| blob | 93f9d4c8449b91d94e104e1f202950955d721138 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2013 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `node-property', `quote-section' `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `quote-section',
52 ;; `src-block', `table', `table-row' and `verse-block'. Among them,
53 ;; `paragraph' and `verse-block' types can contain Org objects and
54 ;; plain text.
55 ;;
56 ;; Objects are related to document's contents. Some of them are
57 ;; recursive. Associated types are of the following: `bold', `code',
58 ;; `entity', `export-snippet', `footnote-reference',
59 ;; `inline-babel-call', `inline-src-block', `italic',
60 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
61 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
62 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
63 ;;
64 ;; Some elements also have special properties whose value can hold
65 ;; objects themselves (i.e. an item tag or a headline name). Such
66 ;; values are called "secondary strings". Any object belongs to
67 ;; either an element or a secondary string.
68 ;;
69 ;; Notwithstanding affiliated keywords, each greater element, element
70 ;; and object has a fixed set of properties attached to it. Among
71 ;; them, four are shared by all types: `:begin' and `:end', which
72 ;; refer to the beginning and ending buffer positions of the
73 ;; considered element or object, `:post-blank', which holds the number
74 ;; of blank lines, or white spaces, at its end and `:parent' which
75 ;; refers to the element or object containing it. Greater elements,
76 ;; elements and objects containing objects will also have
77 ;; `:contents-begin' and `:contents-end' properties to delimit
78 ;; contents. Eventually, greater elements and elements accepting
79 ;; affiliated keywords will have a `:post-affiliated' property,
80 ;; referring to the buffer position after all such keywords.
81 ;;
82 ;; At the lowest level, a `:parent' property is also attached to any
83 ;; string, as a text property.
84 ;;
85 ;; Lisp-wise, an element or an object can be represented as a list.
86 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
87 ;; TYPE is a symbol describing the Org element or object.
88 ;; PROPERTIES is the property list attached to it. See docstring of
89 ;; appropriate parsing function to get an exhaustive
90 ;; list.
91 ;; CONTENTS is a list of elements, objects or raw strings contained
92 ;; in the current element or object, when applicable.
93 ;;
94 ;; An Org buffer is a nested list of such elements and objects, whose
95 ;; type is `org-data' and properties is nil.
96 ;;
97 ;; The first part of this file defines Org syntax, while the second
98 ;; one provide accessors and setters functions.
99 ;;
100 ;; The next part implements a parser and an interpreter for each
101 ;; element and object type in Org syntax.
102 ;;
103 ;; The following part creates a fully recursive buffer parser. It
104 ;; also provides a tool to map a function to elements or objects
105 ;; matching some criteria in the parse tree. Functions of interest
106 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
107 ;; extent, `org-element-parse-secondary-string'.
108 ;;
109 ;; The penultimate part is the cradle of an interpreter for the
110 ;; obtained parse tree: `org-element-interpret-data'.
111 ;;
112 ;; The library ends by furnishing `org-element-at-point' function, and
113 ;; a way to give information about document structure around point
114 ;; with `org-element-context'.
117 ;;; Code:
123 \f
124 ;;; Definitions And Rules
125 ;;
126 ;; Define elements, greater elements and specify recursive objects,
127 ;; along with the affiliated keywords recognized. Also set up
128 ;; restrictions on recursive objects combinations.
129 ;;
130 ;; These variables really act as a control center for the parsing
131 ;; process.
135 ;; Headlines, inlinetasks.
137 ;; Footnote definitions.
139 ;; Diary sexps.
142 ;; Empty lines.
144 ;; Tables (any type).
146 ;; Blocks (any type), Babel calls, drawers (any type),
147 ;; fixed-width areas and keywords. Note: this is only an
148 ;; indication and need some thorough check.
150 ;; Horizontal rules.
152 ;; LaTeX environments.
154 ;; Planning and Clock lines.
156 org-deadline-string
157 org-closed-string
158 org-clock-string))
160 ;; Lists.
167 "Regexp to separate paragraphs in an Org buffer.
169 is not sufficient to know if point is at a paragraph ending. See
174 dynamic-block example-block export-block fixed-width
175 footnote-definition headline horizontal-rule inlinetask item
176 keyword latex-environment node-property paragraph plain-list
177 planning property-drawer quote-block quote-section section
178 special-block src-block table table-row verse-block)
183 item plain-list property-drawer quote-block section
184 special-block table)
189 latex-or-entity line-break link macro plain-link radio-target
190 statistics-cookie sub/superscript table-cell target
191 text-markup timestamp)
200 "Alist of translations between object type and successor name.
201 Sharing the same successor comes handy when, for example, the
206 inline-src-block italic line-break latex-fragment link macro
207 radio-target statistics-cookie strike-through subscript superscript
208 table-cell target timestamp underline verbatim)
213 table-cell underline)
223 "Alist between block names and the associated parsing function.
224 Names must be uppercase. Any block whose name has no association
230 Only these types can accept search options and an explicit
236 "List of affiliated keywords as strings.
242 ;; Regular affiliated keywords.
245 "Regexp matching any affiliated keyword.
247 Keyword name is put in match group 1. Moreover, if keyword
248 belongs to `org-element-dual-keywords', put the dual value in
249 match group 2.
257 "Alist of usual translations for keywords.
258 The key is the old name and the value the new one. The property
262 "List of affiliated keywords that can occur more than once in an element.
264 Their value will be consed into a list of strings, which will be
265 returned as the value of the property.
267 This list is checked after translations have been applied. See
268 `org-element-keyword-translation-alist'.
274 "List of affiliated keywords whose value can be parsed.
276 Their value will be stored as a secondary string: a list of
277 strings and objects.
279 This list is checked after translations have been applied. See
283 "List of affiliated keywords which can have a secondary value.
285 In Org syntax, they can be written with optional square brackets
286 before the colons. For example, RESULTS keyword can be
287 associated to a hash value with the following:
289 #+RESULTS[hash-string]: some-source
291 This list is checked after translations have been applied. See
295 "List of properties associated to the whole document.
296 Any keyword in this list will have its value parsed and stored as
310 ;; Ignore all links excepted plain links in a link description.
311 ;; Also ignore radio-targets and line breaks.
315 ;; Remove any variable object from radio target as it would
316 ;; prevent it from being properly recognized.
321 ;; Ignore inline babel call and inline src block as formulas are
322 ;; possible. Also ignore line breaks and statistics cookies.
328 "Alist of objects restrictions.
330 CAR is an element or object type containing objects and CDR is
331 a list of successors that will be called within an element or
332 object of such type.
334 For example, in a `radio-target' object, one can only find
335 entities, latex-fragments, subscript and superscript.
337 This alist also applies to secondary string. For example, an
338 `headline' type element doesn't directly contain objects, but
349 "List of buffer-local variables used when parsing objects.
350 These variables are copied to the temporary buffer created by
354 \f
355 ;;; Accessors and Setters
356 ;;
357 ;; Provide four accessors: `org-element-type', `org-element-property'
358 ;; `org-element-contents' and `org-element-restriction'.
359 ;;
360 ;; Setter functions allow to modify elements by side effect. There is
361 ;; `org-element-put-property', `org-element-set-contents',
362 ;; `org-element-set-element' and `org-element-adopt-element'. Note
363 ;; that `org-element-set-element' and `org-element-adopt-elements' are
364 ;; higher level functions since also update `:parent' property.
367 "Return type of ELEMENT.
369 The function returns the type of the element or object provided.
370 It can also return the following special value:
371 `plain-text' for a string
372 `org-data' for a complete document
373 nil in any other case."
379 "Extract the value from the PROPERTY of an ELEMENT."
384 "Extract contents from an ELEMENT."
390 "Return restriction associated to ELEMENT.
391 ELEMENT can be an element, an object or a symbol representing an
392 element or object type."
394 org-element-object-restrictions)))
397 "In ELEMENT set PROPERTY to VALUE.
398 Return modified element."
401 element))
404 "Set ELEMENT contents to CONTENTS.
405 Return modified element."
412 "Replace element or object OLD with element or object NEW.
413 The function takes care of setting `:parent' property for NEW."
414 ;; Since OLD is going to be changed into NEW by side-effect, first
415 ;; make sure that every element or object within NEW has OLD as
416 ;; parent.
419 ;; Transfer contents.
421 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
422 ;; with NEW's.
425 ;; Transfer type.
429 "Append elements to the contents of another element.
431 PARENT is an element or object. CHILDREN can be elements,
432 objects, or a strings.
434 The function takes care of setting `:parent' property for CHILD.
435 Return parent element."
436 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
437 ;; string: parent is the list itself.
440 children)
441 ;; Add CHILDREN at the end of PARENT contents.
444 parent
446 ;; Return modified PARENT element.
450 \f
451 ;;; Greater elements
452 ;;
453 ;; For each greater element type, we define a parser and an
454 ;; interpreter.
455 ;;
456 ;; A parser returns the element or object as the list described above.
457 ;; Most of them accepts no argument. Though, exceptions exist. Hence
458 ;; every element containing a secondary string (see
459 ;; `org-element-secondary-value-alist') will accept an optional
460 ;; argument to toggle parsing of that secondary string. Moreover,
461 ;; `item' parser requires current list's structure as its first
462 ;; element.
463 ;;
464 ;; An interpreter accepts two arguments: the list representation of
465 ;; the element or object, and its contents. The latter may be nil,
466 ;; depending on the element or object considered. It returns the
467 ;; appropriate Org syntax, as a string.
468 ;;
469 ;; Parsing functions must follow the naming convention:
470 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
471 ;; defined in `org-element-greater-elements'.
472 ;;
473 ;; Similarly, interpreting functions must follow the naming
474 ;; convention: org-element-TYPE-interpreter.
475 ;;
476 ;; With the exception of `headline' and `item' types, greater elements
477 ;; cannot contain other greater elements of their own type.
478 ;;
479 ;; Beside implementing a parser and an interpreter, adding a new
480 ;; greater element requires to tweak `org-element--current-element'.
481 ;; Moreover, the newly defined type must be added to both
482 ;; `org-element-all-elements' and `org-element-greater-elements'.
485 ;;;; Center Block
488 "Parse a center block.
490 LIMIT bounds the search. AFFILIATED is a list of which CAR is
491 the buffer position at the beginning of the first affiliated
492 keyword and CDR is a plist of affiliated keywords along with
493 their value.
495 Return a list whose CAR is `center-block' and CDR is a plist
496 containing `:begin', `:end', `:hiddenp', `:contents-begin',
497 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
499 Assume point is at the beginning of the block."
503 ;; Incomplete block: parse it as a paragraph.
508 ;; Empty blocks have no contents.
523 :end end
524 :hiddenp hidden
525 :contents-begin contents-begin
526 :contents-end contents-end
532 "Interpret CENTER-BLOCK element as Org syntax.
533 CONTENTS is the contents of the element."
537 ;;;; Drawer
540 "Parse a drawer.
542 LIMIT bounds the search. AFFILIATED is a list of which CAR is
543 the buffer position at the beginning of the first affiliated
544 keyword and CDR is a plist of affiliated keywords along with
545 their value.
547 Return a list whose CAR is `drawer' and CDR is a plist containing
548 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
549 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
551 Assume point is at beginning of drawer."
554 ;; Incomplete drawer: parse it as a paragraph.
562 ;; Empty drawers have no contents.
577 :end end
578 :drawer-name name
579 :hiddenp hidden
580 :contents-begin contents-begin
581 :contents-end contents-end
587 "Interpret DRAWER element as Org syntax.
588 CONTENTS is the contents of the element."
591 contents))
594 ;;;; Dynamic Block
597 "Parse a dynamic block.
599 LIMIT bounds the search. AFFILIATED is a list of which CAR is
600 the buffer position at the beginning of the first affiliated
601 keyword and CDR is a plist of affiliated keywords along with
602 their value.
604 Return a list whose CAR is `dynamic-block' and CDR is a plist
605 containing `:block-name', `:begin', `:end', `:hiddenp',
606 `:contents-begin', `:contents-end', `:arguments', `:post-blank'
607 and `:post-affiliated' keywords.
609 Assume point is at beginning of dynamic block."
613 ;; Incomplete block: parse it as a paragraph.
622 ;; Empty blocks have no contents.
637 :end end
638 :block-name name
639 :arguments arguments
640 :hiddenp hidden
641 :contents-begin contents-begin
642 :contents-end contents-end
648 "Interpret DYNAMIC-BLOCK element as Org syntax.
649 CONTENTS is the contents of the element."
654 contents))
657 ;;;; Footnote Definition
660 "Parse a footnote definition.
662 LIMIT bounds the search. AFFILIATED is a list of which CAR is
663 the buffer position at the beginning of the first affiliated
664 keyword and CDR is a plist of affiliated keywords along with
665 their value.
667 Return a list whose CAR is `footnote-definition' and CDR is
668 a plist containing `:label', `:begin' `:end', `:contents-begin',
669 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
671 Assume point is at the beginning of the footnote definition."
697 :begin begin
698 :end end
699 :contents-begin contents-begin
700 :contents-end contents-end
706 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
707 CONTENTS is the contents of the footnote-definition."
709 " "
710 contents))
713 ;;;; Headline
716 "Parse a headline.
718 Return a list whose CAR is `headline' and CDR is a plist
719 containing `:raw-value', `:title', `:alt-title', `:begin',
720 `:end', `:pre-blank', `:hiddenp', `:contents-begin' and
721 `:contents-end', `:level', `:priority', `:tags',
722 `:todo-keyword',`:todo-type', `:scheduled', `:deadline',
723 `:closed', `:quotedp', `:archivedp', `:commentedp' and
724 `:footnote-section-p' keywords.
726 The plist also contains any property set in the property drawer,
727 with its name in upper cases and colons added at the
728 beginning (i.e. `:CUSTOM_ID').
730 When RAW-SECONDARY-P is non-nil, headline's title will not be
731 parsed as a secondary string, but as a plain string instead.
733 Assume point is at beginning of the headline."
746 raw-value)))
750 raw-value)))
754 ;; Upcase property names. It avoids confusion between
755 ;; properties obtained through property drawer and default
756 ;; properties from the parser (e.g. `:end' and :END:)
766 plist))
768 ;; Read time properties on the line below the headline.
774 org-keyword-time-not-clock-regexp end t)
784 plist))))
797 ;; Clean RAW-VALUE from any quote or comment string.
805 ""
806 raw-value))))
807 ;; Clean TAGS from archive tag, if any.
813 :begin begin
814 :end end
815 :pre-blank
818 :hiddenp hidden
819 :contents-begin contents-begin
820 :contents-end contents-end
821 :level level
823 :tags tags
824 :todo-keyword todo
825 :todo-type todo-type
831 end)
832 :footnote-section-p footnote-section-p
833 :archivedp archivedp
834 :commentedp commentedp
836 time-props
837 standard-props))))
841 headline :alt-title
846 headline :title
852 "Interpret HEADLINE element as Org syntax.
853 CONTENTS is the contents of the element."
880 ;; Align tags.
888 ? )
889 tags))
893 tags))))
895 contents)))
898 ;;;; Inlinetask
901 "Parse an inline task.
903 Return a list whose CAR is `inlinetask' and CDR is a plist
904 containing `:title', `:begin', `:end', `:hiddenp',
905 `:contents-begin' and `:contents-end', `:level', `:priority',
906 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
907 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
909 The plist also contains any property set in the property drawer,
910 with its name in upper cases and colons added at the
911 beginning (i.e. `:CUSTOM_ID').
913 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
914 title will not be parsed as a secondary string, but as a plain
915 string instead.
917 Assume point is at beginning of the inline task."
927 ;; Upcase property names. It avoids confusion between
928 ;; properties obtained through property drawer and default
929 ;; properties from the parser (e.g. `:end' and :END:)
939 plist))
941 ;; Read time properties on the line below the inlinetask
942 ;; opening string.
948 org-keyword-time-not-clock-regexp end t)
958 plist))))
978 :begin begin
979 :end end
980 :hiddenp hidden
981 :contents-begin contents-begin
982 :contents-end contents-end
985 :tags tags
986 :todo-keyword todo
987 :todo-type todo-type
989 time-props
990 standard-props))))
992 inlinetask :title
995 raw-value
997 inlinetask))))))
1000 "Interpret INLINETASK element as Org syntax.
1001 CONTENTS is the contents of inlinetask."
1016 ;; Align tags.
1024 ? )
1025 tags))
1029 tags))))
1030 ;; Prefer degenerate inlinetasks when there are no
1031 ;; contents.
1034 contents
1038 ;;;; Item
1041 "Parse an item.
1043 STRUCT is the structure of the plain list.
1045 Return a list whose CAR is `item' and CDR is a plist containing
1046 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1047 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1048 `:post-blank' keywords.
1050 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1051 any, will not be parsed as a secondary string, but as a plain
1052 string instead.
1054 Assume point is at the beginning of the item."
1078 ;; Ignore tags in un-ordered lists: they are just
1079 ;; a part of item's body.
1085 ;; If first line isn't empty, contents really start
1086 ;; at the text after item's meta-data.
1097 :begin begin
1098 :end end
1099 ;; CONTENTS-BEGIN and CONTENTS-END may be
1100 ;; mixed up in the case of an empty item
1101 ;; separated from the next by a blank line.
1102 ;; Thus ensure the former is always the
1103 ;; smallest.
1106 :checkbox checkbox
1107 :counter counter
1108 :hiddenp hidden
1109 :structure struct
1112 item :tag
1120 "Interpret ITEM element as Org syntax.
1121 CONTENTS is the contents of the element."
1127 ;; Compute indentation.
1132 ;; Indent contents.
1134 bullet
1147 ;;;; Plain List
1150 ;; Return structure of list at point. Internal function. See
1151 ;; `org-list-struct' for details.
1159 items struct)
1164 ;; At limit: end all items.
1173 ;; At list end: end all items.
1178 ;; At a new item: end previous sibling.
1190 ind
1191 bullet
1194 ;; Description tag.
1198 ;; Ending position, unknown so far.
1199 nil)))
1200 items))
1202 ;; Skip empty lines.
1204 ;; Skip inline tasks and blank lines along the way.
1211 ;; At some text line. Check if it ends any previous item.
1223 ;; Skip blocks (any type) and drawers contents.
1228 limit t)))
1234 "Parse a plain list.
1236 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1237 the buffer position at the beginning of the first affiliated
1238 keyword and CDR is a plist of affiliated keywords along with
1239 their value. STRUCTURE is the structure of the plain list being
1240 parsed.
1242 Return a list whose CAR is `plain-list' and CDR is a plist
1243 containing `:type', `:begin', `:end', `:contents-begin' and
1244 `:contents-end', `:structure', `:post-blank' and
1245 `:post-affiliated' keywords.
1247 Assume point is at the beginning of the list."
1261 ;; Return value.
1265 :begin begin
1266 :end end
1267 :contents-begin contents-begin
1268 :contents-end contents-end
1269 :structure struct
1275 "Interpret PLAIN-LIST element as Org syntax.
1276 CONTENTS is the contents of the element."
1284 ;;;; Property Drawer
1287 "Parse a property drawer.
1289 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1290 the buffer position at the beginning of the first affiliated
1291 keyword and CDR is a plist of affiliated keywords along with
1292 their value.
1294 Return a list whose CAR is `property-drawer' and CDR is a plist
1295 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1296 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1298 Assume point is at the beginning of the property drawer."
1303 ;; Incomplete drawer: parse it as a paragraph.
1323 :end end
1324 :hiddenp hidden
1325 :contents-begin contents-begin
1326 :contents-end contents-end
1332 "Interpret PROPERTY-DRAWER element as Org syntax.
1333 CONTENTS is the properties within the drawer."
1337 ;;;; Quote Block
1340 "Parse a quote block.
1342 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1343 the buffer position at the beginning of the first affiliated
1344 keyword and CDR is a plist of affiliated keywords along with
1345 their value.
1347 Return a list whose CAR is `quote-block' and CDR is a plist
1348 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1349 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1351 Assume point is at the beginning of the block."
1355 ;; Incomplete block: parse it as a paragraph.
1361 ;; Empty blocks have no contents.
1376 :end end
1377 :hiddenp hidden
1378 :contents-begin contents-begin
1379 :contents-end contents-end
1385 "Interpret QUOTE-BLOCK element as Org syntax.
1386 CONTENTS is the contents of the element."
1390 ;;;; Section
1393 "Parse a section.
1395 LIMIT bounds the search.
1397 Return a list whose CAR is `section' and CDR is a plist
1398 containing `:begin', `:end', `:contents-begin', `contents-end'
1399 and `:post-blank' keywords."
1401 ;; Beginning of section is the beginning of the first non-blank
1402 ;; line after previous headline.
1411 :end end
1412 :contents-begin begin
1413 :contents-end pos-before-blank
1417 "Interpret SECTION element as Org syntax.
1418 CONTENTS is the contents of the element."
1419 contents)
1422 ;;;; Special Block
1425 "Parse a special block.
1427 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1428 the buffer position at the beginning of the first affiliated
1429 keyword and CDR is a plist of affiliated keywords along with
1430 their value.
1432 Return a list whose CAR is `special-block' and CDR is a plist
1433 containing `:type', `:begin', `:end', `:hiddenp',
1434 `:contents-begin', `:contents-end', `:post-blank' and
1435 `:post-affiliated' keywords.
1437 Assume point is at the beginning of the block."
1444 limit t)))
1445 ;; Incomplete block: parse it as a paragraph.
1451 ;; Empty blocks have no contents.
1466 :begin begin
1467 :end end
1468 :hiddenp hidden
1469 :contents-begin contents-begin
1470 :contents-end contents-end
1476 "Interpret SPECIAL-BLOCK element as Org syntax.
1477 CONTENTS is the contents of the element."
1482 \f
1483 ;;; Elements
1484 ;;
1485 ;; For each element, a parser and an interpreter are also defined.
1486 ;; Both follow the same naming convention used for greater elements.
1487 ;;
1488 ;; Also, as for greater elements, adding a new element type is done
1489 ;; through the following steps: implement a parser and an interpreter,
1490 ;; tweak `org-element--current-element' so that it recognizes the new
1491 ;; type and add that new type to `org-element-all-elements'.
1492 ;;
1493 ;; As a special case, when the newly defined type is a block type,
1494 ;; `org-element-block-name-alist' has to be modified accordingly.
1497 ;;;; Babel Call
1500 "Parse a babel call.
1502 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1503 the buffer position at the beginning of the first affiliated
1504 keyword and CDR is a plist of affiliated keywords along with
1505 their value.
1507 Return a list whose CAR is `babel-call' and CDR is a plist
1508 containing `:begin', `:end', `:info', `:post-blank' and
1509 `:post-affiliated' as keywords."
1523 :end end
1524 :info info
1530 "Interpret BABEL-CALL element as Org syntax.
1531 CONTENTS is nil."
1537 ;; Remove redundant square brackets.
1542 ;;;; Clock
1545 "Parse a clock.
1547 LIMIT bounds the search.
1549 Return a list whose CAR is `clock' and CDR is a plist containing
1550 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1551 as keywords."
1571 :value value
1572 :duration duration
1573 :begin begin
1574 :end end
1578 "Interpret CLOCK element as Org syntax.
1579 CONTENTS is nil."
1587 "%2s:%02s"
1591 ;;;; Comment
1594 "Parse a comment.
1596 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1597 the buffer position at the beginning of the first affiliated
1598 keyword and CDR is a plist of affiliated keywords along with
1599 their value.
1601 Return a list whose CAR is `comment' and CDR is a plist
1602 containing `:begin', `:end', `:value', `:post-blank',
1603 `:post-affiliated' keywords.
1605 Assume point is at comment beginning."
1614 ;; Get comments ending.
1617 ;; Accumulate lines without leading hash and first
1618 ;; whitespace.
1633 :end end
1634 :value value
1640 "Interpret COMMENT element as Org syntax.
1641 CONTENTS is nil."
1645 ;;;; Comment Block
1648 "Parse an export block.
1650 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1651 the buffer position at the beginning of the first affiliated
1652 keyword and CDR is a plist of affiliated keywords along with
1653 their value.
1655 Return a list whose CAR is `comment-block' and CDR is a plist
1656 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1657 and `:post-affiliated' keywords.
1659 Assume point is at comment block beginning."
1663 ;; Incomplete block: parse it as a paragraph.
1678 contents-begin contents-end)))
1682 :end end
1683 :value value
1684 :hiddenp hidden
1690 "Interpret COMMENT-BLOCK element as Org syntax.
1691 CONTENTS is nil."
1696 ;;;; Diary Sexp
1699 "Parse a diary sexp.
1701 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1702 the buffer position at the beginning of the first affiliated
1703 keyword and CDR is a plist of affiliated keywords along with
1704 their value.
1706 Return a list whose CAR is `diary-sexp' and CDR is a plist
1707 containing `:begin', `:end', `:value', `:post-blank' and
1708 `:post-affiliated' keywords."
1721 :begin begin
1722 :end end
1728 "Interpret DIARY-SEXP as Org syntax.
1729 CONTENTS is nil."
1733 ;;;; Example Block
1736 "Remove maximum common indentation in string S and return it.
1737 When optional argument N is a positive integer, remove exactly
1738 that much characters from indentation, if possible, or return
1739 S as-is otherwise. Unlike to `org-remove-indentation', this
1740 function doesn't call `untabify' on S."
1745 ;; Find maximum common indentation, if not specified.
1753 min-ind)))
1755 ;; Remove exactly N indentation, but give up if not possible.
1765 "Parse an example block.
1767 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1768 the buffer position at the beginning of the first affiliated
1769 keyword and CDR is a plist of affiliated keywords along with
1770 their value.
1772 Return a list whose CAR is `example-block' and CDR is a plist
1773 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1774 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1775 `:switches', `:value', `:post-blank' and `:post-affiliated'
1776 keywords."
1780 ;; Incomplete block: parse it as a paragraph.
1788 ;; Switches analysis
1796 ;; Should labels be retained in (or stripped from) example
1797 ;; blocks?
1802 ;; What should code-references use - labels or
1803 ;; line-numbers?
1812 ;; Standard block parsing.
1821 contents-begin contents-end))
1832 :end end
1833 :value value
1834 :switches switches
1835 :number-lines number-lines
1836 :preserve-indent preserve-indent
1837 :retain-labels retain-labels
1838 :use-labels use-labels
1839 :label-fmt label-fmt
1840 :hiddenp hidden
1846 "Interpret EXAMPLE-BLOCK element as Org syntax.
1847 CONTENTS is nil."
1855 ;;;; Export Block
1858 "Parse an export block.
1860 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1861 the buffer position at the beginning of the first affiliated
1862 keyword and CDR is a plist of affiliated keywords along with
1863 their value.
1865 Return a list whose CAR is `export-block' and CDR is a plist
1866 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1867 `:post-blank' and `:post-affiliated' keywords.
1869 Assume point is at export-block beginning."
1876 ;; Incomplete block: parse it as a paragraph.
1891 contents-end)))
1895 :end end
1896 :type type
1897 :value value
1898 :hiddenp hidden
1904 "Interpret EXPORT-BLOCK element as Org syntax.
1905 CONTENTS is nil."
1912 ;;;; Fixed-width
1915 "Parse a fixed-width section.
1917 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1918 the buffer position at the beginning of the first affiliated
1919 keyword and CDR is a plist of affiliated keywords along with
1920 their value.
1922 Return a list whose CAR is `fixed-width' and CDR is a plist
1923 containing `:begin', `:end', `:value', `:post-blank' and
1924 `:post-affiliated' keywords.
1926 Assume point is at the beginning of the fixed-width area."
1930 value
1935 ;; Accumulate text without starting colons.
1949 :end end
1950 :value value
1956 "Interpret FIXED-WIDTH element as Org syntax.
1957 CONTENTS is nil."
1965 ;;;; Horizontal Rule
1968 "Parse an horizontal rule.
1970 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1971 the buffer position at the beginning of the first affiliated
1972 keyword and CDR is a plist of affiliated keywords along with
1973 their value.
1975 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1976 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1977 keywords."
1988 :end end
1994 "Interpret HORIZONTAL-RULE element as Org syntax.
1995 CONTENTS is nil."
1999 ;;;; Keyword
2002 "Parse a keyword at point.
2004 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2005 the buffer position at the beginning of the first affiliated
2006 keyword and CDR is a plist of affiliated keywords along with
2007 their value.
2009 Return a list whose CAR is `keyword' and CDR is a plist
2010 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2011 `:post-affiliated' keywords."
2026 :value value
2027 :begin begin
2028 :end end
2034 "Interpret KEYWORD element as Org syntax.
2035 CONTENTS is nil."
2041 ;;;; Latex Environment
2044 "Parse a LaTeX environment.
2046 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2047 the buffer position at the beginning of the first affiliated
2048 keyword and CDR is a plist of affiliated keywords along with
2049 their value.
2051 Return a list whose CAR is `latex-environment' and CDR is a plist
2052 containing `:begin', `:end', `:value', `:post-blank' and
2053 `:post-affiliated' keywords.
2055 Assume point is at the beginning of the latex environment."
2062 limit t))
2063 ;; Incomplete latex environment: parse it as a paragraph.
2074 :end end
2075 :value value
2081 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2082 CONTENTS is nil."
2086 ;;;; Node Property
2089 "Parse a node-property at point.
2091 LIMIT bounds the search.
2093 Return a list whose CAR is `node-property' and CDR is a plist
2094 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2095 keywords."
2107 :value value
2108 :begin begin
2109 :end end
2113 "Interpret NODE-PROPERTY element as Org syntax.
2114 CONTENTS is nil."
2120 ;;;; Paragraph
2123 "Parse a paragraph.
2125 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2126 the buffer position at the beginning of the first affiliated
2127 keyword and CDR is a plist of affiliated keywords along with
2128 their value.
2130 Return a list whose CAR is `paragraph' and CDR is a plist
2131 containing `:begin', `:end', `:contents-begin' and
2132 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2134 Assume point is at the beginning of the paragraph."
2143 limit
2144 ;; A matching `org-element-paragraph-separate' is not
2145 ;; necessarily the end of the paragraph. In
2146 ;; particular, lines starting with # or : as a first
2147 ;; non-space character are ambiguous. We have check
2148 ;; if they are valid Org syntax (i.e. not an
2149 ;; incomplete keyword).
2153 ;; There's no ambiguity for other symbols or
2154 ;; empty lines: stop here.
2156 ;; Stop at valid fixed-width areas.
2158 ;; Stop at drawers.
2163 ;; Stop at valid comments.
2165 ;; Stop at valid dynamic blocks.
2170 ;; Stop at valid blocks.
2177 limit t)))
2178 ;; Stop at valid latex environments.
2185 limit t)))
2186 ;; Stop at valid keywords.
2188 ;; Skip everything else.
2206 :end end
2207 :contents-begin contents-begin
2208 :contents-end contents-end
2214 "Interpret PARAGRAPH element as Org syntax.
2215 CONTENTS is the contents of the element."
2216 contents)
2219 ;;;; Planning
2222 "Parse a planning.
2224 LIMIT bounds the search.
2226 Return a list whose CAR is `planning' and CDR is a plist
2227 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2228 and `:post-blank' keywords."
2238 closed deadline scheduled)
2250 :deadline deadline
2251 :scheduled scheduled
2252 :begin begin
2253 :end end
2257 "Interpret PLANNING element as Org syntax.
2258 CONTENTS is nil."
2260 'identity
2277 ;;;; Quote Section
2280 "Parse a quote section.
2282 LIMIT bounds the search.
2284 Return a list whose CAR is `quote-section' and CDR is a plist
2285 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2287 Assume point is at beginning of the section."
2298 :end end
2299 :value value
2303 "Interpret QUOTE-SECTION element as Org syntax.
2304 CONTENTS is nil."
2308 ;;;; Src Block
2311 "Parse a src block.
2313 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2314 the buffer position at the beginning of the first affiliated
2315 keyword and CDR is a plist of affiliated keywords along with
2316 their value.
2318 Return a list whose CAR is `src-block' and CDR is a plist
2319 containing `:language', `:switches', `:parameters', `:begin',
2320 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2321 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2322 `:post-blank' and `:post-affiliated' keywords.
2324 Assume point is at the beginning of the block."
2327 limit t)))
2328 ;; Incomplete block: parse it as a paragraph.
2334 ;; Get language as a string.
2343 ;; Get switches.
2345 ;; Get parameters.
2347 ;; Switches analysis
2359 ;; Should labels be retained in (or stripped from)
2360 ;; src blocks?
2365 ;; What should code-references use - labels or
2366 ;; line-numbers?
2371 ;; Indentation.
2373 ;; Get visibility status.
2375 ;; Retrieve code.
2384 ;; Get position after ending blank lines.
2395 :begin begin
2396 :end end
2397 :number-lines number-lines
2398 :preserve-indent preserve-indent
2399 :retain-labels retain-labels
2400 :use-labels use-labels
2401 :label-fmt label-fmt
2402 :hiddenp hidden
2403 :value value
2409 "Interpret SRC-BLOCK element as Org syntax.
2410 CONTENTS is nil."
2431 ;;;; Table
2434 "Parse a table at point.
2436 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2437 the buffer position at the beginning of the first affiliated
2438 keyword and CDR is a plist of affiliated keywords along with
2439 their value.
2441 Return a list whose CAR is `table' and CDR is a plist containing
2442 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2443 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2444 keywords.
2446 Assume point is at the beginning of the table."
2460 acc))
2468 :end end
2469 :type type
2470 :tblfm tblfm
2471 ;; Only `org' tables have contents. `table.el' tables
2472 ;; use a `:value' property to store raw table as
2473 ;; a string.
2478 table-begin table-end))
2484 "Interpret TABLE element as Org syntax.
2485 CONTENTS is nil."
2496 ;;;; Table Row
2499 "Parse table row at point.
2501 LIMIT bounds the search.
2503 Return a list whose CAR is `table-row' and CDR is a plist
2504 containing `:begin', `:end', `:contents-begin', `:contents-end',
2505 `:type' and `:post-blank' keywords."
2509 ;; A table rule has no contents. In that case, ensure
2510 ;; CONTENTS-BEGIN matches CONTENTS-END.
2522 :begin begin
2523 :end end
2524 :contents-begin contents-begin
2525 :contents-end contents-end
2529 "Interpret TABLE-ROW element as Org syntax.
2530 CONTENTS is the contents of the table row."
2535 ;;;; Verse Block
2538 "Parse a verse block.
2540 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2541 the buffer position at the beginning of the first affiliated
2542 keyword and CDR is a plist of affiliated keywords along with
2543 their value.
2545 Return a list whose CAR is `verse-block' and CDR is a plist
2546 containing `:begin', `:end', `:contents-begin', `:contents-end',
2547 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2549 Assume point is at beginning of the block."
2553 ;; Incomplete block: parse it as a paragraph.
2570 :end end
2571 :contents-begin contents-begin
2572 :contents-end contents-end
2573 :hiddenp hidden
2579 "Interpret VERSE-BLOCK element as Org syntax.
2580 CONTENTS is verse block contents."
2584 \f
2585 ;;; Objects
2586 ;;
2587 ;; Unlike to elements, interstices can be found between objects.
2588 ;; That's why, along with the parser, successor functions are provided
2589 ;; for each object. Some objects share the same successor (i.e. `code'
2590 ;; and `verbatim' objects).
2591 ;;
2592 ;; A successor must accept a single argument bounding the search. It
2593 ;; will return either a cons cell whose CAR is the object's type, as
2594 ;; a symbol, and CDR the position of its next occurrence, or nil.
2595 ;;
2596 ;; Successors follow the naming convention:
2597 ;; org-element-NAME-successor, where NAME is the name of the
2598 ;; successor, as defined in `org-element-all-successors'.
2599 ;;
2600 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2601 ;; object types they can contain will be specified in
2602 ;; `org-element-object-restrictions'.
2603 ;;
2604 ;; Adding a new type of object is simple. Implement a successor,
2605 ;; a parser, and an interpreter for it, all following the naming
2606 ;; convention. Register type in `org-element-all-objects' and
2607 ;; successor in `org-element-all-successors'. Maybe tweak
2608 ;; restrictions about it, and that's it.
2611 ;;;; Bold
2614 "Parse bold object at point.
2616 Return a list whose CAR is `bold' and CDR is a plist with
2617 `:begin', `:end', `:contents-begin' and `:contents-end' and
2618 `:post-blank' keywords.
2620 Assume point is at the first star marker."
2632 :end end
2633 :contents-begin contents-begin
2634 :contents-end contents-end
2638 "Interpret BOLD object as Org syntax.
2639 CONTENTS is the contents of the object."
2643 "Search for the next text-markup object.
2645 LIMIT bounds the search.
2647 Return value is a cons cell whose CAR is a symbol among `bold',
2648 `italic', `underline', `strike-through', `code' and `verbatim'
2649 and CDR is beginning position."
2665 ;;;; Code
2668 "Parse code object at point.
2670 Return a list whose CAR is `code' and CDR is a plist with
2671 `:value', `:begin', `:end' and `:post-blank' keywords.
2673 Assume point is at the first tilde marker."
2684 :begin begin
2685 :end end
2689 "Interpret CODE object as Org syntax.
2690 CONTENTS is nil."
2694 ;;;; Entity
2697 "Parse entity at point.
2699 Return a list whose CAR is `entity' and CDR a plist with
2700 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2701 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2702 keywords.
2704 Assume point is at the beginning of the entity."
2706 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2722 :begin begin
2723 :end end
2724 :use-brackets-p bracketsp
2728 "Interpret ENTITY object as Org syntax.
2729 CONTENTS is nil."
2735 "Search for the next latex-fragment or entity object.
2737 LIMIT bounds the search.
2739 Return value is a cons cell whose CAR is `entity' or
2740 `latex-fragment' and CDR is beginning position."
2745 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2752 limit t)
2755 ;; Determine if it's a real entity or a LaTeX command.
2758 ;; No entity nor command: point is at a LaTeX fragment.
2759 ;; Determine its type to get the correct beginning position.
2767 matchers)
2771 ;;;; Export Snippet
2774 "Parse export snippet at point.
2776 Return a list whose CAR is `export-snippet' and CDR a plist with
2777 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2778 keywords.
2780 Assume point is at the beginning of the snippet."
2792 :value value
2793 :begin begin
2794 :end end
2798 "Interpret EXPORT-SNIPPET object as Org syntax.
2799 CONTENTS is nil."
2805 "Search for the next export-snippet object.
2807 LIMIT bounds the search.
2809 Return value is a cons cell whose CAR is `export-snippet' and CDR
2810 its beginning position."
2819 ;;;; Footnote Reference
2822 "Parse footnote reference at point.
2824 Return a list whose CAR is `footnote-reference' and CDR a plist
2825 with `:label', `:type', `:inline-definition', `:begin', `:end'
2826 and `:post-blank' as keywords."
2848 :type type
2849 :begin begin
2850 :end end
2853 footnote-reference :inline-definition
2858 footnote-reference))))))
2861 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2862 CONTENTS is nil."
2872 "Search for the next footnote-reference object.
2874 LIMIT bounds the search.
2876 Return value is a cons cell whose CAR is `footnote-reference' and
2877 CDR is beginning position."
2891 ;;;; Inline Babel Call
2894 "Parse inline babel call at point.
2896 Return a list whose CAR is `inline-babel-call' and CDR a plist
2897 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2899 Assume point is at the beginning of the babel call."
2910 :end end
2911 :info info
2915 "Interpret INLINE-BABEL-CALL object as Org syntax.
2916 CONTENTS is nil."
2922 ;; Remove redundant square brackets.
2925 main-source)
2929 "Search for the next inline-babel-call object.
2931 LIMIT bounds the search.
2933 Return value is a cons cell whose CAR is `inline-babel-call' and
2934 CDR is beginning position."
2936 ;; Use a simplified version of
2937 ;; `org-babel-inline-lob-one-liner-regexp'.
2940 limit t)
2944 ;;;; Inline Src Block
2947 "Parse inline source block at point.
2949 LIMIT bounds the search.
2951 Return a list whose CAR is `inline-src-block' and CDR a plist
2952 with `:begin', `:end', `:language', `:value', `:parameters' and
2953 `:post-blank' as keywords.
2955 Assume point is at the beginning of the inline src block."
2968 :value value
2969 :parameters parameters
2970 :begin begin
2971 :end end
2975 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2976 CONTENTS is nil."
2981 language
2983 body)))
2986 "Search for the next inline-babel-call element.
2988 LIMIT bounds the search.
2990 Return value is a cons cell whose CAR is `inline-babel-call' and
2991 CDR is beginning position."
2997 ;;;; Italic
3000 "Parse italic object at point.
3002 Return a list whose CAR is `italic' and CDR is a plist with
3003 `:begin', `:end', `:contents-begin' and `:contents-end' and
3004 `:post-blank' keywords.
3006 Assume point is at the first slash marker."
3018 :end end
3019 :contents-begin contents-begin
3020 :contents-end contents-end
3024 "Interpret ITALIC object as Org syntax.
3025 CONTENTS is the contents of the object."
3029 ;;;; Latex Fragment
3032 "Parse latex fragment at point.
3034 Return a list whose CAR is `latex-fragment' and CDR a plist with
3035 `:value', `:begin', `:end', and `:post-blank' as keywords.
3037 Assume point is at the beginning of the latex fragment."
3051 ;; None found: it's a macro.
3060 :begin begin
3061 :end end
3065 "Interpret LATEX-FRAGMENT object as Org syntax.
3066 CONTENTS is nil."
3069 ;;;; Line Break
3072 "Parse line break at point.
3074 Return a list whose CAR is `line-break', and CDR a plist with
3075 `:begin', `:end' and `:post-blank' keywords.
3077 Assume point is at the beginning of the line break."
3084 "Interpret LINE-BREAK object as Org syntax.
3085 CONTENTS is nil."
3089 "Search for the next line-break object.
3091 LIMIT bounds the search.
3093 Return value is a cons cell whose CAR is `line-break' and CDR is
3094 beginning position."
3098 ;; A line break can only happen on a non-empty line.
3103 ;;;; Link
3106 "Parse link at point.
3108 Return a list whose CAR is `link' and CDR a plist with `:type',
3109 `:path', `:raw-link', `:application', `:search-option', `:begin',
3110 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3111 keywords.
3113 Assume point is at the beginning of the link."
3116 end contents-begin contents-end link-end post-blank path type
3117 raw-link link search-option application)
3119 ;; Type 1: Text targeted from a radio target.
3124 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3129 ;; RAW-LINK is the original link. Expand any
3130 ;; abbreviation in it.
3135 ;; Determine TYPE of link and set PATH accordingly.
3137 ;; File type.
3140 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3143 ;; Id type: PATH is the id.
3146 ;; Code-ref type: PATH is the name of the reference.
3149 ;; Custom-id type: PATH is the name of the custom id.
3152 ;; Fuzzy type: Internal link either matches a target, an
3153 ;; headline name or nothing. PATH is the target or
3154 ;; headline's name.
3156 ;; Type 3: Plain link, i.e. http://orgmode.org
3162 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3169 ;; In any case, deduce end point after trailing white space from
3170 ;; LINK-END variable.
3173 ;; Extract search option and opening application out of
3174 ;; "file"-type links.
3176 ;; Application.
3181 ;; Extract search option from PATH.
3185 ;; Make sure TYPE always report "file".
3189 :path path
3191 :application application
3192 :search-option search-option
3193 :begin begin
3194 :end end
3195 :contents-begin contents-begin
3196 :contents-end contents-end
3200 "Interpret LINK object as Org syntax.
3201 CONTENTS is the contents of the object, or nil."
3206 raw-link
3210 "Search for the next link object.
3212 LIMIT bounds the search.
3214 Return value is a cons cell whose CAR is `link' and CDR is
3215 beginning position."
3224 "Search for the next plain link object.
3226 LIMIT bounds the search.
3228 Return value is a cons cell whose CAR is `link' and CDR is
3229 beginning position."
3234 ;;;; Macro
3237 "Parse macro at point.
3239 Return a list whose CAR is `macro' and CDR a plist with `:key',
3240 `:args', `:begin', `:end', `:value' and `:post-blank' as
3241 keywords.
3243 Assume point is at the macro."
3254 ;; Do not use `org-split-string' since empty
3255 ;; strings are meaningful here.
3263 args nil t)
3267 :value value
3268 :args args
3269 :begin begin
3270 :end end
3274 "Interpret MACRO object as Org syntax.
3275 CONTENTS is nil."
3279 "Search for the next macro object.
3281 LIMIT bounds the search.
3283 Return value is cons cell whose CAR is `macro' and CDR is
3284 beginning position."
3288 limit t)
3292 ;;;; Radio-target
3295 "Parse radio target at point.
3297 Return a list whose CAR is `radio-target' and CDR a plist with
3298 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3299 and `:post-blank' as keywords.
3301 Assume point is at the radio target."
3313 :end end
3314 :contents-begin contents-begin
3315 :contents-end contents-end
3316 :post-blank post-blank
3320 "Interpret TARGET object as Org syntax.
3321 CONTENTS is the contents of the object."
3325 "Search for the next radio-target object.
3327 LIMIT bounds the search.
3329 Return value is a cons cell whose CAR is `radio-target' and CDR
3330 is beginning position."
3336 ;;;; Statistics Cookie
3339 "Parse statistics cookie at point.
3341 Return a list whose CAR is `statistics-cookie', and CDR a plist
3342 with `:begin', `:end', `:value' and `:post-blank' keywords.
3344 Assume point is at the beginning of the statistics-cookie."
3355 :end end
3356 :value value
3360 "Interpret STATISTICS-COOKIE object as Org syntax.
3361 CONTENTS is nil."
3365 "Search for the next statistics cookie object.
3367 LIMIT bounds the search.
3369 Return value is a cons cell whose CAR is `statistics-cookie' and
3370 CDR is beginning position."
3376 ;;;; Strike-Through
3379 "Parse strike-through object at point.
3381 Return a list whose CAR is `strike-through' and CDR is a plist
3382 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3383 `:post-blank' keywords.
3385 Assume point is at the first plus sign marker."
3397 :end end
3398 :contents-begin contents-begin
3399 :contents-end contents-end
3403 "Interpret STRIKE-THROUGH object as Org syntax.
3404 CONTENTS is the contents of the object."
3408 ;;;; Subscript
3411 "Parse subscript at point.
3413 Return a list whose CAR is `subscript' and CDR a plist with
3414 `:begin', `:end', `:contents-begin', `:contents-end',
3415 `:use-brackets-p' and `:post-blank' as keywords.
3417 Assume point is at the underscore."
3421 t
3432 :end end
3433 :use-brackets-p bracketsp
3434 :contents-begin contents-begin
3435 :contents-end contents-end
3439 "Interpret SUBSCRIPT object as Org syntax.
3440 CONTENTS is the contents of the object."
3443 contents))
3446 "Search for the next sub/superscript object.
3448 LIMIT bounds the search.
3450 Return value is a cons cell whose CAR is either `subscript' or
3451 `superscript' and CDR is beginning position."
3459 ;;;; Superscript
3462 "Parse superscript at point.
3464 Return a list whose CAR is `superscript' and CDR a plist with
3465 `:begin', `:end', `:contents-begin', `:contents-end',
3466 `:use-brackets-p' and `:post-blank' as keywords.
3468 Assume point is at the caret."
3482 :end end
3483 :use-brackets-p bracketsp
3484 :contents-begin contents-begin
3485 :contents-end contents-end
3489 "Interpret SUPERSCRIPT object as Org syntax.
3490 CONTENTS is the contents of the object."
3493 contents))
3496 ;;;; Table Cell
3499 "Parse table cell at point.
3501 Return a list whose CAR is `table-cell' and CDR is a plist
3502 containing `:begin', `:end', `:contents-begin', `:contents-end'
3503 and `:post-blank' keywords."
3511 :end end
3512 :contents-begin contents-begin
3513 :contents-end contents-end
3517 "Interpret TABLE-CELL element as Org syntax.
3518 CONTENTS is the contents of the cell, or nil."
3522 "Search for the next table-cell object.
3524 LIMIT bounds the search.
3526 Return value is a cons cell whose CAR is `table-cell' and CDR is
3527 beginning position."
3531 ;;;; Target
3534 "Parse target at point.
3536 Return a list whose CAR is `target' and CDR a plist with
3537 `:begin', `:end', `:value' and `:post-blank' as keywords.
3539 Assume point is at the target."
3549 :end end
3550 :value value
3554 "Interpret TARGET object as Org syntax.
3555 CONTENTS is nil."
3559 "Search for the next target object.
3561 LIMIT bounds the search.
3563 Return value is a cons cell whose CAR is `target' and CDR is
3564 beginning position."
3570 ;;;; Timestamp
3573 "Parse time stamp at point.
3575 Return a list whose CAR is `timestamp', and CDR a plist with
3576 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3578 Assume point is at the beginning of the timestamp."
3596 date-start)
3607 raw-value)
3609 :repeater-type
3615 :repeater-unit
3618 year-start month-start day-start hour-start minute-start year-end
3619 month-end day-end hour-end minute-end)
3620 ;; Parse date-start.
3628 ;; Compute date-end. It can be provided directly in time-stamp,
3629 ;; or extracted from time range. Otherwise, it defaults to the
3630 ;; same values as date-start.
3640 :raw-value raw-value
3641 :year-start year-start
3642 :month-start month-start
3643 :day-start day-start
3644 :hour-start hour-start
3645 :minute-start minute-start
3646 :year-end year-end
3647 :month-end month-end
3648 :day-end day-end
3649 :hour-end hour-end
3650 :minute-end minute-end
3651 :begin begin
3652 :end end
3654 repeater-props)))))
3657 "Interpret TIMESTAMP object as Org syntax.
3658 CONTENTS is nil."
3659 ;; Use `:raw-value' if specified.
3661 ;; Otherwise, build timestamp string.
3671 ;; Build an Org timestamp string from TIME. ACTIVEP is
3672 ;; non-nil when time stamp is active. If WITH-TIME-P is
3673 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3674 ;; specify a time range in the timestamp. REPEAT-STRING
3675 ;; is the repeater string, if any.
3679 org-time-stamp-formats)
3680 time)))
3686 nil nil ts)))
3690 " "
3691 repeat-string
3693 ;; Return value.
3694 ts)))
3706 build-ts-string
3725 0
3733 "--"
3745 "Search for the next timestamp object.
3747 LIMIT bounds the search.
3749 Return value is a cons cell whose CAR is `timestamp' and CDR is
3750 beginning position."
3758 limit t)
3762 ;;;; Underline
3765 "Parse underline object at point.
3767 Return a list whose CAR is `underline' and CDR is a plist with
3768 `:begin', `:end', `:contents-begin' and `:contents-end' and
3769 `:post-blank' keywords.
3771 Assume point is at the first underscore marker."
3783 :end end
3784 :contents-begin contents-begin
3785 :contents-end contents-end
3789 "Interpret UNDERLINE object as Org syntax.
3790 CONTENTS is the contents of the object."
3794 ;;;; Verbatim
3797 "Parse verbatim object at point.
3799 Return a list whose CAR is `verbatim' and CDR is a plist with
3800 `:value', `:begin', `:end' and `:post-blank' keywords.
3802 Assume point is at the first equal sign marker."
3813 :begin begin
3814 :end end
3818 "Interpret VERBATIM object as Org syntax.
3819 CONTENTS is nil."
3823 \f
3824 ;;; Parsing Element Starting At Point
3825 ;;
3826 ;; `org-element--current-element' is the core function of this section.
3827 ;; It returns the Lisp representation of the element starting at
3828 ;; point.
3829 ;;
3830 ;; `org-element--current-element' makes use of special modes. They
3831 ;; are activated for fixed element chaining (i.e. `plain-list' >
3832 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3833 ;; `section'). Special modes are: `first-section', `item',
3834 ;; `node-property', `quote-section', `section' and `table-row'.
3838 "Parse the element starting at point.
3840 LIMIT bounds the search.
3842 Return value is a list like (TYPE PROPS) where TYPE is the type
3843 of the element and PROPS a plist of properties associated to the
3844 element.
3846 Possible types are defined in `org-element-all-elements'.
3848 Optional argument GRANULARITY determines the depth of the
3849 recursion. Allowed values are `headline', `greater-element',
3850 `element', `object' or nil. When it is broader than `object' (or
3851 nil), secondary values will not be parsed, since they only
3852 contain objects.
3854 Optional argument SPECIAL, when non-nil, can be either
3855 `first-section', `item', `node-property', `quote-section',
3856 `section', and `table-row'.
3858 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3859 be computed.
3861 This function assumes point is always at the beginning of the
3862 element it has to parse."
3865 ;; Determine if parsing depth allows for secondary strings
3866 ;; parsing. It only applies to elements referenced in
3867 ;; `org-element-secondary-value-alist'.
3870 ;; Item.
3873 ;; Table Row.
3875 ;; Node Property.
3877 ;; Headline.
3880 ;; Sections (must be checked after headline).
3886 limit)))
3887 ;; When not at bol, point is at the beginning of an item or
3888 ;; a footnote definition: next item is always a paragraph.
3890 ;; Planning and Clock.
3895 ;; Inlinetask.
3898 ;; From there, elements can have affiliated keywords.
3901 ;; Jumping over affiliated keywords put point off-limits.
3902 ;; Parse them as regular keywords.
3906 ;; LaTeX Environment.
3910 ;; Drawer and Property Drawer.
3915 ;; Fixed Width
3918 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3919 ;; Keywords.
3928 org-element-block-name-alist)))
3943 ;; Footnote Definition.
3946 ;; Horizontal Rule.
3949 ;; Diary Sexp.
3952 ;; Table.
3954 ;; List.
3957 limit affiliated
3959 ;; Default element: Paragraph.
3963 ;; Most elements can have affiliated keywords. When looking for an
3964 ;; element beginning, we want to move before them, as they belong to
3965 ;; that element, and, in the meantime, collect information they give
3966 ;; into appropriate properties. Hence the following function.
3969 "Collect affiliated keywords from point down to LIMIT.
3971 Return a list whose CAR is the position at the first of them and
3972 CDR a plist of keywords and values and move point to the
3973 beginning of the first line after them.
3975 As a special case, if element doesn't start at the beginning of
3976 the line (i.e. a paragraph starting an item), CAR is current
3977 position of point and CDR is nil."
3981 ;; RESTRICT is the list of objects allowed in parsed
3982 ;; keywords value.
3984 output)
3987 ;; Apply translation to RAW-KWD. From there, KWD is
3988 ;; the official keyword.
3990 org-element-keyword-translation-alist))
3991 raw-kwd))
3992 ;; Find main value for any keyword.
3998 ;; PARSEDP is non-nil when keyword should have its
3999 ;; value parsed.
4001 ;; If KWD is a dual keyword, find its secondary
4002 ;; value. Maybe parse it.
4009 ;; Attribute a property name to KWD.
4011 ;; Now set final shape for VALUE.
4017 ;; Attributes can always appear on multiple lines.
4020 ;; Eventually store the new value in OUTPUT.
4022 ;; Move to next keyword.
4024 ;; If affiliated keywords are orphaned: move back to first one.
4025 ;; They will be parsed as a paragraph.
4027 ;; Return value.
4031 \f
4032 ;;; The Org Parser
4033 ;;
4034 ;; The two major functions here are `org-element-parse-buffer', which
4035 ;; parses Org syntax inside the current buffer, taking into account
4036 ;; region, narrowing, or even visibility if specified, and
4037 ;; `org-element-parse-secondary-string', which parses objects within
4038 ;; a given string.
4039 ;;
4040 ;; The (almost) almighty `org-element-map' allows to apply a function
4041 ;; on elements or objects matching some type, and accumulate the
4042 ;; resulting values. In an export situation, it also skips unneeded
4043 ;; parts of the parse tree.
4046 "Recursively parse the buffer and return structure.
4047 If narrowing is in effect, only parse the visible part of the
4048 buffer.
4050 Optional argument GRANULARITY determines the depth of the
4051 recursion. It can be set to the following symbols:
4053 `headline' Only parse headlines.
4054 `greater-element' Don't recurse into greater elements excepted
4055 headlines and sections. Thus, elements
4056 parsed are the top-level ones.
4057 `element' Parse everything but objects and plain text.
4058 `object' Parse the complete buffer (default).
4060 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4061 elements.
4063 An element or an objects is represented as a list with the
4064 pattern (TYPE PROPERTIES CONTENTS), where :
4066 TYPE is a symbol describing the element or object. See
4067 `org-element-all-elements' and `org-element-all-objects' for an
4068 exhaustive list of such symbols. One can retrieve it with
4069 `org-element-type' function.
4071 PROPERTIES is the list of attributes attached to the element or
4072 object, as a plist. Although most of them are specific to the
4073 element or object type, all types share `:begin', `:end',
4074 `:post-blank' and `:parent' properties, which respectively
4075 refer to buffer position where the element or object starts,
4076 ends, the number of white spaces or blank lines after it, and
4077 the element or object containing it. Properties values can be
4078 obtained by using `org-element-property' function.
4080 CONTENTS is a list of elements, objects or raw strings
4081 contained in the current element or object, when applicable.
4082 One can access them with `org-element-contents' function.
4084 The Org buffer has `org-data' as type and nil as properties.
4085 `org-element-map' function can be used to find specific elements
4086 or objects within the parse tree.
4088 This function assumes that current major mode is `org-mode'."
4094 ;; Start in `first-section' mode so text before the first
4095 ;; headline belongs to a section.
4099 "Recursively parse objects in STRING and return structure.
4101 RESTRICTION is a symbol limiting the object types that will be
4102 looked after.
4104 Optional argument PARENT, when non-nil, is the element or object
4105 containing the secondary string. It is used to set correctly
4106 `:parent' property within the string."
4107 ;; Copy buffer-local variables listed in
4108 ;; `org-element-object-variables' into temporary buffer. This is
4109 ;; required since object parsing is dependent on these variables.
4113 org-element-object-variables))))
4121 secondary))
4122 secondary))))
4126 "Map a function on selected elements or objects.
4128 DATA is a parse tree, an element, an object, a string, or a list
4129 of such constructs. TYPES is a symbol or list of symbols of
4130 elements or objects types (see `org-element-all-elements' and
4131 `org-element-all-objects' for a complete list of types). FUN is
4132 the function called on the matching element or object. It has to
4133 accept one argument: the element or object itself.
4135 When optional argument INFO is non-nil, it should be a plist
4136 holding export options. In that case, parts of the parse tree
4137 not exportable according to that property list will be skipped.
4139 When optional argument FIRST-MATCH is non-nil, stop at the first
4140 match for which FUN doesn't return nil, and return that value.
4142 Optional argument NO-RECURSION is a symbol or a list of symbols
4143 representing elements or objects types. `org-element-map' won't
4144 enter any recursive element or object whose type belongs to that
4145 list. Though, FUN can still be applied on them.
4147 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4148 apply to matching objects within parsed affiliated keywords (see
4149 `org-element-parsed-keywords').
4151 Nil values returned from FUN do not appear in the results.
4154 Examples:
4155 ---------
4157 Assuming TREE is a variable containing an Org buffer parse tree,
4158 the following example will return a flat list of all `src-block'
4159 and `example-block' elements in it:
4161 \(org-element-map tree '(example-block src-block) 'identity)
4163 The following snippet will find the first headline with a level
4166 \(org-element-map tree 'headline
4167 \(lambda (hl)
4168 \(and (= (org-element-property :level hl) 1)
4170 \(org-element-property :begin hl)))
4171 nil t)
4173 The next example will return a flat list of all `plain-list' type
4174 elements in TREE that are not a sub-list themselves:
4176 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4178 Eventually, this example will return a flat list of all `bold'
4179 type objects containing a `latex-snippet' type object, even
4180 looking into captions:
4182 \(org-element-map tree 'bold
4183 \(lambda (b)
4184 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4185 nil nil nil t)"
4186 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4189 ;; Recursion depth is determined by --CATEGORY.
4196 ;; If one object is found, the function
4197 ;; has to recurse into every object.
4200 ;; If one regular element is found, the
4201 ;; function has to recurse, at least,
4202 ;; into every element it encounters.
4205 types)
4206 category)))
4207 ;; Compute properties for affiliated keywords if necessary.
4212 org-element-affiliated-keywords)))
4213 --acc
4214 --walk-tree
4218 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4219 ;; holding contextual information.
4223 ;; Ignored element in an export context.
4225 ;; List of elements or objects.
4227 ;; Unconditionally enter parse trees.
4231 ;; Check if TYPE is matching among TYPES. If so,
4232 ;; apply FUN to --DATA and accumulate return value
4233 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4239 ;; If --DATA has a secondary string that can contain
4240 ;; objects with their type among TYPES, look into it.
4247 ;; If --DATA has any affiliated keywords and
4248 ;; WITH-AFFILIATED is non-nil, look for objects in
4249 ;; them.
4257 ;; Pay attention to the type of value.
4258 ;; Preserve order for multiple keywords.
4274 --affiliated-alist))
4275 ;; Determine if a recursion into --DATA is possible.
4277 ;; --TYPE is explicitly removed from recursion.
4279 ;; --DATA has no contents.
4281 ;; Looking for greater elements but --DATA is simply
4282 ;; an element or an object.
4285 ;; Looking for elements but --DATA is an object.
4288 ;; In any other case, map contents.
4292 ;; Return value in a proper order.
4296 ;; The following functions are internal parts of the parser.
4297 ;;
4298 ;; The first one, `org-element--parse-elements' acts at the element's
4299 ;; level.
4300 ;;
4301 ;; The second one, `org-element--parse-objects' applies on all objects
4302 ;; of a paragraph or a secondary string. It uses
4303 ;; `org-element--get-next-object-candidates' to optimize the search of
4304 ;; the next object in the buffer.
4305 ;;
4306 ;; More precisely, that function looks for every allowed object type
4307 ;; first. Then, it discards failed searches, keeps further matches,
4308 ;; and searches again types matched behind point, for subsequent
4309 ;; calls. Thus, searching for a given type fails only once, and every
4310 ;; object is searched only once at top level (but sometimes more for
4311 ;; nested types).
4315 "Parse elements between BEG and END positions.
4317 SPECIAL prioritize some elements over the others. It can be set
4318 to `first-section', `quote-section', `section' `item' or
4319 `table-row'.
4321 When value is `item', STRUCTURE will be used as the current list
4322 structure.
4324 GRANULARITY determines the depth of the recursion. See
4325 `org-element-parse-buffer' for more information.
4327 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4328 elements.
4330 Elements are accumulated into ACC."
4333 ;; Visible only: skip invisible parts at the beginning of the
4334 ;; element.
4337 ;; When parsing only headlines, skip any text before first one.
4340 ;; Main loop start.
4342 ;; Find current element's type and parse it accordingly to
4343 ;; its category.
4345 end granularity special structure))
4349 ;; Visible only: skip invisible parts between siblings.
4352 ;; Fill ELEMENT contents by side-effect.
4354 ;; If element has no contents, don't modify it.
4356 ;; Greater element: parse it between `contents-begin' and
4357 ;; `contents-end'. Make sure GRANULARITY allows the
4358 ;; recursion, or ELEMENT is a headline, in which case going
4359 ;; inside is mandatory, in order to get sub-level headings.
4367 ;; Possibly switch to a special mode.
4377 granularity visible-only element))
4378 ;; ELEMENT has contents. Parse objects inside, if
4379 ;; GRANULARITY allows it.
4385 ;; Return result.
4386 acc))
4389 "Parse objects between BEG and END and return recursive structure.
4391 Objects are accumulated in ACC.
4393 RESTRICTION is a list of object successors which are allowed in
4394 the current object."
4400 end restriction candidates)))
4407 ;; 1. Text before any object. Untabify it.
4412 acc
4416 ;; 2. Object...
4419 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4420 ;; a recursive type.
4425 cont-beg
4432 ;; 3. Text after last object. Untabify it.
4436 acc
4440 ;; Result.
4441 acc)))
4444 "Return an alist of candidates for the next object.
4446 LIMIT bounds the search, and RESTRICTION narrows candidates to
4447 some object successors.
4449 OBJECTS is the previous candidates alist. If it is set to
4450 `initial', no search has been done before, and all symbols in
4451 RESTRICTION should be looked after.
4453 Return value is an alist whose CAR is the object type and CDR its
4454 beginning position."
4456 nil
4458 ;; When searching for the first time, look for every successor
4459 ;; allowed in RESTRICTION.
4463 restriction)
4464 ;; Focus on objects returned during last search. Keep those
4465 ;; still after point. Search again objects before it.
4471 type)))
4474 limit)))))
4475 objects))))
4478 \f
4479 ;;; Towards A Bijective Process
4480 ;;
4481 ;; The parse tree obtained with `org-element-parse-buffer' is really
4482 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4483 ;; interpreted and expanded into a string with canonical Org syntax.
4484 ;; Hence `org-element-interpret-data'.
4485 ;;
4486 ;; The function relies internally on
4487 ;; `org-element--interpret-affiliated-keywords'.
4489 ;;;###autoload
4491 "Interpret DATA as Org syntax.
4493 DATA is a parse tree, an element, an object or a secondary string
4494 to interpret.
4496 Optional argument PARENT is used for recursive calls. It contains
4497 the element or object containing data, or nil.
4499 Return Org syntax as a string."
4503 ;; Secondary string.
4508 ;; Full Org document.
4513 ;; Plain text: remove `:parent' text property from output.
4515 ;; Element/Object without contents.
4518 data nil))
4519 ;; Element/Object with contents.
4529 ;; Elements directly containing objects must
4530 ;; have their indentation normalized first.
4532 data
4533 ;; When normalizing first paragraph of an
4534 ;; item or a footnote-definition, ignore
4535 ;; first line's indentation.
4542 data
4544 contents)))))))
4546 ;; Build white spaces. If no `:post-blank' property is
4547 ;; specified, assume its value is 0.
4557 "Return ELEMENT's affiliated keywords as Org syntax.
4558 If there is no affiliated keyword, return the empty string."
4568 ": "
4571 value)
4579 ;; All attribute keywords can have multiple lines.
4585 ;; List all ELEMENT's properties matching an attribute line or an
4586 ;; affiliated keyword, but ignore translated keywords since they
4587 ;; cannot belong to the property list.
4594 org-element-keyword-translation-alist)))))
4595 collect prop)
4598 ;; Because interpretation of the parse tree must return the same
4599 ;; number of blank lines between elements and the same number of white
4600 ;; space after objects, some special care must be given to white
4601 ;; spaces.
4602 ;;
4603 ;; The first function, `org-element-normalize-string', ensures any
4604 ;; string different from the empty string will end with a single
4605 ;; newline character.
4606 ;;
4607 ;; The second function, `org-element-normalize-contents', removes
4608 ;; global indentation from the contents of the current element.
4611 "Ensure string S ends with a single newline character.
4613 If S isn't a string return it unchanged. If S is the empty
4614 string, return it. Otherwise, return a new string with a single
4615 newline character at its end."
4623 "Normalize plain text in ELEMENT's contents.
4625 ELEMENT must only contain plain text and objects.
4627 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4628 indentation to compute maximal common indentation.
4630 Return the normalized element that is element with global
4631 indentation removed from its contents. The function assumes that
4632 indentation is not done with TAB characters."
4634 collect-inds ; for byte-compiler
4637 ;; Return list of indentations within BLOB. This is done by
4638 ;; walking recursively BLOB and updating IND-LIST along the
4639 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4640 ;; been seen yet. It is required as this string is the only
4641 ;; one whose indentation doesn't happen after a newline
4642 ;; character.
4650 ;; An indentation of zero means no string will be
4651 ;; modified. Quit the process.
4657 ;; Avoid matching blank or empty lines.
4665 ;; Collect indentation list in ELEMENT. Possibly remove first
4666 ;; value if IGNORE-FIRST is non-nil.
4669 ;; Build ELEMENT back, replacing each string with the same
4670 ;; string minus common indentation.
4675 ;; Return BLOB with all its strings indentation
4676 ;; shortened from MCI white spaces. FIRST-FLAG is
4677 ;; non-nil when the first string hasn't been seen
4678 ;; yet.
4692 org-element-recursive-objects)
4696 blob))))
4700 \f
4701 ;;; The Toolbox
4702 ;;
4703 ;; The first move is to implement a way to obtain the smallest element
4704 ;; containing point. This is the job of `org-element-at-point'. It
4705 ;; basically jumps back to the beginning of section containing point
4706 ;; and moves, element after element, with
4707 ;; `org-element--current-element' until the container is found. Note:
4708 ;; When using `org-element-at-point', secondary values are never
4709 ;; parsed since the function focuses on elements, not on objects.
4710 ;;
4711 ;; At a deeper level, `org-element-context' lists all elements and
4712 ;; objects containing point.
4713 ;;
4714 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4715 ;; internally by navigation and manipulation tools.
4717 ;;;###autoload
4719 "Determine closest element around point.
4721 Return value is a list like (TYPE PROPS) where TYPE is the type
4722 of the element and PROPS a plist of properties associated to the
4723 element.
4725 Possible types are defined in `org-element-all-elements'.
4726 Properties depend on element or object type, but always include
4727 `:begin', `:end', `:parent' and `:post-blank' properties.
4729 As a special case, if point is at the very beginning of a list or
4730 sub-list, returned element will be that list instead of the first
4731 item. In the same way, if point is at the beginning of the first
4732 row of a table, returned element will be the table instead of the
4733 first row.
4735 If optional argument KEEP-TRAIL is non-nil, the function returns
4736 a list of elements leading to element at point. The list's CAR
4737 is always the element at point. The following positions contain
4738 element's siblings, then parents, siblings of parents, until the
4739 first element of current section."
4741 ;; If at a headline, parse it. It is the sole element that
4742 ;; doesn't require to know about context. Be sure to disallow
4743 ;; secondary string parsing, though.
4749 ;; Otherwise move at the beginning of the section containing
4750 ;; point.
4755 element type special-flag trail struct prevs parent)
4758 ;; In empty lines at buffer's beginning, return nil.
4767 ;; In blank lines just after the headline, point still
4768 ;; belongs to the headline.
4776 ;; Parse successively each element, skipping those ending
4777 ;; before original position.
4785 ;; 1. Skip any element ending before point. Also skip
4786 ;; element ending at point when we're sure that another
4787 ;; element has started.
4792 ;; 2. An element containing point is always the element at
4793 ;; point.
4796 ;; 3. At any other greater element type, if point is
4797 ;; within contents, move into it.
4802 ;; Create an anchor for tables and plain lists:
4803 ;; when point is at the very beginning of these
4804 ;; elements, ignoring affiliated keywords,
4805 ;; target them instead of their contents.
4807 ;; When point is at contents end, do not move
4808 ;; into elements with an explicit ending, but
4809 ;; return that element instead.
4813 drawer dynamic-block inlinetask item
4814 plain-list property-drawer quote-block
4815 special-block))))
4830 ;;;###autoload
4832 "Return closest element or object around point.
4834 Return value is a list like (TYPE PROPS) where TYPE is the type
4835 of the element or object and PROPS a plist of properties
4836 associated to it.
4838 Possible types are defined in `org-element-all-elements' and
4839 `org-element-all-objects'. Properties depend on element or
4840 object type, but always include `:begin', `:end', `:parent' and
4841 `:post-blank'.
4843 Optional argument ELEMENT, when non-nil, is the closest element
4844 containing point, as returned by `org-element-at-point'.
4845 Providing it allows for quicker computation."
4850 end)
4851 ;; Check if point is inside an element containing objects or at
4852 ;; a secondary string. In that case, move to beginning of the
4853 ;; element or secondary string and set END to the other side.
4860 org-element-parsed-keywords))
4861 ;; We're at an affiliated keyword. Change
4862 ;; type to retrieve correct restrictions.
4864 ;; Determine if we're at main or dual value.
4878 (<= origin
4879 ;; `1+' is required so some
4880 ;; successors can match
4881 ;; properly their object.
4903 element
4909 end restriction candidates))
4911 candidates)))
4912 ;; If ORIGIN is before next object in element, there's
4913 ;; no point in looking further.
4923 ;; ORIGIN is after OBJECT, so skip it.
4929 ;; ORIGIN is within a non-recursive object or at
4930 ;; an object boundaries: Return that object.
4934 ;; Otherwise, move within current object and
4935 ;; restrict search to the end of its contents.
4940 candidates 'initial
4941 end cend)))))))
4942 parent))))))
4945 "Non-nil when elements ELEM-A and ELEM-B are nested."
4954 "Swap elements ELEM-A and ELEM-B.
4955 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4956 end of ELEM-A."
4958 ;; There are two special cases when an element doesn't start at bol:
4959 ;; the first paragraph in an item or in a footnote definition.
4961 ;; Only a paragraph without any affiliated keyword can be moved at
4962 ;; ELEM-A position in such a situation. Note that the case of
4963 ;; a footnote definition is impossible: it cannot contain two
4964 ;; paragraphs in a row because it cannot contain a blank line.
4970 ;; In a special situation, ELEM-A will have no indentation. We'll
4971 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4985 ;; Store overlays responsible for visibility status. We
4986 ;; also need to store their boundaries as they will be
4987 ;; removed from buffer.
4994 ;; Get contents.
5002 ;; Restore ex ELEM-A overlays.
5011 ;; Restore ex ELEM-B overlays.
5020 ;; Local variables:
5021 ;; generated-autoload-file: "org-loaddefs.el"
5022 ;; End:
5024 ;;; org-element.el ends here