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
)))))))
1431 ;; ... `:path' in a file-type link must be compatible with "file"
1432 ;; scheme in URI syntax, even if Org syntax isn't.
1434 (org-test-with-temp-text-in-file ""
1435 (let ((file (expand-file-name (buffer-file-name))))
1436 (insert (format "[[file://%s]]" file
))
1437 (equal (org-element-property :path
(org-element-context))
1438 (concat "//" file
)))))
1440 (org-test-with-temp-text-in-file ""
1441 (let ((file (expand-file-name (buffer-file-name))))
1442 (insert (format "[[file:%s]]" file
))
1443 (equal (org-element-property :path
(org-element-context))
1444 (concat "//" file
)))))
1446 (org-test-with-temp-text-in-file ""
1447 (let ((file (file-relative-name (buffer-file-name))))
1448 (insert (format "[[file:%s]]" file
))
1449 (list (org-element-property :path
(org-element-context)) file
))))
1452 (org-test-with-temp-text "A link: http://orgmode.org"
1453 (org-element-map (org-element-parse-buffer) 'link
'identity
)))
1456 (org-test-with-temp-text "A link: <http://orgmode.org>"
1457 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))
1458 ;; Link abbreviation.
1461 (org-test-with-temp-text
1462 "#+LINK: orgmode http://www.orgmode.org/\n[[orgmode:#docs]]"
1463 (progn (org-mode-restart)
1464 (goto-char (1- (point-max)))
1465 (org-element-property :type
(org-element-context))))))
1466 ;; Link abbreviation in a secondary string.
1469 (org-test-with-temp-text
1470 "#+LINK: orgmode http://www.orgmode.org/\n* H [[orgmode:#docs]]"
1471 (progn (org-mode-restart)
1472 (org-element-map (org-element-parse-buffer) 'link
1473 (lambda (link) (org-element-property :type link
))
1475 ;; Plain links are allowed as description of regular links.
1478 (org-test-with-temp-text "[[http://orgmode.org][file:unicorn.jpg]]"
1479 (search-forward "file:")
1480 (org-element-property :type
(org-element-context))))))
1485 (ert-deftest test-org-element
/macro-parser
()
1486 "Test `macro' parser."
1487 ;; Without arguments.
1489 (org-test-with-temp-text "{{{macro}}}"
1490 (org-element-map (org-element-parse-buffer) 'macro
'identity
)))
1493 (org-test-with-temp-text "{{{macro(arg1,arg2)}}}"
1494 (org-element-map (org-element-parse-buffer) 'macro
'identity
)))
1495 ;; Properly handle protected commas in arguments...
1499 (org-test-with-temp-text "{{{macro(arg1\\,arg1,arg2)}}}"
1500 (org-element-property :args
(org-element-context))))))
1501 ;; ... even when last argument ends with a protected comma.
1504 (org-test-with-temp-text "{{{macro(C-\\,)}}}"
1505 (org-element-property :args
(org-element-context)))))
1506 ;; Allow to escape escaping character.
1509 (org-test-with-temp-text "{{{macro(C-\\\\,)}}}"
1510 (org-element-property :args
(org-element-context)))))
1511 ;; No need to escape backslashes elsewhere.
1514 (org-test-with-temp-text "{{{macro(\\)}}}"
1515 (org-element-property :args
(org-element-context))))))
1520 (ert-deftest test-org-element
/node-property
()
1521 "Test `node-property' parser."
1524 (equal '("abc" "value")
1525 (org-test-with-temp-text ":PROPERTIES:\n:abc: value\n:END:"
1526 (progn (forward-line)
1527 (let ((element (org-element-at-point)))
1528 (list (org-element-property :key element
)
1529 (org-element-property :value element
)))))))
1530 ;; Value should be trimmed.
1533 (org-test-with-temp-text ":PROPERTIES:\n:abc: value \n:END:"
1534 (progn (forward-line)
1535 (let ((element (org-element-at-point)))
1536 (org-element-property :value element
))))))
1537 ;; A node property requires to be wrapped within a property drawer.
1540 (org-test-with-temp-text ":abc: value"
1541 (org-element-type (org-element-at-point))))))
1546 (ert-deftest test-org-element
/paragraph-parser
()
1547 "Test `paragraph' parser."
1550 (org-test-with-temp-text "Paragraph"
1551 (org-element-map (org-element-parse-buffer) 'paragraph
'identity nil t
)))
1552 ;; Property find end of a paragraph stuck to another element.
1555 (org-test-with-temp-text "Paragraph\n# Comment"
1556 (org-element-map (org-element-parse-buffer) 'paragraph
1557 (lambda (p) (char-after (org-element-property :end p
)))
1559 ;; Include ill-formed Keywords.
1561 (org-test-with-temp-text "#+wrong_keyword something"
1562 (org-element-map (org-element-parse-buffer) 'paragraph
'identity
)))
1563 ;; Include incomplete-drawers.
1565 (org-test-with-temp-text ":TEST:\nParagraph"
1566 (let ((elem (org-element-at-point)))
1567 (and (eq (org-element-type elem
) 'paragraph
)
1568 (= (point-max) (org-element-property :end elem
))))))
1569 ;; Include incomplete blocks.
1571 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph"
1572 (let ((elem (org-element-at-point)))
1573 (and (eq (org-element-type elem
) 'paragraph
)
1574 (= (point-max) (org-element-property :end elem
))))))
1575 ;; Include incomplete dynamic blocks.
1577 (org-test-with-temp-text "#+BEGIN: \nParagraph"
1578 (let ((elem (org-element-at-point)))
1579 (and (eq (org-element-type elem
) 'paragraph
)
1580 (= (point-max) (org-element-property :end elem
))))))
1581 ;; Include incomplete latex environments.
1583 (org-test-with-temp-text "\begin{equation}\nParagraph"
1584 (let ((elem (org-element-at-point)))
1585 (and (eq (org-element-type elem
) 'paragraph
)
1586 (= (point-max) (org-element-property :end elem
))))))
1587 ;; Do not steal affiliated keywords from container.
1589 (org-test-with-temp-text "#+ATTR_LATEX: test\n- item 1"
1590 (let ((elem (progn (search-forward "item") (org-element-at-point))))
1591 (and (eq (org-element-type elem
) 'paragraph
)
1592 (not (org-element-property :attr_latex elem
))
1593 (/= (org-element-property :begin elem
) 1)))))
1594 ;; Handle non-empty blank line at the end of buffer.
1596 (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
1597 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1602 (ert-deftest test-org-element
/plain-list-parser
()
1603 "Test `plain-list' parser."
1604 (org-test-with-temp-text "- item"
1605 (should (org-element-map (org-element-parse-buffer) 'plain-list
'identity
)))
1606 ;; Blank lines after the list only belong to outer plain list.
1610 (org-test-with-temp-text "
1615 (let ((endings (org-element-map (org-element-parse-buffer) 'plain-list
1616 (lambda (pl) (org-element-property :end pl
)))))
1618 ;; Move to ending of outer list.
1619 (progn (goto-char (car endings
)) (looking-at "Outside list"))
1620 ;; Move to ending of inner list.
1621 (progn (goto-char (nth 1 endings
)) (looking-at "^$")))))))
1622 ;; Correctly compute end of list if it doesn't end at a line
1625 (org-test-with-temp-text "- list\n \n "
1626 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1631 (ert-deftest test-org-element
/planning-parser
()
1632 "Test `planning' parser."
1634 (equal "[2012-03-29 thu.]"
1635 (org-element-property
1637 (org-element-property
1639 (org-test-with-temp-text "CLOSED: [2012-03-29 thu.]"
1640 (org-element-at-point))))))
1642 (equal "<2012-03-29 thu.>"
1643 (org-element-property
1645 (org-element-property
1647 (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>"
1648 (org-element-at-point))))))
1650 (equal "<2012-03-29 thu.>"
1651 (org-element-property
1653 (org-element-property
1655 (org-test-with-temp-text "SCHEDULED: <2012-03-29 thu.>"
1656 (org-element-at-point)))))))
1659 ;;;; Property Drawer
1661 (ert-deftest test-org-element
/property-drawer-parser
()
1662 "Test `property-drawer' parser."
1665 (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
1667 (org-element-parse-buffer) 'property-drawer
'identity nil t
)))
1668 ;; Do not mix property drawers and regular drawers.
1670 (org-test-with-temp-text ":TEST:\n:prop: value\n:END:"
1672 (org-element-parse-buffer) 'property-drawer
'identity nil t
)))
1673 ;; Ignore incomplete drawer.
1675 (org-test-with-temp-text ":PROPERTIES:\n:prop: value"
1677 (org-element-parse-buffer) 'property-drawer
'identity nil t
)))
1678 ;; Handle non-empty blank line at the end of buffer.
1680 (org-test-with-temp-text ":PROPERTIES:\n:END:\n "
1681 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1686 (ert-deftest test-org-element
/quote-block-parser
()
1687 "Test `quote-block' parser."
1690 (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
1691 (org-element-map (org-element-parse-buffer) 'quote-block
'identity
)))
1692 ;; Ignore incomplete block.
1694 (org-test-with-temp-text "#+BEGIN_QUOTE"
1695 (org-element-map (org-element-parse-buffer) 'quote-block
'identity nil t
)))
1696 ;; Handle non-empty blank line at the end of buffer.
1698 (org-test-with-temp-text "#+BEGIN_QUOTE\nC\n#+END_QUOTE\n "
1699 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1704 (ert-deftest test-org-element
/radio-target-parser
()
1705 "Test `radio-target' parser."
1709 (org-test-with-temp-text "<<<radio>>>"
1710 (org-element-type (org-element-context)))))
1711 ;; Radio targets with objects.
1714 (org-test-with-temp-text "<<<radio \\alpha>>>"
1715 (org-element-type (org-element-context)))))
1716 ;; Radio targets starting with an object.
1719 (org-test-with-temp-text "<<<\\alpha radio>>>"
1720 (org-element-type (org-element-context)))))
1721 ;; Radio targets cannot begin or end with white space.
1724 (org-test-with-temp-text "<<< radio>>>"
1725 (org-element-type (org-element-context)))))
1728 (org-test-with-temp-text "<<<radio >>>"
1729 (org-element-type (org-element-context))))))
1734 (ert-deftest test-org-element
/section-parser
()
1735 "Test `section' parser."
1738 (org-test-with-temp-text "* Headline\nText"
1739 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
1740 ;; There's a section before the first headline.
1742 (org-test-with-temp-text "Text"
1743 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
1744 ;; A section cannot be empty.
1746 (org-test-with-temp-text "* Headline 1\n* Headline 2"
1747 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
1748 ;; A section doesn't contain sub-trees.
1750 (org-test-with-temp-text "* Head\nText\n** Sub-Head"
1752 (org-element-map (org-element-parse-buffer) 'section
'identity nil t
)
1753 'headline
'identity
))))
1758 (ert-deftest test-org-element
/special-block-parser
()
1759 "Test `special-block' parser."
1763 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1764 (org-element-property :type
(org-element-at-point)))))
1765 ;; Special blocks can contain paragraphs.
1768 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1770 (org-element-type (org-element-at-point)))))
1771 ;; Ignore incomplete block.
1774 (org-test-with-temp-text "#+BEGIN_SPECIAL"
1775 (org-element-type (org-element-at-point)))))
1776 ;; Allow special characters in type.
1778 (equal '(special-block "SPECIAL*")
1779 (org-test-with-temp-text "#+BEGIN_SPECIAL*\nContents\n#+END_SPECIAL*"
1780 (let ((element (org-element-at-point)))
1781 (list (org-element-type element
)
1782 (org-element-property :type element
))))))
1783 ;; Handle non-empty blank line at the end of buffer.
1785 (org-test-with-temp-text "#+BEGIN_SPECIAL\nC\n#+END_SPECIAL\n "
1786 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1791 (ert-deftest test-org-element
/src-block-parser
()
1792 "Test `src-block' parser."
1795 (org-test-with-temp-text "#+BEGIN_SRC org\nText\n#+END_SRC"
1796 (org-element-map (org-element-parse-buffer) 'src-block
'identity
)))
1797 ;; Ignore incomplete block.
1799 (org-test-with-temp-text "#+BEGIN_SRC"
1800 (org-element-map (org-element-parse-buffer) 'src-block
'identity
)))
1801 ;; Properly un-escape code.
1803 (equal "* Headline\n #+keyword\nText\n"
1804 (org-test-with-temp-text
1805 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText\n#+END_SRC"
1806 (org-element-property :value
(org-element-at-point)))))
1807 ;; Remove block indentation according to block boundaries, unless
1808 ;; block contents are less indented than block boundaries.
1811 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
1812 (let ((org-src-preserve-indentation t
))
1813 (org-element-property :value
(org-element-at-point))))))
1817 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
1818 (let ((org-src-preserve-indentation t
))
1819 (org-element-property :value
(org-element-at-point))))))
1820 ;; Handle non-empty blank line at the end of buffer.
1822 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\nC\n#+END_SRC\n "
1823 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1826 ;;;; Statistics Cookie
1828 (ert-deftest test-org-element
/statistics-cookie
()
1829 "Test `statistics-cookie' parser."
1832 (org-test-with-temp-text "[1/2]"
1833 (org-element-map (org-element-parse-buffer) 'statistics-cookie
'identity
)))
1836 (org-test-with-temp-text "[33%]"
1838 (org-element-parse-buffer) 'statistics-cookie
'identity
))))
1843 (ert-deftest test-org-element
/strike-through-parser
()
1844 "Test `strike-through' parser."
1847 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1848 (org-test-with-temp-text "+strike-through+"
1849 (org-element-map (org-element-parse-buffer) 'strike-through
'identity
))))
1850 ;; Multi-line markup.
1853 (org-element-contents
1854 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1855 (org-test-with-temp-text "+first line\nsecond line+"
1857 (org-element-parse-buffer) 'strike-through
'identity nil t
))))
1858 '("first line\nsecond line"))))
1863 (ert-deftest test-org-element
/subscript-parser
()
1864 "Test `subscript' parser."
1867 (org-test-with-temp-text "a_b"
1868 (org-element-map (org-element-parse-buffer) 'subscript
'identity
)))
1871 (org-test-with-temp-text "a_{b}"
1872 (org-element-map (org-element-parse-buffer) 'subscript
'identity
)))
1873 ;; Multiple subscripts in a paragraph.
1876 (org-test-with-temp-text "a_b and c_d"
1878 (org-element-map (org-element-parse-buffer) 'subscript
'identity
))))))
1883 (ert-deftest test-org-element
/superscript-parser
()
1884 "Test `superscript' parser."
1887 (org-test-with-temp-text "a^b"
1888 (org-element-map (org-element-parse-buffer) 'superscript
'identity
)))
1891 (org-test-with-temp-text "a^{b}"
1892 (org-element-map (org-element-parse-buffer) 'superscript
'identity
)))
1893 ;; Multiple superscript in a paragraph.
1896 (org-test-with-temp-text "a^b and c^d"
1899 (org-element-parse-buffer) 'superscript
'identity
))))))
1904 (ert-deftest test-org-element
/table-parser
()
1905 "Test `table' parser."
1907 (org-test-with-temp-text "| a |"
1908 (org-element-map (org-element-parse-buffer) 'table
'identity
)))
1909 ;; TBLFM keyword is case insensitive.
1911 (org-test-with-temp-text "| a |\n#+tblfm: test"
1912 (org-element-property
1914 (org-element-map (org-element-parse-buffer) 'table
'identity nil t
))))
1915 ;; Handle multiple TBLFM lines.
1918 (org-test-with-temp-text "| a |\n#+TBLFM: test1\n#+TBLFM: test2"
1919 (length (org-element-property
1922 (org-element-parse-buffer) 'table
'identity nil t
))))))
1923 ;; Handle non-empty blank line at the end of buffer.
1925 (org-test-with-temp-text "| a |\n "
1926 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1931 (ert-deftest test-org-element
/table-cell-parser
()
1932 "Test `table-cell' parser."
1933 ;; Regular table cell.
1935 (org-test-with-temp-text "| a |"
1936 (org-element-map (org-element-parse-buffer) 'table-cell
'identity
)))
1937 ;; Last vertical bar may be omitted.
1939 (org-test-with-temp-text "| a "
1940 (org-element-map (org-element-parse-buffer) 'table-cell
'identity
))))
1945 (ert-deftest test-org-element
/table-row-parser
()
1946 "Test `table-row' parser."
1948 (equal '(standard rule
)
1949 (org-test-with-temp-text "| a |\n|---|"
1951 (org-element-parse-buffer) 'table-row
1952 (lambda (row) (org-element-property :type row
)))))))
1957 (ert-deftest test-org-element
/target-parser
()
1958 "Test `target' parser."
1960 (org-test-with-temp-text "<<target>>"
1961 (org-element-map (org-element-parse-buffer) 'target
'identity
))))
1966 (ert-deftest test-org-element
/timestamp
()
1967 "Test `timestamp' parser."
1968 ;; Active timestamp.
1970 (org-test-with-temp-text "<2012-03-29 16:40>"
1971 (eq (org-element-property :type
(org-element-context)) 'active
)))
1973 (org-test-with-temp-text "<2012-03-29 Thu>"
1974 (let ((timestamp (org-element-context)))
1975 (or (org-element-property :hour-start timestamp
)
1976 (org-element-property :minute-start timestamp
)))))
1978 (equal '(2012 3 29 16 40)
1979 (org-test-with-temp-text "<2012-03-29 Thu 16:40>"
1980 (let ((object (org-element-context)))
1981 (list (org-element-property :year-start object
)
1982 (org-element-property :month-start object
)
1983 (org-element-property :day-start object
)
1984 (org-element-property :hour-start object
)
1985 (org-element-property :minute-start object
))))))
1986 ;; Inactive timestamp.
1988 (org-test-with-temp-text "[2012-03-29 Thu 16:40]"
1989 (eq (org-element-property :type
(org-element-context)) 'inactive
)))
1992 (equal '(2012 3 29 16 40 7 30)
1993 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
1994 (let ((object (org-element-context)))
1995 (list (org-element-property :year-end object
)
1996 (org-element-property :month-end object
)
1997 (org-element-property :day-end object
)
1998 (org-element-property :hour-end object
)
1999 (org-element-property :minute-end object
)
2000 (org-element-property :hour-start object
)
2001 (org-element-property :minute-start object
))))))
2004 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
2005 (org-element-property :type
(org-element-context)))))
2008 (org-test-with-temp-text "[2012-03-29 Thu 16:40]--[2012-03-29 Thu 16:41]"
2009 (eq (org-element-property :type
(org-element-context)) 'inactive-range
)))
2011 (org-test-with-temp-text "[2011-07-14 Thu]--[2012-03-29 Thu]"
2012 (let ((timestamp (org-element-context)))
2013 (or (org-element-property :hour-end timestamp
)
2014 (org-element-property :minute-end timestamp
)))))
2015 ;; With repeater, warning delay and both.
2018 (org-test-with-temp-text "<2012-03-29 Thu ++1y>"
2019 (org-element-property :repeater-type
(org-element-context)))))
2022 (org-test-with-temp-text "<2012-03-29 Thu --1y>"
2023 (org-element-property :warning-type
(org-element-context)))))
2025 (equal '(cumulate all
)
2026 (org-test-with-temp-text "<2012-03-29 Thu +1y -1y>"
2027 (let ((ts (org-element-context)))
2028 (list (org-element-property :repeater-type ts
)
2029 (org-element-property :warning-type ts
))))))
2030 ;; Timestamps are not planning elements.
2032 (org-test-with-temp-text "SCHEDULED: <2012-03-29 Thu 16:40>"
2033 (org-element-map (org-element-parse-buffer) 'timestamp
'identity
))))
2038 (ert-deftest test-org-element
/underline-parser
()
2039 "Test `underline' parser."
2042 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2043 (org-test-with-temp-text "_underline_"
2044 (org-element-map (org-element-parse-buffer) 'underline
'identity
))))
2045 ;; Multi-line markup.
2048 (org-element-contents
2049 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2050 (org-test-with-temp-text "_first line\nsecond line_"
2052 (org-element-parse-buffer) 'underline
'identity nil t
))))
2053 '("first line\nsecond line"))))
2058 (ert-deftest test-org-element
/verbatim-parser
()
2059 "Test `verbatim' parser."
2062 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2063 (org-test-with-temp-text "=verbatim="
2064 (org-element-map (org-element-parse-buffer) 'verbatim
'identity
))))
2065 ;; Multi-line markup.
2068 (org-element-property
2070 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2071 (org-test-with-temp-text "=first line\nsecond line="
2073 (org-element-parse-buffer) 'verbatim
'identity nil t
))))
2074 "first line\nsecond line")))
2079 (ert-deftest test-org-element
/verse-block-parser
()
2080 "Test `verse-block' parser."
2083 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
2084 (org-element-map (org-element-parse-buffer) 'verse-block
'identity
)))
2087 (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
2088 (org-element-map (org-element-parse-buffer) 'verse-block
'identity
)))
2089 ;; Parse objects in verse blocks.
2091 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
2092 (org-element-map (org-element-parse-buffer) 'entity
'identity
)))
2093 ;; Ignore incomplete verse block.
2095 (org-test-with-temp-text "#+BEGIN_VERSE"
2096 (org-element-map (org-element-parse-buffer) 'verse-block
'identity nil t
)))
2097 ;; Handle non-empty blank line at the end of buffer.
2099 (org-test-with-temp-text "#+BEGIN_VERSE\nC\n#+END_VERSE\n "
2100 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
2104 ;;; Test Interpreters.
2106 (ert-deftest test-org-element
/interpret-data
()
2107 "Test `org-element-interpret-data' specifications."
2108 ;; Interpret simple affiliated keywords.
2111 (org-element-interpret-data
2112 '(org-data nil
(paragraph (:name
"para") "Paragraph")))
2113 "#+NAME: para\nParagraph\n"))
2114 ;; Interpret multiple affiliated keywords.
2117 (org-element-interpret-data
2118 '(org-data nil
(paragraph (:attr_ascii
("line2" "line1")) "Paragraph")))
2119 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
2120 ;; Interpret parsed affiliated keywords.
2123 (org-element-interpret-data
2124 '(org-data nil
(paragraph (:caption
(("caption"))) "Paragraph")))
2125 "#+CAPTION: caption\nParagraph\n"))
2126 ;; Interpret dual affiliated keywords.
2129 (org-element-interpret-data
2130 '(org-data nil
(paragraph (:caption
((("long") "short"))) "Paragraph")))
2131 "#+CAPTION[short]: long\nParagraph\n"))
2132 ;; Interpret multiple parsed dual keywords.
2135 (org-element-interpret-data
2136 '(org-data nil
(paragraph
2137 (:caption
((("l2") "s2") (("l1") "s1"))) "Paragraph")))
2138 "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph\n"))
2139 ;; Pseudo objects and elements are transparent.
2142 (org-element-interpret-data
2143 '(paragraph nil
(pseudo-object (:post-blank
1) "A") "B")
2147 (org-element-interpret-data
2149 (pseudo-element (:post-blank
1) (paragraph nil
"A"))
2150 (paragraph nil
"B"))))))
2152 (ert-deftest test-org-element
/center-block-interpreter
()
2153 "Test center block interpreter."
2155 (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
2156 "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
2158 (ert-deftest test-org-element
/drawer-interpreter
()
2159 "Test drawer interpreter."
2161 (equal (org-test-parse-and-interpret ":TEST:\nTest\n:END:")
2162 ":TEST:\nTest\n:END:\n")))
2164 (ert-deftest test-org-element
/dynamic-block-interpreter
()
2165 "Test dynamic block interpreter."
2167 (equal (org-test-parse-and-interpret
2168 "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
2169 "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
2171 (ert-deftest test-org-element
/footnote-definition-interpreter
()
2172 "Test footnote definition interpreter."
2173 (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
2175 (ert-deftest test-org-element
/headline-interpreter
()
2176 "Test headline and section interpreters."
2177 ;; 1. Standard test.
2178 (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
2179 ;; 2. With TODO keywords.
2181 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2182 (org-test-parse-and-interpret "* TODO Headline"))
2183 "* TODO Headline\n"))
2186 ;; 3.1. ... and a positive `org-tags-column' value.
2188 (equal (let ((org-tags-column 20))
2189 (org-test-parse-and-interpret "* Headline :tag:"))
2190 "* Headline :tag:\n"))
2191 ;; 3.2. ... and a negative `org-tags-column' value.
2193 (equal (let ((org-tags-column -
20))
2194 (org-test-parse-and-interpret "* Headline :tag:"))
2195 "* Headline :tag:\n"))
2196 ;; 3.3. ... and a null `org-tags-column' value.
2198 (equal (let ((org-tags-column 0))
2199 (org-test-parse-and-interpret "* Headline :tag:"))
2200 "* Headline :tag:\n"))
2201 ;; 4. With priority cookie.
2203 (equal (org-test-parse-and-interpret "* [#B] Headline")
2204 "* [#B] Headline\n"))
2205 ;; 5. With comment keyword.
2207 (equal (let ((org-comment-string "COMMENT"))
2208 (org-test-parse-and-interpret "* COMMENT Headline"))
2209 "* COMMENT Headline\n"))
2210 ;; 6. Keep same number of blank lines before body.
2212 (equal (org-test-parse-and-interpret
2213 "* Headline\n\n\nText after two blank lines.")
2214 "* Headline\n\n\nText after two blank lines.\n")))
2216 (ert-deftest test-org-element
/inlinetask-interpreter
()
2217 "Test inlinetask interpretation."
2218 (when (featurep 'org-inlinetask
)
2219 (let ((org-inlinetask-min-level 15))
2220 ;; 1. Regular inlinetask.
2221 (should (equal (org-test-parse-and-interpret
2222 "*************** Task\nTest\n*************** END")
2223 "*************** Task\nTest\n*************** END\n"))
2224 ;; 2. Degenerate inlinetask.
2225 (should (equal (org-test-parse-and-interpret "*************** Task")
2226 "*************** Task\n"))
2227 ;; 3. Prefer degenerate form when there are no contents.
2228 (should (equal (org-test-parse-and-interpret
2229 "*************** Task\n*************** END")
2230 "*************** Task\n"))
2231 ;; 4. With TODO keywords.
2233 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2234 (org-test-parse-and-interpret "*************** TODO Task"))
2235 "*************** TODO Task\n"))
2238 ;; 5.1. ... and a positive `org-tags-column' value.
2240 (equal (let ((org-tags-column 30))
2241 (org-test-parse-and-interpret "*************** Task :tag:"))
2242 "*************** Task :tag:\n"))
2243 ;; 5.2. ... and a negative `org-tags-column' value.
2245 (equal (let ((org-tags-column -
30))
2246 (org-test-parse-and-interpret "*************** Task :tag:"))
2247 "*************** Task :tag:\n"))
2248 ;; 5.3. ... and a null `org-tags-column' value.
2250 (equal (let ((org-tags-column 0))
2251 (org-test-parse-and-interpret "*************** Task :tag:"))
2252 "*************** Task :tag:\n"))
2253 ;; 6. With priority cookie.
2255 (equal (org-test-parse-and-interpret "*************** [#B] Task")
2256 "*************** [#B] Task\n")))))
2258 (ert-deftest test-org-element
/plain-list-interpreter
()
2259 "Test plain-list and item interpreters."
2260 (let ((org-list-two-spaces-after-bullet-regexp nil
))
2262 (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
2263 ;; Description list.
2265 (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
2268 (equal (let ((org-plain-list-ordered-item-terminator t
))
2269 (org-test-parse-and-interpret "1. Item"))
2272 (equal (let ((org-plain-list-ordered-item-terminator ?\
)))
2273 (org-test-parse-and-interpret "1) Item"))
2275 ;; Ordered list with counter.
2277 (equal (let ((org-plain-list-ordered-item-terminator t
))
2278 (org-test-parse-and-interpret "1. [@5] Item"))
2280 ;; List with check-boxes.
2282 (equal (org-test-parse-and-interpret
2283 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
2284 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n"))
2285 ;; Item not starting with a paragraph.
2287 (equal (org-test-parse-and-interpret "-\n | a | b |")
2288 "- \n | a | b |\n"))
2289 ;; Special case: correctly handle "*" bullets.
2290 (should (org-test-parse-and-interpret " * item"))
2291 ;; Special case: correctly handle empty items.
2292 (should (org-test-parse-and-interpret "-"))))
2294 (ert-deftest test-org-element
/quote-block-interpreter
()
2295 "Test quote block interpreter."
2296 (should (equal (org-test-parse-and-interpret
2297 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
2298 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
2300 (ert-deftest test-org-element
/special-block-interpreter
()
2301 "Test special block interpreter."
2302 (should (equal (org-test-parse-and-interpret
2303 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
2304 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
2306 (ert-deftest test-org-element
/babel-call-interpreter
()
2307 "Test babel call interpreter."
2308 ;; 1. Without argument.
2309 (should (equal (org-test-parse-and-interpret "#+CALL: test()")
2310 "#+CALL: test()\n"))
2311 ;; 2. With argument.
2312 (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
2313 "#+CALL: test(x=2)\n"))
2314 ;; 3. With header arguments.
2315 (should (equal (org-test-parse-and-interpret
2316 "#+CALL: test[:results output]()[:results html]")
2317 "#+CALL: test[:results output]()[:results html]\n")))
2319 (ert-deftest test-org-element
/clock-interpreter
()
2320 "Test clock interpreter."
2324 "CLOCK: \\[2012-01-01 .* 00:01\\]"
2325 (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]")))
2329 "CLOCK: \\[2012-01-01 .* 00:01\\]--\\[2012-01-01 .* 00:02\\] => 0:01"
2330 (org-test-parse-and-interpret "
2331 CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))))
2333 (ert-deftest test-org-element
/comment-interpreter
()
2334 "Test comment interpreter."
2336 (should (equal (org-test-parse-and-interpret "# Comment") "# Comment\n"))
2338 (should (equal (org-test-parse-and-interpret " # Comment")
2340 ;; Preserve indentation.
2341 (should (equal (org-test-parse-and-interpret " # No blank\n# One blank")
2342 "# No blank\n# One blank\n")))
2344 (ert-deftest test-org-element
/comment-block-interpreter
()
2345 "Test comment block interpreter."
2346 (should (equal (org-test-parse-and-interpret
2347 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
2348 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n")))
2350 (ert-deftest test-org-element
/diary-sexp
()
2351 "Test diary-sexp interpreter."
2354 (org-test-parse-and-interpret
2355 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old")
2356 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old\n")))
2358 (ert-deftest test-org-element
/example-block-interpreter
()
2359 "Test example block interpreter."
2360 ;; Without switches.
2361 (should (equal (org-test-parse-and-interpret
2362 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
2363 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
2366 (equal (org-test-parse-and-interpret
2367 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
2368 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n"))
2369 ;; Preserve code escaping.
2371 (equal (org-test-parse-and-interpret
2372 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE")
2373 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE\n")))
2375 (ert-deftest test-org-element
/export-block-interpreter
()
2376 "Test export block interpreter."
2377 (should (equal (org-test-parse-and-interpret
2378 "#+BEGIN_HTML\nTest\n#+END_HTML")
2379 "#+BEGIN_HTML\nTest\n#+END_HTML\n")))
2381 (ert-deftest test-org-element
/fixed-width-interpreter
()
2382 "Test fixed width interpreter."
2384 (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
2385 ;; Preserve indentation.
2386 (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
2387 ": 2 blanks\n: 1 blank\n"))
2388 ;; Remove last newline character
2390 (equal (org-element-fixed-width-interpreter
2391 '(fixed-width (:value
"Test\n")) nil
)
2394 (equal (org-element-fixed-width-interpreter
2395 '(fixed-width (:value
"Test")) nil
)
2397 ;; Handle empty string.
2399 (equal (org-element-fixed-width-interpreter
2400 '(fixed-width (:value
"")) nil
)
2402 ;; Handle nil value.
2404 (org-element-fixed-width-interpreter
2405 '(fixed-width (:value nil
)) nil
)))
2407 (ert-deftest test-org-element
/horizontal-rule-interpreter
()
2408 "Test horizontal rule interpreter."
2409 (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
2411 (ert-deftest test-org-element
/keyword-interpreter
()
2412 "Test keyword interpreter."
2413 (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
2414 "#+KEYWORD: value\n")))
2416 (ert-deftest test-org-element
/latex-environment-interpreter
()
2417 "Test latex environment interpreter."
2418 (should (equal (org-test-parse-and-interpret
2419 "\\begin{equation}\n1+1=2\n\\end{equation}")
2420 "\\begin{equation}\n1+1=2\n\\end{equation}\n"))
2421 (should (equal (org-test-parse-and-interpret
2422 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}")
2423 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}\n")))
2425 (ert-deftest test-org-element
/planning-interpreter
()
2426 "Test planning interpreter."
2430 DEADLINE: <2012-03-29 .*?> SCHEDULED: <2012-03-29 .*?> CLOSED: \\[2012-03-29 .*?\\]"
2431 (org-test-parse-and-interpret
2433 DEADLINE: <2012-03-29 thu.> SCHEDULED: <2012-03-29 thu.> CLOSED: [2012-03-29 thu.]"))))
2435 (ert-deftest test-org-element
/property-drawer-interpreter
()
2436 "Test property drawer interpreter."
2437 (should (equal (let ((org-property-format "%-10s %s"))
2438 (org-test-parse-and-interpret
2439 ":PROPERTIES:\n:prop: value\n:END:"))
2440 ":PROPERTIES:\n:prop: value\n:END:\n")))
2442 (ert-deftest test-org-element
/src-block-interpreter
()
2443 "Test src block interpreter."
2446 (equal (let ((org-edit-src-content-indentation 2))
2447 (org-test-parse-and-interpret
2448 "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC"))
2449 "#+BEGIN_SRC emacs-lisp :results silent\n (+ 1 1)\n#+END_SRC\n"))
2452 (equal (let ((org-edit-src-content-indentation 2))
2453 (org-test-parse-and-interpret
2454 "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC"))
2455 "#+BEGIN_SRC emacs-lisp -n -k\n (+ 1 1)\n#+END_SRC\n"))
2456 ;; Preserve code escaping.
2458 (equal (let ((org-edit-src-content-indentation 2))
2459 (org-test-parse-and-interpret
2460 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC"))
2461 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC\n"))
2462 ;; Do not apply `org-edit-src-content-indentation' when preserving
2465 (equal (let ((org-edit-src-content-indentation 2)
2466 (org-src-preserve-indentation t
))
2467 (org-test-parse-and-interpret
2468 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"))
2469 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n"))
2471 (equal (let ((org-edit-src-content-indentation 2)
2472 (org-src-preserve-indentation nil
))
2473 (org-test-parse-and-interpret
2474 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"))
2475 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC\n")))
2477 (ert-deftest test-org-element
/table-interpreter
()
2478 "Test table, table-row and table-cell interpreters."
2480 (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
2481 "| a | b |\n| c | d |\n"))
2482 ;; 2. With horizontal rules.
2483 (should (equal (org-test-parse-and-interpret
2484 "| a | b |\n|---+---|\n| c | d |")
2485 "| a | b |\n|---+---|\n| c | d |\n"))
2486 ;; 3. With meta-data.
2487 (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
2488 "| / | < | > |\n| * | 1 | 2 |\n"))
2489 ;; 4. With a formula.
2491 (equal (org-test-parse-and-interpret
2492 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)")
2493 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)\n"))
2494 ;; 5. With multiple formulas.
2496 (equal (org-test-parse-and-interpret
2497 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2")
2498 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2\n")))
2500 (ert-deftest test-org-element
/timestamp-interpreter
()
2501 "Test timestamp interpreter."
2504 (string-match "<2012-03-29 .* 16:40>"
2505 (org-test-parse-and-interpret "<2012-03-29 thu. 16:40>")))
2507 (string-match "<2012-03-29 .* 16:40>"
2508 (org-element-timestamp-interpreter
2510 (:type active
:year-start
2012 :month-start
3 :day-start
29
2511 :hour-start
16 :minute-start
40)) nil
)))
2514 (string-match "\\[2012-03-29 .* 16:40\\]"
2515 (org-test-parse-and-interpret "[2012-03-29 thu. 16:40]")))
2518 "\\[2012-03-29 .* 16:40\\]"
2519 (org-element-timestamp-interpreter
2521 (:type inactive
:year-start
2012 :month-start
3 :day-start
29
2522 :hour-start
16 :minute-start
40)) nil
)))
2525 (string-match "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2526 (org-test-parse-and-interpret
2527 "<2012-03-29 thu. 16:40>--<2012-03-29 thu. 16:41>")))
2530 "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2531 (org-element-timestamp-interpreter
2533 (:type active-range
:year-start
2012 :month-start
3 :day-start
29
2534 :hour-start
16 :minute-start
40 :year-end
2012 :month-end
3
2535 :day-end
29 :hour-end
16 :minute-end
41)) nil
)))
2538 (string-match "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2539 (org-test-parse-and-interpret
2540 "[2012-03-29 thu. 16:40]--[2012-03-29 thu. 16:41]")))
2543 "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2544 (org-element-timestamp-interpreter
2546 (:type inactive-range
:year-start
2012 :month-start
3 :day-start
29
2547 :hour-start
16 :minute-start
40 :year-end
2012 :month-end
3
2548 :day-end
29 :hour-end
16 :minute-end
41)) nil
)))
2550 (should (equal (org-test-parse-and-interpret "<%%diary-float t 4 2>")
2551 "<%%diary-float t 4 2>\n"))
2552 ;; Timestamp with repeater interval, with delay, with both.
2554 (string-match "<2012-03-29 .* \\+1y>"
2555 (org-test-parse-and-interpret "<2012-03-29 thu. +1y>")))
2558 "<2012-03-29 .* \\+1y>"
2559 (org-element-timestamp-interpreter
2561 (:type active
:year-start
2012 :month-start
3 :day-start
29
2562 :repeater-type cumulate
:repeater-value
1 :repeater-unit year
))
2566 "<2012-03-29 .* -1y>"
2567 (org-element-timestamp-interpreter
2569 (:type active
:year-start
2012 :month-start
3 :day-start
29
2570 :warning-type all
:warning-value
1 :warning-unit year
))
2574 "<2012-03-29 .* \\+1y -1y>"
2575 (org-element-timestamp-interpreter
2577 (:type active
:year-start
2012 :month-start
3 :day-start
29
2578 :warning-type all
:warning-value
1 :warning-unit year
2579 :repeater-type cumulate
:repeater-value
1 :repeater-unit year
))
2581 ;; Timestamp range with repeater interval
2583 (string-match "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2584 (org-test-parse-and-interpret
2585 "<2012-03-29 Thu +1y>--<2012-03-30 Thu +1y>")))
2588 "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2589 (org-element-timestamp-interpreter
2591 (:type active-range
:year-start
2012 :month-start
3 :day-start
29
2592 :year-end
2012 :month-end
3 :day-end
30 :repeater-type cumulate
2593 :repeater-value
1 :repeater-unit year
))
2596 (ert-deftest test-org-element
/verse-block-interpreter
()
2597 "Test verse block interpretation."
2599 (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
2600 "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
2602 (ert-deftest test-org-element
/bold-interpreter
()
2603 "Test bold interpreter."
2604 (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
2606 (ert-deftest test-org-element
/code-interpreter
()
2607 "Test code interpreter."
2608 (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
2610 (ert-deftest test-org-element
/entity-interpreter
()
2611 "Test entity interpreter."
2612 ;; 1. Without brackets.
2614 (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
2615 ;; 2. With brackets.
2617 (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
2619 (ert-deftest test-org-element
/export-snippet-interpreter
()
2620 "Test export snippet interpreter."
2621 (should (equal (org-test-parse-and-interpret "@@back-end:contents@@")
2622 "@@back-end:contents@@\n")))
2624 (ert-deftest test-org-element
/footnote-reference-interpreter
()
2625 "Test footnote reference interpreter."
2626 ;; 1. Regular reference.
2627 (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
2628 ;; 2. Normalized reference.
2629 (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
2630 ;; 3. Named reference.
2631 (should (equal (org-test-parse-and-interpret "Text[fn:label]")
2632 "Text[fn:label]\n"))
2633 ;; 4. Inline reference.
2634 (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
2635 "Text[fn:label:def]\n"))
2636 ;; 5. Anonymous reference.
2637 (should (equal (org-test-parse-and-interpret "Text[fn::def]")
2638 "Text[fn::def]\n")))
2640 (ert-deftest test-org-element
/inline-babel-call-interpreter
()
2641 "Test inline babel call interpreter."
2642 ;; 1. Without arguments.
2643 (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
2644 ;; 2. With arguments.
2645 (should (equal (org-test-parse-and-interpret "call_test(x=2)")
2646 "call_test(x=2)\n"))
2647 ;; 3. With header arguments.
2648 (should (equal (org-test-parse-and-interpret
2649 "call_test[:results output]()[:results html]")
2650 "call_test[:results output]()[:results html]\n")))
2652 (ert-deftest test-org-element
/inline-src-block-interpreter
()
2653 "Test inline src block interpreter."
2654 ;; 1. Without header argument.
2655 (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
2656 "src_emacs-lisp{(+ 1 1)}\n"))
2657 ;; 2. With header arguments.
2658 (should (equal (org-test-parse-and-interpret
2659 "src_emacs-lisp[:results silent]{(+ 1 1)}")
2660 "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
2662 (ert-deftest test-org-element
/italic-interpreter
()
2663 "Test italic interpreter."
2664 (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
2666 (ert-deftest test-org-element
/latex-fragment-interpreter
()
2667 "Test latex fragment interpreter."
2668 (should (equal (org-test-parse-and-interpret "\\command{}") "\\command{}\n"))
2669 (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
2670 (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
2671 (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
2672 (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
2673 (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n")))
2675 (ert-deftest test-org-element
/line-break-interpreter
()
2676 "Test line break interpreter."
2677 (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
2678 "First line \\\\\nSecond line\n")))
2680 (ert-deftest test-org-element
/link-interpreter
()
2681 "Test link interpreter."
2682 ;; 1. Links targeted from a radio target.
2683 (should (equal (let ((org-target-link-regexp "radio-target"))
2684 (org-test-parse-and-interpret "a radio-target"))
2685 "a radio-target\n"))
2686 ;; 2. Regular links.
2688 ;; 2.1. Without description.
2689 (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
2690 "[[http://orgmode.org]]\n"))
2691 ;; 2.2. With a description.
2692 (should (equal (org-test-parse-and-interpret
2693 "[[http://orgmode.org][Org mode]]")
2694 "[[http://orgmode.org][Org mode]]\n"))
2696 (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
2697 ;; 2.4. Custom-id links.
2698 (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
2699 ;; 2.5 Code-ref links.
2700 (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
2701 ;; 3. Normalize plain links.
2702 (should (equal (org-test-parse-and-interpret "http://orgmode.org")
2703 "[[http://orgmode.org]]\n"))
2704 ;; 4. Normalize angular links.
2705 (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
2706 "[[http://orgmode.org]]\n")))
2708 (ert-deftest test-org-element
/macro-interpreter
()
2709 "Test macro interpreter."
2710 ;; 1. Without argument.
2711 (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
2712 ;; 2. With arguments.
2713 (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
2714 "{{{test(arg1,arg2)}}}\n")))
2716 (ert-deftest test-org-element
/radio-target-interpreter
()
2717 "Test radio target interpreter."
2718 (should (equal (org-test-parse-and-interpret "<<<some text>>>")
2719 "<<<some text>>>\n")))
2721 (ert-deftest test-org-element
/statistics-cookie-interpreter
()
2722 "Test statistics cookie interpreter."
2723 ;; 1. Without percent
2724 (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
2726 (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
2728 (ert-deftest test-org-element
/strike-through-interpreter
()
2729 "Test strike through interpreter."
2730 (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
2732 (ert-deftest test-org-element
/subscript-interpreter
()
2733 "Test subscript interpreter."
2734 ;; 1. Without brackets.
2735 (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
2736 ;; 2. With brackets.
2737 (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
2739 (ert-deftest test-org-element
/superscript-interpreter
()
2740 "Test superscript interpreter."
2741 ;; 1. Without brackets.
2742 (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
2743 ;; 2. With brackets.
2744 (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
2746 (ert-deftest test-org-element
/target-interpreter
()
2747 "Test target interpreter."
2748 (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
2750 (ert-deftest test-org-element
/underline-interpreter
()
2751 "Test underline interpreter."
2752 (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
2754 (ert-deftest test-org-element
/verbatim-interpreter
()
2755 "Test verbatim interpreter."
2756 (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
2760 ;;; Test Granularity
2762 (ert-deftest test-org-element
/granularity
()
2763 "Test granularity impact on buffer parsing."
2764 (org-test-with-temp-text "
2771 ;; 1.1. Granularity set to `headline' should parse every headline
2772 ;; in buffer, and only them.
2773 (let ((tree (org-element-parse-buffer 'headline
)))
2774 (should (= 2 (length (org-element-map tree
'headline
'identity
))))
2775 (should-not (org-element-map tree
'paragraph
'identity
)))
2776 ;; 1.2. Granularity set to `greater-element' should not enter
2777 ;; greater elements excepted headlines and sections.
2778 (let ((tree (org-element-parse-buffer 'greater-element
)))
2779 (should (= 1 (length (org-element-map tree
'center-block
'identity
))))
2780 (should (= 1 (length (org-element-map tree
'paragraph
'identity
))))
2781 (should-not (org-element-map tree
'entity
'identity
)))
2782 ;; 1.3. Granularity set to `element' should enter every
2784 (let ((tree (org-element-parse-buffer 'element
)))
2785 (should (= 2 (length (org-element-map tree
'paragraph
'identity
))))
2786 (should-not (org-element-map tree
'entity
'identity
)))
2787 ;; 1.4. Granularity set to `object' can see everything.
2788 (let ((tree (org-element-parse-buffer 'object
)))
2789 (should (= 1 (length (org-element-map tree
'entity
'identity
)))))))
2791 (ert-deftest test-org-element
/secondary-string-parsing
()
2792 "Test if granularity correctly toggles secondary strings parsing."
2793 ;; 1. With a granularity bigger than `object', no secondary string
2794 ;; should be parsed.
2796 ;; 1.1. Test with `headline' type.
2797 (org-test-with-temp-text "* Headline"
2799 (org-element-map (org-element-parse-buffer 'headline
) 'headline
2803 (should (stringp (org-element-property :title headline
)))))
2804 ;; 1.2. Test with `item' type.
2805 (org-test-with-temp-text "* Headline\n- tag :: item"
2806 (let ((item (org-element-map (org-element-parse-buffer 'element
)
2811 (should (stringp (org-element-property :tag item
)))))
2812 ;; 1.3. Test with `inlinetask' type, if avalaible.
2813 (when (featurep 'org-inlinetask
)
2814 (let ((org-inlinetask-min-level 15))
2815 (org-test-with-temp-text "*************** Inlinetask"
2816 (let ((inlinetask (org-element-map (org-element-parse-buffer 'element
)
2821 (should (stringp (org-element-property :title inlinetask
)))))))
2822 ;; 2. With a default granularity, secondary strings should be
2824 (org-test-with-temp-text "* Headline"
2826 (org-element-map (org-element-parse-buffer) 'headline
2830 (should (listp (org-element-property :title headline
)))))
2831 ;; 3. `org-element-at-point' should never parse a secondary string.
2832 (org-test-with-temp-text "* Headline"
2833 (should (stringp (org-element-property :title
(org-element-at-point))))))
2837 ;;; Test Visible Only Parsing
2839 (ert-deftest test-org-element
/parse-buffer-visible
()
2840 "Test `org-element-parse-buffer' with visible only argument."
2842 (equal '("H1" "H3" "H5")
2843 (org-test-with-temp-text
2844 "* H1\n** H2\n** H3 :visible:\n** H4\n** H5 :visible:"
2845 (org-occur ":visible:")
2846 (org-element-map (org-element-parse-buffer nil t
) 'headline
2847 (lambda (hl) (org-element-property :raw-value hl
)))))))
2851 ;;; Test `:parent' Property
2853 (ert-deftest test-org-element
/parent-property
()
2854 "Test `:parent' property."
2856 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
2857 (let* ((tree (org-element-parse-buffer))
2858 (parent (org-element-property
2860 (org-element-map tree
'paragraph
'identity nil t
))))
2862 (should (eq (org-element-map tree
'center-block
'identity nil t
)
2865 (org-test-with-temp-text "a_{/b/}"
2866 (let* ((tree (org-element-parse-buffer))
2867 (parent (org-element-property
2869 (org-element-map tree
'italic
'identity nil t
))))
2872 (org-element-map tree
'subscript
'identity nil t
)))))
2873 ;; Secondary strings
2874 (org-test-with-temp-text "* /italic/"
2875 (let* ((tree (org-element-parse-buffer))
2876 (parent (org-element-property
2877 :parent
(org-element-map tree
'italic
'identity nil t
))))
2880 (org-element-map tree
'headline
'identity nil t
))))))
2884 ;;; Test Normalize Contents
2886 (ert-deftest test-org-element
/normalize-contents
()
2887 "Test `org-element-normalize-contents' specifications."
2888 ;; Remove maximum common indentation from element's contents.
2891 (org-element-normalize-contents
2892 '(paragraph nil
" Two spaces\n Three spaces"))
2893 '(paragraph nil
"Two spaces\n Three spaces")))
2894 ;; Ignore objects within contents when computing maximum common
2898 (org-element-normalize-contents
2899 '(paragraph nil
" One " (emphasis nil
"space") "\n Two spaces"))
2900 '(paragraph nil
"One " (emphasis nil
"space") "\n Two spaces")))
2901 ;; Ignore blank lines.
2904 (org-element-normalize-contents
2905 '(paragraph nil
" Two spaces\n\n \n Two spaces"))
2906 '(paragraph nil
"Two spaces\n\n \nTwo spaces")))
2909 '(paragraph nil
" Two spaces\n" (verbatim nil
"V") "\n Two spaces")
2910 (org-element-normalize-contents
2911 '(paragraph nil
" Two spaces\n " (verbatim nil
"V") "\n Two spaces"))))
2912 ;; Recursively enter objects in order to compute common indentation.
2915 (org-element-normalize-contents
2916 '(paragraph nil
" Two spaces " (bold nil
" and\n One space")))
2917 '(paragraph nil
" Two spaces " (bold nil
" and\nOne space"))))
2918 ;; When optional argument is provided, ignore first line
2922 (org-element-normalize-contents
2923 '(paragraph nil
"No space\n Two spaces\n Three spaces") t
)
2924 '(paragraph nil
"No space\nTwo spaces\n Three spaces"))))
2928 ;;; Test Navigation Tools.
2930 (ert-deftest test-org-element
/at-point
()
2931 "Test `org-element-at-point' specifications."
2932 ;; Return closest element containing point.
2935 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
2936 (progn (search-forward "A")
2937 (org-element-type (org-element-at-point))))))
2938 ;; Correctly set `:parent' property.
2941 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
2942 (progn (search-forward "A")
2944 (org-element-property :parent
(org-element-at-point)))))))
2945 ;; Special case: at a blank line just below a headline, return that
2948 (equal "H1" (org-test-with-temp-text "* H1\n \n* H2\n"
2950 (org-element-property :title
(org-element-at-point)))))
2951 ;; Special case: at the very beginning of a table, return `table'
2952 ;; object instead of `table-row'.
2955 (org-test-with-temp-text "| a | b |"
2956 (org-element-type (org-element-at-point)))))
2957 ;; Special case: at the very beginning of a list or sub-list, return
2958 ;; `plain-list' object instead of `item'.
2961 (org-test-with-temp-text "- item"
2962 (org-element-type (org-element-at-point)))))
2963 ;; Special case: at the closing line of a greater element, be sure
2964 ;; to return it instead of the last element in its contents.
2967 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph\n#+END_CENTER"
2968 (progn (forward-line 2)
2969 (org-element-type (org-element-at-point))))))
2970 ;; Special case: at a blank line between two items, be sure to
2971 ;; return item above instead of the last element of its contents.
2974 (org-test-with-temp-text "- Para1\n\n- Para2"
2975 (progn (forward-line)
2977 (let ((org-list-empty-line-terminates-plain-lists nil
))
2978 (org-element-at-point)))))))
2979 ;; Special case: at the last blank line in a plain list, return it
2980 ;; instead of the last item.
2983 (org-test-with-temp-text "- Para1\n- Para2\n\nPara3"
2984 (progn (forward-line 2)
2985 (org-element-type (org-element-at-point))))))
2986 ;; Special case: when a list ends at the end of buffer and there's
2987 ;; no final newline, return last element in last item.
2990 (org-test-with-temp-text "- a"
2992 (org-element-type (org-element-at-point)))))
2993 ;; Parse a list within a block itself contained in a list.
2996 (org-test-with-temp-text
2997 "- outer\n #+begin_center\n - inner\n #+end_center"
2998 (search-forward "inner")
3000 (org-element-type (org-element-at-point)))))
3001 ;; Do not error at eob on an empty line.
3003 (org-test-with-temp-text "* H\n"
3005 (or (org-element-at-point) t
))))
3007 (ert-deftest test-org-element
/context
()
3008 "Test `org-element-context' specifications."
3009 ;; Return closest object containing point.
3012 (org-test-with-temp-text "Some *text with _underline_ text*"
3013 (progn (search-forward "under")
3014 (org-element-type (org-element-context))))))
3015 ;; Find objects in secondary strings.
3018 (org-test-with-temp-text "* Headline _with_ underlining"
3019 (progn (search-forward "w")
3020 (org-element-type (org-element-context))))))
3021 ;; Find objects in objects.
3024 (org-test-with-temp-text "| a | {{{macro}}} |"
3025 (progn (search-forward "{")
3026 (org-element-type (org-element-context))))))
3029 (org-test-with-temp-text "| a | b {{{macro}}} |"
3030 (progn (search-forward "b")
3031 (org-element-type (org-element-context))))))
3032 ;; Find objects in planning lines.
3035 (org-test-with-temp-text "* H\n SCHEDULED: <2012-03-29 thu.>"
3036 (search-forward "2012")
3037 (org-element-type (org-element-context)))))
3040 (org-test-with-temp-text "* H\n SCHEDULED: <2012-03-29 thu.>"
3041 (search-forward "SCHEDULED")
3042 (org-element-type (org-element-context)))))
3043 ;; Find objects in document keywords.
3046 (org-test-with-temp-text "#+DATE: {{{macro}}}"
3047 (progn (search-forward "{")
3048 (org-element-type (org-element-context))))))
3049 ;; Do not find objects in table rules.
3052 (org-test-with-temp-text "| a | b |\n+---+---+\n| c | d |"
3054 (org-element-type (org-element-context)))))
3055 ;; Find objects in parsed affiliated keywords.
3058 (org-test-with-temp-text "#+CAPTION: {{{macro}}}\n| a | b |."
3059 (progn (search-forward "{")
3060 (org-element-type (org-element-context))))))
3063 (org-test-with-temp-text "#+caption: *bold*\nParagraph"
3064 (progn (search-forward "*")
3065 (org-element-type (org-element-context))))))
3066 ;; Find objects at the end of buffer.
3069 (org-test-with-temp-text "*bold*"
3070 (goto-char (point-max))
3071 (org-element-type (org-element-context)))))
3072 ;; Correctly set `:parent' property.
3075 (org-test-with-temp-text "Some *bold* text"
3076 (progn (search-forward "bold")
3078 (org-element-property :parent
(org-element-context)))))))
3079 ;; Between two objects, return the second one.
3082 (org-test-with-temp-text "<<target>>{{{test}}}"
3083 (progn (search-forward "{")
3085 (org-element-type (org-element-context))))))
3086 ;; Test optional argument.
3089 (org-test-with-temp-text "Some *text with _underline_ text*"
3091 (search-forward "under")
3092 (org-element-type (org-element-context (org-element-at-point)))))))
3093 ;; Special case: bold object at the beginning of a headline.
3096 (org-test-with-temp-text "* *bold*"
3097 (search-forward "bo")
3098 (org-element-type (org-element-context)))))
3099 ;; Special case: incomplete cell at the end of a table row.
3102 (org-test-with-temp-text "|a|b|c"
3103 (goto-char (point-max))
3104 (org-element-type (org-element-context))))))
3110 (ert-deftest test-org-element
/cache
()
3111 "Test basic expectations and common pitfalls for cache."
3115 (org-test-with-temp-text "para1\n\npara2\n\npara3"
3116 (let ((org-element-use-cache t
))
3117 (save-excursion (goto-char (point-max)) (org-element-at-point))
3120 (let ((element (org-element-at-point)))
3121 (cons (org-element-property :begin element
)
3122 (org-element-property :end element
)))))))
3123 ;; Partial shifting: when the contents of a greater element are
3124 ;; modified, only shift ending positions.
3126 (org-test-with-temp-text
3127 "#+BEGIN_CENTER\nPara1\n\nPara2\n\nPara3\n#+END_CENTER"
3128 (let ((org-element-use-cache t
))
3129 (save-excursion (search-forward "3") (org-element-at-point))
3130 (search-forward "Para2")
3132 (let ((element (org-element-property :parent
(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 ;; Re-parent shifted elements.
3139 (org-test-with-temp-text "- item\n\n\n para1\n para2"
3140 (let ((org-element-use-cache t
))
3142 (org-element-at-point)
3143 (save-excursion (goto-char (point-max)) (org-element-at-point))
3146 (goto-char (point-max))
3148 (org-element-property :parent
(org-element-at-point)))))))
3149 ;; Modifying the last line of an element alters the element below.
3151 (org-test-with-temp-text "para1\n\npara2"
3152 (let ((org-element-use-cache t
))
3153 (goto-char (point-max))
3154 (org-element-at-point)
3157 (let ((element (org-element-at-point)))
3158 (equal (cons (org-element-property :begin element
)
3159 (org-element-property :end element
))
3160 (cons (point-min) (point-max)))))))
3161 ;; Modifying the first line of an element alters the element above.
3163 (org-test-with-temp-text ": fixed-width\n:not-fixed-width"
3164 (let ((org-element-use-cache t
))
3165 (goto-char (point-max))
3166 (org-element-at-point)
3167 (search-backward ":")
3170 (let ((element (org-element-at-point)))
3171 (equal (cons (org-element-property :begin element
)
3172 (org-element-property :end element
))
3173 (cons (point-min) (point-max)))))))
3174 ;; Sensitive change: adding a line alters document structure both
3178 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n"
3179 (let ((org-element-use-cache t
))
3180 (goto-char (point-max))
3181 (org-element-at-point)
3182 (insert "#+END_EXAMPLE")
3183 (search-backward "Para1")
3184 (org-element-type (org-element-at-point))))))
3187 (org-test-with-temp-text "Para1\n\nPara2\n#+END_EXAMPLE"
3188 (let ((org-element-use-cache t
))
3189 (save-excursion (goto-char (point-max)) (org-element-at-point))
3190 (insert "#+BEGIN_EXAMPLE\n")
3191 (search-forward "Para2")
3192 (org-element-type (org-element-at-point))))))
3193 ;; Sensitive change: removing a line alters document structure both
3197 (org-test-with-temp-text
3198 "# +BEGIN_EXAMPLE\nPara1\n\nPara2\n#+END_EXAMPLE"
3199 (let ((org-element-use-cache t
))
3200 (save-excursion (goto-char (point-max)) (org-element-at-point))
3203 (search-forward "Para2")
3204 (org-element-type (org-element-at-point))))))
3207 (org-test-with-temp-text
3208 "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n# +END_EXAMPLE"
3209 (let ((org-element-use-cache t
))
3210 (save-excursion (goto-char (point-max)) (org-element-at-point))
3211 (search-forward "# ")
3213 (search-backward "Para1")
3214 (org-element-type (org-element-at-point)))))))
3217 (provide 'test-org-element
)
3219 ;;; test-org-element.el ends here