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