doctest.h 314 KB

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