1 ;;; test-org-element.el --- Tests for org-element.el
3 ;; Copyright (C) 2012-2015 Nicolas Goaziou
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
7 ;; This program is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation, either version 3 of the License, or
10 ;; (at your option) any later version.
12 ;; This program is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;; GNU General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
22 (unless (featurep 'org-element
)
23 (signal 'missing-test-dependency
"org-element"))
25 (defun org-test-parse-and-interpret (text)
26 "Parse TEXT as Org syntax and interpret it.
27 Return interpreted string."
31 (org-element-interpret-data (org-element-parse-buffer))))
35 ;;; Test `org-element-map'
37 (ert-deftest test-org-element
/map
()
38 "Test `org-element-map'."
39 ;; Can map to `plain-text' objects.
42 (org-test-with-temp-text "Some text \alpha
48 (org-element-parse-buffer) 'plain-text
49 (lambda (s) (when (string-match "text" s
) (incf count
))))
51 ;; Applies to secondary strings
53 (org-element-map '("some " (bold nil
"bold") "text") 'bold
'identity
))
54 ;; Enter secondary strings before entering contents.
60 (org-test-with-temp-text "* Some \\alpha headline\n\\beta entity."
61 (org-element-map (org-element-parse-buffer) 'entity
'identity nil t
)))))
62 ;; Apply NO-RECURSION argument.
64 (org-test-with-temp-text "#+BEGIN_CENTER\n\\alpha\n#+END_CENTER"
66 (org-element-parse-buffer) 'entity
'identity nil nil
'center-block
)))
67 ;; Use WITH-AFFILIATED argument.
71 (org-test-with-temp-text "#+CAPTION[a]: 1\n#+CAPTION[b]: 2\nParagraph"
73 (org-element-at-point) 'plain-text
'identity nil nil nil t
)))))
79 (ert-deftest test-org-element
/put-property
()
80 "Test `org-element-put-property' specifications."
82 (org-test-with-temp-text "* Headline\n *a*"
83 (let ((tree (org-element-parse-buffer)))
84 (org-element-put-property
85 (org-element-map tree
'bold
'identity nil t
) :test
1)
86 (should (org-element-property
87 :test
(org-element-map tree
'bold
'identity nil t
)))))
88 ;; Put property on a string.
90 (org-element-property :test
(org-element-put-property "Paragraph" :test t
))))
92 (ert-deftest test-org-element
/set-contents
()
93 "Test `org-element-set-contents' specifications."
94 ;; Accept multiple entries.
96 (equal '("b" (italic nil
"a"))
97 (org-test-with-temp-text "* Headline\n *a*"
98 (let ((tree (org-element-parse-buffer)))
99 (org-element-set-contents
100 (org-element-map tree
'bold
'identity nil t
) "b" '(italic nil
"a"))
101 (org-element-contents
102 (org-element-map tree
'bold
'identity nil t
))))))
103 ;; Accept atoms and elements.
106 (org-test-with-temp-text "* Headline\n *a*"
107 (let ((tree (org-element-parse-buffer)))
108 (org-element-set-contents
109 (org-element-map tree
'bold
'identity nil t
) "b")
110 (org-element-contents
111 (org-element-map tree
'bold
'identity nil t
))))))
113 (equal '((italic nil
"b"))
114 (org-test-with-temp-text "* Headline\n *a*"
115 (let ((tree (org-element-parse-buffer)))
116 (org-element-set-contents
117 (org-element-map tree
'bold
'identity nil t
) '(italic nil
"b"))
118 (org-element-contents
119 (org-element-map tree
'bold
'identity nil t
))))))
120 ;; Allow nil contents.
122 (org-test-with-temp-text "* Headline\n *a*"
123 (let ((tree (org-element-parse-buffer)))
124 (org-element-set-contents (org-element-map tree
'bold
'identity nil t
))
125 (org-element-contents (org-element-map tree
'bold
'identity nil t
))))))
127 (ert-deftest test-org-element
/secondary-p
()
128 "Test `org-element-secondary-p' specifications."
129 ;; In a secondary string, return property name.
132 (org-test-with-temp-text "* Headline *object*"
133 (org-element-map (org-element-parse-buffer) 'bold
134 (lambda (object) (org-element-secondary-p object
))
136 ;; Outside a secondary string, return nil.
138 (org-test-with-temp-text "Paragraph *object*"
139 (org-element-map (org-element-parse-buffer) 'bold
140 (lambda (object) (org-element-type (org-element-secondary-p object
)))
143 (ert-deftest test-org-element
/adopt-elements
()
144 "Test `org-element-adopt-elements' specifications."
147 (equal '(plain-text italic
)
148 (org-test-with-temp-text "* Headline\n *a*"
149 (let ((tree (org-element-parse-buffer)))
150 (org-element-adopt-elements
151 (org-element-map tree
'bold
'identity nil t
) '(italic nil
"a"))
152 (mapcar (lambda (blob) (org-element-type blob
))
153 (org-element-contents
154 (org-element-map tree
'bold
'identity nil t
)))))))
158 (org-test-with-temp-text "* Headline\n *a*"
159 (let ((tree (org-element-parse-buffer)))
160 (org-element-adopt-elements
161 (org-element-map tree
'bold
'identity nil t
) "b")
162 (org-element-contents
163 (org-element-map tree
'bold
'identity nil t
)))))))
165 (ert-deftest test-org-element
/extract-element
()
166 "Test `org-element-extract-element' specifications."
167 ;; Extract a greater element.
169 (equal '(org-data nil
)
170 (org-test-with-temp-text "* Headline"
171 (let* ((tree (org-element-parse-buffer))
172 (element (org-element-map tree
'headline
'identity nil t
)))
173 (org-element-extract-element element
)
175 ;; Extract an element.
178 (org-test-with-temp-text "Paragraph"
179 (let* ((tree (org-element-parse-buffer))
180 (element (org-element-map tree
'paragraph
'identity nil t
)))
181 (org-element-extract-element element
)
185 ;; Extract an object, even in a secondary string.
188 (org-test-with-temp-text "*bold*"
189 (let* ((tree (org-element-parse-buffer))
190 (element (org-element-map tree
'bold
'identity nil t
)))
191 (org-element-extract-element element
)
197 (org-test-with-temp-text "* Headline *bold*"
198 (let* ((tree (org-element-parse-buffer))
199 (element (org-element-map tree
'bold
'identity nil t
)))
200 (org-element-extract-element element
)
204 ;; Return value doesn't have any :parent set.
206 (org-element-property
208 (org-test-with-temp-text "* Headline\n Paragraph with *bold* text."
209 (let* ((tree (org-element-parse-buffer))
210 (element (org-element-map tree
'bold
'identity nil t
)))
211 (org-element-extract-element element
))))))
213 (ert-deftest test-org-element
/insert-before
()
214 "Test `org-element-insert-before' specifications."
218 '(italic entity bold
)
219 (org-test-with-temp-text "/some/ *paragraph*"
220 (let* ((tree (org-element-parse-buffer))
221 (paragraph (org-element-map tree
'paragraph
'identity nil t
))
222 (bold (org-element-map tree
'bold
'identity nil t
)))
223 (org-element-insert-before '(entity (:name
"\\alpha")) bold
)
224 (org-element-map tree
'(bold entity italic
) #'org-element-type nil
)))))
225 ;; Insert an object in a secondary string.
229 (org-test-with-temp-text "* /A/\n Paragraph."
230 (let* ((tree (org-element-parse-buffer))
231 (headline (org-element-map tree
'headline
'identity nil t
))
232 (italic (org-element-map tree
'italic
'identity nil t
)))
233 (org-element-insert-before '(entity (:name
"\\alpha")) italic
)
234 (org-element-map (org-element-property :title headline
) '(entity italic
)
235 #'org-element-type
))))))
237 (ert-deftest test-org-element
/set-element
()
238 "Test `org-element-set-element' specifications."
239 ;; Check if new element is inserted.
241 (org-test-with-temp-text "* Headline\n*a*"
242 (let* ((tree (org-element-parse-buffer))
243 (bold (org-element-map tree
'bold
'identity nil t
)))
244 (org-element-set-element bold
'(italic nil
"b"))
245 (org-element-map tree
'italic
'identity
))))
246 ;; Check if old element is removed.
248 (org-test-with-temp-text "* Headline\n*a*"
249 (let* ((tree (org-element-parse-buffer))
250 (bold (org-element-map tree
'bold
'identity nil t
)))
251 (org-element-set-element bold
'(italic nil
"b"))
252 (org-element-map tree
'bold
'identity
))))
253 ;; Check if :parent property is correctly set.
256 (org-test-with-temp-text "* Headline\n*a*"
257 (let* ((tree (org-element-parse-buffer))
258 (bold (org-element-map tree
'bold
'identity nil t
)))
259 (org-element-set-element bold
'(italic nil
"b"))
261 (org-element-property
262 :parent
(org-element-map tree
'italic
'identity nil t
)))))))
263 ;; Allow to replace strings with elements.
266 (org-test-with-temp-text "* Headline"
267 (let* ((tree (org-element-parse-buffer))
268 (text (org-element-map tree
'plain-text
'identity nil t
)))
269 (org-element-set-element text
(list 'bold nil
"b"))
270 (org-element-map tree
'plain-text
'identity
)))))
271 ;; Allow to replace elements with strings.
274 (org-test-with-temp-text "* =verbatim="
275 (let* ((tree (org-element-parse-buffer))
276 (verb (org-element-map tree
'verbatim
'identity nil t
)))
277 (org-element-set-element verb
"a")
278 (org-element-map tree
'plain-text
'identity nil t
)))))
279 ;; Allow to replace strings with strings.
282 (org-test-with-temp-text "a"
283 (let* ((tree (org-element-parse-buffer))
284 (text (org-element-map tree
'plain-text
'identity nil t
)))
285 (org-element-set-element text
"b")
286 (org-element-map tree
'plain-text
'identity nil t
))))))
288 (ert-deftest test-org-element
/copy
()
289 "Test `org-element-copy' specifications."
292 (org-test-with-temp-text "*bold*"
293 (org-element-type (org-element-copy (org-element-context))))))
294 (should (eq 'plain-text
295 (org-test-with-temp-text "*bold*"
297 (org-element-map (org-element-parse-buffer) 'plain-text
298 #'org-element-copy nil t
)))))
299 ;; Preserve properties except `:parent'.
301 (org-test-with-temp-text "*bold*"
302 (org-element-property
303 :end
(org-element-copy (org-element-context))))))
305 (org-test-with-temp-text "*bold*"
306 (org-element-property
307 :parent
(org-element-copy (org-element-context)))))
309 (org-test-with-temp-text "*bold*"
310 (org-element-property
312 (org-element-map (org-element-parse-buffer) 'plain-text
313 #'org-element-copy nil t
))))
314 ;; Copying nil returns nil.
315 (should-not (org-element-copy nil
))
316 ;; Return a copy secondary strings.
317 (should (equal '("text") (org-element-copy '("text"))))
318 (should-not (eq '("text") (org-element-copy '("text")))))
324 ;;;; Affiliated Keywords
326 (ert-deftest test-org-element
/affiliated-keywords-parser
()
327 "Test affiliated keywords parsing."
328 ;; Read simple keywords.
331 (org-element-property
333 (org-test-with-temp-text "#+NAME: para\nParagraph"
334 (org-element-at-point)))))
337 (org-element-property
339 (org-test-with-temp-text "#+NAME: para\nParagraph"
340 (org-element-at-point)))))
341 ;; Parse multiple keywords.
345 (org-element-property
347 (org-test-with-temp-text
348 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph"
349 (org-element-at-point)))))
350 ;; Parse "parsed" keywords.
354 (org-test-with-temp-text "#+CAPTION: caption\nParagraph"
355 (car (org-element-property :caption
(org-element-at-point))))))
356 ;; Parse dual keywords.
359 '((("long") "short"))
360 (org-test-with-temp-text "#+CAPTION[short]: long\nParagraph"
361 (org-element-property :caption
(org-element-at-point)))))
362 ;; Allow multiple caption keywords.
365 '((("l2") "s2") (("l1") "s1"))
366 (org-test-with-temp-text "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph"
367 (org-element-property :caption
(org-element-at-point)))))
370 '((("l1")) (nil "s1"))
371 (org-test-with-temp-text "#+CAPTION[s1]:\n#+CAPTION: l1\nParagraph"
372 (org-element-property :caption
(org-element-at-point)))))
373 ;; Corner case: orphaned keyword at the end of an element.
376 (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
377 (progn (search-forward "name")
378 (org-element-type (org-element-at-point))))))
380 (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
381 (progn (search-forward "Some")
382 (org-element-property :name
(org-element-at-point))))))
387 (ert-deftest test-org-element
/babel-call-parser
()
388 "Test `babel-call' parsing."
391 (org-test-with-temp-text "#+CALL: test()"
392 (org-element-map (org-element-parse-buffer) 'babel-call
'identity
)))
395 (org-test-with-temp-text "#+call: test()"
396 (org-element-map (org-element-parse-buffer) 'babel-call
'identity
)))
397 ;; Handle non-empty blank line at the end of buffer.
399 (org-test-with-temp-text "#+CALL: test()\n "
400 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
405 (ert-deftest test-org-element
/bold-parser
()
406 "Test `bold' parser."
409 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
410 (org-test-with-temp-text "*bold*"
411 (org-element-map (org-element-parse-buffer) 'bold
'identity nil t
))))
412 ;; Multi-line markup.
415 (org-element-contents
416 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
417 (org-test-with-temp-text "*first line\nsecond line*"
418 (org-element-map (org-element-parse-buffer) 'bold
'identity nil t
))))
419 '("first line\nsecond line"))))
424 (ert-deftest test-org-element
/center-block-parser
()
425 "Test `center-block' parser."
428 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
429 (org-element-map (org-element-parse-buffer) 'center-block
'identity
)))
432 (org-test-with-temp-text "#+begin_center\nText\n#+end_center"
433 (org-element-map (org-element-parse-buffer) 'center-block
'identity
)))
434 ;; Ignore incomplete block.
436 (org-test-with-temp-text "#+BEGIN_CENTER"
437 (org-element-map (org-element-parse-buffer) 'center-block
439 ;; Handle non-empty blank line at the end of buffer.
441 (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
442 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
447 (ert-deftest test-org-element
/clock-parser
()
448 "Test `clock' parser."
450 (let ((clock (org-test-with-temp-text "CLOCK: [2012-01-01 sun. 00:01]"
451 (org-element-at-point))))
452 (should (eq (org-element-property :status clock
) 'running
))
454 (equal (org-element-property :raw-value
455 (org-element-property :value clock
))
456 "[2012-01-01 sun. 00:01]"))
457 (should-not (org-element-property :duration clock
)))
460 (org-test-with-temp-text
461 "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"
462 (org-element-at-point))))
463 (should (eq (org-element-property :status clock
) 'closed
))
464 (should (equal (org-element-property :raw-value
465 (org-element-property :value clock
))
466 "[2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02]"))
467 (should (equal (org-element-property :duration clock
) "0:01"))))
472 (ert-deftest test-org-element
/code-parser
()
473 "Test `code' parser."
476 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
477 (org-test-with-temp-text "~code~"
478 (org-element-map (org-element-parse-buffer) 'code
'identity
))))
479 ;; Multi-line markup.
482 (org-element-property
484 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
485 (org-test-with-temp-text "~first line\nsecond line~"
487 (org-element-parse-buffer) 'code
'identity nil t
))))
488 "first line\nsecond line")))
493 (ert-deftest test-org-element
/comment-parser
()
494 "Test `comment' parser."
497 (org-test-with-temp-text "# Comment"
498 (org-element-map (org-element-parse-buffer) 'comment
'identity
)))
501 (org-test-with-temp-text " # Comment"
502 (org-element-map (org-element-parse-buffer) 'comment
'identity
)))
503 ;; Preserve indentation.
506 (org-element-property
508 (org-test-with-temp-text "# No blank\n# One blank"
509 (org-element-map (org-element-parse-buffer) 'comment
'identity nil t
)))
510 "No blank\n One blank"))
511 ;; Comment with blank lines.
514 (org-element-property
516 (org-test-with-temp-text "# First part\n# \n#\n# Second part"
517 (org-element-map (org-element-parse-buffer) 'comment
'identity nil t
)))
518 "First part\n\n\nSecond part"))
519 ;; Do not mix comments and keywords.
522 (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
523 (length (org-element-map (org-element-parse-buffer) 'comment
527 (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
528 (org-element-property
530 (org-element-map (org-element-parse-buffer) 'comment
532 ;; Correctly handle non-empty blank lines at the end of buffer.
534 (org-test-with-temp-text "# A\n "
535 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
540 (ert-deftest test-org-element
/comment-block-parser
()
541 "Test `comment-block' parser."
544 (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
545 (org-element-map (org-element-parse-buffer) 'comment-block
'identity
)))
548 (org-test-with-temp-text "#+begin_comment\nText\n#+end_comment"
549 (org-element-map (org-element-parse-buffer) 'comment-block
'identity
)))
550 ;; Ignore incomplete block.
552 (org-test-with-temp-text "#+BEGIN_COMMENT"
553 (org-element-map (org-element-parse-buffer) 'comment-block
555 ;; Handle non-empty blank line at the end of buffer.
557 (org-test-with-temp-text "#+BEGIN_COMMENT\nC\n#+END_COMMENT\n "
558 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
563 (ert-deftest test-org-element
/diary-sexp-parser
()
564 "Test `diary-sexp' parser."
568 (org-test-with-temp-text
569 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old"
570 (org-element-type (org-element-at-point)))))
571 ;; Diary sexp must live at beginning of line
574 (org-test-with-temp-text " %%(org-bbdb-anniversaries)"
575 (org-element-type (org-element-at-point)))))
576 ;; Handle non-empty blank line at the end of buffer.
578 (org-test-with-temp-text "%%(org-bbdb-anniversaries)\n "
579 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
584 (ert-deftest test-org-element
/drawer-parser
()
585 "Test `drawer' parser."
588 (org-test-with-temp-text ":TEST:\nText\n:END:"
589 (org-element-map (org-element-parse-buffer) 'drawer
'identity
)))
590 ;; Ignore incomplete drawer.
592 (org-test-with-temp-text ":TEST:"
593 (org-element-map (org-element-parse-buffer) 'drawer
'identity nil t
)))
594 ;; Handle non-empty blank line at the end of buffer.
596 (org-test-with-temp-text ":TEST:\nC\n:END:\n "
597 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
602 (ert-deftest test-org-element
/dynamic-block-parser
()
603 "Test `dynamic-block' parser."
606 (org-test-with-temp-text
607 "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
608 (org-element-map (org-element-parse-buffer) 'dynamic-block
'identity
)))
611 (org-test-with-temp-text
612 "#+begin: myblock :param1 val1 :param2 val2\nText\n#+end:"
613 (org-element-map (org-element-parse-buffer) 'dynamic-block
'identity
)))
614 ;; Ignore incomplete block.
616 (org-test-with-temp-text "#+BEGIN: myblock :param1 val1 :param2 val2"
617 (org-element-map (org-element-parse-buffer) 'dynamic-block
619 ;; Handle non-empty blank line at the end of buffer.
621 (org-test-with-temp-text "#+BEGIN: myblock :param val1\nC\n#+END:\n "
622 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
627 (ert-deftest test-org-element
/entity-parser
()
628 "Test `entity' parser."
631 (org-test-with-temp-text "\\sin"
632 (org-element-map (org-element-parse-buffer) 'entity
'identity
)))
635 (org-element-property
637 (org-test-with-temp-text "\\alpha{}text"
638 (org-element-map (org-element-parse-buffer) 'entity
'identity nil t
))))
639 ;; User-defined entity.
642 (org-element-property
644 (let ((org-entities-user
645 '(("test" "test" nil
"test" "test" "test" "test"))))
646 (org-test-with-temp-text "\\test"
647 (org-element-map (org-element-parse-buffer) 'entity
'identity nil t
))))
649 ;; Special case: entity at the end of a container.
652 (org-test-with-temp-text "*\\alpha \\beta*"
653 (search-forward "be")
654 (org-element-type (org-element-context))))))
659 (ert-deftest test-org-element
/example-block-parser
()
660 "Test `example-block' parser."
663 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
664 (org-element-map (org-element-parse-buffer) 'example-block
'identity
)))
665 ;; Ignore incomplete block.
668 (org-test-with-temp-text "#+BEGIN_EXAMPLE"
669 (org-element-type (org-element-at-point)))))
670 ;; Properly un-escape code.
672 (equal "* Headline\n #+keyword\nText\n"
673 (org-test-with-temp-text
674 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText\n#+END_EXAMPLE"
675 (org-element-property :value
(org-element-at-point)))))
676 ;; Remove block indentation according to block boundaries, unless
677 ;; block contents are less indented than block boundaries.
680 (org-test-with-temp-text " #+BEGIN_EXAMPLE\n L1\n L2\n #+END_EXAMPLE"
681 (let ((org-src-preserve-indentation t
))
682 (org-element-property :value
(org-element-at-point))))))
686 (org-test-with-temp-text " #+BEGIN_EXAMPLE\n L1\n L2\n #+END_EXAMPLE"
687 (let ((org-src-preserve-indentation t
))
688 (org-element-property :value
(org-element-at-point))))))
689 ;; Handle non-empty blank line at the end of buffer.
691 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nC\n#+END_EXAMPLE\n "
692 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
694 (ert-deftest test-org-element
/block-switches
()
695 "Test `example-block' and `src-block' switches parsing."
696 (let ((org-coderef-label-format "(ref:%s)"))
697 ;; 1. Test "-i" switch.
699 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
700 (org-element-property :preserve-indent
(org-element-at-point))))
702 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"
703 (org-element-property :preserve-indent
(org-element-at-point))))
705 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
706 (org-element-property :preserve-indent
(org-element-at-point))))
708 (org-test-with-temp-text "#+BEGIN_EXAMPLE -i\nText.\n#+END_EXAMPLE"
709 (org-element-property :preserve-indent
(org-element-at-point))))
710 ;; 2. "-n -r -k" combination should number lines, retain labels but
711 ;; not use them in coderefs.
712 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r -k\nText.\n#+END_EXAMPLE"
713 (let ((element (org-element-at-point)))
714 (should (org-element-property :number-lines element
))
715 (should (org-element-property :retain-labels element
))
716 (should-not (org-element-property :use-labels element
))))
717 (org-test-with-temp-text
718 "#+BEGIN_SRC emacs-lisp -n -r -k\n(+ 1 1)\n#+END_SRC"
719 (let ((element (org-element-at-point)))
720 (should (org-element-property :number-lines element
))
721 (should (org-element-property :retain-labels element
))
722 (should-not (org-element-property :use-labels element
))))
723 ;; 3. "-n -r" combination should number-lines remove labels and not
724 ;; use them in coderefs.
725 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r\nText.\n#+END_EXAMPLE"
726 (let ((element (org-element-at-point)))
727 (should (org-element-property :number-lines element
))
728 (should-not (org-element-property :retain-labels element
))
729 (should-not (org-element-property :use-labels element
))))
730 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1)\n#+END_SRC"
731 (let ((element (org-element-at-point)))
732 (should (org-element-property :number-lines element
))
733 (should-not (org-element-property :retain-labels element
))
734 (should-not (org-element-property :use-labels element
))))
735 ;; 4. "-n" or "+n" should number lines, retain labels and use them
738 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n\nText.\n#+END_EXAMPLE"
739 (let ((element (org-element-at-point)))
740 (and (org-element-property :number-lines element
)
741 (org-element-property :retain-labels element
)
742 (org-element-property :use-labels element
)))))
744 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1)\n#+END_SRC"
745 (let ((element (org-element-at-point)))
746 (and (org-element-property :number-lines element
)
747 (org-element-property :retain-labels element
)
748 (org-element-property :use-labels element
)))))
750 (org-test-with-temp-text "#+BEGIN_EXAMPLE +n\nText.\n#+END_EXAMPLE"
751 (let ((element (org-element-at-point)))
752 (and (org-element-property :number-lines element
)
753 (org-element-property :retain-labels element
)
754 (org-element-property :use-labels element
)))))
756 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp +n\n(+ 1 1)\n#+END_SRC"
757 (let ((element (org-element-at-point)))
758 (and (org-element-property :number-lines element
)
759 (org-element-property :retain-labels element
)
760 (org-element-property :use-labels element
)))))
761 ;; 5. No switch should not number lines, but retain labels and use
763 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
764 (let ((element (org-element-at-point)))
765 (should (not (org-element-property :number-lines element
)))
766 (should (org-element-property :retain-labels element
))
767 (should (org-element-property :use-labels element
))))
768 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
769 (let ((element (org-element-at-point)))
770 (should (not (org-element-property :number-lines element
)))
771 (should (org-element-property :retain-labels element
))
772 (should (org-element-property :use-labels element
))))
773 ;; 6. "-r" switch only: do not number lines, remove labels, and
774 ;; don't use labels in coderefs.
775 (org-test-with-temp-text "#+BEGIN_EXAMPLE -r\nText.\n#+END_EXAMPLE"
776 (let ((element (org-element-at-point)))
777 (should (not (org-element-property :number-lines element
)))
778 (should (not (org-element-property :retain-labels element
)))
779 (should (not (org-element-property :use-labels element
)))))
780 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1)\n#+END_SRC"
781 (let ((element (org-element-at-point)))
782 (should (not (org-element-property :number-lines element
)))
783 (should (not (org-element-property :retain-labels element
)))
784 (should (not (org-element-property :use-labels element
)))))
785 ;; 7. Recognize coderefs with user-defined syntax.
789 (org-test-with-temp-text
790 "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText [ref:text]\n#+END_EXAMPLE"
791 (org-element-property :label-fmt
(org-element-at-point)))))
795 (org-test-with-temp-text
796 "#+BEGIN_SRC emacs-lisp -l \"[ref:%s]\"\n(+ 1 1) [ref:text]\n#+END_SRC"
797 (org-element-property :label-fmt
(org-element-at-point)))))))
802 (ert-deftest test-org-element
/export-block-parser
()
803 "Test `export-block' parser."
806 (org-test-with-temp-text "#+BEGIN_LATEX\nText\n#+END_LATEX"
808 (let ((org-element-block-name-alist
809 '(("LATEX" . org-element-export-block-parser
))))
810 (org-element-parse-buffer))
811 'export-block
'identity
)))
814 (let ((org-element-block-name-alist
815 '(("LATEX" . org-element-export-block-parser
))))
816 (org-test-with-temp-text "#+begin_latex\nText\n#+end_latex"
817 (org-element-map (org-element-parse-buffer) 'export-block
'identity
))))
818 ;; Ignore incomplete block.
820 (let ((org-element-block-name-alist
821 '(("LATEX" . org-element-export-block-parser
))))
822 (org-test-with-temp-text "#+BEGIN_LATEX"
823 (org-element-map (org-element-parse-buffer) 'export-block
825 ;; Handle non-empty blank line at the end of buffer.
827 (let ((org-element-block-name-alist
828 '(("LATEX" . org-element-export-block-parser
))))
829 (org-test-with-temp-text "#+BEGIN_LATEX\nC\n#+END_LATEX\n "
830 (= (org-element-property :end
(org-element-at-point)) (point-max))))))
835 (ert-deftest test-org-element
/export-snippet-parser
()
836 "Test `export-snippet' parser."
839 '("back-end" .
"contents")
840 (org-test-with-temp-text "@@back-end:contents@@"
842 (org-element-parse-buffer) 'export-snippet
843 (lambda (snippet) (cons (org-element-property :back-end snippet
)
844 (org-element-property :value snippet
)))
850 (ert-deftest test-org-element
/fixed-width-parser
()
851 "Test fixed-width area parsing."
852 ;; Preserve indentation.
854 (org-test-with-temp-text ": no blank\n: one blank"
855 (org-element-map (org-element-parse-buffer) 'fixed-width
'identity
)))
856 ;; Fixed-width with empty lines.
858 (org-test-with-temp-text ": first part\n:\n: \n: second part"
859 (org-element-map (org-element-parse-buffer) 'fixed-width
'identity
)))
860 ;; Parse indented fixed-width markers.
862 (org-test-with-temp-text "Text\n : no blank\n : one blank"
863 (org-element-map (org-element-parse-buffer) 'fixed-width
'identity
)))
864 ;; Distinguish fixed-width areas within a list and outside of it.
868 (org-test-with-temp-text "
871 : fixed-width outside"
872 (org-element-map (org-element-parse-buffer) 'fixed-width
'identity
)))))
873 ;; Handle non-empty blank line at the end of buffer.
875 (org-test-with-temp-text ": A\n "
876 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
879 ;;;; Footnote Definition
881 (ert-deftest test-org-element
/footnote-definition-parser
()
882 "Test `footnote-definition' parser."
884 (org-test-with-temp-text "[fn:1] Definition"
885 (org-element-map (org-element-parse-buffer) 'footnote-definition
887 ;; Footnote with more contents
890 (org-element-property
892 (org-test-with-temp-text "[fn:1] Definition\n\n| a | b |"
893 (org-element-map (org-element-parse-buffer) 'footnote-definition
895 ;; Footnote starting with special syntax.
897 (org-test-with-temp-text "[fn:1] - no item"
898 (org-element-map (org-element-parse-buffer) 'item
'identity
)))
899 ;; Correctly handle footnote starting with an empty line.
902 (org-test-with-temp-text "[fn:1]\n\n Body"
903 (org-element-property :contents-begin
(org-element-at-point)))))
904 ;; Handle non-empty blank line at the end of buffer.
906 (org-test-with-temp-text "[fn:1] Definition\n "
907 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
910 ;;;; Footnotes Reference.
912 (ert-deftest test-org-element
/footnote-reference-parser
()
913 "Test `footnote-reference' parser."
914 ;; Parse a standard reference.
916 (org-test-with-temp-text "Text[fn:label]"
918 (org-element-parse-buffer) 'footnote-reference
'identity
)))
919 ;; Parse a normalized reference.
921 (org-test-with-temp-text "Text[1]"
923 (org-element-parse-buffer) 'footnote-reference
'identity
)))
924 ;; Parse an inline reference.
926 (org-test-with-temp-text "Text[fn:test:def]"
928 (org-element-parse-buffer) 'footnote-reference
'identity
)))
929 ;; Parse an anonymous reference.
931 (org-test-with-temp-text "Text[fn::def]"
933 (org-element-parse-buffer) 'footnote-reference
'identity
)))
934 ;; Parse nested footnotes.
938 (org-test-with-temp-text "Text[fn::def [fn:label]]"
940 (org-element-parse-buffer) 'footnote-reference
'identity
)))))
941 ;; Parse adjacent footnotes.
943 (org-test-with-temp-text "Text[fn:label1][fn:label2]"
947 (org-element-parse-buffer) 'footnote-reference
'identity
)))))
948 ;; Only properly closed footnotes are recognized as such.
950 (org-test-with-temp-text "Text[fn:label"
952 (org-element-parse-buffer) 'footnote-reference
'identity
))))
957 (ert-deftest test-org-element
/headline-comment-keyword
()
958 "Test COMMENT keyword recognition."
960 (org-test-with-temp-text "* Headline"
961 (let ((org-comment-string "COMMENT"))
962 (should-not (org-element-property :commentedp
(org-element-at-point)))))
963 ;; Standard position.
964 (org-test-with-temp-text "* COMMENT Headline"
965 (let ((org-comment-string "COMMENT")
966 (headline (org-element-at-point)))
967 (should (org-element-property :commentedp headline
))
968 (should (equal (org-element-property :raw-value headline
) "Headline"))))
970 (org-test-with-temp-text "* COMMENT Headline"
971 (let* ((org-comment-string "Comment")
972 (headline (org-element-at-point)))
973 (should-not (org-element-property :commentedp headline
))
974 (should (equal (org-element-property :raw-value headline
)
975 "COMMENT Headline"))))
976 ;; With another keyword.
977 (org-test-with-temp-text "* TODO COMMENT Headline"
978 (let* ((org-comment-string "COMMENT")
979 (org-todo-keywords '((sequence "TODO" "DONE")))
980 (headline (org-element-at-point)))
981 (should (org-element-property :commentedp headline
))
982 (should (equal (org-element-property :raw-value headline
) "Headline"))))
983 ;; With the keyword only.
984 (org-test-with-temp-text "* COMMENT"
985 (let* ((org-comment-string "COMMENT")
986 (headline (org-element-at-point)))
987 (should (org-element-property :commentedp headline
))
988 (should (equal (org-element-property :raw-value headline
) "")))))
990 (ert-deftest test-org-element
/headline-archive-tag
()
991 "Test ARCHIVE tag recognition."
994 (org-test-with-temp-text "* Headline"
995 (let ((org-archive-tag "ARCHIVE"))
996 (org-element-property :archivedp
(org-element-at-point)))))
998 (org-test-with-temp-text "* Headline :ARCHIVE:"
999 (let ((org-archive-tag "ARCHIVE"))
1000 (let ((headline (org-element-at-point)))
1001 (should (org-element-property :archivedp headline
))
1002 ;; Test tag removal.
1003 (should-not (org-element-property :tags headline
)))))
1005 (org-test-with-temp-text "* Headline :test:ARCHIVE:"
1006 (let ((org-archive-tag "ARCHIVE"))
1007 (let ((headline (org-element-at-point)))
1008 (should (org-element-property :archivedp headline
))
1009 ;; Test tag removal.
1010 (should (equal (org-element-property :tags headline
) '("test"))))))
1011 ;; Tag is case-sensitive.
1013 (org-test-with-temp-text "* Headline :ARCHIVE:"
1014 (let ((org-archive-tag "Archive"))
1015 (org-element-property :archivedp
(org-element-at-point))))))
1017 (ert-deftest test-org-element
/headline-properties
()
1018 "Test properties from property drawer."
1019 ;; All properties from property drawer have their symbol upper
1022 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
1023 (org-element-property :FOO
(org-element-at-point))))
1025 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
1026 (org-element-property :foo
(org-element-at-point))))
1027 ;; Also parse properties associated in inlinetasks.
1028 (when (featurep 'org-inlinetask
)
1030 (org-test-with-temp-text "*************** Inlinetask
1034 *************** END"
1035 (org-element-property :FOO
(org-element-at-point)))))
1036 ;; Do not find property drawer in a verbatim area.
1038 (org-test-with-temp-text
1045 (org-element-property :FOO
(org-element-at-point))))
1046 ;; Do not use properties from a drawer associated to an inlinetask.
1047 (when (featurep 'org-inlinetask
)
1049 (org-test-with-temp-text
1051 *************** Inlinetask
1055 *************** END"
1056 (org-element-property
1057 :FOO
(let ((org-inlinetask-min-level 15)) (org-element-at-point))))))
1058 ;; Do not find incomplete drawers.
1060 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar"
1061 (org-element-property :FOO
(org-element-at-point)))))
1064 ;;;; Horizontal Rule
1066 (ert-deftest test-org-element
/horizontal-rule-parser
()
1067 "Test `horizontal-rule' parser."
1070 (org-test-with-temp-text "-----"
1071 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
1074 (org-test-with-temp-text " -----"
1075 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
1076 ;; Hyphen must be alone on the line.
1078 (org-test-with-temp-text "-----wrong"
1079 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
1080 ;; 4 hyphens is too small.
1082 (org-test-with-temp-text "----"
1083 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
1084 ;; Handle non-empty blank line at the end of buffer.
1086 (org-test-with-temp-text "-----\n "
1087 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1090 ;;;; Inline Babel Call
1092 (ert-deftest test-org-element
/inline-babel-call-parser
()
1093 "Test `inline-babel-call' parser."
1095 (org-test-with-temp-text "call_test()"
1097 (org-element-parse-buffer) 'inline-babel-call
'identity
))))
1100 ;;;; Inline Src Block
1102 (ert-deftest test-org-element
/inline-src-block-parser
()
1103 "Test `inline-src-block' parser."
1105 (org-test-with-temp-text "src_emacs-lisp{(+ 1 1)}"
1106 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1109 (org-test-with-temp-text "src_emacs-lisp[:foo bar]{(+ 1 1)}"
1110 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1112 (org-test-with-temp-text "src_emacs-lisp[ :foo bar]{(+ 1 1)}"
1113 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1116 (org-test-with-temp-text "src_emacs-lisp[]{(+ 1 1)}"
1117 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1120 (org-test-with-temp-text "foosrc_emacs-lisp[]{(+ 1 1)}"
1121 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1123 (org-test-with-temp-text "src_emacs-lisp[]foo{(+ 1 1)}"
1124 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1125 ;; Invalid language name
1127 (org-test-with-temp-text "src_emacs-\tlisp{(+ 1 1)}"
1128 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1129 ;; Test parsing at the beginning of an item.
1131 (org-test-with-temp-text "- src_emacs-lisp{(+ 1 1)}"
1132 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
))))
1137 (ert-deftest test-org-element
/inlinetask-parser
()
1138 "Test `inlinetask' parser."
1139 (when (featurep 'org-inlinetask
)
1140 (let ((org-inlinetask-min-level 15))
1141 ;; Regular inlinetask.
1144 (org-test-with-temp-text
1145 "*************** Task\nTest\n*************** END"
1146 (org-element-type (org-element-at-point)))))
1147 ;; Degenerate inlinetask.
1150 (org-test-with-temp-text "*************** Task"
1151 (org-element-type (org-element-at-point)))))
1152 ;; Mixed inlinetasks.
1154 (org-test-with-temp-text
1156 *************** Task
1157 *************** Task2
1159 *************** END"
1161 (goto-char (org-element-property :end
(org-element-at-point)))
1167 (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
1168 (org-test-with-temp-text "*************** TODO Task"
1169 (org-element-property :todo-keyword
(org-element-at-point))))))
1172 (org-test-with-temp-text "
1173 *************** Task
1174 DEADLINE: <2012-03-29 thu.>
1175 *************** END"
1177 (org-element-property :deadline
(org-element-at-point))))
1179 (org-test-with-temp-text "
1180 *************** Task
1181 DEADLINE: <2012-03-29 thu.>"
1183 (org-element-property :deadline
(org-element-at-point))))
1188 (org-test-with-temp-text "
1189 *************** [#A] Task"
1191 (org-element-property :priority
(org-element-at-point)))))
1196 (org-test-with-temp-text "
1197 *************** Task :test:"
1199 (org-element-property :tags
(org-element-at-point)))))
1200 ;; Regular properties are accessed through upper case keywords.
1202 (org-test-with-temp-text "
1203 *************** Task
1207 *************** END"
1209 (org-element-property :FOO
(org-element-at-point))))
1211 (org-test-with-temp-text "
1212 *************** Task
1216 *************** END"
1218 (org-element-property :foo
(org-element-at-point))))
1219 ;; Handle non-empty blank line at the end of buffer.
1221 (org-test-with-temp-text "*************** Task\n*************** END\n "
1222 (= (org-element-property :end
(org-element-at-point)) (point-max)))))))
1227 (ert-deftest test-org-element
/italic-parser
()
1228 "Test `italic' parser."
1231 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1232 (org-test-with-temp-text "/italic/"
1233 (org-element-map (org-element-parse-buffer) 'italic
'identity nil t
))))
1234 ;; Multi-line markup.
1237 (org-element-contents
1238 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1239 (org-test-with-temp-text "/first line\nsecond line/"
1240 (org-element-map (org-element-parse-buffer) 'italic
'identity nil t
))))
1241 '("first line\nsecond line"))))
1246 (ert-deftest test-org-element
/item-parser
()
1247 "Test `item' parser."
1250 (org-test-with-temp-text "- item"
1251 (org-element-map (org-element-parse-buffer) 'item
'identity
)))
1255 (org-element-property
1257 (org-test-with-temp-text "6. [@6] item"
1258 (org-element-map (org-element-parse-buffer) 'item
'identity nil t
)))))
1263 (org-element-property
1265 (org-test-with-temp-text "- tag :: description"
1266 (org-element-map (org-element-parse-buffer) 'item
'identity nil t
)))))
1267 ;; No tags in ordered lists.
1269 (org-element-property
1271 (org-test-with-temp-text "1. tag :: description"
1272 (org-element-map (org-element-parse-buffer) 'item
'identity nil t
))))
1277 (org-test-with-temp-text "
1282 (org-element-parse-buffer) 'item
1283 (lambda (item) (org-element-property :checkbox item
))))))
1284 ;; Item starting with special syntax.
1286 (equal '(("- item"))
1287 (org-test-with-temp-text "- - item"
1288 (org-element-map (org-element-parse-buffer) 'paragraph
1289 'org-element-contents
))))
1290 ;; Block in an item: ignore indentation within the block.
1292 (org-test-with-temp-text "- item\n #+begin_src emacs-lisp\n(+ 1 1)\n #+end_src"
1294 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1299 (ert-deftest test-org-element
/keyword-parser
()
1300 "Test `keyword' parser."
1303 (org-test-with-temp-text "#+KEYWORD: value"
1304 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1305 ;; Keywords are case-insensitive.
1307 (org-test-with-temp-text "#+keyword: value"
1308 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1309 ;; Affiliated keywords are not keywords.
1311 (org-test-with-temp-text "#+NAME: value
1313 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1314 ;; Do not mix keywords with Babel calls and dynamic blocks.
1316 (org-test-with-temp-text "#+CALL: fun()"
1317 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1319 (org-test-with-temp-text "#+BEGIN: my-fun\nBody\n#+END:"
1320 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1321 ;; Handle non-empty blank line at the end of buffer.
1323 (org-test-with-temp-text "#+KEYWORD: value\n "
1324 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1327 ;;;; Latex Environment
1329 (ert-deftest test-org-element
/latex-environment-parser
()
1330 "Test `latex-environment' parser."
1332 (org-test-with-temp-text "\\begin{equation}\ne^{i\\pi}+1=0\n\\end{equation}"
1333 (org-element-map (org-element-parse-buffer) 'latex-environment
'identity
)))
1334 ;; Allow nested environments.
1342 (org-test-with-temp-text "
1348 (org-element-property
1351 (org-element-parse-buffer) 'latex-environment
'identity nil t
)))))
1352 ;; Allow environments with options and arguments.
1354 (eq 'latex-environment
1355 (org-test-with-temp-text
1356 "\\begin{theorem}[Euler]\ne^{i\\pi}+1=0\n\\end{theorem}"
1357 (org-element-type (org-element-at-point)))))
1359 (eq 'latex-environment
1360 (org-test-with-temp-text "\\begin{env}{arg}\nvalue\n\\end{env}"
1361 (org-element-type (org-element-at-point)))))
1362 ;; Allow environments without newline after \begin{.}.
1364 (eq 'latex-environment
1365 (org-test-with-temp-text "\\begin{env}{arg}something\nvalue\n\\end{env}"
1366 (org-element-type (org-element-at-point)))))
1367 ;; Allow one-line environments.
1369 (eq 'latex-environment
1370 (org-test-with-temp-text "\\begin{env}{arg}something\\end{env}"
1371 (org-element-type (org-element-at-point)))))
1372 ;; Should not allow different tags.
1374 (eq 'latex-environment
1375 (org-test-with-temp-text "\\begin{env*}{arg}something\\end{env}"
1376 (org-element-type (org-element-at-point)))))
1377 ;; LaTeX environments must be on separate lines.
1379 (eq 'latex-environment
1380 (org-test-with-temp-text "\\begin{env} x \\end{env} y"
1381 (org-element-type (org-element-at-point)))))
1383 (eq 'latex-environment
1384 (org-test-with-temp-text "y \\begin{env} x<point> \\end{env}"
1385 (org-element-type (org-element-at-point)))))
1386 ;; Handle non-empty blank line at the end of buffer.
1388 (org-test-with-temp-text "\\begin{env}\n\\end{env}\n "
1389 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1394 (ert-deftest test-org-element
/latex-fragment-parser
()
1395 "Test `latex-fragment' parser."
1397 (org-test-with-temp-text "$a$"
1398 (org-element-map (org-element-parse-buffer) 'latex-fragment
'identity
)))
1400 (org-test-with-temp-text "$$a$$"
1401 (org-element-map (org-element-parse-buffer) 'latex-fragment
'identity
)))
1403 (org-test-with-temp-text "\\(a\\)"
1404 (org-element-map (org-element-parse-buffer) 'latex-fragment
'identity
)))
1406 (org-test-with-temp-text "\\[a\\]"
1408 (org-element-parse-buffer) 'latex-fragment
'identity
)))
1409 ;; Test fragment at the beginning of an item.
1412 (org-test-with-temp-text "- $x$"
1413 (progn (search-forward "$")
1414 (org-element-type (org-element-context)))))))
1419 (ert-deftest test-org-element
/line-break-parser
()
1420 "Test `line-break' parser."
1423 (org-test-with-temp-text "Text \\\\"
1424 (org-element-map (org-element-parse-buffer) 'line-break
'identity
)))
1425 ;; Line break with trailing white spaces.
1427 (org-test-with-temp-text "Text \\\\ "
1428 (org-element-map (org-element-parse-buffer) 'line-break
'identity
)))
1429 ;; Three backslashes are too much.
1431 (org-test-with-temp-text "Text \\\\\\"
1432 (org-element-map (org-element-parse-buffer) 'line-break
'identity
))))
1437 (ert-deftest test-org-element
/link-parser
()
1438 "Test `link' parser."
1443 (org-test-with-temp-text "<<<radio>>>A radio link"
1444 (org-update-radio-target-regexp)
1445 (org-element-property
1447 (org-element-map (org-element-parse-buffer) 'link
#'identity nil t
)))))
1450 ;; ... with description.
1454 (org-test-with-temp-text "[[http://orgmode.org][Orgmode.org]]"
1455 (org-element-contents
1456 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1457 ;; ... without description.
1461 (org-test-with-temp-text "[[http://orgmode.org]]"
1462 (org-element-property
1464 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1465 ;; ... with expansion.
1468 "//orgmode.org/worg"
1469 (org-test-with-temp-text "[[Org:worg]]"
1470 (let ((org-link-abbrev-alist '(("Org" .
"http://orgmode.org/"))))
1471 (org-element-property
1473 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
))))))
1474 ;; ... with translation.
1478 (org-test-with-temp-text "[[http://orgmode.org]]"
1479 (flet ((link-translate (type path
) (cons type
"127.0.0.1")))
1480 (let ((org-link-translation-function 'link-translate
))
1481 (org-element-property
1483 (org-element-map (org-element-parse-buffer) 'link
1484 'identity nil t
)))))))
1489 (org-test-with-temp-text "[[id:aaaa]]"
1490 (org-element-property
1492 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1493 ;; ... custom-id link.
1497 (org-test-with-temp-text "[[#some-id]]"
1498 (org-element-property
1500 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1501 ;; ... coderef link.
1505 (org-test-with-temp-text "[[(reference)]]"
1506 (org-element-property
1508 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1513 (org-test-with-temp-text "[[target-or-title]]"
1514 (org-element-property
1516 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1517 ;; ... file-type link with search option.
1520 '(("file" "projects.org" "*task title"))
1521 (org-test-with-temp-text "[[file:projects.org::*task title]]"
1522 (org-element-map (org-element-parse-buffer) 'link
1523 (lambda (l) (list (org-element-property :type l
)
1524 (org-element-property :path l
)
1525 (org-element-property :search-option l
)))))))
1526 ;; ... file-type link with application...
1527 (require 'org-docview
)
1530 '("file" "projects.org" "emacs")
1531 (org-test-with-temp-text "[[file+emacs:projects.org]]"
1532 (let ((l (org-element-context)))
1533 (list (org-element-property :type l
)
1534 (org-element-property :path l
)
1535 (org-element-property :application l
))))))
1536 ;; ... `:path' in a file-type link must be compatible with "file"
1537 ;; scheme in URI syntax, even if Org syntax isn't...
1539 (org-test-with-temp-text-in-file ""
1540 (let ((file (expand-file-name (buffer-file-name))))
1541 (insert (format "[[file://%s]]" file
))
1542 (equal (org-element-property :path
(org-element-context))
1543 (concat "//" file
)))))
1545 (org-test-with-temp-text-in-file ""
1546 (let ((file (expand-file-name (buffer-file-name))))
1547 (insert (format "[[file:%s]]" file
))
1548 (equal (org-element-property :path
(org-element-context))
1549 (concat "//" file
)))))
1551 (org-test-with-temp-text-in-file ""
1552 (let ((file (file-relative-name (buffer-file-name))))
1553 (insert (format "[[file:%s]]" file
))
1554 (list (org-element-property :path
(org-element-context)) file
))))
1555 ;; ... multi-line link.
1557 (equal "//orgmode.org"
1558 (org-test-with-temp-text "[[http://orgmode.\norg]]"
1559 (org-element-property :path
(org-element-context)))))
1562 (org-test-with-temp-text "A link: http://orgmode.org"
1563 (org-element-map (org-element-parse-buffer) 'link
'identity
)))
1566 (org-test-with-temp-text "A link: <http://orgmode.org>"
1567 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))
1568 ;; Link abbreviation.
1571 (org-test-with-temp-text
1572 "#+LINK: orgmode http://www.orgmode.org/\n[[orgmode:#docs]]"
1573 (progn (org-mode-restart)
1574 (goto-char (1- (point-max)))
1575 (org-element-property :type
(org-element-context))))))
1576 ;; Link abbreviation in a secondary string.
1579 (org-test-with-temp-text
1580 "#+LINK: orgmode http://www.orgmode.org/\n* H [[orgmode:#docs]]"
1581 (progn (org-mode-restart)
1582 (org-element-map (org-element-parse-buffer) 'link
1583 (lambda (link) (org-element-property :type link
))
1585 ;; Plain links are allowed as description of regular links.
1588 (org-test-with-temp-text "[[http://orgmode.org][file:unicorn.jpg]]"
1589 (search-forward "file:")
1590 (org-element-property :type
(org-element-context))))))
1595 (ert-deftest test-org-element
/macro-parser
()
1596 "Test `macro' parser."
1597 ;; Without arguments.
1599 (org-test-with-temp-text "{{{macro}}}"
1600 (org-element-map (org-element-parse-buffer) 'macro
'identity
)))
1603 (org-test-with-temp-text "{{{macro(arg1,arg2)}}}"
1604 (org-element-map (org-element-parse-buffer) 'macro
'identity
)))
1605 ;; Properly handle protected commas in arguments...
1609 (org-test-with-temp-text "{{{macro(arg1\\,arg1,arg2)}}}"
1610 (org-element-property :args
(org-element-context))))))
1611 ;; ... even when last argument ends with a protected comma.
1614 (org-test-with-temp-text "{{{macro(C-\\,)}}}"
1615 (org-element-property :args
(org-element-context)))))
1616 ;; Allow to escape escaping character.
1619 (org-test-with-temp-text "{{{macro(C-\\\\,)}}}"
1620 (org-element-property :args
(org-element-context)))))
1621 ;; No need to escape backslashes elsewhere.
1624 (org-test-with-temp-text "{{{macro(\\)}}}"
1625 (org-element-property :args
(org-element-context))))))
1630 (ert-deftest test-org-element
/node-property
()
1631 "Test `node-property' parser."
1634 (equal '("abc" "value")
1635 (org-test-with-temp-text "* H\n:PROPERTIES:\n<point>:abc: value\n:END:"
1636 (let ((element (org-element-at-point)))
1637 (list (org-element-property :key element
)
1638 (org-element-property :value element
))))))
1639 ;; Value should be trimmed.
1642 (org-test-with-temp-text
1643 "* H\n:PROPERTIES:\n<point>:abc: value \n:END:"
1644 (org-element-property :value
(org-element-at-point)))))
1645 ;; A node property requires to be wrapped within a property drawer.
1648 (org-test-with-temp-text ":abc: value"
1649 (org-element-type (org-element-at-point)))))
1650 ;; Accept empty properties.
1652 (equal '(("foo" "value") ("bar" ""))
1653 (org-test-with-temp-text "* H\n:PROPERTIES:\n:foo: value\n:bar:\n:END:"
1654 (org-element-map (org-element-parse-buffer) 'node-property
1656 (list (org-element-property :key p
)
1657 (org-element-property :value p
))))))))
1662 (ert-deftest test-org-element
/paragraph-parser
()
1663 "Test `paragraph' parser."
1666 (org-test-with-temp-text "Paragraph"
1667 (org-element-map (org-element-parse-buffer) 'paragraph
'identity nil t
)))
1668 ;; Property find end of a paragraph stuck to another element.
1671 (org-test-with-temp-text "Paragraph\n# Comment"
1672 (org-element-map (org-element-parse-buffer) 'paragraph
1673 (lambda (p) (char-after (org-element-property :end p
)))
1675 ;; Include ill-formed Keywords.
1677 (org-test-with-temp-text "#+wrong_keyword something"
1678 (org-element-map (org-element-parse-buffer) 'paragraph
'identity
)))
1679 ;; Include incomplete-drawers.
1681 (org-test-with-temp-text ":TEST:\nParagraph"
1682 (let ((elem (org-element-at-point)))
1683 (and (eq (org-element-type elem
) 'paragraph
)
1684 (= (point-max) (org-element-property :end elem
))))))
1685 ;; Include incomplete blocks.
1687 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph"
1688 (let ((elem (org-element-at-point)))
1689 (and (eq (org-element-type elem
) 'paragraph
)
1690 (= (point-max) (org-element-property :end elem
))))))
1691 ;; Include incomplete dynamic blocks.
1693 (org-test-with-temp-text "#+BEGIN: \nParagraph"
1694 (let ((elem (org-element-at-point)))
1695 (and (eq (org-element-type elem
) 'paragraph
)
1696 (= (point-max) (org-element-property :end elem
))))))
1697 ;; Include incomplete latex environments.
1699 (org-test-with-temp-text "\begin{equation}\nParagraph"
1700 (let ((elem (org-element-at-point)))
1701 (and (eq (org-element-type elem
) 'paragraph
)
1702 (= (point-max) (org-element-property :end elem
))))))
1703 ;; Do not steal affiliated keywords from container.
1705 (org-test-with-temp-text "#+ATTR_LATEX: test\n- item 1"
1706 (let ((elem (progn (search-forward "item") (org-element-at-point))))
1707 (and (eq (org-element-type elem
) 'paragraph
)
1708 (not (org-element-property :attr_latex elem
))
1709 (/= (org-element-property :begin elem
) 1)))))
1710 ;; Handle non-empty blank line at the end of buffer.
1712 (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
1713 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1718 (ert-deftest test-org-element
/plain-list-parser
()
1719 "Test `plain-list' parser."
1720 (org-test-with-temp-text "- item"
1721 (should (org-element-map (org-element-parse-buffer) 'plain-list
'identity
)))
1722 ;; Blank lines after the list only belong to outer plain list.
1726 (org-test-with-temp-text "
1731 (let ((endings (org-element-map (org-element-parse-buffer) 'plain-list
1732 (lambda (pl) (org-element-property :end pl
)))))
1734 ;; Move to ending of outer list.
1735 (progn (goto-char (car endings
)) (looking-at "Outside list"))
1736 ;; Move to ending of inner list.
1737 (progn (goto-char (nth 1 endings
)) (looking-at "^$")))))))
1738 ;; Correctly compute end of list if it doesn't end at a line
1741 (org-test-with-temp-text "- list\n \n "
1742 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1747 (ert-deftest test-org-element
/planning-parser
()
1748 "Test `planning' parser."
1749 ;; Test various keywords.
1751 (org-element-property
1753 (org-test-with-temp-text "* H\n<point>CLOSED: [2012-03-29 thu.]"
1754 (org-element-at-point))))
1756 (org-element-property
1758 (org-test-with-temp-text "* H\n<point>DEADLINE: <2012-03-29 thu.>"
1759 (org-element-at-point))))
1761 (org-element-property
1763 (org-test-with-temp-text "* H\n<point>SCHEDULED: <2012-03-29 thu.>"
1764 (org-element-at-point))))
1765 ;; Planning line only exists right after a headline.
1768 (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>"
1769 (org-element-type (org-element-at-point)))))
1772 (org-test-with-temp-text
1773 "* H\n# Comment\n<point>DEADLINE: <2012-03-29 thu.>"
1774 (org-element-type (org-element-at-point))))))
1777 ;;;; Property Drawer
1779 (ert-deftest test-org-element
/property-drawer-parser
()
1780 "Test `property-drawer' parser."
1783 (eq 'property-drawer
1784 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop: value\n:END:"
1785 (org-element-type (org-element-at-point)))))
1787 (eq 'property-drawer
1788 (org-test-with-temp-text
1789 "* H\nDEADLINE: <2014-03-04 tue.>\n<point>:PROPERTIES:\n:prop: value\n:END:"
1790 (org-element-type (org-element-at-point)))))
1791 ;; Allow properties without value and no property at all.
1793 (eq 'property-drawer
1794 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop:\n:END:"
1795 (org-element-type (org-element-at-point)))))
1797 (eq 'property-drawer
1798 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:END:"
1799 (org-element-type (org-element-at-point)))))
1800 ;; Ignore incomplete drawer, drawer at a wrong location or with
1803 (eq 'property-drawer
1804 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop: value"
1805 (org-element-type (org-element-at-point)))))
1807 (eq 'property-drawer
1808 (org-test-with-temp-text
1809 "* H\nParagraph\n<point>:PROPERTIES:\n:prop: value\n:END:"
1810 (org-element-type (org-element-at-point)))))
1812 (eq 'property-drawer
1813 (org-test-with-temp-text
1814 "* H\nParagraph\n<point>:PROPERTIES:\nparagraph\n:END:"
1815 (org-element-type (org-element-at-point)))))
1816 ;; Handle non-empty blank line at the end of buffer.
1818 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:END:\n "
1819 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1824 (ert-deftest test-org-element
/quote-block-parser
()
1825 "Test `quote-block' parser."
1828 (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
1829 (org-element-map (org-element-parse-buffer) 'quote-block
'identity
)))
1830 ;; Ignore incomplete block.
1832 (org-test-with-temp-text "#+BEGIN_QUOTE"
1833 (org-element-map (org-element-parse-buffer) 'quote-block
'identity nil t
)))
1834 ;; Handle non-empty blank line at the end of buffer.
1836 (org-test-with-temp-text "#+BEGIN_QUOTE\nC\n#+END_QUOTE\n "
1837 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1842 (ert-deftest test-org-element
/radio-target-parser
()
1843 "Test `radio-target' parser."
1847 (org-test-with-temp-text "<<<radio>>>"
1848 (org-element-type (org-element-context)))))
1849 ;; Radio targets with objects.
1852 (org-test-with-temp-text "<<<radio \\alpha>>>"
1853 (org-element-type (org-element-context)))))
1854 ;; Radio targets starting with an object.
1857 (org-test-with-temp-text "<<<\\alpha radio>>>"
1858 (org-element-type (org-element-context)))))
1859 ;; Radio targets cannot begin or end with white space.
1862 (org-test-with-temp-text "<<< radio>>>"
1863 (org-element-type (org-element-context)))))
1866 (org-test-with-temp-text "<<<radio >>>"
1867 (org-element-type (org-element-context))))))
1872 (ert-deftest test-org-element
/section-parser
()
1873 "Test `section' parser."
1876 (org-test-with-temp-text "* Headline\nText"
1877 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
1878 ;; There's a section before the first headline.
1880 (org-test-with-temp-text "Text"
1881 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
1882 ;; A section cannot be empty.
1884 (org-test-with-temp-text "* Headline 1\n* Headline 2"
1885 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
1886 ;; A section doesn't contain sub-trees.
1888 (org-test-with-temp-text "* Head\nText\n** Sub-Head"
1890 (org-element-map (org-element-parse-buffer) 'section
'identity nil t
)
1891 'headline
'identity
))))
1896 (ert-deftest test-org-element
/special-block-parser
()
1897 "Test `special-block' parser."
1901 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1902 (org-element-property :type
(org-element-at-point)))))
1903 ;; Special blocks are case sensitive.
1906 (org-test-with-temp-text "#+BEGIN_CaSe\nText\n#+END_CaSe"
1907 (org-element-property :type
(org-element-at-point)))))
1908 ;; Special blocks can contain paragraphs.
1911 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1913 (org-element-type (org-element-at-point)))))
1914 ;; Ignore incomplete block.
1917 (org-test-with-temp-text "#+BEGIN_SPECIAL"
1918 (org-element-type (org-element-at-point)))))
1919 ;; Allow special characters in type.
1921 (equal '(special-block "SPECIAL*")
1922 (org-test-with-temp-text "#+BEGIN_SPECIAL*\nContents\n#+END_SPECIAL*"
1923 (let ((element (org-element-at-point)))
1924 (list (org-element-type element
)
1925 (org-element-property :type element
))))))
1926 ;; Handle non-empty blank line at the end of buffer.
1928 (org-test-with-temp-text "#+BEGIN_SPECIAL\nC\n#+END_SPECIAL\n "
1929 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1934 (ert-deftest test-org-element
/src-block-parser
()
1935 "Test `src-block' parser."
1938 (org-test-with-temp-text "#+BEGIN_SRC org\nText\n#+END_SRC"
1939 (org-element-map (org-element-parse-buffer) 'src-block
'identity
)))
1940 ;; Ignore incomplete block.
1942 (org-test-with-temp-text "#+BEGIN_SRC"
1943 (org-element-map (org-element-parse-buffer) 'src-block
'identity
)))
1944 ;; Properly un-escape code.
1946 (equal "* Headline\n #+keyword\nText\n"
1947 (org-test-with-temp-text
1948 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText\n#+END_SRC"
1949 (org-element-property :value
(org-element-at-point)))))
1950 ;; Remove block indentation according to block boundaries, unless
1951 ;; block contents are less indented than block boundaries.
1954 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
1955 (let ((org-src-preserve-indentation t
))
1956 (org-element-property :value
(org-element-at-point))))))
1960 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
1961 (let ((org-src-preserve-indentation t
))
1962 (org-element-property :value
(org-element-at-point))))))
1963 ;; Handle non-empty blank line at the end of buffer.
1965 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\nC\n#+END_SRC\n "
1966 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1969 ;;;; Statistics Cookie
1971 (ert-deftest test-org-element
/statistics-cookie
()
1972 "Test `statistics-cookie' parser."
1975 (org-test-with-temp-text "[1/2]"
1976 (org-element-map (org-element-parse-buffer) 'statistics-cookie
'identity
)))
1979 (org-test-with-temp-text "[33%]"
1981 (org-element-parse-buffer) 'statistics-cookie
'identity
))))
1986 (ert-deftest test-org-element
/strike-through-parser
()
1987 "Test `strike-through' parser."
1990 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1991 (org-test-with-temp-text "+strike-through+"
1992 (org-element-map (org-element-parse-buffer) 'strike-through
'identity
))))
1993 ;; Multi-line markup.
1996 (org-element-contents
1997 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1998 (org-test-with-temp-text "+first line\nsecond line+"
2000 (org-element-parse-buffer) 'strike-through
'identity nil t
))))
2001 '("first line\nsecond line"))))
2006 (ert-deftest test-org-element
/subscript-parser
()
2007 "Test `subscript' parser."
2010 (org-test-with-temp-text "a_b"
2011 (org-element-map (org-element-parse-buffer) 'subscript
'identity
)))
2014 (org-test-with-temp-text "a_{b}"
2015 (org-element-map (org-element-parse-buffer) 'subscript
'identity
)))
2016 ;; Multiple subscripts in a paragraph.
2019 (org-test-with-temp-text "a_b and c_d"
2021 (org-element-map (org-element-parse-buffer) 'subscript
'identity
))))))
2026 (ert-deftest test-org-element
/superscript-parser
()
2027 "Test `superscript' parser."
2030 (org-test-with-temp-text "a^b"
2031 (org-element-map (org-element-parse-buffer) 'superscript
'identity
)))
2034 (org-test-with-temp-text "a^{b}"
2035 (org-element-map (org-element-parse-buffer) 'superscript
'identity
)))
2036 ;; Multiple superscript in a paragraph.
2039 (org-test-with-temp-text "a^b and c^d"
2042 (org-element-parse-buffer) 'superscript
'identity
))))))
2047 (ert-deftest test-org-element
/table-parser
()
2048 "Test `table' parser."
2050 (org-test-with-temp-text "| a |"
2051 (org-element-map (org-element-parse-buffer) 'table
'identity
)))
2052 ;; TBLFM keyword is case insensitive.
2054 (org-test-with-temp-text "| a |\n#+tblfm: test"
2055 (org-element-property
2057 (org-element-map (org-element-parse-buffer) 'table
'identity nil t
))))
2058 ;; Handle multiple TBLFM lines.
2061 (org-test-with-temp-text "| a |\n#+TBLFM: test1\n#+TBLFM: test2"
2062 (length (org-element-property
2065 (org-element-parse-buffer) 'table
'identity nil t
))))))
2066 ;; Handle non-empty blank line at the end of buffer.
2068 (org-test-with-temp-text "| a |\n "
2069 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
2074 (ert-deftest test-org-element
/table-cell-parser
()
2075 "Test `table-cell' parser."
2076 ;; Regular table cell.
2078 (org-test-with-temp-text "| a |"
2079 (org-element-map (org-element-parse-buffer) 'table-cell
'identity
)))
2080 ;; Last vertical bar may be omitted.
2082 (org-test-with-temp-text "| a "
2083 (org-element-map (org-element-parse-buffer) 'table-cell
'identity
))))
2088 (ert-deftest test-org-element
/table-row-parser
()
2089 "Test `table-row' parser."
2091 (equal '(standard rule
)
2092 (org-test-with-temp-text "| a |\n|---|"
2094 (org-element-parse-buffer) 'table-row
2095 (lambda (row) (org-element-property :type row
)))))))
2100 (ert-deftest test-org-element
/target-parser
()
2101 "Test `target' parser."
2103 (org-test-with-temp-text "<<target>>"
2104 (org-element-map (org-element-parse-buffer) 'target
'identity
))))
2109 (ert-deftest test-org-element
/timestamp
()
2110 "Test `timestamp' parser."
2111 ;; Active timestamp.
2113 (org-test-with-temp-text "<2012-03-29 16:40>"
2114 (eq (org-element-property :type
(org-element-context)) 'active
)))
2116 (org-test-with-temp-text "<2012-03-29 Thu>"
2117 (let ((timestamp (org-element-context)))
2118 (or (org-element-property :hour-start timestamp
)
2119 (org-element-property :minute-start timestamp
)))))
2121 (equal '(2012 3 29 16 40)
2122 (org-test-with-temp-text "<2012-03-29 Thu 16:40>"
2123 (let ((object (org-element-context)))
2124 (list (org-element-property :year-start object
)
2125 (org-element-property :month-start object
)
2126 (org-element-property :day-start object
)
2127 (org-element-property :hour-start object
)
2128 (org-element-property :minute-start object
))))))
2129 ;; Inactive timestamp.
2131 (org-test-with-temp-text "[2012-03-29 Thu 16:40]"
2132 (eq (org-element-property :type
(org-element-context)) 'inactive
)))
2135 (equal '(2012 3 29 16 40 7 30)
2136 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
2137 (let ((object (org-element-context)))
2138 (list (org-element-property :year-end object
)
2139 (org-element-property :month-end object
)
2140 (org-element-property :day-end object
)
2141 (org-element-property :hour-end object
)
2142 (org-element-property :minute-end object
)
2143 (org-element-property :hour-start object
)
2144 (org-element-property :minute-start object
))))))
2147 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
2148 (org-element-property :type
(org-element-context)))))
2151 (org-test-with-temp-text "[2012-03-29 Thu 16:40]--[2012-03-29 Thu 16:41]"
2152 (eq (org-element-property :type
(org-element-context)) 'inactive-range
)))
2154 (org-test-with-temp-text "[2011-07-14 Thu]--[2012-03-29 Thu]"
2155 (let ((timestamp (org-element-context)))
2156 (or (org-element-property :hour-end timestamp
)
2157 (org-element-property :minute-end timestamp
)))))
2158 ;; With repeater, warning delay and both.
2161 (org-test-with-temp-text "<2012-03-29 Thu ++1y>"
2162 (org-element-property :repeater-type
(org-element-context)))))
2165 (org-test-with-temp-text "<2012-03-29 Thu --1y>"
2166 (org-element-property :warning-type
(org-element-context)))))
2168 (equal '(cumulate all
)
2169 (org-test-with-temp-text "<2012-03-29 Thu +1y -1y>"
2170 (let ((ts (org-element-context)))
2171 (list (org-element-property :repeater-type ts
)
2172 (org-element-property :warning-type ts
)))))))
2177 (ert-deftest test-org-element
/underline-parser
()
2178 "Test `underline' parser."
2181 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2182 (org-test-with-temp-text "_underline_"
2183 (org-element-map (org-element-parse-buffer) 'underline
'identity
))))
2184 ;; Multi-line markup.
2187 (org-element-contents
2188 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2189 (org-test-with-temp-text "_first line\nsecond line_"
2191 (org-element-parse-buffer) 'underline
'identity nil t
))))
2192 '("first line\nsecond line"))))
2197 (ert-deftest test-org-element
/verbatim-parser
()
2198 "Test `verbatim' parser."
2201 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2202 (org-test-with-temp-text "=verbatim="
2203 (org-element-map (org-element-parse-buffer) 'verbatim
'identity
))))
2204 ;; Multi-line markup.
2207 (org-element-property
2209 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2210 (org-test-with-temp-text "=first line\nsecond line="
2212 (org-element-parse-buffer) 'verbatim
'identity nil t
))))
2213 "first line\nsecond line")))
2218 (ert-deftest test-org-element
/verse-block-parser
()
2219 "Test `verse-block' parser."
2222 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
2223 (org-element-map (org-element-parse-buffer) 'verse-block
'identity
)))
2226 (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
2227 (org-element-map (org-element-parse-buffer) 'verse-block
'identity
)))
2228 ;; Parse objects in verse blocks.
2230 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
2231 (org-element-map (org-element-parse-buffer) 'entity
'identity
)))
2232 ;; Ignore incomplete verse block.
2234 (org-test-with-temp-text "#+BEGIN_VERSE"
2235 (org-element-map (org-element-parse-buffer) 'verse-block
'identity nil t
)))
2236 ;; Handle non-empty blank line at the end of buffer.
2238 (org-test-with-temp-text "#+BEGIN_VERSE\nC\n#+END_VERSE\n "
2239 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
2243 ;;; Test Interpreters.
2245 (ert-deftest test-org-element
/interpret-data
()
2246 "Test `org-element-interpret-data' specifications."
2247 ;; Interpret simple affiliated keywords.
2250 (org-element-interpret-data
2251 '(org-data nil
(paragraph (:name
"para") "Paragraph")))
2252 "#+NAME: para\nParagraph\n"))
2253 ;; Interpret multiple affiliated keywords.
2256 (org-element-interpret-data
2257 '(org-data nil
(paragraph (:attr_ascii
("line2" "line1")) "Paragraph")))
2258 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
2259 ;; Interpret parsed affiliated keywords.
2262 (org-element-interpret-data
2263 '(org-data nil
(paragraph (:caption
(("caption"))) "Paragraph")))
2264 "#+CAPTION: caption\nParagraph\n"))
2265 ;; Interpret dual affiliated keywords.
2268 (org-element-interpret-data
2269 '(org-data nil
(paragraph (:caption
((("long") "short"))) "Paragraph")))
2270 "#+CAPTION[short]: long\nParagraph\n"))
2271 ;; Interpret multiple parsed dual keywords.
2274 (org-element-interpret-data
2275 '(org-data nil
(paragraph
2276 (:caption
((("l2") "s2") (("l1") "s1"))) "Paragraph")))
2277 "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph\n"))
2278 ;; Pseudo objects and elements are transparent.
2282 (org-element-interpret-data
2283 '(paragraph nil
(pseudo-object (:post-blank
1) "A") "B")))))
2286 (org-element-interpret-data
2288 (pseudo-element (:post-blank
1) (paragraph nil
"A"))
2289 (paragraph nil
"B"))))))
2291 (ert-deftest test-org-element
/center-block-interpreter
()
2292 "Test center block interpreter."
2294 (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
2295 "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
2297 (ert-deftest test-org-element
/drawer-interpreter
()
2298 "Test drawer interpreter."
2300 (equal (org-test-parse-and-interpret ":TEST:\nTest\n:END:")
2301 ":TEST:\nTest\n:END:\n")))
2303 (ert-deftest test-org-element
/dynamic-block-interpreter
()
2304 "Test dynamic block interpreter."
2306 (equal (org-test-parse-and-interpret
2307 "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
2308 "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
2310 (ert-deftest test-org-element
/footnote-definition-interpreter
()
2311 "Test footnote definition interpreter."
2312 (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
2314 (ert-deftest test-org-element
/headline-interpreter
()
2315 "Test headline and section interpreters."
2316 ;; 1. Standard test.
2317 (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
2318 ;; 2. With TODO keywords.
2320 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2321 (org-test-parse-and-interpret "* TODO Headline"))
2322 "* TODO Headline\n"))
2325 ;; 3.1. ... and a positive `org-tags-column' value.
2327 (equal (let ((org-tags-column 20))
2328 (org-test-parse-and-interpret "* Headline :tag:"))
2329 "* Headline :tag:\n"))
2330 ;; 3.2. ... and a negative `org-tags-column' value.
2332 (equal (let ((org-tags-column -
20))
2333 (org-test-parse-and-interpret "* Headline :tag:"))
2334 "* Headline :tag:\n"))
2335 ;; 3.3. ... and a null `org-tags-column' value.
2337 (equal (let ((org-tags-column 0))
2338 (org-test-parse-and-interpret "* Headline :tag:"))
2339 "* Headline :tag:\n"))
2340 ;; 4. With priority cookie.
2342 (equal (org-test-parse-and-interpret "* [#B] Headline")
2343 "* [#B] Headline\n"))
2344 ;; 5. With comment keyword.
2346 (equal (let ((org-comment-string "COMMENT"))
2347 (org-test-parse-and-interpret "* COMMENT Headline"))
2348 "* COMMENT Headline\n"))
2349 ;; 6. Keep same number of blank lines before body.
2351 (equal (org-test-parse-and-interpret
2352 "* Headline\n\n\nText after two blank lines.")
2353 "* Headline\n\n\nText after two blank lines.\n"))
2354 ;; 8. Preserve `org-odd-levels-only' state.
2356 (equal "* H\n*** H2\n"
2357 (let ((org-odd-levels-only t
))
2358 (org-test-parse-and-interpret "* H\n*** H2")))))
2360 (ert-deftest test-org-element
/inlinetask-interpreter
()
2361 "Test inlinetask interpretation."
2362 (when (featurep 'org-inlinetask
)
2363 (let ((org-inlinetask-min-level 15))
2364 ;; 1. Regular inlinetask.
2365 (should (equal (org-test-parse-and-interpret
2366 "*************** Task\nTest\n*************** END")
2367 "*************** Task\nTest\n*************** END\n"))
2368 ;; 2. Degenerate inlinetask.
2369 (should (equal (org-test-parse-and-interpret "*************** Task")
2370 "*************** Task\n"))
2371 ;; 3. Prefer degenerate form when there are no contents.
2372 (should (equal (org-test-parse-and-interpret
2373 "*************** Task\n*************** END")
2374 "*************** Task\n"))
2375 ;; 4. With TODO keywords.
2377 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2378 (org-test-parse-and-interpret "*************** TODO Task"))
2379 "*************** TODO Task\n"))
2382 ;; 5.1. ... and a positive `org-tags-column' value.
2384 (equal (let ((org-tags-column 30))
2385 (org-test-parse-and-interpret "*************** Task :tag:"))
2386 "*************** Task :tag:\n"))
2387 ;; 5.2. ... and a negative `org-tags-column' value.
2389 (equal (let ((org-tags-column -
30))
2390 (org-test-parse-and-interpret "*************** Task :tag:"))
2391 "*************** Task :tag:\n"))
2392 ;; 5.3. ... and a null `org-tags-column' value.
2394 (equal (let ((org-tags-column 0))
2395 (org-test-parse-and-interpret "*************** Task :tag:"))
2396 "*************** Task :tag:\n"))
2397 ;; 6. With priority cookie.
2399 (equal (org-test-parse-and-interpret "*************** [#B] Task")
2400 "*************** [#B] Task\n")))))
2402 (ert-deftest test-org-element
/plain-list-interpreter
()
2403 "Test plain-list and item interpreters."
2404 (let ((org-list-two-spaces-after-bullet-regexp nil
))
2406 (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
2407 ;; Description list.
2409 (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
2412 (equal (let ((org-plain-list-ordered-item-terminator t
))
2413 (org-test-parse-and-interpret "1. Item"))
2416 (equal (let ((org-plain-list-ordered-item-terminator ?\
)))
2417 (org-test-parse-and-interpret "1) Item"))
2419 ;; Ordered list with counter.
2421 (equal (let ((org-plain-list-ordered-item-terminator t
))
2422 (org-test-parse-and-interpret "1. [@5] Item"))
2424 ;; List with check-boxes.
2426 (equal (org-test-parse-and-interpret
2427 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
2428 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n"))
2429 ;; Item not starting with a paragraph.
2431 (equal (org-test-parse-and-interpret "-\n | a | b |")
2432 "- \n | a | b |\n"))
2433 ;; Special case: correctly handle "*" bullets.
2434 (should (org-test-parse-and-interpret " * item"))
2435 ;; Special case: correctly handle empty items.
2436 (should (org-test-parse-and-interpret "-"))))
2438 (ert-deftest test-org-element
/quote-block-interpreter
()
2439 "Test quote block interpreter."
2440 (should (equal (org-test-parse-and-interpret
2441 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
2442 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
2444 (ert-deftest test-org-element
/special-block-interpreter
()
2445 "Test special block interpreter."
2446 (should (equal (org-test-parse-and-interpret
2447 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
2448 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
2450 (ert-deftest test-org-element
/babel-call-interpreter
()
2451 "Test babel call interpreter."
2452 ;; 1. Without argument.
2453 (should (equal (org-test-parse-and-interpret "#+CALL: test()")
2454 "#+CALL: test()\n"))
2455 ;; 2. With argument.
2456 (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
2457 "#+CALL: test(x=2)\n"))
2458 ;; 3. With header arguments.
2459 (should (equal (org-test-parse-and-interpret
2460 "#+CALL: test[:results output]()[:results html]")
2461 "#+CALL: test[:results output]()[:results html]\n")))
2463 (ert-deftest test-org-element
/clock-interpreter
()
2464 "Test clock interpreter."
2468 "CLOCK: \\[2012-01-01 .* 00:01\\]"
2469 (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]")))
2473 "CLOCK: \\[2012-01-01 .* 00:01\\]--\\[2012-01-01 .* 00:02\\] => 0:01"
2474 (org-test-parse-and-interpret "
2475 CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))))
2477 (ert-deftest test-org-element
/comment-interpreter
()
2478 "Test comment interpreter."
2480 (should (equal (org-test-parse-and-interpret "# Comment") "# Comment\n"))
2482 (should (equal (org-test-parse-and-interpret " # Comment")
2484 ;; Preserve indentation.
2485 (should (equal (org-test-parse-and-interpret " # No blank\n# One blank")
2486 "# No blank\n# One blank\n")))
2488 (ert-deftest test-org-element
/comment-block-interpreter
()
2489 "Test comment block interpreter."
2490 (should (equal (org-test-parse-and-interpret
2491 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
2492 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n"))
2493 ;; Accept missing final newline in value.
2496 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n"
2497 (org-element-interpret-data '(comment-block (:value
"Test"))))))
2499 (ert-deftest test-org-element
/diary-sexp
()
2500 "Test diary-sexp interpreter."
2503 (org-test-parse-and-interpret
2504 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old")
2505 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old\n")))
2507 (ert-deftest test-org-element
/example-block-interpreter
()
2508 "Test example block interpreter."
2509 ;; Without switches.
2510 (should (equal (org-test-parse-and-interpret
2511 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
2512 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
2515 (equal (org-test-parse-and-interpret
2516 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
2517 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n"))
2518 ;; Preserve code escaping.
2520 (equal (org-test-parse-and-interpret
2521 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE")
2522 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE\n"))
2523 ;; Accept missing final newline in value.
2526 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"
2527 (org-element-interpret-data '(example-block (:value
"Test"))))))
2529 (ert-deftest test-org-element
/export-block-interpreter
()
2530 "Test export block interpreter."
2531 (should (equal (org-test-parse-and-interpret
2532 "#+BEGIN_HTML\nTest\n#+END_HTML")
2533 "#+BEGIN_HTML\nTest\n#+END_HTML\n")))
2535 (ert-deftest test-org-element
/fixed-width-interpreter
()
2536 "Test fixed width interpreter."
2538 (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
2539 ;; Preserve indentation.
2540 (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
2541 ": 2 blanks\n: 1 blank\n"))
2542 ;; Remove last newline character
2544 (equal (org-element-fixed-width-interpreter
2545 '(fixed-width (:value
"Test\n")) nil
)
2548 (equal (org-element-fixed-width-interpreter
2549 '(fixed-width (:value
"Test")) nil
)
2551 ;; Handle empty string.
2553 (equal (org-element-fixed-width-interpreter
2554 '(fixed-width (:value
"")) nil
)
2556 ;; Handle nil value.
2558 (org-element-fixed-width-interpreter
2559 '(fixed-width (:value nil
)) nil
)))
2561 (ert-deftest test-org-element
/horizontal-rule-interpreter
()
2562 "Test horizontal rule interpreter."
2563 (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
2565 (ert-deftest test-org-element
/keyword-interpreter
()
2566 "Test keyword interpreter."
2567 (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
2568 "#+KEYWORD: value\n")))
2570 (ert-deftest test-org-element
/latex-environment-interpreter
()
2571 "Test latex environment interpreter."
2572 (should (equal (org-test-parse-and-interpret
2573 "\\begin{equation}\n1+1=2\n\\end{equation}")
2574 "\\begin{equation}\n1+1=2\n\\end{equation}\n"))
2575 (should (equal (org-test-parse-and-interpret
2576 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}")
2577 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}\n")))
2579 (ert-deftest test-org-element
/planning-interpreter
()
2580 "Test planning interpreter."
2584 DEADLINE: <2012-03-29 .*?> SCHEDULED: <2012-03-29 .*?> CLOSED: \\[2012-03-29 .*?\\]"
2585 (org-test-parse-and-interpret
2587 DEADLINE: <2012-03-29 thu.> SCHEDULED: <2012-03-29 thu.> CLOSED: [2012-03-29 thu.]"))))
2589 (ert-deftest test-org-element
/property-drawer-interpreter
()
2590 "Test property drawer interpreter."
2591 (should (equal (let ((org-property-format "%-10s %s"))
2592 (org-test-parse-and-interpret
2593 "* H\n:PROPERTIES:\n:prop: value\n:END:"))
2594 "* H\n:PROPERTIES:\n:prop: value\n:END:\n")))
2596 (ert-deftest test-org-element
/src-block-interpreter
()
2597 "Test src block interpreter."
2600 (equal (let ((org-edit-src-content-indentation 2)
2601 (org-src-preserve-indentation nil
))
2602 (org-test-parse-and-interpret
2603 "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC"))
2604 "#+BEGIN_SRC emacs-lisp :results silent\n (+ 1 1)\n#+END_SRC\n"))
2607 (equal (let ((org-edit-src-content-indentation 2)
2608 (org-src-preserve-indentation nil
))
2609 (org-test-parse-and-interpret
2610 "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC"))
2611 "#+BEGIN_SRC emacs-lisp -n -k\n (+ 1 1)\n#+END_SRC\n"))
2612 ;; Preserve code escaping.
2614 (equal (let ((org-edit-src-content-indentation 2)
2615 (org-src-preserve-indentation nil
))
2616 (org-test-parse-and-interpret
2617 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC"))
2618 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC\n"))
2619 ;; Do not apply `org-edit-src-content-indentation' when preserving
2622 (equal (let ((org-edit-src-content-indentation 2)
2623 (org-src-preserve-indentation t
))
2624 (org-test-parse-and-interpret
2625 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"))
2626 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n"))
2628 (equal (let ((org-edit-src-content-indentation 2)
2629 (org-src-preserve-indentation nil
))
2630 (org-test-parse-and-interpret
2631 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"))
2632 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC\n"))
2633 ;; Accept missing final newline in value.
2636 "#+BEGIN_SRC emacs-lisp\n Test\n#+END_SRC\n"
2637 (let ((org-edit-src-content-indentation 2)
2638 (org-src-preserve-indentation nil
))
2639 (org-element-interpret-data
2640 '(src-block (:language
"emacs-lisp" :value
"Test")))))))
2642 (ert-deftest test-org-element
/table-interpreter
()
2643 "Test table, table-row and table-cell interpreters."
2645 (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
2646 "| a | b |\n| c | d |\n"))
2647 ;; 2. With horizontal rules.
2648 (should (equal (org-test-parse-and-interpret
2649 "| a | b |\n|---+---|\n| c | d |")
2650 "| a | b |\n|---+---|\n| c | d |\n"))
2651 ;; 3. With meta-data.
2652 (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
2653 "| / | < | > |\n| * | 1 | 2 |\n"))
2654 ;; 4. With a formula.
2656 (equal (org-test-parse-and-interpret
2657 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)")
2658 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)\n"))
2659 ;; 5. With multiple formulas.
2661 (equal (org-test-parse-and-interpret
2662 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2")
2663 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2\n")))
2665 (ert-deftest test-org-element
/timestamp-interpreter
()
2666 "Test timestamp interpreter."
2669 (string-match "<2012-03-29 .* 16:40>"
2670 (org-test-parse-and-interpret "<2012-03-29 thu. 16:40>")))
2672 (string-match "<2012-03-29 .* 16:40>"
2673 (org-element-timestamp-interpreter
2675 (:type active
:year-start
2012 :month-start
3 :day-start
29
2676 :hour-start
16 :minute-start
40)) nil
)))
2679 (string-match "\\[2012-03-29 .* 16:40\\]"
2680 (org-test-parse-and-interpret "[2012-03-29 thu. 16:40]")))
2683 "\\[2012-03-29 .* 16:40\\]"
2684 (org-element-timestamp-interpreter
2686 (:type inactive
:year-start
2012 :month-start
3 :day-start
29
2687 :hour-start
16 :minute-start
40)) nil
)))
2690 (string-match "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2691 (org-test-parse-and-interpret
2692 "<2012-03-29 thu. 16:40>--<2012-03-29 thu. 16:41>")))
2695 "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2696 (org-element-timestamp-interpreter
2698 (:type active-range
:year-start
2012 :month-start
3 :day-start
29
2699 :hour-start
16 :minute-start
40 :year-end
2012 :month-end
3
2700 :day-end
29 :hour-end
16 :minute-end
41)) nil
)))
2703 (string-match "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2704 (org-test-parse-and-interpret
2705 "[2012-03-29 thu. 16:40]--[2012-03-29 thu. 16:41]")))
2708 "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2709 (org-element-timestamp-interpreter
2711 (:type inactive-range
:year-start
2012 :month-start
3 :day-start
29
2712 :hour-start
16 :minute-start
40 :year-end
2012 :month-end
3
2713 :day-end
29 :hour-end
16 :minute-end
41)) nil
)))
2715 (should (equal (org-test-parse-and-interpret "<%%diary-float t 4 2>")
2716 "<%%diary-float t 4 2>\n"))
2717 ;; Timestamp with repeater interval, with delay, with both.
2719 (string-match "<2012-03-29 .* \\+1y>"
2720 (org-test-parse-and-interpret "<2012-03-29 thu. +1y>")))
2723 "<2012-03-29 .* \\+1y>"
2724 (org-element-timestamp-interpreter
2726 (:type active
:year-start
2012 :month-start
3 :day-start
29
2727 :repeater-type cumulate
:repeater-value
1 :repeater-unit year
))
2731 "<2012-03-29 .* -1y>"
2732 (org-element-timestamp-interpreter
2734 (:type active
:year-start
2012 :month-start
3 :day-start
29
2735 :warning-type all
:warning-value
1 :warning-unit year
))
2739 "<2012-03-29 .* \\+1y -1y>"
2740 (org-element-timestamp-interpreter
2742 (:type active
:year-start
2012 :month-start
3 :day-start
29
2743 :warning-type all
:warning-value
1 :warning-unit year
2744 :repeater-type cumulate
:repeater-value
1 :repeater-unit year
))
2746 ;; Timestamp range with repeater interval
2748 (string-match "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2749 (org-test-parse-and-interpret
2750 "<2012-03-29 Thu +1y>--<2012-03-30 Thu +1y>")))
2753 "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2754 (org-element-timestamp-interpreter
2756 (:type active-range
:year-start
2012 :month-start
3 :day-start
29
2757 :year-end
2012 :month-end
3 :day-end
30 :repeater-type cumulate
2758 :repeater-value
1 :repeater-unit year
))
2761 (ert-deftest test-org-element
/verse-block-interpreter
()
2762 "Test verse block interpretation."
2764 (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
2765 "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
2767 (ert-deftest test-org-element
/bold-interpreter
()
2768 "Test bold interpreter."
2769 (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
2771 (ert-deftest test-org-element
/code-interpreter
()
2772 "Test code interpreter."
2773 (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
2775 (ert-deftest test-org-element
/entity-interpreter
()
2776 "Test entity interpreter."
2777 ;; 1. Without brackets.
2779 (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
2780 ;; 2. With brackets.
2782 (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
2784 (ert-deftest test-org-element
/export-snippet-interpreter
()
2785 "Test export snippet interpreter."
2786 (should (equal (org-test-parse-and-interpret "@@back-end:contents@@")
2787 "@@back-end:contents@@\n")))
2789 (ert-deftest test-org-element
/footnote-reference-interpreter
()
2790 "Test footnote reference interpreter."
2791 ;; 1. Regular reference.
2792 (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
2793 ;; 2. Normalized reference.
2794 (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
2795 ;; 3. Named reference.
2796 (should (equal (org-test-parse-and-interpret "Text[fn:label]")
2797 "Text[fn:label]\n"))
2798 ;; 4. Inline reference.
2799 (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
2800 "Text[fn:label:def]\n"))
2801 ;; 5. Anonymous reference.
2802 (should (equal (org-test-parse-and-interpret "Text[fn::def]")
2803 "Text[fn::def]\n")))
2805 (ert-deftest test-org-element
/inline-babel-call-interpreter
()
2806 "Test inline babel call interpreter."
2807 ;; 1. Without arguments.
2808 (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
2809 ;; 2. With arguments.
2810 (should (equal (org-test-parse-and-interpret "call_test(x=2)")
2811 "call_test(x=2)\n"))
2812 ;; 3. With header arguments.
2813 (should (equal (org-test-parse-and-interpret
2814 "call_test[:results output]()[:results html]")
2815 "call_test[:results output]()[:results html]\n")))
2817 (ert-deftest test-org-element
/inline-src-block-interpreter
()
2818 "Test inline src block interpreter."
2819 ;; 1. Without header argument.
2820 (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
2821 "src_emacs-lisp{(+ 1 1)}\n"))
2822 ;; 2. With header arguments.
2823 (should (equal (org-test-parse-and-interpret
2824 "src_emacs-lisp[:results silent]{(+ 1 1)}")
2825 "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
2827 (ert-deftest test-org-element
/italic-interpreter
()
2828 "Test italic interpreter."
2829 (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
2831 (ert-deftest test-org-element
/latex-fragment-interpreter
()
2832 "Test latex fragment interpreter."
2833 (should (equal (org-test-parse-and-interpret "\\command{}") "\\command{}\n"))
2834 (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
2835 (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
2836 (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
2837 (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
2838 (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n")))
2840 (ert-deftest test-org-element
/line-break-interpreter
()
2841 "Test line break interpreter."
2842 (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
2843 "First line \\\\\nSecond line\n")))
2845 (ert-deftest test-org-element
/link-interpreter
()
2846 "Test link interpreter."
2847 ;; 1. Links targeted from a radio target.
2848 (should (equal (let ((org-target-link-regexp "radio-target"))
2849 (org-test-parse-and-interpret "a radio-target"))
2850 "a radio-target\n"))
2851 ;; 2. Regular links.
2853 ;; 2.1. Without description.
2854 (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
2855 "[[http://orgmode.org]]\n"))
2856 ;; 2.2. With a description.
2857 (should (equal (org-test-parse-and-interpret
2858 "[[http://orgmode.org][Org mode]]")
2859 "[[http://orgmode.org][Org mode]]\n"))
2861 (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
2862 ;; 2.4. Custom-id links.
2863 (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
2864 ;; 2.5 Code-ref links.
2865 (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
2866 ;; 3. Normalize plain links.
2867 (should (equal (org-test-parse-and-interpret "http://orgmode.org")
2868 "[[http://orgmode.org]]\n"))
2869 ;; 4. Normalize angular links.
2870 (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
2871 "[[http://orgmode.org]]\n")))
2873 (ert-deftest test-org-element
/macro-interpreter
()
2874 "Test macro interpreter."
2875 ;; 1. Without argument.
2876 (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
2877 ;; 2. With arguments.
2878 (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
2879 "{{{test(arg1,arg2)}}}\n")))
2881 (ert-deftest test-org-element
/radio-target-interpreter
()
2882 "Test radio target interpreter."
2883 (should (equal (org-test-parse-and-interpret "<<<some text>>>")
2884 "<<<some text>>>\n")))
2886 (ert-deftest test-org-element
/statistics-cookie-interpreter
()
2887 "Test statistics cookie interpreter."
2888 ;; 1. Without percent
2889 (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
2891 (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
2893 (ert-deftest test-org-element
/strike-through-interpreter
()
2894 "Test strike through interpreter."
2895 (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
2897 (ert-deftest test-org-element
/subscript-interpreter
()
2898 "Test subscript interpreter."
2899 ;; 1. Without brackets.
2900 (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
2901 ;; 2. With brackets.
2902 (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
2904 (ert-deftest test-org-element
/superscript-interpreter
()
2905 "Test superscript interpreter."
2906 ;; 1. Without brackets.
2907 (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
2908 ;; 2. With brackets.
2909 (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
2911 (ert-deftest test-org-element
/target-interpreter
()
2912 "Test target interpreter."
2913 (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
2915 (ert-deftest test-org-element
/underline-interpreter
()
2916 "Test underline interpreter."
2917 (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
2919 (ert-deftest test-org-element
/verbatim-interpreter
()
2920 "Test verbatim interpreter."
2921 (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
2925 ;;; Test Granularity
2927 (ert-deftest test-org-element
/granularity
()
2928 "Test granularity impact on buffer parsing."
2929 (org-test-with-temp-text "
2936 ;; 1.1. Granularity set to `headline' should parse every headline
2937 ;; in buffer, and only them.
2938 (let ((tree (org-element-parse-buffer 'headline
)))
2939 (should (= 2 (length (org-element-map tree
'headline
'identity
))))
2940 (should-not (org-element-map tree
'paragraph
'identity
)))
2941 ;; 1.2. Granularity set to `greater-element' should not enter
2942 ;; greater elements excepted headlines and sections.
2943 (let ((tree (org-element-parse-buffer 'greater-element
)))
2944 (should (= 1 (length (org-element-map tree
'center-block
'identity
))))
2945 (should (= 1 (length (org-element-map tree
'paragraph
'identity
))))
2946 (should-not (org-element-map tree
'entity
'identity
)))
2947 ;; 1.3. Granularity set to `element' should enter every
2949 (let ((tree (org-element-parse-buffer 'element
)))
2950 (should (= 2 (length (org-element-map tree
'paragraph
'identity
))))
2951 (should-not (org-element-map tree
'entity
'identity
)))
2952 ;; 1.4. Granularity set to `object' can see everything.
2953 (let ((tree (org-element-parse-buffer 'object
)))
2954 (should (= 1 (length (org-element-map tree
'entity
'identity
)))))))
2956 (ert-deftest test-org-element
/secondary-string-parsing
()
2957 "Test if granularity correctly toggles secondary strings parsing."
2958 ;; With a granularity bigger than `object', no secondary string
2959 ;; should be parsed.
2962 (org-test-with-temp-text "* Headline"
2964 (org-element-map (org-element-parse-buffer 'headline
) 'headline
2965 #'identity nil
'first-match
)))
2966 (org-element-property :title headline
)))))
2969 (org-test-with-temp-text "* Headline\n- tag :: item"
2970 (let ((item (org-element-map (org-element-parse-buffer 'element
) 'item
2971 #'identity nil
'first-match
)))
2972 (org-element-property :tag item
)))))
2973 (when (featurep 'org-inlinetask
)
2976 (let ((org-inlinetask-min-level 15))
2977 (org-test-with-temp-text "*************** Inlinetask"
2978 (let ((inlinetask (org-element-map (org-element-parse-buffer 'element
)
2980 #'identity nil
'first-match
)))
2981 (org-element-property :title inlinetask
)))))))
2982 ;; With a default granularity, secondary strings should be parsed.
2985 (org-test-with-temp-text "* Headline"
2987 (org-element-map (org-element-parse-buffer) 'headline
2988 #'identity nil
'first-match
)))
2989 (org-element-property :title headline
)))))
2990 ;; `org-element-at-point' should never parse a secondary string.
2993 (org-test-with-temp-text "* Headline"
2994 (org-element-property :title
(org-element-at-point)))))
2995 ;; Preserve current local variables when parsing a secondary string.
2997 (let ((org-entities nil
)
2998 (org-entities-user nil
))
2999 (org-test-with-temp-text "
3003 # org-entities-user: ((\"foo\"))
3005 (let ((safe-local-variable-values '((org-entities-user .
(("foo"))))))
3006 (hack-local-variables))
3007 (org-element-map (org-element-parse-buffer) 'entity
3008 #'identity nil nil nil t
)))))
3012 ;;; Test Visible Only Parsing
3014 (ert-deftest test-org-element
/parse-buffer-visible
()
3015 "Test `org-element-parse-buffer' with visible only argument."
3017 (equal '("H1" "H3" "H5")
3018 (org-test-with-temp-text
3019 "* H1\n** H2\n** H3 :visible:\n** H4\n** H5 :visible:"
3020 (org-occur ":visible:")
3021 (org-element-map (org-element-parse-buffer nil t
) 'headline
3022 (lambda (hl) (org-element-property :raw-value hl
)))))))
3026 ;;; Test `:parent' Property
3028 (ert-deftest test-org-element
/parent-property
()
3029 "Test `:parent' property."
3031 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
3032 (let* ((tree (org-element-parse-buffer))
3033 (parent (org-element-property
3035 (org-element-map tree
'paragraph
'identity nil t
))))
3037 (should (eq (org-element-map tree
'center-block
'identity nil t
)
3040 (org-test-with-temp-text "a_{/b/}"
3041 (let* ((tree (org-element-parse-buffer))
3042 (parent (org-element-property
3044 (org-element-map tree
'italic
'identity nil t
))))
3047 (org-element-map tree
'subscript
'identity nil t
)))))
3048 ;; Secondary strings
3049 (org-test-with-temp-text "* /italic/"
3050 (let* ((tree (org-element-parse-buffer))
3051 (parent (org-element-property
3052 :parent
(org-element-map tree
'italic
'identity nil t
))))
3055 (org-element-map tree
'headline
'identity nil t
))))))
3059 ;;; Test Normalize Contents
3061 (ert-deftest test-org-element
/normalize-contents
()
3062 "Test `org-element-normalize-contents' specifications."
3063 ;; Remove maximum common indentation from element's contents.
3066 (org-element-normalize-contents
3067 '(paragraph nil
" Two spaces\n Three spaces"))
3068 '(paragraph nil
"Two spaces\n Three spaces")))
3069 ;; Ignore objects within contents when computing maximum common
3070 ;; indentation. However, if contents start with an object, common
3071 ;; indentation is 0.
3074 (org-element-normalize-contents
3075 '(paragraph nil
" One " (emphasis nil
"space") "\n Two spaces"))
3076 '(paragraph nil
"One " (emphasis nil
"space") "\n Two spaces")))
3079 (org-element-normalize-contents
3080 '(paragraph nil
(verbatim nil
"V") "No space\n Two\n Three"))
3081 '(paragraph nil
(verbatim nil
"V") "No space\n Two\n Three")))
3082 ;; Ignore blank lines.
3085 (org-element-normalize-contents
3086 '(paragraph nil
" Two spaces\n\n \n Two spaces"))
3087 '(paragraph nil
"Two spaces\n\n \nTwo spaces")))
3090 '(paragraph nil
" Two spaces\n" (verbatim nil
"V") "\n Two spaces")
3091 (org-element-normalize-contents
3092 '(paragraph nil
" Two spaces\n " (verbatim nil
"V") "\n Two spaces"))))
3095 '(verse-block nil
"line 1\n\nline 2")
3096 (org-element-normalize-contents
3097 '(verse-block nil
" line 1\n\n line 2"))))
3098 ;; Recursively enter objects in order to compute common indentation.
3101 (org-element-normalize-contents
3102 '(paragraph nil
" Two spaces " (bold nil
" and\n One space")))
3103 '(paragraph nil
" Two spaces " (bold nil
" and\nOne space"))))
3104 ;; When optional argument is provided, ignore first line
3108 (org-element-normalize-contents
3109 '(paragraph nil
"No space\n Two spaces\n Three spaces") t
)
3110 '(paragraph nil
"No space\nTwo spaces\n Three spaces")))
3113 (org-element-normalize-contents
3114 '(paragraph nil
(verbatim nil
"V") "No space\n Two\n Three") t
)
3115 '(paragraph nil
(verbatim nil
"V") "No space\nTwo\n Three")))
3116 ;; Corner case: do not ignore indentation of string right after
3120 (org-element-normalize-contents
3121 '(paragraph nil
" 1 space" (line-break) " 2 spaces"))
3122 '(paragraph nil
"1 space" (line-break) " 2 spaces"))))
3126 ;;; Test Navigation Tools.
3128 (ert-deftest test-org-element
/at-point
()
3129 "Test `org-element-at-point' specifications."
3130 ;; Return closest element containing point.
3133 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
3134 (progn (search-forward "A")
3135 (org-element-type (org-element-at-point))))))
3136 ;; Correctly set `:parent' property.
3139 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
3140 (progn (search-forward "A")
3142 (org-element-property :parent
(org-element-at-point)))))))
3143 ;; Special case: at a blank line just below a headline, return that
3146 (equal "H1" (org-test-with-temp-text "* H1\n \n* H2\n"
3148 (org-element-property :title
(org-element-at-point)))))
3149 ;; Special case: at the very beginning of a table, return `table'
3150 ;; object instead of `table-row'.
3153 (org-test-with-temp-text "| a | b |"
3154 (org-element-type (org-element-at-point)))))
3155 ;; Special case: at the very beginning of a list or sub-list, return
3156 ;; `plain-list' object instead of `item'.
3159 (org-test-with-temp-text "- item"
3160 (org-element-type (org-element-at-point)))))
3161 ;; Special case: at the closing line of a greater element, be sure
3162 ;; to return it instead of the last element in its contents.
3165 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph\n#+END_CENTER"
3166 (progn (forward-line 2)
3167 (org-element-type (org-element-at-point))))))
3168 ;; Special case: at a blank line between two items, be sure to
3169 ;; return item above instead of the last element of its contents.
3172 (org-test-with-temp-text "- Para1\n\n- Para2"
3173 (progn (forward-line)
3175 (let ((org-list-empty-line-terminates-plain-lists nil
))
3176 (org-element-at-point)))))))
3177 ;; Special case: at the last blank line in a plain list, return it
3178 ;; instead of the last item.
3181 (org-test-with-temp-text "- Para1\n- Para2\n\nPara3"
3182 (progn (forward-line 2)
3183 (org-element-type (org-element-at-point))))))
3184 ;; Special case: when a list ends at the end of buffer and there's
3185 ;; no final newline, return last element in last item.
3188 (org-test-with-temp-text "- a"
3190 (org-element-type (org-element-at-point)))))
3191 ;; Parse a list within a block itself contained in a list.
3194 (org-test-with-temp-text
3195 "- outer\n #+begin_center\n - inner\n #+end_center"
3196 (search-forward "inner")
3198 (org-element-type (org-element-at-point)))))
3199 ;; Do not error at eob on an empty line.
3201 (org-test-with-temp-text "* H\n"
3203 (or (org-element-at-point) t
))))
3205 (ert-deftest test-org-element
/context
()
3206 "Test `org-element-context' specifications."
3207 ;; Return closest object containing point.
3210 (org-test-with-temp-text "Some *text with _underline_ text*"
3211 (progn (search-forward "under")
3212 (org-element-type (org-element-context))))))
3213 ;; Find objects in secondary strings.
3216 (org-test-with-temp-text "* Headline _with_ underlining"
3217 (progn (search-forward "w")
3218 (org-element-type (org-element-context))))))
3219 ;; Find objects in objects.
3222 (org-test-with-temp-text "| a | {{{macro}}} |"
3223 (progn (search-forward "{")
3224 (org-element-type (org-element-context))))))
3227 (org-test-with-temp-text "| a | b {{{macro}}} |"
3228 (progn (search-forward "b")
3229 (org-element-type (org-element-context))))))
3230 ;; Find objects in planning lines.
3233 (org-test-with-temp-text "* H\n SCHEDULED: <2012-03-29 thu.>"
3234 (search-forward "2012")
3235 (org-element-type (org-element-context)))))
3238 (org-test-with-temp-text "* H\n SCHEDULED: <2012-03-29 thu.>"
3239 (search-forward "SCHEDULED")
3240 (org-element-type (org-element-context)))))
3241 ;; Do not find objects in table rules.
3244 (org-test-with-temp-text "| a | b |\n+---+---+\n| c | d |"
3246 (org-element-type (org-element-context)))))
3247 ;; Find objects in parsed affiliated keywords.
3250 (org-test-with-temp-text "#+CAPTION: {{{macro}}}\n| a | b |."
3251 (progn (search-forward "{")
3252 (org-element-type (org-element-context))))))
3255 (org-test-with-temp-text "#+caption: *bold*\nParagraph"
3256 (progn (search-forward "*")
3257 (org-element-type (org-element-context))))))
3258 ;; Find objects at the end of buffer.
3261 (org-test-with-temp-text "*bold*"
3262 (goto-char (point-max))
3263 (org-element-type (org-element-context)))))
3264 ;; Correctly set `:parent' property.
3267 (org-test-with-temp-text "Some *bold* text"
3268 (progn (search-forward "bold")
3270 (org-element-property :parent
(org-element-context)))))))
3271 ;; Between two objects, return the second one.
3274 (org-test-with-temp-text "<<target>>{{{test}}}"
3275 (progn (search-forward "{")
3277 (org-element-type (org-element-context))))))
3278 ;; Test optional argument.
3281 (org-test-with-temp-text "Some *text with _underline_ text*"
3283 (search-forward "under")
3284 (org-element-type (org-element-context (org-element-at-point)))))))
3285 ;; Special case: bold object at the beginning of a headline.
3288 (org-test-with-temp-text "* *bold*"
3289 (search-forward "bo")
3290 (org-element-type (org-element-context)))))
3291 ;; Special case: incomplete cell at the end of a table row.
3294 (org-test-with-temp-text "|a|b|c"
3295 (goto-char (point-max))
3296 (org-element-type (org-element-context)))))
3297 ;; Special case: objects in inline footnotes.
3300 (org-test-with-temp-text "[fn::[[<point>http://orgmode.org]]]"
3301 (org-element-type (org-element-context))))))
3307 (ert-deftest test-org-element
/lineage
()
3308 "Test `org-element-lineage' specifications."
3309 ;; Regular tests. When applied to an element or object returned by
3310 ;; `org-element-at-point' or `org-element-context', the list is
3311 ;; limited to the current section.
3313 (equal '(paragraph center-block
)
3314 (org-test-with-temp-text
3315 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3316 (mapcar #'car
(org-element-lineage (org-element-context))))))
3318 (equal '(paragraph center-block section headline headline org-data
)
3319 (org-test-with-temp-text
3320 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3322 (org-element-lineage
3323 (org-element-map (org-element-parse-buffer) 'bold
3324 #'identity nil t
))))))
3325 ;; Test TYPES optional argument.
3328 (org-test-with-temp-text
3329 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3331 (org-element-lineage (org-element-context) '(center-block))))))
3333 (org-test-with-temp-text
3334 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3335 (org-element-lineage (org-element-context) '(example-block))))
3336 ;; Test WITH-SELF optional argument.
3338 (equal '(bold paragraph center-block
)
3339 (org-test-with-temp-text
3340 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3341 (mapcar #'car
(org-element-lineage (org-element-context) nil t
)))))
3342 ;; When TYPES and WITH-SELF are provided, the latter is also checked
3343 ;; against the former.
3345 (org-test-with-temp-text
3346 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3347 (org-element-lineage (org-element-context) '(bold) t
))))
3353 (ert-deftest test-org-element
/cache
()
3354 "Test basic expectations and common pitfalls for cache."
3358 (org-test-with-temp-text "para1\n\npara2\n\npara3"
3359 (let ((org-element-use-cache t
))
3360 (save-excursion (goto-char (point-max)) (org-element-at-point))
3363 (let ((element (org-element-at-point)))
3364 (cons (org-element-property :begin element
)
3365 (org-element-property :end element
)))))))
3366 ;; Partial shifting: when the contents of a greater element are
3367 ;; modified, only shift ending positions.
3369 (org-test-with-temp-text
3370 "#+BEGIN_CENTER\nPara1\n\nPara2\n\nPara3\n#+END_CENTER"
3371 (let ((org-element-use-cache t
))
3372 (save-excursion (search-forward "3") (org-element-at-point))
3373 (search-forward "Para2")
3375 (let ((element (org-element-property :parent
(org-element-at-point))))
3376 (equal (cons (org-element-property :begin element
)
3377 (org-element-property :end element
))
3378 (cons (point-min) (point-max)))))))
3379 ;; Re-parent shifted elements.
3382 (org-test-with-temp-text "- item\n\n\n para1\n para2"
3383 (let ((org-element-use-cache t
))
3385 (org-element-at-point)
3386 (save-excursion (goto-char (point-max)) (org-element-at-point))
3389 (goto-char (point-max))
3391 (org-element-property :parent
(org-element-at-point)))))))
3392 ;; Preserve local structures when re-parenting.
3395 (org-test-with-temp-text
3396 "#+begin_center\nP0\n\n<point>\n\n P1\n | a | b |\n| c | d |\n#+end_center"
3397 (let ((org-element-use-cache t
))
3398 (save-excursion (search-forward "| c |") (org-element-at-point))
3400 (search-forward "| c |")
3403 (org-element-property :parent
(org-element-at-point)))))))
3406 (org-test-with-temp-text
3407 "#+begin_center\nP0\n\n<point>\n\n P1\n | a | b |\n#+end_center"
3408 (let ((org-element-use-cache t
))
3409 (save-excursion (search-forward "| a |") (org-element-at-point))
3411 (search-forward "| a |")
3414 (org-element-property :parent
(org-element-at-point)))))))
3415 ;; When re-parenting, also propagate changes to list structures.
3418 (org-test-with-temp-text "\n Para\n - item<point>"
3419 (let ((org-element-use-cache t
))
3420 (org-element-at-point)
3421 (goto-char (point-min))
3423 (search-forward "- item")
3425 (length (org-element-property :structure
(org-element-at-point)))))))
3426 ;; Modifying the last line of an element alters the element below.
3428 (org-test-with-temp-text "para1\n\npara2"
3429 (let ((org-element-use-cache t
))
3430 (goto-char (point-max))
3431 (org-element-at-point)
3434 (let ((element (org-element-at-point)))
3435 (equal (cons (org-element-property :begin element
)
3436 (org-element-property :end element
))
3437 (cons (point-min) (point-max)))))))
3438 ;; Modifying the first line of an element alters the element above.
3440 (org-test-with-temp-text ": fixed-width\n:not-fixed-width"
3441 (let ((org-element-use-cache t
))
3442 (goto-char (point-max))
3443 (org-element-at-point)
3444 (search-backward ":")
3447 (let ((element (org-element-at-point)))
3448 (equal (cons (org-element-property :begin element
)
3449 (org-element-property :end element
))
3450 (cons (point-min) (point-max)))))))
3451 ;; Sensitive change: adding a line alters document structure both
3455 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n"
3456 (let ((org-element-use-cache t
))
3457 (goto-char (point-max))
3458 (org-element-at-point)
3459 (insert "#+END_EXAMPLE")
3460 (search-backward "Para1")
3461 (org-element-type (org-element-at-point))))))
3464 (org-test-with-temp-text "Para1\n\nPara2\n#+END_EXAMPLE"
3465 (let ((org-element-use-cache t
))
3466 (save-excursion (goto-char (point-max)) (org-element-at-point))
3467 (insert "#+BEGIN_EXAMPLE\n")
3468 (search-forward "Para2")
3469 (org-element-type (org-element-at-point))))))
3470 ;; Sensitive change: removing a line alters document structure both
3474 (org-test-with-temp-text
3475 "# +BEGIN_EXAMPLE\nPara1\n\nPara2\n#+END_EXAMPLE"
3476 (let ((org-element-use-cache t
))
3477 (save-excursion (goto-char (point-max)) (org-element-at-point))
3480 (search-forward "Para2")
3481 (org-element-type (org-element-at-point))))))
3484 (org-test-with-temp-text
3485 "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n# +END_EXAMPLE"
3486 (let ((org-element-use-cache t
))
3487 (save-excursion (goto-char (point-max)) (org-element-at-point))
3488 (search-forward "# ")
3490 (search-backward "Para1")
3491 (org-element-type (org-element-at-point))))))
3492 ;; Corner case: watch out drawers named "PROPERTIES" as they are
3493 ;; fragile, unlike to other drawers.
3496 (org-test-with-temp-text "* H\n:PROPERTIES:\n:A: 1\n:A<point>\n:END:"
3497 (let ((org-element-use-cache t
))
3498 (org-element-at-point)
3500 (org-element-type (org-element-at-point)))))))
3503 (provide 'test-org-element
)
3505 ;;; test-org-element.el ends here