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