test-org-element.el 142 KB

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