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