123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344 |
- ;;; test-org-element.el --- Tests for org-element.el -*- lexical-binding: t; -*-
- ;; Copyright (C) 2012-2015, 2019 Nicolas Goaziou
- ;; Author: Nicolas Goaziou <n.goaziou at gmail dot com>
- ;; This program is free software; you can redistribute it and/or modify
- ;; it under the terms of the GNU General Public License as published by
- ;; the Free Software Foundation, either version 3 of the License, or
- ;; (at your option) any later version.
- ;; This program is distributed in the hope that it will be useful,
- ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
- ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- ;; GNU General Public License for more details.
- ;; You should have received a copy of the GNU General Public License
- ;; along with this program. If not, see <https://www.gnu.org/licenses/>.
- ;;; Code:
- (eval-and-compile (require 'cl-lib))
- (require 'org-element)
- (require 'org)
- (require 'org-inlinetask)
- (defun org-test-parse-and-interpret (text)
- "Parse TEXT as Org syntax and interpret it.
- Return interpreted string."
- (with-temp-buffer
- (org-mode)
- (insert text)
- (org-element-interpret-data (org-element-parse-buffer))))
- ;;; Test `org-element-map'
- (ert-deftest test-org-element/map ()
- "Test `org-element-map'."
- ;; Can map to `plain-text' objects.
- (should
- (= 2
- (org-test-with-temp-text "Some text \alpha
- #+BEGIN_CENTER
- Some other text
- #+END_CENTER"
- (let ((count 0))
- (org-element-map
- (org-element-parse-buffer) 'plain-text
- (lambda (s) (when (string-match "text" s) (cl-incf count))))
- count))))
- ;; Applies to secondary strings
- (should
- (org-element-map '("some " (bold nil "bold") "text") 'bold 'identity))
- ;; Enter secondary strings before entering contents.
- (should
- (equal
- "alpha"
- (org-element-property
- :name
- (org-test-with-temp-text "* Some \\alpha headline\n\\beta entity."
- (org-element-map (org-element-parse-buffer) 'entity 'identity nil t)))))
- ;; Apply NO-RECURSION argument.
- (should-not
- (org-test-with-temp-text "#+BEGIN_CENTER\n\\alpha\n#+END_CENTER"
- (org-element-map
- (org-element-parse-buffer) 'entity 'identity nil nil 'center-block)))
- ;; Use WITH-AFFILIATED argument.
- (should
- (equal
- '("a" "1" "b" "2")
- (org-test-with-temp-text "#+CAPTION[a]: 1\n#+CAPTION[b]: 2\nParagraph"
- (org-element-map
- (org-element-at-point) 'plain-text 'identity nil nil nil t)))))
- ;;; Test Setters
- (ert-deftest test-org-element/put-property ()
- "Test `org-element-put-property' specifications."
- ;; Standard test.
- (org-test-with-temp-text "* Headline\n *a*"
- (let ((tree (org-element-parse-buffer)))
- (org-element-put-property
- (org-element-map tree 'bold 'identity nil t) :test 1)
- (should (org-element-property
- :test (org-element-map tree 'bold 'identity nil t)))))
- ;; Put property on a string.
- (should
- (org-element-property :test (org-element-put-property "Paragraph" :test t))))
- (ert-deftest test-org-element/set-contents ()
- "Test `org-element-set-contents' specifications."
- ;; Accept multiple entries.
- (should
- (equal '("b" (italic nil "a"))
- (org-test-with-temp-text "* Headline\n *a*"
- (let ((tree (org-element-parse-buffer)))
- (org-element-set-contents
- (org-element-map tree 'bold 'identity nil t) "b" '(italic nil "a"))
- (org-element-contents
- (org-element-map tree 'bold 'identity nil t))))))
- ;; Accept atoms and elements.
- (should
- (equal '("b")
- (org-test-with-temp-text "* Headline\n *a*"
- (let ((tree (org-element-parse-buffer)))
- (org-element-set-contents
- (org-element-map tree 'bold 'identity nil t) "b")
- (org-element-contents
- (org-element-map tree 'bold 'identity nil t))))))
- (should
- (equal '((italic nil "b"))
- (org-test-with-temp-text "* Headline\n *a*"
- (let ((tree (org-element-parse-buffer)))
- (org-element-set-contents
- (org-element-map tree 'bold 'identity nil t) '(italic nil "b"))
- (org-element-contents
- (org-element-map tree 'bold 'identity nil t))))))
- ;; Allow nil contents.
- (should-not
- (org-test-with-temp-text "* Headline\n *a*"
- (let ((tree (org-element-parse-buffer)))
- (org-element-set-contents (org-element-map tree 'bold 'identity nil t))
- (org-element-contents (org-element-map tree 'bold 'identity nil t))))))
- (ert-deftest test-org-element/secondary-p ()
- "Test `org-element-secondary-p' specifications."
- ;; In a secondary string, return property name.
- (should
- (eq :title
- (org-test-with-temp-text "* Headline *object*"
- (org-element-map (org-element-parse-buffer) 'bold
- (lambda (object) (org-element-secondary-p object))
- nil t))))
- ;; Outside a secondary string, return nil.
- (should-not
- (org-test-with-temp-text "Paragraph *object*"
- (org-element-map (org-element-parse-buffer) 'bold
- (lambda (object) (org-element-type (org-element-secondary-p object)))
- nil t))))
- ;; FIXME: `org-element-class' is a defsubst and cannot be tested
- ;; properly (i.e., "make test" fails).
- ;;
- ;; (ert-deftest test-org-element/class ()
- ;; "Test `org-element-class' specifications."
- ;; ;; Regular tests.
- ;; (should (eq 'element (org-element-class '(paragraph nil) nil)))
- ;; (should (eq 'object (org-element-class '(target nil) nil)))
- ;; ;; Special types.
- ;; (should (eq 'element (org-element-class '(org-data nil) nil)))
- ;; (should (eq 'object (org-element-class "text" nil)))
- ;; (should (eq 'object (org-element-class '("secondary " "string") nil)))
- ;; ;; Pseudo elements.
- ;; (should (eq 'element (org-element-class '(foo nil) nil)))
- ;; (should (eq 'element (org-element-class '(foo nil) '(center-block nil))))
- ;; (should (eq 'element (org-element-class '(foo nil) '(org-data nil))))
- ;; ;; Pseudo objects.
- ;; (should (eq 'object (org-element-class '(foo nil) '(bold nil))))
- ;; (should (eq 'object (org-element-class '(foo nil) '(paragraph nil))))
- ;; (should (eq 'object (org-element-class '(foo nil) '("secondary"))))
- ;; (should
- ;; (eq 'object
- ;; (let* ((datum '(foo nil))
- ;; (headline `(headline (:title (,datum)))))
- ;; (org-element-put-property datum :parent headline)
- ;; (org-element-class datum)))))
- (ert-deftest test-org-element/adopt-elements ()
- "Test `org-element-adopt-elements' specifications."
- ;; Adopt an element.
- (should
- (equal '(plain-text italic)
- (org-test-with-temp-text "* Headline\n *a*"
- (let ((tree (org-element-parse-buffer)))
- (org-element-adopt-elements
- (org-element-map tree 'bold 'identity nil t) '(italic nil "a"))
- (mapcar (lambda (blob) (org-element-type blob))
- (org-element-contents
- (org-element-map tree 'bold 'identity nil t)))))))
- ;; Adopt a string.
- (should
- (equal '("a" "b")
- (org-test-with-temp-text "* Headline\n *a*"
- (let ((tree (org-element-parse-buffer)))
- (org-element-adopt-elements
- (org-element-map tree 'bold 'identity nil t) "b")
- (org-element-contents
- (org-element-map tree 'bold 'identity nil t)))))))
- (ert-deftest test-org-element/extract-element ()
- "Test `org-element-extract-element' specifications."
- ;; Extract a greater element.
- (should
- (eq 'org-data
- (org-test-with-temp-text "* Headline"
- (let* ((tree (org-element-parse-buffer))
- (element (org-element-map tree 'headline 'identity nil t)))
- (org-element-extract-element element)
- (org-element-type tree)))))
- ;; Extract an element.
- (should-not
- (org-element-map
- (org-test-with-temp-text "Paragraph"
- (let* ((tree (org-element-parse-buffer))
- (element (org-element-map tree 'paragraph 'identity nil t)))
- (org-element-extract-element element)
- tree))
- 'paragraph
- 'identity))
- ;; Extract an object, even in a secondary string.
- (should-not
- (org-element-map
- (org-test-with-temp-text "*bold*"
- (let* ((tree (org-element-parse-buffer))
- (element (org-element-map tree 'bold 'identity nil t)))
- (org-element-extract-element element)
- tree))
- 'bold
- 'identity))
- (should-not
- (org-element-map
- (org-test-with-temp-text "* Headline *bold*"
- (let* ((tree (org-element-parse-buffer))
- (element (org-element-map tree 'bold 'identity nil t)))
- (org-element-extract-element element)
- tree))
- 'bold
- 'identity))
- ;; Return value doesn't have any :parent set.
- (should-not
- (org-element-property
- :parent
- (org-test-with-temp-text "* Headline\n Paragraph with *bold* text."
- (let* ((tree (org-element-parse-buffer))
- (element (org-element-map tree 'bold 'identity nil t)))
- (org-element-extract-element element))))))
- (ert-deftest test-org-element/insert-before ()
- "Test `org-element-insert-before' specifications."
- ;; Standard test.
- (should
- (equal
- '(italic entity bold)
- (org-test-with-temp-text "/some/ *paragraph*"
- (let* ((tree (org-element-parse-buffer))
- (_paragraph (org-element-map tree 'paragraph #'identity nil t))
- (bold (org-element-map tree 'bold 'identity nil t)))
- (org-element-insert-before '(entity (:name "\\alpha")) bold)
- (org-element-map tree '(bold entity italic) #'org-element-type nil)))))
- ;; Insert an object in a secondary string.
- (should
- (equal
- '(entity italic)
- (org-test-with-temp-text "* /A/\n Paragraph."
- (let* ((tree (org-element-parse-buffer))
- (headline (org-element-map tree 'headline 'identity nil t))
- (italic (org-element-map tree 'italic 'identity nil t)))
- (org-element-insert-before '(entity (:name "\\alpha")) italic)
- (org-element-map (org-element-property :title headline) '(entity italic)
- #'org-element-type))))))
- (ert-deftest test-org-element/set-element ()
- "Test `org-element-set-element' specifications."
- ;; Check if new element is inserted.
- (should
- (org-test-with-temp-text "* Headline\n*a*"
- (let* ((tree (org-element-parse-buffer))
- (bold (org-element-map tree 'bold 'identity nil t)))
- (org-element-set-element bold '(italic nil "b"))
- (org-element-map tree 'italic 'identity))))
- ;; Check if old element is removed.
- (should-not
- (org-test-with-temp-text "* Headline\n*a*"
- (let* ((tree (org-element-parse-buffer))
- (bold (org-element-map tree 'bold 'identity nil t)))
- (org-element-set-element bold '(italic nil "b"))
- (org-element-map tree 'bold 'identity))))
- ;; Check if :parent property is correctly set.
- (should
- (eq 'paragraph
- (org-test-with-temp-text "* Headline\n*a*"
- (let* ((tree (org-element-parse-buffer))
- (bold (org-element-map tree 'bold 'identity nil t)))
- (org-element-set-element bold '(italic nil "b"))
- (org-element-type
- (org-element-property
- :parent (org-element-map tree 'italic 'identity nil t)))))))
- ;; Allow to replace strings with elements.
- (should
- (equal '("b")
- (org-test-with-temp-text "* Headline"
- (let* ((tree (org-element-parse-buffer))
- (text (org-element-map tree 'plain-text 'identity nil t)))
- (org-element-set-element text (list 'bold nil "b"))
- (org-element-map tree 'plain-text 'identity)))))
- ;; Allow to replace elements with strings.
- (should
- (equal "a"
- (org-test-with-temp-text "* =verbatim="
- (let* ((tree (org-element-parse-buffer))
- (verb (org-element-map tree 'verbatim 'identity nil t)))
- (org-element-set-element verb "a")
- (org-element-map tree 'plain-text 'identity nil t)))))
- ;; Allow to replace strings with strings.
- (should
- (equal "b"
- (org-test-with-temp-text "a"
- (let* ((tree (org-element-parse-buffer))
- (text (org-element-map tree 'plain-text 'identity nil t)))
- (org-element-set-element text "b")
- (org-element-map tree 'plain-text 'identity nil t))))))
- (ert-deftest test-org-element/copy ()
- "Test `org-element-copy' specifications."
- ;; Preserve type.
- (should (eq 'bold
- (org-test-with-temp-text "*bold*"
- (org-element-type (org-element-copy (org-element-context))))))
- (should (eq 'plain-text
- (org-test-with-temp-text "*bold*"
- (org-element-type
- (org-element-map (org-element-parse-buffer) 'plain-text
- #'org-element-copy nil t)))))
- ;; Preserve properties except `:parent'.
- (should (= 7
- (org-test-with-temp-text "*bold*"
- (org-element-property
- :end (org-element-copy (org-element-context))))))
- (should-not
- (org-test-with-temp-text "*bold*"
- (org-element-property
- :parent (org-element-copy (org-element-context)))))
- (should-not
- (org-test-with-temp-text "*bold*"
- (org-element-property
- :parent
- (org-element-map (org-element-parse-buffer) 'plain-text
- #'org-element-copy nil t))))
- ;; Copying nil returns nil.
- (should-not (org-element-copy nil))
- ;; Return a copy secondary strings.
- (should (equal '("text") (org-element-copy '("text"))))
- (should-not (eq '("text") (org-element-copy '("text")))))
- ;;; Test Parsers
- ;;;; Affiliated Keywords
- (ert-deftest test-org-element/affiliated-keywords-parser ()
- "Test affiliated keywords parsing."
- ;; Read simple keywords.
- (should
- (equal "para"
- (org-element-property
- :name
- (org-test-with-temp-text "#+NAME: para\nParagraph"
- (org-element-at-point)))))
- (should
- (= 1
- (org-element-property
- :begin
- (org-test-with-temp-text "#+NAME: para\nParagraph"
- (org-element-at-point)))))
- ;; Parse multiple keywords.
- (should
- (equal
- '("line2" "line1")
- (org-element-property
- :attr_ascii
- (org-test-with-temp-text
- "#+ATTR_ASCII: line1\n#+ATTR_ASCII: line2\nParagraph"
- (org-element-at-point)))))
- ;; Parse "parsed" keywords, unless granularity prevents it.
- (should
- (equal
- '(("caption"))
- (org-test-with-temp-text "#+CAPTION: caption\nParagraph"
- (car (org-element-property :caption (org-element-at-point))))))
- (should
- (org-test-with-temp-text "#+CAPTION: *caption*\nParagraph"
- (org-element-map (org-element-map (org-element-parse-buffer)
- 'paragraph
- (lambda (e) (org-element-property :caption e)) nil t)
- 'bold
- #'org-element-type nil t)))
- (should-not
- (org-test-with-temp-text "#+CAPTION: *caption*\nParagraph"
- (org-element-map (org-element-map (org-element-parse-buffer 'element)
- 'paragraph
- (lambda (e) (org-element-property :caption e)) nil t)
- 'bold
- #'org-element-type nil t)))
- ;; Parse dual keywords.
- (should
- (equal
- '((("long") "short"))
- (org-test-with-temp-text "#+CAPTION[short]: long\nParagraph"
- (org-element-property :caption (org-element-at-point)))))
- ;; Allow multiple caption keywords.
- (should
- (equal
- '((("l2") "s2") (("l1") "s1"))
- (org-test-with-temp-text "#+CAPTION[s1]: l1\n#+CAPTION[s2]: l2\nParagraph"
- (org-element-property :caption (org-element-at-point)))))
- (should
- (equal
- '((("l1")) (nil "s1"))
- (org-test-with-temp-text "#+CAPTION[s1]:\n#+CAPTION: l1\nParagraph"
- (org-element-property :caption (org-element-at-point)))))
- ;; Corner case: orphaned keyword at the end of an element.
- (should
- (eq 'keyword
- (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
- (progn (search-forward "name")
- (org-element-type (org-element-at-point))))))
- (should-not
- (org-test-with-temp-text "- item\n #+name: name\nSome paragraph"
- (progn (search-forward "Some")
- (org-element-property :name (org-element-at-point))))))
- ;;;; Babel Call
- (ert-deftest test-org-element/babel-call-parser ()
- "Test `babel-call' parsing."
- ;; Standard test.
- (should
- (eq 'babel-call
- (org-test-with-temp-text "#+CALL: test()"
- (org-element-type (org-element-at-point)))))
- ;; Ignore case.
- (should
- (eq 'babel-call
- (org-test-with-temp-text "#+call: test()"
- (org-element-type (org-element-at-point)))))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "#+CALL: test()\n "
- (= (org-element-property :end (org-element-at-point)) (point-max))))
- ;; Parse call name.
- (should
- (equal "test"
- (org-test-with-temp-text "#+CALL: test()"
- (org-element-property :call (org-element-at-point)))))
- ;; Parse inside header. It may contain paired square brackets.
- (should
- (equal ":results output"
- (org-test-with-temp-text "#+CALL: test[:results output]()"
- (org-element-property :inside-header (org-element-at-point)))))
- (should
- (equal ":results output, a=table[1:2], b=2"
- (org-test-with-temp-text
- "#+CALL: test[:results output, a=table[1:2], b=2]()"
- (org-element-property :inside-header (org-element-at-point)))))
- ;; Parse arguments, which can be nested. However, stop at paired
- ;; parenthesis, even when, e.g.,end header contains some.
- (should
- (equal "n=4"
- (org-test-with-temp-text "#+CALL: test(n=4)"
- (org-element-property :arguments (org-element-at-point)))))
- (should
- (equal "test()"
- (org-test-with-temp-text "#+CALL: test(test())"
- (org-element-property :arguments (org-element-at-point)))))
- (should
- (equal "a=1"
- (org-test-with-temp-text "#+CALL: test(a=1) :post another-call()"
- (org-element-property :arguments (org-element-at-point)))))
- ;; Parse end header.
- (should
- (equal ":results html"
- (org-test-with-temp-text "#+CALL: test() :results html"
- (org-element-property :end-header (org-element-at-point))))))
- ;;;; Bold
- (ert-deftest test-org-element/bold-parser ()
- "Test `bold' parser."
- ;; Standard test.
- (should
- (org-test-with-temp-text "*bold*"
- (org-element-map (org-element-parse-buffer) 'bold #'identity nil t)))
- ;; Multi-line markup.
- (should
- (equal
- (org-element-contents
- (org-test-with-temp-text "*first line\nsecond line*"
- (org-element-map (org-element-parse-buffer) 'bold #'identity nil t)))
- '("first line\nsecond line"))))
- ;;;; Center Block
- (ert-deftest test-org-element/center-block-parser ()
- "Test `center-block' parser."
- ;; Standard test.
- (should
- (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
- (org-element-map (org-element-parse-buffer) 'center-block 'identity)))
- ;; Ignore case.
- (should
- (org-test-with-temp-text "#+begin_center\nText\n#+end_center"
- (org-element-map (org-element-parse-buffer) 'center-block 'identity)))
- ;; Ignore incomplete block.
- (should-not
- (org-test-with-temp-text "#+BEGIN_CENTER"
- (org-element-map (org-element-parse-buffer) 'center-block
- 'identity nil t)))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
- (= (org-element-property :end (org-element-at-point)) (point-max)))))
- ;;;; Citation
- (ert-deftest test-org-element/citation-parser ()
- "Test `citation' parser"
- ;; Parse citations. They must contain at least a bare key.
- (should
- (eq 'citation
- (org-test-with-temp-text "[cite:@key]"
- (org-element-type (org-element-context)))))
- (should-not
- (eq 'citation
- (org-test-with-temp-text "[cite:text]"
- (org-element-type (org-element-context)))))
- ;; Citation may contain a style.
- (should
- (eq 'citation
- (org-test-with-temp-text "[cite/style:@key]"
- (org-element-type (org-element-context)))))
- (should
- (equal "style"
- (org-test-with-temp-text "[cite/style:@key]"
- (org-element-property :style (org-element-context)))))
- ;; Handle multi citations separated with semi-columns.
- (should
- (eq 'citation
- (org-test-with-temp-text "[cite:@a;@b;@c]"
- (org-element-type (org-element-context)))))
- (should
- (equal '("a" "b" "c")
- (org-test-with-temp-text "[cite:@a;@b;@c]"
- (org-element-map (org-element-parse-buffer) 'citation-reference
- (lambda (r) (org-element-property :key r))))))
- (should
- (eq 'citation
- (org-test-with-temp-text "[cite:@a;-@b]"
- (org-element-type (org-element-context)))))
- (should
- (equal '("a" "b")
- (org-test-with-temp-text "[cite:@a;-@b]"
- (org-element-map (org-element-parse-buffer) 'citation-reference
- (lambda (r) (org-element-property :key r))))))
- ;; Multi citations accept `:prefix' and `:suffix' properties.
- (should
- (equal '("common-prefix")
- (org-test-with-temp-text "[cite:common-prefix;@a]"
- (org-element-property :prefix (org-element-context)))))
- (should
- (equal '("common-suffix")
- (org-test-with-temp-text "[cite:@a;common-suffix]"
- (org-element-property :suffix (org-element-context)))))
- ;; White spaces right after "cite" tags are ignored. So are white
- ;; spaces at the end of the citation.
- (should
- (equal '("common-prefix ")
- (org-test-with-temp-text "[cite: common-prefix ;@a]"
- (org-element-property :prefix (org-element-context)))))
- (should
- (equal '(" common-suffix")
- (org-test-with-temp-text "[cite: @a; common-suffix ]"
- (org-element-property :suffix (org-element-context)))))
- ;; Allow citations in a table cell.
- (should
- (eq 'citation
- (org-test-with-temp-text "| <point>[cite:@key] |"
- (org-element-type (org-element-context))))))
- ;;;; Citation Reference
- (ert-deftest test-org-element/citation-reference-parser ()
- "Test `citation' reference parser."
- ;; Parse bare keys.
- (should
- (eq 'citation-reference
- (org-test-with-temp-text "[cite:<point>@key]"
- (org-element-type (org-element-context)))))
- ;; Bare keys can contain any word character, and some punctuation,
- ;; but not semicolon, square brackets, and space.
- (should
- (equal "_key"
- (org-test-with-temp-text "[cite:@_k<point>ey]"
- (org-element-property :key (org-element-context)))))
- (should
- (eq 'citation-reference
- (org-test-with-temp-text "[cite:<point>@a]"
- (org-element-type (org-element-context)))))
- (should
- (eq 'citation-reference
- (org-test-with-temp-text "[cite:<point>@ö]"
- (org-element-type (org-element-context)))))
- (should
- (eq 'citation-reference
- (org-test-with-temp-text "[cite:<point>@_]"
- (org-element-type (org-element-context)))))
- (should
- (equal "a:.#$%&-+?<>~/1"
- (org-test-with-temp-text "[cite:<point>@a:.#$%&-+?<>~/1]"
- (org-element-property :key (org-element-context)))))
- (should-not
- (eq 'citation-reference
- (org-test-with-temp-text "[cite:<point>@;]"
- (org-element-type (org-element-context)))))
- (should-not
- (equal "key"
- (org-test-with-temp-text "[cite:<point>@[]]"
- (org-element-property :key (org-element-context)))))
- ;; References in citations accept optional `:prefix' and `:suffix'
- ;; properties.
- (should
- (equal '("pre ")
- (org-test-with-temp-text "[cite:pre <point>@key]"
- (org-element-property :prefix (org-element-context)))))
- (should
- (equal '(" post")
- (org-test-with-temp-text "[cite:<point>@key post]"
- (org-element-property :suffix (org-element-context)))))
- ;; White spaces between "cite" tag and prefix are ignored.
- (should
- (equal '("pre ")
- (org-test-with-temp-text "[cite: pre <point>@key]"
- (org-element-property :prefix (org-element-context)))))
- ;; Semicolons do not belong to prefix or suffix.
- (should
- (equal '("pre ")
- (org-test-with-temp-text "[cite:@key1;pre <point>@key2]"
- (org-element-property :prefix (org-element-context)))))
- (should
- (equal '(" post")
- (org-test-with-temp-text "[cite:@key1 <point>post;@key2]"
- (org-element-property :suffix (org-element-context)))))
- (should
- (equal '("pre ")
- (org-test-with-temp-text "[cite:global prefix;pre<point> @key1]"
- (org-element-property :prefix (org-element-context)))))
- (should
- (equal '(" post")
- (org-test-with-temp-text "[cite:@key1 <point>post; global suffix]"
- (org-element-property :suffix (org-element-context))))))
- ;;;; Clock
- (ert-deftest test-org-element/clock-parser ()
- "Test `clock' parser."
- ;; Running clock.
- (let ((clock (org-test-with-temp-text "CLOCK: [2012-01-01 sun. 00:01]"
- (org-element-at-point))))
- (should (eq (org-element-property :status clock) 'running))
- (should
- (equal (org-element-property :raw-value
- (org-element-property :value clock))
- "[2012-01-01 sun. 00:01]"))
- (should-not (org-element-property :duration clock)))
- ;; Closed clock.
- (let ((clock
- (org-test-with-temp-text
- "CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"
- (org-element-at-point))))
- (should (eq (org-element-property :status clock) 'closed))
- (should (equal (org-element-property :raw-value
- (org-element-property :value clock))
- "[2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02]"))
- (should (equal (org-element-property :duration clock) "0:01"))))
- ;;;; Code
- (ert-deftest test-org-element/code-parser ()
- "Test `code' parser."
- ;; Regular test.
- (should
- (org-test-with-temp-text "~code~"
- (org-element-map (org-element-parse-buffer) 'code #'identity)))
- ;; Multi-line markup.
- (should
- (equal
- (org-element-property
- :value
- (org-test-with-temp-text "~first line\nsecond line~"
- (org-element-map
- (org-element-parse-buffer) 'code #'identity nil t)))
- "first line\nsecond line")))
- ;;;; Comment
- (ert-deftest test-org-element/comment-parser ()
- "Test `comment' parser."
- ;; Regular comment.
- (should (eq 'comment
- (org-test-with-temp-text "# Comment"
- (org-element-type (org-element-at-point)))))
- ;; Inline comment.
- (should (eq 'comment
- (org-test-with-temp-text " # Comment"
- (org-element-type (org-element-at-point)))))
- ;; Preserve indentation.
- (should
- (equal "No blank\n One blank"
- (org-element-property
- :value
- (org-test-with-temp-text "# No blank\n# One blank"
- (org-element-at-point)))))
- ;; Comment with blank lines.
- (should
- (equal "First part\n\n\nSecond part"
- (org-element-property
- :value
- (org-test-with-temp-text "# First part\n# \n#\n# Second part"
- (org-element-at-point)))))
- ;; Do not mix comments and keywords.
- (should
- (eq 1
- (org-test-with-temp-text "#+keyword: value\n# comment\n#+keyword: value"
- (length (org-element-map (org-element-parse-buffer) 'comment
- #'identity)))))
- (should
- (equal "comment"
- (org-test-with-temp-text
- "#+key: value\n<point># comment\n#+key: value"
- (org-element-property :value (org-element-at-point)))))
- ;; Correctly handle non-empty blank lines at the end of buffer.
- (should
- (org-test-with-temp-text "# A\n "
- (= (org-element-property :end (org-element-at-point)) (point-max)))))
- ;;;; Comment Block
- (ert-deftest test-org-element/comment-block-parser ()
- "Test `comment-block' parser."
- ;; Standard test.
- (should
- (org-test-with-temp-text "#+BEGIN_COMMENT\nText\n#+END_COMMENT"
- (org-element-map (org-element-parse-buffer) 'comment-block 'identity)))
- ;; Ignore case.
- (should
- (org-test-with-temp-text "#+begin_comment\nText\n#+end_comment"
- (org-element-map (org-element-parse-buffer) 'comment-block 'identity)))
- ;; Ignore incomplete block.
- (should-not
- (org-test-with-temp-text "#+BEGIN_COMMENT"
- (org-element-map (org-element-parse-buffer) 'comment-block
- 'identity nil t)))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "#+BEGIN_COMMENT\nC\n#+END_COMMENT\n "
- (= (org-element-property :end (org-element-at-point)) (point-max)))))
- ;;;; Diary Sexp
- (ert-deftest test-org-element/diary-sexp-parser ()
- "Test `diary-sexp' parser."
- ;; Standard test.
- (should
- (eq 'diary-sexp
- (org-test-with-temp-text
- "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old"
- (org-element-type (org-element-at-point)))))
- ;; Diary sexp must live at beginning of line
- (should-not
- (eq 'diary-sexp
- (org-test-with-temp-text " %%(org-bbdb-anniversaries)"
- (org-element-type (org-element-at-point)))))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "%%(org-bbdb-anniversaries)\n "
- (= (org-element-property :end (org-element-at-point)) (point-max)))))
- ;;;; Drawer
- (ert-deftest test-org-element/drawer-parser ()
- "Test `drawer' parser."
- ;; Standard test.
- (should
- (org-test-with-temp-text ":TEST:\nText\n:END:"
- (org-element-map (org-element-parse-buffer) 'drawer 'identity)))
- ;; Ignore incomplete drawer.
- (should-not
- (org-test-with-temp-text ":TEST:"
- (org-element-map (org-element-parse-buffer) 'drawer 'identity nil t)))
- (should-not
- (org-test-with-temp-text ":END:"
- (org-element-map (org-element-parse-buffer) 'drawer 'identity nil t)))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text ":TEST:\nC\n:END:\n "
- (= (org-element-property :end (org-element-at-point)) (point-max)))))
- ;;;; Dynamic Block
- (ert-deftest test-org-element/dynamic-block-parser ()
- "Test `dynamic-block' parser."
- ;; Standard test.
- (should
- (org-test-with-temp-text
- "#+BEGIN: myblock :param1 val1 :param2 val2\nText\n#+END:"
- (org-element-map (org-element-parse-buffer) 'dynamic-block 'identity)))
- ;; Ignore case.
- (should
- (org-test-with-temp-text
- "#+begin: myblock :param1 val1 :param2 val2\nText\n#+end:"
- (org-element-map (org-element-parse-buffer) 'dynamic-block 'identity)))
- ;; Ignore incomplete block.
- (should-not
- (org-test-with-temp-text "#+BEGIN: myblock :param1 val1 :param2 val2"
- (org-element-map (org-element-parse-buffer) 'dynamic-block
- 'identity nil t)))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "#+BEGIN: myblock :param val1\nC\n#+END:\n "
- (= (org-element-property :end (org-element-at-point)) (point-max)))))
- ;;;; Entity
- (ert-deftest test-org-element/entity-parser ()
- "Test `entity' parser."
- ;; Without brackets.
- (should
- (org-test-with-temp-text "\\sin"
- (org-element-map (org-element-parse-buffer) 'entity 'identity)))
- ;; With brackets.
- (should
- (org-element-property
- :use-brackets-p
- (org-test-with-temp-text "\\alpha{}text"
- (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
- ;; User-defined entity.
- (should
- (equal
- (org-element-property
- :name
- (let ((org-entities-user
- '(("test" "test" nil "test" "test" "test" "test"))))
- (org-test-with-temp-text "\\test"
- (org-element-map (org-element-parse-buffer) 'entity 'identity nil t))))
- "test"))
- ;; Special case: entity at the end of a container.
- (should
- (eq 'entity
- (org-test-with-temp-text "*\\alpha \\beta*"
- (search-forward "be")
- (org-element-type (org-element-context))))))
- ;;;; Example Block
- (ert-deftest test-org-element/example-block-parser ()
- "Test `example-block' parser."
- ;; Standard test.
- (should
- (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText\n#+END_EXAMPLE"
- (org-element-map (org-element-parse-buffer) 'example-block 'identity)))
- ;; Ignore incomplete block.
- (should-not
- (eq 'example-block
- (org-test-with-temp-text "#+BEGIN_EXAMPLE"
- (org-element-type (org-element-at-point)))))
- ;; Properly un-escape code.
- (should
- (equal "* Headline\n #+keyword:\nText\n"
- (org-test-with-temp-text
- "#+BEGIN_EXAMPLE\n,* Headline\n ,#+keyword:\nText\n#+END_EXAMPLE"
- (org-element-property :value (org-element-at-point)))))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "#+BEGIN_EXAMPLE\nC\n#+END_EXAMPLE\n "
- (= (org-element-property :end (org-element-at-point)) (point-max)))))
- (ert-deftest test-org-element/block-switches ()
- "Test `example-block' and `src-block' switches parsing."
- (let ((org-coderef-label-format "(ref:%s)"))
- ;; 1. Test "-i" switch.
- (should-not
- (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
- (org-element-property :preserve-indent (org-element-at-point))))
- (should
- (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"
- (org-element-property :preserve-indent (org-element-at-point))))
- (should-not
- (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
- (org-element-property :preserve-indent (org-element-at-point))))
- (should
- (org-test-with-temp-text "#+BEGIN_EXAMPLE -i\nText.\n#+END_EXAMPLE"
- (org-element-property :preserve-indent (org-element-at-point))))
- ;; 2. "-n -r -k" combination should number lines, retain labels but
- ;; not use them in coderefs.
- (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r -k\nText.\n#+END_EXAMPLE"
- (let ((element (org-element-at-point)))
- (should (org-element-property :number-lines element))
- (should (org-element-property :retain-labels element))
- (should-not (org-element-property :use-labels element))))
- (org-test-with-temp-text
- "#+BEGIN_SRC emacs-lisp -n -r -k\n(+ 1 1)\n#+END_SRC"
- (let ((element (org-element-at-point)))
- (should (org-element-property :number-lines element))
- (should (org-element-property :retain-labels element))
- (should-not (org-element-property :use-labels element))))
- ;; 3. "-n -r" combination should number-lines remove labels and not
- ;; use them in coderefs.
- (org-test-with-temp-text "#+BEGIN_EXAMPLE -n -r\nText.\n#+END_EXAMPLE"
- (let ((element (org-element-at-point)))
- (should (org-element-property :number-lines element))
- (should-not (org-element-property :retain-labels element))
- (should-not (org-element-property :use-labels element))))
- (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n -r\n(+ 1 1)\n#+END_SRC"
- (let ((element (org-element-at-point)))
- (should (org-element-property :number-lines element))
- (should-not (org-element-property :retain-labels element))
- (should-not (org-element-property :use-labels element))))
- ;; 4. "-n" or "+n" should number lines, retain labels and use them
- ;; in coderefs.
- (should
- (org-test-with-temp-text "#+BEGIN_EXAMPLE -n\nText.\n#+END_EXAMPLE"
- (let ((element (org-element-at-point)))
- (and (org-element-property :number-lines element)
- (org-element-property :retain-labels element)
- (org-element-property :use-labels element)))))
- (should
- (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -n\n(+ 1 1)\n#+END_SRC"
- (let ((element (org-element-at-point)))
- (and (org-element-property :number-lines element)
- (org-element-property :retain-labels element)
- (org-element-property :use-labels element)))))
- (should
- (org-test-with-temp-text "#+BEGIN_EXAMPLE +n\nText.\n#+END_EXAMPLE"
- (let ((element (org-element-at-point)))
- (and (org-element-property :number-lines element)
- (org-element-property :retain-labels element)
- (org-element-property :use-labels element)))))
- (should
- (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp +n\n(+ 1 1)\n#+END_SRC"
- (let ((element (org-element-at-point)))
- (and (org-element-property :number-lines element)
- (org-element-property :retain-labels element)
- (org-element-property :use-labels element)))))
- ;; 5. No switch should not number lines, but retain labels and use
- ;; them in coderefs.
- (org-test-with-temp-text "#+BEGIN_EXAMPLE\nText.\n#+END_EXAMPLE"
- (let ((element (org-element-at-point)))
- (should (not (org-element-property :number-lines element)))
- (should (org-element-property :retain-labels element))
- (should (org-element-property :use-labels element))))
- (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"
- (let ((element (org-element-at-point)))
- (should (not (org-element-property :number-lines element)))
- (should (org-element-property :retain-labels element))
- (should (org-element-property :use-labels element))))
- ;; 6. "-r" switch only: do not number lines, remove labels, and
- ;; don't use labels in coderefs.
- (org-test-with-temp-text "#+BEGIN_EXAMPLE -r\nText.\n#+END_EXAMPLE"
- (let ((element (org-element-at-point)))
- (should (not (org-element-property :number-lines element)))
- (should (not (org-element-property :retain-labels element)))
- (should (not (org-element-property :use-labels element)))))
- (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp -r\n(+ 1 1)\n#+END_SRC"
- (let ((element (org-element-at-point)))
- (should (not (org-element-property :number-lines element)))
- (should (not (org-element-property :retain-labels element)))
- (should (not (org-element-property :use-labels element)))))
- ;; 7. Recognize coderefs with user-defined syntax.
- (should
- (equal
- "[ref:%s]"
- (org-test-with-temp-text
- "#+BEGIN_EXAMPLE -l \"[ref:%s]\"\nText [ref:text]\n#+END_EXAMPLE"
- (org-element-property :label-fmt (org-element-at-point)))))
- (should
- (equal
- "[ref:%s]"
- (org-test-with-temp-text
- "#+BEGIN_SRC emacs-lisp -l \"[ref:%s]\"\n(+ 1 1) [ref:text]\n#+END_SRC"
- (org-element-property :label-fmt (org-element-at-point)))))))
- ;;;; Export Block
- (ert-deftest test-org-element/export-block-parser ()
- "Test `export-block' parser."
- ;; Standard test.
- (should
- (eq 'export-block
- (org-test-with-temp-text "#+BEGIN_EXPORT LATEX\nText\n#+END_EXPORT"
- (org-element-type (org-element-at-point)))))
- (should
- (equal "LATEX"
- (org-test-with-temp-text "#+BEGIN_EXPORT LATEX\nText\n#+END_EXPORT"
- (org-element-property :type (org-element-at-point)))))
- ;; Ignore case.
- (should
- (eq 'export-block
- (org-test-with-temp-text "#+begin_export latex\nText\n#+end_export"
- (org-element-type (org-element-at-point)))))
- ;; Ignore incomplete block.
- (should-not
- (eq 'export-block
- (org-test-with-temp-text "#+BEGIN_EXPORT"
- (org-element-type (org-element-at-point)))))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "#+BEGIN_EXPORT latex\nC\n#+END_EXPORT\n "
- (= (org-element-property :end (org-element-at-point)) (point-max))))
- ;; Un-escape commas in `:value'.
- (should
- (equal "* H\n"
- (org-test-with-temp-text "#+BEGIN_EXPORT org\n,* H\n#+END_EXPORT\n "
- (org-element-property :value (org-element-at-point))))))
- ;;;; Export Snippet
- (ert-deftest test-org-element/export-snippet-parser ()
- "Test `export-snippet' parser."
- (should
- (equal
- '("back-end" . "contents")
- (org-test-with-temp-text "@@back-end:contents@@"
- (org-element-map
- (org-element-parse-buffer) 'export-snippet
- (lambda (snippet) (cons (org-element-property :back-end snippet)
- (org-element-property :value snippet)))
- nil t)))))
- ;;;; Fixed Width
- (ert-deftest test-org-element/fixed-width-parser ()
- "Test fixed-width area parsing."
- ;; Preserve indentation.
- (should
- (equal "no blank\n one blank"
- (org-test-with-temp-text ": no blank\n: one blank"
- (org-element-property :value (org-element-at-point)))))
- ;; Fixed-width with empty lines.
- (should
- (equal "first part\n\n\nsecond part"
- (org-test-with-temp-text ": first part\n:\n: \n: second part"
- (org-element-property :value (org-element-at-point)))))
- ;; Parse indented fixed-width markers.
- (should
- (eq 'fixed-width
- (org-test-with-temp-text "Text\n<point> : no blank\n : one blank"
- (org-element-type (org-element-at-point)))))
- ;; Distinguish fixed-width areas within a list and outside of it.
- (should
- (org-test-with-temp-text "
- - Item
- : fixed-width inside<point>
- : fixed-width outside"
- (= (org-element-property :end (org-element-at-point))
- (line-beginning-position 2))))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text ": A\n "
- (= (org-element-property :end (org-element-at-point))
- (point-max)))))
- ;;;; Footnote Definition
- (ert-deftest test-org-element/footnote-definition-parser ()
- "Test `footnote-definition' parser."
- (should
- (org-test-with-temp-text "[fn:1] Definition"
- (eq (org-element-type (org-element-at-point)) 'footnote-definition)))
- ;; Footnote with more contents.
- (should
- (= 29 (org-test-with-temp-text "[fn:1] Definition\n\n| a | b |"
- (org-element-property :end (org-element-at-point)))))
- ;; Test difference between :contents-end and :end property
- (should
- (< (org-test-with-temp-text "[fn:1] Definition\n\n\n"
- (org-element-property :contents-end (org-element-at-point)))
- (org-test-with-temp-text "[fn:1] Definition\n\n\n"
- (org-element-property :end (org-element-at-point)))))
- ;; Footnote starting with special syntax.
- (should-not
- (org-test-with-temp-text "[fn:1] <point>- no item"
- (eq (org-element-type (org-element-at-point)) 'item)))
- ;; Correctly handle footnote starting with an empty line.
- (should
- (= 9
- (org-test-with-temp-text "[fn:1]\n\n Body"
- (org-element-property :contents-begin (org-element-at-point)))))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "[fn:1] Definition\n "
- (= (org-element-property :end (org-element-at-point)) (point-max))))
- ;; Footnote with attributes.
- (should
- (= 1
- (org-test-with-temp-text "#+attr_latex: :offset 0in\n[fn:1] A footnote."
- (length
- (org-element-map (org-element-parse-buffer) 'footnote-definition
- #'identity)))))
- (should
- (org-test-with-temp-text "[fn:1] 1\n\n#+attr_latex: :offset 0in\n[fn:2] 2"
- (goto-char (org-element-property :end (org-element-at-point)))
- (looking-at "#")))
- ;; An empty footnote has no contents.
- (should-not
- (org-test-with-temp-text "[fn:1]\n\n"
- (let ((footnote (org-element-at-point)))
- (or (org-element-property :contents-begin footnote)
- (org-element-property :contents-end footnote)))))
- ;; Parse `:pre-blank'.
- (should
- (= 0
- (org-test-with-temp-text "[fn:1] A"
- (org-element-property :pre-blank (org-element-at-point)))))
- (should
- (= 1
- (org-test-with-temp-text "[fn:1]\nA"
- (org-element-property :pre-blank (org-element-at-point)))))
- (should
- (= 2
- (org-test-with-temp-text "[fn:1]\n\nA"
- (org-element-property :pre-blank (org-element-at-point))))))
- ;;;; Footnotes Reference.
- (ert-deftest test-org-element/footnote-reference-parser ()
- "Test `footnote-reference' parser."
- ;; Parse a standard reference.
- (should
- (org-test-with-temp-text "Text[fn:label]"
- (org-element-map
- (org-element-parse-buffer) 'footnote-reference 'identity)))
- ;; Parse an inline reference.
- (should
- (org-test-with-temp-text "Text[fn:test:def]"
- (org-element-map
- (org-element-parse-buffer) 'footnote-reference 'identity)))
- ;; Parse an anonymous reference.
- (should
- (org-test-with-temp-text "Text[fn::def]"
- (org-element-map
- (org-element-parse-buffer) 'footnote-reference 'identity)))
- ;; Parse inline references with syntax loaded characters.
- (should
- (eq 'footnote-reference
- (org-test-with-temp-text "Text[fn<point>::(def]"
- (org-element-type (org-element-context)))))
- (should
- (eq 'footnote-reference
- (org-test-with-temp-text "Text[fn<point>::\"def]"
- (org-element-type (org-element-context)))))
- ;; Parse nested footnotes.
- (should
- (= 2
- (length
- (org-test-with-temp-text "Text[fn::def [fn:label]]"
- (org-element-map
- (org-element-parse-buffer) 'footnote-reference 'identity)))))
- ;; Parse adjacent footnotes.
- (should
- (org-test-with-temp-text "Text[fn:label1][fn:label2]"
- (= 2
- (length
- (org-element-map
- (org-element-parse-buffer) 'footnote-reference 'identity)))))
- ;; Only properly closed footnotes are recognized as such.
- (should-not
- (org-test-with-temp-text "Text[fn:label"
- (org-element-map
- (org-element-parse-buffer) 'footnote-reference 'identity))))
- ;;;; Headline
- (ert-deftest test-org-element/headline-todo-keyword ()
- "Test todo keyword recognition."
- ;; Reference test.
- (org-test-with-temp-text "* TODO Headline"
- (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
- (should (org-element-property :todo-keyword (org-element-at-point)))))
- ;; Todo keyword is prefix of headlines first word.
- (org-test-with-temp-text "* TODOHeadline"
- (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
- (should-not (org-element-property :todo-keyword (org-element-at-point))))))
- (ert-deftest test-org-element/headline-comment-keyword ()
- "Test COMMENT keyword recognition."
- ;; Reference test.
- (org-test-with-temp-text "* Headline"
- (should-not (org-element-property :commentedp (org-element-at-point))))
- ;; Standard position.
- (org-test-with-temp-text "* COMMENT Headline"
- (let ((headline (org-element-at-point)))
- (should (org-element-property :commentedp headline))
- (should (equal (org-element-property :raw-value headline) "Headline"))))
- ;; Case sensitivity.
- (org-test-with-temp-text "* Comment Headline"
- (let ((headline (org-element-at-point)))
- (should-not (org-element-property :commentedp headline))
- (should (equal (org-element-property :raw-value headline)
- "Comment Headline"))))
- ;; With another keyword.
- (org-test-with-temp-text "* TODO COMMENT Headline"
- (let* ((org-todo-keywords '((sequence "TODO" "DONE")))
- (headline (org-element-at-point)))
- (should (org-element-property :commentedp headline))
- (should (equal (org-element-property :raw-value headline) "Headline"))))
- ;; With the keyword only.
- (org-test-with-temp-text "* COMMENT"
- (let* ((headline (org-element-at-point)))
- (should (org-element-property :commentedp headline))
- (should (equal (org-element-property :raw-value headline) "")))))
- (ert-deftest test-org-element/headline-archive-tag ()
- "Test ARCHIVE tag recognition."
- ;; Reference test.
- (should-not
- (org-test-with-temp-text "* Headline"
- (org-element-property :archivedp (org-element-at-point))))
- ;; Single tag.
- (org-test-with-temp-text "* Headline :ARCHIVE:"
- (let ((headline (org-element-at-point)))
- (should (org-element-property :archivedp headline))))
- ;; Multiple tags.
- (org-test-with-temp-text "* Headline :test:ARCHIVE:"
- (let ((headline (org-element-at-point)))
- (should (org-element-property :archivedp headline))))
- ;; Tag is case-sensitive.
- (should-not
- (org-test-with-temp-text "* Headline :Archive:"
- (org-element-property :archivedp (org-element-at-point)))))
- (ert-deftest test-org-element/headline-properties ()
- "Test properties from property drawer."
- ;; All properties from property drawer have their symbol upper
- ;; cased.
- (should
- (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
- (org-element-property :FOO (org-element-at-point))))
- (should-not
- (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar\n:END:"
- (org-element-property :foo (org-element-at-point))))
- ;; Also parse properties associated in inlinetasks.
- (when (featurep 'org-inlinetask)
- (should
- (org-test-with-temp-text "*************** Inlinetask
- :PROPERTIES:
- :foo: bar
- :END:
- *************** END"
- (org-element-property :FOO (org-element-at-point)))))
- ;; Do not find property drawer in a verbatim area.
- (should-not
- (org-test-with-temp-text
- "* Headline
- #+BEGIN_EXAMPLE
- :PROPERTIES:
- :foo: bar
- :END:
- #+END_EXAMPLE"
- (org-element-property :FOO (org-element-at-point))))
- ;; Do not use properties from a drawer associated to an inlinetask.
- (when (featurep 'org-inlinetask)
- (should-not
- (org-test-with-temp-text
- "* Headline
- *************** Inlinetask
- :PROPERTIES:
- :foo: bar
- :END:
- *************** END"
- (org-element-property
- :FOO (let ((org-inlinetask-min-level 15)) (org-element-at-point))))))
- ;; Do not find incomplete drawers.
- (should-not
- (org-test-with-temp-text "* Headline\n:PROPERTIES:\n:foo: bar"
- (org-element-property :FOO (org-element-at-point)))))
- ;;;; Horizontal Rule
- (ert-deftest test-org-element/horizontal-rule-parser ()
- "Test `horizontal-rule' parser."
- ;; Standard.
- (should
- (org-test-with-temp-text "-----"
- (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
- ;; Indented.
- (should
- (org-test-with-temp-text " -----"
- (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
- ;; Hyphen must be alone on the line.
- (should-not
- (org-test-with-temp-text "-----wrong"
- (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
- ;; 4 hyphens is too small.
- (should-not
- (org-test-with-temp-text "----"
- (org-element-map (org-element-parse-buffer) 'horizontal-rule 'identity)))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "-----\n "
- (= (org-element-property :end (org-element-at-point)) (point-max)))))
- ;;;; Inline Babel Call
- (ert-deftest test-org-element/inline-babel-call-parser ()
- "Test `inline-babel-call' parser."
- ;; Standard test.
- (should
- (eq 'inline-babel-call
- (org-test-with-temp-text "call_test()"
- (org-element-type (org-element-context)))))
- (should
- (eq 'inline-babel-call
- (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
- (org-element-type (org-element-context)))))
- ;; Parse call name.
- (should
- (equal
- "test"
- (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
- (org-element-property :call (org-element-context)))))
- ;; Parse inside header.
- (should
- (equal
- ":results output"
- (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
- (org-element-property :inside-header (org-element-context)))))
- ;; Parse arguments.
- (should
- (equal
- "x=2"
- (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
- (org-element-property :arguments (org-element-context)))))
- ;; Parse end header.
- (should
- (equal
- ":results html"
- (org-test-with-temp-text "call_test[:results output](x=2)[:results html]"
- (org-element-property :end-header (org-element-context)))))
- ;; Handle multi-line babel calls.
- (should
- (eq 'inline-babel-call
- (org-test-with-temp-text
- "call_test[:results\noutput](x=2)[:results html]"
- (org-element-type (org-element-context)))))
- (should
- (eq 'inline-babel-call
- (org-test-with-temp-text
- "call_test[:results output](x=2\ny=3)[:results html]"
- (org-element-type (org-element-context)))))
- (should
- (eq 'inline-babel-call
- (org-test-with-temp-text
- "call_test[:results output](x=2)[:results\nhtml]"
- (org-element-type (org-element-context)))))
- ;; Parse parameters containing round brackets.
- (should
- (eq 'inline-babel-call
- (org-test-with-temp-text "call_test[:var x='(1)](x=2)"
- (org-element-type (org-element-context))))))
- ;;;; Inline Src Block
- (ert-deftest test-org-element/inline-src-block-parser ()
- "Test `inline-src-block' parser."
- (should
- (org-test-with-temp-text "src_emacs-lisp{(+ 1 1)}"
- (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
- ;; With switches.
- (should
- (org-test-with-temp-text "src_emacs-lisp[:foo bar]{(+ 1 1)}"
- (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
- (should
- (org-test-with-temp-text "src_emacs-lisp[ :foo bar]{(+ 1 1)}"
- (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
- ;; Empty switches.
- (should
- (org-test-with-temp-text "src_emacs-lisp[]{(+ 1 1)}"
- (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
- ;; Invalid syntax.
- (should-not
- (org-test-with-temp-text "src_emacs-lisp[]foo{(+ 1 1)}"
- (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
- (should-not
- (org-test-with-temp-text "foosrc_emacs-lisp[]{(+ 1 1)}"
- (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
- ;; Invalid language name
- (should-not
- (org-test-with-temp-text "src_emacs-\tlisp{(+ 1 1)}"
- (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
- ;; Test parsing at the beginning of an item.
- (should
- (org-test-with-temp-text "- src_emacs-lisp{(+ 1 1)}"
- (org-element-map (org-element-parse-buffer) 'inline-src-block 'identity)))
- ;; Test parsing multi-line source blocks.
- (should
- (eq 'inline-src-block
- (org-test-with-temp-text "src_emacs-lisp{(+ 1\n 1)}"
- (org-element-type (org-element-context)))))
- (should
- (eq 'inline-src-block
- (org-test-with-temp-text "src_emacs-lisp[\n:foo bar]{(+ 1 1)}"
- (org-element-type (org-element-context)))))
- (should
- (eq 'inline-src-block
- (org-test-with-temp-text "src_emacs-lisp[:foo\nbar]{(+ 1 1)}"
- (org-element-type (org-element-context)))))
- ;; Besides curly brackets, ignore any other bracket type.
- (should
- (equal "[foo"
- (org-test-with-temp-text "src_emacs-lisp{[foo}"
- (org-element-property :value (org-element-context)))))
- (should
- (equal "foo]"
- (org-test-with-temp-text "src_emacs-lisp{foo]}"
- (org-element-property :value (org-element-context)))))
- (should
- (equal "(foo"
- (org-test-with-temp-text "src_emacs-lisp{(foo}"
- (org-element-property :value (org-element-context)))))
- (should
- (equal "foo)"
- (org-test-with-temp-text "src_emacs-lisp{foo)}"
- (org-element-property :value (org-element-context)))))
- ;; Parse parameters containing square brackets.
- (should
- (eq 'inline-src-block
- (org-test-with-temp-text "src_emacs-lisp[:var table=t[1,1]]{(+ 1 1)}"
- (org-element-type (org-element-context))))))
- ;;;; Inlinetask
- (ert-deftest test-org-element/inlinetask-parser ()
- "Test `inlinetask' parser."
- (when (featurep 'org-inlinetask)
- (let ((org-inlinetask-min-level 15))
- ;; Regular inlinetask.
- (should
- (eq 'inlinetask
- (org-test-with-temp-text
- "*************** Task\nTest\n*************** END"
- (org-element-type (org-element-at-point)))))
- (should
- (eq 'inlinetask
- (org-test-with-temp-text
- "*************** Task\nTest\n*************** END"
- (org-element-type (org-element-at-point)))))
- ;; Degenerate inlinetask.
- (should
- (eq 'inlinetask
- (org-test-with-temp-text "*************** Task"
- (org-element-type (org-element-at-point)))))
- ;; Mixed inlinetasks.
- (should-not
- (org-test-with-temp-text
- "
- *************** Task
- *************** Task2
- Contents
- *************** END"
- (forward-line)
- (goto-char (org-element-property :end (org-element-at-point)))
- (eobp)))
- ;; TODO keyword.
- (should
- (equal
- "TODO"
- (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
- (org-test-with-temp-text "*************** TODO Task"
- (org-element-property :todo-keyword (org-element-at-point))))))
- ;; Planning info.
- (should
- (org-test-with-temp-text "
- *************** Task<point>
- DEADLINE: <2012-03-29 thu.>
- *************** END"
- (org-element-property :deadline (org-element-at-point))))
- (should
- (eq 'planning
- (org-test-with-temp-text "
- *************** Task
- <point>DEADLINE: <2012-03-29 thu.>
- *************** END"
- (org-element-type (org-element-at-point)))))
- (should-not
- (org-test-with-temp-text "
- *************** Task<point>
- DEADLINE: <2012-03-29 thu.>"
- (org-element-property :deadline (org-element-at-point))))
- (should-not
- (eq 'planning
- (org-test-with-temp-text "
- *************** Task
- <point>DEADLINE: <2012-03-29 thu.>"
- (org-element-type (org-element-at-point)))))
- ;; Priority.
- (should
- (eq
- ?A
- (org-test-with-temp-text "
- *************** [#A] Task"
- (forward-line)
- (org-element-property :priority (org-element-at-point)))))
- ;; Tags.
- (should
- (equal
- '("test")
- (org-test-with-temp-text "
- *************** Task :test:"
- (forward-line)
- (org-element-property :tags (org-element-at-point)))))
- ;; Regular properties are accessed through upper case keywords.
- (should
- (org-test-with-temp-text "
- *************** Task
- :PROPERTIES:
- :foo: bar
- :END:
- *************** END"
- (forward-line)
- (org-element-property :FOO (org-element-at-point))))
- (should-not
- (org-test-with-temp-text "
- *************** Task
- :PROPERTIES:
- :foo: bar
- :END:
- *************** END"
- (forward-line)
- (org-element-property :foo (org-element-at-point))))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "*************** Task\n*************** END\n "
- (= (org-element-property :end (org-element-at-point)) (point-max)))))))
- ;;;; Italic
- (ert-deftest test-org-element/italic-parser ()
- "Test `italic' parser."
- ;; Regular test.
- (should
- (org-test-with-temp-text "/italic/"
- (org-element-map (org-element-parse-buffer) 'italic #'identity nil t)))
- ;; Multi-line markup.
- (should
- (equal
- (org-element-contents
- (org-test-with-temp-text "/first line\nsecond line/"
- (org-element-map (org-element-parse-buffer) 'italic #'identity nil t)))
- '("first line\nsecond line"))))
- ;;;; Item
- (ert-deftest test-org-element/item-parser ()
- "Test `item' parser."
- ;; Standard test.
- (should
- (org-test-with-temp-text "- item"
- (org-element-map (org-element-parse-buffer) 'item 'identity)))
- ;; Counter.
- (should
- (= 6
- (org-element-property
- :counter
- (org-test-with-temp-text "6. [@6] item"
- (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
- ;; Tag
- (should
- (equal
- '("tag")
- (org-element-property
- :tag
- (org-test-with-temp-text "- tag :: description"
- (org-element-map (org-element-parse-buffer) 'item 'identity nil t)))))
- ;; No tags in ordered lists.
- (should-not
- (org-element-property
- :tag
- (org-test-with-temp-text "1. tag :: description"
- (org-element-map (org-element-parse-buffer) 'item 'identity nil t))))
- ;; Check-boxes
- (should
- (equal
- '(trans on off)
- (org-test-with-temp-text "
- - [-] item 1
- - [X] item 1.1
- - [ ] item 1.2"
- (org-element-map (org-element-parse-buffer) 'item
- (lambda (item) (org-element-property :checkbox item))))))
- ;; Item starting with special syntax.
- (should
- (equal '(("- item"))
- (org-test-with-temp-text "- - item"
- (org-element-map (org-element-parse-buffer) 'paragraph
- 'org-element-contents))))
- ;; Block in an item: ignore indentation within the block.
- (should
- (org-test-with-temp-text
- "-<point> item\n #+begin_src emacs-lisp\n(+ 1 1)\n #+end_src"
- (= (org-element-property :end (org-element-at-point)) (point-max))))
- ;; Parse `:pre-blank'.
- (should
- (= 0
- (org-test-with-temp-text "-<point> A"
- (org-element-property :pre-blank (org-element-at-point)))))
- (should
- (= 1
- (org-test-with-temp-text "-<point>\n A"
- (org-element-property :pre-blank (org-element-at-point)))))
- (should
- (= 2
- (org-test-with-temp-text "-<point>\n\n A"
- (org-element-property :pre-blank (org-element-at-point)))))
- ;; Last item in a list or sub-list has no `:post-blank' lines, since
- ;; those belong to the plain-list.
- (should
- (= 0
- (org-test-with-temp-text "- A\n\n- <point>B\n\nEnd list"
- (org-element-property :post-blank (org-element-at-point)))))
- (should
- (= 0
- (org-test-with-temp-text "- A\n\n - B\n\n<point> - C\n\n End sub-list"
- (org-element-property :post-blank (org-element-at-point))))))
- ;;;; Keyword
- (ert-deftest test-org-element/keyword-parser ()
- "Test `keyword' parser."
- ;; Standard test.
- (should
- (org-test-with-temp-text "#+KEYWORD: value"
- (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
- ;; Keywords are case-insensitive.
- (should
- (org-test-with-temp-text "#+keyword: value"
- (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
- ;; Affiliated keywords are not keywords.
- (should-not
- (org-test-with-temp-text "#+NAME: value
- Paragraph"
- (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
- ;; Do not mix keywords with Babel calls and dynamic blocks.
- (should-not
- (org-test-with-temp-text "#+CALL: fun()"
- (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
- (should-not
- (org-test-with-temp-text "#+BEGIN: my-fun\nBody\n#+END:"
- (org-element-map (org-element-parse-buffer) 'keyword 'identity)))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "#+KEYWORD: value\n "
- (= (org-element-property :end (org-element-at-point)) (point-max)))))
- ;;;; Latex Environment
- (ert-deftest test-org-element/latex-environment-parser ()
- "Test `latex-environment' parser."
- (should
- (org-test-with-temp-text "\\begin{equation}\ne^{i\\pi}+1=0\n\\end{equation}"
- (org-element-map (org-element-parse-buffer) 'latex-environment 'identity)))
- ;; Allow nested environments.
- (should
- (equal
- "\\begin{outer}
- \\begin{inner}
- e^{i\\pi}+1=0
- \\end{inner}
- \\end{outer}"
- (org-test-with-temp-text "
- \\begin{outer}
- \\begin{inner}
- e^{i\\pi}+1=0
- \\end{inner}
- \\end{outer}"
- (org-element-property
- :value
- (org-element-map
- (org-element-parse-buffer) 'latex-environment 'identity nil t)))))
- ;; Allow environments with options and arguments.
- (should
- (eq 'latex-environment
- (org-test-with-temp-text
- "\\begin{theorem}[Euler]\ne^{i\\pi}+1=0\n\\end{theorem}"
- (org-element-type (org-element-at-point)))))
- (should
- (eq 'latex-environment
- (org-test-with-temp-text "\\begin{env}{arg}\nvalue\n\\end{env}"
- (org-element-type (org-element-at-point)))))
- ;; Allow environments without newline after \begin{.}.
- (should
- (eq 'latex-environment
- (org-test-with-temp-text "\\begin{env}{arg}something\nvalue\n\\end{env}"
- (org-element-type (org-element-at-point)))))
- ;; Allow one-line environments.
- (should
- (eq 'latex-environment
- (org-test-with-temp-text "\\begin{env}{arg}something\\end{env}"
- (org-element-type (org-element-at-point)))))
- ;; Should not allow different tags.
- (should-not
- (eq 'latex-environment
- (org-test-with-temp-text "\\begin{env*}{arg}something\\end{env}"
- (org-element-type (org-element-at-point)))))
- ;; LaTeX environments must be on separate lines.
- (should-not
- (eq 'latex-environment
- (org-test-with-temp-text "\\begin{env} x \\end{env} y"
- (org-element-type (org-element-at-point)))))
- (should-not
- (eq 'latex-environment
- (org-test-with-temp-text "y \\begin{env} x<point> \\end{env}"
- (org-element-type (org-element-at-point)))))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "\\begin{env}\n\\end{env}\n "
- (= (org-element-property :end (org-element-at-point)) (point-max)))))
- ;;;; Latex Fragment
- (ert-deftest test-org-element/latex-fragment-parser ()
- "Test `latex-fragment' parser."
- ;; Basic $...$ test.
- (should
- (eq 'latex-fragment
- (org-test-with-temp-text "$a$"
- (org-element-type (org-element-context)))))
- ;; Test valid characters after $...$ construct.
- (should-not
- (eq 'latex-fragment
- (org-test-with-temp-text "$a$a"
- (org-element-type (org-element-context)))))
- (should
- (eq 'latex-fragment
- (org-test-with-temp-text "$a$!"
- (org-element-type (org-element-context)))))
- (should
- (eq 'latex-fragment
- (org-test-with-temp-text "$a$,"
- (org-element-type (org-element-context)))))
- (should
- (eq 'latex-fragment
- (org-test-with-temp-text "$a$\""
- (org-element-type (org-element-context)))))
- (should
- (eq 'latex-fragment
- (org-test-with-temp-text "$a$)"
- (org-element-type (org-element-context)))))
- (should
- (eq 'latex-fragment
- (org-test-with-temp-text "$a$ "
- (org-element-type (org-element-context)))))
- (should
- (eq 'latex-fragment
- (org-test-with-temp-text "$a$'"
- (org-element-type (org-element-context)))))
- ;; Test forbidden characters inside $...$.
- (should-not
- (eq 'latex-fragment
- (org-test-with-temp-text "$.a$"
- (org-element-type (org-element-context)))))
- (should-not
- (eq 'latex-fragment
- (org-test-with-temp-text "$,a$"
- (org-element-type (org-element-context)))))
- (should-not
- (eq 'latex-fragment
- (org-test-with-temp-text "$;a$"
- (org-element-type (org-element-context)))))
- (should-not
- (eq 'latex-fragment
- (org-test-with-temp-text "$ a$"
- (org-element-type (org-element-context)))))
- (should-not
- (eq 'latex-fragment
- (org-test-with-temp-text "$a.$"
- (org-element-type (org-element-context)))))
- (should-not
- (eq 'latex-fragment
- (org-test-with-temp-text "$a,$"
- (org-element-type (org-element-context)))))
- (should-not
- (eq 'latex-fragment
- (org-test-with-temp-text "$a $"
- (org-element-type (org-element-context)))))
- ;; Test $$...$$.
- (should
- (eq 'latex-fragment
- (org-test-with-temp-text "$$a$$"
- (org-element-type (org-element-context)))))
- ;; Test \(...\).
- (should
- (eq 'latex-fragment
- (org-test-with-temp-text "\\(a\\)"
- (org-element-type (org-element-context)))))
- ;; Test \[...\].
- (should
- (eq 'latex-fragment
- (org-test-with-temp-text "\\[a\\]"
- (org-element-type (org-element-context)))))
- ;; Test fragment at the beginning of an item.
- (should
- (eq 'latex-fragment
- (org-test-with-temp-text "- $<point>x$"
- (org-element-type (org-element-context))))))
- ;;;; Line Break
- (ert-deftest test-org-element/line-break-parser ()
- "Test `line-break' parser."
- ;; Regular test.
- (should
- (org-test-with-temp-text "Text \\\\"
- (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
- ;; Line break with trailing white spaces.
- (should
- (org-test-with-temp-text "Text \\\\ "
- (org-element-map (org-element-parse-buffer) 'line-break 'identity)))
- ;; Three backslashes are too much.
- (should-not
- (org-test-with-temp-text "Text \\\\\\"
- (org-element-map (org-element-parse-buffer) 'line-break 'identity))))
- ;;;; Link
- (ert-deftest test-org-element/link-parser ()
- "Test `link' parser."
- ;; Radio target.
- (should
- (equal
- "radio"
- (org-test-with-temp-text "<<<radio>>>A radio link"
- (org-update-radio-target-regexp)
- (org-element-property
- :type
- (org-element-map (org-element-parse-buffer) 'link #'identity nil t)))))
- ;; Pathological case: radio target of length 1 at beginning of line
- ;; not followed by spaces.
- (should
- (org-test-with-temp-text "* <<<a>>>\n<point>a-bug"
- (org-update-radio-target-regexp)
- (org-element-parse-buffer)))
- ;; Pathological case: radio target in an emphasis environment.
- (should
- (eq 'bold
- (org-test-with-temp-text "* <<<radio>>>\n<point>*radio*"
- (org-update-radio-target-regexp)
- (org-element-type (org-element-context)))))
- (should
- (eq 'link
- (org-test-with-temp-text "* <<<radio>>>\n*<point>radio*"
- (org-update-radio-target-regexp)
- (org-element-type (org-element-context)))))
- ;; Standard link.
- ;;
- ;; ... with description.
- (should
- (equal
- '("Orgmode.org")
- (org-test-with-temp-text "[[https://orgmode.org][Orgmode.org]]"
- (org-element-contents
- (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
- ;; ... without description.
- (should
- (equal
- "https"
- (org-test-with-temp-text "[[https://orgmode.org]]"
- (org-element-property
- :type
- (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
- ;; ... with expansion.
- (should
- (equal
- "//orgmode.org/worg"
- (org-test-with-temp-text "[[Org:worg]]"
- (let ((org-link-abbrev-alist '(("Org" . "https://orgmode.org/"))))
- (org-element-property
- :path
- (org-element-map (org-element-parse-buffer) 'link 'identity nil t))))))
- ;; ... with translation.
- (should
- (equal
- "127.0.0.1"
- (org-test-with-temp-text "[[https://orgmode.org]]"
- (let ((org-link-translation-function
- (lambda (type _) (cons type "127.0.0.1"))))
- (org-element-property
- :path
- (org-element-map (org-element-parse-buffer) 'link
- #'identity nil t))))))
- ;; ... custom-id link.
- (should
- (equal
- "custom-id"
- (org-test-with-temp-text "[[#some-id]]"
- (org-element-property
- :type
- (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
- ;; ... coderef link.
- (should
- (equal
- "coderef"
- (org-test-with-temp-text "[[(reference)]]"
- (org-element-property
- :type
- (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
- ;; ... fuzzy link.
- (should
- (equal
- "fuzzy"
- (org-test-with-temp-text "[[target-or-title]]"
- (org-element-property
- :type
- (org-element-map (org-element-parse-buffer) 'link 'identity nil t)))))
- ;; ... file-type link with search option.
- (should
- (equal
- '(("file" "projects.org" "*task title"))
- (org-test-with-temp-text "[[file:projects.org::*task title]]"
- (org-element-map (org-element-parse-buffer) 'link
- (lambda (l) (list (org-element-property :type l)
- (org-element-property :path l)
- (org-element-property :search-option l)))))))
- ;; ... file-type link with application...
- (should
- (equal
- '("file" "projects.org" "emacs")
- (org-test-with-temp-text "[[file+emacs:projects.org]]"
- (let ((l (org-element-context)))
- (list (org-element-property :type l)
- (org-element-property :path l)
- (org-element-property :application l))))))
- ;; ... `:path' in a file-type link must be compatible with "file"
- ;; scheme in URI syntax, even if Org syntax isn't...
- (should
- (org-test-with-temp-text-in-file ""
- (let ((file (expand-file-name (buffer-file-name))))
- (insert (format "[[file://%s]]" file))
- (equal (org-element-property :path (org-element-context)) file))))
- (should
- (org-test-with-temp-text-in-file ""
- (let ((file (expand-file-name (buffer-file-name))))
- (insert (format "[[file:%s]]" file))
- (equal (org-element-property :path (org-element-context)) file))))
- (should
- (org-test-with-temp-text-in-file ""
- (let ((file (expand-file-name (buffer-file-name))))
- (insert (format "[[file:%s]]" file))
- (equal (org-element-property :path (org-element-context)) file))))
- ;; ... multi-line link.
- (should
- (equal "ls *.org"
- (org-test-with-temp-text "[[shell:ls\n*.org]]"
- (org-element-property :path (org-element-context)))))
- ;; Plain link.
- (should
- (org-test-with-temp-text "A link: https://orgmode.org"
- (org-element-map (org-element-parse-buffer) 'link 'identity)))
- ;; Angular link. Follow RFC 3986.
- (should
- (eq 'link
- (org-test-with-temp-text "A link: <point><https://orgmode.org>"
- (org-element-type (org-element-context)))))
- (should
- (equal "//orgmode.org"
- (org-test-with-temp-text "A link: <point><https://orgmode\n.org>"
- (org-element-property :path (org-element-context)))))
- ;; Link abbreviation.
- (should
- (equal "https"
- (org-test-with-temp-text
- "#+LINK: orgmode https://www.orgmode.org/\n[[orgmode:#docs]]"
- (progn (org-mode-restart)
- (goto-char (1- (point-max)))
- (org-element-property :type (org-element-context))))))
- ;; Link abbreviation in a secondary string.
- (should
- (equal "https"
- (org-test-with-temp-text
- "#+LINK: orgmode https://www.orgmode.org/\n* H [[orgmode:#docs]]"
- (progn (org-mode-restart)
- (org-element-map (org-element-parse-buffer) 'link
- (lambda (link) (org-element-property :type link))
- nil t nil t))))))
- ;;;; Macro
- (ert-deftest test-org-element/macro-parser ()
- "Test `macro' parser."
- ;; Without arguments.
- (should
- (org-test-with-temp-text "{{{macro}}}"
- (org-element-map (org-element-parse-buffer) 'macro 'identity)))
- ;; With arguments.
- (should
- (org-test-with-temp-text "{{{macro(arg1,arg2)}}}"
- (org-element-map (org-element-parse-buffer) 'macro 'identity)))
- ;; Properly handle protected commas in arguments...
- (should
- (= 2
- (length
- (org-test-with-temp-text "{{{macro(arg1\\,arg1,arg2)}}}"
- (org-element-property :args (org-element-context))))))
- ;; ... even when last argument ends with a protected comma.
- (should
- (equal '("C-,")
- (org-test-with-temp-text "{{{macro(C-\\,)}}}"
- (org-element-property :args (org-element-context)))))
- ;; Allow to escape escaping character.
- (should
- (equal '("C-\\" "")
- (org-test-with-temp-text "{{{macro(C-\\\\,)}}}"
- (org-element-property :args (org-element-context)))))
- ;; No need to escape backslashes elsewhere.
- (should
- (equal '("\\")
- (org-test-with-temp-text "{{{macro(\\)}}}"
- (org-element-property :args (org-element-context))))))
- ;;;; Node Property
- (ert-deftest test-org-element/node-property ()
- "Test `node-property' parser."
- ;; Standard test.
- (should
- (equal '("abc" "value")
- (org-test-with-temp-text "* H\n:PROPERTIES:\n<point>:abc: value\n:END:"
- (let ((element (org-element-at-point)))
- (list (org-element-property :key element)
- (org-element-property :value element))))))
- ;; The insides of property blocks on document level are parsed the
- ;; same way as headline property blocks. I.e. the concept of
- ;; `node-property' apply also for properties in those blocks.
- (should
- (equal '("abc" "value")
- (org-test-with-temp-text ":PROPERTIES:\n<point>:abc: value\n:END:"
- (let ((element (org-element-at-point)))
- (list (org-element-property :key element)
- (org-element-property :value element))))))
- ;; Value should be trimmed.
- (should
- (equal "value"
- (org-test-with-temp-text
- "* H\n:PROPERTIES:\n<point>:abc: value \n:END:"
- (org-element-property :value (org-element-at-point)))))
- ;; A node property requires to be wrapped within a property drawer.
- (should-not
- (eq 'node-property
- (org-test-with-temp-text ":abc: value"
- (org-element-type (org-element-at-point)))))
- ;; Accept empty properties.
- (should
- (equal '(("foo" "value") ("bar" ""))
- (org-test-with-temp-text "* H\n:PROPERTIES:\n:foo: value\n:bar:\n:END:"
- (org-element-map (org-element-parse-buffer) 'node-property
- (lambda (p)
- (list (org-element-property :key p)
- (org-element-property :value p))))))))
- ;;;; Paragraph
- (ert-deftest test-org-element/paragraph-parser ()
- "Test `paragraph' parser."
- ;; Standard test.
- (should
- (org-test-with-temp-text "Paragraph"
- (org-element-map (org-element-parse-buffer) 'paragraph 'identity nil t)))
- ;; Property find end of a paragraph stuck to another element.
- (should
- (eq ?#
- (org-test-with-temp-text "Paragraph\n# Comment"
- (org-element-map (org-element-parse-buffer) 'paragraph
- (lambda (p) (char-after (org-element-property :end p)))
- nil t))))
- ;; Include ill-formed Keywords.
- (should
- (org-test-with-temp-text "#+wrong_keyword something"
- (org-element-map (org-element-parse-buffer) 'paragraph 'identity)))
- ;; Include incomplete-drawers.
- (should
- (org-test-with-temp-text ":TEST:\nParagraph"
- (let ((elem (org-element-at-point)))
- (and (eq (org-element-type elem) 'paragraph)
- (= (point-max) (org-element-property :end elem))))))
- ;; Include incomplete blocks.
- (should
- (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph"
- (let ((elem (org-element-at-point)))
- (and (eq (org-element-type elem) 'paragraph)
- (= (point-max) (org-element-property :end elem))))))
- ;; Include incomplete dynamic blocks.
- (should
- (org-test-with-temp-text "#+BEGIN: \n<point>Paragraph"
- (let ((elem (org-element-at-point)))
- (and (eq (org-element-type elem) 'paragraph)
- (= (point-max) (org-element-property :end elem))))))
- ;; Include incomplete latex environments.
- (should
- (org-test-with-temp-text "\begin{equation}\nParagraph"
- (let ((elem (org-element-at-point)))
- (and (eq (org-element-type elem) 'paragraph)
- (= (point-max) (org-element-property :end elem))))))
- (should
- (org-test-with-temp-text "Paragraph\n\begin{equation}"
- (let ((elem (org-element-at-point)))
- (and (eq (org-element-type elem) 'paragraph)
- (= (point-max) (org-element-property :end elem))))))
- ;; Stop at affiliated keywords.
- (should
- (org-test-with-temp-text "Paragraph\n#+NAME: test\n| table |"
- (let ((elem (org-element-at-point)))
- (and (eq (org-element-type elem) 'paragraph)
- (not (org-element-property :name elem))
- (= (org-element-property :end elem) (line-beginning-position 2))))))
- (should
- (org-test-with-temp-text
- "Paragraph\n#+CAPTION[with short caption]: test\n| table |"
- (let ((elem (org-element-at-point)))
- (and (eq (org-element-type elem) 'paragraph)
- (not (org-element-property :name elem))
- (= (org-element-property :end elem) (line-beginning-position 2))))))
- ;; Do not steal affiliated keywords from container.
- (should
- (org-test-with-temp-text "#+ATTR_LATEX: test\n- item<point> 1"
- (let ((elem (org-element-at-point)))
- (and (eq (org-element-type elem) 'paragraph)
- (not (org-element-property :attr_latex elem))
- (/= (org-element-property :begin elem) 1)))))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "#+BEGIN_CENTER\nC\n#+END_CENTER\n "
- (= (org-element-property :end (org-element-at-point)) (point-max))))
- (should
- (org-test-with-temp-text "#+BEGIN_CENTER\n<point>C\n#+END_CENTER\n "
- (= (org-element-property :end (org-element-at-point))
- (save-excursion
- (search-forward "END")
- (line-beginning-position))))))
- ;;;; Plain List
- (ert-deftest test-org-element/plain-list-parser ()
- "Test `plain-list' parser."
- (org-test-with-temp-text "- item"
- (should (org-element-map (org-element-parse-buffer) 'plain-list 'identity)))
- ;; Blank lines after a list or sub-list belongs to that list.
- (should
- (= 1
- (org-test-with-temp-text "- A\n\n- B\n\nEnd list"
- (org-element-property :post-blank (org-element-at-point)))))
- (should
- (= 1
- (org-test-with-temp-text "- A\n\n<point> - B\n\n - C\n\n End sub-list"
- (org-element-property :post-blank (org-element-at-point)))))
- ;; Blank lines after the list only belong to outer plain list,
- ;; however.
- (should
- (equal
- '(t t)
- (org-test-with-temp-text "
- - outer
- - inner
- Outside list"
- (let ((endings (org-element-map (org-element-parse-buffer) 'plain-list
- (lambda (pl) (org-element-property :end pl)))))
- (list
- ;; Move to ending of outer list.
- (progn (goto-char (car endings)) (looking-at "Outside list"))
- ;; Move to ending of inner list.
- (progn (goto-char (nth 1 endings)) (looking-at "^$")))))))
- ;; Correctly compute end of list if it doesn't end at a line
- ;; beginning.
- (should
- (org-test-with-temp-text "- list\n \n "
- (= (org-element-property :end (org-element-at-point)) (point-max))))
- ;; Correctly compute list ending when list is before first headline.
- (dolist (org-element-use-cache '(t nil))
- (org-test-with-temp-text "- list\n* Headline\n"
- (should (= (org-element-property :end (org-element-at-point)) 8)))))
- ;;;; Planning
- (ert-deftest test-org-element/planning-parser ()
- "Test `planning' parser."
- ;; Test various keywords.
- (should
- (org-element-property
- :closed
- (org-test-with-temp-text "* H\n<point>CLOSED: [2012-03-29 thu.]"
- (org-element-at-point))))
- (should
- (org-element-property
- :deadline
- (org-test-with-temp-text "* H\n<point>DEADLINE: <2012-03-29 thu.>"
- (org-element-at-point))))
- (should
- (org-element-property
- :scheduled
- (org-test-with-temp-text "* H\n<point>SCHEDULED: <2012-03-29 thu.>"
- (org-element-at-point))))
- ;; Planning line only exists right after a headline.
- (should-not
- (eq 'planning
- (org-test-with-temp-text "DEADLINE: <2012-03-29 thu.>"
- (org-element-type (org-element-at-point)))))
- (should-not
- (eq 'planning
- (org-test-with-temp-text
- "* H\n# Comment\n<point>DEADLINE: <2012-03-29 thu.>"
- (org-element-type (org-element-at-point)))))
- (should-not
- (eq 'planning
- (org-test-with-temp-text
- "* H\n\n<point>DEADLINE: <2012-03-29 thu.>"
- (org-element-type (org-element-at-point))))))
- ;;;; Property Drawer
- (ert-deftest test-org-element/property-drawer-parser ()
- "Test `property-drawer' parser."
- ;; Standard test.
- (should
- (eq 'property-drawer
- (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop: value\n:END:"
- (org-element-type (org-element-at-point)))))
- (should
- (eq 'property-drawer
- (org-test-with-temp-text
- "* H\nDEADLINE: <2014-03-04 tue.>\n<point>:PROPERTIES:\n:prop: value\n:END:"
- (org-element-type (org-element-at-point)))))
- ;; Parse property drawer at the beginning of the document, possibly
- ;; after some initial comments.
- (should
- (eq 'property-drawer
- (org-test-with-temp-text "<point>:PROPERTIES:\n:prop: value\n:END:"
- (org-element-type (org-element-at-point)))))
- (should
- (eq 'property-drawer
- (org-test-with-temp-text "# C\n# C\n<point>:PROPERTIES:\n:prop: value\n:END:"
- (org-element-type (org-element-at-point)))))
- (should-not
- (eq 'property-drawer
- (org-test-with-temp-text "\n<point>:PROPERTIES:\n:prop: value\n:END:"
- (org-element-type (org-element-at-point)))))
- ;; Allow properties without value and no property at all.
- (should
- (eq 'property-drawer
- (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop:\n:END:"
- (org-element-type (org-element-at-point)))))
- (should
- (eq 'property-drawer
- (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:END:"
- (org-element-type (org-element-at-point)))))
- ;; Ignore incomplete drawer, drawer at a wrong location or with
- ;; wrong contents.
- (should-not
- (eq 'property-drawer
- (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:prop: value"
- (org-element-type (org-element-at-point)))))
- (should-not
- (eq 'property-drawer
- (org-test-with-temp-text
- "* H\nParagraph\n<point>:PROPERTIES:\n:prop: value\n:END:"
- (org-element-type (org-element-at-point)))))
- (should-not
- (eq 'property-drawer
- (org-test-with-temp-text
- "* H\nParagraph\n<point>:PROPERTIES:\nparagraph\n:END:"
- (org-element-type (org-element-at-point)))))
- (should-not
- (eq 'property-drawer
- (org-test-with-temp-text
- "* H\n\n<point>:PROPERTIES:\n:prop: value\n:END:"
- (org-element-type (org-element-at-point)))))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "* H\n<point>:PROPERTIES:\n:END:\n "
- (= (org-element-property :end (org-element-at-point)) (point-max)))))
- ;;;; Quote Block
- (ert-deftest test-org-element/quote-block-parser ()
- "Test `quote-block' parser."
- ;; Regular test.
- (should
- (org-test-with-temp-text "#+BEGIN_QUOTE\nText\n#+END_QUOTE"
- (org-element-map (org-element-parse-buffer) 'quote-block 'identity)))
- ;; Ignore incomplete block.
- (should-not
- (org-test-with-temp-text "#+BEGIN_QUOTE"
- (org-element-map (org-element-parse-buffer) 'quote-block 'identity nil t)))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "#+BEGIN_QUOTE\nC\n#+END_QUOTE\n "
- (= (org-element-property :end (org-element-at-point)) (point-max)))))
- ;;;; Radio Target
- (ert-deftest test-org-element/radio-target-parser ()
- "Test `radio-target' parser."
- ;; Standard test.
- (should
- (eq 'radio-target
- (org-test-with-temp-text "<<<radio>>>"
- (org-element-type (org-element-context)))))
- ;; Radio targets with objects.
- (should
- (eq 'radio-target
- (org-test-with-temp-text "<<<radio \\alpha>>>"
- (org-element-type (org-element-context)))))
- ;; Radio targets starting with an object.
- (should
- (eq 'radio-target
- (org-test-with-temp-text "<<<\\alpha radio>>>"
- (org-element-type (org-element-context)))))
- ;; Radio targets cannot begin or end with white space.
- (should-not
- (eq 'radio-target
- (org-test-with-temp-text "<<< radio>>>"
- (org-element-type (org-element-context)))))
- (should-not
- (eq 'radio-target
- (org-test-with-temp-text "<<<radio >>>"
- (org-element-type (org-element-context))))))
- ;;;; Section
- (ert-deftest test-org-element/section-parser ()
- "Test `section' parser."
- ;; Standard test.
- (should
- (org-test-with-temp-text "* Headline\nText"
- (org-element-map (org-element-parse-buffer) 'section 'identity)))
- ;; There's a section before the first headline.
- (should
- (org-test-with-temp-text "Text"
- (org-element-map (org-element-parse-buffer) 'section 'identity)))
- ;; A section cannot be empty.
- (should-not
- (org-test-with-temp-text "* Headline 1\n* Headline 2"
- (org-element-map (org-element-parse-buffer) 'section 'identity)))
- ;; A section doesn't contain sub-trees.
- (should-not
- (org-test-with-temp-text "* Head\nText\n** Sub-Head"
- (org-element-map
- (org-element-map (org-element-parse-buffer) 'section 'identity nil t)
- 'headline 'identity))))
- ;;;; Special Block
- (ert-deftest test-org-element/special-block-parser ()
- "Test `special-block' parser."
- ;; Standard test.
- (should
- (equal "SPECIAL"
- (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
- (org-element-property :type (org-element-at-point)))))
- ;; Special blocks are case sensitive.
- (should
- (equal "CaSe"
- (org-test-with-temp-text "#+BEGIN_CaSe\nText\n#+END_CaSe"
- (org-element-property :type (org-element-at-point)))))
- ;; Special blocks can contain paragraphs.
- (should
- (eq 'paragraph
- (org-test-with-temp-text "#+BEGIN_SPECIAL\nText\n#+END_SPECIAL"
- (forward-line)
- (org-element-type (org-element-at-point)))))
- ;; Ignore incomplete block.
- (should-not
- (eq 'special-block
- (org-test-with-temp-text "#+BEGIN_SPECIAL"
- (org-element-type (org-element-at-point)))))
- ;; Allow special characters in type.
- (should
- (equal '(special-block "SPECIAL*")
- (org-test-with-temp-text "#+BEGIN_SPECIAL*\nContents\n#+END_SPECIAL*"
- (let ((element (org-element-at-point)))
- (list (org-element-type element)
- (org-element-property :type element))))))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "#+BEGIN_SPECIAL\nC\n#+END_SPECIAL\n "
- (= (org-element-property :end (org-element-at-point)) (point-max))))
- ;; When contents is empty, the parsed contents is nil.
- (should
- (org-test-with-temp-text "#+BEGIN_SPECIAL\n#+END_SPECIAL"
- (eq nil (org-element-contents (org-element-at-point))))))
- ;;;; Src Block
- (ert-deftest test-org-element/src-block-parser ()
- "Test `src-block' parser."
- ;; Regular tests.
- (should
- (org-test-with-temp-text "#+BEGIN_SRC org\nText\n#+END_SRC"
- (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
- ;; Ignore incomplete block.
- (should-not
- (org-test-with-temp-text "#+BEGIN_SRC"
- (org-element-map (org-element-parse-buffer) 'src-block 'identity)))
- ;; Properly un-escape code.
- (should
- (equal "* Headline\n #+keyword\nText\n"
- (org-test-with-temp-text
- "#+BEGIN_SRC org\n,* Headline\n ,#+keyword\nText\n#+END_SRC"
- (org-element-property :value (org-element-at-point)))))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "#+BEGIN_SRC emacs-lisp\nC\n#+END_SRC\n "
- (= (org-element-property :end (org-element-at-point)) (point-max)))))
- ;;;; Statistics Cookie
- (ert-deftest test-org-element/statistics-cookie ()
- "Test `statistics-cookie' parser."
- ;; With numbers.
- (should
- (org-test-with-temp-text "[1/2]"
- (org-element-map (org-element-parse-buffer) 'statistics-cookie 'identity)))
- ;; With percents.
- (should
- (org-test-with-temp-text "[33%]"
- (org-element-map
- (org-element-parse-buffer) 'statistics-cookie 'identity))))
- ;;;; Strike Through
- (ert-deftest test-org-element/strike-through-parser ()
- "Test `strike-through' parser."
- ;; Regular test.
- (should
- (org-test-with-temp-text "+strike-through+"
- (org-element-map (org-element-parse-buffer) 'strike-through #'identity)))
- ;; Multi-line markup.
- (should
- (equal
- (org-element-contents
- (org-test-with-temp-text "+first line\nsecond line+"
- (org-element-map
- (org-element-parse-buffer) 'strike-through #'identity nil t)))
- '("first line\nsecond line"))))
- ;;;; Subscript
- (ert-deftest test-org-element/subscript-parser ()
- "Test `subscript' parser."
- ;; Without braces.
- (should
- (org-test-with-temp-text "a_b"
- (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
- ;; With braces.
- (should
- (org-test-with-temp-text "a_{b}"
- (org-element-map (org-element-parse-buffer) 'subscript 'identity)))
- ;; Multiple subscripts in a paragraph.
- (should
- (= 2
- (org-test-with-temp-text "a_b and c_d"
- (length
- (org-element-map (org-element-parse-buffer) 'subscript 'identity))))))
- ;;;; Superscript
- (ert-deftest test-org-element/superscript-parser ()
- "Test `superscript' parser."
- ;; Without braces.
- (should
- (org-test-with-temp-text "a^b"
- (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
- ;; With braces.
- (should
- (org-test-with-temp-text "a^{b}"
- (org-element-map (org-element-parse-buffer) 'superscript 'identity)))
- ;; Multiple superscript in a paragraph.
- (should
- (= 2
- (org-test-with-temp-text "a^b and c^d"
- (length
- (org-element-map
- (org-element-parse-buffer) 'superscript 'identity))))))
- ;;;; Table
- (ert-deftest test-org-element/table-parser ()
- "Test `table' parser."
- (should
- (org-test-with-temp-text "| a |"
- (org-element-map (org-element-parse-buffer) 'table 'identity)))
- ;; TBLFM keyword is case insensitive.
- (should
- (org-test-with-temp-text "| a |\n#+tblfm: test"
- (org-element-property
- :tblfm
- (org-element-map (org-element-parse-buffer) 'table 'identity nil t))))
- ;; Handle multiple TBLFM lines.
- (should
- (= 2
- (org-test-with-temp-text "| a |\n#+TBLFM: test1\n#+TBLFM: test2"
- (length (org-element-property
- :tblfm
- (org-element-map
- (org-element-parse-buffer) 'table 'identity nil t))))))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "| a |\n "
- (= (org-element-property :end (org-element-at-point)) (point-max)))))
- ;;;; Table Cell
- (ert-deftest test-org-element/table-cell-parser ()
- "Test `table-cell' parser."
- ;; Regular table cell.
- (should
- (org-test-with-temp-text "| a |"
- (org-element-map (org-element-parse-buffer) 'table-cell 'identity)))
- ;; Last vertical bar may be omitted.
- (should
- (org-test-with-temp-text "| a "
- (org-element-map (org-element-parse-buffer) 'table-cell 'identity))))
- ;;;; Table Row
- (ert-deftest test-org-element/table-row-parser ()
- "Test `table-row' parser."
- (should
- (equal '(standard rule)
- (org-test-with-temp-text "| a |\n|---|"
- (org-element-map
- (org-element-parse-buffer) 'table-row
- (lambda (row) (org-element-property :type row)))))))
- ;;;; Target
- (ert-deftest test-org-element/target-parser ()
- "Test `target' parser."
- (should
- (org-test-with-temp-text "<<target>>"
- (org-element-map (org-element-parse-buffer) 'target 'identity))))
- ;;;; Timestamp
- (ert-deftest test-org-element/timestamp-parser ()
- "Test `timestamp' parser."
- ;; Active timestamp.
- (should
- (org-test-with-temp-text "<2012-03-29 16:40>"
- (eq (org-element-property :type (org-element-context)) 'active)))
- (should-not
- (org-test-with-temp-text "<2012-03-29 Thu>"
- (let ((timestamp (org-element-context)))
- (or (org-element-property :hour-start timestamp)
- (org-element-property :minute-start timestamp)))))
- (should
- (equal '(2012 3 29 16 40)
- (org-test-with-temp-text "<2012-03-29 Thu 16:40>"
- (let ((object (org-element-context)))
- (list (org-element-property :year-start object)
- (org-element-property :month-start object)
- (org-element-property :day-start object)
- (org-element-property :hour-start object)
- (org-element-property :minute-start object))))))
- ;; Inactive timestamp.
- (should
- (org-test-with-temp-text "[2012-03-29 Thu 16:40]"
- (eq (org-element-property :type (org-element-context)) 'inactive)))
- ;; Time range.
- (should
- (equal '(2012 3 29 16 40 7 30)
- (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
- (let ((object (org-element-context)))
- (list (org-element-property :year-end object)
- (org-element-property :month-end object)
- (org-element-property :day-end object)
- (org-element-property :hour-end object)
- (org-element-property :minute-end object)
- (org-element-property :hour-start object)
- (org-element-property :minute-start object))))))
- (should
- (eq 'active-range
- (org-test-with-temp-text "<2012-03-29 Thu 7:30-16:40>"
- (org-element-property :type (org-element-context)))))
- ;; Date range.
- (should
- (org-test-with-temp-text "[2012-03-29 Thu 16:40]--[2012-03-29 Thu 16:41]"
- (eq (org-element-property :type (org-element-context)) 'inactive-range)))
- (should-not
- (org-test-with-temp-text "[2011-07-14 Thu]--[2012-03-29 Thu]"
- (let ((timestamp (org-element-context)))
- (or (org-element-property :hour-end timestamp)
- (org-element-property :minute-end timestamp)))))
- ;; With repeater, warning delay and both.
- (should
- (eq 'catch-up
- (org-test-with-temp-text "<2012-03-29 Thu ++1y>"
- (org-element-property :repeater-type (org-element-context)))))
- (should
- (eq 'first
- (org-test-with-temp-text "<2012-03-29 Thu --1y>"
- (org-element-property :warning-type (org-element-context)))))
- (should
- (equal '(cumulate all)
- (org-test-with-temp-text "<2012-03-29 Thu +1y -1y>"
- (let ((ts (org-element-context)))
- (list (org-element-property :repeater-type ts)
- (org-element-property :warning-type ts)))))))
- ;;;; Underline
- (ert-deftest test-org-element/underline-parser ()
- "Test `underline' parser."
- ;; Regular test.
- (should
- (org-test-with-temp-text "_underline_"
- (org-element-map (org-element-parse-buffer) 'underline #'identity)))
- ;; Multi-line markup.
- (should
- (equal
- (org-element-contents
- (org-test-with-temp-text "_first line\nsecond line_"
- (org-element-map
- (org-element-parse-buffer) 'underline #'identity nil t)))
- '("first line\nsecond line"))))
- ;;;; Verbatim
- (ert-deftest test-org-element/verbatim-parser ()
- "Test `verbatim' parser."
- ;; Regular test.
- (should
- (org-test-with-temp-text "=verbatim="
- (org-element-map (org-element-parse-buffer) 'verbatim #'identity)))
- ;; Multi-line markup.
- (should
- (equal
- (org-element-property
- :value
- (org-test-with-temp-text "=first line\nsecond line="
- (org-element-map (org-element-parse-buffer) 'verbatim #'identity nil t)))
- "first line\nsecond line")))
- ;;;; Verse Block
- (ert-deftest test-org-element/verse-block-parser ()
- "Test `verse-block' parser."
- ;; Standard test.
- (should
- (org-test-with-temp-text "#+BEGIN_VERSE\nVerse block\n#+END_VERSE"
- (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
- ;; Ignore case.
- (should
- (org-test-with-temp-text "#+begin_verse\nVerse block\n#+end_verse"
- (org-element-map (org-element-parse-buffer) 'verse-block 'identity)))
- ;; Parse objects in verse blocks.
- (should
- (org-test-with-temp-text "#+BEGIN_VERSE\nVerse \\alpha\n#+END_VERSE"
- (org-element-map (org-element-parse-buffer) 'entity 'identity)))
- ;; Ignore incomplete verse block.
- (should-not
- (org-test-with-temp-text "#+BEGIN_VERSE"
- (org-element-map (org-element-parse-buffer) 'verse-block 'identity nil t)))
- ;; Handle non-empty blank line at the end of buffer.
- (should
- (org-test-with-temp-text "#+BEGIN_VERSE\nC\n#+END_VERSE\n "
- (= (org-element-property :end (org-element-at-point)) (point-max)))))
- ;;; Test Interpreters.
- (ert-deftest test-org-element/interpret-data ()
- "Test `org-element-interpret-data' specifications."
- ;; Interpret simple affiliated keywords.
- (should
- (equal
- (org-element-interpret-data
- '(org-data nil (paragraph (:name "para") "Paragraph")))
- "#+name: para\nParagraph\n"))
- ;; Interpret multiple affiliated keywords.
- (should
- (equal
- (org-element-interpret-data
- '(org-data nil (paragraph (:attr_ascii ("line2" "line1")) "Paragraph")))
- "#+attr_ascii: line1\n#+attr_ascii: line2\nParagraph\n"))
- ;; Interpret parsed affiliated keywords.
- (should
- (equal
- (org-element-interpret-data
- '(org-data nil (paragraph (:caption (("caption"))) "Paragraph")))
- "#+caption: caption\nParagraph\n"))
- ;; Interpret dual affiliated keywords.
- (should
- (equal
- (org-element-interpret-data
- '(org-data nil (paragraph (:caption ((("long") "short"))) "Paragraph")))
- "#+caption[short]: long\nParagraph\n"))
- ;; Interpret multiple parsed dual keywords.
- (should
- (equal
- (org-element-interpret-data
- '(org-data nil (paragraph
- (:caption ((("l2") "s2") (("l1") "s1"))) "Paragraph")))
- "#+caption[s1]: l1\n#+caption[s2]: l2\nParagraph\n"))
- ;; Pseudo objects and elements are transparent.
- (should
- (equal "A B"
- (org-trim
- (org-element-interpret-data
- '(paragraph nil (pseudo-object (:post-blank 1) "A") "B")))))
- (should
- (equal "A\n\nB\n"
- (org-element-interpret-data
- '(center nil
- (pseudo-element (:post-blank 1) (paragraph nil "A"))
- (paragraph nil "B")))))
- ;; Obey post-blank property in strings.
- (should
- (equal "A "
- (org-element-interpret-data
- (org-element-put-property "A" :post-blank 1)))))
- (ert-deftest test-org-element/center-block-interpreter ()
- "Test center block interpreter."
- (should
- (equal (org-test-parse-and-interpret "#+BEGIN_CENTER\nTest\n#+END_CENTER")
- "#+begin_center\nTest\n#+end_center\n")))
- (ert-deftest test-org-element/drawer-interpreter ()
- "Test drawer interpreter."
- (should
- (equal (org-test-parse-and-interpret ":TEST:\nTest\n:END:")
- ":TEST:\nTest\n:END:\n")))
- (ert-deftest test-org-element/dynamic-block-interpreter ()
- "Test dynamic block interpreter."
- (should
- (equal (org-test-parse-and-interpret
- "#+BEGIN: myblock :parameter value1\nTest\n#+END:")
- "#+begin: myblock :parameter value1\nTest\n#+end:\n")))
- (ert-deftest test-org-element/footnote-definition-interpreter ()
- "Test footnote definition interpreter."
- (should (equal (org-test-parse-and-interpret "[fn:1] Test") "[fn:1] Test\n"))
- ;; Handle `:pre-blank' in definitions.
- (should
- (equal (org-test-parse-and-interpret "[fn:1]\nparagraph")
- "[fn:1]\nparagraph\n"))
- (should
- (equal (org-test-parse-and-interpret "[fn:1]\n\nparagraph")
- "[fn:1]\n\nparagraph\n")))
- (ert-deftest test-org-element/headline-interpreter ()
- "Test headline and section interpreters."
- ;; 1. Standard test.
- (should (equal (org-test-parse-and-interpret "* Headline") "* Headline\n"))
- ;; 2. With TODO keywords.
- (should
- (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
- (org-test-parse-and-interpret "* TODO Headline"))
- "* TODO Headline\n"))
- ;; 3. With tags...
- ;;
- ;; 3.1. ... and a positive `org-tags-column' value.
- (should
- (equal (let ((org-tags-column 20))
- (org-test-parse-and-interpret "* Headline :tag:"))
- "* Headline :tag:\n"))
- ;; 3.2. ... and a negative `org-tags-column' value.
- (should
- (equal (let ((org-tags-column -20))
- (org-test-parse-and-interpret "* Headline :tag:"))
- "* Headline :tag:\n"))
- ;; 3.3. ... and a null `org-tags-column' value.
- (should
- (equal (let ((org-tags-column 0))
- (org-test-parse-and-interpret "* Headline :tag:"))
- "* Headline :tag:\n"))
- ;; 4. With priority cookie.
- (should
- (equal (org-test-parse-and-interpret "* [#B] Headline")
- "* [#B] Headline\n"))
- ;; 5. With comment keyword.
- (should
- (equal (let ((org-comment-string "COMMENT"))
- (org-test-parse-and-interpret "* COMMENT Headline"))
- "* COMMENT Headline\n"))
- ;; 6. Keep same number of blank lines before body.
- (should
- (equal (org-test-parse-and-interpret
- "* Headline\n\n\nText after two blank lines.")
- "* Headline\n\n\nText after two blank lines.\n"))
- ;; 8. Preserve `org-odd-levels-only' state.
- (should
- (equal "* H\n*** H2\n"
- (let ((org-odd-levels-only t))
- (org-test-parse-and-interpret "* H\n*** H2")))))
- (ert-deftest test-org-element/inlinetask-interpreter ()
- "Test inlinetask interpretation."
- (when (featurep 'org-inlinetask)
- (let ((org-inlinetask-min-level 15))
- ;; 1. Regular inlinetask.
- (should (equal (org-test-parse-and-interpret
- "*************** Task\nTest\n*************** END")
- "*************** Task\nTest\n*************** end\n"))
- ;; 2. Degenerate inlinetask.
- (should (equal (org-test-parse-and-interpret "*************** Task")
- "*************** Task\n"))
- ;; 3. Prefer degenerate form when there are no contents.
- (should (equal (org-test-parse-and-interpret
- "*************** Task\n*************** end")
- "*************** Task\n"))
- ;; 4. With TODO keywords.
- (should
- (equal (let ((org-todo-keywords '((sequence "TODO" "DONE"))))
- (org-test-parse-and-interpret "*************** TODO Task"))
- "*************** TODO Task\n"))
- ;; 5. With tags...
- ;;
- ;; 5.1. ... and a positive `org-tags-column' value.
- (should
- (equal (let ((org-tags-column 30))
- (org-test-parse-and-interpret "*************** Task :tag:"))
- "*************** Task :tag:\n"))
- ;; 5.2. ... and a negative `org-tags-column' value.
- (should
- (equal (let ((org-tags-column -30))
- (org-test-parse-and-interpret "*************** Task :tag:"))
- "*************** Task :tag:\n"))
- ;; 5.3. ... and a null `org-tags-column' value.
- (should
- (equal (let ((org-tags-column 0))
- (org-test-parse-and-interpret "*************** Task :tag:"))
- "*************** Task :tag:\n"))
- ;; 6. With priority cookie.
- (should
- (equal (org-test-parse-and-interpret "*************** [#B] Task")
- "*************** [#B] Task\n")))))
- (ert-deftest test-org-element/plain-list-interpreter ()
- "Test plain-list and item interpreters."
- (let ((org-list-two-spaces-after-bullet-regexp nil))
- ;; Unordered list.
- (should (equal (org-test-parse-and-interpret "- item 1") "- item 1\n"))
- ;; Description list.
- (should
- (equal (org-test-parse-and-interpret "- tag :: desc") "- tag :: desc\n"))
- ;; Ordered list.
- (should
- (equal (let ((org-plain-list-ordered-item-terminator t))
- (org-test-parse-and-interpret "1. Item"))
- "1. Item\n"))
- (should
- (equal (let ((org-plain-list-ordered-item-terminator ?\)))
- (org-test-parse-and-interpret "1) Item"))
- "1) Item\n"))
- ;; Ordered list with counter.
- (should
- (equal (let ((org-plain-list-ordered-item-terminator t))
- (org-test-parse-and-interpret "1. [@5] Item"))
- "5. [@5] Item\n"))
- ;; List with check-boxes.
- (should
- (equal (org-test-parse-and-interpret
- "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3")
- "- [-] Item 1\n - [X] Item 2\n - [ ] Item 3\n"))
- ;; Item not starting with a paragraph.
- (should
- (equal (org-test-parse-and-interpret "-\n | a | b |")
- "- \n | a | b |\n"))
- ;; Handle `:pre-blank' in items.
- (should
- (equal (org-test-parse-and-interpret "-\n paragraph")
- "- \n paragraph\n"))
- (should
- (equal (org-test-parse-and-interpret "-\n\n paragraph")
- "- \n\n paragraph\n"))
- ;; Special case: correctly handle "*" bullets.
- (should (org-test-parse-and-interpret " * item"))
- ;; Special case: correctly handle empty items.
- (should (org-test-parse-and-interpret "-"))))
- (ert-deftest test-org-element/quote-block-interpreter ()
- "Test quote block interpreter."
- (should (equal (org-test-parse-and-interpret
- "#+BEGIN_QUOTE\nTest\n#+END_QUOTE")
- "#+begin_quote\nTest\n#+end_quote\n")))
- (ert-deftest test-org-element/special-block-interpreter ()
- "Test special block interpreter."
- (should (equal (org-test-parse-and-interpret
- "#+BEGIN_SPECIAL\nTest\n#+END_SPECIAL")
- "#+begin_SPECIAL\nTest\n#+end_SPECIAL\n"))
- ;; No content
- (should (equal (org-test-parse-and-interpret
- "#+BEGIN_SPECIAL\n#+END_SPECIAL")
- "#+begin_SPECIAL\n#+end_SPECIAL\n")))
- (ert-deftest test-org-element/babel-call-interpreter ()
- "Test Babel call interpreter."
- ;; Without argument.
- (should (equal (org-test-parse-and-interpret "#+CALL: test()")
- "#+call: test()\n"))
- ;; With argument.
- (should (equal (org-test-parse-and-interpret "#+CALL: test(x=2)")
- "#+call: test(x=2)\n"))
- ;; With header arguments.
- (should (equal (org-test-parse-and-interpret
- "#+CALL: test[:results output]() :results html")
- "#+call: test[:results output]() :results html\n")))
- (ert-deftest test-org-element/clock-interpreter ()
- "Test clock interpreter."
- ;; Running clock.
- (should
- (string-match
- "CLOCK: \\[2012-01-01 .* 00:01\\]"
- (org-test-parse-and-interpret "CLOCK: [2012-01-01 sun. 00:01]")))
- ;; Closed clock.
- (should
- (string-match
- "CLOCK: \\[2012-01-01 .* 00:01\\]--\\[2012-01-01 .* 00:02\\] => 0:01"
- (org-test-parse-and-interpret "
- CLOCK: [2012-01-01 sun. 00:01]--[2012-01-01 sun. 00:02] => 0:01"))))
- (ert-deftest test-org-element/comment-interpreter ()
- "Test comment interpreter."
- ;; Regular comment.
- (should (equal (org-test-parse-and-interpret "# Comment") "# Comment\n"))
- ;; Inline comment.
- (should (equal (org-test-parse-and-interpret " # Comment")
- "# Comment\n"))
- ;; Preserve indentation.
- (should (equal (org-test-parse-and-interpret " # No blank\n# One blank")
- "# No blank\n# One blank\n")))
- (ert-deftest test-org-element/comment-block-interpreter ()
- "Test comment block interpreter."
- (should (equal (org-test-parse-and-interpret
- "#+BEGIN_COMMENT\nTest\n#+END_COMMENT")
- "#+begin_comment\nTest\n#+end_comment\n"))
- ;; Accept missing final newline in value.
- (should
- (equal "#+begin_comment\nTest\n#+end_comment\n"
- (org-element-interpret-data '(comment-block (:value "Test"))))))
- (ert-deftest test-org-element/diary-sexp ()
- "Test diary-sexp interpreter."
- (should
- (equal
- (org-test-parse-and-interpret
- "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old")
- "%%(org-anniversary 1956 5 14)(2) Arthur Dent is %d years old\n")))
- (ert-deftest test-org-element/example-block-interpreter ()
- "Test example block interpreter."
- ;; Without switches.
- (should (equal "#+begin_example\nTest\n#+end_example\n"
- (let ((org-src-preserve-indentation t))
- (org-test-parse-and-interpret
- "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE"))))
- ;; With switches.
- (should
- (equal "#+begin_example -n -k\n(+ 1 1)\n#+end_example\n"
- (let ((org-src-preserve-indentation t))
- (org-test-parse-and-interpret
- "#+BEGIN_EXAMPLE -n -k\n(+ 1 1)\n#+END_EXAMPLE"))))
- ;; Preserve code escaping.
- (should
- (equal
- (let ((org-src-preserve-indentation t))
- (org-test-parse-and-interpret
- "#+BEGIN_EXAMPLE\n,* Headline\n,#+KEYWORD: value\nText\n#+END_EXAMPLE"))
- "#+begin_example\n,* Headline\n,#+KEYWORD: value\nText\n#+end_example\n"))
- ;; Accept missing final newline in value.
- (should
- (equal
- "#+begin_example\nTest\n#+end_example\n"
- (let ((org-src-preserve-indentation t))
- (org-element-interpret-data '(example-block (:value "Test"))))))
- ;; Handle indentation.
- (should (equal "#+begin_example\n Test\n#+end_example\n"
- (let ((org-src-preserve-indentation nil)
- (org-edit-src-content-indentation 2))
- (org-test-parse-and-interpret
- "#+BEGIN_EXAMPLE\nTest\n#+END_EXAMPLE"))))
- (should (equal "#+begin_example\n Test\n#+end_example\n"
- (let ((org-src-preserve-indentation t)
- (org-edit-src-content-indentation 2))
- (org-test-parse-and-interpret
- "#+BEGIN_EXAMPLE\n Test\n#+END_EXAMPLE")))))
- (ert-deftest test-org-element/export-block-interpreter ()
- "Test export block interpreter."
- (should (equal (org-test-parse-and-interpret
- "#+begin_export HTML\nTest\n#+end_export")
- "#+begin_export HTML\nTest\n#+end_export\n")))
- (ert-deftest test-org-element/fixed-width-interpreter ()
- "Test fixed width interpreter."
- ;; Standard test.
- (should (equal (org-test-parse-and-interpret ": Test") ": Test\n"))
- ;; Preserve indentation.
- (should (equal (org-test-parse-and-interpret ": 2 blanks\n: 1 blank")
- ": 2 blanks\n: 1 blank\n"))
- ;; Handle empty string.
- (should
- (equal (org-element-fixed-width-interpreter
- '(fixed-width (:value "")) nil)
- ""))
- ;; Handle nil value.
- (should-not
- (org-element-fixed-width-interpreter
- '(fixed-width (:value nil)) nil)))
- (ert-deftest test-org-element/horizontal-rule-interpreter ()
- "Test horizontal rule interpreter."
- (should (equal (org-test-parse-and-interpret "-------") "-----\n")))
- (ert-deftest test-org-element/keyword-interpreter ()
- "Test keyword interpreter."
- (should (equal (org-test-parse-and-interpret "#+KEYWORD: value")
- "#+keyword: value\n")))
- (ert-deftest test-org-element/latex-environment-interpreter ()
- "Test latex environment interpreter."
- (should (equal (org-test-parse-and-interpret
- "\\begin{equation}\n1+1=2\n\\end{equation}")
- "\\begin{equation}\n1+1=2\n\\end{equation}\n"))
- (should (equal (org-test-parse-and-interpret
- "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}")
- "\\begin{theorem}[me]\n1+1=2\n\\end{theorem}\n")))
- (ert-deftest test-org-element/planning-interpreter ()
- "Test planning interpreter."
- (should
- (string-match
- "\\* Headline
- DEADLINE: <2012-03-29 .*?> SCHEDULED: <2012-03-29 .*?> CLOSED: \\[2012-03-29 .*?\\]"
- (org-test-parse-and-interpret
- "* Headline
- DEADLINE: <2012-03-29 thu.> SCHEDULED: <2012-03-29 thu.> CLOSED: [2012-03-29 thu.]"))))
- (ert-deftest test-org-element/property-drawer-interpreter ()
- "Test property drawer interpreter."
- (should (equal (let ((org-property-format "%-10s %s"))
- (org-test-parse-and-interpret
- "* H\n:PROPERTIES:\n:prop: value\n:END:"))
- "* H\n:PROPERTIES:\n:prop: value\n:END:\n")))
- (ert-deftest test-org-element/src-block-interpreter ()
- "Test src block interpreter."
- ;; With arguments.
- (should
- (equal (let ((org-edit-src-content-indentation 2)
- (org-src-preserve-indentation nil))
- (org-test-parse-and-interpret
- "#+BEGIN_SRC emacs-lisp :results silent\n(+ 1 1)\n#+END_SRC"))
- "#+begin_src emacs-lisp :results silent\n (+ 1 1)\n#+end_src\n"))
- ;; With switches.
- (should
- (equal (let ((org-edit-src-content-indentation 2)
- (org-src-preserve-indentation nil))
- (org-test-parse-and-interpret
- "#+BEGIN_SRC emacs-lisp -n -k\n(+ 1 1)\n#+END_SRC"))
- "#+begin_src emacs-lisp -n -k\n (+ 1 1)\n#+end_src\n"))
- ;; Preserve code escaping.
- (should
- (equal
- (let ((org-edit-src-content-indentation 2)
- (org-src-preserve-indentation nil))
- (org-test-parse-and-interpret
- "#+BEGIN_SRC org\n,* Headline\n,#+KEYWORD: value\nText\n#+END_SRC"))
- "#+begin_src org\n ,* Headline\n ,#+KEYWORD: value\n Text\n#+end_src\n"))
- ;; Do not apply `org-edit-src-content-indentation' when preserving
- ;; indentation.
- (should
- (equal (let ((org-edit-src-content-indentation 2)
- (org-src-preserve-indentation t))
- (org-test-parse-and-interpret
- "#+BEGIN_SRC emacs-lisp\n(+ 1 1)\n#+END_SRC"))
- "#+begin_src emacs-lisp\n(+ 1 1)\n#+end_src\n"))
- (should
- (equal (let ((org-edit-src-content-indentation 2)
- (org-src-preserve-indentation nil))
- (org-test-parse-and-interpret
- "#+BEGIN_SRC emacs-lisp -i\n(+ 1 1)\n#+END_SRC"))
- "#+begin_src emacs-lisp -i\n(+ 1 1)\n#+end_src\n"))
- ;; Accept missing final newline in value.
- (should
- (equal
- "#+begin_src emacs-lisp\n Test\n#+end_src\n"
- (let ((org-edit-src-content-indentation 2)
- (org-src-preserve-indentation nil))
- (org-element-interpret-data
- '(src-block (:language "emacs-lisp" :value "Test")))))))
- (ert-deftest test-org-element/table-interpreter ()
- "Test table, table-row and table-cell interpreters."
- ;; 1. Simple table.
- (should (equal (org-test-parse-and-interpret "| a | b |\n| c | d |")
- "| a | b |\n| c | d |\n"))
- ;; 2. With horizontal rules.
- (should (equal (org-test-parse-and-interpret
- "| a | b |\n|---+---|\n| c | d |")
- "| a | b |\n|---+---|\n| c | d |\n"))
- ;; 3. With meta-data.
- (should (equal (org-test-parse-and-interpret "| / | < | > |\n| * | 1 | 2 |")
- "| / | < | > |\n| * | 1 | 2 |\n"))
- ;; 4. With a formula.
- (should
- (equal (org-test-parse-and-interpret
- "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)")
- "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: @3=vmean(@1..@2)\n"))
- ;; 5. With multiple formulas.
- (should
- (equal (org-test-parse-and-interpret
- "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2")
- "| 2 |\n| 4 |\n| 3 |\n#+TBLFM: test1\n#+TBLFM: test2\n")))
- (ert-deftest test-org-element/timestamp-interpreter ()
- "Test timestamp interpreter."
- ;; Active.
- (should
- (string-match "<2012-03-29 .* 16:40>"
- (org-test-parse-and-interpret "<2012-03-29 thu. 16:40>")))
- (should
- (string-match "<2012-03-29 .* 16:40>"
- (org-element-timestamp-interpreter
- '(timestamp
- (:type active :year-start 2012 :month-start 3 :day-start 29
- :hour-start 16 :minute-start 40)) nil)))
- ;; Inactive.
- (should
- (string-match "\\[2012-03-29 .* 16:40\\]"
- (org-test-parse-and-interpret "[2012-03-29 thu. 16:40]")))
- (should
- (string-match
- "\\[2012-03-29 .* 16:40\\]"
- (org-element-timestamp-interpreter
- '(timestamp
- (:type inactive :year-start 2012 :month-start 3 :day-start 29
- :hour-start 16 :minute-start 40)) nil)))
- ;; Active range.
- (should
- (string-match "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
- (org-test-parse-and-interpret
- "<2012-03-29 thu. 16:40>--<2012-03-29 thu. 16:41>")))
- (should
- (string-match
- "<2012-03-29 .* 16:40>--<2012-03-29 .* 16:41>"
- (org-element-timestamp-interpreter
- '(timestamp
- (:type active-range :year-start 2012 :month-start 3 :day-start 29
- :hour-start 16 :minute-start 40 :year-end 2012 :month-end 3
- :day-end 29 :hour-end 16 :minute-end 41)) nil)))
- ;; Inactive range.
- (should
- (string-match "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
- (org-test-parse-and-interpret
- "[2012-03-29 thu. 16:40]--[2012-03-29 thu. 16:41]")))
- (should
- (string-match
- "\\[2012-03-29 .* 16:40\\]--\\[2012-03-29 .* 16:41\\]"
- (org-element-timestamp-interpreter
- '(timestamp
- (:type inactive-range :year-start 2012 :month-start 3 :day-start 29
- :hour-start 16 :minute-start 40 :year-end 2012 :month-end 3
- :day-end 29 :hour-end 16 :minute-end 41)) nil)))
- ;; Diary.
- (should (equal (org-test-parse-and-interpret "<%%diary-float t 4 2>")
- "<%%diary-float t 4 2>\n"))
- ;; Timestamp with repeater interval, with delay, with both.
- (should
- (string-match "<2012-03-29 .* \\+1y>"
- (org-test-parse-and-interpret "<2012-03-29 thu. +1y>")))
- (should
- (string-match
- "<2012-03-29 .* \\+1y>"
- (org-element-timestamp-interpreter
- '(timestamp
- (:type active :year-start 2012 :month-start 3 :day-start 29
- :repeater-type cumulate :repeater-value 1 :repeater-unit year))
- nil)))
- (should
- (string-match
- "<2012-03-29 .* -1y>"
- (org-element-timestamp-interpreter
- '(timestamp
- (:type active :year-start 2012 :month-start 3 :day-start 29
- :warning-type all :warning-value 1 :warning-unit year))
- nil)))
- (should
- (string-match
- "<2012-03-29 .* \\+1y -1y>"
- (org-element-timestamp-interpreter
- '(timestamp
- (:type active :year-start 2012 :month-start 3 :day-start 29
- :warning-type all :warning-value 1 :warning-unit year
- :repeater-type cumulate :repeater-value 1 :repeater-unit year))
- nil)))
- ;; Timestamp range with repeater interval
- (should
- (string-match "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
- (org-test-parse-and-interpret
- "<2012-03-29 Thu +1y>--<2012-03-30 Thu +1y>")))
- (should
- (string-match
- "<2012-03-29 .* \\+1y>--<2012-03-30 .* \\+1y>"
- (org-element-timestamp-interpreter
- '(timestamp
- (:type active-range :year-start 2012 :month-start 3 :day-start 29
- :year-end 2012 :month-end 3 :day-end 30 :repeater-type cumulate
- :repeater-value 1 :repeater-unit year))
- nil))))
- (ert-deftest test-org-element/verse-block-interpreter ()
- "Test verse block interpretation."
- (should
- (equal (org-test-parse-and-interpret "#+BEGIN_VERSE\nTest\n#+END_VERSE")
- "#+begin_verse\nTest\n#+end_verse\n")))
- (ert-deftest test-org-element/bold-interpreter ()
- "Test bold interpreter."
- (should (equal (org-test-parse-and-interpret "*text*") "*text*\n")))
- (ert-deftest test-org-element/citation-interpreter ()
- "Test citation interpreter."
- (should
- (equal "[cite:@key]\n"
- (org-test-parse-and-interpret "[cite:@key]")))
- (should
- (equal "[cite:-@key]\n"
- (org-test-parse-and-interpret "[cite:-@key]")))
- (should
- (equal "[cite/style:@key]\n"
- (org-test-parse-and-interpret "[cite/style:@key]")))
- (should
- (equal "[cite:pre @key]\n"
- (org-test-parse-and-interpret "[cite:pre @key]")))
- (should
- (equal "[cite:@key post]\n"
- (org-test-parse-and-interpret "[cite:@key post]")))
- (should
- (equal "[cite:@a ;b]\n"
- (org-test-parse-and-interpret "[cite: @a ;b]")))
- (should
- (equal "[cite:@a;@b;@c]\n"
- (org-test-parse-and-interpret "[cite:@a;@b;@c]")))
- (should
- (equal "[cite:common-pre ; @a]\n"
- (org-test-parse-and-interpret "[cite:common-pre ; @a]")))
- (should
- (equal "[cite:@a ; common-post]\n"
- (org-test-parse-and-interpret "[cite:@a ; common-post]"))))
- (ert-deftest test-org-element/code-interpreter ()
- "Test code interpreter."
- (should (equal (org-test-parse-and-interpret "~text~") "~text~\n")))
- (ert-deftest test-org-element/entity-interpreter ()
- "Test entity interpreter."
- ;; 1. Without brackets.
- (should
- (equal (org-test-parse-and-interpret "\\alpha text") "\\alpha text\n"))
- ;; 2. With brackets.
- (should
- (equal (org-test-parse-and-interpret "\\alpha{}text") "\\alpha{}text\n")))
- (ert-deftest test-org-element/export-snippet-interpreter ()
- "Test export snippet interpreter."
- (should (equal (org-test-parse-and-interpret "@@back-end:contents@@")
- "@@back-end:contents@@\n")))
- (ert-deftest test-org-element/footnote-reference-interpreter ()
- "Test footnote reference interpreter."
- ;; Regular reference.
- (should (equal (org-test-parse-and-interpret "Text[fn:1]") "Text[fn:1]\n"))
- ;; Named reference.
- (should (equal (org-test-parse-and-interpret "Text[fn:label]")
- "Text[fn:label]\n"))
- ;; Inline reference.
- (should (equal (org-test-parse-and-interpret "Text[fn:label:def]")
- "Text[fn:label:def]\n"))
- ;; Anonymous reference.
- (should (equal (org-test-parse-and-interpret "Text[fn::def]")
- "Text[fn::def]\n")))
- (ert-deftest test-org-element/inline-babel-call-interpreter ()
- "Test inline babel call interpreter."
- ;; Without arguments.
- (should (equal (org-test-parse-and-interpret "call_test()") "call_test()\n"))
- ;; With arguments.
- (should (equal (org-test-parse-and-interpret "call_test(x=2)")
- "call_test(x=2)\n"))
- ;; With header arguments.
- (should (equal (org-test-parse-and-interpret
- "call_test[:results output]()[:results html]")
- "call_test[:results output]()[:results html]\n")))
- (ert-deftest test-org-element/inline-src-block-interpreter ()
- "Test inline src block interpreter."
- ;; 1. Without header argument.
- (should (equal (org-test-parse-and-interpret "src_emacs-lisp{(+ 1 1)}")
- "src_emacs-lisp{(+ 1 1)}\n"))
- ;; 2. With header arguments.
- (should (equal (org-test-parse-and-interpret
- "src_emacs-lisp[:results silent]{(+ 1 1)}")
- "src_emacs-lisp[:results silent]{(+ 1 1)}\n")))
- (ert-deftest test-org-element/italic-interpreter ()
- "Test italic interpreter."
- (should (equal (org-test-parse-and-interpret "/text/") "/text/\n")))
- (ert-deftest test-org-element/latex-fragment-interpreter ()
- "Test latex fragment interpreter."
- (should (equal (org-test-parse-and-interpret "\\command{}") "\\command{}\n"))
- (should (equal (org-test-parse-and-interpret "$x$") "$x$\n"))
- (should (equal (org-test-parse-and-interpret "$x+y$") "$x+y$\n"))
- (should (equal (org-test-parse-and-interpret "$$x+y$$") "$$x+y$$\n"))
- (should (equal (org-test-parse-and-interpret "\\(x+y\\)") "\\(x+y\\)\n"))
- (should (equal (org-test-parse-and-interpret "\\[x+y\\]") "\\[x+y\\]\n")))
- (ert-deftest test-org-element/line-break-interpreter ()
- "Test line break interpreter."
- (should (equal (org-test-parse-and-interpret "First line \\\\ \nSecond line")
- "First line \\\\\nSecond line\n")))
- (ert-deftest test-org-element/link-interpreter ()
- "Test link interpreter."
- ;; Links targeted from a radio target.
- (should (equal (let ((org-target-link-regexp "radio-target"))
- (org-test-parse-and-interpret "a radio-target"))
- "a radio-target\n"))
- ;; Links without description.
- (should (equal (org-test-parse-and-interpret "[[https://orgmode.org]]")
- "[[https://orgmode.org]]\n"))
- ;; Links with a description, even one containing a link.
- (should (equal (org-test-parse-and-interpret
- "[[https://orgmode.org][Org mode]]")
- "[[https://orgmode.org][Org mode]]\n"))
- (should (equal (org-test-parse-and-interpret
- "[[https://orgmode.org][https://orgmode.org]]")
- "[[https://orgmode.org][https://orgmode.org]]\n"))
- ;; File links.
- (should
- (equal (org-test-parse-and-interpret "[[file+emacs:todo.org]]")
- "[[file+emacs:todo.org]]\n"))
- (should
- (equal (org-test-parse-and-interpret "[[file:todo.org::*task]]")
- "[[file:todo.org::*task]]\n"))
- ;; Id links.
- (should (equal (org-test-parse-and-interpret "[[id:aaaa]]") "[[id:aaaa]]\n"))
- ;; Custom-id links.
- (should (equal (org-test-parse-and-interpret "[[#id]]") "[[#id]]\n"))
- ;; Code-ref links.
- (should (equal (org-test-parse-and-interpret "[[(ref)]]") "[[(ref)]]\n"))
- ;; Plain links.
- (should (equal (org-test-parse-and-interpret "https://orgmode.org")
- "https://orgmode.org\n"))
- ;; Angular links.
- (should (equal (org-test-parse-and-interpret "<https://orgmode.org>")
- "<https://orgmode.org>\n"))
- ;; Pathological case: link with a %-sign in description.
- (should (equal (org-test-parse-and-interpret "[[file://path][%s]]")
- "[[file://path][%s]]\n")))
- (ert-deftest test-org-element/macro-interpreter ()
- "Test macro interpreter."
- ;; 1. Without argument.
- (should (equal (org-test-parse-and-interpret "{{{test}}}") "{{{test}}}\n"))
- ;; 2. With arguments.
- (should (equal (org-test-parse-and-interpret "{{{test(arg1,arg2)}}}")
- "{{{test(arg1,arg2)}}}\n")))
- (ert-deftest test-org-element/radio-target-interpreter ()
- "Test radio target interpreter."
- (should (equal (org-test-parse-and-interpret "<<<some text>>>")
- "<<<some text>>>\n")))
- (ert-deftest test-org-element/statistics-cookie-interpreter ()
- "Test statistics cookie interpreter."
- ;; 1. Without percent
- (should (equal (org-test-parse-and-interpret "[0/1]") "[0/1]\n"))
- ;; 2. With percent.
- (should (equal (org-test-parse-and-interpret "[66%]") "[66%]\n")))
- (ert-deftest test-org-element/strike-through-interpreter ()
- "Test strike through interpreter."
- (should (equal (org-test-parse-and-interpret "+target+") "+target+\n")))
- (ert-deftest test-org-element/subscript-interpreter ()
- "Test subscript interpreter."
- ;; 1. Without brackets.
- (should (equal (org-test-parse-and-interpret "a_b") "a_b\n"))
- ;; 2. With brackets.
- (should (equal (org-test-parse-and-interpret "a_{b}") "a_{b}\n")))
- (ert-deftest test-org-element/superscript-interpreter ()
- "Test superscript interpreter."
- ;; 1. Without brackets.
- (should (equal (org-test-parse-and-interpret "a^b") "a^b\n"))
- ;; 2. With brackets.
- (should (equal (org-test-parse-and-interpret "a^{b}") "a^{b}\n")))
- (ert-deftest test-org-element/target-interpreter ()
- "Test target interpreter."
- (should (equal (org-test-parse-and-interpret "<<target>>") "<<target>>\n")))
- (ert-deftest test-org-element/underline-interpreter ()
- "Test underline interpreter."
- (should (equal (org-test-parse-and-interpret "_text_") "_text_\n")))
- (ert-deftest test-org-element/verbatim-interpreter ()
- "Test verbatim interpreter."
- (should (equal (org-test-parse-and-interpret "=text=") "=text=\n")))
- ;;; Test Granularity
- (ert-deftest test-org-element/granularity ()
- "Test granularity impact on buffer parsing."
- (org-test-with-temp-text
- "* Head 1
- ** Head 2
- #+BEGIN_CENTER
- Centered paragraph.
- #+END_CENTER
- Paragraph \\alpha."
- ;; 1.1. Granularity set to `headline' should parse every headline
- ;; in buffer, and only them.
- (let ((tree (org-element-parse-buffer 'headline)))
- (should (= 2 (length (org-element-map tree 'headline 'identity))))
- (should-not (org-element-map tree 'paragraph 'identity)))
- ;; 1.2. Granularity set to `greater-element' should not enter
- ;; greater elements excepted headlines and sections.
- (let ((tree (org-element-parse-buffer 'greater-element)))
- (should (= 1 (length (org-element-map tree 'center-block 'identity))))
- (should (= 1 (length (org-element-map tree 'paragraph 'identity))))
- (should-not (org-element-map tree 'entity 'identity)))
- ;; 1.3. Granularity set to `element' should enter every
- ;; greater-element.
- (let ((tree (org-element-parse-buffer 'element)))
- (should (= 2 (length (org-element-map tree 'paragraph 'identity))))
- (should-not (org-element-map tree 'entity 'identity)))
- ;; 1.4. Granularity set to `object' can see everything.
- (let ((tree (org-element-parse-buffer 'object)))
- (should (= 1 (length (org-element-map tree 'entity 'identity)))))))
- (ert-deftest test-org-element/secondary-string-parsing ()
- "Test if granularity correctly toggles secondary strings parsing."
- ;; With a granularity bigger than `object', no secondary string
- ;; should be parsed.
- (should
- (stringp
- (org-test-with-temp-text "* Headline"
- (let ((headline
- (org-element-map (org-element-parse-buffer 'headline) 'headline
- #'identity nil 'first-match)))
- (org-element-property :title headline)))))
- (should
- (stringp
- (org-test-with-temp-text "* Headline\n- tag :: item"
- (let ((item (org-element-map (org-element-parse-buffer 'element) 'item
- #'identity nil 'first-match)))
- (org-element-property :tag item)))))
- (when (featurep 'org-inlinetask)
- (should
- (stringp
- (let ((org-inlinetask-min-level 15))
- (org-test-with-temp-text "*************** Inlinetask"
- (let ((inlinetask (org-element-map (org-element-parse-buffer 'element)
- 'inlinetask
- #'identity nil 'first-match)))
- (org-element-property :title inlinetask)))))))
- ;; With a default granularity, secondary strings should be parsed.
- (should
- (listp
- (org-test-with-temp-text "* Headline"
- (let ((headline
- (org-element-map (org-element-parse-buffer) 'headline
- #'identity nil 'first-match)))
- (org-element-property :title headline)))))
- ;; `org-element-at-point' should never parse a secondary string.
- (should-not
- (listp
- (org-test-with-temp-text "* Headline"
- (org-element-property :title (org-element-at-point)))))
- ;; Preserve current local variables when parsing a secondary string.
- (should
- (let ((org-entities nil)
- (org-entities-user nil))
- (org-test-with-temp-text "
- #+CAPTION: \\foo
- Text
- # Local Variables:
- # org-entities-user: ((\"foo\"))
- # End:"
- (let ((safe-local-variable-values '((org-entities-user . (("foo"))))))
- (hack-local-variables))
- (org-element-map (org-element-parse-buffer) 'entity
- #'identity nil nil nil t)))))
- ;;; Test Visible Only Parsing
- (ert-deftest test-org-element/parse-buffer-visible ()
- "Test `org-element-parse-buffer' with visible only argument."
- (should
- (equal '("H1" "H3" "H5")
- (org-test-with-temp-text
- "* H1\n** H2\n** H3 :visible:\n** H4\n** H5 :visible:"
- (org-occur ":visible:")
- (org-element-map (org-element-parse-buffer nil t) 'headline
- (lambda (hl) (org-element-property :raw-value hl))))))
- (should
- (equal "Test"
- (let ((contents "Test"))
- (org-test-with-temp-text contents
- (add-text-properties 0 1 '(invisible t) contents)
- (org-element-map (org-element-parse-buffer nil t) 'plain-text
- #'org-no-properties nil t)))))
- (should
- (equal "Test"
- (let ((contents "Test"))
- (org-test-with-temp-text (concat "- " contents)
- (add-text-properties 0 1 '(invisible t) contents)
- (org-element-map (org-element-parse-buffer nil t) 'plain-text
- #'org-no-properties nil t))))))
- ;;; Test `:parent' Property
- (ert-deftest test-org-element/parent-property ()
- "Test `:parent' property."
- ;; Elements.
- (org-test-with-temp-text "#+BEGIN_CENTER\nText\n#+END_CENTER"
- (let* ((tree (org-element-parse-buffer))
- (parent (org-element-property
- :parent
- (org-element-map tree 'paragraph 'identity nil t))))
- (should parent)
- (should (eq (org-element-map tree 'center-block 'identity nil t)
- parent))))
- ;; Objects.
- (org-test-with-temp-text "a_{/b/}"
- (let* ((tree (org-element-parse-buffer))
- (parent (org-element-property
- :parent
- (org-element-map tree 'italic 'identity nil t))))
- (should parent)
- (should (eq parent
- (org-element-map tree 'subscript 'identity nil t)))))
- ;; Secondary strings
- (org-test-with-temp-text "* /italic/"
- (let* ((tree (org-element-parse-buffer))
- (parent (org-element-property
- :parent (org-element-map tree 'italic 'identity nil t))))
- (should parent)
- (should (equal parent
- (org-element-map tree 'headline 'identity nil t))))))
- ;;; Test Normalize Contents
- (ert-deftest test-org-element/normalize-contents ()
- "Test `org-element-normalize-contents' specifications."
- ;; Remove maximum common indentation from element's contents.
- (should
- (equal
- (org-element-normalize-contents
- '(paragraph nil " Two spaces\n Three spaces"))
- '(paragraph nil "Two spaces\n Three spaces")))
- (should
- (equal
- (org-element-normalize-contents
- '(paragraph nil " Two spaces\nNo space"))
- '(paragraph nil " Two spaces\nNo space")))
- ;; Ignore objects within contents when computing maximum common
- ;; indentation. However, if contents start with an object, common
- ;; indentation is 0.
- (should
- (equal
- (org-element-normalize-contents
- '(paragraph nil " One " (emphasis nil "space") "\n Two spaces"))
- '(paragraph nil "One " (emphasis nil "space") "\n Two spaces")))
- (should
- (equal
- (org-element-normalize-contents
- '(paragraph nil (verbatim nil "V") "No space\n Two\n Three"))
- '(paragraph nil (verbatim nil "V") "No space\n Two\n Three")))
- ;; Ignore blank lines.
- (should
- (equal
- (org-element-normalize-contents
- '(paragraph nil " Two spaces\n\n \n Two spaces"))
- '(paragraph nil "Two spaces\n\n\nTwo spaces")))
- (should
- (equal
- '(paragraph nil " Two spaces\n" (verbatim nil "V") "\n Two spaces")
- (org-element-normalize-contents
- '(paragraph nil " Two spaces\n " (verbatim nil "V") "\n Two spaces"))))
- (should
- (equal
- '(verse-block nil "line 1\n\nline 2")
- (org-element-normalize-contents
- '(verse-block nil " line 1\n\n line 2"))))
- ;; Recursively enter objects in order to compute common indentation.
- (should
- (equal
- (org-element-normalize-contents
- '(paragraph nil " Two spaces " (bold nil " and\n One space")))
- '(paragraph nil " Two spaces " (bold nil " and\nOne space"))))
- ;; When optional argument is provided, ignore first line
- ;; indentation.
- (should
- (equal
- (org-element-normalize-contents
- '(paragraph nil "No space\n Two spaces\n Three spaces") t)
- '(paragraph nil "No space\nTwo spaces\n Three spaces")))
- (should
- (equal
- (org-element-normalize-contents
- '(paragraph nil (verbatim nil "V") "No space\n Two\n Three") t)
- '(paragraph nil (verbatim nil "V") "No space\nTwo\n Three")))
- ;; Corner case: do not ignore indentation of string right after
- ;; a line break.
- (should
- (equal
- (org-element-normalize-contents
- '(paragraph nil " 1 space" (line-break) " 2 spaces"))
- '(paragraph nil "1 space" (line-break) " 2 spaces"))))
- ;;; Test Navigation Tools.
- (ert-deftest test-org-element/at-point ()
- "Test `org-element-at-point' specifications."
- ;; Return closest element containing point.
- (should
- (eq 'paragraph
- (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
- (progn (search-forward "A")
- (org-element-type (org-element-at-point))))))
- ;; Correctly set `:parent' property.
- (should
- (eq 'center-block
- (org-test-with-temp-text "#+BEGIN_CENTER\nA\n#+END_CENTER"
- (progn (search-forward "A")
- (org-element-type
- (org-element-property :parent (org-element-at-point)))))))
- ;; Special case: at a blank line just below a headline, return that
- ;; headline.
- (should
- (equal "H1" (org-test-with-temp-text "* H1\n \n* H2\n"
- (forward-line)
- (org-element-property :title (org-element-at-point)))))
- ;; Special case: at the very beginning of a table, return `table'
- ;; object instead of `table-row'.
- (should
- (eq 'table
- (org-test-with-temp-text "| a | b |"
- (org-element-type (org-element-at-point)))))
- ;; Special case: at the very beginning of a list or sub-list, return
- ;; `plain-list' object instead of `item'.
- (should
- (eq 'plain-list
- (org-test-with-temp-text "- item"
- (org-element-type (org-element-at-point)))))
- ;; Special case: at the closing line of a greater element, be sure
- ;; to return it instead of the last element in its contents.
- (should
- (eq 'center-block
- (org-test-with-temp-text "#+BEGIN_CENTER\nParagraph\n#+END_CENTER"
- (progn (forward-line 2)
- (org-element-type (org-element-at-point))))))
- ;; Special case: at a blank line between two items, be sure to
- ;; return item above instead of the last element of its contents.
- (should
- (eq 'item
- (org-test-with-temp-text "- Para1\n\n- Para2"
- (forward-line)
- (org-element-type (org-element-at-point)))))
- ;; Special case: at the last blank line in a plain list, return it
- ;; instead of the last item.
- (should
- (eq 'plain-list
- (org-test-with-temp-text "- Para1\n- Para2\n\nPara3"
- (progn (forward-line 2)
- (org-element-type (org-element-at-point))))))
- ;; Special case: at the last blank line in a plain list at the end of
- ;; a headline, return the plain list, not the last item, and not the
- ;; headline.
- (should
- (eq 'plain-list
- (org-test-with-temp-text "* Headline\n- Para1\n- Para2\n\nPara3\n* Another headline"
- (progn (forward-line 3)
- (org-element-type (org-element-at-point))))))
- ;; Special case: when a list ends at the end of buffer and there's
- ;; no final newline, return last element in last item.
- (should
- (eq 'paragraph
- (org-test-with-temp-text "- a"
- (end-of-line)
- (org-element-type (org-element-at-point)))))
- ;; Parse a list within a block itself contained in a list.
- (should
- (eq 'plain-list
- (org-test-with-temp-text
- "- outer\n #+begin_center\n - inner\n #+end_center"
- (search-forward "inner")
- (beginning-of-line)
- (org-element-type (org-element-at-point)))))
- ;; Do not error at eob on an empty line.
- (should
- (org-test-with-temp-text "* H\n"
- (forward-line)
- (or (org-element-at-point) t)))
- ;; Return greater element when outside contents.
- (should
- (eq 'drawer
- (org-test-with-temp-text
- ":DRAWER:\ntest\n:EN<point>D:\n"
- (org-element-type (org-element-at-point)))))
- (should
- (eq 'drawer
- (org-test-with-temp-text
- ":DRA<point>WER:\ntest\n:END:\n"
- (org-element-type (org-element-at-point)))))
- ;; Return greater element when at :contents-end.
- (should
- (eq 'drawer
- (org-test-with-temp-text
- ":DRAWER:\ntest\n<point>:END:\n"
- (org-element-type (org-element-at-point))))))
- (ert-deftest test-org-element/context ()
- "Test `org-element-context' specifications."
- ;; Return closest object containing point.
- (should
- (eq 'underline
- (org-test-with-temp-text "Some *text with _under<point>line_ text*"
- (org-element-type (org-element-context)))))
- ;; Find objects in secondary strings.
- (should
- (eq 'underline
- (org-test-with-temp-text "* Headline _<point>with_ underlining"
- (org-element-type (org-element-context)))))
- ;; Find objects in objects.
- (should
- (eq 'macro
- (org-test-with-temp-text "| a | {<point>{{macro}}} |"
- (org-element-type (org-element-context)))))
- (should
- (eq 'table-cell
- (org-test-with-temp-text "| a | b<point> {{{macro}}} |"
- (org-element-type (org-element-context)))))
- ;; Find objects in item tags.
- (should
- (eq 'bold
- (org-test-with-temp-text "- *bo<point>ld* ::"
- (org-element-type (org-element-context)))))
- (should-not
- (eq 'bold
- (org-test-with-temp-text "- *bold* ::<point>"
- (org-element-type (org-element-context)))))
- (should-not
- (eq 'bold
- (org-test-with-temp-text "- *bold* ::\n<point>"
- (org-element-type (org-element-context)))))
- ;; Do not find objects in table rules.
- (should
- (eq 'table-row
- (org-test-with-temp-text "| a | b |\n|-<point>--|---|\n| c | d |"
- (org-element-type (org-element-context)))))
- ;; Find objects in parsed affiliated keywords.
- (should
- (eq 'macro
- (org-test-with-temp-text "#+CAPTION: {<point>{{macro}}}\n| a | b |"
- (org-element-type (org-element-context)))))
- (should
- (eq 'bold
- (org-test-with-temp-text "#+caption: *<point>bold*\nParagraph"
- (org-element-type (org-element-context)))))
- ;; Find objects at the end of buffer.
- (should
- (eq 'bold
- (org-test-with-temp-text "*bold*"
- (goto-char (point-max))
- (org-element-type (org-element-context)))))
- ;; Correctly set `:parent' property.
- (should
- (eq 'paragraph
- (org-test-with-temp-text "Some *bold<point>* text"
- (org-element-type
- (org-element-property :parent (org-element-context))))))
- ;; Between two objects, return the second one.
- (should
- (eq 'macro
- (org-test-with-temp-text "<<target>><point>{{{test}}}"
- (org-element-type (org-element-context)))))
- ;; Test optional argument.
- (should
- (eq 'underline
- (org-test-with-temp-text "Some *text with _under<point>line_ text*"
- (org-element-type (org-element-context (org-element-at-point))))))
- ;; Special case: bold object at the beginning of a headline.
- (should
- (eq 'bold
- (org-test-with-temp-text "* *bo<point>ld*"
- (org-element-type (org-element-context)))))
- ;; Special case: incomplete cell at the end of a table row.
- (should
- (eq 'table-cell
- (org-test-with-temp-text "|a|b|c<point>"
- (org-element-type (org-element-context)))))
- ;; Special case: objects in inline footnotes.
- (should
- (eq 'link
- (org-test-with-temp-text "[fn::[[<point>https://orgmode.org]]]"
- (org-element-type (org-element-context)))))
- ;; Special case: tags looking like a link.
- (should-not
- (eq 'link
- (org-test-with-temp-text "* Headline :file<point>:tags:"
- (org-element-type (org-element-context)))))
- (should
- (eq 'link
- (org-test-with-temp-text "* Headline :file<point>:tags: :real:tag:"
- (org-element-type (org-element-context))))))
- ;;; Test Tools
- (ert-deftest test-org-element/lineage ()
- "Test `org-element-lineage' specifications."
- ;; Regular tests. When applied to an element or object returned by
- ;; `org-element-at-point' or `org-element-context', the list is
- ;; limited to the current section.
- (should
- (equal '(paragraph center-block section headline headline org-data)
- (org-test-with-temp-text
- "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
- (mapcar #'car (org-element-lineage (org-element-context))))))
- (should
- (equal '(paragraph center-block section headline headline org-data)
- (org-test-with-temp-text
- "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
- (mapcar #'car
- (org-element-lineage
- (org-element-map (org-element-parse-buffer) 'bold
- #'identity nil t))))))
- ;; Test TYPES optional argument.
- (should
- (eq 'center-block
- (org-test-with-temp-text
- "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
- (org-element-type
- (org-element-lineage (org-element-context) '(center-block))))))
- (should-not
- (org-test-with-temp-text
- "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
- (org-element-lineage (org-element-context) '(example-block))))
- ;; Test WITH-SELF optional argument.
- (should
- (equal '(bold paragraph center-block section headline headline org-data)
- (org-test-with-temp-text
- "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
- (mapcar #'car (org-element-lineage (org-element-context) nil t)))))
- ;; When TYPES and WITH-SELF are provided, the latter is also checked
- ;; against the former.
- (should
- (org-test-with-temp-text
- "* H1\n** H2\n#+BEGIN_CENTER\n*bold<point>*\n#+END_CENTER"
- (org-element-lineage (org-element-context) '(bold) t))))
- ;;; Test Cache.
- (ert-deftest test-org-element/cache ()
- "Test basic expectations and common pitfalls for cache."
- ;; Shift positions.
- (should
- (equal '(18 . 23)
- (org-test-with-temp-text "para1\n\npara2\n\npara3"
- (let ((org-element-use-cache t))
- (save-excursion (goto-char (point-max)) (org-element-at-point))
- (insert "add")
- (forward-line 4)
- (let ((element (org-element-at-point)))
- (cons (org-element-property :begin element)
- (org-element-property :end element)))))))
- ;; Partial shifting: when the contents of a greater element are
- ;; modified, only shift ending positions.
- (should
- (org-test-with-temp-text
- "#+BEGIN_CENTER\nPara1\n\nPara2\n\nPara3\n#+END_CENTER"
- (let ((org-element-use-cache t))
- (save-excursion (search-forward "3") (org-element-at-point))
- (search-forward "Para2")
- (insert " ")
- (let ((element (org-element-property :parent (org-element-at-point))))
- (equal (cons (org-element-property :begin element)
- (org-element-property :end element))
- (cons (point-min) (point-max)))))))
- ;; Re-parent shifted elements.
- (should
- (eq 'item
- (org-test-with-temp-text "- item\n\n\n para1\n para2"
- (let ((org-element-use-cache t))
- (end-of-line)
- (org-element-at-point)
- (save-excursion (goto-char (point-max)) (org-element-at-point))
- (forward-line)
- (delete-char 1)
- (goto-char (point-max))
- (org-element-type
- (org-element-property :parent (org-element-at-point)))))))
- ;; Preserve local structures when re-parenting.
- (should
- (eq 'table
- (let ((org-element-use-cache t))
- (org-test-with-temp-text
- "#+begin_center\nP0\n\n<point>\n\n P1\n | a | b |\n | c | d |\n#+end_center"
- (save-excursion (search-forward "| c |") (org-element-at-point))
- (insert "- item")
- (search-forward "| c |")
- (beginning-of-line)
- (org-element-type
- (org-element-property :parent (org-element-at-point)))))))
- (should-not
- (eq 'center-block
- (org-test-with-temp-text
- "#+begin_center\nP0\n\n<point>\n\n P1\n | a | b |\n#+end_center"
- (let ((org-element-use-cache t))
- (save-excursion (search-forward "| a |") (org-element-at-point))
- (insert "- item")
- (search-forward "| a |")
- (beginning-of-line)
- (org-element-type
- (org-element-property :parent (org-element-at-point)))))))
- ;; When re-parenting, also propagate changes to list structures.
- (should
- (= 2
- (org-test-with-temp-text "\n Para\n - item<point>"
- (let ((org-element-use-cache t))
- (org-element-at-point)
- (goto-char (point-min))
- (insert "- Top\n")
- (search-forward "- item")
- (beginning-of-line)
- (length (org-element-property :structure (org-element-at-point)))))))
- ;; Modifying the last line of an element alters the element below.
- (should
- (org-test-with-temp-text "para1\n\npara2"
- (let ((org-element-use-cache t))
- (goto-char (point-max))
- (org-element-at-point)
- (forward-line -1)
- (insert "merge")
- (let ((element (org-element-at-point)))
- (equal (cons (org-element-property :begin element)
- (org-element-property :end element))
- (cons (point-min) (point-max)))))))
- ;; Modifying the first line of an element alters the element above.
- (should
- (org-test-with-temp-text ": fixed-width\n:not-fixed-width"
- (let ((org-element-use-cache t))
- (goto-char (point-max))
- (org-element-at-point)
- (search-backward ":")
- (forward-char)
- (insert " ")
- (let ((element (org-element-at-point)))
- (equal (cons (org-element-property :begin element)
- (org-element-property :end element))
- (cons (point-min) (point-max)))))))
- (org-test-with-temp-text ":DRAWER:\ntest\n:END:\n <point>#\nParagraph"
- (let ((org-element-use-cache t))
- (org-element-cache-map #'ignore :granularity 'element)
- (should (eq 'comment (org-element-type (org-element-at-point))))
- (should (eq 0 (org-element-property :post-blank (org-element-at-point (point-min)))))
- (insert " ") (delete-char -1)
- (org-element-cache-map #'ignore :granularity 'element)
- (delete-char 1)
- (should (eq 1 (org-element-property :post-blank (org-element-at-point (point-min)))))))
- ;; Sensitive change: adding a line alters document structure both
- ;; above and below.
- (should
- (eq 'example-block
- (org-test-with-temp-text "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n"
- (let ((org-element-use-cache t))
- (goto-char (point-max))
- (org-element-at-point)
- (insert "#+END_EXAMPLE")
- (search-backward "Para1")
- (org-element-type (org-element-at-point))))))
- (should
- (eq 'example-block
- (org-test-with-temp-text "Para1\n\nPara2\n#+END_EXAMPLE"
- (let ((org-element-use-cache t))
- (save-excursion (goto-char (point-max)) (org-element-at-point))
- (insert "#+BEGIN_EXAMPLE\n")
- (search-forward "Para2")
- (org-element-type (org-element-at-point))))))
- ;; Sensitive change: removing a line alters document structure both
- ;; above and below.
- (should
- (eq 'example-block
- (org-test-with-temp-text
- "# +BEGIN_EXAMPLE\nPara1\n\nPara2\n#+END_EXAMPLE"
- (let ((org-element-use-cache t))
- (save-excursion (goto-char (point-max)) (org-element-at-point))
- (forward-char)
- (delete-char 1)
- (search-forward "Para2")
- (org-element-type (org-element-at-point))))))
- (should
- (eq 'example-block
- (org-test-with-temp-text
- "#+BEGIN_EXAMPLE\nPara1\n\nPara2\n# +END_EXAMPLE"
- (let ((org-element-use-cache t))
- (save-excursion (goto-char (point-max)) (org-element-at-point))
- (search-forward "# ")
- (delete-char -1)
- (search-backward "Para1")
- (org-element-type (org-element-at-point))))))
- ;; Make sure that we do not generate intersecting elements.
- (should (eq 'paragraph
- (org-test-with-temp-text ":DRAWER:\nP1\n<point>\n:END:\n#+END_EXAMPLE"
- (let ((org-element-use-cache t))
- (org-element-at-point (point-max))
- (org-element-at-point)
- (insert "#+BEGIN_EXAMPLE")
- (org-element-type (org-element-at-point))))))
- ;; But yet correctly slurp obsolete elements inside a new element.
- (should (eq 'example-block
- (org-test-with-temp-text ":DRAWER:\nP1\n<point>\nP2\n#+END_EXAMPLE\n:END:"
- (let ((org-element-use-cache t))
- (org-element-at-point (point-max))
- (save-excursion
- (re-search-forward "P2")
- (should (eq 'paragraph (org-element-type (org-element-at-point))))
- (re-search-forward "END_")
- (should (eq 'paragraph (org-element-type (org-element-at-point)))))
- (insert "#+BEGIN_EXAMPLE")
- (re-search-forward "P2")
- (should (eq 'example-block (org-element-type (org-element-at-point))))
- (re-search-forward "END_")
- (org-element-type (org-element-at-point))))))
- ;; Test edits near :end of element
- (should-not (eq 'headline
- (org-test-with-temp-text "* H1\nP1\n<point>*H2\n"
- (let ((org-element-use-cache t))
- (org-element-cache-map #'ignore :granularity 'element)
- (insert "Blah")
- (org-element-type (org-element-at-point))))))
- (should-not (eq 'headline
- (org-test-with-temp-text "* H1\nP1\n<point>*H2\n"
- (let ((org-element-use-cache t))
- (org-element-cache-map #'ignore :granularity 'element)
- (backward-delete-char 1)
- (org-element-type (org-element-at-point))))))
- (org-test-with-temp-text "Paragraph.\n #<point> comment"
- (let ((org-element-use-cache t))
- (org-element-cache-map #'ignore :granularity 'element)
- (should (eq 'comment (org-element-type (org-element-at-point))))
- (insert "not comment anymore")
- (org-element-cache-map #'ignore :granularity 'element)
- (should-not (eq 'comment (org-element-type (org-element-at-point))))
- (should (eq (org-element-at-point) (org-element-at-point 1)))))
- (should (eq 'headline
- (org-test-with-temp-text "* H1\nP1\n<point>* H2\n"
- (let ((org-element-use-cache t))
- (org-element-cache-map #'ignore :granularity 'element)
- (insert "Blah\n")
- (org-element-type (org-element-at-point))))))
- ;; Corner case: watch out drawers named "PROPERTIES" as they are
- ;; fragile, unlike to other drawers.
- (should
- (eq 'node-property
- (org-test-with-temp-text "* H\n:PROPERTIES:\n:A: 1\n:A<point>\n:END:"
- (let ((org-element-use-cache t))
- (org-element-at-point)
- (insert "+:")
- (org-element-type (org-element-at-point))))))
- ;; Properly handle elements not altered by modifications but whose
- ;; parents were removed from cache.
- (should
- (org-test-with-temp-text
- "Paragraph\n\n\n\n#+begin_center\n<point>contents\n#+end_center"
- (let ((org-element-use-cache t)
- (parent-end (point-max)))
- (org-element-at-point)
- (save-excursion (search-backward "Paragraph")
- (forward-line 2)
- (insert "\n "))
- (eq (org-element-property
- :end (org-element-property :parent (org-element-at-point)))
- (+ parent-end 3))))))
- (ert-deftest test-org-element/cache-affiliated ()
- "Test updating affiliated keywords."
- ;; Inserting a line right after other keywords.
- (let ((org-element-use-cache t))
- (org-test-with-temp-text "
- #+caption: test
- #+name: test
- <point>
- line"
- (org-element-cache-map #'ignore :granularity 'element)
- (should (eq 'keyword (org-element-type (org-element-at-point))))
- (insert "#")
- (should (eq 2 (org-element-property :begin (org-element-at-point)))))))
- (ert-deftest test-org-element/cache-table ()
- "Test handling edits in tables."
- ;; Unindented second row of the table should not be re-parented by
- ;; inserted item.
- (should
- (eq 'table
- (let ((org-element-use-cache t))
- (org-test-with-temp-text
- "#+begin_center
- P0
- <point>
- P1
- | a | b |
- | c | d |
- #+end_center"
- (save-excursion (search-forward "| c |") (org-element-at-point))
- (insert "- item")
- (search-forward "| c |")
- (beginning-of-line)
- (org-element-type (org-element-at-point))))))
- (should
- (eq 'table
- (let ((org-element-use-cache t))
- (org-test-with-temp-text
- "
- - item 1
- <point>
- | a | b |
- | c | d |
- #+end_center"
- (save-excursion (search-forward "| c |") (org-element-at-point))
- (delete-char 1)
- (search-forward "| c |")
- (beginning-of-line)
- (org-element-type (org-element-at-point))))))
- (should
- (eq 'table-row
- (let ((org-element-use-cache t))
- (org-test-with-temp-text
- "
- - item 1
- <point>
- | a | b |
- | c | d |
- #+end_center"
- (save-excursion (search-forward "| c |") (org-element-at-point))
- (insert "\n")
- (search-forward "| c |")
- (beginning-of-line)
- (org-element-type (org-element-at-point)))))))
- (ert-deftest test-org-element/cache-headline ()
- "Test basic expectations and common pitfalls for cached headings."
- ;; Appending to final headline in a subtree.
- (org-test-with-temp-text
- "
- * Heading
- Aliquam erat volutpat.
- *** Subheading
- ** Another
- ** Final
- :PROPERTIES:
- :ID: some
- <point>:END:
- * Heading 2
- ** End
- "
- (let ((org-element-use-cache t))
- (org-element-at-point)
- (save-excursion
- (goto-char (point-max))
- (org-element-at-point))
- (insert ":CATEOGORY: cat\n")
- (search-backward "* Heading")
- (should
- (eq (org-element-property :end (org-element-at-point))
- (save-excursion
- (search-forward "* Heading 2")
- (line-beginning-position))))
- (search-forward "* Heading 2")
- (beginning-of-line)
- (insert "\n\n")
- (search-backward "* Heading")
- (should
- (eq (org-element-property :end (org-element-at-point))
- (save-excursion
- (search-forward "* Heading 2")
- (line-beginning-position))))))
- ;; Appending at eob.
- (org-test-with-temp-text
- "
- * Heading
- *** Sub-heading
- ** Another
- *** 1
- ***** 2
- ** 3
- Aenean in sem ac leo mollis blandit.
- <point>"
- (let ((org-element-use-cache t))
- (org-element-at-point (point-max))
- (insert "\n\nTest\n")
- (search-backward "* Heading")
- (should
- (eq (point-max)
- (org-element-property :end (org-element-at-point))))))
- ;; Breaking headline at eob.
- (org-test-with-temp-text
- "
- * Heading
- *** Sub-heading
- <point>"
- (let ((org-element-use-cache t))
- (org-element-at-point (point-max))
- (insert "* heading 2")
- (beginning-of-line)
- (should
- (eq (point-max)
- (org-element-property :end (org-element-at-point))))
- (delete-char 1)
- (search-backward "* Heading")
- (should
- (eq (point-max)
- (org-element-property :end (org-element-at-point))))))
- ;; Inserting low-level headline in-between.
- (org-test-with-temp-text
- "
- * Heading
- *** Sub-heading
- <point>
- *** Sub-heading 2
- *** Sub-heading 3
- "
- (let ((org-element-use-cache t))
- (org-element-at-point (point-max))
- (insert "** heading 2")
- (search-forward "*** Sub-heading 2")
- (should
- (equal (org-element-property :parent (org-element-at-point))
- (progn
- (search-backward "** heading 2")
- (org-element-at-point))))))
- ;; Test when `org-element--cache-for-removal' modifies common parent
- ;; (`org-data' in this case) around changed region.
- (org-test-with-temp-text
- "blah
- :DRAWER:
- <point>test
- :END:
- paragraph
- * headline"
- (let ((org-element-use-cache t))
- (org-element-at-point (point-max))
- (delete-region (point) (point-max))
- (should (eq 'paragraph (org-element-type (org-element-at-point)))))))
- (provide 'test-org-element)
- ;;; test-org-element.el ends here
|