Merge branch 'maint'
[org-mode/org-tableheadings.git] / testing / lisp / test-org-element.el
blob52ea74b6e3b351e5991ffd9a16419b4f3eeff6b4
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 Snippet
782 (ert-deftest test-org-element/export-snippet-parser ()
783 "Test `export-snippet' parser."
784 (should
785 (equal
786 '("back-end" . "contents")
787 (org-test-with-temp-text "@@back-end:contents@@"
788 (org-element-map
789 (org-element-parse-buffer) 'export-snippet
790 (lambda (snippet) (cons (org-element-property :back-end snippet)
791 (org-element-property :value snippet)))
792 nil t)))))
795 ;;;; Fixed Width
797 (ert-deftest test-org-element/fixed-width-parser ()
798 "Test fixed-width area parsing."
799 ;; Preserve indentation.
800 (should
801 (org-test-with-temp-text ": no blank\n: one blank"
802 (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
803 ;; Fixed-width with empty lines.
804 (should
805 (org-test-with-temp-text ": first part\n:\n: \n: second part"
806 (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
807 ;; Parse indented fixed-width markers.
808 (should
809 (org-test-with-temp-text "Text\n : no blank\n : one blank"
810 (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
811 ;; Distinguish fixed-width areas within a list and outside of it.
812 (should
813 (= 2
814 (length
815 (org-test-with-temp-text "
816 - Item
817 : fixed-width inside
818 : fixed-width outside"
819 (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))))
820 ;; Handle non-empty blank line at the end of buffer.
821 (should
822 (org-test-with-temp-text ": A\n "
823 (= (org-element-property :end (org-element-at-point)) (point-max)))))
826 ;;;; Footnote Definition
828 (ert-deftest test-org-element/footnote-definition-parser ()
829 "Test `footnote-definition' parser."
830 (should
831 (org-test-with-temp-text "[fn:1] Definition"
832 (org-element-map (org-element-parse-buffer) 'footnote-definition
833 'identity nil t)))
834 ;; Footnote with more contents
835 (should
836 (= 29
837 (org-element-property
838 :end
839 (org-test-with-temp-text "[fn:1] Definition\n\n| a | b |"
840 (org-element-map (org-element-parse-buffer) 'footnote-definition
841 'identity nil t)))))
842 ;; Footnote starting with special syntax.
843 (should-not
844 (org-test-with-temp-text "[fn:1] - no item"
845 (org-element-map (org-element-parse-buffer) 'item 'identity)))
846 ;; Correctly handle footnote starting with an empty line.
847 (should
848 (= 9
849 (org-test-with-temp-text "[fn:1]\n\n Body"
850 (org-element-property :contents-begin (org-element-at-point)))))
851 ;; Handle non-empty blank line at the end of buffer.
852 (should
853 (org-test-with-temp-text "[fn:1] Definition\n "
854 (= (org-element-property :end (org-element-at-point)) (point-max)))))
857 ;;;; Footnotes Reference.
859 (ert-deftest test-org-element/footnote-reference-parser ()
860 "Test `footnote-reference' parser."
861 ;; Parse a standard reference.
862 (should
863 (org-test-with-temp-text "Text[fn:label]"
864 (org-element-map
865 (org-element-parse-buffer) 'footnote-reference 'identity)))
866 ;; Parse a normalized reference.
867 (should
868 (org-test-with-temp-text "Text[1]"
869 (org-element-map
870 (org-element-parse-buffer) 'footnote-reference 'identity)))
871 ;; Parse an inline reference.
872 (should
873 (org-test-with-temp-text "Text[fn:test:def]"
874 (org-element-map
875 (org-element-parse-buffer) 'footnote-reference 'identity)))
876 ;; Parse an anonymous reference.
877 (should
878 (org-test-with-temp-text "Text[fn::def]"
879 (org-element-map
880 (org-element-parse-buffer) 'footnote-reference 'identity)))
881 ;; Parse nested footnotes.
882 (should
883 (= 2
884 (length
885 (org-test-with-temp-text "Text[fn::def [fn:label]]"
886 (org-element-map
887 (org-element-parse-buffer) 'footnote-reference 'identity)))))
888 ;; Parse adjacent footnotes.
889 (should
890 (org-test-with-temp-text "Text[fn:label1][fn:label2]"
891 (= 2
892 (length
893 (org-element-map
894 (org-element-parse-buffer) 'footnote-reference 'identity)))))
895 ;; Only properly closed footnotes are recognized as such.
896 (should-not
897 (org-test-with-temp-text "Text[fn:label"
898 (org-element-map
899 (org-element-parse-buffer) 'footnote-reference 'identity))))
902 ;;;; Headline
904 (ert-deftest test-org-element/headline-comment-keyword ()
905 "Test COMMENT keyword recognition."
906 ;; Reference test.
907 (org-test-with-temp-text "* Headline"
908 (let ((org-comment-string "COMMENT"))
909 (should-not (org-element-property :commentedp (org-element-at-point)))))
910 ;; Standard position.
911 (org-test-with-temp-text "* COMMENT Headline"
912 (let ((org-comment-string "COMMENT")
913 (headline (org-element-at-point)))
914 (should (org-element-property :commentedp headline))
915 (should (equal (org-element-property :raw-value headline) "Headline"))))
916 ;; Case sensitivity.
917 (org-test-with-temp-text "* COMMENT Headline"
918 (let* ((org-comment-string "Comment")
919 (headline (org-element-at-point)))
920 (should-not (org-element-property :commentedp headline))
921 (should (equal (org-element-property :raw-value headline)
922 "COMMENT Headline"))))
923 ;; With another keyword.
924 (org-test-with-temp-text "* TODO COMMENT Headline"
925 (let* ((org-comment-string "COMMENT")
926 (org-todo-keywords '((sequence "TODO" "DONE")))
927 (headline (org-element-at-point)))
928 (should (org-element-property :commentedp headline))
929 (should (equal (org-element-property :raw-value headline) "Headline"))))
930 ;; With the keyword only.
931 (org-test-with-temp-text "* COMMENT"
932 (let* ((org-comment-string "COMMENT")
933 (headline (org-element-at-point)))
934 (should (org-element-property :commentedp headline))
935 (should (equal (org-element-property :raw-value headline) "")))))
937 (ert-deftest test-org-element/headline-archive-tag ()
938 "Test ARCHIVE tag recognition."
939 ;; Reference test.
940 (should-not
941 (org-test-with-temp-text "* Headline"
942 (let ((org-archive-tag "ARCHIVE"))
943 (org-element-property :archivedp (org-element-at-point)))))
944 ;; Single tag.
945 (org-test-with-temp-text "* Headline :ARCHIVE:"
946 (let ((org-archive-tag "ARCHIVE"))
947 (let ((headline (org-element-at-point)))
948 (should (org-element-property :archivedp headline))
949 ;; Test tag removal.
950 (should-not (org-element-property :tags headline)))))
951 ;; Multiple tags.
952 (org-test-with-temp-text "* Headline :test:ARCHIVE:"
953 (let ((org-archive-tag "ARCHIVE"))
954 (let ((headline (org-element-at-point)))
955 (should (org-element-property :archivedp headline))
956 ;; Test tag removal.
957 (should (equal (org-element-property :tags headline) '("test"))))))
958 ;; Tag is case-sensitive.
959 (should-not
960 (org-test-with-temp-text "* Headline :ARCHIVE:"
961 (let ((org-archive-tag "Archive"))
962 (org-element-property :archivedp (org-element-at-point))))))
964 (ert-deftest test-org-element/headline-properties ()
965 "Test properties from property drawer."
966 ;; All properties from property drawer have their symbol upper
967 ;; cased.
968 (should
969 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
970 (org-element-property :FOO (org-element-at-point))))
971 (should-not
972 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
973 (org-element-property :foo (org-element-at-point))))
974 ;; Also parse properties associated in inlinetasks.
975 (when (featurep 'org-inlinetask)
976 (should
977 (org-test-with-temp-text "*************** Inlinetask
978 :PROPERTIES:
979 :foo: bar
980 :END:
981 *************** END"
982 (org-element-property :FOO (org-element-at-point)))))
983 ;; Do not find property drawer in a verbatim area.
984 (should-not
985 (org-test-with-temp-text
986 "* Headline
987 #+BEGIN_EXAMPLE
988 :PROPERTIES:
989 :foo: bar
990 :END:
991 #+END_EXAMPLE"
992 (org-element-property :FOO (org-element-at-point))))
993 ;; Do not use properties from a drawer associated to an inlinetask.
994 (when (featurep 'org-inlinetask)
995 (should-not
996 (org-test-with-temp-text
997 "* Headline
998 *************** Inlinetask
999 :PROPERTIES:
1000 :foo: bar
1001 :END:
1002 *************** END"
1003 (org-element-property
1004 :FOO (let ((org-inlinetask-min-level 15)) (org-element-at-point))))))
1005 ;; Do not find incomplete drawers.
1006 (should-not
1007 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar"
1008 (org-element-property :FOO (org-element-at-point)))))
1011 ;;;; Horizontal Rule
1013 (ert-deftest test-org-element/horizontal-rule-parser ()
1014 "Test `horizontal-rule' parser."
1015 ;; Standard.
1016 (should
1017 (org-test-with-temp-text "-----"
1018 (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
1019 ;; Indented.
1020 (should
1021 (org-test-with-temp-text " -----"
1022 (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
1023 ;; Hyphen must be alone on the line.
1024 (should-not
1025 (org-test-with-temp-text "-----wrong"
1026 (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
1027 ;; 4 hyphens is too small.
1028 (should-not
1029 (org-test-with-temp-text "----"
1030 (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
1031 ;; Handle non-empty blank line at the end of buffer.
1032 (should
1033 (org-test-with-temp-text "-----\n "
1034 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1037 ;;;; Inline Babel Call
1039 (ert-deftest test-org-element/inline-babel-call-parser ()
1040 "Test `inline-babel-call' parser."
1041 (should
1042 (org-test-with-temp-text "call_test()"
1043 (org-element-map
1044 (org-element-parse-buffer) 'inline-babel-call 'identity))))
1047 ;;;; Inline Src Block
1049 (ert-deftest test-org-element/inline-src-block-parser ()
1050 "Test `inline-src-block' parser."
1051 (should
1052 (org-test-with-temp-text "src_emacs-lisp{(+ 1 1)}"
1053 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
1054 ;; With switches.
1055 (should
1056 (org-test-with-temp-text "src_emacs-lisp[:foo bar]{(+ 1 1)}"
1057 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
1058 (should
1059 (org-test-with-temp-text "src_emacs-lisp[ :foo bar]{(+ 1 1)}"
1060 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
1061 ;; Empty switches.
1062 (should
1063 (org-test-with-temp-text "src_emacs-lisp[]{(+ 1 1)}"
1064 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
1065 ;; Invalid syntax.
1066 (should-not
1067 (org-test-with-temp-text "foosrc_emacs-lisp[]{(+ 1 1)}"
1068 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
1069 (should-not
1070 (org-test-with-temp-text "src_emacs-lisp[]foo{(+ 1 1)}"
1071 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
1072 ;; Invalid language name
1073 (should-not
1074 (org-test-with-temp-text "src_emacs-\tlisp{(+ 1 1)}"
1075 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
1076 ;; Test parsing at the beginning of an item.
1077 (should
1078 (org-test-with-temp-text "- src_emacs-lisp{(+ 1 1)}"
1079 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity))))
1082 ;;;; Inlinetask
1084 (ert-deftest test-org-element/inlinetask-parser ()
1085 "Test `inlinetask' parser."
1086 (when (featurep 'org-inlinetask)
1087 (let ((org-inlinetask-min-level 15))
1088 ;; Regular inlinetask.
1089 (should
1090 (eq 'inlinetask
1091 (org-test-with-temp-text
1092 "*************** Task\nTest\n*************** END"
1093 (org-element-type (org-element-at-point)))))
1094 ;; Degenerate inlinetask.
1095 (should
1096 (eq 'inlinetask
1097 (org-test-with-temp-text "*************** Task"
1098 (org-element-type (org-element-at-point)))))
1099 ;; Mixed inlinetasks.
1100 (should-not
1101 (org-test-with-temp-text
1103 *************** Task
1104 *************** Task2
1105 Contents
1106 *************** END"
1107 (forward-line)
1108 (goto-char (org-element-property :end (org-element-at-point)))
1109 (eobp)))
1110 ;; TODO keyword.
1111 (should
1112 (equal
1113 "TODO"
1114 (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
1115 (org-test-with-temp-text "*************** TODO Task"
1116 (org-element-property :todo-keyword (org-element-at-point))))))
1117 ;; Planning info.
1118 (should
1119 (org-test-with-temp-text "
1120 *************** Task
1121 DEADLINE: <2012-03-29 thu.>"
1122 (forward-line)
1123 (org-element-property :deadline (org-element-at-point))))
1124 ;; Priority.
1125 (should
1128 (org-test-with-temp-text "
1129 *************** [#A] Task"
1130 (forward-line)
1131 (org-element-property :priority (org-element-at-point)))))
1132 ;; Tags.
1133 (should
1134 (equal
1135 '("test")
1136 (org-test-with-temp-text "
1137 *************** Task :test:"
1138 (forward-line)
1139 (org-element-property :tags (org-element-at-point)))))
1140 ;; Regular properties are accessed through upper case keywords.
1141 (should
1142 (org-test-with-temp-text "
1143 *************** Task
1144 :PROPERTIES:
1145 :foo: bar
1146 :END:
1147 *************** END"
1148 (forward-line)
1149 (org-element-property :FOO (org-element-at-point))))
1150 (should-not
1151 (org-test-with-temp-text "
1152 *************** Task
1153 :PROPERTIES:
1154 :foo: bar
1155 :END:
1156 *************** END"
1157 (forward-line)
1158 (org-element-property :foo (org-element-at-point))))
1159 ;; Handle non-empty blank line at the end of buffer.
1160 (should
1161 (org-test-with-temp-text "*************** Task\n*************** END\n "
1162 (= (org-element-property :end (org-element-at-point)) (point-max)))))))
1165 ;;;; Italic
1167 (ert-deftest test-org-element/italic-parser ()
1168 "Test `italic' parser."
1169 ;; Regular test.
1170 (should
1171 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1172 (org-test-with-temp-text "/italic/"
1173 (org-element-map (org-element-parse-buffer) 'italic 'identity nil t))))
1174 ;; Multi-line markup.
1175 (should
1176 (equal
1177 (org-element-contents
1178 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1179 (org-test-with-temp-text "/first line\nsecond line/"
1180 (org-element-map (org-element-parse-buffer) 'italic 'identity nil t))))
1181 '("first line\nsecond line"))))
1184 ;;;; Item
1186 (ert-deftest test-org-element/item-parser ()
1187 "Test `item' parser."
1188 ;; Standard test.
1189 (should
1190 (org-test-with-temp-text "- item"
1191 (org-element-map (org-element-parse-buffer) 'item 'identity)))
1192 ;; Counter.
1193 (should
1194 (= 6
1195 (org-element-property
1196 :counter
1197 (org-test-with-temp-text "6. [@6] item"
1198 (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
1199 ;; Tag
1200 (should
1201 (equal
1202 '("tag")
1203 (org-element-property
1204 :tag
1205 (org-test-with-temp-text "- tag :: description"
1206 (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
1207 ;; No tags in ordered lists.
1208 (should-not
1209 (org-element-property
1210 :tag
1211 (org-test-with-temp-text "1. tag :: description"
1212 (org-element-map (org-element-parse-buffer) 'item 'identity nil t))))
1213 ;; Check-boxes
1214 (should
1215 (equal
1216 '(trans on off)
1217 (org-test-with-temp-text "
1218 - [-] item 1
1219 - [X] item 1.1
1220 - [ ] item 1.2"
1221 (org-element-map
1222 (org-element-parse-buffer) 'item
1223 (lambda (item) (org-element-property :checkbox item))))))
1224 ;; Item starting with special syntax.
1225 (should
1226 (equal '(("- item"))
1227 (org-test-with-temp-text "- - item"
1228 (org-element-map (org-element-parse-buffer) 'paragraph
1229 'org-element-contents))))
1230 ;; Block in an item: ignore indentation within the block.
1231 (should
1232 (org-test-with-temp-text "- item\n #+begin_src emacs-lisp\n(+ 1 1)\n #+end_src"
1233 (forward-char)
1234 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1237 ;;;; Keyword
1239 (ert-deftest test-org-element/keyword-parser ()
1240 "Test `keyword' parser."
1241 ;; Standard test.
1242 (should
1243 (org-test-with-temp-text "#+KEYWORD: value"
1244 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1245 ;; Keywords are case-insensitive.
1246 (should
1247 (org-test-with-temp-text "#+keyword: value"
1248 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1249 ;; Affiliated keywords are not keywords.
1250 (should-not
1251 (org-test-with-temp-text "#+NAME: value
1252 Paragraph"
1253 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1254 ;; Do not mix keywords with Babel calls and dynamic blocks.
1255 (should-not
1256 (org-test-with-temp-text "#+CALL: fun()"
1257 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1258 (should-not
1259 (org-test-with-temp-text "#+BEGIN: my-fun\nBody\n#+END:"
1260 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1261 ;; Handle non-empty blank line at the end of buffer.
1262 (should
1263 (org-test-with-temp-text "#+KEYWORD: value\n "
1264 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1267 ;;;; Latex Environment
1269 (ert-deftest test-org-element/latex-environment-parser ()
1270 "Test `latex-environment' parser."
1271 (should
1272 (org-test-with-temp-text "\\begin{equation}\ne^{i\\pi}+1=0\n\\end{equation}"
1273 (org-element-map (org-element-parse-buffer) 'latex-environment 'identity)))
1274 ;; Allow nested environments.
1275 (should
1276 (equal
1277 "\\begin{outer}
1278 \\begin{inner}
1279 e^{i\\pi}+1=0
1280 \\end{inner}
1281 \\end{outer}"
1282 (org-test-with-temp-text "
1283 \\begin{outer}
1284 \\begin{inner}
1285 e^{i\\pi}+1=0
1286 \\end{inner}
1287 \\end{outer}"
1288 (org-element-property
1289 :value
1290 (org-element-map
1291 (org-element-parse-buffer) 'latex-environment 'identity nil t)))))
1292 ;; Allow environments with options and arguments.
1293 (should
1294 (eq 'latex-environment
1295 (org-test-with-temp-text
1296 "\\begin{theorem}[Euler]\ne^{i\\pi}+1=0\n\\end{theorem}"
1297 (org-element-type (org-element-at-point)))))
1298 (should
1299 (eq 'latex-environment
1300 (org-test-with-temp-text "\\begin{env}{arg}\nvalue\n\\end{env}"
1301 (org-element-type (org-element-at-point)))))
1302 ;; Allow environments without newline after \begin{.}.
1303 (should
1304 (eq 'latex-environment
1305 (org-test-with-temp-text "\\begin{env}{arg}something\nvalue\n\\end{env}"
1306 (org-element-type (org-element-at-point)))))
1307 ;; Allow one-line environments.
1308 (should
1309 (eq 'latex-environment
1310 (org-test-with-temp-text "\\begin{env}{arg}something\\end{env}"
1311 (org-element-type (org-element-at-point)))))
1312 ;; Should not allow different tags.
1313 (should-not
1314 (eq 'latex-environment
1315 (org-test-with-temp-text "\\begin{env*}{arg}something\\end{env}"
1316 (org-element-type (org-element-at-point)))))
1317 ;; LaTeX environments must be on separate lines.
1318 (should-not
1319 (eq 'latex-environment
1320 (org-test-with-temp-text "\\begin{env} x \\end{env} y"
1321 (org-element-type (org-element-at-point)))))
1322 (should-not
1323 (eq 'latex-environment
1324 (org-test-with-temp-text "y \\begin{env} x<point> \\end{env}"
1325 (org-element-type (org-element-at-point)))))
1326 ;; Handle non-empty blank line at the end of buffer.
1327 (should
1328 (org-test-with-temp-text "\\begin{env}\n\\end{env}\n "
1329 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1332 ;;;; Latex Fragment
1334 (ert-deftest test-org-element/latex-fragment-parser ()
1335 "Test `latex-fragment' parser."
1336 (should
1337 (org-test-with-temp-text "$a$"
1338 (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
1339 (should
1340 (org-test-with-temp-text "$$a$$"
1341 (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
1342 (should
1343 (org-test-with-temp-text "\\(a\\)"
1344 (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
1345 (should
1346 (org-test-with-temp-text "\\[a\\]"
1347 (org-element-map
1348 (org-element-parse-buffer) 'latex-fragment 'identity)))
1349 ;; Test fragment at the beginning of an item.
1350 (should
1351 (eq 'latex-fragment
1352 (org-test-with-temp-text "- $x$"
1353 (progn (search-forward "$")
1354 (org-element-type (org-element-context)))))))
1357 ;;;; Line Break
1359 (ert-deftest test-org-element/line-break-parser ()
1360 "Test `line-break' parser."
1361 ;; Regular test.
1362 (should
1363 (org-test-with-temp-text "Text \\\\"
1364 (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
1365 ;; Line break with trailing white spaces.
1366 (should
1367 (org-test-with-temp-text "Text \\\\ "
1368 (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
1369 ;; Three backslashes are too much.
1370 (should-not
1371 (org-test-with-temp-text "Text \\\\\\"
1372 (org-element-map (org-element-parse-buffer) 'line-break 'identity))))
1375 ;;;; Link
1377 (ert-deftest test-org-element/link-parser ()
1378 "Test `link' parser."
1379 ;; Radio target.
1380 (should
1381 (equal
1382 "radio"
1383 (org-test-with-temp-text "<<<radio>>>A radio link"
1384 (org-update-radio-target-regexp)
1385 (org-element-property
1386 :type
1387 (org-element-map (org-element-parse-buffer) 'link #'identity nil t)))))
1388 ;; Standard link.
1390 ;; ... with description.
1391 (should
1392 (equal
1393 '("Orgmode.org")
1394 (org-test-with-temp-text "[[http://orgmode.org][Orgmode.org]]"
1395 (org-element-contents
1396 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1397 ;; ... without description.
1398 (should
1399 (equal
1400 "http"
1401 (org-test-with-temp-text "[[http://orgmode.org]]"
1402 (org-element-property
1403 :type
1404 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1405 ;; ... with expansion.
1406 (should
1407 (equal
1408 "//orgmode.org/worg"
1409 (org-test-with-temp-text "[[Org:worg]]"
1410 (let ((org-link-abbrev-alist '(("Org" . "http://orgmode.org/"))))
1411 (org-element-property
1412 :path
1413 (org-element-map (org-element-parse-buffer) 'link 'identity nil t))))))
1414 ;; ... with translation.
1415 (should
1416 (equal
1417 "127.0.0.1"
1418 (org-test-with-temp-text "[[http://orgmode.org]]"
1419 (flet ((link-translate (type path) (cons type "127.0.0.1")))
1420 (let ((org-link-translation-function 'link-translate))
1421 (org-element-property
1422 :path
1423 (org-element-map (org-element-parse-buffer) 'link
1424 'identity nil t)))))))
1425 ;; ... id link.
1426 (should
1427 (equal
1428 "id"
1429 (org-test-with-temp-text "[[id:aaaa]]"
1430 (org-element-property
1431 :type
1432 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1433 ;; ... custom-id link.
1434 (should
1435 (equal
1436 "custom-id"
1437 (org-test-with-temp-text "[[#some-id]]"
1438 (org-element-property
1439 :type
1440 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1441 ;; ... coderef link.
1442 (should
1443 (equal
1444 "coderef"
1445 (org-test-with-temp-text "[[(reference)]]"
1446 (org-element-property
1447 :type
1448 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1449 ;; ... fuzzy link.
1450 (should
1451 (equal
1452 "fuzzy"
1453 (org-test-with-temp-text "[[target-or-title]]"
1454 (org-element-property
1455 :type
1456 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1457 ;; ... file-type link with search option.
1458 (should
1459 (equal
1460 '(("file" "projects.org" "*task title"))
1461 (org-test-with-temp-text "[[file:projects.org::*task title]]"
1462 (org-element-map (org-element-parse-buffer) 'link
1463 (lambda (l) (list (org-element-property :type l)
1464 (org-element-property :path l)
1465 (org-element-property :search-option l)))))))
1466 ;; ... file-type link with application...
1467 (should
1468 (equal
1469 '("file" "projects.org" "docview")
1470 (org-test-with-temp-text "[[docview:projects.org]]"
1471 (let ((l (org-element-context)))
1472 (list (org-element-property :type l)
1473 (org-element-property :path l)
1474 (org-element-property :application l))))))
1475 ;; ... `:path' in a file-type link must be compatible with "file"
1476 ;; scheme in URI syntax, even if Org syntax isn't...
1477 (should
1478 (org-test-with-temp-text-in-file ""
1479 (let ((file (expand-file-name (buffer-file-name))))
1480 (insert (format "[[file://%s]]" file))
1481 (equal (org-element-property :path (org-element-context))
1482 (concat "//" file)))))
1483 (should
1484 (org-test-with-temp-text-in-file ""
1485 (let ((file (expand-file-name (buffer-file-name))))
1486 (insert (format "[[file:%s]]" file))
1487 (equal (org-element-property :path (org-element-context))
1488 (concat "//" file)))))
1489 (should
1490 (org-test-with-temp-text-in-file ""
1491 (let ((file (file-relative-name (buffer-file-name))))
1492 (insert (format "[[file:%s]]" file))
1493 (list (org-element-property :path (org-element-context)) file))))
1494 ;; ... multi-line link.
1495 (should
1496 (equal "//orgmode.org"
1497 (org-test-with-temp-text "[[http://orgmode.\norg]]"
1498 (org-element-property :path (org-element-context)))))
1499 ;; Plain link.
1500 (should
1501 (org-test-with-temp-text "A link: http://orgmode.org"
1502 (org-element-map (org-element-parse-buffer) 'link 'identity)))
1503 ;; Angular link.
1504 (should
1505 (org-test-with-temp-text "A link: <http://orgmode.org>"
1506 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))
1507 ;; Link abbreviation.
1508 (should
1509 (equal "http"
1510 (org-test-with-temp-text
1511 "#+LINK: orgmode http://www.orgmode.org/\n[[orgmode:#docs]]"
1512 (progn (org-mode-restart)
1513 (goto-char (1- (point-max)))
1514 (org-element-property :type (org-element-context))))))
1515 ;; Link abbreviation in a secondary string.
1516 (should
1517 (equal "http"
1518 (org-test-with-temp-text
1519 "#+LINK: orgmode http://www.orgmode.org/\n* H [[orgmode:#docs]]"
1520 (progn (org-mode-restart)
1521 (org-element-map (org-element-parse-buffer) 'link
1522 (lambda (link) (org-element-property :type link))
1523 nil t nil t)))))
1524 ;; Plain links are allowed as description of regular links.
1525 (should
1526 (equal "file"
1527 (org-test-with-temp-text "[[http://orgmode.org][file:unicorn.jpg]]"
1528 (search-forward "file:")
1529 (org-element-property :type (org-element-context))))))
1532 ;;;; Macro
1534 (ert-deftest test-org-element/macro-parser ()
1535 "Test `macro' parser."
1536 ;; Without arguments.
1537 (should
1538 (org-test-with-temp-text "{{{macro}}}"
1539 (org-element-map (org-element-parse-buffer) 'macro 'identity)))
1540 ;; With arguments.
1541 (should
1542 (org-test-with-temp-text "{{{macro(arg1,arg2)}}}"
1543 (org-element-map (org-element-parse-buffer) 'macro 'identity)))
1544 ;; Properly handle protected commas in arguments...
1545 (should
1546 (= 2
1547 (length
1548 (org-test-with-temp-text "{{{macro(arg1\\,arg1,arg2)}}}"
1549 (org-element-property :args (org-element-context))))))
1550 ;; ... even when last argument ends with a protected comma.
1551 (should
1552 (equal '("C-,")
1553 (org-test-with-temp-text "{{{macro(C-\\,)}}}"
1554 (org-element-property :args (org-element-context)))))
1555 ;; Allow to escape escaping character.
1556 (should
1557 (equal '("C-\\" "")
1558 (org-test-with-temp-text "{{{macro(C-\\\\,)}}}"
1559 (org-element-property :args (org-element-context)))))
1560 ;; No need to escape backslashes elsewhere.
1561 (should
1562 (equal '("\\")
1563 (org-test-with-temp-text "{{{macro(\\)}}}"
1564 (org-element-property :args (org-element-context))))))
1567 ;;;; Node Property
1569 (ert-deftest test-org-element/node-property ()
1570 "Test `node-property' parser."
1571 ;; Standard test.
1572 (should
1573 (equal '("abc" "value")
1574 (org-test-with-temp-text ":PROPERTIES:\n:abc: value\n:END:"
1575 (progn (forward-line)
1576 (let ((element (org-element-at-point)))
1577 (list (org-element-property :key element)
1578 (org-element-property :value element)))))))
1579 ;; Value should be trimmed.
1580 (should
1581 (equal "value"
1582 (org-test-with-temp-text ":PROPERTIES:\n:abc: value \n:END:"
1583 (progn (forward-line)
1584 (let ((element (org-element-at-point)))
1585 (org-element-property :value element))))))
1586 ;; A node property requires to be wrapped within a property drawer.
1587 (should-not
1588 (eq 'node-property
1589 (org-test-with-temp-text ":abc: value"
1590 (org-element-type (org-element-at-point))))))
1593 ;;;; Paragraph
1595 (ert-deftest test-org-element/paragraph-parser ()
1596 "Test `paragraph' parser."
1597 ;; Standard test.
1598 (should
1599 (org-test-with-temp-text "Paragraph"
1600 (org-element-map (org-element-parse-buffer) 'paragraph 'identity nil t)))
1601 ;; Property find end of a paragraph stuck to another element.
1602 (should
1603 (eq ?#
1604 (org-test-with-temp-text "Paragraph\n# Comment"
1605 (org-element-map (org-element-parse-buffer) 'paragraph
1606 (lambda (p) (char-after (org-element-property :end p)))
1607 nil t))))
1608 ;; Include ill-formed Keywords.
1609 (should
1610 (org-test-with-temp-text "#+wrong_keyword something"
1611 (org-element-map (org-element-parse-buffer) 'paragraph 'identity)))
1612 ;; Include incomplete-drawers.
1613 (should
1614 (org-test-with-temp-text ":TEST:\nParagraph"
1615 (let ((elem (org-element-at-point)))
1616 (and (eq (org-element-type elem) 'paragraph)
1617 (= (point-max) (org-element-property :end elem))))))
1618 ;; Include incomplete blocks.
1619 (should
1620 (org-test-with-temp-text "#+BEGIN_CENTER\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 dynamic blocks.
1625 (should
1626 (org-test-with-temp-text "#+BEGIN: \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 latex environments.
1631 (should
1632 (org-test-with-temp-text "\begin{equation}\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 ;; Do not steal affiliated keywords from container.
1637 (should
1638 (org-test-with-temp-text "#+ATTR_LATEX: test\n- item 1"
1639 (let ((elem (progn (search-forward "item") (org-element-at-point))))
1640 (and (eq (org-element-type elem) 'paragraph)
1641 (not (org-element-property :attr_latex elem))
1642 (/= (org-element-property :begin elem) 1)))))
1643 ;; Handle non-empty blank line at the end of buffer.
1644 (should
1645 (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
1646 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1649 ;;;; Plain List
1651 (ert-deftest test-org-element/plain-list-parser ()
1652 "Test `plain-list' parser."
1653 (org-test-with-temp-text "- item"
1654 (should (org-element-map (org-element-parse-buffer) 'plain-list 'identity)))
1655 ;; Blank lines after the list only belong to outer plain list.
1656 (should
1657 (equal
1658 '(t t)
1659 (org-test-with-temp-text "
1660 - outer
1661 - inner
1663 Outside list"
1664 (let ((endings (org-element-map (org-element-parse-buffer) 'plain-list
1665 (lambda (pl) (org-element-property :end pl)))))
1666 (list
1667 ;; Move to ending of outer list.
1668 (progn (goto-char (car endings)) (looking-at "Outside list"))
1669 ;; Move to ending of inner list.
1670 (progn (goto-char (nth 1 endings)) (looking-at "^$")))))))
1671 ;; Correctly compute end of list if it doesn't end at a line
1672 ;; beginning.
1673 (should
1674 (org-test-with-temp-text "- list\n \n "
1675 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1678 ;;;; Planning
1680 (ert-deftest test-org-element/planning-parser ()
1681 "Test `planning' parser."
1682 (should
1683 (equal "[2012-03-29 thu.]"
1684 (org-element-property
1685 :raw-value
1686 (org-element-property
1687 :closed
1688 (org-test-with-temp-text "CLOSED: [2012-03-29 thu.]"
1689 (org-element-at-point))))))
1690 (should
1691 (equal "<2012-03-29 thu.>"
1692 (org-element-property
1693 :raw-value
1694 (org-element-property
1695 :deadline
1696 (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>"
1697 (org-element-at-point))))))
1698 (should
1699 (equal "<2012-03-29 thu.>"
1700 (org-element-property
1701 :raw-value
1702 (org-element-property
1703 :scheduled
1704 (org-test-with-temp-text "SCHEDULED: <2012-03-29 thu.>"
1705 (org-element-at-point)))))))
1708 ;;;; Property Drawer
1710 (ert-deftest test-org-element/property-drawer-parser ()
1711 "Test `property-drawer' parser."
1712 ;; Standard test.
1713 (should
1714 (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
1715 (org-element-map
1716 (org-element-parse-buffer) 'property-drawer 'identity nil t)))
1717 ;; Do not mix property drawers and regular drawers.
1718 (should-not
1719 (org-test-with-temp-text ":TEST:\n:prop: value\n:END:"
1720 (org-element-map
1721 (org-element-parse-buffer) 'property-drawer 'identity nil t)))
1722 ;; Ignore incomplete drawer.
1723 (should-not
1724 (org-test-with-temp-text ":PROPERTIES:\n:prop: value"
1725 (org-element-map
1726 (org-element-parse-buffer) 'property-drawer 'identity nil t)))
1727 ;; Handle non-empty blank line at the end of buffer.
1728 (should
1729 (org-test-with-temp-text ":PROPERTIES:\n:END:\n "
1730 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1733 ;;;; Quote Block
1735 (ert-deftest test-org-element/quote-block-parser ()
1736 "Test `quote-block' parser."
1737 ;; Regular test.
1738 (should
1739 (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
1740 (org-element-map (org-element-parse-buffer) 'quote-block 'identity)))
1741 ;; Ignore incomplete block.
1742 (should-not
1743 (org-test-with-temp-text "#+BEGIN_QUOTE"
1744 (org-element-map (org-element-parse-buffer) 'quote-block 'identity nil t)))
1745 ;; Handle non-empty blank line at the end of buffer.
1746 (should
1747 (org-test-with-temp-text "#+BEGIN_QUOTE\nC\n#+END_QUOTE\n "
1748 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1751 ;;;; Radio Target
1753 (ert-deftest test-org-element/radio-target-parser ()
1754 "Test `radio-target' parser."
1755 ;; Standard test.
1756 (should
1757 (eq 'radio-target
1758 (org-test-with-temp-text "<<<radio>>>"
1759 (org-element-type (org-element-context)))))
1760 ;; Radio targets with objects.
1761 (should
1762 (eq 'radio-target
1763 (org-test-with-temp-text "<<<radio \\alpha>>>"
1764 (org-element-type (org-element-context)))))
1765 ;; Radio targets starting with an object.
1766 (should
1767 (eq 'radio-target
1768 (org-test-with-temp-text "<<<\\alpha radio>>>"
1769 (org-element-type (org-element-context)))))
1770 ;; Radio targets cannot begin or end with white space.
1771 (should-not
1772 (eq 'radio-target
1773 (org-test-with-temp-text "<<< radio>>>"
1774 (org-element-type (org-element-context)))))
1775 (should-not
1776 (eq 'radio-target
1777 (org-test-with-temp-text "<<<radio >>>"
1778 (org-element-type (org-element-context))))))
1781 ;;;; Section
1783 (ert-deftest test-org-element/section-parser ()
1784 "Test `section' parser."
1785 ;; Standard test.
1786 (should
1787 (org-test-with-temp-text "* Headline\nText"
1788 (org-element-map (org-element-parse-buffer) 'section 'identity)))
1789 ;; There's a section before the first headline.
1790 (should
1791 (org-test-with-temp-text "Text"
1792 (org-element-map (org-element-parse-buffer) 'section 'identity)))
1793 ;; A section cannot be empty.
1794 (should-not
1795 (org-test-with-temp-text "* Headline 1\n* Headline 2"
1796 (org-element-map (org-element-parse-buffer) 'section 'identity)))
1797 ;; A section doesn't contain sub-trees.
1798 (should-not
1799 (org-test-with-temp-text "* Head\nText\n** Sub-Head"
1800 (org-element-map
1801 (org-element-map (org-element-parse-buffer) 'section 'identity nil t)
1802 'headline 'identity))))
1805 ;;;; Special Block
1807 (ert-deftest test-org-element/special-block-parser ()
1808 "Test `special-block' parser."
1809 ;; Standard test.
1810 (should
1811 (equal "SPECIAL"
1812 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1813 (org-element-property :type (org-element-at-point)))))
1814 ;; Special blocks can contain paragraphs.
1815 (should
1816 (eq 'paragraph
1817 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1818 (forward-line)
1819 (org-element-type (org-element-at-point)))))
1820 ;; Ignore incomplete block.
1821 (should-not
1822 (eq 'special-block
1823 (org-test-with-temp-text "#+BEGIN_SPECIAL"
1824 (org-element-type (org-element-at-point)))))
1825 ;; Allow special characters in type.
1826 (should
1827 (equal '(special-block "SPECIAL*")
1828 (org-test-with-temp-text "#+BEGIN_SPECIAL*\nContents\n#+END_SPECIAL*"
1829 (let ((element (org-element-at-point)))
1830 (list (org-element-type element)
1831 (org-element-property :type element))))))
1832 ;; Handle non-empty blank line at the end of buffer.
1833 (should
1834 (org-test-with-temp-text "#+BEGIN_SPECIAL\nC\n#+END_SPECIAL\n "
1835 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1838 ;;;; Src Block
1840 (ert-deftest test-org-element/src-block-parser ()
1841 "Test `src-block' parser."
1842 ;; Regular tests.
1843 (should
1844 (org-test-with-temp-text "#+BEGIN_SRC org\nText\n#+END_SRC"
1845 (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
1846 ;; Ignore incomplete block.
1847 (should-not
1848 (org-test-with-temp-text "#+BEGIN_SRC"
1849 (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
1850 ;; Properly un-escape code.
1851 (should
1852 (equal "* Headline\n #+keyword\nText\n"
1853 (org-test-with-temp-text
1854 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText\n#+END_SRC"
1855 (org-element-property :value (org-element-at-point)))))
1856 ;; Remove block indentation according to block boundaries, unless
1857 ;; block contents are less indented than block boundaries.
1858 (should
1859 (equal " L1\nL2\n"
1860 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
1861 (let ((org-src-preserve-indentation t))
1862 (org-element-property :value (org-element-at-point))))))
1863 (should
1864 (equal
1865 " L1\n L2\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 ;; Handle non-empty blank line at the end of buffer.
1870 (should
1871 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\nC\n#+END_SRC\n "
1872 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1875 ;;;; Statistics Cookie
1877 (ert-deftest test-org-element/statistics-cookie ()
1878 "Test `statistics-cookie' parser."
1879 ;; With numbers.
1880 (should
1881 (org-test-with-temp-text "[1/2]"
1882 (org-element-map (org-element-parse-buffer) 'statistics-cookie 'identity)))
1883 ;; With percents.
1884 (should
1885 (org-test-with-temp-text "[33%]"
1886 (org-element-map
1887 (org-element-parse-buffer) 'statistics-cookie 'identity))))
1890 ;;;; Strike Through
1892 (ert-deftest test-org-element/strike-through-parser ()
1893 "Test `strike-through' parser."
1894 ;; Regular test.
1895 (should
1896 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1897 (org-test-with-temp-text "+strike-through+"
1898 (org-element-map (org-element-parse-buffer) 'strike-through 'identity))))
1899 ;; Multi-line markup.
1900 (should
1901 (equal
1902 (org-element-contents
1903 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1904 (org-test-with-temp-text "+first line\nsecond line+"
1905 (org-element-map
1906 (org-element-parse-buffer) 'strike-through 'identity nil t))))
1907 '("first line\nsecond line"))))
1910 ;;;; Subscript
1912 (ert-deftest test-org-element/subscript-parser ()
1913 "Test `subscript' parser."
1914 ;; Without braces.
1915 (should
1916 (org-test-with-temp-text "a_b"
1917 (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
1918 ;; With braces.
1919 (should
1920 (org-test-with-temp-text "a_{b}"
1921 (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
1922 ;; Multiple subscripts in a paragraph.
1923 (should
1924 (= 2
1925 (org-test-with-temp-text "a_b and c_d"
1926 (length
1927 (org-element-map (org-element-parse-buffer) 'subscript 'identity))))))
1930 ;;;; Superscript
1932 (ert-deftest test-org-element/superscript-parser ()
1933 "Test `superscript' parser."
1934 ;; Without braces.
1935 (should
1936 (org-test-with-temp-text "a^b"
1937 (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
1938 ;; With braces.
1939 (should
1940 (org-test-with-temp-text "a^{b}"
1941 (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
1942 ;; Multiple superscript in a paragraph.
1943 (should
1944 (= 2
1945 (org-test-with-temp-text "a^b and c^d"
1946 (length
1947 (org-element-map
1948 (org-element-parse-buffer) 'superscript 'identity))))))
1951 ;;;; Table
1953 (ert-deftest test-org-element/table-parser ()
1954 "Test `table' parser."
1955 (should
1956 (org-test-with-temp-text "| a |"
1957 (org-element-map (org-element-parse-buffer) 'table 'identity)))
1958 ;; TBLFM keyword is case insensitive.
1959 (should
1960 (org-test-with-temp-text "| a |\n#+tblfm: test"
1961 (org-element-property
1962 :tblfm
1963 (org-element-map (org-element-parse-buffer) 'table 'identity nil t))))
1964 ;; Handle multiple TBLFM lines.
1965 (should
1966 (= 2
1967 (org-test-with-temp-text "| a |\n#+TBLFM: test1\n#+TBLFM: test2"
1968 (length (org-element-property
1969 :tblfm
1970 (org-element-map
1971 (org-element-parse-buffer) 'table 'identity nil t))))))
1972 ;; Handle non-empty blank line at the end of buffer.
1973 (should
1974 (org-test-with-temp-text "| a |\n "
1975 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1978 ;;;; Table Cell
1980 (ert-deftest test-org-element/table-cell-parser ()
1981 "Test `table-cell' parser."
1982 ;; Regular table cell.
1983 (should
1984 (org-test-with-temp-text "| a |"
1985 (org-element-map (org-element-parse-buffer) 'table-cell 'identity)))
1986 ;; Last vertical bar may be omitted.
1987 (should
1988 (org-test-with-temp-text "| a "
1989 (org-element-map (org-element-parse-buffer) 'table-cell 'identity))))
1992 ;;;; Table Row
1994 (ert-deftest test-org-element/table-row-parser ()
1995 "Test `table-row' parser."
1996 (should
1997 (equal '(standard rule)
1998 (org-test-with-temp-text "| a |\n|---|"
1999 (org-element-map
2000 (org-element-parse-buffer) 'table-row
2001 (lambda (row) (org-element-property :type row)))))))
2004 ;;;; Target
2006 (ert-deftest test-org-element/target-parser ()
2007 "Test `target' parser."
2008 (should
2009 (org-test-with-temp-text "<<target>>"
2010 (org-element-map (org-element-parse-buffer) 'target 'identity))))
2013 ;;;; Timestamp
2015 (ert-deftest test-org-element/timestamp ()
2016 "Test `timestamp' parser."
2017 ;; Active timestamp.
2018 (should
2019 (org-test-with-temp-text "<2012-03-29 16:40>"
2020 (eq (org-element-property :type (org-element-context)) 'active)))
2021 (should-not
2022 (org-test-with-temp-text "<2012-03-29 Thu>"
2023 (let ((timestamp (org-element-context)))
2024 (or (org-element-property :hour-start timestamp)
2025 (org-element-property :minute-start timestamp)))))
2026 (should
2027 (equal '(2012 3 29 16 40)
2028 (org-test-with-temp-text "<2012-03-29 Thu 16:40>"
2029 (let ((object (org-element-context)))
2030 (list (org-element-property :year-start object)
2031 (org-element-property :month-start object)
2032 (org-element-property :day-start object)
2033 (org-element-property :hour-start object)
2034 (org-element-property :minute-start object))))))
2035 ;; Inactive timestamp.
2036 (should
2037 (org-test-with-temp-text "[2012-03-29 Thu 16:40]"
2038 (eq (org-element-property :type (org-element-context)) 'inactive)))
2039 ;; Time range.
2040 (should
2041 (equal '(2012 3 29 16 40 7 30)
2042 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
2043 (let ((object (org-element-context)))
2044 (list (org-element-property :year-end object)
2045 (org-element-property :month-end object)
2046 (org-element-property :day-end object)
2047 (org-element-property :hour-end object)
2048 (org-element-property :minute-end object)
2049 (org-element-property :hour-start object)
2050 (org-element-property :minute-start object))))))
2051 (should
2052 (eq 'active-range
2053 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
2054 (org-element-property :type (org-element-context)))))
2055 ;; Date range.
2056 (should
2057 (org-test-with-temp-text "[2012-03-29 Thu 16:40]--[2012-03-29 Thu 16:41]"
2058 (eq (org-element-property :type (org-element-context)) 'inactive-range)))
2059 (should-not
2060 (org-test-with-temp-text "[2011-07-14 Thu]--[2012-03-29 Thu]"
2061 (let ((timestamp (org-element-context)))
2062 (or (org-element-property :hour-end timestamp)
2063 (org-element-property :minute-end timestamp)))))
2064 ;; With repeater, warning delay and both.
2065 (should
2066 (eq 'catch-up
2067 (org-test-with-temp-text "<2012-03-29 Thu ++1y>"
2068 (org-element-property :repeater-type (org-element-context)))))
2069 (should
2070 (eq 'first
2071 (org-test-with-temp-text "<2012-03-29 Thu --1y>"
2072 (org-element-property :warning-type (org-element-context)))))
2073 (should
2074 (equal '(cumulate all)
2075 (org-test-with-temp-text "<2012-03-29 Thu +1y -1y>"
2076 (let ((ts (org-element-context)))
2077 (list (org-element-property :repeater-type ts)
2078 (org-element-property :warning-type ts))))))
2079 ;; Timestamps are not planning elements.
2080 (should-not
2081 (org-test-with-temp-text "SCHEDULED: <2012-03-29 Thu 16:40>"
2082 (org-element-map (org-element-parse-buffer) 'timestamp 'identity))))
2085 ;;;; Underline
2087 (ert-deftest test-org-element/underline-parser ()
2088 "Test `underline' parser."
2089 ;; Regular test.
2090 (should
2091 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2092 (org-test-with-temp-text "_underline_"
2093 (org-element-map (org-element-parse-buffer) 'underline 'identity))))
2094 ;; Multi-line markup.
2095 (should
2096 (equal
2097 (org-element-contents
2098 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2099 (org-test-with-temp-text "_first line\nsecond line_"
2100 (org-element-map
2101 (org-element-parse-buffer) 'underline 'identity nil t))))
2102 '("first line\nsecond line"))))
2105 ;;;; Verbatim
2107 (ert-deftest test-org-element/verbatim-parser ()
2108 "Test `verbatim' parser."
2109 ;; Regular test.
2110 (should
2111 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2112 (org-test-with-temp-text "=verbatim="
2113 (org-element-map (org-element-parse-buffer) 'verbatim 'identity))))
2114 ;; Multi-line markup.
2115 (should
2116 (equal
2117 (org-element-property
2118 :value
2119 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2120 (org-test-with-temp-text "=first line\nsecond line="
2121 (org-element-map
2122 (org-element-parse-buffer) 'verbatim 'identity nil t))))
2123 "first line\nsecond line")))
2126 ;;;; Verse Block
2128 (ert-deftest test-org-element/verse-block-parser ()
2129 "Test `verse-block' parser."
2130 ;; Standard test.
2131 (should
2132 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
2133 (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
2134 ;; Ignore case.
2135 (should
2136 (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
2137 (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
2138 ;; Parse objects in verse blocks.
2139 (should
2140 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
2141 (org-element-map (org-element-parse-buffer) 'entity 'identity)))
2142 ;; Ignore incomplete verse block.
2143 (should-not
2144 (org-test-with-temp-text "#+BEGIN_VERSE"
2145 (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)))
2146 ;; Handle non-empty blank line at the end of buffer.
2147 (should
2148 (org-test-with-temp-text "#+BEGIN_VERSE\nC\n#+END_VERSE\n "
2149 (= (org-element-property :end (org-element-at-point)) (point-max)))))
2153 ;;; Test Interpreters.
2155 (ert-deftest test-org-element/interpret-data ()
2156 "Test `org-element-interpret-data' specifications."
2157 ;; Interpret simple affiliated keywords.
2158 (should
2159 (equal
2160 (org-element-interpret-data
2161 '(org-data nil (paragraph (:name "para") "Paragraph")))
2162 "#+NAME: para\nParagraph\n"))
2163 ;; Interpret multiple affiliated keywords.
2164 (should
2165 (equal
2166 (org-element-interpret-data
2167 '(org-data nil (paragraph (:attr_ascii ("line2" "line1")) "Paragraph")))
2168 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
2169 ;; Interpret parsed affiliated keywords.
2170 (should
2171 (equal
2172 (org-element-interpret-data
2173 '(org-data nil (paragraph (:caption (("caption"))) "Paragraph")))
2174 "#+CAPTION: caption\nParagraph\n"))
2175 ;; Interpret dual affiliated keywords.
2176 (should
2177 (equal
2178 (org-element-interpret-data
2179 '(org-data nil (paragraph (:caption ((("long") "short"))) "Paragraph")))
2180 "#+CAPTION[short]: long\nParagraph\n"))
2181 ;; Interpret multiple parsed dual keywords.
2182 (should
2183 (equal
2184 (org-element-interpret-data
2185 '(org-data nil (paragraph
2186 (:caption ((("l2") "s2") (("l1") "s1"))) "Paragraph")))
2187 "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph\n"))
2188 ;; Pseudo objects and elements are transparent.
2189 (should
2190 (equal "A B\n"
2191 (org-element-interpret-data
2192 '(paragraph nil (pseudo-object (:post-blank 1) "A") "B")
2193 '(pseudo-object))))
2194 (should
2195 (equal "A\n\nB\n"
2196 (org-element-interpret-data
2197 '(center nil
2198 (pseudo-element (:post-blank 1) (paragraph nil "A"))
2199 (paragraph nil "B"))))))
2201 (ert-deftest test-org-element/center-block-interpreter ()
2202 "Test center block interpreter."
2203 (should
2204 (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
2205 "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
2207 (ert-deftest test-org-element/drawer-interpreter ()
2208 "Test drawer interpreter."
2209 (should
2210 (equal (org-test-parse-and-interpret ":TEST:\nTest\n:END:")
2211 ":TEST:\nTest\n:END:\n")))
2213 (ert-deftest test-org-element/dynamic-block-interpreter ()
2214 "Test dynamic block interpreter."
2215 (should
2216 (equal (org-test-parse-and-interpret
2217 "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
2218 "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
2220 (ert-deftest test-org-element/footnote-definition-interpreter ()
2221 "Test footnote definition interpreter."
2222 (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
2224 (ert-deftest test-org-element/headline-interpreter ()
2225 "Test headline and section interpreters."
2226 ;; 1. Standard test.
2227 (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
2228 ;; 2. With TODO keywords.
2229 (should
2230 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2231 (org-test-parse-and-interpret "* TODO Headline"))
2232 "* TODO Headline\n"))
2233 ;; 3. With tags...
2235 ;; 3.1. ... and a positive `org-tags-column' value.
2236 (should
2237 (equal (let ((org-tags-column 20))
2238 (org-test-parse-and-interpret "* Headline :tag:"))
2239 "* Headline :tag:\n"))
2240 ;; 3.2. ... and a negative `org-tags-column' value.
2241 (should
2242 (equal (let ((org-tags-column -20))
2243 (org-test-parse-and-interpret "* Headline :tag:"))
2244 "* Headline :tag:\n"))
2245 ;; 3.3. ... and a null `org-tags-column' value.
2246 (should
2247 (equal (let ((org-tags-column 0))
2248 (org-test-parse-and-interpret "* Headline :tag:"))
2249 "* Headline :tag:\n"))
2250 ;; 4. With priority cookie.
2251 (should
2252 (equal (org-test-parse-and-interpret "* [#B] Headline")
2253 "* [#B] Headline\n"))
2254 ;; 5. With comment keyword.
2255 (should
2256 (equal (let ((org-comment-string "COMMENT"))
2257 (org-test-parse-and-interpret "* COMMENT Headline"))
2258 "* COMMENT Headline\n"))
2259 ;; 6. Keep same number of blank lines before body.
2260 (should
2261 (equal (org-test-parse-and-interpret
2262 "* Headline\n\n\nText after two blank lines.")
2263 "* Headline\n\n\nText after two blank lines.\n"))
2264 ;; 8. Preserve `org-odd-levels-only' state.
2265 (should
2266 (equal "* H\n*** H2\n"
2267 (let ((org-odd-levels-only t))
2268 (org-test-parse-and-interpret "* H\n*** H2")))))
2270 (ert-deftest test-org-element/inlinetask-interpreter ()
2271 "Test inlinetask interpretation."
2272 (when (featurep 'org-inlinetask)
2273 (let ((org-inlinetask-min-level 15))
2274 ;; 1. Regular inlinetask.
2275 (should (equal (org-test-parse-and-interpret
2276 "*************** Task\nTest\n*************** END")
2277 "*************** Task\nTest\n*************** END\n"))
2278 ;; 2. Degenerate inlinetask.
2279 (should (equal (org-test-parse-and-interpret "*************** Task")
2280 "*************** Task\n"))
2281 ;; 3. Prefer degenerate form when there are no contents.
2282 (should (equal (org-test-parse-and-interpret
2283 "*************** Task\n*************** END")
2284 "*************** Task\n"))
2285 ;; 4. With TODO keywords.
2286 (should
2287 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2288 (org-test-parse-and-interpret "*************** TODO Task"))
2289 "*************** TODO Task\n"))
2290 ;; 5. With tags...
2292 ;; 5.1. ... and a positive `org-tags-column' value.
2293 (should
2294 (equal (let ((org-tags-column 30))
2295 (org-test-parse-and-interpret "*************** Task :tag:"))
2296 "*************** Task :tag:\n"))
2297 ;; 5.2. ... and a negative `org-tags-column' value.
2298 (should
2299 (equal (let ((org-tags-column -30))
2300 (org-test-parse-and-interpret "*************** Task :tag:"))
2301 "*************** Task :tag:\n"))
2302 ;; 5.3. ... and a null `org-tags-column' value.
2303 (should
2304 (equal (let ((org-tags-column 0))
2305 (org-test-parse-and-interpret "*************** Task :tag:"))
2306 "*************** Task :tag:\n"))
2307 ;; 6. With priority cookie.
2308 (should
2309 (equal (org-test-parse-and-interpret "*************** [#B] Task")
2310 "*************** [#B] Task\n")))))
2312 (ert-deftest test-org-element/plain-list-interpreter ()
2313 "Test plain-list and item interpreters."
2314 (let ((org-list-two-spaces-after-bullet-regexp nil))
2315 ;; Unordered list.
2316 (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
2317 ;; Description list.
2318 (should
2319 (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
2320 ;; Ordered list.
2321 (should
2322 (equal (let ((org-plain-list-ordered-item-terminator t))
2323 (org-test-parse-and-interpret "1. Item"))
2324 "1. Item\n"))
2325 (should
2326 (equal (let ((org-plain-list-ordered-item-terminator ?\)))
2327 (org-test-parse-and-interpret "1) Item"))
2328 "1) Item\n"))
2329 ;; Ordered list with counter.
2330 (should
2331 (equal (let ((org-plain-list-ordered-item-terminator t))
2332 (org-test-parse-and-interpret "1. [@5] Item"))
2333 "5. [@5] Item\n"))
2334 ;; List with check-boxes.
2335 (should
2336 (equal (org-test-parse-and-interpret
2337 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
2338 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n"))
2339 ;; Item not starting with a paragraph.
2340 (should
2341 (equal (org-test-parse-and-interpret "-\n | a | b |")
2342 "- \n | a | b |\n"))
2343 ;; Special case: correctly handle "*" bullets.
2344 (should (org-test-parse-and-interpret " * item"))
2345 ;; Special case: correctly handle empty items.
2346 (should (org-test-parse-and-interpret "-"))))
2348 (ert-deftest test-org-element/quote-block-interpreter ()
2349 "Test quote block interpreter."
2350 (should (equal (org-test-parse-and-interpret
2351 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
2352 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
2354 (ert-deftest test-org-element/special-block-interpreter ()
2355 "Test special block interpreter."
2356 (should (equal (org-test-parse-and-interpret
2357 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
2358 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
2360 (ert-deftest test-org-element/babel-call-interpreter ()
2361 "Test babel call interpreter."
2362 ;; 1. Without argument.
2363 (should (equal (org-test-parse-and-interpret "#+CALL: test()")
2364 "#+CALL: test()\n"))
2365 ;; 2. With argument.
2366 (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
2367 "#+CALL: test(x=2)\n"))
2368 ;; 3. With header arguments.
2369 (should (equal (org-test-parse-and-interpret
2370 "#+CALL: test[:results output]()[:results html]")
2371 "#+CALL: test[:results output]()[:results html]\n")))
2373 (ert-deftest test-org-element/clock-interpreter ()
2374 "Test clock interpreter."
2375 ;; Running clock.
2376 (should
2377 (string-match
2378 "CLOCK: \\[2012-01-01 .* 00:01\\]"
2379 (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]")))
2380 ;; Closed clock.
2381 (should
2382 (string-match
2383 "CLOCK: \\[2012-01-01 .* 00:01\\]--\\[2012-01-01 .* 00:02\\] => 0:01"
2384 (org-test-parse-and-interpret "
2385 CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))))
2387 (ert-deftest test-org-element/comment-interpreter ()
2388 "Test comment interpreter."
2389 ;; Regular comment.
2390 (should (equal (org-test-parse-and-interpret "# Comment") "# Comment\n"))
2391 ;; Inline comment.
2392 (should (equal (org-test-parse-and-interpret " # Comment")
2393 "# Comment\n"))
2394 ;; Preserve indentation.
2395 (should (equal (org-test-parse-and-interpret " # No blank\n# One blank")
2396 "# No blank\n# One blank\n")))
2398 (ert-deftest test-org-element/comment-block-interpreter ()
2399 "Test comment block interpreter."
2400 (should (equal (org-test-parse-and-interpret
2401 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
2402 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n"))
2403 ;; Accept missing final newline in value.
2404 (should
2405 (equal
2406 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n"
2407 (org-element-interpret-data '(comment-block (:value "Test"))))))
2409 (ert-deftest test-org-element/diary-sexp ()
2410 "Test diary-sexp interpreter."
2411 (should
2412 (equal
2413 (org-test-parse-and-interpret
2414 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old")
2415 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old\n")))
2417 (ert-deftest test-org-element/example-block-interpreter ()
2418 "Test example block interpreter."
2419 ;; Without switches.
2420 (should (equal (org-test-parse-and-interpret
2421 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
2422 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
2423 ;; With switches.
2424 (should
2425 (equal (org-test-parse-and-interpret
2426 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
2427 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n"))
2428 ;; Preserve code escaping.
2429 (should
2430 (equal (org-test-parse-and-interpret
2431 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE")
2432 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE\n"))
2433 ;; Accept missing final newline in value.
2434 (should
2435 (equal
2436 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"
2437 (org-element-interpret-data '(example-block (:value "Test"))))))
2439 (ert-deftest test-org-element/fixed-width-interpreter ()
2440 "Test fixed width interpreter."
2441 ;; Standard test.
2442 (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
2443 ;; Preserve indentation.
2444 (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
2445 ": 2 blanks\n: 1 blank\n"))
2446 ;; Remove last newline character
2447 (should
2448 (equal (org-element-fixed-width-interpreter
2449 '(fixed-width (:value "Test\n")) nil)
2450 ": Test"))
2451 (should
2452 (equal (org-element-fixed-width-interpreter
2453 '(fixed-width (:value "Test")) nil)
2454 ": Test"))
2455 ;; Handle empty string.
2456 (should
2457 (equal (org-element-fixed-width-interpreter
2458 '(fixed-width (:value "")) nil)
2459 ""))
2460 ;; Handle nil value.
2461 (should-not
2462 (org-element-fixed-width-interpreter
2463 '(fixed-width (:value nil)) nil)))
2465 (ert-deftest test-org-element/horizontal-rule-interpreter ()
2466 "Test horizontal rule interpreter."
2467 (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
2469 (ert-deftest test-org-element/keyword-interpreter ()
2470 "Test keyword interpreter."
2471 (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
2472 "#+KEYWORD: value\n")))
2474 (ert-deftest test-org-element/latex-environment-interpreter ()
2475 "Test latex environment interpreter."
2476 (should (equal (org-test-parse-and-interpret
2477 "\\begin{equation}\n1+1=2\n\\end{equation}")
2478 "\\begin{equation}\n1+1=2\n\\end{equation}\n"))
2479 (should (equal (org-test-parse-and-interpret
2480 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}")
2481 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}\n")))
2483 (ert-deftest test-org-element/planning-interpreter ()
2484 "Test planning interpreter."
2485 (should
2486 (string-match
2487 "\\* Headline
2488 DEADLINE: <2012-03-29 .*?> SCHEDULED: <2012-03-29 .*?> CLOSED: \\[2012-03-29 .*?\\]"
2489 (org-test-parse-and-interpret
2490 "* Headline
2491 DEADLINE: <2012-03-29 thu.> SCHEDULED: <2012-03-29 thu.> CLOSED: [2012-03-29 thu.]"))))
2493 (ert-deftest test-org-element/property-drawer-interpreter ()
2494 "Test property drawer interpreter."
2495 (should (equal (let ((org-property-format "%-10s %s"))
2496 (org-test-parse-and-interpret
2497 ":PROPERTIES:\n:prop: value\n:END:"))
2498 ":PROPERTIES:\n:prop: value\n:END:\n")))
2500 (ert-deftest test-org-element/src-block-interpreter ()
2501 "Test src block interpreter."
2502 ;; With arguments.
2503 (should
2504 (equal (let ((org-edit-src-content-indentation 2))
2505 (org-test-parse-and-interpret
2506 "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC"))
2507 "#+BEGIN_SRC emacs-lisp :results silent\n (+ 1 1)\n#+END_SRC\n"))
2508 ;; With switches.
2509 (should
2510 (equal (let ((org-edit-src-content-indentation 2))
2511 (org-test-parse-and-interpret
2512 "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC"))
2513 "#+BEGIN_SRC emacs-lisp -n -k\n (+ 1 1)\n#+END_SRC\n"))
2514 ;; Preserve code escaping.
2515 (should
2516 (equal (let ((org-edit-src-content-indentation 2))
2517 (org-test-parse-and-interpret
2518 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC"))
2519 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC\n"))
2520 ;; Do not apply `org-edit-src-content-indentation' when preserving
2521 ;; indentation.
2522 (should
2523 (equal (let ((org-edit-src-content-indentation 2)
2524 (org-src-preserve-indentation t))
2525 (org-test-parse-and-interpret
2526 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"))
2527 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n"))
2528 (should
2529 (equal (let ((org-edit-src-content-indentation 2)
2530 (org-src-preserve-indentation nil))
2531 (org-test-parse-and-interpret
2532 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"))
2533 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC\n"))
2534 ;; Accept missing final newline in value.
2535 (should
2536 (equal
2537 "#+BEGIN_SRC emacs-lisp\n Test\n#+END_SRC\n"
2538 (let ((org-edit-src-content-indentation 2))
2539 (org-element-interpret-data
2540 '(src-block (:language "emacs-lisp" :value "Test")))))))
2542 (ert-deftest test-org-element/table-interpreter ()
2543 "Test table, table-row and table-cell interpreters."
2544 ;; 1. Simple table.
2545 (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
2546 "| a | b |\n| c | d |\n"))
2547 ;; 2. With horizontal rules.
2548 (should (equal (org-test-parse-and-interpret
2549 "| a | b |\n|---+---|\n| c | d |")
2550 "| a | b |\n|---+---|\n| c | d |\n"))
2551 ;; 3. With meta-data.
2552 (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
2553 "| / | < | > |\n| * | 1 | 2 |\n"))
2554 ;; 4. With a formula.
2555 (should
2556 (equal (org-test-parse-and-interpret
2557 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)")
2558 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)\n"))
2559 ;; 5. With multiple formulas.
2560 (should
2561 (equal (org-test-parse-and-interpret
2562 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2")
2563 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2\n")))
2565 (ert-deftest test-org-element/timestamp-interpreter ()
2566 "Test timestamp interpreter."
2567 ;; Active.
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 "<2012-03-29 .* 16:40>"
2573 (org-element-timestamp-interpreter
2574 '(timestamp
2575 (:type active :year-start 2012 :month-start 3 :day-start 29
2576 :hour-start 16 :minute-start 40)) nil)))
2577 ;; Inactive.
2578 (should
2579 (string-match "\\[2012-03-29 .* 16:40\\]"
2580 (org-test-parse-and-interpret "[2012-03-29 thu. 16:40]")))
2581 (should
2582 (string-match
2583 "\\[2012-03-29 .* 16:40\\]"
2584 (org-element-timestamp-interpreter
2585 '(timestamp
2586 (:type inactive :year-start 2012 :month-start 3 :day-start 29
2587 :hour-start 16 :minute-start 40)) nil)))
2588 ;; Active range.
2589 (should
2590 (string-match "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2591 (org-test-parse-and-interpret
2592 "<2012-03-29 thu. 16:40>--<2012-03-29 thu. 16:41>")))
2593 (should
2594 (string-match
2595 "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2596 (org-element-timestamp-interpreter
2597 '(timestamp
2598 (:type active-range :year-start 2012 :month-start 3 :day-start 29
2599 :hour-start 16 :minute-start 40 :year-end 2012 :month-end 3
2600 :day-end 29 :hour-end 16 :minute-end 41)) nil)))
2601 ;; Inactive range.
2602 (should
2603 (string-match "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2604 (org-test-parse-and-interpret
2605 "[2012-03-29 thu. 16:40]--[2012-03-29 thu. 16:41]")))
2606 (should
2607 (string-match
2608 "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2609 (org-element-timestamp-interpreter
2610 '(timestamp
2611 (:type inactive-range :year-start 2012 :month-start 3 :day-start 29
2612 :hour-start 16 :minute-start 40 :year-end 2012 :month-end 3
2613 :day-end 29 :hour-end 16 :minute-end 41)) nil)))
2614 ;; Diary.
2615 (should (equal (org-test-parse-and-interpret "<%%diary-float t 4 2>")
2616 "<%%diary-float t 4 2>\n"))
2617 ;; Timestamp with repeater interval, with delay, with both.
2618 (should
2619 (string-match "<2012-03-29 .* \\+1y>"
2620 (org-test-parse-and-interpret "<2012-03-29 thu. +1y>")))
2621 (should
2622 (string-match
2623 "<2012-03-29 .* \\+1y>"
2624 (org-element-timestamp-interpreter
2625 '(timestamp
2626 (:type active :year-start 2012 :month-start 3 :day-start 29
2627 :repeater-type cumulate :repeater-value 1 :repeater-unit year))
2628 nil)))
2629 (should
2630 (string-match
2631 "<2012-03-29 .* -1y>"
2632 (org-element-timestamp-interpreter
2633 '(timestamp
2634 (:type active :year-start 2012 :month-start 3 :day-start 29
2635 :warning-type all :warning-value 1 :warning-unit year))
2636 nil)))
2637 (should
2638 (string-match
2639 "<2012-03-29 .* \\+1y -1y>"
2640 (org-element-timestamp-interpreter
2641 '(timestamp
2642 (:type active :year-start 2012 :month-start 3 :day-start 29
2643 :warning-type all :warning-value 1 :warning-unit year
2644 :repeater-type cumulate :repeater-value 1 :repeater-unit year))
2645 nil)))
2646 ;; Timestamp range with repeater interval
2647 (should
2648 (string-match "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2649 (org-test-parse-and-interpret
2650 "<2012-03-29 Thu +1y>--<2012-03-30 Thu +1y>")))
2651 (should
2652 (string-match
2653 "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2654 (org-element-timestamp-interpreter
2655 '(timestamp
2656 (:type active-range :year-start 2012 :month-start 3 :day-start 29
2657 :year-end 2012 :month-end 3 :day-end 30 :repeater-type cumulate
2658 :repeater-value 1 :repeater-unit year))
2659 nil))))
2661 (ert-deftest test-org-element/verse-block-interpreter ()
2662 "Test verse block interpretation."
2663 (should
2664 (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
2665 "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
2667 (ert-deftest test-org-element/bold-interpreter ()
2668 "Test bold interpreter."
2669 (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
2671 (ert-deftest test-org-element/code-interpreter ()
2672 "Test code interpreter."
2673 (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
2675 (ert-deftest test-org-element/entity-interpreter ()
2676 "Test entity interpreter."
2677 ;; 1. Without brackets.
2678 (should
2679 (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
2680 ;; 2. With brackets.
2681 (should
2682 (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
2684 (ert-deftest test-org-element/export-snippet-interpreter ()
2685 "Test export snippet interpreter."
2686 (should (equal (org-test-parse-and-interpret "@@back-end:contents@@")
2687 "@@back-end:contents@@\n")))
2689 (ert-deftest test-org-element/footnote-reference-interpreter ()
2690 "Test footnote reference interpreter."
2691 ;; 1. Regular reference.
2692 (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
2693 ;; 2. Normalized reference.
2694 (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
2695 ;; 3. Named reference.
2696 (should (equal (org-test-parse-and-interpret "Text[fn:label]")
2697 "Text[fn:label]\n"))
2698 ;; 4. Inline reference.
2699 (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
2700 "Text[fn:label:def]\n"))
2701 ;; 5. Anonymous reference.
2702 (should (equal (org-test-parse-and-interpret "Text[fn::def]")
2703 "Text[fn::def]\n")))
2705 (ert-deftest test-org-element/inline-babel-call-interpreter ()
2706 "Test inline babel call interpreter."
2707 ;; 1. Without arguments.
2708 (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
2709 ;; 2. With arguments.
2710 (should (equal (org-test-parse-and-interpret "call_test(x=2)")
2711 "call_test(x=2)\n"))
2712 ;; 3. With header arguments.
2713 (should (equal (org-test-parse-and-interpret
2714 "call_test[:results output]()[:results html]")
2715 "call_test[:results output]()[:results html]\n")))
2717 (ert-deftest test-org-element/inline-src-block-interpreter ()
2718 "Test inline src block interpreter."
2719 ;; 1. Without header argument.
2720 (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
2721 "src_emacs-lisp{(+ 1 1)}\n"))
2722 ;; 2. With header arguments.
2723 (should (equal (org-test-parse-and-interpret
2724 "src_emacs-lisp[:results silent]{(+ 1 1)}")
2725 "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
2727 (ert-deftest test-org-element/italic-interpreter ()
2728 "Test italic interpreter."
2729 (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
2731 (ert-deftest test-org-element/latex-fragment-interpreter ()
2732 "Test latex fragment interpreter."
2733 (should (equal (org-test-parse-and-interpret "\\command{}") "\\command{}\n"))
2734 (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
2735 (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
2736 (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
2737 (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
2738 (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n")))
2740 (ert-deftest test-org-element/line-break-interpreter ()
2741 "Test line break interpreter."
2742 (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
2743 "First line \\\\\nSecond line\n")))
2745 (ert-deftest test-org-element/link-interpreter ()
2746 "Test link interpreter."
2747 ;; 1. Links targeted from a radio target.
2748 (should (equal (let ((org-target-link-regexp "radio-target"))
2749 (org-test-parse-and-interpret "a radio-target"))
2750 "a radio-target\n"))
2751 ;; 2. Regular links.
2753 ;; 2.1. Without description.
2754 (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
2755 "[[http://orgmode.org]]\n"))
2756 ;; 2.2. With a description.
2757 (should (equal (org-test-parse-and-interpret
2758 "[[http://orgmode.org][Org mode]]")
2759 "[[http://orgmode.org][Org mode]]\n"))
2760 ;; 2.3. Id links.
2761 (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
2762 ;; 2.4. Custom-id links.
2763 (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
2764 ;; 2.5 Code-ref links.
2765 (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
2766 ;; 3. Normalize plain links.
2767 (should (equal (org-test-parse-and-interpret "http://orgmode.org")
2768 "[[http://orgmode.org]]\n"))
2769 ;; 4. Normalize angular links.
2770 (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
2771 "[[http://orgmode.org]]\n")))
2773 (ert-deftest test-org-element/macro-interpreter ()
2774 "Test macro interpreter."
2775 ;; 1. Without argument.
2776 (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
2777 ;; 2. With arguments.
2778 (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
2779 "{{{test(arg1,arg2)}}}\n")))
2781 (ert-deftest test-org-element/radio-target-interpreter ()
2782 "Test radio target interpreter."
2783 (should (equal (org-test-parse-and-interpret "<<<some text>>>")
2784 "<<<some text>>>\n")))
2786 (ert-deftest test-org-element/statistics-cookie-interpreter ()
2787 "Test statistics cookie interpreter."
2788 ;; 1. Without percent
2789 (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
2790 ;; 2. With percent.
2791 (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
2793 (ert-deftest test-org-element/strike-through-interpreter ()
2794 "Test strike through interpreter."
2795 (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
2797 (ert-deftest test-org-element/subscript-interpreter ()
2798 "Test subscript interpreter."
2799 ;; 1. Without brackets.
2800 (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
2801 ;; 2. With brackets.
2802 (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
2804 (ert-deftest test-org-element/superscript-interpreter ()
2805 "Test superscript interpreter."
2806 ;; 1. Without brackets.
2807 (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
2808 ;; 2. With brackets.
2809 (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
2811 (ert-deftest test-org-element/target-interpreter ()
2812 "Test target interpreter."
2813 (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
2815 (ert-deftest test-org-element/underline-interpreter ()
2816 "Test underline interpreter."
2817 (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
2819 (ert-deftest test-org-element/verbatim-interpreter ()
2820 "Test verbatim interpreter."
2821 (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
2825 ;;; Test Granularity
2827 (ert-deftest test-org-element/granularity ()
2828 "Test granularity impact on buffer parsing."
2829 (org-test-with-temp-text "
2830 * Head 1
2831 ** Head 2
2832 #+BEGIN_CENTER
2833 Centered paragraph.
2834 #+END_CENTER
2835 Paragraph \\alpha."
2836 ;; 1.1. Granularity set to `headline' should parse every headline
2837 ;; in buffer, and only them.
2838 (let ((tree (org-element-parse-buffer 'headline)))
2839 (should (= 2 (length (org-element-map tree 'headline 'identity))))
2840 (should-not (org-element-map tree 'paragraph 'identity)))
2841 ;; 1.2. Granularity set to `greater-element' should not enter
2842 ;; greater elements excepted headlines and sections.
2843 (let ((tree (org-element-parse-buffer 'greater-element)))
2844 (should (= 1 (length (org-element-map tree 'center-block 'identity))))
2845 (should (= 1 (length (org-element-map tree 'paragraph 'identity))))
2846 (should-not (org-element-map tree 'entity 'identity)))
2847 ;; 1.3. Granularity set to `element' should enter every
2848 ;; greater-element.
2849 (let ((tree (org-element-parse-buffer 'element)))
2850 (should (= 2 (length (org-element-map tree 'paragraph 'identity))))
2851 (should-not (org-element-map tree 'entity 'identity)))
2852 ;; 1.4. Granularity set to `object' can see everything.
2853 (let ((tree (org-element-parse-buffer 'object)))
2854 (should (= 1 (length (org-element-map tree 'entity 'identity)))))))
2856 (ert-deftest test-org-element/secondary-string-parsing ()
2857 "Test if granularity correctly toggles secondary strings parsing."
2858 ;; With a granularity bigger than `object', no secondary string
2859 ;; should be parsed.
2860 (should
2861 (stringp
2862 (org-test-with-temp-text "* Headline"
2863 (let ((headline
2864 (org-element-map (org-element-parse-buffer 'headline) 'headline
2865 #'identity nil 'first-match)))
2866 (org-element-property :title headline)))))
2867 (should
2868 (stringp
2869 (org-test-with-temp-text "* Headline\n- tag :: item"
2870 (let ((item (org-element-map (org-element-parse-buffer 'element) 'item
2871 #'identity nil 'first-match)))
2872 (org-element-property :tag item)))))
2873 (when (featurep 'org-inlinetask)
2874 (should
2875 (stringp
2876 (let ((org-inlinetask-min-level 15))
2877 (org-test-with-temp-text "*************** Inlinetask"
2878 (let ((inlinetask (org-element-map (org-element-parse-buffer 'element)
2879 'inlinetask
2880 #'identity nil 'first-match)))
2881 (org-element-property :title inlinetask)))))))
2882 ;; With a default granularity, secondary strings should be parsed.
2883 (should
2884 (listp
2885 (org-test-with-temp-text "* Headline"
2886 (let ((headline
2887 (org-element-map (org-element-parse-buffer) 'headline
2888 #'identity nil 'first-match)))
2889 (org-element-property :title headline)))))
2890 ;; `org-element-at-point' should never parse a secondary string.
2891 (should-not
2892 (listp
2893 (org-test-with-temp-text "* Headline"
2894 (org-element-property :title (org-element-at-point)))))
2895 ;; Preserve current local variables when parsing a secondary string.
2896 (should
2897 (let ((org-entities nil)
2898 (org-entities-user nil))
2899 (org-test-with-temp-text "
2900 #+CAPTION: \\foo
2901 Text
2902 # Local Variables:
2903 # org-entities-user: ((\"foo\"))
2904 # End:"
2905 (let ((safe-local-variable-values '((org-entities-user . (("foo"))))))
2906 (hack-local-variables))
2907 (org-element-map (org-element-parse-buffer) 'entity
2908 #'identity nil nil nil t)))))
2912 ;;; Test Visible Only Parsing
2914 (ert-deftest test-org-element/parse-buffer-visible ()
2915 "Test `org-element-parse-buffer' with visible only argument."
2916 (should
2917 (equal '("H1" "H3" "H5")
2918 (org-test-with-temp-text
2919 "* H1\n** H2\n** H3 :visible:\n** H4\n** H5 :visible:"
2920 (org-occur ":visible:")
2921 (org-element-map (org-element-parse-buffer nil t) 'headline
2922 (lambda (hl) (org-element-property :raw-value hl)))))))
2926 ;;; Test `:parent' Property
2928 (ert-deftest test-org-element/parent-property ()
2929 "Test `:parent' property."
2930 ;; Elements.
2931 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
2932 (let* ((tree (org-element-parse-buffer))
2933 (parent (org-element-property
2934 :parent
2935 (org-element-map tree 'paragraph 'identity nil t))))
2936 (should parent)
2937 (should (eq (org-element-map tree 'center-block 'identity nil t)
2938 parent))))
2939 ;; Objects.
2940 (org-test-with-temp-text "a_{/b/}"
2941 (let* ((tree (org-element-parse-buffer))
2942 (parent (org-element-property
2943 :parent
2944 (org-element-map tree 'italic 'identity nil t))))
2945 (should parent)
2946 (should (eq parent
2947 (org-element-map tree 'subscript 'identity nil t)))))
2948 ;; Secondary strings
2949 (org-test-with-temp-text "* /italic/"
2950 (let* ((tree (org-element-parse-buffer))
2951 (parent (org-element-property
2952 :parent (org-element-map tree 'italic 'identity nil t))))
2953 (should parent)
2954 (should (eq parent
2955 (org-element-map tree 'headline 'identity nil t))))))
2959 ;;; Test Normalize Contents
2961 (ert-deftest test-org-element/normalize-contents ()
2962 "Test `org-element-normalize-contents' specifications."
2963 ;; Remove maximum common indentation from element's contents.
2964 (should
2965 (equal
2966 (org-element-normalize-contents
2967 '(paragraph nil " Two spaces\n Three spaces"))
2968 '(paragraph nil "Two spaces\n Three spaces")))
2969 ;; Ignore objects within contents when computing maximum common
2970 ;; indentation.
2971 (should
2972 (equal
2973 (org-element-normalize-contents
2974 '(paragraph nil " One " (emphasis nil "space") "\n Two spaces"))
2975 '(paragraph nil "One " (emphasis nil "space") "\n Two spaces")))
2976 ;; Ignore blank lines.
2977 (should
2978 (equal
2979 (org-element-normalize-contents
2980 '(paragraph nil " Two spaces\n\n \n Two spaces"))
2981 '(paragraph nil "Two spaces\n\n \nTwo spaces")))
2982 (should
2983 (equal
2984 '(paragraph nil " Two spaces\n" (verbatim nil "V") "\n Two spaces")
2985 (org-element-normalize-contents
2986 '(paragraph nil " Two spaces\n " (verbatim nil "V") "\n Two spaces"))))
2987 (should
2988 (equal
2989 '(verse-block nil "line 1\n\nline 2")
2990 (org-element-normalize-contents
2991 '(verse-block nil " line 1\n\n line 2"))))
2992 ;; Recursively enter objects in order to compute common indentation.
2993 (should
2994 (equal
2995 (org-element-normalize-contents
2996 '(paragraph nil " Two spaces " (bold nil " and\n One space")))
2997 '(paragraph nil " Two spaces " (bold nil " and\nOne space"))))
2998 ;; When optional argument is provided, ignore first line
2999 ;; indentation.
3000 (should
3001 (equal
3002 (org-element-normalize-contents
3003 '(paragraph nil "No space\n Two spaces\n Three spaces") t)
3004 '(paragraph nil "No space\nTwo spaces\n Three spaces"))))
3008 ;;; Test Navigation Tools.
3010 (ert-deftest test-org-element/at-point ()
3011 "Test `org-element-at-point' specifications."
3012 ;; Return closest element containing point.
3013 (should
3014 (eq 'paragraph
3015 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
3016 (progn (search-forward "A")
3017 (org-element-type (org-element-at-point))))))
3018 ;; Correctly set `:parent' property.
3019 (should
3020 (eq 'center-block
3021 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
3022 (progn (search-forward "A")
3023 (org-element-type
3024 (org-element-property :parent (org-element-at-point)))))))
3025 ;; Special case: at a blank line just below a headline, return that
3026 ;; headline.
3027 (should
3028 (equal "H1" (org-test-with-temp-text "* H1\n \n* H2\n"
3029 (forward-line)
3030 (org-element-property :title (org-element-at-point)))))
3031 ;; Special case: at the very beginning of a table, return `table'
3032 ;; object instead of `table-row'.
3033 (should
3034 (eq 'table
3035 (org-test-with-temp-text "| a | b |"
3036 (org-element-type (org-element-at-point)))))
3037 ;; Special case: at the very beginning of a list or sub-list, return
3038 ;; `plain-list' object instead of `item'.
3039 (should
3040 (eq 'plain-list
3041 (org-test-with-temp-text "- item"
3042 (org-element-type (org-element-at-point)))))
3043 ;; Special case: at the closing line of a greater element, be sure
3044 ;; to return it instead of the last element in its contents.
3045 (should
3046 (eq 'center-block
3047 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph\n#+END_CENTER"
3048 (progn (forward-line 2)
3049 (org-element-type (org-element-at-point))))))
3050 ;; Special case: at a blank line between two items, be sure to
3051 ;; return item above instead of the last element of its contents.
3052 (should
3053 (eq 'item
3054 (org-test-with-temp-text "- Para1\n\n- Para2"
3055 (progn (forward-line)
3056 (org-element-type
3057 (let ((org-list-empty-line-terminates-plain-lists nil))
3058 (org-element-at-point)))))))
3059 ;; Special case: at the last blank line in a plain list, return it
3060 ;; instead of the last item.
3061 (should
3062 (eq 'plain-list
3063 (org-test-with-temp-text "- Para1\n- Para2\n\nPara3"
3064 (progn (forward-line 2)
3065 (org-element-type (org-element-at-point))))))
3066 ;; Special case: when a list ends at the end of buffer and there's
3067 ;; no final newline, return last element in last item.
3068 (should
3069 (eq 'paragraph
3070 (org-test-with-temp-text "- a"
3071 (end-of-line)
3072 (org-element-type (org-element-at-point)))))
3073 ;; Parse a list within a block itself contained in a list.
3074 (should
3075 (eq 'plain-list
3076 (org-test-with-temp-text
3077 "- outer\n #+begin_center\n - inner\n #+end_center"
3078 (search-forward "inner")
3079 (beginning-of-line)
3080 (org-element-type (org-element-at-point)))))
3081 ;; Do not error at eob on an empty line.
3082 (should
3083 (org-test-with-temp-text "* H\n"
3084 (forward-line)
3085 (or (org-element-at-point) t))))
3087 (ert-deftest test-org-element/context ()
3088 "Test `org-element-context' specifications."
3089 ;; Return closest object containing point.
3090 (should
3091 (eq 'underline
3092 (org-test-with-temp-text "Some *text with _underline_ text*"
3093 (progn (search-forward "under")
3094 (org-element-type (org-element-context))))))
3095 ;; Find objects in secondary strings.
3096 (should
3097 (eq 'underline
3098 (org-test-with-temp-text "* Headline _with_ underlining"
3099 (progn (search-forward "w")
3100 (org-element-type (org-element-context))))))
3101 ;; Find objects in objects.
3102 (should
3103 (eq 'macro
3104 (org-test-with-temp-text "| a | {{{macro}}} |"
3105 (progn (search-forward "{")
3106 (org-element-type (org-element-context))))))
3107 (should
3108 (eq 'table-cell
3109 (org-test-with-temp-text "| a | b {{{macro}}} |"
3110 (progn (search-forward "b")
3111 (org-element-type (org-element-context))))))
3112 ;; Find objects in planning lines.
3113 (should
3114 (eq 'timestamp
3115 (org-test-with-temp-text "* H\n SCHEDULED: <2012-03-29 thu.>"
3116 (search-forward "2012")
3117 (org-element-type (org-element-context)))))
3118 (should-not
3119 (eq 'timestamp
3120 (org-test-with-temp-text "* H\n SCHEDULED: <2012-03-29 thu.>"
3121 (search-forward "SCHEDULED")
3122 (org-element-type (org-element-context)))))
3123 ;; Find objects in document keywords.
3124 (should
3125 (eq 'macro
3126 (org-test-with-temp-text "#+DATE: {{{macro}}}"
3127 (progn (search-forward "{")
3128 (org-element-type (org-element-context))))))
3129 ;; Do not find objects in table rules.
3130 (should
3131 (eq 'table-row
3132 (org-test-with-temp-text "| a | b |\n+---+---+\n| c | d |"
3133 (forward-line)
3134 (org-element-type (org-element-context)))))
3135 ;; Find objects in parsed affiliated keywords.
3136 (should
3137 (eq 'macro
3138 (org-test-with-temp-text "#+CAPTION: {{{macro}}}\n| a | b |."
3139 (progn (search-forward "{")
3140 (org-element-type (org-element-context))))))
3141 (should
3142 (eq 'bold
3143 (org-test-with-temp-text "#+caption: *bold*\nParagraph"
3144 (progn (search-forward "*")
3145 (org-element-type (org-element-context))))))
3146 ;; Find objects at the end of buffer.
3147 (should
3148 (eq 'bold
3149 (org-test-with-temp-text "*bold*"
3150 (goto-char (point-max))
3151 (org-element-type (org-element-context)))))
3152 ;; Correctly set `:parent' property.
3153 (should
3154 (eq 'paragraph
3155 (org-test-with-temp-text "Some *bold* text"
3156 (progn (search-forward "bold")
3157 (org-element-type
3158 (org-element-property :parent (org-element-context)))))))
3159 ;; Between two objects, return the second one.
3160 (should
3161 (eq 'macro
3162 (org-test-with-temp-text "<<target>>{{{test}}}"
3163 (progn (search-forward "{")
3164 (backward-char)
3165 (org-element-type (org-element-context))))))
3166 ;; Test optional argument.
3167 (should
3168 (eq 'underline
3169 (org-test-with-temp-text "Some *text with _underline_ text*"
3170 (progn
3171 (search-forward "under")
3172 (org-element-type (org-element-context (org-element-at-point)))))))
3173 ;; Special case: bold object at the beginning of a headline.
3174 (should
3175 (eq 'bold
3176 (org-test-with-temp-text "* *bold*"
3177 (search-forward "bo")
3178 (org-element-type (org-element-context)))))
3179 ;; Special case: incomplete cell at the end of a table row.
3180 (should
3181 (eq 'table-cell
3182 (org-test-with-temp-text "|a|b|c"
3183 (goto-char (point-max))
3184 (org-element-type (org-element-context)))))
3185 ;; Special case: objects in inline footnotes.
3186 (should
3187 (eq 'link
3188 (org-test-with-temp-text "[fn::[[<point>http://orgmode.org]]]"
3189 (org-element-type (org-element-context))))))
3193 ;;; Test Cache.
3195 (ert-deftest test-org-element/cache ()
3196 "Test basic expectations and common pitfalls for cache."
3197 ;; Shift positions.
3198 (should
3199 (equal '(18 . 23)
3200 (org-test-with-temp-text "para1\n\npara2\n\npara3"
3201 (let ((org-element-use-cache t))
3202 (save-excursion (goto-char (point-max)) (org-element-at-point))
3203 (insert "add")
3204 (forward-line 4)
3205 (let ((element (org-element-at-point)))
3206 (cons (org-element-property :begin element)
3207 (org-element-property :end element)))))))
3208 ;; Partial shifting: when the contents of a greater element are
3209 ;; modified, only shift ending positions.
3210 (should
3211 (org-test-with-temp-text
3212 "#+BEGIN_CENTER\nPara1\n\nPara2\n\nPara3\n#+END_CENTER"
3213 (let ((org-element-use-cache t))
3214 (save-excursion (search-forward "3") (org-element-at-point))
3215 (search-forward "Para2")
3216 (insert " ")
3217 (let ((element (org-element-property :parent (org-element-at-point))))
3218 (equal (cons (org-element-property :begin element)
3219 (org-element-property :end element))
3220 (cons (point-min) (point-max)))))))
3221 ;; Re-parent shifted elements.
3222 (should
3223 (eq 'item
3224 (org-test-with-temp-text "- item\n\n\n para1\n para2"
3225 (let ((org-element-use-cache t))
3226 (end-of-line)
3227 (org-element-at-point)
3228 (save-excursion (goto-char (point-max)) (org-element-at-point))
3229 (forward-line)
3230 (delete-char 1)
3231 (goto-char (point-max))
3232 (org-element-type
3233 (org-element-property :parent (org-element-at-point)))))))
3234 ;; Preserve local structures when re-parenting.
3235 (should
3236 (eq 'table
3237 (org-test-with-temp-text
3238 "#+begin_center\nP0\n\n<point>\n\n P1\n | a | b |\n| c | d |\n#+end_center"
3239 (let ((org-element-use-cache t))
3240 (save-excursion (search-forward "| c |") (org-element-at-point))
3241 (insert "- item")
3242 (search-forward "| c |")
3243 (beginning-of-line)
3244 (org-element-type
3245 (org-element-property :parent (org-element-at-point)))))))
3246 (should-not
3247 (eq 'center-block
3248 (org-test-with-temp-text
3249 "#+begin_center\nP0\n\n<point>\n\n P1\n | a | b |\n#+end_center"
3250 (let ((org-element-use-cache t))
3251 (save-excursion (search-forward "| a |") (org-element-at-point))
3252 (insert "- item")
3253 (search-forward "| a |")
3254 (beginning-of-line)
3255 (org-element-type
3256 (org-element-property :parent (org-element-at-point)))))))
3257 ;; When re-parenting, also propagate changes to list structures.
3258 (should
3259 (= 2
3260 (org-test-with-temp-text "\n Para\n - item<point>"
3261 (let ((org-element-use-cache t))
3262 (org-element-at-point)
3263 (goto-char (point-min))
3264 (insert "- Top\n")
3265 (search-forward "- item")
3266 (beginning-of-line)
3267 (length (org-element-property :structure (org-element-at-point)))))))
3268 ;; Modifying the last line of an element alters the element below.
3269 (should
3270 (org-test-with-temp-text "para1\n\npara2"
3271 (let ((org-element-use-cache t))
3272 (goto-char (point-max))
3273 (org-element-at-point)
3274 (forward-line -1)
3275 (insert "merge")
3276 (let ((element (org-element-at-point)))
3277 (equal (cons (org-element-property :begin element)
3278 (org-element-property :end element))
3279 (cons (point-min) (point-max)))))))
3280 ;; Modifying the first line of an element alters the element above.
3281 (should
3282 (org-test-with-temp-text ": fixed-width\n:not-fixed-width"
3283 (let ((org-element-use-cache t))
3284 (goto-char (point-max))
3285 (org-element-at-point)
3286 (search-backward ":")
3287 (forward-char)
3288 (insert " ")
3289 (let ((element (org-element-at-point)))
3290 (equal (cons (org-element-property :begin element)
3291 (org-element-property :end element))
3292 (cons (point-min) (point-max)))))))
3293 ;; Sensitive change: adding a line alters document structure both
3294 ;; above and below.
3295 (should
3296 (eq 'example-block
3297 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n"
3298 (let ((org-element-use-cache t))
3299 (goto-char (point-max))
3300 (org-element-at-point)
3301 (insert "#+END_EXAMPLE")
3302 (search-backward "Para1")
3303 (org-element-type (org-element-at-point))))))
3304 (should
3305 (eq 'example-block
3306 (org-test-with-temp-text "Para1\n\nPara2\n#+END_EXAMPLE"
3307 (let ((org-element-use-cache t))
3308 (save-excursion (goto-char (point-max)) (org-element-at-point))
3309 (insert "#+BEGIN_EXAMPLE\n")
3310 (search-forward "Para2")
3311 (org-element-type (org-element-at-point))))))
3312 ;; Sensitive change: removing a line alters document structure both
3313 ;; above and below.
3314 (should
3315 (eq 'example-block
3316 (org-test-with-temp-text
3317 "# +BEGIN_EXAMPLE\nPara1\n\nPara2\n#+END_EXAMPLE"
3318 (let ((org-element-use-cache t))
3319 (save-excursion (goto-char (point-max)) (org-element-at-point))
3320 (forward-char)
3321 (delete-char 1)
3322 (search-forward "Para2")
3323 (org-element-type (org-element-at-point))))))
3324 (should
3325 (eq 'example-block
3326 (org-test-with-temp-text
3327 "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n# +END_EXAMPLE"
3328 (let ((org-element-use-cache t))
3329 (save-excursion (goto-char (point-max)) (org-element-at-point))
3330 (search-forward "# ")
3331 (delete-char -1)
3332 (search-backward "Para1")
3333 (org-element-type (org-element-at-point)))))))
3336 (provide 'test-org-element)
3338 ;;; test-org-element.el ends here