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