| blob | 0a3f5f602f200517e0b91785386747c07442257b |
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."
1265 ;; Return value.
1269 :begin begin
1270 :end end
1271 :contents-begin contents-begin
1272 :contents-end contents-end
1273 :structure struct
1279 "Interpret PLAIN-LIST element as Org syntax.
1280 CONTENTS is the contents of the element."
1288 ;;;; Property Drawer
1291 "Parse a property drawer.
1293 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1294 the buffer position at the beginning of the first affiliated
1295 keyword and CDR is a plist of affiliated keywords along with
1296 their value.
1298 Return a list whose CAR is `property-drawer' and CDR is a plist
1299 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1300 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1302 Assume point is at the beginning of the property drawer."
1307 ;; Incomplete drawer: parse it as a paragraph.
1327 :end end
1328 :hiddenp hidden
1329 :contents-begin contents-begin
1330 :contents-end contents-end
1336 "Interpret PROPERTY-DRAWER element as Org syntax.
1337 CONTENTS is the properties within the drawer."
1341 ;;;; Quote Block
1344 "Parse a quote block.
1346 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1347 the buffer position at the beginning of the first affiliated
1348 keyword and CDR is a plist of affiliated keywords along with
1349 their value.
1351 Return a list whose CAR is `quote-block' and CDR is a plist
1352 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1353 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1355 Assume point is at the beginning of the block."
1359 ;; Incomplete block: parse it as a paragraph.
1365 ;; Empty blocks have no contents.
1380 :end end
1381 :hiddenp hidden
1382 :contents-begin contents-begin
1383 :contents-end contents-end
1389 "Interpret QUOTE-BLOCK element as Org syntax.
1390 CONTENTS is the contents of the element."
1394 ;;;; Section
1397 "Parse a section.
1399 LIMIT bounds the search.
1401 Return a list whose CAR is `section' and CDR is a plist
1402 containing `:begin', `:end', `:contents-begin', `contents-end'
1403 and `:post-blank' keywords."
1405 ;; Beginning of section is the beginning of the first non-blank
1406 ;; line after previous headline.
1415 :end end
1416 :contents-begin begin
1417 :contents-end pos-before-blank
1421 "Interpret SECTION element as Org syntax.
1422 CONTENTS is the contents of the element."
1423 contents)
1426 ;;;; Special Block
1429 "Parse a special block.
1431 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1432 the buffer position at the beginning of the first affiliated
1433 keyword and CDR is a plist of affiliated keywords along with
1434 their value.
1436 Return a list whose CAR is `special-block' and CDR is a plist
1437 containing `:type', `:begin', `:end', `:hiddenp',
1438 `:contents-begin', `:contents-end', `:post-blank' and
1439 `:post-affiliated' keywords.
1441 Assume point is at the beginning of the block."
1448 limit t)))
1449 ;; Incomplete block: parse it as a paragraph.
1455 ;; Empty blocks have no contents.
1470 :begin begin
1471 :end end
1472 :hiddenp hidden
1473 :contents-begin contents-begin
1474 :contents-end contents-end
1480 "Interpret SPECIAL-BLOCK element as Org syntax.
1481 CONTENTS is the contents of the element."
1486 \f
1487 ;;; Elements
1488 ;;
1489 ;; For each element, a parser and an interpreter are also defined.
1490 ;; Both follow the same naming convention used for greater elements.
1491 ;;
1492 ;; Also, as for greater elements, adding a new element type is done
1493 ;; through the following steps: implement a parser and an interpreter,
1494 ;; tweak `org-element--current-element' so that it recognizes the new
1495 ;; type and add that new type to `org-element-all-elements'.
1496 ;;
1497 ;; As a special case, when the newly defined type is a block type,
1498 ;; `org-element-block-name-alist' has to be modified accordingly.
1501 ;;;; Babel Call
1504 "Parse a babel call.
1506 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1507 the buffer position at the beginning of the first affiliated
1508 keyword and CDR is a plist of affiliated keywords along with
1509 their value.
1511 Return a list whose CAR is `babel-call' and CDR is a plist
1512 containing `:begin', `:end', `:info', `:post-blank' and
1513 `:post-affiliated' as keywords."
1527 :end end
1528 :info info
1534 "Interpret BABEL-CALL element as Org syntax.
1535 CONTENTS is nil."
1541 ;; Remove redundant square brackets.
1546 ;;;; Clock
1549 "Parse a clock.
1551 LIMIT bounds the search.
1553 Return a list whose CAR is `clock' and CDR is a plist containing
1554 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1555 as keywords."
1575 :value value
1576 :duration duration
1577 :begin begin
1578 :end end
1582 "Interpret CLOCK element as Org syntax.
1583 CONTENTS is nil."
1591 "%2s:%02s"
1595 ;;;; Comment
1598 "Parse a comment.
1600 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1601 the buffer position at the beginning of the first affiliated
1602 keyword and CDR is a plist of affiliated keywords along with
1603 their value.
1605 Return a list whose CAR is `comment' and CDR is a plist
1606 containing `:begin', `:end', `:value', `:post-blank',
1607 `:post-affiliated' keywords.
1609 Assume point is at comment beginning."
1618 ;; Get comments ending.
1621 ;; Accumulate lines without leading hash and first
1622 ;; whitespace.
1637 :end end
1638 :value value
1644 "Interpret COMMENT element as Org syntax.
1645 CONTENTS is nil."
1649 ;;;; Comment Block
1652 "Parse an export block.
1654 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1655 the buffer position at the beginning of the first affiliated
1656 keyword and CDR is a plist of affiliated keywords along with
1657 their value.
1659 Return a list whose CAR is `comment-block' and CDR is a plist
1660 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1661 and `:post-affiliated' keywords.
1663 Assume point is at comment block beginning."
1667 ;; Incomplete block: parse it as a paragraph.
1682 contents-begin contents-end)))
1686 :end end
1687 :value value
1688 :hiddenp hidden
1694 "Interpret COMMENT-BLOCK element as Org syntax.
1695 CONTENTS is nil."
1700 ;;;; Diary Sexp
1703 "Parse a diary sexp.
1705 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1706 the buffer position at the beginning of the first affiliated
1707 keyword and CDR is a plist of affiliated keywords along with
1708 their value.
1710 Return a list whose CAR is `diary-sexp' and CDR is a plist
1711 containing `:begin', `:end', `:value', `:post-blank' and
1712 `:post-affiliated' keywords."
1725 :begin begin
1726 :end end
1732 "Interpret DIARY-SEXP as Org syntax.
1733 CONTENTS is nil."
1737 ;;;; Example Block
1740 "Remove maximum common indentation in string S and return it.
1741 When optional argument N is a positive integer, remove exactly
1742 that much characters from indentation, if possible, or return
1743 S as-is otherwise. Unlike to `org-remove-indentation', this
1744 function doesn't call `untabify' on S."
1749 ;; Find maximum common indentation, if not specified.
1757 min-ind)))
1759 ;; Remove exactly N indentation, but give up if not possible.
1769 "Parse an example block.
1771 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1772 the buffer position at the beginning of the first affiliated
1773 keyword and CDR is a plist of affiliated keywords along with
1774 their value.
1776 Return a list whose CAR is `example-block' and CDR is a plist
1777 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1778 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1779 `:switches', `:value', `:post-blank' and `:post-affiliated'
1780 keywords."
1784 ;; Incomplete block: parse it as a paragraph.
1792 ;; Switches analysis
1800 ;; Should labels be retained in (or stripped from) example
1801 ;; blocks?
1806 ;; What should code-references use - labels or
1807 ;; line-numbers?
1816 ;; Standard block parsing.
1825 contents-begin contents-end))
1836 :end end
1837 :value value
1838 :switches switches
1839 :number-lines number-lines
1840 :preserve-indent preserve-indent
1841 :retain-labels retain-labels
1842 :use-labels use-labels
1843 :label-fmt label-fmt
1844 :hiddenp hidden
1850 "Interpret EXAMPLE-BLOCK element as Org syntax.
1851 CONTENTS is nil."
1859 ;;;; Export Block
1862 "Parse an export block.
1864 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1865 the buffer position at the beginning of the first affiliated
1866 keyword and CDR is a plist of affiliated keywords along with
1867 their value.
1869 Return a list whose CAR is `export-block' and CDR is a plist
1870 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1871 `:post-blank' and `:post-affiliated' keywords.
1873 Assume point is at export-block beginning."
1880 ;; Incomplete block: parse it as a paragraph.
1895 contents-end)))
1899 :end end
1900 :type type
1901 :value value
1902 :hiddenp hidden
1908 "Interpret EXPORT-BLOCK element as Org syntax.
1909 CONTENTS is nil."
1916 ;;;; Fixed-width
1919 "Parse a fixed-width section.
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 `fixed-width' and CDR is a plist
1927 containing `:begin', `:end', `:value', `:post-blank' and
1928 `:post-affiliated' keywords.
1930 Assume point is at the beginning of the fixed-width area."
1934 value
1939 ;; Accumulate text without starting colons.
1953 :end end
1954 :value value
1960 "Interpret FIXED-WIDTH element as Org syntax.
1961 CONTENTS is nil."
1969 ;;;; Horizontal Rule
1972 "Parse an horizontal rule.
1974 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1975 the buffer position at the beginning of the first affiliated
1976 keyword and CDR is a plist of affiliated keywords along with
1977 their value.
1979 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1980 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1981 keywords."
1992 :end end
1998 "Interpret HORIZONTAL-RULE element as Org syntax.
1999 CONTENTS is nil."
2003 ;;;; Keyword
2006 "Parse a keyword at point.
2008 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2009 the buffer position at the beginning of the first affiliated
2010 keyword and CDR is a plist of affiliated keywords along with
2011 their value.
2013 Return a list whose CAR is `keyword' and CDR is a plist
2014 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2015 `:post-affiliated' keywords."
2030 :value value
2031 :begin begin
2032 :end end
2038 "Interpret KEYWORD element as Org syntax.
2039 CONTENTS is nil."
2045 ;;;; Latex Environment
2048 "Parse a LaTeX environment.
2050 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2051 the buffer position at the beginning of the first affiliated
2052 keyword and CDR is a plist of affiliated keywords along with
2053 their value.
2055 Return a list whose CAR is `latex-environment' and CDR is a plist
2056 containing `:begin', `:end', `:value', `:post-blank' and
2057 `:post-affiliated' keywords.
2059 Assume point is at the beginning of the latex environment."
2066 limit t))
2067 ;; Incomplete latex environment: parse it as a paragraph.
2078 :end end
2079 :value value
2085 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2086 CONTENTS is nil."
2090 ;;;; Node Property
2093 "Parse a node-property at point.
2095 LIMIT bounds the search.
2097 Return a list whose CAR is `node-property' and CDR is a plist
2098 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2099 keywords."
2111 :value value
2112 :begin begin
2113 :end end
2117 "Interpret NODE-PROPERTY element as Org syntax.
2118 CONTENTS is nil."
2124 ;;;; Paragraph
2127 "Parse a paragraph.
2129 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2130 the buffer position at the beginning of the first affiliated
2131 keyword and CDR is a plist of affiliated keywords along with
2132 their value.
2134 Return a list whose CAR is `paragraph' and CDR is a plist
2135 containing `:begin', `:end', `:contents-begin' and
2136 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2138 Assume point is at the beginning of the paragraph."
2147 limit
2148 ;; A matching `org-element-paragraph-separate' is not
2149 ;; necessarily the end of the paragraph. In
2150 ;; particular, lines starting with # or : as a first
2151 ;; non-space character are ambiguous. We have check
2152 ;; if they are valid Org syntax (i.e. not an
2153 ;; incomplete keyword).
2157 ;; There's no ambiguity for other symbols or
2158 ;; empty lines: stop here.
2160 ;; Stop at valid fixed-width areas.
2162 ;; Stop at drawers.
2167 ;; Stop at valid comments.
2169 ;; Stop at valid dynamic blocks.
2174 ;; Stop at valid blocks.
2181 limit t)))
2182 ;; Stop at valid latex environments.
2189 limit t)))
2190 ;; Stop at valid keywords.
2192 ;; Skip everything else.
2210 :end end
2211 :contents-begin contents-begin
2212 :contents-end contents-end
2218 "Interpret PARAGRAPH element as Org syntax.
2219 CONTENTS is the contents of the element."
2220 contents)
2223 ;;;; Planning
2226 "Parse a planning.
2228 LIMIT bounds the search.
2230 Return a list whose CAR is `planning' and CDR is a plist
2231 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2232 and `:post-blank' keywords."
2242 closed deadline scheduled)
2254 :deadline deadline
2255 :scheduled scheduled
2256 :begin begin
2257 :end end
2261 "Interpret PLANNING element as Org syntax.
2262 CONTENTS is nil."
2264 'identity
2281 ;;;; Quote Section
2284 "Parse a quote section.
2286 LIMIT bounds the search.
2288 Return a list whose CAR is `quote-section' and CDR is a plist
2289 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2291 Assume point is at beginning of the section."
2302 :end end
2303 :value value
2307 "Interpret QUOTE-SECTION element as Org syntax.
2308 CONTENTS is nil."
2312 ;;;; Src Block
2315 "Parse a src block.
2317 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2318 the buffer position at the beginning of the first affiliated
2319 keyword and CDR is a plist of affiliated keywords along with
2320 their value.
2322 Return a list whose CAR is `src-block' and CDR is a plist
2323 containing `:language', `:switches', `:parameters', `:begin',
2324 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2325 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2326 `:post-blank' and `:post-affiliated' keywords.
2328 Assume point is at the beginning of the block."
2331 limit t)))
2332 ;; Incomplete block: parse it as a paragraph.
2338 ;; Get language as a string.
2347 ;; Get switches.
2349 ;; Get parameters.
2351 ;; Switches analysis
2363 ;; Should labels be retained in (or stripped from)
2364 ;; src blocks?
2369 ;; What should code-references use - labels or
2370 ;; line-numbers?
2375 ;; Indentation.
2377 ;; Get visibility status.
2379 ;; Retrieve code.
2388 ;; Get position after ending blank lines.
2399 :begin begin
2400 :end end
2401 :number-lines number-lines
2402 :preserve-indent preserve-indent
2403 :retain-labels retain-labels
2404 :use-labels use-labels
2405 :label-fmt label-fmt
2406 :hiddenp hidden
2407 :value value
2413 "Interpret SRC-BLOCK element as Org syntax.
2414 CONTENTS is nil."
2435 ;;;; Table
2438 "Parse a table at point.
2440 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2441 the buffer position at the beginning of the first affiliated
2442 keyword and CDR is a plist of affiliated keywords along with
2443 their value.
2445 Return a list whose CAR is `table' and CDR is a plist containing
2446 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2447 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2448 keywords.
2450 Assume point is at the beginning of the table."
2464 acc))
2472 :end end
2473 :type type
2474 :tblfm tblfm
2475 ;; Only `org' tables have contents. `table.el' tables
2476 ;; use a `:value' property to store raw table as
2477 ;; a string.
2482 table-begin table-end))
2488 "Interpret TABLE element as Org syntax.
2489 CONTENTS is nil."
2500 ;;;; Table Row
2503 "Parse table row at point.
2505 LIMIT bounds the search.
2507 Return a list whose CAR is `table-row' and CDR is a plist
2508 containing `:begin', `:end', `:contents-begin', `:contents-end',
2509 `:type' and `:post-blank' keywords."
2513 ;; A table rule has no contents. In that case, ensure
2514 ;; CONTENTS-BEGIN matches CONTENTS-END.
2526 :begin begin
2527 :end end
2528 :contents-begin contents-begin
2529 :contents-end contents-end
2533 "Interpret TABLE-ROW element as Org syntax.
2534 CONTENTS is the contents of the table row."
2539 ;;;; Verse Block
2542 "Parse a verse block.
2544 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2545 the buffer position at the beginning of the first affiliated
2546 keyword and CDR is a plist of affiliated keywords along with
2547 their value.
2549 Return a list whose CAR is `verse-block' and CDR is a plist
2550 containing `:begin', `:end', `:contents-begin', `:contents-end',
2551 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2553 Assume point is at beginning of the block."
2557 ;; Incomplete block: parse it as a paragraph.
2574 :end end
2575 :contents-begin contents-begin
2576 :contents-end contents-end
2577 :hiddenp hidden
2583 "Interpret VERSE-BLOCK element as Org syntax.
2584 CONTENTS is verse block contents."
2588 \f
2589 ;;; Objects
2590 ;;
2591 ;; Unlike to elements, interstices can be found between objects.
2592 ;; That's why, along with the parser, successor functions are provided
2593 ;; for each object. Some objects share the same successor (i.e. `code'
2594 ;; and `verbatim' objects).
2595 ;;
2596 ;; A successor must accept a single argument bounding the search. It
2597 ;; will return either a cons cell whose CAR is the object's type, as
2598 ;; a symbol, and CDR the position of its next occurrence, or nil.
2599 ;;
2600 ;; Successors follow the naming convention:
2601 ;; org-element-NAME-successor, where NAME is the name of the
2602 ;; successor, as defined in `org-element-all-successors'.
2603 ;;
2604 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2605 ;; object types they can contain will be specified in
2606 ;; `org-element-object-restrictions'.
2607 ;;
2608 ;; Adding a new type of object is simple. Implement a successor,
2609 ;; a parser, and an interpreter for it, all following the naming
2610 ;; convention. Register type in `org-element-all-objects' and
2611 ;; successor in `org-element-all-successors'. Maybe tweak
2612 ;; restrictions about it, and that's it.
2615 ;;;; Bold
2618 "Parse bold object at point.
2620 Return a list whose CAR is `bold' and CDR is a plist with
2621 `:begin', `:end', `:contents-begin' and `:contents-end' and
2622 `:post-blank' keywords.
2624 Assume point is at the first star marker."
2636 :end end
2637 :contents-begin contents-begin
2638 :contents-end contents-end
2642 "Interpret BOLD object as Org syntax.
2643 CONTENTS is the contents of the object."
2647 "Search for the next text-markup object.
2649 LIMIT bounds the search.
2651 Return value is a cons cell whose CAR is a symbol among `bold',
2652 `italic', `underline', `strike-through', `code' and `verbatim'
2653 and CDR is beginning position."
2669 ;;;; Code
2672 "Parse code object at point.
2674 Return a list whose CAR is `code' and CDR is a plist with
2675 `:value', `:begin', `:end' and `:post-blank' keywords.
2677 Assume point is at the first tilde marker."
2688 :begin begin
2689 :end end
2693 "Interpret CODE object as Org syntax.
2694 CONTENTS is nil."
2698 ;;;; Entity
2701 "Parse entity at point.
2703 Return a list whose CAR is `entity' and CDR a plist with
2704 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2705 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2706 keywords.
2708 Assume point is at the beginning of the entity."
2710 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2726 :begin begin
2727 :end end
2728 :use-brackets-p bracketsp
2732 "Interpret ENTITY object as Org syntax.
2733 CONTENTS is nil."
2739 "Search for the next latex-fragment or entity object.
2741 LIMIT bounds the search.
2743 Return value is a cons cell whose CAR is `entity' or
2744 `latex-fragment' and CDR is beginning position."
2749 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2756 limit t)
2759 ;; Determine if it's a real entity or a LaTeX command.
2762 ;; No entity nor command: point is at a LaTeX fragment.
2763 ;; Determine its type to get the correct beginning position.
2771 matchers)
2775 ;;;; Export Snippet
2778 "Parse export snippet at point.
2780 Return a list whose CAR is `export-snippet' and CDR a plist with
2781 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2782 keywords.
2784 Assume point is at the beginning of the snippet."
2796 :value value
2797 :begin begin
2798 :end end
2802 "Interpret EXPORT-SNIPPET object as Org syntax.
2803 CONTENTS is nil."
2809 "Search for the next export-snippet object.
2811 LIMIT bounds the search.
2813 Return value is a cons cell whose CAR is `export-snippet' and CDR
2814 its beginning position."
2823 ;;;; Footnote Reference
2826 "Parse footnote reference at point.
2828 Return a list whose CAR is `footnote-reference' and CDR a plist
2829 with `:label', `:type', `:inline-definition', `:begin', `:end'
2830 and `:post-blank' as keywords."
2852 :type type
2853 :begin begin
2854 :end end
2857 footnote-reference :inline-definition
2862 footnote-reference))))))
2865 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2866 CONTENTS is nil."
2876 "Search for the next footnote-reference object.
2878 LIMIT bounds the search.
2880 Return value is a cons cell whose CAR is `footnote-reference' and
2881 CDR is beginning position."
2895 ;;;; Inline Babel Call
2898 "Parse inline babel call at point.
2900 Return a list whose CAR is `inline-babel-call' and CDR a plist
2901 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2903 Assume point is at the beginning of the babel call."
2914 :end end
2915 :info info
2919 "Interpret INLINE-BABEL-CALL object as Org syntax.
2920 CONTENTS is nil."
2926 ;; Remove redundant square brackets.
2929 main-source)
2933 "Search for the next inline-babel-call object.
2935 LIMIT bounds the search.
2937 Return value is a cons cell whose CAR is `inline-babel-call' and
2938 CDR is beginning position."
2940 ;; Use a simplified version of
2941 ;; `org-babel-inline-lob-one-liner-regexp'.
2944 limit t)
2948 ;;;; Inline Src Block
2951 "Parse inline source block at point.
2953 LIMIT bounds the search.
2955 Return a list whose CAR is `inline-src-block' and CDR a plist
2956 with `:begin', `:end', `:language', `:value', `:parameters' and
2957 `:post-blank' as keywords.
2959 Assume point is at the beginning of the inline src block."
2972 :value value
2973 :parameters parameters
2974 :begin begin
2975 :end end
2979 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2980 CONTENTS is nil."
2985 language
2987 body)))
2990 "Search for the next inline-babel-call element.
2992 LIMIT bounds the search.
2994 Return value is a cons cell whose CAR is `inline-babel-call' and
2995 CDR is beginning position."
3001 ;;;; Italic
3004 "Parse italic object at point.
3006 Return a list whose CAR is `italic' and CDR is a plist with
3007 `:begin', `:end', `:contents-begin' and `:contents-end' and
3008 `:post-blank' keywords.
3010 Assume point is at the first slash marker."
3022 :end end
3023 :contents-begin contents-begin
3024 :contents-end contents-end
3028 "Interpret ITALIC object as Org syntax.
3029 CONTENTS is the contents of the object."
3033 ;;;; Latex Fragment
3036 "Parse latex fragment at point.
3038 Return a list whose CAR is `latex-fragment' and CDR a plist with
3039 `:value', `:begin', `:end', and `:post-blank' as keywords.
3041 Assume point is at the beginning of the latex fragment."
3055 ;; None found: it's a macro.
3064 :begin begin
3065 :end end
3069 "Interpret LATEX-FRAGMENT object as Org syntax.
3070 CONTENTS is nil."
3073 ;;;; Line Break
3076 "Parse line break at point.
3078 Return a list whose CAR is `line-break', and CDR a plist with
3079 `:begin', `:end' and `:post-blank' keywords.
3081 Assume point is at the beginning of the line break."
3088 "Interpret LINE-BREAK object as Org syntax.
3089 CONTENTS is nil."
3093 "Search for the next line-break object.
3095 LIMIT bounds the search.
3097 Return value is a cons cell whose CAR is `line-break' and CDR is
3098 beginning position."
3102 ;; A line break can only happen on a non-empty line.
3107 ;;;; Link
3110 "Parse link at point.
3112 Return a list whose CAR is `link' and CDR a plist with `:type',
3113 `:path', `:raw-link', `:application', `:search-option', `:begin',
3114 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3115 keywords.
3117 Assume point is at the beginning of the link."
3120 end contents-begin contents-end link-end post-blank path type
3121 raw-link link search-option application)
3123 ;; Type 1: Text targeted from a radio target.
3128 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3133 ;; RAW-LINK is the original link. Expand any
3134 ;; abbreviation in it.
3138 ;; Determine TYPE of link and set PATH accordingly.
3140 ;; File type.
3144 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3147 ;; Id type: PATH is the id.
3150 ;; Code-ref type: PATH is the name of the reference.
3153 ;; Custom-id type: PATH is the name of the custom id.
3156 ;; Fuzzy type: Internal link either matches a target, an
3157 ;; headline name or nothing. PATH is the target or
3158 ;; headline's name.
3160 ;; Type 3: Plain link, i.e. http://orgmode.org
3166 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3173 ;; In any case, deduce end point after trailing white space from
3174 ;; LINK-END variable.
3177 ;; Extract search option and opening application out of
3178 ;; "file"-type links.
3180 ;; Application.
3185 ;; Extract search option from PATH.
3189 ;; Make sure TYPE always reports "file".
3193 :path path
3195 :application application
3196 :search-option search-option
3197 :begin begin
3198 :end end
3199 :contents-begin contents-begin
3200 :contents-end contents-end
3204 "Interpret LINK object as Org syntax.
3205 CONTENTS is the contents of the object, or nil."
3210 raw-link
3214 "Search for the next link object.
3216 LIMIT bounds the search.
3218 Return value is a cons cell whose CAR is `link' and CDR is
3219 beginning position."
3228 "Search for the next plain link object.
3230 LIMIT bounds the search.
3232 Return value is a cons cell whose CAR is `link' and CDR is
3233 beginning position."
3238 ;;;; Macro
3241 "Parse macro at point.
3243 Return a list whose CAR is `macro' and CDR a plist with `:key',
3244 `:args', `:begin', `:end', `:value' and `:post-blank' as
3245 keywords.
3247 Assume point is at the macro."
3258 ;; Do not use `org-split-string' since empty
3259 ;; strings are meaningful here.
3267 args nil t)
3271 :value value
3272 :args args
3273 :begin begin
3274 :end end
3278 "Interpret MACRO object as Org syntax.
3279 CONTENTS is nil."
3283 "Search for the next macro object.
3285 LIMIT bounds the search.
3287 Return value is cons cell whose CAR is `macro' and CDR is
3288 beginning position."
3292 limit t)
3296 ;;;; Radio-target
3299 "Parse radio target at point.
3301 Return a list whose CAR is `radio-target' and CDR a plist with
3302 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3303 and `:post-blank' as keywords.
3305 Assume point is at the radio target."
3317 :end end
3318 :contents-begin contents-begin
3319 :contents-end contents-end
3320 :post-blank post-blank
3324 "Interpret TARGET object as Org syntax.
3325 CONTENTS is the contents of the object."
3329 "Search for the next radio-target object.
3331 LIMIT bounds the search.
3333 Return value is a cons cell whose CAR is `radio-target' and CDR
3334 is beginning position."
3340 ;;;; Statistics Cookie
3343 "Parse statistics cookie at point.
3345 Return a list whose CAR is `statistics-cookie', and CDR a plist
3346 with `:begin', `:end', `:value' and `:post-blank' keywords.
3348 Assume point is at the beginning of the statistics-cookie."
3359 :end end
3360 :value value
3364 "Interpret STATISTICS-COOKIE object as Org syntax.
3365 CONTENTS is nil."
3369 "Search for the next statistics cookie object.
3371 LIMIT bounds the search.
3373 Return value is a cons cell whose CAR is `statistics-cookie' and
3374 CDR is beginning position."
3380 ;;;; Strike-Through
3383 "Parse strike-through object at point.
3385 Return a list whose CAR is `strike-through' and CDR is a plist
3386 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3387 `:post-blank' keywords.
3389 Assume point is at the first plus sign marker."
3401 :end end
3402 :contents-begin contents-begin
3403 :contents-end contents-end
3407 "Interpret STRIKE-THROUGH object as Org syntax.
3408 CONTENTS is the contents of the object."
3412 ;;;; Subscript
3415 "Parse subscript at point.
3417 Return a list whose CAR is `subscript' and CDR a plist with
3418 `:begin', `:end', `:contents-begin', `:contents-end',
3419 `:use-brackets-p' and `:post-blank' as keywords.
3421 Assume point is at the underscore."
3425 t
3436 :end end
3437 :use-brackets-p bracketsp
3438 :contents-begin contents-begin
3439 :contents-end contents-end
3443 "Interpret SUBSCRIPT object as Org syntax.
3444 CONTENTS is the contents of the object."
3447 contents))
3450 "Search for the next sub/superscript object.
3452 LIMIT bounds the search.
3454 Return value is a cons cell whose CAR is either `subscript' or
3455 `superscript' and CDR is beginning position."
3463 ;;;; Superscript
3466 "Parse superscript at point.
3468 Return a list whose CAR is `superscript' and CDR a plist with
3469 `:begin', `:end', `:contents-begin', `:contents-end',
3470 `:use-brackets-p' and `:post-blank' as keywords.
3472 Assume point is at the caret."
3486 :end end
3487 :use-brackets-p bracketsp
3488 :contents-begin contents-begin
3489 :contents-end contents-end
3493 "Interpret SUPERSCRIPT object as Org syntax.
3494 CONTENTS is the contents of the object."
3497 contents))
3500 ;;;; Table Cell
3503 "Parse table cell at point.
3505 Return a list whose CAR is `table-cell' and CDR is a plist
3506 containing `:begin', `:end', `:contents-begin', `:contents-end'
3507 and `:post-blank' keywords."
3515 :end end
3516 :contents-begin contents-begin
3517 :contents-end contents-end
3521 "Interpret TABLE-CELL element as Org syntax.
3522 CONTENTS is the contents of the cell, or nil."
3526 "Search for the next table-cell object.
3528 LIMIT bounds the search.
3530 Return value is a cons cell whose CAR is `table-cell' and CDR is
3531 beginning position."
3535 ;;;; Target
3538 "Parse target at point.
3540 Return a list whose CAR is `target' and CDR a plist with
3541 `:begin', `:end', `:value' and `:post-blank' as keywords.
3543 Assume point is at the target."
3553 :end end
3554 :value value
3558 "Interpret TARGET object as Org syntax.
3559 CONTENTS is nil."
3563 "Search for the next target object.
3565 LIMIT bounds the search.
3567 Return value is a cons cell whose CAR is `target' and CDR is
3568 beginning position."
3574 ;;;; Timestamp
3577 "Parse time stamp at point.
3579 Return a list whose CAR is `timestamp', and CDR a plist with
3580 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3582 Assume point is at the beginning of the timestamp."
3600 date-start)
3611 raw-value)
3613 :repeater-type
3619 :repeater-unit
3622 year-start month-start day-start hour-start minute-start year-end
3623 month-end day-end hour-end minute-end)
3624 ;; Parse date-start.
3632 ;; Compute date-end. It can be provided directly in time-stamp,
3633 ;; or extracted from time range. Otherwise, it defaults to the
3634 ;; same values as date-start.
3644 :raw-value raw-value
3645 :year-start year-start
3646 :month-start month-start
3647 :day-start day-start
3648 :hour-start hour-start
3649 :minute-start minute-start
3650 :year-end year-end
3651 :month-end month-end
3652 :day-end day-end
3653 :hour-end hour-end
3654 :minute-end minute-end
3655 :begin begin
3656 :end end
3658 repeater-props)))))
3661 "Interpret TIMESTAMP object as Org syntax.
3662 CONTENTS is nil."
3663 ;; Use `:raw-value' if specified.
3665 ;; Otherwise, build timestamp string.
3675 ;; Build an Org timestamp string from TIME. ACTIVEP is
3676 ;; non-nil when time stamp is active. If WITH-TIME-P is
3677 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3678 ;; specify a time range in the timestamp. REPEAT-STRING
3679 ;; is the repeater string, if any.
3683 org-time-stamp-formats)
3684 time)))
3690 nil nil ts)))
3694 " "
3695 repeat-string
3697 ;; Return value.
3698 ts)))
3710 build-ts-string
3729 0
3737 "--"
3749 "Search for the next timestamp object.
3751 LIMIT bounds the search.
3753 Return value is a cons cell whose CAR is `timestamp' and CDR is
3754 beginning position."
3762 limit t)
3766 ;;;; Underline
3769 "Parse underline object at point.
3771 Return a list whose CAR is `underline' and CDR is a plist with
3772 `:begin', `:end', `:contents-begin' and `:contents-end' and
3773 `:post-blank' keywords.
3775 Assume point is at the first underscore marker."
3787 :end end
3788 :contents-begin contents-begin
3789 :contents-end contents-end
3793 "Interpret UNDERLINE object as Org syntax.
3794 CONTENTS is the contents of the object."
3798 ;;;; Verbatim
3801 "Parse verbatim object at point.
3803 Return a list whose CAR is `verbatim' and CDR is a plist with
3804 `:value', `:begin', `:end' and `:post-blank' keywords.
3806 Assume point is at the first equal sign marker."
3817 :begin begin
3818 :end end
3822 "Interpret VERBATIM object as Org syntax.
3823 CONTENTS is nil."
3827 \f
3828 ;;; Parsing Element Starting At Point
3829 ;;
3830 ;; `org-element--current-element' is the core function of this section.
3831 ;; It returns the Lisp representation of the element starting at
3832 ;; point.
3833 ;;
3834 ;; `org-element--current-element' makes use of special modes. They
3835 ;; are activated for fixed element chaining (i.e. `plain-list' >
3836 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3837 ;; `section'). Special modes are: `first-section', `item',
3838 ;; `node-property', `quote-section', `section' and `table-row'.
3842 "Parse the element starting at point.
3844 LIMIT bounds the search.
3846 Return value is a list like (TYPE PROPS) where TYPE is the type
3847 of the element and PROPS a plist of properties associated to the
3848 element.
3850 Possible types are defined in `org-element-all-elements'.
3852 Optional argument GRANULARITY determines the depth of the
3853 recursion. Allowed values are `headline', `greater-element',
3854 `element', `object' or nil. When it is broader than `object' (or
3855 nil), secondary values will not be parsed, since they only
3856 contain objects.
3858 Optional argument SPECIAL, when non-nil, can be either
3859 `first-section', `item', `node-property', `quote-section',
3860 `section', and `table-row'.
3862 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3863 be computed.
3865 This function assumes point is always at the beginning of the
3866 element it has to parse."
3869 ;; Determine if parsing depth allows for secondary strings
3870 ;; parsing. It only applies to elements referenced in
3871 ;; `org-element-secondary-value-alist'.
3874 ;; Item.
3877 ;; Table Row.
3879 ;; Node Property.
3881 ;; Headline.
3884 ;; Sections (must be checked after headline).
3890 limit)))
3891 ;; When not at bol, point is at the beginning of an item or
3892 ;; a footnote definition: next item is always a paragraph.
3894 ;; Planning and Clock.
3899 ;; Inlinetask.
3902 ;; From there, elements can have affiliated keywords.
3905 ;; Jumping over affiliated keywords put point off-limits.
3906 ;; Parse them as regular keywords.
3910 ;; LaTeX Environment.
3914 ;; Drawer and Property Drawer.
3919 ;; Fixed Width
3922 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3923 ;; Keywords.
3932 org-element-block-name-alist)))
3947 ;; Footnote Definition.
3950 ;; Horizontal Rule.
3953 ;; Diary Sexp.
3956 ;; Table.
3958 ;; List.
3961 limit affiliated
3963 ;; Default element: Paragraph.
3967 ;; Most elements can have affiliated keywords. When looking for an
3968 ;; element beginning, we want to move before them, as they belong to
3969 ;; that element, and, in the meantime, collect information they give
3970 ;; into appropriate properties. Hence the following function.
3973 "Collect affiliated keywords from point down to LIMIT.
3975 Return a list whose CAR is the position at the first of them and
3976 CDR a plist of keywords and values and move point to the
3977 beginning of the first line after them.
3979 As a special case, if element doesn't start at the beginning of
3980 the line (i.e. a paragraph starting an item), CAR is current
3981 position of point and CDR is nil."
3985 ;; RESTRICT is the list of objects allowed in parsed
3986 ;; keywords value.
3988 output)
3991 ;; Apply translation to RAW-KWD. From there, KWD is
3992 ;; the official keyword.
3994 org-element-keyword-translation-alist))
3995 raw-kwd))
3996 ;; Find main value for any keyword.
4002 ;; PARSEDP is non-nil when keyword should have its
4003 ;; value parsed.
4005 ;; If KWD is a dual keyword, find its secondary
4006 ;; value. Maybe parse it.
4013 ;; Attribute a property name to KWD.
4015 ;; Now set final shape for VALUE.
4021 ;; Attributes can always appear on multiple lines.
4024 ;; Eventually store the new value in OUTPUT.
4026 ;; Move to next keyword.
4028 ;; If affiliated keywords are orphaned: move back to first one.
4029 ;; They will be parsed as a paragraph.
4031 ;; Return value.
4035 \f
4036 ;;; The Org Parser
4037 ;;
4038 ;; The two major functions here are `org-element-parse-buffer', which
4039 ;; parses Org syntax inside the current buffer, taking into account
4040 ;; region, narrowing, or even visibility if specified, and
4041 ;; `org-element-parse-secondary-string', which parses objects within
4042 ;; a given string.
4043 ;;
4044 ;; The (almost) almighty `org-element-map' allows to apply a function
4045 ;; on elements or objects matching some type, and accumulate the
4046 ;; resulting values. In an export situation, it also skips unneeded
4047 ;; parts of the parse tree.
4050 "Recursively parse the buffer and return structure.
4051 If narrowing is in effect, only parse the visible part of the
4052 buffer.
4054 Optional argument GRANULARITY determines the depth of the
4055 recursion. It can be set to the following symbols:
4057 `headline' Only parse headlines.
4058 `greater-element' Don't recurse into greater elements excepted
4059 headlines and sections. Thus, elements
4060 parsed are the top-level ones.
4061 `element' Parse everything but objects and plain text.
4062 `object' Parse the complete buffer (default).
4064 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4065 elements.
4067 An element or an objects is represented as a list with the
4068 pattern (TYPE PROPERTIES CONTENTS), where :
4070 TYPE is a symbol describing the element or object. See
4071 `org-element-all-elements' and `org-element-all-objects' for an
4072 exhaustive list of such symbols. One can retrieve it with
4073 `org-element-type' function.
4075 PROPERTIES is the list of attributes attached to the element or
4076 object, as a plist. Although most of them are specific to the
4077 element or object type, all types share `:begin', `:end',
4078 `:post-blank' and `:parent' properties, which respectively
4079 refer to buffer position where the element or object starts,
4080 ends, the number of white spaces or blank lines after it, and
4081 the element or object containing it. Properties values can be
4082 obtained by using `org-element-property' function.
4084 CONTENTS is a list of elements, objects or raw strings
4085 contained in the current element or object, when applicable.
4086 One can access them with `org-element-contents' function.
4088 The Org buffer has `org-data' as type and nil as properties.
4089 `org-element-map' function can be used to find specific elements
4090 or objects within the parse tree.
4092 This function assumes that current major mode is `org-mode'."
4098 ;; Start in `first-section' mode so text before the first
4099 ;; headline belongs to a section.
4103 "Recursively parse objects in STRING and return structure.
4105 RESTRICTION is a symbol limiting the object types that will be
4106 looked after.
4108 Optional argument PARENT, when non-nil, is the element or object
4109 containing the secondary string. It is used to set correctly
4110 `:parent' property within the string."
4111 ;; Copy buffer-local variables listed in
4112 ;; `org-element-object-variables' into temporary buffer. This is
4113 ;; required since object parsing is dependent on these variables.
4117 org-element-object-variables))))
4125 secondary))
4126 secondary))))
4130 "Map a function on selected elements or objects.
4132 DATA is a parse tree, an element, an object, a string, or a list
4133 of such constructs. TYPES is a symbol or list of symbols of
4134 elements or objects types (see `org-element-all-elements' and
4135 `org-element-all-objects' for a complete list of types). FUN is
4136 the function called on the matching element or object. It has to
4137 accept one argument: the element or object itself.
4139 When optional argument INFO is non-nil, it should be a plist
4140 holding export options. In that case, parts of the parse tree
4141 not exportable according to that property list will be skipped.
4143 When optional argument FIRST-MATCH is non-nil, stop at the first
4144 match for which FUN doesn't return nil, and return that value.
4146 Optional argument NO-RECURSION is a symbol or a list of symbols
4147 representing elements or objects types. `org-element-map' won't
4148 enter any recursive element or object whose type belongs to that
4149 list. Though, FUN can still be applied on them.
4151 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4152 apply to matching objects within parsed affiliated keywords (see
4153 `org-element-parsed-keywords').
4155 Nil values returned from FUN do not appear in the results.
4158 Examples:
4159 ---------
4161 Assuming TREE is a variable containing an Org buffer parse tree,
4162 the following example will return a flat list of all `src-block'
4163 and `example-block' elements in it:
4165 \(org-element-map tree '(example-block src-block) 'identity)
4167 The following snippet will find the first headline with a level
4170 \(org-element-map tree 'headline
4171 \(lambda (hl)
4172 \(and (= (org-element-property :level hl) 1)
4174 \(org-element-property :begin hl)))
4175 nil t)
4177 The next example will return a flat list of all `plain-list' type
4178 elements in TREE that are not a sub-list themselves:
4180 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4182 Eventually, this example will return a flat list of all `bold'
4183 type objects containing a `latex-snippet' type object, even
4184 looking into captions:
4186 \(org-element-map tree 'bold
4187 \(lambda (b)
4188 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4189 nil nil nil t)"
4190 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4193 ;; Recursion depth is determined by --CATEGORY.
4200 ;; If one object is found, the function
4201 ;; has to recurse into every object.
4204 ;; If one regular element is found, the
4205 ;; function has to recurse, at least,
4206 ;; into every element it encounters.
4209 types)
4210 category)))
4211 ;; Compute properties for affiliated keywords if necessary.
4216 org-element-affiliated-keywords)))
4217 --acc
4218 --walk-tree
4222 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4223 ;; holding contextual information.
4227 ;; Ignored element in an export context.
4229 ;; List of elements or objects.
4231 ;; Unconditionally enter parse trees.
4235 ;; Check if TYPE is matching among TYPES. If so,
4236 ;; apply FUN to --DATA and accumulate return value
4237 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4243 ;; If --DATA has a secondary string that can contain
4244 ;; objects with their type among TYPES, look into it.
4251 ;; If --DATA has any affiliated keywords and
4252 ;; WITH-AFFILIATED is non-nil, look for objects in
4253 ;; them.
4261 ;; Pay attention to the type of value.
4262 ;; Preserve order for multiple keywords.
4278 --affiliated-alist))
4279 ;; Determine if a recursion into --DATA is possible.
4281 ;; --TYPE is explicitly removed from recursion.
4283 ;; --DATA has no contents.
4285 ;; Looking for greater elements but --DATA is simply
4286 ;; an element or an object.
4289 ;; Looking for elements but --DATA is an object.
4292 ;; In any other case, map contents.
4296 ;; Return value in a proper order.
4300 ;; The following functions are internal parts of the parser.
4301 ;;
4302 ;; The first one, `org-element--parse-elements' acts at the element's
4303 ;; level.
4304 ;;
4305 ;; The second one, `org-element--parse-objects' applies on all objects
4306 ;; of a paragraph or a secondary string. It uses
4307 ;; `org-element--get-next-object-candidates' to optimize the search of
4308 ;; the next object in the buffer.
4309 ;;
4310 ;; More precisely, that function looks for every allowed object type
4311 ;; first. Then, it discards failed searches, keeps further matches,
4312 ;; and searches again types matched behind point, for subsequent
4313 ;; calls. Thus, searching for a given type fails only once, and every
4314 ;; object is searched only once at top level (but sometimes more for
4315 ;; nested types).
4319 "Parse elements between BEG and END positions.
4321 SPECIAL prioritize some elements over the others. It can be set
4322 to `first-section', `quote-section', `section' `item' or
4323 `table-row'.
4325 When value is `item', STRUCTURE will be used as the current list
4326 structure.
4328 GRANULARITY determines the depth of the recursion. See
4329 `org-element-parse-buffer' for more information.
4331 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4332 elements.
4334 Elements are accumulated into ACC."
4337 ;; Visible only: skip invisible parts at the beginning of the
4338 ;; element.
4341 ;; When parsing only headlines, skip any text before first one.
4344 ;; Main loop start.
4346 ;; Find current element's type and parse it accordingly to
4347 ;; its category.
4349 end granularity special structure))
4353 ;; Visible only: skip invisible parts between siblings.
4356 ;; Fill ELEMENT contents by side-effect.
4358 ;; If element has no contents, don't modify it.
4360 ;; Greater element: parse it between `contents-begin' and
4361 ;; `contents-end'. Make sure GRANULARITY allows the
4362 ;; recursion, or ELEMENT is a headline, in which case going
4363 ;; inside is mandatory, in order to get sub-level headings.
4371 ;; Possibly switch to a special mode.
4381 granularity visible-only element))
4382 ;; ELEMENT has contents. Parse objects inside, if
4383 ;; GRANULARITY allows it.
4389 ;; Return result.
4390 acc))
4393 "Parse objects between BEG and END and return recursive structure.
4395 Objects are accumulated in ACC.
4397 RESTRICTION is a list of object successors which are allowed in
4398 the current object."
4404 end restriction candidates)))
4411 ;; 1. Text before any object. Untabify it.
4416 acc
4420 ;; 2. Object...
4423 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4424 ;; a recursive type.
4429 cont-beg
4436 ;; 3. Text after last object. Untabify it.
4440 acc
4444 ;; Result.
4445 acc)))
4448 "Return an alist of candidates for the next object.
4450 LIMIT bounds the search, and RESTRICTION narrows candidates to
4451 some object successors.
4453 OBJECTS is the previous candidates alist. If it is set to
4454 `initial', no search has been done before, and all symbols in
4455 RESTRICTION should be looked after.
4457 Return value is an alist whose CAR is the object type and CDR its
4458 beginning position."
4460 nil
4462 ;; When searching for the first time, look for every successor
4463 ;; allowed in RESTRICTION.
4467 restriction)
4468 ;; Focus on objects returned during last search. Keep those
4469 ;; still after point. Search again objects before it.
4475 type)))
4478 limit)))))
4479 objects))))
4482 \f
4483 ;;; Towards A Bijective Process
4484 ;;
4485 ;; The parse tree obtained with `org-element-parse-buffer' is really
4486 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4487 ;; interpreted and expanded into a string with canonical Org syntax.
4488 ;; Hence `org-element-interpret-data'.
4489 ;;
4490 ;; The function relies internally on
4491 ;; `org-element--interpret-affiliated-keywords'.
4493 ;;;###autoload
4495 "Interpret DATA as Org syntax.
4497 DATA is a parse tree, an element, an object or a secondary string
4498 to interpret.
4500 Optional argument PARENT is used for recursive calls. It contains
4501 the element or object containing data, or nil.
4503 Return Org syntax as a string."
4507 ;; Secondary string.
4512 ;; Full Org document.
4517 ;; Plain text: remove `:parent' text property from output.
4519 ;; Element/Object without contents.
4522 data nil))
4523 ;; Element/Object with contents.
4533 ;; Elements directly containing objects must
4534 ;; have their indentation normalized first.
4536 data
4537 ;; When normalizing first paragraph of an
4538 ;; item or a footnote-definition, ignore
4539 ;; first line's indentation.
4546 data
4548 contents)))))))
4550 ;; Build white spaces. If no `:post-blank' property is
4551 ;; specified, assume its value is 0.
4561 "Return ELEMENT's affiliated keywords as Org syntax.
4562 If there is no affiliated keyword, return the empty string."
4572 ": "
4575 value)
4583 ;; All attribute keywords can have multiple lines.
4589 ;; List all ELEMENT's properties matching an attribute line or an
4590 ;; affiliated keyword, but ignore translated keywords since they
4591 ;; cannot belong to the property list.
4598 org-element-keyword-translation-alist)))))
4599 collect prop)
4602 ;; Because interpretation of the parse tree must return the same
4603 ;; number of blank lines between elements and the same number of white
4604 ;; space after objects, some special care must be given to white
4605 ;; spaces.
4606 ;;
4607 ;; The first function, `org-element-normalize-string', ensures any
4608 ;; string different from the empty string will end with a single
4609 ;; newline character.
4610 ;;
4611 ;; The second function, `org-element-normalize-contents', removes
4612 ;; global indentation from the contents of the current element.
4615 "Ensure string S ends with a single newline character.
4617 If S isn't a string return it unchanged. If S is the empty
4618 string, return it. Otherwise, return a new string with a single
4619 newline character at its end."
4627 "Normalize plain text in ELEMENT's contents.
4629 ELEMENT must only contain plain text and objects.
4631 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4632 indentation to compute maximal common indentation.
4634 Return the normalized element that is element with global
4635 indentation removed from its contents. The function assumes that
4636 indentation is not done with TAB characters."
4638 collect-inds ; for byte-compiler
4641 ;; Return list of indentations within BLOB. This is done by
4642 ;; walking recursively BLOB and updating IND-LIST along the
4643 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4644 ;; been seen yet. It is required as this string is the only
4645 ;; one whose indentation doesn't happen after a newline
4646 ;; character.
4654 ;; An indentation of zero means no string will be
4655 ;; modified. Quit the process.
4661 ;; Avoid matching blank or empty lines.
4669 ;; Collect indentation list in ELEMENT. Possibly remove first
4670 ;; value if IGNORE-FIRST is non-nil.
4673 ;; Build ELEMENT back, replacing each string with the same
4674 ;; string minus common indentation.
4679 ;; Return BLOB with all its strings indentation
4680 ;; shortened from MCI white spaces. FIRST-FLAG is
4681 ;; non-nil when the first string hasn't been seen
4682 ;; yet.
4696 org-element-recursive-objects)
4700 blob))))
4704 \f
4705 ;;; The Toolbox
4706 ;;
4707 ;; The first move is to implement a way to obtain the smallest element
4708 ;; containing point. This is the job of `org-element-at-point'. It
4709 ;; basically jumps back to the beginning of section containing point
4710 ;; and moves, element after element, with
4711 ;; `org-element--current-element' until the container is found. Note:
4712 ;; When using `org-element-at-point', secondary values are never
4713 ;; parsed since the function focuses on elements, not on objects.
4714 ;;
4715 ;; At a deeper level, `org-element-context' lists all elements and
4716 ;; objects containing point.
4717 ;;
4718 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4719 ;; internally by navigation and manipulation tools.
4721 ;;;###autoload
4723 "Determine closest element around point.
4725 Return value is a list like (TYPE PROPS) where TYPE is the type
4726 of the element and PROPS a plist of properties associated to the
4727 element.
4729 Possible types are defined in `org-element-all-elements'.
4730 Properties depend on element or object type, but always include
4731 `:begin', `:end', `:parent' and `:post-blank' properties.
4733 As a special case, if point is at the very beginning of a list or
4734 sub-list, returned element will be that list instead of the first
4735 item. In the same way, if point is at the beginning of the first
4736 row of a table, returned element will be the table instead of the
4737 first row.
4739 If optional argument KEEP-TRAIL is non-nil, the function returns
4740 a list of elements leading to element at point. The list's CAR
4741 is always the element at point. The following positions contain
4742 element's siblings, then parents, siblings of parents, until the
4743 first element of current section."
4745 ;; If at a headline, parse it. It is the sole element that
4746 ;; doesn't require to know about context. Be sure to disallow
4747 ;; secondary string parsing, though.
4753 ;; Otherwise move at the beginning of the section containing
4754 ;; point.
4759 element type special-flag trail struct prevs parent)
4762 ;; In empty lines at buffer's beginning, return nil.
4771 ;; In blank lines just after the headline, point still
4772 ;; belongs to the headline.
4780 ;; Parse successively each element, skipping those ending
4781 ;; before original position.
4789 ;; 1. Skip any element ending before point. Also skip
4790 ;; element ending at point when we're sure that another
4791 ;; element has started.
4796 ;; 2. An element containing point is always the element at
4797 ;; point.
4800 ;; 3. At any other greater element type, if point is
4801 ;; within contents, move into it.
4806 ;; Create an anchor for tables and plain lists:
4807 ;; when point is at the very beginning of these
4808 ;; elements, ignoring affiliated keywords,
4809 ;; target them instead of their contents.
4811 ;; When point is at contents end, do not move
4812 ;; into elements with an explicit ending, but
4813 ;; return that element instead.
4817 drawer dynamic-block inlinetask item
4818 plain-list property-drawer quote-block
4819 special-block))))
4834 ;;;###autoload
4836 "Return closest element or object around point.
4838 Return value is a list like (TYPE PROPS) where TYPE is the type
4839 of the element or object and PROPS a plist of properties
4840 associated to it.
4842 Possible types are defined in `org-element-all-elements' and
4843 `org-element-all-objects'. Properties depend on element or
4844 object type, but always include `:begin', `:end', `:parent' and
4845 `:post-blank'.
4847 Optional argument ELEMENT, when non-nil, is the closest element
4848 containing point, as returned by `org-element-at-point'.
4849 Providing it allows for quicker computation."
4854 end)
4855 ;; Check if point is inside an element containing objects or at
4856 ;; a secondary string. In that case, move to beginning of the
4857 ;; element or secondary string and set END to the other side.
4864 org-element-parsed-keywords))
4865 ;; We're at an affiliated keyword. Change
4866 ;; type to retrieve correct restrictions.
4868 ;; Determine if we're at main or dual value.
4882 (<= origin
4883 ;; `1+' is required so some
4884 ;; successors can match
4885 ;; properly their object.
4907 element
4913 end restriction candidates))
4915 candidates)))
4916 ;; If ORIGIN is before next object in element, there's
4917 ;; no point in looking further.
4927 ;; ORIGIN is after OBJECT, so skip it.
4933 ;; ORIGIN is within a non-recursive object or at
4934 ;; an object boundaries: Return that object.
4938 ;; Otherwise, move within current object and
4939 ;; restrict search to the end of its contents.
4944 candidates 'initial
4945 end cend)))))))
4946 parent))))))
4949 "Non-nil when elements ELEM-A and ELEM-B are nested."
4958 "Swap elements ELEM-A and ELEM-B.
4959 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4960 end of ELEM-A."
4962 ;; There are two special cases when an element doesn't start at bol:
4963 ;; the first paragraph in an item or in a footnote definition.
4965 ;; Only a paragraph without any affiliated keyword can be moved at
4966 ;; ELEM-A position in such a situation. Note that the case of
4967 ;; a footnote definition is impossible: it cannot contain two
4968 ;; paragraphs in a row because it cannot contain a blank line.
4974 ;; In a special situation, ELEM-A will have no indentation. We'll
4975 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4989 ;; Store overlays responsible for visibility status. We
4990 ;; also need to store their boundaries as they will be
4991 ;; removed from buffer.
4998 ;; Get contents.
5006 ;; Restore ex ELEM-A overlays.
5015 ;; Restore ex ELEM-B overlays.
5024 ;; Local variables:
5025 ;; generated-autoload-file: "org-loaddefs.el"
5026 ;; End:
5028 ;;; org-element.el ends here