test-org-element.el 121 KB

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