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