test-org-element.el (test-org-element/org-open-at-point): Add test
[org-mode.git] / testing / lisp / test-org-element.el
blobee405855f2223b92d98dd5998b4fd0ba813e4c0f
1 ;;; test-org-element.el --- Tests for org-element.el
3 ;; Copyright (C) 2012, 2013, 2014 Nicolas Goaziou
5 ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
7 ;; This program is free software; you can redistribute it and/or modify
8 ;; it under the terms of the GNU General Public License as published by
9 ;; the Free Software Foundation, either version 3 of the License, or
10 ;; (at your option) any later version.
12 ;; This program is distributed in the hope that it will be useful,
13 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
14 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 ;; GNU General Public License for more details.
17 ;; You should have received a copy of the GNU General Public License
18 ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
20 ;;; Code:
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."
28 (with-temp-buffer
29 (org-mode)
30 (insert text)
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.
40 (should
41 (= 2
42 (org-test-with-temp-text "Some text \alpha
43 #+BEGIN_CENTER
44 Some other text
45 #+END_CENTER"
46 (let ((count 0))
47 (org-element-map
48 (org-element-parse-buffer) 'plain-text
49 (lambda (s) (when (string-match "text" s) (incf count))))
50 count))))
51 ;; Applies to secondary strings
52 (should
53 (org-element-map '("some " (bold nil "bold") "text") 'bold 'identity))
54 ;; Enter secondary strings before entering contents.
55 (should
56 (equal
57 "alpha"
58 (org-element-property
59 :name
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.
63 (should-not
64 (org-test-with-temp-text "#+BEGIN_CENTER\n\\alpha\n#+END_CENTER"
65 (org-element-map
66 (org-element-parse-buffer) 'entity 'identity nil nil 'center-block)))
67 ;; Use WITH-AFFILIATED argument.
68 (should
69 (equal
70 '("a" "1" "b" "2")
71 (org-test-with-temp-text "#+CAPTION[a]: 1\n#+CAPTION[b]: 2\nParagraph"
72 (org-element-map
73 (org-element-at-point) 'plain-text 'identity nil nil nil t)))))
77 ;;; Test Setters
79 (ert-deftest test-org-element/put-property ()
80 "Test `org-element-put-property' specifications."
81 ;; Standard test.
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.
89 (should
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.
95 (should
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.
104 (should
105 (equal '("b")
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))))))
112 (should
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.
121 (should-not
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.
130 (should
131 (eq :title
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))
135 nil t))))
136 ;; Outside a secondary string, return nil.
137 (should-not
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)))
141 nil t))))
143 (ert-deftest test-org-element/adopt-elements ()
144 "Test `org-element-adopt-elements' specifications."
145 ;; Adopt an element.
146 (should
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)))))))
155 ;; Adopt a string.
156 (should
157 (equal '("a" "b")
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.
168 (should
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)
174 tree))))
175 ;; Extract an element.
176 (should-not
177 (org-element-map
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)
182 tree))
183 'paragraph
184 'identity))
185 ;; Extract an object, even in a secondary string.
186 (should-not
187 (org-element-map
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)
192 tree))
193 'bold
194 'identity))
195 (should-not
196 (org-element-map
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)
201 tree))
202 'bold
203 'identity))
204 ;; Return value doesn't have any :parent set.
205 (should-not
206 (org-element-property
207 :parent
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."
215 ;; Standard test.
216 (should
217 (equal
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.
226 (should
227 (equal
228 '(entity italic)
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.
240 (should
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.
247 (should-not
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.
254 (should
255 (eq 'paragraph
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"))
260 (org-element-type
261 (org-element-property
262 :parent (org-element-map tree 'italic 'identity nil t)))))))
263 ;; Allow to replace strings with elements.
264 (should
265 (equal '("b")
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.
272 (should
273 (equal "a"
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.
280 (should
281 (equal "b"
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))))))
290 ;;; Test Parsers
292 ;;;; Affiliated Keywords
294 (ert-deftest test-org-element/affiliated-keywords-parser ()
295 "Test affiliated keywords parsing."
296 ;; Read simple keywords.
297 (should
298 (equal "para"
299 (org-element-property
300 :name
301 (org-test-with-temp-text "#+NAME: para\nParagraph"
302 (org-element-at-point)))))
303 (should
304 (= 1
305 (org-element-property
306 :begin
307 (org-test-with-temp-text "#+NAME: para\nParagraph"
308 (org-element-at-point)))))
309 ;; Parse multiple keywords.
310 (should
311 (equal
312 '("line2" "line1")
313 (org-element-property
314 :attr_ascii
315 (org-test-with-temp-text
316 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph"
317 (org-element-at-point)))))
318 ;; Parse "parsed" keywords.
319 (should
320 (equal
321 '(("caption"))
322 (org-test-with-temp-text "#+CAPTION: caption\nParagraph"
323 (car (org-element-property :caption (org-element-at-point))))))
324 ;; Parse dual keywords.
325 (should
326 (equal
327 '((("long") "short"))
328 (org-test-with-temp-text "#+CAPTION[short]: long\nParagraph"
329 (org-element-property :caption (org-element-at-point)))))
330 ;; Allow multiple caption keywords.
331 (should
332 (equal
333 '((("l2") "s2") (("l1") "s1"))
334 (org-test-with-temp-text "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph"
335 (org-element-property :caption (org-element-at-point)))))
336 (should
337 (equal
338 '((("l1")) (nil "s1"))
339 (org-test-with-temp-text "#+CAPTION[s1]:\n#+CAPTION: l1\nParagraph"
340 (org-element-property :caption (org-element-at-point)))))
341 ;; Corner case: orphaned keyword at the end of an element.
342 (should
343 (eq 'keyword
344 (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
345 (progn (search-forward "name")
346 (org-element-type (org-element-at-point))))))
347 (should-not
348 (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
349 (progn (search-forward "Some")
350 (org-element-property :name (org-element-at-point))))))
353 ;;;; Babel Call
355 (ert-deftest test-org-element/babel-call-parser ()
356 "Test `babel-call' parsing."
357 ;; Standard test.
358 (should
359 (org-test-with-temp-text "#+CALL: test()"
360 (org-element-map (org-element-parse-buffer) 'babel-call 'identity)))
361 ;; Ignore case.
362 (should
363 (org-test-with-temp-text "#+call: test()"
364 (org-element-map (org-element-parse-buffer) 'babel-call 'identity)))
365 ;; Handle non-empty blank line at the end of buffer.
366 (should
367 (org-test-with-temp-text "#+CALL: test()\n "
368 (= (org-element-property :end (org-element-at-point)) (point-max)))))
371 ;;;; Bold
373 (ert-deftest test-org-element/bold-parser ()
374 "Test `bold' parser."
375 ;; Standard test.
376 (should
377 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
378 (org-test-with-temp-text "*bold*"
379 (org-element-map (org-element-parse-buffer) 'bold 'identity nil t))))
380 ;; Multi-line markup.
381 (should
382 (equal
383 (org-element-contents
384 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
385 (org-test-with-temp-text "*first line\nsecond line*"
386 (org-element-map (org-element-parse-buffer) 'bold 'identity nil t))))
387 '("first line\nsecond line"))))
390 ;;;; Center Block
392 (ert-deftest test-org-element/center-block-parser ()
393 "Test `center-block' parser."
394 ;; Standard test.
395 (should
396 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
397 (org-element-map (org-element-parse-buffer) 'center-block 'identity)))
398 ;; Ignore case.
399 (should
400 (org-test-with-temp-text "#+begin_center\nText\n#+end_center"
401 (org-element-map (org-element-parse-buffer) 'center-block 'identity)))
402 ;; Ignore incomplete block.
403 (should-not
404 (org-test-with-temp-text "#+BEGIN_CENTER"
405 (org-element-map (org-element-parse-buffer) 'center-block
406 'identity nil t)))
407 ;; Handle non-empty blank line at the end of buffer.
408 (should
409 (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
410 (= (org-element-property :end (org-element-at-point)) (point-max)))))
413 ;;;; Clock
415 (ert-deftest test-org-element/clock-parser ()
416 "Test `clock' parser."
417 ;; Running clock.
418 (let ((clock (org-test-with-temp-text "CLOCK: [2012-01-01 sun. 00:01]"
419 (org-element-at-point))))
420 (should (eq (org-element-property :status clock) 'running))
421 (should
422 (equal (org-element-property :raw-value
423 (org-element-property :value clock))
424 "[2012-01-01 sun. 00:01]"))
425 (should-not (org-element-property :duration clock)))
426 ;; Closed clock.
427 (let ((clock
428 (org-test-with-temp-text
429 "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"
430 (org-element-at-point))))
431 (should (eq (org-element-property :status clock) 'closed))
432 (should (equal (org-element-property :raw-value
433 (org-element-property :value clock))
434 "[2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02]"))
435 (should (equal (org-element-property :duration clock) "0:01"))))
438 ;;;; Code
440 (ert-deftest test-org-element/code-parser ()
441 "Test `code' parser."
442 ;; Regular test.
443 (should
444 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
445 (org-test-with-temp-text "~code~"
446 (org-element-map (org-element-parse-buffer) 'code 'identity))))
447 ;; Multi-line markup.
448 (should
449 (equal
450 (org-element-property
451 :value
452 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
453 (org-test-with-temp-text "~first line\nsecond line~"
454 (org-element-map
455 (org-element-parse-buffer) 'code 'identity nil t))))
456 "first line\nsecond line")))
459 ;;;; Comment
461 (ert-deftest test-org-element/comment-parser ()
462 "Test `comment' parser."
463 ;; Regular comment.
464 (should
465 (org-test-with-temp-text "# Comment"
466 (org-element-map (org-element-parse-buffer) 'comment 'identity)))
467 ;; Inline comment.
468 (should
469 (org-test-with-temp-text " # Comment"
470 (org-element-map (org-element-parse-buffer) 'comment 'identity)))
471 ;; Preserve indentation.
472 (should
473 (equal
474 (org-element-property
475 :value
476 (org-test-with-temp-text "# No blank\n# One blank"
477 (org-element-map (org-element-parse-buffer) 'comment 'identity nil t)))
478 "No blank\n One blank"))
479 ;; Comment with blank lines.
480 (should
481 (equal
482 (org-element-property
483 :value
484 (org-test-with-temp-text "# First part\n# \n#\n# Second part"
485 (org-element-map (org-element-parse-buffer) 'comment 'identity nil t)))
486 "First part\n\n\nSecond part"))
487 ;; Do not mix comments and keywords.
488 (should
489 (eq 1
490 (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
491 (length (org-element-map (org-element-parse-buffer) 'comment
492 'identity)))))
493 (should
494 (equal "comment"
495 (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
496 (org-element-property
497 :value
498 (org-element-map (org-element-parse-buffer) 'comment
499 'identity nil t)))))
500 ;; Correctly handle non-empty blank lines at the end of buffer.
501 (should
502 (org-test-with-temp-text "# A\n "
503 (= (org-element-property :end (org-element-at-point)) (point-max)))))
506 ;;;; Comment Block
508 (ert-deftest test-org-element/comment-block-parser ()
509 "Test `comment-block' parser."
510 ;; Standard test.
511 (should
512 (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
513 (org-element-map (org-element-parse-buffer) 'comment-block 'identity)))
514 ;; Ignore case.
515 (should
516 (org-test-with-temp-text "#+begin_comment\nText\n#+end_comment"
517 (org-element-map (org-element-parse-buffer) 'comment-block 'identity)))
518 ;; Ignore incomplete block.
519 (should-not
520 (org-test-with-temp-text "#+BEGIN_COMMENT"
521 (org-element-map (org-element-parse-buffer) 'comment-block
522 'identity nil t)))
523 ;; Handle non-empty blank line at the end of buffer.
524 (should
525 (org-test-with-temp-text "#+BEGIN_COMMENT\nC\n#+END_COMMENT\n "
526 (= (org-element-property :end (org-element-at-point)) (point-max)))))
529 ;;;; Diary Sexp
531 (ert-deftest test-org-element/diary-sexp-parser ()
532 "Test `diary-sexp' parser."
533 ;; Standard test.
534 (should
535 (eq 'diary-sexp
536 (org-test-with-temp-text
537 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old"
538 (org-element-type (org-element-at-point)))))
539 ;; Diary sexp must live at beginning of line
540 (should-not
541 (eq 'diary-sexp
542 (org-test-with-temp-text " %%(org-bbdb-anniversaries)"
543 (org-element-type (org-element-at-point)))))
544 ;; Handle non-empty blank line at the end of buffer.
545 (should
546 (org-test-with-temp-text "%%(org-bbdb-anniversaries)\n "
547 (= (org-element-property :end (org-element-at-point)) (point-max)))))
550 ;;;; Drawer
552 (ert-deftest test-org-element/drawer-parser ()
553 "Test `drawer' parser."
554 ;; Standard test.
555 (should
556 (org-test-with-temp-text ":TEST:\nText\n:END:"
557 (org-element-map (org-element-parse-buffer) 'drawer 'identity)))
558 ;; Do not mix regular drawers and property drawers.
559 (should-not
560 (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
561 (org-element-map (org-element-parse-buffer) 'drawer 'identity nil t)))
562 ;; Ignore incomplete drawer.
563 (should-not
564 (org-test-with-temp-text ":TEST:"
565 (org-element-map (org-element-parse-buffer) 'drawer 'identity nil t)))
566 ;; Handle non-empty blank line at the end of buffer.
567 (should
568 (org-test-with-temp-text ":TEST:\nC\n:END:\n "
569 (= (org-element-property :end (org-element-at-point)) (point-max)))))
572 ;;;; Dynamic Block
574 (ert-deftest test-org-element/dynamic-block-parser ()
575 "Test `dynamic-block' parser."
576 ;; Standard test.
577 (should
578 (org-test-with-temp-text
579 "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
580 (org-element-map (org-element-parse-buffer) 'dynamic-block 'identity)))
581 ;; Ignore case.
582 (should
583 (org-test-with-temp-text
584 "#+begin: myblock :param1 val1 :param2 val2\nText\n#+end:"
585 (org-element-map (org-element-parse-buffer) 'dynamic-block 'identity)))
586 ;; Ignore incomplete block.
587 (should-not
588 (org-test-with-temp-text "#+BEGIN: myblock :param1 val1 :param2 val2"
589 (org-element-map (org-element-parse-buffer) 'dynamic-block
590 'identity nil t)))
591 ;; Handle non-empty blank line at the end of buffer.
592 (should
593 (org-test-with-temp-text "#+BEGIN: myblock :param val1\nC\n#+END:\n "
594 (= (org-element-property :end (org-element-at-point)) (point-max)))))
597 ;;;; Entity
599 (ert-deftest test-org-element/entity-parser ()
600 "Test `entity' parser."
601 ;; Without brackets.
602 (should
603 (org-test-with-temp-text "\\sin"
604 (org-element-map (org-element-parse-buffer) 'entity 'identity)))
605 ;; With brackets.
606 (should
607 (org-element-property
608 :use-brackets-p
609 (org-test-with-temp-text "\\alpha{}text"
610 (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
611 ;; User-defined entity.
612 (should
613 (equal
614 (org-element-property
615 :name
616 (let ((org-entities-user
617 '(("test" "test" nil "test" "test" "test" "test"))))
618 (org-test-with-temp-text "\\test"
619 (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
620 "test"))
621 ;; Special case: entity at the end of a container.
622 (should
623 (eq 'entity
624 (org-test-with-temp-text "*\\alpha \\beta*"
625 (search-forward "be")
626 (org-element-type (org-element-context))))))
629 ;;;; Example Block
631 (ert-deftest test-org-element/example-block-parser ()
632 "Test `example-block' parser."
633 ;; Standard test.
634 (should
635 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
636 (org-element-map (org-element-parse-buffer) 'example-block 'identity)))
637 ;; Ignore incomplete block.
638 (should-not
639 (eq 'example-block
640 (org-test-with-temp-text "#+BEGIN_EXAMPLE"
641 (org-element-type (org-element-at-point)))))
642 ;; Properly un-escape code.
643 (should
644 (equal "* Headline\n #+keyword\nText\n"
645 (org-test-with-temp-text
646 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText\n#+END_EXAMPLE"
647 (org-element-property :value (org-element-at-point)))))
648 ;; Remove block indentation according to block boundaries, unless
649 ;; block contents are less indented than block boundaries.
650 (should
651 (equal " L1\nL2\n"
652 (org-test-with-temp-text " #+BEGIN_EXAMPLE\n L1\n L2\n #+END_EXAMPLE"
653 (let ((org-src-preserve-indentation t))
654 (org-element-property :value (org-element-at-point))))))
655 (should
656 (equal
657 " L1\n L2\n"
658 (org-test-with-temp-text " #+BEGIN_EXAMPLE\n L1\n L2\n #+END_EXAMPLE"
659 (let ((org-src-preserve-indentation t))
660 (org-element-property :value (org-element-at-point))))))
661 ;; Handle non-empty blank line at the end of buffer.
662 (should
663 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nC\n#+END_EXAMPLE\n "
664 (= (org-element-property :end (org-element-at-point)) (point-max)))))
666 (ert-deftest test-org-element/block-switches ()
667 "Test `example-block' and `src-block' switches parsing."
668 (let ((org-coderef-label-format "(ref:%s)"))
669 ;; 1. Test "-i" switch.
670 (should-not
671 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
672 (org-element-property :preserve-indent (org-element-at-point))))
673 (should
674 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"
675 (org-element-property :preserve-indent (org-element-at-point))))
676 (should-not
677 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
678 (org-element-property :preserve-indent (org-element-at-point))))
679 (should
680 (org-test-with-temp-text "#+BEGIN_EXAMPLE -i\nText.\n#+END_EXAMPLE"
681 (org-element-property :preserve-indent (org-element-at-point))))
682 ;; 2. "-n -r -k" combination should number lines, retain labels but
683 ;; not use them in coderefs.
684 (should
685 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r -k\nText.\n#+END_EXAMPLE"
686 (let ((element (org-element-at-point)))
687 (and (org-element-property :number-lines element)
688 (org-element-property :retain-labels element)
689 (not (org-element-property :use-labels element))))))
690 (should
691 (org-test-with-temp-text
692 "#+BEGIN_SRC emacs-lisp -n -r -k\n(+ 1 1)\n#+END_SRC"
693 (let ((element (org-element-at-point)))
694 (and (org-element-property :number-lines element)
695 (org-element-property :retain-labels element)
696 (not (org-element-property :use-labels element))))))
697 ;; 3. "-n -r" combination should number-lines remove labels and not
698 ;; use them in coderefs.
699 (should
700 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r\nText.\n#+END_EXAMPLE"
701 (let ((element (org-element-at-point)))
702 (and (org-element-property :number-lines element)
703 (not (org-element-property :retain-labels element))
704 (not (org-element-property :use-labels element))))))
705 (should
706 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1)\n#+END_SRC"
707 (let ((element (org-element-at-point)))
708 (and (org-element-property :number-lines element)
709 (not (org-element-property :retain-labels element))
710 (not (org-element-property :use-labels element))))))
711 ;; 4. "-n" or "+n" should number lines, retain labels and use them
712 ;; in coderefs.
713 (should
714 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n\nText.\n#+END_EXAMPLE"
715 (let ((element (org-element-at-point)))
716 (and (org-element-property :number-lines element)
717 (org-element-property :retain-labels element)
718 (org-element-property :use-labels element)))))
719 (should
720 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1)\n#+END_SRC"
721 (let ((element (org-element-at-point)))
722 (and (org-element-property :number-lines element)
723 (org-element-property :retain-labels element)
724 (org-element-property :use-labels element)))))
725 (should
726 (org-test-with-temp-text "#+BEGIN_EXAMPLE +n\nText.\n#+END_EXAMPLE"
727 (let ((element (org-element-at-point)))
728 (and (org-element-property :number-lines element)
729 (org-element-property :retain-labels element)
730 (org-element-property :use-labels element)))))
731 (should
732 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp +n\n(+ 1 1)\n#+END_SRC"
733 (let ((element (org-element-at-point)))
734 (and (org-element-property :number-lines element)
735 (org-element-property :retain-labels element)
736 (org-element-property :use-labels element)))))
737 ;; 5. No switch should not number lines, but retain labels and use
738 ;; them in coderefs.
739 (should
740 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
741 (let ((element (org-element-at-point)))
742 (and (not (org-element-property :number-lines element))
743 (org-element-property :retain-labels element)
744 (org-element-property :use-labels element)))))
745 (should
746 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
747 (let ((element (org-element-at-point)))
748 (and (not (org-element-property :number-lines element))
749 (org-element-property :retain-labels element)
750 (org-element-property :use-labels element)))))
751 ;; 6. "-r" switch only: do not number lines, remove labels, and
752 ;; don't use labels in coderefs.
753 (should
754 (org-test-with-temp-text "#+BEGIN_EXAMPLE -r\nText.\n#+END_EXAMPLE"
755 (let ((element (org-element-at-point)))
756 (and (not (org-element-property :number-lines element))
757 (not (org-element-property :retain-labels element))
758 (not (org-element-property :use-labels element))))))
759 (should
760 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1)\n#+END_SRC"
761 (let ((element (org-element-at-point)))
762 (and (not (org-element-property :number-lines element))
763 (not (org-element-property :retain-labels element))
764 (not (org-element-property :use-labels element))))))
765 ;; 7. Recognize coderefs with user-defined syntax.
766 (should
767 (equal
768 "[ref:%s]"
769 (org-test-with-temp-text
770 "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText [ref:text]\n#+END_EXAMPLE"
771 (org-element-property :label-fmt (org-element-at-point)))))
772 (should
773 (equal
774 "[ref:%s]"
775 (org-test-with-temp-text
776 "#+BEGIN_SRC emacs-lisp -l \"[ref:%s]\"\n(+ 1 1) [ref:text]\n#+END_SRC"
777 (org-element-property :label-fmt (org-element-at-point)))))))
780 ;;;; Export Block
782 (ert-deftest test-org-element/export-block-parser ()
783 "Test `export-block' parser."
784 ;; Standard test.
785 (should
786 (org-test-with-temp-text "#+BEGIN_LATEX\nText\n#+END_LATEX"
787 (org-element-map
788 (let ((org-element-block-name-alist
789 '(("LATEX" . org-element-export-block-parser))))
790 (org-element-parse-buffer))
791 'export-block 'identity)))
792 ;; Ignore case.
793 (should
794 (let ((org-element-block-name-alist
795 '(("LATEX" . org-element-export-block-parser))))
796 (org-test-with-temp-text "#+begin_latex\nText\n#+end_latex"
797 (org-element-map (org-element-parse-buffer) 'export-block 'identity))))
798 ;; Ignore incomplete block.
799 (should-not
800 (let ((org-element-block-name-alist
801 '(("LATEX" . org-element-export-block-parser))))
802 (org-test-with-temp-text "#+BEGIN_LATEX"
803 (org-element-map (org-element-parse-buffer) 'export-block
804 'identity nil t))))
805 ;; Handle non-empty blank line at the end of buffer.
806 (should
807 (let ((org-element-block-name-alist
808 '(("LATEX" . org-element-export-block-parser))))
809 (org-test-with-temp-text "#+BEGIN_LATEX\nC\n#+END_LATEX\n "
810 (= (org-element-property :end (org-element-at-point)) (point-max))))))
813 ;;;; Export Snippet
815 (ert-deftest test-org-element/export-snippet-parser ()
816 "Test `export-snippet' parser."
817 (should
818 (equal
819 '("back-end" . "contents")
820 (org-test-with-temp-text "@@back-end:contents@@"
821 (org-element-map
822 (org-element-parse-buffer) 'export-snippet
823 (lambda (snippet) (cons (org-element-property :back-end snippet)
824 (org-element-property :value snippet)))
825 nil t)))))
828 ;;;; Fixed Width
830 (ert-deftest test-org-element/fixed-width-parser ()
831 "Test fixed-width area parsing."
832 ;; Preserve indentation.
833 (should
834 (org-test-with-temp-text ": no blank\n: one blank"
835 (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
836 ;; Fixed-width with empty lines.
837 (should
838 (org-test-with-temp-text ": first part\n:\n: \n: second part"
839 (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
840 ;; Parse indented fixed-width markers.
841 (should
842 (org-test-with-temp-text "Text\n : no blank\n : one blank"
843 (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
844 ;; Distinguish fixed-width areas within a list and outside of it.
845 (should
846 (= 2
847 (length
848 (org-test-with-temp-text "
849 - Item
850 : fixed-width inside
851 : fixed-width outside"
852 (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))))
853 ;; Handle non-empty blank line at the end of buffer.
854 (should
855 (org-test-with-temp-text ": A\n "
856 (= (org-element-property :end (org-element-at-point)) (point-max)))))
859 ;;;; Footnote Definition
861 (ert-deftest test-org-element/footnote-definition-parser ()
862 "Test `footnote-definition' parser."
863 (should
864 (org-test-with-temp-text "[fn:1] Definition"
865 (org-element-map (org-element-parse-buffer) 'footnote-definition
866 'identity nil t)))
867 ;; Footnote with more contents
868 (should
869 (= 29
870 (org-element-property
871 :end
872 (org-test-with-temp-text "[fn:1] Definition\n\n| a | b |"
873 (org-element-map (org-element-parse-buffer) 'footnote-definition
874 'identity nil t)))))
875 ;; Footnote starting with special syntax.
876 (should-not
877 (org-test-with-temp-text "[fn:1] - no item"
878 (org-element-map (org-element-parse-buffer) 'item 'identity)))
879 ;; Correctly handle footnote starting with an empty line.
880 (should
881 (= 9
882 (org-test-with-temp-text "[fn:1]\n\n Body"
883 (org-element-property :contents-begin (org-element-at-point)))))
884 ;; Handle non-empty blank line at the end of buffer.
885 (should
886 (org-test-with-temp-text "[fn:1] Definition\n "
887 (= (org-element-property :end (org-element-at-point)) (point-max)))))
890 ;;;; Footnotes Reference.
892 (ert-deftest test-org-element/footnote-reference-parser ()
893 "Test `footnote-reference' parser."
894 ;; 1. Parse a standard reference.
895 (org-test-with-temp-text "Text[fn:label]"
896 (should
897 (org-element-map
898 (org-element-parse-buffer) 'footnote-reference 'identity)))
899 ;; 2. Parse a normalized reference.
900 (org-test-with-temp-text "Text[1]"
901 (should
902 (org-element-map
903 (org-element-parse-buffer) 'footnote-reference 'identity)))
904 ;; 3. Parse an inline reference.
905 (org-test-with-temp-text "Text[fn:test:def]"
906 (should
907 (org-element-map
908 (org-element-parse-buffer) 'footnote-reference 'identity)))
909 ;; 4. Parse an anonymous reference.
910 (org-test-with-temp-text "Text[fn::def]"
911 (should
912 (org-element-map
913 (org-element-parse-buffer) 'footnote-reference 'identity)))
914 ;; 5. Parse nested footnotes.
915 (org-test-with-temp-text "Text[fn::def [fn:label]]"
916 (should
917 (= 2
918 (length
919 (org-element-map
920 (org-element-parse-buffer) 'footnote-reference 'identity)))))
921 ;; 6. Parse adjacent footnotes.
922 (org-test-with-temp-text "Text[fn:label1][fn:label2]"
923 (should
924 (= 2
925 (length
926 (org-element-map
927 (org-element-parse-buffer) 'footnote-reference 'identity)))))
928 ;; 7. Only properly closed footnotes are recognized as such.
929 (org-test-with-temp-text "Text[fn:label"
930 (should-not
931 (org-element-map
932 (org-element-parse-buffer) 'footnote-reference 'identity))))
935 ;;;; Headline
937 (ert-deftest test-org-element/headline-comment-keyword ()
938 "Test COMMENT keyword recognition."
939 ;; Reference test.
940 (org-test-with-temp-text "* Headline"
941 (let ((org-comment-string "COMMENT"))
942 (should-not (org-element-property :commentedp (org-element-at-point)))))
943 ;; Standard position.
944 (org-test-with-temp-text "* COMMENT Headline"
945 (let ((org-comment-string "COMMENT")
946 (headline (org-element-at-point)))
947 (should (org-element-property :commentedp headline))
948 (should (equal (org-element-property :raw-value headline) "Headline"))))
949 ;; Case sensitivity.
950 (org-test-with-temp-text "* COMMENT Headline"
951 (let* ((org-comment-string "Comment")
952 (headline (org-element-at-point)))
953 (should-not (org-element-property :commentedp headline))
954 (should (equal (org-element-property :raw-value headline)
955 "COMMENT Headline"))))
956 ;; With another keyword.
957 (org-test-with-temp-text "* TODO COMMENT Headline"
958 (let* ((org-comment-string "COMMENT")
959 (org-todo-keywords '((sequence "TODO" "DONE")))
960 (headline (org-element-at-point)))
961 (should (org-element-property :commentedp headline))
962 (should (equal (org-element-property :raw-value headline) "Headline"))))
963 ;; With the keyword only.
964 (org-test-with-temp-text "* COMMENT"
965 (let* ((org-comment-string "COMMENT")
966 (headline (org-element-at-point)))
967 (should (org-element-property :commentedp headline))
968 (should (equal (org-element-property :raw-value headline) "")))))
970 (ert-deftest test-org-element/headline-archive-tag ()
971 "Test ARCHIVE tag recognition."
972 ;; Reference test.
973 (should-not
974 (org-test-with-temp-text "* Headline"
975 (let ((org-archive-tag "ARCHIVE"))
976 (org-element-property :archivedp (org-element-at-point)))))
977 ;; Single tag.
978 (org-test-with-temp-text "* Headline :ARCHIVE:"
979 (let ((org-archive-tag "ARCHIVE"))
980 (let ((headline (org-element-at-point)))
981 (should (org-element-property :archivedp headline))
982 ;; Test tag removal.
983 (should-not (org-element-property :tags headline)))))
984 ;; Multiple tags.
985 (org-test-with-temp-text "* Headline :test:ARCHIVE:"
986 (let ((org-archive-tag "ARCHIVE"))
987 (let ((headline (org-element-at-point)))
988 (should (org-element-property :archivedp headline))
989 ;; Test tag removal.
990 (should (equal (org-element-property :tags headline) '("test"))))))
991 ;; Tag is case-sensitive.
992 (should-not
993 (org-test-with-temp-text "* Headline :ARCHIVE:"
994 (let ((org-archive-tag "Archive"))
995 (org-element-property :archivedp (org-element-at-point))))))
997 (ert-deftest test-org-element/headline-properties ()
998 "Test properties from property drawer."
999 ;; All properties from property drawer have their symbol upper
1000 ;; cased.
1001 (should
1002 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
1003 (org-element-property :FOO (org-element-at-point))))
1004 (should-not
1005 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
1006 (org-element-property :foo (org-element-at-point)))))
1009 ;;;; Horizontal Rule
1011 (ert-deftest test-org-element/horizontal-rule-parser ()
1012 "Test `horizontal-rule' parser."
1013 ;; Standard.
1014 (should
1015 (org-test-with-temp-text "-----"
1016 (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
1017 ;; Indented.
1018 (should
1019 (org-test-with-temp-text " -----"
1020 (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
1021 ;; Hyphen must be alone on the line.
1022 (should-not
1023 (org-test-with-temp-text "-----wrong"
1024 (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
1025 ;; 4 hyphens is too small.
1026 (should-not
1027 (org-test-with-temp-text "----"
1028 (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
1029 ;; Handle non-empty blank line at the end of buffer.
1030 (should
1031 (org-test-with-temp-text "-----\n "
1032 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1035 ;;;; Inline Babel Call
1037 (ert-deftest test-org-element/inline-babel-call-parser ()
1038 "Test `inline-babel-call' parser."
1039 (should
1040 (org-test-with-temp-text "call_test()"
1041 (org-element-map
1042 (org-element-parse-buffer) 'inline-babel-call 'identity))))
1045 ;;;; Inline Src Block
1047 (ert-deftest test-org-element/inline-src-block-parser ()
1048 "Test `inline-src-block' parser."
1049 (should
1050 (org-test-with-temp-text "src_emacs-lisp{(+ 1 1)}"
1051 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
1052 ;; Test parsing at the beginning of an item.
1053 (should
1054 (org-test-with-temp-text "- src_emacs-lisp{(+ 1 1)}"
1055 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity))))
1058 ;;;; Inlinetask
1060 (ert-deftest test-org-element/inlinetask-parser ()
1061 "Test `inlinetask' parser."
1062 (when (featurep 'org-inlinetask)
1063 (let ((org-inlinetask-min-level 15))
1064 ;; Regular inlinetask.
1065 (should
1066 (eq 'inlinetask
1067 (org-test-with-temp-text
1068 "*************** Task\nTest\n*************** END"
1069 (org-element-type (org-element-at-point)))))
1070 ;; Degenerate inlinetask.
1071 (should
1072 (eq 'inlinetask
1073 (org-test-with-temp-text "*************** Task"
1074 (org-element-type (org-element-at-point)))))
1075 ;; Mixed inlinetasks.
1076 (should-not
1077 (org-test-with-temp-text
1079 *************** Task
1080 *************** Task2
1081 Contents
1082 *************** END"
1083 (forward-line)
1084 (goto-char (org-element-property :end (org-element-at-point)))
1085 (eobp)))
1086 ;; TODO keyword.
1087 (should
1088 (equal
1089 "TODO"
1090 (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
1091 (org-test-with-temp-text "*************** TODO Task"
1092 (org-element-property :todo-keyword (org-element-at-point))))))
1093 ;; Planning info.
1094 (should
1095 (org-test-with-temp-text "
1096 *************** Task
1097 DEADLINE: <2012-03-29 thu.>"
1098 (forward-line)
1099 (org-element-property :deadline (org-element-at-point))))
1100 ;; Priority.
1101 (should
1104 (org-test-with-temp-text "
1105 *************** [#A] Task"
1106 (forward-line)
1107 (org-element-property :priority (org-element-at-point)))))
1108 ;; Tags.
1109 (should
1110 (equal
1111 '("test")
1112 (org-test-with-temp-text "
1113 *************** Task :test:"
1114 (forward-line)
1115 (org-element-property :tags (org-element-at-point)))))
1116 ;; Regular properties are accessed through upper case keywords.
1117 (should
1118 (org-test-with-temp-text "
1119 *************** Task
1120 :PROPERTIES:
1121 :foo: bar
1122 :END:
1123 *************** END"
1124 (forward-line)
1125 (org-element-property :FOO (org-element-at-point))))
1126 (should-not
1127 (org-test-with-temp-text "
1128 *************** Task
1129 :PROPERTIES:
1130 :foo: bar
1131 :END:
1132 *************** END"
1133 (forward-line)
1134 (org-element-property :foo (org-element-at-point))))
1135 ;; Handle non-empty blank line at the end of buffer.
1136 (should
1137 (org-test-with-temp-text "*************** Task\n*************** END\n "
1138 (= (org-element-property :end (org-element-at-point)) (point-max)))))))
1141 ;;;; Italic
1143 (ert-deftest test-org-element/italic-parser ()
1144 "Test `italic' parser."
1145 ;; Regular test.
1146 (should
1147 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1148 (org-test-with-temp-text "/italic/"
1149 (org-element-map (org-element-parse-buffer) 'italic 'identity nil t))))
1150 ;; Multi-line markup.
1151 (should
1152 (equal
1153 (org-element-contents
1154 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1155 (org-test-with-temp-text "/first line\nsecond line/"
1156 (org-element-map (org-element-parse-buffer) 'italic 'identity nil t))))
1157 '("first line\nsecond line"))))
1160 ;;;; Item
1162 (ert-deftest test-org-element/item-parser ()
1163 "Test `item' parser."
1164 ;; Standard test.
1165 (should
1166 (org-test-with-temp-text "- item"
1167 (org-element-map (org-element-parse-buffer) 'item 'identity)))
1168 ;; Counter.
1169 (should
1170 (= 6
1171 (org-element-property
1172 :counter
1173 (org-test-with-temp-text "6. [@6] item"
1174 (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
1175 ;; Tag
1176 (should
1177 (equal
1178 '("tag")
1179 (org-element-property
1180 :tag
1181 (org-test-with-temp-text "- tag :: description"
1182 (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
1183 ;; No tags in ordered lists.
1184 (should-not
1185 (org-element-property
1186 :tag
1187 (org-test-with-temp-text "1. tag :: description"
1188 (org-element-map (org-element-parse-buffer) 'item 'identity nil t))))
1189 ;; Check-boxes
1190 (should
1191 (equal
1192 '(trans on off)
1193 (org-test-with-temp-text "
1194 - [-] item 1
1195 - [X] item 1.1
1196 - [ ] item 1.2"
1197 (org-element-map
1198 (org-element-parse-buffer) 'item
1199 (lambda (item) (org-element-property :checkbox item))))))
1200 ;; Item starting with special syntax.
1201 (should
1202 (equal '(("- item"))
1203 (org-test-with-temp-text "- - item"
1204 (org-element-map (org-element-parse-buffer) 'paragraph
1205 'org-element-contents))))
1206 ;; Block in an item: ignore indentation within the block.
1207 (should
1208 (org-test-with-temp-text "- item\n #+begin_src emacs-lisp\n(+ 1 1)\n #+end_src"
1209 (forward-char)
1210 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1213 ;;;; Keyword
1215 (ert-deftest test-org-element/keyword-parser ()
1216 "Test `keyword' parser."
1217 ;; Standard test.
1218 (should
1219 (org-test-with-temp-text "#+KEYWORD: value"
1220 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1221 ;; Keywords are case-insensitive.
1222 (should
1223 (org-test-with-temp-text "#+keyword: value"
1224 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1225 ;; Affiliated keywords are not keywords.
1226 (should-not
1227 (org-test-with-temp-text "#+NAME: value
1228 Paragraph"
1229 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1230 ;; Do not mix keywords with Babel calls and dynamic blocks.
1231 (should-not
1232 (org-test-with-temp-text "#+CALL: fun()"
1233 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1234 (should-not
1235 (org-test-with-temp-text "#+BEGIN: my-fun\nBody\n#+END:"
1236 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1237 ;; Handle non-empty blank line at the end of buffer.
1238 (should
1239 (org-test-with-temp-text "#+KEYWORD: value\n "
1240 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1243 ;;;; Latex Environment
1245 (ert-deftest test-org-element/latex-environment-parser ()
1246 "Test `latex-environment' parser."
1247 (should
1248 (org-test-with-temp-text "\\begin{equation}\ne^{i\\pi}+1=0\n\\end{equation}"
1249 (org-element-map (org-element-parse-buffer) 'latex-environment 'identity)))
1250 ;; Allow nested environments.
1251 (should
1252 (equal
1253 "\\begin{outer}
1254 \\begin{inner}
1255 e^{i\\pi}+1=0
1256 \\end{inner}
1257 \\end{outer}"
1258 (org-test-with-temp-text "
1259 \\begin{outer}
1260 \\begin{inner}
1261 e^{i\\pi}+1=0
1262 \\end{inner}
1263 \\end{outer}"
1264 (org-element-property
1265 :value
1266 (org-element-map
1267 (org-element-parse-buffer) 'latex-environment 'identity nil t)))))
1268 ;; Allow environments with options and arguments.
1269 (should
1270 (eq 'latex-environment
1271 (org-test-with-temp-text
1272 "\\begin{theorem}[Euler]\ne^{i\\pi}+1=0\n\\end{theorem}"
1273 (org-element-type (org-element-at-point)))))
1274 (should
1275 (eq 'latex-environment
1276 (org-test-with-temp-text "\\begin{env}{arg}\nvalue\n\\end{env}"
1277 (org-element-type (org-element-at-point)))))
1278 (should-not
1279 (eq 'latex-environment
1280 (org-test-with-temp-text "\\begin{env}{arg} something\nvalue\n\\end{env}"
1281 (org-element-type (org-element-at-point)))))
1282 ;; Handle non-empty blank line at the end of buffer.
1283 (should
1284 (org-test-with-temp-text "\\begin{env}\n\\end{env}\n "
1285 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1288 ;;;; Latex Fragment
1290 (ert-deftest test-org-element/latex-fragment-parser ()
1291 "Test `latex-fragment' parser."
1292 (should
1293 (org-test-with-temp-text "$a$"
1294 (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
1295 (should
1296 (org-test-with-temp-text "$$a$$"
1297 (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
1298 (should
1299 (org-test-with-temp-text "\\(a\\)"
1300 (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
1301 (should
1302 (org-test-with-temp-text "\\[a\\]"
1303 (org-element-map
1304 (org-element-parse-buffer) 'latex-fragment 'identity)))
1305 ;; Test fragment at the beginning of an item.
1306 (should
1307 (eq 'latex-fragment
1308 (org-test-with-temp-text "- $x$"
1309 (progn (search-forward "$")
1310 (org-element-type (org-element-context)))))))
1313 ;;;; Line Break
1315 (ert-deftest test-org-element/line-break-parser ()
1316 "Test `line-break' parser."
1317 ;; Regular test.
1318 (should
1319 (org-test-with-temp-text "Text \\\\"
1320 (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
1321 ;; Line break with trailing white spaces.
1322 (should
1323 (org-test-with-temp-text "Text \\\\ "
1324 (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
1325 ;; Three backslashes are too much.
1326 (should-not
1327 (org-test-with-temp-text "Text \\\\\\"
1328 (org-element-map (org-element-parse-buffer) 'line-break 'identity))))
1331 ;;;; Link
1333 (ert-deftest test-org-element/link-parser ()
1334 "Test `link' parser."
1335 ;; Radio target.
1336 (should
1337 (equal
1338 "radio"
1339 (org-test-with-temp-text "<<<radio>>>A radio link"
1340 (org-update-radio-target-regexp)
1341 (org-element-property
1342 :type
1343 (org-element-map (org-element-parse-buffer) 'link #'identity nil t)))))
1344 ;; Standard link.
1346 ;; ... with description.
1347 (should
1348 (equal
1349 '("Orgmode.org")
1350 (org-test-with-temp-text "[[http://orgmode.org][Orgmode.org]]"
1351 (org-element-contents
1352 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1353 ;; ... without description.
1354 (should
1355 (equal
1356 "http"
1357 (org-test-with-temp-text "[[http://orgmode.org]]"
1358 (org-element-property
1359 :type
1360 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1361 ;; ... with expansion.
1362 (should
1363 (equal
1364 "//orgmode.org/worg"
1365 (org-test-with-temp-text "[[Org:worg]]"
1366 (let ((org-link-abbrev-alist '(("Org" . "http://orgmode.org/"))))
1367 (org-element-property
1368 :path
1369 (org-element-map (org-element-parse-buffer) 'link 'identity nil t))))))
1370 ;; ... with translation.
1371 (should
1372 (equal
1373 "127.0.0.1"
1374 (org-test-with-temp-text "[[http://orgmode.org]]"
1375 (flet ((link-translate (type path) (cons type "127.0.0.1")))
1376 (let ((org-link-translation-function 'link-translate))
1377 (org-element-property
1378 :path
1379 (org-element-map (org-element-parse-buffer) 'link
1380 'identity nil t)))))))
1381 ;; ... id link.
1382 (should
1383 (equal
1384 "id"
1385 (org-test-with-temp-text "[[id:aaaa]]"
1386 (org-element-property
1387 :type
1388 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1389 ;; ... custom-id link.
1390 (should
1391 (equal
1392 "custom-id"
1393 (org-test-with-temp-text "[[#some-id]]"
1394 (org-element-property
1395 :type
1396 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1397 ;; ... coderef link.
1398 (should
1399 (equal
1400 "coderef"
1401 (org-test-with-temp-text "[[(reference)]]"
1402 (org-element-property
1403 :type
1404 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1405 ;; ... fuzzy link.
1406 (should
1407 (equal
1408 "fuzzy"
1409 (org-test-with-temp-text "[[target-or-title]]"
1410 (org-element-property
1411 :type
1412 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1413 ;; ... file-type link with search option.
1414 (should
1415 (equal
1416 '(("file" "projects.org" "*task title"))
1417 (org-test-with-temp-text "[[file:projects.org::*task title]]"
1418 (org-element-map (org-element-parse-buffer) 'link
1419 (lambda (l) (list (org-element-property :type l)
1420 (org-element-property :path l)
1421 (org-element-property :search-option l)))))))
1422 ;; ... file-type link with application.
1423 (should
1424 (equal
1425 '(("file" "projects.org" "docview"))
1426 (org-test-with-temp-text "[[docview:projects.org]]"
1427 (org-element-map (org-element-parse-buffer) 'link
1428 (lambda (l) (list (org-element-property :type l)
1429 (org-element-property :path l)
1430 (org-element-property :application l)))))))
1431 ;; ... `:path' in a file-type link must be compatible with "file"
1432 ;; scheme in URI syntax, even if Org syntax isn't.
1433 (should
1434 (org-test-with-temp-text-in-file ""
1435 (let ((file (expand-file-name (buffer-file-name))))
1436 (insert (format "[[file://%s]]" file))
1437 (equal (org-element-property :path (org-element-context))
1438 (concat "//" file)))))
1439 (should
1440 (org-test-with-temp-text-in-file ""
1441 (let ((file (expand-file-name (buffer-file-name))))
1442 (insert (format "[[file:%s]]" file))
1443 (equal (org-element-property :path (org-element-context))
1444 (concat "//" file)))))
1445 (should
1446 (org-test-with-temp-text-in-file ""
1447 (let ((file (file-relative-name (buffer-file-name))))
1448 (insert (format "[[file:%s]]" file))
1449 (list (org-element-property :path (org-element-context)) file))))
1450 ;; Plain link.
1451 (should
1452 (org-test-with-temp-text "A link: http://orgmode.org"
1453 (org-element-map (org-element-parse-buffer) 'link 'identity)))
1454 ;; Angular link.
1455 (should
1456 (org-test-with-temp-text "A link: <http://orgmode.org>"
1457 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))
1458 ;; Link abbreviation.
1459 (should
1460 (equal "http"
1461 (org-test-with-temp-text
1462 "#+LINK: orgmode http://www.orgmode.org/\n[[orgmode:#docs]]"
1463 (progn (org-mode-restart)
1464 (goto-char (1- (point-max)))
1465 (org-element-property :type (org-element-context))))))
1466 ;; Link abbreviation in a secondary string.
1467 (should
1468 (equal "http"
1469 (org-test-with-temp-text
1470 "#+LINK: orgmode http://www.orgmode.org/\n* H [[orgmode:#docs]]"
1471 (progn (org-mode-restart)
1472 (org-element-map (org-element-parse-buffer) 'link
1473 (lambda (link) (org-element-property :type link))
1474 nil t nil t)))))
1475 ;; Plain links are allowed as description of regular links.
1476 (should
1477 (equal "file"
1478 (org-test-with-temp-text "[[http://orgmode.org][file:unicorn.jpg]]"
1479 (search-forward "file:")
1480 (org-element-property :type (org-element-context))))))
1482 (ert-deftest test-org-element/org-open-at-point ()
1483 "Test `org-open-at-point' with link being a heading property."
1484 (org-test-with-temp-text
1485 "* Headline
1486 :PROPERTIES:
1487 :URL: <point>[[info:org#Top]]
1488 :END:"
1489 (org-open-at-point)))
1491 ;;;; Macro
1493 (ert-deftest test-org-element/macro-parser ()
1494 "Test `macro' parser."
1495 ;; Without arguments.
1496 (should
1497 (org-test-with-temp-text "{{{macro}}}"
1498 (org-element-map (org-element-parse-buffer) 'macro 'identity)))
1499 ;; With arguments.
1500 (should
1501 (org-test-with-temp-text "{{{macro(arg1,arg2)}}}"
1502 (org-element-map (org-element-parse-buffer) 'macro 'identity)))
1503 ;; Properly handle protected commas in arguments...
1504 (should
1505 (= 2
1506 (length
1507 (org-test-with-temp-text "{{{macro(arg1\\,arg1,arg2)}}}"
1508 (org-element-property :args (org-element-context))))))
1509 ;; ... even when last argument ends with a protected comma.
1510 (should
1511 (equal '("C-,")
1512 (org-test-with-temp-text "{{{macro(C-\\,)}}}"
1513 (org-element-property :args (org-element-context)))))
1514 ;; Allow to escape escaping character.
1515 (should
1516 (equal '("C-\\" "")
1517 (org-test-with-temp-text "{{{macro(C-\\\\,)}}}"
1518 (org-element-property :args (org-element-context)))))
1519 ;; No need to escape backslashes elsewhere.
1520 (should
1521 (equal '("\\")
1522 (org-test-with-temp-text "{{{macro(\\)}}}"
1523 (org-element-property :args (org-element-context))))))
1526 ;;;; Node Property
1528 (ert-deftest test-org-element/node-property ()
1529 "Test `node-property' parser."
1530 ;; Standard test.
1531 (should
1532 (equal '("abc" "value")
1533 (org-test-with-temp-text ":PROPERTIES:\n:abc: value\n:END:"
1534 (progn (forward-line)
1535 (let ((element (org-element-at-point)))
1536 (list (org-element-property :key element)
1537 (org-element-property :value element)))))))
1538 ;; Value should be trimmed.
1539 (should
1540 (equal "value"
1541 (org-test-with-temp-text ":PROPERTIES:\n:abc: value \n:END:"
1542 (progn (forward-line)
1543 (let ((element (org-element-at-point)))
1544 (org-element-property :value element))))))
1545 ;; A node property requires to be wrapped within a property drawer.
1546 (should-not
1547 (eq 'node-property
1548 (org-test-with-temp-text ":abc: value"
1549 (org-element-type (org-element-at-point))))))
1552 ;;;; Paragraph
1554 (ert-deftest test-org-element/paragraph-parser ()
1555 "Test `paragraph' parser."
1556 ;; Standard test.
1557 (should
1558 (org-test-with-temp-text "Paragraph"
1559 (org-element-map (org-element-parse-buffer) 'paragraph 'identity nil t)))
1560 ;; Property find end of a paragraph stuck to another element.
1561 (should
1562 (eq ?#
1563 (org-test-with-temp-text "Paragraph\n# Comment"
1564 (org-element-map (org-element-parse-buffer) 'paragraph
1565 (lambda (p) (char-after (org-element-property :end p)))
1566 nil t))))
1567 ;; Include ill-formed Keywords.
1568 (should
1569 (org-test-with-temp-text "#+wrong_keyword something"
1570 (org-element-map (org-element-parse-buffer) 'paragraph 'identity)))
1571 ;; Include incomplete-drawers.
1572 (should
1573 (org-test-with-temp-text ":TEST:\nParagraph"
1574 (let ((elem (org-element-at-point)))
1575 (and (eq (org-element-type elem) 'paragraph)
1576 (= (point-max) (org-element-property :end elem))))))
1577 ;; Include incomplete blocks.
1578 (should
1579 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph"
1580 (let ((elem (org-element-at-point)))
1581 (and (eq (org-element-type elem) 'paragraph)
1582 (= (point-max) (org-element-property :end elem))))))
1583 ;; Include incomplete dynamic blocks.
1584 (should
1585 (org-test-with-temp-text "#+BEGIN: \nParagraph"
1586 (let ((elem (org-element-at-point)))
1587 (and (eq (org-element-type elem) 'paragraph)
1588 (= (point-max) (org-element-property :end elem))))))
1589 ;; Include incomplete latex environments.
1590 (should
1591 (org-test-with-temp-text "\begin{equation}\nParagraph"
1592 (let ((elem (org-element-at-point)))
1593 (and (eq (org-element-type elem) 'paragraph)
1594 (= (point-max) (org-element-property :end elem))))))
1595 ;; Do not steal affiliated keywords from container.
1596 (should
1597 (org-test-with-temp-text "#+ATTR_LATEX: test\n- item 1"
1598 (let ((elem (progn (search-forward "item") (org-element-at-point))))
1599 (and (eq (org-element-type elem) 'paragraph)
1600 (not (org-element-property :attr_latex elem))
1601 (/= (org-element-property :begin elem) 1)))))
1602 ;; Handle non-empty blank line at the end of buffer.
1603 (should
1604 (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
1605 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1608 ;;;; Plain List
1610 (ert-deftest test-org-element/plain-list-parser ()
1611 "Test `plain-list' parser."
1612 (org-test-with-temp-text "- item"
1613 (should (org-element-map (org-element-parse-buffer) 'plain-list 'identity)))
1614 ;; Blank lines after the list only belong to outer plain list.
1615 (should
1616 (equal
1617 '(t t)
1618 (org-test-with-temp-text "
1619 - outer
1620 - inner
1622 Outside list"
1623 (let ((endings (org-element-map (org-element-parse-buffer) 'plain-list
1624 (lambda (pl) (org-element-property :end pl)))))
1625 (list
1626 ;; Move to ending of outer list.
1627 (progn (goto-char (car endings)) (looking-at "Outside list"))
1628 ;; Move to ending of inner list.
1629 (progn (goto-char (nth 1 endings)) (looking-at "^$")))))))
1630 ;; Correctly compute end of list if it doesn't end at a line
1631 ;; beginning.
1632 (should
1633 (org-test-with-temp-text "- list\n \n "
1634 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1637 ;;;; Planning
1639 (ert-deftest test-org-element/planning-parser ()
1640 "Test `planning' parser."
1641 (should
1642 (equal "[2012-03-29 thu.]"
1643 (org-element-property
1644 :raw-value
1645 (org-element-property
1646 :closed
1647 (org-test-with-temp-text "CLOSED: [2012-03-29 thu.]"
1648 (org-element-at-point))))))
1649 (should
1650 (equal "<2012-03-29 thu.>"
1651 (org-element-property
1652 :raw-value
1653 (org-element-property
1654 :deadline
1655 (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>"
1656 (org-element-at-point))))))
1657 (should
1658 (equal "<2012-03-29 thu.>"
1659 (org-element-property
1660 :raw-value
1661 (org-element-property
1662 :scheduled
1663 (org-test-with-temp-text "SCHEDULED: <2012-03-29 thu.>"
1664 (org-element-at-point)))))))
1667 ;;;; Property Drawer
1669 (ert-deftest test-org-element/property-drawer-parser ()
1670 "Test `property-drawer' parser."
1671 ;; Standard test.
1672 (should
1673 (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
1674 (org-element-map
1675 (org-element-parse-buffer) 'property-drawer 'identity nil t)))
1676 ;; Do not mix property drawers and regular drawers.
1677 (should-not
1678 (org-test-with-temp-text ":TEST:\n:prop: value\n:END:"
1679 (org-element-map
1680 (org-element-parse-buffer) 'property-drawer 'identity nil t)))
1681 ;; Ignore incomplete drawer.
1682 (should-not
1683 (org-test-with-temp-text ":PROPERTIES:\n:prop: value"
1684 (org-element-map
1685 (org-element-parse-buffer) 'property-drawer 'identity nil t)))
1686 ;; Handle non-empty blank line at the end of buffer.
1687 (should
1688 (org-test-with-temp-text ":PROPERTIES:\n:END:\n "
1689 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1692 ;;;; Quote Block
1694 (ert-deftest test-org-element/quote-block-parser ()
1695 "Test `quote-block' parser."
1696 ;; Regular test.
1697 (should
1698 (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
1699 (org-element-map (org-element-parse-buffer) 'quote-block 'identity)))
1700 ;; Ignore incomplete block.
1701 (should-not
1702 (org-test-with-temp-text "#+BEGIN_QUOTE"
1703 (org-element-map (org-element-parse-buffer) 'quote-block 'identity nil t)))
1704 ;; Handle non-empty blank line at the end of buffer.
1705 (should
1706 (org-test-with-temp-text "#+BEGIN_QUOTE\nC\n#+END_QUOTE\n "
1707 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1710 ;;;; Radio Target
1712 (ert-deftest test-org-element/radio-target-parser ()
1713 "Test `radio-target' parser."
1714 ;; Standard test.
1715 (should
1716 (eq 'radio-target
1717 (org-test-with-temp-text "<<<radio>>>"
1718 (org-element-type (org-element-context)))))
1719 ;; Radio targets with objects.
1720 (should
1721 (eq 'radio-target
1722 (org-test-with-temp-text "<<<radio \\alpha>>>"
1723 (org-element-type (org-element-context)))))
1724 ;; Radio targets starting with an object.
1725 (should
1726 (eq 'radio-target
1727 (org-test-with-temp-text "<<<\\alpha radio>>>"
1728 (org-element-type (org-element-context)))))
1729 ;; Radio targets cannot begin or end with white space.
1730 (should-not
1731 (eq 'radio-target
1732 (org-test-with-temp-text "<<< radio>>>"
1733 (org-element-type (org-element-context)))))
1734 (should-not
1735 (eq 'radio-target
1736 (org-test-with-temp-text "<<<radio >>>"
1737 (org-element-type (org-element-context))))))
1740 ;;;; Section
1742 (ert-deftest test-org-element/section-parser ()
1743 "Test `section' parser."
1744 ;; Standard test.
1745 (should
1746 (org-test-with-temp-text "* Headline\nText"
1747 (org-element-map (org-element-parse-buffer) 'section 'identity)))
1748 ;; There's a section before the first headline.
1749 (should
1750 (org-test-with-temp-text "Text"
1751 (org-element-map (org-element-parse-buffer) 'section 'identity)))
1752 ;; A section cannot be empty.
1753 (should-not
1754 (org-test-with-temp-text "* Headline 1\n* Headline 2"
1755 (org-element-map (org-element-parse-buffer) 'section 'identity)))
1756 ;; A section doesn't contain sub-trees.
1757 (should-not
1758 (org-test-with-temp-text "* Head\nText\n** Sub-Head"
1759 (org-element-map
1760 (org-element-map (org-element-parse-buffer) 'section 'identity nil t)
1761 'headline 'identity))))
1764 ;;;; Special Block
1766 (ert-deftest test-org-element/special-block-parser ()
1767 "Test `special-block' parser."
1768 ;; Standard test.
1769 (should
1770 (equal "SPECIAL"
1771 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1772 (org-element-property :type (org-element-at-point)))))
1773 ;; Special blocks can contain paragraphs.
1774 (should
1775 (eq 'paragraph
1776 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1777 (forward-line)
1778 (org-element-type (org-element-at-point)))))
1779 ;; Ignore incomplete block.
1780 (should-not
1781 (eq 'special-block
1782 (org-test-with-temp-text "#+BEGIN_SPECIAL"
1783 (org-element-type (org-element-at-point)))))
1784 ;; Allow special characters in type.
1785 (should
1786 (equal '(special-block "SPECIAL*")
1787 (org-test-with-temp-text "#+BEGIN_SPECIAL*\nContents\n#+END_SPECIAL*"
1788 (let ((element (org-element-at-point)))
1789 (list (org-element-type element)
1790 (org-element-property :type element))))))
1791 ;; Handle non-empty blank line at the end of buffer.
1792 (should
1793 (org-test-with-temp-text "#+BEGIN_SPECIAL\nC\n#+END_SPECIAL\n "
1794 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1797 ;;;; Src Block
1799 (ert-deftest test-org-element/src-block-parser ()
1800 "Test `src-block' parser."
1801 ;; Regular tests.
1802 (should
1803 (org-test-with-temp-text "#+BEGIN_SRC org\nText\n#+END_SRC"
1804 (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
1805 ;; Ignore incomplete block.
1806 (should-not
1807 (org-test-with-temp-text "#+BEGIN_SRC"
1808 (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
1809 ;; Properly un-escape code.
1810 (should
1811 (equal "* Headline\n #+keyword\nText\n"
1812 (org-test-with-temp-text
1813 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText\n#+END_SRC"
1814 (org-element-property :value (org-element-at-point)))))
1815 ;; Remove block indentation according to block boundaries, unless
1816 ;; block contents are less indented than block boundaries.
1817 (should
1818 (equal " L1\nL2\n"
1819 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
1820 (let ((org-src-preserve-indentation t))
1821 (org-element-property :value (org-element-at-point))))))
1822 (should
1823 (equal
1824 " L1\n L2\n"
1825 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
1826 (let ((org-src-preserve-indentation t))
1827 (org-element-property :value (org-element-at-point))))))
1828 ;; Handle non-empty blank line at the end of buffer.
1829 (should
1830 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\nC\n#+END_SRC\n "
1831 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1834 ;;;; Statistics Cookie
1836 (ert-deftest test-org-element/statistics-cookie ()
1837 "Test `statistics-cookie' parser."
1838 ;; With numbers.
1839 (should
1840 (org-test-with-temp-text "[1/2]"
1841 (org-element-map (org-element-parse-buffer) 'statistics-cookie 'identity)))
1842 ;; With percents.
1843 (should
1844 (org-test-with-temp-text "[33%]"
1845 (org-element-map
1846 (org-element-parse-buffer) 'statistics-cookie 'identity))))
1849 ;;;; Strike Through
1851 (ert-deftest test-org-element/strike-through-parser ()
1852 "Test `strike-through' parser."
1853 ;; Regular test.
1854 (should
1855 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1856 (org-test-with-temp-text "+strike-through+"
1857 (org-element-map (org-element-parse-buffer) 'strike-through 'identity))))
1858 ;; Multi-line markup.
1859 (should
1860 (equal
1861 (org-element-contents
1862 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1863 (org-test-with-temp-text "+first line\nsecond line+"
1864 (org-element-map
1865 (org-element-parse-buffer) 'strike-through 'identity nil t))))
1866 '("first line\nsecond line"))))
1869 ;;;; Subscript
1871 (ert-deftest test-org-element/subscript-parser ()
1872 "Test `subscript' parser."
1873 ;; Without braces.
1874 (should
1875 (org-test-with-temp-text "a_b"
1876 (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
1877 ;; With braces.
1878 (should
1879 (org-test-with-temp-text "a_{b}"
1880 (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
1881 ;; Multiple subscripts in a paragraph.
1882 (should
1883 (= 2
1884 (org-test-with-temp-text "a_b and c_d"
1885 (length
1886 (org-element-map (org-element-parse-buffer) 'subscript 'identity))))))
1889 ;;;; Superscript
1891 (ert-deftest test-org-element/superscript-parser ()
1892 "Test `superscript' parser."
1893 ;; Without braces.
1894 (should
1895 (org-test-with-temp-text "a^b"
1896 (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
1897 ;; With braces.
1898 (should
1899 (org-test-with-temp-text "a^{b}"
1900 (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
1901 ;; Multiple superscript in a paragraph.
1902 (should
1903 (= 2
1904 (org-test-with-temp-text "a^b and c^d"
1905 (length
1906 (org-element-map
1907 (org-element-parse-buffer) 'superscript 'identity))))))
1910 ;;;; Table
1912 (ert-deftest test-org-element/table-parser ()
1913 "Test `table' parser."
1914 (should
1915 (org-test-with-temp-text "| a |"
1916 (org-element-map (org-element-parse-buffer) 'table 'identity)))
1917 ;; TBLFM keyword is case insensitive.
1918 (should
1919 (org-test-with-temp-text "| a |\n#+tblfm: test"
1920 (org-element-property
1921 :tblfm
1922 (org-element-map (org-element-parse-buffer) 'table 'identity nil t))))
1923 ;; Handle multiple TBLFM lines.
1924 (should
1925 (= 2
1926 (org-test-with-temp-text "| a |\n#+TBLFM: test1\n#+TBLFM: test2"
1927 (length (org-element-property
1928 :tblfm
1929 (org-element-map
1930 (org-element-parse-buffer) 'table 'identity nil t))))))
1931 ;; Handle non-empty blank line at the end of buffer.
1932 (should
1933 (org-test-with-temp-text "| a |\n "
1934 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1937 ;;;; Table Cell
1939 (ert-deftest test-org-element/table-cell-parser ()
1940 "Test `table-cell' parser."
1941 ;; Regular table cell.
1942 (should
1943 (org-test-with-temp-text "| a |"
1944 (org-element-map (org-element-parse-buffer) 'table-cell 'identity)))
1945 ;; Last vertical bar may be omitted.
1946 (should
1947 (org-test-with-temp-text "| a "
1948 (org-element-map (org-element-parse-buffer) 'table-cell 'identity))))
1951 ;;;; Table Row
1953 (ert-deftest test-org-element/table-row-parser ()
1954 "Test `table-row' parser."
1955 (should
1956 (equal '(standard rule)
1957 (org-test-with-temp-text "| a |\n|---|"
1958 (org-element-map
1959 (org-element-parse-buffer) 'table-row
1960 (lambda (row) (org-element-property :type row)))))))
1963 ;;;; Target
1965 (ert-deftest test-org-element/target-parser ()
1966 "Test `target' parser."
1967 (should
1968 (org-test-with-temp-text "<<target>>"
1969 (org-element-map (org-element-parse-buffer) 'target 'identity))))
1972 ;;;; Timestamp
1974 (ert-deftest test-org-element/timestamp ()
1975 "Test `timestamp' parser."
1976 ;; Active timestamp.
1977 (should
1978 (org-test-with-temp-text "<2012-03-29 16:40>"
1979 (eq (org-element-property :type (org-element-context)) 'active)))
1980 (should-not
1981 (org-test-with-temp-text "<2012-03-29 Thu>"
1982 (let ((timestamp (org-element-context)))
1983 (or (org-element-property :hour-start timestamp)
1984 (org-element-property :minute-start timestamp)))))
1985 (should
1986 (equal '(2012 3 29 16 40)
1987 (org-test-with-temp-text "<2012-03-29 Thu 16:40>"
1988 (let ((object (org-element-context)))
1989 (list (org-element-property :year-start object)
1990 (org-element-property :month-start object)
1991 (org-element-property :day-start object)
1992 (org-element-property :hour-start object)
1993 (org-element-property :minute-start object))))))
1994 ;; Inactive timestamp.
1995 (should
1996 (org-test-with-temp-text "[2012-03-29 Thu 16:40]"
1997 (eq (org-element-property :type (org-element-context)) 'inactive)))
1998 ;; Time range.
1999 (should
2000 (equal '(2012 3 29 16 40 7 30)
2001 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
2002 (let ((object (org-element-context)))
2003 (list (org-element-property :year-end object)
2004 (org-element-property :month-end object)
2005 (org-element-property :day-end object)
2006 (org-element-property :hour-end object)
2007 (org-element-property :minute-end object)
2008 (org-element-property :hour-start object)
2009 (org-element-property :minute-start object))))))
2010 (should
2011 (eq 'active-range
2012 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
2013 (org-element-property :type (org-element-context)))))
2014 ;; Date range.
2015 (should
2016 (org-test-with-temp-text "[2012-03-29 Thu 16:40]--[2012-03-29 Thu 16:41]"
2017 (eq (org-element-property :type (org-element-context)) 'inactive-range)))
2018 (should-not
2019 (org-test-with-temp-text "[2011-07-14 Thu]--[2012-03-29 Thu]"
2020 (let ((timestamp (org-element-context)))
2021 (or (org-element-property :hour-end timestamp)
2022 (org-element-property :minute-end timestamp)))))
2023 ;; With repeater, warning delay and both.
2024 (should
2025 (eq 'catch-up
2026 (org-test-with-temp-text "<2012-03-29 Thu ++1y>"
2027 (org-element-property :repeater-type (org-element-context)))))
2028 (should
2029 (eq 'first
2030 (org-test-with-temp-text "<2012-03-29 Thu --1y>"
2031 (org-element-property :warning-type (org-element-context)))))
2032 (should
2033 (equal '(cumulate all)
2034 (org-test-with-temp-text "<2012-03-29 Thu +1y -1y>"
2035 (let ((ts (org-element-context)))
2036 (list (org-element-property :repeater-type ts)
2037 (org-element-property :warning-type ts))))))
2038 ;; Timestamps are not planning elements.
2039 (should-not
2040 (org-test-with-temp-text "SCHEDULED: <2012-03-29 Thu 16:40>"
2041 (org-element-map (org-element-parse-buffer) 'timestamp 'identity))))
2044 ;;;; Underline
2046 (ert-deftest test-org-element/underline-parser ()
2047 "Test `underline' parser."
2048 ;; Regular test.
2049 (should
2050 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2051 (org-test-with-temp-text "_underline_"
2052 (org-element-map (org-element-parse-buffer) 'underline 'identity))))
2053 ;; Multi-line markup.
2054 (should
2055 (equal
2056 (org-element-contents
2057 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2058 (org-test-with-temp-text "_first line\nsecond line_"
2059 (org-element-map
2060 (org-element-parse-buffer) 'underline 'identity nil t))))
2061 '("first line\nsecond line"))))
2064 ;;;; Verbatim
2066 (ert-deftest test-org-element/verbatim-parser ()
2067 "Test `verbatim' parser."
2068 ;; Regular test.
2069 (should
2070 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2071 (org-test-with-temp-text "=verbatim="
2072 (org-element-map (org-element-parse-buffer) 'verbatim 'identity))))
2073 ;; Multi-line markup.
2074 (should
2075 (equal
2076 (org-element-property
2077 :value
2078 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2079 (org-test-with-temp-text "=first line\nsecond line="
2080 (org-element-map
2081 (org-element-parse-buffer) 'verbatim 'identity nil t))))
2082 "first line\nsecond line")))
2085 ;;;; Verse Block
2087 (ert-deftest test-org-element/verse-block-parser ()
2088 "Test `verse-block' parser."
2089 ;; Standard test.
2090 (should
2091 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
2092 (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
2093 ;; Ignore case.
2094 (should
2095 (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
2096 (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
2097 ;; Parse objects in verse blocks.
2098 (should
2099 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
2100 (org-element-map (org-element-parse-buffer) 'entity 'identity)))
2101 ;; Ignore incomplete verse block.
2102 (should-not
2103 (org-test-with-temp-text "#+BEGIN_VERSE"
2104 (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)))
2105 ;; Handle non-empty blank line at the end of buffer.
2106 (should
2107 (org-test-with-temp-text "#+BEGIN_VERSE\nC\n#+END_VERSE\n "
2108 (= (org-element-property :end (org-element-at-point)) (point-max)))))
2112 ;;; Test Interpreters.
2114 (ert-deftest test-org-element/interpret-data ()
2115 "Test `org-element-interpret-data' specifications."
2116 ;; Interpret simple affiliated keywords.
2117 (should
2118 (equal
2119 (org-element-interpret-data
2120 '(org-data nil (paragraph (:name "para") "Paragraph")))
2121 "#+NAME: para\nParagraph\n"))
2122 ;; Interpret multiple affiliated keywords.
2123 (should
2124 (equal
2125 (org-element-interpret-data
2126 '(org-data nil (paragraph (:attr_ascii ("line2" "line1")) "Paragraph")))
2127 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
2128 ;; Interpret parsed affiliated keywords.
2129 (should
2130 (equal
2131 (org-element-interpret-data
2132 '(org-data nil (paragraph (:caption (("caption"))) "Paragraph")))
2133 "#+CAPTION: caption\nParagraph\n"))
2134 ;; Interpret dual affiliated keywords.
2135 (should
2136 (equal
2137 (org-element-interpret-data
2138 '(org-data nil (paragraph (:caption ((("long") "short"))) "Paragraph")))
2139 "#+CAPTION[short]: long\nParagraph\n"))
2140 ;; Interpret multiple parsed dual keywords.
2141 (should
2142 (equal
2143 (org-element-interpret-data
2144 '(org-data nil (paragraph
2145 (:caption ((("l2") "s2") (("l1") "s1"))) "Paragraph")))
2146 "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph\n"))
2147 ;; Pseudo objects and elements are transparent.
2148 (should
2149 (equal "A B\n"
2150 (org-element-interpret-data
2151 '(paragraph nil (pseudo-object (:post-blank 1) "A") "B")
2152 '(pseudo-object))))
2153 (should
2154 (equal "A\n\nB\n"
2155 (org-element-interpret-data
2156 '(center nil
2157 (pseudo-element (:post-blank 1) (paragraph nil "A"))
2158 (paragraph nil "B"))))))
2160 (ert-deftest test-org-element/center-block-interpreter ()
2161 "Test center block interpreter."
2162 (should
2163 (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
2164 "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
2166 (ert-deftest test-org-element/drawer-interpreter ()
2167 "Test drawer interpreter."
2168 (should
2169 (equal (org-test-parse-and-interpret ":TEST:\nTest\n:END:")
2170 ":TEST:\nTest\n:END:\n")))
2172 (ert-deftest test-org-element/dynamic-block-interpreter ()
2173 "Test dynamic block interpreter."
2174 (should
2175 (equal (org-test-parse-and-interpret
2176 "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
2177 "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
2179 (ert-deftest test-org-element/footnote-definition-interpreter ()
2180 "Test footnote definition interpreter."
2181 (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
2183 (ert-deftest test-org-element/headline-interpreter ()
2184 "Test headline and section interpreters."
2185 ;; 1. Standard test.
2186 (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
2187 ;; 2. With TODO keywords.
2188 (should
2189 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2190 (org-test-parse-and-interpret "* TODO Headline"))
2191 "* TODO Headline\n"))
2192 ;; 3. With tags...
2194 ;; 3.1. ... and a positive `org-tags-column' value.
2195 (should
2196 (equal (let ((org-tags-column 20))
2197 (org-test-parse-and-interpret "* Headline :tag:"))
2198 "* Headline :tag:\n"))
2199 ;; 3.2. ... and a negative `org-tags-column' value.
2200 (should
2201 (equal (let ((org-tags-column -20))
2202 (org-test-parse-and-interpret "* Headline :tag:"))
2203 "* Headline :tag:\n"))
2204 ;; 3.3. ... and a null `org-tags-column' value.
2205 (should
2206 (equal (let ((org-tags-column 0))
2207 (org-test-parse-and-interpret "* Headline :tag:"))
2208 "* Headline :tag:\n"))
2209 ;; 4. With priority cookie.
2210 (should
2211 (equal (org-test-parse-and-interpret "* [#B] Headline")
2212 "* [#B] Headline\n"))
2213 ;; 5. With comment keyword.
2214 (should
2215 (equal (let ((org-comment-string "COMMENT"))
2216 (org-test-parse-and-interpret "* COMMENT Headline"))
2217 "* COMMENT Headline\n"))
2218 ;; 6. Keep same number of blank lines before body.
2219 (should
2220 (equal (org-test-parse-and-interpret
2221 "* Headline\n\n\nText after two blank lines.")
2222 "* Headline\n\n\nText after two blank lines.\n")))
2224 (ert-deftest test-org-element/inlinetask-interpreter ()
2225 "Test inlinetask interpretation."
2226 (when (featurep 'org-inlinetask)
2227 (let ((org-inlinetask-min-level 15))
2228 ;; 1. Regular inlinetask.
2229 (should (equal (org-test-parse-and-interpret
2230 "*************** Task\nTest\n*************** END")
2231 "*************** Task\nTest\n*************** END\n"))
2232 ;; 2. Degenerate inlinetask.
2233 (should (equal (org-test-parse-and-interpret "*************** Task")
2234 "*************** Task\n"))
2235 ;; 3. Prefer degenerate form when there are no contents.
2236 (should (equal (org-test-parse-and-interpret
2237 "*************** Task\n*************** END")
2238 "*************** Task\n"))
2239 ;; 4. With TODO keywords.
2240 (should
2241 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2242 (org-test-parse-and-interpret "*************** TODO Task"))
2243 "*************** TODO Task\n"))
2244 ;; 5. With tags...
2246 ;; 5.1. ... and a positive `org-tags-column' value.
2247 (should
2248 (equal (let ((org-tags-column 30))
2249 (org-test-parse-and-interpret "*************** Task :tag:"))
2250 "*************** Task :tag:\n"))
2251 ;; 5.2. ... and a negative `org-tags-column' value.
2252 (should
2253 (equal (let ((org-tags-column -30))
2254 (org-test-parse-and-interpret "*************** Task :tag:"))
2255 "*************** Task :tag:\n"))
2256 ;; 5.3. ... and a null `org-tags-column' value.
2257 (should
2258 (equal (let ((org-tags-column 0))
2259 (org-test-parse-and-interpret "*************** Task :tag:"))
2260 "*************** Task :tag:\n"))
2261 ;; 6. With priority cookie.
2262 (should
2263 (equal (org-test-parse-and-interpret "*************** [#B] Task")
2264 "*************** [#B] Task\n")))))
2266 (ert-deftest test-org-element/plain-list-interpreter ()
2267 "Test plain-list and item interpreters."
2268 (let ((org-list-two-spaces-after-bullet-regexp nil))
2269 ;; Unordered list.
2270 (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
2271 ;; Description list.
2272 (should
2273 (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
2274 ;; Ordered list.
2275 (should
2276 (equal (let ((org-plain-list-ordered-item-terminator t))
2277 (org-test-parse-and-interpret "1. Item"))
2278 "1. Item\n"))
2279 (should
2280 (equal (let ((org-plain-list-ordered-item-terminator ?\)))
2281 (org-test-parse-and-interpret "1) Item"))
2282 "1) Item\n"))
2283 ;; Ordered list with counter.
2284 (should
2285 (equal (let ((org-plain-list-ordered-item-terminator t))
2286 (org-test-parse-and-interpret "1. [@5] Item"))
2287 "5. [@5] Item\n"))
2288 ;; List with check-boxes.
2289 (should
2290 (equal (org-test-parse-and-interpret
2291 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
2292 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n"))
2293 ;; Item not starting with a paragraph.
2294 (should
2295 (equal (org-test-parse-and-interpret "-\n | a | b |")
2296 "- \n | a | b |\n"))
2297 ;; Special case: correctly handle "*" bullets.
2298 (should (org-test-parse-and-interpret " * item"))
2299 ;; Special case: correctly handle empty items.
2300 (should (org-test-parse-and-interpret "-"))))
2302 (ert-deftest test-org-element/quote-block-interpreter ()
2303 "Test quote block interpreter."
2304 (should (equal (org-test-parse-and-interpret
2305 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
2306 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
2308 (ert-deftest test-org-element/special-block-interpreter ()
2309 "Test special block interpreter."
2310 (should (equal (org-test-parse-and-interpret
2311 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
2312 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
2314 (ert-deftest test-org-element/babel-call-interpreter ()
2315 "Test babel call interpreter."
2316 ;; 1. Without argument.
2317 (should (equal (org-test-parse-and-interpret "#+CALL: test()")
2318 "#+CALL: test()\n"))
2319 ;; 2. With argument.
2320 (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
2321 "#+CALL: test(x=2)\n"))
2322 ;; 3. With header arguments.
2323 (should (equal (org-test-parse-and-interpret
2324 "#+CALL: test[:results output]()[:results html]")
2325 "#+CALL: test[:results output]()[:results html]\n")))
2327 (ert-deftest test-org-element/clock-interpreter ()
2328 "Test clock interpreter."
2329 ;; Running clock.
2330 (should
2331 (string-match
2332 "CLOCK: \\[2012-01-01 .* 00:01\\]"
2333 (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]")))
2334 ;; Closed clock.
2335 (should
2336 (string-match
2337 "CLOCK: \\[2012-01-01 .* 00:01\\]--\\[2012-01-01 .* 00:02\\] => 0:01"
2338 (org-test-parse-and-interpret "
2339 CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))))
2341 (ert-deftest test-org-element/comment-interpreter ()
2342 "Test comment interpreter."
2343 ;; Regular comment.
2344 (should (equal (org-test-parse-and-interpret "# Comment") "# Comment\n"))
2345 ;; Inline comment.
2346 (should (equal (org-test-parse-and-interpret " # Comment")
2347 "# Comment\n"))
2348 ;; Preserve indentation.
2349 (should (equal (org-test-parse-and-interpret " # No blank\n# One blank")
2350 "# No blank\n# One blank\n")))
2352 (ert-deftest test-org-element/comment-block-interpreter ()
2353 "Test comment block interpreter."
2354 (should (equal (org-test-parse-and-interpret
2355 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
2356 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n")))
2358 (ert-deftest test-org-element/diary-sexp ()
2359 "Test diary-sexp interpreter."
2360 (should
2361 (equal
2362 (org-test-parse-and-interpret
2363 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old")
2364 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old\n")))
2366 (ert-deftest test-org-element/example-block-interpreter ()
2367 "Test example block interpreter."
2368 ;; Without switches.
2369 (should (equal (org-test-parse-and-interpret
2370 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
2371 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
2372 ;; With switches.
2373 (should
2374 (equal (org-test-parse-and-interpret
2375 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
2376 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n"))
2377 ;; Preserve code escaping.
2378 (should
2379 (equal (org-test-parse-and-interpret
2380 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE")
2381 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE\n")))
2383 (ert-deftest test-org-element/export-block-interpreter ()
2384 "Test export block interpreter."
2385 (should (equal (org-test-parse-and-interpret
2386 "#+BEGIN_HTML\nTest\n#+END_HTML")
2387 "#+BEGIN_HTML\nTest\n#+END_HTML\n")))
2389 (ert-deftest test-org-element/fixed-width-interpreter ()
2390 "Test fixed width interpreter."
2391 ;; Standard test.
2392 (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
2393 ;; Preserve indentation.
2394 (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
2395 ": 2 blanks\n: 1 blank\n"))
2396 ;; Remove last newline character
2397 (should
2398 (equal (org-element-fixed-width-interpreter
2399 '(fixed-width (:value "Test\n")) nil)
2400 ": Test"))
2401 (should
2402 (equal (org-element-fixed-width-interpreter
2403 '(fixed-width (:value "Test")) nil)
2404 ": Test"))
2405 ;; Handle empty string.
2406 (should
2407 (equal (org-element-fixed-width-interpreter
2408 '(fixed-width (:value "")) nil)
2409 ""))
2410 ;; Handle nil value.
2411 (should-not
2412 (org-element-fixed-width-interpreter
2413 '(fixed-width (:value nil)) nil)))
2415 (ert-deftest test-org-element/horizontal-rule-interpreter ()
2416 "Test horizontal rule interpreter."
2417 (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
2419 (ert-deftest test-org-element/keyword-interpreter ()
2420 "Test keyword interpreter."
2421 (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
2422 "#+KEYWORD: value\n")))
2424 (ert-deftest test-org-element/latex-environment-interpreter ()
2425 "Test latex environment interpreter."
2426 (should (equal (org-test-parse-and-interpret
2427 "\\begin{equation}\n1+1=2\n\\end{equation}")
2428 "\\begin{equation}\n1+1=2\n\\end{equation}\n"))
2429 (should (equal (org-test-parse-and-interpret
2430 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}")
2431 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}\n")))
2433 (ert-deftest test-org-element/planning-interpreter ()
2434 "Test planning interpreter."
2435 (should
2436 (string-match
2437 "\\* Headline
2438 DEADLINE: <2012-03-29 .*?> SCHEDULED: <2012-03-29 .*?> CLOSED: \\[2012-03-29 .*?\\]"
2439 (org-test-parse-and-interpret
2440 "* Headline
2441 DEADLINE: <2012-03-29 thu.> SCHEDULED: <2012-03-29 thu.> CLOSED: [2012-03-29 thu.]"))))
2443 (ert-deftest test-org-element/property-drawer-interpreter ()
2444 "Test property drawer interpreter."
2445 (should (equal (let ((org-property-format "%-10s %s"))
2446 (org-test-parse-and-interpret
2447 ":PROPERTIES:\n:prop: value\n:END:"))
2448 ":PROPERTIES:\n:prop: value\n:END:\n")))
2450 (ert-deftest test-org-element/src-block-interpreter ()
2451 "Test src block interpreter."
2452 ;; With arguments.
2453 (should
2454 (equal (let ((org-edit-src-content-indentation 2))
2455 (org-test-parse-and-interpret
2456 "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC"))
2457 "#+BEGIN_SRC emacs-lisp :results silent\n (+ 1 1)\n#+END_SRC\n"))
2458 ;; With switches.
2459 (should
2460 (equal (let ((org-edit-src-content-indentation 2))
2461 (org-test-parse-and-interpret
2462 "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC"))
2463 "#+BEGIN_SRC emacs-lisp -n -k\n (+ 1 1)\n#+END_SRC\n"))
2464 ;; Preserve code escaping.
2465 (should
2466 (equal (let ((org-edit-src-content-indentation 2))
2467 (org-test-parse-and-interpret
2468 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC"))
2469 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC\n"))
2470 ;; Do not apply `org-edit-src-content-indentation' when preserving
2471 ;; indentation.
2472 (should
2473 (equal (let ((org-edit-src-content-indentation 2)
2474 (org-src-preserve-indentation t))
2475 (org-test-parse-and-interpret
2476 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"))
2477 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n"))
2478 (should
2479 (equal (let ((org-edit-src-content-indentation 2)
2480 (org-src-preserve-indentation nil))
2481 (org-test-parse-and-interpret
2482 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"))
2483 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC\n")))
2485 (ert-deftest test-org-element/table-interpreter ()
2486 "Test table, table-row and table-cell interpreters."
2487 ;; 1. Simple table.
2488 (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
2489 "| a | b |\n| c | d |\n"))
2490 ;; 2. With horizontal rules.
2491 (should (equal (org-test-parse-and-interpret
2492 "| a | b |\n|---+---|\n| c | d |")
2493 "| a | b |\n|---+---|\n| c | d |\n"))
2494 ;; 3. With meta-data.
2495 (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
2496 "| / | < | > |\n| * | 1 | 2 |\n"))
2497 ;; 4. With a formula.
2498 (should
2499 (equal (org-test-parse-and-interpret
2500 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)")
2501 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)\n"))
2502 ;; 5. With multiple formulas.
2503 (should
2504 (equal (org-test-parse-and-interpret
2505 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2")
2506 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2\n")))
2508 (ert-deftest test-org-element/timestamp-interpreter ()
2509 "Test timestamp interpreter."
2510 ;; Active.
2511 (should
2512 (string-match "<2012-03-29 .* 16:40>"
2513 (org-test-parse-and-interpret "<2012-03-29 thu. 16:40>")))
2514 (should
2515 (string-match "<2012-03-29 .* 16:40>"
2516 (org-element-timestamp-interpreter
2517 '(timestamp
2518 (:type active :year-start 2012 :month-start 3 :day-start 29
2519 :hour-start 16 :minute-start 40)) nil)))
2520 ;; Inactive.
2521 (should
2522 (string-match "\\[2012-03-29 .* 16:40\\]"
2523 (org-test-parse-and-interpret "[2012-03-29 thu. 16:40]")))
2524 (should
2525 (string-match
2526 "\\[2012-03-29 .* 16:40\\]"
2527 (org-element-timestamp-interpreter
2528 '(timestamp
2529 (:type inactive :year-start 2012 :month-start 3 :day-start 29
2530 :hour-start 16 :minute-start 40)) nil)))
2531 ;; Active range.
2532 (should
2533 (string-match "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2534 (org-test-parse-and-interpret
2535 "<2012-03-29 thu. 16:40>--<2012-03-29 thu. 16:41>")))
2536 (should
2537 (string-match
2538 "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2539 (org-element-timestamp-interpreter
2540 '(timestamp
2541 (:type active-range :year-start 2012 :month-start 3 :day-start 29
2542 :hour-start 16 :minute-start 40 :year-end 2012 :month-end 3
2543 :day-end 29 :hour-end 16 :minute-end 41)) nil)))
2544 ;; Inactive range.
2545 (should
2546 (string-match "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2547 (org-test-parse-and-interpret
2548 "[2012-03-29 thu. 16:40]--[2012-03-29 thu. 16:41]")))
2549 (should
2550 (string-match
2551 "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2552 (org-element-timestamp-interpreter
2553 '(timestamp
2554 (:type inactive-range :year-start 2012 :month-start 3 :day-start 29
2555 :hour-start 16 :minute-start 40 :year-end 2012 :month-end 3
2556 :day-end 29 :hour-end 16 :minute-end 41)) nil)))
2557 ;; Diary.
2558 (should (equal (org-test-parse-and-interpret "<%%diary-float t 4 2>")
2559 "<%%diary-float t 4 2>\n"))
2560 ;; Timestamp with repeater interval, with delay, with both.
2561 (should
2562 (string-match "<2012-03-29 .* \\+1y>"
2563 (org-test-parse-and-interpret "<2012-03-29 thu. +1y>")))
2564 (should
2565 (string-match
2566 "<2012-03-29 .* \\+1y>"
2567 (org-element-timestamp-interpreter
2568 '(timestamp
2569 (:type active :year-start 2012 :month-start 3 :day-start 29
2570 :repeater-type cumulate :repeater-value 1 :repeater-unit year))
2571 nil)))
2572 (should
2573 (string-match
2574 "<2012-03-29 .* -1y>"
2575 (org-element-timestamp-interpreter
2576 '(timestamp
2577 (:type active :year-start 2012 :month-start 3 :day-start 29
2578 :warning-type all :warning-value 1 :warning-unit year))
2579 nil)))
2580 (should
2581 (string-match
2582 "<2012-03-29 .* \\+1y -1y>"
2583 (org-element-timestamp-interpreter
2584 '(timestamp
2585 (:type active :year-start 2012 :month-start 3 :day-start 29
2586 :warning-type all :warning-value 1 :warning-unit year
2587 :repeater-type cumulate :repeater-value 1 :repeater-unit year))
2588 nil)))
2589 ;; Timestamp range with repeater interval
2590 (should
2591 (string-match "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2592 (org-test-parse-and-interpret
2593 "<2012-03-29 Thu +1y>--<2012-03-30 Thu +1y>")))
2594 (should
2595 (string-match
2596 "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2597 (org-element-timestamp-interpreter
2598 '(timestamp
2599 (:type active-range :year-start 2012 :month-start 3 :day-start 29
2600 :year-end 2012 :month-end 3 :day-end 30 :repeater-type cumulate
2601 :repeater-value 1 :repeater-unit year))
2602 nil))))
2604 (ert-deftest test-org-element/verse-block-interpreter ()
2605 "Test verse block interpretation."
2606 (should
2607 (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
2608 "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
2610 (ert-deftest test-org-element/bold-interpreter ()
2611 "Test bold interpreter."
2612 (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
2614 (ert-deftest test-org-element/code-interpreter ()
2615 "Test code interpreter."
2616 (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
2618 (ert-deftest test-org-element/entity-interpreter ()
2619 "Test entity interpreter."
2620 ;; 1. Without brackets.
2621 (should
2622 (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
2623 ;; 2. With brackets.
2624 (should
2625 (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
2627 (ert-deftest test-org-element/export-snippet-interpreter ()
2628 "Test export snippet interpreter."
2629 (should (equal (org-test-parse-and-interpret "@@back-end:contents@@")
2630 "@@back-end:contents@@\n")))
2632 (ert-deftest test-org-element/footnote-reference-interpreter ()
2633 "Test footnote reference interpreter."
2634 ;; 1. Regular reference.
2635 (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
2636 ;; 2. Normalized reference.
2637 (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
2638 ;; 3. Named reference.
2639 (should (equal (org-test-parse-and-interpret "Text[fn:label]")
2640 "Text[fn:label]\n"))
2641 ;; 4. Inline reference.
2642 (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
2643 "Text[fn:label:def]\n"))
2644 ;; 5. Anonymous reference.
2645 (should (equal (org-test-parse-and-interpret "Text[fn::def]")
2646 "Text[fn::def]\n")))
2648 (ert-deftest test-org-element/inline-babel-call-interpreter ()
2649 "Test inline babel call interpreter."
2650 ;; 1. Without arguments.
2651 (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
2652 ;; 2. With arguments.
2653 (should (equal (org-test-parse-and-interpret "call_test(x=2)")
2654 "call_test(x=2)\n"))
2655 ;; 3. With header arguments.
2656 (should (equal (org-test-parse-and-interpret
2657 "call_test[:results output]()[:results html]")
2658 "call_test[:results output]()[:results html]\n")))
2660 (ert-deftest test-org-element/inline-src-block-interpreter ()
2661 "Test inline src block interpreter."
2662 ;; 1. Without header argument.
2663 (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
2664 "src_emacs-lisp{(+ 1 1)}\n"))
2665 ;; 2. With header arguments.
2666 (should (equal (org-test-parse-and-interpret
2667 "src_emacs-lisp[:results silent]{(+ 1 1)}")
2668 "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
2670 (ert-deftest test-org-element/italic-interpreter ()
2671 "Test italic interpreter."
2672 (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
2674 (ert-deftest test-org-element/latex-fragment-interpreter ()
2675 "Test latex fragment interpreter."
2676 (should (equal (org-test-parse-and-interpret "\\command{}") "\\command{}\n"))
2677 (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
2678 (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
2679 (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
2680 (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
2681 (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n")))
2683 (ert-deftest test-org-element/line-break-interpreter ()
2684 "Test line break interpreter."
2685 (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
2686 "First line \\\\\nSecond line\n")))
2688 (ert-deftest test-org-element/link-interpreter ()
2689 "Test link interpreter."
2690 ;; 1. Links targeted from a radio target.
2691 (should (equal (let ((org-target-link-regexp "radio-target"))
2692 (org-test-parse-and-interpret "a radio-target"))
2693 "a radio-target\n"))
2694 ;; 2. Regular links.
2696 ;; 2.1. Without description.
2697 (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
2698 "[[http://orgmode.org]]\n"))
2699 ;; 2.2. With a description.
2700 (should (equal (org-test-parse-and-interpret
2701 "[[http://orgmode.org][Org mode]]")
2702 "[[http://orgmode.org][Org mode]]\n"))
2703 ;; 2.3. Id links.
2704 (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
2705 ;; 2.4. Custom-id links.
2706 (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
2707 ;; 2.5 Code-ref links.
2708 (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
2709 ;; 3. Normalize plain links.
2710 (should (equal (org-test-parse-and-interpret "http://orgmode.org")
2711 "[[http://orgmode.org]]\n"))
2712 ;; 4. Normalize angular links.
2713 (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
2714 "[[http://orgmode.org]]\n")))
2716 (ert-deftest test-org-element/macro-interpreter ()
2717 "Test macro interpreter."
2718 ;; 1. Without argument.
2719 (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
2720 ;; 2. With arguments.
2721 (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
2722 "{{{test(arg1,arg2)}}}\n")))
2724 (ert-deftest test-org-element/radio-target-interpreter ()
2725 "Test radio target interpreter."
2726 (should (equal (org-test-parse-and-interpret "<<<some text>>>")
2727 "<<<some text>>>\n")))
2729 (ert-deftest test-org-element/statistics-cookie-interpreter ()
2730 "Test statistics cookie interpreter."
2731 ;; 1. Without percent
2732 (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
2733 ;; 2. With percent.
2734 (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
2736 (ert-deftest test-org-element/strike-through-interpreter ()
2737 "Test strike through interpreter."
2738 (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
2740 (ert-deftest test-org-element/subscript-interpreter ()
2741 "Test subscript interpreter."
2742 ;; 1. Without brackets.
2743 (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
2744 ;; 2. With brackets.
2745 (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
2747 (ert-deftest test-org-element/superscript-interpreter ()
2748 "Test superscript interpreter."
2749 ;; 1. Without brackets.
2750 (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
2751 ;; 2. With brackets.
2752 (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
2754 (ert-deftest test-org-element/target-interpreter ()
2755 "Test target interpreter."
2756 (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
2758 (ert-deftest test-org-element/underline-interpreter ()
2759 "Test underline interpreter."
2760 (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
2762 (ert-deftest test-org-element/verbatim-interpreter ()
2763 "Test verbatim interpreter."
2764 (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
2768 ;;; Test Granularity
2770 (ert-deftest test-org-element/granularity ()
2771 "Test granularity impact on buffer parsing."
2772 (org-test-with-temp-text "
2773 * Head 1
2774 ** Head 2
2775 #+BEGIN_CENTER
2776 Centered paragraph.
2777 #+END_CENTER
2778 Paragraph \\alpha."
2779 ;; 1.1. Granularity set to `headline' should parse every headline
2780 ;; in buffer, and only them.
2781 (let ((tree (org-element-parse-buffer 'headline)))
2782 (should (= 2 (length (org-element-map tree 'headline 'identity))))
2783 (should-not (org-element-map tree 'paragraph 'identity)))
2784 ;; 1.2. Granularity set to `greater-element' should not enter
2785 ;; greater elements excepted headlines and sections.
2786 (let ((tree (org-element-parse-buffer 'greater-element)))
2787 (should (= 1 (length (org-element-map tree 'center-block 'identity))))
2788 (should (= 1 (length (org-element-map tree 'paragraph 'identity))))
2789 (should-not (org-element-map tree 'entity 'identity)))
2790 ;; 1.3. Granularity set to `element' should enter every
2791 ;; greater-element.
2792 (let ((tree (org-element-parse-buffer 'element)))
2793 (should (= 2 (length (org-element-map tree 'paragraph 'identity))))
2794 (should-not (org-element-map tree 'entity 'identity)))
2795 ;; 1.4. Granularity set to `object' can see everything.
2796 (let ((tree (org-element-parse-buffer 'object)))
2797 (should (= 1 (length (org-element-map tree 'entity 'identity)))))))
2799 (ert-deftest test-org-element/secondary-string-parsing ()
2800 "Test if granularity correctly toggles secondary strings parsing."
2801 ;; 1. With a granularity bigger than `object', no secondary string
2802 ;; should be parsed.
2804 ;; 1.1. Test with `headline' type.
2805 (org-test-with-temp-text "* Headline"
2806 (let ((headline
2807 (org-element-map (org-element-parse-buffer 'headline) 'headline
2808 'identity
2810 'first-match)))
2811 (should (stringp (org-element-property :title headline)))))
2812 ;; 1.2. Test with `item' type.
2813 (org-test-with-temp-text "* Headline\n- tag :: item"
2814 (let ((item (org-element-map (org-element-parse-buffer 'element)
2815 'item
2816 'identity
2818 'first-match)))
2819 (should (stringp (org-element-property :tag item)))))
2820 ;; 1.3. Test with `inlinetask' type, if avalaible.
2821 (when (featurep 'org-inlinetask)
2822 (let ((org-inlinetask-min-level 15))
2823 (org-test-with-temp-text "*************** Inlinetask"
2824 (let ((inlinetask (org-element-map (org-element-parse-buffer 'element)
2825 'inlinetask
2826 'identity
2828 'first-match)))
2829 (should (stringp (org-element-property :title inlinetask)))))))
2830 ;; 2. With a default granularity, secondary strings should be
2831 ;; parsed.
2832 (org-test-with-temp-text "* Headline"
2833 (let ((headline
2834 (org-element-map (org-element-parse-buffer) 'headline
2835 'identity
2837 'first-match)))
2838 (should (listp (org-element-property :title headline)))))
2839 ;; 3. `org-element-at-point' should never parse a secondary string.
2840 (org-test-with-temp-text "* Headline"
2841 (should (stringp (org-element-property :title (org-element-at-point))))))
2845 ;;; Test Visible Only Parsing
2847 (ert-deftest test-org-element/parse-buffer-visible ()
2848 "Test `org-element-parse-buffer' with visible only argument."
2849 (should
2850 (equal '("H1" "H3" "H5")
2851 (org-test-with-temp-text
2852 "* H1\n** H2\n** H3 :visible:\n** H4\n** H5 :visible:"
2853 (org-occur ":visible:")
2854 (org-element-map (org-element-parse-buffer nil t) 'headline
2855 (lambda (hl) (org-element-property :raw-value hl)))))))
2859 ;;; Test `:parent' Property
2861 (ert-deftest test-org-element/parent-property ()
2862 "Test `:parent' property."
2863 ;; Elements.
2864 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
2865 (let* ((tree (org-element-parse-buffer))
2866 (parent (org-element-property
2867 :parent
2868 (org-element-map tree 'paragraph 'identity nil t))))
2869 (should parent)
2870 (should (eq (org-element-map tree 'center-block 'identity nil t)
2871 parent))))
2872 ;; Objects.
2873 (org-test-with-temp-text "a_{/b/}"
2874 (let* ((tree (org-element-parse-buffer))
2875 (parent (org-element-property
2876 :parent
2877 (org-element-map tree 'italic 'identity nil t))))
2878 (should parent)
2879 (should (eq parent
2880 (org-element-map tree 'subscript 'identity nil t)))))
2881 ;; Secondary strings
2882 (org-test-with-temp-text "* /italic/"
2883 (let* ((tree (org-element-parse-buffer))
2884 (parent (org-element-property
2885 :parent (org-element-map tree 'italic 'identity nil t))))
2886 (should parent)
2887 (should (eq parent
2888 (org-element-map tree 'headline 'identity nil t))))))
2892 ;;; Test Normalize Contents
2894 (ert-deftest test-org-element/normalize-contents ()
2895 "Test `org-element-normalize-contents' specifications."
2896 ;; Remove maximum common indentation from element's contents.
2897 (should
2898 (equal
2899 (org-element-normalize-contents
2900 '(paragraph nil " Two spaces\n Three spaces"))
2901 '(paragraph nil "Two spaces\n Three spaces")))
2902 ;; Ignore objects within contents when computing maximum common
2903 ;; indentation.
2904 (should
2905 (equal
2906 (org-element-normalize-contents
2907 '(paragraph nil " One " (emphasis nil "space") "\n Two spaces"))
2908 '(paragraph nil "One " (emphasis nil "space") "\n Two spaces")))
2909 ;; Ignore blank lines.
2910 (should
2911 (equal
2912 (org-element-normalize-contents
2913 '(paragraph nil " Two spaces\n\n \n Two spaces"))
2914 '(paragraph nil "Two spaces\n\n \nTwo spaces")))
2915 (should
2916 (equal
2917 '(paragraph nil " Two spaces\n" (verbatim nil "V") "\n Two spaces")
2918 (org-element-normalize-contents
2919 '(paragraph nil " Two spaces\n " (verbatim nil "V") "\n Two spaces"))))
2920 ;; Recursively enter objects in order to compute common indentation.
2921 (should
2922 (equal
2923 (org-element-normalize-contents
2924 '(paragraph nil " Two spaces " (bold nil " and\n One space")))
2925 '(paragraph nil " Two spaces " (bold nil " and\nOne space"))))
2926 ;; When optional argument is provided, ignore first line
2927 ;; indentation.
2928 (should
2929 (equal
2930 (org-element-normalize-contents
2931 '(paragraph nil "No space\n Two spaces\n Three spaces") t)
2932 '(paragraph nil "No space\nTwo spaces\n Three spaces"))))
2936 ;;; Test Navigation Tools.
2938 (ert-deftest test-org-element/at-point ()
2939 "Test `org-element-at-point' specifications."
2940 ;; Return closest element containing point.
2941 (should
2942 (eq 'paragraph
2943 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
2944 (progn (search-forward "A")
2945 (org-element-type (org-element-at-point))))))
2946 ;; Correctly set `:parent' property.
2947 (should
2948 (eq 'center-block
2949 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
2950 (progn (search-forward "A")
2951 (org-element-type
2952 (org-element-property :parent (org-element-at-point)))))))
2953 ;; Special case: at a blank line just below a headline, return that
2954 ;; headline.
2955 (should
2956 (equal "H1" (org-test-with-temp-text "* H1\n \n* H2\n"
2957 (forward-line)
2958 (org-element-property :title (org-element-at-point)))))
2959 ;; Special case: at the very beginning of a table, return `table'
2960 ;; object instead of `table-row'.
2961 (should
2962 (eq 'table
2963 (org-test-with-temp-text "| a | b |"
2964 (org-element-type (org-element-at-point)))))
2965 ;; Special case: at the very beginning of a list or sub-list, return
2966 ;; `plain-list' object instead of `item'.
2967 (should
2968 (eq 'plain-list
2969 (org-test-with-temp-text "- item"
2970 (org-element-type (org-element-at-point)))))
2971 ;; Special case: at the closing line of a greater element, be sure
2972 ;; to return it instead of the last element in its contents.
2973 (should
2974 (eq 'center-block
2975 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph\n#+END_CENTER"
2976 (progn (forward-line 2)
2977 (org-element-type (org-element-at-point))))))
2978 ;; Special case: at a blank line between two items, be sure to
2979 ;; return item above instead of the last element of its contents.
2980 (should
2981 (eq 'item
2982 (org-test-with-temp-text "- Para1\n\n- Para2"
2983 (progn (forward-line)
2984 (org-element-type
2985 (let ((org-list-empty-line-terminates-plain-lists nil))
2986 (org-element-at-point)))))))
2987 ;; Special case: at the last blank line in a plain list, return it
2988 ;; instead of the last item.
2989 (should
2990 (eq 'plain-list
2991 (org-test-with-temp-text "- Para1\n- Para2\n\nPara3"
2992 (progn (forward-line 2)
2993 (org-element-type (org-element-at-point))))))
2994 ;; Special case: when a list ends at the end of buffer and there's
2995 ;; no final newline, return last element in last item.
2996 (should
2997 (eq 'paragraph
2998 (org-test-with-temp-text "- a"
2999 (end-of-line)
3000 (org-element-type (org-element-at-point)))))
3001 ;; Parse a list within a block itself contained in a list.
3002 (should
3003 (eq 'plain-list
3004 (org-test-with-temp-text
3005 "- outer\n #+begin_center\n - inner\n #+end_center"
3006 (search-forward "inner")
3007 (beginning-of-line)
3008 (org-element-type (org-element-at-point)))))
3009 ;; Do not error at eob on an empty line.
3010 (should
3011 (org-test-with-temp-text "* H\n"
3012 (forward-line)
3013 (or (org-element-at-point) t))))
3015 (ert-deftest test-org-element/context ()
3016 "Test `org-element-context' specifications."
3017 ;; Return closest object containing point.
3018 (should
3019 (eq 'underline
3020 (org-test-with-temp-text "Some *text with _underline_ text*"
3021 (progn (search-forward "under")
3022 (org-element-type (org-element-context))))))
3023 ;; Find objects in secondary strings.
3024 (should
3025 (eq 'underline
3026 (org-test-with-temp-text "* Headline _with_ underlining"
3027 (progn (search-forward "w")
3028 (org-element-type (org-element-context))))))
3029 ;; Find objects in objects.
3030 (should
3031 (eq 'macro
3032 (org-test-with-temp-text "| a | {{{macro}}} |"
3033 (progn (search-forward "{")
3034 (org-element-type (org-element-context))))))
3035 (should
3036 (eq 'table-cell
3037 (org-test-with-temp-text "| a | b {{{macro}}} |"
3038 (progn (search-forward "b")
3039 (org-element-type (org-element-context))))))
3040 ;; Find objects in planning lines.
3041 (should
3042 (eq 'timestamp
3043 (org-test-with-temp-text "* H\n SCHEDULED: <2012-03-29 thu.>"
3044 (search-forward "2012")
3045 (org-element-type (org-element-context)))))
3046 (should-not
3047 (eq 'timestamp
3048 (org-test-with-temp-text "* H\n SCHEDULED: <2012-03-29 thu.>"
3049 (search-forward "SCHEDULED")
3050 (org-element-type (org-element-context)))))
3051 ;; Find objects in document keywords.
3052 (should
3053 (eq 'macro
3054 (org-test-with-temp-text "#+DATE: {{{macro}}}"
3055 (progn (search-forward "{")
3056 (org-element-type (org-element-context))))))
3057 ;; Do not find objects in table rules.
3058 (should
3059 (eq 'table-row
3060 (org-test-with-temp-text "| a | b |\n+---+---+\n| c | d |"
3061 (forward-line)
3062 (org-element-type (org-element-context)))))
3063 ;; Find objects in parsed affiliated keywords.
3064 (should
3065 (eq 'macro
3066 (org-test-with-temp-text "#+CAPTION: {{{macro}}}\n| a | b |."
3067 (progn (search-forward "{")
3068 (org-element-type (org-element-context))))))
3069 (should
3070 (eq 'bold
3071 (org-test-with-temp-text "#+caption: *bold*\nParagraph"
3072 (progn (search-forward "*")
3073 (org-element-type (org-element-context))))))
3074 ;; Find objects at the end of buffer.
3075 (should
3076 (eq 'bold
3077 (org-test-with-temp-text "*bold*"
3078 (goto-char (point-max))
3079 (org-element-type (org-element-context)))))
3080 ;; Correctly set `:parent' property.
3081 (should
3082 (eq 'paragraph
3083 (org-test-with-temp-text "Some *bold* text"
3084 (progn (search-forward "bold")
3085 (org-element-type
3086 (org-element-property :parent (org-element-context)))))))
3087 ;; Between two objects, return the second one.
3088 (should
3089 (eq 'macro
3090 (org-test-with-temp-text "<<target>>{{{test}}}"
3091 (progn (search-forward "{")
3092 (backward-char)
3093 (org-element-type (org-element-context))))))
3094 ;; Test optional argument.
3095 (should
3096 (eq 'underline
3097 (org-test-with-temp-text "Some *text with _underline_ text*"
3098 (progn
3099 (search-forward "under")
3100 (org-element-type (org-element-context (org-element-at-point)))))))
3101 ;; Special case: bold object at the beginning of a headline.
3102 (should
3103 (eq 'bold
3104 (org-test-with-temp-text "* *bold*"
3105 (search-forward "bo")
3106 (org-element-type (org-element-context)))))
3107 ;; Special case: incomplete cell at the end of a table row.
3108 (should
3109 (eq 'table-cell
3110 (org-test-with-temp-text "|a|b|c"
3111 (goto-char (point-max))
3112 (org-element-type (org-element-context))))))
3116 ;;; Test Cache.
3118 (ert-deftest test-org-element/cache ()
3119 "Test basic expectations and common pitfalls for cache."
3120 ;; Shift positions.
3121 (should
3122 (equal '(18 . 23)
3123 (org-test-with-temp-text "para1\n\npara2\n\npara3"
3124 (let ((org-element-use-cache t))
3125 (save-excursion (goto-char (point-max)) (org-element-at-point))
3126 (insert "add")
3127 (forward-line 4)
3128 (let ((element (org-element-at-point)))
3129 (cons (org-element-property :begin element)
3130 (org-element-property :end element)))))))
3131 ;; Partial shifting: when the contents of a greater element are
3132 ;; modified, only shift ending positions.
3133 (should
3134 (org-test-with-temp-text
3135 "#+BEGIN_CENTER\nPara1\n\nPara2\n\nPara3\n#+END_CENTER"
3136 (let ((org-element-use-cache t))
3137 (save-excursion (search-forward "3") (org-element-at-point))
3138 (search-forward "Para2")
3139 (insert " ")
3140 (let ((element (org-element-property :parent (org-element-at-point))))
3141 (equal (cons (org-element-property :begin element)
3142 (org-element-property :end element))
3143 (cons (point-min) (point-max)))))))
3144 ;; Re-parent shifted elements.
3145 (should
3146 (eq 'item
3147 (org-test-with-temp-text "- item\n\n\n para1\n para2"
3148 (let ((org-element-use-cache t))
3149 (end-of-line)
3150 (org-element-at-point)
3151 (save-excursion (goto-char (point-max)) (org-element-at-point))
3152 (forward-line)
3153 (delete-char 1)
3154 (goto-char (point-max))
3155 (org-element-type
3156 (org-element-property :parent (org-element-at-point)))))))
3157 ;; Modifying the last line of an element alters the element below.
3158 (should
3159 (org-test-with-temp-text "para1\n\npara2"
3160 (let ((org-element-use-cache t))
3161 (goto-char (point-max))
3162 (org-element-at-point)
3163 (forward-line -1)
3164 (insert "merge")
3165 (let ((element (org-element-at-point)))
3166 (equal (cons (org-element-property :begin element)
3167 (org-element-property :end element))
3168 (cons (point-min) (point-max)))))))
3169 ;; Modifying the first line of an element alters the element above.
3170 (should
3171 (org-test-with-temp-text ": fixed-width\n:not-fixed-width"
3172 (let ((org-element-use-cache t))
3173 (goto-char (point-max))
3174 (org-element-at-point)
3175 (search-backward ":")
3176 (forward-char)
3177 (insert " ")
3178 (let ((element (org-element-at-point)))
3179 (equal (cons (org-element-property :begin element)
3180 (org-element-property :end element))
3181 (cons (point-min) (point-max)))))))
3182 ;; Sensitive change: adding a line alters document structure both
3183 ;; above and below.
3184 (should
3185 (eq 'example-block
3186 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n"
3187 (let ((org-element-use-cache t))
3188 (goto-char (point-max))
3189 (org-element-at-point)
3190 (insert "#+END_EXAMPLE")
3191 (search-backward "Para1")
3192 (org-element-type (org-element-at-point))))))
3193 (should
3194 (eq 'example-block
3195 (org-test-with-temp-text "Para1\n\nPara2\n#+END_EXAMPLE"
3196 (let ((org-element-use-cache t))
3197 (save-excursion (goto-char (point-max)) (org-element-at-point))
3198 (insert "#+BEGIN_EXAMPLE\n")
3199 (search-forward "Para2")
3200 (org-element-type (org-element-at-point))))))
3201 ;; Sensitive change: removing a line alters document structure both
3202 ;; above and below.
3203 (should
3204 (eq 'example-block
3205 (org-test-with-temp-text
3206 "# +BEGIN_EXAMPLE\nPara1\n\nPara2\n#+END_EXAMPLE"
3207 (let ((org-element-use-cache t))
3208 (save-excursion (goto-char (point-max)) (org-element-at-point))
3209 (forward-char)
3210 (delete-char 1)
3211 (search-forward "Para2")
3212 (org-element-type (org-element-at-point))))))
3213 (should
3214 (eq 'example-block
3215 (org-test-with-temp-text
3216 "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n# +END_EXAMPLE"
3217 (let ((org-element-use-cache t))
3218 (save-excursion (goto-char (point-max)) (org-element-at-point))
3219 (search-forward "# ")
3220 (delete-char -1)
3221 (search-backward "Para1")
3222 (org-element-type (org-element-at-point)))))))
3225 (provide 'test-org-element)
3227 ;;; test-org-element.el ends here