doctest.h 281 KB

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