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