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