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))))
934 ;; Footnote with attributes.
937 (org-test-with-temp-text "#+attr_latex: :offset 0in\n[fn:1] A footnote."
939 (org-element-map (org-element-parse-buffer) 'footnote-definition
942 (org-test-with-temp-text "[fn:1] 1\n\n#+attr_latex: :offset 0in\n[fn:2] 2"
943 (goto-char (org-element-property :end
(org-element-at-point)))
947 ;;;; Footnotes Reference.
949 (ert-deftest test-org-element
/footnote-reference-parser
()
950 "Test `footnote-reference' parser."
951 ;; Parse a standard reference.
953 (org-test-with-temp-text "Text[fn:label]"
955 (org-element-parse-buffer) 'footnote-reference
'identity
)))
956 ;; Parse a normalized reference.
958 (org-test-with-temp-text "Text[1]"
960 (org-element-parse-buffer) 'footnote-reference
'identity
)))
961 ;; Parse an inline reference.
963 (org-test-with-temp-text "Text[fn:test:def]"
965 (org-element-parse-buffer) 'footnote-reference
'identity
)))
966 ;; Parse an anonymous reference.
968 (org-test-with-temp-text "Text[fn::def]"
970 (org-element-parse-buffer) 'footnote-reference
'identity
)))
971 ;; Parse nested footnotes.
975 (org-test-with-temp-text "Text[fn::def [fn:label]]"
977 (org-element-parse-buffer) 'footnote-reference
'identity
)))))
978 ;; Parse adjacent footnotes.
980 (org-test-with-temp-text "Text[fn:label1][fn:label2]"
984 (org-element-parse-buffer) 'footnote-reference
'identity
)))))
985 ;; Only properly closed footnotes are recognized as such.
987 (org-test-with-temp-text "Text[fn:label"
989 (org-element-parse-buffer) 'footnote-reference
'identity
))))
994 (ert-deftest test-org-element
/headline-comment-keyword
()
995 "Test COMMENT keyword recognition."
997 (org-test-with-temp-text "* Headline"
998 (let ((org-comment-string "COMMENT"))
999 (should-not (org-element-property :commentedp
(org-element-at-point)))))
1000 ;; Standard position.
1001 (org-test-with-temp-text "* COMMENT Headline"
1002 (let ((org-comment-string "COMMENT")
1003 (headline (org-element-at-point)))
1004 (should (org-element-property :commentedp headline
))
1005 (should (equal (org-element-property :raw-value headline
) "Headline"))))
1006 ;; Case sensitivity.
1007 (org-test-with-temp-text "* COMMENT Headline"
1008 (let* ((org-comment-string "Comment")
1009 (headline (org-element-at-point)))
1010 (should-not (org-element-property :commentedp headline
))
1011 (should (equal (org-element-property :raw-value headline
)
1012 "COMMENT Headline"))))
1013 ;; With another keyword.
1014 (org-test-with-temp-text "* TODO COMMENT Headline"
1015 (let* ((org-comment-string "COMMENT")
1016 (org-todo-keywords '((sequence "TODO" "DONE")))
1017 (headline (org-element-at-point)))
1018 (should (org-element-property :commentedp headline
))
1019 (should (equal (org-element-property :raw-value headline
) "Headline"))))
1020 ;; With the keyword only.
1021 (org-test-with-temp-text "* COMMENT"
1022 (let* ((org-comment-string "COMMENT")
1023 (headline (org-element-at-point)))
1024 (should (org-element-property :commentedp headline
))
1025 (should (equal (org-element-property :raw-value headline
) "")))))
1027 (ert-deftest test-org-element
/headline-archive-tag
()
1028 "Test ARCHIVE tag recognition."
1031 (org-test-with-temp-text "* Headline"
1032 (let ((org-archive-tag "ARCHIVE"))
1033 (org-element-property :archivedp
(org-element-at-point)))))
1035 (org-test-with-temp-text "* Headline :ARCHIVE:"
1036 (let ((org-archive-tag "ARCHIVE"))
1037 (let ((headline (org-element-at-point)))
1038 (should (org-element-property :archivedp headline
)))))
1040 (org-test-with-temp-text "* Headline :test:ARCHIVE:"
1041 (let ((org-archive-tag "ARCHIVE"))
1042 (let ((headline (org-element-at-point)))
1043 (should (org-element-property :archivedp headline
)))))
1044 ;; Tag is case-sensitive.
1046 (org-test-with-temp-text "* Headline :ARCHIVE:"
1047 (let ((org-archive-tag "Archive"))
1048 (org-element-property :archivedp
(org-element-at-point))))))
1050 (ert-deftest test-org-element
/headline-properties
()
1051 "Test properties from property drawer."
1052 ;; All properties from property drawer have their symbol upper
1055 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
1056 (org-element-property :FOO
(org-element-at-point))))
1058 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
1059 (org-element-property :foo
(org-element-at-point))))
1060 ;; Also parse properties associated in inlinetasks.
1061 (when (featurep 'org-inlinetask
)
1063 (org-test-with-temp-text "*************** Inlinetask
1067 *************** END"
1068 (org-element-property :FOO
(org-element-at-point)))))
1069 ;; Do not find property drawer in a verbatim area.
1071 (org-test-with-temp-text
1078 (org-element-property :FOO
(org-element-at-point))))
1079 ;; Do not use properties from a drawer associated to an inlinetask.
1080 (when (featurep 'org-inlinetask
)
1082 (org-test-with-temp-text
1084 *************** Inlinetask
1088 *************** END"
1089 (org-element-property
1090 :FOO
(let ((org-inlinetask-min-level 15)) (org-element-at-point))))))
1091 ;; Do not find incomplete drawers.
1093 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar"
1094 (org-element-property :FOO
(org-element-at-point)))))
1097 ;;;; Horizontal Rule
1099 (ert-deftest test-org-element
/horizontal-rule-parser
()
1100 "Test `horizontal-rule' parser."
1103 (org-test-with-temp-text "-----"
1104 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
1107 (org-test-with-temp-text " -----"
1108 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
1109 ;; Hyphen must be alone on the line.
1111 (org-test-with-temp-text "-----wrong"
1112 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
1113 ;; 4 hyphens is too small.
1115 (org-test-with-temp-text "----"
1116 (org-element-map (org-element-parse-buffer) 'horizontal-rule
'identity
)))
1117 ;; Handle non-empty blank line at the end of buffer.
1119 (org-test-with-temp-text "-----\n "
1120 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1123 ;;;; Inline Babel Call
1125 (ert-deftest test-org-element
/inline-babel-call-parser
()
1126 "Test `inline-babel-call' parser."
1129 (eq 'inline-babel-call
1130 (org-test-with-temp-text "call_test()"
1131 (org-element-type (org-element-context)))))
1133 (eq 'inline-babel-call
1134 (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
1135 (org-element-type (org-element-context)))))
1140 (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
1141 (org-element-property :call
(org-element-context)))))
1142 ;; Parse inside header.
1146 (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
1147 (org-element-property :inside-header
(org-element-context)))))
1152 (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
1153 (org-element-property :arguments
(org-element-context)))))
1154 ;; Parse end header.
1158 (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
1159 (org-element-property :end-header
(org-element-context))))))
1162 ;;;; Inline Src Block
1164 (ert-deftest test-org-element
/inline-src-block-parser
()
1165 "Test `inline-src-block' parser."
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 "src_emacs-lisp[:foo bar]{(+ 1 1)}"
1172 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1174 (org-test-with-temp-text "src_emacs-lisp[ :foo bar]{(+ 1 1)}"
1175 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1178 (org-test-with-temp-text "src_emacs-lisp[]{(+ 1 1)}"
1179 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1182 (org-test-with-temp-text "foosrc_emacs-lisp[]{(+ 1 1)}"
1183 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1185 (org-test-with-temp-text "src_emacs-lisp[]foo{(+ 1 1)}"
1186 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1187 ;; Invalid language name
1189 (org-test-with-temp-text "src_emacs-\tlisp{(+ 1 1)}"
1190 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
)))
1191 ;; Test parsing at the beginning of an item.
1193 (org-test-with-temp-text "- src_emacs-lisp{(+ 1 1)}"
1194 (org-element-map (org-element-parse-buffer) 'inline-src-block
'identity
))))
1199 (ert-deftest test-org-element
/inlinetask-parser
()
1200 "Test `inlinetask' parser."
1201 (when (featurep 'org-inlinetask
)
1202 (let ((org-inlinetask-min-level 15))
1203 ;; Regular inlinetask.
1206 (org-test-with-temp-text
1207 "*************** Task\nTest\n*************** END"
1208 (org-element-type (org-element-at-point)))))
1209 ;; Degenerate inlinetask.
1212 (org-test-with-temp-text "*************** Task"
1213 (org-element-type (org-element-at-point)))))
1214 ;; Mixed inlinetasks.
1216 (org-test-with-temp-text
1218 *************** Task
1219 *************** Task2
1221 *************** END"
1223 (goto-char (org-element-property :end
(org-element-at-point)))
1229 (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
1230 (org-test-with-temp-text "*************** TODO Task"
1231 (org-element-property :todo-keyword
(org-element-at-point))))))
1234 (org-test-with-temp-text "
1235 *************** Task<point>
1236 DEADLINE: <2012-03-29 thu.>
1237 *************** END"
1238 (org-element-property :deadline
(org-element-at-point))))
1241 (org-test-with-temp-text "
1242 *************** Task
1243 <point>DEADLINE: <2012-03-29 thu.>
1244 *************** END"
1245 (org-element-type (org-element-at-point)))))
1247 (org-test-with-temp-text "
1248 *************** Task<point>
1249 DEADLINE: <2012-03-29 thu.>"
1250 (org-element-property :deadline
(org-element-at-point))))
1253 (org-test-with-temp-text "
1254 *************** Task
1255 <point>DEADLINE: <2012-03-29 thu.>"
1256 (org-element-type (org-element-at-point)))))
1261 (org-test-with-temp-text "
1262 *************** [#A] Task"
1264 (org-element-property :priority
(org-element-at-point)))))
1269 (org-test-with-temp-text "
1270 *************** Task :test:"
1272 (org-element-property :tags
(org-element-at-point)))))
1273 ;; Regular properties are accessed through upper case keywords.
1275 (org-test-with-temp-text "
1276 *************** Task
1280 *************** END"
1282 (org-element-property :FOO
(org-element-at-point))))
1284 (org-test-with-temp-text "
1285 *************** Task
1289 *************** END"
1291 (org-element-property :foo
(org-element-at-point))))
1292 ;; Handle non-empty blank line at the end of buffer.
1294 (org-test-with-temp-text "*************** Task\n*************** END\n "
1295 (= (org-element-property :end
(org-element-at-point)) (point-max)))))))
1300 (ert-deftest test-org-element
/italic-parser
()
1301 "Test `italic' parser."
1304 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1305 (org-test-with-temp-text "/italic/"
1306 (org-element-map (org-element-parse-buffer) 'italic
'identity nil t
))))
1307 ;; Multi-line markup.
1310 (org-element-contents
1311 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1312 (org-test-with-temp-text "/first line\nsecond line/"
1313 (org-element-map (org-element-parse-buffer) 'italic
'identity nil t
))))
1314 '("first line\nsecond line"))))
1319 (ert-deftest test-org-element
/item-parser
()
1320 "Test `item' parser."
1323 (org-test-with-temp-text "- item"
1324 (org-element-map (org-element-parse-buffer) 'item
'identity
)))
1328 (org-element-property
1330 (org-test-with-temp-text "6. [@6] item"
1331 (org-element-map (org-element-parse-buffer) 'item
'identity nil t
)))))
1336 (org-element-property
1338 (org-test-with-temp-text "- tag :: description"
1339 (org-element-map (org-element-parse-buffer) 'item
'identity nil t
)))))
1340 ;; No tags in ordered lists.
1342 (org-element-property
1344 (org-test-with-temp-text "1. tag :: description"
1345 (org-element-map (org-element-parse-buffer) 'item
'identity nil t
))))
1350 (org-test-with-temp-text "
1355 (org-element-parse-buffer) 'item
1356 (lambda (item) (org-element-property :checkbox item
))))))
1357 ;; Item starting with special syntax.
1359 (equal '(("- item"))
1360 (org-test-with-temp-text "- - item"
1361 (org-element-map (org-element-parse-buffer) 'paragraph
1362 'org-element-contents
))))
1363 ;; Block in an item: ignore indentation within the block.
1365 (org-test-with-temp-text "- item\n #+begin_src emacs-lisp\n(+ 1 1)\n #+end_src"
1367 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1372 (ert-deftest test-org-element
/keyword-parser
()
1373 "Test `keyword' parser."
1376 (org-test-with-temp-text "#+KEYWORD: value"
1377 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1378 ;; Keywords are case-insensitive.
1380 (org-test-with-temp-text "#+keyword: value"
1381 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1382 ;; Affiliated keywords are not keywords.
1384 (org-test-with-temp-text "#+NAME: value
1386 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1387 ;; Do not mix keywords with Babel calls and dynamic blocks.
1389 (org-test-with-temp-text "#+CALL: fun()"
1390 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1392 (org-test-with-temp-text "#+BEGIN: my-fun\nBody\n#+END:"
1393 (org-element-map (org-element-parse-buffer) 'keyword
'identity
)))
1394 ;; Handle non-empty blank line at the end of buffer.
1396 (org-test-with-temp-text "#+KEYWORD: value\n "
1397 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1400 ;;;; Latex Environment
1402 (ert-deftest test-org-element
/latex-environment-parser
()
1403 "Test `latex-environment' parser."
1405 (org-test-with-temp-text "\\begin{equation}\ne^{i\\pi}+1=0\n\\end{equation}"
1406 (org-element-map (org-element-parse-buffer) 'latex-environment
'identity
)))
1407 ;; Allow nested environments.
1415 (org-test-with-temp-text "
1421 (org-element-property
1424 (org-element-parse-buffer) 'latex-environment
'identity nil t
)))))
1425 ;; Allow environments with options and arguments.
1427 (eq 'latex-environment
1428 (org-test-with-temp-text
1429 "\\begin{theorem}[Euler]\ne^{i\\pi}+1=0\n\\end{theorem}"
1430 (org-element-type (org-element-at-point)))))
1432 (eq 'latex-environment
1433 (org-test-with-temp-text "\\begin{env}{arg}\nvalue\n\\end{env}"
1434 (org-element-type (org-element-at-point)))))
1435 ;; Allow environments without newline after \begin{.}.
1437 (eq 'latex-environment
1438 (org-test-with-temp-text "\\begin{env}{arg}something\nvalue\n\\end{env}"
1439 (org-element-type (org-element-at-point)))))
1440 ;; Allow one-line environments.
1442 (eq 'latex-environment
1443 (org-test-with-temp-text "\\begin{env}{arg}something\\end{env}"
1444 (org-element-type (org-element-at-point)))))
1445 ;; Should not allow different tags.
1447 (eq 'latex-environment
1448 (org-test-with-temp-text "\\begin{env*}{arg}something\\end{env}"
1449 (org-element-type (org-element-at-point)))))
1450 ;; LaTeX environments must be on separate lines.
1452 (eq 'latex-environment
1453 (org-test-with-temp-text "\\begin{env} x \\end{env} y"
1454 (org-element-type (org-element-at-point)))))
1456 (eq 'latex-environment
1457 (org-test-with-temp-text "y \\begin{env} x<point> \\end{env}"
1458 (org-element-type (org-element-at-point)))))
1459 ;; Handle non-empty blank line at the end of buffer.
1461 (org-test-with-temp-text "\\begin{env}\n\\end{env}\n "
1462 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1467 (ert-deftest test-org-element
/latex-fragment-parser
()
1468 "Test `latex-fragment' parser."
1471 (org-test-with-temp-text "$a$"
1472 (org-element-type (org-element-context)))))
1475 (org-test-with-temp-text "$a$!"
1476 (org-element-type (org-element-context)))))
1479 (org-test-with-temp-text "$a$,"
1480 (org-element-type (org-element-context)))))
1483 (org-test-with-temp-text "$a$\""
1484 (org-element-type (org-element-context)))))
1487 (org-test-with-temp-text "$a$)"
1488 (org-element-type (org-element-context)))))
1491 (org-test-with-temp-text "$a$ "
1492 (org-element-type (org-element-context)))))
1495 (org-test-with-temp-text "$a$a"
1496 (org-element-type (org-element-context)))))
1499 (org-test-with-temp-text "$$a$$"
1500 (org-element-type (org-element-context)))))
1503 (org-test-with-temp-text "\\(a\\)"
1504 (org-element-type (org-element-context)))))
1507 (org-test-with-temp-text "\\[a\\]"
1508 (org-element-type (org-element-context)))))
1509 ;; Test fragment at the beginning of an item.
1512 (org-test-with-temp-text "- $<point>x$"
1513 (org-element-type (org-element-context))))))
1518 (ert-deftest test-org-element
/line-break-parser
()
1519 "Test `line-break' parser."
1522 (org-test-with-temp-text "Text \\\\"
1523 (org-element-map (org-element-parse-buffer) 'line-break
'identity
)))
1524 ;; Line break with trailing white spaces.
1526 (org-test-with-temp-text "Text \\\\ "
1527 (org-element-map (org-element-parse-buffer) 'line-break
'identity
)))
1528 ;; Three backslashes are too much.
1530 (org-test-with-temp-text "Text \\\\\\"
1531 (org-element-map (org-element-parse-buffer) 'line-break
'identity
))))
1536 (ert-deftest test-org-element
/link-parser
()
1537 "Test `link' parser."
1542 (org-test-with-temp-text "<<<radio>>>A radio link"
1543 (org-update-radio-target-regexp)
1544 (org-element-property
1546 (org-element-map (org-element-parse-buffer) 'link
#'identity nil t
)))))
1549 ;; ... with description.
1553 (org-test-with-temp-text "[[http://orgmode.org][Orgmode.org]]"
1554 (org-element-contents
1555 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1556 ;; ... without description.
1560 (org-test-with-temp-text "[[http://orgmode.org]]"
1561 (org-element-property
1563 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1564 ;; ... with expansion.
1567 "//orgmode.org/worg"
1568 (org-test-with-temp-text "[[Org:worg]]"
1569 (let ((org-link-abbrev-alist '(("Org" .
"http://orgmode.org/"))))
1570 (org-element-property
1572 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
))))))
1573 ;; ... with translation.
1577 (org-test-with-temp-text "[[http://orgmode.org]]"
1578 (flet ((link-translate (type path
) (cons type
"127.0.0.1")))
1579 (let ((org-link-translation-function 'link-translate
))
1580 (org-element-property
1582 (org-element-map (org-element-parse-buffer) 'link
1583 'identity nil t
)))))))
1588 (org-test-with-temp-text "[[id:aaaa]]"
1589 (org-element-property
1591 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1592 ;; ... custom-id link.
1596 (org-test-with-temp-text "[[#some-id]]"
1597 (org-element-property
1599 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1600 ;; ... coderef link.
1604 (org-test-with-temp-text "[[(reference)]]"
1605 (org-element-property
1607 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1612 (org-test-with-temp-text "[[target-or-title]]"
1613 (org-element-property
1615 (org-element-map (org-element-parse-buffer) 'link
'identity nil t
)))))
1616 ;; ... file-type link with search option.
1619 '(("file" "projects.org" "*task title"))
1620 (org-test-with-temp-text "[[file:projects.org::*task title]]"
1621 (org-element-map (org-element-parse-buffer) 'link
1622 (lambda (l) (list (org-element-property :type l
)
1623 (org-element-property :path l
)
1624 (org-element-property :search-option l
)))))))
1625 ;; ... file-type link with application...
1628 '("file" "projects.org" "emacs")
1629 (org-test-with-temp-text "[[file+emacs:projects.org]]"
1630 (let ((l (org-element-context)))
1631 (list (org-element-property :type l
)
1632 (org-element-property :path l
)
1633 (org-element-property :application l
))))))
1634 ;; ... `:path' in a file-type link must be compatible with "file"
1635 ;; scheme in URI syntax, even if Org syntax isn't...
1637 (org-test-with-temp-text-in-file ""
1638 (let ((file (expand-file-name (buffer-file-name))))
1639 (insert (format "[[file://%s]]" file
))
1640 (equal (org-element-property :path
(org-element-context)) file
))))
1642 (org-test-with-temp-text-in-file ""
1643 (let ((file (expand-file-name (buffer-file-name))))
1644 (insert (format "[[file:%s]]" file
))
1645 (equal (org-element-property :path
(org-element-context)) file
))))
1647 (org-test-with-temp-text-in-file ""
1648 (let ((file (expand-file-name (buffer-file-name))))
1649 (insert (format "[[file:%s]]" file
))
1650 (equal (org-element-property :path
(org-element-context)) file
))))
1651 ;; ... multi-line link.
1654 (org-test-with-temp-text "[[shell:ls\n*.org]]"
1655 (org-element-property :path
(org-element-context)))))
1658 (org-test-with-temp-text "A link: http://orgmode.org"
1659 (org-element-map (org-element-parse-buffer) 'link
'identity
)))
1660 ;; Angular link. Follow RFC 3986.
1663 (org-test-with-temp-text "A link: <point><http://orgmode.org>"
1664 (org-element-type (org-element-context)))))
1666 (equal "//orgmode.org"
1667 (org-test-with-temp-text "A link: <point><http://orgmode\n.org>"
1668 (org-element-property :path
(org-element-context)))))
1669 ;; Link abbreviation.
1672 (org-test-with-temp-text
1673 "#+LINK: orgmode http://www.orgmode.org/\n[[orgmode:#docs]]"
1674 (progn (org-mode-restart)
1675 (goto-char (1- (point-max)))
1676 (org-element-property :type
(org-element-context))))))
1677 ;; Link abbreviation in a secondary string.
1680 (org-test-with-temp-text
1681 "#+LINK: orgmode http://www.orgmode.org/\n* H [[orgmode:#docs]]"
1682 (progn (org-mode-restart)
1683 (org-element-map (org-element-parse-buffer) 'link
1684 (lambda (link) (org-element-property :type link
))
1686 ;; Plain links are allowed as description of regular links.
1689 (org-test-with-temp-text "[[http://orgmode.org][file:unicorn.jpg]]"
1690 (search-forward "file:")
1691 (org-element-property :type
(org-element-context))))))
1696 (ert-deftest test-org-element
/macro-parser
()
1697 "Test `macro' parser."
1698 ;; Without arguments.
1700 (org-test-with-temp-text "{{{macro}}}"
1701 (org-element-map (org-element-parse-buffer) 'macro
'identity
)))
1704 (org-test-with-temp-text "{{{macro(arg1,arg2)}}}"
1705 (org-element-map (org-element-parse-buffer) 'macro
'identity
)))
1706 ;; Properly handle protected commas in arguments...
1710 (org-test-with-temp-text "{{{macro(arg1\\,arg1,arg2)}}}"
1711 (org-element-property :args
(org-element-context))))))
1712 ;; ... even when last argument ends with a protected comma.
1715 (org-test-with-temp-text "{{{macro(C-\\,)}}}"
1716 (org-element-property :args
(org-element-context)))))
1717 ;; Allow to escape escaping character.
1720 (org-test-with-temp-text "{{{macro(C-\\\\,)}}}"
1721 (org-element-property :args
(org-element-context)))))
1722 ;; No need to escape backslashes elsewhere.
1725 (org-test-with-temp-text "{{{macro(\\)}}}"
1726 (org-element-property :args
(org-element-context))))))
1731 (ert-deftest test-org-element
/node-property
()
1732 "Test `node-property' parser."
1735 (equal '("abc" "value")
1736 (org-test-with-temp-text "* H\n:PROPERTIES:\n<point>:abc: value\n:END:"
1737 (let ((element (org-element-at-point)))
1738 (list (org-element-property :key element
)
1739 (org-element-property :value element
))))))
1740 ;; Value should be trimmed.
1743 (org-test-with-temp-text
1744 "* H\n:PROPERTIES:\n<point>:abc: value \n:END:"
1745 (org-element-property :value
(org-element-at-point)))))
1746 ;; A node property requires to be wrapped within a property drawer.
1749 (org-test-with-temp-text ":abc: value"
1750 (org-element-type (org-element-at-point)))))
1751 ;; Accept empty properties.
1753 (equal '(("foo" "value") ("bar" ""))
1754 (org-test-with-temp-text "* H\n:PROPERTIES:\n:foo: value\n:bar:\n:END:"
1755 (org-element-map (org-element-parse-buffer) 'node-property
1757 (list (org-element-property :key p
)
1758 (org-element-property :value p
))))))))
1763 (ert-deftest test-org-element
/paragraph-parser
()
1764 "Test `paragraph' parser."
1767 (org-test-with-temp-text "Paragraph"
1768 (org-element-map (org-element-parse-buffer) 'paragraph
'identity nil t
)))
1769 ;; Property find end of a paragraph stuck to another element.
1772 (org-test-with-temp-text "Paragraph\n# Comment"
1773 (org-element-map (org-element-parse-buffer) 'paragraph
1774 (lambda (p) (char-after (org-element-property :end p
)))
1776 ;; Include ill-formed Keywords.
1778 (org-test-with-temp-text "#+wrong_keyword something"
1779 (org-element-map (org-element-parse-buffer) 'paragraph
'identity
)))
1780 ;; Include incomplete-drawers.
1782 (org-test-with-temp-text ":TEST:\nParagraph"
1783 (let ((elem (org-element-at-point)))
1784 (and (eq (org-element-type elem
) 'paragraph
)
1785 (= (point-max) (org-element-property :end elem
))))))
1786 ;; Include incomplete blocks.
1788 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph"
1789 (let ((elem (org-element-at-point)))
1790 (and (eq (org-element-type elem
) 'paragraph
)
1791 (= (point-max) (org-element-property :end elem
))))))
1792 ;; Include incomplete dynamic blocks.
1794 (org-test-with-temp-text "#+BEGIN: \nParagraph"
1795 (let ((elem (org-element-at-point)))
1796 (and (eq (org-element-type elem
) 'paragraph
)
1797 (= (point-max) (org-element-property :end elem
))))))
1798 ;; Include incomplete latex environments.
1800 (org-test-with-temp-text "\begin{equation}\nParagraph"
1801 (let ((elem (org-element-at-point)))
1802 (and (eq (org-element-type elem
) 'paragraph
)
1803 (= (point-max) (org-element-property :end elem
))))))
1805 (org-test-with-temp-text "Paragraph\n\begin{equation}"
1806 (let ((elem (org-element-at-point)))
1807 (and (eq (org-element-type elem
) 'paragraph
)
1808 (= (point-max) (org-element-property :end elem
))))))
1809 ;; Stop at affiliated keywords.
1811 (org-test-with-temp-text "Paragraph\n#+NAME: test\n| table |"
1812 (let ((elem (org-element-at-point)))
1813 (and (eq (org-element-type elem
) 'paragraph
)
1814 (not (org-element-property :name elem
))
1815 (= (org-element-property :end elem
) (line-beginning-position 2))))))
1817 (org-test-with-temp-text
1818 "Paragraph\n#+CAPTION[with short caption]: test\n| table |"
1819 (let ((elem (org-element-at-point)))
1820 (and (eq (org-element-type elem
) 'paragraph
)
1821 (not (org-element-property :name elem
))
1822 (= (org-element-property :end elem
) (line-beginning-position 2))))))
1823 ;; Do not steal affiliated keywords from container.
1825 (org-test-with-temp-text "#+ATTR_LATEX: test\n- item<point> 1"
1826 (let ((elem (org-element-at-point)))
1827 (and (eq (org-element-type elem
) 'paragraph
)
1828 (not (org-element-property :attr_latex elem
))
1829 (/= (org-element-property :begin elem
) 1)))))
1830 ;; Handle non-empty blank line at the end of buffer.
1832 (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
1833 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1838 (ert-deftest test-org-element
/plain-list-parser
()
1839 "Test `plain-list' parser."
1840 (org-test-with-temp-text "- item"
1841 (should (org-element-map (org-element-parse-buffer) 'plain-list
'identity
)))
1842 ;; Blank lines after the list only belong to outer plain list.
1846 (org-test-with-temp-text "
1851 (let ((endings (org-element-map (org-element-parse-buffer) 'plain-list
1852 (lambda (pl) (org-element-property :end pl
)))))
1854 ;; Move to ending of outer list.
1855 (progn (goto-char (car endings
)) (looking-at "Outside list"))
1856 ;; Move to ending of inner list.
1857 (progn (goto-char (nth 1 endings
)) (looking-at "^$")))))))
1858 ;; Correctly compute end of list if it doesn't end at a line
1861 (org-test-with-temp-text "- list\n \n "
1862 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1867 (ert-deftest test-org-element
/planning-parser
()
1868 "Test `planning' parser."
1869 ;; Test various keywords.
1871 (org-element-property
1873 (org-test-with-temp-text "* H\n<point>CLOSED: [2012-03-29 thu.]"
1874 (org-element-at-point))))
1876 (org-element-property
1878 (org-test-with-temp-text "* H\n<point>DEADLINE: <2012-03-29 thu.>"
1879 (org-element-at-point))))
1881 (org-element-property
1883 (org-test-with-temp-text "* H\n<point>SCHEDULED: <2012-03-29 thu.>"
1884 (org-element-at-point))))
1885 ;; Planning line only exists right after a headline.
1888 (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>"
1889 (org-element-type (org-element-at-point)))))
1892 (org-test-with-temp-text
1893 "* H\n# Comment\n<point>DEADLINE: <2012-03-29 thu.>"
1894 (org-element-type (org-element-at-point))))))
1897 ;;;; Property Drawer
1899 (ert-deftest test-org-element
/property-drawer-parser
()
1900 "Test `property-drawer' parser."
1903 (eq 'property-drawer
1904 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop: value\n:END:"
1905 (org-element-type (org-element-at-point)))))
1907 (eq 'property-drawer
1908 (org-test-with-temp-text
1909 "* H\nDEADLINE: <2014-03-04 tue.>\n<point>:PROPERTIES:\n:prop: value\n:END:"
1910 (org-element-type (org-element-at-point)))))
1911 ;; Allow properties without value and no property at all.
1913 (eq 'property-drawer
1914 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop:\n:END:"
1915 (org-element-type (org-element-at-point)))))
1917 (eq 'property-drawer
1918 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:END:"
1919 (org-element-type (org-element-at-point)))))
1920 ;; Ignore incomplete drawer, drawer at a wrong location or with
1923 (eq 'property-drawer
1924 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop: value"
1925 (org-element-type (org-element-at-point)))))
1927 (eq 'property-drawer
1928 (org-test-with-temp-text
1929 "* H\nParagraph\n<point>:PROPERTIES:\n:prop: value\n:END:"
1930 (org-element-type (org-element-at-point)))))
1932 (eq 'property-drawer
1933 (org-test-with-temp-text
1934 "* H\nParagraph\n<point>:PROPERTIES:\nparagraph\n:END:"
1935 (org-element-type (org-element-at-point)))))
1936 ;; Handle non-empty blank line at the end of buffer.
1938 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:END:\n "
1939 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1944 (ert-deftest test-org-element
/quote-block-parser
()
1945 "Test `quote-block' parser."
1948 (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
1949 (org-element-map (org-element-parse-buffer) 'quote-block
'identity
)))
1950 ;; Ignore incomplete block.
1952 (org-test-with-temp-text "#+BEGIN_QUOTE"
1953 (org-element-map (org-element-parse-buffer) 'quote-block
'identity nil t
)))
1954 ;; Handle non-empty blank line at the end of buffer.
1956 (org-test-with-temp-text "#+BEGIN_QUOTE\nC\n#+END_QUOTE\n "
1957 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
1962 (ert-deftest test-org-element
/radio-target-parser
()
1963 "Test `radio-target' parser."
1967 (org-test-with-temp-text "<<<radio>>>"
1968 (org-element-type (org-element-context)))))
1969 ;; Radio targets with objects.
1972 (org-test-with-temp-text "<<<radio \\alpha>>>"
1973 (org-element-type (org-element-context)))))
1974 ;; Radio targets starting with an object.
1977 (org-test-with-temp-text "<<<\\alpha radio>>>"
1978 (org-element-type (org-element-context)))))
1979 ;; Radio targets cannot begin or end with white space.
1982 (org-test-with-temp-text "<<< radio>>>"
1983 (org-element-type (org-element-context)))))
1986 (org-test-with-temp-text "<<<radio >>>"
1987 (org-element-type (org-element-context))))))
1992 (ert-deftest test-org-element
/section-parser
()
1993 "Test `section' parser."
1996 (org-test-with-temp-text "* Headline\nText"
1997 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
1998 ;; There's a section before the first headline.
2000 (org-test-with-temp-text "Text"
2001 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
2002 ;; A section cannot be empty.
2004 (org-test-with-temp-text "* Headline 1\n* Headline 2"
2005 (org-element-map (org-element-parse-buffer) 'section
'identity
)))
2006 ;; A section doesn't contain sub-trees.
2008 (org-test-with-temp-text "* Head\nText\n** Sub-Head"
2010 (org-element-map (org-element-parse-buffer) 'section
'identity nil t
)
2011 'headline
'identity
))))
2016 (ert-deftest test-org-element
/special-block-parser
()
2017 "Test `special-block' parser."
2021 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
2022 (org-element-property :type
(org-element-at-point)))))
2023 ;; Special blocks are case sensitive.
2026 (org-test-with-temp-text "#+BEGIN_CaSe\nText\n#+END_CaSe"
2027 (org-element-property :type
(org-element-at-point)))))
2028 ;; Special blocks can contain paragraphs.
2031 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
2033 (org-element-type (org-element-at-point)))))
2034 ;; Ignore incomplete block.
2037 (org-test-with-temp-text "#+BEGIN_SPECIAL"
2038 (org-element-type (org-element-at-point)))))
2039 ;; Allow special characters in type.
2041 (equal '(special-block "SPECIAL*")
2042 (org-test-with-temp-text "#+BEGIN_SPECIAL*\nContents\n#+END_SPECIAL*"
2043 (let ((element (org-element-at-point)))
2044 (list (org-element-type element
)
2045 (org-element-property :type element
))))))
2046 ;; Handle non-empty blank line at the end of buffer.
2048 (org-test-with-temp-text "#+BEGIN_SPECIAL\nC\n#+END_SPECIAL\n "
2049 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
2054 (ert-deftest test-org-element
/src-block-parser
()
2055 "Test `src-block' parser."
2058 (org-test-with-temp-text "#+BEGIN_SRC org\nText\n#+END_SRC"
2059 (org-element-map (org-element-parse-buffer) 'src-block
'identity
)))
2060 ;; Ignore incomplete block.
2062 (org-test-with-temp-text "#+BEGIN_SRC"
2063 (org-element-map (org-element-parse-buffer) 'src-block
'identity
)))
2064 ;; Properly un-escape code.
2066 (equal "* Headline\n #+keyword\nText\n"
2067 (org-test-with-temp-text
2068 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText\n#+END_SRC"
2069 (org-element-property :value
(org-element-at-point)))))
2070 ;; Remove block indentation according to block boundaries, unless
2071 ;; block contents are less indented than block boundaries.
2074 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
2075 (let ((org-src-preserve-indentation t
))
2076 (org-element-property :value
(org-element-at-point))))))
2080 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
2081 (let ((org-src-preserve-indentation t
))
2082 (org-element-property :value
(org-element-at-point))))))
2083 ;; Handle non-empty blank line at the end of buffer.
2085 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\nC\n#+END_SRC\n "
2086 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
2089 ;;;; Statistics Cookie
2091 (ert-deftest test-org-element
/statistics-cookie
()
2092 "Test `statistics-cookie' parser."
2095 (org-test-with-temp-text "[1/2]"
2096 (org-element-map (org-element-parse-buffer) 'statistics-cookie
'identity
)))
2099 (org-test-with-temp-text "[33%]"
2101 (org-element-parse-buffer) 'statistics-cookie
'identity
))))
2106 (ert-deftest test-org-element
/strike-through-parser
()
2107 "Test `strike-through' parser."
2110 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2111 (org-test-with-temp-text "+strike-through+"
2112 (org-element-map (org-element-parse-buffer) 'strike-through
'identity
))))
2113 ;; Multi-line markup.
2116 (org-element-contents
2117 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2118 (org-test-with-temp-text "+first line\nsecond line+"
2120 (org-element-parse-buffer) 'strike-through
'identity nil t
))))
2121 '("first line\nsecond line"))))
2126 (ert-deftest test-org-element
/subscript-parser
()
2127 "Test `subscript' parser."
2130 (org-test-with-temp-text "a_b"
2131 (org-element-map (org-element-parse-buffer) 'subscript
'identity
)))
2134 (org-test-with-temp-text "a_{b}"
2135 (org-element-map (org-element-parse-buffer) 'subscript
'identity
)))
2136 ;; Multiple subscripts in a paragraph.
2139 (org-test-with-temp-text "a_b and c_d"
2141 (org-element-map (org-element-parse-buffer) 'subscript
'identity
))))))
2146 (ert-deftest test-org-element
/superscript-parser
()
2147 "Test `superscript' parser."
2150 (org-test-with-temp-text "a^b"
2151 (org-element-map (org-element-parse-buffer) 'superscript
'identity
)))
2154 (org-test-with-temp-text "a^{b}"
2155 (org-element-map (org-element-parse-buffer) 'superscript
'identity
)))
2156 ;; Multiple superscript in a paragraph.
2159 (org-test-with-temp-text "a^b and c^d"
2162 (org-element-parse-buffer) 'superscript
'identity
))))))
2167 (ert-deftest test-org-element
/table-parser
()
2168 "Test `table' parser."
2170 (org-test-with-temp-text "| a |"
2171 (org-element-map (org-element-parse-buffer) 'table
'identity
)))
2172 ;; TBLFM keyword is case insensitive.
2174 (org-test-with-temp-text "| a |\n#+tblfm: test"
2175 (org-element-property
2177 (org-element-map (org-element-parse-buffer) 'table
'identity nil t
))))
2178 ;; Handle multiple TBLFM lines.
2181 (org-test-with-temp-text "| a |\n#+TBLFM: test1\n#+TBLFM: test2"
2182 (length (org-element-property
2185 (org-element-parse-buffer) 'table
'identity nil t
))))))
2186 ;; Handle non-empty blank line at the end of buffer.
2188 (org-test-with-temp-text "| a |\n "
2189 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
2194 (ert-deftest test-org-element
/table-cell-parser
()
2195 "Test `table-cell' parser."
2196 ;; Regular table cell.
2198 (org-test-with-temp-text "| a |"
2199 (org-element-map (org-element-parse-buffer) 'table-cell
'identity
)))
2200 ;; Last vertical bar may be omitted.
2202 (org-test-with-temp-text "| a "
2203 (org-element-map (org-element-parse-buffer) 'table-cell
'identity
))))
2208 (ert-deftest test-org-element
/table-row-parser
()
2209 "Test `table-row' parser."
2211 (equal '(standard rule
)
2212 (org-test-with-temp-text "| a |\n|---|"
2214 (org-element-parse-buffer) 'table-row
2215 (lambda (row) (org-element-property :type row
)))))))
2220 (ert-deftest test-org-element
/target-parser
()
2221 "Test `target' parser."
2223 (org-test-with-temp-text "<<target>>"
2224 (org-element-map (org-element-parse-buffer) 'target
'identity
))))
2229 (ert-deftest test-org-element
/timestamp
()
2230 "Test `timestamp' parser."
2231 ;; Active timestamp.
2233 (org-test-with-temp-text "<2012-03-29 16:40>"
2234 (eq (org-element-property :type
(org-element-context)) 'active
)))
2236 (org-test-with-temp-text "<2012-03-29 Thu>"
2237 (let ((timestamp (org-element-context)))
2238 (or (org-element-property :hour-start timestamp
)
2239 (org-element-property :minute-start timestamp
)))))
2241 (equal '(2012 3 29 16 40)
2242 (org-test-with-temp-text "<2012-03-29 Thu 16:40>"
2243 (let ((object (org-element-context)))
2244 (list (org-element-property :year-start object
)
2245 (org-element-property :month-start object
)
2246 (org-element-property :day-start object
)
2247 (org-element-property :hour-start object
)
2248 (org-element-property :minute-start object
))))))
2249 ;; Inactive timestamp.
2251 (org-test-with-temp-text "[2012-03-29 Thu 16:40]"
2252 (eq (org-element-property :type
(org-element-context)) 'inactive
)))
2255 (equal '(2012 3 29 16 40 7 30)
2256 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
2257 (let ((object (org-element-context)))
2258 (list (org-element-property :year-end object
)
2259 (org-element-property :month-end object
)
2260 (org-element-property :day-end object
)
2261 (org-element-property :hour-end object
)
2262 (org-element-property :minute-end object
)
2263 (org-element-property :hour-start object
)
2264 (org-element-property :minute-start object
))))))
2267 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
2268 (org-element-property :type
(org-element-context)))))
2271 (org-test-with-temp-text "[2012-03-29 Thu 16:40]--[2012-03-29 Thu 16:41]"
2272 (eq (org-element-property :type
(org-element-context)) 'inactive-range
)))
2274 (org-test-with-temp-text "[2011-07-14 Thu]--[2012-03-29 Thu]"
2275 (let ((timestamp (org-element-context)))
2276 (or (org-element-property :hour-end timestamp
)
2277 (org-element-property :minute-end timestamp
)))))
2278 ;; With repeater, warning delay and both.
2281 (org-test-with-temp-text "<2012-03-29 Thu ++1y>"
2282 (org-element-property :repeater-type
(org-element-context)))))
2285 (org-test-with-temp-text "<2012-03-29 Thu --1y>"
2286 (org-element-property :warning-type
(org-element-context)))))
2288 (equal '(cumulate all
)
2289 (org-test-with-temp-text "<2012-03-29 Thu +1y -1y>"
2290 (let ((ts (org-element-context)))
2291 (list (org-element-property :repeater-type ts
)
2292 (org-element-property :warning-type ts
)))))))
2297 (ert-deftest test-org-element
/underline-parser
()
2298 "Test `underline' parser."
2301 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2302 (org-test-with-temp-text "_underline_"
2303 (org-element-map (org-element-parse-buffer) 'underline
'identity
))))
2304 ;; Multi-line markup.
2307 (org-element-contents
2308 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2309 (org-test-with-temp-text "_first line\nsecond line_"
2311 (org-element-parse-buffer) 'underline
'identity nil t
))))
2312 '("first line\nsecond line"))))
2317 (ert-deftest test-org-element
/verbatim-parser
()
2318 "Test `verbatim' parser."
2321 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2322 (org-test-with-temp-text "=verbatim="
2323 (org-element-map (org-element-parse-buffer) 'verbatim
'identity
))))
2324 ;; Multi-line markup.
2327 (org-element-property
2329 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^
\n,\"']\\|[^
\n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^
\n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2330 (org-test-with-temp-text "=first line\nsecond line="
2332 (org-element-parse-buffer) 'verbatim
'identity nil t
))))
2333 "first line\nsecond line")))
2338 (ert-deftest test-org-element
/verse-block-parser
()
2339 "Test `verse-block' parser."
2342 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
2343 (org-element-map (org-element-parse-buffer) 'verse-block
'identity
)))
2346 (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
2347 (org-element-map (org-element-parse-buffer) 'verse-block
'identity
)))
2348 ;; Parse objects in verse blocks.
2350 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
2351 (org-element-map (org-element-parse-buffer) 'entity
'identity
)))
2352 ;; Ignore incomplete verse block.
2354 (org-test-with-temp-text "#+BEGIN_VERSE"
2355 (org-element-map (org-element-parse-buffer) 'verse-block
'identity nil t
)))
2356 ;; Handle non-empty blank line at the end of buffer.
2358 (org-test-with-temp-text "#+BEGIN_VERSE\nC\n#+END_VERSE\n "
2359 (= (org-element-property :end
(org-element-at-point)) (point-max)))))
2363 ;;; Test Interpreters.
2365 (ert-deftest test-org-element
/interpret-data
()
2366 "Test `org-element-interpret-data' specifications."
2367 ;; Interpret simple affiliated keywords.
2370 (org-element-interpret-data
2371 '(org-data nil
(paragraph (:name
"para") "Paragraph")))
2372 "#+NAME: para\nParagraph\n"))
2373 ;; Interpret multiple affiliated keywords.
2376 (org-element-interpret-data
2377 '(org-data nil
(paragraph (:attr_ascii
("line2" "line1")) "Paragraph")))
2378 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
2379 ;; Interpret parsed affiliated keywords.
2382 (org-element-interpret-data
2383 '(org-data nil
(paragraph (:caption
(("caption"))) "Paragraph")))
2384 "#+CAPTION: caption\nParagraph\n"))
2385 ;; Interpret dual affiliated keywords.
2388 (org-element-interpret-data
2389 '(org-data nil
(paragraph (:caption
((("long") "short"))) "Paragraph")))
2390 "#+CAPTION[short]: long\nParagraph\n"))
2391 ;; Interpret multiple parsed dual keywords.
2394 (org-element-interpret-data
2395 '(org-data nil
(paragraph
2396 (:caption
((("l2") "s2") (("l1") "s1"))) "Paragraph")))
2397 "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph\n"))
2398 ;; Pseudo objects and elements are transparent.
2402 (org-element-interpret-data
2403 '(paragraph nil
(pseudo-object (:post-blank
1) "A") "B")))))
2406 (org-element-interpret-data
2408 (pseudo-element (:post-blank
1) (paragraph nil
"A"))
2409 (paragraph nil
"B"))))))
2411 (ert-deftest test-org-element
/center-block-interpreter
()
2412 "Test center block interpreter."
2414 (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
2415 "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
2417 (ert-deftest test-org-element
/drawer-interpreter
()
2418 "Test drawer interpreter."
2420 (equal (org-test-parse-and-interpret ":TEST:\nTest\n:END:")
2421 ":TEST:\nTest\n:END:\n")))
2423 (ert-deftest test-org-element
/dynamic-block-interpreter
()
2424 "Test dynamic block interpreter."
2426 (equal (org-test-parse-and-interpret
2427 "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
2428 "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
2430 (ert-deftest test-org-element
/footnote-definition-interpreter
()
2431 "Test footnote definition interpreter."
2432 (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
2434 (ert-deftest test-org-element
/headline-interpreter
()
2435 "Test headline and section interpreters."
2436 ;; 1. Standard test.
2437 (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
2438 ;; 2. With TODO keywords.
2440 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2441 (org-test-parse-and-interpret "* TODO Headline"))
2442 "* TODO Headline\n"))
2445 ;; 3.1. ... and a positive `org-tags-column' value.
2447 (equal (let ((org-tags-column 20))
2448 (org-test-parse-and-interpret "* Headline :tag:"))
2449 "* Headline :tag:\n"))
2450 ;; 3.2. ... and a negative `org-tags-column' value.
2452 (equal (let ((org-tags-column -
20))
2453 (org-test-parse-and-interpret "* Headline :tag:"))
2454 "* Headline :tag:\n"))
2455 ;; 3.3. ... and a null `org-tags-column' value.
2457 (equal (let ((org-tags-column 0))
2458 (org-test-parse-and-interpret "* Headline :tag:"))
2459 "* Headline :tag:\n"))
2460 ;; 4. With priority cookie.
2462 (equal (org-test-parse-and-interpret "* [#B] Headline")
2463 "* [#B] Headline\n"))
2464 ;; 5. With comment keyword.
2466 (equal (let ((org-comment-string "COMMENT"))
2467 (org-test-parse-and-interpret "* COMMENT Headline"))
2468 "* COMMENT Headline\n"))
2469 ;; 6. Keep same number of blank lines before body.
2471 (equal (org-test-parse-and-interpret
2472 "* Headline\n\n\nText after two blank lines.")
2473 "* Headline\n\n\nText after two blank lines.\n"))
2474 ;; 8. Preserve `org-odd-levels-only' state.
2476 (equal "* H\n*** H2\n"
2477 (let ((org-odd-levels-only t
))
2478 (org-test-parse-and-interpret "* H\n*** H2")))))
2480 (ert-deftest test-org-element
/inlinetask-interpreter
()
2481 "Test inlinetask interpretation."
2482 (when (featurep 'org-inlinetask
)
2483 (let ((org-inlinetask-min-level 15))
2484 ;; 1. Regular inlinetask.
2485 (should (equal (org-test-parse-and-interpret
2486 "*************** Task\nTest\n*************** END")
2487 "*************** Task\nTest\n*************** END\n"))
2488 ;; 2. Degenerate inlinetask.
2489 (should (equal (org-test-parse-and-interpret "*************** Task")
2490 "*************** Task\n"))
2491 ;; 3. Prefer degenerate form when there are no contents.
2492 (should (equal (org-test-parse-and-interpret
2493 "*************** Task\n*************** END")
2494 "*************** Task\n"))
2495 ;; 4. With TODO keywords.
2497 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2498 (org-test-parse-and-interpret "*************** TODO Task"))
2499 "*************** TODO Task\n"))
2502 ;; 5.1. ... and a positive `org-tags-column' value.
2504 (equal (let ((org-tags-column 30))
2505 (org-test-parse-and-interpret "*************** Task :tag:"))
2506 "*************** Task :tag:\n"))
2507 ;; 5.2. ... and a negative `org-tags-column' value.
2509 (equal (let ((org-tags-column -
30))
2510 (org-test-parse-and-interpret "*************** Task :tag:"))
2511 "*************** Task :tag:\n"))
2512 ;; 5.3. ... and a null `org-tags-column' value.
2514 (equal (let ((org-tags-column 0))
2515 (org-test-parse-and-interpret "*************** Task :tag:"))
2516 "*************** Task :tag:\n"))
2517 ;; 6. With priority cookie.
2519 (equal (org-test-parse-and-interpret "*************** [#B] Task")
2520 "*************** [#B] Task\n")))))
2522 (ert-deftest test-org-element
/plain-list-interpreter
()
2523 "Test plain-list and item interpreters."
2524 (let ((org-list-two-spaces-after-bullet-regexp nil
))
2526 (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
2527 ;; Description list.
2529 (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
2532 (equal (let ((org-plain-list-ordered-item-terminator t
))
2533 (org-test-parse-and-interpret "1. Item"))
2536 (equal (let ((org-plain-list-ordered-item-terminator ?\
)))
2537 (org-test-parse-and-interpret "1) Item"))
2539 ;; Ordered list with counter.
2541 (equal (let ((org-plain-list-ordered-item-terminator t
))
2542 (org-test-parse-and-interpret "1. [@5] Item"))
2544 ;; List with check-boxes.
2546 (equal (org-test-parse-and-interpret
2547 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
2548 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n"))
2549 ;; Item not starting with a paragraph.
2551 (equal (org-test-parse-and-interpret "-\n | a | b |")
2552 "- \n | a | b |\n"))
2553 ;; Special case: correctly handle "*" bullets.
2554 (should (org-test-parse-and-interpret " * item"))
2555 ;; Special case: correctly handle empty items.
2556 (should (org-test-parse-and-interpret "-"))))
2558 (ert-deftest test-org-element
/quote-block-interpreter
()
2559 "Test quote block interpreter."
2560 (should (equal (org-test-parse-and-interpret
2561 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
2562 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
2564 (ert-deftest test-org-element
/special-block-interpreter
()
2565 "Test special block interpreter."
2566 (should (equal (org-test-parse-and-interpret
2567 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
2568 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
2570 (ert-deftest test-org-element
/babel-call-interpreter
()
2571 "Test Babel call interpreter."
2572 ;; Without argument.
2573 (should (equal (org-test-parse-and-interpret "#+CALL: test()")
2574 "#+CALL: test()\n"))
2576 (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
2577 "#+CALL: test(x=2)\n"))
2578 ;; With header arguments.
2579 (should (equal (org-test-parse-and-interpret
2580 "#+CALL: test[:results output]() :results html")
2581 "#+CALL: test[:results output]() :results html\n")))
2583 (ert-deftest test-org-element
/clock-interpreter
()
2584 "Test clock interpreter."
2588 "CLOCK: \\[2012-01-01 .* 00:01\\]"
2589 (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]")))
2593 "CLOCK: \\[2012-01-01 .* 00:01\\]--\\[2012-01-01 .* 00:02\\] => 0:01"
2594 (org-test-parse-and-interpret "
2595 CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))))
2597 (ert-deftest test-org-element
/comment-interpreter
()
2598 "Test comment interpreter."
2600 (should (equal (org-test-parse-and-interpret "# Comment") "# Comment\n"))
2602 (should (equal (org-test-parse-and-interpret " # Comment")
2604 ;; Preserve indentation.
2605 (should (equal (org-test-parse-and-interpret " # No blank\n# One blank")
2606 "# No blank\n# One blank\n")))
2608 (ert-deftest test-org-element
/comment-block-interpreter
()
2609 "Test comment block interpreter."
2610 (should (equal (org-test-parse-and-interpret
2611 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
2612 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n"))
2613 ;; Accept missing final newline in value.
2616 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n"
2617 (org-element-interpret-data '(comment-block (:value
"Test"))))))
2619 (ert-deftest test-org-element
/diary-sexp
()
2620 "Test diary-sexp interpreter."
2623 (org-test-parse-and-interpret
2624 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old")
2625 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old\n")))
2627 (ert-deftest test-org-element
/example-block-interpreter
()
2628 "Test example block interpreter."
2629 ;; Without switches.
2630 (should (equal (org-test-parse-and-interpret
2631 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
2632 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
2635 (equal (org-test-parse-and-interpret
2636 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
2637 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n"))
2638 ;; Preserve code escaping.
2640 (equal (org-test-parse-and-interpret
2641 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE")
2642 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE\n"))
2643 ;; Accept missing final newline in value.
2646 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"
2647 (org-element-interpret-data '(example-block (:value
"Test"))))))
2649 (ert-deftest test-org-element
/export-block-interpreter
()
2650 "Test export block interpreter."
2651 (should (equal (org-test-parse-and-interpret
2652 "#+BEGIN_HTML\nTest\n#+END_HTML")
2653 "#+BEGIN_HTML\nTest\n#+END_HTML\n")))
2655 (ert-deftest test-org-element
/fixed-width-interpreter
()
2656 "Test fixed width interpreter."
2658 (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
2659 ;; Preserve indentation.
2660 (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
2661 ": 2 blanks\n: 1 blank\n"))
2662 ;; Remove last newline character
2664 (equal (org-element-fixed-width-interpreter
2665 '(fixed-width (:value
"Test\n")) nil
)
2668 (equal (org-element-fixed-width-interpreter
2669 '(fixed-width (:value
"Test")) nil
)
2671 ;; Handle empty string.
2673 (equal (org-element-fixed-width-interpreter
2674 '(fixed-width (:value
"")) nil
)
2676 ;; Handle nil value.
2678 (org-element-fixed-width-interpreter
2679 '(fixed-width (:value nil
)) nil
)))
2681 (ert-deftest test-org-element
/horizontal-rule-interpreter
()
2682 "Test horizontal rule interpreter."
2683 (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
2685 (ert-deftest test-org-element
/keyword-interpreter
()
2686 "Test keyword interpreter."
2687 (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
2688 "#+KEYWORD: value\n")))
2690 (ert-deftest test-org-element
/latex-environment-interpreter
()
2691 "Test latex environment interpreter."
2692 (should (equal (org-test-parse-and-interpret
2693 "\\begin{equation}\n1+1=2\n\\end{equation}")
2694 "\\begin{equation}\n1+1=2\n\\end{equation}\n"))
2695 (should (equal (org-test-parse-and-interpret
2696 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}")
2697 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}\n")))
2699 (ert-deftest test-org-element
/planning-interpreter
()
2700 "Test planning interpreter."
2704 DEADLINE: <2012-03-29 .*?> SCHEDULED: <2012-03-29 .*?> CLOSED: \\[2012-03-29 .*?\\]"
2705 (org-test-parse-and-interpret
2707 DEADLINE: <2012-03-29 thu.> SCHEDULED: <2012-03-29 thu.> CLOSED: [2012-03-29 thu.]"))))
2709 (ert-deftest test-org-element
/property-drawer-interpreter
()
2710 "Test property drawer interpreter."
2711 (should (equal (let ((org-property-format "%-10s %s"))
2712 (org-test-parse-and-interpret
2713 "* H\n:PROPERTIES:\n:prop: value\n:END:"))
2714 "* H\n:PROPERTIES:\n:prop: value\n:END:\n")))
2716 (ert-deftest test-org-element
/src-block-interpreter
()
2717 "Test src block interpreter."
2720 (equal (let ((org-edit-src-content-indentation 2)
2721 (org-src-preserve-indentation nil
))
2722 (org-test-parse-and-interpret
2723 "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC"))
2724 "#+BEGIN_SRC emacs-lisp :results silent\n (+ 1 1)\n#+END_SRC\n"))
2727 (equal (let ((org-edit-src-content-indentation 2)
2728 (org-src-preserve-indentation nil
))
2729 (org-test-parse-and-interpret
2730 "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC"))
2731 "#+BEGIN_SRC emacs-lisp -n -k\n (+ 1 1)\n#+END_SRC\n"))
2732 ;; Preserve code escaping.
2734 (equal (let ((org-edit-src-content-indentation 2)
2735 (org-src-preserve-indentation nil
))
2736 (org-test-parse-and-interpret
2737 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC"))
2738 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC\n"))
2739 ;; Do not apply `org-edit-src-content-indentation' when preserving
2742 (equal (let ((org-edit-src-content-indentation 2)
2743 (org-src-preserve-indentation t
))
2744 (org-test-parse-and-interpret
2745 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"))
2746 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n"))
2748 (equal (let ((org-edit-src-content-indentation 2)
2749 (org-src-preserve-indentation nil
))
2750 (org-test-parse-and-interpret
2751 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"))
2752 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC\n"))
2753 ;; Accept missing final newline in value.
2756 "#+BEGIN_SRC emacs-lisp\n Test\n#+END_SRC\n"
2757 (let ((org-edit-src-content-indentation 2)
2758 (org-src-preserve-indentation nil
))
2759 (org-element-interpret-data
2760 '(src-block (:language
"emacs-lisp" :value
"Test")))))))
2762 (ert-deftest test-org-element
/table-interpreter
()
2763 "Test table, table-row and table-cell interpreters."
2765 (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
2766 "| a | b |\n| c | d |\n"))
2767 ;; 2. With horizontal rules.
2768 (should (equal (org-test-parse-and-interpret
2769 "| a | b |\n|---+---|\n| c | d |")
2770 "| a | b |\n|---+---|\n| c | d |\n"))
2771 ;; 3. With meta-data.
2772 (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
2773 "| / | < | > |\n| * | 1 | 2 |\n"))
2774 ;; 4. With a formula.
2776 (equal (org-test-parse-and-interpret
2777 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)")
2778 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)\n"))
2779 ;; 5. With multiple formulas.
2781 (equal (org-test-parse-and-interpret
2782 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2")
2783 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2\n")))
2785 (ert-deftest test-org-element
/timestamp-interpreter
()
2786 "Test timestamp interpreter."
2789 (string-match "<2012-03-29 .* 16:40>"
2790 (org-test-parse-and-interpret "<2012-03-29 thu. 16:40>")))
2792 (string-match "<2012-03-29 .* 16:40>"
2793 (org-element-timestamp-interpreter
2795 (:type active
:year-start
2012 :month-start
3 :day-start
29
2796 :hour-start
16 :minute-start
40)) nil
)))
2799 (string-match "\\[2012-03-29 .* 16:40\\]"
2800 (org-test-parse-and-interpret "[2012-03-29 thu. 16:40]")))
2803 "\\[2012-03-29 .* 16:40\\]"
2804 (org-element-timestamp-interpreter
2806 (:type inactive
:year-start
2012 :month-start
3 :day-start
29
2807 :hour-start
16 :minute-start
40)) nil
)))
2810 (string-match "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2811 (org-test-parse-and-interpret
2812 "<2012-03-29 thu. 16:40>--<2012-03-29 thu. 16:41>")))
2815 "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2816 (org-element-timestamp-interpreter
2818 (:type active-range
:year-start
2012 :month-start
3 :day-start
29
2819 :hour-start
16 :minute-start
40 :year-end
2012 :month-end
3
2820 :day-end
29 :hour-end
16 :minute-end
41)) nil
)))
2823 (string-match "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2824 (org-test-parse-and-interpret
2825 "[2012-03-29 thu. 16:40]--[2012-03-29 thu. 16:41]")))
2828 "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2829 (org-element-timestamp-interpreter
2831 (:type inactive-range
:year-start
2012 :month-start
3 :day-start
29
2832 :hour-start
16 :minute-start
40 :year-end
2012 :month-end
3
2833 :day-end
29 :hour-end
16 :minute-end
41)) nil
)))
2835 (should (equal (org-test-parse-and-interpret "<%%diary-float t 4 2>")
2836 "<%%diary-float t 4 2>\n"))
2837 ;; Timestamp with repeater interval, with delay, with both.
2839 (string-match "<2012-03-29 .* \\+1y>"
2840 (org-test-parse-and-interpret "<2012-03-29 thu. +1y>")))
2843 "<2012-03-29 .* \\+1y>"
2844 (org-element-timestamp-interpreter
2846 (:type active
:year-start
2012 :month-start
3 :day-start
29
2847 :repeater-type cumulate
:repeater-value
1 :repeater-unit year
))
2851 "<2012-03-29 .* -1y>"
2852 (org-element-timestamp-interpreter
2854 (:type active
:year-start
2012 :month-start
3 :day-start
29
2855 :warning-type all
:warning-value
1 :warning-unit year
))
2859 "<2012-03-29 .* \\+1y -1y>"
2860 (org-element-timestamp-interpreter
2862 (:type active
:year-start
2012 :month-start
3 :day-start
29
2863 :warning-type all
:warning-value
1 :warning-unit year
2864 :repeater-type cumulate
:repeater-value
1 :repeater-unit year
))
2866 ;; Timestamp range with repeater interval
2868 (string-match "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2869 (org-test-parse-and-interpret
2870 "<2012-03-29 Thu +1y>--<2012-03-30 Thu +1y>")))
2873 "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2874 (org-element-timestamp-interpreter
2876 (:type active-range
:year-start
2012 :month-start
3 :day-start
29
2877 :year-end
2012 :month-end
3 :day-end
30 :repeater-type cumulate
2878 :repeater-value
1 :repeater-unit year
))
2881 (ert-deftest test-org-element
/verse-block-interpreter
()
2882 "Test verse block interpretation."
2884 (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
2885 "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
2887 (ert-deftest test-org-element
/bold-interpreter
()
2888 "Test bold interpreter."
2889 (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
2891 (ert-deftest test-org-element
/code-interpreter
()
2892 "Test code interpreter."
2893 (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
2895 (ert-deftest test-org-element
/entity-interpreter
()
2896 "Test entity interpreter."
2897 ;; 1. Without brackets.
2899 (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
2900 ;; 2. With brackets.
2902 (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
2904 (ert-deftest test-org-element
/export-snippet-interpreter
()
2905 "Test export snippet interpreter."
2906 (should (equal (org-test-parse-and-interpret "@@back-end:contents@@")
2907 "@@back-end:contents@@\n")))
2909 (ert-deftest test-org-element
/footnote-reference-interpreter
()
2910 "Test footnote reference interpreter."
2911 ;; 1. Regular reference.
2912 (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
2913 ;; 2. Normalized reference.
2914 (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
2915 ;; 3. Named reference.
2916 (should (equal (org-test-parse-and-interpret "Text[fn:label]")
2917 "Text[fn:label]\n"))
2918 ;; 4. Inline reference.
2919 (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
2920 "Text[fn:label:def]\n"))
2921 ;; 5. Anonymous reference.
2922 (should (equal (org-test-parse-and-interpret "Text[fn::def]")
2923 "Text[fn::def]\n")))
2925 (ert-deftest test-org-element
/inline-babel-call-interpreter
()
2926 "Test inline babel call interpreter."
2927 ;; Without arguments.
2928 (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
2930 (should (equal (org-test-parse-and-interpret "call_test(x=2)")
2931 "call_test(x=2)\n"))
2932 ;; With header arguments.
2933 (should (equal (org-test-parse-and-interpret
2934 "call_test[:results output]()[:results html]")
2935 "call_test[:results output]()[:results html]\n")))
2937 (ert-deftest test-org-element
/inline-src-block-interpreter
()
2938 "Test inline src block interpreter."
2939 ;; 1. Without header argument.
2940 (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
2941 "src_emacs-lisp{(+ 1 1)}\n"))
2942 ;; 2. With header arguments.
2943 (should (equal (org-test-parse-and-interpret
2944 "src_emacs-lisp[:results silent]{(+ 1 1)}")
2945 "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
2947 (ert-deftest test-org-element
/italic-interpreter
()
2948 "Test italic interpreter."
2949 (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
2951 (ert-deftest test-org-element
/latex-fragment-interpreter
()
2952 "Test latex fragment interpreter."
2953 (should (equal (org-test-parse-and-interpret "\\command{}") "\\command{}\n"))
2954 (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
2955 (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
2956 (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
2957 (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
2958 (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n")))
2960 (ert-deftest test-org-element
/line-break-interpreter
()
2961 "Test line break interpreter."
2962 (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
2963 "First line \\\\\nSecond line\n")))
2965 (ert-deftest test-org-element
/link-interpreter
()
2966 "Test link interpreter."
2967 ;; Links targeted from a radio target.
2968 (should (equal (let ((org-target-link-regexp "radio-target"))
2969 (org-test-parse-and-interpret "a radio-target"))
2970 "a radio-target\n"))
2971 ;; Links without description.
2972 (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
2973 "[[http://orgmode.org]]\n"))
2974 ;; Links with a description.
2975 (should (equal (org-test-parse-and-interpret
2976 "[[http://orgmode.org][Org mode]]")
2977 "[[http://orgmode.org][Org mode]]\n"))
2980 (equal (org-test-parse-and-interpret "[[file+emacs:todo.org]]")
2981 "[[file+emacs:todo.org]]\n"))
2983 (equal (org-test-parse-and-interpret "[[file:todo.org::*task]]")
2984 "[[file:todo.org::*task]]\n"))
2986 (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
2988 (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
2990 (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
2991 ;; Normalize plain links.
2992 (should (equal (org-test-parse-and-interpret "http://orgmode.org")
2993 "[[http://orgmode.org]]\n"))
2994 ;; Normalize angular links.
2995 (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
2996 "[[http://orgmode.org]]\n")))
2998 (ert-deftest test-org-element
/macro-interpreter
()
2999 "Test macro interpreter."
3000 ;; 1. Without argument.
3001 (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
3002 ;; 2. With arguments.
3003 (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
3004 "{{{test(arg1,arg2)}}}\n")))
3006 (ert-deftest test-org-element
/radio-target-interpreter
()
3007 "Test radio target interpreter."
3008 (should (equal (org-test-parse-and-interpret "<<<some text>>>")
3009 "<<<some text>>>\n")))
3011 (ert-deftest test-org-element
/statistics-cookie-interpreter
()
3012 "Test statistics cookie interpreter."
3013 ;; 1. Without percent
3014 (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
3016 (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
3018 (ert-deftest test-org-element
/strike-through-interpreter
()
3019 "Test strike through interpreter."
3020 (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
3022 (ert-deftest test-org-element
/subscript-interpreter
()
3023 "Test subscript interpreter."
3024 ;; 1. Without brackets.
3025 (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
3026 ;; 2. With brackets.
3027 (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
3029 (ert-deftest test-org-element
/superscript-interpreter
()
3030 "Test superscript interpreter."
3031 ;; 1. Without brackets.
3032 (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
3033 ;; 2. With brackets.
3034 (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
3036 (ert-deftest test-org-element
/target-interpreter
()
3037 "Test target interpreter."
3038 (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
3040 (ert-deftest test-org-element
/underline-interpreter
()
3041 "Test underline interpreter."
3042 (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
3044 (ert-deftest test-org-element
/verbatim-interpreter
()
3045 "Test verbatim interpreter."
3046 (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
3050 ;;; Test Granularity
3052 (ert-deftest test-org-element
/granularity
()
3053 "Test granularity impact on buffer parsing."
3054 (org-test-with-temp-text "
3061 ;; 1.1. Granularity set to `headline' should parse every headline
3062 ;; in buffer, and only them.
3063 (let ((tree (org-element-parse-buffer 'headline
)))
3064 (should (= 2 (length (org-element-map tree
'headline
'identity
))))
3065 (should-not (org-element-map tree
'paragraph
'identity
)))
3066 ;; 1.2. Granularity set to `greater-element' should not enter
3067 ;; greater elements excepted headlines and sections.
3068 (let ((tree (org-element-parse-buffer 'greater-element
)))
3069 (should (= 1 (length (org-element-map tree
'center-block
'identity
))))
3070 (should (= 1 (length (org-element-map tree
'paragraph
'identity
))))
3071 (should-not (org-element-map tree
'entity
'identity
)))
3072 ;; 1.3. Granularity set to `element' should enter every
3074 (let ((tree (org-element-parse-buffer 'element
)))
3075 (should (= 2 (length (org-element-map tree
'paragraph
'identity
))))
3076 (should-not (org-element-map tree
'entity
'identity
)))
3077 ;; 1.4. Granularity set to `object' can see everything.
3078 (let ((tree (org-element-parse-buffer 'object
)))
3079 (should (= 1 (length (org-element-map tree
'entity
'identity
)))))))
3081 (ert-deftest test-org-element
/secondary-string-parsing
()
3082 "Test if granularity correctly toggles secondary strings parsing."
3083 ;; With a granularity bigger than `object', no secondary string
3084 ;; should be parsed.
3087 (org-test-with-temp-text "* Headline"
3089 (org-element-map (org-element-parse-buffer 'headline
) 'headline
3090 #'identity nil
'first-match
)))
3091 (org-element-property :title headline
)))))
3094 (org-test-with-temp-text "* Headline\n- tag :: item"
3095 (let ((item (org-element-map (org-element-parse-buffer 'element
) 'item
3096 #'identity nil
'first-match
)))
3097 (org-element-property :tag item
)))))
3098 (when (featurep 'org-inlinetask
)
3101 (let ((org-inlinetask-min-level 15))
3102 (org-test-with-temp-text "*************** Inlinetask"
3103 (let ((inlinetask (org-element-map (org-element-parse-buffer 'element
)
3105 #'identity nil
'first-match
)))
3106 (org-element-property :title inlinetask
)))))))
3107 ;; With a default granularity, secondary strings should be parsed.
3110 (org-test-with-temp-text "* Headline"
3112 (org-element-map (org-element-parse-buffer) 'headline
3113 #'identity nil
'first-match
)))
3114 (org-element-property :title headline
)))))
3115 ;; `org-element-at-point' should never parse a secondary string.
3118 (org-test-with-temp-text "* Headline"
3119 (org-element-property :title
(org-element-at-point)))))
3120 ;; Preserve current local variables when parsing a secondary string.
3122 (let ((org-entities nil
)
3123 (org-entities-user nil
))
3124 (org-test-with-temp-text "
3128 # org-entities-user: ((\"foo\"))
3130 (let ((safe-local-variable-values '((org-entities-user .
(("foo"))))))
3131 (hack-local-variables))
3132 (org-element-map (org-element-parse-buffer) 'entity
3133 #'identity nil nil nil t
)))))
3137 ;;; Test Visible Only Parsing
3139 (ert-deftest test-org-element
/parse-buffer-visible
()
3140 "Test `org-element-parse-buffer' with visible only argument."
3142 (equal '("H1" "H3" "H5")
3143 (org-test-with-temp-text
3144 "* H1\n** H2\n** H3 :visible:\n** H4\n** H5 :visible:"
3145 (org-occur ":visible:")
3146 (org-element-map (org-element-parse-buffer nil t
) 'headline
3147 (lambda (hl) (org-element-property :raw-value hl
)))))))
3151 ;;; Test `:parent' Property
3153 (ert-deftest test-org-element
/parent-property
()
3154 "Test `:parent' property."
3156 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
3157 (let* ((tree (org-element-parse-buffer))
3158 (parent (org-element-property
3160 (org-element-map tree
'paragraph
'identity nil t
))))
3162 (should (eq (org-element-map tree
'center-block
'identity nil t
)
3165 (org-test-with-temp-text "a_{/b/}"
3166 (let* ((tree (org-element-parse-buffer))
3167 (parent (org-element-property
3169 (org-element-map tree
'italic
'identity nil t
))))
3172 (org-element-map tree
'subscript
'identity nil t
)))))
3173 ;; Secondary strings
3174 (org-test-with-temp-text "* /italic/"
3175 (let* ((tree (org-element-parse-buffer))
3176 (parent (org-element-property
3177 :parent
(org-element-map tree
'italic
'identity nil t
))))
3180 (org-element-map tree
'headline
'identity nil t
))))))
3184 ;;; Test Normalize Contents
3186 (ert-deftest test-org-element
/normalize-contents
()
3187 "Test `org-element-normalize-contents' specifications."
3188 ;; Remove maximum common indentation from element's contents.
3191 (org-element-normalize-contents
3192 '(paragraph nil
" Two spaces\n Three spaces"))
3193 '(paragraph nil
"Two spaces\n Three spaces")))
3194 ;; Ignore objects within contents when computing maximum common
3195 ;; indentation. However, if contents start with an object, common
3196 ;; indentation is 0.
3199 (org-element-normalize-contents
3200 '(paragraph nil
" One " (emphasis nil
"space") "\n Two spaces"))
3201 '(paragraph nil
"One " (emphasis nil
"space") "\n Two spaces")))
3204 (org-element-normalize-contents
3205 '(paragraph nil
(verbatim nil
"V") "No space\n Two\n Three"))
3206 '(paragraph nil
(verbatim nil
"V") "No space\n Two\n Three")))
3207 ;; Ignore blank lines.
3210 (org-element-normalize-contents
3211 '(paragraph nil
" Two spaces\n\n \n Two spaces"))
3212 '(paragraph nil
"Two spaces\n\n \nTwo spaces")))
3215 '(paragraph nil
" Two spaces\n" (verbatim nil
"V") "\n Two spaces")
3216 (org-element-normalize-contents
3217 '(paragraph nil
" Two spaces\n " (verbatim nil
"V") "\n Two spaces"))))
3220 '(verse-block nil
"line 1\n\nline 2")
3221 (org-element-normalize-contents
3222 '(verse-block nil
" line 1\n\n line 2"))))
3223 ;; Recursively enter objects in order to compute common indentation.
3226 (org-element-normalize-contents
3227 '(paragraph nil
" Two spaces " (bold nil
" and\n One space")))
3228 '(paragraph nil
" Two spaces " (bold nil
" and\nOne space"))))
3229 ;; When optional argument is provided, ignore first line
3233 (org-element-normalize-contents
3234 '(paragraph nil
"No space\n Two spaces\n Three spaces") t
)
3235 '(paragraph nil
"No space\nTwo spaces\n Three spaces")))
3238 (org-element-normalize-contents
3239 '(paragraph nil
(verbatim nil
"V") "No space\n Two\n Three") t
)
3240 '(paragraph nil
(verbatim nil
"V") "No space\nTwo\n Three")))
3241 ;; Corner case: do not ignore indentation of string right after
3245 (org-element-normalize-contents
3246 '(paragraph nil
" 1 space" (line-break) " 2 spaces"))
3247 '(paragraph nil
"1 space" (line-break) " 2 spaces"))))
3251 ;;; Test Navigation Tools.
3253 (ert-deftest test-org-element
/at-point
()
3254 "Test `org-element-at-point' specifications."
3255 ;; Return closest element containing point.
3258 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
3259 (progn (search-forward "A")
3260 (org-element-type (org-element-at-point))))))
3261 ;; Correctly set `:parent' property.
3264 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
3265 (progn (search-forward "A")
3267 (org-element-property :parent
(org-element-at-point)))))))
3268 ;; Special case: at a blank line just below a headline, return that
3271 (equal "H1" (org-test-with-temp-text "* H1\n \n* H2\n"
3273 (org-element-property :title
(org-element-at-point)))))
3274 ;; Special case: at the very beginning of a table, return `table'
3275 ;; object instead of `table-row'.
3278 (org-test-with-temp-text "| a | b |"
3279 (org-element-type (org-element-at-point)))))
3280 ;; Special case: at the very beginning of a list or sub-list, return
3281 ;; `plain-list' object instead of `item'.
3284 (org-test-with-temp-text "- item"
3285 (org-element-type (org-element-at-point)))))
3286 ;; Special case: at the closing line of a greater element, be sure
3287 ;; to return it instead of the last element in its contents.
3290 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph\n#+END_CENTER"
3291 (progn (forward-line 2)
3292 (org-element-type (org-element-at-point))))))
3293 ;; Special case: at a blank line between two items, be sure to
3294 ;; return item above instead of the last element of its contents.
3297 (org-test-with-temp-text "- Para1\n\n- Para2"
3298 (progn (forward-line)
3300 (let ((org-list-empty-line-terminates-plain-lists nil
))
3301 (org-element-at-point)))))))
3302 ;; Special case: at the last blank line in a plain list, return it
3303 ;; instead of the last item.
3306 (org-test-with-temp-text "- Para1\n- Para2\n\nPara3"
3307 (progn (forward-line 2)
3308 (org-element-type (org-element-at-point))))))
3309 ;; Special case: when a list ends at the end of buffer and there's
3310 ;; no final newline, return last element in last item.
3313 (org-test-with-temp-text "- a"
3315 (org-element-type (org-element-at-point)))))
3316 ;; Parse a list within a block itself contained in a list.
3319 (org-test-with-temp-text
3320 "- outer\n #+begin_center\n - inner\n #+end_center"
3321 (search-forward "inner")
3323 (org-element-type (org-element-at-point)))))
3324 ;; Do not error at eob on an empty line.
3326 (org-test-with-temp-text "* H\n"
3328 (or (org-element-at-point) t
))))
3330 (ert-deftest test-org-element
/context
()
3331 "Test `org-element-context' specifications."
3332 ;; Return closest object containing point.
3335 (org-test-with-temp-text "Some *text with _under<point>line_ text*"
3336 (org-element-type (org-element-context)))))
3337 ;; Find objects in secondary strings.
3340 (org-test-with-temp-text "* Headline _<point>with_ underlining"
3341 (org-element-type (org-element-context)))))
3342 ;; Find objects in objects.
3345 (org-test-with-temp-text "| a | {<point>{{macro}}} |"
3346 (org-element-type (org-element-context)))))
3349 (org-test-with-temp-text "| a | b<point> {{{macro}}} |"
3350 (org-element-type (org-element-context)))))
3351 ;; Find objects in planning lines.
3354 (org-test-with-temp-text "* H\n SCHEDULED: <2012<point>-03-29 thu.>"
3355 (org-element-type (org-element-context)))))
3358 (org-test-with-temp-text "* H\n SCHEDULED<point>: <2012-03-29 thu.>"
3359 (org-element-type (org-element-context)))))
3360 ;; Find objects in item tags.
3363 (org-test-with-temp-text "- *bo<point>ld* ::"
3364 (org-element-type (org-element-context)))))
3367 (org-test-with-temp-text "- *bold* ::<point>"
3368 (org-element-type (org-element-context)))))
3371 (org-test-with-temp-text "- *bold* ::\n<point>"
3372 (org-element-type (org-element-context)))))
3373 ;; Do not find objects in table rules.
3376 (org-test-with-temp-text "| a | b |\n|-<point>--|---|\n| c | d |"
3377 (org-element-type (org-element-context)))))
3378 ;; Find objects in parsed affiliated keywords.
3381 (org-test-with-temp-text "#+CAPTION: {<point>{{macro}}}\n| a | b |"
3382 (org-element-type (org-element-context)))))
3385 (org-test-with-temp-text "#+caption: *<point>bold*\nParagraph"
3386 (org-element-type (org-element-context)))))
3387 ;; Find objects at the end of buffer.
3390 (org-test-with-temp-text "*bold*"
3391 (goto-char (point-max))
3392 (org-element-type (org-element-context)))))
3393 ;; Correctly set `:parent' property.
3396 (org-test-with-temp-text "Some *bold<point>* text"
3398 (org-element-property :parent
(org-element-context))))))
3399 ;; Between two objects, return the second one.
3402 (org-test-with-temp-text "<<target>><point>{{{test}}}"
3403 (org-element-type (org-element-context)))))
3404 ;; Test optional argument.
3407 (org-test-with-temp-text "Some *text with _under<point>line_ text*"
3408 (org-element-type (org-element-context (org-element-at-point))))))
3409 ;; Special case: bold object at the beginning of a headline.
3412 (org-test-with-temp-text "* *bo<point>ld*"
3413 (org-element-type (org-element-context)))))
3414 ;; Special case: incomplete cell at the end of a table row.
3417 (org-test-with-temp-text "|a|b|c<point>"
3418 (org-element-type (org-element-context)))))
3419 ;; Special case: objects in inline footnotes.
3422 (org-test-with-temp-text "[fn::[[<point>http://orgmode.org]]]"
3423 (org-element-type (org-element-context)))))
3424 ;; Special case: tags looking like a link.
3427 (org-test-with-temp-text "* Headline :file<point>:tags:"
3428 (org-element-type (org-element-context)))))
3431 (org-test-with-temp-text "* Headline :file<point>:tags: :real:tag:"
3432 (org-element-type (org-element-context))))))
3438 (ert-deftest test-org-element
/lineage
()
3439 "Test `org-element-lineage' specifications."
3440 ;; Regular tests. When applied to an element or object returned by
3441 ;; `org-element-at-point' or `org-element-context', the list is
3442 ;; limited to the current section.
3444 (equal '(paragraph center-block
)
3445 (org-test-with-temp-text
3446 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3447 (mapcar #'car
(org-element-lineage (org-element-context))))))
3449 (equal '(paragraph center-block section headline headline org-data
)
3450 (org-test-with-temp-text
3451 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3453 (org-element-lineage
3454 (org-element-map (org-element-parse-buffer) 'bold
3455 #'identity nil t
))))))
3456 ;; Test TYPES optional argument.
3459 (org-test-with-temp-text
3460 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3462 (org-element-lineage (org-element-context) '(center-block))))))
3464 (org-test-with-temp-text
3465 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3466 (org-element-lineage (org-element-context) '(example-block))))
3467 ;; Test WITH-SELF optional argument.
3469 (equal '(bold paragraph center-block
)
3470 (org-test-with-temp-text
3471 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3472 (mapcar #'car
(org-element-lineage (org-element-context) nil t
)))))
3473 ;; When TYPES and WITH-SELF are provided, the latter is also checked
3474 ;; against the former.
3476 (org-test-with-temp-text
3477 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3478 (org-element-lineage (org-element-context) '(bold) t
))))
3484 (ert-deftest test-org-element
/cache
()
3485 "Test basic expectations and common pitfalls for cache."
3489 (org-test-with-temp-text "para1\n\npara2\n\npara3"
3490 (let ((org-element-use-cache t
))
3491 (save-excursion (goto-char (point-max)) (org-element-at-point))
3494 (let ((element (org-element-at-point)))
3495 (cons (org-element-property :begin element
)
3496 (org-element-property :end element
)))))))
3497 ;; Partial shifting: when the contents of a greater element are
3498 ;; modified, only shift ending positions.
3500 (org-test-with-temp-text
3501 "#+BEGIN_CENTER\nPara1\n\nPara2\n\nPara3\n#+END_CENTER"
3502 (let ((org-element-use-cache t
))
3503 (save-excursion (search-forward "3") (org-element-at-point))
3504 (search-forward "Para2")
3506 (let ((element (org-element-property :parent
(org-element-at-point))))
3507 (equal (cons (org-element-property :begin element
)
3508 (org-element-property :end element
))
3509 (cons (point-min) (point-max)))))))
3510 ;; Re-parent shifted elements.
3513 (org-test-with-temp-text "- item\n\n\n para1\n para2"
3514 (let ((org-element-use-cache t
))
3516 (org-element-at-point)
3517 (save-excursion (goto-char (point-max)) (org-element-at-point))
3520 (goto-char (point-max))
3522 (org-element-property :parent
(org-element-at-point)))))))
3523 ;; Preserve local structures when re-parenting.
3526 (org-test-with-temp-text
3527 "#+begin_center\nP0\n\n<point>\n\n P1\n | a | b |\n| c | d |\n#+end_center"
3528 (let ((org-element-use-cache t
))
3529 (save-excursion (search-forward "| c |") (org-element-at-point))
3531 (search-forward "| c |")
3534 (org-element-property :parent
(org-element-at-point)))))))
3537 (org-test-with-temp-text
3538 "#+begin_center\nP0\n\n<point>\n\n P1\n | a | b |\n#+end_center"
3539 (let ((org-element-use-cache t
))
3540 (save-excursion (search-forward "| a |") (org-element-at-point))
3542 (search-forward "| a |")
3545 (org-element-property :parent
(org-element-at-point)))))))
3546 ;; When re-parenting, also propagate changes to list structures.
3549 (org-test-with-temp-text "\n Para\n - item<point>"
3550 (let ((org-element-use-cache t
))
3551 (org-element-at-point)
3552 (goto-char (point-min))
3554 (search-forward "- item")
3556 (length (org-element-property :structure
(org-element-at-point)))))))
3557 ;; Modifying the last line of an element alters the element below.
3559 (org-test-with-temp-text "para1\n\npara2"
3560 (let ((org-element-use-cache t
))
3561 (goto-char (point-max))
3562 (org-element-at-point)
3565 (let ((element (org-element-at-point)))
3566 (equal (cons (org-element-property :begin element
)
3567 (org-element-property :end element
))
3568 (cons (point-min) (point-max)))))))
3569 ;; Modifying the first line of an element alters the element above.
3571 (org-test-with-temp-text ": fixed-width\n:not-fixed-width"
3572 (let ((org-element-use-cache t
))
3573 (goto-char (point-max))
3574 (org-element-at-point)
3575 (search-backward ":")
3578 (let ((element (org-element-at-point)))
3579 (equal (cons (org-element-property :begin element
)
3580 (org-element-property :end element
))
3581 (cons (point-min) (point-max)))))))
3582 ;; Sensitive change: adding a line alters document structure both
3586 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n"
3587 (let ((org-element-use-cache t
))
3588 (goto-char (point-max))
3589 (org-element-at-point)
3590 (insert "#+END_EXAMPLE")
3591 (search-backward "Para1")
3592 (org-element-type (org-element-at-point))))))
3595 (org-test-with-temp-text "Para1\n\nPara2\n#+END_EXAMPLE"
3596 (let ((org-element-use-cache t
))
3597 (save-excursion (goto-char (point-max)) (org-element-at-point))
3598 (insert "#+BEGIN_EXAMPLE\n")
3599 (search-forward "Para2")
3600 (org-element-type (org-element-at-point))))))
3601 ;; Sensitive change: removing a line alters document structure both
3605 (org-test-with-temp-text
3606 "# +BEGIN_EXAMPLE\nPara1\n\nPara2\n#+END_EXAMPLE"
3607 (let ((org-element-use-cache t
))
3608 (save-excursion (goto-char (point-max)) (org-element-at-point))
3611 (search-forward "Para2")
3612 (org-element-type (org-element-at-point))))))
3615 (org-test-with-temp-text
3616 "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n# +END_EXAMPLE"
3617 (let ((org-element-use-cache t
))
3618 (save-excursion (goto-char (point-max)) (org-element-at-point))
3619 (search-forward "# ")
3621 (search-backward "Para1")
3622 (org-element-type (org-element-at-point))))))
3623 ;; Corner case: watch out drawers named "PROPERTIES" as they are
3624 ;; fragile, unlike to other drawers.
3627 (org-test-with-temp-text "* H\n:PROPERTIES:\n:A: 1\n:A<point>\n:END:"
3628 (let ((org-element-use-cache t
))
3629 (org-element-at-point)
3631 (org-element-type (org-element-at-point))))))
3632 ;; Properly handle elements not altered by modifications but whose
3633 ;; parents were removed from cache.
3635 (org-test-with-temp-text
3636 "Paragraph\n\n\n\n#+begin_center\n<point>contents\n#+end_center"
3637 (let ((org-element-use-cache t
)
3638 (parent-end (point-max)))
3639 (org-element-at-point)
3640 (save-excursion (search-backward "Paragraph")
3643 (eq (org-element-property
3644 :end
(org-element-property :parent
(org-element-at-point)))
3645 (+ parent-end
3))))))
3648 (provide 'test-org-element
)
3650 ;;; test-org-element.el ends here