1 ;;; test-org-element.el --- Tests for org-element.el
3 ;; Copyright (C) 2012, 2013, 2014 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
))))))
292 ;;;; Affiliated Keywords
294 (ert-deftest test-org-element
/affiliated-keywords-parser
()
295 "Test affiliated keywords parsing."
296 ;; Read simple keywords.
299 (org-element-property
301 (org-test-with-temp-text "#+NAME: para\nParagraph"
302 (org-element-at-point)))))
305 (org-element-property
307 (org-test-with-temp-text "#+NAME: para\nParagraph"
308 (org-element-at-point)))))
309 ;; Parse multiple keywords.
313 (org-element-property
315 (org-test-with-temp-text
316 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph"
317 (org-element-at-point)))))
318 ;; Parse "parsed" keywords.
322 (org-test-with-temp-text "#+CAPTION: caption\nParagraph"
323 (car (org-element-property :caption
(org-element-at-point))))))
324 ;; Parse dual keywords.
327 '((("long") "short"))
328 (org-test-with-temp-text "#+CAPTION[short]: long\nParagraph"
329 (org-element-property :caption
(org-element-at-point)))))
330 ;; Allow multiple caption keywords.
333 '((("l2") "s2") (("l1") "s1"))
334 (org-test-with-temp-text "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph"
335 (org-element-property :caption
(org-element-at-point)))))
338 '((("l1")) (nil "s1"))
339 (org-test-with-temp-text "#+CAPTION[s1]:\n#+CAPTION: l1\nParagraph"
340 (org-element-property :caption
(org-element-at-point)))))
341 ;; Corner case: orphaned keyword at the end of an element.
344 (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
345 (progn (search-forward "name")
346 (org-element-type (org-element-at-point))))))
348 (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
349 (progn (search-forward "Some")
350 (org-element-property :name
(org-element-at-point))))))
355 (ert-deftest test-org-element
/babel-call-parser
()
356 "Test `babel-call' parsing."
359 (org-test-with-temp-text "#+CALL: test()"
360 (org-element-map (org-element-parse-buffer) 'babel-call
'identity
)))
363 (org-test-with-temp-text "#+call: test()"
364 (org-element-map (org-element-parse-buffer) 'babel-call
'identity
)))
365 ;; Handle non-empty blank line at the end of buffer.
367 (org-test-with-temp-text "#+CALL: test()\n "
368 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
373 (ert-deftest test-org-element
/bold-parser
()
374 "Test `bold' parser."
377 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
378 (org-test-with-temp-text "*bold*"
379 (org-element-map (org-element-parse-buffer) 'bold
'identity nil t
))))
380 ;; Multi-line markup.
383 (org-element-contents
384 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
385 (org-test-with-temp-text "*first line\nsecond line*"
386 (org-element-map (org-element-parse-buffer) 'bold
'identity nil t
))))
387 '("first line\nsecond line"))))
392 (ert-deftest test-org-element
/center-block-parser
()
393 "Test `center-block' parser."
396 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
397 (org-element-map (org-element-parse-buffer) 'center-block
'identity
)))
400 (org-test-with-temp-text "#+begin_center\nText\n#+end_center"
401 (org-element-map (org-element-parse-buffer) 'center-block
'identity
)))
402 ;; Ignore incomplete block.
404 (org-test-with-temp-text "#+BEGIN_CENTER"
405 (org-element-map (org-element-parse-buffer) 'center-block
407 ;; Handle non-empty blank line at the end of buffer.
409 (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
410 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
415 (ert-deftest test-org-element
/clock-parser
()
416 "Test `clock' parser."
418 (let ((clock (org-test-with-temp-text "CLOCK: [2012-01-01 sun. 00:01]"
419 (org-element-at-point))))
420 (should (eq (org-element-property :status clock
) 'running
))
422 (equal (org-element-property :raw-value
423 (org-element-property :value clock
))
424 "[2012-01-01 sun. 00:01]"))
425 (should-not (org-element-property :duration clock
)))
428 (org-test-with-temp-text
429 "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"
430 (org-element-at-point))))
431 (should (eq (org-element-property :status clock
) 'closed
))
432 (should (equal (org-element-property :raw-value
433 (org-element-property :value clock
))
434 "[2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02]"))
435 (should (equal (org-element-property :duration clock
) "0:01"))))
440 (ert-deftest test-org-element
/code-parser
()
441 "Test `code' parser."
444 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
445 (org-test-with-temp-text "~code~"
446 (org-element-map (org-element-parse-buffer) 'code
'identity
))))
447 ;; Multi-line markup.
450 (org-element-property
452 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
453 (org-test-with-temp-text "~first line\nsecond line~"
455 (org-element-parse-buffer) 'code
'identity nil t
))))
456 "first line\nsecond line")))
461 (ert-deftest test-org-element
/comment-parser
()
462 "Test `comment' parser."
465 (org-test-with-temp-text "# Comment"
466 (org-element-map (org-element-parse-buffer) 'comment
'identity
)))
469 (org-test-with-temp-text " # Comment"
470 (org-element-map (org-element-parse-buffer) 'comment
'identity
)))
471 ;; Preserve indentation.
474 (org-element-property
476 (org-test-with-temp-text "# No blank\n# One blank"
477 (org-element-map (org-element-parse-buffer) 'comment
'identity nil t
)))
478 "No blank\n One blank"))
479 ;; Comment with blank lines.
482 (org-element-property
484 (org-test-with-temp-text "# First part\n# \n#\n# Second part"
485 (org-element-map (org-element-parse-buffer) 'comment
'identity nil t
)))
486 "First part\n\n\nSecond part"))
487 ;; Do not mix comments and keywords.
490 (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
491 (length (org-element-map (org-element-parse-buffer) 'comment
495 (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
496 (org-element-property
498 (org-element-map (org-element-parse-buffer) 'comment
500 ;; Correctly handle non-empty blank lines at the end of buffer.
502 (org-test-with-temp-text "# A\n "
503 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
508 (ert-deftest test-org-element
/comment-block-parser
()
509 "Test `comment-block' parser."
512 (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
513 (org-element-map (org-element-parse-buffer) 'comment-block
'identity
)))
516 (org-test-with-temp-text "#+begin_comment\nText\n#+end_comment"
517 (org-element-map (org-element-parse-buffer) 'comment-block
'identity
)))
518 ;; Ignore incomplete block.
520 (org-test-with-temp-text "#+BEGIN_COMMENT"
521 (org-element-map (org-element-parse-buffer) 'comment-block
523 ;; Handle non-empty blank line at the end of buffer.
525 (org-test-with-temp-text "#+BEGIN_COMMENT\nC\n#+END_COMMENT\n "
526 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
531 (ert-deftest test-org-element
/diary-sexp-parser
()
532 "Test `diary-sexp' parser."
536 (org-test-with-temp-text
537 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old"
538 (org-element-type (org-element-at-point)))))
539 ;; Diary sexp must live at beginning of line
542 (org-test-with-temp-text " %%(org-bbdb-anniversaries)"
543 (org-element-type (org-element-at-point)))))
544 ;; Handle non-empty blank line at the end of buffer.
546 (org-test-with-temp-text "%%(org-bbdb-anniversaries)\n "
547 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
552 (ert-deftest test-org-element
/drawer-parser
()
553 "Test `drawer' parser."
556 (org-test-with-temp-text ":TEST:\nText\n:END:"
557 (org-element-map (org-element-parse-buffer) 'drawer
'identity
)))
558 ;; Do not mix regular drawers and property drawers.
560 (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
561 (org-element-map (org-element-parse-buffer) 'drawer
'identity nil t
)))
562 ;; Ignore incomplete drawer.
564 (org-test-with-temp-text ":TEST:"
565 (org-element-map (org-element-parse-buffer) 'drawer
'identity nil t
)))
566 ;; Handle non-empty blank line at the end of buffer.
568 (org-test-with-temp-text ":TEST:\nC\n:END:\n "
569 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
574 (ert-deftest test-org-element
/dynamic-block-parser
()
575 "Test `dynamic-block' parser."
578 (org-test-with-temp-text
579 "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
580 (org-element-map (org-element-parse-buffer) 'dynamic-block
'identity
)))
583 (org-test-with-temp-text
584 "#+begin: myblock :param1 val1 :param2 val2\nText\n#+end:"
585 (org-element-map (org-element-parse-buffer) 'dynamic-block
'identity
)))
586 ;; Ignore incomplete block.
588 (org-test-with-temp-text "#+BEGIN: myblock :param1 val1 :param2 val2"
589 (org-element-map (org-element-parse-buffer) 'dynamic-block
591 ;; Handle non-empty blank line at the end of buffer.
593 (org-test-with-temp-text "#+BEGIN: myblock :param val1\nC\n#+END:\n "
594 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
599 (ert-deftest test-org-element
/entity-parser
()
600 "Test `entity' parser."
603 (org-test-with-temp-text "\\sin"
604 (org-element-map (org-element-parse-buffer) 'entity
'identity
)))
607 (org-element-property
609 (org-test-with-temp-text "\\alpha{}text"
610 (org-element-map (org-element-parse-buffer) 'entity
'identity nil t
))))
611 ;; User-defined entity.
614 (org-element-property
616 (let ((org-entities-user
617 '(("test" "test" nil
"test" "test" "test" "test"))))
618 (org-test-with-temp-text "\\test"
619 (org-element-map (org-element-parse-buffer) 'entity
'identity nil t
))))
621 ;; Special case: entity at the end of a container.
624 (org-test-with-temp-text "*\\alpha \\beta*"
625 (search-forward "be")
626 (org-element-type (org-element-context))))))
631 (ert-deftest test-org-element
/example-block-parser
()
632 "Test `example-block' parser."
635 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
636 (org-element-map (org-element-parse-buffer) 'example-block
'identity
)))
637 ;; Ignore incomplete block.
640 (org-test-with-temp-text "#+BEGIN_EXAMPLE"
641 (org-element-type (org-element-at-point)))))
642 ;; Properly un-escape code.
644 (equal "* Headline\n #+keyword\nText\n"
645 (org-test-with-temp-text
646 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText\n#+END_EXAMPLE"
647 (org-element-property :value
(org-element-at-point)))))
648 ;; Remove block indentation according to block boundaries, unless
649 ;; block contents are less indented than block boundaries.
652 (org-test-with-temp-text " #+BEGIN_EXAMPLE\n L1\n L2\n #+END_EXAMPLE"
653 (let ((org-src-preserve-indentation t
))
654 (org-element-property :value
(org-element-at-point))))))
658 (org-test-with-temp-text " #+BEGIN_EXAMPLE\n L1\n L2\n #+END_EXAMPLE"
659 (let ((org-src-preserve-indentation t
))
660 (org-element-property :value
(org-element-at-point))))))
661 ;; Handle non-empty blank line at the end of buffer.
663 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nC\n#+END_EXAMPLE\n "
664 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
666 (ert-deftest test-org-element
/block-switches
()
667 "Test `example-block' and `src-block' switches parsing."
668 (let ((org-coderef-label-format "(ref:%s)"))
669 ;; 1. Test "-i" switch.
671 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
672 (org-element-property :preserve-indent
(org-element-at-point))))
674 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"
675 (org-element-property :preserve-indent
(org-element-at-point))))
677 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
678 (org-element-property :preserve-indent
(org-element-at-point))))
680 (org-test-with-temp-text "#+BEGIN_EXAMPLE -i\nText.\n#+END_EXAMPLE"
681 (org-element-property :preserve-indent
(org-element-at-point))))
682 ;; 2. "-n -r -k" combination should number lines, retain labels but
683 ;; not use them in coderefs.
685 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r -k\nText.\n#+END_EXAMPLE"
686 (let ((element (org-element-at-point)))
687 (and (org-element-property :number-lines element
)
688 (org-element-property :retain-labels element
)
689 (not (org-element-property :use-labels element
))))))
691 (org-test-with-temp-text
692 "#+BEGIN_SRC emacs-lisp -n -r -k\n(+ 1 1)\n#+END_SRC"
693 (let ((element (org-element-at-point)))
694 (and (org-element-property :number-lines element
)
695 (org-element-property :retain-labels element
)
696 (not (org-element-property :use-labels element
))))))
697 ;; 3. "-n -r" combination should number-lines remove labels and not
698 ;; use them in coderefs.
700 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r\nText.\n#+END_EXAMPLE"
701 (let ((element (org-element-at-point)))
702 (and (org-element-property :number-lines element
)
703 (not (org-element-property :retain-labels element
))
704 (not (org-element-property :use-labels element
))))))
706 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1)\n#+END_SRC"
707 (let ((element (org-element-at-point)))
708 (and (org-element-property :number-lines element
)
709 (not (org-element-property :retain-labels element
))
710 (not (org-element-property :use-labels element
))))))
711 ;; 4. "-n" or "+n" should number lines, retain labels and use them
714 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n\nText.\n#+END_EXAMPLE"
715 (let ((element (org-element-at-point)))
716 (and (org-element-property :number-lines element
)
717 (org-element-property :retain-labels element
)
718 (org-element-property :use-labels element
)))))
720 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1)\n#+END_SRC"
721 (let ((element (org-element-at-point)))
722 (and (org-element-property :number-lines element
)
723 (org-element-property :retain-labels element
)
724 (org-element-property :use-labels element
)))))
726 (org-test-with-temp-text "#+BEGIN_EXAMPLE +n\nText.\n#+END_EXAMPLE"
727 (let ((element (org-element-at-point)))
728 (and (org-element-property :number-lines element
)
729 (org-element-property :retain-labels element
)
730 (org-element-property :use-labels element
)))))
732 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp +n\n(+ 1 1)\n#+END_SRC"
733 (let ((element (org-element-at-point)))
734 (and (org-element-property :number-lines element
)
735 (org-element-property :retain-labels element
)
736 (org-element-property :use-labels element
)))))
737 ;; 5. No switch should not number lines, but retain labels and use
740 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
741 (let ((element (org-element-at-point)))
742 (and (not (org-element-property :number-lines element
))
743 (org-element-property :retain-labels element
)
744 (org-element-property :use-labels element
)))))
746 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
747 (let ((element (org-element-at-point)))
748 (and (not (org-element-property :number-lines element
))
749 (org-element-property :retain-labels element
)
750 (org-element-property :use-labels element
)))))
751 ;; 6. "-r" switch only: do not number lines, remove labels, and
752 ;; don't use labels in coderefs.
754 (org-test-with-temp-text "#+BEGIN_EXAMPLE -r\nText.\n#+END_EXAMPLE"
755 (let ((element (org-element-at-point)))
756 (and (not (org-element-property :number-lines element
))
757 (not (org-element-property :retain-labels element
))
758 (not (org-element-property :use-labels element
))))))
760 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1)\n#+END_SRC"
761 (let ((element (org-element-at-point)))
762 (and (not (org-element-property :number-lines element
))
763 (not (org-element-property :retain-labels element
))
764 (not (org-element-property :use-labels element
))))))
765 ;; 7. Recognize coderefs with user-defined syntax.
769 (org-test-with-temp-text
770 "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText [ref:text]\n#+END_EXAMPLE"
771 (org-element-property :label-fmt
(org-element-at-point)))))
775 (org-test-with-temp-text
776 "#+BEGIN_SRC emacs-lisp -l \"[ref:%s]\"\n(+ 1 1) [ref:text]\n#+END_SRC"
777 (org-element-property :label-fmt
(org-element-at-point)))))))
782 (ert-deftest test-org-element
/export-block-parser
()
783 "Test `export-block' parser."
786 (org-test-with-temp-text "#+BEGIN_LATEX\nText\n#+END_LATEX"
788 (let ((org-element-block-name-alist
789 '(("LATEX" . org-element-export-block-parser
))))
790 (org-element-parse-buffer))
791 'export-block
'identity
)))
794 (let ((org-element-block-name-alist
795 '(("LATEX" . org-element-export-block-parser
))))
796 (org-test-with-temp-text "#+begin_latex\nText\n#+end_latex"
797 (org-element-map (org-element-parse-buffer) 'export-block
'identity
))))
798 ;; Ignore incomplete block.
800 (let ((org-element-block-name-alist
801 '(("LATEX" . org-element-export-block-parser
))))
802 (org-test-with-temp-text "#+BEGIN_LATEX"
803 (org-element-map (org-element-parse-buffer) 'export-block
805 ;; Handle non-empty blank line at the end of buffer.
807 (let ((org-element-block-name-alist
808 '(("LATEX" . org-element-export-block-parser
))))
809 (org-test-with-temp-text "#+BEGIN_LATEX\nC\n#+END_LATEX\n "
810 (= (org-element-property :end
(org-element-at-point)) (point-max))))))
815 (ert-deftest test-org-element
/export-snippet-parser
()
816 "Test `export-snippet' parser."
819 '("back-end" .
"contents")
820 (org-test-with-temp-text "@@back-end:contents@@"
822 (org-element-parse-buffer) 'export-snippet
823 (lambda (snippet) (cons (org-element-property :back-end snippet
)
824 (org-element-property :value snippet
)))
830 (ert-deftest test-org-element
/fixed-width-parser
()
831 "Test fixed-width area parsing."
832 ;; Preserve indentation.
834 (org-test-with-temp-text ": no blank\n: one blank"
835 (org-element-map (org-element-parse-buffer) 'fixed-width
'identity
)))
836 ;; Fixed-width with empty lines.
838 (org-test-with-temp-text ": first part\n:\n: \n: second part"
839 (org-element-map (org-element-parse-buffer) 'fixed-width
'identity
)))
840 ;; Parse indented fixed-width markers.
842 (org-test-with-temp-text "Text\n : no blank\n : one blank"
843 (org-element-map (org-element-parse-buffer) 'fixed-width
'identity
)))
844 ;; Distinguish fixed-width areas within a list and outside of it.
848 (org-test-with-temp-text "
851 : fixed-width outside"
852 (org-element-map (org-element-parse-buffer) 'fixed-width
'identity
)))))
853 ;; Handle non-empty blank line at the end of buffer.
855 (org-test-with-temp-text ": A\n "
856 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
859 ;;;; Footnote Definition
861 (ert-deftest test-org-element
/footnote-definition-parser
()
862 "Test `footnote-definition' parser."
864 (org-test-with-temp-text "[fn:1] Definition"
865 (org-element-map (org-element-parse-buffer) 'footnote-definition
867 ;; Footnote with more contents
870 (org-element-property
872 (org-test-with-temp-text "[fn:1] Definition\n\n| a | b |"
873 (org-element-map (org-element-parse-buffer) 'footnote-definition
875 ;; Footnote starting with special syntax.
877 (org-test-with-temp-text "[fn:1] - no item"
878 (org-element-map (org-element-parse-buffer) 'item
'identity
)))
879 ;; Correctly handle footnote starting with an empty line.
882 (org-test-with-temp-text "[fn:1]\n\n Body"
883 (org-element-property :contents-begin
(org-element-at-point)))))
884 ;; Handle non-empty blank line at the end of buffer.
886 (org-test-with-temp-text "[fn:1] Definition\n "
887 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
890 ;;;; Footnotes Reference.
892 (ert-deftest test-org-element
/footnote-reference-parser
()
893 "Test `footnote-reference' parser."
894 ;; 1. Parse a standard reference.
895 (org-test-with-temp-text "Text[fn:label]"
898 (org-element-parse-buffer) 'footnote-reference
'identity
)))
899 ;; 2. Parse a normalized reference.
900 (org-test-with-temp-text "Text[1]"
903 (org-element-parse-buffer) 'footnote-reference
'identity
)))
904 ;; 3. Parse an inline reference.
905 (org-test-with-temp-text "Text[fn:test:def]"
908 (org-element-parse-buffer) 'footnote-reference
'identity
)))
909 ;; 4. Parse an anonymous reference.
910 (org-test-with-temp-text "Text[fn::def]"
913 (org-element-parse-buffer) 'footnote-reference
'identity
)))
914 ;; 5. Parse nested footnotes.
915 (org-test-with-temp-text "Text[fn::def [fn:label]]"
920 (org-element-parse-buffer) 'footnote-reference
'identity
)))))
921 ;; 6. Parse adjacent footnotes.
922 (org-test-with-temp-text "Text[fn:label1][fn:label2]"
927 (org-element-parse-buffer) 'footnote-reference
'identity
)))))
928 ;; 7. Only properly closed footnotes are recognized as such.
929 (org-test-with-temp-text "Text[fn:label"
932 (org-element-parse-buffer) 'footnote-reference
'identity
))))
937 (ert-deftest test-org-element
/headline-comment-keyword
()
938 "Test COMMENT keyword recognition."
940 (org-test-with-temp-text "* Headline"
941 (let ((org-comment-string "COMMENT"))
942 (should-not (org-element-property :commentedp
(org-element-at-point)))))
943 ;; Standard position.
944 (org-test-with-temp-text "* COMMENT Headline"
945 (let ((org-comment-string "COMMENT")
946 (headline (org-element-at-point)))
947 (should (org-element-property :commentedp headline
))
948 (should (equal (org-element-property :raw-value headline
) "Headline"))))
950 (org-test-with-temp-text "* COMMENT Headline"
951 (let* ((org-comment-string "Comment")
952 (headline (org-element-at-point)))
953 (should-not (org-element-property :commentedp headline
))
954 (should (equal (org-element-property :raw-value headline
)
955 "COMMENT Headline"))))
956 ;; With another keyword.
957 (org-test-with-temp-text "* TODO COMMENT Headline"
958 (let* ((org-comment-string "COMMENT")
959 (org-todo-keywords '((sequence "TODO" "DONE")))
960 (headline (org-element-at-point)))
961 (should (org-element-property :commentedp headline
))
962 (should (equal (org-element-property :raw-value headline
) "Headline"))))
963 ;; With the keyword only.
964 (org-test-with-temp-text "* COMMENT"
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
) "")))))
970 (ert-deftest test-org-element
/headline-archive-tag
()
971 "Test ARCHIVE tag recognition."
974 (org-test-with-temp-text "* Headline"
975 (let ((org-archive-tag "ARCHIVE"))
976 (org-element-property :archivedp
(org-element-at-point)))))
978 (org-test-with-temp-text "* Headline :ARCHIVE:"
979 (let ((org-archive-tag "ARCHIVE"))
980 (let ((headline (org-element-at-point)))
981 (should (org-element-property :archivedp headline
))
983 (should-not (org-element-property :tags headline
)))))
985 (org-test-with-temp-text "* Headline :test:ARCHIVE:"
986 (let ((org-archive-tag "ARCHIVE"))
987 (let ((headline (org-element-at-point)))
988 (should (org-element-property :archivedp headline
))
990 (should (equal (org-element-property :tags headline
) '("test"))))))
991 ;; Tag is case-sensitive.
993 (org-test-with-temp-text "* Headline :ARCHIVE:"
994 (let ((org-archive-tag "Archive"))
995 (org-element-property :archivedp
(org-element-at-point))))))
997 (ert-deftest test-org-element
/headline-properties
()
998 "Test properties from property drawer."
999 ;; All properties from property drawer have their symbol upper
1002 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
1003 (org-element-property :FOO
(org-element-at-point))))
1005 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
1006 (org-element-property :foo
(org-element-at-point)))))
1009 ;;;; Horizontal Rule
1011 (ert-deftest test-org-element
/horizontal-rule-parser
()
1012 "Test `horizontal-rule' parser."
1015 (org-test-with-temp-text "-----"
1016 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
1019 (org-test-with-temp-text " -----"
1020 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
1021 ;; Hyphen must be alone on the line.
1023 (org-test-with-temp-text "-----wrong"
1024 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
1025 ;; 4 hyphens is too small.
1027 (org-test-with-temp-text "----"
1028 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
1029 ;; Handle non-empty blank line at the end of buffer.
1031 (org-test-with-temp-text "-----\n "
1032 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1035 ;;;; Inline Babel Call
1037 (ert-deftest test-org-element
/inline-babel-call-parser
()
1038 "Test `inline-babel-call' parser."
1040 (org-test-with-temp-text "call_test()"
1042 (org-element-parse-buffer) 'inline-babel-call
'identity
))))
1045 ;;;; Inline Src Block
1047 (ert-deftest test-org-element
/inline-src-block-parser
()
1048 "Test `inline-src-block' parser."
1050 (org-test-with-temp-text "src_emacs-lisp{(+ 1 1)}"
1051 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1052 ;; Test parsing at the beginning of an item.
1054 (org-test-with-temp-text "- src_emacs-lisp{(+ 1 1)}"
1055 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
))))
1060 (ert-deftest test-org-element
/inlinetask-parser
()
1061 "Test `inlinetask' parser."
1062 (when (featurep 'org-inlinetask
)
1063 (let ((org-inlinetask-min-level 15))
1064 ;; Regular inlinetask.
1067 (org-test-with-temp-text
1068 "*************** Task\nTest\n*************** END"
1069 (org-element-type (org-element-at-point)))))
1070 ;; Degenerate inlinetask.
1073 (org-test-with-temp-text "*************** Task"
1074 (org-element-type (org-element-at-point)))))
1075 ;; Mixed inlinetasks.
1077 (org-test-with-temp-text
1079 *************** Task
1080 *************** Task2
1082 *************** END"
1084 (goto-char (org-element-property :end
(org-element-at-point)))
1090 (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
1091 (org-test-with-temp-text "*************** TODO Task"
1092 (org-element-property :todo-keyword
(org-element-at-point))))))
1095 (org-test-with-temp-text "
1096 *************** Task
1097 DEADLINE: <2012-03-29 thu.>"
1099 (org-element-property :deadline
(org-element-at-point))))
1104 (org-test-with-temp-text "
1105 *************** [#A] Task"
1107 (org-element-property :priority
(org-element-at-point)))))
1112 (org-test-with-temp-text "
1113 *************** Task :test:"
1115 (org-element-property :tags
(org-element-at-point)))))
1116 ;; Regular properties are accessed through upper case keywords.
1118 (org-test-with-temp-text "
1119 *************** Task
1123 *************** END"
1125 (org-element-property :FOO
(org-element-at-point))))
1127 (org-test-with-temp-text "
1128 *************** Task
1132 *************** END"
1134 (org-element-property :foo
(org-element-at-point))))
1135 ;; Handle non-empty blank line at the end of buffer.
1137 (org-test-with-temp-text "*************** Task\n*************** END\n "
1138 (= (org-element-property :end
(org-element-at-point)) (point-max)))))))
1143 (ert-deftest test-org-element
/italic-parser
()
1144 "Test `italic' parser."
1147 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1148 (org-test-with-temp-text "/italic/"
1149 (org-element-map (org-element-parse-buffer) 'italic
'identity nil t
))))
1150 ;; Multi-line markup.
1153 (org-element-contents
1154 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1155 (org-test-with-temp-text "/first line\nsecond line/"
1156 (org-element-map (org-element-parse-buffer) 'italic
'identity nil t
))))
1157 '("first line\nsecond line"))))
1162 (ert-deftest test-org-element
/item-parser
()
1163 "Test `item' parser."
1166 (org-test-with-temp-text "- item"
1167 (org-element-map (org-element-parse-buffer) 'item
'identity
)))
1171 (org-element-property
1173 (org-test-with-temp-text "6. [@6] item"
1174 (org-element-map (org-element-parse-buffer) 'item
'identity nil t
)))))
1179 (org-element-property
1181 (org-test-with-temp-text "- tag :: description"
1182 (org-element-map (org-element-parse-buffer) 'item
'identity nil t
)))))
1183 ;; No tags in ordered lists.
1185 (org-element-property
1187 (org-test-with-temp-text "1. tag :: description"
1188 (org-element-map (org-element-parse-buffer) 'item
'identity nil t
))))
1193 (org-test-with-temp-text "
1198 (org-element-parse-buffer) 'item
1199 (lambda (item) (org-element-property :checkbox item
))))))
1200 ;; Item starting with special syntax.
1202 (equal '(("- item"))
1203 (org-test-with-temp-text "- - item"
1204 (org-element-map (org-element-parse-buffer) 'paragraph
1205 'org-element-contents
))))
1206 ;; Block in an item: ignore indentation within the block.
1208 (org-test-with-temp-text "- item\n #+begin_src emacs-lisp\n(+ 1 1)\n #+end_src"
1210 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1215 (ert-deftest test-org-element
/keyword-parser
()
1216 "Test `keyword' parser."
1219 (org-test-with-temp-text "#+KEYWORD: value"
1220 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1221 ;; Keywords are case-insensitive.
1223 (org-test-with-temp-text "#+keyword: value"
1224 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1225 ;; Affiliated keywords are not keywords.
1227 (org-test-with-temp-text "#+NAME: value
1229 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1230 ;; Do not mix keywords with Babel calls and dynamic blocks.
1232 (org-test-with-temp-text "#+CALL: fun()"
1233 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1235 (org-test-with-temp-text "#+BEGIN: my-fun\nBody\n#+END:"
1236 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1237 ;; Handle non-empty blank line at the end of buffer.
1239 (org-test-with-temp-text "#+KEYWORD: value\n "
1240 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1243 ;;;; Latex Environment
1245 (ert-deftest test-org-element
/latex-environment-parser
()
1246 "Test `latex-environment' parser."
1248 (org-test-with-temp-text "\\begin{equation}\ne^{i\\pi}+1=0\n\\end{equation}"
1249 (org-element-map (org-element-parse-buffer) 'latex-environment
'identity
)))
1250 ;; Allow nested environments.
1258 (org-test-with-temp-text "
1264 (org-element-property
1267 (org-element-parse-buffer) 'latex-environment
'identity nil t
)))))
1268 ;; Allow environments with options and arguments.
1270 (eq 'latex-environment
1271 (org-test-with-temp-text
1272 "\\begin{theorem}[Euler]\ne^{i\\pi}+1=0\n\\end{theorem}"
1273 (org-element-type (org-element-at-point)))))
1275 (eq 'latex-environment
1276 (org-test-with-temp-text "\\begin{env}{arg}\nvalue\n\\end{env}"
1277 (org-element-type (org-element-at-point)))))
1279 (eq 'latex-environment
1280 (org-test-with-temp-text "\\begin{env}{arg} something\nvalue\n\\end{env}"
1281 (org-element-type (org-element-at-point)))))
1282 ;; Handle non-empty blank line at the end of buffer.
1284 (org-test-with-temp-text "\\begin{env}\n\\end{env}\n "
1285 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1290 (ert-deftest test-org-element
/latex-fragment-parser
()
1291 "Test `latex-fragment' parser."
1293 (org-test-with-temp-text "$a$"
1294 (org-element-map (org-element-parse-buffer) 'latex-fragment
'identity
)))
1296 (org-test-with-temp-text "$$a$$"
1297 (org-element-map (org-element-parse-buffer) 'latex-fragment
'identity
)))
1299 (org-test-with-temp-text "\\(a\\)"
1300 (org-element-map (org-element-parse-buffer) 'latex-fragment
'identity
)))
1302 (org-test-with-temp-text "\\[a\\]"
1304 (org-element-parse-buffer) 'latex-fragment
'identity
)))
1305 ;; Test fragment at the beginning of an item.
1308 (org-test-with-temp-text "- $x$"
1309 (progn (search-forward "$")
1310 (org-element-type (org-element-context)))))))
1315 (ert-deftest test-org-element
/line-break-parser
()
1316 "Test `line-break' parser."
1319 (org-test-with-temp-text "Text \\\\"
1320 (org-element-map (org-element-parse-buffer) 'line-break
'identity
)))
1321 ;; Line break with trailing white spaces.
1323 (org-test-with-temp-text "Text \\\\ "
1324 (org-element-map (org-element-parse-buffer) 'line-break
'identity
)))
1325 ;; Three backslashes are too much.
1327 (org-test-with-temp-text "Text \\\\\\"
1328 (org-element-map (org-element-parse-buffer) 'line-break
'identity
))))
1333 (ert-deftest test-org-element
/link-parser
()
1334 "Test `link' parser."
1339 (org-test-with-temp-text "<<<radio>>>A radio link"
1340 (org-update-radio-target-regexp)
1341 (org-element-property
1343 (org-element-map (org-element-parse-buffer) 'link
#'identity nil t
)))))
1346 ;; ... with description.
1350 (org-test-with-temp-text "[[http://orgmode.org][Orgmode.org]]"
1351 (org-element-contents
1352 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1353 ;; ... without description.
1357 (org-test-with-temp-text "[[http://orgmode.org]]"
1358 (org-element-property
1360 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1361 ;; ... with expansion.
1364 "//orgmode.org/worg"
1365 (org-test-with-temp-text "[[Org:worg]]"
1366 (let ((org-link-abbrev-alist '(("Org" .
"http://orgmode.org/"))))
1367 (org-element-property
1369 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
))))))
1370 ;; ... with translation.
1374 (org-test-with-temp-text "[[http://orgmode.org]]"
1375 (flet ((link-translate (type path
) (cons type
"127.0.0.1")))
1376 (let ((org-link-translation-function 'link-translate
))
1377 (org-element-property
1379 (org-element-map (org-element-parse-buffer) 'link
1380 'identity nil t
)))))))
1385 (org-test-with-temp-text "[[id:aaaa]]"
1386 (org-element-property
1388 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1389 ;; ... custom-id link.
1393 (org-test-with-temp-text "[[#some-id]]"
1394 (org-element-property
1396 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1397 ;; ... coderef link.
1401 (org-test-with-temp-text "[[(reference)]]"
1402 (org-element-property
1404 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1409 (org-test-with-temp-text "[[target-or-title]]"
1410 (org-element-property
1412 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1413 ;; ... file-type link with search option.
1416 '(("file" "projects.org" "*task title"))
1417 (org-test-with-temp-text "[[file:projects.org::*task title]]"
1418 (org-element-map (org-element-parse-buffer) 'link
1419 (lambda (l) (list (org-element-property :type l
)
1420 (org-element-property :path l
)
1421 (org-element-property :search-option l
)))))))
1422 ;; ... file-type link with application.
1425 '(("file" "projects.org" "docview"))
1426 (org-test-with-temp-text "[[docview:projects.org]]"
1427 (org-element-map (org-element-parse-buffer) 'link
1428 (lambda (l) (list (org-element-property :type l
)
1429 (org-element-property :path l
)
1430 (org-element-property :application l
)))))))
1433 (org-test-with-temp-text "A link: http://orgmode.org"
1434 (org-element-map (org-element-parse-buffer) 'link
'identity
)))
1437 (org-test-with-temp-text "A link: <http://orgmode.org>"
1438 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))
1439 ;; Link abbreviation.
1442 (org-test-with-temp-text
1443 "#+LINK: orgmode http://www.orgmode.org/\n[[orgmode:#docs]]"
1444 (progn (org-mode-restart)
1445 (goto-char (1- (point-max)))
1446 (org-element-property :type
(org-element-context))))))
1447 ;; Link abbreviation in a secondary string.
1450 (org-test-with-temp-text
1451 "#+LINK: orgmode http://www.orgmode.org/\n* H [[orgmode:#docs]]"
1452 (progn (org-mode-restart)
1453 (org-element-map (org-element-parse-buffer) 'link
1454 (lambda (link) (org-element-property :type link
))
1456 ;; Plain links are allowed as description of regular links.
1459 (org-test-with-temp-text "[[http://orgmode.org][file:unicorn.jpg]]"
1460 (search-forward "file:")
1461 (org-element-property :type
(org-element-context))))))
1466 (ert-deftest test-org-element
/macro-parser
()
1467 "Test `macro' parser."
1468 ;; Without arguments.
1470 (org-test-with-temp-text "{{{macro}}}"
1471 (org-element-map (org-element-parse-buffer) 'macro
'identity
)))
1474 (org-test-with-temp-text "{{{macro(arg1,arg2)}}}"
1475 (org-element-map (org-element-parse-buffer) 'macro
'identity
)))
1476 ;; Properly handle protected commas in arguments...
1480 (org-test-with-temp-text "{{{macro(arg1\\,arg1,arg2)}}}"
1481 (org-element-property :args
(org-element-context))))))
1482 ;; ... even when last argument ends with a protected comma.
1485 (org-test-with-temp-text "{{{macro(C-\\,)}}}"
1486 (org-element-property :args
(org-element-context)))))
1487 ;; Allow to escape escaping character.
1490 (org-test-with-temp-text "{{{macro(C-\\\\,)}}}"
1491 (org-element-property :args
(org-element-context)))))
1492 ;; No need to escape backslashes elsewhere.
1495 (org-test-with-temp-text "{{{macro(\\)}}}"
1496 (org-element-property :args
(org-element-context))))))
1501 (ert-deftest test-org-element
/node-property
()
1502 "Test `node-property' parser."
1505 (equal '("abc" "value")
1506 (org-test-with-temp-text ":PROPERTIES:\n:abc: value\n:END:"
1507 (progn (forward-line)
1508 (let ((element (org-element-at-point)))
1509 (list (org-element-property :key element
)
1510 (org-element-property :value element
)))))))
1511 ;; Value should be trimmed.
1514 (org-test-with-temp-text ":PROPERTIES:\n:abc: value \n:END:"
1515 (progn (forward-line)
1516 (let ((element (org-element-at-point)))
1517 (org-element-property :value element
))))))
1518 ;; A node property requires to be wrapped within a property drawer.
1521 (org-test-with-temp-text ":abc: value"
1522 (org-element-type (org-element-at-point))))))
1527 (ert-deftest test-org-element
/paragraph-parser
()
1528 "Test `paragraph' parser."
1531 (org-test-with-temp-text "Paragraph"
1532 (org-element-map (org-element-parse-buffer) 'paragraph
'identity nil t
)))
1533 ;; Property find end of a paragraph stuck to another element.
1536 (org-test-with-temp-text "Paragraph\n# Comment"
1537 (org-element-map (org-element-parse-buffer) 'paragraph
1538 (lambda (p) (char-after (org-element-property :end p
)))
1540 ;; Include ill-formed Keywords.
1542 (org-test-with-temp-text "#+wrong_keyword something"
1543 (org-element-map (org-element-parse-buffer) 'paragraph
'identity
)))
1544 ;; Include incomplete-drawers.
1546 (org-test-with-temp-text ":TEST:\nParagraph"
1547 (let ((elem (org-element-at-point)))
1548 (and (eq (org-element-type elem
) 'paragraph
)
1549 (= (point-max) (org-element-property :end elem
))))))
1550 ;; Include incomplete blocks.
1552 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph"
1553 (let ((elem (org-element-at-point)))
1554 (and (eq (org-element-type elem
) 'paragraph
)
1555 (= (point-max) (org-element-property :end elem
))))))
1556 ;; Include incomplete dynamic blocks.
1558 (org-test-with-temp-text "#+BEGIN: \nParagraph"
1559 (let ((elem (org-element-at-point)))
1560 (and (eq (org-element-type elem
) 'paragraph
)
1561 (= (point-max) (org-element-property :end elem
))))))
1562 ;; Include incomplete latex environments.
1564 (org-test-with-temp-text "\begin{equation}\nParagraph"
1565 (let ((elem (org-element-at-point)))
1566 (and (eq (org-element-type elem
) 'paragraph
)
1567 (= (point-max) (org-element-property :end elem
))))))
1568 ;; Do not steal affiliated keywords from container.
1570 (org-test-with-temp-text "#+ATTR_LATEX: test\n- item 1"
1571 (let ((elem (progn (search-forward "item") (org-element-at-point))))
1572 (and (eq (org-element-type elem
) 'paragraph
)
1573 (not (org-element-property :attr_latex elem
))
1574 (/= (org-element-property :begin elem
) 1)))))
1575 ;; Handle non-empty blank line at the end of buffer.
1577 (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
1578 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1583 (ert-deftest test-org-element
/plain-list-parser
()
1584 "Test `plain-list' parser."
1585 (org-test-with-temp-text "- item"
1586 (should (org-element-map (org-element-parse-buffer) 'plain-list
'identity
)))
1587 ;; Blank lines after the list only belong to outer plain list.
1591 (org-test-with-temp-text "
1596 (let ((endings (org-element-map (org-element-parse-buffer) 'plain-list
1597 (lambda (pl) (org-element-property :end pl
)))))
1599 ;; Move to ending of outer list.
1600 (progn (goto-char (car endings
)) (looking-at "Outside list"))
1601 ;; Move to ending of inner list.
1602 (progn (goto-char (nth 1 endings
)) (looking-at "^$")))))))
1603 ;; Correctly compute end of list if it doesn't end at a line
1606 (org-test-with-temp-text "- list\n \n "
1607 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1612 (ert-deftest test-org-element
/planning-parser
()
1613 "Test `planning' parser."
1615 (equal "[2012-03-29 thu.]"
1616 (org-element-property
1618 (org-element-property
1620 (org-test-with-temp-text "CLOSED: [2012-03-29 thu.]"
1621 (org-element-at-point))))))
1623 (equal "<2012-03-29 thu.>"
1624 (org-element-property
1626 (org-element-property
1628 (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>"
1629 (org-element-at-point))))))
1631 (equal "<2012-03-29 thu.>"
1632 (org-element-property
1634 (org-element-property
1636 (org-test-with-temp-text "SCHEDULED: <2012-03-29 thu.>"
1637 (org-element-at-point)))))))
1640 ;;;; Property Drawer
1642 (ert-deftest test-org-element
/property-drawer-parser
()
1643 "Test `property-drawer' parser."
1646 (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
1648 (org-element-parse-buffer) 'property-drawer
'identity nil t
)))
1649 ;; Do not mix property drawers and regular drawers.
1651 (org-test-with-temp-text ":TEST:\n:prop: value\n:END:"
1653 (org-element-parse-buffer) 'property-drawer
'identity nil t
)))
1654 ;; Ignore incomplete drawer.
1656 (org-test-with-temp-text ":PROPERTIES:\n:prop: value"
1658 (org-element-parse-buffer) 'property-drawer
'identity nil t
)))
1659 ;; Handle non-empty blank line at the end of buffer.
1661 (org-test-with-temp-text ":PROPERTIES:\n:END:\n "
1662 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1667 (ert-deftest test-org-element
/quote-block-parser
()
1668 "Test `quote-block' parser."
1671 (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
1672 (org-element-map (org-element-parse-buffer) 'quote-block
'identity
)))
1673 ;; Ignore incomplete block.
1675 (org-test-with-temp-text "#+BEGIN_QUOTE"
1676 (org-element-map (org-element-parse-buffer) 'quote-block
'identity nil t
)))
1677 ;; Handle non-empty blank line at the end of buffer.
1679 (org-test-with-temp-text "#+BEGIN_QUOTE\nC\n#+END_QUOTE\n "
1680 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1685 (ert-deftest test-org-element
/radio-target-parser
()
1686 "Test `radio-target' parser."
1690 (org-test-with-temp-text "<<<radio>>>"
1691 (org-element-type (org-element-context)))))
1692 ;; Radio targets with objects.
1695 (org-test-with-temp-text "<<<radio \\alpha>>>"
1696 (org-element-type (org-element-context)))))
1697 ;; Radio targets starting with an object.
1700 (org-test-with-temp-text "<<<\\alpha radio>>>"
1701 (org-element-type (org-element-context)))))
1702 ;; Radio targets cannot begin or end with white space.
1705 (org-test-with-temp-text "<<< radio>>>"
1706 (org-element-type (org-element-context)))))
1709 (org-test-with-temp-text "<<<radio >>>"
1710 (org-element-type (org-element-context))))))
1715 (ert-deftest test-org-element
/section-parser
()
1716 "Test `section' parser."
1719 (org-test-with-temp-text "* Headline\nText"
1720 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
1721 ;; There's a section before the first headline.
1723 (org-test-with-temp-text "Text"
1724 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
1725 ;; A section cannot be empty.
1727 (org-test-with-temp-text "* Headline 1\n* Headline 2"
1728 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
1729 ;; A section doesn't contain sub-trees.
1731 (org-test-with-temp-text "* Head\nText\n** Sub-Head"
1733 (org-element-map (org-element-parse-buffer) 'section
'identity nil t
)
1734 'headline
'identity
))))
1739 (ert-deftest test-org-element
/special-block-parser
()
1740 "Test `special-block' parser."
1744 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1745 (org-element-property :type
(org-element-at-point)))))
1746 ;; Special blocks can contain paragraphs.
1749 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1751 (org-element-type (org-element-at-point)))))
1752 ;; Ignore incomplete block.
1755 (org-test-with-temp-text "#+BEGIN_SPECIAL"
1756 (org-element-type (org-element-at-point)))))
1757 ;; Allow special characters in type.
1759 (equal '(special-block "SPECIAL*")
1760 (org-test-with-temp-text "#+BEGIN_SPECIAL*\nContents\n#+END_SPECIAL*"
1761 (let ((element (org-element-at-point)))
1762 (list (org-element-type element
)
1763 (org-element-property :type element
))))))
1764 ;; Handle non-empty blank line at the end of buffer.
1766 (org-test-with-temp-text "#+BEGIN_SPECIAL\nC\n#+END_SPECIAL\n "
1767 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1772 (ert-deftest test-org-element
/src-block-parser
()
1773 "Test `src-block' parser."
1776 (org-test-with-temp-text "#+BEGIN_SRC org\nText\n#+END_SRC"
1777 (org-element-map (org-element-parse-buffer) 'src-block
'identity
)))
1778 ;; Ignore incomplete block.
1780 (org-test-with-temp-text "#+BEGIN_SRC"
1781 (org-element-map (org-element-parse-buffer) 'src-block
'identity
)))
1782 ;; Properly un-escape code.
1784 (equal "* Headline\n #+keyword\nText\n"
1785 (org-test-with-temp-text
1786 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText\n#+END_SRC"
1787 (org-element-property :value
(org-element-at-point)))))
1788 ;; Remove block indentation according to block boundaries, unless
1789 ;; block contents are less indented than block boundaries.
1792 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
1793 (let ((org-src-preserve-indentation t
))
1794 (org-element-property :value
(org-element-at-point))))))
1798 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
1799 (let ((org-src-preserve-indentation t
))
1800 (org-element-property :value
(org-element-at-point))))))
1801 ;; Handle non-empty blank line at the end of buffer.
1803 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\nC\n#+END_SRC\n "
1804 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1807 ;;;; Statistics Cookie
1809 (ert-deftest test-org-element
/statistics-cookie
()
1810 "Test `statistics-cookie' parser."
1813 (org-test-with-temp-text "[1/2]"
1814 (org-element-map (org-element-parse-buffer) 'statistics-cookie
'identity
)))
1817 (org-test-with-temp-text "[33%]"
1819 (org-element-parse-buffer) 'statistics-cookie
'identity
))))
1824 (ert-deftest test-org-element
/strike-through-parser
()
1825 "Test `strike-through' parser."
1828 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1829 (org-test-with-temp-text "+strike-through+"
1830 (org-element-map (org-element-parse-buffer) 'strike-through
'identity
))))
1831 ;; Multi-line markup.
1834 (org-element-contents
1835 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1836 (org-test-with-temp-text "+first line\nsecond line+"
1838 (org-element-parse-buffer) 'strike-through
'identity nil t
))))
1839 '("first line\nsecond line"))))
1844 (ert-deftest test-org-element
/subscript-parser
()
1845 "Test `subscript' parser."
1848 (org-test-with-temp-text "a_b"
1849 (org-element-map (org-element-parse-buffer) 'subscript
'identity
)))
1852 (org-test-with-temp-text "a_{b}"
1853 (org-element-map (org-element-parse-buffer) 'subscript
'identity
)))
1854 ;; Multiple subscripts in a paragraph.
1857 (org-test-with-temp-text "a_b and c_d"
1859 (org-element-map (org-element-parse-buffer) 'subscript
'identity
))))))
1864 (ert-deftest test-org-element
/superscript-parser
()
1865 "Test `superscript' parser."
1868 (org-test-with-temp-text "a^b"
1869 (org-element-map (org-element-parse-buffer) 'superscript
'identity
)))
1872 (org-test-with-temp-text "a^{b}"
1873 (org-element-map (org-element-parse-buffer) 'superscript
'identity
)))
1874 ;; Multiple superscript in a paragraph.
1877 (org-test-with-temp-text "a^b and c^d"
1880 (org-element-parse-buffer) 'superscript
'identity
))))))
1885 (ert-deftest test-org-element
/table-parser
()
1886 "Test `table' parser."
1888 (org-test-with-temp-text "| a |"
1889 (org-element-map (org-element-parse-buffer) 'table
'identity
)))
1890 ;; TBLFM keyword is case insensitive.
1892 (org-test-with-temp-text "| a |\n#+tblfm: test"
1893 (org-element-property
1895 (org-element-map (org-element-parse-buffer) 'table
'identity nil t
))))
1896 ;; Handle multiple TBLFM lines.
1899 (org-test-with-temp-text "| a |\n#+TBLFM: test1\n#+TBLFM: test2"
1900 (length (org-element-property
1903 (org-element-parse-buffer) 'table
'identity nil t
))))))
1904 ;; Handle non-empty blank line at the end of buffer.
1906 (org-test-with-temp-text "| a |\n "
1907 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1912 (ert-deftest test-org-element
/table-cell-parser
()
1913 "Test `table-cell' parser."
1914 ;; Regular table cell.
1916 (org-test-with-temp-text "| a |"
1917 (org-element-map (org-element-parse-buffer) 'table-cell
'identity
)))
1918 ;; Last vertical bar may be omitted.
1920 (org-test-with-temp-text "| a "
1921 (org-element-map (org-element-parse-buffer) 'table-cell
'identity
))))
1926 (ert-deftest test-org-element
/table-row-parser
()
1927 "Test `table-row' parser."
1929 (equal '(standard rule
)
1930 (org-test-with-temp-text "| a |\n|---|"
1932 (org-element-parse-buffer) 'table-row
1933 (lambda (row) (org-element-property :type row
)))))))
1938 (ert-deftest test-org-element
/target-parser
()
1939 "Test `target' parser."
1941 (org-test-with-temp-text "<<target>>"
1942 (org-element-map (org-element-parse-buffer) 'target
'identity
))))
1947 (ert-deftest test-org-element
/timestamp
()
1948 "Test `timestamp' parser."
1949 ;; Active timestamp.
1951 (org-test-with-temp-text "<2012-03-29 16:40>"
1952 (eq (org-element-property :type
(org-element-context)) 'active
)))
1954 (org-test-with-temp-text "<2012-03-29 Thu>"
1955 (let ((timestamp (org-element-context)))
1956 (or (org-element-property :hour-start timestamp
)
1957 (org-element-property :minute-start timestamp
)))))
1959 (equal '(2012 3 29 16 40)
1960 (org-test-with-temp-text "<2012-03-29 Thu 16:40>"
1961 (let ((object (org-element-context)))
1962 (list (org-element-property :year-start object
)
1963 (org-element-property :month-start object
)
1964 (org-element-property :day-start object
)
1965 (org-element-property :hour-start object
)
1966 (org-element-property :minute-start object
))))))
1967 ;; Inactive timestamp.
1969 (org-test-with-temp-text "[2012-03-29 Thu 16:40]"
1970 (eq (org-element-property :type
(org-element-context)) 'inactive
)))
1973 (equal '(2012 3 29 16 40 7 30)
1974 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
1975 (let ((object (org-element-context)))
1976 (list (org-element-property :year-end object
)
1977 (org-element-property :month-end object
)
1978 (org-element-property :day-end object
)
1979 (org-element-property :hour-end object
)
1980 (org-element-property :minute-end object
)
1981 (org-element-property :hour-start object
)
1982 (org-element-property :minute-start object
))))))
1985 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
1986 (org-element-property :type
(org-element-context)))))
1989 (org-test-with-temp-text "[2012-03-29 Thu 16:40]--[2012-03-29 Thu 16:41]"
1990 (eq (org-element-property :type
(org-element-context)) 'inactive-range
)))
1992 (org-test-with-temp-text "[2011-07-14 Thu]--[2012-03-29 Thu]"
1993 (let ((timestamp (org-element-context)))
1994 (or (org-element-property :hour-end timestamp
)
1995 (org-element-property :minute-end timestamp
)))))
1996 ;; With repeater, warning delay and both.
1999 (org-test-with-temp-text "<2012-03-29 Thu ++1y>"
2000 (org-element-property :repeater-type
(org-element-context)))))
2003 (org-test-with-temp-text "<2012-03-29 Thu --1y>"
2004 (org-element-property :warning-type
(org-element-context)))))
2006 (equal '(cumulate all
)
2007 (org-test-with-temp-text "<2012-03-29 Thu +1y -1y>"
2008 (let ((ts (org-element-context)))
2009 (list (org-element-property :repeater-type ts
)
2010 (org-element-property :warning-type ts
))))))
2011 ;; Timestamps are not planning elements.
2013 (org-test-with-temp-text "SCHEDULED: <2012-03-29 Thu 16:40>"
2014 (org-element-map (org-element-parse-buffer) 'timestamp
'identity
))))
2019 (ert-deftest test-org-element
/underline-parser
()
2020 "Test `underline' parser."
2023 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2024 (org-test-with-temp-text "_underline_"
2025 (org-element-map (org-element-parse-buffer) 'underline
'identity
))))
2026 ;; Multi-line markup.
2029 (org-element-contents
2030 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2031 (org-test-with-temp-text "_first line\nsecond line_"
2033 (org-element-parse-buffer) 'underline
'identity nil t
))))
2034 '("first line\nsecond line"))))
2039 (ert-deftest test-org-element
/verbatim-parser
()
2040 "Test `verbatim' parser."
2043 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2044 (org-test-with-temp-text "=verbatim="
2045 (org-element-map (org-element-parse-buffer) 'verbatim
'identity
))))
2046 ;; Multi-line markup.
2049 (org-element-property
2051 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2052 (org-test-with-temp-text "=first line\nsecond line="
2054 (org-element-parse-buffer) 'verbatim
'identity nil t
))))
2055 "first line\nsecond line")))
2060 (ert-deftest test-org-element
/verse-block-parser
()
2061 "Test `verse-block' parser."
2064 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
2065 (org-element-map (org-element-parse-buffer) 'verse-block
'identity
)))
2068 (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
2069 (org-element-map (org-element-parse-buffer) 'verse-block
'identity
)))
2070 ;; Parse objects in verse blocks.
2072 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
2073 (org-element-map (org-element-parse-buffer) 'entity
'identity
)))
2074 ;; Ignore incomplete verse block.
2076 (org-test-with-temp-text "#+BEGIN_VERSE"
2077 (org-element-map (org-element-parse-buffer) 'verse-block
'identity nil t
)))
2078 ;; Handle non-empty blank line at the end of buffer.
2080 (org-test-with-temp-text "#+BEGIN_VERSE\nC\n#+END_VERSE\n "
2081 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
2085 ;;; Test Interpreters.
2087 (ert-deftest test-org-element
/interpret-data
()
2088 "Test `org-element-interpret-data' specifications."
2089 ;; Interpret simple affiliated keywords.
2092 (org-element-interpret-data
2093 '(org-data nil
(paragraph (:name
"para") "Paragraph")))
2094 "#+NAME: para\nParagraph\n"))
2095 ;; Interpret multiple affiliated keywords.
2098 (org-element-interpret-data
2099 '(org-data nil
(paragraph (:attr_ascii
("line2" "line1")) "Paragraph")))
2100 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
2101 ;; Interpret parsed affiliated keywords.
2104 (org-element-interpret-data
2105 '(org-data nil
(paragraph (:caption
(("caption"))) "Paragraph")))
2106 "#+CAPTION: caption\nParagraph\n"))
2107 ;; Interpret dual affiliated keywords.
2110 (org-element-interpret-data
2111 '(org-data nil
(paragraph (:caption
((("long") "short"))) "Paragraph")))
2112 "#+CAPTION[short]: long\nParagraph\n"))
2113 ;; Interpret multiple parsed dual keywords.
2116 (org-element-interpret-data
2117 '(org-data nil
(paragraph
2118 (:caption
((("l2") "s2") (("l1") "s1"))) "Paragraph")))
2119 "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph\n"))
2120 ;; Pseudo objects and elements are transparent.
2123 (org-element-interpret-data
2124 '(paragraph nil
(pseudo-object (:post-blank
1) "A") "B")
2128 (org-element-interpret-data
2130 (pseudo-element (:post-blank
1) (paragraph nil
"A"))
2131 (paragraph nil
"B"))))))
2133 (ert-deftest test-org-element
/center-block-interpreter
()
2134 "Test center block interpreter."
2136 (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
2137 "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
2139 (ert-deftest test-org-element
/drawer-interpreter
()
2140 "Test drawer interpreter."
2142 (equal (org-test-parse-and-interpret ":TEST:\nTest\n:END:")
2143 ":TEST:\nTest\n:END:\n")))
2145 (ert-deftest test-org-element
/dynamic-block-interpreter
()
2146 "Test dynamic block interpreter."
2148 (equal (org-test-parse-and-interpret
2149 "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
2150 "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
2152 (ert-deftest test-org-element
/footnote-definition-interpreter
()
2153 "Test footnote definition interpreter."
2154 (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
2156 (ert-deftest test-org-element
/headline-interpreter
()
2157 "Test headline and section interpreters."
2158 ;; 1. Standard test.
2159 (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
2160 ;; 2. With TODO keywords.
2162 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2163 (org-test-parse-and-interpret "* TODO Headline"))
2164 "* TODO Headline\n"))
2167 ;; 3.1. ... and a positive `org-tags-column' value.
2169 (equal (let ((org-tags-column 20))
2170 (org-test-parse-and-interpret "* Headline :tag:"))
2171 "* Headline :tag:\n"))
2172 ;; 3.2. ... and a negative `org-tags-column' value.
2174 (equal (let ((org-tags-column -
20))
2175 (org-test-parse-and-interpret "* Headline :tag:"))
2176 "* Headline :tag:\n"))
2177 ;; 3.3. ... and a null `org-tags-column' value.
2179 (equal (let ((org-tags-column 0))
2180 (org-test-parse-and-interpret "* Headline :tag:"))
2181 "* Headline :tag:\n"))
2182 ;; 4. With priority cookie.
2184 (equal (org-test-parse-and-interpret "* [#B] Headline")
2185 "* [#B] Headline\n"))
2186 ;; 5. With comment keyword.
2188 (equal (let ((org-comment-string "COMMENT"))
2189 (org-test-parse-and-interpret "* COMMENT Headline"))
2190 "* COMMENT Headline\n"))
2191 ;; 6. Keep same number of blank lines before body.
2193 (equal (org-test-parse-and-interpret
2194 "* Headline\n\n\nText after two blank lines.")
2195 "* Headline\n\n\nText after two blank lines.\n")))
2197 (ert-deftest test-org-element
/inlinetask-interpreter
()
2198 "Test inlinetask interpretation."
2199 (when (featurep 'org-inlinetask
)
2200 (let ((org-inlinetask-min-level 15))
2201 ;; 1. Regular inlinetask.
2202 (should (equal (org-test-parse-and-interpret
2203 "*************** Task\nTest\n*************** END")
2204 "*************** Task\nTest\n*************** END\n"))
2205 ;; 2. Degenerate inlinetask.
2206 (should (equal (org-test-parse-and-interpret "*************** Task")
2207 "*************** Task\n"))
2208 ;; 3. Prefer degenerate form when there are no contents.
2209 (should (equal (org-test-parse-and-interpret
2210 "*************** Task\n*************** END")
2211 "*************** Task\n"))
2212 ;; 4. With TODO keywords.
2214 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2215 (org-test-parse-and-interpret "*************** TODO Task"))
2216 "*************** TODO Task\n"))
2219 ;; 5.1. ... and a positive `org-tags-column' value.
2221 (equal (let ((org-tags-column 30))
2222 (org-test-parse-and-interpret "*************** Task :tag:"))
2223 "*************** Task :tag:\n"))
2224 ;; 5.2. ... and a negative `org-tags-column' value.
2226 (equal (let ((org-tags-column -
30))
2227 (org-test-parse-and-interpret "*************** Task :tag:"))
2228 "*************** Task :tag:\n"))
2229 ;; 5.3. ... and a null `org-tags-column' value.
2231 (equal (let ((org-tags-column 0))
2232 (org-test-parse-and-interpret "*************** Task :tag:"))
2233 "*************** Task :tag:\n"))
2234 ;; 6. With priority cookie.
2236 (equal (org-test-parse-and-interpret "*************** [#B] Task")
2237 "*************** [#B] Task\n")))))
2239 (ert-deftest test-org-element
/plain-list-interpreter
()
2240 "Test plain-list and item interpreters."
2241 (let ((org-list-two-spaces-after-bullet-regexp nil
))
2243 (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
2244 ;; Description list.
2246 (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
2249 (equal (let ((org-plain-list-ordered-item-terminator t
))
2250 (org-test-parse-and-interpret "1. Item"))
2253 (equal (let ((org-plain-list-ordered-item-terminator ?\
)))
2254 (org-test-parse-and-interpret "1) Item"))
2256 ;; Ordered list with counter.
2258 (equal (let ((org-plain-list-ordered-item-terminator t
))
2259 (org-test-parse-and-interpret "1. [@5] Item"))
2261 ;; List with check-boxes.
2263 (equal (org-test-parse-and-interpret
2264 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
2265 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n"))
2266 ;; Item not starting with a paragraph.
2268 (equal (org-test-parse-and-interpret "-\n | a | b |")
2269 "- \n | a | b |\n"))
2270 ;; Special case: correctly handle "*" bullets.
2271 (should (org-test-parse-and-interpret " * item"))
2272 ;; Special case: correctly handle empty items.
2273 (should (org-test-parse-and-interpret "-"))))
2275 (ert-deftest test-org-element
/quote-block-interpreter
()
2276 "Test quote block interpreter."
2277 (should (equal (org-test-parse-and-interpret
2278 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
2279 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
2281 (ert-deftest test-org-element
/special-block-interpreter
()
2282 "Test special block interpreter."
2283 (should (equal (org-test-parse-and-interpret
2284 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
2285 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
2287 (ert-deftest test-org-element
/babel-call-interpreter
()
2288 "Test babel call interpreter."
2289 ;; 1. Without argument.
2290 (should (equal (org-test-parse-and-interpret "#+CALL: test()")
2291 "#+CALL: test()\n"))
2292 ;; 2. With argument.
2293 (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
2294 "#+CALL: test(x=2)\n"))
2295 ;; 3. With header arguments.
2296 (should (equal (org-test-parse-and-interpret
2297 "#+CALL: test[:results output]()[:results html]")
2298 "#+CALL: test[:results output]()[:results html]\n")))
2300 (ert-deftest test-org-element
/clock-interpreter
()
2301 "Test clock interpreter."
2305 "CLOCK: \\[2012-01-01 .* 00:01\\]"
2306 (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]")))
2310 "CLOCK: \\[2012-01-01 .* 00:01\\]--\\[2012-01-01 .* 00:02\\] => 0:01"
2311 (org-test-parse-and-interpret "
2312 CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))))
2314 (ert-deftest test-org-element
/comment-interpreter
()
2315 "Test comment interpreter."
2317 (should (equal (org-test-parse-and-interpret "# Comment") "# Comment\n"))
2319 (should (equal (org-test-parse-and-interpret " # Comment")
2321 ;; Preserve indentation.
2322 (should (equal (org-test-parse-and-interpret " # No blank\n# One blank")
2323 "# No blank\n# One blank\n")))
2325 (ert-deftest test-org-element
/comment-block-interpreter
()
2326 "Test comment block interpreter."
2327 (should (equal (org-test-parse-and-interpret
2328 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
2329 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n")))
2331 (ert-deftest test-org-element
/diary-sexp
()
2332 "Test diary-sexp interpreter."
2335 (org-test-parse-and-interpret
2336 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old")
2337 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old\n")))
2339 (ert-deftest test-org-element
/example-block-interpreter
()
2340 "Test example block interpreter."
2341 ;; Without switches.
2342 (should (equal (org-test-parse-and-interpret
2343 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
2344 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
2347 (equal (org-test-parse-and-interpret
2348 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
2349 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n"))
2350 ;; Preserve code escaping.
2352 (equal (org-test-parse-and-interpret
2353 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE")
2354 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE\n")))
2356 (ert-deftest test-org-element
/export-block-interpreter
()
2357 "Test export block interpreter."
2358 (should (equal (org-test-parse-and-interpret
2359 "#+BEGIN_HTML\nTest\n#+END_HTML")
2360 "#+BEGIN_HTML\nTest\n#+END_HTML\n")))
2362 (ert-deftest test-org-element
/fixed-width-interpreter
()
2363 "Test fixed width interpreter."
2365 (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
2366 ;; Preserve indentation.
2367 (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
2368 ": 2 blanks\n: 1 blank\n"))
2369 ;; Remove last newline character
2371 (equal (org-element-fixed-width-interpreter
2372 '(fixed-width (:value
"Test\n")) nil
)
2375 (equal (org-element-fixed-width-interpreter
2376 '(fixed-width (:value
"Test")) nil
)
2378 ;; Handle empty string.
2380 (equal (org-element-fixed-width-interpreter
2381 '(fixed-width (:value
"")) nil
)
2383 ;; Handle nil value.
2385 (org-element-fixed-width-interpreter
2386 '(fixed-width (:value nil
)) nil
)))
2388 (ert-deftest test-org-element
/horizontal-rule-interpreter
()
2389 "Test horizontal rule interpreter."
2390 (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
2392 (ert-deftest test-org-element
/keyword-interpreter
()
2393 "Test keyword interpreter."
2394 (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
2395 "#+KEYWORD: value\n")))
2397 (ert-deftest test-org-element
/latex-environment-interpreter
()
2398 "Test latex environment interpreter."
2399 (should (equal (org-test-parse-and-interpret
2400 "\\begin{equation}\n1+1=2\n\\end{equation}")
2401 "\\begin{equation}\n1+1=2\n\\end{equation}\n"))
2402 (should (equal (org-test-parse-and-interpret
2403 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}")
2404 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}\n")))
2406 (ert-deftest test-org-element
/planning-interpreter
()
2407 "Test planning interpreter."
2411 DEADLINE: <2012-03-29 .*?> SCHEDULED: <2012-03-29 .*?> CLOSED: \\[2012-03-29 .*?\\]"
2412 (org-test-parse-and-interpret
2414 DEADLINE: <2012-03-29 thu.> SCHEDULED: <2012-03-29 thu.> CLOSED: [2012-03-29 thu.]"))))
2416 (ert-deftest test-org-element
/property-drawer-interpreter
()
2417 "Test property drawer interpreter."
2418 (should (equal (let ((org-property-format "%-10s %s"))
2419 (org-test-parse-and-interpret
2420 ":PROPERTIES:\n:prop: value\n:END:"))
2421 ":PROPERTIES:\n:prop: value\n:END:\n")))
2423 (ert-deftest test-org-element
/src-block-interpreter
()
2424 "Test src block interpreter."
2427 (equal (let ((org-edit-src-content-indentation 2))
2428 (org-test-parse-and-interpret
2429 "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC"))
2430 "#+BEGIN_SRC emacs-lisp :results silent\n (+ 1 1)\n#+END_SRC\n"))
2433 (equal (let ((org-edit-src-content-indentation 2))
2434 (org-test-parse-and-interpret
2435 "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC"))
2436 "#+BEGIN_SRC emacs-lisp -n -k\n (+ 1 1)\n#+END_SRC\n"))
2437 ;; Preserve code escaping.
2439 (equal (let ((org-edit-src-content-indentation 2))
2440 (org-test-parse-and-interpret
2441 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC"))
2442 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC\n"))
2443 ;; Do not apply `org-edit-src-content-indentation' when preserving
2446 (equal (let ((org-edit-src-content-indentation 2)
2447 (org-src-preserve-indentation t
))
2448 (org-test-parse-and-interpret
2449 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"))
2450 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n"))
2452 (equal (let ((org-edit-src-content-indentation 2)
2453 (org-src-preserve-indentation nil
))
2454 (org-test-parse-and-interpret
2455 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"))
2456 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC\n")))
2458 (ert-deftest test-org-element
/table-interpreter
()
2459 "Test table, table-row and table-cell interpreters."
2461 (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
2462 "| a | b |\n| c | d |\n"))
2463 ;; 2. With horizontal rules.
2464 (should (equal (org-test-parse-and-interpret
2465 "| a | b |\n|---+---|\n| c | d |")
2466 "| a | b |\n|---+---|\n| c | d |\n"))
2467 ;; 3. With meta-data.
2468 (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
2469 "| / | < | > |\n| * | 1 | 2 |\n"))
2470 ;; 4. With a formula.
2472 (equal (org-test-parse-and-interpret
2473 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)")
2474 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)\n"))
2475 ;; 5. With multiple formulas.
2477 (equal (org-test-parse-and-interpret
2478 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2")
2479 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2\n")))
2481 (ert-deftest test-org-element
/timestamp-interpreter
()
2482 "Test timestamp interpreter."
2485 (string-match "<2012-03-29 .* 16:40>"
2486 (org-test-parse-and-interpret "<2012-03-29 thu. 16:40>")))
2488 (string-match "<2012-03-29 .* 16:40>"
2489 (org-element-timestamp-interpreter
2491 (:type active
:year-start
2012 :month-start
3 :day-start
29
2492 :hour-start
16 :minute-start
40)) nil
)))
2495 (string-match "\\[2012-03-29 .* 16:40\\]"
2496 (org-test-parse-and-interpret "[2012-03-29 thu. 16:40]")))
2499 "\\[2012-03-29 .* 16:40\\]"
2500 (org-element-timestamp-interpreter
2502 (:type inactive
:year-start
2012 :month-start
3 :day-start
29
2503 :hour-start
16 :minute-start
40)) nil
)))
2506 (string-match "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2507 (org-test-parse-and-interpret
2508 "<2012-03-29 thu. 16:40>--<2012-03-29 thu. 16:41>")))
2511 "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2512 (org-element-timestamp-interpreter
2514 (:type active-range
:year-start
2012 :month-start
3 :day-start
29
2515 :hour-start
16 :minute-start
40 :year-end
2012 :month-end
3
2516 :day-end
29 :hour-end
16 :minute-end
41)) nil
)))
2519 (string-match "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2520 (org-test-parse-and-interpret
2521 "[2012-03-29 thu. 16:40]--[2012-03-29 thu. 16:41]")))
2524 "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2525 (org-element-timestamp-interpreter
2527 (:type inactive-range
:year-start
2012 :month-start
3 :day-start
29
2528 :hour-start
16 :minute-start
40 :year-end
2012 :month-end
3
2529 :day-end
29 :hour-end
16 :minute-end
41)) nil
)))
2531 (should (equal (org-test-parse-and-interpret "<%%diary-float t 4 2>")
2532 "<%%diary-float t 4 2>\n"))
2533 ;; Timestamp with repeater interval, with delay, with both.
2535 (string-match "<2012-03-29 .* \\+1y>"
2536 (org-test-parse-and-interpret "<2012-03-29 thu. +1y>")))
2539 "<2012-03-29 .* \\+1y>"
2540 (org-element-timestamp-interpreter
2542 (:type active
:year-start
2012 :month-start
3 :day-start
29
2543 :repeater-type cumulate
:repeater-value
1 :repeater-unit year
))
2547 "<2012-03-29 .* -1y>"
2548 (org-element-timestamp-interpreter
2550 (:type active
:year-start
2012 :month-start
3 :day-start
29
2551 :warning-type all
:warning-value
1 :warning-unit year
))
2555 "<2012-03-29 .* \\+1y -1y>"
2556 (org-element-timestamp-interpreter
2558 (:type active
:year-start
2012 :month-start
3 :day-start
29
2559 :warning-type all
:warning-value
1 :warning-unit year
2560 :repeater-type cumulate
:repeater-value
1 :repeater-unit year
))
2562 ;; Timestamp range with repeater interval
2564 (string-match "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2565 (org-test-parse-and-interpret
2566 "<2012-03-29 Thu +1y>--<2012-03-30 Thu +1y>")))
2569 "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2570 (org-element-timestamp-interpreter
2572 (:type active-range
:year-start
2012 :month-start
3 :day-start
29
2573 :year-end
2012 :month-end
3 :day-end
30 :repeater-type cumulate
2574 :repeater-value
1 :repeater-unit year
))
2577 (ert-deftest test-org-element
/verse-block-interpreter
()
2578 "Test verse block interpretation."
2580 (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
2581 "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
2583 (ert-deftest test-org-element
/bold-interpreter
()
2584 "Test bold interpreter."
2585 (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
2587 (ert-deftest test-org-element
/code-interpreter
()
2588 "Test code interpreter."
2589 (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
2591 (ert-deftest test-org-element
/entity-interpreter
()
2592 "Test entity interpreter."
2593 ;; 1. Without brackets.
2595 (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
2596 ;; 2. With brackets.
2598 (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
2600 (ert-deftest test-org-element
/export-snippet-interpreter
()
2601 "Test export snippet interpreter."
2602 (should (equal (org-test-parse-and-interpret "@@back-end:contents@@")
2603 "@@back-end:contents@@\n")))
2605 (ert-deftest test-org-element
/footnote-reference-interpreter
()
2606 "Test footnote reference interpreter."
2607 ;; 1. Regular reference.
2608 (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
2609 ;; 2. Normalized reference.
2610 (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
2611 ;; 3. Named reference.
2612 (should (equal (org-test-parse-and-interpret "Text[fn:label]")
2613 "Text[fn:label]\n"))
2614 ;; 4. Inline reference.
2615 (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
2616 "Text[fn:label:def]\n"))
2617 ;; 5. Anonymous reference.
2618 (should (equal (org-test-parse-and-interpret "Text[fn::def]")
2619 "Text[fn::def]\n")))
2621 (ert-deftest test-org-element
/inline-babel-call-interpreter
()
2622 "Test inline babel call interpreter."
2623 ;; 1. Without arguments.
2624 (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
2625 ;; 2. With arguments.
2626 (should (equal (org-test-parse-and-interpret "call_test(x=2)")
2627 "call_test(x=2)\n"))
2628 ;; 3. With header arguments.
2629 (should (equal (org-test-parse-and-interpret
2630 "call_test[:results output]()[:results html]")
2631 "call_test[:results output]()[:results html]\n")))
2633 (ert-deftest test-org-element
/inline-src-block-interpreter
()
2634 "Test inline src block interpreter."
2635 ;; 1. Without header argument.
2636 (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
2637 "src_emacs-lisp{(+ 1 1)}\n"))
2638 ;; 2. With header arguments.
2639 (should (equal (org-test-parse-and-interpret
2640 "src_emacs-lisp[:results silent]{(+ 1 1)}")
2641 "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
2643 (ert-deftest test-org-element
/italic-interpreter
()
2644 "Test italic interpreter."
2645 (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
2647 (ert-deftest test-org-element
/latex-fragment-interpreter
()
2648 "Test latex fragment interpreter."
2649 (should (equal (org-test-parse-and-interpret "\\command{}") "\\command{}\n"))
2650 (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
2651 (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
2652 (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
2653 (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
2654 (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n")))
2656 (ert-deftest test-org-element
/line-break-interpreter
()
2657 "Test line break interpreter."
2658 (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
2659 "First line \\\\\nSecond line\n")))
2661 (ert-deftest test-org-element
/link-interpreter
()
2662 "Test link interpreter."
2663 ;; 1. Links targeted from a radio target.
2664 (should (equal (let ((org-target-link-regexp "radio-target"))
2665 (org-test-parse-and-interpret "a radio-target"))
2666 "a radio-target\n"))
2667 ;; 2. Regular links.
2669 ;; 2.1. Without description.
2670 (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
2671 "[[http://orgmode.org]]\n"))
2672 ;; 2.2. With a description.
2673 (should (equal (org-test-parse-and-interpret
2674 "[[http://orgmode.org][Org mode]]")
2675 "[[http://orgmode.org][Org mode]]\n"))
2677 (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
2678 ;; 2.4. Custom-id links.
2679 (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
2680 ;; 2.5 Code-ref links.
2681 (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
2682 ;; 3. Normalize plain links.
2683 (should (equal (org-test-parse-and-interpret "http://orgmode.org")
2684 "[[http://orgmode.org]]\n"))
2685 ;; 4. Normalize angular links.
2686 (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
2687 "[[http://orgmode.org]]\n")))
2689 (ert-deftest test-org-element
/macro-interpreter
()
2690 "Test macro interpreter."
2691 ;; 1. Without argument.
2692 (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
2693 ;; 2. With arguments.
2694 (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
2695 "{{{test(arg1,arg2)}}}\n")))
2697 (ert-deftest test-org-element
/radio-target-interpreter
()
2698 "Test radio target interpreter."
2699 (should (equal (org-test-parse-and-interpret "<<<some text>>>")
2700 "<<<some text>>>\n")))
2702 (ert-deftest test-org-element
/statistics-cookie-interpreter
()
2703 "Test statistics cookie interpreter."
2704 ;; 1. Without percent
2705 (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
2707 (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
2709 (ert-deftest test-org-element
/strike-through-interpreter
()
2710 "Test strike through interpreter."
2711 (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
2713 (ert-deftest test-org-element
/subscript-interpreter
()
2714 "Test subscript interpreter."
2715 ;; 1. Without brackets.
2716 (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
2717 ;; 2. With brackets.
2718 (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
2720 (ert-deftest test-org-element
/superscript-interpreter
()
2721 "Test superscript interpreter."
2722 ;; 1. Without brackets.
2723 (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
2724 ;; 2. With brackets.
2725 (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
2727 (ert-deftest test-org-element
/target-interpreter
()
2728 "Test target interpreter."
2729 (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
2731 (ert-deftest test-org-element
/underline-interpreter
()
2732 "Test underline interpreter."
2733 (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
2735 (ert-deftest test-org-element
/verbatim-interpreter
()
2736 "Test verbatim interpreter."
2737 (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
2741 ;;; Test Granularity
2743 (ert-deftest test-org-element
/granularity
()
2744 "Test granularity impact on buffer parsing."
2745 (org-test-with-temp-text "
2752 ;; 1.1. Granularity set to `headline' should parse every headline
2753 ;; in buffer, and only them.
2754 (let ((tree (org-element-parse-buffer 'headline
)))
2755 (should (= 2 (length (org-element-map tree
'headline
'identity
))))
2756 (should-not (org-element-map tree
'paragraph
'identity
)))
2757 ;; 1.2. Granularity set to `greater-element' should not enter
2758 ;; greater elements excepted headlines and sections.
2759 (let ((tree (org-element-parse-buffer 'greater-element
)))
2760 (should (= 1 (length (org-element-map tree
'center-block
'identity
))))
2761 (should (= 1 (length (org-element-map tree
'paragraph
'identity
))))
2762 (should-not (org-element-map tree
'entity
'identity
)))
2763 ;; 1.3. Granularity set to `element' should enter every
2765 (let ((tree (org-element-parse-buffer 'element
)))
2766 (should (= 2 (length (org-element-map tree
'paragraph
'identity
))))
2767 (should-not (org-element-map tree
'entity
'identity
)))
2768 ;; 1.4. Granularity set to `object' can see everything.
2769 (let ((tree (org-element-parse-buffer 'object
)))
2770 (should (= 1 (length (org-element-map tree
'entity
'identity
)))))))
2772 (ert-deftest test-org-element
/secondary-string-parsing
()
2773 "Test if granularity correctly toggles secondary strings parsing."
2774 ;; 1. With a granularity bigger than `object', no secondary string
2775 ;; should be parsed.
2777 ;; 1.1. Test with `headline' type.
2778 (org-test-with-temp-text "* Headline"
2780 (org-element-map (org-element-parse-buffer 'headline
) 'headline
2784 (should (stringp (org-element-property :title headline
)))))
2785 ;; 1.2. Test with `item' type.
2786 (org-test-with-temp-text "* Headline\n- tag :: item"
2787 (let ((item (org-element-map (org-element-parse-buffer 'element
)
2792 (should (stringp (org-element-property :tag item
)))))
2793 ;; 1.3. Test with `inlinetask' type, if avalaible.
2794 (when (featurep 'org-inlinetask
)
2795 (let ((org-inlinetask-min-level 15))
2796 (org-test-with-temp-text "*************** Inlinetask"
2797 (let ((inlinetask (org-element-map (org-element-parse-buffer 'element
)
2802 (should (stringp (org-element-property :title inlinetask
)))))))
2803 ;; 2. With a default granularity, secondary strings should be
2805 (org-test-with-temp-text "* Headline"
2807 (org-element-map (org-element-parse-buffer) 'headline
2811 (should (listp (org-element-property :title headline
)))))
2812 ;; 3. `org-element-at-point' should never parse a secondary string.
2813 (org-test-with-temp-text "* Headline"
2814 (should (stringp (org-element-property :title
(org-element-at-point))))))
2818 ;;; Test Visible Only Parsing
2820 (ert-deftest test-org-element
/parse-buffer-visible
()
2821 "Test `org-element-parse-buffer' with visible only argument."
2823 (equal '("H1" "H3" "H5")
2824 (org-test-with-temp-text
2825 "* H1\n** H2\n** H3 :visible:\n** H4\n** H5 :visible:"
2826 (org-occur ":visible:")
2827 (org-element-map (org-element-parse-buffer nil t
) 'headline
2828 (lambda (hl) (org-element-property :raw-value hl
)))))))
2832 ;;; Test `:parent' Property
2834 (ert-deftest test-org-element
/parent-property
()
2835 "Test `:parent' property."
2837 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
2838 (let* ((tree (org-element-parse-buffer))
2839 (parent (org-element-property
2841 (org-element-map tree
'paragraph
'identity nil t
))))
2843 (should (eq (org-element-map tree
'center-block
'identity nil t
)
2846 (org-test-with-temp-text "a_{/b/}"
2847 (let* ((tree (org-element-parse-buffer))
2848 (parent (org-element-property
2850 (org-element-map tree
'italic
'identity nil t
))))
2853 (org-element-map tree
'subscript
'identity nil t
)))))
2854 ;; Secondary strings
2855 (org-test-with-temp-text "* /italic/"
2856 (let* ((tree (org-element-parse-buffer))
2857 (parent (org-element-property
2858 :parent
(org-element-map tree
'italic
'identity nil t
))))
2861 (org-element-map tree
'headline
'identity nil t
))))))
2865 ;;; Test Normalize Contents
2867 (ert-deftest test-org-element
/normalize-contents
()
2868 "Test `org-element-normalize-contents' specifications."
2869 ;; Remove maximum common indentation from element's contents.
2872 (org-element-normalize-contents
2873 '(paragraph nil
" Two spaces\n Three spaces"))
2874 '(paragraph nil
"Two spaces\n Three spaces")))
2875 ;; Ignore objects within contents when computing maximum common
2879 (org-element-normalize-contents
2880 '(paragraph nil
" One " (emphasis nil
"space") "\n Two spaces"))
2881 '(paragraph nil
"One " (emphasis nil
"space") "\n Two spaces")))
2882 ;; Ignore blank lines.
2885 (org-element-normalize-contents
2886 '(paragraph nil
" Two spaces\n\n \n Two spaces"))
2887 '(paragraph nil
"Two spaces\n\n \nTwo spaces")))
2890 '(paragraph nil
" Two spaces\n" (verbatim nil
"V") "\n Two spaces")
2891 (org-element-normalize-contents
2892 '(paragraph nil
" Two spaces\n " (verbatim nil
"V") "\n Two spaces"))))
2893 ;; Recursively enter objects in order to compute common indentation.
2896 (org-element-normalize-contents
2897 '(paragraph nil
" Two spaces " (bold nil
" and\n One space")))
2898 '(paragraph nil
" Two spaces " (bold nil
" and\nOne space"))))
2899 ;; When optional argument is provided, ignore first line
2903 (org-element-normalize-contents
2904 '(paragraph nil
"No space\n Two spaces\n Three spaces") t
)
2905 '(paragraph nil
"No space\nTwo spaces\n Three spaces"))))
2909 ;;; Test Navigation Tools.
2911 (ert-deftest test-org-element
/at-point
()
2912 "Test `org-element-at-point' specifications."
2913 ;; Return closest element containing point.
2916 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
2917 (progn (search-forward "A")
2918 (org-element-type (org-element-at-point))))))
2919 ;; Correctly set `:parent' property.
2922 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
2923 (progn (search-forward "A")
2925 (org-element-property :parent
(org-element-at-point)))))))
2926 ;; Special case: at a blank line just below a headline, return that
2929 (equal "H1" (org-test-with-temp-text "* H1\n \n* H2\n"
2931 (org-element-property :title
(org-element-at-point)))))
2932 ;; Special case: at the very beginning of a table, return `table'
2933 ;; object instead of `table-row'.
2936 (org-test-with-temp-text "| a | b |"
2937 (org-element-type (org-element-at-point)))))
2938 ;; Special case: at the very beginning of a list or sub-list, return
2939 ;; `plain-list' object instead of `item'.
2942 (org-test-with-temp-text "- item"
2943 (org-element-type (org-element-at-point)))))
2944 ;; Special case: at the closing line of a greater element, be sure
2945 ;; to return it instead of the last element in its contents.
2948 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph\n#+END_CENTER"
2949 (progn (forward-line 2)
2950 (org-element-type (org-element-at-point))))))
2951 ;; Special case: at a blank line between two items, be sure to
2952 ;; return item above instead of the last element of its contents.
2955 (org-test-with-temp-text "- Para1\n\n- Para2"
2956 (progn (forward-line)
2958 (let ((org-list-empty-line-terminates-plain-lists nil
))
2959 (org-element-at-point)))))))
2960 ;; Special case: at the last blank line in a plain list, return it
2961 ;; instead of the last item.
2964 (org-test-with-temp-text "- Para1\n- Para2\n\nPara3"
2965 (progn (forward-line 2)
2966 (org-element-type (org-element-at-point))))))
2967 ;; Special case: when a list ends at the end of buffer and there's
2968 ;; no final newline, return last element in last item.
2971 (org-test-with-temp-text "- a"
2973 (org-element-type (org-element-at-point)))))
2974 ;; Parse a list within a block itself contained in a list.
2977 (org-test-with-temp-text
2978 "- outer\n #+begin_center\n - inner\n #+end_center"
2979 (search-forward "inner")
2981 (org-element-type (org-element-at-point)))))
2982 ;; Do not error at eob on an empty line.
2984 (org-test-with-temp-text "* H\n"
2986 (or (org-element-at-point) t
))))
2988 (ert-deftest test-org-element
/context
()
2989 "Test `org-element-context' specifications."
2990 ;; Return closest object containing point.
2993 (org-test-with-temp-text "Some *text with _underline_ text*"
2994 (progn (search-forward "under")
2995 (org-element-type (org-element-context))))))
2996 ;; Find objects in secondary strings.
2999 (org-test-with-temp-text "* Headline _with_ underlining"
3000 (progn (search-forward "w")
3001 (org-element-type (org-element-context))))))
3002 ;; Find objects in objects.
3005 (org-test-with-temp-text "| a | {{{macro}}} |"
3006 (progn (search-forward "{")
3007 (org-element-type (org-element-context))))))
3010 (org-test-with-temp-text "| a | b {{{macro}}} |"
3011 (progn (search-forward "b")
3012 (org-element-type (org-element-context))))))
3013 ;; Find objects in planning lines.
3016 (org-test-with-temp-text "* H\n SCHEDULED: <2012-03-29 thu.>"
3017 (search-forward "2012")
3018 (org-element-type (org-element-context)))))
3021 (org-test-with-temp-text "* H\n SCHEDULED: <2012-03-29 thu.>"
3022 (search-forward "SCHEDULED")
3023 (org-element-type (org-element-context)))))
3024 ;; Find objects in document keywords.
3027 (org-test-with-temp-text "#+DATE: {{{macro}}}"
3028 (progn (search-forward "{")
3029 (org-element-type (org-element-context))))))
3030 ;; Do not find objects in table rules.
3033 (org-test-with-temp-text "| a | b |\n+---+---+\n| c | d |"
3035 (org-element-type (org-element-context)))))
3036 ;; Find objects in parsed affiliated keywords.
3039 (org-test-with-temp-text "#+CAPTION: {{{macro}}}\n| a | b |."
3040 (progn (search-forward "{")
3041 (org-element-type (org-element-context))))))
3044 (org-test-with-temp-text "#+caption: *bold*\nParagraph"
3045 (progn (search-forward "*")
3046 (org-element-type (org-element-context))))))
3047 ;; Find objects at the end of buffer.
3050 (org-test-with-temp-text "*bold*"
3051 (goto-char (point-max))
3052 (org-element-type (org-element-context)))))
3053 ;; Correctly set `:parent' property.
3056 (org-test-with-temp-text "Some *bold* text"
3057 (progn (search-forward "bold")
3059 (org-element-property :parent
(org-element-context)))))))
3060 ;; Between two objects, return the second one.
3063 (org-test-with-temp-text "<<target>>{{{test}}}"
3064 (progn (search-forward "{")
3066 (org-element-type (org-element-context))))))
3067 ;; Test optional argument.
3070 (org-test-with-temp-text "Some *text with _underline_ text*"
3072 (search-forward "under")
3073 (org-element-type (org-element-context (org-element-at-point)))))))
3074 ;; Special case: bold object at the beginning of a headline.
3077 (org-test-with-temp-text "* *bold*"
3078 (search-forward "bo")
3079 (org-element-type (org-element-context))))))
3085 (ert-deftest test-org-element
/cache
()
3086 "Test basic expectations and common pitfalls for cache."
3090 (org-test-with-temp-text "para1\n\npara2\n\npara3"
3091 (let ((org-element-use-cache t
))
3092 (save-excursion (goto-char (point-max)) (org-element-at-point))
3095 (let ((element (org-element-at-point)))
3096 (cons (org-element-property :begin element
)
3097 (org-element-property :end element
)))))))
3098 ;; Partial shifting: when the contents of a greater element are
3099 ;; modified, only shift ending positions.
3101 (org-test-with-temp-text
3102 "#+BEGIN_CENTER\nPara1\n\nPara2\n\nPara3\n#+END_CENTER"
3103 (let ((org-element-use-cache t
))
3104 (save-excursion (search-forward "3") (org-element-at-point))
3105 (search-forward "Para2")
3107 (let ((element (org-element-property :parent
(org-element-at-point))))
3108 (equal (cons (org-element-property :begin element
)
3109 (org-element-property :end element
))
3110 (cons (point-min) (point-max)))))))
3111 ;; Re-parent shifted elements.
3114 (org-test-with-temp-text "- item\n\n\n para1\n para2"
3115 (let ((org-element-use-cache t
))
3117 (org-element-at-point)
3118 (save-excursion (goto-char (point-max)) (org-element-at-point))
3121 (goto-char (point-max))
3123 (org-element-property :parent
(org-element-at-point)))))))
3124 ;; Modifying the last line of an element alters the element below.
3126 (org-test-with-temp-text "para1\n\npara2"
3127 (let ((org-element-use-cache t
))
3128 (goto-char (point-max))
3129 (org-element-at-point)
3132 (let ((element (org-element-at-point)))
3133 (equal (cons (org-element-property :begin element
)
3134 (org-element-property :end element
))
3135 (cons (point-min) (point-max)))))))
3136 ;; Modifying the first line of an element alters the element above.
3138 (org-test-with-temp-text ": fixed-width\n:not-fixed-width"
3139 (let ((org-element-use-cache t
))
3140 (goto-char (point-max))
3141 (org-element-at-point)
3142 (search-backward ":")
3145 (let ((element (org-element-at-point)))
3146 (equal (cons (org-element-property :begin element
)
3147 (org-element-property :end element
))
3148 (cons (point-min) (point-max)))))))
3149 ;; Sensitive change: adding a line alters document structure both
3153 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n"
3154 (let ((org-element-use-cache t
))
3155 (goto-char (point-max))
3156 (org-element-at-point)
3157 (insert "#+END_EXAMPLE")
3158 (search-backward "Para1")
3159 (org-element-type (org-element-at-point))))))
3162 (org-test-with-temp-text "Para1\n\nPara2\n#+END_EXAMPLE"
3163 (let ((org-element-use-cache t
))
3164 (save-excursion (goto-char (point-max)) (org-element-at-point))
3165 (insert "#+BEGIN_EXAMPLE\n")
3166 (search-forward "Para2")
3167 (org-element-type (org-element-at-point))))))
3168 ;; Sensitive change: removing a line alters document structure both
3172 (org-test-with-temp-text
3173 "# +BEGIN_EXAMPLE\nPara1\n\nPara2\n#+END_EXAMPLE"
3174 (let ((org-element-use-cache t
))
3175 (save-excursion (goto-char (point-max)) (org-element-at-point))
3178 (search-forward "Para2")
3179 (org-element-type (org-element-at-point))))))
3182 (org-test-with-temp-text
3183 "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n# +END_EXAMPLE"
3184 (let ((org-element-use-cache t
))
3185 (save-excursion (goto-char (point-max)) (org-element-at-point))
3186 (search-forward "# ")
3188 (search-backward "Para1")
3189 (org-element-type (org-element-at-point)))))))
3192 (provide 'test-org-element
)
3194 ;;; test-org-element.el ends here