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
688 (skip-chars-forward " \r\t\n" ending
)
689 (cond ((= (point) ending
) nil
)
690 ((= (line-beginning-position) begin
) (point))
691 (t (line-beginning-position)))))
692 (contents-end (and contents-begin ending
))
693 (end (progn (goto-char ending
)
694 (skip-chars-forward " \r\t\n" limit
)
695 (skip-chars-backward " \t")
696 (if (bolp) (point) (line-end-position)))))
697 (list 'footnote-definition
702 :contents-begin contents-begin
703 :contents-end contents-end
704 :post-blank
(count-lines ending end
)
705 :post-affiliated post-affiliated
)
706 (cdr affiliated
))))))
708 (defun org-element-footnote-definition-interpreter (footnote-definition contents
)
709 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
710 CONTENTS is the contents of the footnote-definition."
711 (concat (format "[%s]" (org-element-property :label footnote-definition
))
718 (defun org-element-headline-parser (limit &optional raw-secondary-p
)
721 Return a list whose CAR is `headline' and CDR is a plist
722 containing `:raw-value', `:title', `:alt-title', `:begin',
723 `:end', `:pre-blank', `:hiddenp', `:contents-begin' and
724 `:contents-end', `:level', `:priority', `:tags',
725 `:todo-keyword',`:todo-type', `:scheduled', `:deadline',
726 `:closed', `:quotedp', `:archivedp', `:commentedp' and
727 `:footnote-section-p' keywords.
729 The plist also contains any property set in the property drawer,
730 with its name in upper cases and colons added at the
731 beginning (i.e. `:CUSTOM_ID').
733 When RAW-SECONDARY-P is non-nil, headline's title will not be
734 parsed as a secondary string, but as a plain string instead.
736 Assume point is at beginning of the headline."
738 (let* ((components (org-heading-components))
739 (level (nth 1 components
))
740 (todo (nth 2 components
))
742 (and todo
(if (member todo org-done-keywords
) 'done
'todo
)))
743 (tags (let ((raw-tags (nth 5 components
)))
744 (and raw-tags
(org-split-string raw-tags
":"))))
745 (raw-value (or (nth 4 components
) ""))
747 (let ((case-fold-search nil
))
748 (string-match (format "^%s\\( \\|$\\)" org-quote-string
)
751 (let ((case-fold-search nil
))
752 (string-match (format "^%s\\( \\|$\\)" org-comment-string
)
754 (archivedp (member org-archive-tag tags
))
755 (footnote-section-p (and org-footnote-section
756 (string= org-footnote-section raw-value
)))
757 ;; Upcase property names. It avoids confusion between
758 ;; properties obtained through property drawer and default
759 ;; properties from the parser (e.g. `:end' and :END:)
766 (intern (concat ":" (upcase (car p
))))
768 (org-entry-properties nil
'standard
))
771 ;; Read time properties on the line below the headline.
773 (when (progn (forward-line)
774 (looking-at org-planning-or-clock-line-re
))
775 (let ((end (line-end-position)) plist
)
776 (while (re-search-forward
777 org-keyword-time-not-clock-regexp end t
)
778 (goto-char (match-end 1))
779 (skip-chars-forward " \t")
780 (let ((keyword (match-string 1))
781 (time (org-element-timestamp-parser)))
782 (cond ((equal keyword org-scheduled-string
)
783 (setq plist
(plist-put plist
:scheduled time
)))
784 ((equal keyword org-deadline-string
)
785 (setq plist
(plist-put plist
:deadline time
)))
786 (t (setq plist
(plist-put plist
:closed time
))))))
789 (end (save-excursion (goto-char (org-end-of-subtree t t
))))
790 (pos-after-head (progn (forward-line) (point)))
791 (contents-begin (save-excursion
792 (skip-chars-forward " \r\t\n" end
)
793 (and (/= (point) end
) (line-beginning-position))))
794 (hidden (org-invisible-p2))
795 (contents-end (and contents-begin
796 (progn (goto-char end
)
797 (skip-chars-backward " \r\t\n")
800 ;; Clean RAW-VALUE from any quote or comment string.
801 (when (or quotedp commentedp
)
802 (let ((case-fold-search nil
))
804 (replace-regexp-in-string
806 (regexp-opt (list org-quote-string org-comment-string
))
810 ;; Clean TAGS from archive tag, if any.
811 (when archivedp
(setq tags
(delete org-archive-tag tags
)))
815 (list :raw-value raw-value
819 (if (not contents-begin
) 0
820 (count-lines pos-after-head contents-begin
))
822 :contents-begin contents-begin
823 :contents-end contents-end
825 :priority
(nth 3 components
)
829 :post-blank
(count-lines
830 (if (not contents-end
) pos-after-head
831 (goto-char contents-end
)
835 :footnote-section-p footnote-section-p
837 :commentedp commentedp
841 (let ((alt-title (org-element-property :ALT_TITLE headline
)))
843 (org-element-put-property
845 (if raw-secondary-p alt-title
846 (org-element-parse-secondary-string
847 alt-title
(org-element-restriction 'headline
) headline
)))))
848 (org-element-put-property
850 (if raw-secondary-p raw-value
851 (org-element-parse-secondary-string
852 raw-value
(org-element-restriction 'headline
) headline
)))))))
854 (defun org-element-headline-interpreter (headline contents
)
855 "Interpret HEADLINE element as Org syntax.
856 CONTENTS is the contents of the element."
857 (let* ((level (org-element-property :level headline
))
858 (todo (org-element-property :todo-keyword headline
))
859 (priority (org-element-property :priority headline
))
860 (title (org-element-interpret-data
861 (org-element-property :title headline
)))
862 (tags (let ((tag-list (if (org-element-property :archivedp headline
)
863 (cons org-archive-tag
864 (org-element-property :tags headline
))
865 (org-element-property :tags headline
))))
867 (format ":%s:" (mapconcat 'identity tag-list
":")))))
868 (commentedp (org-element-property :commentedp headline
))
869 (quotedp (org-element-property :quotedp headline
))
870 (pre-blank (or (org-element-property :pre-blank headline
) 0))
871 (heading (concat (make-string level ?
*)
872 (and todo
(concat " " todo
))
873 (and quotedp
(concat " " org-quote-string
))
874 (and commentedp
(concat " " org-comment-string
))
876 (format " [#%s]" (char-to-string priority
)))
877 (cond ((and org-footnote-section
878 (org-element-property
879 :footnote-section-p headline
))
880 (concat " " org-footnote-section
))
881 (title (concat " " title
))))))
886 ((zerop org-tags-column
) (format " %s" tags
))
887 ((< org-tags-column
0)
890 (max (- (+ org-tags-column
(length heading
) (length tags
))) 1)
895 (make-string (max (- org-tags-column
(length heading
)) 1) ?
)
897 (make-string (1+ pre-blank
) 10)
903 (defun org-element-inlinetask-parser (limit &optional raw-secondary-p
)
904 "Parse an inline task.
906 Return a list whose CAR is `inlinetask' and CDR is a plist
907 containing `:title', `:begin', `:end', `:hiddenp',
908 `:contents-begin' and `:contents-end', `:level', `:priority',
909 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
910 `:scheduled', `:deadline', `:closed' and `:post-blank' keywords.
912 The plist also contains any property set in the property drawer,
913 with its name in upper cases and colons added at the
914 beginning (i.e. `:CUSTOM_ID').
916 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
917 title will not be parsed as a secondary string, but as a plain
920 Assume point is at beginning of the inline task."
922 (let* ((begin (point))
923 (components (org-heading-components))
924 (todo (nth 2 components
))
926 (if (member todo org-done-keywords
) 'done
'todo
)))
927 (tags (let ((raw-tags (nth 5 components
)))
928 (and raw-tags
(org-split-string raw-tags
":"))))
929 (raw-value (or (nth 4 components
) ""))
930 ;; Upcase property names. It avoids confusion between
931 ;; properties obtained through property drawer and default
932 ;; properties from the parser (e.g. `:end' and :END:)
939 (intern (concat ":" (upcase (car p
))))
941 (org-entry-properties nil
'standard
))
944 ;; Read time properties on the line below the inlinetask
947 (when (progn (forward-line)
948 (looking-at org-planning-or-clock-line-re
))
949 (let ((end (line-end-position)) plist
)
950 (while (re-search-forward
951 org-keyword-time-not-clock-regexp end t
)
952 (goto-char (match-end 1))
953 (skip-chars-forward " \t")
954 (let ((keyword (match-string 1))
955 (time (org-element-timestamp-parser)))
956 (cond ((equal keyword org-scheduled-string
)
957 (setq plist
(plist-put plist
:scheduled time
)))
958 ((equal keyword org-deadline-string
)
959 (setq plist
(plist-put plist
:deadline time
)))
960 (t (setq plist
(plist-put plist
:closed time
))))))
962 (task-end (save-excursion
964 (and (re-search-forward "^\\*+ END" limit t
)
965 (match-beginning 0))))
966 (contents-begin (progn (forward-line)
967 (and task-end
(< (point) task-end
) (point))))
968 (hidden (and contents-begin
(org-invisible-p2)))
969 (contents-end (and contents-begin task-end
))
970 (before-blank (if (not task-end
) (point)
974 (end (progn (skip-chars-forward " \r\t\n" limit
)
975 (skip-chars-backward " \t")
976 (if (bolp) (point) (line-end-position))))
980 (list :raw-value raw-value
984 :contents-begin contents-begin
985 :contents-end contents-end
986 :level
(nth 1 components
)
987 :priority
(nth 3 components
)
991 :post-blank
(count-lines before-blank end
))
994 (org-element-put-property
996 (if raw-secondary-p raw-value
997 (org-element-parse-secondary-string
999 (org-element-restriction 'inlinetask
)
1002 (defun org-element-inlinetask-interpreter (inlinetask contents
)
1003 "Interpret INLINETASK element as Org syntax.
1004 CONTENTS is the contents of inlinetask."
1005 (let* ((level (org-element-property :level inlinetask
))
1006 (todo (org-element-property :todo-keyword inlinetask
))
1007 (priority (org-element-property :priority inlinetask
))
1008 (title (org-element-interpret-data
1009 (org-element-property :title inlinetask
)))
1010 (tags (let ((tag-list (org-element-property :tags inlinetask
)))
1012 (format ":%s:" (mapconcat 'identity tag-list
":")))))
1013 (task (concat (make-string level ?
*)
1014 (and todo
(concat " " todo
))
1016 (format " [#%s]" (char-to-string priority
)))
1017 (and title
(concat " " title
)))))
1022 ((zerop org-tags-column
) (format " %s" tags
))
1023 ((< org-tags-column
0)
1026 (max (- (+ org-tags-column
(length task
) (length tags
))) 1)
1031 (make-string (max (- org-tags-column
(length task
)) 1) ?
)
1033 ;; Prefer degenerate inlinetasks when there are no
1038 (make-string level ?
*) " END")))))
1043 (defun org-element-item-parser (limit struct
&optional raw-secondary-p
)
1046 STRUCT is the structure of the plain list.
1048 Return a list whose CAR is `item' and CDR is a plist containing
1049 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1050 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
1051 `:post-blank' keywords.
1053 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1054 any, will not be parsed as a secondary string, but as a plain
1057 Assume point is at the beginning of the item."
1060 (looking-at org-list-full-item-re
)
1061 (let* ((begin (point))
1062 (bullet (org-match-string-no-properties 1))
1063 (checkbox (let ((box (org-match-string-no-properties 3)))
1064 (cond ((equal "[ ]" box
) 'off
)
1065 ((equal "[X]" box
) 'on
)
1066 ((equal "[-]" box
) 'trans
))))
1067 (counter (let ((c (org-match-string-no-properties 2)))
1071 ((string-match "[A-Za-z]" c
)
1072 (- (string-to-char (upcase (match-string 0 c
)))
1074 ((string-match "[0-9]+" c
)
1075 (string-to-number (match-string 0 c
)))))))
1076 (end (save-excursion (goto-char (org-list-get-item-end begin struct
))
1077 (unless (bolp) (forward-line))
1081 ;; Ignore tags in un-ordered lists: they are just
1082 ;; a part of item's body.
1083 (if (and (match-beginning 4)
1084 (save-match-data (string-match "[.)]" bullet
)))
1087 (skip-chars-forward " \r\t\n" limit
)
1088 ;; If first line isn't empty, contents really start
1089 ;; at the text after item's meta-data.
1090 (if (= (point-at-bol) begin
) (point) (point-at-bol))))
1091 (hidden (progn (forward-line)
1092 (and (not (= (point) end
)) (org-invisible-p2))))
1093 (contents-end (progn (goto-char end
)
1094 (skip-chars-backward " \r\t\n")
1099 (list :bullet bullet
1102 ;; CONTENTS-BEGIN and CONTENTS-END may be
1103 ;; mixed up in the case of an empty item
1104 ;; separated from the next by a blank line.
1105 ;; Thus ensure the former is always the
1107 :contents-begin
(min contents-begin contents-end
)
1108 :contents-end
(max contents-begin contents-end
)
1113 :post-blank
(count-lines contents-end end
)))))
1114 (org-element-put-property
1116 (let ((raw-tag (org-list-get-tag begin struct
)))
1118 (if raw-secondary-p raw-tag
1119 (org-element-parse-secondary-string
1120 raw-tag
(org-element-restriction 'item
) item
))))))))
1122 (defun org-element-item-interpreter (item contents
)
1123 "Interpret ITEM element as Org syntax.
1124 CONTENTS is the contents of the element."
1125 (let* ((bullet (let ((bullet (org-element-property :bullet item
)))
1126 (org-list-bullet-string
1127 (cond ((not (string-match "[0-9a-zA-Z]" bullet
)) "- ")
1128 ((eq org-plain-list-ordered-item-terminator ?\
)) "1)")
1130 (checkbox (org-element-property :checkbox item
))
1131 (counter (org-element-property :counter item
))
1132 (tag (let ((tag (org-element-property :tag item
)))
1133 (and tag
(org-element-interpret-data tag
))))
1134 ;; Compute indentation.
1135 (ind (make-string (length bullet
) 32))
1136 (item-starts-with-par-p
1137 (eq (org-element-type (car (org-element-contents item
)))
1142 (and counter
(format "[@%d] " counter
))
1147 (and tag
(format "%s :: " tag
))
1149 (let ((contents (replace-regexp-in-string
1150 "\\(^\\)[ \t]*\\S-" ind contents nil nil
1)))
1151 (if item-starts-with-par-p
(org-trim contents
)
1152 (concat "\n" contents
)))))))
1157 (defun org-element--list-struct (limit)
1158 ;; Return structure of list at point. Internal function. See
1159 ;; `org-list-struct' for details.
1160 (let ((case-fold-search t
)
1162 (item-re (org-item-re))
1163 (drawers-re (concat ":\\("
1164 (mapconcat 'regexp-quote org-drawers
"\\|")
1166 (inlinetask-re (and (featurep 'org-inlinetask
) "^\\*+ "))
1172 ;; At limit: end all items.
1175 (let ((end (progn (skip-chars-backward " \r\t\n")
1178 (dolist (item items
(sort (nconc items struct
)
1179 'car-less-than-car
))
1180 (setcar (nthcdr 6 item
) end
)))))
1181 ;; At list end: end all items.
1182 ((looking-at org-list-end-re
)
1183 (throw 'exit
(dolist (item items
(sort (nconc items struct
)
1184 'car-less-than-car
))
1185 (setcar (nthcdr 6 item
) (point)))))
1186 ;; At a new item: end previous sibling.
1187 ((looking-at item-re
)
1188 (let ((ind (save-excursion (skip-chars-forward " \t")
1190 (setq top-ind
(min top-ind ind
))
1191 (while (and items
(<= ind
(nth 1 (car items
))))
1192 (let ((item (pop items
)))
1193 (setcar (nthcdr 6 item
) (point))
1194 (push item struct
)))
1195 (push (progn (looking-at org-list-full-item-re
)
1196 (let ((bullet (match-string-no-properties 1)))
1200 (match-string-no-properties 2) ; counter
1201 (match-string-no-properties 3) ; checkbox
1203 (and (save-match-data
1204 (string-match "[-+*]" bullet
))
1205 (match-string-no-properties 4))
1206 ;; Ending position, unknown so far.
1210 ;; Skip empty lines.
1211 ((looking-at "^[ \t]*$") (forward-line))
1212 ;; Skip inline tasks and blank lines along the way.
1213 ((and inlinetask-re
(looking-at inlinetask-re
))
1215 (let ((origin (point)))
1216 (when (re-search-forward inlinetask-re limit t
)
1217 (if (looking-at "^\\*+ END[ \t]*$") (forward-line)
1218 (goto-char origin
)))))
1219 ;; At some text line. Check if it ends any previous item.
1221 (let ((ind (progn (skip-chars-forward " \t") (current-column))))
1222 (when (<= ind top-ind
)
1223 (skip-chars-backward " \r\t\n")
1225 (while (<= ind
(nth 1 (car items
)))
1226 (let ((item (pop items
)))
1227 (setcar (nthcdr 6 item
) (line-beginning-position))
1230 (throw 'exit
(sort struct
'car-less-than-car
))))))
1231 ;; Skip blocks (any type) and drawers contents.
1233 ((and (looking-at "#\\+BEGIN\\(:\\|_\\S-+\\)")
1235 (format "^[ \t]*#\\+END%s[ \t]*$"
1236 (match-string-no-properties 1))
1238 ((and (looking-at drawers-re
)
1239 (re-search-forward "^[ \t]*:END:[ \t]*$" limit t
))))
1240 (forward-line))))))))
1242 (defun org-element-plain-list-parser (limit affiliated structure
)
1243 "Parse a plain list.
1245 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1246 the buffer position at the beginning of the first affiliated
1247 keyword and CDR is a plist of affiliated keywords along with
1248 their value. STRUCTURE is the structure of the plain list being
1251 Return a list whose CAR is `plain-list' and CDR is a plist
1252 containing `:type', `:begin', `:end', `:contents-begin' and
1253 `:contents-end', `:structure', `:post-blank' and
1254 `:post-affiliated' keywords.
1256 Assume point is at the beginning of the list."
1258 (let* ((struct (or structure
(org-element--list-struct limit
)))
1259 (prevs (org-list-prevs-alist struct
))
1260 (type (org-list-get-list-type (point) struct prevs
))
1261 (contents-begin (point))
1262 (begin (car affiliated
))
1264 (progn (goto-char (org-list-get-list-end (point) struct prevs
))
1265 (unless (bolp) (forward-line))
1267 (end (progn (skip-chars-forward " \r\t\n" limit
)
1268 (if (= (point) limit
) limit
(line-beginning-position)))))
1275 :contents-begin contents-begin
1276 :contents-end contents-end
1278 :post-blank
(count-lines contents-end end
)
1279 :post-affiliated contents-begin
)
1280 (cdr affiliated
))))))
1282 (defun org-element-plain-list-interpreter (plain-list contents
)
1283 "Interpret PLAIN-LIST element as Org syntax.
1284 CONTENTS is the contents of the element."
1287 (goto-char (point-min))
1292 ;;;; Property Drawer
1294 (defun org-element-property-drawer-parser (limit affiliated
)
1295 "Parse a property drawer.
1297 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1298 the buffer position at the beginning of the first affiliated
1299 keyword and CDR is a plist of affiliated keywords along with
1302 Return a list whose CAR is `property-drawer' and CDR is a plist
1303 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1304 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1306 Assume point is at the beginning of the property drawer."
1308 (let ((case-fold-search t
))
1309 (if (not (save-excursion
1310 (re-search-forward "^[ \t]*:END:[ \t]*$" limit t
)))
1311 ;; Incomplete drawer: parse it as a paragraph.
1312 (org-element-paragraph-parser limit affiliated
)
1314 (let* ((drawer-end-line (match-beginning 0))
1315 (begin (car affiliated
))
1316 (post-affiliated (point))
1317 (contents-begin (progn (forward-line)
1318 (and (< (point) drawer-end-line
)
1320 (contents-end (and contents-begin drawer-end-line
))
1321 (hidden (org-invisible-p2))
1322 (pos-before-blank (progn (goto-char drawer-end-line
)
1325 (end (progn (skip-chars-forward " \r\t\n" limit
)
1326 (skip-chars-backward " \t")
1327 (if (bolp) (point) (line-end-position)))))
1328 (list 'property-drawer
1333 :contents-begin contents-begin
1334 :contents-end contents-end
1335 :post-blank
(count-lines pos-before-blank end
)
1336 :post-affiliated post-affiliated
)
1337 (cdr affiliated
)))))))))
1339 (defun org-element-property-drawer-interpreter (property-drawer contents
)
1340 "Interpret PROPERTY-DRAWER element as Org syntax.
1341 CONTENTS is the properties within the drawer."
1342 (format ":PROPERTIES:\n%s:END:" contents
))
1347 (defun org-element-quote-block-parser (limit affiliated
)
1348 "Parse a quote block.
1350 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1351 the buffer position at the beginning of the first affiliated
1352 keyword and CDR is a plist of affiliated keywords along with
1355 Return a list whose CAR is `quote-block' and CDR is a plist
1356 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1357 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1359 Assume point is at the beginning of the block."
1360 (let ((case-fold-search t
))
1361 (if (not (save-excursion
1362 (re-search-forward "^[ \t]*#\\+END_QUOTE[ \t]*$" limit t
)))
1363 ;; Incomplete block: parse it as a paragraph.
1364 (org-element-paragraph-parser limit affiliated
)
1365 (let ((block-end-line (match-beginning 0)))
1367 (let* ((begin (car affiliated
))
1368 (post-affiliated (point))
1369 ;; Empty blocks have no contents.
1370 (contents-begin (progn (forward-line)
1371 (and (< (point) block-end-line
)
1373 (contents-end (and contents-begin block-end-line
))
1374 (hidden (org-invisible-p2))
1375 (pos-before-blank (progn (goto-char block-end-line
)
1378 (end (progn (skip-chars-forward " \r\t\n" limit
)
1379 (skip-chars-backward " \t")
1380 (if (bolp) (point) (line-end-position)))))
1386 :contents-begin contents-begin
1387 :contents-end contents-end
1388 :post-blank
(count-lines pos-before-blank end
)
1389 :post-affiliated post-affiliated
)
1390 (cdr affiliated
)))))))))
1392 (defun org-element-quote-block-interpreter (quote-block contents
)
1393 "Interpret QUOTE-BLOCK element as Org syntax.
1394 CONTENTS is the contents of the element."
1395 (format "#+BEGIN_QUOTE\n%s#+END_QUOTE" contents
))
1400 (defun org-element-section-parser (limit)
1403 LIMIT bounds the search.
1405 Return a list whose CAR is `section' and CDR is a plist
1406 containing `:begin', `:end', `:contents-begin', `contents-end'
1407 and `:post-blank' keywords."
1409 ;; Beginning of section is the beginning of the first non-blank
1410 ;; line after previous headline.
1411 (let ((begin (point))
1412 (end (progn (org-with-limited-levels (outline-next-heading))
1414 (pos-before-blank (progn (skip-chars-backward " \r\t\n")
1420 :contents-begin begin
1421 :contents-end pos-before-blank
1422 :post-blank
(count-lines pos-before-blank end
))))))
1424 (defun org-element-section-interpreter (section contents
)
1425 "Interpret SECTION element as Org syntax.
1426 CONTENTS is the contents of the element."
1432 (defun org-element-special-block-parser (limit affiliated
)
1433 "Parse a special block.
1435 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1436 the buffer position at the beginning of the first affiliated
1437 keyword and CDR is a plist of affiliated keywords along with
1440 Return a list whose CAR is `special-block' and CDR is a plist
1441 containing `:type', `:begin', `:end', `:hiddenp',
1442 `:contents-begin', `:contents-end', `:post-blank' and
1443 `:post-affiliated' keywords.
1445 Assume point is at the beginning of the block."
1446 (let* ((case-fold-search t
)
1447 (type (progn (looking-at "[ \t]*#\\+BEGIN_\\(\\S-+\\)")
1448 (upcase (match-string-no-properties 1)))))
1449 (if (not (save-excursion
1451 (format "^[ \t]*#\\+END_%s[ \t]*$" (regexp-quote type
))
1453 ;; Incomplete block: parse it as a paragraph.
1454 (org-element-paragraph-parser limit affiliated
)
1455 (let ((block-end-line (match-beginning 0)))
1457 (let* ((begin (car affiliated
))
1458 (post-affiliated (point))
1459 ;; Empty blocks have no contents.
1460 (contents-begin (progn (forward-line)
1461 (and (< (point) block-end-line
)
1463 (contents-end (and contents-begin block-end-line
))
1464 (hidden (org-invisible-p2))
1465 (pos-before-blank (progn (goto-char block-end-line
)
1468 (end (progn (skip-chars-forward " \r\t\n" limit
)
1469 (skip-chars-backward " \t")
1470 (if (bolp) (point) (line-end-position)))))
1471 (list 'special-block
1477 :contents-begin contents-begin
1478 :contents-end contents-end
1479 :post-blank
(count-lines pos-before-blank end
)
1480 :post-affiliated post-affiliated
)
1481 (cdr affiliated
)))))))))
1483 (defun org-element-special-block-interpreter (special-block contents
)
1484 "Interpret SPECIAL-BLOCK element as Org syntax.
1485 CONTENTS is the contents of the element."
1486 (let ((block-type (org-element-property :type special-block
)))
1487 (format "#+BEGIN_%s\n%s#+END_%s" block-type contents block-type
)))
1493 ;; For each element, a parser and an interpreter are also defined.
1494 ;; Both follow the same naming convention used for greater elements.
1496 ;; Also, as for greater elements, adding a new element type is done
1497 ;; through the following steps: implement a parser and an interpreter,
1498 ;; tweak `org-element--current-element' so that it recognizes the new
1499 ;; type and add that new type to `org-element-all-elements'.
1501 ;; As a special case, when the newly defined type is a block type,
1502 ;; `org-element-block-name-alist' has to be modified accordingly.
1507 (defun org-element-babel-call-parser (limit affiliated
)
1508 "Parse a babel call.
1510 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1511 the buffer position at the beginning of the first affiliated
1512 keyword and CDR is a plist of affiliated keywords along with
1515 Return a list whose CAR is `babel-call' and CDR is a plist
1516 containing `:begin', `:end', `:info', `:post-blank' and
1517 `:post-affiliated' as keywords."
1519 (let ((case-fold-search t
)
1520 (info (progn (looking-at org-babel-block-lob-one-liner-regexp
)
1521 (org-babel-lob-get-info)))
1522 (begin (car affiliated
))
1523 (post-affiliated (point))
1524 (pos-before-blank (progn (forward-line) (point)))
1525 (end (progn (skip-chars-forward " \r\t\n" limit
)
1526 (skip-chars-backward " \t")
1527 (if (bolp) (point) (line-end-position)))))
1533 :post-blank
(count-lines pos-before-blank end
)
1534 :post-affiliated post-affiliated
)
1535 (cdr affiliated
))))))
1537 (defun org-element-babel-call-interpreter (babel-call contents
)
1538 "Interpret BABEL-CALL element as Org syntax.
1540 (let* ((babel-info (org-element-property :info babel-call
))
1541 (main (car babel-info
))
1542 (post-options (nth 1 babel-info
)))
1544 (if (not (string-match "\\[\\(\\[.*?\\]\\)\\]" main
)) main
1545 ;; Remove redundant square brackets.
1546 (replace-match (match-string 1 main
) nil nil main
))
1547 (and post-options
(format "[%s]" post-options
)))))
1552 (defun org-element-clock-parser (limit)
1555 LIMIT bounds the search.
1557 Return a list whose CAR is `clock' and CDR is a plist containing
1558 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1561 (let* ((case-fold-search nil
)
1563 (value (progn (search-forward org-clock-string
(line-end-position) t
)
1564 (skip-chars-forward " \t")
1565 (org-element-timestamp-parser)))
1566 (duration (and (search-forward " => " (line-end-position) t
)
1567 (progn (skip-chars-forward " \t")
1568 (looking-at "\\(\\S-+\\)[ \t]*$"))
1569 (org-match-string-no-properties 1)))
1570 (status (if duration
'closed
'running
))
1571 (post-blank (let ((before-blank (progn (forward-line) (point))))
1572 (skip-chars-forward " \r\t\n" limit
)
1573 (skip-chars-backward " \t")
1574 (unless (bolp) (end-of-line))
1575 (count-lines before-blank
(point))))
1578 (list :status status
1583 :post-blank post-blank
)))))
1585 (defun org-element-clock-interpreter (clock contents
)
1586 "Interpret CLOCK element as Org syntax.
1588 (concat org-clock-string
" "
1589 (org-element-timestamp-interpreter
1590 (org-element-property :value clock
) nil
)
1591 (let ((duration (org-element-property :duration clock
)))
1596 (org-split-string duration
":")))))))
1601 (defun org-element-comment-parser (limit affiliated
)
1604 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1605 the buffer position at the beginning of the first affiliated
1606 keyword and CDR is a plist of affiliated keywords along with
1609 Return a list whose CAR is `comment' and CDR is a plist
1610 containing `:begin', `:end', `:value', `:post-blank',
1611 `:post-affiliated' keywords.
1613 Assume point is at comment beginning."
1615 (let* ((begin (car affiliated
))
1616 (post-affiliated (point))
1617 (value (prog2 (looking-at "[ \t]*# ?")
1618 (buffer-substring-no-properties
1619 (match-end 0) (line-end-position))
1622 ;; Get comments ending.
1624 (while (and (< (point) limit
) (looking-at "[ \t]*#\\( \\|$\\)"))
1625 ;; Accumulate lines without leading hash and first
1630 (buffer-substring-no-properties
1631 (match-end 0) (line-end-position))))
1634 (end (progn (goto-char com-end
)
1635 (skip-chars-forward " \r\t\n" limit
)
1636 (skip-chars-backward " \t")
1637 (if (bolp) (point) (line-end-position)))))
1643 :post-blank
(count-lines com-end end
)
1644 :post-affiliated post-affiliated
)
1645 (cdr affiliated
))))))
1647 (defun org-element-comment-interpreter (comment contents
)
1648 "Interpret COMMENT element as Org syntax.
1650 (replace-regexp-in-string "^" "# " (org-element-property :value comment
)))
1655 (defun org-element-comment-block-parser (limit affiliated
)
1656 "Parse an export block.
1658 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1659 the buffer position at the beginning of the first affiliated
1660 keyword and CDR is a plist of affiliated keywords along with
1663 Return a list whose CAR is `comment-block' and CDR is a plist
1664 containing `:begin', `:end', `:hiddenp', `:value', `:post-blank'
1665 and `:post-affiliated' keywords.
1667 Assume point is at comment block beginning."
1668 (let ((case-fold-search t
))
1669 (if (not (save-excursion
1670 (re-search-forward "^[ \t]*#\\+END_COMMENT[ \t]*$" limit t
)))
1671 ;; Incomplete block: parse it as a paragraph.
1672 (org-element-paragraph-parser limit affiliated
)
1673 (let ((contents-end (match-beginning 0)))
1675 (let* ((begin (car affiliated
))
1676 (post-affiliated (point))
1677 (contents-begin (progn (forward-line) (point)))
1678 (hidden (org-invisible-p2))
1679 (pos-before-blank (progn (goto-char contents-end
)
1682 (end (progn (skip-chars-forward " \r\t\n" limit
)
1683 (skip-chars-backward " \t")
1684 (if (bolp) (point) (line-end-position))))
1685 (value (buffer-substring-no-properties
1686 contents-begin contents-end
)))
1687 (list 'comment-block
1693 :post-blank
(count-lines pos-before-blank end
)
1694 :post-affiliated post-affiliated
)
1695 (cdr affiliated
)))))))))
1697 (defun org-element-comment-block-interpreter (comment-block contents
)
1698 "Interpret COMMENT-BLOCK element as Org syntax.
1700 (format "#+BEGIN_COMMENT\n%s#+END_COMMENT"
1701 (org-remove-indentation (org-element-property :value comment-block
))))
1706 (defun org-element-diary-sexp-parser (limit affiliated
)
1707 "Parse a diary sexp.
1709 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1710 the buffer position at the beginning of the first affiliated
1711 keyword and CDR is a plist of affiliated keywords along with
1714 Return a list whose CAR is `diary-sexp' and CDR is a plist
1715 containing `:begin', `:end', `:value', `:post-blank' and
1716 `:post-affiliated' keywords."
1718 (let ((begin (car affiliated
))
1719 (post-affiliated (point))
1720 (value (progn (looking-at "\\(%%(.*\\)[ \t]*$")
1721 (org-match-string-no-properties 1)))
1722 (pos-before-blank (progn (forward-line) (point)))
1723 (end (progn (skip-chars-forward " \r\t\n" limit
)
1724 (skip-chars-backward " \t")
1725 (if (bolp) (point) (line-end-position)))))
1731 :post-blank
(count-lines pos-before-blank end
)
1732 :post-affiliated post-affiliated
)
1733 (cdr affiliated
))))))
1735 (defun org-element-diary-sexp-interpreter (diary-sexp contents
)
1736 "Interpret DIARY-SEXP as Org syntax.
1738 (org-element-property :value diary-sexp
))
1743 (defun org-element--remove-indentation (s &optional n
)
1744 "Remove maximum common indentation in string S and return it.
1745 When optional argument N is a positive integer, remove exactly
1746 that much characters from indentation, if possible, or return
1747 S as-is otherwise. Unlike to `org-remove-indentation', this
1748 function doesn't call `untabify' on S."
1752 (goto-char (point-min))
1753 ;; Find maximum common indentation, if not specified.
1755 (let ((min-ind (point-max)))
1757 (while (re-search-forward "^[ \t]*\\S-" nil t
)
1758 (let ((ind (1- (current-column))))
1759 (if (zerop ind
) (throw 'exit s
)
1760 (setq min-ind
(min min-ind ind
))))))
1763 ;; Remove exactly N indentation, but give up if not possible.
1765 (let ((ind (progn (skip-chars-forward " \t") (current-column))))
1766 (cond ((eolp) (delete-region (line-beginning-position) (point)))
1767 ((< ind n
) (throw 'exit s
))
1768 (t (org-indent-line-to (- ind n
))))
1772 (defun org-element-example-block-parser (limit affiliated
)
1773 "Parse an example block.
1775 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1776 the buffer position at the beginning of the first affiliated
1777 keyword and CDR is a plist of affiliated keywords along with
1780 Return a list whose CAR is `example-block' and CDR is a plist
1781 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1782 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1783 `:switches', `:value', `:post-blank' and `:post-affiliated'
1785 (let ((case-fold-search t
))
1786 (if (not (save-excursion
1787 (re-search-forward "^[ \t]*#\\+END_EXAMPLE[ \t]*$" limit t
)))
1788 ;; Incomplete block: parse it as a paragraph.
1789 (org-element-paragraph-parser limit affiliated
)
1790 (let ((contents-end (match-beginning 0)))
1794 (looking-at "^[ \t]*#\\+BEGIN_EXAMPLE\\(?: +\\(.*\\)\\)?")
1795 (org-match-string-no-properties 1)))
1796 ;; Switches analysis
1798 (cond ((not switches
) nil
)
1799 ((string-match "-n\\>" switches
) 'new
)
1800 ((string-match "+n\\>" switches
) 'continued
)))
1802 (or org-src-preserve-indentation
1803 (and switches
(string-match "-i\\>" switches
))))
1804 ;; Should labels be retained in (or stripped from) example
1808 (not (string-match "-r\\>" switches
))
1809 (and number-lines
(string-match "-k\\>" switches
))))
1810 ;; What should code-references use - labels or
1815 (not (string-match "-k\\>" switches
)))))
1818 (string-match "-l +\"\\([^\"\n]+\\)\"" switches
)
1819 (match-string 1 switches
)))
1820 ;; Standard block parsing.
1821 (begin (car affiliated
))
1822 (post-affiliated (point))
1823 (block-ind (progn (skip-chars-forward " \t") (current-column)))
1824 (contents-begin (progn (forward-line) (point)))
1825 (hidden (org-invisible-p2))
1826 (value (org-element--remove-indentation
1827 (org-unescape-code-in-string
1828 (buffer-substring-no-properties
1829 contents-begin contents-end
))
1830 (and preserve-indent block-ind
)))
1831 (pos-before-blank (progn (goto-char contents-end
)
1834 (end (progn (skip-chars-forward " \r\t\n" limit
)
1835 (skip-chars-backward " \t")
1836 (if (bolp) (point) (line-end-position)))))
1837 (list 'example-block
1843 :number-lines number-lines
1844 :preserve-indent preserve-indent
1845 :retain-labels retain-labels
1846 :use-labels use-labels
1847 :label-fmt label-fmt
1849 :post-blank
(count-lines pos-before-blank end
)
1850 :post-affiliated post-affiliated
)
1851 (cdr affiliated
)))))))))
1853 (defun org-element-example-block-interpreter (example-block contents
)
1854 "Interpret EXAMPLE-BLOCK element as Org syntax.
1856 (let ((switches (org-element-property :switches example-block
)))
1857 (concat "#+BEGIN_EXAMPLE" (and switches
(concat " " switches
)) "\n"
1858 (org-escape-code-in-string
1859 (org-element-property :value example-block
))
1865 (defun org-element-export-block-parser (limit affiliated
)
1866 "Parse an export block.
1868 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1869 the buffer position at the beginning of the first affiliated
1870 keyword and CDR is a plist of affiliated keywords along with
1873 Return a list whose CAR is `export-block' and CDR is a plist
1874 containing `:begin', `:end', `:type', `:hiddenp', `:value',
1875 `:post-blank' and `:post-affiliated' keywords.
1877 Assume point is at export-block beginning."
1878 (let* ((case-fold-search t
)
1879 (type (progn (looking-at "[ \t]*#\\+BEGIN_\\(\\S-+\\)")
1880 (upcase (org-match-string-no-properties 1)))))
1881 (if (not (save-excursion
1883 (format "^[ \t]*#\\+END_%s[ \t]*$" type
) limit t
)))
1884 ;; Incomplete block: parse it as a paragraph.
1885 (org-element-paragraph-parser limit affiliated
)
1886 (let ((contents-end (match-beginning 0)))
1888 (let* ((begin (car affiliated
))
1889 (post-affiliated (point))
1890 (contents-begin (progn (forward-line) (point)))
1891 (hidden (org-invisible-p2))
1892 (pos-before-blank (progn (goto-char contents-end
)
1895 (end (progn (skip-chars-forward " \r\t\n" limit
)
1896 (skip-chars-backward " \t")
1897 (if (bolp) (point) (line-end-position))))
1898 (value (buffer-substring-no-properties contents-begin
1907 :post-blank
(count-lines pos-before-blank end
)
1908 :post-affiliated post-affiliated
)
1909 (cdr affiliated
)))))))))
1911 (defun org-element-export-block-interpreter (export-block contents
)
1912 "Interpret EXPORT-BLOCK element as Org syntax.
1914 (let ((type (org-element-property :type export-block
)))
1915 (concat (format "#+BEGIN_%s\n" type
)
1916 (org-element-property :value export-block
)
1917 (format "#+END_%s" type
))))
1922 (defun org-element-fixed-width-parser (limit affiliated
)
1923 "Parse a fixed-width section.
1925 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1926 the buffer position at the beginning of the first affiliated
1927 keyword and CDR is a plist of affiliated keywords along with
1930 Return a list whose CAR is `fixed-width' and CDR is a plist
1931 containing `:begin', `:end', `:value', `:post-blank' and
1932 `:post-affiliated' keywords.
1934 Assume point is at the beginning of the fixed-width area."
1936 (let* ((begin (car affiliated
))
1937 (post-affiliated (point))
1941 (while (and (< (point) limit
)
1942 (looking-at "[ \t]*:\\( \\|$\\)"))
1943 ;; Accumulate text without starting colons.
1946 (buffer-substring-no-properties
1947 (match-end 0) (point-at-eol))
1951 (end (progn (skip-chars-forward " \r\t\n" limit
)
1952 (skip-chars-backward " \t")
1953 (if (bolp) (point) (line-end-position)))))
1959 :post-blank
(count-lines end-area end
)
1960 :post-affiliated post-affiliated
)
1961 (cdr affiliated
))))))
1963 (defun org-element-fixed-width-interpreter (fixed-width contents
)
1964 "Interpret FIXED-WIDTH element as Org syntax.
1966 (let ((value (org-element-property :value fixed-width
)))
1968 (replace-regexp-in-string
1970 (if (string-match "\n\\'" value
) (substring value
0 -
1) value
)))))
1973 ;;;; Horizontal Rule
1975 (defun org-element-horizontal-rule-parser (limit affiliated
)
1976 "Parse an horizontal rule.
1978 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1979 the buffer position at the beginning of the first affiliated
1980 keyword and CDR is a plist of affiliated keywords along with
1983 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1984 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
1987 (let ((begin (car affiliated
))
1988 (post-affiliated (point))
1989 (post-hr (progn (forward-line) (point)))
1990 (end (progn (skip-chars-forward " \r\t\n" limit
)
1991 (skip-chars-backward " \t")
1992 (if (bolp) (point) (line-end-position)))))
1993 (list 'horizontal-rule
1997 :post-blank
(count-lines post-hr end
)
1998 :post-affiliated post-affiliated
)
1999 (cdr affiliated
))))))
2001 (defun org-element-horizontal-rule-interpreter (horizontal-rule contents
)
2002 "Interpret HORIZONTAL-RULE element as Org syntax.
2009 (defun org-element-keyword-parser (limit affiliated
)
2010 "Parse a keyword at point.
2012 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2013 the buffer position at the beginning of the first affiliated
2014 keyword and CDR is a plist of affiliated keywords along with
2017 Return a list whose CAR is `keyword' and CDR is a plist
2018 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2019 `:post-affiliated' keywords."
2021 (let ((begin (car affiliated
))
2022 (post-affiliated (point))
2023 (key (progn (looking-at "[ \t]*#\\+\\(\\S-+*\\):")
2024 (upcase (org-match-string-no-properties 1))))
2025 (value (org-trim (buffer-substring-no-properties
2026 (match-end 0) (point-at-eol))))
2027 (pos-before-blank (progn (forward-line) (point)))
2028 (end (progn (skip-chars-forward " \r\t\n" limit
)
2029 (skip-chars-backward " \t")
2030 (if (bolp) (point) (line-end-position)))))
2037 :post-blank
(count-lines pos-before-blank end
)
2038 :post-affiliated post-affiliated
)
2039 (cdr affiliated
))))))
2041 (defun org-element-keyword-interpreter (keyword contents
)
2042 "Interpret KEYWORD element as Org syntax.
2045 (org-element-property :key keyword
)
2046 (org-element-property :value keyword
)))
2049 ;;;; Latex Environment
2051 (defun org-element-latex-environment-parser (limit affiliated
)
2052 "Parse a LaTeX environment.
2054 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2055 the buffer position at the beginning of the first affiliated
2056 keyword and CDR is a plist of affiliated keywords along with
2059 Return a list whose CAR is `latex-environment' and CDR is a plist
2060 containing `:begin', `:end', `:value', `:post-blank' and
2061 `:post-affiliated' keywords.
2063 Assume point is at the beginning of the latex environment."
2065 (let ((case-fold-search t
)
2066 (code-begin (point)))
2067 (looking-at "[ \t]*\\\\begin{\\([A-Za-z0-9]+\\*?\\)}")
2068 (if (not (re-search-forward (format "^[ \t]*\\\\end{%s}[ \t]*$"
2069 (regexp-quote (match-string 1)))
2071 ;; Incomplete latex environment: parse it as a paragraph.
2072 (org-element-paragraph-parser limit affiliated
)
2073 (let* ((code-end (progn (forward-line) (point)))
2074 (begin (car affiliated
))
2075 (value (buffer-substring-no-properties code-begin code-end
))
2076 (end (progn (skip-chars-forward " \r\t\n" limit
)
2077 (skip-chars-backward " \t")
2078 (if (bolp) (point) (line-end-position)))))
2079 (list 'latex-environment
2084 :post-blank
(count-lines code-end end
)
2085 :post-affiliated code-begin
)
2086 (cdr affiliated
))))))))
2088 (defun org-element-latex-environment-interpreter (latex-environment contents
)
2089 "Interpret LATEX-ENVIRONMENT element as Org syntax.
2091 (org-element-property :value latex-environment
))
2096 (defun org-element-node-property-parser (limit)
2097 "Parse a node-property at point.
2099 LIMIT bounds the search.
2101 Return a list whose CAR is `node-property' and CDR is a plist
2102 containing `:key', `:value', `:begin', `:end' and `:post-blank'
2105 (looking-at org-property-re
)
2106 (let ((case-fold-search t
)
2108 (key (org-match-string-no-properties 2))
2109 (value (org-match-string-no-properties 3))
2110 (pos-before-blank (progn (forward-line) (point)))
2111 (end (progn (skip-chars-forward " \r\t\n" limit
)
2112 (if (eobp) (point) (point-at-bol)))))
2113 (list 'node-property
2118 :post-blank
(count-lines pos-before-blank end
))))))
2120 (defun org-element-node-property-interpreter (node-property contents
)
2121 "Interpret NODE-PROPERTY element as Org syntax.
2123 (format org-property-format
2124 (format ":%s:" (org-element-property :key node-property
))
2125 (org-element-property :value node-property
)))
2130 (defun org-element-paragraph-parser (limit affiliated
)
2133 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2134 the buffer position at the beginning of the first affiliated
2135 keyword and CDR is a plist of affiliated keywords along with
2138 Return a list whose CAR is `paragraph' and CDR is a plist
2139 containing `:begin', `:end', `:contents-begin' and
2140 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2142 Assume point is at the beginning of the paragraph."
2144 (let* ((begin (car affiliated
))
2145 (contents-begin (point))
2147 (let ((case-fold-search t
))
2149 (if (not (re-search-forward
2150 org-element-paragraph-separate limit
'm
))
2152 ;; A matching `org-element-paragraph-separate' is not
2153 ;; necessarily the end of the paragraph. In
2154 ;; particular, lines starting with # or : as a first
2155 ;; non-space character are ambiguous. We have check
2156 ;; if they are valid Org syntax (i.e. not an
2157 ;; incomplete keyword).
2161 ;; There's no ambiguity for other symbols or
2162 ;; empty lines: stop here.
2163 (looking-at "[ \t]*\\(?:[^:#]\\|$\\)")
2164 ;; Stop at valid fixed-width areas.
2165 (looking-at "[ \t]*:\\(?: \\|$\\)")
2167 (and (looking-at org-drawer-regexp
)
2170 "^[ \t]*:END:[ \t]*$" limit t
)))
2171 ;; Stop at valid comments.
2172 (looking-at "[ \t]*#\\(?: \\|$\\)")
2173 ;; Stop at valid dynamic blocks.
2174 (and (looking-at org-dblock-start-re
)
2177 "^[ \t]*#\\+END:?[ \t]*$" limit t
)))
2178 ;; Stop at valid blocks.
2179 (and (looking-at "[ \t]*#\\+BEGIN_\\(\\S-+\\)")
2182 (format "^[ \t]*#\\+END_%s[ \t]*$"
2184 (org-match-string-no-properties 1)))
2186 ;; Stop at valid latex environments.
2188 "[ \t]*\\\\begin{\\([A-Za-z0-9]+\\*?\\)}")
2191 (format "^[ \t]*\\\\end{%s}[ \t]*$"
2193 (org-match-string-no-properties 1)))
2195 ;; Stop at valid keywords.
2196 (looking-at "[ \t]*#\\+\\S-+:")
2197 ;; Skip everything else.
2201 (re-search-forward org-element-paragraph-separate
2203 (beginning-of-line)))
2204 (if (= (point) limit
) limit
2205 (goto-char (line-beginning-position)))))
2206 (contents-end (progn (skip-chars-backward " \r\t\n" contents-begin
)
2209 (end (progn (skip-chars-forward " \r\t\n" limit
)
2210 (skip-chars-backward " \t")
2211 (if (bolp) (point) (line-end-position)))))
2216 :contents-begin contents-begin
2217 :contents-end contents-end
2218 :post-blank
(count-lines before-blank end
)
2219 :post-affiliated contents-begin
)
2220 (cdr affiliated
))))))
2222 (defun org-element-paragraph-interpreter (paragraph contents
)
2223 "Interpret PARAGRAPH element as Org syntax.
2224 CONTENTS is the contents of the element."
2230 (defun org-element-planning-parser (limit)
2233 LIMIT bounds the search.
2235 Return a list whose CAR is `planning' and CDR is a plist
2236 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
2237 and `:post-blank' keywords."
2239 (let* ((case-fold-search nil
)
2241 (post-blank (let ((before-blank (progn (forward-line) (point))))
2242 (skip-chars-forward " \r\t\n" limit
)
2243 (skip-chars-backward " \t")
2244 (unless (bolp) (end-of-line))
2245 (count-lines before-blank
(point))))
2247 closed deadline scheduled
)
2249 (while (re-search-forward org-keyword-time-not-clock-regexp end t
)
2250 (goto-char (match-end 1))
2251 (skip-chars-forward " \t" end
)
2252 (let ((keyword (match-string 1))
2253 (time (org-element-timestamp-parser)))
2254 (cond ((equal keyword org-closed-string
) (setq closed time
))
2255 ((equal keyword org-deadline-string
) (setq deadline time
))
2256 (t (setq scheduled time
)))))
2258 (list :closed closed
2260 :scheduled scheduled
2263 :post-blank post-blank
)))))
2265 (defun org-element-planning-interpreter (planning contents
)
2266 "Interpret PLANNING element as Org syntax.
2271 (list (let ((deadline (org-element-property :deadline planning
)))
2273 (concat org-deadline-string
" "
2274 (org-element-timestamp-interpreter deadline nil
))))
2275 (let ((scheduled (org-element-property :scheduled planning
)))
2277 (concat org-scheduled-string
" "
2278 (org-element-timestamp-interpreter scheduled nil
))))
2279 (let ((closed (org-element-property :closed planning
)))
2281 (concat org-closed-string
" "
2282 (org-element-timestamp-interpreter closed nil
))))))
2288 (defun org-element-quote-section-parser (limit)
2289 "Parse a quote section.
2291 LIMIT bounds the search.
2293 Return a list whose CAR is `quote-section' and CDR is a plist
2294 containing `:begin', `:end', `:value' and `:post-blank' keywords.
2296 Assume point is at beginning of the section."
2298 (let* ((begin (point))
2299 (end (progn (org-with-limited-levels (outline-next-heading))
2301 (pos-before-blank (progn (skip-chars-backward " \r\t\n")
2304 (value (buffer-substring-no-properties begin pos-before-blank
)))
2305 (list 'quote-section
2309 :post-blank
(count-lines pos-before-blank end
))))))
2311 (defun org-element-quote-section-interpreter (quote-section contents
)
2312 "Interpret QUOTE-SECTION element as Org syntax.
2314 (org-element-property :value quote-section
))
2319 (defun org-element-src-block-parser (limit affiliated
)
2322 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2323 the buffer position at the beginning of the first affiliated
2324 keyword and CDR is a plist of affiliated keywords along with
2327 Return a list whose CAR is `src-block' and CDR is a plist
2328 containing `:language', `:switches', `:parameters', `:begin',
2329 `:end', `:hiddenp', `:number-lines', `:retain-labels',
2330 `:use-labels', `:label-fmt', `:preserve-indent', `:value',
2331 `:post-blank' and `:post-affiliated' keywords.
2333 Assume point is at the beginning of the block."
2334 (let ((case-fold-search t
))
2335 (if (not (save-excursion (re-search-forward "^[ \t]*#\\+END_SRC[ \t]*$"
2337 ;; Incomplete block: parse it as a paragraph.
2338 (org-element-paragraph-parser limit affiliated
)
2339 (let ((contents-end (match-beginning 0)))
2341 (let* ((begin (car affiliated
))
2342 (post-affiliated (point))
2343 ;; Get language as a string.
2347 (concat "^[ \t]*#\\+BEGIN_SRC"
2348 "\\(?: +\\(\\S-+\\)\\)?"
2349 "\\(\\(?: +\\(?:-l \".*?\"\\|[-+][A-Za-z]\\)\\)+\\)?"
2351 (org-match-string-no-properties 1)))
2353 (switches (org-match-string-no-properties 2))
2355 (parameters (org-match-string-no-properties 3))
2356 ;; Switches analysis
2358 (cond ((not switches
) nil
)
2359 ((string-match "-n\\>" switches
) 'new
)
2360 ((string-match "+n\\>" switches
) 'continued
)))
2361 (preserve-indent (or org-src-preserve-indentation
2363 (string-match "-i\\>" switches
))))
2366 (string-match "-l +\"\\([^\"\n]+\\)\"" switches
)
2367 (match-string 1 switches
)))
2368 ;; Should labels be retained in (or stripped from)
2372 (not (string-match "-r\\>" switches
))
2373 (and number-lines
(string-match "-k\\>" switches
))))
2374 ;; What should code-references use - labels or
2379 (not (string-match "-k\\>" switches
)))))
2381 (block-ind (progn (skip-chars-forward " \t") (current-column)))
2382 ;; Get visibility status.
2383 (hidden (progn (forward-line) (org-invisible-p2)))
2385 (value (org-element--remove-indentation
2386 (org-unescape-code-in-string
2387 (buffer-substring-no-properties
2388 (point) contents-end
))
2389 (and preserve-indent block-ind
)))
2390 (pos-before-blank (progn (goto-char contents-end
)
2393 ;; Get position after ending blank lines.
2394 (end (progn (skip-chars-forward " \r\t\n" limit
)
2395 (skip-chars-backward " \t")
2396 (if (bolp) (point) (line-end-position)))))
2399 (list :language language
2400 :switches
(and (org-string-nw-p switches
)
2401 (org-trim switches
))
2402 :parameters
(and (org-string-nw-p parameters
)
2403 (org-trim parameters
))
2406 :number-lines number-lines
2407 :preserve-indent preserve-indent
2408 :retain-labels retain-labels
2409 :use-labels use-labels
2410 :label-fmt label-fmt
2413 :post-blank
(count-lines pos-before-blank end
)
2414 :post-affiliated post-affiliated
)
2415 (cdr affiliated
)))))))))
2417 (defun org-element-src-block-interpreter (src-block contents
)
2418 "Interpret SRC-BLOCK element as Org syntax.
2420 (let ((lang (org-element-property :language src-block
))
2421 (switches (org-element-property :switches src-block
))
2422 (params (org-element-property :parameters src-block
))
2423 (value (let ((val (org-element-property :value src-block
)))
2425 ((org-element-property :preserve-indent src-block
) val
)
2426 ((zerop org-edit-src-content-indentation
) val
)
2428 (let ((ind (make-string
2429 org-edit-src-content-indentation
32)))
2430 (replace-regexp-in-string
2431 "\\(^\\)[ \t]*\\S-" ind val nil nil
1)))))))
2432 (concat (format "#+BEGIN_SRC%s\n"
2433 (concat (and lang
(concat " " lang
))
2434 (and switches
(concat " " switches
))
2435 (and params
(concat " " params
))))
2436 (org-escape-code-in-string value
)
2442 (defun org-element-table-parser (limit affiliated
)
2443 "Parse a table at point.
2445 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2446 the buffer position at the beginning of the first affiliated
2447 keyword and CDR is a plist of affiliated keywords along with
2450 Return a list whose CAR is `table' and CDR is a plist containing
2451 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2452 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2455 Assume point is at the beginning of the table."
2457 (let* ((case-fold-search t
)
2458 (table-begin (point))
2459 (type (if (org-at-table.el-p
) 'table.el
'org
))
2460 (begin (car affiliated
))
2462 (if (re-search-forward org-table-any-border-regexp limit
'm
)
2463 (goto-char (match-beginning 0))
2466 (while (looking-at "[ \t]*#\\+TBLFM: +\\(.*\\)[ \t]*$")
2467 (push (org-match-string-no-properties 1) acc
)
2470 (pos-before-blank (point))
2471 (end (progn (skip-chars-forward " \r\t\n" limit
)
2472 (skip-chars-backward " \t")
2473 (if (bolp) (point) (line-end-position)))))
2480 ;; Only `org' tables have contents. `table.el' tables
2481 ;; use a `:value' property to store raw table as
2483 :contents-begin
(and (eq type
'org
) table-begin
)
2484 :contents-end
(and (eq type
'org
) table-end
)
2485 :value
(and (eq type
'table.el
)
2486 (buffer-substring-no-properties
2487 table-begin table-end
))
2488 :post-blank
(count-lines pos-before-blank end
)
2489 :post-affiliated table-begin
)
2490 (cdr affiliated
))))))
2492 (defun org-element-table-interpreter (table contents
)
2493 "Interpret TABLE element as Org syntax.
2495 (if (eq (org-element-property :type table
) 'table.el
)
2496 (org-remove-indentation (org-element-property :value table
))
2497 (concat (with-temp-buffer (insert contents
)
2500 (mapconcat (lambda (fm) (concat "#+TBLFM: " fm
))
2501 (reverse (org-element-property :tblfm table
))
2507 (defun org-element-table-row-parser (limit)
2508 "Parse table row at point.
2510 LIMIT bounds the search.
2512 Return a list whose CAR is `table-row' and CDR is a plist
2513 containing `:begin', `:end', `:contents-begin', `:contents-end',
2514 `:type' and `:post-blank' keywords."
2516 (let* ((type (if (looking-at "^[ \t]*|-") 'rule
'standard
))
2518 ;; A table rule has no contents. In that case, ensure
2519 ;; CONTENTS-BEGIN matches CONTENTS-END.
2520 (contents-begin (and (eq type
'standard
)
2521 (search-forward "|")
2523 (contents-end (and (eq type
'standard
)
2526 (skip-chars-backward " \t")
2528 (end (progn (forward-line) (point))))
2533 :contents-begin contents-begin
2534 :contents-end contents-end
2537 (defun org-element-table-row-interpreter (table-row contents
)
2538 "Interpret TABLE-ROW element as Org syntax.
2539 CONTENTS is the contents of the table row."
2540 (if (eq (org-element-property :type table-row
) 'rule
) "|-"
2541 (concat "| " contents
)))
2546 (defun org-element-verse-block-parser (limit affiliated
)
2547 "Parse a verse block.
2549 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2550 the buffer position at the beginning of the first affiliated
2551 keyword and CDR is a plist of affiliated keywords along with
2554 Return a list whose CAR is `verse-block' and CDR is a plist
2555 containing `:begin', `:end', `:contents-begin', `:contents-end',
2556 `:hiddenp', `:post-blank' and `:post-affiliated' keywords.
2558 Assume point is at beginning of the block."
2559 (let ((case-fold-search t
))
2560 (if (not (save-excursion
2561 (re-search-forward "^[ \t]*#\\+END_VERSE[ \t]*$" limit t
)))
2562 ;; Incomplete block: parse it as a paragraph.
2563 (org-element-paragraph-parser limit affiliated
)
2564 (let ((contents-end (match-beginning 0)))
2566 (let* ((begin (car affiliated
))
2567 (post-affiliated (point))
2568 (hidden (progn (forward-line) (org-invisible-p2)))
2569 (contents-begin (point))
2570 (pos-before-blank (progn (goto-char contents-end
)
2573 (end (progn (skip-chars-forward " \r\t\n" limit
)
2574 (skip-chars-backward " \t")
2575 (if (bolp) (point) (line-end-position)))))
2580 :contents-begin contents-begin
2581 :contents-end contents-end
2583 :post-blank
(count-lines pos-before-blank end
)
2584 :post-affiliated post-affiliated
)
2585 (cdr affiliated
)))))))))
2587 (defun org-element-verse-block-interpreter (verse-block contents
)
2588 "Interpret VERSE-BLOCK element as Org syntax.
2589 CONTENTS is verse block contents."
2590 (format "#+BEGIN_VERSE\n%s#+END_VERSE" contents
))
2596 ;; Unlike to elements, interstices can be found between objects.
2597 ;; That's why, along with the parser, successor functions are provided
2598 ;; for each object. Some objects share the same successor (i.e. `code'
2599 ;; and `verbatim' objects).
2601 ;; A successor must accept a single argument bounding the search. It
2602 ;; will return either a cons cell whose CAR is the object's type, as
2603 ;; a symbol, and CDR the position of its next occurrence, or nil.
2605 ;; Successors follow the naming convention:
2606 ;; org-element-NAME-successor, where NAME is the name of the
2607 ;; successor, as defined in `org-element-all-successors'.
2609 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2610 ;; object types they can contain will be specified in
2611 ;; `org-element-object-restrictions'.
2613 ;; Adding a new type of object is simple. Implement a successor,
2614 ;; a parser, and an interpreter for it, all following the naming
2615 ;; convention. Register type in `org-element-all-objects' and
2616 ;; successor in `org-element-all-successors'. Maybe tweak
2617 ;; restrictions about it, and that's it.
2622 (defun org-element-bold-parser ()
2623 "Parse bold object at point.
2625 Return a list whose CAR is `bold' and CDR is a plist with
2626 `:begin', `:end', `:contents-begin' and `:contents-end' and
2627 `:post-blank' keywords.
2629 Assume point is at the first star marker."
2631 (unless (bolp) (backward-char 1))
2632 (looking-at org-emph-re
)
2633 (let ((begin (match-beginning 2))
2634 (contents-begin (match-beginning 4))
2635 (contents-end (match-end 4))
2636 (post-blank (progn (goto-char (match-end 2))
2637 (skip-chars-forward " \t")))
2642 :contents-begin contents-begin
2643 :contents-end contents-end
2644 :post-blank post-blank
)))))
2646 (defun org-element-bold-interpreter (bold contents
)
2647 "Interpret BOLD object as Org syntax.
2648 CONTENTS is the contents of the object."
2649 (format "*%s*" contents
))
2651 (defun org-element-text-markup-successor ()
2652 "Search for the next text-markup object.
2654 Return value is a cons cell whose CAR is a symbol among `bold',
2655 `italic', `underline', `strike-through', `code' and `verbatim'
2656 and CDR is beginning position."
2658 (unless (bolp) (backward-char))
2659 (when (re-search-forward org-emph-re nil t
)
2660 (let ((marker (match-string 3)))
2662 ((equal marker
"*") 'bold
)
2663 ((equal marker
"/") 'italic
)
2664 ((equal marker
"_") 'underline
)
2665 ((equal marker
"+") 'strike-through
)
2666 ((equal marker
"~") 'code
)
2667 ((equal marker
"=") 'verbatim
)
2668 (t (error "Unknown marker at %d" (match-beginning 3))))
2669 (match-beginning 2))))))
2674 (defun org-element-code-parser ()
2675 "Parse code object at point.
2677 Return a list whose CAR is `code' and CDR is a plist with
2678 `:value', `:begin', `:end' and `:post-blank' keywords.
2680 Assume point is at the first tilde marker."
2682 (unless (bolp) (backward-char 1))
2683 (looking-at org-emph-re
)
2684 (let ((begin (match-beginning 2))
2685 (value (org-match-string-no-properties 4))
2686 (post-blank (progn (goto-char (match-end 2))
2687 (skip-chars-forward " \t")))
2693 :post-blank post-blank
)))))
2695 (defun org-element-code-interpreter (code contents
)
2696 "Interpret CODE object as Org syntax.
2698 (format "~%s~" (org-element-property :value code
)))
2703 (defun org-element-entity-parser ()
2704 "Parse entity at point.
2706 Return a list whose CAR is `entity' and CDR a plist with
2707 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2708 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2711 Assume point is at the beginning of the entity."
2713 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2714 (let* ((value (org-entity-get (match-string 1)))
2715 (begin (match-beginning 0))
2716 (bracketsp (string= (match-string 2) "{}"))
2717 (post-blank (progn (goto-char (match-end 1))
2718 (when bracketsp
(forward-char 2))
2719 (skip-chars-forward " \t")))
2722 (list :name
(car value
)
2723 :latex
(nth 1 value
)
2724 :latex-math-p
(nth 2 value
)
2726 :ascii
(nth 4 value
)
2727 :latin1
(nth 5 value
)
2728 :utf-8
(nth 6 value
)
2731 :use-brackets-p bracketsp
2732 :post-blank post-blank
)))))
2734 (defun org-element-entity-interpreter (entity contents
)
2735 "Interpret ENTITY object as Org syntax.
2738 (org-element-property :name entity
)
2739 (when (org-element-property :use-brackets-p entity
) "{}")))
2741 (defun org-element-latex-or-entity-successor ()
2742 "Search for the next latex-fragment or entity object.
2744 Return value is a cons cell whose CAR is `entity' or
2745 `latex-fragment' and CDR is beginning position."
2747 (unless (bolp) (backward-char))
2749 (remove "begin" (plist-get org-format-latex-options
:matchers
)))
2750 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2752 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))
2753 (when (re-search-forward
2754 (concat (mapconcat (lambda (e) (nth 1 (assoc e org-latex-regexps
)))
2758 (goto-char (match-beginning 0))
2759 (if (looking-at entity-re
)
2760 ;; Determine if it's a real entity or a LaTeX command.
2761 (cons (if (org-entity-get (match-string 1)) 'entity
'latex-fragment
)
2762 (match-beginning 0))
2763 ;; No entity nor command: point is at a LaTeX fragment.
2764 ;; Determine its type to get the correct beginning position.
2765 (cons 'latex-fragment
2768 (when (looking-at (nth 1 (assoc e org-latex-regexps
)))
2771 (nth 2 (assoc e org-latex-regexps
))))))
2778 (defun org-element-export-snippet-parser ()
2779 "Parse export snippet at point.
2781 Return a list whose CAR is `export-snippet' and CDR a plist with
2782 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2785 Assume point is at the beginning of the snippet."
2787 (re-search-forward "@@\\([-A-Za-z0-9]+\\):" nil t
)
2788 (let* ((begin (match-beginning 0))
2789 (back-end (org-match-string-no-properties 1))
2790 (value (buffer-substring-no-properties
2792 (progn (re-search-forward "@@" nil t
) (match-beginning 0))))
2793 (post-blank (skip-chars-forward " \t"))
2795 (list 'export-snippet
2796 (list :back-end back-end
2800 :post-blank post-blank
)))))
2802 (defun org-element-export-snippet-interpreter (export-snippet contents
)
2803 "Interpret EXPORT-SNIPPET object as Org syntax.
2806 (org-element-property :back-end export-snippet
)
2807 (org-element-property :value export-snippet
)))
2809 (defun org-element-export-snippet-successor ()
2810 "Search for the next export-snippet object.
2812 Return value is a cons cell whose CAR is `export-snippet' and CDR
2813 its beginning position."
2816 (when (and (re-search-forward "@@[-A-Za-z0-9]+:" nil t
)
2817 (setq beg
(match-beginning 0))
2818 (search-forward "@@" nil t
))
2819 (cons 'export-snippet beg
)))))
2822 ;;;; Footnote Reference
2824 (defun org-element-footnote-reference-parser ()
2825 "Parse footnote reference at point.
2827 Return a list whose CAR is `footnote-reference' and CDR a plist
2828 with `:label', `:type', `:inline-definition', `:begin', `:end'
2829 and `:post-blank' as keywords."
2831 (looking-at org-footnote-re
)
2832 (let* ((begin (point))
2833 (label (or (org-match-string-no-properties 2)
2834 (org-match-string-no-properties 3)
2835 (and (match-string 1)
2836 (concat "fn:" (org-match-string-no-properties 1)))))
2837 (type (if (or (not label
) (match-string 1)) 'inline
'standard
))
2838 (inner-begin (match-end 0))
2842 (while (and (> count
0) (re-search-forward "[][]" nil t
))
2843 (if (equal (match-string 0) "[") (incf count
) (decf count
)))
2845 (post-blank (progn (goto-char (1+ inner-end
))
2846 (skip-chars-forward " \t")))
2849 (list 'footnote-reference
2854 :post-blank post-blank
))))
2855 (org-element-put-property
2856 footnote-reference
:inline-definition
2857 (and (eq type
'inline
)
2858 (org-element-parse-secondary-string
2859 (buffer-substring inner-begin inner-end
)
2860 (org-element-restriction 'footnote-reference
)
2861 footnote-reference
))))))
2863 (defun org-element-footnote-reference-interpreter (footnote-reference contents
)
2864 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2866 (let ((label (or (org-element-property :label footnote-reference
) "fn:"))
2869 (org-element-property :inline-definition footnote-reference
)))
2870 (if (not inline-def
) ""
2871 (concat ":" (org-element-interpret-data inline-def
))))))
2872 (format "[%s]" (concat label def
))))
2874 (defun org-element-footnote-reference-successor ()
2875 "Search for the next footnote-reference object.
2877 Return value is a cons cell whose CAR is `footnote-reference' and
2878 CDR is beginning position."
2881 (while (re-search-forward org-footnote-re nil t
)
2883 (let ((beg (match-beginning 0))
2886 (while (re-search-forward "[][]" nil t
)
2887 (if (equal (match-string 0) "[") (incf count
) (decf count
))
2889 (throw 'exit
(cons 'footnote-reference beg
))))))))))
2892 ;;;; Inline Babel Call
2894 (defun org-element-inline-babel-call-parser ()
2895 "Parse inline babel call at point.
2897 Return a list whose CAR is `inline-babel-call' and CDR a plist
2898 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2900 Assume point is at the beginning of the babel call."
2902 (unless (bolp) (backward-char))
2903 (looking-at org-babel-inline-lob-one-liner-regexp
)
2904 (let ((info (save-match-data (org-babel-lob-get-info)))
2905 (begin (match-end 1))
2906 (post-blank (progn (goto-char (match-end 0))
2907 (skip-chars-forward " \t")))
2909 (list 'inline-babel-call
2913 :post-blank post-blank
)))))
2915 (defun org-element-inline-babel-call-interpreter (inline-babel-call contents
)
2916 "Interpret INLINE-BABEL-CALL object as Org syntax.
2918 (let* ((babel-info (org-element-property :info inline-babel-call
))
2919 (main-source (car babel-info
))
2920 (post-options (nth 1 babel-info
)))
2922 (if (string-match "\\[\\(\\[.*?\\]\\)\\]" main-source
)
2923 ;; Remove redundant square brackets.
2925 (match-string 1 main-source
) nil nil main-source
)
2927 (and post-options
(format "[%s]" post-options
)))))
2929 (defun org-element-inline-babel-call-successor ()
2930 "Search for the next inline-babel-call object.
2932 Return value is a cons cell whose CAR is `inline-babel-call' and
2933 CDR is beginning position."
2935 ;; Use a simplified version of
2936 ;; `org-babel-inline-lob-one-liner-regexp'.
2937 (when (re-search-forward
2938 "call_\\([^()\n]+?\\)\\(?:\\[.*?\\]\\)?([^\n]*?)\\(\\[.*?\\]\\)?"
2940 (cons 'inline-babel-call
(match-beginning 0)))))
2943 ;;;; Inline Src Block
2945 (defun org-element-inline-src-block-parser ()
2946 "Parse inline source block at point.
2948 Return a list whose CAR is `inline-src-block' and CDR a plist
2949 with `:begin', `:end', `:language', `:value', `:parameters' and
2950 `:post-blank' as keywords.
2952 Assume point is at the beginning of the inline src block."
2954 (unless (bolp) (backward-char))
2955 (looking-at org-babel-inline-src-block-regexp
)
2956 (let ((begin (match-beginning 1))
2957 (language (org-match-string-no-properties 2))
2958 (parameters (org-match-string-no-properties 4))
2959 (value (org-match-string-no-properties 5))
2960 (post-blank (progn (goto-char (match-end 0))
2961 (skip-chars-forward " \t")))
2963 (list 'inline-src-block
2964 (list :language language
2966 :parameters parameters
2969 :post-blank post-blank
)))))
2971 (defun org-element-inline-src-block-interpreter (inline-src-block contents
)
2972 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2974 (let ((language (org-element-property :language inline-src-block
))
2975 (arguments (org-element-property :parameters inline-src-block
))
2976 (body (org-element-property :value inline-src-block
)))
2977 (format "src_%s%s{%s}"
2979 (if arguments
(format "[%s]" arguments
) "")
2982 (defun org-element-inline-src-block-successor ()
2983 "Search for the next inline-babel-call element.
2985 Return value is a cons cell whose CAR is `inline-babel-call' and
2986 CDR is beginning position."
2988 (unless (bolp) (backward-char))
2989 (when (re-search-forward org-babel-inline-src-block-regexp nil t
)
2990 (cons 'inline-src-block
(match-beginning 1)))))
2994 (defun org-element-italic-parser ()
2995 "Parse italic object at point.
2997 Return a list whose CAR is `italic' and CDR is a plist with
2998 `:begin', `:end', `:contents-begin' and `:contents-end' and
2999 `:post-blank' keywords.
3001 Assume point is at the first slash marker."
3003 (unless (bolp) (backward-char 1))
3004 (looking-at org-emph-re
)
3005 (let ((begin (match-beginning 2))
3006 (contents-begin (match-beginning 4))
3007 (contents-end (match-end 4))
3008 (post-blank (progn (goto-char (match-end 2))
3009 (skip-chars-forward " \t")))
3014 :contents-begin contents-begin
3015 :contents-end contents-end
3016 :post-blank post-blank
)))))
3018 (defun org-element-italic-interpreter (italic contents
)
3019 "Interpret ITALIC object as Org syntax.
3020 CONTENTS is the contents of the object."
3021 (format "/%s/" contents
))
3026 (defun org-element-latex-fragment-parser ()
3027 "Parse latex fragment at point.
3029 Return a list whose CAR is `latex-fragment' and CDR a plist with
3030 `:value', `:begin', `:end', and `:post-blank' as keywords.
3032 Assume point is at the beginning of the latex fragment."
3034 (let* ((begin (point))
3038 (let ((latex-regexp (nth 1 (assoc e org-latex-regexps
))))
3039 (when (or (looking-at latex-regexp
)
3043 (looking-at latex-regexp
))))
3044 (throw 'exit
(nth 2 (assoc e org-latex-regexps
))))))
3045 (plist-get org-format-latex-options
:matchers
))
3046 ;; None found: it's a macro.
3047 (looking-at "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")
3049 (value (match-string-no-properties substring-match
))
3050 (post-blank (progn (goto-char (match-end substring-match
))
3051 (skip-chars-forward " \t")))
3053 (list 'latex-fragment
3057 :post-blank post-blank
)))))
3059 (defun org-element-latex-fragment-interpreter (latex-fragment contents
)
3060 "Interpret LATEX-FRAGMENT object as Org syntax.
3062 (org-element-property :value latex-fragment
))
3066 (defun org-element-line-break-parser ()
3067 "Parse line break at point.
3069 Return a list whose CAR is `line-break', and CDR a plist with
3070 `:begin', `:end' and `:post-blank' keywords.
3072 Assume point is at the beginning of the line break."
3074 (list :begin
(point)
3075 :end
(progn (forward-line) (point))
3078 (defun org-element-line-break-interpreter (line-break contents
)
3079 "Interpret LINE-BREAK object as Org syntax.
3083 (defun org-element-line-break-successor ()
3084 "Search for the next line-break object.
3086 Return value is a cons cell whose CAR is `line-break' and CDR is
3087 beginning position."
3089 (let ((beg (and (re-search-forward "[^\\\\]\\(\\\\\\\\\\)[ \t]*$" nil t
)
3090 (goto-char (match-beginning 1)))))
3091 ;; A line break can only happen on a non-empty line.
3092 (when (and beg
(re-search-backward "\\S-" (point-at-bol) t
))
3093 (cons 'line-break beg
)))))
3098 (defun org-element-link-parser ()
3099 "Parse link at point.
3101 Return a list whose CAR is `link' and CDR a plist with `:type',
3102 `:path', `:raw-link', `:application', `:search-option', `:begin',
3103 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
3106 Assume point is at the beginning of the link."
3108 (let ((begin (point))
3109 end contents-begin contents-end link-end post-blank path type
3110 raw-link link search-option application
)
3112 ;; Type 1: Text targeted from a radio target.
3113 ((and org-target-link-regexp
(looking-at org-target-link-regexp
))
3115 link-end
(match-end 0)
3116 path
(org-match-string-no-properties 0)))
3117 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3118 ((looking-at org-bracket-link-regexp
)
3119 (setq contents-begin
(match-beginning 3)
3120 contents-end
(match-end 3)
3121 link-end
(match-end 0)
3122 ;; RAW-LINK is the original link. Expand any
3123 ;; abbreviation in it.
3124 raw-link
(org-translate-link
3125 (org-link-expand-abbrev
3126 (org-match-string-no-properties 1))))
3127 ;; Determine TYPE of link and set PATH accordingly.
3130 ((or (file-name-absolute-p raw-link
)
3131 (string-match "^\\.\\.?/" raw-link
))
3132 (setq type
"file" path raw-link
))
3133 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
3134 ((string-match org-link-re-with-space3 raw-link
)
3135 (setq type
(match-string 1 raw-link
) path
(match-string 2 raw-link
)))
3136 ;; Id type: PATH is the id.
3137 ((string-match "^id:\\([-a-f0-9]+\\)" raw-link
)
3138 (setq type
"id" path
(match-string 1 raw-link
)))
3139 ;; Code-ref type: PATH is the name of the reference.
3140 ((string-match "^(\\(.*\\))$" raw-link
)
3141 (setq type
"coderef" path
(match-string 1 raw-link
)))
3142 ;; Custom-id type: PATH is the name of the custom id.
3143 ((= (aref raw-link
0) ?
#)
3144 (setq type
"custom-id" path
(substring raw-link
1)))
3145 ;; Fuzzy type: Internal link either matches a target, an
3146 ;; headline name or nothing. PATH is the target or
3148 (t (setq type
"fuzzy" path raw-link
))))
3149 ;; Type 3: Plain link, i.e. http://orgmode.org
3150 ((looking-at org-plain-link-re
)
3151 (setq raw-link
(org-match-string-no-properties 0)
3152 type
(org-match-string-no-properties 1)
3153 link-end
(match-end 0)
3154 path
(org-match-string-no-properties 2)))
3155 ;; Type 4: Angular link, i.e. <http://orgmode.org>
3156 ((looking-at org-angle-link-re
)
3157 (setq raw-link
(buffer-substring-no-properties
3158 (match-beginning 1) (match-end 2))
3159 type
(org-match-string-no-properties 1)
3160 link-end
(match-end 0)
3161 path
(org-match-string-no-properties 2))))
3162 ;; In any case, deduce end point after trailing white space from
3163 ;; LINK-END variable.
3164 (setq post-blank
(progn (goto-char link-end
) (skip-chars-forward " \t"))
3166 ;; Extract search option and opening application out of
3167 ;; "file"-type links.
3168 (when (member type org-element-link-type-is-file
)
3170 (cond ((string-match "^file\\+\\(.*\\)$" type
)
3171 (setq application
(match-string 1 type
)))
3172 ((not (string-match "^file" type
))
3173 (setq application type
)))
3174 ;; Extract search option from PATH.
3175 (when (string-match "::\\(.*\\)$" path
)
3176 (setq search-option
(match-string 1 path
)
3177 path
(replace-match "" nil nil path
)))
3178 ;; Make sure TYPE always reports "file".
3183 :raw-link
(or raw-link path
)
3184 :application application
3185 :search-option search-option
3188 :contents-begin contents-begin
3189 :contents-end contents-end
3190 :post-blank post-blank
)))))
3192 (defun org-element-link-interpreter (link contents
)
3193 "Interpret LINK object as Org syntax.
3194 CONTENTS is the contents of the object, or nil."
3195 (let ((type (org-element-property :type link
))
3196 (raw-link (org-element-property :raw-link link
)))
3197 (if (string= type
"radio") raw-link
3200 (if contents
(format "[%s]" contents
) "")))))
3202 (defun org-element-link-successor ()
3203 "Search for the next link object.
3205 Return value is a cons cell whose CAR is `link' and CDR is
3206 beginning position."
3209 (if (not org-target-link-regexp
) org-any-link-re
3210 (concat org-any-link-re
"\\|" org-target-link-regexp
))))
3211 (when (re-search-forward link-regexp nil t
)
3212 (cons 'link
(match-beginning 0))))))
3214 (defun org-element-plain-link-successor ()
3215 "Search for the next plain link object.
3217 Return value is a cons cell whose CAR is `link' and CDR is
3218 beginning position."
3219 (and (save-excursion (re-search-forward org-plain-link-re nil t
))
3220 (cons 'link
(match-beginning 0))))
3225 (defun org-element-macro-parser ()
3226 "Parse macro at point.
3228 Return a list whose CAR is `macro' and CDR a plist with `:key',
3229 `:args', `:begin', `:end', `:value' and `:post-blank' as
3232 Assume point is at the macro."
3234 (looking-at "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\(([ \t\n]*\\([^\000]*?\\))\\)?}}}")
3235 (let ((begin (point))
3236 (key (downcase (org-match-string-no-properties 1)))
3237 (value (org-match-string-no-properties 0))
3238 (post-blank (progn (goto-char (match-end 0))
3239 (skip-chars-forward " \t")))
3241 (args (let ((args (org-match-string-no-properties 3)))
3243 ;; Do not use `org-split-string' since empty
3244 ;; strings are meaningful here.
3246 (replace-regexp-in-string
3247 "\\(\\\\*\\)\\(,\\)"
3249 (let ((len (length (match-string 1 str
))))
3250 (concat (make-string (/ len
2) ?
\\)
3251 (if (zerop (mod len
2)) "\000" ","))))
3260 :post-blank post-blank
)))))
3262 (defun org-element-macro-interpreter (macro contents
)
3263 "Interpret MACRO object as Org syntax.
3265 (org-element-property :value macro
))
3267 (defun org-element-macro-successor ()
3268 "Search for the next macro object.
3270 Return value is cons cell whose CAR is `macro' and CDR is
3271 beginning position."
3273 (when (re-search-forward
3274 "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\(([ \t\n]*\\([^\000]*?\\))\\)?}}}"
3276 (cons 'macro
(match-beginning 0)))))
3281 (defun org-element-radio-target-parser ()
3282 "Parse radio target at point.
3284 Return a list whose CAR is `radio-target' and CDR a plist with
3285 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
3286 and `:post-blank' as keywords.
3288 Assume point is at the radio target."
3290 (looking-at org-radio-target-regexp
)
3291 (let ((begin (point))
3292 (contents-begin (match-beginning 1))
3293 (contents-end (match-end 1))
3294 (value (org-match-string-no-properties 1))
3295 (post-blank (progn (goto-char (match-end 0))
3296 (skip-chars-forward " \t")))
3301 :contents-begin contents-begin
3302 :contents-end contents-end
3303 :post-blank post-blank
3306 (defun org-element-radio-target-interpreter (target contents
)
3307 "Interpret TARGET object as Org syntax.
3308 CONTENTS is the contents of the object."
3309 (concat "<<<" contents
">>>"))
3311 (defun org-element-radio-target-successor ()
3312 "Search for the next radio-target object.
3314 Return value is a cons cell whose CAR is `radio-target' and CDR
3315 is beginning position."
3317 (when (re-search-forward org-radio-target-regexp nil t
)
3318 (cons 'radio-target
(match-beginning 0)))))
3321 ;;;; Statistics Cookie
3323 (defun org-element-statistics-cookie-parser ()
3324 "Parse statistics cookie at point.
3326 Return a list whose CAR is `statistics-cookie', and CDR a plist
3327 with `:begin', `:end', `:value' and `:post-blank' keywords.
3329 Assume point is at the beginning of the statistics-cookie."
3331 (looking-at "\\[[0-9]*\\(%\\|/[0-9]*\\)\\]")
3332 (let* ((begin (point))
3333 (value (buffer-substring-no-properties
3334 (match-beginning 0) (match-end 0)))
3335 (post-blank (progn (goto-char (match-end 0))
3336 (skip-chars-forward " \t")))
3338 (list 'statistics-cookie
3342 :post-blank post-blank
)))))
3344 (defun org-element-statistics-cookie-interpreter (statistics-cookie contents
)
3345 "Interpret STATISTICS-COOKIE object as Org syntax.
3347 (org-element-property :value statistics-cookie
))
3349 (defun org-element-statistics-cookie-successor ()
3350 "Search for the next statistics cookie object.
3352 Return value is a cons cell whose CAR is `statistics-cookie' and
3353 CDR is beginning position."
3355 (when (re-search-forward "\\[[0-9]*\\(%\\|/[0-9]*\\)\\]" nil t
)
3356 (cons 'statistics-cookie
(match-beginning 0)))))
3361 (defun org-element-strike-through-parser ()
3362 "Parse strike-through object at point.
3364 Return a list whose CAR is `strike-through' and CDR is a plist
3365 with `:begin', `:end', `:contents-begin' and `:contents-end' and
3366 `:post-blank' keywords.
3368 Assume point is at the first plus sign marker."
3370 (unless (bolp) (backward-char 1))
3371 (looking-at org-emph-re
)
3372 (let ((begin (match-beginning 2))
3373 (contents-begin (match-beginning 4))
3374 (contents-end (match-end 4))
3375 (post-blank (progn (goto-char (match-end 2))
3376 (skip-chars-forward " \t")))
3378 (list 'strike-through
3381 :contents-begin contents-begin
3382 :contents-end contents-end
3383 :post-blank post-blank
)))))
3385 (defun org-element-strike-through-interpreter (strike-through contents
)
3386 "Interpret STRIKE-THROUGH object as Org syntax.
3387 CONTENTS is the contents of the object."
3388 (format "+%s+" contents
))
3393 (defun org-element-subscript-parser ()
3394 "Parse subscript at point.
3396 Return a list whose CAR is `subscript' and CDR a plist with
3397 `:begin', `:end', `:contents-begin', `:contents-end',
3398 `:use-brackets-p' and `:post-blank' as keywords.
3400 Assume point is at the underscore."
3402 (unless (bolp) (backward-char))
3403 (let ((bracketsp (if (looking-at org-match-substring-with-braces-regexp
)
3405 (not (looking-at org-match-substring-regexp
))))
3406 (begin (match-beginning 2))
3407 (contents-begin (or (match-beginning 5)
3408 (match-beginning 3)))
3409 (contents-end (or (match-end 5) (match-end 3)))
3410 (post-blank (progn (goto-char (match-end 0))
3411 (skip-chars-forward " \t")))
3416 :use-brackets-p bracketsp
3417 :contents-begin contents-begin
3418 :contents-end contents-end
3419 :post-blank post-blank
)))))
3421 (defun org-element-subscript-interpreter (subscript contents
)
3422 "Interpret SUBSCRIPT object as Org syntax.
3423 CONTENTS is the contents of the object."
3425 (if (org-element-property :use-brackets-p subscript
) "_{%s}" "_%s")
3428 (defun org-element-sub/superscript-successor
()
3429 "Search for the next sub/superscript object.
3431 Return value is a cons cell whose CAR is either `subscript' or
3432 `superscript' and CDR is beginning position."
3434 (unless (bolp) (backward-char))
3435 (when (re-search-forward org-match-substring-regexp nil t
)
3436 (cons (if (string= (match-string 2) "_") 'subscript
'superscript
)
3437 (match-beginning 2)))))
3442 (defun org-element-superscript-parser ()
3443 "Parse superscript at point.
3445 Return a list whose CAR is `superscript' and CDR a plist with
3446 `:begin', `:end', `:contents-begin', `:contents-end',
3447 `:use-brackets-p' and `:post-blank' as keywords.
3449 Assume point is at the caret."
3451 (unless (bolp) (backward-char))
3452 (let ((bracketsp (if (looking-at org-match-substring-with-braces-regexp
) t
3453 (not (looking-at org-match-substring-regexp
))))
3454 (begin (match-beginning 2))
3455 (contents-begin (or (match-beginning 5)
3456 (match-beginning 3)))
3457 (contents-end (or (match-end 5) (match-end 3)))
3458 (post-blank (progn (goto-char (match-end 0))
3459 (skip-chars-forward " \t")))
3464 :use-brackets-p bracketsp
3465 :contents-begin contents-begin
3466 :contents-end contents-end
3467 :post-blank post-blank
)))))
3469 (defun org-element-superscript-interpreter (superscript contents
)
3470 "Interpret SUPERSCRIPT object as Org syntax.
3471 CONTENTS is the contents of the object."
3473 (if (org-element-property :use-brackets-p superscript
) "^{%s}" "^%s")
3479 (defun org-element-table-cell-parser ()
3480 "Parse table cell at point.
3482 Return a list whose CAR is `table-cell' and CDR is a plist
3483 containing `:begin', `:end', `:contents-begin', `:contents-end'
3484 and `:post-blank' keywords."
3485 (looking-at "[ \t]*\\(.*?\\)[ \t]*|")
3486 (let* ((begin (match-beginning 0))
3488 (contents-begin (match-beginning 1))
3489 (contents-end (match-end 1)))
3493 :contents-begin contents-begin
3494 :contents-end contents-end
3497 (defun org-element-table-cell-interpreter (table-cell contents
)
3498 "Interpret TABLE-CELL element as Org syntax.
3499 CONTENTS is the contents of the cell, or nil."
3500 (concat " " contents
" |"))
3502 (defun org-element-table-cell-successor ()
3503 "Search for the next table-cell object.
3505 Return value is a cons cell whose CAR is `table-cell' and CDR is
3506 beginning position."
3507 (when (looking-at "[ \t]*.*?[ \t]*|") (cons 'table-cell
(point))))
3512 (defun org-element-target-parser ()
3513 "Parse target at point.
3515 Return a list whose CAR is `target' and CDR a plist with
3516 `:begin', `:end', `:value' and `:post-blank' as keywords.
3518 Assume point is at the target."
3520 (looking-at org-target-regexp
)
3521 (let ((begin (point))
3522 (value (org-match-string-no-properties 1))
3523 (post-blank (progn (goto-char (match-end 0))
3524 (skip-chars-forward " \t")))
3530 :post-blank post-blank
)))))
3532 (defun org-element-target-interpreter (target contents
)
3533 "Interpret TARGET object as Org syntax.
3535 (format "<<%s>>" (org-element-property :value target
)))
3537 (defun org-element-target-successor ()
3538 "Search for the next target object.
3540 Return value is a cons cell whose CAR is `target' and CDR is
3541 beginning position."
3543 (when (re-search-forward org-target-regexp nil t
)
3544 (cons 'target
(match-beginning 0)))))
3549 (defun org-element-timestamp-parser ()
3550 "Parse time stamp at point.
3552 Return a list whose CAR is `timestamp', and CDR a plist with
3553 `:type', `:raw-value', `:year-start', `:month-start',
3554 `:day-start', `:hour-start', `:minute-start', `:year-end',
3555 `:month-end', `:day-end', `:hour-end', `:minute-end',
3556 `:repeater-type', `:repeater-value', `:repeater-unit',
3557 `:warning-type', `:warning-value', `:warning-unit', `:begin',
3558 `:end', `:value' and `:post-blank' keywords.
3560 Assume point is at the beginning of the timestamp."
3562 (let* ((begin (point))
3563 (activep (eq (char-after) ?
<))
3566 (looking-at "\\([<[]\\(%%\\)?.*?\\)[]>]\\(?:--\\([<[].*?[]>]\\)\\)?")
3567 (match-string-no-properties 0)))
3568 (date-start (match-string-no-properties 1))
3569 (date-end (match-string 3))
3570 (diaryp (match-beginning 2))
3571 (post-blank (progn (goto-char (match-end 0))
3572 (skip-chars-forward " \t")))
3577 "[012]?[0-9]:[0-5][0-9]\\(-\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)"
3579 (cons (string-to-number (match-string 2 date-start
))
3580 (string-to-number (match-string 3 date-start
)))))
3581 (type (cond (diaryp 'diary
)
3582 ((and activep
(or date-end time-range
)) 'active-range
)
3584 ((or date-end time-range
) 'inactive-range
)
3588 (string-match "\\([.+]?\\+\\)\\([0-9]+\\)\\([hdwmy]\\)"
3592 (let ((type (match-string 1 raw-value
)))
3593 (cond ((equal "++" type
) 'catch-up
)
3594 ((equal ".+" type
) 'restart
)
3596 :repeater-value
(string-to-number (match-string 2 raw-value
))
3598 (case (string-to-char (match-string 3 raw-value
))
3599 (?h
'hour
) (?d
'day
) (?w
'week
) (?m
'month
) (t 'year
)))))
3602 (string-match "\\(-\\)?-\\([0-9]+\\)\\([hdwmy]\\)" raw-value
)
3604 :warning-type
(if (match-string 1 raw-value
) 'first
'all
)
3605 :warning-value
(string-to-number (match-string 2 raw-value
))
3607 (case (string-to-char (match-string 3 raw-value
))
3608 (?h
'hour
) (?d
'day
) (?w
'week
) (?m
'month
) (t 'year
)))))
3609 year-start month-start day-start hour-start minute-start year-end
3610 month-end day-end hour-end minute-end
)
3611 ;; Parse date-start.
3613 (let ((date (org-parse-time-string date-start t
)))
3614 (setq year-start
(nth 5 date
)
3615 month-start
(nth 4 date
)
3616 day-start
(nth 3 date
)
3617 hour-start
(nth 2 date
)
3618 minute-start
(nth 1 date
))))
3619 ;; Compute date-end. It can be provided directly in time-stamp,
3620 ;; or extracted from time range. Otherwise, it defaults to the
3621 ;; same values as date-start.
3623 (let ((date (and date-end
(org-parse-time-string date-end t
))))
3624 (setq year-end
(or (nth 5 date
) year-start
)
3625 month-end
(or (nth 4 date
) month-start
)
3626 day-end
(or (nth 3 date
) day-start
)
3627 hour-end
(or (nth 2 date
) (car time-range
) hour-start
)
3628 minute-end
(or (nth 1 date
) (cdr time-range
) minute-start
))))
3630 (nconc (list :type type
3631 :raw-value raw-value
3632 :year-start year-start
3633 :month-start month-start
3634 :day-start day-start
3635 :hour-start hour-start
3636 :minute-start minute-start
3638 :month-end month-end
3641 :minute-end minute-end
3644 :post-blank post-blank
)
3648 (defun org-element-timestamp-interpreter (timestamp contents
)
3649 "Interpret TIMESTAMP object as Org syntax.
3651 ;; Use `:raw-value' if specified.
3652 (or (org-element-property :raw-value timestamp
)
3653 ;; Otherwise, build timestamp string.
3654 (let* ((repeat-string
3656 (case (org-element-property :repeater-type timestamp
)
3657 (cumulate "+") (catch-up "++") (restart ".+"))
3658 (let ((val (org-element-property :repeater-value timestamp
)))
3659 (and val
(number-to-string val
)))
3660 (case (org-element-property :repeater-unit timestamp
)
3661 (hour "h") (day "d") (week "w") (month "m") (year "y"))))
3664 (case (org-element-property :warning-type timestamp
)
3667 (let ((val (org-element-property :warning-value timestamp
)))
3668 (and val
(number-to-string val
)))
3669 (case (org-element-property :warning-unit timestamp
)
3670 (hour "h") (day "d") (week "w") (month "m") (year "y"))))
3672 ;; Build an Org timestamp string from TIME. ACTIVEP is
3673 ;; non-nil when time stamp is active. If WITH-TIME-P is
3674 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3675 ;; specify a time range in the timestamp. REPEAT-STRING
3676 ;; is the repeater string, if any.
3677 (lambda (time activep
&optional with-time-p hour-end minute-end
)
3678 (let ((ts (format-time-string
3679 (funcall (if with-time-p
'cdr
'car
)
3680 org-time-stamp-formats
)
3682 (when (and hour-end minute-end
)
3683 (string-match "[012]?[0-9]:[0-5][0-9]" ts
)
3686 (format "\\&-%02d:%02d" hour-end minute-end
)
3688 (unless activep
(setq ts
(format "[%s]" (substring ts
1 -
1))))
3689 (dolist (s (list repeat-string warning-string
))
3690 (when (org-string-nw-p s
)
3691 (setq ts
(concat (substring ts
0 -
1)
3694 (substring ts -
1)))))
3697 (type (org-element-property :type timestamp
)))
3700 (let* ((minute-start (org-element-property :minute-start timestamp
))
3701 (minute-end (org-element-property :minute-end timestamp
))
3702 (hour-start (org-element-property :hour-start timestamp
))
3703 (hour-end (org-element-property :hour-end timestamp
))
3704 (time-range-p (and hour-start hour-end minute-start minute-end
3705 (or (/= hour-start hour-end
)
3706 (/= minute-start minute-end
)))))
3712 (org-element-property :day-start timestamp
)
3713 (org-element-property :month-start timestamp
)
3714 (org-element-property :year-start timestamp
))
3716 (and hour-start minute-start
)
3717 (and time-range-p hour-end
)
3718 (and time-range-p minute-end
))))
3719 ((active-range inactive-range
)
3720 (let ((minute-start (org-element-property :minute-start timestamp
))
3721 (minute-end (org-element-property :minute-end timestamp
))
3722 (hour-start (org-element-property :hour-start timestamp
))
3723 (hour-end (org-element-property :hour-end timestamp
)))
3726 build-ts-string
(encode-time
3730 (org-element-property :day-start timestamp
)
3731 (org-element-property :month-start timestamp
)
3732 (org-element-property :year-start timestamp
))
3733 (eq type
'active-range
)
3734 (and hour-start minute-start
))
3736 (funcall build-ts-string
3740 (org-element-property :day-end timestamp
)
3741 (org-element-property :month-end timestamp
)
3742 (org-element-property :year-end timestamp
))
3743 (eq type
'active-range
)
3744 (and hour-end minute-end
)))))))))
3746 (defun org-element-timestamp-successor ()
3747 "Search for the next timestamp object.
3749 Return value is a cons cell whose CAR is `timestamp' and CDR is
3750 beginning position."
3752 (when (re-search-forward
3753 (concat org-ts-regexp-both
3755 "\\(?:<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[dwmy]>\\)"
3757 "\\(?:<%%\\(?:([^>\n]+)\\)>\\)")
3759 (cons 'timestamp
(match-beginning 0)))))
3764 (defun org-element-underline-parser ()
3765 "Parse underline object at point.
3767 Return a list whose CAR is `underline' and CDR is a plist with
3768 `:begin', `:end', `:contents-begin' and `:contents-end' and
3769 `:post-blank' keywords.
3771 Assume point is at the first underscore marker."
3773 (unless (bolp) (backward-char 1))
3774 (looking-at org-emph-re
)
3775 (let ((begin (match-beginning 2))
3776 (contents-begin (match-beginning 4))
3777 (contents-end (match-end 4))
3778 (post-blank (progn (goto-char (match-end 2))
3779 (skip-chars-forward " \t")))
3784 :contents-begin contents-begin
3785 :contents-end contents-end
3786 :post-blank post-blank
)))))
3788 (defun org-element-underline-interpreter (underline contents
)
3789 "Interpret UNDERLINE object as Org syntax.
3790 CONTENTS is the contents of the object."
3791 (format "_%s_" contents
))
3796 (defun org-element-verbatim-parser ()
3797 "Parse verbatim object at point.
3799 Return a list whose CAR is `verbatim' and CDR is a plist with
3800 `:value', `:begin', `:end' and `:post-blank' keywords.
3802 Assume point is at the first equal sign marker."
3804 (unless (bolp) (backward-char 1))
3805 (looking-at org-emph-re
)
3806 (let ((begin (match-beginning 2))
3807 (value (org-match-string-no-properties 4))
3808 (post-blank (progn (goto-char (match-end 2))
3809 (skip-chars-forward " \t")))
3815 :post-blank post-blank
)))))
3817 (defun org-element-verbatim-interpreter (verbatim contents
)
3818 "Interpret VERBATIM object as Org syntax.
3820 (format "=%s=" (org-element-property :value verbatim
)))
3824 ;;; Parsing Element Starting At Point
3826 ;; `org-element--current-element' is the core function of this section.
3827 ;; It returns the Lisp representation of the element starting at
3830 ;; `org-element--current-element' makes use of special modes. They
3831 ;; are activated for fixed element chaining (i.e. `plain-list' >
3832 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3833 ;; `section'). Special modes are: `first-section', `item',
3834 ;; `node-property', `quote-section', `section' and `table-row'.
3836 (defun org-element--current-element
3837 (limit &optional granularity special structure
)
3838 "Parse the element starting at point.
3840 Return value is a list like (TYPE PROPS) where TYPE is the type
3841 of the element and PROPS a plist of properties associated to the
3844 Possible types are defined in `org-element-all-elements'.
3846 LIMIT bounds the search.
3848 Optional argument GRANULARITY determines the depth of the
3849 recursion. Allowed values are `headline', `greater-element',
3850 `element', `object' or nil. When it is broader than `object' (or
3851 nil), secondary values will not be parsed, since they only
3854 Optional argument SPECIAL, when non-nil, can be either
3855 `first-section', `item', `node-property', `quote-section',
3856 `section', and `table-row'.
3858 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3861 This function assumes point is always at the beginning of the
3862 element it has to parse."
3864 (let ((case-fold-search t
)
3865 ;; Determine if parsing depth allows for secondary strings
3866 ;; parsing. It only applies to elements referenced in
3867 ;; `org-element-secondary-value-alist'.
3868 (raw-secondary-p (and granularity
(not (eq granularity
'object
)))))
3872 (org-element-item-parser limit structure raw-secondary-p
))
3874 ((eq special
'table-row
) (org-element-table-row-parser limit
))
3876 ((eq special
'node-property
) (org-element-node-property-parser limit
))
3878 ((org-with-limited-levels (org-at-heading-p))
3879 (org-element-headline-parser limit raw-secondary-p
))
3880 ;; Sections (must be checked after headline).
3881 ((eq special
'section
) (org-element-section-parser limit
))
3882 ((eq special
'quote-section
) (org-element-quote-section-parser limit
))
3883 ((eq special
'first-section
)
3884 (org-element-section-parser
3885 (or (save-excursion (org-with-limited-levels (outline-next-heading)))
3887 ;; When not at bol, point is at the beginning of an item or
3888 ;; a footnote definition: next item is always a paragraph.
3889 ((not (bolp)) (org-element-paragraph-parser limit
(list (point))))
3890 ;; Planning and Clock.
3891 ((looking-at org-planning-or-clock-line-re
)
3892 (if (equal (match-string 1) org-clock-string
)
3893 (org-element-clock-parser limit
)
3894 (org-element-planning-parser limit
)))
3897 (org-element-inlinetask-parser limit raw-secondary-p
))
3898 ;; From there, elements can have affiliated keywords.
3899 (t (let ((affiliated (org-element--collect-affiliated-keywords limit
)))
3901 ;; Jumping over affiliated keywords put point off-limits.
3902 ;; Parse them as regular keywords.
3903 ((and (cdr affiliated
) (>= (point) limit
))
3904 (goto-char (car affiliated
))
3905 (org-element-keyword-parser limit nil
))
3906 ;; LaTeX Environment.
3908 "[ \t]*\\\\begin{[A-Za-z0-9*]+}\\(\\[.*?\\]\\|{.*?}\\)*[ \t]*$")
3909 (org-element-latex-environment-parser limit affiliated
))
3910 ;; Drawer and Property Drawer.
3911 ((looking-at org-drawer-regexp
)
3912 (if (equal (match-string 1) "PROPERTIES")
3913 (org-element-property-drawer-parser limit affiliated
)
3914 (org-element-drawer-parser limit affiliated
)))
3916 ((looking-at "[ \t]*:\\( \\|$\\)")
3917 (org-element-fixed-width-parser limit affiliated
))
3918 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3920 ((looking-at "[ \t]*#")
3921 (goto-char (match-end 0))
3922 (cond ((looking-at "\\(?: \\|$\\)")
3924 (org-element-comment-parser limit affiliated
))
3925 ((looking-at "\\+BEGIN_\\(\\S-+\\)")
3927 (let ((parser (assoc (upcase (match-string 1))
3928 org-element-block-name-alist
)))
3929 (if parser
(funcall (cdr parser
) limit affiliated
)
3930 (org-element-special-block-parser limit affiliated
))))
3931 ((looking-at "\\+CALL:")
3933 (org-element-babel-call-parser limit affiliated
))
3934 ((looking-at "\\+BEGIN:? ")
3936 (org-element-dynamic-block-parser limit affiliated
))
3937 ((looking-at "\\+\\S-+:")
3939 (org-element-keyword-parser limit affiliated
))
3942 (org-element-paragraph-parser limit affiliated
))))
3943 ;; Footnote Definition.
3944 ((looking-at org-footnote-definition-re
)
3945 (org-element-footnote-definition-parser limit affiliated
))
3947 ((looking-at "[ \t]*-\\{5,\\}[ \t]*$")
3948 (org-element-horizontal-rule-parser limit affiliated
))
3951 (org-element-diary-sexp-parser limit affiliated
))
3953 ((org-at-table-p t
) (org-element-table-parser limit affiliated
))
3955 ((looking-at (org-item-re))
3956 (org-element-plain-list-parser
3958 (or structure
(org-element--list-struct limit
))))
3959 ;; Default element: Paragraph.
3960 (t (org-element-paragraph-parser limit affiliated
)))))))))
3963 ;; Most elements can have affiliated keywords. When looking for an
3964 ;; element beginning, we want to move before them, as they belong to
3965 ;; that element, and, in the meantime, collect information they give
3966 ;; into appropriate properties. Hence the following function.
3968 (defun org-element--collect-affiliated-keywords (limit)
3969 "Collect affiliated keywords from point down to LIMIT.
3971 Return a list whose CAR is the position at the first of them and
3972 CDR a plist of keywords and values and move point to the
3973 beginning of the first line after them.
3975 As a special case, if element doesn't start at the beginning of
3976 the line (i.e. a paragraph starting an item), CAR is current
3977 position of point and CDR is nil."
3978 (if (not (bolp)) (list (point))
3979 (let ((case-fold-search t
)
3981 ;; RESTRICT is the list of objects allowed in parsed
3983 (restrict (org-element-restriction 'keyword
))
3985 (while (and (< (point) limit
) (looking-at org-element--affiliated-re
))
3986 (let* ((raw-kwd (upcase (match-string 1)))
3987 ;; Apply translation to RAW-KWD. From there, KWD is
3988 ;; the official keyword.
3989 (kwd (or (cdr (assoc raw-kwd
3990 org-element-keyword-translation-alist
))
3992 ;; Find main value for any keyword.
3996 (buffer-substring-no-properties
3997 (match-end 0) (point-at-eol)))))
3998 ;; PARSEDP is non-nil when keyword should have its
4000 (parsedp (member kwd org-element-parsed-keywords
))
4001 ;; If KWD is a dual keyword, find its secondary
4002 ;; value. Maybe parse it.
4003 (dualp (member kwd org-element-dual-keywords
))
4006 (let ((sec (org-match-string-no-properties 2)))
4007 (if (or (not sec
) (not parsedp
)) sec
4008 (org-element-parse-secondary-string sec restrict
)))))
4009 ;; Attribute a property name to KWD.
4010 (kwd-sym (and kwd
(intern (concat ":" (downcase kwd
))))))
4011 ;; Now set final shape for VALUE.
4013 (setq value
(org-element-parse-secondary-string value restrict
)))
4015 (setq value
(and (or value dual-value
) (cons value dual-value
))))
4016 (when (or (member kwd org-element-multiple-keywords
)
4017 ;; Attributes can always appear on multiple lines.
4018 (string-match "^ATTR_" kwd
))
4019 (setq value
(cons value
(plist-get output kwd-sym
))))
4020 ;; Eventually store the new value in OUTPUT.
4021 (setq output
(plist-put output kwd-sym value
))
4022 ;; Move to next keyword.
4024 ;; If affiliated keywords are orphaned: move back to first one.
4025 ;; They will be parsed as a paragraph.
4026 (when (looking-at "[ \t]*$") (goto-char origin
) (setq output nil
))
4028 (cons origin output
))))
4034 ;; The two major functions here are `org-element-parse-buffer', which
4035 ;; parses Org syntax inside the current buffer, taking into account
4036 ;; region, narrowing, or even visibility if specified, and
4037 ;; `org-element-parse-secondary-string', which parses objects within
4040 ;; The (almost) almighty `org-element-map' allows to apply a function
4041 ;; on elements or objects matching some type, and accumulate the
4042 ;; resulting values. In an export situation, it also skips unneeded
4043 ;; parts of the parse tree.
4045 (defun org-element-parse-buffer (&optional granularity visible-only
)
4046 "Recursively parse the buffer and return structure.
4047 If narrowing is in effect, only parse the visible part of the
4050 Optional argument GRANULARITY determines the depth of the
4051 recursion. It can be set to the following symbols:
4053 `headline' Only parse headlines.
4054 `greater-element' Don't recurse into greater elements excepted
4055 headlines and sections. Thus, elements
4056 parsed are the top-level ones.
4057 `element' Parse everything but objects and plain text.
4058 `object' Parse the complete buffer (default).
4060 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4063 An element or an objects is represented as a list with the
4064 pattern (TYPE PROPERTIES CONTENTS), where :
4066 TYPE is a symbol describing the element or object. See
4067 `org-element-all-elements' and `org-element-all-objects' for an
4068 exhaustive list of such symbols. One can retrieve it with
4069 `org-element-type' function.
4071 PROPERTIES is the list of attributes attached to the element or
4072 object, as a plist. Although most of them are specific to the
4073 element or object type, all types share `:begin', `:end',
4074 `:post-blank' and `:parent' properties, which respectively
4075 refer to buffer position where the element or object starts,
4076 ends, the number of white spaces or blank lines after it, and
4077 the element or object containing it. Properties values can be
4078 obtained by using `org-element-property' function.
4080 CONTENTS is a list of elements, objects or raw strings
4081 contained in the current element or object, when applicable.
4082 One can access them with `org-element-contents' function.
4084 The Org buffer has `org-data' as type and nil as properties.
4085 `org-element-map' function can be used to find specific elements
4086 or objects within the parse tree.
4088 This function assumes that current major mode is `org-mode'."
4090 (goto-char (point-min))
4091 (org-skip-whitespace)
4092 (org-element--parse-elements
4093 (point-at-bol) (point-max)
4094 ;; Start in `first-section' mode so text before the first
4095 ;; headline belongs to a section.
4096 'first-section nil granularity visible-only
(list 'org-data nil
))))
4098 (defun org-element-parse-secondary-string (string restriction
&optional parent
)
4099 "Recursively parse objects in STRING and return structure.
4101 RESTRICTION is a symbol limiting the object types that will be
4104 Optional argument PARENT, when non-nil, is the element or object
4105 containing the secondary string. It is used to set correctly
4106 `:parent' property within the string."
4107 ;; Copy buffer-local variables listed in
4108 ;; `org-element-object-variables' into temporary buffer. This is
4109 ;; required since object parsing is dependent on these variables.
4110 (let ((pairs (delq nil
(mapcar (lambda (var)
4112 (cons var
(symbol-value var
))))
4113 org-element-object-variables
))))
4115 (mapc (lambda (pair) (org-set-local (car pair
) (cdr pair
))) pairs
)
4117 (let ((secondary (org-element--parse-objects
4118 (point-min) (point-max) nil restriction
)))
4120 (mapc (lambda (obj) (org-element-put-property obj
:parent parent
))
4124 (defun org-element-map
4125 (data types fun
&optional info first-match no-recursion with-affiliated
)
4126 "Map a function on selected elements or objects.
4128 DATA is a parse tree, an element, an object, a string, or a list
4129 of such constructs. TYPES is a symbol or list of symbols of
4130 elements or objects types (see `org-element-all-elements' and
4131 `org-element-all-objects' for a complete list of types). FUN is
4132 the function called on the matching element or object. It has to
4133 accept one argument: the element or object itself.
4135 When optional argument INFO is non-nil, it should be a plist
4136 holding export options. In that case, parts of the parse tree
4137 not exportable according to that property list will be skipped.
4139 When optional argument FIRST-MATCH is non-nil, stop at the first
4140 match for which FUN doesn't return nil, and return that value.
4142 Optional argument NO-RECURSION is a symbol or a list of symbols
4143 representing elements or objects types. `org-element-map' won't
4144 enter any recursive element or object whose type belongs to that
4145 list. Though, FUN can still be applied on them.
4147 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4148 apply to matching objects within parsed affiliated keywords (see
4149 `org-element-parsed-keywords').
4151 Nil values returned from FUN do not appear in the results.
4157 Assuming TREE is a variable containing an Org buffer parse tree,
4158 the following example will return a flat list of all `src-block'
4159 and `example-block' elements in it:
4161 \(org-element-map tree '(example-block src-block) 'identity)
4163 The following snippet will find the first headline with a level
4164 of 1 and a \"phone\" tag, and will return its beginning position:
4166 \(org-element-map tree 'headline
4168 \(and (= (org-element-property :level hl) 1)
4169 \(member \"phone\" (org-element-property :tags hl))
4170 \(org-element-property :begin hl)))
4173 The next example will return a flat list of all `plain-list' type
4174 elements in TREE that are not a sub-list themselves:
4176 \(org-element-map tree 'plain-list 'identity nil nil 'plain-list)
4178 Eventually, this example will return a flat list of all `bold'
4179 type objects containing a `latex-snippet' type object, even
4180 looking into captions:
4182 \(org-element-map tree 'bold
4184 \(and (org-element-map b 'latex-snippet 'identity nil t) b))
4186 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4187 (unless (listp types
) (setq types
(list types
)))
4188 (unless (listp no-recursion
) (setq no-recursion
(list no-recursion
)))
4189 ;; Recursion depth is determined by --CATEGORY.
4192 (let ((category 'greater-elements
))
4193 (mapc (lambda (type)
4194 (cond ((or (memq type org-element-all-objects
)
4195 (eq type
'plain-text
))
4196 ;; If one object is found, the function
4197 ;; has to recurse into every object.
4198 (throw 'found
'objects
))
4199 ((not (memq type org-element-greater-elements
))
4200 ;; If one regular element is found, the
4201 ;; function has to recurse, at least,
4202 ;; into every element it encounters.
4203 (and (not (eq category
'elements
))
4204 (setq category
'elements
)))))
4207 ;; Compute properties for affiliated keywords if necessary.
4209 (and with-affiliated
4210 (mapcar (lambda (kwd)
4211 (cons kwd
(intern (concat ":" (downcase kwd
)))))
4212 org-element-affiliated-keywords
)))
4218 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4219 ;; holding contextual information.
4220 (let ((--type (org-element-type --data
)))
4223 ;; Ignored element in an export context.
4224 ((and info
(memq --data
(plist-get info
:ignore-list
))))
4225 ;; List of elements or objects.
4226 ((not --type
) (mapc --walk-tree --data
))
4227 ;; Unconditionally enter parse trees.
4228 ((eq --type
'org-data
)
4229 (mapc --walk-tree
(org-element-contents --data
)))
4231 ;; Check if TYPE is matching among TYPES. If so,
4232 ;; apply FUN to --DATA and accumulate return value
4233 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4234 (when (memq --type types
)
4235 (let ((result (funcall fun --data
)))
4236 (cond ((not result
))
4237 (first-match (throw '--map-first-match result
))
4238 (t (push result --acc
)))))
4239 ;; If --DATA has a secondary string that can contain
4240 ;; objects with their type among TYPES, look into it.
4241 (when (and (eq --category
'objects
) (not (stringp --data
)))
4243 (assq --type org-element-secondary-value-alist
)))
4245 (funcall --walk-tree
4246 (org-element-property (cdr sec-prop
) --data
)))))
4247 ;; If --DATA has any affiliated keywords and
4248 ;; WITH-AFFILIATED is non-nil, look for objects in
4250 (when (and with-affiliated
4251 (eq --category
'objects
)
4252 (memq --type org-element-all-elements
))
4253 (mapc (lambda (kwd-pair)
4254 (let ((kwd (car kwd-pair
))
4255 (value (org-element-property
4256 (cdr kwd-pair
) --data
)))
4257 ;; Pay attention to the type of value.
4258 ;; Preserve order for multiple keywords.
4261 ((and (member kwd org-element-multiple-keywords
)
4262 (member kwd org-element-dual-keywords
))
4263 (mapc (lambda (line)
4264 (funcall --walk-tree
(cdr line
))
4265 (funcall --walk-tree
(car line
)))
4267 ((member kwd org-element-multiple-keywords
)
4268 (mapc (lambda (line) (funcall --walk-tree line
))
4270 ((member kwd org-element-dual-keywords
)
4271 (funcall --walk-tree
(cdr value
))
4272 (funcall --walk-tree
(car value
)))
4273 (t (funcall --walk-tree value
)))))
4274 --affiliated-alist
))
4275 ;; Determine if a recursion into --DATA is possible.
4277 ;; --TYPE is explicitly removed from recursion.
4278 ((memq --type no-recursion
))
4279 ;; --DATA has no contents.
4280 ((not (org-element-contents --data
)))
4281 ;; Looking for greater elements but --DATA is simply
4282 ;; an element or an object.
4283 ((and (eq --category
'greater-elements
)
4284 (not (memq --type org-element-greater-elements
))))
4285 ;; Looking for elements but --DATA is an object.
4286 ((and (eq --category
'elements
)
4287 (memq --type org-element-all-objects
)))
4288 ;; In any other case, map contents.
4289 (t (mapc --walk-tree
(org-element-contents --data
)))))))))))
4290 (catch '--map-first-match
4291 (funcall --walk-tree data
)
4292 ;; Return value in a proper order.
4294 (put 'org-element-map
'lisp-indent-function
2)
4296 ;; The following functions are internal parts of the parser.
4298 ;; The first one, `org-element--parse-elements' acts at the element's
4301 ;; The second one, `org-element--parse-objects' applies on all objects
4302 ;; of a paragraph or a secondary string. It uses
4303 ;; `org-element--get-next-object-candidates' to optimize the search of
4304 ;; the next object in the buffer.
4306 ;; More precisely, that function looks for every allowed object type
4307 ;; first. Then, it discards failed searches, keeps further matches,
4308 ;; and searches again types matched behind point, for subsequent
4309 ;; calls. Thus, searching for a given type fails only once, and every
4310 ;; object is searched only once at top level (but sometimes more for
4313 (defun org-element--parse-elements
4314 (beg end special structure granularity visible-only acc
)
4315 "Parse elements between BEG and END positions.
4317 SPECIAL prioritize some elements over the others. It can be set
4318 to `first-section', `quote-section', `section' `item' or
4321 When value is `item', STRUCTURE will be used as the current list
4324 GRANULARITY determines the depth of the recursion. See
4325 `org-element-parse-buffer' for more information.
4327 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4330 Elements are accumulated into ACC."
4333 ;; Visible only: skip invisible parts at the beginning of the
4335 (when (and visible-only
(org-invisible-p2))
4336 (goto-char (min (1+ (org-find-visible)) end
)))
4337 ;; When parsing only headlines, skip any text before first one.
4338 (when (and (eq granularity
'headline
) (not (org-at-heading-p)))
4339 (org-with-limited-levels (outline-next-heading)))
4341 (while (< (point) end
)
4342 ;; Find current element's type and parse it accordingly to
4344 (let* ((element (org-element--current-element
4345 end granularity special structure
))
4346 (type (org-element-type element
))
4347 (cbeg (org-element-property :contents-begin element
)))
4348 (goto-char (org-element-property :end element
))
4349 ;; Visible only: skip invisible parts between siblings.
4350 (when (and visible-only
(org-invisible-p2))
4351 (goto-char (min (1+ (org-find-visible)) end
)))
4352 ;; Fill ELEMENT contents by side-effect.
4354 ;; If element has no contents, don't modify it.
4356 ;; Greater element: parse it between `contents-begin' and
4357 ;; `contents-end'. Make sure GRANULARITY allows the
4358 ;; recursion, or ELEMENT is a headline, in which case going
4359 ;; inside is mandatory, in order to get sub-level headings.
4360 ((and (memq type org-element-greater-elements
)
4361 (or (memq granularity
'(element object nil
))
4362 (and (eq granularity
'greater-element
)
4364 (eq type
'headline
)))
4365 (org-element--parse-elements
4366 cbeg
(org-element-property :contents-end element
)
4367 ;; Possibly switch to a special mode.
4370 (if (org-element-property :quotedp element
) 'quote-section
4373 (property-drawer 'node-property
)
4375 (and (memq type
'(item plain-list
))
4376 (org-element-property :structure element
))
4377 granularity visible-only element
))
4378 ;; ELEMENT has contents. Parse objects inside, if
4379 ;; GRANULARITY allows it.
4380 ((memq granularity
'(object nil
))
4381 (org-element--parse-objects
4382 cbeg
(org-element-property :contents-end element
) element
4383 (org-element-restriction type
))))
4384 (org-element-adopt-elements acc element
)))
4388 (defun org-element--parse-objects (beg end acc restriction
)
4389 "Parse objects between BEG and END and return recursive structure.
4391 Objects are accumulated in ACC.
4393 RESTRICTION is a list of object successors which are allowed in
4394 the current object."
4395 (let ((candidates 'initial
))
4398 (narrow-to-region beg end
)
4399 (goto-char (point-min))
4400 (while (and (not (eobp))
4402 (org-element--get-next-object-candidates
4403 restriction candidates
)))
4405 (let ((pos (apply 'min
(mapcar 'cdr candidates
))))
4408 (funcall (intern (format "org-element-%s-parser"
4409 (car (rassq pos candidates
)))))))))
4410 ;; 1. Text before any object. Untabify it.
4411 (let ((obj-beg (org-element-property :begin next-object
)))
4412 (unless (= (point) obj-beg
)
4414 (org-element-adopt-elements
4416 (replace-regexp-in-string
4417 "\t" (make-string tab-width ?
)
4418 (buffer-substring-no-properties (point) obj-beg
))))))
4420 (let ((obj-end (org-element-property :end next-object
))
4421 (cont-beg (org-element-property :contents-begin next-object
)))
4422 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
4423 ;; a recursive type.
4425 (memq (car next-object
) org-element-recursive-objects
))
4426 (org-element--parse-objects
4427 cont-beg
(org-element-property :contents-end next-object
)
4428 next-object
(org-element-restriction next-object
)))
4429 (setq acc
(org-element-adopt-elements acc next-object
))
4430 (goto-char obj-end
))))
4431 ;; 3. Text after last object. Untabify it.
4434 (org-element-adopt-elements
4436 (replace-regexp-in-string
4437 "\t" (make-string tab-width ?
)
4438 (buffer-substring-no-properties (point) end
)))))
4442 (defun org-element--get-next-object-candidates (restriction objects
)
4443 "Return an alist of candidates for the next object.
4445 RESTRICTION is a list of object types, as symbols. Only
4446 candidates with such types are looked after.
4448 OBJECTS is the previous candidates alist. If it is set to
4449 `initial', no search has been done before, and all symbols in
4450 RESTRICTION should be looked after.
4452 Return value is an alist whose CAR is the object type and CDR its
4453 beginning position."
4456 (if (eq objects
'initial
)
4457 ;; When searching for the first time, look for every successor
4458 ;; allowed in RESTRICTION.
4461 (funcall (intern (format "org-element-%s-successor" res
))))
4463 ;; Focus on objects returned during last search. Keep those
4464 ;; still after point. Search again objects before it.
4467 (if (>= (cdr obj
) (point)) obj
4468 (let* ((type (car obj
))
4469 (succ (or (cdr (assq type org-element-object-successor-alist
))
4472 (funcall (intern (format "org-element-%s-successor" succ
)))))))
4477 ;;; Towards A Bijective Process
4479 ;; The parse tree obtained with `org-element-parse-buffer' is really
4480 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4481 ;; interpreted and expanded into a string with canonical Org syntax.
4482 ;; Hence `org-element-interpret-data'.
4484 ;; The function relies internally on
4485 ;; `org-element--interpret-affiliated-keywords'.
4488 (defun org-element-interpret-data (data &optional parent
)
4489 "Interpret DATA as Org syntax.
4491 DATA is a parse tree, an element, an object or a secondary string
4494 Optional argument PARENT is used for recursive calls. It contains
4495 the element or object containing data, or nil.
4497 Return Org syntax as a string."
4498 (let* ((type (org-element-type data
))
4501 ;; Secondary string.
4504 (lambda (obj) (org-element-interpret-data obj parent
))
4506 ;; Full Org document.
4507 ((eq type
'org-data
)
4509 (lambda (obj) (org-element-interpret-data obj parent
))
4510 (org-element-contents data
) ""))
4511 ;; Plain text: remove `:parent' text property from output.
4512 ((stringp data
) (org-no-properties data
))
4513 ;; Element/Object without contents.
4514 ((not (org-element-contents data
))
4515 (funcall (intern (format "org-element-%s-interpreter" type
))
4517 ;; Element/Object with contents.
4519 (let* ((greaterp (memq type org-element-greater-elements
))
4520 (objectp (and (not greaterp
)
4521 (memq type org-element-recursive-objects
)))
4524 (lambda (obj) (org-element-interpret-data obj data
))
4525 (org-element-contents
4526 (if (or greaterp objectp
) data
4527 ;; Elements directly containing objects must
4528 ;; have their indentation normalized first.
4529 (org-element-normalize-contents
4531 ;; When normalizing first paragraph of an
4532 ;; item or a footnote-definition, ignore
4533 ;; first line's indentation.
4534 (and (eq type
'paragraph
)
4535 (equal data
(car (org-element-contents parent
)))
4536 (memq (org-element-type parent
)
4537 '(footnote-definition item
))))))
4539 (funcall (intern (format "org-element-%s-interpreter" type
))
4541 (if greaterp
(org-element-normalize-contents contents
)
4543 (if (memq type
'(org-data plain-text nil
)) results
4544 ;; Build white spaces. If no `:post-blank' property is
4545 ;; specified, assume its value is 0.
4546 (let ((post-blank (or (org-element-property :post-blank data
) 0)))
4547 (if (memq type org-element-all-objects
)
4548 (concat results
(make-string post-blank
32))
4550 (org-element--interpret-affiliated-keywords data
)
4551 (org-element-normalize-string results
)
4552 (make-string post-blank
10)))))))
4554 (defun org-element--interpret-affiliated-keywords (element)
4555 "Return ELEMENT's affiliated keywords as Org syntax.
4556 If there is no affiliated keyword, return the empty string."
4557 (let ((keyword-to-org
4561 (when (member key org-element-dual-keywords
)
4562 (setq dual
(cdr value
) value
(car value
)))
4565 (format "[%s]" (org-element-interpret-data dual
)))
4567 (if (member key org-element-parsed-keywords
)
4568 (org-element-interpret-data value
)
4573 (let ((value (org-element-property prop element
))
4574 (keyword (upcase (substring (symbol-name prop
) 1))))
4576 (if (or (member keyword org-element-multiple-keywords
)
4577 ;; All attribute keywords can have multiple lines.
4578 (string-match "^ATTR_" keyword
))
4579 (mapconcat (lambda (line) (funcall keyword-to-org keyword line
))
4582 (funcall keyword-to-org keyword value
)))))
4583 ;; List all ELEMENT's properties matching an attribute line or an
4584 ;; affiliated keyword, but ignore translated keywords since they
4585 ;; cannot belong to the property list.
4586 (loop for prop in
(nth 1 element
) by
'cddr
4587 when
(let ((keyword (upcase (substring (symbol-name prop
) 1))))
4588 (or (string-match "^ATTR_" keyword
)
4590 (member keyword org-element-affiliated-keywords
)
4592 org-element-keyword-translation-alist
)))))
4596 ;; Because interpretation of the parse tree must return the same
4597 ;; number of blank lines between elements and the same number of white
4598 ;; space after objects, some special care must be given to white
4601 ;; The first function, `org-element-normalize-string', ensures any
4602 ;; string different from the empty string will end with a single
4603 ;; newline character.
4605 ;; The second function, `org-element-normalize-contents', removes
4606 ;; global indentation from the contents of the current element.
4608 (defun org-element-normalize-string (s)
4609 "Ensure string S ends with a single newline character.
4611 If S isn't a string return it unchanged. If S is the empty
4612 string, return it. Otherwise, return a new string with a single
4613 newline character at its end."
4615 ((not (stringp s
)) s
)
4617 (t (and (string-match "\\(\n[ \t]*\\)*\\'" s
)
4618 (replace-match "\n" nil nil s
)))))
4620 (defun org-element-normalize-contents (element &optional ignore-first
)
4621 "Normalize plain text in ELEMENT's contents.
4623 ELEMENT must only contain plain text and objects.
4625 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4626 indentation to compute maximal common indentation.
4628 Return the normalized element that is element with global
4629 indentation removed from its contents. The function assumes that
4630 indentation is not done with TAB characters."
4631 (let* (ind-list ; for byte-compiler
4632 collect-inds
; for byte-compiler
4635 ;; Return list of indentations within BLOB. This is done by
4636 ;; walking recursively BLOB and updating IND-LIST along the
4637 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4638 ;; been seen yet. It is required as this string is the only
4639 ;; one whose indentation doesn't happen after a newline
4641 (lambda (blob first-flag
)
4644 (when (and first-flag
(stringp object
))
4645 (setq first-flag nil
)
4646 (string-match "\\`\\( *\\)" object
)
4647 (let ((len (length (match-string 1 object
))))
4648 ;; An indentation of zero means no string will be
4649 ;; modified. Quit the process.
4650 (if (zerop len
) (throw 'zero
(setq ind-list nil
))
4651 (push len ind-list
))))
4655 ;; Avoid matching blank or empty lines.
4656 (while (and (string-match "\n\\( *\\)\\(.\\)" object start
)
4657 (not (equal (match-string 2 object
) " ")))
4658 (setq start
(match-end 0))
4659 (push (length (match-string 1 object
)) ind-list
))))
4660 ((memq (org-element-type object
) org-element-recursive-objects
)
4661 (funcall collect-inds object first-flag
))))
4662 (org-element-contents blob
))))))
4663 ;; Collect indentation list in ELEMENT. Possibly remove first
4664 ;; value if IGNORE-FIRST is non-nil.
4665 (catch 'zero
(funcall collect-inds element
(not ignore-first
)))
4666 (if (not ind-list
) element
4667 ;; Build ELEMENT back, replacing each string with the same
4668 ;; string minus common indentation.
4669 (let* (build ; For byte compiler.
4672 (lambda (blob mci first-flag
)
4673 ;; Return BLOB with all its strings indentation
4674 ;; shortened from MCI white spaces. FIRST-FLAG is
4675 ;; non-nil when the first string hasn't been seen
4680 (when (and first-flag
(stringp object
))
4681 (setq first-flag nil
)
4683 (replace-regexp-in-string
4684 (format "\\` \\{%d\\}" mci
) "" object
)))
4687 (replace-regexp-in-string
4688 (format "\n \\{%d\\}" mci
) "\n" object
))
4689 ((memq (org-element-type object
)
4690 org-element-recursive-objects
)
4691 (funcall build object mci first-flag
))
4693 (org-element-contents blob
)))
4695 (funcall build element
(apply 'min ind-list
) (not ignore-first
))))))
4701 ;; The first move is to implement a way to obtain the smallest element
4702 ;; containing point. This is the job of `org-element-at-point'. It
4703 ;; basically jumps back to the beginning of section containing point
4704 ;; and moves, element after element, with
4705 ;; `org-element--current-element' until the container is found. Note:
4706 ;; When using `org-element-at-point', secondary values are never
4707 ;; parsed since the function focuses on elements, not on objects.
4709 ;; At a deeper level, `org-element-context' lists all elements and
4710 ;; objects containing point.
4712 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4713 ;; internally by navigation and manipulation tools.
4716 (defun org-element-at-point (&optional keep-trail
)
4717 "Determine closest element around point.
4719 Return value is a list like (TYPE PROPS) where TYPE is the type
4720 of the element and PROPS a plist of properties associated to the
4723 Possible types are defined in `org-element-all-elements'.
4724 Properties depend on element or object type, but always include
4725 `:begin', `:end', `:parent' and `:post-blank' properties.
4727 As a special case, if point is at the very beginning of a list or
4728 sub-list, returned element will be that list instead of the first
4729 item. In the same way, if point is at the beginning of the first
4730 row of a table, returned element will be the table instead of the
4733 If optional argument KEEP-TRAIL is non-nil, the function returns
4734 a list of elements leading to element at point. The list's CAR
4735 is always the element at point. The following positions contain
4736 element's siblings, then parents, siblings of parents, until the
4737 first element of current section."
4738 (org-with-wide-buffer
4739 ;; If at a headline, parse it. It is the sole element that
4740 ;; doesn't require to know about context. Be sure to disallow
4741 ;; secondary string parsing, though.
4742 (if (org-with-limited-levels (org-at-heading-p))
4745 (if (not keep-trail
) (org-element-headline-parser (point-max) t
)
4746 (list (org-element-headline-parser (point-max) t
))))
4747 ;; Otherwise move at the beginning of the section containing
4750 (let ((origin (point))
4751 (end (save-excursion
4752 (org-with-limited-levels (outline-next-heading)) (point)))
4753 element type special-flag trail struct prevs parent
)
4754 (org-with-limited-levels
4755 (if (org-before-first-heading-p)
4756 ;; In empty lines at buffer's beginning, return nil.
4757 (progn (goto-char (point-min))
4758 (org-skip-whitespace)
4759 (when (or (eobp) (> (line-beginning-position) origin
))
4761 (org-back-to-heading)
4763 (org-skip-whitespace)
4764 (when (or (eobp) (> (line-beginning-position) origin
))
4765 ;; In blank lines just after the headline, point still
4766 ;; belongs to the headline.
4768 (progn (skip-chars-backward " \r\t\n")
4770 (if (not keep-trail
)
4771 (org-element-headline-parser (point-max) t
)
4772 (list (org-element-headline-parser
4773 (point-max) t
))))))))
4775 ;; Parse successively each element, skipping those ending
4776 ;; before original position.
4779 (org-element--current-element end
'element special-flag struct
)
4781 (org-element-put-property element
:parent parent
)
4782 (when keep-trail
(push element trail
))
4784 ;; 1. Skip any element ending before point. Also skip
4785 ;; element ending at point when we're sure that another
4786 ;; element has started.
4787 ((let ((elem-end (org-element-property :end element
)))
4788 (when (or (< elem-end origin
)
4789 (and (= elem-end origin
) (/= elem-end end
)))
4790 (goto-char elem-end
))))
4791 ;; 2. An element containing point is always the element at
4793 ((not (memq type org-element-greater-elements
))
4794 (throw 'exit
(if keep-trail trail element
)))
4795 ;; 3. At any other greater element type, if point is
4796 ;; within contents, move into it.
4798 (let ((cbeg (org-element-property :contents-begin element
))
4799 (cend (org-element-property :contents-end element
)))
4800 (if (or (not cbeg
) (not cend
) (> cbeg origin
) (< cend origin
)
4801 ;; Create an anchor for tables and plain lists:
4802 ;; when point is at the very beginning of these
4803 ;; elements, ignoring affiliated keywords,
4804 ;; target them instead of their contents.
4805 (and (= cbeg origin
) (memq type
'(plain-list table
)))
4806 ;; When point is at contents end, do not move
4807 ;; into elements with an explicit ending, but
4808 ;; return that element instead.
4809 (and (= cend origin
)
4812 drawer dynamic-block inlinetask
4813 property-drawer quote-block
4815 ;; Corner case: if a list ends at the
4816 ;; end of a buffer without a final new
4817 ;; line, return last element in last
4819 (and (memq type
'(item plain-list
))
4820 (progn (goto-char cend
)
4821 (or (bolp) (not (eobp))))))))
4822 (throw 'exit
(if keep-trail trail element
))
4823 (setq parent element
)
4826 (setq special-flag
'item
4827 struct
(org-element-property :structure element
)))
4828 (item (setq special-flag nil
))
4830 (setq special-flag
'node-property struct nil
))
4831 (table (setq special-flag
'table-row struct nil
))
4832 (otherwise (setq special-flag nil struct nil
)))
4834 (goto-char cbeg
)))))))))))
4837 (defun org-element-context (&optional element
)
4838 "Return closest element or object around point.
4840 Return value is a list like (TYPE PROPS) where TYPE is the type
4841 of the element or object and PROPS a plist of properties
4844 Possible types are defined in `org-element-all-elements' and
4845 `org-element-all-objects'. Properties depend on element or
4846 object type, but always include `:begin', `:end', `:parent' and
4849 Optional argument ELEMENT, when non-nil, is the closest element
4850 containing point, as returned by `org-element-at-point'.
4851 Providing it allows for quicker computation."
4852 (catch 'objects-forbidden
4853 (org-with-wide-buffer
4854 (let* ((origin (point))
4855 (element (or element
(org-element-at-point)))
4856 (type (org-element-type element
))
4858 ;; Check if point is inside an element containing objects or at
4859 ;; a secondary string. In that case, narrow buffer to the
4860 ;; containing area. Otherwise, return ELEMENT.
4862 ;; At a parsed affiliated keyword, check if we're inside main
4864 ((let ((post (org-element-property :post-affiliated element
)))
4865 (and post
(< origin post
)))
4867 (looking-at org-element--affiliated-re
)
4869 ((not (member (upcase (match-string 1)) org-element-parsed-keywords
))
4870 (throw 'objects-forbidden element
))
4871 ((< (match-end 0) origin
)
4872 (narrow-to-region (match-end 0) (line-end-position)))
4873 ((and (match-beginning 2)
4874 (>= origin
(match-beginning 2))
4875 (< origin
(match-end 2)))
4876 (narrow-to-region (match-beginning 2) (match-end 2)))
4877 (t (throw 'objects-forbidden element
)))
4878 ;; Also change type to retrieve correct restrictions.
4879 (setq type
'keyword
))
4880 ;; At an item, objects can only be located within tag, if any.
4882 (let ((tag (org-element-property :tag element
)))
4883 (if (not tag
) (throw 'objects-forbidden element
)
4885 (search-forward tag
(line-end-position))
4886 (goto-char (match-beginning 0))
4887 (if (and (>= origin
(point)) (< origin
(match-end 0)))
4888 (narrow-to-region (point) (match-end 0))
4889 (throw 'objects-forbidden element
)))))
4890 ;; At an headline or inlinetask, objects are located within
4892 ((memq type
'(headline inlinetask
))
4893 (goto-char (org-element-property :begin element
))
4894 (skip-chars-forward "* ")
4895 (if (and (>= origin
(point)) (< origin
(line-end-position)))
4896 (narrow-to-region (point) (line-end-position))
4897 (throw 'objects-forbidden element
)))
4898 ;; At a paragraph, a table-row or a verse block, objects are
4899 ;; located within their contents.
4900 ((memq type
'(paragraph table-row verse-block
))
4901 (let ((cbeg (org-element-property :contents-begin element
))
4902 (cend (org-element-property :contents-end element
)))
4903 ;; CBEG is nil for table rules.
4904 (if (and cbeg cend
(>= origin cbeg
) (< origin cend
))
4905 (narrow-to-region cbeg cend
)
4906 (throw 'objects-forbidden element
))))
4907 ;; At a parsed keyword, objects are located within value.
4909 (if (not (member (org-element-property :key element
)
4910 org-element-document-properties
))
4911 (throw 'objects-forbidden element
)
4913 (search-forward ":")
4914 (if (and (>= origin
(point)) (< origin
(line-end-position)))
4915 (narrow-to-region (point) (line-end-position))
4916 (throw 'objects-forbidden element
))))
4917 (t (throw 'objects-forbidden element
)))
4918 (goto-char (point-min))
4919 (let ((restriction (org-element-restriction type
))
4921 (candidates 'initial
))
4923 (while (setq candidates
4924 (org-element--get-next-object-candidates
4925 restriction candidates
))
4926 (let ((closest-cand (rassq (apply 'min
(mapcar 'cdr candidates
))
4928 ;; If ORIGIN is before next object in element, there's
4929 ;; no point in looking further.
4930 (if (> (cdr closest-cand
) origin
) (throw 'exit parent
)
4932 (progn (goto-char (cdr closest-cand
))
4933 (funcall (intern (format "org-element-%s-parser"
4934 (car closest-cand
))))))
4935 (cbeg (org-element-property :contents-begin object
))
4936 (cend (org-element-property :contents-end object
))
4937 (obj-end (org-element-property :end object
)))
4939 ;; ORIGIN is after OBJECT, so skip it.
4940 ((<= obj-end origin
) (goto-char obj-end
))
4941 ;; ORIGIN is within a non-recursive object or at
4942 ;; an object boundaries: Return that object.
4943 ((or (not cbeg
) (< origin cbeg
) (>= origin cend
))
4945 (org-element-put-property object
:parent parent
)))
4946 ;; Otherwise, move within current object and
4947 ;; restrict search to the end of its contents.
4949 (narrow-to-region (point) cend
)
4950 (org-element-put-property object
:parent parent
)
4952 restriction
(org-element-restriction object
)
4953 candidates
'initial
)))))))
4956 (defun org-element-nested-p (elem-A elem-B
)
4957 "Non-nil when elements ELEM-A and ELEM-B are nested."
4958 (let ((beg-A (org-element-property :begin elem-A
))
4959 (beg-B (org-element-property :begin elem-B
))
4960 (end-A (org-element-property :end elem-A
))
4961 (end-B (org-element-property :end elem-B
)))
4962 (or (and (>= beg-A beg-B
) (<= end-A end-B
))
4963 (and (>= beg-B beg-A
) (<= end-B end-A
)))))
4965 (defun org-element-swap-A-B (elem-A elem-B
)
4966 "Swap elements ELEM-A and ELEM-B.
4967 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4969 (goto-char (org-element-property :begin elem-A
))
4970 ;; There are two special cases when an element doesn't start at bol:
4971 ;; the first paragraph in an item or in a footnote definition.
4972 (let ((specialp (not (bolp))))
4973 ;; Only a paragraph without any affiliated keyword can be moved at
4974 ;; ELEM-A position in such a situation. Note that the case of
4975 ;; a footnote definition is impossible: it cannot contain two
4976 ;; paragraphs in a row because it cannot contain a blank line.
4978 (or (not (eq (org-element-type elem-B
) 'paragraph
))
4979 (/= (org-element-property :begin elem-B
)
4980 (org-element-property :contents-begin elem-B
))))
4981 (error "Cannot swap elements"))
4982 ;; In a special situation, ELEM-A will have no indentation. We'll
4983 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4984 (let* ((ind-B (when specialp
4985 (goto-char (org-element-property :begin elem-B
))
4986 (org-get-indentation)))
4987 (beg-A (org-element-property :begin elem-A
))
4988 (end-A (save-excursion
4989 (goto-char (org-element-property :end elem-A
))
4990 (skip-chars-backward " \r\t\n")
4992 (beg-B (org-element-property :begin elem-B
))
4993 (end-B (save-excursion
4994 (goto-char (org-element-property :end elem-B
))
4995 (skip-chars-backward " \r\t\n")
4997 ;; Store overlays responsible for visibility status. We
4998 ;; also need to store their boundaries as they will be
4999 ;; removed from buffer.
5002 (mapcar (lambda (ov) (list ov
(overlay-start ov
) (overlay-end ov
)))
5003 (overlays-in beg-A end-A
))
5004 (mapcar (lambda (ov) (list ov
(overlay-start ov
) (overlay-end ov
)))
5005 (overlays-in beg-B end-B
))))
5007 (body-A (buffer-substring beg-A end-A
))
5008 (body-B (delete-and-extract-region beg-B end-B
)))
5011 (setq body-B
(replace-regexp-in-string "\\`[ \t]*" "" body-B
))
5012 (org-indent-to-column ind-B
))
5014 ;; Restore ex ELEM-A overlays.
5015 (let ((offset (- beg-B beg-A
)))
5018 (car ov
) (+ (nth 1 ov
) offset
) (+ (nth 2 ov
) offset
)))
5021 (delete-region beg-A end-A
)
5023 ;; Restore ex ELEM-B overlays.
5026 (car ov
) (- (nth 1 ov
) offset
) (- (nth 2 ov
) offset
)))
5028 (goto-char (org-element-property :end elem-B
)))))
5030 (provide 'org-element
)
5033 ;; generated-autoload-file: "org-loaddefs.el"
5036 ;;; org-element.el ends here