1 ;;; org-element.el --- Parser for Org Syntax -*- lexical-binding: t; -*-
3 ;; Copyright (C) 2012-2016 Free Software Foundation, Inc.
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
6 ;; Keywords: outlines, hypermedia, calendar, wp
8 ;; This file is part of GNU Emacs.
10 ;; GNU Emacs is free software: you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation, either version 3 of the License, or
13 ;; (at your option) any later version.
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 ;; GNU General Public License for more details.
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
25 ;; Org syntax can be divided into three categories: "Greater
26 ;; elements", "Elements" and "Objects".
28 ;; Elements are related to the structure of the document. Indeed, all
29 ;; elements are a cover for the document: each position within belongs
30 ;; to at least one element.
32 ;; An element always starts and ends at the beginning of a line. With
33 ;; a few exceptions (`clock', `headline', `inlinetask', `item',
34 ;; `planning', `property-drawer', `node-property', `section' and
35 ;; `table-row' types), it can also accept a fixed set of keywords as
36 ;; attributes. Those are called "affiliated keywords" to distinguish
37 ;; them from other keywords, which are full-fledged elements. Almost
38 ;; all affiliated keywords are referenced in
39 ;; `org-element-affiliated-keywords'; the others are export attributes
40 ;; and start with "ATTR_" prefix.
42 ;; Element containing other elements (and only elements) are called
43 ;; greater elements. Concerned types are: `center-block', `drawer',
44 ;; `dynamic-block', `footnote-definition', `headline', `inlinetask',
45 ;; `item', `plain-list', `property-drawer', `quote-block', `section'
46 ;; and `special-block'.
48 ;; Other element types are: `babel-call', `clock', `comment',
49 ;; `comment-block', `diary-sexp', `example-block', `export-block',
50 ;; `fixed-width', `horizontal-rule', `keyword', `latex-environment',
51 ;; `node-property', `paragraph', `planning', `src-block', `table',
52 ;; `table-row' and `verse-block'. Among them, `paragraph' and
53 ;; `verse-block' types can contain Org objects and plain text.
55 ;; Objects are related to document's contents. Some of them are
56 ;; recursive. Associated types are of the following: `bold', `code',
57 ;; `entity', `export-snippet', `footnote-reference',
58 ;; `inline-babel-call', `inline-src-block', `italic',
59 ;; `latex-fragment', `line-break', `link', `macro', `radio-target',
60 ;; `statistics-cookie', `strike-through', `subscript', `superscript',
61 ;; `table-cell', `target', `timestamp', `underline' and `verbatim'.
63 ;; Some elements also have special properties whose value can hold
64 ;; objects themselves (e.g. an item tag or a headline name). Such
65 ;; values are called "secondary strings". Any object belongs to
66 ;; either an element or a secondary string.
68 ;; Notwithstanding affiliated keywords, each greater element, element
69 ;; and object has a fixed set of properties attached to it. Among
70 ;; them, four are shared by all types: `:begin' and `:end', which
71 ;; refer to the beginning and ending buffer positions of the
72 ;; considered element or object, `:post-blank', which holds the number
73 ;; of blank lines, or white spaces, at its end and `:parent' which
74 ;; refers to the element or object containing it. Greater elements,
75 ;; elements and objects containing objects will also have
76 ;; `:contents-begin' and `:contents-end' properties to delimit
77 ;; contents. Eventually, All elements have a `:post-affiliated'
78 ;; property referring to the buffer position after all affiliated
79 ;; keywords, if any, or to their beginning position otherwise.
81 ;; At the lowest level, a `:parent' property is also attached to any
82 ;; string, as a text property.
84 ;; Lisp-wise, an element or an object can be represented as a list.
85 ;; It follows the pattern (TYPE PROPERTIES CONTENTS), where:
86 ;; TYPE is a symbol describing the Org element or object.
87 ;; PROPERTIES is the property list attached to it. See docstring of
88 ;; appropriate parsing function to get an exhaustive
90 ;; CONTENTS is a list of elements, objects or raw strings contained
91 ;; in the current element or object, when applicable.
93 ;; An Org buffer is a nested list of such elements and objects, whose
94 ;; type is `org-data' and properties is nil.
96 ;; The first part of this file defines Org syntax, while the second
97 ;; one provide accessors and setters functions.
99 ;; The next part implements a parser and an interpreter for each
100 ;; element and object type in Org syntax.
102 ;; The following part creates a fully recursive buffer parser. It
103 ;; also provides a tool to map a function to elements or objects
104 ;; matching some criteria in the parse tree. Functions of interest
105 ;; are `org-element-parse-buffer', `org-element-map' and, to a lesser
106 ;; extent, `org-element-parse-secondary-string'.
108 ;; The penultimate part is the cradle of an interpreter for the
109 ;; obtained parse tree: `org-element-interpret-data'.
111 ;; The library ends by furnishing `org-element-at-point' function, and
112 ;; a way to give information about document structure around point
113 ;; with `org-element-context'. A cache mechanism is also provided for
125 ;;; Definitions And Rules
127 ;; Define elements, greater elements and specify recursive objects,
128 ;; along with the affiliated keywords recognized. Also set up
129 ;; restrictions on recursive objects combinations.
131 ;; `org-element-update-syntax' builds proper syntax regexps according
134 (defvar org-element-paragraph-separate nil
135 "Regexp to separate paragraphs in an Org buffer.
136 In the case of lines starting with \"#\" and \":\", this regexp
137 is not sufficient to know if point is at a paragraph ending. See
138 `org-element-paragraph-parser' for more information.")
140 (defvar org-element--object-regexp nil
141 "Regexp possibly matching the beginning of an object.
142 This regexp allows false positives. Dedicated parser (e.g.,
143 `org-export-bold-parser') will take care of further filtering.
144 Radio links are not matched by this regexp, as they are treated
145 specially in `org-element--object-lex'.")
147 (defun org-element--set-regexps ()
148 "Build variable syntax regexps."
149 (setq org-element-paragraph-separate
151 ;; Headlines, inlinetasks.
152 org-outline-regexp
"\\|"
153 ;; Footnote definitions.
154 "\\[fn:[-_[:word:]]+\\]" "\\|"
160 ;; Tables (any type).
162 "\\+\\(?:-+\\+\\)+[ \t]*$" "\\|"
163 ;; Comments, keyword-like or block-like constructs.
164 ;; Blocks and keywords with dual values need to be
166 "#\\(?: \\|$\\|\\+\\(?:"
168 "\\S-+\\(?:\\[.*\\]\\)?:[ \t]*\\)\\)"
170 ;; Drawers (any type) and fixed-width areas. Drawers
171 ;; need to be double-checked.
172 ":\\(?: \\|$\\|[-_[:word:]]+:[ \t]*$\\)" "\\|"
174 "-\\{5,\\}[ \t]*$" "\\|"
175 ;; LaTeX environments.
176 "\\\\begin{\\([A-Za-z0-9*]+\\)}" "\\|"
178 (regexp-quote org-clock-string
) "\\|"
180 (let ((term (pcase org-plain-list-ordered-item-terminator
181 (?\
) ")") (?.
"\\.") (_ "[.)]")))
182 (alpha (and org-list-allow-alphabetical
"\\|[A-Za-z]")))
183 (concat "\\(?:[-+*]\\|\\(?:[0-9]+" alpha
"\\)" term
"\\)"
184 "\\(?:[ \t]\\|$\\)"))
186 org-element--object-regexp
187 (mapconcat #'identity
188 (let ((link-types (regexp-opt (org-link-types))))
191 "\\(?:[_^][-{(*+.,[:alnum:]]\\)"
192 ;; Bold, code, italic, strike-through, underline
196 (nth 2 org-emphasis-regexp-components
)))
198 (concat "\\<" link-types
":")
199 ;; Objects starting with "[": regular link,
200 ;; footnote reference, statistics cookie,
201 ;; timestamp (inactive).
205 "[0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}" "\\|"
206 "[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
208 ;; Objects starting with "@": export snippets.
210 ;; Objects starting with "{": macro.
212 ;; Objects starting with "<" : timestamp
213 ;; (active, diary), target, radio target and
215 (concat "<\\(?:%%\\|<\\|[0-9]\\|" link-types
"\\)")
216 ;; Objects starting with "$": latex fragment.
218 ;; Objects starting with "\": line break,
219 ;; entity, latex fragment.
220 "\\\\\\(?:[a-zA-Z[(]\\|\\\\[ \t]*$\\|_ +\\)"
221 ;; Objects starting with raw text: inline Babel
222 ;; source block, inline Babel call.
223 "\\(?:call\\|src\\)_"))
226 (org-element--set-regexps)
229 (defun org-element-update-syntax ()
230 "Update parser internals."
232 (org-element--set-regexps)
233 (org-element-cache-reset 'all
))
235 (defconst org-element-all-elements
236 '(babel-call center-block clock comment comment-block diary-sexp drawer
237 dynamic-block example-block export-block fixed-width
238 footnote-definition headline horizontal-rule inlinetask item
239 keyword latex-environment node-property paragraph plain-list
240 planning property-drawer quote-block section
241 special-block src-block table table-row verse-block
)
242 "Complete list of element types.")
244 (defconst org-element-greater-elements
245 '(center-block drawer dynamic-block footnote-definition headline inlinetask
246 item plain-list property-drawer quote-block section
248 "List of recursive element types aka Greater Elements.")
250 (defconst org-element-all-objects
251 '(bold code entity export-snippet footnote-reference inline-babel-call
252 inline-src-block italic line-break latex-fragment link macro
253 radio-target statistics-cookie strike-through subscript superscript
254 table-cell target timestamp underline verbatim
)
255 "Complete list of object types.")
257 (defconst org-element-recursive-objects
258 '(bold footnote-reference italic link subscript radio-target strike-through
259 superscript table-cell underline
)
260 "List of recursive object types.")
262 (defconst org-element-object-containers
263 (append org-element-recursive-objects
'(paragraph table-row verse-block
))
264 "List of object or element types that can directly contain objects.")
266 (defconst org-element-affiliated-keywords
267 '("CAPTION" "DATA" "HEADER" "HEADERS" "LABEL" "NAME" "PLOT" "RESNAME" "RESULT"
268 "RESULTS" "SOURCE" "SRCNAME" "TBLNAME")
269 "List of affiliated keywords as strings.
270 By default, all keywords setting attributes (e.g., \"ATTR_LATEX\")
271 are affiliated keywords and need not to be in this list.")
273 (defconst org-element-keyword-translation-alist
274 '(("DATA" .
"NAME") ("LABEL" .
"NAME") ("RESNAME" .
"NAME")
275 ("SOURCE" .
"NAME") ("SRCNAME" .
"NAME") ("TBLNAME" .
"NAME")
276 ("RESULT" .
"RESULTS") ("HEADERS" .
"HEADER"))
277 "Alist of usual translations for keywords.
278 The key is the old name and the value the new one. The property
279 holding their value will be named after the translated name.")
281 (defconst org-element-multiple-keywords
'("CAPTION" "HEADER")
282 "List of affiliated keywords that can occur more than once in an element.
284 Their value will be consed into a list of strings, which will be
285 returned as the value of the property.
287 This list is checked after translations have been applied. See
288 `org-element-keyword-translation-alist'.
290 By default, all keywords setting attributes (e.g., \"ATTR_LATEX\")
291 allow multiple occurrences and need not to be in this list.")
293 (defconst org-element-parsed-keywords
'("CAPTION")
294 "List of affiliated keywords whose value can be parsed.
296 Their value will be stored as a secondary string: a list of
299 This list is checked after translations have been applied. See
300 `org-element-keyword-translation-alist'.")
302 (defconst org-element--parsed-properties-alist
303 (mapcar (lambda (k) (cons k
(intern (concat ":" (downcase k
)))))
304 org-element-parsed-keywords
)
305 "Alist of parsed keywords and associated properties.
306 This is generated from `org-element-parsed-keywords', which
309 (defconst org-element-dual-keywords
'("CAPTION" "RESULTS")
310 "List of affiliated keywords which can have a secondary value.
312 In Org syntax, they can be written with optional square brackets
313 before the colons. For example, RESULTS keyword can be
314 associated to a hash value with the following:
316 #+RESULTS[hash-string]: some-source
318 This list is checked after translations have been applied. See
319 `org-element-keyword-translation-alist'.")
321 (defconst org-element--affiliated-re
322 (format "[ \t]*#\\+\\(?:%s\\):[ \t]*"
324 ;; Dual affiliated keywords.
325 (format "\\(?1:%s\\)\\(?:\\[\\(.*\\)\\]\\)?"
326 (regexp-opt org-element-dual-keywords
))
328 ;; Regular affiliated keywords.
329 (format "\\(?1:%s\\)"
332 (lambda (k) (member k org-element-dual-keywords
))
333 org-element-affiliated-keywords
)))
335 ;; Export attributes.
336 "\\(?1:ATTR_[-_A-Za-z0-9]+\\)"))
337 "Regexp matching any affiliated keyword.
339 Keyword name is put in match group 1. Moreover, if keyword
340 belongs to `org-element-dual-keywords', put the dual value in
343 Don't modify it, set `org-element-affiliated-keywords' instead.")
345 (defconst org-element-object-restrictions
346 (let* ((standard-set (remq 'table-cell org-element-all-objects
))
347 (standard-set-no-line-break (remq 'line-break standard-set
)))
348 `((bold ,@standard-set
)
349 (footnote-reference ,@standard-set
)
350 (headline ,@standard-set-no-line-break
)
351 (inlinetask ,@standard-set-no-line-break
)
352 (italic ,@standard-set
)
353 (item ,@standard-set-no-line-break
)
354 (keyword ,@(remq 'footnote-reference standard-set
))
355 ;; Ignore all links excepted plain links and angular links in
356 ;; a link description. Also ignore radio-targets and line
358 (link bold code entity export-snippet inline-babel-call inline-src-block
359 italic latex-fragment macro simple-link statistics-cookie
360 strike-through subscript superscript underline verbatim
)
361 (paragraph ,@standard-set
)
362 ;; Remove any variable object from radio target as it would
363 ;; prevent it from being properly recognized.
364 (radio-target bold code entity italic latex-fragment strike-through
365 subscript superscript underline superscript
)
366 (strike-through ,@standard-set
)
367 (subscript ,@standard-set
)
368 (superscript ,@standard-set
)
369 ;; Ignore inline babel call and inline src block as formulas are
370 ;; possible. Also ignore line breaks and statistics cookies.
371 (table-cell bold code entity export-snippet footnote-reference italic
372 latex-fragment link macro radio-target strike-through
373 subscript superscript target timestamp underline verbatim
)
374 (table-row table-cell
)
375 (underline ,@standard-set
)
376 (verse-block ,@standard-set
)))
377 "Alist of objects restrictions.
379 key is an element or object type containing objects and value is
380 a list of types that can be contained within an element or object
383 For example, in a `radio-target' object, one can only find
384 entities, latex-fragments, subscript, superscript and text
387 This alist also applies to secondary string. For example, an
388 `headline' type element doesn't directly contain objects, but
389 still has an entry since one of its properties (`:title') does.")
391 (defconst org-element-secondary-value-alist
395 "Alist between element types and locations of secondary values.")
397 (defconst org-element--pair-round-table
398 (let ((table (make-syntax-table)))
399 (modify-syntax-entry ?\
( "()" table
)
400 (modify-syntax-entry ?\
) ")(" table
)
401 (dolist (char '(?\
{ ?\
} ?\
[ ?\
] ?\
< ?\
>) table
)
402 (modify-syntax-entry char
" " table
)))
403 "Table used internally to pair only round brackets.
404 Other brackets are treated as spaces.")
406 (defconst org-element--pair-square-table
407 (let ((table (make-syntax-table)))
408 (modify-syntax-entry ?\
[ "(]" table
)
409 (modify-syntax-entry ?\
] ")[" table
)
410 (dolist (char '(?\
{ ?\
} ?\
( ?\
) ?\
< ?\
>) table
)
411 (modify-syntax-entry char
" " table
)))
412 "Table used internally to pair only square brackets.
413 Other brackets are treated as spaces.")
415 (defconst org-element--pair-curly-table
416 (let ((table (make-syntax-table)))
417 (modify-syntax-entry ?\
{ "(}" table
)
418 (modify-syntax-entry ?\
} "){" table
)
419 (dolist (char '(?\
[ ?\
] ?\
( ?\
) ?\
< ?\
>) table
)
420 (modify-syntax-entry char
" " table
)))
421 "Table used internally to pair only curly brackets.
422 Other brackets are treated as spaces.")
424 (defun org-element--parse-paired-brackets (char)
425 "Parse paired brackets at point.
426 CHAR is the opening bracket to consider, as a character. Return
427 contents between brackets, as a string, or nil. Also move point
429 (when (eq char
(char-after))
430 (let ((syntax-table (pcase char
431 (?\
{ org-element--pair-curly-table
)
432 (?\
[ org-element--pair-square-table
)
433 (?\
( org-element--pair-round-table
)
437 (with-syntax-table syntax-table
438 (let ((end (ignore-errors (scan-lists pos
1 0))))
441 (buffer-substring-no-properties (1+ pos
) (1- end
)))))))))
444 ;;; Accessors and Setters
446 ;; Provide four accessors: `org-element-type', `org-element-property'
447 ;; `org-element-contents' and `org-element-restriction'.
449 ;; Setter functions allow modification of elements by side effect.
450 ;; There is `org-element-put-property', `org-element-set-contents'.
451 ;; These low-level functions are useful to build a parse tree.
453 ;; `org-element-adopt-element', `org-element-set-element',
454 ;; `org-element-extract-element' and `org-element-insert-before' are
455 ;; high-level functions useful to modify a parse tree.
457 ;; `org-element-secondary-p' is a predicate used to know if a given
458 ;; object belongs to a secondary string. `org-element-copy' returns
459 ;; an element or object, stripping its parent property in the process.
461 (defsubst org-element-type
(element)
462 "Return type of ELEMENT.
464 The function returns the type of the element or object provided.
465 It can also return the following special value:
466 `plain-text' for a string
467 `org-data' for a complete document
468 nil in any other case."
470 ((not (consp element
)) (and (stringp element
) 'plain-text
))
471 ((symbolp (car element
)) (car element
))))
473 (defsubst org-element-property
(property element
)
474 "Extract the value from the PROPERTY of an ELEMENT."
475 (if (stringp element
) (get-text-property 0 property element
)
476 (plist-get (nth 1 element
) property
)))
478 (defsubst org-element-contents
(element)
479 "Extract contents from an ELEMENT."
480 (cond ((not (consp element
)) nil
)
481 ((symbolp (car element
)) (nthcdr 2 element
))
484 (defsubst org-element-restriction
(element)
485 "Return restriction associated to ELEMENT.
486 ELEMENT can be an element, an object or a symbol representing an
487 element or object type."
488 (cdr (assq (if (symbolp element
) element
(org-element-type element
))
489 org-element-object-restrictions
)))
491 (defsubst org-element-put-property
(element property value
)
492 "In ELEMENT set PROPERTY to VALUE.
493 Return modified element."
494 (if (stringp element
) (org-add-props element nil property value
)
495 (setcar (cdr element
) (plist-put (nth 1 element
) property value
))
498 (defsubst org-element-set-contents
(element &rest contents
)
499 "Set ELEMENT's contents to CONTENTS.
501 (cond ((null element
) contents
)
502 ((not (symbolp (car element
))) contents
)
503 ((cdr element
) (setcdr (cdr element
) contents
) element
)
504 (t (nconc element contents
))))
506 (defun org-element-secondary-p (object)
507 "Non-nil when OBJECT directly belongs to a secondary string.
508 Return value is the property name, as a keyword, or nil."
509 (let* ((parent (org-element-property :parent object
))
510 (properties (cdr (assq (org-element-type parent
)
511 org-element-secondary-value-alist
))))
513 (dolist (p properties
)
514 (and (memq object
(org-element-property p parent
))
517 (defsubst org-element-adopt-elements
(parent &rest children
)
518 "Append elements to the contents of another element.
520 PARENT is an element or object. CHILDREN can be elements,
521 objects, or a strings.
523 The function takes care of setting `:parent' property for CHILD.
524 Return parent element."
525 (if (not children
) parent
526 ;; Link every child to PARENT. If PARENT is nil, it is a secondary
527 ;; string: parent is the list itself.
528 (dolist (child children
)
529 (org-element-put-property child
:parent
(or parent children
)))
530 ;; Add CHILDREN at the end of PARENT contents.
532 (apply #'org-element-set-contents
534 (nconc (org-element-contents parent
) children
)))
535 ;; Return modified PARENT element.
536 (or parent children
)))
538 (defun org-element-extract-element (element)
539 "Extract ELEMENT from parse tree.
540 Remove element from the parse tree by side-effect, and return it
541 with its `:parent' property stripped out."
542 (let ((parent (org-element-property :parent element
))
543 (secondary (org-element-secondary-p element
)))
545 (org-element-put-property
547 (delq element
(org-element-property secondary parent
)))
548 (apply #'org-element-set-contents
550 (delq element
(org-element-contents parent
))))
551 ;; Return ELEMENT with its :parent removed.
552 (org-element-put-property element
:parent nil
)))
554 (defun org-element-insert-before (element location
)
555 "Insert ELEMENT before LOCATION in parse tree.
556 LOCATION is an element, object or string within the parse tree.
557 Parse tree is modified by side effect."
558 (let* ((parent (org-element-property :parent location
))
559 (property (org-element-secondary-p location
))
560 (siblings (if property
(org-element-property property parent
)
561 (org-element-contents parent
)))
562 ;; Special case: LOCATION is the first element of an
563 ;; independent secondary string (e.g. :title property). Add
565 (specialp (and (not property
)
567 (eq (car parent
) location
))))
568 ;; Install ELEMENT at the appropriate POSITION within SIBLINGS.
570 ((or (null siblings
) (eq (car siblings
) location
))
571 (push element siblings
))
572 ((null location
) (nconc siblings
(list element
)))
573 (t (let ((previous (cadr (memq location
(reverse siblings
)))))
575 (error "No location found to insert element")
576 (let ((next (memq previous siblings
)))
577 (setcdr next
(cons element
(cdr next
))))))))
578 ;; Store SIBLINGS at appropriate place in parse tree.
580 (specialp (setcdr parent
(copy-sequence parent
)) (setcar parent element
))
581 (property (org-element-put-property parent property siblings
))
582 (t (apply #'org-element-set-contents parent siblings
)))
583 ;; Set appropriate :parent property.
584 (org-element-put-property element
:parent parent
)))
586 (defun org-element-set-element (old new
)
587 "Replace element or object OLD with element or object NEW.
588 The function takes care of setting `:parent' property for NEW."
589 ;; Ensure OLD and NEW have the same parent.
590 (org-element-put-property new
:parent
(org-element-property :parent old
))
591 (if (or (memq (org-element-type old
) '(plain-text nil
))
592 (memq (org-element-type new
) '(plain-text nil
)))
593 ;; We cannot replace OLD with NEW since one of them is not an
594 ;; object or element. We take the long path.
595 (progn (org-element-insert-before new old
)
596 (org-element-extract-element old
))
597 ;; Since OLD is going to be changed into NEW by side-effect, first
598 ;; make sure that every element or object within NEW has OLD as
600 (dolist (blob (org-element-contents new
))
601 (org-element-put-property blob
:parent old
))
602 ;; Transfer contents.
603 (apply #'org-element-set-contents old
(org-element-contents new
))
604 ;; Overwrite OLD's properties with NEW's.
605 (setcar (cdr old
) (nth 1 new
))
607 (setcar old
(car new
))))
609 (defun org-element-create (type &optional props
&rest children
)
610 "Create a new element of type TYPE.
611 Optional argument PROPS, when non-nil, is a plist defining the
612 properties of the element. CHILDREN can be elements, objects or
614 (apply #'org-element-adopt-elements
(list type props
) children
))
616 (defun org-element-copy (datum)
617 "Return a copy of DATUM.
618 DATUM is an element, object, string or nil. `:parent' property
619 is cleared and contents are removed in the process."
621 (let ((type (org-element-type datum
)))
623 (`org-data
(list 'org-data nil
))
624 (`plain-text
(substring-no-properties datum
))
625 (`nil
(copy-sequence datum
))
627 (list type
(plist-put (copy-sequence (nth 1 datum
)) :parent nil
)))))))
633 ;; For each greater element type, we define a parser and an
636 ;; A parser returns the element or object as the list described above.
637 ;; Most of them accepts no argument. Though, exceptions exist. Hence
638 ;; every element containing a secondary string (see
639 ;; `org-element-secondary-value-alist') will accept an optional
640 ;; argument to toggle parsing of these secondary strings. Moreover,
641 ;; `item' parser requires current list's structure as its first
644 ;; An interpreter accepts two arguments: the list representation of
645 ;; the element or object, and its contents. The latter may be nil,
646 ;; depending on the element or object considered. It returns the
647 ;; appropriate Org syntax, as a string.
649 ;; Parsing functions must follow the naming convention:
650 ;; org-element-TYPE-parser, where TYPE is greater element's type, as
651 ;; defined in `org-element-greater-elements'.
653 ;; Similarly, interpreting functions must follow the naming
654 ;; convention: org-element-TYPE-interpreter.
656 ;; With the exception of `headline' and `item' types, greater elements
657 ;; cannot contain other greater elements of their own type.
659 ;; Beside implementing a parser and an interpreter, adding a new
660 ;; greater element requires tweaking `org-element--current-element'.
661 ;; Moreover, the newly defined type must be added to both
662 ;; `org-element-all-elements' and `org-element-greater-elements'.
667 (defun org-element-center-block-parser (limit affiliated
)
668 "Parse a center block.
670 LIMIT bounds the search. AFFILIATED is a list of which CAR is
671 the buffer position at the beginning of the first affiliated
672 keyword and CDR is a plist of affiliated keywords along with
675 Return a list whose CAR is `center-block' and CDR is a plist
676 containing `:begin', `:end', `:contents-begin', `:contents-end',
677 `:post-blank' and `:post-affiliated' keywords.
679 Assume point is at the beginning of the block."
680 (let ((case-fold-search t
))
681 (if (not (save-excursion
682 (re-search-forward "^[ \t]*#\\+END_CENTER[ \t]*$" limit t
)))
683 ;; Incomplete block: parse it as a paragraph.
684 (org-element-paragraph-parser limit affiliated
)
685 (let ((block-end-line (match-beginning 0)))
686 (let* ((begin (car affiliated
))
687 (post-affiliated (point))
688 ;; Empty blocks have no contents.
689 (contents-begin (progn (forward-line)
690 (and (< (point) block-end-line
)
692 (contents-end (and contents-begin block-end-line
))
693 (pos-before-blank (progn (goto-char block-end-line
)
697 (skip-chars-forward " \r\t\n" limit
)
698 (if (eobp) (point) (line-beginning-position)))))
703 :contents-begin contents-begin
704 :contents-end contents-end
705 :post-blank
(count-lines pos-before-blank end
)
706 :post-affiliated post-affiliated
)
707 (cdr affiliated
))))))))
709 (defun org-element-center-block-interpreter (_ contents
)
710 "Interpret a center-block element as Org syntax.
711 CONTENTS is the contents of the element."
712 (format "#+BEGIN_CENTER\n%s#+END_CENTER" contents
))
717 (defun org-element-drawer-parser (limit affiliated
)
720 LIMIT bounds the search. AFFILIATED is a list of which CAR is
721 the buffer position at the beginning of the first affiliated
722 keyword and CDR is a plist of affiliated keywords along with
725 Return a list whose CAR is `drawer' and CDR is a plist containing
726 `:drawer-name', `:begin', `:end', `:contents-begin',
727 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
729 Assume point is at beginning of drawer."
730 (let ((case-fold-search t
))
731 (if (not (save-excursion (re-search-forward "^[ \t]*:END:[ \t]*$" limit t
)))
732 ;; Incomplete drawer: parse it as a paragraph.
733 (org-element-paragraph-parser limit affiliated
)
735 (let* ((drawer-end-line (match-beginning 0))
736 (name (progn (looking-at org-drawer-regexp
)
737 (match-string-no-properties 1)))
738 (begin (car affiliated
))
739 (post-affiliated (point))
740 ;; Empty drawers have no contents.
741 (contents-begin (progn (forward-line)
742 (and (< (point) drawer-end-line
)
744 (contents-end (and contents-begin drawer-end-line
))
745 (pos-before-blank (progn (goto-char drawer-end-line
)
748 (end (progn (skip-chars-forward " \r\t\n" limit
)
749 (if (eobp) (point) (line-beginning-position)))))
755 :contents-begin contents-begin
756 :contents-end contents-end
757 :post-blank
(count-lines pos-before-blank end
)
758 :post-affiliated post-affiliated
)
759 (cdr affiliated
))))))))
761 (defun org-element-drawer-interpreter (drawer contents
)
762 "Interpret DRAWER element as Org syntax.
763 CONTENTS is the contents of the element."
764 (format ":%s:\n%s:END:"
765 (org-element-property :drawer-name drawer
)
771 (defun org-element-dynamic-block-parser (limit affiliated
)
772 "Parse a dynamic block.
774 LIMIT bounds the search. AFFILIATED is a list of which CAR is
775 the buffer position at the beginning of the first affiliated
776 keyword and CDR is a plist of affiliated keywords along with
779 Return a list whose CAR is `dynamic-block' and CDR is a plist
780 containing `:block-name', `:begin', `:end', `:contents-begin',
781 `:contents-end', `:arguments', `:post-blank' and
782 `:post-affiliated' keywords.
784 Assume point is at beginning of dynamic block."
785 (let ((case-fold-search t
))
786 (if (not (save-excursion
787 (re-search-forward "^[ \t]*#\\+END:?[ \t]*$" limit t
)))
788 ;; Incomplete block: parse it as a paragraph.
789 (org-element-paragraph-parser limit affiliated
)
790 (let ((block-end-line (match-beginning 0)))
792 (let* ((name (progn (looking-at org-dblock-start-re
)
793 (match-string-no-properties 1)))
794 (arguments (match-string-no-properties 3))
795 (begin (car affiliated
))
796 (post-affiliated (point))
797 ;; Empty blocks have no contents.
798 (contents-begin (progn (forward-line)
799 (and (< (point) block-end-line
)
801 (contents-end (and contents-begin block-end-line
))
802 (pos-before-blank (progn (goto-char block-end-line
)
805 (end (progn (skip-chars-forward " \r\t\n" limit
)
806 (if (eobp) (point) (line-beginning-position)))))
813 :contents-begin contents-begin
814 :contents-end contents-end
815 :post-blank
(count-lines pos-before-blank end
)
816 :post-affiliated post-affiliated
)
817 (cdr affiliated
)))))))))
819 (defun org-element-dynamic-block-interpreter (dynamic-block contents
)
820 "Interpret DYNAMIC-BLOCK element as Org syntax.
821 CONTENTS is the contents of the element."
822 (format "#+BEGIN: %s%s\n%s#+END:"
823 (org-element-property :block-name dynamic-block
)
824 (let ((args (org-element-property :arguments dynamic-block
)))
825 (and args
(concat " " args
)))
829 ;;;; Footnote Definition
831 (defconst org-element--footnote-separator
832 (concat org-outline-regexp-bol
"\\|"
833 org-footnote-definition-re
"\\|"
834 "^\\([ \t]*\n\\)\\{2,\\}")
835 "Regexp used as a footnote definition separator.")
837 (defun org-element-footnote-definition-parser (limit affiliated
)
838 "Parse a footnote definition.
840 LIMIT bounds the search. AFFILIATED is a list of which CAR is
841 the buffer position at the beginning of the first affiliated
842 keyword and CDR is a plist of affiliated keywords along with
845 Return a list whose CAR is `footnote-definition' and CDR is
846 a plist containing `:label', `:begin' `:end', `:contents-begin',
847 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
849 Assume point is at the beginning of the footnote definition."
851 (let* ((label (progn (looking-at org-footnote-definition-re
)
852 (match-string-no-properties 1)))
853 (begin (car affiliated
))
854 (post-affiliated (point))
860 (re-search-forward org-element--footnote-separator limit t
))
862 ((eq (char-after (match-beginning 0)) ?\
[)
863 ;; At a new footnote definition, make sure we end
864 ;; before any affiliated keyword above.
866 (while (and (> (point) post-affiliated
)
867 (looking-at-p org-element--affiliated-re
))
869 (line-beginning-position 2))
870 (t (match-beginning 0)))))
874 (skip-chars-forward " \r\t\n" ending
)
875 (cond ((= (point) ending
) nil
)
876 ((= (line-beginning-position) post-affiliated
) (point))
877 (t (line-beginning-position)))))
878 (contents-end (and contents-begin ending
))
879 (end (progn (goto-char ending
)
880 (skip-chars-forward " \r\t\n" limit
)
881 (if (eobp) (point) (line-beginning-position)))))
882 (list 'footnote-definition
887 :contents-begin contents-begin
888 :contents-end contents-end
889 :post-blank
(count-lines ending end
)
890 :post-affiliated post-affiliated
)
891 (cdr affiliated
))))))
893 (defun org-element-footnote-definition-interpreter (footnote-definition contents
)
894 "Interpret FOOTNOTE-DEFINITION element as Org syntax.
895 CONTENTS is the contents of the footnote-definition."
896 (concat (format "[fn:%s]" (org-element-property :label footnote-definition
))
903 (defun org-element--get-node-properties ()
904 "Return node properties associated to headline at point.
905 Upcase property names. It avoids confusion between properties
906 obtained through property drawer and default properties from the
907 parser (e.g. `:end' and :END:). Return value is a plist."
910 (when (looking-at-p org-planning-line-re
) (forward-line))
911 (when (looking-at org-property-drawer-re
)
913 (let ((end (match-end 0)) properties
)
914 (while (< (line-end-position) end
)
915 (looking-at org-property-re
)
916 (push (match-string-no-properties 3) properties
)
917 (push (intern (concat ":" (upcase (match-string 2)))) properties
)
921 (defun org-element--get-time-properties ()
922 "Return time properties associated to headline at point.
923 Return value is a plist."
925 (when (progn (forward-line) (looking-at org-planning-line-re
))
926 (let ((end (line-end-position)) plist
)
927 (while (re-search-forward org-keyword-time-not-clock-regexp end t
)
928 (goto-char (match-end 1))
929 (skip-chars-forward " \t")
930 (let ((keyword (match-string 1))
931 (time (org-element-timestamp-parser)))
932 (cond ((equal keyword org-scheduled-string
)
933 (setq plist
(plist-put plist
:scheduled time
)))
934 ((equal keyword org-deadline-string
)
935 (setq plist
(plist-put plist
:deadline time
)))
936 (t (setq plist
(plist-put plist
:closed time
))))))
939 (defun org-element-headline-parser (limit &optional raw-secondary-p
)
942 Return a list whose CAR is `headline' and CDR is a plist
943 containing `:raw-value', `:title', `:begin', `:end',
944 `:pre-blank', `:contents-begin' and `:contents-end', `:level',
945 `:priority', `:tags', `:todo-keyword',`:todo-type', `:scheduled',
946 `:deadline', `:closed', `:archivedp', `:commentedp'
947 `:footnote-section-p', `:post-blank' and `:post-affiliated'
950 The plist also contains any property set in the property drawer,
951 with its name in upper cases and colons added at the
952 beginning (e.g., `:CUSTOM_ID').
954 LIMIT is a buffer position bounding the search.
956 When RAW-SECONDARY-P is non-nil, headline's title will not be
957 parsed as a secondary string, but as a plain string instead.
959 Assume point is at beginning of the headline."
961 (let* ((begin (point))
962 (level (prog1 (org-reduced-level (skip-chars-forward "*"))
963 (skip-chars-forward " \t")))
964 (todo (and org-todo-regexp
965 (let (case-fold-search) (looking-at org-todo-regexp
))
966 (progn (goto-char (match-end 0))
967 (skip-chars-forward " \t")
970 (and todo
(if (member todo org-done-keywords
) 'done
'todo
)))
971 (priority (and (looking-at "\\[#.\\][ \t]*")
972 (progn (goto-char (match-end 0))
973 (aref (match-string 0) 2))))
975 (and (let (case-fold-search) (looking-at org-comment-string
))
976 (goto-char (match-end 0))))
977 (title-start (point))
978 (tags (when (re-search-forward
979 "[ \t]+\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"
982 (goto-char (match-beginning 0))
983 (org-split-string (match-string 1) ":")))
986 (buffer-substring-no-properties title-start title-end
)))
987 (archivedp (member org-archive-tag tags
))
988 (footnote-section-p (and org-footnote-section
989 (string= org-footnote-section raw-value
)))
990 (standard-props (org-element--get-node-properties))
991 (time-props (org-element--get-time-properties))
992 (end (min (save-excursion (org-end-of-subtree t t
)) limit
))
993 (pos-after-head (progn (forward-line) (point)))
994 (contents-begin (save-excursion
995 (skip-chars-forward " \r\t\n" end
)
996 (and (/= (point) end
) (line-beginning-position))))
997 (contents-end (and contents-begin
998 (progn (goto-char end
)
999 (skip-chars-backward " \r\t\n")
1005 (list :raw-value raw-value
1009 (if (not contents-begin
) 0
1010 (count-lines pos-after-head contents-begin
))
1011 :contents-begin contents-begin
1012 :contents-end contents-end
1017 :todo-type todo-type
1018 :post-blank
(count-lines
1019 (or contents-end pos-after-head
)
1021 :footnote-section-p footnote-section-p
1022 :archivedp archivedp
1023 :commentedp commentedp
1024 :post-affiliated begin
)
1027 (org-element-put-property
1029 (if raw-secondary-p raw-value
1030 (org-element--parse-objects
1031 (progn (goto-char title-start
)
1032 (skip-chars-forward " \t")
1034 (progn (goto-char title-end
)
1035 (skip-chars-backward " \t")
1038 (org-element-restriction 'headline
)
1041 (defun org-element-headline-interpreter (headline contents
)
1042 "Interpret HEADLINE element as Org syntax.
1043 CONTENTS is the contents of the element."
1044 (let* ((level (org-element-property :level headline
))
1045 (todo (org-element-property :todo-keyword headline
))
1046 (priority (org-element-property :priority headline
))
1047 (title (org-element-interpret-data
1048 (org-element-property :title headline
)))
1049 (tags (let ((tag-list (org-element-property :tags headline
)))
1051 (format ":%s:" (mapconcat #'identity tag-list
":")))))
1052 (commentedp (org-element-property :commentedp headline
))
1053 (pre-blank (or (org-element-property :pre-blank headline
) 0))
1055 (concat (make-string (if org-odd-levels-only
(1- (* level
2)) level
)
1057 (and todo
(concat " " todo
))
1058 (and commentedp
(concat " " org-comment-string
))
1059 (and priority
(format " [#%c]" priority
))
1061 (if (and org-footnote-section
1062 (org-element-property :footnote-section-p headline
))
1063 org-footnote-section
1070 ((zerop org-tags-column
) (format " %s" tags
))
1071 ((< org-tags-column
0)
1074 (max (- (+ org-tags-column
(length heading
) (length tags
))) 1)
1079 (make-string (max (- org-tags-column
(length heading
)) 1) ?\s
)
1081 (make-string (1+ pre-blank
) ?
\n)
1087 (defun org-element-inlinetask-parser (limit &optional raw-secondary-p
)
1088 "Parse an inline task.
1090 Return a list whose CAR is `inlinetask' and CDR is a plist
1091 containing `:title', `:begin', `:end', `:contents-begin' and
1092 `:contents-end', `:level', `:priority', `:raw-value', `:tags',
1093 `:todo-keyword', `:todo-type', `:scheduled', `:deadline',
1094 `:closed', `:post-blank' and `:post-affiliated' keywords.
1096 The plist also contains any property set in the property drawer,
1097 with its name in upper cases and colons added at the
1098 beginning (e.g., `:CUSTOM_ID').
1100 When optional argument RAW-SECONDARY-P is non-nil, inline-task's
1101 title will not be parsed as a secondary string, but as a plain
1104 Assume point is at beginning of the inline task."
1106 (let* ((begin (point))
1107 (level (prog1 (org-reduced-level (skip-chars-forward "*"))
1108 (skip-chars-forward " \t")))
1109 (todo (and org-todo-regexp
1110 (let (case-fold-search) (looking-at org-todo-regexp
))
1111 (progn (goto-char (match-end 0))
1112 (skip-chars-forward " \t")
1114 (todo-type (and todo
1115 (if (member todo org-done-keywords
) 'done
'todo
)))
1116 (priority (and (looking-at "\\[#.\\][ \t]*")
1117 (progn (goto-char (match-end 0))
1118 (aref (match-string 0) 2))))
1119 (title-start (point))
1120 (tags (when (re-search-forward
1121 "[ \t]+\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"
1124 (goto-char (match-beginning 0))
1125 (org-split-string (match-string 1) ":")))
1127 (raw-value (org-trim
1128 (buffer-substring-no-properties title-start title-end
)))
1129 (task-end (save-excursion
1131 (and (re-search-forward org-outline-regexp-bol limit t
)
1132 (looking-at-p "END[ \t]*$")
1133 (line-beginning-position))))
1134 (standard-props (and task-end
(org-element--get-node-properties)))
1135 (time-props (and task-end
(org-element--get-time-properties)))
1136 (contents-begin (progn (forward-line)
1137 (and task-end
(< (point) task-end
) (point))))
1138 (contents-end (and contents-begin task-end
))
1139 (before-blank (if (not task-end
) (point)
1140 (goto-char task-end
)
1143 (end (progn (skip-chars-forward " \r\t\n" limit
)
1144 (if (eobp) (point) (line-beginning-position))))
1148 (list :raw-value raw-value
1151 :contents-begin contents-begin
1152 :contents-end contents-end
1157 :todo-type todo-type
1158 :post-blank
(count-lines before-blank end
)
1159 :post-affiliated begin
)
1162 (org-element-put-property
1164 (if raw-secondary-p raw-value
1165 (org-element--parse-objects
1166 (progn (goto-char title-start
)
1167 (skip-chars-forward " \t")
1169 (progn (goto-char title-end
)
1170 (skip-chars-backward " \t")
1173 (org-element-restriction 'inlinetask
)
1176 (defun org-element-inlinetask-interpreter (inlinetask contents
)
1177 "Interpret INLINETASK element as Org syntax.
1178 CONTENTS is the contents of inlinetask."
1179 (let* ((level (org-element-property :level inlinetask
))
1180 (todo (org-element-property :todo-keyword inlinetask
))
1181 (priority (org-element-property :priority inlinetask
))
1182 (title (org-element-interpret-data
1183 (org-element-property :title inlinetask
)))
1184 (tags (let ((tag-list (org-element-property :tags inlinetask
)))
1186 (format ":%s:" (mapconcat 'identity tag-list
":")))))
1187 (task (concat (make-string level ?
*)
1188 (and todo
(concat " " todo
))
1189 (and priority
(format " [#%c]" priority
))
1190 (and title
(concat " " title
)))))
1195 ((zerop org-tags-column
) (format " %s" tags
))
1196 ((< org-tags-column
0)
1199 (max (- (+ org-tags-column
(length task
) (length tags
))) 1)
1204 (make-string (max (- org-tags-column
(length task
)) 1) ?
)
1206 ;; Prefer degenerate inlinetasks when there are no
1211 (make-string level ?
*) " END")))))
1216 (defun org-element-item-parser (_ struct
&optional raw-secondary-p
)
1219 STRUCT is the structure of the plain list.
1221 Return a list whose CAR is `item' and CDR is a plist containing
1222 `:bullet', `:begin', `:end', `:contents-begin', `:contents-end',
1223 `:checkbox', `:counter', `:tag', `:structure', `:post-blank' and
1224 `:post-affiliated' keywords.
1226 When optional argument RAW-SECONDARY-P is non-nil, item's tag, if
1227 any, will not be parsed as a secondary string, but as a plain
1230 Assume point is at the beginning of the item."
1233 (looking-at org-list-full-item-re
)
1234 (let* ((begin (point))
1235 (bullet (match-string-no-properties 1))
1236 (checkbox (let ((box (match-string 3)))
1237 (cond ((equal "[ ]" box
) 'off
)
1238 ((equal "[X]" box
) 'on
)
1239 ((equal "[-]" box
) 'trans
))))
1240 (counter (let ((c (match-string 2)))
1244 ((string-match "[A-Za-z]" c
)
1245 (- (string-to-char (upcase (match-string 0 c
)))
1247 ((string-match "[0-9]+" c
)
1248 (string-to-number (match-string 0 c
)))))))
1249 (end (progn (goto-char (nth 6 (assq (point) struct
)))
1250 (if (bolp) (point) (line-beginning-position 2))))
1253 ;; Ignore tags in un-ordered lists: they are just
1254 ;; a part of item's body.
1255 (if (and (match-beginning 4)
1256 (save-match-data (string-match "[.)]" bullet
)))
1259 (skip-chars-forward " \r\t\n" end
)
1260 (cond ((= (point) end
) nil
)
1261 ;; If first line isn't empty, contents really
1262 ;; start at the text after item's meta-data.
1263 ((= (line-beginning-position) begin
) (point))
1264 (t (line-beginning-position)))))
1265 (contents-end (and contents-begin
1266 (progn (goto-char end
)
1267 (skip-chars-backward " \r\t\n")
1268 (line-beginning-position 2))))
1271 (list :bullet bullet
1274 :contents-begin contents-begin
1275 :contents-end contents-end
1279 :post-blank
(count-lines (or contents-end begin
) end
)
1280 :post-affiliated begin
))))
1281 (org-element-put-property
1283 (let ((raw (org-list-get-tag begin struct
)))
1285 (if raw-secondary-p raw
1286 (org-element--parse-objects
1287 (match-beginning 4) (match-end 4) nil
1288 (org-element-restriction 'item
)
1291 (defun org-element-item-interpreter (item contents
)
1292 "Interpret ITEM element as Org syntax.
1293 CONTENTS is the contents of the element."
1294 (let* ((bullet (let ((bullet (org-element-property :bullet item
)))
1295 (org-list-bullet-string
1296 (cond ((not (string-match "[0-9a-zA-Z]" bullet
)) "- ")
1297 ((eq org-plain-list-ordered-item-terminator ?\
)) "1)")
1299 (checkbox (org-element-property :checkbox item
))
1300 (counter (org-element-property :counter item
))
1301 (tag (let ((tag (org-element-property :tag item
)))
1302 (and tag
(org-element-interpret-data tag
))))
1303 ;; Compute indentation.
1304 (ind (make-string (length bullet
) 32))
1305 (item-starts-with-par-p
1306 (eq (org-element-type (car (org-element-contents item
)))
1311 (and counter
(format "[@%d] " counter
))
1317 (and tag
(format "%s :: " tag
))
1319 (let ((contents (replace-regexp-in-string
1320 "\\(^\\)[ \t]*\\S-" ind contents nil nil
1)))
1321 (if item-starts-with-par-p
(org-trim contents
)
1322 (concat "\n" contents
)))))))
1327 (defun org-element--list-struct (limit)
1328 ;; Return structure of list at point. Internal function. See
1329 ;; `org-list-struct' for details.
1330 (let ((case-fold-search t
)
1332 (item-re (org-item-re))
1333 (inlinetask-re (and (featurep 'org-inlinetask
) "^\\*+ "))
1339 ;; At limit: end all items.
1342 (let ((end (progn (skip-chars-backward " \r\t\n")
1345 (dolist (item items
(sort (nconc items struct
)
1346 'car-less-than-car
))
1347 (setcar (nthcdr 6 item
) end
)))))
1348 ;; At list end: end all items.
1349 ((looking-at org-list-end-re
)
1350 (throw 'exit
(dolist (item items
(sort (nconc items struct
)
1351 'car-less-than-car
))
1352 (setcar (nthcdr 6 item
) (point)))))
1353 ;; At a new item: end previous sibling.
1354 ((looking-at item-re
)
1355 (let ((ind (save-excursion (skip-chars-forward " \t")
1357 (setq top-ind
(min top-ind ind
))
1358 (while (and items
(<= ind
(nth 1 (car items
))))
1359 (let ((item (pop items
)))
1360 (setcar (nthcdr 6 item
) (point))
1361 (push item struct
)))
1362 (push (progn (looking-at org-list-full-item-re
)
1363 (let ((bullet (match-string-no-properties 1)))
1367 (match-string-no-properties 2) ; counter
1368 (match-string-no-properties 3) ; checkbox
1370 (and (save-match-data
1371 (string-match "[-+*]" bullet
))
1372 (match-string-no-properties 4))
1373 ;; Ending position, unknown so far.
1377 ;; Skip empty lines.
1378 ((looking-at "^[ \t]*$") (forward-line))
1379 ;; Skip inline tasks and blank lines along the way.
1380 ((and inlinetask-re
(looking-at inlinetask-re
))
1382 (let ((origin (point)))
1383 (when (re-search-forward inlinetask-re limit t
)
1384 (if (looking-at-p "END[ \t]*$") (forward-line)
1385 (goto-char origin
)))))
1386 ;; At some text line. Check if it ends any previous item.
1388 (let ((ind (save-excursion (skip-chars-forward " \t")
1390 (when (<= ind top-ind
)
1391 (skip-chars-backward " \r\t\n")
1393 (while (<= ind
(nth 1 (car items
)))
1394 (let ((item (pop items
)))
1395 (setcar (nthcdr 6 item
) (line-beginning-position))
1398 (throw 'exit
(sort struct
#'car-less-than-car
))))))
1399 ;; Skip blocks (any type) and drawers contents.
1401 ((and (looking-at "[ \t]*#\\+BEGIN\\(:\\|_\\S-+\\)")
1403 (format "^[ \t]*#\\+END%s[ \t]*$" (match-string 1))
1405 ((and (looking-at org-drawer-regexp
)
1406 (re-search-forward "^[ \t]*:END:[ \t]*$" limit t
))))
1407 (forward-line))))))))
1409 (defun org-element-plain-list-parser (limit affiliated structure
)
1410 "Parse a plain list.
1412 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1413 the buffer position at the beginning of the first affiliated
1414 keyword and CDR is a plist of affiliated keywords along with
1415 their value. STRUCTURE is the structure of the plain list being
1418 Return a list whose CAR is `plain-list' and CDR is a plist
1419 containing `:type', `:begin', `:end', `:contents-begin' and
1420 `:contents-end', `:structure', `:post-blank' and
1421 `:post-affiliated' keywords.
1423 Assume point is at the beginning of the list."
1425 (let* ((struct (or structure
(org-element--list-struct limit
)))
1426 (type (cond ((looking-at-p "[ \t]*[A-Za-z0-9]") 'ordered
)
1427 ((nth 5 (assq (point) struct
)) 'descriptive
)
1429 (contents-begin (point))
1430 (begin (car affiliated
))
1431 (contents-end (let* ((item (assq contents-begin struct
))
1434 (while (and (setq item
(assq pos struct
))
1435 (= (nth 1 item
) ind
))
1436 (setq pos
(nth 6 item
)))
1438 (end (progn (goto-char contents-end
)
1439 (skip-chars-forward " \r\t\n" limit
)
1440 (if (= (point) limit
) limit
(line-beginning-position)))))
1447 :contents-begin contents-begin
1448 :contents-end contents-end
1450 :post-blank
(count-lines contents-end end
)
1451 :post-affiliated contents-begin
)
1452 (cdr affiliated
))))))
1454 (defun org-element-plain-list-interpreter (_ contents
)
1455 "Interpret plain-list element as Org syntax.
1456 CONTENTS is the contents of the element."
1459 (goto-char (point-min))
1464 ;;;; Property Drawer
1466 (defun org-element-property-drawer-parser (limit)
1467 "Parse a property drawer.
1469 LIMIT bounds the search.
1471 Return a list whose car is `property-drawer' and cdr is a plist
1472 containing `:begin', `:end', `:contents-begin', `:contents-end',
1473 `:post-blank' and `:post-affiliated' keywords.
1475 Assume point is at the beginning of the property drawer."
1477 (let ((case-fold-search t
)
1479 (contents-begin (line-beginning-position 2)))
1480 (re-search-forward "^[ \t]*:END:[ \t]*$" limit t
)
1481 (let ((contents-end (and (> (match-beginning 0) contents-begin
)
1482 (match-beginning 0)))
1483 (before-blank (progn (forward-line) (point)))
1484 (end (progn (skip-chars-forward " \r\t\n" limit
)
1485 (if (eobp) (point) (line-beginning-position)))))
1486 (list 'property-drawer
1489 :contents-begin
(and contents-end contents-begin
)
1490 :contents-end contents-end
1491 :post-blank
(count-lines before-blank end
)
1492 :post-affiliated begin
))))))
1494 (defun org-element-property-drawer-interpreter (_ contents
)
1495 "Interpret property-drawer element as Org syntax.
1496 CONTENTS is the properties within the drawer."
1497 (format ":PROPERTIES:\n%s:END:" contents
))
1502 (defun org-element-quote-block-parser (limit affiliated
)
1503 "Parse a quote block.
1505 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1506 the buffer position at the beginning of the first affiliated
1507 keyword and CDR is a plist of affiliated keywords along with
1510 Return a list whose CAR is `quote-block' and CDR is a plist
1511 containing `:begin', `:end', `:contents-begin', `:contents-end',
1512 `:post-blank' and `:post-affiliated' keywords.
1514 Assume point is at the beginning of the block."
1515 (let ((case-fold-search t
))
1516 (if (not (save-excursion
1517 (re-search-forward "^[ \t]*#\\+END_QUOTE[ \t]*$" limit t
)))
1518 ;; Incomplete block: parse it as a paragraph.
1519 (org-element-paragraph-parser limit affiliated
)
1520 (let ((block-end-line (match-beginning 0)))
1522 (let* ((begin (car affiliated
))
1523 (post-affiliated (point))
1524 ;; Empty blocks have no contents.
1525 (contents-begin (progn (forward-line)
1526 (and (< (point) block-end-line
)
1528 (contents-end (and contents-begin block-end-line
))
1529 (pos-before-blank (progn (goto-char block-end-line
)
1532 (end (progn (skip-chars-forward " \r\t\n" limit
)
1533 (if (eobp) (point) (line-beginning-position)))))
1538 :contents-begin contents-begin
1539 :contents-end contents-end
1540 :post-blank
(count-lines pos-before-blank end
)
1541 :post-affiliated post-affiliated
)
1542 (cdr affiliated
)))))))))
1544 (defun org-element-quote-block-interpreter (_ contents
)
1545 "Interpret quote-block element as Org syntax.
1546 CONTENTS is the contents of the element."
1547 (format "#+BEGIN_QUOTE\n%s#+END_QUOTE" contents
))
1552 (defun org-element-section-parser (_)
1555 Return a list whose CAR is `section' and CDR is a plist
1556 containing `:begin', `:end', `:contents-begin', `contents-end',
1557 `:post-blank' and `:post-affiliated' keywords."
1559 ;; Beginning of section is the beginning of the first non-blank
1560 ;; line after previous headline.
1561 (let ((begin (point))
1562 (end (progn (org-with-limited-levels (outline-next-heading))
1564 (pos-before-blank (progn (skip-chars-backward " \r\t\n")
1565 (line-beginning-position 2))))
1569 :contents-begin begin
1570 :contents-end pos-before-blank
1571 :post-blank
(count-lines pos-before-blank end
)
1572 :post-affiliated begin
)))))
1574 (defun org-element-section-interpreter (_ contents
)
1575 "Interpret section element as Org syntax.
1576 CONTENTS is the contents of the element."
1582 (defun org-element-special-block-parser (limit affiliated
)
1583 "Parse a special block.
1585 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1586 the buffer position at the beginning of the first affiliated
1587 keyword and CDR is a plist of affiliated keywords along with
1590 Return a list whose CAR is `special-block' and CDR is a plist
1591 containing `:type', `:begin', `:end', `:contents-begin',
1592 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
1594 Assume point is at the beginning of the block."
1595 (let* ((case-fold-search t
)
1596 (type (progn (looking-at "[ \t]*#\\+BEGIN_\\(\\S-+\\)")
1597 (match-string-no-properties 1))))
1598 (if (not (save-excursion
1600 (format "^[ \t]*#\\+END_%s[ \t]*$" (regexp-quote type
))
1602 ;; Incomplete block: parse it as a paragraph.
1603 (org-element-paragraph-parser limit affiliated
)
1604 (let ((block-end-line (match-beginning 0)))
1606 (let* ((begin (car affiliated
))
1607 (post-affiliated (point))
1608 ;; Empty blocks have no contents.
1609 (contents-begin (progn (forward-line)
1610 (and (< (point) block-end-line
)
1612 (contents-end (and contents-begin block-end-line
))
1613 (pos-before-blank (progn (goto-char block-end-line
)
1616 (end (progn (skip-chars-forward " \r\t\n" limit
)
1617 (if (eobp) (point) (line-beginning-position)))))
1618 (list 'special-block
1623 :contents-begin contents-begin
1624 :contents-end contents-end
1625 :post-blank
(count-lines pos-before-blank end
)
1626 :post-affiliated post-affiliated
)
1627 (cdr affiliated
)))))))))
1629 (defun org-element-special-block-interpreter (special-block contents
)
1630 "Interpret SPECIAL-BLOCK element as Org syntax.
1631 CONTENTS is the contents of the element."
1632 (let ((block-type (org-element-property :type special-block
)))
1633 (format "#+BEGIN_%s\n%s#+END_%s" block-type contents block-type
)))
1639 ;; For each element, a parser and an interpreter are also defined.
1640 ;; Both follow the same naming convention used for greater elements.
1642 ;; Also, as for greater elements, adding a new element type is done
1643 ;; through the following steps: implement a parser and an interpreter,
1644 ;; tweak `org-element--current-element' so that it recognizes the new
1645 ;; type and add that new type to `org-element-all-elements'.
1650 (defun org-element-babel-call-parser (limit affiliated
)
1651 "Parse a babel call.
1653 LIMIT bounds the search. AFFILIATED is a list of which car is
1654 the buffer position at the beginning of the first affiliated
1655 keyword and cdr is a plist of affiliated keywords along with
1658 Return a list whose car is `babel-call' and cdr is a plist
1659 containing `:call', `:inside-header', `:arguments',
1660 `:end-header', `:begin', `:end', `:value', `:post-blank' and
1661 `:post-affiliated' as keywords."
1663 (let* ((begin (car affiliated
))
1664 (post-affiliated (point))
1665 (value (progn (search-forward ":" nil t
)
1667 (buffer-substring-no-properties
1668 (point) (line-end-position)))))
1669 (pos-before-blank (progn (forward-line) (point)))
1670 (end (progn (skip-chars-forward " \r\t\n" limit
)
1671 (if (eobp) (point) (line-beginning-position))))
1674 "\\([^()\n]+?\\)\\(?:\\[\\(.*?\\)\\]\\)?(\\(.*\\))[ \t]*\\(.*\\)"
1678 (list :call
(and valid-value
(match-string 1 value
))
1679 :inside-header
(and valid-value
1680 (org-string-nw-p (match-string 2 value
)))
1681 :arguments
(and valid-value
1682 (org-string-nw-p (match-string 3 value
)))
1683 :end-header
(and valid-value
1684 (org-string-nw-p (match-string 4 value
)))
1688 :post-blank
(count-lines pos-before-blank end
)
1689 :post-affiliated post-affiliated
)
1690 (cdr affiliated
))))))
1692 (defun org-element-babel-call-interpreter (babel-call _
)
1693 "Interpret BABEL-CALL element as Org syntax."
1695 (org-element-property :call babel-call
)
1696 (let ((h (org-element-property :inside-header babel-call
)))
1697 (and h
(format "[%s]" h
)))
1698 (concat "(" (org-element-property :arguments babel-call
) ")")
1699 (let ((h (org-element-property :end-header babel-call
)))
1700 (and h
(concat " " h
)))))
1705 (defun org-element-clock-parser (limit)
1708 LIMIT bounds the search.
1710 Return a list whose CAR is `clock' and CDR is a plist containing
1711 `:status', `:value', `:time', `:begin', `:end', `:post-blank' and
1712 `:post-affiliated' as keywords."
1714 (let* ((case-fold-search nil
)
1716 (value (progn (search-forward org-clock-string
(line-end-position) t
)
1717 (skip-chars-forward " \t")
1718 (org-element-timestamp-parser)))
1719 (duration (and (search-forward " => " (line-end-position) t
)
1720 (progn (skip-chars-forward " \t")
1721 (looking-at "\\(\\S-+\\)[ \t]*$"))
1722 (match-string-no-properties 1)))
1723 (status (if duration
'closed
'running
))
1724 (post-blank (let ((before-blank (progn (forward-line) (point))))
1725 (skip-chars-forward " \r\t\n" limit
)
1726 (skip-chars-backward " \t")
1727 (unless (bolp) (end-of-line))
1728 (count-lines before-blank
(point))))
1731 (list :status status
1736 :post-blank post-blank
1737 :post-affiliated begin
)))))
1739 (defun org-element-clock-interpreter (clock _
)
1740 "Interpret CLOCK element as Org syntax."
1741 (concat org-clock-string
" "
1742 (org-element-timestamp-interpreter
1743 (org-element-property :value clock
) nil
)
1744 (let ((duration (org-element-property :duration clock
)))
1749 (org-split-string duration
":")))))))
1754 (defun org-element-comment-parser (limit affiliated
)
1757 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1758 the buffer position at the beginning of the first affiliated
1759 keyword and CDR is a plist of affiliated keywords along with
1762 Return a list whose CAR is `comment' and CDR is a plist
1763 containing `:begin', `:end', `:value', `:post-blank',
1764 `:post-affiliated' keywords.
1766 Assume point is at comment beginning."
1768 (let* ((begin (car affiliated
))
1769 (post-affiliated (point))
1770 (value (prog2 (looking-at "[ \t]*# ?")
1771 (buffer-substring-no-properties
1772 (match-end 0) (line-end-position))
1775 ;; Get comments ending.
1777 (while (and (< (point) limit
) (looking-at "[ \t]*#\\( \\|$\\)"))
1778 ;; Accumulate lines without leading hash and first
1783 (buffer-substring-no-properties
1784 (match-end 0) (line-end-position))))
1787 (end (progn (goto-char com-end
)
1788 (skip-chars-forward " \r\t\n" limit
)
1789 (if (eobp) (point) (line-beginning-position)))))
1795 :post-blank
(count-lines com-end end
)
1796 :post-affiliated post-affiliated
)
1797 (cdr affiliated
))))))
1799 (defun org-element-comment-interpreter (comment _
)
1800 "Interpret COMMENT element as Org syntax.
1802 (replace-regexp-in-string "^" "# " (org-element-property :value comment
)))
1807 (defun org-element-comment-block-parser (limit affiliated
)
1808 "Parse an export block.
1810 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1811 the buffer position at the beginning of the first affiliated
1812 keyword and CDR is a plist of affiliated keywords along with
1815 Return a list whose CAR is `comment-block' and CDR is a plist
1816 containing `:begin', `:end', `:value', `:post-blank' and
1817 `:post-affiliated' keywords.
1819 Assume point is at comment block beginning."
1820 (let ((case-fold-search t
))
1821 (if (not (save-excursion
1822 (re-search-forward "^[ \t]*#\\+END_COMMENT[ \t]*$" limit t
)))
1823 ;; Incomplete block: parse it as a paragraph.
1824 (org-element-paragraph-parser limit affiliated
)
1825 (let ((contents-end (match-beginning 0)))
1827 (let* ((begin (car affiliated
))
1828 (post-affiliated (point))
1829 (contents-begin (progn (forward-line) (point)))
1830 (pos-before-blank (progn (goto-char contents-end
)
1833 (end (progn (skip-chars-forward " \r\t\n" limit
)
1834 (if (eobp) (point) (line-beginning-position))))
1835 (value (buffer-substring-no-properties
1836 contents-begin contents-end
)))
1837 (list 'comment-block
1842 :post-blank
(count-lines pos-before-blank end
)
1843 :post-affiliated post-affiliated
)
1844 (cdr affiliated
)))))))))
1846 (defun org-element-comment-block-interpreter (comment-block _
)
1847 "Interpret COMMENT-BLOCK element as Org syntax."
1848 (format "#+BEGIN_COMMENT\n%s#+END_COMMENT"
1849 (org-element-normalize-string
1850 (org-remove-indentation
1851 (org-element-property :value comment-block
)))))
1856 (defun org-element-diary-sexp-parser (limit affiliated
)
1857 "Parse a diary sexp.
1859 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1860 the buffer position at the beginning of the first affiliated
1861 keyword and CDR is a plist of affiliated keywords along with
1864 Return a list whose CAR is `diary-sexp' and CDR is a plist
1865 containing `:begin', `:end', `:value', `:post-blank' and
1866 `:post-affiliated' keywords."
1868 (let ((begin (car affiliated
))
1869 (post-affiliated (point))
1870 (value (progn (looking-at "\\(%%(.*\\)[ \t]*$")
1871 (match-string-no-properties 1)))
1872 (pos-before-blank (progn (forward-line) (point)))
1873 (end (progn (skip-chars-forward " \r\t\n" limit
)
1874 (if (eobp) (point) (line-beginning-position)))))
1880 :post-blank
(count-lines pos-before-blank end
)
1881 :post-affiliated post-affiliated
)
1882 (cdr affiliated
))))))
1884 (defun org-element-diary-sexp-interpreter (diary-sexp _
)
1885 "Interpret DIARY-SEXP as Org syntax."
1886 (org-element-property :value diary-sexp
))
1891 (defun org-element-example-block-parser (limit affiliated
)
1892 "Parse an example block.
1894 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1895 the buffer position at the beginning of the first affiliated
1896 keyword and CDR is a plist of affiliated keywords along with
1899 Return a list whose CAR is `example-block' and CDR is a plist
1900 containing `:begin', `:end', `:number-lines', `:preserve-indent',
1901 `:retain-labels', `:use-labels', `:label-fmt', `:switches',
1902 `:value', `:post-blank' and `:post-affiliated' keywords."
1903 (let ((case-fold-search t
))
1904 (if (not (save-excursion
1905 (re-search-forward "^[ \t]*#\\+END_EXAMPLE[ \t]*$" limit t
)))
1906 ;; Incomplete block: parse it as a paragraph.
1907 (org-element-paragraph-parser limit affiliated
)
1908 (let ((contents-end (match-beginning 0)))
1912 (looking-at "^[ \t]*#\\+BEGIN_EXAMPLE\\(?: +\\(.*\\)\\)?")
1913 (match-string-no-properties 1)))
1914 ;; Switches analysis.
1917 (string-match "\\([-+]\\)n\\(?: *\\([0-9]+\\)\\)?\\>"
1920 (if (equal (match-string 1 switches
) "-")
1923 (if (not (match-end 2)) 0
1924 ;; Subtract 1 to give number of lines before
1926 (1- (string-to-number (match-string 2 switches
)))))))
1928 (and switches
(string-match "-i\\>" switches
)))
1929 ;; Should labels be retained in (or stripped from) example
1933 (not (string-match "-r\\>" switches
))
1934 (and number-lines
(string-match "-k\\>" switches
))))
1935 ;; What should code-references use - labels or
1940 (not (string-match "-k\\>" switches
)))))
1943 (string-match "-l +\"\\([^\"\n]+\\)\"" switches
)
1944 (match-string 1 switches
)))
1945 ;; Standard block parsing.
1946 (begin (car affiliated
))
1947 (post-affiliated (point))
1948 (contents-begin (line-beginning-position 2))
1949 (value (org-unescape-code-in-string
1950 (buffer-substring-no-properties
1951 contents-begin contents-end
)))
1952 (pos-before-blank (progn (goto-char contents-end
)
1955 (end (progn (skip-chars-forward " \r\t\n" limit
)
1956 (if (eobp) (point) (line-beginning-position)))))
1957 (list 'example-block
1963 :number-lines number-lines
1964 :preserve-indent preserve-indent
1965 :retain-labels retain-labels
1966 :use-labels use-labels
1967 :label-fmt label-fmt
1968 :post-blank
(count-lines pos-before-blank end
)
1969 :post-affiliated post-affiliated
)
1970 (cdr affiliated
)))))))))
1972 (defun org-element-example-block-interpreter (example-block _
)
1973 "Interpret EXAMPLE-BLOCK element as Org syntax."
1974 (let ((switches (org-element-property :switches example-block
))
1975 (value (org-element-property :value example-block
)))
1976 (concat "#+BEGIN_EXAMPLE" (and switches
(concat " " switches
)) "\n"
1977 (org-element-normalize-string
1978 (org-escape-code-in-string
1979 (if (or org-src-preserve-indentation
1980 (org-element-property :preserve-indent example-block
))
1982 (org-remove-indentation value
))))
1988 (defun org-element-export-block-parser (limit affiliated
)
1989 "Parse an export block.
1991 LIMIT bounds the search. AFFILIATED is a list of which CAR is
1992 the buffer position at the beginning of the first affiliated
1993 keyword and CDR is a plist of affiliated keywords along with
1996 Return a list whose CAR is `export-block' and CDR is a plist
1997 containing `:begin', `:end', `:type', `:value', `:post-blank' and
1998 `:post-affiliated' keywords.
2000 Assume point is at export-block beginning."
2001 (let* ((case-fold-search t
))
2002 (if (not (save-excursion
2003 (re-search-forward "^[ \t]*#\\+END_EXPORT[ \t]*$" limit t
)))
2004 ;; Incomplete block: parse it as a paragraph.
2005 (org-element-paragraph-parser limit affiliated
)
2007 (let* ((contents-end (match-beginning 0))
2011 "[ \t]*#\\+BEGIN_EXPORT\\(?:[ \t]+\\(\\S-+\\)\\)?[ \t]*$")
2012 (match-string-no-properties 1)))
2013 (begin (car affiliated
))
2014 (post-affiliated (point))
2015 (contents-begin (progn (forward-line) (point)))
2016 (pos-before-blank (progn (goto-char contents-end
)
2019 (end (progn (skip-chars-forward " \r\t\n" limit
)
2020 (if (eobp) (point) (line-beginning-position))))
2021 (value (org-unescape-code-in-string
2022 (buffer-substring-no-properties contents-begin
2026 (list :type
(and backend
(upcase backend
))
2030 :post-blank
(count-lines pos-before-blank end
)
2031 :post-affiliated post-affiliated
)
2032 (cdr affiliated
))))))))
2034 (defun org-element-export-block-interpreter (export-block _
)
2035 "Interpret EXPORT-BLOCK element as Org syntax."
2036 (format "#+BEGIN_EXPORT %s\n%s#+END_EXPORT"
2037 (org-element-property :type export-block
)
2038 (org-element-property :value export-block
)))
2043 (defun org-element-fixed-width-parser (limit affiliated
)
2044 "Parse a fixed-width section.
2046 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2047 the buffer position at the beginning of the first affiliated
2048 keyword and CDR is a plist of affiliated keywords along with
2051 Return a list whose CAR is `fixed-width' and CDR is a plist
2052 containing `:begin', `:end', `:value', `:post-blank' and
2053 `:post-affiliated' keywords.
2055 Assume point is at the beginning of the fixed-width area."
2057 (let* ((begin (car affiliated
))
2058 (post-affiliated (point))
2062 (while (and (< (point) limit
)
2063 (looking-at "[ \t]*:\\( \\|$\\)"))
2064 ;; Accumulate text without starting colons.
2067 (buffer-substring-no-properties
2068 (match-end 0) (point-at-eol))
2072 (end (progn (skip-chars-forward " \r\t\n" limit
)
2073 (if (eobp) (point) (line-beginning-position)))))
2079 :post-blank
(count-lines end-area end
)
2080 :post-affiliated post-affiliated
)
2081 (cdr affiliated
))))))
2083 (defun org-element-fixed-width-interpreter (fixed-width _
)
2084 "Interpret FIXED-WIDTH element as Org syntax."
2085 (let ((value (org-element-property :value fixed-width
)))
2087 (replace-regexp-in-string
2089 (if (string-match "\n\\'" value
) (substring value
0 -
1) value
)))))
2092 ;;;; Horizontal Rule
2094 (defun org-element-horizontal-rule-parser (limit affiliated
)
2095 "Parse an horizontal rule.
2097 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2098 the buffer position at the beginning of the first affiliated
2099 keyword and CDR is a plist of affiliated keywords along with
2102 Return a list whose CAR is `horizontal-rule' and CDR is a plist
2103 containing `:begin', `:end', `:post-blank' and `:post-affiliated'
2106 (let ((begin (car affiliated
))
2107 (post-affiliated (point))
2108 (post-hr (progn (forward-line) (point)))
2109 (end (progn (skip-chars-forward " \r\t\n" limit
)
2110 (if (eobp) (point) (line-beginning-position)))))
2111 (list 'horizontal-rule
2115 :post-blank
(count-lines post-hr end
)
2116 :post-affiliated post-affiliated
)
2117 (cdr affiliated
))))))
2119 (defun org-element-horizontal-rule-interpreter (&rest _
)
2120 "Interpret HORIZONTAL-RULE element as Org syntax."
2126 (defun org-element-keyword-parser (limit affiliated
)
2127 "Parse a keyword at point.
2129 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2130 the buffer position at the beginning of the first affiliated
2131 keyword and CDR is a plist of affiliated keywords along with
2134 Return a list whose CAR is `keyword' and CDR is a plist
2135 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2136 `:post-affiliated' keywords."
2138 ;; An orphaned affiliated keyword is considered as a regular
2139 ;; keyword. In this case AFFILIATED is nil, so we take care of
2140 ;; this corner case.
2141 (let ((begin (or (car affiliated
) (point)))
2142 (post-affiliated (point))
2143 (key (progn (looking-at "[ \t]*#\\+\\(\\S-+*\\):")
2144 (upcase (match-string-no-properties 1))))
2145 (value (org-trim (buffer-substring-no-properties
2146 (match-end 0) (point-at-eol))))
2147 (pos-before-blank (progn (forward-line) (point)))
2148 (end (progn (skip-chars-forward " \r\t\n" limit
)
2149 (if (eobp) (point) (line-beginning-position)))))
2156 :post-blank
(count-lines pos-before-blank end
)
2157 :post-affiliated post-affiliated
)
2158 (cdr affiliated
))))))
2160 (defun org-element-keyword-interpreter (keyword _
)
2161 "Interpret KEYWORD element as Org syntax."
2163 (org-element-property :key keyword
)
2164 (org-element-property :value keyword
)))
2167 ;;;; Latex Environment
2169 (defconst org-element--latex-begin-environment
2170 "^[ \t]*\\\\begin{\\([A-Za-z0-9*]+\\)}"
2171 "Regexp matching the beginning of a LaTeX environment.
2172 The environment is captured by the first group.
2174 See also `org-element--latex-end-environment'.")
2176 (defconst org-element--latex-end-environment
2177 "\\\\end{%s}[ \t]*$"
2178 "Format string matching the ending of a LaTeX environment.
2179 See also `org-element--latex-begin-environment'.")
2181 (defun org-element-latex-environment-parser (limit affiliated
)
2182 "Parse a LaTeX environment.
2184 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2185 the buffer position at the beginning of the first affiliated
2186 keyword and CDR is a plist of affiliated keywords along with
2189 Return a list whose CAR is `latex-environment' and CDR is a plist
2190 containing `:begin', `:end', `:value', `:post-blank' and
2191 `:post-affiliated' keywords.
2193 Assume point is at the beginning of the latex environment."
2195 (let ((case-fold-search t
)
2196 (code-begin (point)))
2197 (looking-at org-element--latex-begin-environment
)
2198 (if (not (re-search-forward (format org-element--latex-end-environment
2199 (regexp-quote (match-string 1)))
2201 ;; Incomplete latex environment: parse it as a paragraph.
2202 (org-element-paragraph-parser limit affiliated
)
2203 (let* ((code-end (progn (forward-line) (point)))
2204 (begin (car affiliated
))
2205 (value (buffer-substring-no-properties code-begin code-end
))
2206 (end (progn (skip-chars-forward " \r\t\n" limit
)
2207 (if (eobp) (point) (line-beginning-position)))))
2208 (list 'latex-environment
2213 :post-blank
(count-lines code-end end
)
2214 :post-affiliated code-begin
)
2215 (cdr affiliated
))))))))
2217 (defun org-element-latex-environment-interpreter (latex-environment _
)
2218 "Interpret LATEX-ENVIRONMENT element as Org syntax."
2219 (org-element-property :value latex-environment
))
2224 (defun org-element-node-property-parser (limit)
2225 "Parse a node-property at point.
2227 LIMIT bounds the search.
2229 Return a list whose CAR is `node-property' and CDR is a plist
2230 containing `:key', `:value', `:begin', `:end', `:post-blank' and
2231 `:post-affiliated' keywords."
2232 (looking-at org-property-re
)
2233 (let ((case-fold-search t
)
2235 (key (match-string-no-properties 2))
2236 (value (match-string-no-properties 3))
2237 (end (save-excursion
2239 (if (re-search-forward org-property-re limit t
)
2240 (line-beginning-position)
2242 (list 'node-property
2248 :post-affiliated begin
))))
2250 (defun org-element-node-property-interpreter (node-property _
)
2251 "Interpret NODE-PROPERTY element as Org syntax."
2252 (format org-property-format
2253 (format ":%s:" (org-element-property :key node-property
))
2254 (or (org-element-property :value node-property
) "")))
2259 (defun org-element-paragraph-parser (limit affiliated
)
2262 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2263 the buffer position at the beginning of the first affiliated
2264 keyword and CDR is a plist of affiliated keywords along with
2267 Return a list whose CAR is `paragraph' and CDR is a plist
2268 containing `:begin', `:end', `:contents-begin' and
2269 `:contents-end', `:post-blank' and `:post-affiliated' keywords.
2271 Assume point is at the beginning of the paragraph."
2273 (let* ((begin (car affiliated
))
2274 (contents-begin (point))
2276 (let ((case-fold-search t
))
2278 ;; A matching `org-element-paragraph-separate' is not
2279 ;; necessarily the end of the paragraph. In particular,
2280 ;; drawers, blocks or LaTeX environments opening lines
2281 ;; must be closed. Moreover keywords with a secondary
2282 ;; value must belong to "dual keywords".
2285 ((not (and (re-search-forward
2286 org-element-paragraph-separate limit
'move
)
2287 (progn (beginning-of-line) t
))))
2288 ((looking-at org-drawer-regexp
)
2290 (re-search-forward "^[ \t]*:END:[ \t]*$" limit t
)))
2291 ((looking-at "[ \t]*#\\+BEGIN_\\(\\S-+\\)")
2294 (format "^[ \t]*#\\+END_%s[ \t]*$"
2295 (regexp-quote (match-string 1)))
2297 ((looking-at org-element--latex-begin-environment
)
2300 (format org-element--latex-end-environment
2301 (regexp-quote (match-string 1)))
2303 ((looking-at "[ \t]*#\\+\\(\\S-+\\)\\[.*\\]:")
2304 (member-ignore-case (match-string 1)
2305 org-element-dual-keywords
))
2306 ;; Everything else is unambiguous.
2309 (if (= (point) limit
) limit
2310 (goto-char (line-beginning-position)))))
2311 (contents-end (save-excursion
2312 (skip-chars-backward " \r\t\n" contents-begin
)
2313 (line-beginning-position 2)))
2314 (end (progn (skip-chars-forward " \r\t\n" limit
)
2315 (if (eobp) (point) (line-beginning-position)))))
2320 :contents-begin contents-begin
2321 :contents-end contents-end
2322 :post-blank
(count-lines before-blank end
)
2323 :post-affiliated contents-begin
)
2324 (cdr affiliated
))))))
2326 (defun org-element-paragraph-interpreter (_ contents
)
2327 "Interpret paragraph element as Org syntax.
2328 CONTENTS is the contents of the element."
2334 (defun org-element-planning-parser (limit)
2337 LIMIT bounds the search.
2339 Return a list whose CAR is `planning' and CDR is a plist
2340 containing `:closed', `:deadline', `:scheduled', `:begin',
2341 `:end', `:post-blank' and `:post-affiliated' keywords."
2343 (let* ((case-fold-search nil
)
2345 (post-blank (let ((before-blank (progn (forward-line) (point))))
2346 (skip-chars-forward " \r\t\n" limit
)
2347 (skip-chars-backward " \t")
2348 (unless (bolp) (end-of-line))
2349 (count-lines before-blank
(point))))
2351 closed deadline scheduled
)
2353 (while (re-search-forward org-keyword-time-not-clock-regexp end t
)
2354 (goto-char (match-end 1))
2355 (skip-chars-forward " \t" end
)
2356 (let ((keyword (match-string 1))
2357 (time (org-element-timestamp-parser)))
2358 (cond ((equal keyword org-closed-string
) (setq closed time
))
2359 ((equal keyword org-deadline-string
) (setq deadline time
))
2360 (t (setq scheduled time
)))))
2362 (list :closed closed
2364 :scheduled scheduled
2367 :post-blank post-blank
2368 :post-affiliated begin
)))))
2370 (defun org-element-planning-interpreter (planning _
)
2371 "Interpret PLANNING element as Org syntax."
2375 (list (let ((deadline (org-element-property :deadline planning
)))
2377 (concat org-deadline-string
" "
2378 (org-element-timestamp-interpreter deadline nil
))))
2379 (let ((scheduled (org-element-property :scheduled planning
)))
2381 (concat org-scheduled-string
" "
2382 (org-element-timestamp-interpreter scheduled nil
))))
2383 (let ((closed (org-element-property :closed planning
)))
2385 (concat org-closed-string
" "
2386 (org-element-timestamp-interpreter closed nil
))))))
2392 (defun org-element-src-block-parser (limit affiliated
)
2395 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2396 the buffer position at the beginning of the first affiliated
2397 keyword and CDR is a plist of affiliated keywords along with
2400 Return a list whose CAR is `src-block' and CDR is a plist
2401 containing `:language', `:switches', `:parameters', `:begin',
2402 `:end', `:number-lines', `:retain-labels', `:use-labels',
2403 `:label-fmt', `:preserve-indent', `:value', `:post-blank' and
2404 `:post-affiliated' keywords.
2406 Assume point is at the beginning of the block."
2407 (let ((case-fold-search t
))
2408 (if (not (save-excursion (re-search-forward "^[ \t]*#\\+END_SRC[ \t]*$"
2410 ;; Incomplete block: parse it as a paragraph.
2411 (org-element-paragraph-parser limit affiliated
)
2412 (let ((contents-end (match-beginning 0)))
2414 (let* ((begin (car affiliated
))
2415 (post-affiliated (point))
2416 ;; Get language as a string.
2420 "^[ \t]*#\\+BEGIN_SRC\
2421 \\(?: +\\(\\S-+\\)\\)?\
2422 \\(\\(?: +\\(?:-\\(?:l \".+\"\\|[ikr]\\)\\|[-+]n\\(?: *[0-9]+\\)?\\)\\)+\\)?\
2424 (match-string-no-properties 1)))
2426 (switches (match-string-no-properties 2))
2428 (parameters (match-string-no-properties 3))
2429 ;; Switches analysis.
2432 (string-match "\\([-+]\\)n\\(?: *\\([0-9]+\\)\\)?\\>"
2435 (if (equal (match-string 1 switches
) "-")
2438 (if (not (match-end 2)) 0
2439 ;; Subtract 1 to give number of lines before
2441 (1- (string-to-number (match-string 2 switches
)))))))
2442 (preserve-indent (and switches
2443 (string-match "-i\\>" switches
)))
2446 (string-match "-l +\"\\([^\"\n]+\\)\"" switches
)
2447 (match-string 1 switches
)))
2448 ;; Should labels be retained in (or stripped from)
2452 (not (string-match "-r\\>" switches
))
2453 (and number-lines
(string-match "-k\\>" switches
))))
2454 ;; What should code-references use - labels or
2459 (not (string-match "-k\\>" switches
)))))
2461 (value (org-unescape-code-in-string
2462 (buffer-substring-no-properties
2463 (line-beginning-position 2) contents-end
)))
2464 (pos-before-blank (progn (goto-char contents-end
)
2467 ;; Get position after ending blank lines.
2468 (end (progn (skip-chars-forward " \r\t\n" limit
)
2469 (if (eobp) (point) (line-beginning-position)))))
2472 (list :language language
2473 :switches
(and (org-string-nw-p switches
)
2474 (org-trim switches
))
2475 :parameters
(and (org-string-nw-p parameters
)
2476 (org-trim parameters
))
2479 :number-lines number-lines
2480 :preserve-indent preserve-indent
2481 :retain-labels retain-labels
2482 :use-labels use-labels
2483 :label-fmt label-fmt
2485 :post-blank
(count-lines pos-before-blank end
)
2486 :post-affiliated post-affiliated
)
2487 (cdr affiliated
)))))))))
2489 (defun org-element-src-block-interpreter (src-block _
)
2490 "Interpret SRC-BLOCK element as Org syntax."
2491 (let ((lang (org-element-property :language src-block
))
2492 (switches (org-element-property :switches src-block
))
2493 (params (org-element-property :parameters src-block
))
2495 (let ((val (org-element-property :value src-block
)))
2497 ((or org-src-preserve-indentation
2498 (org-element-property :preserve-indent src-block
))
2500 ((zerop org-edit-src-content-indentation
)
2501 (org-remove-indentation val
))
2503 (let ((ind (make-string org-edit-src-content-indentation ?\s
)))
2504 (replace-regexp-in-string
2505 "^" ind
(org-remove-indentation val
))))))))
2506 (concat (format "#+BEGIN_SRC%s\n"
2507 (concat (and lang
(concat " " lang
))
2508 (and switches
(concat " " switches
))
2509 (and params
(concat " " params
))))
2510 (org-element-normalize-string (org-escape-code-in-string value
))
2516 (defun org-element-table-parser (limit affiliated
)
2517 "Parse a table at point.
2519 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2520 the buffer position at the beginning of the first affiliated
2521 keyword and CDR is a plist of affiliated keywords along with
2524 Return a list whose CAR is `table' and CDR is a plist containing
2525 `:begin', `:end', `:tblfm', `:type', `:contents-begin',
2526 `:contents-end', `:value', `:post-blank' and `:post-affiliated'
2529 Assume point is at the beginning of the table."
2531 (let* ((case-fold-search t
)
2532 (table-begin (point))
2533 (type (if (looking-at "[ \t]*|") 'org
'table.el
))
2534 (end-re (format "^[ \t]*\\($\\|[^| \t%s]\\)"
2535 (if (eq type
'org
) "" "+")))
2536 (begin (car affiliated
))
2538 (if (re-search-forward end-re limit
'move
)
2539 (goto-char (match-beginning 0))
2542 (while (looking-at "[ \t]*#\\+TBLFM: +\\(.*\\)[ \t]*$")
2543 (push (match-string-no-properties 1) acc
)
2546 (pos-before-blank (point))
2547 (end (progn (skip-chars-forward " \r\t\n" limit
)
2548 (if (eobp) (point) (line-beginning-position)))))
2555 ;; Only `org' tables have contents. `table.el' tables
2556 ;; use a `:value' property to store raw table as
2558 :contents-begin
(and (eq type
'org
) table-begin
)
2559 :contents-end
(and (eq type
'org
) table-end
)
2560 :value
(and (eq type
'table.el
)
2561 (buffer-substring-no-properties
2562 table-begin table-end
))
2563 :post-blank
(count-lines pos-before-blank end
)
2564 :post-affiliated table-begin
)
2565 (cdr affiliated
))))))
2567 (defun org-element-table-interpreter (table contents
)
2568 "Interpret TABLE element as Org syntax.
2569 CONTENTS is a string, if table's type is `org', or nil."
2570 (if (eq (org-element-property :type table
) 'table.el
)
2571 (org-remove-indentation (org-element-property :value table
))
2572 (concat (with-temp-buffer (insert contents
)
2575 (mapconcat (lambda (fm) (concat "#+TBLFM: " fm
))
2576 (reverse (org-element-property :tblfm table
))
2582 (defun org-element-table-row-parser (_)
2583 "Parse table row at point.
2585 Return a list whose CAR is `table-row' and CDR is a plist
2586 containing `:begin', `:end', `:contents-begin', `:contents-end',
2587 `:type', `:post-blank' and `:post-affiliated' keywords."
2589 (let* ((type (if (looking-at "^[ \t]*|-") 'rule
'standard
))
2591 ;; A table rule has no contents. In that case, ensure
2592 ;; CONTENTS-BEGIN matches CONTENTS-END.
2593 (contents-begin (and (eq type
'standard
) (search-forward "|")))
2594 (contents-end (and (eq type
'standard
)
2597 (skip-chars-backward " \t")
2599 (end (line-beginning-position 2)))
2604 :contents-begin contents-begin
2605 :contents-end contents-end
2607 :post-affiliated begin
)))))
2609 (defun org-element-table-row-interpreter (table-row contents
)
2610 "Interpret TABLE-ROW element as Org syntax.
2611 CONTENTS is the contents of the table row."
2612 (if (eq (org-element-property :type table-row
) 'rule
) "|-"
2613 (concat "|" contents
)))
2618 (defun org-element-verse-block-parser (limit affiliated
)
2619 "Parse a verse block.
2621 LIMIT bounds the search. AFFILIATED is a list of which CAR is
2622 the buffer position at the beginning of the first affiliated
2623 keyword and CDR is a plist of affiliated keywords along with
2626 Return a list whose CAR is `verse-block' and CDR is a plist
2627 containing `:begin', `:end', `:contents-begin', `:contents-end',
2628 `:post-blank' and `:post-affiliated' keywords.
2630 Assume point is at beginning of the block."
2631 (let ((case-fold-search t
))
2632 (if (not (save-excursion
2633 (re-search-forward "^[ \t]*#\\+END_VERSE[ \t]*$" limit t
)))
2634 ;; Incomplete block: parse it as a paragraph.
2635 (org-element-paragraph-parser limit affiliated
)
2636 (let ((contents-end (match-beginning 0)))
2638 (let* ((begin (car affiliated
))
2639 (post-affiliated (point))
2640 (contents-begin (progn (forward-line) (point)))
2641 (pos-before-blank (progn (goto-char contents-end
)
2644 (end (progn (skip-chars-forward " \r\t\n" limit
)
2645 (if (eobp) (point) (line-beginning-position)))))
2650 :contents-begin contents-begin
2651 :contents-end contents-end
2652 :post-blank
(count-lines pos-before-blank end
)
2653 :post-affiliated post-affiliated
)
2654 (cdr affiliated
)))))))))
2656 (defun org-element-verse-block-interpreter (_ contents
)
2657 "Interpret verse-block element as Org syntax.
2658 CONTENTS is verse block contents."
2659 (format "#+BEGIN_VERSE\n%s#+END_VERSE" contents
))
2665 ;; Unlike to elements, raw text can be found between objects. Hence,
2666 ;; `org-element--object-lex' is provided to find the next object in
2669 ;; Some object types (e.g., `italic') are recursive. Restrictions on
2670 ;; object types they can contain will be specified in
2671 ;; `org-element-object-restrictions'.
2673 ;; Creating a new type of object requires to alter
2674 ;; `org-element--object-regexp' and `org-element--object-lex', add the
2675 ;; new type in `org-element-all-objects', and possibly add
2676 ;; restrictions in `org-element-object-restrictions'.
2680 (defun org-element-bold-parser ()
2681 "Parse bold object at point, if any.
2683 When at a bold object, return a list whose car is `bold' and cdr
2684 is a plist with `:begin', `:end', `:contents-begin' and
2685 `:contents-end' and `:post-blank' keywords. Otherwise, return
2688 Assume point is at the first star marker."
2690 (unless (bolp) (backward-char 1))
2691 (when (looking-at org-emph-re
)
2692 (let ((begin (match-beginning 2))
2693 (contents-begin (match-beginning 4))
2694 (contents-end (match-end 4))
2695 (post-blank (progn (goto-char (match-end 2))
2696 (skip-chars-forward " \t")))
2701 :contents-begin contents-begin
2702 :contents-end contents-end
2703 :post-blank post-blank
))))))
2705 (defun org-element-bold-interpreter (_ contents
)
2706 "Interpret bold object as Org syntax.
2707 CONTENTS is the contents of the object."
2708 (format "*%s*" contents
))
2713 (defun org-element-code-parser ()
2714 "Parse code object at point, if any.
2716 When at a code object, return a list whose car is `code' and cdr
2717 is a plist with `:value', `:begin', `:end' and `:post-blank'
2718 keywords. Otherwise, return nil.
2720 Assume point is at the first tilde marker."
2722 (unless (bolp) (backward-char 1))
2723 (when (looking-at org-emph-re
)
2724 (let ((begin (match-beginning 2))
2725 (value (match-string-no-properties 4))
2726 (post-blank (progn (goto-char (match-end 2))
2727 (skip-chars-forward " \t")))
2733 :post-blank post-blank
))))))
2735 (defun org-element-code-interpreter (code _
)
2736 "Interpret CODE object as Org syntax."
2737 (format "~%s~" (org-element-property :value code
)))
2742 (defun org-element-entity-parser ()
2743 "Parse entity at point, if any.
2745 When at an entity, return a list whose car is `entity' and cdr
2746 a plist with `:begin', `:end', `:latex', `:latex-math-p',
2747 `:html', `:latin1', `:utf-8', `:ascii', `:use-brackets-p' and
2748 `:post-blank' as keywords. Otherwise, return nil.
2750 Assume point is at the beginning of the entity."
2752 (when (looking-at "\\\\\\(?:\\(?1:_ +\\)\\|\\(?1:there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\(?2:$\\|{}\\|[^[:alpha:]]\\)\\)")
2754 (let* ((value (or (org-entity-get (match-string 1))
2755 (throw 'no-object nil
)))
2756 (begin (match-beginning 0))
2757 (bracketsp (string= (match-string 2) "{}"))
2758 (post-blank (progn (goto-char (match-end 1))
2759 (when bracketsp
(forward-char 2))
2760 (skip-chars-forward " \t")))
2763 (list :name
(car value
)
2764 :latex
(nth 1 value
)
2765 :latex-math-p
(nth 2 value
)
2767 :ascii
(nth 4 value
)
2768 :latin1
(nth 5 value
)
2769 :utf-8
(nth 6 value
)
2772 :use-brackets-p bracketsp
2773 :post-blank post-blank
)))))))
2775 (defun org-element-entity-interpreter (entity _
)
2776 "Interpret ENTITY object as Org syntax."
2778 (org-element-property :name entity
)
2779 (when (org-element-property :use-brackets-p entity
) "{}")))
2784 (defun org-element-export-snippet-parser ()
2785 "Parse export snippet at point.
2787 When at an export snippet, return a list whose car is
2788 `export-snippet' and cdr a plist with `:begin', `:end',
2789 `:back-end', `:value' and `:post-blank' as keywords. Otherwise,
2792 Assume point is at the beginning of the snippet."
2795 (when (and (looking-at "@@\\([-A-Za-z0-9]+\\):")
2797 (save-match-data (goto-char (match-end 0))
2798 (re-search-forward "@@" nil t
)
2799 (match-beginning 0))))
2800 (let* ((begin (match-beginning 0))
2801 (back-end (match-string-no-properties 1))
2802 (value (buffer-substring-no-properties
2803 (match-end 0) contents-end
))
2804 (post-blank (skip-chars-forward " \t"))
2806 (list 'export-snippet
2807 (list :back-end back-end
2811 :post-blank post-blank
)))))))
2813 (defun org-element-export-snippet-interpreter (export-snippet _
)
2814 "Interpret EXPORT-SNIPPET object as Org syntax."
2816 (org-element-property :back-end export-snippet
)
2817 (org-element-property :value export-snippet
)))
2820 ;;;; Footnote Reference
2822 (defun org-element-footnote-reference-parser ()
2823 "Parse footnote reference at point, if any.
2825 When at a footnote reference, return a list whose car is
2826 `footnote-reference' and cdr a plist with `:label', `:type',
2827 `:begin', `:end', `:content-begin', `:contents-end' and
2828 `:post-blank' as keywords. Otherwise, return nil."
2829 (when (looking-at org-footnote-re
)
2830 (let ((closing (with-syntax-table org-element--pair-square-table
2831 (ignore-errors (scan-lists (point) 1 0)))))
2834 (let* ((begin (point))
2835 (label (match-string-no-properties 1))
2836 (inner-begin (match-end 0))
2837 (inner-end (1- closing
))
2838 (type (if (match-end 2) 'inline
'standard
))
2839 (post-blank (progn (goto-char closing
)
2840 (skip-chars-forward " \t")))
2842 (list 'footnote-reference
2847 :contents-begin
(and (eq type
'inline
) inner-begin
)
2848 :contents-end
(and (eq type
'inline
) inner-end
)
2849 :post-blank post-blank
))))))))
2851 (defun org-element-footnote-reference-interpreter (footnote-reference contents
)
2852 "Interpret FOOTNOTE-REFERENCE object as Org syntax.
2853 CONTENTS is its definition, when inline, or nil."
2855 (or (org-element-property :label footnote-reference
) "")
2856 (if contents
(concat ":" contents
) "")))
2859 ;;;; Inline Babel Call
2861 (defun org-element-inline-babel-call-parser ()
2862 "Parse inline babel call at point, if any.
2864 When at an inline babel call, return a list whose car is
2865 `inline-babel-call' and cdr a plist with `:call',
2866 `:inside-header', `:arguments', `:end-header', `:begin', `:end',
2867 `:value' and `:post-blank' as keywords. Otherwise, return nil.
2869 Assume point is at the beginning of the babel call."
2872 (when (let ((case-fold-search nil
))
2873 (looking-at "\\<call_\\([^ \t\n[(]+\\)[([]"))
2874 (goto-char (match-end 1))
2875 (let* ((begin (match-beginning 0))
2876 (call (match-string-no-properties 1))
2878 (let ((p (org-element--parse-paired-brackets ?\
[)))
2879 (and (org-string-nw-p p
)
2880 (replace-regexp-in-string "\n[ \t]*" " " (org-trim p
)))))
2881 (arguments (org-string-nw-p
2882 (or (org-element--parse-paired-brackets ?\
()
2883 ;; Parenthesis are mandatory.
2884 (throw :no-object nil
))))
2886 (let ((p (org-element--parse-paired-brackets ?\
[)))
2887 (and (org-string-nw-p p
)
2888 (replace-regexp-in-string "\n[ \t]*" " " (org-trim p
)))))
2889 (value (buffer-substring-no-properties begin
(point)))
2890 (post-blank (skip-chars-forward " \t"))
2892 (list 'inline-babel-call
2894 :inside-header inside-header
2895 :arguments arguments
2896 :end-header end-header
2900 :post-blank post-blank
)))))))
2902 (defun org-element-inline-babel-call-interpreter (inline-babel-call _
)
2903 "Interpret INLINE-BABEL-CALL object as Org syntax."
2905 (org-element-property :call inline-babel-call
)
2906 (let ((h (org-element-property :inside-header inline-babel-call
)))
2907 (and h
(format "[%s]" h
)))
2908 "(" (org-element-property :arguments inline-babel-call
) ")"
2909 (let ((h (org-element-property :end-header inline-babel-call
)))
2910 (and h
(format "[%s]" h
)))))
2913 ;;;; Inline Src Block
2915 (defun org-element-inline-src-block-parser ()
2916 "Parse inline source block at point, if any.
2918 When at an inline source block, return a list whose car is
2919 `inline-src-block' and cdr a plist with `:begin', `:end',
2920 `:language', `:value', `:parameters' and `:post-blank' as
2921 keywords. Otherwise, return nil.
2923 Assume point is at the beginning of the inline src block."
2926 (when (let ((case-fold-search nil
))
2927 (looking-at "\\<src_\\([^ \t\n[{]+\\)[{[]"))
2928 (goto-char (match-end 1))
2929 (let ((begin (match-beginning 0))
2930 (language (match-string-no-properties 1))
2932 (let ((p (org-element--parse-paired-brackets ?\
[)))
2933 (and (org-string-nw-p p
)
2934 (replace-regexp-in-string "\n[ \t]*" " " (org-trim p
)))))
2935 (value (or (org-element--parse-paired-brackets ?\
{)
2936 (throw :no-object nil
)))
2937 (post-blank (skip-chars-forward " \t")))
2938 (list 'inline-src-block
2939 (list :language language
2941 :parameters parameters
2944 :post-blank post-blank
)))))))
2946 (defun org-element-inline-src-block-interpreter (inline-src-block _
)
2947 "Interpret INLINE-SRC-BLOCK object as Org syntax."
2948 (let ((language (org-element-property :language inline-src-block
))
2949 (arguments (org-element-property :parameters inline-src-block
))
2950 (body (org-element-property :value inline-src-block
)))
2951 (format "src_%s%s{%s}"
2953 (if arguments
(format "[%s]" arguments
) "")
2958 (defun org-element-italic-parser ()
2959 "Parse italic object at point, if any.
2961 When at an italic object, return a list whose car is `italic' and
2962 cdr is a plist with `:begin', `:end', `:contents-begin' and
2963 `:contents-end' and `:post-blank' keywords. Otherwise, return
2966 Assume point is at the first slash marker."
2968 (unless (bolp) (backward-char 1))
2969 (when (looking-at org-emph-re
)
2970 (let ((begin (match-beginning 2))
2971 (contents-begin (match-beginning 4))
2972 (contents-end (match-end 4))
2973 (post-blank (progn (goto-char (match-end 2))
2974 (skip-chars-forward " \t")))
2979 :contents-begin contents-begin
2980 :contents-end contents-end
2981 :post-blank post-blank
))))))
2983 (defun org-element-italic-interpreter (_ contents
)
2984 "Interpret italic object as Org syntax.
2985 CONTENTS is the contents of the object."
2986 (format "/%s/" contents
))
2991 (defun org-element-latex-fragment-parser ()
2992 "Parse LaTeX fragment at point, if any.
2994 When at a LaTeX fragment, return a list whose car is
2995 `latex-fragment' and cdr a plist with `:value', `:begin', `:end',
2996 and `:post-blank' as keywords. Otherwise, return nil.
2998 Assume point is at the beginning of the LaTeX fragment."
3001 (let* ((begin (point))
3003 (if (eq (char-after) ?$
)
3004 (if (eq (char-after (1+ (point))) ?$
)
3005 (search-forward "$$" nil t
2)
3006 (and (not (eq (char-before) ?$
))
3007 (search-forward "$" nil t
2)
3008 (not (memq (char-before (match-beginning 0))
3009 '(?\s ?
\t ?
\n ?
, ?.
)))
3010 (looking-at "\\(\\s.\\|\\s-\\|\\s(\\|\\s)\\|\\s\"\\|$\\)")
3012 (pcase (char-after (1+ (point)))
3013 (?\
( (search-forward "\\)" nil t
))
3014 (?\
[ (search-forward "\\]" nil t
))
3017 (and (looking-at "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\
3018 \\|\\({[^{}\n]*}\\)\\)*")
3020 (post-blank (if (not after-fragment
) (throw 'no-object nil
)
3021 (goto-char after-fragment
)
3022 (skip-chars-forward " \t")))
3024 (list 'latex-fragment
3025 (list :value
(buffer-substring-no-properties begin after-fragment
)
3028 :post-blank post-blank
))))))
3030 (defun org-element-latex-fragment-interpreter (latex-fragment _
)
3031 "Interpret LATEX-FRAGMENT object as Org syntax."
3032 (org-element-property :value latex-fragment
))
3036 (defun org-element-line-break-parser ()
3037 "Parse line break at point, if any.
3039 When at a line break, return a list whose car is `line-break',
3040 and cdr a plist with `:begin', `:end' and `:post-blank' keywords.
3041 Otherwise, return nil.
3043 Assume point is at the beginning of the line break."
3044 (when (and (looking-at-p "\\\\\\\\[ \t]*$")
3045 (not (eq (char-before) ?
\\)))
3047 (list :begin
(point)
3048 :end
(line-beginning-position 2)
3051 (defun org-element-line-break-interpreter (&rest _
)
3052 "Interpret LINE-BREAK object as Org syntax."
3058 (defun org-element-link-parser ()
3059 "Parse link at point, if any.
3061 When at a link, return a list whose car is `link' and cdr a plist
3062 with `:type', `:path', `:format', `:raw-link', `:application',
3063 `:search-option', `:begin', `:end', `:contents-begin',
3064 `:contents-end' and `:post-blank' as keywords. Otherwise, return
3067 Assume point is at the beginning of the link."
3069 (let ((begin (point))
3070 end contents-begin contents-end link-end post-blank path type format
3071 raw-link search-option application
)
3073 ;; Type 1: Text targeted from a radio target.
3074 ((and org-target-link-regexp
3075 (save-excursion (or (bolp) (backward-char))
3076 (looking-at org-target-link-regexp
)))
3078 (setq format
'plain
)
3079 (setq link-end
(match-end 1))
3080 (setq path
(match-string-no-properties 1))
3081 (setq contents-begin
(match-beginning 1))
3082 (setq contents-end
(match-end 1)))
3083 ;; Type 2: Standard link, i.e. [[http://orgmode.org][homepage]]
3084 ((looking-at org-bracket-link-regexp
)
3085 (setq format
'bracket
)
3086 (setq contents-begin
(match-beginning 3))
3087 (setq contents-end
(match-end 3))
3088 (setq link-end
(match-end 0))
3089 ;; RAW-LINK is the original link. Expand any
3090 ;; abbreviation in it.
3092 ;; Also treat any newline character and associated
3093 ;; indentation as a single space character. This is not
3094 ;; compatible with RFC 3986, which requires to ignore
3095 ;; them altogether. However, doing so would require
3096 ;; users to encode spaces on the fly when writing links
3097 ;; (e.g., insert [[shell:ls%20*.org]] instead of
3098 ;; [[shell:ls *.org]], which defeats Org's focus on
3100 (setq raw-link
(org-link-expand-abbrev
3101 (replace-regexp-in-string
3102 "[ \t]*\n[ \t]*" " "
3103 (match-string-no-properties 1))))
3104 ;; Determine TYPE of link and set PATH accordingly. According
3105 ;; to RFC 3986, remove whitespaces from URI in external links.
3106 ;; In internal ones, treat indentation as a single space.
3109 ((or (file-name-absolute-p raw-link
)
3110 (string-match "\\`\\.\\.?/" raw-link
))
3112 (setq path raw-link
))
3113 ;; Explicit type (http, irc, bbdb...).
3114 ((string-match org-link-types-re raw-link
)
3115 (setq type
(match-string 1 raw-link
))
3116 (setq path
(substring raw-link
(match-end 0))))
3117 ;; Code-ref type: PATH is the name of the reference.
3118 ((and (string-match-p "\\`(" raw-link
)
3119 (string-match-p ")\\'" raw-link
))
3120 (setq type
"coderef")
3121 (setq path
(substring raw-link
1 -
1)))
3122 ;; Custom-id type: PATH is the name of the custom id.
3123 ((= (string-to-char raw-link
) ?
#)
3124 (setq type
"custom-id")
3125 (setq path
(substring raw-link
1)))
3126 ;; Fuzzy type: Internal link either matches a target, an
3127 ;; headline name or nothing. PATH is the target or
3131 (setq path raw-link
))))
3132 ;; Type 3: Plain link, e.g., http://orgmode.org
3133 ((looking-at org-plain-link-re
)
3134 (setq format
'plain
)
3135 (setq raw-link
(match-string-no-properties 0))
3136 (setq type
(match-string-no-properties 1))
3137 (setq link-end
(match-end 0))
3138 (setq path
(match-string-no-properties 2)))
3139 ;; Type 4: Angular link, e.g., <http://orgmode.org>. Unlike to
3140 ;; bracket links, follow RFC 3986 and remove any extra
3141 ;; whitespace in URI.
3142 ((looking-at org-angle-link-re
)
3143 (setq format
'angle
)
3144 (setq type
(match-string-no-properties 1))
3145 (setq link-end
(match-end 0))
3147 (buffer-substring-no-properties
3148 (match-beginning 1) (match-end 2)))
3149 (setq path
(replace-regexp-in-string
3150 "[ \t]*\n[ \t]*" "" (match-string-no-properties 2))))
3151 (t (throw 'no-object nil
)))
3152 ;; In any case, deduce end point after trailing white space from
3153 ;; LINK-END variable.
3156 (progn (goto-char link-end
) (skip-chars-forward " \t")))
3158 ;; Special "file" type link processing. Extract opening
3159 ;; application and search option, if any. Also normalize URI.
3160 (when (string-match "\\`file\\(?:\\+\\(.+\\)\\)?\\'" type
)
3161 (setq application
(match-string 1 type
) type
"file")
3162 (when (string-match "::\\(.*\\)\\'" path
)
3163 (setq search-option
(match-string 1 path
))
3164 (setq path
(replace-match "" nil nil path
)))
3165 (setq path
(replace-regexp-in-string "\\`///+" "/" path
)))
3166 ;; Translate link, if `org-link-translation-function' is set.
3167 (let ((trans (and (functionp org-link-translation-function
)
3168 (funcall org-link-translation-function type path
))))
3170 (setq type
(car trans
))
3171 (setq path
(cdr trans
))))
3176 :raw-link
(or raw-link path
)
3177 :application application
3178 :search-option search-option
3181 :contents-begin contents-begin
3182 :contents-end contents-end
3183 :post-blank post-blank
)))))
3185 (defun org-element-link-interpreter (link contents
)
3186 "Interpret LINK object as Org syntax.
3187 CONTENTS is the contents of the object, or nil."
3188 (let ((type (org-element-property :type link
))
3189 (path (org-element-property :path link
)))
3190 (if (string= type
"radio") path
3191 (let ((fmt (pcase (org-element-property :format link
)
3192 ;; Links with contents and internal links have to
3193 ;; use bracket syntax. Ignore `:format' in these
3194 ;; cases. This is also the default syntax when the
3195 ;; property is not defined, e.g., when the object
3196 ;; was crafted by the user.
3197 ((guard contents
) (format "[[%%s][%s]]" contents
))
3200 (guard (member type
'("coderef" "custom-id" "fuzzy"))))
3202 ;; Otherwise, just obey to `:format'.
3205 (f (error "Wrong `:format' value: %s" f
)))))
3208 ("coderef" (format "(%s)" path
))
3209 ("custom-id" (concat "#" path
))
3211 (let ((app (org-element-property :application link
))
3212 (opt (org-element-property :search-option link
)))
3213 (concat type
(and app
(concat "+" app
)) ":"
3215 (and opt
(concat "::" opt
)))))
3217 (_ (concat type
":" path
))))))))
3222 (defun org-element-macro-parser ()
3223 "Parse macro at point, if any.
3225 When at a macro, return a list whose car is `macro' and cdr
3226 a plist with `:key', `:args', `:begin', `:end', `:value' and
3227 `:post-blank' as keywords. Otherwise, return nil.
3229 Assume point is at the macro."
3231 (when (looking-at "{{{\\([a-zA-Z][-a-zA-Z0-9_]*\\)\\(([ \t\n]*\\([^\000]*?\\))\\)?}}}")
3232 (let ((begin (point))
3233 (key (downcase (match-string-no-properties 1)))
3234 (value (match-string-no-properties 0))
3235 (post-blank (progn (goto-char (match-end 0))
3236 (skip-chars-forward " \t")))
3238 (args (let ((args (match-string-no-properties 3)))
3239 (and args
(org-macro-extract-arguments args
)))))
3246 :post-blank post-blank
))))))
3248 (defun org-element-macro-interpreter (macro _
)
3249 "Interpret MACRO object as Org syntax."
3250 (org-element-property :value macro
))
3255 (defun org-element-radio-target-parser ()
3256 "Parse radio target at point, if any.
3258 When at a radio target, return a list whose car is `radio-target'
3259 and cdr a plist with `:begin', `:end', `:contents-begin',
3260 `:contents-end', `:value' and `:post-blank' as keywords.
3261 Otherwise, return nil.
3263 Assume point is at the radio target."
3265 (when (looking-at org-radio-target-regexp
)
3266 (let ((begin (point))
3267 (contents-begin (match-beginning 1))
3268 (contents-end (match-end 1))
3269 (value (match-string-no-properties 1))
3270 (post-blank (progn (goto-char (match-end 0))
3271 (skip-chars-forward " \t")))
3276 :contents-begin contents-begin
3277 :contents-end contents-end
3278 :post-blank post-blank
3281 (defun org-element-radio-target-interpreter (_ contents
)
3282 "Interpret target object as Org syntax.
3283 CONTENTS is the contents of the object."
3284 (concat "<<<" contents
">>>"))
3287 ;;;; Statistics Cookie
3289 (defun org-element-statistics-cookie-parser ()
3290 "Parse statistics cookie at point, if any.
3292 When at a statistics cookie, return a list whose car is
3293 `statistics-cookie', and cdr a plist with `:begin', `:end',
3294 `:value' and `:post-blank' keywords. Otherwise, return nil.
3296 Assume point is at the beginning of the statistics-cookie."
3298 (when (looking-at "\\[[0-9]*\\(%\\|/[0-9]*\\)\\]")
3299 (let* ((begin (point))
3300 (value (buffer-substring-no-properties
3301 (match-beginning 0) (match-end 0)))
3302 (post-blank (progn (goto-char (match-end 0))
3303 (skip-chars-forward " \t")))
3305 (list 'statistics-cookie
3309 :post-blank post-blank
))))))
3311 (defun org-element-statistics-cookie-interpreter (statistics-cookie _
)
3312 "Interpret STATISTICS-COOKIE object as Org syntax."
3313 (org-element-property :value statistics-cookie
))
3318 (defun org-element-strike-through-parser ()
3319 "Parse strike-through object at point, if any.
3321 When at a strike-through object, return a list whose car is
3322 `strike-through' and cdr is a plist with `:begin', `:end',
3323 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3324 Otherwise, return nil.
3326 Assume point is at the first plus sign marker."
3328 (unless (bolp) (backward-char 1))
3329 (when (looking-at org-emph-re
)
3330 (let ((begin (match-beginning 2))
3331 (contents-begin (match-beginning 4))
3332 (contents-end (match-end 4))
3333 (post-blank (progn (goto-char (match-end 2))
3334 (skip-chars-forward " \t")))
3336 (list 'strike-through
3339 :contents-begin contents-begin
3340 :contents-end contents-end
3341 :post-blank post-blank
))))))
3343 (defun org-element-strike-through-interpreter (_ contents
)
3344 "Interpret strike-through object as Org syntax.
3345 CONTENTS is the contents of the object."
3346 (format "+%s+" contents
))
3351 (defun org-element-subscript-parser ()
3352 "Parse subscript at point, if any.
3354 When at a subscript object, return a list whose car is
3355 `subscript' and cdr a plist with `:begin', `:end',
3356 `:contents-begin', `:contents-end', `:use-brackets-p' and
3357 `:post-blank' as keywords. Otherwise, return nil.
3359 Assume point is at the underscore."
3361 (unless (bolp) (backward-char))
3362 (when (looking-at org-match-substring-regexp
)
3363 (let ((bracketsp (match-beginning 4))
3364 (begin (match-beginning 2))
3365 (contents-begin (or (match-beginning 4)
3366 (match-beginning 3)))
3367 (contents-end (or (match-end 4) (match-end 3)))
3368 (post-blank (progn (goto-char (match-end 0))
3369 (skip-chars-forward " \t")))
3374 :use-brackets-p bracketsp
3375 :contents-begin contents-begin
3376 :contents-end contents-end
3377 :post-blank post-blank
))))))
3379 (defun org-element-subscript-interpreter (subscript contents
)
3380 "Interpret SUBSCRIPT object as Org syntax.
3381 CONTENTS is the contents of the object."
3383 (if (org-element-property :use-brackets-p subscript
) "_{%s}" "_%s")
3389 (defun org-element-superscript-parser ()
3390 "Parse superscript at point, if any.
3392 When at a superscript object, return a list whose car is
3393 `superscript' and cdr a plist with `:begin', `:end',
3394 `:contents-begin', `:contents-end', `:use-brackets-p' and
3395 `:post-blank' as keywords. Otherwise, return nil.
3397 Assume point is at the caret."
3399 (unless (bolp) (backward-char))
3400 (when (looking-at org-match-substring-regexp
)
3401 (let ((bracketsp (match-beginning 4))
3402 (begin (match-beginning 2))
3403 (contents-begin (or (match-beginning 4)
3404 (match-beginning 3)))
3405 (contents-end (or (match-end 4) (match-end 3)))
3406 (post-blank (progn (goto-char (match-end 0))
3407 (skip-chars-forward " \t")))
3412 :use-brackets-p bracketsp
3413 :contents-begin contents-begin
3414 :contents-end contents-end
3415 :post-blank post-blank
))))))
3417 (defun org-element-superscript-interpreter (superscript contents
)
3418 "Interpret SUPERSCRIPT object as Org syntax.
3419 CONTENTS is the contents of the object."
3421 (if (org-element-property :use-brackets-p superscript
) "^{%s}" "^%s")
3427 (defun org-element-table-cell-parser ()
3428 "Parse table cell at point.
3429 Return a list whose car is `table-cell' and cdr is a plist
3430 containing `:begin', `:end', `:contents-begin', `:contents-end'
3431 and `:post-blank' keywords."
3432 (looking-at "[ \t]*\\(.*?\\)[ \t]*\\(?:|\\|$\\)")
3433 (let* ((begin (match-beginning 0))
3435 (contents-begin (match-beginning 1))
3436 (contents-end (match-end 1)))
3440 :contents-begin contents-begin
3441 :contents-end contents-end
3444 (defun org-element-table-cell-interpreter (_ contents
)
3445 "Interpret table-cell element as Org syntax.
3446 CONTENTS is the contents of the cell, or nil."
3447 (concat " " contents
" |"))
3452 (defun org-element-target-parser ()
3453 "Parse target at point, if any.
3455 When at a target, return a list whose car is `target' and cdr
3456 a plist with `:begin', `:end', `:value' and `:post-blank' as
3457 keywords. Otherwise, return nil.
3459 Assume point is at the target."
3461 (when (looking-at org-target-regexp
)
3462 (let ((begin (point))
3463 (value (match-string-no-properties 1))
3464 (post-blank (progn (goto-char (match-end 0))
3465 (skip-chars-forward " \t")))
3471 :post-blank post-blank
))))))
3473 (defun org-element-target-interpreter (target _
)
3474 "Interpret TARGET object as Org syntax."
3475 (format "<<%s>>" (org-element-property :value target
)))
3480 (defconst org-element--timestamp-regexp
3481 (concat org-ts-regexp-both
3483 "\\(?:<[0-9]+-[0-9]+-[0-9]+[^>\n]+?\\+[0-9]+[dwmy]>\\)"
3485 "\\(?:<%%\\(?:([^>\n]+)\\)>\\)")
3486 "Regexp matching any timestamp type object.")
3488 (defun org-element-timestamp-parser ()
3489 "Parse time stamp at point, if any.
3491 When at a time stamp, return a list whose car is `timestamp', and
3492 cdr a plist with `:type', `:raw-value', `:year-start',
3493 `:month-start', `:day-start', `:hour-start', `:minute-start',
3494 `:year-end', `:month-end', `:day-end', `:hour-end',
3495 `:minute-end', `:repeater-type', `:repeater-value',
3496 `:repeater-unit', `:warning-type', `:warning-value',
3497 `:warning-unit', `:begin', `:end' and `:post-blank' keywords.
3498 Otherwise, return nil.
3500 Assume point is at the beginning of the timestamp."
3501 (when (looking-at-p org-element--timestamp-regexp
)
3503 (let* ((begin (point))
3504 (activep (eq (char-after) ?
<))
3507 (looking-at "\\([<[]\\(%%\\)?.*?\\)[]>]\\(?:--\\([<[].*?[]>]\\)\\)?")
3508 (match-string-no-properties 0)))
3509 (date-start (match-string-no-properties 1))
3510 (date-end (match-string 3))
3511 (diaryp (match-beginning 2))
3512 (post-blank (progn (goto-char (match-end 0))
3513 (skip-chars-forward " \t")))
3518 "[012]?[0-9]:[0-5][0-9]\\(-\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)"
3520 (cons (string-to-number (match-string 2 date-start
))
3521 (string-to-number (match-string 3 date-start
)))))
3522 (type (cond (diaryp 'diary
)
3523 ((and activep
(or date-end time-range
)) 'active-range
)
3525 ((or date-end time-range
) 'inactive-range
)
3529 (string-match "\\([.+]?\\+\\)\\([0-9]+\\)\\([hdwmy]\\)"
3533 (let ((type (match-string 1 raw-value
)))
3534 (cond ((equal "++" type
) 'catch-up
)
3535 ((equal ".+" type
) 'restart
)
3537 :repeater-value
(string-to-number (match-string 2 raw-value
))
3539 (pcase (string-to-char (match-string 3 raw-value
))
3540 (?h
'hour
) (?d
'day
) (?w
'week
) (?m
'month
) (_ 'year
)))))
3543 (string-match "\\(-\\)?-\\([0-9]+\\)\\([hdwmy]\\)" raw-value
)
3545 :warning-type
(if (match-string 1 raw-value
) 'first
'all
)
3546 :warning-value
(string-to-number (match-string 2 raw-value
))
3548 (pcase (string-to-char (match-string 3 raw-value
))
3549 (?h
'hour
) (?d
'day
) (?w
'week
) (?m
'month
) (_ 'year
)))))
3550 year-start month-start day-start hour-start minute-start year-end
3551 month-end day-end hour-end minute-end
)
3552 ;; Parse date-start.
3554 (let ((date (org-parse-time-string date-start t
)))
3555 (setq year-start
(nth 5 date
)
3556 month-start
(nth 4 date
)
3557 day-start
(nth 3 date
)
3558 hour-start
(nth 2 date
)
3559 minute-start
(nth 1 date
))))
3560 ;; Compute date-end. It can be provided directly in time-stamp,
3561 ;; or extracted from time range. Otherwise, it defaults to the
3562 ;; same values as date-start.
3564 (let ((date (and date-end
(org-parse-time-string date-end t
))))
3565 (setq year-end
(or (nth 5 date
) year-start
)
3566 month-end
(or (nth 4 date
) month-start
)
3567 day-end
(or (nth 3 date
) day-start
)
3568 hour-end
(or (nth 2 date
) (car time-range
) hour-start
)
3569 minute-end
(or (nth 1 date
) (cdr time-range
) minute-start
))))
3571 (nconc (list :type type
3572 :raw-value raw-value
3573 :year-start year-start
3574 :month-start month-start
3575 :day-start day-start
3576 :hour-start hour-start
3577 :minute-start minute-start
3579 :month-end month-end
3582 :minute-end minute-end
3585 :post-blank post-blank
)
3589 (defun org-element-timestamp-interpreter (timestamp _
)
3590 "Interpret TIMESTAMP object as Org syntax."
3591 (let* ((repeat-string
3593 (pcase (org-element-property :repeater-type timestamp
)
3594 (`cumulate
"+") (`catch-up
"++") (`restart
".+"))
3595 (let ((val (org-element-property :repeater-value timestamp
)))
3596 (and val
(number-to-string val
)))
3597 (pcase (org-element-property :repeater-unit timestamp
)
3598 (`hour
"h") (`day
"d") (`week
"w") (`month
"m") (`year
"y"))))
3601 (pcase (org-element-property :warning-type timestamp
)
3602 (`first
"--") (`all
"-"))
3603 (let ((val (org-element-property :warning-value timestamp
)))
3604 (and val
(number-to-string val
)))
3605 (pcase (org-element-property :warning-unit timestamp
)
3606 (`hour
"h") (`day
"d") (`week
"w") (`month
"m") (`year
"y"))))
3608 ;; Build an Org timestamp string from TIME. ACTIVEP is
3609 ;; non-nil when time stamp is active. If WITH-TIME-P is
3610 ;; non-nil, add a time part. HOUR-END and MINUTE-END
3611 ;; specify a time range in the timestamp. REPEAT-STRING is
3612 ;; the repeater string, if any.
3613 (lambda (time activep
&optional with-time-p hour-end minute-end
)
3614 (let ((ts (format-time-string
3615 (funcall (if with-time-p
#'cdr
#'car
)
3616 org-time-stamp-formats
)
3618 (when (and hour-end minute-end
)
3619 (string-match "[012]?[0-9]:[0-5][0-9]" ts
)
3622 (format "\\&-%02d:%02d" hour-end minute-end
)
3624 (unless activep
(setq ts
(format "[%s]" (substring ts
1 -
1))))
3625 (dolist (s (list repeat-string warning-string
))
3626 (when (org-string-nw-p s
)
3627 (setq ts
(concat (substring ts
0 -
1)
3630 (substring ts -
1)))))
3633 (type (org-element-property :type timestamp
)))
3635 ((or `active
`inactive
)
3636 (let* ((minute-start (org-element-property :minute-start timestamp
))
3637 (minute-end (org-element-property :minute-end timestamp
))
3638 (hour-start (org-element-property :hour-start timestamp
))
3639 (hour-end (org-element-property :hour-end timestamp
))
3640 (time-range-p (and hour-start hour-end minute-start minute-end
3641 (or (/= hour-start hour-end
)
3642 (/= minute-start minute-end
)))))
3648 (org-element-property :day-start timestamp
)
3649 (org-element-property :month-start timestamp
)
3650 (org-element-property :year-start timestamp
))
3652 (and hour-start minute-start
)
3653 (and time-range-p hour-end
)
3654 (and time-range-p minute-end
))))
3655 ((or `active-range
`inactive-range
)
3656 (let ((minute-start (org-element-property :minute-start timestamp
))
3657 (minute-end (org-element-property :minute-end timestamp
))
3658 (hour-start (org-element-property :hour-start timestamp
))
3659 (hour-end (org-element-property :hour-end timestamp
)))
3662 build-ts-string
(encode-time
3666 (org-element-property :day-start timestamp
)
3667 (org-element-property :month-start timestamp
)
3668 (org-element-property :year-start timestamp
))
3669 (eq type
'active-range
)
3670 (and hour-start minute-start
))
3672 (funcall build-ts-string
3676 (org-element-property :day-end timestamp
)
3677 (org-element-property :month-end timestamp
)
3678 (org-element-property :year-end timestamp
))
3679 (eq type
'active-range
)
3680 (and hour-end minute-end
)))))
3681 (_ (org-element-property :raw-value timestamp
)))))
3686 (defun org-element-underline-parser ()
3687 "Parse underline object at point, if any.
3689 When at an underline object, return a list whose car is
3690 `underline' and cdr is a plist with `:begin', `:end',
3691 `:contents-begin' and `:contents-end' and `:post-blank' keywords.
3692 Otherwise, return nil.
3694 Assume point is at the first underscore marker."
3696 (unless (bolp) (backward-char 1))
3697 (when (looking-at org-emph-re
)
3698 (let ((begin (match-beginning 2))
3699 (contents-begin (match-beginning 4))
3700 (contents-end (match-end 4))
3701 (post-blank (progn (goto-char (match-end 2))
3702 (skip-chars-forward " \t")))
3707 :contents-begin contents-begin
3708 :contents-end contents-end
3709 :post-blank post-blank
))))))
3711 (defun org-element-underline-interpreter (_ contents
)
3712 "Interpret underline object as Org syntax.
3713 CONTENTS is the contents of the object."
3714 (format "_%s_" contents
))
3719 (defun org-element-verbatim-parser ()
3720 "Parse verbatim object at point, if any.
3722 When at a verbatim object, return a list whose car is `verbatim'
3723 and cdr is a plist with `:value', `:begin', `:end' and
3724 `:post-blank' keywords. Otherwise, return nil.
3726 Assume point is at the first equal sign marker."
3728 (unless (bolp) (backward-char 1))
3729 (when (looking-at org-emph-re
)
3730 (let ((begin (match-beginning 2))
3731 (value (match-string-no-properties 4))
3732 (post-blank (progn (goto-char (match-end 2))
3733 (skip-chars-forward " \t")))
3739 :post-blank post-blank
))))))
3741 (defun org-element-verbatim-interpreter (verbatim _
)
3742 "Interpret VERBATIM object as Org syntax."
3743 (format "=%s=" (org-element-property :value verbatim
)))
3747 ;;; Parsing Element Starting At Point
3749 ;; `org-element--current-element' is the core function of this section.
3750 ;; It returns the Lisp representation of the element starting at
3753 ;; `org-element--current-element' makes use of special modes. They
3754 ;; are activated for fixed element chaining (e.g., `plain-list' >
3755 ;; `item') or fixed conditional element chaining (e.g., `headline' >
3756 ;; `section'). Special modes are: `first-section', `item',
3757 ;; `node-property', `section' and `table-row'.
3759 (defun org-element--current-element (limit &optional granularity mode structure
)
3760 "Parse the element starting at point.
3762 Return value is a list like (TYPE PROPS) where TYPE is the type
3763 of the element and PROPS a plist of properties associated to the
3766 Possible types are defined in `org-element-all-elements'.
3768 LIMIT bounds the search.
3770 Optional argument GRANULARITY determines the depth of the
3771 recursion. Allowed values are `headline', `greater-element',
3772 `element', `object' or nil. When it is broader than `object' (or
3773 nil), secondary values will not be parsed, since they only
3776 Optional argument MODE, when non-nil, can be either
3777 `first-section', `section', `planning', `item', `node-property'
3780 If STRUCTURE isn't provided but MODE is set to `item', it will be
3783 This function assumes point is always at the beginning of the
3784 element it has to parse."
3786 (let ((case-fold-search t
)
3787 ;; Determine if parsing depth allows for secondary strings
3788 ;; parsing. It only applies to elements referenced in
3789 ;; `org-element-secondary-value-alist'.
3790 (raw-secondary-p (and granularity
(not (eq granularity
'object
)))))
3794 (org-element-item-parser limit structure raw-secondary-p
))
3796 ((eq mode
'table-row
) (org-element-table-row-parser limit
))
3798 ((eq mode
'node-property
) (org-element-node-property-parser limit
))
3800 ((org-with-limited-levels (org-at-heading-p))
3801 (org-element-headline-parser limit raw-secondary-p
))
3802 ;; Sections (must be checked after headline).
3803 ((eq mode
'section
) (org-element-section-parser limit
))
3804 ((eq mode
'first-section
)
3805 (org-element-section-parser
3806 (or (save-excursion (org-with-limited-levels (outline-next-heading)))
3809 ((and (eq mode
'planning
) (looking-at org-planning-line-re
))
3810 (org-element-planning-parser limit
))
3812 ((and (memq mode
'(planning property-drawer
))
3813 (looking-at org-property-drawer-re
))
3814 (org-element-property-drawer-parser limit
))
3815 ;; When not at bol, point is at the beginning of an item or
3816 ;; a footnote definition: next item is always a paragraph.
3817 ((not (bolp)) (org-element-paragraph-parser limit
(list (point))))
3819 ((looking-at org-clock-line-re
) (org-element-clock-parser limit
))
3822 (org-element-inlinetask-parser limit raw-secondary-p
))
3823 ;; From there, elements can have affiliated keywords.
3824 (t (let ((affiliated (org-element--collect-affiliated-keywords limit
)))
3826 ;; Jumping over affiliated keywords put point off-limits.
3827 ;; Parse them as regular keywords.
3828 ((and (cdr affiliated
) (>= (point) limit
))
3829 (goto-char (car affiliated
))
3830 (org-element-keyword-parser limit nil
))
3831 ;; LaTeX Environment.
3832 ((looking-at org-element--latex-begin-environment
)
3833 (org-element-latex-environment-parser limit affiliated
))
3834 ;; Drawer and Property Drawer.
3835 ((looking-at org-drawer-regexp
)
3836 (org-element-drawer-parser limit affiliated
))
3838 ((looking-at "[ \t]*:\\( \\|$\\)")
3839 (org-element-fixed-width-parser limit affiliated
))
3840 ;; Inline Comments, Blocks, Babel Calls, Dynamic Blocks and
3842 ((looking-at "[ \t]*#")
3843 (goto-char (match-end 0))
3845 ((looking-at "\\(?: \\|$\\)")
3847 (org-element-comment-parser limit affiliated
))
3848 ((looking-at "\\+BEGIN_\\(\\S-+\\)")
3850 (funcall (pcase (upcase (match-string 1))
3851 ("CENTER" #'org-element-center-block-parser
)
3852 ("COMMENT" #'org-element-comment-block-parser
)
3853 ("EXAMPLE" #'org-element-example-block-parser
)
3854 ("EXPORT" #'org-element-export-block-parser
)
3855 ("QUOTE" #'org-element-quote-block-parser
)
3856 ("SRC" #'org-element-src-block-parser
)
3857 ("VERSE" #'org-element-verse-block-parser
)
3858 (_ #'org-element-special-block-parser
))
3861 ((looking-at "\\+CALL:")
3863 (org-element-babel-call-parser limit affiliated
))
3864 ((looking-at "\\+BEGIN:? ")
3866 (org-element-dynamic-block-parser limit affiliated
))
3867 ((looking-at "\\+\\S-+:")
3869 (org-element-keyword-parser limit affiliated
))
3872 (org-element-paragraph-parser limit affiliated
))))
3873 ;; Footnote Definition.
3874 ((looking-at org-footnote-definition-re
)
3875 (org-element-footnote-definition-parser limit affiliated
))
3877 ((looking-at "[ \t]*-\\{5,\\}[ \t]*$")
3878 (org-element-horizontal-rule-parser limit affiliated
))
3881 (org-element-diary-sexp-parser limit affiliated
))
3883 ((looking-at "[ \t]*\\(|\\|\\+\\(-+\\+\\)+[ \t]*$\\)")
3884 (org-element-table-parser limit affiliated
))
3886 ((looking-at (org-item-re))
3887 (org-element-plain-list-parser
3889 (or structure
(org-element--list-struct limit
))))
3890 ;; Default element: Paragraph.
3891 (t (org-element-paragraph-parser limit affiliated
)))))))))
3894 ;; Most elements can have affiliated keywords. When looking for an
3895 ;; element beginning, we want to move before them, as they belong to
3896 ;; that element, and, in the meantime, collect information they give
3897 ;; into appropriate properties. Hence the following function.
3899 (defun org-element--collect-affiliated-keywords (limit)
3900 "Collect affiliated keywords from point down to LIMIT.
3902 Return a list whose CAR is the position at the first of them and
3903 CDR a plist of keywords and values and move point to the
3904 beginning of the first line after them.
3906 As a special case, if element doesn't start at the beginning of
3907 the line (e.g., a paragraph starting an item), CAR is current
3908 position of point and CDR is nil."
3909 (if (not (bolp)) (list (point))
3910 (let ((case-fold-search t
)
3912 ;; RESTRICT is the list of objects allowed in parsed
3914 (restrict (org-element-restriction 'keyword
))
3916 (while (and (< (point) limit
) (looking-at org-element--affiliated-re
))
3917 (let* ((raw-kwd (upcase (match-string 1)))
3918 ;; Apply translation to RAW-KWD. From there, KWD is
3919 ;; the official keyword.
3920 (kwd (or (cdr (assoc raw-kwd
3921 org-element-keyword-translation-alist
))
3923 ;; Find main value for any keyword.
3927 (buffer-substring-no-properties
3928 (match-end 0) (line-end-position)))))
3929 ;; PARSEDP is non-nil when keyword should have its
3931 (parsedp (member kwd org-element-parsed-keywords
))
3932 ;; If KWD is a dual keyword, find its secondary
3933 ;; value. Maybe parse it.
3934 (dualp (member kwd org-element-dual-keywords
))
3937 (let ((sec (match-string-no-properties 2)))
3938 (if (or (not sec
) (not parsedp
)) sec
3940 (org-element--parse-objects
3941 (match-beginning 2) (match-end 2) nil restrict
))))))
3942 ;; Attribute a property name to KWD.
3943 (kwd-sym (and kwd
(intern (concat ":" (downcase kwd
))))))
3944 ;; Now set final shape for VALUE.
3947 (org-element--parse-objects
3949 (progn (end-of-line) (skip-chars-backward " \t") (point))
3952 (setq value
(and (or value dual-value
) (cons value dual-value
))))
3953 (when (or (member kwd org-element-multiple-keywords
)
3954 ;; Attributes can always appear on multiple lines.
3955 (string-match "^ATTR_" kwd
))
3956 (setq value
(cons value
(plist-get output kwd-sym
))))
3957 ;; Eventually store the new value in OUTPUT.
3958 (setq output
(plist-put output kwd-sym value
))
3959 ;; Move to next keyword.
3961 ;; If affiliated keywords are orphaned: move back to first one.
3962 ;; They will be parsed as a paragraph.
3963 (when (looking-at "[ \t]*$") (goto-char origin
) (setq output nil
))
3965 (cons origin output
))))
3971 ;; The two major functions here are `org-element-parse-buffer', which
3972 ;; parses Org syntax inside the current buffer, taking into account
3973 ;; region, narrowing, or even visibility if specified, and
3974 ;; `org-element-parse-secondary-string', which parses objects within
3977 ;; The (almost) almighty `org-element-map' allows applying a function
3978 ;; on elements or objects matching some type, and accumulating the
3979 ;; resulting values. In an export situation, it also skips unneeded
3980 ;; parts of the parse tree.
3982 (defun org-element-parse-buffer (&optional granularity visible-only
)
3983 "Recursively parse the buffer and return structure.
3984 If narrowing is in effect, only parse the visible part of the
3987 Optional argument GRANULARITY determines the depth of the
3988 recursion. It can be set to the following symbols:
3990 `headline' Only parse headlines.
3991 `greater-element' Don't recurse into greater elements excepted
3992 headlines and sections. Thus, elements
3993 parsed are the top-level ones.
3994 `element' Parse everything but objects and plain text.
3995 `object' Parse the complete buffer (default).
3997 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4000 An element or an objects is represented as a list with the
4001 pattern (TYPE PROPERTIES CONTENTS), where :
4003 TYPE is a symbol describing the element or object. See
4004 `org-element-all-elements' and `org-element-all-objects' for an
4005 exhaustive list of such symbols. One can retrieve it with
4006 `org-element-type' function.
4008 PROPERTIES is the list of attributes attached to the element or
4009 object, as a plist. Although most of them are specific to the
4010 element or object type, all types share `:begin', `:end',
4011 `:post-blank' and `:parent' properties, which respectively
4012 refer to buffer position where the element or object starts,
4013 ends, the number of white spaces or blank lines after it, and
4014 the element or object containing it. Properties values can be
4015 obtained by using `org-element-property' function.
4017 CONTENTS is a list of elements, objects or raw strings
4018 contained in the current element or object, when applicable.
4019 One can access them with `org-element-contents' function.
4021 The Org buffer has `org-data' as type and nil as properties.
4022 `org-element-map' function can be used to find specific elements
4023 or objects within the parse tree.
4025 This function assumes that current major mode is `org-mode'."
4027 (goto-char (point-min))
4028 (org-skip-whitespace)
4029 (org-element--parse-elements
4030 (point-at-bol) (point-max)
4031 ;; Start in `first-section' mode so text before the first
4032 ;; headline belongs to a section.
4033 'first-section nil granularity visible-only
(list 'org-data nil
))))
4035 (defun org-element-parse-secondary-string (string restriction
&optional parent
)
4036 "Recursively parse objects in STRING and return structure.
4038 RESTRICTION is a symbol limiting the object types that will be
4041 Optional argument PARENT, when non-nil, is the element or object
4042 containing the secondary string. It is used to set correctly
4043 `:parent' property within the string.
4045 If STRING is the empty string or nil, return nil."
4048 ((equal string
"") nil
)
4049 (t (let ((local-variables (buffer-local-variables)))
4051 (dolist (v local-variables
)
4053 (if (symbolp v
) (makunbound v
)
4054 (set (make-local-variable (car v
)) (cdr v
)))))
4056 (restore-buffer-modified-p nil
)
4057 (org-element--parse-objects
4058 (point-min) (point-max) nil restriction parent
))))))
4060 (defun org-element-map
4061 (data types fun
&optional info first-match no-recursion with-affiliated
)
4062 "Map a function on selected elements or objects.
4064 DATA is a parse tree, an element, an object, a string, or a list
4065 of such constructs. TYPES is a symbol or list of symbols of
4066 elements or objects types (see `org-element-all-elements' and
4067 `org-element-all-objects' for a complete list of types). FUN is
4068 the function called on the matching element or object. It has to
4069 accept one argument: the element or object itself.
4071 When optional argument INFO is non-nil, it should be a plist
4072 holding export options. In that case, parts of the parse tree
4073 not exportable according to that property list will be skipped.
4075 When optional argument FIRST-MATCH is non-nil, stop at the first
4076 match for which FUN doesn't return nil, and return that value.
4078 Optional argument NO-RECURSION is a symbol or a list of symbols
4079 representing elements or objects types. `org-element-map' won't
4080 enter any recursive element or object whose type belongs to that
4081 list. Though, FUN can still be applied on them.
4083 When optional argument WITH-AFFILIATED is non-nil, FUN will also
4084 apply to matching objects within parsed affiliated keywords (see
4085 `org-element-parsed-keywords').
4087 Nil values returned from FUN do not appear in the results.
4093 Assuming TREE is a variable containing an Org buffer parse tree,
4094 the following example will return a flat list of all `src-block'
4095 and `example-block' elements in it:
4097 (org-element-map tree \\='(example-block src-block) #\\='identity)
4099 The following snippet will find the first headline with a level
4100 of 1 and a \"phone\" tag, and will return its beginning position:
4102 (org-element-map tree \\='headline
4104 (and (= (org-element-property :level hl) 1)
4105 (member \"phone\" (org-element-property :tags hl))
4106 (org-element-property :begin hl)))
4109 The next example will return a flat list of all `plain-list' type
4110 elements in TREE that are not a sub-list themselves:
4112 (org-element-map tree \\='plain-list #\\='identity nil nil \\='plain-list)
4114 Eventually, this example will return a flat list of all `bold'
4115 type objects containing a `latex-snippet' type object, even
4116 looking into captions:
4118 (org-element-map tree \\='bold
4120 (and (org-element-map b \\='latex-snippet #\\='identity nil t) b))
4122 ;; Ensure TYPES and NO-RECURSION are a list, even of one element.
4123 (let* ((types (if (listp types
) types
(list types
)))
4124 (no-recursion (if (listp no-recursion
) no-recursion
4125 (list no-recursion
)))
4126 ;; Recursion depth is determined by --CATEGORY.
4129 (let ((category 'greater-elements
)
4130 (all-objects (cons 'plain-text org-element-all-objects
)))
4131 (dolist (type types category
)
4132 (cond ((memq type all-objects
)
4133 ;; If one object is found, the function has
4134 ;; to recurse into every object.
4135 (throw :--found
'objects
))
4136 ((not (memq type org-element-greater-elements
))
4137 ;; If one regular element is found, the
4138 ;; function has to recurse, at least, into
4139 ;; every element it encounters.
4140 (and (not (eq category
'elements
))
4141 (setq category
'elements
))))))))
4143 (letrec ((--walk-tree
4145 ;; Recursively walk DATA. INFO, if non-nil, is a plist
4146 ;; holding contextual information.
4147 (let ((--type (org-element-type --data
)))
4150 ;; Ignored element in an export context.
4151 ((and info
(memq --data
(plist-get info
:ignore-list
))))
4152 ;; List of elements or objects.
4153 ((not --type
) (mapc --walk-tree --data
))
4154 ;; Unconditionally enter parse trees.
4155 ((eq --type
'org-data
)
4156 (mapc --walk-tree
(org-element-contents --data
)))
4158 ;; Check if TYPE is matching among TYPES. If so,
4159 ;; apply FUN to --DATA and accumulate return value
4160 ;; into --ACC (or exit if FIRST-MATCH is non-nil).
4161 (when (memq --type types
)
4162 (let ((result (funcall fun --data
)))
4163 (cond ((not result
))
4164 (first-match (throw :--map-first-match result
))
4165 (t (push result --acc
)))))
4166 ;; If --DATA has a secondary string that can contain
4167 ;; objects with their type among TYPES, look inside.
4168 (when (and (eq --category
'objects
) (not (stringp --data
)))
4169 (dolist (p (cdr (assq --type
4170 org-element-secondary-value-alist
)))
4171 (funcall --walk-tree
(org-element-property p --data
))))
4172 ;; If --DATA has any parsed affiliated keywords and
4173 ;; WITH-AFFILIATED is non-nil, look for objects in
4175 (when (and with-affiliated
4176 (eq --category
'objects
)
4177 (memq --type org-element-all-elements
))
4178 (dolist (kwd-pair org-element--parsed-properties-alist
)
4179 (let ((kwd (car kwd-pair
))
4180 (value (org-element-property (cdr kwd-pair
) --data
)))
4181 ;; Pay attention to the type of parsed
4182 ;; keyword. In particular, preserve order for
4183 ;; multiple keywords.
4186 ((member kwd org-element-dual-keywords
)
4187 (if (member kwd org-element-multiple-keywords
)
4188 (dolist (line (reverse value
))
4189 (funcall --walk-tree
(cdr line
))
4190 (funcall --walk-tree
(car line
)))
4191 (funcall --walk-tree
(cdr value
))
4192 (funcall --walk-tree
(car value
))))
4193 ((member kwd org-element-multiple-keywords
)
4194 (mapc --walk-tree
(reverse value
)))
4195 (t (funcall --walk-tree value
))))))
4196 ;; Determine if a recursion into --DATA is possible.
4198 ;; --TYPE is explicitly removed from recursion.
4199 ((memq --type no-recursion
))
4200 ;; --DATA has no contents.
4201 ((not (org-element-contents --data
)))
4202 ;; Looking for greater elements but --DATA is
4203 ;; simply an element or an object.
4204 ((and (eq --category
'greater-elements
)
4205 (not (memq --type org-element-greater-elements
))))
4206 ;; Looking for elements but --DATA is an object.
4207 ((and (eq --category
'elements
)
4208 (memq --type org-element-all-objects
)))
4209 ;; In any other case, map contents.
4210 (t (mapc --walk-tree
(org-element-contents --data
))))))))))
4211 (catch :--map-first-match
4212 (funcall --walk-tree data
)
4213 ;; Return value in a proper order.
4214 (nreverse --acc
)))))
4215 (put 'org-element-map
'lisp-indent-function
2)
4217 ;; The following functions are internal parts of the parser.
4219 ;; The first one, `org-element--parse-elements' acts at the element's
4222 ;; The second one, `org-element--parse-objects' applies on all objects
4223 ;; of a paragraph or a secondary string. It calls
4224 ;; `org-element--object-lex' to find the next object in the current
4227 (defsubst org-element--next-mode
(type parentp
)
4228 "Return next special mode according to TYPE, or nil.
4229 TYPE is a symbol representing the type of an element or object
4230 containing next element if PARENTP is non-nil, or before it
4231 otherwise. Modes can be either `first-section', `item',
4232 `node-property', `planning', `property-drawer', `section',
4233 `table-row' or nil."
4236 (`headline
'section
)
4237 (`inlinetask
'planning
)
4239 (`property-drawer
'node-property
)
4240 (`section
'planning
)
4241 (`table
'table-row
))
4244 (`node-property
'node-property
)
4245 (`planning
'property-drawer
)
4246 (`table-row
'table-row
))))
4248 (defun org-element--parse-elements
4249 (beg end mode structure granularity visible-only acc
)
4250 "Parse elements between BEG and END positions.
4252 MODE prioritizes some elements over the others. It can be set to
4253 `first-section', `section', `planning', `item', `node-property'
4256 When value is `item', STRUCTURE will be used as the current list
4259 GRANULARITY determines the depth of the recursion. See
4260 `org-element-parse-buffer' for more information.
4262 When VISIBLE-ONLY is non-nil, don't parse contents of hidden
4265 Elements are accumulated into ACC."
4268 ;; Visible only: skip invisible parts at the beginning of the
4270 (when (and visible-only
(org-invisible-p2))
4271 (goto-char (min (1+ (org-find-visible)) end
)))
4272 ;; When parsing only headlines, skip any text before first one.
4273 (when (and (eq granularity
'headline
) (not (org-at-heading-p)))
4274 (org-with-limited-levels (outline-next-heading)))
4276 (while (< (point) end
)
4277 ;; Find current element's type and parse it accordingly to
4279 (let* ((element (org-element--current-element
4280 end granularity mode structure
))
4281 (type (org-element-type element
))
4282 (cbeg (org-element-property :contents-begin element
)))
4283 (goto-char (org-element-property :end element
))
4284 ;; Visible only: skip invisible parts between siblings.
4285 (when (and visible-only
(org-invisible-p2))
4286 (goto-char (min (1+ (org-find-visible)) end
)))
4287 ;; Fill ELEMENT contents by side-effect.
4289 ;; If element has no contents, don't modify it.
4291 ;; Greater element: parse it between `contents-begin' and
4292 ;; `contents-end'. Make sure GRANULARITY allows the
4293 ;; recursion, or ELEMENT is a headline, in which case going
4294 ;; inside is mandatory, in order to get sub-level headings.
4295 ((and (memq type org-element-greater-elements
)
4296 (or (memq granularity
'(element object nil
))
4297 (and (eq granularity
'greater-element
)
4299 (eq type
'headline
)))
4300 (org-element--parse-elements
4301 cbeg
(org-element-property :contents-end element
)
4302 ;; Possibly switch to a special mode.
4303 (org-element--next-mode type t
)
4304 (and (memq type
'(item plain-list
))
4305 (org-element-property :structure element
))
4306 granularity visible-only element
))
4307 ;; ELEMENT has contents. Parse objects inside, if
4308 ;; GRANULARITY allows it.
4309 ((memq granularity
'(object nil
))
4310 (org-element--parse-objects
4311 cbeg
(org-element-property :contents-end element
) element
4312 (org-element-restriction type
))))
4313 (push (org-element-put-property element
:parent acc
) elements
)
4315 (setq mode
(org-element--next-mode type nil
))))
4317 (apply #'org-element-set-contents acc
(nreverse elements
)))))
4319 (defun org-element--object-lex (restriction)
4320 "Return next object in current buffer or nil.
4321 RESTRICTION is a list of object types, as symbols, that should be
4322 looked after. This function assumes that the buffer is narrowed
4323 to an appropriate container (e.g., a paragraph)."
4324 (if (memq 'table-cell restriction
) (org-element-table-cell-parser)
4326 (let ((limit (and org-target-link-regexp
4328 (or (bolp) (backward-char))
4329 (re-search-forward org-target-link-regexp nil t
))
4330 (match-beginning 1)))
4332 (while (and (not found
)
4333 (re-search-forward org-element--object-regexp limit t
))
4334 (goto-char (match-beginning 0))
4335 (let ((result (match-string 0)))
4338 ((eq (compare-strings result nil nil
"call_" nil nil t
) t
)
4339 (and (memq 'inline-babel-call restriction
)
4340 (org-element-inline-babel-call-parser)))
4341 ((eq (compare-strings result nil nil
"src_" nil nil t
) t
)
4342 (and (memq 'inline-src-block restriction
)
4343 (org-element-inline-src-block-parser)))
4346 (?^
(and (memq 'superscript restriction
)
4347 (org-element-superscript-parser)))
4348 (?_
(or (and (memq 'subscript restriction
)
4349 (org-element-subscript-parser))
4350 (and (memq 'underline restriction
)
4351 (org-element-underline-parser))))
4352 (?
* (and (memq 'bold restriction
)
4353 (org-element-bold-parser)))
4354 (?
/ (and (memq 'italic restriction
)
4355 (org-element-italic-parser)))
4356 (?~
(and (memq 'code restriction
)
4357 (org-element-code-parser)))
4358 (?
= (and (memq 'verbatim restriction
)
4359 (org-element-verbatim-parser)))
4360 (?
+ (and (memq 'strike-through restriction
)
4361 (org-element-strike-through-parser)))
4362 (?
@ (and (memq 'export-snippet restriction
)
4363 (org-element-export-snippet-parser)))
4364 (?
{ (and (memq 'macro restriction
)
4365 (org-element-macro-parser)))
4366 (?$
(and (memq 'latex-fragment restriction
)
4367 (org-element-latex-fragment-parser)))
4369 (if (eq (aref result
1) ?
<)
4370 (or (and (memq 'radio-target restriction
)
4371 (org-element-radio-target-parser))
4372 (and (memq 'target restriction
)
4373 (org-element-target-parser)))
4374 (or (and (memq 'timestamp restriction
)
4375 (org-element-timestamp-parser))
4376 (and (or (memq 'link restriction
)
4377 (memq 'simple-link restriction
))
4378 (org-element-link-parser)))))
4380 (if (eq (aref result
1) ?
\\)
4381 (and (memq 'line-break restriction
)
4382 (org-element-line-break-parser))
4383 (or (and (memq 'entity restriction
)
4384 (org-element-entity-parser))
4385 (and (memq 'latex-fragment restriction
)
4386 (org-element-latex-fragment-parser)))))
4388 (if (eq (aref result
1) ?\
[)
4389 (and (memq 'link restriction
)
4390 (org-element-link-parser))
4391 (or (and (memq 'footnote-reference restriction
)
4392 (org-element-footnote-reference-parser))
4393 (and (memq 'timestamp restriction
)
4394 (org-element-timestamp-parser))
4395 (and (memq 'statistics-cookie restriction
)
4396 (org-element-statistics-cookie-parser)))))
4397 ;; This is probably a plain link.
4398 (_ (and (or (memq 'link restriction
)
4399 (memq 'simple-link restriction
))
4400 (org-element-link-parser)))))))
4401 (or (eobp) (forward-char))))
4404 ((and limit
(memq 'link restriction
))
4405 (goto-char limit
) (org-element-link-parser)))))))
4407 (defun org-element--parse-objects (beg end acc restriction
&optional parent
)
4408 "Parse objects between BEG and END and return recursive structure.
4410 Objects are accumulated in ACC. RESTRICTION is a list of object
4411 successors which are allowed in the current object.
4413 ACC becomes the parent for all parsed objects. However, if ACC
4414 is nil (i.e., a secondary string is being parsed) and optional
4415 argument PARENT is non-nil, use it as the parent for all objects.
4416 Eventually, if both ACC and PARENT are nil, the common parent is
4417 the list of objects itself."
4420 (narrow-to-region beg end
)
4421 (goto-char (point-min))
4422 (let (next-object contents
)
4423 (while (and (not (eobp))
4424 (setq next-object
(org-element--object-lex restriction
)))
4425 ;; Text before any object. Untabify it.
4426 (let ((obj-beg (org-element-property :begin next-object
)))
4427 (unless (= (point) obj-beg
)
4428 (let ((text (buffer-substring-no-properties (point) obj-beg
)))
4429 (push (if acc
(org-element-put-property text
:parent acc
) text
)
4432 (let ((obj-end (org-element-property :end next-object
))
4433 (cont-beg (org-element-property :contents-begin next-object
)))
4434 (when acc
(org-element-put-property next-object
:parent acc
))
4436 ;; Fill contents of NEXT-OBJECT if possible.
4437 (org-element--parse-objects
4439 (org-element-property :contents-end next-object
)
4441 (org-element-restriction next-object
))
4444 (goto-char obj-end
)))
4445 ;; Text after last object. Untabify it.
4447 (let ((text (buffer-substring-no-properties (point) end
)))
4448 (push (if acc
(org-element-put-property text
:parent acc
) text
)
4450 ;; Result. Set appropriate parent.
4451 (if acc
(apply #'org-element-set-contents acc
(nreverse contents
))
4452 (let* ((contents (nreverse contents
))
4453 (parent (or parent contents
)))
4454 (dolist (datum contents contents
)
4455 (org-element-put-property datum
:parent parent
))))))))
4459 ;;; Towards A Bijective Process
4461 ;; The parse tree obtained with `org-element-parse-buffer' is really
4462 ;; a snapshot of the corresponding Org buffer. Therefore, it can be
4463 ;; interpreted and expanded into a string with canonical Org syntax.
4464 ;; Hence `org-element-interpret-data'.
4466 ;; The function relies internally on
4467 ;; `org-element--interpret-affiliated-keywords'.
4470 (defun org-element-interpret-data (data)
4471 "Interpret DATA as Org syntax.
4472 DATA is a parse tree, an element, an object or a secondary string
4473 to interpret. Return Org syntax as a string."
4475 (lambda (data parent
)
4476 (let* ((type (org-element-type data
))
4477 ;; Find interpreter for current object or
4478 ;; element. If it doesn't exist (e.g. this is
4479 ;; a pseudo object or element), return contents,
4483 (format "org-element-%s-interpreter" type
))))
4484 (if (fboundp fun
) fun
(lambda (_ contents
) contents
))))
4487 ;; Secondary string.
4489 (mapconcat (lambda (obj) (funcall fun obj parent
))
4492 ;; Full Org document.
4493 ((eq type
'org-data
)
4494 (mapconcat (lambda (obj) (funcall fun obj parent
))
4495 (org-element-contents data
)
4497 ;; Plain text: return it.
4498 ((stringp data
) data
)
4499 ;; Element or object without contents.
4500 ((not (org-element-contents data
))
4501 (funcall interpret data nil
))
4502 ;; Element or object with contents.
4507 ;; Recursively interpret contents.
4509 (lambda (datum) (funcall fun datum data
))
4510 (org-element-contents
4511 (if (not (memq type
'(paragraph verse-block
)))
4513 ;; Fix indentation of elements containing
4514 ;; objects. We ignore `table-row'
4515 ;; elements as they are one line long
4517 (org-element-normalize-contents
4519 ;; When normalizing first paragraph of
4520 ;; an item or a footnote-definition,
4521 ;; ignore first line's indentation.
4522 (and (eq type
'paragraph
)
4523 (memq (org-element-type parent
)
4524 '(footnote-definition item
))
4526 (car (org-element-contents parent
)))))))
4528 (if (memq type
'(org-data plain-text nil
)) results
4529 ;; Build white spaces. If no `:post-blank' property
4530 ;; is specified, assume its value is 0.
4531 (let ((blank (or (org-element-property :post-blank data
) 0)))
4532 (if (or (memq type org-element-all-objects
)
4533 (and (not (memq type org-element-all-elements
))
4535 (let ((type (org-element-type parent
)))
4538 org-element-object-containers
)))))
4539 (concat results
(make-string blank ?\s
))
4541 (org-element--interpret-affiliated-keywords data
)
4542 (org-element-normalize-string results
)
4543 (make-string blank ?
\n)))))))))
4544 (funcall fun data nil
)))
4546 (defun org-element--interpret-affiliated-keywords (element)
4547 "Return ELEMENT's affiliated keywords as Org syntax.
4548 If there is no affiliated keyword, return the empty string."
4549 (let ((keyword-to-org
4553 (when (member key org-element-dual-keywords
)
4554 (setq dual
(cdr value
) value
(car value
)))
4557 (format "[%s]" (org-element-interpret-data dual
)))
4559 (if (member key org-element-parsed-keywords
)
4560 (org-element-interpret-data value
)
4565 (let ((value (org-element-property prop element
))
4566 (keyword (upcase (substring (symbol-name prop
) 1))))
4568 (if (or (member keyword org-element-multiple-keywords
)
4569 ;; All attribute keywords can have multiple lines.
4570 (string-match "^ATTR_" keyword
))
4571 (mapconcat (lambda (line) (funcall keyword-to-org keyword line
))
4574 (funcall keyword-to-org keyword value
)))))
4575 ;; List all ELEMENT's properties matching an attribute line or an
4576 ;; affiliated keyword, but ignore translated keywords since they
4577 ;; cannot belong to the property list.
4578 (cl-loop for prop in
(nth 1 element
) by
'cddr
4579 when
(let ((keyword (upcase (substring (symbol-name prop
) 1))))
4580 (or (string-match "^ATTR_" keyword
)
4582 (member keyword org-element-affiliated-keywords
)
4584 org-element-keyword-translation-alist
)))))
4588 ;; Because interpretation of the parse tree must return the same
4589 ;; number of blank lines between elements and the same number of white
4590 ;; space after objects, some special care must be given to white
4593 ;; The first function, `org-element-normalize-string', ensures any
4594 ;; string different from the empty string will end with a single
4595 ;; newline character.
4597 ;; The second function, `org-element-normalize-contents', removes
4598 ;; global indentation from the contents of the current element.
4600 (defun org-element-normalize-string (s)
4601 "Ensure string S ends with a single newline character.
4603 If S isn't a string return it unchanged. If S is the empty
4604 string, return it. Otherwise, return a new string with a single
4605 newline character at its end."
4607 ((not (stringp s
)) s
)
4609 (t (and (string-match "\\(\n[ \t]*\\)*\\'" s
)
4610 (replace-match "\n" nil nil s
)))))
4612 (defun org-element-normalize-contents (element &optional ignore-first
)
4613 "Normalize plain text in ELEMENT's contents.
4615 ELEMENT must only contain plain text and objects.
4617 If optional argument IGNORE-FIRST is non-nil, ignore first line's
4618 indentation to compute maximal common indentation.
4620 Return the normalized element that is element with global
4621 indentation removed from its contents."
4622 (letrec ((find-min-ind
4623 ;; Return minimal common indentation within BLOB. This is
4624 ;; done by walking recursively BLOB and updating MIN-IND
4625 ;; along the way. FIRST-FLAG is non-nil when the next
4626 ;; object is expected to be a string that doesn't start
4627 ;; with a newline character. It happens for strings at
4628 ;; the beginnings of the contents or right after a line
4630 (lambda (blob first-flag min-ind
)
4632 (dolist (datum (org-element-contents blob
) min-ind
)
4634 (setq first-flag nil
)
4636 ;; Objects cannot start with spaces: in this
4637 ;; case, indentation is 0.
4638 ((not (stringp datum
)) (throw 'zero
0))
4640 "\\`\\([ \t]+\\)\\([^ \t\n]\\|\n\\|\\'\\)" datum
))
4642 ((equal (match-string 2 datum
) "\n")
4644 (match-beginning 1) (match-end 1) 'org-ind
'empty datum
))
4646 (let ((i (string-width (match-string 1 datum
))))
4648 (match-beginning 1) (match-end 1) 'org-ind i datum
)
4649 (setq min-ind
(min i min-ind
))))))
4653 (while (string-match
4654 "\n\\([ \t]+\\)\\([^ \t\n]\\|\n\\|\\'\\)" datum s
)
4655 (setq s
(match-end 1))
4656 (if (equal (match-string 2 datum
) "\n")
4658 (match-beginning 1) (match-end 1)
4661 (let ((i (string-width (match-string 1 datum
))))
4663 (match-beginning 1) (match-end 1) 'org-ind i datum
)
4664 (setq min-ind
(min i min-ind
)))))))
4665 ((eq (org-element-type datum
) 'line-break
)
4666 (setq first-flag t
))
4667 ((memq (org-element-type datum
) org-element-recursive-objects
)
4669 (funcall find-min-ind datum first-flag min-ind
))))))))
4670 (min-ind (funcall find-min-ind
4671 element
(not ignore-first
) most-positive-fixnum
)))
4672 (if (or (zerop min-ind
) (= min-ind most-positive-fixnum
)) element
4673 ;; Build ELEMENT back, replacing each string with the same
4674 ;; string minus common indentation.
4677 ;; Return DATUM with all its strings indentation
4678 ;; shortened from MIN-IND white spaces.
4687 (let ((s (point-min)))
4688 (while (setq s
(text-property-not-all
4689 s
(point-max) 'org-ind nil
))
4691 (let ((i (get-text-property s
'org-ind
)))
4692 (delete-region s
(progn
4693 (skip-chars-forward " \t")
4695 (when (integerp i
) (indent-to (- i min-ind
))))))
4697 ((memq (org-element-type object
)
4698 org-element-recursive-objects
)
4699 (funcall build object
))
4701 (org-element-contents datum
)))
4703 (funcall build element
)))))
4709 ;; Implement a caching mechanism for `org-element-at-point' and
4710 ;; `org-element-context', which see.
4712 ;; A single public function is provided: `org-element-cache-reset'.
4714 ;; Cache is enabled by default, but can be disabled globally with
4715 ;; `org-element-use-cache'. `org-element-cache-sync-idle-time',
4716 ;; org-element-cache-sync-duration' and `org-element-cache-sync-break'
4717 ;; can be tweaked to control caching behaviour.
4719 ;; Internally, parsed elements are stored in an AVL tree,
4720 ;; `org-element--cache'. This tree is updated lazily: whenever
4721 ;; a change happens to the buffer, a synchronization request is
4722 ;; registered in `org-element--cache-sync-requests' (see
4723 ;; `org-element--cache-submit-request'). During idle time, requests
4724 ;; are processed by `org-element--cache-sync'. Synchronization also
4725 ;; happens when an element is required from the cache. In this case,
4726 ;; the process stops as soon as the needed element is up-to-date.
4728 ;; A synchronization request can only apply on a synchronized part of
4729 ;; the cache. Therefore, the cache is updated at least to the
4730 ;; location where the new request applies. Thus, requests are ordered
4731 ;; from left to right and all elements starting before the first
4732 ;; request are correct. This property is used by functions like
4733 ;; `org-element--cache-find' to retrieve elements in the part of the
4734 ;; cache that can be trusted.
4736 ;; A request applies to every element, starting from its original
4737 ;; location (or key, see below). When a request is processed, it
4738 ;; moves forward and may collide the next one. In this case, both
4739 ;; requests are merged into a new one that starts from that element.
4740 ;; As a consequence, the whole synchronization complexity does not
4741 ;; depend on the number of pending requests, but on the number of
4742 ;; elements the very first request will be applied on.
4744 ;; Elements cannot be accessed through their beginning position, which
4745 ;; may or may not be up-to-date. Instead, each element in the tree is
4746 ;; associated to a key, obtained with `org-element--cache-key'. This
4747 ;; mechanism is robust enough to preserve total order among elements
4748 ;; even when the tree is only partially synchronized.
4750 ;; Objects contained in an element are stored in a hash table,
4751 ;; `org-element--cache-objects'.
4754 (defvar org-element-use-cache t
4755 "Non nil when Org parser should cache its results.
4756 This is mostly for debugging purpose.")
4758 (defvar org-element-cache-sync-idle-time
0.6
4759 "Length, in seconds, of idle time before syncing cache.")
4761 (defvar org-element-cache-sync-duration
(seconds-to-time 0.04)
4762 "Maximum duration, as a time value, for a cache synchronization.
4763 If the synchronization is not over after this delay, the process
4764 pauses and resumes after `org-element-cache-sync-break'
4767 (defvar org-element-cache-sync-break
(seconds-to-time 0.3)
4768 "Duration, as a time value, of the pause between synchronizations.
4769 See `org-element-cache-sync-duration' for more information.")
4774 (defvar org-element--cache nil
4775 "AVL tree used to cache elements.
4776 Each node of the tree contains an element. Comparison is done
4777 with `org-element--cache-compare'. This cache is used in
4778 `org-element-at-point'.")
4780 (defvar org-element--cache-objects nil
4781 "Hash table used as to cache objects.
4782 Key is an element, as returned by `org-element-at-point', and
4783 value is an alist where each association is:
4785 \(PARENT COMPLETEP . OBJECTS)
4787 where PARENT is an element or object, COMPLETEP is a boolean,
4788 non-nil when all direct children of parent are already cached and
4789 OBJECTS is a list of such children, as objects, from farthest to
4792 In the following example, \\alpha, bold object and \\beta are
4793 contained within a paragraph
4797 If the paragraph is completely parsed, OBJECTS-DATA will be
4799 \((PARAGRAPH t BOLD-OBJECT ENTITY-OBJECT)
4800 \(BOLD-OBJECT t ENTITY-OBJECT))
4802 whereas in a partially parsed paragraph, it could be
4804 \((PARAGRAPH nil ENTITY-OBJECT))
4806 This cache is used in `org-element-context'.")
4808 (defvar org-element--cache-sync-requests nil
4809 "List of pending synchronization requests.
4811 A request is a vector with the following pattern:
4813 \[NEXT BEG END OFFSET PARENT PHASE]
4815 Processing a synchronization request consists of three phases:
4817 0. Delete modified elements,
4818 1. Fill missing area in cache,
4819 2. Shift positions and re-parent elements after the changes.
4821 During phase 0, NEXT is the key of the first element to be
4822 removed, BEG and END is buffer position delimiting the
4823 modifications. Elements starting between them (inclusive) are
4824 removed. So are elements whose parent is removed. PARENT, when
4825 non-nil, is the parent of the first element to be removed.
4827 During phase 1, NEXT is the key of the next known element in
4828 cache and BEG its beginning position. Parse buffer between that
4829 element and the one before it in order to determine the parent of
4830 the next element. Set PARENT to the element containing NEXT.
4832 During phase 2, NEXT is the key of the next element to shift in
4833 the parse tree. All elements starting from this one have their
4834 properties relatives to buffer positions shifted by integer
4835 OFFSET and, if they belong to element PARENT, are adopted by it.
4837 PHASE specifies the phase number, as an integer.")
4839 (defvar org-element--cache-sync-timer nil
4840 "Timer used for cache synchronization.")
4842 (defvar org-element--cache-sync-keys nil
4843 "Hash table used to store keys during synchronization.
4844 See `org-element--cache-key' for more information.")
4846 (defsubst org-element--cache-key
(element)
4847 "Return a unique key for ELEMENT in cache tree.
4849 Keys are used to keep a total order among elements in the cache.
4850 Comparison is done with `org-element--cache-key-less-p'.
4852 When no synchronization is taking place, a key is simply the
4853 beginning position of the element, or that position plus one in
4854 the case of an first item (respectively row) in
4855 a list (respectively a table).
4857 During a synchronization, the key is the one the element had when
4858 the cache was synchronized for the last time. Elements added to
4859 cache during the synchronization get a new key generated with
4860 `org-element--cache-generate-key'.
4862 Such keys are stored in `org-element--cache-sync-keys'. The hash
4863 table is cleared once the synchronization is complete."
4864 (or (gethash element org-element--cache-sync-keys
)
4865 (let* ((begin (org-element-property :begin element
))
4866 ;; Increase beginning position of items (respectively
4867 ;; table rows) by one, so the first item can get
4868 ;; a different key from its parent list (respectively
4870 (key (if (memq (org-element-type element
) '(item table-row
))
4873 (if org-element--cache-sync-requests
4874 (puthash element key org-element--cache-sync-keys
)
4877 (defun org-element--cache-generate-key (lower upper
)
4878 "Generate a key between LOWER and UPPER.
4880 LOWER and UPPER are integers or lists, possibly empty.
4882 If LOWER and UPPER are equals, return LOWER. Otherwise, return
4883 a unique key, as an integer or a list of integers, according to
4884 the following rules:
4886 - LOWER and UPPER are compared level-wise until values differ.
4888 - If, at a given level, LOWER and UPPER differ from more than
4889 2, the new key shares all the levels above with LOWER and
4890 gets a new level. Its value is the mean between LOWER and
4893 \(1 2) + (1 4) --> (1 3)
4895 - If LOWER has no value to compare with, it is assumed that its
4896 value is `most-negative-fixnum'. E.g.,
4904 where m is `most-negative-fixnum'. Likewise, if UPPER is
4905 short of levels, the current value is `most-positive-fixnum'.
4907 - If they differ from only one, the new key inherits from
4908 current LOWER level and fork it at the next level. E.g.,
4916 where M is `most-positive-fixnum'.
4918 - If the key is only one level long, it is returned as an
4921 \(1 2) + (3 2) --> 2
4923 When they are not equals, the function assumes that LOWER is
4924 lesser than UPPER, per `org-element--cache-key-less-p'."
4925 (if (equal lower upper
) lower
4926 (let ((lower (if (integerp lower
) (list lower
) lower
))
4927 (upper (if (integerp upper
) (list upper
) upper
))
4931 (let ((min (or (car lower
) most-negative-fixnum
))
4932 (max (cond (skip-upper most-positive-fixnum
)
4934 (t most-positive-fixnum
))))
4935 (if (< (1+ min
) max
)
4936 (let ((mean (+ (ash min -
1) (ash max -
1) (logand min max
1))))
4937 (throw 'exit
(if key
(nreverse (cons mean key
)) mean
)))
4938 (when (and (< min max
) (not skip-upper
))
4939 ;; When at a given level, LOWER and UPPER differ from
4940 ;; 1, ignore UPPER altogether. Instead create a key
4941 ;; between LOWER and the greatest key with the same
4942 ;; prefix as LOWER so far.
4943 (setq skip-upper t
))
4945 (setq lower
(cdr lower
) upper
(cdr upper
)))))))))
4947 (defsubst org-element--cache-key-less-p
(a b
)
4948 "Non-nil if key A is less than key B.
4949 A and B are either integers or lists of integers, as returned by
4950 `org-element--cache-key'."
4951 (if (integerp a
) (if (integerp b
) (< a b
) (<= a
(car b
)))
4952 (if (integerp b
) (< (car a
) b
)
4955 (cond ((car-less-than-car a b
) (throw 'exit t
))
4956 ((car-less-than-car b a
) (throw 'exit nil
))
4957 (t (setq a
(cdr a
) b
(cdr b
)))))
4958 ;; If A is empty, either keys are equal (B is also empty) and
4959 ;; we return nil, or A is lesser than B (B is longer) and we
4960 ;; return a non-nil value.
4962 ;; If A is not empty, B is necessarily empty and A is greater
4963 ;; than B (A is longer). Therefore, return nil.
4964 (and (null a
) b
)))))
4966 (defun org-element--cache-compare (a b
)
4967 "Non-nil when element A is located before element B."
4968 (org-element--cache-key-less-p (org-element--cache-key a
)
4969 (org-element--cache-key b
)))
4971 (defsubst org-element--cache-root
()
4972 "Return root value in cache.
4973 This function assumes `org-element--cache' is a valid AVL tree."
4974 (avl-tree--node-left (avl-tree--dummyroot org-element--cache
)))
4979 (defsubst org-element--cache-active-p
()
4980 "Non-nil when cache is active in current buffer."
4981 (and org-element-use-cache
4983 (derived-mode-p 'org-mode
)))
4985 (defun org-element--cache-find (pos &optional side
)
4986 "Find element in cache starting at POS or before.
4988 POS refers to a buffer position.
4990 When optional argument SIDE is non-nil, the function checks for
4991 elements starting at or past POS instead. If SIDE is `both', the
4992 function returns a cons cell where car is the first element
4993 starting at or before POS and cdr the first element starting
4996 The function can only find elements in the synchronized part of
4998 (let ((limit (and org-element--cache-sync-requests
4999 (aref (car org-element--cache-sync-requests
) 0)))
5000 (node (org-element--cache-root))
5003 (let* ((element (avl-tree--node-data node
))
5004 (begin (org-element-property :begin element
)))
5007 (not (org-element--cache-key-less-p
5008 (org-element--cache-key element
) limit
)))
5009 (setq node
(avl-tree--node-left node
)))
5012 node
(avl-tree--node-left node
)))
5015 node
(avl-tree--node-right node
)))
5016 ;; We found an element in cache starting at POS. If `side'
5017 ;; is `both' we also want the next one in order to generate
5018 ;; a key in-between.
5020 ;; If the element is the first row or item in a table or
5021 ;; a plain list, we always return the table or the plain
5024 ;; In any other case, we return the element found.
5026 (setq lower element
)
5027 (setq node
(avl-tree--node-right node
)))
5028 ((and (memq (org-element-type element
) '(item table-row
))
5029 (let ((parent (org-element-property :parent element
)))
5030 (and (= (org-element-property :begin element
)
5031 (org-element-property :contents-begin parent
))
5040 (`both
(cons lower upper
))
5044 (defun org-element--cache-put (element &optional data
)
5045 "Store ELEMENT in current buffer's cache, if allowed.
5046 When optional argument DATA is non-nil, assume is it object data
5047 relative to ELEMENT and store it in the objects cache."
5048 (cond ((not (org-element--cache-active-p)) nil
)
5050 (when org-element--cache-sync-requests
5051 ;; During synchronization, first build an appropriate key
5052 ;; for the new element so `avl-tree-enter' can insert it at
5053 ;; the right spot in the cache.
5054 (let ((keys (org-element--cache-find
5055 (org-element-property :begin element
) 'both
)))
5057 (org-element--cache-generate-key
5058 (and (car keys
) (org-element--cache-key (car keys
)))
5059 (cond ((cdr keys
) (org-element--cache-key (cdr keys
)))
5060 (org-element--cache-sync-requests
5061 (aref (car org-element--cache-sync-requests
) 0))))
5062 org-element--cache-sync-keys
)))
5063 (avl-tree-enter org-element--cache element
))
5064 ;; Headlines are not stored in cache, so objects in titles are
5065 ;; not stored either.
5066 ((eq (org-element-type element
) 'headline
) nil
)
5067 (t (puthash element data org-element--cache-objects
))))
5069 (defsubst org-element--cache-remove
(element)
5070 "Remove ELEMENT from cache.
5071 Assume ELEMENT belongs to cache and that a cache is active."
5072 (avl-tree-delete org-element--cache element
)
5073 (remhash element org-element--cache-objects
))
5076 ;;;; Synchronization
5078 (defsubst org-element--cache-set-timer
(buffer)
5079 "Set idle timer for cache synchronization in BUFFER."
5080 (when org-element--cache-sync-timer
5081 (cancel-timer org-element--cache-sync-timer
))
5082 (setq org-element--cache-sync-timer
5083 (run-with-idle-timer
5084 (let ((idle (current-idle-time)))
5085 (if idle
(time-add idle org-element-cache-sync-break
)
5086 org-element-cache-sync-idle-time
))
5088 #'org-element--cache-sync
5091 (defsubst org-element--cache-interrupt-p
(time-limit)
5092 "Non-nil when synchronization process should be interrupted.
5093 TIME-LIMIT is a time value or nil."
5095 (or (input-pending-p)
5096 (time-less-p time-limit
(current-time)))))
5098 (defsubst org-element--cache-shift-positions
(element offset
&optional props
)
5099 "Shift ELEMENT properties relative to buffer positions by OFFSET.
5101 Properties containing buffer positions are `:begin', `:end',
5102 `:contents-begin', `:contents-end' and `:structure'. When
5103 optional argument PROPS is a list of keywords, only shift
5104 properties provided in that list.
5106 Properties are modified by side-effect."
5107 (let ((properties (nth 1 element
)))
5108 ;; Shift `:structure' property for the first plain list only: it
5109 ;; is the only one that really matters and it prevents from
5110 ;; shifting it more than once.
5111 (when (and (or (not props
) (memq :structure props
))
5112 (eq (org-element-type element
) 'plain-list
)
5113 (not (eq (org-element-type (plist-get properties
:parent
))
5115 (dolist (item (plist-get properties
:structure
))
5116 (cl-incf (car item
) offset
)
5117 (cl-incf (nth 6 item
) offset
)))
5118 (dolist (key '(:begin
:contents-begin
:contents-end
:end
:post-affiliated
))
5119 (let ((value (and (or (not props
) (memq key props
))
5120 (plist-get properties key
))))
5121 (and value
(plist-put properties key
(+ offset value
)))))))
5123 (defun org-element--cache-sync (buffer &optional threshold future-change
)
5124 "Synchronize cache with recent modification in BUFFER.
5126 When optional argument THRESHOLD is non-nil, do the
5127 synchronization for all elements starting before or at threshold,
5128 then exit. Otherwise, synchronize cache for as long as
5129 `org-element-cache-sync-duration' or until Emacs leaves idle
5132 FUTURE-CHANGE, when non-nil, is a buffer position where changes
5133 not registered yet in the cache are going to happen. It is used
5134 in `org-element--cache-submit-request', where cache is partially
5135 updated before current modification are actually submitted."
5136 (when (buffer-live-p buffer
)
5137 (with-current-buffer buffer
5138 (let ((inhibit-quit t
) request next
)
5139 (when org-element--cache-sync-timer
5140 (cancel-timer org-element--cache-sync-timer
))
5142 (while org-element--cache-sync-requests
5143 (setq request
(car org-element--cache-sync-requests
)
5144 next
(nth 1 org-element--cache-sync-requests
))
5145 (org-element--cache-process-request
5147 (and next
(aref next
0))
5149 (and (not threshold
)
5150 (time-add (current-time)
5151 org-element-cache-sync-duration
))
5153 ;; Request processed. Merge current and next offsets and
5154 ;; transfer ending position.
5156 (cl-incf (aref next
3) (aref request
3))
5157 (aset next
2 (aref request
2)))
5158 (setq org-element--cache-sync-requests
5159 (cdr org-element--cache-sync-requests
))))
5160 ;; If more requests are awaiting, set idle timer accordingly.
5161 ;; Otherwise, reset keys.
5162 (if org-element--cache-sync-requests
5163 (org-element--cache-set-timer buffer
)
5164 (clrhash org-element--cache-sync-keys
))))))
5166 (defun org-element--cache-process-request
5167 (request next threshold time-limit future-change
)
5168 "Process synchronization REQUEST for all entries before NEXT.
5170 REQUEST is a vector, built by `org-element--cache-submit-request'.
5172 NEXT is a cache key, as returned by `org-element--cache-key'.
5174 When non-nil, THRESHOLD is a buffer position. Synchronization
5175 stops as soon as a shifted element begins after it.
5177 When non-nil, TIME-LIMIT is a time value. Synchronization stops
5178 after this time or when Emacs exits idle state.
5180 When non-nil, FUTURE-CHANGE is a buffer position where changes
5181 not registered yet in the cache are going to happen. See
5182 `org-element--cache-submit-request' for more information.
5184 Throw `interrupt' if the process stops before completing the
5187 (when (= (aref request
5) 0)
5190 ;; Delete all elements starting after BEG, but not after buffer
5191 ;; position END or past element with key NEXT. Also delete
5192 ;; elements contained within a previously removed element
5193 ;; (stored in `last-container').
5195 ;; At each iteration, we start again at tree root since
5196 ;; a deletion modifies structure of the balanced tree.
5199 (when (org-element--cache-interrupt-p time-limit
)
5200 (throw 'interrupt nil
))
5201 ;; Find first element in cache with key BEG or after it.
5202 (let ((beg (aref request
0))
5203 (end (aref request
2))
5204 (node (org-element--cache-root))
5205 data data-key last-container
)
5207 (let* ((element (avl-tree--node-data node
))
5208 (key (org-element--cache-key element
)))
5210 ((org-element--cache-key-less-p key beg
)
5211 (setq node
(avl-tree--node-right node
)))
5212 ((org-element--cache-key-less-p beg key
)
5215 node
(avl-tree--node-left node
)))
5216 (t (setq data element
5220 (let ((pos (org-element-property :begin data
)))
5221 (if (if (or (not next
)
5222 (org-element--cache-key-less-p data-key next
))
5226 (while (and up
(not (eq up last-container
)))
5227 (setq up
(org-element-property :parent up
)))
5229 (progn (when (and (not last-container
)
5230 (> (org-element-property :end data
)
5232 (setq last-container data
))
5233 (org-element--cache-remove data
))
5234 (aset request
0 data-key
)
5235 (aset request
1 pos
)
5237 (throw 'end-phase nil
)))
5238 ;; No element starting after modifications left in
5239 ;; cache: further processing is futile.
5240 (throw 'quit t
))))))
5241 (when (= (aref request
5) 1)
5244 ;; Phase 0 left a hole in the cache. Some elements after it
5245 ;; could have parents within. For example, in the following
5255 ;; if we remove a blank line between "item" and "Paragraph1",
5256 ;; everything down to "Paragraph2" is removed from cache. But
5257 ;; the paragraph now belongs to the list, and its `:parent'
5258 ;; property no longer is accurate.
5260 ;; Therefore we need to parse again elements in the hole, or at
5261 ;; least in its last section, so that we can re-parent
5262 ;; subsequent elements, during phase 2.
5264 ;; Note that we only need to get the parent from the first
5265 ;; element in cache after the hole.
5267 ;; When next key is lesser or equal to the current one, delegate
5268 ;; phase 1 processing to next request in order to preserve key
5269 ;; order among requests.
5270 (let ((key (aref request
0)))
5271 (when (and next
(not (org-element--cache-key-less-p key next
)))
5272 (let ((next-request (nth 1 org-element--cache-sync-requests
)))
5273 (aset next-request
0 key
)
5274 (aset next-request
1 (aref request
1))
5275 (aset next-request
5 1))
5277 ;; Next element will start at its beginning position plus
5278 ;; offset, since it hasn't been shifted yet. Therefore, LIMIT
5279 ;; contains the real beginning position of the first element to
5280 ;; shift and re-parent.
5281 (let ((limit (+ (aref request
1) (aref request
3))))
5282 (cond ((and threshold
(> limit threshold
)) (throw 'interrupt nil
))
5283 ((and future-change
(>= limit future-change
))
5284 ;; Changes are going to happen around this element and
5285 ;; they will trigger another phase 1 request. Skip the
5289 (let ((parent (org-element--parse-to limit t time-limit
)))
5290 (aset request
4 parent
)
5291 (aset request
5 2))))))
5294 ;; Shift all elements starting from key START, but before NEXT, by
5295 ;; OFFSET, and re-parent them when appropriate.
5297 ;; Elements are modified by side-effect so the tree structure
5300 ;; Once THRESHOLD, if any, is reached, or once there is an input
5301 ;; pending, exit. Before leaving, the current synchronization
5302 ;; request is updated.
5303 (let ((start (aref request
0))
5304 (offset (aref request
3))
5305 (parent (aref request
4))
5306 (node (org-element--cache-root))
5310 ;; No re-parenting nor shifting planned: request is over.
5311 (when (and (not parent
) (zerop offset
)) (throw 'quit t
))
5313 (let* ((data (avl-tree--node-data node
))
5314 (key (org-element--cache-key data
)))
5315 (if (and leftp
(avl-tree--node-left node
)
5316 (not (org-element--cache-key-less-p key start
)))
5317 (progn (push node stack
)
5318 (setq node
(avl-tree--node-left node
)))
5319 (unless (org-element--cache-key-less-p key start
)
5320 ;; We reached NEXT. Request is complete.
5321 (when (equal key next
) (throw 'quit t
))
5322 ;; Handle interruption request. Update current request.
5323 (when (or exit-flag
(org-element--cache-interrupt-p time-limit
))
5324 (aset request
0 key
)
5325 (aset request
4 parent
)
5326 (throw 'interrupt nil
))
5328 (unless (zerop offset
)
5329 (org-element--cache-shift-positions data offset
)
5330 ;; Shift associated objects data, if any.
5331 (dolist (object-data (gethash data org-element--cache-objects
))
5332 (dolist (object (cddr object-data
))
5333 (org-element--cache-shift-positions object offset
))))
5334 (let ((begin (org-element-property :begin data
)))
5335 ;; Update PARENT and re-parent DATA, only when
5336 ;; necessary. Propagate new structures for lists.
5338 (<= (org-element-property :end parent
) begin
))
5339 (setq parent
(org-element-property :parent parent
)))
5340 (cond ((and (not parent
) (zerop offset
)) (throw 'quit nil
))
5342 (let ((p (org-element-property :parent data
)))
5344 (< (org-element-property :begin p
)
5345 (org-element-property :begin parent
)))))
5346 (org-element-put-property data
:parent parent
)
5347 (let ((s (org-element-property :structure parent
)))
5348 (when (and s
(org-element-property :structure data
))
5349 (org-element-put-property data
:structure s
)))))
5350 ;; Cache is up-to-date past THRESHOLD. Request
5352 (when (and threshold
(> begin threshold
)) (setq exit-flag t
))))
5353 (setq node
(if (setq leftp
(avl-tree--node-right node
))
5354 (avl-tree--node-right node
)
5356 ;; We reached end of tree: synchronization complete.
5359 (defun org-element--parse-to (pos &optional syncp time-limit
)
5360 "Parse elements in current section, down to POS.
5362 Start parsing from the closest between the last known element in
5363 cache or headline above. Return the smallest element containing
5366 When optional argument SYNCP is non-nil, return the parent of the
5367 element containing POS instead. In that case, it is also
5368 possible to provide TIME-LIMIT, which is a time value specifying
5369 when the parsing should stop. The function throws `interrupt' if
5370 the process stopped before finding the expected result."
5372 (org-with-wide-buffer
5374 (let* ((cached (and (org-element--cache-active-p)
5375 (org-element--cache-find pos nil
)))
5376 (begin (org-element-property :begin cached
))
5379 ;; Nothing in cache before point: start parsing from first
5380 ;; element following headline above, or first element in
5383 (when (org-with-limited-levels (outline-previous-heading))
5384 (setq mode
'planning
)
5386 (skip-chars-forward " \r\t\n")
5387 (beginning-of-line))
5388 ;; Cache returned exact match: return it.
5390 (throw 'exit
(if syncp
(org-element-property :parent cached
) cached
)))
5391 ;; There's a headline between cached value and POS: cached
5392 ;; value is invalid. Start parsing from first element
5393 ;; following the headline.
5394 ((re-search-backward
5395 (org-with-limited-levels org-outline-regexp-bol
) begin t
)
5397 (skip-chars-forward " \r\t\n")
5399 (setq mode
'planning
))
5400 ;; Check if CACHED or any of its ancestors contain point.
5402 ;; If there is such an element, we inspect it in order to know
5403 ;; if we return it or if we need to parse its contents.
5404 ;; Otherwise, we just start parsing from current location,
5405 ;; which is right after the top-most element containing
5408 ;; As a special case, if POS is at the end of the buffer, we
5409 ;; want to return the innermost element ending there.
5411 ;; Also, if we find an ancestor and discover that we need to
5412 ;; parse its contents, make sure we don't start from
5413 ;; `:contents-begin', as we would otherwise go past CACHED
5414 ;; again. Instead, in that situation, we will resume parsing
5415 ;; from NEXT, which is located after CACHED or its higher
5416 ;; ancestor not containing point.
5419 (pos (if (= (point-max) pos
) (1- pos
) pos
)))
5420 (goto-char (or (org-element-property :contents-begin cached
) begin
))
5421 (while (let ((end (org-element-property :end up
)))
5424 (setq up
(org-element-property :parent up
)))))
5426 ((eobp) (setq element up
))
5427 (t (setq element up next
(point)))))))
5428 ;; Parse successively each element until we reach POS.
5429 (let ((end (or (org-element-property :end element
)
5431 (org-with-limited-levels (outline-next-heading))
5436 (cond ((= (point) pos
) (throw 'exit parent
))
5437 ((org-element--cache-interrupt-p time-limit
)
5438 (throw 'interrupt nil
))))
5440 (setq element
(org-element--current-element
5442 (org-element-property :structure parent
)))
5443 (org-element-put-property element
:parent parent
)
5444 (org-element--cache-put element
))
5445 (let ((elem-end (org-element-property :end element
))
5446 (type (org-element-type element
)))
5448 ;; Skip any element ending before point. Also skip
5449 ;; element ending at point (unless it is also the end of
5450 ;; buffer) since we're sure that another element begins
5452 ((and (<= elem-end pos
) (/= (point-max) elem-end
))
5453 (goto-char elem-end
)
5454 (setq mode
(org-element--next-mode type nil
)))
5455 ;; A non-greater element contains point: return it.
5456 ((not (memq type org-element-greater-elements
))
5457 (throw 'exit element
))
5458 ;; Otherwise, we have to decide if ELEMENT really
5459 ;; contains POS. In that case we start parsing from
5460 ;; contents' beginning.
5462 ;; If POS is at contents' beginning but it is also at
5463 ;; the beginning of the first item in a list or a table.
5464 ;; In that case, we need to create an anchor for that
5465 ;; list or table, so return it.
5467 ;; Also, if POS is at the end of the buffer, no element
5468 ;; can start after it, but more than one may end there.
5469 ;; Arbitrarily, we choose to return the innermost of
5471 ((let ((cbeg (org-element-property :contents-begin element
))
5472 (cend (org-element-property :contents-end element
)))
5477 (not (memq type
'(plain-list table
)))))
5479 (and (= cend pos
) (= (point-max) pos
)))))
5480 (goto-char (or next cbeg
))
5482 mode
(org-element--next-mode type t
)
5485 ;; Otherwise, return ELEMENT as it is the smallest
5486 ;; element containing POS.
5487 (t (throw 'exit element
))))
5488 (setq element nil
)))))))
5491 ;;;; Staging Buffer Changes
5493 (defconst org-element--cache-sensitive-re
5495 org-outline-regexp-bol
"\\|"
5496 "\\\\end{[A-Za-z0-9*]+}[ \t]*$" "\\|"
5498 "#\\+\\(?:BEGIN[:_]\\|END\\(?:_\\|:?[ \t]*$\\)\\)" "\\|"
5499 "\\\\begin{[A-Za-z0-9*]+}" "\\|"
5500 ":\\(?:\\w\\|[-_]\\)+:[ \t]*$"
5502 "Regexp matching a sensitive line, structure wise.
5503 A sensitive line is a headline, inlinetask, block, drawer, or
5504 latex-environment boundary. When such a line is modified,
5505 structure changes in the document may propagate in the whole
5506 section, possibly making cache invalid.")
5508 (defvar org-element--cache-change-warning nil
5509 "Non-nil when a sensitive line is about to be changed.
5510 It is a symbol among nil, t and `headline'.")
5512 (defun org-element--cache-before-change (beg end
)
5513 "Request extension of area going to be modified if needed.
5514 BEG and END are the beginning and end of the range of changed
5515 text. See `before-change-functions' for more information."
5516 (when (org-element--cache-active-p)
5517 (org-with-wide-buffer
5520 (let ((bottom (save-excursion (goto-char end
) (line-end-position))))
5521 (setq org-element--cache-change-warning
5523 (if (and (org-with-limited-levels (org-at-heading-p))
5524 (= (line-end-position) bottom
))
5526 (let ((case-fold-search t
))
5528 org-element--cache-sensitive-re bottom t
)))))))))
5530 (defun org-element--cache-after-change (beg end pre
)
5531 "Update buffer modifications for current buffer.
5532 BEG and END are the beginning and end of the range of changed
5533 text, and the length in bytes of the pre-change text replaced by
5534 that range. See `after-change-functions' for more information."
5535 (when (org-element--cache-active-p)
5536 (org-with-wide-buffer
5541 (bottom (save-excursion (goto-char end
) (line-end-position))))
5542 ;; Determine if modified area needs to be extended, according
5543 ;; to both previous and current state. We make a special
5544 ;; case for headline editing: if a headline is modified but
5545 ;; not removed, do not extend.
5546 (when (pcase org-element--cache-change-warning
5549 (not (and (org-with-limited-levels (org-at-heading-p))
5550 (= (line-end-position) bottom
))))
5552 (let ((case-fold-search t
))
5554 org-element--cache-sensitive-re bottom t
))))
5555 ;; Effectively extend modified area.
5556 (org-with-limited-levels
5557 (setq top
(progn (goto-char top
)
5558 (when (outline-previous-heading) (forward-line))
5560 (setq bottom
(progn (goto-char bottom
)
5561 (if (outline-next-heading) (1- (point))
5563 ;; Store synchronization request.
5564 (let ((offset (- end beg pre
)))
5565 (org-element--cache-submit-request top
(- bottom offset
) offset
)))))
5566 ;; Activate a timer to process the request during idle time.
5567 (org-element--cache-set-timer (current-buffer))))
5569 (defun org-element--cache-for-removal (beg end offset
)
5570 "Return first element to remove from cache.
5572 BEG and END are buffer positions delimiting buffer modifications.
5573 OFFSET is the size of the changes.
5575 Returned element is usually the first element in cache containing
5576 any position between BEG and END. As an exception, greater
5577 elements around the changes that are robust to contents
5578 modifications are preserved and updated according to the
5580 (let* ((elements (org-element--cache-find (1- beg
) 'both
))
5581 (before (car elements
))
5582 (after (cdr elements
)))
5583 (if (not before
) after
5587 (if (let ((type (org-element-type up
)))
5588 (and (or (memq type
'(center-block dynamic-block quote-block
5590 ;; Drawers named "PROPERTIES" are probably
5591 ;; a properties drawer being edited. Force
5592 ;; parsing to check if editing is over.
5593 (and (eq type
'drawer
)
5595 (org-element-property :drawer-name up
)
5597 (let ((cbeg (org-element-property :contents-begin up
)))
5600 (> (org-element-property :contents-end up
) end
)))))
5601 ;; UP is a robust greater element containing changes.
5602 ;; We only need to extend its ending boundaries.
5603 (org-element--cache-shift-positions
5604 up offset
'(:contents-end
:end
))
5606 (when robust-flag
(setq robust-flag nil
)))
5607 (setq up
(org-element-property :parent up
)))
5608 ;; We're at top level element containing ELEMENT: if it's
5609 ;; altered by buffer modifications, it is first element in
5610 ;; cache to be removed. Otherwise, that first element is the
5613 ;; As a special case, do not remove BEFORE if it is a robust
5614 ;; container for current changes.
5615 (if (or (< (org-element-property :end before
) beg
) robust-flag
) after
5618 (defun org-element--cache-submit-request (beg end offset
)
5619 "Submit a new cache synchronization request for current buffer.
5620 BEG and END are buffer positions delimiting the minimal area
5621 where cache data should be removed. OFFSET is the size of the
5622 change, as an integer."
5623 (let ((next (car org-element--cache-sync-requests
))
5624 delete-to delete-from
)
5626 (zerop (aref next
5))
5627 (> (setq delete-to
(+ (aref next
2) (aref next
3))) end
)
5628 (<= (setq delete-from
(aref next
1)) end
))
5629 ;; Current changes can be merged with first sync request: we
5630 ;; can save a partial cache synchronization.
5632 (cl-incf (aref next
3) offset
)
5633 ;; If last change happened within area to be removed, extend
5634 ;; boundaries of robust parents, if any. Otherwise, find
5635 ;; first element to remove and update request accordingly.
5636 (if (> beg delete-from
)
5637 (let ((up (aref next
4)))
5639 (org-element--cache-shift-positions
5640 up offset
'(:contents-end
:end
))
5641 (setq up
(org-element-property :parent up
))))
5642 (let ((first (org-element--cache-for-removal beg delete-to offset
)))
5644 (aset next
0 (org-element--cache-key first
))
5645 (aset next
1 (org-element-property :begin first
))
5646 (aset next
4 (org-element-property :parent first
))))))
5647 ;; Ensure cache is correct up to END. Also make sure that NEXT,
5648 ;; if any, is no longer a 0-phase request, thus ensuring that
5649 ;; phases are properly ordered. We need to provide OFFSET as
5650 ;; optional parameter since current modifications are not known
5651 ;; yet to the otherwise correct part of the cache (i.e, before
5652 ;; the first request).
5653 (when next
(org-element--cache-sync (current-buffer) end beg
))
5654 (let ((first (org-element--cache-for-removal beg end offset
)))
5656 (push (let ((beg (org-element-property :begin first
))
5657 (key (org-element--cache-key first
)))
5659 ;; When changes happen before the first known
5660 ;; element, re-parent and shift the rest of the
5662 ((> beg end
) (vector key beg nil offset nil
1))
5663 ;; Otherwise, we find the first non robust
5664 ;; element containing END. All elements between
5665 ;; FIRST and this one are to be removed.
5666 ((let ((first-end (org-element-property :end first
)))
5667 (and (> first-end end
)
5668 (vector key beg first-end offset first
0))))
5670 (let* ((element (org-element--cache-find end
))
5671 (end (org-element-property :end element
))
5673 (while (and (setq up
(org-element-property :parent up
))
5674 (>= (org-element-property :begin up
) beg
))
5675 (setq end
(org-element-property :end up
)
5677 (vector key beg end offset element
0)))))
5678 org-element--cache-sync-requests
)
5679 ;; No element to remove. No need to re-parent either.
5680 ;; Simply shift additional elements, if any, by OFFSET.
5681 (when org-element--cache-sync-requests
5682 (cl-incf (aref (car org-element--cache-sync-requests
) 3)
5686 ;;;; Public Functions
5689 (defun org-element-cache-reset (&optional all
)
5690 "Reset cache in current buffer.
5691 When optional argument ALL is non-nil, reset cache in all Org
5694 (dolist (buffer (if all
(buffer-list) (list (current-buffer))))
5695 (with-current-buffer buffer
5696 (when (and org-element-use-cache
(derived-mode-p 'org-mode
))
5697 (setq-local org-element--cache
5698 (avl-tree-create #'org-element--cache-compare
))
5699 (setq-local org-element--cache-objects
(make-hash-table :test
#'eq
))
5700 (setq-local org-element--cache-sync-keys
5701 (make-hash-table :weakness
'key
:test
#'eq
))
5702 (setq-local org-element--cache-change-warning nil
)
5703 (setq-local org-element--cache-sync-requests nil
)
5704 (setq-local org-element--cache-sync-timer nil
)
5705 (add-hook 'before-change-functions
5706 #'org-element--cache-before-change nil t
)
5707 (add-hook 'after-change-functions
5708 #'org-element--cache-after-change nil t
)))))
5711 (defun org-element-cache-refresh (pos)
5712 "Refresh cache at position POS."
5713 (when (org-element--cache-active-p)
5714 (org-element--cache-sync (current-buffer) pos
)
5715 (org-element--cache-submit-request pos pos
0)
5716 (org-element--cache-set-timer (current-buffer))))
5722 ;; The first move is to implement a way to obtain the smallest element
5723 ;; containing point. This is the job of `org-element-at-point'. It
5724 ;; basically jumps back to the beginning of section containing point
5725 ;; and proceed, one element after the other, with
5726 ;; `org-element--current-element' until the container is found. Note:
5727 ;; When using `org-element-at-point', secondary values are never
5728 ;; parsed since the function focuses on elements, not on objects.
5730 ;; At a deeper level, `org-element-context' lists all elements and
5731 ;; objects containing point.
5733 ;; `org-element-nested-p' and `org-element-swap-A-B' may be used
5734 ;; internally by navigation and manipulation tools.
5738 (defun org-element-at-point ()
5739 "Determine closest element around point.
5741 Return value is a list like (TYPE PROPS) where TYPE is the type
5742 of the element and PROPS a plist of properties associated to the
5745 Possible types are defined in `org-element-all-elements'.
5746 Properties depend on element or object type, but always include
5747 `:begin', `:end', `:parent' and `:post-blank' properties.
5749 As a special case, if point is at the very beginning of the first
5750 item in a list or sub-list, returned element will be that list
5751 instead of the item. Likewise, if point is at the beginning of
5752 the first row of a table, returned element will be the table
5753 instead of the first row.
5755 When point is at the end of the buffer, return the innermost
5756 element ending there."
5757 (org-with-wide-buffer
5758 (let ((origin (point)))
5760 (skip-chars-backward " \r\t\n")
5762 ;; Within blank lines at the beginning of buffer, return nil.
5764 ;; Within blank lines right after a headline, return that
5766 ((org-with-limited-levels (org-at-heading-p))
5768 (org-element-headline-parser (point-max) t
))
5769 ;; Otherwise parse until we find element containing ORIGIN.
5771 (when (org-element--cache-active-p)
5772 (if (not org-element--cache
) (org-element-cache-reset)
5773 (org-element--cache-sync (current-buffer) origin
)))
5774 (org-element--parse-to origin
))))))
5777 (defun org-element-context (&optional element
)
5778 "Return smallest element or object around point.
5780 Return value is a list like (TYPE PROPS) where TYPE is the type
5781 of the element or object and PROPS a plist of properties
5784 Possible types are defined in `org-element-all-elements' and
5785 `org-element-all-objects'. Properties depend on element or
5786 object type, but always include `:begin', `:end', `:parent' and
5789 As a special case, if point is right after an object and not at
5790 the beginning of any other object, return that object.
5792 Optional argument ELEMENT, when non-nil, is the closest element
5793 containing point, as returned by `org-element-at-point'.
5794 Providing it allows for quicker computation."
5795 (catch 'objects-forbidden
5796 (org-with-wide-buffer
5797 (let* ((pos (point))
5798 (element (or element
(org-element-at-point)))
5799 (type (org-element-type element
))
5800 (post (org-element-property :post-affiliated element
)))
5801 ;; If point is inside an element containing objects or
5802 ;; a secondary string, narrow buffer to the container and
5803 ;; proceed with parsing. Otherwise, return ELEMENT.
5805 ;; At a parsed affiliated keyword, check if we're inside main
5807 ((and post
(< pos post
))
5809 (let ((case-fold-search t
)) (looking-at org-element--affiliated-re
))
5811 ((not (member-ignore-case (match-string 1)
5812 org-element-parsed-keywords
))
5813 (throw 'objects-forbidden element
))
5814 ((< (match-end 0) pos
)
5815 (narrow-to-region (match-end 0) (line-end-position)))
5816 ((and (match-beginning 2)
5817 (>= pos
(match-beginning 2))
5818 (< pos
(match-end 2)))
5819 (narrow-to-region (match-beginning 2) (match-end 2)))
5820 (t (throw 'objects-forbidden element
)))
5821 ;; Also change type to retrieve correct restrictions.
5822 (setq type
'keyword
))
5823 ;; At an item, objects can only be located within tag, if any.
5825 (let ((tag (org-element-property :tag element
)))
5826 (if (or (not tag
) (/= (line-beginning-position) post
))
5827 (throw 'objects-forbidden element
)
5829 (search-forward tag
(line-end-position))
5830 (goto-char (match-beginning 0))
5831 (if (and (>= pos
(point)) (< pos
(match-end 0)))
5832 (narrow-to-region (point) (match-end 0))
5833 (throw 'objects-forbidden element
)))))
5834 ;; At an headline or inlinetask, objects are in title.
5835 ((memq type
'(headline inlinetask
))
5836 (goto-char (org-element-property :begin element
))
5837 (looking-at org-complex-heading-regexp
)
5838 (let ((end (match-end 4)))
5839 (if (not end
) (throw 'objects-forbidden element
)
5840 (goto-char (match-beginning 4))
5841 (when (let (case-fold-search) (looking-at org-comment-string
))
5842 (goto-char (match-end 0)))
5843 (if (>= (point) end
) (throw 'objects-forbidden element
)
5844 (narrow-to-region (point) end
)))))
5845 ;; At a paragraph, a table-row or a verse block, objects are
5846 ;; located within their contents.
5847 ((memq type
'(paragraph table-row verse-block
))
5848 (let ((cbeg (org-element-property :contents-begin element
))
5849 (cend (org-element-property :contents-end element
)))
5850 ;; CBEG is nil for table rules.
5851 (if (and cbeg cend
(>= pos cbeg
)
5852 (or (< pos cend
) (and (= pos cend
) (eobp))))
5853 (narrow-to-region cbeg cend
)
5854 (throw 'objects-forbidden element
))))
5855 ;; At a planning line, if point is at a timestamp, return it,
5856 ;; otherwise, return element.
5857 ((eq type
'planning
)
5858 (dolist (p '(:closed
:deadline
:scheduled
))
5859 (let ((timestamp (org-element-property p element
)))
5860 (when (and timestamp
5861 (<= (org-element-property :begin timestamp
) pos
)
5862 (> (org-element-property :end timestamp
) pos
))
5863 (throw 'objects-forbidden timestamp
))))
5864 ;; All other locations cannot contain objects: bail out.
5865 (throw 'objects-forbidden element
))
5866 (t (throw 'objects-forbidden element
)))
5867 (goto-char (point-min))
5868 (let ((restriction (org-element-restriction type
))
5870 (cache (cond ((not (org-element--cache-active-p)) nil
)
5871 (org-element--cache-objects
5872 (gethash element org-element--cache-objects
))
5873 (t (org-element-cache-reset) nil
)))
5874 next object-data last
)
5878 ;; When entering PARENT for the first time, get list
5879 ;; of objects within known so far. Store it in
5882 (let ((data (assq parent cache
)))
5883 (if data
(setq object-data data
)
5884 (push (setq object-data
(list parent nil
)) cache
))))
5885 ;; Find NEXT object for analysis.
5887 ;; If NEXT is non-nil, we already exhausted the
5888 ;; cache so we can parse buffer to find the object
5890 (if next
(setq next
(org-element--object-lex restriction
))
5891 ;; Otherwise, check if cache can help us.
5892 (let ((objects (cddr object-data
))
5893 (completep (nth 1 object-data
)))
5895 ((and (not objects
) completep
) (throw 'exit parent
))
5897 (setq next
(org-element--object-lex restriction
)))
5900 (org-element-property :end
(car objects
))))
5901 (if (>= cache-limit pos
)
5902 ;; Cache contains the information needed.
5903 (dolist (object objects
(throw 'exit parent
))
5904 (when (<= (org-element-property :begin object
)
5906 (if (>= (org-element-property :end object
)
5908 (throw 'found
(setq next object
))
5909 (throw 'exit parent
))))
5910 (goto-char cache-limit
)
5912 (org-element--object-lex restriction
))))))))
5913 ;; If we have a new object to analyze, store it in
5914 ;; cache. Otherwise record that there is nothing
5915 ;; more to parse in this element at this depth.
5917 (progn (org-element-put-property next
:parent parent
)
5918 (push next
(cddr object-data
)))
5919 (setcar (cdr object-data
) t
)))
5920 ;; Process NEXT, if any, in order to know if we need
5921 ;; to skip it, return it or move into it.
5922 (if (or (not next
) (> (org-element-property :begin next
) pos
))
5923 (throw 'exit
(or last parent
))
5924 (let ((end (org-element-property :end next
))
5925 (cbeg (org-element-property :contents-begin next
))
5926 (cend (org-element-property :contents-end next
)))
5928 ;; Skip objects ending before point. Also skip
5929 ;; objects ending at point unless it is also the
5930 ;; end of buffer, since we want to return the
5931 ;; innermost object.
5932 ((and (<= end pos
) (/= (point-max) end
))
5934 ;; For convenience, when object ends at POS,
5935 ;; without any space, store it in LAST, as we
5936 ;; will return it if no object starts here.
5937 (when (and (= end pos
)
5938 (not (memq (char-before) '(?\s ?
\t))))
5940 ;; If POS is within a container object, move
5941 ;; into that object.
5945 ;; At contents' end, if there is no
5946 ;; space before point, also move into
5947 ;; object, for consistency with
5948 ;; convenience feature above.
5950 (or (= (point-max) pos
)
5951 (not (memq (char-before pos
)
5954 (narrow-to-region (point) cend
)
5956 restriction
(org-element-restriction next
)
5959 ;; Otherwise, return NEXT.
5960 (t (throw 'exit next
)))))))
5961 ;; Store results in cache, if applicable.
5962 (org-element--cache-put element cache
)))))))
5964 (defun org-element-lineage (blob &optional types with-self
)
5965 "List all ancestors of a given element or object.
5967 BLOB is an object or element.
5969 When optional argument TYPES is a list of symbols, return the
5970 first element or object in the lineage whose type belongs to that
5973 When optional argument WITH-SELF is non-nil, lineage includes
5974 BLOB itself as the first element, and TYPES, if provided, also
5977 When BLOB is obtained through `org-element-context' or
5978 `org-element-at-point', only ancestors from its section can be
5979 found. There is no such limitation when BLOB belongs to a full
5981 (let ((up (if with-self blob
(org-element-property :parent blob
)))
5983 (while (and up
(not (memq (org-element-type up
) types
)))
5984 (unless types
(push up ancestors
))
5985 (setq up
(org-element-property :parent up
)))
5986 (if types up
(nreverse ancestors
))))
5988 (defun org-element-nested-p (elem-A elem-B
)
5989 "Non-nil when elements ELEM-A and ELEM-B are nested."
5990 (let ((beg-A (org-element-property :begin elem-A
))
5991 (beg-B (org-element-property :begin elem-B
))
5992 (end-A (org-element-property :end elem-A
))
5993 (end-B (org-element-property :end elem-B
)))
5994 (or (and (>= beg-A beg-B
) (<= end-A end-B
))
5995 (and (>= beg-B beg-A
) (<= end-B end-A
)))))
5997 (defun org-element-swap-A-B (elem-A elem-B
)
5998 "Swap elements ELEM-A and ELEM-B.
5999 Assume ELEM-B is after ELEM-A in the buffer. Leave point at the
6001 (goto-char (org-element-property :begin elem-A
))
6002 ;; There are two special cases when an element doesn't start at bol:
6003 ;; the first paragraph in an item or in a footnote definition.
6004 (let ((specialp (not (bolp))))
6005 ;; Only a paragraph without any affiliated keyword can be moved at
6006 ;; ELEM-A position in such a situation. Note that the case of
6007 ;; a footnote definition is impossible: it cannot contain two
6008 ;; paragraphs in a row because it cannot contain a blank line.
6010 (or (not (eq (org-element-type elem-B
) 'paragraph
))
6011 (/= (org-element-property :begin elem-B
)
6012 (org-element-property :contents-begin elem-B
))))
6013 (error "Cannot swap elements"))
6014 ;; In a special situation, ELEM-A will have no indentation. We'll
6015 ;; give it ELEM-B's (which will in, in turn, have no indentation).
6016 (let* ((ind-B (when specialp
6017 (goto-char (org-element-property :begin elem-B
))
6018 (org-get-indentation)))
6019 (beg-A (org-element-property :begin elem-A
))
6020 (end-A (save-excursion
6021 (goto-char (org-element-property :end elem-A
))
6022 (skip-chars-backward " \r\t\n")
6024 (beg-B (org-element-property :begin elem-B
))
6025 (end-B (save-excursion
6026 (goto-char (org-element-property :end elem-B
))
6027 (skip-chars-backward " \r\t\n")
6029 ;; Store inner overlays responsible for visibility status.
6030 ;; We also need to store their boundaries as they will be
6031 ;; removed from buffer.
6036 (and (>= (overlay-start o
) beg-A
)
6037 (<= (overlay-end o
) end-A
)
6038 (list o
(overlay-start o
) (overlay-end o
))))
6039 (overlays-in beg-A end-A
)))
6042 (and (>= (overlay-start o
) beg-B
)
6043 (<= (overlay-end o
) end-B
)
6044 (list o
(overlay-start o
) (overlay-end o
))))
6045 (overlays-in beg-B end-B
)))))
6047 (body-A (buffer-substring beg-A end-A
))
6048 (body-B (delete-and-extract-region beg-B end-B
)))
6051 (setq body-B
(replace-regexp-in-string "\\`[ \t]*" "" body-B
))
6052 (indent-to-column ind-B
))
6054 ;; Restore ex ELEM-A overlays.
6055 (let ((offset (- beg-B beg-A
)))
6056 (dolist (o (car overlays
))
6057 (move-overlay (car o
) (+ (nth 1 o
) offset
) (+ (nth 2 o
) offset
)))
6059 (delete-region beg-A end-A
)
6061 ;; Restore ex ELEM-B overlays.
6062 (dolist (o (cdr overlays
))
6063 (move-overlay (car o
) (- (nth 1 o
) offset
) (- (nth 2 o
) offset
))))
6064 (goto-char (org-element-property :end elem-B
)))))
6067 (provide 'org-element
)
6070 ;; generated-autoload-file: "org-loaddefs.el"
6073 ;;; org-element.el ends here