org-clone-subtree-with-time-shift: Fix SHIFT check
[org-mode.git] / testing / lisp / test-org-element.el
blobdc3316281af73940fd8c816633e4e855ffe08e87
1 ;;; test-org-element.el --- Tests for org-element.el
3 ;; Copyright (C) 2012-2015 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/class ()
144 "Test `org-element-class' specifications."
145 ;; Regular tests.
146 (should (eq 'element (org-element-class '(paragraph nil) nil)))
147 (should (eq 'object (org-element-class '(target nil) nil)))
148 ;; Special types.
149 (should (eq 'element (org-element-class '(org-data nil) nil)))
150 (should (eq 'object (org-element-class "text" nil)))
151 (should (eq 'object (org-element-class '("secondary " "string") nil)))
152 ;; Pseudo elements.
153 (should (eq 'element (org-element-class '(foo nil) nil)))
154 (should (eq 'element (org-element-class '(foo nil) '(center-block nil))))
155 (should (eq 'element (org-element-class '(foo nil) '(org-data nil))))
156 ;; Pseudo objects.
157 (should (eq 'object (org-element-class '(foo nil) '(bold nil))))
158 (should (eq 'object (org-element-class '(foo nil) '(paragraph nil))))
159 (should (eq 'object (org-element-class '(foo nil) '("secondary"))))
160 (should
161 (eq 'object
162 (let* ((datum '(foo nil))
163 (headline `(headline (:title (,datum)))))
164 (org-element-put-property datum :parent headline)
165 (org-element-class datum)))))
167 (ert-deftest test-org-element/adopt-elements ()
168 "Test `org-element-adopt-elements' specifications."
169 ;; Adopt an element.
170 (should
171 (equal '(plain-text italic)
172 (org-test-with-temp-text "* Headline\n *a*"
173 (let ((tree (org-element-parse-buffer)))
174 (org-element-adopt-elements
175 (org-element-map tree 'bold 'identity nil t) '(italic nil "a"))
176 (mapcar (lambda (blob) (org-element-type blob))
177 (org-element-contents
178 (org-element-map tree 'bold 'identity nil t)))))))
179 ;; Adopt a string.
180 (should
181 (equal '("a" "b")
182 (org-test-with-temp-text "* Headline\n *a*"
183 (let ((tree (org-element-parse-buffer)))
184 (org-element-adopt-elements
185 (org-element-map tree 'bold 'identity nil t) "b")
186 (org-element-contents
187 (org-element-map tree 'bold 'identity nil t)))))))
189 (ert-deftest test-org-element/extract-element ()
190 "Test `org-element-extract-element' specifications."
191 ;; Extract a greater element.
192 (should
193 (equal '(org-data nil)
194 (org-test-with-temp-text "* Headline"
195 (let* ((tree (org-element-parse-buffer))
196 (element (org-element-map tree 'headline 'identity nil t)))
197 (org-element-extract-element element)
198 tree))))
199 ;; Extract an element.
200 (should-not
201 (org-element-map
202 (org-test-with-temp-text "Paragraph"
203 (let* ((tree (org-element-parse-buffer))
204 (element (org-element-map tree 'paragraph 'identity nil t)))
205 (org-element-extract-element element)
206 tree))
207 'paragraph
208 'identity))
209 ;; Extract an object, even in a secondary string.
210 (should-not
211 (org-element-map
212 (org-test-with-temp-text "*bold*"
213 (let* ((tree (org-element-parse-buffer))
214 (element (org-element-map tree 'bold 'identity nil t)))
215 (org-element-extract-element element)
216 tree))
217 'bold
218 'identity))
219 (should-not
220 (org-element-map
221 (org-test-with-temp-text "* Headline *bold*"
222 (let* ((tree (org-element-parse-buffer))
223 (element (org-element-map tree 'bold 'identity nil t)))
224 (org-element-extract-element element)
225 tree))
226 'bold
227 'identity))
228 ;; Return value doesn't have any :parent set.
229 (should-not
230 (org-element-property
231 :parent
232 (org-test-with-temp-text "* Headline\n Paragraph with *bold* text."
233 (let* ((tree (org-element-parse-buffer))
234 (element (org-element-map tree 'bold 'identity nil t)))
235 (org-element-extract-element element))))))
237 (ert-deftest test-org-element/insert-before ()
238 "Test `org-element-insert-before' specifications."
239 ;; Standard test.
240 (should
241 (equal
242 '(italic entity bold)
243 (org-test-with-temp-text "/some/ *paragraph*"
244 (let* ((tree (org-element-parse-buffer))
245 (paragraph (org-element-map tree 'paragraph 'identity nil t))
246 (bold (org-element-map tree 'bold 'identity nil t)))
247 (org-element-insert-before '(entity (:name "\\alpha")) bold)
248 (org-element-map tree '(bold entity italic) #'org-element-type nil)))))
249 ;; Insert an object in a secondary string.
250 (should
251 (equal
252 '(entity italic)
253 (org-test-with-temp-text "* /A/\n Paragraph."
254 (let* ((tree (org-element-parse-buffer))
255 (headline (org-element-map tree 'headline 'identity nil t))
256 (italic (org-element-map tree 'italic 'identity nil t)))
257 (org-element-insert-before '(entity (:name "\\alpha")) italic)
258 (org-element-map (org-element-property :title headline) '(entity italic)
259 #'org-element-type))))))
261 (ert-deftest test-org-element/set-element ()
262 "Test `org-element-set-element' specifications."
263 ;; Check if new element is inserted.
264 (should
265 (org-test-with-temp-text "* Headline\n*a*"
266 (let* ((tree (org-element-parse-buffer))
267 (bold (org-element-map tree 'bold 'identity nil t)))
268 (org-element-set-element bold '(italic nil "b"))
269 (org-element-map tree 'italic 'identity))))
270 ;; Check if old element is removed.
271 (should-not
272 (org-test-with-temp-text "* Headline\n*a*"
273 (let* ((tree (org-element-parse-buffer))
274 (bold (org-element-map tree 'bold 'identity nil t)))
275 (org-element-set-element bold '(italic nil "b"))
276 (org-element-map tree 'bold 'identity))))
277 ;; Check if :parent property is correctly set.
278 (should
279 (eq 'paragraph
280 (org-test-with-temp-text "* Headline\n*a*"
281 (let* ((tree (org-element-parse-buffer))
282 (bold (org-element-map tree 'bold 'identity nil t)))
283 (org-element-set-element bold '(italic nil "b"))
284 (org-element-type
285 (org-element-property
286 :parent (org-element-map tree 'italic 'identity nil t)))))))
287 ;; Allow to replace strings with elements.
288 (should
289 (equal '("b")
290 (org-test-with-temp-text "* Headline"
291 (let* ((tree (org-element-parse-buffer))
292 (text (org-element-map tree 'plain-text 'identity nil t)))
293 (org-element-set-element text (list 'bold nil "b"))
294 (org-element-map tree 'plain-text 'identity)))))
295 ;; Allow to replace elements with strings.
296 (should
297 (equal "a"
298 (org-test-with-temp-text "* =verbatim="
299 (let* ((tree (org-element-parse-buffer))
300 (verb (org-element-map tree 'verbatim 'identity nil t)))
301 (org-element-set-element verb "a")
302 (org-element-map tree 'plain-text 'identity nil t)))))
303 ;; Allow to replace strings with strings.
304 (should
305 (equal "b"
306 (org-test-with-temp-text "a"
307 (let* ((tree (org-element-parse-buffer))
308 (text (org-element-map tree 'plain-text 'identity nil t)))
309 (org-element-set-element text "b")
310 (org-element-map tree 'plain-text 'identity nil t))))))
312 (ert-deftest test-org-element/copy ()
313 "Test `org-element-copy' specifications."
314 ;; Preserve type.
315 (should (eq 'bold
316 (org-test-with-temp-text "*bold*"
317 (org-element-type (org-element-copy (org-element-context))))))
318 (should (eq 'plain-text
319 (org-test-with-temp-text "*bold*"
320 (org-element-type
321 (org-element-map (org-element-parse-buffer) 'plain-text
322 #'org-element-copy nil t)))))
323 ;; Preserve properties except `:parent'.
324 (should (= 7
325 (org-test-with-temp-text "*bold*"
326 (org-element-property
327 :end (org-element-copy (org-element-context))))))
328 (should-not
329 (org-test-with-temp-text "*bold*"
330 (org-element-property
331 :parent (org-element-copy (org-element-context)))))
332 (should-not
333 (org-test-with-temp-text "*bold*"
334 (org-element-property
335 :parent
336 (org-element-map (org-element-parse-buffer) 'plain-text
337 #'org-element-copy nil t))))
338 ;; Copying nil returns nil.
339 (should-not (org-element-copy nil))
340 ;; Return a copy secondary strings.
341 (should (equal '("text") (org-element-copy '("text"))))
342 (should-not (eq '("text") (org-element-copy '("text")))))
346 ;;; Test Parsers
348 ;;;; Affiliated Keywords
350 (ert-deftest test-org-element/affiliated-keywords-parser ()
351 "Test affiliated keywords parsing."
352 ;; Read simple keywords.
353 (should
354 (equal "para"
355 (org-element-property
356 :name
357 (org-test-with-temp-text "#+NAME: para\nParagraph"
358 (org-element-at-point)))))
359 (should
360 (= 1
361 (org-element-property
362 :begin
363 (org-test-with-temp-text "#+NAME: para\nParagraph"
364 (org-element-at-point)))))
365 ;; Parse multiple keywords.
366 (should
367 (equal
368 '("line2" "line1")
369 (org-element-property
370 :attr_ascii
371 (org-test-with-temp-text
372 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph"
373 (org-element-at-point)))))
374 ;; Parse "parsed" keywords.
375 (should
376 (equal
377 '(("caption"))
378 (org-test-with-temp-text "#+CAPTION: caption\nParagraph"
379 (car (org-element-property :caption (org-element-at-point))))))
380 ;; Parse dual keywords.
381 (should
382 (equal
383 '((("long") "short"))
384 (org-test-with-temp-text "#+CAPTION[short]: long\nParagraph"
385 (org-element-property :caption (org-element-at-point)))))
386 ;; Allow multiple caption keywords.
387 (should
388 (equal
389 '((("l2") "s2") (("l1") "s1"))
390 (org-test-with-temp-text "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph"
391 (org-element-property :caption (org-element-at-point)))))
392 (should
393 (equal
394 '((("l1")) (nil "s1"))
395 (org-test-with-temp-text "#+CAPTION[s1]:\n#+CAPTION: l1\nParagraph"
396 (org-element-property :caption (org-element-at-point)))))
397 ;; Corner case: orphaned keyword at the end of an element.
398 (should
399 (eq 'keyword
400 (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
401 (progn (search-forward "name")
402 (org-element-type (org-element-at-point))))))
403 (should-not
404 (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
405 (progn (search-forward "Some")
406 (org-element-property :name (org-element-at-point))))))
409 ;;;; Babel Call
411 (ert-deftest test-org-element/babel-call-parser ()
412 "Test `babel-call' parsing."
413 ;; Standard test.
414 (should
415 (eq 'babel-call
416 (org-test-with-temp-text "#+CALL: test()"
417 (org-element-type (org-element-at-point)))))
418 ;; Ignore case.
419 (should
420 (eq 'babel-call
421 (org-test-with-temp-text "#+call: test()"
422 (org-element-type (org-element-at-point)))))
423 ;; Handle non-empty blank line at the end of buffer.
424 (should
425 (org-test-with-temp-text "#+CALL: test()\n "
426 (= (org-element-property :end (org-element-at-point)) (point-max))))
427 ;; Parse call name.
428 (should
429 (equal "test"
430 (org-test-with-temp-text "#+CALL: test()"
431 (org-element-property :call (org-element-at-point)))))
432 ;; Parse inside header.
433 (should
434 (equal ":results output"
435 (org-test-with-temp-text "#+CALL: test[:results output]()"
436 (org-element-property :inside-header (org-element-at-point)))))
437 ;; Parse arguments, which can be nested.
438 (should
439 (equal "n=4"
440 (org-test-with-temp-text "#+CALL: test(n=4)"
441 (org-element-property :arguments (org-element-at-point)))))
442 (should
443 (equal "test()"
444 (org-test-with-temp-text "#+CALL: test(test())"
445 (org-element-property :arguments (org-element-at-point)))))
446 ;; Parse end header.
447 (should
448 (equal ":results html"
449 (org-test-with-temp-text "#+CALL: test() :results html"
450 (org-element-property :end-header (org-element-at-point))))))
453 ;;;; Bold
455 (ert-deftest test-org-element/bold-parser ()
456 "Test `bold' parser."
457 ;; Standard test.
458 (should
459 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
460 (org-test-with-temp-text "*bold*"
461 (org-element-map (org-element-parse-buffer) 'bold 'identity nil t))))
462 ;; Multi-line markup.
463 (should
464 (equal
465 (org-element-contents
466 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
467 (org-test-with-temp-text "*first line\nsecond line*"
468 (org-element-map (org-element-parse-buffer) 'bold 'identity nil t))))
469 '("first line\nsecond line"))))
472 ;;;; Center Block
474 (ert-deftest test-org-element/center-block-parser ()
475 "Test `center-block' parser."
476 ;; Standard test.
477 (should
478 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
479 (org-element-map (org-element-parse-buffer) 'center-block 'identity)))
480 ;; Ignore case.
481 (should
482 (org-test-with-temp-text "#+begin_center\nText\n#+end_center"
483 (org-element-map (org-element-parse-buffer) 'center-block 'identity)))
484 ;; Ignore incomplete block.
485 (should-not
486 (org-test-with-temp-text "#+BEGIN_CENTER"
487 (org-element-map (org-element-parse-buffer) 'center-block
488 'identity nil t)))
489 ;; Handle non-empty blank line at the end of buffer.
490 (should
491 (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
492 (= (org-element-property :end (org-element-at-point)) (point-max)))))
495 ;;;; Clock
497 (ert-deftest test-org-element/clock-parser ()
498 "Test `clock' parser."
499 ;; Running clock.
500 (let ((clock (org-test-with-temp-text "CLOCK: [2012-01-01 sun. 00:01]"
501 (org-element-at-point))))
502 (should (eq (org-element-property :status clock) 'running))
503 (should
504 (equal (org-element-property :raw-value
505 (org-element-property :value clock))
506 "[2012-01-01 sun. 00:01]"))
507 (should-not (org-element-property :duration clock)))
508 ;; Closed clock.
509 (let ((clock
510 (org-test-with-temp-text
511 "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"
512 (org-element-at-point))))
513 (should (eq (org-element-property :status clock) 'closed))
514 (should (equal (org-element-property :raw-value
515 (org-element-property :value clock))
516 "[2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02]"))
517 (should (equal (org-element-property :duration clock) "0:01"))))
520 ;;;; Code
522 (ert-deftest test-org-element/code-parser ()
523 "Test `code' parser."
524 ;; Regular test.
525 (should
526 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
527 (org-test-with-temp-text "~code~"
528 (org-element-map (org-element-parse-buffer) 'code 'identity))))
529 ;; Multi-line markup.
530 (should
531 (equal
532 (org-element-property
533 :value
534 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
535 (org-test-with-temp-text "~first line\nsecond line~"
536 (org-element-map
537 (org-element-parse-buffer) 'code 'identity nil t))))
538 "first line\nsecond line")))
541 ;;;; Comment
543 (ert-deftest test-org-element/comment-parser ()
544 "Test `comment' parser."
545 ;; Regular comment.
546 (should
547 (org-test-with-temp-text "# Comment"
548 (org-element-map (org-element-parse-buffer) 'comment 'identity)))
549 ;; Inline comment.
550 (should
551 (org-test-with-temp-text " # Comment"
552 (org-element-map (org-element-parse-buffer) 'comment 'identity)))
553 ;; Preserve indentation.
554 (should
555 (equal
556 (org-element-property
557 :value
558 (org-test-with-temp-text "# No blank\n# One blank"
559 (org-element-map (org-element-parse-buffer) 'comment 'identity nil t)))
560 "No blank\n One blank"))
561 ;; Comment with blank lines.
562 (should
563 (equal
564 (org-element-property
565 :value
566 (org-test-with-temp-text "# First part\n# \n#\n# Second part"
567 (org-element-map (org-element-parse-buffer) 'comment 'identity nil t)))
568 "First part\n\n\nSecond part"))
569 ;; Do not mix comments and keywords.
570 (should
571 (eq 1
572 (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
573 (length (org-element-map (org-element-parse-buffer) 'comment
574 'identity)))))
575 (should
576 (equal "comment"
577 (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
578 (org-element-property
579 :value
580 (org-element-map (org-element-parse-buffer) 'comment
581 'identity nil t)))))
582 ;; Correctly handle non-empty blank lines at the end of buffer.
583 (should
584 (org-test-with-temp-text "# A\n "
585 (= (org-element-property :end (org-element-at-point)) (point-max)))))
588 ;;;; Comment Block
590 (ert-deftest test-org-element/comment-block-parser ()
591 "Test `comment-block' parser."
592 ;; Standard test.
593 (should
594 (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
595 (org-element-map (org-element-parse-buffer) 'comment-block 'identity)))
596 ;; Ignore case.
597 (should
598 (org-test-with-temp-text "#+begin_comment\nText\n#+end_comment"
599 (org-element-map (org-element-parse-buffer) 'comment-block 'identity)))
600 ;; Ignore incomplete block.
601 (should-not
602 (org-test-with-temp-text "#+BEGIN_COMMENT"
603 (org-element-map (org-element-parse-buffer) 'comment-block
604 'identity nil t)))
605 ;; Handle non-empty blank line at the end of buffer.
606 (should
607 (org-test-with-temp-text "#+BEGIN_COMMENT\nC\n#+END_COMMENT\n "
608 (= (org-element-property :end (org-element-at-point)) (point-max)))))
611 ;;;; Diary Sexp
613 (ert-deftest test-org-element/diary-sexp-parser ()
614 "Test `diary-sexp' parser."
615 ;; Standard test.
616 (should
617 (eq 'diary-sexp
618 (org-test-with-temp-text
619 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old"
620 (org-element-type (org-element-at-point)))))
621 ;; Diary sexp must live at beginning of line
622 (should-not
623 (eq 'diary-sexp
624 (org-test-with-temp-text " %%(org-bbdb-anniversaries)"
625 (org-element-type (org-element-at-point)))))
626 ;; Handle non-empty blank line at the end of buffer.
627 (should
628 (org-test-with-temp-text "%%(org-bbdb-anniversaries)\n "
629 (= (org-element-property :end (org-element-at-point)) (point-max)))))
632 ;;;; Drawer
634 (ert-deftest test-org-element/drawer-parser ()
635 "Test `drawer' parser."
636 ;; Standard test.
637 (should
638 (org-test-with-temp-text ":TEST:\nText\n:END:"
639 (org-element-map (org-element-parse-buffer) 'drawer 'identity)))
640 ;; Ignore incomplete drawer.
641 (should-not
642 (org-test-with-temp-text ":TEST:"
643 (org-element-map (org-element-parse-buffer) 'drawer 'identity nil t)))
644 ;; Handle non-empty blank line at the end of buffer.
645 (should
646 (org-test-with-temp-text ":TEST:\nC\n:END:\n "
647 (= (org-element-property :end (org-element-at-point)) (point-max)))))
650 ;;;; Dynamic Block
652 (ert-deftest test-org-element/dynamic-block-parser ()
653 "Test `dynamic-block' parser."
654 ;; Standard test.
655 (should
656 (org-test-with-temp-text
657 "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
658 (org-element-map (org-element-parse-buffer) 'dynamic-block 'identity)))
659 ;; Ignore case.
660 (should
661 (org-test-with-temp-text
662 "#+begin: myblock :param1 val1 :param2 val2\nText\n#+end:"
663 (org-element-map (org-element-parse-buffer) 'dynamic-block 'identity)))
664 ;; Ignore incomplete block.
665 (should-not
666 (org-test-with-temp-text "#+BEGIN: myblock :param1 val1 :param2 val2"
667 (org-element-map (org-element-parse-buffer) 'dynamic-block
668 'identity nil t)))
669 ;; Handle non-empty blank line at the end of buffer.
670 (should
671 (org-test-with-temp-text "#+BEGIN: myblock :param val1\nC\n#+END:\n "
672 (= (org-element-property :end (org-element-at-point)) (point-max)))))
675 ;;;; Entity
677 (ert-deftest test-org-element/entity-parser ()
678 "Test `entity' parser."
679 ;; Without brackets.
680 (should
681 (org-test-with-temp-text "\\sin"
682 (org-element-map (org-element-parse-buffer) 'entity 'identity)))
683 ;; With brackets.
684 (should
685 (org-element-property
686 :use-brackets-p
687 (org-test-with-temp-text "\\alpha{}text"
688 (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
689 ;; User-defined entity.
690 (should
691 (equal
692 (org-element-property
693 :name
694 (let ((org-entities-user
695 '(("test" "test" nil "test" "test" "test" "test"))))
696 (org-test-with-temp-text "\\test"
697 (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
698 "test"))
699 ;; Special case: entity at the end of a container.
700 (should
701 (eq 'entity
702 (org-test-with-temp-text "*\\alpha \\beta*"
703 (search-forward "be")
704 (org-element-type (org-element-context))))))
707 ;;;; Example Block
709 (ert-deftest test-org-element/example-block-parser ()
710 "Test `example-block' parser."
711 ;; Standard test.
712 (should
713 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
714 (org-element-map (org-element-parse-buffer) 'example-block 'identity)))
715 ;; Ignore incomplete block.
716 (should-not
717 (eq 'example-block
718 (org-test-with-temp-text "#+BEGIN_EXAMPLE"
719 (org-element-type (org-element-at-point)))))
720 ;; Properly un-escape code.
721 (should
722 (equal "* Headline\n #+keyword\nText\n"
723 (org-test-with-temp-text
724 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText\n#+END_EXAMPLE"
725 (org-element-property :value (org-element-at-point)))))
726 ;; Handle non-empty blank line at the end of buffer.
727 (should
728 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nC\n#+END_EXAMPLE\n "
729 (= (org-element-property :end (org-element-at-point)) (point-max)))))
731 (ert-deftest test-org-element/block-switches ()
732 "Test `example-block' and `src-block' switches parsing."
733 (let ((org-coderef-label-format "(ref:%s)"))
734 ;; 1. Test "-i" switch.
735 (should-not
736 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
737 (org-element-property :preserve-indent (org-element-at-point))))
738 (should
739 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"
740 (org-element-property :preserve-indent (org-element-at-point))))
741 (should-not
742 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
743 (org-element-property :preserve-indent (org-element-at-point))))
744 (should
745 (org-test-with-temp-text "#+BEGIN_EXAMPLE -i\nText.\n#+END_EXAMPLE"
746 (org-element-property :preserve-indent (org-element-at-point))))
747 ;; 2. "-n -r -k" combination should number lines, retain labels but
748 ;; not use them in coderefs.
749 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r -k\nText.\n#+END_EXAMPLE"
750 (let ((element (org-element-at-point)))
751 (should (org-element-property :number-lines element))
752 (should (org-element-property :retain-labels element))
753 (should-not (org-element-property :use-labels element))))
754 (org-test-with-temp-text
755 "#+BEGIN_SRC emacs-lisp -n -r -k\n(+ 1 1)\n#+END_SRC"
756 (let ((element (org-element-at-point)))
757 (should (org-element-property :number-lines element))
758 (should (org-element-property :retain-labels element))
759 (should-not (org-element-property :use-labels element))))
760 ;; 3. "-n -r" combination should number-lines remove labels and not
761 ;; use them in coderefs.
762 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r\nText.\n#+END_EXAMPLE"
763 (let ((element (org-element-at-point)))
764 (should (org-element-property :number-lines element))
765 (should-not (org-element-property :retain-labels element))
766 (should-not (org-element-property :use-labels element))))
767 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1)\n#+END_SRC"
768 (let ((element (org-element-at-point)))
769 (should (org-element-property :number-lines element))
770 (should-not (org-element-property :retain-labels element))
771 (should-not (org-element-property :use-labels element))))
772 ;; 4. "-n" or "+n" should number lines, retain labels and use them
773 ;; in coderefs.
774 (should
775 (org-test-with-temp-text "#+BEGIN_EXAMPLE -n\nText.\n#+END_EXAMPLE"
776 (let ((element (org-element-at-point)))
777 (and (org-element-property :number-lines element)
778 (org-element-property :retain-labels element)
779 (org-element-property :use-labels element)))))
780 (should
781 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1)\n#+END_SRC"
782 (let ((element (org-element-at-point)))
783 (and (org-element-property :number-lines element)
784 (org-element-property :retain-labels element)
785 (org-element-property :use-labels element)))))
786 (should
787 (org-test-with-temp-text "#+BEGIN_EXAMPLE +n\nText.\n#+END_EXAMPLE"
788 (let ((element (org-element-at-point)))
789 (and (org-element-property :number-lines element)
790 (org-element-property :retain-labels element)
791 (org-element-property :use-labels element)))))
792 (should
793 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp +n\n(+ 1 1)\n#+END_SRC"
794 (let ((element (org-element-at-point)))
795 (and (org-element-property :number-lines element)
796 (org-element-property :retain-labels element)
797 (org-element-property :use-labels element)))))
798 ;; 5. No switch should not number lines, but retain labels and use
799 ;; them in coderefs.
800 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
801 (let ((element (org-element-at-point)))
802 (should (not (org-element-property :number-lines element)))
803 (should (org-element-property :retain-labels element))
804 (should (org-element-property :use-labels element))))
805 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
806 (let ((element (org-element-at-point)))
807 (should (not (org-element-property :number-lines element)))
808 (should (org-element-property :retain-labels element))
809 (should (org-element-property :use-labels element))))
810 ;; 6. "-r" switch only: do not number lines, remove labels, and
811 ;; don't use labels in coderefs.
812 (org-test-with-temp-text "#+BEGIN_EXAMPLE -r\nText.\n#+END_EXAMPLE"
813 (let ((element (org-element-at-point)))
814 (should (not (org-element-property :number-lines element)))
815 (should (not (org-element-property :retain-labels element)))
816 (should (not (org-element-property :use-labels element)))))
817 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1)\n#+END_SRC"
818 (let ((element (org-element-at-point)))
819 (should (not (org-element-property :number-lines element)))
820 (should (not (org-element-property :retain-labels element)))
821 (should (not (org-element-property :use-labels element)))))
822 ;; 7. Recognize coderefs with user-defined syntax.
823 (should
824 (equal
825 "[ref:%s]"
826 (org-test-with-temp-text
827 "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText [ref:text]\n#+END_EXAMPLE"
828 (org-element-property :label-fmt (org-element-at-point)))))
829 (should
830 (equal
831 "[ref:%s]"
832 (org-test-with-temp-text
833 "#+BEGIN_SRC emacs-lisp -l \"[ref:%s]\"\n(+ 1 1) [ref:text]\n#+END_SRC"
834 (org-element-property :label-fmt (org-element-at-point)))))))
837 ;;;; Export Block
839 (ert-deftest test-org-element/export-block-parser ()
840 "Test `export-block' parser."
841 ;; Standard test.
842 (should
843 (eq 'export-block
844 (org-test-with-temp-text "#+BEGIN_EXPORT LATEX\nText\n#+END_EXPORT"
845 (org-element-type (org-element-at-point)))))
846 (should
847 (equal "LATEX"
848 (org-test-with-temp-text "#+BEGIN_EXPORT LATEX\nText\n#+END_EXPORT"
849 (org-element-property :type (org-element-at-point)))))
850 ;; Ignore case.
851 (should
852 (eq 'export-block
853 (org-test-with-temp-text "#+begin_export latex\nText\n#+end_export"
854 (org-element-type (org-element-at-point)))))
855 ;; Ignore incomplete block.
856 (should-not
857 (eq 'export-block
858 (org-test-with-temp-text "#+BEGIN_EXPORT"
859 (org-element-type (org-element-at-point)))))
860 ;; Handle non-empty blank line at the end of buffer.
861 (should
862 (org-test-with-temp-text "#+BEGIN_EXPORT latex\nC\n#+END_EXPORT\n "
863 (= (org-element-property :end (org-element-at-point)) (point-max))))
864 ;; Un-escape commas in `:value'.
865 (should
866 (equal "* H\n"
867 (org-test-with-temp-text "#+BEGIN_EXPORT org\n,* H\n#+END_EXPORT\n "
868 (org-element-property :value (org-element-at-point))))))
871 ;;;; Export Snippet
873 (ert-deftest test-org-element/export-snippet-parser ()
874 "Test `export-snippet' parser."
875 (should
876 (equal
877 '("back-end" . "contents")
878 (org-test-with-temp-text "@@back-end:contents@@"
879 (org-element-map
880 (org-element-parse-buffer) 'export-snippet
881 (lambda (snippet) (cons (org-element-property :back-end snippet)
882 (org-element-property :value snippet)))
883 nil t)))))
886 ;;;; Fixed Width
888 (ert-deftest test-org-element/fixed-width-parser ()
889 "Test fixed-width area parsing."
890 ;; Preserve indentation.
891 (should
892 (org-test-with-temp-text ": no blank\n: one blank"
893 (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
894 ;; Fixed-width with empty lines.
895 (should
896 (org-test-with-temp-text ": first part\n:\n: \n: second part"
897 (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
898 ;; Parse indented fixed-width markers.
899 (should
900 (org-test-with-temp-text "Text\n : no blank\n : one blank"
901 (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
902 ;; Distinguish fixed-width areas within a list and outside of it.
903 (should
904 (= 2
905 (length
906 (org-test-with-temp-text "
907 - Item
908 : fixed-width inside
909 : fixed-width outside"
910 (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))))
911 ;; Handle non-empty blank line at the end of buffer.
912 (should
913 (org-test-with-temp-text ": A\n "
914 (= (org-element-property :end (org-element-at-point)) (point-max)))))
917 ;;;; Footnote Definition
919 (ert-deftest test-org-element/footnote-definition-parser ()
920 "Test `footnote-definition' parser."
921 (should
922 (org-test-with-temp-text "[fn:1] Definition"
923 (org-element-map (org-element-parse-buffer) 'footnote-definition
924 'identity nil t)))
925 ;; Footnote with more contents
926 (should
927 (= 29
928 (org-element-property
929 :end
930 (org-test-with-temp-text "[fn:1] Definition\n\n| a | b |"
931 (org-element-map (org-element-parse-buffer) 'footnote-definition
932 'identity nil t)))))
933 ;; Footnote starting with special syntax.
934 (should-not
935 (org-test-with-temp-text "[fn:1] - no item"
936 (org-element-map (org-element-parse-buffer) 'item 'identity)))
937 ;; Correctly handle footnote starting with an empty line.
938 (should
939 (= 9
940 (org-test-with-temp-text "[fn:1]\n\n Body"
941 (org-element-property :contents-begin (org-element-at-point)))))
942 ;; Handle non-empty blank line at the end of buffer.
943 (should
944 (org-test-with-temp-text "[fn:1] Definition\n "
945 (= (org-element-property :end (org-element-at-point)) (point-max))))
946 ;; Footnote with attributes.
947 (should
948 (= 1
949 (org-test-with-temp-text "#+attr_latex: :offset 0in\n[fn:1] A footnote."
950 (length
951 (org-element-map (org-element-parse-buffer) 'footnote-definition
952 #'identity)))))
953 (should
954 (org-test-with-temp-text "[fn:1] 1\n\n#+attr_latex: :offset 0in\n[fn:2] 2"
955 (goto-char (org-element-property :end (org-element-at-point)))
956 (looking-at "#"))))
959 ;;;; Footnotes Reference.
961 (ert-deftest test-org-element/footnote-reference-parser ()
962 "Test `footnote-reference' parser."
963 ;; Parse a standard reference.
964 (should
965 (org-test-with-temp-text "Text[fn:label]"
966 (org-element-map
967 (org-element-parse-buffer) 'footnote-reference 'identity)))
968 ;; Parse an inline reference.
969 (should
970 (org-test-with-temp-text "Text[fn:test:def]"
971 (org-element-map
972 (org-element-parse-buffer) 'footnote-reference 'identity)))
973 ;; Parse an anonymous reference.
974 (should
975 (org-test-with-temp-text "Text[fn::def]"
976 (org-element-map
977 (org-element-parse-buffer) 'footnote-reference 'identity)))
978 ;; Parse nested footnotes.
979 (should
980 (= 2
981 (length
982 (org-test-with-temp-text "Text[fn::def [fn:label]]"
983 (org-element-map
984 (org-element-parse-buffer) 'footnote-reference 'identity)))))
985 ;; Parse adjacent footnotes.
986 (should
987 (org-test-with-temp-text "Text[fn:label1][fn:label2]"
988 (= 2
989 (length
990 (org-element-map
991 (org-element-parse-buffer) 'footnote-reference 'identity)))))
992 ;; Only properly closed footnotes are recognized as such.
993 (should-not
994 (org-test-with-temp-text "Text[fn:label"
995 (org-element-map
996 (org-element-parse-buffer) 'footnote-reference 'identity))))
999 ;;;; Headline
1001 (ert-deftest test-org-element/headline-comment-keyword ()
1002 "Test COMMENT keyword recognition."
1003 ;; Reference test.
1004 (org-test-with-temp-text "* Headline"
1005 (let ((org-comment-string "COMMENT"))
1006 (should-not (org-element-property :commentedp (org-element-at-point)))))
1007 ;; Standard position.
1008 (org-test-with-temp-text "* COMMENT Headline"
1009 (let ((org-comment-string "COMMENT")
1010 (headline (org-element-at-point)))
1011 (should (org-element-property :commentedp headline))
1012 (should (equal (org-element-property :raw-value headline) "Headline"))))
1013 ;; Case sensitivity.
1014 (org-test-with-temp-text "* COMMENT Headline"
1015 (let* ((org-comment-string "Comment")
1016 (headline (org-element-at-point)))
1017 (should-not (org-element-property :commentedp headline))
1018 (should (equal (org-element-property :raw-value headline)
1019 "COMMENT Headline"))))
1020 ;; With another keyword.
1021 (org-test-with-temp-text "* TODO COMMENT Headline"
1022 (let* ((org-comment-string "COMMENT")
1023 (org-todo-keywords '((sequence "TODO" "DONE")))
1024 (headline (org-element-at-point)))
1025 (should (org-element-property :commentedp headline))
1026 (should (equal (org-element-property :raw-value headline) "Headline"))))
1027 ;; With the keyword only.
1028 (org-test-with-temp-text "* COMMENT"
1029 (let* ((org-comment-string "COMMENT")
1030 (headline (org-element-at-point)))
1031 (should (org-element-property :commentedp headline))
1032 (should (equal (org-element-property :raw-value headline) "")))))
1034 (ert-deftest test-org-element/headline-archive-tag ()
1035 "Test ARCHIVE tag recognition."
1036 ;; Reference test.
1037 (should-not
1038 (org-test-with-temp-text "* Headline"
1039 (let ((org-archive-tag "ARCHIVE"))
1040 (org-element-property :archivedp (org-element-at-point)))))
1041 ;; Single tag.
1042 (org-test-with-temp-text "* Headline :ARCHIVE:"
1043 (let ((org-archive-tag "ARCHIVE"))
1044 (let ((headline (org-element-at-point)))
1045 (should (org-element-property :archivedp headline)))))
1046 ;; Multiple tags.
1047 (org-test-with-temp-text "* Headline :test:ARCHIVE:"
1048 (let ((org-archive-tag "ARCHIVE"))
1049 (let ((headline (org-element-at-point)))
1050 (should (org-element-property :archivedp headline)))))
1051 ;; Tag is case-sensitive.
1052 (should-not
1053 (org-test-with-temp-text "* Headline :ARCHIVE:"
1054 (let ((org-archive-tag "Archive"))
1055 (org-element-property :archivedp (org-element-at-point))))))
1057 (ert-deftest test-org-element/headline-properties ()
1058 "Test properties from property drawer."
1059 ;; All properties from property drawer have their symbol upper
1060 ;; cased.
1061 (should
1062 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
1063 (org-element-property :FOO (org-element-at-point))))
1064 (should-not
1065 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
1066 (org-element-property :foo (org-element-at-point))))
1067 ;; Also parse properties associated in inlinetasks.
1068 (when (featurep 'org-inlinetask)
1069 (should
1070 (org-test-with-temp-text "*************** Inlinetask
1071 :PROPERTIES:
1072 :foo: bar
1073 :END:
1074 *************** END"
1075 (org-element-property :FOO (org-element-at-point)))))
1076 ;; Do not find property drawer in a verbatim area.
1077 (should-not
1078 (org-test-with-temp-text
1079 "* Headline
1080 #+BEGIN_EXAMPLE
1081 :PROPERTIES:
1082 :foo: bar
1083 :END:
1084 #+END_EXAMPLE"
1085 (org-element-property :FOO (org-element-at-point))))
1086 ;; Do not use properties from a drawer associated to an inlinetask.
1087 (when (featurep 'org-inlinetask)
1088 (should-not
1089 (org-test-with-temp-text
1090 "* Headline
1091 *************** Inlinetask
1092 :PROPERTIES:
1093 :foo: bar
1094 :END:
1095 *************** END"
1096 (org-element-property
1097 :FOO (let ((org-inlinetask-min-level 15)) (org-element-at-point))))))
1098 ;; Do not find incomplete drawers.
1099 (should-not
1100 (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar"
1101 (org-element-property :FOO (org-element-at-point)))))
1104 ;;;; Horizontal Rule
1106 (ert-deftest test-org-element/horizontal-rule-parser ()
1107 "Test `horizontal-rule' parser."
1108 ;; Standard.
1109 (should
1110 (org-test-with-temp-text "-----"
1111 (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
1112 ;; Indented.
1113 (should
1114 (org-test-with-temp-text " -----"
1115 (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
1116 ;; Hyphen must be alone on the line.
1117 (should-not
1118 (org-test-with-temp-text "-----wrong"
1119 (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
1120 ;; 4 hyphens is too small.
1121 (should-not
1122 (org-test-with-temp-text "----"
1123 (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
1124 ;; Handle non-empty blank line at the end of buffer.
1125 (should
1126 (org-test-with-temp-text "-----\n "
1127 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1130 ;;;; Inline Babel Call
1132 (ert-deftest test-org-element/inline-babel-call-parser ()
1133 "Test `inline-babel-call' parser."
1134 ;; Standard test.
1135 (should
1136 (eq 'inline-babel-call
1137 (org-test-with-temp-text "call_test()"
1138 (org-element-type (org-element-context)))))
1139 (should
1140 (eq 'inline-babel-call
1141 (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
1142 (org-element-type (org-element-context)))))
1143 ;; Parse call name.
1144 (should
1145 (equal
1146 "test"
1147 (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
1148 (org-element-property :call (org-element-context)))))
1149 ;; Parse inside header.
1150 (should
1151 (equal
1152 ":results output"
1153 (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
1154 (org-element-property :inside-header (org-element-context)))))
1155 ;; Parse arguments.
1156 (should
1157 (equal
1158 "x=2"
1159 (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
1160 (org-element-property :arguments (org-element-context)))))
1161 ;; Parse end header.
1162 (should
1163 (equal
1164 ":results html"
1165 (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
1166 (org-element-property :end-header (org-element-context)))))
1167 ;; Handle multi-line babel calls.
1168 (should
1169 (eq 'inline-babel-call
1170 (org-test-with-temp-text
1171 "call_test[:results\noutput](x=2)[:results html]"
1172 (org-element-type (org-element-context)))))
1173 (should
1174 (eq 'inline-babel-call
1175 (org-test-with-temp-text
1176 "call_test[:results output](x=2\ny=3)[:results html]"
1177 (org-element-type (org-element-context)))))
1178 (should
1179 (eq 'inline-babel-call
1180 (org-test-with-temp-text
1181 "call_test[:results output](x=2)[:results\nhtml]"
1182 (org-element-type (org-element-context)))))
1183 ;; Parse parameters containing round brackets.
1184 (should
1185 (eq 'inline-babel-call
1186 (org-test-with-temp-text "call_test[:var x='(1)](x=2)"
1187 (org-element-type (org-element-context))))))
1190 ;;;; Inline Src Block
1192 (ert-deftest test-org-element/inline-src-block-parser ()
1193 "Test `inline-src-block' parser."
1194 (should
1195 (org-test-with-temp-text "src_emacs-lisp{(+ 1 1)}"
1196 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
1197 ;; With switches.
1198 (should
1199 (org-test-with-temp-text "src_emacs-lisp[:foo bar]{(+ 1 1)}"
1200 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
1201 (should
1202 (org-test-with-temp-text "src_emacs-lisp[ :foo bar]{(+ 1 1)}"
1203 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
1204 ;; Empty switches.
1205 (should
1206 (org-test-with-temp-text "src_emacs-lisp[]{(+ 1 1)}"
1207 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
1208 ;; Invalid syntax.
1209 (should-not
1210 (org-test-with-temp-text "foosrc_emacs-lisp[]{(+ 1 1)}"
1211 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
1212 (should-not
1213 (org-test-with-temp-text "src_emacs-lisp[]foo{(+ 1 1)}"
1214 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
1215 ;; Invalid language name
1216 (should-not
1217 (org-test-with-temp-text "src_emacs-\tlisp{(+ 1 1)}"
1218 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
1219 ;; Test parsing at the beginning of an item.
1220 (should
1221 (org-test-with-temp-text "- src_emacs-lisp{(+ 1 1)}"
1222 (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
1223 ;; Test parsing multi-line source blocks.
1224 (should
1225 (eq 'inline-src-block
1226 (org-test-with-temp-text "src_emacs-lisp{(+ 1\n 1)}"
1227 (org-element-type (org-element-context)))))
1228 (should
1229 (eq 'inline-src-block
1230 (org-test-with-temp-text "src_emacs-lisp[\n:foo bar]{(+ 1 1)}"
1231 (org-element-type (org-element-context)))))
1232 (should
1233 (eq 'inline-src-block
1234 (org-test-with-temp-text "src_emacs-lisp[:foo\nbar]{(+ 1 1)}"
1235 (org-element-type (org-element-context)))))
1236 ;; Besides curly brackets, ignore any other bracket type.
1237 (should
1238 (equal "[foo"
1239 (org-test-with-temp-text "src_emacs-lisp{[foo}"
1240 (org-element-property :value (org-element-context)))))
1241 (should
1242 (equal "foo]"
1243 (org-test-with-temp-text "src_emacs-lisp{foo]}"
1244 (org-element-property :value (org-element-context)))))
1245 (should
1246 (equal "(foo"
1247 (org-test-with-temp-text "src_emacs-lisp{(foo}"
1248 (org-element-property :value (org-element-context)))))
1249 (should
1250 (equal "foo)"
1251 (org-test-with-temp-text "src_emacs-lisp{foo)}"
1252 (org-element-property :value (org-element-context)))))
1253 ;; Parse parameters containing square brackets.
1254 (should
1255 (eq 'inline-src-block
1256 (org-test-with-temp-text "src_emacs-lisp[:var table=t[1,1]]{(+ 1 1)}"
1257 (org-element-type (org-element-context))))))
1260 ;;;; Inlinetask
1262 (ert-deftest test-org-element/inlinetask-parser ()
1263 "Test `inlinetask' parser."
1264 (when (featurep 'org-inlinetask)
1265 (let ((org-inlinetask-min-level 15))
1266 ;; Regular inlinetask.
1267 (should
1268 (eq 'inlinetask
1269 (org-test-with-temp-text
1270 "*************** Task\nTest\n*************** END"
1271 (org-element-type (org-element-at-point)))))
1272 (should
1273 (eq 'inlinetask
1274 (org-test-with-temp-text
1275 "*************** Task\nTest\n*************** END"
1276 (org-element-type (org-element-at-point)))))
1277 ;; Degenerate inlinetask.
1278 (should
1279 (eq 'inlinetask
1280 (org-test-with-temp-text "*************** Task"
1281 (org-element-type (org-element-at-point)))))
1282 ;; Mixed inlinetasks.
1283 (should-not
1284 (org-test-with-temp-text
1286 *************** Task
1287 *************** Task2
1288 Contents
1289 *************** END"
1290 (forward-line)
1291 (goto-char (org-element-property :end (org-element-at-point)))
1292 (eobp)))
1293 ;; TODO keyword.
1294 (should
1295 (equal
1296 "TODO"
1297 (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
1298 (org-test-with-temp-text "*************** TODO Task"
1299 (org-element-property :todo-keyword (org-element-at-point))))))
1300 ;; Planning info.
1301 (should
1302 (org-test-with-temp-text "
1303 *************** Task<point>
1304 DEADLINE: <2012-03-29 thu.>
1305 *************** END"
1306 (org-element-property :deadline (org-element-at-point))))
1307 (should
1308 (eq 'planning
1309 (org-test-with-temp-text "
1310 *************** Task
1311 <point>DEADLINE: <2012-03-29 thu.>
1312 *************** END"
1313 (org-element-type (org-element-at-point)))))
1314 (should-not
1315 (org-test-with-temp-text "
1316 *************** Task<point>
1317 DEADLINE: <2012-03-29 thu.>"
1318 (org-element-property :deadline (org-element-at-point))))
1319 (should-not
1320 (eq 'planning
1321 (org-test-with-temp-text "
1322 *************** Task
1323 <point>DEADLINE: <2012-03-29 thu.>"
1324 (org-element-type (org-element-at-point)))))
1325 ;; Priority.
1326 (should
1329 (org-test-with-temp-text "
1330 *************** [#A] Task"
1331 (forward-line)
1332 (org-element-property :priority (org-element-at-point)))))
1333 ;; Tags.
1334 (should
1335 (equal
1336 '("test")
1337 (org-test-with-temp-text "
1338 *************** Task :test:"
1339 (forward-line)
1340 (org-element-property :tags (org-element-at-point)))))
1341 ;; Regular properties are accessed through upper case keywords.
1342 (should
1343 (org-test-with-temp-text "
1344 *************** Task
1345 :PROPERTIES:
1346 :foo: bar
1347 :END:
1348 *************** END"
1349 (forward-line)
1350 (org-element-property :FOO (org-element-at-point))))
1351 (should-not
1352 (org-test-with-temp-text "
1353 *************** Task
1354 :PROPERTIES:
1355 :foo: bar
1356 :END:
1357 *************** END"
1358 (forward-line)
1359 (org-element-property :foo (org-element-at-point))))
1360 ;; Handle non-empty blank line at the end of buffer.
1361 (should
1362 (org-test-with-temp-text "*************** Task\n*************** END\n "
1363 (= (org-element-property :end (org-element-at-point)) (point-max)))))))
1366 ;;;; Italic
1368 (ert-deftest test-org-element/italic-parser ()
1369 "Test `italic' parser."
1370 ;; Regular test.
1371 (should
1372 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1373 (org-test-with-temp-text "/italic/"
1374 (org-element-map (org-element-parse-buffer) 'italic 'identity nil t))))
1375 ;; Multi-line markup.
1376 (should
1377 (equal
1378 (org-element-contents
1379 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
1380 (org-test-with-temp-text "/first line\nsecond line/"
1381 (org-element-map (org-element-parse-buffer) 'italic 'identity nil t))))
1382 '("first line\nsecond line"))))
1385 ;;;; Item
1387 (ert-deftest test-org-element/item-parser ()
1388 "Test `item' parser."
1389 ;; Standard test.
1390 (should
1391 (org-test-with-temp-text "- item"
1392 (org-element-map (org-element-parse-buffer) 'item 'identity)))
1393 ;; Counter.
1394 (should
1395 (= 6
1396 (org-element-property
1397 :counter
1398 (org-test-with-temp-text "6. [@6] item"
1399 (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
1400 ;; Tag
1401 (should
1402 (equal
1403 '("tag")
1404 (org-element-property
1405 :tag
1406 (org-test-with-temp-text "- tag :: description"
1407 (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
1408 ;; No tags in ordered lists.
1409 (should-not
1410 (org-element-property
1411 :tag
1412 (org-test-with-temp-text "1. tag :: description"
1413 (org-element-map (org-element-parse-buffer) 'item 'identity nil t))))
1414 ;; Check-boxes
1415 (should
1416 (equal
1417 '(trans on off)
1418 (org-test-with-temp-text "
1419 - [-] item 1
1420 - [X] item 1.1
1421 - [ ] item 1.2"
1422 (org-element-map
1423 (org-element-parse-buffer) 'item
1424 (lambda (item) (org-element-property :checkbox item))))))
1425 ;; Item starting with special syntax.
1426 (should
1427 (equal '(("- item"))
1428 (org-test-with-temp-text "- - item"
1429 (org-element-map (org-element-parse-buffer) 'paragraph
1430 'org-element-contents))))
1431 ;; Block in an item: ignore indentation within the block.
1432 (should
1433 (org-test-with-temp-text "- item\n #+begin_src emacs-lisp\n(+ 1 1)\n #+end_src"
1434 (forward-char)
1435 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1438 ;;;; Keyword
1440 (ert-deftest test-org-element/keyword-parser ()
1441 "Test `keyword' parser."
1442 ;; Standard test.
1443 (should
1444 (org-test-with-temp-text "#+KEYWORD: value"
1445 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1446 ;; Keywords are case-insensitive.
1447 (should
1448 (org-test-with-temp-text "#+keyword: value"
1449 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1450 ;; Affiliated keywords are not keywords.
1451 (should-not
1452 (org-test-with-temp-text "#+NAME: value
1453 Paragraph"
1454 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1455 ;; Do not mix keywords with Babel calls and dynamic blocks.
1456 (should-not
1457 (org-test-with-temp-text "#+CALL: fun()"
1458 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1459 (should-not
1460 (org-test-with-temp-text "#+BEGIN: my-fun\nBody\n#+END:"
1461 (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
1462 ;; Handle non-empty blank line at the end of buffer.
1463 (should
1464 (org-test-with-temp-text "#+KEYWORD: value\n "
1465 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1468 ;;;; Latex Environment
1470 (ert-deftest test-org-element/latex-environment-parser ()
1471 "Test `latex-environment' parser."
1472 (should
1473 (org-test-with-temp-text "\\begin{equation}\ne^{i\\pi}+1=0\n\\end{equation}"
1474 (org-element-map (org-element-parse-buffer) 'latex-environment 'identity)))
1475 ;; Allow nested environments.
1476 (should
1477 (equal
1478 "\\begin{outer}
1479 \\begin{inner}
1480 e^{i\\pi}+1=0
1481 \\end{inner}
1482 \\end{outer}"
1483 (org-test-with-temp-text "
1484 \\begin{outer}
1485 \\begin{inner}
1486 e^{i\\pi}+1=0
1487 \\end{inner}
1488 \\end{outer}"
1489 (org-element-property
1490 :value
1491 (org-element-map
1492 (org-element-parse-buffer) 'latex-environment 'identity nil t)))))
1493 ;; Allow environments with options and arguments.
1494 (should
1495 (eq 'latex-environment
1496 (org-test-with-temp-text
1497 "\\begin{theorem}[Euler]\ne^{i\\pi}+1=0\n\\end{theorem}"
1498 (org-element-type (org-element-at-point)))))
1499 (should
1500 (eq 'latex-environment
1501 (org-test-with-temp-text "\\begin{env}{arg}\nvalue\n\\end{env}"
1502 (org-element-type (org-element-at-point)))))
1503 ;; Allow environments without newline after \begin{.}.
1504 (should
1505 (eq 'latex-environment
1506 (org-test-with-temp-text "\\begin{env}{arg}something\nvalue\n\\end{env}"
1507 (org-element-type (org-element-at-point)))))
1508 ;; Allow one-line environments.
1509 (should
1510 (eq 'latex-environment
1511 (org-test-with-temp-text "\\begin{env}{arg}something\\end{env}"
1512 (org-element-type (org-element-at-point)))))
1513 ;; Should not allow different tags.
1514 (should-not
1515 (eq 'latex-environment
1516 (org-test-with-temp-text "\\begin{env*}{arg}something\\end{env}"
1517 (org-element-type (org-element-at-point)))))
1518 ;; LaTeX environments must be on separate lines.
1519 (should-not
1520 (eq 'latex-environment
1521 (org-test-with-temp-text "\\begin{env} x \\end{env} y"
1522 (org-element-type (org-element-at-point)))))
1523 (should-not
1524 (eq 'latex-environment
1525 (org-test-with-temp-text "y \\begin{env} x<point> \\end{env}"
1526 (org-element-type (org-element-at-point)))))
1527 ;; Handle non-empty blank line at the end of buffer.
1528 (should
1529 (org-test-with-temp-text "\\begin{env}\n\\end{env}\n "
1530 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1533 ;;;; Latex Fragment
1535 (ert-deftest test-org-element/latex-fragment-parser ()
1536 "Test `latex-fragment' parser."
1537 (should
1538 (eq 'latex-fragment
1539 (org-test-with-temp-text "$a$"
1540 (org-element-type (org-element-context)))))
1541 (should
1542 (eq 'latex-fragment
1543 (org-test-with-temp-text "$a$!"
1544 (org-element-type (org-element-context)))))
1545 (should
1546 (eq 'latex-fragment
1547 (org-test-with-temp-text "$a$,"
1548 (org-element-type (org-element-context)))))
1549 (should
1550 (eq 'latex-fragment
1551 (org-test-with-temp-text "$a$\""
1552 (org-element-type (org-element-context)))))
1553 (should
1554 (eq 'latex-fragment
1555 (org-test-with-temp-text "$a$)"
1556 (org-element-type (org-element-context)))))
1557 (should
1558 (eq 'latex-fragment
1559 (org-test-with-temp-text "$a$ "
1560 (org-element-type (org-element-context)))))
1561 (should-not
1562 (eq 'latex-fragment
1563 (org-test-with-temp-text "$a$a"
1564 (org-element-type (org-element-context)))))
1565 (should
1566 (eq 'latex-fragment
1567 (org-test-with-temp-text "$$a$$"
1568 (org-element-type (org-element-context)))))
1569 (should
1570 (eq 'latex-fragment
1571 (org-test-with-temp-text "\\(a\\)"
1572 (org-element-type (org-element-context)))))
1573 (should
1574 (eq 'latex-fragment
1575 (org-test-with-temp-text "\\[a\\]"
1576 (org-element-type (org-element-context)))))
1577 ;; Test fragment at the beginning of an item.
1578 (should
1579 (eq 'latex-fragment
1580 (org-test-with-temp-text "- $<point>x$"
1581 (org-element-type (org-element-context))))))
1584 ;;;; Line Break
1586 (ert-deftest test-org-element/line-break-parser ()
1587 "Test `line-break' parser."
1588 ;; Regular test.
1589 (should
1590 (org-test-with-temp-text "Text \\\\"
1591 (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
1592 ;; Line break with trailing white spaces.
1593 (should
1594 (org-test-with-temp-text "Text \\\\ "
1595 (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
1596 ;; Three backslashes are too much.
1597 (should-not
1598 (org-test-with-temp-text "Text \\\\\\"
1599 (org-element-map (org-element-parse-buffer) 'line-break 'identity))))
1602 ;;;; Link
1604 (ert-deftest test-org-element/link-parser ()
1605 "Test `link' parser."
1606 ;; Radio target.
1607 (should
1608 (equal
1609 "radio"
1610 (org-test-with-temp-text "<<<radio>>>A radio link"
1611 (org-update-radio-target-regexp)
1612 (org-element-property
1613 :type
1614 (org-element-map (org-element-parse-buffer) 'link #'identity nil t)))))
1615 ;; Pathological case: radio target of length 1 at beginning of line
1616 ;; not followed by spaces.
1617 (should
1618 (org-test-with-temp-text "* <<<a>>>\n<point>a-bug"
1619 (org-update-radio-target-regexp)
1620 (org-element-parse-buffer)))
1621 ;; Standard link.
1623 ;; ... with description.
1624 (should
1625 (equal
1626 '("Orgmode.org")
1627 (org-test-with-temp-text "[[http://orgmode.org][Orgmode.org]]"
1628 (org-element-contents
1629 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1630 ;; ... without description.
1631 (should
1632 (equal
1633 "http"
1634 (org-test-with-temp-text "[[http://orgmode.org]]"
1635 (org-element-property
1636 :type
1637 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1638 ;; ... with expansion.
1639 (should
1640 (equal
1641 "//orgmode.org/worg"
1642 (org-test-with-temp-text "[[Org:worg]]"
1643 (let ((org-link-abbrev-alist '(("Org" . "http://orgmode.org/"))))
1644 (org-element-property
1645 :path
1646 (org-element-map (org-element-parse-buffer) 'link 'identity nil t))))))
1647 ;; ... with translation.
1648 (should
1649 (equal
1650 "127.0.0.1"
1651 (org-test-with-temp-text "[[http://orgmode.org]]"
1652 (let ((org-link-translation-function
1653 (lambda (type _) (cons type "127.0.0.1"))))
1654 (org-element-property
1655 :path
1656 (org-element-map (org-element-parse-buffer) 'link
1657 #'identity nil t))))))
1658 ;; ... id link.
1659 (should
1660 (equal
1661 "id"
1662 (org-test-with-temp-text "[[id:aaaa]]"
1663 (org-element-property
1664 :type
1665 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1666 ;; ... custom-id link.
1667 (should
1668 (equal
1669 "custom-id"
1670 (org-test-with-temp-text "[[#some-id]]"
1671 (org-element-property
1672 :type
1673 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1674 ;; ... coderef link.
1675 (should
1676 (equal
1677 "coderef"
1678 (org-test-with-temp-text "[[(reference)]]"
1679 (org-element-property
1680 :type
1681 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1682 ;; ... fuzzy link.
1683 (should
1684 (equal
1685 "fuzzy"
1686 (org-test-with-temp-text "[[target-or-title]]"
1687 (org-element-property
1688 :type
1689 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1690 ;; ... file-type link with search option.
1691 (should
1692 (equal
1693 '(("file" "projects.org" "*task title"))
1694 (org-test-with-temp-text "[[file:projects.org::*task title]]"
1695 (org-element-map (org-element-parse-buffer) 'link
1696 (lambda (l) (list (org-element-property :type l)
1697 (org-element-property :path l)
1698 (org-element-property :search-option l)))))))
1699 ;; ... file-type link with application...
1700 (should
1701 (equal
1702 '("file" "projects.org" "emacs")
1703 (org-test-with-temp-text "[[file+emacs:projects.org]]"
1704 (let ((l (org-element-context)))
1705 (list (org-element-property :type l)
1706 (org-element-property :path l)
1707 (org-element-property :application l))))))
1708 ;; ... `:path' in a file-type link must be compatible with "file"
1709 ;; scheme in URI syntax, even if Org syntax isn't...
1710 (should
1711 (org-test-with-temp-text-in-file ""
1712 (let ((file (expand-file-name (buffer-file-name))))
1713 (insert (format "[[file://%s]]" file))
1714 (equal (org-element-property :path (org-element-context)) file))))
1715 (should
1716 (org-test-with-temp-text-in-file ""
1717 (let ((file (expand-file-name (buffer-file-name))))
1718 (insert (format "[[file:%s]]" file))
1719 (equal (org-element-property :path (org-element-context)) file))))
1720 (should
1721 (org-test-with-temp-text-in-file ""
1722 (let ((file (expand-file-name (buffer-file-name))))
1723 (insert (format "[[file:%s]]" file))
1724 (equal (org-element-property :path (org-element-context)) file))))
1725 ;; ... multi-line link.
1726 (should
1727 (equal "ls *.org"
1728 (org-test-with-temp-text "[[shell:ls\n*.org]]"
1729 (org-element-property :path (org-element-context)))))
1730 ;; Plain link.
1731 (should
1732 (org-test-with-temp-text "A link: http://orgmode.org"
1733 (org-element-map (org-element-parse-buffer) 'link 'identity)))
1734 ;; Angular link. Follow RFC 3986.
1735 (should
1736 (eq 'link
1737 (org-test-with-temp-text "A link: <point><http://orgmode.org>"
1738 (org-element-type (org-element-context)))))
1739 (should
1740 (equal "//orgmode.org"
1741 (org-test-with-temp-text "A link: <point><http://orgmode\n.org>"
1742 (org-element-property :path (org-element-context)))))
1743 ;; Link abbreviation.
1744 (should
1745 (equal "http"
1746 (org-test-with-temp-text
1747 "#+LINK: orgmode http://www.orgmode.org/\n[[orgmode:#docs]]"
1748 (progn (org-mode-restart)
1749 (goto-char (1- (point-max)))
1750 (org-element-property :type (org-element-context))))))
1751 ;; Link abbreviation in a secondary string.
1752 (should
1753 (equal "http"
1754 (org-test-with-temp-text
1755 "#+LINK: orgmode http://www.orgmode.org/\n* H [[orgmode:#docs]]"
1756 (progn (org-mode-restart)
1757 (org-element-map (org-element-parse-buffer) 'link
1758 (lambda (link) (org-element-property :type link))
1759 nil t nil t)))))
1760 ;; Plain links are allowed as description of regular links.
1761 (should
1762 (equal "file"
1763 (org-test-with-temp-text "[[http://orgmode.org][file:unicorn.jpg]]"
1764 (search-forward "file:")
1765 (org-element-property :type (org-element-context)))))
1766 ;; So are angular links.
1767 (should
1768 (equal "file"
1769 (org-test-with-temp-text "[[http://orgmode.org][<file:unicorn.jpg>]]"
1770 (search-forward "file:")
1771 (org-element-property :type (org-element-context))))))
1774 ;;;; Macro
1776 (ert-deftest test-org-element/macro-parser ()
1777 "Test `macro' parser."
1778 ;; Without arguments.
1779 (should
1780 (org-test-with-temp-text "{{{macro}}}"
1781 (org-element-map (org-element-parse-buffer) 'macro 'identity)))
1782 ;; With arguments.
1783 (should
1784 (org-test-with-temp-text "{{{macro(arg1,arg2)}}}"
1785 (org-element-map (org-element-parse-buffer) 'macro 'identity)))
1786 ;; Properly handle protected commas in arguments...
1787 (should
1788 (= 2
1789 (length
1790 (org-test-with-temp-text "{{{macro(arg1\\,arg1,arg2)}}}"
1791 (org-element-property :args (org-element-context))))))
1792 ;; ... even when last argument ends with a protected comma.
1793 (should
1794 (equal '("C-,")
1795 (org-test-with-temp-text "{{{macro(C-\\,)}}}"
1796 (org-element-property :args (org-element-context)))))
1797 ;; Allow to escape escaping character.
1798 (should
1799 (equal '("C-\\" "")
1800 (org-test-with-temp-text "{{{macro(C-\\\\,)}}}"
1801 (org-element-property :args (org-element-context)))))
1802 ;; No need to escape backslashes elsewhere.
1803 (should
1804 (equal '("\\")
1805 (org-test-with-temp-text "{{{macro(\\)}}}"
1806 (org-element-property :args (org-element-context))))))
1809 ;;;; Node Property
1811 (ert-deftest test-org-element/node-property ()
1812 "Test `node-property' parser."
1813 ;; Standard test.
1814 (should
1815 (equal '("abc" "value")
1816 (org-test-with-temp-text "* H\n:PROPERTIES:\n<point>:abc: value\n:END:"
1817 (let ((element (org-element-at-point)))
1818 (list (org-element-property :key element)
1819 (org-element-property :value element))))))
1820 ;; Value should be trimmed.
1821 (should
1822 (equal "value"
1823 (org-test-with-temp-text
1824 "* H\n:PROPERTIES:\n<point>:abc: value \n:END:"
1825 (org-element-property :value (org-element-at-point)))))
1826 ;; A node property requires to be wrapped within a property drawer.
1827 (should-not
1828 (eq 'node-property
1829 (org-test-with-temp-text ":abc: value"
1830 (org-element-type (org-element-at-point)))))
1831 ;; Accept empty properties.
1832 (should
1833 (equal '(("foo" "value") ("bar" ""))
1834 (org-test-with-temp-text "* H\n:PROPERTIES:\n:foo: value\n:bar:\n:END:"
1835 (org-element-map (org-element-parse-buffer) 'node-property
1836 (lambda (p)
1837 (list (org-element-property :key p)
1838 (org-element-property :value p))))))))
1841 ;;;; Paragraph
1843 (ert-deftest test-org-element/paragraph-parser ()
1844 "Test `paragraph' parser."
1845 ;; Standard test.
1846 (should
1847 (org-test-with-temp-text "Paragraph"
1848 (org-element-map (org-element-parse-buffer) 'paragraph 'identity nil t)))
1849 ;; Property find end of a paragraph stuck to another element.
1850 (should
1851 (eq ?#
1852 (org-test-with-temp-text "Paragraph\n# Comment"
1853 (org-element-map (org-element-parse-buffer) 'paragraph
1854 (lambda (p) (char-after (org-element-property :end p)))
1855 nil t))))
1856 ;; Include ill-formed Keywords.
1857 (should
1858 (org-test-with-temp-text "#+wrong_keyword something"
1859 (org-element-map (org-element-parse-buffer) 'paragraph 'identity)))
1860 ;; Include incomplete-drawers.
1861 (should
1862 (org-test-with-temp-text ":TEST:\nParagraph"
1863 (let ((elem (org-element-at-point)))
1864 (and (eq (org-element-type elem) 'paragraph)
1865 (= (point-max) (org-element-property :end elem))))))
1866 ;; Include incomplete blocks.
1867 (should
1868 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph"
1869 (let ((elem (org-element-at-point)))
1870 (and (eq (org-element-type elem) 'paragraph)
1871 (= (point-max) (org-element-property :end elem))))))
1872 ;; Include incomplete dynamic blocks.
1873 (should
1874 (org-test-with-temp-text "#+BEGIN: \nParagraph"
1875 (let ((elem (org-element-at-point)))
1876 (and (eq (org-element-type elem) 'paragraph)
1877 (= (point-max) (org-element-property :end elem))))))
1878 ;; Include incomplete latex environments.
1879 (should
1880 (org-test-with-temp-text "\begin{equation}\nParagraph"
1881 (let ((elem (org-element-at-point)))
1882 (and (eq (org-element-type elem) 'paragraph)
1883 (= (point-max) (org-element-property :end elem))))))
1884 (should
1885 (org-test-with-temp-text "Paragraph\n\begin{equation}"
1886 (let ((elem (org-element-at-point)))
1887 (and (eq (org-element-type elem) 'paragraph)
1888 (= (point-max) (org-element-property :end elem))))))
1889 ;; Stop at affiliated keywords.
1890 (should
1891 (org-test-with-temp-text "Paragraph\n#+NAME: test\n| table |"
1892 (let ((elem (org-element-at-point)))
1893 (and (eq (org-element-type elem) 'paragraph)
1894 (not (org-element-property :name elem))
1895 (= (org-element-property :end elem) (line-beginning-position 2))))))
1896 (should
1897 (org-test-with-temp-text
1898 "Paragraph\n#+CAPTION[with short caption]: test\n| table |"
1899 (let ((elem (org-element-at-point)))
1900 (and (eq (org-element-type elem) 'paragraph)
1901 (not (org-element-property :name elem))
1902 (= (org-element-property :end elem) (line-beginning-position 2))))))
1903 ;; Do not steal affiliated keywords from container.
1904 (should
1905 (org-test-with-temp-text "#+ATTR_LATEX: test\n- item<point> 1"
1906 (let ((elem (org-element-at-point)))
1907 (and (eq (org-element-type elem) 'paragraph)
1908 (not (org-element-property :attr_latex elem))
1909 (/= (org-element-property :begin elem) 1)))))
1910 ;; Handle non-empty blank line at the end of buffer.
1911 (should
1912 (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
1913 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1916 ;;;; Plain List
1918 (ert-deftest test-org-element/plain-list-parser ()
1919 "Test `plain-list' parser."
1920 (org-test-with-temp-text "- item"
1921 (should (org-element-map (org-element-parse-buffer) 'plain-list 'identity)))
1922 ;; Blank lines after the list only belong to outer plain list.
1923 (should
1924 (equal
1925 '(t t)
1926 (org-test-with-temp-text "
1927 - outer
1928 - inner
1930 Outside list"
1931 (let ((endings (org-element-map (org-element-parse-buffer) 'plain-list
1932 (lambda (pl) (org-element-property :end pl)))))
1933 (list
1934 ;; Move to ending of outer list.
1935 (progn (goto-char (car endings)) (looking-at "Outside list"))
1936 ;; Move to ending of inner list.
1937 (progn (goto-char (nth 1 endings)) (looking-at "^$")))))))
1938 ;; Correctly compute end of list if it doesn't end at a line
1939 ;; beginning.
1940 (should
1941 (org-test-with-temp-text "- list\n \n "
1942 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1945 ;;;; Planning
1947 (ert-deftest test-org-element/planning-parser ()
1948 "Test `planning' parser."
1949 ;; Test various keywords.
1950 (should
1951 (org-element-property
1952 :closed
1953 (org-test-with-temp-text "* H\n<point>CLOSED: [2012-03-29 thu.]"
1954 (org-element-at-point))))
1955 (should
1956 (org-element-property
1957 :deadline
1958 (org-test-with-temp-text "* H\n<point>DEADLINE: <2012-03-29 thu.>"
1959 (org-element-at-point))))
1960 (should
1961 (org-element-property
1962 :scheduled
1963 (org-test-with-temp-text "* H\n<point>SCHEDULED: <2012-03-29 thu.>"
1964 (org-element-at-point))))
1965 ;; Planning line only exists right after a headline.
1966 (should-not
1967 (eq 'planning
1968 (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>"
1969 (org-element-type (org-element-at-point)))))
1970 (should-not
1971 (eq 'planning
1972 (org-test-with-temp-text
1973 "* H\n# Comment\n<point>DEADLINE: <2012-03-29 thu.>"
1974 (org-element-type (org-element-at-point)))))
1975 (should-not
1976 (eq 'planning
1977 (org-test-with-temp-text
1978 "* H\n\n<point>DEADLINE: <2012-03-29 thu.>"
1979 (org-element-type (org-element-at-point))))))
1982 ;;;; Property Drawer
1984 (ert-deftest test-org-element/property-drawer-parser ()
1985 "Test `property-drawer' parser."
1986 ;; Standard test.
1987 (should
1988 (eq 'property-drawer
1989 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop: value\n:END:"
1990 (org-element-type (org-element-at-point)))))
1991 (should
1992 (eq 'property-drawer
1993 (org-test-with-temp-text
1994 "* H\nDEADLINE: <2014-03-04 tue.>\n<point>:PROPERTIES:\n:prop: value\n:END:"
1995 (org-element-type (org-element-at-point)))))
1996 ;; Allow properties without value and no property at all.
1997 (should
1998 (eq 'property-drawer
1999 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop:\n:END:"
2000 (org-element-type (org-element-at-point)))))
2001 (should
2002 (eq 'property-drawer
2003 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:END:"
2004 (org-element-type (org-element-at-point)))))
2005 ;; Ignore incomplete drawer, drawer at a wrong location or with
2006 ;; wrong contents.
2007 (should-not
2008 (eq 'property-drawer
2009 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop: value"
2010 (org-element-type (org-element-at-point)))))
2011 (should-not
2012 (eq 'property-drawer
2013 (org-test-with-temp-text
2014 "* H\nParagraph\n<point>:PROPERTIES:\n:prop: value\n:END:"
2015 (org-element-type (org-element-at-point)))))
2016 (should-not
2017 (eq 'property-drawer
2018 (org-test-with-temp-text
2019 "* H\nParagraph\n<point>:PROPERTIES:\nparagraph\n:END:"
2020 (org-element-type (org-element-at-point)))))
2021 (should-not
2022 (eq 'property-drawer
2023 (org-test-with-temp-text
2024 "* H\n\n<point>:PROPERTIES:\n:prop: value\n:END:"
2025 (org-element-type (org-element-at-point)))))
2026 ;; Handle non-empty blank line at the end of buffer.
2027 (should
2028 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:END:\n "
2029 (= (org-element-property :end (org-element-at-point)) (point-max)))))
2032 ;;;; Quote Block
2034 (ert-deftest test-org-element/quote-block-parser ()
2035 "Test `quote-block' parser."
2036 ;; Regular test.
2037 (should
2038 (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
2039 (org-element-map (org-element-parse-buffer) 'quote-block 'identity)))
2040 ;; Ignore incomplete block.
2041 (should-not
2042 (org-test-with-temp-text "#+BEGIN_QUOTE"
2043 (org-element-map (org-element-parse-buffer) 'quote-block 'identity nil t)))
2044 ;; Handle non-empty blank line at the end of buffer.
2045 (should
2046 (org-test-with-temp-text "#+BEGIN_QUOTE\nC\n#+END_QUOTE\n "
2047 (= (org-element-property :end (org-element-at-point)) (point-max)))))
2050 ;;;; Radio Target
2052 (ert-deftest test-org-element/radio-target-parser ()
2053 "Test `radio-target' parser."
2054 ;; Standard test.
2055 (should
2056 (eq 'radio-target
2057 (org-test-with-temp-text "<<<radio>>>"
2058 (org-element-type (org-element-context)))))
2059 ;; Radio targets with objects.
2060 (should
2061 (eq 'radio-target
2062 (org-test-with-temp-text "<<<radio \\alpha>>>"
2063 (org-element-type (org-element-context)))))
2064 ;; Radio targets starting with an object.
2065 (should
2066 (eq 'radio-target
2067 (org-test-with-temp-text "<<<\\alpha radio>>>"
2068 (org-element-type (org-element-context)))))
2069 ;; Radio targets cannot begin or end with white space.
2070 (should-not
2071 (eq 'radio-target
2072 (org-test-with-temp-text "<<< radio>>>"
2073 (org-element-type (org-element-context)))))
2074 (should-not
2075 (eq 'radio-target
2076 (org-test-with-temp-text "<<<radio >>>"
2077 (org-element-type (org-element-context))))))
2080 ;;;; Section
2082 (ert-deftest test-org-element/section-parser ()
2083 "Test `section' parser."
2084 ;; Standard test.
2085 (should
2086 (org-test-with-temp-text "* Headline\nText"
2087 (org-element-map (org-element-parse-buffer) 'section 'identity)))
2088 ;; There's a section before the first headline.
2089 (should
2090 (org-test-with-temp-text "Text"
2091 (org-element-map (org-element-parse-buffer) 'section 'identity)))
2092 ;; A section cannot be empty.
2093 (should-not
2094 (org-test-with-temp-text "* Headline 1\n* Headline 2"
2095 (org-element-map (org-element-parse-buffer) 'section 'identity)))
2096 ;; A section doesn't contain sub-trees.
2097 (should-not
2098 (org-test-with-temp-text "* Head\nText\n** Sub-Head"
2099 (org-element-map
2100 (org-element-map (org-element-parse-buffer) 'section 'identity nil t)
2101 'headline 'identity))))
2104 ;;;; Special Block
2106 (ert-deftest test-org-element/special-block-parser ()
2107 "Test `special-block' parser."
2108 ;; Standard test.
2109 (should
2110 (equal "SPECIAL"
2111 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
2112 (org-element-property :type (org-element-at-point)))))
2113 ;; Special blocks are case sensitive.
2114 (should
2115 (equal "CaSe"
2116 (org-test-with-temp-text "#+BEGIN_CaSe\nText\n#+END_CaSe"
2117 (org-element-property :type (org-element-at-point)))))
2118 ;; Special blocks can contain paragraphs.
2119 (should
2120 (eq 'paragraph
2121 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
2122 (forward-line)
2123 (org-element-type (org-element-at-point)))))
2124 ;; Ignore incomplete block.
2125 (should-not
2126 (eq 'special-block
2127 (org-test-with-temp-text "#+BEGIN_SPECIAL"
2128 (org-element-type (org-element-at-point)))))
2129 ;; Allow special characters in type.
2130 (should
2131 (equal '(special-block "SPECIAL*")
2132 (org-test-with-temp-text "#+BEGIN_SPECIAL*\nContents\n#+END_SPECIAL*"
2133 (let ((element (org-element-at-point)))
2134 (list (org-element-type element)
2135 (org-element-property :type element))))))
2136 ;; Handle non-empty blank line at the end of buffer.
2137 (should
2138 (org-test-with-temp-text "#+BEGIN_SPECIAL\nC\n#+END_SPECIAL\n "
2139 (= (org-element-property :end (org-element-at-point)) (point-max)))))
2142 ;;;; Src Block
2144 (ert-deftest test-org-element/src-block-parser ()
2145 "Test `src-block' parser."
2146 ;; Regular tests.
2147 (should
2148 (org-test-with-temp-text "#+BEGIN_SRC org\nText\n#+END_SRC"
2149 (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
2150 ;; Ignore incomplete block.
2151 (should-not
2152 (org-test-with-temp-text "#+BEGIN_SRC"
2153 (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
2154 ;; Properly un-escape code.
2155 (should
2156 (equal "* Headline\n #+keyword\nText\n"
2157 (org-test-with-temp-text
2158 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText\n#+END_SRC"
2159 (org-element-property :value (org-element-at-point)))))
2160 ;; Handle non-empty blank line at the end of buffer.
2161 (should
2162 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\nC\n#+END_SRC\n "
2163 (= (org-element-property :end (org-element-at-point)) (point-max)))))
2166 ;;;; Statistics Cookie
2168 (ert-deftest test-org-element/statistics-cookie ()
2169 "Test `statistics-cookie' parser."
2170 ;; With numbers.
2171 (should
2172 (org-test-with-temp-text "[1/2]"
2173 (org-element-map (org-element-parse-buffer) 'statistics-cookie 'identity)))
2174 ;; With percents.
2175 (should
2176 (org-test-with-temp-text "[33%]"
2177 (org-element-map
2178 (org-element-parse-buffer) 'statistics-cookie 'identity))))
2181 ;;;; Strike Through
2183 (ert-deftest test-org-element/strike-through-parser ()
2184 "Test `strike-through' parser."
2185 ;; Regular test.
2186 (should
2187 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2188 (org-test-with-temp-text "+strike-through+"
2189 (org-element-map (org-element-parse-buffer) 'strike-through 'identity))))
2190 ;; Multi-line markup.
2191 (should
2192 (equal
2193 (org-element-contents
2194 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2195 (org-test-with-temp-text "+first line\nsecond line+"
2196 (org-element-map
2197 (org-element-parse-buffer) 'strike-through 'identity nil t))))
2198 '("first line\nsecond line"))))
2201 ;;;; Subscript
2203 (ert-deftest test-org-element/subscript-parser ()
2204 "Test `subscript' parser."
2205 ;; Without braces.
2206 (should
2207 (org-test-with-temp-text "a_b"
2208 (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
2209 ;; With braces.
2210 (should
2211 (org-test-with-temp-text "a_{b}"
2212 (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
2213 ;; Multiple subscripts in a paragraph.
2214 (should
2215 (= 2
2216 (org-test-with-temp-text "a_b and c_d"
2217 (length
2218 (org-element-map (org-element-parse-buffer) 'subscript 'identity))))))
2221 ;;;; Superscript
2223 (ert-deftest test-org-element/superscript-parser ()
2224 "Test `superscript' parser."
2225 ;; Without braces.
2226 (should
2227 (org-test-with-temp-text "a^b"
2228 (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
2229 ;; With braces.
2230 (should
2231 (org-test-with-temp-text "a^{b}"
2232 (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
2233 ;; Multiple superscript in a paragraph.
2234 (should
2235 (= 2
2236 (org-test-with-temp-text "a^b and c^d"
2237 (length
2238 (org-element-map
2239 (org-element-parse-buffer) 'superscript 'identity))))))
2242 ;;;; Table
2244 (ert-deftest test-org-element/table-parser ()
2245 "Test `table' parser."
2246 (should
2247 (org-test-with-temp-text "| a |"
2248 (org-element-map (org-element-parse-buffer) 'table 'identity)))
2249 ;; TBLFM keyword is case insensitive.
2250 (should
2251 (org-test-with-temp-text "| a |\n#+tblfm: test"
2252 (org-element-property
2253 :tblfm
2254 (org-element-map (org-element-parse-buffer) 'table 'identity nil t))))
2255 ;; Handle multiple TBLFM lines.
2256 (should
2257 (= 2
2258 (org-test-with-temp-text "| a |\n#+TBLFM: test1\n#+TBLFM: test2"
2259 (length (org-element-property
2260 :tblfm
2261 (org-element-map
2262 (org-element-parse-buffer) 'table 'identity nil t))))))
2263 ;; Handle non-empty blank line at the end of buffer.
2264 (should
2265 (org-test-with-temp-text "| a |\n "
2266 (= (org-element-property :end (org-element-at-point)) (point-max)))))
2269 ;;;; Table Cell
2271 (ert-deftest test-org-element/table-cell-parser ()
2272 "Test `table-cell' parser."
2273 ;; Regular table cell.
2274 (should
2275 (org-test-with-temp-text "| a |"
2276 (org-element-map (org-element-parse-buffer) 'table-cell 'identity)))
2277 ;; Last vertical bar may be omitted.
2278 (should
2279 (org-test-with-temp-text "| a "
2280 (org-element-map (org-element-parse-buffer) 'table-cell 'identity))))
2283 ;;;; Table Row
2285 (ert-deftest test-org-element/table-row-parser ()
2286 "Test `table-row' parser."
2287 (should
2288 (equal '(standard rule)
2289 (org-test-with-temp-text "| a |\n|---|"
2290 (org-element-map
2291 (org-element-parse-buffer) 'table-row
2292 (lambda (row) (org-element-property :type row)))))))
2295 ;;;; Target
2297 (ert-deftest test-org-element/target-parser ()
2298 "Test `target' parser."
2299 (should
2300 (org-test-with-temp-text "<<target>>"
2301 (org-element-map (org-element-parse-buffer) 'target 'identity))))
2304 ;;;; Timestamp
2306 (ert-deftest test-org-element/timestamp ()
2307 "Test `timestamp' parser."
2308 ;; Active timestamp.
2309 (should
2310 (org-test-with-temp-text "<2012-03-29 16:40>"
2311 (eq (org-element-property :type (org-element-context)) 'active)))
2312 (should-not
2313 (org-test-with-temp-text "<2012-03-29 Thu>"
2314 (let ((timestamp (org-element-context)))
2315 (or (org-element-property :hour-start timestamp)
2316 (org-element-property :minute-start timestamp)))))
2317 (should
2318 (equal '(2012 3 29 16 40)
2319 (org-test-with-temp-text "<2012-03-29 Thu 16:40>"
2320 (let ((object (org-element-context)))
2321 (list (org-element-property :year-start object)
2322 (org-element-property :month-start object)
2323 (org-element-property :day-start object)
2324 (org-element-property :hour-start object)
2325 (org-element-property :minute-start object))))))
2326 ;; Inactive timestamp.
2327 (should
2328 (org-test-with-temp-text "[2012-03-29 Thu 16:40]"
2329 (eq (org-element-property :type (org-element-context)) 'inactive)))
2330 ;; Time range.
2331 (should
2332 (equal '(2012 3 29 16 40 7 30)
2333 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
2334 (let ((object (org-element-context)))
2335 (list (org-element-property :year-end object)
2336 (org-element-property :month-end object)
2337 (org-element-property :day-end object)
2338 (org-element-property :hour-end object)
2339 (org-element-property :minute-end object)
2340 (org-element-property :hour-start object)
2341 (org-element-property :minute-start object))))))
2342 (should
2343 (eq 'active-range
2344 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
2345 (org-element-property :type (org-element-context)))))
2346 ;; Date range.
2347 (should
2348 (org-test-with-temp-text "[2012-03-29 Thu 16:40]--[2012-03-29 Thu 16:41]"
2349 (eq (org-element-property :type (org-element-context)) 'inactive-range)))
2350 (should-not
2351 (org-test-with-temp-text "[2011-07-14 Thu]--[2012-03-29 Thu]"
2352 (let ((timestamp (org-element-context)))
2353 (or (org-element-property :hour-end timestamp)
2354 (org-element-property :minute-end timestamp)))))
2355 ;; With repeater, warning delay and both.
2356 (should
2357 (eq 'catch-up
2358 (org-test-with-temp-text "<2012-03-29 Thu ++1y>"
2359 (org-element-property :repeater-type (org-element-context)))))
2360 (should
2361 (eq 'first
2362 (org-test-with-temp-text "<2012-03-29 Thu --1y>"
2363 (org-element-property :warning-type (org-element-context)))))
2364 (should
2365 (equal '(cumulate all)
2366 (org-test-with-temp-text "<2012-03-29 Thu +1y -1y>"
2367 (let ((ts (org-element-context)))
2368 (list (org-element-property :repeater-type ts)
2369 (org-element-property :warning-type ts)))))))
2372 ;;;; Underline
2374 (ert-deftest test-org-element/underline-parser ()
2375 "Test `underline' parser."
2376 ;; Regular test.
2377 (should
2378 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2379 (org-test-with-temp-text "_underline_"
2380 (org-element-map (org-element-parse-buffer) 'underline 'identity))))
2381 ;; Multi-line markup.
2382 (should
2383 (equal
2384 (org-element-contents
2385 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2386 (org-test-with-temp-text "_first line\nsecond line_"
2387 (org-element-map
2388 (org-element-parse-buffer) 'underline 'identity nil t))))
2389 '("first line\nsecond line"))))
2392 ;;;; Verbatim
2394 (ert-deftest test-org-element/verbatim-parser ()
2395 "Test `verbatim' parser."
2396 ;; Regular test.
2397 (should
2398 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2399 (org-test-with-temp-text "=verbatim="
2400 (org-element-map (org-element-parse-buffer) 'verbatim 'identity))))
2401 ;; Multi-line markup.
2402 (should
2403 (equal
2404 (org-element-property
2405 :value
2406 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2407 (org-test-with-temp-text "=first line\nsecond line="
2408 (org-element-map
2409 (org-element-parse-buffer) 'verbatim 'identity nil t))))
2410 "first line\nsecond line")))
2413 ;;;; Verse Block
2415 (ert-deftest test-org-element/verse-block-parser ()
2416 "Test `verse-block' parser."
2417 ;; Standard test.
2418 (should
2419 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
2420 (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
2421 ;; Ignore case.
2422 (should
2423 (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
2424 (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
2425 ;; Parse objects in verse blocks.
2426 (should
2427 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
2428 (org-element-map (org-element-parse-buffer) 'entity 'identity)))
2429 ;; Ignore incomplete verse block.
2430 (should-not
2431 (org-test-with-temp-text "#+BEGIN_VERSE"
2432 (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)))
2433 ;; Handle non-empty blank line at the end of buffer.
2434 (should
2435 (org-test-with-temp-text "#+BEGIN_VERSE\nC\n#+END_VERSE\n "
2436 (= (org-element-property :end (org-element-at-point)) (point-max)))))
2440 ;;; Test Interpreters.
2442 (ert-deftest test-org-element/interpret-data ()
2443 "Test `org-element-interpret-data' specifications."
2444 ;; Interpret simple affiliated keywords.
2445 (should
2446 (equal
2447 (org-element-interpret-data
2448 '(org-data nil (paragraph (:name "para") "Paragraph")))
2449 "#+NAME: para\nParagraph\n"))
2450 ;; Interpret multiple affiliated keywords.
2451 (should
2452 (equal
2453 (org-element-interpret-data
2454 '(org-data nil (paragraph (:attr_ascii ("line2" "line1")) "Paragraph")))
2455 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
2456 ;; Interpret parsed affiliated keywords.
2457 (should
2458 (equal
2459 (org-element-interpret-data
2460 '(org-data nil (paragraph (:caption (("caption"))) "Paragraph")))
2461 "#+CAPTION: caption\nParagraph\n"))
2462 ;; Interpret dual affiliated keywords.
2463 (should
2464 (equal
2465 (org-element-interpret-data
2466 '(org-data nil (paragraph (:caption ((("long") "short"))) "Paragraph")))
2467 "#+CAPTION[short]: long\nParagraph\n"))
2468 ;; Interpret multiple parsed dual keywords.
2469 (should
2470 (equal
2471 (org-element-interpret-data
2472 '(org-data nil (paragraph
2473 (:caption ((("l2") "s2") (("l1") "s1"))) "Paragraph")))
2474 "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph\n"))
2475 ;; Pseudo objects and elements are transparent.
2476 (should
2477 (equal "A B"
2478 (org-trim
2479 (org-element-interpret-data
2480 '(paragraph nil (pseudo-object (:post-blank 1) "A") "B")))))
2481 (should
2482 (equal "A\n\nB\n"
2483 (org-element-interpret-data
2484 '(center nil
2485 (pseudo-element (:post-blank 1) (paragraph nil "A"))
2486 (paragraph nil "B"))))))
2488 (ert-deftest test-org-element/center-block-interpreter ()
2489 "Test center block interpreter."
2490 (should
2491 (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
2492 "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
2494 (ert-deftest test-org-element/drawer-interpreter ()
2495 "Test drawer interpreter."
2496 (should
2497 (equal (org-test-parse-and-interpret ":TEST:\nTest\n:END:")
2498 ":TEST:\nTest\n:END:\n")))
2500 (ert-deftest test-org-element/dynamic-block-interpreter ()
2501 "Test dynamic block interpreter."
2502 (should
2503 (equal (org-test-parse-and-interpret
2504 "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
2505 "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
2507 (ert-deftest test-org-element/footnote-definition-interpreter ()
2508 "Test footnote definition interpreter."
2509 (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
2511 (ert-deftest test-org-element/headline-interpreter ()
2512 "Test headline and section interpreters."
2513 ;; 1. Standard test.
2514 (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
2515 ;; 2. With TODO keywords.
2516 (should
2517 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2518 (org-test-parse-and-interpret "* TODO Headline"))
2519 "* TODO Headline\n"))
2520 ;; 3. With tags...
2522 ;; 3.1. ... and a positive `org-tags-column' value.
2523 (should
2524 (equal (let ((org-tags-column 20))
2525 (org-test-parse-and-interpret "* Headline :tag:"))
2526 "* Headline :tag:\n"))
2527 ;; 3.2. ... and a negative `org-tags-column' value.
2528 (should
2529 (equal (let ((org-tags-column -20))
2530 (org-test-parse-and-interpret "* Headline :tag:"))
2531 "* Headline :tag:\n"))
2532 ;; 3.3. ... and a null `org-tags-column' value.
2533 (should
2534 (equal (let ((org-tags-column 0))
2535 (org-test-parse-and-interpret "* Headline :tag:"))
2536 "* Headline :tag:\n"))
2537 ;; 4. With priority cookie.
2538 (should
2539 (equal (org-test-parse-and-interpret "* [#B] Headline")
2540 "* [#B] Headline\n"))
2541 ;; 5. With comment keyword.
2542 (should
2543 (equal (let ((org-comment-string "COMMENT"))
2544 (org-test-parse-and-interpret "* COMMENT Headline"))
2545 "* COMMENT Headline\n"))
2546 ;; 6. Keep same number of blank lines before body.
2547 (should
2548 (equal (org-test-parse-and-interpret
2549 "* Headline\n\n\nText after two blank lines.")
2550 "* Headline\n\n\nText after two blank lines.\n"))
2551 ;; 8. Preserve `org-odd-levels-only' state.
2552 (should
2553 (equal "* H\n*** H2\n"
2554 (let ((org-odd-levels-only t))
2555 (org-test-parse-and-interpret "* H\n*** H2")))))
2557 (ert-deftest test-org-element/inlinetask-interpreter ()
2558 "Test inlinetask interpretation."
2559 (when (featurep 'org-inlinetask)
2560 (let ((org-inlinetask-min-level 15))
2561 ;; 1. Regular inlinetask.
2562 (should (equal (org-test-parse-and-interpret
2563 "*************** Task\nTest\n*************** END")
2564 "*************** Task\nTest\n*************** END\n"))
2565 ;; 2. Degenerate inlinetask.
2566 (should (equal (org-test-parse-and-interpret "*************** Task")
2567 "*************** Task\n"))
2568 ;; 3. Prefer degenerate form when there are no contents.
2569 (should (equal (org-test-parse-and-interpret
2570 "*************** Task\n*************** END")
2571 "*************** Task\n"))
2572 ;; 4. With TODO keywords.
2573 (should
2574 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2575 (org-test-parse-and-interpret "*************** TODO Task"))
2576 "*************** TODO Task\n"))
2577 ;; 5. With tags...
2579 ;; 5.1. ... and a positive `org-tags-column' value.
2580 (should
2581 (equal (let ((org-tags-column 30))
2582 (org-test-parse-and-interpret "*************** Task :tag:"))
2583 "*************** Task :tag:\n"))
2584 ;; 5.2. ... and a negative `org-tags-column' value.
2585 (should
2586 (equal (let ((org-tags-column -30))
2587 (org-test-parse-and-interpret "*************** Task :tag:"))
2588 "*************** Task :tag:\n"))
2589 ;; 5.3. ... and a null `org-tags-column' value.
2590 (should
2591 (equal (let ((org-tags-column 0))
2592 (org-test-parse-and-interpret "*************** Task :tag:"))
2593 "*************** Task :tag:\n"))
2594 ;; 6. With priority cookie.
2595 (should
2596 (equal (org-test-parse-and-interpret "*************** [#B] Task")
2597 "*************** [#B] Task\n")))))
2599 (ert-deftest test-org-element/plain-list-interpreter ()
2600 "Test plain-list and item interpreters."
2601 (let ((org-list-two-spaces-after-bullet-regexp nil))
2602 ;; Unordered list.
2603 (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
2604 ;; Description list.
2605 (should
2606 (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
2607 ;; Ordered list.
2608 (should
2609 (equal (let ((org-plain-list-ordered-item-terminator t))
2610 (org-test-parse-and-interpret "1. Item"))
2611 "1. Item\n"))
2612 (should
2613 (equal (let ((org-plain-list-ordered-item-terminator ?\)))
2614 (org-test-parse-and-interpret "1) Item"))
2615 "1) Item\n"))
2616 ;; Ordered list with counter.
2617 (should
2618 (equal (let ((org-plain-list-ordered-item-terminator t))
2619 (org-test-parse-and-interpret "1. [@5] Item"))
2620 "5. [@5] Item\n"))
2621 ;; List with check-boxes.
2622 (should
2623 (equal (org-test-parse-and-interpret
2624 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
2625 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n"))
2626 ;; Item not starting with a paragraph.
2627 (should
2628 (equal (org-test-parse-and-interpret "-\n | a | b |")
2629 "- \n | a | b |\n"))
2630 ;; Special case: correctly handle "*" bullets.
2631 (should (org-test-parse-and-interpret " * item"))
2632 ;; Special case: correctly handle empty items.
2633 (should (org-test-parse-and-interpret "-"))))
2635 (ert-deftest test-org-element/quote-block-interpreter ()
2636 "Test quote block interpreter."
2637 (should (equal (org-test-parse-and-interpret
2638 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
2639 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
2641 (ert-deftest test-org-element/special-block-interpreter ()
2642 "Test special block interpreter."
2643 (should (equal (org-test-parse-and-interpret
2644 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
2645 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
2647 (ert-deftest test-org-element/babel-call-interpreter ()
2648 "Test Babel call interpreter."
2649 ;; Without argument.
2650 (should (equal (org-test-parse-and-interpret "#+CALL: test()")
2651 "#+CALL: test()\n"))
2652 ;; With argument.
2653 (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
2654 "#+CALL: test(x=2)\n"))
2655 ;; With header arguments.
2656 (should (equal (org-test-parse-and-interpret
2657 "#+CALL: test[:results output]() :results html")
2658 "#+CALL: test[:results output]() :results html\n")))
2660 (ert-deftest test-org-element/clock-interpreter ()
2661 "Test clock interpreter."
2662 ;; Running clock.
2663 (should
2664 (string-match
2665 "CLOCK: \\[2012-01-01 .* 00:01\\]"
2666 (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]")))
2667 ;; Closed clock.
2668 (should
2669 (string-match
2670 "CLOCK: \\[2012-01-01 .* 00:01\\]--\\[2012-01-01 .* 00:02\\] => 0:01"
2671 (org-test-parse-and-interpret "
2672 CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))))
2674 (ert-deftest test-org-element/comment-interpreter ()
2675 "Test comment interpreter."
2676 ;; Regular comment.
2677 (should (equal (org-test-parse-and-interpret "# Comment") "# Comment\n"))
2678 ;; Inline comment.
2679 (should (equal (org-test-parse-and-interpret " # Comment")
2680 "# Comment\n"))
2681 ;; Preserve indentation.
2682 (should (equal (org-test-parse-and-interpret " # No blank\n# One blank")
2683 "# No blank\n# One blank\n")))
2685 (ert-deftest test-org-element/comment-block-interpreter ()
2686 "Test comment block interpreter."
2687 (should (equal (org-test-parse-and-interpret
2688 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
2689 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n"))
2690 ;; Accept missing final newline in value.
2691 (should
2692 (equal
2693 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n"
2694 (org-element-interpret-data '(comment-block (:value "Test"))))))
2696 (ert-deftest test-org-element/diary-sexp ()
2697 "Test diary-sexp interpreter."
2698 (should
2699 (equal
2700 (org-test-parse-and-interpret
2701 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old")
2702 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old\n")))
2704 (ert-deftest test-org-element/example-block-interpreter ()
2705 "Test example block interpreter."
2706 ;; Without switches.
2707 (should (equal (org-test-parse-and-interpret
2708 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
2709 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
2710 ;; With switches.
2711 (should
2712 (equal (org-test-parse-and-interpret
2713 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
2714 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n"))
2715 ;; Preserve code escaping.
2716 (should
2717 (equal (org-test-parse-and-interpret
2718 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE")
2719 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE\n"))
2720 ;; Accept missing final newline in value.
2721 (should
2722 (equal
2723 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"
2724 (org-element-interpret-data '(example-block (:value "Test"))))))
2726 (ert-deftest test-org-element/export-block-interpreter ()
2727 "Test export block interpreter."
2728 (should (equal (org-test-parse-and-interpret
2729 "#+BEGIN_EXPORT HTML\nTest\n#+END_EXPORT")
2730 "#+BEGIN_EXPORT HTML\nTest\n#+END_EXPORT\n")))
2732 (ert-deftest test-org-element/fixed-width-interpreter ()
2733 "Test fixed width interpreter."
2734 ;; Standard test.
2735 (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
2736 ;; Preserve indentation.
2737 (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
2738 ": 2 blanks\n: 1 blank\n"))
2739 ;; Remove last newline character
2740 (should
2741 (equal (org-element-fixed-width-interpreter
2742 '(fixed-width (:value "Test\n")) nil)
2743 ": Test"))
2744 (should
2745 (equal (org-element-fixed-width-interpreter
2746 '(fixed-width (:value "Test")) nil)
2747 ": Test"))
2748 ;; Handle empty string.
2749 (should
2750 (equal (org-element-fixed-width-interpreter
2751 '(fixed-width (:value "")) nil)
2752 ""))
2753 ;; Handle nil value.
2754 (should-not
2755 (org-element-fixed-width-interpreter
2756 '(fixed-width (:value nil)) nil)))
2758 (ert-deftest test-org-element/horizontal-rule-interpreter ()
2759 "Test horizontal rule interpreter."
2760 (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
2762 (ert-deftest test-org-element/keyword-interpreter ()
2763 "Test keyword interpreter."
2764 (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
2765 "#+KEYWORD: value\n")))
2767 (ert-deftest test-org-element/latex-environment-interpreter ()
2768 "Test latex environment interpreter."
2769 (should (equal (org-test-parse-and-interpret
2770 "\\begin{equation}\n1+1=2\n\\end{equation}")
2771 "\\begin{equation}\n1+1=2\n\\end{equation}\n"))
2772 (should (equal (org-test-parse-and-interpret
2773 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}")
2774 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}\n")))
2776 (ert-deftest test-org-element/planning-interpreter ()
2777 "Test planning interpreter."
2778 (should
2779 (string-match
2780 "\\* Headline
2781 DEADLINE: <2012-03-29 .*?> SCHEDULED: <2012-03-29 .*?> CLOSED: \\[2012-03-29 .*?\\]"
2782 (org-test-parse-and-interpret
2783 "* Headline
2784 DEADLINE: <2012-03-29 thu.> SCHEDULED: <2012-03-29 thu.> CLOSED: [2012-03-29 thu.]"))))
2786 (ert-deftest test-org-element/property-drawer-interpreter ()
2787 "Test property drawer interpreter."
2788 (should (equal (let ((org-property-format "%-10s %s"))
2789 (org-test-parse-and-interpret
2790 "* H\n:PROPERTIES:\n:prop: value\n:END:"))
2791 "* H\n:PROPERTIES:\n:prop: value\n:END:\n")))
2793 (ert-deftest test-org-element/src-block-interpreter ()
2794 "Test src block interpreter."
2795 ;; With arguments.
2796 (should
2797 (equal (let ((org-edit-src-content-indentation 2)
2798 (org-src-preserve-indentation nil))
2799 (org-test-parse-and-interpret
2800 "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC"))
2801 "#+BEGIN_SRC emacs-lisp :results silent\n (+ 1 1)\n#+END_SRC\n"))
2802 ;; With switches.
2803 (should
2804 (equal (let ((org-edit-src-content-indentation 2)
2805 (org-src-preserve-indentation nil))
2806 (org-test-parse-and-interpret
2807 "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC"))
2808 "#+BEGIN_SRC emacs-lisp -n -k\n (+ 1 1)\n#+END_SRC\n"))
2809 ;; Preserve code escaping.
2810 (should
2811 (equal (let ((org-edit-src-content-indentation 2)
2812 (org-src-preserve-indentation nil))
2813 (org-test-parse-and-interpret
2814 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC"))
2815 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC\n"))
2816 ;; Do not apply `org-edit-src-content-indentation' when preserving
2817 ;; indentation.
2818 (should
2819 (equal (let ((org-edit-src-content-indentation 2)
2820 (org-src-preserve-indentation t))
2821 (org-test-parse-and-interpret
2822 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"))
2823 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n"))
2824 (should
2825 (equal (let ((org-edit-src-content-indentation 2)
2826 (org-src-preserve-indentation nil))
2827 (org-test-parse-and-interpret
2828 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"))
2829 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC\n"))
2830 ;; Accept missing final newline in value.
2831 (should
2832 (equal
2833 "#+BEGIN_SRC emacs-lisp\n Test\n#+END_SRC\n"
2834 (let ((org-edit-src-content-indentation 2)
2835 (org-src-preserve-indentation nil))
2836 (org-element-interpret-data
2837 '(src-block (:language "emacs-lisp" :value "Test")))))))
2839 (ert-deftest test-org-element/table-interpreter ()
2840 "Test table, table-row and table-cell interpreters."
2841 ;; 1. Simple table.
2842 (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
2843 "| a | b |\n| c | d |\n"))
2844 ;; 2. With horizontal rules.
2845 (should (equal (org-test-parse-and-interpret
2846 "| a | b |\n|---+---|\n| c | d |")
2847 "| a | b |\n|---+---|\n| c | d |\n"))
2848 ;; 3. With meta-data.
2849 (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
2850 "| / | < | > |\n| * | 1 | 2 |\n"))
2851 ;; 4. With a formula.
2852 (should
2853 (equal (org-test-parse-and-interpret
2854 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)")
2855 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)\n"))
2856 ;; 5. With multiple formulas.
2857 (should
2858 (equal (org-test-parse-and-interpret
2859 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2")
2860 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2\n")))
2862 (ert-deftest test-org-element/timestamp-interpreter ()
2863 "Test timestamp interpreter."
2864 ;; Active.
2865 (should
2866 (string-match "<2012-03-29 .* 16:40>"
2867 (org-test-parse-and-interpret "<2012-03-29 thu. 16:40>")))
2868 (should
2869 (string-match "<2012-03-29 .* 16:40>"
2870 (org-element-timestamp-interpreter
2871 '(timestamp
2872 (:type active :year-start 2012 :month-start 3 :day-start 29
2873 :hour-start 16 :minute-start 40)) nil)))
2874 ;; Inactive.
2875 (should
2876 (string-match "\\[2012-03-29 .* 16:40\\]"
2877 (org-test-parse-and-interpret "[2012-03-29 thu. 16:40]")))
2878 (should
2879 (string-match
2880 "\\[2012-03-29 .* 16:40\\]"
2881 (org-element-timestamp-interpreter
2882 '(timestamp
2883 (:type inactive :year-start 2012 :month-start 3 :day-start 29
2884 :hour-start 16 :minute-start 40)) nil)))
2885 ;; Active range.
2886 (should
2887 (string-match "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2888 (org-test-parse-and-interpret
2889 "<2012-03-29 thu. 16:40>--<2012-03-29 thu. 16:41>")))
2890 (should
2891 (string-match
2892 "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2893 (org-element-timestamp-interpreter
2894 '(timestamp
2895 (:type active-range :year-start 2012 :month-start 3 :day-start 29
2896 :hour-start 16 :minute-start 40 :year-end 2012 :month-end 3
2897 :day-end 29 :hour-end 16 :minute-end 41)) nil)))
2898 ;; Inactive range.
2899 (should
2900 (string-match "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2901 (org-test-parse-and-interpret
2902 "[2012-03-29 thu. 16:40]--[2012-03-29 thu. 16:41]")))
2903 (should
2904 (string-match
2905 "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2906 (org-element-timestamp-interpreter
2907 '(timestamp
2908 (:type inactive-range :year-start 2012 :month-start 3 :day-start 29
2909 :hour-start 16 :minute-start 40 :year-end 2012 :month-end 3
2910 :day-end 29 :hour-end 16 :minute-end 41)) nil)))
2911 ;; Diary.
2912 (should (equal (org-test-parse-and-interpret "<%%diary-float t 4 2>")
2913 "<%%diary-float t 4 2>\n"))
2914 ;; Timestamp with repeater interval, with delay, with both.
2915 (should
2916 (string-match "<2012-03-29 .* \\+1y>"
2917 (org-test-parse-and-interpret "<2012-03-29 thu. +1y>")))
2918 (should
2919 (string-match
2920 "<2012-03-29 .* \\+1y>"
2921 (org-element-timestamp-interpreter
2922 '(timestamp
2923 (:type active :year-start 2012 :month-start 3 :day-start 29
2924 :repeater-type cumulate :repeater-value 1 :repeater-unit year))
2925 nil)))
2926 (should
2927 (string-match
2928 "<2012-03-29 .* -1y>"
2929 (org-element-timestamp-interpreter
2930 '(timestamp
2931 (:type active :year-start 2012 :month-start 3 :day-start 29
2932 :warning-type all :warning-value 1 :warning-unit year))
2933 nil)))
2934 (should
2935 (string-match
2936 "<2012-03-29 .* \\+1y -1y>"
2937 (org-element-timestamp-interpreter
2938 '(timestamp
2939 (:type active :year-start 2012 :month-start 3 :day-start 29
2940 :warning-type all :warning-value 1 :warning-unit year
2941 :repeater-type cumulate :repeater-value 1 :repeater-unit year))
2942 nil)))
2943 ;; Timestamp range with repeater interval
2944 (should
2945 (string-match "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2946 (org-test-parse-and-interpret
2947 "<2012-03-29 Thu +1y>--<2012-03-30 Thu +1y>")))
2948 (should
2949 (string-match
2950 "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2951 (org-element-timestamp-interpreter
2952 '(timestamp
2953 (:type active-range :year-start 2012 :month-start 3 :day-start 29
2954 :year-end 2012 :month-end 3 :day-end 30 :repeater-type cumulate
2955 :repeater-value 1 :repeater-unit year))
2956 nil))))
2958 (ert-deftest test-org-element/verse-block-interpreter ()
2959 "Test verse block interpretation."
2960 (should
2961 (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
2962 "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
2964 (ert-deftest test-org-element/bold-interpreter ()
2965 "Test bold interpreter."
2966 (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
2968 (ert-deftest test-org-element/code-interpreter ()
2969 "Test code interpreter."
2970 (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
2972 (ert-deftest test-org-element/entity-interpreter ()
2973 "Test entity interpreter."
2974 ;; 1. Without brackets.
2975 (should
2976 (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
2977 ;; 2. With brackets.
2978 (should
2979 (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
2981 (ert-deftest test-org-element/export-snippet-interpreter ()
2982 "Test export snippet interpreter."
2983 (should (equal (org-test-parse-and-interpret "@@back-end:contents@@")
2984 "@@back-end:contents@@\n")))
2986 (ert-deftest test-org-element/footnote-reference-interpreter ()
2987 "Test footnote reference interpreter."
2988 ;; Regular reference.
2989 (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
2990 ;; Named reference.
2991 (should (equal (org-test-parse-and-interpret "Text[fn:label]")
2992 "Text[fn:label]\n"))
2993 ;; Inline reference.
2994 (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
2995 "Text[fn:label:def]\n"))
2996 ;; Anonymous reference.
2997 (should (equal (org-test-parse-and-interpret "Text[fn::def]")
2998 "Text[fn::def]\n")))
3000 (ert-deftest test-org-element/inline-babel-call-interpreter ()
3001 "Test inline babel call interpreter."
3002 ;; Without arguments.
3003 (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
3004 ;; With arguments.
3005 (should (equal (org-test-parse-and-interpret "call_test(x=2)")
3006 "call_test(x=2)\n"))
3007 ;; With header arguments.
3008 (should (equal (org-test-parse-and-interpret
3009 "call_test[:results output]()[:results html]")
3010 "call_test[:results output]()[:results html]\n")))
3012 (ert-deftest test-org-element/inline-src-block-interpreter ()
3013 "Test inline src block interpreter."
3014 ;; 1. Without header argument.
3015 (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
3016 "src_emacs-lisp{(+ 1 1)}\n"))
3017 ;; 2. With header arguments.
3018 (should (equal (org-test-parse-and-interpret
3019 "src_emacs-lisp[:results silent]{(+ 1 1)}")
3020 "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
3022 (ert-deftest test-org-element/italic-interpreter ()
3023 "Test italic interpreter."
3024 (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
3026 (ert-deftest test-org-element/latex-fragment-interpreter ()
3027 "Test latex fragment interpreter."
3028 (should (equal (org-test-parse-and-interpret "\\command{}") "\\command{}\n"))
3029 (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
3030 (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
3031 (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
3032 (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
3033 (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n")))
3035 (ert-deftest test-org-element/line-break-interpreter ()
3036 "Test line break interpreter."
3037 (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
3038 "First line \\\\\nSecond line\n")))
3040 (ert-deftest test-org-element/link-interpreter ()
3041 "Test link interpreter."
3042 ;; Links targeted from a radio target.
3043 (should (equal (let ((org-target-link-regexp "radio-target"))
3044 (org-test-parse-and-interpret "a radio-target"))
3045 "a radio-target\n"))
3046 ;; Links without description.
3047 (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
3048 "[[http://orgmode.org]]\n"))
3049 ;; Links with a description, even one containing a link.
3050 (should (equal (org-test-parse-and-interpret
3051 "[[http://orgmode.org][Org mode]]")
3052 "[[http://orgmode.org][Org mode]]\n"))
3053 (should (equal (org-test-parse-and-interpret
3054 "[[http://orgmode.org][http://orgmode.org]]")
3055 "[[http://orgmode.org][http://orgmode.org]]\n"))
3056 ;; File links.
3057 (should
3058 (equal (org-test-parse-and-interpret "[[file+emacs:todo.org]]")
3059 "[[file+emacs:todo.org]]\n"))
3060 (should
3061 (equal (org-test-parse-and-interpret "[[file:todo.org::*task]]")
3062 "[[file:todo.org::*task]]\n"))
3063 ;; Id links.
3064 (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
3065 ;; Custom-id links.
3066 (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
3067 ;; Code-ref links.
3068 (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
3069 ;; Plain links.
3070 (should (equal (org-test-parse-and-interpret "http://orgmode.org")
3071 "http://orgmode.org\n"))
3072 ;; Angular links.
3073 (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
3074 "<http://orgmode.org>\n"))
3075 ;; Pathological case: link with a %-sign in description.
3076 (should (equal (org-test-parse-and-interpret "[[file://path][%s]]")
3077 "[[file://path][%s]]\n")))
3079 (ert-deftest test-org-element/macro-interpreter ()
3080 "Test macro interpreter."
3081 ;; 1. Without argument.
3082 (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
3083 ;; 2. With arguments.
3084 (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
3085 "{{{test(arg1,arg2)}}}\n")))
3087 (ert-deftest test-org-element/radio-target-interpreter ()
3088 "Test radio target interpreter."
3089 (should (equal (org-test-parse-and-interpret "<<<some text>>>")
3090 "<<<some text>>>\n")))
3092 (ert-deftest test-org-element/statistics-cookie-interpreter ()
3093 "Test statistics cookie interpreter."
3094 ;; 1. Without percent
3095 (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
3096 ;; 2. With percent.
3097 (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
3099 (ert-deftest test-org-element/strike-through-interpreter ()
3100 "Test strike through interpreter."
3101 (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
3103 (ert-deftest test-org-element/subscript-interpreter ()
3104 "Test subscript interpreter."
3105 ;; 1. Without brackets.
3106 (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
3107 ;; 2. With brackets.
3108 (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
3110 (ert-deftest test-org-element/superscript-interpreter ()
3111 "Test superscript interpreter."
3112 ;; 1. Without brackets.
3113 (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
3114 ;; 2. With brackets.
3115 (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
3117 (ert-deftest test-org-element/target-interpreter ()
3118 "Test target interpreter."
3119 (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
3121 (ert-deftest test-org-element/underline-interpreter ()
3122 "Test underline interpreter."
3123 (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
3125 (ert-deftest test-org-element/verbatim-interpreter ()
3126 "Test verbatim interpreter."
3127 (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
3131 ;;; Test Granularity
3133 (ert-deftest test-org-element/granularity ()
3134 "Test granularity impact on buffer parsing."
3135 (org-test-with-temp-text "
3136 * Head 1
3137 ** Head 2
3138 #+BEGIN_CENTER
3139 Centered paragraph.
3140 #+END_CENTER
3141 Paragraph \\alpha."
3142 ;; 1.1. Granularity set to `headline' should parse every headline
3143 ;; in buffer, and only them.
3144 (let ((tree (org-element-parse-buffer 'headline)))
3145 (should (= 2 (length (org-element-map tree 'headline 'identity))))
3146 (should-not (org-element-map tree 'paragraph 'identity)))
3147 ;; 1.2. Granularity set to `greater-element' should not enter
3148 ;; greater elements excepted headlines and sections.
3149 (let ((tree (org-element-parse-buffer 'greater-element)))
3150 (should (= 1 (length (org-element-map tree 'center-block 'identity))))
3151 (should (= 1 (length (org-element-map tree 'paragraph 'identity))))
3152 (should-not (org-element-map tree 'entity 'identity)))
3153 ;; 1.3. Granularity set to `element' should enter every
3154 ;; greater-element.
3155 (let ((tree (org-element-parse-buffer 'element)))
3156 (should (= 2 (length (org-element-map tree 'paragraph 'identity))))
3157 (should-not (org-element-map tree 'entity 'identity)))
3158 ;; 1.4. Granularity set to `object' can see everything.
3159 (let ((tree (org-element-parse-buffer 'object)))
3160 (should (= 1 (length (org-element-map tree 'entity 'identity)))))))
3162 (ert-deftest test-org-element/secondary-string-parsing ()
3163 "Test if granularity correctly toggles secondary strings parsing."
3164 ;; With a granularity bigger than `object', no secondary string
3165 ;; should be parsed.
3166 (should
3167 (stringp
3168 (org-test-with-temp-text "* Headline"
3169 (let ((headline
3170 (org-element-map (org-element-parse-buffer 'headline) 'headline
3171 #'identity nil 'first-match)))
3172 (org-element-property :title headline)))))
3173 (should
3174 (stringp
3175 (org-test-with-temp-text "* Headline\n- tag :: item"
3176 (let ((item (org-element-map (org-element-parse-buffer 'element) 'item
3177 #'identity nil 'first-match)))
3178 (org-element-property :tag item)))))
3179 (when (featurep 'org-inlinetask)
3180 (should
3181 (stringp
3182 (let ((org-inlinetask-min-level 15))
3183 (org-test-with-temp-text "*************** Inlinetask"
3184 (let ((inlinetask (org-element-map (org-element-parse-buffer 'element)
3185 'inlinetask
3186 #'identity nil 'first-match)))
3187 (org-element-property :title inlinetask)))))))
3188 ;; With a default granularity, secondary strings should be parsed.
3189 (should
3190 (listp
3191 (org-test-with-temp-text "* Headline"
3192 (let ((headline
3193 (org-element-map (org-element-parse-buffer) 'headline
3194 #'identity nil 'first-match)))
3195 (org-element-property :title headline)))))
3196 ;; `org-element-at-point' should never parse a secondary string.
3197 (should-not
3198 (listp
3199 (org-test-with-temp-text "* Headline"
3200 (org-element-property :title (org-element-at-point)))))
3201 ;; Preserve current local variables when parsing a secondary string.
3202 (should
3203 (let ((org-entities nil)
3204 (org-entities-user nil))
3205 (org-test-with-temp-text "
3206 #+CAPTION: \\foo
3207 Text
3208 # Local Variables:
3209 # org-entities-user: ((\"foo\"))
3210 # End:"
3211 (let ((safe-local-variable-values '((org-entities-user . (("foo"))))))
3212 (hack-local-variables))
3213 (org-element-map (org-element-parse-buffer) 'entity
3214 #'identity nil nil nil t)))))
3218 ;;; Test Visible Only Parsing
3220 (ert-deftest test-org-element/parse-buffer-visible ()
3221 "Test `org-element-parse-buffer' with visible only argument."
3222 (should
3223 (equal '("H1" "H3" "H5")
3224 (org-test-with-temp-text
3225 "* H1\n** H2\n** H3 :visible:\n** H4\n** H5 :visible:"
3226 (org-occur ":visible:")
3227 (org-element-map (org-element-parse-buffer nil t) 'headline
3228 (lambda (hl) (org-element-property :raw-value hl)))))))
3232 ;;; Test `:parent' Property
3234 (ert-deftest test-org-element/parent-property ()
3235 "Test `:parent' property."
3236 ;; Elements.
3237 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
3238 (let* ((tree (org-element-parse-buffer))
3239 (parent (org-element-property
3240 :parent
3241 (org-element-map tree 'paragraph 'identity nil t))))
3242 (should parent)
3243 (should (eq (org-element-map tree 'center-block 'identity nil t)
3244 parent))))
3245 ;; Objects.
3246 (org-test-with-temp-text "a_{/b/}"
3247 (let* ((tree (org-element-parse-buffer))
3248 (parent (org-element-property
3249 :parent
3250 (org-element-map tree 'italic 'identity nil t))))
3251 (should parent)
3252 (should (eq parent
3253 (org-element-map tree 'subscript 'identity nil t)))))
3254 ;; Secondary strings
3255 (org-test-with-temp-text "* /italic/"
3256 (let* ((tree (org-element-parse-buffer))
3257 (parent (org-element-property
3258 :parent (org-element-map tree 'italic 'identity nil t))))
3259 (should parent)
3260 (should (eq parent
3261 (org-element-map tree 'headline 'identity nil t))))))
3265 ;;; Test Normalize Contents
3267 (ert-deftest test-org-element/normalize-contents ()
3268 "Test `org-element-normalize-contents' specifications."
3269 ;; Remove maximum common indentation from element's contents.
3270 (should
3271 (equal
3272 (org-element-normalize-contents
3273 '(paragraph nil " Two spaces\n Three spaces"))
3274 '(paragraph nil "Two spaces\n Three spaces")))
3275 (should
3276 (equal
3277 (org-element-normalize-contents
3278 '(paragraph nil " Two spaces\nNo space"))
3279 '(paragraph nil " Two spaces\nNo space")))
3280 ;; Ignore objects within contents when computing maximum common
3281 ;; indentation. However, if contents start with an object, common
3282 ;; indentation is 0.
3283 (should
3284 (equal
3285 (org-element-normalize-contents
3286 '(paragraph nil " One " (emphasis nil "space") "\n Two spaces"))
3287 '(paragraph nil "One " (emphasis nil "space") "\n Two spaces")))
3288 (should
3289 (equal
3290 (org-element-normalize-contents
3291 '(paragraph nil (verbatim nil "V") "No space\n Two\n Three"))
3292 '(paragraph nil (verbatim nil "V") "No space\n Two\n Three")))
3293 ;; Ignore blank lines.
3294 (should
3295 (equal
3296 (org-element-normalize-contents
3297 '(paragraph nil " Two spaces\n\n \n Two spaces"))
3298 '(paragraph nil "Two spaces\n\n\nTwo spaces")))
3299 (should
3300 (equal
3301 '(paragraph nil " Two spaces\n" (verbatim nil "V") "\n Two spaces")
3302 (org-element-normalize-contents
3303 '(paragraph nil " Two spaces\n " (verbatim nil "V") "\n Two spaces"))))
3304 (should
3305 (equal
3306 '(verse-block nil "line 1\n\nline 2")
3307 (org-element-normalize-contents
3308 '(verse-block nil " line 1\n\n line 2"))))
3309 ;; Recursively enter objects in order to compute common indentation.
3310 (should
3311 (equal
3312 (org-element-normalize-contents
3313 '(paragraph nil " Two spaces " (bold nil " and\n One space")))
3314 '(paragraph nil " Two spaces " (bold nil " and\nOne space"))))
3315 ;; When optional argument is provided, ignore first line
3316 ;; indentation.
3317 (should
3318 (equal
3319 (org-element-normalize-contents
3320 '(paragraph nil "No space\n Two spaces\n Three spaces") t)
3321 '(paragraph nil "No space\nTwo spaces\n Three spaces")))
3322 (should
3323 (equal
3324 (org-element-normalize-contents
3325 '(paragraph nil (verbatim nil "V") "No space\n Two\n Three") t)
3326 '(paragraph nil (verbatim nil "V") "No space\nTwo\n Three")))
3327 ;; Corner case: do not ignore indentation of string right after
3328 ;; a line break.
3329 (should
3330 (equal
3331 (org-element-normalize-contents
3332 '(paragraph nil " 1 space" (line-break) " 2 spaces"))
3333 '(paragraph nil "1 space" (line-break) " 2 spaces"))))
3337 ;;; Test Navigation Tools.
3339 (ert-deftest test-org-element/at-point ()
3340 "Test `org-element-at-point' specifications."
3341 ;; Return closest element containing point.
3342 (should
3343 (eq 'paragraph
3344 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
3345 (progn (search-forward "A")
3346 (org-element-type (org-element-at-point))))))
3347 ;; Correctly set `:parent' property.
3348 (should
3349 (eq 'center-block
3350 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
3351 (progn (search-forward "A")
3352 (org-element-type
3353 (org-element-property :parent (org-element-at-point)))))))
3354 ;; Special case: at a blank line just below a headline, return that
3355 ;; headline.
3356 (should
3357 (equal "H1" (org-test-with-temp-text "* H1\n \n* H2\n"
3358 (forward-line)
3359 (org-element-property :title (org-element-at-point)))))
3360 ;; Special case: at the very beginning of a table, return `table'
3361 ;; object instead of `table-row'.
3362 (should
3363 (eq 'table
3364 (org-test-with-temp-text "| a | b |"
3365 (org-element-type (org-element-at-point)))))
3366 ;; Special case: at the very beginning of a list or sub-list, return
3367 ;; `plain-list' object instead of `item'.
3368 (should
3369 (eq 'plain-list
3370 (org-test-with-temp-text "- item"
3371 (org-element-type (org-element-at-point)))))
3372 ;; Special case: at the closing line of a greater element, be sure
3373 ;; to return it instead of the last element in its contents.
3374 (should
3375 (eq 'center-block
3376 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph\n#+END_CENTER"
3377 (progn (forward-line 2)
3378 (org-element-type (org-element-at-point))))))
3379 ;; Special case: at a blank line between two items, be sure to
3380 ;; return item above instead of the last element of its contents.
3381 (should
3382 (eq 'item
3383 (org-test-with-temp-text "- Para1\n\n- Para2"
3384 (forward-line)
3385 (org-element-type (org-element-at-point)))))
3386 ;; Special case: at the last blank line in a plain list, return it
3387 ;; instead of the last item.
3388 (should
3389 (eq 'plain-list
3390 (org-test-with-temp-text "- Para1\n- Para2\n\nPara3"
3391 (progn (forward-line 2)
3392 (org-element-type (org-element-at-point))))))
3393 ;; Special case: when a list ends at the end of buffer and there's
3394 ;; no final newline, return last element in last item.
3395 (should
3396 (eq 'paragraph
3397 (org-test-with-temp-text "- a"
3398 (end-of-line)
3399 (org-element-type (org-element-at-point)))))
3400 ;; Parse a list within a block itself contained in a list.
3401 (should
3402 (eq 'plain-list
3403 (org-test-with-temp-text
3404 "- outer\n #+begin_center\n - inner\n #+end_center"
3405 (search-forward "inner")
3406 (beginning-of-line)
3407 (org-element-type (org-element-at-point)))))
3408 ;; Do not error at eob on an empty line.
3409 (should
3410 (org-test-with-temp-text "* H\n"
3411 (forward-line)
3412 (or (org-element-at-point) t))))
3414 (ert-deftest test-org-element/context ()
3415 "Test `org-element-context' specifications."
3416 ;; Return closest object containing point.
3417 (should
3418 (eq 'underline
3419 (org-test-with-temp-text "Some *text with _under<point>line_ text*"
3420 (org-element-type (org-element-context)))))
3421 ;; Find objects in secondary strings.
3422 (should
3423 (eq 'underline
3424 (org-test-with-temp-text "* Headline _<point>with_ underlining"
3425 (org-element-type (org-element-context)))))
3426 ;; Find objects in objects.
3427 (should
3428 (eq 'macro
3429 (org-test-with-temp-text "| a | {<point>{{macro}}} |"
3430 (org-element-type (org-element-context)))))
3431 (should
3432 (eq 'table-cell
3433 (org-test-with-temp-text "| a | b<point> {{{macro}}} |"
3434 (org-element-type (org-element-context)))))
3435 ;; Find objects in planning lines.
3436 (should
3437 (eq 'timestamp
3438 (org-test-with-temp-text "* H\n SCHEDULED: <2012<point>-03-29 thu.>"
3439 (org-element-type (org-element-context)))))
3440 (should-not
3441 (eq 'timestamp
3442 (org-test-with-temp-text "* H\n SCHEDULED<point>: <2012-03-29 thu.>"
3443 (org-element-type (org-element-context)))))
3444 ;; Find objects in item tags.
3445 (should
3446 (eq 'bold
3447 (org-test-with-temp-text "- *bo<point>ld* ::"
3448 (org-element-type (org-element-context)))))
3449 (should-not
3450 (eq 'bold
3451 (org-test-with-temp-text "- *bold* ::<point>"
3452 (org-element-type (org-element-context)))))
3453 (should-not
3454 (eq 'bold
3455 (org-test-with-temp-text "- *bold* ::\n<point>"
3456 (org-element-type (org-element-context)))))
3457 ;; Do not find objects in table rules.
3458 (should
3459 (eq 'table-row
3460 (org-test-with-temp-text "| a | b |\n|-<point>--|---|\n| c | d |"
3461 (org-element-type (org-element-context)))))
3462 ;; Find objects in parsed affiliated keywords.
3463 (should
3464 (eq 'macro
3465 (org-test-with-temp-text "#+CAPTION: {<point>{{macro}}}\n| a | b |"
3466 (org-element-type (org-element-context)))))
3467 (should
3468 (eq 'bold
3469 (org-test-with-temp-text "#+caption: *<point>bold*\nParagraph"
3470 (org-element-type (org-element-context)))))
3471 ;; Find objects at the end of buffer.
3472 (should
3473 (eq 'bold
3474 (org-test-with-temp-text "*bold*"
3475 (goto-char (point-max))
3476 (org-element-type (org-element-context)))))
3477 ;; Correctly set `:parent' property.
3478 (should
3479 (eq 'paragraph
3480 (org-test-with-temp-text "Some *bold<point>* text"
3481 (org-element-type
3482 (org-element-property :parent (org-element-context))))))
3483 ;; Between two objects, return the second one.
3484 (should
3485 (eq 'macro
3486 (org-test-with-temp-text "<<target>><point>{{{test}}}"
3487 (org-element-type (org-element-context)))))
3488 ;; Test optional argument.
3489 (should
3490 (eq 'underline
3491 (org-test-with-temp-text "Some *text with _under<point>line_ text*"
3492 (org-element-type (org-element-context (org-element-at-point))))))
3493 ;; Special case: bold object at the beginning of a headline.
3494 (should
3495 (eq 'bold
3496 (org-test-with-temp-text "* *bo<point>ld*"
3497 (org-element-type (org-element-context)))))
3498 ;; Special case: incomplete cell at the end of a table row.
3499 (should
3500 (eq 'table-cell
3501 (org-test-with-temp-text "|a|b|c<point>"
3502 (org-element-type (org-element-context)))))
3503 ;; Special case: objects in inline footnotes.
3504 (should
3505 (eq 'link
3506 (org-test-with-temp-text "[fn::[[<point>http://orgmode.org]]]"
3507 (org-element-type (org-element-context)))))
3508 ;; Special case: tags looking like a link.
3509 (should-not
3510 (eq 'link
3511 (org-test-with-temp-text "* Headline :file<point>:tags:"
3512 (org-element-type (org-element-context)))))
3513 (should
3514 (eq 'link
3515 (org-test-with-temp-text "* Headline :file<point>:tags: :real:tag:"
3516 (org-element-type (org-element-context))))))
3520 ;;; Test Tools
3522 (ert-deftest test-org-element/lineage ()
3523 "Test `org-element-lineage' specifications."
3524 ;; Regular tests. When applied to an element or object returned by
3525 ;; `org-element-at-point' or `org-element-context', the list is
3526 ;; limited to the current section.
3527 (should
3528 (equal '(paragraph center-block)
3529 (org-test-with-temp-text
3530 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3531 (mapcar #'car (org-element-lineage (org-element-context))))))
3532 (should
3533 (equal '(paragraph center-block section headline headline org-data)
3534 (org-test-with-temp-text
3535 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3536 (mapcar #'car
3537 (org-element-lineage
3538 (org-element-map (org-element-parse-buffer) 'bold
3539 #'identity nil t))))))
3540 ;; Test TYPES optional argument.
3541 (should
3542 (eq 'center-block
3543 (org-test-with-temp-text
3544 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3545 (org-element-type
3546 (org-element-lineage (org-element-context) '(center-block))))))
3547 (should-not
3548 (org-test-with-temp-text
3549 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3550 (org-element-lineage (org-element-context) '(example-block))))
3551 ;; Test WITH-SELF optional argument.
3552 (should
3553 (equal '(bold paragraph center-block)
3554 (org-test-with-temp-text
3555 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3556 (mapcar #'car (org-element-lineage (org-element-context) nil t)))))
3557 ;; When TYPES and WITH-SELF are provided, the latter is also checked
3558 ;; against the former.
3559 (should
3560 (org-test-with-temp-text
3561 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3562 (org-element-lineage (org-element-context) '(bold) t))))
3566 ;;; Test Cache.
3568 (ert-deftest test-org-element/cache ()
3569 "Test basic expectations and common pitfalls for cache."
3570 ;; Shift positions.
3571 (should
3572 (equal '(18 . 23)
3573 (org-test-with-temp-text "para1\n\npara2\n\npara3"
3574 (let ((org-element-use-cache t))
3575 (save-excursion (goto-char (point-max)) (org-element-at-point))
3576 (insert "add")
3577 (forward-line 4)
3578 (let ((element (org-element-at-point)))
3579 (cons (org-element-property :begin element)
3580 (org-element-property :end element)))))))
3581 ;; Partial shifting: when the contents of a greater element are
3582 ;; modified, only shift ending positions.
3583 (should
3584 (org-test-with-temp-text
3585 "#+BEGIN_CENTER\nPara1\n\nPara2\n\nPara3\n#+END_CENTER"
3586 (let ((org-element-use-cache t))
3587 (save-excursion (search-forward "3") (org-element-at-point))
3588 (search-forward "Para2")
3589 (insert " ")
3590 (let ((element (org-element-property :parent (org-element-at-point))))
3591 (equal (cons (org-element-property :begin element)
3592 (org-element-property :end element))
3593 (cons (point-min) (point-max)))))))
3594 ;; Re-parent shifted elements.
3595 (should
3596 (eq 'item
3597 (org-test-with-temp-text "- item\n\n\n para1\n para2"
3598 (let ((org-element-use-cache t))
3599 (end-of-line)
3600 (org-element-at-point)
3601 (save-excursion (goto-char (point-max)) (org-element-at-point))
3602 (forward-line)
3603 (delete-char 1)
3604 (goto-char (point-max))
3605 (org-element-type
3606 (org-element-property :parent (org-element-at-point)))))))
3607 ;; Preserve local structures when re-parenting.
3608 (should
3609 (eq 'table
3610 (org-test-with-temp-text
3611 "#+begin_center\nP0\n\n<point>\n\n P1\n | a | b |\n| c | d |\n#+end_center"
3612 (let ((org-element-use-cache t))
3613 (save-excursion (search-forward "| c |") (org-element-at-point))
3614 (insert "- item")
3615 (search-forward "| c |")
3616 (beginning-of-line)
3617 (org-element-type
3618 (org-element-property :parent (org-element-at-point)))))))
3619 (should-not
3620 (eq 'center-block
3621 (org-test-with-temp-text
3622 "#+begin_center\nP0\n\n<point>\n\n P1\n | a | b |\n#+end_center"
3623 (let ((org-element-use-cache t))
3624 (save-excursion (search-forward "| a |") (org-element-at-point))
3625 (insert "- item")
3626 (search-forward "| a |")
3627 (beginning-of-line)
3628 (org-element-type
3629 (org-element-property :parent (org-element-at-point)))))))
3630 ;; When re-parenting, also propagate changes to list structures.
3631 (should
3632 (= 2
3633 (org-test-with-temp-text "\n Para\n - item<point>"
3634 (let ((org-element-use-cache t))
3635 (org-element-at-point)
3636 (goto-char (point-min))
3637 (insert "- Top\n")
3638 (search-forward "- item")
3639 (beginning-of-line)
3640 (length (org-element-property :structure (org-element-at-point)))))))
3641 ;; Modifying the last line of an element alters the element below.
3642 (should
3643 (org-test-with-temp-text "para1\n\npara2"
3644 (let ((org-element-use-cache t))
3645 (goto-char (point-max))
3646 (org-element-at-point)
3647 (forward-line -1)
3648 (insert "merge")
3649 (let ((element (org-element-at-point)))
3650 (equal (cons (org-element-property :begin element)
3651 (org-element-property :end element))
3652 (cons (point-min) (point-max)))))))
3653 ;; Modifying the first line of an element alters the element above.
3654 (should
3655 (org-test-with-temp-text ": fixed-width\n:not-fixed-width"
3656 (let ((org-element-use-cache t))
3657 (goto-char (point-max))
3658 (org-element-at-point)
3659 (search-backward ":")
3660 (forward-char)
3661 (insert " ")
3662 (let ((element (org-element-at-point)))
3663 (equal (cons (org-element-property :begin element)
3664 (org-element-property :end element))
3665 (cons (point-min) (point-max)))))))
3666 ;; Sensitive change: adding a line alters document structure both
3667 ;; above and below.
3668 (should
3669 (eq 'example-block
3670 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n"
3671 (let ((org-element-use-cache t))
3672 (goto-char (point-max))
3673 (org-element-at-point)
3674 (insert "#+END_EXAMPLE")
3675 (search-backward "Para1")
3676 (org-element-type (org-element-at-point))))))
3677 (should
3678 (eq 'example-block
3679 (org-test-with-temp-text "Para1\n\nPara2\n#+END_EXAMPLE"
3680 (let ((org-element-use-cache t))
3681 (save-excursion (goto-char (point-max)) (org-element-at-point))
3682 (insert "#+BEGIN_EXAMPLE\n")
3683 (search-forward "Para2")
3684 (org-element-type (org-element-at-point))))))
3685 ;; Sensitive change: removing a line alters document structure both
3686 ;; above and below.
3687 (should
3688 (eq 'example-block
3689 (org-test-with-temp-text
3690 "# +BEGIN_EXAMPLE\nPara1\n\nPara2\n#+END_EXAMPLE"
3691 (let ((org-element-use-cache t))
3692 (save-excursion (goto-char (point-max)) (org-element-at-point))
3693 (forward-char)
3694 (delete-char 1)
3695 (search-forward "Para2")
3696 (org-element-type (org-element-at-point))))))
3697 (should
3698 (eq 'example-block
3699 (org-test-with-temp-text
3700 "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n# +END_EXAMPLE"
3701 (let ((org-element-use-cache t))
3702 (save-excursion (goto-char (point-max)) (org-element-at-point))
3703 (search-forward "# ")
3704 (delete-char -1)
3705 (search-backward "Para1")
3706 (org-element-type (org-element-at-point))))))
3707 ;; Corner case: watch out drawers named "PROPERTIES" as they are
3708 ;; fragile, unlike to other drawers.
3709 (should
3710 (eq 'node-property
3711 (org-test-with-temp-text "* H\n:PROPERTIES:\n:A: 1\n:A<point>\n:END:"
3712 (let ((org-element-use-cache t))
3713 (org-element-at-point)
3714 (insert "+:")
3715 (org-element-type (org-element-at-point))))))
3716 ;; Properly handle elements not altered by modifications but whose
3717 ;; parents were removed from cache.
3718 (should
3719 (org-test-with-temp-text
3720 "Paragraph\n\n\n\n#+begin_center\n<point>contents\n#+end_center"
3721 (let ((org-element-use-cache t)
3722 (parent-end (point-max)))
3723 (org-element-at-point)
3724 (save-excursion (search-backward "Paragraph")
3725 (forward-line 2)
3726 (insert "\n "))
3727 (eq (org-element-property
3728 :end (org-element-property :parent (org-element-at-point)))
3729 (+ parent-end 3))))))
3732 (provide 'test-org-element)
3734 ;;; test-org-element.el ends here