Merge branch 'maint'
[org-mode/org-tableheadings.git] / testing / lisp / test-org-element.el
blob9b1ca77117bf23bd6e67860fb9f123080bfc5ebd
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<point>:abc: value\n:END:"
1575 (let ((element (org-element-at-point)))
1576 (list (org-element-property :key element)
1577 (org-element-property :value element))))))
1578 ;; Value should be trimmed.
1579 (should
1580 (equal "value"
1581 (org-test-with-temp-text ":PROPERTIES:\n<point>:abc: value \n:END:"
1582 (org-element-property :value (org-element-at-point)))))
1583 ;; A node property requires to be wrapped within a property drawer.
1584 (should-not
1585 (eq 'node-property
1586 (org-test-with-temp-text ":abc: value"
1587 (org-element-type (org-element-at-point)))))
1588 ;; Accept empty properties.
1589 (should
1590 (equal '(("foo" "value") ("bar" ""))
1591 (org-test-with-temp-text ":PROPERTIES:\n:foo: value\n:bar:\n:END:"
1592 (org-element-map (org-element-parse-buffer) 'node-property
1593 (lambda (p)
1594 (list (org-element-property :key p)
1595 (org-element-property :value p)))))))
1596 ;; Ignore all non-property lines in property drawers.
1597 (should
1598 (equal
1599 '(("foo" "value"))
1600 (org-test-with-temp-text ":PROPERTIES:\nWrong1\n:foo: value\nWrong2\n:END:"
1601 (org-element-map (org-element-parse-buffer) 'node-property
1602 (lambda (p)
1603 (list (org-element-property :key p)
1604 (org-element-property :value p))))))))
1607 ;;;; Paragraph
1609 (ert-deftest test-org-element/paragraph-parser ()
1610 "Test `paragraph' parser."
1611 ;; Standard test.
1612 (should
1613 (org-test-with-temp-text "Paragraph"
1614 (org-element-map (org-element-parse-buffer) 'paragraph 'identity nil t)))
1615 ;; Property find end of a paragraph stuck to another element.
1616 (should
1617 (eq ?#
1618 (org-test-with-temp-text "Paragraph\n# Comment"
1619 (org-element-map (org-element-parse-buffer) 'paragraph
1620 (lambda (p) (char-after (org-element-property :end p)))
1621 nil t))))
1622 ;; Include ill-formed Keywords.
1623 (should
1624 (org-test-with-temp-text "#+wrong_keyword something"
1625 (org-element-map (org-element-parse-buffer) 'paragraph 'identity)))
1626 ;; Include incomplete-drawers.
1627 (should
1628 (org-test-with-temp-text ":TEST:\nParagraph"
1629 (let ((elem (org-element-at-point)))
1630 (and (eq (org-element-type elem) 'paragraph)
1631 (= (point-max) (org-element-property :end elem))))))
1632 ;; Include incomplete blocks.
1633 (should
1634 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph"
1635 (let ((elem (org-element-at-point)))
1636 (and (eq (org-element-type elem) 'paragraph)
1637 (= (point-max) (org-element-property :end elem))))))
1638 ;; Include incomplete dynamic blocks.
1639 (should
1640 (org-test-with-temp-text "#+BEGIN: \nParagraph"
1641 (let ((elem (org-element-at-point)))
1642 (and (eq (org-element-type elem) 'paragraph)
1643 (= (point-max) (org-element-property :end elem))))))
1644 ;; Include incomplete latex environments.
1645 (should
1646 (org-test-with-temp-text "\begin{equation}\nParagraph"
1647 (let ((elem (org-element-at-point)))
1648 (and (eq (org-element-type elem) 'paragraph)
1649 (= (point-max) (org-element-property :end elem))))))
1650 ;; Do not steal affiliated keywords from container.
1651 (should
1652 (org-test-with-temp-text "#+ATTR_LATEX: test\n- item 1"
1653 (let ((elem (progn (search-forward "item") (org-element-at-point))))
1654 (and (eq (org-element-type elem) 'paragraph)
1655 (not (org-element-property :attr_latex elem))
1656 (/= (org-element-property :begin elem) 1)))))
1657 ;; Handle non-empty blank line at the end of buffer.
1658 (should
1659 (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
1660 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1663 ;;;; Plain List
1665 (ert-deftest test-org-element/plain-list-parser ()
1666 "Test `plain-list' parser."
1667 (org-test-with-temp-text "- item"
1668 (should (org-element-map (org-element-parse-buffer) 'plain-list 'identity)))
1669 ;; Blank lines after the list only belong to outer plain list.
1670 (should
1671 (equal
1672 '(t t)
1673 (org-test-with-temp-text "
1674 - outer
1675 - inner
1677 Outside list"
1678 (let ((endings (org-element-map (org-element-parse-buffer) 'plain-list
1679 (lambda (pl) (org-element-property :end pl)))))
1680 (list
1681 ;; Move to ending of outer list.
1682 (progn (goto-char (car endings)) (looking-at "Outside list"))
1683 ;; Move to ending of inner list.
1684 (progn (goto-char (nth 1 endings)) (looking-at "^$")))))))
1685 ;; Correctly compute end of list if it doesn't end at a line
1686 ;; beginning.
1687 (should
1688 (org-test-with-temp-text "- list\n \n "
1689 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1692 ;;;; Planning
1694 (ert-deftest test-org-element/planning-parser ()
1695 "Test `planning' parser."
1696 ;; Test various keywords.
1697 (should
1698 (org-element-property
1699 :closed
1700 (org-test-with-temp-text "* H\n<point>CLOSED: [2012-03-29 thu.]"
1701 (org-element-at-point))))
1702 (should
1703 (org-element-property
1704 :deadline
1705 (org-test-with-temp-text "* H\n<point>DEADLINE: <2012-03-29 thu.>"
1706 (org-element-at-point))))
1707 (should
1708 (org-element-property
1709 :scheduled
1710 (org-test-with-temp-text "* H\n<point>SCHEDULED: <2012-03-29 thu.>"
1711 (org-element-at-point))))
1712 ;; Planning line only exists right after a headline.
1713 (should-not
1714 (eq 'planning
1715 (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>"
1716 (org-element-type (org-element-at-point))))))
1719 ;;;; Property Drawer
1721 (ert-deftest test-org-element/property-drawer-parser ()
1722 "Test `property-drawer' parser."
1723 ;; Standard test.
1724 (should
1725 (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
1726 (org-element-map
1727 (org-element-parse-buffer) 'property-drawer 'identity nil t)))
1728 ;; Do not mix property drawers and regular drawers.
1729 (should-not
1730 (org-test-with-temp-text ":TEST:\n:prop: value\n:END:"
1731 (org-element-map
1732 (org-element-parse-buffer) 'property-drawer 'identity nil t)))
1733 ;; Ignore incomplete drawer.
1734 (should-not
1735 (org-test-with-temp-text ":PROPERTIES:\n:prop: value"
1736 (org-element-map
1737 (org-element-parse-buffer) 'property-drawer 'identity nil t)))
1738 ;; Handle non-empty blank line at the end of buffer.
1739 (should
1740 (org-test-with-temp-text ":PROPERTIES:\n:END:\n "
1741 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1744 ;;;; Quote Block
1746 (ert-deftest test-org-element/quote-block-parser ()
1747 "Test `quote-block' parser."
1748 ;; Regular test.
1749 (should
1750 (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
1751 (org-element-map (org-element-parse-buffer) 'quote-block 'identity)))
1752 ;; Ignore incomplete block.
1753 (should-not
1754 (org-test-with-temp-text "#+BEGIN_QUOTE"
1755 (org-element-map (org-element-parse-buffer) 'quote-block 'identity nil t)))
1756 ;; Handle non-empty blank line at the end of buffer.
1757 (should
1758 (org-test-with-temp-text "#+BEGIN_QUOTE\nC\n#+END_QUOTE\n "
1759 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1762 ;;;; Radio Target
1764 (ert-deftest test-org-element/radio-target-parser ()
1765 "Test `radio-target' parser."
1766 ;; Standard test.
1767 (should
1768 (eq 'radio-target
1769 (org-test-with-temp-text "<<<radio>>>"
1770 (org-element-type (org-element-context)))))
1771 ;; Radio targets with objects.
1772 (should
1773 (eq 'radio-target
1774 (org-test-with-temp-text "<<<radio \\alpha>>>"
1775 (org-element-type (org-element-context)))))
1776 ;; Radio targets starting with an object.
1777 (should
1778 (eq 'radio-target
1779 (org-test-with-temp-text "<<<\\alpha radio>>>"
1780 (org-element-type (org-element-context)))))
1781 ;; Radio targets cannot begin or end with white space.
1782 (should-not
1783 (eq 'radio-target
1784 (org-test-with-temp-text "<<< radio>>>"
1785 (org-element-type (org-element-context)))))
1786 (should-not
1787 (eq 'radio-target
1788 (org-test-with-temp-text "<<<radio >>>"
1789 (org-element-type (org-element-context))))))
1792 ;;;; Section
1794 (ert-deftest test-org-element/section-parser ()
1795 "Test `section' parser."
1796 ;; Standard test.
1797 (should
1798 (org-test-with-temp-text "* Headline\nText"
1799 (org-element-map (org-element-parse-buffer) 'section 'identity)))
1800 ;; There's a section before the first headline.
1801 (should
1802 (org-test-with-temp-text "Text"
1803 (org-element-map (org-element-parse-buffer) 'section 'identity)))
1804 ;; A section cannot be empty.
1805 (should-not
1806 (org-test-with-temp-text "* Headline 1\n* Headline 2"
1807 (org-element-map (org-element-parse-buffer) 'section 'identity)))
1808 ;; A section doesn't contain sub-trees.
1809 (should-not
1810 (org-test-with-temp-text "* Head\nText\n** Sub-Head"
1811 (org-element-map
1812 (org-element-map (org-element-parse-buffer) 'section 'identity nil t)
1813 'headline 'identity))))
1816 ;;;; Special Block
1818 (ert-deftest test-org-element/special-block-parser ()
1819 "Test `special-block' parser."
1820 ;; Standard test.
1821 (should
1822 (equal "SPECIAL"
1823 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1824 (org-element-property :type (org-element-at-point)))))
1825 ;; Special blocks can contain paragraphs.
1826 (should
1827 (eq 'paragraph
1828 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1829 (forward-line)
1830 (org-element-type (org-element-at-point)))))
1831 ;; Ignore incomplete block.
1832 (should-not
1833 (eq 'special-block
1834 (org-test-with-temp-text "#+BEGIN_SPECIAL"
1835 (org-element-type (org-element-at-point)))))
1836 ;; Allow special characters in type.
1837 (should
1838 (equal '(special-block "SPECIAL*")
1839 (org-test-with-temp-text "#+BEGIN_SPECIAL*\nContents\n#+END_SPECIAL*"
1840 (let ((element (org-element-at-point)))
1841 (list (org-element-type element)
1842 (org-element-property :type element))))))
1843 ;; Handle non-empty blank line at the end of buffer.
1844 (should
1845 (org-test-with-temp-text "#+BEGIN_SPECIAL\nC\n#+END_SPECIAL\n "
1846 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1849 ;;;; Src Block
1851 (ert-deftest test-org-element/src-block-parser ()
1852 "Test `src-block' parser."
1853 ;; Regular tests.
1854 (should
1855 (org-test-with-temp-text "#+BEGIN_SRC org\nText\n#+END_SRC"
1856 (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
1857 ;; Ignore incomplete block.
1858 (should-not
1859 (org-test-with-temp-text "#+BEGIN_SRC"
1860 (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
1861 ;; Properly un-escape code.
1862 (should
1863 (equal "* Headline\n #+keyword\nText\n"
1864 (org-test-with-temp-text
1865 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText\n#+END_SRC"
1866 (org-element-property :value (org-element-at-point)))))
1867 ;; Remove block indentation according to block boundaries, unless
1868 ;; block contents are less indented than block boundaries.
1869 (should
1870 (equal " L1\nL2\n"
1871 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
1872 (let ((org-src-preserve-indentation t))
1873 (org-element-property :value (org-element-at-point))))))
1874 (should
1875 (equal
1876 " L1\n L2\n"
1877 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
1878 (let ((org-src-preserve-indentation t))
1879 (org-element-property :value (org-element-at-point))))))
1880 ;; Handle non-empty blank line at the end of buffer.
1881 (should
1882 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\nC\n#+END_SRC\n "
1883 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1886 ;;;; Statistics Cookie
1888 (ert-deftest test-org-element/statistics-cookie ()
1889 "Test `statistics-cookie' parser."
1890 ;; With numbers.
1891 (should
1892 (org-test-with-temp-text "[1/2]"
1893 (org-element-map (org-element-parse-buffer) 'statistics-cookie 'identity)))
1894 ;; With percents.
1895 (should
1896 (org-test-with-temp-text "[33%]"
1897 (org-element-map
1898 (org-element-parse-buffer) 'statistics-cookie 'identity))))
1901 ;;;; Strike Through
1903 (ert-deftest test-org-element/strike-through-parser ()
1904 "Test `strike-through' parser."
1905 ;; Regular test.
1906 (should
1907 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1908 (org-test-with-temp-text "+strike-through+"
1909 (org-element-map (org-element-parse-buffer) 'strike-through 'identity))))
1910 ;; Multi-line markup.
1911 (should
1912 (equal
1913 (org-element-contents
1914 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1915 (org-test-with-temp-text "+first line\nsecond line+"
1916 (org-element-map
1917 (org-element-parse-buffer) 'strike-through 'identity nil t))))
1918 '("first line\nsecond line"))))
1921 ;;;; Subscript
1923 (ert-deftest test-org-element/subscript-parser ()
1924 "Test `subscript' parser."
1925 ;; Without braces.
1926 (should
1927 (org-test-with-temp-text "a_b"
1928 (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
1929 ;; With braces.
1930 (should
1931 (org-test-with-temp-text "a_{b}"
1932 (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
1933 ;; Multiple subscripts in a paragraph.
1934 (should
1935 (= 2
1936 (org-test-with-temp-text "a_b and c_d"
1937 (length
1938 (org-element-map (org-element-parse-buffer) 'subscript 'identity))))))
1941 ;;;; Superscript
1943 (ert-deftest test-org-element/superscript-parser ()
1944 "Test `superscript' parser."
1945 ;; Without braces.
1946 (should
1947 (org-test-with-temp-text "a^b"
1948 (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
1949 ;; With braces.
1950 (should
1951 (org-test-with-temp-text "a^{b}"
1952 (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
1953 ;; Multiple superscript in a paragraph.
1954 (should
1955 (= 2
1956 (org-test-with-temp-text "a^b and c^d"
1957 (length
1958 (org-element-map
1959 (org-element-parse-buffer) 'superscript 'identity))))))
1962 ;;;; Table
1964 (ert-deftest test-org-element/table-parser ()
1965 "Test `table' parser."
1966 (should
1967 (org-test-with-temp-text "| a |"
1968 (org-element-map (org-element-parse-buffer) 'table 'identity)))
1969 ;; TBLFM keyword is case insensitive.
1970 (should
1971 (org-test-with-temp-text "| a |\n#+tblfm: test"
1972 (org-element-property
1973 :tblfm
1974 (org-element-map (org-element-parse-buffer) 'table 'identity nil t))))
1975 ;; Handle multiple TBLFM lines.
1976 (should
1977 (= 2
1978 (org-test-with-temp-text "| a |\n#+TBLFM: test1\n#+TBLFM: test2"
1979 (length (org-element-property
1980 :tblfm
1981 (org-element-map
1982 (org-element-parse-buffer) 'table 'identity nil t))))))
1983 ;; Handle non-empty blank line at the end of buffer.
1984 (should
1985 (org-test-with-temp-text "| a |\n "
1986 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1989 ;;;; Table Cell
1991 (ert-deftest test-org-element/table-cell-parser ()
1992 "Test `table-cell' parser."
1993 ;; Regular table cell.
1994 (should
1995 (org-test-with-temp-text "| a |"
1996 (org-element-map (org-element-parse-buffer) 'table-cell 'identity)))
1997 ;; Last vertical bar may be omitted.
1998 (should
1999 (org-test-with-temp-text "| a "
2000 (org-element-map (org-element-parse-buffer) 'table-cell 'identity))))
2003 ;;;; Table Row
2005 (ert-deftest test-org-element/table-row-parser ()
2006 "Test `table-row' parser."
2007 (should
2008 (equal '(standard rule)
2009 (org-test-with-temp-text "| a |\n|---|"
2010 (org-element-map
2011 (org-element-parse-buffer) 'table-row
2012 (lambda (row) (org-element-property :type row)))))))
2015 ;;;; Target
2017 (ert-deftest test-org-element/target-parser ()
2018 "Test `target' parser."
2019 (should
2020 (org-test-with-temp-text "<<target>>"
2021 (org-element-map (org-element-parse-buffer) 'target 'identity))))
2024 ;;;; Timestamp
2026 (ert-deftest test-org-element/timestamp ()
2027 "Test `timestamp' parser."
2028 ;; Active timestamp.
2029 (should
2030 (org-test-with-temp-text "<2012-03-29 16:40>"
2031 (eq (org-element-property :type (org-element-context)) 'active)))
2032 (should-not
2033 (org-test-with-temp-text "<2012-03-29 Thu>"
2034 (let ((timestamp (org-element-context)))
2035 (or (org-element-property :hour-start timestamp)
2036 (org-element-property :minute-start timestamp)))))
2037 (should
2038 (equal '(2012 3 29 16 40)
2039 (org-test-with-temp-text "<2012-03-29 Thu 16:40>"
2040 (let ((object (org-element-context)))
2041 (list (org-element-property :year-start object)
2042 (org-element-property :month-start object)
2043 (org-element-property :day-start object)
2044 (org-element-property :hour-start object)
2045 (org-element-property :minute-start object))))))
2046 ;; Inactive timestamp.
2047 (should
2048 (org-test-with-temp-text "[2012-03-29 Thu 16:40]"
2049 (eq (org-element-property :type (org-element-context)) 'inactive)))
2050 ;; Time range.
2051 (should
2052 (equal '(2012 3 29 16 40 7 30)
2053 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
2054 (let ((object (org-element-context)))
2055 (list (org-element-property :year-end object)
2056 (org-element-property :month-end object)
2057 (org-element-property :day-end object)
2058 (org-element-property :hour-end object)
2059 (org-element-property :minute-end object)
2060 (org-element-property :hour-start object)
2061 (org-element-property :minute-start object))))))
2062 (should
2063 (eq 'active-range
2064 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
2065 (org-element-property :type (org-element-context)))))
2066 ;; Date range.
2067 (should
2068 (org-test-with-temp-text "[2012-03-29 Thu 16:40]--[2012-03-29 Thu 16:41]"
2069 (eq (org-element-property :type (org-element-context)) 'inactive-range)))
2070 (should-not
2071 (org-test-with-temp-text "[2011-07-14 Thu]--[2012-03-29 Thu]"
2072 (let ((timestamp (org-element-context)))
2073 (or (org-element-property :hour-end timestamp)
2074 (org-element-property :minute-end timestamp)))))
2075 ;; With repeater, warning delay and both.
2076 (should
2077 (eq 'catch-up
2078 (org-test-with-temp-text "<2012-03-29 Thu ++1y>"
2079 (org-element-property :repeater-type (org-element-context)))))
2080 (should
2081 (eq 'first
2082 (org-test-with-temp-text "<2012-03-29 Thu --1y>"
2083 (org-element-property :warning-type (org-element-context)))))
2084 (should
2085 (equal '(cumulate all)
2086 (org-test-with-temp-text "<2012-03-29 Thu +1y -1y>"
2087 (let ((ts (org-element-context)))
2088 (list (org-element-property :repeater-type ts)
2089 (org-element-property :warning-type ts)))))))
2092 ;;;; Underline
2094 (ert-deftest test-org-element/underline-parser ()
2095 "Test `underline' parser."
2096 ;; Regular test.
2097 (should
2098 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2099 (org-test-with-temp-text "_underline_"
2100 (org-element-map (org-element-parse-buffer) 'underline 'identity))))
2101 ;; Multi-line markup.
2102 (should
2103 (equal
2104 (org-element-contents
2105 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2106 (org-test-with-temp-text "_first line\nsecond line_"
2107 (org-element-map
2108 (org-element-parse-buffer) 'underline 'identity nil t))))
2109 '("first line\nsecond line"))))
2112 ;;;; Verbatim
2114 (ert-deftest test-org-element/verbatim-parser ()
2115 "Test `verbatim' parser."
2116 ;; Regular test.
2117 (should
2118 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2119 (org-test-with-temp-text "=verbatim="
2120 (org-element-map (org-element-parse-buffer) 'verbatim 'identity))))
2121 ;; Multi-line markup.
2122 (should
2123 (equal
2124 (org-element-property
2125 :value
2126 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2127 (org-test-with-temp-text "=first line\nsecond line="
2128 (org-element-map
2129 (org-element-parse-buffer) 'verbatim 'identity nil t))))
2130 "first line\nsecond line")))
2133 ;;;; Verse Block
2135 (ert-deftest test-org-element/verse-block-parser ()
2136 "Test `verse-block' parser."
2137 ;; Standard test.
2138 (should
2139 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
2140 (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
2141 ;; Ignore case.
2142 (should
2143 (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
2144 (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
2145 ;; Parse objects in verse blocks.
2146 (should
2147 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
2148 (org-element-map (org-element-parse-buffer) 'entity 'identity)))
2149 ;; Ignore incomplete verse block.
2150 (should-not
2151 (org-test-with-temp-text "#+BEGIN_VERSE"
2152 (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)))
2153 ;; Handle non-empty blank line at the end of buffer.
2154 (should
2155 (org-test-with-temp-text "#+BEGIN_VERSE\nC\n#+END_VERSE\n "
2156 (= (org-element-property :end (org-element-at-point)) (point-max)))))
2160 ;;; Test Interpreters.
2162 (ert-deftest test-org-element/interpret-data ()
2163 "Test `org-element-interpret-data' specifications."
2164 ;; Interpret simple affiliated keywords.
2165 (should
2166 (equal
2167 (org-element-interpret-data
2168 '(org-data nil (paragraph (:name "para") "Paragraph")))
2169 "#+NAME: para\nParagraph\n"))
2170 ;; Interpret multiple affiliated keywords.
2171 (should
2172 (equal
2173 (org-element-interpret-data
2174 '(org-data nil (paragraph (:attr_ascii ("line2" "line1")) "Paragraph")))
2175 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
2176 ;; Interpret parsed affiliated keywords.
2177 (should
2178 (equal
2179 (org-element-interpret-data
2180 '(org-data nil (paragraph (:caption (("caption"))) "Paragraph")))
2181 "#+CAPTION: caption\nParagraph\n"))
2182 ;; Interpret dual affiliated keywords.
2183 (should
2184 (equal
2185 (org-element-interpret-data
2186 '(org-data nil (paragraph (:caption ((("long") "short"))) "Paragraph")))
2187 "#+CAPTION[short]: long\nParagraph\n"))
2188 ;; Interpret multiple parsed dual keywords.
2189 (should
2190 (equal
2191 (org-element-interpret-data
2192 '(org-data nil (paragraph
2193 (:caption ((("l2") "s2") (("l1") "s1"))) "Paragraph")))
2194 "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph\n"))
2195 ;; Pseudo objects and elements are transparent.
2196 (should
2197 (equal "A B\n"
2198 (org-element-interpret-data
2199 '(paragraph nil (pseudo-object (:post-blank 1) "A") "B")
2200 '(pseudo-object))))
2201 (should
2202 (equal "A\n\nB\n"
2203 (org-element-interpret-data
2204 '(center nil
2205 (pseudo-element (:post-blank 1) (paragraph nil "A"))
2206 (paragraph nil "B"))))))
2208 (ert-deftest test-org-element/center-block-interpreter ()
2209 "Test center block interpreter."
2210 (should
2211 (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
2212 "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
2214 (ert-deftest test-org-element/drawer-interpreter ()
2215 "Test drawer interpreter."
2216 (should
2217 (equal (org-test-parse-and-interpret ":TEST:\nTest\n:END:")
2218 ":TEST:\nTest\n:END:\n")))
2220 (ert-deftest test-org-element/dynamic-block-interpreter ()
2221 "Test dynamic block interpreter."
2222 (should
2223 (equal (org-test-parse-and-interpret
2224 "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
2225 "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
2227 (ert-deftest test-org-element/footnote-definition-interpreter ()
2228 "Test footnote definition interpreter."
2229 (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
2231 (ert-deftest test-org-element/headline-interpreter ()
2232 "Test headline and section interpreters."
2233 ;; 1. Standard test.
2234 (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
2235 ;; 2. With TODO keywords.
2236 (should
2237 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2238 (org-test-parse-and-interpret "* TODO Headline"))
2239 "* TODO Headline\n"))
2240 ;; 3. With tags...
2242 ;; 3.1. ... and a positive `org-tags-column' value.
2243 (should
2244 (equal (let ((org-tags-column 20))
2245 (org-test-parse-and-interpret "* Headline :tag:"))
2246 "* Headline :tag:\n"))
2247 ;; 3.2. ... and a negative `org-tags-column' value.
2248 (should
2249 (equal (let ((org-tags-column -20))
2250 (org-test-parse-and-interpret "* Headline :tag:"))
2251 "* Headline :tag:\n"))
2252 ;; 3.3. ... and a null `org-tags-column' value.
2253 (should
2254 (equal (let ((org-tags-column 0))
2255 (org-test-parse-and-interpret "* Headline :tag:"))
2256 "* Headline :tag:\n"))
2257 ;; 4. With priority cookie.
2258 (should
2259 (equal (org-test-parse-and-interpret "* [#B] Headline")
2260 "* [#B] Headline\n"))
2261 ;; 5. With comment keyword.
2262 (should
2263 (equal (let ((org-comment-string "COMMENT"))
2264 (org-test-parse-and-interpret "* COMMENT Headline"))
2265 "* COMMENT Headline\n"))
2266 ;; 6. Keep same number of blank lines before body.
2267 (should
2268 (equal (org-test-parse-and-interpret
2269 "* Headline\n\n\nText after two blank lines.")
2270 "* Headline\n\n\nText after two blank lines.\n"))
2271 ;; 8. Preserve `org-odd-levels-only' state.
2272 (should
2273 (equal "* H\n*** H2\n"
2274 (let ((org-odd-levels-only t))
2275 (org-test-parse-and-interpret "* H\n*** H2")))))
2277 (ert-deftest test-org-element/inlinetask-interpreter ()
2278 "Test inlinetask interpretation."
2279 (when (featurep 'org-inlinetask)
2280 (let ((org-inlinetask-min-level 15))
2281 ;; 1. Regular inlinetask.
2282 (should (equal (org-test-parse-and-interpret
2283 "*************** Task\nTest\n*************** END")
2284 "*************** Task\nTest\n*************** END\n"))
2285 ;; 2. Degenerate inlinetask.
2286 (should (equal (org-test-parse-and-interpret "*************** Task")
2287 "*************** Task\n"))
2288 ;; 3. Prefer degenerate form when there are no contents.
2289 (should (equal (org-test-parse-and-interpret
2290 "*************** Task\n*************** END")
2291 "*************** Task\n"))
2292 ;; 4. With TODO keywords.
2293 (should
2294 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2295 (org-test-parse-and-interpret "*************** TODO Task"))
2296 "*************** TODO Task\n"))
2297 ;; 5. With tags...
2299 ;; 5.1. ... and a positive `org-tags-column' value.
2300 (should
2301 (equal (let ((org-tags-column 30))
2302 (org-test-parse-and-interpret "*************** Task :tag:"))
2303 "*************** Task :tag:\n"))
2304 ;; 5.2. ... and a negative `org-tags-column' value.
2305 (should
2306 (equal (let ((org-tags-column -30))
2307 (org-test-parse-and-interpret "*************** Task :tag:"))
2308 "*************** Task :tag:\n"))
2309 ;; 5.3. ... and a null `org-tags-column' value.
2310 (should
2311 (equal (let ((org-tags-column 0))
2312 (org-test-parse-and-interpret "*************** Task :tag:"))
2313 "*************** Task :tag:\n"))
2314 ;; 6. With priority cookie.
2315 (should
2316 (equal (org-test-parse-and-interpret "*************** [#B] Task")
2317 "*************** [#B] Task\n")))))
2319 (ert-deftest test-org-element/plain-list-interpreter ()
2320 "Test plain-list and item interpreters."
2321 (let ((org-list-two-spaces-after-bullet-regexp nil))
2322 ;; Unordered list.
2323 (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
2324 ;; Description list.
2325 (should
2326 (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
2327 ;; Ordered list.
2328 (should
2329 (equal (let ((org-plain-list-ordered-item-terminator t))
2330 (org-test-parse-and-interpret "1. Item"))
2331 "1. Item\n"))
2332 (should
2333 (equal (let ((org-plain-list-ordered-item-terminator ?\)))
2334 (org-test-parse-and-interpret "1) Item"))
2335 "1) Item\n"))
2336 ;; Ordered list with counter.
2337 (should
2338 (equal (let ((org-plain-list-ordered-item-terminator t))
2339 (org-test-parse-and-interpret "1. [@5] Item"))
2340 "5. [@5] Item\n"))
2341 ;; List with check-boxes.
2342 (should
2343 (equal (org-test-parse-and-interpret
2344 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
2345 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n"))
2346 ;; Item not starting with a paragraph.
2347 (should
2348 (equal (org-test-parse-and-interpret "-\n | a | b |")
2349 "- \n | a | b |\n"))
2350 ;; Special case: correctly handle "*" bullets.
2351 (should (org-test-parse-and-interpret " * item"))
2352 ;; Special case: correctly handle empty items.
2353 (should (org-test-parse-and-interpret "-"))))
2355 (ert-deftest test-org-element/quote-block-interpreter ()
2356 "Test quote block interpreter."
2357 (should (equal (org-test-parse-and-interpret
2358 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
2359 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
2361 (ert-deftest test-org-element/special-block-interpreter ()
2362 "Test special block interpreter."
2363 (should (equal (org-test-parse-and-interpret
2364 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
2365 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
2367 (ert-deftest test-org-element/babel-call-interpreter ()
2368 "Test babel call interpreter."
2369 ;; 1. Without argument.
2370 (should (equal (org-test-parse-and-interpret "#+CALL: test()")
2371 "#+CALL: test()\n"))
2372 ;; 2. With argument.
2373 (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
2374 "#+CALL: test(x=2)\n"))
2375 ;; 3. With header arguments.
2376 (should (equal (org-test-parse-and-interpret
2377 "#+CALL: test[:results output]()[:results html]")
2378 "#+CALL: test[:results output]()[:results html]\n")))
2380 (ert-deftest test-org-element/clock-interpreter ()
2381 "Test clock interpreter."
2382 ;; Running clock.
2383 (should
2384 (string-match
2385 "CLOCK: \\[2012-01-01 .* 00:01\\]"
2386 (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]")))
2387 ;; Closed clock.
2388 (should
2389 (string-match
2390 "CLOCK: \\[2012-01-01 .* 00:01\\]--\\[2012-01-01 .* 00:02\\] => 0:01"
2391 (org-test-parse-and-interpret "
2392 CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))))
2394 (ert-deftest test-org-element/comment-interpreter ()
2395 "Test comment interpreter."
2396 ;; Regular comment.
2397 (should (equal (org-test-parse-and-interpret "# Comment") "# Comment\n"))
2398 ;; Inline comment.
2399 (should (equal (org-test-parse-and-interpret " # Comment")
2400 "# Comment\n"))
2401 ;; Preserve indentation.
2402 (should (equal (org-test-parse-and-interpret " # No blank\n# One blank")
2403 "# No blank\n# One blank\n")))
2405 (ert-deftest test-org-element/comment-block-interpreter ()
2406 "Test comment block interpreter."
2407 (should (equal (org-test-parse-and-interpret
2408 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
2409 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n"))
2410 ;; Accept missing final newline in value.
2411 (should
2412 (equal
2413 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n"
2414 (org-element-interpret-data '(comment-block (:value "Test"))))))
2416 (ert-deftest test-org-element/diary-sexp ()
2417 "Test diary-sexp interpreter."
2418 (should
2419 (equal
2420 (org-test-parse-and-interpret
2421 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old")
2422 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old\n")))
2424 (ert-deftest test-org-element/example-block-interpreter ()
2425 "Test example block interpreter."
2426 ;; Without switches.
2427 (should (equal (org-test-parse-and-interpret
2428 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
2429 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
2430 ;; With switches.
2431 (should
2432 (equal (org-test-parse-and-interpret
2433 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
2434 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n"))
2435 ;; Preserve code escaping.
2436 (should
2437 (equal (org-test-parse-and-interpret
2438 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE")
2439 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE\n"))
2440 ;; Accept missing final newline in value.
2441 (should
2442 (equal
2443 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"
2444 (org-element-interpret-data '(example-block (:value "Test"))))))
2446 (ert-deftest test-org-element/fixed-width-interpreter ()
2447 "Test fixed width interpreter."
2448 ;; Standard test.
2449 (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
2450 ;; Preserve indentation.
2451 (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
2452 ": 2 blanks\n: 1 blank\n"))
2453 ;; Remove last newline character
2454 (should
2455 (equal (org-element-fixed-width-interpreter
2456 '(fixed-width (:value "Test\n")) nil)
2457 ": Test"))
2458 (should
2459 (equal (org-element-fixed-width-interpreter
2460 '(fixed-width (:value "Test")) nil)
2461 ": Test"))
2462 ;; Handle empty string.
2463 (should
2464 (equal (org-element-fixed-width-interpreter
2465 '(fixed-width (:value "")) nil)
2466 ""))
2467 ;; Handle nil value.
2468 (should-not
2469 (org-element-fixed-width-interpreter
2470 '(fixed-width (:value nil)) nil)))
2472 (ert-deftest test-org-element/horizontal-rule-interpreter ()
2473 "Test horizontal rule interpreter."
2474 (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
2476 (ert-deftest test-org-element/keyword-interpreter ()
2477 "Test keyword interpreter."
2478 (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
2479 "#+KEYWORD: value\n")))
2481 (ert-deftest test-org-element/latex-environment-interpreter ()
2482 "Test latex environment interpreter."
2483 (should (equal (org-test-parse-and-interpret
2484 "\\begin{equation}\n1+1=2\n\\end{equation}")
2485 "\\begin{equation}\n1+1=2\n\\end{equation}\n"))
2486 (should (equal (org-test-parse-and-interpret
2487 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}")
2488 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}\n")))
2490 (ert-deftest test-org-element/planning-interpreter ()
2491 "Test planning interpreter."
2492 (should
2493 (string-match
2494 "\\* Headline
2495 DEADLINE: <2012-03-29 .*?> SCHEDULED: <2012-03-29 .*?> CLOSED: \\[2012-03-29 .*?\\]"
2496 (org-test-parse-and-interpret
2497 "* Headline
2498 DEADLINE: <2012-03-29 thu.> SCHEDULED: <2012-03-29 thu.> CLOSED: [2012-03-29 thu.]"))))
2500 (ert-deftest test-org-element/property-drawer-interpreter ()
2501 "Test property drawer interpreter."
2502 (should (equal (let ((org-property-format "%-10s %s"))
2503 (org-test-parse-and-interpret
2504 ":PROPERTIES:\n:prop: value\n:END:"))
2505 ":PROPERTIES:\n:prop: value\n:END:\n")))
2507 (ert-deftest test-org-element/src-block-interpreter ()
2508 "Test src block interpreter."
2509 ;; With arguments.
2510 (should
2511 (equal (let ((org-edit-src-content-indentation 2))
2512 (org-test-parse-and-interpret
2513 "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC"))
2514 "#+BEGIN_SRC emacs-lisp :results silent\n (+ 1 1)\n#+END_SRC\n"))
2515 ;; With switches.
2516 (should
2517 (equal (let ((org-edit-src-content-indentation 2))
2518 (org-test-parse-and-interpret
2519 "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC"))
2520 "#+BEGIN_SRC emacs-lisp -n -k\n (+ 1 1)\n#+END_SRC\n"))
2521 ;; Preserve code escaping.
2522 (should
2523 (equal (let ((org-edit-src-content-indentation 2))
2524 (org-test-parse-and-interpret
2525 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC"))
2526 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC\n"))
2527 ;; Do not apply `org-edit-src-content-indentation' when preserving
2528 ;; indentation.
2529 (should
2530 (equal (let ((org-edit-src-content-indentation 2)
2531 (org-src-preserve-indentation t))
2532 (org-test-parse-and-interpret
2533 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"))
2534 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n"))
2535 (should
2536 (equal (let ((org-edit-src-content-indentation 2)
2537 (org-src-preserve-indentation nil))
2538 (org-test-parse-and-interpret
2539 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"))
2540 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC\n"))
2541 ;; Accept missing final newline in value.
2542 (should
2543 (equal
2544 "#+BEGIN_SRC emacs-lisp\n Test\n#+END_SRC\n"
2545 (let ((org-edit-src-content-indentation 2))
2546 (org-element-interpret-data
2547 '(src-block (:language "emacs-lisp" :value "Test")))))))
2549 (ert-deftest test-org-element/table-interpreter ()
2550 "Test table, table-row and table-cell interpreters."
2551 ;; 1. Simple table.
2552 (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
2553 "| a | b |\n| c | d |\n"))
2554 ;; 2. With horizontal rules.
2555 (should (equal (org-test-parse-and-interpret
2556 "| a | b |\n|---+---|\n| c | d |")
2557 "| a | b |\n|---+---|\n| c | d |\n"))
2558 ;; 3. With meta-data.
2559 (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
2560 "| / | < | > |\n| * | 1 | 2 |\n"))
2561 ;; 4. With a formula.
2562 (should
2563 (equal (org-test-parse-and-interpret
2564 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)")
2565 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)\n"))
2566 ;; 5. With multiple formulas.
2567 (should
2568 (equal (org-test-parse-and-interpret
2569 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2")
2570 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2\n")))
2572 (ert-deftest test-org-element/timestamp-interpreter ()
2573 "Test timestamp interpreter."
2574 ;; Active.
2575 (should
2576 (string-match "<2012-03-29 .* 16:40>"
2577 (org-test-parse-and-interpret "<2012-03-29 thu. 16:40>")))
2578 (should
2579 (string-match "<2012-03-29 .* 16:40>"
2580 (org-element-timestamp-interpreter
2581 '(timestamp
2582 (:type active :year-start 2012 :month-start 3 :day-start 29
2583 :hour-start 16 :minute-start 40)) nil)))
2584 ;; Inactive.
2585 (should
2586 (string-match "\\[2012-03-29 .* 16:40\\]"
2587 (org-test-parse-and-interpret "[2012-03-29 thu. 16:40]")))
2588 (should
2589 (string-match
2590 "\\[2012-03-29 .* 16:40\\]"
2591 (org-element-timestamp-interpreter
2592 '(timestamp
2593 (:type inactive :year-start 2012 :month-start 3 :day-start 29
2594 :hour-start 16 :minute-start 40)) nil)))
2595 ;; Active range.
2596 (should
2597 (string-match "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2598 (org-test-parse-and-interpret
2599 "<2012-03-29 thu. 16:40>--<2012-03-29 thu. 16:41>")))
2600 (should
2601 (string-match
2602 "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2603 (org-element-timestamp-interpreter
2604 '(timestamp
2605 (:type active-range :year-start 2012 :month-start 3 :day-start 29
2606 :hour-start 16 :minute-start 40 :year-end 2012 :month-end 3
2607 :day-end 29 :hour-end 16 :minute-end 41)) nil)))
2608 ;; Inactive range.
2609 (should
2610 (string-match "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2611 (org-test-parse-and-interpret
2612 "[2012-03-29 thu. 16:40]--[2012-03-29 thu. 16:41]")))
2613 (should
2614 (string-match
2615 "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2616 (org-element-timestamp-interpreter
2617 '(timestamp
2618 (:type inactive-range :year-start 2012 :month-start 3 :day-start 29
2619 :hour-start 16 :minute-start 40 :year-end 2012 :month-end 3
2620 :day-end 29 :hour-end 16 :minute-end 41)) nil)))
2621 ;; Diary.
2622 (should (equal (org-test-parse-and-interpret "<%%diary-float t 4 2>")
2623 "<%%diary-float t 4 2>\n"))
2624 ;; Timestamp with repeater interval, with delay, with both.
2625 (should
2626 (string-match "<2012-03-29 .* \\+1y>"
2627 (org-test-parse-and-interpret "<2012-03-29 thu. +1y>")))
2628 (should
2629 (string-match
2630 "<2012-03-29 .* \\+1y>"
2631 (org-element-timestamp-interpreter
2632 '(timestamp
2633 (:type active :year-start 2012 :month-start 3 :day-start 29
2634 :repeater-type cumulate :repeater-value 1 :repeater-unit year))
2635 nil)))
2636 (should
2637 (string-match
2638 "<2012-03-29 .* -1y>"
2639 (org-element-timestamp-interpreter
2640 '(timestamp
2641 (:type active :year-start 2012 :month-start 3 :day-start 29
2642 :warning-type all :warning-value 1 :warning-unit year))
2643 nil)))
2644 (should
2645 (string-match
2646 "<2012-03-29 .* \\+1y -1y>"
2647 (org-element-timestamp-interpreter
2648 '(timestamp
2649 (:type active :year-start 2012 :month-start 3 :day-start 29
2650 :warning-type all :warning-value 1 :warning-unit year
2651 :repeater-type cumulate :repeater-value 1 :repeater-unit year))
2652 nil)))
2653 ;; Timestamp range with repeater interval
2654 (should
2655 (string-match "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2656 (org-test-parse-and-interpret
2657 "<2012-03-29 Thu +1y>--<2012-03-30 Thu +1y>")))
2658 (should
2659 (string-match
2660 "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2661 (org-element-timestamp-interpreter
2662 '(timestamp
2663 (:type active-range :year-start 2012 :month-start 3 :day-start 29
2664 :year-end 2012 :month-end 3 :day-end 30 :repeater-type cumulate
2665 :repeater-value 1 :repeater-unit year))
2666 nil))))
2668 (ert-deftest test-org-element/verse-block-interpreter ()
2669 "Test verse block interpretation."
2670 (should
2671 (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
2672 "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
2674 (ert-deftest test-org-element/bold-interpreter ()
2675 "Test bold interpreter."
2676 (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
2678 (ert-deftest test-org-element/code-interpreter ()
2679 "Test code interpreter."
2680 (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
2682 (ert-deftest test-org-element/entity-interpreter ()
2683 "Test entity interpreter."
2684 ;; 1. Without brackets.
2685 (should
2686 (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
2687 ;; 2. With brackets.
2688 (should
2689 (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
2691 (ert-deftest test-org-element/export-snippet-interpreter ()
2692 "Test export snippet interpreter."
2693 (should (equal (org-test-parse-and-interpret "@@back-end:contents@@")
2694 "@@back-end:contents@@\n")))
2696 (ert-deftest test-org-element/footnote-reference-interpreter ()
2697 "Test footnote reference interpreter."
2698 ;; 1. Regular reference.
2699 (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
2700 ;; 2. Normalized reference.
2701 (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
2702 ;; 3. Named reference.
2703 (should (equal (org-test-parse-and-interpret "Text[fn:label]")
2704 "Text[fn:label]\n"))
2705 ;; 4. Inline reference.
2706 (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
2707 "Text[fn:label:def]\n"))
2708 ;; 5. Anonymous reference.
2709 (should (equal (org-test-parse-and-interpret "Text[fn::def]")
2710 "Text[fn::def]\n")))
2712 (ert-deftest test-org-element/inline-babel-call-interpreter ()
2713 "Test inline babel call interpreter."
2714 ;; 1. Without arguments.
2715 (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
2716 ;; 2. With arguments.
2717 (should (equal (org-test-parse-and-interpret "call_test(x=2)")
2718 "call_test(x=2)\n"))
2719 ;; 3. With header arguments.
2720 (should (equal (org-test-parse-and-interpret
2721 "call_test[:results output]()[:results html]")
2722 "call_test[:results output]()[:results html]\n")))
2724 (ert-deftest test-org-element/inline-src-block-interpreter ()
2725 "Test inline src block interpreter."
2726 ;; 1. Without header argument.
2727 (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
2728 "src_emacs-lisp{(+ 1 1)}\n"))
2729 ;; 2. With header arguments.
2730 (should (equal (org-test-parse-and-interpret
2731 "src_emacs-lisp[:results silent]{(+ 1 1)}")
2732 "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
2734 (ert-deftest test-org-element/italic-interpreter ()
2735 "Test italic interpreter."
2736 (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
2738 (ert-deftest test-org-element/latex-fragment-interpreter ()
2739 "Test latex fragment interpreter."
2740 (should (equal (org-test-parse-and-interpret "\\command{}") "\\command{}\n"))
2741 (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
2742 (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
2743 (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
2744 (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
2745 (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n")))
2747 (ert-deftest test-org-element/line-break-interpreter ()
2748 "Test line break interpreter."
2749 (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
2750 "First line \\\\\nSecond line\n")))
2752 (ert-deftest test-org-element/link-interpreter ()
2753 "Test link interpreter."
2754 ;; 1. Links targeted from a radio target.
2755 (should (equal (let ((org-target-link-regexp "radio-target"))
2756 (org-test-parse-and-interpret "a radio-target"))
2757 "a radio-target\n"))
2758 ;; 2. Regular links.
2760 ;; 2.1. Without description.
2761 (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
2762 "[[http://orgmode.org]]\n"))
2763 ;; 2.2. With a description.
2764 (should (equal (org-test-parse-and-interpret
2765 "[[http://orgmode.org][Org mode]]")
2766 "[[http://orgmode.org][Org mode]]\n"))
2767 ;; 2.3. Id links.
2768 (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
2769 ;; 2.4. Custom-id links.
2770 (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
2771 ;; 2.5 Code-ref links.
2772 (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
2773 ;; 3. Normalize plain links.
2774 (should (equal (org-test-parse-and-interpret "http://orgmode.org")
2775 "[[http://orgmode.org]]\n"))
2776 ;; 4. Normalize angular links.
2777 (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
2778 "[[http://orgmode.org]]\n")))
2780 (ert-deftest test-org-element/macro-interpreter ()
2781 "Test macro interpreter."
2782 ;; 1. Without argument.
2783 (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
2784 ;; 2. With arguments.
2785 (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
2786 "{{{test(arg1,arg2)}}}\n")))
2788 (ert-deftest test-org-element/radio-target-interpreter ()
2789 "Test radio target interpreter."
2790 (should (equal (org-test-parse-and-interpret "<<<some text>>>")
2791 "<<<some text>>>\n")))
2793 (ert-deftest test-org-element/statistics-cookie-interpreter ()
2794 "Test statistics cookie interpreter."
2795 ;; 1. Without percent
2796 (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
2797 ;; 2. With percent.
2798 (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
2800 (ert-deftest test-org-element/strike-through-interpreter ()
2801 "Test strike through interpreter."
2802 (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
2804 (ert-deftest test-org-element/subscript-interpreter ()
2805 "Test subscript 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/superscript-interpreter ()
2812 "Test superscript interpreter."
2813 ;; 1. Without brackets.
2814 (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
2815 ;; 2. With brackets.
2816 (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
2818 (ert-deftest test-org-element/target-interpreter ()
2819 "Test target interpreter."
2820 (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
2822 (ert-deftest test-org-element/underline-interpreter ()
2823 "Test underline interpreter."
2824 (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
2826 (ert-deftest test-org-element/verbatim-interpreter ()
2827 "Test verbatim interpreter."
2828 (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
2832 ;;; Test Granularity
2834 (ert-deftest test-org-element/granularity ()
2835 "Test granularity impact on buffer parsing."
2836 (org-test-with-temp-text "
2837 * Head 1
2838 ** Head 2
2839 #+BEGIN_CENTER
2840 Centered paragraph.
2841 #+END_CENTER
2842 Paragraph \\alpha."
2843 ;; 1.1. Granularity set to `headline' should parse every headline
2844 ;; in buffer, and only them.
2845 (let ((tree (org-element-parse-buffer 'headline)))
2846 (should (= 2 (length (org-element-map tree 'headline 'identity))))
2847 (should-not (org-element-map tree 'paragraph 'identity)))
2848 ;; 1.2. Granularity set to `greater-element' should not enter
2849 ;; greater elements excepted headlines and sections.
2850 (let ((tree (org-element-parse-buffer 'greater-element)))
2851 (should (= 1 (length (org-element-map tree 'center-block 'identity))))
2852 (should (= 1 (length (org-element-map tree 'paragraph 'identity))))
2853 (should-not (org-element-map tree 'entity 'identity)))
2854 ;; 1.3. Granularity set to `element' should enter every
2855 ;; greater-element.
2856 (let ((tree (org-element-parse-buffer 'element)))
2857 (should (= 2 (length (org-element-map tree 'paragraph 'identity))))
2858 (should-not (org-element-map tree 'entity 'identity)))
2859 ;; 1.4. Granularity set to `object' can see everything.
2860 (let ((tree (org-element-parse-buffer 'object)))
2861 (should (= 1 (length (org-element-map tree 'entity 'identity)))))))
2863 (ert-deftest test-org-element/secondary-string-parsing ()
2864 "Test if granularity correctly toggles secondary strings parsing."
2865 ;; With a granularity bigger than `object', no secondary string
2866 ;; should be parsed.
2867 (should
2868 (stringp
2869 (org-test-with-temp-text "* Headline"
2870 (let ((headline
2871 (org-element-map (org-element-parse-buffer 'headline) 'headline
2872 #'identity nil 'first-match)))
2873 (org-element-property :title headline)))))
2874 (should
2875 (stringp
2876 (org-test-with-temp-text "* Headline\n- tag :: item"
2877 (let ((item (org-element-map (org-element-parse-buffer 'element) 'item
2878 #'identity nil 'first-match)))
2879 (org-element-property :tag item)))))
2880 (when (featurep 'org-inlinetask)
2881 (should
2882 (stringp
2883 (let ((org-inlinetask-min-level 15))
2884 (org-test-with-temp-text "*************** Inlinetask"
2885 (let ((inlinetask (org-element-map (org-element-parse-buffer 'element)
2886 'inlinetask
2887 #'identity nil 'first-match)))
2888 (org-element-property :title inlinetask)))))))
2889 ;; With a default granularity, secondary strings should be parsed.
2890 (should
2891 (listp
2892 (org-test-with-temp-text "* Headline"
2893 (let ((headline
2894 (org-element-map (org-element-parse-buffer) 'headline
2895 #'identity nil 'first-match)))
2896 (org-element-property :title headline)))))
2897 ;; `org-element-at-point' should never parse a secondary string.
2898 (should-not
2899 (listp
2900 (org-test-with-temp-text "* Headline"
2901 (org-element-property :title (org-element-at-point)))))
2902 ;; Preserve current local variables when parsing a secondary string.
2903 (should
2904 (let ((org-entities nil)
2905 (org-entities-user nil))
2906 (org-test-with-temp-text "
2907 #+CAPTION: \\foo
2908 Text
2909 # Local Variables:
2910 # org-entities-user: ((\"foo\"))
2911 # End:"
2912 (let ((safe-local-variable-values '((org-entities-user . (("foo"))))))
2913 (hack-local-variables))
2914 (org-element-map (org-element-parse-buffer) 'entity
2915 #'identity nil nil nil t)))))
2919 ;;; Test Visible Only Parsing
2921 (ert-deftest test-org-element/parse-buffer-visible ()
2922 "Test `org-element-parse-buffer' with visible only argument."
2923 (should
2924 (equal '("H1" "H3" "H5")
2925 (org-test-with-temp-text
2926 "* H1\n** H2\n** H3 :visible:\n** H4\n** H5 :visible:"
2927 (org-occur ":visible:")
2928 (org-element-map (org-element-parse-buffer nil t) 'headline
2929 (lambda (hl) (org-element-property :raw-value hl)))))))
2933 ;;; Test `:parent' Property
2935 (ert-deftest test-org-element/parent-property ()
2936 "Test `:parent' property."
2937 ;; Elements.
2938 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
2939 (let* ((tree (org-element-parse-buffer))
2940 (parent (org-element-property
2941 :parent
2942 (org-element-map tree 'paragraph 'identity nil t))))
2943 (should parent)
2944 (should (eq (org-element-map tree 'center-block 'identity nil t)
2945 parent))))
2946 ;; Objects.
2947 (org-test-with-temp-text "a_{/b/}"
2948 (let* ((tree (org-element-parse-buffer))
2949 (parent (org-element-property
2950 :parent
2951 (org-element-map tree 'italic 'identity nil t))))
2952 (should parent)
2953 (should (eq parent
2954 (org-element-map tree 'subscript 'identity nil t)))))
2955 ;; Secondary strings
2956 (org-test-with-temp-text "* /italic/"
2957 (let* ((tree (org-element-parse-buffer))
2958 (parent (org-element-property
2959 :parent (org-element-map tree 'italic 'identity nil t))))
2960 (should parent)
2961 (should (eq parent
2962 (org-element-map tree 'headline 'identity nil t))))))
2966 ;;; Test Normalize Contents
2968 (ert-deftest test-org-element/normalize-contents ()
2969 "Test `org-element-normalize-contents' specifications."
2970 ;; Remove maximum common indentation from element's contents.
2971 (should
2972 (equal
2973 (org-element-normalize-contents
2974 '(paragraph nil " Two spaces\n Three spaces"))
2975 '(paragraph nil "Two spaces\n Three spaces")))
2976 ;; Ignore objects within contents when computing maximum common
2977 ;; indentation.
2978 (should
2979 (equal
2980 (org-element-normalize-contents
2981 '(paragraph nil " One " (emphasis nil "space") "\n Two spaces"))
2982 '(paragraph nil "One " (emphasis nil "space") "\n Two spaces")))
2983 ;; Ignore blank lines.
2984 (should
2985 (equal
2986 (org-element-normalize-contents
2987 '(paragraph nil " Two spaces\n\n \n Two spaces"))
2988 '(paragraph nil "Two spaces\n\n \nTwo spaces")))
2989 (should
2990 (equal
2991 '(paragraph nil " Two spaces\n" (verbatim nil "V") "\n Two spaces")
2992 (org-element-normalize-contents
2993 '(paragraph nil " Two spaces\n " (verbatim nil "V") "\n Two spaces"))))
2994 (should
2995 (equal
2996 '(verse-block nil "line 1\n\nline 2")
2997 (org-element-normalize-contents
2998 '(verse-block nil " line 1\n\n line 2"))))
2999 ;; Recursively enter objects in order to compute common indentation.
3000 (should
3001 (equal
3002 (org-element-normalize-contents
3003 '(paragraph nil " Two spaces " (bold nil " and\n One space")))
3004 '(paragraph nil " Two spaces " (bold nil " and\nOne space"))))
3005 ;; When optional argument is provided, ignore first line
3006 ;; indentation.
3007 (should
3008 (equal
3009 (org-element-normalize-contents
3010 '(paragraph nil "No space\n Two spaces\n Three spaces") t)
3011 '(paragraph nil "No space\nTwo spaces\n Three spaces"))))
3015 ;;; Test Navigation Tools.
3017 (ert-deftest test-org-element/at-point ()
3018 "Test `org-element-at-point' specifications."
3019 ;; Return closest element containing point.
3020 (should
3021 (eq 'paragraph
3022 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
3023 (progn (search-forward "A")
3024 (org-element-type (org-element-at-point))))))
3025 ;; Correctly set `:parent' property.
3026 (should
3027 (eq 'center-block
3028 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
3029 (progn (search-forward "A")
3030 (org-element-type
3031 (org-element-property :parent (org-element-at-point)))))))
3032 ;; Special case: at a blank line just below a headline, return that
3033 ;; headline.
3034 (should
3035 (equal "H1" (org-test-with-temp-text "* H1\n \n* H2\n"
3036 (forward-line)
3037 (org-element-property :title (org-element-at-point)))))
3038 ;; Special case: at the very beginning of a table, return `table'
3039 ;; object instead of `table-row'.
3040 (should
3041 (eq 'table
3042 (org-test-with-temp-text "| a | b |"
3043 (org-element-type (org-element-at-point)))))
3044 ;; Special case: at the very beginning of a list or sub-list, return
3045 ;; `plain-list' object instead of `item'.
3046 (should
3047 (eq 'plain-list
3048 (org-test-with-temp-text "- item"
3049 (org-element-type (org-element-at-point)))))
3050 ;; Special case: at the closing line of a greater element, be sure
3051 ;; to return it instead of the last element in its contents.
3052 (should
3053 (eq 'center-block
3054 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph\n#+END_CENTER"
3055 (progn (forward-line 2)
3056 (org-element-type (org-element-at-point))))))
3057 ;; Special case: at a blank line between two items, be sure to
3058 ;; return item above instead of the last element of its contents.
3059 (should
3060 (eq 'item
3061 (org-test-with-temp-text "- Para1\n\n- Para2"
3062 (progn (forward-line)
3063 (org-element-type
3064 (let ((org-list-empty-line-terminates-plain-lists nil))
3065 (org-element-at-point)))))))
3066 ;; Special case: at the last blank line in a plain list, return it
3067 ;; instead of the last item.
3068 (should
3069 (eq 'plain-list
3070 (org-test-with-temp-text "- Para1\n- Para2\n\nPara3"
3071 (progn (forward-line 2)
3072 (org-element-type (org-element-at-point))))))
3073 ;; Special case: when a list ends at the end of buffer and there's
3074 ;; no final newline, return last element in last item.
3075 (should
3076 (eq 'paragraph
3077 (org-test-with-temp-text "- a"
3078 (end-of-line)
3079 (org-element-type (org-element-at-point)))))
3080 ;; Parse a list within a block itself contained in a list.
3081 (should
3082 (eq 'plain-list
3083 (org-test-with-temp-text
3084 "- outer\n #+begin_center\n - inner\n #+end_center"
3085 (search-forward "inner")
3086 (beginning-of-line)
3087 (org-element-type (org-element-at-point)))))
3088 ;; Do not error at eob on an empty line.
3089 (should
3090 (org-test-with-temp-text "* H\n"
3091 (forward-line)
3092 (or (org-element-at-point) t))))
3094 (ert-deftest test-org-element/context ()
3095 "Test `org-element-context' specifications."
3096 ;; Return closest object containing point.
3097 (should
3098 (eq 'underline
3099 (org-test-with-temp-text "Some *text with _underline_ text*"
3100 (progn (search-forward "under")
3101 (org-element-type (org-element-context))))))
3102 ;; Find objects in secondary strings.
3103 (should
3104 (eq 'underline
3105 (org-test-with-temp-text "* Headline _with_ underlining"
3106 (progn (search-forward "w")
3107 (org-element-type (org-element-context))))))
3108 ;; Find objects in objects.
3109 (should
3110 (eq 'macro
3111 (org-test-with-temp-text "| a | {{{macro}}} |"
3112 (progn (search-forward "{")
3113 (org-element-type (org-element-context))))))
3114 (should
3115 (eq 'table-cell
3116 (org-test-with-temp-text "| a | b {{{macro}}} |"
3117 (progn (search-forward "b")
3118 (org-element-type (org-element-context))))))
3119 ;; Find objects in planning lines.
3120 (should
3121 (eq 'timestamp
3122 (org-test-with-temp-text "* H\n SCHEDULED: <2012-03-29 thu.>"
3123 (search-forward "2012")
3124 (org-element-type (org-element-context)))))
3125 (should-not
3126 (eq 'timestamp
3127 (org-test-with-temp-text "* H\n SCHEDULED: <2012-03-29 thu.>"
3128 (search-forward "SCHEDULED")
3129 (org-element-type (org-element-context)))))
3130 ;; Find objects in document keywords.
3131 (should
3132 (eq 'macro
3133 (org-test-with-temp-text "#+DATE: {{{macro}}}"
3134 (progn (search-forward "{")
3135 (org-element-type (org-element-context))))))
3136 ;; Do not find objects in table rules.
3137 (should
3138 (eq 'table-row
3139 (org-test-with-temp-text "| a | b |\n+---+---+\n| c | d |"
3140 (forward-line)
3141 (org-element-type (org-element-context)))))
3142 ;; Find objects in parsed affiliated keywords.
3143 (should
3144 (eq 'macro
3145 (org-test-with-temp-text "#+CAPTION: {{{macro}}}\n| a | b |."
3146 (progn (search-forward "{")
3147 (org-element-type (org-element-context))))))
3148 (should
3149 (eq 'bold
3150 (org-test-with-temp-text "#+caption: *bold*\nParagraph"
3151 (progn (search-forward "*")
3152 (org-element-type (org-element-context))))))
3153 ;; Find objects at the end of buffer.
3154 (should
3155 (eq 'bold
3156 (org-test-with-temp-text "*bold*"
3157 (goto-char (point-max))
3158 (org-element-type (org-element-context)))))
3159 ;; Correctly set `:parent' property.
3160 (should
3161 (eq 'paragraph
3162 (org-test-with-temp-text "Some *bold* text"
3163 (progn (search-forward "bold")
3164 (org-element-type
3165 (org-element-property :parent (org-element-context)))))))
3166 ;; Between two objects, return the second one.
3167 (should
3168 (eq 'macro
3169 (org-test-with-temp-text "<<target>>{{{test}}}"
3170 (progn (search-forward "{")
3171 (backward-char)
3172 (org-element-type (org-element-context))))))
3173 ;; Test optional argument.
3174 (should
3175 (eq 'underline
3176 (org-test-with-temp-text "Some *text with _underline_ text*"
3177 (progn
3178 (search-forward "under")
3179 (org-element-type (org-element-context (org-element-at-point)))))))
3180 ;; Special case: bold object at the beginning of a headline.
3181 (should
3182 (eq 'bold
3183 (org-test-with-temp-text "* *bold*"
3184 (search-forward "bo")
3185 (org-element-type (org-element-context)))))
3186 ;; Special case: incomplete cell at the end of a table row.
3187 (should
3188 (eq 'table-cell
3189 (org-test-with-temp-text "|a|b|c"
3190 (goto-char (point-max))
3191 (org-element-type (org-element-context)))))
3192 ;; Special case: objects in inline footnotes.
3193 (should
3194 (eq 'link
3195 (org-test-with-temp-text "[fn::[[<point>http://orgmode.org]]]"
3196 (org-element-type (org-element-context))))))
3200 ;;; Test Cache.
3202 (ert-deftest test-org-element/cache ()
3203 "Test basic expectations and common pitfalls for cache."
3204 ;; Shift positions.
3205 (should
3206 (equal '(18 . 23)
3207 (org-test-with-temp-text "para1\n\npara2\n\npara3"
3208 (let ((org-element-use-cache t))
3209 (save-excursion (goto-char (point-max)) (org-element-at-point))
3210 (insert "add")
3211 (forward-line 4)
3212 (let ((element (org-element-at-point)))
3213 (cons (org-element-property :begin element)
3214 (org-element-property :end element)))))))
3215 ;; Partial shifting: when the contents of a greater element are
3216 ;; modified, only shift ending positions.
3217 (should
3218 (org-test-with-temp-text
3219 "#+BEGIN_CENTER\nPara1\n\nPara2\n\nPara3\n#+END_CENTER"
3220 (let ((org-element-use-cache t))
3221 (save-excursion (search-forward "3") (org-element-at-point))
3222 (search-forward "Para2")
3223 (insert " ")
3224 (let ((element (org-element-property :parent (org-element-at-point))))
3225 (equal (cons (org-element-property :begin element)
3226 (org-element-property :end element))
3227 (cons (point-min) (point-max)))))))
3228 ;; Re-parent shifted elements.
3229 (should
3230 (eq 'item
3231 (org-test-with-temp-text "- item\n\n\n para1\n para2"
3232 (let ((org-element-use-cache t))
3233 (end-of-line)
3234 (org-element-at-point)
3235 (save-excursion (goto-char (point-max)) (org-element-at-point))
3236 (forward-line)
3237 (delete-char 1)
3238 (goto-char (point-max))
3239 (org-element-type
3240 (org-element-property :parent (org-element-at-point)))))))
3241 ;; Preserve local structures when re-parenting.
3242 (should
3243 (eq 'table
3244 (org-test-with-temp-text
3245 "#+begin_center\nP0\n\n<point>\n\n P1\n | a | b |\n| c | d |\n#+end_center"
3246 (let ((org-element-use-cache t))
3247 (save-excursion (search-forward "| c |") (org-element-at-point))
3248 (insert "- item")
3249 (search-forward "| c |")
3250 (beginning-of-line)
3251 (org-element-type
3252 (org-element-property :parent (org-element-at-point)))))))
3253 (should-not
3254 (eq 'center-block
3255 (org-test-with-temp-text
3256 "#+begin_center\nP0\n\n<point>\n\n P1\n | a | b |\n#+end_center"
3257 (let ((org-element-use-cache t))
3258 (save-excursion (search-forward "| a |") (org-element-at-point))
3259 (insert "- item")
3260 (search-forward "| a |")
3261 (beginning-of-line)
3262 (org-element-type
3263 (org-element-property :parent (org-element-at-point)))))))
3264 ;; When re-parenting, also propagate changes to list structures.
3265 (should
3266 (= 2
3267 (org-test-with-temp-text "\n Para\n - item<point>"
3268 (let ((org-element-use-cache t))
3269 (org-element-at-point)
3270 (goto-char (point-min))
3271 (insert "- Top\n")
3272 (search-forward "- item")
3273 (beginning-of-line)
3274 (length (org-element-property :structure (org-element-at-point)))))))
3275 ;; Modifying the last line of an element alters the element below.
3276 (should
3277 (org-test-with-temp-text "para1\n\npara2"
3278 (let ((org-element-use-cache t))
3279 (goto-char (point-max))
3280 (org-element-at-point)
3281 (forward-line -1)
3282 (insert "merge")
3283 (let ((element (org-element-at-point)))
3284 (equal (cons (org-element-property :begin element)
3285 (org-element-property :end element))
3286 (cons (point-min) (point-max)))))))
3287 ;; Modifying the first line of an element alters the element above.
3288 (should
3289 (org-test-with-temp-text ": fixed-width\n:not-fixed-width"
3290 (let ((org-element-use-cache t))
3291 (goto-char (point-max))
3292 (org-element-at-point)
3293 (search-backward ":")
3294 (forward-char)
3295 (insert " ")
3296 (let ((element (org-element-at-point)))
3297 (equal (cons (org-element-property :begin element)
3298 (org-element-property :end element))
3299 (cons (point-min) (point-max)))))))
3300 ;; Sensitive change: adding a line alters document structure both
3301 ;; above and below.
3302 (should
3303 (eq 'example-block
3304 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n"
3305 (let ((org-element-use-cache t))
3306 (goto-char (point-max))
3307 (org-element-at-point)
3308 (insert "#+END_EXAMPLE")
3309 (search-backward "Para1")
3310 (org-element-type (org-element-at-point))))))
3311 (should
3312 (eq 'example-block
3313 (org-test-with-temp-text "Para1\n\nPara2\n#+END_EXAMPLE"
3314 (let ((org-element-use-cache t))
3315 (save-excursion (goto-char (point-max)) (org-element-at-point))
3316 (insert "#+BEGIN_EXAMPLE\n")
3317 (search-forward "Para2")
3318 (org-element-type (org-element-at-point))))))
3319 ;; Sensitive change: removing a line alters document structure both
3320 ;; above and below.
3321 (should
3322 (eq 'example-block
3323 (org-test-with-temp-text
3324 "# +BEGIN_EXAMPLE\nPara1\n\nPara2\n#+END_EXAMPLE"
3325 (let ((org-element-use-cache t))
3326 (save-excursion (goto-char (point-max)) (org-element-at-point))
3327 (forward-char)
3328 (delete-char 1)
3329 (search-forward "Para2")
3330 (org-element-type (org-element-at-point))))))
3331 (should
3332 (eq 'example-block
3333 (org-test-with-temp-text
3334 "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n# +END_EXAMPLE"
3335 (let ((org-element-use-cache t))
3336 (save-excursion (goto-char (point-max)) (org-element-at-point))
3337 (search-forward "# ")
3338 (delete-char -1)
3339 (search-backward "Para1")
3340 (org-element-type (org-element-at-point)))))))
3343 (provide 'test-org-element)
3345 ;;; test-org-element.el ends here