test-org-element.el 69 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945
  1. ;;; test-org-element.el --- Tests for org-element.el
  2. ;; Copyright (C) 2012 Nicolas Goaziou
  3. ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
  4. ;; This program is free software; you can redistribute it and/or modify
  5. ;; it under the terms of the GNU General Public License as published by
  6. ;; the Free Software Foundation, either version 3 of the License, or
  7. ;; (at your option) any later version.
  8. ;; This program is distributed in the hope that it will be useful,
  9. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. ;; GNU General Public License for more details.
  12. ;; You should have received a copy of the GNU General Public License
  13. ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
  14. ;;; Commentary:
  15. ;;; Code:
  16. (unless (featurep 'org-element)
  17. (signal 'missing-test-dependency "org-element"))
  18. (defun org-test-parse-and-interpret (text)
  19. "Parse TEXT as Org syntax and interpret it.
  20. Return interpreted string."
  21. (with-temp-buffer
  22. (org-mode)
  23. (insert text)
  24. (org-element-interpret-data (org-element-parse-buffer))))
  25. ;;; Test Parsers
  26. ;;;; Babel Call
  27. (ert-deftest test-org-element/babel-call-parser ()
  28. "Test `babel-call' parsing."
  29. (should
  30. (equal
  31. (org-test-with-temp-text "#+CALL: test()"
  32. (org-element-map (org-element-parse-buffer) 'babel-call 'identity nil t))
  33. '(babel-call (:begin 1 :end 15 :info ("test()" nil 0) :post-blank 0)))))
  34. ;;;; Bold
  35. (ert-deftest test-org-element/bold-parser ()
  36. "Test `bold' parser."
  37. ;; Regular test.
  38. (should
  39. (equal
  40. (org-test-with-temp-text "*bold*"
  41. (org-element-map (org-element-parse-buffer) 'bold 'identity nil t))
  42. '(bold (:begin 1 :end 7 :contents-begin 2 :contents-end 6 :post-blank 0)
  43. "bold")))
  44. ;; Multi-line markup.
  45. (should
  46. (equal
  47. (org-test-with-temp-text "*first line\nsecond line*"
  48. (org-element-map (org-element-parse-buffer) 'bold 'identity nil t))
  49. '(bold (:begin 1 :end 25 :contents-begin 2 :contents-end 24 :post-blank 0)
  50. "first line\nsecond line"))))
  51. ;;;; Center Block
  52. (ert-deftest test-org-element/center-block-parser ()
  53. "Test `center-block' parser."
  54. ;; Regular test.
  55. (should
  56. (equal
  57. (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
  58. (org-element-map
  59. (org-element-parse-buffer) 'center-block 'identity nil t))
  60. '(center-block
  61. (:begin 1 :end 33 :hiddenp nil :contents-begin 16 :contents-end 21
  62. :post-blank 0)
  63. (paragraph
  64. (:begin 16 :end 21 :contents-begin 16 :contents-end 20 :post-blank 0)
  65. "Text"))))
  66. ;; Test folded block.
  67. (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
  68. (org-cycle)
  69. (should
  70. (org-element-property
  71. :hiddenp
  72. (org-element-map
  73. (org-element-parse-buffer) 'center-block 'identity nil t))))
  74. ;; Ignore incomplete block.
  75. (should-not
  76. (org-test-with-temp-text "#+BEGIN_CENTER"
  77. (org-element-map
  78. (org-element-parse-buffer) 'center-block 'identity nil t))))
  79. ;;;; Clock
  80. (ert-deftest test-org-element/clock-parser ()
  81. "Test `clock' parser."
  82. ;; Running clock.
  83. (should
  84. (equal
  85. (let ((org-clock-string "CLOCK:"))
  86. (org-test-with-temp-text "CLOCK: [2012-01-01 sun. 00:01]"
  87. (org-element-map
  88. (org-element-parse-buffer) 'clock 'identity nil t)))
  89. '(clock
  90. (:status running :value "[2012-01-01 sun. 00:01]" :time nil :begin 1
  91. :end 31 :post-blank 0))))
  92. ;; Closed clock.
  93. (should
  94. (equal
  95. (let ((org-clock-string "CLOCK:"))
  96. (org-test-with-temp-text "
  97. CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"
  98. (org-element-map
  99. (org-element-parse-buffer) 'clock 'identity nil t)))
  100. '(clock
  101. (:status closed
  102. :value "[2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02]"
  103. :time "0:01" :begin 2 :end 66 :post-blank 0)))))
  104. ;;;; Code
  105. (ert-deftest test-org-element/code-parser ()
  106. "Test `code' parser."
  107. ;; Regular test.
  108. (should
  109. (equal
  110. (org-test-with-temp-text "~code~"
  111. (org-element-map (org-element-parse-buffer) 'code 'identity nil t))
  112. '(code (:value "code" :begin 1 :end 7 :post-blank 0))))
  113. ;; Multi-line markup.
  114. (should
  115. (equal
  116. (org-test-with-temp-text "~first line\nsecond line~"
  117. (org-element-map (org-element-parse-buffer) 'code 'identity nil t))
  118. '(code (:value "first line\nsecond line" :begin 1 :end 25 :post-blank 0)))))
  119. ;;;; Comment
  120. (ert-deftest test-org-element/comment-parser ()
  121. "Test `comment' parser."
  122. ;; Regular comment.
  123. (should
  124. (equal
  125. (org-test-with-temp-text "# Comment"
  126. (org-element-map (org-element-parse-buffer) 'comment 'identity nil t))
  127. '(comment (:begin 1 :end 10 :value "Comment\n" :post-blank 0))))
  128. ;; Inline comment.
  129. (should
  130. (equal
  131. (org-test-with-temp-text "#+ Comment"
  132. (org-element-map (org-element-parse-buffer) 'comment 'identity nil t))
  133. '(comment (:begin 1 :end 11 :value "Comment\n" :post-blank 0))))
  134. ;; Preserve indentation.
  135. (should
  136. (equal
  137. (org-test-with-temp-text "#+ No blank\n#+ One blank"
  138. (org-element-map (org-element-parse-buffer) 'comment 'identity nil t))
  139. '(comment (:begin 1 :end 26 :value "No blank\n One blank\n" :post-blank 0))))
  140. ;; Comment with blank lines.
  141. (should
  142. (equal
  143. (org-test-with-temp-text "#+ First part\n#+ \n#+\n#+ Second part"
  144. (org-element-map (org-element-parse-buffer) 'comment 'identity nil t))
  145. '(comment
  146. (:begin 1 :end 36 :value "First part\n\n\nSecond part\n"
  147. :post-blank 0)))))
  148. ;;;; Comment Block
  149. (ert-deftest test-org-element/comment-block-parser ()
  150. "Test `comment-block' parser."
  151. ;; Regular tests.
  152. (should
  153. (equal
  154. (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
  155. (org-element-map
  156. (org-element-parse-buffer) 'comment-block 'identity nil t))
  157. '(comment-block (:begin 1 :end 35 :value "Text\n" :hiddenp nil
  158. :post-blank 0))))
  159. ;; Test folded block.
  160. (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
  161. (org-cycle)
  162. (should
  163. (org-element-property
  164. :hiddenp
  165. (org-element-map
  166. (org-element-parse-buffer) 'comment-block 'identity nil t))))
  167. ;; Ignore incomplete block.
  168. (should-not
  169. (org-test-with-temp-text "#+BEGIN_COMMENT"
  170. (org-element-map
  171. (org-element-parse-buffer) 'comment-block 'identity nil t))))
  172. ;;;; Drawer
  173. (ert-deftest test-org-element/drawer-parser ()
  174. "Test `drawer' parser."
  175. ;; Regular test.
  176. (should
  177. (equal
  178. (let ((org-drawers '("TEST")))
  179. (org-test-with-temp-text ":TEST:\nText\n:END:"
  180. (org-element-map (org-element-parse-buffer) 'drawer 'identity nil t)))
  181. '(drawer
  182. (:begin 1 :end 18 :drawer-name "TEST" :hiddenp nil :contents-begin 8
  183. :contents-end 13 :post-blank 0)
  184. (paragraph
  185. (:begin 8 :end 13 :contents-begin 8 :contents-end 12 :post-blank 0)
  186. "Text"))))
  187. ;; Do not mix regular drawers and property drawers.
  188. (should-not
  189. (let ((org-drawers '("PROPERTIES")))
  190. (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
  191. (org-element-map
  192. (org-element-parse-buffer) 'drawer 'identity nil t))))
  193. ;; Ignore incomplete drawer.
  194. (should-not
  195. (let ((org-drawers '("TEST")))
  196. (org-test-with-temp-text ":TEST:"
  197. (org-element-map
  198. (org-element-parse-buffer) 'drawer 'identity nil t)))))
  199. ;;;; Dynamic Block
  200. (ert-deftest test-org-element/dynamic-block-parser ()
  201. "Test `dynamic-block' parser."
  202. ;; Regular test.
  203. (should
  204. (equal
  205. (org-test-with-temp-text
  206. "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
  207. (org-element-map
  208. (org-element-parse-buffer) 'dynamic-block 'identity nil t))
  209. '(dynamic-block
  210. (:begin 1 :end 55 :block-name "myblock"
  211. :arguments ":param1 val1 :param2 val2" :hiddenp nil
  212. :contents-begin 44 :contents-end 49 :post-blank 0)
  213. (paragraph
  214. (:begin 44 :end 49 :contents-begin 44 :contents-end 48 :post-blank 0)
  215. "Text"))))
  216. ;; Folded view
  217. (org-test-with-temp-text
  218. "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
  219. (org-cycle)
  220. (should
  221. (org-element-property
  222. :hiddenp
  223. (org-element-map
  224. (org-element-parse-buffer) 'dynamic-block 'identity nil t))))
  225. ;; Ignore incomplete block.
  226. (should-not
  227. (org-test-with-temp-text "#+BEGIN: myblock :param1 val1 :param2 val2"
  228. (org-element-map
  229. (org-element-parse-buffer) 'dynamic-block 'identity nil t))))
  230. ;;;; Entity
  231. (ert-deftest test-org-element/entity-parser ()
  232. "Test `entity' parser."
  233. ;; Without brackets.
  234. (should
  235. (equal
  236. (org-test-with-temp-text "\\sin"
  237. (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))
  238. '(entity
  239. (:name "sin" :latex "\\sin" :latex-math-p t :html "sin"
  240. :ascii "sin" :latin1 "sin" :utf-8 "sin" :begin 1 :end 5
  241. :use-brackets-p nil :post-blank 0))))
  242. ;; With brackets.
  243. (should
  244. (org-element-property
  245. :use-brackets-p
  246. (org-test-with-temp-text "\\alpha{}text"
  247. (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
  248. ;; User-defined entity.
  249. (should
  250. (equal
  251. (org-element-property
  252. :name
  253. (let ((org-entities-user
  254. '(("test" "test" nil "test" "test" "test" "test"))))
  255. (org-test-with-temp-text "\\test"
  256. (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
  257. "test")))
  258. ;;;; Example Block
  259. (ert-deftest test-org-element/example-block-parser ()
  260. "Test `example-block' parser."
  261. ;; Regular tests.
  262. (should
  263. (equal
  264. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
  265. (org-element-map
  266. (org-element-parse-buffer) 'example-block 'identity nil t))
  267. '(example-block
  268. (:begin 1 :end 35 :value "Text\n" :switches nil
  269. :number-lines nil :preserve-indent nil :retain-labels t
  270. :use-labels t :label-fmt nil :hiddenp nil :post-blank 0))))
  271. ;; Test folded block.
  272. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
  273. (org-cycle)
  274. (should
  275. (org-element-property
  276. :hiddenp
  277. (org-element-map
  278. (org-element-parse-buffer) 'example-block 'identity nil t))))
  279. ;; Ignore incomplete block.
  280. (should-not
  281. (org-test-with-temp-text "#+BEGIN_EXAMPLE"
  282. (org-element-map
  283. (org-element-parse-buffer) 'example-block 'identity nil t))))
  284. (ert-deftest test-org-element/block-switches ()
  285. "Test `example-block' and `src-block' switches parsing."
  286. (let ((org-coderef-label-format "(ref:%s)"))
  287. ;; 1. Test "-i" switch.
  288. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  289. (let ((element (org-element-current-element)))
  290. (should-not (org-element-property :preserve-indent element))))
  291. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"
  292. (let ((element (org-element-current-element)))
  293. (should (org-element-property :preserve-indent element))))
  294. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
  295. (let ((element (org-element-current-element)))
  296. (should-not (org-element-property :preserve-indent element))))
  297. (org-test-with-temp-text "#+BEGIN_EXAMPLE -i\nText.\n#+END_EXAMPLE"
  298. (let ((element (org-element-current-element)))
  299. (should (org-element-property :preserve-indent element))))
  300. ;; 2. "-n -r -k" combination should number lines, retain labels but
  301. ;; not use them in coderefs.
  302. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r -k\nText.\n#+END_EXAMPLE"
  303. (let ((element (org-element-current-element)))
  304. (should (and (org-element-property :number-lines element)
  305. (org-element-property :retain-labels element)
  306. (not (org-element-property :use-labels element))))))
  307. (org-test-with-temp-text
  308. "#+BEGIN_SRC emacs-lisp -n -r -k\n(+ 1 1)\n#+END_SRC"
  309. (let ((element (org-element-current-element)))
  310. (should (and (org-element-property :number-lines element)
  311. (org-element-property :retain-labels element)
  312. (not (org-element-property :use-labels element))))))
  313. ;; 3. "-n -r" combination should number-lines remove labels and not
  314. ;; use them in coderefs.
  315. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r\nText.\n#+END_EXAMPLE"
  316. (let ((element (org-element-current-element)))
  317. (should (and (org-element-property :number-lines element)
  318. (not (org-element-property :retain-labels element))
  319. (not (org-element-property :use-labels element))))))
  320. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1)\n#+END_SRC"
  321. (let ((element (org-element-current-element)))
  322. (should (and (org-element-property :number-lines element)
  323. (not (org-element-property :retain-labels element))
  324. (not (org-element-property :use-labels element))))))
  325. ;; 4. "-n" or "+n" should number lines, retain labels and use them
  326. ;; in coderefs.
  327. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n\nText.\n#+END_EXAMPLE"
  328. (let ((element (org-element-current-element)))
  329. (should (and (org-element-property :number-lines element)
  330. (org-element-property :retain-labels element)
  331. (org-element-property :use-labels element)))))
  332. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1)\n#+END_SRC"
  333. (let ((element (org-element-current-element)))
  334. (should (and (org-element-property :number-lines element)
  335. (org-element-property :retain-labels element)
  336. (org-element-property :use-labels element)))))
  337. (org-test-with-temp-text "#+BEGIN_EXAMPLE +n\nText.\n#+END_EXAMPLE"
  338. (let ((element (org-element-current-element)))
  339. (should (and (org-element-property :number-lines element)
  340. (org-element-property :retain-labels element)
  341. (org-element-property :use-labels element)))))
  342. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp +n\n(+ 1 1)\n#+END_SRC"
  343. (let ((element (org-element-current-element)))
  344. (should (and (org-element-property :number-lines element)
  345. (org-element-property :retain-labels element)
  346. (org-element-property :use-labels element)))))
  347. ;; 5. No switch should not number lines, but retain labels and use
  348. ;; them in coderefs.
  349. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
  350. (let ((element (org-element-current-element)))
  351. (should (and (not (org-element-property :number-lines element))
  352. (org-element-property :retain-labels element)
  353. (org-element-property :use-labels element)))))
  354. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  355. (let ((element (org-element-current-element)))
  356. (should (and (not (org-element-property :number-lines element))
  357. (org-element-property :retain-labels element)
  358. (org-element-property :use-labels element)))))
  359. ;; 6. "-r" switch only: do not number lines, remove labels, and
  360. ;; don't use labels in coderefs.
  361. (org-test-with-temp-text "#+BEGIN_EXAMPLE -r\nText.\n#+END_EXAMPLE"
  362. (let ((element (org-element-current-element)))
  363. (should (and (not (org-element-property :number-lines element))
  364. (not (org-element-property :retain-labels element))
  365. (not (org-element-property :use-labels element))))))
  366. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1)\n#+END_SRC"
  367. (let ((element (org-element-current-element)))
  368. (should (and (not (org-element-property :number-lines element))
  369. (not (org-element-property :retain-labels element))
  370. (not (org-element-property :use-labels element))))))
  371. ;; 7. Recognize coderefs with user-defined syntax.
  372. (org-test-with-temp-text
  373. "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText [ref:text]\n#+END_EXAMPLE"
  374. (let ((element (org-element-current-element)))
  375. (should
  376. (equal (org-element-property :label-fmt element) "[ref:%s]"))))
  377. (org-test-with-temp-text
  378. "#+BEGIN_SRC emacs-lisp -l \"[ref:%s]\"\n(+ 1 1) [ref:text]\n#+END_SRC"
  379. (let ((element (org-element-current-element)))
  380. (should
  381. (equal (org-element-property :label-fmt element) "[ref:%s]"))))))
  382. ;;;; Export Block
  383. (ert-deftest test-org-element/export-block-parser ()
  384. "Test `export-block' parser."
  385. ;; Regular tests.
  386. (should
  387. (equal
  388. (org-test-with-temp-text "#+BEGIN_LATEX\nText\n#+END_LATEX"
  389. (org-element-map
  390. (org-element-parse-buffer) 'export-block 'identity nil t))
  391. '(export-block
  392. (:begin 1 :end 31 :type "LATEX" :value "Text\n" :hiddenp nil
  393. :post-blank 0))))
  394. ;; Test folded block.
  395. (org-test-with-temp-text "#+BEGIN_LATEX\nText\n#+END_LATEX"
  396. (org-cycle)
  397. (should
  398. (org-element-property
  399. :hiddenp
  400. (org-element-map
  401. (org-element-parse-buffer) 'export-block 'identity nil t))))
  402. ;; Ignore incomplete block.
  403. (should-not
  404. (org-test-with-temp-text "#+BEGIN_LATEX"
  405. (org-element-map
  406. (org-element-parse-buffer) 'export-block 'identity nil t))))
  407. ;;;; Export Snippet
  408. (ert-deftest test-org-element/export-snippet-parser ()
  409. "Test `export-snippet' parser."
  410. (should
  411. (equal
  412. (org-test-with-temp-text "<back-end@contents>"
  413. (org-element-map
  414. (org-element-parse-buffer) 'export-snippet 'identity nil t))
  415. '(export-snippet
  416. (:back-end "back-end"
  417. :value "contents" :begin 1 :end 20 :post-blank 0)))))
  418. ;;;; Fixed Width
  419. (ert-deftest test-org-element/fixed-width ()
  420. "Test fixed-width area parsing."
  421. ;; Preserve indentation.
  422. (should
  423. (equal
  424. (org-test-with-temp-text ": no blank\n: one blank"
  425. (org-element-map (org-element-parse-buffer) 'fixed-width 'identity nil t))
  426. '(fixed-width
  427. (:begin 1 :end 24 :value "no blank\n one blank\n" :post-blank 0))))
  428. ;; Fixed-width with empty lines.
  429. (should
  430. (equal
  431. (org-test-with-temp-text ": first part\n:\n: \n: second part"
  432. (org-element-map (org-element-parse-buffer) 'fixed-width 'identity nil t))
  433. '(fixed-width
  434. (:begin 1 :end 32 :value "first part\n\n\nsecond part\n" :post-blank 0))))
  435. ;; Parse indented fixed-width markers.
  436. (should
  437. (equal
  438. (org-test-with-temp-text "Text\n : no blank\n : one blank"
  439. (org-element-map (org-element-parse-buffer) 'fixed-width 'identity nil t))
  440. '(fixed-width
  441. (:begin 6 :end 33 :value "no blank\n one blank\n" :post-blank 0))))
  442. ;; Distinguish fixed-width areas within a list and outside of it.
  443. (should
  444. (= 2
  445. (length
  446. (org-test-with-temp-text "
  447. - Item
  448. : fixed-width inside
  449. : fixed-width outside"
  450. (org-element-map
  451. (org-element-parse-buffer) 'fixed-width 'identity))))))
  452. ;;;; Footnote Definition.
  453. (ert-deftest test-org-element/footnote-definition-parser ()
  454. "Test `footnote-definition' parser."
  455. (should
  456. (equal
  457. (org-test-with-temp-text "[fn:1] Definition"
  458. (org-element-map
  459. (org-element-parse-buffer) 'footnote-definition 'identity nil t))
  460. '(footnote-definition
  461. (:label "fn:1" :begin 1 :end 18 :contents-begin 8 :contents-end 18
  462. :post-blank 0)
  463. (paragraph
  464. (:begin 8 :end 18 :contents-begin 8 :contents-end 18 :post-blank 0)
  465. "Definition")))))
  466. ;;;; Footnotes Reference
  467. (ert-deftest test-org-element/footnote-reference-parser ()
  468. "Test `footnote-reference' parser."
  469. ;; 1. Parse a standard reference.
  470. (org-test-with-temp-text "[fn:label]"
  471. (should (equal (org-element-footnote-reference-parser)
  472. '(footnote-reference
  473. (:label "fn:label" :type standard :inline-definition nil
  474. :begin 1 :end 11 :post-blank 0)))))
  475. ;; 2. Parse a normalized reference.
  476. (org-test-with-temp-text "[1]"
  477. (should (equal (org-element-footnote-reference-parser)
  478. '(footnote-reference
  479. (:label "1" :type standard :inline-definition nil
  480. :begin 1 :end 4 :post-blank 0)))))
  481. ;; 3. Parse an inline reference.
  482. (org-test-with-temp-text "[fn:test:def]"
  483. (should (equal (org-element-footnote-reference-parser)
  484. '(footnote-reference
  485. (:label "fn:test" :type inline :inline-definition ("def")
  486. :begin 1 :end 14 :post-blank 0)))))
  487. ;; 4. Parse an anonymous reference.
  488. (org-test-with-temp-text "[fn::def]"
  489. (should (equal (org-element-footnote-reference-parser)
  490. '(footnote-reference
  491. (:label nil :type inline :inline-definition ("def")
  492. :begin 1 :end 10 :post-blank 0)))))
  493. ;; 5. Parse nested footnotes.
  494. (org-test-with-temp-text "[fn::def [fn:label]]"
  495. (should
  496. (equal
  497. (org-element-footnote-reference-parser)
  498. '(footnote-reference
  499. (:label nil :type inline
  500. :inline-definition
  501. ("def "
  502. (footnote-reference
  503. (:label "fn:label" :type standard :inline-definition nil
  504. :begin 5 :end 15 :post-blank 0)))
  505. :begin 1 :end 21 :post-blank 0)))))
  506. ;; 6. Parse adjacent footnotes.
  507. (org-test-with-temp-text "[fn:label1][fn:label2]"
  508. (should
  509. (equal
  510. (org-element-footnote-reference-parser)
  511. '(footnote-reference
  512. (:label "fn:label1" :type standard :inline-definition nil :begin 1
  513. :end 12 :post-blank 0)))))
  514. ;; 7. Only properly closed footnotes are recognized as such.
  515. (org-test-with-temp-text "Text [fn:label"
  516. (should-not
  517. (org-element-map
  518. (org-element-parse-buffer) 'footnote-reference 'identity))))
  519. ;;;; Headlines
  520. (ert-deftest test-org-element/headline-quote-keyword ()
  521. "Test QUOTE keyword recognition."
  522. ;; Reference test.
  523. (org-test-with-temp-text "* Headline"
  524. (let ((org-quote-string "QUOTE"))
  525. (should-not (org-element-property :quotedp (org-element-at-point)))))
  526. ;; Standard position.
  527. (org-test-with-temp-text "* QUOTE Headline"
  528. (let ((org-quote-string "QUOTE"))
  529. (let ((headline (org-element-at-point)))
  530. (should (org-element-property :quotedp headline))
  531. ;; Test removal from raw value.
  532. (should (equal (org-element-property :raw-value headline) "Headline"))))
  533. ;; Case sensitivity.
  534. (let ((org-quote-string "Quote"))
  535. (should-not (org-element-property :quotedp (org-element-at-point)))))
  536. ;; With another keyword.
  537. (org-test-with-temp-text "* TODO QUOTE Headline"
  538. (let ((org-quote-string "QUOTE")
  539. (org-todo-keywords '((sequence "TODO" "DONE"))))
  540. (should (org-element-property :quotedp (org-element-at-point))))))
  541. (ert-deftest test-org-element/headline-comment-keyword ()
  542. "Test COMMENT keyword recognition."
  543. ;; Reference test.
  544. (org-test-with-temp-text "* Headline"
  545. (let ((org-comment-string "COMMENT"))
  546. (should-not (org-element-property :commentedp (org-element-at-point)))))
  547. ;; Standard position.
  548. (org-test-with-temp-text "* COMMENT Headline"
  549. (let ((org-comment-string "COMMENT"))
  550. (let ((headline (org-element-at-point)))
  551. (should (org-element-property :commentedp headline))
  552. ;; Test removal from raw value.
  553. (should (equal (org-element-property :raw-value headline) "Headline"))))
  554. ;; Case sensitivity.
  555. (let ((org-comment-string "Comment"))
  556. (should-not (org-element-property :commentedp (org-element-at-point)))))
  557. ;; With another keyword.
  558. (org-test-with-temp-text "* TODO COMMENT Headline"
  559. (let ((org-comment-string "COMMENT")
  560. (org-todo-keywords '((sequence "TODO" "DONE"))))
  561. (should (org-element-property :commentedp (org-element-at-point))))))
  562. (ert-deftest test-org-element/headline-archive-tag ()
  563. "Test ARCHIVE tag recognition."
  564. ;; Reference test.
  565. (org-test-with-temp-text "* Headline"
  566. (let ((org-archive-tag "ARCHIVE"))
  567. (should-not (org-element-property :archivedp (org-element-at-point)))))
  568. ;; Single tag.
  569. (org-test-with-temp-text "* Headline :ARCHIVE:"
  570. (let ((org-archive-tag "ARCHIVE"))
  571. (let ((headline (org-element-at-point)))
  572. (should (org-element-property :archivedp headline))
  573. ;; Test tag removal.
  574. (should-not (org-element-property :tags headline))))
  575. (let ((org-archive-tag "Archive"))
  576. (should-not (org-element-property :archivedp (org-element-at-point)))))
  577. ;; Multiple tags.
  578. (org-test-with-temp-text "* Headline :test:ARCHIVE:"
  579. (let ((org-archive-tag "ARCHIVE"))
  580. (let ((headline (org-element-at-point)))
  581. (should (org-element-property :archivedp headline))
  582. ;; Test tag removal.
  583. (should (equal (org-element-property :tags headline) '("test")))))))
  584. ;;;; Inlinetask.
  585. (ert-deftest test-org-element/inlinetask-parser ()
  586. "Test `inlinetask' parser."
  587. (when (featurep 'org-inlinetask)
  588. (let ((org-inlinetask-min-level 15))
  589. ;; 1. Regular inlinetask.
  590. (should
  591. (equal
  592. (org-test-with-temp-text
  593. "*************** Task\nTest\n*************** END"
  594. (org-element-map
  595. (org-element-parse-buffer) 'inlinetask 'identity nil t))
  596. '(inlinetask
  597. (:title ("Task") :begin 1 :end 46 :hiddenp nil :contents-begin 22
  598. :contents-end 27 :level 15 :priority nil :tags nil
  599. :todo-keyword nil :todo-type nil :scheduled nil :deadline nil
  600. :timestamp nil :clock nil :post-blank 0 :category "???")
  601. (paragraph
  602. (:begin 22 :end 27 :contents-begin 22 :contents-end 26 :post-blank 0)
  603. "Test"))))
  604. ;; 2. Degenerate inlinetask.
  605. (should
  606. (equal
  607. (org-test-with-temp-text
  608. "*************** Task"
  609. (org-element-map
  610. (org-element-parse-buffer) 'inlinetask 'identity nil t))
  611. '(inlinetask
  612. (:title ("Task") :begin 1 :end 21 :hiddenp nil :contents-begin 21
  613. :contents-end 21 :level 15 :priority nil :tags nil
  614. :todo-keyword nil :todo-type nil :scheduled nil :deadline nil
  615. :timestamp nil :clock nil :post-blank 0 :category nil))))
  616. ;; TODO keyword.
  617. (should
  618. (equal
  619. "TODO"
  620. (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  621. (org-test-with-temp-text "*************** TODO Task"
  622. (org-element-property
  623. :todo-keyword
  624. (org-element-map
  625. (org-element-parse-buffer) 'inlinetask 'identity nil t))))))
  626. ;; Planning info.
  627. (should
  628. (equal
  629. "2012-03-29 thu."
  630. (org-test-with-temp-text "
  631. *************** Task
  632. DEADLINE: <2012-03-29 thu.>"
  633. (org-element-property
  634. :deadline
  635. (org-element-map
  636. (org-element-parse-buffer) 'inlinetask 'identity nil t)))))
  637. ;; Priority.
  638. (should
  639. (equal
  640. ?A
  641. (org-test-with-temp-text "
  642. *************** [#A] Task"
  643. (org-element-property
  644. :priority
  645. (org-element-map
  646. (org-element-parse-buffer) 'inlinetask 'identity nil t)))))
  647. ;; Tags.
  648. (should
  649. (equal
  650. '("test")
  651. (org-test-with-temp-text "
  652. *************** Task :test:"
  653. (org-element-property
  654. :tags
  655. (org-element-map
  656. (org-element-parse-buffer) 'inlinetask 'identity nil t))))))))
  657. ;;;; Item.
  658. (ert-deftest test-org-element/item-parser ()
  659. "Test `item' parser."
  660. ;; Standard test.
  661. (should
  662. (equal
  663. (org-test-with-temp-text "- item"
  664. (org-element-map (org-element-parse-buffer) 'item 'identity nil t))
  665. '(item
  666. (:bullet "- " :begin 1 :end 7 :contents-begin 3 :contents-end 7
  667. :checkbox nil :counter nil :tag nil :hiddenp nil
  668. :structure ((1 0 "- " nil nil nil 7))
  669. :post-blank 0)
  670. (paragraph
  671. (:begin 3 :end 7 :contents-begin 3 :contents-end 7 :post-blank 0)
  672. "item"))))
  673. ;; Counter.
  674. (should
  675. (= 6
  676. (org-element-property
  677. :counter
  678. (org-test-with-temp-text "6. [@6] item"
  679. (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
  680. ;; Tag
  681. (should
  682. (equal
  683. '("tag")
  684. (org-element-property
  685. :tag
  686. (org-test-with-temp-text "- tag :: description"
  687. (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
  688. ;; Check-boxes
  689. (should
  690. (equal
  691. '(trans on off)
  692. (org-test-with-temp-text "
  693. - [-] item 1
  694. - [X] item 1.1
  695. - [ ] item 1.2"
  696. (org-element-map
  697. (org-element-parse-buffer) 'item
  698. (lambda (item) (org-element-property :checkbox item))))))
  699. ;; Folded state.
  700. (org-test-with-temp-text "* Headline
  701. - item
  702. paragraph below"
  703. (forward-line)
  704. (let ((org-cycle-include-plain-lists t)) (org-cycle))
  705. (should
  706. (org-element-property
  707. :hiddenp
  708. (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
  709. ;;;; Link
  710. (ert-deftest test-org-element/link-parser ()
  711. "Test `link' parser."
  712. ;; 1. Radio target.
  713. (should
  714. (equal (org-test-with-temp-text "A radio link"
  715. (org-element-map
  716. (let ((org-target-link-regexp "radio")) (org-element-parse-buffer))
  717. 'link 'identity nil t))
  718. '(link (:type "radio" :path "radio" :raw-link "radio" :begin 3 :end 9
  719. :contents-begin nil :contents-end nil :post-blank 1))))
  720. ;; 2. Standard link.
  721. ;;
  722. ;; 2.1. With description.
  723. (should
  724. (equal (org-test-with-temp-text "[[http://orgmode.org][Orgmode.org]]"
  725. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  726. '(link (:type "http" :path "//orgmode.org"
  727. :raw-link "http://orgmode.org" :begin 1 :end 36
  728. :contents-begin 23 :contents-end 34 :post-blank 0)
  729. "Orgmode.org")))
  730. ;; 2.2. Without description.
  731. (should
  732. (equal (org-test-with-temp-text "[[http://orgmode.org]]"
  733. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  734. '(link (:type "http" :path "//orgmode.org"
  735. :raw-link "http://orgmode.org" :begin 1 :end 23
  736. :contents-begin nil :contents-end nil :post-blank 0))))
  737. ;; 2.3. With expansion.
  738. (should
  739. (equal (org-test-with-temp-text "[[Org:worg]]"
  740. (let ((org-link-abbrev-alist '(("Org" . "http://orgmode.org/"))))
  741. (org-element-map
  742. (org-element-parse-buffer) 'link 'identity nil t)))
  743. '(link (:type "http" :path "//orgmode.org/worg" :raw-link "Org:worg"
  744. :begin 1 :end 13 :contents-begin nil :contents-end nil
  745. :post-blank 0))))
  746. ;; 2.4. With translation.
  747. (should
  748. (equal (org-test-with-temp-text "[[http://orgmode.org]]"
  749. (flet ((link-translate (type path) (cons type "127.0.0.1")))
  750. (let ((org-link-translation-function 'link-translate))
  751. (org-element-map
  752. (org-element-parse-buffer) 'link 'identity nil t))))
  753. '(link (:type "http" :path "127.0.0.1" :raw-link "http://orgmode.org"
  754. :begin 1 :end 23 :contents-begin nil :contents-end nil
  755. :post-blank 0))))
  756. ;; 2.5. Id link.
  757. (should
  758. (equal (org-test-with-temp-text "[[id:aaaa]]"
  759. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  760. '(link (:type "id" :path "aaaa" :raw-link "id:aaaa" :begin 1 :end 12
  761. :contents-begin nil :contents-end nil :post-blank 0))))
  762. ;; 2.6. Custom-id link.
  763. (should
  764. (equal (org-test-with-temp-text "[[#some-id]]"
  765. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  766. '(link (:type "custom-id" :path "some-id" :raw-link "#some-id"
  767. :begin 1 :end 13 :contents-begin nil :contents-end nil
  768. :post-blank 0))))
  769. ;; 2.7 Coderef link.
  770. (should
  771. (equal (org-test-with-temp-text "[[(reference)]]"
  772. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  773. '(link (:type "coderef" :path "reference" :raw-link "(reference)"
  774. :begin 1 :end 16 :contents-begin nil :contents-end nil
  775. :post-blank 0))))
  776. ;; 2.8 Fuzzy link.
  777. (should
  778. (equal (org-test-with-temp-text "[[target-or-title]]"
  779. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  780. '(link (:type "fuzzy" :path "target-or-title"
  781. :raw-link "target-or-title" :begin 1 :end 20
  782. :contents-begin nil :contents-end nil :post-blank 0))))
  783. ;; 3. Plain link.
  784. (should
  785. (equal (org-test-with-temp-text "A link: http://orgmode.org"
  786. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  787. '(link (:type "http" :path "//orgmode.org"
  788. :raw-link "http://orgmode.org" :begin 9 :end 27
  789. :contents-begin nil :contents-end nil :post-blank 0))))
  790. ;; 4. Angular link.
  791. (should
  792. (equal (org-test-with-temp-text "A link: <http://orgmode.org>"
  793. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  794. '(link (:type "http" :path "//orgmode.org"
  795. :raw-link "http://orgmode.org" :begin 9 :end 29
  796. :contents-begin nil :contents-end nil :post-blank 0)))))
  797. ;;;; Plain List.
  798. (ert-deftest test-org-element/plain-list-parser ()
  799. "Test `plain-list' parser."
  800. (should
  801. (equal
  802. (org-test-with-temp-text "- item"
  803. (org-element-map (org-element-parse-buffer) 'plain-list 'identity nil t))
  804. '(plain-list
  805. (:type unordered :begin 1 :end 7 :contents-begin 1 :contents-end 7
  806. :structure ((1 0 "- " nil nil nil 7)) :post-blank 0)
  807. (item
  808. (:bullet "- " :begin 1 :end 7 :contents-begin 3 :contents-end 7
  809. :checkbox nil :counter nil :tag nil :hiddenp nil
  810. :structure ((1 0 "- " nil nil nil 7)) :post-blank 0)
  811. (paragraph
  812. (:begin 3 :end 7 :contents-begin 3 :contents-end 7 :post-blank 0)
  813. "item")))))
  814. ;; Blank lines after the list only belong to outer plain list.
  815. (org-test-with-temp-text "
  816. - outer
  817. - inner
  818. Outside list"
  819. (let ((endings (org-element-map
  820. (org-element-parse-buffer) 'plain-list
  821. (lambda (pl) (org-element-property :end pl)))))
  822. ;; Move to ending of outer list.
  823. (goto-char (car endings))
  824. (should (looking-at "Outside list"))
  825. ;; Move to ending of inner list.
  826. (goto-char (nth 1 endings))
  827. (should (looking-at "^$")))))
  828. ;;;; Src Block.
  829. (ert-deftest test-org-element/src-block-parser ()
  830. "Test `src-block' parser."
  831. ;; Regular tests.
  832. (should
  833. (equal
  834. (org-test-with-temp-text "#+BEGIN_SRC\nText\n#+END_SRC"
  835. (org-element-map
  836. (org-element-parse-buffer) 'src-block 'identity nil t))
  837. '(src-block
  838. (:language nil :switches nil :parameters nil :begin 1 :end 27
  839. :number-lines nil :preserve-indent nil :retain-labels t
  840. :use-labels t :label-fmt nil :hiddenp nil :value "Text\n"
  841. :post-blank 0))))
  842. ;; Test folded block.
  843. (org-test-with-temp-text "#+BEGIN_SRC\nText\n#+END_SRC"
  844. (org-cycle)
  845. (should
  846. (org-element-property
  847. :hiddenp
  848. (org-element-map
  849. (org-element-parse-buffer) 'src-block 'identity nil t))))
  850. ;; Ignore incomplete block.
  851. (should-not
  852. (org-test-with-temp-text "#+BEGIN_SRC"
  853. (org-element-map
  854. (org-element-parse-buffer) 'src-block 'identity nil t))))
  855. ;;;; Quote Block
  856. (ert-deftest test-org-element/quote-block-parser ()
  857. "Test `quote-block' parser."
  858. ;; Regular test.
  859. (should
  860. (equal
  861. (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
  862. (org-element-map
  863. (org-element-parse-buffer) 'quote-block 'identity nil t))
  864. '(quote-block
  865. (:begin 1 :end 31 :hiddenp nil :contents-begin 15 :contents-end 20
  866. :post-blank 0)
  867. (paragraph
  868. (:begin 15 :end 20 :contents-begin 15 :contents-end 19 :post-blank 0)
  869. "Text"))))
  870. ;; Test folded block.
  871. (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
  872. (org-cycle)
  873. (should
  874. (org-element-property
  875. :hiddenp
  876. (org-element-map
  877. (org-element-parse-buffer) 'quote-block 'identity nil t))))
  878. ;; Ignore incomplete block.
  879. (should-not
  880. (org-test-with-temp-text "#+BEGIN_QUOTE"
  881. (org-element-map
  882. (org-element-parse-buffer) 'quote-block 'identity nil t))))
  883. ;;;; Section
  884. (ert-deftest test-org-element/section-parser ()
  885. "Test `section' parser."
  886. ;; Standard test.
  887. (should
  888. (equal
  889. (org-test-with-temp-text "* Headline\nText"
  890. (org-element-map (org-element-parse-buffer) 'section 'identity nil t))
  891. '(section
  892. (:begin 12 :end 16 :contents-begin 12 :contents-end 16 :post-blank 0)
  893. (paragraph
  894. (:begin 12 :end 16 :contents-begin 12 :contents-end 16 :post-blank 0)
  895. "Text"))))
  896. ;; There's a section before the first headline.
  897. (should
  898. (org-test-with-temp-text "Text"
  899. (org-element-map (org-element-parse-buffer) 'section 'identity)))
  900. ;; A section cannot be empty.
  901. (should-not
  902. (org-test-with-temp-text "* Headline 1\n* Headline 2"
  903. (org-element-map (org-element-parse-buffer) 'section 'identity))))
  904. ;;;; Special Block
  905. (ert-deftest test-org-element/special-block-parser ()
  906. "Test `special-block' parser."
  907. ;; Regular test.
  908. (should
  909. (equal
  910. (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
  911. (org-element-map
  912. (org-element-parse-buffer) 'special-block 'identity nil t))
  913. '(special-block
  914. (:type "SPECIAL" :begin 1 :end 35 :hiddenp nil :contents-begin 17
  915. :contents-end 22 :post-blank 0)
  916. (paragraph
  917. (:begin 17 :end 22 :contents-begin 17 :contents-end 21 :post-blank 0)
  918. "Text"))))
  919. ;; Test folded block.
  920. (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
  921. (org-cycle)
  922. (should
  923. (org-element-property
  924. :hiddenp
  925. (org-element-map
  926. (org-element-parse-buffer) 'special-block 'identity nil t))))
  927. ;; Ignore incomplete block.
  928. (should-not
  929. (org-test-with-temp-text "#+BEGIN_SPECIAL"
  930. (org-element-map
  931. (org-element-parse-buffer) 'special-block 'identity nil t))))
  932. ;;;; Verse Block
  933. (ert-deftest test-org-element/verse-block-parser ()
  934. "Test `verse-block' parser."
  935. ;; Standard test.
  936. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
  937. (should
  938. (equal
  939. (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)
  940. '(verse-block
  941. (:begin 1 :end 38 :contents-begin 15 :contents-end 27 :hiddenp nil
  942. :post-blank 0)
  943. "Verse block\n"))))
  944. ;; Ignore case.
  945. (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
  946. (should
  947. (equal
  948. (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)
  949. '(verse-block
  950. (:begin 1 :end 38 :contents-begin 15 :contents-end 27 :hiddenp nil
  951. :post-blank 0)
  952. "Verse block\n"))))
  953. ;; Parse folding.
  954. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
  955. (org-hide-block-all)
  956. (should
  957. (equal
  958. (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)
  959. '(verse-block
  960. (:begin 1 :end 38 :contents-begin 15 :contents-end 27
  961. :hiddenp org-hide-block :post-blank 0)
  962. "Verse block\n"))))
  963. ;; Parse objects in verse blocks.
  964. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
  965. (should (org-element-map (org-element-parse-buffer) 'entity 'identity)))
  966. ;; Ignore incomplete verse block.
  967. (should-not
  968. (org-test-with-temp-text "#+BEGIN_VERSE"
  969. (org-element-map
  970. (org-element-parse-buffer) 'verse-block 'identity nil t))))
  971. ;;; Test Interpreters.
  972. (ert-deftest test-org-element/interpret-affiliated-keywords ()
  973. "Test if affiliated keywords are correctly interpreted."
  974. ;; Interpret simple keywords.
  975. (should
  976. (equal
  977. (org-element-interpret-data
  978. '(org-data nil (paragraph (:name "para") "Paragraph")))
  979. "#+NAME: para\nParagraph\n"))
  980. ;; Interpret multiple keywords.
  981. (should
  982. (equal
  983. (org-element-interpret-data
  984. '(org-data nil (paragraph (:attr_ascii ("line1" "line2")) "Paragraph")))
  985. "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
  986. ;; Interpret parsed keywords.
  987. (should
  988. (equal
  989. (org-element-interpret-data
  990. '(org-data nil (paragraph (:caption ("caption")) "Paragraph")))
  991. "#+CAPTION: caption\nParagraph\n"))
  992. ;; Interpret dual keywords.
  993. (should
  994. (equal
  995. (org-element-interpret-data
  996. '(org-data nil (paragraph (:caption (("long") "short")) "Paragraph")))
  997. "#+CAPTION[short]: long\nParagraph\n")))
  998. (ert-deftest test-org-element/center-block-interpreter ()
  999. "Test center block interpreter."
  1000. (should
  1001. (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
  1002. "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
  1003. (ert-deftest test-org-element/drawer-interpreter ()
  1004. "Test drawer interpreter."
  1005. (should
  1006. (equal (let ((org-drawers '("TEST")))
  1007. (org-test-parse-and-interpret ":TEST:\nTest\n:END:"))
  1008. ":TEST:\nTest\n:END:\n")))
  1009. (ert-deftest test-org-element/dynamic-block-interpreter ()
  1010. "Test dynamic block interpreter."
  1011. (should
  1012. (equal (org-test-parse-and-interpret
  1013. "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
  1014. "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
  1015. (ert-deftest test-org-element/footnote-definition-interpreter ()
  1016. "Test footnote definition interpreter."
  1017. (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
  1018. (ert-deftest test-org-element/headline-interpreter ()
  1019. "Test headline and section interpreters."
  1020. ;; 1. Standard test.
  1021. (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
  1022. ;; 2. With TODO keywords.
  1023. (should
  1024. (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  1025. (org-test-parse-and-interpret "* TODO Headline"))
  1026. "* TODO Headline\n"))
  1027. ;; 3. With tags...
  1028. ;;
  1029. ;; 3.1. ... and a positive `org-tags-column' value.
  1030. (should
  1031. (equal (let ((org-tags-column 20))
  1032. (org-test-parse-and-interpret "* Headline :tag:"))
  1033. "* Headline :tag:\n"))
  1034. ;; 3.2. ... and a negative `org-tags-column' value.
  1035. (should
  1036. (equal (let ((org-tags-column -20))
  1037. (org-test-parse-and-interpret "* Headline :tag:"))
  1038. "* Headline :tag:\n"))
  1039. ;; 3.3. ... and a null `org-tags-column' value.
  1040. (should
  1041. (equal (let ((org-tags-column 0))
  1042. (org-test-parse-and-interpret "* Headline :tag:"))
  1043. "* Headline :tag:\n"))
  1044. ;; 4. With priority cookie.
  1045. (should
  1046. (equal (org-test-parse-and-interpret "* [#B] Headline")
  1047. "* [#B] Headline\n"))
  1048. ;; 5. With comment keyword.
  1049. (should
  1050. (equal (let ((org-comment-string "COMMENT"))
  1051. (org-test-parse-and-interpret "* COMMENT Headline"))
  1052. "* COMMENT Headline\n"))
  1053. ;; 6. With quote section.
  1054. (should
  1055. (equal (let ((org-quote-string "QUOTE"))
  1056. (org-test-parse-and-interpret "* QUOTE Headline"))
  1057. "* QUOTE Headline\n"))
  1058. ;; 7. Keep same number of blank lines before body.
  1059. (should
  1060. (equal (org-test-parse-and-interpret
  1061. "* Headline\n\n\nText after two blank lines.")
  1062. "* Headline\n\n\nText after two blank lines.\n")))
  1063. (ert-deftest test-org-element/inlinetask-interpreter ()
  1064. "Test inlinetask interpretation."
  1065. (when (featurep 'org-inlinetask)
  1066. (let ((org-inlinetask-min-level 15))
  1067. ;; 1. Regular inlinetask.
  1068. (should (equal (org-test-parse-and-interpret
  1069. "*************** Task\nTest\n*************** END")
  1070. "*************** Task\nTest\n*************** END\n"))
  1071. ;; 2. Degenerate inlinetask.
  1072. (should (equal (org-test-parse-and-interpret "*************** Task")
  1073. "*************** Task\n"))
  1074. ;; 3. Prefer degenerate form when there are no contents.
  1075. (should (equal (org-test-parse-and-interpret
  1076. "*************** Task\n*************** END")
  1077. "*************** Task\n"))
  1078. ;; 4. With TODO keywords.
  1079. (should
  1080. (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  1081. (org-test-parse-and-interpret "*************** TODO Task"))
  1082. "*************** TODO Task\n"))
  1083. ;; 5. With tags...
  1084. ;;
  1085. ;; 5.1. ... and a positive `org-tags-column' value.
  1086. (should
  1087. (equal (let ((org-tags-column 30))
  1088. (org-test-parse-and-interpret "*************** Task :tag:"))
  1089. "*************** Task :tag:\n"))
  1090. ;; 5.2. ... and a negative `org-tags-column' value.
  1091. (should
  1092. (equal (let ((org-tags-column -30))
  1093. (org-test-parse-and-interpret "*************** Task :tag:"))
  1094. "*************** Task :tag:\n"))
  1095. ;; 5.3. ... and a null `org-tags-column' value.
  1096. (should
  1097. (equal (let ((org-tags-column 0))
  1098. (org-test-parse-and-interpret "*************** Task :tag:"))
  1099. "*************** Task :tag:\n"))
  1100. ;; 6. With priority cookie.
  1101. (should
  1102. (equal (org-test-parse-and-interpret "*************** [#B] Task")
  1103. "*************** [#B] Task\n")))))
  1104. (ert-deftest test-org-element/plain-list-interpreter ()
  1105. "Test plain-list and item interpreters."
  1106. ;; 1. Unordered list.
  1107. (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
  1108. ;; 2. Description list.
  1109. (should
  1110. (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
  1111. ;; 3. Ordered list.
  1112. (should
  1113. (equal (let ((org-plain-list-ordered-item-terminator t))
  1114. (org-test-parse-and-interpret "1. Item"))
  1115. "1. Item\n"))
  1116. ;; 4. Ordered list with counter.
  1117. (should
  1118. (equal (let ((org-plain-list-ordered-item-terminator t))
  1119. (org-test-parse-and-interpret "1. [@5] Item"))
  1120. "5. [@5] Item\n"))
  1121. ;; 5. List with check-boxes.
  1122. (should
  1123. (equal (org-test-parse-and-interpret
  1124. "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
  1125. "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n")))
  1126. (ert-deftest test-org-element/quote-block-interpreter ()
  1127. "Test quote block interpreter."
  1128. (should (equal (org-test-parse-and-interpret
  1129. "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
  1130. "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
  1131. (ert-deftest test-org-element/special-block-interpreter ()
  1132. "Test special block interpreter."
  1133. (should (equal (org-test-parse-and-interpret
  1134. "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
  1135. "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
  1136. (ert-deftest test-org-element/babel-call-interpreter ()
  1137. "Test babel call interpreter."
  1138. ;; 1. Without argument.
  1139. (should (equal (org-test-parse-and-interpret "#+CALL: test()")
  1140. "#+CALL: test()\n"))
  1141. ;; 2. With argument.
  1142. (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
  1143. "#+CALL: test(x=2)\n"))
  1144. ;; 3. With header arguments.
  1145. (should (equal (org-test-parse-and-interpret
  1146. "#+CALL: test[:results output]()[:results html]")
  1147. "#+CALL: test[:results output]()[:results html]\n")))
  1148. (ert-deftest test-org-element/clock-interpreter ()
  1149. "Test clock interpreter."
  1150. ;; Running clock.
  1151. (should
  1152. (equal (let ((org-clock-string "CLOCK:"))
  1153. (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]"))
  1154. "CLOCK: [2012-01-01 sun. 00:01]\n"))
  1155. ;; Closed clock.
  1156. (should
  1157. (equal
  1158. (let ((org-clock-string "CLOCK:"))
  1159. (org-test-parse-and-interpret "
  1160. CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))
  1161. "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01\n")))
  1162. (ert-deftest test-org-element/comment-interpreter ()
  1163. "Test comment interpreter."
  1164. ;; Regular comment.
  1165. (should (equal (org-test-parse-and-interpret "#Comment") "#+ Comment\n"))
  1166. ;; Inline comment.
  1167. (should (equal (org-test-parse-and-interpret " #+ Comment")
  1168. "#+ Comment\n"))
  1169. ;; Preserve indentation.
  1170. (should (equal (org-test-parse-and-interpret " #+ No blank\n#+ One blank")
  1171. "#+ No blank\n#+ One blank\n")))
  1172. (ert-deftest test-org-element/comment-block-interpreter ()
  1173. "Test comment block interpreter."
  1174. (should (equal (org-test-parse-and-interpret
  1175. "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
  1176. "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n")))
  1177. (ert-deftest test-org-element/example-block-interpreter ()
  1178. "Test example block interpreter."
  1179. ;; Without switches.
  1180. (should (equal (org-test-parse-and-interpret
  1181. "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
  1182. "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
  1183. ;; With switches.
  1184. (should
  1185. (equal (org-test-parse-and-interpret
  1186. "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
  1187. "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n")))
  1188. (ert-deftest test-org-element/export-block-interpreter ()
  1189. "Test export block interpreter."
  1190. (should (equal (org-test-parse-and-interpret
  1191. "#+BEGIN_HTML\nTest\n#+END_HTML")
  1192. "#+BEGIN_HTML\nTest\n#+END_HTML\n")))
  1193. (ert-deftest test-org-element/fixed-width-interpreter ()
  1194. "Test fixed width interpreter."
  1195. ;; Standard test.
  1196. (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
  1197. ;; Preserve indentation.
  1198. (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
  1199. ": 2 blanks\n: 1 blank\n")))
  1200. (ert-deftest test-org-element/horizontal-rule-interpreter ()
  1201. "Test horizontal rule interpreter."
  1202. (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
  1203. (ert-deftest test-org-element/keyword-interpreter ()
  1204. "Test keyword interpreter."
  1205. (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
  1206. "#+KEYWORD: value\n")))
  1207. (ert-deftest test-org-element/latex-environment-interpreter ()
  1208. "Test latex environment interpreter."
  1209. (should (equal (org-test-parse-and-interpret
  1210. "\\begin{equation}\n1+1=2\n\\end{equation}")
  1211. "\\begin{equation}\n1+1=2\n\\end{equation}\n")))
  1212. (ert-deftest test-org-element/planning-interpreter ()
  1213. "Test planning interpreter."
  1214. (let ((org-closed-string "CLOSED:")
  1215. (org-deadline-string "DEADLINE:")
  1216. (org-scheduled-string "SCHEDULED:"))
  1217. (should
  1218. (equal
  1219. (org-test-parse-and-interpret
  1220. "* Headline
  1221. CLOSED: <2012-01-01> DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01>")
  1222. "* Headline
  1223. CLOSED: <2012-01-01> DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01>\n"))))
  1224. (ert-deftest test-org-element/property-drawer-interpreter ()
  1225. "Test property drawer interpreter."
  1226. (should (equal (let ((org-property-format "%-10s %s"))
  1227. (org-test-parse-and-interpret
  1228. ":PROPERTIES:\n:prop: value\n:END:"))
  1229. ":PROPERTIES:\n:prop: value\n:END:\n")))
  1230. (ert-deftest test-org-element/src-block-interpreter ()
  1231. "Test src block interpreter."
  1232. ;; With arguments.
  1233. (should
  1234. (equal (org-test-parse-and-interpret
  1235. "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC")
  1236. "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC\n"))
  1237. ;; With switches.
  1238. (should
  1239. (equal (org-test-parse-and-interpret
  1240. "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC")
  1241. "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC\n")))
  1242. (ert-deftest test-org-element/table-interpreter ()
  1243. "Test table, table-row and table-cell interpreters."
  1244. ;; 1. Simple table.
  1245. (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
  1246. "| a | b |\n| c | d |\n"))
  1247. ;; 2. Table with horizontal rules.
  1248. (should (equal (org-test-parse-and-interpret
  1249. "| a | b |\n|---+---|\n| c | d |")
  1250. "| a | b |\n|---+---|\n| c | d |\n"))
  1251. ;; 3. Table with meta-data.
  1252. (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
  1253. "| / | < | > |\n| * | 1 | 2 |\n")))
  1254. (ert-deftest test-org-element/verse-block-interpreter ()
  1255. "Test verse block interpretation."
  1256. (should
  1257. (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
  1258. "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
  1259. (ert-deftest test-org-element/bold-interpreter ()
  1260. "Test bold interpreter."
  1261. (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
  1262. (ert-deftest test-org-element/code-interpreter ()
  1263. "Test code interpreter."
  1264. (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
  1265. (ert-deftest test-org-element/entity-interpreter ()
  1266. "Test entity interpreter."
  1267. ;; 1. Without brackets.
  1268. (should
  1269. (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
  1270. ;; 2. With brackets.
  1271. (should
  1272. (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
  1273. (ert-deftest test-org-element/export-snippet-interpreter ()
  1274. "Test export snippet interpreter."
  1275. (should (equal (org-test-parse-and-interpret "<back-end@contents>")
  1276. "<back-end@contents>\n")))
  1277. (ert-deftest test-org-element/footnote-reference-interpreter ()
  1278. "Test footnote reference interpreter."
  1279. ;; 1. Regular reference.
  1280. (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
  1281. ;; 2. Normalized reference.
  1282. (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
  1283. ;; 3. Named reference.
  1284. (should (equal (org-test-parse-and-interpret "Text[fn:label]")
  1285. "Text[fn:label]\n"))
  1286. ;; 4. Inline reference.
  1287. (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
  1288. "Text[fn:label:def]\n"))
  1289. ;; 5. Anonymous reference.
  1290. (should (equal (org-test-parse-and-interpret "Text[fn::def]")
  1291. "Text[fn::def]\n")))
  1292. (ert-deftest test-org-element/inline-babel-call-interpreter ()
  1293. "Test inline babel call interpreter."
  1294. ;; 1. Without arguments.
  1295. (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
  1296. ;; 2. With arguments.
  1297. (should (equal (org-test-parse-and-interpret "call_test(x=2)")
  1298. "call_test(x=2)\n"))
  1299. ;; 3. With header arguments.
  1300. (should (equal (org-test-parse-and-interpret
  1301. "call_test[:results output]()[:results html]")
  1302. "call_test[:results output]()[:results html]\n")))
  1303. (ert-deftest test-org-element/inline-src-block-interpreter ()
  1304. "Test inline src block interpreter."
  1305. ;; 1. Without header argument.
  1306. (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
  1307. "src_emacs-lisp{(+ 1 1)}\n"))
  1308. ;; 2. With header arguments.
  1309. (should (equal (org-test-parse-and-interpret
  1310. "src_emacs-lisp[:results silent]{(+ 1 1)}")
  1311. "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
  1312. (ert-deftest test-org-element/italic-interpreter ()
  1313. "Test italic interpreter."
  1314. (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
  1315. (ert-deftest test-org-element/latex-fragment-interpreter ()
  1316. "Test latex fragment interpreter."
  1317. (let ((org-latex-regexps
  1318. '(("begin" "^[ ]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^�]+?\\\\end{\\2}\\)" 1 t)
  1319. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \n,;.$]\\$\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  1320. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \n,;.$][^$\n ]*?\\(\n[^$\n ]*?\\)\\{0,2\\}[^ \n,.$]\\)\\$\\)\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  1321. ("\\(" "\\\\([^�]*?\\\\)" 0 nil)
  1322. ("\\[" "\\\\\\[[^�]*?\\\\\\]" 0 nil)
  1323. ("$$" "\\$\\$[^�]*?\\$\\$" 0 nil))))
  1324. (should (equal (org-test-parse-and-interpret "\\command{}")
  1325. "\\command{}\n"))
  1326. (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
  1327. (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
  1328. (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
  1329. (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
  1330. (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n"))))
  1331. (ert-deftest test-org-element/line-break-interpreter ()
  1332. "Test line break interpreter."
  1333. (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
  1334. "First line \\\\\nSecond line\n")))
  1335. (ert-deftest test-org-element/link-interpreter ()
  1336. "Test link interpreter."
  1337. ;; 1. Links targeted from a radio target.
  1338. (should (equal (let ((org-target-link-regexp "radio-target"))
  1339. (org-test-parse-and-interpret "a radio-target"))
  1340. "a radio-target\n"))
  1341. ;; 2. Regular links.
  1342. ;;
  1343. ;; 2.1. Without description.
  1344. (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
  1345. "[[http://orgmode.org]]\n"))
  1346. ;; 2.2. With a description.
  1347. (should (equal (org-test-parse-and-interpret
  1348. "[[http://orgmode.org][Org mode]]")
  1349. "[[http://orgmode.org][Org mode]]\n"))
  1350. ;; 2.3. Id links.
  1351. (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
  1352. ;; 2.4. Custom-id links.
  1353. (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
  1354. ;; 2.5 Code-ref links.
  1355. (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
  1356. ;; 3. Normalize plain links.
  1357. (should (equal (org-test-parse-and-interpret "http://orgmode.org")
  1358. "[[http://orgmode.org]]\n"))
  1359. ;; 4. Normalize angular links.
  1360. (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
  1361. "[[http://orgmode.org]]\n")))
  1362. (ert-deftest test-org-element/macro-interpreter ()
  1363. "Test macro interpreter."
  1364. ;; 1. Without argument.
  1365. (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
  1366. ;; 2. With arguments.
  1367. (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
  1368. "{{{test(arg1,arg2)}}}\n")))
  1369. (ert-deftest test-org-element/radio-target-interpreter ()
  1370. "Test radio target interpreter."
  1371. (should (equal (org-test-parse-and-interpret "<<<some text>>>")
  1372. "<<<some text>>>\n")))
  1373. (ert-deftest test-org-element/statistics-cookie-interpreter ()
  1374. "Test statistics cookie interpreter."
  1375. ;; 1. Without percent
  1376. (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
  1377. ;; 2. With percent.
  1378. (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
  1379. (ert-deftest test-org-element/strike-through-interpreter ()
  1380. "Test strike through interpreter."
  1381. (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
  1382. (ert-deftest test-org-element/subscript-interpreter ()
  1383. "Test subscript interpreter."
  1384. ;; 1. Without brackets.
  1385. (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
  1386. ;; 2. With brackets.
  1387. (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
  1388. (ert-deftest test-org-element/superscript-interpreter ()
  1389. "Test superscript interpreter."
  1390. ;; 1. Without brackets.
  1391. (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
  1392. ;; 2. With brackets.
  1393. (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
  1394. (ert-deftest test-org-element/target-interpreter ()
  1395. "Test target interpreter."
  1396. (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
  1397. (ert-deftest test-org-element/underline-interpreter ()
  1398. "Test underline interpreter."
  1399. (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
  1400. (ert-deftest test-org-element/verbatim-interpreter ()
  1401. "Test verbatim interpreter."
  1402. (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
  1403. ;;; Test Granularity
  1404. (ert-deftest test-org-element/granularity ()
  1405. "Test granularity impact on buffer parsing."
  1406. (org-test-with-temp-text "
  1407. * Head 1
  1408. ** Head 2
  1409. #+BEGIN_CENTER
  1410. Centered paragraph.
  1411. #+END_CENTER
  1412. Paragraph \\alpha."
  1413. ;; 1.1. Granularity set to `headline' should parse every headline
  1414. ;; in buffer, and only them.
  1415. (let ((tree (org-element-parse-buffer 'headline)))
  1416. (should (= 2 (length (org-element-map tree 'headline 'identity))))
  1417. (should-not (org-element-map tree 'paragraph 'identity)))
  1418. ;; 1.2. Granularity set to `greater-element' should not enter
  1419. ;; greater elements excepted headlines and sections.
  1420. (let ((tree (org-element-parse-buffer 'greater-element)))
  1421. (should (= 1 (length (org-element-map tree 'center-block 'identity))))
  1422. (should (= 1 (length (org-element-map tree 'paragraph 'identity))))
  1423. (should-not (org-element-map tree 'entity 'identity)))
  1424. ;; 1.3. Granularity set to `element' should enter every
  1425. ;; greater-element.
  1426. (let ((tree (org-element-parse-buffer 'element)))
  1427. (should (= 2 (length (org-element-map tree 'paragraph 'identity))))
  1428. (should-not (org-element-map tree 'entity 'identity)))
  1429. ;; 1.4. Granularity set to `object' can see everything.
  1430. (let ((tree (org-element-parse-buffer 'object)))
  1431. (should (= 1 (length (org-element-map tree 'entity 'identity)))))))
  1432. (ert-deftest test-org-element/secondary-string-parsing ()
  1433. "Test if granularity correctly toggles secondary strings parsing."
  1434. ;; 1. With a granularity bigger than `object', no secondary string
  1435. ;; should be parsed.
  1436. ;;
  1437. ;; 1.1. Test with `headline' type.
  1438. (org-test-with-temp-text "* Headline"
  1439. (let ((headline
  1440. (org-element-map (org-element-parse-buffer 'headline) 'headline
  1441. 'identity
  1442. nil
  1443. 'first-match)))
  1444. (should (stringp (org-element-property :title headline)))))
  1445. ;; 1.2. Test with `item' type.
  1446. (org-test-with-temp-text "* Headline\n- tag :: item"
  1447. (let ((item (org-element-map (org-element-parse-buffer 'element)
  1448. 'item
  1449. 'identity
  1450. nil
  1451. 'first-match)))
  1452. (should (stringp (org-element-property :tag item)))))
  1453. ;; 1.3. Test with `inlinetask' type, if avalaible.
  1454. (when (featurep 'org-inlinetask)
  1455. (let ((org-inlinetask-min-level 15))
  1456. (org-test-with-temp-text "*************** Inlinetask"
  1457. (let ((inlinetask (org-element-map (org-element-parse-buffer 'element)
  1458. 'inlinetask
  1459. 'identity
  1460. nil
  1461. 'first-match)))
  1462. (should (stringp (org-element-property :title inlinetask)))))))
  1463. ;; 2. With a default granularity, secondary strings should be
  1464. ;; parsed.
  1465. (org-test-with-temp-text "* Headline"
  1466. (let ((headline
  1467. (org-element-map (org-element-parse-buffer) 'headline
  1468. 'identity
  1469. nil
  1470. 'first-match)))
  1471. (should (listp (org-element-property :title headline)))))
  1472. ;; 3. `org-element-at-point' should never parse a secondary string.
  1473. (org-test-with-temp-text "* Headline"
  1474. (should (stringp (org-element-property :title (org-element-at-point))))))
  1475. ;;; Test Normalize Contents
  1476. (ert-deftest test-org-element/normalize-contents ()
  1477. "Test `org-element-normalize-contents' specifications."
  1478. ;; 1. Remove maximum common indentation from element's contents.
  1479. (should
  1480. (equal
  1481. (org-element-normalize-contents
  1482. '(paragraph nil " Two spaces\n Three spaces"))
  1483. '(paragraph nil "Two spaces\n Three spaces")))
  1484. ;; 2. Ignore objects within contents when computing maximum common
  1485. ;; indentation.
  1486. (should
  1487. (equal
  1488. (org-element-normalize-contents
  1489. '(paragraph nil " One " (emphasis nil "space") "\n Two spaces"))
  1490. '(paragraph nil "One " (emphasis nil "space") "\n Two spaces")))
  1491. ;; 3. Ignore blank lines.
  1492. (should
  1493. (equal
  1494. (org-element-normalize-contents
  1495. '(paragraph nil " Two spaces\n\n \n Two spaces"))
  1496. '(paragraph nil "Two spaces\n\n \nTwo spaces")))
  1497. ;; 4. Recursively enter objects in order to compute common
  1498. ;; indentation.
  1499. (should
  1500. (equal
  1501. (org-element-normalize-contents
  1502. '(paragraph nil " Two spaces " (bold nil " and\n One space")))
  1503. '(paragraph nil " Two spaces " (bold nil " and\nOne space"))))
  1504. ;; 5. When optional argument is provided, ignore first line
  1505. ;; indentation.
  1506. (should
  1507. (equal
  1508. (org-element-normalize-contents
  1509. '(paragraph nil "No space\n Two spaces\n Three spaces") t)
  1510. '(paragraph nil "No space\nTwo spaces\n Three spaces"))))
  1511. ;;; Test Navigation Tools.
  1512. (ert-deftest test-org-element/forward-element ()
  1513. "Test `org-element-forward' specifications."
  1514. ;; 1. At EOB: should error.
  1515. (org-test-with-temp-text "Some text\n"
  1516. (goto-char (point-max))
  1517. (should-error (org-element-forward)))
  1518. ;; 2. Standard move: expected to ignore blank lines.
  1519. (org-test-with-temp-text "First paragraph.\n\n\nSecond paragraph."
  1520. (org-element-forward)
  1521. (should (looking-at "Second paragraph.")))
  1522. ;; 3. Headline tests.
  1523. (org-test-with-temp-text "
  1524. * Head 1
  1525. ** Head 1.1
  1526. *** Head 1.1.1
  1527. ** Head 1.2"
  1528. ;; 3.1. At an headline beginning: move to next headline at the
  1529. ;; same level.
  1530. (goto-line 3)
  1531. (org-element-forward)
  1532. (should (looking-at "** Head 1.2"))
  1533. ;; 3.2. At an headline beginning: move to parent headline if no
  1534. ;; headline at the same level.
  1535. (goto-line 3)
  1536. (org-element-forward)
  1537. (should (looking-at "** Head 1.2")))
  1538. ;; 4. Greater element tests.
  1539. (org-test-with-temp-text
  1540. "#+BEGIN_CENTER\nInside.\n#+END_CENTER\n\nOutside."
  1541. ;; 4.1. At a greater element: expected to skip contents.
  1542. (org-element-forward)
  1543. (should (looking-at "Outside."))
  1544. ;; 4.2. At the end of greater element contents: expected to skip
  1545. ;; to the end of the greater element.
  1546. (goto-line 2)
  1547. (org-element-forward)
  1548. (should (looking-at "Outside.")))
  1549. ;; 5. List tests.
  1550. (org-test-with-temp-text "
  1551. - item1
  1552. - sub1
  1553. - sub2
  1554. - sub3
  1555. Inner paragraph.
  1556. - item2
  1557. Outside."
  1558. ;; 5.1. At list top point: expected to move to the element after
  1559. ;; the list.
  1560. (goto-line 2)
  1561. (org-element-forward)
  1562. (should (looking-at "Outside."))
  1563. ;; 5.2. Special case: at the first line of a sub-list, but not at
  1564. ;; beginning of line, move to next item.
  1565. (goto-line 2)
  1566. (forward-char)
  1567. (org-element-forward)
  1568. (should (looking-at "- item2"))
  1569. (goto-line 4)
  1570. (forward-char)
  1571. (org-element-forward)
  1572. (should (looking-at " - sub2"))
  1573. ;; 5.3 At sub-list beginning: expected to move after the sub-list.
  1574. (goto-line 4)
  1575. (org-element-forward)
  1576. (should (looking-at " Inner paragraph."))
  1577. ;; 5.4. At sub-list end: expected to move outside the sub-list.
  1578. (goto-line 8)
  1579. (org-element-forward)
  1580. (should (looking-at " Inner paragraph."))
  1581. ;; 5.5. At an item: expected to move to next item, if any.
  1582. (goto-line 6)
  1583. (org-element-forward)
  1584. (should (looking-at " - sub3"))))
  1585. (ert-deftest test-org-element/backward-element ()
  1586. "Test `org-element-backward' specifications."
  1587. ;; 1. At BOB (modulo some white spaces): should error.
  1588. (org-test-with-temp-text " \nParagraph."
  1589. (org-skip-whitespace)
  1590. (should-error (org-element-backward)))
  1591. ;; 2. Not at the beginning of an element: move at its beginning.
  1592. (org-test-with-temp-text "Paragraph1.\n\nParagraph2."
  1593. (goto-line 3)
  1594. (end-of-line)
  1595. (org-element-backward)
  1596. (should (looking-at "Paragraph2.")))
  1597. ;; 3. Headline tests.
  1598. (org-test-with-temp-text "
  1599. * Head 1
  1600. ** Head 1.1
  1601. *** Head 1.1.1
  1602. ** Head 1.2"
  1603. ;; 3.1. At an headline beginning: move to previous headline at the
  1604. ;; same level.
  1605. (goto-line 5)
  1606. (org-element-backward)
  1607. (should (looking-at "** Head 1.1"))
  1608. ;; 3.2. At an headline beginning: move to parent headline if no
  1609. ;; headline at the same level.
  1610. (goto-line 3)
  1611. (org-element-backward)
  1612. (should (looking-at "* Head 1"))
  1613. ;; 3.3. At the first top-level headline: should error.
  1614. (goto-line 2)
  1615. (should-error (org-element-backward)))
  1616. ;; 4. At beginning of first element inside a greater element:
  1617. ;; expected to move to greater element's beginning.
  1618. (org-test-with-temp-text "Before.\n#+BEGIN_CENTER\nInside.\n#+END_CENTER."
  1619. (goto-line 3)
  1620. (org-element-backward)
  1621. (should (looking-at "#\\+BEGIN_CENTER")))
  1622. ;; 5. List tests.
  1623. (org-test-with-temp-text "
  1624. - item1
  1625. - sub1
  1626. - sub2
  1627. - sub3
  1628. Inner paragraph.
  1629. - item2
  1630. Outside."
  1631. ;; 5.1. At beginning of sub-list: expected to move to the
  1632. ;; paragraph before it.
  1633. (goto-line 4)
  1634. (org-element-backward)
  1635. (should (looking-at "item1"))
  1636. ;; 5.2. At an item in a list: expected to move at previous item.
  1637. (goto-line 8)
  1638. (org-element-backward)
  1639. (should (looking-at " - sub2"))
  1640. (goto-line 12)
  1641. (org-element-backward)
  1642. (should (looking-at "- item1"))
  1643. ;; 5.3. At end of list/sub-list: expected to move to list/sub-list
  1644. ;; beginning.
  1645. (goto-line 10)
  1646. (org-element-backward)
  1647. (should (looking-at " - sub1"))
  1648. (goto-line 15)
  1649. (org-element-backward)
  1650. (should (looking-at "- item1"))
  1651. ;; 5.4. At blank-lines before list end: expected to move to top
  1652. ;; item.
  1653. (goto-line 14)
  1654. (org-element-backward)
  1655. (should (looking-at "- item1"))))
  1656. (ert-deftest test-org-element/up-element ()
  1657. "Test `org-element-up' specifications."
  1658. ;; 1. At BOB or with no surrounding element: should error.
  1659. (org-test-with-temp-text "Paragraph."
  1660. (should-error (org-element-up)))
  1661. (org-test-with-temp-text "* Head1\n* Head2"
  1662. (goto-line 2)
  1663. (should-error (org-element-up)))
  1664. (org-test-with-temp-text "Paragraph1.\n\nParagraph2."
  1665. (goto-line 3)
  1666. (should-error (org-element-up)))
  1667. ;; 2. At an headline: move to parent headline.
  1668. (org-test-with-temp-text "* Head1\n** Sub-Head1\n** Sub-Head2"
  1669. (goto-line 3)
  1670. (org-element-up)
  1671. (should (looking-at "\\* Head1")))
  1672. ;; 3. Inside a greater element: move to greater element beginning.
  1673. (org-test-with-temp-text
  1674. "Before.\n#+BEGIN_CENTER\nParagraph1\nParagraph2\n#+END_CENTER\n"
  1675. (goto-line 3)
  1676. (org-element-up)
  1677. (should (looking-at "#\\+BEGIN_CENTER")))
  1678. ;; 4. List tests.
  1679. (org-test-with-temp-text "* Top
  1680. - item1
  1681. - sub1
  1682. - sub2
  1683. Paragraph within sub2.
  1684. - item2"
  1685. ;; 4.1. Within an item: move to the item beginning.
  1686. (goto-line 8)
  1687. (org-element-up)
  1688. (should (looking-at " - sub2"))
  1689. ;; 4.2. At an item in a sub-list: move to parent item.
  1690. (goto-line 4)
  1691. (org-element-up)
  1692. (should (looking-at "- item1"))
  1693. ;; 4.3. At an item in top list: move to beginning of whole list.
  1694. (goto-line 10)
  1695. (org-element-up)
  1696. (should (looking-at "- item1"))
  1697. ;; 4.4. Special case. At very top point: should move to parent of
  1698. ;; list.
  1699. (goto-line 2)
  1700. (org-element-up)
  1701. (should (looking-at "\\* Top"))))
  1702. (ert-deftest test-org-element/down-element ()
  1703. "Test `org-element-down' specifications."
  1704. ;; 1. Error when the element hasn't got a recursive type.
  1705. (org-test-with-temp-text "Paragraph."
  1706. (should-error (org-element-down)))
  1707. ;; 2. When at a plain-list, move to first item.
  1708. (org-test-with-temp-text "- Item 1\n - Item 1.1\n - Item 2.2"
  1709. (goto-line 2)
  1710. (org-element-down)
  1711. (should (looking-at " - Item 1.1")))
  1712. (org-test-with-temp-text "#+NAME: list\n- Item 1"
  1713. (org-element-down)
  1714. (should (looking-at " Item 1")))
  1715. ;; 3. When at a table, move to first row
  1716. (org-test-with-temp-text "#+NAME: table\n| a | b |"
  1717. (org-element-down)
  1718. (should (looking-at " a | b |")))
  1719. ;; 4. Otherwise, move inside the greater element.
  1720. (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph.\n#+END_CENTER"
  1721. (org-element-down)
  1722. (should (looking-at "Paragraph"))))
  1723. (ert-deftest test-org-element/drag-backward ()
  1724. "Test `org-element-drag-backward' specifications."
  1725. ;; 1. Error when trying to move first element of buffer.
  1726. (org-test-with-temp-text "Paragraph 1.\n\nParagraph 2."
  1727. (should-error (org-element-drag-backward)))
  1728. ;; 2. Error when trying to swap nested elements.
  1729. (org-test-with-temp-text "#+BEGIN_CENTER\nTest.\n#+END_CENTER"
  1730. (forward-line)
  1731. (should-error (org-element-drag-backward)))
  1732. ;; 3. Error when trying to swap an headline element and
  1733. ;; a non-headline element.
  1734. (org-test-with-temp-text "Test.\n* Head 1"
  1735. (forward-line)
  1736. (should-error (org-element-drag-backward)))
  1737. ;; 4. Otherwise, swap elements, preserving column and blank lines
  1738. ;; between elements.
  1739. (org-test-with-temp-text "Para1\n\n\nParagraph 2\n\nPara3"
  1740. (search-forward "graph")
  1741. (org-element-drag-backward)
  1742. (should (equal (buffer-string) "Paragraph 2\n\n\nPara1\n\nPara3"))
  1743. (should (looking-at " 2"))))
  1744. (ert-deftest test-org-element/drag-forward ()
  1745. "Test `org-element-drag-forward' specifications."
  1746. ;; 1. Error when trying to move first element of buffer.
  1747. (org-test-with-temp-text "Paragraph 1.\n\nParagraph 2."
  1748. (goto-line 3)
  1749. (should-error (org-element-drag-forward)))
  1750. ;; 2. Error when trying to swap nested elements.
  1751. (org-test-with-temp-text "#+BEGIN_CENTER\nTest.\n#+END_CENTER"
  1752. (forward-line)
  1753. (should-error (org-element-drag-forward)))
  1754. ;; 3. Error when trying to swap a non-headline element and an
  1755. ;; headline.
  1756. (org-test-with-temp-text "Test.\n* Head 1"
  1757. (should-error (org-element-drag-forward)))
  1758. ;; 4. Otherwise, swap elements, preserving column and blank lines
  1759. ;; between elements.
  1760. (org-test-with-temp-text "Paragraph 1\n\n\nPara2\n\nPara3"
  1761. (search-forward "graph")
  1762. (org-element-drag-forward)
  1763. (should (equal (buffer-string) "Para2\n\n\nParagraph 1\n\nPara3"))
  1764. (should (looking-at " 1"))))
  1765. (provide 'test-org-element)
  1766. ;;; test-org-element.el ends here