| blob | 28148b7c2e68410198f2c804f090d4f722e3eb39 |
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012-2013 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
24 ;;
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
27 ;;
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
31 ;;
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `node-property', `quote-section' `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
41 ;;
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
47 ;;
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `quote-section',
52 ;; `src-block', `table', `table-row' and `verse-block'. Among them,
53 ;; `paragraph' and `verse-block' types can contain Org objects and
54 ;; plain text.
55 ;;
56 ;; Objects are related to document's contents. Some of them are
57 ;; recursive. Associated types are of the following: `bold', `code',
58 ;; `entity', `export-snippet', `footnote-reference',
59 ;; `inline-babel-call', `inline-src-block', `italic',
60 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
61 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
62 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
63 ;;
64 ;; Some elements also have special properties whose value can hold
65 ;; objects themselves (i.e. an item tag or a headline name). Such
66 ;; values are called "secondary strings". Any object belongs to
67 ;; either an element or a secondary string.
68 ;;
69 ;; Notwithstanding affiliated keywords, each greater element, element
70 ;; and object has a fixed set of properties attached to it. Among
71 ;; them, four are shared by all types: `:begin' and `:end', which
72 ;; refer to the beginning and ending buffer positions of the
73 ;; considered element or object, `:post-blank', which holds the number
74 ;; of blank lines, or white spaces, at its end and `:parent' which
75 ;; refers to the element or object containing it. Greater elements,
76 ;; elements and objects containing objects will also have
77 ;; `:contents-begin' and `:contents-end' properties to delimit
78 ;; contents. Eventually, greater elements and elements accepting
79 ;; affiliated keywords will have a `:post-affiliated' property,
80 ;; referring to the buffer position after all such keywords.
81 ;;
82 ;; At the lowest level, a `:parent' property is also attached to any
83 ;; string, as a text property.
84 ;;
85 ;; Lisp-wise, an element or an object can be represented as a list.
86 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
87 ;; TYPE is a symbol describing the Org element or object.
88 ;; PROPERTIES is the property list attached to it. See docstring of
89 ;; appropriate parsing function to get an exhaustive
90 ;; list.
91 ;; CONTENTS is a list of elements, objects or raw strings contained
92 ;; in the current element or object, when applicable.
93 ;;
94 ;; An Org buffer is a nested list of such elements and objects, whose
95 ;; type is `org-data' and properties is nil.
96 ;;
97 ;; The first part of this file defines Org syntax, while the second
98 ;; one provide accessors and setters functions.
99 ;;
100 ;; The next part implements a parser and an interpreter for each
101 ;; element and object type in Org syntax.
102 ;;
103 ;; The following part creates a fully recursive buffer parser. It
104 ;; also provides a tool to map a function to elements or objects
105 ;; matching some criteria in the parse tree. Functions of interest
106 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
107 ;; extent, `org-element-parse-secondary-string'.
108 ;;
109 ;; The penultimate part is the cradle of an interpreter for the
110 ;; obtained parse tree: `org-element-interpret-data'.
111 ;;
112 ;; The library ends by furnishing `org-element-at-point' function, and
113 ;; a way to give information about document structure around point
114 ;; with `org-element-context'.
117 ;;; Code:
123 \f
124 ;;; Definitions And Rules
125 ;;
126 ;; Define elements, greater elements and specify recursive objects,
127 ;; along with the affiliated keywords recognized. Also set up
128 ;; restrictions on recursive objects combinations.
129 ;;
130 ;; These variables really act as a control center for the parsing
131 ;; process.
135 ;; Headlines, inlinetasks.
137 ;; Footnote definitions.
139 ;; Diary sexps.
142 ;; Empty lines.
144 ;; Tables (any type).
146 ;; Blocks (any type), Babel calls, drawers (any type),
147 ;; fixed-width areas and keywords. Note: this is only an
148 ;; indication and need some thorough check.
150 ;; Horizontal rules.
152 ;; LaTeX environments.
154 ;; Planning and Clock lines.
156 org-deadline-string
157 org-closed-string
158 org-clock-string))
160 ;; Lists.
167 "Regexp to separate paragraphs in an Org buffer.
169 is not sufficient to know if point is at a paragraph ending. See
174 dynamic-block example-block export-block fixed-width
175 footnote-definition headline horizontal-rule inlinetask item
176 keyword latex-environment node-property paragraph plain-list
177 planning property-drawer quote-block quote-section section
178 special-block src-block table table-row verse-block)
183 item plain-list property-drawer quote-block section
184 special-block table)
189 latex-or-entity line-break link macro plain-link radio-target
190 statistics-cookie sub/superscript table-cell target
191 text-markup timestamp)
200 "Alist of translations between object type and successor name.
201 Sharing the same successor comes handy when, for example, the
206 inline-src-block italic line-break latex-fragment link macro
207 radio-target statistics-cookie strike-through subscript superscript
208 table-cell target timestamp underline verbatim)
213 table-cell underline)
223 "Alist between block names and the associated parsing function.
224 Names must be uppercase. Any block whose name has no association
230 Only these types can accept search options and an explicit
236 "List of affiliated keywords as strings.
242 ;; Regular affiliated keywords.
245 "Regexp matching any affiliated keyword.
247 Keyword name is put in match group 1. Moreover, if keyword
248 belongs to `org-element-dual-keywords', put the dual value in
249 match group 2.
257 "Alist of usual translations for keywords.
258 The key is the old name and the value the new one. The property
262 "List of affiliated keywords that can occur more than once in an element.
264 Their value will be consed into a list of strings, which will be
265 returned as the value of the property.
267 This list is checked after translations have been applied. See
268 `org-element-keyword-translation-alist'.
274 "List of affiliated keywords whose value can be parsed.
276 Their value will be stored as a secondary string: a list of
277 strings and objects.
279 This list is checked after translations have been applied. See
283 "List of affiliated keywords which can have a secondary value.
285 In Org syntax, they can be written with optional square brackets
286 before the colons. For example, RESULTS keyword can be
287 associated to a hash value with the following:
289 #+RESULTS[hash-string]: some-source
291 This list is checked after translations have been applied. See
295 "List of properties associated to the whole document.
296 Any keyword in this list will have its value parsed and stored as
310 ;; Ignore all links excepted plain links in a link description.
311 ;; Also ignore radio-targets and line breaks.
315 ;; Remove any variable object from radio target as it would
316 ;; prevent it from being properly recognized.
321 ;; Ignore inline babel call and inline src block as formulas are
322 ;; possible. Also ignore line breaks and statistics cookies.
328 "Alist of objects restrictions.
330 CAR is an element or object type containing objects and CDR is
331 a list of successors that will be called within an element or
332 object of such type.
334 For example, in a `radio-target' object, one can only find
335 entities, latex-fragments, subscript and superscript.
337 This alist also applies to secondary string. For example, an
338 `headline' type element doesn't directly contain objects, but
349 "List of buffer-local variables used when parsing objects.
350 These variables are copied to the temporary buffer created by
354 \f
355 ;;; Accessors and Setters
356 ;;
357 ;; Provide four accessors: `org-element-type', `org-element-property'
358 ;; `org-element-contents' and `org-element-restriction'.
359 ;;
360 ;; Setter functions allow to modify elements by side effect. There is
361 ;; `org-element-put-property', `org-element-set-contents',
362 ;; `org-element-set-element' and `org-element-adopt-element'. Note
363 ;; that `org-element-set-element' and `org-element-adopt-elements' are
364 ;; higher level functions since also update `:parent' property.
367 "Return type of ELEMENT.
369 The function returns the type of the element or object provided.
370 It can also return the following special value:
371 `plain-text' for a string
372 `org-data' for a complete document
373 nil in any other case."
379 "Extract the value from the PROPERTY of an ELEMENT."
384 "Extract contents from an ELEMENT."
390 "Return restriction associated to ELEMENT.
391 ELEMENT can be an element, an object or a symbol representing an
392 element or object type."
394 org-element-object-restrictions)))
397 "In ELEMENT set PROPERTY to VALUE.
398 Return modified element."
401 element))
404 "Set ELEMENT contents to CONTENTS.
405 Return modified element."
412 "Replace element or object OLD with element or object NEW.
413 The function takes care of setting `:parent' property for NEW."
414 ;; Since OLD is going to be changed into NEW by side-effect, first
415 ;; make sure that every element or object within NEW has OLD as
416 ;; parent.
419 ;; Transfer contents.
421 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
422 ;; with NEW's.
425 ;; Transfer type.
429 "Append elements to the contents of another element.
431 PARENT is an element or object. CHILDREN can be elements,
432 objects, or a strings.
434 The function takes care of setting `:parent' property for CHILD.
435 Return parent element."
436 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
437 ;; string: parent is the list itself.
440 children)
441 ;; Add CHILDREN at the end of PARENT contents.
444 parent
446 ;; Return modified PARENT element.
450 \f
451 ;;; Greater elements
452 ;;
453 ;; For each greater element type, we define a parser and an
454 ;; interpreter.
455 ;;
456 ;; A parser returns the element or object as the list described above.
457 ;; Most of them accepts no argument. Though, exceptions exist. Hence
458 ;; every element containing a secondary string (see
459 ;; `org-element-secondary-value-alist') will accept an optional
460 ;; argument to toggle parsing of that secondary string. Moreover,
461 ;; `item' parser requires current list's structure as its first
462 ;; element.
463 ;;
464 ;; An interpreter accepts two arguments: the list representation of
465 ;; the element or object, and its contents. The latter may be nil,
466 ;; depending on the element or object considered. It returns the
467 ;; appropriate Org syntax, as a string.
468 ;;
469 ;; Parsing functions must follow the naming convention:
470 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
471 ;; defined in `org-element-greater-elements'.
472 ;;
473 ;; Similarly, interpreting functions must follow the naming
474 ;; convention: org-element-TYPE-interpreter.
475 ;;
476 ;; With the exception of `headline' and `item' types, greater elements
477 ;; cannot contain other greater elements of their own type.
478 ;;
479 ;; Beside implementing a parser and an interpreter, adding a new
480 ;; greater element requires to tweak `org-element--current-element'.
481 ;; Moreover, the newly defined type must be added to both
482 ;; `org-element-all-elements' and `org-element-greater-elements'.
485 ;;;; Center Block
488 "Parse a center block.
490 LIMIT bounds the search. AFFILIATED is a list of which CAR is
491 the buffer position at the beginning of the first affiliated
492 keyword and CDR is a plist of affiliated keywords along with
493 their value.
495 Return a list whose CAR is `center-block' and CDR is a plist
496 containing `:begin', `:end', `:hiddenp', `:contents-begin',
497 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
499 Assume point is at the beginning of the block."
503 ;; Incomplete block: parse it as a paragraph.
508 ;; Empty blocks have no contents.
523 :end end
524 :hiddenp hidden
525 :contents-begin contents-begin
526 :contents-end contents-end
532 "Interpret CENTER-BLOCK element as Org syntax.
533 CONTENTS is the contents of the element."
537 ;;;; Drawer
540 "Parse a drawer.
542 LIMIT bounds the search. AFFILIATED is a list of which CAR is
543 the buffer position at the beginning of the first affiliated
544 keyword and CDR is a plist of affiliated keywords along with
545 their value.
547 Return a list whose CAR is `drawer' and CDR is a plist containing
548 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
549 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
551 Assume point is at beginning of drawer."
554 ;; Incomplete drawer: parse it as a paragraph.
562 ;; Empty drawers have no contents.
577 :end end
578 :drawer-name name
579 :hiddenp hidden
580 :contents-begin contents-begin
581 :contents-end contents-end
587 "Interpret DRAWER element as Org syntax.
588 CONTENTS is the contents of the element."
591 contents))
594 ;;;; Dynamic Block
597 "Parse a dynamic block.
599 LIMIT bounds the search. AFFILIATED is a list of which CAR is
600 the buffer position at the beginning of the first affiliated
601 keyword and CDR is a plist of affiliated keywords along with
602 their value.
604 Return a list whose CAR is `dynamic-block' and CDR is a plist
605 containing `:block-name', `:begin', `:end', `:hiddenp',
606 `:contents-begin', `:contents-end', `:arguments', `:post-blank'
607 and `:post-affiliated' keywords.
609 Assume point is at beginning of dynamic block."
613 ;; Incomplete block: parse it as a paragraph.
622 ;; Empty blocks have no contents.
637 :end end
638 :block-name name
639 :arguments arguments
640 :hiddenp hidden
641 :contents-begin contents-begin
642 :contents-end contents-end
648 "Interpret DYNAMIC-BLOCK element as Org syntax.
649 CONTENTS is the contents of the element."
654 contents))
657 ;;;; Footnote Definition
660 "Parse a footnote definition.
662 LIMIT bounds the search. AFFILIATED is a list of which CAR is
663 the buffer position at the beginning of the first affiliated
664 keyword and CDR is a plist of affiliated keywords along with
665 their value.
667 Return a list whose CAR is `footnote-definition' and CDR is
668 a plist containing `:label', `:begin' `:end', `:contents-begin',
669 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
671 Assume point is at the beginning of the footnote definition."
697 :begin begin
698 :end end
699 :contents-begin contents-begin
700 :contents-end contents-end
706 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
707 CONTENTS is the contents of the footnote-definition."
709 " "
710 contents))
713 ;;;; Headline
716 "Parse a headline.
718 Return a list whose CAR is `headline' and CDR is a plist
719 containing `:raw-value', `:title', `:alt-title', `:begin',
720 `:end', `:pre-blank', `:hiddenp', `:contents-begin' and
721 `:contents-end', `:level', `:priority', `:tags',
722 `:todo-keyword',`:todo-type', `:scheduled', `:deadline',
723 `:closed', `:quotedp', `:archivedp', `:commentedp' and
724 `:footnote-section-p' keywords.
726 The plist also contains any property set in the property drawer,
727 with its name in upper cases and colons added at the
728 beginning (i.e. `:CUSTOM_ID').
730 When RAW-SECONDARY-P is non-nil, headline's title will not be
731 parsed as a secondary string, but as a plain string instead.
733 Assume point is at beginning of the headline."
746 raw-value)))
750 raw-value)))
754 ;; Upcase property names. It avoids confusion between
755 ;; properties obtained through property drawer and default
756 ;; properties from the parser (e.g. `:end' and :END:)
766 plist))
768 ;; Read time properties on the line below the headline.
774 org-keyword-time-not-clock-regexp end t)
784 plist))))
797 ;; Clean RAW-VALUE from any quote or comment string.
805 ""
806 raw-value))))
807 ;; Clean TAGS from archive tag, if any.
813 :begin begin
814 :end end
815 :pre-blank
818 :hiddenp hidden
819 :contents-begin contents-begin
820 :contents-end contents-end
821 :level level
823 :tags tags
824 :todo-keyword todo
825 :todo-type todo-type
831 end)
832 :footnote-section-p footnote-section-p
833 :archivedp archivedp
834 :commentedp commentedp
836 time-props
837 standard-props))))
841 headline :alt-title
846 headline :title
852 "Interpret HEADLINE element as Org syntax.
853 CONTENTS is the contents of the element."
880 ;; Align tags.
888 ? )
889 tags))
893 tags))))
895 contents)))
898 ;;;; Inlinetask
901 "Parse an inline task.
903 Return a list whose CAR is `inlinetask' and CDR is a plist
904 containing `:title', `:begin', `:end', `:hiddenp',
905 `:contents-begin' and `:contents-end', `:level', `:priority',
906 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
907 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
909 The plist also contains any property set in the property drawer,
910 with its name in upper cases and colons added at the
911 beginning (i.e. `:CUSTOM_ID').
913 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
914 title will not be parsed as a secondary string, but as a plain
915 string instead.
917 Assume point is at beginning of the inline task."
927 ;; Upcase property names. It avoids confusion between
928 ;; properties obtained through property drawer and default
929 ;; properties from the parser (e.g. `:end' and :END:)
939 plist))
941 ;; Read time properties on the line below the inlinetask
942 ;; opening string.
948 org-keyword-time-not-clock-regexp end t)
958 plist))))
978 :begin begin
979 :end end
980 :hiddenp hidden
981 :contents-begin contents-begin
982 :contents-end contents-end
985 :tags tags
986 :todo-keyword todo
987 :todo-type todo-type
989 time-props
990 standard-props))))
992 inlinetask :title
995 raw-value
997 inlinetask))))))
1000 "Interpret INLINETASK element as Org syntax.
1001 CONTENTS is the contents of inlinetask."
1016 ;; Align tags.
1024 ? )
1025 tags))
1029 tags))))
1030 ;; Prefer degenerate inlinetasks when there are no
1031 ;; contents.
1034 contents
1038 ;;;; Item
1041 "Parse an item.
1043 STRUCT is the structure of the plain list.
1045 Return a list whose CAR is `item' and CDR is a plist containing
1046 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1047 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1048 `:post-blank' keywords.
1050 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1051 any, will not be parsed as a secondary string, but as a plain
1052 string instead.
1054 Assume point is at the beginning of the item."
1078 ;; Ignore tags in un-ordered lists: they are just
1079 ;; a part of item's body.
1085 ;; If first line isn't empty, contents really start
1086 ;; at the text after item's meta-data.
1097 :begin begin
1098 :end end
1099 ;; CONTENTS-BEGIN and CONTENTS-END may be
1100 ;; mixed up in the case of an empty item
1101 ;; separated from the next by a blank line.
1102 ;; Thus ensure the former is always the
1103 ;; smallest.
1106 :checkbox checkbox
1107 :counter counter
1108 :hiddenp hidden
1109 :structure struct
1112 item :tag
1120 "Interpret ITEM element as Org syntax.
1121 CONTENTS is the contents of the element."
1131 ;; Compute indentation.
1136 ;; Indent contents.
1138 bullet
1152 ;;;; Plain List
1155 ;; Return structure of list at point. Internal function. See
1156 ;; `org-list-struct' for details.
1164 items struct)
1169 ;; At limit: end all items.
1178 ;; At list end: end all items.
1183 ;; At a new item: end previous sibling.
1195 ind
1196 bullet
1199 ;; Description tag.
1203 ;; Ending position, unknown so far.
1204 nil)))
1205 items))
1207 ;; Skip empty lines.
1209 ;; Skip inline tasks and blank lines along the way.
1216 ;; At some text line. Check if it ends any previous item.
1228 ;; Skip blocks (any type) and drawers contents.
1233 limit t)))
1239 "Parse a plain list.
1241 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1242 the buffer position at the beginning of the first affiliated
1243 keyword and CDR is a plist of affiliated keywords along with
1244 their value. STRUCTURE is the structure of the plain list being
1245 parsed.
1247 Return a list whose CAR is `plain-list' and CDR is a plist
1248 containing `:type', `:begin', `:end', `:contents-begin' and
1249 `:contents-end', `:structure', `:post-blank' and
1250 `:post-affiliated' keywords.
1252 Assume point is at the beginning of the list."
1265 ;; Return value.
1269 :begin begin
1270 :end end
1271 :contents-begin contents-begin
1272 :contents-end contents-end
1273 :structure struct
1279 "Interpret PLAIN-LIST element as Org syntax.
1280 CONTENTS is the contents of the element."
1288 ;;;; Property Drawer
1291 "Parse a property drawer.
1293 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1294 the buffer position at the beginning of the first affiliated
1295 keyword and CDR is a plist of affiliated keywords along with
1296 their value.
1298 Return a list whose CAR is `property-drawer' and CDR is a plist
1299 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1300 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1302 Assume point is at the beginning of the property drawer."
1307 ;; Incomplete drawer: parse it as a paragraph.
1327 :end end
1328 :hiddenp hidden
1329 :contents-begin contents-begin
1330 :contents-end contents-end
1336 "Interpret PROPERTY-DRAWER element as Org syntax.
1337 CONTENTS is the properties within the drawer."
1341 ;;;; Quote Block
1344 "Parse a quote block.
1346 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1347 the buffer position at the beginning of the first affiliated
1348 keyword and CDR is a plist of affiliated keywords along with
1349 their value.
1351 Return a list whose CAR is `quote-block' and CDR is a plist
1352 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1353 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1355 Assume point is at the beginning of the block."
1359 ;; Incomplete block: parse it as a paragraph.
1365 ;; Empty blocks have no contents.
1380 :end end
1381 :hiddenp hidden
1382 :contents-begin contents-begin
1383 :contents-end contents-end
1389 "Interpret QUOTE-BLOCK element as Org syntax.
1390 CONTENTS is the contents of the element."
1394 ;;;; Section
1397 "Parse a section.
1399 LIMIT bounds the search.
1401 Return a list whose CAR is `section' and CDR is a plist
1402 containing `:begin', `:end', `:contents-begin', `contents-end'
1403 and `:post-blank' keywords."
1405 ;; Beginning of section is the beginning of the first non-blank
1406 ;; line after previous headline.
1415 :end end
1416 :contents-begin begin
1417 :contents-end pos-before-blank
1421 "Interpret SECTION element as Org syntax.
1422 CONTENTS is the contents of the element."
1423 contents)
1426 ;;;; Special Block
1429 "Parse a special block.
1431 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1432 the buffer position at the beginning of the first affiliated
1433 keyword and CDR is a plist of affiliated keywords along with
1434 their value.
1436 Return a list whose CAR is `special-block' and CDR is a plist
1437 containing `:type', `:begin', `:end', `:hiddenp',
1438 `:contents-begin', `:contents-end', `:post-blank' and
1439 `:post-affiliated' keywords.
1441 Assume point is at the beginning of the block."
1448 limit t)))
1449 ;; Incomplete block: parse it as a paragraph.
1455 ;; Empty blocks have no contents.
1470 :begin begin
1471 :end end
1472 :hiddenp hidden
1473 :contents-begin contents-begin
1474 :contents-end contents-end
1480 "Interpret SPECIAL-BLOCK element as Org syntax.
1481 CONTENTS is the contents of the element."
1486 \f
1487 ;;; Elements
1488 ;;
1489 ;; For each element, a parser and an interpreter are also defined.
1490 ;; Both follow the same naming convention used for greater elements.
1491 ;;
1492 ;; Also, as for greater elements, adding a new element type is done
1493 ;; through the following steps: implement a parser and an interpreter,
1494 ;; tweak `org-element--current-element' so that it recognizes the new
1495 ;; type and add that new type to `org-element-all-elements'.
1496 ;;
1497 ;; As a special case, when the newly defined type is a block type,
1498 ;; `org-element-block-name-alist' has to be modified accordingly.
1501 ;;;; Babel Call
1504 "Parse a babel call.
1506 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1507 the buffer position at the beginning of the first affiliated
1508 keyword and CDR is a plist of affiliated keywords along with
1509 their value.
1511 Return a list whose CAR is `babel-call' and CDR is a plist
1512 containing `:begin', `:end', `:info', `:post-blank' and
1513 `:post-affiliated' as keywords."
1527 :end end
1528 :info info
1534 "Interpret BABEL-CALL element as Org syntax.
1535 CONTENTS is nil."
1541 ;; Remove redundant square brackets.
1546 ;;;; Clock
1549 "Parse a clock.
1551 LIMIT bounds the search.
1553 Return a list whose CAR is `clock' and CDR is a plist containing
1554 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1555 as keywords."
1575 :value value
1576 :duration duration
1577 :begin begin
1578 :end end
1582 "Interpret CLOCK element as Org syntax.
1583 CONTENTS is nil."
1591 "%2s:%02s"
1595 ;;;; Comment
1598 "Parse a comment.
1600 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1601 the buffer position at the beginning of the first affiliated
1602 keyword and CDR is a plist of affiliated keywords along with
1603 their value.
1605 Return a list whose CAR is `comment' and CDR is a plist
1606 containing `:begin', `:end', `:value', `:post-blank',
1607 `:post-affiliated' keywords.
1609 Assume point is at comment beginning."
1618 ;; Get comments ending.
1621 ;; Accumulate lines without leading hash and first
1622 ;; whitespace.
1637 :end end
1638 :value value
1644 "Interpret COMMENT element as Org syntax.
1645 CONTENTS is nil."
1649 ;;;; Comment Block
1652 "Parse an export block.
1654 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1655 the buffer position at the beginning of the first affiliated
1656 keyword and CDR is a plist of affiliated keywords along with
1657 their value.
1659 Return a list whose CAR is `comment-block' and CDR is a plist
1660 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1661 and `:post-affiliated' keywords.
1663 Assume point is at comment block beginning."
1667 ;; Incomplete block: parse it as a paragraph.
1682 contents-begin contents-end)))
1686 :end end
1687 :value value
1688 :hiddenp hidden
1694 "Interpret COMMENT-BLOCK element as Org syntax.
1695 CONTENTS is nil."
1700 ;;;; Diary Sexp
1703 "Parse a diary sexp.
1705 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1706 the buffer position at the beginning of the first affiliated
1707 keyword and CDR is a plist of affiliated keywords along with
1708 their value.
1710 Return a list whose CAR is `diary-sexp' and CDR is a plist
1711 containing `:begin', `:end', `:value', `:post-blank' and
1712 `:post-affiliated' keywords."
1725 :begin begin
1726 :end end
1732 "Interpret DIARY-SEXP as Org syntax.
1733 CONTENTS is nil."
1737 ;;;; Example Block
1740 "Remove maximum common indentation in string S and return it.
1741 When optional argument N is a positive integer, remove exactly
1742 that much characters from indentation, if possible, or return
1743 S as-is otherwise. Unlike to `org-remove-indentation', this
1744 function doesn't call `untabify' on S."
1749 ;; Find maximum common indentation, if not specified.
1757 min-ind)))
1759 ;; Remove exactly N indentation, but give up if not possible.
1769 "Parse an example block.
1771 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1772 the buffer position at the beginning of the first affiliated
1773 keyword and CDR is a plist of affiliated keywords along with
1774 their value.
1776 Return a list whose CAR is `example-block' and CDR is a plist
1777 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1778 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1779 `:switches', `:value', `:post-blank' and `:post-affiliated'
1780 keywords."
1784 ;; Incomplete block: parse it as a paragraph.
1792 ;; Switches analysis
1800 ;; Should labels be retained in (or stripped from) example
1801 ;; blocks?
1806 ;; What should code-references use - labels or
1807 ;; line-numbers?
1816 ;; Standard block parsing.
1825 contents-begin contents-end))
1836 :end end
1837 :value value
1838 :switches switches
1839 :number-lines number-lines
1840 :preserve-indent preserve-indent
1841 :retain-labels retain-labels
1842 :use-labels use-labels
1843 :label-fmt label-fmt
1844 :hiddenp hidden
1850 "Interpret EXAMPLE-BLOCK element as Org syntax.
1851 CONTENTS is nil."
1859 ;;;; Export Block
1862 "Parse an export block.
1864 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1865 the buffer position at the beginning of the first affiliated
1866 keyword and CDR is a plist of affiliated keywords along with
1867 their value.
1869 Return a list whose CAR is `export-block' and CDR is a plist
1870 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1871 `:post-blank' and `:post-affiliated' keywords.
1873 Assume point is at export-block beginning."
1880 ;; Incomplete block: parse it as a paragraph.
1895 contents-end)))
1899 :end end
1900 :type type
1901 :value value
1902 :hiddenp hidden
1908 "Interpret EXPORT-BLOCK element as Org syntax.
1909 CONTENTS is nil."
1916 ;;;; Fixed-width
1919 "Parse a fixed-width section.
1921 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1922 the buffer position at the beginning of the first affiliated
1923 keyword and CDR is a plist of affiliated keywords along with
1924 their value.
1926 Return a list whose CAR is `fixed-width' and CDR is a plist
1927 containing `:begin', `:end', `:value', `:post-blank' and
1928 `:post-affiliated' keywords.
1930 Assume point is at the beginning of the fixed-width area."
1934 value
1939 ;; Accumulate text without starting colons.
1953 :end end
1954 :value value
1960 "Interpret FIXED-WIDTH element as Org syntax.
1961 CONTENTS is nil."
1969 ;;;; Horizontal Rule
1972 "Parse an horizontal rule.
1974 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1975 the buffer position at the beginning of the first affiliated
1976 keyword and CDR is a plist of affiliated keywords along with
1977 their value.
1979 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1980 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1981 keywords."
1992 :end end
1998 "Interpret HORIZONTAL-RULE element as Org syntax.
1999 CONTENTS is nil."
2003 ;;;; Keyword
2006 "Parse a keyword at point.
2008 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2009 the buffer position at the beginning of the first affiliated
2010 keyword and CDR is a plist of affiliated keywords along with
2011 their value.
2013 Return a list whose CAR is `keyword' and CDR is a plist
2014 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2015 `:post-affiliated' keywords."
2030 :value value
2031 :begin begin
2032 :end end
2038 "Interpret KEYWORD element as Org syntax.
2039 CONTENTS is nil."
2045 ;;;; Latex Environment
2048 "Parse a LaTeX environment.
2050 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2051 the buffer position at the beginning of the first affiliated
2052 keyword and CDR is a plist of affiliated keywords along with
2053 their value.
2055 Return a list whose CAR is `latex-environment' and CDR is a plist
2056 containing `:begin', `:end', `:value', `:post-blank' and
2057 `:post-affiliated' keywords.
2059 Assume point is at the beginning of the latex environment."
2066 limit t))
2067 ;; Incomplete latex environment: parse it as a paragraph.
2078 :end end
2079 :value value
2085 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2086 CONTENTS is nil."
2090 ;;;; Node Property
2093 "Parse a node-property at point.
2095 LIMIT bounds the search.
2097 Return a list whose CAR is `node-property' and CDR is a plist
2098 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2099 keywords."
2111 :value value
2112 :begin begin
2113 :end end
2117 "Interpret NODE-PROPERTY element as Org syntax.
2118 CONTENTS is nil."
2124 ;;;; Paragraph
2127 "Parse a paragraph.
2129 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2130 the buffer position at the beginning of the first affiliated
2131 keyword and CDR is a plist of affiliated keywords along with
2132 their value.
2134 Return a list whose CAR is `paragraph' and CDR is a plist
2135 containing `:begin', `:end', `:contents-begin' and
2136 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2138 Assume point is at the beginning of the paragraph."
2147 limit
2148 ;; A matching `org-element-paragraph-separate' is not
2149 ;; necessarily the end of the paragraph. In
2150 ;; particular, lines starting with # or : as a first
2151 ;; non-space character are ambiguous. We have check
2152 ;; if they are valid Org syntax (i.e. not an
2153 ;; incomplete keyword).
2157 ;; There's no ambiguity for other symbols or
2158 ;; empty lines: stop here.
2160 ;; Stop at valid fixed-width areas.
2162 ;; Stop at drawers.
2167 ;; Stop at valid comments.
2169 ;; Stop at valid dynamic blocks.
2174 ;; Stop at valid blocks.
2181 limit t)))
2182 ;; Stop at valid latex environments.
2189 limit t)))
2190 ;; Stop at valid keywords.
2192 ;; Skip everything else.
2210 :end end
2211 :contents-begin contents-begin
2212 :contents-end contents-end
2218 "Interpret PARAGRAPH element as Org syntax.
2219 CONTENTS is the contents of the element."
2220 contents)
2223 ;;;; Planning
2226 "Parse a planning.
2228 LIMIT bounds the search.
2230 Return a list whose CAR is `planning' and CDR is a plist
2231 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2232 and `:post-blank' keywords."
2242 closed deadline scheduled)
2254 :deadline deadline
2255 :scheduled scheduled
2256 :begin begin
2257 :end end
2261 "Interpret PLANNING element as Org syntax.
2262 CONTENTS is nil."
2264 'identity
2281 ;;;; Quote Section
2284 "Parse a quote section.
2286 LIMIT bounds the search.
2288 Return a list whose CAR is `quote-section' and CDR is a plist
2289 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2291 Assume point is at beginning of the section."
2302 :end end
2303 :value value
2307 "Interpret QUOTE-SECTION element as Org syntax.
2308 CONTENTS is nil."
2312 ;;;; Src Block
2315 "Parse a src block.
2317 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2318 the buffer position at the beginning of the first affiliated
2319 keyword and CDR is a plist of affiliated keywords along with
2320 their value.
2322 Return a list whose CAR is `src-block' and CDR is a plist
2323 containing `:language', `:switches', `:parameters', `:begin',
2324 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2325 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2326 `:post-blank' and `:post-affiliated' keywords.
2328 Assume point is at the beginning of the block."
2331 limit t)))
2332 ;; Incomplete block: parse it as a paragraph.
2338 ;; Get language as a string.
2347 ;; Get switches.
2349 ;; Get parameters.
2351 ;; Switches analysis
2363 ;; Should labels be retained in (or stripped from)
2364 ;; src blocks?
2369 ;; What should code-references use - labels or
2370 ;; line-numbers?
2375 ;; Indentation.
2377 ;; Get visibility status.
2379 ;; Retrieve code.
2388 ;; Get position after ending blank lines.
2399 :begin begin
2400 :end end
2401 :number-lines number-lines
2402 :preserve-indent preserve-indent
2403 :retain-labels retain-labels
2404 :use-labels use-labels
2405 :label-fmt label-fmt
2406 :hiddenp hidden
2407 :value value
2413 "Interpret SRC-BLOCK element as Org syntax.
2414 CONTENTS is nil."
2435 ;;;; Table
2438 "Parse a table at point.
2440 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2441 the buffer position at the beginning of the first affiliated
2442 keyword and CDR is a plist of affiliated keywords along with
2443 their value.
2445 Return a list whose CAR is `table' and CDR is a plist containing
2446 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2447 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2448 keywords.
2450 Assume point is at the beginning of the table."
2464 acc))
2472 :end end
2473 :type type
2474 :tblfm tblfm
2475 ;; Only `org' tables have contents. `table.el' tables
2476 ;; use a `:value' property to store raw table as
2477 ;; a string.
2482 table-begin table-end))
2488 "Interpret TABLE element as Org syntax.
2489 CONTENTS is nil."
2500 ;;;; Table Row
2503 "Parse table row at point.
2505 LIMIT bounds the search.
2507 Return a list whose CAR is `table-row' and CDR is a plist
2508 containing `:begin', `:end', `:contents-begin', `:contents-end',
2509 `:type' and `:post-blank' keywords."
2513 ;; A table rule has no contents. In that case, ensure
2514 ;; CONTENTS-BEGIN matches CONTENTS-END.
2526 :begin begin
2527 :end end
2528 :contents-begin contents-begin
2529 :contents-end contents-end
2533 "Interpret TABLE-ROW element as Org syntax.
2534 CONTENTS is the contents of the table row."
2539 ;;;; Verse Block
2542 "Parse a verse block.
2544 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2545 the buffer position at the beginning of the first affiliated
2546 keyword and CDR is a plist of affiliated keywords along with
2547 their value.
2549 Return a list whose CAR is `verse-block' and CDR is a plist
2550 containing `:begin', `:end', `:contents-begin', `:contents-end',
2551 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2553 Assume point is at beginning of the block."
2557 ;; Incomplete block: parse it as a paragraph.
2574 :end end
2575 :contents-begin contents-begin
2576 :contents-end contents-end
2577 :hiddenp hidden
2583 "Interpret VERSE-BLOCK element as Org syntax.
2584 CONTENTS is verse block contents."
2588 \f
2589 ;;; Objects
2590 ;;
2591 ;; Unlike to elements, interstices can be found between objects.
2592 ;; That's why, along with the parser, successor functions are provided
2593 ;; for each object. Some objects share the same successor (i.e. `code'
2594 ;; and `verbatim' objects).
2595 ;;
2596 ;; A successor must accept a single argument bounding the search. It
2597 ;; will return either a cons cell whose CAR is the object's type, as
2598 ;; a symbol, and CDR the position of its next occurrence, or nil.
2599 ;;
2600 ;; Successors follow the naming convention:
2601 ;; org-element-NAME-successor, where NAME is the name of the
2602 ;; successor, as defined in `org-element-all-successors'.
2603 ;;
2604 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2605 ;; object types they can contain will be specified in
2606 ;; `org-element-object-restrictions'.
2607 ;;
2608 ;; Adding a new type of object is simple. Implement a successor,
2609 ;; a parser, and an interpreter for it, all following the naming
2610 ;; convention. Register type in `org-element-all-objects' and
2611 ;; successor in `org-element-all-successors'. Maybe tweak
2612 ;; restrictions about it, and that's it.
2615 ;;;; Bold
2618 "Parse bold object at point.
2620 Return a list whose CAR is `bold' and CDR is a plist with
2621 `:begin', `:end', `:contents-begin' and `:contents-end' and
2622 `:post-blank' keywords.
2624 Assume point is at the first star marker."
2636 :end end
2637 :contents-begin contents-begin
2638 :contents-end contents-end
2642 "Interpret BOLD object as Org syntax.
2643 CONTENTS is the contents of the object."
2647 "Search for the next text-markup object.
2649 Return value is a cons cell whose CAR is a symbol among `bold',
2650 `italic', `underline', `strike-through', `code' and `verbatim'
2651 and CDR is beginning position."
2667 ;;;; Code
2670 "Parse code object at point.
2672 Return a list whose CAR is `code' and CDR is a plist with
2673 `:value', `:begin', `:end' and `:post-blank' keywords.
2675 Assume point is at the first tilde marker."
2686 :begin begin
2687 :end end
2691 "Interpret CODE object as Org syntax.
2692 CONTENTS is nil."
2696 ;;;; Entity
2699 "Parse entity at point.
2701 Return a list whose CAR is `entity' and CDR a plist with
2702 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2703 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2704 keywords.
2706 Assume point is at the beginning of the entity."
2708 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2724 :begin begin
2725 :end end
2726 :use-brackets-p bracketsp
2730 "Interpret ENTITY object as Org syntax.
2731 CONTENTS is nil."
2737 "Search for the next latex-fragment or entity object.
2739 Return value is a cons cell whose CAR is `entity' or
2740 `latex-fragment' and CDR is beginning position."
2745 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2752 nil t)
2755 ;; Determine if it's a real entity or a LaTeX command.
2758 ;; No entity nor command: point is at a LaTeX fragment.
2759 ;; Determine its type to get the correct beginning position.
2767 matchers)
2771 ;;;; Export Snippet
2774 "Parse export snippet at point.
2776 Return a list whose CAR is `export-snippet' and CDR a plist with
2777 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2778 keywords.
2780 Assume point is at the beginning of the snippet."
2792 :value value
2793 :begin begin
2794 :end end
2798 "Interpret EXPORT-SNIPPET object as Org syntax.
2799 CONTENTS is nil."
2805 "Search for the next export-snippet object.
2807 Return value is a cons cell whose CAR is `export-snippet' and CDR
2808 its beginning position."
2817 ;;;; Footnote Reference
2820 "Parse footnote reference at point.
2822 Return a list whose CAR is `footnote-reference' and CDR a plist
2823 with `:label', `:type', `:inline-definition', `:begin', `:end'
2824 and `:post-blank' as keywords."
2846 :type type
2847 :begin begin
2848 :end end
2851 footnote-reference :inline-definition
2856 footnote-reference))))))
2859 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2860 CONTENTS is nil."
2870 "Search for the next footnote-reference object.
2872 Return value is a cons cell whose CAR is `footnote-reference' and
2873 CDR is beginning position."
2887 ;;;; Inline Babel Call
2890 "Parse inline babel call at point.
2892 Return a list whose CAR is `inline-babel-call' and CDR a plist
2893 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2895 Assume point is at the beginning of the babel call."
2906 :end end
2907 :info info
2911 "Interpret INLINE-BABEL-CALL object as Org syntax.
2912 CONTENTS is nil."
2918 ;; Remove redundant square brackets.
2921 main-source)
2925 "Search for the next inline-babel-call object.
2927 Return value is a cons cell whose CAR is `inline-babel-call' and
2928 CDR is beginning position."
2930 ;; Use a simplified version of
2931 ;; `org-babel-inline-lob-one-liner-regexp'.
2934 nil t)
2938 ;;;; Inline Src Block
2941 "Parse inline source block at point.
2943 Return a list whose CAR is `inline-src-block' and CDR a plist
2944 with `:begin', `:end', `:language', `:value', `:parameters' and
2945 `:post-blank' as keywords.
2947 Assume point is at the beginning of the inline src block."
2960 :value value
2961 :parameters parameters
2962 :begin begin
2963 :end end
2967 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2968 CONTENTS is nil."
2973 language
2975 body)))
2978 "Search for the next inline-babel-call element.
2980 Return value is a cons cell whose CAR is `inline-babel-call' and
2981 CDR is beginning position."
2987 ;;;; Italic
2990 "Parse italic object at point.
2992 Return a list whose CAR is `italic' and CDR is a plist with
2993 `:begin', `:end', `:contents-begin' and `:contents-end' and
2994 `:post-blank' keywords.
2996 Assume point is at the first slash marker."
3008 :end end
3009 :contents-begin contents-begin
3010 :contents-end contents-end
3014 "Interpret ITALIC object as Org syntax.
3015 CONTENTS is the contents of the object."
3019 ;;;; Latex Fragment
3022 "Parse latex fragment at point.
3024 Return a list whose CAR is `latex-fragment' and CDR a plist with
3025 `:value', `:begin', `:end', and `:post-blank' as keywords.
3027 Assume point is at the beginning of the latex fragment."
3041 ;; None found: it's a macro.
3050 :begin begin
3051 :end end
3055 "Interpret LATEX-FRAGMENT object as Org syntax.
3056 CONTENTS is nil."
3059 ;;;; Line Break
3062 "Parse line break at point.
3064 Return a list whose CAR is `line-break', and CDR a plist with
3065 `:begin', `:end' and `:post-blank' keywords.
3067 Assume point is at the beginning of the line break."
3074 "Interpret LINE-BREAK object as Org syntax.
3075 CONTENTS is nil."
3079 "Search for the next line-break object.
3081 Return value is a cons cell whose CAR is `line-break' and CDR is
3082 beginning position."
3086 ;; A line break can only happen on a non-empty line.
3091 ;;;; Link
3094 "Parse link at point.
3096 Return a list whose CAR is `link' and CDR a plist with `:type',
3097 `:path', `:raw-link', `:application', `:search-option', `:begin',
3098 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3099 keywords.
3101 Assume point is at the beginning of the link."
3104 end contents-begin contents-end link-end post-blank path type
3105 raw-link link search-option application)
3107 ;; Type 1: Text targeted from a radio target.
3112 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3117 ;; RAW-LINK is the original link. Expand any
3118 ;; abbreviation in it.
3122 ;; Determine TYPE of link and set PATH accordingly.
3124 ;; File type.
3128 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3131 ;; Id type: PATH is the id.
3134 ;; Code-ref type: PATH is the name of the reference.
3137 ;; Custom-id type: PATH is the name of the custom id.
3140 ;; Fuzzy type: Internal link either matches a target, an
3141 ;; headline name or nothing. PATH is the target or
3142 ;; headline's name.
3144 ;; Type 3: Plain link, i.e. http://orgmode.org
3150 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3157 ;; In any case, deduce end point after trailing white space from
3158 ;; LINK-END variable.
3161 ;; Extract search option and opening application out of
3162 ;; "file"-type links.
3164 ;; Application.
3169 ;; Extract search option from PATH.
3173 ;; Make sure TYPE always reports "file".
3177 :path path
3179 :application application
3180 :search-option search-option
3181 :begin begin
3182 :end end
3183 :contents-begin contents-begin
3184 :contents-end contents-end
3188 "Interpret LINK object as Org syntax.
3189 CONTENTS is the contents of the object, or nil."
3194 raw-link
3198 "Search for the next link object.
3200 Return value is a cons cell whose CAR is `link' and CDR is
3201 beginning position."
3210 "Search for the next plain link object.
3212 Return value is a cons cell whose CAR is `link' and CDR is
3213 beginning position."
3218 ;;;; Macro
3221 "Parse macro at point.
3223 Return a list whose CAR is `macro' and CDR a plist with `:key',
3224 `:args', `:begin', `:end', `:value' and `:post-blank' as
3225 keywords.
3227 Assume point is at the macro."
3238 ;; Do not use `org-split-string' since empty
3239 ;; strings are meaningful here.
3247 args nil t)
3251 :value value
3252 :args args
3253 :begin begin
3254 :end end
3258 "Interpret MACRO object as Org syntax.
3259 CONTENTS is nil."
3263 "Search for the next macro object.
3265 Return value is cons cell whose CAR is `macro' and CDR is
3266 beginning position."
3270 nil t)
3274 ;;;; Radio-target
3277 "Parse radio target at point.
3279 Return a list whose CAR is `radio-target' and CDR a plist with
3280 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3281 and `:post-blank' as keywords.
3283 Assume point is at the radio target."
3295 :end end
3296 :contents-begin contents-begin
3297 :contents-end contents-end
3298 :post-blank post-blank
3302 "Interpret TARGET object as Org syntax.
3303 CONTENTS is the contents of the object."
3307 "Search for the next radio-target object.
3309 Return value is a cons cell whose CAR is `radio-target' and CDR
3310 is beginning position."
3316 ;;;; Statistics Cookie
3319 "Parse statistics cookie at point.
3321 Return a list whose CAR is `statistics-cookie', and CDR a plist
3322 with `:begin', `:end', `:value' and `:post-blank' keywords.
3324 Assume point is at the beginning of the statistics-cookie."
3335 :end end
3336 :value value
3340 "Interpret STATISTICS-COOKIE object as Org syntax.
3341 CONTENTS is nil."
3345 "Search for the next statistics cookie object.
3347 Return value is a cons cell whose CAR is `statistics-cookie' and
3348 CDR is beginning position."
3354 ;;;; Strike-Through
3357 "Parse strike-through object at point.
3359 Return a list whose CAR is `strike-through' and CDR is a plist
3360 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3361 `:post-blank' keywords.
3363 Assume point is at the first plus sign marker."
3375 :end end
3376 :contents-begin contents-begin
3377 :contents-end contents-end
3381 "Interpret STRIKE-THROUGH object as Org syntax.
3382 CONTENTS is the contents of the object."
3386 ;;;; Subscript
3389 "Parse subscript at point.
3391 Return a list whose CAR is `subscript' and CDR a plist with
3392 `:begin', `:end', `:contents-begin', `:contents-end',
3393 `:use-brackets-p' and `:post-blank' as keywords.
3395 Assume point is at the underscore."
3399 t
3410 :end end
3411 :use-brackets-p bracketsp
3412 :contents-begin contents-begin
3413 :contents-end contents-end
3417 "Interpret SUBSCRIPT object as Org syntax.
3418 CONTENTS is the contents of the object."
3421 contents))
3424 "Search for the next sub/superscript object.
3426 Return value is a cons cell whose CAR is either `subscript' or
3427 `superscript' and CDR is beginning position."
3435 ;;;; Superscript
3438 "Parse superscript at point.
3440 Return a list whose CAR is `superscript' and CDR a plist with
3441 `:begin', `:end', `:contents-begin', `:contents-end',
3442 `:use-brackets-p' and `:post-blank' as keywords.
3444 Assume point is at the caret."
3458 :end end
3459 :use-brackets-p bracketsp
3460 :contents-begin contents-begin
3461 :contents-end contents-end
3465 "Interpret SUPERSCRIPT object as Org syntax.
3466 CONTENTS is the contents of the object."
3469 contents))
3472 ;;;; Table Cell
3475 "Parse table cell at point.
3477 Return a list whose CAR is `table-cell' and CDR is a plist
3478 containing `:begin', `:end', `:contents-begin', `:contents-end'
3479 and `:post-blank' keywords."
3487 :end end
3488 :contents-begin contents-begin
3489 :contents-end contents-end
3493 "Interpret TABLE-CELL element as Org syntax.
3494 CONTENTS is the contents of the cell, or nil."
3498 "Search for the next table-cell object.
3500 Return value is a cons cell whose CAR is `table-cell' and CDR is
3501 beginning position."
3505 ;;;; Target
3508 "Parse target at point.
3510 Return a list whose CAR is `target' and CDR a plist with
3511 `:begin', `:end', `:value' and `:post-blank' as keywords.
3513 Assume point is at the target."
3523 :end end
3524 :value value
3528 "Interpret TARGET object as Org syntax.
3529 CONTENTS is nil."
3533 "Search for the next target object.
3535 Return value is a cons cell whose CAR is `target' and CDR is
3536 beginning position."
3542 ;;;; Timestamp
3545 "Parse time stamp at point.
3547 Return a list whose CAR is `timestamp', and CDR a plist with
3548 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3550 Assume point is at the beginning of the timestamp."
3568 date-start)
3579 raw-value)
3581 :repeater-type
3587 :repeater-unit
3590 year-start month-start day-start hour-start minute-start year-end
3591 month-end day-end hour-end minute-end)
3592 ;; Parse date-start.
3600 ;; Compute date-end. It can be provided directly in time-stamp,
3601 ;; or extracted from time range. Otherwise, it defaults to the
3602 ;; same values as date-start.
3612 :raw-value raw-value
3613 :year-start year-start
3614 :month-start month-start
3615 :day-start day-start
3616 :hour-start hour-start
3617 :minute-start minute-start
3618 :year-end year-end
3619 :month-end month-end
3620 :day-end day-end
3621 :hour-end hour-end
3622 :minute-end minute-end
3623 :begin begin
3624 :end end
3626 repeater-props)))))
3629 "Interpret TIMESTAMP object as Org syntax.
3630 CONTENTS is nil."
3631 ;; Use `:raw-value' if specified.
3633 ;; Otherwise, build timestamp string.
3643 ;; Build an Org timestamp string from TIME. ACTIVEP is
3644 ;; non-nil when time stamp is active. If WITH-TIME-P is
3645 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3646 ;; specify a time range in the timestamp. REPEAT-STRING
3647 ;; is the repeater string, if any.
3651 org-time-stamp-formats)
3652 time)))
3658 nil nil ts)))
3662 " "
3663 repeat-string
3665 ;; Return value.
3666 ts)))
3678 build-ts-string
3697 0
3705 "--"
3717 "Search for the next timestamp object.
3719 Return value is a cons cell whose CAR is `timestamp' and CDR is
3720 beginning position."
3728 nil t)
3732 ;;;; Underline
3735 "Parse underline object at point.
3737 Return a list whose CAR is `underline' and CDR is a plist with
3738 `:begin', `:end', `:contents-begin' and `:contents-end' and
3739 `:post-blank' keywords.
3741 Assume point is at the first underscore marker."
3753 :end end
3754 :contents-begin contents-begin
3755 :contents-end contents-end
3759 "Interpret UNDERLINE object as Org syntax.
3760 CONTENTS is the contents of the object."
3764 ;;;; Verbatim
3767 "Parse verbatim object at point.
3769 Return a list whose CAR is `verbatim' and CDR is a plist with
3770 `:value', `:begin', `:end' and `:post-blank' keywords.
3772 Assume point is at the first equal sign marker."
3783 :begin begin
3784 :end end
3788 "Interpret VERBATIM object as Org syntax.
3789 CONTENTS is nil."
3793 \f
3794 ;;; Parsing Element Starting At Point
3795 ;;
3796 ;; `org-element--current-element' is the core function of this section.
3797 ;; It returns the Lisp representation of the element starting at
3798 ;; point.
3799 ;;
3800 ;; `org-element--current-element' makes use of special modes. They
3801 ;; are activated for fixed element chaining (i.e. `plain-list' >
3802 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3803 ;; `section'). Special modes are: `first-section', `item',
3804 ;; `node-property', `quote-section', `section' and `table-row'.
3808 "Parse the element starting at point.
3810 Return value is a list like (TYPE PROPS) where TYPE is the type
3811 of the element and PROPS a plist of properties associated to the
3812 element.
3814 Possible types are defined in `org-element-all-elements'.
3816 LIMIT bounds the search.
3818 Optional argument GRANULARITY determines the depth of the
3819 recursion. Allowed values are `headline', `greater-element',
3820 `element', `object' or nil. When it is broader than `object' (or
3821 nil), secondary values will not be parsed, since they only
3822 contain objects.
3824 Optional argument SPECIAL, when non-nil, can be either
3825 `first-section', `item', `node-property', `quote-section',
3826 `section', and `table-row'.
3828 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3829 be computed.
3831 This function assumes point is always at the beginning of the
3832 element it has to parse."
3835 ;; Determine if parsing depth allows for secondary strings
3836 ;; parsing. It only applies to elements referenced in
3837 ;; `org-element-secondary-value-alist'.
3840 ;; Item.
3843 ;; Table Row.
3845 ;; Node Property.
3847 ;; Headline.
3850 ;; Sections (must be checked after headline).
3856 limit)))
3857 ;; When not at bol, point is at the beginning of an item or
3858 ;; a footnote definition: next item is always a paragraph.
3860 ;; Planning and Clock.
3865 ;; Inlinetask.
3868 ;; From there, elements can have affiliated keywords.
3871 ;; Jumping over affiliated keywords put point off-limits.
3872 ;; Parse them as regular keywords.
3876 ;; LaTeX Environment.
3880 ;; Drawer and Property Drawer.
3885 ;; Fixed Width
3888 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3889 ;; Keywords.
3898 org-element-block-name-alist)))
3913 ;; Footnote Definition.
3916 ;; Horizontal Rule.
3919 ;; Diary Sexp.
3922 ;; Table.
3924 ;; List.
3927 limit affiliated
3929 ;; Default element: Paragraph.
3933 ;; Most elements can have affiliated keywords. When looking for an
3934 ;; element beginning, we want to move before them, as they belong to
3935 ;; that element, and, in the meantime, collect information they give
3936 ;; into appropriate properties. Hence the following function.
3939 "Collect affiliated keywords from point down to LIMIT.
3941 Return a list whose CAR is the position at the first of them and
3942 CDR a plist of keywords and values and move point to the
3943 beginning of the first line after them.
3945 As a special case, if element doesn't start at the beginning of
3946 the line (i.e. a paragraph starting an item), CAR is current
3947 position of point and CDR is nil."
3951 ;; RESTRICT is the list of objects allowed in parsed
3952 ;; keywords value.
3954 output)
3957 ;; Apply translation to RAW-KWD. From there, KWD is
3958 ;; the official keyword.
3960 org-element-keyword-translation-alist))
3961 raw-kwd))
3962 ;; Find main value for any keyword.
3968 ;; PARSEDP is non-nil when keyword should have its
3969 ;; value parsed.
3971 ;; If KWD is a dual keyword, find its secondary
3972 ;; value. Maybe parse it.
3979 ;; Attribute a property name to KWD.
3981 ;; Now set final shape for VALUE.
3987 ;; Attributes can always appear on multiple lines.
3990 ;; Eventually store the new value in OUTPUT.
3992 ;; Move to next keyword.
3994 ;; If affiliated keywords are orphaned: move back to first one.
3995 ;; They will be parsed as a paragraph.
3997 ;; Return value.
4001 \f
4002 ;;; The Org Parser
4003 ;;
4004 ;; The two major functions here are `org-element-parse-buffer', which
4005 ;; parses Org syntax inside the current buffer, taking into account
4006 ;; region, narrowing, or even visibility if specified, and
4007 ;; `org-element-parse-secondary-string', which parses objects within
4008 ;; a given string.
4009 ;;
4010 ;; The (almost) almighty `org-element-map' allows to apply a function
4011 ;; on elements or objects matching some type, and accumulate the
4012 ;; resulting values. In an export situation, it also skips unneeded
4013 ;; parts of the parse tree.
4016 "Recursively parse the buffer and return structure.
4017 If narrowing is in effect, only parse the visible part of the
4018 buffer.
4020 Optional argument GRANULARITY determines the depth of the
4021 recursion. It can be set to the following symbols:
4023 `headline' Only parse headlines.
4024 `greater-element' Don't recurse into greater elements excepted
4025 headlines and sections. Thus, elements
4026 parsed are the top-level ones.
4027 `element' Parse everything but objects and plain text.
4028 `object' Parse the complete buffer (default).
4030 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4031 elements.
4033 An element or an objects is represented as a list with the
4034 pattern (TYPE PROPERTIES CONTENTS), where :
4036 TYPE is a symbol describing the element or object. See
4037 `org-element-all-elements' and `org-element-all-objects' for an
4038 exhaustive list of such symbols. One can retrieve it with
4039 `org-element-type' function.
4041 PROPERTIES is the list of attributes attached to the element or
4042 object, as a plist. Although most of them are specific to the
4043 element or object type, all types share `:begin', `:end',
4044 `:post-blank' and `:parent' properties, which respectively
4045 refer to buffer position where the element or object starts,
4046 ends, the number of white spaces or blank lines after it, and
4047 the element or object containing it. Properties values can be
4048 obtained by using `org-element-property' function.
4050 CONTENTS is a list of elements, objects or raw strings
4051 contained in the current element or object, when applicable.
4052 One can access them with `org-element-contents' function.
4054 The Org buffer has `org-data' as type and nil as properties.
4055 `org-element-map' function can be used to find specific elements
4056 or objects within the parse tree.
4058 This function assumes that current major mode is `org-mode'."
4064 ;; Start in `first-section' mode so text before the first
4065 ;; headline belongs to a section.
4069 "Recursively parse objects in STRING and return structure.
4071 RESTRICTION is a symbol limiting the object types that will be
4072 looked after.
4074 Optional argument PARENT, when non-nil, is the element or object
4075 containing the secondary string. It is used to set correctly
4076 `:parent' property within the string."
4077 ;; Copy buffer-local variables listed in
4078 ;; `org-element-object-variables' into temporary buffer. This is
4079 ;; required since object parsing is dependent on these variables.
4083 org-element-object-variables))))
4091 secondary))
4092 secondary))))
4096 "Map a function on selected elements or objects.
4098 DATA is a parse tree, an element, an object, a string, or a list
4099 of such constructs. TYPES is a symbol or list of symbols of
4100 elements or objects types (see `org-element-all-elements' and
4101 `org-element-all-objects' for a complete list of types). FUN is
4102 the function called on the matching element or object. It has to
4103 accept one argument: the element or object itself.
4105 When optional argument INFO is non-nil, it should be a plist
4106 holding export options. In that case, parts of the parse tree
4107 not exportable according to that property list will be skipped.
4109 When optional argument FIRST-MATCH is non-nil, stop at the first
4110 match for which FUN doesn't return nil, and return that value.
4112 Optional argument NO-RECURSION is a symbol or a list of symbols
4113 representing elements or objects types. `org-element-map' won't
4114 enter any recursive element or object whose type belongs to that
4115 list. Though, FUN can still be applied on them.
4117 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4118 apply to matching objects within parsed affiliated keywords (see
4119 `org-element-parsed-keywords').
4121 Nil values returned from FUN do not appear in the results.
4124 Examples:
4125 ---------
4127 Assuming TREE is a variable containing an Org buffer parse tree,
4128 the following example will return a flat list of all `src-block'
4129 and `example-block' elements in it:
4131 \(org-element-map tree '(example-block src-block) 'identity)
4133 The following snippet will find the first headline with a level
4136 \(org-element-map tree 'headline
4137 \(lambda (hl)
4138 \(and (= (org-element-property :level hl) 1)
4140 \(org-element-property :begin hl)))
4141 nil t)
4143 The next example will return a flat list of all `plain-list' type
4144 elements in TREE that are not a sub-list themselves:
4146 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4148 Eventually, this example will return a flat list of all `bold'
4149 type objects containing a `latex-snippet' type object, even
4150 looking into captions:
4152 \(org-element-map tree 'bold
4153 \(lambda (b)
4154 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4155 nil nil nil t)"
4156 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4159 ;; Recursion depth is determined by --CATEGORY.
4166 ;; If one object is found, the function
4167 ;; has to recurse into every object.
4170 ;; If one regular element is found, the
4171 ;; function has to recurse, at least,
4172 ;; into every element it encounters.
4175 types)
4176 category)))
4177 ;; Compute properties for affiliated keywords if necessary.
4182 org-element-affiliated-keywords)))
4183 --acc
4184 --walk-tree
4188 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4189 ;; holding contextual information.
4193 ;; Ignored element in an export context.
4195 ;; List of elements or objects.
4197 ;; Unconditionally enter parse trees.
4201 ;; Check if TYPE is matching among TYPES. If so,
4202 ;; apply FUN to --DATA and accumulate return value
4203 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4209 ;; If --DATA has a secondary string that can contain
4210 ;; objects with their type among TYPES, look into it.
4217 ;; If --DATA has any affiliated keywords and
4218 ;; WITH-AFFILIATED is non-nil, look for objects in
4219 ;; them.
4227 ;; Pay attention to the type of value.
4228 ;; Preserve order for multiple keywords.
4244 --affiliated-alist))
4245 ;; Determine if a recursion into --DATA is possible.
4247 ;; --TYPE is explicitly removed from recursion.
4249 ;; --DATA has no contents.
4251 ;; Looking for greater elements but --DATA is simply
4252 ;; an element or an object.
4255 ;; Looking for elements but --DATA is an object.
4258 ;; In any other case, map contents.
4262 ;; Return value in a proper order.
4266 ;; The following functions are internal parts of the parser.
4267 ;;
4268 ;; The first one, `org-element--parse-elements' acts at the element's
4269 ;; level.
4270 ;;
4271 ;; The second one, `org-element--parse-objects' applies on all objects
4272 ;; of a paragraph or a secondary string. It uses
4273 ;; `org-element--get-next-object-candidates' to optimize the search of
4274 ;; the next object in the buffer.
4275 ;;
4276 ;; More precisely, that function looks for every allowed object type
4277 ;; first. Then, it discards failed searches, keeps further matches,
4278 ;; and searches again types matched behind point, for subsequent
4279 ;; calls. Thus, searching for a given type fails only once, and every
4280 ;; object is searched only once at top level (but sometimes more for
4281 ;; nested types).
4285 "Parse elements between BEG and END positions.
4287 SPECIAL prioritize some elements over the others. It can be set
4288 to `first-section', `quote-section', `section' `item' or
4289 `table-row'.
4291 When value is `item', STRUCTURE will be used as the current list
4292 structure.
4294 GRANULARITY determines the depth of the recursion. See
4295 `org-element-parse-buffer' for more information.
4297 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4298 elements.
4300 Elements are accumulated into ACC."
4303 ;; Visible only: skip invisible parts at the beginning of the
4304 ;; element.
4307 ;; When parsing only headlines, skip any text before first one.
4310 ;; Main loop start.
4312 ;; Find current element's type and parse it accordingly to
4313 ;; its category.
4315 end granularity special structure))
4319 ;; Visible only: skip invisible parts between siblings.
4322 ;; Fill ELEMENT contents by side-effect.
4324 ;; If element has no contents, don't modify it.
4326 ;; Greater element: parse it between `contents-begin' and
4327 ;; `contents-end'. Make sure GRANULARITY allows the
4328 ;; recursion, or ELEMENT is a headline, in which case going
4329 ;; inside is mandatory, in order to get sub-level headings.
4337 ;; Possibly switch to a special mode.
4347 granularity visible-only element))
4348 ;; ELEMENT has contents. Parse objects inside, if
4349 ;; GRANULARITY allows it.
4355 ;; Return result.
4356 acc))
4359 "Parse objects between BEG and END and return recursive structure.
4361 Objects are accumulated in ACC.
4363 RESTRICTION is a list of object successors which are allowed in
4364 the current object."
4373 restriction candidates)))
4380 ;; 1. Text before any object. Untabify it.
4385 acc
4389 ;; 2. Object...
4392 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4393 ;; a recursive type.
4401 ;; 3. Text after last object. Untabify it.
4405 acc
4409 ;; Result.
4410 acc))))
4413 "Return an alist of candidates for the next object.
4415 RESTRICTION is a list of object types, as symbols. Only
4416 candidates with such types are looked after.
4418 OBJECTS is the previous candidates alist. If it is set to
4419 `initial', no search has been done before, and all symbols in
4420 RESTRICTION should be looked after.
4422 Return value is an alist whose CAR is the object type and CDR its
4423 beginning position."
4425 nil
4427 ;; When searching for the first time, look for every successor
4428 ;; allowed in RESTRICTION.
4432 restriction)
4433 ;; Focus on objects returned during last search. Keep those
4434 ;; still after point. Search again objects before it.
4440 type)))
4443 objects))))
4446 \f
4447 ;;; Towards A Bijective Process
4448 ;;
4449 ;; The parse tree obtained with `org-element-parse-buffer' is really
4450 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4451 ;; interpreted and expanded into a string with canonical Org syntax.
4452 ;; Hence `org-element-interpret-data'.
4453 ;;
4454 ;; The function relies internally on
4455 ;; `org-element--interpret-affiliated-keywords'.
4457 ;;;###autoload
4459 "Interpret DATA as Org syntax.
4461 DATA is a parse tree, an element, an object or a secondary string
4462 to interpret.
4464 Optional argument PARENT is used for recursive calls. It contains
4465 the element or object containing data, or nil.
4467 Return Org syntax as a string."
4471 ;; Secondary string.
4476 ;; Full Org document.
4481 ;; Plain text: remove `:parent' text property from output.
4483 ;; Element/Object without contents.
4486 data nil))
4487 ;; Element/Object with contents.
4497 ;; Elements directly containing objects must
4498 ;; have their indentation normalized first.
4500 data
4501 ;; When normalizing first paragraph of an
4502 ;; item or a footnote-definition, ignore
4503 ;; first line's indentation.
4510 data
4512 contents)))))))
4514 ;; Build white spaces. If no `:post-blank' property is
4515 ;; specified, assume its value is 0.
4525 "Return ELEMENT's affiliated keywords as Org syntax.
4526 If there is no affiliated keyword, return the empty string."
4536 ": "
4539 value)
4547 ;; All attribute keywords can have multiple lines.
4553 ;; List all ELEMENT's properties matching an attribute line or an
4554 ;; affiliated keyword, but ignore translated keywords since they
4555 ;; cannot belong to the property list.
4562 org-element-keyword-translation-alist)))))
4563 collect prop)
4566 ;; Because interpretation of the parse tree must return the same
4567 ;; number of blank lines between elements and the same number of white
4568 ;; space after objects, some special care must be given to white
4569 ;; spaces.
4570 ;;
4571 ;; The first function, `org-element-normalize-string', ensures any
4572 ;; string different from the empty string will end with a single
4573 ;; newline character.
4574 ;;
4575 ;; The second function, `org-element-normalize-contents', removes
4576 ;; global indentation from the contents of the current element.
4579 "Ensure string S ends with a single newline character.
4581 If S isn't a string return it unchanged. If S is the empty
4582 string, return it. Otherwise, return a new string with a single
4583 newline character at its end."
4591 "Normalize plain text in ELEMENT's contents.
4593 ELEMENT must only contain plain text and objects.
4595 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4596 indentation to compute maximal common indentation.
4598 Return the normalized element that is element with global
4599 indentation removed from its contents. The function assumes that
4600 indentation is not done with TAB characters."
4602 collect-inds ; for byte-compiler
4605 ;; Return list of indentations within BLOB. This is done by
4606 ;; walking recursively BLOB and updating IND-LIST along the
4607 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4608 ;; been seen yet. It is required as this string is the only
4609 ;; one whose indentation doesn't happen after a newline
4610 ;; character.
4618 ;; An indentation of zero means no string will be
4619 ;; modified. Quit the process.
4625 ;; Avoid matching blank or empty lines.
4633 ;; Collect indentation list in ELEMENT. Possibly remove first
4634 ;; value if IGNORE-FIRST is non-nil.
4637 ;; Build ELEMENT back, replacing each string with the same
4638 ;; string minus common indentation.
4643 ;; Return BLOB with all its strings indentation
4644 ;; shortened from MCI white spaces. FIRST-FLAG is
4645 ;; non-nil when the first string hasn't been seen
4646 ;; yet.
4660 org-element-recursive-objects)
4664 blob))))
4668 \f
4669 ;;; The Toolbox
4670 ;;
4671 ;; The first move is to implement a way to obtain the smallest element
4672 ;; containing point. This is the job of `org-element-at-point'. It
4673 ;; basically jumps back to the beginning of section containing point
4674 ;; and moves, element after element, with
4675 ;; `org-element--current-element' until the container is found. Note:
4676 ;; When using `org-element-at-point', secondary values are never
4677 ;; parsed since the function focuses on elements, not on objects.
4678 ;;
4679 ;; At a deeper level, `org-element-context' lists all elements and
4680 ;; objects containing point.
4681 ;;
4682 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4683 ;; internally by navigation and manipulation tools.
4685 ;;;###autoload
4687 "Determine closest element around point.
4689 Return value is a list like (TYPE PROPS) where TYPE is the type
4690 of the element and PROPS a plist of properties associated to the
4691 element.
4693 Possible types are defined in `org-element-all-elements'.
4694 Properties depend on element or object type, but always include
4695 `:begin', `:end', `:parent' and `:post-blank' properties.
4697 As a special case, if point is at the very beginning of a list or
4698 sub-list, returned element will be that list instead of the first
4699 item. In the same way, if point is at the beginning of the first
4700 row of a table, returned element will be the table instead of the
4701 first row.
4703 If optional argument KEEP-TRAIL is non-nil, the function returns
4704 a list of elements leading to element at point. The list's CAR
4705 is always the element at point. The following positions contain
4706 element's siblings, then parents, siblings of parents, until the
4707 first element of current section."
4709 ;; If at a headline, parse it. It is the sole element that
4710 ;; doesn't require to know about context. Be sure to disallow
4711 ;; secondary string parsing, though.
4717 ;; Otherwise move at the beginning of the section containing
4718 ;; point.
4723 element type special-flag trail struct prevs parent)
4726 ;; In empty lines at buffer's beginning, return nil.
4735 ;; In blank lines just after the headline, point still
4736 ;; belongs to the headline.
4744 ;; Parse successively each element, skipping those ending
4745 ;; before original position.
4753 ;; 1. Skip any element ending before point. Also skip
4754 ;; element ending at point when we're sure that another
4755 ;; element has started.
4760 ;; 2. An element containing point is always the element at
4761 ;; point.
4764 ;; 3. At any other greater element type, if point is
4765 ;; within contents, move into it.
4770 ;; Create an anchor for tables and plain lists:
4771 ;; when point is at the very beginning of these
4772 ;; elements, ignoring affiliated keywords,
4773 ;; target them instead of their contents.
4775 ;; When point is at contents end, do not move
4776 ;; into elements with an explicit ending, but
4777 ;; return that element instead.
4781 drawer dynamic-block inlinetask item
4782 plain-list property-drawer quote-block
4783 special-block))))
4798 ;;;###autoload
4800 "Return closest element or object around point.
4802 Return value is a list like (TYPE PROPS) where TYPE is the type
4803 of the element or object and PROPS a plist of properties
4804 associated to it.
4806 Possible types are defined in `org-element-all-elements' and
4807 `org-element-all-objects'. Properties depend on element or
4808 object type, but always include `:begin', `:end', `:parent' and
4809 `:post-blank'.
4811 Optional argument ELEMENT, when non-nil, is the closest element
4812 containing point, as returned by `org-element-at-point'.
4813 Providing it allows for quicker computation."
4819 context)
4820 ;; Check if point is inside an element containing objects or at
4821 ;; a secondary string. In that case, narrow buffer to the
4822 ;; containing area. Otherwise, return ELEMENT.
4824 ;; At a parsed affiliated keyword, check if we're inside main
4825 ;; or dual value.
4840 ;; Also change type to retrieve correct restrictions.
4842 ;; At an item, objects can only be located within tag, if any.
4852 ;; At an headline or inlinetask, objects are located within
4853 ;; their title.
4860 ;; At a paragraph, a table-row or a verse block, objects are
4861 ;; located within their contents.
4865 ;; CBEG is nil for table rules.
4869 ;; At a parsed keyword, objects are located within value.
4872 org-element-document-properties))
4887 restriction candidates))
4889 candidates)))
4890 ;; If ORIGIN is before next object in element, there's
4891 ;; no point in looking further.
4901 ;; ORIGIN is after OBJECT, so skip it.
4903 ;; ORIGIN is within a non-recursive object or at
4904 ;; an object boundaries: Return that object.
4908 ;; Otherwise, move within current object and
4909 ;; restrict search to the end of its contents.
4916 parent))))))
4919 "Non-nil when elements ELEM-A and ELEM-B are nested."
4928 "Swap elements ELEM-A and ELEM-B.
4929 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4930 end of ELEM-A."
4932 ;; There are two special cases when an element doesn't start at bol:
4933 ;; the first paragraph in an item or in a footnote definition.
4935 ;; Only a paragraph without any affiliated keyword can be moved at
4936 ;; ELEM-A position in such a situation. Note that the case of
4937 ;; a footnote definition is impossible: it cannot contain two
4938 ;; paragraphs in a row because it cannot contain a blank line.
4944 ;; In a special situation, ELEM-A will have no indentation. We'll
4945 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4959 ;; Store overlays responsible for visibility status. We
4960 ;; also need to store their boundaries as they will be
4961 ;; removed from buffer.
4968 ;; Get contents.
4976 ;; Restore ex ELEM-A overlays.
4985 ;; Restore ex ELEM-B overlays.
4994 ;; Local variables:
4995 ;; generated-autoload-file: "org-loaddefs.el"
4996 ;; End:
4998 ;;; org-element.el ends here