test-org-element.el 86 KB

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