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