test-org-element.el 84 KB

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