test-ox.el 133 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080
  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-comments)
  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. (org-test-with-temp-text "
  856. * Head1
  857. ** Head2
  858. text
  859. *** Head3"
  860. ;; Subtree.
  861. (forward-line 3)
  862. (should (equal (org-export-as (org-test-default-backend) 'subtree)
  863. "text\n*** Head3\n"))
  864. ;; Visible.
  865. (goto-char (point-min))
  866. (forward-line)
  867. (org-cycle)
  868. (should (equal (org-export-as (org-test-default-backend) nil 'visible)
  869. "* Head1\n"))
  870. ;; Region.
  871. (goto-char (point-min))
  872. (forward-line 3)
  873. (transient-mark-mode 1)
  874. (push-mark (point) t t)
  875. (goto-char (point-at-eol))
  876. (should (equal (org-export-as (org-test-default-backend)) "text\n")))
  877. ;; Subtree with a code block calling another block outside.
  878. (let ((org-export-babel-evaluate t))
  879. (should
  880. (equal ": 3\n"
  881. (org-test-with-temp-text "
  882. * Head1
  883. #+BEGIN_SRC emacs-lisp :noweb yes :exports results
  884. <<test>>
  885. #+END_SRC
  886. * Head2
  887. #+NAME: test
  888. #+BEGIN_SRC emacs-lisp
  889. \(+ 1 2)
  890. #+END_SRC"
  891. (forward-line 1)
  892. (org-export-as (org-test-default-backend) 'subtree)))))
  893. ;; Body only.
  894. (let ((backend (org-test-default-backend)))
  895. (setf (org-export-backend-transcoders backend)
  896. (cons '(template . (lambda (body i)
  897. (format "BEGIN\n%sEND" body)))
  898. (org-export-backend-transcoders backend)))
  899. (org-test-with-temp-text "Text"
  900. (should (equal (org-export-as backend nil nil 'body-only)
  901. "Text\n"))
  902. (should (equal (org-export-as backend) "BEGIN\nText\nEND")))))
  903. (ert-deftest test-org-export/output-file-name ()
  904. "Test `org-export-output-file-name' specifications."
  905. ;; Export from a file: name is built from original file name.
  906. (should
  907. (org-test-with-temp-text-in-file "Test"
  908. (equal (concat (file-name-as-directory ".")
  909. (file-name-nondirectory
  910. (file-name-sans-extension (buffer-file-name))))
  911. (file-name-sans-extension (org-export-output-file-name ".ext")))))
  912. ;; When exporting to subtree, check EXPORT_FILE_NAME property first.
  913. (should
  914. (org-test-with-temp-text-in-file
  915. "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: test\n :END:"
  916. (equal (org-export-output-file-name ".ext" t) "./test.ext")))
  917. ;; From a buffer not associated to a file, too.
  918. (should
  919. (org-test-with-temp-text
  920. "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: test\n :END:"
  921. (equal (org-export-output-file-name ".ext" t) "./test.ext")))
  922. ;; When provided name is absolute, preserve it.
  923. (should
  924. (org-test-with-temp-text
  925. (format "* Test\n :PROPERTIES:\n :EXPORT_FILE_NAME: %s\n :END:"
  926. (expand-file-name "test"))
  927. (file-name-absolute-p (org-export-output-file-name ".ext" t))))
  928. ;; When PUB-DIR argument is provided, use it.
  929. (should
  930. (org-test-with-temp-text-in-file "Test"
  931. (equal (file-name-directory
  932. (org-export-output-file-name ".ext" nil "dir/"))
  933. "dir/")))
  934. ;; When returned name would overwrite original file, add EXTENSION
  935. ;; another time.
  936. (should
  937. (org-test-at-id "75282ba2-f77a-4309-a970-e87c149fe125"
  938. (equal (org-export-output-file-name ".org") "./normal.org.org"))))
  939. (ert-deftest test-org-export/expand-include ()
  940. "Test file inclusion in an Org buffer."
  941. ;; Error when file isn't specified.
  942. (should-error
  943. (org-test-with-temp-text "#+INCLUDE: dummy.org"
  944. (org-export-expand-include-keyword)))
  945. ;; Full insertion with recursive inclusion.
  946. (should
  947. (equal
  948. (with-temp-buffer
  949. (insert-file
  950. (expand-file-name "examples/include.org" org-test-dir))
  951. (replace-regexp-in-string
  952. (regexp-quote "#+INCLUDE: \"include2.org\"")
  953. "Success!" (buffer-string)))
  954. (org-test-with-temp-text
  955. (format "#+INCLUDE: \"%s/examples/include.org\"" org-test-dir)
  956. (org-export-expand-include-keyword)
  957. (buffer-string))))
  958. ;; Localized insertion.
  959. (org-test-with-temp-text
  960. (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\""
  961. org-test-dir)
  962. (org-export-expand-include-keyword)
  963. (should (equal (buffer-string)
  964. "Small Org file with an include keyword.\n")))
  965. ;; Insertion with constraints on headlines level.
  966. (should
  967. (equal
  968. "* Top heading\n** Heading\nbody\n"
  969. (org-test-with-temp-text
  970. (format
  971. "* Top heading\n#+INCLUDE: \"%s/examples/include.org\" :lines \"9-11\""
  972. org-test-dir)
  973. (org-export-expand-include-keyword)
  974. (buffer-string))))
  975. (should
  976. (equal
  977. "* Top heading\n* Heading\nbody\n"
  978. (org-test-with-temp-text
  979. (format
  980. "* Top heading\n#+INCLUDE: \"%s/examples/include.org\" :lines \"9-11\" :minlevel 1"
  981. org-test-dir)
  982. (org-export-expand-include-keyword)
  983. (buffer-string))))
  984. ;; Inclusion within an example block.
  985. (should
  986. (equal
  987. "#+BEGIN_EXAMPLE\nSmall Org file with an include keyword.\n#+END_EXAMPLE\n"
  988. (org-test-with-temp-text
  989. (format "#+INCLUDE: \"%s/examples/include.org\" :lines \"1-2\" EXAMPLE"
  990. org-test-dir)
  991. (org-export-expand-include-keyword)
  992. (buffer-string))))
  993. ;; Inclusion within a src-block.
  994. (should
  995. (equal
  996. "#+BEGIN_SRC emacs-lisp\n(+ 2 1)\n#+END_SRC\n"
  997. (org-test-with-temp-text
  998. (format
  999. "#+INCLUDE: \"%s/examples/include.org\" :lines \"4-5\" SRC emacs-lisp"
  1000. org-test-dir)
  1001. (org-export-expand-include-keyword)
  1002. (buffer-string))))
  1003. ;; Inclusion within an html export-block.
  1004. (should
  1005. (equal
  1006. "#+BEGIN_EXPORT html\n<p>HTML!</p>\n#+END_EXPORT\n"
  1007. (org-test-with-temp-text
  1008. (format
  1009. "#+INCLUDE: \"%s/examples/include.html\" EXPORT html"
  1010. org-test-dir)
  1011. (org-export-expand-include-keyword)
  1012. (buffer-string))))
  1013. ;; Inclusion within an center paragraph
  1014. (should
  1015. (equal
  1016. "#+BEGIN_CENTER\nSuccess!\n#+END_CENTER\n"
  1017. (org-test-with-temp-text
  1018. (format
  1019. "#+INCLUDE: \"%s/examples/include2.org\" CENTER"
  1020. org-test-dir)
  1021. (org-export-expand-include-keyword)
  1022. (buffer-string))))
  1023. ;; Footnotes labels are local to each included file.
  1024. (should
  1025. (= 6
  1026. (length
  1027. (delete-dups
  1028. (let ((contents "
  1029. Footnotes[fn:1], [fn:test], [fn:test] and [fn:inline:inline footnote].
  1030. \[fn:1] Footnote 1
  1031. \[fn:test] Footnote \"test\""))
  1032. (org-test-with-temp-text-in-file contents
  1033. (let ((file1 (buffer-file-name)))
  1034. (org-test-with-temp-text-in-file contents
  1035. (let ((file2 (buffer-file-name)))
  1036. (org-test-with-temp-text
  1037. (format "#+INCLUDE: \"%s\"\n#+INCLUDE: \"%s\""
  1038. file1 file2)
  1039. (org-export-expand-include-keyword)
  1040. (org-element-map (org-element-parse-buffer)
  1041. 'footnote-reference
  1042. (lambda (r) (org-element-property :label r)))))))))))))
  1043. ;; Footnotes labels are not local to each include keyword.
  1044. (should
  1045. (= 3
  1046. (length
  1047. (delete-dups
  1048. (let ((contents "
  1049. Footnotes[fn:1], [fn:test] and [fn:inline:inline footnote].
  1050. \[fn:1] Footnote 1
  1051. \[fn:test] Footnote \"test\""))
  1052. (org-test-with-temp-text-in-file contents
  1053. (let ((file (buffer-file-name)))
  1054. (org-test-with-temp-text
  1055. (format "#+INCLUDE: \"%s\"\n#+INCLUDE: \"%s\"" file file)
  1056. (org-export-expand-include-keyword)
  1057. (org-element-map (org-element-parse-buffer)
  1058. 'footnote-reference
  1059. (lambda (ref) (org-element-property :label ref)))))))))))
  1060. ;; Footnotes are supported by :lines-like elements and unnecessary
  1061. ;; footnotes are dropped.
  1062. (should
  1063. (= 3
  1064. (length
  1065. (delete-dups
  1066. (let ((contents "
  1067. * foo
  1068. Footnotes[fn:1]
  1069. * bar
  1070. Footnotes[fn:2], foot[fn:test] and [fn:inline:inline footnote]
  1071. \[fn:1] Footnote 1
  1072. \[fn:2] Footnote 1
  1073. * Footnotes
  1074. \[fn:test] Footnote \"test\"
  1075. "))
  1076. (org-test-with-temp-text-in-file contents
  1077. (let ((file (buffer-file-name)))
  1078. (org-test-with-temp-text
  1079. (format "#+INCLUDE: \"%s::*bar\"\n" file)
  1080. (org-export-expand-include-keyword)
  1081. (org-element-map (org-element-parse-buffer)
  1082. 'footnote-definition
  1083. (lambda (ref) (org-element-property :label ref)))))))))))
  1084. ;; If only-contents is non-nil only include contents of element.
  1085. (should
  1086. (equal
  1087. "body\n"
  1088. (org-test-with-temp-text
  1089. (concat
  1090. (format "#+INCLUDE: \"%s/examples/include.org::*Heading\" "
  1091. org-test-dir)
  1092. ":only-contents t")
  1093. (org-export-expand-include-keyword)
  1094. (buffer-string))))
  1095. ;; Headings can be included via CUSTOM_ID.
  1096. (should
  1097. (org-test-with-temp-text
  1098. (format "#+INCLUDE: \"%s/examples/include.org::#ah\"" org-test-dir)
  1099. (org-export-expand-include-keyword)
  1100. (goto-char (point-min))
  1101. (looking-at "* Another heading")))
  1102. ;; Named objects can be included.
  1103. (should
  1104. (equal
  1105. "| 1 |\n"
  1106. (org-test-with-temp-text
  1107. (format "#+INCLUDE: \"%s/examples/include.org::tbl\" :only-contents t"
  1108. org-test-dir)
  1109. (org-export-expand-include-keyword)
  1110. (buffer-string))))
  1111. ;; Including non-existing elements should result in an error.
  1112. (should-error
  1113. (org-test-with-temp-text
  1114. (format "#+INCLUDE: \"%s/examples/include.org::*non-existing heading\""
  1115. org-test-dir)
  1116. (org-export-expand-include-keyword)))
  1117. ;; Lines work relatively to an included element.
  1118. (should
  1119. (equal
  1120. "2\n3\n"
  1121. (org-test-with-temp-text
  1122. (format "#+INCLUDE: \"%s/examples/include.org::#ah\" :only-contents t \
  1123. :lines \"2-3\""
  1124. org-test-dir)
  1125. (org-export-expand-include-keyword)
  1126. (buffer-string))))
  1127. ;; Properties should be dropped from headlines.
  1128. (should
  1129. (equal
  1130. (org-test-with-temp-text
  1131. (format "#+INCLUDE: \"%s/examples/include.org::#ht\" :only-contents t"
  1132. org-test-dir)
  1133. (org-export-expand-include-keyword)
  1134. (buffer-string))
  1135. (org-test-with-temp-text
  1136. (format "#+INCLUDE: \"%s/examples/include.org::tbl\"" org-test-dir)
  1137. (org-export-expand-include-keyword)
  1138. (buffer-string))))
  1139. ;; Properties should be dropped, drawers should not be.
  1140. (should
  1141. (equal
  1142. ":LOGBOOK:\ndrawer\n:END:\ncontent\n"
  1143. (org-test-with-temp-text
  1144. (format "#+INCLUDE: \"%s/examples/include.org::#dh\" :only-contents t"
  1145. org-test-dir)
  1146. (org-export-expand-include-keyword)
  1147. (buffer-string))))
  1148. ;; Adjacent INCLUDE-keywords should have the same :minlevel if unspecified.
  1149. (should
  1150. (cl-every (lambda (level) (zerop (1- level)))
  1151. (org-test-with-temp-text
  1152. (concat
  1153. (format "#+INCLUDE: \"%s/examples/include.org::#ah\"\n"
  1154. org-test-dir)
  1155. (format "#+INCLUDE: \"%s/examples/include.org::*Heading\""
  1156. org-test-dir))
  1157. (org-export-expand-include-keyword)
  1158. (org-element-map (org-element-parse-buffer) 'headline
  1159. (lambda (head) (org-element-property :level head))))))
  1160. ;; INCLUDE does not insert induced :minlevel for src-blocks.
  1161. (should-not
  1162. (equal
  1163. (org-test-with-temp-text
  1164. (format "#+INCLUDE: \"%s/examples/include2.org\" src emacs-lisp"
  1165. org-test-dir)
  1166. (org-export-expand-include-keyword)
  1167. (buffer-string))
  1168. (org-test-with-temp-text
  1169. (format
  1170. "#+INCLUDE: \"%s/examples/include2.org\" src emacs-lisp :minlevel 1"
  1171. org-test-dir)
  1172. (org-export-expand-include-keyword)
  1173. (buffer-string))))
  1174. ;; INCLUDE assigns the relative :minlevel conditional on narrowing.
  1175. (should
  1176. (org-test-with-temp-text-in-file
  1177. (format "* h1\n<point>#+INCLUDE: \"%s/examples/include.org::#ah\""
  1178. org-test-dir)
  1179. (narrow-to-region (point) (point-max))
  1180. (org-export-expand-include-keyword)
  1181. (eq 1 (org-current-level))))
  1182. ;; If :minlevel is present do not alter it.
  1183. (should
  1184. (org-test-with-temp-text
  1185. (format
  1186. "* h1\n<point>#+INCLUDE: \"%s/examples/include.org::#ah\" :minlevel 3"
  1187. org-test-dir)
  1188. (narrow-to-region (point) (point-max))
  1189. (org-export-expand-include-keyword)
  1190. (eq 3 (org-current-level)))))
  1191. (ert-deftest test-org-export/expand-macro ()
  1192. "Test macro expansion in an Org buffer."
  1193. (require 'ox-org)
  1194. ;; Standard macro expansion.
  1195. (should
  1196. (equal "#+MACRO: macro1 value\nvalue\n"
  1197. (org-test-with-temp-text "#+MACRO: macro1 value\n{{{macro1}}}"
  1198. (org-export-as (org-test-default-backend)))))
  1199. ;; Allow macro in parsed keywords and associated properties.
  1200. ;; Standard macro expansion.
  1201. (should
  1202. (string-match
  1203. "#\\+K: value"
  1204. (let ((backend (org-export-create-backend
  1205. :parent 'org
  1206. :options '((:k "K" nil nil parse)))))
  1207. (org-test-with-temp-text "#+MACRO: macro value\n#+K: {{{macro}}}"
  1208. (org-export-as backend)))))
  1209. (should
  1210. (string-match
  1211. ":EXPORT_K: v"
  1212. (let ((backend (org-export-create-backend
  1213. :parent 'org
  1214. :options '((:k "K" nil nil parse)))))
  1215. (org-test-with-temp-text
  1216. "#+MACRO: m v\n* H\n:PROPERTIES:\n:EXPORT_K: {{{m}}}\n:END:"
  1217. (org-export-as backend nil nil nil '(:with-properties t))))))
  1218. ;; Expand specific macros.
  1219. (should
  1220. (equal "me 2012-03-29 me@here Title\n"
  1221. (org-test-with-temp-text
  1222. "
  1223. #+TITLE: Title
  1224. #+DATE: 2012-03-29
  1225. #+AUTHOR: me
  1226. #+EMAIL: me@here
  1227. {{{author}}} {{{date}}} {{{email}}} {{{title}}}"
  1228. (let ((output (org-export-as (org-test-default-backend))))
  1229. (substring output (string-match ".*\n\\'" output))))))
  1230. ;; Expand specific macros when property contained a regular macro
  1231. ;; already.
  1232. (should
  1233. (equal "value\n"
  1234. (org-test-with-temp-text "
  1235. #+MACRO: macro1 value
  1236. #+TITLE: {{{macro1}}}
  1237. {{{title}}}"
  1238. (let ((output (org-export-as (org-test-default-backend))))
  1239. (substring output (string-match ".*\n\\'" output))))))
  1240. ;; Expand macros with templates in included files.
  1241. (should
  1242. (equal "success\n"
  1243. (org-test-with-temp-text
  1244. (format "#+INCLUDE: \"%s/examples/macro-templates.org\"
  1245. {{{included-macro}}}" org-test-dir)
  1246. (let ((output (org-export-as (org-test-default-backend))))
  1247. (substring output (string-match ".*\n\\'" output))))))
  1248. ;; Date macro takes a optional formatting argument
  1249. (should
  1250. (equal "09-02-15\n"
  1251. (org-test-with-temp-text "{{{date(%d-%m-%y)}}}\n* d :noexport:\n#+DATE: <2015-02-09>"
  1252. (org-export-as (org-test-default-backend)))))
  1253. ;; Only single timestamps are formatted
  1254. (should
  1255. (equal "<2015-02x-09>\n"
  1256. (org-test-with-temp-text "{{{date(%d-%m-%y)}}}\n* d :noexport:\n#+DATE: <2015-02x-09>"
  1257. (org-export-as (org-test-default-backend)))))
  1258. ;; Throw an error when a macro definition is missing.
  1259. (should-error
  1260. (org-test-with-temp-text "{{{missing}}}"
  1261. (org-export-as (org-test-default-backend))))
  1262. ;; Macros defined in commented subtrees are ignored.
  1263. (should-error
  1264. (org-test-with-temp-text
  1265. "* COMMENT H\n#+MACRO: macro1\n* H2\nvalue\n{{{macro1}}}"
  1266. (org-export-as (org-test-default-backend))))
  1267. (should-error
  1268. (org-test-with-temp-text
  1269. "* COMMENT H\n** H2\n#+MACRO: macro1\n* H3\nvalue\n{{{macro1}}}"
  1270. (org-export-as (org-test-default-backend)))))
  1271. (ert-deftest test-org-export/before-processing-hook ()
  1272. "Test `org-export-before-processing-hook'."
  1273. (should
  1274. (equal
  1275. "#+MACRO: mac val\nTest\n"
  1276. (org-test-with-temp-text "#+MACRO: mac val\n{{{mac}}} Test"
  1277. (let ((org-export-before-processing-hook
  1278. '((lambda (backend)
  1279. (while (re-search-forward "{{{" nil t)
  1280. (let ((object (org-element-context)))
  1281. (when (eq (org-element-type object) 'macro)
  1282. (delete-region
  1283. (org-element-property :begin object)
  1284. (org-element-property :end object)))))))))
  1285. (org-export-as (org-test-default-backend)))))))
  1286. (ert-deftest test-org-export/before-parsing-hook ()
  1287. "Test `org-export-before-parsing-hook'."
  1288. (should
  1289. (equal "Body 1\nBody 2\n"
  1290. (org-test-with-temp-text "* Headline 1\nBody 1\n* Headline 2\nBody 2"
  1291. (let ((org-export-before-parsing-hook
  1292. '((lambda (backend)
  1293. (goto-char (point-min))
  1294. (while (re-search-forward org-outline-regexp-bol nil t)
  1295. (delete-region
  1296. (point-at-bol) (progn (forward-line) (point))))))))
  1297. (org-export-as (org-test-default-backend)))))))
  1298. ;;; Affiliated Keywords
  1299. (ert-deftest test-org-export/read-attribute ()
  1300. "Test `org-export-read-attribute' specifications."
  1301. ;; Standard test.
  1302. (should
  1303. (equal
  1304. (org-export-read-attribute
  1305. :attr_html
  1306. (org-test-with-temp-text "#+ATTR_HTML: :a 1 :b 2\nParagraph"
  1307. (org-element-at-point)))
  1308. '(:a "1" :b "2")))
  1309. ;; Return nil on empty attribute.
  1310. (should-not
  1311. (org-export-read-attribute
  1312. :attr_html
  1313. (org-test-with-temp-text "Paragraph" (org-element-at-point))))
  1314. ;; Return nil on "nil" string.
  1315. (should
  1316. (equal '(:a nil :b nil)
  1317. (org-export-read-attribute
  1318. :attr_html
  1319. (org-test-with-temp-text "#+ATTR_HTML: :a nil :b nil\nParagraph"
  1320. (org-element-at-point)))))
  1321. ;; Return nil on empty string.
  1322. (should
  1323. (equal '(:a nil :b nil)
  1324. (org-export-read-attribute
  1325. :attr_html
  1326. (org-test-with-temp-text "#+ATTR_HTML: :a :b\nParagraph"
  1327. (org-element-at-point)))))
  1328. ;; Return empty string when value is "".
  1329. (should
  1330. (equal '(:a "")
  1331. (org-export-read-attribute
  1332. :attr_html
  1333. (org-test-with-temp-text "#+ATTR_HTML: :a \"\"\nParagraph"
  1334. (org-element-at-point)))))
  1335. ;; Return \"\" when value is """".
  1336. (should
  1337. (equal '(:a "\"\"")
  1338. (org-export-read-attribute
  1339. :attr_html
  1340. (org-test-with-temp-text "#+ATTR_HTML: :a \"\"\"\"\nParagraph"
  1341. (org-element-at-point)))))
  1342. ;; Ignore text before first property.
  1343. (should-not
  1344. (member "ignore"
  1345. (org-export-read-attribute
  1346. :attr_html
  1347. (org-test-with-temp-text "#+ATTR_HTML: ignore :a 1\nParagraph"
  1348. (org-element-at-point))))))
  1349. (ert-deftest test-org-export/get-caption ()
  1350. "Test `org-export-get-caption' specifications."
  1351. ;; Without optional argument, return long caption
  1352. (should
  1353. (equal
  1354. '("l")
  1355. (org-test-with-temp-text "#+CAPTION[s]: l\nPara"
  1356. (org-export-get-caption (org-element-at-point)))))
  1357. ;; With optional argument, return short caption.
  1358. (should
  1359. (equal
  1360. '("s")
  1361. (org-test-with-temp-text "#+CAPTION[s]: l\nPara"
  1362. (org-export-get-caption (org-element-at-point) t))))
  1363. ;; Multiple lines are separated by white spaces.
  1364. (should
  1365. (equal
  1366. '("a" " " "b")
  1367. (org-test-with-temp-text "#+CAPTION: a\n#+CAPTION: b\nPara"
  1368. (org-export-get-caption (org-element-at-point))))))
  1369. ;;; Back-End Tools
  1370. (ert-deftest test-org-export/define-backend ()
  1371. "Test back-end definition and accessors."
  1372. ;; Translate table.
  1373. (should
  1374. (equal '((headline . my-headline-test))
  1375. (let (org-export-registered-backends)
  1376. (org-export-define-backend 'test '((headline . my-headline-test)))
  1377. (org-export-get-all-transcoders 'test))))
  1378. ;; Filters.
  1379. (should
  1380. (equal '((:filter-headline . my-filter))
  1381. (let (org-export-registered-backends)
  1382. (org-export-define-backend 'test
  1383. '((headline . my-headline-test))
  1384. :filters-alist '((:filter-headline . my-filter)))
  1385. (org-export-backend-filters (org-export-get-backend 'test)))))
  1386. ;; Options.
  1387. (should
  1388. (equal '((:prop value))
  1389. (let (org-export-registered-backends)
  1390. (org-export-define-backend 'test
  1391. '((headline . my-headline-test))
  1392. :options-alist '((:prop value)))
  1393. (org-export-backend-options (org-export-get-backend 'test)))))
  1394. ;; Menu.
  1395. (should
  1396. (equal '(?k "Test Export" test)
  1397. (let (org-export-registered-backends)
  1398. (org-export-define-backend 'test
  1399. '((headline . my-headline-test))
  1400. :menu-entry '(?k "Test Export" test))
  1401. (org-export-backend-menu (org-export-get-backend 'test))))))
  1402. (ert-deftest test-org-export/define-derived-backend ()
  1403. "Test `org-export-define-derived-backend' specifications."
  1404. ;; Error when parent back-end is not defined.
  1405. (should-error
  1406. (let (org-export-registered-backends)
  1407. (org-export-define-derived-backend 'test 'parent)))
  1408. ;; Append translation table to parent's.
  1409. (should
  1410. (equal '((:headline . test) (:headline . parent))
  1411. (let (org-export-registered-backends)
  1412. (org-export-define-backend 'parent '((:headline . parent)))
  1413. (org-export-define-derived-backend 'test 'parent
  1414. :translate-alist '((:headline . test)))
  1415. (org-export-get-all-transcoders 'test))))
  1416. ;; Options defined in the new back have priority over those defined
  1417. ;; in parent.
  1418. (should
  1419. (eq 'test
  1420. (let (org-export-registered-backends)
  1421. (org-export-define-backend 'parent
  1422. '((:headline . parent))
  1423. :options-alist '((:a nil nil 'parent)))
  1424. (org-export-define-derived-backend 'test 'parent
  1425. :options-alist '((:a nil nil 'test)))
  1426. (plist-get (org-export--get-global-options
  1427. (org-export-get-backend 'test))
  1428. :a)))))
  1429. (ert-deftest test-org-export/derived-backend-p ()
  1430. "Test `org-export-derived-backend-p' specifications."
  1431. ;; Non-nil with direct match.
  1432. (should
  1433. (let (org-export-registered-backends)
  1434. (org-export-define-backend 'test '((headline . test)))
  1435. (org-export-derived-backend-p 'test 'test)))
  1436. (should
  1437. (let (org-export-registered-backends)
  1438. (org-export-define-backend 'test '((headline . test)))
  1439. (org-export-define-derived-backend 'test2 'test)
  1440. (org-export-derived-backend-p 'test2 'test2)))
  1441. ;; Non-nil with a direct parent.
  1442. (should
  1443. (let (org-export-registered-backends)
  1444. (org-export-define-backend 'test '((headline . test)))
  1445. (org-export-define-derived-backend 'test2 'test)
  1446. (org-export-derived-backend-p 'test2 'test)))
  1447. ;; Non-nil with an indirect parent.
  1448. (should
  1449. (let (org-export-registered-backends)
  1450. (org-export-define-backend 'test '((headline . test)))
  1451. (org-export-define-derived-backend 'test2 'test)
  1452. (org-export-define-derived-backend 'test3 'test2)
  1453. (org-export-derived-backend-p 'test3 'test)))
  1454. ;; Nil otherwise.
  1455. (should-not
  1456. (let (org-export-registered-backends)
  1457. (org-export-define-backend 'test '((headline . test)))
  1458. (org-export-define-backend 'test2 '((headline . test2)))
  1459. (org-export-derived-backend-p 'test2 'test)))
  1460. (should-not
  1461. (let (org-export-registered-backends)
  1462. (org-export-define-backend 'test '((headline . test)))
  1463. (org-export-define-backend 'test2 '((headline . test2)))
  1464. (org-export-define-derived-backend 'test3 'test2)
  1465. (org-export-derived-backend-p 'test3 'test))))
  1466. (ert-deftest test-org-export/get-all-transcoders ()
  1467. "Test `org-export-get-all-transcoders' specifications."
  1468. ;; Return nil when back-end cannot be found.
  1469. (should-not (org-export-get-all-transcoders nil))
  1470. ;; Same as `org-export-transcoders' if no parent.
  1471. (should
  1472. (equal '((headline . ignore))
  1473. (org-export-get-all-transcoders
  1474. (org-export-create-backend
  1475. :transcoders '((headline . ignore))))))
  1476. ;; But inherit from all ancestors whenever possible.
  1477. (should
  1478. (equal '((section . ignore) (headline . ignore))
  1479. (let (org-export-registered-backends)
  1480. (org-export-define-backend 'b1 '((headline . ignore)))
  1481. (org-export-get-all-transcoders
  1482. (org-export-create-backend
  1483. :parent 'b1 :transcoders '((section . ignore)))))))
  1484. (should
  1485. (equal '((paragraph . ignore) (section . ignore) (headline . ignore))
  1486. (let (org-export-registered-backends)
  1487. (org-export-define-backend 'b1 '((headline . ignore)))
  1488. (org-export-define-derived-backend 'b2 'b1
  1489. :translate-alist '((section . ignore)))
  1490. (org-export-get-all-transcoders
  1491. (org-export-create-backend
  1492. :parent 'b2 :transcoders '((paragraph . ignore)))))))
  1493. ;; Back-end transcoders overrule inherited ones.
  1494. (should
  1495. (eq 'b
  1496. (let (org-export-registered-backends)
  1497. (org-export-define-backend 'b1 '((headline . a)))
  1498. (cdr (assq 'headline
  1499. (org-export-get-all-transcoders
  1500. (org-export-create-backend
  1501. :parent 'b1 :transcoders '((headline . b))))))))))
  1502. (ert-deftest test-org-export/get-all-options ()
  1503. "Test `org-export-get-all-options' specifications."
  1504. ;; Return nil when back-end cannot be found.
  1505. (should-not (org-export-get-all-options nil))
  1506. ;; Same as `org-export-options' if no parent.
  1507. (should
  1508. (equal '((headline . ignore))
  1509. (org-export-get-all-options
  1510. (org-export-create-backend
  1511. :options '((headline . ignore))))))
  1512. ;; But inherit from all ancestors whenever possible.
  1513. (should
  1514. (equal '((:key2 value2) (:key1 value1))
  1515. (let (org-export-registered-backends)
  1516. (org-export-define-backend 'b1 nil :options-alist '((:key1 value1)))
  1517. (org-export-get-all-options
  1518. (org-export-create-backend
  1519. :parent 'b1 :options '((:key2 value2)))))))
  1520. (should
  1521. (equal '((:key3 value3) (:key2 value2) (:key1 value1))
  1522. (let (org-export-registered-backends)
  1523. (org-export-define-backend 'b1 nil :options-alist '((:key1 value1)))
  1524. (org-export-define-derived-backend 'b2 'b1
  1525. :options-alist '((:key2 value2)))
  1526. (org-export-get-all-options
  1527. (org-export-create-backend
  1528. :parent 'b2 :options '((:key3 value3)))))))
  1529. ;; Back-end options overrule inherited ones.
  1530. (should
  1531. (eq 'b
  1532. (let (org-export-registered-backends)
  1533. (org-export-define-backend 'b1 nil :options-alist '((:key1 . a)))
  1534. (cdr (assq :key1
  1535. (org-export-get-all-options
  1536. (org-export-create-backend
  1537. :parent 'b1 :options '((:key1 . b))))))))))
  1538. (ert-deftest test-org-export/get-all-filters ()
  1539. "Test `org-export-get-all-filters' specifications."
  1540. ;; Return nil when back-end cannot be found.
  1541. (should-not (org-export-get-all-filters nil))
  1542. ;; Same as `org-export-filters' if no parent.
  1543. (should
  1544. (equal '((:filter-headline . ignore))
  1545. (org-export-get-all-filters
  1546. (org-export-create-backend
  1547. :filters '((:filter-headline . ignore))))))
  1548. ;; But inherit from all ancestors whenever possible.
  1549. (should
  1550. (equal '((:filter-section . ignore) (:filter-headline . ignore))
  1551. (let (org-export-registered-backends)
  1552. (org-export-define-backend 'b1
  1553. nil :filters-alist '((:filter-headline . ignore)))
  1554. (org-export-get-all-filters
  1555. (org-export-create-backend
  1556. :parent 'b1 :filters '((:filter-section . ignore)))))))
  1557. (should
  1558. (equal '((:filter-paragraph . ignore)
  1559. (:filter-section . ignore)
  1560. (:filter-headline . ignore))
  1561. (let (org-export-registered-backends)
  1562. (org-export-define-backend 'b1
  1563. nil :filters-alist '((:filter-headline . ignore)))
  1564. (org-export-define-derived-backend 'b2 'b1
  1565. :filters-alist '((:filter-section . ignore)))
  1566. (org-export-get-all-filters
  1567. (org-export-create-backend
  1568. :parent 'b2 :filters '((:filter-paragraph . ignore)))))))
  1569. ;; Back-end filters overrule inherited ones.
  1570. (should
  1571. (eq 'b
  1572. (let (org-export-registered-backends)
  1573. (org-export-define-backend 'b1 '((:filter-headline . a)))
  1574. (cdr (assq :filter-headline
  1575. (org-export-get-all-filters
  1576. (org-export-create-backend
  1577. :parent 'b1 :filters '((:filter-headline . b))))))))))
  1578. (ert-deftest test-org-export/with-backend ()
  1579. "Test `org-export-with-backend' definition."
  1580. ;; Error when calling an undefined back-end
  1581. (should-error (org-export-with-backend nil "Test"))
  1582. ;; Error when called back-end doesn't have an appropriate
  1583. ;; transcoder.
  1584. (should-error
  1585. (org-export-with-backend
  1586. (org-export-create-backend :transcoders '((headline . ignore)))
  1587. "Test"))
  1588. ;; Otherwise, export using correct transcoder
  1589. (should
  1590. (equal "Success"
  1591. (let (org-export-registered-backends)
  1592. (org-export-define-backend 'test
  1593. '((plain-text . (lambda (text contents info) "Failure"))))
  1594. (org-export-define-backend 'test2
  1595. '((plain-text . (lambda (text contents info) "Success"))))
  1596. (org-export-with-backend 'test2 "Test"))))
  1597. ;; Provide correct back-end if transcoder needs to use recursive
  1598. ;; calls anyway.
  1599. (should
  1600. (equal "Success\n"
  1601. (let ((test-back-end
  1602. (org-export-create-backend
  1603. :transcoders
  1604. (list (cons 'headline
  1605. (lambda (headline contents info)
  1606. (org-export-data
  1607. (org-element-property :title headline)
  1608. info)))
  1609. (cons 'plain-text (lambda (text info) "Success"))))))
  1610. (org-export-string-as
  1611. "* Test"
  1612. (org-export-create-backend
  1613. :transcoders
  1614. (list (cons 'headline
  1615. (lambda (headline contents info)
  1616. (org-export-with-backend
  1617. test-back-end headline contents info))))))))))
  1618. (ert-deftest test-org-export/data-with-backend ()
  1619. "Test `org-export-data-with-backend' specifications."
  1620. ;; Error when calling an undefined back-end.
  1621. (should-error (org-export-data-with-backend nil "nil" nil))
  1622. ;; Otherwise, export data recursively, using correct back-end.
  1623. (should
  1624. (equal
  1625. "Success!"
  1626. (org-export-data-with-backend
  1627. '(bold nil "Test")
  1628. (org-export-create-backend
  1629. :transcoders
  1630. '((plain-text . (lambda (text info) "Success"))
  1631. (bold . (lambda (bold contents info) (concat contents "!")))))
  1632. '(:with-emphasize t)))))
  1633. ;;; Comments
  1634. (ert-deftest test-org-export/comments ()
  1635. "Test comments handling during export.
  1636. In particular, structure of the document mustn't be altered after
  1637. comments removal."
  1638. (should
  1639. (equal (org-test-with-temp-text "
  1640. Para1
  1641. # Comment
  1642. # Comment
  1643. Para2"
  1644. (org-export-as (org-test-default-backend)))
  1645. "Para1\n\nPara2\n"))
  1646. (should
  1647. (equal (org-test-with-temp-text "
  1648. Para1
  1649. # Comment
  1650. Para2"
  1651. (org-export-as (org-test-default-backend)))
  1652. "Para1\n\nPara2\n"))
  1653. (should
  1654. (equal (org-test-with-temp-text "
  1655. \[fn:1] Para1
  1656. # Inside definition
  1657. # Outside definition
  1658. Para2"
  1659. (org-export-as (org-test-default-backend)))
  1660. "[fn:1] Para1\n\n\nPara2\n"))
  1661. (should
  1662. (equal (org-test-with-temp-text "
  1663. \[fn:1] Para1
  1664. # Inside definition
  1665. # Inside definition
  1666. Para2"
  1667. (org-export-as (org-test-default-backend)))
  1668. "[fn:1] Para1\n\nPara2\n"))
  1669. (should
  1670. (equal (org-test-with-temp-text "
  1671. \[fn:1] Para1
  1672. # Inside definition
  1673. Para2"
  1674. (org-export-as (org-test-default-backend)))
  1675. "[fn:1] Para1\n\nPara2\n"))
  1676. (should
  1677. (equal (org-test-with-temp-text "
  1678. \[fn:1] Para1
  1679. # Inside definition
  1680. Para2"
  1681. (org-export-as (org-test-default-backend)))
  1682. "[fn:1] Para1\n\nPara2\n")))
  1683. ;;; Export blocks
  1684. (ert-deftest test-org-export/export-block ()
  1685. "Test export blocks transcoding."
  1686. (should
  1687. (equal "Success!\n"
  1688. (org-test-with-temp-text
  1689. "#+BEGIN_EXPORT backend\nSuccess!\n#+END_EXPORT"
  1690. (org-export-as
  1691. (org-export-create-backend
  1692. :transcoders '((export-block . (lambda (b _c _i)
  1693. (org-element-property :value b)))
  1694. (section . (lambda (_s c _i) c))))))))
  1695. (should
  1696. (equal "Success!\n"
  1697. (org-test-with-temp-text
  1698. "#+BEGIN_EXPORT backend\nSuccess!\n#+END_EXPORT"
  1699. (org-export-as
  1700. (org-export-create-backend
  1701. :transcoders
  1702. (list
  1703. (cons 'export-block
  1704. (lambda (b _c _i)
  1705. (and (equal (org-element-property :type b) "BACKEND")
  1706. (org-element-property :value b))))
  1707. (cons 'section (lambda (_s c _i) c)))))))))
  1708. ;;; Export Snippets
  1709. (ert-deftest test-org-export/export-snippet ()
  1710. "Test export snippets transcoding."
  1711. ;; Standard test.
  1712. (org-test-with-temp-text "@@test:A@@@@t:B@@"
  1713. (let ((backend (org-test-default-backend)))
  1714. (setf (org-export-backend-name backend) 'test)
  1715. (setf (org-export-backend-transcoders backend)
  1716. (cons (cons 'export-snippet
  1717. (lambda (snippet contents info)
  1718. (when (eq (org-export-snippet-backend snippet) 'test)
  1719. (org-element-property :value snippet))))
  1720. (org-export-backend-transcoders backend)))
  1721. (let ((org-export-snippet-translation-alist nil))
  1722. (should (equal (org-export-as backend) "A\n")))
  1723. (let ((org-export-snippet-translation-alist '(("t" . "test"))))
  1724. (should (equal (org-export-as backend) "AB\n")))))
  1725. ;; Ignored export snippets do not remove any blank.
  1726. (should
  1727. (equal "begin end\n"
  1728. (org-test-with-parsed-data "begin @@test:A@@ end"
  1729. (org-export-data-with-backend
  1730. tree
  1731. (org-export-create-backend
  1732. :transcoders
  1733. '((paragraph . (lambda (paragraph contents info) contents))
  1734. (section . (lambda (section contents info) contents))))
  1735. info)))))
  1736. ;;; Footnotes
  1737. (ert-deftest test-org-export/footnote-first-reference-p ()
  1738. "Test `org-export-footnote-first-reference-p' specifications."
  1739. (should
  1740. (equal
  1741. '(t nil)
  1742. (org-test-with-temp-text "Text[fn:1][fn:1]\n\n[fn:1] Definition"
  1743. (let (result)
  1744. (org-export-as
  1745. (org-export-create-backend
  1746. :transcoders
  1747. `(,(cons 'footnote-reference
  1748. (lambda (f c i)
  1749. (push (org-export-footnote-first-reference-p f i)
  1750. result)
  1751. ""))
  1752. (section . (lambda (s c i) c))
  1753. (paragraph . (lambda (p c i) c))))
  1754. nil nil nil '(:with-footnotes t))
  1755. (nreverse result)))))
  1756. ;; Limit check to DATA, when non-nil.
  1757. (should
  1758. (equal
  1759. '(nil t)
  1760. (org-test-with-parsed-data "Text[fn:1]\n* H\nText[fn:1]\n\n[fn:1] D1"
  1761. (let (result)
  1762. (org-element-map tree 'footnote-reference
  1763. (lambda (ref)
  1764. (push
  1765. (org-export-footnote-first-reference-p
  1766. ref info (org-element-map tree 'headline #'identity info t))
  1767. result))
  1768. info)
  1769. (nreverse result)))))
  1770. (should
  1771. (equal
  1772. '(t nil)
  1773. (org-test-with-parsed-data "Text[fn:1]\n* H\nText[fn:1]\n\n[fn:1] D1"
  1774. (let (result)
  1775. (org-element-map tree 'footnote-reference
  1776. (lambda (ref)
  1777. (push (org-export-footnote-first-reference-p ref info) result))
  1778. info)
  1779. (nreverse result)))))
  1780. ;; If optional argument BODY-FIRST is non-nil, first find footnote
  1781. ;; in the main body of the document. Otherwise, enter footnote
  1782. ;; definitions when they are encountered.
  1783. (should
  1784. (equal
  1785. '(t nil)
  1786. (org-test-with-temp-text
  1787. ":BODY:\nText[fn:1][fn:2]\n:END:\n\n[fn:1] Definition[fn:2]\n\n[fn:2] Inner"
  1788. (let (result)
  1789. (org-export-as
  1790. (org-export-create-backend
  1791. :transcoders
  1792. `(,(cons 'footnote-reference
  1793. (lambda (f c i)
  1794. (when (org-element-lineage f '(drawer))
  1795. (push (org-export-footnote-first-reference-p f i nil)
  1796. result))
  1797. ""))
  1798. (drawer . (lambda (d c i) c))
  1799. (footnote-definition . (lambda (d c i) c))
  1800. (section . (lambda (s c i) c))
  1801. (paragraph . (lambda (p c i) c))))
  1802. nil nil nil '(:with-footnotes t))
  1803. (nreverse result)))))
  1804. (should
  1805. (equal
  1806. '(t t)
  1807. (org-test-with-temp-text
  1808. ":BODY:\nText[fn:1][fn:2]\n:END:\n\n[fn:1] Definition[fn:2]\n\n[fn:2] Inner"
  1809. (let (result)
  1810. (org-export-as
  1811. (org-export-create-backend
  1812. :transcoders
  1813. `(,(cons 'footnote-reference
  1814. (lambda (f c i)
  1815. (when (org-element-lineage f '(drawer))
  1816. (push (org-export-footnote-first-reference-p f i nil t)
  1817. result))
  1818. ""))
  1819. (drawer . (lambda (d c i) c))
  1820. (footnote-definition . (lambda (d c i) c))
  1821. (section . (lambda (s c i) c))
  1822. (paragraph . (lambda (p c i) c))))
  1823. nil nil nil '(:with-footnotes t))
  1824. (nreverse result))))))
  1825. (ert-deftest test-org-export/get-footnote-number ()
  1826. "Test `org-export-get-footnote-number' specifications."
  1827. (should
  1828. (equal '(1 2 1)
  1829. (org-test-with-parsed-data
  1830. "Text[fn:1][fn:2][fn:1]\n\n[fn:1] Def\n[fn:2] Def"
  1831. (org-element-map tree 'footnote-reference
  1832. (lambda (ref) (org-export-get-footnote-number ref info))
  1833. info))))
  1834. ;; Anonymous footnotes all get a new number.
  1835. (should
  1836. (equal '(1 2)
  1837. (org-test-with-parsed-data
  1838. "Text[fn::anon1][fn::anon2]"
  1839. (org-element-map tree 'footnote-reference
  1840. (lambda (ref) (org-export-get-footnote-number ref info))
  1841. info))))
  1842. ;; Test nested footnotes order.
  1843. (should
  1844. (equal
  1845. '((1 . "1") (2 . "2") (3 . "3") (3 . "3") (4))
  1846. (org-test-with-parsed-data
  1847. "Text[fn:1:A[fn:2]] [fn:3].\n\n[fn:2] B [fn:3] [fn::D].\n\n[fn:3] C."
  1848. (org-element-map tree 'footnote-reference
  1849. (lambda (ref)
  1850. (cons (org-export-get-footnote-number ref info)
  1851. (org-element-property :label ref)))
  1852. info))))
  1853. ;; Limit number to provided DATA, when non-nil.
  1854. (should
  1855. (equal
  1856. '(1)
  1857. (org-test-with-parsed-data
  1858. "Text[fn:1]\n* H\nText[fn:2]\n\n[fn:1] D1\n[fn:2] D2"
  1859. (org-element-map tree 'footnote-reference
  1860. (lambda (ref)
  1861. (org-export-get-footnote-number
  1862. ref info (org-element-map tree 'headline #'identity info t)))
  1863. info))))
  1864. (should
  1865. (equal
  1866. '(1 2)
  1867. (org-test-with-parsed-data
  1868. "Text[fn:1]\n* H\nText[fn:2]\n\n[fn:1] D1\n[fn:2]"
  1869. (org-element-map tree 'footnote-reference
  1870. (lambda (ref) (org-export-get-footnote-number ref info))
  1871. info))))
  1872. ;; With a non-nil BODY-FIRST optional argument, first check body,
  1873. ;; then footnote definitions.
  1874. (should
  1875. (equal
  1876. '(("1" . 1) ("2" . 2) ("3" . 3) ("3" . 3))
  1877. (org-test-with-parsed-data
  1878. "Text[fn:1][fn:2][fn:3]\n\n[fn:1] Def[fn:3]\n[fn:2] Def\n[fn:3] Def"
  1879. (org-element-map tree 'footnote-reference
  1880. (lambda (ref)
  1881. (cons (org-element-property :label ref)
  1882. (org-export-get-footnote-number ref info nil t)))
  1883. info))))
  1884. (should
  1885. (equal
  1886. '(("1" . 1) ("2" . 3) ("3" . 2) ("3" . 2))
  1887. (org-test-with-parsed-data
  1888. "Text[fn:1][fn:2][fn:3]\n\n[fn:1] Def[fn:3]\n[fn:2] Def\n[fn:3] Def"
  1889. (org-element-map tree 'footnote-reference
  1890. (lambda (ref)
  1891. (cons (org-element-property :label ref)
  1892. (org-export-get-footnote-number ref info nil)))
  1893. info)))))
  1894. (ert-deftest test-org-export/collect-footnote-definitions ()
  1895. "Test `org-export-collect-footnote-definitions' specifications."
  1896. (should
  1897. (= 4
  1898. (org-test-with-parsed-data "Text[fn:1:A[fn:2]] [fn:3].
  1899. \[fn:2] B [fn:3] [fn::D].
  1900. \[fn:3] C."
  1901. (length (org-export-collect-footnote-definitions info)))))
  1902. ;; Limit number to provided DATA, when non-nil.
  1903. (should
  1904. (equal
  1905. '((1 "2"))
  1906. (org-test-with-parsed-data
  1907. "Text[fn:1]\n* H\nText[fn:2]\n\n[fn:1] D1\n[fn:2] D2"
  1908. (mapcar #'butlast
  1909. (org-export-collect-footnote-definitions
  1910. info (org-element-map tree 'headline #'identity info t))))))
  1911. (should
  1912. (equal
  1913. '((1 "1") (2 "2"))
  1914. (org-test-with-parsed-data
  1915. "Text[fn:1]\n* H\nText[fn:2]\n\n[fn:1] D1\n[fn:2] D2"
  1916. (mapcar #'butlast (org-export-collect-footnote-definitions info)))))
  1917. ;; With optional argument BODY-FIRST, first check body, then
  1918. ;; footnote definitions.
  1919. (should
  1920. (equal '("1" "3" "2" nil)
  1921. (org-test-with-parsed-data "Text[fn:1:A[fn:2]] [fn:3].
  1922. \[fn:2] B [fn:3] [fn::D].
  1923. \[fn:3] C."
  1924. (mapcar (lambda (e) (nth 1 e))
  1925. (org-export-collect-footnote-definitions info nil t)))))
  1926. (should-not
  1927. (equal '("1" "3" "2" nil)
  1928. (org-test-with-parsed-data "Text[fn:1:A[fn:2]] [fn:3].
  1929. \[fn:2] B [fn:3] [fn::D].
  1930. \[fn:3] C."
  1931. (mapcar (lambda (e) (nth 1 e))
  1932. (org-export-collect-footnote-definitions info))))))
  1933. (ert-deftest test-org-export/footnotes ()
  1934. "Miscellaneous tests on footnotes."
  1935. (let ((org-footnote-section nil)
  1936. (org-export-with-footnotes t))
  1937. ;; Read every type of footnote.
  1938. (should
  1939. (equal
  1940. '((1 . "A\n") (2 . "C") (3 . "D"))
  1941. (org-test-with-parsed-data
  1942. "Text[fn:1] [fn:label:C] [fn::D]\n\n[fn:1] A\n"
  1943. (org-element-map tree 'footnote-reference
  1944. (lambda (ref)
  1945. (let ((def (org-export-get-footnote-definition ref info)))
  1946. (cons (org-export-get-footnote-number ref info)
  1947. (if (eq (org-element-property :type ref) 'inline) (car def)
  1948. (car (org-element-contents
  1949. (car (org-element-contents def))))))))
  1950. info))))
  1951. ;; Test nested footnote in invisible definitions.
  1952. (should
  1953. (= 2
  1954. (org-test-with-temp-text "Text[fn:1]\n\n[fn:1] B [fn:2]\n\n[fn:2] C."
  1955. (narrow-to-region (point) (line-end-position))
  1956. (catch 'exit
  1957. (org-export-as
  1958. (org-export-create-backend
  1959. :transcoders
  1960. '((section
  1961. .
  1962. (lambda (s c i)
  1963. (throw 'exit (length
  1964. (org-export-collect-footnote-definitions
  1965. i))))))))))))
  1966. ;; Test export of footnotes defined outside parsing scope.
  1967. (should
  1968. (equal
  1969. "ParagraphOut of scope\n"
  1970. (org-test-with-temp-text "[fn:1] Out of scope
  1971. * Title
  1972. <point>Paragraph[fn:1]"
  1973. (let ((backend (org-test-default-backend)))
  1974. (setf (org-export-backend-transcoders backend)
  1975. (append
  1976. (list (cons 'footnote-reference
  1977. (lambda (fn contents info)
  1978. (org-element-interpret-data
  1979. (org-export-get-footnote-definition fn info))))
  1980. (cons 'footnote-definition #'ignore)
  1981. (cons 'headline #'ignore))
  1982. (org-export-backend-transcoders backend)))
  1983. (org-export-as backend 'subtree)))))
  1984. ;; Footnotes without a definition should throw an error.
  1985. (should-error
  1986. (org-test-with-parsed-data "Text[fn:1]"
  1987. (org-export-get-footnote-definition
  1988. (org-element-map tree 'footnote-reference #'identity info t) info)))
  1989. ;; Footnote section should be ignored in TOC and in headlines
  1990. ;; numbering.
  1991. (should
  1992. (= 1 (let ((org-footnote-section "Footnotes"))
  1993. (length (org-test-with-parsed-data "* H1\n* Footnotes\n"
  1994. (org-export-collect-headlines info))))))
  1995. (should
  1996. (equal '(2)
  1997. (let ((org-footnote-section "Footnotes"))
  1998. (org-test-with-parsed-data "* H1\n* Footnotes\n* H2"
  1999. (org-element-map tree 'headline
  2000. (lambda (hl)
  2001. (when (equal (org-element-property :raw-value hl) "H2")
  2002. (org-export-get-headline-number hl info)))
  2003. info t)))))))
  2004. ;;; Headlines and Inlinetasks
  2005. (ert-deftest test-org-export/get-relative-level ()
  2006. "Test `org-export-get-relative-level' specifications."
  2007. ;; Standard test.
  2008. (should
  2009. (equal '(1 2)
  2010. (let ((org-odd-levels-only nil))
  2011. (org-test-with-parsed-data "* Headline 1\n** Headline 2"
  2012. (org-element-map tree 'headline
  2013. (lambda (h) (org-export-get-relative-level h info))
  2014. info)))))
  2015. ;; Missing levels
  2016. (should
  2017. (equal '(1 3)
  2018. (let ((org-odd-levels-only nil))
  2019. (org-test-with-parsed-data "** Headline 1\n**** Headline 2"
  2020. (org-element-map tree 'headline
  2021. (lambda (h) (org-export-get-relative-level h info))
  2022. info))))))
  2023. (ert-deftest test-org-export/low-level-p ()
  2024. "Test `org-export-low-level-p' specifications."
  2025. (should
  2026. (equal
  2027. '(no yes)
  2028. (let ((org-odd-levels-only nil))
  2029. (org-test-with-parsed-data "* Headline 1\n** Headline 2"
  2030. (org-element-map tree 'headline
  2031. (lambda (h) (if (org-export-low-level-p h info) 'yes 'no))
  2032. (plist-put info :headline-levels 1)))))))
  2033. (ert-deftest test-org-export/get-headline-number ()
  2034. "Test `org-export-get-headline-number' specifications."
  2035. ;; Standard test.
  2036. (should
  2037. (equal
  2038. '((1) (1 1))
  2039. (let ((org-odd-levels-only nil))
  2040. (org-test-with-parsed-data "* Headline 1\n** Headline 2"
  2041. (org-element-map tree 'headline
  2042. (lambda (h) (org-export-get-headline-number h info))
  2043. info)))))
  2044. ;; Missing levels are replaced with 0.
  2045. (should
  2046. (equal
  2047. '((1) (1 0 1))
  2048. (let ((org-odd-levels-only nil))
  2049. (org-test-with-parsed-data "* Headline 1\n*** Headline 2"
  2050. (org-element-map tree 'headline
  2051. (lambda (h) (org-export-get-headline-number h info))
  2052. info))))))
  2053. (ert-deftest test-org-export/numbered-headline-p ()
  2054. "Test `org-export-numbered-headline-p' specifications."
  2055. ;; If `:section-numbers' is nil, never number headlines.
  2056. (should-not
  2057. (org-test-with-parsed-data "* Headline"
  2058. (org-element-map tree 'headline
  2059. (lambda (h) (org-export-numbered-headline-p h info))
  2060. (plist-put info :section-numbers nil))))
  2061. ;; If `:section-numbers' is a number, only number headlines with
  2062. ;; a level greater that it.
  2063. (should
  2064. (equal
  2065. '(yes no)
  2066. (org-test-with-parsed-data "* Headline 1\n** Headline 2"
  2067. (org-element-map tree 'headline
  2068. (lambda (h) (if (org-export-numbered-headline-p h info) 'yes 'no))
  2069. (plist-put info :section-numbers 1)))))
  2070. ;; Otherwise, headlines are always numbered.
  2071. (should
  2072. (org-test-with-parsed-data "* Headline"
  2073. (org-element-map tree 'headline
  2074. (lambda (h) (org-export-numbered-headline-p h info))
  2075. (plist-put info :section-numbers t))))
  2076. ;; With #+OPTIONS: num:nil all headlines are unnumbered.
  2077. (should-not
  2078. (org-test-with-parsed-data "* H\n#+OPTIONS: num:nil"
  2079. (org-export-numbered-headline-p
  2080. (org-element-map tree 'headline 'identity info t)
  2081. info)))
  2082. ;; Headlines with a non-nil UNNUMBERED property are not numbered.
  2083. (should-not
  2084. (org-test-with-parsed-data "* H\n:PROPERTIES:\n:UNNUMBERED: t\n:END:"
  2085. (org-export-numbered-headline-p
  2086. (org-element-map tree 'headline #'identity info t)
  2087. info)))
  2088. ;; UNNUMBERED ignores inheritance. Any non-nil value among
  2089. ;; ancestors disables numbering.
  2090. (should
  2091. (org-test-with-parsed-data
  2092. "* H
  2093. :PROPERTIES:
  2094. :UNNUMBERED: t
  2095. :END:
  2096. ** H2
  2097. :PROPERTIES:
  2098. :UNNUMBERED: nil
  2099. :END:
  2100. *** H3"
  2101. (cl-every
  2102. (lambda (h) (not (org-export-numbered-headline-p h info)))
  2103. (org-element-map tree 'headline #'identity info)))))
  2104. (ert-deftest test-org-export/number-to-roman ()
  2105. "Test `org-export-number-to-roman' specifications."
  2106. ;; If number is negative, return it as a string.
  2107. (should (equal (org-export-number-to-roman -1) "-1"))
  2108. ;; Otherwise, return it as a roman number.
  2109. (should (equal (org-export-number-to-roman 1449) "MCDXLIX")))
  2110. (ert-deftest test-org-export/get-optional-title ()
  2111. "Test `org-export-get-alt-title' specifications."
  2112. ;; If ALT_TITLE property is defined, use it.
  2113. (should
  2114. (equal '("opt")
  2115. (org-test-with-parsed-data
  2116. "* Headline\n:PROPERTIES:\n:ALT_TITLE: opt\n:END:"
  2117. (org-export-get-alt-title
  2118. (org-element-map tree 'headline 'identity info t)
  2119. info))))
  2120. ;; Otherwise, fall-back to regular title.
  2121. (should
  2122. (equal '("Headline")
  2123. (org-test-with-parsed-data "* Headline"
  2124. (org-export-get-alt-title
  2125. (org-element-map tree 'headline 'identity info t)
  2126. info)))))
  2127. (ert-deftest test-org-export/get-tags ()
  2128. "Test `org-export-get-tags' specifications."
  2129. ;; Standard test: tags which are not a select tag, an exclude tag,
  2130. ;; or specified as optional argument shouldn't be ignored.
  2131. (should
  2132. (org-test-with-parsed-data "* Headline :tag:"
  2133. (org-export-get-tags (org-element-map tree 'headline 'identity info t)
  2134. info)))
  2135. ;; Tags provided in the optional argument are ignored.
  2136. (should-not
  2137. (org-test-with-parsed-data "* Headline :ignore:"
  2138. (org-export-get-tags (org-element-map tree 'headline 'identity info t)
  2139. info '("ignore"))))
  2140. ;; Allow tag inheritance.
  2141. (should
  2142. (equal
  2143. '(("tag") ("tag"))
  2144. (org-test-with-parsed-data "* Headline :tag:\n** Sub-heading"
  2145. (org-element-map tree 'headline
  2146. (lambda (hl) (org-export-get-tags hl info nil t)) info))))
  2147. ;; Tag inheritance checks FILETAGS keywords.
  2148. (should
  2149. (equal
  2150. '(("a" "b" "tag"))
  2151. (org-test-with-parsed-data "#+FILETAGS: :a:b:\n* Headline :tag:"
  2152. (org-element-map tree 'headline
  2153. (lambda (hl) (org-export-get-tags hl info nil t)) info)))))
  2154. (ert-deftest test-org-export/get-node-property ()
  2155. "Test`org-export-get-node-property' specifications."
  2156. ;; Standard test.
  2157. (should
  2158. (equal "value"
  2159. (org-test-with-parsed-data "* Headline
  2160. :PROPERTIES:
  2161. :prop: value
  2162. :END:"
  2163. (org-export-get-node-property
  2164. :PROP (org-element-map tree 'headline 'identity nil t)))))
  2165. ;; Test inheritance.
  2166. (should
  2167. (equal "value"
  2168. (org-test-with-parsed-data "* Parent
  2169. :PROPERTIES:
  2170. :prop: value
  2171. :END:
  2172. ** Headline
  2173. Paragraph"
  2174. (org-export-get-node-property
  2175. :PROP (org-element-map tree 'paragraph 'identity nil t) t))))
  2176. ;; Cannot return a value before the first headline.
  2177. (should-not
  2178. (org-test-with-parsed-data "Paragraph
  2179. * Headline
  2180. :PROPERTIES:
  2181. :prop: value
  2182. :END:"
  2183. (org-export-get-node-property
  2184. :PROP (org-element-map tree 'paragraph 'identity nil t)))))
  2185. (ert-deftest test-org-export/get-category ()
  2186. "Test `org-export-get-category' specifications."
  2187. ;; Standard test.
  2188. (should
  2189. (equal "value"
  2190. (org-test-with-parsed-data "* Headline
  2191. :PROPERTIES:
  2192. :CATEGORY: value
  2193. :END:"
  2194. (org-export-get-category
  2195. (org-element-map tree 'headline 'identity nil t) info))))
  2196. ;; Test inheritance from a parent headline.
  2197. (should
  2198. (equal '("value" "value")
  2199. (org-test-with-parsed-data "* Headline1
  2200. :PROPERTIES:
  2201. :CATEGORY: value
  2202. :END:
  2203. ** Headline2"
  2204. (org-element-map tree 'headline
  2205. (lambda (hl) (org-export-get-category hl info)) info))))
  2206. ;; Test inheritance from #+CATEGORY keyword
  2207. (should
  2208. (equal "value"
  2209. (org-test-with-parsed-data "#+CATEGORY: value
  2210. * Headline"
  2211. (org-export-get-category
  2212. (org-element-map tree 'headline 'identity nil t) info))))
  2213. ;; Test inheritance from file name.
  2214. (should
  2215. (equal "test"
  2216. (org-test-with-parsed-data "* Headline"
  2217. (let ((info (plist-put info :input-file "~/test.org")))
  2218. (org-export-get-category
  2219. (org-element-map tree 'headline 'identity nil t) info)))))
  2220. ;; Fall-back value.
  2221. (should
  2222. (equal "???"
  2223. (org-test-with-parsed-data "* Headline"
  2224. (org-export-get-category
  2225. (org-element-map tree 'headline 'identity nil t) info)))))
  2226. (ert-deftest test-org-export/first-sibling-p ()
  2227. "Test `org-export-first-sibling-p' specifications."
  2228. ;; Standard test.
  2229. (should
  2230. (equal
  2231. '(yes yes no)
  2232. (org-test-with-parsed-data "* H\n** H 2\n** H 3"
  2233. (org-element-map tree 'headline
  2234. (lambda (h) (if (org-export-first-sibling-p h info) 'yes 'no))
  2235. info))))
  2236. (should
  2237. (equal '(yes no)
  2238. (org-test-with-parsed-data "- item\n\n para"
  2239. (org-element-map tree 'paragraph
  2240. (lambda (h) (if (org-export-first-sibling-p h info) 'yes 'no))
  2241. info))))
  2242. ;; Ignore sections for headlines.
  2243. (should
  2244. (equal '(yes yes)
  2245. (org-test-with-parsed-data "* H\nSection\n** H 2"
  2246. (org-element-map tree 'headline
  2247. (lambda (h) (if (org-export-first-sibling-p h info) 'yes 'no))
  2248. info))))
  2249. ;; Ignore headlines not exported.
  2250. (should
  2251. (equal
  2252. '(yes)
  2253. (let ((org-export-exclude-tags '("ignore")))
  2254. (org-test-with-parsed-data "* Headline :ignore:\n* Headline 2"
  2255. (org-element-map tree 'headline
  2256. (lambda (h) (if (org-export-first-sibling-p h info) 'yes 'no))
  2257. info))))))
  2258. (ert-deftest test-org-export/last-sibling-p ()
  2259. "Test `org-export-last-sibling-p' specifications."
  2260. ;; Standard test.
  2261. (should
  2262. (equal
  2263. '(yes no yes)
  2264. (org-test-with-parsed-data "* Headline\n** Headline 2\n** Headline 3"
  2265. (org-element-map tree 'headline
  2266. (lambda (h) (if (org-export-last-sibling-p h info) 'yes 'no))
  2267. info))))
  2268. (should
  2269. (equal '(no yes)
  2270. (org-test-with-parsed-data "- item\n\n para"
  2271. (org-element-map tree 'paragraph
  2272. (lambda (h) (if (org-export-last-sibling-p h info) 'yes 'no))
  2273. info))))
  2274. ;; Ignore headlines not exported.
  2275. (should
  2276. (equal
  2277. '(yes)
  2278. (let ((org-export-exclude-tags '("ignore")))
  2279. (org-test-with-parsed-data "* Headline\n* Headline 2 :ignore:"
  2280. (org-element-map tree 'headline
  2281. (lambda (h) (if (org-export-last-sibling-p h info) 'yes 'no))
  2282. info))))))
  2283. (ert-deftest test-org-export/handle-inlinetasks ()
  2284. "Test inlinetask export."
  2285. ;; Inlinetask with an exclude tag.
  2286. (when (featurep 'org-inlinetask)
  2287. (should
  2288. (equal
  2289. ""
  2290. (let ((org-inlinetask-min-level 3)
  2291. org-export-filter-body-functions
  2292. org-export-filter-final-output-functions)
  2293. (org-test-with-temp-text "*** Inlinetask :noexp:\nContents\n*** end"
  2294. (org-export-as (org-test-default-backend)
  2295. nil nil nil '(:exclude-tags ("noexp")))))))
  2296. ;; Inlinetask with an include tag.
  2297. (should
  2298. (equal
  2299. "* H2\n*** Inline :exp:\n"
  2300. (let ((org-inlinetask-min-level 3)
  2301. (org-tags-column 0))
  2302. (org-test-with-temp-text "* H1\n* H2\n*** Inline :exp:"
  2303. (org-export-as (org-test-default-backend)
  2304. nil nil nil '(:select-tags ("exp")))))))
  2305. ;; Ignore inlinetask with a TODO keyword and tasks excluded.
  2306. (should
  2307. (equal ""
  2308. (let ((org-todo-keywords '((sequence "TODO" "DONE")))
  2309. (org-inlinetask-min-level 3)
  2310. org-export-filter-body-functions
  2311. org-export-filter-final-output-functions)
  2312. (org-test-with-temp-text "*** TODO Inline"
  2313. (org-export-as (org-test-default-backend)
  2314. nil nil nil '(:with-tasks nil))))))))
  2315. ;;; Keywords
  2316. (ert-deftest test-org-export/get-date ()
  2317. "Test `org-export-get-date' specifications."
  2318. ;; Return a properly formatted string when
  2319. ;; `org-export-date-timestamp-format' is non-nil and DATE keyword
  2320. ;; consists in a single timestamp.
  2321. (should
  2322. (equal "29 03 2012"
  2323. (let ((org-export-date-timestamp-format "%d %m %Y"))
  2324. (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
  2325. (org-export-get-date info)))))
  2326. ;; Return a secondary string otherwise.
  2327. (should-not
  2328. (stringp
  2329. (let ((org-export-date-timestamp-format nil))
  2330. (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
  2331. (org-export-get-date info)))))
  2332. (should
  2333. (equal '("Date")
  2334. (org-test-with-parsed-data "#+DATE: Date"
  2335. (org-export-get-date info))))
  2336. ;; Optional argument has precedence over
  2337. ;; `org-export-date-timestamp-format'.
  2338. (should
  2339. (equal "29 03"
  2340. (let ((org-export-date-timestamp-format "%d %m %Y"))
  2341. (org-test-with-parsed-data "#+DATE: <2012-03-29 Thu>"
  2342. (org-export-get-date info "%d %m"))))))
  2343. ;;; Links
  2344. (ert-deftest test-org-export/custom-protocol-maybe ()
  2345. "Test `org-export-custom-protocol-maybe' specifications."
  2346. (should
  2347. (string-match
  2348. "success"
  2349. (let ((org-link-types (copy-sequence org-link-types)))
  2350. (org-add-link-type "foo" nil (lambda (p d f) "success"))
  2351. (org-export-string-as
  2352. "[[foo:path]]"
  2353. (org-export-create-backend
  2354. :name 'test
  2355. :transcoders
  2356. '((section . (lambda (s c i) c))
  2357. (paragraph . (lambda (p c i) c))
  2358. (link . (lambda (l c i)
  2359. (or (org-export-custom-protocol-maybe l c 'test)
  2360. "failure")))))))))
  2361. (should-not
  2362. (string-match
  2363. "success"
  2364. (let ((org-link-types (copy-sequence org-link-types)))
  2365. (org-add-link-type
  2366. "foo" nil (lambda (p d f) (and (eq f 'test) "success")))
  2367. (org-export-string-as
  2368. "[[foo:path]]"
  2369. (org-export-create-backend
  2370. :name 'no-test
  2371. :transcoders
  2372. '((section . (lambda (s c i) c))
  2373. (paragraph . (lambda (p c i) c))
  2374. (link . (lambda (l c i)
  2375. (or (org-export-custom-protocol-maybe l c 'no-test)
  2376. "failure")))))))))
  2377. ;; Ignore anonymous back-ends.
  2378. (should-not
  2379. (string-match
  2380. "success"
  2381. (let ((org-link-types (copy-sequence org-link-types)))
  2382. (org-add-link-type
  2383. "foo" nil (lambda (p d f) (and (eq f 'test) "success")))
  2384. (org-export-string-as
  2385. "[[foo:path]]"
  2386. (org-export-create-backend
  2387. :transcoders
  2388. '((section . (lambda (s c i) c))
  2389. (paragraph . (lambda (p c i) c))
  2390. (link . (lambda (l c i)
  2391. (or (org-export-custom-protocol-maybe l c nil)
  2392. "failure"))))))))))
  2393. (ert-deftest test-org-export/get-coderef-format ()
  2394. "Test `org-export-get-coderef-format' specifications."
  2395. ;; A link without description returns "%s"
  2396. (should (equal (org-export-get-coderef-format "(ref:line)" nil)
  2397. "%s"))
  2398. ;; Return "%s" when path is matched within description.
  2399. (should (equal (org-export-get-coderef-format "path" "desc (path)")
  2400. "desc %s"))
  2401. ;; Otherwise return description.
  2402. (should (equal (org-export-get-coderef-format "path" "desc")
  2403. "desc")))
  2404. (ert-deftest test-org-export/inline-image-p ()
  2405. "Test `org-export-inline-image-p' specifications."
  2406. (should
  2407. (org-export-inline-image-p
  2408. (org-test-with-temp-text "[[#id]]"
  2409. (org-element-map (org-element-parse-buffer) 'link 'identity nil t))
  2410. '(("custom-id" . "id")))))
  2411. (ert-deftest test-org-export/fuzzy-link ()
  2412. "Test fuzzy links specifications."
  2413. ;; Link to an headline should return headline's number.
  2414. (should
  2415. ;; Note: Headline's number is in fact a list of numbers.
  2416. (equal '(2)
  2417. (org-test-with-parsed-data
  2418. "Paragraph.\n* Head1\n* Head2\n* Head3\n[[Head2]]"
  2419. (org-element-map tree 'link
  2420. (lambda (link)
  2421. (org-export-get-ordinal
  2422. (org-export-resolve-fuzzy-link link info) info)) info t))))
  2423. ;; Link to a target in an item should return item's number.
  2424. (should
  2425. ;; Note: Item's number is in fact a list of numbers.
  2426. (equal '(1 2)
  2427. (org-test-with-parsed-data
  2428. "- Item1\n - Item11\n - <<test>>Item12\n- Item2\n\n\n[[test]]"
  2429. (org-element-map tree 'link
  2430. (lambda (link)
  2431. (org-export-get-ordinal
  2432. (org-export-resolve-fuzzy-link link info) info)) info t))))
  2433. ;; Link to a target in a footnote should return footnote's number.
  2434. (should
  2435. (equal '(2 3)
  2436. (org-test-with-parsed-data "
  2437. Paragraph[fn:1][fn:2][fn:lbl3:C<<target>>][[test]][[target]]
  2438. \[fn:1] A
  2439. \[fn:2] <<test>>B"
  2440. (org-element-map tree 'link
  2441. (lambda (link)
  2442. (org-export-get-ordinal
  2443. (org-export-resolve-fuzzy-link link info) info)) info))))
  2444. ;; Link to a named element should return sequence number of that
  2445. ;; element.
  2446. (should
  2447. (= 2
  2448. (org-test-with-parsed-data
  2449. "#+NAME: tbl1\n|1|2|\n#+NAME: tbl2\n|3|4|\n#+NAME: tbl3\n|5|6|\n[[tbl2]]"
  2450. (org-element-map tree 'link
  2451. (lambda (link)
  2452. (org-export-get-ordinal
  2453. (org-export-resolve-fuzzy-link link info) info)) info t))))
  2454. ;; Link to a target not within an item, a table, a footnote
  2455. ;; reference or definition should return section number.
  2456. (should
  2457. (equal '(2)
  2458. (org-test-with-parsed-data
  2459. "* Head1\n* Head2\nParagraph<<target>>\n* Head3\n[[target]]"
  2460. (org-element-map tree 'link
  2461. (lambda (link)
  2462. (org-export-get-ordinal
  2463. (org-export-resolve-fuzzy-link link info) info)) info t))))
  2464. ;; Space are not significant when matching a fuzzy link.
  2465. (should
  2466. (org-test-with-parsed-data "* Head 1\n[[Head\n 1]]"
  2467. (org-element-map tree 'link
  2468. (lambda (link) (org-export-resolve-fuzzy-link link info))
  2469. info t)))
  2470. ;; Statistics cookies are ignored for headline match.
  2471. (should
  2472. (org-test-with-parsed-data "* Head [0/0]\n[[Head]]"
  2473. (org-element-map tree 'link
  2474. (lambda (link) (org-export-resolve-fuzzy-link link info))
  2475. info t)))
  2476. (should
  2477. (org-test-with-parsed-data "* Head [100%]\n[[Head]]"
  2478. (org-element-map tree 'link
  2479. (lambda (link) (org-export-resolve-fuzzy-link link info))
  2480. info t))))
  2481. (defun test-org-gen-loc-list(text type)
  2482. (org-test-with-parsed-data text
  2483. (org-element-map tree type
  2484. (lambda (el) (or (org-export-get-loc el info) 'no-loc)))))
  2485. (ert-deftest test-org-export/get-loc ()
  2486. "Test `org-export-get-loc' specifications."
  2487. (should
  2488. ;; "-n" resets line number.
  2489. (equal '(0)
  2490. (test-org-gen-loc-list "#+BEGIN_EXAMPLE -n\n Text\n#+END_EXAMPLE"
  2491. 'example-block)))
  2492. ;; The first "+n" has 0 lines before it
  2493. (should
  2494. (equal '(0)
  2495. (test-org-gen-loc-list "#+BEGIN_EXAMPLE +n\n Text\n#+END_EXAMPLE"
  2496. 'example-block)))
  2497. ;; "-n 10" resets line number but has "9 lines" before it.
  2498. (should
  2499. (equal '(9)
  2500. (test-org-gen-loc-list "#+BEGIN_EXAMPLE -n 10\n Text\n#+END_EXAMPLE"
  2501. 'example-block)))
  2502. ;; -n10 with two lines then +n 15
  2503. (should
  2504. (equal '(9 25)
  2505. (test-org-gen-loc-list "
  2506. #+BEGIN_EXAMPLE -n 10
  2507. Text_10
  2508. Second line(11)
  2509. #+END_EXAMPLE
  2510. #+BEGIN_EXAMPLE +n 15
  2511. Text line (11 + 15)
  2512. #+END_EXAMPLE"
  2513. 'example-block)))
  2514. (should
  2515. (equal '(9 19 0)
  2516. (test-org-gen-loc-list "
  2517. #+BEGIN_EXAMPLE -n 10
  2518. Text
  2519. #+END_EXAMPLE
  2520. #+BEGIN_EXAMPLE +n 10
  2521. Text
  2522. #+END_EXAMPLE
  2523. #+BEGIN_EXAMPLE -n
  2524. Text
  2525. #+END_EXAMPLE"
  2526. 'example-block)))
  2527. ;; an Example Block without -n does not add to the line count.
  2528. (should
  2529. (equal '(9 no-loc 19)
  2530. (test-org-gen-loc-list "
  2531. #+BEGIN_EXAMPLE -n 10
  2532. Text
  2533. #+END_EXAMPLE
  2534. #+BEGIN_EXAMPLE
  2535. Text
  2536. #+END_EXAMPLE
  2537. #+BEGIN_EXAMPLE +n 10
  2538. Text
  2539. #+END_EXAMPLE"
  2540. 'example-block)))
  2541. ;; "-n" resets line number.
  2542. (should
  2543. (equal
  2544. '(0)
  2545. (test-org-gen-loc-list "#+BEGIN_SRC emacs-lisp -n \n (- 1 1) \n#+END_SRC"
  2546. 'src-block)))
  2547. ;; The first "+n" has 0 lines before it.
  2548. (should
  2549. (equal '(0)
  2550. (test-org-gen-loc-list
  2551. "#+BEGIN_SRC emacs-lisp +n \n (+ 0 (- 1 1))\n#+END_SRC"
  2552. 'src-block)))
  2553. ;; "-n 10" resets line number but has "9 lines" before it.
  2554. (should
  2555. (equal '(9)
  2556. (test-org-gen-loc-list
  2557. "#+BEGIN_SRC emacs-lisp -n 10\n (- 10 1)\n#+END_SRC"
  2558. 'src-block)))
  2559. (should
  2560. (equal '(9 25)
  2561. (test-org-gen-loc-list "
  2562. #+BEGIN_SRC emacs-lisp -n 10
  2563. (- 10 1)
  2564. (+ (- 10 1) 1)
  2565. #+END_SRC
  2566. #+BEGIN_SRC emacs-lisp +n 15
  2567. (+ (- 10 1) 2 (- 15 1))
  2568. #+END_SRC"
  2569. 'src-block)))
  2570. (should
  2571. (equal '(9 19 0)
  2572. (test-org-gen-loc-list "
  2573. #+BEGIN_SRC emacs-lisp -n 10
  2574. (- 10 1)
  2575. #+END_SRC
  2576. #+BEGIN_SRC emacs-lisp +n 10
  2577. (+ (- 10 1) 1 (- 10 1))
  2578. #+END_SRC
  2579. #+BEGIN_SRC emacs-lisp -n
  2580. (- 1 1)
  2581. #+END_SRC"
  2582. 'src-block)))
  2583. ;; A SRC Block without -n does not add to the line count.
  2584. (should
  2585. (equal '(9 no-loc 19)
  2586. (test-org-gen-loc-list
  2587. "#+BEGIN_SRC emacs-lisp -n 10
  2588. (+ (-10 1) 1)
  2589. #+END_SRC
  2590. #+BEGIN_SRC emacs-lisp
  2591. (+ 2 2)
  2592. #+END_SRC
  2593. #+BEGIN_SRC emacs-lisp +n 10
  2594. (+ (- 10 1) 1 (- 10 1))
  2595. #+END_SRC"
  2596. 'src-block))))
  2597. (ert-deftest test-org-export/resolve-coderef ()
  2598. "Test `org-export-resolve-coderef' specifications."
  2599. (let ((org-coderef-label-format "(ref:%s)"))
  2600. ;; A link to a "-n -k -r" block returns line number.
  2601. (should
  2602. (= 1
  2603. (org-test-with-parsed-data
  2604. "#+BEGIN_EXAMPLE -n -k -r\nText (ref:coderef)\n#+END_EXAMPLE"
  2605. (org-export-resolve-coderef "coderef" info))))
  2606. (should
  2607. (= 10
  2608. (org-test-with-parsed-data
  2609. "#+BEGIN_EXAMPLE -n 10 -k -r\nText (ref:coderef)\n#+END_EXAMPLE"
  2610. (org-export-resolve-coderef "coderef" info))))
  2611. (should
  2612. (= 135
  2613. (org-test-with-parsed-data
  2614. "#+BEGIN_EXAMPLE -n 10 -k -r\nText \n#+END_EXAMPLE\n
  2615. #+BEGIN_EXAMPLE +n 125 -k -r\nText (ref:coderef)\n#+END_EXAMPLE"
  2616. (org-export-resolve-coderef "coderef" info))))
  2617. (should
  2618. (= 1
  2619. (org-test-with-parsed-data
  2620. "#+BEGIN_SRC emacs-lisp -n -k -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2621. (org-export-resolve-coderef "coderef" info))))
  2622. (should
  2623. (= 10
  2624. (org-test-with-parsed-data
  2625. "#+BEGIN_SRC emacs-lisp -n 10 -k -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2626. (org-export-resolve-coderef "coderef" info))))
  2627. (should
  2628. (= 135
  2629. (org-test-with-parsed-data
  2630. "#+BEGIN_SRC emacs-lisp -n 10 -k -r\n(+ 1 1) \n#+END_SRC\n
  2631. #+BEGIN_SRC emacs-lisp +n 125 -k -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2632. (org-export-resolve-coderef "coderef" info))))
  2633. ;; A link to a "-n -r" block returns line number.
  2634. (should
  2635. (= 1
  2636. (org-test-with-parsed-data
  2637. "#+BEGIN_EXAMPLE -n -r\nText (ref:coderef)\n#+END_EXAMPLE"
  2638. (org-export-resolve-coderef "coderef" info))))
  2639. (should
  2640. (= 10
  2641. (org-test-with-parsed-data
  2642. "#+BEGIN_EXAMPLE -n 10 -r\nText (ref:coderef)\n#+END_EXAMPLE"
  2643. (org-export-resolve-coderef "coderef" info))))
  2644. (should
  2645. (= 135
  2646. (org-test-with-parsed-data
  2647. "#+BEGIN_EXAMPLE +n 10 -r\nText \n#+END_EXAMPLE
  2648. #+BEGIN_EXAMPLE +n 125 -r\nText (ref:coderef)\n#+END_EXAMPLE"
  2649. (org-export-resolve-coderef "coderef" info))))
  2650. (should
  2651. (= 1
  2652. (org-test-with-parsed-data
  2653. "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2654. (org-export-resolve-coderef "coderef" info))))
  2655. (should
  2656. (= 10
  2657. (org-test-with-parsed-data
  2658. "#+BEGIN_SRC emacs-lisp -n10 -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2659. (org-export-resolve-coderef "coderef" info))))
  2660. (should
  2661. (= 135
  2662. (org-test-with-parsed-data
  2663. "#+BEGIN_SRC emacs-lisp -n10 -r\n(+ 1 1) \n#+END_SRC
  2664. #+BEGIN_SRC emacs-lisp +n125 -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2665. (org-export-resolve-coderef "coderef" info))))
  2666. ;; A link to a "-n" block returns coderef.
  2667. (should
  2668. (equal "coderef"
  2669. (org-test-with-parsed-data
  2670. "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2671. (org-export-resolve-coderef "coderef" info))))
  2672. (should
  2673. (equal "coderef"
  2674. (org-test-with-parsed-data
  2675. "#+BEGIN_EXAMPLE -n\nText (ref:coderef)\n#+END_EXAMPLE"
  2676. (org-export-resolve-coderef "coderef" info))))
  2677. ;; A link to a "-r" block returns line number.
  2678. (should
  2679. (= 1
  2680. (org-test-with-parsed-data
  2681. "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2682. (org-export-resolve-coderef "coderef" info))))
  2683. (should
  2684. (= 1
  2685. (org-test-with-parsed-data
  2686. "#+BEGIN_EXAMPLE -r\nText (ref:coderef)\n#+END_EXAMPLE"
  2687. (org-export-resolve-coderef "coderef" info))))
  2688. ;; A link to a block without a switch returns coderef.
  2689. (should
  2690. (equal "coderef"
  2691. (org-test-with-parsed-data
  2692. "#+BEGIN_SRC emacs-lisp\n(+ 1 1) (ref:coderef)\n#+END_SRC"
  2693. (org-export-resolve-coderef "coderef" info))))
  2694. (org-test-with-parsed-data
  2695. "#+BEGIN_EXAMPLE\nText (ref:coderef)\n#+END_EXAMPLE"
  2696. (should (equal (org-export-resolve-coderef "coderef" info) "coderef")))
  2697. ;; Correctly handle continued line numbers. A "+n" switch should
  2698. ;; resume numbering from previous block with numbered lines,
  2699. ;; ignoring blocks not numbering lines in the process. A "-n"
  2700. ;; switch resets count.
  2701. (should
  2702. (equal '(2 1)
  2703. (org-test-with-parsed-data "
  2704. #+BEGIN_EXAMPLE -n
  2705. Text.
  2706. #+END_EXAMPLE
  2707. #+BEGIN_SRC emacs-lisp
  2708. \(- 1 1)
  2709. #+END_SRC
  2710. #+BEGIN_SRC emacs-lisp +n -r
  2711. \(+ 1 1) (ref:addition)
  2712. #+END_SRC
  2713. #+BEGIN_EXAMPLE -n -r
  2714. Another text. (ref:text)
  2715. #+END_EXAMPLE"
  2716. (list (org-export-resolve-coderef "addition" info)
  2717. (org-export-resolve-coderef "text" info)))))
  2718. ;; Recognize coderef with user-specified syntax.
  2719. (should
  2720. (equal
  2721. "text"
  2722. (org-test-with-parsed-data
  2723. "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText. [ref:text]\n#+END_EXAMPLE"
  2724. (org-export-resolve-coderef "text" info))))
  2725. ;; Unresolved coderefs raise a `org-link-broken' signal.
  2726. (should
  2727. (condition-case nil
  2728. (org-test-with-parsed-data "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
  2729. (org-export-resolve-coderef "unknown" info))
  2730. (org-link-broken t)))))
  2731. (ert-deftest test-org-export/resolve-fuzzy-link ()
  2732. "Test `org-export-resolve-fuzzy-link' specifications."
  2733. ;; Match target objects.
  2734. (should
  2735. (org-test-with-parsed-data "<<target>> [[target]]"
  2736. (org-export-resolve-fuzzy-link
  2737. (org-element-map tree 'link 'identity info t) info)))
  2738. ;; Match named elements.
  2739. (should
  2740. (org-test-with-parsed-data "#+NAME: target\nParagraph\n\n[[target]]"
  2741. (org-export-resolve-fuzzy-link
  2742. (org-element-map tree 'link 'identity info t) info)))
  2743. ;; Match exact headline's name.
  2744. (should
  2745. (org-test-with-parsed-data "* My headline\n[[My headline]]"
  2746. (org-export-resolve-fuzzy-link
  2747. (org-element-map tree 'link 'identity info t) info)))
  2748. ;; Targets objects have priority over headline titles.
  2749. (should
  2750. (eq 'target
  2751. (org-test-with-parsed-data "* target\n<<target>>[[target]]"
  2752. (org-element-type
  2753. (org-export-resolve-fuzzy-link
  2754. (org-element-map tree 'link 'identity info t) info)))))
  2755. ;; Named elements have priority over headline titles.
  2756. (should
  2757. (eq 'paragraph
  2758. (org-test-with-parsed-data
  2759. "* target\n#+NAME: target\nParagraph\n\n[[target]]"
  2760. (org-element-type
  2761. (org-export-resolve-fuzzy-link
  2762. (org-element-map tree 'link 'identity info t) info)))))
  2763. ;; If link's path starts with a "*", only match headline titles,
  2764. ;; though.
  2765. (should
  2766. (eq 'headline
  2767. (org-test-with-parsed-data
  2768. "* target\n#+NAME: target\n<<target>>\n\n[[*target]]"
  2769. (org-element-type
  2770. (org-export-resolve-fuzzy-link
  2771. (org-element-map tree 'link 'identity info t) info)))))
  2772. ;; Raise a `org-link-broken' signal if no match.
  2773. (should
  2774. (org-test-with-parsed-data "[[target]]"
  2775. (condition-case nil
  2776. (org-export-resolve-fuzzy-link
  2777. (org-element-map tree 'link #'identity info t) info)
  2778. (org-link-broken t))))
  2779. ;; Match fuzzy link even when before first headline.
  2780. (should
  2781. (eq 'headline
  2782. (org-test-with-parsed-data "[[hl]]\n* hl"
  2783. (org-element-type
  2784. (org-export-resolve-fuzzy-link
  2785. (org-element-map tree 'link 'identity info t) info)))))
  2786. ;; Handle url-encoded fuzzy links.
  2787. (should
  2788. (org-test-with-parsed-data "* A B\n[[A%20B]]"
  2789. (org-export-resolve-fuzzy-link
  2790. (org-element-map tree 'link #'identity info t) info))))
  2791. (ert-deftest test-org-export/resolve-id-link ()
  2792. "Test `org-export-resolve-id-link' specifications."
  2793. ;; Regular test for custom-id link.
  2794. (should
  2795. (equal '("Headline1")
  2796. (org-test-with-parsed-data "* Headline1
  2797. :PROPERTIES:
  2798. :CUSTOM_ID: test
  2799. :END:
  2800. * Headline 2
  2801. \[[#test]]"
  2802. (org-element-property
  2803. :title
  2804. (org-export-resolve-id-link
  2805. (org-element-map tree 'link 'identity info t) info)))))
  2806. ;; Raise a `org-link-broken' signal on failing searches.
  2807. (should
  2808. (org-test-with-parsed-data "* Headline1
  2809. :PROPERTIES:
  2810. :CUSTOM_ID: test
  2811. :END:
  2812. * Headline 2
  2813. \[[#no-match]]"
  2814. (condition-case nil
  2815. (org-export-resolve-id-link
  2816. (org-element-map tree 'link #'identity info t) info)
  2817. (org-link-broken t))))
  2818. ;; Test for internal id target.
  2819. (should
  2820. (equal '("Headline1")
  2821. (org-test-with-parsed-data "* Headline1
  2822. :PROPERTIES:
  2823. :ID: aaaa
  2824. :END:
  2825. * Headline 2
  2826. \[[id:aaaa]]"
  2827. (org-element-property
  2828. :title
  2829. (org-export-resolve-id-link
  2830. (org-element-map tree 'link 'identity info t) info)))))
  2831. ;; Test for external id target.
  2832. (should
  2833. (equal
  2834. "external-file"
  2835. (org-test-with-parsed-data "[[id:aaaa]]"
  2836. (org-export-resolve-id-link
  2837. (org-element-map tree 'link 'identity info t)
  2838. (org-combine-plists info '(:id-alist (("aaaa" . "external-file")))))))))
  2839. (ert-deftest test-org-export/resolve-radio-link ()
  2840. "Test `org-export-resolve-radio-link' specifications."
  2841. ;; Standard test.
  2842. (should
  2843. (org-test-with-temp-text "<<<radio>>> radio"
  2844. (org-update-radio-target-regexp)
  2845. (let* ((tree (org-element-parse-buffer))
  2846. (info `(:parse-tree ,tree)))
  2847. (org-export-resolve-radio-link
  2848. (org-element-map tree 'link 'identity info t)
  2849. info))))
  2850. ;; Radio targets are case-insensitive.
  2851. (should
  2852. (org-test-with-temp-text "<<<RADIO>>> radio"
  2853. (org-update-radio-target-regexp)
  2854. (let* ((tree (org-element-parse-buffer))
  2855. (info `(:parse-tree ,tree)))
  2856. (org-export-resolve-radio-link
  2857. (org-element-map tree 'link 'identity info t)
  2858. info))))
  2859. ;; Radio target with objects.
  2860. (should
  2861. (org-test-with-temp-text "<<<radio \\alpha>>> radio \\alpha"
  2862. (org-update-radio-target-regexp)
  2863. (let* ((tree (org-element-parse-buffer))
  2864. (info `(:parse-tree ,tree)))
  2865. (org-export-resolve-radio-link
  2866. (org-element-map tree 'link 'identity info t)
  2867. info))))
  2868. ;; Radio target with objects at its beginning.
  2869. (should
  2870. (org-test-with-temp-text "<<<\\alpha radio>>> \\alpha radio"
  2871. (org-update-radio-target-regexp)
  2872. (let* ((tree (org-element-parse-buffer))
  2873. (info `(:parse-tree ,tree)))
  2874. (org-export-resolve-radio-link
  2875. (org-element-map tree 'link 'identity info t)
  2876. info))))
  2877. ;; Radio link next to an apostrophe.
  2878. (should
  2879. (org-test-with-temp-text "<<<radio>>> radio's"
  2880. (org-update-radio-target-regexp)
  2881. (let* ((tree (org-element-parse-buffer))
  2882. (info `(:parse-tree ,tree)))
  2883. (org-export-resolve-radio-link
  2884. (org-element-map tree 'link 'identity info t)
  2885. info))))
  2886. ;; Multiple radio targets.
  2887. (should
  2888. (equal '("radio1" "radio2")
  2889. (org-test-with-temp-text "<<<radio1>>> <<<radio2>>> radio1 radio2"
  2890. (org-update-radio-target-regexp)
  2891. (let* ((tree (org-element-parse-buffer))
  2892. (info `(:parse-tree ,tree)))
  2893. (org-element-map tree 'link
  2894. (lambda (link)
  2895. (org-element-property
  2896. :value (org-export-resolve-radio-link link info)))
  2897. info)))))
  2898. ;; Radio target is whitespace insensitive.
  2899. (should
  2900. (org-test-with-temp-text "<<<a radio>>> a\n radio"
  2901. (org-update-radio-target-regexp)
  2902. (let* ((tree (org-element-parse-buffer))
  2903. (info `(:parse-tree ,tree)))
  2904. (org-element-map tree 'link
  2905. (lambda (link) (org-export-resolve-radio-link link info)) info t)))))
  2906. (ert-deftest test-org-export/file-uri ()
  2907. "Test `org-export-file-uri' specifications."
  2908. ;; Preserve relative filenames.
  2909. (should (equal "relative.org" (org-export-file-uri "relative.org")))
  2910. ;; Local files start with "file:///"
  2911. (should (equal "file:///local.org" (org-export-file-uri "/local.org")))
  2912. ;; Remote files start with "file://"
  2913. (should (equal "file://myself@some.where:papers/last.pdf"
  2914. (org-export-file-uri "/myself@some.where:papers/last.pdf")))
  2915. (should (equal "file://localhost/etc/fstab"
  2916. (org-export-file-uri "//localhost/etc/fstab")))
  2917. ;; Expand filename starting with "~".
  2918. (should (equal (org-export-file-uri "~/file.org")
  2919. (concat "file://" (expand-file-name "~/file.org")))))
  2920. (ert-deftest test-org-export/get-reference ()
  2921. "Test `org-export-get-reference' specifications."
  2922. (should
  2923. (org-test-with-parsed-data "* Headline"
  2924. (org-export-get-reference (org-element-map tree 'headline #'identity nil t)
  2925. info)))
  2926. ;; For a given element always return the same reference.
  2927. (should
  2928. (org-test-with-parsed-data "* Headline"
  2929. (let ((headline (org-element-map tree 'headline #'identity nil t)))
  2930. (equal (org-export-get-reference headline info)
  2931. (org-export-get-reference headline info)))))
  2932. ;; Use search cells defined in `:crossrefs'.
  2933. (should
  2934. (equal "org0000001"
  2935. (org-test-with-parsed-data "* Headline"
  2936. (let* ((headline (org-element-map tree 'headline #'identity nil t))
  2937. (search-cell (car (org-export-search-cells headline))))
  2938. (setq info
  2939. (plist-put info :crossrefs (list (cons search-cell 1))))
  2940. (org-export-get-reference headline info))))))
  2941. ;;; Src-block and example-block
  2942. (ert-deftest test-org-export/unravel-code ()
  2943. "Test `org-export-unravel-code' function."
  2944. ;; Code without reference.
  2945. (should
  2946. (equal '("(+ 1 1)\n")
  2947. (org-test-with-temp-text "#+BEGIN_EXAMPLE\n(+ 1 1)\n#+END_EXAMPLE"
  2948. (org-export-unravel-code (org-element-at-point)))))
  2949. ;; Code with reference.
  2950. (should
  2951. (equal '("(+ 1 1)\n" (1 . "test"))
  2952. (org-test-with-temp-text
  2953. "#+BEGIN_EXAMPLE\n(+ 1 1) (ref:test)\n#+END_EXAMPLE"
  2954. (let ((org-coderef-label-format "(ref:%s)"))
  2955. (org-export-unravel-code (org-element-at-point))))))
  2956. ;; Code with user-defined reference.
  2957. (should
  2958. (equal
  2959. '("(+ 1 1)\n" (1 . "test"))
  2960. (org-test-with-temp-text
  2961. "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\n(+ 1 1) [ref:test]\n#+END_EXAMPLE"
  2962. (let ((org-coderef-label-format "(ref:%s)"))
  2963. (org-export-unravel-code (org-element-at-point))))))
  2964. ;; Code references keys are relative to the current block.
  2965. (should
  2966. (equal '("(+ 2 2)\n(+ 3 3)\n" (2 . "one"))
  2967. (org-test-with-temp-text "
  2968. #+BEGIN_EXAMPLE -n
  2969. \(+ 1 1)
  2970. #+END_EXAMPLE
  2971. #+BEGIN_EXAMPLE +n
  2972. \(+ 2 2)
  2973. \(+ 3 3) (ref:one)
  2974. #+END_EXAMPLE"
  2975. (goto-line 5)
  2976. (let ((org-coderef-label-format "(ref:%s)"))
  2977. (org-export-unravel-code (org-element-at-point)))))))
  2978. (ert-deftest test-org-export/format-code-default ()
  2979. "Test `org-export-format-code-default' specifications."
  2980. ;; Return the empty string when code is empty.
  2981. (should
  2982. (equal ""
  2983. (org-test-with-parsed-data "#+BEGIN_SRC emacs-lisp\n\n\n#+END_SRC"
  2984. (org-export-format-code-default
  2985. (org-element-map tree 'src-block 'identity info t) info))))
  2986. ;; Number lines, two whitespace characters before the actual loc.
  2987. (should
  2988. (equal "1 a\n2 b\n"
  2989. (org-test-with-parsed-data
  2990. "#+BEGIN_SRC emacs-lisp +n\na\nb\n#+END_SRC"
  2991. (org-export-format-code-default
  2992. (org-element-map tree 'src-block 'identity info t) info))))
  2993. ;; Put references 6 whitespace characters after the widest line,
  2994. ;; wrapped within parenthesis.
  2995. (should
  2996. (equal "123 (a)\n1 (b)\n"
  2997. (let ((org-coderef-label-format "(ref:%s)"))
  2998. (org-test-with-parsed-data
  2999. "#+BEGIN_SRC emacs-lisp\n123 (ref:a)\n1 (ref:b)\n#+END_SRC"
  3000. (org-export-format-code-default
  3001. (org-element-map tree 'src-block 'identity info t) info))))))
  3002. ;;; Smart Quotes
  3003. (ert-deftest test-org-export/activate-smart-quotes ()
  3004. "Test `org-export-activate-smart-quotes' specifications."
  3005. ;; Double quotes: standard test.
  3006. (should
  3007. (equal
  3008. '("some &ldquo;quoted&rdquo; text")
  3009. (let ((org-export-default-language "en"))
  3010. (org-test-with-parsed-data "some \"quoted\" text"
  3011. (org-element-map tree 'plain-text
  3012. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3013. info)))))
  3014. ;; Opening quotes: at the beginning of a paragraph.
  3015. (should
  3016. (equal
  3017. '("&ldquo;begin")
  3018. (let ((org-export-default-language "en"))
  3019. (org-test-with-parsed-data "\"begin"
  3020. (org-element-map tree 'plain-text
  3021. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3022. info)))))
  3023. ;; Opening quotes: after an object.
  3024. (should
  3025. (equal
  3026. '("&ldquo;quoted&rdquo; text")
  3027. (let ((org-export-default-language "en"))
  3028. (org-test-with-parsed-data "=verb= \"quoted\" text"
  3029. (org-element-map tree 'plain-text
  3030. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3031. info)))))
  3032. ;; Closing quotes: at the end of a paragraph.
  3033. (should
  3034. (equal
  3035. '("Quoted &ldquo;text&rdquo;")
  3036. (let ((org-export-default-language "en"))
  3037. (org-test-with-parsed-data "Quoted \"text\""
  3038. (org-element-map tree 'plain-text
  3039. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3040. info)))))
  3041. ;; Inner quotes: standard test.
  3042. (should
  3043. (equal '("« outer « inner » outer »")
  3044. (let ((org-export-default-language "fr"))
  3045. (org-test-with-parsed-data "\"outer 'inner' outer\""
  3046. (org-element-map tree 'plain-text
  3047. (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
  3048. info)))))
  3049. ;; Inner quotes: close to special symbols.
  3050. (should
  3051. (equal '("« outer (« inner ») outer »")
  3052. (let ((org-export-default-language "fr"))
  3053. (org-test-with-parsed-data "\"outer ('inner') outer\""
  3054. (org-element-map tree 'plain-text
  3055. (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
  3056. info)))))
  3057. (should
  3058. (equal '("« « inner » »")
  3059. (let ((org-export-default-language "fr"))
  3060. (org-test-with-parsed-data "\"'inner'\""
  3061. (org-element-map tree 'plain-text
  3062. (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
  3063. info)))))
  3064. ;; Apostrophe: standard test.
  3065. (should
  3066. (equal '("It « shouldn’t » fail")
  3067. (let ((org-export-default-language "fr"))
  3068. (org-test-with-parsed-data "It \"shouldn't\" fail"
  3069. (org-element-map tree 'plain-text
  3070. (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
  3071. info)))))
  3072. (should
  3073. (equal '("It shouldn’t fail")
  3074. (let ((org-export-default-language "fr"))
  3075. (org-test-with-parsed-data "It shouldn't fail"
  3076. (org-element-map tree 'plain-text
  3077. (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
  3078. info)))))
  3079. ;; Apostrophe: before an object.
  3080. (should
  3081. (equal
  3082. '("« a’" " »")
  3083. (let ((org-export-default-language "fr"))
  3084. (org-test-with-parsed-data "\"a'=b=\""
  3085. (org-element-map tree 'plain-text
  3086. (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
  3087. info)))))
  3088. ;; Apostrophe: after an object.
  3089. (should
  3090. (equal '("« " "’s »")
  3091. (let ((org-export-default-language "fr"))
  3092. (org-test-with-parsed-data "\"=code='s\""
  3093. (org-element-map tree 'plain-text
  3094. (lambda (s) (org-export-activate-smart-quotes s :utf-8 info))
  3095. info)))))
  3096. ;; Special case: isolated quotes.
  3097. (should
  3098. (equal '("&ldquo;" "&rdquo;")
  3099. (let ((org-export-default-language "en"))
  3100. (org-test-with-parsed-data "\"$x$\""
  3101. (org-element-map tree 'plain-text
  3102. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3103. info)))))
  3104. ;; Smart quotes in secondary strings.
  3105. (should
  3106. (equal '("&ldquo;" "&rdquo;")
  3107. (let ((org-export-default-language "en"))
  3108. (org-test-with-parsed-data "* \"$x$\""
  3109. (org-element-map tree 'plain-text
  3110. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3111. info)))))
  3112. ;; Smart quotes in document keywords.
  3113. (should
  3114. (equal '("&ldquo;" "&rdquo;")
  3115. (let ((org-export-default-language "en"))
  3116. (org-test-with-parsed-data "#+TITLE: \"$x$\""
  3117. (org-element-map (plist-get info :title) 'plain-text
  3118. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3119. info)))))
  3120. ;; Smart quotes in parsed affiliated keywords.
  3121. (should
  3122. (equal '("&ldquo;" "&rdquo;" "Paragraph")
  3123. (let ((org-export-default-language "en"))
  3124. (org-test-with-parsed-data "#+CAPTION: \"$x$\"\nParagraph"
  3125. (org-element-map tree 'plain-text
  3126. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3127. info nil nil t)))))
  3128. ;; Smart quotes within objects.
  3129. (should
  3130. (equal '("&ldquo;foo&rdquo;")
  3131. (let ((org-export-default-language "en"))
  3132. (org-test-with-parsed-data "| \"foo\" |"
  3133. (org-element-map tree 'plain-text
  3134. (lambda (s) (org-export-activate-smart-quotes s :html info))
  3135. info nil nil t)))))
  3136. ;; FIXME: Test failing non-interactively.
  3137. ;;
  3138. ;; (should
  3139. ;; (equal '("&ldquo;foo&rdquo;")
  3140. ;; (let ((org-export-default-language "en"))
  3141. ;; (org-test-with-parsed-data "*\"foo\"*"
  3142. ;; (org-element-map tree 'plain-text
  3143. ;; (lambda (s) (org-export-activate-smart-quotes s :html info))
  3144. ;; info nil nil t)))))
  3145. )
  3146. ;;; Tables
  3147. (ert-deftest test-org-export/special-column ()
  3148. "Test if the table's special column is properly recognized."
  3149. ;; 1. First column is special if it contains only a special marking
  3150. ;; characters or empty cells.
  3151. (org-test-with-temp-text "
  3152. | ! | 1 |
  3153. | | 2 |"
  3154. (should
  3155. (org-export-table-has-special-column-p
  3156. (org-element-map
  3157. (org-element-parse-buffer) 'table 'identity nil 'first-match))))
  3158. ;; 2. If the column contains anything else, it isn't special.
  3159. (org-test-with-temp-text "
  3160. | ! | 1 |
  3161. | b | 2 |"
  3162. (should-not
  3163. (org-export-table-has-special-column-p
  3164. (org-element-map
  3165. (org-element-parse-buffer) 'table 'identity nil 'first-match))))
  3166. ;; 3. Special marking characters are "#", "^", "*", "_", "/", "$"
  3167. ;; and "!".
  3168. (org-test-with-temp-text "
  3169. | # | 1 |
  3170. | ^ | 2 |
  3171. | * | 3 |
  3172. | _ | 4 |
  3173. | / | 5 |
  3174. | $ | 6 |
  3175. | ! | 7 |"
  3176. (should
  3177. (org-export-table-has-special-column-p
  3178. (org-element-map
  3179. (org-element-parse-buffer) 'table 'identity nil 'first-match))))
  3180. ;; 4. A first column with only empty cells isn't considered as
  3181. ;; special.
  3182. (org-test-with-temp-text "
  3183. | | 1 |
  3184. | | 2 |"
  3185. (should-not
  3186. (org-export-table-has-special-column-p
  3187. (org-element-map
  3188. (org-element-parse-buffer) 'table 'identity nil 'first-match)))))
  3189. (ert-deftest test-org-export/table-row-is-special-p ()
  3190. "Test `org-export-table-row-is-special-p' specifications."
  3191. ;; 1. A row is special if it has a special marking character in the
  3192. ;; special column.
  3193. (org-test-with-parsed-data "| ! | 1 |"
  3194. (should
  3195. (org-export-table-row-is-special-p
  3196. (org-element-map tree 'table-row 'identity nil 'first-match) info)))
  3197. ;; 2. A row is special when its first field is "/"
  3198. (org-test-with-parsed-data "
  3199. | / | 1 |
  3200. | a | b |"
  3201. (should
  3202. (org-export-table-row-is-special-p
  3203. (org-element-map tree 'table-row 'identity nil 'first-match) info)))
  3204. ;; 3. A row only containing alignment cookies is also considered as
  3205. ;; special.
  3206. (org-test-with-parsed-data "| <5> | | <l> | <l22> |"
  3207. (should
  3208. (org-export-table-row-is-special-p
  3209. (org-element-map tree 'table-row 'identity nil 'first-match) info)))
  3210. ;; 4. Everything else isn't considered as special.
  3211. (org-test-with-parsed-data "| \alpha | | c |"
  3212. (should-not
  3213. (org-export-table-row-is-special-p
  3214. (org-element-map tree 'table-row 'identity nil 'first-match) info)))
  3215. ;; 5. Table's rules are never considered as special rows.
  3216. (org-test-with-parsed-data "|---+---|"
  3217. (should-not
  3218. (org-export-table-row-is-special-p
  3219. (org-element-map tree 'table-row 'identity nil 'first-match) info))))
  3220. (ert-deftest test-org-export/has-header-p ()
  3221. "Test `org-export-table-has-header-p' specifications."
  3222. ;; 1. With an header.
  3223. (org-test-with-parsed-data "
  3224. | a | b |
  3225. |---+---|
  3226. | c | d |"
  3227. (should
  3228. (org-export-table-has-header-p
  3229. (org-element-map tree 'table 'identity info 'first-match)
  3230. info)))
  3231. ;; 2. Without an header.
  3232. (org-test-with-parsed-data "
  3233. | a | b |
  3234. | c | d |"
  3235. (should-not
  3236. (org-export-table-has-header-p
  3237. (org-element-map tree 'table 'identity info 'first-match)
  3238. info)))
  3239. ;; 3. Don't get fooled with starting and ending rules.
  3240. (org-test-with-parsed-data "
  3241. |---+---|
  3242. | a | b |
  3243. | c | d |
  3244. |---+---|"
  3245. (should-not
  3246. (org-export-table-has-header-p
  3247. (org-element-map tree 'table 'identity info 'first-match)
  3248. info))))
  3249. (ert-deftest test-org-export/table-row-group ()
  3250. "Test `org-export-table-row-group' specifications."
  3251. ;; 1. A rule creates a new group.
  3252. (should
  3253. (equal '(1 rule 2)
  3254. (org-test-with-parsed-data "
  3255. | a | b |
  3256. |---+---|
  3257. | 1 | 2 |"
  3258. (org-element-map tree 'table-row
  3259. (lambda (row)
  3260. (if (eq (org-element-property :type row) 'rule) 'rule
  3261. (org-export-table-row-group row info)))))))
  3262. ;; 2. Special rows are ignored in count.
  3263. (should
  3264. (equal
  3265. '(rule 1)
  3266. (org-test-with-parsed-data "
  3267. | / | < | > |
  3268. |---|---+---|
  3269. | | 1 | 2 |"
  3270. (org-element-map tree 'table-row
  3271. (lambda (row)
  3272. (if (eq (org-element-property :type row) 'rule) 'rule
  3273. (org-export-table-row-group row info)))
  3274. info))))
  3275. ;; 3. Double rules also are ignored in count.
  3276. (should
  3277. (equal '(1 rule rule 2)
  3278. (org-test-with-parsed-data "
  3279. | a | b |
  3280. |---+---|
  3281. |---+---|
  3282. | 1 | 2 |"
  3283. (org-element-map tree 'table-row
  3284. (lambda (row)
  3285. (if (eq (org-element-property :type row) 'rule) 'rule
  3286. (org-export-table-row-group row info))))))))
  3287. (ert-deftest test-org-export/table-row-number ()
  3288. "Test `org-export-table-row-number' specifications."
  3289. ;; Standard test. Number is 0-indexed.
  3290. (should
  3291. (equal '(0 1)
  3292. (org-test-with-parsed-data "| a | b | c |\n| d | e | f |"
  3293. (org-element-map tree 'table-row
  3294. (lambda (row) (org-export-table-row-number row info)) info))))
  3295. ;; Number ignores separators.
  3296. (should
  3297. (equal '(0 1)
  3298. (org-test-with-parsed-data "
  3299. | a | b | c |
  3300. |---+---+---|
  3301. | d | e | f |"
  3302. (org-element-map tree 'table-row
  3303. (lambda (row) (org-export-table-row-number row info)) info))))
  3304. ;; Number ignores special rows.
  3305. (should
  3306. (equal '(0 1)
  3307. (org-test-with-parsed-data "
  3308. | / | < | > |
  3309. | | b | c |
  3310. |---+-----+-----|
  3311. | | <c> | <c> |
  3312. | | e | f |"
  3313. (org-element-map tree 'table-row
  3314. (lambda (row) (org-export-table-row-number row info)) info)))))
  3315. (ert-deftest test-org-export/table-cell-width ()
  3316. "Test `org-export-table-cell-width' specifications."
  3317. ;; 1. Width is primarily determined by width cookies. If no cookie
  3318. ;; is found, cell's width is nil.
  3319. (org-test-with-parsed-data "
  3320. | / | <l> | <6> | <l7> |
  3321. | | a | b | c |"
  3322. (should
  3323. (equal
  3324. '(nil 6 7)
  3325. (mapcar (lambda (cell) (org-export-table-cell-width cell info))
  3326. (org-element-map tree 'table-cell 'identity info)))))
  3327. ;; 2. The last width cookie has precedence.
  3328. (org-test-with-parsed-data "
  3329. | <6> |
  3330. | <7> |
  3331. | a |"
  3332. (should
  3333. (equal
  3334. '(7)
  3335. (mapcar (lambda (cell) (org-export-table-cell-width cell info))
  3336. (org-element-map tree 'table-cell 'identity info)))))
  3337. ;; 3. Valid width cookies must have a specific row.
  3338. (org-test-with-parsed-data "| <6> | cell |"
  3339. (should
  3340. (equal
  3341. '(nil nil)
  3342. (mapcar (lambda (cell) (org-export-table-cell-width cell info))
  3343. (org-element-map tree 'table-cell 'identity))))))
  3344. (ert-deftest test-org-export/table-cell-alignment ()
  3345. "Test `org-export-table-cell-alignment' specifications."
  3346. ;; 1. Alignment is primarily determined by alignment cookies.
  3347. (should
  3348. (equal '(left center right)
  3349. (let ((org-table-number-fraction 0.5)
  3350. (org-table-number-regexp "^[0-9]+$"))
  3351. (org-test-with-parsed-data "| <l> | <c> | <r> |"
  3352. (mapcar (lambda (cell)
  3353. (org-export-table-cell-alignment cell info))
  3354. (org-element-map tree 'table-cell 'identity))))))
  3355. ;; 2. The last alignment cookie has precedence.
  3356. (should
  3357. (equal '(right right right)
  3358. (org-test-with-parsed-data "
  3359. | <l8> |
  3360. | cell |
  3361. | <r9> |"
  3362. (mapcar (lambda (cell) (org-export-table-cell-alignment cell info))
  3363. (org-element-map tree 'table-cell 'identity)))))
  3364. ;; 3. If there's no cookie, cell's contents determine alignment.
  3365. ;; A column mostly made of cells containing numbers will align
  3366. ;; its cells to the right.
  3367. (should
  3368. (equal '(right right right)
  3369. (let ((org-table-number-fraction 0.5)
  3370. (org-table-number-regexp "^[0-9]+$"))
  3371. (org-test-with-parsed-data "
  3372. | 123 |
  3373. | some text |
  3374. | 12345 |"
  3375. (mapcar (lambda (cell)
  3376. (org-export-table-cell-alignment cell info))
  3377. (org-element-map tree 'table-cell 'identity))))))
  3378. ;; 4. Otherwise, they will be aligned to the left.
  3379. (should
  3380. (equal '(left left left)
  3381. (org-test-with-parsed-data "
  3382. | text |
  3383. | some text |
  3384. | \alpha |"
  3385. (mapcar (lambda (cell)
  3386. (org-export-table-cell-alignment cell info))
  3387. (org-element-map tree 'table-cell 'identity info))))))
  3388. (ert-deftest test-org-export/table-cell-borders ()
  3389. "Test `org-export-table-cell-borders' specifications."
  3390. ;; 1. Recognize various column groups indicators.
  3391. (org-test-with-parsed-data "| / | < | > | <> |"
  3392. (should
  3393. (equal
  3394. '((right bottom top) (left bottom top) (right bottom top)
  3395. (right left bottom top))
  3396. (mapcar (lambda (cell)
  3397. (org-export-table-cell-borders cell info))
  3398. (org-element-map tree 'table-cell 'identity)))))
  3399. ;; 2. Accept shortcuts to define column groups.
  3400. (org-test-with-parsed-data "| / | < | < |"
  3401. (should
  3402. (equal
  3403. '((right bottom top) (right left bottom top) (left bottom top))
  3404. (mapcar (lambda (cell)
  3405. (org-export-table-cell-borders cell info))
  3406. (org-element-map tree 'table-cell 'identity)))))
  3407. ;; 3. A valid column groups row must start with a "/".
  3408. (org-test-with-parsed-data "
  3409. | | < |
  3410. | a | b |"
  3411. (should
  3412. (equal '((top) (top) (bottom) (bottom))
  3413. (mapcar (lambda (cell)
  3414. (org-export-table-cell-borders cell info))
  3415. (org-element-map tree 'table-cell 'identity)))))
  3416. ;; 4. Take table rules into consideration.
  3417. (org-test-with-parsed-data "
  3418. | 1 |
  3419. |---|
  3420. | 2 |"
  3421. (should
  3422. (equal '((below top) (bottom above))
  3423. (mapcar (lambda (cell)
  3424. (org-export-table-cell-borders cell info))
  3425. (org-element-map tree 'table-cell 'identity)))))
  3426. ;; 5. Top and (resp. bottom) rules induce both `top' and `above'
  3427. ;; (resp. `bottom' and `below') borders. Any special row is
  3428. ;; ignored.
  3429. (org-test-with-parsed-data "
  3430. |---+----|
  3431. | / | |
  3432. | | 1 |
  3433. |---+----|"
  3434. (should
  3435. (equal '((bottom below top above))
  3436. (last
  3437. (mapcar (lambda (cell)
  3438. (org-export-table-cell-borders cell info))
  3439. (org-element-map tree 'table-cell 'identity)))))))
  3440. (ert-deftest test-org-export/table-dimensions ()
  3441. "Test `org-export-table-dimensions' specifications."
  3442. ;; 1. Standard test.
  3443. (org-test-with-parsed-data "
  3444. | 1 | 2 | 3 |
  3445. | 4 | 5 | 6 |"
  3446. (should
  3447. (equal '(2 . 3)
  3448. (org-export-table-dimensions
  3449. (org-element-map tree 'table 'identity info 'first-match) info))))
  3450. ;; 2. Ignore horizontal rules and special columns.
  3451. (org-test-with-parsed-data "
  3452. | / | < | > |
  3453. | 1 | 2 | 3 |
  3454. |---+---+---|
  3455. | 4 | 5 | 6 |"
  3456. (should
  3457. (equal '(2 . 3)
  3458. (org-export-table-dimensions
  3459. (org-element-map tree 'table 'identity info 'first-match) info)))))
  3460. (ert-deftest test-org-export/table-cell-address ()
  3461. "Test `org-export-table-cell-address' specifications."
  3462. ;; 1. Standard test: index is 0-based.
  3463. (org-test-with-parsed-data "| a | b |"
  3464. (should
  3465. (equal '((0 . 0) (0 . 1))
  3466. (org-element-map tree 'table-cell
  3467. (lambda (cell) (org-export-table-cell-address cell info))
  3468. info))))
  3469. ;; 2. Special column isn't counted, nor are special rows.
  3470. (org-test-with-parsed-data "
  3471. | / | <> |
  3472. | | c |"
  3473. (should
  3474. (equal '(0 . 0)
  3475. (org-export-table-cell-address
  3476. (car (last (org-element-map tree 'table-cell 'identity info)))
  3477. info))))
  3478. ;; 3. Tables rules do not count either.
  3479. (org-test-with-parsed-data "
  3480. | a |
  3481. |---|
  3482. | b |
  3483. |---|
  3484. | c |"
  3485. (should
  3486. (equal '(2 . 0)
  3487. (org-export-table-cell-address
  3488. (car (last (org-element-map tree 'table-cell 'identity info)))
  3489. info))))
  3490. ;; 4. Return nil for special cells.
  3491. (org-test-with-parsed-data "| / | a |"
  3492. (should-not
  3493. (org-export-table-cell-address
  3494. (org-element-map tree 'table-cell 'identity nil 'first-match)
  3495. info))))
  3496. (ert-deftest test-org-export/get-table-cell-at ()
  3497. "Test `org-export-get-table-cell-at' specifications."
  3498. ;; 1. Address ignores special columns, special rows and rules.
  3499. (org-test-with-parsed-data "
  3500. | / | <> |
  3501. | | a |
  3502. |---+----|
  3503. | | b |"
  3504. (should
  3505. (equal '("b")
  3506. (org-element-contents
  3507. (org-export-get-table-cell-at
  3508. '(1 . 0)
  3509. (org-element-map tree 'table 'identity info 'first-match)
  3510. info)))))
  3511. ;; 2. Return value for a non-existent address is nil.
  3512. (org-test-with-parsed-data "| a |"
  3513. (should-not
  3514. (org-export-get-table-cell-at
  3515. '(2 . 2)
  3516. (org-element-map tree 'table 'identity info 'first-match)
  3517. info)))
  3518. (org-test-with-parsed-data "| / |"
  3519. (should-not
  3520. (org-export-get-table-cell-at
  3521. '(0 . 0)
  3522. (org-element-map tree 'table 'identity info 'first-match)
  3523. info))))
  3524. (ert-deftest test-org-export/table-cell-starts-colgroup-p ()
  3525. "Test `org-export-table-cell-starts-colgroup-p' specifications."
  3526. ;; 1. A cell at a beginning of a row always starts a column group.
  3527. (org-test-with-parsed-data "| a |"
  3528. (should
  3529. (org-export-table-cell-starts-colgroup-p
  3530. (org-element-map tree 'table-cell 'identity info 'first-match)
  3531. info)))
  3532. ;; 2. Special column should be ignored when determining the
  3533. ;; beginning of the row.
  3534. (org-test-with-parsed-data "
  3535. | / | |
  3536. | | a |"
  3537. (should
  3538. (org-export-table-cell-starts-colgroup-p
  3539. (org-element-map tree 'table-cell 'identity info 'first-match)
  3540. info)))
  3541. ;; 2. Explicit column groups.
  3542. (org-test-with-parsed-data "
  3543. | / | | < |
  3544. | a | b | c |"
  3545. (should
  3546. (equal
  3547. '(yes no yes)
  3548. (org-element-map tree 'table-cell
  3549. (lambda (cell)
  3550. (if (org-export-table-cell-starts-colgroup-p cell info) 'yes 'no))
  3551. info)))))
  3552. (ert-deftest test-org-export/table-cell-ends-colgroup-p ()
  3553. "Test `org-export-table-cell-ends-colgroup-p' specifications."
  3554. ;; 1. A cell at the end of a row always ends a column group.
  3555. (org-test-with-parsed-data "| a |"
  3556. (should
  3557. (org-export-table-cell-ends-colgroup-p
  3558. (org-element-map tree 'table-cell 'identity info 'first-match)
  3559. info)))
  3560. ;; 2. Special column should be ignored when determining the
  3561. ;; beginning of the row.
  3562. (org-test-with-parsed-data "
  3563. | / | |
  3564. | | a |"
  3565. (should
  3566. (org-export-table-cell-ends-colgroup-p
  3567. (org-element-map tree 'table-cell 'identity info 'first-match)
  3568. info)))
  3569. ;; 3. Explicit column groups.
  3570. (org-test-with-parsed-data "
  3571. | / | < | |
  3572. | a | b | c |"
  3573. (should
  3574. (equal
  3575. '(yes no yes)
  3576. (org-element-map tree 'table-cell
  3577. (lambda (cell)
  3578. (if (org-export-table-cell-ends-colgroup-p cell info) 'yes 'no))
  3579. info)))))
  3580. (ert-deftest test-org-export/table-row-starts-rowgroup-p ()
  3581. "Test `org-export-table-row-starts-rowgroup-p' specifications."
  3582. ;; 1. A row at the beginning of a table always starts a row group.
  3583. ;; So does a row following a table rule.
  3584. (org-test-with-parsed-data "
  3585. | a |
  3586. |---|
  3587. | b |"
  3588. (should
  3589. (equal
  3590. '(yes no yes)
  3591. (org-element-map tree 'table-row
  3592. (lambda (row)
  3593. (if (org-export-table-row-starts-rowgroup-p row info) 'yes 'no))
  3594. info))))
  3595. ;; 2. Special rows should be ignored when determining the beginning
  3596. ;; of the row.
  3597. (org-test-with-parsed-data "
  3598. | / | < |
  3599. | | a |
  3600. |---+---|
  3601. | / | < |
  3602. | | b |"
  3603. (should
  3604. (equal
  3605. '(yes no yes)
  3606. (org-element-map tree 'table-row
  3607. (lambda (row)
  3608. (if (org-export-table-row-starts-rowgroup-p row info) 'yes 'no))
  3609. info)))))
  3610. (ert-deftest test-org-export/table-row-ends-rowgroup-p ()
  3611. "Test `org-export-table-row-ends-rowgroup-p' specifications."
  3612. ;; 1. A row at the end of a table always ends a row group. So does
  3613. ;; a row preceding a table rule.
  3614. (org-test-with-parsed-data "
  3615. | a |
  3616. |---|
  3617. | b |"
  3618. (should
  3619. (equal
  3620. '(yes no yes)
  3621. (org-element-map tree 'table-row
  3622. (lambda (row)
  3623. (if (org-export-table-row-ends-rowgroup-p row info) 'yes 'no))
  3624. info))))
  3625. ;; 2. Special rows should be ignored when determining the beginning
  3626. ;; of the row.
  3627. (org-test-with-parsed-data "
  3628. | | a |
  3629. | / | < |
  3630. |---+---|
  3631. | | b |
  3632. | / | < |"
  3633. (should
  3634. (equal
  3635. '(yes no yes)
  3636. (org-element-map tree 'table-row
  3637. (lambda (row)
  3638. (if (org-export-table-row-ends-rowgroup-p row info) 'yes 'no))
  3639. info)))))
  3640. (ert-deftest test-org-export/table-row-in-header-p ()
  3641. "Test `org-export-table-row-in-header-p' specifications."
  3642. ;; Standard test. Separators are always nil.
  3643. (should
  3644. (equal
  3645. '(yes no no)
  3646. (org-test-with-parsed-data "| a |\n|---|\n| b |"
  3647. (org-element-map tree 'table-row
  3648. (lambda (row)
  3649. (if (org-export-table-row-in-header-p row info) 'yes 'no)) info))))
  3650. ;; Nil when there is no header.
  3651. (should
  3652. (equal
  3653. '(no no)
  3654. (org-test-with-parsed-data "| a |\n| b |"
  3655. (org-element-map tree 'table-row
  3656. (lambda (row)
  3657. (if (org-export-table-row-in-header-p row info) 'yes 'no)) info)))))
  3658. (ert-deftest test-org-export/table-row-starts-header-p ()
  3659. "Test `org-export-table-row-starts-header-p' specifications."
  3660. ;; 1. Only the row starting the first row group starts the table
  3661. ;; header.
  3662. (org-test-with-parsed-data "
  3663. | a |
  3664. | b |
  3665. |---|
  3666. | c |"
  3667. (should
  3668. (equal
  3669. '(yes no no no)
  3670. (org-element-map tree 'table-row
  3671. (lambda (row)
  3672. (if (org-export-table-row-starts-header-p row info) 'yes 'no))
  3673. info))))
  3674. ;; 2. A row cannot start an header if there's no header in the
  3675. ;; table.
  3676. (org-test-with-parsed-data "
  3677. | a |
  3678. |---|"
  3679. (should-not
  3680. (org-export-table-row-starts-header-p
  3681. (org-element-map tree 'table-row 'identity info 'first-match)
  3682. info))))
  3683. (ert-deftest test-org-export/table-row-ends-header-p ()
  3684. "Test `org-export-table-row-ends-header-p' specifications."
  3685. ;; 1. Only the row starting the first row group starts the table
  3686. ;; header.
  3687. (org-test-with-parsed-data "
  3688. | a |
  3689. | b |
  3690. |---|
  3691. | c |"
  3692. (should
  3693. (equal
  3694. '(no yes no no)
  3695. (org-element-map tree 'table-row
  3696. (lambda (row)
  3697. (if (org-export-table-row-ends-header-p row info) 'yes 'no))
  3698. info))))
  3699. ;; 2. A row cannot start an header if there's no header in the
  3700. ;; table.
  3701. (org-test-with-parsed-data "
  3702. | a |
  3703. |---|"
  3704. (should-not
  3705. (org-export-table-row-ends-header-p
  3706. (org-element-map tree 'table-row 'identity info 'first-match)
  3707. info))))
  3708. ;;; Tables of Contents
  3709. (ert-deftest test-org-export/collect-headlines ()
  3710. "Test `org-export-collect-headlines' specifications."
  3711. ;; Standard test.
  3712. (should
  3713. (= 2
  3714. (length
  3715. (org-test-with-parsed-data "* H1\n** H2"
  3716. (org-export-collect-headlines info)))))
  3717. ;; Do not collect headlines below optional argument.
  3718. (should
  3719. (= 1
  3720. (length
  3721. (org-test-with-parsed-data "* H1\n** H2"
  3722. (org-export-collect-headlines info 1)))))
  3723. ;; Never collect headlines below maximum headline level.
  3724. (should
  3725. (= 1
  3726. (length
  3727. (org-test-with-parsed-data "#+OPTIONS: H:1\n* H1\n** H2"
  3728. (org-export-collect-headlines info)))))
  3729. (should
  3730. (= 1
  3731. (length
  3732. (org-test-with-parsed-data "#+OPTIONS: H:1\n* H1\n** H2"
  3733. (org-export-collect-headlines info 2)))))
  3734. ;; Collect headlines locally.
  3735. (should
  3736. (= 2
  3737. (org-test-with-parsed-data "* H1\n** H2\n** H3"
  3738. (let ((scope (org-element-map tree 'headline #'identity info t)))
  3739. (length (org-export-collect-headlines info nil scope))))))
  3740. ;; When collecting locally, optional level is relative.
  3741. (should
  3742. (= 1
  3743. (org-test-with-parsed-data "* H1\n** H2\n*** H3"
  3744. (let ((scope (org-element-map tree 'headline #'identity info t)))
  3745. (length (org-export-collect-headlines info 1 scope)))))))
  3746. ;;; Templates
  3747. (ert-deftest test-org-export/inner-template ()
  3748. "Test `inner-template' translator specifications."
  3749. (should
  3750. (equal "Success!"
  3751. (org-test-with-temp-text "* Headline"
  3752. (org-export-as
  3753. (org-export-create-backend
  3754. :transcoders
  3755. '((inner-template . (lambda (contents info) "Success!"))
  3756. (headline . (lambda (h c i) "Headline"))))))))
  3757. ;; Inner template is applied even in a "body-only" export.
  3758. (should
  3759. (equal "Success!"
  3760. (org-test-with-temp-text "* Headline"
  3761. (org-export-as
  3762. (org-export-create-backend
  3763. :transcoders '((inner-template . (lambda (c i) "Success!"))
  3764. (headline . (lambda (h c i) "Headline"))))
  3765. nil nil 'body-only)))))
  3766. (ert-deftest test-org-export/template ()
  3767. "Test `template' translator specifications."
  3768. (should
  3769. (equal "Success!"
  3770. (org-test-with-temp-text "* Headline"
  3771. (org-export-as
  3772. (org-export-create-backend
  3773. :transcoders '((template . (lambda (contents info) "Success!"))
  3774. (headline . (lambda (h c i) "Headline"))))))))
  3775. ;; Template is not applied in a "body-only" export.
  3776. (should-not
  3777. (equal "Success!"
  3778. (org-test-with-temp-text "* Headline"
  3779. (org-export-as
  3780. (org-export-create-backend
  3781. :transcoders '((template . (lambda (contents info) "Success!"))
  3782. (headline . (lambda (h c i) "Headline"))))
  3783. nil nil 'body-only)))))
  3784. ;;; Topology
  3785. (ert-deftest test-org-export/get-next-element ()
  3786. "Test `org-export-get-next-element' specifications."
  3787. ;; Standard test.
  3788. (should
  3789. (equal "b"
  3790. (org-test-with-parsed-data "* Headline\n*a* b"
  3791. (org-export-get-next-element
  3792. (org-element-map tree 'bold 'identity info t) info))))
  3793. ;; Return nil when no previous element.
  3794. (should-not
  3795. (org-test-with-parsed-data "* Headline\na *b*"
  3796. (org-export-get-next-element
  3797. (org-element-map tree 'bold 'identity info t) info)))
  3798. ;; Non-exportable elements are ignored.
  3799. (should-not
  3800. (let ((org-export-with-timestamps nil))
  3801. (org-test-with-parsed-data "\alpha <2012-03-29 Thu>"
  3802. (org-export-get-next-element
  3803. (org-element-map tree 'entity 'identity info t) info))))
  3804. ;; Find next element in secondary strings.
  3805. (should
  3806. (eq 'verbatim
  3807. (org-test-with-parsed-data "* a =verb="
  3808. (org-element-type
  3809. (org-export-get-next-element
  3810. (org-element-map tree 'plain-text 'identity info t) info)))))
  3811. (should
  3812. (eq 'verbatim
  3813. (org-test-with-parsed-data "* /italic/ =verb="
  3814. (org-element-type
  3815. (org-export-get-next-element
  3816. (org-element-map tree 'italic 'identity info t) info)))))
  3817. ;; Find next element in document keywords.
  3818. (should
  3819. (eq 'verbatim
  3820. (org-test-with-parsed-data "#+TITLE: a =verb="
  3821. (org-element-type
  3822. (org-export-get-next-element
  3823. (org-element-map
  3824. (plist-get info :title) 'plain-text 'identity info t) info)))))
  3825. ;; Find next element in parsed affiliated keywords.
  3826. (should
  3827. (eq 'verbatim
  3828. (org-test-with-parsed-data "#+CAPTION: a =verb=\nParagraph"
  3829. (org-element-type
  3830. (org-export-get-next-element
  3831. (org-element-map tree 'plain-text 'identity info t nil t) info)))))
  3832. ;; With optional argument N, return a list containing all the
  3833. ;; following elements.
  3834. (should
  3835. (equal
  3836. '(bold code underline)
  3837. (org-test-with-parsed-data "_a_ /b/ *c* ~d~ _e_"
  3838. (mapcar 'car
  3839. (org-export-get-next-element
  3840. (org-element-map tree 'italic 'identity info t) info t)))))
  3841. ;; When N is a positive integer, return a list containing up to
  3842. ;; N following elements.
  3843. (should
  3844. (equal
  3845. '(bold code)
  3846. (org-test-with-parsed-data "_a_ /b/ *c* ~d~ _e_"
  3847. (mapcar 'car
  3848. (org-export-get-next-element
  3849. (org-element-map tree 'italic 'identity info t) info 2))))))
  3850. (ert-deftest test-org-export/get-previous-element ()
  3851. "Test `org-export-get-previous-element' specifications."
  3852. ;; Standard test.
  3853. (should
  3854. (equal "a "
  3855. (org-test-with-parsed-data "* Headline\na *b*"
  3856. (org-export-get-previous-element
  3857. (org-element-map tree 'bold 'identity info t) info))))
  3858. ;; Return nil when no previous element.
  3859. (should-not
  3860. (org-test-with-parsed-data "* Headline\n*a* b"
  3861. (org-export-get-previous-element
  3862. (org-element-map tree 'bold 'identity info t) info)))
  3863. ;; Non-exportable elements are ignored.
  3864. (should-not
  3865. (let ((org-export-with-timestamps nil))
  3866. (org-test-with-parsed-data "<2012-03-29 Thu> \alpha"
  3867. (org-export-get-previous-element
  3868. (org-element-map tree 'entity 'identity info t) info))))
  3869. ;; Find previous element in secondary strings.
  3870. (should
  3871. (eq 'verbatim
  3872. (org-test-with-parsed-data "* =verb= a"
  3873. (org-element-type
  3874. (org-export-get-previous-element
  3875. (org-element-map tree 'plain-text 'identity info t) info)))))
  3876. (should
  3877. (eq 'verbatim
  3878. (org-test-with-parsed-data "* =verb= /italic/"
  3879. (org-element-type
  3880. (org-export-get-previous-element
  3881. (org-element-map tree 'italic 'identity info t) info)))))
  3882. ;; Find previous element in document keywords.
  3883. (should
  3884. (eq 'verbatim
  3885. (org-test-with-parsed-data "#+TITLE: =verb= a"
  3886. (org-element-type
  3887. (org-export-get-previous-element
  3888. (org-element-map
  3889. (plist-get info :title) 'plain-text 'identity info t) info)))))
  3890. ;; Find previous element in parsed affiliated keywords.
  3891. (should
  3892. (eq 'verbatim
  3893. (org-test-with-parsed-data "#+CAPTION: =verb= a\nParagraph"
  3894. (org-element-type
  3895. (org-export-get-previous-element
  3896. (org-element-map tree 'plain-text 'identity info t nil t) info)))))
  3897. ;; With optional argument N, return a list containing up to
  3898. ;; N previous elements.
  3899. (should
  3900. (equal '(underline italic bold)
  3901. (org-test-with-parsed-data "_a_ /b/ *c* ~d~"
  3902. (mapcar 'car
  3903. (org-export-get-previous-element
  3904. (org-element-map tree 'code 'identity info t) info t)))))
  3905. ;; When N is a positive integer, return a list containing up to
  3906. ;; N previous elements.
  3907. (should
  3908. (equal '(italic bold)
  3909. (org-test-with-parsed-data "_a_ /b/ *c* ~d~"
  3910. (mapcar 'car
  3911. (org-export-get-previous-element
  3912. (org-element-map tree 'code 'identity info t) info 2))))))
  3913. (provide 'test-ox)
  3914. ;;; test-org-export.el end here