| blob | 8d6465752e18d859f50b79322c15e20055362cad |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2013 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `node-property', `quote-section' `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `quote-section',
52 ;; `src-block', `table', `table-row' and `verse-block'. Among them,
53 ;; `paragraph' and `verse-block' types can contain Org objects and
54 ;; plain text.
55 ;;
56 ;; Objects are related to document's contents. Some of them are
57 ;; recursive. Associated types are of the following: `bold', `code',
58 ;; `entity', `export-snippet', `footnote-reference',
59 ;; `inline-babel-call', `inline-src-block', `italic',
60 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
61 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
62 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
63 ;;
64 ;; Some elements also have special properties whose value can hold
65 ;; objects themselves (i.e. an item tag or a headline name). Such
66 ;; values are called "secondary strings". Any object belongs to
67 ;; either an element or a secondary string.
68 ;;
69 ;; Notwithstanding affiliated keywords, each greater element, element
70 ;; and object has a fixed set of properties attached to it. Among
71 ;; them, four are shared by all types: `:begin' and `:end', which
72 ;; refer to the beginning and ending buffer positions of the
73 ;; considered element or object, `:post-blank', which holds the number
74 ;; of blank lines, or white spaces, at its end and `:parent' which
75 ;; refers to the element or object containing it. Greater elements,
76 ;; elements and objects containing objects will also have
77 ;; `:contents-begin' and `:contents-end' properties to delimit
78 ;; contents. Eventually, greater elements and elements accepting
79 ;; affiliated keywords will have a `:post-affiliated' property,
80 ;; referring to the buffer position after all such keywords.
81 ;;
82 ;; At the lowest level, a `:parent' property is also attached to any
83 ;; string, as a text property.
84 ;;
85 ;; Lisp-wise, an element or an object can be represented as a list.
86 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
87 ;; TYPE is a symbol describing the Org element or object.
88 ;; PROPERTIES is the property list attached to it. See docstring of
89 ;; appropriate parsing function to get an exhaustive
90 ;; list.
91 ;; CONTENTS is a list of elements, objects or raw strings contained
92 ;; in the current element or object, when applicable.
93 ;;
94 ;; An Org buffer is a nested list of such elements and objects, whose
95 ;; type is `org-data' and properties is nil.
96 ;;
97 ;; The first part of this file defines Org syntax, while the second
98 ;; one provide accessors and setters functions.
99 ;;
100 ;; The next part implements a parser and an interpreter for each
101 ;; element and object type in Org syntax.
102 ;;
103 ;; The following part creates a fully recursive buffer parser. It
104 ;; also provides a tool to map a function to elements or objects
105 ;; matching some criteria in the parse tree. Functions of interest
106 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
107 ;; extent, `org-element-parse-secondary-string'.
108 ;;
109 ;; The penultimate part is the cradle of an interpreter for the
110 ;; obtained parse tree: `org-element-interpret-data'.
111 ;;
112 ;; The library ends by furnishing `org-element-at-point' function, and
113 ;; a way to give information about document structure around point
114 ;; with `org-element-context'.
117 ;;; Code:
123 \f
124 ;;; Definitions And Rules
125 ;;
126 ;; Define elements, greater elements and specify recursive objects,
127 ;; along with the affiliated keywords recognized. Also set up
128 ;; restrictions on recursive objects combinations.
129 ;;
130 ;; These variables really act as a control center for the parsing
131 ;; process.
135 ;; Headlines, inlinetasks.
137 ;; Footnote definitions.
139 ;; Diary sexps.
142 ;; Empty lines.
144 ;; Tables (any type).
146 ;; Blocks (any type), Babel calls, drawers (any type),
147 ;; fixed-width areas and keywords. Note: this is only an
148 ;; indication and need some thorough check.
150 ;; Horizontal rules.
152 ;; LaTeX environments.
154 ;; Planning and Clock lines.
156 org-deadline-string
157 org-closed-string
158 org-clock-string))
160 ;; Lists.
167 "Regexp to separate paragraphs in an Org buffer.
169 is not sufficient to know if point is at a paragraph ending. See
174 dynamic-block example-block export-block fixed-width
175 footnote-definition headline horizontal-rule inlinetask item
176 keyword latex-environment node-property paragraph plain-list
177 planning property-drawer quote-block quote-section section
178 special-block src-block table table-row verse-block)
183 item plain-list property-drawer quote-block section
184 special-block table)
189 latex-or-entity line-break link macro plain-link radio-target
190 statistics-cookie sub/superscript table-cell target
191 text-markup timestamp)
200 "Alist of translations between object type and successor name.
201 Sharing the same successor comes handy when, for example, the
206 inline-src-block italic line-break latex-fragment link macro
207 radio-target statistics-cookie strike-through subscript superscript
208 table-cell target timestamp underline verbatim)
213 table-cell underline)
223 "Alist between block names and the associated parsing function.
224 Names must be uppercase. Any block whose name has no association
230 Only these types can accept search options and an explicit
236 "List of affiliated keywords as strings.
242 ;; Regular affiliated keywords.
245 "Regexp matching any affiliated keyword.
247 Keyword name is put in match group 1. Moreover, if keyword
248 belongs to `org-element-dual-keywords', put the dual value in
249 match group 2.
257 "Alist of usual translations for keywords.
258 The key is the old name and the value the new one. The property
262 "List of affiliated keywords that can occur more than once in an element.
264 Their value will be consed into a list of strings, which will be
265 returned as the value of the property.
267 This list is checked after translations have been applied. See
268 `org-element-keyword-translation-alist'.
274 "List of affiliated keywords whose value can be parsed.
276 Their value will be stored as a secondary string: a list of
277 strings and objects.
279 This list is checked after translations have been applied. See
283 "List of affiliated keywords which can have a secondary value.
285 In Org syntax, they can be written with optional square brackets
286 before the colons. For example, RESULTS keyword can be
287 associated to a hash value with the following:
289 #+RESULTS[hash-string]: some-source
291 This list is checked after translations have been applied. See
295 "List of properties associated to the whole document.
296 Any keyword in this list will have its value parsed and stored as
310 ;; Ignore all links excepted plain links in a link description.
311 ;; Also ignore radio-targets and line breaks.
315 ;; Remove any variable object from radio target as it would
316 ;; prevent it from being properly recognized.
321 ;; Ignore inline babel call and inline src block as formulas are
322 ;; possible. Also ignore line breaks and statistics cookies.
328 "Alist of objects restrictions.
330 CAR is an element or object type containing objects and CDR is
331 a list of successors that will be called within an element or
332 object of such type.
334 For example, in a `radio-target' object, one can only find
335 entities, latex-fragments, subscript and superscript.
337 This alist also applies to secondary string. For example, an
338 `headline' type element doesn't directly contain objects, but
349 "List of buffer-local variables used when parsing objects.
350 These variables are copied to the temporary buffer created by
354 \f
355 ;;; Accessors and Setters
356 ;;
357 ;; Provide four accessors: `org-element-type', `org-element-property'
358 ;; `org-element-contents' and `org-element-restriction'.
359 ;;
360 ;; Setter functions allow to modify elements by side effect. There is
361 ;; `org-element-put-property', `org-element-set-contents',
362 ;; `org-element-set-element' and `org-element-adopt-element'. Note
363 ;; that `org-element-set-element' and `org-element-adopt-elements' are
364 ;; higher level functions since also update `:parent' property.
367 "Return type of ELEMENT.
369 The function returns the type of the element or object provided.
370 It can also return the following special value:
371 `plain-text' for a string
372 `org-data' for a complete document
373 nil in any other case."
379 "Extract the value from the PROPERTY of an ELEMENT."
384 "Extract contents from an ELEMENT."
390 "Return restriction associated to ELEMENT.
391 ELEMENT can be an element, an object or a symbol representing an
392 element or object type."
394 org-element-object-restrictions)))
397 "In ELEMENT set PROPERTY to VALUE.
398 Return modified element."
401 element))
404 "Set ELEMENT contents to CONTENTS.
405 Return modified element."
412 "Replace element or object OLD with element or object NEW.
413 The function takes care of setting `:parent' property for NEW."
414 ;; Since OLD is going to be changed into NEW by side-effect, first
415 ;; make sure that every element or object within NEW has OLD as
416 ;; parent.
419 ;; Transfer contents.
421 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
422 ;; with NEW's.
425 ;; Transfer type.
429 "Append elements to the contents of another element.
431 PARENT is an element or object. CHILDREN can be elements,
432 objects, or a strings.
434 The function takes care of setting `:parent' property for CHILD.
435 Return parent element."
436 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
437 ;; string: parent is the list itself.
440 children)
441 ;; Add CHILDREN at the end of PARENT contents.
444 parent
446 ;; Return modified PARENT element.
450 \f
451 ;;; Greater elements
452 ;;
453 ;; For each greater element type, we define a parser and an
454 ;; interpreter.
455 ;;
456 ;; A parser returns the element or object as the list described above.
457 ;; Most of them accepts no argument. Though, exceptions exist. Hence
458 ;; every element containing a secondary string (see
459 ;; `org-element-secondary-value-alist') will accept an optional
460 ;; argument to toggle parsing of that secondary string. Moreover,
461 ;; `item' parser requires current list's structure as its first
462 ;; element.
463 ;;
464 ;; An interpreter accepts two arguments: the list representation of
465 ;; the element or object, and its contents. The latter may be nil,
466 ;; depending on the element or object considered. It returns the
467 ;; appropriate Org syntax, as a string.
468 ;;
469 ;; Parsing functions must follow the naming convention:
470 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
471 ;; defined in `org-element-greater-elements'.
472 ;;
473 ;; Similarly, interpreting functions must follow the naming
474 ;; convention: org-element-TYPE-interpreter.
475 ;;
476 ;; With the exception of `headline' and `item' types, greater elements
477 ;; cannot contain other greater elements of their own type.
478 ;;
479 ;; Beside implementing a parser and an interpreter, adding a new
480 ;; greater element requires to tweak `org-element--current-element'.
481 ;; Moreover, the newly defined type must be added to both
482 ;; `org-element-all-elements' and `org-element-greater-elements'.
485 ;;;; Center Block
488 "Parse a center block.
490 LIMIT bounds the search. AFFILIATED is a list of which CAR is
491 the buffer position at the beginning of the first affiliated
492 keyword and CDR is a plist of affiliated keywords along with
493 their value.
495 Return a list whose CAR is `center-block' and CDR is a plist
496 containing `:begin', `:end', `:hiddenp', `:contents-begin',
497 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
499 Assume point is at the beginning of the block."
503 ;; Incomplete block: parse it as a paragraph.
508 ;; Empty blocks have no contents.
523 :end end
524 :hiddenp hidden
525 :contents-begin contents-begin
526 :contents-end contents-end
532 "Interpret CENTER-BLOCK element as Org syntax.
533 CONTENTS is the contents of the element."
537 ;;;; Drawer
540 "Parse a drawer.
542 LIMIT bounds the search. AFFILIATED is a list of which CAR is
543 the buffer position at the beginning of the first affiliated
544 keyword and CDR is a plist of affiliated keywords along with
545 their value.
547 Return a list whose CAR is `drawer' and CDR is a plist containing
548 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
549 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
551 Assume point is at beginning of drawer."
554 ;; Incomplete drawer: parse it as a paragraph.
562 ;; Empty drawers have no contents.
577 :end end
578 :drawer-name name
579 :hiddenp hidden
580 :contents-begin contents-begin
581 :contents-end contents-end
587 "Interpret DRAWER element as Org syntax.
588 CONTENTS is the contents of the element."
591 contents))
594 ;;;; Dynamic Block
597 "Parse a dynamic block.
599 LIMIT bounds the search. AFFILIATED is a list of which CAR is
600 the buffer position at the beginning of the first affiliated
601 keyword and CDR is a plist of affiliated keywords along with
602 their value.
604 Return a list whose CAR is `dynamic-block' and CDR is a plist
605 containing `:block-name', `:begin', `:end', `:hiddenp',
606 `:contents-begin', `:contents-end', `:arguments', `:post-blank'
607 and `:post-affiliated' keywords.
609 Assume point is at beginning of dynamic block."
613 ;; Incomplete block: parse it as a paragraph.
622 ;; Empty blocks have no contents.
637 :end end
638 :block-name name
639 :arguments arguments
640 :hiddenp hidden
641 :contents-begin contents-begin
642 :contents-end contents-end
648 "Interpret DYNAMIC-BLOCK element as Org syntax.
649 CONTENTS is the contents of the element."
654 contents))
657 ;;;; Footnote Definition
660 "Parse a footnote definition.
662 LIMIT bounds the search. AFFILIATED is a list of which CAR is
663 the buffer position at the beginning of the first affiliated
664 keyword and CDR is a plist of affiliated keywords along with
665 their value.
667 Return a list whose CAR is `footnote-definition' and CDR is
668 a plist containing `:label', `:begin' `:end', `:contents-begin',
669 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
671 Assume point is at the beginning of the footnote definition."
697 :begin begin
698 :end end
699 :contents-begin contents-begin
700 :contents-end contents-end
706 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
707 CONTENTS is the contents of the footnote-definition."
709 " "
710 contents))
713 ;;;; Headline
716 "Parse a headline.
718 Return a list whose CAR is `headline' and CDR is a plist
719 containing `:raw-value', `:title', `:alt-title', `:begin',
720 `:end', `:pre-blank', `:hiddenp', `:contents-begin' and
721 `:contents-end', `:level', `:priority', `:tags',
722 `:todo-keyword',`:todo-type', `:scheduled', `:deadline',
723 `:closed', `:quotedp', `:archivedp', `:commentedp' and
724 `:footnote-section-p' keywords.
726 The plist also contains any property set in the property drawer,
727 with its name in upper cases and colons added at the
728 beginning (i.e. `:CUSTOM_ID').
730 When RAW-SECONDARY-P is non-nil, headline's title will not be
731 parsed as a secondary string, but as a plain string instead.
733 Assume point is at beginning of the headline."
746 raw-value)))
750 raw-value)))
754 ;; Upcase property names. It avoids confusion between
755 ;; properties obtained through property drawer and default
756 ;; properties from the parser (e.g. `:end' and :END:)
766 plist))
768 ;; Read time properties on the line below the headline.
774 org-keyword-time-not-clock-regexp end t)
784 plist))))
797 ;; Clean RAW-VALUE from any quote or comment string.
805 ""
806 raw-value))))
807 ;; Clean TAGS from archive tag, if any.
813 :begin begin
814 :end end
815 :pre-blank
818 :hiddenp hidden
819 :contents-begin contents-begin
820 :contents-end contents-end
821 :level level
823 :tags tags
824 :todo-keyword todo
825 :todo-type todo-type
831 end)
832 :footnote-section-p footnote-section-p
833 :archivedp archivedp
834 :commentedp commentedp
836 time-props
837 standard-props))))
841 headline :alt-title
846 headline :title
852 "Interpret HEADLINE element as Org syntax.
853 CONTENTS is the contents of the element."
880 ;; Align tags.
888 ? )
889 tags))
893 tags))))
895 contents)))
898 ;;;; Inlinetask
901 "Parse an inline task.
903 Return a list whose CAR is `inlinetask' and CDR is a plist
904 containing `:title', `:begin', `:end', `:hiddenp',
905 `:contents-begin' and `:contents-end', `:level', `:priority',
906 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
907 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
909 The plist also contains any property set in the property drawer,
910 with its name in upper cases and colons added at the
911 beginning (i.e. `:CUSTOM_ID').
913 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
914 title will not be parsed as a secondary string, but as a plain
915 string instead.
917 Assume point is at beginning of the inline task."
927 ;; Upcase property names. It avoids confusion between
928 ;; properties obtained through property drawer and default
929 ;; properties from the parser (e.g. `:end' and :END:)
939 plist))
941 ;; Read time properties on the line below the inlinetask
942 ;; opening string.
948 org-keyword-time-not-clock-regexp end t)
958 plist))))
978 :begin begin
979 :end end
980 :hiddenp hidden
981 :contents-begin contents-begin
982 :contents-end contents-end
985 :tags tags
986 :todo-keyword todo
987 :todo-type todo-type
989 time-props
990 standard-props))))
992 inlinetask :title
995 raw-value
997 inlinetask))))))
1000 "Interpret INLINETASK element as Org syntax.
1001 CONTENTS is the contents of inlinetask."
1016 ;; Align tags.
1024 ? )
1025 tags))
1029 tags))))
1030 ;; Prefer degenerate inlinetasks when there are no
1031 ;; contents.
1034 contents
1038 ;;;; Item
1041 "Parse an item.
1043 STRUCT is the structure of the plain list.
1045 Return a list whose CAR is `item' and CDR is a plist containing
1046 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1047 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1048 `:post-blank' keywords.
1050 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1051 any, will not be parsed as a secondary string, but as a plain
1052 string instead.
1054 Assume point is at the beginning of the item."
1078 ;; Ignore tags in un-ordered lists: they are just
1079 ;; a part of item's body.
1085 ;; If first line isn't empty, contents really start
1086 ;; at the text after item's meta-data.
1097 :begin begin
1098 :end end
1099 ;; CONTENTS-BEGIN and CONTENTS-END may be
1100 ;; mixed up in the case of an empty item
1101 ;; separated from the next by a blank line.
1102 ;; Thus ensure the former is always the
1103 ;; smallest.
1106 :checkbox checkbox
1107 :counter counter
1108 :hiddenp hidden
1109 :structure struct
1112 item :tag
1120 "Interpret ITEM element as Org syntax.
1121 CONTENTS is the contents of the element."
1131 ;; Compute indentation.
1136 ;; Indent contents.
1138 bullet
1152 ;;;; Plain List
1155 ;; Return structure of list at point. Internal function. See
1156 ;; `org-list-struct' for details.
1164 items struct)
1169 ;; At limit: end all items.
1178 ;; At list end: end all items.
1183 ;; At a new item: end previous sibling.
1195 ind
1196 bullet
1199 ;; Description tag.
1203 ;; Ending position, unknown so far.
1204 nil)))
1205 items))
1207 ;; Skip empty lines.
1209 ;; Skip inline tasks and blank lines along the way.
1216 ;; At some text line. Check if it ends any previous item.
1228 ;; Skip blocks (any type) and drawers contents.
1233 limit t)))
1239 "Parse a plain list.
1241 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1242 the buffer position at the beginning of the first affiliated
1243 keyword and CDR is a plist of affiliated keywords along with
1244 their value. STRUCTURE is the structure of the plain list being
1245 parsed.
1247 Return a list whose CAR is `plain-list' and CDR is a plist
1248 containing `:type', `:begin', `:end', `:contents-begin' and
1249 `:contents-end', `:structure', `:post-blank' and
1250 `:post-affiliated' keywords.
1252 Assume point is at the beginning of the list."
1266 ;; Return value.
1270 :begin begin
1271 :end end
1272 :contents-begin contents-begin
1273 :contents-end contents-end
1274 :structure struct
1280 "Interpret PLAIN-LIST element as Org syntax.
1281 CONTENTS is the contents of the element."
1289 ;;;; Property Drawer
1292 "Parse a property drawer.
1294 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1295 the buffer position at the beginning of the first affiliated
1296 keyword and CDR is a plist of affiliated keywords along with
1297 their value.
1299 Return a list whose CAR is `property-drawer' and CDR is a plist
1300 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1301 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1303 Assume point is at the beginning of the property drawer."
1308 ;; Incomplete drawer: parse it as a paragraph.
1328 :end end
1329 :hiddenp hidden
1330 :contents-begin contents-begin
1331 :contents-end contents-end
1337 "Interpret PROPERTY-DRAWER element as Org syntax.
1338 CONTENTS is the properties within the drawer."
1342 ;;;; Quote Block
1345 "Parse a quote block.
1347 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1348 the buffer position at the beginning of the first affiliated
1349 keyword and CDR is a plist of affiliated keywords along with
1350 their value.
1352 Return a list whose CAR is `quote-block' and CDR is a plist
1353 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1354 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1356 Assume point is at the beginning of the block."
1360 ;; Incomplete block: parse it as a paragraph.
1366 ;; Empty blocks have no contents.
1381 :end end
1382 :hiddenp hidden
1383 :contents-begin contents-begin
1384 :contents-end contents-end
1390 "Interpret QUOTE-BLOCK element as Org syntax.
1391 CONTENTS is the contents of the element."
1395 ;;;; Section
1398 "Parse a section.
1400 LIMIT bounds the search.
1402 Return a list whose CAR is `section' and CDR is a plist
1403 containing `:begin', `:end', `:contents-begin', `contents-end'
1404 and `:post-blank' keywords."
1406 ;; Beginning of section is the beginning of the first non-blank
1407 ;; line after previous headline.
1416 :end end
1417 :contents-begin begin
1418 :contents-end pos-before-blank
1422 "Interpret SECTION element as Org syntax.
1423 CONTENTS is the contents of the element."
1424 contents)
1427 ;;;; Special Block
1430 "Parse a special block.
1432 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1433 the buffer position at the beginning of the first affiliated
1434 keyword and CDR is a plist of affiliated keywords along with
1435 their value.
1437 Return a list whose CAR is `special-block' and CDR is a plist
1438 containing `:type', `:begin', `:end', `:hiddenp',
1439 `:contents-begin', `:contents-end', `:post-blank' and
1440 `:post-affiliated' keywords.
1442 Assume point is at the beginning of the block."
1449 limit t)))
1450 ;; Incomplete block: parse it as a paragraph.
1456 ;; Empty blocks have no contents.
1471 :begin begin
1472 :end end
1473 :hiddenp hidden
1474 :contents-begin contents-begin
1475 :contents-end contents-end
1481 "Interpret SPECIAL-BLOCK element as Org syntax.
1482 CONTENTS is the contents of the element."
1487 \f
1488 ;;; Elements
1489 ;;
1490 ;; For each element, a parser and an interpreter are also defined.
1491 ;; Both follow the same naming convention used for greater elements.
1492 ;;
1493 ;; Also, as for greater elements, adding a new element type is done
1494 ;; through the following steps: implement a parser and an interpreter,
1495 ;; tweak `org-element--current-element' so that it recognizes the new
1496 ;; type and add that new type to `org-element-all-elements'.
1497 ;;
1498 ;; As a special case, when the newly defined type is a block type,
1499 ;; `org-element-block-name-alist' has to be modified accordingly.
1502 ;;;; Babel Call
1505 "Parse a babel call.
1507 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1508 the buffer position at the beginning of the first affiliated
1509 keyword and CDR is a plist of affiliated keywords along with
1510 their value.
1512 Return a list whose CAR is `babel-call' and CDR is a plist
1513 containing `:begin', `:end', `:info', `:post-blank' and
1514 `:post-affiliated' as keywords."
1528 :end end
1529 :info info
1535 "Interpret BABEL-CALL element as Org syntax.
1536 CONTENTS is nil."
1542 ;; Remove redundant square brackets.
1547 ;;;; Clock
1550 "Parse a clock.
1552 LIMIT bounds the search.
1554 Return a list whose CAR is `clock' and CDR is a plist containing
1555 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1556 as keywords."
1576 :value value
1577 :duration duration
1578 :begin begin
1579 :end end
1583 "Interpret CLOCK element as Org syntax.
1584 CONTENTS is nil."
1592 "%2s:%02s"
1596 ;;;; Comment
1599 "Parse a comment.
1601 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1602 the buffer position at the beginning of the first affiliated
1603 keyword and CDR is a plist of affiliated keywords along with
1604 their value.
1606 Return a list whose CAR is `comment' and CDR is a plist
1607 containing `:begin', `:end', `:value', `:post-blank',
1608 `:post-affiliated' keywords.
1610 Assume point is at comment beginning."
1619 ;; Get comments ending.
1622 ;; Accumulate lines without leading hash and first
1623 ;; whitespace.
1638 :end end
1639 :value value
1645 "Interpret COMMENT element as Org syntax.
1646 CONTENTS is nil."
1650 ;;;; Comment Block
1653 "Parse an export block.
1655 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1656 the buffer position at the beginning of the first affiliated
1657 keyword and CDR is a plist of affiliated keywords along with
1658 their value.
1660 Return a list whose CAR is `comment-block' and CDR is a plist
1661 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1662 and `:post-affiliated' keywords.
1664 Assume point is at comment block beginning."
1668 ;; Incomplete block: parse it as a paragraph.
1683 contents-begin contents-end)))
1687 :end end
1688 :value value
1689 :hiddenp hidden
1695 "Interpret COMMENT-BLOCK element as Org syntax.
1696 CONTENTS is nil."
1701 ;;;; Diary Sexp
1704 "Parse a diary sexp.
1706 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1707 the buffer position at the beginning of the first affiliated
1708 keyword and CDR is a plist of affiliated keywords along with
1709 their value.
1711 Return a list whose CAR is `diary-sexp' and CDR is a plist
1712 containing `:begin', `:end', `:value', `:post-blank' and
1713 `:post-affiliated' keywords."
1726 :begin begin
1727 :end end
1733 "Interpret DIARY-SEXP as Org syntax.
1734 CONTENTS is nil."
1738 ;;;; Example Block
1741 "Remove maximum common indentation in string S and return it.
1742 When optional argument N is a positive integer, remove exactly
1743 that much characters from indentation, if possible, or return
1744 S as-is otherwise. Unlike to `org-remove-indentation', this
1745 function doesn't call `untabify' on S."
1750 ;; Find maximum common indentation, if not specified.
1758 min-ind)))
1760 ;; Remove exactly N indentation, but give up if not possible.
1770 "Parse an example block.
1772 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1773 the buffer position at the beginning of the first affiliated
1774 keyword and CDR is a plist of affiliated keywords along with
1775 their value.
1777 Return a list whose CAR is `example-block' and CDR is a plist
1778 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1779 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1780 `:switches', `:value', `:post-blank' and `:post-affiliated'
1781 keywords."
1785 ;; Incomplete block: parse it as a paragraph.
1793 ;; Switches analysis
1801 ;; Should labels be retained in (or stripped from) example
1802 ;; blocks?
1807 ;; What should code-references use - labels or
1808 ;; line-numbers?
1817 ;; Standard block parsing.
1826 contents-begin contents-end))
1837 :end end
1838 :value value
1839 :switches switches
1840 :number-lines number-lines
1841 :preserve-indent preserve-indent
1842 :retain-labels retain-labels
1843 :use-labels use-labels
1844 :label-fmt label-fmt
1845 :hiddenp hidden
1851 "Interpret EXAMPLE-BLOCK element as Org syntax.
1852 CONTENTS is nil."
1860 ;;;; Export Block
1863 "Parse an export block.
1865 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1866 the buffer position at the beginning of the first affiliated
1867 keyword and CDR is a plist of affiliated keywords along with
1868 their value.
1870 Return a list whose CAR is `export-block' and CDR is a plist
1871 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1872 `:post-blank' and `:post-affiliated' keywords.
1874 Assume point is at export-block beginning."
1881 ;; Incomplete block: parse it as a paragraph.
1896 contents-end)))
1900 :end end
1901 :type type
1902 :value value
1903 :hiddenp hidden
1909 "Interpret EXPORT-BLOCK element as Org syntax.
1910 CONTENTS is nil."
1917 ;;;; Fixed-width
1920 "Parse a fixed-width section.
1922 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1923 the buffer position at the beginning of the first affiliated
1924 keyword and CDR is a plist of affiliated keywords along with
1925 their value.
1927 Return a list whose CAR is `fixed-width' and CDR is a plist
1928 containing `:begin', `:end', `:value', `:post-blank' and
1929 `:post-affiliated' keywords.
1931 Assume point is at the beginning of the fixed-width area."
1935 value
1940 ;; Accumulate text without starting colons.
1954 :end end
1955 :value value
1961 "Interpret FIXED-WIDTH element as Org syntax.
1962 CONTENTS is nil."
1970 ;;;; Horizontal Rule
1973 "Parse an horizontal rule.
1975 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1976 the buffer position at the beginning of the first affiliated
1977 keyword and CDR is a plist of affiliated keywords along with
1978 their value.
1980 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1981 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1982 keywords."
1993 :end end
1999 "Interpret HORIZONTAL-RULE element as Org syntax.
2000 CONTENTS is nil."
2004 ;;;; Keyword
2007 "Parse a keyword at point.
2009 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2010 the buffer position at the beginning of the first affiliated
2011 keyword and CDR is a plist of affiliated keywords along with
2012 their value.
2014 Return a list whose CAR is `keyword' and CDR is a plist
2015 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2016 `:post-affiliated' keywords."
2031 :value value
2032 :begin begin
2033 :end end
2039 "Interpret KEYWORD element as Org syntax.
2040 CONTENTS is nil."
2046 ;;;; Latex Environment
2049 "Parse a LaTeX environment.
2051 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2052 the buffer position at the beginning of the first affiliated
2053 keyword and CDR is a plist of affiliated keywords along with
2054 their value.
2056 Return a list whose CAR is `latex-environment' and CDR is a plist
2057 containing `:begin', `:end', `:value', `:post-blank' and
2058 `:post-affiliated' keywords.
2060 Assume point is at the beginning of the latex environment."
2067 limit t))
2068 ;; Incomplete latex environment: parse it as a paragraph.
2079 :end end
2080 :value value
2086 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2087 CONTENTS is nil."
2091 ;;;; Node Property
2094 "Parse a node-property at point.
2096 LIMIT bounds the search.
2098 Return a list whose CAR is `node-property' and CDR is a plist
2099 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2100 keywords."
2112 :value value
2113 :begin begin
2114 :end end
2118 "Interpret NODE-PROPERTY element as Org syntax.
2119 CONTENTS is nil."
2125 ;;;; Paragraph
2128 "Parse a paragraph.
2130 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2131 the buffer position at the beginning of the first affiliated
2132 keyword and CDR is a plist of affiliated keywords along with
2133 their value.
2135 Return a list whose CAR is `paragraph' and CDR is a plist
2136 containing `:begin', `:end', `:contents-begin' and
2137 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2139 Assume point is at the beginning of the paragraph."
2148 limit
2149 ;; A matching `org-element-paragraph-separate' is not
2150 ;; necessarily the end of the paragraph. In
2151 ;; particular, lines starting with # or : as a first
2152 ;; non-space character are ambiguous. We have check
2153 ;; if they are valid Org syntax (i.e. not an
2154 ;; incomplete keyword).
2158 ;; There's no ambiguity for other symbols or
2159 ;; empty lines: stop here.
2161 ;; Stop at valid fixed-width areas.
2163 ;; Stop at drawers.
2168 ;; Stop at valid comments.
2170 ;; Stop at valid dynamic blocks.
2175 ;; Stop at valid blocks.
2182 limit t)))
2183 ;; Stop at valid latex environments.
2190 limit t)))
2191 ;; Stop at valid keywords.
2193 ;; Skip everything else.
2211 :end end
2212 :contents-begin contents-begin
2213 :contents-end contents-end
2219 "Interpret PARAGRAPH element as Org syntax.
2220 CONTENTS is the contents of the element."
2221 contents)
2224 ;;;; Planning
2227 "Parse a planning.
2229 LIMIT bounds the search.
2231 Return a list whose CAR is `planning' and CDR is a plist
2232 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2233 and `:post-blank' keywords."
2243 closed deadline scheduled)
2255 :deadline deadline
2256 :scheduled scheduled
2257 :begin begin
2258 :end end
2262 "Interpret PLANNING element as Org syntax.
2263 CONTENTS is nil."
2265 'identity
2282 ;;;; Quote Section
2285 "Parse a quote section.
2287 LIMIT bounds the search.
2289 Return a list whose CAR is `quote-section' and CDR is a plist
2290 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2292 Assume point is at beginning of the section."
2303 :end end
2304 :value value
2308 "Interpret QUOTE-SECTION element as Org syntax.
2309 CONTENTS is nil."
2313 ;;;; Src Block
2316 "Parse a src block.
2318 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2319 the buffer position at the beginning of the first affiliated
2320 keyword and CDR is a plist of affiliated keywords along with
2321 their value.
2323 Return a list whose CAR is `src-block' and CDR is a plist
2324 containing `:language', `:switches', `:parameters', `:begin',
2325 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2326 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2327 `:post-blank' and `:post-affiliated' keywords.
2329 Assume point is at the beginning of the block."
2332 limit t)))
2333 ;; Incomplete block: parse it as a paragraph.
2339 ;; Get language as a string.
2348 ;; Get switches.
2350 ;; Get parameters.
2352 ;; Switches analysis
2364 ;; Should labels be retained in (or stripped from)
2365 ;; src blocks?
2370 ;; What should code-references use - labels or
2371 ;; line-numbers?
2376 ;; Indentation.
2378 ;; Get visibility status.
2380 ;; Retrieve code.
2389 ;; Get position after ending blank lines.
2400 :begin begin
2401 :end end
2402 :number-lines number-lines
2403 :preserve-indent preserve-indent
2404 :retain-labels retain-labels
2405 :use-labels use-labels
2406 :label-fmt label-fmt
2407 :hiddenp hidden
2408 :value value
2414 "Interpret SRC-BLOCK element as Org syntax.
2415 CONTENTS is nil."
2436 ;;;; Table
2439 "Parse a table at point.
2441 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2442 the buffer position at the beginning of the first affiliated
2443 keyword and CDR is a plist of affiliated keywords along with
2444 their value.
2446 Return a list whose CAR is `table' and CDR is a plist containing
2447 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2448 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2449 keywords.
2451 Assume point is at the beginning of the table."
2465 acc))
2473 :end end
2474 :type type
2475 :tblfm tblfm
2476 ;; Only `org' tables have contents. `table.el' tables
2477 ;; use a `:value' property to store raw table as
2478 ;; a string.
2483 table-begin table-end))
2489 "Interpret TABLE element as Org syntax.
2490 CONTENTS is nil."
2501 ;;;; Table Row
2504 "Parse table row at point.
2506 LIMIT bounds the search.
2508 Return a list whose CAR is `table-row' and CDR is a plist
2509 containing `:begin', `:end', `:contents-begin', `:contents-end',
2510 `:type' and `:post-blank' keywords."
2514 ;; A table rule has no contents. In that case, ensure
2515 ;; CONTENTS-BEGIN matches CONTENTS-END.
2527 :begin begin
2528 :end end
2529 :contents-begin contents-begin
2530 :contents-end contents-end
2534 "Interpret TABLE-ROW element as Org syntax.
2535 CONTENTS is the contents of the table row."
2540 ;;;; Verse Block
2543 "Parse a verse block.
2545 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2546 the buffer position at the beginning of the first affiliated
2547 keyword and CDR is a plist of affiliated keywords along with
2548 their value.
2550 Return a list whose CAR is `verse-block' and CDR is a plist
2551 containing `:begin', `:end', `:contents-begin', `:contents-end',
2552 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2554 Assume point is at beginning of the block."
2558 ;; Incomplete block: parse it as a paragraph.
2575 :end end
2576 :contents-begin contents-begin
2577 :contents-end contents-end
2578 :hiddenp hidden
2584 "Interpret VERSE-BLOCK element as Org syntax.
2585 CONTENTS is verse block contents."
2589 \f
2590 ;;; Objects
2591 ;;
2592 ;; Unlike to elements, interstices can be found between objects.
2593 ;; That's why, along with the parser, successor functions are provided
2594 ;; for each object. Some objects share the same successor (i.e. `code'
2595 ;; and `verbatim' objects).
2596 ;;
2597 ;; A successor must accept a single argument bounding the search. It
2598 ;; will return either a cons cell whose CAR is the object's type, as
2599 ;; a symbol, and CDR the position of its next occurrence, or nil.
2600 ;;
2601 ;; Successors follow the naming convention:
2602 ;; org-element-NAME-successor, where NAME is the name of the
2603 ;; successor, as defined in `org-element-all-successors'.
2604 ;;
2605 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2606 ;; object types they can contain will be specified in
2607 ;; `org-element-object-restrictions'.
2608 ;;
2609 ;; Adding a new type of object is simple. Implement a successor,
2610 ;; a parser, and an interpreter for it, all following the naming
2611 ;; convention. Register type in `org-element-all-objects' and
2612 ;; successor in `org-element-all-successors'. Maybe tweak
2613 ;; restrictions about it, and that's it.
2616 ;;;; Bold
2619 "Parse bold object at point.
2621 Return a list whose CAR is `bold' and CDR is a plist with
2622 `:begin', `:end', `:contents-begin' and `:contents-end' and
2623 `:post-blank' keywords.
2625 Assume point is at the first star marker."
2637 :end end
2638 :contents-begin contents-begin
2639 :contents-end contents-end
2643 "Interpret BOLD object as Org syntax.
2644 CONTENTS is the contents of the object."
2648 "Search for the next text-markup object.
2650 LIMIT bounds the search.
2652 Return value is a cons cell whose CAR is a symbol among `bold',
2653 `italic', `underline', `strike-through', `code' and `verbatim'
2654 and CDR is beginning position."
2670 ;;;; Code
2673 "Parse code object at point.
2675 Return a list whose CAR is `code' and CDR is a plist with
2676 `:value', `:begin', `:end' and `:post-blank' keywords.
2678 Assume point is at the first tilde marker."
2689 :begin begin
2690 :end end
2694 "Interpret CODE object as Org syntax.
2695 CONTENTS is nil."
2699 ;;;; Entity
2702 "Parse entity at point.
2704 Return a list whose CAR is `entity' and CDR a plist with
2705 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2706 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2707 keywords.
2709 Assume point is at the beginning of the entity."
2711 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2727 :begin begin
2728 :end end
2729 :use-brackets-p bracketsp
2733 "Interpret ENTITY object as Org syntax.
2734 CONTENTS is nil."
2740 "Search for the next latex-fragment or entity object.
2742 LIMIT bounds the search.
2744 Return value is a cons cell whose CAR is `entity' or
2745 `latex-fragment' and CDR is beginning position."
2750 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2757 limit t)
2760 ;; Determine if it's a real entity or a LaTeX command.
2763 ;; No entity nor command: point is at a LaTeX fragment.
2764 ;; Determine its type to get the correct beginning position.
2772 matchers)
2776 ;;;; Export Snippet
2779 "Parse export snippet at point.
2781 Return a list whose CAR is `export-snippet' and CDR a plist with
2782 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2783 keywords.
2785 Assume point is at the beginning of the snippet."
2797 :value value
2798 :begin begin
2799 :end end
2803 "Interpret EXPORT-SNIPPET object as Org syntax.
2804 CONTENTS is nil."
2810 "Search for the next export-snippet object.
2812 LIMIT bounds the search.
2814 Return value is a cons cell whose CAR is `export-snippet' and CDR
2815 its beginning position."
2824 ;;;; Footnote Reference
2827 "Parse footnote reference at point.
2829 Return a list whose CAR is `footnote-reference' and CDR a plist
2830 with `:label', `:type', `:inline-definition', `:begin', `:end'
2831 and `:post-blank' as keywords."
2853 :type type
2854 :begin begin
2855 :end end
2858 footnote-reference :inline-definition
2863 footnote-reference))))))
2866 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2867 CONTENTS is nil."
2877 "Search for the next footnote-reference object.
2879 LIMIT bounds the search.
2881 Return value is a cons cell whose CAR is `footnote-reference' and
2882 CDR is beginning position."
2896 ;;;; Inline Babel Call
2899 "Parse inline babel call at point.
2901 Return a list whose CAR is `inline-babel-call' and CDR a plist
2902 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2904 Assume point is at the beginning of the babel call."
2915 :end end
2916 :info info
2920 "Interpret INLINE-BABEL-CALL object as Org syntax.
2921 CONTENTS is nil."
2927 ;; Remove redundant square brackets.
2930 main-source)
2934 "Search for the next inline-babel-call object.
2936 LIMIT bounds the search.
2938 Return value is a cons cell whose CAR is `inline-babel-call' and
2939 CDR is beginning position."
2941 ;; Use a simplified version of
2942 ;; `org-babel-inline-lob-one-liner-regexp'.
2945 limit t)
2949 ;;;; Inline Src Block
2952 "Parse inline source block at point.
2954 LIMIT bounds the search.
2956 Return a list whose CAR is `inline-src-block' and CDR a plist
2957 with `:begin', `:end', `:language', `:value', `:parameters' and
2958 `:post-blank' as keywords.
2960 Assume point is at the beginning of the inline src block."
2973 :value value
2974 :parameters parameters
2975 :begin begin
2976 :end end
2980 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2981 CONTENTS is nil."
2986 language
2988 body)))
2991 "Search for the next inline-babel-call element.
2993 LIMIT bounds the search.
2995 Return value is a cons cell whose CAR is `inline-babel-call' and
2996 CDR is beginning position."
3002 ;;;; Italic
3005 "Parse italic object at point.
3007 Return a list whose CAR is `italic' and CDR is a plist with
3008 `:begin', `:end', `:contents-begin' and `:contents-end' and
3009 `:post-blank' keywords.
3011 Assume point is at the first slash marker."
3023 :end end
3024 :contents-begin contents-begin
3025 :contents-end contents-end
3029 "Interpret ITALIC object as Org syntax.
3030 CONTENTS is the contents of the object."
3034 ;;;; Latex Fragment
3037 "Parse latex fragment at point.
3039 Return a list whose CAR is `latex-fragment' and CDR a plist with
3040 `:value', `:begin', `:end', and `:post-blank' as keywords.
3042 Assume point is at the beginning of the latex fragment."
3056 ;; None found: it's a macro.
3065 :begin begin
3066 :end end
3070 "Interpret LATEX-FRAGMENT object as Org syntax.
3071 CONTENTS is nil."
3074 ;;;; Line Break
3077 "Parse line break at point.
3079 Return a list whose CAR is `line-break', and CDR a plist with
3080 `:begin', `:end' and `:post-blank' keywords.
3082 Assume point is at the beginning of the line break."
3089 "Interpret LINE-BREAK object as Org syntax.
3090 CONTENTS is nil."
3094 "Search for the next line-break object.
3096 LIMIT bounds the search.
3098 Return value is a cons cell whose CAR is `line-break' and CDR is
3099 beginning position."
3103 ;; A line break can only happen on a non-empty line.
3108 ;;;; Link
3111 "Parse link at point.
3113 Return a list whose CAR is `link' and CDR a plist with `:type',
3114 `:path', `:raw-link', `:application', `:search-option', `:begin',
3115 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3116 keywords.
3118 Assume point is at the beginning of the link."
3121 end contents-begin contents-end link-end post-blank path type
3122 raw-link link search-option application)
3124 ;; Type 1: Text targeted from a radio target.
3129 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3134 ;; RAW-LINK is the original link. Expand any
3135 ;; abbreviation in it.
3140 ;; Determine TYPE of link and set PATH accordingly.
3142 ;; File type.
3145 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3148 ;; Id type: PATH is the id.
3151 ;; Code-ref type: PATH is the name of the reference.
3154 ;; Custom-id type: PATH is the name of the custom id.
3157 ;; Fuzzy type: Internal link either matches a target, an
3158 ;; headline name or nothing. PATH is the target or
3159 ;; headline's name.
3161 ;; Type 3: Plain link, i.e. http://orgmode.org
3167 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3174 ;; In any case, deduce end point after trailing white space from
3175 ;; LINK-END variable.
3178 ;; Extract search option and opening application out of
3179 ;; "file"-type links.
3181 ;; Application.
3186 ;; Extract search option from PATH.
3190 ;; Make sure TYPE always report "file".
3194 :path path
3196 :application application
3197 :search-option search-option
3198 :begin begin
3199 :end end
3200 :contents-begin contents-begin
3201 :contents-end contents-end
3205 "Interpret LINK object as Org syntax.
3206 CONTENTS is the contents of the object, or nil."
3211 raw-link
3215 "Search for the next link object.
3217 LIMIT bounds the search.
3219 Return value is a cons cell whose CAR is `link' and CDR is
3220 beginning position."
3229 "Search for the next plain link object.
3231 LIMIT bounds the search.
3233 Return value is a cons cell whose CAR is `link' and CDR is
3234 beginning position."
3239 ;;;; Macro
3242 "Parse macro at point.
3244 Return a list whose CAR is `macro' and CDR a plist with `:key',
3245 `:args', `:begin', `:end', `:value' and `:post-blank' as
3246 keywords.
3248 Assume point is at the macro."
3259 ;; Do not use `org-split-string' since empty
3260 ;; strings are meaningful here.
3268 args nil t)
3272 :value value
3273 :args args
3274 :begin begin
3275 :end end
3279 "Interpret MACRO object as Org syntax.
3280 CONTENTS is nil."
3284 "Search for the next macro object.
3286 LIMIT bounds the search.
3288 Return value is cons cell whose CAR is `macro' and CDR is
3289 beginning position."
3293 limit t)
3297 ;;;; Radio-target
3300 "Parse radio target at point.
3302 Return a list whose CAR is `radio-target' and CDR a plist with
3303 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3304 and `:post-blank' as keywords.
3306 Assume point is at the radio target."
3318 :end end
3319 :contents-begin contents-begin
3320 :contents-end contents-end
3321 :post-blank post-blank
3325 "Interpret TARGET object as Org syntax.
3326 CONTENTS is the contents of the object."
3330 "Search for the next radio-target object.
3332 LIMIT bounds the search.
3334 Return value is a cons cell whose CAR is `radio-target' and CDR
3335 is beginning position."
3341 ;;;; Statistics Cookie
3344 "Parse statistics cookie at point.
3346 Return a list whose CAR is `statistics-cookie', and CDR a plist
3347 with `:begin', `:end', `:value' and `:post-blank' keywords.
3349 Assume point is at the beginning of the statistics-cookie."
3360 :end end
3361 :value value
3365 "Interpret STATISTICS-COOKIE object as Org syntax.
3366 CONTENTS is nil."
3370 "Search for the next statistics cookie object.
3372 LIMIT bounds the search.
3374 Return value is a cons cell whose CAR is `statistics-cookie' and
3375 CDR is beginning position."
3381 ;;;; Strike-Through
3384 "Parse strike-through object at point.
3386 Return a list whose CAR is `strike-through' and CDR is a plist
3387 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3388 `:post-blank' keywords.
3390 Assume point is at the first plus sign marker."
3402 :end end
3403 :contents-begin contents-begin
3404 :contents-end contents-end
3408 "Interpret STRIKE-THROUGH object as Org syntax.
3409 CONTENTS is the contents of the object."
3413 ;;;; Subscript
3416 "Parse subscript at point.
3418 Return a list whose CAR is `subscript' and CDR a plist with
3419 `:begin', `:end', `:contents-begin', `:contents-end',
3420 `:use-brackets-p' and `:post-blank' as keywords.
3422 Assume point is at the underscore."
3426 t
3437 :end end
3438 :use-brackets-p bracketsp
3439 :contents-begin contents-begin
3440 :contents-end contents-end
3444 "Interpret SUBSCRIPT object as Org syntax.
3445 CONTENTS is the contents of the object."
3448 contents))
3451 "Search for the next sub/superscript object.
3453 LIMIT bounds the search.
3455 Return value is a cons cell whose CAR is either `subscript' or
3456 `superscript' and CDR is beginning position."
3464 ;;;; Superscript
3467 "Parse superscript at point.
3469 Return a list whose CAR is `superscript' and CDR a plist with
3470 `:begin', `:end', `:contents-begin', `:contents-end',
3471 `:use-brackets-p' and `:post-blank' as keywords.
3473 Assume point is at the caret."
3487 :end end
3488 :use-brackets-p bracketsp
3489 :contents-begin contents-begin
3490 :contents-end contents-end
3494 "Interpret SUPERSCRIPT object as Org syntax.
3495 CONTENTS is the contents of the object."
3498 contents))
3501 ;;;; Table Cell
3504 "Parse table cell at point.
3506 Return a list whose CAR is `table-cell' and CDR is a plist
3507 containing `:begin', `:end', `:contents-begin', `:contents-end'
3508 and `:post-blank' keywords."
3516 :end end
3517 :contents-begin contents-begin
3518 :contents-end contents-end
3522 "Interpret TABLE-CELL element as Org syntax.
3523 CONTENTS is the contents of the cell, or nil."
3527 "Search for the next table-cell object.
3529 LIMIT bounds the search.
3531 Return value is a cons cell whose CAR is `table-cell' and CDR is
3532 beginning position."
3536 ;;;; Target
3539 "Parse target at point.
3541 Return a list whose CAR is `target' and CDR a plist with
3542 `:begin', `:end', `:value' and `:post-blank' as keywords.
3544 Assume point is at the target."
3554 :end end
3555 :value value
3559 "Interpret TARGET object as Org syntax.
3560 CONTENTS is nil."
3564 "Search for the next target object.
3566 LIMIT bounds the search.
3568 Return value is a cons cell whose CAR is `target' and CDR is
3569 beginning position."
3575 ;;;; Timestamp
3578 "Parse time stamp at point.
3580 Return a list whose CAR is `timestamp', and CDR a plist with
3581 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3583 Assume point is at the beginning of the timestamp."
3601 date-start)
3612 raw-value)
3614 :repeater-type
3620 :repeater-unit
3623 year-start month-start day-start hour-start minute-start year-end
3624 month-end day-end hour-end minute-end)
3625 ;; Parse date-start.
3633 ;; Compute date-end. It can be provided directly in time-stamp,
3634 ;; or extracted from time range. Otherwise, it defaults to the
3635 ;; same values as date-start.
3645 :raw-value raw-value
3646 :year-start year-start
3647 :month-start month-start
3648 :day-start day-start
3649 :hour-start hour-start
3650 :minute-start minute-start
3651 :year-end year-end
3652 :month-end month-end
3653 :day-end day-end
3654 :hour-end hour-end
3655 :minute-end minute-end
3656 :begin begin
3657 :end end
3659 repeater-props)))))
3662 "Interpret TIMESTAMP object as Org syntax.
3663 CONTENTS is nil."
3664 ;; Use `:raw-value' if specified.
3666 ;; Otherwise, build timestamp string.
3676 ;; Build an Org timestamp string from TIME. ACTIVEP is
3677 ;; non-nil when time stamp is active. If WITH-TIME-P is
3678 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3679 ;; specify a time range in the timestamp. REPEAT-STRING
3680 ;; is the repeater string, if any.
3684 org-time-stamp-formats)
3685 time)))
3691 nil nil ts)))
3695 " "
3696 repeat-string
3698 ;; Return value.
3699 ts)))
3711 build-ts-string
3730 0
3738 "--"
3750 "Search for the next timestamp object.
3752 LIMIT bounds the search.
3754 Return value is a cons cell whose CAR is `timestamp' and CDR is
3755 beginning position."
3763 limit t)
3767 ;;;; Underline
3770 "Parse underline object at point.
3772 Return a list whose CAR is `underline' and CDR is a plist with
3773 `:begin', `:end', `:contents-begin' and `:contents-end' and
3774 `:post-blank' keywords.
3776 Assume point is at the first underscore marker."
3788 :end end
3789 :contents-begin contents-begin
3790 :contents-end contents-end
3794 "Interpret UNDERLINE object as Org syntax.
3795 CONTENTS is the contents of the object."
3799 ;;;; Verbatim
3802 "Parse verbatim object at point.
3804 Return a list whose CAR is `verbatim' and CDR is a plist with
3805 `:value', `:begin', `:end' and `:post-blank' keywords.
3807 Assume point is at the first equal sign marker."
3818 :begin begin
3819 :end end
3823 "Interpret VERBATIM object as Org syntax.
3824 CONTENTS is nil."
3828 \f
3829 ;;; Parsing Element Starting At Point
3830 ;;
3831 ;; `org-element--current-element' is the core function of this section.
3832 ;; It returns the Lisp representation of the element starting at
3833 ;; point.
3834 ;;
3835 ;; `org-element--current-element' makes use of special modes. They
3836 ;; are activated for fixed element chaining (i.e. `plain-list' >
3837 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3838 ;; `section'). Special modes are: `first-section', `item',
3839 ;; `node-property', `quote-section', `section' and `table-row'.
3843 "Parse the element starting at point.
3845 LIMIT bounds the search.
3847 Return value is a list like (TYPE PROPS) where TYPE is the type
3848 of the element and PROPS a plist of properties associated to the
3849 element.
3851 Possible types are defined in `org-element-all-elements'.
3853 Optional argument GRANULARITY determines the depth of the
3854 recursion. Allowed values are `headline', `greater-element',
3855 `element', `object' or nil. When it is broader than `object' (or
3856 nil), secondary values will not be parsed, since they only
3857 contain objects.
3859 Optional argument SPECIAL, when non-nil, can be either
3860 `first-section', `item', `node-property', `quote-section',
3861 `section', and `table-row'.
3863 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3864 be computed.
3866 This function assumes point is always at the beginning of the
3867 element it has to parse."
3870 ;; Determine if parsing depth allows for secondary strings
3871 ;; parsing. It only applies to elements referenced in
3872 ;; `org-element-secondary-value-alist'.
3875 ;; Item.
3878 ;; Table Row.
3880 ;; Node Property.
3882 ;; Headline.
3885 ;; Sections (must be checked after headline).
3891 limit)))
3892 ;; When not at bol, point is at the beginning of an item or
3893 ;; a footnote definition: next item is always a paragraph.
3895 ;; Planning and Clock.
3900 ;; Inlinetask.
3903 ;; From there, elements can have affiliated keywords.
3906 ;; Jumping over affiliated keywords put point off-limits.
3907 ;; Parse them as regular keywords.
3911 ;; LaTeX Environment.
3915 ;; Drawer and Property Drawer.
3920 ;; Fixed Width
3923 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3924 ;; Keywords.
3933 org-element-block-name-alist)))
3948 ;; Footnote Definition.
3951 ;; Horizontal Rule.
3954 ;; Diary Sexp.
3957 ;; Table.
3959 ;; List.
3962 limit affiliated
3964 ;; Default element: Paragraph.
3968 ;; Most elements can have affiliated keywords. When looking for an
3969 ;; element beginning, we want to move before them, as they belong to
3970 ;; that element, and, in the meantime, collect information they give
3971 ;; into appropriate properties. Hence the following function.
3974 "Collect affiliated keywords from point down to LIMIT.
3976 Return a list whose CAR is the position at the first of them and
3977 CDR a plist of keywords and values and move point to the
3978 beginning of the first line after them.
3980 As a special case, if element doesn't start at the beginning of
3981 the line (i.e. a paragraph starting an item), CAR is current
3982 position of point and CDR is nil."
3986 ;; RESTRICT is the list of objects allowed in parsed
3987 ;; keywords value.
3989 output)
3992 ;; Apply translation to RAW-KWD. From there, KWD is
3993 ;; the official keyword.
3995 org-element-keyword-translation-alist))
3996 raw-kwd))
3997 ;; Find main value for any keyword.
4003 ;; PARSEDP is non-nil when keyword should have its
4004 ;; value parsed.
4006 ;; If KWD is a dual keyword, find its secondary
4007 ;; value. Maybe parse it.
4014 ;; Attribute a property name to KWD.
4016 ;; Now set final shape for VALUE.
4022 ;; Attributes can always appear on multiple lines.
4025 ;; Eventually store the new value in OUTPUT.
4027 ;; Move to next keyword.
4029 ;; If affiliated keywords are orphaned: move back to first one.
4030 ;; They will be parsed as a paragraph.
4032 ;; Return value.
4036 \f
4037 ;;; The Org Parser
4038 ;;
4039 ;; The two major functions here are `org-element-parse-buffer', which
4040 ;; parses Org syntax inside the current buffer, taking into account
4041 ;; region, narrowing, or even visibility if specified, and
4042 ;; `org-element-parse-secondary-string', which parses objects within
4043 ;; a given string.
4044 ;;
4045 ;; The (almost) almighty `org-element-map' allows to apply a function
4046 ;; on elements or objects matching some type, and accumulate the
4047 ;; resulting values. In an export situation, it also skips unneeded
4048 ;; parts of the parse tree.
4051 "Recursively parse the buffer and return structure.
4052 If narrowing is in effect, only parse the visible part of the
4053 buffer.
4055 Optional argument GRANULARITY determines the depth of the
4056 recursion. It can be set to the following symbols:
4058 `headline' Only parse headlines.
4059 `greater-element' Don't recurse into greater elements excepted
4060 headlines and sections. Thus, elements
4061 parsed are the top-level ones.
4062 `element' Parse everything but objects and plain text.
4063 `object' Parse the complete buffer (default).
4065 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4066 elements.
4068 An element or an objects is represented as a list with the
4069 pattern (TYPE PROPERTIES CONTENTS), where :
4071 TYPE is a symbol describing the element or object. See
4072 `org-element-all-elements' and `org-element-all-objects' for an
4073 exhaustive list of such symbols. One can retrieve it with
4074 `org-element-type' function.
4076 PROPERTIES is the list of attributes attached to the element or
4077 object, as a plist. Although most of them are specific to the
4078 element or object type, all types share `:begin', `:end',
4079 `:post-blank' and `:parent' properties, which respectively
4080 refer to buffer position where the element or object starts,
4081 ends, the number of white spaces or blank lines after it, and
4082 the element or object containing it. Properties values can be
4083 obtained by using `org-element-property' function.
4085 CONTENTS is a list of elements, objects or raw strings
4086 contained in the current element or object, when applicable.
4087 One can access them with `org-element-contents' function.
4089 The Org buffer has `org-data' as type and nil as properties.
4090 `org-element-map' function can be used to find specific elements
4091 or objects within the parse tree.
4093 This function assumes that current major mode is `org-mode'."
4099 ;; Start in `first-section' mode so text before the first
4100 ;; headline belongs to a section.
4104 "Recursively parse objects in STRING and return structure.
4106 RESTRICTION is a symbol limiting the object types that will be
4107 looked after.
4109 Optional argument PARENT, when non-nil, is the element or object
4110 containing the secondary string. It is used to set correctly
4111 `:parent' property within the string."
4112 ;; Copy buffer-local variables listed in
4113 ;; `org-element-object-variables' into temporary buffer. This is
4114 ;; required since object parsing is dependent on these variables.
4118 org-element-object-variables))))
4126 secondary))
4127 secondary))))
4131 "Map a function on selected elements or objects.
4133 DATA is a parse tree, an element, an object, a string, or a list
4134 of such constructs. TYPES is a symbol or list of symbols of
4135 elements or objects types (see `org-element-all-elements' and
4136 `org-element-all-objects' for a complete list of types). FUN is
4137 the function called on the matching element or object. It has to
4138 accept one argument: the element or object itself.
4140 When optional argument INFO is non-nil, it should be a plist
4141 holding export options. In that case, parts of the parse tree
4142 not exportable according to that property list will be skipped.
4144 When optional argument FIRST-MATCH is non-nil, stop at the first
4145 match for which FUN doesn't return nil, and return that value.
4147 Optional argument NO-RECURSION is a symbol or a list of symbols
4148 representing elements or objects types. `org-element-map' won't
4149 enter any recursive element or object whose type belongs to that
4150 list. Though, FUN can still be applied on them.
4152 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4153 apply to matching objects within parsed affiliated keywords (see
4154 `org-element-parsed-keywords').
4156 Nil values returned from FUN do not appear in the results.
4159 Examples:
4160 ---------
4162 Assuming TREE is a variable containing an Org buffer parse tree,
4163 the following example will return a flat list of all `src-block'
4164 and `example-block' elements in it:
4166 \(org-element-map tree '(example-block src-block) 'identity)
4168 The following snippet will find the first headline with a level
4171 \(org-element-map tree 'headline
4172 \(lambda (hl)
4173 \(and (= (org-element-property :level hl) 1)
4175 \(org-element-property :begin hl)))
4176 nil t)
4178 The next example will return a flat list of all `plain-list' type
4179 elements in TREE that are not a sub-list themselves:
4181 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4183 Eventually, this example will return a flat list of all `bold'
4184 type objects containing a `latex-snippet' type object, even
4185 looking into captions:
4187 \(org-element-map tree 'bold
4188 \(lambda (b)
4189 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4190 nil nil nil t)"
4191 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4194 ;; Recursion depth is determined by --CATEGORY.
4201 ;; If one object is found, the function
4202 ;; has to recurse into every object.
4205 ;; If one regular element is found, the
4206 ;; function has to recurse, at least,
4207 ;; into every element it encounters.
4210 types)
4211 category)))
4212 ;; Compute properties for affiliated keywords if necessary.
4217 org-element-affiliated-keywords)))
4218 --acc
4219 --walk-tree
4223 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4224 ;; holding contextual information.
4228 ;; Ignored element in an export context.
4230 ;; List of elements or objects.
4232 ;; Unconditionally enter parse trees.
4236 ;; Check if TYPE is matching among TYPES. If so,
4237 ;; apply FUN to --DATA and accumulate return value
4238 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4244 ;; If --DATA has a secondary string that can contain
4245 ;; objects with their type among TYPES, look into it.
4252 ;; If --DATA has any affiliated keywords and
4253 ;; WITH-AFFILIATED is non-nil, look for objects in
4254 ;; them.
4262 ;; Pay attention to the type of value.
4263 ;; Preserve order for multiple keywords.
4279 --affiliated-alist))
4280 ;; Determine if a recursion into --DATA is possible.
4282 ;; --TYPE is explicitly removed from recursion.
4284 ;; --DATA has no contents.
4286 ;; Looking for greater elements but --DATA is simply
4287 ;; an element or an object.
4290 ;; Looking for elements but --DATA is an object.
4293 ;; In any other case, map contents.
4297 ;; Return value in a proper order.
4301 ;; The following functions are internal parts of the parser.
4302 ;;
4303 ;; The first one, `org-element--parse-elements' acts at the element's
4304 ;; level.
4305 ;;
4306 ;; The second one, `org-element--parse-objects' applies on all objects
4307 ;; of a paragraph or a secondary string. It uses
4308 ;; `org-element--get-next-object-candidates' to optimize the search of
4309 ;; the next object in the buffer.
4310 ;;
4311 ;; More precisely, that function looks for every allowed object type
4312 ;; first. Then, it discards failed searches, keeps further matches,
4313 ;; and searches again types matched behind point, for subsequent
4314 ;; calls. Thus, searching for a given type fails only once, and every
4315 ;; object is searched only once at top level (but sometimes more for
4316 ;; nested types).
4320 "Parse elements between BEG and END positions.
4322 SPECIAL prioritize some elements over the others. It can be set
4323 to `first-section', `quote-section', `section' `item' or
4324 `table-row'.
4326 When value is `item', STRUCTURE will be used as the current list
4327 structure.
4329 GRANULARITY determines the depth of the recursion. See
4330 `org-element-parse-buffer' for more information.
4332 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4333 elements.
4335 Elements are accumulated into ACC."
4338 ;; Visible only: skip invisible parts at the beginning of the
4339 ;; element.
4342 ;; When parsing only headlines, skip any text before first one.
4345 ;; Main loop start.
4347 ;; Find current element's type and parse it accordingly to
4348 ;; its category.
4350 end granularity special structure))
4354 ;; Visible only: skip invisible parts between siblings.
4357 ;; Fill ELEMENT contents by side-effect.
4359 ;; If element has no contents, don't modify it.
4361 ;; Greater element: parse it between `contents-begin' and
4362 ;; `contents-end'. Make sure GRANULARITY allows the
4363 ;; recursion, or ELEMENT is a headline, in which case going
4364 ;; inside is mandatory, in order to get sub-level headings.
4372 ;; Possibly switch to a special mode.
4382 granularity visible-only element))
4383 ;; ELEMENT has contents. Parse objects inside, if
4384 ;; GRANULARITY allows it.
4390 ;; Return result.
4391 acc))
4394 "Parse objects between BEG and END and return recursive structure.
4396 Objects are accumulated in ACC.
4398 RESTRICTION is a list of object successors which are allowed in
4399 the current object."
4405 end restriction candidates)))
4412 ;; 1. Text before any object. Untabify it.
4417 acc
4421 ;; 2. Object...
4424 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4425 ;; a recursive type.
4430 cont-beg
4437 ;; 3. Text after last object. Untabify it.
4441 acc
4445 ;; Result.
4446 acc)))
4449 "Return an alist of candidates for the next object.
4451 LIMIT bounds the search, and RESTRICTION narrows candidates to
4452 some object successors.
4454 OBJECTS is the previous candidates alist. If it is set to
4455 `initial', no search has been done before, and all symbols in
4456 RESTRICTION should be looked after.
4458 Return value is an alist whose CAR is the object type and CDR its
4459 beginning position."
4461 nil
4463 ;; When searching for the first time, look for every successor
4464 ;; allowed in RESTRICTION.
4468 restriction)
4469 ;; Focus on objects returned during last search. Keep those
4470 ;; still after point. Search again objects before it.
4476 type)))
4479 limit)))))
4480 objects))))
4483 \f
4484 ;;; Towards A Bijective Process
4485 ;;
4486 ;; The parse tree obtained with `org-element-parse-buffer' is really
4487 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4488 ;; interpreted and expanded into a string with canonical Org syntax.
4489 ;; Hence `org-element-interpret-data'.
4490 ;;
4491 ;; The function relies internally on
4492 ;; `org-element--interpret-affiliated-keywords'.
4494 ;;;###autoload
4496 "Interpret DATA as Org syntax.
4498 DATA is a parse tree, an element, an object or a secondary string
4499 to interpret.
4501 Optional argument PARENT is used for recursive calls. It contains
4502 the element or object containing data, or nil.
4504 Return Org syntax as a string."
4508 ;; Secondary string.
4513 ;; Full Org document.
4518 ;; Plain text: remove `:parent' text property from output.
4520 ;; Element/Object without contents.
4523 data nil))
4524 ;; Element/Object with contents.
4534 ;; Elements directly containing objects must
4535 ;; have their indentation normalized first.
4537 data
4538 ;; When normalizing first paragraph of an
4539 ;; item or a footnote-definition, ignore
4540 ;; first line's indentation.
4547 data
4549 contents)))))))
4551 ;; Build white spaces. If no `:post-blank' property is
4552 ;; specified, assume its value is 0.
4562 "Return ELEMENT's affiliated keywords as Org syntax.
4563 If there is no affiliated keyword, return the empty string."
4573 ": "
4576 value)
4584 ;; All attribute keywords can have multiple lines.
4590 ;; List all ELEMENT's properties matching an attribute line or an
4591 ;; affiliated keyword, but ignore translated keywords since they
4592 ;; cannot belong to the property list.
4599 org-element-keyword-translation-alist)))))
4600 collect prop)
4603 ;; Because interpretation of the parse tree must return the same
4604 ;; number of blank lines between elements and the same number of white
4605 ;; space after objects, some special care must be given to white
4606 ;; spaces.
4607 ;;
4608 ;; The first function, `org-element-normalize-string', ensures any
4609 ;; string different from the empty string will end with a single
4610 ;; newline character.
4611 ;;
4612 ;; The second function, `org-element-normalize-contents', removes
4613 ;; global indentation from the contents of the current element.
4616 "Ensure string S ends with a single newline character.
4618 If S isn't a string return it unchanged. If S is the empty
4619 string, return it. Otherwise, return a new string with a single
4620 newline character at its end."
4628 "Normalize plain text in ELEMENT's contents.
4630 ELEMENT must only contain plain text and objects.
4632 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4633 indentation to compute maximal common indentation.
4635 Return the normalized element that is element with global
4636 indentation removed from its contents. The function assumes that
4637 indentation is not done with TAB characters."
4639 collect-inds ; for byte-compiler
4642 ;; Return list of indentations within BLOB. This is done by
4643 ;; walking recursively BLOB and updating IND-LIST along the
4644 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4645 ;; been seen yet. It is required as this string is the only
4646 ;; one whose indentation doesn't happen after a newline
4647 ;; character.
4655 ;; An indentation of zero means no string will be
4656 ;; modified. Quit the process.
4662 ;; Avoid matching blank or empty lines.
4670 ;; Collect indentation list in ELEMENT. Possibly remove first
4671 ;; value if IGNORE-FIRST is non-nil.
4674 ;; Build ELEMENT back, replacing each string with the same
4675 ;; string minus common indentation.
4680 ;; Return BLOB with all its strings indentation
4681 ;; shortened from MCI white spaces. FIRST-FLAG is
4682 ;; non-nil when the first string hasn't been seen
4683 ;; yet.
4697 org-element-recursive-objects)
4701 blob))))
4705 \f
4706 ;;; The Toolbox
4707 ;;
4708 ;; The first move is to implement a way to obtain the smallest element
4709 ;; containing point. This is the job of `org-element-at-point'. It
4710 ;; basically jumps back to the beginning of section containing point
4711 ;; and moves, element after element, with
4712 ;; `org-element--current-element' until the container is found. Note:
4713 ;; When using `org-element-at-point', secondary values are never
4714 ;; parsed since the function focuses on elements, not on objects.
4715 ;;
4716 ;; At a deeper level, `org-element-context' lists all elements and
4717 ;; objects containing point.
4718 ;;
4719 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4720 ;; internally by navigation and manipulation tools.
4722 ;;;###autoload
4724 "Determine closest element around point.
4726 Return value is a list like (TYPE PROPS) where TYPE is the type
4727 of the element and PROPS a plist of properties associated to the
4728 element.
4730 Possible types are defined in `org-element-all-elements'.
4731 Properties depend on element or object type, but always include
4732 `:begin', `:end', `:parent' and `:post-blank' properties.
4734 As a special case, if point is at the very beginning of a list or
4735 sub-list, returned element will be that list instead of the first
4736 item. In the same way, if point is at the beginning of the first
4737 row of a table, returned element will be the table instead of the
4738 first row.
4740 If optional argument KEEP-TRAIL is non-nil, the function returns
4741 a list of elements leading to element at point. The list's CAR
4742 is always the element at point. The following positions contain
4743 element's siblings, then parents, siblings of parents, until the
4744 first element of current section."
4746 ;; If at a headline, parse it. It is the sole element that
4747 ;; doesn't require to know about context. Be sure to disallow
4748 ;; secondary string parsing, though.
4754 ;; Otherwise move at the beginning of the section containing
4755 ;; point.
4760 element type special-flag trail struct prevs parent)
4763 ;; In empty lines at buffer's beginning, return nil.
4772 ;; In blank lines just after the headline, point still
4773 ;; belongs to the headline.
4781 ;; Parse successively each element, skipping those ending
4782 ;; before original position.
4790 ;; 1. Skip any element ending before point. Also skip
4791 ;; element ending at point when we're sure that another
4792 ;; element has started.
4797 ;; 2. An element containing point is always the element at
4798 ;; point.
4801 ;; 3. At any other greater element type, if point is
4802 ;; within contents, move into it.
4807 ;; Create an anchor for tables and plain lists:
4808 ;; when point is at the very beginning of these
4809 ;; elements, ignoring affiliated keywords,
4810 ;; target them instead of their contents.
4812 ;; When point is at contents end, do not move
4813 ;; into elements with an explicit ending, but
4814 ;; return that element instead.
4818 drawer dynamic-block inlinetask item
4819 plain-list property-drawer quote-block
4820 special-block))))
4835 ;;;###autoload
4837 "Return closest element or object around point.
4839 Return value is a list like (TYPE PROPS) where TYPE is the type
4840 of the element or object and PROPS a plist of properties
4841 associated to it.
4843 Possible types are defined in `org-element-all-elements' and
4844 `org-element-all-objects'. Properties depend on element or
4845 object type, but always include `:begin', `:end', `:parent' and
4846 `:post-blank'.
4848 Optional argument ELEMENT, when non-nil, is the closest element
4849 containing point, as returned by `org-element-at-point'.
4850 Providing it allows for quicker computation."
4855 end)
4856 ;; Check if point is inside an element containing objects or at
4857 ;; a secondary string. In that case, move to beginning of the
4858 ;; element or secondary string and set END to the other side.
4865 org-element-parsed-keywords))
4866 ;; We're at an affiliated keyword. Change
4867 ;; type to retrieve correct restrictions.
4869 ;; Determine if we're at main or dual value.
4883 (<= origin
4884 ;; `1+' is required so some
4885 ;; successors can match
4886 ;; properly their object.
4908 element
4914 end restriction candidates))
4916 candidates)))
4917 ;; If ORIGIN is before next object in element, there's
4918 ;; no point in looking further.
4928 ;; ORIGIN is after OBJECT, so skip it.
4934 ;; ORIGIN is within a non-recursive object or at
4935 ;; an object boundaries: Return that object.
4939 ;; Otherwise, move within current object and
4940 ;; restrict search to the end of its contents.
4945 candidates 'initial
4946 end cend)))))))
4947 parent))))))
4950 "Non-nil when elements ELEM-A and ELEM-B are nested."
4959 "Swap elements ELEM-A and ELEM-B.
4960 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4961 end of ELEM-A."
4963 ;; There are two special cases when an element doesn't start at bol:
4964 ;; the first paragraph in an item or in a footnote definition.
4966 ;; Only a paragraph without any affiliated keyword can be moved at
4967 ;; ELEM-A position in such a situation. Note that the case of
4968 ;; a footnote definition is impossible: it cannot contain two
4969 ;; paragraphs in a row because it cannot contain a blank line.
4975 ;; In a special situation, ELEM-A will have no indentation. We'll
4976 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4990 ;; Store overlays responsible for visibility status. We
4991 ;; also need to store their boundaries as they will be
4992 ;; removed from buffer.
4999 ;; Get contents.
5007 ;; Restore ex ELEM-A overlays.
5016 ;; Restore ex ELEM-B overlays.
5025 ;; Local variables:
5026 ;; generated-autoload-file: "org-loaddefs.el"
5027 ;; End:
5029 ;;; org-element.el ends here