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