org-element: Keep ARCHIVE tag in headline tags
[org-mode/org-tableheadings.git] / testing / lisp / test-org-element.el
blob278038eb8af062c37129e840f317aaea942e4c7f
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 (org-test-with-temp-text "$a$"
1445 (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
1446 (should
1447 (org-test-with-temp-text "$$a$$"
1448 (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
1449 (should
1450 (org-test-with-temp-text "\\(a\\)"
1451 (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
1452 (should
1453 (org-test-with-temp-text "\\[a\\]"
1454 (org-element-map
1455 (org-element-parse-buffer) 'latex-fragment 'identity)))
1456 ;; Test fragment at the beginning of an item.
1457 (should
1458 (eq 'latex-fragment
1459 (org-test-with-temp-text "- $x$"
1460 (progn (search-forward "$")
1461 (org-element-type (org-element-context)))))))
1464 ;;;; Line Break
1466 (ert-deftest test-org-element/line-break-parser ()
1467 "Test `line-break' parser."
1468 ;; Regular test.
1469 (should
1470 (org-test-with-temp-text "Text \\\\"
1471 (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
1472 ;; Line break with trailing white spaces.
1473 (should
1474 (org-test-with-temp-text "Text \\\\ "
1475 (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
1476 ;; Three backslashes are too much.
1477 (should-not
1478 (org-test-with-temp-text "Text \\\\\\"
1479 (org-element-map (org-element-parse-buffer) 'line-break 'identity))))
1482 ;;;; Link
1484 (ert-deftest test-org-element/link-parser ()
1485 "Test `link' parser."
1486 ;; Radio target.
1487 (should
1488 (equal
1489 "radio"
1490 (org-test-with-temp-text "<<<radio>>>A radio link"
1491 (org-update-radio-target-regexp)
1492 (org-element-property
1493 :type
1494 (org-element-map (org-element-parse-buffer) 'link #'identity nil t)))))
1495 ;; Standard link.
1497 ;; ... with description.
1498 (should
1499 (equal
1500 '("Orgmode.org")
1501 (org-test-with-temp-text "[[http://orgmode.org][Orgmode.org]]"
1502 (org-element-contents
1503 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1504 ;; ... without description.
1505 (should
1506 (equal
1507 "http"
1508 (org-test-with-temp-text "[[http://orgmode.org]]"
1509 (org-element-property
1510 :type
1511 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1512 ;; ... with expansion.
1513 (should
1514 (equal
1515 "//orgmode.org/worg"
1516 (org-test-with-temp-text "[[Org:worg]]"
1517 (let ((org-link-abbrev-alist '(("Org" . "http://orgmode.org/"))))
1518 (org-element-property
1519 :path
1520 (org-element-map (org-element-parse-buffer) 'link 'identity nil t))))))
1521 ;; ... with translation.
1522 (should
1523 (equal
1524 "127.0.0.1"
1525 (org-test-with-temp-text "[[http://orgmode.org]]"
1526 (flet ((link-translate (type path) (cons type "127.0.0.1")))
1527 (let ((org-link-translation-function 'link-translate))
1528 (org-element-property
1529 :path
1530 (org-element-map (org-element-parse-buffer) 'link
1531 'identity nil t)))))))
1532 ;; ... id link.
1533 (should
1534 (equal
1535 "id"
1536 (org-test-with-temp-text "[[id:aaaa]]"
1537 (org-element-property
1538 :type
1539 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1540 ;; ... custom-id link.
1541 (should
1542 (equal
1543 "custom-id"
1544 (org-test-with-temp-text "[[#some-id]]"
1545 (org-element-property
1546 :type
1547 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1548 ;; ... coderef link.
1549 (should
1550 (equal
1551 "coderef"
1552 (org-test-with-temp-text "[[(reference)]]"
1553 (org-element-property
1554 :type
1555 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1556 ;; ... fuzzy link.
1557 (should
1558 (equal
1559 "fuzzy"
1560 (org-test-with-temp-text "[[target-or-title]]"
1561 (org-element-property
1562 :type
1563 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
1564 ;; ... file-type link with search option.
1565 (should
1566 (equal
1567 '(("file" "projects.org" "*task title"))
1568 (org-test-with-temp-text "[[file:projects.org::*task title]]"
1569 (org-element-map (org-element-parse-buffer) 'link
1570 (lambda (l) (list (org-element-property :type l)
1571 (org-element-property :path l)
1572 (org-element-property :search-option l)))))))
1573 ;; ... file-type link with application...
1574 (should
1575 (equal
1576 '("file" "projects.org" "emacs")
1577 (org-test-with-temp-text "[[file+emacs:projects.org]]"
1578 (let ((l (org-element-context)))
1579 (list (org-element-property :type l)
1580 (org-element-property :path l)
1581 (org-element-property :application l))))))
1582 ;; ... `:path' in a file-type link must be compatible with "file"
1583 ;; scheme in URI syntax, even if Org syntax isn't...
1584 (should
1585 (org-test-with-temp-text-in-file ""
1586 (let ((file (expand-file-name (buffer-file-name))))
1587 (insert (format "[[file://%s]]" file))
1588 (equal (org-element-property :path (org-element-context)) file))))
1589 (should
1590 (org-test-with-temp-text-in-file ""
1591 (let ((file (expand-file-name (buffer-file-name))))
1592 (insert (format "[[file:%s]]" file))
1593 (equal (org-element-property :path (org-element-context)) file))))
1594 (should
1595 (org-test-with-temp-text-in-file ""
1596 (let ((file (expand-file-name (buffer-file-name))))
1597 (insert (format "[[file:%s]]" file))
1598 (equal (org-element-property :path (org-element-context)) file))))
1599 ;; ... multi-line link.
1600 (should
1601 (equal "//orgmode.org"
1602 (org-test-with-temp-text "[[http://orgmode.\norg]]"
1603 (org-element-property :path (org-element-context)))))
1604 ;; Plain link.
1605 (should
1606 (org-test-with-temp-text "A link: http://orgmode.org"
1607 (org-element-map (org-element-parse-buffer) 'link 'identity)))
1608 ;; Angular link.
1609 (should
1610 (org-test-with-temp-text "A link: <http://orgmode.org>"
1611 (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))
1612 ;; Link abbreviation.
1613 (should
1614 (equal "http"
1615 (org-test-with-temp-text
1616 "#+LINK: orgmode http://www.orgmode.org/\n[[orgmode:#docs]]"
1617 (progn (org-mode-restart)
1618 (goto-char (1- (point-max)))
1619 (org-element-property :type (org-element-context))))))
1620 ;; Link abbreviation in a secondary string.
1621 (should
1622 (equal "http"
1623 (org-test-with-temp-text
1624 "#+LINK: orgmode http://www.orgmode.org/\n* H [[orgmode:#docs]]"
1625 (progn (org-mode-restart)
1626 (org-element-map (org-element-parse-buffer) 'link
1627 (lambda (link) (org-element-property :type link))
1628 nil t nil t)))))
1629 ;; Plain links are allowed as description of regular links.
1630 (should
1631 (equal "file"
1632 (org-test-with-temp-text "[[http://orgmode.org][file:unicorn.jpg]]"
1633 (search-forward "file:")
1634 (org-element-property :type (org-element-context))))))
1637 ;;;; Macro
1639 (ert-deftest test-org-element/macro-parser ()
1640 "Test `macro' parser."
1641 ;; Without arguments.
1642 (should
1643 (org-test-with-temp-text "{{{macro}}}"
1644 (org-element-map (org-element-parse-buffer) 'macro 'identity)))
1645 ;; With arguments.
1646 (should
1647 (org-test-with-temp-text "{{{macro(arg1,arg2)}}}"
1648 (org-element-map (org-element-parse-buffer) 'macro 'identity)))
1649 ;; Properly handle protected commas in arguments...
1650 (should
1651 (= 2
1652 (length
1653 (org-test-with-temp-text "{{{macro(arg1\\,arg1,arg2)}}}"
1654 (org-element-property :args (org-element-context))))))
1655 ;; ... even when last argument ends with a protected comma.
1656 (should
1657 (equal '("C-,")
1658 (org-test-with-temp-text "{{{macro(C-\\,)}}}"
1659 (org-element-property :args (org-element-context)))))
1660 ;; Allow to escape escaping character.
1661 (should
1662 (equal '("C-\\" "")
1663 (org-test-with-temp-text "{{{macro(C-\\\\,)}}}"
1664 (org-element-property :args (org-element-context)))))
1665 ;; No need to escape backslashes elsewhere.
1666 (should
1667 (equal '("\\")
1668 (org-test-with-temp-text "{{{macro(\\)}}}"
1669 (org-element-property :args (org-element-context))))))
1672 ;;;; Node Property
1674 (ert-deftest test-org-element/node-property ()
1675 "Test `node-property' parser."
1676 ;; Standard test.
1677 (should
1678 (equal '("abc" "value")
1679 (org-test-with-temp-text "* H\n:PROPERTIES:\n<point>:abc: value\n:END:"
1680 (let ((element (org-element-at-point)))
1681 (list (org-element-property :key element)
1682 (org-element-property :value element))))))
1683 ;; Value should be trimmed.
1684 (should
1685 (equal "value"
1686 (org-test-with-temp-text
1687 "* H\n:PROPERTIES:\n<point>:abc: value \n:END:"
1688 (org-element-property :value (org-element-at-point)))))
1689 ;; A node property requires to be wrapped within a property drawer.
1690 (should-not
1691 (eq 'node-property
1692 (org-test-with-temp-text ":abc: value"
1693 (org-element-type (org-element-at-point)))))
1694 ;; Accept empty properties.
1695 (should
1696 (equal '(("foo" "value") ("bar" ""))
1697 (org-test-with-temp-text "* H\n:PROPERTIES:\n:foo: value\n:bar:\n:END:"
1698 (org-element-map (org-element-parse-buffer) 'node-property
1699 (lambda (p)
1700 (list (org-element-property :key p)
1701 (org-element-property :value p))))))))
1704 ;;;; Paragraph
1706 (ert-deftest test-org-element/paragraph-parser ()
1707 "Test `paragraph' parser."
1708 ;; Standard test.
1709 (should
1710 (org-test-with-temp-text "Paragraph"
1711 (org-element-map (org-element-parse-buffer) 'paragraph 'identity nil t)))
1712 ;; Property find end of a paragraph stuck to another element.
1713 (should
1714 (eq ?#
1715 (org-test-with-temp-text "Paragraph\n# Comment"
1716 (org-element-map (org-element-parse-buffer) 'paragraph
1717 (lambda (p) (char-after (org-element-property :end p)))
1718 nil t))))
1719 ;; Include ill-formed Keywords.
1720 (should
1721 (org-test-with-temp-text "#+wrong_keyword something"
1722 (org-element-map (org-element-parse-buffer) 'paragraph 'identity)))
1723 ;; Include incomplete-drawers.
1724 (should
1725 (org-test-with-temp-text ":TEST:\nParagraph"
1726 (let ((elem (org-element-at-point)))
1727 (and (eq (org-element-type elem) 'paragraph)
1728 (= (point-max) (org-element-property :end elem))))))
1729 ;; Include incomplete blocks.
1730 (should
1731 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph"
1732 (let ((elem (org-element-at-point)))
1733 (and (eq (org-element-type elem) 'paragraph)
1734 (= (point-max) (org-element-property :end elem))))))
1735 ;; Include incomplete dynamic blocks.
1736 (should
1737 (org-test-with-temp-text "#+BEGIN: \nParagraph"
1738 (let ((elem (org-element-at-point)))
1739 (and (eq (org-element-type elem) 'paragraph)
1740 (= (point-max) (org-element-property :end elem))))))
1741 ;; Include incomplete latex environments.
1742 (should
1743 (org-test-with-temp-text "\begin{equation}\nParagraph"
1744 (let ((elem (org-element-at-point)))
1745 (and (eq (org-element-type elem) 'paragraph)
1746 (= (point-max) (org-element-property :end elem))))))
1747 ;; Do not steal affiliated keywords from container.
1748 (should
1749 (org-test-with-temp-text "#+ATTR_LATEX: test\n- item 1"
1750 (let ((elem (progn (search-forward "item") (org-element-at-point))))
1751 (and (eq (org-element-type elem) 'paragraph)
1752 (not (org-element-property :attr_latex elem))
1753 (/= (org-element-property :begin elem) 1)))))
1754 ;; Handle non-empty blank line at the end of buffer.
1755 (should
1756 (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
1757 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1760 ;;;; Plain List
1762 (ert-deftest test-org-element/plain-list-parser ()
1763 "Test `plain-list' parser."
1764 (org-test-with-temp-text "- item"
1765 (should (org-element-map (org-element-parse-buffer) 'plain-list 'identity)))
1766 ;; Blank lines after the list only belong to outer plain list.
1767 (should
1768 (equal
1769 '(t t)
1770 (org-test-with-temp-text "
1771 - outer
1772 - inner
1774 Outside list"
1775 (let ((endings (org-element-map (org-element-parse-buffer) 'plain-list
1776 (lambda (pl) (org-element-property :end pl)))))
1777 (list
1778 ;; Move to ending of outer list.
1779 (progn (goto-char (car endings)) (looking-at "Outside list"))
1780 ;; Move to ending of inner list.
1781 (progn (goto-char (nth 1 endings)) (looking-at "^$")))))))
1782 ;; Correctly compute end of list if it doesn't end at a line
1783 ;; beginning.
1784 (should
1785 (org-test-with-temp-text "- list\n \n "
1786 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1789 ;;;; Planning
1791 (ert-deftest test-org-element/planning-parser ()
1792 "Test `planning' parser."
1793 ;; Test various keywords.
1794 (should
1795 (org-element-property
1796 :closed
1797 (org-test-with-temp-text "* H\n<point>CLOSED: [2012-03-29 thu.]"
1798 (org-element-at-point))))
1799 (should
1800 (org-element-property
1801 :deadline
1802 (org-test-with-temp-text "* H\n<point>DEADLINE: <2012-03-29 thu.>"
1803 (org-element-at-point))))
1804 (should
1805 (org-element-property
1806 :scheduled
1807 (org-test-with-temp-text "* H\n<point>SCHEDULED: <2012-03-29 thu.>"
1808 (org-element-at-point))))
1809 ;; Planning line only exists right after a headline.
1810 (should-not
1811 (eq 'planning
1812 (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>"
1813 (org-element-type (org-element-at-point)))))
1814 (should-not
1815 (eq 'planning
1816 (org-test-with-temp-text
1817 "* H\n# Comment\n<point>DEADLINE: <2012-03-29 thu.>"
1818 (org-element-type (org-element-at-point))))))
1821 ;;;; Property Drawer
1823 (ert-deftest test-org-element/property-drawer-parser ()
1824 "Test `property-drawer' parser."
1825 ;; Standard test.
1826 (should
1827 (eq 'property-drawer
1828 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop: value\n:END:"
1829 (org-element-type (org-element-at-point)))))
1830 (should
1831 (eq 'property-drawer
1832 (org-test-with-temp-text
1833 "* H\nDEADLINE: <2014-03-04 tue.>\n<point>:PROPERTIES:\n:prop: value\n:END:"
1834 (org-element-type (org-element-at-point)))))
1835 ;; Allow properties without value and no property at all.
1836 (should
1837 (eq 'property-drawer
1838 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop:\n:END:"
1839 (org-element-type (org-element-at-point)))))
1840 (should
1841 (eq 'property-drawer
1842 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:END:"
1843 (org-element-type (org-element-at-point)))))
1844 ;; Ignore incomplete drawer, drawer at a wrong location or with
1845 ;; wrong contents.
1846 (should-not
1847 (eq 'property-drawer
1848 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop: value"
1849 (org-element-type (org-element-at-point)))))
1850 (should-not
1851 (eq 'property-drawer
1852 (org-test-with-temp-text
1853 "* H\nParagraph\n<point>:PROPERTIES:\n:prop: value\n:END:"
1854 (org-element-type (org-element-at-point)))))
1855 (should-not
1856 (eq 'property-drawer
1857 (org-test-with-temp-text
1858 "* H\nParagraph\n<point>:PROPERTIES:\nparagraph\n:END:"
1859 (org-element-type (org-element-at-point)))))
1860 ;; Handle non-empty blank line at the end of buffer.
1861 (should
1862 (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:END:\n "
1863 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1866 ;;;; Quote Block
1868 (ert-deftest test-org-element/quote-block-parser ()
1869 "Test `quote-block' parser."
1870 ;; Regular test.
1871 (should
1872 (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
1873 (org-element-map (org-element-parse-buffer) 'quote-block 'identity)))
1874 ;; Ignore incomplete block.
1875 (should-not
1876 (org-test-with-temp-text "#+BEGIN_QUOTE"
1877 (org-element-map (org-element-parse-buffer) 'quote-block 'identity nil t)))
1878 ;; Handle non-empty blank line at the end of buffer.
1879 (should
1880 (org-test-with-temp-text "#+BEGIN_QUOTE\nC\n#+END_QUOTE\n "
1881 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1884 ;;;; Radio Target
1886 (ert-deftest test-org-element/radio-target-parser ()
1887 "Test `radio-target' parser."
1888 ;; Standard test.
1889 (should
1890 (eq 'radio-target
1891 (org-test-with-temp-text "<<<radio>>>"
1892 (org-element-type (org-element-context)))))
1893 ;; Radio targets with objects.
1894 (should
1895 (eq 'radio-target
1896 (org-test-with-temp-text "<<<radio \\alpha>>>"
1897 (org-element-type (org-element-context)))))
1898 ;; Radio targets starting with an object.
1899 (should
1900 (eq 'radio-target
1901 (org-test-with-temp-text "<<<\\alpha radio>>>"
1902 (org-element-type (org-element-context)))))
1903 ;; Radio targets cannot begin or end with white space.
1904 (should-not
1905 (eq 'radio-target
1906 (org-test-with-temp-text "<<< radio>>>"
1907 (org-element-type (org-element-context)))))
1908 (should-not
1909 (eq 'radio-target
1910 (org-test-with-temp-text "<<<radio >>>"
1911 (org-element-type (org-element-context))))))
1914 ;;;; Section
1916 (ert-deftest test-org-element/section-parser ()
1917 "Test `section' parser."
1918 ;; Standard test.
1919 (should
1920 (org-test-with-temp-text "* Headline\nText"
1921 (org-element-map (org-element-parse-buffer) 'section 'identity)))
1922 ;; There's a section before the first headline.
1923 (should
1924 (org-test-with-temp-text "Text"
1925 (org-element-map (org-element-parse-buffer) 'section 'identity)))
1926 ;; A section cannot be empty.
1927 (should-not
1928 (org-test-with-temp-text "* Headline 1\n* Headline 2"
1929 (org-element-map (org-element-parse-buffer) 'section 'identity)))
1930 ;; A section doesn't contain sub-trees.
1931 (should-not
1932 (org-test-with-temp-text "* Head\nText\n** Sub-Head"
1933 (org-element-map
1934 (org-element-map (org-element-parse-buffer) 'section 'identity nil t)
1935 'headline 'identity))))
1938 ;;;; Special Block
1940 (ert-deftest test-org-element/special-block-parser ()
1941 "Test `special-block' parser."
1942 ;; Standard test.
1943 (should
1944 (equal "SPECIAL"
1945 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1946 (org-element-property :type (org-element-at-point)))))
1947 ;; Special blocks are case sensitive.
1948 (should
1949 (equal "CaSe"
1950 (org-test-with-temp-text "#+BEGIN_CaSe\nText\n#+END_CaSe"
1951 (org-element-property :type (org-element-at-point)))))
1952 ;; Special blocks can contain paragraphs.
1953 (should
1954 (eq 'paragraph
1955 (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
1956 (forward-line)
1957 (org-element-type (org-element-at-point)))))
1958 ;; Ignore incomplete block.
1959 (should-not
1960 (eq 'special-block
1961 (org-test-with-temp-text "#+BEGIN_SPECIAL"
1962 (org-element-type (org-element-at-point)))))
1963 ;; Allow special characters in type.
1964 (should
1965 (equal '(special-block "SPECIAL*")
1966 (org-test-with-temp-text "#+BEGIN_SPECIAL*\nContents\n#+END_SPECIAL*"
1967 (let ((element (org-element-at-point)))
1968 (list (org-element-type element)
1969 (org-element-property :type element))))))
1970 ;; Handle non-empty blank line at the end of buffer.
1971 (should
1972 (org-test-with-temp-text "#+BEGIN_SPECIAL\nC\n#+END_SPECIAL\n "
1973 (= (org-element-property :end (org-element-at-point)) (point-max)))))
1976 ;;;; Src Block
1978 (ert-deftest test-org-element/src-block-parser ()
1979 "Test `src-block' parser."
1980 ;; Regular tests.
1981 (should
1982 (org-test-with-temp-text "#+BEGIN_SRC org\nText\n#+END_SRC"
1983 (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
1984 ;; Ignore incomplete block.
1985 (should-not
1986 (org-test-with-temp-text "#+BEGIN_SRC"
1987 (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
1988 ;; Properly un-escape code.
1989 (should
1990 (equal "* Headline\n #+keyword\nText\n"
1991 (org-test-with-temp-text
1992 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText\n#+END_SRC"
1993 (org-element-property :value (org-element-at-point)))))
1994 ;; Remove block indentation according to block boundaries, unless
1995 ;; block contents are less indented than block boundaries.
1996 (should
1997 (equal " L1\nL2\n"
1998 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
1999 (let ((org-src-preserve-indentation t))
2000 (org-element-property :value (org-element-at-point))))))
2001 (should
2002 (equal
2003 " L1\n L2\n"
2004 (org-test-with-temp-text " #+BEGIN_SRC org\n L1\n L2\n #+END_SRC"
2005 (let ((org-src-preserve-indentation t))
2006 (org-element-property :value (org-element-at-point))))))
2007 ;; Handle non-empty blank line at the end of buffer.
2008 (should
2009 (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\nC\n#+END_SRC\n "
2010 (= (org-element-property :end (org-element-at-point)) (point-max)))))
2013 ;;;; Statistics Cookie
2015 (ert-deftest test-org-element/statistics-cookie ()
2016 "Test `statistics-cookie' parser."
2017 ;; With numbers.
2018 (should
2019 (org-test-with-temp-text "[1/2]"
2020 (org-element-map (org-element-parse-buffer) 'statistics-cookie 'identity)))
2021 ;; With percents.
2022 (should
2023 (org-test-with-temp-text "[33%]"
2024 (org-element-map
2025 (org-element-parse-buffer) 'statistics-cookie 'identity))))
2028 ;;;; Strike Through
2030 (ert-deftest test-org-element/strike-through-parser ()
2031 "Test `strike-through' parser."
2032 ;; Regular test.
2033 (should
2034 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2035 (org-test-with-temp-text "+strike-through+"
2036 (org-element-map (org-element-parse-buffer) 'strike-through 'identity))))
2037 ;; Multi-line markup.
2038 (should
2039 (equal
2040 (org-element-contents
2041 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2042 (org-test-with-temp-text "+first line\nsecond line+"
2043 (org-element-map
2044 (org-element-parse-buffer) 'strike-through 'identity nil t))))
2045 '("first line\nsecond line"))))
2048 ;;;; Subscript
2050 (ert-deftest test-org-element/subscript-parser ()
2051 "Test `subscript' parser."
2052 ;; Without braces.
2053 (should
2054 (org-test-with-temp-text "a_b"
2055 (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
2056 ;; With braces.
2057 (should
2058 (org-test-with-temp-text "a_{b}"
2059 (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
2060 ;; Multiple subscripts in a paragraph.
2061 (should
2062 (= 2
2063 (org-test-with-temp-text "a_b and c_d"
2064 (length
2065 (org-element-map (org-element-parse-buffer) 'subscript 'identity))))))
2068 ;;;; Superscript
2070 (ert-deftest test-org-element/superscript-parser ()
2071 "Test `superscript' parser."
2072 ;; Without braces.
2073 (should
2074 (org-test-with-temp-text "a^b"
2075 (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
2076 ;; With braces.
2077 (should
2078 (org-test-with-temp-text "a^{b}"
2079 (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
2080 ;; Multiple superscript in a paragraph.
2081 (should
2082 (= 2
2083 (org-test-with-temp-text "a^b and c^d"
2084 (length
2085 (org-element-map
2086 (org-element-parse-buffer) 'superscript 'identity))))))
2089 ;;;; Table
2091 (ert-deftest test-org-element/table-parser ()
2092 "Test `table' parser."
2093 (should
2094 (org-test-with-temp-text "| a |"
2095 (org-element-map (org-element-parse-buffer) 'table 'identity)))
2096 ;; TBLFM keyword is case insensitive.
2097 (should
2098 (org-test-with-temp-text "| a |\n#+tblfm: test"
2099 (org-element-property
2100 :tblfm
2101 (org-element-map (org-element-parse-buffer) 'table 'identity nil t))))
2102 ;; Handle multiple TBLFM lines.
2103 (should
2104 (= 2
2105 (org-test-with-temp-text "| a |\n#+TBLFM: test1\n#+TBLFM: test2"
2106 (length (org-element-property
2107 :tblfm
2108 (org-element-map
2109 (org-element-parse-buffer) 'table 'identity nil t))))))
2110 ;; Handle non-empty blank line at the end of buffer.
2111 (should
2112 (org-test-with-temp-text "| a |\n "
2113 (= (org-element-property :end (org-element-at-point)) (point-max)))))
2116 ;;;; Table Cell
2118 (ert-deftest test-org-element/table-cell-parser ()
2119 "Test `table-cell' parser."
2120 ;; Regular table cell.
2121 (should
2122 (org-test-with-temp-text "| a |"
2123 (org-element-map (org-element-parse-buffer) 'table-cell 'identity)))
2124 ;; Last vertical bar may be omitted.
2125 (should
2126 (org-test-with-temp-text "| a "
2127 (org-element-map (org-element-parse-buffer) 'table-cell 'identity))))
2130 ;;;; Table Row
2132 (ert-deftest test-org-element/table-row-parser ()
2133 "Test `table-row' parser."
2134 (should
2135 (equal '(standard rule)
2136 (org-test-with-temp-text "| a |\n|---|"
2137 (org-element-map
2138 (org-element-parse-buffer) 'table-row
2139 (lambda (row) (org-element-property :type row)))))))
2142 ;;;; Target
2144 (ert-deftest test-org-element/target-parser ()
2145 "Test `target' parser."
2146 (should
2147 (org-test-with-temp-text "<<target>>"
2148 (org-element-map (org-element-parse-buffer) 'target 'identity))))
2151 ;;;; Timestamp
2153 (ert-deftest test-org-element/timestamp ()
2154 "Test `timestamp' parser."
2155 ;; Active timestamp.
2156 (should
2157 (org-test-with-temp-text "<2012-03-29 16:40>"
2158 (eq (org-element-property :type (org-element-context)) 'active)))
2159 (should-not
2160 (org-test-with-temp-text "<2012-03-29 Thu>"
2161 (let ((timestamp (org-element-context)))
2162 (or (org-element-property :hour-start timestamp)
2163 (org-element-property :minute-start timestamp)))))
2164 (should
2165 (equal '(2012 3 29 16 40)
2166 (org-test-with-temp-text "<2012-03-29 Thu 16:40>"
2167 (let ((object (org-element-context)))
2168 (list (org-element-property :year-start object)
2169 (org-element-property :month-start object)
2170 (org-element-property :day-start object)
2171 (org-element-property :hour-start object)
2172 (org-element-property :minute-start object))))))
2173 ;; Inactive timestamp.
2174 (should
2175 (org-test-with-temp-text "[2012-03-29 Thu 16:40]"
2176 (eq (org-element-property :type (org-element-context)) 'inactive)))
2177 ;; Time range.
2178 (should
2179 (equal '(2012 3 29 16 40 7 30)
2180 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
2181 (let ((object (org-element-context)))
2182 (list (org-element-property :year-end object)
2183 (org-element-property :month-end object)
2184 (org-element-property :day-end object)
2185 (org-element-property :hour-end object)
2186 (org-element-property :minute-end object)
2187 (org-element-property :hour-start object)
2188 (org-element-property :minute-start object))))))
2189 (should
2190 (eq 'active-range
2191 (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
2192 (org-element-property :type (org-element-context)))))
2193 ;; Date range.
2194 (should
2195 (org-test-with-temp-text "[2012-03-29 Thu 16:40]--[2012-03-29 Thu 16:41]"
2196 (eq (org-element-property :type (org-element-context)) 'inactive-range)))
2197 (should-not
2198 (org-test-with-temp-text "[2011-07-14 Thu]--[2012-03-29 Thu]"
2199 (let ((timestamp (org-element-context)))
2200 (or (org-element-property :hour-end timestamp)
2201 (org-element-property :minute-end timestamp)))))
2202 ;; With repeater, warning delay and both.
2203 (should
2204 (eq 'catch-up
2205 (org-test-with-temp-text "<2012-03-29 Thu ++1y>"
2206 (org-element-property :repeater-type (org-element-context)))))
2207 (should
2208 (eq 'first
2209 (org-test-with-temp-text "<2012-03-29 Thu --1y>"
2210 (org-element-property :warning-type (org-element-context)))))
2211 (should
2212 (equal '(cumulate all)
2213 (org-test-with-temp-text "<2012-03-29 Thu +1y -1y>"
2214 (let ((ts (org-element-context)))
2215 (list (org-element-property :repeater-type ts)
2216 (org-element-property :warning-type ts)))))))
2219 ;;;; Underline
2221 (ert-deftest test-org-element/underline-parser ()
2222 "Test `underline' parser."
2223 ;; Regular test.
2224 (should
2225 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2226 (org-test-with-temp-text "_underline_"
2227 (org-element-map (org-element-parse-buffer) 'underline 'identity))))
2228 ;; Multi-line markup.
2229 (should
2230 (equal
2231 (org-element-contents
2232 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2233 (org-test-with-temp-text "_first line\nsecond line_"
2234 (org-element-map
2235 (org-element-parse-buffer) 'underline 'identity nil t))))
2236 '("first line\nsecond line"))))
2239 ;;;; Verbatim
2241 (ert-deftest test-org-element/verbatim-parser ()
2242 "Test `verbatim' parser."
2243 ;; Regular test.
2244 (should
2245 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2246 (org-test-with-temp-text "=verbatim="
2247 (org-element-map (org-element-parse-buffer) 'verbatim 'identity))))
2248 ;; Multi-line markup.
2249 (should
2250 (equal
2251 (org-element-property
2252 :value
2253 (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
2254 (org-test-with-temp-text "=first line\nsecond line="
2255 (org-element-map
2256 (org-element-parse-buffer) 'verbatim 'identity nil t))))
2257 "first line\nsecond line")))
2260 ;;;; Verse Block
2262 (ert-deftest test-org-element/verse-block-parser ()
2263 "Test `verse-block' parser."
2264 ;; Standard test.
2265 (should
2266 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
2267 (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
2268 ;; Ignore case.
2269 (should
2270 (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
2271 (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
2272 ;; Parse objects in verse blocks.
2273 (should
2274 (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
2275 (org-element-map (org-element-parse-buffer) 'entity 'identity)))
2276 ;; Ignore incomplete verse block.
2277 (should-not
2278 (org-test-with-temp-text "#+BEGIN_VERSE"
2279 (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)))
2280 ;; Handle non-empty blank line at the end of buffer.
2281 (should
2282 (org-test-with-temp-text "#+BEGIN_VERSE\nC\n#+END_VERSE\n "
2283 (= (org-element-property :end (org-element-at-point)) (point-max)))))
2287 ;;; Test Interpreters.
2289 (ert-deftest test-org-element/interpret-data ()
2290 "Test `org-element-interpret-data' specifications."
2291 ;; Interpret simple affiliated keywords.
2292 (should
2293 (equal
2294 (org-element-interpret-data
2295 '(org-data nil (paragraph (:name "para") "Paragraph")))
2296 "#+NAME: para\nParagraph\n"))
2297 ;; Interpret multiple affiliated keywords.
2298 (should
2299 (equal
2300 (org-element-interpret-data
2301 '(org-data nil (paragraph (:attr_ascii ("line2" "line1")) "Paragraph")))
2302 "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
2303 ;; Interpret parsed affiliated keywords.
2304 (should
2305 (equal
2306 (org-element-interpret-data
2307 '(org-data nil (paragraph (:caption (("caption"))) "Paragraph")))
2308 "#+CAPTION: caption\nParagraph\n"))
2309 ;; Interpret dual affiliated keywords.
2310 (should
2311 (equal
2312 (org-element-interpret-data
2313 '(org-data nil (paragraph (:caption ((("long") "short"))) "Paragraph")))
2314 "#+CAPTION[short]: long\nParagraph\n"))
2315 ;; Interpret multiple parsed dual keywords.
2316 (should
2317 (equal
2318 (org-element-interpret-data
2319 '(org-data nil (paragraph
2320 (:caption ((("l2") "s2") (("l1") "s1"))) "Paragraph")))
2321 "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph\n"))
2322 ;; Pseudo objects and elements are transparent.
2323 (should
2324 (equal "A B"
2325 (org-trim
2326 (org-element-interpret-data
2327 '(paragraph nil (pseudo-object (:post-blank 1) "A") "B")))))
2328 (should
2329 (equal "A\n\nB\n"
2330 (org-element-interpret-data
2331 '(center nil
2332 (pseudo-element (:post-blank 1) (paragraph nil "A"))
2333 (paragraph nil "B"))))))
2335 (ert-deftest test-org-element/center-block-interpreter ()
2336 "Test center block interpreter."
2337 (should
2338 (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
2339 "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
2341 (ert-deftest test-org-element/drawer-interpreter ()
2342 "Test drawer interpreter."
2343 (should
2344 (equal (org-test-parse-and-interpret ":TEST:\nTest\n:END:")
2345 ":TEST:\nTest\n:END:\n")))
2347 (ert-deftest test-org-element/dynamic-block-interpreter ()
2348 "Test dynamic block interpreter."
2349 (should
2350 (equal (org-test-parse-and-interpret
2351 "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
2352 "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
2354 (ert-deftest test-org-element/footnote-definition-interpreter ()
2355 "Test footnote definition interpreter."
2356 (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
2358 (ert-deftest test-org-element/headline-interpreter ()
2359 "Test headline and section interpreters."
2360 ;; 1. Standard test.
2361 (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
2362 ;; 2. With TODO keywords.
2363 (should
2364 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2365 (org-test-parse-and-interpret "* TODO Headline"))
2366 "* TODO Headline\n"))
2367 ;; 3. With tags...
2369 ;; 3.1. ... and a positive `org-tags-column' value.
2370 (should
2371 (equal (let ((org-tags-column 20))
2372 (org-test-parse-and-interpret "* Headline :tag:"))
2373 "* Headline :tag:\n"))
2374 ;; 3.2. ... and a negative `org-tags-column' value.
2375 (should
2376 (equal (let ((org-tags-column -20))
2377 (org-test-parse-and-interpret "* Headline :tag:"))
2378 "* Headline :tag:\n"))
2379 ;; 3.3. ... and a null `org-tags-column' value.
2380 (should
2381 (equal (let ((org-tags-column 0))
2382 (org-test-parse-and-interpret "* Headline :tag:"))
2383 "* Headline :tag:\n"))
2384 ;; 4. With priority cookie.
2385 (should
2386 (equal (org-test-parse-and-interpret "* [#B] Headline")
2387 "* [#B] Headline\n"))
2388 ;; 5. With comment keyword.
2389 (should
2390 (equal (let ((org-comment-string "COMMENT"))
2391 (org-test-parse-and-interpret "* COMMENT Headline"))
2392 "* COMMENT Headline\n"))
2393 ;; 6. Keep same number of blank lines before body.
2394 (should
2395 (equal (org-test-parse-and-interpret
2396 "* Headline\n\n\nText after two blank lines.")
2397 "* Headline\n\n\nText after two blank lines.\n"))
2398 ;; 8. Preserve `org-odd-levels-only' state.
2399 (should
2400 (equal "* H\n*** H2\n"
2401 (let ((org-odd-levels-only t))
2402 (org-test-parse-and-interpret "* H\n*** H2")))))
2404 (ert-deftest test-org-element/inlinetask-interpreter ()
2405 "Test inlinetask interpretation."
2406 (when (featurep 'org-inlinetask)
2407 (let ((org-inlinetask-min-level 15))
2408 ;; 1. Regular inlinetask.
2409 (should (equal (org-test-parse-and-interpret
2410 "*************** Task\nTest\n*************** END")
2411 "*************** Task\nTest\n*************** END\n"))
2412 ;; 2. Degenerate inlinetask.
2413 (should (equal (org-test-parse-and-interpret "*************** Task")
2414 "*************** Task\n"))
2415 ;; 3. Prefer degenerate form when there are no contents.
2416 (should (equal (org-test-parse-and-interpret
2417 "*************** Task\n*************** END")
2418 "*************** Task\n"))
2419 ;; 4. With TODO keywords.
2420 (should
2421 (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
2422 (org-test-parse-and-interpret "*************** TODO Task"))
2423 "*************** TODO Task\n"))
2424 ;; 5. With tags...
2426 ;; 5.1. ... and a positive `org-tags-column' value.
2427 (should
2428 (equal (let ((org-tags-column 30))
2429 (org-test-parse-and-interpret "*************** Task :tag:"))
2430 "*************** Task :tag:\n"))
2431 ;; 5.2. ... and a negative `org-tags-column' value.
2432 (should
2433 (equal (let ((org-tags-column -30))
2434 (org-test-parse-and-interpret "*************** Task :tag:"))
2435 "*************** Task :tag:\n"))
2436 ;; 5.3. ... and a null `org-tags-column' value.
2437 (should
2438 (equal (let ((org-tags-column 0))
2439 (org-test-parse-and-interpret "*************** Task :tag:"))
2440 "*************** Task :tag:\n"))
2441 ;; 6. With priority cookie.
2442 (should
2443 (equal (org-test-parse-and-interpret "*************** [#B] Task")
2444 "*************** [#B] Task\n")))))
2446 (ert-deftest test-org-element/plain-list-interpreter ()
2447 "Test plain-list and item interpreters."
2448 (let ((org-list-two-spaces-after-bullet-regexp nil))
2449 ;; Unordered list.
2450 (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
2451 ;; Description list.
2452 (should
2453 (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
2454 ;; Ordered list.
2455 (should
2456 (equal (let ((org-plain-list-ordered-item-terminator t))
2457 (org-test-parse-and-interpret "1. Item"))
2458 "1. Item\n"))
2459 (should
2460 (equal (let ((org-plain-list-ordered-item-terminator ?\)))
2461 (org-test-parse-and-interpret "1) Item"))
2462 "1) Item\n"))
2463 ;; Ordered list with counter.
2464 (should
2465 (equal (let ((org-plain-list-ordered-item-terminator t))
2466 (org-test-parse-and-interpret "1. [@5] Item"))
2467 "5. [@5] Item\n"))
2468 ;; List with check-boxes.
2469 (should
2470 (equal (org-test-parse-and-interpret
2471 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
2472 "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n"))
2473 ;; Item not starting with a paragraph.
2474 (should
2475 (equal (org-test-parse-and-interpret "-\n | a | b |")
2476 "- \n | a | b |\n"))
2477 ;; Special case: correctly handle "*" bullets.
2478 (should (org-test-parse-and-interpret " * item"))
2479 ;; Special case: correctly handle empty items.
2480 (should (org-test-parse-and-interpret "-"))))
2482 (ert-deftest test-org-element/quote-block-interpreter ()
2483 "Test quote block interpreter."
2484 (should (equal (org-test-parse-and-interpret
2485 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
2486 "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
2488 (ert-deftest test-org-element/special-block-interpreter ()
2489 "Test special block interpreter."
2490 (should (equal (org-test-parse-and-interpret
2491 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
2492 "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
2494 (ert-deftest test-org-element/babel-call-interpreter ()
2495 "Test Babel call interpreter."
2496 ;; Without argument.
2497 (should (equal (org-test-parse-and-interpret "#+CALL: test()")
2498 "#+CALL: test()\n"))
2499 ;; With argument.
2500 (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
2501 "#+CALL: test(x=2)\n"))
2502 ;; With header arguments.
2503 (should (equal (org-test-parse-and-interpret
2504 "#+CALL: test[:results output]() :results html")
2505 "#+CALL: test[:results output]() :results html\n")))
2507 (ert-deftest test-org-element/clock-interpreter ()
2508 "Test clock interpreter."
2509 ;; Running clock.
2510 (should
2511 (string-match
2512 "CLOCK: \\[2012-01-01 .* 00:01\\]"
2513 (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]")))
2514 ;; Closed clock.
2515 (should
2516 (string-match
2517 "CLOCK: \\[2012-01-01 .* 00:01\\]--\\[2012-01-01 .* 00:02\\] => 0:01"
2518 (org-test-parse-and-interpret "
2519 CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))))
2521 (ert-deftest test-org-element/comment-interpreter ()
2522 "Test comment interpreter."
2523 ;; Regular comment.
2524 (should (equal (org-test-parse-and-interpret "# Comment") "# Comment\n"))
2525 ;; Inline comment.
2526 (should (equal (org-test-parse-and-interpret " # Comment")
2527 "# Comment\n"))
2528 ;; Preserve indentation.
2529 (should (equal (org-test-parse-and-interpret " # No blank\n# One blank")
2530 "# No blank\n# One blank\n")))
2532 (ert-deftest test-org-element/comment-block-interpreter ()
2533 "Test comment block interpreter."
2534 (should (equal (org-test-parse-and-interpret
2535 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
2536 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n"))
2537 ;; Accept missing final newline in value.
2538 (should
2539 (equal
2540 "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n"
2541 (org-element-interpret-data '(comment-block (:value "Test"))))))
2543 (ert-deftest test-org-element/diary-sexp ()
2544 "Test diary-sexp interpreter."
2545 (should
2546 (equal
2547 (org-test-parse-and-interpret
2548 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old")
2549 "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old\n")))
2551 (ert-deftest test-org-element/example-block-interpreter ()
2552 "Test example block interpreter."
2553 ;; Without switches.
2554 (should (equal (org-test-parse-and-interpret
2555 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
2556 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
2557 ;; With switches.
2558 (should
2559 (equal (org-test-parse-and-interpret
2560 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
2561 "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n"))
2562 ;; Preserve code escaping.
2563 (should
2564 (equal (org-test-parse-and-interpret
2565 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE")
2566 "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword\nText #+END_EXAMPLE\n"))
2567 ;; Accept missing final newline in value.
2568 (should
2569 (equal
2570 "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"
2571 (org-element-interpret-data '(example-block (:value "Test"))))))
2573 (ert-deftest test-org-element/export-block-interpreter ()
2574 "Test export block interpreter."
2575 (should (equal (org-test-parse-and-interpret
2576 "#+BEGIN_HTML\nTest\n#+END_HTML")
2577 "#+BEGIN_HTML\nTest\n#+END_HTML\n")))
2579 (ert-deftest test-org-element/fixed-width-interpreter ()
2580 "Test fixed width interpreter."
2581 ;; Standard test.
2582 (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
2583 ;; Preserve indentation.
2584 (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
2585 ": 2 blanks\n: 1 blank\n"))
2586 ;; Remove last newline character
2587 (should
2588 (equal (org-element-fixed-width-interpreter
2589 '(fixed-width (:value "Test\n")) nil)
2590 ": Test"))
2591 (should
2592 (equal (org-element-fixed-width-interpreter
2593 '(fixed-width (:value "Test")) nil)
2594 ": Test"))
2595 ;; Handle empty string.
2596 (should
2597 (equal (org-element-fixed-width-interpreter
2598 '(fixed-width (:value "")) nil)
2599 ""))
2600 ;; Handle nil value.
2601 (should-not
2602 (org-element-fixed-width-interpreter
2603 '(fixed-width (:value nil)) nil)))
2605 (ert-deftest test-org-element/horizontal-rule-interpreter ()
2606 "Test horizontal rule interpreter."
2607 (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
2609 (ert-deftest test-org-element/keyword-interpreter ()
2610 "Test keyword interpreter."
2611 (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
2612 "#+KEYWORD: value\n")))
2614 (ert-deftest test-org-element/latex-environment-interpreter ()
2615 "Test latex environment interpreter."
2616 (should (equal (org-test-parse-and-interpret
2617 "\\begin{equation}\n1+1=2\n\\end{equation}")
2618 "\\begin{equation}\n1+1=2\n\\end{equation}\n"))
2619 (should (equal (org-test-parse-and-interpret
2620 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}")
2621 "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}\n")))
2623 (ert-deftest test-org-element/planning-interpreter ()
2624 "Test planning interpreter."
2625 (should
2626 (string-match
2627 "\\* Headline
2628 DEADLINE: <2012-03-29 .*?> SCHEDULED: <2012-03-29 .*?> CLOSED: \\[2012-03-29 .*?\\]"
2629 (org-test-parse-and-interpret
2630 "* Headline
2631 DEADLINE: <2012-03-29 thu.> SCHEDULED: <2012-03-29 thu.> CLOSED: [2012-03-29 thu.]"))))
2633 (ert-deftest test-org-element/property-drawer-interpreter ()
2634 "Test property drawer interpreter."
2635 (should (equal (let ((org-property-format "%-10s %s"))
2636 (org-test-parse-and-interpret
2637 "* H\n:PROPERTIES:\n:prop: value\n:END:"))
2638 "* H\n:PROPERTIES:\n:prop: value\n:END:\n")))
2640 (ert-deftest test-org-element/src-block-interpreter ()
2641 "Test src block interpreter."
2642 ;; With arguments.
2643 (should
2644 (equal (let ((org-edit-src-content-indentation 2)
2645 (org-src-preserve-indentation nil))
2646 (org-test-parse-and-interpret
2647 "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC"))
2648 "#+BEGIN_SRC emacs-lisp :results silent\n (+ 1 1)\n#+END_SRC\n"))
2649 ;; With switches.
2650 (should
2651 (equal (let ((org-edit-src-content-indentation 2)
2652 (org-src-preserve-indentation nil))
2653 (org-test-parse-and-interpret
2654 "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC"))
2655 "#+BEGIN_SRC emacs-lisp -n -k\n (+ 1 1)\n#+END_SRC\n"))
2656 ;; Preserve code escaping.
2657 (should
2658 (equal (let ((org-edit-src-content-indentation 2)
2659 (org-src-preserve-indentation nil))
2660 (org-test-parse-and-interpret
2661 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC"))
2662 "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText #+END_SRC\n"))
2663 ;; Do not apply `org-edit-src-content-indentation' when preserving
2664 ;; indentation.
2665 (should
2666 (equal (let ((org-edit-src-content-indentation 2)
2667 (org-src-preserve-indentation t))
2668 (org-test-parse-and-interpret
2669 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"))
2670 "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC\n"))
2671 (should
2672 (equal (let ((org-edit-src-content-indentation 2)
2673 (org-src-preserve-indentation nil))
2674 (org-test-parse-and-interpret
2675 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"))
2676 "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC\n"))
2677 ;; Accept missing final newline in value.
2678 (should
2679 (equal
2680 "#+BEGIN_SRC emacs-lisp\n Test\n#+END_SRC\n"
2681 (let ((org-edit-src-content-indentation 2)
2682 (org-src-preserve-indentation nil))
2683 (org-element-interpret-data
2684 '(src-block (:language "emacs-lisp" :value "Test")))))))
2686 (ert-deftest test-org-element/table-interpreter ()
2687 "Test table, table-row and table-cell interpreters."
2688 ;; 1. Simple table.
2689 (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
2690 "| a | b |\n| c | d |\n"))
2691 ;; 2. With horizontal rules.
2692 (should (equal (org-test-parse-and-interpret
2693 "| a | b |\n|---+---|\n| c | d |")
2694 "| a | b |\n|---+---|\n| c | d |\n"))
2695 ;; 3. With meta-data.
2696 (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
2697 "| / | < | > |\n| * | 1 | 2 |\n"))
2698 ;; 4. With a formula.
2699 (should
2700 (equal (org-test-parse-and-interpret
2701 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)")
2702 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)\n"))
2703 ;; 5. With multiple formulas.
2704 (should
2705 (equal (org-test-parse-and-interpret
2706 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2")
2707 "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2\n")))
2709 (ert-deftest test-org-element/timestamp-interpreter ()
2710 "Test timestamp interpreter."
2711 ;; Active.
2712 (should
2713 (string-match "<2012-03-29 .* 16:40>"
2714 (org-test-parse-and-interpret "<2012-03-29 thu. 16:40>")))
2715 (should
2716 (string-match "<2012-03-29 .* 16:40>"
2717 (org-element-timestamp-interpreter
2718 '(timestamp
2719 (:type active :year-start 2012 :month-start 3 :day-start 29
2720 :hour-start 16 :minute-start 40)) nil)))
2721 ;; Inactive.
2722 (should
2723 (string-match "\\[2012-03-29 .* 16:40\\]"
2724 (org-test-parse-and-interpret "[2012-03-29 thu. 16:40]")))
2725 (should
2726 (string-match
2727 "\\[2012-03-29 .* 16:40\\]"
2728 (org-element-timestamp-interpreter
2729 '(timestamp
2730 (:type inactive :year-start 2012 :month-start 3 :day-start 29
2731 :hour-start 16 :minute-start 40)) nil)))
2732 ;; Active range.
2733 (should
2734 (string-match "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2735 (org-test-parse-and-interpret
2736 "<2012-03-29 thu. 16:40>--<2012-03-29 thu. 16:41>")))
2737 (should
2738 (string-match
2739 "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
2740 (org-element-timestamp-interpreter
2741 '(timestamp
2742 (:type active-range :year-start 2012 :month-start 3 :day-start 29
2743 :hour-start 16 :minute-start 40 :year-end 2012 :month-end 3
2744 :day-end 29 :hour-end 16 :minute-end 41)) nil)))
2745 ;; Inactive range.
2746 (should
2747 (string-match "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2748 (org-test-parse-and-interpret
2749 "[2012-03-29 thu. 16:40]--[2012-03-29 thu. 16:41]")))
2750 (should
2751 (string-match
2752 "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
2753 (org-element-timestamp-interpreter
2754 '(timestamp
2755 (:type inactive-range :year-start 2012 :month-start 3 :day-start 29
2756 :hour-start 16 :minute-start 40 :year-end 2012 :month-end 3
2757 :day-end 29 :hour-end 16 :minute-end 41)) nil)))
2758 ;; Diary.
2759 (should (equal (org-test-parse-and-interpret "<%%diary-float t 4 2>")
2760 "<%%diary-float t 4 2>\n"))
2761 ;; Timestamp with repeater interval, with delay, with both.
2762 (should
2763 (string-match "<2012-03-29 .* \\+1y>"
2764 (org-test-parse-and-interpret "<2012-03-29 thu. +1y>")))
2765 (should
2766 (string-match
2767 "<2012-03-29 .* \\+1y>"
2768 (org-element-timestamp-interpreter
2769 '(timestamp
2770 (:type active :year-start 2012 :month-start 3 :day-start 29
2771 :repeater-type cumulate :repeater-value 1 :repeater-unit year))
2772 nil)))
2773 (should
2774 (string-match
2775 "<2012-03-29 .* -1y>"
2776 (org-element-timestamp-interpreter
2777 '(timestamp
2778 (:type active :year-start 2012 :month-start 3 :day-start 29
2779 :warning-type all :warning-value 1 :warning-unit year))
2780 nil)))
2781 (should
2782 (string-match
2783 "<2012-03-29 .* \\+1y -1y>"
2784 (org-element-timestamp-interpreter
2785 '(timestamp
2786 (:type active :year-start 2012 :month-start 3 :day-start 29
2787 :warning-type all :warning-value 1 :warning-unit year
2788 :repeater-type cumulate :repeater-value 1 :repeater-unit year))
2789 nil)))
2790 ;; Timestamp range with repeater interval
2791 (should
2792 (string-match "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2793 (org-test-parse-and-interpret
2794 "<2012-03-29 Thu +1y>--<2012-03-30 Thu +1y>")))
2795 (should
2796 (string-match
2797 "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
2798 (org-element-timestamp-interpreter
2799 '(timestamp
2800 (:type active-range :year-start 2012 :month-start 3 :day-start 29
2801 :year-end 2012 :month-end 3 :day-end 30 :repeater-type cumulate
2802 :repeater-value 1 :repeater-unit year))
2803 nil))))
2805 (ert-deftest test-org-element/verse-block-interpreter ()
2806 "Test verse block interpretation."
2807 (should
2808 (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
2809 "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
2811 (ert-deftest test-org-element/bold-interpreter ()
2812 "Test bold interpreter."
2813 (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
2815 (ert-deftest test-org-element/code-interpreter ()
2816 "Test code interpreter."
2817 (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
2819 (ert-deftest test-org-element/entity-interpreter ()
2820 "Test entity interpreter."
2821 ;; 1. Without brackets.
2822 (should
2823 (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
2824 ;; 2. With brackets.
2825 (should
2826 (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
2828 (ert-deftest test-org-element/export-snippet-interpreter ()
2829 "Test export snippet interpreter."
2830 (should (equal (org-test-parse-and-interpret "@@back-end:contents@@")
2831 "@@back-end:contents@@\n")))
2833 (ert-deftest test-org-element/footnote-reference-interpreter ()
2834 "Test footnote reference interpreter."
2835 ;; 1. Regular reference.
2836 (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
2837 ;; 2. Normalized reference.
2838 (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
2839 ;; 3. Named reference.
2840 (should (equal (org-test-parse-and-interpret "Text[fn:label]")
2841 "Text[fn:label]\n"))
2842 ;; 4. Inline reference.
2843 (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
2844 "Text[fn:label:def]\n"))
2845 ;; 5. Anonymous reference.
2846 (should (equal (org-test-parse-and-interpret "Text[fn::def]")
2847 "Text[fn::def]\n")))
2849 (ert-deftest test-org-element/inline-babel-call-interpreter ()
2850 "Test inline babel call interpreter."
2851 ;; Without arguments.
2852 (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
2853 ;; With arguments.
2854 (should (equal (org-test-parse-and-interpret "call_test(x=2)")
2855 "call_test(x=2)\n"))
2856 ;; With header arguments.
2857 (should (equal (org-test-parse-and-interpret
2858 "call_test[:results output]()[:results html]")
2859 "call_test[:results output]()[:results html]\n")))
2861 (ert-deftest test-org-element/inline-src-block-interpreter ()
2862 "Test inline src block interpreter."
2863 ;; 1. Without header argument.
2864 (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
2865 "src_emacs-lisp{(+ 1 1)}\n"))
2866 ;; 2. With header arguments.
2867 (should (equal (org-test-parse-and-interpret
2868 "src_emacs-lisp[:results silent]{(+ 1 1)}")
2869 "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
2871 (ert-deftest test-org-element/italic-interpreter ()
2872 "Test italic interpreter."
2873 (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
2875 (ert-deftest test-org-element/latex-fragment-interpreter ()
2876 "Test latex fragment interpreter."
2877 (should (equal (org-test-parse-and-interpret "\\command{}") "\\command{}\n"))
2878 (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
2879 (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
2880 (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
2881 (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
2882 (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n")))
2884 (ert-deftest test-org-element/line-break-interpreter ()
2885 "Test line break interpreter."
2886 (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
2887 "First line \\\\\nSecond line\n")))
2889 (ert-deftest test-org-element/link-interpreter ()
2890 "Test link interpreter."
2891 ;; 1. Links targeted from a radio target.
2892 (should (equal (let ((org-target-link-regexp "radio-target"))
2893 (org-test-parse-and-interpret "a radio-target"))
2894 "a radio-target\n"))
2895 ;; 2. Regular links.
2897 ;; 2.1. Without description.
2898 (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
2899 "[[http://orgmode.org]]\n"))
2900 ;; 2.2. With a description.
2901 (should (equal (org-test-parse-and-interpret
2902 "[[http://orgmode.org][Org mode]]")
2903 "[[http://orgmode.org][Org mode]]\n"))
2904 ;; 2.3. Id links.
2905 (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
2906 ;; 2.4. Custom-id links.
2907 (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
2908 ;; 2.5 Code-ref links.
2909 (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
2910 ;; 3. Normalize plain links.
2911 (should (equal (org-test-parse-and-interpret "http://orgmode.org")
2912 "[[http://orgmode.org]]\n"))
2913 ;; 4. Normalize angular links.
2914 (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
2915 "[[http://orgmode.org]]\n")))
2917 (ert-deftest test-org-element/macro-interpreter ()
2918 "Test macro interpreter."
2919 ;; 1. Without argument.
2920 (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
2921 ;; 2. With arguments.
2922 (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
2923 "{{{test(arg1,arg2)}}}\n")))
2925 (ert-deftest test-org-element/radio-target-interpreter ()
2926 "Test radio target interpreter."
2927 (should (equal (org-test-parse-and-interpret "<<<some text>>>")
2928 "<<<some text>>>\n")))
2930 (ert-deftest test-org-element/statistics-cookie-interpreter ()
2931 "Test statistics cookie interpreter."
2932 ;; 1. Without percent
2933 (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
2934 ;; 2. With percent.
2935 (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
2937 (ert-deftest test-org-element/strike-through-interpreter ()
2938 "Test strike through interpreter."
2939 (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
2941 (ert-deftest test-org-element/subscript-interpreter ()
2942 "Test subscript interpreter."
2943 ;; 1. Without brackets.
2944 (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
2945 ;; 2. With brackets.
2946 (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
2948 (ert-deftest test-org-element/superscript-interpreter ()
2949 "Test superscript interpreter."
2950 ;; 1. Without brackets.
2951 (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
2952 ;; 2. With brackets.
2953 (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
2955 (ert-deftest test-org-element/target-interpreter ()
2956 "Test target interpreter."
2957 (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
2959 (ert-deftest test-org-element/underline-interpreter ()
2960 "Test underline interpreter."
2961 (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
2963 (ert-deftest test-org-element/verbatim-interpreter ()
2964 "Test verbatim interpreter."
2965 (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
2969 ;;; Test Granularity
2971 (ert-deftest test-org-element/granularity ()
2972 "Test granularity impact on buffer parsing."
2973 (org-test-with-temp-text "
2974 * Head 1
2975 ** Head 2
2976 #+BEGIN_CENTER
2977 Centered paragraph.
2978 #+END_CENTER
2979 Paragraph \\alpha."
2980 ;; 1.1. Granularity set to `headline' should parse every headline
2981 ;; in buffer, and only them.
2982 (let ((tree (org-element-parse-buffer 'headline)))
2983 (should (= 2 (length (org-element-map tree 'headline 'identity))))
2984 (should-not (org-element-map tree 'paragraph 'identity)))
2985 ;; 1.2. Granularity set to `greater-element' should not enter
2986 ;; greater elements excepted headlines and sections.
2987 (let ((tree (org-element-parse-buffer 'greater-element)))
2988 (should (= 1 (length (org-element-map tree 'center-block 'identity))))
2989 (should (= 1 (length (org-element-map tree 'paragraph 'identity))))
2990 (should-not (org-element-map tree 'entity 'identity)))
2991 ;; 1.3. Granularity set to `element' should enter every
2992 ;; greater-element.
2993 (let ((tree (org-element-parse-buffer 'element)))
2994 (should (= 2 (length (org-element-map tree 'paragraph 'identity))))
2995 (should-not (org-element-map tree 'entity 'identity)))
2996 ;; 1.4. Granularity set to `object' can see everything.
2997 (let ((tree (org-element-parse-buffer 'object)))
2998 (should (= 1 (length (org-element-map tree 'entity 'identity)))))))
3000 (ert-deftest test-org-element/secondary-string-parsing ()
3001 "Test if granularity correctly toggles secondary strings parsing."
3002 ;; With a granularity bigger than `object', no secondary string
3003 ;; should be parsed.
3004 (should
3005 (stringp
3006 (org-test-with-temp-text "* Headline"
3007 (let ((headline
3008 (org-element-map (org-element-parse-buffer 'headline) 'headline
3009 #'identity nil 'first-match)))
3010 (org-element-property :title headline)))))
3011 (should
3012 (stringp
3013 (org-test-with-temp-text "* Headline\n- tag :: item"
3014 (let ((item (org-element-map (org-element-parse-buffer 'element) 'item
3015 #'identity nil 'first-match)))
3016 (org-element-property :tag item)))))
3017 (when (featurep 'org-inlinetask)
3018 (should
3019 (stringp
3020 (let ((org-inlinetask-min-level 15))
3021 (org-test-with-temp-text "*************** Inlinetask"
3022 (let ((inlinetask (org-element-map (org-element-parse-buffer 'element)
3023 'inlinetask
3024 #'identity nil 'first-match)))
3025 (org-element-property :title inlinetask)))))))
3026 ;; With a default granularity, secondary strings should be parsed.
3027 (should
3028 (listp
3029 (org-test-with-temp-text "* Headline"
3030 (let ((headline
3031 (org-element-map (org-element-parse-buffer) 'headline
3032 #'identity nil 'first-match)))
3033 (org-element-property :title headline)))))
3034 ;; `org-element-at-point' should never parse a secondary string.
3035 (should-not
3036 (listp
3037 (org-test-with-temp-text "* Headline"
3038 (org-element-property :title (org-element-at-point)))))
3039 ;; Preserve current local variables when parsing a secondary string.
3040 (should
3041 (let ((org-entities nil)
3042 (org-entities-user nil))
3043 (org-test-with-temp-text "
3044 #+CAPTION: \\foo
3045 Text
3046 # Local Variables:
3047 # org-entities-user: ((\"foo\"))
3048 # End:"
3049 (let ((safe-local-variable-values '((org-entities-user . (("foo"))))))
3050 (hack-local-variables))
3051 (org-element-map (org-element-parse-buffer) 'entity
3052 #'identity nil nil nil t)))))
3056 ;;; Test Visible Only Parsing
3058 (ert-deftest test-org-element/parse-buffer-visible ()
3059 "Test `org-element-parse-buffer' with visible only argument."
3060 (should
3061 (equal '("H1" "H3" "H5")
3062 (org-test-with-temp-text
3063 "* H1\n** H2\n** H3 :visible:\n** H4\n** H5 :visible:"
3064 (org-occur ":visible:")
3065 (org-element-map (org-element-parse-buffer nil t) 'headline
3066 (lambda (hl) (org-element-property :raw-value hl)))))))
3070 ;;; Test `:parent' Property
3072 (ert-deftest test-org-element/parent-property ()
3073 "Test `:parent' property."
3074 ;; Elements.
3075 (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
3076 (let* ((tree (org-element-parse-buffer))
3077 (parent (org-element-property
3078 :parent
3079 (org-element-map tree 'paragraph 'identity nil t))))
3080 (should parent)
3081 (should (eq (org-element-map tree 'center-block 'identity nil t)
3082 parent))))
3083 ;; Objects.
3084 (org-test-with-temp-text "a_{/b/}"
3085 (let* ((tree (org-element-parse-buffer))
3086 (parent (org-element-property
3087 :parent
3088 (org-element-map tree 'italic 'identity nil t))))
3089 (should parent)
3090 (should (eq parent
3091 (org-element-map tree 'subscript 'identity nil t)))))
3092 ;; Secondary strings
3093 (org-test-with-temp-text "* /italic/"
3094 (let* ((tree (org-element-parse-buffer))
3095 (parent (org-element-property
3096 :parent (org-element-map tree 'italic 'identity nil t))))
3097 (should parent)
3098 (should (eq parent
3099 (org-element-map tree 'headline 'identity nil t))))))
3103 ;;; Test Normalize Contents
3105 (ert-deftest test-org-element/normalize-contents ()
3106 "Test `org-element-normalize-contents' specifications."
3107 ;; Remove maximum common indentation from element's contents.
3108 (should
3109 (equal
3110 (org-element-normalize-contents
3111 '(paragraph nil " Two spaces\n Three spaces"))
3112 '(paragraph nil "Two spaces\n Three spaces")))
3113 ;; Ignore objects within contents when computing maximum common
3114 ;; indentation. However, if contents start with an object, common
3115 ;; indentation is 0.
3116 (should
3117 (equal
3118 (org-element-normalize-contents
3119 '(paragraph nil " One " (emphasis nil "space") "\n Two spaces"))
3120 '(paragraph nil "One " (emphasis nil "space") "\n Two spaces")))
3121 (should
3122 (equal
3123 (org-element-normalize-contents
3124 '(paragraph nil (verbatim nil "V") "No space\n Two\n Three"))
3125 '(paragraph nil (verbatim nil "V") "No space\n Two\n Three")))
3126 ;; Ignore blank lines.
3127 (should
3128 (equal
3129 (org-element-normalize-contents
3130 '(paragraph nil " Two spaces\n\n \n Two spaces"))
3131 '(paragraph nil "Two spaces\n\n \nTwo spaces")))
3132 (should
3133 (equal
3134 '(paragraph nil " Two spaces\n" (verbatim nil "V") "\n Two spaces")
3135 (org-element-normalize-contents
3136 '(paragraph nil " Two spaces\n " (verbatim nil "V") "\n Two spaces"))))
3137 (should
3138 (equal
3139 '(verse-block nil "line 1\n\nline 2")
3140 (org-element-normalize-contents
3141 '(verse-block nil " line 1\n\n line 2"))))
3142 ;; Recursively enter objects in order to compute common indentation.
3143 (should
3144 (equal
3145 (org-element-normalize-contents
3146 '(paragraph nil " Two spaces " (bold nil " and\n One space")))
3147 '(paragraph nil " Two spaces " (bold nil " and\nOne space"))))
3148 ;; When optional argument is provided, ignore first line
3149 ;; indentation.
3150 (should
3151 (equal
3152 (org-element-normalize-contents
3153 '(paragraph nil "No space\n Two spaces\n Three spaces") t)
3154 '(paragraph nil "No space\nTwo spaces\n Three spaces")))
3155 (should
3156 (equal
3157 (org-element-normalize-contents
3158 '(paragraph nil (verbatim nil "V") "No space\n Two\n Three") t)
3159 '(paragraph nil (verbatim nil "V") "No space\nTwo\n Three")))
3160 ;; Corner case: do not ignore indentation of string right after
3161 ;; a line break.
3162 (should
3163 (equal
3164 (org-element-normalize-contents
3165 '(paragraph nil " 1 space" (line-break) " 2 spaces"))
3166 '(paragraph nil "1 space" (line-break) " 2 spaces"))))
3170 ;;; Test Navigation Tools.
3172 (ert-deftest test-org-element/at-point ()
3173 "Test `org-element-at-point' specifications."
3174 ;; Return closest element containing point.
3175 (should
3176 (eq 'paragraph
3177 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
3178 (progn (search-forward "A")
3179 (org-element-type (org-element-at-point))))))
3180 ;; Correctly set `:parent' property.
3181 (should
3182 (eq 'center-block
3183 (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
3184 (progn (search-forward "A")
3185 (org-element-type
3186 (org-element-property :parent (org-element-at-point)))))))
3187 ;; Special case: at a blank line just below a headline, return that
3188 ;; headline.
3189 (should
3190 (equal "H1" (org-test-with-temp-text "* H1\n \n* H2\n"
3191 (forward-line)
3192 (org-element-property :title (org-element-at-point)))))
3193 ;; Special case: at the very beginning of a table, return `table'
3194 ;; object instead of `table-row'.
3195 (should
3196 (eq 'table
3197 (org-test-with-temp-text "| a | b |"
3198 (org-element-type (org-element-at-point)))))
3199 ;; Special case: at the very beginning of a list or sub-list, return
3200 ;; `plain-list' object instead of `item'.
3201 (should
3202 (eq 'plain-list
3203 (org-test-with-temp-text "- item"
3204 (org-element-type (org-element-at-point)))))
3205 ;; Special case: at the closing line of a greater element, be sure
3206 ;; to return it instead of the last element in its contents.
3207 (should
3208 (eq 'center-block
3209 (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph\n#+END_CENTER"
3210 (progn (forward-line 2)
3211 (org-element-type (org-element-at-point))))))
3212 ;; Special case: at a blank line between two items, be sure to
3213 ;; return item above instead of the last element of its contents.
3214 (should
3215 (eq 'item
3216 (org-test-with-temp-text "- Para1\n\n- Para2"
3217 (progn (forward-line)
3218 (org-element-type
3219 (let ((org-list-empty-line-terminates-plain-lists nil))
3220 (org-element-at-point)))))))
3221 ;; Special case: at the last blank line in a plain list, return it
3222 ;; instead of the last item.
3223 (should
3224 (eq 'plain-list
3225 (org-test-with-temp-text "- Para1\n- Para2\n\nPara3"
3226 (progn (forward-line 2)
3227 (org-element-type (org-element-at-point))))))
3228 ;; Special case: when a list ends at the end of buffer and there's
3229 ;; no final newline, return last element in last item.
3230 (should
3231 (eq 'paragraph
3232 (org-test-with-temp-text "- a"
3233 (end-of-line)
3234 (org-element-type (org-element-at-point)))))
3235 ;; Parse a list within a block itself contained in a list.
3236 (should
3237 (eq 'plain-list
3238 (org-test-with-temp-text
3239 "- outer\n #+begin_center\n - inner\n #+end_center"
3240 (search-forward "inner")
3241 (beginning-of-line)
3242 (org-element-type (org-element-at-point)))))
3243 ;; Do not error at eob on an empty line.
3244 (should
3245 (org-test-with-temp-text "* H\n"
3246 (forward-line)
3247 (or (org-element-at-point) t))))
3249 (ert-deftest test-org-element/context ()
3250 "Test `org-element-context' specifications."
3251 ;; Return closest object containing point.
3252 (should
3253 (eq 'underline
3254 (org-test-with-temp-text "Some *text with _underline_ text*"
3255 (progn (search-forward "under")
3256 (org-element-type (org-element-context))))))
3257 ;; Find objects in secondary strings.
3258 (should
3259 (eq 'underline
3260 (org-test-with-temp-text "* Headline _with_ underlining"
3261 (progn (search-forward "w")
3262 (org-element-type (org-element-context))))))
3263 ;; Find objects in objects.
3264 (should
3265 (eq 'macro
3266 (org-test-with-temp-text "| a | {{{macro}}} |"
3267 (progn (search-forward "{")
3268 (org-element-type (org-element-context))))))
3269 (should
3270 (eq 'table-cell
3271 (org-test-with-temp-text "| a | b {{{macro}}} |"
3272 (progn (search-forward "b")
3273 (org-element-type (org-element-context))))))
3274 ;; Find objects in planning lines.
3275 (should
3276 (eq 'timestamp
3277 (org-test-with-temp-text "* H\n SCHEDULED: <2012-03-29 thu.>"
3278 (search-forward "2012")
3279 (org-element-type (org-element-context)))))
3280 (should-not
3281 (eq 'timestamp
3282 (org-test-with-temp-text "* H\n SCHEDULED: <2012-03-29 thu.>"
3283 (search-forward "SCHEDULED")
3284 (org-element-type (org-element-context)))))
3285 ;; Do not find objects in table rules.
3286 (should
3287 (eq 'table-row
3288 (org-test-with-temp-text "| a | b |\n+---+---+\n| c | d |"
3289 (forward-line)
3290 (org-element-type (org-element-context)))))
3291 ;; Find objects in parsed affiliated keywords.
3292 (should
3293 (eq 'macro
3294 (org-test-with-temp-text "#+CAPTION: {{{macro}}}\n| a | b |."
3295 (progn (search-forward "{")
3296 (org-element-type (org-element-context))))))
3297 (should
3298 (eq 'bold
3299 (org-test-with-temp-text "#+caption: *bold*\nParagraph"
3300 (progn (search-forward "*")
3301 (org-element-type (org-element-context))))))
3302 ;; Find objects at the end of buffer.
3303 (should
3304 (eq 'bold
3305 (org-test-with-temp-text "*bold*"
3306 (goto-char (point-max))
3307 (org-element-type (org-element-context)))))
3308 ;; Correctly set `:parent' property.
3309 (should
3310 (eq 'paragraph
3311 (org-test-with-temp-text "Some *bold* text"
3312 (progn (search-forward "bold")
3313 (org-element-type
3314 (org-element-property :parent (org-element-context)))))))
3315 ;; Between two objects, return the second one.
3316 (should
3317 (eq 'macro
3318 (org-test-with-temp-text "<<target>>{{{test}}}"
3319 (progn (search-forward "{")
3320 (backward-char)
3321 (org-element-type (org-element-context))))))
3322 ;; Test optional argument.
3323 (should
3324 (eq 'underline
3325 (org-test-with-temp-text "Some *text with _underline_ text*"
3326 (progn
3327 (search-forward "under")
3328 (org-element-type (org-element-context (org-element-at-point)))))))
3329 ;; Special case: bold object at the beginning of a headline.
3330 (should
3331 (eq 'bold
3332 (org-test-with-temp-text "* *bold*"
3333 (search-forward "bo")
3334 (org-element-type (org-element-context)))))
3335 ;; Special case: incomplete cell at the end of a table row.
3336 (should
3337 (eq 'table-cell
3338 (org-test-with-temp-text "|a|b|c"
3339 (goto-char (point-max))
3340 (org-element-type (org-element-context)))))
3341 ;; Special case: objects in inline footnotes.
3342 (should
3343 (eq 'link
3344 (org-test-with-temp-text "[fn::[[<point>http://orgmode.org]]]"
3345 (org-element-type (org-element-context))))))
3349 ;;; Test Tools
3351 (ert-deftest test-org-element/lineage ()
3352 "Test `org-element-lineage' specifications."
3353 ;; Regular tests. When applied to an element or object returned by
3354 ;; `org-element-at-point' or `org-element-context', the list is
3355 ;; limited to the current section.
3356 (should
3357 (equal '(paragraph center-block)
3358 (org-test-with-temp-text
3359 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3360 (mapcar #'car (org-element-lineage (org-element-context))))))
3361 (should
3362 (equal '(paragraph center-block section headline headline org-data)
3363 (org-test-with-temp-text
3364 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3365 (mapcar #'car
3366 (org-element-lineage
3367 (org-element-map (org-element-parse-buffer) 'bold
3368 #'identity nil t))))))
3369 ;; Test TYPES optional argument.
3370 (should
3371 (eq 'center-block
3372 (org-test-with-temp-text
3373 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3374 (org-element-type
3375 (org-element-lineage (org-element-context) '(center-block))))))
3376 (should-not
3377 (org-test-with-temp-text
3378 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3379 (org-element-lineage (org-element-context) '(example-block))))
3380 ;; Test WITH-SELF optional argument.
3381 (should
3382 (equal '(bold paragraph center-block)
3383 (org-test-with-temp-text
3384 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3385 (mapcar #'car (org-element-lineage (org-element-context) nil t)))))
3386 ;; When TYPES and WITH-SELF are provided, the latter is also checked
3387 ;; against the former.
3388 (should
3389 (org-test-with-temp-text
3390 "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
3391 (org-element-lineage (org-element-context) '(bold) t))))
3395 ;;; Test Cache.
3397 (ert-deftest test-org-element/cache ()
3398 "Test basic expectations and common pitfalls for cache."
3399 ;; Shift positions.
3400 (should
3401 (equal '(18 . 23)
3402 (org-test-with-temp-text "para1\n\npara2\n\npara3"
3403 (let ((org-element-use-cache t))
3404 (save-excursion (goto-char (point-max)) (org-element-at-point))
3405 (insert "add")
3406 (forward-line 4)
3407 (let ((element (org-element-at-point)))
3408 (cons (org-element-property :begin element)
3409 (org-element-property :end element)))))))
3410 ;; Partial shifting: when the contents of a greater element are
3411 ;; modified, only shift ending positions.
3412 (should
3413 (org-test-with-temp-text
3414 "#+BEGIN_CENTER\nPara1\n\nPara2\n\nPara3\n#+END_CENTER"
3415 (let ((org-element-use-cache t))
3416 (save-excursion (search-forward "3") (org-element-at-point))
3417 (search-forward "Para2")
3418 (insert " ")
3419 (let ((element (org-element-property :parent (org-element-at-point))))
3420 (equal (cons (org-element-property :begin element)
3421 (org-element-property :end element))
3422 (cons (point-min) (point-max)))))))
3423 ;; Re-parent shifted elements.
3424 (should
3425 (eq 'item
3426 (org-test-with-temp-text "- item\n\n\n para1\n para2"
3427 (let ((org-element-use-cache t))
3428 (end-of-line)
3429 (org-element-at-point)
3430 (save-excursion (goto-char (point-max)) (org-element-at-point))
3431 (forward-line)
3432 (delete-char 1)
3433 (goto-char (point-max))
3434 (org-element-type
3435 (org-element-property :parent (org-element-at-point)))))))
3436 ;; Preserve local structures when re-parenting.
3437 (should
3438 (eq 'table
3439 (org-test-with-temp-text
3440 "#+begin_center\nP0\n\n<point>\n\n P1\n | a | b |\n| c | d |\n#+end_center"
3441 (let ((org-element-use-cache t))
3442 (save-excursion (search-forward "| c |") (org-element-at-point))
3443 (insert "- item")
3444 (search-forward "| c |")
3445 (beginning-of-line)
3446 (org-element-type
3447 (org-element-property :parent (org-element-at-point)))))))
3448 (should-not
3449 (eq 'center-block
3450 (org-test-with-temp-text
3451 "#+begin_center\nP0\n\n<point>\n\n P1\n | a | b |\n#+end_center"
3452 (let ((org-element-use-cache t))
3453 (save-excursion (search-forward "| a |") (org-element-at-point))
3454 (insert "- item")
3455 (search-forward "| a |")
3456 (beginning-of-line)
3457 (org-element-type
3458 (org-element-property :parent (org-element-at-point)))))))
3459 ;; When re-parenting, also propagate changes to list structures.
3460 (should
3461 (= 2
3462 (org-test-with-temp-text "\n Para\n - item<point>"
3463 (let ((org-element-use-cache t))
3464 (org-element-at-point)
3465 (goto-char (point-min))
3466 (insert "- Top\n")
3467 (search-forward "- item")
3468 (beginning-of-line)
3469 (length (org-element-property :structure (org-element-at-point)))))))
3470 ;; Modifying the last line of an element alters the element below.
3471 (should
3472 (org-test-with-temp-text "para1\n\npara2"
3473 (let ((org-element-use-cache t))
3474 (goto-char (point-max))
3475 (org-element-at-point)
3476 (forward-line -1)
3477 (insert "merge")
3478 (let ((element (org-element-at-point)))
3479 (equal (cons (org-element-property :begin element)
3480 (org-element-property :end element))
3481 (cons (point-min) (point-max)))))))
3482 ;; Modifying the first line of an element alters the element above.
3483 (should
3484 (org-test-with-temp-text ": fixed-width\n:not-fixed-width"
3485 (let ((org-element-use-cache t))
3486 (goto-char (point-max))
3487 (org-element-at-point)
3488 (search-backward ":")
3489 (forward-char)
3490 (insert " ")
3491 (let ((element (org-element-at-point)))
3492 (equal (cons (org-element-property :begin element)
3493 (org-element-property :end element))
3494 (cons (point-min) (point-max)))))))
3495 ;; Sensitive change: adding a line alters document structure both
3496 ;; above and below.
3497 (should
3498 (eq 'example-block
3499 (org-test-with-temp-text "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n"
3500 (let ((org-element-use-cache t))
3501 (goto-char (point-max))
3502 (org-element-at-point)
3503 (insert "#+END_EXAMPLE")
3504 (search-backward "Para1")
3505 (org-element-type (org-element-at-point))))))
3506 (should
3507 (eq 'example-block
3508 (org-test-with-temp-text "Para1\n\nPara2\n#+END_EXAMPLE"
3509 (let ((org-element-use-cache t))
3510 (save-excursion (goto-char (point-max)) (org-element-at-point))
3511 (insert "#+BEGIN_EXAMPLE\n")
3512 (search-forward "Para2")
3513 (org-element-type (org-element-at-point))))))
3514 ;; Sensitive change: removing a line alters document structure both
3515 ;; above and below.
3516 (should
3517 (eq 'example-block
3518 (org-test-with-temp-text
3519 "# +BEGIN_EXAMPLE\nPara1\n\nPara2\n#+END_EXAMPLE"
3520 (let ((org-element-use-cache t))
3521 (save-excursion (goto-char (point-max)) (org-element-at-point))
3522 (forward-char)
3523 (delete-char 1)
3524 (search-forward "Para2")
3525 (org-element-type (org-element-at-point))))))
3526 (should
3527 (eq 'example-block
3528 (org-test-with-temp-text
3529 "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n# +END_EXAMPLE"
3530 (let ((org-element-use-cache t))
3531 (save-excursion (goto-char (point-max)) (org-element-at-point))
3532 (search-forward "# ")
3533 (delete-char -1)
3534 (search-backward "Para1")
3535 (org-element-type (org-element-at-point))))))
3536 ;; Corner case: watch out drawers named "PROPERTIES" as they are
3537 ;; fragile, unlike to other drawers.
3538 (should
3539 (eq 'node-property
3540 (org-test-with-temp-text "* H\n:PROPERTIES:\n:A: 1\n:A<point>\n:END:"
3541 (let ((org-element-use-cache t))
3542 (org-element-at-point)
3543 (insert "+:")
3544 (org-element-type (org-element-at-point)))))))
3547 (provide 'test-org-element)
3549 ;;; test-org-element.el ends here