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/>.
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
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.
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.
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'.
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
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'.
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.
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.
82 ;; At the lowest level, a `:parent' property is also attached to any
83 ;; string, as a text property.
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
91 ;; CONTENTS is a list of elements, objects or raw strings contained
92 ;; in the current element or object, when applicable.
94 ;; An Org buffer is a nested list of such elements and objects, whose
95 ;; type is `org-data' and properties is nil.
97 ;; The first part of this file defines Org syntax, while the second
98 ;; one provide accessors and setters functions.
100 ;; The next part implements a parser and an interpreter for each
101 ;; element and object type in Org syntax.
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'.
109 ;; The penultimate part is the cradle of an interpreter for the
110 ;; obtained parse tree: `org-element-interpret-data'.
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'.
119 (eval-when-compile (require 'cl
))
124 ;;; Definitions And Rules
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.
130 ;; These variables really act as a control center for the parsing
133 (defconst org-element-paragraph-separate
135 ;; Headlines, inlinetasks.
136 org-outline-regexp
"\\|"
137 ;; Footnote definitions.
138 "\\[\\(?:[0-9]+\\|fn:[-_[:word:]]+\\)\\]" "\\|"
144 ;; Tables (any type).
145 "\\(?:|\\|\\+-[-+]\\)" "\\|"
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.
151 "-\\{5,\\}[ \t]*$" "\\|"
152 ;; LaTeX environments.
153 "\\\\begin{\\([A-Za-z0-9]+\\*?\\)}" "\\|"
154 ;; Planning and Clock lines.
155 (regexp-opt (list org-scheduled-string
161 (let ((term (case org-plain-list-ordered-item-terminator
162 (?\
) ")") (?.
"\\.") (otherwise "[.)]")))
163 (alpha (and org-list-allow-alphabetical
"\\|[A-Za-z]")))
164 (concat "\\(?:[-+*]\\|\\(?:[0-9]+" alpha
"\\)" term
"\\)"
165 "\\(?:[ \t]\\|$\\)"))
167 "Regexp to separate paragraphs in an Org buffer.
168 In the case of lines starting with \"#\" and \":\", this regexp
169 is not sufficient to know if point is at a paragraph ending. See
170 `org-element-paragraph-parser' for more information.")
172 (defconst org-element-all-elements
173 '(babel-call center-block clock comment comment-block diary-sexp drawer
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
)
179 "Complete list of element types.")
181 (defconst org-element-greater-elements
182 '(center-block drawer dynamic-block footnote-definition headline inlinetask
183 item plain-list property-drawer quote-block section
185 "List of recursive element types aka Greater Elements.")
187 (defconst org-element-all-successors
188 '(export-snippet footnote-reference inline-babel-call inline-src-block
189 latex-or-entity line-break link macro plain-link radio-target
190 statistics-cookie sub
/superscript table-cell target
191 text-markup timestamp
)
192 "Complete list of successors.")
194 (defconst org-element-object-successor-alist
195 '((subscript . sub
/superscript
) (superscript . sub
/superscript
)
196 (bold . text-markup
) (code . text-markup
) (italic . text-markup
)
197 (strike-through . text-markup
) (underline . text-markup
)
198 (verbatim . text-markup
) (entity . latex-or-entity
)
199 (latex-fragment . latex-or-entity
))
200 "Alist of translations between object type and successor name.
201 Sharing the same successor comes handy when, for example, the
202 regexp matching one object can also match the other object.")
204 (defconst org-element-all-objects
205 '(bold code entity export-snippet footnote-reference inline-babel-call
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
)
209 "Complete list of object types.")
211 (defconst org-element-recursive-objects
212 '(bold italic link subscript radio-target strike-through superscript
213 table-cell underline
)
214 "List of recursive object types.")
216 (defvar org-element-block-name-alist
217 '(("CENTER" . org-element-center-block-parser
)
218 ("COMMENT" . org-element-comment-block-parser
)
219 ("EXAMPLE" . org-element-example-block-parser
)
220 ("QUOTE" . org-element-quote-block-parser
)
221 ("SRC" . org-element-src-block-parser
)
222 ("VERSE" . org-element-verse-block-parser
))
223 "Alist between block names and the associated parsing function.
224 Names must be uppercase. Any block whose name has no association
225 is parsed with `org-element-special-block-parser'.")
227 (defconst org-element-link-type-is-file
228 '("file" "file+emacs" "file+sys" "docview")
229 "List of link types equivalent to \"file\".
230 Only these types can accept search options and an explicit
231 application to open them.")
233 (defconst org-element-affiliated-keywords
234 '("CAPTION" "DATA" "HEADER" "HEADERS" "LABEL" "NAME" "PLOT" "RESNAME" "RESULT"
235 "RESULTS" "SOURCE" "SRCNAME" "TBLNAME")
236 "List of affiliated keywords as strings.
237 By default, all keywords setting attributes (i.e. \"ATTR_LATEX\")
238 are affiliated keywords and need not to be in this list.")
240 (defconst org-element--affiliated-re
241 (format "[ \t]*#\\+%s:"
242 ;; Regular affiliated keywords.
243 (format "\\(%s\\|ATTR_[-_A-Za-z0-9]+\\)\\(?:\\[\\(.*\\)\\]\\)?"
244 (regexp-opt org-element-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
251 Don't modify it, set `org-element-affiliated-keywords' instead.")
253 (defconst org-element-keyword-translation-alist
254 '(("DATA" .
"NAME") ("LABEL" .
"NAME") ("RESNAME" .
"NAME")
255 ("SOURCE" .
"NAME") ("SRCNAME" .
"NAME") ("TBLNAME" .
"NAME")
256 ("RESULT" .
"RESULTS") ("HEADERS" .
"HEADER"))
257 "Alist of usual translations for keywords.
258 The key is the old name and the value the new one. The property
259 holding their value will be named after the translated name.")
261 (defconst org-element-multiple-keywords
'("CAPTION" "HEADER")
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'.
270 By default, all keywords setting attributes (i.e. \"ATTR_LATEX\")
271 allow multiple occurrences and need not to be in this list.")
273 (defconst org-element-parsed-keywords
'("CAPTION")
274 "List of affiliated keywords whose value can be parsed.
276 Their value will be stored as a secondary string: a list of
279 This list is checked after translations have been applied. See
280 `org-element-keyword-translation-alist'.")
282 (defconst org-element-dual-keywords
'("CAPTION" "RESULTS")
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
292 `org-element-keyword-translation-alist'.")
294 (defconst org-element-document-properties
'("AUTHOR" "DATE" "TITLE")
295 "List of properties associated to the whole document.
296 Any keyword in this list will have its value parsed and stored as
297 a secondary string.")
299 (defconst org-element-object-restrictions
301 (remq 'plain-link
(remq 'table-cell org-element-all-successors
)))
302 (standard-set-no-line-break (remq 'line-break standard-set
)))
303 `((bold ,@standard-set
)
304 (footnote-reference ,@standard-set
)
305 (headline ,@standard-set-no-line-break
)
306 (inlinetask ,@standard-set-no-line-break
)
307 (italic ,@standard-set
)
308 (item ,@standard-set-no-line-break
)
309 (keyword ,@standard-set
)
310 ;; Ignore all links excepted plain links in a link description.
311 ;; Also ignore radio-targets and line breaks.
312 (link export-snippet inline-babel-call inline-src-block latex-or-entity
313 macro plain-link statistics-cookie sub
/superscript text-markup
)
314 (paragraph ,@standard-set
)
315 ;; Remove any variable object from radio target as it would
316 ;; prevent it from being properly recognized.
317 (radio-target latex-or-entity sub
/superscript
)
318 (strike-through ,@standard-set
)
319 (subscript ,@standard-set
)
320 (superscript ,@standard-set
)
321 ;; Ignore inline babel call and inline src block as formulas are
322 ;; possible. Also ignore line breaks and statistics cookies.
323 (table-cell export-snippet footnote-reference latex-or-entity link macro
324 radio-target sub
/superscript target text-markup timestamp
)
325 (table-row table-cell
)
326 (underline ,@standard-set
)
327 (verse-block ,@standard-set
)))
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
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
339 still has an entry since one of its properties (`:title') does.")
341 (defconst org-element-secondary-value-alist
342 '((headline .
:title
)
343 (inlinetask .
:title
)
345 (footnote-reference .
:inline-definition
))
346 "Alist between element types and location of secondary value.")
348 (defconst org-element-object-variables
'(org-link-abbrev-alist-local)
349 "List of buffer-local variables used when parsing objects.
350 These variables are copied to the temporary buffer created by
351 `org-export-secondary-string'.")
355 ;;; Accessors and Setters
357 ;; Provide four accessors: `org-element-type', `org-element-property'
358 ;; `org-element-contents' and `org-element-restriction'.
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.
366 (defsubst org-element-type
(element)
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."
375 ((not (consp element
)) (and (stringp element
) 'plain-text
))
376 ((symbolp (car element
)) (car element
))))
378 (defsubst org-element-property
(property element
)
379 "Extract the value from the PROPERTY of an ELEMENT."
380 (if (stringp element
) (get-text-property 0 property element
)
381 (plist-get (nth 1 element
) property
)))
383 (defsubst org-element-contents
(element)
384 "Extract contents from an ELEMENT."
385 (cond ((not (consp element
)) nil
)
386 ((symbolp (car element
)) (nthcdr 2 element
))
389 (defsubst org-element-restriction
(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."
393 (cdr (assq (if (symbolp element
) element
(org-element-type element
))
394 org-element-object-restrictions
)))
396 (defsubst org-element-put-property
(element property value
)
397 "In ELEMENT set PROPERTY to VALUE.
398 Return modified element."
399 (if (stringp element
) (org-add-props element nil property value
)
400 (setcar (cdr element
) (plist-put (nth 1 element
) property value
))
403 (defsubst org-element-set-contents
(element &rest contents
)
404 "Set ELEMENT contents to CONTENTS.
405 Return modified element."
406 (cond ((not element
) (list contents
))
407 ((not (symbolp (car element
))) contents
)
408 ((cdr element
) (setcdr (cdr element
) contents
))
409 (t (nconc element contents
))))
411 (defsubst org-element-set-element
(old new
)
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
417 (mapc (lambda (blob) (org-element-put-property blob
:parent old
))
418 (org-element-contents new
))
419 ;; Transfer contents.
420 (apply 'org-element-set-contents old
(org-element-contents new
))
421 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
423 (org-element-put-property new
:parent
(org-element-property :parent old
))
424 (setcar (cdr old
) (nth 1 new
))
426 (setcar old
(car new
)))
428 (defsubst org-element-adopt-elements
(parent &rest children
)
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.
438 (mapc (lambda (child)
439 (org-element-put-property child
:parent
(or parent children
)))
441 ;; Add CHILDREN at the end of PARENT contents.
443 (apply 'org-element-set-contents
445 (nconc (org-element-contents parent
) children
)))
446 ;; Return modified PARENT element.
447 (or parent children
))
453 ;; For each greater element type, we define a parser and an
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
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.
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'.
473 ;; Similarly, interpreting functions must follow the naming
474 ;; convention: org-element-TYPE-interpreter.
476 ;; With the exception of `headline' and `item' types, greater elements
477 ;; cannot contain other greater elements of their own type.
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'.
487 (defun org-element-center-block-parser (limit affiliated
)
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
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."
500 (let ((case-fold-search t
))
501 (if (not (save-excursion
502 (re-search-forward "^[ \t]*#\\+END_CENTER[ \t]*$" limit t
)))
503 ;; Incomplete block: parse it as a paragraph.
504 (org-element-paragraph-parser limit affiliated
)
505 (let ((block-end-line (match-beginning 0)))
506 (let* ((begin (car affiliated
))
507 (post-affiliated (point))
508 ;; Empty blocks have no contents.
509 (contents-begin (progn (forward-line)
510 (and (< (point) block-end-line
)
512 (contents-end (and contents-begin block-end-line
))
513 (hidden (org-invisible-p2))
514 (pos-before-blank (progn (goto-char block-end-line
)
517 (end (save-excursion (skip-chars-forward " \r\t\n" limit
)
518 (skip-chars-backward " \t")
519 (if (bolp) (point) (line-end-position)))))
525 :contents-begin contents-begin
526 :contents-end contents-end
527 :post-blank
(count-lines pos-before-blank end
)
528 :post-affiliated post-affiliated
)
529 (cdr affiliated
))))))))
531 (defun org-element-center-block-interpreter (center-block contents
)
532 "Interpret CENTER-BLOCK element as Org syntax.
533 CONTENTS is the contents of the element."
534 (format "#+BEGIN_CENTER\n%s#+END_CENTER" contents
))
539 (defun org-element-drawer-parser (limit affiliated
)
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
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."
552 (let ((case-fold-search t
))
553 (if (not (save-excursion (re-search-forward "^[ \t]*:END:[ \t]*$" limit t
)))
554 ;; Incomplete drawer: parse it as a paragraph.
555 (org-element-paragraph-parser limit affiliated
)
557 (let* ((drawer-end-line (match-beginning 0))
558 (name (progn (looking-at org-drawer-regexp
)
559 (org-match-string-no-properties 1)))
560 (begin (car affiliated
))
561 (post-affiliated (point))
562 ;; Empty drawers have no contents.
563 (contents-begin (progn (forward-line)
564 (and (< (point) drawer-end-line
)
566 (contents-end (and contents-begin drawer-end-line
))
567 (hidden (org-invisible-p2))
568 (pos-before-blank (progn (goto-char drawer-end-line
)
571 (end (progn (skip-chars-forward " \r\t\n" limit
)
572 (skip-chars-backward " \t")
573 (if (bolp) (point) (line-end-position)))))
580 :contents-begin contents-begin
581 :contents-end contents-end
582 :post-blank
(count-lines pos-before-blank end
)
583 :post-affiliated post-affiliated
)
584 (cdr affiliated
))))))))
586 (defun org-element-drawer-interpreter (drawer contents
)
587 "Interpret DRAWER element as Org syntax.
588 CONTENTS is the contents of the element."
589 (format ":%s:\n%s:END:"
590 (org-element-property :drawer-name drawer
)
596 (defun org-element-dynamic-block-parser (limit affiliated
)
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
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."
610 (let ((case-fold-search t
))
611 (if (not (save-excursion
612 (re-search-forward "^[ \t]*#\\+END:?[ \t]*$" limit t
)))
613 ;; Incomplete block: parse it as a paragraph.
614 (org-element-paragraph-parser limit affiliated
)
615 (let ((block-end-line (match-beginning 0)))
617 (let* ((name (progn (looking-at org-dblock-start-re
)
618 (org-match-string-no-properties 1)))
619 (arguments (org-match-string-no-properties 3))
620 (begin (car affiliated
))
621 (post-affiliated (point))
622 ;; Empty blocks have no contents.
623 (contents-begin (progn (forward-line)
624 (and (< (point) block-end-line
)
626 (contents-end (and contents-begin block-end-line
))
627 (hidden (org-invisible-p2))
628 (pos-before-blank (progn (goto-char block-end-line
)
631 (end (progn (skip-chars-forward " \r\t\n" limit
)
632 (skip-chars-backward " \t")
633 (if (bolp) (point) (line-end-position)))))
641 :contents-begin contents-begin
642 :contents-end contents-end
643 :post-blank
(count-lines pos-before-blank end
)
644 :post-affiliated post-affiliated
)
645 (cdr affiliated
)))))))))
647 (defun org-element-dynamic-block-interpreter (dynamic-block contents
)
648 "Interpret DYNAMIC-BLOCK element as Org syntax.
649 CONTENTS is the contents of the element."
650 (format "#+BEGIN: %s%s\n%s#+END:"
651 (org-element-property :block-name dynamic-block
)
652 (let ((args (org-element-property :arguments dynamic-block
)))
653 (and args
(concat " " args
)))
657 ;;;; Footnote Definition
659 (defun org-element-footnote-definition-parser (limit affiliated
)
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
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."
673 (let* ((label (progn (looking-at org-footnote-definition-re
)
674 (org-match-string-no-properties 1)))
675 (begin (car affiliated
))
676 (post-affiliated (point))
677 (ending (save-excursion
681 (concat org-outline-regexp-bol
"\\|"
682 org-footnote-definition-re
"\\|"
683 "^\\([ \t]*\n\\)\\{2,\\}") limit
'move
))
686 (contents-begin (progn (search-forward "]")
687 (skip-chars-forward " \r\t\n" ending
)
688 (and (/= (point) ending
) (point))))
689 (contents-end (and contents-begin ending
))
690 (end (progn (goto-char ending
)
691 (skip-chars-forward " \r\t\n" limit
)
692 (skip-chars-backward " \t")
693 (if (bolp) (point) (line-end-position)))))
694 (list 'footnote-definition
699 :contents-begin contents-begin
700 :contents-end contents-end
701 :post-blank
(count-lines ending end
)
702 :post-affiliated post-affiliated
)
703 (cdr affiliated
))))))
705 (defun org-element-footnote-definition-interpreter (footnote-definition contents
)
706 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
707 CONTENTS is the contents of the footnote-definition."
708 (concat (format "[%s]" (org-element-property :label footnote-definition
))
715 (defun org-element-headline-parser (limit &optional raw-secondary-p
)
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."
735 (let* ((components (org-heading-components))
736 (level (nth 1 components
))
737 (todo (nth 2 components
))
739 (and todo
(if (member todo org-done-keywords
) 'done
'todo
)))
740 (tags (let ((raw-tags (nth 5 components
)))
741 (and raw-tags
(org-split-string raw-tags
":"))))
742 (raw-value (or (nth 4 components
) ""))
744 (let ((case-fold-search nil
))
745 (string-match (format "^%s\\( \\|$\\)" org-quote-string
)
748 (let ((case-fold-search nil
))
749 (string-match (format "^%s\\( \\|$\\)" org-comment-string
)
751 (archivedp (member org-archive-tag tags
))
752 (footnote-section-p (and org-footnote-section
753 (string= org-footnote-section 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:)
763 (intern (concat ":" (upcase (car p
))))
765 (org-entry-properties nil
'standard
))
768 ;; Read time properties on the line below the headline.
770 (when (progn (forward-line)
771 (looking-at org-planning-or-clock-line-re
))
772 (let ((end (line-end-position)) plist
)
773 (while (re-search-forward
774 org-keyword-time-not-clock-regexp end t
)
775 (goto-char (match-end 1))
776 (skip-chars-forward " \t")
777 (let ((keyword (match-string 1))
778 (time (org-element-timestamp-parser)))
779 (cond ((equal keyword org-scheduled-string
)
780 (setq plist
(plist-put plist
:scheduled time
)))
781 ((equal keyword org-deadline-string
)
782 (setq plist
(plist-put plist
:deadline time
)))
783 (t (setq plist
(plist-put plist
:closed time
))))))
786 (end (save-excursion (goto-char (org-end-of-subtree t t
))))
787 (pos-after-head (progn (forward-line) (point)))
788 (contents-begin (save-excursion
789 (skip-chars-forward " \r\t\n" end
)
790 (and (/= (point) end
) (line-beginning-position))))
791 (hidden (org-invisible-p2))
792 (contents-end (and contents-begin
793 (progn (goto-char end
)
794 (skip-chars-backward " \r\t\n")
797 ;; Clean RAW-VALUE from any quote or comment string.
798 (when (or quotedp commentedp
)
799 (let ((case-fold-search nil
))
801 (replace-regexp-in-string
803 (regexp-opt (list org-quote-string org-comment-string
))
807 ;; Clean TAGS from archive tag, if any.
808 (when archivedp
(setq tags
(delete org-archive-tag tags
)))
812 (list :raw-value raw-value
816 (if (not contents-begin
) 0
817 (count-lines pos-after-head contents-begin
))
819 :contents-begin contents-begin
820 :contents-end contents-end
822 :priority
(nth 3 components
)
826 :post-blank
(count-lines
827 (if (not contents-end
) pos-after-head
828 (goto-char contents-end
)
832 :footnote-section-p footnote-section-p
834 :commentedp commentedp
838 (let ((alt-title (org-element-property :ALT_TITLE headline
)))
840 (org-element-put-property
842 (if raw-secondary-p alt-title
843 (org-element-parse-secondary-string
844 alt-title
(org-element-restriction 'headline
) headline
)))))
845 (org-element-put-property
847 (if raw-secondary-p raw-value
848 (org-element-parse-secondary-string
849 raw-value
(org-element-restriction 'headline
) headline
)))))))
851 (defun org-element-headline-interpreter (headline contents
)
852 "Interpret HEADLINE element as Org syntax.
853 CONTENTS is the contents of the element."
854 (let* ((level (org-element-property :level headline
))
855 (todo (org-element-property :todo-keyword headline
))
856 (priority (org-element-property :priority headline
))
857 (title (org-element-interpret-data
858 (org-element-property :title headline
)))
859 (tags (let ((tag-list (if (org-element-property :archivedp headline
)
860 (cons org-archive-tag
861 (org-element-property :tags headline
))
862 (org-element-property :tags headline
))))
864 (format ":%s:" (mapconcat 'identity tag-list
":")))))
865 (commentedp (org-element-property :commentedp headline
))
866 (quotedp (org-element-property :quotedp headline
))
867 (pre-blank (or (org-element-property :pre-blank headline
) 0))
868 (heading (concat (make-string level ?
*)
869 (and todo
(concat " " todo
))
870 (and quotedp
(concat " " org-quote-string
))
871 (and commentedp
(concat " " org-comment-string
))
873 (format " [#%s]" (char-to-string priority
)))
874 (cond ((and org-footnote-section
875 (org-element-property
876 :footnote-section-p headline
))
877 (concat " " org-footnote-section
))
878 (title (concat " " title
))))))
883 ((zerop org-tags-column
) (format " %s" tags
))
884 ((< org-tags-column
0)
887 (max (- (+ org-tags-column
(length heading
) (length tags
))) 1)
892 (make-string (max (- org-tags-column
(length heading
)) 1) ?
)
894 (make-string (1+ pre-blank
) 10)
900 (defun org-element-inlinetask-parser (limit &optional raw-secondary-p
)
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
917 Assume point is at beginning of the inline task."
919 (let* ((begin (point))
920 (components (org-heading-components))
921 (todo (nth 2 components
))
923 (if (member todo org-done-keywords
) 'done
'todo
)))
924 (tags (let ((raw-tags (nth 5 components
)))
925 (and raw-tags
(org-split-string raw-tags
":"))))
926 (raw-value (or (nth 4 components
) ""))
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:)
936 (intern (concat ":" (upcase (car p
))))
938 (org-entry-properties nil
'standard
))
941 ;; Read time properties on the line below the inlinetask
944 (when (progn (forward-line)
945 (looking-at org-planning-or-clock-line-re
))
946 (let ((end (line-end-position)) plist
)
947 (while (re-search-forward
948 org-keyword-time-not-clock-regexp end t
)
949 (goto-char (match-end 1))
950 (skip-chars-forward " \t")
951 (let ((keyword (match-string 1))
952 (time (org-element-timestamp-parser)))
953 (cond ((equal keyword org-scheduled-string
)
954 (setq plist
(plist-put plist
:scheduled time
)))
955 ((equal keyword org-deadline-string
)
956 (setq plist
(plist-put plist
:deadline time
)))
957 (t (setq plist
(plist-put plist
:closed time
))))))
959 (task-end (save-excursion
961 (and (re-search-forward "^\\*+ END" limit t
)
962 (match-beginning 0))))
963 (contents-begin (progn (forward-line)
964 (and task-end
(< (point) task-end
) (point))))
965 (hidden (and contents-begin
(org-invisible-p2)))
966 (contents-end (and contents-begin task-end
))
967 (before-blank (if (not task-end
) (point)
971 (end (progn (skip-chars-forward " \r\t\n" limit
)
972 (skip-chars-backward " \t")
973 (if (bolp) (point) (line-end-position))))
977 (list :raw-value raw-value
981 :contents-begin contents-begin
982 :contents-end contents-end
983 :level
(nth 1 components
)
984 :priority
(nth 3 components
)
988 :post-blank
(count-lines before-blank end
))
991 (org-element-put-property
993 (if raw-secondary-p raw-value
994 (org-element-parse-secondary-string
996 (org-element-restriction 'inlinetask
)
999 (defun org-element-inlinetask-interpreter (inlinetask contents
)
1000 "Interpret INLINETASK element as Org syntax.
1001 CONTENTS is the contents of inlinetask."
1002 (let* ((level (org-element-property :level inlinetask
))
1003 (todo (org-element-property :todo-keyword inlinetask
))
1004 (priority (org-element-property :priority inlinetask
))
1005 (title (org-element-interpret-data
1006 (org-element-property :title inlinetask
)))
1007 (tags (let ((tag-list (org-element-property :tags inlinetask
)))
1009 (format ":%s:" (mapconcat 'identity tag-list
":")))))
1010 (task (concat (make-string level ?
*)
1011 (and todo
(concat " " todo
))
1013 (format " [#%s]" (char-to-string priority
)))
1014 (and title
(concat " " title
)))))
1019 ((zerop org-tags-column
) (format " %s" tags
))
1020 ((< org-tags-column
0)
1023 (max (- (+ org-tags-column
(length task
) (length tags
))) 1)
1028 (make-string (max (- org-tags-column
(length task
)) 1) ?
)
1030 ;; Prefer degenerate inlinetasks when there are no
1035 (make-string level ?
*) " END")))))
1040 (defun org-element-item-parser (limit struct
&optional raw-secondary-p
)
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
1054 Assume point is at the beginning of the item."
1057 (looking-at org-list-full-item-re
)
1058 (let* ((begin (point))
1059 (bullet (org-match-string-no-properties 1))
1060 (checkbox (let ((box (org-match-string-no-properties 3)))
1061 (cond ((equal "[ ]" box
) 'off
)
1062 ((equal "[X]" box
) 'on
)
1063 ((equal "[-]" box
) 'trans
))))
1064 (counter (let ((c (org-match-string-no-properties 2)))
1068 ((string-match "[A-Za-z]" c
)
1069 (- (string-to-char (upcase (match-string 0 c
)))
1071 ((string-match "[0-9]+" c
)
1072 (string-to-number (match-string 0 c
)))))))
1073 (end (save-excursion (goto-char (org-list-get-item-end begin struct
))
1074 (unless (bolp) (forward-line))
1078 ;; Ignore tags in un-ordered lists: they are just
1079 ;; a part of item's body.
1080 (if (and (match-beginning 4)
1081 (save-match-data (string-match "[.)]" bullet
)))
1084 (skip-chars-forward " \r\t\n" limit
)
1085 ;; If first line isn't empty, contents really start
1086 ;; at the text after item's meta-data.
1087 (if (= (point-at-bol) begin
) (point) (point-at-bol))))
1088 (hidden (progn (forward-line)
1089 (and (not (= (point) end
)) (org-invisible-p2))))
1090 (contents-end (progn (goto-char end
)
1091 (skip-chars-backward " \r\t\n")
1096 (list :bullet bullet
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
1104 :contents-begin
(min contents-begin contents-end
)
1105 :contents-end
(max contents-begin contents-end
)
1110 :post-blank
(count-lines contents-end end
)))))
1111 (org-element-put-property
1113 (let ((raw-tag (org-list-get-tag begin struct
)))
1115 (if raw-secondary-p raw-tag
1116 (org-element-parse-secondary-string
1117 raw-tag
(org-element-restriction 'item
) item
))))))))
1119 (defun org-element-item-interpreter (item contents
)
1120 "Interpret ITEM element as Org syntax.
1121 CONTENTS is the contents of the element."
1122 (let* ((bullet (let ((bullet (org-element-property :bullet item
)))
1123 (org-list-bullet-string
1124 (cond ((not (string-match "[0-9a-zA-Z]" bullet
)) "- ")
1125 ((eq org-plain-list-ordered-item-terminator ?\
)) "1)")
1127 (checkbox (org-element-property :checkbox item
))
1128 (counter (org-element-property :counter item
))
1129 (tag (let ((tag (org-element-property :tag item
)))
1130 (and tag
(org-element-interpret-data tag
))))
1131 ;; Compute indentation.
1132 (ind (make-string (length bullet
) 32))
1133 (item-starts-with-par-p
1134 (eq (org-element-type (car (org-element-contents item
)))
1139 (and counter
(format "[@%d] " counter
))
1144 (and tag
(format "%s :: " tag
))
1146 (let ((contents (replace-regexp-in-string
1147 "\\(^\\)[ \t]*\\S-" ind contents nil nil
1)))
1148 (if item-starts-with-par-p
(org-trim contents
)
1149 (concat "\n" contents
)))))))
1154 (defun org-element--list-struct (limit)
1155 ;; Return structure of list at point. Internal function. See
1156 ;; `org-list-struct' for details.
1157 (let ((case-fold-search t
)
1159 (item-re (org-item-re))
1160 (drawers-re (concat ":\\("
1161 (mapconcat 'regexp-quote org-drawers
"\\|")
1163 (inlinetask-re (and (featurep 'org-inlinetask
) "^\\*+ "))
1169 ;; At limit: end all items.
1172 (let ((end (progn (skip-chars-backward " \r\t\n")
1175 (dolist (item items
(sort (nconc items struct
)
1176 'car-less-than-car
))
1177 (setcar (nthcdr 6 item
) end
)))))
1178 ;; At list end: end all items.
1179 ((looking-at org-list-end-re
)
1180 (throw 'exit
(dolist (item items
(sort (nconc items struct
)
1181 'car-less-than-car
))
1182 (setcar (nthcdr 6 item
) (point)))))
1183 ;; At a new item: end previous sibling.
1184 ((looking-at item-re
)
1185 (let ((ind (save-excursion (skip-chars-forward " \t")
1187 (setq top-ind
(min top-ind ind
))
1188 (while (and items
(<= ind
(nth 1 (car items
))))
1189 (let ((item (pop items
)))
1190 (setcar (nthcdr 6 item
) (point))
1191 (push item struct
)))
1192 (push (progn (looking-at org-list-full-item-re
)
1193 (let ((bullet (match-string-no-properties 1)))
1197 (match-string-no-properties 2) ; counter
1198 (match-string-no-properties 3) ; checkbox
1200 (and (save-match-data
1201 (string-match "[-+*]" bullet
))
1202 (match-string-no-properties 4))
1203 ;; Ending position, unknown so far.
1207 ;; Skip empty lines.
1208 ((looking-at "^[ \t]*$") (forward-line))
1209 ;; Skip inline tasks and blank lines along the way.
1210 ((and inlinetask-re
(looking-at inlinetask-re
))
1212 (let ((origin (point)))
1213 (when (re-search-forward inlinetask-re limit t
)
1214 (if (looking-at "^\\*+ END[ \t]*$") (forward-line)
1215 (goto-char origin
)))))
1216 ;; At some text line. Check if it ends any previous item.
1218 (let ((ind (progn (skip-chars-forward " \t") (current-column))))
1219 (when (<= ind top-ind
)
1220 (skip-chars-backward " \r\t\n")
1222 (while (<= ind
(nth 1 (car items
)))
1223 (let ((item (pop items
)))
1224 (setcar (nthcdr 6 item
) (line-beginning-position))
1227 (throw 'exit
(sort struct
'car-less-than-car
))))))
1228 ;; Skip blocks (any type) and drawers contents.
1230 ((and (looking-at "#\\+BEGIN\\(:[ \t]*$\\|_\\S-\\)+")
1232 (format "^[ \t]*#\\+END%s[ \t]*$" (match-string 1))
1234 ((and (looking-at drawers-re
)
1235 (re-search-forward "^[ \t]*:END:[ \t]*$" limit t
))))
1236 (forward-line))))))))
1238 (defun org-element-plain-list-parser (limit affiliated structure
)
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
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."
1254 (let* ((struct (or structure
(org-element--list-struct limit
)))
1255 (prevs (org-list-prevs-alist struct
))
1256 (type (org-list-get-list-type (point) struct prevs
))
1257 (contents-begin (point))
1258 (begin (car affiliated
))
1260 (progn (goto-char (org-list-get-list-end (point) struct prevs
))
1261 (unless (bolp) (forward-line))
1263 (end (progn (skip-chars-forward " \r\t\n" limit
)
1264 (if (= (point) limit
) limit
(line-beginning-position)))))
1271 :contents-begin contents-begin
1272 :contents-end contents-end
1274 :post-blank
(count-lines contents-end end
)
1275 :post-affiliated contents-begin
)
1276 (cdr affiliated
))))))
1278 (defun org-element-plain-list-interpreter (plain-list contents
)
1279 "Interpret PLAIN-LIST element as Org syntax.
1280 CONTENTS is the contents of the element."
1283 (goto-char (point-min))
1288 ;;;; Property Drawer
1290 (defun org-element-property-drawer-parser (limit affiliated
)
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
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."
1304 (let ((case-fold-search t
))
1305 (if (not (save-excursion
1306 (re-search-forward "^[ \t]*:END:[ \t]*$" limit t
)))
1307 ;; Incomplete drawer: parse it as a paragraph.
1308 (org-element-paragraph-parser limit affiliated
)
1310 (let* ((drawer-end-line (match-beginning 0))
1311 (begin (car affiliated
))
1312 (post-affiliated (point))
1313 (contents-begin (progn (forward-line)
1314 (and (< (point) drawer-end-line
)
1316 (contents-end (and contents-begin drawer-end-line
))
1317 (hidden (org-invisible-p2))
1318 (pos-before-blank (progn (goto-char drawer-end-line
)
1321 (end (progn (skip-chars-forward " \r\t\n" limit
)
1322 (skip-chars-backward " \t")
1323 (if (bolp) (point) (line-end-position)))))
1324 (list 'property-drawer
1329 :contents-begin contents-begin
1330 :contents-end contents-end
1331 :post-blank
(count-lines pos-before-blank end
)
1332 :post-affiliated post-affiliated
)
1333 (cdr affiliated
)))))))))
1335 (defun org-element-property-drawer-interpreter (property-drawer contents
)
1336 "Interpret PROPERTY-DRAWER element as Org syntax.
1337 CONTENTS is the properties within the drawer."
1338 (format ":PROPERTIES:\n%s:END:" contents
))
1343 (defun org-element-quote-block-parser (limit affiliated
)
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
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."
1356 (let ((case-fold-search t
))
1357 (if (not (save-excursion
1358 (re-search-forward "^[ \t]*#\\+END_QUOTE[ \t]*$" limit t
)))
1359 ;; Incomplete block: parse it as a paragraph.
1360 (org-element-paragraph-parser limit affiliated
)
1361 (let ((block-end-line (match-beginning 0)))
1363 (let* ((begin (car affiliated
))
1364 (post-affiliated (point))
1365 ;; Empty blocks have no contents.
1366 (contents-begin (progn (forward-line)
1367 (and (< (point) block-end-line
)
1369 (contents-end (and contents-begin block-end-line
))
1370 (hidden (org-invisible-p2))
1371 (pos-before-blank (progn (goto-char block-end-line
)
1374 (end (progn (skip-chars-forward " \r\t\n" limit
)
1375 (skip-chars-backward " \t")
1376 (if (bolp) (point) (line-end-position)))))
1382 :contents-begin contents-begin
1383 :contents-end contents-end
1384 :post-blank
(count-lines pos-before-blank end
)
1385 :post-affiliated post-affiliated
)
1386 (cdr affiliated
)))))))))
1388 (defun org-element-quote-block-interpreter (quote-block contents
)
1389 "Interpret QUOTE-BLOCK element as Org syntax.
1390 CONTENTS is the contents of the element."
1391 (format "#+BEGIN_QUOTE\n%s#+END_QUOTE" contents
))
1396 (defun org-element-section-parser (limit)
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.
1407 (let ((begin (point))
1408 (end (progn (org-with-limited-levels (outline-next-heading))
1410 (pos-before-blank (progn (skip-chars-backward " \r\t\n")
1416 :contents-begin begin
1417 :contents-end pos-before-blank
1418 :post-blank
(count-lines pos-before-blank end
))))))
1420 (defun org-element-section-interpreter (section contents
)
1421 "Interpret SECTION element as Org syntax.
1422 CONTENTS is the contents of the element."
1428 (defun org-element-special-block-parser (limit affiliated
)
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
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."
1442 (let* ((case-fold-search t
)
1443 (type (progn (looking-at "[ \t]*#\\+BEGIN_\\(\\S-+\\)")
1444 (upcase (match-string-no-properties 1)))))
1445 (if (not (save-excursion
1447 (format "^[ \t]*#\\+END_%s[ \t]*$" (regexp-quote type
))
1449 ;; Incomplete block: parse it as a paragraph.
1450 (org-element-paragraph-parser limit affiliated
)
1451 (let ((block-end-line (match-beginning 0)))
1453 (let* ((begin (car affiliated
))
1454 (post-affiliated (point))
1455 ;; Empty blocks have no contents.
1456 (contents-begin (progn (forward-line)
1457 (and (< (point) block-end-line
)
1459 (contents-end (and contents-begin block-end-line
))
1460 (hidden (org-invisible-p2))
1461 (pos-before-blank (progn (goto-char block-end-line
)
1464 (end (progn (skip-chars-forward " \r\t\n" limit
)
1465 (skip-chars-backward " \t")
1466 (if (bolp) (point) (line-end-position)))))
1467 (list 'special-block
1473 :contents-begin contents-begin
1474 :contents-end contents-end
1475 :post-blank
(count-lines pos-before-blank end
)
1476 :post-affiliated post-affiliated
)
1477 (cdr affiliated
)))))))))
1479 (defun org-element-special-block-interpreter (special-block contents
)
1480 "Interpret SPECIAL-BLOCK element as Org syntax.
1481 CONTENTS is the contents of the element."
1482 (let ((block-type (org-element-property :type special-block
)))
1483 (format "#+BEGIN_%s\n%s#+END_%s" block-type contents block-type
)))
1489 ;; For each element, a parser and an interpreter are also defined.
1490 ;; Both follow the same naming convention used for greater elements.
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'.
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.
1503 (defun org-element-babel-call-parser (limit affiliated
)
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
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."
1515 (let ((case-fold-search t
)
1516 (info (progn (looking-at org-babel-block-lob-one-liner-regexp
)
1517 (org-babel-lob-get-info)))
1518 (begin (car affiliated
))
1519 (post-affiliated (point))
1520 (pos-before-blank (progn (forward-line) (point)))
1521 (end (progn (skip-chars-forward " \r\t\n" limit
)
1522 (skip-chars-backward " \t")
1523 (if (bolp) (point) (line-end-position)))))
1529 :post-blank
(count-lines pos-before-blank end
)
1530 :post-affiliated post-affiliated
)
1531 (cdr affiliated
))))))
1533 (defun org-element-babel-call-interpreter (babel-call contents
)
1534 "Interpret BABEL-CALL element as Org syntax.
1536 (let* ((babel-info (org-element-property :info babel-call
))
1537 (main (car babel-info
))
1538 (post-options (nth 1 babel-info
)))
1540 (if (not (string-match "\\[\\(\\[.*?\\]\\)\\]" main
)) main
1541 ;; Remove redundant square brackets.
1542 (replace-match (match-string 1 main
) nil nil main
))
1543 (and post-options
(format "[%s]" post-options
)))))
1548 (defun org-element-clock-parser (limit)
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'
1557 (let* ((case-fold-search nil
)
1559 (value (progn (search-forward org-clock-string
(line-end-position) t
)
1560 (skip-chars-forward " \t")
1561 (org-element-timestamp-parser)))
1562 (duration (and (search-forward " => " (line-end-position) t
)
1563 (progn (skip-chars-forward " \t")
1564 (looking-at "\\(\\S-+\\)[ \t]*$"))
1565 (org-match-string-no-properties 1)))
1566 (status (if duration
'closed
'running
))
1567 (post-blank (let ((before-blank (progn (forward-line) (point))))
1568 (skip-chars-forward " \r\t\n" limit
)
1569 (skip-chars-backward " \t")
1570 (unless (bolp) (end-of-line))
1571 (count-lines before-blank
(point))))
1574 (list :status status
1579 :post-blank post-blank
)))))
1581 (defun org-element-clock-interpreter (clock contents
)
1582 "Interpret CLOCK element as Org syntax.
1584 (concat org-clock-string
" "
1585 (org-element-timestamp-interpreter
1586 (org-element-property :value clock
) nil
)
1587 (let ((duration (org-element-property :duration clock
)))
1592 (org-split-string duration
":")))))))
1597 (defun org-element-comment-parser (limit affiliated
)
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
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."
1611 (let* ((begin (car affiliated
))
1612 (post-affiliated (point))
1613 (value (prog2 (looking-at "[ \t]*# ?")
1614 (buffer-substring-no-properties
1615 (match-end 0) (line-end-position))
1618 ;; Get comments ending.
1620 (while (and (< (point) limit
) (looking-at "[ \t]*#\\( \\|$\\)"))
1621 ;; Accumulate lines without leading hash and first
1626 (buffer-substring-no-properties
1627 (match-end 0) (line-end-position))))
1630 (end (progn (goto-char com-end
)
1631 (skip-chars-forward " \r\t\n" limit
)
1632 (skip-chars-backward " \t")
1633 (if (bolp) (point) (line-end-position)))))
1639 :post-blank
(count-lines com-end end
)
1640 :post-affiliated post-affiliated
)
1641 (cdr affiliated
))))))
1643 (defun org-element-comment-interpreter (comment contents
)
1644 "Interpret COMMENT element as Org syntax.
1646 (replace-regexp-in-string "^" "# " (org-element-property :value comment
)))
1651 (defun org-element-comment-block-parser (limit affiliated
)
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
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."
1664 (let ((case-fold-search t
))
1665 (if (not (save-excursion
1666 (re-search-forward "^[ \t]*#\\+END_COMMENT[ \t]*$" limit t
)))
1667 ;; Incomplete block: parse it as a paragraph.
1668 (org-element-paragraph-parser limit affiliated
)
1669 (let ((contents-end (match-beginning 0)))
1671 (let* ((begin (car affiliated
))
1672 (post-affiliated (point))
1673 (contents-begin (progn (forward-line) (point)))
1674 (hidden (org-invisible-p2))
1675 (pos-before-blank (progn (goto-char contents-end
)
1678 (end (progn (skip-chars-forward " \r\t\n" limit
)
1679 (skip-chars-backward " \t")
1680 (if (bolp) (point) (line-end-position))))
1681 (value (buffer-substring-no-properties
1682 contents-begin contents-end
)))
1683 (list 'comment-block
1689 :post-blank
(count-lines pos-before-blank end
)
1690 :post-affiliated post-affiliated
)
1691 (cdr affiliated
)))))))))
1693 (defun org-element-comment-block-interpreter (comment-block contents
)
1694 "Interpret COMMENT-BLOCK element as Org syntax.
1696 (format "#+BEGIN_COMMENT\n%s#+END_COMMENT"
1697 (org-remove-indentation (org-element-property :value comment-block
))))
1702 (defun org-element-diary-sexp-parser (limit affiliated
)
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
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."
1714 (let ((begin (car affiliated
))
1715 (post-affiliated (point))
1716 (value (progn (looking-at "\\(%%(.*\\)[ \t]*$")
1717 (org-match-string-no-properties 1)))
1718 (pos-before-blank (progn (forward-line) (point)))
1719 (end (progn (skip-chars-forward " \r\t\n" limit
)
1720 (skip-chars-backward " \t")
1721 (if (bolp) (point) (line-end-position)))))
1727 :post-blank
(count-lines pos-before-blank end
)
1728 :post-affiliated post-affiliated
)
1729 (cdr affiliated
))))))
1731 (defun org-element-diary-sexp-interpreter (diary-sexp contents
)
1732 "Interpret DIARY-SEXP as Org syntax.
1734 (org-element-property :value diary-sexp
))
1739 (defun org-element--remove-indentation (s &optional n
)
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."
1748 (goto-char (point-min))
1749 ;; Find maximum common indentation, if not specified.
1751 (let ((min-ind (point-max)))
1753 (while (re-search-forward "^[ \t]*\\S-" nil t
)
1754 (let ((ind (1- (current-column))))
1755 (if (zerop ind
) (throw 'exit s
)
1756 (setq min-ind
(min min-ind ind
))))))
1759 ;; Remove exactly N indentation, but give up if not possible.
1761 (let ((ind (progn (skip-chars-forward " \t") (current-column))))
1762 (cond ((eolp) (delete-region (line-beginning-position) (point)))
1763 ((< ind n
) (throw 'exit s
))
1764 (t (org-indent-line-to (- ind n
))))
1768 (defun org-element-example-block-parser (limit affiliated
)
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
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'
1781 (let ((case-fold-search t
))
1782 (if (not (save-excursion
1783 (re-search-forward "^[ \t]*#\\+END_EXAMPLE[ \t]*$" limit t
)))
1784 ;; Incomplete block: parse it as a paragraph.
1785 (org-element-paragraph-parser limit affiliated
)
1786 (let ((contents-end (match-beginning 0)))
1790 (looking-at "^[ \t]*#\\+BEGIN_EXAMPLE\\(?: +\\(.*\\)\\)?")
1791 (org-match-string-no-properties 1)))
1792 ;; Switches analysis
1794 (cond ((not switches
) nil
)
1795 ((string-match "-n\\>" switches
) 'new
)
1796 ((string-match "+n\\>" switches
) 'continued
)))
1798 (or org-src-preserve-indentation
1799 (and switches
(string-match "-i\\>" switches
))))
1800 ;; Should labels be retained in (or stripped from) example
1804 (not (string-match "-r\\>" switches
))
1805 (and number-lines
(string-match "-k\\>" switches
))))
1806 ;; What should code-references use - labels or
1811 (not (string-match "-k\\>" switches
)))))
1814 (string-match "-l +\"\\([^\"\n]+\\)\"" switches
)
1815 (match-string 1 switches
)))
1816 ;; Standard block parsing.
1817 (begin (car affiliated
))
1818 (post-affiliated (point))
1819 (block-ind (progn (skip-chars-forward " \t") (current-column)))
1820 (contents-begin (progn (forward-line) (point)))
1821 (hidden (org-invisible-p2))
1822 (value (org-element--remove-indentation
1823 (org-unescape-code-in-string
1824 (buffer-substring-no-properties
1825 contents-begin contents-end
))
1826 (and preserve-indent block-ind
)))
1827 (pos-before-blank (progn (goto-char contents-end
)
1830 (end (progn (skip-chars-forward " \r\t\n" limit
)
1831 (skip-chars-backward " \t")
1832 (if (bolp) (point) (line-end-position)))))
1833 (list 'example-block
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
1845 :post-blank
(count-lines pos-before-blank end
)
1846 :post-affiliated post-affiliated
)
1847 (cdr affiliated
)))))))))
1849 (defun org-element-example-block-interpreter (example-block contents
)
1850 "Interpret EXAMPLE-BLOCK element as Org syntax.
1852 (let ((switches (org-element-property :switches example-block
)))
1853 (concat "#+BEGIN_EXAMPLE" (and switches
(concat " " switches
)) "\n"
1854 (org-escape-code-in-string
1855 (org-element-property :value example-block
))
1861 (defun org-element-export-block-parser (limit affiliated
)
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
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."
1874 (let* ((case-fold-search t
)
1875 (type (progn (looking-at "[ \t]*#\\+BEGIN_\\(\\S-+\\)")
1876 (upcase (org-match-string-no-properties 1)))))
1877 (if (not (save-excursion
1879 (format "^[ \t]*#\\+END_%s[ \t]*$" type
) limit t
)))
1880 ;; Incomplete block: parse it as a paragraph.
1881 (org-element-paragraph-parser limit affiliated
)
1882 (let ((contents-end (match-beginning 0)))
1884 (let* ((begin (car affiliated
))
1885 (post-affiliated (point))
1886 (contents-begin (progn (forward-line) (point)))
1887 (hidden (org-invisible-p2))
1888 (pos-before-blank (progn (goto-char contents-end
)
1891 (end (progn (skip-chars-forward " \r\t\n" limit
)
1892 (skip-chars-backward " \t")
1893 (if (bolp) (point) (line-end-position))))
1894 (value (buffer-substring-no-properties contents-begin
1903 :post-blank
(count-lines pos-before-blank end
)
1904 :post-affiliated post-affiliated
)
1905 (cdr affiliated
)))))))))
1907 (defun org-element-export-block-interpreter (export-block contents
)
1908 "Interpret EXPORT-BLOCK element as Org syntax.
1910 (let ((type (org-element-property :type export-block
)))
1911 (concat (format "#+BEGIN_%s\n" type
)
1912 (org-element-property :value export-block
)
1913 (format "#+END_%s" type
))))
1918 (defun org-element-fixed-width-parser (limit affiliated
)
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
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."
1932 (let* ((begin (car affiliated
))
1933 (post-affiliated (point))
1937 (while (and (< (point) limit
)
1938 (looking-at "[ \t]*:\\( \\|$\\)"))
1939 ;; Accumulate text without starting colons.
1942 (buffer-substring-no-properties
1943 (match-end 0) (point-at-eol))
1947 (end (progn (skip-chars-forward " \r\t\n" limit
)
1948 (skip-chars-backward " \t")
1949 (if (bolp) (point) (line-end-position)))))
1955 :post-blank
(count-lines end-area end
)
1956 :post-affiliated post-affiliated
)
1957 (cdr affiliated
))))))
1959 (defun org-element-fixed-width-interpreter (fixed-width contents
)
1960 "Interpret FIXED-WIDTH element as Org syntax.
1962 (let ((value (org-element-property :value fixed-width
)))
1964 (replace-regexp-in-string
1966 (if (string-match "\n\\'" value
) (substring value
0 -
1) value
)))))
1969 ;;;; Horizontal Rule
1971 (defun org-element-horizontal-rule-parser (limit affiliated
)
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
1979 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1980 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1983 (let ((begin (car affiliated
))
1984 (post-affiliated (point))
1985 (post-hr (progn (forward-line) (point)))
1986 (end (progn (skip-chars-forward " \r\t\n" limit
)
1987 (skip-chars-backward " \t")
1988 (if (bolp) (point) (line-end-position)))))
1989 (list 'horizontal-rule
1993 :post-blank
(count-lines post-hr end
)
1994 :post-affiliated post-affiliated
)
1995 (cdr affiliated
))))))
1997 (defun org-element-horizontal-rule-interpreter (horizontal-rule contents
)
1998 "Interpret HORIZONTAL-RULE element as Org syntax.
2005 (defun org-element-keyword-parser (limit affiliated
)
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
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."
2017 (let ((begin (car affiliated
))
2018 (post-affiliated (point))
2019 (key (progn (looking-at "[ \t]*#\\+\\(\\S-+*\\):")
2020 (upcase (org-match-string-no-properties 1))))
2021 (value (org-trim (buffer-substring-no-properties
2022 (match-end 0) (point-at-eol))))
2023 (pos-before-blank (progn (forward-line) (point)))
2024 (end (progn (skip-chars-forward " \r\t\n" limit
)
2025 (skip-chars-backward " \t")
2026 (if (bolp) (point) (line-end-position)))))
2033 :post-blank
(count-lines pos-before-blank end
)
2034 :post-affiliated post-affiliated
)
2035 (cdr affiliated
))))))
2037 (defun org-element-keyword-interpreter (keyword contents
)
2038 "Interpret KEYWORD element as Org syntax.
2041 (org-element-property :key keyword
)
2042 (org-element-property :value keyword
)))
2045 ;;;; Latex Environment
2047 (defun org-element-latex-environment-parser (limit affiliated
)
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
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."
2061 (let ((case-fold-search t
)
2062 (code-begin (point)))
2063 (looking-at "[ \t]*\\\\begin{\\([A-Za-z0-9]+\\*?\\)}")
2064 (if (not (re-search-forward (format "^[ \t]*\\\\end{%s}[ \t]*$"
2065 (regexp-quote (match-string 1)))
2067 ;; Incomplete latex environment: parse it as a paragraph.
2068 (org-element-paragraph-parser limit affiliated
)
2069 (let* ((code-end (progn (forward-line) (point)))
2070 (begin (car affiliated
))
2071 (value (buffer-substring-no-properties code-begin code-end
))
2072 (end (progn (skip-chars-forward " \r\t\n" limit
)
2073 (skip-chars-backward " \t")
2074 (if (bolp) (point) (line-end-position)))))
2075 (list 'latex-environment
2080 :post-blank
(count-lines code-end end
)
2081 :post-affiliated code-begin
)
2082 (cdr affiliated
))))))))
2084 (defun org-element-latex-environment-interpreter (latex-environment contents
)
2085 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2087 (org-element-property :value latex-environment
))
2092 (defun org-element-node-property-parser (limit)
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'
2101 (looking-at org-property-re
)
2102 (let ((case-fold-search t
)
2104 (key (org-match-string-no-properties 2))
2105 (value (org-match-string-no-properties 3))
2106 (pos-before-blank (progn (forward-line) (point)))
2107 (end (progn (skip-chars-forward " \r\t\n" limit
)
2108 (if (eobp) (point) (point-at-bol)))))
2109 (list 'node-property
2114 :post-blank
(count-lines pos-before-blank end
))))))
2116 (defun org-element-node-property-interpreter (node-property contents
)
2117 "Interpret NODE-PROPERTY element as Org syntax.
2119 (format org-property-format
2120 (format ":%s:" (org-element-property :key node-property
))
2121 (org-element-property :value node-property
)))
2126 (defun org-element-paragraph-parser (limit affiliated
)
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
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."
2140 (let* ((begin (car affiliated
))
2141 (contents-begin (point))
2143 (let ((case-fold-search t
))
2145 (if (not (re-search-forward
2146 org-element-paragraph-separate limit
'm
))
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.
2159 (looking-at "[ \t]*\\(?:[^:#]\\|$\\)")
2160 ;; Stop at valid fixed-width areas.
2161 (looking-at "[ \t]*:\\(?: \\|$\\)")
2163 (and (looking-at org-drawer-regexp
)
2166 "^[ \t]*:END:[ \t]*$" limit t
)))
2167 ;; Stop at valid comments.
2168 (looking-at "[ \t]*#\\(?: \\|$\\)")
2169 ;; Stop at valid dynamic blocks.
2170 (and (looking-at org-dblock-start-re
)
2173 "^[ \t]*#\\+END:?[ \t]*$" limit t
)))
2174 ;; Stop at valid blocks.
2175 (and (looking-at "[ \t]*#\\+BEGIN_\\(\\S-+\\)")
2178 (format "^[ \t]*#\\+END_%s[ \t]*$"
2180 (org-match-string-no-properties 1)))
2182 ;; Stop at valid latex environments.
2184 "[ \t]*\\\\begin{\\([A-Za-z0-9]+\\*?\\)}")
2187 (format "^[ \t]*\\\\end{%s}[ \t]*$"
2189 (org-match-string-no-properties 1)))
2191 ;; Stop at valid keywords.
2192 (looking-at "[ \t]*#\\+\\S-+:")
2193 ;; Skip everything else.
2197 (re-search-forward org-element-paragraph-separate
2199 (beginning-of-line)))
2200 (if (= (point) limit
) limit
2201 (goto-char (line-beginning-position)))))
2202 (contents-end (progn (skip-chars-backward " \r\t\n" contents-begin
)
2205 (end (progn (skip-chars-forward " \r\t\n" limit
)
2206 (skip-chars-backward " \t")
2207 (if (bolp) (point) (line-end-position)))))
2212 :contents-begin contents-begin
2213 :contents-end contents-end
2214 :post-blank
(count-lines before-blank end
)
2215 :post-affiliated contents-begin
)
2216 (cdr affiliated
))))))
2218 (defun org-element-paragraph-interpreter (paragraph contents
)
2219 "Interpret PARAGRAPH element as Org syntax.
2220 CONTENTS is the contents of the element."
2226 (defun org-element-planning-parser (limit)
2229 LIMIT bounds the search.
2231 Return a list whose CAR is `planning' and CDR is a plist
2232 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2233 and `:post-blank' keywords."
2235 (let* ((case-fold-search nil
)
2237 (post-blank (let ((before-blank (progn (forward-line) (point))))
2238 (skip-chars-forward " \r\t\n" limit
)
2239 (skip-chars-backward " \t")
2240 (unless (bolp) (end-of-line))
2241 (count-lines before-blank
(point))))
2243 closed deadline scheduled
)
2245 (while (re-search-forward org-keyword-time-not-clock-regexp end t
)
2246 (goto-char (match-end 1))
2247 (skip-chars-forward " \t" end
)
2248 (let ((keyword (match-string 1))
2249 (time (org-element-timestamp-parser)))
2250 (cond ((equal keyword org-closed-string
) (setq closed time
))
2251 ((equal keyword org-deadline-string
) (setq deadline time
))
2252 (t (setq scheduled time
)))))
2254 (list :closed closed
2256 :scheduled scheduled
2259 :post-blank post-blank
)))))
2261 (defun org-element-planning-interpreter (planning contents
)
2262 "Interpret PLANNING element as Org syntax.
2267 (list (let ((deadline (org-element-property :deadline planning
)))
2269 (concat org-deadline-string
" "
2270 (org-element-timestamp-interpreter deadline nil
))))
2271 (let ((scheduled (org-element-property :scheduled planning
)))
2273 (concat org-scheduled-string
" "
2274 (org-element-timestamp-interpreter scheduled nil
))))
2275 (let ((closed (org-element-property :closed planning
)))
2277 (concat org-closed-string
" "
2278 (org-element-timestamp-interpreter closed nil
))))))
2284 (defun org-element-quote-section-parser (limit)
2285 "Parse a quote section.
2287 LIMIT bounds the search.
2289 Return a list whose CAR is `quote-section' and CDR is a plist
2290 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2292 Assume point is at beginning of the section."
2294 (let* ((begin (point))
2295 (end (progn (org-with-limited-levels (outline-next-heading))
2297 (pos-before-blank (progn (skip-chars-backward " \r\t\n")
2300 (value (buffer-substring-no-properties begin pos-before-blank
)))
2301 (list 'quote-section
2305 :post-blank
(count-lines pos-before-blank end
))))))
2307 (defun org-element-quote-section-interpreter (quote-section contents
)
2308 "Interpret QUOTE-SECTION element as Org syntax.
2310 (org-element-property :value quote-section
))
2315 (defun org-element-src-block-parser (limit affiliated
)
2318 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2319 the buffer position at the beginning of the first affiliated
2320 keyword and CDR is a plist of affiliated keywords along with
2323 Return a list whose CAR is `src-block' and CDR is a plist
2324 containing `:language', `:switches', `:parameters', `:begin',
2325 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2326 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2327 `:post-blank' and `:post-affiliated' keywords.
2329 Assume point is at the beginning of the block."
2330 (let ((case-fold-search t
))
2331 (if (not (save-excursion (re-search-forward "^[ \t]*#\\+END_SRC[ \t]*$"
2333 ;; Incomplete block: parse it as a paragraph.
2334 (org-element-paragraph-parser limit affiliated
)
2335 (let ((contents-end (match-beginning 0)))
2337 (let* ((begin (car affiliated
))
2338 (post-affiliated (point))
2339 ;; Get language as a string.
2343 (concat "^[ \t]*#\\+BEGIN_SRC"
2344 "\\(?: +\\(\\S-+\\)\\)?"
2345 "\\(\\(?: +\\(?:-l \".*?\"\\|[-+][A-Za-z]\\)\\)+\\)?"
2347 (org-match-string-no-properties 1)))
2349 (switches (org-match-string-no-properties 2))
2351 (parameters (org-match-string-no-properties 3))
2352 ;; Switches analysis
2354 (cond ((not switches
) nil
)
2355 ((string-match "-n\\>" switches
) 'new
)
2356 ((string-match "+n\\>" switches
) 'continued
)))
2357 (preserve-indent (or org-src-preserve-indentation
2359 (string-match "-i\\>" switches
))))
2362 (string-match "-l +\"\\([^\"\n]+\\)\"" switches
)
2363 (match-string 1 switches
)))
2364 ;; Should labels be retained in (or stripped from)
2368 (not (string-match "-r\\>" switches
))
2369 (and number-lines
(string-match "-k\\>" switches
))))
2370 ;; What should code-references use - labels or
2375 (not (string-match "-k\\>" switches
)))))
2377 (block-ind (progn (skip-chars-forward " \t") (current-column)))
2378 ;; Get visibility status.
2379 (hidden (progn (forward-line) (org-invisible-p2)))
2381 (value (org-element--remove-indentation
2382 (org-unescape-code-in-string
2383 (buffer-substring-no-properties
2384 (point) contents-end
))
2385 (and preserve-indent block-ind
)))
2386 (pos-before-blank (progn (goto-char contents-end
)
2389 ;; Get position after ending blank lines.
2390 (end (progn (skip-chars-forward " \r\t\n" limit
)
2391 (skip-chars-backward " \t")
2392 (if (bolp) (point) (line-end-position)))))
2395 (list :language language
2396 :switches
(and (org-string-nw-p switches
)
2397 (org-trim switches
))
2398 :parameters
(and (org-string-nw-p parameters
)
2399 (org-trim parameters
))
2402 :number-lines number-lines
2403 :preserve-indent preserve-indent
2404 :retain-labels retain-labels
2405 :use-labels use-labels
2406 :label-fmt label-fmt
2409 :post-blank
(count-lines pos-before-blank end
)
2410 :post-affiliated post-affiliated
)
2411 (cdr affiliated
)))))))))
2413 (defun org-element-src-block-interpreter (src-block contents
)
2414 "Interpret SRC-BLOCK element as Org syntax.
2416 (let ((lang (org-element-property :language src-block
))
2417 (switches (org-element-property :switches src-block
))
2418 (params (org-element-property :parameters src-block
))
2419 (value (let ((val (org-element-property :value src-block
)))
2421 ((org-element-property :preserve-indent src-block
) val
)
2422 ((zerop org-edit-src-content-indentation
) val
)
2424 (let ((ind (make-string
2425 org-edit-src-content-indentation
32)))
2426 (replace-regexp-in-string
2427 "\\(^\\)[ \t]*\\S-" ind val nil nil
1)))))))
2428 (concat (format "#+BEGIN_SRC%s\n"
2429 (concat (and lang
(concat " " lang
))
2430 (and switches
(concat " " switches
))
2431 (and params
(concat " " params
))))
2432 (org-escape-code-in-string value
)
2438 (defun org-element-table-parser (limit affiliated
)
2439 "Parse a table at point.
2441 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2442 the buffer position at the beginning of the first affiliated
2443 keyword and CDR is a plist of affiliated keywords along with
2446 Return a list whose CAR is `table' and CDR is a plist containing
2447 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2448 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2451 Assume point is at the beginning of the table."
2453 (let* ((case-fold-search t
)
2454 (table-begin (point))
2455 (type (if (org-at-table.el-p
) 'table.el
'org
))
2456 (begin (car affiliated
))
2458 (if (re-search-forward org-table-any-border-regexp limit
'm
)
2459 (goto-char (match-beginning 0))
2462 (while (looking-at "[ \t]*#\\+TBLFM: +\\(.*\\)[ \t]*$")
2463 (push (org-match-string-no-properties 1) acc
)
2466 (pos-before-blank (point))
2467 (end (progn (skip-chars-forward " \r\t\n" limit
)
2468 (skip-chars-backward " \t")
2469 (if (bolp) (point) (line-end-position)))))
2476 ;; Only `org' tables have contents. `table.el' tables
2477 ;; use a `:value' property to store raw table as
2479 :contents-begin
(and (eq type
'org
) table-begin
)
2480 :contents-end
(and (eq type
'org
) table-end
)
2481 :value
(and (eq type
'table.el
)
2482 (buffer-substring-no-properties
2483 table-begin table-end
))
2484 :post-blank
(count-lines pos-before-blank end
)
2485 :post-affiliated table-begin
)
2486 (cdr affiliated
))))))
2488 (defun org-element-table-interpreter (table contents
)
2489 "Interpret TABLE element as Org syntax.
2491 (if (eq (org-element-property :type table
) 'table.el
)
2492 (org-remove-indentation (org-element-property :value table
))
2493 (concat (with-temp-buffer (insert contents
)
2496 (mapconcat (lambda (fm) (concat "#+TBLFM: " fm
))
2497 (reverse (org-element-property :tblfm table
))
2503 (defun org-element-table-row-parser (limit)
2504 "Parse table row at point.
2506 LIMIT bounds the search.
2508 Return a list whose CAR is `table-row' and CDR is a plist
2509 containing `:begin', `:end', `:contents-begin', `:contents-end',
2510 `:type' and `:post-blank' keywords."
2512 (let* ((type (if (looking-at "^[ \t]*|-") 'rule
'standard
))
2514 ;; A table rule has no contents. In that case, ensure
2515 ;; CONTENTS-BEGIN matches CONTENTS-END.
2516 (contents-begin (and (eq type
'standard
)
2517 (search-forward "|")
2519 (contents-end (and (eq type
'standard
)
2522 (skip-chars-backward " \t")
2524 (end (progn (forward-line) (point))))
2529 :contents-begin contents-begin
2530 :contents-end contents-end
2533 (defun org-element-table-row-interpreter (table-row contents
)
2534 "Interpret TABLE-ROW element as Org syntax.
2535 CONTENTS is the contents of the table row."
2536 (if (eq (org-element-property :type table-row
) 'rule
) "|-"
2537 (concat "| " contents
)))
2542 (defun org-element-verse-block-parser (limit affiliated
)
2543 "Parse a verse block.
2545 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2546 the buffer position at the beginning of the first affiliated
2547 keyword and CDR is a plist of affiliated keywords along with
2550 Return a list whose CAR is `verse-block' and CDR is a plist
2551 containing `:begin', `:end', `:contents-begin', `:contents-end',
2552 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2554 Assume point is at beginning of the block."
2555 (let ((case-fold-search t
))
2556 (if (not (save-excursion
2557 (re-search-forward "^[ \t]*#\\+END_VERSE[ \t]*$" limit t
)))
2558 ;; Incomplete block: parse it as a paragraph.
2559 (org-element-paragraph-parser limit affiliated
)
2560 (let ((contents-end (match-beginning 0)))
2562 (let* ((begin (car affiliated
))
2563 (post-affiliated (point))
2564 (hidden (progn (forward-line) (org-invisible-p2)))
2565 (contents-begin (point))
2566 (pos-before-blank (progn (goto-char contents-end
)
2569 (end (progn (skip-chars-forward " \r\t\n" limit
)
2570 (skip-chars-backward " \t")
2571 (if (bolp) (point) (line-end-position)))))
2576 :contents-begin contents-begin
2577 :contents-end contents-end
2579 :post-blank
(count-lines pos-before-blank end
)
2580 :post-affiliated post-affiliated
)
2581 (cdr affiliated
)))))))))
2583 (defun org-element-verse-block-interpreter (verse-block contents
)
2584 "Interpret VERSE-BLOCK element as Org syntax.
2585 CONTENTS is verse block contents."
2586 (format "#+BEGIN_VERSE\n%s#+END_VERSE" contents
))
2592 ;; Unlike to elements, interstices can be found between objects.
2593 ;; That's why, along with the parser, successor functions are provided
2594 ;; for each object. Some objects share the same successor (i.e. `code'
2595 ;; and `verbatim' objects).
2597 ;; A successor must accept a single argument bounding the search. It
2598 ;; will return either a cons cell whose CAR is the object's type, as
2599 ;; a symbol, and CDR the position of its next occurrence, or nil.
2601 ;; Successors follow the naming convention:
2602 ;; org-element-NAME-successor, where NAME is the name of the
2603 ;; successor, as defined in `org-element-all-successors'.
2605 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2606 ;; object types they can contain will be specified in
2607 ;; `org-element-object-restrictions'.
2609 ;; Adding a new type of object is simple. Implement a successor,
2610 ;; a parser, and an interpreter for it, all following the naming
2611 ;; convention. Register type in `org-element-all-objects' and
2612 ;; successor in `org-element-all-successors'. Maybe tweak
2613 ;; restrictions about it, and that's it.
2618 (defun org-element-bold-parser ()
2619 "Parse bold object at point.
2621 Return a list whose CAR is `bold' and CDR is a plist with
2622 `:begin', `:end', `:contents-begin' and `:contents-end' and
2623 `:post-blank' keywords.
2625 Assume point is at the first star marker."
2627 (unless (bolp) (backward-char 1))
2628 (looking-at org-emph-re
)
2629 (let ((begin (match-beginning 2))
2630 (contents-begin (match-beginning 4))
2631 (contents-end (match-end 4))
2632 (post-blank (progn (goto-char (match-end 2))
2633 (skip-chars-forward " \t")))
2638 :contents-begin contents-begin
2639 :contents-end contents-end
2640 :post-blank post-blank
)))))
2642 (defun org-element-bold-interpreter (bold contents
)
2643 "Interpret BOLD object as Org syntax.
2644 CONTENTS is the contents of the object."
2645 (format "*%s*" contents
))
2647 (defun org-element-text-markup-successor ()
2648 "Search for the next text-markup object.
2650 Return value is a cons cell whose CAR is a symbol among `bold',
2651 `italic', `underline', `strike-through', `code' and `verbatim'
2652 and CDR is beginning position."
2654 (unless (bolp) (backward-char))
2655 (when (re-search-forward org-emph-re nil t
)
2656 (let ((marker (match-string 3)))
2658 ((equal marker
"*") 'bold
)
2659 ((equal marker
"/") 'italic
)
2660 ((equal marker
"_") 'underline
)
2661 ((equal marker
"+") 'strike-through
)
2662 ((equal marker
"~") 'code
)
2663 ((equal marker
"=") 'verbatim
)
2664 (t (error "Unknown marker at %d" (match-beginning 3))))
2665 (match-beginning 2))))))
2670 (defun org-element-code-parser ()
2671 "Parse code object at point.
2673 Return a list whose CAR is `code' and CDR is a plist with
2674 `:value', `:begin', `:end' and `:post-blank' keywords.
2676 Assume point is at the first tilde marker."
2678 (unless (bolp) (backward-char 1))
2679 (looking-at org-emph-re
)
2680 (let ((begin (match-beginning 2))
2681 (value (org-match-string-no-properties 4))
2682 (post-blank (progn (goto-char (match-end 2))
2683 (skip-chars-forward " \t")))
2689 :post-blank post-blank
)))))
2691 (defun org-element-code-interpreter (code contents
)
2692 "Interpret CODE object as Org syntax.
2694 (format "~%s~" (org-element-property :value code
)))
2699 (defun org-element-entity-parser ()
2700 "Parse entity at point.
2702 Return a list whose CAR is `entity' and CDR a plist with
2703 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2704 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2707 Assume point is at the beginning of the entity."
2709 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2710 (let* ((value (org-entity-get (match-string 1)))
2711 (begin (match-beginning 0))
2712 (bracketsp (string= (match-string 2) "{}"))
2713 (post-blank (progn (goto-char (match-end 1))
2714 (when bracketsp
(forward-char 2))
2715 (skip-chars-forward " \t")))
2718 (list :name
(car value
)
2719 :latex
(nth 1 value
)
2720 :latex-math-p
(nth 2 value
)
2722 :ascii
(nth 4 value
)
2723 :latin1
(nth 5 value
)
2724 :utf-8
(nth 6 value
)
2727 :use-brackets-p bracketsp
2728 :post-blank post-blank
)))))
2730 (defun org-element-entity-interpreter (entity contents
)
2731 "Interpret ENTITY object as Org syntax.
2734 (org-element-property :name entity
)
2735 (when (org-element-property :use-brackets-p entity
) "{}")))
2737 (defun org-element-latex-or-entity-successor ()
2738 "Search for the next latex-fragment or entity object.
2740 Return value is a cons cell whose CAR is `entity' or
2741 `latex-fragment' and CDR is beginning position."
2743 (unless (bolp) (backward-char))
2745 (remove "begin" (plist-get org-format-latex-options
:matchers
)))
2746 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2748 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))
2749 (when (re-search-forward
2750 (concat (mapconcat (lambda (e) (nth 1 (assoc e org-latex-regexps
)))
2754 (goto-char (match-beginning 0))
2755 (if (looking-at entity-re
)
2756 ;; Determine if it's a real entity or a LaTeX command.
2757 (cons (if (org-entity-get (match-string 1)) 'entity
'latex-fragment
)
2758 (match-beginning 0))
2759 ;; No entity nor command: point is at a LaTeX fragment.
2760 ;; Determine its type to get the correct beginning position.
2761 (cons 'latex-fragment
2764 (when (looking-at (nth 1 (assoc e org-latex-regexps
)))
2767 (nth 2 (assoc e org-latex-regexps
))))))
2774 (defun org-element-export-snippet-parser ()
2775 "Parse export snippet at point.
2777 Return a list whose CAR is `export-snippet' and CDR a plist with
2778 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2781 Assume point is at the beginning of the snippet."
2783 (re-search-forward "@@\\([-A-Za-z0-9]+\\):" nil t
)
2784 (let* ((begin (match-beginning 0))
2785 (back-end (org-match-string-no-properties 1))
2786 (value (buffer-substring-no-properties
2788 (progn (re-search-forward "@@" nil t
) (match-beginning 0))))
2789 (post-blank (skip-chars-forward " \t"))
2791 (list 'export-snippet
2792 (list :back-end back-end
2796 :post-blank post-blank
)))))
2798 (defun org-element-export-snippet-interpreter (export-snippet contents
)
2799 "Interpret EXPORT-SNIPPET object as Org syntax.
2802 (org-element-property :back-end export-snippet
)
2803 (org-element-property :value export-snippet
)))
2805 (defun org-element-export-snippet-successor ()
2806 "Search for the next export-snippet object.
2808 Return value is a cons cell whose CAR is `export-snippet' and CDR
2809 its beginning position."
2812 (when (and (re-search-forward "@@[-A-Za-z0-9]+:" nil t
)
2813 (setq beg
(match-beginning 0))
2814 (search-forward "@@" nil t
))
2815 (cons 'export-snippet beg
)))))
2818 ;;;; Footnote Reference
2820 (defun org-element-footnote-reference-parser ()
2821 "Parse footnote reference at point.
2823 Return a list whose CAR is `footnote-reference' and CDR a plist
2824 with `:label', `:type', `:inline-definition', `:begin', `:end'
2825 and `:post-blank' as keywords."
2827 (looking-at org-footnote-re
)
2828 (let* ((begin (point))
2829 (label (or (org-match-string-no-properties 2)
2830 (org-match-string-no-properties 3)
2831 (and (match-string 1)
2832 (concat "fn:" (org-match-string-no-properties 1)))))
2833 (type (if (or (not label
) (match-string 1)) 'inline
'standard
))
2834 (inner-begin (match-end 0))
2838 (while (and (> count
0) (re-search-forward "[][]" nil t
))
2839 (if (equal (match-string 0) "[") (incf count
) (decf count
)))
2841 (post-blank (progn (goto-char (1+ inner-end
))
2842 (skip-chars-forward " \t")))
2845 (list 'footnote-reference
2850 :post-blank post-blank
))))
2851 (org-element-put-property
2852 footnote-reference
:inline-definition
2853 (and (eq type
'inline
)
2854 (org-element-parse-secondary-string
2855 (buffer-substring inner-begin inner-end
)
2856 (org-element-restriction 'footnote-reference
)
2857 footnote-reference
))))))
2859 (defun org-element-footnote-reference-interpreter (footnote-reference contents
)
2860 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2862 (let ((label (or (org-element-property :label footnote-reference
) "fn:"))
2865 (org-element-property :inline-definition footnote-reference
)))
2866 (if (not inline-def
) ""
2867 (concat ":" (org-element-interpret-data inline-def
))))))
2868 (format "[%s]" (concat label def
))))
2870 (defun org-element-footnote-reference-successor ()
2871 "Search for the next footnote-reference object.
2873 Return value is a cons cell whose CAR is `footnote-reference' and
2874 CDR is beginning position."
2877 (while (re-search-forward org-footnote-re nil t
)
2879 (let ((beg (match-beginning 0))
2882 (while (re-search-forward "[][]" nil t
)
2883 (if (equal (match-string 0) "[") (incf count
) (decf count
))
2885 (throw 'exit
(cons 'footnote-reference beg
))))))))))
2888 ;;;; Inline Babel Call
2890 (defun org-element-inline-babel-call-parser ()
2891 "Parse inline babel call at point.
2893 Return a list whose CAR is `inline-babel-call' and CDR a plist
2894 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2896 Assume point is at the beginning of the babel call."
2898 (unless (bolp) (backward-char))
2899 (looking-at org-babel-inline-lob-one-liner-regexp
)
2900 (let ((info (save-match-data (org-babel-lob-get-info)))
2901 (begin (match-end 1))
2902 (post-blank (progn (goto-char (match-end 0))
2903 (skip-chars-forward " \t")))
2905 (list 'inline-babel-call
2909 :post-blank post-blank
)))))
2911 (defun org-element-inline-babel-call-interpreter (inline-babel-call contents
)
2912 "Interpret INLINE-BABEL-CALL object as Org syntax.
2914 (let* ((babel-info (org-element-property :info inline-babel-call
))
2915 (main-source (car babel-info
))
2916 (post-options (nth 1 babel-info
)))
2918 (if (string-match "\\[\\(\\[.*?\\]\\)\\]" main-source
)
2919 ;; Remove redundant square brackets.
2921 (match-string 1 main-source
) nil nil main-source
)
2923 (and post-options
(format "[%s]" post-options
)))))
2925 (defun org-element-inline-babel-call-successor ()
2926 "Search for the next inline-babel-call object.
2928 Return value is a cons cell whose CAR is `inline-babel-call' and
2929 CDR is beginning position."
2931 ;; Use a simplified version of
2932 ;; `org-babel-inline-lob-one-liner-regexp'.
2933 (when (re-search-forward
2934 "call_\\([^()\n]+?\\)\\(?:\\[.*?\\]\\)?([^\n]*?)\\(\\[.*?\\]\\)?"
2936 (cons 'inline-babel-call
(match-beginning 0)))))
2939 ;;;; Inline Src Block
2941 (defun org-element-inline-src-block-parser ()
2942 "Parse inline source block at point.
2944 Return a list whose CAR is `inline-src-block' and CDR a plist
2945 with `:begin', `:end', `:language', `:value', `:parameters' and
2946 `:post-blank' as keywords.
2948 Assume point is at the beginning of the inline src block."
2950 (unless (bolp) (backward-char))
2951 (looking-at org-babel-inline-src-block-regexp
)
2952 (let ((begin (match-beginning 1))
2953 (language (org-match-string-no-properties 2))
2954 (parameters (org-match-string-no-properties 4))
2955 (value (org-match-string-no-properties 5))
2956 (post-blank (progn (goto-char (match-end 0))
2957 (skip-chars-forward " \t")))
2959 (list 'inline-src-block
2960 (list :language language
2962 :parameters parameters
2965 :post-blank post-blank
)))))
2967 (defun org-element-inline-src-block-interpreter (inline-src-block contents
)
2968 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2970 (let ((language (org-element-property :language inline-src-block
))
2971 (arguments (org-element-property :parameters inline-src-block
))
2972 (body (org-element-property :value inline-src-block
)))
2973 (format "src_%s%s{%s}"
2975 (if arguments
(format "[%s]" arguments
) "")
2978 (defun org-element-inline-src-block-successor ()
2979 "Search for the next inline-babel-call element.
2981 Return value is a cons cell whose CAR is `inline-babel-call' and
2982 CDR is beginning position."
2984 (unless (bolp) (backward-char))
2985 (when (re-search-forward org-babel-inline-src-block-regexp nil t
)
2986 (cons 'inline-src-block
(match-beginning 1)))))
2990 (defun org-element-italic-parser ()
2991 "Parse italic object at point.
2993 Return a list whose CAR is `italic' and CDR is a plist with
2994 `:begin', `:end', `:contents-begin' and `:contents-end' and
2995 `:post-blank' keywords.
2997 Assume point is at the first slash marker."
2999 (unless (bolp) (backward-char 1))
3000 (looking-at org-emph-re
)
3001 (let ((begin (match-beginning 2))
3002 (contents-begin (match-beginning 4))
3003 (contents-end (match-end 4))
3004 (post-blank (progn (goto-char (match-end 2))
3005 (skip-chars-forward " \t")))
3010 :contents-begin contents-begin
3011 :contents-end contents-end
3012 :post-blank post-blank
)))))
3014 (defun org-element-italic-interpreter (italic contents
)
3015 "Interpret ITALIC object as Org syntax.
3016 CONTENTS is the contents of the object."
3017 (format "/%s/" contents
))
3022 (defun org-element-latex-fragment-parser ()
3023 "Parse latex fragment at point.
3025 Return a list whose CAR is `latex-fragment' and CDR a plist with
3026 `:value', `:begin', `:end', and `:post-blank' as keywords.
3028 Assume point is at the beginning of the latex fragment."
3030 (let* ((begin (point))
3034 (let ((latex-regexp (nth 1 (assoc e org-latex-regexps
))))
3035 (when (or (looking-at latex-regexp
)
3039 (looking-at latex-regexp
))))
3040 (throw 'exit
(nth 2 (assoc e org-latex-regexps
))))))
3041 (plist-get org-format-latex-options
:matchers
))
3042 ;; None found: it's a macro.
3043 (looking-at "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")
3045 (value (match-string-no-properties substring-match
))
3046 (post-blank (progn (goto-char (match-end substring-match
))
3047 (skip-chars-forward " \t")))
3049 (list 'latex-fragment
3053 :post-blank post-blank
)))))
3055 (defun org-element-latex-fragment-interpreter (latex-fragment contents
)
3056 "Interpret LATEX-FRAGMENT object as Org syntax.
3058 (org-element-property :value latex-fragment
))
3062 (defun org-element-line-break-parser ()
3063 "Parse line break at point.
3065 Return a list whose CAR is `line-break', and CDR a plist with
3066 `:begin', `:end' and `:post-blank' keywords.
3068 Assume point is at the beginning of the line break."
3070 (list :begin
(point)
3071 :end
(progn (forward-line) (point))
3074 (defun org-element-line-break-interpreter (line-break contents
)
3075 "Interpret LINE-BREAK object as Org syntax.
3079 (defun org-element-line-break-successor ()
3080 "Search for the next line-break object.
3082 Return value is a cons cell whose CAR is `line-break' and CDR is
3083 beginning position."
3085 (let ((beg (and (re-search-forward "[^\\\\]\\(\\\\\\\\\\)[ \t]*$" nil t
)
3086 (goto-char (match-beginning 1)))))
3087 ;; A line break can only happen on a non-empty line.
3088 (when (and beg
(re-search-backward "\\S-" (point-at-bol) t
))
3089 (cons 'line-break beg
)))))
3094 (defun org-element-link-parser ()
3095 "Parse link at point.
3097 Return a list whose CAR is `link' and CDR a plist with `:type',
3098 `:path', `:raw-link', `:application', `:search-option', `:begin',
3099 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3102 Assume point is at the beginning of the link."
3104 (let ((begin (point))
3105 end contents-begin contents-end link-end post-blank path type
3106 raw-link link search-option application
)
3108 ;; Type 1: Text targeted from a radio target.
3109 ((and org-target-link-regexp
(looking-at org-target-link-regexp
))
3111 link-end
(match-end 0)
3112 path
(org-match-string-no-properties 0)))
3113 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3114 ((looking-at org-bracket-link-regexp
)
3115 (setq contents-begin
(match-beginning 3)
3116 contents-end
(match-end 3)
3117 link-end
(match-end 0)
3118 ;; RAW-LINK is the original link. Expand any
3119 ;; abbreviation in it.
3120 raw-link
(org-translate-link
3121 (org-link-expand-abbrev
3122 (org-match-string-no-properties 1))))
3123 ;; Determine TYPE of link and set PATH accordingly.
3126 ((or (file-name-absolute-p raw-link
)
3127 (string-match "^\\.\\.?/" raw-link
))
3128 (setq type
"file" path raw-link
))
3129 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3130 ((string-match org-link-re-with-space3 raw-link
)
3131 (setq type
(match-string 1 raw-link
) path
(match-string 2 raw-link
)))
3132 ;; Id type: PATH is the id.
3133 ((string-match "^id:\\([-a-f0-9]+\\)" raw-link
)
3134 (setq type
"id" path
(match-string 1 raw-link
)))
3135 ;; Code-ref type: PATH is the name of the reference.
3136 ((string-match "^(\\(.*\\))$" raw-link
)
3137 (setq type
"coderef" path
(match-string 1 raw-link
)))
3138 ;; Custom-id type: PATH is the name of the custom id.
3139 ((= (aref raw-link
0) ?
#)
3140 (setq type
"custom-id" path
(substring raw-link
1)))
3141 ;; Fuzzy type: Internal link either matches a target, an
3142 ;; headline name or nothing. PATH is the target or
3144 (t (setq type
"fuzzy" path raw-link
))))
3145 ;; Type 3: Plain link, i.e. http://orgmode.org
3146 ((looking-at org-plain-link-re
)
3147 (setq raw-link
(org-match-string-no-properties 0)
3148 type
(org-match-string-no-properties 1)
3149 link-end
(match-end 0)
3150 path
(org-match-string-no-properties 2)))
3151 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3152 ((looking-at org-angle-link-re
)
3153 (setq raw-link
(buffer-substring-no-properties
3154 (match-beginning 1) (match-end 2))
3155 type
(org-match-string-no-properties 1)
3156 link-end
(match-end 0)
3157 path
(org-match-string-no-properties 2))))
3158 ;; In any case, deduce end point after trailing white space from
3159 ;; LINK-END variable.
3160 (setq post-blank
(progn (goto-char link-end
) (skip-chars-forward " \t"))
3162 ;; Extract search option and opening application out of
3163 ;; "file"-type links.
3164 (when (member type org-element-link-type-is-file
)
3166 (cond ((string-match "^file\\+\\(.*\\)$" type
)
3167 (setq application
(match-string 1 type
)))
3168 ((not (string-match "^file" type
))
3169 (setq application type
)))
3170 ;; Extract search option from PATH.
3171 (when (string-match "::\\(.*\\)$" path
)
3172 (setq search-option
(match-string 1 path
)
3173 path
(replace-match "" nil nil path
)))
3174 ;; Make sure TYPE always reports "file".
3179 :raw-link
(or raw-link path
)
3180 :application application
3181 :search-option search-option
3184 :contents-begin contents-begin
3185 :contents-end contents-end
3186 :post-blank post-blank
)))))
3188 (defun org-element-link-interpreter (link contents
)
3189 "Interpret LINK object as Org syntax.
3190 CONTENTS is the contents of the object, or nil."
3191 (let ((type (org-element-property :type link
))
3192 (raw-link (org-element-property :raw-link link
)))
3193 (if (string= type
"radio") raw-link
3196 (if contents
(format "[%s]" contents
) "")))))
3198 (defun org-element-link-successor ()
3199 "Search for the next link object.
3201 Return value is a cons cell whose CAR is `link' and CDR is
3202 beginning position."
3205 (if (not org-target-link-regexp
) org-any-link-re
3206 (concat org-any-link-re
"\\|" org-target-link-regexp
))))
3207 (when (re-search-forward link-regexp nil t
)
3208 (cons 'link
(match-beginning 0))))))
3210 (defun org-element-plain-link-successor ()
3211 "Search for the next plain link object.
3213 Return value is a cons cell whose CAR is `link' and CDR is
3214 beginning position."
3215 (and (save-excursion (re-search-forward org-plain-link-re nil t
))
3216 (cons 'link
(match-beginning 0))))
3221 (defun org-element-macro-parser ()
3222 "Parse macro at point.
3224 Return a list whose CAR is `macro' and CDR a plist with `:key',
3225 `:args', `:begin', `:end', `:value' and `:post-blank' as
3228 Assume point is at the macro."
3230 (looking-at "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\(([ \t\n]*\\([^\000]*?\\))\\)?}}}")
3231 (let ((begin (point))
3232 (key (downcase (org-match-string-no-properties 1)))
3233 (value (org-match-string-no-properties 0))
3234 (post-blank (progn (goto-char (match-end 0))
3235 (skip-chars-forward " \t")))
3237 (args (let ((args (org-match-string-no-properties 3)))
3239 ;; Do not use `org-split-string' since empty
3240 ;; strings are meaningful here.
3242 (replace-regexp-in-string
3243 "\\(\\\\*\\)\\(,\\)"
3245 (let ((len (length (match-string 1 str
))))
3246 (concat (make-string (/ len
2) ?
\\)
3247 (if (zerop (mod len
2)) "\000" ","))))
3256 :post-blank post-blank
)))))
3258 (defun org-element-macro-interpreter (macro contents
)
3259 "Interpret MACRO object as Org syntax.
3261 (org-element-property :value macro
))
3263 (defun org-element-macro-successor ()
3264 "Search for the next macro object.
3266 Return value is cons cell whose CAR is `macro' and CDR is
3267 beginning position."
3269 (when (re-search-forward
3270 "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\(([ \t\n]*\\([^\000]*?\\))\\)?}}}"
3272 (cons 'macro
(match-beginning 0)))))
3277 (defun org-element-radio-target-parser ()
3278 "Parse radio target at point.
3280 Return a list whose CAR is `radio-target' and CDR a plist with
3281 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3282 and `:post-blank' as keywords.
3284 Assume point is at the radio target."
3286 (looking-at org-radio-target-regexp
)
3287 (let ((begin (point))
3288 (contents-begin (match-beginning 1))
3289 (contents-end (match-end 1))
3290 (value (org-match-string-no-properties 1))
3291 (post-blank (progn (goto-char (match-end 0))
3292 (skip-chars-forward " \t")))
3297 :contents-begin contents-begin
3298 :contents-end contents-end
3299 :post-blank post-blank
3302 (defun org-element-radio-target-interpreter (target contents
)
3303 "Interpret TARGET object as Org syntax.
3304 CONTENTS is the contents of the object."
3305 (concat "<<<" contents
">>>"))
3307 (defun org-element-radio-target-successor ()
3308 "Search for the next radio-target object.
3310 Return value is a cons cell whose CAR is `radio-target' and CDR
3311 is beginning position."
3313 (when (re-search-forward org-radio-target-regexp nil t
)
3314 (cons 'radio-target
(match-beginning 0)))))
3317 ;;;; Statistics Cookie
3319 (defun org-element-statistics-cookie-parser ()
3320 "Parse statistics cookie at point.
3322 Return a list whose CAR is `statistics-cookie', and CDR a plist
3323 with `:begin', `:end', `:value' and `:post-blank' keywords.
3325 Assume point is at the beginning of the statistics-cookie."
3327 (looking-at "\\[[0-9]*\\(%\\|/[0-9]*\\)\\]")
3328 (let* ((begin (point))
3329 (value (buffer-substring-no-properties
3330 (match-beginning 0) (match-end 0)))
3331 (post-blank (progn (goto-char (match-end 0))
3332 (skip-chars-forward " \t")))
3334 (list 'statistics-cookie
3338 :post-blank post-blank
)))))
3340 (defun org-element-statistics-cookie-interpreter (statistics-cookie contents
)
3341 "Interpret STATISTICS-COOKIE object as Org syntax.
3343 (org-element-property :value statistics-cookie
))
3345 (defun org-element-statistics-cookie-successor ()
3346 "Search for the next statistics cookie object.
3348 Return value is a cons cell whose CAR is `statistics-cookie' and
3349 CDR is beginning position."
3351 (when (re-search-forward "\\[[0-9]*\\(%\\|/[0-9]*\\)\\]" nil t
)
3352 (cons 'statistics-cookie
(match-beginning 0)))))
3357 (defun org-element-strike-through-parser ()
3358 "Parse strike-through object at point.
3360 Return a list whose CAR is `strike-through' and CDR is a plist
3361 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3362 `:post-blank' keywords.
3364 Assume point is at the first plus sign marker."
3366 (unless (bolp) (backward-char 1))
3367 (looking-at org-emph-re
)
3368 (let ((begin (match-beginning 2))
3369 (contents-begin (match-beginning 4))
3370 (contents-end (match-end 4))
3371 (post-blank (progn (goto-char (match-end 2))
3372 (skip-chars-forward " \t")))
3374 (list 'strike-through
3377 :contents-begin contents-begin
3378 :contents-end contents-end
3379 :post-blank post-blank
)))))
3381 (defun org-element-strike-through-interpreter (strike-through contents
)
3382 "Interpret STRIKE-THROUGH object as Org syntax.
3383 CONTENTS is the contents of the object."
3384 (format "+%s+" contents
))
3389 (defun org-element-subscript-parser ()
3390 "Parse subscript at point.
3392 Return a list whose CAR is `subscript' and CDR a plist with
3393 `:begin', `:end', `:contents-begin', `:contents-end',
3394 `:use-brackets-p' and `:post-blank' as keywords.
3396 Assume point is at the underscore."
3398 (unless (bolp) (backward-char))
3399 (let ((bracketsp (if (looking-at org-match-substring-with-braces-regexp
)
3401 (not (looking-at org-match-substring-regexp
))))
3402 (begin (match-beginning 2))
3403 (contents-begin (or (match-beginning 5)
3404 (match-beginning 3)))
3405 (contents-end (or (match-end 5) (match-end 3)))
3406 (post-blank (progn (goto-char (match-end 0))
3407 (skip-chars-forward " \t")))
3412 :use-brackets-p bracketsp
3413 :contents-begin contents-begin
3414 :contents-end contents-end
3415 :post-blank post-blank
)))))
3417 (defun org-element-subscript-interpreter (subscript contents
)
3418 "Interpret SUBSCRIPT object as Org syntax.
3419 CONTENTS is the contents of the object."
3421 (if (org-element-property :use-brackets-p subscript
) "_{%s}" "_%s")
3424 (defun org-element-sub/superscript-successor
()
3425 "Search for the next sub/superscript object.
3427 Return value is a cons cell whose CAR is either `subscript' or
3428 `superscript' and CDR is beginning position."
3430 (unless (bolp) (backward-char))
3431 (when (re-search-forward org-match-substring-regexp nil t
)
3432 (cons (if (string= (match-string 2) "_") 'subscript
'superscript
)
3433 (match-beginning 2)))))
3438 (defun org-element-superscript-parser ()
3439 "Parse superscript at point.
3441 Return a list whose CAR is `superscript' and CDR a plist with
3442 `:begin', `:end', `:contents-begin', `:contents-end',
3443 `:use-brackets-p' and `:post-blank' as keywords.
3445 Assume point is at the caret."
3447 (unless (bolp) (backward-char))
3448 (let ((bracketsp (if (looking-at org-match-substring-with-braces-regexp
) t
3449 (not (looking-at org-match-substring-regexp
))))
3450 (begin (match-beginning 2))
3451 (contents-begin (or (match-beginning 5)
3452 (match-beginning 3)))
3453 (contents-end (or (match-end 5) (match-end 3)))
3454 (post-blank (progn (goto-char (match-end 0))
3455 (skip-chars-forward " \t")))
3460 :use-brackets-p bracketsp
3461 :contents-begin contents-begin
3462 :contents-end contents-end
3463 :post-blank post-blank
)))))
3465 (defun org-element-superscript-interpreter (superscript contents
)
3466 "Interpret SUPERSCRIPT object as Org syntax.
3467 CONTENTS is the contents of the object."
3469 (if (org-element-property :use-brackets-p superscript
) "^{%s}" "^%s")
3475 (defun org-element-table-cell-parser ()
3476 "Parse table cell at point.
3478 Return a list whose CAR is `table-cell' and CDR is a plist
3479 containing `:begin', `:end', `:contents-begin', `:contents-end'
3480 and `:post-blank' keywords."
3481 (looking-at "[ \t]*\\(.*?\\)[ \t]*|")
3482 (let* ((begin (match-beginning 0))
3484 (contents-begin (match-beginning 1))
3485 (contents-end (match-end 1)))
3489 :contents-begin contents-begin
3490 :contents-end contents-end
3493 (defun org-element-table-cell-interpreter (table-cell contents
)
3494 "Interpret TABLE-CELL element as Org syntax.
3495 CONTENTS is the contents of the cell, or nil."
3496 (concat " " contents
" |"))
3498 (defun org-element-table-cell-successor ()
3499 "Search for the next table-cell object.
3501 Return value is a cons cell whose CAR is `table-cell' and CDR is
3502 beginning position."
3503 (when (looking-at "[ \t]*.*?[ \t]*|") (cons 'table-cell
(point))))
3508 (defun org-element-target-parser ()
3509 "Parse target at point.
3511 Return a list whose CAR is `target' and CDR a plist with
3512 `:begin', `:end', `:value' and `:post-blank' as keywords.
3514 Assume point is at the target."
3516 (looking-at org-target-regexp
)
3517 (let ((begin (point))
3518 (value (org-match-string-no-properties 1))
3519 (post-blank (progn (goto-char (match-end 0))
3520 (skip-chars-forward " \t")))
3526 :post-blank post-blank
)))))
3528 (defun org-element-target-interpreter (target contents
)
3529 "Interpret TARGET object as Org syntax.
3531 (format "<<%s>>" (org-element-property :value target
)))
3533 (defun org-element-target-successor ()
3534 "Search for the next target object.
3536 Return value is a cons cell whose CAR is `target' and CDR is
3537 beginning position."
3539 (when (re-search-forward org-target-regexp nil t
)
3540 (cons 'target
(match-beginning 0)))))
3545 (defun org-element-timestamp-parser ()
3546 "Parse time stamp at point.
3548 Return a list whose CAR is `timestamp', and CDR a plist with
3549 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3551 Assume point is at the beginning of the timestamp."
3553 (let* ((begin (point))
3554 (activep (eq (char-after) ?
<))
3557 (looking-at "\\([<[]\\(%%\\)?.*?\\)[]>]\\(?:--\\([<[].*?[]>]\\)\\)?")
3558 (match-string-no-properties 0)))
3559 (date-start (match-string-no-properties 1))
3560 (date-end (match-string 3))
3561 (diaryp (match-beginning 2))
3562 (post-blank (progn (goto-char (match-end 0))
3563 (skip-chars-forward " \t")))
3568 "[012]?[0-9]:[0-5][0-9]\\(-\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)"
3570 (cons (string-to-number (match-string 2 date-start
))
3571 (string-to-number (match-string 3 date-start
)))))
3572 (type (cond (diaryp 'diary
)
3573 ((and activep
(or date-end time-range
)) 'active-range
)
3575 ((or date-end time-range
) 'inactive-range
)
3579 (string-match "\\([.+]?\\+\\)\\([0-9]+\\)\\([hdwmy]\\)>"
3583 (let ((type (match-string 1 raw-value
)))
3584 (cond ((equal "++" type
) 'catch-up
)
3585 ((equal ".+" type
) 'restart
)
3587 :repeater-value
(string-to-number (match-string 2 raw-value
))
3589 (case (string-to-char (match-string 3 raw-value
))
3590 (?h
'hour
) (?d
'day
) (?w
'week
) (?m
'month
) (t 'year
)))))
3591 year-start month-start day-start hour-start minute-start year-end
3592 month-end day-end hour-end minute-end
)
3593 ;; Parse date-start.
3595 (let ((date (org-parse-time-string date-start t
)))
3596 (setq year-start
(nth 5 date
)
3597 month-start
(nth 4 date
)
3598 day-start
(nth 3 date
)
3599 hour-start
(nth 2 date
)
3600 minute-start
(nth 1 date
))))
3601 ;; Compute date-end. It can be provided directly in time-stamp,
3602 ;; or extracted from time range. Otherwise, it defaults to the
3603 ;; same values as date-start.
3605 (let ((date (and date-end
(org-parse-time-string date-end t
))))
3606 (setq year-end
(or (nth 5 date
) year-start
)
3607 month-end
(or (nth 4 date
) month-start
)
3608 day-end
(or (nth 3 date
) day-start
)
3609 hour-end
(or (nth 2 date
) (car time-range
) hour-start
)
3610 minute-end
(or (nth 1 date
) (cdr time-range
) minute-start
))))
3612 (nconc (list :type type
3613 :raw-value raw-value
3614 :year-start year-start
3615 :month-start month-start
3616 :day-start day-start
3617 :hour-start hour-start
3618 :minute-start minute-start
3620 :month-end month-end
3623 :minute-end minute-end
3626 :post-blank post-blank
)
3629 (defun org-element-timestamp-interpreter (timestamp contents
)
3630 "Interpret TIMESTAMP object as Org syntax.
3632 ;; Use `:raw-value' if specified.
3633 (or (org-element-property :raw-value timestamp
)
3634 ;; Otherwise, build timestamp string.
3635 (let* ((repeat-string
3637 (case (org-element-property :repeater-type timestamp
)
3638 (cumulate "+") (catch-up "++") (restart ".+"))
3639 (let ((val (org-element-property :repeater-value timestamp
)))
3640 (and val
(number-to-string val
)))
3641 (case (org-element-property :repeater-unit timestamp
)
3642 (hour "h") (day "d") (week "w") (month "m") (year "y"))))
3644 ;; Build an Org timestamp string from TIME. ACTIVEP is
3645 ;; non-nil when time stamp is active. If WITH-TIME-P is
3646 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3647 ;; specify a time range in the timestamp. REPEAT-STRING
3648 ;; is the repeater string, if any.
3649 (lambda (time activep
&optional with-time-p hour-end minute-end
)
3650 (let ((ts (format-time-string
3651 (funcall (if with-time-p
'cdr
'car
)
3652 org-time-stamp-formats
)
3654 (when (and hour-end minute-end
)
3655 (string-match "[012]?[0-9]:[0-5][0-9]" ts
)
3658 (format "\\&-%02d:%02d" hour-end minute-end
)
3660 (unless activep
(setq ts
(format "[%s]" (substring ts
1 -
1))))
3661 (when (org-string-nw-p repeat-string
)
3662 (setq ts
(concat (substring ts
0 -
1)
3665 (substring ts -
1))))
3668 (type (org-element-property :type timestamp
)))
3671 (let* ((minute-start (org-element-property :minute-start timestamp
))
3672 (minute-end (org-element-property :minute-end timestamp
))
3673 (hour-start (org-element-property :hour-start timestamp
))
3674 (hour-end (org-element-property :hour-end timestamp
))
3675 (time-range-p (and hour-start hour-end minute-start minute-end
3676 (or (/= hour-start hour-end
)
3677 (/= minute-start minute-end
)))))
3683 (org-element-property :day-start timestamp
)
3684 (org-element-property :month-start timestamp
)
3685 (org-element-property :year-start timestamp
))
3687 (and hour-start minute-start
)
3688 (and time-range-p hour-end
)
3689 (and time-range-p minute-end
))))
3690 ((active-range inactive-range
)
3691 (let ((minute-start (org-element-property :minute-start timestamp
))
3692 (minute-end (org-element-property :minute-end timestamp
))
3693 (hour-start (org-element-property :hour-start timestamp
))
3694 (hour-end (org-element-property :hour-end timestamp
)))
3697 build-ts-string
(encode-time
3701 (org-element-property :day-start timestamp
)
3702 (org-element-property :month-start timestamp
)
3703 (org-element-property :year-start timestamp
))
3704 (eq type
'active-range
)
3705 (and hour-start minute-start
))
3707 (funcall build-ts-string
3711 (org-element-property :day-end timestamp
)
3712 (org-element-property :month-end timestamp
)
3713 (org-element-property :year-end timestamp
))
3714 (eq type
'active-range
)
3715 (and hour-end minute-end
)))))))))
3717 (defun org-element-timestamp-successor ()
3718 "Search for the next timestamp object.
3720 Return value is a cons cell whose CAR is `timestamp' and CDR is
3721 beginning position."
3723 (when (re-search-forward
3724 (concat org-ts-regexp-both
3726 "\\(?:<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[dwmy]>\\)"
3728 "\\(?:<%%\\(?:([^>\n]+)\\)>\\)")
3730 (cons 'timestamp
(match-beginning 0)))))
3735 (defun org-element-underline-parser ()
3736 "Parse underline object at point.
3738 Return a list whose CAR is `underline' and CDR is a plist with
3739 `:begin', `:end', `:contents-begin' and `:contents-end' and
3740 `:post-blank' keywords.
3742 Assume point is at the first underscore marker."
3744 (unless (bolp) (backward-char 1))
3745 (looking-at org-emph-re
)
3746 (let ((begin (match-beginning 2))
3747 (contents-begin (match-beginning 4))
3748 (contents-end (match-end 4))
3749 (post-blank (progn (goto-char (match-end 2))
3750 (skip-chars-forward " \t")))
3755 :contents-begin contents-begin
3756 :contents-end contents-end
3757 :post-blank post-blank
)))))
3759 (defun org-element-underline-interpreter (underline contents
)
3760 "Interpret UNDERLINE object as Org syntax.
3761 CONTENTS is the contents of the object."
3762 (format "_%s_" contents
))
3767 (defun org-element-verbatim-parser ()
3768 "Parse verbatim object at point.
3770 Return a list whose CAR is `verbatim' and CDR is a plist with
3771 `:value', `:begin', `:end' and `:post-blank' keywords.
3773 Assume point is at the first equal sign marker."
3775 (unless (bolp) (backward-char 1))
3776 (looking-at org-emph-re
)
3777 (let ((begin (match-beginning 2))
3778 (value (org-match-string-no-properties 4))
3779 (post-blank (progn (goto-char (match-end 2))
3780 (skip-chars-forward " \t")))
3786 :post-blank post-blank
)))))
3788 (defun org-element-verbatim-interpreter (verbatim contents
)
3789 "Interpret VERBATIM object as Org syntax.
3791 (format "=%s=" (org-element-property :value verbatim
)))
3795 ;;; Parsing Element Starting At Point
3797 ;; `org-element--current-element' is the core function of this section.
3798 ;; It returns the Lisp representation of the element starting at
3801 ;; `org-element--current-element' makes use of special modes. They
3802 ;; are activated for fixed element chaining (i.e. `plain-list' >
3803 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3804 ;; `section'). Special modes are: `first-section', `item',
3805 ;; `node-property', `quote-section', `section' and `table-row'.
3807 (defun org-element--current-element
3808 (limit &optional granularity special structure
)
3809 "Parse the element starting at point.
3811 Return value is a list like (TYPE PROPS) where TYPE is the type
3812 of the element and PROPS a plist of properties associated to the
3815 Possible types are defined in `org-element-all-elements'.
3817 LIMIT bounds the search.
3819 Optional argument GRANULARITY determines the depth of the
3820 recursion. Allowed values are `headline', `greater-element',
3821 `element', `object' or nil. When it is broader than `object' (or
3822 nil), secondary values will not be parsed, since they only
3825 Optional argument SPECIAL, when non-nil, can be either
3826 `first-section', `item', `node-property', `quote-section',
3827 `section', and `table-row'.
3829 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3832 This function assumes point is always at the beginning of the
3833 element it has to parse."
3835 (let ((case-fold-search t
)
3836 ;; Determine if parsing depth allows for secondary strings
3837 ;; parsing. It only applies to elements referenced in
3838 ;; `org-element-secondary-value-alist'.
3839 (raw-secondary-p (and granularity
(not (eq granularity
'object
)))))
3843 (org-element-item-parser limit structure raw-secondary-p
))
3845 ((eq special
'table-row
) (org-element-table-row-parser limit
))
3847 ((eq special
'node-property
) (org-element-node-property-parser limit
))
3849 ((org-with-limited-levels (org-at-heading-p))
3850 (org-element-headline-parser limit raw-secondary-p
))
3851 ;; Sections (must be checked after headline).
3852 ((eq special
'section
) (org-element-section-parser limit
))
3853 ((eq special
'quote-section
) (org-element-quote-section-parser limit
))
3854 ((eq special
'first-section
)
3855 (org-element-section-parser
3856 (or (save-excursion (org-with-limited-levels (outline-next-heading)))
3858 ;; When not at bol, point is at the beginning of an item or
3859 ;; a footnote definition: next item is always a paragraph.
3860 ((not (bolp)) (org-element-paragraph-parser limit
(list (point))))
3861 ;; Planning and Clock.
3862 ((looking-at org-planning-or-clock-line-re
)
3863 (if (equal (match-string 1) org-clock-string
)
3864 (org-element-clock-parser limit
)
3865 (org-element-planning-parser limit
)))
3868 (org-element-inlinetask-parser limit raw-secondary-p
))
3869 ;; From there, elements can have affiliated keywords.
3870 (t (let ((affiliated (org-element--collect-affiliated-keywords limit
)))
3872 ;; Jumping over affiliated keywords put point off-limits.
3873 ;; Parse them as regular keywords.
3874 ((and (cdr affiliated
) (>= (point) limit
))
3875 (goto-char (car affiliated
))
3876 (org-element-keyword-parser limit nil
))
3877 ;; LaTeX Environment.
3879 "[ \t]*\\\\begin{[A-Za-z0-9*]+}\\(\\[.*?\\]\\|{.*?}\\)*[ \t]*$")
3880 (org-element-latex-environment-parser limit affiliated
))
3881 ;; Drawer and Property Drawer.
3882 ((looking-at org-drawer-regexp
)
3883 (if (equal (match-string 1) "PROPERTIES")
3884 (org-element-property-drawer-parser limit affiliated
)
3885 (org-element-drawer-parser limit affiliated
)))
3887 ((looking-at "[ \t]*:\\( \\|$\\)")
3888 (org-element-fixed-width-parser limit affiliated
))
3889 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3891 ((looking-at "[ \t]*#")
3892 (goto-char (match-end 0))
3893 (cond ((looking-at "\\(?: \\|$\\)")
3895 (org-element-comment-parser limit affiliated
))
3896 ((looking-at "\\+BEGIN_\\(\\S-+\\)")
3898 (let ((parser (assoc (upcase (match-string 1))
3899 org-element-block-name-alist
)))
3900 (if parser
(funcall (cdr parser
) limit affiliated
)
3901 (org-element-special-block-parser limit affiliated
))))
3902 ((looking-at "\\+CALL:")
3904 (org-element-babel-call-parser limit affiliated
))
3905 ((looking-at "\\+BEGIN:? ")
3907 (org-element-dynamic-block-parser limit affiliated
))
3908 ((looking-at "\\+\\S-+:")
3910 (org-element-keyword-parser limit affiliated
))
3913 (org-element-paragraph-parser limit affiliated
))))
3914 ;; Footnote Definition.
3915 ((looking-at org-footnote-definition-re
)
3916 (org-element-footnote-definition-parser limit affiliated
))
3918 ((looking-at "[ \t]*-\\{5,\\}[ \t]*$")
3919 (org-element-horizontal-rule-parser limit affiliated
))
3922 (org-element-diary-sexp-parser limit affiliated
))
3924 ((org-at-table-p t
) (org-element-table-parser limit affiliated
))
3926 ((looking-at (org-item-re))
3927 (org-element-plain-list-parser
3929 (or structure
(org-element--list-struct limit
))))
3930 ;; Default element: Paragraph.
3931 (t (org-element-paragraph-parser limit affiliated
)))))))))
3934 ;; Most elements can have affiliated keywords. When looking for an
3935 ;; element beginning, we want to move before them, as they belong to
3936 ;; that element, and, in the meantime, collect information they give
3937 ;; into appropriate properties. Hence the following function.
3939 (defun org-element--collect-affiliated-keywords (limit)
3940 "Collect affiliated keywords from point down to LIMIT.
3942 Return a list whose CAR is the position at the first of them and
3943 CDR a plist of keywords and values and move point to the
3944 beginning of the first line after them.
3946 As a special case, if element doesn't start at the beginning of
3947 the line (i.e. a paragraph starting an item), CAR is current
3948 position of point and CDR is nil."
3949 (if (not (bolp)) (list (point))
3950 (let ((case-fold-search t
)
3952 ;; RESTRICT is the list of objects allowed in parsed
3954 (restrict (org-element-restriction 'keyword
))
3956 (while (and (< (point) limit
) (looking-at org-element--affiliated-re
))
3957 (let* ((raw-kwd (upcase (match-string 1)))
3958 ;; Apply translation to RAW-KWD. From there, KWD is
3959 ;; the official keyword.
3960 (kwd (or (cdr (assoc raw-kwd
3961 org-element-keyword-translation-alist
))
3963 ;; Find main value for any keyword.
3967 (buffer-substring-no-properties
3968 (match-end 0) (point-at-eol)))))
3969 ;; PARSEDP is non-nil when keyword should have its
3971 (parsedp (member kwd org-element-parsed-keywords
))
3972 ;; If KWD is a dual keyword, find its secondary
3973 ;; value. Maybe parse it.
3974 (dualp (member kwd org-element-dual-keywords
))
3977 (let ((sec (org-match-string-no-properties 2)))
3978 (if (or (not sec
) (not parsedp
)) sec
3979 (org-element-parse-secondary-string sec restrict
)))))
3980 ;; Attribute a property name to KWD.
3981 (kwd-sym (and kwd
(intern (concat ":" (downcase kwd
))))))
3982 ;; Now set final shape for VALUE.
3984 (setq value
(org-element-parse-secondary-string value restrict
)))
3986 (setq value
(and (or value dual-value
) (cons value dual-value
))))
3987 (when (or (member kwd org-element-multiple-keywords
)
3988 ;; Attributes can always appear on multiple lines.
3989 (string-match "^ATTR_" kwd
))
3990 (setq value
(cons value
(plist-get output kwd-sym
))))
3991 ;; Eventually store the new value in OUTPUT.
3992 (setq output
(plist-put output kwd-sym value
))
3993 ;; Move to next keyword.
3995 ;; If affiliated keywords are orphaned: move back to first one.
3996 ;; They will be parsed as a paragraph.
3997 (when (looking-at "[ \t]*$") (goto-char origin
) (setq output nil
))
3999 (cons origin output
))))
4005 ;; The two major functions here are `org-element-parse-buffer', which
4006 ;; parses Org syntax inside the current buffer, taking into account
4007 ;; region, narrowing, or even visibility if specified, and
4008 ;; `org-element-parse-secondary-string', which parses objects within
4011 ;; The (almost) almighty `org-element-map' allows to apply a function
4012 ;; on elements or objects matching some type, and accumulate the
4013 ;; resulting values. In an export situation, it also skips unneeded
4014 ;; parts of the parse tree.
4016 (defun org-element-parse-buffer (&optional granularity visible-only
)
4017 "Recursively parse the buffer and return structure.
4018 If narrowing is in effect, only parse the visible part of the
4021 Optional argument GRANULARITY determines the depth of the
4022 recursion. It can be set to the following symbols:
4024 `headline' Only parse headlines.
4025 `greater-element' Don't recurse into greater elements excepted
4026 headlines and sections. Thus, elements
4027 parsed are the top-level ones.
4028 `element' Parse everything but objects and plain text.
4029 `object' Parse the complete buffer (default).
4031 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4034 An element or an objects is represented as a list with the
4035 pattern (TYPE PROPERTIES CONTENTS), where :
4037 TYPE is a symbol describing the element or object. See
4038 `org-element-all-elements' and `org-element-all-objects' for an
4039 exhaustive list of such symbols. One can retrieve it with
4040 `org-element-type' function.
4042 PROPERTIES is the list of attributes attached to the element or
4043 object, as a plist. Although most of them are specific to the
4044 element or object type, all types share `:begin', `:end',
4045 `:post-blank' and `:parent' properties, which respectively
4046 refer to buffer position where the element or object starts,
4047 ends, the number of white spaces or blank lines after it, and
4048 the element or object containing it. Properties values can be
4049 obtained by using `org-element-property' function.
4051 CONTENTS is a list of elements, objects or raw strings
4052 contained in the current element or object, when applicable.
4053 One can access them with `org-element-contents' function.
4055 The Org buffer has `org-data' as type and nil as properties.
4056 `org-element-map' function can be used to find specific elements
4057 or objects within the parse tree.
4059 This function assumes that current major mode is `org-mode'."
4061 (goto-char (point-min))
4062 (org-skip-whitespace)
4063 (org-element--parse-elements
4064 (point-at-bol) (point-max)
4065 ;; Start in `first-section' mode so text before the first
4066 ;; headline belongs to a section.
4067 'first-section nil granularity visible-only
(list 'org-data nil
))))
4069 (defun org-element-parse-secondary-string (string restriction
&optional parent
)
4070 "Recursively parse objects in STRING and return structure.
4072 RESTRICTION is a symbol limiting the object types that will be
4075 Optional argument PARENT, when non-nil, is the element or object
4076 containing the secondary string. It is used to set correctly
4077 `:parent' property within the string."
4078 ;; Copy buffer-local variables listed in
4079 ;; `org-element-object-variables' into temporary buffer. This is
4080 ;; required since object parsing is dependent on these variables.
4081 (let ((pairs (delq nil
(mapcar (lambda (var)
4083 (cons var
(symbol-value var
))))
4084 org-element-object-variables
))))
4086 (mapc (lambda (pair) (org-set-local (car pair
) (cdr pair
))) pairs
)
4088 (let ((secondary (org-element--parse-objects
4089 (point-min) (point-max) nil restriction
)))
4091 (mapc (lambda (obj) (org-element-put-property obj
:parent parent
))
4095 (defun org-element-map
4096 (data types fun
&optional info first-match no-recursion with-affiliated
)
4097 "Map a function on selected elements or objects.
4099 DATA is a parse tree, an element, an object, a string, or a list
4100 of such constructs. TYPES is a symbol or list of symbols of
4101 elements or objects types (see `org-element-all-elements' and
4102 `org-element-all-objects' for a complete list of types). FUN is
4103 the function called on the matching element or object. It has to
4104 accept one argument: the element or object itself.
4106 When optional argument INFO is non-nil, it should be a plist
4107 holding export options. In that case, parts of the parse tree
4108 not exportable according to that property list will be skipped.
4110 When optional argument FIRST-MATCH is non-nil, stop at the first
4111 match for which FUN doesn't return nil, and return that value.
4113 Optional argument NO-RECURSION is a symbol or a list of symbols
4114 representing elements or objects types. `org-element-map' won't
4115 enter any recursive element or object whose type belongs to that
4116 list. Though, FUN can still be applied on them.
4118 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4119 apply to matching objects within parsed affiliated keywords (see
4120 `org-element-parsed-keywords').
4122 Nil values returned from FUN do not appear in the results.
4128 Assuming TREE is a variable containing an Org buffer parse tree,
4129 the following example will return a flat list of all `src-block'
4130 and `example-block' elements in it:
4132 \(org-element-map tree '(example-block src-block) 'identity)
4134 The following snippet will find the first headline with a level
4135 of 1 and a \"phone\" tag, and will return its beginning position:
4137 \(org-element-map tree 'headline
4139 \(and (= (org-element-property :level hl) 1)
4140 \(member \"phone\" (org-element-property :tags hl))
4141 \(org-element-property :begin hl)))
4144 The next example will return a flat list of all `plain-list' type
4145 elements in TREE that are not a sub-list themselves:
4147 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4149 Eventually, this example will return a flat list of all `bold'
4150 type objects containing a `latex-snippet' type object, even
4151 looking into captions:
4153 \(org-element-map tree 'bold
4155 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4157 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4158 (unless (listp types
) (setq types
(list types
)))
4159 (unless (listp no-recursion
) (setq no-recursion
(list no-recursion
)))
4160 ;; Recursion depth is determined by --CATEGORY.
4163 (let ((category 'greater-elements
))
4164 (mapc (lambda (type)
4165 (cond ((or (memq type org-element-all-objects
)
4166 (eq type
'plain-text
))
4167 ;; If one object is found, the function
4168 ;; has to recurse into every object.
4169 (throw 'found
'objects
))
4170 ((not (memq type org-element-greater-elements
))
4171 ;; If one regular element is found, the
4172 ;; function has to recurse, at least,
4173 ;; into every element it encounters.
4174 (and (not (eq category
'elements
))
4175 (setq category
'elements
)))))
4178 ;; Compute properties for affiliated keywords if necessary.
4180 (and with-affiliated
4181 (mapcar (lambda (kwd)
4182 (cons kwd
(intern (concat ":" (downcase kwd
)))))
4183 org-element-affiliated-keywords
)))
4189 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4190 ;; holding contextual information.
4191 (let ((--type (org-element-type --data
)))
4194 ;; Ignored element in an export context.
4195 ((and info
(memq --data
(plist-get info
:ignore-list
))))
4196 ;; List of elements or objects.
4197 ((not --type
) (mapc --walk-tree --data
))
4198 ;; Unconditionally enter parse trees.
4199 ((eq --type
'org-data
)
4200 (mapc --walk-tree
(org-element-contents --data
)))
4202 ;; Check if TYPE is matching among TYPES. If so,
4203 ;; apply FUN to --DATA and accumulate return value
4204 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4205 (when (memq --type types
)
4206 (let ((result (funcall fun --data
)))
4207 (cond ((not result
))
4208 (first-match (throw '--map-first-match result
))
4209 (t (push result --acc
)))))
4210 ;; If --DATA has a secondary string that can contain
4211 ;; objects with their type among TYPES, look into it.
4212 (when (and (eq --category
'objects
) (not (stringp --data
)))
4214 (assq --type org-element-secondary-value-alist
)))
4216 (funcall --walk-tree
4217 (org-element-property (cdr sec-prop
) --data
)))))
4218 ;; If --DATA has any affiliated keywords and
4219 ;; WITH-AFFILIATED is non-nil, look for objects in
4221 (when (and with-affiliated
4222 (eq --category
'objects
)
4223 (memq --type org-element-all-elements
))
4224 (mapc (lambda (kwd-pair)
4225 (let ((kwd (car kwd-pair
))
4226 (value (org-element-property
4227 (cdr kwd-pair
) --data
)))
4228 ;; Pay attention to the type of value.
4229 ;; Preserve order for multiple keywords.
4232 ((and (member kwd org-element-multiple-keywords
)
4233 (member kwd org-element-dual-keywords
))
4234 (mapc (lambda (line)
4235 (funcall --walk-tree
(cdr line
))
4236 (funcall --walk-tree
(car line
)))
4238 ((member kwd org-element-multiple-keywords
)
4239 (mapc (lambda (line) (funcall --walk-tree line
))
4241 ((member kwd org-element-dual-keywords
)
4242 (funcall --walk-tree
(cdr value
))
4243 (funcall --walk-tree
(car value
)))
4244 (t (funcall --walk-tree value
)))))
4245 --affiliated-alist
))
4246 ;; Determine if a recursion into --DATA is possible.
4248 ;; --TYPE is explicitly removed from recursion.
4249 ((memq --type no-recursion
))
4250 ;; --DATA has no contents.
4251 ((not (org-element-contents --data
)))
4252 ;; Looking for greater elements but --DATA is simply
4253 ;; an element or an object.
4254 ((and (eq --category
'greater-elements
)
4255 (not (memq --type org-element-greater-elements
))))
4256 ;; Looking for elements but --DATA is an object.
4257 ((and (eq --category
'elements
)
4258 (memq --type org-element-all-objects
)))
4259 ;; In any other case, map contents.
4260 (t (mapc --walk-tree
(org-element-contents --data
)))))))))))
4261 (catch '--map-first-match
4262 (funcall --walk-tree data
)
4263 ;; Return value in a proper order.
4265 (put 'org-element-map
'lisp-indent-function
2)
4267 ;; The following functions are internal parts of the parser.
4269 ;; The first one, `org-element--parse-elements' acts at the element's
4272 ;; The second one, `org-element--parse-objects' applies on all objects
4273 ;; of a paragraph or a secondary string. It uses
4274 ;; `org-element--get-next-object-candidates' to optimize the search of
4275 ;; the next object in the buffer.
4277 ;; More precisely, that function looks for every allowed object type
4278 ;; first. Then, it discards failed searches, keeps further matches,
4279 ;; and searches again types matched behind point, for subsequent
4280 ;; calls. Thus, searching for a given type fails only once, and every
4281 ;; object is searched only once at top level (but sometimes more for
4284 (defun org-element--parse-elements
4285 (beg end special structure granularity visible-only acc
)
4286 "Parse elements between BEG and END positions.
4288 SPECIAL prioritize some elements over the others. It can be set
4289 to `first-section', `quote-section', `section' `item' or
4292 When value is `item', STRUCTURE will be used as the current list
4295 GRANULARITY determines the depth of the recursion. See
4296 `org-element-parse-buffer' for more information.
4298 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4301 Elements are accumulated into ACC."
4304 ;; Visible only: skip invisible parts at the beginning of the
4306 (when (and visible-only
(org-invisible-p2))
4307 (goto-char (min (1+ (org-find-visible)) end
)))
4308 ;; When parsing only headlines, skip any text before first one.
4309 (when (and (eq granularity
'headline
) (not (org-at-heading-p)))
4310 (org-with-limited-levels (outline-next-heading)))
4312 (while (< (point) end
)
4313 ;; Find current element's type and parse it accordingly to
4315 (let* ((element (org-element--current-element
4316 end granularity special structure
))
4317 (type (org-element-type element
))
4318 (cbeg (org-element-property :contents-begin element
)))
4319 (goto-char (org-element-property :end element
))
4320 ;; Visible only: skip invisible parts between siblings.
4321 (when (and visible-only
(org-invisible-p2))
4322 (goto-char (min (1+ (org-find-visible)) end
)))
4323 ;; Fill ELEMENT contents by side-effect.
4325 ;; If element has no contents, don't modify it.
4327 ;; Greater element: parse it between `contents-begin' and
4328 ;; `contents-end'. Make sure GRANULARITY allows the
4329 ;; recursion, or ELEMENT is a headline, in which case going
4330 ;; inside is mandatory, in order to get sub-level headings.
4331 ((and (memq type org-element-greater-elements
)
4332 (or (memq granularity
'(element object nil
))
4333 (and (eq granularity
'greater-element
)
4335 (eq type
'headline
)))
4336 (org-element--parse-elements
4337 cbeg
(org-element-property :contents-end element
)
4338 ;; Possibly switch to a special mode.
4341 (if (org-element-property :quotedp element
) 'quote-section
4344 (property-drawer 'node-property
)
4346 (and (memq type
'(item plain-list
))
4347 (org-element-property :structure element
))
4348 granularity visible-only element
))
4349 ;; ELEMENT has contents. Parse objects inside, if
4350 ;; GRANULARITY allows it.
4351 ((memq granularity
'(object nil
))
4352 (org-element--parse-objects
4353 cbeg
(org-element-property :contents-end element
) element
4354 (org-element-restriction type
))))
4355 (org-element-adopt-elements acc element
)))
4359 (defun org-element--parse-objects (beg end acc restriction
)
4360 "Parse objects between BEG and END and return recursive structure.
4362 Objects are accumulated in ACC.
4364 RESTRICTION is a list of object successors which are allowed in
4365 the current object."
4366 (let ((candidates 'initial
))
4369 (narrow-to-region beg end
)
4370 (goto-char (point-min))
4371 (while (and (not (eobp))
4373 (org-element--get-next-object-candidates
4374 restriction candidates
)))
4376 (let ((pos (apply 'min
(mapcar 'cdr candidates
))))
4379 (funcall (intern (format "org-element-%s-parser"
4380 (car (rassq pos candidates
)))))))))
4381 ;; 1. Text before any object. Untabify it.
4382 (let ((obj-beg (org-element-property :begin next-object
)))
4383 (unless (= (point) obj-beg
)
4385 (org-element-adopt-elements
4387 (replace-regexp-in-string
4388 "\t" (make-string tab-width ?
)
4389 (buffer-substring-no-properties (point) obj-beg
))))))
4391 (let ((obj-end (org-element-property :end next-object
))
4392 (cont-beg (org-element-property :contents-begin next-object
)))
4393 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4394 ;; a recursive type.
4396 (memq (car next-object
) org-element-recursive-objects
))
4397 (org-element--parse-objects
4398 cont-beg
(org-element-property :contents-end next-object
)
4399 next-object
(org-element-restriction next-object
)))
4400 (setq acc
(org-element-adopt-elements acc next-object
))
4401 (goto-char obj-end
))))
4402 ;; 3. Text after last object. Untabify it.
4405 (org-element-adopt-elements
4407 (replace-regexp-in-string
4408 "\t" (make-string tab-width ?
)
4409 (buffer-substring-no-properties (point) end
)))))
4413 (defun org-element--get-next-object-candidates (restriction objects
)
4414 "Return an alist of candidates for the next object.
4416 RESTRICTION is a list of object types, as symbols. Only
4417 candidates with such types are looked after.
4419 OBJECTS is the previous candidates alist. If it is set to
4420 `initial', no search has been done before, and all symbols in
4421 RESTRICTION should be looked after.
4423 Return value is an alist whose CAR is the object type and CDR its
4424 beginning position."
4427 (if (eq objects
'initial
)
4428 ;; When searching for the first time, look for every successor
4429 ;; allowed in RESTRICTION.
4432 (funcall (intern (format "org-element-%s-successor" res
))))
4434 ;; Focus on objects returned during last search. Keep those
4435 ;; still after point. Search again objects before it.
4438 (if (>= (cdr obj
) (point)) obj
4439 (let* ((type (car obj
))
4440 (succ (or (cdr (assq type org-element-object-successor-alist
))
4443 (funcall (intern (format "org-element-%s-successor" succ
)))))))
4448 ;;; Towards A Bijective Process
4450 ;; The parse tree obtained with `org-element-parse-buffer' is really
4451 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4452 ;; interpreted and expanded into a string with canonical Org syntax.
4453 ;; Hence `org-element-interpret-data'.
4455 ;; The function relies internally on
4456 ;; `org-element--interpret-affiliated-keywords'.
4459 (defun org-element-interpret-data (data &optional parent
)
4460 "Interpret DATA as Org syntax.
4462 DATA is a parse tree, an element, an object or a secondary string
4465 Optional argument PARENT is used for recursive calls. It contains
4466 the element or object containing data, or nil.
4468 Return Org syntax as a string."
4469 (let* ((type (org-element-type data
))
4472 ;; Secondary string.
4475 (lambda (obj) (org-element-interpret-data obj parent
))
4477 ;; Full Org document.
4478 ((eq type
'org-data
)
4480 (lambda (obj) (org-element-interpret-data obj parent
))
4481 (org-element-contents data
) ""))
4482 ;; Plain text: remove `:parent' text property from output.
4483 ((stringp data
) (org-no-properties data
))
4484 ;; Element/Object without contents.
4485 ((not (org-element-contents data
))
4486 (funcall (intern (format "org-element-%s-interpreter" type
))
4488 ;; Element/Object with contents.
4490 (let* ((greaterp (memq type org-element-greater-elements
))
4491 (objectp (and (not greaterp
)
4492 (memq type org-element-recursive-objects
)))
4495 (lambda (obj) (org-element-interpret-data obj data
))
4496 (org-element-contents
4497 (if (or greaterp objectp
) data
4498 ;; Elements directly containing objects must
4499 ;; have their indentation normalized first.
4500 (org-element-normalize-contents
4502 ;; When normalizing first paragraph of an
4503 ;; item or a footnote-definition, ignore
4504 ;; first line's indentation.
4505 (and (eq type
'paragraph
)
4506 (equal data
(car (org-element-contents parent
)))
4507 (memq (org-element-type parent
)
4508 '(footnote-definition item
))))))
4510 (funcall (intern (format "org-element-%s-interpreter" type
))
4512 (if greaterp
(org-element-normalize-contents contents
)
4514 (if (memq type
'(org-data plain-text nil
)) results
4515 ;; Build white spaces. If no `:post-blank' property is
4516 ;; specified, assume its value is 0.
4517 (let ((post-blank (or (org-element-property :post-blank data
) 0)))
4518 (if (memq type org-element-all-objects
)
4519 (concat results
(make-string post-blank
32))
4521 (org-element--interpret-affiliated-keywords data
)
4522 (org-element-normalize-string results
)
4523 (make-string post-blank
10)))))))
4525 (defun org-element--interpret-affiliated-keywords (element)
4526 "Return ELEMENT's affiliated keywords as Org syntax.
4527 If there is no affiliated keyword, return the empty string."
4528 (let ((keyword-to-org
4532 (when (member key org-element-dual-keywords
)
4533 (setq dual
(cdr value
) value
(car value
)))
4536 (format "[%s]" (org-element-interpret-data dual
)))
4538 (if (member key org-element-parsed-keywords
)
4539 (org-element-interpret-data value
)
4544 (let ((value (org-element-property prop element
))
4545 (keyword (upcase (substring (symbol-name prop
) 1))))
4547 (if (or (member keyword org-element-multiple-keywords
)
4548 ;; All attribute keywords can have multiple lines.
4549 (string-match "^ATTR_" keyword
))
4550 (mapconcat (lambda (line) (funcall keyword-to-org keyword line
))
4553 (funcall keyword-to-org keyword value
)))))
4554 ;; List all ELEMENT's properties matching an attribute line or an
4555 ;; affiliated keyword, but ignore translated keywords since they
4556 ;; cannot belong to the property list.
4557 (loop for prop in
(nth 1 element
) by
'cddr
4558 when
(let ((keyword (upcase (substring (symbol-name prop
) 1))))
4559 (or (string-match "^ATTR_" keyword
)
4561 (member keyword org-element-affiliated-keywords
)
4563 org-element-keyword-translation-alist
)))))
4567 ;; Because interpretation of the parse tree must return the same
4568 ;; number of blank lines between elements and the same number of white
4569 ;; space after objects, some special care must be given to white
4572 ;; The first function, `org-element-normalize-string', ensures any
4573 ;; string different from the empty string will end with a single
4574 ;; newline character.
4576 ;; The second function, `org-element-normalize-contents', removes
4577 ;; global indentation from the contents of the current element.
4579 (defun org-element-normalize-string (s)
4580 "Ensure string S ends with a single newline character.
4582 If S isn't a string return it unchanged. If S is the empty
4583 string, return it. Otherwise, return a new string with a single
4584 newline character at its end."
4586 ((not (stringp s
)) s
)
4588 (t (and (string-match "\\(\n[ \t]*\\)*\\'" s
)
4589 (replace-match "\n" nil nil s
)))))
4591 (defun org-element-normalize-contents (element &optional ignore-first
)
4592 "Normalize plain text in ELEMENT's contents.
4594 ELEMENT must only contain plain text and objects.
4596 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4597 indentation to compute maximal common indentation.
4599 Return the normalized element that is element with global
4600 indentation removed from its contents. The function assumes that
4601 indentation is not done with TAB characters."
4602 (let* (ind-list ; for byte-compiler
4603 collect-inds
; for byte-compiler
4606 ;; Return list of indentations within BLOB. This is done by
4607 ;; walking recursively BLOB and updating IND-LIST along the
4608 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4609 ;; been seen yet. It is required as this string is the only
4610 ;; one whose indentation doesn't happen after a newline
4612 (lambda (blob first-flag
)
4615 (when (and first-flag
(stringp object
))
4616 (setq first-flag nil
)
4617 (string-match "\\`\\( *\\)" object
)
4618 (let ((len (length (match-string 1 object
))))
4619 ;; An indentation of zero means no string will be
4620 ;; modified. Quit the process.
4621 (if (zerop len
) (throw 'zero
(setq ind-list nil
))
4622 (push len ind-list
))))
4626 ;; Avoid matching blank or empty lines.
4627 (while (and (string-match "\n\\( *\\)\\(.\\)" object start
)
4628 (not (equal (match-string 2 object
) " ")))
4629 (setq start
(match-end 0))
4630 (push (length (match-string 1 object
)) ind-list
))))
4631 ((memq (org-element-type object
) org-element-recursive-objects
)
4632 (funcall collect-inds object first-flag
))))
4633 (org-element-contents blob
))))))
4634 ;; Collect indentation list in ELEMENT. Possibly remove first
4635 ;; value if IGNORE-FIRST is non-nil.
4636 (catch 'zero
(funcall collect-inds element
(not ignore-first
)))
4637 (if (not ind-list
) element
4638 ;; Build ELEMENT back, replacing each string with the same
4639 ;; string minus common indentation.
4640 (let* (build ; For byte compiler.
4643 (lambda (blob mci first-flag
)
4644 ;; Return BLOB with all its strings indentation
4645 ;; shortened from MCI white spaces. FIRST-FLAG is
4646 ;; non-nil when the first string hasn't been seen
4651 (when (and first-flag
(stringp object
))
4652 (setq first-flag nil
)
4654 (replace-regexp-in-string
4655 (format "\\` \\{%d\\}" mci
) "" object
)))
4658 (replace-regexp-in-string
4659 (format "\n \\{%d\\}" mci
) "\n" object
))
4660 ((memq (org-element-type object
)
4661 org-element-recursive-objects
)
4662 (funcall build object mci first-flag
))
4664 (org-element-contents blob
)))
4666 (funcall build element
(apply 'min ind-list
) (not ignore-first
))))))
4672 ;; The first move is to implement a way to obtain the smallest element
4673 ;; containing point. This is the job of `org-element-at-point'. It
4674 ;; basically jumps back to the beginning of section containing point
4675 ;; and moves, element after element, with
4676 ;; `org-element--current-element' until the container is found. Note:
4677 ;; When using `org-element-at-point', secondary values are never
4678 ;; parsed since the function focuses on elements, not on objects.
4680 ;; At a deeper level, `org-element-context' lists all elements and
4681 ;; objects containing point.
4683 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4684 ;; internally by navigation and manipulation tools.
4687 (defun org-element-at-point (&optional keep-trail
)
4688 "Determine closest element around point.
4690 Return value is a list like (TYPE PROPS) where TYPE is the type
4691 of the element and PROPS a plist of properties associated to the
4694 Possible types are defined in `org-element-all-elements'.
4695 Properties depend on element or object type, but always include
4696 `:begin', `:end', `:parent' and `:post-blank' properties.
4698 As a special case, if point is at the very beginning of a list or
4699 sub-list, returned element will be that list instead of the first
4700 item. In the same way, if point is at the beginning of the first
4701 row of a table, returned element will be the table instead of the
4704 If optional argument KEEP-TRAIL is non-nil, the function returns
4705 a list of elements leading to element at point. The list's CAR
4706 is always the element at point. The following positions contain
4707 element's siblings, then parents, siblings of parents, until the
4708 first element of current section."
4709 (org-with-wide-buffer
4710 ;; If at a headline, parse it. It is the sole element that
4711 ;; doesn't require to know about context. Be sure to disallow
4712 ;; secondary string parsing, though.
4713 (if (org-with-limited-levels (org-at-heading-p))
4716 (if (not keep-trail
) (org-element-headline-parser (point-max) t
)
4717 (list (org-element-headline-parser (point-max) t
))))
4718 ;; Otherwise move at the beginning of the section containing
4721 (let ((origin (point))
4722 (end (save-excursion
4723 (org-with-limited-levels (outline-next-heading)) (point)))
4724 element type special-flag trail struct prevs parent
)
4725 (org-with-limited-levels
4726 (if (org-before-first-heading-p)
4727 ;; In empty lines at buffer's beginning, return nil.
4728 (progn (goto-char (point-min))
4729 (org-skip-whitespace)
4730 (when (or (eobp) (> (line-beginning-position) origin
))
4732 (org-back-to-heading)
4734 (org-skip-whitespace)
4735 (when (> (line-beginning-position) origin
)
4736 ;; In blank lines just after the headline, point still
4737 ;; belongs to the headline.
4739 (progn (org-back-to-heading)
4740 (if (not keep-trail
)
4741 (org-element-headline-parser (point-max) t
)
4742 (list (org-element-headline-parser
4743 (point-max) t
))))))))
4745 ;; Parse successively each element, skipping those ending
4746 ;; before original position.
4749 (org-element--current-element end
'element special-flag struct
)
4751 (org-element-put-property element
:parent parent
)
4752 (when keep-trail
(push element trail
))
4754 ;; 1. Skip any element ending before point. Also skip
4755 ;; element ending at point when we're sure that another
4756 ;; element has started.
4757 ((let ((elem-end (org-element-property :end element
)))
4758 (when (or (< elem-end origin
)
4759 (and (= elem-end origin
) (/= elem-end end
)))
4760 (goto-char elem-end
))))
4761 ;; 2. An element containing point is always the element at
4763 ((not (memq type org-element-greater-elements
))
4764 (throw 'exit
(if keep-trail trail element
)))
4765 ;; 3. At any other greater element type, if point is
4766 ;; within contents, move into it.
4768 (let ((cbeg (org-element-property :contents-begin element
))
4769 (cend (org-element-property :contents-end element
)))
4770 (if (or (not cbeg
) (not cend
) (> cbeg origin
) (< cend origin
)
4771 ;; Create an anchor for tables and plain lists:
4772 ;; when point is at the very beginning of these
4773 ;; elements, ignoring affiliated keywords,
4774 ;; target them instead of their contents.
4775 (and (= cbeg origin
) (memq type
'(plain-list table
)))
4776 ;; When point is at contents end, do not move
4777 ;; into elements with an explicit ending, but
4778 ;; return that element instead.
4779 (and (= cend origin
)
4782 drawer dynamic-block inlinetask item
4783 plain-list property-drawer quote-block
4785 (throw 'exit
(if keep-trail trail element
))
4786 (setq parent element
)
4789 (setq special-flag
'item
4790 struct
(org-element-property :structure element
)))
4791 (item (setq special-flag nil
))
4793 (setq special-flag
'node-property struct nil
))
4794 (table (setq special-flag
'table-row struct nil
))
4795 (otherwise (setq special-flag nil struct nil
)))
4797 (goto-char cbeg
)))))))))))
4800 (defun org-element-context (&optional element
)
4801 "Return closest element or object around point.
4803 Return value is a list like (TYPE PROPS) where TYPE is the type
4804 of the element or object and PROPS a plist of properties
4807 Possible types are defined in `org-element-all-elements' and
4808 `org-element-all-objects'. Properties depend on element or
4809 object type, but always include `:begin', `:end', `:parent' and
4812 Optional argument ELEMENT, when non-nil, is the closest element
4813 containing point, as returned by `org-element-at-point'.
4814 Providing it allows for quicker computation."
4815 (catch 'objects-forbidden
4816 (org-with-wide-buffer
4817 (let* ((origin (point))
4818 (element (or element
(org-element-at-point)))
4819 (type (org-element-type element
))
4821 ;; Check if point is inside an element containing objects or at
4822 ;; a secondary string. In that case, narrow buffer to the
4823 ;; containing area. Otherwise, return ELEMENT.
4825 ;; At a parsed affiliated keyword, check if we're inside main
4827 ((let ((post (org-element-property :post-affiliated element
)))
4828 (and post
(< origin post
)))
4830 (looking-at org-element--affiliated-re
)
4832 ((not (member (upcase (match-string 1)) org-element-parsed-keywords
))
4833 (throw 'objects-forbidden element
))
4834 ((< (match-end 0) origin
)
4835 (narrow-to-region (match-end 0) (line-end-position)))
4836 ((and (match-beginning 2)
4837 (>= origin
(match-beginning 2))
4838 (< origin
(match-end 2)))
4839 (narrow-to-region (match-beginning 2) (match-end 2)))
4840 (t (throw 'objects-forbidden element
)))
4841 ;; Also change type to retrieve correct restrictions.
4842 (setq type
'keyword
))
4843 ;; At an item, objects can only be located within tag, if any.
4845 (let ((tag (org-element-property :tag element
)))
4846 (if (not tag
) (throw 'objects-forbidden element
)
4848 (search-forward tag
(line-end-position))
4849 (goto-char (match-beginning 0))
4850 (if (and (>= origin
(point)) (< origin
(match-end 0)))
4851 (narrow-to-region (point) (match-end 0))
4852 (throw 'objects-forbidden element
)))))
4853 ;; At an headline or inlinetask, objects are located within
4855 ((memq type
'(headline inlinetask
))
4856 (goto-char (org-element-property :begin element
))
4857 (skip-chars-forward "* ")
4858 (if (and (>= origin
(point)) (< origin
(line-end-position)))
4859 (narrow-to-region (point) (line-end-position))
4860 (throw 'objects-forbidden element
)))
4861 ;; At a paragraph, a table-row or a verse block, objects are
4862 ;; located within their contents.
4863 ((memq type
'(paragraph table-row verse-block
))
4864 (let ((cbeg (org-element-property :contents-begin element
))
4865 (cend (org-element-property :contents-end element
)))
4866 ;; CBEG is nil for table rules.
4867 (if (and cbeg cend
(>= origin cbeg
) (< origin cend
))
4868 (narrow-to-region cbeg cend
)
4869 (throw 'objects-forbidden element
))))
4870 ;; At a parsed keyword, objects are located within value.
4872 (if (not (member (org-element-property :key element
)
4873 org-element-document-properties
))
4874 (throw 'objects-forbidden element
)
4876 (search-forward ":")
4877 (if (and (>= origin
(point)) (< origin
(line-end-position)))
4878 (narrow-to-region (point) (line-end-position))
4879 (throw 'objects-forbidden element
))))
4880 (t (throw 'objects-forbidden element
)))
4881 (goto-char (point-min))
4882 (let ((restriction (org-element-restriction type
))
4884 (candidates 'initial
))
4886 (while (setq candidates
4887 (org-element--get-next-object-candidates
4888 restriction candidates
))
4889 (let ((closest-cand (rassq (apply 'min
(mapcar 'cdr candidates
))
4891 ;; If ORIGIN is before next object in element, there's
4892 ;; no point in looking further.
4893 (if (> (cdr closest-cand
) origin
) (throw 'exit parent
)
4895 (progn (goto-char (cdr closest-cand
))
4896 (funcall (intern (format "org-element-%s-parser"
4897 (car closest-cand
))))))
4898 (cbeg (org-element-property :contents-begin object
))
4899 (cend (org-element-property :contents-end object
))
4900 (obj-end (org-element-property :end object
)))
4902 ;; ORIGIN is after OBJECT, so skip it.
4903 ((<= obj-end origin
) (goto-char obj-end
))
4904 ;; ORIGIN is within a non-recursive object or at
4905 ;; an object boundaries: Return that object.
4906 ((or (not cbeg
) (< origin cbeg
) (>= origin cend
))
4908 (org-element-put-property object
:parent parent
)))
4909 ;; Otherwise, move within current object and
4910 ;; restrict search to the end of its contents.
4912 (narrow-to-region (point) cend
)
4913 (org-element-put-property object
:parent parent
)
4915 restriction
(org-element-restriction object
)
4916 candidates
'initial
)))))))
4919 (defun org-element-nested-p (elem-A elem-B
)
4920 "Non-nil when elements ELEM-A and ELEM-B are nested."
4921 (let ((beg-A (org-element-property :begin elem-A
))
4922 (beg-B (org-element-property :begin elem-B
))
4923 (end-A (org-element-property :end elem-A
))
4924 (end-B (org-element-property :end elem-B
)))
4925 (or (and (>= beg-A beg-B
) (<= end-A end-B
))
4926 (and (>= beg-B beg-A
) (<= end-B end-A
)))))
4928 (defun org-element-swap-A-B (elem-A elem-B
)
4929 "Swap elements ELEM-A and ELEM-B.
4930 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4932 (goto-char (org-element-property :begin elem-A
))
4933 ;; There are two special cases when an element doesn't start at bol:
4934 ;; the first paragraph in an item or in a footnote definition.
4935 (let ((specialp (not (bolp))))
4936 ;; Only a paragraph without any affiliated keyword can be moved at
4937 ;; ELEM-A position in such a situation. Note that the case of
4938 ;; a footnote definition is impossible: it cannot contain two
4939 ;; paragraphs in a row because it cannot contain a blank line.
4941 (or (not (eq (org-element-type elem-B
) 'paragraph
))
4942 (/= (org-element-property :begin elem-B
)
4943 (org-element-property :contents-begin elem-B
))))
4944 (error "Cannot swap elements"))
4945 ;; In a special situation, ELEM-A will have no indentation. We'll
4946 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4947 (let* ((ind-B (when specialp
4948 (goto-char (org-element-property :begin elem-B
))
4949 (org-get-indentation)))
4950 (beg-A (org-element-property :begin elem-A
))
4951 (end-A (save-excursion
4952 (goto-char (org-element-property :end elem-A
))
4953 (skip-chars-backward " \r\t\n")
4955 (beg-B (org-element-property :begin elem-B
))
4956 (end-B (save-excursion
4957 (goto-char (org-element-property :end elem-B
))
4958 (skip-chars-backward " \r\t\n")
4960 ;; Store overlays responsible for visibility status. We
4961 ;; also need to store their boundaries as they will be
4962 ;; removed from buffer.
4965 (mapcar (lambda (ov) (list ov
(overlay-start ov
) (overlay-end ov
)))
4966 (overlays-in beg-A end-A
))
4967 (mapcar (lambda (ov) (list ov
(overlay-start ov
) (overlay-end ov
)))
4968 (overlays-in beg-B end-B
))))
4970 (body-A (buffer-substring beg-A end-A
))
4971 (body-B (delete-and-extract-region beg-B end-B
)))
4974 (setq body-B
(replace-regexp-in-string "\\`[ \t]*" "" body-B
))
4975 (org-indent-to-column ind-B
))
4977 ;; Restore ex ELEM-A overlays.
4978 (let ((offset (- beg-B beg-A
)))
4981 (car ov
) (+ (nth 1 ov
) offset
) (+ (nth 2 ov
) offset
)))
4984 (delete-region beg-A end-A
)
4986 ;; Restore ex ELEM-B overlays.
4989 (car ov
) (- (nth 1 ov
) offset
) (- (nth 2 ov
) offset
)))
4991 (goto-char (org-element-property :end elem-B
)))))
4993 (provide 'org-element
)
4996 ;; generated-autoload-file: "org-loaddefs.el"
4999 ;;; org-element.el ends here