test-org-element.el 87 KB

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