| blob | 5f2e700cfa10d49ebc9d64c8d8b21b43d34b19de |
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 ;; Incomplete block: parse it as a paragraph.
1450 ;; Empty blocks have no contents.
1465 :begin begin
1466 :end end
1467 :hiddenp hidden
1468 :contents-begin contents-begin
1469 :contents-end contents-end
1475 "Interpret SPECIAL-BLOCK element as Org syntax.
1476 CONTENTS is the contents of the element."
1481 \f
1482 ;;; Elements
1483 ;;
1484 ;; For each element, a parser and an interpreter are also defined.
1485 ;; Both follow the same naming convention used for greater elements.
1486 ;;
1487 ;; Also, as for greater elements, adding a new element type is done
1488 ;; through the following steps: implement a parser and an interpreter,
1489 ;; tweak `org-element--current-element' so that it recognizes the new
1490 ;; type and add that new type to `org-element-all-elements'.
1491 ;;
1492 ;; As a special case, when the newly defined type is a block type,
1493 ;; `org-element-block-name-alist' has to be modified accordingly.
1496 ;;;; Babel Call
1499 "Parse a babel call.
1501 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1502 the buffer position at the beginning of the first affiliated
1503 keyword and CDR is a plist of affiliated keywords along with
1504 their value.
1506 Return a list whose CAR is `babel-call' and CDR is a plist
1507 containing `:begin', `:end', `:info', `:post-blank' and
1508 `:post-affiliated' as keywords."
1522 :end end
1523 :info info
1529 "Interpret BABEL-CALL element as Org syntax.
1530 CONTENTS is nil."
1536 ;; Remove redundant square brackets.
1541 ;;;; Clock
1544 "Parse a clock.
1546 LIMIT bounds the search.
1548 Return a list whose CAR is `clock' and CDR is a plist containing
1549 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1550 as keywords."
1570 :value value
1571 :duration duration
1572 :begin begin
1573 :end end
1577 "Interpret CLOCK element as Org syntax.
1578 CONTENTS is nil."
1586 "%2s:%02s"
1590 ;;;; Comment
1593 "Parse a comment.
1595 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1596 the buffer position at the beginning of the first affiliated
1597 keyword and CDR is a plist of affiliated keywords along with
1598 their value.
1600 Return a list whose CAR is `comment' and CDR is a plist
1601 containing `:begin', `:end', `:value', `:post-blank',
1602 `:post-affiliated' keywords.
1604 Assume point is at comment beginning."
1613 ;; Get comments ending.
1616 ;; Accumulate lines without leading hash and first
1617 ;; whitespace.
1632 :end end
1633 :value value
1639 "Interpret COMMENT element as Org syntax.
1640 CONTENTS is nil."
1644 ;;;; Comment Block
1647 "Parse an export block.
1649 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1650 the buffer position at the beginning of the first affiliated
1651 keyword and CDR is a plist of affiliated keywords along with
1652 their value.
1654 Return a list whose CAR is `comment-block' and CDR is a plist
1655 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1656 and `:post-affiliated' keywords.
1658 Assume point is at comment block beginning."
1662 ;; Incomplete block: parse it as a paragraph.
1677 contents-begin contents-end)))
1681 :end end
1682 :value value
1683 :hiddenp hidden
1689 "Interpret COMMENT-BLOCK element as Org syntax.
1690 CONTENTS is nil."
1695 ;;;; Diary Sexp
1698 "Parse a diary sexp.
1700 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1701 the buffer position at the beginning of the first affiliated
1702 keyword and CDR is a plist of affiliated keywords along with
1703 their value.
1705 Return a list whose CAR is `diary-sexp' and CDR is a plist
1706 containing `:begin', `:end', `:value', `:post-blank' and
1707 `:post-affiliated' keywords."
1720 :begin begin
1721 :end end
1727 "Interpret DIARY-SEXP as Org syntax.
1728 CONTENTS is nil."
1732 ;;;; Example Block
1735 "Remove maximum common indentation in string S and return it.
1736 When optional argument N is a positive integer, remove exactly
1737 that much characters from indentation, if possible, or return
1738 S as-is otherwise. Unlike to `org-remove-indentation', this
1739 function doesn't call `untabify' on S."
1744 ;; Find maximum common indentation, if not specified.
1752 min-ind)))
1754 ;; Remove exactly N indentation, but give up if not possible.
1764 "Parse an example block.
1766 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1767 the buffer position at the beginning of the first affiliated
1768 keyword and CDR is a plist of affiliated keywords along with
1769 their value.
1771 Return a list whose CAR is `example-block' and CDR is a plist
1772 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1773 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1774 `:switches', `:value', `:post-blank' and `:post-affiliated'
1775 keywords."
1779 ;; Incomplete block: parse it as a paragraph.
1787 ;; Switches analysis
1795 ;; Should labels be retained in (or stripped from) example
1796 ;; blocks?
1801 ;; What should code-references use - labels or
1802 ;; line-numbers?
1811 ;; Standard block parsing.
1820 contents-begin contents-end))
1831 :end end
1832 :value value
1833 :switches switches
1834 :number-lines number-lines
1835 :preserve-indent preserve-indent
1836 :retain-labels retain-labels
1837 :use-labels use-labels
1838 :label-fmt label-fmt
1839 :hiddenp hidden
1845 "Interpret EXAMPLE-BLOCK element as Org syntax.
1846 CONTENTS is nil."
1854 ;;;; Export Block
1857 "Parse an export block.
1859 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1860 the buffer position at the beginning of the first affiliated
1861 keyword and CDR is a plist of affiliated keywords along with
1862 their value.
1864 Return a list whose CAR is `export-block' and CDR is a plist
1865 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1866 `:post-blank' and `:post-affiliated' keywords.
1868 Assume point is at export-block beginning."
1875 ;; Incomplete block: parse it as a paragraph.
1890 contents-end)))
1894 :end end
1895 :type type
1896 :value value
1897 :hiddenp hidden
1903 "Interpret EXPORT-BLOCK element as Org syntax.
1904 CONTENTS is nil."
1911 ;;;; Fixed-width
1914 "Parse a fixed-width section.
1916 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1917 the buffer position at the beginning of the first affiliated
1918 keyword and CDR is a plist of affiliated keywords along with
1919 their value.
1921 Return a list whose CAR is `fixed-width' and CDR is a plist
1922 containing `:begin', `:end', `:value', `:post-blank' and
1923 `:post-affiliated' keywords.
1925 Assume point is at the beginning of the fixed-width area."
1929 value
1934 ;; Accumulate text without starting colons.
1948 :end end
1949 :value value
1955 "Interpret FIXED-WIDTH element as Org syntax.
1956 CONTENTS is nil."
1964 ;;;; Horizontal Rule
1967 "Parse an horizontal rule.
1969 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1970 the buffer position at the beginning of the first affiliated
1971 keyword and CDR is a plist of affiliated keywords along with
1972 their value.
1974 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1975 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1976 keywords."
1987 :end end
1993 "Interpret HORIZONTAL-RULE element as Org syntax.
1994 CONTENTS is nil."
1998 ;;;; Keyword
2001 "Parse a keyword at point.
2003 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2004 the buffer position at the beginning of the first affiliated
2005 keyword and CDR is a plist of affiliated keywords along with
2006 their value.
2008 Return a list whose CAR is `keyword' and CDR is a plist
2009 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2010 `:post-affiliated' keywords."
2025 :value value
2026 :begin begin
2027 :end end
2033 "Interpret KEYWORD element as Org syntax.
2034 CONTENTS is nil."
2040 ;;;; Latex Environment
2043 "Parse a LaTeX environment.
2045 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2046 the buffer position at the beginning of the first affiliated
2047 keyword and CDR is a plist of affiliated keywords along with
2048 their value.
2050 Return a list whose CAR is `latex-environment' and CDR is a plist
2051 containing `:begin', `:end', `:value', `:post-blank' and
2052 `:post-affiliated' keywords.
2054 Assume point is at the beginning of the latex environment."
2061 limit t))
2062 ;; Incomplete latex environment: parse it as a paragraph.
2073 :end end
2074 :value value
2080 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2081 CONTENTS is nil."
2085 ;;;; Node Property
2088 "Parse a node-property at point.
2090 LIMIT bounds the search.
2092 Return a list whose CAR is `node-property' and CDR is a plist
2093 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2094 keywords."
2106 :value value
2107 :begin begin
2108 :end end
2112 "Interpret NODE-PROPERTY element as Org syntax.
2113 CONTENTS is nil."
2119 ;;;; Paragraph
2122 "Parse a paragraph.
2124 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2125 the buffer position at the beginning of the first affiliated
2126 keyword and CDR is a plist of affiliated keywords along with
2127 their value.
2129 Return a list whose CAR is `paragraph' and CDR is a plist
2130 containing `:begin', `:end', `:contents-begin' and
2131 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2133 Assume point is at the beginning of the paragraph."
2142 limit
2143 ;; A matching `org-element-paragraph-separate' is not
2144 ;; necessarily the end of the paragraph. In
2145 ;; particular, lines starting with # or : as a first
2146 ;; non-space character are ambiguous. We have check
2147 ;; if they are valid Org syntax (i.e. not an
2148 ;; incomplete keyword).
2152 ;; There's no ambiguity for other symbols or
2153 ;; empty lines: stop here.
2155 ;; Stop at valid fixed-width areas.
2157 ;; Stop at drawers.
2162 ;; Stop at valid comments.
2164 ;; Stop at valid dynamic blocks.
2169 ;; Stop at valid blocks.
2176 limit t)))
2177 ;; Stop at valid latex environments.
2184 limit t)))
2185 ;; Stop at valid keywords.
2187 ;; Skip everything else.
2205 :end end
2206 :contents-begin contents-begin
2207 :contents-end contents-end
2213 "Interpret PARAGRAPH element as Org syntax.
2214 CONTENTS is the contents of the element."
2215 contents)
2218 ;;;; Planning
2221 "Parse a planning.
2223 LIMIT bounds the search.
2225 Return a list whose CAR is `planning' and CDR is a plist
2226 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2227 and `:post-blank' keywords."
2237 closed deadline scheduled)
2249 :deadline deadline
2250 :scheduled scheduled
2251 :begin begin
2252 :end end
2256 "Interpret PLANNING element as Org syntax.
2257 CONTENTS is nil."
2259 'identity
2276 ;;;; Quote Section
2279 "Parse a quote section.
2281 LIMIT bounds the search.
2283 Return a list whose CAR is `quote-section' and CDR is a plist
2284 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2286 Assume point is at beginning of the section."
2297 :end end
2298 :value value
2302 "Interpret QUOTE-SECTION element as Org syntax.
2303 CONTENTS is nil."
2307 ;;;; Src Block
2310 "Parse a src block.
2312 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2313 the buffer position at the beginning of the first affiliated
2314 keyword and CDR is a plist of affiliated keywords along with
2315 their value.
2317 Return a list whose CAR is `src-block' and CDR is a plist
2318 containing `:language', `:switches', `:parameters', `:begin',
2319 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2320 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2321 `:post-blank' and `:post-affiliated' keywords.
2323 Assume point is at the beginning of the block."
2326 limit t)))
2327 ;; Incomplete block: parse it as a paragraph.
2333 ;; Get language as a string.
2342 ;; Get switches.
2344 ;; Get parameters.
2346 ;; Switches analysis
2358 ;; Should labels be retained in (or stripped from)
2359 ;; src blocks?
2364 ;; What should code-references use - labels or
2365 ;; line-numbers?
2370 ;; Indentation.
2372 ;; Get visibility status.
2374 ;; Retrieve code.
2383 ;; Get position after ending blank lines.
2394 :begin begin
2395 :end end
2396 :number-lines number-lines
2397 :preserve-indent preserve-indent
2398 :retain-labels retain-labels
2399 :use-labels use-labels
2400 :label-fmt label-fmt
2401 :hiddenp hidden
2402 :value value
2408 "Interpret SRC-BLOCK element as Org syntax.
2409 CONTENTS is nil."
2430 ;;;; Table
2433 "Parse a table at point.
2435 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2436 the buffer position at the beginning of the first affiliated
2437 keyword and CDR is a plist of affiliated keywords along with
2438 their value.
2440 Return a list whose CAR is `table' and CDR is a plist containing
2441 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2442 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2443 keywords.
2445 Assume point is at the beginning of the table."
2459 acc))
2467 :end end
2468 :type type
2469 :tblfm tblfm
2470 ;; Only `org' tables have contents. `table.el' tables
2471 ;; use a `:value' property to store raw table as
2472 ;; a string.
2477 table-begin table-end))
2483 "Interpret TABLE element as Org syntax.
2484 CONTENTS is nil."
2495 ;;;; Table Row
2498 "Parse table row at point.
2500 LIMIT bounds the search.
2502 Return a list whose CAR is `table-row' and CDR is a plist
2503 containing `:begin', `:end', `:contents-begin', `:contents-end',
2504 `:type' and `:post-blank' keywords."
2508 ;; A table rule has no contents. In that case, ensure
2509 ;; CONTENTS-BEGIN matches CONTENTS-END.
2521 :begin begin
2522 :end end
2523 :contents-begin contents-begin
2524 :contents-end contents-end
2528 "Interpret TABLE-ROW element as Org syntax.
2529 CONTENTS is the contents of the table row."
2534 ;;;; Verse Block
2537 "Parse a verse block.
2539 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2540 the buffer position at the beginning of the first affiliated
2541 keyword and CDR is a plist of affiliated keywords along with
2542 their value.
2544 Return a list whose CAR is `verse-block' and CDR is a plist
2545 containing `:begin', `:end', `:contents-begin', `:contents-end',
2546 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2548 Assume point is at beginning of the block."
2552 ;; Incomplete block: parse it as a paragraph.
2569 :end end
2570 :contents-begin contents-begin
2571 :contents-end contents-end
2572 :hiddenp hidden
2578 "Interpret VERSE-BLOCK element as Org syntax.
2579 CONTENTS is verse block contents."
2583 \f
2584 ;;; Objects
2585 ;;
2586 ;; Unlike to elements, interstices can be found between objects.
2587 ;; That's why, along with the parser, successor functions are provided
2588 ;; for each object. Some objects share the same successor (i.e. `code'
2589 ;; and `verbatim' objects).
2590 ;;
2591 ;; A successor must accept a single argument bounding the search. It
2592 ;; will return either a cons cell whose CAR is the object's type, as
2593 ;; a symbol, and CDR the position of its next occurrence, or nil.
2594 ;;
2595 ;; Successors follow the naming convention:
2596 ;; org-element-NAME-successor, where NAME is the name of the
2597 ;; successor, as defined in `org-element-all-successors'.
2598 ;;
2599 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2600 ;; object types they can contain will be specified in
2601 ;; `org-element-object-restrictions'.
2602 ;;
2603 ;; Adding a new type of object is simple. Implement a successor,
2604 ;; a parser, and an interpreter for it, all following the naming
2605 ;; convention. Register type in `org-element-all-objects' and
2606 ;; successor in `org-element-all-successors'. Maybe tweak
2607 ;; restrictions about it, and that's it.
2610 ;;;; Bold
2613 "Parse bold object at point.
2615 Return a list whose CAR is `bold' and CDR is a plist with
2616 `:begin', `:end', `:contents-begin' and `:contents-end' and
2617 `:post-blank' keywords.
2619 Assume point is at the first star marker."
2631 :end end
2632 :contents-begin contents-begin
2633 :contents-end contents-end
2637 "Interpret BOLD object as Org syntax.
2638 CONTENTS is the contents of the object."
2642 "Search for the next text-markup object.
2644 LIMIT bounds the search.
2646 Return value is a cons cell whose CAR is a symbol among `bold',
2647 `italic', `underline', `strike-through', `code' and `verbatim'
2648 and CDR is beginning position."
2664 ;;;; Code
2667 "Parse code object at point.
2669 Return a list whose CAR is `code' and CDR is a plist with
2670 `:value', `:begin', `:end' and `:post-blank' keywords.
2672 Assume point is at the first tilde marker."
2683 :begin begin
2684 :end end
2688 "Interpret CODE object as Org syntax.
2689 CONTENTS is nil."
2693 ;;;; Entity
2696 "Parse entity at point.
2698 Return a list whose CAR is `entity' and CDR a plist with
2699 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2700 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2701 keywords.
2703 Assume point is at the beginning of the entity."
2705 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2721 :begin begin
2722 :end end
2723 :use-brackets-p bracketsp
2727 "Interpret ENTITY object as Org syntax.
2728 CONTENTS is nil."
2734 "Search for the next latex-fragment or entity object.
2736 LIMIT bounds the search.
2738 Return value is a cons cell whose CAR is `entity' or
2739 `latex-fragment' and CDR is beginning position."
2744 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2751 limit t)
2754 ;; Determine if it's a real entity or a LaTeX command.
2757 ;; No entity nor command: point is at a LaTeX fragment.
2758 ;; Determine its type to get the correct beginning position.
2766 matchers)
2770 ;;;; Export Snippet
2773 "Parse export snippet at point.
2775 Return a list whose CAR is `export-snippet' and CDR a plist with
2776 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2777 keywords.
2779 Assume point is at the beginning of the snippet."
2791 :value value
2792 :begin begin
2793 :end end
2797 "Interpret EXPORT-SNIPPET object as Org syntax.
2798 CONTENTS is nil."
2804 "Search for the next export-snippet object.
2806 LIMIT bounds the search.
2808 Return value is a cons cell whose CAR is `export-snippet' and CDR
2809 its beginning position."
2818 ;;;; Footnote Reference
2821 "Parse footnote reference at point.
2823 Return a list whose CAR is `footnote-reference' and CDR a plist
2824 with `:label', `:type', `:inline-definition', `:begin', `:end'
2825 and `:post-blank' as keywords."
2847 :type type
2848 :begin begin
2849 :end end
2852 footnote-reference :inline-definition
2857 footnote-reference))))))
2860 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2861 CONTENTS is nil."
2871 "Search for the next footnote-reference object.
2873 LIMIT bounds the search.
2875 Return value is a cons cell whose CAR is `footnote-reference' and
2876 CDR is beginning position."
2890 ;;;; Inline Babel Call
2893 "Parse inline babel call at point.
2895 Return a list whose CAR is `inline-babel-call' and CDR a plist
2896 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2898 Assume point is at the beginning of the babel call."
2909 :end end
2910 :info info
2914 "Interpret INLINE-BABEL-CALL object as Org syntax.
2915 CONTENTS is nil."
2921 ;; Remove redundant square brackets.
2924 main-source)
2928 "Search for the next inline-babel-call object.
2930 LIMIT bounds the search.
2932 Return value is a cons cell whose CAR is `inline-babel-call' and
2933 CDR is beginning position."
2935 ;; Use a simplified version of
2936 ;; `org-babel-inline-lob-one-liner-regexp'.
2939 limit t)
2943 ;;;; Inline Src Block
2946 "Parse inline source block at point.
2948 LIMIT bounds the search.
2950 Return a list whose CAR is `inline-src-block' and CDR a plist
2951 with `:begin', `:end', `:language', `:value', `:parameters' and
2952 `:post-blank' as keywords.
2954 Assume point is at the beginning of the inline src block."
2967 :value value
2968 :parameters parameters
2969 :begin begin
2970 :end end
2974 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2975 CONTENTS is nil."
2980 language
2982 body)))
2985 "Search for the next inline-babel-call element.
2987 LIMIT bounds the search.
2989 Return value is a cons cell whose CAR is `inline-babel-call' and
2990 CDR is beginning position."
2996 ;;;; Italic
2999 "Parse italic object at point.
3001 Return a list whose CAR is `italic' and CDR is a plist with
3002 `:begin', `:end', `:contents-begin' and `:contents-end' and
3003 `:post-blank' keywords.
3005 Assume point is at the first slash marker."
3017 :end end
3018 :contents-begin contents-begin
3019 :contents-end contents-end
3023 "Interpret ITALIC object as Org syntax.
3024 CONTENTS is the contents of the object."
3028 ;;;; Latex Fragment
3031 "Parse latex fragment at point.
3033 Return a list whose CAR is `latex-fragment' and CDR a plist with
3034 `:value', `:begin', `:end', and `:post-blank' as keywords.
3036 Assume point is at the beginning of the latex fragment."
3050 ;; None found: it's a macro.
3059 :begin begin
3060 :end end
3064 "Interpret LATEX-FRAGMENT object as Org syntax.
3065 CONTENTS is nil."
3068 ;;;; Line Break
3071 "Parse line break at point.
3073 Return a list whose CAR is `line-break', and CDR a plist with
3074 `:begin', `:end' and `:post-blank' keywords.
3076 Assume point is at the beginning of the line break."
3083 "Interpret LINE-BREAK object as Org syntax.
3084 CONTENTS is nil."
3088 "Search for the next line-break object.
3090 LIMIT bounds the search.
3092 Return value is a cons cell whose CAR is `line-break' and CDR is
3093 beginning position."
3097 ;; A line break can only happen on a non-empty line.
3102 ;;;; Link
3105 "Parse link at point.
3107 Return a list whose CAR is `link' and CDR a plist with `:type',
3108 `:path', `:raw-link', `:application', `:search-option', `:begin',
3109 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3110 keywords.
3112 Assume point is at the beginning of the link."
3115 end contents-begin contents-end link-end post-blank path type
3116 raw-link link search-option application)
3118 ;; Type 1: Text targeted from a radio target.
3123 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3128 ;; RAW-LINK is the original link. Expand any
3129 ;; abbreviation in it.
3134 ;; Determine TYPE of link and set PATH accordingly.
3136 ;; File type.
3139 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3142 ;; Id type: PATH is the id.
3145 ;; Code-ref type: PATH is the name of the reference.
3148 ;; Custom-id type: PATH is the name of the custom id.
3151 ;; Fuzzy type: Internal link either matches a target, an
3152 ;; headline name or nothing. PATH is the target or
3153 ;; headline's name.
3155 ;; Type 3: Plain link, i.e. http://orgmode.org
3161 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3168 ;; In any case, deduce end point after trailing white space from
3169 ;; LINK-END variable.
3172 ;; Extract search option and opening application out of
3173 ;; "file"-type links.
3175 ;; Application.
3180 ;; Extract search option from PATH.
3184 ;; Make sure TYPE always report "file".
3188 :path path
3190 :application application
3191 :search-option search-option
3192 :begin begin
3193 :end end
3194 :contents-begin contents-begin
3195 :contents-end contents-end
3199 "Interpret LINK object as Org syntax.
3200 CONTENTS is the contents of the object, or nil."
3205 raw-link
3209 "Search for the next link object.
3211 LIMIT bounds the search.
3213 Return value is a cons cell whose CAR is `link' and CDR is
3214 beginning position."
3223 "Search for the next plain link object.
3225 LIMIT bounds the search.
3227 Return value is a cons cell whose CAR is `link' and CDR is
3228 beginning position."
3233 ;;;; Macro
3236 "Parse macro at point.
3238 Return a list whose CAR is `macro' and CDR a plist with `:key',
3239 `:args', `:begin', `:end', `:value' and `:post-blank' as
3240 keywords.
3242 Assume point is at the macro."
3253 ;; Do not use `org-split-string' since empty
3254 ;; strings are meaningful here.
3262 args nil t)
3266 :value value
3267 :args args
3268 :begin begin
3269 :end end
3273 "Interpret MACRO object as Org syntax.
3274 CONTENTS is nil."
3278 "Search for the next macro object.
3280 LIMIT bounds the search.
3282 Return value is cons cell whose CAR is `macro' and CDR is
3283 beginning position."
3287 limit t)
3291 ;;;; Radio-target
3294 "Parse radio target at point.
3296 Return a list whose CAR is `radio-target' and CDR a plist with
3297 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3298 and `:post-blank' as keywords.
3300 Assume point is at the radio target."
3312 :end end
3313 :contents-begin contents-begin
3314 :contents-end contents-end
3315 :post-blank post-blank
3319 "Interpret TARGET object as Org syntax.
3320 CONTENTS is the contents of the object."
3324 "Search for the next radio-target object.
3326 LIMIT bounds the search.
3328 Return value is a cons cell whose CAR is `radio-target' and CDR
3329 is beginning position."
3335 ;;;; Statistics Cookie
3338 "Parse statistics cookie at point.
3340 Return a list whose CAR is `statistics-cookie', and CDR a plist
3341 with `:begin', `:end', `:value' and `:post-blank' keywords.
3343 Assume point is at the beginning of the statistics-cookie."
3354 :end end
3355 :value value
3359 "Interpret STATISTICS-COOKIE object as Org syntax.
3360 CONTENTS is nil."
3364 "Search for the next statistics cookie object.
3366 LIMIT bounds the search.
3368 Return value is a cons cell whose CAR is `statistics-cookie' and
3369 CDR is beginning position."
3375 ;;;; Strike-Through
3378 "Parse strike-through object at point.
3380 Return a list whose CAR is `strike-through' and CDR is a plist
3381 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3382 `:post-blank' keywords.
3384 Assume point is at the first plus sign marker."
3396 :end end
3397 :contents-begin contents-begin
3398 :contents-end contents-end
3402 "Interpret STRIKE-THROUGH object as Org syntax.
3403 CONTENTS is the contents of the object."
3407 ;;;; Subscript
3410 "Parse subscript at point.
3412 Return a list whose CAR is `subscript' and CDR a plist with
3413 `:begin', `:end', `:contents-begin', `:contents-end',
3414 `:use-brackets-p' and `:post-blank' as keywords.
3416 Assume point is at the underscore."
3420 t
3431 :end end
3432 :use-brackets-p bracketsp
3433 :contents-begin contents-begin
3434 :contents-end contents-end
3438 "Interpret SUBSCRIPT object as Org syntax.
3439 CONTENTS is the contents of the object."
3442 contents))
3445 "Search for the next sub/superscript object.
3447 LIMIT bounds the search.
3449 Return value is a cons cell whose CAR is either `subscript' or
3450 `superscript' and CDR is beginning position."
3458 ;;;; Superscript
3461 "Parse superscript at point.
3463 Return a list whose CAR is `superscript' and CDR a plist with
3464 `:begin', `:end', `:contents-begin', `:contents-end',
3465 `:use-brackets-p' and `:post-blank' as keywords.
3467 Assume point is at the caret."
3481 :end end
3482 :use-brackets-p bracketsp
3483 :contents-begin contents-begin
3484 :contents-end contents-end
3488 "Interpret SUPERSCRIPT object as Org syntax.
3489 CONTENTS is the contents of the object."
3492 contents))
3495 ;;;; Table Cell
3498 "Parse table cell at point.
3500 Return a list whose CAR is `table-cell' and CDR is a plist
3501 containing `:begin', `:end', `:contents-begin', `:contents-end'
3502 and `:post-blank' keywords."
3510 :end end
3511 :contents-begin contents-begin
3512 :contents-end contents-end
3516 "Interpret TABLE-CELL element as Org syntax.
3517 CONTENTS is the contents of the cell, or nil."
3521 "Search for the next table-cell object.
3523 LIMIT bounds the search.
3525 Return value is a cons cell whose CAR is `table-cell' and CDR is
3526 beginning position."
3530 ;;;; Target
3533 "Parse target at point.
3535 Return a list whose CAR is `target' and CDR a plist with
3536 `:begin', `:end', `:value' and `:post-blank' as keywords.
3538 Assume point is at the target."
3548 :end end
3549 :value value
3553 "Interpret TARGET object as Org syntax.
3554 CONTENTS is nil."
3558 "Search for the next target object.
3560 LIMIT bounds the search.
3562 Return value is a cons cell whose CAR is `target' and CDR is
3563 beginning position."
3569 ;;;; Timestamp
3572 "Parse time stamp at point.
3574 Return a list whose CAR is `timestamp', and CDR a plist with
3575 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3577 Assume point is at the beginning of the timestamp."
3595 date-start)
3606 raw-value)
3608 :repeater-type
3614 :repeater-unit
3617 year-start month-start day-start hour-start minute-start year-end
3618 month-end day-end hour-end minute-end)
3619 ;; Parse date-start.
3627 ;; Compute date-end. It can be provided directly in time-stamp,
3628 ;; or extracted from time range. Otherwise, it defaults to the
3629 ;; same values as date-start.
3639 :raw-value raw-value
3640 :year-start year-start
3641 :month-start month-start
3642 :day-start day-start
3643 :hour-start hour-start
3644 :minute-start minute-start
3645 :year-end year-end
3646 :month-end month-end
3647 :day-end day-end
3648 :hour-end hour-end
3649 :minute-end minute-end
3650 :begin begin
3651 :end end
3653 repeater-props)))))
3656 "Interpret TIMESTAMP object as Org syntax.
3657 CONTENTS is nil."
3658 ;; Use `:raw-value' if specified.
3660 ;; Otherwise, build timestamp string.
3670 ;; Build an Org timestamp string from TIME. ACTIVEP is
3671 ;; non-nil when time stamp is active. If WITH-TIME-P is
3672 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3673 ;; specify a time range in the timestamp. REPEAT-STRING
3674 ;; is the repeater string, if any.
3678 org-time-stamp-formats)
3679 time)))
3685 nil nil ts)))
3689 " "
3690 repeat-string
3692 ;; Return value.
3693 ts)))
3705 build-ts-string
3724 0
3732 "--"
3744 "Search for the next timestamp object.
3746 LIMIT bounds the search.
3748 Return value is a cons cell whose CAR is `timestamp' and CDR is
3749 beginning position."
3757 limit t)
3761 ;;;; Underline
3764 "Parse underline object at point.
3766 Return a list whose CAR is `underline' and CDR is a plist with
3767 `:begin', `:end', `:contents-begin' and `:contents-end' and
3768 `:post-blank' keywords.
3770 Assume point is at the first underscore marker."
3782 :end end
3783 :contents-begin contents-begin
3784 :contents-end contents-end
3788 "Interpret UNDERLINE object as Org syntax.
3789 CONTENTS is the contents of the object."
3793 ;;;; Verbatim
3796 "Parse verbatim object at point.
3798 Return a list whose CAR is `verbatim' and CDR is a plist with
3799 `:value', `:begin', `:end' and `:post-blank' keywords.
3801 Assume point is at the first equal sign marker."
3812 :begin begin
3813 :end end
3817 "Interpret VERBATIM object as Org syntax.
3818 CONTENTS is nil."
3822 \f
3823 ;;; Parsing Element Starting At Point
3824 ;;
3825 ;; `org-element--current-element' is the core function of this section.
3826 ;; It returns the Lisp representation of the element starting at
3827 ;; point.
3828 ;;
3829 ;; `org-element--current-element' makes use of special modes. They
3830 ;; are activated for fixed element chaining (i.e. `plain-list' >
3831 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3832 ;; `section'). Special modes are: `first-section', `item',
3833 ;; `node-property', `quote-section', `section' and `table-row'.
3837 "Parse the element starting at point.
3839 LIMIT bounds the search.
3841 Return value is a list like (TYPE PROPS) where TYPE is the type
3842 of the element and PROPS a plist of properties associated to the
3843 element.
3845 Possible types are defined in `org-element-all-elements'.
3847 Optional argument GRANULARITY determines the depth of the
3848 recursion. Allowed values are `headline', `greater-element',
3849 `element', `object' or nil. When it is broader than `object' (or
3850 nil), secondary values will not be parsed, since they only
3851 contain objects.
3853 Optional argument SPECIAL, when non-nil, can be either
3854 `first-section', `item', `node-property', `quote-section',
3855 `section', and `table-row'.
3857 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3858 be computed.
3860 This function assumes point is always at the beginning of the
3861 element it has to parse."
3864 ;; Determine if parsing depth allows for secondary strings
3865 ;; parsing. It only applies to elements referenced in
3866 ;; `org-element-secondary-value-alist'.
3869 ;; Item.
3872 ;; Table Row.
3874 ;; Node Property.
3876 ;; Headline.
3879 ;; Sections (must be checked after headline).
3885 limit)))
3886 ;; When not at bol, point is at the beginning of an item or
3887 ;; a footnote definition: next item is always a paragraph.
3889 ;; Planning and Clock.
3894 ;; Inlinetask.
3897 ;; From there, elements can have affiliated keywords.
3900 ;; Jumping over affiliated keywords put point off-limits.
3901 ;; Parse them as regular keywords.
3905 ;; LaTeX Environment.
3909 ;; Drawer and Property Drawer.
3914 ;; Fixed Width
3917 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3918 ;; Keywords.
3927 org-element-block-name-alist)))
3942 ;; Footnote Definition.
3945 ;; Horizontal Rule.
3948 ;; Diary Sexp.
3951 ;; Table.
3953 ;; List.
3956 limit affiliated
3958 ;; Default element: Paragraph.
3962 ;; Most elements can have affiliated keywords. When looking for an
3963 ;; element beginning, we want to move before them, as they belong to
3964 ;; that element, and, in the meantime, collect information they give
3965 ;; into appropriate properties. Hence the following function.
3968 "Collect affiliated keywords from point down to LIMIT.
3970 Return a list whose CAR is the position at the first of them and
3971 CDR a plist of keywords and values and move point to the
3972 beginning of the first line after them.
3974 As a special case, if element doesn't start at the beginning of
3975 the line (i.e. a paragraph starting an item), CAR is current
3976 position of point and CDR is nil."
3980 ;; RESTRICT is the list of objects allowed in parsed
3981 ;; keywords value.
3983 output)
3986 ;; Apply translation to RAW-KWD. From there, KWD is
3987 ;; the official keyword.
3989 org-element-keyword-translation-alist))
3990 raw-kwd))
3991 ;; Find main value for any keyword.
3997 ;; PARSEDP is non-nil when keyword should have its
3998 ;; value parsed.
4000 ;; If KWD is a dual keyword, find its secondary
4001 ;; value. Maybe parse it.
4008 ;; Attribute a property name to KWD.
4010 ;; Now set final shape for VALUE.
4016 ;; Attributes can always appear on multiple lines.
4019 ;; Eventually store the new value in OUTPUT.
4021 ;; Move to next keyword.
4023 ;; If affiliated keywords are orphaned: move back to first one.
4024 ;; They will be parsed as a paragraph.
4026 ;; Return value.
4030 \f
4031 ;;; The Org Parser
4032 ;;
4033 ;; The two major functions here are `org-element-parse-buffer', which
4034 ;; parses Org syntax inside the current buffer, taking into account
4035 ;; region, narrowing, or even visibility if specified, and
4036 ;; `org-element-parse-secondary-string', which parses objects within
4037 ;; a given string.
4038 ;;
4039 ;; The (almost) almighty `org-element-map' allows to apply a function
4040 ;; on elements or objects matching some type, and accumulate the
4041 ;; resulting values. In an export situation, it also skips unneeded
4042 ;; parts of the parse tree.
4045 "Recursively parse the buffer and return structure.
4046 If narrowing is in effect, only parse the visible part of the
4047 buffer.
4049 Optional argument GRANULARITY determines the depth of the
4050 recursion. It can be set to the following symbols:
4052 `headline' Only parse headlines.
4053 `greater-element' Don't recurse into greater elements excepted
4054 headlines and sections. Thus, elements
4055 parsed are the top-level ones.
4056 `element' Parse everything but objects and plain text.
4057 `object' Parse the complete buffer (default).
4059 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4060 elements.
4062 An element or an objects is represented as a list with the
4063 pattern (TYPE PROPERTIES CONTENTS), where :
4065 TYPE is a symbol describing the element or object. See
4066 `org-element-all-elements' and `org-element-all-objects' for an
4067 exhaustive list of such symbols. One can retrieve it with
4068 `org-element-type' function.
4070 PROPERTIES is the list of attributes attached to the element or
4071 object, as a plist. Although most of them are specific to the
4072 element or object type, all types share `:begin', `:end',
4073 `:post-blank' and `:parent' properties, which respectively
4074 refer to buffer position where the element or object starts,
4075 ends, the number of white spaces or blank lines after it, and
4076 the element or object containing it. Properties values can be
4077 obtained by using `org-element-property' function.
4079 CONTENTS is a list of elements, objects or raw strings
4080 contained in the current element or object, when applicable.
4081 One can access them with `org-element-contents' function.
4083 The Org buffer has `org-data' as type and nil as properties.
4084 `org-element-map' function can be used to find specific elements
4085 or objects within the parse tree.
4087 This function assumes that current major mode is `org-mode'."
4093 ;; Start in `first-section' mode so text before the first
4094 ;; headline belongs to a section.
4098 "Recursively parse objects in STRING and return structure.
4100 RESTRICTION is a symbol limiting the object types that will be
4101 looked after.
4103 Optional argument PARENT, when non-nil, is the element or object
4104 containing the secondary string. It is used to set correctly
4105 `:parent' property within the string."
4106 ;; Copy buffer-local variables listed in
4107 ;; `org-element-object-variables' into temporary buffer. This is
4108 ;; required since object parsing is dependent on these variables.
4112 org-element-object-variables))))
4120 secondary))
4121 secondary))))
4125 "Map a function on selected elements or objects.
4127 DATA is a parse tree, an element, an object, a string, or a list
4128 of such constructs. TYPES is a symbol or list of symbols of
4129 elements or objects types (see `org-element-all-elements' and
4130 `org-element-all-objects' for a complete list of types). FUN is
4131 the function called on the matching element or object. It has to
4132 accept one argument: the element or object itself.
4134 When optional argument INFO is non-nil, it should be a plist
4135 holding export options. In that case, parts of the parse tree
4136 not exportable according to that property list will be skipped.
4138 When optional argument FIRST-MATCH is non-nil, stop at the first
4139 match for which FUN doesn't return nil, and return that value.
4141 Optional argument NO-RECURSION is a symbol or a list of symbols
4142 representing elements or objects types. `org-element-map' won't
4143 enter any recursive element or object whose type belongs to that
4144 list. Though, FUN can still be applied on them.
4146 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4147 apply to matching objects within parsed affiliated keywords (see
4148 `org-element-parsed-keywords').
4150 Nil values returned from FUN do not appear in the results.
4153 Examples:
4154 ---------
4156 Assuming TREE is a variable containing an Org buffer parse tree,
4157 the following example will return a flat list of all `src-block'
4158 and `example-block' elements in it:
4160 \(org-element-map tree '(example-block src-block) 'identity)
4162 The following snippet will find the first headline with a level
4165 \(org-element-map tree 'headline
4166 \(lambda (hl)
4167 \(and (= (org-element-property :level hl) 1)
4169 \(org-element-property :begin hl)))
4170 nil t)
4172 The next example will return a flat list of all `plain-list' type
4173 elements in TREE that are not a sub-list themselves:
4175 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4177 Eventually, this example will return a flat list of all `bold'
4178 type objects containing a `latex-snippet' type object, even
4179 looking into captions:
4181 \(org-element-map tree 'bold
4182 \(lambda (b)
4183 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4184 nil nil nil t)"
4185 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4188 ;; Recursion depth is determined by --CATEGORY.
4195 ;; If one object is found, the function
4196 ;; has to recurse into every object.
4199 ;; If one regular element is found, the
4200 ;; function has to recurse, at least,
4201 ;; into every element it encounters.
4204 types)
4205 category)))
4206 ;; Compute properties for affiliated keywords if necessary.
4211 org-element-affiliated-keywords)))
4212 --acc
4213 --walk-tree
4217 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4218 ;; holding contextual information.
4222 ;; Ignored element in an export context.
4224 ;; List of elements or objects.
4226 ;; Unconditionally enter parse trees.
4230 ;; Check if TYPE is matching among TYPES. If so,
4231 ;; apply FUN to --DATA and accumulate return value
4232 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4238 ;; If --DATA has a secondary string that can contain
4239 ;; objects with their type among TYPES, look into it.
4246 ;; If --DATA has any affiliated keywords and
4247 ;; WITH-AFFILIATED is non-nil, look for objects in
4248 ;; them.
4256 ;; Pay attention to the type of value.
4257 ;; Preserve order for multiple keywords.
4273 --affiliated-alist))
4274 ;; Determine if a recursion into --DATA is possible.
4276 ;; --TYPE is explicitly removed from recursion.
4278 ;; --DATA has no contents.
4280 ;; Looking for greater elements but --DATA is simply
4281 ;; an element or an object.
4284 ;; Looking for elements but --DATA is an object.
4287 ;; In any other case, map contents.
4291 ;; Return value in a proper order.
4295 ;; The following functions are internal parts of the parser.
4296 ;;
4297 ;; The first one, `org-element--parse-elements' acts at the element's
4298 ;; level.
4299 ;;
4300 ;; The second one, `org-element--parse-objects' applies on all objects
4301 ;; of a paragraph or a secondary string. It uses
4302 ;; `org-element--get-next-object-candidates' to optimize the search of
4303 ;; the next object in the buffer.
4304 ;;
4305 ;; More precisely, that function looks for every allowed object type
4306 ;; first. Then, it discards failed searches, keeps further matches,
4307 ;; and searches again types matched behind point, for subsequent
4308 ;; calls. Thus, searching for a given type fails only once, and every
4309 ;; object is searched only once at top level (but sometimes more for
4310 ;; nested types).
4314 "Parse elements between BEG and END positions.
4316 SPECIAL prioritize some elements over the others. It can be set
4317 to `first-section', `quote-section', `section' `item' or
4318 `table-row'.
4320 When value is `item', STRUCTURE will be used as the current list
4321 structure.
4323 GRANULARITY determines the depth of the recursion. See
4324 `org-element-parse-buffer' for more information.
4326 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4327 elements.
4329 Elements are accumulated into ACC."
4332 ;; Visible only: skip invisible parts at the beginning of the
4333 ;; element.
4336 ;; When parsing only headlines, skip any text before first one.
4339 ;; Main loop start.
4341 ;; Find current element's type and parse it accordingly to
4342 ;; its category.
4344 end granularity special structure))
4348 ;; Visible only: skip invisible parts between siblings.
4351 ;; Fill ELEMENT contents by side-effect.
4353 ;; If element has no contents, don't modify it.
4355 ;; Greater element: parse it between `contents-begin' and
4356 ;; `contents-end'. Make sure GRANULARITY allows the
4357 ;; recursion, or ELEMENT is a headline, in which case going
4358 ;; inside is mandatory, in order to get sub-level headings.
4366 ;; Possibly switch to a special mode.
4376 granularity visible-only element))
4377 ;; ELEMENT has contents. Parse objects inside, if
4378 ;; GRANULARITY allows it.
4384 ;; Return result.
4385 acc))
4388 "Parse objects between BEG and END and return recursive structure.
4390 Objects are accumulated in ACC.
4392 RESTRICTION is a list of object successors which are allowed in
4393 the current object."
4399 end restriction candidates)))
4406 ;; 1. Text before any object. Untabify it.
4411 acc
4415 ;; 2. Object...
4418 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4419 ;; a recursive type.
4424 cont-beg
4431 ;; 3. Text after last object. Untabify it.
4435 acc
4439 ;; Result.
4440 acc)))
4443 "Return an alist of candidates for the next object.
4445 LIMIT bounds the search, and RESTRICTION narrows candidates to
4446 some object successors.
4448 OBJECTS is the previous candidates alist. If it is set to
4449 `initial', no search has been done before, and all symbols in
4450 RESTRICTION should be looked after.
4452 Return value is an alist whose CAR is the object type and CDR its
4453 beginning position."
4455 nil
4457 ;; When searching for the first time, look for every successor
4458 ;; allowed in RESTRICTION.
4462 restriction)
4463 ;; Focus on objects returned during last search. Keep those
4464 ;; still after point. Search again objects before it.
4470 type)))
4473 limit)))))
4474 objects))))
4477 \f
4478 ;;; Towards A Bijective Process
4479 ;;
4480 ;; The parse tree obtained with `org-element-parse-buffer' is really
4481 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4482 ;; interpreted and expanded into a string with canonical Org syntax.
4483 ;; Hence `org-element-interpret-data'.
4484 ;;
4485 ;; The function relies internally on
4486 ;; `org-element--interpret-affiliated-keywords'.
4488 ;;;###autoload
4490 "Interpret DATA as Org syntax.
4492 DATA is a parse tree, an element, an object or a secondary string
4493 to interpret.
4495 Optional argument PARENT is used for recursive calls. It contains
4496 the element or object containing data, or nil.
4498 Return Org syntax as a string."
4502 ;; Secondary string.
4507 ;; Full Org document.
4512 ;; Plain text: remove `:parent' text property from output.
4514 ;; Element/Object without contents.
4517 data nil))
4518 ;; Element/Object with contents.
4528 ;; Elements directly containing objects must
4529 ;; have their indentation normalized first.
4531 data
4532 ;; When normalizing first paragraph of an
4533 ;; item or a footnote-definition, ignore
4534 ;; first line's indentation.
4541 data
4543 contents)))))))
4545 ;; Build white spaces. If no `:post-blank' property is
4546 ;; specified, assume its value is 0.
4556 "Return ELEMENT's affiliated keywords as Org syntax.
4557 If there is no affiliated keyword, return the empty string."
4567 ": "
4570 value)
4578 ;; All attribute keywords can have multiple lines.
4584 ;; List all ELEMENT's properties matching an attribute line or an
4585 ;; affiliated keyword, but ignore translated keywords since they
4586 ;; cannot belong to the property list.
4593 org-element-keyword-translation-alist)))))
4594 collect prop)
4597 ;; Because interpretation of the parse tree must return the same
4598 ;; number of blank lines between elements and the same number of white
4599 ;; space after objects, some special care must be given to white
4600 ;; spaces.
4601 ;;
4602 ;; The first function, `org-element-normalize-string', ensures any
4603 ;; string different from the empty string will end with a single
4604 ;; newline character.
4605 ;;
4606 ;; The second function, `org-element-normalize-contents', removes
4607 ;; global indentation from the contents of the current element.
4610 "Ensure string S ends with a single newline character.
4612 If S isn't a string return it unchanged. If S is the empty
4613 string, return it. Otherwise, return a new string with a single
4614 newline character at its end."
4622 "Normalize plain text in ELEMENT's contents.
4624 ELEMENT must only contain plain text and objects.
4626 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4627 indentation to compute maximal common indentation.
4629 Return the normalized element that is element with global
4630 indentation removed from its contents. The function assumes that
4631 indentation is not done with TAB characters."
4633 collect-inds ; for byte-compiler
4636 ;; Return list of indentations within BLOB. This is done by
4637 ;; walking recursively BLOB and updating IND-LIST along the
4638 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4639 ;; been seen yet. It is required as this string is the only
4640 ;; one whose indentation doesn't happen after a newline
4641 ;; character.
4649 ;; An indentation of zero means no string will be
4650 ;; modified. Quit the process.
4656 ;; Avoid matching blank or empty lines.
4664 ;; Collect indentation list in ELEMENT. Possibly remove first
4665 ;; value if IGNORE-FIRST is non-nil.
4668 ;; Build ELEMENT back, replacing each string with the same
4669 ;; string minus common indentation.
4674 ;; Return BLOB with all its strings indentation
4675 ;; shortened from MCI white spaces. FIRST-FLAG is
4676 ;; non-nil when the first string hasn't been seen
4677 ;; yet.
4691 org-element-recursive-objects)
4695 blob))))
4699 \f
4700 ;;; The Toolbox
4701 ;;
4702 ;; The first move is to implement a way to obtain the smallest element
4703 ;; containing point. This is the job of `org-element-at-point'. It
4704 ;; basically jumps back to the beginning of section containing point
4705 ;; and moves, element after element, with
4706 ;; `org-element--current-element' until the container is found. Note:
4707 ;; When using `org-element-at-point', secondary values are never
4708 ;; parsed since the function focuses on elements, not on objects.
4709 ;;
4710 ;; At a deeper level, `org-element-context' lists all elements and
4711 ;; objects containing point.
4712 ;;
4713 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4714 ;; internally by navigation and manipulation tools.
4716 ;;;###autoload
4718 "Determine closest element around point.
4720 Return value is a list like (TYPE PROPS) where TYPE is the type
4721 of the element and PROPS a plist of properties associated to the
4722 element.
4724 Possible types are defined in `org-element-all-elements'.
4725 Properties depend on element or object type, but always include
4726 `:begin', `:end', `:parent' and `:post-blank' properties.
4728 As a special case, if point is at the very beginning of a list or
4729 sub-list, returned element will be that list instead of the first
4730 item. In the same way, if point is at the beginning of the first
4731 row of a table, returned element will be the table instead of the
4732 first row.
4734 If optional argument KEEP-TRAIL is non-nil, the function returns
4735 a list of elements leading to element at point. The list's CAR
4736 is always the element at point. The following positions contain
4737 element's siblings, then parents, siblings of parents, until the
4738 first element of current section."
4740 ;; If at a headline, parse it. It is the sole element that
4741 ;; doesn't require to know about context. Be sure to disallow
4742 ;; secondary string parsing, though.
4748 ;; Otherwise move at the beginning of the section containing
4749 ;; point.
4754 element type special-flag trail struct prevs parent)
4757 ;; In empty lines at buffer's beginning, return nil.
4766 ;; In blank lines just after the headline, point still
4767 ;; belongs to the headline.
4775 ;; Parse successively each element, skipping those ending
4776 ;; before original position.
4784 ;; 1. Skip any element ending before point. Also skip
4785 ;; element ending at point when we're sure that another
4786 ;; element has started.
4791 ;; 2. An element containing point is always the element at
4792 ;; point.
4795 ;; 3. At any other greater element type, if point is
4796 ;; within contents, move into it.
4801 ;; Create an anchor for tables and plain lists:
4802 ;; when point is at the very beginning of these
4803 ;; elements, ignoring affiliated keywords,
4804 ;; target them instead of their contents.
4806 ;; When point is at contents end, do not move
4807 ;; into elements with an explicit ending, but
4808 ;; return that element instead.
4812 drawer dynamic-block inlinetask item
4813 plain-list property-drawer quote-block
4814 special-block))))
4829 ;;;###autoload
4831 "Return closest element or object around point.
4833 Return value is a list like (TYPE PROPS) where TYPE is the type
4834 of the element or object and PROPS a plist of properties
4835 associated to it.
4837 Possible types are defined in `org-element-all-elements' and
4838 `org-element-all-objects'. Properties depend on element or
4839 object type, but always include `:begin', `:end', `:parent' and
4840 `:post-blank'.
4842 Optional argument ELEMENT, when non-nil, is the closest element
4843 containing point, as returned by `org-element-at-point'.
4844 Providing it allows for quicker computation."
4849 end)
4850 ;; Check if point is inside an element containing objects or at
4851 ;; a secondary string. In that case, move to beginning of the
4852 ;; element or secondary string and set END to the other side.
4859 org-element-parsed-keywords))
4860 ;; We're at an affiliated keyword. Change
4861 ;; type to retrieve correct restrictions.
4863 ;; Determine if we're at main or dual value.
4877 (<= origin
4878 ;; `1+' is required so some
4879 ;; successors can match
4880 ;; properly their object.
4902 element
4908 end restriction candidates))
4910 candidates)))
4911 ;; If ORIGIN is before next object in element, there's
4912 ;; no point in looking further.
4922 ;; ORIGIN is after OBJECT, so skip it.
4928 ;; ORIGIN is within a non-recursive object or at
4929 ;; an object boundaries: Return that object.
4933 ;; Otherwise, move within current object and
4934 ;; restrict search to the end of its contents.
4939 candidates 'initial
4940 end cend)))))))
4941 parent))))))
4944 "Non-nil when elements ELEM-A and ELEM-B are nested."
4953 "Swap elements ELEM-A and ELEM-B.
4954 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4955 end of ELEM-A."
4957 ;; There are two special cases when an element doesn't start at bol:
4958 ;; the first paragraph in an item or in a footnote definition.
4960 ;; Only a paragraph without any affiliated keyword can be moved at
4961 ;; ELEM-A position in such a situation. Note that the case of
4962 ;; a footnote definition is impossible: it cannot contain two
4963 ;; paragraphs in a row because it cannot contain a blank line.
4969 ;; In a special situation, ELEM-A will have no indentation. We'll
4970 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4984 ;; Store overlays responsible for visibility status. We
4985 ;; also need to store their boundaries as they will be
4986 ;; removed from buffer.
4993 ;; Get contents.
5001 ;; Restore ex ELEM-A overlays.
5010 ;; Restore ex ELEM-B overlays.
5019 ;; Local variables:
5020 ;; generated-autoload-file: "org-loaddefs.el"
5021 ;; End:
5023 ;;; org-element.el ends here