test-org-element.el 103 KB

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