test-org-element.el 100 KB

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