test-org-element.el 69 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969
  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. ;; Footnote with more contents
  467. (should
  468. (= 28
  469. (org-element-property
  470. :end
  471. (org-test-with-temp-text "[fn:1] Definition\n| a | b |"
  472. (org-element-map
  473. (org-element-parse-buffer)
  474. 'footnote-definition 'identity nil t))))))
  475. ;;;; Footnotes Reference
  476. (ert-deftest test-org-element/footnote-reference-parser ()
  477. "Test `footnote-reference' parser."
  478. ;; 1. Parse a standard reference.
  479. (org-test-with-temp-text "[fn:label]"
  480. (should (equal (org-element-footnote-reference-parser)
  481. '(footnote-reference
  482. (:label "fn:label" :type standard :inline-definition nil
  483. :begin 1 :end 11 :post-blank 0)))))
  484. ;; 2. Parse a normalized reference.
  485. (org-test-with-temp-text "[1]"
  486. (should (equal (org-element-footnote-reference-parser)
  487. '(footnote-reference
  488. (:label "1" :type standard :inline-definition nil
  489. :begin 1 :end 4 :post-blank 0)))))
  490. ;; 3. Parse an inline reference.
  491. (org-test-with-temp-text "[fn:test:def]"
  492. (should (equal (org-element-footnote-reference-parser)
  493. '(footnote-reference
  494. (:label "fn:test" :type inline :inline-definition ("def")
  495. :begin 1 :end 14 :post-blank 0)))))
  496. ;; 4. Parse an anonymous reference.
  497. (org-test-with-temp-text "[fn::def]"
  498. (should (equal (org-element-footnote-reference-parser)
  499. '(footnote-reference
  500. (:label nil :type inline :inline-definition ("def")
  501. :begin 1 :end 10 :post-blank 0)))))
  502. ;; 5. Parse nested footnotes.
  503. (org-test-with-temp-text "[fn::def [fn:label]]"
  504. (should
  505. (equal
  506. (org-element-footnote-reference-parser)
  507. '(footnote-reference
  508. (:label nil :type inline
  509. :inline-definition
  510. ("def "
  511. (footnote-reference
  512. (:label "fn:label" :type standard :inline-definition nil
  513. :begin 5 :end 15 :post-blank 0)))
  514. :begin 1 :end 21 :post-blank 0)))))
  515. ;; 6. Parse adjacent footnotes.
  516. (org-test-with-temp-text "[fn:label1][fn:label2]"
  517. (should
  518. (equal
  519. (org-element-footnote-reference-parser)
  520. '(footnote-reference
  521. (:label "fn:label1" :type standard :inline-definition nil :begin 1
  522. :end 12 :post-blank 0)))))
  523. ;; 7. Only properly closed footnotes are recognized as such.
  524. (org-test-with-temp-text "Text [fn:label"
  525. (should-not
  526. (org-element-map
  527. (org-element-parse-buffer) 'footnote-reference 'identity))))
  528. ;;;; Headlines
  529. (ert-deftest test-org-element/headline-quote-keyword ()
  530. "Test QUOTE keyword recognition."
  531. ;; Reference test.
  532. (org-test-with-temp-text "* Headline"
  533. (let ((org-quote-string "QUOTE"))
  534. (should-not (org-element-property :quotedp (org-element-at-point)))))
  535. ;; Standard position.
  536. (org-test-with-temp-text "* QUOTE Headline"
  537. (let ((org-quote-string "QUOTE"))
  538. (let ((headline (org-element-at-point)))
  539. (should (org-element-property :quotedp headline))
  540. ;; Test removal from raw value.
  541. (should (equal (org-element-property :raw-value headline) "Headline"))))
  542. ;; Case sensitivity.
  543. (let ((org-quote-string "Quote"))
  544. (should-not (org-element-property :quotedp (org-element-at-point)))))
  545. ;; With another keyword.
  546. (org-test-with-temp-text "* TODO QUOTE Headline"
  547. (let ((org-quote-string "QUOTE")
  548. (org-todo-keywords '((sequence "TODO" "DONE"))))
  549. (should (org-element-property :quotedp (org-element-at-point))))))
  550. (ert-deftest test-org-element/headline-comment-keyword ()
  551. "Test COMMENT keyword recognition."
  552. ;; Reference test.
  553. (org-test-with-temp-text "* Headline"
  554. (let ((org-comment-string "COMMENT"))
  555. (should-not (org-element-property :commentedp (org-element-at-point)))))
  556. ;; Standard position.
  557. (org-test-with-temp-text "* COMMENT Headline"
  558. (let ((org-comment-string "COMMENT"))
  559. (let ((headline (org-element-at-point)))
  560. (should (org-element-property :commentedp headline))
  561. ;; Test removal from raw value.
  562. (should (equal (org-element-property :raw-value headline) "Headline"))))
  563. ;; Case sensitivity.
  564. (let ((org-comment-string "Comment"))
  565. (should-not (org-element-property :commentedp (org-element-at-point)))))
  566. ;; With another keyword.
  567. (org-test-with-temp-text "* TODO COMMENT Headline"
  568. (let ((org-comment-string "COMMENT")
  569. (org-todo-keywords '((sequence "TODO" "DONE"))))
  570. (should (org-element-property :commentedp (org-element-at-point))))))
  571. (ert-deftest test-org-element/headline-archive-tag ()
  572. "Test ARCHIVE tag recognition."
  573. ;; Reference test.
  574. (org-test-with-temp-text "* Headline"
  575. (let ((org-archive-tag "ARCHIVE"))
  576. (should-not (org-element-property :archivedp (org-element-at-point)))))
  577. ;; Single tag.
  578. (org-test-with-temp-text "* Headline :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-not (org-element-property :tags headline))))
  584. (let ((org-archive-tag "Archive"))
  585. (should-not (org-element-property :archivedp (org-element-at-point)))))
  586. ;; Multiple tags.
  587. (org-test-with-temp-text "* Headline :test:ARCHIVE:"
  588. (let ((org-archive-tag "ARCHIVE"))
  589. (let ((headline (org-element-at-point)))
  590. (should (org-element-property :archivedp headline))
  591. ;; Test tag removal.
  592. (should (equal (org-element-property :tags headline) '("test")))))))
  593. ;;;; Inlinetask.
  594. (ert-deftest test-org-element/inlinetask-parser ()
  595. "Test `inlinetask' parser."
  596. (when (featurep 'org-inlinetask)
  597. (let ((org-inlinetask-min-level 15))
  598. ;; 1. Regular inlinetask.
  599. (should
  600. (equal
  601. (org-test-with-temp-text
  602. "*************** Task\nTest\n*************** END"
  603. (org-element-map
  604. (org-element-parse-buffer) 'inlinetask 'identity nil t))
  605. '(inlinetask
  606. (:title ("Task") :begin 1 :end 46 :hiddenp nil :contents-begin 22
  607. :contents-end 27 :level 15 :priority nil :tags nil
  608. :todo-keyword nil :todo-type nil :scheduled nil :deadline nil
  609. :timestamp nil :clock nil :post-blank 0 :category "???")
  610. (paragraph
  611. (:begin 22 :end 27 :contents-begin 22 :contents-end 26 :post-blank 0)
  612. "Test"))))
  613. ;; 2. Degenerate inlinetask.
  614. (should
  615. (equal
  616. (org-test-with-temp-text
  617. "*************** Task"
  618. (org-element-map
  619. (org-element-parse-buffer) 'inlinetask 'identity nil t))
  620. '(inlinetask
  621. (:title ("Task") :begin 1 :end 21 :hiddenp nil :contents-begin 21
  622. :contents-end 21 :level 15 :priority nil :tags nil
  623. :todo-keyword nil :todo-type nil :scheduled nil :deadline nil
  624. :timestamp nil :clock nil :post-blank 0 :category nil))))
  625. ;; TODO keyword.
  626. (should
  627. (equal
  628. "TODO"
  629. (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  630. (org-test-with-temp-text "*************** TODO Task"
  631. (org-element-property
  632. :todo-keyword
  633. (org-element-map
  634. (org-element-parse-buffer) 'inlinetask 'identity nil t))))))
  635. ;; Planning info.
  636. (should
  637. (equal
  638. "2012-03-29 thu."
  639. (org-test-with-temp-text "
  640. *************** Task
  641. DEADLINE: <2012-03-29 thu.>"
  642. (org-element-property
  643. :deadline
  644. (org-element-map
  645. (org-element-parse-buffer) 'inlinetask 'identity nil t)))))
  646. ;; Priority.
  647. (should
  648. (equal
  649. ?A
  650. (org-test-with-temp-text "
  651. *************** [#A] Task"
  652. (org-element-property
  653. :priority
  654. (org-element-map
  655. (org-element-parse-buffer) 'inlinetask 'identity nil t)))))
  656. ;; Tags.
  657. (should
  658. (equal
  659. '("test")
  660. (org-test-with-temp-text "
  661. *************** Task :test:"
  662. (org-element-property
  663. :tags
  664. (org-element-map
  665. (org-element-parse-buffer) 'inlinetask 'identity nil t))))))))
  666. ;;;; Item.
  667. (ert-deftest test-org-element/item-parser ()
  668. "Test `item' parser."
  669. ;; Standard test.
  670. (should
  671. (equal
  672. (org-test-with-temp-text "- item"
  673. (org-element-map (org-element-parse-buffer) 'item 'identity nil t))
  674. '(item
  675. (:bullet "- " :begin 1 :end 7 :contents-begin 3 :contents-end 7
  676. :checkbox nil :counter nil :tag nil :hiddenp nil
  677. :structure ((1 0 "- " nil nil nil 7))
  678. :post-blank 0)
  679. (paragraph
  680. (:begin 3 :end 7 :contents-begin 3 :contents-end 7 :post-blank 0)
  681. "item"))))
  682. ;; Counter.
  683. (should
  684. (= 6
  685. (org-element-property
  686. :counter
  687. (org-test-with-temp-text "6. [@6] item"
  688. (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
  689. ;; Tag
  690. (should
  691. (equal
  692. '("tag")
  693. (org-element-property
  694. :tag
  695. (org-test-with-temp-text "- tag :: description"
  696. (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
  697. ;; Check-boxes
  698. (should
  699. (equal
  700. '(trans on off)
  701. (org-test-with-temp-text "
  702. - [-] item 1
  703. - [X] item 1.1
  704. - [ ] item 1.2"
  705. (org-element-map
  706. (org-element-parse-buffer) 'item
  707. (lambda (item) (org-element-property :checkbox item))))))
  708. ;; Folded state.
  709. (org-test-with-temp-text "* Headline
  710. - item
  711. paragraph below"
  712. (forward-line)
  713. (let ((org-cycle-include-plain-lists t)) (org-cycle))
  714. (should
  715. (org-element-property
  716. :hiddenp
  717. (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
  718. ;;;; Link
  719. (ert-deftest test-org-element/link-parser ()
  720. "Test `link' parser."
  721. ;; 1. Radio target.
  722. (should
  723. (equal (org-test-with-temp-text "A radio link"
  724. (org-element-map
  725. (let ((org-target-link-regexp "radio")) (org-element-parse-buffer))
  726. 'link 'identity nil t))
  727. '(link (:type "radio" :path "radio" :raw-link "radio" :begin 3 :end 9
  728. :contents-begin nil :contents-end nil :post-blank 1))))
  729. ;; 2. Standard link.
  730. ;;
  731. ;; 2.1. With description.
  732. (should
  733. (equal (org-test-with-temp-text "[[http://orgmode.org][Orgmode.org]]"
  734. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  735. '(link (:type "http" :path "//orgmode.org"
  736. :raw-link "http://orgmode.org" :begin 1 :end 36
  737. :contents-begin 23 :contents-end 34 :post-blank 0)
  738. "Orgmode.org")))
  739. ;; 2.2. Without description.
  740. (should
  741. (equal (org-test-with-temp-text "[[http://orgmode.org]]"
  742. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  743. '(link (:type "http" :path "//orgmode.org"
  744. :raw-link "http://orgmode.org" :begin 1 :end 23
  745. :contents-begin nil :contents-end nil :post-blank 0))))
  746. ;; 2.3. With expansion.
  747. (should
  748. (equal (org-test-with-temp-text "[[Org:worg]]"
  749. (let ((org-link-abbrev-alist '(("Org" . "http://orgmode.org/"))))
  750. (org-element-map
  751. (org-element-parse-buffer) 'link 'identity nil t)))
  752. '(link (:type "http" :path "//orgmode.org/worg" :raw-link "Org:worg"
  753. :begin 1 :end 13 :contents-begin nil :contents-end nil
  754. :post-blank 0))))
  755. ;; 2.4. With translation.
  756. (should
  757. (equal (org-test-with-temp-text "[[http://orgmode.org]]"
  758. (flet ((link-translate (type path) (cons type "127.0.0.1")))
  759. (let ((org-link-translation-function 'link-translate))
  760. (org-element-map
  761. (org-element-parse-buffer) 'link 'identity nil t))))
  762. '(link (:type "http" :path "127.0.0.1" :raw-link "http://orgmode.org"
  763. :begin 1 :end 23 :contents-begin nil :contents-end nil
  764. :post-blank 0))))
  765. ;; 2.5. Id link.
  766. (should
  767. (equal (org-test-with-temp-text "[[id:aaaa]]"
  768. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  769. '(link (:type "id" :path "aaaa" :raw-link "id:aaaa" :begin 1 :end 12
  770. :contents-begin nil :contents-end nil :post-blank 0))))
  771. ;; 2.6. Custom-id link.
  772. (should
  773. (equal (org-test-with-temp-text "[[#some-id]]"
  774. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  775. '(link (:type "custom-id" :path "some-id" :raw-link "#some-id"
  776. :begin 1 :end 13 :contents-begin nil :contents-end nil
  777. :post-blank 0))))
  778. ;; 2.7 Coderef link.
  779. (should
  780. (equal (org-test-with-temp-text "[[(reference)]]"
  781. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  782. '(link (:type "coderef" :path "reference" :raw-link "(reference)"
  783. :begin 1 :end 16 :contents-begin nil :contents-end nil
  784. :post-blank 0))))
  785. ;; 2.8 Fuzzy link.
  786. (should
  787. (equal (org-test-with-temp-text "[[target-or-title]]"
  788. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  789. '(link (:type "fuzzy" :path "target-or-title"
  790. :raw-link "target-or-title" :begin 1 :end 20
  791. :contents-begin nil :contents-end nil :post-blank 0))))
  792. ;; 3. Plain link.
  793. (should
  794. (equal (org-test-with-temp-text "A link: http://orgmode.org"
  795. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  796. '(link (:type "http" :path "//orgmode.org"
  797. :raw-link "http://orgmode.org" :begin 9 :end 27
  798. :contents-begin nil :contents-end nil :post-blank 0))))
  799. ;; 4. Angular link.
  800. (should
  801. (equal (org-test-with-temp-text "A link: <http://orgmode.org>"
  802. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  803. '(link (:type "http" :path "//orgmode.org"
  804. :raw-link "http://orgmode.org" :begin 9 :end 29
  805. :contents-begin nil :contents-end nil :post-blank 0)))))
  806. ;;;; Plain List.
  807. (ert-deftest test-org-element/plain-list-parser ()
  808. "Test `plain-list' parser."
  809. (should
  810. (equal
  811. (org-test-with-temp-text "- item"
  812. (org-element-map (org-element-parse-buffer) 'plain-list 'identity nil t))
  813. '(plain-list
  814. (:type unordered :begin 1 :end 7 :contents-begin 1 :contents-end 7
  815. :structure ((1 0 "- " nil nil nil 7)) :post-blank 0)
  816. (item
  817. (:bullet "- " :begin 1 :end 7 :contents-begin 3 :contents-end 7
  818. :checkbox nil :counter nil :tag nil :hiddenp nil
  819. :structure ((1 0 "- " nil nil nil 7)) :post-blank 0)
  820. (paragraph
  821. (:begin 3 :end 7 :contents-begin 3 :contents-end 7 :post-blank 0)
  822. "item")))))
  823. ;; Blank lines after the list only belong to outer plain list.
  824. (org-test-with-temp-text "
  825. - outer
  826. - inner
  827. Outside list"
  828. (let ((endings (org-element-map
  829. (org-element-parse-buffer) 'plain-list
  830. (lambda (pl) (org-element-property :end pl)))))
  831. ;; Move to ending of outer list.
  832. (goto-char (car endings))
  833. (should (looking-at "Outside list"))
  834. ;; Move to ending of inner list.
  835. (goto-char (nth 1 endings))
  836. (should (looking-at "^$")))))
  837. ;;;; Src Block.
  838. (ert-deftest test-org-element/src-block-parser ()
  839. "Test `src-block' parser."
  840. ;; Regular tests.
  841. (should
  842. (equal
  843. (org-test-with-temp-text "#+BEGIN_SRC\nText\n#+END_SRC"
  844. (org-element-map
  845. (org-element-parse-buffer) 'src-block 'identity nil t))
  846. '(src-block
  847. (:language nil :switches nil :parameters nil :begin 1 :end 27
  848. :number-lines nil :preserve-indent nil :retain-labels t
  849. :use-labels t :label-fmt nil :hiddenp nil :value "Text\n"
  850. :post-blank 0))))
  851. ;; Test folded block.
  852. (org-test-with-temp-text "#+BEGIN_SRC\nText\n#+END_SRC"
  853. (org-cycle)
  854. (should
  855. (org-element-property
  856. :hiddenp
  857. (org-element-map
  858. (org-element-parse-buffer) 'src-block 'identity nil t))))
  859. ;; Ignore incomplete block.
  860. (should-not
  861. (org-test-with-temp-text "#+BEGIN_SRC"
  862. (org-element-map
  863. (org-element-parse-buffer) 'src-block 'identity nil t))))
  864. ;;;; Quote Block
  865. (ert-deftest test-org-element/quote-block-parser ()
  866. "Test `quote-block' parser."
  867. ;; Regular test.
  868. (should
  869. (equal
  870. (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
  871. (org-element-map
  872. (org-element-parse-buffer) 'quote-block 'identity nil t))
  873. '(quote-block
  874. (:begin 1 :end 31 :hiddenp nil :contents-begin 15 :contents-end 20
  875. :post-blank 0)
  876. (paragraph
  877. (:begin 15 :end 20 :contents-begin 15 :contents-end 19 :post-blank 0)
  878. "Text"))))
  879. ;; Test folded block.
  880. (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
  881. (org-cycle)
  882. (should
  883. (org-element-property
  884. :hiddenp
  885. (org-element-map
  886. (org-element-parse-buffer) 'quote-block 'identity nil t))))
  887. ;; Ignore incomplete block.
  888. (should-not
  889. (org-test-with-temp-text "#+BEGIN_QUOTE"
  890. (org-element-map
  891. (org-element-parse-buffer) 'quote-block 'identity nil t))))
  892. ;;;; Section
  893. (ert-deftest test-org-element/section-parser ()
  894. "Test `section' parser."
  895. ;; Standard test.
  896. (should
  897. (equal
  898. (org-test-with-temp-text "* Headline\nText"
  899. (org-element-map (org-element-parse-buffer) 'section 'identity nil t))
  900. '(section
  901. (:begin 12 :end 16 :contents-begin 12 :contents-end 16 :post-blank 0)
  902. (paragraph
  903. (:begin 12 :end 16 :contents-begin 12 :contents-end 16 :post-blank 0)
  904. "Text"))))
  905. ;; There's a section before the first headline.
  906. (should
  907. (org-test-with-temp-text "Text"
  908. (org-element-map (org-element-parse-buffer) 'section 'identity)))
  909. ;; A section cannot be empty.
  910. (should-not
  911. (org-test-with-temp-text "* Headline 1\n* Headline 2"
  912. (org-element-map (org-element-parse-buffer) 'section 'identity))))
  913. ;;;; Special Block
  914. (ert-deftest test-org-element/special-block-parser ()
  915. "Test `special-block' parser."
  916. ;; Regular test.
  917. (should
  918. (equal
  919. (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
  920. (org-element-map
  921. (org-element-parse-buffer) 'special-block 'identity nil t))
  922. '(special-block
  923. (:type "SPECIAL" :begin 1 :end 35 :hiddenp nil :contents-begin 17
  924. :contents-end 22 :post-blank 0)
  925. (paragraph
  926. (:begin 17 :end 22 :contents-begin 17 :contents-end 21 :post-blank 0)
  927. "Text"))))
  928. ;; Test folded block.
  929. (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
  930. (org-cycle)
  931. (should
  932. (org-element-property
  933. :hiddenp
  934. (org-element-map
  935. (org-element-parse-buffer) 'special-block 'identity nil t))))
  936. ;; Ignore incomplete block.
  937. (should-not
  938. (org-test-with-temp-text "#+BEGIN_SPECIAL"
  939. (org-element-map
  940. (org-element-parse-buffer) 'special-block 'identity nil t))))
  941. ;;;; Verse Block
  942. (ert-deftest test-org-element/verse-block-parser ()
  943. "Test `verse-block' parser."
  944. ;; Standard test.
  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. ;; Ignore case.
  954. (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
  955. (should
  956. (equal
  957. (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)
  958. '(verse-block
  959. (:begin 1 :end 38 :contents-begin 15 :contents-end 27 :hiddenp nil
  960. :post-blank 0)
  961. "Verse block\n"))))
  962. ;; Parse folding.
  963. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
  964. (org-hide-block-all)
  965. (should
  966. (equal
  967. (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)
  968. '(verse-block
  969. (:begin 1 :end 38 :contents-begin 15 :contents-end 27
  970. :hiddenp org-hide-block :post-blank 0)
  971. "Verse block\n"))))
  972. ;; Parse objects in verse blocks.
  973. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
  974. (should (org-element-map (org-element-parse-buffer) 'entity 'identity)))
  975. ;; Ignore incomplete verse block.
  976. (should-not
  977. (org-test-with-temp-text "#+BEGIN_VERSE"
  978. (org-element-map
  979. (org-element-parse-buffer) 'verse-block 'identity nil t))))
  980. ;;; Test Interpreters.
  981. (ert-deftest test-org-element/interpret-affiliated-keywords ()
  982. "Test if affiliated keywords are correctly interpreted."
  983. ;; Interpret simple keywords.
  984. (should
  985. (equal
  986. (org-element-interpret-data
  987. '(org-data nil (paragraph (:name "para") "Paragraph")))
  988. "#+NAME: para\nParagraph\n"))
  989. ;; Interpret multiple keywords.
  990. (should
  991. (equal
  992. (org-element-interpret-data
  993. '(org-data nil (paragraph (:attr_ascii ("line1" "line2")) "Paragraph")))
  994. "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
  995. ;; Interpret parsed keywords.
  996. (should
  997. (equal
  998. (org-element-interpret-data
  999. '(org-data nil (paragraph (:caption ("caption")) "Paragraph")))
  1000. "#+CAPTION: caption\nParagraph\n"))
  1001. ;; Interpret dual keywords.
  1002. (should
  1003. (equal
  1004. (org-element-interpret-data
  1005. '(org-data nil (paragraph (:caption (("long") "short")) "Paragraph")))
  1006. "#+CAPTION[short]: long\nParagraph\n")))
  1007. (ert-deftest test-org-element/center-block-interpreter ()
  1008. "Test center block interpreter."
  1009. (should
  1010. (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
  1011. "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
  1012. (ert-deftest test-org-element/drawer-interpreter ()
  1013. "Test drawer interpreter."
  1014. (should
  1015. (equal (let ((org-drawers '("TEST")))
  1016. (org-test-parse-and-interpret ":TEST:\nTest\n:END:"))
  1017. ":TEST:\nTest\n:END:\n")))
  1018. (ert-deftest test-org-element/dynamic-block-interpreter ()
  1019. "Test dynamic block interpreter."
  1020. (should
  1021. (equal (org-test-parse-and-interpret
  1022. "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
  1023. "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
  1024. (ert-deftest test-org-element/footnote-definition-interpreter ()
  1025. "Test footnote definition interpreter."
  1026. (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
  1027. (ert-deftest test-org-element/headline-interpreter ()
  1028. "Test headline and section interpreters."
  1029. ;; 1. Standard test.
  1030. (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
  1031. ;; 2. With TODO keywords.
  1032. (should
  1033. (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  1034. (org-test-parse-and-interpret "* TODO Headline"))
  1035. "* TODO Headline\n"))
  1036. ;; 3. With tags...
  1037. ;;
  1038. ;; 3.1. ... and a positive `org-tags-column' value.
  1039. (should
  1040. (equal (let ((org-tags-column 20))
  1041. (org-test-parse-and-interpret "* Headline :tag:"))
  1042. "* Headline :tag:\n"))
  1043. ;; 3.2. ... and a negative `org-tags-column' value.
  1044. (should
  1045. (equal (let ((org-tags-column -20))
  1046. (org-test-parse-and-interpret "* Headline :tag:"))
  1047. "* Headline :tag:\n"))
  1048. ;; 3.3. ... and a null `org-tags-column' value.
  1049. (should
  1050. (equal (let ((org-tags-column 0))
  1051. (org-test-parse-and-interpret "* Headline :tag:"))
  1052. "* Headline :tag:\n"))
  1053. ;; 4. With priority cookie.
  1054. (should
  1055. (equal (org-test-parse-and-interpret "* [#B] Headline")
  1056. "* [#B] Headline\n"))
  1057. ;; 5. With comment keyword.
  1058. (should
  1059. (equal (let ((org-comment-string "COMMENT"))
  1060. (org-test-parse-and-interpret "* COMMENT Headline"))
  1061. "* COMMENT Headline\n"))
  1062. ;; 6. With quote section.
  1063. (should
  1064. (equal (let ((org-quote-string "QUOTE"))
  1065. (org-test-parse-and-interpret "* QUOTE Headline"))
  1066. "* QUOTE Headline\n"))
  1067. ;; 7. Keep same number of blank lines before body.
  1068. (should
  1069. (equal (org-test-parse-and-interpret
  1070. "* Headline\n\n\nText after two blank lines.")
  1071. "* Headline\n\n\nText after two blank lines.\n")))
  1072. (ert-deftest test-org-element/inlinetask-interpreter ()
  1073. "Test inlinetask interpretation."
  1074. (when (featurep 'org-inlinetask)
  1075. (let ((org-inlinetask-min-level 15))
  1076. ;; 1. Regular inlinetask.
  1077. (should (equal (org-test-parse-and-interpret
  1078. "*************** Task\nTest\n*************** END")
  1079. "*************** Task\nTest\n*************** END\n"))
  1080. ;; 2. Degenerate inlinetask.
  1081. (should (equal (org-test-parse-and-interpret "*************** Task")
  1082. "*************** Task\n"))
  1083. ;; 3. Prefer degenerate form when there are no contents.
  1084. (should (equal (org-test-parse-and-interpret
  1085. "*************** Task\n*************** END")
  1086. "*************** Task\n"))
  1087. ;; 4. With TODO keywords.
  1088. (should
  1089. (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  1090. (org-test-parse-and-interpret "*************** TODO Task"))
  1091. "*************** TODO Task\n"))
  1092. ;; 5. With tags...
  1093. ;;
  1094. ;; 5.1. ... and a positive `org-tags-column' value.
  1095. (should
  1096. (equal (let ((org-tags-column 30))
  1097. (org-test-parse-and-interpret "*************** Task :tag:"))
  1098. "*************** Task :tag:\n"))
  1099. ;; 5.2. ... and a negative `org-tags-column' value.
  1100. (should
  1101. (equal (let ((org-tags-column -30))
  1102. (org-test-parse-and-interpret "*************** Task :tag:"))
  1103. "*************** Task :tag:\n"))
  1104. ;; 5.3. ... and a null `org-tags-column' value.
  1105. (should
  1106. (equal (let ((org-tags-column 0))
  1107. (org-test-parse-and-interpret "*************** Task :tag:"))
  1108. "*************** Task :tag:\n"))
  1109. ;; 6. With priority cookie.
  1110. (should
  1111. (equal (org-test-parse-and-interpret "*************** [#B] Task")
  1112. "*************** [#B] Task\n")))))
  1113. (ert-deftest test-org-element/plain-list-interpreter ()
  1114. "Test plain-list and item interpreters."
  1115. ;; 1. Unordered list.
  1116. (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
  1117. ;; 2. Description list.
  1118. (should
  1119. (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
  1120. ;; 3. Ordered list.
  1121. (should
  1122. (equal (let ((org-plain-list-ordered-item-terminator t))
  1123. (org-test-parse-and-interpret "1. Item"))
  1124. "1. Item\n"))
  1125. ;; 4. Ordered list with counter.
  1126. (should
  1127. (equal (let ((org-plain-list-ordered-item-terminator t))
  1128. (org-test-parse-and-interpret "1. [@5] Item"))
  1129. "5. [@5] Item\n"))
  1130. ;; 5. List with check-boxes.
  1131. (should
  1132. (equal (org-test-parse-and-interpret
  1133. "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
  1134. "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n")))
  1135. (ert-deftest test-org-element/quote-block-interpreter ()
  1136. "Test quote block interpreter."
  1137. (should (equal (org-test-parse-and-interpret
  1138. "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
  1139. "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
  1140. (ert-deftest test-org-element/special-block-interpreter ()
  1141. "Test special block interpreter."
  1142. (should (equal (org-test-parse-and-interpret
  1143. "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
  1144. "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
  1145. (ert-deftest test-org-element/babel-call-interpreter ()
  1146. "Test babel call interpreter."
  1147. ;; 1. Without argument.
  1148. (should (equal (org-test-parse-and-interpret "#+CALL: test()")
  1149. "#+CALL: test()\n"))
  1150. ;; 2. With argument.
  1151. (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
  1152. "#+CALL: test(x=2)\n"))
  1153. ;; 3. With header arguments.
  1154. (should (equal (org-test-parse-and-interpret
  1155. "#+CALL: test[:results output]()[:results html]")
  1156. "#+CALL: test[:results output]()[:results html]\n")))
  1157. (ert-deftest test-org-element/clock-interpreter ()
  1158. "Test clock interpreter."
  1159. ;; Running clock.
  1160. (should
  1161. (equal (let ((org-clock-string "CLOCK:"))
  1162. (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]"))
  1163. "CLOCK: [2012-01-01 sun. 00:01]\n"))
  1164. ;; Closed clock.
  1165. (should
  1166. (equal
  1167. (let ((org-clock-string "CLOCK:"))
  1168. (org-test-parse-and-interpret "
  1169. CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))
  1170. "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01\n")))
  1171. (ert-deftest test-org-element/comment-interpreter ()
  1172. "Test comment interpreter."
  1173. ;; Regular comment.
  1174. (should (equal (org-test-parse-and-interpret "#Comment") "#+ Comment\n"))
  1175. ;; Inline comment.
  1176. (should (equal (org-test-parse-and-interpret " #+ Comment")
  1177. "#+ Comment\n"))
  1178. ;; Preserve indentation.
  1179. (should (equal (org-test-parse-and-interpret " #+ No blank\n#+ One blank")
  1180. "#+ No blank\n#+ One blank\n")))
  1181. (ert-deftest test-org-element/comment-block-interpreter ()
  1182. "Test comment block interpreter."
  1183. (should (equal (org-test-parse-and-interpret
  1184. "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
  1185. "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n")))
  1186. (ert-deftest test-org-element/example-block-interpreter ()
  1187. "Test example block interpreter."
  1188. ;; Without switches.
  1189. (should (equal (org-test-parse-and-interpret
  1190. "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
  1191. "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
  1192. ;; With switches.
  1193. (should
  1194. (equal (org-test-parse-and-interpret
  1195. "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
  1196. "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n")))
  1197. (ert-deftest test-org-element/export-block-interpreter ()
  1198. "Test export block interpreter."
  1199. (should (equal (org-test-parse-and-interpret
  1200. "#+BEGIN_HTML\nTest\n#+END_HTML")
  1201. "#+BEGIN_HTML\nTest\n#+END_HTML\n")))
  1202. (ert-deftest test-org-element/fixed-width-interpreter ()
  1203. "Test fixed width interpreter."
  1204. ;; Standard test.
  1205. (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
  1206. ;; Preserve indentation.
  1207. (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
  1208. ": 2 blanks\n: 1 blank\n")))
  1209. (ert-deftest test-org-element/horizontal-rule-interpreter ()
  1210. "Test horizontal rule interpreter."
  1211. (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
  1212. (ert-deftest test-org-element/keyword-interpreter ()
  1213. "Test keyword interpreter."
  1214. (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
  1215. "#+KEYWORD: value\n")))
  1216. (ert-deftest test-org-element/latex-environment-interpreter ()
  1217. "Test latex environment interpreter."
  1218. (should (equal (org-test-parse-and-interpret
  1219. "\\begin{equation}\n1+1=2\n\\end{equation}")
  1220. "\\begin{equation}\n1+1=2\n\\end{equation}\n")))
  1221. (ert-deftest test-org-element/planning-interpreter ()
  1222. "Test planning interpreter."
  1223. (let ((org-closed-string "CLOSED:")
  1224. (org-deadline-string "DEADLINE:")
  1225. (org-scheduled-string "SCHEDULED:"))
  1226. (should
  1227. (equal
  1228. (org-test-parse-and-interpret
  1229. "* Headline
  1230. CLOSED: <2012-01-01> DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01>")
  1231. "* Headline
  1232. CLOSED: <2012-01-01> DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01>\n"))))
  1233. (ert-deftest test-org-element/property-drawer-interpreter ()
  1234. "Test property drawer interpreter."
  1235. (should (equal (let ((org-property-format "%-10s %s"))
  1236. (org-test-parse-and-interpret
  1237. ":PROPERTIES:\n:prop: value\n:END:"))
  1238. ":PROPERTIES:\n:prop: value\n:END:\n")))
  1239. (ert-deftest test-org-element/src-block-interpreter ()
  1240. "Test src block interpreter."
  1241. ;; With arguments.
  1242. (should
  1243. (equal (org-test-parse-and-interpret
  1244. "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC")
  1245. "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC\n"))
  1246. ;; With switches.
  1247. (should
  1248. (equal (org-test-parse-and-interpret
  1249. "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC")
  1250. "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC\n")))
  1251. (ert-deftest test-org-element/table-interpreter ()
  1252. "Test table, table-row and table-cell interpreters."
  1253. ;; 1. Simple table.
  1254. (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
  1255. "| a | b |\n| c | d |\n"))
  1256. ;; 2. Table with horizontal rules.
  1257. (should (equal (org-test-parse-and-interpret
  1258. "| a | b |\n|---+---|\n| c | d |")
  1259. "| a | b |\n|---+---|\n| c | d |\n"))
  1260. ;; 3. Table with meta-data.
  1261. (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
  1262. "| / | < | > |\n| * | 1 | 2 |\n")))
  1263. (ert-deftest test-org-element/verse-block-interpreter ()
  1264. "Test verse block interpretation."
  1265. (should
  1266. (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
  1267. "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
  1268. (ert-deftest test-org-element/bold-interpreter ()
  1269. "Test bold interpreter."
  1270. (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
  1271. (ert-deftest test-org-element/code-interpreter ()
  1272. "Test code interpreter."
  1273. (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
  1274. (ert-deftest test-org-element/entity-interpreter ()
  1275. "Test entity interpreter."
  1276. ;; 1. Without brackets.
  1277. (should
  1278. (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
  1279. ;; 2. With brackets.
  1280. (should
  1281. (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
  1282. (ert-deftest test-org-element/export-snippet-interpreter ()
  1283. "Test export snippet interpreter."
  1284. (should (equal (org-test-parse-and-interpret "<back-end@contents>")
  1285. "<back-end@contents>\n")))
  1286. (ert-deftest test-org-element/footnote-reference-interpreter ()
  1287. "Test footnote reference interpreter."
  1288. ;; 1. Regular reference.
  1289. (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
  1290. ;; 2. Normalized reference.
  1291. (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
  1292. ;; 3. Named reference.
  1293. (should (equal (org-test-parse-and-interpret "Text[fn:label]")
  1294. "Text[fn:label]\n"))
  1295. ;; 4. Inline reference.
  1296. (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
  1297. "Text[fn:label:def]\n"))
  1298. ;; 5. Anonymous reference.
  1299. (should (equal (org-test-parse-and-interpret "Text[fn::def]")
  1300. "Text[fn::def]\n")))
  1301. (ert-deftest test-org-element/inline-babel-call-interpreter ()
  1302. "Test inline babel call interpreter."
  1303. ;; 1. Without arguments.
  1304. (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
  1305. ;; 2. With arguments.
  1306. (should (equal (org-test-parse-and-interpret "call_test(x=2)")
  1307. "call_test(x=2)\n"))
  1308. ;; 3. With header arguments.
  1309. (should (equal (org-test-parse-and-interpret
  1310. "call_test[:results output]()[:results html]")
  1311. "call_test[:results output]()[:results html]\n")))
  1312. (ert-deftest test-org-element/inline-src-block-interpreter ()
  1313. "Test inline src block interpreter."
  1314. ;; 1. Without header argument.
  1315. (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
  1316. "src_emacs-lisp{(+ 1 1)}\n"))
  1317. ;; 2. With header arguments.
  1318. (should (equal (org-test-parse-and-interpret
  1319. "src_emacs-lisp[:results silent]{(+ 1 1)}")
  1320. "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
  1321. (ert-deftest test-org-element/italic-interpreter ()
  1322. "Test italic interpreter."
  1323. (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
  1324. (ert-deftest test-org-element/latex-fragment-interpreter ()
  1325. "Test latex fragment interpreter."
  1326. (let ((org-latex-regexps
  1327. '(("begin" "^[ ]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^�]+?\\\\end{\\2}\\)" 1 t)
  1328. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \n,;.$]\\$\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  1329. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \n,;.$][^$\n ]*?\\(\n[^$\n ]*?\\)\\{0,2\\}[^ \n,.$]\\)\\$\\)\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  1330. ("\\(" "\\\\([^�]*?\\\\)" 0 nil)
  1331. ("\\[" "\\\\\\[[^�]*?\\\\\\]" 0 nil)
  1332. ("$$" "\\$\\$[^�]*?\\$\\$" 0 nil))))
  1333. (should (equal (org-test-parse-and-interpret "\\command{}")
  1334. "\\command{}\n"))
  1335. (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
  1336. (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
  1337. (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
  1338. (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
  1339. (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n"))))
  1340. (ert-deftest test-org-element/line-break-interpreter ()
  1341. "Test line break interpreter."
  1342. (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
  1343. "First line \\\\\nSecond line\n")))
  1344. (ert-deftest test-org-element/link-interpreter ()
  1345. "Test link interpreter."
  1346. ;; 1. Links targeted from a radio target.
  1347. (should (equal (let ((org-target-link-regexp "radio-target"))
  1348. (org-test-parse-and-interpret "a radio-target"))
  1349. "a radio-target\n"))
  1350. ;; 2. Regular links.
  1351. ;;
  1352. ;; 2.1. Without description.
  1353. (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
  1354. "[[http://orgmode.org]]\n"))
  1355. ;; 2.2. With a description.
  1356. (should (equal (org-test-parse-and-interpret
  1357. "[[http://orgmode.org][Org mode]]")
  1358. "[[http://orgmode.org][Org mode]]\n"))
  1359. ;; 2.3. Id links.
  1360. (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
  1361. ;; 2.4. Custom-id links.
  1362. (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
  1363. ;; 2.5 Code-ref links.
  1364. (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
  1365. ;; 3. Normalize plain links.
  1366. (should (equal (org-test-parse-and-interpret "http://orgmode.org")
  1367. "[[http://orgmode.org]]\n"))
  1368. ;; 4. Normalize angular links.
  1369. (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
  1370. "[[http://orgmode.org]]\n")))
  1371. (ert-deftest test-org-element/macro-interpreter ()
  1372. "Test macro interpreter."
  1373. ;; 1. Without argument.
  1374. (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
  1375. ;; 2. With arguments.
  1376. (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
  1377. "{{{test(arg1,arg2)}}}\n")))
  1378. (ert-deftest test-org-element/radio-target-interpreter ()
  1379. "Test radio target interpreter."
  1380. (should (equal (org-test-parse-and-interpret "<<<some text>>>")
  1381. "<<<some text>>>\n")))
  1382. (ert-deftest test-org-element/statistics-cookie-interpreter ()
  1383. "Test statistics cookie interpreter."
  1384. ;; 1. Without percent
  1385. (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
  1386. ;; 2. With percent.
  1387. (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
  1388. (ert-deftest test-org-element/strike-through-interpreter ()
  1389. "Test strike through interpreter."
  1390. (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
  1391. (ert-deftest test-org-element/subscript-interpreter ()
  1392. "Test subscript interpreter."
  1393. ;; 1. Without brackets.
  1394. (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
  1395. ;; 2. With brackets.
  1396. (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
  1397. (ert-deftest test-org-element/superscript-interpreter ()
  1398. "Test superscript interpreter."
  1399. ;; 1. Without brackets.
  1400. (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
  1401. ;; 2. With brackets.
  1402. (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
  1403. (ert-deftest test-org-element/target-interpreter ()
  1404. "Test target interpreter."
  1405. (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
  1406. (ert-deftest test-org-element/underline-interpreter ()
  1407. "Test underline interpreter."
  1408. (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
  1409. (ert-deftest test-org-element/verbatim-interpreter ()
  1410. "Test verbatim interpreter."
  1411. (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
  1412. ;;; Test Granularity
  1413. (ert-deftest test-org-element/granularity ()
  1414. "Test granularity impact on buffer parsing."
  1415. (org-test-with-temp-text "
  1416. * Head 1
  1417. ** Head 2
  1418. #+BEGIN_CENTER
  1419. Centered paragraph.
  1420. #+END_CENTER
  1421. Paragraph \\alpha."
  1422. ;; 1.1. Granularity set to `headline' should parse every headline
  1423. ;; in buffer, and only them.
  1424. (let ((tree (org-element-parse-buffer 'headline)))
  1425. (should (= 2 (length (org-element-map tree 'headline 'identity))))
  1426. (should-not (org-element-map tree 'paragraph 'identity)))
  1427. ;; 1.2. Granularity set to `greater-element' should not enter
  1428. ;; greater elements excepted headlines and sections.
  1429. (let ((tree (org-element-parse-buffer 'greater-element)))
  1430. (should (= 1 (length (org-element-map tree 'center-block 'identity))))
  1431. (should (= 1 (length (org-element-map tree 'paragraph 'identity))))
  1432. (should-not (org-element-map tree 'entity 'identity)))
  1433. ;; 1.3. Granularity set to `element' should enter every
  1434. ;; greater-element.
  1435. (let ((tree (org-element-parse-buffer 'element)))
  1436. (should (= 2 (length (org-element-map tree 'paragraph 'identity))))
  1437. (should-not (org-element-map tree 'entity 'identity)))
  1438. ;; 1.4. Granularity set to `object' can see everything.
  1439. (let ((tree (org-element-parse-buffer 'object)))
  1440. (should (= 1 (length (org-element-map tree 'entity 'identity)))))))
  1441. (ert-deftest test-org-element/secondary-string-parsing ()
  1442. "Test if granularity correctly toggles secondary strings parsing."
  1443. ;; 1. With a granularity bigger than `object', no secondary string
  1444. ;; should be parsed.
  1445. ;;
  1446. ;; 1.1. Test with `headline' type.
  1447. (org-test-with-temp-text "* Headline"
  1448. (let ((headline
  1449. (org-element-map (org-element-parse-buffer 'headline) 'headline
  1450. 'identity
  1451. nil
  1452. 'first-match)))
  1453. (should (stringp (org-element-property :title headline)))))
  1454. ;; 1.2. Test with `item' type.
  1455. (org-test-with-temp-text "* Headline\n- tag :: item"
  1456. (let ((item (org-element-map (org-element-parse-buffer 'element)
  1457. 'item
  1458. 'identity
  1459. nil
  1460. 'first-match)))
  1461. (should (stringp (org-element-property :tag item)))))
  1462. ;; 1.3. Test with `inlinetask' type, if avalaible.
  1463. (when (featurep 'org-inlinetask)
  1464. (let ((org-inlinetask-min-level 15))
  1465. (org-test-with-temp-text "*************** Inlinetask"
  1466. (let ((inlinetask (org-element-map (org-element-parse-buffer 'element)
  1467. 'inlinetask
  1468. 'identity
  1469. nil
  1470. 'first-match)))
  1471. (should (stringp (org-element-property :title inlinetask)))))))
  1472. ;; 2. With a default granularity, secondary strings should be
  1473. ;; parsed.
  1474. (org-test-with-temp-text "* Headline"
  1475. (let ((headline
  1476. (org-element-map (org-element-parse-buffer) 'headline
  1477. 'identity
  1478. nil
  1479. 'first-match)))
  1480. (should (listp (org-element-property :title headline)))))
  1481. ;; 3. `org-element-at-point' should never parse a secondary string.
  1482. (org-test-with-temp-text "* Headline"
  1483. (should (stringp (org-element-property :title (org-element-at-point))))))
  1484. ;;; Test Normalize Contents
  1485. (ert-deftest test-org-element/normalize-contents ()
  1486. "Test `org-element-normalize-contents' specifications."
  1487. ;; 1. Remove maximum common indentation from element's contents.
  1488. (should
  1489. (equal
  1490. (org-element-normalize-contents
  1491. '(paragraph nil " Two spaces\n Three spaces"))
  1492. '(paragraph nil "Two spaces\n Three spaces")))
  1493. ;; 2. Ignore objects within contents when computing maximum common
  1494. ;; indentation.
  1495. (should
  1496. (equal
  1497. (org-element-normalize-contents
  1498. '(paragraph nil " One " (emphasis nil "space") "\n Two spaces"))
  1499. '(paragraph nil "One " (emphasis nil "space") "\n Two spaces")))
  1500. ;; 3. Ignore blank lines.
  1501. (should
  1502. (equal
  1503. (org-element-normalize-contents
  1504. '(paragraph nil " Two spaces\n\n \n Two spaces"))
  1505. '(paragraph nil "Two spaces\n\n \nTwo spaces")))
  1506. ;; 4. Recursively enter objects in order to compute common
  1507. ;; indentation.
  1508. (should
  1509. (equal
  1510. (org-element-normalize-contents
  1511. '(paragraph nil " Two spaces " (bold nil " and\n One space")))
  1512. '(paragraph nil " Two spaces " (bold nil " and\nOne space"))))
  1513. ;; 5. When optional argument is provided, ignore first line
  1514. ;; indentation.
  1515. (should
  1516. (equal
  1517. (org-element-normalize-contents
  1518. '(paragraph nil "No space\n Two spaces\n Three spaces") t)
  1519. '(paragraph nil "No space\nTwo spaces\n Three spaces"))))
  1520. ;;; Test Navigation Tools.
  1521. (ert-deftest test-org-element/at-point ()
  1522. "Test `org-element-at-point' specifications."
  1523. ;; Special case: at the very beginning of a table, return `table'
  1524. ;; object instead of `table-row'.
  1525. (should
  1526. (eq 'table
  1527. (org-test-with-temp-text "| a | b |"
  1528. (org-element-type (org-element-at-point)))))
  1529. ;; Special case: at the very beginning of a list or sub-list, return
  1530. ;; `plain-list' object instead of `item'.
  1531. (should
  1532. (eq 'plain-list
  1533. (org-test-with-temp-text "- item"
  1534. (org-element-type (org-element-at-point))))))
  1535. (ert-deftest test-org-element/forward ()
  1536. "Test `org-element-forward' specifications."
  1537. ;; 1. At EOB: should error.
  1538. (org-test-with-temp-text "Some text\n"
  1539. (goto-char (point-max))
  1540. (should-error (org-element-forward)))
  1541. ;; 2. Standard move: expected to ignore blank lines.
  1542. (org-test-with-temp-text "First paragraph.\n\n\nSecond paragraph."
  1543. (org-element-forward)
  1544. (should (looking-at "Second paragraph.")))
  1545. ;; 3. Headline tests.
  1546. (org-test-with-temp-text "
  1547. * Head 1
  1548. ** Head 1.1
  1549. *** Head 1.1.1
  1550. ** Head 1.2"
  1551. ;; 3.1. At an headline beginning: move to next headline at the
  1552. ;; same level.
  1553. (goto-line 3)
  1554. (org-element-forward)
  1555. (should (looking-at "** Head 1.2"))
  1556. ;; 3.2. At an headline beginning: move to parent headline if no
  1557. ;; headline at the same level.
  1558. (goto-line 3)
  1559. (org-element-forward)
  1560. (should (looking-at "** Head 1.2")))
  1561. ;; 4. Greater element tests.
  1562. (org-test-with-temp-text
  1563. "#+BEGIN_CENTER\nInside.\n#+END_CENTER\n\nOutside."
  1564. ;; 4.1. At a greater element: expected to skip contents.
  1565. (org-element-forward)
  1566. (should (looking-at "Outside."))
  1567. ;; 4.2. At the end of greater element contents: expected to skip
  1568. ;; to the end of the greater element.
  1569. (goto-line 2)
  1570. (org-element-forward)
  1571. (should (looking-at "Outside.")))
  1572. ;; 5. List tests.
  1573. (org-test-with-temp-text "
  1574. - item1
  1575. - sub1
  1576. - sub2
  1577. - sub3
  1578. Inner paragraph.
  1579. - item2
  1580. Outside."
  1581. ;; 5.1. At list top point: expected to move to the element after
  1582. ;; the list.
  1583. (goto-line 2)
  1584. (org-element-forward)
  1585. (should (looking-at "Outside."))
  1586. ;; 5.2. Special case: at the first line of a sub-list, but not at
  1587. ;; beginning of line, move to next item.
  1588. (goto-line 2)
  1589. (forward-char)
  1590. (org-element-forward)
  1591. (should (looking-at "- item2"))
  1592. (goto-line 4)
  1593. (forward-char)
  1594. (org-element-forward)
  1595. (should (looking-at " - sub2"))
  1596. ;; 5.3 At sub-list beginning: expected to move after the sub-list.
  1597. (goto-line 4)
  1598. (org-element-forward)
  1599. (should (looking-at " Inner paragraph."))
  1600. ;; 5.4. At sub-list end: expected to move outside the sub-list.
  1601. (goto-line 8)
  1602. (org-element-forward)
  1603. (should (looking-at " Inner paragraph."))
  1604. ;; 5.5. At an item: expected to move to next item, if any.
  1605. (goto-line 6)
  1606. (org-element-forward)
  1607. (should (looking-at " - sub3"))))
  1608. (ert-deftest test-org-element/backward ()
  1609. "Test `org-element-backward' specifications."
  1610. ;; 1. At BOB (modulo some white spaces): should error.
  1611. (org-test-with-temp-text " \nParagraph."
  1612. (org-skip-whitespace)
  1613. (should-error (org-element-backward)))
  1614. ;; 2. Not at the beginning of an element: move at its beginning.
  1615. (org-test-with-temp-text "Paragraph1.\n\nParagraph2."
  1616. (goto-line 3)
  1617. (end-of-line)
  1618. (org-element-backward)
  1619. (should (looking-at "Paragraph2.")))
  1620. ;; 3. Headline tests.
  1621. (org-test-with-temp-text "
  1622. * Head 1
  1623. ** Head 1.1
  1624. *** Head 1.1.1
  1625. ** Head 1.2"
  1626. ;; 3.1. At an headline beginning: move to previous headline at the
  1627. ;; same level.
  1628. (goto-line 5)
  1629. (org-element-backward)
  1630. (should (looking-at "** Head 1.1"))
  1631. ;; 3.2. At an headline beginning: move to parent headline if no
  1632. ;; headline at the same level.
  1633. (goto-line 3)
  1634. (org-element-backward)
  1635. (should (looking-at "* Head 1"))
  1636. ;; 3.3. At the first top-level headline: should error.
  1637. (goto-line 2)
  1638. (should-error (org-element-backward)))
  1639. ;; 4. At beginning of first element inside a greater element:
  1640. ;; expected to move to greater element's beginning.
  1641. (org-test-with-temp-text "Before.\n#+BEGIN_CENTER\nInside.\n#+END_CENTER."
  1642. (goto-line 3)
  1643. (org-element-backward)
  1644. (should (looking-at "#\\+BEGIN_CENTER")))
  1645. ;; 5. List tests.
  1646. (org-test-with-temp-text "
  1647. - item1
  1648. - sub1
  1649. - sub2
  1650. - sub3
  1651. Inner paragraph.
  1652. - item2
  1653. Outside."
  1654. ;; 5.1. At beginning of sub-list: expected to move to the
  1655. ;; paragraph before it.
  1656. (goto-line 4)
  1657. (org-element-backward)
  1658. (should (looking-at "item1"))
  1659. ;; 5.2. At an item in a list: expected to move at previous item.
  1660. (goto-line 8)
  1661. (org-element-backward)
  1662. (should (looking-at " - sub2"))
  1663. (goto-line 12)
  1664. (org-element-backward)
  1665. (should (looking-at "- item1"))
  1666. ;; 5.3. At end of list/sub-list: expected to move to list/sub-list
  1667. ;; beginning.
  1668. (goto-line 10)
  1669. (org-element-backward)
  1670. (should (looking-at " - sub1"))
  1671. (goto-line 15)
  1672. (org-element-backward)
  1673. (should (looking-at "- item1"))
  1674. ;; 5.4. At blank-lines before list end: expected to move to top
  1675. ;; item.
  1676. (goto-line 14)
  1677. (org-element-backward)
  1678. (should (looking-at "- item1"))))
  1679. (ert-deftest test-org-element/up ()
  1680. "Test `org-element-up' specifications."
  1681. ;; 1. At BOB or with no surrounding element: should error.
  1682. (org-test-with-temp-text "Paragraph."
  1683. (should-error (org-element-up)))
  1684. (org-test-with-temp-text "* Head1\n* Head2"
  1685. (goto-line 2)
  1686. (should-error (org-element-up)))
  1687. (org-test-with-temp-text "Paragraph1.\n\nParagraph2."
  1688. (goto-line 3)
  1689. (should-error (org-element-up)))
  1690. ;; 2. At an headline: move to parent headline.
  1691. (org-test-with-temp-text "* Head1\n** Sub-Head1\n** Sub-Head2"
  1692. (goto-line 3)
  1693. (org-element-up)
  1694. (should (looking-at "\\* Head1")))
  1695. ;; 3. Inside a greater element: move to greater element beginning.
  1696. (org-test-with-temp-text
  1697. "Before.\n#+BEGIN_CENTER\nParagraph1\nParagraph2\n#+END_CENTER\n"
  1698. (goto-line 3)
  1699. (org-element-up)
  1700. (should (looking-at "#\\+BEGIN_CENTER")))
  1701. ;; 4. List tests.
  1702. (org-test-with-temp-text "* Top
  1703. - item1
  1704. - sub1
  1705. - sub2
  1706. Paragraph within sub2.
  1707. - item2"
  1708. ;; 4.1. Within an item: move to the item beginning.
  1709. (goto-line 8)
  1710. (org-element-up)
  1711. (should (looking-at " - sub2"))
  1712. ;; 4.2. At an item in a sub-list: move to parent item.
  1713. (goto-line 4)
  1714. (org-element-up)
  1715. (should (looking-at "- item1"))
  1716. ;; 4.3. At an item in top list: move to beginning of whole list.
  1717. (goto-line 10)
  1718. (org-element-up)
  1719. (should (looking-at "- item1"))
  1720. ;; 4.4. Special case. At very top point: should move to parent of
  1721. ;; list.
  1722. (goto-line 2)
  1723. (org-element-up)
  1724. (should (looking-at "\\* Top"))))
  1725. (ert-deftest test-org-element/down ()
  1726. "Test `org-element-down' specifications."
  1727. ;; 1. Error when the element hasn't got a recursive type.
  1728. (org-test-with-temp-text "Paragraph."
  1729. (should-error (org-element-down)))
  1730. ;; 2. When at a plain-list, move to first item.
  1731. (org-test-with-temp-text "- Item 1\n - Item 1.1\n - Item 2.2"
  1732. (goto-line 2)
  1733. (org-element-down)
  1734. (should (looking-at " - Item 1.1")))
  1735. (org-test-with-temp-text "#+NAME: list\n- Item 1"
  1736. (org-element-down)
  1737. (should (looking-at " Item 1")))
  1738. ;; 3. When at a table, move to first row
  1739. (org-test-with-temp-text "#+NAME: table\n| a | b |"
  1740. (org-element-down)
  1741. (should (looking-at " a | b |")))
  1742. ;; 4. Otherwise, move inside the greater element.
  1743. (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph.\n#+END_CENTER"
  1744. (org-element-down)
  1745. (should (looking-at "Paragraph"))))
  1746. (ert-deftest test-org-element/drag-backward ()
  1747. "Test `org-element-drag-backward' specifications."
  1748. ;; 1. Error when trying to move first element of buffer.
  1749. (org-test-with-temp-text "Paragraph 1.\n\nParagraph 2."
  1750. (should-error (org-element-drag-backward)))
  1751. ;; 2. Error when trying to swap nested elements.
  1752. (org-test-with-temp-text "#+BEGIN_CENTER\nTest.\n#+END_CENTER"
  1753. (forward-line)
  1754. (should-error (org-element-drag-backward)))
  1755. ;; 3. Error when trying to swap an headline element and
  1756. ;; a non-headline element.
  1757. (org-test-with-temp-text "Test.\n* Head 1"
  1758. (forward-line)
  1759. (should-error (org-element-drag-backward)))
  1760. ;; 4. Otherwise, swap elements, preserving column and blank lines
  1761. ;; between elements.
  1762. (org-test-with-temp-text "Para1\n\n\nParagraph 2\n\nPara3"
  1763. (search-forward "graph")
  1764. (org-element-drag-backward)
  1765. (should (equal (buffer-string) "Paragraph 2\n\n\nPara1\n\nPara3"))
  1766. (should (looking-at " 2"))))
  1767. (ert-deftest test-org-element/drag-forward ()
  1768. "Test `org-element-drag-forward' specifications."
  1769. ;; 1. Error when trying to move first element of buffer.
  1770. (org-test-with-temp-text "Paragraph 1.\n\nParagraph 2."
  1771. (goto-line 3)
  1772. (should-error (org-element-drag-forward)))
  1773. ;; 2. Error when trying to swap nested elements.
  1774. (org-test-with-temp-text "#+BEGIN_CENTER\nTest.\n#+END_CENTER"
  1775. (forward-line)
  1776. (should-error (org-element-drag-forward)))
  1777. ;; 3. Error when trying to swap a non-headline element and an
  1778. ;; headline.
  1779. (org-test-with-temp-text "Test.\n* Head 1"
  1780. (should-error (org-element-drag-forward)))
  1781. ;; 4. Otherwise, swap elements, preserving column and blank lines
  1782. ;; between elements.
  1783. (org-test-with-temp-text "Paragraph 1\n\n\nPara2\n\nPara3"
  1784. (search-forward "graph")
  1785. (org-element-drag-forward)
  1786. (should (equal (buffer-string) "Para2\n\n\nParagraph 1\n\nPara3"))
  1787. (should (looking-at " 1"))))
  1788. (provide 'test-org-element)
  1789. ;;; test-org-element.el ends here