test-org-element.el 101 KB

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