test-org-element.el 84 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437
  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. (unless (featurep 'org-element)
  15. (signal 'missing-test-dependency "org-element"))
  16. (defun org-test-parse-and-interpret (text)
  17. "Parse TEXT as Org syntax and interpret it.
  18. Return interpreted string."
  19. (with-temp-buffer
  20. (org-mode)
  21. (insert text)
  22. (org-element-interpret-data (org-element-parse-buffer))))
  23. ;;; Test `org-element-map'
  24. (ert-deftest test-org-element/map ()
  25. "Test `org-element-map'."
  26. ;; Can map to `plain-text' objects.
  27. (should
  28. (= 2
  29. (org-test-with-temp-text "Some text \alpha
  30. #+BEGIN_CENTER
  31. Some other text
  32. #+END_CENTER"
  33. (let ((count 0))
  34. (org-element-map
  35. (org-element-parse-buffer) 'plain-text
  36. (lambda (s) (when (string-match "text" s) (incf count))))
  37. count))))
  38. ;; Applies to secondary strings
  39. (should
  40. (org-element-map '("some " (bold nil "bold") "text") 'bold 'identity))
  41. ;; Enter secondary strings before entering contents.
  42. (should
  43. (equal
  44. "alpha"
  45. (org-element-property
  46. :name
  47. (org-test-with-temp-text "* Some \\alpha headline\n\\beta entity."
  48. (org-element-map (org-element-parse-buffer) 'entity 'identity nil t)))))
  49. ;; Apply NO-RECURSION argument.
  50. (should-not
  51. (org-test-with-temp-text "#+BEGIN_CENTER\n\\alpha\n#+END_CENTER"
  52. (org-element-map
  53. (org-element-parse-buffer) 'entity 'identity nil nil 'center-block))))
  54. ;;; Test Setters
  55. (ert-deftest test-org-element/put-property ()
  56. "Test `org-element-put-property' specifications."
  57. (org-test-with-temp-text "* Headline\n *a*"
  58. (let ((tree (org-element-parse-buffer)))
  59. (org-element-put-property
  60. (org-element-map tree 'bold 'identity nil t) :test 1)
  61. (should (org-element-property
  62. :test (org-element-map tree 'bold 'identity nil t))))))
  63. (ert-deftest test-org-element/set-contents ()
  64. "Test `org-element-set-contents' specifications."
  65. ;; Accept multiple entries.
  66. (should
  67. (equal '("b" (italic nil "a"))
  68. (org-test-with-temp-text "* Headline\n *a*"
  69. (let ((tree (org-element-parse-buffer)))
  70. (org-element-set-contents
  71. (org-element-map tree 'bold 'identity nil t) "b" '(italic nil "a"))
  72. (org-element-contents
  73. (org-element-map tree 'bold 'identity nil t))))))
  74. ;; Accept atoms and elements.
  75. (should
  76. (equal '("b")
  77. (org-test-with-temp-text "* Headline\n *a*"
  78. (let ((tree (org-element-parse-buffer)))
  79. (org-element-set-contents
  80. (org-element-map tree 'bold 'identity nil t) "b")
  81. (org-element-contents
  82. (org-element-map tree 'bold 'identity nil t))))))
  83. (should
  84. (equal '((italic nil "b"))
  85. (org-test-with-temp-text "* Headline\n *a*"
  86. (let ((tree (org-element-parse-buffer)))
  87. (org-element-set-contents
  88. (org-element-map tree 'bold 'identity nil t) '(italic nil "b"))
  89. (org-element-contents
  90. (org-element-map tree 'bold 'identity nil t))))))
  91. ;; Allow nil contents.
  92. (should-not
  93. (org-test-with-temp-text "* Headline\n *a*"
  94. (let ((tree (org-element-parse-buffer)))
  95. (org-element-set-contents (org-element-map tree 'bold 'identity nil t))
  96. (org-element-contents (org-element-map tree 'bold 'identity nil t))))))
  97. (ert-deftest test-org-element/set-element ()
  98. "Test `org-element-set-element' specifications."
  99. (org-test-with-temp-text "* Headline\n*a*"
  100. (let ((tree (org-element-parse-buffer)))
  101. (org-element-set-element
  102. (org-element-map tree 'bold 'identity nil t)
  103. '(italic nil "b"))
  104. ;; Check if object is correctly replaced.
  105. (should (org-element-map tree 'italic 'identity))
  106. (should-not (org-element-map tree 'bold 'identity))
  107. ;; Check if new object's parent is correctly set.
  108. (should
  109. (eq
  110. (org-element-property :parent
  111. (org-element-map tree 'italic 'identity nil t))
  112. (org-element-map tree 'paragraph 'identity nil t))))))
  113. (ert-deftest test-org-element/adopt-elements ()
  114. "Test `org-element-adopt-elements' specifications."
  115. ;; Adopt an element.
  116. (should
  117. (equal '(plain-text italic)
  118. (org-test-with-temp-text "* Headline\n *a*"
  119. (let ((tree (org-element-parse-buffer)))
  120. (org-element-adopt-elements
  121. (org-element-map tree 'bold 'identity nil t) '(italic nil "a"))
  122. (mapcar (lambda (blob) (org-element-type blob))
  123. (org-element-contents
  124. (org-element-map tree 'bold 'identity nil t)))))))
  125. ;; Adopt a string.
  126. (should
  127. (equal '("a" "b")
  128. (org-test-with-temp-text "* Headline\n *a*"
  129. (let ((tree (org-element-parse-buffer)))
  130. (org-element-adopt-elements
  131. (org-element-map tree 'bold 'identity nil t) "b")
  132. (org-element-contents
  133. (org-element-map tree 'bold 'identity nil t)))))))
  134. ;;; Test Parsers
  135. ;;;; Affiliated Keywords
  136. (ert-deftest test-org-element/affiliated-keywords-parser ()
  137. "Test affiliated keywords parsing."
  138. ;; Read simple keywords.
  139. (should
  140. (equal "para"
  141. (org-element-property
  142. :name
  143. (org-test-with-temp-text "#+NAME: para\nParagraph"
  144. (org-element-at-point)))))
  145. ;; Parse multiple keywords.
  146. (should
  147. (equal
  148. '("line1" "line2")
  149. (org-element-property
  150. :attr_ascii
  151. (org-test-with-temp-text
  152. "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph"
  153. (org-element-at-point)))))
  154. ;; Parse "parsed" keywords.
  155. (should
  156. (equal
  157. '(("caption"))
  158. (org-test-with-temp-text "#+CAPTION: caption\nParagraph"
  159. (car (org-element-property :caption (org-element-at-point))))))
  160. ;; Parse dual keywords.
  161. (should
  162. (equal
  163. '((("long") "short"))
  164. (org-test-with-temp-text "#+CAPTION[short]: long\nParagraph"
  165. (org-element-property :caption (org-element-at-point)))))
  166. ;; Allow multiple caption keywords.
  167. (should
  168. (equal
  169. '((("l1") "s1") (("l2") "s2"))
  170. (org-test-with-temp-text "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph"
  171. (org-element-property :caption (org-element-at-point))))))
  172. ;;;; Babel Call
  173. (ert-deftest test-org-element/babel-call-parser ()
  174. "Test `babel-call' parsing."
  175. ;; Standard test.
  176. (should
  177. (org-test-with-temp-text "#+CALL: test()"
  178. (org-element-map (org-element-parse-buffer) 'babel-call 'identity)))
  179. ;; Ignore case.
  180. (should
  181. (org-test-with-temp-text "#+call: test()"
  182. (org-element-map (org-element-parse-buffer) 'babel-call 'identity))))
  183. ;;;; Bold
  184. (ert-deftest test-org-element/bold-parser ()
  185. "Test `bold' parser."
  186. ;; Standard test.
  187. (should
  188. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  189. (org-test-with-temp-text "*bold*"
  190. (org-element-map (org-element-parse-buffer) 'bold 'identity nil t))))
  191. ;; Multi-line markup.
  192. (should
  193. (equal
  194. (org-element-contents
  195. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  196. (org-test-with-temp-text "*first line\nsecond line*"
  197. (org-element-map (org-element-parse-buffer) 'bold 'identity nil t))))
  198. '("first line\nsecond line"))))
  199. ;;;; Center Block
  200. (ert-deftest test-org-element/center-block-parser ()
  201. "Test `center-block' parser."
  202. ;; Standard test.
  203. (should
  204. (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
  205. (org-element-map (org-element-parse-buffer) 'center-block 'identity)))
  206. ;; Ignore case.
  207. (should
  208. (org-test-with-temp-text "#+begin_center\nText\n#+end_center"
  209. (org-element-map (org-element-parse-buffer) 'center-block 'identity)))
  210. ;; Test folded block.
  211. (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
  212. (org-cycle)
  213. (should
  214. (org-element-property
  215. :hiddenp
  216. (org-element-map
  217. (org-element-parse-buffer) 'center-block 'identity nil t))))
  218. ;; Ignore incomplete block.
  219. (should-not
  220. (org-test-with-temp-text "#+BEGIN_CENTER"
  221. (org-element-map
  222. (org-element-parse-buffer) 'center-block 'identity nil t))))
  223. ;;;; Clock
  224. (ert-deftest test-org-element/clock-parser ()
  225. "Test `clock' parser."
  226. ;; Running clock.
  227. (let* ((org-clock-string "CLOCK:")
  228. (clock (org-test-with-temp-text "CLOCK: [2012-01-01 sun. 00:01]"
  229. (org-element-map
  230. (org-element-parse-buffer) 'clock 'identity nil t))))
  231. (should (eq (org-element-property :status clock) 'running))
  232. (should (equal (org-element-property :value clock)
  233. "[2012-01-01 sun. 00:01]"))
  234. (should-not (org-element-property :time clock)))
  235. ;; Closed clock.
  236. (let* ((org-clock-string "CLOCK:")
  237. (clock (org-test-with-temp-text "
  238. CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"
  239. (org-element-map
  240. (org-element-parse-buffer) 'clock 'identity nil t))))
  241. (should (eq (org-element-property :status clock) 'closed))
  242. (should (equal (org-element-property :value clock)
  243. "[2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02]"))
  244. (should (equal (org-element-property :time clock) "0:01"))))
  245. ;;;; Code
  246. (ert-deftest test-org-element/code-parser ()
  247. "Test `code' parser."
  248. ;; Regular test.
  249. (should
  250. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  251. (org-test-with-temp-text "~code~"
  252. (org-element-map (org-element-parse-buffer) 'code 'identity))))
  253. ;; Multi-line markup.
  254. (should
  255. (equal
  256. (org-element-property
  257. :value
  258. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  259. (org-test-with-temp-text "~first line\nsecond line~"
  260. (org-element-map
  261. (org-element-parse-buffer) 'code 'identity nil t))))
  262. "first line\nsecond line")))
  263. ;;;; Comment
  264. (ert-deftest test-org-element/comment-parser ()
  265. "Test `comment' parser."
  266. ;; Regular comment.
  267. (should
  268. (org-test-with-temp-text "# Comment"
  269. (org-element-map (org-element-parse-buffer) 'comment 'identity)))
  270. ;; Inline comment.
  271. (should
  272. (org-test-with-temp-text " # Comment"
  273. (org-element-map (org-element-parse-buffer) 'comment 'identity)))
  274. ;; Preserve indentation.
  275. (should
  276. (equal
  277. (org-element-property
  278. :value
  279. (org-test-with-temp-text "# No blank\n# One blank"
  280. (org-element-map (org-element-parse-buffer) 'comment 'identity nil t)))
  281. "No blank\n One blank"))
  282. ;; Comment with blank lines.
  283. (should
  284. (equal
  285. (org-element-property
  286. :value
  287. (org-test-with-temp-text "# First part\n# \n#\n# Second part"
  288. (org-element-map (org-element-parse-buffer) 'comment 'identity nil t)))
  289. "First part\n\n\nSecond part"))
  290. ;; Do not mix comments and keywords.
  291. (should
  292. (eq 1
  293. (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
  294. (length (org-element-map
  295. (org-element-parse-buffer) 'comment 'identity)))))
  296. (should
  297. (equal "comment"
  298. (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
  299. (org-element-property
  300. :value
  301. (org-element-map
  302. (org-element-parse-buffer) 'comment 'identity nil t))))))
  303. ;;;; Comment Block
  304. (ert-deftest test-org-element/comment-block-parser ()
  305. "Test `comment-block' parser."
  306. ;; Standard test.
  307. (should
  308. (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
  309. (org-element-map
  310. (org-element-parse-buffer) 'comment-block 'identity)))
  311. ;; Ignore case.
  312. (should
  313. (org-test-with-temp-text "#+begin_comment\nText\n#+end_comment"
  314. (org-element-map
  315. (org-element-parse-buffer) 'comment-block 'identity)))
  316. ;; Test folded block.
  317. (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
  318. (org-cycle)
  319. (should
  320. (org-element-property
  321. :hiddenp
  322. (org-element-map
  323. (org-element-parse-buffer) 'comment-block 'identity nil t))))
  324. ;; Ignore incomplete block.
  325. (should-not
  326. (org-test-with-temp-text "#+BEGIN_COMMENT"
  327. (org-element-map
  328. (org-element-parse-buffer) 'comment-block 'identity nil t))))
  329. ;;;; Drawer
  330. (ert-deftest test-org-element/drawer-parser ()
  331. "Test `drawer' parser."
  332. ;; Standard test.
  333. (should
  334. (let ((org-drawers '("TEST")))
  335. (org-test-with-temp-text ":TEST:\nText\n:END:"
  336. (org-element-map (org-element-parse-buffer) 'drawer 'identity))))
  337. ;; Do not mix regular drawers and property drawers.
  338. (should-not
  339. (let ((org-drawers '("PROPERTIES")))
  340. (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
  341. (org-element-map
  342. (org-element-parse-buffer) 'drawer 'identity nil t))))
  343. ;; Ignore incomplete drawer.
  344. (should-not
  345. (let ((org-drawers '("TEST")))
  346. (org-test-with-temp-text ":TEST:"
  347. (org-element-map
  348. (org-element-parse-buffer) 'drawer 'identity nil t)))))
  349. ;;;; Dynamic Block
  350. (ert-deftest test-org-element/dynamic-block-parser ()
  351. "Test `dynamic-block' parser."
  352. ;; Standard test.
  353. (should
  354. (org-test-with-temp-text
  355. "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
  356. (org-element-map (org-element-parse-buffer) 'dynamic-block 'identity)))
  357. ;; Folded view
  358. (org-test-with-temp-text
  359. "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
  360. (org-cycle)
  361. (should
  362. (org-element-property
  363. :hiddenp
  364. (org-element-map
  365. (org-element-parse-buffer) 'dynamic-block 'identity nil t))))
  366. ;; Ignore case.
  367. (should
  368. (org-test-with-temp-text
  369. "#+begin: myblock :param1 val1 :param2 val2\nText\n#+end:"
  370. (org-element-map (org-element-parse-buffer) 'dynamic-block 'identity)))
  371. ;; Ignore incomplete block.
  372. (should-not
  373. (org-test-with-temp-text "#+BEGIN: myblock :param1 val1 :param2 val2"
  374. (org-element-map
  375. (org-element-parse-buffer) 'dynamic-block 'identity nil t))))
  376. ;;;; Entity
  377. (ert-deftest test-org-element/entity-parser ()
  378. "Test `entity' parser."
  379. ;; Without brackets.
  380. (should
  381. (org-test-with-temp-text "\\sin"
  382. (org-element-map (org-element-parse-buffer) 'entity 'identity)))
  383. ;; With brackets.
  384. (should
  385. (org-element-property
  386. :use-brackets-p
  387. (org-test-with-temp-text "\\alpha{}text"
  388. (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
  389. ;; User-defined entity.
  390. (should
  391. (equal
  392. (org-element-property
  393. :name
  394. (let ((org-entities-user
  395. '(("test" "test" nil "test" "test" "test" "test"))))
  396. (org-test-with-temp-text "\\test"
  397. (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
  398. "test")))
  399. ;;;; Example Block
  400. (ert-deftest test-org-element/example-block-parser ()
  401. "Test `example-block' parser."
  402. ;; Standard test.
  403. (should
  404. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
  405. (org-element-map (org-element-parse-buffer) 'example-block 'identity)))
  406. ;; Test folded block.
  407. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
  408. (org-cycle)
  409. (should
  410. (org-element-property
  411. :hiddenp
  412. (org-element-map
  413. (org-element-parse-buffer) 'example-block 'identity nil t))))
  414. ;; Ignore incomplete block.
  415. (should-not
  416. (org-test-with-temp-text "#+BEGIN_EXAMPLE"
  417. (org-element-map
  418. (org-element-parse-buffer) 'example-block 'identity nil t))))
  419. (ert-deftest test-org-element/block-switches ()
  420. "Test `example-block' and `src-block' switches parsing."
  421. (let ((org-coderef-label-format "(ref:%s)"))
  422. ;; 1. Test "-i" switch.
  423. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  424. (should-not
  425. (org-element-property :preserve-indent (org-element-at-point))))
  426. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"
  427. (should (org-element-property :preserve-indent (org-element-at-point))))
  428. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
  429. (should-not
  430. (org-element-property :preserve-indent (org-element-at-point))))
  431. (org-test-with-temp-text "#+BEGIN_EXAMPLE -i\nText.\n#+END_EXAMPLE"
  432. (should (org-element-property :preserve-indent (org-element-at-point))))
  433. ;; 2. "-n -r -k" combination should number lines, retain labels but
  434. ;; not use them in coderefs.
  435. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r -k\nText.\n#+END_EXAMPLE"
  436. (let ((element (org-element-at-point)))
  437. (should (and (org-element-property :number-lines element)
  438. (org-element-property :retain-labels element)
  439. (not (org-element-property :use-labels element))))))
  440. (org-test-with-temp-text
  441. "#+BEGIN_SRC emacs-lisp -n -r -k\n(+ 1 1)\n#+END_SRC"
  442. (let ((element (org-element-at-point)))
  443. (should (and (org-element-property :number-lines element)
  444. (org-element-property :retain-labels element)
  445. (not (org-element-property :use-labels element))))))
  446. ;; 3. "-n -r" combination should number-lines remove labels and not
  447. ;; use them in coderefs.
  448. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r\nText.\n#+END_EXAMPLE"
  449. (let ((element (org-element-at-point)))
  450. (should (and (org-element-property :number-lines element)
  451. (not (org-element-property :retain-labels element))
  452. (not (org-element-property :use-labels element))))))
  453. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1)\n#+END_SRC"
  454. (let ((element (org-element-at-point)))
  455. (should (and (org-element-property :number-lines element)
  456. (not (org-element-property :retain-labels element))
  457. (not (org-element-property :use-labels element))))))
  458. ;; 4. "-n" or "+n" should number lines, retain labels and use them
  459. ;; in coderefs.
  460. (org-test-with-temp-text "#+BEGIN_EXAMPLE -n\nText.\n#+END_EXAMPLE"
  461. (let ((element (org-element-at-point)))
  462. (should (and (org-element-property :number-lines element)
  463. (org-element-property :retain-labels element)
  464. (org-element-property :use-labels element)))))
  465. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1)\n#+END_SRC"
  466. (let ((element (org-element-at-point)))
  467. (should (and (org-element-property :number-lines element)
  468. (org-element-property :retain-labels element)
  469. (org-element-property :use-labels element)))))
  470. (org-test-with-temp-text "#+BEGIN_EXAMPLE +n\nText.\n#+END_EXAMPLE"
  471. (let ((element (org-element-at-point)))
  472. (should (and (org-element-property :number-lines element)
  473. (org-element-property :retain-labels element)
  474. (org-element-property :use-labels element)))))
  475. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp +n\n(+ 1 1)\n#+END_SRC"
  476. (let ((element (org-element-at-point)))
  477. (should (and (org-element-property :number-lines element)
  478. (org-element-property :retain-labels element)
  479. (org-element-property :use-labels element)))))
  480. ;; 5. No switch should not number lines, but retain labels and use
  481. ;; them in coderefs.
  482. (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
  483. (let ((element (org-element-at-point)))
  484. (should (and (not (org-element-property :number-lines element))
  485. (org-element-property :retain-labels element)
  486. (org-element-property :use-labels element)))))
  487. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  488. (let ((element (org-element-at-point)))
  489. (should (and (not (org-element-property :number-lines element))
  490. (org-element-property :retain-labels element)
  491. (org-element-property :use-labels element)))))
  492. ;; 6. "-r" switch only: do not number lines, remove labels, and
  493. ;; don't use labels in coderefs.
  494. (org-test-with-temp-text "#+BEGIN_EXAMPLE -r\nText.\n#+END_EXAMPLE"
  495. (let ((element (org-element-at-point)))
  496. (should (and (not (org-element-property :number-lines element))
  497. (not (org-element-property :retain-labels element))
  498. (not (org-element-property :use-labels element))))))
  499. (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1)\n#+END_SRC"
  500. (let ((element (org-element-at-point)))
  501. (should (and (not (org-element-property :number-lines element))
  502. (not (org-element-property :retain-labels element))
  503. (not (org-element-property :use-labels element))))))
  504. ;; 7. Recognize coderefs with user-defined syntax.
  505. (org-test-with-temp-text
  506. "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText [ref:text]\n#+END_EXAMPLE"
  507. (let ((element (org-element-at-point)))
  508. (should
  509. (equal (org-element-property :label-fmt element) "[ref:%s]"))))
  510. (org-test-with-temp-text
  511. "#+BEGIN_SRC emacs-lisp -l \"[ref:%s]\"\n(+ 1 1) [ref:text]\n#+END_SRC"
  512. (let ((element (org-element-at-point)))
  513. (should
  514. (equal (org-element-property :label-fmt element) "[ref:%s]"))))))
  515. ;;;; Export Block
  516. (ert-deftest test-org-element/export-block-parser ()
  517. "Test `export-block' parser."
  518. ;; Standard test.
  519. (should
  520. (org-test-with-temp-text "#+BEGIN_LATEX\nText\n#+END_LATEX"
  521. (org-element-map
  522. (let ((org-element-block-name-alist
  523. '(("LATEX" . org-element-export-block-parser))))
  524. (org-element-parse-buffer))
  525. 'export-block 'identity)))
  526. ;; Test folded block.
  527. (org-test-with-temp-text "#+BEGIN_LATEX\nText\n#+END_LATEX"
  528. (org-cycle)
  529. (should
  530. (org-element-property
  531. :hiddenp
  532. (org-element-map
  533. (let ((org-element-block-name-alist
  534. '(("LATEX" . org-element-export-block-parser))))
  535. (org-element-parse-buffer))
  536. 'export-block 'identity nil t))))
  537. ;; Ignore case.
  538. (should
  539. (org-test-with-temp-text "#+begin_latex\nText\n#+end_latex"
  540. (org-element-map
  541. (let ((org-element-block-name-alist
  542. '(("LATEX" . org-element-export-block-parser))))
  543. (org-element-parse-buffer))
  544. 'export-block 'identity)))
  545. ;; Ignore incomplete block.
  546. (should-not
  547. (org-test-with-temp-text "#+BEGIN_LATEX"
  548. (org-element-map
  549. (let ((org-element-block-name-alist
  550. '(("LATEX" . org-element-export-block-parser))))
  551. (org-element-parse-buffer))
  552. 'export-block 'identity nil t))))
  553. ;;;; Export Snippet
  554. (ert-deftest test-org-element/export-snippet-parser ()
  555. "Test `export-snippet' parser."
  556. (should
  557. (equal
  558. '("back-end" . "contents")
  559. (org-test-with-temp-text "@@back-end:contents@@"
  560. (org-element-map
  561. (org-element-parse-buffer) 'export-snippet
  562. (lambda (snippet) (cons (org-element-property :back-end snippet)
  563. (org-element-property :value snippet)))
  564. nil t)))))
  565. ;;;; Fixed Width
  566. (ert-deftest test-org-element/fixed-width ()
  567. "Test fixed-width area parsing."
  568. ;; Preserve indentation.
  569. (should
  570. (org-test-with-temp-text ": no blank\n: one blank"
  571. (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
  572. ;; Fixed-width with empty lines.
  573. (should
  574. (org-test-with-temp-text ": first part\n:\n: \n: second part"
  575. (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
  576. ;; Parse indented fixed-width markers.
  577. (should
  578. (org-test-with-temp-text "Text\n : no blank\n : one blank"
  579. (org-element-map (org-element-parse-buffer) 'fixed-width 'identity)))
  580. ;; Distinguish fixed-width areas within a list and outside of it.
  581. (should
  582. (= 2
  583. (length
  584. (org-test-with-temp-text "
  585. - Item
  586. : fixed-width inside
  587. : fixed-width outside"
  588. (org-element-map
  589. (org-element-parse-buffer) 'fixed-width 'identity))))))
  590. ;;;; Footnote Definition
  591. (ert-deftest test-org-element/footnote-definition-parser ()
  592. "Test `footnote-definition' parser."
  593. (should
  594. (org-test-with-temp-text "[fn:1] Definition"
  595. (org-element-map
  596. (org-element-parse-buffer) 'footnote-definition 'identity nil t)))
  597. ;; Footnote with more contents
  598. (should
  599. (= 28
  600. (org-element-property
  601. :end
  602. (org-test-with-temp-text "[fn:1] Definition\n| a | b |"
  603. (org-element-map
  604. (org-element-parse-buffer)
  605. 'footnote-definition 'identity nil t)))))
  606. ;; Footnote starting with special syntax.
  607. (should-not
  608. (org-test-with-temp-text "[fn:1] - no item"
  609. (org-element-map (org-element-parse-buffer) 'item 'identity))))
  610. ;;;; Footnotes Reference.
  611. (ert-deftest test-org-element/footnote-reference-parser ()
  612. "Test `footnote-reference' parser."
  613. ;; 1. Parse a standard reference.
  614. (org-test-with-temp-text "Text[fn:label]"
  615. (should
  616. (org-element-map
  617. (org-element-parse-buffer) 'footnote-reference 'identity)))
  618. ;; 2. Parse a normalized reference.
  619. (org-test-with-temp-text "Text[1]"
  620. (should
  621. (org-element-map
  622. (org-element-parse-buffer) 'footnote-reference 'identity)))
  623. ;; 3. Parse an inline reference.
  624. (org-test-with-temp-text "Text[fn:test:def]"
  625. (should
  626. (org-element-map
  627. (org-element-parse-buffer) 'footnote-reference 'identity)))
  628. ;; 4. Parse an anonymous reference.
  629. (org-test-with-temp-text "Text[fn::def]"
  630. (should
  631. (org-element-map
  632. (org-element-parse-buffer) 'footnote-reference 'identity)))
  633. ;; 5. Parse nested footnotes.
  634. (org-test-with-temp-text "Text[fn::def [fn:label]]"
  635. (should
  636. (= 2
  637. (length
  638. (org-element-map
  639. (org-element-parse-buffer) 'footnote-reference 'identity)))))
  640. ;; 6. Parse adjacent footnotes.
  641. (org-test-with-temp-text "Text[fn:label1][fn:label2]"
  642. (should
  643. (= 2
  644. (length
  645. (org-element-map
  646. (org-element-parse-buffer) 'footnote-reference 'identity)))))
  647. ;; 7. Only properly closed footnotes are recognized as such.
  648. (org-test-with-temp-text "Text[fn:label"
  649. (should-not
  650. (org-element-map
  651. (org-element-parse-buffer) 'footnote-reference 'identity))))
  652. ;;;; Headline
  653. (ert-deftest test-org-element/headline-quote-keyword ()
  654. "Test QUOTE keyword recognition."
  655. ;; Reference test.
  656. (org-test-with-temp-text "* Headline"
  657. (let ((org-quote-string "QUOTE"))
  658. (should-not (org-element-property :quotedp (org-element-at-point)))))
  659. ;; Standard position.
  660. (org-test-with-temp-text "* QUOTE Headline"
  661. (let ((org-quote-string "QUOTE"))
  662. (let ((headline (org-element-at-point)))
  663. (should (org-element-property :quotedp headline))
  664. ;; Test removal from raw value.
  665. (should (equal (org-element-property :raw-value headline) "Headline"))))
  666. ;; Case sensitivity.
  667. (let ((org-quote-string "Quote"))
  668. (should-not (org-element-property :quotedp (org-element-at-point)))))
  669. ;; With another keyword.
  670. (org-test-with-temp-text "* TODO QUOTE Headline"
  671. (let ((org-quote-string "QUOTE")
  672. (org-todo-keywords '((sequence "TODO" "DONE"))))
  673. (should (org-element-property :quotedp (org-element-at-point))))))
  674. (ert-deftest test-org-element/headline-comment-keyword ()
  675. "Test COMMENT keyword recognition."
  676. ;; Reference test.
  677. (org-test-with-temp-text "* Headline"
  678. (let ((org-comment-string "COMMENT"))
  679. (should-not (org-element-property :commentedp (org-element-at-point)))))
  680. ;; Standard position.
  681. (org-test-with-temp-text "* COMMENT Headline"
  682. (let ((org-comment-string "COMMENT"))
  683. (let ((headline (org-element-at-point)))
  684. (should (org-element-property :commentedp headline))
  685. ;; Test removal from raw value.
  686. (should (equal (org-element-property :raw-value headline) "Headline"))))
  687. ;; Case sensitivity.
  688. (let ((org-comment-string "Comment"))
  689. (should-not (org-element-property :commentedp (org-element-at-point)))))
  690. ;; With another keyword.
  691. (org-test-with-temp-text "* TODO COMMENT Headline"
  692. (let ((org-comment-string "COMMENT")
  693. (org-todo-keywords '((sequence "TODO" "DONE"))))
  694. (should (org-element-property :commentedp (org-element-at-point))))))
  695. (ert-deftest test-org-element/headline-archive-tag ()
  696. "Test ARCHIVE tag recognition."
  697. ;; Reference test.
  698. (org-test-with-temp-text "* Headline"
  699. (let ((org-archive-tag "ARCHIVE"))
  700. (should-not (org-element-property :archivedp (org-element-at-point)))))
  701. ;; Single tag.
  702. (org-test-with-temp-text "* Headline :ARCHIVE:"
  703. (let ((org-archive-tag "ARCHIVE"))
  704. (let ((headline (org-element-at-point)))
  705. (should (org-element-property :archivedp headline))
  706. ;; Test tag removal.
  707. (should-not (org-element-property :tags headline))))
  708. (let ((org-archive-tag "Archive"))
  709. (should-not (org-element-property :archivedp (org-element-at-point)))))
  710. ;; Multiple tags.
  711. (org-test-with-temp-text "* Headline :test:ARCHIVE:"
  712. (let ((org-archive-tag "ARCHIVE"))
  713. (let ((headline (org-element-at-point)))
  714. (should (org-element-property :archivedp headline))
  715. ;; Test tag removal.
  716. (should (equal (org-element-property :tags headline) '("test")))))))
  717. ;;;; Horizontal Rule
  718. (ert-deftest test-org-element/horizontal-rule-parser ()
  719. "Test `horizontal-rule' parser."
  720. ;; Standard.
  721. (should
  722. (org-test-with-temp-text "-----"
  723. (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
  724. ;; Indented.
  725. (should
  726. (org-test-with-temp-text " -----"
  727. (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
  728. ;; Hyphen must be alone on the line.
  729. (should-not
  730. (org-test-with-temp-text "-----wrong"
  731. (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
  732. ;; 4 hyphens is too small.
  733. (should-not
  734. (org-test-with-temp-text "----"
  735. (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity))))
  736. ;;;; Inline Babel Call
  737. (ert-deftest test-org-element/inline-babel-call-parser ()
  738. "Test `inline-babel-call' parser."
  739. (should
  740. (org-test-with-temp-text "call_test()"
  741. (org-element-map
  742. (org-element-parse-buffer) 'inline-babel-call 'identity))))
  743. ;;;; Inline Src Block
  744. (ert-deftest test-org-element/inline-src-block-parser ()
  745. "Test `inline-src-block' parser."
  746. (should
  747. (org-test-with-temp-text "src_emacs-lisp{(+ 1 1)}"
  748. (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity))))
  749. ;;;; Inlinetask
  750. (ert-deftest test-org-element/inlinetask-parser ()
  751. "Test `inlinetask' parser."
  752. (when (featurep 'org-inlinetask)
  753. (let ((org-inlinetask-min-level 15))
  754. ;; 1. Regular inlinetask.
  755. (should
  756. (org-test-with-temp-text
  757. "*************** Task\nTest\n*************** END"
  758. (org-element-map (org-element-parse-buffer) 'inlinetask 'identity)))
  759. ;; 2. Degenerate inlinetask.
  760. (should
  761. (org-test-with-temp-text "*************** Task"
  762. (org-element-map (org-element-parse-buffer) 'inlinetask 'identity)))
  763. ;; TODO keyword.
  764. (should
  765. (equal
  766. "TODO"
  767. (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  768. (org-test-with-temp-text "*************** TODO Task"
  769. (org-element-property
  770. :todo-keyword
  771. (org-element-map
  772. (org-element-parse-buffer) 'inlinetask 'identity nil t))))))
  773. ;; Planning info.
  774. (should
  775. (equal
  776. "2012-03-29 thu."
  777. (org-test-with-temp-text "
  778. *************** Task
  779. DEADLINE: <2012-03-29 thu.>"
  780. (org-element-property
  781. :deadline
  782. (org-element-map
  783. (org-element-parse-buffer) 'inlinetask 'identity nil t)))))
  784. ;; Priority.
  785. (should
  786. (equal
  787. ?A
  788. (org-test-with-temp-text "
  789. *************** [#A] Task"
  790. (org-element-property
  791. :priority
  792. (org-element-map
  793. (org-element-parse-buffer) 'inlinetask 'identity nil t)))))
  794. ;; Tags.
  795. (should
  796. (equal
  797. '("test")
  798. (org-test-with-temp-text "
  799. *************** Task :test:"
  800. (org-element-property
  801. :tags
  802. (org-element-map
  803. (org-element-parse-buffer) 'inlinetask 'identity nil t))))))))
  804. ;;;; Italic
  805. (ert-deftest test-org-element/italic-parser ()
  806. "Test `italic' parser."
  807. ;; Regular test.
  808. (should
  809. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  810. (org-test-with-temp-text "/italic/"
  811. (org-element-map (org-element-parse-buffer) 'italic 'identity nil t))))
  812. ;; Multi-line markup.
  813. (should
  814. (equal
  815. (org-element-contents
  816. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  817. (org-test-with-temp-text "/first line\nsecond line/"
  818. (org-element-map (org-element-parse-buffer) 'italic 'identity nil t))))
  819. '("first line\nsecond line"))))
  820. ;;;; Item
  821. (ert-deftest test-org-element/item-parser ()
  822. "Test `item' parser."
  823. ;; Standard test.
  824. (should
  825. (org-test-with-temp-text "- item"
  826. (org-element-map (org-element-parse-buffer) 'item 'identity)))
  827. ;; Counter.
  828. (should
  829. (= 6
  830. (org-element-property
  831. :counter
  832. (org-test-with-temp-text "6. [@6] item"
  833. (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
  834. ;; Tag
  835. (should
  836. (equal
  837. '("tag")
  838. (org-element-property
  839. :tag
  840. (org-test-with-temp-text "- tag :: description"
  841. (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
  842. ;; No tags in ordered lists.
  843. (should-not
  844. (org-element-property
  845. :tag
  846. (org-test-with-temp-text "1. tag :: description"
  847. (org-element-map (org-element-parse-buffer) 'item 'identity nil t))))
  848. ;; Check-boxes
  849. (should
  850. (equal
  851. '(trans on off)
  852. (org-test-with-temp-text "
  853. - [-] item 1
  854. - [X] item 1.1
  855. - [ ] item 1.2"
  856. (org-element-map
  857. (org-element-parse-buffer) 'item
  858. (lambda (item) (org-element-property :checkbox item))))))
  859. ;; Folded state.
  860. (org-test-with-temp-text "* Headline
  861. - item
  862. paragraph below"
  863. (forward-line)
  864. (let ((org-cycle-include-plain-lists t)) (org-cycle))
  865. (should
  866. (org-element-property
  867. :hiddenp
  868. (org-element-map (org-element-parse-buffer) 'item 'identity nil t))))
  869. ;; Item starting with special syntax.
  870. (should
  871. (equal '(("- item"))
  872. (org-test-with-temp-text "- - item"
  873. (org-element-map
  874. (org-element-parse-buffer) 'paragraph 'org-element-contents)))))
  875. ;;;; Keyword
  876. (ert-deftest test-org-element/keyword-parser ()
  877. "Test `keyword' parser."
  878. ;; Standard test.
  879. (should
  880. (org-test-with-temp-text "#+KEYWORD: value"
  881. (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
  882. ;; Keywords are case-insensitive.
  883. (should
  884. (org-test-with-temp-text "#+keyword: value"
  885. (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
  886. ;; Affiliated keywords are not keywords.
  887. (should-not
  888. (org-test-with-temp-text "#+NAME: value
  889. Paragraph"
  890. (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
  891. ;; Do not mix keywords with Babel calls and dynamic blocks.
  892. (should-not
  893. (org-test-with-temp-text "#+CALL: fun()"
  894. (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
  895. (should-not
  896. (org-test-with-temp-text "#+BEGIN: my-fun\nBody\n#+END:"
  897. (org-element-map (org-element-parse-buffer) 'keyword 'identity))))
  898. ;;;; Latex Environment
  899. (ert-deftest test-org-element/latex-environment-parser ()
  900. "Test `latex-environment' parser."
  901. (should
  902. (org-test-with-temp-text "\\begin{equation}\ne^{i\\pi}+1=0\n\\end{equation}"
  903. (org-element-map
  904. (org-element-parse-buffer) 'latex-environment 'identity)))
  905. ;; Allow nested environments.
  906. (should
  907. (equal
  908. "\\begin{outer}
  909. \\begin{inner}
  910. e^{i\\pi}+1=0
  911. \\end{inner}
  912. \\end{outer}"
  913. (org-test-with-temp-text "
  914. \\begin{outer}
  915. \\begin{inner}
  916. e^{i\\pi}+1=0
  917. \\end{inner}
  918. \\end{outer}"
  919. (org-element-property
  920. :value
  921. (org-element-map
  922. (org-element-parse-buffer) 'latex-environment 'identity nil t))))))
  923. ;;;; Latex Fragment
  924. (ert-deftest test-org-element/latex-fragment-parser ()
  925. "Test `latex-fragment' parser."
  926. (let ((org-latex-regexps
  927. '(("begin" "^[ ]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^�]+?\\\\end{\\2}\\)" 1 t)
  928. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \n,;.$]\\$\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  929. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \n,;.$][^$\n ]*?\\(\n[^$\n ]*?\\)\\{0,2\\}[^ \n,.$]\\)\\$\\)\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  930. ("\\(" "\\\\([^�]*?\\\\)" 0 nil)
  931. ("\\[" "\\\\\\[[^�]*?\\\\\\]" 0 nil)
  932. ("$$" "\\$\\$[^�]*?\\$\\$" 0 nil))))
  933. (should
  934. (org-test-with-temp-text "$a$"
  935. (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
  936. (should
  937. (org-test-with-temp-text "$$a$$"
  938. (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
  939. (should
  940. (org-test-with-temp-text "\\(a\\)"
  941. (org-element-map (org-element-parse-buffer) 'latex-fragment 'identity)))
  942. (should
  943. (org-test-with-temp-text "\\[a\\]"
  944. (org-element-map
  945. (org-element-parse-buffer) 'latex-fragment 'identity)))))
  946. ;;;; Line Break
  947. (ert-deftest test-org-element/line-break-parser ()
  948. "Test `line-break' parser."
  949. ;; Regular test.
  950. (should
  951. (org-test-with-temp-text "Text \\\\"
  952. (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
  953. ;; Line break with trailing white spaces.
  954. (should
  955. (org-test-with-temp-text "Text \\\\ "
  956. (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
  957. ;; Three backslashes are too much.
  958. (should-not
  959. (org-test-with-temp-text "Text \\\\\\"
  960. (org-element-map (org-element-parse-buffer) 'line-break 'identity))))
  961. ;;;; Link
  962. (ert-deftest test-org-element/link-parser ()
  963. "Test `link' parser."
  964. ;; 1. Radio target.
  965. (should
  966. (equal
  967. "radio"
  968. (org-test-with-temp-text "A radio link"
  969. (org-element-property
  970. :type
  971. (org-element-map
  972. (let ((org-target-link-regexp "radio")) (org-element-parse-buffer))
  973. 'link 'identity nil t)))))
  974. ;; 2. Standard link.
  975. ;;
  976. ;; 2.1. With description.
  977. (should
  978. (equal
  979. '("Orgmode.org")
  980. (org-test-with-temp-text "[[http://orgmode.org][Orgmode.org]]"
  981. (org-element-contents
  982. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  983. ;; 2.2. Without description.
  984. (should
  985. (equal
  986. "http"
  987. (org-test-with-temp-text "[[http://orgmode.org]]"
  988. (org-element-property
  989. :type
  990. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  991. ;; 2.3. With expansion.
  992. (should
  993. (equal
  994. "//orgmode.org/worg"
  995. (org-test-with-temp-text "[[Org:worg]]"
  996. (let ((org-link-abbrev-alist '(("Org" . "http://orgmode.org/"))))
  997. (org-element-property
  998. :path
  999. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))))))
  1000. ;; 2.4. With translation.
  1001. (should
  1002. (equal
  1003. "127.0.0.1"
  1004. (org-test-with-temp-text "[[http://orgmode.org]]"
  1005. (flet ((link-translate (type path) (cons type "127.0.0.1")))
  1006. (let ((org-link-translation-function 'link-translate))
  1007. (org-element-property
  1008. :path
  1009. (org-element-map
  1010. (org-element-parse-buffer) 'link 'identity nil t)))))))
  1011. ;; 2.5. Id link.
  1012. (should
  1013. (equal
  1014. "id"
  1015. (org-test-with-temp-text "[[id:aaaa]]"
  1016. (org-element-property
  1017. :type
  1018. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1019. ;; 2.6. Custom-id link.
  1020. (should
  1021. (equal
  1022. "custom-id"
  1023. (org-test-with-temp-text "[[#some-id]]"
  1024. (org-element-property
  1025. :type
  1026. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1027. ;; 2.7 Coderef link.
  1028. (should
  1029. (equal
  1030. "coderef"
  1031. (org-test-with-temp-text "[[(reference)]]"
  1032. (org-element-property
  1033. :type
  1034. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1035. ;; 2.8 Fuzzy link.
  1036. (should
  1037. (equal
  1038. "fuzzy"
  1039. (org-test-with-temp-text "[[target-or-title]]"
  1040. (org-element-property
  1041. :type
  1042. (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
  1043. ;; 2.9 File-type link with search option.
  1044. (should
  1045. (equal
  1046. '(("file" "projects.org" "*task title"))
  1047. (org-test-with-temp-text "[[file:projects.org::*task title]]"
  1048. (org-element-map
  1049. (org-element-parse-buffer) 'link
  1050. (lambda (l) (list (org-element-property :type l)
  1051. (org-element-property :path l)
  1052. (org-element-property :search-option l)))))))
  1053. ;; 2.10 File-type link with application.
  1054. (should
  1055. (equal
  1056. '(("file" "projects.org" "docview"))
  1057. (org-test-with-temp-text "[[docview:projects.org]]"
  1058. (org-element-map
  1059. (org-element-parse-buffer) 'link
  1060. (lambda (l) (list (org-element-property :type l)
  1061. (org-element-property :path l)
  1062. (org-element-property :application l)))))))
  1063. ;; 3. Plain link.
  1064. (should
  1065. (org-test-with-temp-text "A link: http://orgmode.org"
  1066. (org-element-map (org-element-parse-buffer) 'link 'identity)))
  1067. ;; 4. Angular link.
  1068. (should
  1069. (org-test-with-temp-text "A link: <http://orgmode.org>"
  1070. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))))
  1071. ;;;; Macro
  1072. (ert-deftest test-org-element/macro-parser ()
  1073. "Test `macro' parser."
  1074. ;; Without arguments.
  1075. (should
  1076. (org-test-with-temp-text "{{{macro}}}"
  1077. (org-element-map (org-element-parse-buffer) 'macro 'identity)))
  1078. ;; With arguments.
  1079. (should
  1080. (org-test-with-temp-text "{{{macro(arg1,arg2)}}}"
  1081. (org-element-map (org-element-parse-buffer) 'macro 'identity))))
  1082. ;;;; Paragraph
  1083. (ert-deftest test-org-element/paragraph-parser ()
  1084. "Test `paragraph' parser."
  1085. ;; Standard test.
  1086. (should
  1087. (org-test-with-temp-text "Paragraph"
  1088. (org-element-map (org-element-parse-buffer) 'paragraph 'identity nil t)))
  1089. ;; Property find end of a paragraph stuck to another element.
  1090. (should
  1091. (eq ?#
  1092. (org-test-with-temp-text "Paragraph\n# Comment"
  1093. (org-element-map
  1094. (org-element-parse-buffer) 'paragraph
  1095. (lambda (p) (char-after (org-element-property :end p)))
  1096. nil t))))
  1097. ;; Include ill-formed Keywords.
  1098. (should
  1099. (org-test-with-temp-text "#+wrong_keyword something"
  1100. (org-element-map (org-element-parse-buffer) 'paragraph 'identity)))
  1101. ;; Include incomplete-drawers.
  1102. (should
  1103. (let ((org-drawers '("TEST")))
  1104. (org-test-with-temp-text ":TEST:\nParagraph"
  1105. (let ((elem (org-element-at-point)))
  1106. (and (eq (org-element-type elem) 'paragraph)
  1107. (= (point-max) (org-element-property :end elem)))))))
  1108. ;; Include non-existent drawers.
  1109. (should
  1110. (let ((org-drawers '("TEST")))
  1111. (org-test-with-temp-text ":NONAME:"
  1112. (org-element-map (org-element-parse-buffer) 'paragraph 'identity))))
  1113. ;; Include incomplete blocks.
  1114. (should
  1115. (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph"
  1116. (let ((elem (org-element-at-point)))
  1117. (and (eq (org-element-type elem) 'paragraph)
  1118. (= (point-max) (org-element-property :end elem))))))
  1119. ;; Include incomplete dynamic blocks.
  1120. (should
  1121. (org-test-with-temp-text "#+BEGIN: \nParagraph"
  1122. (let ((elem (org-element-at-point)))
  1123. (and (eq (org-element-type elem) 'paragraph)
  1124. (= (point-max) (org-element-property :end elem))))))
  1125. ;; Include incomplete latex environments.
  1126. (should
  1127. (org-test-with-temp-text "\begin{equation}\nParagraph"
  1128. (let ((elem (org-element-at-point)))
  1129. (and (eq (org-element-type elem) 'paragraph)
  1130. (= (point-max) (org-element-property :end elem))))))
  1131. ;; Do not steal affiliated keywords from container.
  1132. (should
  1133. (org-test-with-temp-text "#+ATTR_LATEX: test\n- item 1"
  1134. (let ((elem (progn (search-forward "item") (org-element-at-point))))
  1135. (and (eq (org-element-type elem) 'paragraph)
  1136. (not (org-element-property :attr_latex elem))
  1137. (/= (org-element-property :begin elem) 1))))))
  1138. ;;;; Plain List
  1139. (ert-deftest test-org-element/plain-list-parser ()
  1140. "Test `plain-list' parser."
  1141. (should
  1142. (org-test-with-temp-text "- item"
  1143. (org-element-map (org-element-parse-buffer) 'plain-list 'identity)))
  1144. ;; Blank lines after the list only belong to outer plain list.
  1145. (org-test-with-temp-text "
  1146. - outer
  1147. - inner
  1148. Outside list"
  1149. (let ((endings (org-element-map
  1150. (org-element-parse-buffer) 'plain-list
  1151. (lambda (pl) (org-element-property :end pl)))))
  1152. ;; Move to ending of outer list.
  1153. (goto-char (car endings))
  1154. (should (looking-at "Outside list"))
  1155. ;; Move to ending of inner list.
  1156. (goto-char (nth 1 endings))
  1157. (should (looking-at "^$")))))
  1158. ;;;; Planning
  1159. (ert-deftest test-org-element/planning-parser ()
  1160. "Test `planning' parser."
  1161. (should
  1162. (equal
  1163. (org-element-property
  1164. :closed
  1165. (org-test-with-temp-text "CLOSED: [2012-03-29 thu.]"
  1166. (org-element-map (org-element-parse-buffer) 'planning 'identity nil t)))
  1167. "2012-03-29 thu."))
  1168. (should
  1169. (equal
  1170. (org-element-property
  1171. :deadline
  1172. (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>"
  1173. (org-element-map (org-element-parse-buffer) 'planning 'identity nil t)))
  1174. "2012-03-29 thu."))
  1175. (should
  1176. (equal
  1177. (org-element-property
  1178. :scheduled
  1179. (org-test-with-temp-text "SCHEDULED: <2012-03-29 thu.>"
  1180. (org-element-map (org-element-parse-buffer) 'planning 'identity nil t)))
  1181. "2012-03-29 thu.")))
  1182. ;;;; Property Drawer
  1183. (ert-deftest test-org-element/property-drawer ()
  1184. "Test `property-drawer' parser."
  1185. ;; Standard test.
  1186. (should
  1187. (let ((org-drawers '("PROPERTIES")))
  1188. (org-test-with-temp-text ":PROPERTIES:\n:prop: value\n:END:"
  1189. (org-element-map
  1190. (org-element-parse-buffer) 'property-drawer 'identity nil t))))
  1191. ;; Do not mix property drawers and regular drawers.
  1192. (should-not
  1193. (let ((org-drawers '("TEST")))
  1194. (org-test-with-temp-text ":TEST:\n:prop: value\n:END:"
  1195. (org-element-map
  1196. (org-element-parse-buffer) 'property-drawer 'identity nil t))))
  1197. ;; Ignore incomplete drawer.
  1198. (should-not
  1199. (let ((org-drawers '("PROPERTIES")))
  1200. (org-test-with-temp-text ":PROPERTIES:\n:prop: value"
  1201. (org-element-map
  1202. (org-element-parse-buffer) 'property-drawer 'identity nil t)))))
  1203. ;;;; Quote Block
  1204. (ert-deftest test-org-element/quote-block-parser ()
  1205. "Test `quote-block' parser."
  1206. ;; Regular test.
  1207. (should
  1208. (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
  1209. (org-element-map (org-element-parse-buffer) 'quote-block 'identity)))
  1210. ;; Test folded block.
  1211. (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
  1212. (org-cycle)
  1213. (should
  1214. (org-element-property
  1215. :hiddenp
  1216. (org-element-map
  1217. (org-element-parse-buffer) 'quote-block 'identity nil t))))
  1218. ;; Ignore incomplete block.
  1219. (should-not
  1220. (org-test-with-temp-text "#+BEGIN_QUOTE"
  1221. (org-element-map
  1222. (org-element-parse-buffer) 'quote-block 'identity nil t))))
  1223. ;;;; Quote Section
  1224. (ert-deftest test-org-element/quote-section-parser ()
  1225. "Test `quote-section' parser."
  1226. (should
  1227. (let ((org-quote-string "QUOTE"))
  1228. (org-test-with-temp-text "* QUOTE Headline\nBody"
  1229. (org-element-map (org-element-parse-buffer) 'quote-section 'identity))))
  1230. (should-not
  1231. (let ((org-quote-string "TEST"))
  1232. (org-test-with-temp-text "* QUOTE Headline\nBody"
  1233. (org-element-map (org-element-parse-buffer) 'quote-section 'identity)))))
  1234. ;;;; Radio Target
  1235. (ert-deftest test-org-element/radio-target-parser ()
  1236. "Test `radio-target' parser."
  1237. ;; Standard test.
  1238. (should
  1239. (org-test-with-temp-text "<<<radio>>>"
  1240. (org-element-map (org-element-parse-buffer) 'radio-target 'identity)))
  1241. ;; Radio targets with objects.
  1242. (should
  1243. (org-test-with-temp-text "<<<radio \\alpha>>>"
  1244. (org-element-map (org-element-parse-buffer) 'radio-target 'identity))))
  1245. ;;;; Section
  1246. (ert-deftest test-org-element/section-parser ()
  1247. "Test `section' parser."
  1248. ;; Standard test.
  1249. (should
  1250. (org-test-with-temp-text "* Headline\nText"
  1251. (org-element-map (org-element-parse-buffer) 'section 'identity)))
  1252. ;; There's a section before the first headline.
  1253. (should
  1254. (org-test-with-temp-text "Text"
  1255. (org-element-map (org-element-parse-buffer) 'section 'identity)))
  1256. ;; A section cannot be empty.
  1257. (should-not
  1258. (org-test-with-temp-text "* Headline 1\n* Headline 2"
  1259. (org-element-map (org-element-parse-buffer) 'section 'identity)))
  1260. ;; A section doesn't contain sub-trees.
  1261. (should-not
  1262. (org-test-with-temp-text "* Head\nText\n** Sub-Head"
  1263. (org-element-map
  1264. (org-element-map (org-element-parse-buffer) 'section 'identity nil t)
  1265. 'headline 'identity))))
  1266. ;;;; Special Block
  1267. (ert-deftest test-org-element/special-block-parser ()
  1268. "Test `special-block' parser."
  1269. ;; Standard test.
  1270. (let ((special-block
  1271. (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
  1272. (org-element-map
  1273. (org-element-parse-buffer) 'special-block 'identity nil t))))
  1274. (should (equal (org-element-property :type special-block) "SPECIAL"))
  1275. (should (org-element-map special-block 'paragraph 'identity)))
  1276. ;; Test folded block.
  1277. (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
  1278. (org-cycle)
  1279. (should
  1280. (org-element-property
  1281. :hiddenp
  1282. (org-element-map
  1283. (org-element-parse-buffer) 'special-block 'identity nil t))))
  1284. ;; Ignore incomplete block.
  1285. (should-not
  1286. (org-test-with-temp-text "#+BEGIN_SPECIAL"
  1287. (org-element-map
  1288. (org-element-parse-buffer) 'special-block 'identity nil t))))
  1289. ;;;; Src Block
  1290. (ert-deftest test-org-element/src-block-parser ()
  1291. "Test `src-block' parser."
  1292. ;; Regular tests.
  1293. (should
  1294. (org-test-with-temp-text "#+BEGIN_SRC\nText\n#+END_SRC"
  1295. (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
  1296. ;; Test folded block.
  1297. (org-test-with-temp-text "#+BEGIN_SRC\nText\n#+END_SRC"
  1298. (org-cycle)
  1299. (should
  1300. (org-element-property
  1301. :hiddenp
  1302. (org-element-map
  1303. (org-element-parse-buffer) 'src-block 'identity nil t))))
  1304. ;; Ignore incomplete block.
  1305. (should-not
  1306. (org-test-with-temp-text "#+BEGIN_SRC"
  1307. (org-element-map (org-element-parse-buffer) 'src-block 'identity))))
  1308. ;;;; Statistics Cookie
  1309. (ert-deftest test-org-element/statistics-cookie ()
  1310. "Test `statistics-cookie' parser."
  1311. ;; With numbers.
  1312. (should
  1313. (org-test-with-temp-text "[1/2]"
  1314. (org-element-map (org-element-parse-buffer) 'statistics-cookie 'identity)))
  1315. ;; With percents.
  1316. (should
  1317. (org-test-with-temp-text "[33%]"
  1318. (org-element-map
  1319. (org-element-parse-buffer) 'statistics-cookie 'identity))))
  1320. ;;;; Strike Through
  1321. (ert-deftest test-org-element/strike-through-parser ()
  1322. "Test `strike-through' parser."
  1323. ;; Regular test.
  1324. (should
  1325. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1326. (org-test-with-temp-text "+strike-through+"
  1327. (org-element-map (org-element-parse-buffer) 'strike-through 'identity))))
  1328. ;; Multi-line markup.
  1329. (should
  1330. (equal
  1331. (org-element-contents
  1332. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1333. (org-test-with-temp-text "+first line\nsecond line+"
  1334. (org-element-map
  1335. (org-element-parse-buffer) 'strike-through 'identity nil t))))
  1336. '("first line\nsecond line"))))
  1337. ;;;; Subscript
  1338. (ert-deftest test-org-element/subscript-parser ()
  1339. "Test `subscript' parser."
  1340. ;; Without braces.
  1341. (should
  1342. (org-test-with-temp-text "a_b"
  1343. (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
  1344. ;; With braces.
  1345. (should
  1346. (org-test-with-temp-text "a_{b}"
  1347. (org-element-map (org-element-parse-buffer) 'subscript 'identity))))
  1348. ;;;; Superscript
  1349. (ert-deftest test-org-element/superscript-parser ()
  1350. "Test `superscript' parser."
  1351. ;; Without braces.
  1352. (should
  1353. (org-test-with-temp-text "a^b"
  1354. (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
  1355. ;; With braces.
  1356. (should
  1357. (org-test-with-temp-text "a^{b}"
  1358. (org-element-map (org-element-parse-buffer) 'superscript 'identity))))
  1359. ;;;; Table
  1360. (ert-deftest test-org-element/table-parser ()
  1361. "Test `table' parser."
  1362. (should
  1363. (org-test-with-temp-text "| a |"
  1364. (org-element-map (org-element-parse-buffer) 'table 'identity)))
  1365. ;; TBLFM keyword is case insensitive.
  1366. (should
  1367. (org-test-with-temp-text "| a |\n#+tblfm: test"
  1368. (org-element-property
  1369. :tblfm
  1370. (org-element-map (org-element-parse-buffer) 'table 'identity nil t))))
  1371. ;; Handle multiple TBLFM lines.
  1372. (should
  1373. (= 2
  1374. (org-test-with-temp-text "| a |\n#+TBLFM: test1\n#+TBLFM: test2"
  1375. (length (org-element-property
  1376. :tblfm
  1377. (org-element-map
  1378. (org-element-parse-buffer) 'table 'identity nil t)))))))
  1379. ;;;; Table Cell
  1380. (ert-deftest test-org-element/table-cell-parser ()
  1381. "Test `table-cell' parser."
  1382. (should
  1383. (org-test-with-temp-text "| a |"
  1384. (org-element-map (org-element-parse-buffer) 'table-cell 'identity))))
  1385. ;;;; Table Row
  1386. (ert-deftest test-org-element/table-row-parser ()
  1387. "Test `table-row' parser."
  1388. (should
  1389. (equal '(standard rule)
  1390. (org-test-with-temp-text "| a |\n|---|"
  1391. (org-element-map
  1392. (org-element-parse-buffer) 'table-row
  1393. (lambda (row) (org-element-property :type row)))))))
  1394. ;;;; Target
  1395. (ert-deftest test-org-element/target-parser ()
  1396. "Test `target' parser."
  1397. (should
  1398. (org-test-with-temp-text "<<target>>"
  1399. (org-element-map (org-element-parse-buffer) 'target 'identity))))
  1400. ;;;; Timestamp
  1401. (ert-deftest test-org-element/timestamp ()
  1402. "Test `timestamp' parser."
  1403. ;; Active timestamp.
  1404. (should
  1405. (org-test-with-temp-text "<2012-03-29 16:40>"
  1406. (eq (org-element-property :type
  1407. (org-element-map
  1408. (org-element-parse-buffer)
  1409. 'timestamp 'identity nil t))
  1410. 'active)))
  1411. ;; Inactive timestamp.
  1412. (should
  1413. (org-test-with-temp-text "[2012-03-29 16:40]"
  1414. (eq (org-element-property :type
  1415. (org-element-map
  1416. (org-element-parse-buffer)
  1417. 'timestamp 'identity nil t))
  1418. 'inactive)))
  1419. ;; Date range.
  1420. (should
  1421. (org-test-with-temp-text "[2012-03-29 16:40]--[2012-03-29 16:41]"
  1422. (eq (org-element-property :type
  1423. (org-element-map
  1424. (org-element-parse-buffer)
  1425. 'timestamp 'identity nil t))
  1426. 'inactive-range)))
  1427. ;; Timestamps are not planning elements.
  1428. (should-not
  1429. (org-test-with-temp-text "SCHEDULED: <2012-03-29 16:40>"
  1430. (org-element-map (org-element-parse-buffer) 'timestamp 'identity))))
  1431. ;;;; Underline
  1432. (ert-deftest test-org-element/underline-parser ()
  1433. "Test `underline' parser."
  1434. ;; Regular test.
  1435. (should
  1436. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1437. (org-test-with-temp-text "_underline_"
  1438. (org-element-map (org-element-parse-buffer) 'underline 'identity))))
  1439. ;; Multi-line markup.
  1440. (should
  1441. (equal
  1442. (org-element-contents
  1443. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1444. (org-test-with-temp-text "_first line\nsecond line_"
  1445. (org-element-map
  1446. (org-element-parse-buffer) 'underline 'identity nil t))))
  1447. '("first line\nsecond line"))))
  1448. ;;;; Verbatim
  1449. (ert-deftest test-org-element/verbatim-parser ()
  1450. "Test `verbatim' parser."
  1451. ;; Regular test.
  1452. (should
  1453. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1454. (org-test-with-temp-text "=verbatim="
  1455. (org-element-map (org-element-parse-buffer) 'verbatim 'identity))))
  1456. ;; Multi-line markup.
  1457. (should
  1458. (equal
  1459. (org-element-property
  1460. :value
  1461. (let ((org-emph-re "\\([ ('\"{]\\|^\\)\\(\\([+*/_=~]\\)\\([^ \n,\"']\\|[^ \n,\"'].*?\\(?:\n.*?\\)\\{0,1\\}[^ \n,\"']\\)\\3\\)\\([- .,:!?;'\")}\\]\\|$\\)"))
  1462. (org-test-with-temp-text "=first line\nsecond line="
  1463. (org-element-map
  1464. (org-element-parse-buffer) 'verbatim 'identity nil t))))
  1465. "first line\nsecond line")))
  1466. ;;;; Verse Block
  1467. (ert-deftest test-org-element/verse-block-parser ()
  1468. "Test `verse-block' parser."
  1469. ;; Standard test.
  1470. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
  1471. (should
  1472. (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
  1473. ;; Ignore case.
  1474. (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
  1475. (should
  1476. (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
  1477. ;; Parse folding.
  1478. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
  1479. (org-hide-block-all)
  1480. (should
  1481. (org-element-property
  1482. :hiddenp
  1483. (org-element-map
  1484. (org-element-parse-buffer) 'verse-block 'identity nil t))))
  1485. ;; Parse objects in verse blocks.
  1486. (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
  1487. (should (org-element-map (org-element-parse-buffer) 'entity 'identity)))
  1488. ;; Ignore incomplete verse block.
  1489. (should-not
  1490. (org-test-with-temp-text "#+BEGIN_VERSE"
  1491. (org-element-map
  1492. (org-element-parse-buffer) 'verse-block 'identity nil t))))
  1493. ;;; Test Interpreters.
  1494. (ert-deftest test-org-element/affiliated-keywords-interpreter ()
  1495. "Test if affiliated keywords are correctly interpreted."
  1496. ;; Interpret simple keywords.
  1497. (should
  1498. (equal
  1499. (org-element-interpret-data
  1500. '(org-data nil (paragraph (:name "para") "Paragraph")))
  1501. "#+NAME: para\nParagraph\n"))
  1502. ;; Interpret multiple keywords.
  1503. (should
  1504. (equal
  1505. (org-element-interpret-data
  1506. '(org-data nil (paragraph (:attr_ascii ("line1" "line2")) "Paragraph")))
  1507. "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph\n"))
  1508. ;; Interpret parsed keywords.
  1509. (should
  1510. (equal
  1511. (org-element-interpret-data
  1512. '(org-data nil (paragraph (:caption (("caption"))) "Paragraph")))
  1513. "#+CAPTION: caption\nParagraph\n"))
  1514. ;; Interpret dual keywords.
  1515. (should
  1516. (equal
  1517. (org-element-interpret-data
  1518. '(org-data nil (paragraph (:caption ((("long") "short"))) "Paragraph")))
  1519. "#+CAPTION[short]: long\nParagraph\n"))
  1520. ;; Interpret multiple parsed dual keywords.
  1521. (should
  1522. (equal
  1523. (org-element-interpret-data
  1524. '(org-data nil (paragraph
  1525. (:caption ((("l1") "s1") (("l2") "s2"))) "Paragraph")))
  1526. "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph\n")))
  1527. (ert-deftest test-org-element/center-block-interpreter ()
  1528. "Test center block interpreter."
  1529. (should
  1530. (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
  1531. "#+BEGIN_CENTER\nTest\n#+END_CENTER\n")))
  1532. (ert-deftest test-org-element/drawer-interpreter ()
  1533. "Test drawer interpreter."
  1534. (should
  1535. (equal (let ((org-drawers '("TEST")))
  1536. (org-test-parse-and-interpret ":TEST:\nTest\n:END:"))
  1537. ":TEST:\nTest\n:END:\n")))
  1538. (ert-deftest test-org-element/dynamic-block-interpreter ()
  1539. "Test dynamic block interpreter."
  1540. (should
  1541. (equal (org-test-parse-and-interpret
  1542. "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
  1543. "#+BEGIN: myblock :parameter value1\nTest\n#+END:\n")))
  1544. (ert-deftest test-org-element/footnote-definition-interpreter ()
  1545. "Test footnote definition interpreter."
  1546. (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n")))
  1547. (ert-deftest test-org-element/headline-interpreter ()
  1548. "Test headline and section interpreters."
  1549. ;; 1. Standard test.
  1550. (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
  1551. ;; 2. With TODO keywords.
  1552. (should
  1553. (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  1554. (org-test-parse-and-interpret "* TODO Headline"))
  1555. "* TODO Headline\n"))
  1556. ;; 3. With tags...
  1557. ;;
  1558. ;; 3.1. ... and a positive `org-tags-column' value.
  1559. (should
  1560. (equal (let ((org-tags-column 20))
  1561. (org-test-parse-and-interpret "* Headline :tag:"))
  1562. "* Headline :tag:\n"))
  1563. ;; 3.2. ... and a negative `org-tags-column' value.
  1564. (should
  1565. (equal (let ((org-tags-column -20))
  1566. (org-test-parse-and-interpret "* Headline :tag:"))
  1567. "* Headline :tag:\n"))
  1568. ;; 3.3. ... and a null `org-tags-column' value.
  1569. (should
  1570. (equal (let ((org-tags-column 0))
  1571. (org-test-parse-and-interpret "* Headline :tag:"))
  1572. "* Headline :tag:\n"))
  1573. ;; 4. With priority cookie.
  1574. (should
  1575. (equal (org-test-parse-and-interpret "* [#B] Headline")
  1576. "* [#B] Headline\n"))
  1577. ;; 5. With comment keyword.
  1578. (should
  1579. (equal (let ((org-comment-string "COMMENT"))
  1580. (org-test-parse-and-interpret "* COMMENT Headline"))
  1581. "* COMMENT Headline\n"))
  1582. ;; 6. With quote section.
  1583. (should
  1584. (equal (let ((org-quote-string "QUOTE"))
  1585. (org-test-parse-and-interpret "* QUOTE Headline"))
  1586. "* QUOTE Headline\n"))
  1587. ;; 7. Keep same number of blank lines before body.
  1588. (should
  1589. (equal (org-test-parse-and-interpret
  1590. "* Headline\n\n\nText after two blank lines.")
  1591. "* Headline\n\n\nText after two blank lines.\n")))
  1592. (ert-deftest test-org-element/inlinetask-interpreter ()
  1593. "Test inlinetask interpretation."
  1594. (when (featurep 'org-inlinetask)
  1595. (let ((org-inlinetask-min-level 15))
  1596. ;; 1. Regular inlinetask.
  1597. (should (equal (org-test-parse-and-interpret
  1598. "*************** Task\nTest\n*************** END")
  1599. "*************** Task\nTest\n*************** END\n"))
  1600. ;; 2. Degenerate inlinetask.
  1601. (should (equal (org-test-parse-and-interpret "*************** Task")
  1602. "*************** Task\n"))
  1603. ;; 3. Prefer degenerate form when there are no contents.
  1604. (should (equal (org-test-parse-and-interpret
  1605. "*************** Task\n*************** END")
  1606. "*************** Task\n"))
  1607. ;; 4. With TODO keywords.
  1608. (should
  1609. (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  1610. (org-test-parse-and-interpret "*************** TODO Task"))
  1611. "*************** TODO Task\n"))
  1612. ;; 5. With tags...
  1613. ;;
  1614. ;; 5.1. ... and a positive `org-tags-column' value.
  1615. (should
  1616. (equal (let ((org-tags-column 30))
  1617. (org-test-parse-and-interpret "*************** Task :tag:"))
  1618. "*************** Task :tag:\n"))
  1619. ;; 5.2. ... and a negative `org-tags-column' value.
  1620. (should
  1621. (equal (let ((org-tags-column -30))
  1622. (org-test-parse-and-interpret "*************** Task :tag:"))
  1623. "*************** Task :tag:\n"))
  1624. ;; 5.3. ... and a null `org-tags-column' value.
  1625. (should
  1626. (equal (let ((org-tags-column 0))
  1627. (org-test-parse-and-interpret "*************** Task :tag:"))
  1628. "*************** Task :tag:\n"))
  1629. ;; 6. With priority cookie.
  1630. (should
  1631. (equal (org-test-parse-and-interpret "*************** [#B] Task")
  1632. "*************** [#B] Task\n")))))
  1633. (ert-deftest test-org-element/plain-list-interpreter ()
  1634. "Test plain-list and item interpreters."
  1635. (let ((org-list-two-spaces-after-bullet-regexp nil))
  1636. ;; 1. Unordered list.
  1637. (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
  1638. ;; 2. Description list.
  1639. (should
  1640. (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
  1641. ;; 3. Ordered list.
  1642. (should
  1643. (equal (let ((org-plain-list-ordered-item-terminator t))
  1644. (org-test-parse-and-interpret "1. Item"))
  1645. "1. Item\n"))
  1646. ;; 4. Ordered list with counter.
  1647. (should
  1648. (equal (let ((org-plain-list-ordered-item-terminator t))
  1649. (org-test-parse-and-interpret "1. [@5] Item"))
  1650. "5. [@5] Item\n"))
  1651. ;; 5. List with check-boxes.
  1652. (should
  1653. (equal (org-test-parse-and-interpret
  1654. "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
  1655. "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n"))
  1656. ;; 6. Item not starting with a paragraph.
  1657. (should
  1658. (equal (org-test-parse-and-interpret "-\n | a | b |")
  1659. "- \n | a | b |\n"))))
  1660. (ert-deftest test-org-element/quote-block-interpreter ()
  1661. "Test quote block interpreter."
  1662. (should (equal (org-test-parse-and-interpret
  1663. "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
  1664. "#+BEGIN_QUOTE\nTest\n#+END_QUOTE\n")))
  1665. (ert-deftest test-org-element/special-block-interpreter ()
  1666. "Test special block interpreter."
  1667. (should (equal (org-test-parse-and-interpret
  1668. "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
  1669. "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL\n")))
  1670. (ert-deftest test-org-element/babel-call-interpreter ()
  1671. "Test babel call interpreter."
  1672. ;; 1. Without argument.
  1673. (should (equal (org-test-parse-and-interpret "#+CALL: test()")
  1674. "#+CALL: test()\n"))
  1675. ;; 2. With argument.
  1676. (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
  1677. "#+CALL: test(x=2)\n"))
  1678. ;; 3. With header arguments.
  1679. (should (equal (org-test-parse-and-interpret
  1680. "#+CALL: test[:results output]()[:results html]")
  1681. "#+CALL: test[:results output]()[:results html]\n")))
  1682. (ert-deftest test-org-element/clock-interpreter ()
  1683. "Test clock interpreter."
  1684. ;; Running clock.
  1685. (should
  1686. (equal (let ((org-clock-string "CLOCK:"))
  1687. (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]"))
  1688. "CLOCK: [2012-01-01 sun. 00:01]\n"))
  1689. ;; Closed clock.
  1690. (should
  1691. (equal
  1692. (let ((org-clock-string "CLOCK:"))
  1693. (org-test-parse-and-interpret "
  1694. CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))
  1695. "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01\n")))
  1696. (ert-deftest test-org-element/comment-interpreter ()
  1697. "Test comment interpreter."
  1698. ;; Regular comment.
  1699. (should (equal (org-test-parse-and-interpret "# Comment") "# Comment\n"))
  1700. ;; Inline comment.
  1701. (should (equal (org-test-parse-and-interpret " # Comment")
  1702. "# Comment\n"))
  1703. ;; Preserve indentation.
  1704. (should (equal (org-test-parse-and-interpret " # No blank\n# One blank")
  1705. "# No blank\n# One blank\n")))
  1706. (ert-deftest test-org-element/comment-block-interpreter ()
  1707. "Test comment block interpreter."
  1708. (should (equal (org-test-parse-and-interpret
  1709. "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
  1710. "#+BEGIN_COMMENT\nTest\n#+END_COMMENT\n")))
  1711. (ert-deftest test-org-element/example-block-interpreter ()
  1712. "Test example block interpreter."
  1713. ;; Without switches.
  1714. (should (equal (org-test-parse-and-interpret
  1715. "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE")
  1716. "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE\n"))
  1717. ;; With switches.
  1718. (should
  1719. (equal (org-test-parse-and-interpret
  1720. "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE")
  1721. "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE\n")))
  1722. (ert-deftest test-org-element/export-block-interpreter ()
  1723. "Test export block interpreter."
  1724. (should (equal (org-test-parse-and-interpret
  1725. "#+BEGIN_HTML\nTest\n#+END_HTML")
  1726. "#+BEGIN_HTML\nTest\n#+END_HTML\n")))
  1727. (ert-deftest test-org-element/fixed-width-interpreter ()
  1728. "Test fixed width interpreter."
  1729. ;; Standard test.
  1730. (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
  1731. ;; Preserve indentation.
  1732. (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
  1733. ": 2 blanks\n: 1 blank\n")))
  1734. (ert-deftest test-org-element/horizontal-rule-interpreter ()
  1735. "Test horizontal rule interpreter."
  1736. (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
  1737. (ert-deftest test-org-element/keyword-interpreter ()
  1738. "Test keyword interpreter."
  1739. (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
  1740. "#+KEYWORD: value\n")))
  1741. (ert-deftest test-org-element/latex-environment-interpreter ()
  1742. "Test latex environment interpreter."
  1743. (should (equal (org-test-parse-and-interpret
  1744. "\\begin{equation}\n1+1=2\n\\end{equation}")
  1745. "\\begin{equation}\n1+1=2\n\\end{equation}\n")))
  1746. (ert-deftest test-org-element/planning-interpreter ()
  1747. "Test planning interpreter."
  1748. (let ((org-closed-string "CLOSED:")
  1749. (org-deadline-string "DEADLINE:")
  1750. (org-scheduled-string "SCHEDULED:"))
  1751. (should
  1752. (equal
  1753. (org-test-parse-and-interpret
  1754. "* Headline
  1755. CLOSED: [2012-01-01] DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01>")
  1756. "* Headline
  1757. CLOSED: [2012-01-01] DEADLINE: <2012-01-01> SCHEDULED: <2012-01-01>\n"))))
  1758. (ert-deftest test-org-element/property-drawer-interpreter ()
  1759. "Test property drawer interpreter."
  1760. (should (equal (let ((org-property-format "%-10s %s"))
  1761. (org-test-parse-and-interpret
  1762. ":PROPERTIES:\n:prop: value\n:END:"))
  1763. ":PROPERTIES:\n:prop: value\n:END:\n")))
  1764. (ert-deftest test-org-element/src-block-interpreter ()
  1765. "Test src block interpreter."
  1766. ;; With arguments.
  1767. (should
  1768. (equal (let ((org-edit-src-content-indentation 2))
  1769. (org-test-parse-and-interpret
  1770. "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC"))
  1771. "#+BEGIN_SRC emacs-lisp :results silent\n (+ 1 1)\n#+END_SRC\n"))
  1772. ;; With switches.
  1773. (should
  1774. (equal (let ((org-edit-src-content-indentation 2))
  1775. (org-test-parse-and-interpret
  1776. "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC"))
  1777. "#+BEGIN_SRC emacs-lisp -n -k\n (+ 1 1)\n#+END_SRC\n")))
  1778. (ert-deftest test-org-element/table-interpreter ()
  1779. "Test table, table-row and table-cell interpreters."
  1780. ;; 1. Simple table.
  1781. (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
  1782. "| a | b |\n| c | d |\n"))
  1783. ;; 2. With horizontal rules.
  1784. (should (equal (org-test-parse-and-interpret
  1785. "| a | b |\n|---+---|\n| c | d |")
  1786. "| a | b |\n|---+---|\n| c | d |\n"))
  1787. ;; 3. With meta-data.
  1788. (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
  1789. "| / | < | > |\n| * | 1 | 2 |\n"))
  1790. ;; 4. With a formula.
  1791. (should
  1792. (equal (org-test-parse-and-interpret
  1793. "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)")
  1794. "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)\n"))
  1795. ;; 5. With multiple formulas.
  1796. (should
  1797. (equal (org-test-parse-and-interpret
  1798. "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2")
  1799. "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2\n")))
  1800. (ert-deftest test-org-element/timestamp-interpreter ()
  1801. "Test timestamp interpreter."
  1802. ;; Active.
  1803. (should (equal (org-test-parse-and-interpret "<2012-03-29 16:40>")
  1804. "<2012-03-29 16:40>\n"))
  1805. ;; Inactive.
  1806. (should (equal (org-test-parse-and-interpret "[2012-03-29 16:40]")
  1807. "[2012-03-29 16:40]\n"))
  1808. ;; Active range.
  1809. (should (equal (org-test-parse-and-interpret
  1810. "<2012-03-29 16:40>--<2012-03-29 16:41>")
  1811. "<2012-03-29 16:40>--<2012-03-29 16:41>\n"))
  1812. ;; Inactive range.
  1813. (should (equal (org-test-parse-and-interpret
  1814. "[2012-03-29 16:40]--[2012-03-29 16:41]")
  1815. "[2012-03-29 16:40]--[2012-03-29 16:41]\n"))
  1816. ;; Diary.
  1817. (should (equal (org-test-parse-and-interpret "<%%org-float t 4 2>")
  1818. "<%%org-float t 4 2>\n"))
  1819. ;; Timestamp with repeater interval.
  1820. (should (equal (org-test-parse-and-interpret "<2012-03-29 +1y>")
  1821. "<2012-03-29 +1y>\n")))
  1822. (ert-deftest test-org-element/verse-block-interpreter ()
  1823. "Test verse block interpretation."
  1824. (should
  1825. (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
  1826. "#+BEGIN_VERSE\nTest\n#+END_VERSE\n")))
  1827. (ert-deftest test-org-element/bold-interpreter ()
  1828. "Test bold interpreter."
  1829. (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
  1830. (ert-deftest test-org-element/code-interpreter ()
  1831. "Test code interpreter."
  1832. (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
  1833. (ert-deftest test-org-element/entity-interpreter ()
  1834. "Test entity interpreter."
  1835. ;; 1. Without brackets.
  1836. (should
  1837. (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
  1838. ;; 2. With brackets.
  1839. (should
  1840. (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
  1841. (ert-deftest test-org-element/export-snippet-interpreter ()
  1842. "Test export snippet interpreter."
  1843. (should (equal (org-test-parse-and-interpret "@@back-end:contents@@")
  1844. "@@back-end:contents@@\n")))
  1845. (ert-deftest test-org-element/footnote-reference-interpreter ()
  1846. "Test footnote reference interpreter."
  1847. ;; 1. Regular reference.
  1848. (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
  1849. ;; 2. Normalized reference.
  1850. (should (equal (org-test-parse-and-interpret "Text[1]") "Text[1]\n"))
  1851. ;; 3. Named reference.
  1852. (should (equal (org-test-parse-and-interpret "Text[fn:label]")
  1853. "Text[fn:label]\n"))
  1854. ;; 4. Inline reference.
  1855. (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
  1856. "Text[fn:label:def]\n"))
  1857. ;; 5. Anonymous reference.
  1858. (should (equal (org-test-parse-and-interpret "Text[fn::def]")
  1859. "Text[fn::def]\n")))
  1860. (ert-deftest test-org-element/inline-babel-call-interpreter ()
  1861. "Test inline babel call interpreter."
  1862. ;; 1. Without arguments.
  1863. (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
  1864. ;; 2. With arguments.
  1865. (should (equal (org-test-parse-and-interpret "call_test(x=2)")
  1866. "call_test(x=2)\n"))
  1867. ;; 3. With header arguments.
  1868. (should (equal (org-test-parse-and-interpret
  1869. "call_test[:results output]()[:results html]")
  1870. "call_test[:results output]()[:results html]\n")))
  1871. (ert-deftest test-org-element/inline-src-block-interpreter ()
  1872. "Test inline src block interpreter."
  1873. ;; 1. Without header argument.
  1874. (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
  1875. "src_emacs-lisp{(+ 1 1)}\n"))
  1876. ;; 2. With header arguments.
  1877. (should (equal (org-test-parse-and-interpret
  1878. "src_emacs-lisp[:results silent]{(+ 1 1)}")
  1879. "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
  1880. (ert-deftest test-org-element/italic-interpreter ()
  1881. "Test italic interpreter."
  1882. (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
  1883. (ert-deftest test-org-element/latex-fragment-interpreter ()
  1884. "Test latex fragment interpreter."
  1885. (let ((org-latex-regexps
  1886. '(("begin" "^[ ]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^�]+?\\\\end{\\2}\\)" 1 t)
  1887. ("$1" "\\([^$]\\|^\\)\\(\\$[^ \n,;.$]\\$\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  1888. ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \n,;.$][^$\n ]*?\\(\n[^$\n ]*?\\)\\{0,2\\}[^ \n,.$]\\)\\$\\)\\)\\([- .,?;:'\")�]\\|$\\)" 2 nil)
  1889. ("\\(" "\\\\([^�]*?\\\\)" 0 nil)
  1890. ("\\[" "\\\\\\[[^�]*?\\\\\\]" 0 nil)
  1891. ("$$" "\\$\\$[^�]*?\\$\\$" 0 nil))))
  1892. (should (equal (org-test-parse-and-interpret "\\command{}")
  1893. "\\command{}\n"))
  1894. (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
  1895. (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
  1896. (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
  1897. (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
  1898. (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n"))))
  1899. (ert-deftest test-org-element/line-break-interpreter ()
  1900. "Test line break interpreter."
  1901. (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
  1902. "First line \\\\\nSecond line\n")))
  1903. (ert-deftest test-org-element/link-interpreter ()
  1904. "Test link interpreter."
  1905. ;; 1. Links targeted from a radio target.
  1906. (should (equal (let ((org-target-link-regexp "radio-target"))
  1907. (org-test-parse-and-interpret "a radio-target"))
  1908. "a radio-target\n"))
  1909. ;; 2. Regular links.
  1910. ;;
  1911. ;; 2.1. Without description.
  1912. (should (equal (org-test-parse-and-interpret "[[http://orgmode.org]]")
  1913. "[[http://orgmode.org]]\n"))
  1914. ;; 2.2. With a description.
  1915. (should (equal (org-test-parse-and-interpret
  1916. "[[http://orgmode.org][Org mode]]")
  1917. "[[http://orgmode.org][Org mode]]\n"))
  1918. ;; 2.3. Id links.
  1919. (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
  1920. ;; 2.4. Custom-id links.
  1921. (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
  1922. ;; 2.5 Code-ref links.
  1923. (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
  1924. ;; 3. Normalize plain links.
  1925. (should (equal (org-test-parse-and-interpret "http://orgmode.org")
  1926. "[[http://orgmode.org]]\n"))
  1927. ;; 4. Normalize angular links.
  1928. (should (equal (org-test-parse-and-interpret "<http://orgmode.org>")
  1929. "[[http://orgmode.org]]\n")))
  1930. (ert-deftest test-org-element/macro-interpreter ()
  1931. "Test macro interpreter."
  1932. ;; 1. Without argument.
  1933. (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
  1934. ;; 2. With arguments.
  1935. (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
  1936. "{{{test(arg1,arg2)}}}\n")))
  1937. (ert-deftest test-org-element/radio-target-interpreter ()
  1938. "Test radio target interpreter."
  1939. (should (equal (org-test-parse-and-interpret "<<<some text>>>")
  1940. "<<<some text>>>\n")))
  1941. (ert-deftest test-org-element/statistics-cookie-interpreter ()
  1942. "Test statistics cookie interpreter."
  1943. ;; 1. Without percent
  1944. (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
  1945. ;; 2. With percent.
  1946. (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
  1947. (ert-deftest test-org-element/strike-through-interpreter ()
  1948. "Test strike through interpreter."
  1949. (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
  1950. (ert-deftest test-org-element/subscript-interpreter ()
  1951. "Test subscript interpreter."
  1952. ;; 1. Without brackets.
  1953. (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
  1954. ;; 2. With brackets.
  1955. (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
  1956. (ert-deftest test-org-element/superscript-interpreter ()
  1957. "Test superscript interpreter."
  1958. ;; 1. Without brackets.
  1959. (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
  1960. ;; 2. With brackets.
  1961. (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
  1962. (ert-deftest test-org-element/target-interpreter ()
  1963. "Test target interpreter."
  1964. (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
  1965. (ert-deftest test-org-element/underline-interpreter ()
  1966. "Test underline interpreter."
  1967. (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
  1968. (ert-deftest test-org-element/verbatim-interpreter ()
  1969. "Test verbatim interpreter."
  1970. (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
  1971. ;;; Test Granularity
  1972. (ert-deftest test-org-element/granularity ()
  1973. "Test granularity impact on buffer parsing."
  1974. (org-test-with-temp-text "
  1975. * Head 1
  1976. ** Head 2
  1977. #+BEGIN_CENTER
  1978. Centered paragraph.
  1979. #+END_CENTER
  1980. Paragraph \\alpha."
  1981. ;; 1.1. Granularity set to `headline' should parse every headline
  1982. ;; in buffer, and only them.
  1983. (let ((tree (org-element-parse-buffer 'headline)))
  1984. (should (= 2 (length (org-element-map tree 'headline 'identity))))
  1985. (should-not (org-element-map tree 'paragraph 'identity)))
  1986. ;; 1.2. Granularity set to `greater-element' should not enter
  1987. ;; greater elements excepted headlines and sections.
  1988. (let ((tree (org-element-parse-buffer 'greater-element)))
  1989. (should (= 1 (length (org-element-map tree 'center-block 'identity))))
  1990. (should (= 1 (length (org-element-map tree 'paragraph 'identity))))
  1991. (should-not (org-element-map tree 'entity 'identity)))
  1992. ;; 1.3. Granularity set to `element' should enter every
  1993. ;; greater-element.
  1994. (let ((tree (org-element-parse-buffer 'element)))
  1995. (should (= 2 (length (org-element-map tree 'paragraph 'identity))))
  1996. (should-not (org-element-map tree 'entity 'identity)))
  1997. ;; 1.4. Granularity set to `object' can see everything.
  1998. (let ((tree (org-element-parse-buffer 'object)))
  1999. (should (= 1 (length (org-element-map tree 'entity 'identity)))))))
  2000. (ert-deftest test-org-element/secondary-string-parsing ()
  2001. "Test if granularity correctly toggles secondary strings parsing."
  2002. ;; 1. With a granularity bigger than `object', no secondary string
  2003. ;; should be parsed.
  2004. ;;
  2005. ;; 1.1. Test with `headline' type.
  2006. (org-test-with-temp-text "* Headline"
  2007. (let ((headline
  2008. (org-element-map (org-element-parse-buffer 'headline) 'headline
  2009. 'identity
  2010. nil
  2011. 'first-match)))
  2012. (should (stringp (org-element-property :title headline)))))
  2013. ;; 1.2. Test with `item' type.
  2014. (org-test-with-temp-text "* Headline\n- tag :: item"
  2015. (let ((item (org-element-map (org-element-parse-buffer 'element)
  2016. 'item
  2017. 'identity
  2018. nil
  2019. 'first-match)))
  2020. (should (stringp (org-element-property :tag item)))))
  2021. ;; 1.3. Test with `inlinetask' type, if avalaible.
  2022. (when (featurep 'org-inlinetask)
  2023. (let ((org-inlinetask-min-level 15))
  2024. (org-test-with-temp-text "*************** Inlinetask"
  2025. (let ((inlinetask (org-element-map (org-element-parse-buffer 'element)
  2026. 'inlinetask
  2027. 'identity
  2028. nil
  2029. 'first-match)))
  2030. (should (stringp (org-element-property :title inlinetask)))))))
  2031. ;; 2. With a default granularity, secondary strings should be
  2032. ;; parsed.
  2033. (org-test-with-temp-text "* Headline"
  2034. (let ((headline
  2035. (org-element-map (org-element-parse-buffer) 'headline
  2036. 'identity
  2037. nil
  2038. 'first-match)))
  2039. (should (listp (org-element-property :title headline)))))
  2040. ;; 3. `org-element-at-point' should never parse a secondary string.
  2041. (org-test-with-temp-text "* Headline"
  2042. (should (stringp (org-element-property :title (org-element-at-point))))))
  2043. ;;; Test `:parent' Property
  2044. (ert-deftest test-org-element/parent-property ()
  2045. "Test `:parent' property."
  2046. ;; Elements.
  2047. (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
  2048. (let* ((tree (org-element-parse-buffer))
  2049. (parent (org-element-property
  2050. :parent
  2051. (org-element-map tree 'paragraph 'identity nil t))))
  2052. (should parent)
  2053. (should (eq (org-element-map tree 'center-block 'identity nil t)
  2054. parent))))
  2055. ;; Objects.
  2056. (org-test-with-temp-text "a_{/b/}"
  2057. (let* ((tree (org-element-parse-buffer))
  2058. (parent (org-element-property
  2059. :parent
  2060. (org-element-map tree 'italic 'identity nil t))))
  2061. (should parent)
  2062. (should (eq parent
  2063. (org-element-map tree 'subscript 'identity nil t)))))
  2064. ;; Secondary strings
  2065. (org-test-with-temp-text "* /italic/"
  2066. (let* ((tree (org-element-parse-buffer))
  2067. (parent (org-element-property
  2068. :parent (org-element-map tree 'italic 'identity nil t))))
  2069. (should parent)
  2070. (should (eq parent
  2071. (org-element-map tree 'headline 'identity nil t))))))
  2072. ;;; Test Normalize Contents
  2073. (ert-deftest test-org-element/normalize-contents ()
  2074. "Test `org-element-normalize-contents' specifications."
  2075. ;; 1. Remove maximum common indentation from element's contents.
  2076. (should
  2077. (equal
  2078. (org-element-normalize-contents
  2079. '(paragraph nil " Two spaces\n Three spaces"))
  2080. '(paragraph nil "Two spaces\n Three spaces")))
  2081. ;; 2. Ignore objects within contents when computing maximum common
  2082. ;; indentation.
  2083. (should
  2084. (equal
  2085. (org-element-normalize-contents
  2086. '(paragraph nil " One " (emphasis nil "space") "\n Two spaces"))
  2087. '(paragraph nil "One " (emphasis nil "space") "\n Two spaces")))
  2088. ;; 3. Ignore blank lines.
  2089. (should
  2090. (equal
  2091. (org-element-normalize-contents
  2092. '(paragraph nil " Two spaces\n\n \n Two spaces"))
  2093. '(paragraph nil "Two spaces\n\n \nTwo spaces")))
  2094. ;; 4. Recursively enter objects in order to compute common
  2095. ;; indentation.
  2096. (should
  2097. (equal
  2098. (org-element-normalize-contents
  2099. '(paragraph nil " Two spaces " (bold nil " and\n One space")))
  2100. '(paragraph nil " Two spaces " (bold nil " and\nOne space"))))
  2101. ;; 5. When optional argument is provided, ignore first line
  2102. ;; indentation.
  2103. (should
  2104. (equal
  2105. (org-element-normalize-contents
  2106. '(paragraph nil "No space\n Two spaces\n Three spaces") t)
  2107. '(paragraph nil "No space\nTwo spaces\n Three spaces"))))
  2108. ;;; Test Navigation Tools.
  2109. (ert-deftest test-org-element/at-point ()
  2110. "Test `org-element-at-point' specifications."
  2111. ;; Return closest element containing point.
  2112. (should
  2113. (eq 'paragraph
  2114. (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
  2115. (progn (search-forward "A")
  2116. (org-element-type (org-element-at-point))))))
  2117. ;; Correctly set `:parent' property.
  2118. (should
  2119. (eq 'center-block
  2120. (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
  2121. (progn (search-forward "A")
  2122. (org-element-type
  2123. (org-element-property :parent (org-element-at-point)))))))
  2124. ;; Special case: at the very beginning of a table, return `table'
  2125. ;; object instead of `table-row'.
  2126. (should
  2127. (eq 'table
  2128. (org-test-with-temp-text "| a | b |"
  2129. (org-element-type (org-element-at-point)))))
  2130. ;; Special case: at the very beginning of a list or sub-list, return
  2131. ;; `plain-list' object instead of `item'.
  2132. (should
  2133. (eq 'plain-list
  2134. (org-test-with-temp-text "- item"
  2135. (org-element-type (org-element-at-point)))))
  2136. ;; Special case: at the closing line of a greater element, be sure
  2137. ;; to return it instead of the last element in its contents.
  2138. (should
  2139. (eq 'center-block
  2140. (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph\n#+END_CENTER"
  2141. (progn (forward-line 2)
  2142. (org-element-type (org-element-at-point))))))
  2143. ;; Special case: at a blank line between two items, be sure to
  2144. ;; return item above instead of the last element of its contents.
  2145. (should
  2146. (eq 'item
  2147. (org-test-with-temp-text "- Para1\n\n- Para2"
  2148. (progn (forward-line)
  2149. (org-element-type
  2150. (let ((org-empty-line-terminates-plain-lists nil))
  2151. (org-element-at-point)))))))
  2152. ;; Special case: at the last blank line in a plain list, return it
  2153. ;; instead of the last item.
  2154. (should
  2155. (eq 'plain-list
  2156. (org-test-with-temp-text "- Para1\n- Para2\n\nPara3"
  2157. (progn (forward-line 2)
  2158. (org-element-type (org-element-at-point))))))
  2159. ;; With an optional argument, return trail.
  2160. (should
  2161. (equal '(paragraph center-block)
  2162. (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER\nZ"
  2163. (progn (search-forward "Z")
  2164. (mapcar 'org-element-type (org-element-at-point t)))))))
  2165. (ert-deftest test-org-element/context ()
  2166. "Test `org-element-context' specifications."
  2167. ;; Return closest object containing point.
  2168. (should
  2169. (eq 'underline
  2170. (org-test-with-temp-text "Some *text with _underline_ text*"
  2171. (progn (search-forward "under")
  2172. (org-element-type (org-element-context))))))
  2173. ;; Find objects in secondary strings.
  2174. (should
  2175. (eq 'underline
  2176. (org-test-with-temp-text "* Headline _with_ underlining"
  2177. (progn (search-forward "w")
  2178. (org-element-type (org-element-context))))))
  2179. ;; Correctly set `:parent' property.
  2180. (should
  2181. (eq 'paragraph
  2182. (org-test-with-temp-text "Some *bold* text"
  2183. (progn (search-forward "bold")
  2184. (org-element-type
  2185. (org-element-property :parent (org-element-context))))))))
  2186. (provide 'test-org-element)
  2187. ;;; test-org-element.el ends here