1 ;;; test-org-element.el --- Tests for org-element.el
3 ;; Copyright (C) 2012-2015 Nicolas Goaziou
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
7 ;; This program is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation, either version 3 of the License, or
10 ;; (at your option) any later version.
12 ;; This program is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;; GNU General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
22 (unless (featurep 'org-element
)
23 (signal 'missing-test-dependency
"org-element"))
25 (defun org-test-parse-and-interpret (text)
26 "Parse TEXT as Org syntax and interpret it.
27 Return interpreted string."
31 (org-element-interpret-data (org-element-parse-buffer))))
35 ;;; Test `org-element-map'
37 (ert-deftest test-org-element
/map
()
38 "Test `org-element-map'."
39 ;; Can map to `plain-text' objects.
42 (org-test-with-temp-text "Some text \alpha
48 (org-element-parse-buffer) 'plain-text
49 (lambda (s) (when (string-match "text" s
) (incf count
))))
51 ;; Applies to secondary strings
53 (org-element-map '("some " (bold nil
"bold") "text") 'bold
'identity
))
54 ;; Enter secondary strings before entering contents.
60 (org-test-with-temp-text "* Some \\alpha headline\n\\beta entity."
61 (org-element-map (org-element-parse-buffer) 'entity
'identity nil t
)))))
62 ;; Apply NO-RECURSION argument.
64 (org-test-with-temp-text "#+BEGIN_CENTER\n\\alpha\n#+END_CENTER"
66 (org-element-parse-buffer) 'entity
'identity nil nil
'center-block
)))
67 ;; Use WITH-AFFILIATED argument.
71 (org-test-with-temp-text "#+CAPTION[a]: 1\n#+CAPTION[b]: 2\nParagraph"
73 (org-element-at-point) 'plain-text
'identity nil nil nil t
)))))
79 (ert-deftest test-org-element
/put-property
()
80 "Test `org-element-put-property' specifications."
82 (org-test-with-temp-text "* Headline\n *a*"
83 (let ((tree (org-element-parse-buffer)))
84 (org-element-put-property
85 (org-element-map tree
'bold
'identity nil t
) :test
1)
86 (should (org-element-property
87 :test
(org-element-map tree
'bold
'identity nil t
)))))
88 ;; Put property on a string.
90 (org-element-property :test
(org-element-put-property "Paragraph" :test t
))))
92 (ert-deftest test-org-element
/set-contents
()
93 "Test `org-element-set-contents' specifications."
94 ;; Accept multiple entries.
96 (equal '("b" (italic nil
"a"))
97 (org-test-with-temp-text "* Headline\n *a*"
98 (let ((tree (org-element-parse-buffer)))
99 (org-element-set-contents
100 (org-element-map tree
'bold
'identity nil t
) "b" '(italic nil
"a"))
101 (org-element-contents
102 (org-element-map tree
'bold
'identity nil t
))))))
103 ;; Accept atoms and elements.
106 (org-test-with-temp-text "* Headline\n *a*"
107 (let ((tree (org-element-parse-buffer)))
108 (org-element-set-contents
109 (org-element-map tree
'bold
'identity nil t
) "b")
110 (org-element-contents
111 (org-element-map tree
'bold
'identity nil t
))))))
113 (equal '((italic nil
"b"))
114 (org-test-with-temp-text "* Headline\n *a*"
115 (let ((tree (org-element-parse-buffer)))
116 (org-element-set-contents
117 (org-element-map tree
'bold
'identity nil t
) '(italic nil
"b"))
118 (org-element-contents
119 (org-element-map tree
'bold
'identity nil t
))))))
120 ;; Allow nil contents.
122 (org-test-with-temp-text "* Headline\n *a*"
123 (let ((tree (org-element-parse-buffer)))
124 (org-element-set-contents (org-element-map tree
'bold
'identity nil t
))
125 (org-element-contents (org-element-map tree
'bold
'identity nil t
))))))
127 (ert-deftest test-org-element
/secondary-p
()
128 "Test `org-element-secondary-p' specifications."
129 ;; In a secondary string, return property name.
132 (org-test-with-temp-text "* Headline *object*"
133 (org-element-map (org-element-parse-buffer) 'bold
134 (lambda (object) (org-element-secondary-p object
))
136 ;; Outside a secondary string, return nil.
138 (org-test-with-temp-text "Paragraph *object*"
139 (org-element-map (org-element-parse-buffer) 'bold
140 (lambda (object) (org-element-type (org-element-secondary-p object
)))
143 (ert-deftest test-org-element
/adopt-elements
()
144 "Test `org-element-adopt-elements' specifications."
147 (equal '(plain-text italic
)
148 (org-test-with-temp-text "* Headline\n *a*"
149 (let ((tree (org-element-parse-buffer)))
150 (org-element-adopt-elements
151 (org-element-map tree
'bold
'identity nil t
) '(italic nil
"a"))
152 (mapcar (lambda (blob) (org-element-type blob
))
153 (org-element-contents
154 (org-element-map tree
'bold
'identity nil t
)))))))
158 (org-test-with-temp-text "* Headline\n *a*"
159 (let ((tree (org-element-parse-buffer)))
160 (org-element-adopt-elements
161 (org-element-map tree
'bold
'identity nil t
) "b")
162 (org-element-contents
163 (org-element-map tree
'bold
'identity nil t
)))))))
165 (ert-deftest test-org-element
/extract-element
()
166 "Test `org-element-extract-element' specifications."
167 ;; Extract a greater element.
169 (equal '(org-data nil
)
170 (org-test-with-temp-text "* Headline"
171 (let* ((tree (org-element-parse-buffer))
172 (element (org-element-map tree
'headline
'identity nil t
)))
173 (org-element-extract-element element
)
175 ;; Extract an element.
178 (org-test-with-temp-text "Paragraph"
179 (let* ((tree (org-element-parse-buffer))
180 (element (org-element-map tree
'paragraph
'identity nil t
)))
181 (org-element-extract-element element
)
185 ;; Extract an object, even in a secondary string.
188 (org-test-with-temp-text "*bold*"
189 (let* ((tree (org-element-parse-buffer))
190 (element (org-element-map tree
'bold
'identity nil t
)))
191 (org-element-extract-element element
)
197 (org-test-with-temp-text "* Headline *bold*"
198 (let* ((tree (org-element-parse-buffer))
199 (element (org-element-map tree
'bold
'identity nil t
)))
200 (org-element-extract-element element
)
204 ;; Return value doesn't have any :parent set.
206 (org-element-property
208 (org-test-with-temp-text "* Headline\n Paragraph with *bold* text."
209 (let* ((tree (org-element-parse-buffer))
210 (element (org-element-map tree
'bold
'identity nil t
)))
211 (org-element-extract-element element
))))))
213 (ert-deftest test-org-element
/insert-before
()
214 "Test `org-element-insert-before' specifications."
218 '(italic entity bold
)
219 (org-test-with-temp-text "/some/ *paragraph*"
220 (let* ((tree (org-element-parse-buffer))
221 (paragraph (org-element-map tree
'paragraph
'identity nil t
))
222 (bold (org-element-map tree
'bold
'identity nil t
)))
223 (org-element-insert-before '(entity (:name
"\\alpha")) bold
)
224 (org-element-map tree
'(bold entity italic
) #'org-element-type nil
)))))
225 ;; Insert an object in a secondary string.
229 (org-test-with-temp-text "* /A/\n Paragraph."
230 (let* ((tree (org-element-parse-buffer))
231 (headline (org-element-map tree
'headline
'identity nil t
))
232 (italic (org-element-map tree
'italic
'identity nil t
)))
233 (org-element-insert-before '(entity (:name
"\\alpha")) italic
)
234 (org-element-map (org-element-property :title headline
) '(entity italic
)
235 #'org-element-type
))))))
237 (ert-deftest test-org-element
/set-element
()
238 "Test `org-element-set-element' specifications."
239 ;; Check if new element is inserted.
241 (org-test-with-temp-text "* Headline\n*a*"
242 (let* ((tree (org-element-parse-buffer))
243 (bold (org-element-map tree
'bold
'identity nil t
)))
244 (org-element-set-element bold
'(italic nil
"b"))
245 (org-element-map tree
'italic
'identity
))))
246 ;; Check if old element is removed.
248 (org-test-with-temp-text "* Headline\n*a*"
249 (let* ((tree (org-element-parse-buffer))
250 (bold (org-element-map tree
'bold
'identity nil t
)))
251 (org-element-set-element bold
'(italic nil
"b"))
252 (org-element-map tree
'bold
'identity
))))
253 ;; Check if :parent property is correctly set.
256 (org-test-with-temp-text "* Headline\n*a*"
257 (let* ((tree (org-element-parse-buffer))
258 (bold (org-element-map tree
'bold
'identity nil t
)))
259 (org-element-set-element bold
'(italic nil
"b"))
261 (org-element-property
262 :parent
(org-element-map tree
'italic
'identity nil t
)))))))
263 ;; Allow to replace strings with elements.
266 (org-test-with-temp-text "* Headline"
267 (let* ((tree (org-element-parse-buffer))
268 (text (org-element-map tree
'plain-text
'identity nil t
)))
269 (org-element-set-element text
(list 'bold nil
"b"))
270 (org-element-map tree
'plain-text
'identity
)))))
271 ;; Allow to replace elements with strings.
274 (org-test-with-temp-text "* =verbatim="
275 (let* ((tree (org-element-parse-buffer))
276 (verb (org-element-map tree
'verbatim
'identity nil t
)))
277 (org-element-set-element verb
"a")
278 (org-element-map tree
'plain-text
'identity nil t
)))))
279 ;; Allow to replace strings with strings.
282 (org-test-with-temp-text "a"
283 (let* ((tree (org-element-parse-buffer))
284 (text (org-element-map tree
'plain-text
'identity nil t
)))
285 (org-element-set-element text
"b")
286 (org-element-map tree
'plain-text
'identity nil t
))))))
288 (ert-deftest test-org-element
/copy
()
289 "Test `org-element-copy' specifications."
292 (org-test-with-temp-text "*bold*"
293 (org-element-type (org-element-copy (org-element-context))))))
294 (should (eq 'plain-text
295 (org-test-with-temp-text "*bold*"
297 (org-element-map (org-element-parse-buffer) 'plain-text
298 #'org-element-copy nil t
)))))
299 ;; Preserve properties except `:parent'.
301 (org-test-with-temp-text "*bold*"
302 (org-element-property
303 :end
(org-element-copy (org-element-context))))))
305 (org-test-with-temp-text "*bold*"
306 (org-element-property
307 :parent
(org-element-copy (org-element-context)))))
309 (org-test-with-temp-text "*bold*"
310 (org-element-property
312 (org-element-map (org-element-parse-buffer) 'plain-text
313 #'org-element-copy nil t
))))
314 ;; Copying nil returns nil.
315 (should-not (org-element-copy nil
))
316 ;; Return a copy secondary strings.
317 (should (equal '("text") (org-element-copy '("text"))))
318 (should-not (eq '("text") (org-element-copy '("text")))))
324 ;;;; Affiliated Keywords
326 (ert-deftest test-org-element
/affiliated-keywords-parser
()
327 "Test affiliated keywords parsing."
328 ;; Read simple keywords.
331 (org-element-property
333 (org-test-with-temp-text "#+NAME: para\nParagraph"
334 (org-element-at-point)))))
337 (org-element-property
339 (org-test-with-temp-text "#+NAME: para\nParagraph"
340 (org-element-at-point)))))
341 ;; Parse multiple keywords.
345 (org-element-property
347 (org-test-with-temp-text
348 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph"
349 (org-element-at-point)))))
350 ;; Parse "parsed" keywords.
354 (org-test-with-temp-text "#+CAPTION: caption\nParagraph"
355 (car (org-element-property :caption
(org-element-at-point))))))
356 ;; Parse dual keywords.
359 '((("long") "short"))
360 (org-test-with-temp-text "#+CAPTION[short]: long\nParagraph"
361 (org-element-property :caption
(org-element-at-point)))))
362 ;; Allow multiple caption keywords.
365 '((("l2") "s2") (("l1") "s1"))
366 (org-test-with-temp-text "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph"
367 (org-element-property :caption
(org-element-at-point)))))
370 '((("l1")) (nil "s1"))
371 (org-test-with-temp-text "#+CAPTION[s1]:\n#+CAPTION: l1\nParagraph"
372 (org-element-property :caption
(org-element-at-point)))))
373 ;; Corner case: orphaned keyword at the end of an element.
376 (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
377 (progn (search-forward "name")
378 (org-element-type (org-element-at-point))))))
380 (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
381 (progn (search-forward "Some")
382 (org-element-property :name
(org-element-at-point))))))
387 (ert-deftest test-org-element
/babel-call-parser
()
388 "Test `babel-call' parsing."
392 (org-test-with-temp-text "#+CALL: test()"
393 (org-element-type (org-element-at-point)))))
397 (org-test-with-temp-text "#+call: test()"
398 (org-element-type (org-element-at-point)))))
399 ;; Handle non-empty blank line at the end of buffer.
401 (org-test-with-temp-text "#+CALL: test()\n "
402 (= (org-element-property :end
(org-element-at-point)) (point-max))))
406 (org-test-with-temp-text "#+CALL: test()"
407 (org-element-property :call
(org-element-at-point)))))
408 ;; Parse inside header.
410 (equal ":results output"
411 (org-test-with-temp-text "#+CALL: test[:results output]()"
412 (org-element-property :inside-header
(org-element-at-point)))))
413 ;; Parse arguments, which can be nested.
416 (org-test-with-temp-text "#+CALL: test(n=4)"
417 (org-element-property :arguments
(org-element-at-point)))))
420 (org-test-with-temp-text "#+CALL: test(test())"
421 (org-element-property :arguments
(org-element-at-point)))))
424 (equal ":results html"
425 (org-test-with-temp-text "#+CALL: test() :results html"
426 (org-element-property :end-header
(org-element-at-point))))))
431 (ert-deftest test-org-element
/bold-parser
()
432 "Test `bold' parser."
435 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
436 (org-test-with-temp-text "*bold*"
437 (org-element-map (org-element-parse-buffer) 'bold
'identity nil t
))))
438 ;; Multi-line markup.
441 (org-element-contents
442 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
443 (org-test-with-temp-text "*first line\nsecond line*"
444 (org-element-map (org-element-parse-buffer) 'bold
'identity nil t
))))
445 '("first line\nsecond line"))))
450 (ert-deftest test-org-element
/center-block-parser
()
451 "Test `center-block' parser."
454 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
455 (org-element-map (org-element-parse-buffer) 'center-block
'identity
)))
458 (org-test-with-temp-text "#+begin_center\nText\n#+end_center"
459 (org-element-map (org-element-parse-buffer) 'center-block
'identity
)))
460 ;; Ignore incomplete block.
462 (org-test-with-temp-text "#+BEGIN_CENTER"
463 (org-element-map (org-element-parse-buffer) 'center-block
465 ;; Handle non-empty blank line at the end of buffer.
467 (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
468 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
473 (ert-deftest test-org-element
/clock-parser
()
474 "Test `clock' parser."
476 (let ((clock (org-test-with-temp-text "CLOCK: [2012-01-01 sun. 00:01]"
477 (org-element-at-point))))
478 (should (eq (org-element-property :status clock
) 'running
))
480 (equal (org-element-property :raw-value
481 (org-element-property :value clock
))
482 "[2012-01-01 sun. 00:01]"))
483 (should-not (org-element-property :duration clock
)))
486 (org-test-with-temp-text
487 "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"
488 (org-element-at-point))))
489 (should (eq (org-element-property :status clock
) 'closed
))
490 (should (equal (org-element-property :raw-value
491 (org-element-property :value clock
))
492 "[2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02]"))
493 (should (equal (org-element-property :duration clock
) "0:01"))))
498 (ert-deftest test-org-element
/code-parser
()
499 "Test `code' parser."
502 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
503 (org-test-with-temp-text "~code~"
504 (org-element-map (org-element-parse-buffer) 'code
'identity
))))
505 ;; Multi-line markup.
508 (org-element-property
510 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
511 (org-test-with-temp-text "~first line\nsecond line~"
513 (org-element-parse-buffer) 'code
'identity nil t
))))
514 "first line\nsecond line")))
519 (ert-deftest test-org-element
/comment-parser
()
520 "Test `comment' parser."
523 (org-test-with-temp-text "# Comment"
524 (org-element-map (org-element-parse-buffer) 'comment
'identity
)))
527 (org-test-with-temp-text " # Comment"
528 (org-element-map (org-element-parse-buffer) 'comment
'identity
)))
529 ;; Preserve indentation.
532 (org-element-property
534 (org-test-with-temp-text "# No blank\n# One blank"
535 (org-element-map (org-element-parse-buffer) 'comment
'identity nil t
)))
536 "No blank\n One blank"))
537 ;; Comment with blank lines.
540 (org-element-property
542 (org-test-with-temp-text "# First part\n# \n#\n# Second part"
543 (org-element-map (org-element-parse-buffer) 'comment
'identity nil t
)))
544 "First part\n\n\nSecond part"))
545 ;; Do not mix comments and keywords.
548 (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
549 (length (org-element-map (org-element-parse-buffer) 'comment
553 (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
554 (org-element-property
556 (org-element-map (org-element-parse-buffer) 'comment
558 ;; Correctly handle non-empty blank lines at the end of buffer.
560 (org-test-with-temp-text "# A\n "
561 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
566 (ert-deftest test-org-element
/comment-block-parser
()
567 "Test `comment-block' parser."
570 (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
571 (org-element-map (org-element-parse-buffer) 'comment-block
'identity
)))
574 (org-test-with-temp-text "#+begin_comment\nText\n#+end_comment"
575 (org-element-map (org-element-parse-buffer) 'comment-block
'identity
)))
576 ;; Ignore incomplete block.
578 (org-test-with-temp-text "#+BEGIN_COMMENT"
579 (org-element-map (org-element-parse-buffer) 'comment-block
581 ;; Handle non-empty blank line at the end of buffer.
583 (org-test-with-temp-text "#+BEGIN_COMMENT\nC\n#+END_COMMENT\n "
584 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
589 (ert-deftest test-org-element
/diary-sexp-parser
()
590 "Test `diary-sexp' parser."
594 (org-test-with-temp-text
595 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old"
596 (org-element-type (org-element-at-point)))))
597 ;; Diary sexp must live at beginning of line
600 (org-test-with-temp-text " %%(org-bbdb-anniversaries)"
601 (org-element-type (org-element-at-point)))))
602 ;; Handle non-empty blank line at the end of buffer.
604 (org-test-with-temp-text "%%(org-bbdb-anniversaries)\n "
605 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
610 (ert-deftest test-org-element
/drawer-parser
()
611 "Test `drawer' parser."
614 (org-test-with-temp-text ":TEST:\nText\n:END:"
615 (org-element-map (org-element-parse-buffer) 'drawer
'identity
)))
616 ;; Ignore incomplete drawer.
618 (org-test-with-temp-text ":TEST:"
619 (org-element-map (org-element-parse-buffer) 'drawer
'identity nil t
)))
620 ;; Handle non-empty blank line at the end of buffer.
622 (org-test-with-temp-text ":TEST:\nC\n:END:\n "
623 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
628 (ert-deftest test-org-element
/dynamic-block-parser
()
629 "Test `dynamic-block' parser."
632 (org-test-with-temp-text
633 "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
634 (org-element-map (org-element-parse-buffer) 'dynamic-block
'identity
)))
637 (org-test-with-temp-text
638 "#+begin: myblock :param1 val1 :param2 val2\nText\n#+end:"
639 (org-element-map (org-element-parse-buffer) 'dynamic-block
'identity
)))
640 ;; Ignore incomplete block.
642 (org-test-with-temp-text "#+BEGIN: myblock :param1 val1 :param2 val2"
643 (org-element-map (org-element-parse-buffer) 'dynamic-block
645 ;; Handle non-empty blank line at the end of buffer.
647 (org-test-with-temp-text "#+BEGIN: myblock :param val1\nC\n#+END:\n "
648 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
653 (ert-deftest test-org-element
/entity-parser
()
654 "Test `entity' parser."
657 (org-test-with-temp-text "\\sin"
658 (org-element-map (org-element-parse-buffer) 'entity
'identity
)))
661 (org-element-property
663 (org-test-with-temp-text "\\alpha{}text"
664 (org-element-map (org-element-parse-buffer) 'entity
'identity nil t
))))
665 ;; User-defined entity.
668 (org-element-property
670 (let ((org-entities-user
671 '(("test" "test" nil
"test" "test" "test" "test"))))
672 (org-test-with-temp-text "\\test"
673 (org-element-map (org-element-parse-buffer) 'entity
'identity nil t
))))
675 ;; Special case: entity at the end of a container.
678 (org-test-with-temp-text "*\\alpha \\beta*"
679 (search-forward "be")
680 (org-element-type (org-element-context))))))
685 (ert-deftest test-org-element
/example-block-parser
()
686 "Test `example-block' parser."
689 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
690 (org-element-map (org-element-parse-buffer) 'example-block
'identity
)))
691 ;; Ignore incomplete block.
694 (org-test-with-temp-text "#+BEGIN_EXAMPLE"
695 (org-element-type (org-element-at-point)))))
696 ;; Properly un-escape code.
698 (equal "* Headline\n #+keyword\nText\n"
699 (org-test-with-temp-text
700 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText\n#+END_EXAMPLE"
701 (org-element-property :value
(org-element-at-point)))))
702 ;; Remove block indentation according to block boundaries, unless
703 ;; block contents are less indented than block boundaries.
706 (org-test-with-temp-text " #+BEGIN_EXAMPLE\n L1\n L2\n #+END_EXAMPLE"
707 (let ((org-src-preserve-indentation t
))
708 (org-element-property :value
(org-element-at-point))))))
712 (org-test-with-temp-text " #+BEGIN_EXAMPLE\n L1\n L2\n #+END_EXAMPLE"
713 (let ((org-src-preserve-indentation t
))
714 (org-element-property :value
(org-element-at-point))))))
715 ;; Handle non-empty blank line at the end of buffer.
717 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nC\n#+END_EXAMPLE\n "
718 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
720 (ert-deftest test-org-element
/block-switches
()
721 "Test `example-block' and `src-block' switches parsing."
722 (let ((org-coderef-label-format "(ref:%s)"))
723 ;; 1. Test "-i" switch.
725 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
726 (org-element-property :preserve-indent
(org-element-at-point))))
728 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"
729 (org-element-property :preserve-indent
(org-element-at-point))))
731 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
732 (org-element-property :preserve-indent
(org-element-at-point))))
734 (org-test-with-temp-text "#+BEGIN_EXAMPLE -i\nText.\n#+END_EXAMPLE"
735 (org-element-property :preserve-indent
(org-element-at-point))))
736 ;; 2. "-n -r -k" combination should number lines, retain labels but
737 ;; not use them in coderefs.
738 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r -k\nText.\n#+END_EXAMPLE"
739 (let ((element (org-element-at-point)))
740 (should (org-element-property :number-lines element
))
741 (should (org-element-property :retain-labels element
))
742 (should-not (org-element-property :use-labels element
))))
743 (org-test-with-temp-text
744 "#+BEGIN_SRC emacs-lisp -n -r -k\n(+ 1 1)\n#+END_SRC"
745 (let ((element (org-element-at-point)))
746 (should (org-element-property :number-lines element
))
747 (should (org-element-property :retain-labels element
))
748 (should-not (org-element-property :use-labels element
))))
749 ;; 3. "-n -r" combination should number-lines remove labels and not
750 ;; use them in coderefs.
751 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r\nText.\n#+END_EXAMPLE"
752 (let ((element (org-element-at-point)))
753 (should (org-element-property :number-lines element
))
754 (should-not (org-element-property :retain-labels element
))
755 (should-not (org-element-property :use-labels element
))))
756 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1)\n#+END_SRC"
757 (let ((element (org-element-at-point)))
758 (should (org-element-property :number-lines element
))
759 (should-not (org-element-property :retain-labels element
))
760 (should-not (org-element-property :use-labels element
))))
761 ;; 4. "-n" or "+n" should number lines, retain labels and use them
764 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n\nText.\n#+END_EXAMPLE"
765 (let ((element (org-element-at-point)))
766 (and (org-element-property :number-lines element
)
767 (org-element-property :retain-labels element
)
768 (org-element-property :use-labels element
)))))
770 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1)\n#+END_SRC"
771 (let ((element (org-element-at-point)))
772 (and (org-element-property :number-lines element
)
773 (org-element-property :retain-labels element
)
774 (org-element-property :use-labels element
)))))
776 (org-test-with-temp-text "#+BEGIN_EXAMPLE +n\nText.\n#+END_EXAMPLE"
777 (let ((element (org-element-at-point)))
778 (and (org-element-property :number-lines element
)
779 (org-element-property :retain-labels element
)
780 (org-element-property :use-labels element
)))))
782 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp +n\n(+ 1 1)\n#+END_SRC"
783 (let ((element (org-element-at-point)))
784 (and (org-element-property :number-lines element
)
785 (org-element-property :retain-labels element
)
786 (org-element-property :use-labels element
)))))
787 ;; 5. No switch should not number lines, but retain labels and use
789 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
790 (let ((element (org-element-at-point)))
791 (should (not (org-element-property :number-lines element
)))
792 (should (org-element-property :retain-labels element
))
793 (should (org-element-property :use-labels element
))))
794 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
795 (let ((element (org-element-at-point)))
796 (should (not (org-element-property :number-lines element
)))
797 (should (org-element-property :retain-labels element
))
798 (should (org-element-property :use-labels element
))))
799 ;; 6. "-r" switch only: do not number lines, remove labels, and
800 ;; don't use labels in coderefs.
801 (org-test-with-temp-text "#+BEGIN_EXAMPLE -r\nText.\n#+END_EXAMPLE"
802 (let ((element (org-element-at-point)))
803 (should (not (org-element-property :number-lines element
)))
804 (should (not (org-element-property :retain-labels element
)))
805 (should (not (org-element-property :use-labels element
)))))
806 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1)\n#+END_SRC"
807 (let ((element (org-element-at-point)))
808 (should (not (org-element-property :number-lines element
)))
809 (should (not (org-element-property :retain-labels element
)))
810 (should (not (org-element-property :use-labels element
)))))
811 ;; 7. Recognize coderefs with user-defined syntax.
815 (org-test-with-temp-text
816 "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText [ref:text]\n#+END_EXAMPLE"
817 (org-element-property :label-fmt
(org-element-at-point)))))
821 (org-test-with-temp-text
822 "#+BEGIN_SRC emacs-lisp -l \"[ref:%s]\"\n(+ 1 1) [ref:text]\n#+END_SRC"
823 (org-element-property :label-fmt
(org-element-at-point)))))))
828 (ert-deftest test-org-element
/export-block-parser
()
829 "Test `export-block' parser."
832 (org-test-with-temp-text "#+BEGIN_LATEX\nText\n#+END_LATEX"
834 (let ((org-element-block-name-alist
835 '(("LATEX" . org-element-export-block-parser
))))
836 (org-element-parse-buffer))
837 'export-block
'identity
)))
840 (let ((org-element-block-name-alist
841 '(("LATEX" . org-element-export-block-parser
))))
842 (org-test-with-temp-text "#+begin_latex\nText\n#+end_latex"
843 (org-element-map (org-element-parse-buffer) 'export-block
'identity
))))
844 ;; Ignore incomplete block.
846 (let ((org-element-block-name-alist
847 '(("LATEX" . org-element-export-block-parser
))))
848 (org-test-with-temp-text "#+BEGIN_LATEX"
849 (org-element-map (org-element-parse-buffer) 'export-block
851 ;; Handle non-empty blank line at the end of buffer.
853 (let ((org-element-block-name-alist
854 '(("LATEX" . org-element-export-block-parser
))))
855 (org-test-with-temp-text "#+BEGIN_LATEX\nC\n#+END_LATEX\n "
856 (= (org-element-property :end
(org-element-at-point)) (point-max))))))
861 (ert-deftest test-org-element
/export-snippet-parser
()
862 "Test `export-snippet' parser."
865 '("back-end" .
"contents")
866 (org-test-with-temp-text "@@back-end:contents@@"
868 (org-element-parse-buffer) 'export-snippet
869 (lambda (snippet) (cons (org-element-property :back-end snippet
)
870 (org-element-property :value snippet
)))
876 (ert-deftest test-org-element
/fixed-width-parser
()
877 "Test fixed-width area parsing."
878 ;; Preserve indentation.
880 (org-test-with-temp-text ": no blank\n: one blank"
881 (org-element-map (org-element-parse-buffer) 'fixed-width
'identity
)))
882 ;; Fixed-width with empty lines.
884 (org-test-with-temp-text ": first part\n:\n: \n: second part"
885 (org-element-map (org-element-parse-buffer) 'fixed-width
'identity
)))
886 ;; Parse indented fixed-width markers.
888 (org-test-with-temp-text "Text\n : no blank\n : one blank"
889 (org-element-map (org-element-parse-buffer) 'fixed-width
'identity
)))
890 ;; Distinguish fixed-width areas within a list and outside of it.
894 (org-test-with-temp-text "
897 : fixed-width outside"
898 (org-element-map (org-element-parse-buffer) 'fixed-width
'identity
)))))
899 ;; Handle non-empty blank line at the end of buffer.
901 (org-test-with-temp-text ": A\n "
902 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
905 ;;;; Footnote Definition
907 (ert-deftest test-org-element
/footnote-definition-parser
()
908 "Test `footnote-definition' parser."
910 (org-test-with-temp-text "[fn:1] Definition"
911 (org-element-map (org-element-parse-buffer) 'footnote-definition
913 ;; Footnote with more contents
916 (org-element-property
918 (org-test-with-temp-text "[fn:1] Definition\n\n| a | b |"
919 (org-element-map (org-element-parse-buffer) 'footnote-definition
921 ;; Footnote starting with special syntax.
923 (org-test-with-temp-text "[fn:1] - no item"
924 (org-element-map (org-element-parse-buffer) 'item
'identity
)))
925 ;; Correctly handle footnote starting with an empty line.
928 (org-test-with-temp-text "[fn:1]\n\n Body"
929 (org-element-property :contents-begin
(org-element-at-point)))))
930 ;; Handle non-empty blank line at the end of buffer.
932 (org-test-with-temp-text "[fn:1] Definition\n "
933 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
936 ;;;; Footnotes Reference.
938 (ert-deftest test-org-element
/footnote-reference-parser
()
939 "Test `footnote-reference' parser."
940 ;; Parse a standard reference.
942 (org-test-with-temp-text "Text[fn:label]"
944 (org-element-parse-buffer) 'footnote-reference
'identity
)))
945 ;; Parse a normalized reference.
947 (org-test-with-temp-text "Text[1]"
949 (org-element-parse-buffer) 'footnote-reference
'identity
)))
950 ;; Parse an inline reference.
952 (org-test-with-temp-text "Text[fn:test:def]"
954 (org-element-parse-buffer) 'footnote-reference
'identity
)))
955 ;; Parse an anonymous reference.
957 (org-test-with-temp-text "Text[fn::def]"
959 (org-element-parse-buffer) 'footnote-reference
'identity
)))
960 ;; Parse nested footnotes.
964 (org-test-with-temp-text "Text[fn::def [fn:label]]"
966 (org-element-parse-buffer) 'footnote-reference
'identity
)))))
967 ;; Parse adjacent footnotes.
969 (org-test-with-temp-text "Text[fn:label1][fn:label2]"
973 (org-element-parse-buffer) 'footnote-reference
'identity
)))))
974 ;; Only properly closed footnotes are recognized as such.
976 (org-test-with-temp-text "Text[fn:label"
978 (org-element-parse-buffer) 'footnote-reference
'identity
))))
983 (ert-deftest test-org-element
/headline-comment-keyword
()
984 "Test COMMENT keyword recognition."
986 (org-test-with-temp-text "* Headline"
987 (let ((org-comment-string "COMMENT"))
988 (should-not (org-element-property :commentedp
(org-element-at-point)))))
989 ;; Standard position.
990 (org-test-with-temp-text "* COMMENT Headline"
991 (let ((org-comment-string "COMMENT")
992 (headline (org-element-at-point)))
993 (should (org-element-property :commentedp headline
))
994 (should (equal (org-element-property :raw-value headline
) "Headline"))))
996 (org-test-with-temp-text "* COMMENT Headline"
997 (let* ((org-comment-string "Comment")
998 (headline (org-element-at-point)))
999 (should-not (org-element-property :commentedp headline
))
1000 (should (equal (org-element-property :raw-value headline
)
1001 "COMMENT Headline"))))
1002 ;; With another keyword.
1003 (org-test-with-temp-text "* TODO COMMENT Headline"
1004 (let* ((org-comment-string "COMMENT")
1005 (org-todo-keywords '((sequence "TODO" "DONE")))
1006 (headline (org-element-at-point)))
1007 (should (org-element-property :commentedp headline
))
1008 (should (equal (org-element-property :raw-value headline
) "Headline"))))
1009 ;; With the keyword only.
1010 (org-test-with-temp-text "* COMMENT"
1011 (let* ((org-comment-string "COMMENT")
1012 (headline (org-element-at-point)))
1013 (should (org-element-property :commentedp headline
))
1014 (should (equal (org-element-property :raw-value headline
) "")))))
1016 (ert-deftest test-org-element
/headline-archive-tag
()
1017 "Test ARCHIVE tag recognition."
1020 (org-test-with-temp-text "* Headline"
1021 (let ((org-archive-tag "ARCHIVE"))
1022 (org-element-property :archivedp
(org-element-at-point)))))
1024 (org-test-with-temp-text "* Headline :ARCHIVE:"
1025 (let ((org-archive-tag "ARCHIVE"))
1026 (let ((headline (org-element-at-point)))
1027 (should (org-element-property :archivedp headline
)))))
1029 (org-test-with-temp-text "* Headline :test:ARCHIVE:"
1030 (let ((org-archive-tag "ARCHIVE"))
1031 (let ((headline (org-element-at-point)))
1032 (should (org-element-property :archivedp headline
)))))
1033 ;; Tag is case-sensitive.
1035 (org-test-with-temp-text "* Headline :ARCHIVE:"
1036 (let ((org-archive-tag "Archive"))
1037 (org-element-property :archivedp
(org-element-at-point))))))
1039 (ert-deftest test-org-element
/headline-properties
()
1040 "Test properties from property drawer."
1041 ;; All properties from property drawer have their symbol upper
1044 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
1045 (org-element-property :FOO
(org-element-at-point))))
1047 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
1048 (org-element-property :foo
(org-element-at-point))))
1049 ;; Also parse properties associated in inlinetasks.
1050 (when (featurep 'org-inlinetask
)
1052 (org-test-with-temp-text "*************** Inlinetask
1056 *************** END"
1057 (org-element-property :FOO
(org-element-at-point)))))
1058 ;; Do not find property drawer in a verbatim area.
1060 (org-test-with-temp-text
1067 (org-element-property :FOO
(org-element-at-point))))
1068 ;; Do not use properties from a drawer associated to an inlinetask.
1069 (when (featurep 'org-inlinetask
)
1071 (org-test-with-temp-text
1073 *************** Inlinetask
1077 *************** END"
1078 (org-element-property
1079 :FOO
(let ((org-inlinetask-min-level 15)) (org-element-at-point))))))
1080 ;; Do not find incomplete drawers.
1082 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar"
1083 (org-element-property :FOO
(org-element-at-point)))))
1086 ;;;; Horizontal Rule
1088 (ert-deftest test-org-element
/horizontal-rule-parser
()
1089 "Test `horizontal-rule' parser."
1092 (org-test-with-temp-text "-----"
1093 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
1096 (org-test-with-temp-text " -----"
1097 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
1098 ;; Hyphen must be alone on the line.
1100 (org-test-with-temp-text "-----wrong"
1101 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
1102 ;; 4 hyphens is too small.
1104 (org-test-with-temp-text "----"
1105 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
1106 ;; Handle non-empty blank line at the end of buffer.
1108 (org-test-with-temp-text "-----\n "
1109 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1112 ;;;; Inline Babel Call
1114 (ert-deftest test-org-element
/inline-babel-call-parser
()
1115 "Test `inline-babel-call' parser."
1118 (eq 'inline-babel-call
1119 (org-test-with-temp-text "call_test()"
1120 (org-element-type (org-element-context)))))
1122 (eq 'inline-babel-call
1123 (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
1124 (org-element-type (org-element-context)))))
1129 (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
1130 (org-element-property :call
(org-element-context)))))
1131 ;; Parse inside header.
1135 (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
1136 (org-element-property :inside-header
(org-element-context)))))
1141 (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
1142 (org-element-property :arguments
(org-element-context)))))
1143 ;; Parse end header.
1147 (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
1148 (org-element-property :end-header
(org-element-context))))))
1151 ;;;; Inline Src Block
1153 (ert-deftest test-org-element
/inline-src-block-parser
()
1154 "Test `inline-src-block' parser."
1156 (org-test-with-temp-text "src_emacs-lisp{(+ 1 1)}"
1157 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1160 (org-test-with-temp-text "src_emacs-lisp[:foo bar]{(+ 1 1)}"
1161 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1163 (org-test-with-temp-text "src_emacs-lisp[ :foo bar]{(+ 1 1)}"
1164 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1167 (org-test-with-temp-text "src_emacs-lisp[]{(+ 1 1)}"
1168 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1171 (org-test-with-temp-text "foosrc_emacs-lisp[]{(+ 1 1)}"
1172 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1174 (org-test-with-temp-text "src_emacs-lisp[]foo{(+ 1 1)}"
1175 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1176 ;; Invalid language name
1178 (org-test-with-temp-text "src_emacs-\tlisp{(+ 1 1)}"
1179 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1180 ;; Test parsing at the beginning of an item.
1182 (org-test-with-temp-text "- src_emacs-lisp{(+ 1 1)}"
1183 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
))))
1188 (ert-deftest test-org-element
/inlinetask-parser
()
1189 "Test `inlinetask' parser."
1190 (when (featurep 'org-inlinetask
)
1191 (let ((org-inlinetask-min-level 15))
1192 ;; Regular inlinetask.
1195 (org-test-with-temp-text
1196 "*************** Task\nTest\n*************** END"
1197 (org-element-type (org-element-at-point)))))
1198 ;; Degenerate inlinetask.
1201 (org-test-with-temp-text "*************** Task"
1202 (org-element-type (org-element-at-point)))))
1203 ;; Mixed inlinetasks.
1205 (org-test-with-temp-text
1207 *************** Task
1208 *************** Task2
1210 *************** END"
1212 (goto-char (org-element-property :end
(org-element-at-point)))
1218 (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
1219 (org-test-with-temp-text "*************** TODO Task"
1220 (org-element-property :todo-keyword
(org-element-at-point))))))
1223 (org-test-with-temp-text "
1224 *************** Task
1225 DEADLINE: <2012-03-29 thu.>
1226 *************** END"
1228 (org-element-property :deadline
(org-element-at-point))))
1230 (org-test-with-temp-text "
1231 *************** Task
1232 DEADLINE: <2012-03-29 thu.>"
1234 (org-element-property :deadline
(org-element-at-point))))
1239 (org-test-with-temp-text "
1240 *************** [#A] Task"
1242 (org-element-property :priority
(org-element-at-point)))))
1247 (org-test-with-temp-text "
1248 *************** Task :test:"
1250 (org-element-property :tags
(org-element-at-point)))))
1251 ;; Regular properties are accessed through upper case keywords.
1253 (org-test-with-temp-text "
1254 *************** Task
1258 *************** END"
1260 (org-element-property :FOO
(org-element-at-point))))
1262 (org-test-with-temp-text "
1263 *************** Task
1267 *************** END"
1269 (org-element-property :foo
(org-element-at-point))))
1270 ;; Handle non-empty blank line at the end of buffer.
1272 (org-test-with-temp-text "*************** Task\n*************** END\n "
1273 (= (org-element-property :end
(org-element-at-point)) (point-max)))))))
1278 (ert-deftest test-org-element
/italic-parser
()
1279 "Test `italic' parser."
1282 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1283 (org-test-with-temp-text "/italic/"
1284 (org-element-map (org-element-parse-buffer) 'italic
'identity nil t
))))
1285 ;; Multi-line markup.
1288 (org-element-contents
1289 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1290 (org-test-with-temp-text "/first line\nsecond line/"
1291 (org-element-map (org-element-parse-buffer) 'italic
'identity nil t
))))
1292 '("first line\nsecond line"))))
1297 (ert-deftest test-org-element
/item-parser
()
1298 "Test `item' parser."
1301 (org-test-with-temp-text "- item"
1302 (org-element-map (org-element-parse-buffer) 'item
'identity
)))
1306 (org-element-property
1308 (org-test-with-temp-text "6. [@6] item"
1309 (org-element-map (org-element-parse-buffer) 'item
'identity nil t
)))))
1314 (org-element-property
1316 (org-test-with-temp-text "- tag :: description"
1317 (org-element-map (org-element-parse-buffer) 'item
'identity nil t
)))))
1318 ;; No tags in ordered lists.
1320 (org-element-property
1322 (org-test-with-temp-text "1. tag :: description"
1323 (org-element-map (org-element-parse-buffer) 'item
'identity nil t
))))
1328 (org-test-with-temp-text "
1333 (org-element-parse-buffer) 'item
1334 (lambda (item) (org-element-property :checkbox item
))))))
1335 ;; Item starting with special syntax.
1337 (equal '(("- item"))
1338 (org-test-with-temp-text "- - item"
1339 (org-element-map (org-element-parse-buffer) 'paragraph
1340 'org-element-contents
))))
1341 ;; Block in an item: ignore indentation within the block.
1343 (org-test-with-temp-text "- item\n #+begin_src emacs-lisp\n(+ 1 1)\n #+end_src"
1345 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1350 (ert-deftest test-org-element
/keyword-parser
()
1351 "Test `keyword' parser."
1354 (org-test-with-temp-text "#+KEYWORD: value"
1355 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1356 ;; Keywords are case-insensitive.
1358 (org-test-with-temp-text "#+keyword: value"
1359 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1360 ;; Affiliated keywords are not keywords.
1362 (org-test-with-temp-text "#+NAME: value
1364 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1365 ;; Do not mix keywords with Babel calls and dynamic blocks.
1367 (org-test-with-temp-text "#+CALL: fun()"
1368 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1370 (org-test-with-temp-text "#+BEGIN: my-fun\nBody\n#+END:"
1371 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1372 ;; Handle non-empty blank line at the end of buffer.
1374 (org-test-with-temp-text "#+KEYWORD: value\n "
1375 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1378 ;;;; Latex Environment
1380 (ert-deftest test-org-element
/latex-environment-parser
()
1381 "Test `latex-environment' parser."
1383 (org-test-with-temp-text "\\begin{equation}\ne^{i\\pi}+1=0\n\\end{equation}"
1384 (org-element-map (org-element-parse-buffer) 'latex-environment
'identity
)))
1385 ;; Allow nested environments.
1393 (org-test-with-temp-text "
1399 (org-element-property
1402 (org-element-parse-buffer) 'latex-environment
'identity nil t
)))))
1403 ;; Allow environments with options and arguments.
1405 (eq 'latex-environment
1406 (org-test-with-temp-text
1407 "\\begin{theorem}[Euler]\ne^{i\\pi}+1=0\n\\end{theorem}"
1408 (org-element-type (org-element-at-point)))))
1410 (eq 'latex-environment
1411 (org-test-with-temp-text "\\begin{env}{arg}\nvalue\n\\end{env}"
1412 (org-element-type (org-element-at-point)))))
1413 ;; Allow environments without newline after \begin{.}.
1415 (eq 'latex-environment
1416 (org-test-with-temp-text "\\begin{env}{arg}something\nvalue\n\\end{env}"
1417 (org-element-type (org-element-at-point)))))
1418 ;; Allow one-line environments.
1420 (eq 'latex-environment
1421 (org-test-with-temp-text "\\begin{env}{arg}something\\end{env}"
1422 (org-element-type (org-element-at-point)))))
1423 ;; Should not allow different tags.
1425 (eq 'latex-environment
1426 (org-test-with-temp-text "\\begin{env*}{arg}something\\end{env}"
1427 (org-element-type (org-element-at-point)))))
1428 ;; LaTeX environments must be on separate lines.
1430 (eq 'latex-environment
1431 (org-test-with-temp-text "\\begin{env} x \\end{env} y"
1432 (org-element-type (org-element-at-point)))))
1434 (eq 'latex-environment
1435 (org-test-with-temp-text "y \\begin{env} x<point> \\end{env}"
1436 (org-element-type (org-element-at-point)))))
1437 ;; Handle non-empty blank line at the end of buffer.
1439 (org-test-with-temp-text "\\begin{env}\n\\end{env}\n "
1440 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1445 (ert-deftest test-org-element
/latex-fragment-parser
()
1446 "Test `latex-fragment' parser."
1449 (org-test-with-temp-text "$a$"
1450 (org-element-type (org-element-context)))))
1453 (org-test-with-temp-text "$a$!"
1454 (org-element-type (org-element-context)))))
1457 (org-test-with-temp-text "$a$,"
1458 (org-element-type (org-element-context)))))
1461 (org-test-with-temp-text "$a$\""
1462 (org-element-type (org-element-context)))))
1465 (org-test-with-temp-text "$a$)"
1466 (org-element-type (org-element-context)))))
1469 (org-test-with-temp-text "$a$ "
1470 (org-element-type (org-element-context)))))
1473 (org-test-with-temp-text "$a$a"
1474 (org-element-type (org-element-context)))))
1477 (org-test-with-temp-text "$$a$$"
1478 (org-element-type (org-element-context)))))
1481 (org-test-with-temp-text "\\(a\\)"
1482 (org-element-type (org-element-context)))))
1485 (org-test-with-temp-text "\\[a\\]"
1486 (org-element-type (org-element-context)))))
1487 ;; Test fragment at the beginning of an item.
1490 (org-test-with-temp-text "- $<point>x$"
1491 (org-element-type (org-element-context))))))
1496 (ert-deftest test-org-element
/line-break-parser
()
1497 "Test `line-break' parser."
1500 (org-test-with-temp-text "Text \\\\"
1501 (org-element-map (org-element-parse-buffer) 'line-break
'identity
)))
1502 ;; Line break with trailing white spaces.
1504 (org-test-with-temp-text "Text \\\\ "
1505 (org-element-map (org-element-parse-buffer) 'line-break
'identity
)))
1506 ;; Three backslashes are too much.
1508 (org-test-with-temp-text "Text \\\\\\"
1509 (org-element-map (org-element-parse-buffer) 'line-break
'identity
))))
1514 (ert-deftest test-org-element
/link-parser
()
1515 "Test `link' parser."
1520 (org-test-with-temp-text "<<<radio>>>A radio link"
1521 (org-update-radio-target-regexp)
1522 (org-element-property
1524 (org-element-map (org-element-parse-buffer) 'link
#'identity nil t
)))))
1527 ;; ... with description.
1531 (org-test-with-temp-text "[[http://orgmode.org][Orgmode.org]]"
1532 (org-element-contents
1533 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1534 ;; ... without description.
1538 (org-test-with-temp-text "[[http://orgmode.org]]"
1539 (org-element-property
1541 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1542 ;; ... with expansion.
1545 "//orgmode.org/worg"
1546 (org-test-with-temp-text "[[Org:worg]]"
1547 (let ((org-link-abbrev-alist '(("Org" .
"http://orgmode.org/"))))
1548 (org-element-property
1550 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
))))))
1551 ;; ... with translation.
1555 (org-test-with-temp-text "[[http://orgmode.org]]"
1556 (flet ((link-translate (type path
) (cons type
"127.0.0.1")))
1557 (let ((org-link-translation-function 'link-translate
))
1558 (org-element-property
1560 (org-element-map (org-element-parse-buffer) 'link
1561 'identity nil t
)))))))
1566 (org-test-with-temp-text "[[id:aaaa]]"
1567 (org-element-property
1569 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1570 ;; ... custom-id link.
1574 (org-test-with-temp-text "[[#some-id]]"
1575 (org-element-property
1577 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1578 ;; ... coderef link.
1582 (org-test-with-temp-text "[[(reference)]]"
1583 (org-element-property
1585 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1590 (org-test-with-temp-text "[[target-or-title]]"
1591 (org-element-property
1593 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1594 ;; ... file-type link with search option.
1597 '(("file" "projects.org" "*task title"))
1598 (org-test-with-temp-text "[[file:projects.org::*task title]]"
1599 (org-element-map (org-element-parse-buffer) 'link
1600 (lambda (l) (list (org-element-property :type l
)
1601 (org-element-property :path l
)
1602 (org-element-property :search-option l
)))))))
1603 ;; ... file-type link with application...
1606 '("file" "projects.org" "emacs")
1607 (org-test-with-temp-text "[[file+emacs:projects.org]]"
1608 (let ((l (org-element-context)))
1609 (list (org-element-property :type l
)
1610 (org-element-property :path l
)
1611 (org-element-property :application l
))))))
1612 ;; ... `:path' in a file-type link must be compatible with "file"
1613 ;; scheme in URI syntax, even if Org syntax isn't...
1615 (org-test-with-temp-text-in-file ""
1616 (let ((file (expand-file-name (buffer-file-name))))
1617 (insert (format "[[file://%s]]" file
))
1618 (equal (org-element-property :path
(org-element-context)) file
))))
1620 (org-test-with-temp-text-in-file ""
1621 (let ((file (expand-file-name (buffer-file-name))))
1622 (insert (format "[[file:%s]]" file
))
1623 (equal (org-element-property :path
(org-element-context)) file
))))
1625 (org-test-with-temp-text-in-file ""
1626 (let ((file (expand-file-name (buffer-file-name))))
1627 (insert (format "[[file:%s]]" file
))
1628 (equal (org-element-property :path
(org-element-context)) file
))))
1629 ;; ... multi-line link.
1632 (org-test-with-temp-text "[[shell:ls\n*.org]]"
1633 (org-element-property :path
(org-element-context)))))
1636 (org-test-with-temp-text "A link: http://orgmode.org"
1637 (org-element-map (org-element-parse-buffer) 'link
'identity
)))
1638 ;; Angular link. Follow RFC 3986.
1641 (org-test-with-temp-text "A link: <point><http://orgmode.org>"
1642 (org-element-type (org-element-context)))))
1644 (equal "//orgmode.org"
1645 (org-test-with-temp-text "A link: <point><http://orgmode\n.org>"
1646 (org-element-property :path
(org-element-context)))))
1647 ;; Link abbreviation.
1650 (org-test-with-temp-text
1651 "#+LINK: orgmode http://www.orgmode.org/\n[[orgmode:#docs]]"
1652 (progn (org-mode-restart)
1653 (goto-char (1- (point-max)))
1654 (org-element-property :type
(org-element-context))))))
1655 ;; Link abbreviation in a secondary string.
1658 (org-test-with-temp-text
1659 "#+LINK: orgmode http://www.orgmode.org/\n* H [[orgmode:#docs]]"
1660 (progn (org-mode-restart)
1661 (org-element-map (org-element-parse-buffer) 'link
1662 (lambda (link) (org-element-property :type link
))
1664 ;; Plain links are allowed as description of regular links.
1667 (org-test-with-temp-text "[[http://orgmode.org][file:unicorn.jpg]]"
1668 (search-forward "file:")
1669 (org-element-property :type
(org-element-context))))))
1674 (ert-deftest test-org-element
/macro-parser
()
1675 "Test `macro' parser."
1676 ;; Without arguments.
1678 (org-test-with-temp-text "{{{macro}}}"
1679 (org-element-map (org-element-parse-buffer) 'macro
'identity
)))
1682 (org-test-with-temp-text "{{{macro(arg1,arg2)}}}"
1683 (org-element-map (org-element-parse-buffer) 'macro
'identity
)))
1684 ;; Properly handle protected commas in arguments...
1688 (org-test-with-temp-text "{{{macro(arg1\\,arg1,arg2)}}}"
1689 (org-element-property :args
(org-element-context))))))
1690 ;; ... even when last argument ends with a protected comma.
1693 (org-test-with-temp-text "{{{macro(C-\\,)}}}"
1694 (org-element-property :args
(org-element-context)))))
1695 ;; Allow to escape escaping character.
1698 (org-test-with-temp-text "{{{macro(C-\\\\,)}}}"
1699 (org-element-property :args
(org-element-context)))))
1700 ;; No need to escape backslashes elsewhere.
1703 (org-test-with-temp-text "{{{macro(\\)}}}"
1704 (org-element-property :args
(org-element-context))))))
1709 (ert-deftest test-org-element
/node-property
()
1710 "Test `node-property' parser."
1713 (equal '("abc" "value")
1714 (org-test-with-temp-text "* H\n:PROPERTIES:\n<point>:abc: value\n:END:"
1715 (let ((element (org-element-at-point)))
1716 (list (org-element-property :key element
)
1717 (org-element-property :value element
))))))
1718 ;; Value should be trimmed.
1721 (org-test-with-temp-text
1722 "* H\n:PROPERTIES:\n<point>:abc: value \n:END:"
1723 (org-element-property :value
(org-element-at-point)))))
1724 ;; A node property requires to be wrapped within a property drawer.
1727 (org-test-with-temp-text ":abc: value"
1728 (org-element-type (org-element-at-point)))))
1729 ;; Accept empty properties.
1731 (equal '(("foo" "value") ("bar" ""))
1732 (org-test-with-temp-text "* H\n:PROPERTIES:\n:foo: value\n:bar:\n:END:"
1733 (org-element-map (org-element-parse-buffer) 'node-property
1735 (list (org-element-property :key p
)
1736 (org-element-property :value p
))))))))
1741 (ert-deftest test-org-element
/paragraph-parser
()
1742 "Test `paragraph' parser."
1745 (org-test-with-temp-text "Paragraph"
1746 (org-element-map (org-element-parse-buffer) 'paragraph
'identity nil t
)))
1747 ;; Property find end of a paragraph stuck to another element.
1750 (org-test-with-temp-text "Paragraph\n# Comment"
1751 (org-element-map (org-element-parse-buffer) 'paragraph
1752 (lambda (p) (char-after (org-element-property :end p
)))
1754 ;; Include ill-formed Keywords.
1756 (org-test-with-temp-text "#+wrong_keyword something"
1757 (org-element-map (org-element-parse-buffer) 'paragraph
'identity
)))
1758 ;; Include incomplete-drawers.
1760 (org-test-with-temp-text ":TEST:\nParagraph"
1761 (let ((elem (org-element-at-point)))
1762 (and (eq (org-element-type elem
) 'paragraph
)
1763 (= (point-max) (org-element-property :end elem
))))))
1764 ;; Include incomplete blocks.
1766 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph"
1767 (let ((elem (org-element-at-point)))
1768 (and (eq (org-element-type elem
) 'paragraph
)
1769 (= (point-max) (org-element-property :end elem
))))))
1770 ;; Include incomplete dynamic blocks.
1772 (org-test-with-temp-text "#+BEGIN: \nParagraph"
1773 (let ((elem (org-element-at-point)))
1774 (and (eq (org-element-type elem
) 'paragraph
)
1775 (= (point-max) (org-element-property :end elem
))))))
1776 ;; Include incomplete latex environments.
1778 (org-test-with-temp-text "\begin{equation}\nParagraph"
1779 (let ((elem (org-element-at-point)))
1780 (and (eq (org-element-type elem
) 'paragraph
)
1781 (= (point-max) (org-element-property :end elem
))))))
1783 (org-test-with-temp-text "Paragraph\n\begin{equation}"
1784 (let ((elem (org-element-at-point)))
1785 (and (eq (org-element-type elem
) 'paragraph
)
1786 (= (point-max) (org-element-property :end elem
))))))
1787 ;; Stop at affiliated keywords.
1789 (org-test-with-temp-text "Paragraph\n#+NAME: test\n| table |"
1790 (let ((elem (org-element-at-point)))
1791 (and (eq (org-element-type elem
) 'paragraph
)
1792 (not (org-element-property :name elem
))
1793 (= (org-element-property :end elem
) (line-beginning-position 2))))))
1795 (org-test-with-temp-text
1796 "Paragraph\n#+CAPTION[with short caption]: test\n| table |"
1797 (let ((elem (org-element-at-point)))
1798 (and (eq (org-element-type elem
) 'paragraph
)
1799 (not (org-element-property :name elem
))
1800 (= (org-element-property :end elem
) (line-beginning-position 2))))))
1801 ;; Do not steal affiliated keywords from container.
1803 (org-test-with-temp-text "#+ATTR_LATEX: test\n- item<point> 1"
1804 (let ((elem (org-element-at-point)))
1805 (and (eq (org-element-type elem
) 'paragraph
)
1806 (not (org-element-property :attr_latex elem
))
1807 (/= (org-element-property :begin elem
) 1)))))
1808 ;; Handle non-empty blank line at the end of buffer.
1810 (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
1811 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1816 (ert-deftest test-org-element
/plain-list-parser
()
1817 "Test `plain-list' parser."
1818 (org-test-with-temp-text "- item"
1819 (should (org-element-map (org-element-parse-buffer) 'plain-list
'identity
)))
1820 ;; Blank lines after the list only belong to outer plain list.
1824 (org-test-with-temp-text "
1829 (let ((endings (org-element-map (org-element-parse-buffer) 'plain-list
1830 (lambda (pl) (org-element-property :end pl
)))))
1832 ;; Move to ending of outer list.
1833 (progn (goto-char (car endings
)) (looking-at "Outside list"))
1834 ;; Move to ending of inner list.
1835 (progn (goto-char (nth 1 endings
)) (looking-at "^$")))))))
1836 ;; Correctly compute end of list if it doesn't end at a line
1839 (org-test-with-temp-text "- list\n \n "
1840 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1845 (ert-deftest test-org-element
/planning-parser
()
1846 "Test `planning' parser."
1847 ;; Test various keywords.
1849 (org-element-property
1851 (org-test-with-temp-text "* H\n<point>CLOSED: [2012-03-29 thu.]"
1852 (org-element-at-point))))
1854 (org-element-property
1856 (org-test-with-temp-text "* H\n<point>DEADLINE: <2012-03-29 thu.>"
1857 (org-element-at-point))))
1859 (org-element-property
1861 (org-test-with-temp-text "* H\n<point>SCHEDULED: <2012-03-29 thu.>"
1862 (org-element-at-point))))
1863 ;; Planning line only exists right after a headline.
1866 (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>"
1867 (org-element-type (org-element-at-point)))))
1870 (org-test-with-temp-text
1871 "* H\n# Comment\n<point>DEADLINE: <2012-03-29 thu.>"
1872 (org-element-type (org-element-at-point))))))
1875 ;;;; Property Drawer
1877 (ert-deftest test-org-element
/property-drawer-parser
()
1878 "Test `property-drawer' parser."
1881 (eq 'property-drawer
1882 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop: value\n:END:"
1883 (org-element-type (org-element-at-point)))))
1885 (eq 'property-drawer
1886 (org-test-with-temp-text
1887 "* H\nDEADLINE: <2014-03-04 tue.>\n<point>:PROPERTIES:\n:prop: value\n:END:"
1888 (org-element-type (org-element-at-point)))))
1889 ;; Allow properties without value and no property at all.
1891 (eq 'property-drawer
1892 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop:\n:END:"
1893 (org-element-type (org-element-at-point)))))
1895 (eq 'property-drawer
1896 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:END:"
1897 (org-element-type (org-element-at-point)))))
1898 ;; Ignore incomplete drawer, drawer at a wrong location or with
1901 (eq 'property-drawer
1902 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop: value"
1903 (org-element-type (org-element-at-point)))))
1905 (eq 'property-drawer
1906 (org-test-with-temp-text
1907 "* H\nParagraph\n<point>:PROPERTIES:\n:prop: value\n:END:"
1908 (org-element-type (org-element-at-point)))))
1910 (eq 'property-drawer
1911 (org-test-with-temp-text
1912 "* H\nParagraph\n<point>:PROPERTIES:\nparagraph\n:END:"
1913 (org-element-type (org-element-at-point)))))
1914 ;; Handle non-empty blank line at the end of buffer.
1916 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:END:\n "
1917 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1922 (ert-deftest test-org-element
/quote-block-parser
()
1923 "Test `quote-block' parser."
1926 (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
1927 (org-element-map (org-element-parse-buffer) 'quote-block
'identity
)))
1928 ;; Ignore incomplete block.
1930 (org-test-with-temp-text "#+BEGIN_QUOTE"
1931 (org-element-map (org-element-parse-buffer) 'quote-block
'identity nil t
)))
1932 ;; Handle non-empty blank line at the end of buffer.
1934 (org-test-with-temp-text "#+BEGIN_QUOTE\nC\n#+END_QUOTE\n "
1935 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1940 (ert-deftest test-org-element
/radio-target-parser
()
1941 "Test `radio-target' parser."
1945 (org-test-with-temp-text "<<<radio>>>"
1946 (org-element-type (org-element-context)))))
1947 ;; Radio targets with objects.
1950 (org-test-with-temp-text "<<<radio \\alpha>>>"
1951 (org-element-type (org-element-context)))))
1952 ;; Radio targets starting with an object.
1955 (org-test-with-temp-text "<<<\\alpha radio>>>"
1956 (org-element-type (org-element-context)))))
1957 ;; Radio targets cannot begin or end with white space.
1960 (org-test-with-temp-text "<<< radio>>>"
1961 (org-element-type (org-element-context)))))
1964 (org-test-with-temp-text "<<<radio >>>"
1965 (org-element-type (org-element-context))))))
1970 (ert-deftest test-org-element
/section-parser
()
1971 "Test `section' parser."
1974 (org-test-with-temp-text "* Headline\nText"
1975 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
1976 ;; There's a section before the first headline.
1978 (org-test-with-temp-text "Text"
1979 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
1980 ;; A section cannot be empty.
1982 (org-test-with-temp-text "* Headline 1\n* Headline 2"
1983 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
1984 ;; A section doesn't contain sub-trees.
1986 (org-test-with-temp-text "* Head\nText\n** Sub-Head"
1988 (org-element-map (org-element-parse-buffer) 'section
'identity nil t
)
1989 'headline
'identity
))))
1994 (ert-deftest test-org-element
/special-block-parser
()
1995 "Test `special-block' parser."
1999 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
2000 (org-element-property :type
(org-element-at-point)))))
2001 ;; Special blocks are case sensitive.
2004 (org-test-with-temp-text "#+BEGIN_CaSe\nText\n#+END_CaSe"
2005 (org-element-property :type
(org-element-at-point)))))
2006 ;; Special blocks can contain paragraphs.
2009 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
2011 (org-element-type (org-element-at-point)))))
2012 ;; Ignore incomplete block.
2015 (org-test-with-temp-text "#+BEGIN_SPECIAL"
2016 (org-element-type (org-element-at-point)))))
2017 ;; Allow special characters in type.
2019 (equal '(special-block "SPECIAL*")
2020 (org-test-with-temp-text "#+BEGIN_SPECIAL*\nContents\n#+END_SPECIAL*"
2021 (let ((element (org-element-at-point)))
2022 (list (org-element-type element
)
2023 (org-element-property :type element
))))))
2024 ;; Handle non-empty blank line at the end of buffer.
2026 (org-test-with-temp-text "#+BEGIN_SPECIAL\nC\n#+END_SPECIAL\n "
2027 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
2032 (ert-deftest test-org-element
/src-block-parser
()
2033 "Test `src-block' parser."
2036 (org-test-with-temp-text "#+BEGIN_SRC org\nText\n#+END_SRC"
2037 (org-element-map (org-element-parse-buffer) 'src-block
'identity
)))
2038 ;; Ignore incomplete block.
2040 (org-test-with-temp-text "#+BEGIN_SRC"
2041 (org-element-map (org-element-parse-buffer) 'src-block
'identity
)))
2042 ;; Properly un-escape code.
2044 (equal "* Headline\n #+keyword\nText\n"
2045 (org-test-with-temp-text
2046 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText\n#+END_SRC"
2047 (org-element-property :value
(org-element-at-point)))))
2048 ;; Remove block indentation according to block boundaries, unless
2049 ;; block contents are less indented than block boundaries.
2052 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
2053 (let ((org-src-preserve-indentation t
))
2054 (org-element-property :value
(org-element-at-point))))))
2058 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
2059 (let ((org-src-preserve-indentation t
))
2060 (org-element-property :value
(org-element-at-point))))))
2061 ;; Handle non-empty blank line at the end of buffer.
2063 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\nC\n#+END_SRC\n "
2064 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
2067 ;;;; Statistics Cookie
2069 (ert-deftest test-org-element
/statistics-cookie
()
2070 "Test `statistics-cookie' parser."
2073 (org-test-with-temp-text "[1/2]"
2074 (org-element-map (org-element-parse-buffer) 'statistics-cookie
'identity
)))
2077 (org-test-with-temp-text "[33%]"
2079 (org-element-parse-buffer) 'statistics-cookie
'identity
))))
2084 (ert-deftest test-org-element
/strike-through-parser
()
2085 "Test `strike-through' parser."
2088 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2089 (org-test-with-temp-text "+strike-through+"
2090 (org-element-map (org-element-parse-buffer) 'strike-through
'identity
))))
2091 ;; Multi-line markup.
2094 (org-element-contents
2095 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2096 (org-test-with-temp-text "+first line\nsecond line+"
2098 (org-element-parse-buffer) 'strike-through
'identity nil t
))))
2099 '("first line\nsecond line"))))
2104 (ert-deftest test-org-element
/subscript-parser
()
2105 "Test `subscript' parser."
2108 (org-test-with-temp-text "a_b"
2109 (org-element-map (org-element-parse-buffer) 'subscript
'identity
)))
2112 (org-test-with-temp-text "a_{b}"
2113 (org-element-map (org-element-parse-buffer) 'subscript
'identity
)))
2114 ;; Multiple subscripts in a paragraph.
2117 (org-test-with-temp-text "a_b and c_d"
2119 (org-element-map (org-element-parse-buffer) 'subscript
'identity
))))))
2124 (ert-deftest test-org-element
/superscript-parser
()
2125 "Test `superscript' parser."
2128 (org-test-with-temp-text "a^b"
2129 (org-element-map (org-element-parse-buffer) 'superscript
'identity
)))
2132 (org-test-with-temp-text "a^{b}"
2133 (org-element-map (org-element-parse-buffer) 'superscript
'identity
)))
2134 ;; Multiple superscript in a paragraph.
2137 (org-test-with-temp-text "a^b and c^d"
2140 (org-element-parse-buffer) 'superscript
'identity
))))))
2145 (ert-deftest test-org-element
/table-parser
()
2146 "Test `table' parser."
2148 (org-test-with-temp-text "| a |"
2149 (org-element-map (org-element-parse-buffer) 'table
'identity
)))
2150 ;; TBLFM keyword is case insensitive.
2152 (org-test-with-temp-text "| a |\n#+tblfm: test"
2153 (org-element-property
2155 (org-element-map (org-element-parse-buffer) 'table
'identity nil t
))))
2156 ;; Handle multiple TBLFM lines.
2159 (org-test-with-temp-text "| a |\n#+TBLFM: test1\n#+TBLFM: test2"
2160 (length (org-element-property
2163 (org-element-parse-buffer) 'table
'identity nil t
))))))
2164 ;; Handle non-empty blank line at the end of buffer.
2166 (org-test-with-temp-text "| a |\n "
2167 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
2172 (ert-deftest test-org-element
/table-cell-parser
()
2173 "Test `table-cell' parser."
2174 ;; Regular table cell.
2176 (org-test-with-temp-text "| a |"
2177 (org-element-map (org-element-parse-buffer) 'table-cell
'identity
)))
2178 ;; Last vertical bar may be omitted.
2180 (org-test-with-temp-text "| a "
2181 (org-element-map (org-element-parse-buffer) 'table-cell
'identity
))))
2186 (ert-deftest test-org-element
/table-row-parser
()
2187 "Test `table-row' parser."
2189 (equal '(standard rule
)
2190 (org-test-with-temp-text "| a |\n|---|"
2192 (org-element-parse-buffer) 'table-row
2193 (lambda (row) (org-element-property :type row
)))))))
2198 (ert-deftest test-org-element
/target-parser
()
2199 "Test `target' parser."
2201 (org-test-with-temp-text "<<target>>"
2202 (org-element-map (org-element-parse-buffer) 'target
'identity
))))
2207 (ert-deftest test-org-element
/timestamp
()
2208 "Test `timestamp' parser."
2209 ;; Active timestamp.
2211 (org-test-with-temp-text "<2012-03-29 16:40>"
2212 (eq (org-element-property :type
(org-element-context)) 'active
)))
2214 (org-test-with-temp-text "<2012-03-29 Thu>"
2215 (let ((timestamp (org-element-context)))
2216 (or (org-element-property :hour-start timestamp
)
2217 (org-element-property :minute-start timestamp
)))))
2219 (equal '(2012 3 29 16 40)
2220 (org-test-with-temp-text "<2012-03-29 Thu 16:40>"
2221 (let ((object (org-element-context)))
2222 (list (org-element-property :year-start object
)
2223 (org-element-property :month-start object
)
2224 (org-element-property :day-start object
)
2225 (org-element-property :hour-start object
)
2226 (org-element-property :minute-start object
))))))
2227 ;; Inactive timestamp.
2229 (org-test-with-temp-text "[2012-03-29 Thu 16:40]"
2230 (eq (org-element-property :type
(org-element-context)) 'inactive
)))
2233 (equal '(2012 3 29 16 40 7 30)
2234 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
2235 (let ((object (org-element-context)))
2236 (list (org-element-property :year-end object
)
2237 (org-element-property :month-end object
)
2238 (org-element-property :day-end object
)
2239 (org-element-property :hour-end object
)
2240 (org-element-property :minute-end object
)
2241 (org-element-property :hour-start object
)
2242 (org-element-property :minute-start object
))))))
2245 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
2246 (org-element-property :type
(org-element-context)))))
2249 (org-test-with-temp-text "[2012-03-29 Thu 16:40]--[2012-03-29 Thu 16:41]"
2250 (eq (org-element-property :type
(org-element-context)) 'inactive-range
)))
2252 (org-test-with-temp-text "[2011-07-14 Thu]--[2012-03-29 Thu]"
2253 (let ((timestamp (org-element-context)))
2254 (or (org-element-property :hour-end timestamp
)
2255 (org-element-property :minute-end timestamp
)))))
2256 ;; With repeater, warning delay and both.
2259 (org-test-with-temp-text "<2012-03-29 Thu ++1y>"
2260 (org-element-property :repeater-type
(org-element-context)))))
2263 (org-test-with-temp-text "<2012-03-29 Thu --1y>"
2264 (org-element-property :warning-type
(org-element-context)))))
2266 (equal '(cumulate all
)
2267 (org-test-with-temp-text "<2012-03-29 Thu +1y -1y>"
2268 (let ((ts (org-element-context)))
2269 (list (org-element-property :repeater-type ts
)
2270 (org-element-property :warning-type ts
)))))))
2275 (ert-deftest test-org-element
/underline-parser
()
2276 "Test `underline' parser."
2279 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2280 (org-test-with-temp-text "_underline_"
2281 (org-element-map (org-element-parse-buffer) 'underline
'identity
))))
2282 ;; Multi-line markup.
2285 (org-element-contents
2286 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2287 (org-test-with-temp-text "_first line\nsecond line_"
2289 (org-element-parse-buffer) 'underline
'identity nil t
))))
2290 '("first line\nsecond line"))))
2295 (ert-deftest test-org-element
/verbatim-parser
()
2296 "Test `verbatim' parser."
2299 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2300 (org-test-with-temp-text "=verbatim="
2301 (org-element-map (org-element-parse-buffer) 'verbatim
'identity
))))
2302 ;; Multi-line markup.
2305 (org-element-property
2307 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2308 (org-test-with-temp-text "=first line\nsecond line="
2310 (org-element-parse-buffer) 'verbatim
'identity nil t
))))
2311 "first line\nsecond line")))
2316 (ert-deftest test-org-element
/verse-block-parser
()
2317 "Test `verse-block' parser."
2320 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
2321 (org-element-map (org-element-parse-buffer) 'verse-block
'identity
)))
2324 (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
2325 (org-element-map (org-element-parse-buffer) 'verse-block
'identity
)))
2326 ;; Parse objects in verse blocks.
2328 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
2329 (org-element-map (org-element-parse-buffer) 'entity
'identity
)))
2330 ;; Ignore incomplete verse block.
2332 (org-test-with-temp-text "#+BEGIN_VERSE"
2333 (org-element-map (org-element-parse-buffer) 'verse-block
'identity nil t
)))
2334 ;; Handle non-empty blank line at the end of buffer.
2336 (org-test-with-temp-text "#+BEGIN_VERSE\nC\n#+END_VERSE\n "
2337 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
2341 ;;; Test Interpreters.
2343 (ert-deftest test-org-element
/interpret-data
()
2344 "Test `org-element-interpret-data' specifications."
2345 ;; Interpret simple affiliated keywords.
2348 (org-element-interpret-data
2349 '(org-data nil
(paragraph (:name
"para") "Paragraph")))
2350 "#+NAME: para\nParagraph\n"))
2351 ;; Interpret multiple affiliated keywords.
2354 (org-element-interpret-data
2355 '(org-data nil
(paragraph (:attr_ascii
("line2" "line1")) "Paragraph")))
2356 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
2357 ;; Interpret parsed affiliated keywords.
2360 (org-element-interpret-data
2361 '(org-data nil
(paragraph (:caption
(("caption"))) "Paragraph")))
2362 "#+CAPTION: caption\nParagraph\n"))
2363 ;; Interpret dual affiliated keywords.
2366 (org-element-interpret-data
2367 '(org-data nil
(paragraph (:caption
((("long") "short"))) "Paragraph")))
2368 "#+CAPTION[short]: long\nParagraph\n"))
2369 ;; Interpret multiple parsed dual keywords.
2372 (org-element-interpret-data
2373 '(org-data nil
(paragraph
2374 (:caption
((("l2") "s2") (("l1") "s1"))) "Paragraph")))
2375 "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph\n"))
2376 ;; Pseudo objects and elements are transparent.
2380 (org-element-interpret-data
2381 '(paragraph nil
(pseudo-object (:post-blank
1) "A") "B")))))
2384 (org-element-interpret-data
2386 (pseudo-element (:post-blank
1) (paragraph nil
"A"))
2387 (paragraph nil
"B"))))))
2389 (ert-deftest test-org-element
/center-block-interpreter
()
2390 "Test center block interpreter."
2392 (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
2393 "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
2395 (ert-deftest test-org-element
/drawer-interpreter
()
2396 "Test drawer interpreter."
2398 (equal (org-test-parse-and-interpret ":TEST:\nTest\n:END:")
2399 ":TEST:\nTest\n:END:\n")))
2401 (ert-deftest test-org-element
/dynamic-block-interpreter
()
2402 "Test dynamic block interpreter."
2404 (equal (org-test-parse-and-interpret
2405 "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
2406 "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
2408 (ert-deftest test-org-element
/footnote-definition-interpreter
()
2409 "Test footnote definition interpreter."
2410 (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
2412 (ert-deftest test-org-element
/headline-interpreter
()
2413 "Test headline and section interpreters."
2414 ;; 1. Standard test.
2415 (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
2416 ;; 2. With TODO keywords.
2418 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2419 (org-test-parse-and-interpret "* TODO Headline"))
2420 "* TODO Headline\n"))
2423 ;; 3.1. ... and a positive `org-tags-column' value.
2425 (equal (let ((org-tags-column 20))
2426 (org-test-parse-and-interpret "* Headline :tag:"))
2427 "* Headline :tag:\n"))
2428 ;; 3.2. ... and a negative `org-tags-column' value.
2430 (equal (let ((org-tags-column -
20))
2431 (org-test-parse-and-interpret "* Headline :tag:"))
2432 "* Headline :tag:\n"))
2433 ;; 3.3. ... and a null `org-tags-column' value.
2435 (equal (let ((org-tags-column 0))
2436 (org-test-parse-and-interpret "* Headline :tag:"))
2437 "* Headline :tag:\n"))
2438 ;; 4. With priority cookie.
2440 (equal (org-test-parse-and-interpret "* [#B] Headline")
2441 "* [#B] Headline\n"))
2442 ;; 5. With comment keyword.
2444 (equal (let ((org-comment-string "COMMENT"))
2445 (org-test-parse-and-interpret "* COMMENT Headline"))
2446 "* COMMENT Headline\n"))
2447 ;; 6. Keep same number of blank lines before body.
2449 (equal (org-test-parse-and-interpret
2450 "* Headline\n\n\nText after two blank lines.")
2451 "* Headline\n\n\nText after two blank lines.\n"))
2452 ;; 8. Preserve `org-odd-levels-only' state.
2454 (equal "* H\n*** H2\n"
2455 (let ((org-odd-levels-only t
))
2456 (org-test-parse-and-interpret "* H\n*** H2")))))
2458 (ert-deftest test-org-element
/inlinetask-interpreter
()
2459 "Test inlinetask interpretation."
2460 (when (featurep 'org-inlinetask
)
2461 (let ((org-inlinetask-min-level 15))
2462 ;; 1. Regular inlinetask.
2463 (should (equal (org-test-parse-and-interpret
2464 "*************** Task\nTest\n*************** END")
2465 "*************** Task\nTest\n*************** END\n"))
2466 ;; 2. Degenerate inlinetask.
2467 (should (equal (org-test-parse-and-interpret "*************** Task")
2468 "*************** Task\n"))
2469 ;; 3. Prefer degenerate form when there are no contents.
2470 (should (equal (org-test-parse-and-interpret
2471 "*************** Task\n*************** END")
2472 "*************** Task\n"))
2473 ;; 4. With TODO keywords.
2475 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2476 (org-test-parse-and-interpret "*************** TODO Task"))
2477 "*************** TODO Task\n"))
2480 ;; 5.1. ... and a positive `org-tags-column' value.
2482 (equal (let ((org-tags-column 30))
2483 (org-test-parse-and-interpret "*************** Task :tag:"))
2484 "*************** Task :tag:\n"))
2485 ;; 5.2. ... and a negative `org-tags-column' value.
2487 (equal (let ((org-tags-column -
30))
2488 (org-test-parse-and-interpret "*************** Task :tag:"))
2489 "*************** Task :tag:\n"))
2490 ;; 5.3. ... and a null `org-tags-column' value.
2492 (equal (let ((org-tags-column 0))
2493 (org-test-parse-and-interpret "*************** Task :tag:"))
2494 "*************** Task :tag:\n"))
2495 ;; 6. With priority cookie.
2497 (equal (org-test-parse-and-interpret "*************** [#B] Task")
2498 "*************** [#B] Task\n")))))
2500 (ert-deftest test-org-element
/plain-list-interpreter
()
2501 "Test plain-list and item interpreters."
2502 (let ((org-list-two-spaces-after-bullet-regexp nil
))
2504 (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
2505 ;; Description list.
2507 (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
2510 (equal (let ((org-plain-list-ordered-item-terminator t
))
2511 (org-test-parse-and-interpret "1. Item"))
2514 (equal (let ((org-plain-list-ordered-item-terminator ?\
)))
2515 (org-test-parse-and-interpret "1) Item"))
2517 ;; Ordered list with counter.
2519 (equal (let ((org-plain-list-ordered-item-terminator t
))
2520 (org-test-parse-and-interpret "1. [@5] Item"))
2522 ;; List with check-boxes.
2524 (equal (org-test-parse-and-interpret
2525 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
2526 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n"))
2527 ;; Item not starting with a paragraph.
2529 (equal (org-test-parse-and-interpret "-\n | a | b |")
2530 "- \n | a | b |\n"))
2531 ;; Special case: correctly handle "*" bullets.
2532 (should (org-test-parse-and-interpret " * item"))
2533 ;; Special case: correctly handle empty items.
2534 (should (org-test-parse-and-interpret "-"))))
2536 (ert-deftest test-org-element
/quote-block-interpreter
()
2537 "Test quote block interpreter."
2538 (should (equal (org-test-parse-and-interpret
2539 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
2540 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
2542 (ert-deftest test-org-element
/special-block-interpreter
()
2543 "Test special block interpreter."
2544 (should (equal (org-test-parse-and-interpret
2545 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
2546 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
2548 (ert-deftest test-org-element
/babel-call-interpreter
()
2549 "Test Babel call interpreter."
2550 ;; Without argument.
2551 (should (equal (org-test-parse-and-interpret "#+CALL: test()")
2552 "#+CALL: test()\n"))
2554 (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
2555 "#+CALL: test(x=2)\n"))
2556 ;; With header arguments.
2557 (should (equal (org-test-parse-and-interpret
2558 "#+CALL: test[:results output]() :results html")
2559 "#+CALL: test[:results output]() :results html\n")))
2561 (ert-deftest test-org-element
/clock-interpreter
()
2562 "Test clock interpreter."
2566 "CLOCK: \\[2012-01-01 .* 00:01\\]"
2567 (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]")))
2571 "CLOCK: \\[2012-01-01 .* 00:01\\]--\\[2012-01-01 .* 00:02\\] => 0:01"
2572 (org-test-parse-and-interpret "
2573 CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))))
2575 (ert-deftest test-org-element
/comment-interpreter
()
2576 "Test comment interpreter."
2578 (should (equal (org-test-parse-and-interpret "# Comment") "# Comment\n"))
2580 (should (equal (org-test-parse-and-interpret " # Comment")
2582 ;; Preserve indentation.
2583 (should (equal (org-test-parse-and-interpret " # No blank\n# One blank")
2584 "# No blank\n# One blank\n")))
2586 (ert-deftest test-org-element
/comment-block-interpreter
()
2587 "Test comment block interpreter."
2588 (should (equal (org-test-parse-and-interpret
2589 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
2590 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n"))
2591 ;; Accept missing final newline in value.
2594 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n"
2595 (org-element-interpret-data '(comment-block (:value
"Test"))))))
2597 (ert-deftest test-org-element
/diary-sexp
()
2598 "Test diary-sexp interpreter."
2601 (org-test-parse-and-interpret
2602 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old")
2603 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old\n")))
2605 (ert-deftest test-org-element
/example-block-interpreter
()
2606 "Test example block interpreter."
2607 ;; Without switches.
2608 (should (equal (org-test-parse-and-interpret
2609 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
2610 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
2613 (equal (org-test-parse-and-interpret
2614 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
2615 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n"))
2616 ;; Preserve code escaping.
2618 (equal (org-test-parse-and-interpret
2619 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE")
2620 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE\n"))
2621 ;; Accept missing final newline in value.
2624 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"
2625 (org-element-interpret-data '(example-block (:value
"Test"))))))
2627 (ert-deftest test-org-element
/export-block-interpreter
()
2628 "Test export block interpreter."
2629 (should (equal (org-test-parse-and-interpret
2630 "#+BEGIN_HTML\nTest\n#+END_HTML")
2631 "#+BEGIN_HTML\nTest\n#+END_HTML\n")))
2633 (ert-deftest test-org-element
/fixed-width-interpreter
()
2634 "Test fixed width interpreter."
2636 (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
2637 ;; Preserve indentation.
2638 (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
2639 ": 2 blanks\n: 1 blank\n"))
2640 ;; Remove last newline character
2642 (equal (org-element-fixed-width-interpreter
2643 '(fixed-width (:value
"Test\n")) nil
)
2646 (equal (org-element-fixed-width-interpreter
2647 '(fixed-width (:value
"Test")) nil
)
2649 ;; Handle empty string.
2651 (equal (org-element-fixed-width-interpreter
2652 '(fixed-width (:value
"")) nil
)
2654 ;; Handle nil value.
2656 (org-element-fixed-width-interpreter
2657 '(fixed-width (:value nil
)) nil
)))
2659 (ert-deftest test-org-element
/horizontal-rule-interpreter
()
2660 "Test horizontal rule interpreter."
2661 (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
2663 (ert-deftest test-org-element
/keyword-interpreter
()
2664 "Test keyword interpreter."
2665 (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
2666 "#+KEYWORD: value\n")))
2668 (ert-deftest test-org-element
/latex-environment-interpreter
()
2669 "Test latex environment interpreter."
2670 (should (equal (org-test-parse-and-interpret
2671 "\\begin{equation}\n1+1=2\n\\end{equation}")
2672 "\\begin{equation}\n1+1=2\n\\end{equation}\n"))
2673 (should (equal (org-test-parse-and-interpret
2674 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}")
2675 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}\n")))
2677 (ert-deftest test-org-element
/planning-interpreter
()
2678 "Test planning interpreter."
2682 DEADLINE: <2012-03-29 .*?> SCHEDULED: <2012-03-29 .*?> CLOSED: \\[2012-03-29 .*?\\]"
2683 (org-test-parse-and-interpret
2685 DEADLINE: <2012-03-29 thu.> SCHEDULED: <2012-03-29 thu.> CLOSED: [2012-03-29 thu.]"))))
2687 (ert-deftest test-org-element
/property-drawer-interpreter
()
2688 "Test property drawer interpreter."
2689 (should (equal (let ((org-property-format "%-10s %s"))
2690 (org-test-parse-and-interpret
2691 "* H\n:PROPERTIES:\n:prop: value\n:END:"))
2692 "* H\n:PROPERTIES:\n:prop: value\n:END:\n")))
2694 (ert-deftest test-org-element
/src-block-interpreter
()
2695 "Test src block interpreter."
2698 (equal (let ((org-edit-src-content-indentation 2)
2699 (org-src-preserve-indentation nil
))
2700 (org-test-parse-and-interpret
2701 "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC"))
2702 "#+BEGIN_SRC emacs-lisp :results silent\n (+ 1 1)\n#+END_SRC\n"))
2705 (equal (let ((org-edit-src-content-indentation 2)
2706 (org-src-preserve-indentation nil
))
2707 (org-test-parse-and-interpret
2708 "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC"))
2709 "#+BEGIN_SRC emacs-lisp -n -k\n (+ 1 1)\n#+END_SRC\n"))
2710 ;; Preserve code escaping.
2712 (equal (let ((org-edit-src-content-indentation 2)
2713 (org-src-preserve-indentation nil
))
2714 (org-test-parse-and-interpret
2715 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC"))
2716 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC\n"))
2717 ;; Do not apply `org-edit-src-content-indentation' when preserving
2720 (equal (let ((org-edit-src-content-indentation 2)
2721 (org-src-preserve-indentation t
))
2722 (org-test-parse-and-interpret
2723 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"))
2724 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n"))
2726 (equal (let ((org-edit-src-content-indentation 2)
2727 (org-src-preserve-indentation nil
))
2728 (org-test-parse-and-interpret
2729 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"))
2730 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC\n"))
2731 ;; Accept missing final newline in value.
2734 "#+BEGIN_SRC emacs-lisp\n Test\n#+END_SRC\n"
2735 (let ((org-edit-src-content-indentation 2)
2736 (org-src-preserve-indentation nil
))
2737 (org-element-interpret-data
2738 '(src-block (:language
"emacs-lisp" :value
"Test")))))))
2740 (ert-deftest test-org-element
/table-interpreter
()
2741 "Test table, table-row and table-cell interpreters."
2743 (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
2744 "| a | b |\n| c | d |\n"))
2745 ;; 2. With horizontal rules.
2746 (should (equal (org-test-parse-and-interpret
2747 "| a | b |\n|---+---|\n| c | d |")
2748 "| a | b |\n|---+---|\n| c | d |\n"))
2749 ;; 3. With meta-data.
2750 (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
2751 "| / | < | > |\n| * | 1 | 2 |\n"))
2752 ;; 4. With a formula.
2754 (equal (org-test-parse-and-interpret
2755 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)")
2756 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)\n"))
2757 ;; 5. With multiple formulas.
2759 (equal (org-test-parse-and-interpret
2760 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2")
2761 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2\n")))
2763 (ert-deftest test-org-element
/timestamp-interpreter
()
2764 "Test timestamp interpreter."
2767 (string-match "<2012-03-29 .* 16:40>"
2768 (org-test-parse-and-interpret "<2012-03-29 thu. 16:40>")))
2770 (string-match "<2012-03-29 .* 16:40>"
2771 (org-element-timestamp-interpreter
2773 (:type active
:year-start
2012 :month-start
3 :day-start
29
2774 :hour-start
16 :minute-start
40)) nil
)))
2777 (string-match "\\[2012-03-29 .* 16:40\\]"
2778 (org-test-parse-and-interpret "[2012-03-29 thu. 16:40]")))
2781 "\\[2012-03-29 .* 16:40\\]"
2782 (org-element-timestamp-interpreter
2784 (:type inactive
:year-start
2012 :month-start
3 :day-start
29
2785 :hour-start
16 :minute-start
40)) nil
)))
2788 (string-match "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2789 (org-test-parse-and-interpret
2790 "<2012-03-29 thu. 16:40>--<2012-03-29 thu. 16:41>")))
2793 "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2794 (org-element-timestamp-interpreter
2796 (:type active-range
:year-start
2012 :month-start
3 :day-start
29
2797 :hour-start
16 :minute-start
40 :year-end
2012 :month-end
3
2798 :day-end
29 :hour-end
16 :minute-end
41)) nil
)))
2801 (string-match "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2802 (org-test-parse-and-interpret
2803 "[2012-03-29 thu. 16:40]--[2012-03-29 thu. 16:41]")))
2806 "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2807 (org-element-timestamp-interpreter
2809 (:type inactive-range
:year-start
2012 :month-start
3 :day-start
29
2810 :hour-start
16 :minute-start
40 :year-end
2012 :month-end
3
2811 :day-end
29 :hour-end
16 :minute-end
41)) nil
)))
2813 (should (equal (org-test-parse-and-interpret "<%%diary-float t 4 2>")
2814 "<%%diary-float t 4 2>\n"))
2815 ;; Timestamp with repeater interval, with delay, with both.
2817 (string-match "<2012-03-29 .* \\+1y>"
2818 (org-test-parse-and-interpret "<2012-03-29 thu. +1y>")))
2821 "<2012-03-29 .* \\+1y>"
2822 (org-element-timestamp-interpreter
2824 (:type active
:year-start
2012 :month-start
3 :day-start
29
2825 :repeater-type cumulate
:repeater-value
1 :repeater-unit year
))
2829 "<2012-03-29 .* -1y>"
2830 (org-element-timestamp-interpreter
2832 (:type active
:year-start
2012 :month-start
3 :day-start
29
2833 :warning-type all
:warning-value
1 :warning-unit year
))
2837 "<2012-03-29 .* \\+1y -1y>"
2838 (org-element-timestamp-interpreter
2840 (:type active
:year-start
2012 :month-start
3 :day-start
29
2841 :warning-type all
:warning-value
1 :warning-unit year
2842 :repeater-type cumulate
:repeater-value
1 :repeater-unit year
))
2844 ;; Timestamp range with repeater interval
2846 (string-match "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2847 (org-test-parse-and-interpret
2848 "<2012-03-29 Thu +1y>--<2012-03-30 Thu +1y>")))
2851 "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2852 (org-element-timestamp-interpreter
2854 (:type active-range
:year-start
2012 :month-start
3 :day-start
29
2855 :year-end
2012 :month-end
3 :day-end
30 :repeater-type cumulate
2856 :repeater-value
1 :repeater-unit year
))
2859 (ert-deftest test-org-element
/verse-block-interpreter
()
2860 "Test verse block interpretation."
2862 (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
2863 "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
2865 (ert-deftest test-org-element
/bold-interpreter
()
2866 "Test bold interpreter."
2867 (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
2869 (ert-deftest test-org-element
/code-interpreter
()
2870 "Test code interpreter."
2871 (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
2873 (ert-deftest test-org-element
/entity-interpreter
()
2874 "Test entity interpreter."
2875 ;; 1. Without brackets.
2877 (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
2878 ;; 2. With brackets.
2880 (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
2882 (ert-deftest test-org-element
/export-snippet-interpreter
()
2883 "Test export snippet interpreter."
2884 (should (equal (org-test-parse-and-interpret "@@back-end:contents@@")
2885 "@@back-end:contents@@\n")))
2887 (ert-deftest test-org-element
/footnote-reference-interpreter
()
2888 "Test footnote reference interpreter."
2889 ;; 1. Regular reference.
2890 (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
2891 ;; 2. Normalized reference.
2892 (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
2893 ;; 3. Named reference.
2894 (should (equal (org-test-parse-and-interpret "Text[fn:label]")
2895 "Text[fn:label]\n"))
2896 ;; 4. Inline reference.
2897 (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
2898 "Text[fn:label:def]\n"))
2899 ;; 5. Anonymous reference.
2900 (should (equal (org-test-parse-and-interpret "Text[fn::def]")
2901 "Text[fn::def]\n")))
2903 (ert-deftest test-org-element
/inline-babel-call-interpreter
()
2904 "Test inline babel call interpreter."
2905 ;; Without arguments.
2906 (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
2908 (should (equal (org-test-parse-and-interpret "call_test(x=2)")
2909 "call_test(x=2)\n"))
2910 ;; With header arguments.
2911 (should (equal (org-test-parse-and-interpret
2912 "call_test[:results output]()[:results html]")
2913 "call_test[:results output]()[:results html]\n")))
2915 (ert-deftest test-org-element
/inline-src-block-interpreter
()
2916 "Test inline src block interpreter."
2917 ;; 1. Without header argument.
2918 (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
2919 "src_emacs-lisp{(+ 1 1)}\n"))
2920 ;; 2. With header arguments.
2921 (should (equal (org-test-parse-and-interpret
2922 "src_emacs-lisp[:results silent]{(+ 1 1)}")
2923 "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
2925 (ert-deftest test-org-element
/italic-interpreter
()
2926 "Test italic interpreter."
2927 (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
2929 (ert-deftest test-org-element
/latex-fragment-interpreter
()
2930 "Test latex fragment interpreter."
2931 (should (equal (org-test-parse-and-interpret "\\command{}") "\\command{}\n"))
2932 (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
2933 (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
2934 (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
2935 (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
2936 (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n")))
2938 (ert-deftest test-org-element
/line-break-interpreter
()
2939 "Test line break interpreter."
2940 (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
2941 "First line \\\\\nSecond line\n")))
2943 (ert-deftest test-org-element
/link-interpreter
()
2944 "Test link interpreter."
2945 ;; 1. Links targeted from a radio target.
2946 (should (equal (let ((org-target-link-regexp "radio-target"))
2947 (org-test-parse-and-interpret "a radio-target"))
2948 "a radio-target\n"))
2949 ;; 2. Regular links.
2951 ;; 2.1. Without description.
2952 (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
2953 "[[http://orgmode.org]]\n"))
2954 ;; 2.2. With a description.
2955 (should (equal (org-test-parse-and-interpret
2956 "[[http://orgmode.org][Org mode]]")
2957 "[[http://orgmode.org][Org mode]]\n"))
2959 (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
2960 ;; 2.4. Custom-id links.
2961 (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
2962 ;; 2.5 Code-ref links.
2963 (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
2964 ;; 3. Normalize plain links.
2965 (should (equal (org-test-parse-and-interpret "http://orgmode.org")
2966 "[[http://orgmode.org]]\n"))
2967 ;; 4. Normalize angular links.
2968 (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
2969 "[[http://orgmode.org]]\n")))
2971 (ert-deftest test-org-element
/macro-interpreter
()
2972 "Test macro interpreter."
2973 ;; 1. Without argument.
2974 (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
2975 ;; 2. With arguments.
2976 (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
2977 "{{{test(arg1,arg2)}}}\n")))
2979 (ert-deftest test-org-element
/radio-target-interpreter
()
2980 "Test radio target interpreter."
2981 (should (equal (org-test-parse-and-interpret "<<<some text>>>")
2982 "<<<some text>>>\n")))
2984 (ert-deftest test-org-element
/statistics-cookie-interpreter
()
2985 "Test statistics cookie interpreter."
2986 ;; 1. Without percent
2987 (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
2989 (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
2991 (ert-deftest test-org-element
/strike-through-interpreter
()
2992 "Test strike through interpreter."
2993 (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
2995 (ert-deftest test-org-element
/subscript-interpreter
()
2996 "Test subscript interpreter."
2997 ;; 1. Without brackets.
2998 (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
2999 ;; 2. With brackets.
3000 (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
3002 (ert-deftest test-org-element
/superscript-interpreter
()
3003 "Test superscript interpreter."
3004 ;; 1. Without brackets.
3005 (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
3006 ;; 2. With brackets.
3007 (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
3009 (ert-deftest test-org-element
/target-interpreter
()
3010 "Test target interpreter."
3011 (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
3013 (ert-deftest test-org-element
/underline-interpreter
()
3014 "Test underline interpreter."
3015 (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
3017 (ert-deftest test-org-element
/verbatim-interpreter
()
3018 "Test verbatim interpreter."
3019 (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
3023 ;;; Test Granularity
3025 (ert-deftest test-org-element
/granularity
()
3026 "Test granularity impact on buffer parsing."
3027 (org-test-with-temp-text "
3034 ;; 1.1. Granularity set to `headline' should parse every headline
3035 ;; in buffer, and only them.
3036 (let ((tree (org-element-parse-buffer 'headline
)))
3037 (should (= 2 (length (org-element-map tree
'headline
'identity
))))
3038 (should-not (org-element-map tree
'paragraph
'identity
)))
3039 ;; 1.2. Granularity set to `greater-element' should not enter
3040 ;; greater elements excepted headlines and sections.
3041 (let ((tree (org-element-parse-buffer 'greater-element
)))
3042 (should (= 1 (length (org-element-map tree
'center-block
'identity
))))
3043 (should (= 1 (length (org-element-map tree
'paragraph
'identity
))))
3044 (should-not (org-element-map tree
'entity
'identity
)))
3045 ;; 1.3. Granularity set to `element' should enter every
3047 (let ((tree (org-element-parse-buffer 'element
)))
3048 (should (= 2 (length (org-element-map tree
'paragraph
'identity
))))
3049 (should-not (org-element-map tree
'entity
'identity
)))
3050 ;; 1.4. Granularity set to `object' can see everything.
3051 (let ((tree (org-element-parse-buffer 'object
)))
3052 (should (= 1 (length (org-element-map tree
'entity
'identity
)))))))
3054 (ert-deftest test-org-element
/secondary-string-parsing
()
3055 "Test if granularity correctly toggles secondary strings parsing."
3056 ;; With a granularity bigger than `object', no secondary string
3057 ;; should be parsed.
3060 (org-test-with-temp-text "* Headline"
3062 (org-element-map (org-element-parse-buffer 'headline
) 'headline
3063 #'identity nil
'first-match
)))
3064 (org-element-property :title headline
)))))
3067 (org-test-with-temp-text "* Headline\n- tag :: item"
3068 (let ((item (org-element-map (org-element-parse-buffer 'element
) 'item
3069 #'identity nil
'first-match
)))
3070 (org-element-property :tag item
)))))
3071 (when (featurep 'org-inlinetask
)
3074 (let ((org-inlinetask-min-level 15))
3075 (org-test-with-temp-text "*************** Inlinetask"
3076 (let ((inlinetask (org-element-map (org-element-parse-buffer 'element
)
3078 #'identity nil
'first-match
)))
3079 (org-element-property :title inlinetask
)))))))
3080 ;; With a default granularity, secondary strings should be parsed.
3083 (org-test-with-temp-text "* Headline"
3085 (org-element-map (org-element-parse-buffer) 'headline
3086 #'identity nil
'first-match
)))
3087 (org-element-property :title headline
)))))
3088 ;; `org-element-at-point' should never parse a secondary string.
3091 (org-test-with-temp-text "* Headline"
3092 (org-element-property :title
(org-element-at-point)))))
3093 ;; Preserve current local variables when parsing a secondary string.
3095 (let ((org-entities nil
)
3096 (org-entities-user nil
))
3097 (org-test-with-temp-text "
3101 # org-entities-user: ((\"foo\"))
3103 (let ((safe-local-variable-values '((org-entities-user .
(("foo"))))))
3104 (hack-local-variables))
3105 (org-element-map (org-element-parse-buffer) 'entity
3106 #'identity nil nil nil t
)))))
3110 ;;; Test Visible Only Parsing
3112 (ert-deftest test-org-element
/parse-buffer-visible
()
3113 "Test `org-element-parse-buffer' with visible only argument."
3115 (equal '("H1" "H3" "H5")
3116 (org-test-with-temp-text
3117 "* H1\n** H2\n** H3 :visible:\n** H4\n** H5 :visible:"
3118 (org-occur ":visible:")
3119 (org-element-map (org-element-parse-buffer nil t
) 'headline
3120 (lambda (hl) (org-element-property :raw-value hl
)))))))
3124 ;;; Test `:parent' Property
3126 (ert-deftest test-org-element
/parent-property
()
3127 "Test `:parent' property."
3129 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
3130 (let* ((tree (org-element-parse-buffer))
3131 (parent (org-element-property
3133 (org-element-map tree
'paragraph
'identity nil t
))))
3135 (should (eq (org-element-map tree
'center-block
'identity nil t
)
3138 (org-test-with-temp-text "a_{/b/}"
3139 (let* ((tree (org-element-parse-buffer))
3140 (parent (org-element-property
3142 (org-element-map tree
'italic
'identity nil t
))))
3145 (org-element-map tree
'subscript
'identity nil t
)))))
3146 ;; Secondary strings
3147 (org-test-with-temp-text "* /italic/"
3148 (let* ((tree (org-element-parse-buffer))
3149 (parent (org-element-property
3150 :parent
(org-element-map tree
'italic
'identity nil t
))))
3153 (org-element-map tree
'headline
'identity nil t
))))))
3157 ;;; Test Normalize Contents
3159 (ert-deftest test-org-element
/normalize-contents
()
3160 "Test `org-element-normalize-contents' specifications."
3161 ;; Remove maximum common indentation from element's contents.
3164 (org-element-normalize-contents
3165 '(paragraph nil
" Two spaces\n Three spaces"))
3166 '(paragraph nil
"Two spaces\n Three spaces")))
3167 ;; Ignore objects within contents when computing maximum common
3168 ;; indentation. However, if contents start with an object, common
3169 ;; indentation is 0.
3172 (org-element-normalize-contents
3173 '(paragraph nil
" One " (emphasis nil
"space") "\n Two spaces"))
3174 '(paragraph nil
"One " (emphasis nil
"space") "\n Two spaces")))
3177 (org-element-normalize-contents
3178 '(paragraph nil
(verbatim nil
"V") "No space\n Two\n Three"))
3179 '(paragraph nil
(verbatim nil
"V") "No space\n Two\n Three")))
3180 ;; Ignore blank lines.
3183 (org-element-normalize-contents
3184 '(paragraph nil
" Two spaces\n\n \n Two spaces"))
3185 '(paragraph nil
"Two spaces\n\n \nTwo spaces")))
3188 '(paragraph nil
" Two spaces\n" (verbatim nil
"V") "\n Two spaces")
3189 (org-element-normalize-contents
3190 '(paragraph nil
" Two spaces\n " (verbatim nil
"V") "\n Two spaces"))))
3193 '(verse-block nil
"line 1\n\nline 2")
3194 (org-element-normalize-contents
3195 '(verse-block nil
" line 1\n\n line 2"))))
3196 ;; Recursively enter objects in order to compute common indentation.
3199 (org-element-normalize-contents
3200 '(paragraph nil
" Two spaces " (bold nil
" and\n One space")))
3201 '(paragraph nil
" Two spaces " (bold nil
" and\nOne space"))))
3202 ;; When optional argument is provided, ignore first line
3206 (org-element-normalize-contents
3207 '(paragraph nil
"No space\n Two spaces\n Three spaces") t
)
3208 '(paragraph nil
"No space\nTwo spaces\n Three spaces")))
3211 (org-element-normalize-contents
3212 '(paragraph nil
(verbatim nil
"V") "No space\n Two\n Three") t
)
3213 '(paragraph nil
(verbatim nil
"V") "No space\nTwo\n Three")))
3214 ;; Corner case: do not ignore indentation of string right after
3218 (org-element-normalize-contents
3219 '(paragraph nil
" 1 space" (line-break) " 2 spaces"))
3220 '(paragraph nil
"1 space" (line-break) " 2 spaces"))))
3224 ;;; Test Navigation Tools.
3226 (ert-deftest test-org-element
/at-point
()
3227 "Test `org-element-at-point' specifications."
3228 ;; Return closest element containing point.
3231 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
3232 (progn (search-forward "A")
3233 (org-element-type (org-element-at-point))))))
3234 ;; Correctly set `:parent' property.
3237 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
3238 (progn (search-forward "A")
3240 (org-element-property :parent
(org-element-at-point)))))))
3241 ;; Special case: at a blank line just below a headline, return that
3244 (equal "H1" (org-test-with-temp-text "* H1\n \n* H2\n"
3246 (org-element-property :title
(org-element-at-point)))))
3247 ;; Special case: at the very beginning of a table, return `table'
3248 ;; object instead of `table-row'.
3251 (org-test-with-temp-text "| a | b |"
3252 (org-element-type (org-element-at-point)))))
3253 ;; Special case: at the very beginning of a list or sub-list, return
3254 ;; `plain-list' object instead of `item'.
3257 (org-test-with-temp-text "- item"
3258 (org-element-type (org-element-at-point)))))
3259 ;; Special case: at the closing line of a greater element, be sure
3260 ;; to return it instead of the last element in its contents.
3263 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph\n#+END_CENTER"
3264 (progn (forward-line 2)
3265 (org-element-type (org-element-at-point))))))
3266 ;; Special case: at a blank line between two items, be sure to
3267 ;; return item above instead of the last element of its contents.
3270 (org-test-with-temp-text "- Para1\n\n- Para2"
3272 (org-element-type (org-element-at-point)))))
3273 ;; Special case: at the last blank line in a plain list, return it
3274 ;; instead of the last item.
3277 (org-test-with-temp-text "- Para1\n- Para2\n\nPara3"
3278 (progn (forward-line 2)
3279 (org-element-type (org-element-at-point))))))
3280 ;; Special case: when a list ends at the end of buffer and there's
3281 ;; no final newline, return last element in last item.
3284 (org-test-with-temp-text "- a"
3286 (org-element-type (org-element-at-point)))))
3287 ;; Parse a list within a block itself contained in a list.
3290 (org-test-with-temp-text
3291 "- outer\n #+begin_center\n - inner\n #+end_center"
3292 (search-forward "inner")
3294 (org-element-type (org-element-at-point)))))
3295 ;; Do not error at eob on an empty line.
3297 (org-test-with-temp-text "* H\n"
3299 (or (org-element-at-point) t
))))
3301 (ert-deftest test-org-element
/context
()
3302 "Test `org-element-context' specifications."
3303 ;; Return closest object containing point.
3306 (org-test-with-temp-text "Some *text with _underline_ text*"
3307 (progn (search-forward "under")
3308 (org-element-type (org-element-context))))))
3309 ;; Find objects in secondary strings.
3312 (org-test-with-temp-text "* Headline _with_ underlining"
3313 (progn (search-forward "w")
3314 (org-element-type (org-element-context))))))
3315 ;; Find objects in objects.
3318 (org-test-with-temp-text "| a | {{{macro}}} |"
3319 (progn (search-forward "{")
3320 (org-element-type (org-element-context))))))
3323 (org-test-with-temp-text "| a | b {{{macro}}} |"
3324 (progn (search-forward "b")
3325 (org-element-type (org-element-context))))))
3326 ;; Find objects in planning lines.
3329 (org-test-with-temp-text "* H\n SCHEDULED: <2012-03-29 thu.>"
3330 (search-forward "2012")
3331 (org-element-type (org-element-context)))))
3334 (org-test-with-temp-text "* H\n SCHEDULED: <2012-03-29 thu.>"
3335 (search-forward "SCHEDULED")
3336 (org-element-type (org-element-context)))))
3337 ;; Do not find objects in table rules.
3340 (org-test-with-temp-text "| a | b |\n|-<point>--|---|\n| c | d |"
3341 (org-element-type (org-element-context)))))
3342 ;; Find objects in parsed affiliated keywords.
3345 (org-test-with-temp-text "#+CAPTION: {{{macro}}}\n| a | b |."
3346 (progn (search-forward "{")
3347 (org-element-type (org-element-context))))))
3350 (org-test-with-temp-text "#+caption: *bold*\nParagraph"
3351 (progn (search-forward "*")
3352 (org-element-type (org-element-context))))))
3353 ;; Find objects at the end of buffer.
3356 (org-test-with-temp-text "*bold*"
3357 (goto-char (point-max))
3358 (org-element-type (org-element-context)))))
3359 ;; Correctly set `:parent' property.
3362 (org-test-with-temp-text "Some *bold* text"
3363 (progn (search-forward "bold")
3365 (org-element-property :parent
(org-element-context)))))))
3366 ;; Between two objects, return the second one.
3369 (org-test-with-temp-text "<<target>>{{{test}}}"
3370 (progn (search-forward "{")
3372 (org-element-type (org-element-context))))))
3373 ;; Test optional argument.
3376 (org-test-with-temp-text "Some *text with _underline_ text*"
3378 (search-forward "under")
3379 (org-element-type (org-element-context (org-element-at-point)))))))
3380 ;; Special case: bold object at the beginning of a headline.
3383 (org-test-with-temp-text "* *bold*"
3384 (search-forward "bo")
3385 (org-element-type (org-element-context)))))
3386 ;; Special case: incomplete cell at the end of a table row.
3389 (org-test-with-temp-text "|a|b|c"
3390 (goto-char (point-max))
3391 (org-element-type (org-element-context)))))
3392 ;; Special case: objects in inline footnotes.
3395 (org-test-with-temp-text "[fn::[[<point>http://orgmode.org]]]"
3396 (org-element-type (org-element-context))))))
3402 (ert-deftest test-org-element
/lineage
()
3403 "Test `org-element-lineage' specifications."
3404 ;; Regular tests. When applied to an element or object returned by
3405 ;; `org-element-at-point' or `org-element-context', the list is
3406 ;; limited to the current section.
3408 (equal '(paragraph center-block
)
3409 (org-test-with-temp-text
3410 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3411 (mapcar #'car
(org-element-lineage (org-element-context))))))
3413 (equal '(paragraph center-block section headline headline org-data
)
3414 (org-test-with-temp-text
3415 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3417 (org-element-lineage
3418 (org-element-map (org-element-parse-buffer) 'bold
3419 #'identity nil t
))))))
3420 ;; Test TYPES optional argument.
3423 (org-test-with-temp-text
3424 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3426 (org-element-lineage (org-element-context) '(center-block))))))
3428 (org-test-with-temp-text
3429 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3430 (org-element-lineage (org-element-context) '(example-block))))
3431 ;; Test WITH-SELF optional argument.
3433 (equal '(bold paragraph center-block
)
3434 (org-test-with-temp-text
3435 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3436 (mapcar #'car
(org-element-lineage (org-element-context) nil t
)))))
3437 ;; When TYPES and WITH-SELF are provided, the latter is also checked
3438 ;; against the former.
3440 (org-test-with-temp-text
3441 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3442 (org-element-lineage (org-element-context) '(bold) t
))))
3448 (ert-deftest test-org-element
/cache
()
3449 "Test basic expectations and common pitfalls for cache."
3453 (org-test-with-temp-text "para1\n\npara2\n\npara3"
3454 (let ((org-element-use-cache t
))
3455 (save-excursion (goto-char (point-max)) (org-element-at-point))
3458 (let ((element (org-element-at-point)))
3459 (cons (org-element-property :begin element
)
3460 (org-element-property :end element
)))))))
3461 ;; Partial shifting: when the contents of a greater element are
3462 ;; modified, only shift ending positions.
3464 (org-test-with-temp-text
3465 "#+BEGIN_CENTER\nPara1\n\nPara2\n\nPara3\n#+END_CENTER"
3466 (let ((org-element-use-cache t
))
3467 (save-excursion (search-forward "3") (org-element-at-point))
3468 (search-forward "Para2")
3470 (let ((element (org-element-property :parent
(org-element-at-point))))
3471 (equal (cons (org-element-property :begin element
)
3472 (org-element-property :end element
))
3473 (cons (point-min) (point-max)))))))
3474 ;; Re-parent shifted elements.
3477 (org-test-with-temp-text "- item\n\n\n para1\n para2"
3478 (let ((org-element-use-cache t
))
3480 (org-element-at-point)
3481 (save-excursion (goto-char (point-max)) (org-element-at-point))
3484 (goto-char (point-max))
3486 (org-element-property :parent
(org-element-at-point)))))))
3487 ;; Preserve local structures when re-parenting.
3490 (org-test-with-temp-text
3491 "#+begin_center\nP0\n\n<point>\n\n P1\n | a | b |\n| c | d |\n#+end_center"
3492 (let ((org-element-use-cache t
))
3493 (save-excursion (search-forward "| c |") (org-element-at-point))
3495 (search-forward "| c |")
3498 (org-element-property :parent
(org-element-at-point)))))))
3501 (org-test-with-temp-text
3502 "#+begin_center\nP0\n\n<point>\n\n P1\n | a | b |\n#+end_center"
3503 (let ((org-element-use-cache t
))
3504 (save-excursion (search-forward "| a |") (org-element-at-point))
3506 (search-forward "| a |")
3509 (org-element-property :parent
(org-element-at-point)))))))
3510 ;; When re-parenting, also propagate changes to list structures.
3513 (org-test-with-temp-text "\n Para\n - item<point>"
3514 (let ((org-element-use-cache t
))
3515 (org-element-at-point)
3516 (goto-char (point-min))
3518 (search-forward "- item")
3520 (length (org-element-property :structure
(org-element-at-point)))))))
3521 ;; Modifying the last line of an element alters the element below.
3523 (org-test-with-temp-text "para1\n\npara2"
3524 (let ((org-element-use-cache t
))
3525 (goto-char (point-max))
3526 (org-element-at-point)
3529 (let ((element (org-element-at-point)))
3530 (equal (cons (org-element-property :begin element
)
3531 (org-element-property :end element
))
3532 (cons (point-min) (point-max)))))))
3533 ;; Modifying the first line of an element alters the element above.
3535 (org-test-with-temp-text ": fixed-width\n:not-fixed-width"
3536 (let ((org-element-use-cache t
))
3537 (goto-char (point-max))
3538 (org-element-at-point)
3539 (search-backward ":")
3542 (let ((element (org-element-at-point)))
3543 (equal (cons (org-element-property :begin element
)
3544 (org-element-property :end element
))
3545 (cons (point-min) (point-max)))))))
3546 ;; Sensitive change: adding a line alters document structure both
3550 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n"
3551 (let ((org-element-use-cache t
))
3552 (goto-char (point-max))
3553 (org-element-at-point)
3554 (insert "#+END_EXAMPLE")
3555 (search-backward "Para1")
3556 (org-element-type (org-element-at-point))))))
3559 (org-test-with-temp-text "Para1\n\nPara2\n#+END_EXAMPLE"
3560 (let ((org-element-use-cache t
))
3561 (save-excursion (goto-char (point-max)) (org-element-at-point))
3562 (insert "#+BEGIN_EXAMPLE\n")
3563 (search-forward "Para2")
3564 (org-element-type (org-element-at-point))))))
3565 ;; Sensitive change: removing a line alters document structure both
3569 (org-test-with-temp-text
3570 "# +BEGIN_EXAMPLE\nPara1\n\nPara2\n#+END_EXAMPLE"
3571 (let ((org-element-use-cache t
))
3572 (save-excursion (goto-char (point-max)) (org-element-at-point))
3575 (search-forward "Para2")
3576 (org-element-type (org-element-at-point))))))
3579 (org-test-with-temp-text
3580 "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n# +END_EXAMPLE"
3581 (let ((org-element-use-cache t
))
3582 (save-excursion (goto-char (point-max)) (org-element-at-point))
3583 (search-forward "# ")
3585 (search-backward "Para1")
3586 (org-element-type (org-element-at-point))))))
3587 ;; Corner case: watch out drawers named "PROPERTIES" as they are
3588 ;; fragile, unlike to other drawers.
3591 (org-test-with-temp-text "* H\n:PROPERTIES:\n:A: 1\n:A<point>\n:END:"
3592 (let ((org-element-use-cache t
))
3593 (org-element-at-point)
3595 (org-element-type (org-element-at-point))))))
3596 ;; Properly handle elements not altered by modifications but whose
3597 ;; parents were removed from cache.
3599 (org-test-with-temp-text
3600 "Paragraph\n\n\n\n#+begin_center\n<point>contents\n#+end_center"
3601 (let ((org-element-use-cache t
)
3602 (parent-end (point-max)))
3603 (org-element-at-point)
3604 (save-excursion (search-backward "Paragraph")
3607 (eq (org-element-property
3608 :end
(org-element-property :parent
(org-element-at-point)))
3609 (+ parent-end
3))))))
3612 (provide 'test-org-element
)
3614 ;;; test-org-element.el ends here