| blob | e078d9f12539d4d21c94f9304a5a30c5270caedf |
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."
700 :begin begin
701 :end end
702 :contents-begin contents-begin
703 :contents-end contents-end
709 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
710 CONTENTS is the contents of the footnote-definition."
712 " "
713 contents))
716 ;;;; Headline
719 "Parse a headline.
721 Return a list whose CAR is `headline' and CDR is a plist
722 containing `:raw-value', `:title', `:alt-title', `:begin',
723 `:end', `:pre-blank', `:hiddenp', `:contents-begin' and
724 `:contents-end', `:level', `:priority', `:tags',
725 `:todo-keyword',`:todo-type', `:scheduled', `:deadline',
726 `:closed', `:quotedp', `:archivedp', `:commentedp' and
727 `:footnote-section-p' keywords.
729 The plist also contains any property set in the property drawer,
730 with its name in upper cases and colons added at the
731 beginning (i.e. `:CUSTOM_ID').
733 When RAW-SECONDARY-P is non-nil, headline's title will not be
734 parsed as a secondary string, but as a plain string instead.
736 Assume point is at beginning of the headline."
749 raw-value)))
753 raw-value)))
757 ;; Upcase property names. It avoids confusion between
758 ;; properties obtained through property drawer and default
759 ;; properties from the parser (e.g. `:end' and :END:)
769 plist))
771 ;; Read time properties on the line below the headline.
777 org-keyword-time-not-clock-regexp end t)
787 plist))))
800 ;; Clean RAW-VALUE from any quote or comment string.
808 ""
809 raw-value))))
810 ;; Clean TAGS from archive tag, if any.
816 :begin begin
817 :end end
818 :pre-blank
821 :hiddenp hidden
822 :contents-begin contents-begin
823 :contents-end contents-end
824 :level level
826 :tags tags
827 :todo-keyword todo
828 :todo-type todo-type
834 end)
835 :footnote-section-p footnote-section-p
836 :archivedp archivedp
837 :commentedp commentedp
839 time-props
840 standard-props))))
844 headline :alt-title
849 headline :title
855 "Interpret HEADLINE element as Org syntax.
856 CONTENTS is the contents of the element."
883 ;; Align tags.
891 ? )
892 tags))
896 tags))))
898 contents)))
901 ;;;; Inlinetask
904 "Parse an inline task.
906 Return a list whose CAR is `inlinetask' and CDR is a plist
907 containing `:title', `:begin', `:end', `:hiddenp',
908 `:contents-begin' and `:contents-end', `:level', `:priority',
909 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
910 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
912 The plist also contains any property set in the property drawer,
913 with its name in upper cases and colons added at the
914 beginning (i.e. `:CUSTOM_ID').
916 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
917 title will not be parsed as a secondary string, but as a plain
918 string instead.
920 Assume point is at beginning of the inline task."
930 ;; Upcase property names. It avoids confusion between
931 ;; properties obtained through property drawer and default
932 ;; properties from the parser (e.g. `:end' and :END:)
942 plist))
944 ;; Read time properties on the line below the inlinetask
945 ;; opening string.
951 org-keyword-time-not-clock-regexp end t)
961 plist))))
981 :begin begin
982 :end end
983 :hiddenp hidden
984 :contents-begin contents-begin
985 :contents-end contents-end
988 :tags tags
989 :todo-keyword todo
990 :todo-type todo-type
992 time-props
993 standard-props))))
995 inlinetask :title
998 raw-value
1000 inlinetask))))))
1003 "Interpret INLINETASK element as Org syntax.
1004 CONTENTS is the contents of inlinetask."
1019 ;; Align tags.
1027 ? )
1028 tags))
1032 tags))))
1033 ;; Prefer degenerate inlinetasks when there are no
1034 ;; contents.
1037 contents
1041 ;;;; Item
1044 "Parse an item.
1046 STRUCT is the structure of the plain list.
1048 Return a list whose CAR is `item' and CDR is a plist containing
1049 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1050 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1051 `:post-blank' keywords.
1053 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1054 any, will not be parsed as a secondary string, but as a plain
1055 string instead.
1057 Assume point is at the beginning of the item."
1081 ;; Ignore tags in un-ordered lists: they are just
1082 ;; a part of item's body.
1088 ;; If first line isn't empty, contents really start
1089 ;; at the text after item's meta-data.
1100 :begin begin
1101 :end end
1102 ;; CONTENTS-BEGIN and CONTENTS-END may be
1103 ;; mixed up in the case of an empty item
1104 ;; separated from the next by a blank line.
1105 ;; Thus ensure the former is always the
1106 ;; smallest.
1109 :checkbox checkbox
1110 :counter counter
1111 :hiddenp hidden
1112 :structure struct
1115 item :tag
1123 "Interpret ITEM element as Org syntax.
1124 CONTENTS is the contents of the element."
1134 ;; Compute indentation.
1139 ;; Indent contents.
1141 bullet
1155 ;;;; Plain List
1158 ;; Return structure of list at point. Internal function. See
1159 ;; `org-list-struct' for details.
1167 items struct)
1172 ;; At limit: end all items.
1181 ;; At list end: end all items.
1186 ;; At a new item: end previous sibling.
1198 ind
1199 bullet
1202 ;; Description tag.
1206 ;; Ending position, unknown so far.
1207 nil)))
1208 items))
1210 ;; Skip empty lines.
1212 ;; Skip inline tasks and blank lines along the way.
1219 ;; At some text line. Check if it ends any previous item.
1231 ;; Skip blocks (any type) and drawers contents.
1236 limit t)))
1242 "Parse a plain list.
1244 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1245 the buffer position at the beginning of the first affiliated
1246 keyword and CDR is a plist of affiliated keywords along with
1247 their value. STRUCTURE is the structure of the plain list being
1248 parsed.
1250 Return a list whose CAR is `plain-list' and CDR is a plist
1251 containing `:type', `:begin', `:end', `:contents-begin' and
1252 `:contents-end', `:structure', `:post-blank' and
1253 `:post-affiliated' keywords.
1255 Assume point is at the beginning of the list."
1268 ;; Return value.
1272 :begin begin
1273 :end end
1274 :contents-begin contents-begin
1275 :contents-end contents-end
1276 :structure struct
1282 "Interpret PLAIN-LIST element as Org syntax.
1283 CONTENTS is the contents of the element."
1291 ;;;; Property Drawer
1294 "Parse a property drawer.
1296 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1297 the buffer position at the beginning of the first affiliated
1298 keyword and CDR is a plist of affiliated keywords along with
1299 their value.
1301 Return a list whose CAR is `property-drawer' and CDR is a plist
1302 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1303 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1305 Assume point is at the beginning of the property drawer."
1310 ;; Incomplete drawer: parse it as a paragraph.
1330 :end end
1331 :hiddenp hidden
1332 :contents-begin contents-begin
1333 :contents-end contents-end
1339 "Interpret PROPERTY-DRAWER element as Org syntax.
1340 CONTENTS is the properties within the drawer."
1344 ;;;; Quote Block
1347 "Parse a quote block.
1349 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1350 the buffer position at the beginning of the first affiliated
1351 keyword and CDR is a plist of affiliated keywords along with
1352 their value.
1354 Return a list whose CAR is `quote-block' and CDR is a plist
1355 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1356 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1358 Assume point is at the beginning of the block."
1362 ;; Incomplete block: parse it as a paragraph.
1368 ;; Empty blocks have no contents.
1383 :end end
1384 :hiddenp hidden
1385 :contents-begin contents-begin
1386 :contents-end contents-end
1392 "Interpret QUOTE-BLOCK element as Org syntax.
1393 CONTENTS is the contents of the element."
1397 ;;;; Section
1400 "Parse a section.
1402 LIMIT bounds the search.
1404 Return a list whose CAR is `section' and CDR is a plist
1405 containing `:begin', `:end', `:contents-begin', `contents-end'
1406 and `:post-blank' keywords."
1408 ;; Beginning of section is the beginning of the first non-blank
1409 ;; line after previous headline.
1418 :end end
1419 :contents-begin begin
1420 :contents-end pos-before-blank
1424 "Interpret SECTION element as Org syntax.
1425 CONTENTS is the contents of the element."
1426 contents)
1429 ;;;; Special Block
1432 "Parse a special block.
1434 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1435 the buffer position at the beginning of the first affiliated
1436 keyword and CDR is a plist of affiliated keywords along with
1437 their value.
1439 Return a list whose CAR is `special-block' and CDR is a plist
1440 containing `:type', `:begin', `:end', `:hiddenp',
1441 `:contents-begin', `:contents-end', `:post-blank' and
1442 `:post-affiliated' keywords.
1444 Assume point is at the beginning of the block."
1451 limit t)))
1452 ;; Incomplete block: parse it as a paragraph.
1458 ;; Empty blocks have no contents.
1473 :begin begin
1474 :end end
1475 :hiddenp hidden
1476 :contents-begin contents-begin
1477 :contents-end contents-end
1483 "Interpret SPECIAL-BLOCK element as Org syntax.
1484 CONTENTS is the contents of the element."
1489 \f
1490 ;;; Elements
1491 ;;
1492 ;; For each element, a parser and an interpreter are also defined.
1493 ;; Both follow the same naming convention used for greater elements.
1494 ;;
1495 ;; Also, as for greater elements, adding a new element type is done
1496 ;; through the following steps: implement a parser and an interpreter,
1497 ;; tweak `org-element--current-element' so that it recognizes the new
1498 ;; type and add that new type to `org-element-all-elements'.
1499 ;;
1500 ;; As a special case, when the newly defined type is a block type,
1501 ;; `org-element-block-name-alist' has to be modified accordingly.
1504 ;;;; Babel Call
1507 "Parse a babel call.
1509 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1510 the buffer position at the beginning of the first affiliated
1511 keyword and CDR is a plist of affiliated keywords along with
1512 their value.
1514 Return a list whose CAR is `babel-call' and CDR is a plist
1515 containing `:begin', `:end', `:info', `:post-blank' and
1516 `:post-affiliated' as keywords."
1530 :end end
1531 :info info
1537 "Interpret BABEL-CALL element as Org syntax.
1538 CONTENTS is nil."
1544 ;; Remove redundant square brackets.
1549 ;;;; Clock
1552 "Parse a clock.
1554 LIMIT bounds the search.
1556 Return a list whose CAR is `clock' and CDR is a plist containing
1557 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1558 as keywords."
1578 :value value
1579 :duration duration
1580 :begin begin
1581 :end end
1585 "Interpret CLOCK element as Org syntax.
1586 CONTENTS is nil."
1594 "%2s:%02s"
1598 ;;;; Comment
1601 "Parse a comment.
1603 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1604 the buffer position at the beginning of the first affiliated
1605 keyword and CDR is a plist of affiliated keywords along with
1606 their value.
1608 Return a list whose CAR is `comment' and CDR is a plist
1609 containing `:begin', `:end', `:value', `:post-blank',
1610 `:post-affiliated' keywords.
1612 Assume point is at comment beginning."
1621 ;; Get comments ending.
1624 ;; Accumulate lines without leading hash and first
1625 ;; whitespace.
1640 :end end
1641 :value value
1647 "Interpret COMMENT element as Org syntax.
1648 CONTENTS is nil."
1652 ;;;; Comment Block
1655 "Parse an export block.
1657 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1658 the buffer position at the beginning of the first affiliated
1659 keyword and CDR is a plist of affiliated keywords along with
1660 their value.
1662 Return a list whose CAR is `comment-block' and CDR is a plist
1663 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1664 and `:post-affiliated' keywords.
1666 Assume point is at comment block beginning."
1670 ;; Incomplete block: parse it as a paragraph.
1685 contents-begin contents-end)))
1689 :end end
1690 :value value
1691 :hiddenp hidden
1697 "Interpret COMMENT-BLOCK element as Org syntax.
1698 CONTENTS is nil."
1703 ;;;; Diary Sexp
1706 "Parse a diary sexp.
1708 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1709 the buffer position at the beginning of the first affiliated
1710 keyword and CDR is a plist of affiliated keywords along with
1711 their value.
1713 Return a list whose CAR is `diary-sexp' and CDR is a plist
1714 containing `:begin', `:end', `:value', `:post-blank' and
1715 `:post-affiliated' keywords."
1728 :begin begin
1729 :end end
1735 "Interpret DIARY-SEXP as Org syntax.
1736 CONTENTS is nil."
1740 ;;;; Example Block
1743 "Remove maximum common indentation in string S and return it.
1744 When optional argument N is a positive integer, remove exactly
1745 that much characters from indentation, if possible, or return
1746 S as-is otherwise. Unlike to `org-remove-indentation', this
1747 function doesn't call `untabify' on S."
1752 ;; Find maximum common indentation, if not specified.
1760 min-ind)))
1762 ;; Remove exactly N indentation, but give up if not possible.
1772 "Parse an example block.
1774 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1775 the buffer position at the beginning of the first affiliated
1776 keyword and CDR is a plist of affiliated keywords along with
1777 their value.
1779 Return a list whose CAR is `example-block' and CDR is a plist
1780 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1781 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1782 `:switches', `:value', `:post-blank' and `:post-affiliated'
1783 keywords."
1787 ;; Incomplete block: parse it as a paragraph.
1795 ;; Switches analysis
1803 ;; Should labels be retained in (or stripped from) example
1804 ;; blocks?
1809 ;; What should code-references use - labels or
1810 ;; line-numbers?
1819 ;; Standard block parsing.
1828 contents-begin contents-end))
1839 :end end
1840 :value value
1841 :switches switches
1842 :number-lines number-lines
1843 :preserve-indent preserve-indent
1844 :retain-labels retain-labels
1845 :use-labels use-labels
1846 :label-fmt label-fmt
1847 :hiddenp hidden
1853 "Interpret EXAMPLE-BLOCK element as Org syntax.
1854 CONTENTS is nil."
1862 ;;;; Export Block
1865 "Parse an export block.
1867 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1868 the buffer position at the beginning of the first affiliated
1869 keyword and CDR is a plist of affiliated keywords along with
1870 their value.
1872 Return a list whose CAR is `export-block' and CDR is a plist
1873 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1874 `:post-blank' and `:post-affiliated' keywords.
1876 Assume point is at export-block beginning."
1883 ;; Incomplete block: parse it as a paragraph.
1898 contents-end)))
1902 :end end
1903 :type type
1904 :value value
1905 :hiddenp hidden
1911 "Interpret EXPORT-BLOCK element as Org syntax.
1912 CONTENTS is nil."
1919 ;;;; Fixed-width
1922 "Parse a fixed-width section.
1924 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1925 the buffer position at the beginning of the first affiliated
1926 keyword and CDR is a plist of affiliated keywords along with
1927 their value.
1929 Return a list whose CAR is `fixed-width' and CDR is a plist
1930 containing `:begin', `:end', `:value', `:post-blank' and
1931 `:post-affiliated' keywords.
1933 Assume point is at the beginning of the fixed-width area."
1937 value
1942 ;; Accumulate text without starting colons.
1956 :end end
1957 :value value
1963 "Interpret FIXED-WIDTH element as Org syntax.
1964 CONTENTS is nil."
1972 ;;;; Horizontal Rule
1975 "Parse an horizontal rule.
1977 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1978 the buffer position at the beginning of the first affiliated
1979 keyword and CDR is a plist of affiliated keywords along with
1980 their value.
1982 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1983 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1984 keywords."
1995 :end end
2001 "Interpret HORIZONTAL-RULE element as Org syntax.
2002 CONTENTS is nil."
2006 ;;;; Keyword
2009 "Parse a keyword at point.
2011 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2012 the buffer position at the beginning of the first affiliated
2013 keyword and CDR is a plist of affiliated keywords along with
2014 their value.
2016 Return a list whose CAR is `keyword' and CDR is a plist
2017 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2018 `:post-affiliated' keywords."
2033 :value value
2034 :begin begin
2035 :end end
2041 "Interpret KEYWORD element as Org syntax.
2042 CONTENTS is nil."
2048 ;;;; Latex Environment
2051 "Parse a LaTeX environment.
2053 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2054 the buffer position at the beginning of the first affiliated
2055 keyword and CDR is a plist of affiliated keywords along with
2056 their value.
2058 Return a list whose CAR is `latex-environment' and CDR is a plist
2059 containing `:begin', `:end', `:value', `:post-blank' and
2060 `:post-affiliated' keywords.
2062 Assume point is at the beginning of the latex environment."
2069 limit t))
2070 ;; Incomplete latex environment: parse it as a paragraph.
2081 :end end
2082 :value value
2088 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2089 CONTENTS is nil."
2093 ;;;; Node Property
2096 "Parse a node-property at point.
2098 LIMIT bounds the search.
2100 Return a list whose CAR is `node-property' and CDR is a plist
2101 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2102 keywords."
2114 :value value
2115 :begin begin
2116 :end end
2120 "Interpret NODE-PROPERTY element as Org syntax.
2121 CONTENTS is nil."
2127 ;;;; Paragraph
2130 "Parse a paragraph.
2132 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2133 the buffer position at the beginning of the first affiliated
2134 keyword and CDR is a plist of affiliated keywords along with
2135 their value.
2137 Return a list whose CAR is `paragraph' and CDR is a plist
2138 containing `:begin', `:end', `:contents-begin' and
2139 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2141 Assume point is at the beginning of the paragraph."
2150 limit
2151 ;; A matching `org-element-paragraph-separate' is not
2152 ;; necessarily the end of the paragraph. In
2153 ;; particular, lines starting with # or : as a first
2154 ;; non-space character are ambiguous. We have check
2155 ;; if they are valid Org syntax (i.e. not an
2156 ;; incomplete keyword).
2160 ;; There's no ambiguity for other symbols or
2161 ;; empty lines: stop here.
2163 ;; Stop at valid fixed-width areas.
2165 ;; Stop at drawers.
2170 ;; Stop at valid comments.
2172 ;; Stop at valid dynamic blocks.
2177 ;; Stop at valid blocks.
2184 limit t)))
2185 ;; Stop at valid latex environments.
2193 limit t)))
2194 ;; Stop at valid keywords.
2196 ;; Skip everything else.
2214 :end end
2215 :contents-begin contents-begin
2216 :contents-end contents-end
2222 "Interpret PARAGRAPH element as Org syntax.
2223 CONTENTS is the contents of the element."
2224 contents)
2227 ;;;; Planning
2230 "Parse a planning.
2232 LIMIT bounds the search.
2234 Return a list whose CAR is `planning' and CDR is a plist
2235 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2236 and `:post-blank' keywords."
2246 closed deadline scheduled)
2258 :deadline deadline
2259 :scheduled scheduled
2260 :begin begin
2261 :end end
2265 "Interpret PLANNING element as Org syntax.
2266 CONTENTS is nil."
2268 'identity
2285 ;;;; Quote Section
2288 "Parse a quote section.
2290 LIMIT bounds the search.
2292 Return a list whose CAR is `quote-section' and CDR is a plist
2293 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2295 Assume point is at beginning of the section."
2306 :end end
2307 :value value
2311 "Interpret QUOTE-SECTION element as Org syntax.
2312 CONTENTS is nil."
2316 ;;;; Src Block
2319 "Parse a src block.
2321 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2322 the buffer position at the beginning of the first affiliated
2323 keyword and CDR is a plist of affiliated keywords along with
2324 their value.
2326 Return a list whose CAR is `src-block' and CDR is a plist
2327 containing `:language', `:switches', `:parameters', `:begin',
2328 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2329 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2330 `:post-blank' and `:post-affiliated' keywords.
2332 Assume point is at the beginning of the block."
2335 limit t)))
2336 ;; Incomplete block: parse it as a paragraph.
2342 ;; Get language as a string.
2351 ;; Get switches.
2353 ;; Get parameters.
2355 ;; Switches analysis
2367 ;; Should labels be retained in (or stripped from)
2368 ;; src blocks?
2373 ;; What should code-references use - labels or
2374 ;; line-numbers?
2379 ;; Indentation.
2381 ;; Get visibility status.
2383 ;; Retrieve code.
2392 ;; Get position after ending blank lines.
2403 :begin begin
2404 :end end
2405 :number-lines number-lines
2406 :preserve-indent preserve-indent
2407 :retain-labels retain-labels
2408 :use-labels use-labels
2409 :label-fmt label-fmt
2410 :hiddenp hidden
2411 :value value
2417 "Interpret SRC-BLOCK element as Org syntax.
2418 CONTENTS is nil."
2439 ;;;; Table
2442 "Parse a table at point.
2444 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2445 the buffer position at the beginning of the first affiliated
2446 keyword and CDR is a plist of affiliated keywords along with
2447 their value.
2449 Return a list whose CAR is `table' and CDR is a plist containing
2450 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2451 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2452 keywords.
2454 Assume point is at the beginning of the table."
2468 acc))
2476 :end end
2477 :type type
2478 :tblfm tblfm
2479 ;; Only `org' tables have contents. `table.el' tables
2480 ;; use a `:value' property to store raw table as
2481 ;; a string.
2486 table-begin table-end))
2492 "Interpret TABLE element as Org syntax.
2493 CONTENTS is nil."
2504 ;;;; Table Row
2507 "Parse table row at point.
2509 LIMIT bounds the search.
2511 Return a list whose CAR is `table-row' and CDR is a plist
2512 containing `:begin', `:end', `:contents-begin', `:contents-end',
2513 `:type' and `:post-blank' keywords."
2517 ;; A table rule has no contents. In that case, ensure
2518 ;; CONTENTS-BEGIN matches CONTENTS-END.
2530 :begin begin
2531 :end end
2532 :contents-begin contents-begin
2533 :contents-end contents-end
2537 "Interpret TABLE-ROW element as Org syntax.
2538 CONTENTS is the contents of the table row."
2543 ;;;; Verse Block
2546 "Parse a verse block.
2548 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2549 the buffer position at the beginning of the first affiliated
2550 keyword and CDR is a plist of affiliated keywords along with
2551 their value.
2553 Return a list whose CAR is `verse-block' and CDR is a plist
2554 containing `:begin', `:end', `:contents-begin', `:contents-end',
2555 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2557 Assume point is at beginning of the block."
2561 ;; Incomplete block: parse it as a paragraph.
2578 :end end
2579 :contents-begin contents-begin
2580 :contents-end contents-end
2581 :hiddenp hidden
2587 "Interpret VERSE-BLOCK element as Org syntax.
2588 CONTENTS is verse block contents."
2592 \f
2593 ;;; Objects
2594 ;;
2595 ;; Unlike to elements, interstices can be found between objects.
2596 ;; That's why, along with the parser, successor functions are provided
2597 ;; for each object. Some objects share the same successor (i.e. `code'
2598 ;; and `verbatim' objects).
2599 ;;
2600 ;; A successor must accept a single argument bounding the search. It
2601 ;; will return either a cons cell whose CAR is the object's type, as
2602 ;; a symbol, and CDR the position of its next occurrence, or nil.
2603 ;;
2604 ;; Successors follow the naming convention:
2605 ;; org-element-NAME-successor, where NAME is the name of the
2606 ;; successor, as defined in `org-element-all-successors'.
2607 ;;
2608 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2609 ;; object types they can contain will be specified in
2610 ;; `org-element-object-restrictions'.
2611 ;;
2612 ;; Adding a new type of object is simple. Implement a successor,
2613 ;; a parser, and an interpreter for it, all following the naming
2614 ;; convention. Register type in `org-element-all-objects' and
2615 ;; successor in `org-element-all-successors'. Maybe tweak
2616 ;; restrictions about it, and that's it.
2619 ;;;; Bold
2622 "Parse bold object at point.
2624 Return a list whose CAR is `bold' and CDR is a plist with
2625 `:begin', `:end', `:contents-begin' and `:contents-end' and
2626 `:post-blank' keywords.
2628 Assume point is at the first star marker."
2640 :end end
2641 :contents-begin contents-begin
2642 :contents-end contents-end
2646 "Interpret BOLD object as Org syntax.
2647 CONTENTS is the contents of the object."
2651 "Search for the next text-markup object.
2653 Return value is a cons cell whose CAR is a symbol among `bold',
2654 `italic', `underline', `strike-through', `code' and `verbatim'
2655 and CDR is beginning position."
2671 ;;;; Code
2674 "Parse code object at point.
2676 Return a list whose CAR is `code' and CDR is a plist with
2677 `:value', `:begin', `:end' and `:post-blank' keywords.
2679 Assume point is at the first tilde marker."
2690 :begin begin
2691 :end end
2695 "Interpret CODE object as Org syntax.
2696 CONTENTS is nil."
2700 ;;;; Entity
2703 "Parse entity at point.
2705 Return a list whose CAR is `entity' and CDR a plist with
2706 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2707 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2708 keywords.
2710 Assume point is at the beginning of the entity."
2712 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2728 :begin begin
2729 :end end
2730 :use-brackets-p bracketsp
2734 "Interpret ENTITY object as Org syntax.
2735 CONTENTS is nil."
2741 "Search for the next latex-fragment or entity object.
2743 Return value is a cons cell whose CAR is `entity' or
2744 `latex-fragment' and CDR is beginning position."
2749 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2756 nil t)
2759 ;; Determine if it's a real entity or a LaTeX command.
2762 ;; No entity nor command: point is at a LaTeX fragment.
2763 ;; Determine its type to get the correct beginning position.
2771 matchers)
2775 ;;;; Export Snippet
2778 "Parse export snippet at point.
2780 Return a list whose CAR is `export-snippet' and CDR a plist with
2781 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2782 keywords.
2784 Assume point is at the beginning of the snippet."
2796 :value value
2797 :begin begin
2798 :end end
2802 "Interpret EXPORT-SNIPPET object as Org syntax.
2803 CONTENTS is nil."
2809 "Search for the next export-snippet object.
2811 Return value is a cons cell whose CAR is `export-snippet' and CDR
2812 its beginning position."
2821 ;;;; Footnote Reference
2824 "Parse footnote reference at point.
2826 Return a list whose CAR is `footnote-reference' and CDR a plist
2827 with `:label', `:type', `:inline-definition', `:begin', `:end'
2828 and `:post-blank' as keywords."
2850 :type type
2851 :begin begin
2852 :end end
2855 footnote-reference :inline-definition
2860 footnote-reference))))))
2863 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2864 CONTENTS is nil."
2874 "Search for the next footnote-reference object.
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 Return value is a cons cell whose CAR is `inline-babel-call' and
2932 CDR is beginning position."
2934 ;; Use a simplified version of
2935 ;; `org-babel-inline-lob-one-liner-regexp'.
2938 nil t)
2942 ;;;; Inline Src Block
2945 "Parse inline source block at point.
2947 Return a list whose CAR is `inline-src-block' and CDR a plist
2948 with `:begin', `:end', `:language', `:value', `:parameters' and
2949 `:post-blank' as keywords.
2951 Assume point is at the beginning of the inline src block."
2964 :value value
2965 :parameters parameters
2966 :begin begin
2967 :end end
2971 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2972 CONTENTS is nil."
2977 language
2979 body)))
2982 "Search for the next inline-babel-call element.
2984 Return value is a cons cell whose CAR is `inline-babel-call' and
2985 CDR is beginning position."
2991 ;;;; Italic
2994 "Parse italic object at point.
2996 Return a list whose CAR is `italic' and CDR is a plist with
2997 `:begin', `:end', `:contents-begin' and `:contents-end' and
2998 `:post-blank' keywords.
3000 Assume point is at the first slash marker."
3012 :end end
3013 :contents-begin contents-begin
3014 :contents-end contents-end
3018 "Interpret ITALIC object as Org syntax.
3019 CONTENTS is the contents of the object."
3023 ;;;; Latex Fragment
3026 "Parse latex fragment at point.
3028 Return a list whose CAR is `latex-fragment' and CDR a plist with
3029 `:value', `:begin', `:end', and `:post-blank' as keywords.
3031 Assume point is at the beginning of the latex fragment."
3045 ;; None found: it's a macro.
3054 :begin begin
3055 :end end
3059 "Interpret LATEX-FRAGMENT object as Org syntax.
3060 CONTENTS is nil."
3063 ;;;; Line Break
3066 "Parse line break at point.
3068 Return a list whose CAR is `line-break', and CDR a plist with
3069 `:begin', `:end' and `:post-blank' keywords.
3071 Assume point is at the beginning of the line break."
3078 "Interpret LINE-BREAK object as Org syntax.
3079 CONTENTS is nil."
3083 "Search for the next line-break object.
3085 Return value is a cons cell whose CAR is `line-break' and CDR is
3086 beginning position."
3090 ;; A line break can only happen on a non-empty line.
3095 ;;;; Link
3098 "Parse link at point.
3100 Return a list whose CAR is `link' and CDR a plist with `:type',
3101 `:path', `:raw-link', `:application', `:search-option', `:begin',
3102 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3103 keywords.
3105 Assume point is at the beginning of the link."
3108 end contents-begin contents-end link-end post-blank path type
3109 raw-link link search-option application)
3111 ;; Type 1: Text targeted from a radio target.
3116 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3121 ;; RAW-LINK is the original link. Expand any
3122 ;; abbreviation in it.
3126 ;; Determine TYPE of link and set PATH accordingly.
3128 ;; File type.
3132 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3135 ;; Id type: PATH is the id.
3138 ;; Code-ref type: PATH is the name of the reference.
3141 ;; Custom-id type: PATH is the name of the custom id.
3144 ;; Fuzzy type: Internal link either matches a target, an
3145 ;; headline name or nothing. PATH is the target or
3146 ;; headline's name.
3148 ;; Type 3: Plain link, i.e. http://orgmode.org
3154 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3161 ;; In any case, deduce end point after trailing white space from
3162 ;; LINK-END variable.
3165 ;; Extract search option and opening application out of
3166 ;; "file"-type links.
3168 ;; Application.
3173 ;; Extract search option from PATH.
3177 ;; Make sure TYPE always reports "file".
3181 :path path
3183 :application application
3184 :search-option search-option
3185 :begin begin
3186 :end end
3187 :contents-begin contents-begin
3188 :contents-end contents-end
3192 "Interpret LINK object as Org syntax.
3193 CONTENTS is the contents of the object, or nil."
3198 raw-link
3202 "Search for the next link object.
3204 Return value is a cons cell whose CAR is `link' and CDR is
3205 beginning position."
3214 "Search for the next plain link object.
3216 Return value is a cons cell whose CAR is `link' and CDR is
3217 beginning position."
3222 ;;;; Macro
3225 "Parse macro at point.
3227 Return a list whose CAR is `macro' and CDR a plist with `:key',
3228 `:args', `:begin', `:end', `:value' and `:post-blank' as
3229 keywords.
3231 Assume point is at the macro."
3242 ;; Do not use `org-split-string' since empty
3243 ;; strings are meaningful here.
3251 args nil t)
3255 :value value
3256 :args args
3257 :begin begin
3258 :end end
3262 "Interpret MACRO object as Org syntax.
3263 CONTENTS is nil."
3267 "Search for the next macro object.
3269 Return value is cons cell whose CAR is `macro' and CDR is
3270 beginning position."
3274 nil t)
3278 ;;;; Radio-target
3281 "Parse radio target at point.
3283 Return a list whose CAR is `radio-target' and CDR a plist with
3284 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3285 and `:post-blank' as keywords.
3287 Assume point is at the radio target."
3299 :end end
3300 :contents-begin contents-begin
3301 :contents-end contents-end
3302 :post-blank post-blank
3306 "Interpret TARGET object as Org syntax.
3307 CONTENTS is the contents of the object."
3311 "Search for the next radio-target object.
3313 Return value is a cons cell whose CAR is `radio-target' and CDR
3314 is beginning position."
3320 ;;;; Statistics Cookie
3323 "Parse statistics cookie at point.
3325 Return a list whose CAR is `statistics-cookie', and CDR a plist
3326 with `:begin', `:end', `:value' and `:post-blank' keywords.
3328 Assume point is at the beginning of the statistics-cookie."
3339 :end end
3340 :value value
3344 "Interpret STATISTICS-COOKIE object as Org syntax.
3345 CONTENTS is nil."
3349 "Search for the next statistics cookie object.
3351 Return value is a cons cell whose CAR is `statistics-cookie' and
3352 CDR is beginning position."
3358 ;;;; Strike-Through
3361 "Parse strike-through object at point.
3363 Return a list whose CAR is `strike-through' and CDR is a plist
3364 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3365 `:post-blank' keywords.
3367 Assume point is at the first plus sign marker."
3379 :end end
3380 :contents-begin contents-begin
3381 :contents-end contents-end
3385 "Interpret STRIKE-THROUGH object as Org syntax.
3386 CONTENTS is the contents of the object."
3390 ;;;; Subscript
3393 "Parse subscript at point.
3395 Return a list whose CAR is `subscript' and CDR a plist with
3396 `:begin', `:end', `:contents-begin', `:contents-end',
3397 `:use-brackets-p' and `:post-blank' as keywords.
3399 Assume point is at the underscore."
3403 t
3414 :end end
3415 :use-brackets-p bracketsp
3416 :contents-begin contents-begin
3417 :contents-end contents-end
3421 "Interpret SUBSCRIPT object as Org syntax.
3422 CONTENTS is the contents of the object."
3425 contents))
3428 "Search for the next sub/superscript object.
3430 Return value is a cons cell whose CAR is either `subscript' or
3431 `superscript' and CDR is beginning position."
3439 ;;;; Superscript
3442 "Parse superscript at point.
3444 Return a list whose CAR is `superscript' and CDR a plist with
3445 `:begin', `:end', `:contents-begin', `:contents-end',
3446 `:use-brackets-p' and `:post-blank' as keywords.
3448 Assume point is at the caret."
3462 :end end
3463 :use-brackets-p bracketsp
3464 :contents-begin contents-begin
3465 :contents-end contents-end
3469 "Interpret SUPERSCRIPT object as Org syntax.
3470 CONTENTS is the contents of the object."
3473 contents))
3476 ;;;; Table Cell
3479 "Parse table cell at point.
3481 Return a list whose CAR is `table-cell' and CDR is a plist
3482 containing `:begin', `:end', `:contents-begin', `:contents-end'
3483 and `:post-blank' keywords."
3491 :end end
3492 :contents-begin contents-begin
3493 :contents-end contents-end
3497 "Interpret TABLE-CELL element as Org syntax.
3498 CONTENTS is the contents of the cell, or nil."
3502 "Search for the next table-cell object.
3504 Return value is a cons cell whose CAR is `table-cell' and CDR is
3505 beginning position."
3509 ;;;; Target
3512 "Parse target at point.
3514 Return a list whose CAR is `target' and CDR a plist with
3515 `:begin', `:end', `:value' and `:post-blank' as keywords.
3517 Assume point is at the target."
3527 :end end
3528 :value value
3532 "Interpret TARGET object as Org syntax.
3533 CONTENTS is nil."
3537 "Search for the next target object.
3539 Return value is a cons cell whose CAR is `target' and CDR is
3540 beginning position."
3546 ;;;; Timestamp
3549 "Parse time stamp at point.
3551 Return a list whose CAR is `timestamp', and CDR a plist with
3552 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3554 Assume point is at the beginning of the timestamp."
3572 date-start)
3583 raw-value)
3585 :repeater-type
3591 :repeater-unit
3594 year-start month-start day-start hour-start minute-start year-end
3595 month-end day-end hour-end minute-end)
3596 ;; Parse date-start.
3604 ;; Compute date-end. It can be provided directly in time-stamp,
3605 ;; or extracted from time range. Otherwise, it defaults to the
3606 ;; same values as date-start.
3616 :raw-value raw-value
3617 :year-start year-start
3618 :month-start month-start
3619 :day-start day-start
3620 :hour-start hour-start
3621 :minute-start minute-start
3622 :year-end year-end
3623 :month-end month-end
3624 :day-end day-end
3625 :hour-end hour-end
3626 :minute-end minute-end
3627 :begin begin
3628 :end end
3630 repeater-props)))))
3633 "Interpret TIMESTAMP object as Org syntax.
3634 CONTENTS is nil."
3635 ;; Use `:raw-value' if specified.
3637 ;; Otherwise, build timestamp string.
3647 ;; Build an Org timestamp string from TIME. ACTIVEP is
3648 ;; non-nil when time stamp is active. If WITH-TIME-P is
3649 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3650 ;; specify a time range in the timestamp. REPEAT-STRING
3651 ;; is the repeater string, if any.
3655 org-time-stamp-formats)
3656 time)))
3662 nil nil ts)))
3666 " "
3667 repeat-string
3669 ;; Return value.
3670 ts)))
3682 build-ts-string
3701 0
3709 "--"
3721 "Search for the next timestamp object.
3723 Return value is a cons cell whose CAR is `timestamp' and CDR is
3724 beginning position."
3732 nil t)
3736 ;;;; Underline
3739 "Parse underline object at point.
3741 Return a list whose CAR is `underline' and CDR is a plist with
3742 `:begin', `:end', `:contents-begin' and `:contents-end' and
3743 `:post-blank' keywords.
3745 Assume point is at the first underscore marker."
3757 :end end
3758 :contents-begin contents-begin
3759 :contents-end contents-end
3763 "Interpret UNDERLINE object as Org syntax.
3764 CONTENTS is the contents of the object."
3768 ;;;; Verbatim
3771 "Parse verbatim object at point.
3773 Return a list whose CAR is `verbatim' and CDR is a plist with
3774 `:value', `:begin', `:end' and `:post-blank' keywords.
3776 Assume point is at the first equal sign marker."
3787 :begin begin
3788 :end end
3792 "Interpret VERBATIM object as Org syntax.
3793 CONTENTS is nil."
3797 \f
3798 ;;; Parsing Element Starting At Point
3799 ;;
3800 ;; `org-element--current-element' is the core function of this section.
3801 ;; It returns the Lisp representation of the element starting at
3802 ;; point.
3803 ;;
3804 ;; `org-element--current-element' makes use of special modes. They
3805 ;; are activated for fixed element chaining (i.e. `plain-list' >
3806 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3807 ;; `section'). Special modes are: `first-section', `item',
3808 ;; `node-property', `quote-section', `section' and `table-row'.
3812 "Parse the element starting at point.
3814 Return value is a list like (TYPE PROPS) where TYPE is the type
3815 of the element and PROPS a plist of properties associated to the
3816 element.
3818 Possible types are defined in `org-element-all-elements'.
3820 LIMIT bounds the search.
3822 Optional argument GRANULARITY determines the depth of the
3823 recursion. Allowed values are `headline', `greater-element',
3824 `element', `object' or nil. When it is broader than `object' (or
3825 nil), secondary values will not be parsed, since they only
3826 contain objects.
3828 Optional argument SPECIAL, when non-nil, can be either
3829 `first-section', `item', `node-property', `quote-section',
3830 `section', and `table-row'.
3832 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3833 be computed.
3835 This function assumes point is always at the beginning of the
3836 element it has to parse."
3839 ;; Determine if parsing depth allows for secondary strings
3840 ;; parsing. It only applies to elements referenced in
3841 ;; `org-element-secondary-value-alist'.
3844 ;; Item.
3847 ;; Table Row.
3849 ;; Node Property.
3851 ;; Headline.
3854 ;; Sections (must be checked after headline).
3860 limit)))
3861 ;; When not at bol, point is at the beginning of an item or
3862 ;; a footnote definition: next item is always a paragraph.
3864 ;; Planning and Clock.
3869 ;; Inlinetask.
3872 ;; From there, elements can have affiliated keywords.
3875 ;; Jumping over affiliated keywords put point off-limits.
3876 ;; Parse them as regular keywords.
3880 ;; LaTeX Environment.
3884 ;; Drawer and Property Drawer.
3889 ;; Fixed Width
3892 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3893 ;; Keywords.
3902 org-element-block-name-alist)))
3917 ;; Footnote Definition.
3920 ;; Horizontal Rule.
3923 ;; Diary Sexp.
3926 ;; Table.
3928 ;; List.
3931 limit affiliated
3933 ;; Default element: Paragraph.
3937 ;; Most elements can have affiliated keywords. When looking for an
3938 ;; element beginning, we want to move before them, as they belong to
3939 ;; that element, and, in the meantime, collect information they give
3940 ;; into appropriate properties. Hence the following function.
3943 "Collect affiliated keywords from point down to LIMIT.
3945 Return a list whose CAR is the position at the first of them and
3946 CDR a plist of keywords and values and move point to the
3947 beginning of the first line after them.
3949 As a special case, if element doesn't start at the beginning of
3950 the line (i.e. a paragraph starting an item), CAR is current
3951 position of point and CDR is nil."
3955 ;; RESTRICT is the list of objects allowed in parsed
3956 ;; keywords value.
3958 output)
3961 ;; Apply translation to RAW-KWD. From there, KWD is
3962 ;; the official keyword.
3964 org-element-keyword-translation-alist))
3965 raw-kwd))
3966 ;; Find main value for any keyword.
3972 ;; PARSEDP is non-nil when keyword should have its
3973 ;; value parsed.
3975 ;; If KWD is a dual keyword, find its secondary
3976 ;; value. Maybe parse it.
3983 ;; Attribute a property name to KWD.
3985 ;; Now set final shape for VALUE.
3991 ;; Attributes can always appear on multiple lines.
3994 ;; Eventually store the new value in OUTPUT.
3996 ;; Move to next keyword.
3998 ;; If affiliated keywords are orphaned: move back to first one.
3999 ;; They will be parsed as a paragraph.
4001 ;; Return value.
4005 \f
4006 ;;; The Org Parser
4007 ;;
4008 ;; The two major functions here are `org-element-parse-buffer', which
4009 ;; parses Org syntax inside the current buffer, taking into account
4010 ;; region, narrowing, or even visibility if specified, and
4011 ;; `org-element-parse-secondary-string', which parses objects within
4012 ;; a given string.
4013 ;;
4014 ;; The (almost) almighty `org-element-map' allows to apply a function
4015 ;; on elements or objects matching some type, and accumulate the
4016 ;; resulting values. In an export situation, it also skips unneeded
4017 ;; parts of the parse tree.
4020 "Recursively parse the buffer and return structure.
4021 If narrowing is in effect, only parse the visible part of the
4022 buffer.
4024 Optional argument GRANULARITY determines the depth of the
4025 recursion. It can be set to the following symbols:
4027 `headline' Only parse headlines.
4028 `greater-element' Don't recurse into greater elements excepted
4029 headlines and sections. Thus, elements
4030 parsed are the top-level ones.
4031 `element' Parse everything but objects and plain text.
4032 `object' Parse the complete buffer (default).
4034 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4035 elements.
4037 An element or an objects is represented as a list with the
4038 pattern (TYPE PROPERTIES CONTENTS), where :
4040 TYPE is a symbol describing the element or object. See
4041 `org-element-all-elements' and `org-element-all-objects' for an
4042 exhaustive list of such symbols. One can retrieve it with
4043 `org-element-type' function.
4045 PROPERTIES is the list of attributes attached to the element or
4046 object, as a plist. Although most of them are specific to the
4047 element or object type, all types share `:begin', `:end',
4048 `:post-blank' and `:parent' properties, which respectively
4049 refer to buffer position where the element or object starts,
4050 ends, the number of white spaces or blank lines after it, and
4051 the element or object containing it. Properties values can be
4052 obtained by using `org-element-property' function.
4054 CONTENTS is a list of elements, objects or raw strings
4055 contained in the current element or object, when applicable.
4056 One can access them with `org-element-contents' function.
4058 The Org buffer has `org-data' as type and nil as properties.
4059 `org-element-map' function can be used to find specific elements
4060 or objects within the parse tree.
4062 This function assumes that current major mode is `org-mode'."
4068 ;; Start in `first-section' mode so text before the first
4069 ;; headline belongs to a section.
4073 "Recursively parse objects in STRING and return structure.
4075 RESTRICTION is a symbol limiting the object types that will be
4076 looked after.
4078 Optional argument PARENT, when non-nil, is the element or object
4079 containing the secondary string. It is used to set correctly
4080 `:parent' property within the string."
4081 ;; Copy buffer-local variables listed in
4082 ;; `org-element-object-variables' into temporary buffer. This is
4083 ;; required since object parsing is dependent on these variables.
4087 org-element-object-variables))))
4095 secondary))
4096 secondary))))
4100 "Map a function on selected elements or objects.
4102 DATA is a parse tree, an element, an object, a string, or a list
4103 of such constructs. TYPES is a symbol or list of symbols of
4104 elements or objects types (see `org-element-all-elements' and
4105 `org-element-all-objects' for a complete list of types). FUN is
4106 the function called on the matching element or object. It has to
4107 accept one argument: the element or object itself.
4109 When optional argument INFO is non-nil, it should be a plist
4110 holding export options. In that case, parts of the parse tree
4111 not exportable according to that property list will be skipped.
4113 When optional argument FIRST-MATCH is non-nil, stop at the first
4114 match for which FUN doesn't return nil, and return that value.
4116 Optional argument NO-RECURSION is a symbol or a list of symbols
4117 representing elements or objects types. `org-element-map' won't
4118 enter any recursive element or object whose type belongs to that
4119 list. Though, FUN can still be applied on them.
4121 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4122 apply to matching objects within parsed affiliated keywords (see
4123 `org-element-parsed-keywords').
4125 Nil values returned from FUN do not appear in the results.
4128 Examples:
4129 ---------
4131 Assuming TREE is a variable containing an Org buffer parse tree,
4132 the following example will return a flat list of all `src-block'
4133 and `example-block' elements in it:
4135 \(org-element-map tree '(example-block src-block) 'identity)
4137 The following snippet will find the first headline with a level
4140 \(org-element-map tree 'headline
4141 \(lambda (hl)
4142 \(and (= (org-element-property :level hl) 1)
4144 \(org-element-property :begin hl)))
4145 nil t)
4147 The next example will return a flat list of all `plain-list' type
4148 elements in TREE that are not a sub-list themselves:
4150 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4152 Eventually, this example will return a flat list of all `bold'
4153 type objects containing a `latex-snippet' type object, even
4154 looking into captions:
4156 \(org-element-map tree 'bold
4157 \(lambda (b)
4158 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4159 nil nil nil t)"
4160 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4163 ;; Recursion depth is determined by --CATEGORY.
4170 ;; If one object is found, the function
4171 ;; has to recurse into every object.
4174 ;; If one regular element is found, the
4175 ;; function has to recurse, at least,
4176 ;; into every element it encounters.
4179 types)
4180 category)))
4181 ;; Compute properties for affiliated keywords if necessary.
4186 org-element-affiliated-keywords)))
4187 --acc
4188 --walk-tree
4192 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4193 ;; holding contextual information.
4197 ;; Ignored element in an export context.
4199 ;; List of elements or objects.
4201 ;; Unconditionally enter parse trees.
4205 ;; Check if TYPE is matching among TYPES. If so,
4206 ;; apply FUN to --DATA and accumulate return value
4207 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4213 ;; If --DATA has a secondary string that can contain
4214 ;; objects with their type among TYPES, look into it.
4221 ;; If --DATA has any affiliated keywords and
4222 ;; WITH-AFFILIATED is non-nil, look for objects in
4223 ;; them.
4231 ;; Pay attention to the type of value.
4232 ;; Preserve order for multiple keywords.
4248 --affiliated-alist))
4249 ;; Determine if a recursion into --DATA is possible.
4251 ;; --TYPE is explicitly removed from recursion.
4253 ;; --DATA has no contents.
4255 ;; Looking for greater elements but --DATA is simply
4256 ;; an element or an object.
4259 ;; Looking for elements but --DATA is an object.
4262 ;; In any other case, map contents.
4266 ;; Return value in a proper order.
4270 ;; The following functions are internal parts of the parser.
4271 ;;
4272 ;; The first one, `org-element--parse-elements' acts at the element's
4273 ;; level.
4274 ;;
4275 ;; The second one, `org-element--parse-objects' applies on all objects
4276 ;; of a paragraph or a secondary string. It uses
4277 ;; `org-element--get-next-object-candidates' to optimize the search of
4278 ;; the next object in the buffer.
4279 ;;
4280 ;; More precisely, that function looks for every allowed object type
4281 ;; first. Then, it discards failed searches, keeps further matches,
4282 ;; and searches again types matched behind point, for subsequent
4283 ;; calls. Thus, searching for a given type fails only once, and every
4284 ;; object is searched only once at top level (but sometimes more for
4285 ;; nested types).
4289 "Parse elements between BEG and END positions.
4291 SPECIAL prioritize some elements over the others. It can be set
4292 to `first-section', `quote-section', `section' `item' or
4293 `table-row'.
4295 When value is `item', STRUCTURE will be used as the current list
4296 structure.
4298 GRANULARITY determines the depth of the recursion. See
4299 `org-element-parse-buffer' for more information.
4301 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4302 elements.
4304 Elements are accumulated into ACC."
4307 ;; Visible only: skip invisible parts at the beginning of the
4308 ;; element.
4311 ;; When parsing only headlines, skip any text before first one.
4314 ;; Main loop start.
4316 ;; Find current element's type and parse it accordingly to
4317 ;; its category.
4319 end granularity special structure))
4323 ;; Visible only: skip invisible parts between siblings.
4326 ;; Fill ELEMENT contents by side-effect.
4328 ;; If element has no contents, don't modify it.
4330 ;; Greater element: parse it between `contents-begin' and
4331 ;; `contents-end'. Make sure GRANULARITY allows the
4332 ;; recursion, or ELEMENT is a headline, in which case going
4333 ;; inside is mandatory, in order to get sub-level headings.
4341 ;; Possibly switch to a special mode.
4351 granularity visible-only element))
4352 ;; ELEMENT has contents. Parse objects inside, if
4353 ;; GRANULARITY allows it.
4359 ;; Return result.
4360 acc))
4363 "Parse objects between BEG and END and return recursive structure.
4365 Objects are accumulated in ACC.
4367 RESTRICTION is a list of object successors which are allowed in
4368 the current object."
4377 restriction candidates)))
4384 ;; 1. Text before any object. Untabify it.
4389 acc
4393 ;; 2. Object...
4396 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4397 ;; a recursive type.
4405 ;; 3. Text after last object. Untabify it.
4409 acc
4413 ;; Result.
4414 acc))))
4417 "Return an alist of candidates for the next object.
4419 RESTRICTION is a list of object types, as symbols. Only
4420 candidates with such types are looked after.
4422 OBJECTS is the previous candidates alist. If it is set to
4423 `initial', no search has been done before, and all symbols in
4424 RESTRICTION should be looked after.
4426 Return value is an alist whose CAR is the object type and CDR its
4427 beginning position."
4429 nil
4431 ;; When searching for the first time, look for every successor
4432 ;; allowed in RESTRICTION.
4436 restriction)
4437 ;; Focus on objects returned during last search. Keep those
4438 ;; still after point. Search again objects before it.
4444 type)))
4447 objects))))
4450 \f
4451 ;;; Towards A Bijective Process
4452 ;;
4453 ;; The parse tree obtained with `org-element-parse-buffer' is really
4454 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4455 ;; interpreted and expanded into a string with canonical Org syntax.
4456 ;; Hence `org-element-interpret-data'.
4457 ;;
4458 ;; The function relies internally on
4459 ;; `org-element--interpret-affiliated-keywords'.
4461 ;;;###autoload
4463 "Interpret DATA as Org syntax.
4465 DATA is a parse tree, an element, an object or a secondary string
4466 to interpret.
4468 Optional argument PARENT is used for recursive calls. It contains
4469 the element or object containing data, or nil.
4471 Return Org syntax as a string."
4475 ;; Secondary string.
4480 ;; Full Org document.
4485 ;; Plain text: remove `:parent' text property from output.
4487 ;; Element/Object without contents.
4490 data nil))
4491 ;; Element/Object with contents.
4501 ;; Elements directly containing objects must
4502 ;; have their indentation normalized first.
4504 data
4505 ;; When normalizing first paragraph of an
4506 ;; item or a footnote-definition, ignore
4507 ;; first line's indentation.
4514 data
4516 contents)))))))
4518 ;; Build white spaces. If no `:post-blank' property is
4519 ;; specified, assume its value is 0.
4529 "Return ELEMENT's affiliated keywords as Org syntax.
4530 If there is no affiliated keyword, return the empty string."
4540 ": "
4543 value)
4551 ;; All attribute keywords can have multiple lines.
4557 ;; List all ELEMENT's properties matching an attribute line or an
4558 ;; affiliated keyword, but ignore translated keywords since they
4559 ;; cannot belong to the property list.
4566 org-element-keyword-translation-alist)))))
4567 collect prop)
4570 ;; Because interpretation of the parse tree must return the same
4571 ;; number of blank lines between elements and the same number of white
4572 ;; space after objects, some special care must be given to white
4573 ;; spaces.
4574 ;;
4575 ;; The first function, `org-element-normalize-string', ensures any
4576 ;; string different from the empty string will end with a single
4577 ;; newline character.
4578 ;;
4579 ;; The second function, `org-element-normalize-contents', removes
4580 ;; global indentation from the contents of the current element.
4583 "Ensure string S ends with a single newline character.
4585 If S isn't a string return it unchanged. If S is the empty
4586 string, return it. Otherwise, return a new string with a single
4587 newline character at its end."
4595 "Normalize plain text in ELEMENT's contents.
4597 ELEMENT must only contain plain text and objects.
4599 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4600 indentation to compute maximal common indentation.
4602 Return the normalized element that is element with global
4603 indentation removed from its contents. The function assumes that
4604 indentation is not done with TAB characters."
4606 collect-inds ; for byte-compiler
4609 ;; Return list of indentations within BLOB. This is done by
4610 ;; walking recursively BLOB and updating IND-LIST along the
4611 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4612 ;; been seen yet. It is required as this string is the only
4613 ;; one whose indentation doesn't happen after a newline
4614 ;; character.
4622 ;; An indentation of zero means no string will be
4623 ;; modified. Quit the process.
4629 ;; Avoid matching blank or empty lines.
4637 ;; Collect indentation list in ELEMENT. Possibly remove first
4638 ;; value if IGNORE-FIRST is non-nil.
4641 ;; Build ELEMENT back, replacing each string with the same
4642 ;; string minus common indentation.
4647 ;; Return BLOB with all its strings indentation
4648 ;; shortened from MCI white spaces. FIRST-FLAG is
4649 ;; non-nil when the first string hasn't been seen
4650 ;; yet.
4664 org-element-recursive-objects)
4668 blob))))
4672 \f
4673 ;;; The Toolbox
4674 ;;
4675 ;; The first move is to implement a way to obtain the smallest element
4676 ;; containing point. This is the job of `org-element-at-point'. It
4677 ;; basically jumps back to the beginning of section containing point
4678 ;; and moves, element after element, with
4679 ;; `org-element--current-element' until the container is found. Note:
4680 ;; When using `org-element-at-point', secondary values are never
4681 ;; parsed since the function focuses on elements, not on objects.
4682 ;;
4683 ;; At a deeper level, `org-element-context' lists all elements and
4684 ;; objects containing point.
4685 ;;
4686 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4687 ;; internally by navigation and manipulation tools.
4689 ;;;###autoload
4691 "Determine closest element around point.
4693 Return value is a list like (TYPE PROPS) where TYPE is the type
4694 of the element and PROPS a plist of properties associated to the
4695 element.
4697 Possible types are defined in `org-element-all-elements'.
4698 Properties depend on element or object type, but always include
4699 `:begin', `:end', `:parent' and `:post-blank' properties.
4701 As a special case, if point is at the very beginning of a list or
4702 sub-list, returned element will be that list instead of the first
4703 item. In the same way, if point is at the beginning of the first
4704 row of a table, returned element will be the table instead of the
4705 first row.
4707 If optional argument KEEP-TRAIL is non-nil, the function returns
4708 a list of elements leading to element at point. The list's CAR
4709 is always the element at point. The following positions contain
4710 element's siblings, then parents, siblings of parents, until the
4711 first element of current section."
4713 ;; If at a headline, parse it. It is the sole element that
4714 ;; doesn't require to know about context. Be sure to disallow
4715 ;; secondary string parsing, though.
4721 ;; Otherwise move at the beginning of the section containing
4722 ;; point.
4727 element type special-flag trail struct prevs parent)
4730 ;; In empty lines at buffer's beginning, return nil.
4739 ;; In blank lines just after the headline, point still
4740 ;; belongs to the headline.
4748 ;; Parse successively each element, skipping those ending
4749 ;; before original position.
4757 ;; 1. Skip any element ending before point. Also skip
4758 ;; element ending at point when we're sure that another
4759 ;; element has started.
4764 ;; 2. An element containing point is always the element at
4765 ;; point.
4768 ;; 3. At any other greater element type, if point is
4769 ;; within contents, move into it.
4774 ;; Create an anchor for tables and plain lists:
4775 ;; when point is at the very beginning of these
4776 ;; elements, ignoring affiliated keywords,
4777 ;; target them instead of their contents.
4779 ;; When point is at contents end, do not move
4780 ;; into elements with an explicit ending, but
4781 ;; return that element instead.
4785 drawer dynamic-block inlinetask item
4786 plain-list property-drawer quote-block
4787 special-block))))
4802 ;;;###autoload
4804 "Return closest element or object around point.
4806 Return value is a list like (TYPE PROPS) where TYPE is the type
4807 of the element or object and PROPS a plist of properties
4808 associated to it.
4810 Possible types are defined in `org-element-all-elements' and
4811 `org-element-all-objects'. Properties depend on element or
4812 object type, but always include `:begin', `:end', `:parent' and
4813 `:post-blank'.
4815 Optional argument ELEMENT, when non-nil, is the closest element
4816 containing point, as returned by `org-element-at-point'.
4817 Providing it allows for quicker computation."
4823 context)
4824 ;; Check if point is inside an element containing objects or at
4825 ;; a secondary string. In that case, narrow buffer to the
4826 ;; containing area. Otherwise, return ELEMENT.
4828 ;; At a parsed affiliated keyword, check if we're inside main
4829 ;; or dual value.
4844 ;; Also change type to retrieve correct restrictions.
4846 ;; At an item, objects can only be located within tag, if any.
4856 ;; At an headline or inlinetask, objects are located within
4857 ;; their title.
4864 ;; At a paragraph, a table-row or a verse block, objects are
4865 ;; located within their contents.
4869 ;; CBEG is nil for table rules.
4873 ;; At a parsed keyword, objects are located within value.
4876 org-element-document-properties))
4891 restriction candidates))
4893 candidates)))
4894 ;; If ORIGIN is before next object in element, there's
4895 ;; no point in looking further.
4905 ;; ORIGIN is after OBJECT, so skip it.
4907 ;; ORIGIN is within a non-recursive object or at
4908 ;; an object boundaries: Return that object.
4912 ;; Otherwise, move within current object and
4913 ;; restrict search to the end of its contents.
4920 parent))))))
4923 "Non-nil when elements ELEM-A and ELEM-B are nested."
4932 "Swap elements ELEM-A and ELEM-B.
4933 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4934 end of ELEM-A."
4936 ;; There are two special cases when an element doesn't start at bol:
4937 ;; the first paragraph in an item or in a footnote definition.
4939 ;; Only a paragraph without any affiliated keyword can be moved at
4940 ;; ELEM-A position in such a situation. Note that the case of
4941 ;; a footnote definition is impossible: it cannot contain two
4942 ;; paragraphs in a row because it cannot contain a blank line.
4948 ;; In a special situation, ELEM-A will have no indentation. We'll
4949 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4963 ;; Store overlays responsible for visibility status. We
4964 ;; also need to store their boundaries as they will be
4965 ;; removed from buffer.
4972 ;; Get contents.
4980 ;; Restore ex ELEM-A overlays.
4989 ;; Restore ex ELEM-B overlays.
4998 ;; Local variables:
4999 ;; generated-autoload-file: "org-loaddefs.el"
5000 ;; End:
5002 ;;; org-element.el ends here