doctest.h 260 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943
  1. // ====================================================================== lgtm [cpp/missing-header-guard]
  2. // == DO NOT MODIFY THIS FILE BY HAND - IT IS AUTO GENERATED BY CMAKE! ==
  3. // ======================================================================
  4. //
  5. // doctest.h - the lightest feature-rich C++ single-header testing framework for unit tests and TDD
  6. //
  7. // Copyright (c) 2016-2019 Viktor Kirilov
  8. //
  9. // Distributed under the MIT Software License
  10. // See accompanying file LICENSE.txt or copy at
  11. // https://opensource.org/licenses/MIT
  12. //
  13. // The documentation can be found at the library's page:
  14. // https://github.com/onqtam/doctest/blob/master/doc/markdown/readme.md
  15. //
  16. // =================================================================================================
  17. // =================================================================================================
  18. // =================================================================================================
  19. //
  20. // The library is heavily influenced by Catch - https://github.com/catchorg/Catch2
  21. // which uses the Boost Software License - Version 1.0
  22. // see here - https://github.com/catchorg/Catch2/blob/master/LICENSE.txt
  23. //
  24. // The concept of subcases (sections in Catch) and expression decomposition are from there.
  25. // Some parts of the code are taken directly:
  26. // - stringification - the detection of "ostream& operator<<(ostream&, const T&)" and StringMaker<>
  27. // - the Approx() helper class for floating point comparison
  28. // - colors in the console
  29. // - breaking into a debugger
  30. // - signal / SEH handling
  31. // - timer
  32. // - XmlWriter class - thanks to Phil Nash for allowing the direct reuse (AKA copy/paste)
  33. //
  34. // The expression decomposing templates are taken from lest - https://github.com/martinmoene/lest
  35. // which uses the Boost Software License - Version 1.0
  36. // see here - https://github.com/martinmoene/lest/blob/master/LICENSE.txt
  37. //
  38. // =================================================================================================
  39. // =================================================================================================
  40. // =================================================================================================
  41. #ifndef DOCTEST_LIBRARY_INCLUDED
  42. #define DOCTEST_LIBRARY_INCLUDED
  43. // =================================================================================================
  44. // == VERSION ======================================================================================
  45. // =================================================================================================
  46. #define DOCTEST_VERSION_MAJOR 2
  47. #define DOCTEST_VERSION_MINOR 3
  48. #define DOCTEST_VERSION_PATCH 5
  49. #define DOCTEST_VERSION_STR "2.3.5"
  50. #define DOCTEST_VERSION \
  51. (DOCTEST_VERSION_MAJOR * 10000 + DOCTEST_VERSION_MINOR * 100 + DOCTEST_VERSION_PATCH)
  52. // =================================================================================================
  53. // == COMPILER VERSION =============================================================================
  54. // =================================================================================================
  55. // ideas for the version stuff are taken from here: https://github.com/cxxstuff/cxx_detect
  56. #define DOCTEST_COMPILER(MAJOR, MINOR, PATCH) ((MAJOR)*10000000 + (MINOR)*100000 + (PATCH))
  57. // GCC/Clang and GCC/MSVC are mutually exclusive, but Clang/MSVC are not because of clang-cl...
  58. #if defined(_MSC_VER) && defined(_MSC_FULL_VER)
  59. #if _MSC_VER == _MSC_FULL_VER / 10000
  60. #define DOCTEST_MSVC DOCTEST_COMPILER(_MSC_VER / 100, _MSC_VER % 100, _MSC_FULL_VER % 10000)
  61. #else // MSVC
  62. #define DOCTEST_MSVC \
  63. DOCTEST_COMPILER(_MSC_VER / 100, (_MSC_FULL_VER / 100000) % 100, _MSC_FULL_VER % 100000)
  64. #endif // MSVC
  65. #endif // MSVC
  66. #if defined(__clang__) && defined(__clang_minor__)
  67. #define DOCTEST_CLANG DOCTEST_COMPILER(__clang_major__, __clang_minor__, __clang_patchlevel__)
  68. #elif defined(__GNUC__) && defined(__GNUC_MINOR__) && defined(__GNUC_PATCHLEVEL__) && \
  69. !defined(__INTEL_COMPILER)
  70. #define DOCTEST_GCC DOCTEST_COMPILER(__GNUC__, __GNUC_MINOR__, __GNUC_PATCHLEVEL__)
  71. #endif // GCC
  72. #ifndef DOCTEST_MSVC
  73. #define DOCTEST_MSVC 0
  74. #endif // DOCTEST_MSVC
  75. #ifndef DOCTEST_CLANG
  76. #define DOCTEST_CLANG 0
  77. #endif // DOCTEST_CLANG
  78. #ifndef DOCTEST_GCC
  79. #define DOCTEST_GCC 0
  80. #endif // DOCTEST_GCC
  81. // =================================================================================================
  82. // == COMPILER WARNINGS HELPERS ====================================================================
  83. // =================================================================================================
  84. #if DOCTEST_CLANG
  85. #define DOCTEST_PRAGMA_TO_STR(x) _Pragma(#x)
  86. #define DOCTEST_CLANG_SUPPRESS_WARNING_PUSH _Pragma("clang diagnostic push")
  87. #define DOCTEST_CLANG_SUPPRESS_WARNING(w) DOCTEST_PRAGMA_TO_STR(clang diagnostic ignored w)
  88. #define DOCTEST_CLANG_SUPPRESS_WARNING_POP _Pragma("clang diagnostic pop")
  89. #define DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH(w) \
  90. DOCTEST_CLANG_SUPPRESS_WARNING_PUSH DOCTEST_CLANG_SUPPRESS_WARNING(w)
  91. #else // DOCTEST_CLANG
  92. #define DOCTEST_CLANG_SUPPRESS_WARNING_PUSH
  93. #define DOCTEST_CLANG_SUPPRESS_WARNING(w)
  94. #define DOCTEST_CLANG_SUPPRESS_WARNING_POP
  95. #define DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH(w)
  96. #endif // DOCTEST_CLANG
  97. #if DOCTEST_GCC
  98. #define DOCTEST_PRAGMA_TO_STR(x) _Pragma(#x)
  99. #define DOCTEST_GCC_SUPPRESS_WARNING_PUSH _Pragma("GCC diagnostic push")
  100. #define DOCTEST_GCC_SUPPRESS_WARNING(w) DOCTEST_PRAGMA_TO_STR(GCC diagnostic ignored w)
  101. #define DOCTEST_GCC_SUPPRESS_WARNING_POP _Pragma("GCC diagnostic pop")
  102. #define DOCTEST_GCC_SUPPRESS_WARNING_WITH_PUSH(w) \
  103. DOCTEST_GCC_SUPPRESS_WARNING_PUSH DOCTEST_GCC_SUPPRESS_WARNING(w)
  104. #else // DOCTEST_GCC
  105. #define DOCTEST_GCC_SUPPRESS_WARNING_PUSH
  106. #define DOCTEST_GCC_SUPPRESS_WARNING(w)
  107. #define DOCTEST_GCC_SUPPRESS_WARNING_POP
  108. #define DOCTEST_GCC_SUPPRESS_WARNING_WITH_PUSH(w)
  109. #endif // DOCTEST_GCC
  110. #if DOCTEST_MSVC
  111. #define DOCTEST_MSVC_SUPPRESS_WARNING_PUSH __pragma(warning(push))
  112. #define DOCTEST_MSVC_SUPPRESS_WARNING(w) __pragma(warning(disable : w))
  113. #define DOCTEST_MSVC_SUPPRESS_WARNING_POP __pragma(warning(pop))
  114. #define DOCTEST_MSVC_SUPPRESS_WARNING_WITH_PUSH(w) \
  115. DOCTEST_MSVC_SUPPRESS_WARNING_PUSH DOCTEST_MSVC_SUPPRESS_WARNING(w)
  116. #else // DOCTEST_MSVC
  117. #define DOCTEST_MSVC_SUPPRESS_WARNING_PUSH
  118. #define DOCTEST_MSVC_SUPPRESS_WARNING(w)
  119. #define DOCTEST_MSVC_SUPPRESS_WARNING_POP
  120. #define DOCTEST_MSVC_SUPPRESS_WARNING_WITH_PUSH(w)
  121. #endif // DOCTEST_MSVC
  122. // =================================================================================================
  123. // == COMPILER WARNINGS ============================================================================
  124. // =================================================================================================
  125. DOCTEST_CLANG_SUPPRESS_WARNING_PUSH
  126. DOCTEST_CLANG_SUPPRESS_WARNING("-Wunknown-pragmas")
  127. DOCTEST_CLANG_SUPPRESS_WARNING("-Wnon-virtual-dtor")
  128. DOCTEST_CLANG_SUPPRESS_WARNING("-Wweak-vtables")
  129. DOCTEST_CLANG_SUPPRESS_WARNING("-Wpadded")
  130. DOCTEST_CLANG_SUPPRESS_WARNING("-Wdeprecated")
  131. DOCTEST_CLANG_SUPPRESS_WARNING("-Wmissing-prototypes")
  132. DOCTEST_CLANG_SUPPRESS_WARNING("-Wunused-local-typedef")
  133. DOCTEST_CLANG_SUPPRESS_WARNING("-Wc++98-compat")
  134. DOCTEST_CLANG_SUPPRESS_WARNING("-Wc++98-compat-pedantic")
  135. DOCTEST_GCC_SUPPRESS_WARNING_PUSH
  136. DOCTEST_GCC_SUPPRESS_WARNING("-Wunknown-pragmas")
  137. DOCTEST_GCC_SUPPRESS_WARNING("-Wpragmas")
  138. DOCTEST_GCC_SUPPRESS_WARNING("-Weffc++")
  139. DOCTEST_GCC_SUPPRESS_WARNING("-Wstrict-overflow")
  140. DOCTEST_GCC_SUPPRESS_WARNING("-Wstrict-aliasing")
  141. DOCTEST_GCC_SUPPRESS_WARNING("-Wctor-dtor-privacy")
  142. DOCTEST_GCC_SUPPRESS_WARNING("-Wmissing-declarations")
  143. DOCTEST_GCC_SUPPRESS_WARNING("-Wnon-virtual-dtor")
  144. DOCTEST_GCC_SUPPRESS_WARNING("-Winline")
  145. DOCTEST_GCC_SUPPRESS_WARNING("-Wunused-local-typedefs")
  146. DOCTEST_GCC_SUPPRESS_WARNING("-Wuseless-cast")
  147. DOCTEST_GCC_SUPPRESS_WARNING("-Wnoexcept")
  148. DOCTEST_GCC_SUPPRESS_WARNING("-Wsign-promo")
  149. DOCTEST_MSVC_SUPPRESS_WARNING_PUSH
  150. DOCTEST_MSVC_SUPPRESS_WARNING(4616) // invalid compiler warning
  151. DOCTEST_MSVC_SUPPRESS_WARNING(4619) // invalid compiler warning
  152. DOCTEST_MSVC_SUPPRESS_WARNING(4996) // The compiler encountered a deprecated declaration
  153. DOCTEST_MSVC_SUPPRESS_WARNING(4706) // assignment within conditional expression
  154. DOCTEST_MSVC_SUPPRESS_WARNING(4512) // 'class' : assignment operator could not be generated
  155. DOCTEST_MSVC_SUPPRESS_WARNING(4127) // conditional expression is constant
  156. DOCTEST_MSVC_SUPPRESS_WARNING(4820) // padding
  157. DOCTEST_MSVC_SUPPRESS_WARNING(4625) // copy constructor was implicitly defined as deleted
  158. DOCTEST_MSVC_SUPPRESS_WARNING(4626) // assignment operator was implicitly defined as deleted
  159. DOCTEST_MSVC_SUPPRESS_WARNING(5027) // move assignment operator was implicitly defined as deleted
  160. DOCTEST_MSVC_SUPPRESS_WARNING(5026) // move constructor was implicitly defined as deleted
  161. DOCTEST_MSVC_SUPPRESS_WARNING(4623) // default constructor was implicitly defined as deleted
  162. DOCTEST_MSVC_SUPPRESS_WARNING(4640) // construction of local static object is not thread-safe
  163. // static analysis
  164. DOCTEST_MSVC_SUPPRESS_WARNING(26439) // This kind of function may not throw. Declare it 'noexcept'
  165. DOCTEST_MSVC_SUPPRESS_WARNING(26495) // Always initialize a member variable
  166. DOCTEST_MSVC_SUPPRESS_WARNING(26451) // Arithmetic overflow ...
  167. DOCTEST_MSVC_SUPPRESS_WARNING(26444) // Avoid unnamed objects with custom construction and dtr...
  168. // 4548 - expression before comma has no effect; expected expression with side - effect
  169. // 4265 - class has virtual functions, but destructor is not virtual
  170. // 4986 - exception specification does not match previous declaration
  171. // 4350 - behavior change: 'member1' called instead of 'member2'
  172. // 4668 - 'x' is not defined as a preprocessor macro, replacing with '0' for '#if/#elif'
  173. // 4365 - conversion from 'int' to 'unsigned long', signed/unsigned mismatch
  174. // 4774 - format string expected in argument 'x' is not a string literal
  175. // 4820 - padding in structs
  176. // only 4 should be disabled globally:
  177. // - 4514 # unreferenced inline function has been removed
  178. // - 4571 # SEH related
  179. // - 4710 # function not inlined
  180. // - 4711 # function 'x' selected for automatic inline expansion
  181. #define DOCTEST_MAKE_STD_HEADERS_CLEAN_FROM_WARNINGS_ON_WALL_BEGIN \
  182. DOCTEST_MSVC_SUPPRESS_WARNING_PUSH \
  183. DOCTEST_MSVC_SUPPRESS_WARNING(4548) \
  184. DOCTEST_MSVC_SUPPRESS_WARNING(4265) \
  185. DOCTEST_MSVC_SUPPRESS_WARNING(4986) \
  186. DOCTEST_MSVC_SUPPRESS_WARNING(4350) \
  187. DOCTEST_MSVC_SUPPRESS_WARNING(4668) \
  188. DOCTEST_MSVC_SUPPRESS_WARNING(4365) \
  189. DOCTEST_MSVC_SUPPRESS_WARNING(4774) \
  190. DOCTEST_MSVC_SUPPRESS_WARNING(4820) \
  191. DOCTEST_MSVC_SUPPRESS_WARNING(4625) \
  192. DOCTEST_MSVC_SUPPRESS_WARNING(4626) \
  193. DOCTEST_MSVC_SUPPRESS_WARNING(5027) \
  194. DOCTEST_MSVC_SUPPRESS_WARNING(5026) \
  195. DOCTEST_MSVC_SUPPRESS_WARNING(4623) \
  196. DOCTEST_MSVC_SUPPRESS_WARNING(5039) \
  197. DOCTEST_MSVC_SUPPRESS_WARNING(5045) \
  198. DOCTEST_MSVC_SUPPRESS_WARNING(5105)
  199. #define DOCTEST_MAKE_STD_HEADERS_CLEAN_FROM_WARNINGS_ON_WALL_END DOCTEST_MSVC_SUPPRESS_WARNING_POP
  200. // =================================================================================================
  201. // == FEATURE DETECTION ============================================================================
  202. // =================================================================================================
  203. // general compiler feature support table: https://en.cppreference.com/w/cpp/compiler_support
  204. // MSVC C++11 feature support table: https://msdn.microsoft.com/en-us/library/hh567368.aspx
  205. // GCC C++11 feature support table: https://gcc.gnu.org/projects/cxx-status.html
  206. // MSVC version table:
  207. // https://en.wikipedia.org/wiki/Microsoft_Visual_C%2B%2B#Internal_version_numbering
  208. // MSVC++ 14.2 (16) _MSC_VER == 1920 (Visual Studio 2019)
  209. // MSVC++ 14.1 (15) _MSC_VER == 1910 (Visual Studio 2017)
  210. // MSVC++ 14.0 _MSC_VER == 1900 (Visual Studio 2015)
  211. // MSVC++ 12.0 _MSC_VER == 1800 (Visual Studio 2013)
  212. // MSVC++ 11.0 _MSC_VER == 1700 (Visual Studio 2012)
  213. // MSVC++ 10.0 _MSC_VER == 1600 (Visual Studio 2010)
  214. // MSVC++ 9.0 _MSC_VER == 1500 (Visual Studio 2008)
  215. // MSVC++ 8.0 _MSC_VER == 1400 (Visual Studio 2005)
  216. #if DOCTEST_MSVC && !defined(DOCTEST_CONFIG_WINDOWS_SEH)
  217. #define DOCTEST_CONFIG_WINDOWS_SEH
  218. #endif // MSVC
  219. #if defined(DOCTEST_CONFIG_NO_WINDOWS_SEH) && defined(DOCTEST_CONFIG_WINDOWS_SEH)
  220. #undef DOCTEST_CONFIG_WINDOWS_SEH
  221. #endif // DOCTEST_CONFIG_NO_WINDOWS_SEH
  222. #if !defined(_WIN32) && !defined(__QNX__) && !defined(DOCTEST_CONFIG_POSIX_SIGNALS) && \
  223. !defined(__EMSCRIPTEN__)
  224. #define DOCTEST_CONFIG_POSIX_SIGNALS
  225. #endif // _WIN32
  226. #if defined(DOCTEST_CONFIG_NO_POSIX_SIGNALS) && defined(DOCTEST_CONFIG_POSIX_SIGNALS)
  227. #undef DOCTEST_CONFIG_POSIX_SIGNALS
  228. #endif // DOCTEST_CONFIG_NO_POSIX_SIGNALS
  229. #ifndef DOCTEST_CONFIG_NO_EXCEPTIONS
  230. #if !defined(__cpp_exceptions) && !defined(__EXCEPTIONS) && !defined(_CPPUNWIND)
  231. #define DOCTEST_CONFIG_NO_EXCEPTIONS
  232. #endif // no exceptions
  233. #endif // DOCTEST_CONFIG_NO_EXCEPTIONS
  234. #ifdef DOCTEST_CONFIG_NO_EXCEPTIONS_BUT_WITH_ALL_ASSERTS
  235. #ifndef DOCTEST_CONFIG_NO_EXCEPTIONS
  236. #define DOCTEST_CONFIG_NO_EXCEPTIONS
  237. #endif // DOCTEST_CONFIG_NO_EXCEPTIONS
  238. #endif // DOCTEST_CONFIG_NO_EXCEPTIONS_BUT_WITH_ALL_ASSERTS
  239. #if defined(DOCTEST_CONFIG_NO_EXCEPTIONS) && !defined(DOCTEST_CONFIG_NO_TRY_CATCH_IN_ASSERTS)
  240. #define DOCTEST_CONFIG_NO_TRY_CATCH_IN_ASSERTS
  241. #endif // DOCTEST_CONFIG_NO_EXCEPTIONS && !DOCTEST_CONFIG_NO_TRY_CATCH_IN_ASSERTS
  242. #if defined(DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN) && !defined(DOCTEST_CONFIG_IMPLEMENT)
  243. #define DOCTEST_CONFIG_IMPLEMENT
  244. #endif // DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN
  245. #if defined(_WIN32) || defined(__CYGWIN__)
  246. #if DOCTEST_MSVC
  247. #define DOCTEST_SYMBOL_EXPORT __declspec(dllexport)
  248. #define DOCTEST_SYMBOL_IMPORT __declspec(dllimport)
  249. #else // MSVC
  250. #define DOCTEST_SYMBOL_EXPORT __attribute__((dllexport))
  251. #define DOCTEST_SYMBOL_IMPORT __attribute__((dllimport))
  252. #endif // MSVC
  253. #else // _WIN32
  254. #define DOCTEST_SYMBOL_EXPORT __attribute__((visibility("default")))
  255. #define DOCTEST_SYMBOL_IMPORT
  256. #endif // _WIN32
  257. #ifdef DOCTEST_CONFIG_IMPLEMENTATION_IN_DLL
  258. #ifdef DOCTEST_CONFIG_IMPLEMENT
  259. #define DOCTEST_INTERFACE DOCTEST_SYMBOL_EXPORT
  260. #else // DOCTEST_CONFIG_IMPLEMENT
  261. #define DOCTEST_INTERFACE DOCTEST_SYMBOL_IMPORT
  262. #endif // DOCTEST_CONFIG_IMPLEMENT
  263. #else // DOCTEST_CONFIG_IMPLEMENTATION_IN_DLL
  264. #define DOCTEST_INTERFACE
  265. #endif // DOCTEST_CONFIG_IMPLEMENTATION_IN_DLL
  266. #define DOCTEST_EMPTY
  267. #if DOCTEST_MSVC
  268. #define DOCTEST_NOINLINE __declspec(noinline)
  269. #define DOCTEST_UNUSED
  270. #define DOCTEST_ALIGNMENT(x)
  271. #else // MSVC
  272. #define DOCTEST_NOINLINE __attribute__((noinline))
  273. #define DOCTEST_UNUSED __attribute__((unused))
  274. #define DOCTEST_ALIGNMENT(x) __attribute__((aligned(x)))
  275. #endif // MSVC
  276. // =================================================================================================
  277. // == FEATURE DETECTION END ========================================================================
  278. // =================================================================================================
  279. // internal macros for string concatenation and anonymous variable name generation
  280. #define DOCTEST_CAT_IMPL(s1, s2) s1##s2
  281. #define DOCTEST_CAT(s1, s2) DOCTEST_CAT_IMPL(s1, s2)
  282. #ifdef __COUNTER__ // not standard and may be missing for some compilers
  283. #define DOCTEST_ANONYMOUS(x) DOCTEST_CAT(x, __COUNTER__)
  284. #else // __COUNTER__
  285. #define DOCTEST_ANONYMOUS(x) DOCTEST_CAT(x, __LINE__)
  286. #endif // __COUNTER__
  287. #define DOCTEST_TOSTR(x) #x
  288. #ifndef DOCTEST_CONFIG_ASSERTION_PARAMETERS_BY_VALUE
  289. #define DOCTEST_REF_WRAP(x) x&
  290. #else // DOCTEST_CONFIG_ASSERTION_PARAMETERS_BY_VALUE
  291. #define DOCTEST_REF_WRAP(x) x
  292. #endif // DOCTEST_CONFIG_ASSERTION_PARAMETERS_BY_VALUE
  293. // not using __APPLE__ because... this is how Catch does it
  294. #ifdef __MAC_OS_X_VERSION_MIN_REQUIRED
  295. #define DOCTEST_PLATFORM_MAC
  296. #elif defined(__IPHONE_OS_VERSION_MIN_REQUIRED)
  297. #define DOCTEST_PLATFORM_IPHONE
  298. #elif defined(_WIN32)
  299. #define DOCTEST_PLATFORM_WINDOWS
  300. #else // DOCTEST_PLATFORM
  301. #define DOCTEST_PLATFORM_LINUX
  302. #endif // DOCTEST_PLATFORM
  303. #define DOCTEST_GLOBAL_NO_WARNINGS(var) \
  304. DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH("-Wglobal-constructors") \
  305. DOCTEST_CLANG_SUPPRESS_WARNING("-Wunused-variable") \
  306. static int var DOCTEST_UNUSED // NOLINT(fuchsia-statically-constructed-objects,cert-err58-cpp)
  307. #define DOCTEST_GLOBAL_NO_WARNINGS_END() DOCTEST_CLANG_SUPPRESS_WARNING_POP
  308. #ifndef DOCTEST_BREAK_INTO_DEBUGGER
  309. // should probably take a look at https://github.com/scottt/debugbreak
  310. #ifdef DOCTEST_PLATFORM_MAC
  311. #define DOCTEST_BREAK_INTO_DEBUGGER() __asm__("int $3\n" : :)
  312. #elif DOCTEST_MSVC
  313. #define DOCTEST_BREAK_INTO_DEBUGGER() __debugbreak()
  314. #elif defined(__MINGW32__)
  315. DOCTEST_GCC_SUPPRESS_WARNING_WITH_PUSH("-Wredundant-decls")
  316. extern "C" __declspec(dllimport) void __stdcall DebugBreak();
  317. DOCTEST_GCC_SUPPRESS_WARNING_POP
  318. #define DOCTEST_BREAK_INTO_DEBUGGER() ::DebugBreak()
  319. #else // linux
  320. #define DOCTEST_BREAK_INTO_DEBUGGER() ((void)0)
  321. #endif // linux
  322. #endif // DOCTEST_BREAK_INTO_DEBUGGER
  323. // this is kept here for backwards compatibility since the config option was changed
  324. #ifdef DOCTEST_CONFIG_USE_IOSFWD
  325. #define DOCTEST_CONFIG_USE_STD_HEADERS
  326. #endif // DOCTEST_CONFIG_USE_IOSFWD
  327. #ifdef DOCTEST_CONFIG_USE_STD_HEADERS
  328. #include <iosfwd>
  329. #include <cstddef>
  330. #if DOCTEST_MSVC >= DOCTEST_COMPILER(19, 20, 0)
  331. // see this issue on why this is needed: https://github.com/onqtam/doctest/issues/183
  332. #include <ostream>
  333. #endif // VS 2019
  334. #else // DOCTEST_CONFIG_USE_STD_HEADERS
  335. #if DOCTEST_CLANG
  336. // to detect if libc++ is being used with clang (the _LIBCPP_VERSION identifier)
  337. #include <ciso646>
  338. #endif // clang
  339. #ifdef _LIBCPP_VERSION
  340. #define DOCTEST_STD_NAMESPACE_BEGIN _LIBCPP_BEGIN_NAMESPACE_STD
  341. #define DOCTEST_STD_NAMESPACE_END _LIBCPP_END_NAMESPACE_STD
  342. #else // _LIBCPP_VERSION
  343. #define DOCTEST_STD_NAMESPACE_BEGIN namespace std {
  344. #define DOCTEST_STD_NAMESPACE_END }
  345. #endif // _LIBCPP_VERSION
  346. // Forward declaring 'X' in namespace std is not permitted by the C++ Standard.
  347. DOCTEST_MSVC_SUPPRESS_WARNING_WITH_PUSH(4643)
  348. DOCTEST_STD_NAMESPACE_BEGIN // NOLINT (cert-dcl58-cpp)
  349. typedef decltype(nullptr) nullptr_t;
  350. template <class charT>
  351. struct char_traits;
  352. template <>
  353. struct char_traits<char>;
  354. template <class charT, class traits>
  355. class basic_ostream;
  356. typedef basic_ostream<char, char_traits<char>> ostream;
  357. template <class... Types>
  358. class tuple;
  359. #if DOCTEST_MSVC >= DOCTEST_COMPILER(19, 20, 0)
  360. // see this issue on why this is needed: https://github.com/onqtam/doctest/issues/183
  361. template <class _Ty>
  362. class allocator;
  363. template <class _Elem, class _Traits, class _Alloc>
  364. class basic_string;
  365. using string = basic_string<char, char_traits<char>, allocator<char>>;
  366. #endif // VS 2019
  367. DOCTEST_STD_NAMESPACE_END
  368. DOCTEST_MSVC_SUPPRESS_WARNING_POP
  369. #endif // DOCTEST_CONFIG_USE_STD_HEADERS
  370. #ifdef DOCTEST_CONFIG_INCLUDE_TYPE_TRAITS
  371. #include <type_traits>
  372. #endif // DOCTEST_CONFIG_INCLUDE_TYPE_TRAITS
  373. namespace doctest {
  374. DOCTEST_INTERFACE extern bool is_running_in_test;
  375. // A 24 byte string class (can be as small as 17 for x64 and 13 for x86) that can hold strings with length
  376. // of up to 23 chars on the stack before going on the heap - the last byte of the buffer is used for:
  377. // - "is small" bit - the highest bit - if "0" then it is small - otherwise its "1" (128)
  378. // - if small - capacity left before going on the heap - using the lowest 5 bits
  379. // - if small - 2 bits are left unused - the second and third highest ones
  380. // - if small - acts as a null terminator if strlen() is 23 (24 including the null terminator)
  381. // and the "is small" bit remains "0" ("as well as the capacity left") so its OK
  382. // Idea taken from this lecture about the string implementation of facebook/folly - fbstring
  383. // https://www.youtube.com/watch?v=kPR8h4-qZdk
  384. // TODO:
  385. // - optimizations - like not deleting memory unnecessarily in operator= and etc.
  386. // - resize/reserve/clear
  387. // - substr
  388. // - replace
  389. // - back/front
  390. // - iterator stuff
  391. // - find & friends
  392. // - push_back/pop_back
  393. // - assign/insert/erase
  394. // - relational operators as free functions - taking const char* as one of the params
  395. class DOCTEST_INTERFACE String
  396. {
  397. static const unsigned len = 24; //!OCLINT avoid private static members
  398. static const unsigned last = len - 1; //!OCLINT avoid private static members
  399. struct view // len should be more than sizeof(view) - because of the final byte for flags
  400. {
  401. char* ptr;
  402. unsigned size;
  403. unsigned capacity;
  404. };
  405. union
  406. {
  407. char buf[len];
  408. view data;
  409. };
  410. bool isOnStack() const { return (buf[last] & 128) == 0; }
  411. void setOnHeap();
  412. void setLast(unsigned in = last);
  413. void copy(const String& other);
  414. public:
  415. String();
  416. ~String();
  417. // cppcheck-suppress noExplicitConstructor
  418. String(const char* in);
  419. String(const char* in, unsigned in_size);
  420. String(const String& other);
  421. String& operator=(const String& other);
  422. String& operator+=(const String& other);
  423. String operator+(const String& other) const;
  424. String(String&& other);
  425. String& operator=(String&& other);
  426. char operator[](unsigned i) const;
  427. char& operator[](unsigned i);
  428. // the only functions I'm willing to leave in the interface - available for inlining
  429. const char* c_str() const { return const_cast<String*>(this)->c_str(); } // NOLINT
  430. char* c_str() {
  431. if(isOnStack())
  432. return reinterpret_cast<char*>(buf);
  433. return data.ptr;
  434. }
  435. unsigned size() const;
  436. unsigned capacity() const;
  437. int compare(const char* other, bool no_case = false) const;
  438. int compare(const String& other, bool no_case = false) const;
  439. };
  440. DOCTEST_INTERFACE bool operator==(const String& lhs, const String& rhs);
  441. DOCTEST_INTERFACE bool operator!=(const String& lhs, const String& rhs);
  442. DOCTEST_INTERFACE bool operator<(const String& lhs, const String& rhs);
  443. DOCTEST_INTERFACE bool operator>(const String& lhs, const String& rhs);
  444. DOCTEST_INTERFACE bool operator<=(const String& lhs, const String& rhs);
  445. DOCTEST_INTERFACE bool operator>=(const String& lhs, const String& rhs);
  446. DOCTEST_INTERFACE std::ostream& operator<<(std::ostream& s, const String& in);
  447. namespace Color {
  448. enum Enum
  449. {
  450. None = 0,
  451. White,
  452. Red,
  453. Green,
  454. Blue,
  455. Cyan,
  456. Yellow,
  457. Grey,
  458. Bright = 0x10,
  459. BrightRed = Bright | Red,
  460. BrightGreen = Bright | Green,
  461. LightGrey = Bright | Grey,
  462. BrightWhite = Bright | White
  463. };
  464. DOCTEST_INTERFACE std::ostream& operator<<(std::ostream& s, Color::Enum code);
  465. } // namespace Color
  466. namespace assertType {
  467. enum Enum
  468. {
  469. // macro traits
  470. is_warn = 1,
  471. is_check = 2 * is_warn,
  472. is_require = 2 * is_check,
  473. is_normal = 2 * is_require,
  474. is_throws = 2 * is_normal,
  475. is_throws_as = 2 * is_throws,
  476. is_throws_with = 2 * is_throws_as,
  477. is_nothrow = 2 * is_throws_with,
  478. is_false = 2 * is_nothrow,
  479. is_unary = 2 * is_false, // not checked anywhere - used just to distinguish the types
  480. is_eq = 2 * is_unary,
  481. is_ne = 2 * is_eq,
  482. is_lt = 2 * is_ne,
  483. is_gt = 2 * is_lt,
  484. is_ge = 2 * is_gt,
  485. is_le = 2 * is_ge,
  486. // macro types
  487. DT_WARN = is_normal | is_warn,
  488. DT_CHECK = is_normal | is_check,
  489. DT_REQUIRE = is_normal | is_require,
  490. DT_WARN_FALSE = is_normal | is_false | is_warn,
  491. DT_CHECK_FALSE = is_normal | is_false | is_check,
  492. DT_REQUIRE_FALSE = is_normal | is_false | is_require,
  493. DT_WARN_THROWS = is_throws | is_warn,
  494. DT_CHECK_THROWS = is_throws | is_check,
  495. DT_REQUIRE_THROWS = is_throws | is_require,
  496. DT_WARN_THROWS_AS = is_throws_as | is_warn,
  497. DT_CHECK_THROWS_AS = is_throws_as | is_check,
  498. DT_REQUIRE_THROWS_AS = is_throws_as | is_require,
  499. DT_WARN_THROWS_WITH = is_throws_with | is_warn,
  500. DT_CHECK_THROWS_WITH = is_throws_with | is_check,
  501. DT_REQUIRE_THROWS_WITH = is_throws_with | is_require,
  502. DT_WARN_THROWS_WITH_AS = is_throws_with | is_throws_as | is_warn,
  503. DT_CHECK_THROWS_WITH_AS = is_throws_with | is_throws_as | is_check,
  504. DT_REQUIRE_THROWS_WITH_AS = is_throws_with | is_throws_as | is_require,
  505. DT_WARN_NOTHROW = is_nothrow | is_warn,
  506. DT_CHECK_NOTHROW = is_nothrow | is_check,
  507. DT_REQUIRE_NOTHROW = is_nothrow | is_require,
  508. DT_WARN_EQ = is_normal | is_eq | is_warn,
  509. DT_CHECK_EQ = is_normal | is_eq | is_check,
  510. DT_REQUIRE_EQ = is_normal | is_eq | is_require,
  511. DT_WARN_NE = is_normal | is_ne | is_warn,
  512. DT_CHECK_NE = is_normal | is_ne | is_check,
  513. DT_REQUIRE_NE = is_normal | is_ne | is_require,
  514. DT_WARN_GT = is_normal | is_gt | is_warn,
  515. DT_CHECK_GT = is_normal | is_gt | is_check,
  516. DT_REQUIRE_GT = is_normal | is_gt | is_require,
  517. DT_WARN_LT = is_normal | is_lt | is_warn,
  518. DT_CHECK_LT = is_normal | is_lt | is_check,
  519. DT_REQUIRE_LT = is_normal | is_lt | is_require,
  520. DT_WARN_GE = is_normal | is_ge | is_warn,
  521. DT_CHECK_GE = is_normal | is_ge | is_check,
  522. DT_REQUIRE_GE = is_normal | is_ge | is_require,
  523. DT_WARN_LE = is_normal | is_le | is_warn,
  524. DT_CHECK_LE = is_normal | is_le | is_check,
  525. DT_REQUIRE_LE = is_normal | is_le | is_require,
  526. DT_WARN_UNARY = is_normal | is_unary | is_warn,
  527. DT_CHECK_UNARY = is_normal | is_unary | is_check,
  528. DT_REQUIRE_UNARY = is_normal | is_unary | is_require,
  529. DT_WARN_UNARY_FALSE = is_normal | is_false | is_unary | is_warn,
  530. DT_CHECK_UNARY_FALSE = is_normal | is_false | is_unary | is_check,
  531. DT_REQUIRE_UNARY_FALSE = is_normal | is_false | is_unary | is_require,
  532. };
  533. } // namespace assertType
  534. DOCTEST_INTERFACE const char* assertString(assertType::Enum at);
  535. DOCTEST_INTERFACE const char* failureString(assertType::Enum at);
  536. DOCTEST_INTERFACE const char* skipPathFromFilename(const char* file);
  537. struct DOCTEST_INTERFACE TestCaseData
  538. {
  539. const char* m_file; // the file in which the test was registered
  540. unsigned m_line; // the line where the test was registered
  541. const char* m_name; // name of the test case
  542. const char* m_test_suite; // the test suite in which the test was added
  543. const char* m_description;
  544. bool m_skip;
  545. bool m_may_fail;
  546. bool m_should_fail;
  547. int m_expected_failures;
  548. double m_timeout;
  549. };
  550. struct DOCTEST_INTERFACE AssertData
  551. {
  552. // common - for all asserts
  553. const TestCaseData* m_test_case;
  554. assertType::Enum m_at;
  555. const char* m_file;
  556. int m_line;
  557. const char* m_expr;
  558. bool m_failed;
  559. // exception-related - for all asserts
  560. bool m_threw;
  561. String m_exception;
  562. // for normal asserts
  563. String m_decomp;
  564. // for specific exception-related asserts
  565. bool m_threw_as;
  566. const char* m_exception_type;
  567. const char* m_exception_string;
  568. };
  569. struct DOCTEST_INTERFACE MessageData
  570. {
  571. String m_string;
  572. const char* m_file;
  573. int m_line;
  574. assertType::Enum m_severity;
  575. };
  576. struct DOCTEST_INTERFACE SubcaseSignature
  577. {
  578. const char* m_name;
  579. const char* m_file;
  580. int m_line;
  581. bool operator<(const SubcaseSignature& other) const;
  582. };
  583. struct DOCTEST_INTERFACE IContextScope
  584. {
  585. IContextScope();
  586. virtual ~IContextScope();
  587. virtual void stringify(std::ostream*) const = 0;
  588. };
  589. struct ContextOptions //!OCLINT too many fields
  590. {
  591. std::ostream* cout; // stdout stream - std::cout by default
  592. std::ostream* cerr; // stderr stream - std::cerr by default
  593. String binary_name; // the test binary name
  594. // == parameters from the command line
  595. String out; // output filename
  596. String order_by; // how tests should be ordered
  597. unsigned rand_seed; // the seed for rand ordering
  598. unsigned first; // the first (matching) test to be executed
  599. unsigned last; // the last (matching) test to be executed
  600. int abort_after; // stop tests after this many failed assertions
  601. int subcase_filter_levels; // apply the subcase filters for the first N levels
  602. bool success; // include successful assertions in output
  603. bool case_sensitive; // if filtering should be case sensitive
  604. bool exit; // if the program should be exited after the tests are ran/whatever
  605. bool duration; // print the time duration of each test case
  606. bool no_throw; // to skip exceptions-related assertion macros
  607. bool no_exitcode; // if the framework should return 0 as the exitcode
  608. bool no_run; // to not run the tests at all (can be done with an "*" exclude)
  609. bool no_version; // to not print the version of the framework
  610. bool no_colors; // if output to the console should be colorized
  611. bool force_colors; // forces the use of colors even when a tty cannot be detected
  612. bool no_breaks; // to not break into the debugger
  613. bool no_skip; // don't skip test cases which are marked to be skipped
  614. bool gnu_file_line; // if line numbers should be surrounded with :x: and not (x):
  615. bool no_path_in_filenames; // if the path to files should be removed from the output
  616. bool no_line_numbers; // if source code line numbers should be omitted from the output
  617. bool no_skipped_summary; // don't print "skipped" in the summary !!! UNDOCUMENTED !!!
  618. bool help; // to print the help
  619. bool version; // to print the version
  620. bool count; // if only the count of matching tests is to be retrieved
  621. bool list_test_cases; // to list all tests matching the filters
  622. bool list_test_suites; // to list all suites matching the filters
  623. bool list_reporters; // lists all registered reporters
  624. };
  625. namespace detail {
  626. #if defined(DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING) || defined(DOCTEST_CONFIG_INCLUDE_TYPE_TRAITS)
  627. template <bool CONDITION, typename TYPE = void>
  628. struct enable_if
  629. {};
  630. template <typename TYPE>
  631. struct enable_if<true, TYPE>
  632. { typedef TYPE type; };
  633. #endif // DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING) || DOCTEST_CONFIG_INCLUDE_TYPE_TRAITS
  634. // clang-format off
  635. template<class T> struct remove_reference { typedef T type; };
  636. template<class T> struct remove_reference<T&> { typedef T type; };
  637. template<class T> struct remove_reference<T&&> { typedef T type; };
  638. template<class T> struct remove_const { typedef T type; };
  639. template<class T> struct remove_const<const T> { typedef T type; };
  640. // clang-format on
  641. template <typename T>
  642. struct deferred_false
  643. // cppcheck-suppress unusedStructMember
  644. { static const bool value = false; };
  645. namespace has_insertion_operator_impl {
  646. typedef char no;
  647. typedef char yes[2];
  648. struct any_t
  649. {
  650. template <typename T>
  651. // cppcheck-suppress noExplicitConstructor
  652. any_t(const DOCTEST_REF_WRAP(T));
  653. };
  654. yes& testStreamable(std::ostream&);
  655. no testStreamable(no);
  656. no operator<<(const std::ostream&, const any_t&);
  657. template <typename T>
  658. struct has_insertion_operator
  659. {
  660. static std::ostream& s;
  661. static const DOCTEST_REF_WRAP(T) t;
  662. static const bool value = sizeof(decltype(testStreamable(s << t))) == sizeof(yes);
  663. };
  664. } // namespace has_insertion_operator_impl
  665. template <typename T>
  666. struct has_insertion_operator : has_insertion_operator_impl::has_insertion_operator<T>
  667. {};
  668. DOCTEST_INTERFACE void my_memcpy(void* dest, const void* src, unsigned num);
  669. DOCTEST_INTERFACE std::ostream* getTlsOss(); // returns a thread-local ostringstream
  670. DOCTEST_INTERFACE String getTlsOssResult();
  671. template <bool C>
  672. struct StringMakerBase
  673. {
  674. template <typename T>
  675. static String convert(const DOCTEST_REF_WRAP(T)) {
  676. return "{?}";
  677. }
  678. };
  679. template <>
  680. struct StringMakerBase<true>
  681. {
  682. template <typename T>
  683. static String convert(const DOCTEST_REF_WRAP(T) in) {
  684. *getTlsOss() << in;
  685. return getTlsOssResult();
  686. }
  687. };
  688. DOCTEST_INTERFACE String rawMemoryToString(const void* object, unsigned size);
  689. template <typename T>
  690. String rawMemoryToString(const DOCTEST_REF_WRAP(T) object) {
  691. return rawMemoryToString(&object, sizeof(object));
  692. }
  693. template <typename T>
  694. const char* type_to_string() {
  695. return "<>";
  696. }
  697. } // namespace detail
  698. template <typename T>
  699. struct StringMaker : public detail::StringMakerBase<detail::has_insertion_operator<T>::value>
  700. {};
  701. template <typename T>
  702. struct StringMaker<T*>
  703. {
  704. template <typename U>
  705. static String convert(U* p) {
  706. if(p)
  707. return detail::rawMemoryToString(p);
  708. return "NULL";
  709. }
  710. };
  711. template <typename R, typename C>
  712. struct StringMaker<R C::*>
  713. {
  714. static String convert(R C::*p) {
  715. if(p)
  716. return detail::rawMemoryToString(p);
  717. return "NULL";
  718. }
  719. };
  720. template <typename T>
  721. String toString(const DOCTEST_REF_WRAP(T) value) {
  722. return StringMaker<T>::convert(value);
  723. }
  724. #ifdef DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING
  725. DOCTEST_INTERFACE String toString(char* in);
  726. DOCTEST_INTERFACE String toString(const char* in);
  727. #endif // DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING
  728. DOCTEST_INTERFACE String toString(bool in);
  729. DOCTEST_INTERFACE String toString(float in);
  730. DOCTEST_INTERFACE String toString(double in);
  731. DOCTEST_INTERFACE String toString(double long in);
  732. DOCTEST_INTERFACE String toString(char in);
  733. DOCTEST_INTERFACE String toString(char signed in);
  734. DOCTEST_INTERFACE String toString(char unsigned in);
  735. DOCTEST_INTERFACE String toString(int short in);
  736. DOCTEST_INTERFACE String toString(int short unsigned in);
  737. DOCTEST_INTERFACE String toString(int in);
  738. DOCTEST_INTERFACE String toString(int unsigned in);
  739. DOCTEST_INTERFACE String toString(int long in);
  740. DOCTEST_INTERFACE String toString(int long unsigned in);
  741. DOCTEST_INTERFACE String toString(int long long in);
  742. DOCTEST_INTERFACE String toString(int long long unsigned in);
  743. DOCTEST_INTERFACE String toString(std::nullptr_t in);
  744. #if DOCTEST_MSVC >= DOCTEST_COMPILER(19, 20, 0)
  745. // see this issue on why this is needed: https://github.com/onqtam/doctest/issues/183
  746. DOCTEST_INTERFACE String toString(const std::string& in);
  747. #endif // VS 2019
  748. class DOCTEST_INTERFACE Approx
  749. {
  750. public:
  751. explicit Approx(double value);
  752. Approx operator()(double value) const;
  753. #ifdef DOCTEST_CONFIG_INCLUDE_TYPE_TRAITS
  754. template <typename T>
  755. explicit Approx(const T& value,
  756. typename detail::enable_if<std::is_constructible<double, T>::value>::type* =
  757. static_cast<T*>(nullptr)) {
  758. *this = Approx(static_cast<double>(value));
  759. }
  760. #endif // DOCTEST_CONFIG_INCLUDE_TYPE_TRAITS
  761. Approx& epsilon(double newEpsilon);
  762. #ifdef DOCTEST_CONFIG_INCLUDE_TYPE_TRAITS
  763. template <typename T>
  764. typename detail::enable_if<std::is_constructible<double, T>::value, Approx&>::type epsilon(
  765. const T& newEpsilon) {
  766. m_epsilon = static_cast<double>(newEpsilon);
  767. return *this;
  768. }
  769. #endif // DOCTEST_CONFIG_INCLUDE_TYPE_TRAITS
  770. Approx& scale(double newScale);
  771. #ifdef DOCTEST_CONFIG_INCLUDE_TYPE_TRAITS
  772. template <typename T>
  773. typename detail::enable_if<std::is_constructible<double, T>::value, Approx&>::type scale(
  774. const T& newScale) {
  775. m_scale = static_cast<double>(newScale);
  776. return *this;
  777. }
  778. #endif // DOCTEST_CONFIG_INCLUDE_TYPE_TRAITS
  779. // clang-format off
  780. DOCTEST_INTERFACE friend bool operator==(double lhs, const Approx & rhs);
  781. DOCTEST_INTERFACE friend bool operator==(const Approx & lhs, double rhs);
  782. DOCTEST_INTERFACE friend bool operator!=(double lhs, const Approx & rhs);
  783. DOCTEST_INTERFACE friend bool operator!=(const Approx & lhs, double rhs);
  784. DOCTEST_INTERFACE friend bool operator<=(double lhs, const Approx & rhs);
  785. DOCTEST_INTERFACE friend bool operator<=(const Approx & lhs, double rhs);
  786. DOCTEST_INTERFACE friend bool operator>=(double lhs, const Approx & rhs);
  787. DOCTEST_INTERFACE friend bool operator>=(const Approx & lhs, double rhs);
  788. DOCTEST_INTERFACE friend bool operator< (double lhs, const Approx & rhs);
  789. DOCTEST_INTERFACE friend bool operator< (const Approx & lhs, double rhs);
  790. DOCTEST_INTERFACE friend bool operator> (double lhs, const Approx & rhs);
  791. DOCTEST_INTERFACE friend bool operator> (const Approx & lhs, double rhs);
  792. DOCTEST_INTERFACE friend String toString(const Approx& in);
  793. #ifdef DOCTEST_CONFIG_INCLUDE_TYPE_TRAITS
  794. #define DOCTEST_APPROX_PREFIX \
  795. template <typename T> friend typename detail::enable_if<std::is_constructible<double, T>::value, bool>::type
  796. DOCTEST_APPROX_PREFIX operator==(const T& lhs, const Approx& rhs) { return operator==(double(lhs), rhs); }
  797. DOCTEST_APPROX_PREFIX operator==(const Approx& lhs, const T& rhs) { return operator==(rhs, lhs); }
  798. DOCTEST_APPROX_PREFIX operator!=(const T& lhs, const Approx& rhs) { return !operator==(lhs, rhs); }
  799. DOCTEST_APPROX_PREFIX operator!=(const Approx& lhs, const T& rhs) { return !operator==(rhs, lhs); }
  800. DOCTEST_APPROX_PREFIX operator<=(const T& lhs, const Approx& rhs) { return double(lhs) < rhs.m_value || lhs == rhs; }
  801. DOCTEST_APPROX_PREFIX operator<=(const Approx& lhs, const T& rhs) { return lhs.m_value < double(rhs) || lhs == rhs; }
  802. DOCTEST_APPROX_PREFIX operator>=(const T& lhs, const Approx& rhs) { return double(lhs) > rhs.m_value || lhs == rhs; }
  803. DOCTEST_APPROX_PREFIX operator>=(const Approx& lhs, const T& rhs) { return lhs.m_value > double(rhs) || lhs == rhs; }
  804. DOCTEST_APPROX_PREFIX operator< (const T& lhs, const Approx& rhs) { return double(lhs) < rhs.m_value && lhs != rhs; }
  805. DOCTEST_APPROX_PREFIX operator< (const Approx& lhs, const T& rhs) { return lhs.m_value < double(rhs) && lhs != rhs; }
  806. DOCTEST_APPROX_PREFIX operator> (const T& lhs, const Approx& rhs) { return double(lhs) > rhs.m_value && lhs != rhs; }
  807. DOCTEST_APPROX_PREFIX operator> (const Approx& lhs, const T& rhs) { return lhs.m_value > double(rhs) && lhs != rhs; }
  808. #undef DOCTEST_APPROX_PREFIX
  809. #endif // DOCTEST_CONFIG_INCLUDE_TYPE_TRAITS
  810. // clang-format on
  811. private:
  812. double m_epsilon;
  813. double m_scale;
  814. double m_value;
  815. };
  816. DOCTEST_INTERFACE String toString(const Approx& in);
  817. DOCTEST_INTERFACE const ContextOptions* getContextOptions();
  818. #if !defined(DOCTEST_CONFIG_DISABLE)
  819. namespace detail {
  820. // clang-format off
  821. #ifdef DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING
  822. template<class T> struct decay_array { typedef T type; };
  823. template<class T, unsigned N> struct decay_array<T[N]> { typedef T* type; };
  824. template<class T> struct decay_array<T[]> { typedef T* type; };
  825. template<class T> struct not_char_pointer { enum { value = 1 }; };
  826. template<> struct not_char_pointer<char*> { enum { value = 0 }; };
  827. template<> struct not_char_pointer<const char*> { enum { value = 0 }; };
  828. template<class T> struct can_use_op : public not_char_pointer<typename decay_array<T>::type> {};
  829. #endif // DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING
  830. // clang-format on
  831. struct DOCTEST_INTERFACE TestFailureException
  832. {
  833. };
  834. DOCTEST_INTERFACE bool checkIfShouldThrow(assertType::Enum at);
  835. #ifndef DOCTEST_CONFIG_NO_EXCEPTIONS
  836. [[noreturn]]
  837. #endif // DOCTEST_CONFIG_NO_EXCEPTIONS
  838. DOCTEST_INTERFACE void throwException();
  839. struct DOCTEST_INTERFACE Subcase
  840. {
  841. SubcaseSignature m_signature;
  842. bool m_entered = false;
  843. Subcase(const char* name, const char* file, int line);
  844. ~Subcase();
  845. operator bool() const;
  846. };
  847. template <typename L, typename R>
  848. String stringifyBinaryExpr(const DOCTEST_REF_WRAP(L) lhs, const char* op,
  849. const DOCTEST_REF_WRAP(R) rhs) {
  850. return toString(lhs) + op + toString(rhs);
  851. }
  852. #define DOCTEST_DO_BINARY_EXPRESSION_COMPARISON(op, op_str, op_macro) \
  853. template <typename R> \
  854. DOCTEST_NOINLINE Result operator op(const DOCTEST_REF_WRAP(R) rhs) { \
  855. bool res = op_macro(lhs, rhs); \
  856. if(m_at & assertType::is_false) \
  857. res = !res; \
  858. if(!res || doctest::getContextOptions()->success) \
  859. return Result(res, stringifyBinaryExpr(lhs, op_str, rhs)); \
  860. return Result(res); \
  861. }
  862. // more checks could be added - like in Catch:
  863. // https://github.com/catchorg/Catch2/pull/1480/files
  864. // https://github.com/catchorg/Catch2/pull/1481/files
  865. #define DOCTEST_FORBIT_EXPRESSION(rt, op) \
  866. template <typename R> \
  867. rt& operator op(const R&) { \
  868. static_assert(deferred_false<R>::value, \
  869. "Expression Too Complex Please Rewrite As Binary Comparison!"); \
  870. return *this; \
  871. }
  872. struct DOCTEST_INTERFACE Result
  873. {
  874. bool m_passed;
  875. String m_decomp;
  876. Result(bool passed, const String& decomposition = String());
  877. // forbidding some expressions based on this table: http://en.cppreference.com/w/cpp/language/operator_precedence
  878. DOCTEST_FORBIT_EXPRESSION(Result, &)
  879. DOCTEST_FORBIT_EXPRESSION(Result, ^)
  880. DOCTEST_FORBIT_EXPRESSION(Result, |)
  881. DOCTEST_FORBIT_EXPRESSION(Result, &&)
  882. DOCTEST_FORBIT_EXPRESSION(Result, ||)
  883. DOCTEST_FORBIT_EXPRESSION(Result, ==)
  884. DOCTEST_FORBIT_EXPRESSION(Result, !=)
  885. DOCTEST_FORBIT_EXPRESSION(Result, <)
  886. DOCTEST_FORBIT_EXPRESSION(Result, >)
  887. DOCTEST_FORBIT_EXPRESSION(Result, <=)
  888. DOCTEST_FORBIT_EXPRESSION(Result, >=)
  889. DOCTEST_FORBIT_EXPRESSION(Result, =)
  890. DOCTEST_FORBIT_EXPRESSION(Result, +=)
  891. DOCTEST_FORBIT_EXPRESSION(Result, -=)
  892. DOCTEST_FORBIT_EXPRESSION(Result, *=)
  893. DOCTEST_FORBIT_EXPRESSION(Result, /=)
  894. DOCTEST_FORBIT_EXPRESSION(Result, %=)
  895. DOCTEST_FORBIT_EXPRESSION(Result, <<=)
  896. DOCTEST_FORBIT_EXPRESSION(Result, >>=)
  897. DOCTEST_FORBIT_EXPRESSION(Result, &=)
  898. DOCTEST_FORBIT_EXPRESSION(Result, ^=)
  899. DOCTEST_FORBIT_EXPRESSION(Result, |=)
  900. };
  901. #ifndef DOCTEST_CONFIG_NO_COMPARISON_WARNING_SUPPRESSION
  902. DOCTEST_CLANG_SUPPRESS_WARNING_PUSH
  903. DOCTEST_CLANG_SUPPRESS_WARNING("-Wsign-conversion")
  904. DOCTEST_CLANG_SUPPRESS_WARNING("-Wsign-compare")
  905. //DOCTEST_CLANG_SUPPRESS_WARNING("-Wdouble-promotion")
  906. //DOCTEST_CLANG_SUPPRESS_WARNING("-Wconversion")
  907. //DOCTEST_CLANG_SUPPRESS_WARNING("-Wfloat-equal")
  908. DOCTEST_GCC_SUPPRESS_WARNING_PUSH
  909. DOCTEST_GCC_SUPPRESS_WARNING("-Wsign-conversion")
  910. DOCTEST_GCC_SUPPRESS_WARNING("-Wsign-compare")
  911. //DOCTEST_GCC_SUPPRESS_WARNING("-Wdouble-promotion")
  912. //DOCTEST_GCC_SUPPRESS_WARNING("-Wconversion")
  913. //DOCTEST_GCC_SUPPRESS_WARNING("-Wfloat-equal")
  914. DOCTEST_MSVC_SUPPRESS_WARNING_PUSH
  915. // http://stackoverflow.com/questions/39479163 what's the difference between 4018 and 4389
  916. DOCTEST_MSVC_SUPPRESS_WARNING(4388) // signed/unsigned mismatch
  917. DOCTEST_MSVC_SUPPRESS_WARNING(4389) // 'operator' : signed/unsigned mismatch
  918. DOCTEST_MSVC_SUPPRESS_WARNING(4018) // 'expression' : signed/unsigned mismatch
  919. //DOCTEST_MSVC_SUPPRESS_WARNING(4805) // 'operation' : unsafe mix of type 'type' and type 'type' in operation
  920. #endif // DOCTEST_CONFIG_NO_COMPARISON_WARNING_SUPPRESSION
  921. // clang-format off
  922. #ifndef DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING
  923. #define DOCTEST_COMPARISON_RETURN_TYPE bool
  924. #else // DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING
  925. #define DOCTEST_COMPARISON_RETURN_TYPE typename enable_if<can_use_op<L>::value || can_use_op<R>::value, bool>::type
  926. inline bool eq(const char* lhs, const char* rhs) { return String(lhs) == String(rhs); }
  927. inline bool ne(const char* lhs, const char* rhs) { return String(lhs) != String(rhs); }
  928. inline bool lt(const char* lhs, const char* rhs) { return String(lhs) < String(rhs); }
  929. inline bool gt(const char* lhs, const char* rhs) { return String(lhs) > String(rhs); }
  930. inline bool le(const char* lhs, const char* rhs) { return String(lhs) <= String(rhs); }
  931. inline bool ge(const char* lhs, const char* rhs) { return String(lhs) >= String(rhs); }
  932. #endif // DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING
  933. // clang-format on
  934. #define DOCTEST_RELATIONAL_OP(name, op) \
  935. template <typename L, typename R> \
  936. DOCTEST_COMPARISON_RETURN_TYPE name(const DOCTEST_REF_WRAP(L) lhs, \
  937. const DOCTEST_REF_WRAP(R) rhs) { \
  938. return lhs op rhs; \
  939. }
  940. DOCTEST_RELATIONAL_OP(eq, ==)
  941. DOCTEST_RELATIONAL_OP(ne, !=)
  942. DOCTEST_RELATIONAL_OP(lt, <)
  943. DOCTEST_RELATIONAL_OP(gt, >)
  944. DOCTEST_RELATIONAL_OP(le, <=)
  945. DOCTEST_RELATIONAL_OP(ge, >=)
  946. #ifndef DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING
  947. #define DOCTEST_CMP_EQ(l, r) l == r
  948. #define DOCTEST_CMP_NE(l, r) l != r
  949. #define DOCTEST_CMP_GT(l, r) l > r
  950. #define DOCTEST_CMP_LT(l, r) l < r
  951. #define DOCTEST_CMP_GE(l, r) l >= r
  952. #define DOCTEST_CMP_LE(l, r) l <= r
  953. #else // DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING
  954. #define DOCTEST_CMP_EQ(l, r) eq(l, r)
  955. #define DOCTEST_CMP_NE(l, r) ne(l, r)
  956. #define DOCTEST_CMP_GT(l, r) gt(l, r)
  957. #define DOCTEST_CMP_LT(l, r) lt(l, r)
  958. #define DOCTEST_CMP_GE(l, r) ge(l, r)
  959. #define DOCTEST_CMP_LE(l, r) le(l, r)
  960. #endif // DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING
  961. template <typename L>
  962. // cppcheck-suppress copyCtorAndEqOperator
  963. struct Expression_lhs
  964. {
  965. L lhs;
  966. assertType::Enum m_at;
  967. explicit Expression_lhs(L in, assertType::Enum at)
  968. : lhs(in)
  969. , m_at(at) {}
  970. DOCTEST_NOINLINE operator Result() {
  971. bool res = !!lhs;
  972. if(m_at & assertType::is_false) //!OCLINT bitwise operator in conditional
  973. res = !res;
  974. if(!res || getContextOptions()->success)
  975. return Result(res, toString(lhs));
  976. return Result(res);
  977. }
  978. // clang-format off
  979. DOCTEST_DO_BINARY_EXPRESSION_COMPARISON(==, " == ", DOCTEST_CMP_EQ) //!OCLINT bitwise operator in conditional
  980. DOCTEST_DO_BINARY_EXPRESSION_COMPARISON(!=, " != ", DOCTEST_CMP_NE) //!OCLINT bitwise operator in conditional
  981. DOCTEST_DO_BINARY_EXPRESSION_COMPARISON(>, " > ", DOCTEST_CMP_GT) //!OCLINT bitwise operator in conditional
  982. DOCTEST_DO_BINARY_EXPRESSION_COMPARISON(<, " < ", DOCTEST_CMP_LT) //!OCLINT bitwise operator in conditional
  983. DOCTEST_DO_BINARY_EXPRESSION_COMPARISON(>=, " >= ", DOCTEST_CMP_GE) //!OCLINT bitwise operator in conditional
  984. DOCTEST_DO_BINARY_EXPRESSION_COMPARISON(<=, " <= ", DOCTEST_CMP_LE) //!OCLINT bitwise operator in conditional
  985. // clang-format on
  986. // forbidding some expressions based on this table: http://en.cppreference.com/w/cpp/language/operator_precedence
  987. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, &)
  988. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, ^)
  989. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, |)
  990. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, &&)
  991. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, ||)
  992. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, =)
  993. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, +=)
  994. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, -=)
  995. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, *=)
  996. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, /=)
  997. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, %=)
  998. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, <<=)
  999. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, >>=)
  1000. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, &=)
  1001. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, ^=)
  1002. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, |=)
  1003. // these 2 are unfortunate because they should be allowed - they have higher precedence over the comparisons, but the
  1004. // ExpressionDecomposer class uses the left shift operator to capture the left operand of the binary expression...
  1005. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, <<)
  1006. DOCTEST_FORBIT_EXPRESSION(Expression_lhs, >>)
  1007. };
  1008. #ifndef DOCTEST_CONFIG_NO_COMPARISON_WARNING_SUPPRESSION
  1009. DOCTEST_CLANG_SUPPRESS_WARNING_POP
  1010. DOCTEST_MSVC_SUPPRESS_WARNING_POP
  1011. DOCTEST_GCC_SUPPRESS_WARNING_POP
  1012. #endif // DOCTEST_CONFIG_NO_COMPARISON_WARNING_SUPPRESSION
  1013. struct DOCTEST_INTERFACE ExpressionDecomposer
  1014. {
  1015. assertType::Enum m_at;
  1016. ExpressionDecomposer(assertType::Enum at);
  1017. // The right operator for capturing expressions is "<=" instead of "<<" (based on the operator precedence table)
  1018. // but then there will be warnings from GCC about "-Wparentheses" and since "_Pragma()" is problematic this will stay for now...
  1019. // https://github.com/catchorg/Catch2/issues/870
  1020. // https://github.com/catchorg/Catch2/issues/565
  1021. template <typename L>
  1022. Expression_lhs<const DOCTEST_REF_WRAP(L)> operator<<(const DOCTEST_REF_WRAP(L) operand) {
  1023. return Expression_lhs<const DOCTEST_REF_WRAP(L)>(operand, m_at);
  1024. }
  1025. };
  1026. struct DOCTEST_INTERFACE TestSuite
  1027. {
  1028. const char* m_test_suite;
  1029. const char* m_description;
  1030. bool m_skip;
  1031. bool m_may_fail;
  1032. bool m_should_fail;
  1033. int m_expected_failures;
  1034. double m_timeout;
  1035. TestSuite& operator*(const char* in);
  1036. template <typename T>
  1037. TestSuite& operator*(const T& in) {
  1038. in.fill(*this);
  1039. return *this;
  1040. }
  1041. };
  1042. typedef void (*funcType)();
  1043. struct DOCTEST_INTERFACE TestCase : public TestCaseData
  1044. {
  1045. funcType m_test; // a function pointer to the test case
  1046. const char* m_type; // for templated test cases - gets appended to the real name
  1047. int m_template_id; // an ID used to distinguish between the different versions of a templated test case
  1048. String m_full_name; // contains the name (only for templated test cases!) + the template type
  1049. TestCase(funcType test, const char* file, unsigned line, const TestSuite& test_suite,
  1050. const char* type = "", int template_id = -1);
  1051. TestCase(const TestCase& other);
  1052. DOCTEST_MSVC_SUPPRESS_WARNING_WITH_PUSH(26434) // hides a non-virtual function
  1053. TestCase& operator=(const TestCase& other);
  1054. DOCTEST_MSVC_SUPPRESS_WARNING_POP
  1055. TestCase& operator*(const char* in);
  1056. template <typename T>
  1057. TestCase& operator*(const T& in) {
  1058. in.fill(*this);
  1059. return *this;
  1060. }
  1061. bool operator<(const TestCase& other) const;
  1062. };
  1063. // forward declarations of functions used by the macros
  1064. DOCTEST_INTERFACE int regTest(const TestCase& tc);
  1065. DOCTEST_INTERFACE int setTestSuite(const TestSuite& ts);
  1066. DOCTEST_INTERFACE bool isDebuggerActive();
  1067. template<typename T>
  1068. int instantiationHelper(const T&) { return 0; }
  1069. namespace binaryAssertComparison {
  1070. enum Enum
  1071. {
  1072. eq = 0,
  1073. ne,
  1074. gt,
  1075. lt,
  1076. ge,
  1077. le
  1078. };
  1079. } // namespace binaryAssertComparison
  1080. // clang-format off
  1081. template <int, class L, class R> struct RelationalComparator { bool operator()(const DOCTEST_REF_WRAP(L), const DOCTEST_REF_WRAP(R) ) const { return false; } };
  1082. #define DOCTEST_BINARY_RELATIONAL_OP(n, op) \
  1083. template <class L, class R> struct RelationalComparator<n, L, R> { bool operator()(const DOCTEST_REF_WRAP(L) lhs, const DOCTEST_REF_WRAP(R) rhs) const { return op(lhs, rhs); } };
  1084. // clang-format on
  1085. DOCTEST_BINARY_RELATIONAL_OP(0, eq)
  1086. DOCTEST_BINARY_RELATIONAL_OP(1, ne)
  1087. DOCTEST_BINARY_RELATIONAL_OP(2, gt)
  1088. DOCTEST_BINARY_RELATIONAL_OP(3, lt)
  1089. DOCTEST_BINARY_RELATIONAL_OP(4, ge)
  1090. DOCTEST_BINARY_RELATIONAL_OP(5, le)
  1091. struct DOCTEST_INTERFACE ResultBuilder : public AssertData
  1092. {
  1093. ResultBuilder(assertType::Enum at, const char* file, int line, const char* expr,
  1094. const char* exception_type = "", const char* exception_string = "");
  1095. void setResult(const Result& res);
  1096. template <int comparison, typename L, typename R>
  1097. DOCTEST_NOINLINE void binary_assert(const DOCTEST_REF_WRAP(L) lhs,
  1098. const DOCTEST_REF_WRAP(R) rhs) {
  1099. m_failed = !RelationalComparator<comparison, L, R>()(lhs, rhs);
  1100. if(m_failed || getContextOptions()->success)
  1101. m_decomp = stringifyBinaryExpr(lhs, ", ", rhs);
  1102. }
  1103. template <typename L>
  1104. DOCTEST_NOINLINE void unary_assert(const DOCTEST_REF_WRAP(L) val) {
  1105. m_failed = !val;
  1106. if(m_at & assertType::is_false) //!OCLINT bitwise operator in conditional
  1107. m_failed = !m_failed;
  1108. if(m_failed || getContextOptions()->success)
  1109. m_decomp = toString(val);
  1110. }
  1111. void translateException();
  1112. bool log();
  1113. void react() const;
  1114. };
  1115. namespace assertAction {
  1116. enum Enum
  1117. {
  1118. nothing = 0,
  1119. dbgbreak = 1,
  1120. shouldthrow = 2
  1121. };
  1122. } // namespace assertAction
  1123. DOCTEST_INTERFACE void failed_out_of_a_testing_context(const AssertData& ad);
  1124. DOCTEST_INTERFACE void decomp_assert(assertType::Enum at, const char* file, int line,
  1125. const char* expr, Result result);
  1126. #define DOCTEST_ASSERT_OUT_OF_TESTS(decomp) \
  1127. do { \
  1128. if(!is_running_in_test) { \
  1129. if(failed) { \
  1130. ResultBuilder rb(at, file, line, expr); \
  1131. rb.m_failed = failed; \
  1132. rb.m_decomp = decomp; \
  1133. failed_out_of_a_testing_context(rb); \
  1134. if(isDebuggerActive() && !getContextOptions()->no_breaks) \
  1135. DOCTEST_BREAK_INTO_DEBUGGER(); \
  1136. if(checkIfShouldThrow(at)) \
  1137. throwException(); \
  1138. } \
  1139. return; \
  1140. } \
  1141. } while(false)
  1142. #define DOCTEST_ASSERT_IN_TESTS(decomp) \
  1143. ResultBuilder rb(at, file, line, expr); \
  1144. rb.m_failed = failed; \
  1145. if(rb.m_failed || getContextOptions()->success) \
  1146. rb.m_decomp = decomp; \
  1147. if(rb.log()) \
  1148. DOCTEST_BREAK_INTO_DEBUGGER(); \
  1149. if(rb.m_failed && checkIfShouldThrow(at)) \
  1150. throwException()
  1151. template <int comparison, typename L, typename R>
  1152. DOCTEST_NOINLINE void binary_assert(assertType::Enum at, const char* file, int line,
  1153. const char* expr, const DOCTEST_REF_WRAP(L) lhs,
  1154. const DOCTEST_REF_WRAP(R) rhs) {
  1155. bool failed = !RelationalComparator<comparison, L, R>()(lhs, rhs);
  1156. // ###################################################################################
  1157. // IF THE DEBUGGER BREAKS HERE - GO 1 LEVEL UP IN THE CALLSTACK FOR THE FAILING ASSERT
  1158. // THIS IS THE EFFECT OF HAVING 'DOCTEST_CONFIG_SUPER_FAST_ASSERTS' DEFINED
  1159. // ###################################################################################
  1160. DOCTEST_ASSERT_OUT_OF_TESTS(stringifyBinaryExpr(lhs, ", ", rhs));
  1161. DOCTEST_ASSERT_IN_TESTS(stringifyBinaryExpr(lhs, ", ", rhs));
  1162. }
  1163. template <typename L>
  1164. DOCTEST_NOINLINE void unary_assert(assertType::Enum at, const char* file, int line,
  1165. const char* expr, const DOCTEST_REF_WRAP(L) val) {
  1166. bool failed = !val;
  1167. if(at & assertType::is_false) //!OCLINT bitwise operator in conditional
  1168. failed = !failed;
  1169. // ###################################################################################
  1170. // IF THE DEBUGGER BREAKS HERE - GO 1 LEVEL UP IN THE CALLSTACK FOR THE FAILING ASSERT
  1171. // THIS IS THE EFFECT OF HAVING 'DOCTEST_CONFIG_SUPER_FAST_ASSERTS' DEFINED
  1172. // ###################################################################################
  1173. DOCTEST_ASSERT_OUT_OF_TESTS(toString(val));
  1174. DOCTEST_ASSERT_IN_TESTS(toString(val));
  1175. }
  1176. struct DOCTEST_INTERFACE IExceptionTranslator
  1177. {
  1178. IExceptionTranslator();
  1179. virtual ~IExceptionTranslator();
  1180. virtual bool translate(String&) const = 0;
  1181. };
  1182. template <typename T>
  1183. class ExceptionTranslator : public IExceptionTranslator //!OCLINT destructor of virtual class
  1184. {
  1185. public:
  1186. explicit ExceptionTranslator(String (*translateFunction)(T))
  1187. : m_translateFunction(translateFunction) {}
  1188. bool translate(String& res) const override {
  1189. #ifndef DOCTEST_CONFIG_NO_EXCEPTIONS
  1190. try {
  1191. throw; // lgtm [cpp/rethrow-no-exception]
  1192. // cppcheck-suppress catchExceptionByValue
  1193. } catch(T ex) { // NOLINT
  1194. res = m_translateFunction(ex); //!OCLINT parameter reassignment
  1195. return true;
  1196. } catch(...) {} //!OCLINT - empty catch statement
  1197. #endif // DOCTEST_CONFIG_NO_EXCEPTIONS
  1198. ((void)res); // to silence -Wunused-parameter
  1199. return false;
  1200. }
  1201. private:
  1202. String (*m_translateFunction)(T);
  1203. };
  1204. DOCTEST_INTERFACE void registerExceptionTranslatorImpl(const IExceptionTranslator* et);
  1205. template <bool C>
  1206. struct StringStreamBase
  1207. {
  1208. template <typename T>
  1209. static void convert(std::ostream* s, const T& in) {
  1210. *s << toString(in);
  1211. }
  1212. // always treat char* as a string in this context - no matter
  1213. // if DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING is defined
  1214. static void convert(std::ostream* s, const char* in) { *s << String(in); }
  1215. };
  1216. template <>
  1217. struct StringStreamBase<true>
  1218. {
  1219. template <typename T>
  1220. static void convert(std::ostream* s, const T& in) {
  1221. *s << in;
  1222. }
  1223. };
  1224. template <typename T>
  1225. struct StringStream : public StringStreamBase<has_insertion_operator<T>::value>
  1226. {};
  1227. template <typename T>
  1228. void toStream(std::ostream* s, const T& value) {
  1229. StringStream<T>::convert(s, value);
  1230. }
  1231. #ifdef DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING
  1232. DOCTEST_INTERFACE void toStream(std::ostream* s, char* in);
  1233. DOCTEST_INTERFACE void toStream(std::ostream* s, const char* in);
  1234. #endif // DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING
  1235. DOCTEST_INTERFACE void toStream(std::ostream* s, bool in);
  1236. DOCTEST_INTERFACE void toStream(std::ostream* s, float in);
  1237. DOCTEST_INTERFACE void toStream(std::ostream* s, double in);
  1238. DOCTEST_INTERFACE void toStream(std::ostream* s, double long in);
  1239. DOCTEST_INTERFACE void toStream(std::ostream* s, char in);
  1240. DOCTEST_INTERFACE void toStream(std::ostream* s, char signed in);
  1241. DOCTEST_INTERFACE void toStream(std::ostream* s, char unsigned in);
  1242. DOCTEST_INTERFACE void toStream(std::ostream* s, int short in);
  1243. DOCTEST_INTERFACE void toStream(std::ostream* s, int short unsigned in);
  1244. DOCTEST_INTERFACE void toStream(std::ostream* s, int in);
  1245. DOCTEST_INTERFACE void toStream(std::ostream* s, int unsigned in);
  1246. DOCTEST_INTERFACE void toStream(std::ostream* s, int long in);
  1247. DOCTEST_INTERFACE void toStream(std::ostream* s, int long unsigned in);
  1248. DOCTEST_INTERFACE void toStream(std::ostream* s, int long long in);
  1249. DOCTEST_INTERFACE void toStream(std::ostream* s, int long long unsigned in);
  1250. // ContextScope base class used to allow implementing methods of ContextScope
  1251. // that don't depend on the template parameter in doctest.cpp.
  1252. class DOCTEST_INTERFACE ContextScopeBase : public IContextScope {
  1253. protected:
  1254. ContextScopeBase();
  1255. void destroy();
  1256. };
  1257. template <typename L> class DOCTEST_INTERFACE ContextScope : public ContextScopeBase
  1258. {
  1259. const L &lambda_;
  1260. public:
  1261. explicit ContextScope(const L &lambda) : lambda_(lambda) {}
  1262. ContextScope(ContextScope &&other) : lambda_(other.lambda_) {}
  1263. void stringify(std::ostream* s) const override { lambda_(s); }
  1264. ~ContextScope() override { destroy(); }
  1265. };
  1266. struct DOCTEST_INTERFACE MessageBuilder : public MessageData
  1267. {
  1268. std::ostream* m_stream;
  1269. MessageBuilder(const char* file, int line, assertType::Enum severity);
  1270. MessageBuilder() = delete;
  1271. ~MessageBuilder();
  1272. template <typename T>
  1273. MessageBuilder& operator<<(const T& in) {
  1274. toStream(m_stream, in);
  1275. return *this;
  1276. }
  1277. bool log();
  1278. void react();
  1279. };
  1280. template <typename L>
  1281. ContextScope<L> MakeContextScope(const L &lambda) {
  1282. return ContextScope<L>(lambda);
  1283. }
  1284. } // namespace detail
  1285. #define DOCTEST_DEFINE_DECORATOR(name, type, def) \
  1286. struct name \
  1287. { \
  1288. type data; \
  1289. name(type in = def) \
  1290. : data(in) {} \
  1291. void fill(detail::TestCase& state) const { state.DOCTEST_CAT(m_, name) = data; } \
  1292. void fill(detail::TestSuite& state) const { state.DOCTEST_CAT(m_, name) = data; } \
  1293. }
  1294. DOCTEST_DEFINE_DECORATOR(test_suite, const char*, "");
  1295. DOCTEST_DEFINE_DECORATOR(description, const char*, "");
  1296. DOCTEST_DEFINE_DECORATOR(skip, bool, true);
  1297. DOCTEST_DEFINE_DECORATOR(timeout, double, 0);
  1298. DOCTEST_DEFINE_DECORATOR(may_fail, bool, true);
  1299. DOCTEST_DEFINE_DECORATOR(should_fail, bool, true);
  1300. DOCTEST_DEFINE_DECORATOR(expected_failures, int, 0);
  1301. template <typename T>
  1302. int registerExceptionTranslator(String (*translateFunction)(T)) {
  1303. DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH("-Wexit-time-destructors")
  1304. static detail::ExceptionTranslator<T> exceptionTranslator(translateFunction);
  1305. DOCTEST_CLANG_SUPPRESS_WARNING_POP
  1306. detail::registerExceptionTranslatorImpl(&exceptionTranslator);
  1307. return 0;
  1308. }
  1309. } // namespace doctest
  1310. // in a separate namespace outside of doctest because the DOCTEST_TEST_SUITE macro
  1311. // introduces an anonymous namespace in which getCurrentTestSuite gets overridden
  1312. namespace doctest_detail_test_suite_ns {
  1313. DOCTEST_INTERFACE doctest::detail::TestSuite& getCurrentTestSuite();
  1314. } // namespace doctest_detail_test_suite_ns
  1315. namespace doctest {
  1316. #else // DOCTEST_CONFIG_DISABLE
  1317. template <typename T>
  1318. int registerExceptionTranslator(String (*)(T)) {
  1319. return 0;
  1320. }
  1321. #endif // DOCTEST_CONFIG_DISABLE
  1322. namespace detail {
  1323. typedef void (*assert_handler)(const AssertData&);
  1324. struct ContextState;
  1325. } // namespace detail
  1326. class DOCTEST_INTERFACE Context
  1327. {
  1328. detail::ContextState* p;
  1329. void parseArgs(int argc, const char* const* argv, bool withDefaults = false);
  1330. public:
  1331. explicit Context(int argc = 0, const char* const* argv = nullptr);
  1332. ~Context();
  1333. void applyCommandLine(int argc, const char* const* argv);
  1334. void addFilter(const char* filter, const char* value);
  1335. void clearFilters();
  1336. void setOption(const char* option, int value);
  1337. void setOption(const char* option, const char* value);
  1338. bool shouldExit();
  1339. void setAsDefaultForAssertsOutOfTestCases();
  1340. void setAssertHandler(detail::assert_handler ah);
  1341. int run();
  1342. };
  1343. namespace TestCaseFailureReason {
  1344. enum Enum
  1345. {
  1346. None = 0,
  1347. AssertFailure = 1, // an assertion has failed in the test case
  1348. Exception = 2, // test case threw an exception
  1349. Crash = 4, // a crash...
  1350. TooManyFailedAsserts = 8, // the abort-after option
  1351. Timeout = 16, // see the timeout decorator
  1352. ShouldHaveFailedButDidnt = 32, // see the should_fail decorator
  1353. ShouldHaveFailedAndDid = 64, // see the should_fail decorator
  1354. DidntFailExactlyNumTimes = 128, // see the expected_failures decorator
  1355. FailedExactlyNumTimes = 256, // see the expected_failures decorator
  1356. CouldHaveFailedAndDid = 512 // see the may_fail decorator
  1357. };
  1358. } // namespace TestCaseFailureReason
  1359. struct DOCTEST_INTERFACE CurrentTestCaseStats
  1360. {
  1361. int numAssertsCurrentTest;
  1362. int numAssertsFailedCurrentTest;
  1363. double seconds;
  1364. int failure_flags; // use TestCaseFailureReason::Enum
  1365. };
  1366. struct DOCTEST_INTERFACE TestCaseException
  1367. {
  1368. String error_string;
  1369. bool is_crash;
  1370. };
  1371. struct DOCTEST_INTERFACE TestRunStats
  1372. {
  1373. unsigned numTestCases;
  1374. unsigned numTestCasesPassingFilters;
  1375. unsigned numTestSuitesPassingFilters;
  1376. unsigned numTestCasesFailed;
  1377. int numAsserts;
  1378. int numAssertsFailed;
  1379. };
  1380. struct QueryData
  1381. {
  1382. const TestRunStats* run_stats = nullptr;
  1383. String* data = nullptr;
  1384. unsigned num_data = 0;
  1385. };
  1386. struct DOCTEST_INTERFACE IReporter
  1387. {
  1388. // The constructor has to accept "const ContextOptions&" as a single argument
  1389. // which has most of the options for the run + a pointer to the stdout stream
  1390. // Reporter(const ContextOptions& in)
  1391. // called when a query should be reported (listing test cases, printing the version, etc.)
  1392. virtual void report_query(const QueryData&) = 0;
  1393. // called when the whole test run starts
  1394. virtual void test_run_start() = 0;
  1395. // called when the whole test run ends (caching a pointer to the input doesn't make sense here)
  1396. virtual void test_run_end(const TestRunStats&) = 0;
  1397. // called when a test case is started (safe to cache a pointer to the input)
  1398. virtual void test_case_start(const TestCaseData&) = 0;
  1399. // called when a test case is reentered because of unfinished subcases (safe to cache a pointer to the input)
  1400. virtual void test_case_reenter(const TestCaseData&) = 0;
  1401. // called when a test case has ended
  1402. virtual void test_case_end(const CurrentTestCaseStats&) = 0;
  1403. // called when an exception is thrown from the test case (or it crashes)
  1404. virtual void test_case_exception(const TestCaseException&) = 0;
  1405. // called whenever a subcase is entered (don't cache pointers to the input)
  1406. virtual void subcase_start(const SubcaseSignature&) = 0;
  1407. // called whenever a subcase is exited (don't cache pointers to the input)
  1408. virtual void subcase_end() = 0;
  1409. // called for each assert (don't cache pointers to the input)
  1410. virtual void log_assert(const AssertData&) = 0;
  1411. // called for each message (don't cache pointers to the input)
  1412. virtual void log_message(const MessageData&) = 0;
  1413. // called when a test case is skipped either because it doesn't pass the filters, has a skip decorator
  1414. // or isn't in the execution range (between first and last) (safe to cache a pointer to the input)
  1415. virtual void test_case_skipped(const TestCaseData&) = 0;
  1416. // doctest will not be managing the lifetimes of reporters given to it but this would still be nice to have
  1417. virtual ~IReporter();
  1418. // can obtain all currently active contexts and stringify them if one wishes to do so
  1419. static int get_num_active_contexts();
  1420. static const IContextScope* const* get_active_contexts();
  1421. // can iterate through contexts which have been stringified automatically in their destructors when an exception has been thrown
  1422. static int get_num_stringified_contexts();
  1423. static const String* get_stringified_contexts();
  1424. };
  1425. namespace detail {
  1426. typedef IReporter* (*reporterCreatorFunc)(const ContextOptions&);
  1427. DOCTEST_INTERFACE void registerReporterImpl(const char* name, int prio, reporterCreatorFunc c, bool isReporter);
  1428. template <typename Reporter>
  1429. IReporter* reporterCreator(const ContextOptions& o) {
  1430. return new Reporter(o);
  1431. }
  1432. } // namespace detail
  1433. template <typename Reporter>
  1434. int registerReporter(const char* name, int priority, bool isReporter) {
  1435. detail::registerReporterImpl(name, priority, detail::reporterCreator<Reporter>, isReporter);
  1436. return 0;
  1437. }
  1438. } // namespace doctest
  1439. // if registering is not disabled
  1440. #if !defined(DOCTEST_CONFIG_DISABLE)
  1441. // common code in asserts - for convenience
  1442. #define DOCTEST_ASSERT_LOG_AND_REACT(b) \
  1443. if(b.log()) \
  1444. DOCTEST_BREAK_INTO_DEBUGGER(); \
  1445. b.react()
  1446. #ifdef DOCTEST_CONFIG_NO_TRY_CATCH_IN_ASSERTS
  1447. #define DOCTEST_WRAP_IN_TRY(x) x;
  1448. #else // DOCTEST_CONFIG_NO_TRY_CATCH_IN_ASSERTS
  1449. #define DOCTEST_WRAP_IN_TRY(x) \
  1450. try { \
  1451. x; \
  1452. } catch(...) { _DOCTEST_RB.translateException(); }
  1453. #endif // DOCTEST_CONFIG_NO_TRY_CATCH_IN_ASSERTS
  1454. #ifdef DOCTEST_CONFIG_VOID_CAST_EXPRESSIONS
  1455. #define DOCTEST_CAST_TO_VOID(x) \
  1456. DOCTEST_GCC_SUPPRESS_WARNING_WITH_PUSH("-Wuseless-cast") \
  1457. static_cast<void>(x); \
  1458. DOCTEST_GCC_SUPPRESS_WARNING_POP
  1459. #else // DOCTEST_CONFIG_VOID_CAST_EXPRESSIONS
  1460. #define DOCTEST_CAST_TO_VOID(x) x;
  1461. #endif // DOCTEST_CONFIG_VOID_CAST_EXPRESSIONS
  1462. // registers the test by initializing a dummy var with a function
  1463. #define DOCTEST_REGISTER_FUNCTION(global_prefix, f, decorators) \
  1464. global_prefix DOCTEST_GLOBAL_NO_WARNINGS(DOCTEST_ANONYMOUS(_DOCTEST_ANON_VAR_)) = \
  1465. doctest::detail::regTest( \
  1466. doctest::detail::TestCase( \
  1467. f, __FILE__, __LINE__, \
  1468. doctest_detail_test_suite_ns::getCurrentTestSuite()) * \
  1469. decorators); \
  1470. DOCTEST_GLOBAL_NO_WARNINGS_END()
  1471. #define DOCTEST_IMPLEMENT_FIXTURE(der, base, func, decorators) \
  1472. namespace { \
  1473. struct der : public base \
  1474. { \
  1475. void f(); \
  1476. }; \
  1477. static void func() { \
  1478. der v; \
  1479. v.f(); \
  1480. } \
  1481. DOCTEST_REGISTER_FUNCTION(DOCTEST_EMPTY, func, decorators) \
  1482. } \
  1483. inline DOCTEST_NOINLINE void der::f()
  1484. #define DOCTEST_CREATE_AND_REGISTER_FUNCTION(f, decorators) \
  1485. static void f(); \
  1486. DOCTEST_REGISTER_FUNCTION(DOCTEST_EMPTY, f, decorators) \
  1487. static void f()
  1488. #define DOCTEST_CREATE_AND_REGISTER_FUNCTION_IN_CLASS(f, proxy, decorators) \
  1489. static doctest::detail::funcType proxy() { return f; } \
  1490. DOCTEST_REGISTER_FUNCTION(inline const, proxy(), decorators) \
  1491. static void f()
  1492. // for registering tests
  1493. #define DOCTEST_TEST_CASE(decorators) \
  1494. DOCTEST_CREATE_AND_REGISTER_FUNCTION(DOCTEST_ANONYMOUS(_DOCTEST_ANON_FUNC_), decorators)
  1495. // for registering tests in classes - requires C++17 for inline variables!
  1496. #if __cplusplus >= 201703L || (DOCTEST_MSVC >= DOCTEST_COMPILER(19, 12, 0) && _MSVC_LANG >= 201703L)
  1497. #define DOCTEST_TEST_CASE_CLASS(decorators) \
  1498. DOCTEST_CREATE_AND_REGISTER_FUNCTION_IN_CLASS(DOCTEST_ANONYMOUS(_DOCTEST_ANON_FUNC_), \
  1499. DOCTEST_ANONYMOUS(_DOCTEST_ANON_PROXY_), \
  1500. decorators)
  1501. #else // DOCTEST_TEST_CASE_CLASS
  1502. #define DOCTEST_TEST_CASE_CLASS(...) \
  1503. TEST_CASES_CAN_BE_REGISTERED_IN_CLASSES_ONLY_IN_CPP17_MODE_OR_WITH_VS_2017_OR_NEWER
  1504. #endif // DOCTEST_TEST_CASE_CLASS
  1505. // for registering tests with a fixture
  1506. #define DOCTEST_TEST_CASE_FIXTURE(c, decorators) \
  1507. DOCTEST_IMPLEMENT_FIXTURE(DOCTEST_ANONYMOUS(_DOCTEST_ANON_CLASS_), c, \
  1508. DOCTEST_ANONYMOUS(_DOCTEST_ANON_FUNC_), decorators)
  1509. // for converting types to strings without the <typeinfo> header and demangling
  1510. #define DOCTEST_TYPE_TO_STRING_IMPL(...) \
  1511. template <> \
  1512. inline const char* type_to_string<__VA_ARGS__>() { \
  1513. return "<" #__VA_ARGS__ ">"; \
  1514. }
  1515. #define DOCTEST_TYPE_TO_STRING(...) \
  1516. namespace doctest { namespace detail { \
  1517. DOCTEST_TYPE_TO_STRING_IMPL(__VA_ARGS__) \
  1518. } \
  1519. } \
  1520. typedef int DOCTEST_ANONYMOUS(_DOCTEST_ANON_FOR_SEMICOLON_)
  1521. #define DOCTEST_TEST_CASE_TEMPLATE_DEFINE_IMPL(dec, T, iter, func) \
  1522. template <typename T> \
  1523. static void func(); \
  1524. namespace { \
  1525. template <typename Tuple> \
  1526. struct iter; \
  1527. template <typename Type, typename... Rest> \
  1528. struct iter<std::tuple<Type, Rest...>> \
  1529. { \
  1530. iter(const char* file, unsigned line, int index) { \
  1531. doctest::detail::regTest(doctest::detail::TestCase(func<Type>, file, line, \
  1532. doctest_detail_test_suite_ns::getCurrentTestSuite(), \
  1533. doctest::detail::type_to_string<Type>(), \
  1534. int(line) * 1000 + index) \
  1535. * dec); \
  1536. iter<std::tuple<Rest...>>(file, line, index + 1); \
  1537. } \
  1538. }; \
  1539. template <> \
  1540. struct iter<std::tuple<>> \
  1541. { \
  1542. iter(const char*, unsigned, int) {} \
  1543. }; \
  1544. } \
  1545. template <typename T> \
  1546. static void func()
  1547. #define DOCTEST_TEST_CASE_TEMPLATE_DEFINE(dec, T, id) \
  1548. DOCTEST_TEST_CASE_TEMPLATE_DEFINE_IMPL(dec, T, DOCTEST_CAT(id, ITERATOR), \
  1549. DOCTEST_ANONYMOUS(_DOCTEST_ANON_TMP_))
  1550. #define DOCTEST_TEST_CASE_TEMPLATE_INSTANTIATE_IMPL(id, anon, ...) \
  1551. DOCTEST_GLOBAL_NO_WARNINGS(DOCTEST_CAT(anon, DUMMY)) = \
  1552. doctest::detail::instantiationHelper(DOCTEST_CAT(id, ITERATOR)<__VA_ARGS__>(__FILE__, __LINE__, 0));\
  1553. DOCTEST_GLOBAL_NO_WARNINGS_END()
  1554. #define DOCTEST_TEST_CASE_TEMPLATE_INVOKE(id, ...) \
  1555. DOCTEST_TEST_CASE_TEMPLATE_INSTANTIATE_IMPL(id, DOCTEST_ANONYMOUS(_DOCTEST_ANON_TMP_), std::tuple<__VA_ARGS__>) \
  1556. typedef int DOCTEST_ANONYMOUS(_DOCTEST_ANON_FOR_SEMICOLON_)
  1557. #define DOCTEST_TEST_CASE_TEMPLATE_APPLY(id, ...) \
  1558. DOCTEST_TEST_CASE_TEMPLATE_INSTANTIATE_IMPL(id, DOCTEST_ANONYMOUS(_DOCTEST_ANON_TMP_), __VA_ARGS__) \
  1559. typedef int DOCTEST_ANONYMOUS(_DOCTEST_ANON_FOR_SEMICOLON_)
  1560. #define DOCTEST_TEST_CASE_TEMPLATE_IMPL(dec, T, anon, ...) \
  1561. DOCTEST_TEST_CASE_TEMPLATE_DEFINE_IMPL(dec, T, DOCTEST_CAT(anon, ITERATOR), anon); \
  1562. DOCTEST_TEST_CASE_TEMPLATE_INSTANTIATE_IMPL(anon, anon, std::tuple<__VA_ARGS__>) \
  1563. template <typename T> \
  1564. static void anon()
  1565. #define DOCTEST_TEST_CASE_TEMPLATE(dec, T, ...) \
  1566. DOCTEST_TEST_CASE_TEMPLATE_IMPL(dec, T, DOCTEST_ANONYMOUS(_DOCTEST_ANON_TMP_), __VA_ARGS__)
  1567. // for subcases
  1568. #define DOCTEST_SUBCASE(name) \
  1569. if(const doctest::detail::Subcase & DOCTEST_ANONYMOUS(_DOCTEST_ANON_SUBCASE_) DOCTEST_UNUSED = \
  1570. doctest::detail::Subcase(name, __FILE__, __LINE__))
  1571. // for grouping tests in test suites by using code blocks
  1572. #define DOCTEST_TEST_SUITE_IMPL(decorators, ns_name) \
  1573. namespace ns_name { namespace doctest_detail_test_suite_ns { \
  1574. static DOCTEST_NOINLINE doctest::detail::TestSuite& getCurrentTestSuite() { \
  1575. DOCTEST_MSVC_SUPPRESS_WARNING_WITH_PUSH(4640) \
  1576. DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH("-Wexit-time-destructors") \
  1577. static doctest::detail::TestSuite data; \
  1578. static bool inited = false; \
  1579. DOCTEST_MSVC_SUPPRESS_WARNING_POP \
  1580. DOCTEST_CLANG_SUPPRESS_WARNING_POP \
  1581. if(!inited) { \
  1582. data* decorators; \
  1583. inited = true; \
  1584. } \
  1585. return data; \
  1586. } \
  1587. } \
  1588. } \
  1589. namespace ns_name
  1590. #define DOCTEST_TEST_SUITE(decorators) \
  1591. DOCTEST_TEST_SUITE_IMPL(decorators, DOCTEST_ANONYMOUS(_DOCTEST_ANON_SUITE_))
  1592. // for starting a testsuite block
  1593. #define DOCTEST_TEST_SUITE_BEGIN(decorators) \
  1594. DOCTEST_GLOBAL_NO_WARNINGS(DOCTEST_ANONYMOUS(_DOCTEST_ANON_VAR_)) = \
  1595. doctest::detail::setTestSuite(doctest::detail::TestSuite() * decorators); \
  1596. DOCTEST_GLOBAL_NO_WARNINGS_END() \
  1597. typedef int DOCTEST_ANONYMOUS(_DOCTEST_ANON_FOR_SEMICOLON_)
  1598. // for ending a testsuite block
  1599. #define DOCTEST_TEST_SUITE_END \
  1600. DOCTEST_GLOBAL_NO_WARNINGS(DOCTEST_ANONYMOUS(_DOCTEST_ANON_VAR_)) = \
  1601. doctest::detail::setTestSuite(doctest::detail::TestSuite() * ""); \
  1602. DOCTEST_GLOBAL_NO_WARNINGS_END() \
  1603. typedef int DOCTEST_ANONYMOUS(_DOCTEST_ANON_FOR_SEMICOLON_)
  1604. // for registering exception translators
  1605. #define DOCTEST_REGISTER_EXCEPTION_TRANSLATOR_IMPL(translatorName, signature) \
  1606. inline doctest::String translatorName(signature); \
  1607. DOCTEST_GLOBAL_NO_WARNINGS(DOCTEST_ANONYMOUS(_DOCTEST_ANON_TRANSLATOR_)) = \
  1608. doctest::registerExceptionTranslator(translatorName); \
  1609. DOCTEST_GLOBAL_NO_WARNINGS_END() \
  1610. doctest::String translatorName(signature)
  1611. #define DOCTEST_REGISTER_EXCEPTION_TRANSLATOR(signature) \
  1612. DOCTEST_REGISTER_EXCEPTION_TRANSLATOR_IMPL(DOCTEST_ANONYMOUS(_DOCTEST_ANON_TRANSLATOR_), \
  1613. signature)
  1614. // for registering reporters
  1615. #define DOCTEST_REGISTER_REPORTER(name, priority, reporter) \
  1616. DOCTEST_GLOBAL_NO_WARNINGS(DOCTEST_ANONYMOUS(_DOCTEST_ANON_REPORTER_)) = \
  1617. doctest::registerReporter<reporter>(name, priority, true); \
  1618. DOCTEST_GLOBAL_NO_WARNINGS_END() typedef int DOCTEST_ANONYMOUS(_DOCTEST_ANON_FOR_SEMICOLON_)
  1619. // for registering listeners
  1620. #define DOCTEST_REGISTER_LISTENER(name, priority, reporter) \
  1621. DOCTEST_GLOBAL_NO_WARNINGS(DOCTEST_ANONYMOUS(_DOCTEST_ANON_REPORTER_)) = \
  1622. doctest::registerReporter<reporter>(name, priority, false); \
  1623. DOCTEST_GLOBAL_NO_WARNINGS_END() typedef int DOCTEST_ANONYMOUS(_DOCTEST_ANON_FOR_SEMICOLON_)
  1624. // for logging
  1625. #define DOCTEST_INFO(expression) \
  1626. DOCTEST_INFO_IMPL(DOCTEST_ANONYMOUS(_DOCTEST_CAPTURE_), DOCTEST_ANONYMOUS(_DOCTEST_CAPTURE_), \
  1627. DOCTEST_ANONYMOUS(_DOCTEST_CAPTURE_), expression)
  1628. #define DOCTEST_INFO_IMPL(lambda_name, mb_name, s_name, expression) \
  1629. DOCTEST_MSVC_SUPPRESS_WARNING_WITH_PUSH(4626) \
  1630. auto lambda_name = [&](std::ostream* s_name) { \
  1631. doctest::detail::MessageBuilder mb_name(__FILE__, __LINE__, doctest::assertType::is_warn); \
  1632. mb_name.m_stream = s_name; \
  1633. mb_name << expression; \
  1634. }; \
  1635. DOCTEST_MSVC_SUPPRESS_WARNING_POP \
  1636. auto DOCTEST_ANONYMOUS(_DOCTEST_CAPTURE_) = doctest::detail::MakeContextScope(lambda_name)
  1637. #define DOCTEST_CAPTURE(x) DOCTEST_INFO(#x " := " << x)
  1638. #define DOCTEST_ADD_AT_IMPL(type, file, line, mb, x) \
  1639. do { \
  1640. doctest::detail::MessageBuilder mb(file, line, doctest::assertType::type); \
  1641. mb << x; \
  1642. DOCTEST_ASSERT_LOG_AND_REACT(mb); \
  1643. } while((void)0, 0)
  1644. // clang-format off
  1645. #define DOCTEST_ADD_MESSAGE_AT(file, line, x) DOCTEST_ADD_AT_IMPL(is_warn, file, line, DOCTEST_ANONYMOUS(_DOCTEST_MESSAGE_), x)
  1646. #define DOCTEST_ADD_FAIL_CHECK_AT(file, line, x) DOCTEST_ADD_AT_IMPL(is_check, file, line, DOCTEST_ANONYMOUS(_DOCTEST_MESSAGE_), x)
  1647. #define DOCTEST_ADD_FAIL_AT(file, line, x) DOCTEST_ADD_AT_IMPL(is_require, file, line, DOCTEST_ANONYMOUS(_DOCTEST_MESSAGE_), x)
  1648. // clang-format on
  1649. #define DOCTEST_MESSAGE(x) DOCTEST_ADD_MESSAGE_AT(__FILE__, __LINE__, x)
  1650. #define DOCTEST_FAIL_CHECK(x) DOCTEST_ADD_FAIL_CHECK_AT(__FILE__, __LINE__, x)
  1651. #define DOCTEST_FAIL(x) DOCTEST_ADD_FAIL_AT(__FILE__, __LINE__, x)
  1652. #define DOCTEST_TO_LVALUE(...) __VA_ARGS__ // Not removed to keep backwards compatibility.
  1653. #ifndef DOCTEST_CONFIG_SUPER_FAST_ASSERTS
  1654. #define DOCTEST_ASSERT_IMPLEMENT_2(assert_type, ...) \
  1655. DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH("-Woverloaded-shift-op-parentheses") \
  1656. doctest::detail::ResultBuilder _DOCTEST_RB(doctest::assertType::assert_type, __FILE__, \
  1657. __LINE__, #__VA_ARGS__); \
  1658. DOCTEST_WRAP_IN_TRY(_DOCTEST_RB.setResult( \
  1659. doctest::detail::ExpressionDecomposer(doctest::assertType::assert_type) \
  1660. << __VA_ARGS__)) \
  1661. DOCTEST_ASSERT_LOG_AND_REACT(_DOCTEST_RB) \
  1662. DOCTEST_CLANG_SUPPRESS_WARNING_POP
  1663. #define DOCTEST_ASSERT_IMPLEMENT_1(assert_type, ...) \
  1664. do { \
  1665. DOCTEST_ASSERT_IMPLEMENT_2(assert_type, __VA_ARGS__); \
  1666. } while((void)0, 0)
  1667. #else // DOCTEST_CONFIG_SUPER_FAST_ASSERTS
  1668. // necessary for <ASSERT>_MESSAGE
  1669. #define DOCTEST_ASSERT_IMPLEMENT_2 DOCTEST_ASSERT_IMPLEMENT_1
  1670. #define DOCTEST_ASSERT_IMPLEMENT_1(assert_type, ...) \
  1671. DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH("-Woverloaded-shift-op-parentheses") \
  1672. doctest::detail::decomp_assert( \
  1673. doctest::assertType::assert_type, __FILE__, __LINE__, #__VA_ARGS__, \
  1674. doctest::detail::ExpressionDecomposer(doctest::assertType::assert_type) \
  1675. << __VA_ARGS__) DOCTEST_CLANG_SUPPRESS_WARNING_POP
  1676. #endif // DOCTEST_CONFIG_SUPER_FAST_ASSERTS
  1677. #define DOCTEST_WARN(...) DOCTEST_ASSERT_IMPLEMENT_1(DT_WARN, __VA_ARGS__)
  1678. #define DOCTEST_CHECK(...) DOCTEST_ASSERT_IMPLEMENT_1(DT_CHECK, __VA_ARGS__)
  1679. #define DOCTEST_REQUIRE(...) DOCTEST_ASSERT_IMPLEMENT_1(DT_REQUIRE, __VA_ARGS__)
  1680. #define DOCTEST_WARN_FALSE(...) DOCTEST_ASSERT_IMPLEMENT_1(DT_WARN_FALSE, __VA_ARGS__)
  1681. #define DOCTEST_CHECK_FALSE(...) DOCTEST_ASSERT_IMPLEMENT_1(DT_CHECK_FALSE, __VA_ARGS__)
  1682. #define DOCTEST_REQUIRE_FALSE(...) DOCTEST_ASSERT_IMPLEMENT_1(DT_REQUIRE_FALSE, __VA_ARGS__)
  1683. // clang-format off
  1684. #define DOCTEST_WARN_MESSAGE(cond, msg) do { DOCTEST_INFO(msg); DOCTEST_ASSERT_IMPLEMENT_2(DT_WARN, cond); } while((void)0, 0)
  1685. #define DOCTEST_CHECK_MESSAGE(cond, msg) do { DOCTEST_INFO(msg); DOCTEST_ASSERT_IMPLEMENT_2(DT_CHECK, cond); } while((void)0, 0)
  1686. #define DOCTEST_REQUIRE_MESSAGE(cond, msg) do { DOCTEST_INFO(msg); DOCTEST_ASSERT_IMPLEMENT_2(DT_REQUIRE, cond); } while((void)0, 0)
  1687. #define DOCTEST_WARN_FALSE_MESSAGE(cond, msg) do { DOCTEST_INFO(msg); DOCTEST_ASSERT_IMPLEMENT_2(DT_WARN_FALSE, cond); } while((void)0, 0)
  1688. #define DOCTEST_CHECK_FALSE_MESSAGE(cond, msg) do { DOCTEST_INFO(msg); DOCTEST_ASSERT_IMPLEMENT_2(DT_CHECK_FALSE, cond); } while((void)0, 0)
  1689. #define DOCTEST_REQUIRE_FALSE_MESSAGE(cond, msg) do { DOCTEST_INFO(msg); DOCTEST_ASSERT_IMPLEMENT_2(DT_REQUIRE_FALSE, cond); } while((void)0, 0)
  1690. // clang-format on
  1691. #define DOCTEST_ASSERT_THROWS_AS(expr, assert_type, message, ...) \
  1692. do { \
  1693. if(!doctest::getContextOptions()->no_throw) { \
  1694. doctest::detail::ResultBuilder _DOCTEST_RB(doctest::assertType::assert_type, __FILE__, \
  1695. __LINE__, #expr, #__VA_ARGS__, message); \
  1696. try { \
  1697. DOCTEST_CAST_TO_VOID(expr) \
  1698. } catch(const doctest::detail::remove_const< \
  1699. doctest::detail::remove_reference<__VA_ARGS__>::type>::type&) { \
  1700. _DOCTEST_RB.translateException(); \
  1701. _DOCTEST_RB.m_threw_as = true; \
  1702. } catch(...) { _DOCTEST_RB.translateException(); } \
  1703. DOCTEST_ASSERT_LOG_AND_REACT(_DOCTEST_RB); \
  1704. } \
  1705. } while((void)0, 0)
  1706. #define DOCTEST_ASSERT_THROWS_WITH(expr, assert_type, ...) \
  1707. do { \
  1708. if(!doctest::getContextOptions()->no_throw) { \
  1709. doctest::detail::ResultBuilder _DOCTEST_RB(doctest::assertType::assert_type, __FILE__, \
  1710. __LINE__, #expr, "", __VA_ARGS__); \
  1711. try { \
  1712. DOCTEST_CAST_TO_VOID(expr) \
  1713. } catch(...) { _DOCTEST_RB.translateException(); } \
  1714. DOCTEST_ASSERT_LOG_AND_REACT(_DOCTEST_RB); \
  1715. } \
  1716. } while((void)0, 0)
  1717. #define DOCTEST_ASSERT_NOTHROW(expr, assert_type) \
  1718. do { \
  1719. doctest::detail::ResultBuilder _DOCTEST_RB(doctest::assertType::assert_type, __FILE__, \
  1720. __LINE__, #expr); \
  1721. try { \
  1722. DOCTEST_CAST_TO_VOID(expr) \
  1723. } catch(...) { _DOCTEST_RB.translateException(); } \
  1724. DOCTEST_ASSERT_LOG_AND_REACT(_DOCTEST_RB); \
  1725. } while((void)0, 0)
  1726. // clang-format off
  1727. #define DOCTEST_WARN_THROWS(expr) DOCTEST_ASSERT_THROWS_WITH(expr, DT_WARN_THROWS, "")
  1728. #define DOCTEST_CHECK_THROWS(expr) DOCTEST_ASSERT_THROWS_WITH(expr, DT_CHECK_THROWS, "")
  1729. #define DOCTEST_REQUIRE_THROWS(expr) DOCTEST_ASSERT_THROWS_WITH(expr, DT_REQUIRE_THROWS, "")
  1730. #define DOCTEST_WARN_THROWS_AS(expr, ...) DOCTEST_ASSERT_THROWS_AS(expr, DT_WARN_THROWS_AS, "", __VA_ARGS__)
  1731. #define DOCTEST_CHECK_THROWS_AS(expr, ...) DOCTEST_ASSERT_THROWS_AS(expr, DT_CHECK_THROWS_AS, "", __VA_ARGS__)
  1732. #define DOCTEST_REQUIRE_THROWS_AS(expr, ...) DOCTEST_ASSERT_THROWS_AS(expr, DT_REQUIRE_THROWS_AS, "", __VA_ARGS__)
  1733. #define DOCTEST_WARN_THROWS_WITH(expr, ...) DOCTEST_ASSERT_THROWS_WITH(expr, DT_WARN_THROWS_WITH, __VA_ARGS__)
  1734. #define DOCTEST_CHECK_THROWS_WITH(expr, ...) DOCTEST_ASSERT_THROWS_WITH(expr, DT_CHECK_THROWS_WITH, __VA_ARGS__)
  1735. #define DOCTEST_REQUIRE_THROWS_WITH(expr, ...) DOCTEST_ASSERT_THROWS_WITH(expr, DT_REQUIRE_THROWS_WITH, __VA_ARGS__)
  1736. #define DOCTEST_WARN_THROWS_WITH_AS(expr, message, ...) DOCTEST_ASSERT_THROWS_AS(expr, DT_WARN_THROWS_WITH_AS, message, __VA_ARGS__)
  1737. #define DOCTEST_CHECK_THROWS_WITH_AS(expr, message, ...) DOCTEST_ASSERT_THROWS_AS(expr, DT_CHECK_THROWS_WITH_AS, message, __VA_ARGS__)
  1738. #define DOCTEST_REQUIRE_THROWS_WITH_AS(expr, message, ...) DOCTEST_ASSERT_THROWS_AS(expr, DT_REQUIRE_THROWS_WITH_AS, message, __VA_ARGS__)
  1739. #define DOCTEST_WARN_NOTHROW(expr) DOCTEST_ASSERT_NOTHROW(expr, DT_WARN_NOTHROW)
  1740. #define DOCTEST_CHECK_NOTHROW(expr) DOCTEST_ASSERT_NOTHROW(expr, DT_CHECK_NOTHROW)
  1741. #define DOCTEST_REQUIRE_NOTHROW(expr) DOCTEST_ASSERT_NOTHROW(expr, DT_REQUIRE_NOTHROW)
  1742. #define DOCTEST_WARN_THROWS_MESSAGE(expr, msg) do { DOCTEST_INFO(msg); DOCTEST_WARN_THROWS(expr); } while((void)0, 0)
  1743. #define DOCTEST_CHECK_THROWS_MESSAGE(expr, msg) do { DOCTEST_INFO(msg); DOCTEST_CHECK_THROWS(expr); } while((void)0, 0)
  1744. #define DOCTEST_REQUIRE_THROWS_MESSAGE(expr, msg) do { DOCTEST_INFO(msg); DOCTEST_REQUIRE_THROWS(expr); } while((void)0, 0)
  1745. #define DOCTEST_WARN_THROWS_AS_MESSAGE(expr, ex, msg) do { DOCTEST_INFO(msg); DOCTEST_WARN_THROWS_AS(expr, ex); } while((void)0, 0)
  1746. #define DOCTEST_CHECK_THROWS_AS_MESSAGE(expr, ex, msg) do { DOCTEST_INFO(msg); DOCTEST_CHECK_THROWS_AS(expr, ex); } while((void)0, 0)
  1747. #define DOCTEST_REQUIRE_THROWS_AS_MESSAGE(expr, ex, msg) do { DOCTEST_INFO(msg); DOCTEST_REQUIRE_THROWS_AS(expr, ex); } while((void)0, 0)
  1748. #define DOCTEST_WARN_THROWS_WITH_MESSAGE(expr, with, msg) do { DOCTEST_INFO(msg); DOCTEST_WARN_THROWS_WITH(expr, with); } while((void)0, 0)
  1749. #define DOCTEST_CHECK_THROWS_WITH_MESSAGE(expr, with, msg) do { DOCTEST_INFO(msg); DOCTEST_CHECK_THROWS_WITH(expr, with); } while((void)0, 0)
  1750. #define DOCTEST_REQUIRE_THROWS_WITH_MESSAGE(expr, with, msg) do { DOCTEST_INFO(msg); DOCTEST_REQUIRE_THROWS_WITH(expr, with); } while((void)0, 0)
  1751. #define DOCTEST_WARN_THROWS_WITH_AS_MESSAGE(expr, with, ex, msg) do { DOCTEST_INFO(msg); DOCTEST_WARN_THROWS_WITH_AS(expr, with, ex); } while((void)0, 0)
  1752. #define DOCTEST_CHECK_THROWS_WITH_AS_MESSAGE(expr, with, ex, msg) do { DOCTEST_INFO(msg); DOCTEST_CHECK_THROWS_WITH_AS(expr, with, ex); } while((void)0, 0)
  1753. #define DOCTEST_REQUIRE_THROWS_WITH_AS_MESSAGE(expr, with, ex, msg) do { DOCTEST_INFO(msg); DOCTEST_REQUIRE_THROWS_WITH_AS(expr, with, ex); } while((void)0, 0)
  1754. #define DOCTEST_WARN_NOTHROW_MESSAGE(expr, msg) do { DOCTEST_INFO(msg); DOCTEST_WARN_NOTHROW(expr); } while((void)0, 0)
  1755. #define DOCTEST_CHECK_NOTHROW_MESSAGE(expr, msg) do { DOCTEST_INFO(msg); DOCTEST_CHECK_NOTHROW(expr); } while((void)0, 0)
  1756. #define DOCTEST_REQUIRE_NOTHROW_MESSAGE(expr, msg) do { DOCTEST_INFO(msg); DOCTEST_REQUIRE_NOTHROW(expr); } while((void)0, 0)
  1757. // clang-format on
  1758. #ifndef DOCTEST_CONFIG_SUPER_FAST_ASSERTS
  1759. #define DOCTEST_BINARY_ASSERT(assert_type, comp, ...) \
  1760. do { \
  1761. doctest::detail::ResultBuilder _DOCTEST_RB(doctest::assertType::assert_type, __FILE__, \
  1762. __LINE__, #__VA_ARGS__); \
  1763. DOCTEST_WRAP_IN_TRY( \
  1764. _DOCTEST_RB.binary_assert<doctest::detail::binaryAssertComparison::comp>( \
  1765. __VA_ARGS__)) \
  1766. DOCTEST_ASSERT_LOG_AND_REACT(_DOCTEST_RB); \
  1767. } while((void)0, 0)
  1768. #define DOCTEST_UNARY_ASSERT(assert_type, ...) \
  1769. do { \
  1770. doctest::detail::ResultBuilder _DOCTEST_RB(doctest::assertType::assert_type, __FILE__, \
  1771. __LINE__, #__VA_ARGS__); \
  1772. DOCTEST_WRAP_IN_TRY(_DOCTEST_RB.unary_assert(__VA_ARGS__)) \
  1773. DOCTEST_ASSERT_LOG_AND_REACT(_DOCTEST_RB); \
  1774. } while((void)0, 0)
  1775. #else // DOCTEST_CONFIG_SUPER_FAST_ASSERTS
  1776. #define DOCTEST_BINARY_ASSERT(assert_type, comparison, ...) \
  1777. doctest::detail::binary_assert<doctest::detail::binaryAssertComparison::comparison>( \
  1778. doctest::assertType::assert_type, __FILE__, __LINE__, #__VA_ARGS__, __VA_ARGS__)
  1779. #define DOCTEST_UNARY_ASSERT(assert_type, ...) \
  1780. doctest::detail::unary_assert(doctest::assertType::assert_type, __FILE__, __LINE__, \
  1781. #__VA_ARGS__, __VA_ARGS__)
  1782. #endif // DOCTEST_CONFIG_SUPER_FAST_ASSERTS
  1783. #define DOCTEST_WARN_EQ(...) DOCTEST_BINARY_ASSERT(DT_WARN_EQ, eq, __VA_ARGS__)
  1784. #define DOCTEST_CHECK_EQ(...) DOCTEST_BINARY_ASSERT(DT_CHECK_EQ, eq, __VA_ARGS__)
  1785. #define DOCTEST_REQUIRE_EQ(...) DOCTEST_BINARY_ASSERT(DT_REQUIRE_EQ, eq, __VA_ARGS__)
  1786. #define DOCTEST_WARN_NE(...) DOCTEST_BINARY_ASSERT(DT_WARN_NE, ne, __VA_ARGS__)
  1787. #define DOCTEST_CHECK_NE(...) DOCTEST_BINARY_ASSERT(DT_CHECK_NE, ne, __VA_ARGS__)
  1788. #define DOCTEST_REQUIRE_NE(...) DOCTEST_BINARY_ASSERT(DT_REQUIRE_NE, ne, __VA_ARGS__)
  1789. #define DOCTEST_WARN_GT(...) DOCTEST_BINARY_ASSERT(DT_WARN_GT, gt, __VA_ARGS__)
  1790. #define DOCTEST_CHECK_GT(...) DOCTEST_BINARY_ASSERT(DT_CHECK_GT, gt, __VA_ARGS__)
  1791. #define DOCTEST_REQUIRE_GT(...) DOCTEST_BINARY_ASSERT(DT_REQUIRE_GT, gt, __VA_ARGS__)
  1792. #define DOCTEST_WARN_LT(...) DOCTEST_BINARY_ASSERT(DT_WARN_LT, lt, __VA_ARGS__)
  1793. #define DOCTEST_CHECK_LT(...) DOCTEST_BINARY_ASSERT(DT_CHECK_LT, lt, __VA_ARGS__)
  1794. #define DOCTEST_REQUIRE_LT(...) DOCTEST_BINARY_ASSERT(DT_REQUIRE_LT, lt, __VA_ARGS__)
  1795. #define DOCTEST_WARN_GE(...) DOCTEST_BINARY_ASSERT(DT_WARN_GE, ge, __VA_ARGS__)
  1796. #define DOCTEST_CHECK_GE(...) DOCTEST_BINARY_ASSERT(DT_CHECK_GE, ge, __VA_ARGS__)
  1797. #define DOCTEST_REQUIRE_GE(...) DOCTEST_BINARY_ASSERT(DT_REQUIRE_GE, ge, __VA_ARGS__)
  1798. #define DOCTEST_WARN_LE(...) DOCTEST_BINARY_ASSERT(DT_WARN_LE, le, __VA_ARGS__)
  1799. #define DOCTEST_CHECK_LE(...) DOCTEST_BINARY_ASSERT(DT_CHECK_LE, le, __VA_ARGS__)
  1800. #define DOCTEST_REQUIRE_LE(...) DOCTEST_BINARY_ASSERT(DT_REQUIRE_LE, le, __VA_ARGS__)
  1801. #define DOCTEST_WARN_UNARY(...) DOCTEST_UNARY_ASSERT(DT_WARN_UNARY, __VA_ARGS__)
  1802. #define DOCTEST_CHECK_UNARY(...) DOCTEST_UNARY_ASSERT(DT_CHECK_UNARY, __VA_ARGS__)
  1803. #define DOCTEST_REQUIRE_UNARY(...) DOCTEST_UNARY_ASSERT(DT_REQUIRE_UNARY, __VA_ARGS__)
  1804. #define DOCTEST_WARN_UNARY_FALSE(...) DOCTEST_UNARY_ASSERT(DT_WARN_UNARY_FALSE, __VA_ARGS__)
  1805. #define DOCTEST_CHECK_UNARY_FALSE(...) DOCTEST_UNARY_ASSERT(DT_CHECK_UNARY_FALSE, __VA_ARGS__)
  1806. #define DOCTEST_REQUIRE_UNARY_FALSE(...) DOCTEST_UNARY_ASSERT(DT_REQUIRE_UNARY_FALSE, __VA_ARGS__)
  1807. #ifdef DOCTEST_CONFIG_NO_EXCEPTIONS
  1808. #undef DOCTEST_WARN_THROWS
  1809. #undef DOCTEST_CHECK_THROWS
  1810. #undef DOCTEST_REQUIRE_THROWS
  1811. #undef DOCTEST_WARN_THROWS_AS
  1812. #undef DOCTEST_CHECK_THROWS_AS
  1813. #undef DOCTEST_REQUIRE_THROWS_AS
  1814. #undef DOCTEST_WARN_THROWS_WITH
  1815. #undef DOCTEST_CHECK_THROWS_WITH
  1816. #undef DOCTEST_REQUIRE_THROWS_WITH
  1817. #undef DOCTEST_WARN_THROWS_WITH_AS
  1818. #undef DOCTEST_CHECK_THROWS_WITH_AS
  1819. #undef DOCTEST_REQUIRE_THROWS_WITH_AS
  1820. #undef DOCTEST_WARN_NOTHROW
  1821. #undef DOCTEST_CHECK_NOTHROW
  1822. #undef DOCTEST_REQUIRE_NOTHROW
  1823. #undef DOCTEST_WARN_THROWS_MESSAGE
  1824. #undef DOCTEST_CHECK_THROWS_MESSAGE
  1825. #undef DOCTEST_REQUIRE_THROWS_MESSAGE
  1826. #undef DOCTEST_WARN_THROWS_AS_MESSAGE
  1827. #undef DOCTEST_CHECK_THROWS_AS_MESSAGE
  1828. #undef DOCTEST_REQUIRE_THROWS_AS_MESSAGE
  1829. #undef DOCTEST_WARN_THROWS_WITH_MESSAGE
  1830. #undef DOCTEST_CHECK_THROWS_WITH_MESSAGE
  1831. #undef DOCTEST_REQUIRE_THROWS_WITH_MESSAGE
  1832. #undef DOCTEST_WARN_THROWS_WITH_AS_MESSAGE
  1833. #undef DOCTEST_CHECK_THROWS_WITH_AS_MESSAGE
  1834. #undef DOCTEST_REQUIRE_THROWS_WITH_AS_MESSAGE
  1835. #undef DOCTEST_WARN_NOTHROW_MESSAGE
  1836. #undef DOCTEST_CHECK_NOTHROW_MESSAGE
  1837. #undef DOCTEST_REQUIRE_NOTHROW_MESSAGE
  1838. #ifdef DOCTEST_CONFIG_NO_EXCEPTIONS_BUT_WITH_ALL_ASSERTS
  1839. #define DOCTEST_WARN_THROWS(expr) ((void)0)
  1840. #define DOCTEST_CHECK_THROWS(expr) ((void)0)
  1841. #define DOCTEST_REQUIRE_THROWS(expr) ((void)0)
  1842. #define DOCTEST_WARN_THROWS_AS(expr, ...) ((void)0)
  1843. #define DOCTEST_CHECK_THROWS_AS(expr, ...) ((void)0)
  1844. #define DOCTEST_REQUIRE_THROWS_AS(expr, ...) ((void)0)
  1845. #define DOCTEST_WARN_THROWS_WITH(expr, ...) ((void)0)
  1846. #define DOCTEST_CHECK_THROWS_WITH(expr, ...) ((void)0)
  1847. #define DOCTEST_REQUIRE_THROWS_WITH(expr, ...) ((void)0)
  1848. #define DOCTEST_WARN_THROWS_WITH_AS(expr, with, ...) ((void)0)
  1849. #define DOCTEST_CHECK_THROWS_WITH_AS(expr, with, ...) ((void)0)
  1850. #define DOCTEST_REQUIRE_THROWS_WITH_AS(expr, with, ...) ((void)0)
  1851. #define DOCTEST_WARN_NOTHROW(expr) ((void)0)
  1852. #define DOCTEST_CHECK_NOTHROW(expr) ((void)0)
  1853. #define DOCTEST_REQUIRE_NOTHROW(expr) ((void)0)
  1854. #define DOCTEST_WARN_THROWS_MESSAGE(expr, msg) ((void)0)
  1855. #define DOCTEST_CHECK_THROWS_MESSAGE(expr, msg) ((void)0)
  1856. #define DOCTEST_REQUIRE_THROWS_MESSAGE(expr, msg) ((void)0)
  1857. #define DOCTEST_WARN_THROWS_AS_MESSAGE(expr, ex, msg) ((void)0)
  1858. #define DOCTEST_CHECK_THROWS_AS_MESSAGE(expr, ex, msg) ((void)0)
  1859. #define DOCTEST_REQUIRE_THROWS_AS_MESSAGE(expr, ex, msg) ((void)0)
  1860. #define DOCTEST_WARN_THROWS_WITH_MESSAGE(expr, with, msg) ((void)0)
  1861. #define DOCTEST_CHECK_THROWS_WITH_MESSAGE(expr, with, msg) ((void)0)
  1862. #define DOCTEST_REQUIRE_THROWS_WITH_MESSAGE(expr, with, msg) ((void)0)
  1863. #define DOCTEST_WARN_THROWS_WITH_AS_MESSAGE(expr, with, ex, msg) ((void)0)
  1864. #define DOCTEST_CHECK_THROWS_WITH_AS_MESSAGE(expr, with, ex, msg) ((void)0)
  1865. #define DOCTEST_REQUIRE_THROWS_WITH_AS_MESSAGE(expr, with, ex, msg) ((void)0)
  1866. #define DOCTEST_WARN_NOTHROW_MESSAGE(expr, msg) ((void)0)
  1867. #define DOCTEST_CHECK_NOTHROW_MESSAGE(expr, msg) ((void)0)
  1868. #define DOCTEST_REQUIRE_NOTHROW_MESSAGE(expr, msg) ((void)0)
  1869. #else // DOCTEST_CONFIG_NO_EXCEPTIONS_BUT_WITH_ALL_ASSERTS
  1870. #undef DOCTEST_REQUIRE
  1871. #undef DOCTEST_REQUIRE_FALSE
  1872. #undef DOCTEST_REQUIRE_MESSAGE
  1873. #undef DOCTEST_REQUIRE_FALSE_MESSAGE
  1874. #undef DOCTEST_REQUIRE_EQ
  1875. #undef DOCTEST_REQUIRE_NE
  1876. #undef DOCTEST_REQUIRE_GT
  1877. #undef DOCTEST_REQUIRE_LT
  1878. #undef DOCTEST_REQUIRE_GE
  1879. #undef DOCTEST_REQUIRE_LE
  1880. #undef DOCTEST_REQUIRE_UNARY
  1881. #undef DOCTEST_REQUIRE_UNARY_FALSE
  1882. #endif // DOCTEST_CONFIG_NO_EXCEPTIONS_BUT_WITH_ALL_ASSERTS
  1883. #endif // DOCTEST_CONFIG_NO_EXCEPTIONS
  1884. // =================================================================================================
  1885. // == WHAT FOLLOWS IS VERSIONS OF THE MACROS THAT DO NOT DO ANY REGISTERING! ==
  1886. // == THIS CAN BE ENABLED BY DEFINING DOCTEST_CONFIG_DISABLE GLOBALLY! ==
  1887. // =================================================================================================
  1888. #else // DOCTEST_CONFIG_DISABLE
  1889. #define DOCTEST_IMPLEMENT_FIXTURE(der, base, func, name) \
  1890. namespace { \
  1891. template <typename DOCTEST_UNUSED_TEMPLATE_TYPE> \
  1892. struct der : public base \
  1893. { void f(); }; \
  1894. } \
  1895. template <typename DOCTEST_UNUSED_TEMPLATE_TYPE> \
  1896. inline void der<DOCTEST_UNUSED_TEMPLATE_TYPE>::f()
  1897. #define DOCTEST_CREATE_AND_REGISTER_FUNCTION(f, name) \
  1898. template <typename DOCTEST_UNUSED_TEMPLATE_TYPE> \
  1899. static inline void f()
  1900. // for registering tests
  1901. #define DOCTEST_TEST_CASE(name) \
  1902. DOCTEST_CREATE_AND_REGISTER_FUNCTION(DOCTEST_ANONYMOUS(_DOCTEST_ANON_FUNC_), name)
  1903. // for registering tests in classes
  1904. #define DOCTEST_TEST_CASE_CLASS(name) \
  1905. DOCTEST_CREATE_AND_REGISTER_FUNCTION(DOCTEST_ANONYMOUS(_DOCTEST_ANON_FUNC_), name)
  1906. // for registering tests with a fixture
  1907. #define DOCTEST_TEST_CASE_FIXTURE(x, name) \
  1908. DOCTEST_IMPLEMENT_FIXTURE(DOCTEST_ANONYMOUS(_DOCTEST_ANON_CLASS_), x, \
  1909. DOCTEST_ANONYMOUS(_DOCTEST_ANON_FUNC_), name)
  1910. // for converting types to strings without the <typeinfo> header and demangling
  1911. #define DOCTEST_TYPE_TO_STRING(...) typedef int DOCTEST_ANONYMOUS(_DOCTEST_ANON_FOR_SEMICOLON_)
  1912. #define DOCTEST_TYPE_TO_STRING_IMPL(...)
  1913. // for typed tests
  1914. #define DOCTEST_TEST_CASE_TEMPLATE(name, type, ...) \
  1915. template <typename type> \
  1916. inline void DOCTEST_ANONYMOUS(_DOCTEST_ANON_TMP_)()
  1917. #define DOCTEST_TEST_CASE_TEMPLATE_DEFINE(name, type, id) \
  1918. template <typename type> \
  1919. inline void DOCTEST_ANONYMOUS(_DOCTEST_ANON_TMP_)()
  1920. #define DOCTEST_TEST_CASE_TEMPLATE_INVOKE(id, ...) \
  1921. typedef int DOCTEST_ANONYMOUS(_DOCTEST_ANON_FOR_SEMICOLON_)
  1922. #define DOCTEST_TEST_CASE_TEMPLATE_APPLY(id, ...) \
  1923. typedef int DOCTEST_ANONYMOUS(_DOCTEST_ANON_FOR_SEMICOLON_)
  1924. // for subcases
  1925. #define DOCTEST_SUBCASE(name)
  1926. // for a testsuite block
  1927. #define DOCTEST_TEST_SUITE(name) namespace
  1928. // for starting a testsuite block
  1929. #define DOCTEST_TEST_SUITE_BEGIN(name) typedef int DOCTEST_ANONYMOUS(_DOCTEST_ANON_FOR_SEMICOLON_)
  1930. // for ending a testsuite block
  1931. #define DOCTEST_TEST_SUITE_END typedef int DOCTEST_ANONYMOUS(_DOCTEST_ANON_FOR_SEMICOLON_)
  1932. #define DOCTEST_REGISTER_EXCEPTION_TRANSLATOR(signature) \
  1933. template <typename DOCTEST_UNUSED_TEMPLATE_TYPE> \
  1934. static inline doctest::String DOCTEST_ANONYMOUS(_DOCTEST_ANON_TRANSLATOR_)(signature)
  1935. #define DOCTEST_REGISTER_REPORTER(name, priority, reporter)
  1936. #define DOCTEST_REGISTER_LISTENER(name, priority, reporter)
  1937. #define DOCTEST_INFO(x) ((void)0)
  1938. #define DOCTEST_CAPTURE(x) ((void)0)
  1939. #define DOCTEST_ADD_MESSAGE_AT(file, line, x) ((void)0)
  1940. #define DOCTEST_ADD_FAIL_CHECK_AT(file, line, x) ((void)0)
  1941. #define DOCTEST_ADD_FAIL_AT(file, line, x) ((void)0)
  1942. #define DOCTEST_MESSAGE(x) ((void)0)
  1943. #define DOCTEST_FAIL_CHECK(x) ((void)0)
  1944. #define DOCTEST_FAIL(x) ((void)0)
  1945. #define DOCTEST_WARN(...) ((void)0)
  1946. #define DOCTEST_CHECK(...) ((void)0)
  1947. #define DOCTEST_REQUIRE(...) ((void)0)
  1948. #define DOCTEST_WARN_FALSE(...) ((void)0)
  1949. #define DOCTEST_CHECK_FALSE(...) ((void)0)
  1950. #define DOCTEST_REQUIRE_FALSE(...) ((void)0)
  1951. #define DOCTEST_WARN_MESSAGE(cond, msg) ((void)0)
  1952. #define DOCTEST_CHECK_MESSAGE(cond, msg) ((void)0)
  1953. #define DOCTEST_REQUIRE_MESSAGE(cond, msg) ((void)0)
  1954. #define DOCTEST_WARN_FALSE_MESSAGE(cond, msg) ((void)0)
  1955. #define DOCTEST_CHECK_FALSE_MESSAGE(cond, msg) ((void)0)
  1956. #define DOCTEST_REQUIRE_FALSE_MESSAGE(cond, msg) ((void)0)
  1957. #define DOCTEST_WARN_THROWS(expr) ((void)0)
  1958. #define DOCTEST_CHECK_THROWS(expr) ((void)0)
  1959. #define DOCTEST_REQUIRE_THROWS(expr) ((void)0)
  1960. #define DOCTEST_WARN_THROWS_AS(expr, ...) ((void)0)
  1961. #define DOCTEST_CHECK_THROWS_AS(expr, ...) ((void)0)
  1962. #define DOCTEST_REQUIRE_THROWS_AS(expr, ...) ((void)0)
  1963. #define DOCTEST_WARN_THROWS_WITH(expr, ...) ((void)0)
  1964. #define DOCTEST_CHECK_THROWS_WITH(expr, ...) ((void)0)
  1965. #define DOCTEST_REQUIRE_THROWS_WITH(expr, ...) ((void)0)
  1966. #define DOCTEST_WARN_THROWS_WITH_AS(expr, with, ...) ((void)0)
  1967. #define DOCTEST_CHECK_THROWS_WITH_AS(expr, with, ...) ((void)0)
  1968. #define DOCTEST_REQUIRE_THROWS_WITH_AS(expr, with, ...) ((void)0)
  1969. #define DOCTEST_WARN_NOTHROW(expr) ((void)0)
  1970. #define DOCTEST_CHECK_NOTHROW(expr) ((void)0)
  1971. #define DOCTEST_REQUIRE_NOTHROW(expr) ((void)0)
  1972. #define DOCTEST_WARN_THROWS_MESSAGE(expr, msg) ((void)0)
  1973. #define DOCTEST_CHECK_THROWS_MESSAGE(expr, msg) ((void)0)
  1974. #define DOCTEST_REQUIRE_THROWS_MESSAGE(expr, msg) ((void)0)
  1975. #define DOCTEST_WARN_THROWS_AS_MESSAGE(expr, ex, msg) ((void)0)
  1976. #define DOCTEST_CHECK_THROWS_AS_MESSAGE(expr, ex, msg) ((void)0)
  1977. #define DOCTEST_REQUIRE_THROWS_AS_MESSAGE(expr, ex, msg) ((void)0)
  1978. #define DOCTEST_WARN_THROWS_WITH_MESSAGE(expr, with, msg) ((void)0)
  1979. #define DOCTEST_CHECK_THROWS_WITH_MESSAGE(expr, with, msg) ((void)0)
  1980. #define DOCTEST_REQUIRE_THROWS_WITH_MESSAGE(expr, with, msg) ((void)0)
  1981. #define DOCTEST_WARN_THROWS_WITH_AS_MESSAGE(expr, with, ex, msg) ((void)0)
  1982. #define DOCTEST_CHECK_THROWS_WITH_AS_MESSAGE(expr, with, ex, msg) ((void)0)
  1983. #define DOCTEST_REQUIRE_THROWS_WITH_AS_MESSAGE(expr, with, ex, msg) ((void)0)
  1984. #define DOCTEST_WARN_NOTHROW_MESSAGE(expr, msg) ((void)0)
  1985. #define DOCTEST_CHECK_NOTHROW_MESSAGE(expr, msg) ((void)0)
  1986. #define DOCTEST_REQUIRE_NOTHROW_MESSAGE(expr, msg) ((void)0)
  1987. #define DOCTEST_WARN_EQ(...) ((void)0)
  1988. #define DOCTEST_CHECK_EQ(...) ((void)0)
  1989. #define DOCTEST_REQUIRE_EQ(...) ((void)0)
  1990. #define DOCTEST_WARN_NE(...) ((void)0)
  1991. #define DOCTEST_CHECK_NE(...) ((void)0)
  1992. #define DOCTEST_REQUIRE_NE(...) ((void)0)
  1993. #define DOCTEST_WARN_GT(...) ((void)0)
  1994. #define DOCTEST_CHECK_GT(...) ((void)0)
  1995. #define DOCTEST_REQUIRE_GT(...) ((void)0)
  1996. #define DOCTEST_WARN_LT(...) ((void)0)
  1997. #define DOCTEST_CHECK_LT(...) ((void)0)
  1998. #define DOCTEST_REQUIRE_LT(...) ((void)0)
  1999. #define DOCTEST_WARN_GE(...) ((void)0)
  2000. #define DOCTEST_CHECK_GE(...) ((void)0)
  2001. #define DOCTEST_REQUIRE_GE(...) ((void)0)
  2002. #define DOCTEST_WARN_LE(...) ((void)0)
  2003. #define DOCTEST_CHECK_LE(...) ((void)0)
  2004. #define DOCTEST_REQUIRE_LE(...) ((void)0)
  2005. #define DOCTEST_WARN_UNARY(...) ((void)0)
  2006. #define DOCTEST_CHECK_UNARY(...) ((void)0)
  2007. #define DOCTEST_REQUIRE_UNARY(...) ((void)0)
  2008. #define DOCTEST_WARN_UNARY_FALSE(...) ((void)0)
  2009. #define DOCTEST_CHECK_UNARY_FALSE(...) ((void)0)
  2010. #define DOCTEST_REQUIRE_UNARY_FALSE(...) ((void)0)
  2011. #endif // DOCTEST_CONFIG_DISABLE
  2012. // clang-format off
  2013. // KEPT FOR BACKWARDS COMPATIBILITY - FORWARDING TO THE RIGHT MACROS
  2014. #define DOCTEST_FAST_WARN_EQ DOCTEST_WARN_EQ
  2015. #define DOCTEST_FAST_CHECK_EQ DOCTEST_CHECK_EQ
  2016. #define DOCTEST_FAST_REQUIRE_EQ DOCTEST_REQUIRE_EQ
  2017. #define DOCTEST_FAST_WARN_NE DOCTEST_WARN_NE
  2018. #define DOCTEST_FAST_CHECK_NE DOCTEST_CHECK_NE
  2019. #define DOCTEST_FAST_REQUIRE_NE DOCTEST_REQUIRE_NE
  2020. #define DOCTEST_FAST_WARN_GT DOCTEST_WARN_GT
  2021. #define DOCTEST_FAST_CHECK_GT DOCTEST_CHECK_GT
  2022. #define DOCTEST_FAST_REQUIRE_GT DOCTEST_REQUIRE_GT
  2023. #define DOCTEST_FAST_WARN_LT DOCTEST_WARN_LT
  2024. #define DOCTEST_FAST_CHECK_LT DOCTEST_CHECK_LT
  2025. #define DOCTEST_FAST_REQUIRE_LT DOCTEST_REQUIRE_LT
  2026. #define DOCTEST_FAST_WARN_GE DOCTEST_WARN_GE
  2027. #define DOCTEST_FAST_CHECK_GE DOCTEST_CHECK_GE
  2028. #define DOCTEST_FAST_REQUIRE_GE DOCTEST_REQUIRE_GE
  2029. #define DOCTEST_FAST_WARN_LE DOCTEST_WARN_LE
  2030. #define DOCTEST_FAST_CHECK_LE DOCTEST_CHECK_LE
  2031. #define DOCTEST_FAST_REQUIRE_LE DOCTEST_REQUIRE_LE
  2032. #define DOCTEST_FAST_WARN_UNARY DOCTEST_WARN_UNARY
  2033. #define DOCTEST_FAST_CHECK_UNARY DOCTEST_CHECK_UNARY
  2034. #define DOCTEST_FAST_REQUIRE_UNARY DOCTEST_REQUIRE_UNARY
  2035. #define DOCTEST_FAST_WARN_UNARY_FALSE DOCTEST_WARN_UNARY_FALSE
  2036. #define DOCTEST_FAST_CHECK_UNARY_FALSE DOCTEST_CHECK_UNARY_FALSE
  2037. #define DOCTEST_FAST_REQUIRE_UNARY_FALSE DOCTEST_REQUIRE_UNARY_FALSE
  2038. #define DOCTEST_TEST_CASE_TEMPLATE_INSTANTIATE DOCTEST_TEST_CASE_TEMPLATE_INVOKE
  2039. // clang-format on
  2040. // BDD style macros
  2041. // clang-format off
  2042. #define DOCTEST_SCENARIO(name) DOCTEST_TEST_CASE(" Scenario: " name)
  2043. #define DOCTEST_SCENARIO_CLASS(name) DOCTEST_TEST_CASE_CLASS(" Scenario: " name)
  2044. #define DOCTEST_SCENARIO_TEMPLATE(name, T, ...) DOCTEST_TEST_CASE_TEMPLATE(" Scenario: " name, T, __VA_ARGS__)
  2045. #define DOCTEST_SCENARIO_TEMPLATE_DEFINE(name, T, id) DOCTEST_TEST_CASE_TEMPLATE_DEFINE(" Scenario: " name, T, id)
  2046. #define DOCTEST_GIVEN(name) DOCTEST_SUBCASE(" Given: " name)
  2047. #define DOCTEST_WHEN(name) DOCTEST_SUBCASE(" When: " name)
  2048. #define DOCTEST_AND_WHEN(name) DOCTEST_SUBCASE("And when: " name)
  2049. #define DOCTEST_THEN(name) DOCTEST_SUBCASE(" Then: " name)
  2050. #define DOCTEST_AND_THEN(name) DOCTEST_SUBCASE(" And: " name)
  2051. // clang-format on
  2052. // == SHORT VERSIONS OF THE MACROS
  2053. #if !defined(DOCTEST_CONFIG_NO_SHORT_MACRO_NAMES)
  2054. #define TEST_CASE DOCTEST_TEST_CASE
  2055. #define TEST_CASE_CLASS DOCTEST_TEST_CASE_CLASS
  2056. #define TEST_CASE_FIXTURE DOCTEST_TEST_CASE_FIXTURE
  2057. #define TYPE_TO_STRING DOCTEST_TYPE_TO_STRING
  2058. #define TEST_CASE_TEMPLATE DOCTEST_TEST_CASE_TEMPLATE
  2059. #define TEST_CASE_TEMPLATE_DEFINE DOCTEST_TEST_CASE_TEMPLATE_DEFINE
  2060. #define TEST_CASE_TEMPLATE_INVOKE DOCTEST_TEST_CASE_TEMPLATE_INVOKE
  2061. #define TEST_CASE_TEMPLATE_APPLY DOCTEST_TEST_CASE_TEMPLATE_APPLY
  2062. #define SUBCASE DOCTEST_SUBCASE
  2063. #define TEST_SUITE DOCTEST_TEST_SUITE
  2064. #define TEST_SUITE_BEGIN DOCTEST_TEST_SUITE_BEGIN
  2065. #define TEST_SUITE_END DOCTEST_TEST_SUITE_END
  2066. #define REGISTER_EXCEPTION_TRANSLATOR DOCTEST_REGISTER_EXCEPTION_TRANSLATOR
  2067. #define REGISTER_REPORTER DOCTEST_REGISTER_REPORTER
  2068. #define REGISTER_LISTENER DOCTEST_REGISTER_LISTENER
  2069. #define INFO DOCTEST_INFO
  2070. #define CAPTURE DOCTEST_CAPTURE
  2071. #define ADD_MESSAGE_AT DOCTEST_ADD_MESSAGE_AT
  2072. #define ADD_FAIL_CHECK_AT DOCTEST_ADD_FAIL_CHECK_AT
  2073. #define ADD_FAIL_AT DOCTEST_ADD_FAIL_AT
  2074. #define MESSAGE DOCTEST_MESSAGE
  2075. #define FAIL_CHECK DOCTEST_FAIL_CHECK
  2076. #define FAIL DOCTEST_FAIL
  2077. #define TO_LVALUE DOCTEST_TO_LVALUE
  2078. #define WARN DOCTEST_WARN
  2079. #define WARN_FALSE DOCTEST_WARN_FALSE
  2080. #define WARN_THROWS DOCTEST_WARN_THROWS
  2081. #define WARN_THROWS_AS DOCTEST_WARN_THROWS_AS
  2082. #define WARN_THROWS_WITH DOCTEST_WARN_THROWS_WITH
  2083. #define WARN_THROWS_WITH_AS DOCTEST_WARN_THROWS_WITH_AS
  2084. #define WARN_NOTHROW DOCTEST_WARN_NOTHROW
  2085. #define CHECK DOCTEST_CHECK
  2086. #define CHECK_FALSE DOCTEST_CHECK_FALSE
  2087. #define CHECK_THROWS DOCTEST_CHECK_THROWS
  2088. #define CHECK_THROWS_AS DOCTEST_CHECK_THROWS_AS
  2089. #define CHECK_THROWS_WITH DOCTEST_CHECK_THROWS_WITH
  2090. #define CHECK_THROWS_WITH_AS DOCTEST_CHECK_THROWS_WITH_AS
  2091. #define CHECK_NOTHROW DOCTEST_CHECK_NOTHROW
  2092. #define REQUIRE DOCTEST_REQUIRE
  2093. #define REQUIRE_FALSE DOCTEST_REQUIRE_FALSE
  2094. #define REQUIRE_THROWS DOCTEST_REQUIRE_THROWS
  2095. #define REQUIRE_THROWS_AS DOCTEST_REQUIRE_THROWS_AS
  2096. #define REQUIRE_THROWS_WITH DOCTEST_REQUIRE_THROWS_WITH
  2097. #define REQUIRE_THROWS_WITH_AS DOCTEST_REQUIRE_THROWS_WITH_AS
  2098. #define REQUIRE_NOTHROW DOCTEST_REQUIRE_NOTHROW
  2099. #define WARN_MESSAGE DOCTEST_WARN_MESSAGE
  2100. #define WARN_FALSE_MESSAGE DOCTEST_WARN_FALSE_MESSAGE
  2101. #define WARN_THROWS_MESSAGE DOCTEST_WARN_THROWS_MESSAGE
  2102. #define WARN_THROWS_AS_MESSAGE DOCTEST_WARN_THROWS_AS_MESSAGE
  2103. #define WARN_THROWS_WITH_MESSAGE DOCTEST_WARN_THROWS_WITH_MESSAGE
  2104. #define WARN_THROWS_WITH_AS_MESSAGE DOCTEST_WARN_THROWS_WITH_AS_MESSAGE
  2105. #define WARN_NOTHROW_MESSAGE DOCTEST_WARN_NOTHROW_MESSAGE
  2106. #define CHECK_MESSAGE DOCTEST_CHECK_MESSAGE
  2107. #define CHECK_FALSE_MESSAGE DOCTEST_CHECK_FALSE_MESSAGE
  2108. #define CHECK_THROWS_MESSAGE DOCTEST_CHECK_THROWS_MESSAGE
  2109. #define CHECK_THROWS_AS_MESSAGE DOCTEST_CHECK_THROWS_AS_MESSAGE
  2110. #define CHECK_THROWS_WITH_MESSAGE DOCTEST_CHECK_THROWS_WITH_MESSAGE
  2111. #define CHECK_THROWS_WITH_AS_MESSAGE DOCTEST_CHECK_THROWS_WITH_AS_MESSAGE
  2112. #define CHECK_NOTHROW_MESSAGE DOCTEST_CHECK_NOTHROW_MESSAGE
  2113. #define REQUIRE_MESSAGE DOCTEST_REQUIRE_MESSAGE
  2114. #define REQUIRE_FALSE_MESSAGE DOCTEST_REQUIRE_FALSE_MESSAGE
  2115. #define REQUIRE_THROWS_MESSAGE DOCTEST_REQUIRE_THROWS_MESSAGE
  2116. #define REQUIRE_THROWS_AS_MESSAGE DOCTEST_REQUIRE_THROWS_AS_MESSAGE
  2117. #define REQUIRE_THROWS_WITH_MESSAGE DOCTEST_REQUIRE_THROWS_WITH_MESSAGE
  2118. #define REQUIRE_THROWS_WITH_AS_MESSAGE DOCTEST_REQUIRE_THROWS_WITH_AS_MESSAGE
  2119. #define REQUIRE_NOTHROW_MESSAGE DOCTEST_REQUIRE_NOTHROW_MESSAGE
  2120. #define SCENARIO DOCTEST_SCENARIO
  2121. #define SCENARIO_CLASS DOCTEST_SCENARIO_CLASS
  2122. #define SCENARIO_TEMPLATE DOCTEST_SCENARIO_TEMPLATE
  2123. #define SCENARIO_TEMPLATE_DEFINE DOCTEST_SCENARIO_TEMPLATE_DEFINE
  2124. #define GIVEN DOCTEST_GIVEN
  2125. #define WHEN DOCTEST_WHEN
  2126. #define AND_WHEN DOCTEST_AND_WHEN
  2127. #define THEN DOCTEST_THEN
  2128. #define AND_THEN DOCTEST_AND_THEN
  2129. #define WARN_EQ DOCTEST_WARN_EQ
  2130. #define CHECK_EQ DOCTEST_CHECK_EQ
  2131. #define REQUIRE_EQ DOCTEST_REQUIRE_EQ
  2132. #define WARN_NE DOCTEST_WARN_NE
  2133. #define CHECK_NE DOCTEST_CHECK_NE
  2134. #define REQUIRE_NE DOCTEST_REQUIRE_NE
  2135. #define WARN_GT DOCTEST_WARN_GT
  2136. #define CHECK_GT DOCTEST_CHECK_GT
  2137. #define REQUIRE_GT DOCTEST_REQUIRE_GT
  2138. #define WARN_LT DOCTEST_WARN_LT
  2139. #define CHECK_LT DOCTEST_CHECK_LT
  2140. #define REQUIRE_LT DOCTEST_REQUIRE_LT
  2141. #define WARN_GE DOCTEST_WARN_GE
  2142. #define CHECK_GE DOCTEST_CHECK_GE
  2143. #define REQUIRE_GE DOCTEST_REQUIRE_GE
  2144. #define WARN_LE DOCTEST_WARN_LE
  2145. #define CHECK_LE DOCTEST_CHECK_LE
  2146. #define REQUIRE_LE DOCTEST_REQUIRE_LE
  2147. #define WARN_UNARY DOCTEST_WARN_UNARY
  2148. #define CHECK_UNARY DOCTEST_CHECK_UNARY
  2149. #define REQUIRE_UNARY DOCTEST_REQUIRE_UNARY
  2150. #define WARN_UNARY_FALSE DOCTEST_WARN_UNARY_FALSE
  2151. #define CHECK_UNARY_FALSE DOCTEST_CHECK_UNARY_FALSE
  2152. #define REQUIRE_UNARY_FALSE DOCTEST_REQUIRE_UNARY_FALSE
  2153. // KEPT FOR BACKWARDS COMPATIBILITY
  2154. #define FAST_WARN_EQ DOCTEST_FAST_WARN_EQ
  2155. #define FAST_CHECK_EQ DOCTEST_FAST_CHECK_EQ
  2156. #define FAST_REQUIRE_EQ DOCTEST_FAST_REQUIRE_EQ
  2157. #define FAST_WARN_NE DOCTEST_FAST_WARN_NE
  2158. #define FAST_CHECK_NE DOCTEST_FAST_CHECK_NE
  2159. #define FAST_REQUIRE_NE DOCTEST_FAST_REQUIRE_NE
  2160. #define FAST_WARN_GT DOCTEST_FAST_WARN_GT
  2161. #define FAST_CHECK_GT DOCTEST_FAST_CHECK_GT
  2162. #define FAST_REQUIRE_GT DOCTEST_FAST_REQUIRE_GT
  2163. #define FAST_WARN_LT DOCTEST_FAST_WARN_LT
  2164. #define FAST_CHECK_LT DOCTEST_FAST_CHECK_LT
  2165. #define FAST_REQUIRE_LT DOCTEST_FAST_REQUIRE_LT
  2166. #define FAST_WARN_GE DOCTEST_FAST_WARN_GE
  2167. #define FAST_CHECK_GE DOCTEST_FAST_CHECK_GE
  2168. #define FAST_REQUIRE_GE DOCTEST_FAST_REQUIRE_GE
  2169. #define FAST_WARN_LE DOCTEST_FAST_WARN_LE
  2170. #define FAST_CHECK_LE DOCTEST_FAST_CHECK_LE
  2171. #define FAST_REQUIRE_LE DOCTEST_FAST_REQUIRE_LE
  2172. #define FAST_WARN_UNARY DOCTEST_FAST_WARN_UNARY
  2173. #define FAST_CHECK_UNARY DOCTEST_FAST_CHECK_UNARY
  2174. #define FAST_REQUIRE_UNARY DOCTEST_FAST_REQUIRE_UNARY
  2175. #define FAST_WARN_UNARY_FALSE DOCTEST_FAST_WARN_UNARY_FALSE
  2176. #define FAST_CHECK_UNARY_FALSE DOCTEST_FAST_CHECK_UNARY_FALSE
  2177. #define FAST_REQUIRE_UNARY_FALSE DOCTEST_FAST_REQUIRE_UNARY_FALSE
  2178. #define TEST_CASE_TEMPLATE_INSTANTIATE DOCTEST_TEST_CASE_TEMPLATE_INSTANTIATE
  2179. #endif // DOCTEST_CONFIG_NO_SHORT_MACRO_NAMES
  2180. #if !defined(DOCTEST_CONFIG_DISABLE)
  2181. // this is here to clear the 'current test suite' for the current translation unit - at the top
  2182. DOCTEST_TEST_SUITE_END();
  2183. // add stringification for primitive/fundamental types
  2184. namespace doctest { namespace detail {
  2185. DOCTEST_TYPE_TO_STRING_IMPL(bool)
  2186. DOCTEST_TYPE_TO_STRING_IMPL(float)
  2187. DOCTEST_TYPE_TO_STRING_IMPL(double)
  2188. DOCTEST_TYPE_TO_STRING_IMPL(long double)
  2189. DOCTEST_TYPE_TO_STRING_IMPL(char)
  2190. DOCTEST_TYPE_TO_STRING_IMPL(signed char)
  2191. DOCTEST_TYPE_TO_STRING_IMPL(unsigned char)
  2192. #if !DOCTEST_MSVC || defined(_NATIVE_WCHAR_T_DEFINED)
  2193. DOCTEST_TYPE_TO_STRING_IMPL(wchar_t)
  2194. #endif // not MSVC or wchar_t support enabled
  2195. DOCTEST_TYPE_TO_STRING_IMPL(short int)
  2196. DOCTEST_TYPE_TO_STRING_IMPL(unsigned short int)
  2197. DOCTEST_TYPE_TO_STRING_IMPL(int)
  2198. DOCTEST_TYPE_TO_STRING_IMPL(unsigned int)
  2199. DOCTEST_TYPE_TO_STRING_IMPL(long int)
  2200. DOCTEST_TYPE_TO_STRING_IMPL(unsigned long int)
  2201. DOCTEST_TYPE_TO_STRING_IMPL(long long int)
  2202. DOCTEST_TYPE_TO_STRING_IMPL(unsigned long long int)
  2203. }} // namespace doctest::detail
  2204. #endif // DOCTEST_CONFIG_DISABLE
  2205. DOCTEST_CLANG_SUPPRESS_WARNING_POP
  2206. DOCTEST_MSVC_SUPPRESS_WARNING_POP
  2207. DOCTEST_GCC_SUPPRESS_WARNING_POP
  2208. #endif // DOCTEST_LIBRARY_INCLUDED
  2209. #ifndef DOCTEST_SINGLE_HEADER
  2210. #define DOCTEST_SINGLE_HEADER
  2211. #endif // DOCTEST_SINGLE_HEADER
  2212. #if defined(DOCTEST_CONFIG_IMPLEMENT) || !defined(DOCTEST_SINGLE_HEADER)
  2213. #ifndef DOCTEST_SINGLE_HEADER
  2214. #include "doctest_fwd.h"
  2215. #endif // DOCTEST_SINGLE_HEADER
  2216. DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH("-Wunused-macros")
  2217. #ifndef DOCTEST_LIBRARY_IMPLEMENTATION
  2218. #define DOCTEST_LIBRARY_IMPLEMENTATION
  2219. DOCTEST_CLANG_SUPPRESS_WARNING_POP
  2220. DOCTEST_CLANG_SUPPRESS_WARNING_PUSH
  2221. DOCTEST_CLANG_SUPPRESS_WARNING("-Wunknown-pragmas")
  2222. DOCTEST_CLANG_SUPPRESS_WARNING("-Wpadded")
  2223. DOCTEST_CLANG_SUPPRESS_WARNING("-Wweak-vtables")
  2224. DOCTEST_CLANG_SUPPRESS_WARNING("-Wglobal-constructors")
  2225. DOCTEST_CLANG_SUPPRESS_WARNING("-Wexit-time-destructors")
  2226. DOCTEST_CLANG_SUPPRESS_WARNING("-Wmissing-prototypes")
  2227. DOCTEST_CLANG_SUPPRESS_WARNING("-Wsign-conversion")
  2228. DOCTEST_CLANG_SUPPRESS_WARNING("-Wshorten-64-to-32")
  2229. DOCTEST_CLANG_SUPPRESS_WARNING("-Wmissing-variable-declarations")
  2230. DOCTEST_CLANG_SUPPRESS_WARNING("-Wswitch")
  2231. DOCTEST_CLANG_SUPPRESS_WARNING("-Wswitch-enum")
  2232. DOCTEST_CLANG_SUPPRESS_WARNING("-Wcovered-switch-default")
  2233. DOCTEST_CLANG_SUPPRESS_WARNING("-Wmissing-noreturn")
  2234. DOCTEST_CLANG_SUPPRESS_WARNING("-Wunused-local-typedef")
  2235. DOCTEST_CLANG_SUPPRESS_WARNING("-Wdisabled-macro-expansion")
  2236. DOCTEST_CLANG_SUPPRESS_WARNING("-Wmissing-braces")
  2237. DOCTEST_CLANG_SUPPRESS_WARNING("-Wmissing-field-initializers")
  2238. DOCTEST_CLANG_SUPPRESS_WARNING("-Wc++98-compat")
  2239. DOCTEST_CLANG_SUPPRESS_WARNING("-Wc++98-compat-pedantic")
  2240. DOCTEST_CLANG_SUPPRESS_WARNING("-Wunused-member-function")
  2241. DOCTEST_GCC_SUPPRESS_WARNING_PUSH
  2242. DOCTEST_GCC_SUPPRESS_WARNING("-Wunknown-pragmas")
  2243. DOCTEST_GCC_SUPPRESS_WARNING("-Wpragmas")
  2244. DOCTEST_GCC_SUPPRESS_WARNING("-Wconversion")
  2245. DOCTEST_GCC_SUPPRESS_WARNING("-Weffc++")
  2246. DOCTEST_GCC_SUPPRESS_WARNING("-Wsign-conversion")
  2247. DOCTEST_GCC_SUPPRESS_WARNING("-Wstrict-overflow")
  2248. DOCTEST_GCC_SUPPRESS_WARNING("-Wstrict-aliasing")
  2249. DOCTEST_GCC_SUPPRESS_WARNING("-Wmissing-field-initializers")
  2250. DOCTEST_GCC_SUPPRESS_WARNING("-Wmissing-braces")
  2251. DOCTEST_GCC_SUPPRESS_WARNING("-Wmissing-declarations")
  2252. DOCTEST_GCC_SUPPRESS_WARNING("-Winline")
  2253. DOCTEST_GCC_SUPPRESS_WARNING("-Wswitch")
  2254. DOCTEST_GCC_SUPPRESS_WARNING("-Wswitch-enum")
  2255. DOCTEST_GCC_SUPPRESS_WARNING("-Wswitch-default")
  2256. DOCTEST_GCC_SUPPRESS_WARNING("-Wunsafe-loop-optimizations")
  2257. DOCTEST_GCC_SUPPRESS_WARNING("-Wold-style-cast")
  2258. DOCTEST_GCC_SUPPRESS_WARNING("-Wunused-local-typedefs")
  2259. DOCTEST_GCC_SUPPRESS_WARNING("-Wuseless-cast")
  2260. DOCTEST_GCC_SUPPRESS_WARNING("-Wunused-function")
  2261. DOCTEST_GCC_SUPPRESS_WARNING("-Wmultiple-inheritance")
  2262. DOCTEST_GCC_SUPPRESS_WARNING("-Wnoexcept")
  2263. DOCTEST_GCC_SUPPRESS_WARNING("-Wsuggest-attribute")
  2264. DOCTEST_MSVC_SUPPRESS_WARNING_PUSH
  2265. DOCTEST_MSVC_SUPPRESS_WARNING(4616) // invalid compiler warning
  2266. DOCTEST_MSVC_SUPPRESS_WARNING(4619) // invalid compiler warning
  2267. DOCTEST_MSVC_SUPPRESS_WARNING(4996) // The compiler encountered a deprecated declaration
  2268. DOCTEST_MSVC_SUPPRESS_WARNING(4267) // 'var' : conversion from 'x' to 'y', possible loss of data
  2269. DOCTEST_MSVC_SUPPRESS_WARNING(4706) // assignment within conditional expression
  2270. DOCTEST_MSVC_SUPPRESS_WARNING(4512) // 'class' : assignment operator could not be generated
  2271. DOCTEST_MSVC_SUPPRESS_WARNING(4127) // conditional expression is constant
  2272. DOCTEST_MSVC_SUPPRESS_WARNING(4530) // C++ exception handler used, but unwind semantics not enabled
  2273. DOCTEST_MSVC_SUPPRESS_WARNING(4577) // 'noexcept' used with no exception handling mode specified
  2274. DOCTEST_MSVC_SUPPRESS_WARNING(4774) // format string expected in argument is not a string literal
  2275. DOCTEST_MSVC_SUPPRESS_WARNING(4365) // conversion from 'int' to 'unsigned', signed/unsigned mismatch
  2276. DOCTEST_MSVC_SUPPRESS_WARNING(4820) // padding in structs
  2277. DOCTEST_MSVC_SUPPRESS_WARNING(4640) // construction of local static object is not thread-safe
  2278. DOCTEST_MSVC_SUPPRESS_WARNING(5039) // pointer to potentially throwing function passed to extern C
  2279. DOCTEST_MSVC_SUPPRESS_WARNING(5045) // Spectre mitigation stuff
  2280. DOCTEST_MSVC_SUPPRESS_WARNING(4626) // assignment operator was implicitly defined as deleted
  2281. DOCTEST_MSVC_SUPPRESS_WARNING(5027) // move assignment operator was implicitly defined as deleted
  2282. DOCTEST_MSVC_SUPPRESS_WARNING(5026) // move constructor was implicitly defined as deleted
  2283. DOCTEST_MSVC_SUPPRESS_WARNING(4625) // copy constructor was implicitly defined as deleted
  2284. DOCTEST_MSVC_SUPPRESS_WARNING(4800) // forcing value to bool 'true' or 'false' (performance warning)
  2285. // static analysis
  2286. DOCTEST_MSVC_SUPPRESS_WARNING(26439) // This kind of function may not throw. Declare it 'noexcept'
  2287. DOCTEST_MSVC_SUPPRESS_WARNING(26495) // Always initialize a member variable
  2288. DOCTEST_MSVC_SUPPRESS_WARNING(26451) // Arithmetic overflow ...
  2289. DOCTEST_MSVC_SUPPRESS_WARNING(26444) // Avoid unnamed objects with custom construction and dtor...
  2290. DOCTEST_MAKE_STD_HEADERS_CLEAN_FROM_WARNINGS_ON_WALL_BEGIN
  2291. // required includes - will go only in one translation unit!
  2292. #include <ctime>
  2293. #include <cmath>
  2294. #include <climits>
  2295. // borland (Embarcadero) compiler requires math.h and not cmath - https://github.com/onqtam/doctest/pull/37
  2296. #ifdef __BORLANDC__
  2297. #include <math.h>
  2298. #endif // __BORLANDC__
  2299. #include <new>
  2300. #include <cstdio>
  2301. #include <cstdlib>
  2302. #include <cstring>
  2303. #include <limits>
  2304. #include <utility>
  2305. #include <fstream>
  2306. #include <sstream>
  2307. #include <iostream>
  2308. #include <algorithm>
  2309. #include <iomanip>
  2310. #include <vector>
  2311. #include <atomic>
  2312. #include <mutex>
  2313. #include <set>
  2314. #include <map>
  2315. #include <exception>
  2316. #include <stdexcept>
  2317. #ifdef DOCTEST_CONFIG_POSIX_SIGNALS
  2318. #include <csignal>
  2319. #endif // DOCTEST_CONFIG_POSIX_SIGNALS
  2320. #include <cfloat>
  2321. #include <cctype>
  2322. #include <cstdint>
  2323. #ifdef DOCTEST_PLATFORM_MAC
  2324. #include <sys/types.h>
  2325. #include <unistd.h>
  2326. #include <sys/sysctl.h>
  2327. #endif // DOCTEST_PLATFORM_MAC
  2328. #ifdef DOCTEST_PLATFORM_WINDOWS
  2329. // defines for a leaner windows.h
  2330. #ifndef WIN32_LEAN_AND_MEAN
  2331. #define WIN32_LEAN_AND_MEAN
  2332. #endif // WIN32_LEAN_AND_MEAN
  2333. #ifndef NOMINMAX
  2334. #define NOMINMAX
  2335. #endif // NOMINMAX
  2336. // not sure what AfxWin.h is for - here I do what Catch does
  2337. #ifdef __AFXDLL
  2338. #include <AfxWin.h>
  2339. #else
  2340. #include <Windows.h>
  2341. #endif
  2342. #include <io.h>
  2343. #else // DOCTEST_PLATFORM_WINDOWS
  2344. #include <sys/time.h>
  2345. #include <unistd.h>
  2346. #endif // DOCTEST_PLATFORM_WINDOWS
  2347. DOCTEST_MAKE_STD_HEADERS_CLEAN_FROM_WARNINGS_ON_WALL_END
  2348. // counts the number of elements in a C array
  2349. #define DOCTEST_COUNTOF(x) (sizeof(x) / sizeof(x[0]))
  2350. #ifdef DOCTEST_CONFIG_DISABLE
  2351. #define DOCTEST_BRANCH_ON_DISABLED(if_disabled, if_not_disabled) if_disabled
  2352. #else // DOCTEST_CONFIG_DISABLE
  2353. #define DOCTEST_BRANCH_ON_DISABLED(if_disabled, if_not_disabled) if_not_disabled
  2354. #endif // DOCTEST_CONFIG_DISABLE
  2355. #ifndef DOCTEST_CONFIG_OPTIONS_PREFIX
  2356. #define DOCTEST_CONFIG_OPTIONS_PREFIX "dt-"
  2357. #endif
  2358. #ifndef DOCTEST_THREAD_LOCAL
  2359. #define DOCTEST_THREAD_LOCAL thread_local
  2360. #endif
  2361. #ifdef DOCTEST_CONFIG_NO_UNPREFIXED_OPTIONS
  2362. #define DOCTEST_OPTIONS_PREFIX_DISPLAY DOCTEST_CONFIG_OPTIONS_PREFIX
  2363. #else
  2364. #define DOCTEST_OPTIONS_PREFIX_DISPLAY ""
  2365. #endif
  2366. namespace doctest {
  2367. bool is_running_in_test = false;
  2368. namespace {
  2369. using namespace detail;
  2370. // case insensitive strcmp
  2371. int stricmp(const char* a, const char* b) {
  2372. for(;; a++, b++) {
  2373. const int d = tolower(*a) - tolower(*b);
  2374. if(d != 0 || !*a)
  2375. return d;
  2376. }
  2377. }
  2378. template <typename T>
  2379. String fpToString(T value, int precision) {
  2380. std::ostringstream oss;
  2381. oss << std::setprecision(precision) << std::fixed << value;
  2382. std::string d = oss.str();
  2383. size_t i = d.find_last_not_of('0');
  2384. if(i != std::string::npos && i != d.size() - 1) {
  2385. if(d[i] == '.')
  2386. i++;
  2387. d = d.substr(0, i + 1);
  2388. }
  2389. return d.c_str();
  2390. }
  2391. struct Endianness
  2392. {
  2393. enum Arch
  2394. {
  2395. Big,
  2396. Little
  2397. };
  2398. static Arch which() {
  2399. int x = 1;
  2400. // casting any data pointer to char* is allowed
  2401. auto ptr = reinterpret_cast<char*>(&x);
  2402. if(*ptr)
  2403. return Little;
  2404. return Big;
  2405. }
  2406. };
  2407. } // namespace
  2408. namespace detail {
  2409. void my_memcpy(void* dest, const void* src, unsigned num) { memcpy(dest, src, num); }
  2410. String rawMemoryToString(const void* object, unsigned size) {
  2411. // Reverse order for little endian architectures
  2412. int i = 0, end = static_cast<int>(size), inc = 1;
  2413. if(Endianness::which() == Endianness::Little) {
  2414. i = end - 1;
  2415. end = inc = -1;
  2416. }
  2417. unsigned const char* bytes = static_cast<unsigned const char*>(object);
  2418. std::ostringstream oss;
  2419. oss << "0x" << std::setfill('0') << std::hex;
  2420. for(; i != end; i += inc)
  2421. oss << std::setw(2) << static_cast<unsigned>(bytes[i]);
  2422. return oss.str().c_str();
  2423. }
  2424. DOCTEST_THREAD_LOCAL std::ostringstream g_oss; // NOLINT(cert-err58-cpp)
  2425. std::ostream* getTlsOss() {
  2426. g_oss.clear(); // there shouldn't be anything worth clearing in the flags
  2427. g_oss.str(""); // the slow way of resetting a string stream
  2428. //g_oss.seekp(0); // optimal reset - as seen here: https://stackoverflow.com/a/624291/3162383
  2429. return &g_oss;
  2430. }
  2431. String getTlsOssResult() {
  2432. //g_oss << std::ends; // needed - as shown here: https://stackoverflow.com/a/624291/3162383
  2433. return g_oss.str().c_str();
  2434. }
  2435. #ifndef DOCTEST_CONFIG_DISABLE
  2436. typedef uint64_t UInt64;
  2437. #ifdef DOCTEST_CONFIG_GETCURRENTTICKS
  2438. UInt64 getCurrentTicks() { return DOCTEST_CONFIG_GETCURRENTTICKS(); }
  2439. #elif defined(DOCTEST_PLATFORM_WINDOWS)
  2440. UInt64 getCurrentTicks() {
  2441. static UInt64 hz = 0, hzo = 0;
  2442. if(!hz) {
  2443. QueryPerformanceFrequency(reinterpret_cast<LARGE_INTEGER*>(&hz));
  2444. QueryPerformanceCounter(reinterpret_cast<LARGE_INTEGER*>(&hzo));
  2445. }
  2446. UInt64 t;
  2447. QueryPerformanceCounter(reinterpret_cast<LARGE_INTEGER*>(&t));
  2448. return ((t - hzo) * 1000000) / hz;
  2449. }
  2450. #else // DOCTEST_PLATFORM_WINDOWS
  2451. UInt64 getCurrentTicks() {
  2452. timeval t;
  2453. gettimeofday(&t, nullptr);
  2454. return static_cast<UInt64>(t.tv_sec) * 1000000 + static_cast<UInt64>(t.tv_usec);
  2455. }
  2456. #endif // DOCTEST_PLATFORM_WINDOWS
  2457. struct Timer
  2458. {
  2459. void start() { m_ticks = getCurrentTicks(); }
  2460. unsigned int getElapsedMicroseconds() const {
  2461. return static_cast<unsigned int>(getCurrentTicks() - m_ticks);
  2462. }
  2463. //unsigned int getElapsedMilliseconds() const {
  2464. // return static_cast<unsigned int>(getElapsedMicroseconds() / 1000);
  2465. //}
  2466. double getElapsedSeconds() const { return getElapsedMicroseconds() / 1000000.0; }
  2467. private:
  2468. UInt64 m_ticks = 0;
  2469. };
  2470. // this holds both parameters from the command line and runtime data for tests
  2471. struct ContextState : ContextOptions, TestRunStats, CurrentTestCaseStats
  2472. {
  2473. std::atomic<int> numAssertsCurrentTest_atomic;
  2474. std::atomic<int> numAssertsFailedCurrentTest_atomic;
  2475. std::vector<std::vector<String>> filters = decltype(filters)(9); // 9 different filters
  2476. std::vector<IReporter*> reporters_currently_used;
  2477. const TestCase* currentTest = nullptr;
  2478. assert_handler ah = nullptr;
  2479. Timer timer;
  2480. std::vector<String> stringifiedContexts; // logging from INFO() due to an exception
  2481. // stuff for subcases
  2482. std::vector<SubcaseSignature> subcasesStack;
  2483. std::set<decltype(subcasesStack)> subcasesPassed;
  2484. int subcasesCurrentMaxLevel;
  2485. bool should_reenter;
  2486. std::atomic<bool> shouldLogCurrentException;
  2487. void resetRunData() {
  2488. numTestCases = 0;
  2489. numTestCasesPassingFilters = 0;
  2490. numTestSuitesPassingFilters = 0;
  2491. numTestCasesFailed = 0;
  2492. numAsserts = 0;
  2493. numAssertsFailed = 0;
  2494. numAssertsCurrentTest = 0;
  2495. numAssertsFailedCurrentTest = 0;
  2496. }
  2497. void finalizeTestCaseData() {
  2498. seconds = timer.getElapsedSeconds();
  2499. // update the non-atomic counters
  2500. numAsserts += numAssertsCurrentTest_atomic;
  2501. numAssertsFailed += numAssertsFailedCurrentTest_atomic;
  2502. numAssertsCurrentTest = numAssertsCurrentTest_atomic;
  2503. numAssertsFailedCurrentTest = numAssertsFailedCurrentTest_atomic;
  2504. if(numAssertsFailedCurrentTest)
  2505. failure_flags |= TestCaseFailureReason::AssertFailure;
  2506. if(Approx(currentTest->m_timeout).epsilon(DBL_EPSILON) != 0 &&
  2507. Approx(seconds).epsilon(DBL_EPSILON) > currentTest->m_timeout)
  2508. failure_flags |= TestCaseFailureReason::Timeout;
  2509. if(currentTest->m_should_fail) {
  2510. if(failure_flags) {
  2511. failure_flags |= TestCaseFailureReason::ShouldHaveFailedAndDid;
  2512. } else {
  2513. failure_flags |= TestCaseFailureReason::ShouldHaveFailedButDidnt;
  2514. }
  2515. } else if(failure_flags && currentTest->m_may_fail) {
  2516. failure_flags |= TestCaseFailureReason::CouldHaveFailedAndDid;
  2517. } else if(currentTest->m_expected_failures > 0) {
  2518. if(numAssertsFailedCurrentTest == currentTest->m_expected_failures) {
  2519. failure_flags |= TestCaseFailureReason::FailedExactlyNumTimes;
  2520. } else {
  2521. failure_flags |= TestCaseFailureReason::DidntFailExactlyNumTimes;
  2522. }
  2523. }
  2524. bool ok_to_fail = (TestCaseFailureReason::ShouldHaveFailedAndDid & failure_flags) ||
  2525. (TestCaseFailureReason::CouldHaveFailedAndDid & failure_flags) ||
  2526. (TestCaseFailureReason::FailedExactlyNumTimes & failure_flags);
  2527. // if any subcase has failed - the whole test case has failed
  2528. if(failure_flags && !ok_to_fail)
  2529. numTestCasesFailed++;
  2530. }
  2531. };
  2532. ContextState* g_cs = nullptr;
  2533. // used to avoid locks for the debug output
  2534. // TODO: figure out if this is indeed necessary/correct - seems like either there still
  2535. // could be a race or that there wouldn't be a race even if using the context directly
  2536. DOCTEST_THREAD_LOCAL bool g_no_colors;
  2537. #endif // DOCTEST_CONFIG_DISABLE
  2538. } // namespace detail
  2539. void String::setOnHeap() { *reinterpret_cast<unsigned char*>(&buf[last]) = 128; }
  2540. void String::setLast(unsigned in) { buf[last] = char(in); }
  2541. void String::copy(const String& other) {
  2542. if(other.isOnStack()) {
  2543. memcpy(buf, other.buf, len);
  2544. } else {
  2545. setOnHeap();
  2546. data.size = other.data.size;
  2547. data.capacity = data.size + 1;
  2548. data.ptr = new char[data.capacity];
  2549. memcpy(data.ptr, other.data.ptr, data.size + 1);
  2550. }
  2551. }
  2552. String::String() {
  2553. buf[0] = '\0';
  2554. setLast();
  2555. }
  2556. String::~String() {
  2557. if(!isOnStack())
  2558. delete[] data.ptr;
  2559. }
  2560. String::String(const char* in)
  2561. : String(in, strlen(in)) {}
  2562. String::String(const char* in, unsigned in_size) {
  2563. if(in_size <= last) {
  2564. memcpy(buf, in, in_size + 1);
  2565. setLast(last - in_size);
  2566. } else {
  2567. setOnHeap();
  2568. data.size = in_size;
  2569. data.capacity = data.size + 1;
  2570. data.ptr = new char[data.capacity];
  2571. memcpy(data.ptr, in, in_size + 1);
  2572. }
  2573. }
  2574. String::String(const String& other) { copy(other); }
  2575. String& String::operator=(const String& other) {
  2576. if(this != &other) {
  2577. if(!isOnStack())
  2578. delete[] data.ptr;
  2579. copy(other);
  2580. }
  2581. return *this;
  2582. }
  2583. String& String::operator+=(const String& other) {
  2584. const unsigned my_old_size = size();
  2585. const unsigned other_size = other.size();
  2586. const unsigned total_size = my_old_size + other_size;
  2587. if(isOnStack()) {
  2588. if(total_size < len) {
  2589. // append to the current stack space
  2590. memcpy(buf + my_old_size, other.c_str(), other_size + 1);
  2591. setLast(last - total_size);
  2592. } else {
  2593. // alloc new chunk
  2594. char* temp = new char[total_size + 1];
  2595. // copy current data to new location before writing in the union
  2596. memcpy(temp, buf, my_old_size); // skip the +1 ('\0') for speed
  2597. // update data in union
  2598. setOnHeap();
  2599. data.size = total_size;
  2600. data.capacity = data.size + 1;
  2601. data.ptr = temp;
  2602. // transfer the rest of the data
  2603. memcpy(data.ptr + my_old_size, other.c_str(), other_size + 1);
  2604. }
  2605. } else {
  2606. if(data.capacity > total_size) {
  2607. // append to the current heap block
  2608. data.size = total_size;
  2609. memcpy(data.ptr + my_old_size, other.c_str(), other_size + 1);
  2610. } else {
  2611. // resize
  2612. data.capacity *= 2;
  2613. if(data.capacity <= total_size)
  2614. data.capacity = total_size + 1;
  2615. // alloc new chunk
  2616. char* temp = new char[data.capacity];
  2617. // copy current data to new location before releasing it
  2618. memcpy(temp, data.ptr, my_old_size); // skip the +1 ('\0') for speed
  2619. // release old chunk
  2620. delete[] data.ptr;
  2621. // update the rest of the union members
  2622. data.size = total_size;
  2623. data.ptr = temp;
  2624. // transfer the rest of the data
  2625. memcpy(data.ptr + my_old_size, other.c_str(), other_size + 1);
  2626. }
  2627. }
  2628. return *this;
  2629. }
  2630. String String::operator+(const String& other) const { return String(*this) += other; }
  2631. String::String(String&& other) {
  2632. memcpy(buf, other.buf, len);
  2633. other.buf[0] = '\0';
  2634. other.setLast();
  2635. }
  2636. String& String::operator=(String&& other) {
  2637. if(this != &other) {
  2638. if(!isOnStack())
  2639. delete[] data.ptr;
  2640. memcpy(buf, other.buf, len);
  2641. other.buf[0] = '\0';
  2642. other.setLast();
  2643. }
  2644. return *this;
  2645. }
  2646. char String::operator[](unsigned i) const {
  2647. return const_cast<String*>(this)->operator[](i); // NOLINT
  2648. }
  2649. char& String::operator[](unsigned i) {
  2650. if(isOnStack())
  2651. return reinterpret_cast<char*>(buf)[i];
  2652. return data.ptr[i];
  2653. }
  2654. DOCTEST_GCC_SUPPRESS_WARNING_WITH_PUSH("-Wmaybe-uninitialized")
  2655. unsigned String::size() const {
  2656. if(isOnStack())
  2657. return last - (unsigned(buf[last]) & 31); // using "last" would work only if "len" is 32
  2658. return data.size;
  2659. }
  2660. DOCTEST_GCC_SUPPRESS_WARNING_POP
  2661. unsigned String::capacity() const {
  2662. if(isOnStack())
  2663. return len;
  2664. return data.capacity;
  2665. }
  2666. int String::compare(const char* other, bool no_case) const {
  2667. if(no_case)
  2668. return stricmp(c_str(), other);
  2669. return std::strcmp(c_str(), other);
  2670. }
  2671. int String::compare(const String& other, bool no_case) const {
  2672. return compare(other.c_str(), no_case);
  2673. }
  2674. // clang-format off
  2675. bool operator==(const String& lhs, const String& rhs) { return lhs.compare(rhs) == 0; }
  2676. bool operator!=(const String& lhs, const String& rhs) { return lhs.compare(rhs) != 0; }
  2677. bool operator< (const String& lhs, const String& rhs) { return lhs.compare(rhs) < 0; }
  2678. bool operator> (const String& lhs, const String& rhs) { return lhs.compare(rhs) > 0; }
  2679. bool operator<=(const String& lhs, const String& rhs) { return (lhs != rhs) ? lhs.compare(rhs) < 0 : true; }
  2680. bool operator>=(const String& lhs, const String& rhs) { return (lhs != rhs) ? lhs.compare(rhs) > 0 : true; }
  2681. // clang-format on
  2682. std::ostream& operator<<(std::ostream& s, const String& in) { return s << in.c_str(); }
  2683. namespace {
  2684. void color_to_stream(std::ostream&, Color::Enum) DOCTEST_BRANCH_ON_DISABLED({}, ;)
  2685. } // namespace
  2686. namespace Color {
  2687. std::ostream& operator<<(std::ostream& s, Color::Enum code) {
  2688. color_to_stream(s, code);
  2689. return s;
  2690. }
  2691. } // namespace Color
  2692. // clang-format off
  2693. const char* assertString(assertType::Enum at) {
  2694. DOCTEST_MSVC_SUPPRESS_WARNING_WITH_PUSH(4062) // enum 'x' in switch of enum 'y' is not handled
  2695. switch(at) { //!OCLINT missing default in switch statements
  2696. case assertType::DT_WARN : return "WARN";
  2697. case assertType::DT_CHECK : return "CHECK";
  2698. case assertType::DT_REQUIRE : return "REQUIRE";
  2699. case assertType::DT_WARN_FALSE : return "WARN_FALSE";
  2700. case assertType::DT_CHECK_FALSE : return "CHECK_FALSE";
  2701. case assertType::DT_REQUIRE_FALSE : return "REQUIRE_FALSE";
  2702. case assertType::DT_WARN_THROWS : return "WARN_THROWS";
  2703. case assertType::DT_CHECK_THROWS : return "CHECK_THROWS";
  2704. case assertType::DT_REQUIRE_THROWS : return "REQUIRE_THROWS";
  2705. case assertType::DT_WARN_THROWS_AS : return "WARN_THROWS_AS";
  2706. case assertType::DT_CHECK_THROWS_AS : return "CHECK_THROWS_AS";
  2707. case assertType::DT_REQUIRE_THROWS_AS : return "REQUIRE_THROWS_AS";
  2708. case assertType::DT_WARN_THROWS_WITH : return "WARN_THROWS_WITH";
  2709. case assertType::DT_CHECK_THROWS_WITH : return "CHECK_THROWS_WITH";
  2710. case assertType::DT_REQUIRE_THROWS_WITH : return "REQUIRE_THROWS_WITH";
  2711. case assertType::DT_WARN_THROWS_WITH_AS : return "WARN_THROWS_WITH_AS";
  2712. case assertType::DT_CHECK_THROWS_WITH_AS : return "CHECK_THROWS_WITH_AS";
  2713. case assertType::DT_REQUIRE_THROWS_WITH_AS : return "REQUIRE_THROWS_WITH_AS";
  2714. case assertType::DT_WARN_NOTHROW : return "WARN_NOTHROW";
  2715. case assertType::DT_CHECK_NOTHROW : return "CHECK_NOTHROW";
  2716. case assertType::DT_REQUIRE_NOTHROW : return "REQUIRE_NOTHROW";
  2717. case assertType::DT_WARN_EQ : return "WARN_EQ";
  2718. case assertType::DT_CHECK_EQ : return "CHECK_EQ";
  2719. case assertType::DT_REQUIRE_EQ : return "REQUIRE_EQ";
  2720. case assertType::DT_WARN_NE : return "WARN_NE";
  2721. case assertType::DT_CHECK_NE : return "CHECK_NE";
  2722. case assertType::DT_REQUIRE_NE : return "REQUIRE_NE";
  2723. case assertType::DT_WARN_GT : return "WARN_GT";
  2724. case assertType::DT_CHECK_GT : return "CHECK_GT";
  2725. case assertType::DT_REQUIRE_GT : return "REQUIRE_GT";
  2726. case assertType::DT_WARN_LT : return "WARN_LT";
  2727. case assertType::DT_CHECK_LT : return "CHECK_LT";
  2728. case assertType::DT_REQUIRE_LT : return "REQUIRE_LT";
  2729. case assertType::DT_WARN_GE : return "WARN_GE";
  2730. case assertType::DT_CHECK_GE : return "CHECK_GE";
  2731. case assertType::DT_REQUIRE_GE : return "REQUIRE_GE";
  2732. case assertType::DT_WARN_LE : return "WARN_LE";
  2733. case assertType::DT_CHECK_LE : return "CHECK_LE";
  2734. case assertType::DT_REQUIRE_LE : return "REQUIRE_LE";
  2735. case assertType::DT_WARN_UNARY : return "WARN_UNARY";
  2736. case assertType::DT_CHECK_UNARY : return "CHECK_UNARY";
  2737. case assertType::DT_REQUIRE_UNARY : return "REQUIRE_UNARY";
  2738. case assertType::DT_WARN_UNARY_FALSE : return "WARN_UNARY_FALSE";
  2739. case assertType::DT_CHECK_UNARY_FALSE : return "CHECK_UNARY_FALSE";
  2740. case assertType::DT_REQUIRE_UNARY_FALSE : return "REQUIRE_UNARY_FALSE";
  2741. }
  2742. DOCTEST_MSVC_SUPPRESS_WARNING_POP
  2743. return "";
  2744. }
  2745. // clang-format on
  2746. const char* failureString(assertType::Enum at) {
  2747. if(at & assertType::is_warn) //!OCLINT bitwise operator in conditional
  2748. return "WARNING";
  2749. if(at & assertType::is_check) //!OCLINT bitwise operator in conditional
  2750. return "ERROR";
  2751. if(at & assertType::is_require) //!OCLINT bitwise operator in conditional
  2752. return "FATAL ERROR";
  2753. return "";
  2754. }
  2755. DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH("-Wnull-dereference")
  2756. DOCTEST_GCC_SUPPRESS_WARNING_WITH_PUSH("-Wnull-dereference")
  2757. // depending on the current options this will remove the path of filenames
  2758. const char* skipPathFromFilename(const char* file) {
  2759. if(getContextOptions()->no_path_in_filenames) {
  2760. auto back = std::strrchr(file, '\\');
  2761. auto forward = std::strrchr(file, '/');
  2762. if(back || forward) {
  2763. if(back > forward)
  2764. forward = back;
  2765. return forward + 1;
  2766. }
  2767. }
  2768. return file;
  2769. }
  2770. DOCTEST_CLANG_SUPPRESS_WARNING_POP
  2771. DOCTEST_GCC_SUPPRESS_WARNING_POP
  2772. bool SubcaseSignature::operator<(const SubcaseSignature& other) const {
  2773. if(m_line != other.m_line)
  2774. return m_line < other.m_line;
  2775. if(std::strcmp(m_file, other.m_file) != 0)
  2776. return std::strcmp(m_file, other.m_file) < 0;
  2777. return std::strcmp(m_name, other.m_name) < 0;
  2778. }
  2779. IContextScope::IContextScope() = default;
  2780. IContextScope::~IContextScope() = default;
  2781. #ifdef DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING
  2782. String toString(char* in) { return toString(static_cast<const char*>(in)); }
  2783. String toString(const char* in) { return String("\"") + (in ? in : "{null string}") + "\""; }
  2784. #endif // DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING
  2785. String toString(bool in) { return in ? "true" : "false"; }
  2786. String toString(float in) { return fpToString(in, 5) + "f"; }
  2787. String toString(double in) { return fpToString(in, 10); }
  2788. String toString(double long in) { return fpToString(in, 15); }
  2789. #define DOCTEST_TO_STRING_OVERLOAD(type, fmt) \
  2790. String toString(type in) { \
  2791. char buf[64]; \
  2792. std::sprintf(buf, fmt, in); \
  2793. return buf; \
  2794. }
  2795. DOCTEST_TO_STRING_OVERLOAD(char, "%d")
  2796. DOCTEST_TO_STRING_OVERLOAD(char signed, "%d")
  2797. DOCTEST_TO_STRING_OVERLOAD(char unsigned, "%u")
  2798. DOCTEST_TO_STRING_OVERLOAD(int short, "%d")
  2799. DOCTEST_TO_STRING_OVERLOAD(int short unsigned, "%u")
  2800. DOCTEST_TO_STRING_OVERLOAD(int, "%d")
  2801. DOCTEST_TO_STRING_OVERLOAD(unsigned, "%u")
  2802. DOCTEST_TO_STRING_OVERLOAD(int long, "%ld")
  2803. DOCTEST_TO_STRING_OVERLOAD(int long unsigned, "%lu")
  2804. DOCTEST_TO_STRING_OVERLOAD(int long long, "%lld")
  2805. DOCTEST_TO_STRING_OVERLOAD(int long long unsigned, "%llu")
  2806. String toString(std::nullptr_t) { return "NULL"; }
  2807. #if DOCTEST_MSVC >= DOCTEST_COMPILER(19, 20, 0)
  2808. // see this issue on why this is needed: https://github.com/onqtam/doctest/issues/183
  2809. String toString(const std::string& in) { return in.c_str(); }
  2810. #endif // VS 2019
  2811. Approx::Approx(double value)
  2812. : m_epsilon(static_cast<double>(std::numeric_limits<float>::epsilon()) * 100)
  2813. , m_scale(1.0)
  2814. , m_value(value) {}
  2815. Approx Approx::operator()(double value) const {
  2816. Approx approx(value);
  2817. approx.epsilon(m_epsilon);
  2818. approx.scale(m_scale);
  2819. return approx;
  2820. }
  2821. Approx& Approx::epsilon(double newEpsilon) {
  2822. m_epsilon = newEpsilon;
  2823. return *this;
  2824. }
  2825. Approx& Approx::scale(double newScale) {
  2826. m_scale = newScale;
  2827. return *this;
  2828. }
  2829. bool operator==(double lhs, const Approx& rhs) {
  2830. // Thanks to Richard Harris for his help refining this formula
  2831. return std::fabs(lhs - rhs.m_value) <
  2832. rhs.m_epsilon * (rhs.m_scale + std::max<double>(std::fabs(lhs), std::fabs(rhs.m_value)));
  2833. }
  2834. bool operator==(const Approx& lhs, double rhs) { return operator==(rhs, lhs); }
  2835. bool operator!=(double lhs, const Approx& rhs) { return !operator==(lhs, rhs); }
  2836. bool operator!=(const Approx& lhs, double rhs) { return !operator==(rhs, lhs); }
  2837. bool operator<=(double lhs, const Approx& rhs) { return lhs < rhs.m_value || lhs == rhs; }
  2838. bool operator<=(const Approx& lhs, double rhs) { return lhs.m_value < rhs || lhs == rhs; }
  2839. bool operator>=(double lhs, const Approx& rhs) { return lhs > rhs.m_value || lhs == rhs; }
  2840. bool operator>=(const Approx& lhs, double rhs) { return lhs.m_value > rhs || lhs == rhs; }
  2841. bool operator<(double lhs, const Approx& rhs) { return lhs < rhs.m_value && lhs != rhs; }
  2842. bool operator<(const Approx& lhs, double rhs) { return lhs.m_value < rhs && lhs != rhs; }
  2843. bool operator>(double lhs, const Approx& rhs) { return lhs > rhs.m_value && lhs != rhs; }
  2844. bool operator>(const Approx& lhs, double rhs) { return lhs.m_value > rhs && lhs != rhs; }
  2845. String toString(const Approx& in) {
  2846. return String("Approx( ") + doctest::toString(in.m_value) + " )";
  2847. }
  2848. const ContextOptions* getContextOptions() { return DOCTEST_BRANCH_ON_DISABLED(nullptr, g_cs); }
  2849. } // namespace doctest
  2850. #ifdef DOCTEST_CONFIG_DISABLE
  2851. namespace doctest {
  2852. Context::Context(int, const char* const*) {}
  2853. Context::~Context() = default;
  2854. void Context::applyCommandLine(int, const char* const*) {}
  2855. void Context::addFilter(const char*, const char*) {}
  2856. void Context::clearFilters() {}
  2857. void Context::setOption(const char*, int) {}
  2858. void Context::setOption(const char*, const char*) {}
  2859. bool Context::shouldExit() { return false; }
  2860. void Context::setAsDefaultForAssertsOutOfTestCases() {}
  2861. void Context::setAssertHandler(detail::assert_handler) {}
  2862. int Context::run() { return 0; }
  2863. IReporter::~IReporter() = default;
  2864. int IReporter::get_num_active_contexts() { return 0; }
  2865. const IContextScope* const* IReporter::get_active_contexts() { return nullptr; }
  2866. int IReporter::get_num_stringified_contexts() { return 0; }
  2867. const String* IReporter::get_stringified_contexts() { return nullptr; }
  2868. int registerReporter(const char*, int, IReporter*) { return 0; }
  2869. } // namespace doctest
  2870. #else // DOCTEST_CONFIG_DISABLE
  2871. #if !defined(DOCTEST_CONFIG_COLORS_NONE)
  2872. #if !defined(DOCTEST_CONFIG_COLORS_WINDOWS) && !defined(DOCTEST_CONFIG_COLORS_ANSI)
  2873. #ifdef DOCTEST_PLATFORM_WINDOWS
  2874. #define DOCTEST_CONFIG_COLORS_WINDOWS
  2875. #else // linux
  2876. #define DOCTEST_CONFIG_COLORS_ANSI
  2877. #endif // platform
  2878. #endif // DOCTEST_CONFIG_COLORS_WINDOWS && DOCTEST_CONFIG_COLORS_ANSI
  2879. #endif // DOCTEST_CONFIG_COLORS_NONE
  2880. namespace doctest_detail_test_suite_ns {
  2881. // holds the current test suite
  2882. doctest::detail::TestSuite& getCurrentTestSuite() {
  2883. static doctest::detail::TestSuite data;
  2884. return data;
  2885. }
  2886. } // namespace doctest_detail_test_suite_ns
  2887. namespace doctest {
  2888. namespace {
  2889. // the int (priority) is part of the key for automatic sorting - sadly one can register a
  2890. // reporter with a duplicate name and a different priority but hopefully that won't happen often :|
  2891. typedef std::map<std::pair<int, String>, reporterCreatorFunc> reporterMap;
  2892. reporterMap& getReporters() {
  2893. static reporterMap data;
  2894. return data;
  2895. }
  2896. reporterMap& getListeners() {
  2897. static reporterMap data;
  2898. return data;
  2899. }
  2900. } // namespace
  2901. namespace detail {
  2902. #define DOCTEST_ITERATE_THROUGH_REPORTERS(function, ...) \
  2903. for(auto& curr_rep : g_cs->reporters_currently_used) \
  2904. curr_rep->function(__VA_ARGS__)
  2905. bool checkIfShouldThrow(assertType::Enum at) {
  2906. if(at & assertType::is_require) //!OCLINT bitwise operator in conditional
  2907. return true;
  2908. if((at & assertType::is_check) //!OCLINT bitwise operator in conditional
  2909. && getContextOptions()->abort_after > 0 &&
  2910. (g_cs->numAssertsFailed + g_cs->numAssertsFailedCurrentTest_atomic) >=
  2911. getContextOptions()->abort_after)
  2912. return true;
  2913. return false;
  2914. }
  2915. #ifndef DOCTEST_CONFIG_NO_EXCEPTIONS
  2916. [[noreturn]] void throwException() {
  2917. g_cs->shouldLogCurrentException = false;
  2918. throw TestFailureException();
  2919. } // NOLINT(cert-err60-cpp)
  2920. #else // DOCTEST_CONFIG_NO_EXCEPTIONS
  2921. void throwException() {}
  2922. #endif // DOCTEST_CONFIG_NO_EXCEPTIONS
  2923. } // namespace detail
  2924. namespace {
  2925. using namespace detail;
  2926. // matching of a string against a wildcard mask (case sensitivity configurable) taken from
  2927. // https://www.codeproject.com/Articles/1088/Wildcard-string-compare-globbing
  2928. int wildcmp(const char* str, const char* wild, bool caseSensitive) {
  2929. const char* cp = nullptr;
  2930. const char* mp = nullptr;
  2931. while((*str) && (*wild != '*')) {
  2932. if((caseSensitive ? (*wild != *str) : (tolower(*wild) != tolower(*str))) &&
  2933. (*wild != '?')) {
  2934. return 0;
  2935. }
  2936. wild++;
  2937. str++;
  2938. }
  2939. while(*str) {
  2940. if(*wild == '*') {
  2941. if(!*++wild) {
  2942. return 1;
  2943. }
  2944. mp = wild;
  2945. cp = str + 1;
  2946. } else if((caseSensitive ? (*wild == *str) : (tolower(*wild) == tolower(*str))) ||
  2947. (*wild == '?')) {
  2948. wild++;
  2949. str++;
  2950. } else {
  2951. wild = mp; //!OCLINT parameter reassignment
  2952. str = cp++; //!OCLINT parameter reassignment
  2953. }
  2954. }
  2955. while(*wild == '*') {
  2956. wild++;
  2957. }
  2958. return !*wild;
  2959. }
  2960. //// C string hash function (djb2) - taken from http://www.cse.yorku.ca/~oz/hash.html
  2961. //unsigned hashStr(unsigned const char* str) {
  2962. // unsigned long hash = 5381;
  2963. // char c;
  2964. // while((c = *str++))
  2965. // hash = ((hash << 5) + hash) + c; // hash * 33 + c
  2966. // return hash;
  2967. //}
  2968. // checks if the name matches any of the filters (and can be configured what to do when empty)
  2969. bool matchesAny(const char* name, const std::vector<String>& filters, bool matchEmpty,
  2970. bool caseSensitive) {
  2971. if(filters.empty() && matchEmpty)
  2972. return true;
  2973. for(auto& curr : filters)
  2974. if(wildcmp(name, curr.c_str(), caseSensitive))
  2975. return true;
  2976. return false;
  2977. }
  2978. } // namespace
  2979. namespace detail {
  2980. Subcase::Subcase(const char* name, const char* file, int line)
  2981. : m_signature({name, file, line}) {
  2982. ContextState* s = g_cs;
  2983. // check subcase filters
  2984. if(s->subcasesStack.size() < size_t(s->subcase_filter_levels)) {
  2985. if(!matchesAny(m_signature.m_name, s->filters[6], true, s->case_sensitive))
  2986. return;
  2987. if(matchesAny(m_signature.m_name, s->filters[7], false, s->case_sensitive))
  2988. return;
  2989. }
  2990. // if a Subcase on the same level has already been entered
  2991. if(s->subcasesStack.size() < size_t(s->subcasesCurrentMaxLevel)) {
  2992. s->should_reenter = true;
  2993. return;
  2994. }
  2995. // push the current signature to the stack so we can check if the
  2996. // current stack + the current new subcase have been traversed
  2997. s->subcasesStack.push_back(m_signature);
  2998. if(s->subcasesPassed.count(s->subcasesStack) != 0) {
  2999. // pop - revert to previous stack since we've already passed this
  3000. s->subcasesStack.pop_back();
  3001. return;
  3002. }
  3003. s->subcasesCurrentMaxLevel = s->subcasesStack.size();
  3004. m_entered = true;
  3005. DOCTEST_ITERATE_THROUGH_REPORTERS(subcase_start, m_signature);
  3006. }
  3007. DOCTEST_MSVC_SUPPRESS_WARNING_WITH_PUSH(4996) // std::uncaught_exception is deprecated in C++17
  3008. DOCTEST_GCC_SUPPRESS_WARNING_WITH_PUSH("-Wdeprecated-declarations")
  3009. DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH("-Wdeprecated-declarations")
  3010. Subcase::~Subcase() {
  3011. if(m_entered) {
  3012. // only mark the subcase stack as passed if no subcases have been skipped
  3013. if(g_cs->should_reenter == false)
  3014. g_cs->subcasesPassed.insert(g_cs->subcasesStack);
  3015. g_cs->subcasesStack.pop_back();
  3016. if(std::uncaught_exception() && g_cs->shouldLogCurrentException) {
  3017. DOCTEST_ITERATE_THROUGH_REPORTERS(
  3018. test_case_exception, {"exception thrown in subcase - will translate later "
  3019. "when the whole test case has been exited (cannot "
  3020. "translate while there is an active exception)",
  3021. false});
  3022. g_cs->shouldLogCurrentException = false;
  3023. }
  3024. DOCTEST_ITERATE_THROUGH_REPORTERS(subcase_end, DOCTEST_EMPTY);
  3025. }
  3026. }
  3027. DOCTEST_CLANG_SUPPRESS_WARNING_POP
  3028. DOCTEST_GCC_SUPPRESS_WARNING_POP
  3029. DOCTEST_MSVC_SUPPRESS_WARNING_POP
  3030. Subcase::operator bool() const { return m_entered; }
  3031. Result::Result(bool passed, const String& decomposition)
  3032. : m_passed(passed)
  3033. , m_decomp(decomposition) {}
  3034. ExpressionDecomposer::ExpressionDecomposer(assertType::Enum at)
  3035. : m_at(at) {}
  3036. TestSuite& TestSuite::operator*(const char* in) {
  3037. m_test_suite = in;
  3038. // clear state
  3039. m_description = nullptr;
  3040. m_skip = false;
  3041. m_may_fail = false;
  3042. m_should_fail = false;
  3043. m_expected_failures = 0;
  3044. m_timeout = 0;
  3045. return *this;
  3046. }
  3047. TestCase::TestCase(funcType test, const char* file, unsigned line, const TestSuite& test_suite,
  3048. const char* type, int template_id) {
  3049. m_file = file;
  3050. m_line = line;
  3051. m_name = nullptr; // will be later overridden in operator*
  3052. m_test_suite = test_suite.m_test_suite;
  3053. m_description = test_suite.m_description;
  3054. m_skip = test_suite.m_skip;
  3055. m_may_fail = test_suite.m_may_fail;
  3056. m_should_fail = test_suite.m_should_fail;
  3057. m_expected_failures = test_suite.m_expected_failures;
  3058. m_timeout = test_suite.m_timeout;
  3059. m_test = test;
  3060. m_type = type;
  3061. m_template_id = template_id;
  3062. }
  3063. TestCase::TestCase(const TestCase& other)
  3064. : TestCaseData() {
  3065. *this = other;
  3066. }
  3067. DOCTEST_MSVC_SUPPRESS_WARNING_WITH_PUSH(26434) // hides a non-virtual function
  3068. DOCTEST_MSVC_SUPPRESS_WARNING(26437) // Do not slice
  3069. TestCase& TestCase::operator=(const TestCase& other) {
  3070. static_cast<TestCaseData&>(*this) = static_cast<const TestCaseData&>(other);
  3071. m_test = other.m_test;
  3072. m_type = other.m_type;
  3073. m_template_id = other.m_template_id;
  3074. m_full_name = other.m_full_name;
  3075. if(m_template_id != -1)
  3076. m_name = m_full_name.c_str();
  3077. return *this;
  3078. }
  3079. DOCTEST_MSVC_SUPPRESS_WARNING_POP
  3080. TestCase& TestCase::operator*(const char* in) {
  3081. m_name = in;
  3082. // make a new name with an appended type for templated test case
  3083. if(m_template_id != -1) {
  3084. m_full_name = String(m_name) + m_type;
  3085. // redirect the name to point to the newly constructed full name
  3086. m_name = m_full_name.c_str();
  3087. }
  3088. return *this;
  3089. }
  3090. bool TestCase::operator<(const TestCase& other) const {
  3091. if(m_line != other.m_line)
  3092. return m_line < other.m_line;
  3093. const int file_cmp = std::strcmp(m_file, other.m_file);
  3094. if(file_cmp != 0)
  3095. return file_cmp < 0;
  3096. return m_template_id < other.m_template_id;
  3097. }
  3098. } // namespace detail
  3099. namespace {
  3100. using namespace detail;
  3101. // for sorting tests by file/line
  3102. bool fileOrderComparator(const TestCase* lhs, const TestCase* rhs) {
  3103. #if DOCTEST_MSVC
  3104. // this is needed because MSVC gives different case for drive letters
  3105. // for __FILE__ when evaluated in a header and a source file
  3106. const int res = stricmp(lhs->m_file, rhs->m_file);
  3107. #else // MSVC
  3108. const int res = std::strcmp(lhs->m_file, rhs->m_file);
  3109. #endif // MSVC
  3110. if(res != 0)
  3111. return res < 0;
  3112. if(lhs->m_line != rhs->m_line)
  3113. return lhs->m_line < rhs->m_line;
  3114. return lhs->m_template_id < rhs->m_template_id;
  3115. }
  3116. // for sorting tests by suite/file/line
  3117. bool suiteOrderComparator(const TestCase* lhs, const TestCase* rhs) {
  3118. const int res = std::strcmp(lhs->m_test_suite, rhs->m_test_suite);
  3119. if(res != 0)
  3120. return res < 0;
  3121. return fileOrderComparator(lhs, rhs);
  3122. }
  3123. // for sorting tests by name/suite/file/line
  3124. bool nameOrderComparator(const TestCase* lhs, const TestCase* rhs) {
  3125. const int res = std::strcmp(lhs->m_name, rhs->m_name);
  3126. if(res != 0)
  3127. return res < 0;
  3128. return suiteOrderComparator(lhs, rhs);
  3129. }
  3130. // all the registered tests
  3131. std::set<TestCase>& getRegisteredTests() {
  3132. static std::set<TestCase> data;
  3133. return data;
  3134. }
  3135. #ifdef DOCTEST_CONFIG_COLORS_WINDOWS
  3136. HANDLE g_stdoutHandle;
  3137. WORD g_origFgAttrs;
  3138. WORD g_origBgAttrs;
  3139. bool g_attrsInitted = false;
  3140. int colors_init() {
  3141. if(!g_attrsInitted) {
  3142. g_stdoutHandle = GetStdHandle(STD_OUTPUT_HANDLE);
  3143. g_attrsInitted = true;
  3144. CONSOLE_SCREEN_BUFFER_INFO csbiInfo;
  3145. GetConsoleScreenBufferInfo(g_stdoutHandle, &csbiInfo);
  3146. g_origFgAttrs = csbiInfo.wAttributes & ~(BACKGROUND_GREEN | BACKGROUND_RED |
  3147. BACKGROUND_BLUE | BACKGROUND_INTENSITY);
  3148. g_origBgAttrs = csbiInfo.wAttributes & ~(FOREGROUND_GREEN | FOREGROUND_RED |
  3149. FOREGROUND_BLUE | FOREGROUND_INTENSITY);
  3150. }
  3151. return 0;
  3152. }
  3153. int dumy_init_console_colors = colors_init();
  3154. #endif // DOCTEST_CONFIG_COLORS_WINDOWS
  3155. DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH("-Wdeprecated-declarations")
  3156. void color_to_stream(std::ostream& s, Color::Enum code) {
  3157. ((void)s); // for DOCTEST_CONFIG_COLORS_NONE or DOCTEST_CONFIG_COLORS_WINDOWS
  3158. ((void)code); // for DOCTEST_CONFIG_COLORS_NONE
  3159. #ifdef DOCTEST_CONFIG_COLORS_ANSI
  3160. if(g_no_colors ||
  3161. (isatty(STDOUT_FILENO) == false && getContextOptions()->force_colors == false))
  3162. return;
  3163. auto col = "";
  3164. // clang-format off
  3165. switch(code) { //!OCLINT missing break in switch statement / unnecessary default statement in covered switch statement
  3166. case Color::Red: col = "[0;31m"; break;
  3167. case Color::Green: col = "[0;32m"; break;
  3168. case Color::Blue: col = "[0;34m"; break;
  3169. case Color::Cyan: col = "[0;36m"; break;
  3170. case Color::Yellow: col = "[0;33m"; break;
  3171. case Color::Grey: col = "[1;30m"; break;
  3172. case Color::LightGrey: col = "[0;37m"; break;
  3173. case Color::BrightRed: col = "[1;31m"; break;
  3174. case Color::BrightGreen: col = "[1;32m"; break;
  3175. case Color::BrightWhite: col = "[1;37m"; break;
  3176. case Color::Bright: // invalid
  3177. case Color::None:
  3178. case Color::White:
  3179. default: col = "[0m";
  3180. }
  3181. // clang-format on
  3182. s << "\033" << col;
  3183. #endif // DOCTEST_CONFIG_COLORS_ANSI
  3184. #ifdef DOCTEST_CONFIG_COLORS_WINDOWS
  3185. if(g_no_colors ||
  3186. (isatty(fileno(stdout)) == false && getContextOptions()->force_colors == false))
  3187. return;
  3188. #define DOCTEST_SET_ATTR(x) SetConsoleTextAttribute(g_stdoutHandle, x | g_origBgAttrs)
  3189. // clang-format off
  3190. switch (code) {
  3191. case Color::White: DOCTEST_SET_ATTR(FOREGROUND_GREEN | FOREGROUND_RED | FOREGROUND_BLUE); break;
  3192. case Color::Red: DOCTEST_SET_ATTR(FOREGROUND_RED); break;
  3193. case Color::Green: DOCTEST_SET_ATTR(FOREGROUND_GREEN); break;
  3194. case Color::Blue: DOCTEST_SET_ATTR(FOREGROUND_BLUE); break;
  3195. case Color::Cyan: DOCTEST_SET_ATTR(FOREGROUND_BLUE | FOREGROUND_GREEN); break;
  3196. case Color::Yellow: DOCTEST_SET_ATTR(FOREGROUND_RED | FOREGROUND_GREEN); break;
  3197. case Color::Grey: DOCTEST_SET_ATTR(0); break;
  3198. case Color::LightGrey: DOCTEST_SET_ATTR(FOREGROUND_INTENSITY); break;
  3199. case Color::BrightRed: DOCTEST_SET_ATTR(FOREGROUND_INTENSITY | FOREGROUND_RED); break;
  3200. case Color::BrightGreen: DOCTEST_SET_ATTR(FOREGROUND_INTENSITY | FOREGROUND_GREEN); break;
  3201. case Color::BrightWhite: DOCTEST_SET_ATTR(FOREGROUND_INTENSITY | FOREGROUND_GREEN | FOREGROUND_RED | FOREGROUND_BLUE); break;
  3202. case Color::None:
  3203. case Color::Bright: // invalid
  3204. default: DOCTEST_SET_ATTR(g_origFgAttrs);
  3205. }
  3206. // clang-format on
  3207. #endif // DOCTEST_CONFIG_COLORS_WINDOWS
  3208. }
  3209. DOCTEST_CLANG_SUPPRESS_WARNING_POP
  3210. std::vector<const IExceptionTranslator*>& getExceptionTranslators() {
  3211. static std::vector<const IExceptionTranslator*> data;
  3212. return data;
  3213. }
  3214. String translateActiveException() {
  3215. #ifndef DOCTEST_CONFIG_NO_EXCEPTIONS
  3216. String res;
  3217. auto& translators = getExceptionTranslators();
  3218. for(auto& curr : translators)
  3219. if(curr->translate(res))
  3220. return res;
  3221. // clang-format off
  3222. DOCTEST_GCC_SUPPRESS_WARNING_WITH_PUSH("-Wcatch-value")
  3223. try {
  3224. throw;
  3225. } catch(std::exception& ex) {
  3226. return ex.what();
  3227. } catch(std::string& msg) {
  3228. return msg.c_str();
  3229. } catch(const char* msg) {
  3230. return msg;
  3231. } catch(...) {
  3232. return "unknown exception";
  3233. }
  3234. DOCTEST_GCC_SUPPRESS_WARNING_POP
  3235. // clang-format on
  3236. #else // DOCTEST_CONFIG_NO_EXCEPTIONS
  3237. return "";
  3238. #endif // DOCTEST_CONFIG_NO_EXCEPTIONS
  3239. }
  3240. } // namespace
  3241. namespace detail {
  3242. // used by the macros for registering tests
  3243. int regTest(const TestCase& tc) {
  3244. getRegisteredTests().insert(tc);
  3245. return 0;
  3246. }
  3247. // sets the current test suite
  3248. int setTestSuite(const TestSuite& ts) {
  3249. doctest_detail_test_suite_ns::getCurrentTestSuite() = ts;
  3250. return 0;
  3251. }
  3252. #ifdef DOCTEST_IS_DEBUGGER_ACTIVE
  3253. bool isDebuggerActive() { return DOCTEST_IS_DEBUGGER_ACTIVE(); }
  3254. #else // DOCTEST_IS_DEBUGGER_ACTIVE
  3255. #ifdef DOCTEST_PLATFORM_MAC
  3256. // The following function is taken directly from the following technical note:
  3257. // http://developer.apple.com/library/mac/#qa/qa2004/qa1361.html
  3258. // Returns true if the current process is being debugged (either
  3259. // running under the debugger or has a debugger attached post facto).
  3260. bool isDebuggerActive() {
  3261. int mib[4];
  3262. kinfo_proc info;
  3263. size_t size;
  3264. // Initialize the flags so that, if sysctl fails for some bizarre
  3265. // reason, we get a predictable result.
  3266. info.kp_proc.p_flag = 0;
  3267. // Initialize mib, which tells sysctl the info we want, in this case
  3268. // we're looking for information about a specific process ID.
  3269. mib[0] = CTL_KERN;
  3270. mib[1] = KERN_PROC;
  3271. mib[2] = KERN_PROC_PID;
  3272. mib[3] = getpid();
  3273. // Call sysctl.
  3274. size = sizeof(info);
  3275. if(sysctl(mib, DOCTEST_COUNTOF(mib), &info, &size, 0, 0) != 0) {
  3276. std::cerr << "\nCall to sysctl failed - unable to determine if debugger is active **\n";
  3277. return false;
  3278. }
  3279. // We're being debugged if the P_TRACED flag is set.
  3280. return ((info.kp_proc.p_flag & P_TRACED) != 0);
  3281. }
  3282. #elif DOCTEST_MSVC || defined(__MINGW32__)
  3283. bool isDebuggerActive() { return ::IsDebuggerPresent() != 0; }
  3284. #else
  3285. bool isDebuggerActive() { return false; }
  3286. #endif // Platform
  3287. #endif // DOCTEST_IS_DEBUGGER_ACTIVE
  3288. void registerExceptionTranslatorImpl(const IExceptionTranslator* et) {
  3289. if(std::find(getExceptionTranslators().begin(), getExceptionTranslators().end(), et) ==
  3290. getExceptionTranslators().end())
  3291. getExceptionTranslators().push_back(et);
  3292. }
  3293. #ifdef DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING
  3294. void toStream(std::ostream* s, char* in) { *s << in; }
  3295. void toStream(std::ostream* s, const char* in) { *s << in; }
  3296. #endif // DOCTEST_CONFIG_TREAT_CHAR_STAR_AS_STRING
  3297. void toStream(std::ostream* s, bool in) { *s << std::boolalpha << in << std::noboolalpha; }
  3298. void toStream(std::ostream* s, float in) { *s << in; }
  3299. void toStream(std::ostream* s, double in) { *s << in; }
  3300. void toStream(std::ostream* s, double long in) { *s << in; }
  3301. void toStream(std::ostream* s, char in) { *s << in; }
  3302. void toStream(std::ostream* s, char signed in) { *s << in; }
  3303. void toStream(std::ostream* s, char unsigned in) { *s << in; }
  3304. void toStream(std::ostream* s, int short in) { *s << in; }
  3305. void toStream(std::ostream* s, int short unsigned in) { *s << in; }
  3306. void toStream(std::ostream* s, int in) { *s << in; }
  3307. void toStream(std::ostream* s, int unsigned in) { *s << in; }
  3308. void toStream(std::ostream* s, int long in) { *s << in; }
  3309. void toStream(std::ostream* s, int long unsigned in) { *s << in; }
  3310. void toStream(std::ostream* s, int long long in) { *s << in; }
  3311. void toStream(std::ostream* s, int long long unsigned in) { *s << in; }
  3312. DOCTEST_THREAD_LOCAL std::vector<IContextScope*> g_infoContexts; // for logging with INFO()
  3313. ContextScopeBase::ContextScopeBase() {
  3314. g_infoContexts.push_back(this);
  3315. }
  3316. DOCTEST_MSVC_SUPPRESS_WARNING_WITH_PUSH(4996) // std::uncaught_exception is deprecated in C++17
  3317. DOCTEST_GCC_SUPPRESS_WARNING_WITH_PUSH("-Wdeprecated-declarations")
  3318. DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH("-Wdeprecated-declarations")
  3319. // destroy cannot be inlined into the destructor because that would mean calling stringify after
  3320. // ContextScope has been destroyed (base class destructors run after derived class destructors).
  3321. // Instead, ContextScope calls this method directly from its destructor.
  3322. void ContextScopeBase::destroy() {
  3323. if(std::uncaught_exception()) {
  3324. std::ostringstream s;
  3325. this->stringify(&s);
  3326. g_cs->stringifiedContexts.push_back(s.str().c_str());
  3327. }
  3328. g_infoContexts.pop_back();
  3329. }
  3330. DOCTEST_CLANG_SUPPRESS_WARNING_POP
  3331. DOCTEST_GCC_SUPPRESS_WARNING_POP
  3332. DOCTEST_MSVC_SUPPRESS_WARNING_POP
  3333. } // namespace detail
  3334. namespace {
  3335. using namespace detail;
  3336. std::ostream& file_line_to_stream(std::ostream& s, const char* file, int line,
  3337. const char* tail = "") {
  3338. const auto opt = getContextOptions();
  3339. s << Color::LightGrey << skipPathFromFilename(file) << (opt->gnu_file_line ? ":" : "(")
  3340. << (opt->no_line_numbers ? 0 : line) // 0 or the real num depending on the option
  3341. << (opt->gnu_file_line ? ":" : "):") << tail;
  3342. return s;
  3343. }
  3344. #if !defined(DOCTEST_CONFIG_POSIX_SIGNALS) && !defined(DOCTEST_CONFIG_WINDOWS_SEH)
  3345. struct FatalConditionHandler
  3346. {
  3347. void reset() {}
  3348. };
  3349. #else // DOCTEST_CONFIG_POSIX_SIGNALS || DOCTEST_CONFIG_WINDOWS_SEH
  3350. void reportFatal(const std::string&);
  3351. #ifdef DOCTEST_PLATFORM_WINDOWS
  3352. struct SignalDefs
  3353. {
  3354. DWORD id;
  3355. const char* name;
  3356. };
  3357. // There is no 1-1 mapping between signals and windows exceptions.
  3358. // Windows can easily distinguish between SO and SigSegV,
  3359. // but SigInt, SigTerm, etc are handled differently.
  3360. SignalDefs signalDefs[] = {
  3361. {EXCEPTION_ILLEGAL_INSTRUCTION, "SIGILL - Illegal instruction signal"},
  3362. {EXCEPTION_STACK_OVERFLOW, "SIGSEGV - Stack overflow"},
  3363. {EXCEPTION_ACCESS_VIOLATION, "SIGSEGV - Segmentation violation signal"},
  3364. {EXCEPTION_INT_DIVIDE_BY_ZERO, "Divide by zero error"},
  3365. };
  3366. struct FatalConditionHandler
  3367. {
  3368. static LONG CALLBACK handleVectoredException(PEXCEPTION_POINTERS ExceptionInfo) {
  3369. for(size_t i = 0; i < DOCTEST_COUNTOF(signalDefs); ++i) {
  3370. if(ExceptionInfo->ExceptionRecord->ExceptionCode == signalDefs[i].id) {
  3371. reportFatal(signalDefs[i].name);
  3372. }
  3373. }
  3374. // If its not an exception we care about, pass it along.
  3375. // This stops us from eating debugger breaks etc.
  3376. return EXCEPTION_CONTINUE_SEARCH;
  3377. }
  3378. FatalConditionHandler() {
  3379. isSet = true;
  3380. // 32k seems enough for doctest to handle stack overflow,
  3381. // but the value was found experimentally, so there is no strong guarantee
  3382. guaranteeSize = 32 * 1024;
  3383. exceptionHandlerHandle = nullptr;
  3384. // Register as first handler in current chain
  3385. exceptionHandlerHandle = AddVectoredExceptionHandler(1, handleVectoredException);
  3386. // Pass in guarantee size to be filled
  3387. SetThreadStackGuarantee(&guaranteeSize);
  3388. }
  3389. static void reset() {
  3390. if(isSet) {
  3391. // Unregister handler and restore the old guarantee
  3392. RemoveVectoredExceptionHandler(exceptionHandlerHandle);
  3393. SetThreadStackGuarantee(&guaranteeSize);
  3394. exceptionHandlerHandle = nullptr;
  3395. isSet = false;
  3396. }
  3397. }
  3398. ~FatalConditionHandler() { reset(); }
  3399. private:
  3400. static bool isSet;
  3401. static ULONG guaranteeSize;
  3402. static PVOID exceptionHandlerHandle;
  3403. };
  3404. bool FatalConditionHandler::isSet = false;
  3405. ULONG FatalConditionHandler::guaranteeSize = 0;
  3406. PVOID FatalConditionHandler::exceptionHandlerHandle = nullptr;
  3407. #else // DOCTEST_PLATFORM_WINDOWS
  3408. struct SignalDefs
  3409. {
  3410. int id;
  3411. const char* name;
  3412. };
  3413. SignalDefs signalDefs[] = {{SIGINT, "SIGINT - Terminal interrupt signal"},
  3414. {SIGILL, "SIGILL - Illegal instruction signal"},
  3415. {SIGFPE, "SIGFPE - Floating point error signal"},
  3416. {SIGSEGV, "SIGSEGV - Segmentation violation signal"},
  3417. {SIGTERM, "SIGTERM - Termination request signal"},
  3418. {SIGABRT, "SIGABRT - Abort (abnormal termination) signal"}};
  3419. struct FatalConditionHandler
  3420. {
  3421. static bool isSet;
  3422. static struct sigaction oldSigActions[DOCTEST_COUNTOF(signalDefs)];
  3423. static stack_t oldSigStack;
  3424. static char altStackMem[4 * SIGSTKSZ];
  3425. static void handleSignal(int sig) {
  3426. const char* name = "<unknown signal>";
  3427. for(std::size_t i = 0; i < DOCTEST_COUNTOF(signalDefs); ++i) {
  3428. SignalDefs& def = signalDefs[i];
  3429. if(sig == def.id) {
  3430. name = def.name;
  3431. break;
  3432. }
  3433. }
  3434. reset();
  3435. reportFatal(name);
  3436. raise(sig);
  3437. }
  3438. FatalConditionHandler() {
  3439. isSet = true;
  3440. stack_t sigStack;
  3441. sigStack.ss_sp = altStackMem;
  3442. sigStack.ss_size = sizeof(altStackMem);
  3443. sigStack.ss_flags = 0;
  3444. sigaltstack(&sigStack, &oldSigStack);
  3445. struct sigaction sa = {};
  3446. sa.sa_handler = handleSignal; // NOLINT
  3447. sa.sa_flags = SA_ONSTACK;
  3448. for(std::size_t i = 0; i < DOCTEST_COUNTOF(signalDefs); ++i) {
  3449. sigaction(signalDefs[i].id, &sa, &oldSigActions[i]);
  3450. }
  3451. }
  3452. ~FatalConditionHandler() { reset(); }
  3453. static void reset() {
  3454. if(isSet) {
  3455. // Set signals back to previous values -- hopefully nobody overwrote them in the meantime
  3456. for(std::size_t i = 0; i < DOCTEST_COUNTOF(signalDefs); ++i) {
  3457. sigaction(signalDefs[i].id, &oldSigActions[i], nullptr);
  3458. }
  3459. // Return the old stack
  3460. sigaltstack(&oldSigStack, nullptr);
  3461. isSet = false;
  3462. }
  3463. }
  3464. };
  3465. bool FatalConditionHandler::isSet = false;
  3466. struct sigaction FatalConditionHandler::oldSigActions[DOCTEST_COUNTOF(signalDefs)] = {};
  3467. stack_t FatalConditionHandler::oldSigStack = {};
  3468. char FatalConditionHandler::altStackMem[] = {};
  3469. #endif // DOCTEST_PLATFORM_WINDOWS
  3470. #endif // DOCTEST_CONFIG_POSIX_SIGNALS || DOCTEST_CONFIG_WINDOWS_SEH
  3471. } // namespace
  3472. namespace {
  3473. using namespace detail;
  3474. #ifdef DOCTEST_PLATFORM_WINDOWS
  3475. #define DOCTEST_OUTPUT_DEBUG_STRING(text) ::OutputDebugStringA(text)
  3476. #else
  3477. // TODO: integration with XCode and other IDEs
  3478. #define DOCTEST_OUTPUT_DEBUG_STRING(text) // NOLINT(clang-diagnostic-unused-macros)
  3479. #endif // Platform
  3480. void addAssert(assertType::Enum at) {
  3481. if((at & assertType::is_warn) == 0) //!OCLINT bitwise operator in conditional
  3482. g_cs->numAssertsCurrentTest_atomic++;
  3483. }
  3484. void addFailedAssert(assertType::Enum at) {
  3485. if((at & assertType::is_warn) == 0) //!OCLINT bitwise operator in conditional
  3486. g_cs->numAssertsFailedCurrentTest_atomic++;
  3487. }
  3488. #if defined(DOCTEST_CONFIG_POSIX_SIGNALS) || defined(DOCTEST_CONFIG_WINDOWS_SEH)
  3489. void reportFatal(const std::string& message) {
  3490. g_cs->failure_flags |= TestCaseFailureReason::Crash;
  3491. DOCTEST_ITERATE_THROUGH_REPORTERS(test_case_exception, {message.c_str(), true});
  3492. while(g_cs->subcasesStack.size()) {
  3493. g_cs->subcasesStack.pop_back();
  3494. DOCTEST_ITERATE_THROUGH_REPORTERS(subcase_end, DOCTEST_EMPTY);
  3495. }
  3496. g_cs->finalizeTestCaseData();
  3497. DOCTEST_ITERATE_THROUGH_REPORTERS(test_case_end, *g_cs);
  3498. DOCTEST_ITERATE_THROUGH_REPORTERS(test_run_end, *g_cs);
  3499. }
  3500. #endif // DOCTEST_CONFIG_POSIX_SIGNALS || DOCTEST_CONFIG_WINDOWS_SEH
  3501. } // namespace
  3502. namespace detail {
  3503. ResultBuilder::ResultBuilder(assertType::Enum at, const char* file, int line, const char* expr,
  3504. const char* exception_type, const char* exception_string) {
  3505. m_test_case = g_cs->currentTest;
  3506. m_at = at;
  3507. m_file = file;
  3508. m_line = line;
  3509. m_expr = expr;
  3510. m_failed = true;
  3511. m_threw = false;
  3512. m_threw_as = false;
  3513. m_exception_type = exception_type;
  3514. m_exception_string = exception_string;
  3515. #if DOCTEST_MSVC
  3516. if(m_expr[0] == ' ') // this happens when variadic macros are disabled under MSVC
  3517. ++m_expr;
  3518. #endif // MSVC
  3519. }
  3520. void ResultBuilder::setResult(const Result& res) {
  3521. m_decomp = res.m_decomp;
  3522. m_failed = !res.m_passed;
  3523. }
  3524. void ResultBuilder::translateException() {
  3525. m_threw = true;
  3526. m_exception = translateActiveException();
  3527. }
  3528. bool ResultBuilder::log() {
  3529. if(m_at & assertType::is_throws) { //!OCLINT bitwise operator in conditional
  3530. m_failed = !m_threw;
  3531. } else if((m_at & assertType::is_throws_as) && (m_at & assertType::is_throws_with)) { //!OCLINT
  3532. m_failed = !m_threw_as || (m_exception != m_exception_string);
  3533. } else if(m_at & assertType::is_throws_as) { //!OCLINT bitwise operator in conditional
  3534. m_failed = !m_threw_as;
  3535. } else if(m_at & assertType::is_throws_with) { //!OCLINT bitwise operator in conditional
  3536. m_failed = m_exception != m_exception_string;
  3537. } else if(m_at & assertType::is_nothrow) { //!OCLINT bitwise operator in conditional
  3538. m_failed = m_threw;
  3539. }
  3540. if(m_exception.size())
  3541. m_exception = String("\"") + m_exception + "\"";
  3542. if(is_running_in_test) {
  3543. addAssert(m_at);
  3544. DOCTEST_ITERATE_THROUGH_REPORTERS(log_assert, *this);
  3545. if(m_failed)
  3546. addFailedAssert(m_at);
  3547. } else if(m_failed) {
  3548. failed_out_of_a_testing_context(*this);
  3549. }
  3550. return m_failed && isDebuggerActive() &&
  3551. !getContextOptions()->no_breaks; // break into debugger
  3552. }
  3553. void ResultBuilder::react() const {
  3554. if(m_failed && checkIfShouldThrow(m_at))
  3555. throwException();
  3556. }
  3557. void failed_out_of_a_testing_context(const AssertData& ad) {
  3558. if(g_cs->ah)
  3559. g_cs->ah(ad);
  3560. else
  3561. std::abort();
  3562. }
  3563. void decomp_assert(assertType::Enum at, const char* file, int line, const char* expr,
  3564. Result result) {
  3565. bool failed = !result.m_passed;
  3566. // ###################################################################################
  3567. // IF THE DEBUGGER BREAKS HERE - GO 1 LEVEL UP IN THE CALLSTACK FOR THE FAILING ASSERT
  3568. // THIS IS THE EFFECT OF HAVING 'DOCTEST_CONFIG_SUPER_FAST_ASSERTS' DEFINED
  3569. // ###################################################################################
  3570. DOCTEST_ASSERT_OUT_OF_TESTS(result.m_decomp);
  3571. DOCTEST_ASSERT_IN_TESTS(result.m_decomp);
  3572. }
  3573. MessageBuilder::MessageBuilder(const char* file, int line, assertType::Enum severity) {
  3574. m_stream = getTlsOss();
  3575. m_file = file;
  3576. m_line = line;
  3577. m_severity = severity;
  3578. }
  3579. IExceptionTranslator::IExceptionTranslator() = default;
  3580. IExceptionTranslator::~IExceptionTranslator() = default;
  3581. bool MessageBuilder::log() {
  3582. m_string = getTlsOssResult();
  3583. DOCTEST_ITERATE_THROUGH_REPORTERS(log_message, *this);
  3584. const bool isWarn = m_severity & assertType::is_warn;
  3585. // warn is just a message in this context so we don't treat it as an assert
  3586. if(!isWarn) {
  3587. addAssert(m_severity);
  3588. addFailedAssert(m_severity);
  3589. }
  3590. return isDebuggerActive() && !getContextOptions()->no_breaks && !isWarn; // break
  3591. }
  3592. void MessageBuilder::react() {
  3593. if(m_severity & assertType::is_require) //!OCLINT bitwise operator in conditional
  3594. throwException();
  3595. }
  3596. MessageBuilder::~MessageBuilder() = default;
  3597. } // namespace detail
  3598. namespace {
  3599. using namespace detail;
  3600. template <typename Ex>
  3601. [[noreturn]] void throw_exception(Ex const& e) {
  3602. #ifndef DOCTEST_CONFIG_NO_EXCEPTIONS
  3603. throw e;
  3604. #else // DOCTEST_CONFIG_NO_EXCEPTIONS
  3605. std::cerr << "doctest will terminate because it needed to throw an exception.\n"
  3606. << "The message was: " << e.what() << '\n';
  3607. std::terminate();
  3608. #endif // DOCTEST_CONFIG_NO_EXCEPTIONS
  3609. }
  3610. #define DOCTEST_INTERNAL_ERROR(msg) \
  3611. throw_exception(std::logic_error( \
  3612. __FILE__ ":" DOCTEST_TOSTR(__LINE__) ": Internal doctest error: " msg))
  3613. // clang-format off
  3614. // =================================================================================================
  3615. // The following code has been taken verbatim from Catch2/include/internal/catch_xmlwriter.h/cpp
  3616. // This is done so cherry-picking bug fixes is trivial - even the style/formatting is untouched.
  3617. // =================================================================================================
  3618. class XmlEncode {
  3619. public:
  3620. enum ForWhat { ForTextNodes, ForAttributes };
  3621. XmlEncode( std::string const& str, ForWhat forWhat = ForTextNodes );
  3622. void encodeTo( std::ostream& os ) const;
  3623. friend std::ostream& operator << ( std::ostream& os, XmlEncode const& xmlEncode );
  3624. private:
  3625. std::string m_str;
  3626. ForWhat m_forWhat;
  3627. };
  3628. class XmlWriter {
  3629. public:
  3630. class ScopedElement {
  3631. public:
  3632. ScopedElement( XmlWriter* writer );
  3633. ScopedElement( ScopedElement&& other ) noexcept;
  3634. ScopedElement& operator=( ScopedElement&& other ) noexcept;
  3635. ~ScopedElement();
  3636. ScopedElement& writeText( std::string const& text, bool indent = true );
  3637. template<typename T>
  3638. ScopedElement& writeAttribute( std::string const& name, T const& attribute ) {
  3639. m_writer->writeAttribute( name, attribute );
  3640. return *this;
  3641. }
  3642. private:
  3643. mutable XmlWriter* m_writer = nullptr;
  3644. };
  3645. XmlWriter( std::ostream& os = std::cout );
  3646. ~XmlWriter();
  3647. XmlWriter( XmlWriter const& ) = delete;
  3648. XmlWriter& operator=( XmlWriter const& ) = delete;
  3649. XmlWriter& startElement( std::string const& name );
  3650. ScopedElement scopedElement( std::string const& name );
  3651. XmlWriter& endElement();
  3652. XmlWriter& writeAttribute( std::string const& name, std::string const& attribute );
  3653. XmlWriter& writeAttribute( std::string const& name, const char* attribute );
  3654. XmlWriter& writeAttribute( std::string const& name, bool attribute );
  3655. template<typename T>
  3656. XmlWriter& writeAttribute( std::string const& name, T const& attribute ) {
  3657. std::stringstream rss;
  3658. rss << attribute;
  3659. return writeAttribute( name, rss.str() );
  3660. }
  3661. XmlWriter& writeText( std::string const& text, bool indent = true );
  3662. //XmlWriter& writeComment( std::string const& text );
  3663. //void writeStylesheetRef( std::string const& url );
  3664. //XmlWriter& writeBlankLine();
  3665. void ensureTagClosed();
  3666. private:
  3667. void writeDeclaration();
  3668. void newlineIfNecessary();
  3669. bool m_tagIsOpen = false;
  3670. bool m_needsNewline = false;
  3671. std::vector<std::string> m_tags;
  3672. std::string m_indent;
  3673. std::ostream& m_os;
  3674. };
  3675. // =================================================================================================
  3676. // The following code has been taken verbatim from Catch2/include/internal/catch_xmlwriter.h/cpp
  3677. // This is done so cherry-picking bug fixes is trivial - even the style/formatting is untouched.
  3678. // =================================================================================================
  3679. using uchar = unsigned char;
  3680. namespace {
  3681. size_t trailingBytes(unsigned char c) {
  3682. if ((c & 0xE0) == 0xC0) {
  3683. return 2;
  3684. }
  3685. if ((c & 0xF0) == 0xE0) {
  3686. return 3;
  3687. }
  3688. if ((c & 0xF8) == 0xF0) {
  3689. return 4;
  3690. }
  3691. DOCTEST_INTERNAL_ERROR("Invalid multibyte utf-8 start byte encountered");
  3692. }
  3693. uint32_t headerValue(unsigned char c) {
  3694. if ((c & 0xE0) == 0xC0) {
  3695. return c & 0x1F;
  3696. }
  3697. if ((c & 0xF0) == 0xE0) {
  3698. return c & 0x0F;
  3699. }
  3700. if ((c & 0xF8) == 0xF0) {
  3701. return c & 0x07;
  3702. }
  3703. DOCTEST_INTERNAL_ERROR("Invalid multibyte utf-8 start byte encountered");
  3704. }
  3705. void hexEscapeChar(std::ostream& os, unsigned char c) {
  3706. std::ios_base::fmtflags f(os.flags());
  3707. os << "\\x"
  3708. << std::uppercase << std::hex << std::setfill('0') << std::setw(2)
  3709. << static_cast<int>(c);
  3710. os.flags(f);
  3711. }
  3712. } // anonymous namespace
  3713. XmlEncode::XmlEncode( std::string const& str, ForWhat forWhat )
  3714. : m_str( str ),
  3715. m_forWhat( forWhat )
  3716. {}
  3717. void XmlEncode::encodeTo( std::ostream& os ) const {
  3718. // Apostrophe escaping not necessary if we always use " to write attributes
  3719. // (see: http://www.w3.org/TR/xml/#syntax)
  3720. for( std::size_t idx = 0; idx < m_str.size(); ++ idx ) {
  3721. uchar c = m_str[idx];
  3722. switch (c) {
  3723. case '<': os << "&lt;"; break;
  3724. case '&': os << "&amp;"; break;
  3725. case '>':
  3726. // See: http://www.w3.org/TR/xml/#syntax
  3727. if (idx > 2 && m_str[idx - 1] == ']' && m_str[idx - 2] == ']')
  3728. os << "&gt;";
  3729. else
  3730. os << c;
  3731. break;
  3732. case '\"':
  3733. if (m_forWhat == ForAttributes)
  3734. os << "&quot;";
  3735. else
  3736. os << c;
  3737. break;
  3738. default:
  3739. // Check for control characters and invalid utf-8
  3740. // Escape control characters in standard ascii
  3741. // see http://stackoverflow.com/questions/404107/why-are-control-characters-illegal-in-xml-1-0
  3742. if (c < 0x09 || (c > 0x0D && c < 0x20) || c == 0x7F) {
  3743. hexEscapeChar(os, c);
  3744. break;
  3745. }
  3746. // Plain ASCII: Write it to stream
  3747. if (c < 0x7F) {
  3748. os << c;
  3749. break;
  3750. }
  3751. // UTF-8 territory
  3752. // Check if the encoding is valid and if it is not, hex escape bytes.
  3753. // Important: We do not check the exact decoded values for validity, only the encoding format
  3754. // First check that this bytes is a valid lead byte:
  3755. // This means that it is not encoded as 1111 1XXX
  3756. // Or as 10XX XXXX
  3757. if (c < 0xC0 ||
  3758. c >= 0xF8) {
  3759. hexEscapeChar(os, c);
  3760. break;
  3761. }
  3762. auto encBytes = trailingBytes(c);
  3763. // Are there enough bytes left to avoid accessing out-of-bounds memory?
  3764. if (idx + encBytes - 1 >= m_str.size()) {
  3765. hexEscapeChar(os, c);
  3766. break;
  3767. }
  3768. // The header is valid, check data
  3769. // The next encBytes bytes must together be a valid utf-8
  3770. // This means: bitpattern 10XX XXXX and the extracted value is sane (ish)
  3771. bool valid = true;
  3772. uint32_t value = headerValue(c);
  3773. for (std::size_t n = 1; n < encBytes; ++n) {
  3774. uchar nc = m_str[idx + n];
  3775. valid &= ((nc & 0xC0) == 0x80);
  3776. value = (value << 6) | (nc & 0x3F);
  3777. }
  3778. if (
  3779. // Wrong bit pattern of following bytes
  3780. (!valid) ||
  3781. // Overlong encodings
  3782. (value < 0x80) ||
  3783. ( value < 0x800 && encBytes > 2) || // removed "0x80 <= value &&" because redundant
  3784. (0x800 < value && value < 0x10000 && encBytes > 3) ||
  3785. // Encoded value out of range
  3786. (value >= 0x110000)
  3787. ) {
  3788. hexEscapeChar(os, c);
  3789. break;
  3790. }
  3791. // If we got here, this is in fact a valid(ish) utf-8 sequence
  3792. for (std::size_t n = 0; n < encBytes; ++n) {
  3793. os << m_str[idx + n];
  3794. }
  3795. idx += encBytes - 1;
  3796. break;
  3797. }
  3798. }
  3799. }
  3800. std::ostream& operator << ( std::ostream& os, XmlEncode const& xmlEncode ) {
  3801. xmlEncode.encodeTo( os );
  3802. return os;
  3803. }
  3804. XmlWriter::ScopedElement::ScopedElement( XmlWriter* writer )
  3805. : m_writer( writer )
  3806. {}
  3807. XmlWriter::ScopedElement::ScopedElement( ScopedElement&& other ) noexcept
  3808. : m_writer( other.m_writer ){
  3809. other.m_writer = nullptr;
  3810. }
  3811. /*
  3812. XmlWriter::ScopedElement& XmlWriter::ScopedElement::operator=( ScopedElement&& other ) noexcept {
  3813. if ( m_writer ) {
  3814. m_writer->endElement();
  3815. }
  3816. m_writer = other.m_writer;
  3817. other.m_writer = nullptr;
  3818. return *this;
  3819. }
  3820. */
  3821. XmlWriter::ScopedElement::~ScopedElement() {
  3822. if( m_writer )
  3823. m_writer->endElement();
  3824. }
  3825. XmlWriter::ScopedElement& XmlWriter::ScopedElement::writeText( std::string const& text, bool indent ) {
  3826. m_writer->writeText( text, indent );
  3827. return *this;
  3828. }
  3829. XmlWriter::XmlWriter( std::ostream& os ) : m_os( os )
  3830. {
  3831. writeDeclaration();
  3832. }
  3833. XmlWriter::~XmlWriter() {
  3834. while( !m_tags.empty() )
  3835. endElement();
  3836. }
  3837. XmlWriter& XmlWriter::startElement( std::string const& name ) {
  3838. ensureTagClosed();
  3839. newlineIfNecessary();
  3840. m_os << m_indent << '<' << name;
  3841. m_tags.push_back( name );
  3842. m_indent += " ";
  3843. m_tagIsOpen = true;
  3844. return *this;
  3845. }
  3846. XmlWriter::ScopedElement XmlWriter::scopedElement( std::string const& name ) {
  3847. ScopedElement scoped( this );
  3848. startElement( name );
  3849. return scoped;
  3850. }
  3851. XmlWriter& XmlWriter::endElement() {
  3852. newlineIfNecessary();
  3853. m_indent = m_indent.substr( 0, m_indent.size()-2 );
  3854. if( m_tagIsOpen ) {
  3855. m_os << "/>";
  3856. m_tagIsOpen = false;
  3857. }
  3858. else {
  3859. m_os << m_indent << "</" << m_tags.back() << ">";
  3860. }
  3861. m_os << std::endl;
  3862. m_tags.pop_back();
  3863. return *this;
  3864. }
  3865. XmlWriter& XmlWriter::writeAttribute( std::string const& name, std::string const& attribute ) {
  3866. if( !name.empty() && !attribute.empty() )
  3867. m_os << ' ' << name << "=\"" << XmlEncode( attribute, XmlEncode::ForAttributes ) << '"';
  3868. return *this;
  3869. }
  3870. XmlWriter& XmlWriter::writeAttribute( std::string const& name, const char* attribute ) {
  3871. if( !name.empty() && attribute && attribute[0] != '\0' )
  3872. m_os << ' ' << name << "=\"" << XmlEncode( attribute, XmlEncode::ForAttributes ) << '"';
  3873. return *this;
  3874. }
  3875. XmlWriter& XmlWriter::writeAttribute( std::string const& name, bool attribute ) {
  3876. m_os << ' ' << name << "=\"" << ( attribute ? "true" : "false" ) << '"';
  3877. return *this;
  3878. }
  3879. XmlWriter& XmlWriter::writeText( std::string const& text, bool indent ) {
  3880. if( !text.empty() ){
  3881. bool tagWasOpen = m_tagIsOpen;
  3882. ensureTagClosed();
  3883. if( tagWasOpen && indent )
  3884. m_os << m_indent;
  3885. m_os << XmlEncode( text );
  3886. m_needsNewline = true;
  3887. }
  3888. return *this;
  3889. }
  3890. //XmlWriter& XmlWriter::writeComment( std::string const& text ) {
  3891. // ensureTagClosed();
  3892. // m_os << m_indent << "<!--" << text << "-->";
  3893. // m_needsNewline = true;
  3894. // return *this;
  3895. //}
  3896. //void XmlWriter::writeStylesheetRef( std::string const& url ) {
  3897. // m_os << "<?xml-stylesheet type=\"text/xsl\" href=\"" << url << "\"?>\n";
  3898. //}
  3899. //XmlWriter& XmlWriter::writeBlankLine() {
  3900. // ensureTagClosed();
  3901. // m_os << '\n';
  3902. // return *this;
  3903. //}
  3904. void XmlWriter::ensureTagClosed() {
  3905. if( m_tagIsOpen ) {
  3906. m_os << ">" << std::endl;
  3907. m_tagIsOpen = false;
  3908. }
  3909. }
  3910. void XmlWriter::writeDeclaration() {
  3911. m_os << "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n";
  3912. }
  3913. void XmlWriter::newlineIfNecessary() {
  3914. if( m_needsNewline ) {
  3915. m_os << std::endl;
  3916. m_needsNewline = false;
  3917. }
  3918. }
  3919. // =================================================================================================
  3920. // End of copy-pasted code from Catch
  3921. // =================================================================================================
  3922. // clang-format on
  3923. struct XmlReporter : public IReporter
  3924. {
  3925. XmlWriter xml;
  3926. std::mutex mutex;
  3927. // caching pointers/references to objects of these types - safe to do
  3928. const ContextOptions& opt;
  3929. const TestCaseData* tc = nullptr;
  3930. XmlReporter(const ContextOptions& co)
  3931. : xml(*co.cout)
  3932. , opt(co) {}
  3933. void log_contexts() {
  3934. int num_contexts = get_num_active_contexts();
  3935. if(num_contexts) {
  3936. auto contexts = get_active_contexts();
  3937. std::stringstream ss;
  3938. for(int i = 0; i < num_contexts; ++i) {
  3939. contexts[i]->stringify(&ss);
  3940. xml.scopedElement("Info").writeText(ss.str());
  3941. ss.str("");
  3942. }
  3943. }
  3944. }
  3945. unsigned line(unsigned l) const { return opt.no_line_numbers ? 0 : l; }
  3946. void test_case_start_impl(const TestCaseData& in) {
  3947. bool open_ts_tag = false;
  3948. if(tc != nullptr) { // we have already opened a test suite
  3949. if(strcmp(tc->m_test_suite, in.m_test_suite) != 0) {
  3950. xml.endElement();
  3951. open_ts_tag = true;
  3952. }
  3953. }
  3954. else {
  3955. open_ts_tag = true; // first test case ==> first test suite
  3956. }
  3957. if(open_ts_tag) {
  3958. xml.startElement("TestSuite");
  3959. xml.writeAttribute("name", in.m_test_suite);
  3960. }
  3961. tc = &in;
  3962. xml.startElement("TestCase")
  3963. .writeAttribute("name", in.m_name)
  3964. .writeAttribute("filename", skipPathFromFilename(in.m_file))
  3965. .writeAttribute("line", line(in.m_line))
  3966. .writeAttribute("description", in.m_description);
  3967. if(Approx(in.m_timeout) != 0)
  3968. xml.writeAttribute("timeout", in.m_timeout);
  3969. if(in.m_may_fail)
  3970. xml.writeAttribute("may_fail", true);
  3971. if(in.m_should_fail)
  3972. xml.writeAttribute("should_fail", true);
  3973. }
  3974. // =========================================================================================
  3975. // WHAT FOLLOWS ARE OVERRIDES OF THE VIRTUAL METHODS OF THE REPORTER INTERFACE
  3976. // =========================================================================================
  3977. void report_query(const QueryData& in) override {
  3978. test_run_start();
  3979. if(opt.list_reporters) {
  3980. for(auto& curr : getListeners())
  3981. xml.scopedElement("Listener")
  3982. .writeAttribute("priority", curr.first.first)
  3983. .writeAttribute("name", curr.first.second);
  3984. for(auto& curr : getReporters())
  3985. xml.scopedElement("Reporter")
  3986. .writeAttribute("priority", curr.first.first)
  3987. .writeAttribute("name", curr.first.second);
  3988. } else if(opt.count || opt.list_test_cases) {
  3989. for(unsigned i = 0; i < in.num_data; ++i)
  3990. xml.scopedElement("TestCase").writeAttribute("name", in.data[i]);
  3991. xml.scopedElement("OverallResultsTestCases")
  3992. .writeAttribute("unskipped", in.run_stats->numTestCasesPassingFilters);
  3993. } else if(opt.list_test_suites) {
  3994. for(unsigned i = 0; i < in.num_data; ++i)
  3995. xml.scopedElement("TestSuite").writeAttribute("name", in.data[i]);
  3996. xml.scopedElement("OverallResultsTestCases")
  3997. .writeAttribute("unskipped", in.run_stats->numTestCasesPassingFilters);
  3998. xml.scopedElement("OverallResultsTestSuites")
  3999. .writeAttribute("unskipped", in.run_stats->numTestSuitesPassingFilters);
  4000. }
  4001. xml.endElement();
  4002. }
  4003. void test_run_start() override {
  4004. // remove .exe extension - mainly to have the same output on UNIX and Windows
  4005. std::string binary_name = skipPathFromFilename(opt.binary_name.c_str());
  4006. #ifdef DOCTEST_PLATFORM_WINDOWS
  4007. if(binary_name.rfind(".exe") != std::string::npos)
  4008. binary_name = binary_name.substr(0, binary_name.length() - 4);
  4009. #endif // DOCTEST_PLATFORM_WINDOWS
  4010. xml.startElement("doctest").writeAttribute("binary", binary_name);
  4011. if(opt.no_version == false)
  4012. xml.writeAttribute("version", DOCTEST_VERSION_STR);
  4013. // only the consequential ones (TODO: filters)
  4014. xml.scopedElement("Options")
  4015. .writeAttribute("order_by", opt.order_by.c_str())
  4016. .writeAttribute("rand_seed", opt.rand_seed)
  4017. .writeAttribute("first", opt.first)
  4018. .writeAttribute("last", opt.last)
  4019. .writeAttribute("abort_after", opt.abort_after)
  4020. .writeAttribute("subcase_filter_levels", opt.subcase_filter_levels)
  4021. .writeAttribute("case_sensitive", opt.case_sensitive)
  4022. .writeAttribute("no_throw", opt.no_throw)
  4023. .writeAttribute("no_skip", opt.no_skip);
  4024. }
  4025. void test_run_end(const TestRunStats& p) override {
  4026. if(tc) // the TestSuite tag - only if there has been at least 1 test case
  4027. xml.endElement();
  4028. xml.scopedElement("OverallResultsAsserts")
  4029. .writeAttribute("successes", p.numAsserts - p.numAssertsFailed)
  4030. .writeAttribute("failures", p.numAssertsFailed);
  4031. xml.startElement("OverallResultsTestCases")
  4032. .writeAttribute("successes",
  4033. p.numTestCasesPassingFilters - p.numTestCasesFailed)
  4034. .writeAttribute("failures", p.numTestCasesFailed);
  4035. if(opt.no_skipped_summary == false)
  4036. xml.writeAttribute("skipped", p.numTestCases - p.numTestCasesPassingFilters);
  4037. xml.endElement();
  4038. xml.endElement();
  4039. }
  4040. void test_case_start(const TestCaseData& in) override {
  4041. test_case_start_impl(in);
  4042. xml.ensureTagClosed();
  4043. }
  4044. void test_case_reenter(const TestCaseData&) override {}
  4045. void test_case_end(const CurrentTestCaseStats& st) override {
  4046. xml.startElement("OverallResultsAsserts")
  4047. .writeAttribute("successes",
  4048. st.numAssertsCurrentTest - st.numAssertsFailedCurrentTest)
  4049. .writeAttribute("failures", st.numAssertsFailedCurrentTest);
  4050. if(opt.duration)
  4051. xml.writeAttribute("duration", st.seconds);
  4052. if(tc->m_expected_failures)
  4053. xml.writeAttribute("expected_failures", tc->m_expected_failures);
  4054. xml.endElement();
  4055. xml.endElement();
  4056. }
  4057. void test_case_exception(const TestCaseException& e) override {
  4058. std::lock_guard<std::mutex> lock(mutex);
  4059. xml.scopedElement("Exception")
  4060. .writeAttribute("crash", e.is_crash)
  4061. .writeText(e.error_string.c_str());
  4062. }
  4063. void subcase_start(const SubcaseSignature& in) override {
  4064. std::lock_guard<std::mutex> lock(mutex);
  4065. xml.startElement("SubCase")
  4066. .writeAttribute("name", in.m_name)
  4067. .writeAttribute("filename", skipPathFromFilename(in.m_file))
  4068. .writeAttribute("line", line(in.m_line));
  4069. xml.ensureTagClosed();
  4070. }
  4071. void subcase_end() override { xml.endElement(); }
  4072. void log_assert(const AssertData& rb) override {
  4073. if(!rb.m_failed && !opt.success)
  4074. return;
  4075. std::lock_guard<std::mutex> lock(mutex);
  4076. xml.startElement("Expression")
  4077. .writeAttribute("success", !rb.m_failed)
  4078. .writeAttribute("type", assertString(rb.m_at))
  4079. .writeAttribute("filename", skipPathFromFilename(rb.m_file))
  4080. .writeAttribute("line", line(rb.m_line));
  4081. xml.scopedElement("Original").writeText(rb.m_expr);
  4082. if(rb.m_threw)
  4083. xml.scopedElement("Exception").writeText(rb.m_exception.c_str());
  4084. if(rb.m_at & assertType::is_throws_as)
  4085. xml.scopedElement("ExpectedException").writeText(rb.m_exception_type);
  4086. if(rb.m_at & assertType::is_throws_with)
  4087. xml.scopedElement("ExpectedExceptionString").writeText(rb.m_exception_string);
  4088. if((rb.m_at & assertType::is_normal) && !rb.m_threw)
  4089. xml.scopedElement("Expanded").writeText(rb.m_decomp.c_str());
  4090. log_contexts();
  4091. xml.endElement();
  4092. }
  4093. void log_message(const MessageData& mb) override {
  4094. std::lock_guard<std::mutex> lock(mutex);
  4095. xml.startElement("Message")
  4096. .writeAttribute("type", failureString(mb.m_severity))
  4097. .writeAttribute("filename", skipPathFromFilename(mb.m_file))
  4098. .writeAttribute("line", line(mb.m_line));
  4099. xml.scopedElement("Text").writeText(mb.m_string.c_str());
  4100. log_contexts();
  4101. xml.endElement();
  4102. }
  4103. void test_case_skipped(const TestCaseData& in) override {
  4104. if(opt.no_skipped_summary == false) {
  4105. test_case_start_impl(in);
  4106. xml.writeAttribute("skipped", "true");
  4107. xml.endElement();
  4108. }
  4109. }
  4110. };
  4111. DOCTEST_REGISTER_REPORTER("xml", 0, XmlReporter);
  4112. struct Whitespace
  4113. {
  4114. int nrSpaces;
  4115. explicit Whitespace(int nr)
  4116. : nrSpaces(nr) {}
  4117. };
  4118. std::ostream& operator<<(std::ostream& out, const Whitespace& ws) {
  4119. if(ws.nrSpaces != 0)
  4120. out << std::setw(ws.nrSpaces) << ' ';
  4121. return out;
  4122. }
  4123. struct ConsoleReporter : public IReporter
  4124. {
  4125. std::ostream& s;
  4126. bool hasLoggedCurrentTestStart;
  4127. std::vector<SubcaseSignature> subcasesStack;
  4128. std::mutex mutex;
  4129. // caching pointers/references to objects of these types - safe to do
  4130. const ContextOptions& opt;
  4131. const TestCaseData* tc;
  4132. ConsoleReporter(const ContextOptions& co)
  4133. : s(*co.cout)
  4134. , opt(co) {}
  4135. ConsoleReporter(const ContextOptions& co, std::ostream& ostr)
  4136. : s(ostr)
  4137. , opt(co) {}
  4138. // =========================================================================================
  4139. // WHAT FOLLOWS ARE HELPERS USED BY THE OVERRIDES OF THE VIRTUAL METHODS OF THE INTERFACE
  4140. // =========================================================================================
  4141. void separator_to_stream() {
  4142. s << Color::Yellow
  4143. << "==============================================================================="
  4144. "\n";
  4145. }
  4146. const char* getSuccessOrFailString(bool success, assertType::Enum at,
  4147. const char* success_str) {
  4148. if(success)
  4149. return success_str;
  4150. return failureString(at);
  4151. }
  4152. Color::Enum getSuccessOrFailColor(bool success, assertType::Enum at) {
  4153. return success ? Color::BrightGreen :
  4154. (at & assertType::is_warn) ? Color::Yellow : Color::Red;
  4155. }
  4156. void successOrFailColoredStringToStream(bool success, assertType::Enum at,
  4157. const char* success_str = "SUCCESS") {
  4158. s << getSuccessOrFailColor(success, at)
  4159. << getSuccessOrFailString(success, at, success_str) << ": ";
  4160. }
  4161. void log_contexts() {
  4162. int num_contexts = get_num_active_contexts();
  4163. if(num_contexts) {
  4164. auto contexts = get_active_contexts();
  4165. s << Color::None << " logged: ";
  4166. for(int i = 0; i < num_contexts; ++i) {
  4167. s << (i == 0 ? "" : " ");
  4168. contexts[i]->stringify(&s);
  4169. s << "\n";
  4170. }
  4171. }
  4172. s << "\n";
  4173. }
  4174. void logTestStart() {
  4175. if(hasLoggedCurrentTestStart)
  4176. return;
  4177. separator_to_stream();
  4178. file_line_to_stream(s, tc->m_file, tc->m_line, "\n");
  4179. if(tc->m_description)
  4180. s << Color::Yellow << "DESCRIPTION: " << Color::None << tc->m_description << "\n";
  4181. if(tc->m_test_suite && tc->m_test_suite[0] != '\0')
  4182. s << Color::Yellow << "TEST SUITE: " << Color::None << tc->m_test_suite << "\n";
  4183. if(strncmp(tc->m_name, " Scenario:", 11) != 0)
  4184. s << Color::None << "TEST CASE: ";
  4185. s << Color::None << tc->m_name << "\n";
  4186. for(auto& curr : subcasesStack)
  4187. if(curr.m_name[0] != '\0')
  4188. s << " " << curr.m_name << "\n";
  4189. s << "\n";
  4190. hasLoggedCurrentTestStart = true;
  4191. }
  4192. void printVersion() {
  4193. if(opt.no_version == false)
  4194. s << Color::Cyan << "[doctest] " << Color::None << "doctest version is \""
  4195. << DOCTEST_VERSION_STR << "\"\n";
  4196. }
  4197. void printIntro() {
  4198. printVersion();
  4199. s << Color::Cyan << "[doctest] " << Color::None
  4200. << "run with \"--" DOCTEST_OPTIONS_PREFIX_DISPLAY "help\" for options\n";
  4201. }
  4202. void printHelp() {
  4203. int sizePrefixDisplay = static_cast<int>(strlen(DOCTEST_OPTIONS_PREFIX_DISPLAY));
  4204. printVersion();
  4205. // clang-format off
  4206. s << Color::Cyan << "[doctest]\n" << Color::None;
  4207. s << Color::Cyan << "[doctest] " << Color::None;
  4208. s << "boolean values: \"1/on/yes/true\" or \"0/off/no/false\"\n";
  4209. s << Color::Cyan << "[doctest] " << Color::None;
  4210. s << "filter values: \"str1,str2,str3\" (comma separated strings)\n";
  4211. s << Color::Cyan << "[doctest]\n" << Color::None;
  4212. s << Color::Cyan << "[doctest] " << Color::None;
  4213. s << "filters use wildcards for matching strings\n";
  4214. s << Color::Cyan << "[doctest] " << Color::None;
  4215. s << "something passes a filter if any of the strings in a filter matches\n";
  4216. #ifndef DOCTEST_CONFIG_NO_UNPREFIXED_OPTIONS
  4217. s << Color::Cyan << "[doctest]\n" << Color::None;
  4218. s << Color::Cyan << "[doctest] " << Color::None;
  4219. s << "ALL FLAGS, OPTIONS AND FILTERS ALSO AVAILABLE WITH A \"" DOCTEST_CONFIG_OPTIONS_PREFIX "\" PREFIX!!!\n";
  4220. #endif
  4221. s << Color::Cyan << "[doctest]\n" << Color::None;
  4222. s << Color::Cyan << "[doctest] " << Color::None;
  4223. s << "Query flags - the program quits after them. Available:\n\n";
  4224. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "?, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "help, -" DOCTEST_OPTIONS_PREFIX_DISPLAY "h "
  4225. << Whitespace(sizePrefixDisplay*0) << "prints this message\n";
  4226. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "v, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "version "
  4227. << Whitespace(sizePrefixDisplay*1) << "prints the version\n";
  4228. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "c, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "count "
  4229. << Whitespace(sizePrefixDisplay*1) << "prints the number of matching tests\n";
  4230. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "ltc, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "list-test-cases "
  4231. << Whitespace(sizePrefixDisplay*1) << "lists all matching tests by name\n";
  4232. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "lts, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "list-test-suites "
  4233. << Whitespace(sizePrefixDisplay*1) << "lists all matching test suites\n";
  4234. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "lr, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "list-reporters "
  4235. << Whitespace(sizePrefixDisplay*1) << "lists all registered reporters\n\n";
  4236. // ================================================================================== << 79
  4237. s << Color::Cyan << "[doctest] " << Color::None;
  4238. s << "The available <int>/<string> options/filters are:\n\n";
  4239. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "tc, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "test-case=<filters> "
  4240. << Whitespace(sizePrefixDisplay*1) << "filters tests by their name\n";
  4241. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "tce, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "test-case-exclude=<filters> "
  4242. << Whitespace(sizePrefixDisplay*1) << "filters OUT tests by their name\n";
  4243. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "sf, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "source-file=<filters> "
  4244. << Whitespace(sizePrefixDisplay*1) << "filters tests by their file\n";
  4245. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "sfe, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "source-file-exclude=<filters> "
  4246. << Whitespace(sizePrefixDisplay*1) << "filters OUT tests by their file\n";
  4247. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "ts, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "test-suite=<filters> "
  4248. << Whitespace(sizePrefixDisplay*1) << "filters tests by their test suite\n";
  4249. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "tse, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "test-suite-exclude=<filters> "
  4250. << Whitespace(sizePrefixDisplay*1) << "filters OUT tests by their test suite\n";
  4251. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "sc, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "subcase=<filters> "
  4252. << Whitespace(sizePrefixDisplay*1) << "filters subcases by their name\n";
  4253. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "sce, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "subcase-exclude=<filters> "
  4254. << Whitespace(sizePrefixDisplay*1) << "filters OUT subcases by their name\n";
  4255. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "r, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "reporters=<filters> "
  4256. << Whitespace(sizePrefixDisplay*1) << "reporters to use (console is default)\n";
  4257. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "o, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "out=<string> "
  4258. << Whitespace(sizePrefixDisplay*1) << "output filename\n";
  4259. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "ob, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "order-by=<string> "
  4260. << Whitespace(sizePrefixDisplay*1) << "how the tests should be ordered\n";
  4261. s << Whitespace(sizePrefixDisplay*3) << " <string> - by [file/suite/name/rand]\n";
  4262. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "rs, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "rand-seed=<int> "
  4263. << Whitespace(sizePrefixDisplay*1) << "seed for random ordering\n";
  4264. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "f, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "first=<int> "
  4265. << Whitespace(sizePrefixDisplay*1) << "the first test passing the filters to\n";
  4266. s << Whitespace(sizePrefixDisplay*3) << " execute - for range-based execution\n";
  4267. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "l, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "last=<int> "
  4268. << Whitespace(sizePrefixDisplay*1) << "the last test passing the filters to\n";
  4269. s << Whitespace(sizePrefixDisplay*3) << " execute - for range-based execution\n";
  4270. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "aa, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "abort-after=<int> "
  4271. << Whitespace(sizePrefixDisplay*1) << "stop after <int> failed assertions\n";
  4272. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "scfl,--" DOCTEST_OPTIONS_PREFIX_DISPLAY "subcase-filter-levels=<int> "
  4273. << Whitespace(sizePrefixDisplay*1) << "apply filters for the first <int> levels\n";
  4274. s << Color::Cyan << "\n[doctest] " << Color::None;
  4275. s << "Bool options - can be used like flags and true is assumed. Available:\n\n";
  4276. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "s, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "success=<bool> "
  4277. << Whitespace(sizePrefixDisplay*1) << "include successful assertions in output\n";
  4278. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "cs, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "case-sensitive=<bool> "
  4279. << Whitespace(sizePrefixDisplay*1) << "filters being treated as case sensitive\n";
  4280. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "e, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "exit=<bool> "
  4281. << Whitespace(sizePrefixDisplay*1) << "exits after the tests finish\n";
  4282. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "d, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "duration=<bool> "
  4283. << Whitespace(sizePrefixDisplay*1) << "prints the time duration of each test\n";
  4284. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "nt, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "no-throw=<bool> "
  4285. << Whitespace(sizePrefixDisplay*1) << "skips exceptions-related assert checks\n";
  4286. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "ne, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "no-exitcode=<bool> "
  4287. << Whitespace(sizePrefixDisplay*1) << "returns (or exits) always with success\n";
  4288. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "nr, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "no-run=<bool> "
  4289. << Whitespace(sizePrefixDisplay*1) << "skips all runtime doctest operations\n";
  4290. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "nv, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "no-version=<bool> "
  4291. << Whitespace(sizePrefixDisplay*1) << "omit the framework version in the output\n";
  4292. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "nc, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "no-colors=<bool> "
  4293. << Whitespace(sizePrefixDisplay*1) << "disables colors in output\n";
  4294. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "fc, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "force-colors=<bool> "
  4295. << Whitespace(sizePrefixDisplay*1) << "use colors even when not in a tty\n";
  4296. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "nb, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "no-breaks=<bool> "
  4297. << Whitespace(sizePrefixDisplay*1) << "disables breakpoints in debuggers\n";
  4298. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "ns, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "no-skip=<bool> "
  4299. << Whitespace(sizePrefixDisplay*1) << "don't skip test cases marked as skip\n";
  4300. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "gfl, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "gnu-file-line=<bool> "
  4301. << Whitespace(sizePrefixDisplay*1) << ":n: vs (n): for line numbers in output\n";
  4302. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "npf, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "no-path-filenames=<bool> "
  4303. << Whitespace(sizePrefixDisplay*1) << "only filenames and no paths in output\n";
  4304. s << " -" DOCTEST_OPTIONS_PREFIX_DISPLAY "nln, --" DOCTEST_OPTIONS_PREFIX_DISPLAY "no-line-numbers=<bool> "
  4305. << Whitespace(sizePrefixDisplay*1) << "0 instead of real line numbers in output\n";
  4306. // ================================================================================== << 79
  4307. // clang-format on
  4308. s << Color::Cyan << "\n[doctest] " << Color::None;
  4309. s << "for more information visit the project documentation\n\n";
  4310. }
  4311. void printRegisteredReporters() {
  4312. printVersion();
  4313. auto printReporters = [this] (const reporterMap& reporters, const char* type) {
  4314. if(reporters.size()) {
  4315. s << Color::Cyan << "[doctest] " << Color::None << "listing all registered " << type << "\n";
  4316. for(auto& curr : reporters)
  4317. s << "priority: " << std::setw(5) << curr.first.first
  4318. << " name: " << curr.first.second << "\n";
  4319. }
  4320. };
  4321. printReporters(getListeners(), "listeners");
  4322. printReporters(getReporters(), "reporters");
  4323. }
  4324. void list_query_results() {
  4325. separator_to_stream();
  4326. if(opt.count || opt.list_test_cases) {
  4327. s << Color::Cyan << "[doctest] " << Color::None
  4328. << "unskipped test cases passing the current filters: "
  4329. << g_cs->numTestCasesPassingFilters << "\n";
  4330. } else if(opt.list_test_suites) {
  4331. s << Color::Cyan << "[doctest] " << Color::None
  4332. << "unskipped test cases passing the current filters: "
  4333. << g_cs->numTestCasesPassingFilters << "\n";
  4334. s << Color::Cyan << "[doctest] " << Color::None
  4335. << "test suites with unskipped test cases passing the current filters: "
  4336. << g_cs->numTestSuitesPassingFilters << "\n";
  4337. }
  4338. }
  4339. // =========================================================================================
  4340. // WHAT FOLLOWS ARE OVERRIDES OF THE VIRTUAL METHODS OF THE REPORTER INTERFACE
  4341. // =========================================================================================
  4342. void report_query(const QueryData& in) override {
  4343. if(opt.version) {
  4344. printVersion();
  4345. } else if(opt.help) {
  4346. printHelp();
  4347. } else if(opt.list_reporters) {
  4348. printRegisteredReporters();
  4349. } else if(opt.count || opt.list_test_cases) {
  4350. if(opt.list_test_cases) {
  4351. s << Color::Cyan << "[doctest] " << Color::None
  4352. << "listing all test case names\n";
  4353. separator_to_stream();
  4354. }
  4355. for(unsigned i = 0; i < in.num_data; ++i)
  4356. s << Color::None << in.data[i] << "\n";
  4357. separator_to_stream();
  4358. s << Color::Cyan << "[doctest] " << Color::None
  4359. << "unskipped test cases passing the current filters: "
  4360. << g_cs->numTestCasesPassingFilters << "\n";
  4361. } else if(opt.list_test_suites) {
  4362. s << Color::Cyan << "[doctest] " << Color::None << "listing all test suites\n";
  4363. separator_to_stream();
  4364. for(unsigned i = 0; i < in.num_data; ++i)
  4365. s << Color::None << in.data[i] << "\n";
  4366. separator_to_stream();
  4367. s << Color::Cyan << "[doctest] " << Color::None
  4368. << "unskipped test cases passing the current filters: "
  4369. << g_cs->numTestCasesPassingFilters << "\n";
  4370. s << Color::Cyan << "[doctest] " << Color::None
  4371. << "test suites with unskipped test cases passing the current filters: "
  4372. << g_cs->numTestSuitesPassingFilters << "\n";
  4373. }
  4374. }
  4375. void test_run_start() override { printIntro(); }
  4376. void test_run_end(const TestRunStats& p) override {
  4377. separator_to_stream();
  4378. const bool anythingFailed = p.numTestCasesFailed > 0 || p.numAssertsFailed > 0;
  4379. s << Color::Cyan << "[doctest] " << Color::None << "test cases: " << std::setw(6)
  4380. << p.numTestCasesPassingFilters << " | "
  4381. << ((p.numTestCasesPassingFilters == 0 || anythingFailed) ? Color::None :
  4382. Color::Green)
  4383. << std::setw(6) << p.numTestCasesPassingFilters - p.numTestCasesFailed << " passed"
  4384. << Color::None << " | " << (p.numTestCasesFailed > 0 ? Color::Red : Color::None)
  4385. << std::setw(6) << p.numTestCasesFailed << " failed" << Color::None << " | ";
  4386. if(opt.no_skipped_summary == false) {
  4387. const int numSkipped = p.numTestCases - p.numTestCasesPassingFilters;
  4388. s << (numSkipped == 0 ? Color::None : Color::Yellow) << std::setw(6) << numSkipped
  4389. << " skipped" << Color::None;
  4390. }
  4391. s << "\n";
  4392. s << Color::Cyan << "[doctest] " << Color::None << "assertions: " << std::setw(6)
  4393. << p.numAsserts << " | "
  4394. << ((p.numAsserts == 0 || anythingFailed) ? Color::None : Color::Green)
  4395. << std::setw(6) << (p.numAsserts - p.numAssertsFailed) << " passed" << Color::None
  4396. << " | " << (p.numAssertsFailed > 0 ? Color::Red : Color::None) << std::setw(6)
  4397. << p.numAssertsFailed << " failed" << Color::None << " |\n";
  4398. s << Color::Cyan << "[doctest] " << Color::None
  4399. << "Status: " << (p.numTestCasesFailed > 0 ? Color::Red : Color::Green)
  4400. << ((p.numTestCasesFailed > 0) ? "FAILURE!" : "SUCCESS!") << Color::None << std::endl;
  4401. }
  4402. void test_case_start(const TestCaseData& in) override {
  4403. hasLoggedCurrentTestStart = false;
  4404. tc = &in;
  4405. }
  4406. void test_case_reenter(const TestCaseData&) override {}
  4407. void test_case_end(const CurrentTestCaseStats& st) override {
  4408. // log the preamble of the test case only if there is something
  4409. // else to print - something other than that an assert has failed
  4410. if(opt.duration ||
  4411. (st.failure_flags && st.failure_flags != TestCaseFailureReason::AssertFailure))
  4412. logTestStart();
  4413. if(opt.duration)
  4414. s << Color::None << std::setprecision(6) << std::fixed << st.seconds
  4415. << " s: " << tc->m_name << "\n";
  4416. if(st.failure_flags & TestCaseFailureReason::Timeout)
  4417. s << Color::Red << "Test case exceeded time limit of " << std::setprecision(6)
  4418. << std::fixed << tc->m_timeout << "!\n";
  4419. if(st.failure_flags & TestCaseFailureReason::ShouldHaveFailedButDidnt) {
  4420. s << Color::Red << "Should have failed but didn't! Marking it as failed!\n";
  4421. } else if(st.failure_flags & TestCaseFailureReason::ShouldHaveFailedAndDid) {
  4422. s << Color::Yellow << "Failed as expected so marking it as not failed\n";
  4423. } else if(st.failure_flags & TestCaseFailureReason::CouldHaveFailedAndDid) {
  4424. s << Color::Yellow << "Allowed to fail so marking it as not failed\n";
  4425. } else if(st.failure_flags & TestCaseFailureReason::DidntFailExactlyNumTimes) {
  4426. s << Color::Red << "Didn't fail exactly " << tc->m_expected_failures
  4427. << " times so marking it as failed!\n";
  4428. } else if(st.failure_flags & TestCaseFailureReason::FailedExactlyNumTimes) {
  4429. s << Color::Yellow << "Failed exactly " << tc->m_expected_failures
  4430. << " times as expected so marking it as not failed!\n";
  4431. }
  4432. if(st.failure_flags & TestCaseFailureReason::TooManyFailedAsserts) {
  4433. s << Color::Red << "Aborting - too many failed asserts!\n";
  4434. }
  4435. s << Color::None; // lgtm [cpp/useless-expression]
  4436. }
  4437. void test_case_exception(const TestCaseException& e) override {
  4438. logTestStart();
  4439. file_line_to_stream(s, tc->m_file, tc->m_line, " ");
  4440. successOrFailColoredStringToStream(false, e.is_crash ? assertType::is_require :
  4441. assertType::is_check);
  4442. s << Color::Red << (e.is_crash ? "test case CRASHED: " : "test case THREW exception: ")
  4443. << Color::Cyan << e.error_string << "\n";
  4444. int num_stringified_contexts = get_num_stringified_contexts();
  4445. if(num_stringified_contexts) {
  4446. auto stringified_contexts = get_stringified_contexts();
  4447. s << Color::None << " logged: ";
  4448. for(int i = num_stringified_contexts; i > 0; --i) {
  4449. s << (i == num_stringified_contexts ? "" : " ")
  4450. << stringified_contexts[i - 1] << "\n";
  4451. }
  4452. }
  4453. s << "\n" << Color::None;
  4454. }
  4455. void subcase_start(const SubcaseSignature& subc) override {
  4456. std::lock_guard<std::mutex> lock(mutex);
  4457. subcasesStack.push_back(subc);
  4458. hasLoggedCurrentTestStart = false;
  4459. }
  4460. void subcase_end() override {
  4461. std::lock_guard<std::mutex> lock(mutex);
  4462. subcasesStack.pop_back();
  4463. hasLoggedCurrentTestStart = false;
  4464. }
  4465. void log_assert(const AssertData& rb) override {
  4466. if(!rb.m_failed && !opt.success)
  4467. return;
  4468. std::lock_guard<std::mutex> lock(mutex);
  4469. logTestStart();
  4470. file_line_to_stream(s, rb.m_file, rb.m_line, " ");
  4471. successOrFailColoredStringToStream(!rb.m_failed, rb.m_at);
  4472. if((rb.m_at & (assertType::is_throws_as | assertType::is_throws_with)) ==
  4473. 0) //!OCLINT bitwise operator in conditional
  4474. s << Color::Cyan << assertString(rb.m_at) << "( " << rb.m_expr << " ) "
  4475. << Color::None;
  4476. if(rb.m_at & assertType::is_throws) { //!OCLINT bitwise operator in conditional
  4477. s << (rb.m_threw ? "threw as expected!" : "did NOT throw at all!") << "\n";
  4478. } else if((rb.m_at & assertType::is_throws_as) &&
  4479. (rb.m_at & assertType::is_throws_with)) { //!OCLINT
  4480. s << Color::Cyan << assertString(rb.m_at) << "( " << rb.m_expr << ", \""
  4481. << rb.m_exception_string << "\", " << rb.m_exception_type << " ) " << Color::None;
  4482. if(rb.m_threw) {
  4483. if(!rb.m_failed) {
  4484. s << "threw as expected!\n";
  4485. } else {
  4486. s << "threw a DIFFERENT exception! (contents: " << rb.m_exception << ")\n";
  4487. }
  4488. } else {
  4489. s << "did NOT throw at all!\n";
  4490. }
  4491. } else if(rb.m_at &
  4492. assertType::is_throws_as) { //!OCLINT bitwise operator in conditional
  4493. s << Color::Cyan << assertString(rb.m_at) << "( " << rb.m_expr << ", "
  4494. << rb.m_exception_type << " ) " << Color::None
  4495. << (rb.m_threw ? (rb.m_threw_as ? "threw as expected!" :
  4496. "threw a DIFFERENT exception: ") :
  4497. "did NOT throw at all!")
  4498. << Color::Cyan << rb.m_exception << "\n";
  4499. } else if(rb.m_at &
  4500. assertType::is_throws_with) { //!OCLINT bitwise operator in conditional
  4501. s << Color::Cyan << assertString(rb.m_at) << "( " << rb.m_expr << ", \""
  4502. << rb.m_exception_string << "\" ) " << Color::None
  4503. << (rb.m_threw ? (!rb.m_failed ? "threw as expected!" :
  4504. "threw a DIFFERENT exception: ") :
  4505. "did NOT throw at all!")
  4506. << Color::Cyan << rb.m_exception << "\n";
  4507. } else if(rb.m_at & assertType::is_nothrow) { //!OCLINT bitwise operator in conditional
  4508. s << (rb.m_threw ? "THREW exception: " : "didn't throw!") << Color::Cyan
  4509. << rb.m_exception << "\n";
  4510. } else {
  4511. s << (rb.m_threw ? "THREW exception: " :
  4512. (!rb.m_failed ? "is correct!\n" : "is NOT correct!\n"));
  4513. if(rb.m_threw)
  4514. s << rb.m_exception << "\n";
  4515. else
  4516. s << " values: " << assertString(rb.m_at) << "( " << rb.m_decomp << " )\n";
  4517. }
  4518. log_contexts();
  4519. }
  4520. void log_message(const MessageData& mb) override {
  4521. std::lock_guard<std::mutex> lock(mutex);
  4522. logTestStart();
  4523. file_line_to_stream(s, mb.m_file, mb.m_line, " ");
  4524. s << getSuccessOrFailColor(false, mb.m_severity)
  4525. << getSuccessOrFailString(mb.m_severity & assertType::is_warn, mb.m_severity,
  4526. "MESSAGE") << ": ";
  4527. s << Color::None << mb.m_string << "\n";
  4528. log_contexts();
  4529. }
  4530. void test_case_skipped(const TestCaseData&) override {}
  4531. };
  4532. DOCTEST_REGISTER_REPORTER("console", 0, ConsoleReporter);
  4533. #ifdef DOCTEST_PLATFORM_WINDOWS
  4534. struct DebugOutputWindowReporter : public ConsoleReporter
  4535. {
  4536. DOCTEST_THREAD_LOCAL static std::ostringstream oss;
  4537. DebugOutputWindowReporter(const ContextOptions& co)
  4538. : ConsoleReporter(co, oss) {}
  4539. #define DOCTEST_DEBUG_OUTPUT_REPORTER_OVERRIDE(func, type, arg) \
  4540. void func(type arg) override { \
  4541. bool with_col = g_no_colors; \
  4542. g_no_colors = false; \
  4543. ConsoleReporter::func(arg); \
  4544. DOCTEST_OUTPUT_DEBUG_STRING(oss.str().c_str()); \
  4545. oss.str(""); \
  4546. g_no_colors = with_col; \
  4547. }
  4548. DOCTEST_DEBUG_OUTPUT_REPORTER_OVERRIDE(test_run_start, DOCTEST_EMPTY, DOCTEST_EMPTY)
  4549. DOCTEST_DEBUG_OUTPUT_REPORTER_OVERRIDE(test_run_end, const TestRunStats&, in)
  4550. DOCTEST_DEBUG_OUTPUT_REPORTER_OVERRIDE(test_case_start, const TestCaseData&, in)
  4551. DOCTEST_DEBUG_OUTPUT_REPORTER_OVERRIDE(test_case_reenter, const TestCaseData&, in)
  4552. DOCTEST_DEBUG_OUTPUT_REPORTER_OVERRIDE(test_case_end, const CurrentTestCaseStats&, in)
  4553. DOCTEST_DEBUG_OUTPUT_REPORTER_OVERRIDE(test_case_exception, const TestCaseException&, in)
  4554. DOCTEST_DEBUG_OUTPUT_REPORTER_OVERRIDE(subcase_start, const SubcaseSignature&, in)
  4555. DOCTEST_DEBUG_OUTPUT_REPORTER_OVERRIDE(subcase_end, DOCTEST_EMPTY, DOCTEST_EMPTY)
  4556. DOCTEST_DEBUG_OUTPUT_REPORTER_OVERRIDE(log_assert, const AssertData&, in)
  4557. DOCTEST_DEBUG_OUTPUT_REPORTER_OVERRIDE(log_message, const MessageData&, in)
  4558. DOCTEST_DEBUG_OUTPUT_REPORTER_OVERRIDE(test_case_skipped, const TestCaseData&, in)
  4559. };
  4560. DOCTEST_THREAD_LOCAL std::ostringstream DebugOutputWindowReporter::oss;
  4561. #endif // DOCTEST_PLATFORM_WINDOWS
  4562. // the implementation of parseOption()
  4563. bool parseOptionImpl(int argc, const char* const* argv, const char* pattern, String* value) {
  4564. // going from the end to the beginning and stopping on the first occurrence from the end
  4565. for(int i = argc; i > 0; --i) {
  4566. auto index = i - 1;
  4567. auto temp = std::strstr(argv[index], pattern);
  4568. if(temp && (value || strlen(temp) == strlen(pattern))) { //!OCLINT prefer early exits and continue
  4569. // eliminate matches in which the chars before the option are not '-'
  4570. bool noBadCharsFound = true;
  4571. auto curr = argv[index];
  4572. while(curr != temp) {
  4573. if(*curr++ != '-') {
  4574. noBadCharsFound = false;
  4575. break;
  4576. }
  4577. }
  4578. if(noBadCharsFound && argv[index][0] == '-') {
  4579. if(value) {
  4580. // parsing the value of an option
  4581. temp += strlen(pattern);
  4582. const unsigned len = strlen(temp);
  4583. if(len) {
  4584. *value = temp;
  4585. return true;
  4586. }
  4587. } else {
  4588. // just a flag - no value
  4589. return true;
  4590. }
  4591. }
  4592. }
  4593. }
  4594. return false;
  4595. }
  4596. // parses an option and returns the string after the '=' character
  4597. bool parseOption(int argc, const char* const* argv, const char* pattern, String* value = nullptr,
  4598. const String& defaultVal = String()) {
  4599. if(value)
  4600. *value = defaultVal;
  4601. #ifndef DOCTEST_CONFIG_NO_UNPREFIXED_OPTIONS
  4602. // offset (normally 3 for "dt-") to skip prefix
  4603. if(parseOptionImpl(argc, argv, pattern + strlen(DOCTEST_CONFIG_OPTIONS_PREFIX), value))
  4604. return true;
  4605. #endif // DOCTEST_CONFIG_NO_UNPREFIXED_OPTIONS
  4606. return parseOptionImpl(argc, argv, pattern, value);
  4607. }
  4608. // locates a flag on the command line
  4609. bool parseFlag(int argc, const char* const* argv, const char* pattern) {
  4610. return parseOption(argc, argv, pattern);
  4611. }
  4612. // parses a comma separated list of words after a pattern in one of the arguments in argv
  4613. bool parseCommaSepArgs(int argc, const char* const* argv, const char* pattern,
  4614. std::vector<String>& res) {
  4615. String filtersString;
  4616. if(parseOption(argc, argv, pattern, &filtersString)) {
  4617. // tokenize with "," as a separator
  4618. // cppcheck-suppress strtokCalled
  4619. DOCTEST_CLANG_SUPPRESS_WARNING_WITH_PUSH("-Wdeprecated-declarations")
  4620. auto pch = std::strtok(filtersString.c_str(), ","); // modifies the string
  4621. while(pch != nullptr) {
  4622. if(strlen(pch))
  4623. res.push_back(pch);
  4624. // uses the strtok() internal state to go to the next token
  4625. // cppcheck-suppress strtokCalled
  4626. pch = std::strtok(nullptr, ",");
  4627. }
  4628. DOCTEST_CLANG_SUPPRESS_WARNING_POP
  4629. return true;
  4630. }
  4631. return false;
  4632. }
  4633. enum optionType
  4634. {
  4635. option_bool,
  4636. option_int
  4637. };
  4638. // parses an int/bool option from the command line
  4639. bool parseIntOption(int argc, const char* const* argv, const char* pattern, optionType type,
  4640. int& res) {
  4641. String parsedValue;
  4642. if(!parseOption(argc, argv, pattern, &parsedValue))
  4643. return false;
  4644. if(type == 0) {
  4645. // boolean
  4646. const char positive[][5] = {"1", "true", "on", "yes"}; // 5 - strlen("true") + 1
  4647. const char negative[][6] = {"0", "false", "off", "no"}; // 6 - strlen("false") + 1
  4648. // if the value matches any of the positive/negative possibilities
  4649. for(unsigned i = 0; i < 4; i++) {
  4650. if(parsedValue.compare(positive[i], true) == 0) {
  4651. res = 1; //!OCLINT parameter reassignment
  4652. return true;
  4653. }
  4654. if(parsedValue.compare(negative[i], true) == 0) {
  4655. res = 0; //!OCLINT parameter reassignment
  4656. return true;
  4657. }
  4658. }
  4659. } else {
  4660. // integer
  4661. // TODO: change this to use std::stoi or something else! currently it uses undefined behavior - assumes '0' on failed parse...
  4662. int theInt = std::atoi(parsedValue.c_str()); // NOLINT
  4663. if(theInt != 0) {
  4664. res = theInt; //!OCLINT parameter reassignment
  4665. return true;
  4666. }
  4667. }
  4668. return false;
  4669. }
  4670. } // namespace
  4671. Context::Context(int argc, const char* const* argv)
  4672. : p(new detail::ContextState) {
  4673. parseArgs(argc, argv, true);
  4674. if(argc)
  4675. p->binary_name = argv[0];
  4676. }
  4677. Context::~Context() {
  4678. if(g_cs == p)
  4679. g_cs = nullptr;
  4680. delete p;
  4681. }
  4682. void Context::applyCommandLine(int argc, const char* const* argv) {
  4683. parseArgs(argc, argv);
  4684. if(argc)
  4685. p->binary_name = argv[0];
  4686. }
  4687. // parses args
  4688. void Context::parseArgs(int argc, const char* const* argv, bool withDefaults) {
  4689. using namespace detail;
  4690. // clang-format off
  4691. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "source-file=", p->filters[0]);
  4692. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "sf=", p->filters[0]);
  4693. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "source-file-exclude=",p->filters[1]);
  4694. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "sfe=", p->filters[1]);
  4695. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "test-suite=", p->filters[2]);
  4696. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "ts=", p->filters[2]);
  4697. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "test-suite-exclude=", p->filters[3]);
  4698. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "tse=", p->filters[3]);
  4699. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "test-case=", p->filters[4]);
  4700. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "tc=", p->filters[4]);
  4701. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "test-case-exclude=", p->filters[5]);
  4702. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "tce=", p->filters[5]);
  4703. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "subcase=", p->filters[6]);
  4704. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "sc=", p->filters[6]);
  4705. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "subcase-exclude=", p->filters[7]);
  4706. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "sce=", p->filters[7]);
  4707. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "reporters=", p->filters[8]);
  4708. parseCommaSepArgs(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "r=", p->filters[8]);
  4709. // clang-format on
  4710. int intRes = 0;
  4711. String strRes;
  4712. #define DOCTEST_PARSE_AS_BOOL_OR_FLAG(name, sname, var, default) \
  4713. if(parseIntOption(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX name "=", option_bool, intRes) || \
  4714. parseIntOption(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX sname "=", option_bool, intRes)) \
  4715. p->var = !!intRes; \
  4716. else if(parseFlag(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX name) || \
  4717. parseFlag(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX sname)) \
  4718. p->var = true; \
  4719. else if(withDefaults) \
  4720. p->var = default
  4721. #define DOCTEST_PARSE_INT_OPTION(name, sname, var, default) \
  4722. if(parseIntOption(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX name "=", option_int, intRes) || \
  4723. parseIntOption(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX sname "=", option_int, intRes)) \
  4724. p->var = intRes; \
  4725. else if(withDefaults) \
  4726. p->var = default
  4727. #define DOCTEST_PARSE_STR_OPTION(name, sname, var, default) \
  4728. if(parseOption(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX name "=", &strRes, default) || \
  4729. parseOption(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX sname "=", &strRes, default) || \
  4730. withDefaults) \
  4731. p->var = strRes
  4732. // clang-format off
  4733. DOCTEST_PARSE_STR_OPTION("out", "o", out, "");
  4734. DOCTEST_PARSE_STR_OPTION("order-by", "ob", order_by, "file");
  4735. DOCTEST_PARSE_INT_OPTION("rand-seed", "rs", rand_seed, 0);
  4736. DOCTEST_PARSE_INT_OPTION("first", "f", first, 0);
  4737. DOCTEST_PARSE_INT_OPTION("last", "l", last, UINT_MAX);
  4738. DOCTEST_PARSE_INT_OPTION("abort-after", "aa", abort_after, 0);
  4739. DOCTEST_PARSE_INT_OPTION("subcase-filter-levels", "scfl", subcase_filter_levels, INT_MAX);
  4740. DOCTEST_PARSE_AS_BOOL_OR_FLAG("success", "s", success, false);
  4741. DOCTEST_PARSE_AS_BOOL_OR_FLAG("case-sensitive", "cs", case_sensitive, false);
  4742. DOCTEST_PARSE_AS_BOOL_OR_FLAG("exit", "e", exit, false);
  4743. DOCTEST_PARSE_AS_BOOL_OR_FLAG("duration", "d", duration, false);
  4744. DOCTEST_PARSE_AS_BOOL_OR_FLAG("no-throw", "nt", no_throw, false);
  4745. DOCTEST_PARSE_AS_BOOL_OR_FLAG("no-exitcode", "ne", no_exitcode, false);
  4746. DOCTEST_PARSE_AS_BOOL_OR_FLAG("no-run", "nr", no_run, false);
  4747. DOCTEST_PARSE_AS_BOOL_OR_FLAG("no-version", "nv", no_version, false);
  4748. DOCTEST_PARSE_AS_BOOL_OR_FLAG("no-colors", "nc", no_colors, false);
  4749. DOCTEST_PARSE_AS_BOOL_OR_FLAG("force-colors", "fc", force_colors, false);
  4750. DOCTEST_PARSE_AS_BOOL_OR_FLAG("no-breaks", "nb", no_breaks, false);
  4751. DOCTEST_PARSE_AS_BOOL_OR_FLAG("no-skip", "ns", no_skip, false);
  4752. DOCTEST_PARSE_AS_BOOL_OR_FLAG("gnu-file-line", "gfl", gnu_file_line, !bool(DOCTEST_MSVC));
  4753. DOCTEST_PARSE_AS_BOOL_OR_FLAG("no-path-filenames", "npf", no_path_in_filenames, false);
  4754. DOCTEST_PARSE_AS_BOOL_OR_FLAG("no-line-numbers", "nln", no_line_numbers, false);
  4755. DOCTEST_PARSE_AS_BOOL_OR_FLAG("no-skipped-summary", "nss", no_skipped_summary, false);
  4756. // clang-format on
  4757. if(withDefaults) {
  4758. p->help = false;
  4759. p->version = false;
  4760. p->count = false;
  4761. p->list_test_cases = false;
  4762. p->list_test_suites = false;
  4763. p->list_reporters = false;
  4764. }
  4765. if(parseFlag(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "help") ||
  4766. parseFlag(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "h") ||
  4767. parseFlag(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "?")) {
  4768. p->help = true;
  4769. p->exit = true;
  4770. }
  4771. if(parseFlag(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "version") ||
  4772. parseFlag(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "v")) {
  4773. p->version = true;
  4774. p->exit = true;
  4775. }
  4776. if(parseFlag(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "count") ||
  4777. parseFlag(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "c")) {
  4778. p->count = true;
  4779. p->exit = true;
  4780. }
  4781. if(parseFlag(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "list-test-cases") ||
  4782. parseFlag(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "ltc")) {
  4783. p->list_test_cases = true;
  4784. p->exit = true;
  4785. }
  4786. if(parseFlag(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "list-test-suites") ||
  4787. parseFlag(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "lts")) {
  4788. p->list_test_suites = true;
  4789. p->exit = true;
  4790. }
  4791. if(parseFlag(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "list-reporters") ||
  4792. parseFlag(argc, argv, DOCTEST_CONFIG_OPTIONS_PREFIX "lr")) {
  4793. p->list_reporters = true;
  4794. p->exit = true;
  4795. }
  4796. }
  4797. // allows the user to add procedurally to the filters from the command line
  4798. void Context::addFilter(const char* filter, const char* value) { setOption(filter, value); }
  4799. // allows the user to clear all filters from the command line
  4800. void Context::clearFilters() {
  4801. for(auto& curr : p->filters)
  4802. curr.clear();
  4803. }
  4804. // allows the user to override procedurally the int/bool options from the command line
  4805. void Context::setOption(const char* option, int value) {
  4806. setOption(option, toString(value).c_str());
  4807. }
  4808. // allows the user to override procedurally the string options from the command line
  4809. void Context::setOption(const char* option, const char* value) {
  4810. auto argv = String("-") + option + "=" + value;
  4811. auto lvalue = argv.c_str();
  4812. parseArgs(1, &lvalue);
  4813. }
  4814. // users should query this in their main() and exit the program if true
  4815. bool Context::shouldExit() { return p->exit; }
  4816. void Context::setAsDefaultForAssertsOutOfTestCases() { g_cs = p; }
  4817. void Context::setAssertHandler(detail::assert_handler ah) { p->ah = ah; }
  4818. // the main function that does all the filtering and test running
  4819. int Context::run() {
  4820. using namespace detail;
  4821. // save the old context state in case such was setup - for using asserts out of a testing context
  4822. auto old_cs = g_cs;
  4823. // this is the current contest
  4824. g_cs = p;
  4825. is_running_in_test = true;
  4826. g_no_colors = p->no_colors;
  4827. p->resetRunData();
  4828. // stdout by default
  4829. p->cout = &std::cout;
  4830. p->cerr = &std::cerr;
  4831. // or to a file if specified
  4832. std::fstream fstr;
  4833. if(p->out.size()) {
  4834. fstr.open(p->out.c_str(), std::fstream::out);
  4835. p->cout = &fstr;
  4836. }
  4837. auto cleanup_and_return = [&]() {
  4838. if(fstr.is_open())
  4839. fstr.close();
  4840. // restore context
  4841. g_cs = old_cs;
  4842. is_running_in_test = false;
  4843. // we have to free the reporters which were allocated when the run started
  4844. for(auto& curr : p->reporters_currently_used)
  4845. delete curr;
  4846. p->reporters_currently_used.clear();
  4847. if(p->numTestCasesFailed && !p->no_exitcode)
  4848. return EXIT_FAILURE;
  4849. return EXIT_SUCCESS;
  4850. };
  4851. // setup default reporter if none is given through the command line
  4852. if(p->filters[8].empty())
  4853. p->filters[8].push_back("console");
  4854. // check to see if any of the registered reporters has been selected
  4855. for(auto& curr : getReporters()) {
  4856. if(matchesAny(curr.first.second.c_str(), p->filters[8], false, p->case_sensitive))
  4857. p->reporters_currently_used.push_back(curr.second(*g_cs));
  4858. }
  4859. // TODO: check if there is nothing in reporters_currently_used
  4860. // prepend all listeners
  4861. for(auto& curr : getListeners())
  4862. p->reporters_currently_used.insert(p->reporters_currently_used.begin(), curr.second(*g_cs));
  4863. #ifdef DOCTEST_PLATFORM_WINDOWS
  4864. if(isDebuggerActive())
  4865. p->reporters_currently_used.push_back(new DebugOutputWindowReporter(*g_cs));
  4866. #endif // DOCTEST_PLATFORM_WINDOWS
  4867. // handle version, help and no_run
  4868. if(p->no_run || p->version || p->help || p->list_reporters) {
  4869. DOCTEST_ITERATE_THROUGH_REPORTERS(report_query, QueryData());
  4870. return cleanup_and_return();
  4871. }
  4872. std::vector<const TestCase*> testArray;
  4873. for(auto& curr : getRegisteredTests())
  4874. testArray.push_back(&curr);
  4875. p->numTestCases = testArray.size();
  4876. // sort the collected records
  4877. if(!testArray.empty()) {
  4878. if(p->order_by.compare("file", true) == 0) {
  4879. std::sort(testArray.begin(), testArray.end(), fileOrderComparator);
  4880. } else if(p->order_by.compare("suite", true) == 0) {
  4881. std::sort(testArray.begin(), testArray.end(), suiteOrderComparator);
  4882. } else if(p->order_by.compare("name", true) == 0) {
  4883. std::sort(testArray.begin(), testArray.end(), nameOrderComparator);
  4884. } else if(p->order_by.compare("rand", true) == 0) {
  4885. std::srand(p->rand_seed);
  4886. // random_shuffle implementation
  4887. const auto first = &testArray[0];
  4888. for(size_t i = testArray.size() - 1; i > 0; --i) {
  4889. int idxToSwap = std::rand() % (i + 1); // NOLINT
  4890. const auto temp = first[i];
  4891. first[i] = first[idxToSwap];
  4892. first[idxToSwap] = temp;
  4893. }
  4894. }
  4895. }
  4896. std::set<String> testSuitesPassingFilt;
  4897. bool query_mode = p->count || p->list_test_cases || p->list_test_suites;
  4898. std::vector<String> queryResults;
  4899. if(!query_mode)
  4900. DOCTEST_ITERATE_THROUGH_REPORTERS(test_run_start, DOCTEST_EMPTY);
  4901. // invoke the registered functions if they match the filter criteria (or just count them)
  4902. for(auto& curr : testArray) {
  4903. const auto& tc = *curr;
  4904. bool skip_me = false;
  4905. if(tc.m_skip && !p->no_skip)
  4906. skip_me = true;
  4907. if(!matchesAny(tc.m_file, p->filters[0], true, p->case_sensitive))
  4908. skip_me = true;
  4909. if(matchesAny(tc.m_file, p->filters[1], false, p->case_sensitive))
  4910. skip_me = true;
  4911. if(!matchesAny(tc.m_test_suite, p->filters[2], true, p->case_sensitive))
  4912. skip_me = true;
  4913. if(matchesAny(tc.m_test_suite, p->filters[3], false, p->case_sensitive))
  4914. skip_me = true;
  4915. if(!matchesAny(tc.m_name, p->filters[4], true, p->case_sensitive))
  4916. skip_me = true;
  4917. if(matchesAny(tc.m_name, p->filters[5], false, p->case_sensitive))
  4918. skip_me = true;
  4919. if(!skip_me)
  4920. p->numTestCasesPassingFilters++;
  4921. // skip the test if it is not in the execution range
  4922. if((p->last < p->numTestCasesPassingFilters && p->first <= p->last) ||
  4923. (p->first > p->numTestCasesPassingFilters))
  4924. skip_me = true;
  4925. if(skip_me) {
  4926. if(!query_mode)
  4927. DOCTEST_ITERATE_THROUGH_REPORTERS(test_case_skipped, tc);
  4928. continue;
  4929. }
  4930. // do not execute the test if we are to only count the number of filter passing tests
  4931. if(p->count)
  4932. continue;
  4933. // print the name of the test and don't execute it
  4934. if(p->list_test_cases) {
  4935. queryResults.push_back(tc.m_name);
  4936. continue;
  4937. }
  4938. // print the name of the test suite if not done already and don't execute it
  4939. if(p->list_test_suites) {
  4940. if((testSuitesPassingFilt.count(tc.m_test_suite) == 0) && tc.m_test_suite[0] != '\0') {
  4941. queryResults.push_back(tc.m_test_suite);
  4942. testSuitesPassingFilt.insert(tc.m_test_suite);
  4943. p->numTestSuitesPassingFilters++;
  4944. }
  4945. continue;
  4946. }
  4947. // execute the test if it passes all the filtering
  4948. {
  4949. p->currentTest = &tc;
  4950. p->failure_flags = TestCaseFailureReason::None;
  4951. p->seconds = 0;
  4952. // reset atomic counters
  4953. p->numAssertsFailedCurrentTest_atomic = 0;
  4954. p->numAssertsCurrentTest_atomic = 0;
  4955. p->subcasesPassed.clear();
  4956. DOCTEST_ITERATE_THROUGH_REPORTERS(test_case_start, tc);
  4957. p->timer.start();
  4958. bool run_test = true;
  4959. do {
  4960. // reset some of the fields for subcases (except for the set of fully passed ones)
  4961. p->should_reenter = false;
  4962. p->subcasesCurrentMaxLevel = 0;
  4963. p->subcasesStack.clear();
  4964. p->shouldLogCurrentException = true;
  4965. // reset stuff for logging with INFO()
  4966. p->stringifiedContexts.clear();
  4967. #ifndef DOCTEST_CONFIG_NO_EXCEPTIONS
  4968. try {
  4969. #endif // DOCTEST_CONFIG_NO_EXCEPTIONS
  4970. FatalConditionHandler fatalConditionHandler; // Handle signals
  4971. // execute the test
  4972. tc.m_test();
  4973. fatalConditionHandler.reset();
  4974. #ifndef DOCTEST_CONFIG_NO_EXCEPTIONS
  4975. } catch(const TestFailureException&) {
  4976. p->failure_flags |= TestCaseFailureReason::AssertFailure;
  4977. } catch(...) {
  4978. DOCTEST_ITERATE_THROUGH_REPORTERS(test_case_exception,
  4979. {translateActiveException(), false});
  4980. p->failure_flags |= TestCaseFailureReason::Exception;
  4981. }
  4982. #endif // DOCTEST_CONFIG_NO_EXCEPTIONS
  4983. // exit this loop if enough assertions have failed - even if there are more subcases
  4984. if(p->abort_after > 0 &&
  4985. p->numAssertsFailed + p->numAssertsFailedCurrentTest_atomic >= p->abort_after) {
  4986. run_test = false;
  4987. p->failure_flags |= TestCaseFailureReason::TooManyFailedAsserts;
  4988. }
  4989. if(p->should_reenter && run_test)
  4990. DOCTEST_ITERATE_THROUGH_REPORTERS(test_case_reenter, tc);
  4991. if(!p->should_reenter)
  4992. run_test = false;
  4993. } while(run_test);
  4994. p->finalizeTestCaseData();
  4995. DOCTEST_ITERATE_THROUGH_REPORTERS(test_case_end, *g_cs);
  4996. p->currentTest = nullptr;
  4997. // stop executing tests if enough assertions have failed
  4998. if(p->abort_after > 0 && p->numAssertsFailed >= p->abort_after)
  4999. break;
  5000. }
  5001. }
  5002. if(!query_mode) {
  5003. DOCTEST_ITERATE_THROUGH_REPORTERS(test_run_end, *g_cs);
  5004. } else {
  5005. QueryData qdata;
  5006. qdata.run_stats = g_cs;
  5007. qdata.data = queryResults.data();
  5008. qdata.num_data = unsigned(queryResults.size());
  5009. DOCTEST_ITERATE_THROUGH_REPORTERS(report_query, qdata);
  5010. }
  5011. // see these issues on the reasoning for this:
  5012. // - https://github.com/onqtam/doctest/issues/143#issuecomment-414418903
  5013. // - https://github.com/onqtam/doctest/issues/126
  5014. auto DOCTEST_FIX_FOR_MACOS_LIBCPP_IOSFWD_STRING_LINK_ERRORS = []() DOCTEST_NOINLINE
  5015. { std::cout << std::string(); };
  5016. DOCTEST_FIX_FOR_MACOS_LIBCPP_IOSFWD_STRING_LINK_ERRORS();
  5017. return cleanup_and_return();
  5018. }
  5019. IReporter::~IReporter() = default;
  5020. int IReporter::get_num_active_contexts() { return detail::g_infoContexts.size(); }
  5021. const IContextScope* const* IReporter::get_active_contexts() {
  5022. return get_num_active_contexts() ? &detail::g_infoContexts[0] : nullptr;
  5023. }
  5024. int IReporter::get_num_stringified_contexts() { return detail::g_cs->stringifiedContexts.size(); }
  5025. const String* IReporter::get_stringified_contexts() {
  5026. return get_num_stringified_contexts() ? &detail::g_cs->stringifiedContexts[0] : nullptr;
  5027. }
  5028. namespace detail {
  5029. void registerReporterImpl(const char* name, int priority, reporterCreatorFunc c, bool isReporter) {
  5030. if(isReporter)
  5031. getReporters().insert(reporterMap::value_type(reporterMap::key_type(priority, name), c));
  5032. else
  5033. getListeners().insert(reporterMap::value_type(reporterMap::key_type(priority, name), c));
  5034. }
  5035. } // namespace detail
  5036. } // namespace doctest
  5037. #endif // DOCTEST_CONFIG_DISABLE
  5038. #ifdef DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN
  5039. DOCTEST_MSVC_SUPPRESS_WARNING_WITH_PUSH(4007) // 'function' : must be 'attribute' - see issue #182
  5040. int main(int argc, char** argv) { return doctest::Context(argc, argv).run(); }
  5041. DOCTEST_MSVC_SUPPRESS_WARNING_POP
  5042. #endif // DOCTEST_CONFIG_IMPLEMENT_WITH_MAIN
  5043. DOCTEST_CLANG_SUPPRESS_WARNING_POP
  5044. DOCTEST_MSVC_SUPPRESS_WARNING_POP
  5045. DOCTEST_GCC_SUPPRESS_WARNING_POP
  5046. #endif // DOCTEST_LIBRARY_IMPLEMENTATION
  5047. #endif // DOCTEST_CONFIG_IMPLEMENT