test-ox.el 144 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419
  1. ;;; test-ox.el --- Tests for ox.el -*- lexical-binding: t; -*-
  2. ;; Copyright (C) 2012-2016 Nicolas Goaziou
  3. ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
  4. ;; This file is not part of GNU Emacs.
  5. ;; This program is free software; you can redistribute it and/or modify
  6. ;; it under the terms of the GNU General Public License as published by
  7. ;; the Free Software Foundation, either version 3 of the License, or
  8. ;; (at your option) any later version.
  9. ;; This program is distributed in the hope that it will be useful,
  10. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  11. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12. ;; GNU General Public License for more details.
  13. ;; You should have received a copy of the GNU General Public License
  14. ;; along with this program. If not, see <http://www.gnu.org/licenses/>.
  15. ;;; Code:
  16. (require 'cl-lib)
  17. (unless (featurep 'ox)
  18. (signal 'missing-test-dependency "org-export"))
  19. (defun org-test-default-backend ()
  20. "Return a default export back-end.
  21. This back-end simply returns parsed data as Org syntax."
  22. (org-export-create-backend
  23. :transcoders
  24. (mapcar (lambda (type)
  25. (cons type
  26. (lambda (o c _)
  27. (funcall
  28. (intern (format "org-element-%s-interpreter" type))
  29. o c))))
  30. (append org-element-all-elements org-element-all-objects))))
  31. (defmacro org-test-with-parsed-data (data &rest body)
  32. "Execute body with parsed data available.
  33. DATA is a string containing the data to be parsed. BODY is the
  34. body to execute. Parse tree is available under the `tree'
  35. variable, and communication channel under `info'."
  36. (declare (debug (form body)) (indent 1))
  37. `(org-test-with-temp-text ,data
  38. (org-export--delete-comment-trees)
  39. (let* ((tree (org-element-parse-buffer))
  40. (info (org-combine-plists
  41. (org-export--get-export-attributes)
  42. (org-export-get-environment))))
  43. (org-export--prune-tree tree info)
  44. (org-export--remove-uninterpreted-data tree info)
  45. (let ((info (org-combine-plists
  46. info (org-export--collect-tree-properties tree info))))
  47. ,@body))))
  48. ;;; Internal Tests
  49. (ert-deftest test-org-export/bind-keyword ()
  50. "Test reading #+BIND: keywords."
  51. ;; Test with `org-export-allow-bind-keywords' set to t.
  52. (should
  53. (org-test-with-temp-text "#+BIND: test-ox-var value"
  54. (let ((org-export-allow-bind-keywords t))
  55. (org-export-get-environment)
  56. (eq test-ox-var 'value))))
  57. ;; Test with `org-export-allow-bind-keywords' set to nil.
  58. (should-not
  59. (org-test-with-temp-text "#+BIND: test-ox-var value"
  60. (let ((org-export-allow-bind-keywords nil))
  61. (org-export-get-environment)
  62. (boundp 'test-ox-var))))
  63. ;; BIND keywords are case-insensitive.
  64. (should
  65. (org-test-with-temp-text "#+bind: test-ox-var value"
  66. (let ((org-export-allow-bind-keywords t))
  67. (org-export-get-environment)
  68. (eq test-ox-var 'value))))
  69. ;; Preserve order of BIND keywords.
  70. (should
  71. (org-test-with-temp-text "#+BIND: test-ox-var 1\n#+BIND: test-ox-var 2"
  72. (let ((org-export-allow-bind-keywords t))
  73. (org-export-get-environment)
  74. (eq test-ox-var 2))))
  75. ;; Read BIND keywords in setup files.
  76. (should
  77. (org-test-with-temp-text
  78. (format "#+SETUPFILE: \"%s/examples/setupfile.org\"" org-test-dir)
  79. (let ((org-export-allow-bind-keywords t))
  80. (org-export-get-environment)
  81. (eq variable 'value))))
  82. ;; Verify that bound variables are seen during export.
  83. (should
  84. (equal "Yes\n"
  85. (org-test-with-temp-text "#+BIND: test-ox-var value"
  86. (let ((org-export-allow-bind-keywords t))
  87. (org-export-as
  88. (org-export-create-backend
  89. :transcoders
  90. '((section . (lambda (s c i)
  91. (if (eq test-ox-var 'value) "Yes" "No")))))))))))
  92. (ert-deftest test-org-export/parse-option-keyword ()
  93. "Test reading all standard #+OPTIONS: items."
  94. (should
  95. (let ((options
  96. (org-export--parse-option-keyword
  97. "H:1 num:t \\n:t timestamp:t arch:t author:t creator:t d:t email:t \
  98. *:t e:t ::t f:t pri:t -:t ^:t toc:t |:t tags:t tasks:t <:t todo:t inline:nil \
  99. stat:t title:t")))
  100. (and (eq (plist-get options :headline-levels) 1)
  101. (eq (plist-get options :section-numbers) t)
  102. (eq (plist-get options :preserve-breaks) t)
  103. (eq (plist-get options :time-stamp-file) t)
  104. (eq (plist-get options :with-archived-trees) t)
  105. (eq (plist-get options :with-author) t)
  106. (eq (plist-get options :with-drawers) t)
  107. (eq (plist-get options :with-email) t)
  108. (eq (plist-get options :with-emphasize) t)
  109. (eq (plist-get options :with-entities) t)
  110. (eq (plist-get options :with-fixed-width) t)
  111. (eq (plist-get options :with-footnotes) t)
  112. (eq (plist-get options :with-priority) t)
  113. (eq (plist-get options :with-special-strings) t)
  114. (eq (plist-get options :with-sub-superscript) t)
  115. (eq (plist-get options :with-toc) t)
  116. (eq (plist-get options :with-tables) t)
  117. (eq (plist-get options :with-tags) t)
  118. (eq (plist-get options :with-tasks) t)
  119. (eq (plist-get options :with-timestamps) t)
  120. (eq (plist-get options :with-todo-keywords) t)
  121. (eq (plist-get options :with-inlinetasks) nil)
  122. (eq (plist-get options :with-statistics-cookies) t)
  123. (eq (plist-get options :with-title) t))))
  124. ;; Test some special values.
  125. (should
  126. (let ((options
  127. (org-export--parse-option-keyword
  128. "arch:headline d:(\"TEST\") ^:{} toc:1 tags:not-in-toc tasks:todo \
  129. num:2 <:active")))
  130. (and (eq (plist-get options :with-archived-trees) 'headline)
  131. (eq (plist-get options :with-sub-superscript) '{})
  132. (eq (plist-get options :with-toc) 1)
  133. (eq (plist-get options :with-tags) 'not-in-toc)
  134. (eq (plist-get options :with-tasks) 'todo)
  135. (eq (plist-get options :section-numbers) 2)
  136. (eq (plist-get options :with-timestamps) 'active)
  137. (equal (plist-get options :with-drawers) '("TEST")))))
  138. ;; Test back-end specific values.
  139. (should
  140. (equal
  141. (org-export--parse-option-keyword
  142. "opt:t" (org-export-create-backend :options '((:option nil "opt"))))
  143. '(:option t)))
  144. ;; More than one property can refer to the same option item.
  145. (should
  146. (equal '(:opt1 t :opt2 t)
  147. (org-export--parse-option-keyword
  148. "opt:t"
  149. (org-export-create-backend
  150. :options '((:opt1 nil "opt") (:opt2 nil "opt")))))))
  151. (ert-deftest test-org-export/get-inbuffer-options ()
  152. "Test reading all standard export keywords."
  153. ;; Properties should follow buffer order.
  154. (should
  155. (equal
  156. (org-test-with-temp-text "#+LANGUAGE: fr\n#+CREATOR: Me\n#+EMAIL: email"
  157. (org-export--get-inbuffer-options))
  158. '(:language "fr" :creator "Me" :email "email")))
  159. ;; Test `space' behaviour.
  160. (should
  161. (equal
  162. (let ((back-end (org-export-create-backend
  163. :options '((:keyword "KEYWORD" nil nil space)))))
  164. (org-test-with-temp-text "#+KEYWORD: With\n#+KEYWORD: spaces"
  165. (org-export--get-inbuffer-options back-end)))
  166. '(:keyword "With spaces")))
  167. ;; Test `newline' behaviour.
  168. (should
  169. (equal
  170. (let ((back-end (org-export-create-backend
  171. :options '((:keyword "KEYWORD" nil nil newline)))))
  172. (org-test-with-temp-text "#+KEYWORD: With\n#+KEYWORD: two lines"
  173. (org-export--get-inbuffer-options back-end)))
  174. '(:keyword "With\ntwo lines")))
  175. ;; Test `split' behaviour.
  176. (should
  177. (equal
  178. (org-test-with-temp-text "#+SELECT_TAGS: a\n#+SELECT_TAGS: b"
  179. (org-export--get-inbuffer-options))
  180. '(:select-tags ("a" "b"))))
  181. ;; Test `parse' behaviour. `parse' implies `space' but preserve
  182. ;; line breaks. Multi-line objects are allowed.
  183. (should
  184. (org-element-map
  185. (org-test-with-temp-text "#+TITLE: *bold*"
  186. (plist-get (org-export--get-inbuffer-options) :title))
  187. 'bold #'identity nil t))
  188. (should
  189. (equal
  190. (org-test-with-temp-text "#+TITLE: Some title\n#+TITLE: with spaces"
  191. (plist-get (org-export--get-inbuffer-options) :title))
  192. '("Some title with spaces")))
  193. (should
  194. (org-element-map
  195. (org-test-with-temp-text "#+TITLE: Some title\\\\\n#+TITLE: with spaces"
  196. (plist-get (org-export--get-inbuffer-options) :title))
  197. 'line-break #'identity nil t))
  198. (should
  199. (org-element-map
  200. (org-test-with-temp-text "#+TITLE: *bold\n#+TITLE: sentence*"
  201. (plist-get (org-export--get-inbuffer-options) :title))
  202. 'bold #'identity nil t))
  203. ;; Options set through SETUPFILE.
  204. (should
  205. (equal
  206. (org-test-with-temp-text
  207. (format "#+DESCRIPTION: l1
  208. #+LANGUAGE: es
  209. #+SELECT_TAGS: a
  210. #+TITLE: a
  211. #+SETUPFILE: \"%s/examples/setupfile.org\"
  212. #+LANGUAGE: fr
  213. #+SELECT_TAGS: c
  214. #+TITLE: c"
  215. org-test-dir)
  216. (org-export--get-inbuffer-options))
  217. '(:language "fr" :select-tags ("a" "b" "c") :title ("a b c"))))
  218. ;; More than one property can refer to the same buffer keyword.
  219. (should
  220. (equal '(:k2 "value" :k1 "value")
  221. (let ((backend (org-export-create-backend
  222. :options '((:k1 "KEYWORD")
  223. (:k2 "KEYWORD")))))
  224. (org-test-with-temp-text "#+KEYWORD: value"
  225. (org-export--get-inbuffer-options backend)))))
  226. ;; Keywords in commented subtrees are ignored.
  227. (should-not
  228. (equal "Me"
  229. (org-test-with-parsed-data "* COMMENT H1\n#+AUTHOR: Me"
  230. (plist-get info :author))))
  231. (should-not
  232. (equal "Mine"
  233. (org-test-with-parsed-data "* COMMENT H1\n** H2\n#+EMAIL: Mine"
  234. (plist-get info :email)))))
  235. (ert-deftest test-org-export/get-subtree-options ()
  236. "Test setting options from headline's properties."
  237. ;; EXPORT_TITLE.
  238. (should
  239. (equal '("Subtree Title")
  240. (org-test-with-temp-text "#+TITLE: Title
  241. * Headline<point>
  242. :PROPERTIES:
  243. :EXPORT_TITLE: Subtree Title
  244. :END:
  245. Paragraph"
  246. (plist-get (org-export-get-environment nil t) :title))))
  247. ;; EXPORT_OPTIONS.
  248. (should
  249. (= 2
  250. (org-test-with-temp-text "#+OPTIONS: H:1
  251. * Headline<point>
  252. :PROPERTIES:
  253. :EXPORT_OPTIONS: H:2
  254. :END:
  255. Paragraph"
  256. (plist-get (org-export-get-environment nil t) :headline-levels))))
  257. ;; EXPORT_DATE.
  258. (should
  259. (equal '("29-03-2012")
  260. (org-test-with-temp-text "#+DATE: today
  261. * Headline<point>
  262. :PROPERTIES:
  263. :EXPORT_DATE: 29-03-2012
  264. :END:
  265. Paragraph"
  266. (plist-get (org-export-get-environment nil t) :date))))
  267. ;; Properties with `split' behaviour are stored as a list of
  268. ;; strings.
  269. (should
  270. (equal '("a" "b")
  271. (org-test-with-temp-text "#+EXCLUDE_TAGS: noexport
  272. * Headline<point>
  273. :PROPERTIES:
  274. :EXPORT_EXCLUDE_TAGS: a b
  275. :END:
  276. Paragraph"
  277. (plist-get (org-export-get-environment nil t) :exclude-tags))))
  278. ;; Handle :PROPERTY+: syntax.
  279. (should
  280. (equal '("a" "b")
  281. (org-test-with-temp-text "#+EXCLUDE_TAGS: noexport
  282. * Headline<point>
  283. :PROPERTIES:
  284. :EXPORT_EXCLUDE_TAGS: a
  285. :EXPORT_EXCLUDE_TAGS+: b
  286. :END:
  287. Paragraph"
  288. (plist-get (org-export-get-environment nil t) :exclude-tags))))
  289. ;; Export properties are case-insensitive.
  290. (should
  291. (equal '("29-03-2012")
  292. (org-test-with-temp-text "* Headline
  293. :PROPERTIES:
  294. :EXPORT_Date: 29-03-2012
  295. :END:
  296. Paragraph"
  297. (plist-get (org-export-get-environment nil t) :date))))
  298. ;; Still grab correct options when section above is empty.
  299. (should
  300. (equal '("H1")
  301. (org-test-with-temp-text "* H1\n** H11\n** H12<point>"
  302. (plist-get (org-export-get-environment nil t) :title))))
  303. ;; More than one property can refer to the same node property.
  304. (should
  305. (equal '("1" "1")
  306. (org-test-with-temp-text
  307. "* H\n:PROPERTIES:\n:EXPORT_A: 1\n:END:\n<point>"
  308. (let* ((backend (org-export-create-backend
  309. :options '((:k1 "A")
  310. (:k2 "A"))))
  311. (options (org-export-get-environment backend t)))
  312. (list (plist-get options :k1) (plist-get options :k2)))))))
  313. (ert-deftest test-org-export/set-title ()
  314. "Test title setting."
  315. ;; Without TITLE keyword.
  316. (should
  317. (equal
  318. ""
  319. (let (org-export-filter-body-functions
  320. org-export-filter-final-output-functions)
  321. (org-test-with-temp-text "Test"
  322. (org-export-as
  323. (org-export-create-backend
  324. :transcoders
  325. '((template . (lambda (text info)
  326. (org-element-interpret-data
  327. (plist-get info :title)))))))))))
  328. ;; With a blank TITLE keyword.
  329. (should
  330. (equal
  331. ""
  332. (let (org-export-filter-body-functions
  333. org-export-filter-final-output-functions)
  334. (org-test-with-temp-text "#+TITLE:\nTest"
  335. (org-export-as
  336. (org-export-create-backend
  337. :transcoders
  338. '((template . (lambda (text info)
  339. (org-element-interpret-data
  340. (plist-get info :title)))))))))))
  341. ;; With a non-empty TITLE keyword.
  342. (should
  343. (equal
  344. "Title"
  345. (org-test-with-temp-text "#+TITLE: Title\nTest"
  346. (org-export-as
  347. (org-export-create-backend
  348. :transcoders
  349. '((template . (lambda (text info)
  350. (org-element-interpret-data
  351. (plist-get info :title))))))))))
  352. ;; When exporting a subtree, its heading becomes the headline of the
  353. ;; document...
  354. (should
  355. (equal
  356. "Headline"
  357. (org-test-with-temp-text "* Headline\nBody"
  358. (org-export-as
  359. (org-export-create-backend
  360. :transcoders
  361. '((template . (lambda (text info)
  362. (org-element-interpret-data
  363. (plist-get info :title))))))
  364. 'subtree))))
  365. ;; ... unless there is an EXPORT_TITLE property at the root of the
  366. ;; subtree.
  367. (should
  368. (equal
  369. "B"
  370. (org-test-with-temp-text
  371. "* A\n :PROPERTIES:\n :EXPORT_TITLE: B\n :END:\nBody"
  372. (org-export-as
  373. (org-export-create-backend
  374. :transcoders
  375. '((template . (lambda (text info)
  376. (org-element-interpret-data
  377. (plist-get info :title))))))
  378. 'subtree)))))
  379. (ert-deftest test-org-export/handle-options ()
  380. "Test if export options have an impact on output."
  381. ;; Test exclude tags for headlines and inlinetasks.
  382. (should
  383. (equal ""
  384. (let (org-export-filter-body-functions
  385. org-export-filter-final-output-functions)
  386. (org-test-with-temp-text "* Head1 :noexp:"
  387. (org-export-as (org-test-default-backend)
  388. nil nil nil '(:exclude-tags ("noexp")))))))
  389. (should
  390. (equal "#+FILETAGS: noexp\n"
  391. (let (org-export-filter-body-functions
  392. org-export-filter-final-output-functions)
  393. (org-test-with-temp-text "#+FILETAGS: noexp\n* Head1"
  394. (org-export-as (org-test-default-backend)
  395. nil nil nil '(:exclude-tags ("noexp")))))))
  396. ;; Test include tags for headlines and inlinetasks.
  397. (should
  398. (equal (org-test-with-temp-text "* H1\n* H2\n** Sub :exp:\n*** Sub Sub\n* H3"
  399. (let ((org-tags-column 0))
  400. (org-export-as (org-test-default-backend)
  401. nil nil nil '(:select-tags ("exp")))))
  402. "* H2\n** Sub :exp:\n*** Sub Sub\n"))
  403. ;; If there is an include tag, ignore the section before the first
  404. ;; headline, if any.
  405. (should
  406. (equal (org-test-with-temp-text "First section\n* H1 :exp:\nBody"
  407. (let ((org-tags-column 0))
  408. (org-export-as (org-test-default-backend)
  409. nil nil nil '(:select-tags ("exp")))))
  410. "* H1 :exp:\nBody\n"))
  411. (should
  412. (equal (org-test-with-temp-text "#+FILETAGS: exp\nFirst section\n* H1\nBody"
  413. (org-export-as (org-test-default-backend)
  414. nil nil nil '(:select-tags ("exp"))))
  415. "* H1\nBody\n"))
  416. (should-not
  417. (equal (org-test-with-temp-text "* H1 :exp:\nBody"
  418. (let ((org-tags-column 0))
  419. (org-export-as (org-test-default-backend)
  420. nil nil nil '(:select-tags ("exp")))))
  421. "* H1 :exp:\n"))
  422. ;; Test mixing include tags and exclude tags.
  423. (should
  424. (string-match
  425. "\\* Head1[ \t]+:export:\n\\*\\* Sub-Head2\n"
  426. (org-test-with-temp-text "
  427. * Head1 :export:
  428. ** Sub-Head1 :noexport:
  429. ** Sub-Head2
  430. * Head2 :noexport:
  431. ** Sub-Head1 :export:"
  432. (org-export-as (org-test-default-backend) nil nil nil
  433. '(:select-tags ("export") :exclude-tags ("noexport"))))))
  434. ;; Ignore tasks.
  435. (should
  436. (equal ""
  437. (let ((org-todo-keywords '((sequence "TODO" "DONE")))
  438. org-export-filter-body-functions
  439. org-export-filter-final-output-functions)
  440. (org-test-with-temp-text "* TODO Head1"
  441. (org-export-as (org-test-default-backend)
  442. nil nil nil '(:with-tasks nil))))))
  443. (should
  444. (equal "* TODO Head1\n"
  445. (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
  446. (org-test-with-temp-text "* TODO Head1"
  447. (org-export-as (org-test-default-backend)
  448. nil nil nil '(:with-tasks t))))))
  449. ;; Archived tree.
  450. (should
  451. (equal ""
  452. (let (org-export-filter-body-functions
  453. org-export-filter-final-output-functions)
  454. (org-test-with-temp-text "* Head1 :archive:"
  455. (let ((org-archive-tag "archive"))
  456. (org-export-as (org-test-default-backend)
  457. nil nil nil '(:with-archived-trees nil)))))))
  458. (should
  459. (string-match
  460. "\\* Head1[ \t]+:archive:"
  461. (org-test-with-temp-text "* Head1 :archive:\nbody\n** Sub-head 2"
  462. (let ((org-archive-tag "archive"))
  463. (org-export-as (org-test-default-backend) nil nil nil
  464. '(:with-archived-trees headline))))))
  465. (should
  466. (string-match
  467. "\\`\\* Head1[ \t]+:archive:\n\\'"
  468. (org-test-with-temp-text "* Head1 :archive:"
  469. (let ((org-archive-tag "archive"))
  470. (org-export-as (org-test-default-backend)
  471. nil nil nil '(:with-archived-trees t))))))
  472. ;; Broken links. Depending on `org-export-with-broken-links', raise
  473. ;; an error, ignore link or mark is as broken in output.
  474. (should-error
  475. (org-test-with-temp-text "[[#broken][link]]"
  476. (let ((backend
  477. (org-export-create-backend
  478. :transcoders
  479. '((section . (lambda (_e c _i) c))
  480. (paragraph . (lambda (_e c _i) c))
  481. (link . (lambda (l c i) (org-export-resolve-id-link l i)))))))
  482. (org-export-as backend nil nil nil '(:with-broken-links nil)))))
  483. (should
  484. (org-test-with-temp-text "[[#broken][link]]"
  485. (let ((backend
  486. (org-export-create-backend
  487. :transcoders
  488. '((section . (lambda (_e c _i) c))
  489. (paragraph . (lambda (_e c _i) c))
  490. (link . (lambda (l c i) (org-export-resolve-id-link l i)))))))
  491. (org-export-as backend nil nil nil '(:with-broken-links t)))))
  492. (should
  493. (org-test-with-temp-text "[[#broken][link]]"
  494. (let ((backend
  495. (org-export-create-backend
  496. :transcoders
  497. '((section . (lambda (_e c _i) c))
  498. (paragraph . (lambda (_e c _i) c))
  499. (link . (lambda (l c i) (org-export-resolve-id-link l i)))))))
  500. (org-string-nw-p
  501. (org-export-as backend nil nil nil '(:with-broken-links mark))))))
  502. ;; Clocks.
  503. (should
  504. (string-match "CLOCK: \\[2012-04-29 .* 10:45\\]"
  505. (org-test-with-temp-text "CLOCK: [2012-04-29 sun. 10:45]"
  506. (org-export-as (org-test-default-backend)
  507. nil nil nil '(:with-clocks t)))))
  508. (should
  509. (equal ""
  510. (let (org-export-filter-body-functions
  511. org-export-filter-final-output-functions)
  512. (org-test-with-temp-text "CLOCK: [2012-04-29 sun. 10:45]"
  513. (org-export-as (org-test-default-backend)
  514. nil nil nil '(:with-clocks nil))))))
  515. ;; Drawers.
  516. (should
  517. (equal ""
  518. (let (org-export-filter-body-functions
  519. org-export-filter-final-output-functions)
  520. (org-test-with-temp-text ":TEST:\ncontents\n:END:"
  521. (org-export-as (org-test-default-backend)
  522. nil nil nil '(:with-drawers nil))))))
  523. (should
  524. (equal ":TEST:\ncontents\n:END:\n"
  525. (org-test-with-temp-text ":TEST:\ncontents\n:END:"
  526. (org-export-as (org-test-default-backend)
  527. nil nil nil '(:with-drawers t)))))
  528. (should
  529. (equal ":FOO:\nkeep\n:END:\n"
  530. (org-test-with-temp-text ":FOO:\nkeep\n:END:\n:BAR:\nremove\n:END:"
  531. (org-export-as (org-test-default-backend)
  532. nil nil nil '(:with-drawers ("FOO"))))))
  533. (should
  534. (equal ":FOO:\nkeep\n:END:\n"
  535. (org-test-with-temp-text ":FOO:\nkeep\n:END:\n:BAR:\nremove\n:END:"
  536. (org-export-as (org-test-default-backend)
  537. nil nil nil '(:with-drawers (not "BAR"))))))
  538. ;; Fixed-width.
  539. (should
  540. (equal ": A\n"
  541. (org-test-with-temp-text ": A"
  542. (org-export-as (org-test-default-backend) nil nil nil
  543. '(:with-fixed-width t)))))
  544. (should
  545. (equal ""
  546. (let (org-export-filter-body-functions
  547. org-export-filter-final-output-functions)
  548. (org-test-with-temp-text ": A"
  549. (org-export-as (org-test-default-backend) nil nil nil
  550. '(:with-fixed-width nil))))))
  551. ;; Footnotes.
  552. (should
  553. (equal "Footnote?"
  554. (let ((org-footnote-section nil))
  555. (org-test-with-temp-text "Footnote?[fn:1]\n\n[fn:1] Def"
  556. (org-trim (org-export-as (org-test-default-backend)
  557. nil nil nil '(:with-footnotes nil)))))))
  558. (should
  559. (equal "Footnote?[fn:1]\n\n[fn:1] Def"
  560. (let ((org-footnote-section nil))
  561. (org-test-with-temp-text "Footnote?[fn:1]\n\n[fn:1] Def"
  562. (org-trim (org-export-as (org-test-default-backend)
  563. nil nil nil '(:with-footnotes t)))))))
  564. ;; Inlinetasks.
  565. (when (featurep 'org-inlinetask)
  566. (should
  567. (equal
  568. ""
  569. (let ((org-inlinetask-min-level 15)
  570. org-export-filter-body-functions
  571. org-export-filter-final-output-functions)
  572. (org-test-with-temp-text "*************** Task"
  573. (org-export-as (org-test-default-backend)
  574. nil nil nil '(:with-inlinetasks nil))))))
  575. (should
  576. (equal
  577. ""
  578. (let ((org-inlinetask-min-level 15)
  579. org-export-filter-body-functions
  580. org-export-filter-final-output-functions)
  581. (org-test-with-temp-text
  582. "*************** Task\nContents\n*************** END"
  583. (org-export-as (org-test-default-backend)
  584. nil nil nil '(:with-inlinetasks nil)))))))
  585. ;; Plannings.
  586. (should
  587. (string-match
  588. "* H\nCLOSED: \\[2012-04-29 .* 10:45\\]"
  589. (let ((org-closed-string "CLOSED:"))
  590. (org-test-with-temp-text "* H\nCLOSED: [2012-04-29 sun. 10:45]"
  591. (org-export-as (org-test-default-backend)
  592. nil nil nil '(:with-planning t))))))
  593. (should
  594. (equal "* H\n"
  595. (let ((org-closed-string "CLOSED:"))
  596. (org-test-with-temp-text "* H\nCLOSED: [2012-04-29 sun. 10:45]"
  597. (org-export-as (org-test-default-backend)
  598. nil nil nil '(:with-planning nil))))))
  599. ;; Property Drawers.
  600. (should
  601. (equal "* H1\n"
  602. (org-test-with-temp-text
  603. "* H1\n :PROPERTIES:\n :PROP: value\n :END:"
  604. (org-export-as (org-test-default-backend)
  605. nil nil nil '(:with-properties nil)))))
  606. (should
  607. (equal "* H1\n:PROPERTIES:\n:PROP: value\n:END:\n"
  608. (org-test-with-temp-text
  609. "* H1\n :PROPERTIES:\n :PROP: value\n :END:"
  610. (org-export-as (org-test-default-backend)
  611. nil nil nil '(:with-properties t)))))
  612. (should
  613. (equal "* H1\n:PROPERTIES:\n:B: 2\n:END:\n"
  614. (org-test-with-temp-text
  615. "* H1\n :PROPERTIES:\n :A: 1\n :B: 2\n:END:"
  616. (org-export-as (org-test-default-backend)
  617. nil nil nil '(:with-properties ("B"))))))
  618. ;; Statistics cookies.
  619. (should
  620. (equal "* Stats"
  621. (let (org-export-filter-body-functions
  622. org-export-filter-final-output-functions)
  623. (org-trim
  624. (org-test-with-temp-text "* Stats [0/0]"
  625. (org-export-as (org-test-default-backend)
  626. nil nil nil '(:with-statistics-cookies nil)))))))
  627. ;; Tables.
  628. (should
  629. (equal "| A |\n"
  630. (org-test-with-temp-text "| A |"
  631. (org-export-as (org-test-default-backend) nil nil nil
  632. '(:with-tables t)))))
  633. (should
  634. (equal ""
  635. (let (org-export-filter-body-functions
  636. org-export-filter-final-output-functions)
  637. (org-test-with-temp-text "| A |"
  638. (org-export-as (org-test-default-backend) nil nil nil
  639. '(:with-tables nil)))))))
  640. (ert-deftest test-org-export/with-timestamps ()
  641. "Test `org-export-with-timestamps' specifications."
  642. ;; t value.
  643. (should
  644. (string-match
  645. "\\[2012-04-29 .*? 10:45\\]<2012-04-29 .*? 10:45>"
  646. (org-test-with-temp-text "[2012-04-29 sun. 10:45]<2012-04-29 sun. 10:45>"
  647. (org-export-as (org-test-default-backend)
  648. nil nil nil '(:with-timestamps t)))))
  649. ;; nil value.
  650. (should
  651. (equal
  652. ""
  653. (let (org-export-filter-body-functions
  654. org-export-filter-final-output-functions)
  655. (org-trim
  656. (org-test-with-temp-text "[2012-04-29 sun. 10:45]<2012-04-29 sun. 10:45>"
  657. (org-export-as (org-test-default-backend)
  658. nil nil nil '(:with-timestamps nil)))))))
  659. ;; `active' value.
  660. (should
  661. (string-match
  662. "<2012-03-29 .*?>\n\nParagraph <2012-03-29 .*?>\\[2012-03-29 .*?\\]"
  663. (org-test-with-temp-text
  664. "<2012-03-29 Thu>[2012-03-29 Thu]
  665. Paragraph <2012-03-29 Thu>[2012-03-29 Thu]"
  666. (org-export-as (org-test-default-backend)
  667. nil nil nil '(:with-timestamps active)))))
  668. ;; `inactive' value.
  669. (should
  670. (string-match
  671. "\\[2012-03-29 .*?\\]\n\nParagraph <2012-03-29 .*?>\\[2012-03-29 .*?\\]"
  672. (org-test-with-temp-text
  673. "<2012-03-29 Thu>[2012-03-29 Thu]
  674. Paragraph <2012-03-29 Thu>[2012-03-29 Thu]"
  675. (org-export-as (org-test-default-backend)
  676. nil nil nil '(:with-timestamps inactive))))))
  677. (ert-deftest test-org-export/comment-tree ()
  678. "Test if export process ignores commented trees."
  679. (should
  680. (equal ""
  681. (let (org-export-filter-body-functions
  682. org-export-filter-final-output-functions)
  683. (org-test-with-temp-text "* COMMENT Head1"
  684. (org-export-as (org-test-default-backend)))))))
  685. (ert-deftest test-org-export/uninterpreted ()
  686. "Test handling of uninterpreted elements."
  687. ;; Entities.
  688. (should
  689. (equal "dummy\n"
  690. (org-test-with-temp-text "\\alpha"
  691. (org-export-as
  692. (org-export-create-backend
  693. :transcoders '((entity . (lambda (e c i) "dummy"))
  694. (paragraph . (lambda (p c i) c))
  695. (section . (lambda (s c i) c))))
  696. nil nil nil '(:with-entities t)))))
  697. (should
  698. (equal "\\alpha\n"
  699. (org-test-with-temp-text "\\alpha"
  700. (org-export-as
  701. (org-export-create-backend
  702. :transcoders '((entity . (lambda (e c i) "dummy"))
  703. (paragraph . (lambda (p c i) c))
  704. (section . (lambda (s c i) c))))
  705. nil nil nil '(:with-entities nil)))))
  706. ;; Emphasis.
  707. (should
  708. (equal "dummy\n"
  709. (org-test-with-temp-text "*bold*"
  710. (org-export-as
  711. (org-export-create-backend
  712. :transcoders '((bold . (lambda (b c i) "dummy"))
  713. (paragraph . (lambda (p c i) c))
  714. (section . (lambda (s c i) c))))
  715. nil nil nil '(:with-emphasize t)))))
  716. (should
  717. (equal "*bold*\n"
  718. (org-test-with-temp-text "*bold*"
  719. (org-export-as
  720. (org-export-create-backend
  721. :transcoders '((bold . (lambda (b c i) "dummy"))
  722. (paragraph . (lambda (p c i) c))
  723. (section . (lambda (s c i) c))))
  724. nil nil nil '(:with-emphasize nil)))))
  725. ;; LaTeX environment.
  726. (should
  727. (equal "dummy\n"
  728. (org-test-with-temp-text "\\begin{equation}\n1+1=2\n\\end{equation}"
  729. (org-export-as
  730. (org-export-create-backend
  731. :transcoders '((latex-environment . (lambda (l c i) "dummy"))
  732. (section . (lambda (s c i) c))))
  733. nil nil nil '(:with-latex t)))))
  734. (should
  735. (equal "\\begin{equation}\n1+1=2\n\\end{equation}\n"
  736. (org-test-with-temp-text "\\begin{equation}\n1+1=2\n\\end{equation}"
  737. (org-export-as
  738. (org-export-create-backend
  739. :transcoders '((latex-environment . (lambda (l c i) "dummy"))
  740. (section . (lambda (s c i) c))))
  741. nil nil nil '(:with-latex verbatim)))))
  742. ;; LaTeX fragment.
  743. (should
  744. (equal "dummy\n"
  745. (org-test-with-temp-text "$1$"
  746. (org-export-as
  747. (org-export-create-backend
  748. :transcoders '((latex-fragment . (lambda (l c i) "dummy"))
  749. (paragraph . (lambda (p c i) c))
  750. (section . (lambda (s c i) c))))
  751. nil nil nil '(:with-latex t)))))
  752. (should
  753. (equal "$1$\n"
  754. (org-test-with-temp-text "$1$"
  755. (org-export-as
  756. (org-export-create-backend
  757. :transcoders '((latex-fragment . (lambda (l c i) "dummy"))
  758. (paragraph . (lambda (p c i) c))
  759. (section . (lambda (s c i) c))))
  760. nil nil nil '(:with-latex verbatim)))))
  761. ;; Sub/superscript.
  762. (should
  763. (equal "adummy\n"
  764. (org-test-with-temp-text "a_b"
  765. (org-export-as
  766. (org-export-create-backend
  767. :transcoders '((subscript . (lambda (s c i) "dummy"))
  768. (paragraph . (lambda (p c i) c))
  769. (section . (lambda (s c i) c))))
  770. nil nil nil '(:with-sub-superscript t)))))
  771. (should
  772. (equal "a_b\n"
  773. (org-test-with-temp-text "a_b"
  774. (org-export-as
  775. (org-export-create-backend
  776. :transcoders '((subscript . (lambda (s c i) "dummy"))
  777. (paragraph . (lambda (p c i) c))
  778. (section . (lambda (s c i) c))))
  779. nil nil nil '(:with-sub-superscript nil)))))
  780. (should
  781. (equal "a_b\n"
  782. (org-test-with-temp-text "a_b"
  783. (org-export-as
  784. (org-export-create-backend
  785. :transcoders '((subscript . (lambda (s c i) "dummy"))
  786. (paragraph . (lambda (p c i) c))
  787. (section . (lambda (s c i) c))))
  788. nil nil nil '(:with-sub-superscript {})))))
  789. (should
  790. (equal "adummy\n"
  791. (org-test-with-temp-text "a_{b}"
  792. (org-export-as
  793. (org-export-create-backend
  794. :transcoders '((subscript . (lambda (s c i) "dummy"))
  795. (paragraph . (lambda (p c i) c))
  796. (section . (lambda (s c i) c))))
  797. nil nil nil '(:with-sub-superscript {})))))
  798. (should
  799. (equal "a_entity\n"
  800. (org-test-with-temp-text "a_\\alpha"
  801. (org-export-as
  802. (org-export-create-backend
  803. :transcoders '((entity . (lambda (e c i) "entity"))
  804. (subscript . (lambda (s c i) "dummy"))
  805. (paragraph . (lambda (p c i) c))
  806. (section . (lambda (s c i) c))))
  807. nil nil nil '(:with-sub-superscript nil)))))
  808. ;; Also handle uninterpreted objects in title.
  809. (should
  810. (equal "a_b"
  811. (org-test-with-temp-text "#+TITLE: a_b"
  812. (org-export-as
  813. (org-export-create-backend
  814. :transcoders
  815. '((subscript . (lambda (s c i) "dummy"))
  816. (template . (lambda (c i) (org-export-data
  817. (plist-get i :title) i)))
  818. (section . (lambda (s c i) c))))
  819. nil nil nil '(:with-sub-superscript nil)))))
  820. ;; Handle uninterpreted objects in captions.
  821. (should
  822. (equal "adummy\n"
  823. (org-test-with-temp-text "#+CAPTION: a_b\nParagraph"
  824. (org-export-as
  825. (org-export-create-backend
  826. :transcoders
  827. '((subscript . (lambda (s c i) "dummy"))
  828. (paragraph . (lambda (p c i)
  829. (org-export-data (org-export-get-caption p) i)))
  830. (section . (lambda (s c i) c))))
  831. nil nil nil '(:with-sub-superscript t)))))
  832. (should
  833. (equal "a_b\n"
  834. (org-test-with-temp-text "#+CAPTION: a_b\nParagraph"
  835. (org-export-as
  836. (org-export-create-backend
  837. :transcoders
  838. '((subscript . (lambda (s c i) "dummy"))
  839. (paragraph . (lambda (p c i)
  840. (org-export-data (org-export-get-caption p) i)))
  841. (section . (lambda (s c i) c))))
  842. nil nil nil '(:with-sub-superscript nil)))))
  843. ;; Special case: multiples uninterpreted objects in a row.
  844. (should
  845. (equal "a_b_c_d\n"
  846. (org-test-with-temp-text "a_b_c_d"
  847. (org-export-as
  848. (org-export-create-backend
  849. :transcoders '((subscript . (lambda (s c i) "dummy"))
  850. (paragraph . (lambda (p c i) c))
  851. (section . (lambda (s c i) c))))
  852. nil nil nil '(:with-sub-superscript {}))))))
  853. (ert-deftest test-org-export/export-scope ()
  854. "Test all export scopes."
  855. ;; Subtree.
  856. (should
  857. (equal "text\n*** H3\n"
  858. (org-test-with-temp-text "* H1\n<point>** H2\ntext\n*** H3"
  859. (org-export-as (org-test-default-backend) 'subtree))))
  860. (should
  861. (equal "text\n*** H3\n"
  862. (org-test-with-temp-text "* H1\n** H2\n<point>text\n*** H3"
  863. (org-export-as (org-test-default-backend) 'subtree))))
  864. ;; Subtree with a code block calling another block outside.
  865. (should
  866. (equal ": 3\n"
  867. (org-test-with-temp-text "
  868. <point>* Head1
  869. #+BEGIN_SRC emacs-lisp :noweb yes :exports results
  870. <<test>>
  871. #+END_SRC
  872. * Head2
  873. #+NAME: test
  874. #+BEGIN_SRC emacs-lisp
  875. \(+ 1 2)
  876. #+END_SRC"
  877. (let ((org-export-use-babel t))
  878. (org-export-as (org-test-default-backend) 'subtree)))))
  879. ;; Subtree export should ignore leading planning line and property
  880. ;; drawer.
  881. (should
  882. (equal "Text\n"
  883. (org-test-with-temp-text "
  884. <point>* H
  885. SCHEDULED: <2012-03-29 Thu>
  886. :PROPERTIES:
  887. :A: 1
  888. :END:
  889. Text"
  890. (org-export-as (org-test-default-backend)
  891. 'subtree nil nil
  892. '(:with-planning t :with-properties t)))))
  893. ;; Visible.
  894. (should
  895. (equal "* H1\n"
  896. (org-test-with-temp-text "* H1\n** H2\ntext\n*** H3"
  897. (org-cycle)
  898. (org-export-as (org-test-default-backend) nil 'visible))))
  899. ;; Region.
  900. (should
  901. (equal "text\n"
  902. (org-test-with-temp-text "* H1\n** H2\n<point>text\n*** H3"
  903. (transient-mark-mode 1)
  904. (push-mark (point) t t)
  905. (end-of-line)
  906. (org-export-as (org-test-default-backend)))))
  907. ;; Body only.
  908. (should
  909. (equal "Text\n"
  910. (org-test-with-temp-text "Text"
  911. (org-export-as
  912. (org-export-create-backend
  913. :transcoders
  914. '((template . (lambda (b _i) (format "BEGIN\n%sEND" b)))
  915. (section . (lambda (_s c _i) c))
  916. (paragraph . (lambda (_p c _i) c))))
  917. nil nil 'body-only))))
  918. (should
  919. (equal "BEGIN\nText\nEND"
  920. (org-test-with-temp-text "Text"
  921. (org-export-as
  922. (org-export-create-backend
  923. :transcoders
  924. '((template . (lambda (b _i) (format "BEGIN\n%sEND" b)))
  925. (section . (lambda (_s c _i) c))
  926. (paragraph . (lambda (_p c _i) c))))))))
  927. ;; Pathological case: Body only on an empty buffer is expected to
  928. ;; return an empty string, not nil.
  929. (should
  930. (org-test-with-temp-text ""
  931. (org-export-as (org-test-default-backend) nil nil t))))
  932. (ert-deftest test-org-export/output-file-name ()
  933. "Test `org-export-output-file-name' specifications."
  934. ;; Export from a file: name is built from original file name.
  935. (should
  936. (org-test-with-temp-text-in-file "Test"
  937. (equal (file-name-base (buffer-file-name))
  938. (file-name-base (org-export-output-file-name ".ext")))))
  939. ;; When #+EXPORT_FILE_NAME is defined, use it.
  940. (should
  941. (equal "test.ext"
  942. (org-test-with-temp-text-in-file "#+EXPORT_FILE_NAME: test"
  943. (org-export-output-file-name ".ext" t))))
  944. ;; When exporting to subtree, check EXPORT_FILE_NAME property first.
  945. (should
  946. (equal "test.ext"
  947. (org-test-with-temp-text-in-file
  948. "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: test\n :END:"
  949. (org-export-output-file-name ".ext" t))))
  950. (should
  951. (equal "property.ext"
  952. (org-test-with-temp-text
  953. "#+EXPORT_FILE_NAME: keyword
  954. * Test<point>
  955. :PROPERTIES:
  956. :EXPORT_FILE_NAME: property
  957. :END:"
  958. (org-export-output-file-name ".ext" t))))
  959. ;; From a buffer not associated to a file, too.
  960. (should
  961. (equal "test.ext"
  962. (org-test-with-temp-text
  963. "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: test\n :END:"
  964. (org-export-output-file-name ".ext" t))))
  965. ;; When provided name is absolute, preserve it.
  966. (should
  967. (org-test-with-temp-text
  968. (format "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: %s\n :END:"
  969. (expand-file-name "test"))
  970. (file-name-absolute-p (org-export-output-file-name ".ext" t))))
  971. ;; When PUB-DIR argument is provided, use it.
  972. (should
  973. (equal "dir/"
  974. (org-test-with-temp-text-in-file "Test"
  975. (file-name-directory
  976. (org-export-output-file-name ".ext" nil "dir/")))))
  977. ;; PUB-DIR has precedence over EXPORT_FILE_NAME keyword or property.
  978. (should
  979. (equal "pub-dir/"
  980. (org-test-with-temp-text-in-file
  981. "#+EXPORT_FILE_NAME: /dir/keyword\nTest"
  982. (file-name-directory
  983. (org-export-output-file-name ".ext" nil "pub-dir/")))))
  984. ;; When returned name would overwrite original file, add EXTENSION
  985. ;; another time.
  986. (should
  987. (equal "normal.org.org"
  988. (org-test-at-id "75282ba2-f77a-4309-a970-e87c149fe125"
  989. (org-export-output-file-name ".org")))))
  990. (ert-deftest test-org-export/expand-include ()
  991. "Test file inclusion in an Org buffer."
  992. ;; Error when file isn't specified.
  993. (should-error
  994. (org-test-with-temp-text "#+INCLUDE: dummy.org"
  995. (org-export-expand-include-keyword)))
  996. ;; Full insertion with recursive inclusion.
  997. (should
  998. (equal
  999. (with-temp-buffer
  1000. (insert-file
  1001. (expand-file-name "examples/include.org" org-test-dir))
  1002. (replace-regexp-in-string
  1003. (regexp-quote "#+INCLUDE: \"include2.org\"")
  1004. "Success!" (buffer-string)))
  1005. (org-test-with-temp-text
  1006. (format "#+INCLUDE: \"%s/examples/include.org\"" org-test-dir)
  1007. (org-export-expand-include-keyword)
  1008. (buffer-string))))
  1009. ;; Localized insertion.
  1010. (org-test-with-temp-text
  1011. (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\""
  1012. org-test-dir)
  1013. (org-export-expand-include-keyword)
  1014. (should (equal (buffer-string)
  1015. "Small Org file with an include keyword.\n")))
  1016. ;; Insertion with constraints on headlines level.
  1017. (should
  1018. (equal
  1019. "* Top heading\n** Heading\nbody\n"
  1020. (org-test-with-temp-text
  1021. (format
  1022. "* Top heading\n#+INCLUDE: \"%s/examples/include.org\" :lines \"9-11\""
  1023. org-test-dir)
  1024. (org-export-expand-include-keyword)
  1025. (buffer-string))))
  1026. (should
  1027. (equal
  1028. "* Top heading\n* Heading\nbody\n"
  1029. (org-test-with-temp-text
  1030. (format
  1031. "* Top heading\n#+INCLUDE: \"%s/examples/include.org\" :lines \"9-11\" :minlevel 1"
  1032. org-test-dir)
  1033. (org-export-expand-include-keyword)
  1034. (buffer-string))))
  1035. ;; Inclusion within an example block.
  1036. (should
  1037. (equal
  1038. "#+BEGIN_EXAMPLE\nSmall Org file with an include keyword.\n#+END_EXAMPLE\n"
  1039. (org-test-with-temp-text
  1040. (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\" EXAMPLE"
  1041. org-test-dir)
  1042. (org-export-expand-include-keyword)
  1043. (buffer-string))))
  1044. ;; Inclusion within a src-block.
  1045. (should
  1046. (equal
  1047. "#+BEGIN_SRC emacs-lisp\n(+ 2 1)\n#+END_SRC\n"
  1048. (org-test-with-temp-text
  1049. (format
  1050. "#+INCLUDE: \"%s/examples/include.org\" :lines \"4-5\" SRC emacs-lisp"
  1051. org-test-dir)
  1052. (org-export-expand-include-keyword)
  1053. (buffer-string))))
  1054. ;; Inclusion within an html export-block.
  1055. (should
  1056. (equal
  1057. "#+BEGIN_EXPORT html\n<p>HTML!</p>\n#+END_EXPORT\n"
  1058. (org-test-with-temp-text
  1059. (format
  1060. "#+INCLUDE: \"%s/examples/include.html\" EXPORT html"
  1061. org-test-dir)
  1062. (org-export-expand-include-keyword)
  1063. (buffer-string))))
  1064. ;; Inclusion within an center paragraph
  1065. (should
  1066. (equal
  1067. "#+BEGIN_CENTER\nSuccess!\n#+END_CENTER\n"
  1068. (org-test-with-temp-text
  1069. (format
  1070. "#+INCLUDE: \"%s/examples/include2.org\" CENTER"
  1071. org-test-dir)
  1072. (org-export-expand-include-keyword)
  1073. (buffer-string))))
  1074. ;; Footnotes labels are local to each included file.
  1075. (should
  1076. (= 6
  1077. (length
  1078. (delete-dups
  1079. (let ((contents "
  1080. Footnotes[fn:1], [fn:test], [fn:test] and [fn:inline:inline footnote].
  1081. \[fn:1] Footnote 1
  1082. \[fn:test] Footnote \"test\""))
  1083. (org-test-with-temp-text-in-file contents
  1084. (let ((file1 (buffer-file-name)))
  1085. (org-test-with-temp-text-in-file contents
  1086. (let ((file2 (buffer-file-name)))
  1087. (org-test-with-temp-text
  1088. (format "#+INCLUDE: \"%s\"\n#+INCLUDE: \"%s\""
  1089. file1 file2)
  1090. (org-export-expand-include-keyword)
  1091. (org-element-map (org-element-parse-buffer)
  1092. 'footnote-reference
  1093. (lambda (r) (org-element-property :label r)))))))))))))
  1094. ;; Footnotes labels are not local to each include keyword.
  1095. (should
  1096. (= 3
  1097. (length
  1098. (delete-dups
  1099. (let ((contents "
  1100. Footnotes[fn:1], [fn:test] and [fn:inline:inline footnote].
  1101. \[fn:1] Footnote 1
  1102. \[fn:test] Footnote \"test\""))
  1103. (org-test-with-temp-text-in-file contents
  1104. (let ((file (buffer-file-name)))
  1105. (org-test-with-temp-text
  1106. (format "#+INCLUDE: \"%s\"\n#+INCLUDE: \"%s\"" file file)
  1107. (org-export-expand-include-keyword)
  1108. (org-element-map (org-element-parse-buffer)
  1109. 'footnote-reference
  1110. (lambda (ref) (org-element-property :label ref)))))))))))
  1111. ;; Footnotes are supported by :lines-like elements and unnecessary
  1112. ;; footnotes are dropped.
  1113. (should
  1114. (= 3
  1115. (length
  1116. (delete-dups
  1117. (let ((contents "
  1118. * foo
  1119. Footnotes[fn:1]
  1120. * bar
  1121. Footnotes[fn:2], foot[fn:test] and [fn:inline:inline footnote]
  1122. \[fn:1] Footnote 1
  1123. \[fn:2] Footnote 1
  1124. * Footnotes
  1125. \[fn:test] Footnote \"test\"
  1126. "))
  1127. (org-test-with-temp-text-in-file contents
  1128. (let ((file (buffer-file-name)))
  1129. (org-test-with-temp-text
  1130. (format "#+INCLUDE: \"%s::*bar\"\n" file)
  1131. (org-export-expand-include-keyword)
  1132. (org-element-map (org-element-parse-buffer)
  1133. 'footnote-definition
  1134. (lambda (ref) (org-element-property :label ref)))))))))))
  1135. ;; If only-contents is non-nil only include contents of element.
  1136. (should
  1137. (equal
  1138. "body\n"
  1139. (org-test-with-temp-text
  1140. (concat
  1141. (format "#+INCLUDE: \"%s/examples/include.org::*Heading\" "
  1142. org-test-dir)
  1143. ":only-contents t")
  1144. (org-export-expand-include-keyword)
  1145. (buffer-string))))
  1146. ;; Headings can be included via CUSTOM_ID.
  1147. (should
  1148. (org-test-with-temp-text
  1149. (format "#+INCLUDE: \"%s/examples/include.org::#ah\"" org-test-dir)
  1150. (org-export-expand-include-keyword)
  1151. (goto-char (point-min))
  1152. (looking-at "* Another heading")))
  1153. ;; Named objects can be included.
  1154. (should
  1155. (equal
  1156. "| 1 |\n"
  1157. (org-test-with-temp-text
  1158. (format "#+INCLUDE: \"%s/examples/include.org::tbl\" :only-contents t"
  1159. org-test-dir)
  1160. (org-export-expand-include-keyword)
  1161. (buffer-string))))
  1162. ;; Including non-existing elements should result in an error.
  1163. (should-error
  1164. (org-test-with-temp-text
  1165. (format "#+INCLUDE: \"%s/examples/include.org::*non-existing heading\""
  1166. org-test-dir)
  1167. (org-export-expand-include-keyword)))
  1168. ;; Lines work relatively to an included element.
  1169. (should
  1170. (equal
  1171. "2\n3\n"
  1172. (org-test-with-temp-text
  1173. (format "#+INCLUDE: \"%s/examples/include.org::#ah\" :only-contents t \
  1174. :lines \"2-3\""
  1175. org-test-dir)
  1176. (org-export-expand-include-keyword)
  1177. (buffer-string))))
  1178. ;; Properties should be dropped from headlines.
  1179. (should
  1180. (equal
  1181. (org-test-with-temp-text
  1182. (format "#+INCLUDE: \"%s/examples/include.org::#ht\" :only-contents t"
  1183. org-test-dir)
  1184. (org-export-expand-include-keyword)
  1185. (buffer-string))
  1186. (org-test-with-temp-text
  1187. (format "#+INCLUDE: \"%s/examples/include.org::tbl\"" org-test-dir)
  1188. (org-export-expand-include-keyword)
  1189. (buffer-string))))
  1190. ;; Properties should be dropped, drawers should not be.
  1191. (should
  1192. (equal
  1193. ":LOGBOOK:\ndrawer\n:END:\ncontent\n"
  1194. (org-test-with-temp-text
  1195. (format "#+INCLUDE: \"%s/examples/include.org::#dh\" :only-contents t"
  1196. org-test-dir)
  1197. (org-export-expand-include-keyword)
  1198. (buffer-string))))
  1199. ;; Adjacent INCLUDE-keywords should have the same :minlevel if unspecified.
  1200. (should
  1201. (cl-every (lambda (level) (zerop (1- level)))
  1202. (org-test-with-temp-text
  1203. (concat
  1204. (format "#+INCLUDE: \"%s/examples/include.org::#ah\"\n"
  1205. org-test-dir)
  1206. (format "#+INCLUDE: \"%s/examples/include.org::*Heading\""
  1207. org-test-dir))
  1208. (org-export-expand-include-keyword)
  1209. (org-element-map (org-element-parse-buffer) 'headline
  1210. (lambda (head) (org-element-property :level head))))))
  1211. ;; INCLUDE does not insert induced :minlevel for src-blocks.
  1212. (should-not
  1213. (equal
  1214. (org-test-with-temp-text
  1215. (format "#+INCLUDE: \"%s/examples/include2.org\" src emacs-lisp"
  1216. org-test-dir)
  1217. (org-export-expand-include-keyword)
  1218. (buffer-string))
  1219. (org-test-with-temp-text
  1220. (format
  1221. "#+INCLUDE: \"%s/examples/include2.org\" src emacs-lisp :minlevel 1"
  1222. org-test-dir)
  1223. (org-export-expand-include-keyword)
  1224. (buffer-string))))
  1225. ;; INCLUDE assigns the relative :minlevel conditional on narrowing.
  1226. (should
  1227. (org-test-with-temp-text-in-file
  1228. (format "* h1\n<point>#+INCLUDE: \"%s/examples/include.org::#ah\""
  1229. org-test-dir)
  1230. (narrow-to-region (point) (point-max))
  1231. (org-export-expand-include-keyword)
  1232. (eq 1 (org-current-level))))
  1233. ;; If :minlevel is present do not alter it.
  1234. (should
  1235. (org-test-with-temp-text
  1236. (format
  1237. "* h1\n<point>#+INCLUDE: \"%s/examples/include.org::#ah\" :minlevel 3"
  1238. org-test-dir)
  1239. (narrow-to-region (point) (point-max))
  1240. (org-export-expand-include-keyword)
  1241. (eq 3 (org-current-level)))))
  1242. (ert-deftest test-org-export/expand-macro ()
  1243. "Test macro expansion in an Org buffer."
  1244. (require 'ox-org)
  1245. ;; Standard macro expansion.
  1246. (should
  1247. (equal "#+MACRO: macro1 value\nvalue\n"
  1248. (org-test-with-temp-text "#+MACRO: macro1 value\n{{{macro1}}}"
  1249. (org-export-as (org-test-default-backend)))))
  1250. ;; Include global macros. However, local macros override them.
  1251. (should
  1252. (equal "global\n"
  1253. (org-test-with-temp-text "{{{M}}}"
  1254. (let ((org-export-global-macros '(("M" . "global"))))
  1255. (org-export-as (org-test-default-backend))))))
  1256. (should
  1257. (equal "global arg\n"
  1258. (org-test-with-temp-text "{{{M(arg)}}}"
  1259. (let ((org-export-global-macros '(("M" . "global $1"))))
  1260. (org-export-as (org-test-default-backend))))))
  1261. (should
  1262. (equal "2\n"
  1263. (org-test-with-temp-text "{{{M}}}"
  1264. (let ((org-export-global-macros '(("M" . "(eval (+ 1 1))"))))
  1265. (org-export-as (org-test-default-backend))))))
  1266. (should
  1267. (equal "#+MACRO: M local\nlocal\n"
  1268. (org-test-with-temp-text "#+macro: M local\n{{{M}}}"
  1269. (let ((org-export-global-macros '(("M" . "global"))))
  1270. (org-export-as (org-test-default-backend))))))
  1271. ;; Allow macro in parsed keywords and associated properties.
  1272. ;; Standard macro expansion.
  1273. (should
  1274. (string-match
  1275. "#\\+K: value"
  1276. (let ((backend (org-export-create-backend
  1277. :parent 'org
  1278. :options '((:k "K" nil nil parse)))))
  1279. (org-test-with-temp-text "#+MACRO: macro value\n#+K: {{{macro}}}"
  1280. (org-export-as backend)))))
  1281. (should
  1282. (string-match
  1283. ":EXPORT_K: v"
  1284. (let ((backend (org-export-create-backend
  1285. :parent 'org
  1286. :options '((:k "K" nil nil parse)))))
  1287. (org-test-with-temp-text
  1288. "#+MACRO: m v\n* H\n:PROPERTIES:\n:EXPORT_K: {{{m}}}\n:END:"
  1289. (org-export-as backend nil nil nil '(:with-properties t))))))
  1290. ;; Expand specific macros.
  1291. (should
  1292. (equal "me 2012-03-29 me@here Title\n"
  1293. (org-test-with-temp-text
  1294. "
  1295. #+TITLE: Title
  1296. #+DATE: 2012-03-29
  1297. #+AUTHOR: me
  1298. #+EMAIL: me@here
  1299. {{{author}}} {{{date}}} {{{email}}} {{{title}}}"
  1300. (let ((output (org-export-as (org-test-default-backend))))
  1301. (substring output (string-match ".*\n\\'" output))))))
  1302. ;; Expand specific macros when property contained a regular macro
  1303. ;; already.
  1304. (should
  1305. (equal "value\n"
  1306. (org-test-with-temp-text "
  1307. #+MACRO: macro1 value
  1308. #+TITLE: {{{macro1}}}
  1309. {{{title}}}"
  1310. (let ((output (org-export-as (org-test-default-backend))))
  1311. (substring output (string-match ".*\n\\'" output))))))
  1312. ;; Expand macros with templates in included files.
  1313. (should
  1314. (equal "success\n"
  1315. (org-test-with-temp-text
  1316. (format "#+INCLUDE: \"%s/examples/macro-templates.org\"
  1317. {{{included-macro}}}" org-test-dir)
  1318. (let ((output (org-export-as (org-test-default-backend))))
  1319. (substring output (string-match ".*\n\\'" output))))))
  1320. ;; Date macro takes a optional formatting argument
  1321. (should
  1322. (equal "09-02-15\n"
  1323. (org-test-with-temp-text "{{{date(%d-%m-%y)}}}\n* d :noexport:\n#+DATE: <2015-02-09>"
  1324. (org-export-as (org-test-default-backend)))))
  1325. ;; Only single timestamps are formatted
  1326. (should
  1327. (equal "<2015-02x-09>\n"
  1328. (org-test-with-temp-text "{{{date(%d-%m-%y)}}}\n* d :noexport:\n#+DATE: <2015-02x-09>"
  1329. (org-export-as (org-test-default-backend)))))
  1330. ;; Throw an error when a macro definition is missing.
  1331. (should-error
  1332. (org-test-with-temp-text "{{{missing}}}"
  1333. (org-export-as (org-test-default-backend))))
  1334. ;; Macros defined in commented subtrees are ignored.
  1335. (should-error
  1336. (org-test-with-temp-text
  1337. "* COMMENT H\n#+MACRO: macro1\n* H2\nvalue\n{{{macro1}}}"
  1338. (org-export-as (org-test-default-backend))))
  1339. (should-error
  1340. (org-test-with-temp-text
  1341. "* COMMENT H\n** H2\n#+MACRO: macro1\n* H3\nvalue\n{{{macro1}}}"
  1342. (org-export-as (org-test-default-backend)))))
  1343. (ert-deftest test-org-export/before-processing-hook ()
  1344. "Test `org-export-before-processing-hook'."
  1345. (should
  1346. (equal
  1347. "#+MACRO: mac val\nTest\n"
  1348. (org-test-with-temp-text "#+MACRO: mac val\n{{{mac}}} Test"
  1349. (let ((org-export-before-processing-hook
  1350. '((lambda (backend)
  1351. (while (re-search-forward "{{{" nil t)
  1352. (let ((object (org-element-context)))
  1353. (when (eq (org-element-type object) 'macro)
  1354. (delete-region
  1355. (org-element-property :begin object)
  1356. (org-element-property :end object)))))))))
  1357. (org-export-as (org-test-default-backend)))))))
  1358. (ert-deftest test-org-export/before-parsing-hook ()
  1359. "Test `org-export-before-parsing-hook'."
  1360. (should
  1361. (equal "Body 1\nBody 2\n"
  1362. (org-test-with-temp-text "* Headline 1\nBody 1\n* Headline 2\nBody 2"
  1363. (let ((org-export-before-parsing-hook
  1364. '((lambda (backend)
  1365. (goto-char (point-min))
  1366. (while (re-search-forward org-outline-regexp-bol nil t)
  1367. (delete-region
  1368. (point-at-bol) (progn (forward-line) (point))))))))
  1369. (org-export-as (org-test-default-backend)))))))
  1370. ;;; Affiliated Keywords
  1371. (ert-deftest test-org-export/read-attribute ()
  1372. "Test `org-export-read-attribute' specifications."
  1373. ;; Standard test.
  1374. (should
  1375. (equal
  1376. (org-export-read-attribute
  1377. :attr_html
  1378. (org-test-with-temp-text "#+ATTR_HTML: :a 1 :b 2\nParagraph"
  1379. (org-element-at-point)))
  1380. '(:a "1" :b "2")))
  1381. ;; Return nil on empty attribute.
  1382. (should-not
  1383. (org-export-read-attribute
  1384. :attr_html
  1385. (org-test-with-temp-text "Paragraph" (org-element-at-point))))
  1386. ;; Return nil on "nil" string.
  1387. (should
  1388. (equal '(:a nil :b nil)
  1389. (org-export-read-attribute
  1390. :attr_html
  1391. (org-test-with-temp-text "#+ATTR_HTML: :a nil :b nil\nParagraph"
  1392. (org-element-at-point)))))
  1393. ;; Return nil on empty string.
  1394. (should
  1395. (equal '(:a nil :b nil)
  1396. (org-export-read-attribute
  1397. :attr_html
  1398. (org-test-with-temp-text "#+ATTR_HTML: :a :b\nParagraph"
  1399. (org-element-at-point)))))
  1400. ;; Return empty string when value is "".
  1401. (should
  1402. (equal '(:a "")
  1403. (org-export-read-attribute
  1404. :attr_html
  1405. (org-test-with-temp-text "#+ATTR_HTML: :a \"\"\nParagraph"
  1406. (org-element-at-point)))))
  1407. ;; Return \"\" when value is """".
  1408. (should
  1409. (equal '(:a "\"\"")
  1410. (org-export-read-attribute
  1411. :attr_html
  1412. (org-test-with-temp-text "#+ATTR_HTML: :a \"\"\"\"\nParagraph"
  1413. (org-element-at-point)))))
  1414. ;; Ignore text before first property.
  1415. (should-not
  1416. (member "ignore"
  1417. (org-export-read-attribute
  1418. :attr_html
  1419. (org-test-with-temp-text "#+ATTR_HTML: ignore :a 1\nParagraph"
  1420. (org-element-at-point))))))
  1421. (ert-deftest test-org-export/get-caption ()
  1422. "Test `org-export-get-caption' specifications."
  1423. ;; Without optional argument, return long caption
  1424. (should
  1425. (equal
  1426. '("l")
  1427. (org-test-with-temp-text "#+CAPTION[s]: l\nPara"
  1428. (org-export-get-caption (org-element-at-point)))))
  1429. ;; With optional argument, return short caption.
  1430. (should
  1431. (equal
  1432. '("s")
  1433. (org-test-with-temp-text "#+CAPTION[s]: l\nPara"
  1434. (org-export-get-caption (org-element-at-point) t))))
  1435. ;; Multiple lines are separated by white spaces.
  1436. (should
  1437. (equal
  1438. '("a" " " "b")
  1439. (org-test-with-temp-text "#+CAPTION: a\n#+CAPTION: b\nPara"
  1440. (org-export-get-caption (org-element-at-point))))))
  1441. ;;; Back-End Tools
  1442. (ert-deftest test-org-export/define-backend ()
  1443. "Test back-end definition and accessors."
  1444. ;; Translate table.
  1445. (should
  1446. (equal '((headline . my-headline-test))
  1447. (let (org-export-registered-backends)
  1448. (org-export-define-backend 'test '((headline . my-headline-test)))
  1449. (org-export-get-all-transcoders 'test))))
  1450. ;; Filters.
  1451. (should
  1452. (equal '((:filter-headline . my-filter))
  1453. (let (org-export-registered-backends)
  1454. (org-export-define-backend 'test
  1455. '((headline . my-headline-test))
  1456. :filters-alist '((:filter-headline . my-filter)))
  1457. (org-export-backend-filters (org-export-get-backend 'test)))))
  1458. ;; Options.
  1459. (should
  1460. (equal '((:prop value))
  1461. (let (org-export-registered-backends)
  1462. (org-export-define-backend 'test
  1463. '((headline . my-headline-test))
  1464. :options-alist '((:prop value)))
  1465. (org-export-backend-options (org-export-get-backend 'test)))))
  1466. ;; Menu.
  1467. (should
  1468. (equal '(?k "Test Export" test)
  1469. (let (org-export-registered-backends)
  1470. (org-export-define-backend 'test
  1471. '((headline . my-headline-test))
  1472. :menu-entry '(?k "Test Export" test))
  1473. (org-export-backend-menu (org-export-get-backend 'test))))))
  1474. (ert-deftest test-org-export/define-derived-backend ()
  1475. "Test `org-export-define-derived-backend' specifications."
  1476. ;; Error when parent back-end is not defined.
  1477. (should-error
  1478. (let (org-export-registered-backends)
  1479. (org-export-define-derived-backend 'test 'parent)))
  1480. ;; Append translation table to parent's.
  1481. (should
  1482. (equal '((:headline . test) (:headline . parent))
  1483. (let (org-export-registered-backends)
  1484. (org-export-define-backend 'parent '((:headline . parent)))
  1485. (org-export-define-derived-backend 'test 'parent
  1486. :translate-alist '((:headline . test)))
  1487. (org-export-get-all-transcoders 'test))))
  1488. ;; Options defined in the new back have priority over those defined
  1489. ;; in parent.
  1490. (should
  1491. (eq 'test
  1492. (let (org-export-registered-backends)
  1493. (org-export-define-backend 'parent
  1494. '((:headline . parent))
  1495. :options-alist '((:a nil nil 'parent)))
  1496. (org-export-define-derived-backend 'test 'parent
  1497. :options-alist '((:a nil nil 'test)))
  1498. (plist-get (org-export--get-global-options
  1499. (org-export-get-backend 'test))
  1500. :a)))))
  1501. (ert-deftest test-org-export/derived-backend-p ()
  1502. "Test `org-export-derived-backend-p' specifications."
  1503. ;; Non-nil with direct match.
  1504. (should
  1505. (let (org-export-registered-backends)
  1506. (org-export-define-backend 'test '((headline . test)))
  1507. (org-export-derived-backend-p 'test 'test)))
  1508. (should
  1509. (let (org-export-registered-backends)
  1510. (org-export-define-backend 'test '((headline . test)))
  1511. (org-export-define-derived-backend 'test2 'test)
  1512. (org-export-derived-backend-p 'test2 'test2)))
  1513. ;; Non-nil with a direct parent.
  1514. (should
  1515. (let (org-export-registered-backends)
  1516. (org-export-define-backend 'test '((headline . test)))
  1517. (org-export-define-derived-backend 'test2 'test)
  1518. (org-export-derived-backend-p 'test2 'test)))
  1519. ;; Non-nil with an indirect parent.
  1520. (should
  1521. (let (org-export-registered-backends)
  1522. (org-export-define-backend 'test '((headline . test)))
  1523. (org-export-define-derived-backend 'test2 'test)
  1524. (org-export-define-derived-backend 'test3 'test2)
  1525. (org-export-derived-backend-p 'test3 'test)))
  1526. ;; Nil otherwise.
  1527. (should-not
  1528. (let (org-export-registered-backends)
  1529. (org-export-define-backend 'test '((headline . test)))
  1530. (org-export-define-backend 'test2 '((headline . test2)))
  1531. (org-export-derived-backend-p 'test2 'test)))
  1532. (should-not
  1533. (let (org-export-registered-backends)
  1534. (org-export-define-backend 'test '((headline . test)))
  1535. (org-export-define-backend 'test2 '((headline . test2)))
  1536. (org-export-define-derived-backend 'test3 'test2)
  1537. (org-export-derived-backend-p 'test3 'test))))
  1538. (ert-deftest test-org-export/get-all-transcoders ()
  1539. "Test `org-export-get-all-transcoders' specifications."
  1540. ;; Return nil when back-end cannot be found.
  1541. (should-not (org-export-get-all-transcoders nil))
  1542. ;; Same as `org-export-transcoders' if no parent.
  1543. (should
  1544. (equal '((headline . ignore))
  1545. (org-export-get-all-transcoders
  1546. (org-export-create-backend
  1547. :transcoders '((headline . ignore))))))
  1548. ;; But inherit from all ancestors whenever possible.
  1549. (should
  1550. (equal '((section . ignore) (headline . ignore))
  1551. (let (org-export-registered-backends)
  1552. (org-export-define-backend 'b1 '((headline . ignore)))
  1553. (org-export-get-all-transcoders
  1554. (org-export-create-backend
  1555. :parent 'b1 :transcoders '((section . ignore)))))))
  1556. (should
  1557. (equal '((paragraph . ignore) (section . ignore) (headline . ignore))
  1558. (let (org-export-registered-backends)
  1559. (org-export-define-backend 'b1 '((headline . ignore)))
  1560. (org-export-define-derived-backend 'b2 'b1
  1561. :translate-alist '((section . ignore)))
  1562. (org-export-get-all-transcoders
  1563. (org-export-create-backend
  1564. :parent 'b2 :transcoders '((paragraph . ignore)))))))
  1565. ;; Back-end transcoders overrule inherited ones.
  1566. (should
  1567. (eq 'b
  1568. (let (org-export-registered-backends)
  1569. (org-export-define-backend 'b1 '((headline . a)))
  1570. (cdr (assq 'headline
  1571. (org-export-get-all-transcoders
  1572. (org-export-create-backend
  1573. :parent 'b1 :transcoders '((headline . b))))))))))
  1574. (ert-deftest test-org-export/get-all-options ()
  1575. "Test `org-export-get-all-options' specifications."
  1576. ;; Return nil when back-end cannot be found.
  1577. (should-not (org-export-get-all-options nil))
  1578. ;; Same as `org-export-options' if no parent.
  1579. (should
  1580. (equal '((headline . ignore))
  1581. (org-export-get-all-options
  1582. (org-export-create-backend
  1583. :options '((headline . ignore))))))
  1584. ;; But inherit from all ancestors whenever possible.
  1585. (should
  1586. (equal '((:key2 value2) (:key1 value1))
  1587. (let (org-export-registered-backends)
  1588. (org-export-define-backend 'b1 nil :options-alist '((:key1 value1)))
  1589. (org-export-get-all-options
  1590. (org-export-create-backend
  1591. :parent 'b1 :options '((:key2 value2)))))))
  1592. (should
  1593. (equal '((:key3 value3) (:key2 value2) (:key1 value1))
  1594. (let (org-export-registered-backends)
  1595. (org-export-define-backend 'b1 nil :options-alist '((:key1 value1)))
  1596. (org-export-define-derived-backend 'b2 'b1
  1597. :options-alist '((:key2 value2)))
  1598. (org-export-get-all-options
  1599. (org-export-create-backend
  1600. :parent 'b2 :options '((:key3 value3)))))))
  1601. ;; Back-end options overrule inherited ones.
  1602. (should
  1603. (eq 'b
  1604. (let (org-export-registered-backends)
  1605. (org-export-define-backend 'b1 nil :options-alist '((:key1 . a)))
  1606. (cdr (assq :key1
  1607. (org-export-get-all-options
  1608. (org-export-create-backend
  1609. :parent 'b1 :options '((:key1 . b))))))))))
  1610. (ert-deftest test-org-export/get-all-filters ()
  1611. "Test `org-export-get-all-filters' specifications."
  1612. ;; Return nil when back-end cannot be found.
  1613. (should-not (org-export-get-all-filters nil))
  1614. ;; Same as `org-export-filters' if no parent.
  1615. (should
  1616. (equal '((:filter-headline . ignore))
  1617. (org-export-get-all-filters
  1618. (org-export-create-backend
  1619. :filters '((:filter-headline . ignore))))))
  1620. ;; But inherit from all ancestors whenever possible.
  1621. (should
  1622. (equal '((:filter-section . ignore) (:filter-headline . ignore))
  1623. (let (org-export-registered-backends)
  1624. (org-export-define-backend 'b1
  1625. nil :filters-alist '((:filter-headline . ignore)))
  1626. (org-export-get-all-filters
  1627. (org-export-create-backend
  1628. :parent 'b1 :filters '((:filter-section . ignore)))))))
  1629. (should
  1630. (equal '((:filter-paragraph . ignore)
  1631. (:filter-section . ignore)
  1632. (:filter-headline . ignore))
  1633. (let (org-export-registered-backends)
  1634. (org-export-define-backend 'b1
  1635. nil :filters-alist '((:filter-headline . ignore)))
  1636. (org-export-define-derived-backend 'b2 'b1
  1637. :filters-alist '((:filter-section . ignore)))
  1638. (org-export-get-all-filters
  1639. (org-export-create-backend
  1640. :parent 'b2 :filters '((:filter-paragraph . ignore)))))))
  1641. ;; Back-end filters overrule inherited ones.
  1642. (should
  1643. (eq 'b
  1644. (let (org-export-registered-backends)
  1645. (org-export-define-backend 'b1 '((:filter-headline . a)))
  1646. (cdr (assq :filter-headline
  1647. (org-export-get-all-filters
  1648. (org-export-create-backend
  1649. :parent 'b1 :filters '((:filter-headline . b))))))))))
  1650. (ert-deftest test-org-export/with-backend ()
  1651. "Test `org-export-with-backend' definition."
  1652. ;; Error when calling an undefined back-end
  1653. (should-error (org-export-with-backend nil "Test"))
  1654. ;; Error when called back-end doesn't have an appropriate
  1655. ;; transcoder.
  1656. (should-error
  1657. (org-export-with-backend
  1658. (org-export-create-backend :transcoders '((headline . ignore)))
  1659. "Test"))
  1660. ;; Otherwise, export using correct transcoder
  1661. (should
  1662. (equal "Success"
  1663. (let (org-export-registered-backends)
  1664. (org-export-define-backend 'test
  1665. '((plain-text . (lambda (text contents info) "Failure"))))
  1666. (org-export-define-backend 'test2
  1667. '((plain-text . (lambda (text contents info) "Success"))))
  1668. (org-export-with-backend 'test2 "Test"))))
  1669. ;; Provide correct back-end if transcoder needs to use recursive
  1670. ;; calls anyway.
  1671. (should
  1672. (equal "Success\n"
  1673. (let ((test-back-end
  1674. (org-export-create-backend
  1675. :transcoders
  1676. (list (cons 'headline
  1677. (lambda (headline contents info)
  1678. (org-export-data
  1679. (org-element-property :title headline)
  1680. info)))
  1681. (cons 'plain-text (lambda (text info) "Success"))))))
  1682. (org-export-string-as
  1683. "* Test"
  1684. (org-export-create-backend
  1685. :transcoders
  1686. (list (cons 'headline
  1687. (lambda (headline contents info)
  1688. (org-export-with-backend
  1689. test-back-end headline contents info))))))))))
  1690. (ert-deftest test-org-export/data-with-backend ()
  1691. "Test `org-export-data-with-backend' specifications."
  1692. ;; Error when calling an undefined back-end.
  1693. (should-error (org-export-data-with-backend nil "nil" nil))
  1694. ;; Otherwise, export data recursively, using correct back-end.
  1695. (should
  1696. (equal
  1697. "Success!"
  1698. (org-export-data-with-backend
  1699. '(bold nil "Test")
  1700. (org-export-create-backend
  1701. :transcoders
  1702. '((plain-text . (lambda (text info) "Success"))
  1703. (bold . (lambda (bold contents info) (concat contents "!")))))
  1704. '(:with-emphasize t)))))
  1705. ;;; Comments
  1706. (ert-deftest test-org-export/comments ()
  1707. "Test comments handling during export.
  1708. In particular, structure of the document mustn't be altered after
  1709. comments removal."
  1710. (should
  1711. (equal "Para1\n\nPara2\n"
  1712. (org-test-with-temp-text "
  1713. Para1
  1714. # Comment
  1715. # Comment
  1716. Para2"
  1717. (org-export-as (org-test-default-backend)))))
  1718. (should
  1719. (equal "Para1\n\nPara2\n"
  1720. (org-test-with-temp-text "
  1721. Para1
  1722. # Comment
  1723. Para2"
  1724. (org-export-as (org-test-default-backend)))))
  1725. (should
  1726. (equal "[fn:1] Para1\n\n\nPara2\n"
  1727. (org-test-with-temp-text "
  1728. \[fn:1] Para1
  1729. # Inside definition
  1730. # Outside definition
  1731. Para2"
  1732. (org-export-as (org-test-default-backend)))))
  1733. (should
  1734. (equal "[fn:1] Para1\n\nPara2\n"
  1735. (org-test-with-temp-text "
  1736. \[fn:1] Para1
  1737. # Inside definition
  1738. # Inside definition
  1739. Para2"
  1740. (org-export-as (org-test-default-backend)))))
  1741. (should
  1742. (equal "[fn:1] Para1\n\nPara2\n"
  1743. (org-test-with-temp-text "
  1744. \[fn:1] Para1
  1745. # Inside definition
  1746. Para2"
  1747. (org-export-as (org-test-default-backend)))))
  1748. (should
  1749. (equal "[fn:1] Para1\n\nPara2\n"
  1750. (org-test-with-temp-text "
  1751. \[fn:1] Para1
  1752. # Inside definition
  1753. Para2"
  1754. (org-export-as (org-test-default-backend)))))
  1755. (should
  1756. (equal "- item 1\n\n- item 2\n"
  1757. (org-test-with-temp-text "
  1758. - item 1
  1759. # Comment
  1760. - item 2"
  1761. (org-export-as (org-test-default-backend))))))
  1762. ;;; Export blocks
  1763. (ert-deftest test-org-export/export-block ()
  1764. "Test export blocks transcoding."
  1765. (should
  1766. (equal "Success!\n"
  1767. (org-test-with-temp-text
  1768. "#+BEGIN_EXPORT backend\nSuccess!\n#+END_EXPORT"
  1769. (org-export-as
  1770. (org-export-create-backend
  1771. :transcoders '((export-block . (lambda (b _c _i)
  1772. (org-element-property :value b)))
  1773. (section . (lambda (_s c _i) c))))))))
  1774. (should
  1775. (equal "Success!\n"
  1776. (org-test-with-temp-text
  1777. "#+BEGIN_EXPORT backend\nSuccess!\n#+END_EXPORT"
  1778. (org-export-as
  1779. (org-export-create-backend
  1780. :transcoders
  1781. (list
  1782. (cons 'export-block
  1783. (lambda (b _c _i)
  1784. (and (equal (org-element-property :type b) "BACKEND")
  1785. (org-element-property :value b))))
  1786. (cons 'section (lambda (_s c _i) c)))))))))
  1787. ;;; Export Snippets
  1788. (ert-deftest test-org-export/export-snippet ()
  1789. "Test export snippets transcoding."
  1790. ;; Standard test.
  1791. (org-test-with-temp-text "@@test:A@@@@t:B@@"
  1792. (let ((backend (org-test-default-backend)))
  1793. (setf (org-export-backend-name backend) 'test)
  1794. (setf (org-export-backend-transcoders backend)
  1795. (cons (cons 'export-snippet
  1796. (lambda (snippet contents info)
  1797. (when (eq (org-export-snippet-backend snippet) 'test)
  1798. (org-element-property :value snippet))))
  1799. (org-export-backend-transcoders backend)))
  1800. (let ((org-export-snippet-translation-alist nil))
  1801. (should (equal (org-export-as backend) "A\n")))
  1802. (let ((org-export-snippet-translation-alist '(("t" . "test"))))
  1803. (should (equal (org-export-as backend) "AB\n")))))
  1804. ;; Ignored export snippets do not remove any blank.
  1805. (should
  1806. (equal "begin end\n"
  1807. (org-test-with-parsed-data "begin @@test:A@@ end"
  1808. (org-export-data-with-backend
  1809. tree
  1810. (org-export-create-backend
  1811. :transcoders
  1812. '((paragraph . (lambda (paragraph contents info) contents))
  1813. (section . (lambda (section contents info) contents))))
  1814. info)))))
  1815. ;;; Filters
  1816. (ert-deftest test-org-export/filter-apply-functions ()
  1817. "Test `org-export-filter-apply-functions' specifications."
  1818. ;; Functions are applied in order and return values are reduced.
  1819. (should
  1820. (equal "210"
  1821. (org-export-filter-apply-functions
  1822. (list (lambda (value &rest _) (concat "1" value))
  1823. (lambda (value &rest _) (concat "2" value)))
  1824. "0" nil)))
  1825. ;; Functions returning nil are skipped.
  1826. (should
  1827. (equal "20"
  1828. (org-export-filter-apply-functions
  1829. (list #'ignore (lambda (value &rest _) (concat "2" value)))
  1830. "0" nil)))
  1831. ;; If all functions are skipped, return the initial value.
  1832. (should
  1833. (equal "0"
  1834. (org-export-filter-apply-functions (list #'ignore) "0" nil)))
  1835. ;; If any function returns the empty string, final value is the
  1836. ;; empty string.
  1837. (should
  1838. (equal ""
  1839. (org-export-filter-apply-functions
  1840. (list (lambda (value &rest _) "")
  1841. (lambda (value &rest _) (concat "2" value)))
  1842. "0" nil)))
  1843. ;; Any function returning the empty string short-circuits the
  1844. ;; process.
  1845. (should
  1846. (org-export-filter-apply-functions
  1847. (list (lambda (value &rest _) "")
  1848. (lambda (value &rest _) (error "This shouldn't happen")))
  1849. "0" nil)))
  1850. ;;; Footnotes
  1851. (ert-deftest test-org-export/footnote-first-reference-p ()
  1852. "Test `org-export-footnote-first-reference-p' specifications."
  1853. (should
  1854. (equal
  1855. '(t nil)
  1856. (org-test-with-temp-text "Text[fn:1][fn:1]\n\n[fn:1] Definition"
  1857. (let (result)
  1858. (org-export-as
  1859. (org-export-create-backend
  1860. :transcoders
  1861. `(,(cons 'footnote-reference
  1862. (lambda (f c i)
  1863. (push (org-export-footnote-first-reference-p f i)
  1864. result)
  1865. ""))
  1866. (section . (lambda (s c i) c))
  1867. (paragraph . (lambda (p c i) c))))
  1868. nil nil nil '(:with-footnotes t))
  1869. (nreverse result)))))
  1870. ;; Limit check to DATA, when non-nil.
  1871. (should
  1872. (equal
  1873. '(nil t)
  1874. (org-test-with-parsed-data "Text[fn:1]\n* H\nText[fn:1]\n\n[fn:1] D1"
  1875. (let (result)
  1876. (org-element-map tree 'footnote-reference
  1877. (lambda (ref)
  1878. (push
  1879. (org-export-footnote-first-reference-p
  1880. ref info (org-element-map tree 'headline #'identity info t))
  1881. result))
  1882. info)
  1883. (nreverse result)))))
  1884. (should
  1885. (equal
  1886. '(t nil)
  1887. (org-test-with-parsed-data "Text[fn:1]\n* H\nText[fn:1]\n\n[fn:1] D1"
  1888. (let (result)
  1889. (org-element-map tree 'footnote-reference
  1890. (lambda (ref)
  1891. (push (org-export-footnote-first-reference-p ref info) result))
  1892. info)
  1893. (nreverse result)))))
  1894. ;; If optional argument BODY-FIRST is non-nil, first find footnote
  1895. ;; in the main body of the document. Otherwise, enter footnote
  1896. ;; definitions when they are encountered.
  1897. (should
  1898. (equal
  1899. '(t nil)
  1900. (org-test-with-temp-text
  1901. ":BODY:\nText[fn:1][fn:2]\n:END:\n\n[fn:1] Definition[fn:2]\n\n[fn:2] Inner"
  1902. (let (result)
  1903. (org-export-as
  1904. (org-export-create-backend
  1905. :transcoders
  1906. `(,(cons 'footnote-reference
  1907. (lambda (f c i)
  1908. (when (org-element-lineage f '(drawer))
  1909. (push (org-export-footnote-first-reference-p f i nil)
  1910. result))
  1911. ""))
  1912. (drawer . (lambda (d c i) c))
  1913. (footnote-definition . (lambda (d c i) c))
  1914. (section . (lambda (s c i) c))
  1915. (paragraph . (lambda (p c i) c))))
  1916. nil nil nil '(:with-footnotes t))
  1917. (nreverse result)))))
  1918. (should
  1919. (equal
  1920. '(t t)
  1921. (org-test-with-temp-text
  1922. ":BODY:\nText[fn:1][fn:2]\n:END:\n\n[fn:1] Definition[fn:2]\n\n[fn:2] Inner"
  1923. (let (result)
  1924. (org-export-as
  1925. (org-export-create-backend
  1926. :transcoders
  1927. `(,(cons 'footnote-reference
  1928. (lambda (f c i)
  1929. (when (org-element-lineage f '(drawer))
  1930. (push (org-export-footnote-first-reference-p f i nil t)
  1931. result))
  1932. ""))
  1933. (drawer . (lambda (d c i) c))
  1934. (footnote-definition . (lambda (d c i) c))
  1935. (section . (lambda (s c i) c))
  1936. (paragraph . (lambda (p c i) c))))
  1937. nil nil nil '(:with-footnotes t))
  1938. (nreverse result))))))
  1939. (ert-deftest test-org-export/get-footnote-number ()
  1940. "Test `org-export-get-footnote-number' specifications."
  1941. (should
  1942. (equal '(1 2 1)
  1943. (org-test-with-parsed-data
  1944. "Text[fn:1][fn:2][fn:1]\n\n[fn:1] Def\n[fn:2] Def"
  1945. (org-element-map tree 'footnote-reference
  1946. (lambda (ref) (org-export-get-footnote-number ref info))
  1947. info))))
  1948. ;; Anonymous footnotes all get a new number.
  1949. (should
  1950. (equal '(1 2)
  1951. (org-test-with-parsed-data
  1952. "Text[fn::anon1][fn::anon2]"
  1953. (org-element-map tree 'footnote-reference
  1954. (lambda (ref) (org-export-get-footnote-number ref info))
  1955. info))))
  1956. ;; Test nested footnotes order.
  1957. (should
  1958. (equal
  1959. '((1 . "1") (2 . "2") (3 . "3") (3 . "3") (4))
  1960. (org-test-with-parsed-data
  1961. "Text[fn:1:A[fn:2]] [fn:3].\n\n[fn:2] B [fn:3] [fn::D].\n\n[fn:3] C."
  1962. (org-element-map tree 'footnote-reference
  1963. (lambda (ref)
  1964. (cons (org-export-get-footnote-number ref info)
  1965. (org-element-property :label ref)))
  1966. info))))
  1967. ;; Limit number to provided DATA, when non-nil.
  1968. (should
  1969. (equal
  1970. '(1)
  1971. (org-test-with-parsed-data
  1972. "Text[fn:1]\n* H\nText[fn:2]\n\n[fn:1] D1\n[fn:2] D2"
  1973. (org-element-map tree 'footnote-reference
  1974. (lambda (ref)
  1975. (org-export-get-footnote-number
  1976. ref info (org-element-map tree 'headline #'identity info t)))
  1977. info))))
  1978. (should
  1979. (equal
  1980. '(1 2)
  1981. (org-test-with-parsed-data
  1982. "Text[fn:1]\n* H\nText[fn:2]\n\n[fn:1] D1\n[fn:2]"
  1983. (org-element-map tree 'footnote-reference
  1984. (lambda (ref) (org-export-get-footnote-number ref info))
  1985. info))))
  1986. ;; With a non-nil BODY-FIRST optional argument, first check body,
  1987. ;; then footnote definitions.
  1988. (should
  1989. (equal
  1990. '(("1" . 1) ("2" . 2) ("3" . 3) ("3" . 3))
  1991. (org-test-with-parsed-data
  1992. "Text[fn:1][fn:2][fn:3]\n\n[fn:1] Def[fn:3]\n[fn:2] Def\n[fn:3] Def"
  1993. (org-element-map tree 'footnote-reference
  1994. (lambda (ref)
  1995. (cons (org-element-property :label ref)
  1996. (org-export-get-footnote-number ref info nil t)))
  1997. info))))
  1998. (should
  1999. (equal
  2000. '(("1" . 1) ("2" . 3) ("3" . 2) ("3" . 2))
  2001. (org-test-with-parsed-data
  2002. "Text[fn:1][fn:2][fn:3]\n\n[fn:1] Def[fn:3]\n[fn:2] Def\n[fn:3] Def"
  2003. (org-element-map tree 'footnote-reference
  2004. (lambda (ref)
  2005. (cons (org-element-property :label ref)
  2006. (org-export-get-footnote-number ref info nil)))
  2007. info)))))
  2008. (ert-deftest test-org-export/get-footnote-definition ()
  2009. "Test `org-export-get-footnote-definition' specifications."
  2010. ;; Standard test.
  2011. (should
  2012. (equal "A\n"
  2013. (org-element-interpret-data
  2014. (org-test-with-parsed-data "Text[fn:1]\n\n[fn:1] A"
  2015. (org-export-get-footnote-definition
  2016. (org-element-map tree 'footnote-reference #'identity nil t)
  2017. info)))))
  2018. ;; Raise an error if no definition is found.
  2019. (should-error
  2020. (org-test-with-parsed-data "Text[fn:1]"
  2021. (org-export-get-footnote-definition
  2022. (org-element-map tree 'footnote-reference #'identity nil t)
  2023. info)))
  2024. ;; Find inline definitions.
  2025. (should
  2026. (equal "A"
  2027. (org-element-interpret-data
  2028. (org-test-with-parsed-data "Text[fn:1:A]"
  2029. (org-export-get-footnote-definition
  2030. (org-element-map tree 'footnote-reference #'identity nil t)
  2031. info)))))
  2032. ;; Find anonymous definitions.
  2033. (should
  2034. (equal "A"
  2035. (org-element-interpret-data
  2036. (org-test-with-parsed-data "Text[fn::A]"
  2037. (org-export-get-footnote-definition
  2038. (org-element-map tree 'footnote-reference #'identity nil t)
  2039. info)))))
  2040. ;; Find empty definitions.
  2041. (should
  2042. (equal ""
  2043. (org-element-interpret-data
  2044. (org-test-with-parsed-data "Text[fn:1]\n\n[fn:1]"
  2045. (org-export-get-footnote-definition
  2046. (org-element-map tree 'footnote-reference #'identity nil t)
  2047. info)))))
  2048. (should
  2049. (equal ""
  2050. (org-element-interpret-data
  2051. (org-test-with-parsed-data "Text[fn:1:]"
  2052. (org-export-get-footnote-definition
  2053. (org-element-map tree 'footnote-reference #'identity nil t)
  2054. info)))))
  2055. (should
  2056. (equal ""
  2057. (org-element-interpret-data
  2058. (org-test-with-parsed-data "Text[fn::]"
  2059. (org-export-get-footnote-definition
  2060. (org-element-map tree 'footnote-reference #'identity nil t)
  2061. info))))))
  2062. (ert-deftest test-org-export/collect-footnote-definitions ()
  2063. "Test `org-export-collect-footnote-definitions' specifications."
  2064. (should
  2065. (= 4
  2066. (org-test-with-parsed-data "Text[fn:1:A[fn:2]] [fn:3].
  2067. \[fn:2] B [fn:3] [fn::D].
  2068. \[fn:3] C."
  2069. (length (org-export-collect-footnote-definitions info)))))
  2070. ;; Limit number to provided DATA, when non-nil.
  2071. (should
  2072. (equal
  2073. '((1 "2"))
  2074. (org-test-with-parsed-data
  2075. "Text[fn:1]\n* H\nText[fn:2]\n\n[fn:1] D1\n[fn:2] D2"
  2076. (mapcar #'butlast
  2077. (org-export-collect-footnote-definitions
  2078. info (org-element-map tree 'headline #'identity info t))))))
  2079. (should
  2080. (equal
  2081. '((1 "1") (2 "2"))
  2082. (org-test-with-parsed-data
  2083. "Text[fn:1]\n* H\nText[fn:2]\n\n[fn:1] D1\n[fn:2] D2"
  2084. (mapcar #'butlast (org-export-collect-footnote-definitions info)))))
  2085. ;; With optional argument BODY-FIRST, first check body, then
  2086. ;; footnote definitions.
  2087. (should
  2088. (equal '("1" "3" "2" nil)
  2089. (org-test-with-parsed-data "Text[fn:1:A[fn:2]] [fn:3].
  2090. \[fn:2] B [fn:3] [fn::D].
  2091. \[fn:3] C."
  2092. (mapcar (lambda (e) (nth 1 e))
  2093. (org-export-collect-footnote-definitions info nil t)))))
  2094. (should-not
  2095. (equal '("1" "3" "2" nil)
  2096. (org-test-with-parsed-data "Text[fn:1:A[fn:2]] [fn:3].
  2097. \[fn:2] B [fn:3] [fn::D].
  2098. \[fn:3] C."
  2099. (mapcar (lambda (e) (nth 1 e))
  2100. (org-export-collect-footnote-definitions info))))))
  2101. (ert-deftest test-org-export/footnotes ()
  2102. "Miscellaneous tests on footnotes."
  2103. (let ((org-footnote-section nil)
  2104. (org-export-with-footnotes t))
  2105. ;; Read every type of footnote.
  2106. (should
  2107. (equal
  2108. '((1 . "A\n") (2 . "C") (3 . "D"))
  2109. (org-test-with-parsed-data
  2110. "Text[fn:1] [fn:label:C] [fn::D]\n\n[fn:1] A\n"
  2111. (org-element-map tree 'footnote-reference
  2112. (lambda (ref)
  2113. (let ((def (org-export-get-footnote-definition ref info)))
  2114. (cons (org-export-get-footnote-number ref info)
  2115. (if (eq (org-element-property :type ref) 'inline) (car def)
  2116. (car (org-element-contents
  2117. (car (org-element-contents def))))))))
  2118. info))))
  2119. ;; Export nested footnote in invisible definitions.
  2120. (should
  2121. (= 2
  2122. (org-test-with-temp-text "Text[fn:1]\n\n[fn:1] B [fn:2]\n\n[fn:2] C."
  2123. (narrow-to-region (point) (line-end-position))
  2124. (catch 'exit
  2125. (org-export-as
  2126. (org-export-create-backend
  2127. :transcoders
  2128. '((section
  2129. .
  2130. (lambda (s c i)
  2131. (throw 'exit (length
  2132. (org-export-collect-footnote-definitions
  2133. i))))))))))))
  2134. ;; Export footnotes defined outside parsing scope.
  2135. (should
  2136. (string-match
  2137. "Out of scope"
  2138. (org-test-with-temp-text "[fn:1] Out of scope
  2139. * Title
  2140. <point>Paragraph[fn:1]"
  2141. (org-export-as (org-test-default-backend) 'subtree))))
  2142. (should
  2143. (string-match
  2144. "Out of scope"
  2145. (org-test-with-temp-text "[fn:1] Out of scope
  2146. * Title
  2147. <point>Paragraph[fn:1]"
  2148. (narrow-to-region (point) (point-max))
  2149. (org-export-as (org-test-default-backend)))))
  2150. ;; Export nested footnotes defined outside parsing scope.
  2151. (should
  2152. (string-match
  2153. "Very out of scope"
  2154. (org-test-with-temp-text "
  2155. \[fn:1] Out of scope[fn:2]
  2156. \[fn:2] Very out of scope
  2157. * Title
  2158. <point>Paragraph[fn:1]"
  2159. (org-export-as (org-test-default-backend) 'subtree))))
  2160. (should
  2161. (string-match
  2162. "Very out of scope"
  2163. (org-test-with-temp-text "
  2164. \[fn:1] Out of scope[fn:2]
  2165. \[fn:2] Very out of scope
  2166. * Title
  2167. <point>Paragraph[fn:1]"
  2168. (narrow-to-region (point) (point-max))
  2169. (org-export-as (org-test-default-backend)))))
  2170. (should
  2171. (string-match
  2172. "D2"
  2173. (org-test-with-temp-text "
  2174. \[fn:1] Out of scope[fn:2:D2]
  2175. * Title
  2176. <point>Paragraph[fn:1]"
  2177. (narrow-to-region (point) (point-max))
  2178. (org-export-as (org-test-default-backend)))))
  2179. ;; Export footnotes in pruned parts of tree.
  2180. (should
  2181. (string-match
  2182. "Definition"
  2183. (let ((org-export-exclude-tags '("noexport")))
  2184. (org-test-with-temp-text
  2185. "* H\nText[fn:1]\n* H2 :noexport:\n[fn:1] Definition"
  2186. (org-export-as (org-test-default-backend))))))
  2187. (should
  2188. (string-match
  2189. "Definition"
  2190. (let ((org-export-select-tags '("export")))
  2191. (org-test-with-temp-text
  2192. "* H :export:\nText[fn:1]\n* H2\n[fn:1] Definition"
  2193. (org-export-as (org-test-default-backend))))))
  2194. ;; Export nested footnotes in pruned parts of tree.
  2195. (should
  2196. (string-match
  2197. "D2"
  2198. (let ((org-export-exclude-tags '("noexport")))
  2199. (org-test-with-temp-text
  2200. "* H\nText[fn:1]\n* H2 :noexport:\n[fn:1] D1[fn:2]\n\n[fn:2] D2"
  2201. (org-export-as (org-test-default-backend))))))
  2202. (should
  2203. (string-match
  2204. "D2"
  2205. (let ((org-export-select-tags '("export")))
  2206. (org-test-with-temp-text
  2207. "* H :export:\nText[fn:1]\n* H2\n[fn:1] D1[fn:2]\n\n[fn:2] D2"
  2208. (org-export-as (org-test-default-backend))))))
  2209. ;; Handle uninterpreted data in pruned footnote definitions.
  2210. (should-not
  2211. (string-match
  2212. "|"
  2213. (let ((org-export-with-tables nil))
  2214. (org-test-with-temp-text
  2215. "* H\nText[fn:1]\n* H2 :noexport:\n[fn:1]\n| a |"
  2216. (org-export-as (org-test-default-backend))))))
  2217. ;; Footnotes without a definition should throw an error.
  2218. (should-error
  2219. (org-test-with-parsed-data "Text[fn:1]"
  2220. (org-export-get-footnote-definition
  2221. (org-element-map tree 'footnote-reference #'identity info t) info)))
  2222. ;; Footnote section should be ignored in TOC and in headlines
  2223. ;; numbering.
  2224. (should
  2225. (= 1 (let ((org-footnote-section "Footnotes"))
  2226. (length (org-test-with-parsed-data "* H1\n* Footnotes\n"
  2227. (org-export-collect-headlines info))))))
  2228. (should
  2229. (equal '(2)
  2230. (let ((org-footnote-section "Footnotes"))
  2231. (org-test-with-parsed-data "* H1\n* Footnotes\n* H2"
  2232. (org-element-map tree 'headline
  2233. (lambda (hl)
  2234. (when (equal (org-element-property :raw-value hl) "H2")
  2235. (org-export-get-headline-number hl info)))
  2236. info t)))))))
  2237. ;;; Headlines and Inlinetasks
  2238. (ert-deftest test-org-export/get-relative-level ()
  2239. "Test `org-export-get-relative-level' specifications."
  2240. ;; Standard test.
  2241. (should
  2242. (equal '(1 2)
  2243. (let ((org-odd-levels-only nil))
  2244. (org-test-with-parsed-data "* Headline 1\n** Headline 2"
  2245. (org-element-map tree 'headline
  2246. (lambda (h) (org-export-get-relative-level h info))
  2247. info)))))
  2248. ;; Missing levels
  2249. (should
  2250. (equal '(1 3)
  2251. (let ((org-odd-levels-only nil))
  2252. (org-test-with-parsed-data "** Headline 1\n**** Headline 2"
  2253. (org-element-map tree 'headline
  2254. (lambda (h) (org-export-get-relative-level h info))
  2255. info))))))
  2256. (ert-deftest test-org-export/low-level-p ()
  2257. "Test `org-export-low-level-p' specifications."
  2258. (should
  2259. (equal
  2260. '(no yes)
  2261. (let ((org-odd-levels-only nil))
  2262. (org-test-with-parsed-data "* Headline 1\n** Headline 2"
  2263. (org-element-map tree 'headline
  2264. (lambda (h) (if (org-export-low-level-p h info) 'yes 'no))
  2265. (plist-put info :headline-levels 1)))))))
  2266. (ert-deftest test-org-export/get-headline-number ()
  2267. "Test `org-export-get-headline-number' specifications."
  2268. ;; Standard test.
  2269. (should
  2270. (equal
  2271. '((1) (1 1))
  2272. (let ((org-odd-levels-only nil))
  2273. (org-test-with-parsed-data "* Headline 1\n** Headline 2"
  2274. (org-element-map tree 'headline
  2275. (lambda (h) (org-export-get-headline-number h info))
  2276. info)))))
  2277. ;; Missing levels are replaced with 0.
  2278. (should
  2279. (equal
  2280. '((1) (1 0 1))
  2281. (let ((org-odd-levels-only nil))
  2282. (org-test-with-parsed-data "* Headline 1\n*** Headline 2"
  2283. (org-element-map tree 'headline
  2284. (lambda (h) (org-export-get-headline-number h info))
  2285. info))))))
  2286. (ert-deftest test-org-export/numbered-headline-p ()
  2287. "Test `org-export-numbered-headline-p' specifications."
  2288. ;; If `:section-numbers' is nil, never number headlines.
  2289. (should-not
  2290. (org-test-with-parsed-data "* Headline"
  2291. (org-element-map tree 'headline
  2292. (lambda (h) (org-export-numbered-headline-p h info))
  2293. (plist-put info :section-numbers nil))))
  2294. ;; If `:section-numbers' is a number, only number headlines with
  2295. ;; a level greater that it.
  2296. (should
  2297. (equal
  2298. '(yes no)
  2299. (org-test-with-parsed-data "* Headline 1\n** Headline 2"
  2300. (org-element-map tree 'headline
  2301. (lambda (h) (if (org-export-numbered-headline-p h info) 'yes 'no))
  2302. (plist-put info :section-numbers 1)))))
  2303. ;; Otherwise, headlines are always numbered.
  2304. (should
  2305. (org-test-with-parsed-data "* Headline"
  2306. (org-element-map tree 'headline
  2307. (lambda (h) (org-export-numbered-headline-p h info))
  2308. (plist-put info :section-numbers t))))
  2309. ;; With #+OPTIONS: num:nil all headlines are unnumbered.
  2310. (should-not
  2311. (org-test-with-parsed-data "* H\n#+OPTIONS: num:nil"
  2312. (org-export-numbered-headline-p
  2313. (org-element-map tree 'headline 'identity info t)
  2314. info)))
  2315. ;; Headlines with a non-nil UNNUMBERED property are not numbered.
  2316. (should-not
  2317. (org-test-with-parsed-data "* H\n:PROPERTIES:\n:UNNUMBERED: t\n:END:"
  2318. (org-export-numbered-headline-p
  2319. (org-element-map tree 'headline #'identity info t)
  2320. info)))
  2321. ;; UNNUMBERED ignores inheritance. Any non-nil value among
  2322. ;; ancestors disables numbering.
  2323. (should
  2324. (org-test-with-parsed-data
  2325. "* H
  2326. :PROPERTIES:
  2327. :UNNUMBERED: t
  2328. :END:
  2329. ** H2
  2330. :PROPERTIES:
  2331. :UNNUMBERED: nil
  2332. :END:
  2333. *** H3"
  2334. (cl-every
  2335. (lambda (h) (not (org-export-numbered-headline-p h info)))
  2336. (org-element-map tree 'headline #'identity info)))))
  2337. (ert-deftest test-org-export/number-to-roman ()
  2338. "Test `org-export-number-to-roman' specifications."
  2339. ;; If number is negative, return it as a string.
  2340. (should (equal (org-export-number-to-roman -1) "-1"))
  2341. ;; Otherwise, return it as a roman number.
  2342. (should (equal (org-export-number-to-roman 1449) "MCDXLIX")))
  2343. (ert-deftest test-org-export/get-optional-title ()
  2344. "Test `org-export-get-alt-title' specifications."
  2345. ;; If ALT_TITLE property is defined, use it.
  2346. (should
  2347. (equal '("opt")
  2348. (org-test-with-parsed-data
  2349. "* Headline\n:PROPERTIES:\n:ALT_TITLE: opt\n:END:"
  2350. (org-export-get-alt-title
  2351. (org-element-map tree 'headline 'identity info t)
  2352. info))))
  2353. ;; Otherwise, fall-back to regular title.
  2354. (should
  2355. (equal '("Headline")
  2356. (org-test-with-parsed-data "* Headline"
  2357. (org-export-get-alt-title
  2358. (org-element-map tree 'headline 'identity info t)
  2359. info)))))
  2360. (ert-deftest test-org-export/get-tags ()
  2361. "Test `org-export-get-tags' specifications."
  2362. ;; Standard test: tags which are not a select tag, an exclude tag,
  2363. ;; or specified as optional argument shouldn't be ignored.
  2364. (should
  2365. (org-test-with-parsed-data "* Headline :tag:"
  2366. (org-export-get-tags (org-element-map tree 'headline 'identity info t)
  2367. info)))
  2368. ;; Tags provided in the optional argument are ignored.
  2369. (should-not
  2370. (org-test-with-parsed-data "* Headline :ignore:"
  2371. (org-export-get-tags (org-element-map tree 'headline 'identity info t)
  2372. info '("ignore"))))
  2373. ;; Allow tag inheritance.
  2374. (should
  2375. (equal
  2376. '(("tag") ("tag"))
  2377. (org-test-with-parsed-data "* Headline :tag:\n** Sub-heading"
  2378. (org-element-map tree 'headline
  2379. (lambda (hl) (org-export-get-tags hl info nil t)) info))))
  2380. ;; Tag inheritance checks FILETAGS keywords.
  2381. (should
  2382. (equal
  2383. '(("a" "b" "tag"))
  2384. (org-test-with-parsed-data "#+FILETAGS: :a:b:\n* Headline :tag:"
  2385. (org-element-map tree 'headline
  2386. (lambda (hl) (org-export-get-tags hl info nil t)) info)))))
  2387. (ert-deftest test-org-export/get-node-property ()
  2388. "Test`org-export-get-node-property' specifications."
  2389. ;; Standard test.
  2390. (should
  2391. (equal "value"
  2392. (org-test-with-parsed-data "* Headline
  2393. :PROPERTIES:
  2394. :prop: value
  2395. :END:"
  2396. (org-export-get-node-property
  2397. :PROP (org-element-map tree 'headline 'identity nil t)))))
  2398. ;; Test inheritance.
  2399. (should
  2400. (equal "value"
  2401. (org-test-with-parsed-data "* Parent
  2402. :PROPERTIES:
  2403. :prop: value
  2404. :END:
  2405. ** Headline
  2406. Paragraph"
  2407. (org-export-get-node-property
  2408. :PROP (org-element-map tree 'paragraph 'identity nil t) t))))
  2409. ;; Cannot return a value before the first headline.
  2410. (should-not
  2411. (org-test-with-parsed-data "Paragraph
  2412. * Headline
  2413. :PROPERTIES:
  2414. :prop: value
  2415. :END:"
  2416. (org-export-get-node-property
  2417. :PROP (org-element-map tree 'paragraph 'identity nil t)))))
  2418. (ert-deftest test-org-export/get-category ()
  2419. "Test `org-export-get-category' specifications."
  2420. ;; Standard test.
  2421. (should
  2422. (equal "value"
  2423. (org-test-with-parsed-data "* Headline
  2424. :PROPERTIES:
  2425. :CATEGORY: value
  2426. :END:"
  2427. (org-export-get-category
  2428. (org-element-map tree 'headline 'identity nil t) info))))
  2429. ;; Test inheritance from a parent headline.
  2430. (should
  2431. (equal '("value" "value")
  2432. (org-test-with-parsed-data "* Headline1
  2433. :PROPERTIES:
  2434. :CATEGORY: value
  2435. :END:
  2436. ** Headline2"
  2437. (org-element-map tree 'headline
  2438. (lambda (hl) (org-export-get-category hl info)) info))))
  2439. ;; Test inheritance from #+CATEGORY keyword
  2440. (should
  2441. (equal "value"
  2442. (org-test-with-parsed-data "#+CATEGORY: value
  2443. * Headline"
  2444. (org-export-get-category
  2445. (org-element-map tree 'headline 'identity nil t) info))))
  2446. ;; Test inheritance from file name.
  2447. (should
  2448. (equal "test"
  2449. (org-test-with-parsed-data "* Headline"
  2450. (let ((info (plist-put info :input-file "~/test.org")))
  2451. (org-export-get-category
  2452. (org-element-map tree 'headline 'identity nil t) info)))))
  2453. ;; Fall-back value.
  2454. (should
  2455. (equal "???"
  2456. (org-test-with-parsed-data "* Headline"
  2457. (org-export-get-category
  2458. (org-element-map tree 'headline 'identity nil t) info)))))
  2459. (ert-deftest test-org-export/first-sibling-p ()
  2460. "Test `org-export-first-sibling-p' specifications."
  2461. ;; Standard test.
  2462. (should
  2463. (equal
  2464. '(yes yes no)
  2465. (org-test-with-parsed-data "* H\n** H 2\n** H 3"
  2466. (org-element-map tree 'headline
  2467. (lambda (h) (if (org-export-first-sibling-p h info) 'yes 'no))
  2468. info))))
  2469. (should
  2470. (equal '(yes no)
  2471. (org-test-with-parsed-data "- item\n\n para"
  2472. (org-element-map tree 'paragraph
  2473. (lambda (h) (if (org-export-first-sibling-p h info) 'yes 'no))
  2474. info))))
  2475. ;; Ignore sections for headlines.
  2476. (should
  2477. (equal '(yes yes)
  2478. (org-test-with-parsed-data "* H\nSection\n** H 2"
  2479. (org-element-map tree 'headline
  2480. (lambda (h) (if (org-export-first-sibling-p h info) 'yes 'no))
  2481. info))))
  2482. ;; Ignore headlines not exported.
  2483. (should
  2484. (equal
  2485. '(yes)
  2486. (let ((org-export-exclude-tags '("ignore")))
  2487. (org-test-with-parsed-data "* Headline :ignore:\n* Headline 2"
  2488. (org-element-map tree 'headline
  2489. (lambda (h) (if (org-export-first-sibling-p h info) 'yes 'no))
  2490. info))))))
  2491. (ert-deftest test-org-export/last-sibling-p ()
  2492. "Test `org-export-last-sibling-p' specifications."
  2493. ;; Standard test.
  2494. (should
  2495. (equal
  2496. '(yes no yes)
  2497. (org-test-with-parsed-data "* Headline\n** Headline 2\n** Headline 3"
  2498. (org-element-map tree 'headline
  2499. (lambda (h) (if (org-export-last-sibling-p h info) 'yes 'no))
  2500. info))))
  2501. (should
  2502. (equal '(no yes)
  2503. (org-test-with-parsed-data "- item\n\n para"
  2504. (org-element-map tree 'paragraph
  2505. (lambda (h) (if (org-export-last-sibling-p h info) 'yes 'no))
  2506. info))))
  2507. ;; Ignore headlines not exported.
  2508. (should
  2509. (equal
  2510. '(yes)
  2511. (let ((org-export-exclude-tags '("ignore")))
  2512. (org-test-with-parsed-data "* Headline\n* Headline 2 :ignore:"
  2513. (org-element-map tree 'headline
  2514. (lambda (h) (if (org-export-last-sibling-p h info) 'yes 'no))
  2515. info))))))
  2516. (ert-deftest test-org-export/handle-inlinetasks ()
  2517. "Test inlinetask export."
  2518. ;; Inlinetask with an exclude tag.
  2519. (when (featurep 'org-inlinetask)
  2520. (should
  2521. (equal
  2522. ""
  2523. (let ((org-inlinetask-min-level 3)
  2524. org-export-filter-body-functions
  2525. org-export-filter-final-output-functions)
  2526. (org-test-with-temp-text "*** Inlinetask :noexp:\nContents\n*** end"
  2527. (org-export-as (org-test-default-backend)
  2528. nil nil nil '(:exclude-tags ("noexp")))))))
  2529. ;; Inlinetask with an include tag.
  2530. (should
  2531. (equal
  2532. "* H2\n*** Inline :exp:\n"
  2533. (let ((org-inlinetask-min-level 3)
  2534. (org-tags-column 0))
  2535. (org-test-with-temp-text "* H1\n* H2\n*** Inline :exp:"
  2536. (org-export-as (org-test-default-backend)
  2537. nil nil nil '(:select-tags ("exp")))))))
  2538. ;; Ignore inlinetask with a TODO keyword and tasks excluded.
  2539. (should
  2540. (equal ""
  2541. (let ((org-todo-keywords '((sequence "TODO" "DONE")))
  2542. (org-inlinetask-min-level 3)
  2543. org-export-filter-body-functions
  2544. org-export-filter-final-output-functions)
  2545. (org-test-with-temp-text "*** TODO Inline"
  2546. (org-export-as (org-test-default-backend)
  2547. nil nil nil '(:with-tasks nil))))))))
  2548. ;;; Keywords
  2549. (ert-deftest test-org-export/get-date ()
  2550. "Test `org-export-get-date' specifications."
  2551. ;; Return a properly formatted string when
  2552. ;; `org-export-date-timestamp-format' is non-nil and DATE keyword
  2553. ;; consists in a single timestamp.
  2554. (should
  2555. (equal "29 03 2012"
  2556. (let ((org-export-date-timestamp-format "%d %m %Y"))
  2557. (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
  2558. (org-export-get-date info)))))
  2559. ;; Return a secondary string otherwise.
  2560. (should-not
  2561. (stringp
  2562. (let ((org-export-date-timestamp-format nil))
  2563. (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
  2564. (org-export-get-date info)))))
  2565. (should
  2566. (equal '("Date")
  2567. (org-test-with-parsed-data "#+DATE: Date"
  2568. (org-export-get-date info))))
  2569. ;; Optional argument has precedence over
  2570. ;; `org-export-date-timestamp-format'.
  2571. (should
  2572. (equal "29 03"
  2573. (let ((org-export-date-timestamp-format "%d %m %Y"))
  2574. (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
  2575. (org-export-get-date info "%d %m"))))))
  2576. ;;; Links
  2577. (ert-deftest test-org-export/custom-protocol-maybe ()
  2578. "Test `org-export-custom-protocol-maybe' specifications."
  2579. (should
  2580. (string-match
  2581. "success"
  2582. (progn
  2583. (org-link-set-parameters "foo" :export (lambda (p d f) "success"))
  2584. (org-export-string-as
  2585. "[[foo:path]]"
  2586. (org-export-create-backend
  2587. :name 'test
  2588. :transcoders
  2589. '((section . (lambda (s c i) c))
  2590. (paragraph . (lambda (p c i) c))
  2591. (link . (lambda (l c i)
  2592. (or (org-export-custom-protocol-maybe l c 'test)
  2593. "failure")))))))))
  2594. (should-not
  2595. (string-match
  2596. "success"
  2597. (progn
  2598. (org-link-set-parameters
  2599. "foo" :export (lambda (p d f) (and (eq f 'test) "success")))
  2600. (org-export-string-as
  2601. "[[foo:path]]"
  2602. (org-export-create-backend
  2603. :name 'no-test
  2604. :transcoders
  2605. '((section . (lambda (s c i) c))
  2606. (paragraph . (lambda (p c i) c))
  2607. (link . (lambda (l c i)
  2608. (or (org-export-custom-protocol-maybe l c 'no-test)
  2609. "failure")))))))))
  2610. ;; Ignore anonymous back-ends.
  2611. (should-not
  2612. (string-match
  2613. "success"
  2614. (progn
  2615. (org-link-set-parameters
  2616. "foo" :export (lambda (p d f) (and (eq f 'test) "success")))
  2617. (org-export-string-as
  2618. "[[foo:path]]"
  2619. (org-export-create-backend
  2620. :transcoders
  2621. '((section . (lambda (s c i) c))
  2622. (paragraph . (lambda (p c i) c))
  2623. (link . (lambda (l c i)
  2624. (or (org-export-custom-protocol-maybe l c nil)
  2625. "failure"))))))))))
  2626. (ert-deftest test-org-export/get-coderef-format ()
  2627. "Test `org-export-get-coderef-format' specifications."
  2628. ;; A link without description returns "%s"
  2629. (should (equal (org-export-get-coderef-format "(ref:line)" nil)
  2630. "%s"))
  2631. ;; Return "%s" when path is matched within description.
  2632. (should (equal (org-export-get-coderef-format "path" "desc (path)")
  2633. "desc %s"))
  2634. ;; Otherwise return description.
  2635. (should (equal (org-export-get-coderef-format "path" "desc")
  2636. "desc")))
  2637. (ert-deftest test-org-export/inline-image-p ()
  2638. "Test `org-export-inline-image-p' specifications."
  2639. (should
  2640. (org-export-inline-image-p
  2641. (org-test-with-temp-text "[[#id]]"
  2642. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  2643. '(("custom-id" . "id")))))
  2644. (ert-deftest test-org-export/insert-image-links ()
  2645. "Test `org-export-insert-image-links' specifications."
  2646. (should-not
  2647. (member "file"
  2648. (org-test-with-parsed-data "[[http://orgmode.org][file:image.png]]"
  2649. (org-element-map tree 'link
  2650. (lambda (l) (org-element-property :type l))))))
  2651. (should
  2652. (member "file"
  2653. (org-test-with-parsed-data "[[http://orgmode.org][file:image.png]]"
  2654. (org-element-map (org-export-insert-image-links tree info) 'link
  2655. (lambda (l) (org-element-property :type l))))))
  2656. ;; Properly set `:parent' property when replace contents with image
  2657. ;; link.
  2658. (should
  2659. (memq 'link
  2660. (org-test-with-parsed-data "[[http://orgmode.org][file:image.png]]"
  2661. (org-element-map (org-export-insert-image-links tree info) 'link
  2662. (lambda (l)
  2663. (org-element-type (org-element-property :parent l)))))))
  2664. ;; With optional argument RULES, recognize different links as
  2665. ;; images.
  2666. (should-not
  2667. (member "file"
  2668. (org-test-with-parsed-data "[[http://orgmode.org][file:image.xxx]]"
  2669. (org-element-map (org-export-insert-image-links tree info) 'link
  2670. (lambda (l) (org-element-property :type l))))))
  2671. (should
  2672. (member "file"
  2673. (org-test-with-parsed-data "[[http://orgmode.org][file:image.xxx]]"
  2674. (org-element-map
  2675. (org-export-insert-image-links tree info '(("file" . "xxx")))
  2676. 'link
  2677. (lambda (l) (org-element-property :type l)))))))
  2678. (ert-deftest test-org-export/fuzzy-link ()
  2679. "Test fuzzy links specifications."
  2680. ;; Link to an headline should return headline's number.
  2681. (should
  2682. ;; Note: Headline's number is in fact a list of numbers.
  2683. (equal '(2)
  2684. (org-test-with-parsed-data
  2685. "Paragraph.\n* Head1\n* Head2\n* Head3\n[[Head2]]"
  2686. (org-element-map tree 'link
  2687. (lambda (link)
  2688. (org-export-get-ordinal
  2689. (org-export-resolve-fuzzy-link link info) info)) info t))))
  2690. ;; Link to a target in an item should return item's number.
  2691. (should
  2692. ;; Note: Item's number is in fact a list of numbers.
  2693. (equal '(1 2)
  2694. (org-test-with-parsed-data
  2695. "- Item1\n - Item11\n - <<test>>Item12\n- Item2\n\n\n[[test]]"
  2696. (org-element-map tree 'link
  2697. (lambda (link)
  2698. (org-export-get-ordinal
  2699. (org-export-resolve-fuzzy-link link info) info)) info t))))
  2700. ;; Link to a target in a footnote should return footnote's number.
  2701. (should
  2702. (equal '(2 3)
  2703. (org-test-with-parsed-data "
  2704. Paragraph[fn:1][fn:2][fn:lbl3:C<<target>>][[test]][[target]]
  2705. \[fn:1] A
  2706. \[fn:2] <<test>>B"
  2707. (org-element-map tree 'link
  2708. (lambda (link)
  2709. (org-export-get-ordinal
  2710. (org-export-resolve-fuzzy-link link info) info)) info))))
  2711. ;; Link to a named element should return sequence number of that
  2712. ;; element.
  2713. (should
  2714. (= 2
  2715. (org-test-with-parsed-data
  2716. "#+NAME: tbl1\n|1|2|\n#+NAME: tbl2\n|3|4|\n#+NAME: tbl3\n|5|6|\n[[tbl2]]"
  2717. (org-element-map tree 'link
  2718. (lambda (link)
  2719. (org-export-get-ordinal
  2720. (org-export-resolve-fuzzy-link link info) info)) info t))))
  2721. ;; Link to a target not within an item, a table, a footnote
  2722. ;; reference or definition should return section number.
  2723. (should
  2724. (equal '(2)
  2725. (org-test-with-parsed-data
  2726. "* Head1\n* Head2\nParagraph<<target>>\n* Head3\n[[target]]"
  2727. (org-element-map tree 'link
  2728. (lambda (link)
  2729. (org-export-get-ordinal
  2730. (org-export-resolve-fuzzy-link link info) info)) info t))))
  2731. ;; Space are not significant when matching a fuzzy link.
  2732. (should
  2733. (org-test-with-parsed-data "* Head 1\n[[Head\n 1]]"
  2734. (org-element-map tree 'link
  2735. (lambda (link) (org-export-resolve-fuzzy-link link info))
  2736. info t)))
  2737. ;; Statistics cookies are ignored for headline match.
  2738. (should
  2739. (org-test-with-parsed-data "* Head [0/0]\n[[Head]]"
  2740. (org-element-map tree 'link
  2741. (lambda (link) (org-export-resolve-fuzzy-link link info))
  2742. info t)))
  2743. (should
  2744. (org-test-with-parsed-data "* Head [100%]\n[[Head]]"
  2745. (org-element-map tree 'link
  2746. (lambda (link) (org-export-resolve-fuzzy-link link info))
  2747. info t))))
  2748. (defun test-org-gen-loc-list(text type)
  2749. (org-test-with-parsed-data text
  2750. (org-element-map tree type
  2751. (lambda (el) (or (org-export-get-loc el info) 'no-loc)))))
  2752. (ert-deftest test-org-export/get-loc ()
  2753. "Test `org-export-get-loc' specifications."
  2754. (should
  2755. ;; "-n" resets line number.
  2756. (equal '(0)
  2757. (test-org-gen-loc-list "#+BEGIN_EXAMPLE -n\n Text\n#+END_EXAMPLE"
  2758. 'example-block)))
  2759. ;; The first "+n" has 0 lines before it
  2760. (should
  2761. (equal '(0)
  2762. (test-org-gen-loc-list "#+BEGIN_EXAMPLE +n\n Text\n#+END_EXAMPLE"
  2763. 'example-block)))
  2764. ;; "-n 10" resets line number but has "9 lines" before it.
  2765. (should
  2766. (equal '(9)
  2767. (test-org-gen-loc-list "#+BEGIN_EXAMPLE -n 10\n Text\n#+END_EXAMPLE"
  2768. 'example-block)))
  2769. ;; -n10 with two lines then +n 15
  2770. (should
  2771. (equal '(9 25)
  2772. (test-org-gen-loc-list "
  2773. #+BEGIN_EXAMPLE -n 10
  2774. Text_10
  2775. Second line(11)
  2776. #+END_EXAMPLE
  2777. #+BEGIN_EXAMPLE +n 15
  2778. Text line (11 + 15)
  2779. #+END_EXAMPLE"
  2780. 'example-block)))
  2781. (should
  2782. (equal '(9 19 0)
  2783. (test-org-gen-loc-list "
  2784. #+BEGIN_EXAMPLE -n 10
  2785. Text
  2786. #+END_EXAMPLE
  2787. #+BEGIN_EXAMPLE +n 10
  2788. Text
  2789. #+END_EXAMPLE
  2790. #+BEGIN_EXAMPLE -n
  2791. Text
  2792. #+END_EXAMPLE"
  2793. 'example-block)))
  2794. ;; an Example Block without -n does not add to the line count.
  2795. (should
  2796. (equal '(9 no-loc 19)
  2797. (test-org-gen-loc-list "
  2798. #+BEGIN_EXAMPLE -n 10
  2799. Text
  2800. #+END_EXAMPLE
  2801. #+BEGIN_EXAMPLE
  2802. Text
  2803. #+END_EXAMPLE
  2804. #+BEGIN_EXAMPLE +n 10
  2805. Text
  2806. #+END_EXAMPLE"
  2807. 'example-block)))
  2808. ;; "-n" resets line number.
  2809. (should
  2810. (equal
  2811. '(0)
  2812. (test-org-gen-loc-list "#+BEGIN_SRC emacs-lisp -n \n (- 1 1) \n#+END_SRC"
  2813. 'src-block)))
  2814. ;; The first "+n" has 0 lines before it.
  2815. (should
  2816. (equal '(0)
  2817. (test-org-gen-loc-list
  2818. "#+BEGIN_SRC emacs-lisp +n \n (+ 0 (- 1 1))\n#+END_SRC"
  2819. 'src-block)))
  2820. ;; "-n 10" resets line number but has "9 lines" before it.
  2821. (should
  2822. (equal '(9)
  2823. (test-org-gen-loc-list
  2824. "#+BEGIN_SRC emacs-lisp -n 10\n (- 10 1)\n#+END_SRC"
  2825. 'src-block)))
  2826. (should
  2827. (equal '(9 25)
  2828. (test-org-gen-loc-list "
  2829. #+BEGIN_SRC emacs-lisp -n 10
  2830. (- 10 1)
  2831. (+ (- 10 1) 1)
  2832. #+END_SRC
  2833. #+BEGIN_SRC emacs-lisp +n 15
  2834. (+ (- 10 1) 2 (- 15 1))
  2835. #+END_SRC"
  2836. 'src-block)))
  2837. (should
  2838. (equal '(9 19 0)
  2839. (test-org-gen-loc-list "
  2840. #+BEGIN_SRC emacs-lisp -n 10
  2841. (- 10 1)
  2842. #+END_SRC
  2843. #+BEGIN_SRC emacs-lisp +n 10
  2844. (+ (- 10 1) 1 (- 10 1))
  2845. #+END_SRC
  2846. #+BEGIN_SRC emacs-lisp -n
  2847. (- 1 1)
  2848. #+END_SRC"
  2849. 'src-block)))
  2850. ;; A SRC Block without -n does not add to the line count.
  2851. (should
  2852. (equal '(9 no-loc 19)
  2853. (test-org-gen-loc-list
  2854. "#+BEGIN_SRC emacs-lisp -n 10
  2855. (+ (-10 1) 1)
  2856. #+END_SRC
  2857. #+BEGIN_SRC emacs-lisp
  2858. (+ 2 2)
  2859. #+END_SRC
  2860. #+BEGIN_SRC emacs-lisp +n 10
  2861. (+ (- 10 1) 1 (- 10 1))
  2862. #+END_SRC"
  2863. 'src-block))))
  2864. (ert-deftest test-org-export/resolve-coderef ()
  2865. "Test `org-export-resolve-coderef' specifications."
  2866. (let ((org-coderef-label-format "(ref:%s)"))
  2867. ;; A link to a "-n -k -r" block returns line number.
  2868. (should
  2869. (= 1
  2870. (org-test-with-parsed-data
  2871. "#+BEGIN_EXAMPLE -n -k -r\nText (ref:coderef)\n#+END_EXAMPLE"
  2872. (org-export-resolve-coderef "coderef" info))))
  2873. (should
  2874. (= 10
  2875. (org-test-with-parsed-data
  2876. "#+BEGIN_EXAMPLE -n 10 -k -r\nText (ref:coderef)\n#+END_EXAMPLE"
  2877. (org-export-resolve-coderef "coderef" info))))
  2878. (should
  2879. (= 135
  2880. (org-test-with-parsed-data
  2881. "#+BEGIN_EXAMPLE -n 10 -k -r\nText \n#+END_EXAMPLE\n
  2882. #+BEGIN_EXAMPLE +n 125 -k -r\nText (ref:coderef)\n#+END_EXAMPLE"
  2883. (org-export-resolve-coderef "coderef" info))))
  2884. (should
  2885. (= 1
  2886. (org-test-with-parsed-data
  2887. "#+BEGIN_SRC emacs-lisp -n -k -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2888. (org-export-resolve-coderef "coderef" info))))
  2889. (should
  2890. (= 10
  2891. (org-test-with-parsed-data
  2892. "#+BEGIN_SRC emacs-lisp -n 10 -k -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2893. (org-export-resolve-coderef "coderef" info))))
  2894. (should
  2895. (= 135
  2896. (org-test-with-parsed-data
  2897. "#+BEGIN_SRC emacs-lisp -n 10 -k -r\n(+ 1 1) \n#+END_SRC\n
  2898. #+BEGIN_SRC emacs-lisp +n 125 -k -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2899. (org-export-resolve-coderef "coderef" info))))
  2900. ;; A link to a "-n -r" block returns line number.
  2901. (should
  2902. (= 1
  2903. (org-test-with-parsed-data
  2904. "#+BEGIN_EXAMPLE -n -r\nText (ref:coderef)\n#+END_EXAMPLE"
  2905. (org-export-resolve-coderef "coderef" info))))
  2906. (should
  2907. (= 10
  2908. (org-test-with-parsed-data
  2909. "#+BEGIN_EXAMPLE -n 10 -r\nText (ref:coderef)\n#+END_EXAMPLE"
  2910. (org-export-resolve-coderef "coderef" info))))
  2911. (should
  2912. (= 135
  2913. (org-test-with-parsed-data
  2914. "#+BEGIN_EXAMPLE +n 10 -r\nText \n#+END_EXAMPLE
  2915. #+BEGIN_EXAMPLE +n 125 -r\nText (ref:coderef)\n#+END_EXAMPLE"
  2916. (org-export-resolve-coderef "coderef" info))))
  2917. (should
  2918. (= 1
  2919. (org-test-with-parsed-data
  2920. "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2921. (org-export-resolve-coderef "coderef" info))))
  2922. (should
  2923. (= 10
  2924. (org-test-with-parsed-data
  2925. "#+BEGIN_SRC emacs-lisp -n10 -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2926. (org-export-resolve-coderef "coderef" info))))
  2927. (should
  2928. (= 135
  2929. (org-test-with-parsed-data
  2930. "#+BEGIN_SRC emacs-lisp -n10 -r\n(+ 1 1) \n#+END_SRC
  2931. #+BEGIN_SRC emacs-lisp +n125 -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2932. (org-export-resolve-coderef "coderef" info))))
  2933. ;; A link to a "-n" block returns coderef.
  2934. (should
  2935. (equal "coderef"
  2936. (org-test-with-parsed-data
  2937. "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2938. (org-export-resolve-coderef "coderef" info))))
  2939. (should
  2940. (equal "coderef"
  2941. (org-test-with-parsed-data
  2942. "#+BEGIN_EXAMPLE -n\nText (ref:coderef)\n#+END_EXAMPLE"
  2943. (org-export-resolve-coderef "coderef" info))))
  2944. ;; A link to a "-r" block returns line number.
  2945. (should
  2946. (= 1
  2947. (org-test-with-parsed-data
  2948. "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2949. (org-export-resolve-coderef "coderef" info))))
  2950. (should
  2951. (= 1
  2952. (org-test-with-parsed-data
  2953. "#+BEGIN_EXAMPLE -r\nText (ref:coderef)\n#+END_EXAMPLE"
  2954. (org-export-resolve-coderef "coderef" info))))
  2955. ;; A link to a block without a switch returns coderef.
  2956. (should
  2957. (equal "coderef"
  2958. (org-test-with-parsed-data
  2959. "#+BEGIN_SRC emacs-lisp\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2960. (org-export-resolve-coderef "coderef" info))))
  2961. (org-test-with-parsed-data
  2962. "#+BEGIN_EXAMPLE\nText (ref:coderef)\n#+END_EXAMPLE"
  2963. (should (equal (org-export-resolve-coderef "coderef" info) "coderef")))
  2964. ;; Correctly handle continued line numbers. A "+n" switch should
  2965. ;; resume numbering from previous block with numbered lines,
  2966. ;; ignoring blocks not numbering lines in the process. A "-n"
  2967. ;; switch resets count.
  2968. (should
  2969. (equal '(2 1)
  2970. (org-test-with-parsed-data "
  2971. #+BEGIN_EXAMPLE -n
  2972. Text.
  2973. #+END_EXAMPLE
  2974. #+BEGIN_SRC emacs-lisp
  2975. \(- 1 1)
  2976. #+END_SRC
  2977. #+BEGIN_SRC emacs-lisp +n -r
  2978. \(+ 1 1) (ref:addition)
  2979. #+END_SRC
  2980. #+BEGIN_EXAMPLE -n -r
  2981. Another text. (ref:text)
  2982. #+END_EXAMPLE"
  2983. (list (org-export-resolve-coderef "addition" info)
  2984. (org-export-resolve-coderef "text" info)))))
  2985. ;; Recognize coderef with user-specified syntax.
  2986. (should
  2987. (equal
  2988. "text"
  2989. (org-test-with-parsed-data
  2990. "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText. [ref:text]\n#+END_EXAMPLE"
  2991. (org-export-resolve-coderef "text" info))))
  2992. ;; Unresolved coderefs raise a `org-link-broken' signal.
  2993. (should
  2994. (condition-case nil
  2995. (org-test-with-parsed-data "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  2996. (org-export-resolve-coderef "unknown" info))
  2997. (org-link-broken t)))))
  2998. (ert-deftest test-org-export/resolve-fuzzy-link ()
  2999. "Test `org-export-resolve-fuzzy-link' specifications."
  3000. ;; Match target objects.
  3001. (should
  3002. (org-test-with-parsed-data "<<target>> [[target]]"
  3003. (org-export-resolve-fuzzy-link
  3004. (org-element-map tree 'link 'identity info t) info)))
  3005. ;; Match named elements.
  3006. (should
  3007. (org-test-with-parsed-data "#+NAME: target\nParagraph\n\n[[target]]"
  3008. (org-export-resolve-fuzzy-link
  3009. (org-element-map tree 'link 'identity info t) info)))
  3010. ;; Match exact headline's name.
  3011. (should
  3012. (org-test-with-parsed-data "* My headline\n[[My headline]]"
  3013. (org-export-resolve-fuzzy-link
  3014. (org-element-map tree 'link 'identity info t) info)))
  3015. ;; Targets objects have priority over headline titles.
  3016. (should
  3017. (eq 'target
  3018. (org-test-with-parsed-data "* target\n<<target>>[[target]]"
  3019. (org-element-type
  3020. (org-export-resolve-fuzzy-link
  3021. (org-element-map tree 'link 'identity info t) info)))))
  3022. ;; Named elements have priority over headline titles.
  3023. (should
  3024. (eq 'paragraph
  3025. (org-test-with-parsed-data
  3026. "* target\n#+NAME: target\nParagraph\n\n[[target]]"
  3027. (org-element-type
  3028. (org-export-resolve-fuzzy-link
  3029. (org-element-map tree 'link 'identity info t) info)))))
  3030. ;; If link's path starts with a "*", only match headline titles,
  3031. ;; though.
  3032. (should
  3033. (eq 'headline
  3034. (org-test-with-parsed-data
  3035. "* target\n#+NAME: target\n<<target>>\n\n[[*target]]"
  3036. (org-element-type
  3037. (org-export-resolve-fuzzy-link
  3038. (org-element-map tree 'link 'identity info t) info)))))
  3039. ;; Raise a `org-link-broken' signal if no match.
  3040. (should
  3041. (org-test-with-parsed-data "[[target]]"
  3042. (condition-case nil
  3043. (org-export-resolve-fuzzy-link
  3044. (org-element-map tree 'link #'identity info t) info)
  3045. (org-link-broken t))))
  3046. ;; Match fuzzy link even when before first headline.
  3047. (should
  3048. (eq 'headline
  3049. (org-test-with-parsed-data "[[hl]]\n* hl"
  3050. (org-element-type
  3051. (org-export-resolve-fuzzy-link
  3052. (org-element-map tree 'link 'identity info t) info)))))
  3053. ;; Handle url-encoded fuzzy links.
  3054. (should
  3055. (org-test-with-parsed-data "* A B\n[[A%20B]]"
  3056. (org-export-resolve-fuzzy-link
  3057. (org-element-map tree 'link #'identity info t) info))))
  3058. (ert-deftest test-org-export/resolve-id-link ()
  3059. "Test `org-export-resolve-id-link' specifications."
  3060. ;; Regular test for custom-id link.
  3061. (should
  3062. (equal '("Headline1")
  3063. (org-test-with-parsed-data "* Headline1
  3064. :PROPERTIES:
  3065. :CUSTOM_ID: test
  3066. :END:
  3067. * Headline 2
  3068. \[[#test]]"
  3069. (org-element-property
  3070. :title
  3071. (org-export-resolve-id-link
  3072. (org-element-map tree 'link 'identity info t) info)))))
  3073. ;; Raise a `org-link-broken' signal on failing searches.
  3074. (should
  3075. (org-test-with-parsed-data "* Headline1
  3076. :PROPERTIES:
  3077. :CUSTOM_ID: test
  3078. :END:
  3079. * Headline 2
  3080. \[[#no-match]]"
  3081. (condition-case nil
  3082. (org-export-resolve-id-link
  3083. (org-element-map tree 'link #'identity info t) info)
  3084. (org-link-broken t))))
  3085. ;; Test for internal id target.
  3086. (should
  3087. (equal '("Headline1")
  3088. (org-test-with-parsed-data "* Headline1
  3089. :PROPERTIES:
  3090. :ID: aaaa
  3091. :END:
  3092. * Headline 2
  3093. \[[id:aaaa]]"
  3094. (org-element-property
  3095. :title
  3096. (org-export-resolve-id-link
  3097. (org-element-map tree 'link 'identity info t) info)))))
  3098. ;; Test for external id target.
  3099. (should
  3100. (equal
  3101. "external-file"
  3102. (org-test-with-parsed-data "[[id:aaaa]]"
  3103. (org-export-resolve-id-link
  3104. (org-element-map tree 'link 'identity info t)
  3105. (org-combine-plists info '(:id-alist (("aaaa" . "external-file")))))))))
  3106. (ert-deftest test-org-export/resolve-radio-link ()
  3107. "Test `org-export-resolve-radio-link' specifications."
  3108. ;; Standard test.
  3109. (should
  3110. (org-test-with-temp-text "<<<radio>>> radio"
  3111. (org-update-radio-target-regexp)
  3112. (let* ((tree (org-element-parse-buffer))
  3113. (info `(:parse-tree ,tree)))
  3114. (org-export-resolve-radio-link
  3115. (org-element-map tree 'link 'identity info t)
  3116. info))))
  3117. ;; Radio targets are case-insensitive.
  3118. (should
  3119. (org-test-with-temp-text "<<<RADIO>>> radio"
  3120. (org-update-radio-target-regexp)
  3121. (let* ((tree (org-element-parse-buffer))
  3122. (info `(:parse-tree ,tree)))
  3123. (org-export-resolve-radio-link
  3124. (org-element-map tree 'link 'identity info t)
  3125. info))))
  3126. ;; Radio target with objects.
  3127. (should
  3128. (org-test-with-temp-text "<<<radio \\alpha>>> radio \\alpha"
  3129. (org-update-radio-target-regexp)
  3130. (let* ((tree (org-element-parse-buffer))
  3131. (info `(:parse-tree ,tree)))
  3132. (org-export-resolve-radio-link
  3133. (org-element-map tree 'link 'identity info t)
  3134. info))))
  3135. ;; Radio target with objects at its beginning.
  3136. (should
  3137. (org-test-with-temp-text "<<<\\alpha radio>>> \\alpha radio"
  3138. (org-update-radio-target-regexp)
  3139. (let* ((tree (org-element-parse-buffer))
  3140. (info `(:parse-tree ,tree)))
  3141. (org-export-resolve-radio-link
  3142. (org-element-map tree 'link 'identity info t)
  3143. info))))
  3144. ;; Radio link next to an apostrophe.
  3145. (should
  3146. (org-test-with-temp-text "<<<radio>>> radio's"
  3147. (org-update-radio-target-regexp)
  3148. (let* ((tree (org-element-parse-buffer))
  3149. (info `(:parse-tree ,tree)))
  3150. (org-export-resolve-radio-link
  3151. (org-element-map tree 'link 'identity info t)
  3152. info))))
  3153. ;; Multiple radio targets.
  3154. (should
  3155. (equal '("radio1" "radio2")
  3156. (org-test-with-temp-text "<<<radio1>>> <<<radio2>>> radio1 radio2"
  3157. (org-update-radio-target-regexp)
  3158. (let* ((tree (org-element-parse-buffer))
  3159. (info `(:parse-tree ,tree)))
  3160. (org-element-map tree 'link
  3161. (lambda (link)
  3162. (org-element-property
  3163. :value (org-export-resolve-radio-link link info)))
  3164. info)))))
  3165. ;; Radio target is whitespace insensitive.
  3166. (should
  3167. (org-test-with-temp-text "<<<a radio>>> a\n radio"
  3168. (org-update-radio-target-regexp)
  3169. (let* ((tree (org-element-parse-buffer))
  3170. (info `(:parse-tree ,tree)))
  3171. (org-element-map tree 'link
  3172. (lambda (link) (org-export-resolve-radio-link link info)) info t)))))
  3173. (ert-deftest test-org-export/file-uri ()
  3174. "Test `org-export-file-uri' specifications."
  3175. ;; Preserve relative filenames.
  3176. (should (equal "relative.org" (org-export-file-uri "relative.org")))
  3177. ;; Local files start with "file:///"
  3178. (should (equal "file:///local.org" (org-export-file-uri "/local.org")))
  3179. ;; Remote files start with "file://"
  3180. (should (equal "file://myself@some.where:papers/last.pdf"
  3181. (org-export-file-uri "/myself@some.where:papers/last.pdf")))
  3182. (should (equal "file://localhost/etc/fstab"
  3183. (org-export-file-uri "//localhost/etc/fstab")))
  3184. ;; Expand filename starting with "~".
  3185. (should (equal (org-export-file-uri "~/file.org")
  3186. (concat "file://" (expand-file-name "~/file.org")))))
  3187. (ert-deftest test-org-export/get-reference ()
  3188. "Test `org-export-get-reference' specifications."
  3189. (should
  3190. (org-test-with-parsed-data "* Headline"
  3191. (org-export-get-reference (org-element-map tree 'headline #'identity nil t)
  3192. info)))
  3193. ;; For a given element always return the same reference.
  3194. (should
  3195. (org-test-with-parsed-data "* Headline"
  3196. (let ((headline (org-element-map tree 'headline #'identity nil t)))
  3197. (equal (org-export-get-reference headline info)
  3198. (org-export-get-reference headline info)))))
  3199. ;; References get through local export back-ends.
  3200. (should
  3201. (org-test-with-parsed-data "* Headline"
  3202. (let ((headline (org-element-map tree 'headline #'identity nil t))
  3203. (backend
  3204. (org-export-create-backend
  3205. :transcoders
  3206. '((headline . (lambda (h _c i) (org-export-get-reference h i)))))))
  3207. (equal (org-trim (org-export-data-with-backend headline backend info))
  3208. (org-export-get-reference headline info)))))
  3209. (should
  3210. (org-test-with-parsed-data "* Headline"
  3211. (let ((headline (org-element-map tree 'headline #'identity nil t))
  3212. (backend
  3213. (org-export-create-backend
  3214. :transcoders
  3215. '((headline . (lambda (h _c i) (org-export-get-reference h i)))))))
  3216. (equal (org-export-with-backend backend headline nil info)
  3217. (org-export-get-reference headline info)))))
  3218. ;; Use search cells defined in `:crossrefs'. However, handle
  3219. ;; duplicate search cells.
  3220. (should
  3221. (equal "org0000001"
  3222. (org-test-with-parsed-data "* Headline"
  3223. (let* ((headline (org-element-map tree 'headline #'identity nil t))
  3224. (search-cell (car (org-export-search-cells headline))))
  3225. (setq info
  3226. (plist-put info :crossrefs (list (cons search-cell 1))))
  3227. (org-export-get-reference headline info)))))
  3228. (should-not
  3229. (equal '("org0000001" "org0000001")
  3230. (org-test-with-parsed-data "* H\n** H"
  3231. (org-element-map tree 'headline
  3232. (lambda (h)
  3233. (let* ((search-cell (car (org-export-search-cells h)))
  3234. (info (plist-put info :crossrefs
  3235. (list (cons search-cell 1)))))
  3236. (org-export-get-reference h info))))))))
  3237. ;;; Pseudo objects and pseudo elements
  3238. (ert-deftest test-org-export/pseudo-elements ()
  3239. "Test exporting pseudo-elements."
  3240. ;; Handle blank lines after pseudo-elements. In particular, do not
  3241. ;; replace them with white spaces.
  3242. (should
  3243. (equal "contents\n\nparagraph\n"
  3244. (let ((backend (org-export-create-backend
  3245. :transcoders
  3246. '((pseudo-element . (lambda (_p c _i) c))
  3247. (paragraph . (lambda (_p c _i) c))
  3248. (plain-text . (lambda (c _i) c)))))
  3249. (element '(pseudo-element (:post-blank 1) "contents"))
  3250. (paragraph '(paragraph nil "paragraph"))
  3251. (data '(org-data nil)))
  3252. (org-element-adopt-elements data element paragraph)
  3253. (org-export-data-with-backend data backend nil)))))
  3254. (ert-deftest test-org-export/pseudo-objects ()
  3255. "Test exporting pseudo-objects."
  3256. ;; Handle blank spaces after pseudo-objects. In particular, do not
  3257. ;; replace them with newlines.
  3258. (should
  3259. (equal "begin x end\n"
  3260. (let ((backend (org-export-create-backend
  3261. :transcoders
  3262. '((pseudo-object . (lambda (_p c _i) c))
  3263. (paragraph . (lambda (_p c _i) c))
  3264. (plain-text . (lambda (c _i) c)))))
  3265. (object '(pseudo-object (:post-blank 1) "x"))
  3266. (paragraph '(paragraph nil)))
  3267. (org-element-adopt-elements paragraph "begin " object "end")
  3268. (org-export-data-with-backend paragraph backend nil)))))
  3269. ;;; Src-block and example-block
  3270. (ert-deftest test-org-export/unravel-code ()
  3271. "Test `org-export-unravel-code' function."
  3272. ;; Code without reference.
  3273. (should
  3274. (equal '("(+ 1 1)\n")
  3275. (org-test-with-temp-text "#+BEGIN_EXAMPLE\n(+ 1 1)\n#+END_EXAMPLE"
  3276. (org-export-unravel-code (org-element-at-point)))))
  3277. ;; Code with reference.
  3278. (should
  3279. (equal '("(+ 1 1)\n" (1 . "test"))
  3280. (org-test-with-temp-text
  3281. "#+BEGIN_EXAMPLE\n(+ 1 1) (ref:test)\n#+END_EXAMPLE"
  3282. (let ((org-coderef-label-format "(ref:%s)"))
  3283. (org-export-unravel-code (org-element-at-point))))))
  3284. ;; Code with user-defined reference.
  3285. (should
  3286. (equal
  3287. '("(+ 1 1)\n" (1 . "test"))
  3288. (org-test-with-temp-text
  3289. "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\n(+ 1 1) [ref:test]\n#+END_EXAMPLE"
  3290. (let ((org-coderef-label-format "(ref:%s)"))
  3291. (org-export-unravel-code (org-element-at-point))))))
  3292. ;; Code references keys are relative to the current block.
  3293. (should
  3294. (equal '("(+ 2 2)\n(+ 3 3)\n" (2 . "one"))
  3295. (org-test-with-temp-text "
  3296. #+BEGIN_EXAMPLE -n
  3297. \(+ 1 1)
  3298. #+END_EXAMPLE
  3299. #+BEGIN_EXAMPLE +n
  3300. \(+ 2 2)
  3301. \(+ 3 3) (ref:one)
  3302. #+END_EXAMPLE"
  3303. (goto-line 5)
  3304. (let ((org-coderef-label-format "(ref:%s)"))
  3305. (org-export-unravel-code (org-element-at-point)))))))
  3306. (ert-deftest test-org-export/format-code-default ()
  3307. "Test `org-export-format-code-default' specifications."
  3308. ;; Return the empty string when code is empty.
  3309. (should
  3310. (equal ""
  3311. (org-test-with-parsed-data "#+BEGIN_SRC emacs-lisp\n\n\n#+END_SRC"
  3312. (org-export-format-code-default
  3313. (org-element-map tree 'src-block 'identity info t) info))))
  3314. ;; Number lines, two whitespace characters before the actual loc.
  3315. (should
  3316. (equal "1 a\n2 b\n"
  3317. (org-test-with-parsed-data
  3318. "#+BEGIN_SRC emacs-lisp +n\na\nb\n#+END_SRC"
  3319. (org-export-format-code-default
  3320. (org-element-map tree 'src-block 'identity info t) info))))
  3321. ;; Put references 6 whitespace characters after the widest line,
  3322. ;; wrapped within parenthesis.
  3323. (should
  3324. (equal "123 (a)\n1 (b)\n"
  3325. (let ((org-coderef-label-format "(ref:%s)"))
  3326. (org-test-with-parsed-data
  3327. "#+BEGIN_SRC emacs-lisp\n123 (ref:a)\n1 (ref:b)\n#+END_SRC"
  3328. (org-export-format-code-default
  3329. (org-element-map tree 'src-block 'identity info t) info))))))
  3330. ;;; Smart Quotes
  3331. (ert-deftest test-org-export/activate-smart-quotes ()
  3332. "Test `org-export-activate-smart-quotes' specifications."
  3333. ;; Double quotes: standard test.
  3334. (should
  3335. (equal
  3336. '("some &ldquo;quoted&rdquo; text")
  3337. (let ((org-export-default-language "en"))
  3338. (org-test-with-parsed-data "some \"quoted\" text"
  3339. (org-element-map tree 'plain-text
  3340. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3341. info)))))
  3342. ;; Opening quotes: at the beginning of a paragraph.
  3343. (should
  3344. (equal
  3345. '("&ldquo;begin")
  3346. (let ((org-export-default-language "en"))
  3347. (org-test-with-parsed-data "\"begin"
  3348. (org-element-map tree 'plain-text
  3349. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3350. info)))))
  3351. ;; Opening quotes: after an object.
  3352. (should
  3353. (equal
  3354. '("&ldquo;quoted&rdquo; text")
  3355. (let ((org-export-default-language "en"))
  3356. (org-test-with-parsed-data "=verb= \"quoted\" text"
  3357. (org-element-map tree 'plain-text
  3358. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3359. info)))))
  3360. ;; Closing quotes: at the end of a paragraph.
  3361. (should
  3362. (equal
  3363. '("Quoted &ldquo;text&rdquo;")
  3364. (let ((org-export-default-language "en"))
  3365. (org-test-with-parsed-data "Quoted \"text\""
  3366. (org-element-map tree 'plain-text
  3367. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3368. info)))))
  3369. ;; Inner quotes: standard test.
  3370. (should
  3371. (equal '("« outer « inner » outer »")
  3372. (let ((org-export-default-language "fr"))
  3373. (org-test-with-parsed-data "\"outer 'inner' outer\""
  3374. (org-element-map tree 'plain-text
  3375. (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
  3376. info)))))
  3377. ;; Inner quotes: close to special symbols.
  3378. (should
  3379. (equal '("« outer (« inner ») outer »")
  3380. (let ((org-export-default-language "fr"))
  3381. (org-test-with-parsed-data "\"outer ('inner') outer\""
  3382. (org-element-map tree 'plain-text
  3383. (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
  3384. info)))))
  3385. (should
  3386. (equal '("« « inner » »")
  3387. (let ((org-export-default-language "fr"))
  3388. (org-test-with-parsed-data "\"'inner'\""
  3389. (org-element-map tree 'plain-text
  3390. (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
  3391. info)))))
  3392. ;; Apostrophe: standard test.
  3393. (should
  3394. (equal '("It « shouldn’t » fail")
  3395. (let ((org-export-default-language "fr"))
  3396. (org-test-with-parsed-data "It \"shouldn't\" fail"
  3397. (org-element-map tree 'plain-text
  3398. (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
  3399. info)))))
  3400. (should
  3401. (equal '("It shouldn’t fail")
  3402. (let ((org-export-default-language "fr"))
  3403. (org-test-with-parsed-data "It shouldn't fail"
  3404. (org-element-map tree 'plain-text
  3405. (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
  3406. info)))))
  3407. ;; Apostrophe: before an object.
  3408. (should
  3409. (equal
  3410. '("« a’" " »")
  3411. (let ((org-export-default-language "fr"))
  3412. (org-test-with-parsed-data "\"a'=b=\""
  3413. (org-element-map tree 'plain-text
  3414. (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
  3415. info)))))
  3416. ;; Apostrophe: after an object.
  3417. (should
  3418. (equal '("« " "’s »")
  3419. (let ((org-export-default-language "fr"))
  3420. (org-test-with-parsed-data "\"=code='s\""
  3421. (org-element-map tree 'plain-text
  3422. (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
  3423. info)))))
  3424. ;; Special case: isolated quotes.
  3425. (should
  3426. (equal '("&ldquo;" "&rdquo;")
  3427. (let ((org-export-default-language "en"))
  3428. (org-test-with-parsed-data "\"$x$\""
  3429. (org-element-map tree 'plain-text
  3430. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3431. info)))))
  3432. ;; Smart quotes in secondary strings.
  3433. (should
  3434. (equal '("&ldquo;" "&rdquo;")
  3435. (let ((org-export-default-language "en"))
  3436. (org-test-with-parsed-data "* \"$x$\""
  3437. (org-element-map tree 'plain-text
  3438. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3439. info)))))
  3440. ;; Smart quotes in document keywords.
  3441. (should
  3442. (equal '("&ldquo;" "&rdquo;")
  3443. (let ((org-export-default-language "en"))
  3444. (org-test-with-parsed-data "#+TITLE: \"$x$\""
  3445. (org-element-map (plist-get info :title) 'plain-text
  3446. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3447. info)))))
  3448. ;; Smart quotes in parsed affiliated keywords.
  3449. (should
  3450. (equal '("&ldquo;" "&rdquo;" "Paragraph")
  3451. (let ((org-export-default-language "en"))
  3452. (org-test-with-parsed-data "#+CAPTION: \"$x$\"\nParagraph"
  3453. (org-element-map tree 'plain-text
  3454. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3455. info nil nil t)))))
  3456. ;; Smart quotes within objects.
  3457. (should
  3458. (equal '("&ldquo;foo&rdquo;")
  3459. (let ((org-export-default-language "en"))
  3460. (org-test-with-parsed-data "| \"foo\" |"
  3461. (org-element-map tree 'plain-text
  3462. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3463. info nil nil t)))))
  3464. ;; FIXME: Test failing non-interactively.
  3465. ;;
  3466. ;; (should
  3467. ;; (equal '("&ldquo;foo&rdquo;")
  3468. ;; (let ((org-export-default-language "en"))
  3469. ;; (org-test-with-parsed-data "*\"foo\"*"
  3470. ;; (org-element-map tree 'plain-text
  3471. ;; (lambda (s) (org-export-activate-smart-quotes s :html info))
  3472. ;; info nil nil t)))))
  3473. )
  3474. ;;; Tables
  3475. (ert-deftest test-org-export/special-column ()
  3476. "Test if the table's special column is properly recognized."
  3477. ;; 1. First column is special if it contains only a special marking
  3478. ;; characters or empty cells.
  3479. (org-test-with-temp-text "
  3480. | ! | 1 |
  3481. | | 2 |"
  3482. (should
  3483. (org-export-table-has-special-column-p
  3484. (org-element-map
  3485. (org-element-parse-buffer) 'table 'identity nil 'first-match))))
  3486. ;; 2. If the column contains anything else, it isn't special.
  3487. (org-test-with-temp-text "
  3488. | ! | 1 |
  3489. | b | 2 |"
  3490. (should-not
  3491. (org-export-table-has-special-column-p
  3492. (org-element-map
  3493. (org-element-parse-buffer) 'table 'identity nil 'first-match))))
  3494. ;; 3. Special marking characters are "#", "^", "*", "_", "/", "$"
  3495. ;; and "!".
  3496. (org-test-with-temp-text "
  3497. | # | 1 |
  3498. | ^ | 2 |
  3499. | * | 3 |
  3500. | _ | 4 |
  3501. | / | 5 |
  3502. | $ | 6 |
  3503. | ! | 7 |"
  3504. (should
  3505. (org-export-table-has-special-column-p
  3506. (org-element-map
  3507. (org-element-parse-buffer) 'table 'identity nil 'first-match))))
  3508. ;; 4. A first column with only empty cells isn't considered as
  3509. ;; special.
  3510. (org-test-with-temp-text "
  3511. | | 1 |
  3512. | | 2 |"
  3513. (should-not
  3514. (org-export-table-has-special-column-p
  3515. (org-element-map
  3516. (org-element-parse-buffer) 'table 'identity nil 'first-match)))))
  3517. (ert-deftest test-org-export/table-row-is-special-p ()
  3518. "Test `org-export-table-row-is-special-p' specifications."
  3519. ;; 1. A row is special if it has a special marking character in the
  3520. ;; special column.
  3521. (org-test-with-parsed-data "| ! | 1 |"
  3522. (should
  3523. (org-export-table-row-is-special-p
  3524. (org-element-map tree 'table-row 'identity nil 'first-match) info)))
  3525. ;; 2. A row is special when its first field is "/"
  3526. (org-test-with-parsed-data "
  3527. | / | 1 |
  3528. | a | b |"
  3529. (should
  3530. (org-export-table-row-is-special-p
  3531. (org-element-map tree 'table-row 'identity nil 'first-match) info)))
  3532. ;; 3. A row only containing alignment cookies is also considered as
  3533. ;; special.
  3534. (org-test-with-parsed-data "| <5> | | <l> | <l22> |"
  3535. (should
  3536. (org-export-table-row-is-special-p
  3537. (org-element-map tree 'table-row 'identity nil 'first-match) info)))
  3538. ;; 4. Everything else isn't considered as special.
  3539. (org-test-with-parsed-data "| \alpha | | c |"
  3540. (should-not
  3541. (org-export-table-row-is-special-p
  3542. (org-element-map tree 'table-row 'identity nil 'first-match) info)))
  3543. ;; 5. Table's rules are never considered as special rows.
  3544. (org-test-with-parsed-data "|---+---|"
  3545. (should-not
  3546. (org-export-table-row-is-special-p
  3547. (org-element-map tree 'table-row 'identity nil 'first-match) info))))
  3548. (ert-deftest test-org-export/has-header-p ()
  3549. "Test `org-export-table-has-header-p' specifications."
  3550. ;; With an header.
  3551. (should
  3552. (org-test-with-parsed-data "
  3553. | a | b |
  3554. |---+---|
  3555. | c | d |"
  3556. (org-export-table-has-header-p
  3557. (org-element-map tree 'table 'identity info 'first-match)
  3558. info)))
  3559. ;; Without an header.
  3560. (should-not
  3561. (org-test-with-parsed-data "
  3562. | a | b |
  3563. | c | d |"
  3564. (org-export-table-has-header-p
  3565. (org-element-map tree 'table 'identity info 'first-match)
  3566. info)))
  3567. ;; Don't get fooled with starting and ending rules.
  3568. (should-not
  3569. (org-test-with-parsed-data "
  3570. |---+---|
  3571. | a | b |
  3572. | c | d |
  3573. |---+---|"
  3574. (org-export-table-has-header-p
  3575. (org-element-map tree 'table 'identity info 'first-match)
  3576. info))))
  3577. (ert-deftest test-org-export/table-row-group ()
  3578. "Test `org-export-table-row-group' specifications."
  3579. ;; A rule creates a new group.
  3580. (should
  3581. (equal '(1 rule 2)
  3582. (org-test-with-parsed-data "
  3583. | a | b |
  3584. |---+---|
  3585. | 1 | 2 |"
  3586. (org-element-map tree 'table-row
  3587. (lambda (row)
  3588. (if (eq (org-element-property :type row) 'rule) 'rule
  3589. (org-export-table-row-group row info)))))))
  3590. ;; Special rows are ignored in count.
  3591. (should
  3592. (equal
  3593. '(rule 1)
  3594. (org-test-with-parsed-data "
  3595. | / | < | > |
  3596. |---|---+---|
  3597. | | 1 | 2 |"
  3598. (org-element-map tree 'table-row
  3599. (lambda (row)
  3600. (if (eq (org-element-property :type row) 'rule) 'rule
  3601. (org-export-table-row-group row info)))
  3602. info))))
  3603. ;; Double rules also are ignored in count.
  3604. (should
  3605. (equal '(1 rule rule 2)
  3606. (org-test-with-parsed-data "
  3607. | a | b |
  3608. |---+---|
  3609. |---+---|
  3610. | 1 | 2 |"
  3611. (org-element-map tree 'table-row
  3612. (lambda (row)
  3613. (if (eq (org-element-property :type row) 'rule) 'rule
  3614. (org-export-table-row-group row info))))))))
  3615. (ert-deftest test-org-export/table-row-number ()
  3616. "Test `org-export-table-row-number' specifications."
  3617. ;; Standard test. Number is 0-indexed.
  3618. (should
  3619. (equal '(0 1)
  3620. (org-test-with-parsed-data "| a | b | c |\n| d | e | f |"
  3621. (org-element-map tree 'table-row
  3622. (lambda (row) (org-export-table-row-number row info)) info))))
  3623. ;; Number ignores separators.
  3624. (should
  3625. (equal '(0 1)
  3626. (org-test-with-parsed-data "
  3627. | a | b | c |
  3628. |---+---+---|
  3629. | d | e | f |"
  3630. (org-element-map tree 'table-row
  3631. (lambda (row) (org-export-table-row-number row info)) info))))
  3632. ;; Number ignores special rows.
  3633. (should
  3634. (equal '(0 1)
  3635. (org-test-with-parsed-data "
  3636. | / | < | > |
  3637. | | b | c |
  3638. |---+-----+-----|
  3639. | | <c> | <c> |
  3640. | | e | f |"
  3641. (org-element-map tree 'table-row
  3642. (lambda (row) (org-export-table-row-number row info)) info)))))
  3643. (ert-deftest test-org-export/table-cell-width ()
  3644. "Test `org-export-table-cell-width' specifications."
  3645. ;; 1. Width is primarily determined by width cookies. If no cookie
  3646. ;; is found, cell's width is nil.
  3647. (org-test-with-parsed-data "
  3648. | / | <l> | <6> | <l7> |
  3649. | | a | b | c |"
  3650. (should
  3651. (equal
  3652. '(nil 6 7)
  3653. (mapcar (lambda (cell) (org-export-table-cell-width cell info))
  3654. (org-element-map tree 'table-cell 'identity info)))))
  3655. ;; 2. The last width cookie has precedence.
  3656. (org-test-with-parsed-data "
  3657. | <6> |
  3658. | <7> |
  3659. | a |"
  3660. (should
  3661. (equal
  3662. '(7)
  3663. (mapcar (lambda (cell) (org-export-table-cell-width cell info))
  3664. (org-element-map tree 'table-cell 'identity info)))))
  3665. ;; 3. Valid width cookies must have a specific row.
  3666. (org-test-with-parsed-data "| <6> | cell |"
  3667. (should
  3668. (equal
  3669. '(nil nil)
  3670. (mapcar (lambda (cell) (org-export-table-cell-width cell info))
  3671. (org-element-map tree 'table-cell 'identity))))))
  3672. (ert-deftest test-org-export/table-cell-alignment ()
  3673. "Test `org-export-table-cell-alignment' specifications."
  3674. ;; 1. Alignment is primarily determined by alignment cookies.
  3675. (should
  3676. (equal '(left center right)
  3677. (let ((org-table-number-fraction 0.5)
  3678. (org-table-number-regexp "^[0-9]+$"))
  3679. (org-test-with-parsed-data "| <l> | <c> | <r> |"
  3680. (mapcar (lambda (cell)
  3681. (org-export-table-cell-alignment cell info))
  3682. (org-element-map tree 'table-cell 'identity))))))
  3683. ;; 2. The last alignment cookie has precedence.
  3684. (should
  3685. (equal '(right right right)
  3686. (org-test-with-parsed-data "
  3687. | <l8> |
  3688. | cell |
  3689. | <r9> |"
  3690. (mapcar (lambda (cell) (org-export-table-cell-alignment cell info))
  3691. (org-element-map tree 'table-cell 'identity)))))
  3692. ;; 3. If there's no cookie, cell's contents determine alignment.
  3693. ;; A column mostly made of cells containing numbers will align
  3694. ;; its cells to the right.
  3695. (should
  3696. (equal '(right right right)
  3697. (let ((org-table-number-fraction 0.5)
  3698. (org-table-number-regexp "^[0-9]+$"))
  3699. (org-test-with-parsed-data "
  3700. | 123 |
  3701. | some text |
  3702. | 12345 |"
  3703. (mapcar (lambda (cell)
  3704. (org-export-table-cell-alignment cell info))
  3705. (org-element-map tree 'table-cell 'identity))))))
  3706. ;; 4. Otherwise, they will be aligned to the left.
  3707. (should
  3708. (equal '(left left left)
  3709. (org-test-with-parsed-data "
  3710. | text |
  3711. | some text |
  3712. | \alpha |"
  3713. (mapcar (lambda (cell)
  3714. (org-export-table-cell-alignment cell info))
  3715. (org-element-map tree 'table-cell 'identity info))))))
  3716. (ert-deftest test-org-export/table-cell-borders ()
  3717. "Test `org-export-table-cell-borders' specifications."
  3718. ;; 1. Recognize various column groups indicators.
  3719. (org-test-with-parsed-data "| / | < | > | <> |"
  3720. (should
  3721. (equal
  3722. '((right bottom top) (left bottom top) (right bottom top)
  3723. (right left bottom top))
  3724. (mapcar (lambda (cell)
  3725. (org-export-table-cell-borders cell info))
  3726. (org-element-map tree 'table-cell 'identity)))))
  3727. ;; 2. Accept shortcuts to define column groups.
  3728. (org-test-with-parsed-data "| / | < | < |"
  3729. (should
  3730. (equal
  3731. '((right bottom top) (right left bottom top) (left bottom top))
  3732. (mapcar (lambda (cell)
  3733. (org-export-table-cell-borders cell info))
  3734. (org-element-map tree 'table-cell 'identity)))))
  3735. ;; 3. A valid column groups row must start with a "/".
  3736. (org-test-with-parsed-data "
  3737. | | < |
  3738. | a | b |"
  3739. (should
  3740. (equal '((top) (top) (bottom) (bottom))
  3741. (mapcar (lambda (cell)
  3742. (org-export-table-cell-borders cell info))
  3743. (org-element-map tree 'table-cell 'identity)))))
  3744. ;; 4. Take table rules into consideration.
  3745. (org-test-with-parsed-data "
  3746. | 1 |
  3747. |---|
  3748. | 2 |"
  3749. (should
  3750. (equal '((below top) (bottom above))
  3751. (mapcar (lambda (cell)
  3752. (org-export-table-cell-borders cell info))
  3753. (org-element-map tree 'table-cell 'identity)))))
  3754. ;; 5. Top and (resp. bottom) rules induce both `top' and `above'
  3755. ;; (resp. `bottom' and `below') borders. Any special row is
  3756. ;; ignored.
  3757. (org-test-with-parsed-data "
  3758. |---+----|
  3759. | / | |
  3760. | | 1 |
  3761. |---+----|"
  3762. (should
  3763. (equal '((bottom below top above))
  3764. (last
  3765. (mapcar (lambda (cell)
  3766. (org-export-table-cell-borders cell info))
  3767. (org-element-map tree 'table-cell 'identity)))))))
  3768. (ert-deftest test-org-export/table-dimensions ()
  3769. "Test `org-export-table-dimensions' specifications."
  3770. ;; 1. Standard test.
  3771. (org-test-with-parsed-data "
  3772. | 1 | 2 | 3 |
  3773. | 4 | 5 | 6 |"
  3774. (should
  3775. (equal '(2 . 3)
  3776. (org-export-table-dimensions
  3777. (org-element-map tree 'table 'identity info 'first-match) info))))
  3778. ;; 2. Ignore horizontal rules and special columns.
  3779. (org-test-with-parsed-data "
  3780. | / | < | > |
  3781. | 1 | 2 | 3 |
  3782. |---+---+---|
  3783. | 4 | 5 | 6 |"
  3784. (should
  3785. (equal '(2 . 3)
  3786. (org-export-table-dimensions
  3787. (org-element-map tree 'table 'identity info 'first-match) info)))))
  3788. (ert-deftest test-org-export/table-cell-address ()
  3789. "Test `org-export-table-cell-address' specifications."
  3790. ;; 1. Standard test: index is 0-based.
  3791. (org-test-with-parsed-data "| a | b |"
  3792. (should
  3793. (equal '((0 . 0) (0 . 1))
  3794. (org-element-map tree 'table-cell
  3795. (lambda (cell) (org-export-table-cell-address cell info))
  3796. info))))
  3797. ;; 2. Special column isn't counted, nor are special rows.
  3798. (org-test-with-parsed-data "
  3799. | / | <> |
  3800. | | c |"
  3801. (should
  3802. (equal '(0 . 0)
  3803. (org-export-table-cell-address
  3804. (car (last (org-element-map tree 'table-cell 'identity info)))
  3805. info))))
  3806. ;; 3. Tables rules do not count either.
  3807. (org-test-with-parsed-data "
  3808. | a |
  3809. |---|
  3810. | b |
  3811. |---|
  3812. | c |"
  3813. (should
  3814. (equal '(2 . 0)
  3815. (org-export-table-cell-address
  3816. (car (last (org-element-map tree 'table-cell 'identity info)))
  3817. info))))
  3818. ;; 4. Return nil for special cells.
  3819. (org-test-with-parsed-data "| / | a |"
  3820. (should-not
  3821. (org-export-table-cell-address
  3822. (org-element-map tree 'table-cell 'identity nil 'first-match)
  3823. info))))
  3824. (ert-deftest test-org-export/get-table-cell-at ()
  3825. "Test `org-export-get-table-cell-at' specifications."
  3826. ;; 1. Address ignores special columns, special rows and rules.
  3827. (org-test-with-parsed-data "
  3828. | / | <> |
  3829. | | a |
  3830. |---+----|
  3831. | | b |"
  3832. (should
  3833. (equal '("b")
  3834. (org-element-contents
  3835. (org-export-get-table-cell-at
  3836. '(1 . 0)
  3837. (org-element-map tree 'table 'identity info 'first-match)
  3838. info)))))
  3839. ;; 2. Return value for a non-existent address is nil.
  3840. (org-test-with-parsed-data "| a |"
  3841. (should-not
  3842. (org-export-get-table-cell-at
  3843. '(2 . 2)
  3844. (org-element-map tree 'table 'identity info 'first-match)
  3845. info)))
  3846. (org-test-with-parsed-data "| / |"
  3847. (should-not
  3848. (org-export-get-table-cell-at
  3849. '(0 . 0)
  3850. (org-element-map tree 'table 'identity info 'first-match)
  3851. info))))
  3852. (ert-deftest test-org-export/table-cell-starts-colgroup-p ()
  3853. "Test `org-export-table-cell-starts-colgroup-p' specifications."
  3854. ;; 1. A cell at a beginning of a row always starts a column group.
  3855. (org-test-with-parsed-data "| a |"
  3856. (should
  3857. (org-export-table-cell-starts-colgroup-p
  3858. (org-element-map tree 'table-cell 'identity info 'first-match)
  3859. info)))
  3860. ;; 2. Special column should be ignored when determining the
  3861. ;; beginning of the row.
  3862. (org-test-with-parsed-data "
  3863. | / | |
  3864. | | a |"
  3865. (should
  3866. (org-export-table-cell-starts-colgroup-p
  3867. (org-element-map tree 'table-cell 'identity info 'first-match)
  3868. info)))
  3869. ;; 2. Explicit column groups.
  3870. (org-test-with-parsed-data "
  3871. | / | | < |
  3872. | a | b | c |"
  3873. (should
  3874. (equal
  3875. '(yes no yes)
  3876. (org-element-map tree 'table-cell
  3877. (lambda (cell)
  3878. (if (org-export-table-cell-starts-colgroup-p cell info) 'yes 'no))
  3879. info)))))
  3880. (ert-deftest test-org-export/table-cell-ends-colgroup-p ()
  3881. "Test `org-export-table-cell-ends-colgroup-p' specifications."
  3882. ;; 1. A cell at the end of a row always ends a column group.
  3883. (org-test-with-parsed-data "| a |"
  3884. (should
  3885. (org-export-table-cell-ends-colgroup-p
  3886. (org-element-map tree 'table-cell 'identity info 'first-match)
  3887. info)))
  3888. ;; 2. Special column should be ignored when determining the
  3889. ;; beginning of the row.
  3890. (org-test-with-parsed-data "
  3891. | / | |
  3892. | | a |"
  3893. (should
  3894. (org-export-table-cell-ends-colgroup-p
  3895. (org-element-map tree 'table-cell 'identity info 'first-match)
  3896. info)))
  3897. ;; 3. Explicit column groups.
  3898. (org-test-with-parsed-data "
  3899. | / | < | |
  3900. | a | b | c |"
  3901. (should
  3902. (equal
  3903. '(yes no yes)
  3904. (org-element-map tree 'table-cell
  3905. (lambda (cell)
  3906. (if (org-export-table-cell-ends-colgroup-p cell info) 'yes 'no))
  3907. info)))))
  3908. (ert-deftest test-org-export/table-row-starts-rowgroup-p ()
  3909. "Test `org-export-table-row-starts-rowgroup-p' specifications."
  3910. ;; 1. A row at the beginning of a table always starts a row group.
  3911. ;; So does a row following a table rule.
  3912. (org-test-with-parsed-data "
  3913. | a |
  3914. |---|
  3915. | b |"
  3916. (should
  3917. (equal
  3918. '(yes no yes)
  3919. (org-element-map tree 'table-row
  3920. (lambda (row)
  3921. (if (org-export-table-row-starts-rowgroup-p row info) 'yes 'no))
  3922. info))))
  3923. ;; 2. Special rows should be ignored when determining the beginning
  3924. ;; of the row.
  3925. (org-test-with-parsed-data "
  3926. | / | < |
  3927. | | a |
  3928. |---+---|
  3929. | / | < |
  3930. | | b |"
  3931. (should
  3932. (equal
  3933. '(yes no yes)
  3934. (org-element-map tree 'table-row
  3935. (lambda (row)
  3936. (if (org-export-table-row-starts-rowgroup-p row info) 'yes 'no))
  3937. info)))))
  3938. (ert-deftest test-org-export/table-row-ends-rowgroup-p ()
  3939. "Test `org-export-table-row-ends-rowgroup-p' specifications."
  3940. ;; 1. A row at the end of a table always ends a row group. So does
  3941. ;; a row preceding a table rule.
  3942. (org-test-with-parsed-data "
  3943. | a |
  3944. |---|
  3945. | b |"
  3946. (should
  3947. (equal
  3948. '(yes no yes)
  3949. (org-element-map tree 'table-row
  3950. (lambda (row)
  3951. (if (org-export-table-row-ends-rowgroup-p row info) 'yes 'no))
  3952. info))))
  3953. ;; 2. Special rows should be ignored when determining the beginning
  3954. ;; of the row.
  3955. (org-test-with-parsed-data "
  3956. | | a |
  3957. | / | < |
  3958. |---+---|
  3959. | | b |
  3960. | / | < |"
  3961. (should
  3962. (equal
  3963. '(yes no yes)
  3964. (org-element-map tree 'table-row
  3965. (lambda (row)
  3966. (if (org-export-table-row-ends-rowgroup-p row info) 'yes 'no))
  3967. info)))))
  3968. (ert-deftest test-org-export/table-row-in-header-p ()
  3969. "Test `org-export-table-row-in-header-p' specifications."
  3970. ;; Standard test. Separators are always nil.
  3971. (should
  3972. (equal
  3973. '(yes no no)
  3974. (org-test-with-parsed-data "| a |\n|---|\n| b |"
  3975. (org-element-map tree 'table-row
  3976. (lambda (row)
  3977. (if (org-export-table-row-in-header-p row info) 'yes 'no)) info))))
  3978. ;; Nil when there is no header.
  3979. (should
  3980. (equal
  3981. '(no no)
  3982. (org-test-with-parsed-data "| a |\n| b |"
  3983. (org-element-map tree 'table-row
  3984. (lambda (row)
  3985. (if (org-export-table-row-in-header-p row info) 'yes 'no)) info)))))
  3986. (ert-deftest test-org-export/table-row-starts-header-p ()
  3987. "Test `org-export-table-row-starts-header-p' specifications."
  3988. ;; 1. Only the row starting the first row group starts the table
  3989. ;; header.
  3990. (org-test-with-parsed-data "
  3991. | a |
  3992. | b |
  3993. |---|
  3994. | c |"
  3995. (should
  3996. (equal
  3997. '(yes no no no)
  3998. (org-element-map tree 'table-row
  3999. (lambda (row)
  4000. (if (org-export-table-row-starts-header-p row info) 'yes 'no))
  4001. info))))
  4002. ;; 2. A row cannot start an header if there's no header in the
  4003. ;; table.
  4004. (org-test-with-parsed-data "
  4005. | a |
  4006. |---|"
  4007. (should-not
  4008. (org-export-table-row-starts-header-p
  4009. (org-element-map tree 'table-row 'identity info 'first-match)
  4010. info))))
  4011. (ert-deftest test-org-export/table-row-ends-header-p ()
  4012. "Test `org-export-table-row-ends-header-p' specifications."
  4013. ;; 1. Only the row starting the first row group starts the table
  4014. ;; header.
  4015. (org-test-with-parsed-data "
  4016. | a |
  4017. | b |
  4018. |---|
  4019. | c |"
  4020. (should
  4021. (equal
  4022. '(no yes no no)
  4023. (org-element-map tree 'table-row
  4024. (lambda (row)
  4025. (if (org-export-table-row-ends-header-p row info) 'yes 'no))
  4026. info))))
  4027. ;; 2. A row cannot start an header if there's no header in the
  4028. ;; table.
  4029. (org-test-with-parsed-data "
  4030. | a |
  4031. |---|"
  4032. (should-not
  4033. (org-export-table-row-ends-header-p
  4034. (org-element-map tree 'table-row 'identity info 'first-match)
  4035. info))))
  4036. ;;; Tables of Contents
  4037. (ert-deftest test-org-export/collect-headlines ()
  4038. "Test `org-export-collect-headlines' specifications."
  4039. ;; Standard test.
  4040. (should
  4041. (= 2
  4042. (length
  4043. (org-test-with-parsed-data "* H1\n** H2"
  4044. (org-export-collect-headlines info)))))
  4045. ;; Do not collect headlines below optional argument.
  4046. (should
  4047. (= 1
  4048. (length
  4049. (org-test-with-parsed-data "* H1\n** H2"
  4050. (org-export-collect-headlines info 1)))))
  4051. ;; Never collect headlines below maximum headline level.
  4052. (should
  4053. (= 1
  4054. (length
  4055. (org-test-with-parsed-data "#+OPTIONS: H:1\n* H1\n** H2"
  4056. (org-export-collect-headlines info)))))
  4057. (should
  4058. (= 1
  4059. (length
  4060. (org-test-with-parsed-data "#+OPTIONS: H:1\n* H1\n** H2"
  4061. (org-export-collect-headlines info 2)))))
  4062. ;; Collect headlines locally.
  4063. (should
  4064. (= 2
  4065. (org-test-with-parsed-data "* H1\n** H2\n** H3"
  4066. (let ((scope (org-element-map tree 'headline #'identity info t)))
  4067. (length (org-export-collect-headlines info nil scope))))))
  4068. ;; When collecting locally, optional level is relative.
  4069. (should
  4070. (= 1
  4071. (org-test-with-parsed-data "* H1\n** H2\n*** H3"
  4072. (let ((scope (org-element-map tree 'headline #'identity info t)))
  4073. (length (org-export-collect-headlines info 1 scope)))))))
  4074. ;;; Templates
  4075. (ert-deftest test-org-export/inner-template ()
  4076. "Test `inner-template' translator specifications."
  4077. (should
  4078. (equal "Success!"
  4079. (org-test-with-temp-text "* Headline"
  4080. (org-export-as
  4081. (org-export-create-backend
  4082. :transcoders
  4083. '((inner-template . (lambda (contents info) "Success!"))
  4084. (headline . (lambda (h c i) "Headline"))))))))
  4085. ;; Inner template is applied even in a "body-only" export.
  4086. (should
  4087. (equal "Success!"
  4088. (org-test-with-temp-text "* Headline"
  4089. (org-export-as
  4090. (org-export-create-backend
  4091. :transcoders '((inner-template . (lambda (c i) "Success!"))
  4092. (headline . (lambda (h c i) "Headline"))))
  4093. nil nil 'body-only)))))
  4094. (ert-deftest test-org-export/template ()
  4095. "Test `template' translator specifications."
  4096. (should
  4097. (equal "Success!"
  4098. (org-test-with-temp-text "* Headline"
  4099. (org-export-as
  4100. (org-export-create-backend
  4101. :transcoders '((template . (lambda (contents info) "Success!"))
  4102. (headline . (lambda (h c i) "Headline"))))))))
  4103. ;; Template is not applied in a "body-only" export.
  4104. (should-not
  4105. (equal "Success!"
  4106. (org-test-with-temp-text "* Headline"
  4107. (org-export-as
  4108. (org-export-create-backend
  4109. :transcoders '((template . (lambda (contents info) "Success!"))
  4110. (headline . (lambda (h c i) "Headline"))))
  4111. nil nil 'body-only)))))
  4112. ;;; Topology
  4113. (ert-deftest test-org-export/get-next-element ()
  4114. "Test `org-export-get-next-element' specifications."
  4115. ;; Standard test.
  4116. (should
  4117. (equal "b"
  4118. (org-test-with-parsed-data "* Headline\n*a* b"
  4119. (org-export-get-next-element
  4120. (org-element-map tree 'bold 'identity info t) info))))
  4121. ;; Return nil when no previous element.
  4122. (should-not
  4123. (org-test-with-parsed-data "* Headline\na *b*"
  4124. (org-export-get-next-element
  4125. (org-element-map tree 'bold 'identity info t) info)))
  4126. ;; Non-exportable elements are ignored.
  4127. (should-not
  4128. (let ((org-export-with-timestamps nil))
  4129. (org-test-with-parsed-data "\alpha <2012-03-29 Thu>"
  4130. (org-export-get-next-element
  4131. (org-element-map tree 'entity 'identity info t) info))))
  4132. ;; Find next element in secondary strings.
  4133. (should
  4134. (eq 'verbatim
  4135. (org-test-with-parsed-data "* a =verb="
  4136. (org-element-type
  4137. (org-export-get-next-element
  4138. (org-element-map tree 'plain-text 'identity info t) info)))))
  4139. (should
  4140. (eq 'verbatim
  4141. (org-test-with-parsed-data "* /italic/ =verb="
  4142. (org-element-type
  4143. (org-export-get-next-element
  4144. (org-element-map tree 'italic 'identity info t) info)))))
  4145. ;; Find next element in document keywords.
  4146. (should
  4147. (eq 'verbatim
  4148. (org-test-with-parsed-data "#+TITLE: a =verb="
  4149. (org-element-type
  4150. (org-export-get-next-element
  4151. (org-element-map
  4152. (plist-get info :title) 'plain-text 'identity info t) info)))))
  4153. ;; Find next element in parsed affiliated keywords.
  4154. (should
  4155. (eq 'verbatim
  4156. (org-test-with-parsed-data "#+CAPTION: a =verb=\nParagraph"
  4157. (org-element-type
  4158. (org-export-get-next-element
  4159. (org-element-map tree 'plain-text 'identity info t nil t) info)))))
  4160. ;; With optional argument N, return a list containing all the
  4161. ;; following elements.
  4162. (should
  4163. (equal
  4164. '(bold code underline)
  4165. (org-test-with-parsed-data "_a_ /b/ *c* ~d~ _e_"
  4166. (mapcar 'car
  4167. (org-export-get-next-element
  4168. (org-element-map tree 'italic 'identity info t) info t)))))
  4169. ;; When N is a positive integer, return a list containing up to
  4170. ;; N following elements.
  4171. (should
  4172. (equal
  4173. '(bold code)
  4174. (org-test-with-parsed-data "_a_ /b/ *c* ~d~ _e_"
  4175. (mapcar 'car
  4176. (org-export-get-next-element
  4177. (org-element-map tree 'italic 'identity info t) info 2))))))
  4178. (ert-deftest test-org-export/get-previous-element ()
  4179. "Test `org-export-get-previous-element' specifications."
  4180. ;; Standard test.
  4181. (should
  4182. (equal "a "
  4183. (org-test-with-parsed-data "* Headline\na *b*"
  4184. (org-export-get-previous-element
  4185. (org-element-map tree 'bold 'identity info t) info))))
  4186. ;; Return nil when no previous element.
  4187. (should-not
  4188. (org-test-with-parsed-data "* Headline\n*a* b"
  4189. (org-export-get-previous-element
  4190. (org-element-map tree 'bold 'identity info t) info)))
  4191. ;; Non-exportable elements are ignored.
  4192. (should-not
  4193. (let ((org-export-with-timestamps nil))
  4194. (org-test-with-parsed-data "<2012-03-29 Thu> \alpha"
  4195. (org-export-get-previous-element
  4196. (org-element-map tree 'entity 'identity info t) info))))
  4197. ;; Find previous element in secondary strings.
  4198. (should
  4199. (eq 'verbatim
  4200. (org-test-with-parsed-data "* =verb= a"
  4201. (org-element-type
  4202. (org-export-get-previous-element
  4203. (org-element-map tree 'plain-text 'identity info t) info)))))
  4204. (should
  4205. (eq 'verbatim
  4206. (org-test-with-parsed-data "* =verb= /italic/"
  4207. (org-element-type
  4208. (org-export-get-previous-element
  4209. (org-element-map tree 'italic 'identity info t) info)))))
  4210. ;; Find previous element in document keywords.
  4211. (should
  4212. (eq 'verbatim
  4213. (org-test-with-parsed-data "#+TITLE: =verb= a"
  4214. (org-element-type
  4215. (org-export-get-previous-element
  4216. (org-element-map
  4217. (plist-get info :title) 'plain-text 'identity info t) info)))))
  4218. ;; Find previous element in parsed affiliated keywords.
  4219. (should
  4220. (eq 'verbatim
  4221. (org-test-with-parsed-data "#+CAPTION: =verb= a\nParagraph"
  4222. (org-element-type
  4223. (org-export-get-previous-element
  4224. (org-element-map tree 'plain-text 'identity info t nil t) info)))))
  4225. ;; With optional argument N, return a list containing up to
  4226. ;; N previous elements.
  4227. (should
  4228. (equal '(underline italic bold)
  4229. (org-test-with-parsed-data "_a_ /b/ *c* ~d~"
  4230. (mapcar 'car
  4231. (org-export-get-previous-element
  4232. (org-element-map tree 'code 'identity info t) info t)))))
  4233. ;; When N is a positive integer, return a list containing up to
  4234. ;; N previous elements.
  4235. (should
  4236. (equal '(italic bold)
  4237. (org-test-with-parsed-data "_a_ /b/ *c* ~d~"
  4238. (mapcar 'car
  4239. (org-export-get-previous-element
  4240. (org-element-map tree 'code 'identity info t) info 2))))))
  4241. (provide 'test-ox)
  4242. ;;; test-org-export.el end here