Merge branch 'maint'
[org-mode.git] / lisp / org-element.el
blob67fda5cce09ad8f10f6980c9f6aee2e5ce67be28
1 ;;; org-element.el --- Parser And Applications for Org syntax
3 ;; Copyright (C) 2012 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This program is free software; you can redistribute it and/or modify
9 ;; it under the terms of the GNU General Public License as published by
10 ;; the Free Software Foundation, either version 3 of the License, or
11 ;; (at your option) any later version.
13 ;; This program is distributed in the hope that it will be useful,
14 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
15 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 ;; GNU General Public License for more details.
18 ;; This file is not part of GNU Emacs.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
23 ;;; Commentary:
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 (namely `babel-call', `clock', `headline', `item',
34 ;; `keyword', `planning', `property-drawer' and `section' types), it
35 ;; can also accept a fixed set of keywords as attributes. Those are
36 ;; called "affiliated keywords" to distinguish them from other
37 ;; keywords, which are full-fledged elements. Almost all affiliated
38 ;; keywords are referenced in `org-element-affiliated-keywords'; the
39 ;; others are export attributes and start with "ATTR_" prefix.
41 ;; Element containing other elements (and only elements) are called
42 ;; greater elements. Concerned types are: `center-block', `drawer',
43 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
44 ;; `item', `plain-list', `quote-block', `section' and `special-block'.
46 ;; Other element types are: `babel-call', `clock', `comment',
47 ;; `comment-block', `example-block', `export-block', `fixed-width',
48 ;; `horizontal-rule', `keyword', `latex-environment', `paragraph',
49 ;; `planning', `property-drawer', `quote-section', `src-block',
50 ;; `table', `table-row' and `verse-block'. Among them, `paragraph'
51 ;; and `verse-block' types can contain Org objects and plain text.
53 ;; Objects are related to document's contents. Some of them are
54 ;; recursive. Associated types are of the following: `bold', `code',
55 ;; `entity', `export-snippet', `footnote-reference',
56 ;; `inline-babel-call', `inline-src-block', `italic',
57 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
58 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
59 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
61 ;; Some elements also have special properties whose value can hold
62 ;; objects themselves (i.e. an item tag or an headline name). Such
63 ;; values are called "secondary strings". Any object belongs to
64 ;; either an element or a secondary string.
66 ;; Notwithstanding affiliated keywords, each greater element, element
67 ;; and object has a fixed set of properties attached to it. Among
68 ;; them, four are shared by all types: `:begin' and `:end', which
69 ;; refer to the beginning and ending buffer positions of the
70 ;; considered element or object, `:post-blank', which holds the number
71 ;; of blank lines, or white spaces, at its end and `:parent' which
72 ;; refers to the element or object containing it. Greater elements
73 ;; and elements containing objects will also have `:contents-begin'
74 ;; and `:contents-end' properties to delimit contents.
76 ;; Lisp-wise, an element or an object can be represented as a list.
77 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
78 ;; TYPE is a symbol describing the Org element or object.
79 ;; PROPERTIES is the property list attached to it. See docstring of
80 ;; appropriate parsing function to get an exhaustive
81 ;; list.
82 ;; CONTENTS is a list of elements, objects or raw strings contained
83 ;; in the current element or object, when applicable.
85 ;; An Org buffer is a nested list of such elements and objects, whose
86 ;; type is `org-data' and properties is nil.
88 ;; The first part of this file defines Org syntax, while the second
89 ;; one provide accessors and setters functions.
91 ;; The next part implements a parser and an interpreter for each
92 ;; element and object type in Org syntax.
94 ;; The following part creates a fully recursive buffer parser. It
95 ;; also provides a tool to map a function to elements or objects
96 ;; matching some criteria in the parse tree. Functions of interest
97 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
98 ;; extent, `org-element-parse-secondary-string'.
100 ;; The penultimate part is the cradle of an interpreter for the
101 ;; obtained parse tree: `org-element-interpret-data'.
103 ;; The library ends by furnishing `org-element-at-point' function, and
104 ;; a way to give information about document structure around point
105 ;; with `org-element-context'.
108 ;;; Code:
110 (eval-when-compile
111 (require 'cl))
113 (require 'org)
116 ;;; Definitions And Rules
118 ;; Define elements, greater elements and specify recursive objects,
119 ;; along with the affiliated keywords recognized. Also set up
120 ;; restrictions on recursive objects combinations.
122 ;; These variables really act as a control center for the parsing
123 ;; process.
125 (defconst org-element-paragraph-separate
126 (concat "^\\(?:"
127 ;; Headlines, inlinetasks.
128 org-outline-regexp "\\|"
129 ;; Footnote definitions.
130 "\\[\\(?:[0-9]+\\|fn:[-_[:word:]]+\\)\\]" "\\|"
131 "[ \t]*\\(?:"
132 ;; Empty lines.
133 "$" "\\|"
134 ;; Tables (any type).
135 "\\(?:|\\|\\+-[-+]\\)" "\\|"
136 ;; Blocks (any type), Babel calls, drawers (any type),
137 ;; fixed-width areas and keywords. Note: this is only an
138 ;; indication and need some thorough check.
139 "[#:]" "\\|"
140 ;; Horizontal rules.
141 "-\\{5,\\}[ \t]*$" "\\|"
142 ;; LaTeX environments.
143 "\\\\begin{\\([A-Za-z0-9]+\\*?\\)}" "\\|"
144 ;; Planning and Clock lines.
145 (regexp-opt (list org-scheduled-string
146 org-deadline-string
147 org-closed-string
148 org-clock-string))
149 "\\|"
150 ;; Lists.
151 (let ((term (case org-plain-list-ordered-item-terminator
152 (?\) ")") (?. "\\.") (otherwise "[.)]")))
153 (alpha (and org-alphabetical-lists "\\|[A-Za-z]")))
154 (concat "\\(?:[-+*]\\|\\(?:[0-9]+" alpha "\\)" term "\\)"
155 "\\(?:[ \t]\\|$\\)"))
156 "\\)\\)")
157 "Regexp to separate paragraphs in an Org buffer.
158 In the case of lines starting with \"#\" and \":\", this regexp
159 is not sufficient to know if point is at a paragraph ending. See
160 `org-element-paragraph-parser' for more information.")
162 (defconst org-element-all-elements
163 '(center-block clock comment comment-block drawer dynamic-block example-block
164 export-block fixed-width footnote-definition headline
165 horizontal-rule inlinetask item keyword latex-environment
166 babel-call paragraph plain-list planning property-drawer
167 quote-block quote-section section special-block src-block table
168 table-row verse-block)
169 "Complete list of element types.")
171 (defconst org-element-greater-elements
172 '(center-block drawer dynamic-block footnote-definition headline inlinetask
173 item plain-list quote-block section special-block table)
174 "List of recursive element types aka Greater Elements.")
176 (defconst org-element-all-successors
177 '(export-snippet footnote-reference inline-babel-call inline-src-block
178 latex-or-entity line-break link macro radio-target
179 statistics-cookie sub/superscript table-cell target
180 text-markup timestamp)
181 "Complete list of successors.")
183 (defconst org-element-object-successor-alist
184 '((subscript . sub/superscript) (superscript . sub/superscript)
185 (bold . text-markup) (code . text-markup) (italic . text-markup)
186 (strike-through . text-markup) (underline . text-markup)
187 (verbatim . text-markup) (entity . latex-or-entity)
188 (latex-fragment . latex-or-entity))
189 "Alist of translations between object type and successor name.
191 Sharing the same successor comes handy when, for example, the
192 regexp matching one object can also match the other object.")
194 (defconst org-element-all-objects
195 '(bold code entity export-snippet footnote-reference inline-babel-call
196 inline-src-block italic line-break latex-fragment link macro
197 radio-target statistics-cookie strike-through subscript superscript
198 table-cell target timestamp underline verbatim)
199 "Complete list of object types.")
201 (defconst org-element-recursive-objects
202 '(bold italic link subscript radio-target strike-through superscript
203 table-cell underline)
204 "List of recursive object types.")
206 (defconst org-element-block-name-alist
207 '(("CENTER" . org-element-center-block-parser)
208 ("COMMENT" . org-element-comment-block-parser)
209 ("EXAMPLE" . org-element-example-block-parser)
210 ("QUOTE" . org-element-quote-block-parser)
211 ("SRC" . org-element-src-block-parser)
212 ("VERSE" . org-element-verse-block-parser))
213 "Alist between block names and the associated parsing function.
214 Names must be uppercase. Any block whose name has no association
215 is parsed with `org-element-special-block-parser'.")
217 (defconst org-element-link-type-is-file
218 '("file" "file+emacs" "file+sys" "docview")
219 "List of link types equivalent to \"file\".
220 Only these types can accept search options and an explicit
221 application to open them.")
223 (defconst org-element-affiliated-keywords
224 '("CAPTION" "DATA" "HEADER" "HEADERS" "LABEL" "NAME" "PLOT" "RESNAME" "RESULT"
225 "RESULTS" "SOURCE" "SRCNAME" "TBLNAME")
226 "List of affiliated keywords as strings.
227 By default, all keywords setting attributes (i.e. \"ATTR_LATEX\")
228 are affiliated keywords and need not to be in this list.")
230 (defconst org-element--affiliated-re
231 (format "[ \t]*#\\+%s:"
232 ;; Regular affiliated keywords.
233 (format "\\(%s\\|ATTR_[-_A-Za-z0-9]+\\)\\(?:\\[\\(.*\\)\\]\\)?"
234 (regexp-opt org-element-affiliated-keywords)))
235 "Regexp matching any affiliated keyword.
237 Keyword name is put in match group 1. Moreover, if keyword
238 belongs to `org-element-dual-keywords', put the dual value in
239 match group 2.
241 Don't modify it, set `org-element-affiliated-keywords' instead.")
243 (defconst org-element-keyword-translation-alist
244 '(("DATA" . "NAME") ("LABEL" . "NAME") ("RESNAME" . "NAME")
245 ("SOURCE" . "NAME") ("SRCNAME" . "NAME") ("TBLNAME" . "NAME")
246 ("RESULT" . "RESULTS") ("HEADERS" . "HEADER"))
247 "Alist of usual translations for keywords.
248 The key is the old name and the value the new one. The property
249 holding their value will be named after the translated name.")
251 (defconst org-element-multiple-keywords '("CAPTION" "HEADER")
252 "List of affiliated keywords that can occur more than once in an element.
254 Their value will be consed into a list of strings, which will be
255 returned as the value of the property.
257 This list is checked after translations have been applied. See
258 `org-element-keyword-translation-alist'.
260 By default, all keywords setting attributes (i.e. \"ATTR_LATEX\")
261 allow multiple occurrences and need not to be in this list.")
263 (defconst org-element-parsed-keywords '("AUTHOR" "CAPTION" "DATE" "TITLE")
264 "List of keywords whose value can be parsed.
266 Their value will be stored as a secondary string: a list of
267 strings and objects.
269 This list is checked after translations have been applied. See
270 `org-element-keyword-translation-alist'.")
272 (defconst org-element-dual-keywords '("CAPTION" "RESULTS")
273 "List of keywords which can have a secondary value.
275 In Org syntax, they can be written with optional square brackets
276 before the colons. For example, results keyword can be
277 associated to a hash value with the following:
279 #+RESULTS[hash-string]: some-source
281 This list is checked after translations have been applied. See
282 `org-element-keyword-translation-alist'.")
284 (defconst org-element-object-restrictions
285 '((bold export-snippet inline-babel-call inline-src-block latex-or-entity link
286 radio-target sub/superscript target text-markup timestamp)
287 (footnote-reference export-snippet footnote-reference inline-babel-call
288 inline-src-block latex-or-entity line-break link macro
289 radio-target sub/superscript target text-markup
290 timestamp)
291 (headline inline-babel-call inline-src-block latex-or-entity link macro
292 radio-target statistics-cookie sub/superscript target text-markup
293 timestamp)
294 (inlinetask inline-babel-call inline-src-block latex-or-entity link macro
295 radio-target sub/superscript target text-markup timestamp)
296 (italic export-snippet inline-babel-call inline-src-block latex-or-entity
297 link radio-target sub/superscript target text-markup timestamp)
298 (item export-snippet footnote-reference inline-babel-call latex-or-entity
299 link macro radio-target sub/superscript target text-markup)
300 (keyword latex-or-entity macro sub/superscript text-markup)
301 (link export-snippet inline-babel-call inline-src-block latex-or-entity link
302 sub/superscript text-markup)
303 (paragraph export-snippet footnote-reference inline-babel-call
304 inline-src-block latex-or-entity line-break link macro
305 radio-target statistics-cookie sub/superscript target text-markup
306 timestamp)
307 (radio-target export-snippet latex-or-entity sub/superscript)
308 (strike-through export-snippet inline-babel-call inline-src-block
309 latex-or-entity link radio-target sub/superscript target
310 text-markup timestamp)
311 (subscript export-snippet inline-babel-call inline-src-block latex-or-entity
312 sub/superscript target text-markup)
313 (superscript export-snippet inline-babel-call inline-src-block
314 latex-or-entity sub/superscript target text-markup)
315 (table-cell export-snippet latex-or-entity link macro radio-target
316 sub/superscript target text-markup timestamp)
317 (table-row table-cell)
318 (underline export-snippet inline-babel-call inline-src-block latex-or-entity
319 link radio-target sub/superscript target text-markup timestamp)
320 (verse-block footnote-reference inline-babel-call inline-src-block
321 latex-or-entity line-break link macro radio-target
322 sub/superscript target text-markup timestamp))
323 "Alist of objects restrictions.
325 CAR is an element or object type containing objects and CDR is
326 a list of successors that will be called within an element or
327 object of such type.
329 For example, in a `radio-target' object, one can only find
330 entities, export snippets, latex-fragments, subscript and
331 superscript.
333 This alist also applies to secondary string. For example, an
334 `headline' type element doesn't directly contain objects, but
335 still has an entry since one of its properties (`:title') does.")
337 (defconst org-element-secondary-value-alist
338 '((headline . :title)
339 (inlinetask . :title)
340 (item . :tag)
341 (footnote-reference . :inline-definition))
342 "Alist between element types and location of secondary value.")
346 ;;; Accessors and Setters
348 ;; Provide four accessors: `org-element-type', `org-element-property'
349 ;; `org-element-contents' and `org-element-restriction'.
351 ;; Setter functions allow to modify elements by side effect. There is
352 ;; `org-element-put-property', `org-element-set-contents',
353 ;; `org-element-set-element' and `org-element-adopt-element'. Note
354 ;; that `org-element-set-element' and `org-element-adopt-elements' are
355 ;; higher level functions since also update `:parent' property.
357 (defsubst org-element-type (element)
358 "Return type of ELEMENT.
360 The function returns the type of the element or object provided.
361 It can also return the following special value:
362 `plain-text' for a string
363 `org-data' for a complete document
364 nil in any other case."
365 (cond
366 ((not (consp element)) (and (stringp element) 'plain-text))
367 ((symbolp (car element)) (car element))))
369 (defsubst org-element-property (property element)
370 "Extract the value from the PROPERTY of an ELEMENT."
371 (plist-get (nth 1 element) property))
373 (defsubst org-element-contents (element)
374 "Extract contents from an ELEMENT."
375 (and (consp element) (nthcdr 2 element)))
377 (defsubst org-element-restriction (element)
378 "Return restriction associated to ELEMENT.
379 ELEMENT can be an element, an object or a symbol representing an
380 element or object type."
381 (cdr (assq (if (symbolp element) element (org-element-type element))
382 org-element-object-restrictions)))
384 (defsubst org-element-put-property (element property value)
385 "In ELEMENT set PROPERTY to VALUE.
386 Return modified element."
387 (when (consp element)
388 (setcar (cdr element) (plist-put (nth 1 element) property value)))
389 element)
391 (defsubst org-element-set-contents (element &rest contents)
392 "Set ELEMENT contents to CONTENTS.
393 Return modified element."
394 (cond ((not element) (list contents))
395 ((cdr element) (setcdr (cdr element) contents))
396 (t (nconc element contents))))
398 (defsubst org-element-set-element (old new)
399 "Replace element or object OLD with element or object NEW.
400 The function takes care of setting `:parent' property for NEW."
401 ;; Since OLD is going to be changed into NEW by side-effect, first
402 ;; make sure that every element or object within NEW has OLD as
403 ;; parent.
404 (mapc (lambda (blob) (org-element-put-property blob :parent old))
405 (org-element-contents new))
406 ;; Transfer contents.
407 (apply 'org-element-set-contents old (org-element-contents new))
408 ;; Ensure NEW has same parent as OLD, then overwrite OLD properties
409 ;; with NEW's.
410 (org-element-put-property new :parent (org-element-property :parent old))
411 (setcar (cdr old) (nth 1 new))
412 ;; Transfer type.
413 (setcar old (car new)))
415 (defsubst org-element-adopt-elements (parent &rest children)
416 "Append elements to the contents of another element.
418 PARENT is an element or object. CHILDREN can be elements,
419 objects, or a strings.
421 The function takes care of setting `:parent' property for CHILD.
422 Return parent element."
423 (if (not parent) children
424 ;; Link every child to PARENT.
425 (mapc (lambda (child)
426 (unless (stringp child)
427 (org-element-put-property child :parent parent)))
428 children)
429 ;; Add CHILDREN at the end of PARENT contents.
430 (apply 'org-element-set-contents
431 parent
432 (nconc (org-element-contents parent) children))
433 ;; Return modified PARENT element.
434 parent))
438 ;;; Greater elements
440 ;; For each greater element type, we define a parser and an
441 ;; interpreter.
443 ;; A parser returns the element or object as the list described above.
444 ;; Most of them accepts no argument. Though, exceptions exist. Hence
445 ;; every element containing a secondary string (see
446 ;; `org-element-secondary-value-alist') will accept an optional
447 ;; argument to toggle parsing of that secondary string. Moreover,
448 ;; `item' parser requires current list's structure as its first
449 ;; element.
451 ;; An interpreter accepts two arguments: the list representation of
452 ;; the element or object, and its contents. The latter may be nil,
453 ;; depending on the element or object considered. It returns the
454 ;; appropriate Org syntax, as a string.
456 ;; Parsing functions must follow the naming convention:
457 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
458 ;; defined in `org-element-greater-elements'.
460 ;; Similarly, interpreting functions must follow the naming
461 ;; convention: org-element-TYPE-interpreter.
463 ;; With the exception of `headline' and `item' types, greater elements
464 ;; cannot contain other greater elements of their own type.
466 ;; Beside implementing a parser and an interpreter, adding a new
467 ;; greater element requires to tweak `org-element--current-element'.
468 ;; Moreover, the newly defined type must be added to both
469 ;; `org-element-all-elements' and `org-element-greater-elements'.
472 ;;;; Center Block
474 (defun org-element-center-block-parser (limit)
475 "Parse a center block.
477 LIMIT bounds the search.
479 Return a list whose CAR is `center-block' and CDR is a plist
480 containing `:begin', `:end', `:hiddenp', `:contents-begin',
481 `:contents-end' and `:post-blank' keywords.
483 Assume point is at the beginning of the block."
484 (let ((case-fold-search t))
485 (if (not (save-excursion
486 (re-search-forward "^[ \t]*#\\+END_CENTER" limit t)))
487 ;; Incomplete block: parse it as a paragraph.
488 (org-element-paragraph-parser limit)
489 (let ((block-end-line (match-beginning 0)))
490 (let* ((keywords (org-element--collect-affiliated-keywords))
491 (begin (car keywords))
492 ;; Empty blocks have no contents.
493 (contents-begin (progn (forward-line)
494 (and (< (point) block-end-line)
495 (point))))
496 (contents-end (and contents-begin block-end-line))
497 (hidden (org-invisible-p2))
498 (pos-before-blank (progn (goto-char block-end-line)
499 (forward-line)
500 (point)))
501 (end (save-excursion (skip-chars-forward " \r\t\n" limit)
502 (if (eobp) (point) (point-at-bol)))))
503 (list 'center-block
504 (nconc
505 (list :begin begin
506 :end end
507 :hiddenp hidden
508 :contents-begin contents-begin
509 :contents-end contents-end
510 :post-blank (count-lines pos-before-blank end))
511 (cadr keywords))))))))
513 (defun org-element-center-block-interpreter (center-block contents)
514 "Interpret CENTER-BLOCK element as Org syntax.
515 CONTENTS is the contents of the element."
516 (format "#+BEGIN_CENTER\n%s#+END_CENTER" contents))
519 ;;;; Drawer
521 (defun org-element-drawer-parser (limit)
522 "Parse a drawer.
524 LIMIT bounds the search.
526 Return a list whose CAR is `drawer' and CDR is a plist containing
527 `:drawer-name', `:begin', `:end', `:hiddenp', `:contents-begin',
528 `:contents-end' and `:post-blank' keywords.
530 Assume point is at beginning of drawer."
531 (let ((case-fold-search t))
532 (if (not (save-excursion (re-search-forward "^[ \t]*:END:" limit t)))
533 ;; Incomplete drawer: parse it as a paragraph.
534 (org-element-paragraph-parser limit)
535 (let ((drawer-end-line (match-beginning 0)))
536 (save-excursion
537 (let* ((case-fold-search t)
538 (name (progn (looking-at org-drawer-regexp)
539 (org-match-string-no-properties 1)))
540 (keywords (org-element--collect-affiliated-keywords))
541 (begin (car keywords))
542 ;; Empty drawers have no contents.
543 (contents-begin (progn (forward-line)
544 (and (< (point) drawer-end-line)
545 (point))))
546 (contents-end (and contents-begin drawer-end-line))
547 (hidden (org-invisible-p2))
548 (pos-before-blank (progn (goto-char drawer-end-line)
549 (forward-line)
550 (point)))
551 (end (progn (skip-chars-forward " \r\t\n" limit)
552 (if (eobp) (point) (point-at-bol)))))
553 (list 'drawer
554 (nconc
555 (list :begin begin
556 :end end
557 :drawer-name name
558 :hiddenp hidden
559 :contents-begin contents-begin
560 :contents-end contents-end
561 :post-blank (count-lines pos-before-blank end))
562 (cadr keywords)))))))))
564 (defun org-element-drawer-interpreter (drawer contents)
565 "Interpret DRAWER element as Org syntax.
566 CONTENTS is the contents of the element."
567 (format ":%s:\n%s:END:"
568 (org-element-property :drawer-name drawer)
569 contents))
572 ;;;; Dynamic Block
574 (defun org-element-dynamic-block-parser (limit)
575 "Parse a dynamic block.
577 LIMIT bounds the search.
579 Return a list whose CAR is `dynamic-block' and CDR is a plist
580 containing `:block-name', `:begin', `:end', `:hiddenp',
581 `:contents-begin', `:contents-end', `:arguments' and
582 `:post-blank' keywords.
584 Assume point is at beginning of dynamic block."
585 (let ((case-fold-search t))
586 (if (not (save-excursion (re-search-forward org-dblock-end-re limit t)))
587 ;; Incomplete block: parse it as a paragraph.
588 (org-element-paragraph-parser limit)
589 (let ((block-end-line (match-beginning 0)))
590 (save-excursion
591 (let* ((name (progn (looking-at org-dblock-start-re)
592 (org-match-string-no-properties 1)))
593 (arguments (org-match-string-no-properties 3))
594 (keywords (org-element--collect-affiliated-keywords))
595 (begin (car keywords))
596 ;; Empty blocks have no contents.
597 (contents-begin (progn (forward-line)
598 (and (< (point) block-end-line)
599 (point))))
600 (contents-end (and contents-begin block-end-line))
601 (hidden (org-invisible-p2))
602 (pos-before-blank (progn (goto-char block-end-line)
603 (forward-line)
604 (point)))
605 (end (progn (skip-chars-forward " \r\t\n" limit)
606 (if (eobp) (point) (point-at-bol)))))
607 (list 'dynamic-block
608 (nconc
609 (list :begin begin
610 :end end
611 :block-name name
612 :arguments arguments
613 :hiddenp hidden
614 :contents-begin contents-begin
615 :contents-end contents-end
616 :post-blank (count-lines pos-before-blank end))
617 (cadr keywords)))))))))
619 (defun org-element-dynamic-block-interpreter (dynamic-block contents)
620 "Interpret DYNAMIC-BLOCK element as Org syntax.
621 CONTENTS is the contents of the element."
622 (format "#+BEGIN: %s%s\n%s#+END:"
623 (org-element-property :block-name dynamic-block)
624 (let ((args (org-element-property :arguments dynamic-block)))
625 (and args (concat " " args)))
626 contents))
629 ;;;; Footnote Definition
631 (defun org-element-footnote-definition-parser (limit)
632 "Parse a footnote definition.
634 LIMIT bounds the search.
636 Return a list whose CAR is `footnote-definition' and CDR is
637 a plist containing `:label', `:begin' `:end', `:contents-begin',
638 `:contents-end' and `:post-blank' keywords.
640 Assume point is at the beginning of the footnote definition."
641 (save-excursion
642 (let* ((label (progn (looking-at org-footnote-definition-re)
643 (org-match-string-no-properties 1)))
644 (keywords (org-element--collect-affiliated-keywords))
645 (begin (car keywords))
646 (ending (save-excursion
647 (if (progn
648 (end-of-line)
649 (re-search-forward
650 (concat org-outline-regexp-bol "\\|"
651 org-footnote-definition-re "\\|"
652 "^[ \t]*$") limit 'move))
653 (match-beginning 0)
654 (point))))
655 (contents-begin (progn (search-forward "]")
656 (skip-chars-forward " \r\t\n" ending)
657 (and (/= (point) ending) (point))))
658 (contents-end (and contents-begin ending))
659 (end (progn (goto-char ending)
660 (skip-chars-forward " \r\t\n" limit)
661 (if (eobp) (point) (point-at-bol)))))
662 (list 'footnote-definition
663 (nconc
664 (list :label label
665 :begin begin
666 :end end
667 :contents-begin contents-begin
668 :contents-end contents-end
669 :post-blank (count-lines ending end))
670 (cadr keywords))))))
672 (defun org-element-footnote-definition-interpreter (footnote-definition contents)
673 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
674 CONTENTS is the contents of the footnote-definition."
675 (concat (format "[%s]" (org-element-property :label footnote-definition))
677 contents))
680 ;;;; Headline
682 (defun org-element-headline-parser (limit &optional raw-secondary-p)
683 "Parse an headline.
685 Return a list whose CAR is `headline' and CDR is a plist
686 containing `:raw-value', `:title', `:begin', `:end',
687 `:pre-blank', `:hiddenp', `:contents-begin' and `:contents-end',
688 `:level', `:priority', `:tags', `:todo-keyword',`:todo-type',
689 `:scheduled', `:deadline', `:timestamp', `:clock', `:category',
690 `:quotedp', `:archivedp', `:commentedp' and `:footnote-section-p'
691 keywords.
693 The plist also contains any property set in the property drawer,
694 with its name in lowercase, the underscores replaced with hyphens
695 and colons at the beginning (i.e. `:custom-id').
697 When RAW-SECONDARY-P is non-nil, headline's title will not be
698 parsed as a secondary string, but as a plain string instead.
700 Assume point is at beginning of the headline."
701 (save-excursion
702 (let* ((components (org-heading-components))
703 (level (nth 1 components))
704 (todo (nth 2 components))
705 (todo-type
706 (and todo (if (member todo org-done-keywords) 'done 'todo)))
707 (tags (let ((raw-tags (nth 5 components)))
708 (and raw-tags (org-split-string raw-tags ":"))))
709 (raw-value (or (nth 4 components) ""))
710 (quotedp
711 (let ((case-fold-search nil))
712 (string-match (format "^%s +" org-quote-string) raw-value)))
713 (commentedp
714 (let ((case-fold-search nil))
715 (string-match (format "^%s +" org-comment-string) raw-value)))
716 (archivedp (member org-archive-tag tags))
717 (footnote-section-p (and org-footnote-section
718 (string= org-footnote-section raw-value)))
719 ;; Normalize property names: ":SOME_PROP:" becomes
720 ;; ":some-prop".
721 (standard-props (let (plist)
722 (mapc
723 (lambda (p)
724 (let ((p-name (downcase (car p))))
725 (while (string-match "_" p-name)
726 (setq p-name
727 (replace-match "-" nil nil p-name)))
728 (setq p-name (intern (concat ":" p-name)))
729 (setq plist
730 (plist-put plist p-name (cdr p)))))
731 (org-entry-properties nil 'standard))
732 plist))
733 (time-props (org-entry-properties nil 'special "CLOCK"))
734 (scheduled (cdr (assoc "SCHEDULED" time-props)))
735 (deadline (cdr (assoc "DEADLINE" time-props)))
736 (clock (cdr (assoc "CLOCK" time-props)))
737 (timestamp (cdr (assoc "TIMESTAMP" time-props)))
738 (begin (point))
739 (end (save-excursion (goto-char (org-end-of-subtree t t))))
740 (pos-after-head (progn (forward-line) (point)))
741 (contents-begin (save-excursion
742 (skip-chars-forward " \r\t\n" end)
743 (and (/= (point) end) (line-beginning-position))))
744 (hidden (org-invisible-p2))
745 (contents-end (and contents-begin
746 (progn (goto-char end)
747 (skip-chars-backward " \r\t\n")
748 (forward-line)
749 (point)))))
750 ;; Clean RAW-VALUE from any quote or comment string.
751 (when (or quotedp commentedp)
752 (setq raw-value
753 (replace-regexp-in-string
754 (concat "\\(" org-quote-string "\\|" org-comment-string "\\) +")
756 raw-value)))
757 ;; Clean TAGS from archive tag, if any.
758 (when archivedp (setq tags (delete org-archive-tag tags)))
759 (let ((headline
760 (list 'headline
761 (nconc
762 (list :raw-value raw-value
763 :begin begin
764 :end end
765 :pre-blank
766 (if (not contents-begin) 0
767 (count-lines pos-after-head contents-begin))
768 :hiddenp hidden
769 :contents-begin contents-begin
770 :contents-end contents-end
771 :level level
772 :priority (nth 3 components)
773 :tags tags
774 :todo-keyword todo
775 :todo-type todo-type
776 :scheduled scheduled
777 :deadline deadline
778 :timestamp timestamp
779 :clock clock
780 :post-blank (count-lines
781 (if (not contents-end) pos-after-head
782 (goto-char contents-end)
783 (forward-line)
784 (point))
785 end)
786 :footnote-section-p footnote-section-p
787 :archivedp archivedp
788 :commentedp commentedp
789 :quotedp quotedp)
790 standard-props))))
791 (org-element-put-property
792 headline :title
793 (if raw-secondary-p raw-value
794 (org-element-parse-secondary-string
795 raw-value (org-element-restriction 'headline) headline)))))))
797 (defun org-element-headline-interpreter (headline contents)
798 "Interpret HEADLINE element as Org syntax.
799 CONTENTS is the contents of the element."
800 (let* ((level (org-element-property :level headline))
801 (todo (org-element-property :todo-keyword headline))
802 (priority (org-element-property :priority headline))
803 (title (org-element-interpret-data
804 (org-element-property :title headline)))
805 (tags (let ((tag-list (if (org-element-property :archivedp headline)
806 (cons org-archive-tag
807 (org-element-property :tags headline))
808 (org-element-property :tags headline))))
809 (and tag-list
810 (format ":%s:" (mapconcat 'identity tag-list ":")))))
811 (commentedp (org-element-property :commentedp headline))
812 (quotedp (org-element-property :quotedp headline))
813 (pre-blank (or (org-element-property :pre-blank headline) 0))
814 (heading (concat (make-string level ?*)
815 (and todo (concat " " todo))
816 (and quotedp (concat " " org-quote-string))
817 (and commentedp (concat " " org-comment-string))
818 (and priority
819 (format " [#%s]" (char-to-string priority)))
820 (cond ((and org-footnote-section
821 (org-element-property
822 :footnote-section-p headline))
823 (concat " " org-footnote-section))
824 (title (concat " " title))))))
825 (concat heading
826 ;; Align tags.
827 (when tags
828 (cond
829 ((zerop org-tags-column) (format " %s" tags))
830 ((< org-tags-column 0)
831 (concat
832 (make-string
833 (max (- (+ org-tags-column (length heading) (length tags))) 1)
835 tags))
837 (concat
838 (make-string (max (- org-tags-column (length heading)) 1) ? )
839 tags))))
840 (make-string (1+ pre-blank) 10)
841 contents)))
844 ;;;; Inlinetask
846 (defun org-element-inlinetask-parser (limit &optional raw-secondary-p)
847 "Parse an inline task.
849 Return a list whose CAR is `inlinetask' and CDR is a plist
850 containing `:title', `:begin', `:end', `:hiddenp',
851 `:contents-begin' and `:contents-end', `:level', `:priority',
852 `:raw-value', `:tags', `:todo-keyword', `:todo-type',
853 `:scheduled', `:deadline', `:timestamp', `:clock' and
854 `:post-blank' keywords.
856 The plist also contains any property set in the property drawer,
857 with its name in lowercase, the underscores replaced with hyphens
858 and colons at the beginning (i.e. `:custom-id').
860 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
861 title will not be parsed as a secondary string, but as a plain
862 string instead.
864 Assume point is at beginning of the inline task."
865 (save-excursion
866 (let* ((keywords (org-element--collect-affiliated-keywords))
867 (begin (car keywords))
868 (components (org-heading-components))
869 (todo (nth 2 components))
870 (todo-type (and todo
871 (if (member todo org-done-keywords) 'done 'todo)))
872 (tags (let ((raw-tags (nth 5 components)))
873 (and raw-tags (org-split-string raw-tags ":"))))
874 (raw-value (or (nth 4 components) ""))
875 ;; Normalize property names: ":SOME_PROP:" becomes
876 ;; ":some-prop".
877 (standard-props (let (plist)
878 (mapc
879 (lambda (p)
880 (let ((p-name (downcase (car p))))
881 (while (string-match "_" p-name)
882 (setq p-name
883 (replace-match "-" nil nil p-name)))
884 (setq p-name (intern (concat ":" p-name)))
885 (setq plist
886 (plist-put plist p-name (cdr p)))))
887 (org-entry-properties nil 'standard))
888 plist))
889 (time-props (org-entry-properties nil 'special "CLOCK"))
890 (scheduled (cdr (assoc "SCHEDULED" time-props)))
891 (deadline (cdr (assoc "DEADLINE" time-props)))
892 (clock (cdr (assoc "CLOCK" time-props)))
893 (timestamp (cdr (assoc "TIMESTAMP" time-props)))
894 (task-end (save-excursion
895 (end-of-line)
896 (and (re-search-forward "^\\*+ END" limit t)
897 (match-beginning 0))))
898 (contents-begin (progn (forward-line)
899 (and task-end (< (point) task-end) (point))))
900 (hidden (and contents-begin (org-invisible-p2)))
901 (contents-end (and contents-begin task-end))
902 (before-blank (if (not task-end) (point)
903 (goto-char task-end)
904 (forward-line)
905 (point)))
906 (end (progn (skip-chars-forward " \r\t\n" limit)
907 (if (eobp) (point) (point-at-bol))))
908 (inlinetask
909 (list 'inlinetask
910 (nconc
911 (list :raw-value raw-value
912 :begin begin
913 :end end
914 :hiddenp hidden
915 :contents-begin contents-begin
916 :contents-end contents-end
917 :level (nth 1 components)
918 :priority (nth 3 components)
919 :tags tags
920 :todo-keyword todo
921 :todo-type todo-type
922 :scheduled scheduled
923 :deadline deadline
924 :timestamp timestamp
925 :clock clock
926 :post-blank (count-lines before-blank end))
927 standard-props
928 (cadr keywords)))))
929 (org-element-put-property
930 inlinetask :title
931 (if raw-secondary-p raw-value
932 (org-element-parse-secondary-string
933 raw-value
934 (org-element-restriction 'inlinetask)
935 inlinetask))))))
937 (defun org-element-inlinetask-interpreter (inlinetask contents)
938 "Interpret INLINETASK element as Org syntax.
939 CONTENTS is the contents of inlinetask."
940 (let* ((level (org-element-property :level inlinetask))
941 (todo (org-element-property :todo-keyword inlinetask))
942 (priority (org-element-property :priority inlinetask))
943 (title (org-element-interpret-data
944 (org-element-property :title inlinetask)))
945 (tags (let ((tag-list (org-element-property :tags inlinetask)))
946 (and tag-list
947 (format ":%s:" (mapconcat 'identity tag-list ":")))))
948 (task (concat (make-string level ?*)
949 (and todo (concat " " todo))
950 (and priority
951 (format " [#%s]" (char-to-string priority)))
952 (and title (concat " " title)))))
953 (concat task
954 ;; Align tags.
955 (when tags
956 (cond
957 ((zerop org-tags-column) (format " %s" tags))
958 ((< org-tags-column 0)
959 (concat
960 (make-string
961 (max (- (+ org-tags-column (length task) (length tags))) 1)
963 tags))
965 (concat
966 (make-string (max (- org-tags-column (length task)) 1) ? )
967 tags))))
968 ;; Prefer degenerate inlinetasks when there are no
969 ;; contents.
970 (when contents
971 (concat "\n"
972 contents
973 (make-string level ?*) " END")))))
976 ;;;; Item
978 (defun org-element-item-parser (limit struct &optional raw-secondary-p)
979 "Parse an item.
981 STRUCT is the structure of the plain list.
983 Return a list whose CAR is `item' and CDR is a plist containing
984 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
985 `:checkbox', `:counter', `:tag', `:structure', `:hiddenp' and
986 `:post-blank' keywords.
988 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
989 any, will not be parsed as a secondary string, but as a plain
990 string instead.
992 Assume point is at the beginning of the item."
993 (save-excursion
994 (beginning-of-line)
995 (looking-at org-list-full-item-re)
996 (let* ((begin (point))
997 (bullet (org-match-string-no-properties 1))
998 (checkbox (let ((box (org-match-string-no-properties 3)))
999 (cond ((equal "[ ]" box) 'off)
1000 ((equal "[X]" box) 'on)
1001 ((equal "[-]" box) 'trans))))
1002 (counter (let ((c (org-match-string-no-properties 2)))
1003 (save-match-data
1004 (cond
1005 ((not c) nil)
1006 ((string-match "[A-Za-z]" c)
1007 (- (string-to-char (upcase (match-string 0 c)))
1008 64))
1009 ((string-match "[0-9]+" c)
1010 (string-to-number (match-string 0 c)))))))
1011 (end (save-excursion (goto-char (org-list-get-item-end begin struct))
1012 (unless (bolp) (forward-line))
1013 (point)))
1014 (contents-begin
1015 (progn (goto-char
1016 ;; Ignore tags in un-ordered lists: they are just
1017 ;; a part of item's body.
1018 (if (and (match-beginning 4)
1019 (save-match-data (string-match "[.)]" bullet)))
1020 (match-beginning 4)
1021 (match-end 0)))
1022 (skip-chars-forward " \r\t\n" limit)
1023 ;; If first line isn't empty, contents really start
1024 ;; at the text after item's meta-data.
1025 (if (= (point-at-bol) begin) (point) (point-at-bol))))
1026 (hidden (progn (forward-line)
1027 (and (not (= (point) end)) (org-invisible-p2))))
1028 (contents-end (progn (goto-char end)
1029 (skip-chars-backward " \r\t\n")
1030 (forward-line)
1031 (point)))
1032 (item
1033 (list 'item
1034 (list :bullet bullet
1035 :begin begin
1036 :end end
1037 ;; CONTENTS-BEGIN and CONTENTS-END may be
1038 ;; mixed up in the case of an empty item
1039 ;; separated from the next by a blank line.
1040 ;; Thus ensure the former is always the
1041 ;; smallest.
1042 :contents-begin (min contents-begin contents-end)
1043 :contents-end (max contents-begin contents-end)
1044 :checkbox checkbox
1045 :counter counter
1046 :hiddenp hidden
1047 :structure struct
1048 :post-blank (count-lines contents-end end)))))
1049 (org-element-put-property
1050 item :tag
1051 (let ((raw-tag (org-list-get-tag begin struct)))
1052 (and raw-tag
1053 (if raw-secondary-p raw-tag
1054 (org-element-parse-secondary-string
1055 raw-tag (org-element-restriction 'item) item))))))))
1057 (defun org-element-item-interpreter (item contents)
1058 "Interpret ITEM element as Org syntax.
1059 CONTENTS is the contents of the element."
1060 (let* ((bullet (org-list-bullet-string (org-element-property :bullet item)))
1061 (checkbox (org-element-property :checkbox item))
1062 (counter (org-element-property :counter item))
1063 (tag (let ((tag (org-element-property :tag item)))
1064 (and tag (org-element-interpret-data tag))))
1065 ;; Compute indentation.
1066 (ind (make-string (length bullet) 32))
1067 (item-starts-with-par-p
1068 (eq (org-element-type (car (org-element-contents item)))
1069 'paragraph)))
1070 ;; Indent contents.
1071 (concat
1072 bullet
1073 (and counter (format "[@%d] " counter))
1074 (case checkbox
1075 (on "[X] ")
1076 (off "[ ] ")
1077 (trans "[-] "))
1078 (and tag (format "%s :: " tag))
1079 (let ((contents (replace-regexp-in-string
1080 "\\(^\\)[ \t]*\\S-" ind contents nil nil 1)))
1081 (if item-starts-with-par-p (org-trim contents)
1082 (concat "\n" contents))))))
1085 ;;;; Plain List
1087 (defun org-element-plain-list-parser (limit &optional structure)
1088 "Parse a plain list.
1090 Optional argument STRUCTURE, when non-nil, is the structure of
1091 the plain list being parsed.
1093 Return a list whose CAR is `plain-list' and CDR is a plist
1094 containing `:type', `:begin', `:end', `:contents-begin' and
1095 `:contents-end', `:structure' and `:post-blank' keywords.
1097 Assume point is at the beginning of the list."
1098 (save-excursion
1099 (let* ((struct (or structure (org-list-struct)))
1100 (prevs (org-list-prevs-alist struct))
1101 (parents (org-list-parents-alist struct))
1102 (type (org-list-get-list-type (point) struct prevs))
1103 (contents-begin (point))
1104 (keywords (org-element--collect-affiliated-keywords))
1105 (begin (car keywords))
1106 (contents-end
1107 (progn (goto-char (org-list-get-list-end (point) struct prevs))
1108 (unless (bolp) (forward-line))
1109 (point)))
1110 (end (progn (skip-chars-forward " \r\t\n" limit)
1111 (if (eobp) (point) (point-at-bol)))))
1112 ;; Return value.
1113 (list 'plain-list
1114 (nconc
1115 (list :type type
1116 :begin begin
1117 :end end
1118 :contents-begin contents-begin
1119 :contents-end contents-end
1120 :structure struct
1121 :post-blank (count-lines contents-end end))
1122 (cadr keywords))))))
1124 (defun org-element-plain-list-interpreter (plain-list contents)
1125 "Interpret PLAIN-LIST element as Org syntax.
1126 CONTENTS is the contents of the element."
1127 (with-temp-buffer
1128 (insert contents)
1129 (goto-char (point-min))
1130 (org-list-repair)
1131 (buffer-string)))
1134 ;;;; Quote Block
1136 (defun org-element-quote-block-parser (limit)
1137 "Parse a quote block.
1139 LIMIT bounds the search.
1141 Return a list whose CAR is `quote-block' and CDR is a plist
1142 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1143 `:contents-end' and `:post-blank' keywords.
1145 Assume point is at the beginning of the block."
1146 (let ((case-fold-search t))
1147 (if (not (save-excursion
1148 (re-search-forward "^[ \t]*#\\+END_QUOTE" limit t)))
1149 ;; Incomplete block: parse it as a paragraph.
1150 (org-element-paragraph-parser limit)
1151 (let ((block-end-line (match-beginning 0)))
1152 (save-excursion
1153 (let* ((keywords (org-element--collect-affiliated-keywords))
1154 (begin (car keywords))
1155 ;; Empty blocks have no contents.
1156 (contents-begin (progn (forward-line)
1157 (and (< (point) block-end-line)
1158 (point))))
1159 (contents-end (and contents-begin block-end-line))
1160 (hidden (org-invisible-p2))
1161 (pos-before-blank (progn (goto-char block-end-line)
1162 (forward-line)
1163 (point)))
1164 (end (progn (skip-chars-forward " \r\t\n" limit)
1165 (if (eobp) (point) (point-at-bol)))))
1166 (list 'quote-block
1167 (nconc
1168 (list :begin begin
1169 :end end
1170 :hiddenp hidden
1171 :contents-begin contents-begin
1172 :contents-end contents-end
1173 :post-blank (count-lines pos-before-blank end))
1174 (cadr keywords)))))))))
1176 (defun org-element-quote-block-interpreter (quote-block contents)
1177 "Interpret QUOTE-BLOCK element as Org syntax.
1178 CONTENTS is the contents of the element."
1179 (format "#+BEGIN_QUOTE\n%s#+END_QUOTE" contents))
1182 ;;;; Section
1184 (defun org-element-section-parser (limit)
1185 "Parse a section.
1187 LIMIT bounds the search.
1189 Return a list whose CAR is `section' and CDR is a plist
1190 containing `:begin', `:end', `:contents-begin', `contents-end'
1191 and `:post-blank' keywords."
1192 (save-excursion
1193 ;; Beginning of section is the beginning of the first non-blank
1194 ;; line after previous headline.
1195 (let ((begin (point))
1196 (end (progn (org-with-limited-levels (outline-next-heading))
1197 (point)))
1198 (pos-before-blank (progn (skip-chars-backward " \r\t\n")
1199 (forward-line)
1200 (point))))
1201 (list 'section
1202 (list :begin begin
1203 :end end
1204 :contents-begin begin
1205 :contents-end pos-before-blank
1206 :post-blank (count-lines pos-before-blank end))))))
1208 (defun org-element-section-interpreter (section contents)
1209 "Interpret SECTION element as Org syntax.
1210 CONTENTS is the contents of the element."
1211 contents)
1214 ;;;; Special Block
1216 (defun org-element-special-block-parser (limit)
1217 "Parse a special block.
1219 LIMIT bounds the search.
1221 Return a list whose CAR is `special-block' and CDR is a plist
1222 containing `:type', `:begin', `:end', `:hiddenp',
1223 `:contents-begin', `:contents-end' and `:post-blank' keywords.
1225 Assume point is at the beginning of the block."
1226 (let* ((case-fold-search t)
1227 (type (progn (looking-at "[ \t]*#\\+BEGIN_\\(S-+\\)")
1228 (upcase (match-string-no-properties 1)))))
1229 (if (not (save-excursion
1230 (re-search-forward (concat "^[ \t]*#\\+END_" type) limit t)))
1231 ;; Incomplete block: parse it as a paragraph.
1232 (org-element-paragraph-parser limit)
1233 (let ((block-end-line (match-beginning 0)))
1234 (save-excursion
1235 (let* ((keywords (org-element--collect-affiliated-keywords))
1236 (begin (car keywords))
1237 ;; Empty blocks have no contents.
1238 (contents-begin (progn (forward-line)
1239 (and (< (point) block-end-line)
1240 (point))))
1241 (contents-end (and contents-begin block-end-line))
1242 (hidden (org-invisible-p2))
1243 (pos-before-blank (progn (goto-char block-end-line)
1244 (forward-line)
1245 (point)))
1246 (end (progn (org-skip-whitespace)
1247 (if (eobp) (point) (point-at-bol)))))
1248 (list 'special-block
1249 (nconc
1250 (list :type type
1251 :begin begin
1252 :end end
1253 :hiddenp hidden
1254 :contents-begin contents-begin
1255 :contents-end contents-end
1256 :post-blank (count-lines pos-before-blank end))
1257 (cadr keywords)))))))))
1259 (defun org-element-special-block-interpreter (special-block contents)
1260 "Interpret SPECIAL-BLOCK element as Org syntax.
1261 CONTENTS is the contents of the element."
1262 (let ((block-type (org-element-property :type special-block)))
1263 (format "#+BEGIN_%s\n%s#+END_%s" block-type contents block-type)))
1267 ;;; Elements
1269 ;; For each element, a parser and an interpreter are also defined.
1270 ;; Both follow the same naming convention used for greater elements.
1272 ;; Also, as for greater elements, adding a new element type is done
1273 ;; through the following steps: implement a parser and an interpreter,
1274 ;; tweak `org-element--current-element' so that it recognizes the new
1275 ;; type and add that new type to `org-element-all-elements'.
1277 ;; As a special case, when the newly defined type is a block type,
1278 ;; `org-element-block-name-alist' has to be modified accordingly.
1281 ;;;; Babel Call
1283 (defun org-element-babel-call-parser (limit)
1284 "Parse a babel call.
1286 LIMIT bounds the search.
1288 Return a list whose CAR is `babel-call' and CDR is a plist
1289 containing `:begin', `:end', `:info' and `:post-blank' as
1290 keywords."
1291 (save-excursion
1292 (let ((case-fold-search t)
1293 (info (progn (looking-at org-babel-block-lob-one-liner-regexp)
1294 (org-babel-lob-get-info)))
1295 (begin (point-at-bol))
1296 (pos-before-blank (progn (forward-line) (point)))
1297 (end (progn (skip-chars-forward " \r\t\n" limit)
1298 (if (eobp) (point) (point-at-bol)))))
1299 (list 'babel-call
1300 (list :begin begin
1301 :end end
1302 :info info
1303 :post-blank (count-lines pos-before-blank end))))))
1305 (defun org-element-babel-call-interpreter (babel-call contents)
1306 "Interpret BABEL-CALL element as Org syntax.
1307 CONTENTS is nil."
1308 (let* ((babel-info (org-element-property :info babel-call))
1309 (main (car babel-info))
1310 (post-options (nth 1 babel-info)))
1311 (concat "#+CALL: "
1312 (if (not (string-match "\\[\\(\\[.*?\\]\\)\\]" main)) main
1313 ;; Remove redundant square brackets.
1314 (replace-match (match-string 1 main) nil nil main))
1315 (and post-options (format "[%s]" post-options)))))
1318 ;;;; Clock
1320 (defun org-element-clock-parser (limit)
1321 "Parse a clock.
1323 LIMIT bounds the search.
1325 Return a list whose CAR is `clock' and CDR is a plist containing
1326 `:status', `:value', `:time', `:begin', `:end' and `:post-blank'
1327 as keywords."
1328 (save-excursion
1329 (let* ((case-fold-search nil)
1330 (begin (point))
1331 (value (progn (search-forward org-clock-string (line-end-position) t)
1332 (org-skip-whitespace)
1333 (looking-at "\\[.*\\]")
1334 (org-match-string-no-properties 0)))
1335 (time (and (progn (goto-char (match-end 0))
1336 (looking-at " +=> +\\(\\S-+\\)[ \t]*$"))
1337 (org-match-string-no-properties 1)))
1338 (status (if time 'closed 'running))
1339 (post-blank (let ((before-blank (progn (forward-line) (point))))
1340 (skip-chars-forward " \r\t\n" limit)
1341 (unless (eobp) (beginning-of-line))
1342 (count-lines before-blank (point))))
1343 (end (point)))
1344 (list 'clock
1345 (list :status status
1346 :value value
1347 :time time
1348 :begin begin
1349 :end end
1350 :post-blank post-blank)))))
1352 (defun org-element-clock-interpreter (clock contents)
1353 "Interpret CLOCK element as Org syntax.
1354 CONTENTS is nil."
1355 (concat org-clock-string " "
1356 (org-element-property :value clock)
1357 (let ((time (org-element-property :time clock)))
1358 (and time
1359 (concat " => "
1360 (apply 'format
1361 "%2s:%02s"
1362 (org-split-string time ":")))))))
1365 ;;;; Comment
1367 (defun org-element-comment-parser (limit)
1368 "Parse a comment.
1370 LIMIT bounds the search.
1372 Return a list whose CAR is `comment' and CDR is a plist
1373 containing `:begin', `:end', `:value' and `:post-blank'
1374 keywords.
1376 Assume point is at comment beginning."
1377 (save-excursion
1378 (let* ((keywords (org-element--collect-affiliated-keywords))
1379 (begin (car keywords))
1380 (value (prog2 (looking-at "[ \t]*# ?")
1381 (buffer-substring-no-properties
1382 (match-end 0) (line-end-position))
1383 (forward-line)))
1384 (com-end
1385 ;; Get comments ending.
1386 (progn
1387 (while (and (< (point) limit) (looking-at "[ \t]*#\\( \\|$\\)"))
1388 ;; Accumulate lines without leading hash and first
1389 ;; whitespace.
1390 (setq value
1391 (concat value
1392 "\n"
1393 (buffer-substring-no-properties
1394 (match-end 0) (line-end-position))))
1395 (forward-line))
1396 (point)))
1397 (end (progn (goto-char com-end)
1398 (skip-chars-forward " \r\t\n" limit)
1399 (if (eobp) (point) (point-at-bol)))))
1400 (list 'comment
1401 (nconc
1402 (list :begin begin
1403 :end end
1404 :value value
1405 :post-blank (count-lines com-end end))
1406 (cadr keywords))))))
1408 (defun org-element-comment-interpreter (comment contents)
1409 "Interpret COMMENT element as Org syntax.
1410 CONTENTS is nil."
1411 (replace-regexp-in-string "^" "# " (org-element-property :value comment)))
1414 ;;;; Comment Block
1416 (defun org-element-comment-block-parser (limit)
1417 "Parse an export block.
1419 LIMIT bounds the search.
1421 Return a list whose CAR is `comment-block' and CDR is a plist
1422 containing `:begin', `:end', `:hiddenp', `:value' and
1423 `:post-blank' keywords.
1425 Assume point is at comment block beginning."
1426 (let ((case-fold-search t))
1427 (if (not (save-excursion
1428 (re-search-forward "^[ \t]*#\\+END_COMMENT" limit t)))
1429 ;; Incomplete block: parse it as a paragraph.
1430 (org-element-paragraph-parser limit)
1431 (let ((contents-end (match-beginning 0)))
1432 (save-excursion
1433 (let* ((keywords (org-element--collect-affiliated-keywords))
1434 (begin (car keywords))
1435 (contents-begin (progn (forward-line) (point)))
1436 (hidden (org-invisible-p2))
1437 (pos-before-blank (progn (goto-char contents-end)
1438 (forward-line)
1439 (point)))
1440 (end (progn (skip-chars-forward " \r\t\n" limit)
1441 (if (eobp) (point) (point-at-bol))))
1442 (value (buffer-substring-no-properties
1443 contents-begin contents-end)))
1444 (list 'comment-block
1445 (nconc
1446 (list :begin begin
1447 :end end
1448 :value value
1449 :hiddenp hidden
1450 :post-blank (count-lines pos-before-blank end))
1451 (cadr keywords)))))))))
1453 (defun org-element-comment-block-interpreter (comment-block contents)
1454 "Interpret COMMENT-BLOCK element as Org syntax.
1455 CONTENTS is nil."
1456 (format "#+BEGIN_COMMENT\n%s#+END_COMMENT"
1457 (org-remove-indentation (org-element-property :value comment-block))))
1460 ;;;; Example Block
1462 (defun org-element-example-block-parser (limit)
1463 "Parse an example block.
1465 LIMIT bounds the search.
1467 Return a list whose CAR is `example-block' and CDR is a plist
1468 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1469 `:retain-labels', `:use-labels', `:label-fmt', `:hiddenp',
1470 `:switches', `:value' and `:post-blank' keywords."
1471 (let ((case-fold-search t))
1472 (if (not (save-excursion
1473 (re-search-forward "^[ \t]*#\\+END_EXAMPLE" limit t)))
1474 ;; Incomplete block: parse it as a paragraph.
1475 (org-element-paragraph-parser limit)
1476 (let ((contents-end (match-beginning 0)))
1477 (save-excursion
1478 (let* ((switches
1479 (progn (looking-at "^[ \t]*#\\+BEGIN_EXAMPLE\\(?: +\\(.*\\)\\)?")
1480 (org-match-string-no-properties 1)))
1481 ;; Switches analysis
1482 (number-lines (cond ((not switches) nil)
1483 ((string-match "-n\\>" switches) 'new)
1484 ((string-match "+n\\>" switches) 'continued)))
1485 (preserve-indent (and switches (string-match "-i\\>" switches)))
1486 ;; Should labels be retained in (or stripped from) example
1487 ;; blocks?
1488 (retain-labels
1489 (or (not switches)
1490 (not (string-match "-r\\>" switches))
1491 (and number-lines (string-match "-k\\>" switches))))
1492 ;; What should code-references use - labels or
1493 ;; line-numbers?
1494 (use-labels
1495 (or (not switches)
1496 (and retain-labels (not (string-match "-k\\>" switches)))))
1497 (label-fmt (and switches
1498 (string-match "-l +\"\\([^\"\n]+\\)\"" switches)
1499 (match-string 1 switches)))
1500 ;; Standard block parsing.
1501 (keywords (org-element--collect-affiliated-keywords))
1502 (begin (car keywords))
1503 (contents-begin (progn (forward-line) (point)))
1504 (hidden (org-invisible-p2))
1505 (value (buffer-substring-no-properties contents-begin contents-end))
1506 (pos-before-blank (progn (goto-char contents-end)
1507 (forward-line)
1508 (point)))
1509 (end (progn (skip-chars-forward " \r\t\n" limit)
1510 (if (eobp) (point) (point-at-bol)))))
1511 (list 'example-block
1512 (nconc
1513 (list :begin begin
1514 :end end
1515 :value value
1516 :switches switches
1517 :number-lines number-lines
1518 :preserve-indent preserve-indent
1519 :retain-labels retain-labels
1520 :use-labels use-labels
1521 :label-fmt label-fmt
1522 :hiddenp hidden
1523 :post-blank (count-lines pos-before-blank end))
1524 (cadr keywords)))))))))
1526 (defun org-element-example-block-interpreter (example-block contents)
1527 "Interpret EXAMPLE-BLOCK element as Org syntax.
1528 CONTENTS is nil."
1529 (let ((switches (org-element-property :switches example-block)))
1530 (concat "#+BEGIN_EXAMPLE" (and switches (concat " " switches)) "\n"
1531 (org-remove-indentation
1532 (org-element-property :value example-block))
1533 "#+END_EXAMPLE")))
1536 ;;;; Export Block
1538 (defun org-element-export-block-parser (limit)
1539 "Parse an export block.
1541 LIMIT bounds the search.
1543 Return a list whose CAR is `export-block' and CDR is a plist
1544 containing `:begin', `:end', `:type', `:hiddenp', `:value' and
1545 `:post-blank' keywords.
1547 Assume point is at export-block beginning."
1548 (let* ((case-fold-search t)
1549 (type (progn (looking-at "[ \t]*#\\+BEGIN_\\(\\S-+\\)")
1550 (upcase (org-match-string-no-properties 1)))))
1551 (if (not (save-excursion
1552 (re-search-forward (concat "^[ \t]*#\\+END_" type) limit t)))
1553 ;; Incomplete block: parse it as a paragraph.
1554 (org-element-paragraph-parser limit)
1555 (let ((contents-end (match-beginning 0)))
1556 (save-excursion
1557 (let* ((keywords (org-element--collect-affiliated-keywords))
1558 (begin (car keywords))
1559 (contents-begin (progn (forward-line) (point)))
1560 (hidden (org-invisible-p2))
1561 (pos-before-blank (progn (goto-char contents-end)
1562 (forward-line)
1563 (point)))
1564 (end (progn (skip-chars-forward " \r\t\n" limit)
1565 (if (eobp) (point) (point-at-bol))))
1566 (value (buffer-substring-no-properties contents-begin
1567 contents-end)))
1568 (list 'export-block
1569 (nconc
1570 (list :begin begin
1571 :end end
1572 :type type
1573 :value value
1574 :hiddenp hidden
1575 :post-blank (count-lines pos-before-blank end))
1576 (cadr keywords)))))))))
1578 (defun org-element-export-block-interpreter (export-block contents)
1579 "Interpret EXPORT-BLOCK element as Org syntax.
1580 CONTENTS is nil."
1581 (let ((type (org-element-property :type export-block)))
1582 (concat (format "#+BEGIN_%s\n" type)
1583 (org-element-property :value export-block)
1584 (format "#+END_%s" type))))
1587 ;;;; Fixed-width
1589 (defun org-element-fixed-width-parser (limit)
1590 "Parse a fixed-width section.
1592 LIMIT bounds the search.
1594 Return a list whose CAR is `fixed-width' and CDR is a plist
1595 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1597 Assume point is at the beginning of the fixed-width area."
1598 (save-excursion
1599 (let* ((keywords (org-element--collect-affiliated-keywords))
1600 (begin (car keywords))
1601 value
1602 (end-area
1603 (progn
1604 (while (and (< (point) limit)
1605 (looking-at "[ \t]*:\\( \\|$\\)"))
1606 ;; Accumulate text without starting colons.
1607 (setq value
1608 (concat value
1609 (buffer-substring-no-properties
1610 (match-end 0) (point-at-eol))
1611 "\n"))
1612 (forward-line))
1613 (point)))
1614 (end (progn (skip-chars-forward " \r\t\n" limit)
1615 (if (eobp) (point) (point-at-bol)))))
1616 (list 'fixed-width
1617 (nconc
1618 (list :begin begin
1619 :end end
1620 :value value
1621 :post-blank (count-lines end-area end))
1622 (cadr keywords))))))
1624 (defun org-element-fixed-width-interpreter (fixed-width contents)
1625 "Interpret FIXED-WIDTH element as Org syntax.
1626 CONTENTS is nil."
1627 (replace-regexp-in-string
1628 "^" ": " (substring (org-element-property :value fixed-width) 0 -1)))
1631 ;;;; Horizontal Rule
1633 (defun org-element-horizontal-rule-parser (limit)
1634 "Parse an horizontal rule.
1636 LIMIT bounds the search.
1638 Return a list whose CAR is `horizontal-rule' and CDR is a plist
1639 containing `:begin', `:end' and `:post-blank' keywords."
1640 (save-excursion
1641 (let* ((keywords (org-element--collect-affiliated-keywords))
1642 (begin (car keywords))
1643 (post-hr (progn (forward-line) (point)))
1644 (end (progn (skip-chars-forward " \r\t\n" limit)
1645 (if (eobp) (point) (point-at-bol)))))
1646 (list 'horizontal-rule
1647 (nconc
1648 (list :begin begin
1649 :end end
1650 :post-blank (count-lines post-hr end))
1651 (cadr keywords))))))
1653 (defun org-element-horizontal-rule-interpreter (horizontal-rule contents)
1654 "Interpret HORIZONTAL-RULE element as Org syntax.
1655 CONTENTS is nil."
1656 "-----")
1659 ;;;; Keyword
1661 (defun org-element-keyword-parser (limit)
1662 "Parse a keyword at point.
1664 LIMIT bounds the search.
1666 Return a list whose CAR is `keyword' and CDR is a plist
1667 containing `:key', `:value', `:begin', `:end' and `:post-blank'
1668 keywords."
1669 (save-excursion
1670 (let* ((case-fold-search t)
1671 (begin (point))
1672 (key (progn (looking-at "[ \t]*#\\+\\(\\S-+\\):")
1673 (upcase (org-match-string-no-properties 1))))
1674 (value (org-trim (buffer-substring-no-properties
1675 (match-end 0) (point-at-eol))))
1676 (pos-before-blank (progn (forward-line) (point)))
1677 (end (progn (skip-chars-forward " \r\t\n" limit)
1678 (if (eobp) (point) (point-at-bol)))))
1679 (list 'keyword
1680 (list :key key
1681 :value value
1682 :begin begin
1683 :end end
1684 :post-blank (count-lines pos-before-blank end))))))
1686 (defun org-element-keyword-interpreter (keyword contents)
1687 "Interpret KEYWORD element as Org syntax.
1688 CONTENTS is nil."
1689 (format "#+%s: %s"
1690 (org-element-property :key keyword)
1691 (org-element-property :value keyword)))
1694 ;;;; Latex Environment
1696 (defun org-element-latex-environment-parser (limit)
1697 "Parse a LaTeX environment.
1699 LIMIT bounds the search.
1701 Return a list whose CAR is `latex-environment' and CDR is a plist
1702 containing `:begin', `:end', `:value' and `:post-blank'
1703 keywords.
1705 Assume point is at the beginning of the latex environment."
1706 (save-excursion
1707 (let* ((case-fold-search t)
1708 (code-begin (point))
1709 (keywords (org-element--collect-affiliated-keywords))
1710 (begin (car keywords))
1711 (env (progn (looking-at "^[ \t]*\\\\begin{\\([A-Za-z0-9]+\\*?\\)}")
1712 (regexp-quote (match-string 1))))
1713 (code-end
1714 (progn (re-search-forward (format "^[ \t]*\\\\end{%s}" env) limit t)
1715 (forward-line)
1716 (point)))
1717 (value (buffer-substring-no-properties code-begin code-end))
1718 (end (progn (skip-chars-forward " \r\t\n" limit)
1719 (if (eobp) (point) (point-at-bol)))))
1720 (list 'latex-environment
1721 (nconc
1722 (list :begin begin
1723 :end end
1724 :value value
1725 :post-blank (count-lines code-end end))
1726 (cadr keywords))))))
1728 (defun org-element-latex-environment-interpreter (latex-environment contents)
1729 "Interpret LATEX-ENVIRONMENT element as Org syntax.
1730 CONTENTS is nil."
1731 (org-element-property :value latex-environment))
1734 ;;;; Paragraph
1736 (defun org-element-paragraph-parser (limit)
1737 "Parse a paragraph.
1739 LIMIT bounds the search.
1741 Return a list whose CAR is `paragraph' and CDR is a plist
1742 containing `:begin', `:end', `:contents-begin' and
1743 `:contents-end' and `:post-blank' keywords.
1745 Assume point is at the beginning of the paragraph."
1746 (save-excursion
1747 (let* (;; INNER-PAR-P is non-nil when paragraph is at the
1748 ;; beginning of an item or a footnote reference. In that
1749 ;; case, we mustn't look for affiliated keywords since they
1750 ;; belong to the container.
1751 (inner-par-p (not (bolp)))
1752 (contents-begin (point))
1753 (keywords (unless inner-par-p
1754 (org-element--collect-affiliated-keywords)))
1755 (begin (if inner-par-p contents-begin (car keywords)))
1756 (before-blank
1757 (let ((case-fold-search t))
1758 (end-of-line)
1759 (re-search-forward org-element-paragraph-separate limit 'm)
1760 (while (and (/= (point) limit)
1761 (cond
1762 ;; Skip non-existent or incomplete drawer.
1763 ((save-excursion
1764 (beginning-of-line)
1765 (and (looking-at "[ \t]*:\\S-")
1766 (or (not (looking-at org-drawer-regexp))
1767 (not (save-excursion
1768 (re-search-forward
1769 "^[ \t]*:END:" limit t)))))))
1770 ;; Stop at comments.
1771 ((save-excursion
1772 (beginning-of-line)
1773 (not (looking-at "[ \t]*#\\S-"))) nil)
1774 ;; Skip incomplete dynamic blocks.
1775 ((save-excursion
1776 (beginning-of-line)
1777 (looking-at "[ \t]*#\\+BEGIN: "))
1778 (not (save-excursion
1779 (re-search-forward
1780 "^[ \t]*\\+END:" limit t))))
1781 ;; Skip incomplete blocks.
1782 ((save-excursion
1783 (beginning-of-line)
1784 (looking-at "[ \t]*#\\+BEGIN_\\(\\S-+\\)"))
1785 (not (save-excursion
1786 (re-search-forward
1787 (concat "^[ \t]*#\\+END_"
1788 (match-string 1))
1789 limit t))))
1790 ;; Skip incomplete latex environments.
1791 ((save-excursion
1792 (beginning-of-line)
1793 (looking-at "^[ \t]*\\\\begin{\\([A-Za-z0-9]+\\*?\\)}"))
1794 (not (save-excursion
1795 (re-search-forward
1796 (format "^[ \t]*\\\\end{%s}"
1797 (match-string 1))
1798 limit t))))
1799 ;; Skip ill-formed keywords.
1800 ((not (save-excursion
1801 (beginning-of-line)
1802 (looking-at "[ \t]*#\\+\\S-+:"))))))
1803 (re-search-forward org-element-paragraph-separate limit 'm))
1804 (if (eobp) (point) (goto-char (line-beginning-position)))))
1805 (contents-end (progn (skip-chars-backward " \r\t\n" contents-begin)
1806 (forward-line)
1807 (point)))
1808 (end (progn (skip-chars-forward " \r\t\n" limit)
1809 (if (eobp) (point) (point-at-bol)))))
1810 (list 'paragraph
1811 (nconc
1812 (list :begin begin
1813 :end end
1814 :contents-begin contents-begin
1815 :contents-end contents-end
1816 :post-blank (count-lines before-blank end))
1817 (cadr keywords))))))
1819 (defun org-element-paragraph-interpreter (paragraph contents)
1820 "Interpret PARAGRAPH element as Org syntax.
1821 CONTENTS is the contents of the element."
1822 contents)
1825 ;;;; Planning
1827 (defun org-element-planning-parser (limit)
1828 "Parse a planning.
1830 LIMIT bounds the search.
1832 Return a list whose CAR is `planning' and CDR is a plist
1833 containing `:closed', `:deadline', `:scheduled', `:begin', `:end'
1834 and `:post-blank' keywords."
1835 (save-excursion
1836 (let* ((case-fold-search nil)
1837 (begin (point))
1838 (post-blank (let ((before-blank (progn (forward-line) (point))))
1839 (skip-chars-forward " \r\t\n" limit)
1840 (unless (eobp) (beginning-of-line))
1841 (count-lines before-blank (point))))
1842 (end (point))
1843 closed deadline scheduled)
1844 (goto-char begin)
1845 (while (re-search-forward org-keyword-time-not-clock-regexp
1846 (line-end-position) t)
1847 (goto-char (match-end 1))
1848 (org-skip-whitespace)
1849 (let ((time (buffer-substring-no-properties
1850 (1+ (point)) (1- (match-end 0))))
1851 (keyword (match-string 1)))
1852 (cond ((equal keyword org-closed-string) (setq closed time))
1853 ((equal keyword org-deadline-string) (setq deadline time))
1854 (t (setq scheduled time)))))
1855 (list 'planning
1856 (list :closed closed
1857 :deadline deadline
1858 :scheduled scheduled
1859 :begin begin
1860 :end end
1861 :post-blank post-blank)))))
1863 (defun org-element-planning-interpreter (planning contents)
1864 "Interpret PLANNING element as Org syntax.
1865 CONTENTS is nil."
1866 (mapconcat
1867 'identity
1868 (delq nil
1869 (list (let ((closed (org-element-property :closed planning)))
1870 (when closed (concat org-closed-string " [" closed "]")))
1871 (let ((deadline (org-element-property :deadline planning)))
1872 (when deadline (concat org-deadline-string " <" deadline ">")))
1873 (let ((scheduled (org-element-property :scheduled planning)))
1874 (when scheduled
1875 (concat org-scheduled-string " <" scheduled ">")))))
1876 " "))
1879 ;;;; Property Drawer
1881 (defun org-element-property-drawer-parser (limit)
1882 "Parse a property drawer.
1884 LIMIT bounds the search.
1886 Return a list whose CAR is `property-drawer' and CDR is a plist
1887 containing `:begin', `:end', `:hiddenp', `:contents-begin',
1888 `:contents-end', `:properties' and `:post-blank' keywords.
1890 Assume point is at the beginning of the property drawer."
1891 (save-excursion
1892 (let ((case-fold-search t)
1893 (begin (point))
1894 (prop-begin (progn (forward-line) (point)))
1895 (hidden (org-invisible-p2))
1896 (properties
1897 (let (val)
1898 (while (not (looking-at "^[ \t]*:END:"))
1899 (when (looking-at "[ \t]*:\\([A-Za-z][-_A-Za-z0-9]*\\):")
1900 (push (cons (org-match-string-no-properties 1)
1901 (org-trim
1902 (buffer-substring-no-properties
1903 (match-end 0) (point-at-eol))))
1904 val))
1905 (forward-line))
1906 val))
1907 (prop-end (progn (re-search-forward "^[ \t]*:END:" limit t)
1908 (point-at-bol)))
1909 (pos-before-blank (progn (forward-line) (point)))
1910 (end (progn (skip-chars-forward " \r\t\n" limit)
1911 (if (eobp) (point) (point-at-bol)))))
1912 (list 'property-drawer
1913 (list :begin begin
1914 :end end
1915 :hiddenp hidden
1916 :properties properties
1917 :post-blank (count-lines pos-before-blank end))))))
1919 (defun org-element-property-drawer-interpreter (property-drawer contents)
1920 "Interpret PROPERTY-DRAWER element as Org syntax.
1921 CONTENTS is nil."
1922 (let ((props (org-element-property :properties property-drawer)))
1923 (concat
1924 ":PROPERTIES:\n"
1925 (mapconcat (lambda (p)
1926 (format org-property-format (format ":%s:" (car p)) (cdr p)))
1927 (nreverse props) "\n")
1928 "\n:END:")))
1931 ;;;; Quote Section
1933 (defun org-element-quote-section-parser (limit)
1934 "Parse a quote section.
1936 LIMIT bounds the search.
1938 Return a list whose CAR is `quote-section' and CDR is a plist
1939 containing `:begin', `:end', `:value' and `:post-blank' keywords.
1941 Assume point is at beginning of the section."
1942 (save-excursion
1943 (let* ((begin (point))
1944 (end (progn (org-with-limited-levels (outline-next-heading))
1945 (point)))
1946 (pos-before-blank (progn (skip-chars-backward " \r\t\n")
1947 (forward-line)
1948 (point)))
1949 (value (buffer-substring-no-properties begin pos-before-blank)))
1950 (list 'quote-section
1951 (list :begin begin
1952 :end end
1953 :value value
1954 :post-blank (count-lines pos-before-blank end))))))
1956 (defun org-element-quote-section-interpreter (quote-section contents)
1957 "Interpret QUOTE-SECTION element as Org syntax.
1958 CONTENTS is nil."
1959 (org-element-property :value quote-section))
1962 ;;;; Src Block
1964 (defun org-element-src-block-parser (limit)
1965 "Parse a src block.
1967 LIMIT bounds the search.
1969 Return a list whose CAR is `src-block' and CDR is a plist
1970 containing `:language', `:switches', `:parameters', `:begin',
1971 `:end', `:hiddenp', `:number-lines', `:retain-labels',
1972 `:use-labels', `:label-fmt', `:preserve-indent', `:value' and
1973 `:post-blank' keywords.
1975 Assume point is at the beginning of the block."
1976 (let ((case-fold-search t))
1977 (if (not (save-excursion (re-search-forward "^[ \t]*#\\+END_SRC" limit t)))
1978 ;; Incomplete block: parse it as a paragraph.
1979 (org-element-paragraph-parser limit)
1980 (let ((contents-end (match-beginning 0)))
1981 (save-excursion
1982 (let* ((keywords (org-element--collect-affiliated-keywords))
1983 ;; Get beginning position.
1984 (begin (car keywords))
1985 ;; Get language as a string.
1986 (language
1987 (progn
1988 (looking-at
1989 (concat "^[ \t]*#\\+BEGIN_SRC"
1990 "\\(?: +\\(\\S-+\\)\\)?"
1991 "\\(\\(?: +\\(?:-l \".*?\"\\|[-+][A-Za-z]\\)\\)+\\)?"
1992 "\\(.*\\)[ \t]*$"))
1993 (org-match-string-no-properties 1)))
1994 ;; Get switches.
1995 (switches (org-match-string-no-properties 2))
1996 ;; Get parameters.
1997 (parameters (org-match-string-no-properties 3))
1998 ;; Switches analysis
1999 (number-lines (cond ((not switches) nil)
2000 ((string-match "-n\\>" switches) 'new)
2001 ((string-match "+n\\>" switches) 'continued)))
2002 (preserve-indent (and switches (string-match "-i\\>" switches)))
2003 (label-fmt (and switches
2004 (string-match "-l +\"\\([^\"\n]+\\)\"" switches)
2005 (match-string 1 switches)))
2006 ;; Should labels be retained in (or stripped from)
2007 ;; src blocks?
2008 (retain-labels
2009 (or (not switches)
2010 (not (string-match "-r\\>" switches))
2011 (and number-lines (string-match "-k\\>" switches))))
2012 ;; What should code-references use - labels or
2013 ;; line-numbers?
2014 (use-labels
2015 (or (not switches)
2016 (and retain-labels (not (string-match "-k\\>" switches)))))
2017 ;; Get visibility status.
2018 (hidden (progn (forward-line) (org-invisible-p2)))
2019 ;; Retrieve code.
2020 (value (buffer-substring-no-properties (point) contents-end))
2021 (pos-before-blank (progn (goto-char contents-end)
2022 (forward-line)
2023 (point)))
2024 ;; Get position after ending blank lines.
2025 (end (progn (skip-chars-forward " \r\t\n" limit)
2026 (if (eobp) (point) (point-at-bol)))))
2027 (list 'src-block
2028 (nconc
2029 (list :language language
2030 :switches (and (org-string-nw-p switches)
2031 (org-trim switches))
2032 :parameters (and (org-string-nw-p parameters)
2033 (org-trim parameters))
2034 :begin begin
2035 :end end
2036 :number-lines number-lines
2037 :preserve-indent preserve-indent
2038 :retain-labels retain-labels
2039 :use-labels use-labels
2040 :label-fmt label-fmt
2041 :hiddenp hidden
2042 :value value
2043 :post-blank (count-lines pos-before-blank end))
2044 (cadr keywords)))))))))
2046 (defun org-element-src-block-interpreter (src-block contents)
2047 "Interpret SRC-BLOCK element as Org syntax.
2048 CONTENTS is nil."
2049 (let ((lang (org-element-property :language src-block))
2050 (switches (org-element-property :switches src-block))
2051 (params (org-element-property :parameters src-block))
2052 (value (let ((val (org-element-property :value src-block)))
2053 (cond
2055 (org-src-preserve-indentation val)
2056 ((zerop org-edit-src-content-indentation)
2057 (org-remove-indentation val))
2059 (let ((ind (make-string
2060 org-edit-src-content-indentation 32)))
2061 (replace-regexp-in-string
2062 "\\(^\\)[ \t]*\\S-" ind
2063 (org-remove-indentation val) nil nil 1)))))))
2064 (concat (format "#+BEGIN_SRC%s\n"
2065 (concat (and lang (concat " " lang))
2066 (and switches (concat " " switches))
2067 (and params (concat " " params))))
2068 value
2069 "#+END_SRC")))
2072 ;;;; Table
2074 (defun org-element-table-parser (limit)
2075 "Parse a table at point.
2077 LIMIT bounds the search.
2079 Return a list whose CAR is `table' and CDR is a plist containing
2080 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2081 `:contents-end', `:value' and `:post-blank' keywords.
2083 Assume point is at the beginning of the table."
2084 (save-excursion
2085 (let* ((case-fold-search t)
2086 (table-begin (point))
2087 (type (if (org-at-table.el-p) 'table.el 'org))
2088 (keywords (org-element--collect-affiliated-keywords))
2089 (begin (car keywords))
2090 (table-end (goto-char (marker-position (org-table-end t))))
2091 (tblfm (let (acc)
2092 (while (looking-at "[ \t]*#\\+TBLFM: +\\(.*\\)[ \t]*$")
2093 (push (org-match-string-no-properties 1) acc)
2094 (forward-line))
2095 acc))
2096 (pos-before-blank (point))
2097 (end (progn (skip-chars-forward " \r\t\n" limit)
2098 (if (eobp) (point) (point-at-bol)))))
2099 (list 'table
2100 (nconc
2101 (list :begin begin
2102 :end end
2103 :type type
2104 :tblfm tblfm
2105 ;; Only `org' tables have contents. `table.el' tables
2106 ;; use a `:value' property to store raw table as
2107 ;; a string.
2108 :contents-begin (and (eq type 'org) table-begin)
2109 :contents-end (and (eq type 'org) table-end)
2110 :value (and (eq type 'table.el)
2111 (buffer-substring-no-properties
2112 table-begin table-end))
2113 :post-blank (count-lines pos-before-blank end))
2114 (cadr keywords))))))
2116 (defun org-element-table-interpreter (table contents)
2117 "Interpret TABLE element as Org syntax.
2118 CONTENTS is nil."
2119 (if (eq (org-element-property :type table) 'table.el)
2120 (org-remove-indentation (org-element-property :value table))
2121 (concat (with-temp-buffer (insert contents)
2122 (org-table-align)
2123 (buffer-string))
2124 (mapconcat (lambda (fm) (concat "#+TBLFM: " fm))
2125 (reverse (org-element-property :tblfm table))
2126 "\n"))))
2129 ;;;; Table Row
2131 (defun org-element-table-row-parser (limit)
2132 "Parse table row at point.
2134 LIMIT bounds the search.
2136 Return a list whose CAR is `table-row' and CDR is a plist
2137 containing `:begin', `:end', `:contents-begin', `:contents-end',
2138 `:type' and `:post-blank' keywords."
2139 (save-excursion
2140 (let* ((type (if (looking-at "^[ \t]*|-") 'rule 'standard))
2141 (begin (point))
2142 ;; A table rule has no contents. In that case, ensure
2143 ;; CONTENTS-BEGIN matches CONTENTS-END.
2144 (contents-begin (and (eq type 'standard)
2145 (search-forward "|")
2146 (point)))
2147 (contents-end (and (eq type 'standard)
2148 (progn
2149 (end-of-line)
2150 (skip-chars-backward " \t")
2151 (point))))
2152 (end (progn (forward-line) (point))))
2153 (list 'table-row
2154 (list :type type
2155 :begin begin
2156 :end end
2157 :contents-begin contents-begin
2158 :contents-end contents-end
2159 :post-blank 0)))))
2161 (defun org-element-table-row-interpreter (table-row contents)
2162 "Interpret TABLE-ROW element as Org syntax.
2163 CONTENTS is the contents of the table row."
2164 (if (eq (org-element-property :type table-row) 'rule) "|-"
2165 (concat "| " contents)))
2168 ;;;; Verse Block
2170 (defun org-element-verse-block-parser (limit)
2171 "Parse a verse block.
2173 LIMIT bounds the search.
2175 Return a list whose CAR is `verse-block' and CDR is a plist
2176 containing `:begin', `:end', `:contents-begin', `:contents-end',
2177 `:hiddenp' and `:post-blank' keywords.
2179 Assume point is at beginning of the block."
2180 (let ((case-fold-search t))
2181 (if (not (save-excursion
2182 (re-search-forward "^[ \t]*#\\+END_VERSE" limit t)))
2183 ;; Incomplete block: parse it as a paragraph.
2184 (org-element-paragraph-parser limit)
2185 (let ((contents-end (match-beginning 0)))
2186 (save-excursion
2187 (let* ((keywords (org-element--collect-affiliated-keywords))
2188 (begin (car keywords))
2189 (hidden (progn (forward-line) (org-invisible-p2)))
2190 (contents-begin (point))
2191 (pos-before-blank (progn (goto-char contents-end)
2192 (forward-line)
2193 (point)))
2194 (end (progn (skip-chars-forward " \r\t\n" limit)
2195 (if (eobp) (point) (point-at-bol)))))
2196 (list 'verse-block
2197 (nconc
2198 (list :begin begin
2199 :end end
2200 :contents-begin contents-begin
2201 :contents-end contents-end
2202 :hiddenp hidden
2203 :post-blank (count-lines pos-before-blank end))
2204 (cadr keywords)))))))))
2206 (defun org-element-verse-block-interpreter (verse-block contents)
2207 "Interpret VERSE-BLOCK element as Org syntax.
2208 CONTENTS is verse block contents."
2209 (format "#+BEGIN_VERSE\n%s#+END_VERSE" contents))
2213 ;;; Objects
2215 ;; Unlike to elements, interstices can be found between objects.
2216 ;; That's why, along with the parser, successor functions are provided
2217 ;; for each object. Some objects share the same successor (i.e. `code'
2218 ;; and `verbatim' objects).
2220 ;; A successor must accept a single argument bounding the search. It
2221 ;; will return either a cons cell whose CAR is the object's type, as
2222 ;; a symbol, and CDR the position of its next occurrence, or nil.
2224 ;; Successors follow the naming convention:
2225 ;; org-element-NAME-successor, where NAME is the name of the
2226 ;; successor, as defined in `org-element-all-successors'.
2228 ;; Some object types (i.e. `italic') are recursive. Restrictions on
2229 ;; object types they can contain will be specified in
2230 ;; `org-element-object-restrictions'.
2232 ;; Adding a new type of object is simple. Implement a successor,
2233 ;; a parser, and an interpreter for it, all following the naming
2234 ;; convention. Register type in `org-element-all-objects' and
2235 ;; successor in `org-element-all-successors'. Maybe tweak
2236 ;; restrictions about it, and that's it.
2239 ;;;; Bold
2241 (defun org-element-bold-parser ()
2242 "Parse bold object at point.
2244 Return a list whose CAR is `bold' and CDR is a plist with
2245 `:begin', `:end', `:contents-begin' and `:contents-end' and
2246 `:post-blank' keywords.
2248 Assume point is at the first star marker."
2249 (save-excursion
2250 (unless (bolp) (backward-char 1))
2251 (looking-at org-emph-re)
2252 (let ((begin (match-beginning 2))
2253 (contents-begin (match-beginning 4))
2254 (contents-end (match-end 4))
2255 (post-blank (progn (goto-char (match-end 2))
2256 (skip-chars-forward " \t")))
2257 (end (point)))
2258 (list 'bold
2259 (list :begin begin
2260 :end end
2261 :contents-begin contents-begin
2262 :contents-end contents-end
2263 :post-blank post-blank)))))
2265 (defun org-element-bold-interpreter (bold contents)
2266 "Interpret BOLD object as Org syntax.
2267 CONTENTS is the contents of the object."
2268 (format "*%s*" contents))
2270 (defun org-element-text-markup-successor (limit)
2271 "Search for the next text-markup object.
2273 LIMIT bounds the search.
2275 Return value is a cons cell whose CAR is a symbol among `bold',
2276 `italic', `underline', `strike-through', `code' and `verbatim'
2277 and CDR is beginning position."
2278 (save-excursion
2279 (unless (bolp) (backward-char))
2280 (when (re-search-forward org-emph-re limit t)
2281 (let ((marker (match-string 3)))
2282 (cons (cond
2283 ((equal marker "*") 'bold)
2284 ((equal marker "/") 'italic)
2285 ((equal marker "_") 'underline)
2286 ((equal marker "+") 'strike-through)
2287 ((equal marker "~") 'code)
2288 ((equal marker "=") 'verbatim)
2289 (t (error "Unknown marker at %d" (match-beginning 3))))
2290 (match-beginning 2))))))
2293 ;;;; Code
2295 (defun org-element-code-parser ()
2296 "Parse code object at point.
2298 Return a list whose CAR is `code' and CDR is a plist with
2299 `:value', `:begin', `:end' and `:post-blank' keywords.
2301 Assume point is at the first tilde marker."
2302 (save-excursion
2303 (unless (bolp) (backward-char 1))
2304 (looking-at org-emph-re)
2305 (let ((begin (match-beginning 2))
2306 (value (org-match-string-no-properties 4))
2307 (post-blank (progn (goto-char (match-end 2))
2308 (skip-chars-forward " \t")))
2309 (end (point)))
2310 (list 'code
2311 (list :value value
2312 :begin begin
2313 :end end
2314 :post-blank post-blank)))))
2316 (defun org-element-code-interpreter (code contents)
2317 "Interpret CODE object as Org syntax.
2318 CONTENTS is nil."
2319 (format "~%s~" (org-element-property :value code)))
2322 ;;;; Entity
2324 (defun org-element-entity-parser ()
2325 "Parse entity at point.
2327 Return a list whose CAR is `entity' and CDR a plist with
2328 `:begin', `:end', `:latex', `:latex-math-p', `:html', `:latin1',
2329 `:utf-8', `:ascii', `:use-brackets-p' and `:post-blank' as
2330 keywords.
2332 Assume point is at the beginning of the entity."
2333 (save-excursion
2334 (looking-at "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)")
2335 (let* ((value (org-entity-get (match-string 1)))
2336 (begin (match-beginning 0))
2337 (bracketsp (string= (match-string 2) "{}"))
2338 (post-blank (progn (goto-char (match-end 1))
2339 (when bracketsp (forward-char 2))
2340 (skip-chars-forward " \t")))
2341 (end (point)))
2342 (list 'entity
2343 (list :name (car value)
2344 :latex (nth 1 value)
2345 :latex-math-p (nth 2 value)
2346 :html (nth 3 value)
2347 :ascii (nth 4 value)
2348 :latin1 (nth 5 value)
2349 :utf-8 (nth 6 value)
2350 :begin begin
2351 :end end
2352 :use-brackets-p bracketsp
2353 :post-blank post-blank)))))
2355 (defun org-element-entity-interpreter (entity contents)
2356 "Interpret ENTITY object as Org syntax.
2357 CONTENTS is nil."
2358 (concat "\\"
2359 (org-element-property :name entity)
2360 (when (org-element-property :use-brackets-p entity) "{}")))
2362 (defun org-element-latex-or-entity-successor (limit)
2363 "Search for the next latex-fragment or entity object.
2365 LIMIT bounds the search.
2367 Return value is a cons cell whose CAR is `entity' or
2368 `latex-fragment' and CDR is beginning position."
2369 (save-excursion
2370 (let ((matchers
2371 (remove "begin" (plist-get org-format-latex-options :matchers)))
2372 ;; ENTITY-RE matches both LaTeX commands and Org entities.
2373 (entity-re
2374 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))
2375 (when (re-search-forward
2376 (concat (mapconcat (lambda (e) (nth 1 (assoc e org-latex-regexps)))
2377 matchers "\\|")
2378 "\\|" entity-re)
2379 limit t)
2380 (goto-char (match-beginning 0))
2381 (if (looking-at entity-re)
2382 ;; Determine if it's a real entity or a LaTeX command.
2383 (cons (if (org-entity-get (match-string 1)) 'entity 'latex-fragment)
2384 (match-beginning 0))
2385 ;; No entity nor command: point is at a LaTeX fragment.
2386 ;; Determine its type to get the correct beginning position.
2387 (cons 'latex-fragment
2388 (catch 'return
2389 (mapc (lambda (e)
2390 (when (looking-at (nth 1 (assoc e org-latex-regexps)))
2391 (throw 'return
2392 (match-beginning
2393 (nth 2 (assoc e org-latex-regexps))))))
2394 matchers)
2395 (point))))))))
2398 ;;;; Export Snippet
2400 (defun org-element-export-snippet-parser ()
2401 "Parse export snippet at point.
2403 Return a list whose CAR is `export-snippet' and CDR a plist with
2404 `:begin', `:end', `:back-end', `:value' and `:post-blank' as
2405 keywords.
2407 Assume point is at the beginning of the snippet."
2408 (save-excursion
2409 (re-search-forward "@@\\([-A-Za-z0-9]+\\):" nil t)
2410 (let* ((begin (match-beginning 0))
2411 (back-end (org-match-string-no-properties 1))
2412 (value (buffer-substring-no-properties
2413 (point)
2414 (progn (re-search-forward "@@" nil t) (match-beginning 0))))
2415 (post-blank (skip-chars-forward " \t"))
2416 (end (point)))
2417 (list 'export-snippet
2418 (list :back-end back-end
2419 :value value
2420 :begin begin
2421 :end end
2422 :post-blank post-blank)))))
2424 (defun org-element-export-snippet-interpreter (export-snippet contents)
2425 "Interpret EXPORT-SNIPPET object as Org syntax.
2426 CONTENTS is nil."
2427 (format "@@%s:%s@@"
2428 (org-element-property :back-end export-snippet)
2429 (org-element-property :value export-snippet)))
2431 (defun org-element-export-snippet-successor (limit)
2432 "Search for the next export-snippet object.
2434 LIMIT bounds the search.
2436 Return value is a cons cell whose CAR is `export-snippet' and CDR
2437 its beginning position."
2438 (save-excursion
2439 (let (beg)
2440 (when (and (re-search-forward "@@[-A-Za-z0-9]+:" limit t)
2441 (setq beg (match-beginning 0))
2442 (search-forward "@@" limit t))
2443 (cons 'export-snippet beg)))))
2446 ;;;; Footnote Reference
2448 (defun org-element-footnote-reference-parser ()
2449 "Parse footnote reference at point.
2451 Return a list whose CAR is `footnote-reference' and CDR a plist
2452 with `:label', `:type', `:inline-definition', `:begin', `:end'
2453 and `:post-blank' as keywords."
2454 (save-excursion
2455 (looking-at org-footnote-re)
2456 (let* ((begin (point))
2457 (label (or (org-match-string-no-properties 2)
2458 (org-match-string-no-properties 3)
2459 (and (match-string 1)
2460 (concat "fn:" (org-match-string-no-properties 1)))))
2461 (type (if (or (not label) (match-string 1)) 'inline 'standard))
2462 (inner-begin (match-end 0))
2463 (inner-end
2464 (let ((count 1))
2465 (forward-char)
2466 (while (and (> count 0) (re-search-forward "[][]" nil t))
2467 (if (equal (match-string 0) "[") (incf count) (decf count)))
2468 (1- (point))))
2469 (post-blank (progn (goto-char (1+ inner-end))
2470 (skip-chars-forward " \t")))
2471 (end (point))
2472 (footnote-reference
2473 (list 'footnote-reference
2474 (list :label label
2475 :type type
2476 :begin begin
2477 :end end
2478 :post-blank post-blank))))
2479 (org-element-put-property
2480 footnote-reference :inline-definition
2481 (and (eq type 'inline)
2482 (org-element-parse-secondary-string
2483 (buffer-substring inner-begin inner-end)
2484 (org-element-restriction 'footnote-reference)
2485 footnote-reference))))))
2487 (defun org-element-footnote-reference-interpreter (footnote-reference contents)
2488 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2489 CONTENTS is nil."
2490 (let ((label (or (org-element-property :label footnote-reference) "fn:"))
2491 (def
2492 (let ((inline-def
2493 (org-element-property :inline-definition footnote-reference)))
2494 (if (not inline-def) ""
2495 (concat ":" (org-element-interpret-data inline-def))))))
2496 (format "[%s]" (concat label def))))
2498 (defun org-element-footnote-reference-successor (limit)
2499 "Search for the next footnote-reference object.
2501 LIMIT bounds the search.
2503 Return value is a cons cell whose CAR is `footnote-reference' and
2504 CDR is beginning position."
2505 (save-excursion
2506 (catch 'exit
2507 (while (re-search-forward org-footnote-re limit t)
2508 (save-excursion
2509 (let ((beg (match-beginning 0))
2510 (count 1))
2511 (backward-char)
2512 (while (re-search-forward "[][]" limit t)
2513 (if (equal (match-string 0) "[") (incf count) (decf count))
2514 (when (zerop count)
2515 (throw 'exit (cons 'footnote-reference beg))))))))))
2518 ;;;; Inline Babel Call
2520 (defun org-element-inline-babel-call-parser ()
2521 "Parse inline babel call at point.
2523 Return a list whose CAR is `inline-babel-call' and CDR a plist
2524 with `:begin', `:end', `:info' and `:post-blank' as keywords.
2526 Assume point is at the beginning of the babel call."
2527 (save-excursion
2528 (unless (bolp) (backward-char))
2529 (looking-at org-babel-inline-lob-one-liner-regexp)
2530 (let ((info (save-match-data (org-babel-lob-get-info)))
2531 (begin (match-end 1))
2532 (post-blank (progn (goto-char (match-end 0))
2533 (skip-chars-forward " \t")))
2534 (end (point)))
2535 (list 'inline-babel-call
2536 (list :begin begin
2537 :end end
2538 :info info
2539 :post-blank post-blank)))))
2541 (defun org-element-inline-babel-call-interpreter (inline-babel-call contents)
2542 "Interpret INLINE-BABEL-CALL object as Org syntax.
2543 CONTENTS is nil."
2544 (let* ((babel-info (org-element-property :info inline-babel-call))
2545 (main-source (car babel-info))
2546 (post-options (nth 1 babel-info)))
2547 (concat "call_"
2548 (if (string-match "\\[\\(\\[.*?\\]\\)\\]" main-source)
2549 ;; Remove redundant square brackets.
2550 (replace-match
2551 (match-string 1 main-source) nil nil main-source)
2552 main-source)
2553 (and post-options (format "[%s]" post-options)))))
2555 (defun org-element-inline-babel-call-successor (limit)
2556 "Search for the next inline-babel-call object.
2558 LIMIT bounds the search.
2560 Return value is a cons cell whose CAR is `inline-babel-call' and
2561 CDR is beginning position."
2562 (save-excursion
2563 ;; Use a simplified version of
2564 ;; `org-babel-inline-lob-one-liner-regexp'.
2565 (when (re-search-forward
2566 "call_\\([^()\n]+?\\)\\(?:\\[.*?\\]\\)?([^\n]*?)\\(\\[.*?\\]\\)?"
2567 limit t)
2568 (cons 'inline-babel-call (match-beginning 0)))))
2571 ;;;; Inline Src Block
2573 (defun org-element-inline-src-block-parser ()
2574 "Parse inline source block at point.
2576 LIMIT bounds the search.
2578 Return a list whose CAR is `inline-src-block' and CDR a plist
2579 with `:begin', `:end', `:language', `:value', `:parameters' and
2580 `:post-blank' as keywords.
2582 Assume point is at the beginning of the inline src block."
2583 (save-excursion
2584 (unless (bolp) (backward-char))
2585 (looking-at org-babel-inline-src-block-regexp)
2586 (let ((begin (match-beginning 1))
2587 (language (org-match-string-no-properties 2))
2588 (parameters (org-match-string-no-properties 4))
2589 (value (org-match-string-no-properties 5))
2590 (post-blank (progn (goto-char (match-end 0))
2591 (skip-chars-forward " \t")))
2592 (end (point)))
2593 (list 'inline-src-block
2594 (list :language language
2595 :value value
2596 :parameters parameters
2597 :begin begin
2598 :end end
2599 :post-blank post-blank)))))
2601 (defun org-element-inline-src-block-interpreter (inline-src-block contents)
2602 "Interpret INLINE-SRC-BLOCK object as Org syntax.
2603 CONTENTS is nil."
2604 (let ((language (org-element-property :language inline-src-block))
2605 (arguments (org-element-property :parameters inline-src-block))
2606 (body (org-element-property :value inline-src-block)))
2607 (format "src_%s%s{%s}"
2608 language
2609 (if arguments (format "[%s]" arguments) "")
2610 body)))
2612 (defun org-element-inline-src-block-successor (limit)
2613 "Search for the next inline-babel-call element.
2615 LIMIT bounds the search.
2617 Return value is a cons cell whose CAR is `inline-babel-call' and
2618 CDR is beginning position."
2619 (save-excursion
2620 (unless (bolp) (backward-char))
2621 (when (re-search-forward org-babel-inline-src-block-regexp limit t)
2622 (cons 'inline-src-block (match-beginning 1)))))
2624 ;;;; Italic
2626 (defun org-element-italic-parser ()
2627 "Parse italic object at point.
2629 Return a list whose CAR is `italic' and CDR is a plist with
2630 `:begin', `:end', `:contents-begin' and `:contents-end' and
2631 `:post-blank' keywords.
2633 Assume point is at the first slash marker."
2634 (save-excursion
2635 (unless (bolp) (backward-char 1))
2636 (looking-at org-emph-re)
2637 (let ((begin (match-beginning 2))
2638 (contents-begin (match-beginning 4))
2639 (contents-end (match-end 4))
2640 (post-blank (progn (goto-char (match-end 2))
2641 (skip-chars-forward " \t")))
2642 (end (point)))
2643 (list 'italic
2644 (list :begin begin
2645 :end end
2646 :contents-begin contents-begin
2647 :contents-end contents-end
2648 :post-blank post-blank)))))
2650 (defun org-element-italic-interpreter (italic contents)
2651 "Interpret ITALIC object as Org syntax.
2652 CONTENTS is the contents of the object."
2653 (format "/%s/" contents))
2656 ;;;; Latex Fragment
2658 (defun org-element-latex-fragment-parser ()
2659 "Parse latex fragment at point.
2661 Return a list whose CAR is `latex-fragment' and CDR a plist with
2662 `:value', `:begin', `:end', and `:post-blank' as keywords.
2664 Assume point is at the beginning of the latex fragment."
2665 (save-excursion
2666 (let* ((begin (point))
2667 (substring-match
2668 (catch 'exit
2669 (mapc (lambda (e)
2670 (let ((latex-regexp (nth 1 (assoc e org-latex-regexps))))
2671 (when (or (looking-at latex-regexp)
2672 (and (not (bobp))
2673 (save-excursion
2674 (backward-char)
2675 (looking-at latex-regexp))))
2676 (throw 'exit (nth 2 (assoc e org-latex-regexps))))))
2677 (plist-get org-format-latex-options :matchers))
2678 ;; None found: it's a macro.
2679 (looking-at "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")
2681 (value (match-string-no-properties substring-match))
2682 (post-blank (progn (goto-char (match-end substring-match))
2683 (skip-chars-forward " \t")))
2684 (end (point)))
2685 (list 'latex-fragment
2686 (list :value value
2687 :begin begin
2688 :end end
2689 :post-blank post-blank)))))
2691 (defun org-element-latex-fragment-interpreter (latex-fragment contents)
2692 "Interpret LATEX-FRAGMENT object as Org syntax.
2693 CONTENTS is nil."
2694 (org-element-property :value latex-fragment))
2696 ;;;; Line Break
2698 (defun org-element-line-break-parser ()
2699 "Parse line break at point.
2701 Return a list whose CAR is `line-break', and CDR a plist with
2702 `:begin', `:end' and `:post-blank' keywords.
2704 Assume point is at the beginning of the line break."
2705 (list 'line-break (list :begin (point) :end (point-at-eol) :post-blank 0)))
2707 (defun org-element-line-break-interpreter (line-break contents)
2708 "Interpret LINE-BREAK object as Org syntax.
2709 CONTENTS is nil."
2710 "\\\\")
2712 (defun org-element-line-break-successor (limit)
2713 "Search for the next line-break object.
2715 LIMIT bounds the search.
2717 Return value is a cons cell whose CAR is `line-break' and CDR is
2718 beginning position."
2719 (save-excursion
2720 (let ((beg (and (re-search-forward "[^\\\\]\\(\\\\\\\\\\)[ \t]*$" limit t)
2721 (goto-char (match-beginning 1)))))
2722 ;; A line break can only happen on a non-empty line.
2723 (when (and beg (re-search-backward "\\S-" (point-at-bol) t))
2724 (cons 'line-break beg)))))
2727 ;;;; Link
2729 (defun org-element-link-parser ()
2730 "Parse link at point.
2732 Return a list whose CAR is `link' and CDR a plist with `:type',
2733 `:path', `:raw-link', `:application', `:search-option', `:begin',
2734 `:end', `:contents-begin', `:contents-end' and `:post-blank' as
2735 keywords.
2737 Assume point is at the beginning of the link."
2738 (save-excursion
2739 (let ((begin (point))
2740 end contents-begin contents-end link-end post-blank path type
2741 raw-link link search-option application)
2742 (cond
2743 ;; Type 1: Text targeted from a radio target.
2744 ((and org-target-link-regexp (looking-at org-target-link-regexp))
2745 (setq type "radio"
2746 link-end (match-end 0)
2747 path (org-match-string-no-properties 0)))
2748 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
2749 ((looking-at org-bracket-link-regexp)
2750 (setq contents-begin (match-beginning 3)
2751 contents-end (match-end 3)
2752 link-end (match-end 0)
2753 ;; RAW-LINK is the original link.
2754 raw-link (org-match-string-no-properties 1)
2755 link (org-translate-link
2756 (org-link-expand-abbrev
2757 (org-link-unescape raw-link))))
2758 ;; Determine TYPE of link and set PATH accordingly.
2759 (cond
2760 ;; File type.
2761 ((or (file-name-absolute-p link) (string-match "^\\.\\.?/" link))
2762 (setq type "file" path link))
2763 ;; Explicit type (http, irc, bbdb...). See `org-link-types'.
2764 ((string-match org-link-re-with-space3 link)
2765 (setq type (match-string 1 link) path (match-string 2 link)))
2766 ;; Id type: PATH is the id.
2767 ((string-match "^id:\\([-a-f0-9]+\\)" link)
2768 (setq type "id" path (match-string 1 link)))
2769 ;; Code-ref type: PATH is the name of the reference.
2770 ((string-match "^(\\(.*\\))$" link)
2771 (setq type "coderef" path (match-string 1 link)))
2772 ;; Custom-id type: PATH is the name of the custom id.
2773 ((= (aref link 0) ?#)
2774 (setq type "custom-id" path (substring link 1)))
2775 ;; Fuzzy type: Internal link either matches a target, an
2776 ;; headline name or nothing. PATH is the target or
2777 ;; headline's name.
2778 (t (setq type "fuzzy" path link))))
2779 ;; Type 3: Plain link, i.e. http://orgmode.org
2780 ((looking-at org-plain-link-re)
2781 (setq raw-link (org-match-string-no-properties 0)
2782 type (org-match-string-no-properties 1)
2783 path (org-match-string-no-properties 2)
2784 link-end (match-end 0)))
2785 ;; Type 4: Angular link, i.e. <http://orgmode.org>
2786 ((looking-at org-angle-link-re)
2787 (setq raw-link (buffer-substring-no-properties
2788 (match-beginning 1) (match-end 2))
2789 type (org-match-string-no-properties 1)
2790 path (org-match-string-no-properties 2)
2791 link-end (match-end 0))))
2792 ;; In any case, deduce end point after trailing white space from
2793 ;; LINK-END variable.
2794 (setq post-blank (progn (goto-char link-end) (skip-chars-forward " \t"))
2795 end (point))
2796 ;; Extract search option and opening application out of
2797 ;; "file"-type links.
2798 (when (member type org-element-link-type-is-file)
2799 ;; Application.
2800 (cond ((string-match "^file\\+\\(.*\\)$" type)
2801 (setq application (match-string 1 type)))
2802 ((not (string-match "^file" type))
2803 (setq application type)))
2804 ;; Extract search option from PATH.
2805 (when (string-match "::\\(.*\\)$" path)
2806 (setq search-option (match-string 1 path)
2807 path (replace-match "" nil nil path)))
2808 ;; Make sure TYPE always report "file".
2809 (setq type "file"))
2810 (list 'link
2811 (list :type type
2812 :path path
2813 :raw-link (or raw-link path)
2814 :application application
2815 :search-option search-option
2816 :begin begin
2817 :end end
2818 :contents-begin contents-begin
2819 :contents-end contents-end
2820 :post-blank post-blank)))))
2822 (defun org-element-link-interpreter (link contents)
2823 "Interpret LINK object as Org syntax.
2824 CONTENTS is the contents of the object, or nil."
2825 (let ((type (org-element-property :type link))
2826 (raw-link (org-element-property :raw-link link)))
2827 (if (string= type "radio") raw-link
2828 (format "[[%s]%s]"
2829 raw-link
2830 (if contents (format "[%s]" contents) "")))))
2832 (defun org-element-link-successor (limit)
2833 "Search for the next link object.
2835 LIMIT bounds the search.
2837 Return value is a cons cell whose CAR is `link' and CDR is
2838 beginning position."
2839 (save-excursion
2840 (let ((link-regexp
2841 (if (not org-target-link-regexp) org-any-link-re
2842 (concat org-any-link-re "\\|" org-target-link-regexp))))
2843 (when (re-search-forward link-regexp limit t)
2844 (cons 'link (match-beginning 0))))))
2847 ;;;; Macro
2849 (defun org-element-macro-parser ()
2850 "Parse macro at point.
2852 Return a list whose CAR is `macro' and CDR a plist with `:key',
2853 `:args', `:begin', `:end', `:value' and `:post-blank' as
2854 keywords.
2856 Assume point is at the macro."
2857 (save-excursion
2858 (looking-at "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\(([ \t\n]*\\([^\000]*?\\))\\)?}}}")
2859 (let ((begin (point))
2860 (key (downcase (org-match-string-no-properties 1)))
2861 (value (org-match-string-no-properties 0))
2862 (post-blank (progn (goto-char (match-end 0))
2863 (skip-chars-forward " \t")))
2864 (end (point))
2865 (args (let ((args (org-match-string-no-properties 3)) args2)
2866 (when args
2867 (setq args (org-split-string args ","))
2868 (while args
2869 (while (string-match "\\\\\\'" (car args))
2870 ;; Repair bad splits.
2871 (setcar (cdr args) (concat (substring (car args) 0 -1)
2872 "," (nth 1 args)))
2873 (pop args))
2874 (push (pop args) args2))
2875 (mapcar 'org-trim (nreverse args2))))))
2876 (list 'macro
2877 (list :key key
2878 :value value
2879 :args args
2880 :begin begin
2881 :end end
2882 :post-blank post-blank)))))
2884 (defun org-element-macro-interpreter (macro contents)
2885 "Interpret MACRO object as Org syntax.
2886 CONTENTS is nil."
2887 (org-element-property :value macro))
2889 (defun org-element-macro-successor (limit)
2890 "Search for the next macro object.
2892 LIMIT bounds the search.
2894 Return value is cons cell whose CAR is `macro' and CDR is
2895 beginning position."
2896 (save-excursion
2897 (when (re-search-forward
2898 "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\(([ \t\n]*\\([^\000]*?\\))\\)?}}}"
2899 limit t)
2900 (cons 'macro (match-beginning 0)))))
2903 ;;;; Radio-target
2905 (defun org-element-radio-target-parser ()
2906 "Parse radio target at point.
2908 Return a list whose CAR is `radio-target' and CDR a plist with
2909 `:begin', `:end', `:contents-begin', `:contents-end', `:value'
2910 and `:post-blank' as keywords.
2912 Assume point is at the radio target."
2913 (save-excursion
2914 (looking-at org-radio-target-regexp)
2915 (let ((begin (point))
2916 (contents-begin (match-beginning 1))
2917 (contents-end (match-end 1))
2918 (value (org-match-string-no-properties 1))
2919 (post-blank (progn (goto-char (match-end 0))
2920 (skip-chars-forward " \t")))
2921 (end (point)))
2922 (list 'radio-target
2923 (list :begin begin
2924 :end end
2925 :contents-begin contents-begin
2926 :contents-end contents-end
2927 :post-blank post-blank
2928 :value value)))))
2930 (defun org-element-radio-target-interpreter (target contents)
2931 "Interpret TARGET object as Org syntax.
2932 CONTENTS is the contents of the object."
2933 (concat "<<<" contents ">>>"))
2935 (defun org-element-radio-target-successor (limit)
2936 "Search for the next radio-target object.
2938 LIMIT bounds the search.
2940 Return value is a cons cell whose CAR is `radio-target' and CDR
2941 is beginning position."
2942 (save-excursion
2943 (when (re-search-forward org-radio-target-regexp limit t)
2944 (cons 'radio-target (match-beginning 0)))))
2947 ;;;; Statistics Cookie
2949 (defun org-element-statistics-cookie-parser ()
2950 "Parse statistics cookie at point.
2952 Return a list whose CAR is `statistics-cookie', and CDR a plist
2953 with `:begin', `:end', `:value' and `:post-blank' keywords.
2955 Assume point is at the beginning of the statistics-cookie."
2956 (save-excursion
2957 (looking-at "\\[[0-9]*\\(%\\|/[0-9]*\\)\\]")
2958 (let* ((begin (point))
2959 (value (buffer-substring-no-properties
2960 (match-beginning 0) (match-end 0)))
2961 (post-blank (progn (goto-char (match-end 0))
2962 (skip-chars-forward " \t")))
2963 (end (point)))
2964 (list 'statistics-cookie
2965 (list :begin begin
2966 :end end
2967 :value value
2968 :post-blank post-blank)))))
2970 (defun org-element-statistics-cookie-interpreter (statistics-cookie contents)
2971 "Interpret STATISTICS-COOKIE object as Org syntax.
2972 CONTENTS is nil."
2973 (org-element-property :value statistics-cookie))
2975 (defun org-element-statistics-cookie-successor (limit)
2976 "Search for the next statistics cookie object.
2978 LIMIT bounds the search.
2980 Return value is a cons cell whose CAR is `statistics-cookie' and
2981 CDR is beginning position."
2982 (save-excursion
2983 (when (re-search-forward "\\[[0-9]*\\(%\\|/[0-9]*\\)\\]" limit t)
2984 (cons 'statistics-cookie (match-beginning 0)))))
2987 ;;;; Strike-Through
2989 (defun org-element-strike-through-parser ()
2990 "Parse strike-through object at point.
2992 Return a list whose CAR is `strike-through' and CDR is a plist
2993 with `:begin', `:end', `:contents-begin' and `:contents-end' and
2994 `:post-blank' keywords.
2996 Assume point is at the first plus sign marker."
2997 (save-excursion
2998 (unless (bolp) (backward-char 1))
2999 (looking-at org-emph-re)
3000 (let ((begin (match-beginning 2))
3001 (contents-begin (match-beginning 4))
3002 (contents-end (match-end 4))
3003 (post-blank (progn (goto-char (match-end 2))
3004 (skip-chars-forward " \t")))
3005 (end (point)))
3006 (list 'strike-through
3007 (list :begin begin
3008 :end end
3009 :contents-begin contents-begin
3010 :contents-end contents-end
3011 :post-blank post-blank)))))
3013 (defun org-element-strike-through-interpreter (strike-through contents)
3014 "Interpret STRIKE-THROUGH object as Org syntax.
3015 CONTENTS is the contents of the object."
3016 (format "+%s+" contents))
3019 ;;;; Subscript
3021 (defun org-element-subscript-parser ()
3022 "Parse subscript at point.
3024 Return a list whose CAR is `subscript' and CDR a plist with
3025 `:begin', `:end', `:contents-begin', `:contents-end',
3026 `:use-brackets-p' and `:post-blank' as keywords.
3028 Assume point is at the underscore."
3029 (save-excursion
3030 (unless (bolp) (backward-char))
3031 (let ((bracketsp (if (looking-at org-match-substring-with-braces-regexp)
3033 (not (looking-at org-match-substring-regexp))))
3034 (begin (match-beginning 2))
3035 (contents-begin (or (match-beginning 5)
3036 (match-beginning 3)))
3037 (contents-end (or (match-end 5) (match-end 3)))
3038 (post-blank (progn (goto-char (match-end 0))
3039 (skip-chars-forward " \t")))
3040 (end (point)))
3041 (list 'subscript
3042 (list :begin begin
3043 :end end
3044 :use-brackets-p bracketsp
3045 :contents-begin contents-begin
3046 :contents-end contents-end
3047 :post-blank post-blank)))))
3049 (defun org-element-subscript-interpreter (subscript contents)
3050 "Interpret SUBSCRIPT object as Org syntax.
3051 CONTENTS is the contents of the object."
3052 (format
3053 (if (org-element-property :use-brackets-p subscript) "_{%s}" "_%s")
3054 contents))
3056 (defun org-element-sub/superscript-successor (limit)
3057 "Search for the next sub/superscript object.
3059 LIMIT bounds the search.
3061 Return value is a cons cell whose CAR is either `subscript' or
3062 `superscript' and CDR is beginning position."
3063 (save-excursion
3064 (when (re-search-forward org-match-substring-regexp limit t)
3065 (cons (if (string= (match-string 2) "_") 'subscript 'superscript)
3066 (match-beginning 2)))))
3069 ;;;; Superscript
3071 (defun org-element-superscript-parser ()
3072 "Parse superscript at point.
3074 Return a list whose CAR is `superscript' and CDR a plist with
3075 `:begin', `:end', `:contents-begin', `:contents-end',
3076 `:use-brackets-p' and `:post-blank' as keywords.
3078 Assume point is at the caret."
3079 (save-excursion
3080 (unless (bolp) (backward-char))
3081 (let ((bracketsp (if (looking-at org-match-substring-with-braces-regexp) t
3082 (not (looking-at org-match-substring-regexp))))
3083 (begin (match-beginning 2))
3084 (contents-begin (or (match-beginning 5)
3085 (match-beginning 3)))
3086 (contents-end (or (match-end 5) (match-end 3)))
3087 (post-blank (progn (goto-char (match-end 0))
3088 (skip-chars-forward " \t")))
3089 (end (point)))
3090 (list 'superscript
3091 (list :begin begin
3092 :end end
3093 :use-brackets-p bracketsp
3094 :contents-begin contents-begin
3095 :contents-end contents-end
3096 :post-blank post-blank)))))
3098 (defun org-element-superscript-interpreter (superscript contents)
3099 "Interpret SUPERSCRIPT object as Org syntax.
3100 CONTENTS is the contents of the object."
3101 (format
3102 (if (org-element-property :use-brackets-p superscript) "^{%s}" "^%s")
3103 contents))
3106 ;;;; Table Cell
3108 (defun org-element-table-cell-parser ()
3109 "Parse table cell at point.
3111 Return a list whose CAR is `table-cell' and CDR is a plist
3112 containing `:begin', `:end', `:contents-begin', `:contents-end'
3113 and `:post-blank' keywords."
3114 (looking-at "[ \t]*\\(.*?\\)[ \t]*|")
3115 (let* ((begin (match-beginning 0))
3116 (end (match-end 0))
3117 (contents-begin (match-beginning 1))
3118 (contents-end (match-end 1)))
3119 (list 'table-cell
3120 (list :begin begin
3121 :end end
3122 :contents-begin contents-begin
3123 :contents-end contents-end
3124 :post-blank 0))))
3126 (defun org-element-table-cell-interpreter (table-cell contents)
3127 "Interpret TABLE-CELL element as Org syntax.
3128 CONTENTS is the contents of the cell, or nil."
3129 (concat " " contents " |"))
3131 (defun org-element-table-cell-successor (limit)
3132 "Search for the next table-cell object.
3134 LIMIT bounds the search.
3136 Return value is a cons cell whose CAR is `table-cell' and CDR is
3137 beginning position."
3138 (when (looking-at "[ \t]*.*?[ \t]+|") (cons 'table-cell (point))))
3141 ;;;; Target
3143 (defun org-element-target-parser ()
3144 "Parse target at point.
3146 Return a list whose CAR is `target' and CDR a plist with
3147 `:begin', `:end', `:value' and `:post-blank' as keywords.
3149 Assume point is at the target."
3150 (save-excursion
3151 (looking-at org-target-regexp)
3152 (let ((begin (point))
3153 (value (org-match-string-no-properties 1))
3154 (post-blank (progn (goto-char (match-end 0))
3155 (skip-chars-forward " \t")))
3156 (end (point)))
3157 (list 'target
3158 (list :begin begin
3159 :end end
3160 :value value
3161 :post-blank post-blank)))))
3163 (defun org-element-target-interpreter (target contents)
3164 "Interpret TARGET object as Org syntax.
3165 CONTENTS is nil."
3166 (format "<<%s>>" (org-element-property :value target)))
3168 (defun org-element-target-successor (limit)
3169 "Search for the next target object.
3171 LIMIT bounds the search.
3173 Return value is a cons cell whose CAR is `target' and CDR is
3174 beginning position."
3175 (save-excursion
3176 (when (re-search-forward org-target-regexp limit t)
3177 (cons 'target (match-beginning 0)))))
3180 ;;;; Timestamp
3182 (defun org-element-timestamp-parser ()
3183 "Parse time stamp at point.
3185 Return a list whose CAR is `timestamp', and CDR a plist with
3186 `:type', `:begin', `:end', `:value' and `:post-blank' keywords.
3188 Assume point is at the beginning of the timestamp."
3189 (save-excursion
3190 (let* ((begin (point))
3191 (activep (eq (char-after) ?<))
3192 (main-value
3193 (progn
3194 (looking-at "[<[]\\(\\(%%\\)?.*?\\)[]>]\\(?:--[<[]\\(.*?\\)[]>]\\)?")
3195 (match-string-no-properties 1)))
3196 (range-end (match-string-no-properties 3))
3197 (type (cond ((match-string 2) 'diary)
3198 ((and activep range-end) 'active-range)
3199 (activep 'active)
3200 (range-end 'inactive-range)
3201 (t 'inactive)))
3202 (post-blank (progn (goto-char (match-end 0))
3203 (skip-chars-forward " \t")))
3204 (end (point)))
3205 (list 'timestamp
3206 (list :type type
3207 :value main-value
3208 :range-end range-end
3209 :begin begin
3210 :end end
3211 :post-blank post-blank)))))
3213 (defun org-element-timestamp-interpreter (timestamp contents)
3214 "Interpret TIMESTAMP object as Org syntax.
3215 CONTENTS is nil."
3216 (let ((type (org-element-property :type timestamp) ))
3217 (concat
3218 (format (if (memq type '(inactive inactive-range)) "[%s]" "<%s>")
3219 (org-element-property :value timestamp))
3220 (let ((range-end (org-element-property :range-end timestamp)))
3221 (when range-end
3222 (concat "--"
3223 (format (if (eq type 'inactive-range) "[%s]" "<%s>")
3224 range-end)))))))
3226 (defun org-element-timestamp-successor (limit)
3227 "Search for the next timestamp object.
3229 LIMIT bounds the search.
3231 Return value is a cons cell whose CAR is `timestamp' and CDR is
3232 beginning position."
3233 (save-excursion
3234 (when (re-search-forward
3235 (concat org-ts-regexp-both
3236 "\\|"
3237 "\\(?:<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[dwmy]>\\)"
3238 "\\|"
3239 "\\(?:<%%\\(?:([^>\n]+)\\)>\\)")
3240 limit t)
3241 (cons 'timestamp (match-beginning 0)))))
3244 ;;;; Underline
3246 (defun org-element-underline-parser ()
3247 "Parse underline object at point.
3249 Return a list whose CAR is `underline' and CDR is a plist with
3250 `:begin', `:end', `:contents-begin' and `:contents-end' and
3251 `:post-blank' keywords.
3253 Assume point is at the first underscore marker."
3254 (save-excursion
3255 (unless (bolp) (backward-char 1))
3256 (looking-at org-emph-re)
3257 (let ((begin (match-beginning 2))
3258 (contents-begin (match-beginning 4))
3259 (contents-end (match-end 4))
3260 (post-blank (progn (goto-char (match-end 2))
3261 (skip-chars-forward " \t")))
3262 (end (point)))
3263 (list 'underline
3264 (list :begin begin
3265 :end end
3266 :contents-begin contents-begin
3267 :contents-end contents-end
3268 :post-blank post-blank)))))
3270 (defun org-element-underline-interpreter (underline contents)
3271 "Interpret UNDERLINE object as Org syntax.
3272 CONTENTS is the contents of the object."
3273 (format "_%s_" contents))
3276 ;;;; Verbatim
3278 (defun org-element-verbatim-parser ()
3279 "Parse verbatim object at point.
3281 Return a list whose CAR is `verbatim' and CDR is a plist with
3282 `:value', `:begin', `:end' and `:post-blank' keywords.
3284 Assume point is at the first equal sign marker."
3285 (save-excursion
3286 (unless (bolp) (backward-char 1))
3287 (looking-at org-emph-re)
3288 (let ((begin (match-beginning 2))
3289 (value (org-match-string-no-properties 4))
3290 (post-blank (progn (goto-char (match-end 2))
3291 (skip-chars-forward " \t")))
3292 (end (point)))
3293 (list 'verbatim
3294 (list :value value
3295 :begin begin
3296 :end end
3297 :post-blank post-blank)))))
3299 (defun org-element-verbatim-interpreter (verbatim contents)
3300 "Interpret VERBATIM object as Org syntax.
3301 CONTENTS is nil."
3302 (format "=%s=" (org-element-property :value verbatim)))
3306 ;;; Parsing Element Starting At Point
3308 ;; `org-element--current-element' is the core function of this section.
3309 ;; It returns the Lisp representation of the element starting at
3310 ;; point.
3312 ;; `org-element--current-element' makes use of special modes. They
3313 ;; are activated for fixed element chaining (i.e. `plain-list' >
3314 ;; `item') or fixed conditional element chaining (i.e. `headline' >
3315 ;; `section'). Special modes are: `first-section', `section',
3316 ;; `quote-section', `item' and `table-row'.
3318 (defun org-element--current-element
3319 (limit &optional granularity special structure)
3320 "Parse the element starting at point.
3322 LIMIT bounds the search.
3324 Return value is a list like (TYPE PROPS) where TYPE is the type
3325 of the element and PROPS a plist of properties associated to the
3326 element.
3328 Possible types are defined in `org-element-all-elements'.
3330 Optional argument GRANULARITY determines the depth of the
3331 recursion. Allowed values are `headline', `greater-element',
3332 `element', `object' or nil. When it is broader than `object' (or
3333 nil), secondary values will not be parsed, since they only
3334 contain objects.
3336 Optional argument SPECIAL, when non-nil, can be either
3337 `first-section', `section', `quote-section', `table-row' and
3338 `item'.
3340 If STRUCTURE isn't provided but SPECIAL is set to `item', it will
3341 be computed.
3343 This function assumes point is always at the beginning of the
3344 element it has to parse."
3345 (save-excursion
3346 ;; If point is at an affiliated keyword, try moving to the
3347 ;; beginning of the associated element. If none is found, the
3348 ;; keyword is orphaned and will be treated as plain text.
3349 (when (looking-at org-element--affiliated-re)
3350 (let ((opoint (point)))
3351 (while (looking-at org-element--affiliated-re) (forward-line))
3352 (when (looking-at "[ \t]*$") (goto-char opoint))))
3353 (let ((case-fold-search t)
3354 ;; Determine if parsing depth allows for secondary strings
3355 ;; parsing. It only applies to elements referenced in
3356 ;; `org-element-secondary-value-alist'.
3357 (raw-secondary-p (and granularity (not (eq granularity 'object)))))
3358 (cond
3359 ;; Item.
3360 ((eq special 'item)
3361 (org-element-item-parser limit structure raw-secondary-p))
3362 ;; Table Row.
3363 ((eq special 'table-row) (org-element-table-row-parser limit))
3364 ;; Headline.
3365 ((org-with-limited-levels (org-at-heading-p))
3366 (org-element-headline-parser limit raw-secondary-p))
3367 ;; Sections (must be checked after headline).
3368 ((eq special 'section) (org-element-section-parser limit))
3369 ((eq special 'quote-section) (org-element-quote-section-parser limit))
3370 ((eq special 'first-section)
3371 (org-element-section-parser
3372 (or (save-excursion (org-with-limited-levels (outline-next-heading)))
3373 limit)))
3374 ;; When not at bol, point is at the beginning of an item or
3375 ;; a footnote definition: next item is always a paragraph.
3376 ((not (bolp)) (org-element-paragraph-parser limit))
3377 ;; Planning and Clock.
3378 ((and (looking-at org-planning-or-clock-line-re))
3379 (if (equal (match-string 1) org-clock-string)
3380 (org-element-clock-parser limit)
3381 (org-element-planning-parser limit)))
3382 ;; Inlinetask.
3383 ((org-at-heading-p)
3384 (org-element-inlinetask-parser limit raw-secondary-p))
3385 ;; LaTeX Environment.
3386 ((looking-at "[ \t]*\\\\begin{\\([A-Za-z0-9*]+\\)}")
3387 (if (save-excursion
3388 (re-search-forward
3389 (format "[ \t]*\\\\end{%s}[ \t]*"
3390 (regexp-quote (match-string 1)))
3391 nil t))
3392 (org-element-latex-environment-parser limit)
3393 (org-element-paragraph-parser limit)))
3394 ;; Drawer and Property Drawer.
3395 ((looking-at org-drawer-regexp)
3396 (let ((name (match-string 1)))
3397 (cond
3398 ((not (save-excursion
3399 (re-search-forward "^[ \t]*:END:[ \t]*$" nil t)))
3400 (org-element-paragraph-parser limit))
3401 ((equal "PROPERTIES" name)
3402 (org-element-property-drawer-parser limit))
3403 (t (org-element-drawer-parser limit)))))
3404 ;; Fixed Width
3405 ((looking-at "[ \t]*:\\( \\|$\\)")
3406 (org-element-fixed-width-parser limit))
3407 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3408 ;; Keywords.
3409 ((looking-at "[ \t]*#")
3410 (goto-char (match-end 0))
3411 (cond ((looking-at "\\(?: \\|$\\)")
3412 (beginning-of-line)
3413 (org-element-comment-parser limit))
3414 ((looking-at "\\+BEGIN_\\(\\S-+\\)")
3415 (beginning-of-line)
3416 (let ((parser (assoc (upcase (match-string 1))
3417 org-element-block-name-alist)))
3418 (if parser (funcall (cdr parser) limit)
3419 (org-element-special-block-parser limit))))
3420 ((looking-at "\\+CALL:")
3421 (beginning-of-line)
3422 (org-element-babel-call-parser limit))
3423 ((looking-at "\\+BEGIN:? ")
3424 (beginning-of-line)
3425 (org-element-dynamic-block-parser limit))
3426 ((looking-at "\\+\\S-+:")
3427 (beginning-of-line)
3428 (org-element-keyword-parser limit))
3430 (beginning-of-line)
3431 (org-element-paragraph-parser limit))))
3432 ;; Footnote Definition.
3433 ((looking-at org-footnote-definition-re)
3434 (org-element-footnote-definition-parser limit))
3435 ;; Horizontal Rule.
3436 ((looking-at "[ \t]*-\\{5,\\}[ \t]*$")
3437 (org-element-horizontal-rule-parser limit))
3438 ;; Table.
3439 ((org-at-table-p t) (org-element-table-parser limit))
3440 ;; List.
3441 ((looking-at (org-item-re))
3442 (org-element-plain-list-parser limit (or structure (org-list-struct))))
3443 ;; Default element: Paragraph.
3444 (t (org-element-paragraph-parser limit))))))
3447 ;; Most elements can have affiliated keywords. When looking for an
3448 ;; element beginning, we want to move before them, as they belong to
3449 ;; that element, and, in the meantime, collect information they give
3450 ;; into appropriate properties. Hence the following function.
3452 ;; Usage of optional arguments may not be obvious at first glance:
3454 ;; - TRANS-LIST is used to polish keywords names that have evolved
3455 ;; during Org history. In example, even though =result= and
3456 ;; =results= coexist, we want to have them under the same =result=
3457 ;; property. It's also true for "srcname" and "name", where the
3458 ;; latter seems to be preferred nowadays (thus the "name" property).
3460 ;; - CONSED allows to regroup multi-lines keywords under the same
3461 ;; property, while preserving their own identity. This is mostly
3462 ;; used for "attr_latex" and al.
3464 ;; - PARSED prepares a keyword value for export. This is useful for
3465 ;; "caption". Objects restrictions for such keywords are defined in
3466 ;; `org-element-object-restrictions'.
3468 ;; - DUALS is used to take care of keywords accepting a main and an
3469 ;; optional secondary values. For example "results" has its
3470 ;; source's name as the main value, and may have an hash string in
3471 ;; optional square brackets as the secondary one.
3473 ;; A keyword may belong to more than one category.
3475 (defun org-element--collect-affiliated-keywords
3476 (&optional key-re trans-list consed parsed duals)
3477 "Collect affiliated keywords before point.
3479 Optional argument KEY-RE is a regexp matching keywords, which
3480 puts matched keyword in group 1. It defaults to
3481 `org-element--affiliated-re'.
3483 TRANS-LIST is an alist where key is the keyword and value the
3484 property name it should be translated to, without the colons. It
3485 defaults to `org-element-keyword-translation-alist'.
3487 CONSED is a list of strings. Any keyword belonging to that list
3488 will have its value consed. The check is done after keyword
3489 translation. It defaults to `org-element-multiple-keywords'.
3491 PARSED is a list of strings. Any keyword member of this list
3492 will have its value parsed. The check is done after keyword
3493 translation. If a keyword is a member of both CONSED and PARSED,
3494 it's value will be a list of parsed strings. It defaults to
3495 `org-element-parsed-keywords'.
3497 DUALS is a list of strings. Any keyword member of this list can
3498 have two parts: one mandatory and one optional. Its value is
3499 a cons cell whose CAR is the former, and the CDR the latter. If
3500 a keyword is a member of both PARSED and DUALS, both values will
3501 be parsed. It defaults to `org-element-dual-keywords'.
3503 Return a list whose CAR is the position at the first of them and
3504 CDR a plist of keywords and values."
3505 (save-excursion
3506 (let ((case-fold-search t)
3507 (key-re (or key-re org-element--affiliated-re))
3508 (trans-list (or trans-list org-element-keyword-translation-alist))
3509 (consed (or consed org-element-multiple-keywords))
3510 (parsed (or parsed org-element-parsed-keywords))
3511 (duals (or duals org-element-dual-keywords))
3512 ;; RESTRICT is the list of objects allowed in parsed
3513 ;; keywords value.
3514 (restrict (org-element-restriction 'keyword))
3515 output)
3516 (unless (bobp)
3517 (while (and (not (bobp)) (progn (forward-line -1) (looking-at key-re)))
3518 (let* ((raw-kwd (upcase (match-string 1)))
3519 ;; Apply translation to RAW-KWD. From there, KWD is
3520 ;; the official keyword.
3521 (kwd (or (cdr (assoc raw-kwd trans-list)) raw-kwd))
3522 ;; Find main value for any keyword.
3523 (value
3524 (save-match-data
3525 (org-trim
3526 (buffer-substring-no-properties
3527 (match-end 0) (point-at-eol)))))
3528 ;; If KWD is a dual keyword, find its secondary
3529 ;; value. Maybe parse it.
3530 (dual-value
3531 (and (member kwd duals)
3532 (let ((sec (org-match-string-no-properties 2)))
3533 (if (or (not sec) (not (member kwd parsed))) sec
3534 (org-element-parse-secondary-string sec restrict)))))
3535 ;; Attribute a property name to KWD.
3536 (kwd-sym (and kwd (intern (concat ":" (downcase kwd))))))
3537 ;; Now set final shape for VALUE.
3538 (when (member kwd parsed)
3539 (setq value (org-element-parse-secondary-string value restrict)))
3540 (when (member kwd duals)
3541 ;; VALUE is mandatory. Set it to nil if there is none.
3542 (setq value (and value (cons value dual-value))))
3543 ;; Attributes are always consed.
3544 (when (or (member kwd consed) (string-match "^ATTR_" kwd))
3545 (setq value (cons value (plist-get output kwd-sym))))
3546 ;; Eventually store the new value in OUTPUT.
3547 (setq output (plist-put output kwd-sym value))))
3548 (unless (looking-at key-re) (forward-line 1)))
3549 (list (point) output))))
3553 ;;; The Org Parser
3555 ;; The two major functions here are `org-element-parse-buffer', which
3556 ;; parses Org syntax inside the current buffer, taking into account
3557 ;; region, narrowing, or even visibility if specified, and
3558 ;; `org-element-parse-secondary-string', which parses objects within
3559 ;; a given string.
3561 ;; The (almost) almighty `org-element-map' allows to apply a function
3562 ;; on elements or objects matching some type, and accumulate the
3563 ;; resulting values. In an export situation, it also skips unneeded
3564 ;; parts of the parse tree.
3566 (defun org-element-parse-buffer (&optional granularity visible-only)
3567 "Recursively parse the buffer and return structure.
3568 If narrowing is in effect, only parse the visible part of the
3569 buffer.
3571 Optional argument GRANULARITY determines the depth of the
3572 recursion. It can be set to the following symbols:
3574 `headline' Only parse headlines.
3575 `greater-element' Don't recurse into greater elements excepted
3576 headlines and sections. Thus, elements
3577 parsed are the top-level ones.
3578 `element' Parse everything but objects and plain text.
3579 `object' Parse the complete buffer (default).
3581 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3582 elements.
3584 Assume buffer is in Org mode."
3585 (save-excursion
3586 (goto-char (point-min))
3587 (org-skip-whitespace)
3588 (org-element--parse-elements
3589 (point-at-bol) (point-max)
3590 ;; Start in `first-section' mode so text before the first
3591 ;; headline belongs to a section.
3592 'first-section nil granularity visible-only (list 'org-data nil))))
3594 (defun org-element-parse-secondary-string (string restriction &optional parent)
3595 "Recursively parse objects in STRING and return structure.
3597 RESTRICTION is a symbol limiting the object types that will be
3598 looked after.
3600 Optional argument PARENT, when non-nil, is the element or object
3601 containing the secondary string. It is used to set correctly
3602 `:parent' property within the string."
3603 (with-temp-buffer
3604 (insert string)
3605 (let ((secondary (org-element--parse-objects
3606 (point-min) (point-max) nil restriction)))
3607 (mapc (lambda (obj) (org-element-put-property obj :parent parent))
3608 secondary))))
3610 (defun org-element-map (data types fun &optional info first-match no-recursion)
3611 "Map a function on selected elements or objects.
3613 DATA is the parsed tree, as returned by, i.e,
3614 `org-element-parse-buffer'. TYPES is a symbol or list of symbols
3615 of elements or objects types. FUN is the function called on the
3616 matching element or object. It must accept one arguments: the
3617 element or object itself.
3619 When optional argument INFO is non-nil, it should be a plist
3620 holding export options. In that case, parts of the parse tree
3621 not exportable according to that property list will be skipped.
3623 When optional argument FIRST-MATCH is non-nil, stop at the first
3624 match for which FUN doesn't return nil, and return that value.
3626 Optional argument NO-RECURSION is a symbol or a list of symbols
3627 representing elements or objects types. `org-element-map' won't
3628 enter any recursive element or object whose type belongs to that
3629 list. Though, FUN can still be applied on them.
3631 Nil values returned from FUN do not appear in the results."
3632 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
3633 (unless (listp types) (setq types (list types)))
3634 (unless (listp no-recursion) (setq no-recursion (list no-recursion)))
3635 ;; Recursion depth is determined by --CATEGORY.
3636 (let* ((--category
3637 (catch 'found
3638 (let ((category 'greater-elements))
3639 (mapc (lambda (type)
3640 (cond ((or (memq type org-element-all-objects)
3641 (eq type 'plain-text))
3642 ;; If one object is found, the function
3643 ;; has to recurse into every object.
3644 (throw 'found 'objects))
3645 ((not (memq type org-element-greater-elements))
3646 ;; If one regular element is found, the
3647 ;; function has to recurse, at least,
3648 ;; into every element it encounters.
3649 (and (not (eq category 'elements))
3650 (setq category 'elements)))))
3651 types)
3652 category)))
3653 --acc
3654 --walk-tree
3655 (--walk-tree
3656 (function
3657 (lambda (--data)
3658 ;; Recursively walk DATA. INFO, if non-nil, is a plist
3659 ;; holding contextual information.
3660 (let ((--type (org-element-type --data)))
3661 (cond
3662 ((not --data))
3663 ;; Ignored element in an export context.
3664 ((and info (memq --data (plist-get info :ignore-list))))
3665 ;; Secondary string: only objects can be found there.
3666 ((not --type)
3667 (when (eq --category 'objects) (mapc --walk-tree --data)))
3668 ;; Unconditionally enter parse trees.
3669 ((eq --type 'org-data)
3670 (mapc --walk-tree (org-element-contents --data)))
3672 ;; Check if TYPE is matching among TYPES. If so,
3673 ;; apply FUN to --DATA and accumulate return value
3674 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
3675 (when (memq --type types)
3676 (let ((result (funcall fun --data)))
3677 (cond ((not result))
3678 (first-match (throw '--map-first-match result))
3679 (t (push result --acc)))))
3680 ;; If --DATA has a secondary string that can contain
3681 ;; objects with their type among TYPES, look into it.
3682 (when (eq --category 'objects)
3683 (let ((sec-prop
3684 (assq --type org-element-secondary-value-alist)))
3685 (when sec-prop
3686 (funcall --walk-tree
3687 (org-element-property (cdr sec-prop) --data)))))
3688 ;; Determine if a recursion into --DATA is possible.
3689 (cond
3690 ;; --TYPE is explicitly removed from recursion.
3691 ((memq --type no-recursion))
3692 ;; --DATA has no contents.
3693 ((not (org-element-contents --data)))
3694 ;; Looking for greater elements but --DATA is simply
3695 ;; an element or an object.
3696 ((and (eq --category 'greater-elements)
3697 (not (memq --type org-element-greater-elements))))
3698 ;; Looking for elements but --DATA is an object.
3699 ((and (eq --category 'elements)
3700 (memq --type org-element-all-objects)))
3701 ;; In any other case, map contents.
3702 (t (mapc --walk-tree (org-element-contents --data)))))))))))
3703 (catch '--map-first-match
3704 (funcall --walk-tree data)
3705 ;; Return value in a proper order.
3706 (nreverse --acc))))
3708 ;; The following functions are internal parts of the parser.
3710 ;; The first one, `org-element--parse-elements' acts at the element's
3711 ;; level.
3713 ;; The second one, `org-element--parse-objects' applies on all objects
3714 ;; of a paragraph or a secondary string. It uses
3715 ;; `org-element--get-next-object-candidates' to optimize the search of
3716 ;; the next object in the buffer.
3718 ;; More precisely, that function looks for every allowed object type
3719 ;; first. Then, it discards failed searches, keeps further matches,
3720 ;; and searches again types matched behind point, for subsequent
3721 ;; calls. Thus, searching for a given type fails only once, and every
3722 ;; object is searched only once at top level (but sometimes more for
3723 ;; nested types).
3725 (defun org-element--parse-elements
3726 (beg end special structure granularity visible-only acc)
3727 "Parse elements between BEG and END positions.
3729 SPECIAL prioritize some elements over the others. It can be set
3730 to `first-section', `quote-section', `section' `item' or
3731 `table-row'.
3733 When value is `item', STRUCTURE will be used as the current list
3734 structure.
3736 GRANULARITY determines the depth of the recursion. See
3737 `org-element-parse-buffer' for more information.
3739 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
3740 elements.
3742 Elements are accumulated into ACC."
3743 (save-excursion
3744 (goto-char beg)
3745 ;; When parsing only headlines, skip any text before first one.
3746 (when (and (eq granularity 'headline) (not (org-at-heading-p)))
3747 (org-with-limited-levels (outline-next-heading)))
3748 ;; Main loop start.
3749 (while (< (point) end)
3750 ;; Find current element's type and parse it accordingly to
3751 ;; its category.
3752 (let* ((element (org-element--current-element
3753 end granularity special structure))
3754 (type (org-element-type element))
3755 (cbeg (org-element-property :contents-begin element)))
3756 (goto-char (org-element-property :end element))
3757 ;; Fill ELEMENT contents by side-effect.
3758 (cond
3759 ;; If VISIBLE-ONLY is true and element is hidden or if it has
3760 ;; no contents, don't modify it.
3761 ((or (and visible-only (org-element-property :hiddenp element))
3762 (not cbeg)))
3763 ;; Greater element: parse it between `contents-begin' and
3764 ;; `contents-end'. Make sure GRANULARITY allows the
3765 ;; recursion, or ELEMENT is an headline, in which case going
3766 ;; inside is mandatory, in order to get sub-level headings.
3767 ((and (memq type org-element-greater-elements)
3768 (or (memq granularity '(element object nil))
3769 (and (eq granularity 'greater-element)
3770 (eq type 'section))
3771 (eq type 'headline)))
3772 (org-element--parse-elements
3773 cbeg (org-element-property :contents-end element)
3774 ;; Possibly switch to a special mode.
3775 (case type
3776 (headline
3777 (if (org-element-property :quotedp element) 'quote-section
3778 'section))
3779 (plain-list 'item)
3780 (table 'table-row))
3781 (org-element-property :structure element)
3782 granularity visible-only element))
3783 ;; ELEMENT has contents. Parse objects inside, if
3784 ;; GRANULARITY allows it.
3785 ((memq granularity '(object nil))
3786 (org-element--parse-objects
3787 cbeg (org-element-property :contents-end element) element
3788 (org-element-restriction type))))
3789 (org-element-adopt-elements acc element)))
3790 ;; Return result.
3791 acc))
3793 (defun org-element--parse-objects (beg end acc restriction)
3794 "Parse objects between BEG and END and return recursive structure.
3796 Objects are accumulated in ACC.
3798 RESTRICTION is a list of object types which are allowed in the
3799 current object."
3800 (let (candidates)
3801 (save-excursion
3802 (goto-char beg)
3803 (while (and (< (point) end)
3804 (setq candidates (org-element--get-next-object-candidates
3805 end restriction candidates)))
3806 (let ((next-object
3807 (let ((pos (apply 'min (mapcar 'cdr candidates))))
3808 (save-excursion
3809 (goto-char pos)
3810 (funcall (intern (format "org-element-%s-parser"
3811 (car (rassq pos candidates)))))))))
3812 ;; 1. Text before any object. Untabify it.
3813 (let ((obj-beg (org-element-property :begin next-object)))
3814 (unless (= (point) obj-beg)
3815 (setq acc
3816 (org-element-adopt-elements
3818 (replace-regexp-in-string
3819 "\t" (make-string tab-width ? )
3820 (buffer-substring-no-properties (point) obj-beg))))))
3821 ;; 2. Object...
3822 (let ((obj-end (org-element-property :end next-object))
3823 (cont-beg (org-element-property :contents-begin next-object)))
3824 ;; Fill contents of NEXT-OBJECT by side-effect, if it has
3825 ;; a recursive type.
3826 (when (and cont-beg
3827 (memq (car next-object) org-element-recursive-objects))
3828 (save-restriction
3829 (narrow-to-region
3830 cont-beg
3831 (org-element-property :contents-end next-object))
3832 (org-element--parse-objects
3833 (point-min) (point-max) next-object
3834 (org-element-restriction next-object))))
3835 (setq acc (org-element-adopt-elements acc next-object))
3836 (goto-char obj-end))))
3837 ;; 3. Text after last object. Untabify it.
3838 (unless (= (point) end)
3839 (setq acc
3840 (org-element-adopt-elements
3842 (replace-regexp-in-string
3843 "\t" (make-string tab-width ? )
3844 (buffer-substring-no-properties (point) end)))))
3845 ;; Result.
3846 acc)))
3848 (defun org-element--get-next-object-candidates (limit restriction objects)
3849 "Return an alist of candidates for the next object.
3851 LIMIT bounds the search, and RESTRICTION narrows candidates to
3852 some object types.
3854 Return value is an alist whose CAR is position and CDR the object
3855 type, as a symbol.
3857 OBJECTS is the previous candidates alist."
3858 (let (next-candidates types-to-search)
3859 ;; If no previous result, search every object type in RESTRICTION.
3860 ;; Otherwise, keep potential candidates (old objects located after
3861 ;; point) and ask to search again those which had matched before.
3862 (if (not objects) (setq types-to-search restriction)
3863 (mapc (lambda (obj)
3864 (if (< (cdr obj) (point)) (push (car obj) types-to-search)
3865 (push obj next-candidates)))
3866 objects))
3867 ;; Call the appropriate successor function for each type to search
3868 ;; and accumulate matches.
3869 (mapc
3870 (lambda (type)
3871 (let* ((successor-fun
3872 (intern
3873 (format "org-element-%s-successor"
3874 (or (cdr (assq type org-element-object-successor-alist))
3875 type))))
3876 (obj (funcall successor-fun limit)))
3877 (and obj (push obj next-candidates))))
3878 types-to-search)
3879 ;; Return alist.
3880 next-candidates))
3884 ;;; Towards A Bijective Process
3886 ;; The parse tree obtained with `org-element-parse-buffer' is really
3887 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
3888 ;; interpreted and expanded into a string with canonical Org syntax.
3889 ;; Hence `org-element-interpret-data'.
3891 ;; The function relies internally on
3892 ;; `org-element--interpret-affiliated-keywords'.
3894 ;;;###autoload
3895 (defun org-element-interpret-data (data &optional parent)
3896 "Interpret DATA as Org syntax.
3898 DATA is a parse tree, an element, an object or a secondary string
3899 to interpret.
3901 Optional argument PARENT is used for recursive calls. It contains
3902 the element or object containing data, or nil.
3904 Return Org syntax as a string."
3905 (let* ((type (org-element-type data))
3906 (results
3907 (cond
3908 ;; Secondary string.
3909 ((not type)
3910 (mapconcat
3911 (lambda (obj) (org-element-interpret-data obj parent))
3912 data ""))
3913 ;; Full Org document.
3914 ((eq type 'org-data)
3915 (mapconcat
3916 (lambda (obj) (org-element-interpret-data obj parent))
3917 (org-element-contents data) ""))
3918 ;; Plain text.
3919 ((stringp data) data)
3920 ;; Element/Object without contents.
3921 ((not (org-element-contents data))
3922 (funcall (intern (format "org-element-%s-interpreter" type))
3923 data nil))
3924 ;; Element/Object with contents.
3926 (let* ((greaterp (memq type org-element-greater-elements))
3927 (objectp (and (not greaterp)
3928 (memq type org-element-recursive-objects)))
3929 (contents
3930 (mapconcat
3931 (lambda (obj) (org-element-interpret-data obj data))
3932 (org-element-contents
3933 (if (or greaterp objectp) data
3934 ;; Elements directly containing objects must
3935 ;; have their indentation normalized first.
3936 (org-element-normalize-contents
3937 data
3938 ;; When normalizing first paragraph of an
3939 ;; item or a footnote-definition, ignore
3940 ;; first line's indentation.
3941 (and (eq type 'paragraph)
3942 (equal data (car (org-element-contents parent)))
3943 (memq (org-element-type parent)
3944 '(footnote-definiton item))))))
3945 "")))
3946 (funcall (intern (format "org-element-%s-interpreter" type))
3947 data
3948 (if greaterp (org-element-normalize-contents contents)
3949 contents)))))))
3950 (if (memq type '(org-data plain-text nil)) results
3951 ;; Build white spaces. If no `:post-blank' property is
3952 ;; specified, assume its value is 0.
3953 (let ((post-blank (or (org-element-property :post-blank data) 0)))
3954 (if (memq type org-element-all-objects)
3955 (concat results (make-string post-blank 32))
3956 (concat
3957 (org-element--interpret-affiliated-keywords data)
3958 (org-element-normalize-string results)
3959 (make-string post-blank 10)))))))
3961 (defun org-element--interpret-affiliated-keywords (element)
3962 "Return ELEMENT's affiliated keywords as Org syntax.
3963 If there is no affiliated keyword, return the empty string."
3964 (let ((keyword-to-org
3965 (function
3966 (lambda (key value)
3967 (let (dual)
3968 (when (member key org-element-dual-keywords)
3969 (setq dual (cdr value) value (car value)))
3970 (concat "#+" key
3971 (and dual
3972 (format "[%s]" (org-element-interpret-data dual)))
3973 ": "
3974 (if (member key org-element-parsed-keywords)
3975 (org-element-interpret-data value)
3976 value)
3977 "\n"))))))
3978 (mapconcat
3979 (lambda (prop)
3980 (let ((value (org-element-property prop element))
3981 (keyword (upcase (substring (symbol-name prop) 1))))
3982 (when value
3983 (if (or (member keyword org-element-multiple-keywords)
3984 ;; All attribute keywords can have multiple lines.
3985 (string-match "^ATTR_" keyword))
3986 (mapconcat (lambda (line) (funcall keyword-to-org keyword line))
3987 value
3989 (funcall keyword-to-org keyword value)))))
3990 ;; List all ELEMENT's properties matching an attribute line or an
3991 ;; affiliated keyword, but ignore translated keywords since they
3992 ;; cannot belong to the property list.
3993 (loop for prop in (nth 1 element) by 'cddr
3994 when (let ((keyword (upcase (substring (symbol-name prop) 1))))
3995 (or (string-match "^ATTR_" keyword)
3996 (and
3997 (member keyword org-element-affiliated-keywords)
3998 (not (assoc keyword
3999 org-element-keyword-translation-alist)))))
4000 collect prop)
4001 "")))
4003 ;; Because interpretation of the parse tree must return the same
4004 ;; number of blank lines between elements and the same number of white
4005 ;; space after objects, some special care must be given to white
4006 ;; spaces.
4008 ;; The first function, `org-element-normalize-string', ensures any
4009 ;; string different from the empty string will end with a single
4010 ;; newline character.
4012 ;; The second function, `org-element-normalize-contents', removes
4013 ;; global indentation from the contents of the current element.
4015 (defun org-element-normalize-string (s)
4016 "Ensure string S ends with a single newline character.
4018 If S isn't a string return it unchanged. If S is the empty
4019 string, return it. Otherwise, return a new string with a single
4020 newline character at its end."
4021 (cond
4022 ((not (stringp s)) s)
4023 ((string= "" s) "")
4024 (t (and (string-match "\\(\n[ \t]*\\)*\\'" s)
4025 (replace-match "\n" nil nil s)))))
4027 (defun org-element-normalize-contents (element &optional ignore-first)
4028 "Normalize plain text in ELEMENT's contents.
4030 ELEMENT must only contain plain text and objects.
4032 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4033 indentation to compute maximal common indentation.
4035 Return the normalized element that is element with global
4036 indentation removed from its contents. The function assumes that
4037 indentation is not done with TAB characters."
4038 (let* (ind-list ; for byte-compiler
4039 collect-inds ; for byte-compiler
4040 (collect-inds
4041 (function
4042 ;; Return list of indentations within BLOB. This is done by
4043 ;; walking recursively BLOB and updating IND-LIST along the
4044 ;; way. FIRST-FLAG is non-nil when the first string hasn't
4045 ;; been seen yet. It is required as this string is the only
4046 ;; one whose indentation doesn't happen after a newline
4047 ;; character.
4048 (lambda (blob first-flag)
4049 (mapc
4050 (lambda (object)
4051 (when (and first-flag (stringp object))
4052 (setq first-flag nil)
4053 (string-match "\\`\\( *\\)" object)
4054 (let ((len (length (match-string 1 object))))
4055 ;; An indentation of zero means no string will be
4056 ;; modified. Quit the process.
4057 (if (zerop len) (throw 'zero (setq ind-list nil))
4058 (push len ind-list))))
4059 (cond
4060 ((stringp object)
4061 (let ((start 0))
4062 ;; Avoid matching blank or empty lines.
4063 (while (and (string-match "\n\\( *\\)\\(.\\)" object start)
4064 (not (equal (match-string 2 object) " ")))
4065 (setq start (match-end 0))
4066 (push (length (match-string 1 object)) ind-list))))
4067 ((memq (org-element-type object) org-element-recursive-objects)
4068 (funcall collect-inds object first-flag))))
4069 (org-element-contents blob))))))
4070 ;; Collect indentation list in ELEMENT. Possibly remove first
4071 ;; value if IGNORE-FIRST is non-nil.
4072 (catch 'zero (funcall collect-inds element (not ignore-first)))
4073 (if (not ind-list) element
4074 ;; Build ELEMENT back, replacing each string with the same
4075 ;; string minus common indentation.
4076 (let* (build ; For byte compiler.
4077 (build
4078 (function
4079 (lambda (blob mci first-flag)
4080 ;; Return BLOB with all its strings indentation
4081 ;; shortened from MCI white spaces. FIRST-FLAG is
4082 ;; non-nil when the first string hasn't been seen
4083 ;; yet.
4084 (setcdr (cdr blob)
4085 (mapcar
4086 (lambda (object)
4087 (when (and first-flag (stringp object))
4088 (setq first-flag nil)
4089 (setq object
4090 (replace-regexp-in-string
4091 (format "\\` \\{%d\\}" mci) "" object)))
4092 (cond
4093 ((stringp object)
4094 (replace-regexp-in-string
4095 (format "\n \\{%d\\}" mci) "\n" object))
4096 ((memq (org-element-type object)
4097 org-element-recursive-objects)
4098 (funcall build object mci first-flag))
4099 (t object)))
4100 (org-element-contents blob)))
4101 blob))))
4102 (funcall build element (apply 'min ind-list) (not ignore-first))))))
4106 ;;; The Toolbox
4108 ;; The first move is to implement a way to obtain the smallest element
4109 ;; containing point. This is the job of `org-element-at-point'. It
4110 ;; basically jumps back to the beginning of section containing point
4111 ;; and moves, element after element, with
4112 ;; `org-element--current-element' until the container is found. Note:
4113 ;; When using `org-element-at-point', secondary values are never
4114 ;; parsed since the function focuses on elements, not on objects.
4116 ;; At a deeper level, `org-element-context' lists all elements and
4117 ;; objects containing point.
4119 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
4120 ;; internally by navigation and manipulation tools.
4122 ;;;###autoload
4123 (defun org-element-at-point (&optional keep-trail)
4124 "Determine closest element around point.
4126 Return value is a list like (TYPE PROPS) where TYPE is the type
4127 of the element and PROPS a plist of properties associated to the
4128 element.
4130 Possible types are defined in `org-element-all-elements'.
4131 Properties depend on element or object type, but always
4132 include :begin, :end, :parent and :post-blank properties.
4134 As a special case, if point is at the very beginning of a list or
4135 sub-list, returned element will be that list instead of the first
4136 item. In the same way, if point is at the beginning of the first
4137 row of a table, returned element will be the table instead of the
4138 first row.
4140 If optional argument KEEP-TRAIL is non-nil, the function returns
4141 a list of of elements leading to element at point. The list's
4142 CAR is always the element at point. Following positions contain
4143 element's siblings, then parents, siblings of parents, until the
4144 first element of current section."
4145 (org-with-wide-buffer
4146 ;; If at an headline, parse it. It is the sole element that
4147 ;; doesn't require to know about context. Be sure to disallow
4148 ;; secondary string parsing, though.
4149 (if (org-with-limited-levels (org-at-heading-p))
4150 (progn
4151 (beginning-of-line)
4152 (if (not keep-trail) (org-element-headline-parser (point-max) t)
4153 (list (org-element-headline-parser (point-max) t))))
4154 ;; Otherwise move at the beginning of the section containing
4155 ;; point.
4156 (let ((origin (point))
4157 (end (save-excursion
4158 (org-with-limited-levels (outline-next-heading)) (point)))
4159 element type special-flag trail struct prevs parent)
4160 (org-with-limited-levels
4161 (if (org-with-limited-levels (org-before-first-heading-p))
4162 (goto-char (point-min))
4163 (org-back-to-heading)
4164 (forward-line)))
4165 (org-skip-whitespace)
4166 (beginning-of-line)
4167 ;; Parse successively each element, skipping those ending
4168 ;; before original position.
4169 (catch 'exit
4170 (while t
4171 (setq element
4172 (org-element--current-element end 'element special-flag struct)
4173 type (car element))
4174 (org-element-put-property element :parent parent)
4175 (when keep-trail (push element trail))
4176 (cond
4177 ;; 1. Skip any element ending before point. Also skip
4178 ;; element ending at point when we're sure that another
4179 ;; element has started.
4180 ((let ((elem-end (org-element-property :end element)))
4181 (when (or (< elem-end origin)
4182 (and (= elem-end origin) (/= elem-end end)))
4183 (goto-char elem-end))))
4184 ;; 2. An element containing point is always the element at
4185 ;; point.
4186 ((not (memq type org-element-greater-elements))
4187 (throw 'exit (if keep-trail trail element)))
4188 ;; 3. At any other greater element type, if point is
4189 ;; within contents, move into it.
4191 (let ((cbeg (org-element-property :contents-begin element))
4192 (cend (org-element-property :contents-end element)))
4193 (if (or (not cbeg) (not cend) (> cbeg origin) (< cend origin)
4194 ;; Create an anchor for tables and plain lists:
4195 ;; when point is at the very beginning of these
4196 ;; elements, ignoring affiliated keywords,
4197 ;; target them instead of their contents.
4198 (and (= cbeg origin) (memq type '(plain-list table)))
4199 ;; When point is at contents end, do not move
4200 ;; into elements with an explicit ending, but
4201 ;; return that element instead.
4202 (and (= cend origin)
4203 (memq type
4204 '(center-block
4205 drawer dynamic-block inlinetask item
4206 plain-list quote-block special-block))))
4207 (throw 'exit (if keep-trail trail element))
4208 (setq parent element)
4209 (case type
4210 (plain-list
4211 (setq special-flag 'item
4212 struct (org-element-property :structure element)))
4213 (table (setq special-flag 'table-row))
4214 (otherwise (setq special-flag nil)))
4215 (setq end cend)
4216 (goto-char cbeg)))))))))))
4218 ;;;###autoload
4219 (defun org-element-context ()
4220 "Return closest element or object around point.
4222 Return value is a list like (TYPE PROPS) where TYPE is the type
4223 of the element or object and PROPS a plist of properties
4224 associated to it.
4226 Possible types are defined in `org-element-all-elements' and
4227 `org-element-all-objects'. Properties depend on element or
4228 object type, but always include :begin, :end, :parent
4229 and :post-blank properties."
4230 (org-with-wide-buffer
4231 (let* ((origin (point))
4232 (element (org-element-at-point))
4233 (type (car element))
4234 end)
4235 ;; Check if point is inside an element containing objects or at
4236 ;; a secondary string. In that case, move to beginning of the
4237 ;; element or secondary string and set END to the other side.
4238 (if (not (or (and (eq type 'item)
4239 (let ((tag (org-element-property :tag element)))
4240 (and tag
4241 (progn
4242 (beginning-of-line)
4243 (search-forward tag (point-at-eol))
4244 (goto-char (match-beginning 0))
4245 (and (>= origin (point))
4246 (<= origin
4247 ;; `1+' is required so some
4248 ;; successors can match
4249 ;; properly their object.
4250 (setq end (1+ (match-end 0)))))))))
4251 (and (memq type '(headline inlinetask))
4252 (progn (beginning-of-line)
4253 (skip-chars-forward "* ")
4254 (setq end (point-at-eol))))
4255 (and (memq type '(paragraph table-cell verse-block))
4256 (let ((cbeg (org-element-property
4257 :contents-begin element))
4258 (cend (org-element-property
4259 :contents-end element)))
4260 (and (>= origin cbeg)
4261 (<= origin cend)
4262 (progn (goto-char cbeg) (setq end cend)))))))
4263 element
4264 (let ((restriction (org-element-restriction element))
4265 (parent element)
4266 candidates)
4267 (catch 'exit
4268 (while (setq candidates (org-element--get-next-object-candidates
4269 end restriction candidates))
4270 (let ((closest-cand (rassq (apply 'min (mapcar 'cdr candidates))
4271 candidates)))
4272 ;; If ORIGIN is before next object in element, there's
4273 ;; no point in looking further.
4274 (if (> (cdr closest-cand) origin) (throw 'exit element)
4275 (let* ((object
4276 (progn (goto-char (cdr closest-cand))
4277 (funcall (intern (format "org-element-%s-parser"
4278 (car closest-cand))))))
4279 (cbeg (org-element-property :contents-begin object))
4280 (cend (org-element-property :contents-end object)))
4281 (cond
4282 ;; ORIGIN is after OBJECT, so skip it.
4283 ((< (org-element-property :end object) origin)
4284 (goto-char (org-element-property :end object)))
4285 ;; ORIGIN is within a non-recursive object or at an
4286 ;; object boundaries: Return that object.
4287 ((or (not cbeg) (> cbeg origin) (< cend origin))
4288 (throw 'exit
4289 (org-element-put-property object :parent parent)))
4290 ;; Otherwise, move within current object and restrict
4291 ;; search to the end of its contents.
4292 (t (goto-char cbeg)
4293 (org-element-put-property object :parent parent)
4294 (setq parent object end cend)))))))
4295 parent))))))
4297 (defsubst org-element-nested-p (elem-A elem-B)
4298 "Non-nil when elements ELEM-A and ELEM-B are nested."
4299 (let ((beg-A (org-element-property :begin elem-A))
4300 (beg-B (org-element-property :begin elem-B))
4301 (end-A (org-element-property :end elem-A))
4302 (end-B (org-element-property :end elem-B)))
4303 (or (and (>= beg-A beg-B) (<= end-A end-B))
4304 (and (>= beg-B beg-A) (<= end-B end-A)))))
4306 (defun org-element-swap-A-B (elem-A elem-B)
4307 "Swap elements ELEM-A and ELEM-B.
4308 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
4309 end of ELEM-A."
4310 (goto-char (org-element-property :begin elem-A))
4311 ;; There are two special cases when an element doesn't start at bol:
4312 ;; the first paragraph in an item or in a footnote definition.
4313 (let ((specialp (not (bolp))))
4314 ;; Only a paragraph without any affiliated keyword can be moved at
4315 ;; ELEM-A position in such a situation. Note that the case of
4316 ;; a footnote definition is impossible: it cannot contain two
4317 ;; paragraphs in a row because it cannot contain a blank line.
4318 (if (and specialp
4319 (or (not (eq (org-element-type elem-B) 'paragraph))
4320 (/= (org-element-property :begin elem-B)
4321 (org-element-property :contents-begin elem-B))))
4322 (error "Cannot swap elements"))
4323 ;; In a special situation, ELEM-A will have no indentation. We'll
4324 ;; give it ELEM-B's (which will in, in turn, have no indentation).
4325 (let* ((ind-B (when specialp
4326 (goto-char (org-element-property :begin elem-B))
4327 (org-get-indentation)))
4328 (beg-A (org-element-property :begin elem-A))
4329 (end-A (save-excursion
4330 (goto-char (org-element-property :end elem-A))
4331 (skip-chars-backward " \r\t\n")
4332 (point-at-eol)))
4333 (beg-B (org-element-property :begin elem-B))
4334 (end-B (save-excursion
4335 (goto-char (org-element-property :end elem-B))
4336 (skip-chars-backward " \r\t\n")
4337 (point-at-eol)))
4338 ;; Store overlays responsible for visibility status. We
4339 ;; also need to store their boundaries as they will be
4340 ;; removed from buffer.
4341 (overlays
4342 (cons
4343 (mapcar (lambda (ov) (list ov (overlay-start ov) (overlay-end ov)))
4344 (overlays-in beg-A end-A))
4345 (mapcar (lambda (ov) (list ov (overlay-start ov) (overlay-end ov)))
4346 (overlays-in beg-B end-B))))
4347 ;; Get contents.
4348 (body-A (buffer-substring beg-A end-A))
4349 (body-B (delete-and-extract-region beg-B end-B)))
4350 (goto-char beg-B)
4351 (when specialp
4352 (setq body-B (replace-regexp-in-string "\\`[ \t]*" "" body-B))
4353 (org-indent-to-column ind-B))
4354 (insert body-A)
4355 ;; Restore ex ELEM-A overlays.
4356 (let ((offset (- beg-B beg-A)))
4357 (mapc (lambda (ov)
4358 (move-overlay
4359 (car ov) (+ (nth 1 ov) offset) (+ (nth 2 ov) offset)))
4360 (car overlays))
4361 (goto-char beg-A)
4362 (delete-region beg-A end-A)
4363 (insert body-B)
4364 ;; Restore ex ELEM-B overlays.
4365 (mapc (lambda (ov)
4366 (move-overlay
4367 (car ov) (- (nth 1 ov) offset) (- (nth 2 ov) offset)))
4368 (cdr overlays)))
4369 (goto-char (org-element-property :end elem-B)))))
4372 (provide 'org-element)
4373 ;;; org-element.el ends here