Update copyright years again.
[org-mode.git] / testing / lisp / test-org-element.el
blobc51f2bd245b1aad5cd4788f66d7863c6d0647931
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/set-element ()
128 "Test `org-element-set-element' specifications."
129 (org-test-with-temp-text "* Headline\n*a*"
130 (let ((tree (org-element-parse-buffer)))
131 (org-element-set-element
132 (org-element-map tree 'bold 'identity nil t)
133 '(italic nil "b"))
134 ;; Check if object is correctly replaced.
135 (should (org-element-map tree 'italic 'identity))
136 (should-not (org-element-map tree 'bold 'identity))
137 ;; Check if new object's parent is correctly set.
138 (should
140 (org-element-property :parent
141 (org-element-map tree 'italic 'identity nil t))
142 (org-element-map tree 'paragraph 'identity nil t))))))
144 (ert-deftest test-org-element/adopt-elements ()
145 "Test `org-element-adopt-elements' specifications."
146 ;; Adopt an element.
147 (should
148 (equal '(plain-text italic)
149 (org-test-with-temp-text "* Headline\n *a*"
150 (let ((tree (org-element-parse-buffer)))
151 (org-element-adopt-elements
152 (org-element-map tree 'bold 'identity nil t) '(italic nil "a"))
153 (mapcar (lambda (blob) (org-element-type blob))
154 (org-element-contents
155 (org-element-map tree 'bold 'identity nil t)))))))
156 ;; Adopt a string.
157 (should
158 (equal '("a" "b")
159 (org-test-with-temp-text "* Headline\n *a*"
160 (let ((tree (org-element-parse-buffer)))
161 (org-element-adopt-elements
162 (org-element-map tree 'bold 'identity nil t) "b")
163 (org-element-contents
164 (org-element-map tree 'bold 'identity nil t)))))))
168 ;;; Test Parsers
170 ;;;; Affiliated Keywords
172 (ert-deftest test-org-element/affiliated-keywords-parser ()
173 "Test affiliated keywords parsing."
174 ;; Read simple keywords.
175 (should
176 (equal "para"
177 (org-element-property
178 :name
179 (org-test-with-temp-text "#+NAME: para\nParagraph"
180 (org-element-at-point)))))
181 (should
182 (= 1
183 (org-element-property
184 :begin
185 (org-test-with-temp-text "#+NAME: para\nParagraph"
186 (org-element-at-point)))))
187 ;; Parse multiple keywords.
188 (should
189 (equal
190 '("line2" "line1")
191 (org-element-property
192 :attr_ascii
193 (org-test-with-temp-text
194 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph"
195 (org-element-at-point)))))
196 ;; Parse "parsed" keywords.
197 (should
198 (equal
199 '(("caption"))
200 (org-test-with-temp-text "#+CAPTION: caption\nParagraph"
201 (car (org-element-property :caption (org-element-at-point))))))
202 ;; Parse dual keywords.
203 (should
204 (equal
205 '((("long") "short"))
206 (org-test-with-temp-text "#+CAPTION[short]: long\nParagraph"
207 (org-element-property :caption (org-element-at-point)))))
208 ;; Allow multiple caption keywords.
209 (should
210 (equal
211 '((("l2") "s2") (("l1") "s1"))
212 (org-test-with-temp-text "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph"
213 (org-element-property :caption (org-element-at-point)))))
214 (should
215 (equal
216 '((("l1")) (nil "s1"))
217 (org-test-with-temp-text "#+CAPTION[s1]:\n#+CAPTION: l1\nParagraph"
218 (org-element-property :caption (org-element-at-point)))))
219 ;; Corner case: orphaned keyword at the end of an element.
220 (should
221 (eq 'keyword
222 (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
223 (progn (search-forward "name")
224 (org-element-type (org-element-at-point))))))
225 (should-not
226 (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
227 (progn (search-forward "Some")
228 (org-element-property :name (org-element-at-point))))))
231 ;;;; Babel Call
233 (ert-deftest test-org-element/babel-call-parser ()
234 "Test `babel-call' parsing."
235 ;; Standard test.
236 (should
237 (org-test-with-temp-text "#+CALL: test()"
238 (org-element-map (org-element-parse-buffer) 'babel-call 'identity)))
239 ;; Ignore case.
240 (should
241 (org-test-with-temp-text "#+call: test()"
242 (org-element-map (org-element-parse-buffer) 'babel-call 'identity)))
243 ;; Handle non-empty blank line at the end of buffer.
244 (should
245 (org-test-with-temp-text "#+CALL: test()\n "
246 (= (org-element-property :end (org-element-at-point)) (point-max)))))
249 ;;;; Bold
251 (ert-deftest test-org-element/bold-parser ()
252 "Test `bold' parser."
253 ;; Standard test.
254 (should
255 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
256 (org-test-with-temp-text "*bold*"
257 (org-element-map (org-element-parse-buffer) 'bold 'identity nil t))))
258 ;; Multi-line markup.
259 (should
260 (equal
261 (org-element-contents
262 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
263 (org-test-with-temp-text "*first line\nsecond line*"
264 (org-element-map (org-element-parse-buffer) 'bold 'identity nil t))))
265 '("first line\nsecond line"))))
268 ;;;; Center Block
270 (ert-deftest test-org-element/center-block-parser ()
271 "Test `center-block' parser."
272 ;; Standard test.
273 (should
274 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
275 (org-element-map (org-element-parse-buffer) 'center-block 'identity)))
276 ;; Ignore case.
277 (should
278 (org-test-with-temp-text "#+begin_center\nText\n#+end_center"
279 (org-element-map (org-element-parse-buffer) 'center-block 'identity)))
280 ;; Test folded block.
281 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
282 (org-cycle)
283 (should
284 (org-element-property
285 :hiddenp
286 (org-element-map (org-element-parse-buffer) 'center-block
287 'identity nil t))))
288 ;; Ignore incomplete block.
289 (should-not
290 (org-test-with-temp-text "#+BEGIN_CENTER"
291 (org-element-map (org-element-parse-buffer) 'center-block
292 'identity nil t)))
293 ;; Handle non-empty blank line at the end of buffer.
294 (should
295 (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
296 (= (org-element-property :end (org-element-at-point)) (point-max)))))
299 ;;;; Clock
301 (ert-deftest test-org-element/clock-parser ()
302 "Test `clock' parser."
303 ;; Running clock.
304 (let* ((org-clock-string "CLOCK:")
305 (clock (org-test-with-temp-text "CLOCK: [2012-01-01 sun. 00:01]"
306 (org-element-at-point))))
307 (should (eq (org-element-property :status clock) 'running))
308 (should
309 (equal (org-element-property :raw-value
310 (org-element-property :value clock))
311 "[2012-01-01 sun. 00:01]"))
312 (should-not (org-element-property :duration clock)))
313 ;; Closed clock.
314 (let* ((org-clock-string "CLOCK:")
315 (clock
316 (org-test-with-temp-text
317 "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"
318 (org-element-at-point))))
319 (should (eq (org-element-property :status clock) 'closed))
320 (should (equal (org-element-property :raw-value
321 (org-element-property :value clock))
322 "[2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02]"))
323 (should (equal (org-element-property :duration clock) "0:01"))))
326 ;;;; Code
328 (ert-deftest test-org-element/code-parser ()
329 "Test `code' parser."
330 ;; Regular test.
331 (should
332 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
333 (org-test-with-temp-text "~code~"
334 (org-element-map (org-element-parse-buffer) 'code 'identity))))
335 ;; Multi-line markup.
336 (should
337 (equal
338 (org-element-property
339 :value
340 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
341 (org-test-with-temp-text "~first line\nsecond line~"
342 (org-element-map
343 (org-element-parse-buffer) 'code 'identity nil t))))
344 "first line\nsecond line")))
347 ;;;; Comment
349 (ert-deftest test-org-element/comment-parser ()
350 "Test `comment' parser."
351 ;; Regular comment.
352 (should
353 (org-test-with-temp-text "# Comment"
354 (org-element-map (org-element-parse-buffer) 'comment 'identity)))
355 ;; Inline comment.
356 (should
357 (org-test-with-temp-text " # Comment"
358 (org-element-map (org-element-parse-buffer) 'comment 'identity)))
359 ;; Preserve indentation.
360 (should
361 (equal
362 (org-element-property
363 :value
364 (org-test-with-temp-text "# No blank\n# One blank"
365 (org-element-map (org-element-parse-buffer) 'comment 'identity nil t)))
366 "No blank\n One blank"))
367 ;; Comment with blank lines.
368 (should
369 (equal
370 (org-element-property
371 :value
372 (org-test-with-temp-text "# First part\n# \n#\n# Second part"
373 (org-element-map (org-element-parse-buffer) 'comment 'identity nil t)))
374 "First part\n\n\nSecond part"))
375 ;; Do not mix comments and keywords.
376 (should
377 (eq 1
378 (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
379 (length (org-element-map (org-element-parse-buffer) 'comment
380 'identity)))))
381 (should
382 (equal "comment"
383 (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
384 (org-element-property
385 :value
386 (org-element-map (org-element-parse-buffer) 'comment
387 'identity nil t)))))
388 ;; Correctly handle non-empty blank lines at the end of buffer.
389 (should
390 (org-test-with-temp-text "# A\n "
391 (= (org-element-property :end (org-element-at-point)) (point-max)))))
394 ;;;; Comment Block
396 (ert-deftest test-org-element/comment-block-parser ()
397 "Test `comment-block' parser."
398 ;; Standard test.
399 (should
400 (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
401 (org-element-map (org-element-parse-buffer) 'comment-block 'identity)))
402 ;; Ignore case.
403 (should
404 (org-test-with-temp-text "#+begin_comment\nText\n#+end_comment"
405 (org-element-map (org-element-parse-buffer) 'comment-block 'identity)))
406 ;; Test folded block.
407 (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
408 (org-cycle)
409 (should
410 (org-element-property
411 :hiddenp
412 (org-element-map (org-element-parse-buffer) 'comment-block
413 'identity nil t))))
414 ;; Ignore incomplete block.
415 (should-not
416 (org-test-with-temp-text "#+BEGIN_COMMENT"
417 (org-element-map (org-element-parse-buffer) 'comment-block
418 'identity nil t)))
419 ;; Handle non-empty blank line at the end of buffer.
420 (should
421 (org-test-with-temp-text "#+BEGIN_COMMENT\nC\n#+END_COMMENT\n "
422 (= (org-element-property :end (org-element-at-point)) (point-max)))))
425 ;;;; Diary Sexp
427 (ert-deftest test-org-element/diary-sexp-parser ()
428 "Test `diary-sexp' parser."
429 ;; Standard test.
430 (should
431 (eq 'diary-sexp
432 (org-test-with-temp-text
433 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old"
434 (org-element-type (org-element-at-point)))))
435 ;; Diary sexp must live at beginning of line
436 (should-not
437 (eq 'diary-sexp
438 (org-test-with-temp-text " %%(org-bbdb-anniversaries)"
439 (org-element-type (org-element-at-point)))))
440 ;; Handle non-empty blank line at the end of buffer.
441 (should
442 (org-test-with-temp-text "%%(org-bbdb-anniversaries)\n "
443 (= (org-element-property :end (org-element-at-point)) (point-max)))))
446 ;;;; Drawer
448 (ert-deftest test-org-element/drawer-parser ()
449 "Test `drawer' parser."
450 ;; Standard test.
451 (should
452 (let ((org-drawers '("TEST")))
453 (org-test-with-temp-text ":TEST:\nText\n:END:"
454 (org-element-map (org-element-parse-buffer) 'drawer 'identity))))
455 ;; Do not mix regular drawers and property drawers.
456 (should-not
457 (let ((org-drawers '("PROPERTIES")))
458 (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
459 (org-element-map (org-element-parse-buffer) 'drawer 'identity nil t))))
460 ;; Ignore incomplete drawer.
461 (should-not
462 (let ((org-drawers '("TEST")))
463 (org-test-with-temp-text ":TEST:"
464 (org-element-map (org-element-parse-buffer) 'drawer 'identity nil t))))
465 ;; Handle non-empty blank line at the end of buffer.
466 (should
467 (org-test-with-temp-text ":TEST:\nC\n:END:\n "
468 (= (org-element-property :end (org-element-at-point)) (point-max)))))
471 ;;;; Dynamic Block
473 (ert-deftest test-org-element/dynamic-block-parser ()
474 "Test `dynamic-block' parser."
475 ;; Standard test.
476 (should
477 (org-test-with-temp-text
478 "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
479 (org-element-map (org-element-parse-buffer) 'dynamic-block 'identity)))
480 ;; Folded view
481 (org-test-with-temp-text
482 "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
483 (org-cycle)
484 (should
485 (org-element-property
486 :hiddenp
487 (org-element-map (org-element-parse-buffer) 'dynamic-block
488 'identity nil t))))
489 ;; Ignore case.
490 (should
491 (org-test-with-temp-text
492 "#+begin: myblock :param1 val1 :param2 val2\nText\n#+end:"
493 (org-element-map (org-element-parse-buffer) 'dynamic-block 'identity)))
494 ;; Ignore incomplete block.
495 (should-not
496 (org-test-with-temp-text "#+BEGIN: myblock :param1 val1 :param2 val2"
497 (org-element-map (org-element-parse-buffer) 'dynamic-block
498 'identity nil t)))
499 ;; Handle non-empty blank line at the end of buffer.
500 (should
501 (org-test-with-temp-text "#+BEGIN: myblock :param val1\nC\n#+END:\n "
502 (= (org-element-property :end (org-element-at-point)) (point-max)))))
505 ;;;; Entity
507 (ert-deftest test-org-element/entity-parser ()
508 "Test `entity' parser."
509 ;; Without brackets.
510 (should
511 (org-test-with-temp-text "\\sin"
512 (org-element-map (org-element-parse-buffer) 'entity 'identity)))
513 ;; With brackets.
514 (should
515 (org-element-property
516 :use-brackets-p
517 (org-test-with-temp-text "\\alpha{}text"
518 (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
519 ;; User-defined entity.
520 (should
521 (equal
522 (org-element-property
523 :name
524 (let ((org-entities-user
525 '(("test" "test" nil "test" "test" "test" "test"))))
526 (org-test-with-temp-text "\\test"
527 (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
528 "test"))
529 ;; Special case: entity at the end of a container.
530 (should
531 (eq 'entity
532 (org-test-with-temp-text "*\\alpha \\beta*"
533 (search-forward "be")
534 (org-element-type (org-element-context))))))
537 ;;;; Example Block
539 (ert-deftest test-org-element/example-block-parser ()
540 "Test `example-block' parser."
541 ;; Standard test.
542 (should
543 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
544 (org-element-map (org-element-parse-buffer) 'example-block 'identity)))
545 ;; Test folded block.
546 (should
547 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
548 (org-cycle)
549 (org-element-property :hiddenp (org-element-at-point))))
550 ;; Ignore incomplete block.
551 (should-not
552 (eq 'example-block
553 (org-test-with-temp-text "#+BEGIN_EXAMPLE"
554 (org-element-type (org-element-at-point)))))
555 ;; Properly un-escape code.
556 (should
557 (equal "* Headline\n #+keyword\nText\n"
558 (org-test-with-temp-text
559 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText\n#+END_EXAMPLE"
560 (org-element-property :value (org-element-at-point)))))
561 ;; Nil `org-src-preserve-indentation': Remove maximum common
562 ;; indentation.
563 (should
564 (equal " L1\nL2\n"
565 (org-test-with-temp-text "#+BEGIN_EXAMPLE\n L1\n L2\n#+END_EXAMPLE"
566 (let ((org-src-preserve-indentation nil))
567 (org-element-property :value (org-element-at-point))))))
568 ;; Non-nil `org-src-preserve-indentation': Remove block indentation
569 ;; only, unless block contents are less indented than block
570 ;; boundaries.
571 (should
572 (equal " L1\nL2\n"
573 (org-test-with-temp-text " #+BEGIN_EXAMPLE\n L1\n L2\n #+END_EXAMPLE"
574 (let ((org-src-preserve-indentation t))
575 (org-element-property :value (org-element-at-point))))))
576 (should
577 (equal
578 " L1\n L2\n"
579 (org-test-with-temp-text " #+BEGIN_EXAMPLE\n L1\n L2\n #+END_EXAMPLE"
580 (let ((org-src-preserve-indentation t))
581 (org-element-property :value (org-element-at-point))))))
582 ;; Handle non-empty blank line at the end of buffer.
583 (should
584 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nC\n#+END_EXAMPLE\n "
585 (= (org-element-property :end (org-element-at-point)) (point-max)))))
587 (ert-deftest test-org-element/block-switches ()
588 "Test `example-block' and `src-block' switches parsing."
589 (let ((org-coderef-label-format "(ref:%s)"))
590 ;; 1. Test "-i" switch.
591 (should-not
592 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
593 (org-element-property :preserve-indent (org-element-at-point))))
594 (should
595 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"
596 (org-element-property :preserve-indent (org-element-at-point))))
597 (should-not
598 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
599 (org-element-property :preserve-indent (org-element-at-point))))
600 (should
601 (org-test-with-temp-text "#+BEGIN_EXAMPLE -i\nText.\n#+END_EXAMPLE"
602 (org-element-property :preserve-indent (org-element-at-point))))
603 ;; 2. "-n -r -k" combination should number lines, retain labels but
604 ;; not use them in coderefs.
605 (should
606 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r -k\nText.\n#+END_EXAMPLE"
607 (let ((element (org-element-at-point)))
608 (and (org-element-property :number-lines element)
609 (org-element-property :retain-labels element)
610 (not (org-element-property :use-labels element))))))
611 (should
612 (org-test-with-temp-text
613 "#+BEGIN_SRC emacs-lisp -n -r -k\n(+ 1 1)\n#+END_SRC"
614 (let ((element (org-element-at-point)))
615 (and (org-element-property :number-lines element)
616 (org-element-property :retain-labels element)
617 (not (org-element-property :use-labels element))))))
618 ;; 3. "-n -r" combination should number-lines remove labels and not
619 ;; use them in coderefs.
620 (should
621 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r\nText.\n#+END_EXAMPLE"
622 (let ((element (org-element-at-point)))
623 (and (org-element-property :number-lines element)
624 (not (org-element-property :retain-labels element))
625 (not (org-element-property :use-labels element))))))
626 (should
627 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1)\n#+END_SRC"
628 (let ((element (org-element-at-point)))
629 (and (org-element-property :number-lines element)
630 (not (org-element-property :retain-labels element))
631 (not (org-element-property :use-labels element))))))
632 ;; 4. "-n" or "+n" should number lines, retain labels and use them
633 ;; in coderefs.
634 (should
635 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n\nText.\n#+END_EXAMPLE"
636 (let ((element (org-element-at-point)))
637 (and (org-element-property :number-lines element)
638 (org-element-property :retain-labels element)
639 (org-element-property :use-labels element)))))
640 (should
641 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1)\n#+END_SRC"
642 (let ((element (org-element-at-point)))
643 (and (org-element-property :number-lines element)
644 (org-element-property :retain-labels element)
645 (org-element-property :use-labels element)))))
646 (should
647 (org-test-with-temp-text "#+BEGIN_EXAMPLE +n\nText.\n#+END_EXAMPLE"
648 (let ((element (org-element-at-point)))
649 (and (org-element-property :number-lines element)
650 (org-element-property :retain-labels element)
651 (org-element-property :use-labels element)))))
652 (should
653 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp +n\n(+ 1 1)\n#+END_SRC"
654 (let ((element (org-element-at-point)))
655 (and (org-element-property :number-lines element)
656 (org-element-property :retain-labels element)
657 (org-element-property :use-labels element)))))
658 ;; 5. No switch should not number lines, but retain labels and use
659 ;; them in coderefs.
660 (should
661 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
662 (let ((element (org-element-at-point)))
663 (and (not (org-element-property :number-lines element))
664 (org-element-property :retain-labels element)
665 (org-element-property :use-labels element)))))
666 (should
667 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
668 (let ((element (org-element-at-point)))
669 (and (not (org-element-property :number-lines element))
670 (org-element-property :retain-labels element)
671 (org-element-property :use-labels element)))))
672 ;; 6. "-r" switch only: do not number lines, remove labels, and
673 ;; don't use labels in coderefs.
674 (should
675 (org-test-with-temp-text "#+BEGIN_EXAMPLE -r\nText.\n#+END_EXAMPLE"
676 (let ((element (org-element-at-point)))
677 (and (not (org-element-property :number-lines element))
678 (not (org-element-property :retain-labels element))
679 (not (org-element-property :use-labels element))))))
680 (should
681 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1)\n#+END_SRC"
682 (let ((element (org-element-at-point)))
683 (and (not (org-element-property :number-lines element))
684 (not (org-element-property :retain-labels element))
685 (not (org-element-property :use-labels element))))))
686 ;; 7. Recognize coderefs with user-defined syntax.
687 (should
688 (equal
689 "[ref:%s]"
690 (org-test-with-temp-text
691 "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText [ref:text]\n#+END_EXAMPLE"
692 (org-element-property :label-fmt (org-element-at-point)))))
693 (should
694 (equal
695 "[ref:%s]"
696 (org-test-with-temp-text
697 "#+BEGIN_SRC emacs-lisp -l \"[ref:%s]\"\n(+ 1 1) [ref:text]\n#+END_SRC"
698 (org-element-property :label-fmt (org-element-at-point)))))))
701 ;;;; Export Block
703 (ert-deftest test-org-element/export-block-parser ()
704 "Test `export-block' parser."
705 ;; Standard test.
706 (should
707 (let ((org-element-block-name-alist
708 '(("LATEX" . org-element-export-block-parser))))
709 (org-test-with-temp-text "#+BEGIN_LATEX\nText\n#+END_LATEX"
710 (org-element-map (org-element-parse-buffer) 'export-block 'identity))))
711 ;; Test folded block.
712 (org-test-with-temp-text "#+BEGIN_LATEX\nText\n#+END_LATEX"
713 (org-cycle)
714 (should
715 (org-element-property
716 :hiddenp
717 (org-element-map
718 (let ((org-element-block-name-alist
719 '(("LATEX" . org-element-export-block-parser))))
720 (org-element-parse-buffer))
721 'export-block 'identity nil t))))
722 ;; Ignore case.
723 (should
724 (let ((org-element-block-name-alist
725 '(("LATEX" . org-element-export-block-parser))))
726 (org-test-with-temp-text "#+begin_latex\nText\n#+end_latex"
727 (org-element-map (org-element-parse-buffer) 'export-block 'identity))))
728 ;; Ignore incomplete block.
729 (should-not
730 (let ((org-element-block-name-alist
731 '(("LATEX" . org-element-export-block-parser))))
732 (org-test-with-temp-text "#+BEGIN_LATEX"
733 (org-element-map (org-element-parse-buffer) 'export-block
734 'identity nil t))))
735 ;; Handle non-empty blank line at the end of buffer.
736 (should
737 (let ((org-element-block-name-alist
738 '(("LATEX" . org-element-export-block-parser))))
739 (org-test-with-temp-text "#+BEGIN_LATEX\nC\n#+END_LATEX\n "
740 (= (org-element-property :end (org-element-at-point)) (point-max))))))
743 ;;;; Export Snippet
745 (ert-deftest test-org-element/export-snippet-parser ()
746 "Test `export-snippet' parser."
747 (should
748 (equal
749 '("back-end" . "contents")
750 (org-test-with-temp-text "@@back-end:contents@@"
751 (org-element-map
752 (org-element-parse-buffer) 'export-snippet
753 (lambda (snippet) (cons (org-element-property :back-end snippet)
754 (org-element-property :value snippet)))
755 nil t)))))
758 ;;;; Fixed Width
760 (ert-deftest test-org-element/fixed-width-parser ()
761 "Test fixed-width area parsing."
762 ;; Preserve indentation.
763 (should
764 (org-test-with-temp-text ": no blank\n: one blank"
765 (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
766 ;; Fixed-width with empty lines.
767 (should
768 (org-test-with-temp-text ": first part\n:\n: \n: second part"
769 (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
770 ;; Parse indented fixed-width markers.
771 (should
772 (org-test-with-temp-text "Text\n : no blank\n : one blank"
773 (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
774 ;; Distinguish fixed-width areas within a list and outside of it.
775 (should
776 (= 2
777 (length
778 (org-test-with-temp-text "
779 - Item
780 : fixed-width inside
781 : fixed-width outside"
782 (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))))
783 ;; Handle non-empty blank line at the end of buffer.
784 (should
785 (org-test-with-temp-text ": A\n "
786 (= (org-element-property :end (org-element-at-point)) (point-max)))))
789 ;;;; Footnote Definition
791 (ert-deftest test-org-element/footnote-definition-parser ()
792 "Test `footnote-definition' parser."
793 (should
794 (org-test-with-temp-text "[fn:1] Definition"
795 (org-element-map (org-element-parse-buffer) 'footnote-definition
796 'identity nil t)))
797 ;; Footnote with more contents
798 (should
799 (= 29
800 (org-element-property
801 :end
802 (org-test-with-temp-text "[fn:1] Definition\n\n| a | b |"
803 (org-element-map (org-element-parse-buffer) 'footnote-definition
804 'identity nil t)))))
805 ;; Footnote starting with special syntax.
806 (should-not
807 (org-test-with-temp-text "[fn:1] - no item"
808 (org-element-map (org-element-parse-buffer) 'item 'identity)))
809 ;; Correctly handle footnote starting with an empty line.
810 (should
811 (= 9
812 (org-test-with-temp-text "[fn:1]\n\n Body"
813 (org-element-property :contents-begin (org-element-at-point)))))
814 ;; Handle non-empty blank line at the end of buffer.
815 (should
816 (org-test-with-temp-text "[fn:1] Definition\n "
817 (= (org-element-property :end (org-element-at-point)) (point-max)))))
820 ;;;; Footnotes Reference.
822 (ert-deftest test-org-element/footnote-reference-parser ()
823 "Test `footnote-reference' parser."
824 ;; 1. Parse a standard reference.
825 (org-test-with-temp-text "Text[fn:label]"
826 (should
827 (org-element-map
828 (org-element-parse-buffer) 'footnote-reference 'identity)))
829 ;; 2. Parse a normalized reference.
830 (org-test-with-temp-text "Text[1]"
831 (should
832 (org-element-map
833 (org-element-parse-buffer) 'footnote-reference 'identity)))
834 ;; 3. Parse an inline reference.
835 (org-test-with-temp-text "Text[fn:test:def]"
836 (should
837 (org-element-map
838 (org-element-parse-buffer) 'footnote-reference 'identity)))
839 ;; 4. Parse an anonymous reference.
840 (org-test-with-temp-text "Text[fn::def]"
841 (should
842 (org-element-map
843 (org-element-parse-buffer) 'footnote-reference 'identity)))
844 ;; 5. Parse nested footnotes.
845 (org-test-with-temp-text "Text[fn::def [fn:label]]"
846 (should
847 (= 2
848 (length
849 (org-element-map
850 (org-element-parse-buffer) 'footnote-reference 'identity)))))
851 ;; 6. Parse adjacent footnotes.
852 (org-test-with-temp-text "Text[fn:label1][fn:label2]"
853 (should
854 (= 2
855 (length
856 (org-element-map
857 (org-element-parse-buffer) 'footnote-reference 'identity)))))
858 ;; 7. Only properly closed footnotes are recognized as such.
859 (org-test-with-temp-text "Text[fn:label"
860 (should-not
861 (org-element-map
862 (org-element-parse-buffer) 'footnote-reference 'identity))))
865 ;;;; Headline
867 (ert-deftest test-org-element/headline-quote-keyword ()
868 "Test QUOTE keyword recognition."
869 ;; Reference test.
870 (org-test-with-temp-text "* Headline"
871 (let ((org-quote-string "QUOTE"))
872 (should-not (org-element-property :quotedp (org-element-at-point)))))
873 ;; Standard position.
874 (org-test-with-temp-text "* QUOTE Headline"
875 (let* ((org-quote-string "QUOTE")
876 (headline (org-element-at-point)))
877 (should (org-element-property :quotedp headline))
878 ;; Test removal from raw value.
879 (should (equal (org-element-property :raw-value headline) "Headline"))))
880 ;; Case sensitivity.
881 (org-test-with-temp-text "* QUOTE Headline"
882 (let* ((org-quote-string "Quote")
883 (headline (org-element-at-point)))
884 (should-not (org-element-property :quotedp headline))
885 (should (equal (org-element-property :raw-value headline)
886 "QUOTE Headline"))))
887 ;; With another keyword.
888 (org-test-with-temp-text "* TODO QUOTE Headline"
889 (let* ((org-quote-string "QUOTE")
890 (org-todo-keywords '((sequence "TODO" "DONE")))
891 (headline (org-element-at-point)))
892 (should (org-element-property :quotedp headline))
893 (should (equal (org-element-property :raw-value headline) "Headline"))))
894 ;; With the keyword only.
895 (org-test-with-temp-text "* QUOTE"
896 (let* ((org-quote-string "QUOTE")
897 (headline (org-element-at-point)))
898 (should (org-element-property :quotedp headline))
899 (should (equal (org-element-property :raw-value headline) "")))))
901 (ert-deftest test-org-element/headline-comment-keyword ()
902 "Test COMMENT keyword recognition."
903 ;; Reference test.
904 (org-test-with-temp-text "* Headline"
905 (let ((org-comment-string "COMMENT"))
906 (should-not (org-element-property :commentedp (org-element-at-point)))))
907 ;; Standard position.
908 (org-test-with-temp-text "* COMMENT Headline"
909 (let ((org-comment-string "COMMENT")
910 (headline (org-element-at-point)))
911 (should (org-element-property :commentedp headline))
912 (should (equal (org-element-property :raw-value headline) "Headline"))))
913 ;; Case sensitivity.
914 (org-test-with-temp-text "* COMMENT Headline"
915 (let* ((org-comment-string "Comment")
916 (headline (org-element-at-point)))
917 (should-not (org-element-property :commentedp headline))
918 (should (equal (org-element-property :raw-value headline)
919 "COMMENT Headline"))))
920 ;; With another keyword.
921 (org-test-with-temp-text "* TODO COMMENT Headline"
922 (let* ((org-comment-string "COMMENT")
923 (org-todo-keywords '((sequence "TODO" "DONE")))
924 (headline (org-element-at-point)))
925 (should (org-element-property :commentedp headline))
926 (should (equal (org-element-property :raw-value headline) "Headline"))))
927 ;; With the keyword only.
928 (org-test-with-temp-text "* COMMENT"
929 (let* ((org-comment-string "COMMENT")
930 (headline (org-element-at-point)))
931 (should (org-element-property :commentedp headline))
932 (should (equal (org-element-property :raw-value headline) "")))))
934 (ert-deftest test-org-element/headline-archive-tag ()
935 "Test ARCHIVE tag recognition."
936 ;; Reference test.
937 (org-test-with-temp-text "* Headline"
938 (let ((org-archive-tag "ARCHIVE"))
939 (should-not (org-element-property :archivedp (org-element-at-point)))))
940 ;; Single tag.
941 (org-test-with-temp-text "* Headline :ARCHIVE:"
942 (let ((org-archive-tag "ARCHIVE"))
943 (let ((headline (org-element-at-point)))
944 (should (org-element-property :archivedp headline))
945 ;; Test tag removal.
946 (should-not (org-element-property :tags headline))))
947 (let ((org-archive-tag "Archive"))
948 (should-not (org-element-property :archivedp (org-element-at-point)))))
949 ;; Multiple tags.
950 (org-test-with-temp-text "* Headline :test:ARCHIVE:"
951 (let ((org-archive-tag "ARCHIVE"))
952 (let ((headline (org-element-at-point)))
953 (should (org-element-property :archivedp headline))
954 ;; Test tag removal.
955 (should (equal (org-element-property :tags headline) '("test")))))))
957 (ert-deftest test-org-element/headline-properties ()
958 "Test properties from property drawer."
959 ;; All properties from property drawer have their symbol upper
960 ;; cased.
961 (should
962 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
963 (org-element-property :FOO (org-element-at-point))))
964 (should-not
965 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
966 (org-element-property :foo (org-element-at-point)))))
969 ;;;; Horizontal Rule
971 (ert-deftest test-org-element/horizontal-rule-parser ()
972 "Test `horizontal-rule' parser."
973 ;; Standard.
974 (should
975 (org-test-with-temp-text "-----"
976 (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
977 ;; Indented.
978 (should
979 (org-test-with-temp-text " -----"
980 (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
981 ;; Hyphen must be alone on the line.
982 (should-not
983 (org-test-with-temp-text "-----wrong"
984 (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
985 ;; 4 hyphens is too small.
986 (should-not
987 (org-test-with-temp-text "----"
988 (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
989 ;; Handle non-empty blank line at the end of buffer.
990 (should
991 (org-test-with-temp-text "-----\n "
992 (= (org-element-property :end (org-element-at-point)) (point-max)))))
995 ;;;; Inline Babel Call
997 (ert-deftest test-org-element/inline-babel-call-parser ()
998 "Test `inline-babel-call' parser."
999 (should
1000 (org-test-with-temp-text "call_test()"
1001 (org-element-map
1002 (org-element-parse-buffer) 'inline-babel-call 'identity))))
1005 ;;;; Inline Src Block
1007 (ert-deftest test-org-element/inline-src-block-parser ()
1008 "Test `inline-src-block' parser."
1009 (should
1010 (org-test-with-temp-text "src_emacs-lisp{(+ 1 1)}"
1011 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
1012 ;; Test parsing at the beginning of an item.
1013 (should
1014 (org-test-with-temp-text "- src_emacs-lisp{(+ 1 1)}"
1015 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity))))
1018 ;;;; Inlinetask
1020 (ert-deftest test-org-element/inlinetask-parser ()
1021 "Test `inlinetask' parser."
1022 (when (featurep 'org-inlinetask)
1023 (let ((org-inlinetask-min-level 15))
1024 ;; 1. Regular inlinetask.
1025 (should
1026 (org-test-with-temp-text
1027 "*************** Task\nTest\n*************** END"
1028 (org-element-map (org-element-parse-buffer) 'inlinetask 'identity)))
1029 ;; 2. Degenerate inlinetask.
1030 (should
1031 (org-test-with-temp-text "*************** Task"
1032 (org-element-map (org-element-parse-buffer) 'inlinetask 'identity)))
1033 ;; TODO keyword.
1034 (should
1035 (equal
1036 "TODO"
1037 (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
1038 (org-test-with-temp-text "*************** TODO Task"
1039 (org-element-property
1040 :todo-keyword
1041 (org-element-map (org-element-parse-buffer) 'inlinetask
1042 'identity nil t))))))
1043 ;; Planning info.
1044 (should
1045 (equal
1046 "2012-03-29 thu."
1047 (org-test-with-temp-text "
1048 *************** Task
1049 DEADLINE: <2012-03-29 thu.>"
1050 (org-element-property
1051 :deadline
1052 (org-element-map (org-element-parse-buffer) 'inlinetask 'identity nil t)))))
1053 ;; Priority.
1054 (should
1055 (equal
1057 (org-test-with-temp-text "
1058 *************** [#A] Task"
1059 (org-element-property
1060 :priority
1061 (org-element-map
1062 (org-element-parse-buffer) 'inlinetask 'identity nil t)))))
1063 ;; Tags.
1064 (should
1065 (equal
1066 '("test")
1067 (org-test-with-temp-text "
1068 *************** Task :test:"
1069 (org-element-property
1070 :tags
1071 (org-element-map
1072 (org-element-parse-buffer) 'inlinetask 'identity nil t)))))
1073 ;; Regular properties are accessed through upper case keywords.
1074 (should
1075 (org-test-with-temp-text "
1076 *************** Task
1077 :PROPERTIES:
1078 :foo: bar
1079 :END:
1080 *************** END"
1081 (forward-line)
1082 (org-element-property :FOO (org-element-at-point))))
1083 (should-not
1084 (org-test-with-temp-text "
1085 *************** Task
1086 :PROPERTIES:
1087 :foo: bar
1088 :END:
1089 *************** END"
1090 (forward-line)
1091 (org-element-property :foo (org-element-at-point))))
1092 ;; Handle non-empty blank line at the end of buffer.
1093 (should
1094 (org-test-with-temp-text "*************** Task\n*************** END\n "
1095 (= (org-element-property :end (org-element-at-point)) (point-max)))))))
1098 ;;;; Italic
1100 (ert-deftest test-org-element/italic-parser ()
1101 "Test `italic' parser."
1102 ;; Regular test.
1103 (should
1104 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1105 (org-test-with-temp-text "/italic/"
1106 (org-element-map (org-element-parse-buffer) 'italic 'identity nil t))))
1107 ;; Multi-line markup.
1108 (should
1109 (equal
1110 (org-element-contents
1111 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1112 (org-test-with-temp-text "/first line\nsecond line/"
1113 (org-element-map (org-element-parse-buffer) 'italic 'identity nil t))))
1114 '("first line\nsecond line"))))
1117 ;;;; Item
1119 (ert-deftest test-org-element/item-parser ()
1120 "Test `item' parser."
1121 ;; Standard test.
1122 (should
1123 (org-test-with-temp-text "- item"
1124 (org-element-map (org-element-parse-buffer) 'item 'identity)))
1125 ;; Counter.
1126 (should
1127 (= 6
1128 (org-element-property
1129 :counter
1130 (org-test-with-temp-text "6. [@6] item"
1131 (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
1132 ;; Tag
1133 (should
1134 (equal
1135 '("tag")
1136 (org-element-property
1137 :tag
1138 (org-test-with-temp-text "- tag :: description"
1139 (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
1140 ;; No tags in ordered lists.
1141 (should-not
1142 (org-element-property
1143 :tag
1144 (org-test-with-temp-text "1. tag :: description"
1145 (org-element-map (org-element-parse-buffer) 'item 'identity nil t))))
1146 ;; Check-boxes
1147 (should
1148 (equal
1149 '(trans on off)
1150 (org-test-with-temp-text "
1151 - [-] item 1
1152 - [X] item 1.1
1153 - [ ] item 1.2"
1154 (org-element-map (org-element-parse-buffer) 'item
1155 (lambda (item) (org-element-property :checkbox item))))))
1156 ;; Folded state.
1157 (org-test-with-temp-text "* Headline
1158 - item
1160 paragraph below"
1161 (forward-line)
1162 (let ((org-cycle-include-plain-lists t)) (org-cycle))
1163 (should
1164 (org-element-property
1165 :hiddenp
1166 (org-element-map (org-element-parse-buffer) 'item 'identity nil t))))
1167 ;; Item starting with special syntax.
1168 (should
1169 (equal '(("- item"))
1170 (org-test-with-temp-text "- - item"
1171 (org-element-map (org-element-parse-buffer) 'paragraph
1172 'org-element-contents))))
1173 ;; Block in an item: ignore indentation within the block.
1174 (should
1175 (org-test-with-temp-text "- item\n #+begin_src emacs-lisp\n(+ 1 1)\n #+end_src"
1176 (forward-char)
1177 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1180 ;;;; Keyword
1182 (ert-deftest test-org-element/keyword-parser ()
1183 "Test `keyword' parser."
1184 ;; Standard test.
1185 (should
1186 (org-test-with-temp-text "#+KEYWORD: value"
1187 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1188 ;; Keywords are case-insensitive.
1189 (should
1190 (org-test-with-temp-text "#+keyword: value"
1191 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1192 ;; Affiliated keywords are not keywords.
1193 (should-not
1194 (org-test-with-temp-text "#+NAME: value
1195 Paragraph"
1196 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1197 ;; Do not mix keywords with Babel calls and dynamic blocks.
1198 (should-not
1199 (org-test-with-temp-text "#+CALL: fun()"
1200 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1201 (should-not
1202 (org-test-with-temp-text "#+BEGIN: my-fun\nBody\n#+END:"
1203 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1204 ;; Handle non-empty blank line at the end of buffer.
1205 (should
1206 (org-test-with-temp-text "#+KEYWORD: value\n "
1207 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1210 ;;;; Latex Environment
1212 (ert-deftest test-org-element/latex-environment-parser ()
1213 "Test `latex-environment' parser."
1214 (should
1215 (org-test-with-temp-text "\\begin{equation}\ne^{i\\pi}+1=0\n\\end{equation}"
1216 (org-element-map (org-element-parse-buffer) 'latex-environment 'identity)))
1217 ;; Allow nested environments.
1218 (should
1219 (equal
1220 "\\begin{outer}
1221 \\begin{inner}
1222 e^{i\\pi}+1=0
1223 \\end{inner}
1224 \\end{outer}"
1225 (org-test-with-temp-text "
1226 \\begin{outer}
1227 \\begin{inner}
1228 e^{i\\pi}+1=0
1229 \\end{inner}
1230 \\end{outer}"
1231 (org-element-property
1232 :value
1233 (org-element-map
1234 (org-element-parse-buffer) 'latex-environment 'identity nil t)))))
1235 ;; Allow environments with options and arguments.
1236 (should
1237 (eq 'latex-environment
1238 (org-test-with-temp-text
1239 "\\begin{theorem}[Euler]\ne^{i\\pi}+1=0\n\\end{theorem}"
1240 (org-element-type (org-element-at-point)))))
1241 (should
1242 (eq 'latex-environment
1243 (org-test-with-temp-text "\\begin{env}{arg}\nvalue\n\\end{env}"
1244 (org-element-type (org-element-at-point)))))
1245 (should-not
1246 (eq 'latex-environment
1247 (org-test-with-temp-text "\\begin{env}{arg} something\nvalue\n\\end{env}"
1248 (org-element-type (org-element-at-point)))))
1249 ;; Handle non-empty blank line at the end of buffer.
1250 (should
1251 (org-test-with-temp-text "\\begin{env}\n\\end{env}\n "
1252 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1255 ;;;; Latex Fragment
1257 (ert-deftest test-org-element/latex-fragment-parser ()
1258 "Test `latex-fragment' parser."
1259 (should
1260 (org-test-with-temp-text "$a$"
1261 (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
1262 (should
1263 (org-test-with-temp-text "$$a$$"
1264 (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
1265 (should
1266 (org-test-with-temp-text "\\(a\\)"
1267 (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
1268 (should
1269 (org-test-with-temp-text "\\[a\\]"
1270 (org-element-map
1271 (org-element-parse-buffer) 'latex-fragment 'identity)))
1272 ;; Test fragment at the beginning of an item.
1273 (should
1274 (eq 'latex-fragment
1275 (org-test-with-temp-text "- $x$"
1276 (progn (search-forward "$")
1277 (org-element-type (org-element-context)))))))
1280 ;;;; Line Break
1282 (ert-deftest test-org-element/line-break-parser ()
1283 "Test `line-break' parser."
1284 ;; Regular test.
1285 (should
1286 (org-test-with-temp-text "Text \\\\"
1287 (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
1288 ;; Line break with trailing white spaces.
1289 (should
1290 (org-test-with-temp-text "Text \\\\ "
1291 (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
1292 ;; Three backslashes are too much.
1293 (should-not
1294 (org-test-with-temp-text "Text \\\\\\"
1295 (org-element-map (org-element-parse-buffer) 'line-break 'identity))))
1298 ;;;; Link
1300 (ert-deftest test-org-element/link-parser ()
1301 "Test `link' parser."
1302 ;; Radio target.
1303 (should
1304 (equal
1305 "radio"
1306 (org-test-with-temp-text "A radio link"
1307 (org-element-property
1308 :type
1309 (org-element-map
1310 (let ((org-target-link-regexp "radio")) (org-element-parse-buffer))
1311 'link 'identity nil t)))))
1312 ;; Standard link.
1314 ;; ... with description.
1315 (should
1316 (equal
1317 '("Orgmode.org")
1318 (org-test-with-temp-text "[[http://orgmode.org][Orgmode.org]]"
1319 (org-element-contents
1320 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1321 ;; ... without description.
1322 (should
1323 (equal
1324 "http"
1325 (org-test-with-temp-text "[[http://orgmode.org]]"
1326 (org-element-property
1327 :type
1328 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1329 ;; ... with expansion.
1330 (should
1331 (equal
1332 "//orgmode.org/worg"
1333 (org-test-with-temp-text "[[Org:worg]]"
1334 (let ((org-link-abbrev-alist '(("Org" . "http://orgmode.org/"))))
1335 (org-element-property
1336 :path
1337 (org-element-map (org-element-parse-buffer) 'link 'identity nil t))))))
1338 ;; ... with translation.
1339 (should
1340 (equal
1341 "127.0.0.1"
1342 (org-test-with-temp-text "[[http://orgmode.org]]"
1343 (flet ((link-translate (type path) (cons type "127.0.0.1")))
1344 (let ((org-link-translation-function 'link-translate))
1345 (org-element-property
1346 :path
1347 (org-element-map (org-element-parse-buffer) 'link
1348 'identity nil t)))))))
1349 ;; ... id link.
1350 (should
1351 (equal
1352 "id"
1353 (org-test-with-temp-text "[[id:aaaa]]"
1354 (org-element-property
1355 :type
1356 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1357 ;; ... custom-id link.
1358 (should
1359 (equal
1360 "custom-id"
1361 (org-test-with-temp-text "[[#some-id]]"
1362 (org-element-property
1363 :type
1364 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1365 ;; ... coderef link.
1366 (should
1367 (equal
1368 "coderef"
1369 (org-test-with-temp-text "[[(reference)]]"
1370 (org-element-property
1371 :type
1372 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1373 ;; ... fuzzy link.
1374 (should
1375 (equal
1376 "fuzzy"
1377 (org-test-with-temp-text "[[target-or-title]]"
1378 (org-element-property
1379 :type
1380 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1381 ;; ... file-type link with search option.
1382 (should
1383 (equal
1384 '(("file" "projects.org" "*task title"))
1385 (org-test-with-temp-text "[[file:projects.org::*task title]]"
1386 (org-element-map (org-element-parse-buffer) 'link
1387 (lambda (l) (list (org-element-property :type l)
1388 (org-element-property :path l)
1389 (org-element-property :search-option l)))))))
1390 ;; ... file-type link with application.
1391 (should
1392 (equal
1393 '(("file" "projects.org" "docview"))
1394 (org-test-with-temp-text "[[docview:projects.org]]"
1395 (org-element-map (org-element-parse-buffer) 'link
1396 (lambda (l) (list (org-element-property :type l)
1397 (org-element-property :path l)
1398 (org-element-property :application l)))))))
1399 ;; Plain link.
1400 (should
1401 (org-test-with-temp-text "A link: http://orgmode.org"
1402 (org-element-map (org-element-parse-buffer) 'link 'identity)))
1403 ;; Angular link.
1404 (should
1405 (org-test-with-temp-text "A link: <http://orgmode.org>"
1406 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))
1407 ;; Link abbreviation.
1408 (should
1409 (equal "http"
1410 (org-test-with-temp-text
1411 "#+LINK: orgmode http://www.orgmode.org/\n[[orgmode:#docs]]"
1412 (progn (org-mode-restart)
1413 (goto-char (1- (point-max)))
1414 (org-element-property :type (org-element-context))))))
1415 ;; Link abbreviation in a secondary string.
1416 (should
1417 (equal "http"
1418 (org-test-with-temp-text
1419 "#+LINK: orgmode http://www.orgmode.org/\n* H [[orgmode:#docs]]"
1420 (progn (org-mode-restart)
1421 (org-element-map (org-element-parse-buffer) 'link
1422 (lambda (link) (org-element-property :type link))
1423 nil t nil t)))))
1424 ;; Plain links are allowed as description of regular links.
1425 (should
1426 (equal "file"
1427 (org-test-with-temp-text "[[http://orgmode.org][file:unicorn.jpg]]"
1428 (search-forward "file:")
1429 (org-element-property :type (org-element-context))))))
1432 ;;;; Macro
1434 (ert-deftest test-org-element/macro-parser ()
1435 "Test `macro' parser."
1436 ;; Without arguments.
1437 (should
1438 (org-test-with-temp-text "{{{macro}}}"
1439 (org-element-map (org-element-parse-buffer) 'macro 'identity)))
1440 ;; With arguments.
1441 (should
1442 (org-test-with-temp-text "{{{macro(arg1,arg2)}}}"
1443 (org-element-map (org-element-parse-buffer) 'macro 'identity)))
1444 ;; Properly handle protected commas in arguments...
1445 (should
1446 (= 2
1447 (length
1448 (org-test-with-temp-text "{{{macro(arg1\\,arg1,arg2)}}}"
1449 (org-element-property :args (org-element-context))))))
1450 ;; ... even when last argument ends with a protected comma.
1451 (should
1452 (equal '("C-,")
1453 (org-test-with-temp-text "{{{macro(C-\\,)}}}"
1454 (org-element-property :args (org-element-context)))))
1455 ;; Allow to escape escaping character.
1456 (should
1457 (equal '("C-\\" "")
1458 (org-test-with-temp-text "{{{macro(C-\\\\,)}}}"
1459 (org-element-property :args (org-element-context)))))
1460 ;; No need to escape backslashes elsewhere.
1461 (should
1462 (equal '("\\")
1463 (org-test-with-temp-text "{{{macro(\\)}}}"
1464 (org-element-property :args (org-element-context))))))
1467 ;;;; Node Property
1469 (ert-deftest test-org-element/node-property ()
1470 "Test `node-property' parser."
1471 ;; Standard test.
1472 (should
1473 (equal '("abc" "value")
1474 (org-test-with-temp-text ":PROPERTIES:\n:abc: value\n:END:"
1475 (progn (forward-line)
1476 (let ((element (org-element-at-point)))
1477 (list (org-element-property :key element)
1478 (org-element-property :value element)))))))
1479 ;; Value should be trimmed.
1480 (should
1481 (equal "value"
1482 (org-test-with-temp-text ":PROPERTIES:\n:abc: value \n:END:"
1483 (progn (forward-line)
1484 (let ((element (org-element-at-point)))
1485 (org-element-property :value element))))))
1486 ;; A node property requires to be wrapped within a property drawer.
1487 (should-not
1488 (eq 'node-property
1489 (org-test-with-temp-text ":abc: value"
1490 (org-element-type (org-element-at-point))))))
1493 ;;;; Paragraph
1495 (ert-deftest test-org-element/paragraph-parser ()
1496 "Test `paragraph' parser."
1497 ;; Standard test.
1498 (should
1499 (org-test-with-temp-text "Paragraph"
1500 (org-element-map (org-element-parse-buffer) 'paragraph 'identity nil t)))
1501 ;; Property find end of a paragraph stuck to another element.
1502 (should
1503 (eq ?#
1504 (org-test-with-temp-text "Paragraph\n# Comment"
1505 (org-element-map (org-element-parse-buffer) 'paragraph
1506 (lambda (p) (char-after (org-element-property :end p)))
1507 nil t))))
1508 ;; Include ill-formed Keywords.
1509 (should
1510 (org-test-with-temp-text "#+wrong_keyword something"
1511 (org-element-map (org-element-parse-buffer) 'paragraph 'identity)))
1512 ;; Include incomplete-drawers.
1513 (should
1514 (let ((org-drawers '("TEST")))
1515 (org-test-with-temp-text ":TEST:\nParagraph"
1516 (let ((elem (org-element-at-point)))
1517 (and (eq (org-element-type elem) 'paragraph)
1518 (= (point-max) (org-element-property :end elem)))))))
1519 ;; Include non-existent drawers.
1520 (should
1521 (let ((org-drawers '("TEST")))
1522 (org-test-with-temp-text ":NONAME:"
1523 (org-element-map (org-element-parse-buffer) 'paragraph 'identity))))
1524 ;; Include incomplete blocks.
1525 (should
1526 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph"
1527 (let ((elem (org-element-at-point)))
1528 (and (eq (org-element-type elem) 'paragraph)
1529 (= (point-max) (org-element-property :end elem))))))
1530 ;; Include incomplete dynamic blocks.
1531 (should
1532 (org-test-with-temp-text "#+BEGIN: \nParagraph"
1533 (let ((elem (org-element-at-point)))
1534 (and (eq (org-element-type elem) 'paragraph)
1535 (= (point-max) (org-element-property :end elem))))))
1536 ;; Include incomplete latex environments.
1537 (should
1538 (org-test-with-temp-text "\begin{equation}\nParagraph"
1539 (let ((elem (org-element-at-point)))
1540 (and (eq (org-element-type elem) 'paragraph)
1541 (= (point-max) (org-element-property :end elem))))))
1542 ;; Do not steal affiliated keywords from container.
1543 (should
1544 (org-test-with-temp-text "#+ATTR_LATEX: test\n- item 1"
1545 (let ((elem (progn (search-forward "item") (org-element-at-point))))
1546 (and (eq (org-element-type elem) 'paragraph)
1547 (not (org-element-property :attr_latex elem))
1548 (/= (org-element-property :begin elem) 1)))))
1549 ;; Handle non-empty blank line at the end of buffer.
1550 (should
1551 (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
1552 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1555 ;;;; Plain List
1557 (ert-deftest test-org-element/plain-list-parser ()
1558 "Test `plain-list' parser."
1559 (org-test-with-temp-text "- item"
1560 (should (org-element-map (org-element-parse-buffer) 'plain-list 'identity)))
1561 ;; Blank lines after the list only belong to outer plain list.
1562 (should
1563 (equal
1564 '(t t)
1565 (org-test-with-temp-text "
1566 - outer
1567 - inner
1569 Outside list"
1570 (let ((endings (org-element-map (org-element-parse-buffer) 'plain-list
1571 (lambda (pl) (org-element-property :end pl)))))
1572 (list
1573 ;; Move to ending of outer list.
1574 (progn (goto-char (car endings)) (looking-at "Outside list"))
1575 ;; Move to ending of inner list.
1576 (progn (goto-char (nth 1 endings)) (looking-at "^$")))))))
1577 ;; Correctly compute end of list if it doesn't end at a line
1578 ;; beginning.
1579 (should
1580 (org-test-with-temp-text "- list\n \n "
1581 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1584 ;;;; Planning
1586 (ert-deftest test-org-element/planning-parser ()
1587 "Test `planning' parser."
1588 (should
1589 (equal "[2012-03-29 thu.]"
1590 (org-element-property
1591 :raw-value
1592 (org-element-property
1593 :closed
1594 (org-test-with-temp-text "CLOSED: [2012-03-29 thu.]"
1595 (org-element-at-point))))))
1596 (should
1597 (equal "<2012-03-29 thu.>"
1598 (org-element-property
1599 :raw-value
1600 (org-element-property
1601 :deadline
1602 (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>"
1603 (org-element-at-point))))))
1604 (should
1605 (equal "<2012-03-29 thu.>"
1606 (org-element-property
1607 :raw-value
1608 (org-element-property
1609 :scheduled
1610 (org-test-with-temp-text "SCHEDULED: <2012-03-29 thu.>"
1611 (org-element-at-point)))))))
1614 ;;;; Property Drawer
1616 (ert-deftest test-org-element/property-drawer-parser ()
1617 "Test `property-drawer' parser."
1618 ;; Standard test.
1619 (should
1620 (let ((org-drawers '("PROPERTIES")))
1621 (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
1622 (org-element-map (org-element-parse-buffer) 'property-drawer
1623 'identity nil t))))
1624 ;; Do not mix property drawers and regular drawers.
1625 (should-not
1626 (let ((org-drawers '("TEST")))
1627 (org-test-with-temp-text ":TEST:\n:prop: value\n:END:"
1628 (org-element-map (org-element-parse-buffer) 'property-drawer
1629 'identity nil t))))
1630 ;; Ignore incomplete drawer.
1631 (should-not
1632 (let ((org-drawers '("PROPERTIES")))
1633 (org-test-with-temp-text ":PROPERTIES:\n:prop: value"
1634 (org-element-map (org-element-parse-buffer) 'property-drawer
1635 'identity nil t))))
1636 ;; Handle non-empty blank line at the end of buffer.
1637 (should
1638 (org-test-with-temp-text ":PROPERTIES:\n:END:\n "
1639 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1642 ;;;; Quote Block
1644 (ert-deftest test-org-element/quote-block-parser ()
1645 "Test `quote-block' parser."
1646 ;; Regular test.
1647 (should
1648 (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
1649 (org-element-map (org-element-parse-buffer) 'quote-block 'identity)))
1650 ;; Test folded block.
1651 (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
1652 (org-cycle)
1653 (should
1654 (org-element-property
1655 :hiddenp
1656 (org-element-map (org-element-parse-buffer) 'quote-block
1657 'identity nil t))))
1658 ;; Ignore incomplete block.
1659 (should-not
1660 (org-test-with-temp-text "#+BEGIN_QUOTE"
1661 (org-element-map (org-element-parse-buffer) 'quote-block 'identity nil t)))
1662 ;; Handle non-empty blank line at the end of buffer.
1663 (should
1664 (org-test-with-temp-text "#+BEGIN_QUOTE\nC\n#+END_QUOTE\n "
1665 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1668 ;;;; Quote Section
1670 (ert-deftest test-org-element/quote-section-parser ()
1671 "Test `quote-section' parser."
1672 (should
1673 (let ((org-quote-string "QUOTE"))
1674 (org-test-with-temp-text "* QUOTE Headline\nBody"
1675 (org-element-map (org-element-parse-buffer) 'quote-section 'identity))))
1676 (should-not
1677 (let ((org-quote-string "TEST"))
1678 (org-test-with-temp-text "* QUOTE Headline\nBody"
1679 (org-element-map (org-element-parse-buffer) 'quote-section 'identity)))))
1682 ;;;; Radio Target
1684 (ert-deftest test-org-element/radio-target-parser ()
1685 "Test `radio-target' parser."
1686 ;; Standard test.
1687 (should
1688 (org-test-with-temp-text "<<<radio>>>"
1689 (org-element-map (org-element-parse-buffer) 'radio-target 'identity)))
1690 ;; Radio targets with objects.
1691 (should
1692 (org-test-with-temp-text "<<<radio \\alpha>>>"
1693 (org-element-map (org-element-parse-buffer) 'radio-target 'identity))))
1696 ;;;; Section
1698 (ert-deftest test-org-element/section-parser ()
1699 "Test `section' parser."
1700 ;; Standard test.
1701 (should
1702 (org-test-with-temp-text "* Headline\nText"
1703 (org-element-map (org-element-parse-buffer) 'section 'identity)))
1704 ;; There's a section before the first headline.
1705 (should
1706 (org-test-with-temp-text "Text"
1707 (org-element-map (org-element-parse-buffer) 'section 'identity)))
1708 ;; A section cannot be empty.
1709 (should-not
1710 (org-test-with-temp-text "* Headline 1\n* Headline 2"
1711 (org-element-map (org-element-parse-buffer) 'section 'identity)))
1712 ;; A section doesn't contain sub-trees.
1713 (should-not
1714 (org-test-with-temp-text "* Head\nText\n** Sub-Head"
1715 (org-element-map
1716 (org-element-map (org-element-parse-buffer) 'section 'identity nil t)
1717 'headline 'identity))))
1720 ;;;; Special Block
1722 (ert-deftest test-org-element/special-block-parser ()
1723 "Test `special-block' parser."
1724 ;; Standard test.
1725 (should
1726 (equal "SPECIAL"
1727 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1728 (org-element-property :type (org-element-at-point)))))
1729 ;; Special blocks can contain paragraphs.
1730 (should
1731 (eq 'paragraph
1732 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1733 (forward-line)
1734 (org-element-type (org-element-at-point)))))
1735 ;; Test folded block.
1736 (should
1737 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1738 (org-cycle)
1739 (org-element-property :hiddenp (org-element-at-point))))
1740 ;; Ignore incomplete block.
1741 (should-not
1742 (eq 'special-block
1743 (org-test-with-temp-text "#+BEGIN_SPECIAL"
1744 (org-element-type (org-element-at-point)))))
1745 ;; Allow special characters in type.
1746 (should
1747 (equal '(special-block "SPECIAL*")
1748 (org-test-with-temp-text "#+BEGIN_SPECIAL*\nContents\n#+END_SPECIAL*"
1749 (let ((element (org-element-at-point)))
1750 (list (org-element-type element)
1751 (org-element-property :type element))))))
1752 ;; Handle non-empty blank line at the end of buffer.
1753 (should
1754 (org-test-with-temp-text "#+BEGIN_SPECIAL\nC\n#+END_SPECIAL\n "
1755 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1758 ;;;; Src Block
1760 (ert-deftest test-org-element/src-block-parser ()
1761 "Test `src-block' parser."
1762 ;; Regular tests.
1763 (should
1764 (org-test-with-temp-text "#+BEGIN_SRC org\nText\n#+END_SRC"
1765 (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
1766 ;; Test folded block.
1767 (should
1768 (org-test-with-temp-text "#+BEGIN_SRC org\nText\n#+END_SRC"
1769 (org-cycle)
1770 (org-element-property :hiddenp (org-element-at-point))))
1771 ;; Ignore incomplete block.
1772 (should-not
1773 (org-test-with-temp-text "#+BEGIN_SRC"
1774 (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
1775 ;; Properly un-escape code.
1776 (should
1777 (equal "* Headline\n #+keyword\nText\n"
1778 (org-test-with-temp-text
1779 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText\n#+END_SRC"
1780 (org-element-property :value (org-element-at-point)))))
1781 ;; Nil `org-src-preserve-indentation': Remove maximum common
1782 ;; indentation.
1783 (should
1784 (equal " L1\nL2\n"
1785 (org-test-with-temp-text "#+BEGIN_SRC org\n L1\n L2\n#+END_SRC"
1786 (let ((org-src-preserve-indentation nil))
1787 (org-element-property :value (org-element-at-point))))))
1788 ;; Non-nil `org-src-preserve-indentation': Remove block indentation
1789 ;; only, unless block contents are less indented than block
1790 ;; boundaries.
1791 (should
1792 (equal " L1\nL2\n"
1793 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
1794 (let ((org-src-preserve-indentation t))
1795 (org-element-property :value (org-element-at-point))))))
1796 (should
1797 (equal
1798 " L1\n L2\n"
1799 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
1800 (let ((org-src-preserve-indentation t))
1801 (org-element-property :value (org-element-at-point))))))
1802 ;; Handle non-empty blank line at the end of buffer.
1803 (should
1804 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\nC\n#+END_SRC\n "
1805 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1808 ;;;; Statistics Cookie
1810 (ert-deftest test-org-element/statistics-cookie ()
1811 "Test `statistics-cookie' parser."
1812 ;; With numbers.
1813 (should
1814 (org-test-with-temp-text "[1/2]"
1815 (org-element-map (org-element-parse-buffer) 'statistics-cookie 'identity)))
1816 ;; With percents.
1817 (should
1818 (org-test-with-temp-text "[33%]"
1819 (org-element-map
1820 (org-element-parse-buffer) 'statistics-cookie 'identity))))
1823 ;;;; Strike Through
1825 (ert-deftest test-org-element/strike-through-parser ()
1826 "Test `strike-through' parser."
1827 ;; Regular test.
1828 (should
1829 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1830 (org-test-with-temp-text "+strike-through+"
1831 (org-element-map (org-element-parse-buffer) 'strike-through 'identity))))
1832 ;; Multi-line markup.
1833 (should
1834 (equal
1835 (org-element-contents
1836 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1837 (org-test-with-temp-text "+first line\nsecond line+"
1838 (org-element-map
1839 (org-element-parse-buffer) 'strike-through 'identity nil t))))
1840 '("first line\nsecond line"))))
1843 ;;;; Subscript
1845 (ert-deftest test-org-element/subscript-parser ()
1846 "Test `subscript' parser."
1847 ;; Without braces.
1848 (should
1849 (org-test-with-temp-text "a_b"
1850 (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
1851 ;; With braces.
1852 (should
1853 (org-test-with-temp-text "a_{b}"
1854 (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
1855 ;; Multiple subscripts in a paragraph.
1856 (should
1857 (= 2
1858 (org-test-with-temp-text "a_b and c_d"
1859 (length
1860 (org-element-map (org-element-parse-buffer) 'subscript 'identity))))))
1863 ;;;; Superscript
1865 (ert-deftest test-org-element/superscript-parser ()
1866 "Test `superscript' parser."
1867 ;; Without braces.
1868 (should
1869 (org-test-with-temp-text "a^b"
1870 (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
1871 ;; With braces.
1872 (should
1873 (org-test-with-temp-text "a^{b}"
1874 (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
1875 ;; Multiple superscript in a paragraph.
1876 (should
1877 (= 2
1878 (org-test-with-temp-text "a^b and c^d"
1879 (length
1880 (org-element-map
1881 (org-element-parse-buffer) 'superscript 'identity))))))
1884 ;;;; Table
1886 (ert-deftest test-org-element/table-parser ()
1887 "Test `table' parser."
1888 (should
1889 (org-test-with-temp-text "| a |"
1890 (org-element-map (org-element-parse-buffer) 'table 'identity)))
1891 ;; TBLFM keyword is case insensitive.
1892 (should
1893 (org-test-with-temp-text "| a |\n#+tblfm: test"
1894 (org-element-property
1895 :tblfm
1896 (org-element-map (org-element-parse-buffer) 'table 'identity nil t))))
1897 ;; Handle multiple TBLFM lines.
1898 (should
1899 (= 2
1900 (org-test-with-temp-text "| a |\n#+TBLFM: test1\n#+TBLFM: test2"
1901 (length (org-element-property
1902 :tblfm
1903 (org-element-map
1904 (org-element-parse-buffer) 'table 'identity nil t))))))
1905 ;; Handle non-empty blank line at the end of buffer.
1906 (should
1907 (org-test-with-temp-text "| a |\n "
1908 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1911 ;;;; Table Cell
1913 (ert-deftest test-org-element/table-cell-parser ()
1914 "Test `table-cell' parser."
1915 (should
1916 (org-test-with-temp-text "| a |"
1917 (org-element-map (org-element-parse-buffer) 'table-cell 'identity))))
1920 ;;;; Table Row
1922 (ert-deftest test-org-element/table-row-parser ()
1923 "Test `table-row' parser."
1924 (should
1925 (equal '(standard rule)
1926 (org-test-with-temp-text "| a |\n|---|"
1927 (org-element-map
1928 (org-element-parse-buffer) 'table-row
1929 (lambda (row) (org-element-property :type row)))))))
1932 ;;;; Target
1934 (ert-deftest test-org-element/target-parser ()
1935 "Test `target' parser."
1936 (should
1937 (org-test-with-temp-text "<<target>>"
1938 (org-element-map (org-element-parse-buffer) 'target 'identity))))
1941 ;;;; Timestamp
1943 (ert-deftest test-org-element/timestamp ()
1944 "Test `timestamp' parser."
1945 ;; Active timestamp.
1946 (should
1947 (org-test-with-temp-text "<2012-03-29 16:40>"
1948 (eq (org-element-property :type (org-element-context)) 'active)))
1949 (should-not
1950 (org-test-with-temp-text "<2012-03-29 Thu>"
1951 (let ((timestamp (org-element-context)))
1952 (or (org-element-property :hour-start timestamp)
1953 (org-element-property :minute-start timestamp)))))
1954 (should
1955 (equal '(2012 3 29 16 40)
1956 (org-test-with-temp-text "<2012-03-29 Thu 16:40>"
1957 (let ((object (org-element-context)))
1958 (list (org-element-property :year-start object)
1959 (org-element-property :month-start object)
1960 (org-element-property :day-start object)
1961 (org-element-property :hour-start object)
1962 (org-element-property :minute-start object))))))
1963 ;; Inactive timestamp.
1964 (should
1965 (org-test-with-temp-text "[2012-03-29 Thu 16:40]"
1966 (eq (org-element-property :type (org-element-context)) 'inactive)))
1967 ;; Time range.
1968 (should
1969 (equal '(2012 3 29 16 40 7 30)
1970 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
1971 (let ((object (org-element-context)))
1972 (list (org-element-property :year-end object)
1973 (org-element-property :month-end object)
1974 (org-element-property :day-end object)
1975 (org-element-property :hour-end object)
1976 (org-element-property :minute-end object)
1977 (org-element-property :hour-start object)
1978 (org-element-property :minute-start object))))))
1979 (should
1980 (eq 'active-range
1981 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
1982 (org-element-property :type (org-element-context)))))
1983 ;; Date range.
1984 (should
1985 (org-test-with-temp-text "[2012-03-29 Thu 16:40]--[2012-03-29 Thu 16:41]"
1986 (eq (org-element-property :type (org-element-context)) 'inactive-range)))
1987 (should-not
1988 (org-test-with-temp-text "[2011-07-14 Thu]--[2012-03-29 Thu]"
1989 (let ((timestamp (org-element-context)))
1990 (or (org-element-property :hour-end timestamp)
1991 (org-element-property :minute-end timestamp)))))
1992 ;; With repeater, warning delay and both.
1993 (should
1994 (eq 'catch-up
1995 (org-test-with-temp-text "<2012-03-29 Thu ++1y>"
1996 (org-element-property :repeater-type (org-element-context)))))
1997 (should
1998 (eq 'first
1999 (org-test-with-temp-text "<2012-03-29 Thu --1y>"
2000 (org-element-property :warning-type (org-element-context)))))
2001 (should
2002 (equal '(cumulate all)
2003 (org-test-with-temp-text "<2012-03-29 Thu +1y -1y>"
2004 (let ((ts (org-element-context)))
2005 (list (org-element-property :repeater-type ts)
2006 (org-element-property :warning-type ts))))))
2007 ;; Timestamps are not planning elements.
2008 (should-not
2009 (org-test-with-temp-text "SCHEDULED: <2012-03-29 Thu 16:40>"
2010 (org-element-map (org-element-parse-buffer) 'timestamp 'identity))))
2013 ;;;; Underline
2015 (ert-deftest test-org-element/underline-parser ()
2016 "Test `underline' parser."
2017 ;; Regular test.
2018 (should
2019 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2020 (org-test-with-temp-text "_underline_"
2021 (org-element-map (org-element-parse-buffer) 'underline 'identity))))
2022 ;; Multi-line markup.
2023 (should
2024 (equal
2025 (org-element-contents
2026 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2027 (org-test-with-temp-text "_first line\nsecond line_"
2028 (org-element-map
2029 (org-element-parse-buffer) 'underline 'identity nil t))))
2030 '("first line\nsecond line"))))
2033 ;;;; Verbatim
2035 (ert-deftest test-org-element/verbatim-parser ()
2036 "Test `verbatim' parser."
2037 ;; Regular test.
2038 (should
2039 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2040 (org-test-with-temp-text "=verbatim="
2041 (org-element-map (org-element-parse-buffer) 'verbatim 'identity))))
2042 ;; Multi-line markup.
2043 (should
2044 (equal
2045 (org-element-property
2046 :value
2047 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2048 (org-test-with-temp-text "=first line\nsecond line="
2049 (org-element-map
2050 (org-element-parse-buffer) 'verbatim 'identity nil t))))
2051 "first line\nsecond line")))
2054 ;;;; Verse Block
2056 (ert-deftest test-org-element/verse-block-parser ()
2057 "Test `verse-block' parser."
2058 ;; Standard test.
2059 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
2060 (should
2061 (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
2062 ;; Ignore case.
2063 (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
2064 (should
2065 (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
2066 ;; Parse folding.
2067 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
2068 (org-hide-block-all)
2069 (should
2070 (org-element-property
2071 :hiddenp
2072 (org-element-map (org-element-parse-buffer) 'verse-block
2073 'identity nil t))))
2074 ;; Parse objects in verse blocks.
2075 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
2076 (should (org-element-map (org-element-parse-buffer) 'entity 'identity)))
2077 ;; Ignore incomplete verse block.
2078 (should-not
2079 (org-test-with-temp-text "#+BEGIN_VERSE"
2080 (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)))
2081 ;; Handle non-empty blank line at the end of buffer.
2082 (should
2083 (org-test-with-temp-text "#+BEGIN_VERSE\nC\n#+END_VERSE\n "
2084 (= (org-element-property :end (org-element-at-point)) (point-max)))))
2088 ;;; Test Interpreters.
2090 (ert-deftest test-org-element/affiliated-keywords-interpreter ()
2091 "Test if affiliated keywords are correctly interpreted."
2092 ;; Interpret simple keywords.
2093 (should
2094 (equal
2095 (org-element-interpret-data
2096 '(org-data nil (paragraph (:name "para") "Paragraph")))
2097 "#+NAME: para\nParagraph\n"))
2098 ;; Interpret multiple keywords.
2099 (should
2100 (equal
2101 (org-element-interpret-data
2102 '(org-data nil (paragraph (:attr_ascii ("line2" "line1")) "Paragraph")))
2103 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
2104 ;; Interpret parsed keywords.
2105 (should
2106 (equal
2107 (org-element-interpret-data
2108 '(org-data nil (paragraph (:caption (("caption"))) "Paragraph")))
2109 "#+CAPTION: caption\nParagraph\n"))
2110 ;; Interpret dual keywords.
2111 (should
2112 (equal
2113 (org-element-interpret-data
2114 '(org-data nil (paragraph (:caption ((("long") "short"))) "Paragraph")))
2115 "#+CAPTION[short]: long\nParagraph\n"))
2116 ;; Interpret multiple parsed dual keywords.
2117 (should
2118 (equal
2119 (org-element-interpret-data
2120 '(org-data nil (paragraph
2121 (:caption ((("l2") "s2") (("l1") "s1"))) "Paragraph")))
2122 "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph\n")))
2124 (ert-deftest test-org-element/center-block-interpreter ()
2125 "Test center block interpreter."
2126 (should
2127 (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
2128 "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
2130 (ert-deftest test-org-element/drawer-interpreter ()
2131 "Test drawer interpreter."
2132 (should
2133 (equal (let ((org-drawers '("TEST")))
2134 (org-test-parse-and-interpret ":TEST:\nTest\n:END:"))
2135 ":TEST:\nTest\n:END:\n")))
2137 (ert-deftest test-org-element/dynamic-block-interpreter ()
2138 "Test dynamic block interpreter."
2139 (should
2140 (equal (org-test-parse-and-interpret
2141 "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
2142 "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
2144 (ert-deftest test-org-element/footnote-definition-interpreter ()
2145 "Test footnote definition interpreter."
2146 (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
2148 (ert-deftest test-org-element/headline-interpreter ()
2149 "Test headline and section interpreters."
2150 ;; 1. Standard test.
2151 (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
2152 ;; 2. With TODO keywords.
2153 (should
2154 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2155 (org-test-parse-and-interpret "* TODO Headline"))
2156 "* TODO Headline\n"))
2157 ;; 3. With tags...
2159 ;; 3.1. ... and a positive `org-tags-column' value.
2160 (should
2161 (equal (let ((org-tags-column 20))
2162 (org-test-parse-and-interpret "* Headline :tag:"))
2163 "* Headline :tag:\n"))
2164 ;; 3.2. ... and a negative `org-tags-column' value.
2165 (should
2166 (equal (let ((org-tags-column -20))
2167 (org-test-parse-and-interpret "* Headline :tag:"))
2168 "* Headline :tag:\n"))
2169 ;; 3.3. ... and a null `org-tags-column' value.
2170 (should
2171 (equal (let ((org-tags-column 0))
2172 (org-test-parse-and-interpret "* Headline :tag:"))
2173 "* Headline :tag:\n"))
2174 ;; 4. With priority cookie.
2175 (should
2176 (equal (org-test-parse-and-interpret "* [#B] Headline")
2177 "* [#B] Headline\n"))
2178 ;; 5. With comment keyword.
2179 (should
2180 (equal (let ((org-comment-string "COMMENT"))
2181 (org-test-parse-and-interpret "* COMMENT Headline"))
2182 "* COMMENT Headline\n"))
2183 ;; 6. With quote section.
2184 (should
2185 (equal (let ((org-quote-string "QUOTE"))
2186 (org-test-parse-and-interpret "* QUOTE Headline"))
2187 "* QUOTE Headline\n"))
2188 ;; 7. Keep same number of blank lines before body.
2189 (should
2190 (equal (org-test-parse-and-interpret
2191 "* Headline\n\n\nText after two blank lines.")
2192 "* Headline\n\n\nText after two blank lines.\n")))
2194 (ert-deftest test-org-element/inlinetask-interpreter ()
2195 "Test inlinetask interpretation."
2196 (when (featurep 'org-inlinetask)
2197 (let ((org-inlinetask-min-level 15))
2198 ;; 1. Regular inlinetask.
2199 (should (equal (org-test-parse-and-interpret
2200 "*************** Task\nTest\n*************** END")
2201 "*************** Task\nTest\n*************** END\n"))
2202 ;; 2. Degenerate inlinetask.
2203 (should (equal (org-test-parse-and-interpret "*************** Task")
2204 "*************** Task\n"))
2205 ;; 3. Prefer degenerate form when there are no contents.
2206 (should (equal (org-test-parse-and-interpret
2207 "*************** Task\n*************** END")
2208 "*************** Task\n"))
2209 ;; 4. With TODO keywords.
2210 (should
2211 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2212 (org-test-parse-and-interpret "*************** TODO Task"))
2213 "*************** TODO Task\n"))
2214 ;; 5. With tags...
2216 ;; 5.1. ... and a positive `org-tags-column' value.
2217 (should
2218 (equal (let ((org-tags-column 30))
2219 (org-test-parse-and-interpret "*************** Task :tag:"))
2220 "*************** Task :tag:\n"))
2221 ;; 5.2. ... and a negative `org-tags-column' value.
2222 (should
2223 (equal (let ((org-tags-column -30))
2224 (org-test-parse-and-interpret "*************** Task :tag:"))
2225 "*************** Task :tag:\n"))
2226 ;; 5.3. ... and a null `org-tags-column' value.
2227 (should
2228 (equal (let ((org-tags-column 0))
2229 (org-test-parse-and-interpret "*************** Task :tag:"))
2230 "*************** Task :tag:\n"))
2231 ;; 6. With priority cookie.
2232 (should
2233 (equal (org-test-parse-and-interpret "*************** [#B] Task")
2234 "*************** [#B] Task\n")))))
2236 (ert-deftest test-org-element/plain-list-interpreter ()
2237 "Test plain-list and item interpreters."
2238 (let ((org-list-two-spaces-after-bullet-regexp nil))
2239 ;; Unordered list.
2240 (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
2241 ;; Description list.
2242 (should
2243 (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
2244 ;; Ordered list.
2245 (should
2246 (equal (let ((org-plain-list-ordered-item-terminator t))
2247 (org-test-parse-and-interpret "1. Item"))
2248 "1. Item\n"))
2249 (should
2250 (equal (let ((org-plain-list-ordered-item-terminator ?\)))
2251 (org-test-parse-and-interpret "1) Item"))
2252 "1) Item\n"))
2253 ;; Ordered list with counter.
2254 (should
2255 (equal (let ((org-plain-list-ordered-item-terminator t))
2256 (org-test-parse-and-interpret "1. [@5] Item"))
2257 "5. [@5] Item\n"))
2258 ;; List with check-boxes.
2259 (should
2260 (equal (org-test-parse-and-interpret
2261 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
2262 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n"))
2263 ;; Item not starting with a paragraph.
2264 (should
2265 (equal (org-test-parse-and-interpret "-\n | a | b |")
2266 "- \n | a | b |\n"))
2267 ;; Special case: correctly handle "*" bullets.
2268 (should (org-test-parse-and-interpret " * item"))
2269 ;; Special case: correctly handle empty items.
2270 (should (org-test-parse-and-interpret "-"))))
2272 (ert-deftest test-org-element/quote-block-interpreter ()
2273 "Test quote block interpreter."
2274 (should (equal (org-test-parse-and-interpret
2275 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
2276 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
2278 (ert-deftest test-org-element/special-block-interpreter ()
2279 "Test special block interpreter."
2280 (should (equal (org-test-parse-and-interpret
2281 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
2282 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
2284 (ert-deftest test-org-element/babel-call-interpreter ()
2285 "Test babel call interpreter."
2286 ;; 1. Without argument.
2287 (should (equal (org-test-parse-and-interpret "#+CALL: test()")
2288 "#+CALL: test()\n"))
2289 ;; 2. With argument.
2290 (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
2291 "#+CALL: test(x=2)\n"))
2292 ;; 3. With header arguments.
2293 (should (equal (org-test-parse-and-interpret
2294 "#+CALL: test[:results output]()[:results html]")
2295 "#+CALL: test[:results output]()[:results html]\n")))
2297 (ert-deftest test-org-element/clock-interpreter ()
2298 "Test clock interpreter."
2299 ;; Running clock.
2300 (should
2301 (equal (let ((org-clock-string "CLOCK:"))
2302 (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]"))
2303 "CLOCK: [2012-01-01 sun. 00:01]\n"))
2304 ;; Closed clock.
2305 (should
2306 (equal
2307 (let ((org-clock-string "CLOCK:"))
2308 (org-test-parse-and-interpret "
2309 CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))
2310 "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01\n")))
2312 (ert-deftest test-org-element/comment-interpreter ()
2313 "Test comment interpreter."
2314 ;; Regular comment.
2315 (should (equal (org-test-parse-and-interpret "# Comment") "# Comment\n"))
2316 ;; Inline comment.
2317 (should (equal (org-test-parse-and-interpret " # Comment")
2318 "# Comment\n"))
2319 ;; Preserve indentation.
2320 (should (equal (org-test-parse-and-interpret " # No blank\n# One blank")
2321 "# No blank\n# One blank\n")))
2323 (ert-deftest test-org-element/comment-block-interpreter ()
2324 "Test comment block interpreter."
2325 (should (equal (org-test-parse-and-interpret
2326 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
2327 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n")))
2329 (ert-deftest test-org-element/diary-sexp ()
2330 "Test diary-sexp interpreter."
2331 (should
2332 (equal
2333 (org-test-parse-and-interpret
2334 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old")
2335 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old\n")))
2337 (ert-deftest test-org-element/example-block-interpreter ()
2338 "Test example block interpreter."
2339 ;; Without switches.
2340 (should (equal (org-test-parse-and-interpret
2341 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
2342 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
2343 ;; With switches.
2344 (should
2345 (equal (org-test-parse-and-interpret
2346 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
2347 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n"))
2348 ;; Preserve code escaping.
2349 (should
2350 (equal (org-test-parse-and-interpret
2351 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE")
2352 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE\n")))
2354 (ert-deftest test-org-element/export-block-interpreter ()
2355 "Test export block interpreter."
2356 (should (equal (org-test-parse-and-interpret
2357 "#+BEGIN_HTML\nTest\n#+END_HTML")
2358 "#+BEGIN_HTML\nTest\n#+END_HTML\n")))
2360 (ert-deftest test-org-element/fixed-width-interpreter ()
2361 "Test fixed width interpreter."
2362 ;; Standard test.
2363 (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
2364 ;; Preserve indentation.
2365 (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
2366 ": 2 blanks\n: 1 blank\n"))
2367 ;; Remove last newline character
2368 (should
2369 (equal (org-element-fixed-width-interpreter
2370 '(fixed-width (:value "Test\n")) nil)
2371 ": Test"))
2372 (should
2373 (equal (org-element-fixed-width-interpreter
2374 '(fixed-width (:value "Test")) nil)
2375 ": Test"))
2376 ;; Handle empty string.
2377 (should
2378 (equal (org-element-fixed-width-interpreter
2379 '(fixed-width (:value "")) nil)
2380 ""))
2381 ;; Handle nil value.
2382 (should-not
2383 (org-element-fixed-width-interpreter
2384 '(fixed-width (:value nil)) nil)))
2386 (ert-deftest test-org-element/horizontal-rule-interpreter ()
2387 "Test horizontal rule interpreter."
2388 (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
2390 (ert-deftest test-org-element/keyword-interpreter ()
2391 "Test keyword interpreter."
2392 (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
2393 "#+KEYWORD: value\n")))
2395 (ert-deftest test-org-element/latex-environment-interpreter ()
2396 "Test latex environment interpreter."
2397 (should (equal (org-test-parse-and-interpret
2398 "\\begin{equation}\n1+1=2\n\\end{equation}")
2399 "\\begin{equation}\n1+1=2\n\\end{equation}\n"))
2400 (should (equal (org-test-parse-and-interpret
2401 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}")
2402 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}\n")))
2404 (ert-deftest test-org-element/planning-interpreter ()
2405 "Test planning interpreter."
2406 (let ((org-closed-string "CLOSED:")
2407 (org-deadline-string "DEADLINE:")
2408 (org-scheduled-string "SCHEDULED:"))
2409 (should
2410 (equal
2411 (org-test-parse-and-interpret
2412 "* Headline
2413 DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01> CLOSED: [2012-01-01]")
2414 "* Headline
2415 DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01> CLOSED: [2012-01-01]\n"))))
2417 (ert-deftest test-org-element/property-drawer-interpreter ()
2418 "Test property drawer interpreter."
2419 (should (equal (let ((org-property-format "%-10s %s"))
2420 (org-test-parse-and-interpret
2421 ":PROPERTIES:\n:prop: value\n:END:"))
2422 ":PROPERTIES:\n:prop: value\n:END:\n")))
2424 (ert-deftest test-org-element/src-block-interpreter ()
2425 "Test src block interpreter."
2426 ;; With arguments.
2427 (should
2428 (equal (let ((org-edit-src-content-indentation 2))
2429 (org-test-parse-and-interpret
2430 "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC"))
2431 "#+BEGIN_SRC emacs-lisp :results silent\n (+ 1 1)\n#+END_SRC\n"))
2432 ;; With switches.
2433 (should
2434 (equal (let ((org-edit-src-content-indentation 2))
2435 (org-test-parse-and-interpret
2436 "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC"))
2437 "#+BEGIN_SRC emacs-lisp -n -k\n (+ 1 1)\n#+END_SRC\n"))
2438 ;; Preserve code escaping.
2439 (should
2440 (equal (let ((org-edit-src-content-indentation 2))
2441 (org-test-parse-and-interpret
2442 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC"))
2443 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC\n"))
2444 ;; Do not apply `org-edit-src-content-indentation' when preserving
2445 ;; indentation.
2446 (should
2447 (equal (let ((org-edit-src-content-indentation 2)
2448 (org-src-preserve-indentation t))
2449 (org-test-parse-and-interpret
2450 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"))
2451 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n"))
2452 (should
2453 (equal (let ((org-edit-src-content-indentation 2)
2454 (org-src-preserve-indentation nil))
2455 (org-test-parse-and-interpret
2456 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"))
2457 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC\n")))
2459 (ert-deftest test-org-element/table-interpreter ()
2460 "Test table, table-row and table-cell interpreters."
2461 ;; 1. Simple table.
2462 (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
2463 "| a | b |\n| c | d |\n"))
2464 ;; 2. With horizontal rules.
2465 (should (equal (org-test-parse-and-interpret
2466 "| a | b |\n|---+---|\n| c | d |")
2467 "| a | b |\n|---+---|\n| c | d |\n"))
2468 ;; 3. With meta-data.
2469 (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
2470 "| / | < | > |\n| * | 1 | 2 |\n"))
2471 ;; 4. With a formula.
2472 (should
2473 (equal (org-test-parse-and-interpret
2474 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)")
2475 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)\n"))
2476 ;; 5. With multiple formulas.
2477 (should
2478 (equal (org-test-parse-and-interpret
2479 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2")
2480 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2\n")))
2482 (ert-deftest test-org-element/timestamp-interpreter ()
2483 "Test timestamp interpreter."
2484 ;; Active.
2485 (should (equal (org-test-parse-and-interpret "<2012-03-29 thu. 16:40>")
2486 "<2012-03-29 thu. 16:40>\n"))
2487 (should
2488 (string-match "<2012-03-29 .* 16:40>"
2489 (org-element-timestamp-interpreter
2490 '(timestamp
2491 (:type active :year-start 2012 :month-start 3 :day-start 29
2492 :hour-start 16 :minute-start 40)) nil)))
2493 ;; Inactive.
2494 (should (equal (org-test-parse-and-interpret "[2012-03-29 thu. 16:40]")
2495 "[2012-03-29 thu. 16:40]\n"))
2496 (should
2497 (string-match
2498 "\\[2012-03-29 .* 16:40\\]"
2499 (org-element-timestamp-interpreter
2500 '(timestamp
2501 (:type inactive :year-start 2012 :month-start 3 :day-start 29
2502 :hour-start 16 :minute-start 40)) nil)))
2503 ;; Active range.
2504 (should (equal (org-test-parse-and-interpret
2505 "<2012-03-29 thu. 16:40>--<2012-03-29 thu. 16:41>")
2506 "<2012-03-29 thu. 16:40>--<2012-03-29 thu. 16:41>\n"))
2507 (should
2508 (string-match
2509 "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2510 (org-element-timestamp-interpreter
2511 '(timestamp
2512 (:type active-range :year-start 2012 :month-start 3 :day-start 29
2513 :hour-start 16 :minute-start 40 :year-end 2012 :month-end 3
2514 :day-end 29 :hour-end 16 :minute-end 41)) nil)))
2515 ;; Inactive range.
2516 (should (equal (org-test-parse-and-interpret
2517 "[2012-03-29 thu. 16:40]--[2012-03-29 thu. 16:41]")
2518 "[2012-03-29 thu. 16:40]--[2012-03-29 thu. 16:41]\n"))
2519 (should
2520 (string-match
2521 "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2522 (org-element-timestamp-interpreter
2523 '(timestamp
2524 (:type inactive-range :year-start 2012 :month-start 3 :day-start 29
2525 :hour-start 16 :minute-start 40 :year-end 2012 :month-end 3
2526 :day-end 29 :hour-end 16 :minute-end 41)) nil)))
2527 ;; Diary.
2528 (should (equal (org-test-parse-and-interpret "<%%diary-float t 4 2>")
2529 "<%%diary-float t 4 2>\n"))
2530 ;; Timestamp with repeater interval, with delay, with both.
2531 (should (equal (org-test-parse-and-interpret "<2012-03-29 thu. +1y>")
2532 "<2012-03-29 thu. +1y>\n"))
2533 (should
2534 (string-match
2535 "<2012-03-29 .* \\+1y>"
2536 (org-element-timestamp-interpreter
2537 '(timestamp
2538 (:type active :year-start 2012 :month-start 3 :day-start 29
2539 :repeater-type cumulate :repeater-value 1 :repeater-unit year))
2540 nil)))
2541 (should
2542 (string-match
2543 "<2012-03-29 .* -1y>"
2544 (org-element-timestamp-interpreter
2545 '(timestamp
2546 (:type active :year-start 2012 :month-start 3 :day-start 29
2547 :warning-type all :warning-value 1 :warning-unit year))
2548 nil)))
2549 (should
2550 (string-match
2551 "<2012-03-29 .* \\+1y -1y>"
2552 (org-element-timestamp-interpreter
2553 '(timestamp
2554 (:type active :year-start 2012 :month-start 3 :day-start 29
2555 :warning-type all :warning-value 1 :warning-unit year
2556 :repeater-type cumulate :repeater-value 1 :repeater-unit year))
2557 nil)))
2558 ;; Timestamp range with repeater interval
2559 (should (equal (org-test-parse-and-interpret
2560 "<2012-03-29 Thu +1y>--<2012-03-30 Thu +1y>")
2561 "<2012-03-29 Thu +1y>--<2012-03-30 Thu +1y>\n"))
2562 (should
2563 (string-match
2564 "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2565 (org-element-timestamp-interpreter
2566 '(timestamp
2567 (:type active-range :year-start 2012 :month-start 3 :day-start 29
2568 :year-end 2012 :month-end 3 :day-end 30 :repeater-type cumulate
2569 :repeater-value 1 :repeater-unit year))
2570 nil))))
2572 (ert-deftest test-org-element/verse-block-interpreter ()
2573 "Test verse block interpretation."
2574 (should
2575 (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
2576 "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
2578 (ert-deftest test-org-element/bold-interpreter ()
2579 "Test bold interpreter."
2580 (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
2582 (ert-deftest test-org-element/code-interpreter ()
2583 "Test code interpreter."
2584 (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
2586 (ert-deftest test-org-element/entity-interpreter ()
2587 "Test entity interpreter."
2588 ;; 1. Without brackets.
2589 (should
2590 (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
2591 ;; 2. With brackets.
2592 (should
2593 (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
2595 (ert-deftest test-org-element/export-snippet-interpreter ()
2596 "Test export snippet interpreter."
2597 (should (equal (org-test-parse-and-interpret "@@back-end:contents@@")
2598 "@@back-end:contents@@\n")))
2600 (ert-deftest test-org-element/footnote-reference-interpreter ()
2601 "Test footnote reference interpreter."
2602 ;; 1. Regular reference.
2603 (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
2604 ;; 2. Normalized reference.
2605 (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
2606 ;; 3. Named reference.
2607 (should (equal (org-test-parse-and-interpret "Text[fn:label]")
2608 "Text[fn:label]\n"))
2609 ;; 4. Inline reference.
2610 (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
2611 "Text[fn:label:def]\n"))
2612 ;; 5. Anonymous reference.
2613 (should (equal (org-test-parse-and-interpret "Text[fn::def]")
2614 "Text[fn::def]\n")))
2616 (ert-deftest test-org-element/inline-babel-call-interpreter ()
2617 "Test inline babel call interpreter."
2618 ;; 1. Without arguments.
2619 (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
2620 ;; 2. With arguments.
2621 (should (equal (org-test-parse-and-interpret "call_test(x=2)")
2622 "call_test(x=2)\n"))
2623 ;; 3. With header arguments.
2624 (should (equal (org-test-parse-and-interpret
2625 "call_test[:results output]()[:results html]")
2626 "call_test[:results output]()[:results html]\n")))
2628 (ert-deftest test-org-element/inline-src-block-interpreter ()
2629 "Test inline src block interpreter."
2630 ;; 1. Without header argument.
2631 (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
2632 "src_emacs-lisp{(+ 1 1)}\n"))
2633 ;; 2. With header arguments.
2634 (should (equal (org-test-parse-and-interpret
2635 "src_emacs-lisp[:results silent]{(+ 1 1)}")
2636 "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
2638 (ert-deftest test-org-element/italic-interpreter ()
2639 "Test italic interpreter."
2640 (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
2642 (ert-deftest test-org-element/latex-fragment-interpreter ()
2643 "Test latex fragment interpreter."
2644 (let ((org-latex-regexps
2645 '(("begin" "^[ ]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^