test-org-element.el 87 KB

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