| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755375637573758375937603761376237633764376537663767376837693770377137723773377437753776377737783779378037813782378337843785378637873788378937903791379237933794379537963797379837993800380138023803380438053806380738083809381038113812381338143815381638173818381938203821382238233824382538263827382838293830383138323833383438353836383738383839384038413842384338443845384638473848384938503851385238533854385538563857385838593860386138623863386438653866386738683869387038713872387338743875387638773878387938803881388238833884388538863887388838893890389138923893389438953896389738983899390039013902390339043905390639073908390939103911391239133914391539163917391839193920392139223923392439253926392739283929393039313932393339343935393639373938393939403941394239433944394539463947394839493950395139523953395439553956395739583959396039613962396339643965396639673968396939703971397239733974397539763977397839793980398139823983398439853986398739883989399039913992399339943995399639973998399940004001400240034004400540064007400840094010401140124013401440154016401740184019402040214022402340244025402640274028402940304031403240334034403540364037403840394040404140424043404440454046404740484049405040514052405340544055405640574058405940604061406240634064406540664067406840694070407140724073407440754076407740784079408040814082408340844085408640874088408940904091409240934094409540964097409840994100410141024103410441054106410741084109411041114112411341144115411641174118411941204121412241234124412541264127412841294130413141324133413441354136413741384139414041414142414341444145414641474148414941504151415241534154415541564157415841594160416141624163416441654166416741684169417041714172417341744175417641774178417941804181418241834184418541864187418841894190419141924193419441954196419741984199420042014202420342044205420642074208420942104211421242134214421542164217421842194220422142224223422442254226422742284229423042314232423342344235423642374238423942404241424242434244424542464247424842494250425142524253425442554256425742584259426042614262426342644265426642674268426942704271427242734274427542764277427842794280428142824283428442854286428742884289429042914292429342944295429642974298429943004301430243034304430543064307430843094310431143124313431443154316431743184319432043214322432343244325432643274328432943304331433243334334433543364337433843394340434143424343434443454346434743484349435043514352435343544355435643574358435943604361436243634364436543664367436843694370437143724373437443754376437743784379438043814382438343844385438643874388438943904391439243934394439543964397439843994400440144024403440444054406440744084409441044114412441344144415441644174418441944204421442244234424442544264427442844294430443144324433443444354436443744384439444044414442444344444445444644474448444944504451445244534454445544564457445844594460446144624463446444654466446744684469447044714472447344744475447644774478447944804481448244834484448544864487448844894490449144924493449444954496449744984499450045014502450345044505450645074508450945104511451245134514451545164517451845194520452145224523452445254526452745284529453045314532453345344535453645374538453945404541454245434544454545464547454845494550455145524553455445554556455745584559456045614562456345644565456645674568456945704571457245734574457545764577457845794580458145824583458445854586458745884589459045914592459345944595459645974598459946004601460246034604460546064607460846094610461146124613461446154616461746184619462046214622462346244625462646274628462946304631463246334634463546364637463846394640464146424643464446454646464746484649465046514652465346544655465646574658465946604661466246634664466546664667466846694670467146724673467446754676467746784679468046814682468346844685468646874688468946904691469246934694469546964697469846994700470147024703470447054706470747084709471047114712471347144715471647174718471947204721472247234724472547264727472847294730473147324733473447354736473747384739474047414742474347444745474647474748474947504751475247534754475547564757475847594760476147624763476447654766476747684769477047714772477347744775477647774778477947804781478247834784478547864787478847894790479147924793479447954796479747984799480048014802480348044805480648074808480948104811481248134814481548164817481848194820482148224823482448254826482748284829483048314832483348344835483648374838483948404841484248434844484548464847484848494850485148524853485448554856485748584859486048614862486348644865486648674868486948704871487248734874487548764877487848794880488148824883488448854886488748884889489048914892489348944895489648974898489949004901490249034904490549064907490849094910491149124913491449154916491749184919492049214922492349244925492649274928492949304931493249334934493549364937493849394940494149424943494449454946494749484949495049514952495349544955495649574958495949604961496249634964496549664967496849694970497149724973497449754976497749784979498049814982498349844985498649874988498949904991499249934994499549964997499849995000500150025003500450055006500750085009501050115012501350145015501650175018501950205021502250235024502550265027502850295030503150325033503450355036503750385039504050415042504350445045504650475048504950505051505250535054505550565057505850595060506150625063506450655066506750685069507050715072507350745075507650775078507950805081508250835084508550865087508850895090509150925093509450955096509750985099510051015102510351045105510651075108510951105111511251135114511551165117511851195120512151225123512451255126512751285129513051315132513351345135513651375138513951405141514251435144514551465147514851495150515151525153515451555156515751585159516051615162516351645165516651675168516951705171517251735174517551765177517851795180518151825183518451855186518751885189519051915192519351945195519651975198519952005201520252035204520552065207520852095210521152125213521452155216521752185219522052215222522352245225522652275228522952305231523252335234523552365237523852395240524152425243524452455246524752485249525052515252525352545255525652575258525952605261526252635264526552665267526852695270527152725273527452755276527752785279528052815282528352845285528652875288528952905291529252935294529552965297529852995300530153025303530453055306530753085309531053115312531353145315531653175318531953205321532253235324532553265327532853295330533153325333533453355336533753385339534053415342534353445345534653475348534953505351535253535354535553565357535853595360536153625363536453655366536753685369537053715372537353745375537653775378537953805381538253835384538553865387538853895390539153925393539453955396539753985399540054015402540354045405540654075408540954105411541254135414541554165417541854195420542154225423542454255426542754285429543054315432543354345435543654375438543954405441544254435444544554465447544854495450545154525453545454555456545754585459546054615462546354645465546654675468546954705471547254735474547554765477547854795480548154825483548454855486548754885489549054915492549354945495549654975498549955005501550255035504550555065507550855095510551155125513551455155516551755185519552055215522552355245525552655275528552955305531553255335534553555365537553855395540554155425543554455455546554755485549555055515552555355545555555655575558555955605561556255635564556555665567556855695570557155725573557455755576557755785579558055815582558355845585558655875588558955905591559255935594559555965597559855995600560156025603560456055606560756085609561056115612561356145615561656175618561956205621562256235624562556265627562856295630563156325633563456355636563756385639564056415642564356445645564656475648564956505651565256535654565556565657565856595660566156625663566456655666566756685669567056715672567356745675567656775678567956805681568256835684568556865687568856895690569156925693569456955696569756985699570057015702570357045705570657075708570957105711571257135714571557165717571857195720572157225723572457255726572757285729573057315732573357345735573657375738573957405741574257435744574557465747574857495750575157525753575457555756575757585759576057615762576357645765576657675768576957705771577257735774577557765777577857795780578157825783578457855786578757885789579057915792579357945795579657975798579958005801580258035804580558065807580858095810581158125813581458155816581758185819582058215822582358245825582658275828582958305831583258335834583558365837583858395840584158425843584458455846584758485849585058515852585358545855585658575858585958605861586258635864586558665867586858695870587158725873587458755876587758785879588058815882588358845885588658875888588958905891589258935894589558965897589858995900590159025903590459055906590759085909591059115912591359145915591659175918591959205921592259235924592559265927592859295930593159325933593459355936593759385939594059415942594359445945594659475948594959505951595259535954595559565957595859595960596159625963596459655966596759685969597059715972597359745975597659775978597959805981598259835984598559865987598859895990599159925993599459955996599759985999600060016002600360046005600660076008600960106011601260136014601560166017601860196020602160226023602460256026602760286029603060316032603360346035603660376038603960406041604260436044604560466047604860496050605160526053605460556056605760586059606060616062606360646065606660676068606960706071607260736074607560766077607860796080608160826083608460856086608760886089609060916092609360946095609660976098609961006101610261036104610561066107610861096110611161126113611461156116611761186119612061216122612361246125612661276128612961306131613261336134613561366137613861396140614161426143614461456146614761486149615061516152615361546155615661576158615961606161616261636164616561666167616861696170617161726173617461756176617761786179618061816182618361846185618661876188618961906191619261936194619561966197619861996200620162026203620462056206620762086209621062116212621362146215621662176218621962206221622262236224622562266227622862296230623162326233623462356236623762386239624062416242624362446245624662476248624962506251625262536254625562566257625862596260626162626263626462656266626762686269627062716272627362746275627662776278627962806281628262836284628562866287628862896290629162926293629462956296629762986299630063016302630363046305630663076308630963106311631263136314631563166317631863196320632163226323632463256326632763286329633063316332633363346335633663376338633963406341634263436344634563466347634863496350635163526353635463556356635763586359636063616362636363646365636663676368636963706371637263736374637563766377637863796380638163826383638463856386638763886389639063916392639363946395639663976398639964006401640264036404640564066407640864096410641164126413641464156416641764186419642064216422642364246425642664276428642964306431643264336434643564366437643864396440644164426443644464456446644764486449645064516452645364546455645664576458645964606461646264636464646564666467646864696470647164726473647464756476647764786479648064816482648364846485648664876488648964906491649264936494649564966497649864996500650165026503650465056506650765086509651065116512651365146515651665176518651965206521652265236524652565266527652865296530653165326533653465356536653765386539654065416542654365446545654665476548654965506551655265536554655565566557655865596560656165626563656465656566656765686569657065716572657365746575657665776578657965806581658265836584658565866587658865896590659165926593659465956596659765986599660066016602660366046605660666076608660966106611661266136614661566166617661866196620662166226623662466256626662766286629663066316632663366346635663666376638663966406641664266436644664566466647664866496650665166526653665466556656665766586659666066616662666366646665666666676668666966706671667266736674667566766677667866796680668166826683668466856686668766886689669066916692669366946695669666976698669967006701670267036704670567066707670867096710671167126713671467156716671767186719672067216722672367246725672667276728672967306731673267336734673567366737673867396740674167426743674467456746674767486749675067516752675367546755675667576758675967606761676267636764676567666767676867696770677167726773677467756776677767786779678067816782678367846785678667876788678967906791679267936794679567966797679867996800680168026803680468056806680768086809681068116812681368146815681668176818681968206821682268236824682568266827682868296830683168326833683468356836683768386839684068416842684368446845684668476848684968506851685268536854685568566857685868596860686168626863686468656866686768686869687068716872687368746875687668776878687968806881688268836884688568866887688868896890689168926893689468956896689768986899690069016902690369046905690669076908690969106911691269136914691569166917691869196920692169226923692469256926692769286929693069316932693369346935693669376938693969406941694269436944694569466947694869496950695169526953695469556956695769586959696069616962696369646965696669676968696969706971697269736974697569766977697869796980698169826983698469856986698769886989699069916992699369946995699669976998699970007001700270037004700570067007700870097010701170127013701470157016701770187019702070217022702370247025702670277028702970307031703270337034703570367037703870397040704170427043704470457046704770487049705070517052705370547055705670577058705970607061706270637064706570667067706870697070707170727073707470757076707770787079708070817082708370847085708670877088708970907091709270937094709570967097709870997100710171027103710471057106710771087109711071117112711371147115711671177118711971207121712271237124712571267127712871297130713171327133713471357136713771387139714071417142714371447145714671477148714971507151715271537154715571567157715871597160716171627163716471657166716771687169717071717172717371747175717671777178717971807181718271837184718571867187718871897190719171927193719471957196719771987199720072017202720372047205720672077208720972107211721272137214721572167217721872197220722172227223722472257226722772287229723072317232723372347235723672377238723972407241724272437244724572467247724872497250725172527253725472557256725772587259726072617262726372647265726672677268726972707271727272737274727572767277727872797280728172827283728472857286728772887289729072917292729372947295729672977298729973007301730273037304730573067307730873097310731173127313731473157316731773187319732073217322732373247325732673277328732973307331733273337334733573367337733873397340734173427343734473457346734773487349735073517352735373547355735673577358735973607361736273637364736573667367736873697370737173727373737473757376737773787379738073817382738373847385738673877388738973907391739273937394739573967397739873997400740174027403740474057406740774087409741074117412741374147415741674177418741974207421742274237424742574267427742874297430743174327433743474357436743774387439744074417442744374447445744674477448744974507451745274537454745574567457745874597460746174627463746474657466746774687469747074717472747374747475747674777478747974807481748274837484748574867487748874897490749174927493749474957496749774987499750075017502750375047505750675077508750975107511751275137514751575167517751875197520752175227523752475257526752775287529753075317532753375347535753675377538753975407541754275437544754575467547754875497550755175527553755475557556755775587559756075617562756375647565756675677568756975707571757275737574757575767577757875797580758175827583758475857586758775887589759075917592759375947595759675977598759976007601760276037604760576067607760876097610761176127613761476157616761776187619762076217622762376247625762676277628762976307631763276337634763576367637763876397640764176427643764476457646764776487649765076517652765376547655765676577658765976607661766276637664766576667667766876697670767176727673767476757676767776787679768076817682768376847685768676877688768976907691769276937694769576967697769876997700770177027703770477057706770777087709771077117712771377147715771677177718771977207721772277237724772577267727772877297730773177327733773477357736773777387739774077417742774377447745774677477748774977507751775277537754775577567757775877597760776177627763776477657766776777687769777077717772777377747775777677777778777977807781778277837784778577867787778877897790779177927793779477957796779777987799780078017802780378047805780678077808780978107811781278137814781578167817781878197820782178227823782478257826782778287829783078317832783378347835783678377838783978407841784278437844784578467847784878497850785178527853785478557856785778587859786078617862786378647865786678677868786978707871787278737874787578767877787878797880788178827883788478857886788778887889789078917892789378947895789678977898789979007901790279037904790579067907790879097910791179127913791479157916791779187919792079217922792379247925792679277928792979307931793279337934793579367937793879397940794179427943794479457946794779487949795079517952795379547955795679577958795979607961796279637964796579667967796879697970797179727973797479757976797779787979798079817982798379847985798679877988798979907991799279937994799579967997799879998000800180028003800480058006800780088009801080118012801380148015801680178018801980208021802280238024802580268027802880298030803180328033803480358036803780388039804080418042804380448045804680478048804980508051805280538054805580568057805880598060806180628063806480658066806780688069807080718072807380748075807680778078807980808081808280838084808580868087808880898090809180928093809480958096809780988099810081018102810381048105810681078108810981108111811281138114811581168117811881198120812181228123812481258126812781288129813081318132813381348135813681378138813981408141814281438144814581468147814881498150815181528153815481558156815781588159816081618162816381648165816681678168816981708171817281738174817581768177817881798180818181828183818481858186818781888189819081918192819381948195819681978198819982008201820282038204820582068207820882098210821182128213821482158216821782188219822082218222822382248225822682278228822982308231823282338234823582368237823882398240824182428243824482458246824782488249825082518252825382548255825682578258825982608261826282638264826582668267826882698270827182728273827482758276827782788279828082818282828382848285828682878288828982908291829282938294829582968297829882998300830183028303830483058306830783088309831083118312831383148315831683178318831983208321832283238324832583268327832883298330833183328333833483358336833783388339834083418342834383448345834683478348834983508351835283538354835583568357835883598360836183628363836483658366836783688369837083718372837383748375837683778378837983808381838283838384838583868387838883898390839183928393839483958396839783988399840084018402840384048405840684078408840984108411841284138414841584168417841884198420842184228423842484258426842784288429843084318432843384348435843684378438843984408441844284438444844584468447844884498450845184528453845484558456845784588459846084618462846384648465846684678468846984708471847284738474847584768477847884798480848184828483848484858486848784888489849084918492849384948495849684978498849985008501850285038504850585068507850885098510851185128513851485158516851785188519852085218522852385248525852685278528852985308531853285338534853585368537853885398540854185428543854485458546854785488549855085518552855385548555855685578558855985608561856285638564856585668567856885698570857185728573857485758576857785788579858085818582858385848585858685878588858985908591859285938594859585968597859885998600860186028603860486058606860786088609861086118612861386148615861686178618861986208621862286238624862586268627862886298630863186328633863486358636863786388639864086418642864386448645864686478648864986508651865286538654865586568657865886598660866186628663866486658666866786688669867086718672867386748675867686778678867986808681868286838684868586868687868886898690869186928693869486958696869786988699870087018702870387048705870687078708870987108711871287138714871587168717871887198720872187228723872487258726872787288729873087318732873387348735873687378738873987408741874287438744874587468747874887498750875187528753875487558756875787588759876087618762876387648765876687678768876987708771877287738774877587768777877887798780878187828783878487858786878787888789879087918792879387948795879687978798879988008801880288038804880588068807880888098810881188128813881488158816881788188819882088218822882388248825882688278828882988308831883288338834883588368837883888398840884188428843884488458846884788488849885088518852885388548855885688578858885988608861886288638864886588668867886888698870887188728873887488758876887788788879888088818882888388848885888688878888888988908891889288938894889588968897889888998900890189028903890489058906890789088909891089118912891389148915891689178918891989208921892289238924892589268927892889298930893189328933893489358936893789388939894089418942894389448945894689478948894989508951895289538954895589568957895889598960896189628963896489658966896789688969897089718972897389748975897689778978897989808981898289838984898589868987898889898990899189928993899489958996899789988999900090019002900390049005900690079008900990109011901290139014901590169017901890199020902190229023902490259026902790289029903090319032903390349035903690379038903990409041904290439044904590469047904890499050905190529053905490559056905790589059906090619062906390649065906690679068906990709071907290739074907590769077907890799080908190829083908490859086908790889089909090919092909390949095909690979098909991009101910291039104910591069107910891099110911191129113911491159116911791189119912091219122912391249125912691279128912991309131913291339134913591369137913891399140914191429143914491459146914791489149915091519152915391549155915691579158915991609161916291639164916591669167916891699170917191729173917491759176917791789179918091819182918391849185918691879188918991909191919291939194919591969197919891999200920192029203920492059206920792089209921092119212921392149215921692179218921992209221922292239224922592269227922892299230923192329233923492359236923792389239924092419242924392449245924692479248924992509251925292539254925592569257925892599260926192629263926492659266926792689269927092719272927392749275927692779278927992809281928292839284928592869287928892899290929192929293929492959296929792989299930093019302930393049305930693079308930993109311931293139314931593169317931893199320932193229323932493259326932793289329933093319332933393349335933693379338933993409341934293439344934593469347934893499350935193529353935493559356935793589359936093619362936393649365936693679368936993709371937293739374937593769377937893799380938193829383938493859386938793889389939093919392939393949395939693979398939994009401940294039404940594069407940894099410941194129413941494159416941794189419942094219422942394249425942694279428942994309431943294339434943594369437943894399440944194429443944494459446944794489449945094519452945394549455945694579458945994609461946294639464946594669467946894699470947194729473947494759476947794789479948094819482948394849485948694879488948994909491949294939494949594969497949894999500950195029503950495059506950795089509951095119512951395149515951695179518951995209521952295239524952595269527952895299530953195329533953495359536953795389539954095419542954395449545954695479548954995509551955295539554955595569557955895599560956195629563956495659566956795689569957095719572957395749575957695779578957995809581958295839584958595869587958895899590959195929593959495959596959795989599960096019602960396049605960696079608960996109611961296139614961596169617961896199620962196229623962496259626962796289629963096319632963396349635963696379638963996409641964296439644964596469647964896499650965196529653965496559656965796589659966096619662966396649665966696679668966996709671967296739674967596769677967896799680968196829683968496859686968796889689969096919692969396949695969696979698969997009701970297039704970597069707970897099710971197129713971497159716971797189719972097219722972397249725972697279728972997309731973297339734973597369737973897399740974197429743974497459746974797489749975097519752975397549755975697579758975997609761976297639764976597669767976897699770977197729773977497759776977797789779978097819782978397849785978697879788978997909791979297939794979597969797979897999800980198029803980498059806980798089809981098119812981398149815981698179818981998209821982298239824982598269827982898299830983198329833983498359836983798389839984098419842984398449845984698479848984998509851985298539854985598569857985898599860986198629863986498659866986798689869987098719872987398749875987698779878987998809881988298839884988598869887988898899890989198929893989498959896989798989899990099019902990399049905990699079908990999109911991299139914991599169917991899199920992199229923992499259926992799289929993099319932993399349935993699379938993999409941994299439944994599469947994899499950995199529953995499559956995799589959996099619962996399649965996699679968996999709971997299739974997599769977997899799980998199829983998499859986998799889989999099919992999399949995999699979998999910000100011000210003100041000510006100071000810009100101001110012100131001410015100161001710018100191002010021100221002310024100251002610027100281002910030100311003210033100341003510036100371003810039100401004110042100431004410045100461004710048100491005010051100521005310054100551005610057100581005910060100611006210063100641006510066100671006810069100701007110072100731007410075100761007710078100791008010081100821008310084100851008610087100881008910090100911009210093100941009510096100971009810099101001010110102101031010410105101061010710108101091011010111101121011310114101151011610117101181011910120101211012210123101241012510126101271012810129101301013110132101331013410135101361013710138101391014010141101421014310144101451014610147101481014910150101511015210153101541015510156101571015810159101601016110162101631016410165101661016710168101691017010171101721017310174101751017610177101781017910180101811018210183101841018510186101871018810189101901019110192101931019410195101961019710198101991020010201102021020310204102051020610207102081020910210102111021210213102141021510216102171021810219102201022110222102231022410225102261022710228102291023010231102321023310234102351023610237102381023910240102411024210243102441024510246102471024810249102501025110252102531025410255102561025710258102591026010261102621026310264102651026610267102681026910270102711027210273102741027510276102771027810279102801028110282102831028410285102861028710288102891029010291102921029310294102951029610297102981029910300103011030210303103041030510306103071030810309103101031110312103131031410315103161031710318103191032010321103221032310324103251032610327103281032910330103311033210333103341033510336103371033810339103401034110342103431034410345103461034710348103491035010351103521035310354103551035610357103581035910360103611036210363103641036510366103671036810369103701037110372103731037410375103761037710378103791038010381103821038310384103851038610387103881038910390103911039210393103941039510396103971039810399104001040110402104031040410405104061040710408104091041010411104121041310414104151041610417104181041910420104211042210423104241042510426104271042810429104301043110432104331043410435104361043710438104391044010441104421044310444104451044610447104481044910450104511045210453104541045510456104571045810459104601046110462104631046410465104661046710468104691047010471104721047310474104751047610477104781047910480104811048210483104841048510486104871048810489104901049110492104931049410495104961049710498104991050010501105021050310504105051050610507105081050910510105111051210513105141051510516105171051810519105201052110522105231052410525105261052710528105291053010531105321053310534105351053610537105381053910540105411054210543105441054510546105471054810549105501055110552105531055410555105561055710558105591056010561105621056310564105651056610567105681056910570105711057210573105741057510576105771057810579105801058110582105831058410585105861058710588105891059010591105921059310594105951059610597105981059910600106011060210603106041060510606106071060810609106101061110612106131061410615106161061710618106191062010621106221062310624106251062610627106281062910630106311063210633106341063510636106371063810639106401064110642106431064410645106461064710648106491065010651106521065310654106551065610657106581065910660106611066210663106641066510666106671066810669106701067110672106731067410675106761067710678106791068010681106821068310684106851068610687106881068910690106911069210693106941069510696106971069810699107001070110702107031070410705107061070710708107091071010711107121071310714107151071610717107181071910720107211072210723107241072510726107271072810729107301073110732107331073410735107361073710738107391074010741107421074310744107451074610747107481074910750107511075210753107541075510756107571075810759107601076110762107631076410765107661076710768107691077010771107721077310774107751077610777107781077910780107811078210783107841078510786107871078810789107901079110792107931079410795107961079710798107991080010801108021080310804108051080610807108081080910810108111081210813108141081510816108171081810819108201082110822108231082410825108261082710828108291083010831108321083310834108351083610837108381083910840108411084210843108441084510846108471084810849108501085110852108531085410855108561085710858108591086010861108621086310864108651086610867108681086910870108711087210873108741087510876108771087810879108801088110882108831088410885108861088710888108891089010891108921089310894108951089610897108981089910900109011090210903109041090510906109071090810909109101091110912109131091410915109161091710918109191092010921109221092310924109251092610927109281092910930109311093210933109341093510936109371093810939109401094110942109431094410945109461094710948109491095010951109521095310954109551095610957109581095910960109611096210963109641096510966109671096810969109701097110972109731097410975109761097710978109791098010981109821098310984109851098610987109881098910990109911099210993109941099510996109971099810999110001100111002110031100411005110061100711008110091101011011110121101311014110151101611017110181101911020110211102211023110241102511026110271102811029110301103111032110331103411035110361103711038110391104011041110421104311044110451104611047110481104911050110511105211053110541105511056110571105811059110601106111062110631106411065110661106711068110691107011071110721107311074110751107611077110781107911080110811108211083110841108511086110871108811089110901109111092110931109411095110961109711098110991110011101111021110311104111051110611107111081110911110111111111211113111141111511116111171111811119111201112111122111231112411125111261112711128111291113011131111321113311134111351113611137111381113911140111411114211143111441114511146111471114811149111501115111152111531115411155111561115711158111591116011161111621116311164111651116611167111681116911170111711117211173111741117511176111771117811179111801118111182111831118411185111861118711188111891119011191111921119311194111951119611197111981119911200112011120211203112041120511206112071120811209112101121111212112131121411215112161121711218112191122011221112221122311224112251122611227112281122911230112311123211233112341123511236112371123811239112401124111242112431124411245112461124711248112491125011251112521125311254112551125611257112581125911260112611126211263112641126511266112671126811269112701127111272112731127411275112761127711278112791128011281112821128311284112851128611287112881128911290112911129211293112941129511296112971129811299113001130111302113031130411305113061130711308113091131011311113121131311314113151131611317113181131911320113211132211323113241132511326113271132811329113301133111332113331133411335113361133711338113391134011341113421134311344113451134611347113481134911350113511135211353113541135511356113571135811359113601136111362113631136411365113661136711368113691137011371113721137311374113751137611377113781137911380113811138211383113841138511386113871138811389113901139111392113931139411395113961139711398113991140011401114021140311404114051140611407114081140911410114111141211413114141141511416114171141811419114201142111422114231142411425114261142711428114291143011431114321143311434114351143611437114381143911440114411144211443114441144511446114471144811449114501145111452114531145411455114561145711458114591146011461114621146311464114651146611467114681146911470114711147211473114741147511476114771147811479114801148111482114831148411485114861148711488114891149011491114921149311494114951149611497114981149911500115011150211503115041150511506115071150811509115101151111512115131151411515115161151711518115191152011521115221152311524115251152611527115281152911530115311153211533115341153511536115371153811539115401154111542115431154411545115461154711548115491155011551115521155311554115551155611557115581155911560115611156211563115641156511566115671156811569115701157111572115731157411575115761157711578115791158011581115821158311584115851158611587115881158911590115911159211593115941159511596115971159811599116001160111602116031160411605116061160711608116091161011611116121161311614116151161611617116181161911620116211162211623116241162511626116271162811629116301163111632116331163411635116361163711638116391164011641116421164311644116451164611647116481164911650116511165211653116541165511656116571165811659116601166111662116631166411665116661166711668116691167011671116721167311674116751167611677116781167911680116811168211683116841168511686116871168811689116901169111692116931169411695116961169711698116991170011701117021170311704117051170611707117081170911710117111171211713117141171511716117171171811719117201172111722117231172411725117261172711728117291173011731117321173311734117351173611737117381173911740117411174211743117441174511746117471174811749117501175111752117531175411755117561175711758117591176011761117621176311764117651176611767117681176911770117711177211773117741177511776117771177811779117801178111782117831178411785117861178711788117891179011791117921179311794117951179611797117981179911800118011180211803118041180511806118071180811809118101181111812118131181411815118161181711818118191182011821118221182311824118251182611827118281182911830118311183211833118341183511836118371183811839118401184111842118431184411845118461184711848118491185011851118521185311854118551185611857118581185911860118611186211863118641186511866118671186811869118701187111872118731187411875118761187711878118791188011881118821188311884118851188611887118881188911890118911189211893118941189511896118971189811899119001190111902119031190411905119061190711908119091191011911119121191311914119151191611917119181191911920119211192211923119241192511926119271192811929119301193111932119331193411935119361193711938119391194011941119421194311944119451194611947119481194911950119511195211953119541195511956119571195811959119601196111962119631196411965119661196711968119691197011971119721197311974119751197611977119781197911980119811198211983119841198511986119871198811989119901199111992119931199411995119961199711998119991200012001120021200312004120051200612007120081200912010120111201212013120141201512016120171201812019120201202112022120231202412025120261202712028120291203012031120321203312034120351203612037120381203912040120411204212043120441204512046120471204812049120501205112052120531205412055120561205712058120591206012061120621206312064120651206612067120681206912070120711207212073120741207512076120771207812079120801208112082120831208412085120861208712088120891209012091120921209312094120951209612097120981209912100121011210212103121041210512106121071210812109121101211112112121131211412115121161211712118121191212012121121221212312124121251212612127121281212912130121311213212133121341213512136121371213812139121401214112142121431214412145121461214712148121491215012151121521215312154121551215612157121581215912160121611216212163121641216512166121671216812169121701217112172121731217412175121761217712178121791218012181121821218312184121851218612187121881218912190121911219212193121941219512196121971219812199122001220112202122031220412205122061220712208122091221012211122121221312214122151221612217122181221912220122211222212223122241222512226122271222812229122301223112232122331223412235122361223712238122391224012241122421224312244122451224612247122481224912250122511225212253122541225512256122571225812259122601226112262122631226412265122661226712268122691227012271122721227312274122751227612277122781227912280122811228212283122841228512286122871228812289122901229112292122931229412295122961229712298122991230012301123021230312304123051230612307123081230912310123111231212313123141231512316123171231812319123201232112322123231232412325123261232712328123291233012331123321233312334123351233612337123381233912340123411234212343123441234512346123471234812349123501235112352123531235412355123561235712358123591236012361123621236312364123651236612367123681236912370123711237212373123741237512376123771237812379123801238112382123831238412385123861238712388123891239012391123921239312394123951239612397123981239912400124011240212403124041240512406124071240812409124101241112412124131241412415124161241712418124191242012421124221242312424124251242612427124281242912430124311243212433124341243512436124371243812439124401244112442124431244412445124461244712448124491245012451124521245312454124551245612457124581245912460124611246212463124641246512466124671246812469124701247112472124731247412475124761247712478124791248012481124821248312484124851248612487124881248912490124911249212493124941249512496124971249812499125001250112502125031250412505125061250712508125091251012511125121251312514125151251612517125181251912520125211252212523125241252512526125271252812529125301253112532125331253412535125361253712538125391254012541125421254312544125451254612547125481254912550125511255212553125541255512556125571255812559125601256112562125631256412565125661256712568125691257012571125721257312574125751257612577125781257912580125811258212583125841258512586125871258812589125901259112592125931259412595125961259712598125991260012601126021260312604126051260612607126081260912610126111261212613126141261512616126171261812619126201262112622126231262412625126261262712628126291263012631126321263312634126351263612637126381263912640126411264212643126441264512646126471264812649126501265112652126531265412655126561265712658126591266012661126621266312664126651266612667126681266912670126711267212673126741267512676126771267812679126801268112682126831268412685126861268712688126891269012691126921269312694126951269612697126981269912700127011270212703127041270512706127071270812709127101271112712127131271412715127161271712718127191272012721127221272312724127251272612727127281272912730127311273212733127341273512736127371273812739127401274112742127431274412745127461274712748127491275012751127521275312754127551275612757127581275912760127611276212763127641276512766127671276812769127701277112772127731277412775127761277712778127791278012781127821278312784127851278612787127881278912790127911279212793127941279512796127971279812799128001280112802128031280412805128061280712808128091281012811128121281312814128151281612817128181281912820128211282212823128241282512826128271282812829128301283112832128331283412835128361283712838128391284012841128421284312844128451284612847128481284912850128511285212853128541285512856128571285812859128601286112862128631286412865128661286712868128691287012871128721287312874128751287612877128781287912880128811288212883128841288512886128871288812889128901289112892128931289412895128961289712898128991290012901129021290312904129051290612907129081290912910129111291212913129141291512916129171291812919129201292112922129231292412925129261292712928129291293012931129321293312934129351293612937129381293912940129411294212943129441294512946129471294812949129501295112952129531295412955129561295712958129591296012961129621296312964129651296612967129681296912970129711297212973129741297512976129771297812979129801298112982129831298412985129861298712988129891299012991129921299312994129951299612997129981299913000130011300213003130041300513006130071300813009130101301113012130131301413015130161301713018130191302013021130221302313024130251302613027130281302913030130311303213033130341303513036130371303813039130401304113042130431304413045130461304713048130491305013051130521305313054130551305613057130581305913060130611306213063130641306513066130671306813069130701307113072130731307413075130761307713078130791308013081130821308313084130851308613087130881308913090130911309213093130941309513096130971309813099131001310113102131031310413105131061310713108131091311013111131121311313114131151311613117131181311913120131211312213123131241312513126131271312813129131301313113132131331313413135131361313713138131391314013141131421314313144131451314613147131481314913150131511315213153131541315513156131571315813159131601316113162131631316413165131661316713168131691317013171131721317313174131751317613177131781317913180131811318213183131841318513186131871318813189131901319113192131931319413195131961319713198131991320013201132021320313204132051320613207132081320913210132111321213213132141321513216132171321813219132201322113222132231322413225132261322713228132291323013231132321323313234132351323613237132381323913240132411324213243132441324513246132471324813249132501325113252132531325413255132561325713258132591326013261132621326313264132651326613267132681326913270132711327213273132741327513276132771327813279132801328113282132831328413285132861328713288132891329013291132921329313294132951329613297132981329913300133011330213303133041330513306133071330813309133101331113312133131331413315133161331713318133191332013321133221332313324133251332613327133281332913330133311333213333133341333513336133371333813339133401334113342133431334413345133461334713348133491335013351133521335313354133551335613357133581335913360133611336213363133641336513366133671336813369133701337113372133731337413375133761337713378133791338013381133821338313384133851338613387133881338913390133911339213393133941339513396133971339813399134001340113402134031340413405134061340713408134091341013411134121341313414134151341613417134181341913420134211342213423134241342513426134271342813429134301343113432134331343413435134361343713438134391344013441134421344313444134451344613447134481344913450134511345213453134541345513456134571345813459134601346113462134631346413465134661346713468134691347013471134721347313474134751347613477134781347913480134811348213483134841348513486134871348813489134901349113492134931349413495134961349713498134991350013501135021350313504135051350613507135081350913510135111351213513135141351513516135171351813519135201352113522135231352413525135261352713528135291353013531135321353313534135351353613537135381353913540135411354213543135441354513546135471354813549135501355113552135531355413555135561355713558135591356013561135621356313564135651356613567135681356913570135711357213573135741357513576135771357813579135801358113582135831358413585135861358713588135891359013591135921359313594135951359613597135981359913600136011360213603136041360513606136071360813609136101361113612136131361413615136161361713618136191362013621136221362313624136251362613627136281362913630136311363213633136341363513636136371363813639136401364113642136431364413645136461364713648136491365013651136521365313654136551365613657136581365913660136611366213663136641366513666136671366813669136701367113672136731367413675136761367713678136791368013681136821368313684136851368613687136881368913690136911369213693136941369513696136971369813699137001370113702137031370413705137061370713708137091371013711137121371313714137151371613717137181371913720137211372213723137241372513726137271372813729137301373113732137331373413735137361373713738137391374013741137421374313744137451374613747137481374913750137511375213753137541375513756137571375813759137601376113762137631376413765137661376713768137691377013771137721377313774137751377613777137781377913780137811378213783137841378513786137871378813789137901379113792137931379413795137961379713798137991380013801138021380313804138051380613807138081380913810138111381213813138141381513816138171381813819138201382113822138231382413825138261382713828138291383013831138321383313834138351383613837138381383913840138411384213843138441384513846138471384813849138501385113852138531385413855138561385713858138591386013861138621386313864138651386613867138681386913870138711387213873138741387513876138771387813879138801388113882138831388413885138861388713888138891389013891138921389313894138951389613897138981389913900139011390213903139041390513906139071390813909139101391113912139131391413915139161391713918139191392013921139221392313924139251392613927139281392913930139311393213933139341393513936139371393813939139401394113942139431394413945139461394713948139491395013951139521395313954139551395613957139581395913960139611396213963139641396513966139671396813969139701397113972139731397413975139761397713978139791398013981139821398313984139851398613987139881398913990139911399213993139941399513996139971399813999140001400114002140031400414005140061400714008140091401014011140121401314014140151401614017140181401914020140211402214023140241402514026140271402814029140301403114032140331403414035140361403714038140391404014041140421404314044140451404614047140481404914050140511405214053140541405514056140571405814059140601406114062140631406414065140661406714068140691407014071140721407314074140751407614077140781407914080140811408214083140841408514086140871408814089140901409114092140931409414095140961409714098140991410014101141021410314104141051410614107141081410914110141111411214113141141411514116141171411814119141201412114122141231412414125141261412714128141291413014131141321413314134141351413614137141381413914140141411414214143141441414514146141471414814149141501415114152141531415414155141561415714158141591416014161141621416314164141651416614167141681416914170141711417214173141741417514176141771417814179141801418114182141831418414185141861418714188141891419014191141921419314194141951419614197141981419914200142011420214203142041420514206142071420814209142101421114212142131421414215142161421714218142191422014221142221422314224142251422614227142281422914230142311423214233142341423514236142371423814239142401424114242142431424414245142461424714248142491425014251142521425314254142551425614257142581425914260142611426214263142641426514266142671426814269142701427114272142731427414275142761427714278142791428014281142821428314284142851428614287142881428914290142911429214293142941429514296142971429814299143001430114302143031430414305143061430714308143091431014311143121431314314143151431614317143181431914320143211432214323143241432514326143271432814329143301433114332143331433414335143361433714338143391434014341143421434314344143451434614347143481434914350143511435214353143541435514356143571435814359143601436114362143631436414365143661436714368143691437014371143721437314374143751437614377143781437914380143811438214383143841438514386143871438814389143901439114392143931439414395143961439714398143991440014401144021440314404144051440614407144081440914410144111441214413144141441514416144171441814419144201442114422144231442414425144261442714428144291443014431144321443314434144351443614437144381443914440144411444214443144441444514446144471444814449144501445114452144531445414455144561445714458144591446014461144621446314464144651446614467144681446914470144711447214473144741447514476144771447814479144801448114482144831448414485144861448714488144891449014491144921449314494144951449614497144981449914500145011450214503145041450514506145071450814509145101451114512145131451414515145161451714518145191452014521145221452314524145251452614527145281452914530145311453214533145341453514536145371453814539145401454114542145431454414545145461454714548145491455014551145521455314554145551455614557145581455914560145611456214563145641456514566145671456814569145701457114572145731457414575145761457714578145791458014581145821458314584145851458614587145881458914590145911459214593145941459514596145971459814599146001460114602146031460414605146061460714608146091461014611146121461314614146151461614617146181461914620146211462214623146241462514626146271462814629146301463114632146331463414635146361463714638146391464014641146421464314644146451464614647146481464914650146511465214653146541465514656146571465814659146601466114662146631466414665146661466714668146691467014671146721467314674146751467614677146781467914680146811468214683146841468514686146871468814689146901469114692146931469414695146961469714698146991470014701147021470314704147051470614707147081470914710147111471214713147141471514716147171471814719147201472114722147231472414725147261472714728147291473014731147321473314734147351473614737147381473914740147411474214743147441474514746147471474814749147501475114752147531475414755147561475714758147591476014761147621476314764147651476614767147681476914770147711477214773147741477514776147771477814779147801478114782147831478414785147861478714788147891479014791147921479314794147951479614797147981479914800148011480214803148041480514806148071480814809148101481114812148131481414815148161481714818148191482014821148221482314824148251482614827148281482914830148311483214833148341483514836148371483814839148401484114842148431484414845148461484714848148491485014851148521485314854148551485614857148581485914860148611486214863148641486514866148671486814869148701487114872148731487414875148761487714878148791488014881148821488314884148851488614887148881488914890148911489214893148941489514896148971489814899149001490114902149031490414905149061490714908149091491014911149121491314914149151491614917149181491914920149211492214923149241492514926149271492814929149301493114932149331493414935149361493714938149391494014941149421494314944149451494614947149481494914950149511495214953149541495514956149571495814959149601496114962149631496414965149661496714968149691497014971149721497314974149751497614977149781497914980149811498214983149841498514986149871498814989149901499114992149931499414995149961499714998149991500015001150021500315004150051500615007150081500915010150111501215013150141501515016150171501815019150201502115022150231502415025150261502715028150291503015031150321503315034150351503615037150381503915040150411504215043150441504515046150471504815049150501505115052150531505415055150561505715058150591506015061150621506315064150651506615067150681506915070150711507215073150741507515076150771507815079150801508115082150831508415085150861508715088150891509015091150921509315094150951509615097150981509915100151011510215103151041510515106151071510815109151101511115112151131511415115151161511715118151191512015121151221512315124151251512615127151281512915130151311513215133151341513515136151371513815139151401514115142151431514415145151461514715148151491515015151151521515315154151551515615157151581515915160151611516215163151641516515166151671516815169151701517115172151731517415175151761517715178151791518015181151821518315184151851518615187151881518915190151911519215193151941519515196151971519815199152001520115202152031520415205152061520715208152091521015211152121521315214152151521615217152181521915220152211522215223152241522515226152271522815229152301523115232152331523415235152361523715238152391524015241152421524315244152451524615247152481524915250152511525215253152541525515256152571525815259152601526115262152631526415265152661526715268152691527015271152721527315274152751527615277152781527915280152811528215283152841528515286152871528815289152901529115292152931529415295152961529715298152991530015301153021530315304153051530615307153081530915310153111531215313153141531515316153171531815319153201532115322153231532415325153261532715328153291533015331153321533315334153351533615337153381533915340153411534215343153441534515346153471534815349153501535115352153531535415355153561535715358153591536015361153621536315364153651536615367153681536915370153711537215373153741537515376153771537815379153801538115382153831538415385153861538715388153891539015391153921539315394153951539615397153981539915400154011540215403154041540515406154071540815409154101541115412154131541415415154161541715418154191542015421154221542315424154251542615427154281542915430154311543215433154341543515436154371543815439154401544115442154431544415445154461544715448154491545015451154521545315454154551545615457154581545915460154611546215463154641546515466154671546815469154701547115472154731547415475154761547715478154791548015481154821548315484154851548615487154881548915490154911549215493154941549515496154971549815499155001550115502155031550415505155061550715508155091551015511155121551315514155151551615517155181551915520155211552215523155241552515526155271552815529155301553115532155331553415535155361553715538155391554015541155421554315544155451554615547155481554915550155511555215553155541555515556155571555815559155601556115562155631556415565155661556715568155691557015571155721557315574155751557615577155781557915580155811558215583155841558515586155871558815589155901559115592155931559415595155961559715598155991560015601156021560315604156051560615607156081560915610156111561215613156141561515616156171561815619156201562115622156231562415625156261562715628156291563015631156321563315634156351563615637156381563915640156411564215643156441564515646156471564815649156501565115652156531565415655156561565715658156591566015661156621566315664156651566615667156681566915670156711567215673156741567515676156771567815679156801568115682156831568415685156861568715688156891569015691156921569315694156951569615697156981569915700157011570215703157041570515706157071570815709157101571115712157131571415715157161571715718157191572015721157221572315724157251572615727157281572915730157311573215733157341573515736157371573815739157401574115742157431574415745157461574715748157491575015751157521575315754157551575615757157581575915760157611576215763157641576515766157671576815769157701577115772157731577415775157761577715778157791578015781157821578315784157851578615787157881578915790157911579215793157941579515796157971579815799158001580115802158031580415805158061580715808158091581015811158121581315814158151581615817158181581915820158211582215823158241582515826158271582815829158301583115832158331583415835158361583715838158391584015841158421584315844158451584615847158481584915850158511585215853158541585515856158571585815859158601586115862158631586415865158661586715868158691587015871158721587315874158751587615877158781587915880158811588215883158841588515886158871588815889158901589115892158931589415895158961589715898158991590015901159021590315904159051590615907159081590915910159111591215913159141591515916159171591815919159201592115922159231592415925159261592715928159291593015931159321593315934159351593615937159381593915940159411594215943159441594515946159471594815949159501595115952159531595415955159561595715958159591596015961159621596315964159651596615967159681596915970159711597215973159741597515976159771597815979159801598115982159831598415985159861598715988159891599015991159921599315994159951599615997159981599916000160011600216003160041600516006160071600816009160101601116012160131601416015160161601716018160191602016021160221602316024160251602616027160281602916030160311603216033160341603516036160371603816039160401604116042160431604416045160461604716048160491605016051160521605316054160551605616057160581605916060160611606216063160641606516066160671606816069160701607116072160731607416075160761607716078160791608016081160821608316084160851608616087160881608916090160911609216093160941609516096160971609816099161001610116102161031610416105161061610716108161091611016111161121611316114161151611616117161181611916120161211612216123161241612516126161271612816129161301613116132161331613416135161361613716138161391614016141161421614316144161451614616147161481614916150161511615216153161541615516156161571615816159161601616116162161631616416165161661616716168161691617016171161721617316174161751617616177161781617916180161811618216183161841618516186161871618816189161901619116192161931619416195161961619716198161991620016201162021620316204162051620616207162081620916210162111621216213162141621516216162171621816219162201622116222162231622416225162261622716228162291623016231162321623316234162351623616237162381623916240162411624216243162441624516246162471624816249162501625116252162531625416255162561625716258162591626016261162621626316264162651626616267162681626916270162711627216273162741627516276162771627816279162801628116282162831628416285162861628716288162891629016291162921629316294162951629616297162981629916300163011630216303163041630516306163071630816309163101631116312163131631416315163161631716318163191632016321163221632316324163251632616327163281632916330163311633216333163341633516336163371633816339163401634116342163431634416345163461634716348163491635016351163521635316354163551635616357163581635916360163611636216363163641636516366163671636816369163701637116372163731637416375163761637716378163791638016381163821638316384163851638616387163881638916390163911639216393163941639516396163971639816399164001640116402164031640416405164061640716408164091641016411164121641316414164151641616417164181641916420164211642216423164241642516426164271642816429164301643116432164331643416435164361643716438164391644016441164421644316444164451644616447164481644916450164511645216453164541645516456164571645816459164601646116462164631646416465164661646716468164691647016471164721647316474164751647616477164781647916480164811648216483164841648516486164871648816489164901649116492164931649416495164961649716498164991650016501165021650316504165051650616507165081650916510165111651216513165141651516516165171651816519165201652116522165231652416525165261652716528165291653016531165321653316534165351653616537165381653916540165411654216543165441654516546165471654816549165501655116552165531655416555165561655716558165591656016561165621656316564165651656616567165681656916570165711657216573165741657516576165771657816579165801658116582165831658416585165861658716588165891659016591165921659316594165951659616597165981659916600166011660216603166041660516606166071660816609166101661116612166131661416615166161661716618166191662016621166221662316624166251662616627166281662916630166311663216633166341663516636166371663816639166401664116642166431664416645166461664716648166491665016651166521665316654166551665616657166581665916660166611666216663166641666516666166671666816669166701667116672166731667416675166761667716678166791668016681166821668316684166851668616687166881668916690166911669216693166941669516696166971669816699167001670116702167031670416705167061670716708167091671016711167121671316714167151671616717167181671916720167211672216723167241672516726167271672816729167301673116732167331673416735167361673716738167391674016741167421674316744167451674616747167481674916750167511675216753167541675516756167571675816759167601676116762167631676416765167661676716768167691677016771167721677316774167751677616777167781677916780167811678216783167841678516786167871678816789167901679116792167931679416795167961679716798167991680016801168021680316804168051680616807168081680916810168111681216813168141681516816168171681816819168201682116822168231682416825168261682716828168291683016831168321683316834168351683616837168381683916840168411684216843168441684516846168471684816849168501685116852168531685416855168561685716858168591686016861168621686316864168651686616867168681686916870168711687216873168741687516876168771687816879168801688116882168831688416885168861688716888168891689016891168921689316894168951689616897168981689916900169011690216903169041690516906169071690816909169101691116912169131691416915169161691716918169191692016921169221692316924169251692616927169281692916930169311693216933169341693516936169371693816939169401694116942169431694416945169461694716948169491695016951169521695316954169551695616957169581695916960169611696216963169641696516966169671696816969169701697116972169731697416975169761697716978169791698016981169821698316984169851698616987169881698916990169911699216993169941699516996169971699816999170001700117002170031700417005170061700717008170091701017011170121701317014170151701617017170181701917020170211702217023170241702517026170271702817029170301703117032170331703417035170361703717038170391704017041170421704317044170451704617047170481704917050170511705217053170541705517056170571705817059170601706117062170631706417065170661706717068170691707017071170721707317074170751707617077170781707917080170811708217083170841708517086170871708817089170901709117092170931709417095170961709717098170991710017101171021710317104171051710617107171081710917110171111711217113171141711517116171171711817119171201712117122171231712417125171261712717128171291713017131171321713317134171351713617137171381713917140171411714217143171441714517146171471714817149171501715117152171531715417155171561715717158171591716017161171621716317164171651716617167171681716917170171711717217173171741717517176171771717817179171801718117182171831718417185171861718717188171891719017191171921719317194171951719617197171981719917200172011720217203172041720517206172071720817209172101721117212172131721417215172161721717218172191722017221172221722317224172251722617227172281722917230172311723217233172341723517236172371723817239172401724117242172431724417245172461724717248172491725017251172521725317254172551725617257172581725917260172611726217263172641726517266172671726817269172701727117272172731727417275172761727717278172791728017281172821728317284172851728617287172881728917290172911729217293172941729517296172971729817299173001730117302173031730417305173061730717308173091731017311173121731317314173151731617317173181731917320173211732217323173241732517326173271732817329173301733117332173331733417335173361733717338173391734017341173421734317344173451734617347173481734917350173511735217353173541735517356173571735817359173601736117362173631736417365173661736717368173691737017371173721737317374173751737617377173781737917380173811738217383173841738517386173871738817389173901739117392173931739417395173961739717398173991740017401174021740317404174051740617407174081740917410174111741217413174141741517416174171741817419174201742117422174231742417425174261742717428174291743017431174321743317434174351743617437174381743917440174411744217443174441744517446174471744817449174501745117452174531745417455174561745717458174591746017461174621746317464174651746617467174681746917470174711747217473174741747517476174771747817479174801748117482174831748417485174861748717488174891749017491174921749317494174951749617497174981749917500175011750217503175041750517506175071750817509175101751117512175131751417515175161751717518175191752017521175221752317524175251752617527175281752917530175311753217533175341753517536175371753817539175401754117542175431754417545175461754717548175491755017551175521755317554175551755617557175581755917560175611756217563175641756517566175671756817569175701757117572175731757417575175761757717578175791758017581175821758317584175851758617587175881758917590175911759217593175941759517596175971759817599176001760117602176031760417605176061760717608176091761017611176121761317614176151761617617176181761917620176211762217623176241762517626176271762817629176301763117632176331763417635176361763717638176391764017641176421764317644176451764617647176481764917650176511765217653176541765517656176571765817659176601766117662176631766417665176661766717668176691767017671176721767317674176751767617677176781767917680176811768217683176841768517686176871768817689176901769117692176931769417695176961769717698176991770017701177021770317704177051770617707177081770917710177111771217713177141771517716177171771817719177201772117722177231772417725177261772717728177291773017731177321773317734177351773617737177381773917740177411774217743177441774517746177471774817749177501775117752177531775417755177561775717758177591776017761177621776317764177651776617767177681776917770177711777217773177741777517776177771777817779177801778117782177831778417785177861778717788177891779017791177921779317794177951779617797177981779917800178011780217803178041780517806178071780817809178101781117812178131781417815178161781717818178191782017821178221782317824178251782617827178281782917830178311783217833178341783517836178371783817839178401784117842178431784417845178461784717848178491785017851178521785317854178551785617857178581785917860178611786217863178641786517866178671786817869178701787117872178731787417875178761787717878178791788017881178821788317884178851788617887178881788917890178911789217893178941789517896178971789817899179001790117902179031790417905179061790717908179091791017911179121791317914179151791617917179181791917920179211792217923179241792517926179271792817929179301793117932179331793417935179361793717938179391794017941179421794317944179451794617947179481794917950179511795217953179541795517956179571795817959179601796117962179631796417965179661796717968179691797017971179721797317974179751797617977179781797917980179811798217983179841798517986179871798817989179901799117992179931799417995179961799717998179991800018001180021800318004180051800618007180081800918010180111801218013180141801518016180171801818019180201802118022180231802418025180261802718028180291803018031180321803318034180351803618037180381803918040180411804218043180441804518046180471804818049180501805118052180531805418055180561805718058180591806018061180621806318064180651806618067180681806918070180711807218073180741807518076180771807818079180801808118082180831808418085180861808718088180891809018091180921809318094180951809618097180981809918100181011810218103181041810518106181071810818109181101811118112181131811418115181161811718118181191812018121181221812318124181251812618127181281812918130181311813218133181341813518136181371813818139181401814118142181431814418145181461814718148181491815018151181521815318154181551815618157181581815918160181611816218163181641816518166181671816818169181701817118172181731817418175181761817718178181791818018181181821818318184181851818618187181881818918190181911819218193181941819518196181971819818199182001820118202182031820418205182061820718208182091821018211182121821318214182151821618217182181821918220182211822218223182241822518226182271822818229182301823118232182331823418235182361823718238182391824018241182421824318244182451824618247182481824918250182511825218253182541825518256182571825818259182601826118262182631826418265182661826718268182691827018271182721827318274182751827618277182781827918280182811828218283182841828518286182871828818289182901829118292182931829418295182961829718298182991830018301183021830318304183051830618307183081830918310183111831218313183141831518316183171831818319183201832118322183231832418325183261832718328183291833018331183321833318334183351833618337183381833918340183411834218343183441834518346183471834818349183501835118352183531835418355183561835718358183591836018361183621836318364183651836618367183681836918370183711837218373183741837518376183771837818379183801838118382183831838418385183861838718388183891839018391183921839318394183951839618397183981839918400184011840218403184041840518406184071840818409184101841118412184131841418415184161841718418184191842018421184221842318424184251842618427184281842918430184311843218433184341843518436184371843818439184401844118442184431844418445184461844718448184491845018451184521845318454184551845618457184581845918460184611846218463184641846518466184671846818469184701847118472184731847418475184761847718478184791848018481184821848318484184851848618487184881848918490184911849218493184941849518496184971849818499185001850118502185031850418505185061850718508185091851018511185121851318514185151851618517185181851918520185211852218523185241852518526185271852818529185301853118532185331853418535185361853718538185391854018541185421854318544185451854618547185481854918550185511855218553185541855518556185571855818559185601856118562185631856418565185661856718568185691857018571185721857318574185751857618577185781857918580185811858218583185841858518586185871858818589185901859118592185931859418595185961859718598185991860018601186021860318604186051860618607186081860918610186111861218613186141861518616186171861818619186201862118622186231862418625186261862718628186291863018631186321863318634186351863618637186381863918640186411864218643186441864518646186471864818649186501865118652186531865418655186561865718658186591866018661186621866318664186651866618667186681866918670186711867218673186741867518676186771867818679186801868118682186831868418685186861868718688186891869018691186921869318694186951869618697186981869918700187011870218703187041870518706187071870818709187101871118712187131871418715187161871718718187191872018721187221872318724187251872618727187281872918730187311873218733187341873518736187371873818739187401874118742187431874418745187461874718748187491875018751187521875318754187551875618757187581875918760187611876218763187641876518766187671876818769187701877118772187731877418775187761877718778187791878018781187821878318784187851878618787187881878918790187911879218793187941879518796187971879818799188001880118802188031880418805188061880718808188091881018811188121881318814188151881618817188181881918820188211882218823188241882518826188271882818829188301883118832188331883418835188361883718838188391884018841188421884318844188451884618847188481884918850188511885218853188541885518856188571885818859188601886118862188631886418865188661886718868188691887018871188721887318874188751887618877188781887918880188811888218883188841888518886188871888818889188901889118892188931889418895188961889718898188991890018901189021890318904189051890618907189081890918910189111891218913189141891518916189171891818919189201892118922189231892418925189261892718928189291893018931189321893318934189351893618937189381893918940189411894218943189441894518946189471894818949189501895118952189531895418955189561895718958189591896018961189621896318964189651896618967189681896918970189711897218973189741897518976189771897818979189801898118982189831898418985189861898718988189891899018991189921899318994189951899618997189981899919000190011900219003190041900519006190071900819009190101901119012190131901419015190161901719018190191902019021190221902319024190251902619027190281902919030190311903219033190341903519036190371903819039190401904119042190431904419045190461904719048190491905019051190521905319054190551905619057190581905919060190611906219063190641906519066190671906819069190701907119072190731907419075190761907719078190791908019081190821908319084190851908619087190881908919090190911909219093190941909519096190971909819099191001910119102191031910419105191061910719108191091911019111191121911319114191151911619117191181911919120191211912219123191241912519126191271912819129191301913119132191331913419135191361913719138191391914019141191421914319144191451914619147191481914919150191511915219153191541915519156191571915819159191601916119162191631916419165191661916719168191691917019171191721917319174191751917619177191781917919180191811918219183191841918519186191871918819189191901919119192191931919419195191961919719198191991920019201192021920319204192051920619207192081920919210192111921219213192141921519216192171921819219192201922119222192231922419225192261922719228192291923019231192321923319234192351923619237192381923919240192411924219243192441924519246192471924819249192501925119252192531925419255192561925719258192591926019261192621926319264192651926619267192681926919270192711927219273192741927519276192771927819279192801928119282192831928419285192861928719288192891929019291192921929319294192951929619297192981929919300193011930219303193041930519306193071930819309193101931119312193131931419315193161931719318193191932019321193221932319324193251932619327193281932919330193311933219333193341933519336193371933819339193401934119342193431934419345193461934719348193491935019351193521935319354193551935619357193581935919360193611936219363193641936519366193671936819369193701937119372193731937419375193761937719378193791938019381193821938319384193851938619387193881938919390193911939219393193941939519396193971939819399194001940119402194031940419405194061940719408194091941019411194121941319414194151941619417194181941919420194211942219423194241942519426194271942819429194301943119432194331943419435194361943719438194391944019441194421944319444194451944619447194481944919450194511945219453194541945519456194571945819459194601946119462194631946419465194661946719468194691947019471194721947319474194751947619477194781947919480194811948219483194841948519486194871948819489194901949119492194931949419495194961949719498194991950019501195021950319504195051950619507195081950919510195111951219513195141951519516195171951819519195201952119522195231952419525195261952719528195291953019531195321953319534195351953619537195381953919540195411954219543195441954519546195471954819549195501955119552195531955419555195561955719558195591956019561195621956319564195651956619567195681956919570195711957219573195741957519576195771957819579195801958119582195831958419585195861958719588195891959019591195921959319594195951959619597195981959919600196011960219603196041960519606196071960819609196101961119612196131961419615196161961719618196191962019621196221962319624196251962619627196281962919630196311963219633196341963519636196371963819639196401964119642196431964419645196461964719648196491965019651196521965319654196551965619657196581965919660196611966219663196641966519666196671966819669196701967119672196731967419675196761967719678196791968019681196821968319684196851968619687196881968919690196911969219693196941969519696196971969819699197001970119702197031970419705197061970719708197091971019711197121971319714197151971619717197181971919720197211972219723197241972519726197271972819729197301973119732197331973419735197361973719738197391974019741197421974319744197451974619747197481974919750197511975219753197541975519756197571975819759197601976119762197631976419765197661976719768197691977019771197721977319774197751977619777197781977919780197811978219783197841978519786197871978819789197901979119792197931979419795197961979719798197991980019801198021980319804198051980619807198081980919810198111981219813198141981519816198171981819819198201982119822198231982419825198261982719828198291983019831198321983319834198351983619837198381983919840198411984219843198441984519846198471984819849198501985119852198531985419855198561985719858198591986019861198621986319864198651986619867198681986919870198711987219873198741987519876198771987819879198801988119882198831988419885198861988719888198891989019891198921989319894198951989619897198981989919900199011990219903199041990519906199071990819909199101991119912199131991419915199161991719918199191992019921199221992319924199251992619927199281992919930199311993219933199341993519936199371993819939199401994119942199431994419945199461994719948199491995019951199521995319954199551995619957199581995919960199611996219963199641996519966199671996819969199701997119972199731997419975199761997719978199791998019981199821998319984199851998619987199881998919990199911999219993199941999519996199971999819999200002000120002200032000420005200062000720008200092001020011200122001320014200152001620017200182001920020200212002220023200242002520026200272002820029200302003120032200332003420035200362003720038200392004020041200422004320044200452004620047200482004920050200512005220053200542005520056200572005820059200602006120062200632006420065200662006720068200692007020071200722007320074200752007620077200782007920080200812008220083200842008520086200872008820089200902009120092200932009420095200962009720098200992010020101201022010320104201052010620107201082010920110201112011220113201142011520116201172011820119201202012120122201232012420125201262012720128201292013020131201322013320134201352013620137201382013920140201412014220143201442014520146201472014820149201502015120152201532015420155201562015720158201592016020161201622016320164201652016620167201682016920170201712017220173201742017520176201772017820179201802018120182201832018420185 |
- // #include "core/algorithm.hpp"
- #ifndef ENTT_CORE_ALGORITHM_HPP
- #define ENTT_CORE_ALGORITHM_HPP
- #include <vector>
- #include <utility>
- #include <iterator>
- #include <algorithm>
- #include <functional>
- // #include "utility.hpp"
- #ifndef ENTT_CORE_UTILITY_HPP
- #define ENTT_CORE_UTILITY_HPP
- #include <utility>
- // #include "../config/config.h"
- #ifndef ENTT_CONFIG_CONFIG_H
- #define ENTT_CONFIG_CONFIG_H
- #ifndef ENTT_NOEXCEPT
- # define ENTT_NOEXCEPT noexcept
- #endif
- #ifndef ENTT_HS_SUFFIX
- # define ENTT_HS_SUFFIX _hs
- #endif
- #ifndef ENTT_HWS_SUFFIX
- # define ENTT_HWS_SUFFIX _hws
- #endif
- #ifndef ENTT_USE_ATOMIC
- # define ENTT_MAYBE_ATOMIC(Type) Type
- #else
- # include <atomic>
- # define ENTT_MAYBE_ATOMIC(Type) std::atomic<Type>
- #endif
- #ifndef ENTT_ID_TYPE
- # include <cstdint>
- # define ENTT_ID_TYPE std::uint32_t
- #endif
- #ifndef ENTT_PAGE_SIZE
- # define ENTT_PAGE_SIZE 32768
- #endif
- #ifndef ENTT_ASSERT
- # include <cassert>
- # define ENTT_ASSERT(condition) assert(condition)
- #endif
- #ifndef ENTT_NO_ETO
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::is_empty<Type>
- #else
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::false_type
- #endif
- #ifndef ENTT_STANDARD_CPP
- # if defined __clang__ || (defined __GNUC__ && __GNUC__ > 8)
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined __GNUC__
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined _MSC_VER
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __FUNCSIG__
- # define ENTT_PRETTY_FUNCTION_PREFIX '<'
- # define ENTT_PRETTY_FUNCTION_SUFFIX '>'
- # endif
- #endif
- #ifndef ENTT_STANDALONE
- # define ENTT_FAST_PATH(...) false
- #else
- # define ENTT_FAST_PATH(Cond) Cond
- #endif
- #endif
- namespace entt {
- /*! @brief Identity function object (waiting for C++20). */
- struct identity {
- /**
- * @brief Returns its argument unchanged.
- * @tparam Type Type of the argument.
- * @param value The actual argument.
- * @return The submitted value as-is.
- */
- template<class Type>
- [[nodiscard]] constexpr Type && operator()(Type &&value) const ENTT_NOEXCEPT {
- return std::forward<Type>(value);
- }
- };
- /**
- * @brief Constant utility to disambiguate overloaded members of a class.
- * @tparam Type Type of the desired overload.
- * @tparam Class Type of class to which the member belongs.
- * @param member A valid pointer to a member.
- * @return Pointer to the member.
- */
- template<typename Type, typename Class>
- [[nodiscard]] constexpr auto overload(Type Class:: *member) ENTT_NOEXCEPT { return member; }
- /**
- * @brief Constant utility to disambiguate overloaded functions.
- * @tparam Func Function type of the desired overload.
- * @param func A valid pointer to a function.
- * @return Pointer to the function.
- */
- template<typename Func>
- [[nodiscard]] constexpr auto overload(Func *func) ENTT_NOEXCEPT { return func; }
- /**
- * @brief Helper type for visitors.
- * @tparam Func Types of function objects.
- */
- template<class... Func>
- struct overloaded: Func... {
- using Func::operator()...;
- };
- /**
- * @brief Deduction guide.
- * @tparam Func Types of function objects.
- */
- template<class... Func>
- overloaded(Func...) -> overloaded<Func...>;
- /**
- * @brief Basic implementation of a y-combinator.
- * @tparam Func Type of a potentially recursive function.
- */
- template<class Func>
- struct y_combinator {
- /**
- * @brief Constructs a y-combinator from a given function.
- * @param recursive A potentially recursive function.
- */
- y_combinator(Func recursive):
- func{std::move(recursive)}
- {}
- /**
- * @brief Invokes a y-combinator and therefore its underlying function.
- * @tparam Args Types of arguments to use to invoke the underlying function.
- * @param args Parameters to use to invoke the underlying function.
- * @return Return value of the underlying function, if any.
- */
- template <class... Args>
- decltype(auto) operator()(Args &&... args) const {
- return func(*this, std::forward<Args>(args)...);
- }
- /*! @copydoc operator()() */
- template <class... Args>
- decltype(auto) operator()(Args &&... args) {
- return func(*this, std::forward<Args>(args)...);
- }
- private:
- Func func;
- };
- }
- #endif
- namespace entt {
- /**
- * @brief Function object to wrap `std::sort` in a class type.
- *
- * Unfortunately, `std::sort` cannot be passed as template argument to a class
- * template or a function template.<br/>
- * This class fills the gap by wrapping some flavors of `std::sort` in a
- * function object.
- */
- struct std_sort {
- /**
- * @brief Sorts the elements in a range.
- *
- * Sorts the elements in a range using the given binary comparison function.
- *
- * @tparam It Type of random access iterator.
- * @tparam Compare Type of comparison function object.
- * @tparam Args Types of arguments to forward to the sort function.
- * @param first An iterator to the first element of the range to sort.
- * @param last An iterator past the last element of the range to sort.
- * @param compare A valid comparison function object.
- * @param args Arguments to forward to the sort function, if any.
- */
- template<typename It, typename Compare = std::less<>, typename... Args>
- void operator()(It first, It last, Compare compare = Compare{}, Args &&... args) const {
- std::sort(std::forward<Args>(args)..., std::move(first), std::move(last), std::move(compare));
- }
- };
- /*! @brief Function object for performing insertion sort. */
- struct insertion_sort {
- /**
- * @brief Sorts the elements in a range.
- *
- * Sorts the elements in a range using the given binary comparison function.
- *
- * @tparam It Type of random access iterator.
- * @tparam Compare Type of comparison function object.
- * @param first An iterator to the first element of the range to sort.
- * @param last An iterator past the last element of the range to sort.
- * @param compare A valid comparison function object.
- */
- template<typename It, typename Compare = std::less<>>
- void operator()(It first, It last, Compare compare = Compare{}) const {
- if(first < last) {
- for(auto it = first+1; it < last; ++it) {
- auto value = std::move(*it);
- auto pre = it;
- for(; pre > first && compare(value, *(pre-1)); --pre) {
- *pre = std::move(*(pre-1));
- }
- *pre = std::move(value);
- }
- }
- }
- };
- /**
- * @brief Function object for performing LSD radix sort.
- * @tparam Bit Number of bits processed per pass.
- * @tparam N Maximum number of bits to sort.
- */
- template<std::size_t Bit, std::size_t N>
- struct radix_sort {
- static_assert((N % Bit) == 0, "The maximum number of bits to sort must be a multiple of the number of bits processed per pass");
- /**
- * @brief Sorts the elements in a range.
- *
- * Sorts the elements in a range using the given _getter_ to access the
- * actual data to be sorted.
- *
- * This implementation is inspired by the online book
- * [Physically Based Rendering](http://www.pbr-book.org/3ed-2018/Primitives_and_Intersection_Acceleration/Bounding_Volume_Hierarchies.html#RadixSort).
- *
- * @tparam It Type of random access iterator.
- * @tparam Getter Type of _getter_ function object.
- * @param first An iterator to the first element of the range to sort.
- * @param last An iterator past the last element of the range to sort.
- * @param getter A valid _getter_ function object.
- */
- template<typename It, typename Getter = identity>
- void operator()(It first, It last, Getter getter = Getter{}) const {
- if(first < last) {
- static constexpr auto mask = (1 << Bit) - 1;
- static constexpr auto buckets = 1 << Bit;
- static constexpr auto passes = N / Bit;
- using value_type = typename std::iterator_traits<It>::value_type;
- std::vector<value_type> aux(std::distance(first, last));
- auto part = [getter = std::move(getter)](auto from, auto to, auto out, auto start) {
- std::size_t index[buckets]{};
- std::size_t count[buckets]{};
- std::for_each(from, to, [&getter, &count, start](const value_type &item) {
- ++count[(getter(item) >> start) & mask];
- });
- std::for_each(std::next(std::begin(index)), std::end(index), [index = std::begin(index), count = std::begin(count)](auto &item) mutable {
- item = *(index++) + *(count++);
- });
- std::for_each(from, to, [&getter, &out, &index, start](value_type &item) {
- out[index[(getter(item) >> start) & mask]++] = std::move(item);
- });
- };
- for(std::size_t pass = 0; pass < (passes & ~1); pass += 2) {
- part(first, last, aux.begin(), pass * Bit);
- part(aux.begin(), aux.end(), first, (pass + 1) * Bit);
- }
- if constexpr(passes & 1) {
- part(first, last, aux.begin(), (passes - 1) * Bit);
- std::move(aux.begin(), aux.end(), first);
- }
- }
- }
- };
- }
- #endif
- // #include "core/attribute.h"
- #ifndef ENTT_CORE_ATTRIBUTE_H
- #define ENTT_CORE_ATTRIBUTE_H
- #ifndef ENTT_EXPORT
- # if defined _WIN32 || defined __CYGWIN__ || defined _MSC_VER
- # define ENTT_EXPORT __declspec(dllexport)
- # define ENTT_IMPORT __declspec(dllimport)
- # define ENTT_HIDDEN
- # elif defined __GNUC__ && __GNUC__ >= 4
- # define ENTT_EXPORT __attribute__((visibility("default")))
- # define ENTT_IMPORT __attribute__((visibility("default")))
- # define ENTT_HIDDEN __attribute__((visibility("hidden")))
- # else /* Unsupported compiler */
- # define ENTT_EXPORT
- # define ENTT_IMPORT
- # define ENTT_HIDDEN
- # endif
- #endif
- #ifndef ENTT_API
- # if defined ENTT_API_EXPORT
- # define ENTT_API ENTT_EXPORT
- # elif defined ENTT_API_IMPORT
- # define ENTT_API ENTT_IMPORT
- # else /* No API */
- # define ENTT_API
- # endif
- #endif
- #endif
- // #include "core/family.hpp"
- #ifndef ENTT_CORE_FAMILY_HPP
- #define ENTT_CORE_FAMILY_HPP
- // #include "../config/config.h"
- // #include "fwd.hpp"
- #ifndef ENTT_CORE_FWD_HPP
- #define ENTT_CORE_FWD_HPP
- // #include "../config/config.h"
- namespace entt {
- /*! @brief Alias declaration for type identifiers. */
- using id_type = ENTT_ID_TYPE;
- }
- #endif
- namespace entt {
- /**
- * @brief Dynamic identifier generator.
- *
- * Utility class template that can be used to assign unique identifiers to types
- * at runtime. Use different specializations to create separate sets of
- * identifiers.
- */
- template<typename...>
- class family {
- inline static ENTT_MAYBE_ATOMIC(id_type) identifier{};
- public:
- /*! @brief Unsigned integer type. */
- using family_type = id_type;
- /*! @brief Statically generated unique identifier for the given type. */
- template<typename... Type>
- // at the time I'm writing, clang crashes during compilation if auto is used instead of family_type
- inline static const family_type type = identifier++;
- };
- }
- #endif
- // #include "core/hashed_string.hpp"
- #ifndef ENTT_CORE_HASHED_STRING_HPP
- #define ENTT_CORE_HASHED_STRING_HPP
- #include <cstddef>
- #include <cstdint>
- // #include "../config/config.h"
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @cond TURN_OFF_DOXYGEN
- * Internal details not to be documented.
- */
- namespace internal {
- template<typename>
- struct fnv1a_traits;
- template<>
- struct fnv1a_traits<std::uint32_t> {
- using type = std::uint32_t;
- static constexpr std::uint32_t offset = 2166136261;
- static constexpr std::uint32_t prime = 16777619;
- };
- template<>
- struct fnv1a_traits<std::uint64_t> {
- using type = std::uint64_t;
- static constexpr std::uint64_t offset = 14695981039346656037ull;
- static constexpr std::uint64_t prime = 1099511628211ull;
- };
- }
- /**
- * Internal details not to be documented.
- * @endcond
- */
- /**
- * @brief Zero overhead unique identifier.
- *
- * A hashed string is a compile-time tool that allows users to use
- * human-readable identifers in the codebase while using their numeric
- * counterparts at runtime.<br/>
- * Because of that, a hashed string can also be used in constant expressions if
- * required.
- *
- * @tparam Char Character type.
- */
- template<typename Char>
- class basic_hashed_string {
- using traits_type = internal::fnv1a_traits<id_type>;
- struct const_wrapper {
- // non-explicit constructor on purpose
- constexpr const_wrapper(const Char *curr) ENTT_NOEXCEPT: str{curr} {}
- const Char *str;
- };
- // Fowler–Noll–Vo hash function v. 1a - the good
- [[nodiscard]] static constexpr id_type helper(const Char *curr) ENTT_NOEXCEPT {
- auto value = traits_type::offset;
- while(*curr != 0) {
- value = (value ^ static_cast<traits_type::type>(*(curr++))) * traits_type::prime;
- }
- return value;
- }
- public:
- /*! @brief Character type. */
- using value_type = Char;
- /*! @brief Unsigned integer type. */
- using hash_type = id_type;
- /**
- * @brief Returns directly the numeric representation of a string.
- *
- * Forcing template resolution avoids implicit conversions. An
- * human-readable identifier can be anything but a plain, old bunch of
- * characters.<br/>
- * Example of use:
- * @code{.cpp}
- * const auto value = basic_hashed_string<char>::to_value("my.png");
- * @endcode
- *
- * @tparam N Number of characters of the identifier.
- * @param str Human-readable identifer.
- * @return The numeric representation of the string.
- */
- template<std::size_t N>
- [[nodiscard]] static constexpr hash_type value(const value_type (&str)[N]) ENTT_NOEXCEPT {
- return helper(str);
- }
- /**
- * @brief Returns directly the numeric representation of a string.
- * @param wrapper Helps achieving the purpose by relying on overloading.
- * @return The numeric representation of the string.
- */
- [[nodiscard]] static hash_type value(const_wrapper wrapper) ENTT_NOEXCEPT {
- return helper(wrapper.str);
- }
- /**
- * @brief Returns directly the numeric representation of a string view.
- * @param str Human-readable identifer.
- * @param size Length of the string to hash.
- * @return The numeric representation of the string.
- */
- [[nodiscard]] static hash_type value(const value_type *str, std::size_t size) ENTT_NOEXCEPT {
- id_type partial{traits_type::offset};
- while(size--) { partial = (partial^(str++)[0])*traits_type::prime; }
- return partial;
- }
- /*! @brief Constructs an empty hashed string. */
- constexpr basic_hashed_string() ENTT_NOEXCEPT
- : str{nullptr}, hash{}
- {}
- /**
- * @brief Constructs a hashed string from an array of const characters.
- *
- * Forcing template resolution avoids implicit conversions. An
- * human-readable identifier can be anything but a plain, old bunch of
- * characters.<br/>
- * Example of use:
- * @code{.cpp}
- * basic_hashed_string<char> hs{"my.png"};
- * @endcode
- *
- * @tparam N Number of characters of the identifier.
- * @param curr Human-readable identifer.
- */
- template<std::size_t N>
- constexpr basic_hashed_string(const value_type (&curr)[N]) ENTT_NOEXCEPT
- : str{curr}, hash{helper(curr)}
- {}
- /**
- * @brief Explicit constructor on purpose to avoid constructing a hashed
- * string directly from a `const value_type *`.
- * @param wrapper Helps achieving the purpose by relying on overloading.
- */
- explicit constexpr basic_hashed_string(const_wrapper wrapper) ENTT_NOEXCEPT
- : str{wrapper.str}, hash{helper(wrapper.str)}
- {}
- /**
- * @brief Returns the human-readable representation of a hashed string.
- * @return The string used to initialize the instance.
- */
- [[nodiscard]] constexpr const value_type * data() const ENTT_NOEXCEPT {
- return str;
- }
- /**
- * @brief Returns the numeric representation of a hashed string.
- * @return The numeric representation of the instance.
- */
- [[nodiscard]] constexpr hash_type value() const ENTT_NOEXCEPT {
- return hash;
- }
- /*! @copydoc data */
- [[nodiscard]] constexpr operator const value_type *() const ENTT_NOEXCEPT { return data(); }
- /**
- * @brief Returns the numeric representation of a hashed string.
- * @return The numeric representation of the instance.
- */
- [[nodiscard]] constexpr operator hash_type() const ENTT_NOEXCEPT { return value(); }
- /**
- * @brief Compares two hashed strings.
- * @param other Hashed string with which to compare.
- * @return True if the two hashed strings are identical, false otherwise.
- */
- [[nodiscard]] constexpr bool operator==(const basic_hashed_string &other) const ENTT_NOEXCEPT {
- return hash == other.hash;
- }
- private:
- const value_type *str;
- hash_type hash;
- };
- /**
- * @brief Deduction guide.
- *
- * It allows to deduce the character type of the hashed string directly from a
- * human-readable identifer provided to the constructor.
- *
- * @tparam Char Character type.
- * @tparam N Number of characters of the identifier.
- * @param str Human-readable identifer.
- */
- template<typename Char, std::size_t N>
- basic_hashed_string(const Char (&str)[N]) ENTT_NOEXCEPT
- -> basic_hashed_string<Char>;
- /**
- * @brief Compares two hashed strings.
- * @tparam Char Character type.
- * @param lhs A valid hashed string.
- * @param rhs A valid hashed string.
- * @return True if the two hashed strings are identical, false otherwise.
- */
- template<typename Char>
- [[nodiscard]] constexpr bool operator!=(const basic_hashed_string<Char> &lhs, const basic_hashed_string<Char> &rhs) ENTT_NOEXCEPT {
- return !(lhs == rhs);
- }
- /*! @brief Aliases for common character types. */
- using hashed_string = basic_hashed_string<char>;
- /*! @brief Aliases for common character types. */
- using hashed_wstring = basic_hashed_string<wchar_t>;
- }
- /**
- * @brief User defined literal for hashed strings.
- * @param str The literal without its suffix.
- * @return A properly initialized hashed string.
- */
- [[nodiscard]] constexpr entt::hashed_string operator"" ENTT_HS_SUFFIX(const char *str, std::size_t) ENTT_NOEXCEPT {
- return entt::hashed_string{str};
- }
- /**
- * @brief User defined literal for hashed wstrings.
- * @param str The literal without its suffix.
- * @return A properly initialized hashed wstring.
- */
- [[nodiscard]] constexpr entt::hashed_wstring operator"" ENTT_HWS_SUFFIX(const wchar_t *str, std::size_t) ENTT_NOEXCEPT {
- return entt::hashed_wstring{str};
- }
- #endif
- // #include "core/ident.hpp"
- #ifndef ENTT_CORE_IDENT_HPP
- #define ENTT_CORE_IDENT_HPP
- #include <tuple>
- #include <cstddef>
- #include <utility>
- #include <type_traits>
- // #include "../config/config.h"
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @brief Types identifiers.
- *
- * Variable template used to generate identifiers at compile-time for the given
- * types. Use the `get` member function to know what's the identifier associated
- * to the specific type.
- *
- * @note
- * Identifiers are constant expression and can be used in any context where such
- * an expression is required. As an example:
- * @code{.cpp}
- * using id = entt::identifier<a_type, another_type>;
- *
- * switch(a_type_identifier) {
- * case id::type<a_type>:
- * // ...
- * break;
- * case id::type<another_type>:
- * // ...
- * break;
- * default:
- * // ...
- * }
- * @endcode
- *
- * @tparam Types List of types for which to generate identifiers.
- */
- template<typename... Types>
- class identifier {
- using tuple_type = std::tuple<std::decay_t<Types>...>;
- template<typename Type, std::size_t... Indexes>
- [[nodiscard]] static constexpr id_type get(std::index_sequence<Indexes...>) {
- static_assert(std::disjunction_v<std::is_same<Type, Types>...>, "Invalid type");
- return (0 + ... + (std::is_same_v<Type, std::tuple_element_t<Indexes, tuple_type>> ? id_type(Indexes) : id_type{}));
- }
- public:
- /*! @brief Unsigned integer type. */
- using identifier_type = id_type;
- /*! @brief Statically generated unique identifier for the given type. */
- template<typename Type>
- static constexpr identifier_type type = get<std::decay_t<Type>>(std::index_sequence_for<Types...>{});
- };
- }
- #endif
- // #include "core/monostate.hpp"
- #ifndef ENTT_CORE_MONOSTATE_HPP
- #define ENTT_CORE_MONOSTATE_HPP
- // #include "../config/config.h"
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @brief Minimal implementation of the monostate pattern.
- *
- * A minimal, yet complete configuration system built on top of the monostate
- * pattern. Thread safe by design, it works only with basic types like `int`s or
- * `bool`s.<br/>
- * Multiple types and therefore more than one value can be associated with a
- * single key. Because of this, users must pay attention to use the same type
- * both during an assignment and when they try to read back their data.
- * Otherwise, they can incur in unexpected results.
- */
- template<id_type>
- struct monostate {
- /**
- * @brief Assigns a value of a specific type to a given key.
- * @tparam Type Type of the value to assign.
- * @param val User data to assign to the given key.
- */
- template<typename Type>
- void operator=(Type val) const ENTT_NOEXCEPT {
- value<Type> = val;
- }
- /**
- * @brief Gets a value of a specific type for a given key.
- * @tparam Type Type of the value to get.
- * @return Stored value, if any.
- */
- template<typename Type>
- operator Type() const ENTT_NOEXCEPT {
- return value<Type>;
- }
- private:
- template<typename Type>
- inline static ENTT_MAYBE_ATOMIC(Type) value{};
- };
- /**
- * @brief Helper variable template.
- * @tparam Value Value used to differentiate between different variables.
- */
- template<id_type Value>
- inline monostate<Value> monostate_v = {};
- }
- #endif
- // #include "core/type_info.hpp"
- #ifndef ENTT_CORE_TYPE_INFO_HPP
- #define ENTT_CORE_TYPE_INFO_HPP
- #include <string_view>
- // #include "../config/config.h"
- // #include "../core/attribute.h"
- #ifndef ENTT_CORE_ATTRIBUTE_H
- #define ENTT_CORE_ATTRIBUTE_H
- #ifndef ENTT_EXPORT
- # if defined _WIN32 || defined __CYGWIN__ || defined _MSC_VER
- # define ENTT_EXPORT __declspec(dllexport)
- # define ENTT_IMPORT __declspec(dllimport)
- # define ENTT_HIDDEN
- # elif defined __GNUC__ && __GNUC__ >= 4
- # define ENTT_EXPORT __attribute__((visibility("default")))
- # define ENTT_IMPORT __attribute__((visibility("default")))
- # define ENTT_HIDDEN __attribute__((visibility("hidden")))
- # else /* Unsupported compiler */
- # define ENTT_EXPORT
- # define ENTT_IMPORT
- # define ENTT_HIDDEN
- # endif
- #endif
- #ifndef ENTT_API
- # if defined ENTT_API_EXPORT
- # define ENTT_API ENTT_EXPORT
- # elif defined ENTT_API_IMPORT
- # define ENTT_API ENTT_IMPORT
- # else /* No API */
- # define ENTT_API
- # endif
- #endif
- #endif
- // #include "hashed_string.hpp"
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @cond TURN_OFF_DOXYGEN
- * Internal details not to be documented.
- */
- namespace internal {
- struct ENTT_API type_index {
- [[nodiscard]] static id_type next() ENTT_NOEXCEPT {
- static ENTT_MAYBE_ATOMIC(id_type) value{};
- return value++;
- }
- };
- template<typename Type>
- [[nodiscard]] constexpr auto type_name() ENTT_NOEXCEPT {
- #if defined ENTT_PRETTY_FUNCTION
- std::string_view pretty_function{ENTT_PRETTY_FUNCTION};
- auto first = pretty_function.find_first_not_of(' ', pretty_function.find_first_of(ENTT_PRETTY_FUNCTION_PREFIX)+1);
- auto value = pretty_function.substr(first, pretty_function.find_last_of(ENTT_PRETTY_FUNCTION_SUFFIX) - first);
- return value;
- #else
- return std::string_view{};
- #endif
- }
- }
- /**
- * Internal details not to be documented.
- * @endcond
- */
- /**
- * @brief Type index.
- * @tparam Type Type for which to generate a sequential identifier.
- */
- template<typename Type, typename = void>
- struct ENTT_API type_index {
- /**
- * @brief Returns the sequential identifier of a given type.
- * @return The sequential identifier of a given type.
- */
- [[nodiscard]] static id_type value() ENTT_NOEXCEPT {
- static const id_type value = internal::type_index::next();
- return value;
- }
- };
- /**
- * @brief Provides the member constant `value` to true if a given type is
- * indexable, false otherwise.
- * @tparam Type Potentially indexable type.
- */
- template<typename, typename = void>
- struct has_type_index: std::false_type {};
- /*! @brief has_type_index */
- template<typename Type>
- struct has_type_index<Type, std::void_t<decltype(type_index<Type>::value())>>: std::true_type {};
- /**
- * @brief Helper variable template.
- * @tparam Type Potentially indexable type.
- */
- template<typename Type>
- inline constexpr bool has_type_index_v = has_type_index<Type>::value;
- /**
- * @brief Type info.
- * @tparam Type Type for which to generate information.
- */
- template<typename Type, typename = void>
- struct type_info {
- /**
- * @brief Returns the numeric representation of a given type.
- * @return The numeric representation of the given type.
- */
- #if defined ENTT_PRETTY_FUNCTION_CONSTEXPR
- [[nodiscard]] static constexpr id_type id() ENTT_NOEXCEPT {
- constexpr auto value = hashed_string::value(ENTT_PRETTY_FUNCTION);
- return value;
- }
- #elif defined ENTT_PRETTY_FUNCTION
- [[nodiscard]] static id_type id() ENTT_NOEXCEPT {
- static const auto value = hashed_string::value(ENTT_PRETTY_FUNCTION);
- return value;
- }
- #else
- [[nodiscard]] static id_type id() ENTT_NOEXCEPT {
- return type_index<Type>::value();
- }
- #endif
- /**
- * @brief Returns the name of a given type.
- * @return The name of the given type.
- */
- #if defined ENTT_PRETTY_FUNCTION_CONSTEXPR
- [[nodiscard]] static constexpr std::string_view name() ENTT_NOEXCEPT {
- constexpr auto value = internal::type_name<Type>();
- return value;
- }
- #elif defined ENTT_PRETTY_FUNCTION
- [[nodiscard]] static std::string_view name() ENTT_NOEXCEPT {
- static const auto value = internal::type_name<Type>();
- return value;
- }
- #else
- [[nodiscard]] static constexpr std::string_view name() ENTT_NOEXCEPT {
- return internal::type_name<Type>();
- }
- #endif
- };
- }
- #endif
- // #include "core/type_traits.hpp"
- #ifndef ENTT_CORE_TYPE_TRAITS_HPP
- #define ENTT_CORE_TYPE_TRAITS_HPP
- #include <cstddef>
- #include <utility>
- #include <type_traits>
- // #include "../config/config.h"
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @brief Using declaration to be used to _repeat_ the same type a number of
- * times equal to the size of a given parameter pack.
- * @tparam Type A type to repeat.
- */
- template<typename Type, typename>
- using unpack_as_t = Type;
- /**
- * @brief Helper variable template to be used to _repeat_ the same value a
- * number of times equal to the size of a given parameter pack.
- * @tparam Value A value to repeat.
- */
- template<auto Value, typename>
- inline constexpr auto unpack_as_v = Value;
- /**
- * @brief Wraps a static constant.
- * @tparam Value A static constant.
- */
- template<auto Value>
- using integral_constant = std::integral_constant<decltype(Value), Value>;
- /**
- * @brief Alias template to ease the creation of named values.
- * @tparam Value A constant value at least convertible to `id_type`.
- */
- template<id_type Value>
- using tag = integral_constant<Value>;
- /**
- * @brief Utility class to disambiguate overloaded functions.
- * @tparam N Number of choices available.
- */
- template<std::size_t N>
- struct choice_t
- // Unfortunately, doxygen cannot parse such a construct.
- /*! @cond TURN_OFF_DOXYGEN */
- : choice_t<N-1>
- /*! @endcond */
- {};
- /*! @copybrief choice_t */
- template<>
- struct choice_t<0> {};
- /**
- * @brief Variable template for the choice trick.
- * @tparam N Number of choices available.
- */
- template<std::size_t N>
- inline constexpr choice_t<N> choice{};
- /*! @brief A class to use to push around lists of types, nothing more. */
- template<typename...>
- struct type_list {};
- /*! @brief Primary template isn't defined on purpose. */
- template<typename>
- struct type_list_size;
- /**
- * @brief Compile-time number of elements in a type list.
- * @tparam Type Types provided by the type list.
- */
- template<typename... Type>
- struct type_list_size<type_list<Type...>>
- : std::integral_constant<std::size_t, sizeof...(Type)>
- {};
- /**
- * @brief Helper variable template.
- * @tparam List Type list.
- */
- template<class List>
- inline constexpr auto type_list_size_v = type_list_size<List>::value;
- /*! @brief Primary template isn't defined on purpose. */
- template<typename...>
- struct type_list_cat;
- /*! @brief Concatenates multiple type lists. */
- template<>
- struct type_list_cat<> {
- /*! @brief A type list composed by the types of all the type lists. */
- using type = type_list<>;
- };
- /**
- * @brief Concatenates multiple type lists.
- * @tparam Type Types provided by the first type list.
- * @tparam Other Types provided by the second type list.
- * @tparam List Other type lists, if any.
- */
- template<typename... Type, typename... Other, typename... List>
- struct type_list_cat<type_list<Type...>, type_list<Other...>, List...> {
- /*! @brief A type list composed by the types of all the type lists. */
- using type = typename type_list_cat<type_list<Type..., Other...>, List...>::type;
- };
- /**
- * @brief Concatenates multiple type lists.
- * @tparam Type Types provided by the type list.
- */
- template<typename... Type>
- struct type_list_cat<type_list<Type...>> {
- /*! @brief A type list composed by the types of all the type lists. */
- using type = type_list<Type...>;
- };
- /**
- * @brief Helper type.
- * @tparam List Type lists to concatenate.
- */
- template<typename... List>
- using type_list_cat_t = typename type_list_cat<List...>::type;
- /*! @brief Primary template isn't defined on purpose. */
- template<typename>
- struct type_list_unique;
- /**
- * @brief Removes duplicates types from a type list.
- * @tparam Type One of the types provided by the given type list.
- * @tparam Other The other types provided by the given type list.
- */
- template<typename Type, typename... Other>
- struct type_list_unique<type_list<Type, Other...>> {
- /*! @brief A type list without duplicate types. */
- using type = std::conditional_t<
- std::disjunction_v<std::is_same<Type, Other>...>,
- typename type_list_unique<type_list<Other...>>::type,
- type_list_cat_t<type_list<Type>, typename type_list_unique<type_list<Other...>>::type>
- >;
- };
- /*! @brief Removes duplicates types from a type list. */
- template<>
- struct type_list_unique<type_list<>> {
- /*! @brief A type list without duplicate types. */
- using type = type_list<>;
- };
- /**
- * @brief Helper type.
- * @tparam Type A type list.
- */
- template<typename Type>
- using type_list_unique_t = typename type_list_unique<Type>::type;
- /**
- * @brief Provides the member constant `value` to true if a given type is
- * equality comparable, false otherwise.
- * @tparam Type Potentially equality comparable type.
- */
- template<typename Type, typename = std::void_t<>>
- struct is_equality_comparable: std::false_type {};
- /*! @copydoc is_equality_comparable */
- template<typename Type>
- struct is_equality_comparable<Type, std::void_t<decltype(std::declval<Type>() == std::declval<Type>())>>
- : std::true_type
- {};
- /**
- * @brief Helper variable template.
- * @tparam Type Potentially equality comparable type.
- */
- template<class Type>
- inline constexpr auto is_equality_comparable_v = is_equality_comparable<Type>::value;
- /**
- * @brief Provides the member constant `value` to true if a given type is empty
- * and the empty type optimization is enabled, false otherwise.
- * @tparam Type Potential empty type.
- */
- template<typename Type, typename = void>
- struct is_eto_eligible
- : ENTT_IS_EMPTY(Type)
- {};
- /**
- * @brief Helper variable template.
- * @tparam Type Potential empty type.
- */
- template<typename Type>
- inline constexpr auto is_eto_eligible_v = is_eto_eligible<Type>::value;
- /**
- * @brief Extracts the class of a non-static member object or function.
- * @tparam Member A pointer to a non-static member object or function.
- */
- template<typename Member>
- class member_class {
- static_assert(std::is_member_pointer_v<Member>, "Invalid pointer type to non-static member object or function");
- template<typename Class, typename Ret, typename... Args>
- static Class * clazz(Ret(Class:: *)(Args...));
- template<typename Class, typename Ret, typename... Args>
- static Class * clazz(Ret(Class:: *)(Args...) const);
- template<typename Class, typename Type>
- static Class * clazz(Type Class:: *);
- public:
- /*! @brief The class of the given non-static member object or function. */
- using type = std::remove_pointer_t<decltype(clazz(std::declval<Member>()))>;
- };
- /**
- * @brief Helper type.
- * @tparam Member A pointer to a non-static member object or function.
- */
- template<typename Member>
- using member_class_t = typename member_class<Member>::type;
- }
- #endif
- // #include "core/utility.hpp"
- // #include "entity/actor.hpp"
- #ifndef ENTT_ENTITY_ACTOR_HPP
- #define ENTT_ENTITY_ACTOR_HPP
- #include <utility>
- #include <type_traits>
- // #include "../config/config.h"
- #ifndef ENTT_CONFIG_CONFIG_H
- #define ENTT_CONFIG_CONFIG_H
- #ifndef ENTT_NOEXCEPT
- # define ENTT_NOEXCEPT noexcept
- #endif
- #ifndef ENTT_HS_SUFFIX
- # define ENTT_HS_SUFFIX _hs
- #endif
- #ifndef ENTT_HWS_SUFFIX
- # define ENTT_HWS_SUFFIX _hws
- #endif
- #ifndef ENTT_USE_ATOMIC
- # define ENTT_MAYBE_ATOMIC(Type) Type
- #else
- # include <atomic>
- # define ENTT_MAYBE_ATOMIC(Type) std::atomic<Type>
- #endif
- #ifndef ENTT_ID_TYPE
- # include <cstdint>
- # define ENTT_ID_TYPE std::uint32_t
- #endif
- #ifndef ENTT_PAGE_SIZE
- # define ENTT_PAGE_SIZE 32768
- #endif
- #ifndef ENTT_ASSERT
- # include <cassert>
- # define ENTT_ASSERT(condition) assert(condition)
- #endif
- #ifndef ENTT_NO_ETO
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::is_empty<Type>
- #else
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::false_type
- #endif
- #ifndef ENTT_STANDARD_CPP
- # if defined __clang__ || (defined __GNUC__ && __GNUC__ > 8)
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined __GNUC__
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined _MSC_VER
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __FUNCSIG__
- # define ENTT_PRETTY_FUNCTION_PREFIX '<'
- # define ENTT_PRETTY_FUNCTION_SUFFIX '>'
- # endif
- #endif
- #ifndef ENTT_STANDALONE
- # define ENTT_FAST_PATH(...) false
- #else
- # define ENTT_FAST_PATH(Cond) Cond
- #endif
- #endif
- // #include "registry.hpp"
- #ifndef ENTT_ENTITY_REGISTRY_HPP
- #define ENTT_ENTITY_REGISTRY_HPP
- #include <algorithm>
- #include <cstddef>
- #include <iterator>
- #include <memory>
- #include <tuple>
- #include <type_traits>
- #include <utility>
- #include <vector>
- // #include "../config/config.h"
- // #include "../core/algorithm.hpp"
- #ifndef ENTT_CORE_ALGORITHM_HPP
- #define ENTT_CORE_ALGORITHM_HPP
- #include <vector>
- #include <utility>
- #include <iterator>
- #include <algorithm>
- #include <functional>
- // #include "utility.hpp"
- #ifndef ENTT_CORE_UTILITY_HPP
- #define ENTT_CORE_UTILITY_HPP
- #include <utility>
- // #include "../config/config.h"
- #ifndef ENTT_CONFIG_CONFIG_H
- #define ENTT_CONFIG_CONFIG_H
- #ifndef ENTT_NOEXCEPT
- # define ENTT_NOEXCEPT noexcept
- #endif
- #ifndef ENTT_HS_SUFFIX
- # define ENTT_HS_SUFFIX _hs
- #endif
- #ifndef ENTT_HWS_SUFFIX
- # define ENTT_HWS_SUFFIX _hws
- #endif
- #ifndef ENTT_USE_ATOMIC
- # define ENTT_MAYBE_ATOMIC(Type) Type
- #else
- # include <atomic>
- # define ENTT_MAYBE_ATOMIC(Type) std::atomic<Type>
- #endif
- #ifndef ENTT_ID_TYPE
- # include <cstdint>
- # define ENTT_ID_TYPE std::uint32_t
- #endif
- #ifndef ENTT_PAGE_SIZE
- # define ENTT_PAGE_SIZE 32768
- #endif
- #ifndef ENTT_ASSERT
- # include <cassert>
- # define ENTT_ASSERT(condition) assert(condition)
- #endif
- #ifndef ENTT_NO_ETO
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::is_empty<Type>
- #else
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::false_type
- #endif
- #ifndef ENTT_STANDARD_CPP
- # if defined __clang__ || (defined __GNUC__ && __GNUC__ > 8)
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined __GNUC__
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined _MSC_VER
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __FUNCSIG__
- # define ENTT_PRETTY_FUNCTION_PREFIX '<'
- # define ENTT_PRETTY_FUNCTION_SUFFIX '>'
- # endif
- #endif
- #ifndef ENTT_STANDALONE
- # define ENTT_FAST_PATH(...) false
- #else
- # define ENTT_FAST_PATH(Cond) Cond
- #endif
- #endif
- namespace entt {
- /*! @brief Identity function object (waiting for C++20). */
- struct identity {
- /**
- * @brief Returns its argument unchanged.
- * @tparam Type Type of the argument.
- * @param value The actual argument.
- * @return The submitted value as-is.
- */
- template<class Type>
- [[nodiscard]] constexpr Type && operator()(Type &&value) const ENTT_NOEXCEPT {
- return std::forward<Type>(value);
- }
- };
- /**
- * @brief Constant utility to disambiguate overloaded members of a class.
- * @tparam Type Type of the desired overload.
- * @tparam Class Type of class to which the member belongs.
- * @param member A valid pointer to a member.
- * @return Pointer to the member.
- */
- template<typename Type, typename Class>
- [[nodiscard]] constexpr auto overload(Type Class:: *member) ENTT_NOEXCEPT { return member; }
- /**
- * @brief Constant utility to disambiguate overloaded functions.
- * @tparam Func Function type of the desired overload.
- * @param func A valid pointer to a function.
- * @return Pointer to the function.
- */
- template<typename Func>
- [[nodiscard]] constexpr auto overload(Func *func) ENTT_NOEXCEPT { return func; }
- /**
- * @brief Helper type for visitors.
- * @tparam Func Types of function objects.
- */
- template<class... Func>
- struct overloaded: Func... {
- using Func::operator()...;
- };
- /**
- * @brief Deduction guide.
- * @tparam Func Types of function objects.
- */
- template<class... Func>
- overloaded(Func...) -> overloaded<Func...>;
- /**
- * @brief Basic implementation of a y-combinator.
- * @tparam Func Type of a potentially recursive function.
- */
- template<class Func>
- struct y_combinator {
- /**
- * @brief Constructs a y-combinator from a given function.
- * @param recursive A potentially recursive function.
- */
- y_combinator(Func recursive):
- func{std::move(recursive)}
- {}
- /**
- * @brief Invokes a y-combinator and therefore its underlying function.
- * @tparam Args Types of arguments to use to invoke the underlying function.
- * @param args Parameters to use to invoke the underlying function.
- * @return Return value of the underlying function, if any.
- */
- template <class... Args>
- decltype(auto) operator()(Args &&... args) const {
- return func(*this, std::forward<Args>(args)...);
- }
- /*! @copydoc operator()() */
- template <class... Args>
- decltype(auto) operator()(Args &&... args) {
- return func(*this, std::forward<Args>(args)...);
- }
- private:
- Func func;
- };
- }
- #endif
- namespace entt {
- /**
- * @brief Function object to wrap `std::sort` in a class type.
- *
- * Unfortunately, `std::sort` cannot be passed as template argument to a class
- * template or a function template.<br/>
- * This class fills the gap by wrapping some flavors of `std::sort` in a
- * function object.
- */
- struct std_sort {
- /**
- * @brief Sorts the elements in a range.
- *
- * Sorts the elements in a range using the given binary comparison function.
- *
- * @tparam It Type of random access iterator.
- * @tparam Compare Type of comparison function object.
- * @tparam Args Types of arguments to forward to the sort function.
- * @param first An iterator to the first element of the range to sort.
- * @param last An iterator past the last element of the range to sort.
- * @param compare A valid comparison function object.
- * @param args Arguments to forward to the sort function, if any.
- */
- template<typename It, typename Compare = std::less<>, typename... Args>
- void operator()(It first, It last, Compare compare = Compare{}, Args &&... args) const {
- std::sort(std::forward<Args>(args)..., std::move(first), std::move(last), std::move(compare));
- }
- };
- /*! @brief Function object for performing insertion sort. */
- struct insertion_sort {
- /**
- * @brief Sorts the elements in a range.
- *
- * Sorts the elements in a range using the given binary comparison function.
- *
- * @tparam It Type of random access iterator.
- * @tparam Compare Type of comparison function object.
- * @param first An iterator to the first element of the range to sort.
- * @param last An iterator past the last element of the range to sort.
- * @param compare A valid comparison function object.
- */
- template<typename It, typename Compare = std::less<>>
- void operator()(It first, It last, Compare compare = Compare{}) const {
- if(first < last) {
- for(auto it = first+1; it < last; ++it) {
- auto value = std::move(*it);
- auto pre = it;
- for(; pre > first && compare(value, *(pre-1)); --pre) {
- *pre = std::move(*(pre-1));
- }
- *pre = std::move(value);
- }
- }
- }
- };
- /**
- * @brief Function object for performing LSD radix sort.
- * @tparam Bit Number of bits processed per pass.
- * @tparam N Maximum number of bits to sort.
- */
- template<std::size_t Bit, std::size_t N>
- struct radix_sort {
- static_assert((N % Bit) == 0, "The maximum number of bits to sort must be a multiple of the number of bits processed per pass");
- /**
- * @brief Sorts the elements in a range.
- *
- * Sorts the elements in a range using the given _getter_ to access the
- * actual data to be sorted.
- *
- * This implementation is inspired by the online book
- * [Physically Based Rendering](http://www.pbr-book.org/3ed-2018/Primitives_and_Intersection_Acceleration/Bounding_Volume_Hierarchies.html#RadixSort).
- *
- * @tparam It Type of random access iterator.
- * @tparam Getter Type of _getter_ function object.
- * @param first An iterator to the first element of the range to sort.
- * @param last An iterator past the last element of the range to sort.
- * @param getter A valid _getter_ function object.
- */
- template<typename It, typename Getter = identity>
- void operator()(It first, It last, Getter getter = Getter{}) const {
- if(first < last) {
- static constexpr auto mask = (1 << Bit) - 1;
- static constexpr auto buckets = 1 << Bit;
- static constexpr auto passes = N / Bit;
- using value_type = typename std::iterator_traits<It>::value_type;
- std::vector<value_type> aux(std::distance(first, last));
- auto part = [getter = std::move(getter)](auto from, auto to, auto out, auto start) {
- std::size_t index[buckets]{};
- std::size_t count[buckets]{};
- std::for_each(from, to, [&getter, &count, start](const value_type &item) {
- ++count[(getter(item) >> start) & mask];
- });
- std::for_each(std::next(std::begin(index)), std::end(index), [index = std::begin(index), count = std::begin(count)](auto &item) mutable {
- item = *(index++) + *(count++);
- });
- std::for_each(from, to, [&getter, &out, &index, start](value_type &item) {
- out[index[(getter(item) >> start) & mask]++] = std::move(item);
- });
- };
- for(std::size_t pass = 0; pass < (passes & ~1); pass += 2) {
- part(first, last, aux.begin(), pass * Bit);
- part(aux.begin(), aux.end(), first, (pass + 1) * Bit);
- }
- if constexpr(passes & 1) {
- part(first, last, aux.begin(), (passes - 1) * Bit);
- std::move(aux.begin(), aux.end(), first);
- }
- }
- }
- };
- }
- #endif
- // #include "../core/fwd.hpp"
- #ifndef ENTT_CORE_FWD_HPP
- #define ENTT_CORE_FWD_HPP
- // #include "../config/config.h"
- namespace entt {
- /*! @brief Alias declaration for type identifiers. */
- using id_type = ENTT_ID_TYPE;
- }
- #endif
- // #include "../core/type_info.hpp"
- #ifndef ENTT_CORE_TYPE_INFO_HPP
- #define ENTT_CORE_TYPE_INFO_HPP
- #include <string_view>
- // #include "../config/config.h"
- // #include "../core/attribute.h"
- #ifndef ENTT_CORE_ATTRIBUTE_H
- #define ENTT_CORE_ATTRIBUTE_H
- #ifndef ENTT_EXPORT
- # if defined _WIN32 || defined __CYGWIN__ || defined _MSC_VER
- # define ENTT_EXPORT __declspec(dllexport)
- # define ENTT_IMPORT __declspec(dllimport)
- # define ENTT_HIDDEN
- # elif defined __GNUC__ && __GNUC__ >= 4
- # define ENTT_EXPORT __attribute__((visibility("default")))
- # define ENTT_IMPORT __attribute__((visibility("default")))
- # define ENTT_HIDDEN __attribute__((visibility("hidden")))
- # else /* Unsupported compiler */
- # define ENTT_EXPORT
- # define ENTT_IMPORT
- # define ENTT_HIDDEN
- # endif
- #endif
- #ifndef ENTT_API
- # if defined ENTT_API_EXPORT
- # define ENTT_API ENTT_EXPORT
- # elif defined ENTT_API_IMPORT
- # define ENTT_API ENTT_IMPORT
- # else /* No API */
- # define ENTT_API
- # endif
- #endif
- #endif
- // #include "hashed_string.hpp"
- #ifndef ENTT_CORE_HASHED_STRING_HPP
- #define ENTT_CORE_HASHED_STRING_HPP
- #include <cstddef>
- #include <cstdint>
- // #include "../config/config.h"
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @cond TURN_OFF_DOXYGEN
- * Internal details not to be documented.
- */
- namespace internal {
- template<typename>
- struct fnv1a_traits;
- template<>
- struct fnv1a_traits<std::uint32_t> {
- using type = std::uint32_t;
- static constexpr std::uint32_t offset = 2166136261;
- static constexpr std::uint32_t prime = 16777619;
- };
- template<>
- struct fnv1a_traits<std::uint64_t> {
- using type = std::uint64_t;
- static constexpr std::uint64_t offset = 14695981039346656037ull;
- static constexpr std::uint64_t prime = 1099511628211ull;
- };
- }
- /**
- * Internal details not to be documented.
- * @endcond
- */
- /**
- * @brief Zero overhead unique identifier.
- *
- * A hashed string is a compile-time tool that allows users to use
- * human-readable identifers in the codebase while using their numeric
- * counterparts at runtime.<br/>
- * Because of that, a hashed string can also be used in constant expressions if
- * required.
- *
- * @tparam Char Character type.
- */
- template<typename Char>
- class basic_hashed_string {
- using traits_type = internal::fnv1a_traits<id_type>;
- struct const_wrapper {
- // non-explicit constructor on purpose
- constexpr const_wrapper(const Char *curr) ENTT_NOEXCEPT: str{curr} {}
- const Char *str;
- };
- // Fowler–Noll–Vo hash function v. 1a - the good
- [[nodiscard]] static constexpr id_type helper(const Char *curr) ENTT_NOEXCEPT {
- auto value = traits_type::offset;
- while(*curr != 0) {
- value = (value ^ static_cast<traits_type::type>(*(curr++))) * traits_type::prime;
- }
- return value;
- }
- public:
- /*! @brief Character type. */
- using value_type = Char;
- /*! @brief Unsigned integer type. */
- using hash_type = id_type;
- /**
- * @brief Returns directly the numeric representation of a string.
- *
- * Forcing template resolution avoids implicit conversions. An
- * human-readable identifier can be anything but a plain, old bunch of
- * characters.<br/>
- * Example of use:
- * @code{.cpp}
- * const auto value = basic_hashed_string<char>::to_value("my.png");
- * @endcode
- *
- * @tparam N Number of characters of the identifier.
- * @param str Human-readable identifer.
- * @return The numeric representation of the string.
- */
- template<std::size_t N>
- [[nodiscard]] static constexpr hash_type value(const value_type (&str)[N]) ENTT_NOEXCEPT {
- return helper(str);
- }
- /**
- * @brief Returns directly the numeric representation of a string.
- * @param wrapper Helps achieving the purpose by relying on overloading.
- * @return The numeric representation of the string.
- */
- [[nodiscard]] static hash_type value(const_wrapper wrapper) ENTT_NOEXCEPT {
- return helper(wrapper.str);
- }
- /**
- * @brief Returns directly the numeric representation of a string view.
- * @param str Human-readable identifer.
- * @param size Length of the string to hash.
- * @return The numeric representation of the string.
- */
- [[nodiscard]] static hash_type value(const value_type *str, std::size_t size) ENTT_NOEXCEPT {
- id_type partial{traits_type::offset};
- while(size--) { partial = (partial^(str++)[0])*traits_type::prime; }
- return partial;
- }
- /*! @brief Constructs an empty hashed string. */
- constexpr basic_hashed_string() ENTT_NOEXCEPT
- : str{nullptr}, hash{}
- {}
- /**
- * @brief Constructs a hashed string from an array of const characters.
- *
- * Forcing template resolution avoids implicit conversions. An
- * human-readable identifier can be anything but a plain, old bunch of
- * characters.<br/>
- * Example of use:
- * @code{.cpp}
- * basic_hashed_string<char> hs{"my.png"};
- * @endcode
- *
- * @tparam N Number of characters of the identifier.
- * @param curr Human-readable identifer.
- */
- template<std::size_t N>
- constexpr basic_hashed_string(const value_type (&curr)[N]) ENTT_NOEXCEPT
- : str{curr}, hash{helper(curr)}
- {}
- /**
- * @brief Explicit constructor on purpose to avoid constructing a hashed
- * string directly from a `const value_type *`.
- * @param wrapper Helps achieving the purpose by relying on overloading.
- */
- explicit constexpr basic_hashed_string(const_wrapper wrapper) ENTT_NOEXCEPT
- : str{wrapper.str}, hash{helper(wrapper.str)}
- {}
- /**
- * @brief Returns the human-readable representation of a hashed string.
- * @return The string used to initialize the instance.
- */
- [[nodiscard]] constexpr const value_type * data() const ENTT_NOEXCEPT {
- return str;
- }
- /**
- * @brief Returns the numeric representation of a hashed string.
- * @return The numeric representation of the instance.
- */
- [[nodiscard]] constexpr hash_type value() const ENTT_NOEXCEPT {
- return hash;
- }
- /*! @copydoc data */
- [[nodiscard]] constexpr operator const value_type *() const ENTT_NOEXCEPT { return data(); }
- /**
- * @brief Returns the numeric representation of a hashed string.
- * @return The numeric representation of the instance.
- */
- [[nodiscard]] constexpr operator hash_type() const ENTT_NOEXCEPT { return value(); }
- /**
- * @brief Compares two hashed strings.
- * @param other Hashed string with which to compare.
- * @return True if the two hashed strings are identical, false otherwise.
- */
- [[nodiscard]] constexpr bool operator==(const basic_hashed_string &other) const ENTT_NOEXCEPT {
- return hash == other.hash;
- }
- private:
- const value_type *str;
- hash_type hash;
- };
- /**
- * @brief Deduction guide.
- *
- * It allows to deduce the character type of the hashed string directly from a
- * human-readable identifer provided to the constructor.
- *
- * @tparam Char Character type.
- * @tparam N Number of characters of the identifier.
- * @param str Human-readable identifer.
- */
- template<typename Char, std::size_t N>
- basic_hashed_string(const Char (&str)[N]) ENTT_NOEXCEPT
- -> basic_hashed_string<Char>;
- /**
- * @brief Compares two hashed strings.
- * @tparam Char Character type.
- * @param lhs A valid hashed string.
- * @param rhs A valid hashed string.
- * @return True if the two hashed strings are identical, false otherwise.
- */
- template<typename Char>
- [[nodiscard]] constexpr bool operator!=(const basic_hashed_string<Char> &lhs, const basic_hashed_string<Char> &rhs) ENTT_NOEXCEPT {
- return !(lhs == rhs);
- }
- /*! @brief Aliases for common character types. */
- using hashed_string = basic_hashed_string<char>;
- /*! @brief Aliases for common character types. */
- using hashed_wstring = basic_hashed_string<wchar_t>;
- }
- /**
- * @brief User defined literal for hashed strings.
- * @param str The literal without its suffix.
- * @return A properly initialized hashed string.
- */
- [[nodiscard]] constexpr entt::hashed_string operator"" ENTT_HS_SUFFIX(const char *str, std::size_t) ENTT_NOEXCEPT {
- return entt::hashed_string{str};
- }
- /**
- * @brief User defined literal for hashed wstrings.
- * @param str The literal without its suffix.
- * @return A properly initialized hashed wstring.
- */
- [[nodiscard]] constexpr entt::hashed_wstring operator"" ENTT_HWS_SUFFIX(const wchar_t *str, std::size_t) ENTT_NOEXCEPT {
- return entt::hashed_wstring{str};
- }
- #endif
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @cond TURN_OFF_DOXYGEN
- * Internal details not to be documented.
- */
- namespace internal {
- struct ENTT_API type_index {
- [[nodiscard]] static id_type next() ENTT_NOEXCEPT {
- static ENTT_MAYBE_ATOMIC(id_type) value{};
- return value++;
- }
- };
- template<typename Type>
- [[nodiscard]] constexpr auto type_name() ENTT_NOEXCEPT {
- #if defined ENTT_PRETTY_FUNCTION
- std::string_view pretty_function{ENTT_PRETTY_FUNCTION};
- auto first = pretty_function.find_first_not_of(' ', pretty_function.find_first_of(ENTT_PRETTY_FUNCTION_PREFIX)+1);
- auto value = pretty_function.substr(first, pretty_function.find_last_of(ENTT_PRETTY_FUNCTION_SUFFIX) - first);
- return value;
- #else
- return std::string_view{};
- #endif
- }
- }
- /**
- * Internal details not to be documented.
- * @endcond
- */
- /**
- * @brief Type index.
- * @tparam Type Type for which to generate a sequential identifier.
- */
- template<typename Type, typename = void>
- struct ENTT_API type_index {
- /**
- * @brief Returns the sequential identifier of a given type.
- * @return The sequential identifier of a given type.
- */
- [[nodiscard]] static id_type value() ENTT_NOEXCEPT {
- static const id_type value = internal::type_index::next();
- return value;
- }
- };
- /**
- * @brief Provides the member constant `value` to true if a given type is
- * indexable, false otherwise.
- * @tparam Type Potentially indexable type.
- */
- template<typename, typename = void>
- struct has_type_index: std::false_type {};
- /*! @brief has_type_index */
- template<typename Type>
- struct has_type_index<Type, std::void_t<decltype(type_index<Type>::value())>>: std::true_type {};
- /**
- * @brief Helper variable template.
- * @tparam Type Potentially indexable type.
- */
- template<typename Type>
- inline constexpr bool has_type_index_v = has_type_index<Type>::value;
- /**
- * @brief Type info.
- * @tparam Type Type for which to generate information.
- */
- template<typename Type, typename = void>
- struct type_info {
- /**
- * @brief Returns the numeric representation of a given type.
- * @return The numeric representation of the given type.
- */
- #if defined ENTT_PRETTY_FUNCTION_CONSTEXPR
- [[nodiscard]] static constexpr id_type id() ENTT_NOEXCEPT {
- constexpr auto value = hashed_string::value(ENTT_PRETTY_FUNCTION);
- return value;
- }
- #elif defined ENTT_PRETTY_FUNCTION
- [[nodiscard]] static id_type id() ENTT_NOEXCEPT {
- static const auto value = hashed_string::value(ENTT_PRETTY_FUNCTION);
- return value;
- }
- #else
- [[nodiscard]] static id_type id() ENTT_NOEXCEPT {
- return type_index<Type>::value();
- }
- #endif
- /**
- * @brief Returns the name of a given type.
- * @return The name of the given type.
- */
- #if defined ENTT_PRETTY_FUNCTION_CONSTEXPR
- [[nodiscard]] static constexpr std::string_view name() ENTT_NOEXCEPT {
- constexpr auto value = internal::type_name<Type>();
- return value;
- }
- #elif defined ENTT_PRETTY_FUNCTION
- [[nodiscard]] static std::string_view name() ENTT_NOEXCEPT {
- static const auto value = internal::type_name<Type>();
- return value;
- }
- #else
- [[nodiscard]] static constexpr std::string_view name() ENTT_NOEXCEPT {
- return internal::type_name<Type>();
- }
- #endif
- };
- }
- #endif
- // #include "../core/type_traits.hpp"
- #ifndef ENTT_CORE_TYPE_TRAITS_HPP
- #define ENTT_CORE_TYPE_TRAITS_HPP
- #include <cstddef>
- #include <utility>
- #include <type_traits>
- // #include "../config/config.h"
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @brief Using declaration to be used to _repeat_ the same type a number of
- * times equal to the size of a given parameter pack.
- * @tparam Type A type to repeat.
- */
- template<typename Type, typename>
- using unpack_as_t = Type;
- /**
- * @brief Helper variable template to be used to _repeat_ the same value a
- * number of times equal to the size of a given parameter pack.
- * @tparam Value A value to repeat.
- */
- template<auto Value, typename>
- inline constexpr auto unpack_as_v = Value;
- /**
- * @brief Wraps a static constant.
- * @tparam Value A static constant.
- */
- template<auto Value>
- using integral_constant = std::integral_constant<decltype(Value), Value>;
- /**
- * @brief Alias template to ease the creation of named values.
- * @tparam Value A constant value at least convertible to `id_type`.
- */
- template<id_type Value>
- using tag = integral_constant<Value>;
- /**
- * @brief Utility class to disambiguate overloaded functions.
- * @tparam N Number of choices available.
- */
- template<std::size_t N>
- struct choice_t
- // Unfortunately, doxygen cannot parse such a construct.
- /*! @cond TURN_OFF_DOXYGEN */
- : choice_t<N-1>
- /*! @endcond */
- {};
- /*! @copybrief choice_t */
- template<>
- struct choice_t<0> {};
- /**
- * @brief Variable template for the choice trick.
- * @tparam N Number of choices available.
- */
- template<std::size_t N>
- inline constexpr choice_t<N> choice{};
- /*! @brief A class to use to push around lists of types, nothing more. */
- template<typename...>
- struct type_list {};
- /*! @brief Primary template isn't defined on purpose. */
- template<typename>
- struct type_list_size;
- /**
- * @brief Compile-time number of elements in a type list.
- * @tparam Type Types provided by the type list.
- */
- template<typename... Type>
- struct type_list_size<type_list<Type...>>
- : std::integral_constant<std::size_t, sizeof...(Type)>
- {};
- /**
- * @brief Helper variable template.
- * @tparam List Type list.
- */
- template<class List>
- inline constexpr auto type_list_size_v = type_list_size<List>::value;
- /*! @brief Primary template isn't defined on purpose. */
- template<typename...>
- struct type_list_cat;
- /*! @brief Concatenates multiple type lists. */
- template<>
- struct type_list_cat<> {
- /*! @brief A type list composed by the types of all the type lists. */
- using type = type_list<>;
- };
- /**
- * @brief Concatenates multiple type lists.
- * @tparam Type Types provided by the first type list.
- * @tparam Other Types provided by the second type list.
- * @tparam List Other type lists, if any.
- */
- template<typename... Type, typename... Other, typename... List>
- struct type_list_cat<type_list<Type...>, type_list<Other...>, List...> {
- /*! @brief A type list composed by the types of all the type lists. */
- using type = typename type_list_cat<type_list<Type..., Other...>, List...>::type;
- };
- /**
- * @brief Concatenates multiple type lists.
- * @tparam Type Types provided by the type list.
- */
- template<typename... Type>
- struct type_list_cat<type_list<Type...>> {
- /*! @brief A type list composed by the types of all the type lists. */
- using type = type_list<Type...>;
- };
- /**
- * @brief Helper type.
- * @tparam List Type lists to concatenate.
- */
- template<typename... List>
- using type_list_cat_t = typename type_list_cat<List...>::type;
- /*! @brief Primary template isn't defined on purpose. */
- template<typename>
- struct type_list_unique;
- /**
- * @brief Removes duplicates types from a type list.
- * @tparam Type One of the types provided by the given type list.
- * @tparam Other The other types provided by the given type list.
- */
- template<typename Type, typename... Other>
- struct type_list_unique<type_list<Type, Other...>> {
- /*! @brief A type list without duplicate types. */
- using type = std::conditional_t<
- std::disjunction_v<std::is_same<Type, Other>...>,
- typename type_list_unique<type_list<Other...>>::type,
- type_list_cat_t<type_list<Type>, typename type_list_unique<type_list<Other...>>::type>
- >;
- };
- /*! @brief Removes duplicates types from a type list. */
- template<>
- struct type_list_unique<type_list<>> {
- /*! @brief A type list without duplicate types. */
- using type = type_list<>;
- };
- /**
- * @brief Helper type.
- * @tparam Type A type list.
- */
- template<typename Type>
- using type_list_unique_t = typename type_list_unique<Type>::type;
- /**
- * @brief Provides the member constant `value` to true if a given type is
- * equality comparable, false otherwise.
- * @tparam Type Potentially equality comparable type.
- */
- template<typename Type, typename = std::void_t<>>
- struct is_equality_comparable: std::false_type {};
- /*! @copydoc is_equality_comparable */
- template<typename Type>
- struct is_equality_comparable<Type, std::void_t<decltype(std::declval<Type>() == std::declval<Type>())>>
- : std::true_type
- {};
- /**
- * @brief Helper variable template.
- * @tparam Type Potentially equality comparable type.
- */
- template<class Type>
- inline constexpr auto is_equality_comparable_v = is_equality_comparable<Type>::value;
- /**
- * @brief Provides the member constant `value` to true if a given type is empty
- * and the empty type optimization is enabled, false otherwise.
- * @tparam Type Potential empty type.
- */
- template<typename Type, typename = void>
- struct is_eto_eligible
- : ENTT_IS_EMPTY(Type)
- {};
- /**
- * @brief Helper variable template.
- * @tparam Type Potential empty type.
- */
- template<typename Type>
- inline constexpr auto is_eto_eligible_v = is_eto_eligible<Type>::value;
- /**
- * @brief Extracts the class of a non-static member object or function.
- * @tparam Member A pointer to a non-static member object or function.
- */
- template<typename Member>
- class member_class {
- static_assert(std::is_member_pointer_v<Member>, "Invalid pointer type to non-static member object or function");
- template<typename Class, typename Ret, typename... Args>
- static Class * clazz(Ret(Class:: *)(Args...));
- template<typename Class, typename Ret, typename... Args>
- static Class * clazz(Ret(Class:: *)(Args...) const);
- template<typename Class, typename Type>
- static Class * clazz(Type Class:: *);
- public:
- /*! @brief The class of the given non-static member object or function. */
- using type = std::remove_pointer_t<decltype(clazz(std::declval<Member>()))>;
- };
- /**
- * @brief Helper type.
- * @tparam Member A pointer to a non-static member object or function.
- */
- template<typename Member>
- using member_class_t = typename member_class<Member>::type;
- }
- #endif
- // #include "../signal/sigh.hpp"
- #ifndef ENTT_SIGNAL_SIGH_HPP
- #define ENTT_SIGNAL_SIGH_HPP
- #include <vector>
- #include <utility>
- #include <iterator>
- #include <algorithm>
- #include <functional>
- #include <type_traits>
- // #include "../config/config.h"
- #ifndef ENTT_CONFIG_CONFIG_H
- #define ENTT_CONFIG_CONFIG_H
- #ifndef ENTT_NOEXCEPT
- # define ENTT_NOEXCEPT noexcept
- #endif
- #ifndef ENTT_HS_SUFFIX
- # define ENTT_HS_SUFFIX _hs
- #endif
- #ifndef ENTT_HWS_SUFFIX
- # define ENTT_HWS_SUFFIX _hws
- #endif
- #ifndef ENTT_USE_ATOMIC
- # define ENTT_MAYBE_ATOMIC(Type) Type
- #else
- # include <atomic>
- # define ENTT_MAYBE_ATOMIC(Type) std::atomic<Type>
- #endif
- #ifndef ENTT_ID_TYPE
- # include <cstdint>
- # define ENTT_ID_TYPE std::uint32_t
- #endif
- #ifndef ENTT_PAGE_SIZE
- # define ENTT_PAGE_SIZE 32768
- #endif
- #ifndef ENTT_ASSERT
- # include <cassert>
- # define ENTT_ASSERT(condition) assert(condition)
- #endif
- #ifndef ENTT_NO_ETO
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::is_empty<Type>
- #else
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::false_type
- #endif
- #ifndef ENTT_STANDARD_CPP
- # if defined __clang__ || (defined __GNUC__ && __GNUC__ > 8)
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined __GNUC__
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined _MSC_VER
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __FUNCSIG__
- # define ENTT_PRETTY_FUNCTION_PREFIX '<'
- # define ENTT_PRETTY_FUNCTION_SUFFIX '>'
- # endif
- #endif
- #ifndef ENTT_STANDALONE
- # define ENTT_FAST_PATH(...) false
- #else
- # define ENTT_FAST_PATH(Cond) Cond
- #endif
- #endif
- // #include "delegate.hpp"
- #ifndef ENTT_SIGNAL_DELEGATE_HPP
- #define ENTT_SIGNAL_DELEGATE_HPP
- #include <tuple>
- #include <cstddef>
- #include <utility>
- #include <functional>
- #include <type_traits>
- // #include "../config/config.h"
- namespace entt {
- /**
- * @cond TURN_OFF_DOXYGEN
- * Internal details not to be documented.
- */
- namespace internal {
- template<typename Ret, typename... Args>
- auto function_pointer(Ret(*)(Args...)) -> Ret(*)(Args...);
- template<typename Ret, typename Type, typename... Args, typename Other>
- auto function_pointer(Ret(*)(Type, Args...), Other &&) -> Ret(*)(Args...);
- template<typename Class, typename Ret, typename... Args, typename... Other>
- auto function_pointer(Ret(Class:: *)(Args...), Other &&...) -> Ret(*)(Args...);
- template<typename Class, typename Ret, typename... Args, typename... Other>
- auto function_pointer(Ret(Class:: *)(Args...) const, Other &&...) -> Ret(*)(Args...);
- template<typename Class, typename Type, typename... Other>
- auto function_pointer(Type Class:: *, Other &&...) -> Type(*)();
- template<typename... Type>
- using function_pointer_t = decltype(internal::function_pointer(std::declval<Type>()...));
- template<typename... Class, typename Ret, typename... Args>
- [[nodiscard]] constexpr auto index_sequence_for(Ret(*)(Args...)) {
- return std::index_sequence_for<Class..., Args...>{};
- }
- }
- /**
- * Internal details not to be documented.
- * @endcond
- */
- /*! @brief Used to wrap a function or a member of a specified type. */
- template<auto>
- struct connect_arg_t {};
- /*! @brief Constant of type connect_arg_t used to disambiguate calls. */
- template<auto Func>
- inline constexpr connect_arg_t<Func> connect_arg{};
- /**
- * @brief Basic delegate implementation.
- *
- * Primary template isn't defined on purpose. All the specializations give a
- * compile-time error unless the template parameter is a function type.
- */
- template<typename>
- class delegate;
- /**
- * @brief Utility class to use to send around functions and members.
- *
- * Unmanaged delegate for function pointers and members. Users of this class are
- * in charge of disconnecting instances before deleting them.
- *
- * A delegate can be used as a general purpose invoker without memory overhead
- * for free functions possibly with payloads and bound or unbound members.
- *
- * @tparam Ret Return type of a function type.
- * @tparam Args Types of arguments of a function type.
- */
- template<typename Ret, typename... Args>
- class delegate<Ret(Args...)> {
- template<auto Candidate, std::size_t... Index>
- [[nodiscard]] auto wrap(std::index_sequence<Index...>) ENTT_NOEXCEPT {
- return [](const void *, Args... args) -> Ret {
- [[maybe_unused]] const auto arguments = std::forward_as_tuple(std::forward<Args>(args)...);
- return Ret(std::invoke(Candidate, std::forward<std::tuple_element_t<Index, std::tuple<Args...>>>(std::get<Index>(arguments))...));
- };
- }
- template<auto Candidate, typename Type, std::size_t... Index>
- [[nodiscard]] auto wrap(Type &, std::index_sequence<Index...>) ENTT_NOEXCEPT {
- return [](const void *payload, Args... args) -> Ret {
- [[maybe_unused]] const auto arguments = std::forward_as_tuple(std::forward<Args>(args)...);
- Type *curr = static_cast<Type *>(const_cast<std::conditional_t<std::is_const_v<Type>, const void *, void *>>(payload));
- return Ret(std::invoke(Candidate, *curr, std::forward<std::tuple_element_t<Index, std::tuple<Args...>>>(std::get<Index>(arguments))...));
- };
- }
- template<auto Candidate, typename Type, std::size_t... Index>
- [[nodiscard]] auto wrap(Type *, std::index_sequence<Index...>) ENTT_NOEXCEPT {
- return [](const void *payload, Args... args) -> Ret {
- [[maybe_unused]] const auto arguments = std::forward_as_tuple(std::forward<Args>(args)...);
- Type *curr = static_cast<Type *>(const_cast<std::conditional_t<std::is_const_v<Type>, const void *, void *>>(payload));
- return Ret(std::invoke(Candidate, curr, std::forward<std::tuple_element_t<Index, std::tuple<Args...>>>(std::get<Index>(arguments))...));
- };
- }
- public:
- /*! @brief Function type of the contained target. */
- using function_type = Ret(const void *, Args...);
- /*! @brief Function type of the delegate. */
- using type = Ret(Args...);
- /*! @brief Return type of the delegate. */
- using result_type = Ret;
- /*! @brief Default constructor. */
- delegate() ENTT_NOEXCEPT
- : fn{nullptr}, data{nullptr}
- {}
- /**
- * @brief Constructs a delegate and connects a free function or an unbound
- * member.
- * @tparam Candidate Function or member to connect to the delegate.
- */
- template<auto Candidate>
- delegate(connect_arg_t<Candidate>) ENTT_NOEXCEPT {
- connect<Candidate>();
- }
- /**
- * @brief Constructs a delegate and connects a free function with payload or
- * a bound member.
- * @tparam Candidate Function or member to connect to the delegate.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid object that fits the purpose.
- */
- template<auto Candidate, typename Type>
- delegate(connect_arg_t<Candidate>, Type &&value_or_instance) ENTT_NOEXCEPT {
- connect<Candidate>(std::forward<Type>(value_or_instance));
- }
- /**
- * @brief Constructs a delegate and connects an user defined function with
- * optional payload.
- * @param function Function to connect to the delegate.
- * @param payload User defined arbitrary data.
- */
- delegate(function_type *function, const void *payload = nullptr) ENTT_NOEXCEPT {
- connect(function, payload);
- }
- /**
- * @brief Connects a free function or an unbound member to a delegate.
- * @tparam Candidate Function or member to connect to the delegate.
- */
- template<auto Candidate>
- void connect() ENTT_NOEXCEPT {
- data = nullptr;
- if constexpr(std::is_invocable_r_v<Ret, decltype(Candidate), Args...>) {
- fn = [](const void *, Args... args) -> Ret {
- return Ret(std::invoke(Candidate, std::forward<Args>(args)...));
- };
- } else if constexpr(std::is_member_pointer_v<decltype(Candidate)>) {
- fn = wrap<Candidate>(internal::index_sequence_for<std::tuple_element_t<0, std::tuple<Args...>>>(internal::function_pointer_t<decltype(Candidate)>{}));
- } else {
- fn = wrap<Candidate>(internal::index_sequence_for(internal::function_pointer_t<decltype(Candidate)>{}));
- }
- }
- /**
- * @brief Connects a free function with payload or a bound member to a
- * delegate.
- *
- * The delegate isn't responsible for the connected object or the payload.
- * Users must always guarantee that the lifetime of the instance overcomes
- * the one of the delegate.<br/>
- * When used to connect a free function with payload, its signature must be
- * such that the instance is the first argument before the ones used to
- * define the delegate itself.
- *
- * @tparam Candidate Function or member to connect to the delegate.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid reference that fits the purpose.
- */
- template<auto Candidate, typename Type>
- void connect(Type &value_or_instance) ENTT_NOEXCEPT {
- data = &value_or_instance;
- if constexpr(std::is_invocable_r_v<Ret, decltype(Candidate), Type &, Args...>) {
- fn = [](const void *payload, Args... args) -> Ret {
- Type *curr = static_cast<Type *>(const_cast<std::conditional_t<std::is_const_v<Type>, const void *, void *>>(payload));
- return Ret(std::invoke(Candidate, *curr, std::forward<Args>(args)...));
- };
- } else {
- fn = wrap<Candidate>(value_or_instance, internal::index_sequence_for(internal::function_pointer_t<decltype(Candidate), Type>{}));
- }
- }
- /**
- * @brief Connects a free function with payload or a bound member to a
- * delegate.
- *
- * @sa connect(Type &)
- *
- * @tparam Candidate Function or member to connect to the delegate.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid pointer that fits the purpose.
- */
- template<auto Candidate, typename Type>
- void connect(Type *value_or_instance) ENTT_NOEXCEPT {
- data = value_or_instance;
- if constexpr(std::is_invocable_r_v<Ret, decltype(Candidate), Type *, Args...>) {
- fn = [](const void *payload, Args... args) -> Ret {
- Type *curr = static_cast<Type *>(const_cast<std::conditional_t<std::is_const_v<Type>, const void *, void *>>(payload));
- return Ret(std::invoke(Candidate, curr, std::forward<Args>(args)...));
- };
- } else {
- fn = wrap<Candidate>(value_or_instance, internal::index_sequence_for(internal::function_pointer_t<decltype(Candidate), Type>{}));
- }
- }
- /**
- * @brief Connects an user defined function with optional payload to a
- * delegate.
- *
- * The delegate isn't responsible for the connected object or the payload.
- * Users must always guarantee that the lifetime of an instance overcomes
- * the one of the delegate.<br/>
- * The payload is returned as the first argument to the target function in
- * all cases.
- *
- * @param function Function to connect to the delegate.
- * @param payload User defined arbitrary data.
- */
- void connect(function_type *function, const void *payload = nullptr) ENTT_NOEXCEPT {
- fn = function;
- data = payload;
- }
- /**
- * @brief Resets a delegate.
- *
- * After a reset, a delegate cannot be invoked anymore.
- */
- void reset() ENTT_NOEXCEPT {
- fn = nullptr;
- data = nullptr;
- }
- /**
- * @brief Returns the instance or the payload linked to a delegate, if any.
- * @return An opaque pointer to the underlying data.
- */
- [[nodiscard]] const void * instance() const ENTT_NOEXCEPT {
- return data;
- }
- /**
- * @brief Triggers a delegate.
- *
- * The delegate invokes the underlying function and returns the result.
- *
- * @warning
- * Attempting to trigger an invalid delegate results in undefined
- * behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * delegate has not yet been set.
- *
- * @param args Arguments to use to invoke the underlying function.
- * @return The value returned by the underlying function.
- */
- Ret operator()(Args... args) const {
- ENTT_ASSERT(fn);
- return fn(data, std::forward<Args>(args)...);
- }
- /**
- * @brief Checks whether a delegate actually stores a listener.
- * @return False if the delegate is empty, true otherwise.
- */
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- // no need to test also data
- return !(fn == nullptr);
- }
- /**
- * @brief Compares the contents of two delegates.
- * @param other Delegate with which to compare.
- * @return False if the two contents differ, true otherwise.
- */
- [[nodiscard]] bool operator==(const delegate<Ret(Args...)> &other) const ENTT_NOEXCEPT {
- return fn == other.fn && data == other.data;
- }
- private:
- function_type *fn;
- const void *data;
- };
- /**
- * @brief Compares the contents of two delegates.
- * @tparam Ret Return type of a function type.
- * @tparam Args Types of arguments of a function type.
- * @param lhs A valid delegate object.
- * @param rhs A valid delegate object.
- * @return True if the two contents differ, false otherwise.
- */
- template<typename Ret, typename... Args>
- [[nodiscard]] bool operator!=(const delegate<Ret(Args...)> &lhs, const delegate<Ret(Args...)> &rhs) ENTT_NOEXCEPT {
- return !(lhs == rhs);
- }
- /**
- * @brief Deduction guide.
- * @tparam Candidate Function or member to connect to the delegate.
- */
- template<auto Candidate>
- delegate(connect_arg_t<Candidate>) ENTT_NOEXCEPT
- -> delegate<std::remove_pointer_t<internal::function_pointer_t<decltype(Candidate)>>>;
- /**
- * @brief Deduction guide.
- * @tparam Candidate Function or member to connect to the delegate.
- * @tparam Type Type of class or type of payload.
- */
- template<auto Candidate, typename Type>
- delegate(connect_arg_t<Candidate>, Type &&) ENTT_NOEXCEPT
- -> delegate<std::remove_pointer_t<internal::function_pointer_t<decltype(Candidate), Type>>>;
- /*! @brief Deduction guide. */
- template<typename Ret, typename... Args>
- delegate(Ret(*)(const void *, Args...), const void * = nullptr) ENTT_NOEXCEPT
- -> delegate<Ret(Args...)>;
- }
- #endif
- // #include "fwd.hpp"
- #ifndef ENTT_SIGNAL_FWD_HPP
- #define ENTT_SIGNAL_FWD_HPP
- namespace entt {
- template<typename>
- class delegate;
- class dispatcher;
- template<typename>
- class emitter;
- class connection;
- struct scoped_connection;
- template<typename>
- class sink;
- template<typename>
- class sigh;
- }
- #endif
- namespace entt {
- /**
- * @brief Sink class.
- *
- * Primary template isn't defined on purpose. All the specializations give a
- * compile-time error unless the template parameter is a function type.
- *
- * @tparam Function A valid function type.
- */
- template<typename Function>
- class sink;
- /**
- * @brief Unmanaged signal handler.
- *
- * Primary template isn't defined on purpose. All the specializations give a
- * compile-time error unless the template parameter is a function type.
- *
- * @tparam Function A valid function type.
- */
- template<typename Function>
- class sigh;
- /**
- * @brief Unmanaged signal handler.
- *
- * It works directly with references to classes and pointers to member functions
- * as well as pointers to free functions. Users of this class are in charge of
- * disconnecting instances before deleting them.
- *
- * This class serves mainly two purposes:
- *
- * * Creating signals to use later to notify a bunch of listeners.
- * * Collecting results from a set of functions like in a voting system.
- *
- * @tparam Ret Return type of a function type.
- * @tparam Args Types of arguments of a function type.
- */
- template<typename Ret, typename... Args>
- class sigh<Ret(Args...)> {
- /*! @brief A sink is allowed to modify a signal. */
- friend class sink<Ret(Args...)>;
- public:
- /*! @brief Unsigned integer type. */
- using size_type = std::size_t;
- /*! @brief Sink type. */
- using sink_type = sink<Ret(Args...)>;
- /**
- * @brief Instance type when it comes to connecting member functions.
- * @tparam Class Type of class to which the member function belongs.
- */
- template<typename Class>
- using instance_type = Class *;
- /**
- * @brief Number of listeners connected to the signal.
- * @return Number of listeners currently connected.
- */
- [[nodiscard]] size_type size() const ENTT_NOEXCEPT {
- return calls.size();
- }
- /**
- * @brief Returns false if at least a listener is connected to the signal.
- * @return True if the signal has no listeners connected, false otherwise.
- */
- [[nodiscard]] bool empty() const ENTT_NOEXCEPT {
- return calls.empty();
- }
- /**
- * @brief Triggers a signal.
- *
- * All the listeners are notified. Order isn't guaranteed.
- *
- * @param args Arguments to use to invoke listeners.
- */
- void publish(Args... args) const {
- for(auto &&call: std::as_const(calls)) {
- call(args...);
- }
- }
- /**
- * @brief Collects return values from the listeners.
- *
- * The collector must expose a call operator with the following properties:
- *
- * * The return type is either `void` or such that it's convertible to
- * `bool`. In the second case, a true value will stop the iteration.
- * * The list of parameters is empty if `Ret` is `void`, otherwise it
- * contains a single element such that `Ret` is convertible to it.
- *
- * @tparam Func Type of collector to use, if any.
- * @param func A valid function object.
- * @param args Arguments to use to invoke listeners.
- */
- template<typename Func>
- void collect(Func func, Args... args) const {
- for(auto &&call: calls) {
- if constexpr(std::is_void_v<Ret>) {
- if constexpr(std::is_invocable_r_v<bool, Func>) {
- call(args...);
- if(func()) { break; }
- } else {
- call(args...);
- func();
- }
- } else {
- if constexpr(std::is_invocable_r_v<bool, Func, Ret>) {
- if(func(call(args...))) { break; }
- } else {
- func(call(args...));
- }
- }
- }
- }
- private:
- std::vector<delegate<Ret(Args...)>> calls;
- };
- /**
- * @brief Connection class.
- *
- * Opaque object the aim of which is to allow users to release an already
- * estabilished connection without having to keep a reference to the signal or
- * the sink that generated it.
- */
- class connection {
- /*! @brief A sink is allowed to create connection objects. */
- template<typename>
- friend class sink;
- connection(delegate<void(void *)> fn, void *ref)
- : disconnect{fn}, signal{ref}
- {}
- public:
- /*! @brief Default constructor. */
- connection() = default;
- /**
- * @brief Checks whether a connection is properly initialized.
- * @return True if the connection is properly initialized, false otherwise.
- */
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- return static_cast<bool>(disconnect);
- }
- /*! @brief Breaks the connection. */
- void release() {
- if(disconnect) {
- disconnect(signal);
- disconnect.reset();
- }
- }
- private:
- delegate<void(void *)> disconnect;
- void *signal{};
- };
- /**
- * @brief Scoped connection class.
- *
- * Opaque object the aim of which is to allow users to release an already
- * estabilished connection without having to keep a reference to the signal or
- * the sink that generated it.<br/>
- * A scoped connection automatically breaks the link between the two objects
- * when it goes out of scope.
- */
- struct scoped_connection {
- /*! @brief Default constructor. */
- scoped_connection() = default;
- /**
- * @brief Constructs a scoped connection from a basic connection.
- * @param other A valid connection object.
- */
- scoped_connection(const connection &other)
- : conn{other}
- {}
- /*! @brief Default copy constructor, deleted on purpose. */
- scoped_connection(const scoped_connection &) = delete;
- /*! @brief Automatically breaks the link on destruction. */
- ~scoped_connection() {
- conn.release();
- }
- /**
- * @brief Default copy assignment operator, deleted on purpose.
- * @return This scoped connection.
- */
- scoped_connection & operator=(const scoped_connection &) = delete;
- /**
- * @brief Acquires a connection.
- * @param other The connection object to acquire.
- * @return This scoped connection.
- */
- scoped_connection & operator=(connection other) {
- conn = std::move(other);
- return *this;
- }
- /**
- * @brief Checks whether a scoped connection is properly initialized.
- * @return True if the connection is properly initialized, false otherwise.
- */
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- return static_cast<bool>(conn);
- }
- /*! @brief Breaks the connection. */
- void release() {
- conn.release();
- }
- private:
- connection conn;
- };
- /**
- * @brief Sink class.
- *
- * A sink is used to connect listeners to signals and to disconnect them.<br/>
- * The function type for a listener is the one of the signal to which it
- * belongs.
- *
- * The clear separation between a signal and a sink permits to store the former
- * as private data member without exposing the publish functionality to the
- * users of the class.
- *
- * @warning
- * Lifetime of a sink must not overcome that of the signal to which it refers.
- * In any other case, attempting to use a sink results in undefined behavior.
- *
- * @tparam Ret Return type of a function type.
- * @tparam Args Types of arguments of a function type.
- */
- template<typename Ret, typename... Args>
- class sink<Ret(Args...)> {
- using signal_type = sigh<Ret(Args...)>;
- using difference_type = typename std::iterator_traits<typename decltype(signal_type::calls)::iterator>::difference_type;
- template<auto Candidate, typename Type>
- static void release(Type value_or_instance, void *signal) {
- sink{*static_cast<signal_type *>(signal)}.disconnect<Candidate>(value_or_instance);
- }
- template<auto Candidate>
- static void release(void *signal) {
- sink{*static_cast<signal_type *>(signal)}.disconnect<Candidate>();
- }
- public:
- /**
- * @brief Constructs a sink that is allowed to modify a given signal.
- * @param ref A valid reference to a signal object.
- */
- sink(sigh<Ret(Args...)> &ref) ENTT_NOEXCEPT
- : offset{},
- signal{&ref}
- {}
- /**
- * @brief Returns false if at least a listener is connected to the sink.
- * @return True if the sink has no listeners connected, false otherwise.
- */
- [[nodiscard]] bool empty() const ENTT_NOEXCEPT {
- return signal->calls.empty();
- }
- /**
- * @brief Returns a sink that connects before a given free function or an
- * unbound member.
- * @tparam Function A valid free function pointer.
- * @return A properly initialized sink object.
- */
- template<auto Function>
- [[nodiscard]] sink before() {
- delegate<Ret(Args...)> call{};
- call.template connect<Function>();
- const auto &calls = signal->calls;
- const auto it = std::find(calls.cbegin(), calls.cend(), std::move(call));
- sink other{*this};
- other.offset = std::distance(it, calls.cend());
- return other;
- }
- /**
- * @brief Returns a sink that connects before a free function with payload
- * or a bound member.
- * @tparam Candidate Member or free function to look for.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid object that fits the purpose.
- * @return A properly initialized sink object.
- */
- template<auto Candidate, typename Type>
- [[nodiscard]] sink before(Type &&value_or_instance) {
- delegate<Ret(Args...)> call{};
- call.template connect<Candidate>(value_or_instance);
- const auto &calls = signal->calls;
- const auto it = std::find(calls.cbegin(), calls.cend(), std::move(call));
- sink other{*this};
- other.offset = std::distance(it, calls.cend());
- return other;
- }
- /**
- * @brief Returns a sink that connects before a given instance or specific
- * payload.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid object that fits the purpose.
- * @return A properly initialized sink object.
- */
- template<typename Type>
- [[nodiscard]] sink before(Type &value_or_instance) {
- return before(&value_or_instance);
- }
- /**
- * @brief Returns a sink that connects before a given instance or specific
- * payload.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid pointer that fits the purpose.
- * @return A properly initialized sink object.
- */
- template<typename Type>
- [[nodiscard]] sink before(Type *value_or_instance) {
- sink other{*this};
- if(value_or_instance) {
- const auto &calls = signal->calls;
- const auto it = std::find_if(calls.cbegin(), calls.cend(), [value_or_instance](const auto &delegate) {
- return delegate.instance() == value_or_instance;
- });
- other.offset = std::distance(it, calls.cend());
- }
- return other;
- }
- /**
- * @brief Returns a sink that connects before anything else.
- * @return A properly initialized sink object.
- */
- [[nodiscard]] sink before() {
- sink other{*this};
- other.offset = signal->calls.size();
- return other;
- }
- /**
- * @brief Connects a free function or an unbound member to a signal.
- *
- * The signal handler performs checks to avoid multiple connections for the
- * same function.
- *
- * @tparam Candidate Function or member to connect to the signal.
- * @return A properly initialized connection object.
- */
- template<auto Candidate>
- connection connect() {
- disconnect<Candidate>();
- delegate<Ret(Args...)> call{};
- call.template connect<Candidate>();
- signal->calls.insert(signal->calls.end() - offset, std::move(call));
- delegate<void(void *)> conn{};
- conn.template connect<&release<Candidate>>();
- return { std::move(conn), signal };
- }
- /**
- * @brief Connects a free function with payload or a bound member to a
- * signal.
- *
- * The signal isn't responsible for the connected object or the payload.
- * Users must always guarantee that the lifetime of the instance overcomes
- * the one of the signal. On the other side, the signal handler performs
- * checks to avoid multiple connections for the same function.<br/>
- * When used to connect a free function with payload, its signature must be
- * such that the instance is the first argument before the ones used to
- * define the signal itself.
- *
- * @tparam Candidate Function or member to connect to the signal.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid object that fits the purpose.
- * @return A properly initialized connection object.
- */
- template<auto Candidate, typename Type>
- connection connect(Type &&value_or_instance) {
- disconnect<Candidate>(value_or_instance);
- delegate<Ret(Args...)> call{};
- call.template connect<Candidate>(value_or_instance);
- signal->calls.insert(signal->calls.end() - offset, std::move(call));
- delegate<void(void *)> conn{};
- conn.template connect<&release<Candidate, Type>>(value_or_instance);
- return { std::move(conn), signal };
- }
- /**
- * @brief Disconnects a free function or an unbound member from a signal.
- * @tparam Candidate Function or member to disconnect from the signal.
- */
- template<auto Candidate>
- void disconnect() {
- auto &calls = signal->calls;
- delegate<Ret(Args...)> call{};
- call.template connect<Candidate>();
- calls.erase(std::remove(calls.begin(), calls.end(), std::move(call)), calls.end());
- }
- /**
- * @brief Disconnects a free function with payload or a bound member from a
- * signal.
- * @tparam Candidate Function or member to disconnect from the signal.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid object that fits the purpose.
- */
- template<auto Candidate, typename Type>
- void disconnect(Type &&value_or_instance) {
- auto &calls = signal->calls;
- delegate<Ret(Args...)> call{};
- call.template connect<Candidate>(value_or_instance);
- calls.erase(std::remove(calls.begin(), calls.end(), std::move(call)), calls.end());
- }
- /**
- * @brief Disconnects free functions with payload or bound members from a
- * signal.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid object that fits the purpose.
- */
- template<typename Type>
- void disconnect(Type &value_or_instance) {
- disconnect(&value_or_instance);
- }
- /**
- * @brief Disconnects free functions with payload or bound members from a
- * signal.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid object that fits the purpose.
- */
- template<typename Type>
- void disconnect(Type *value_or_instance) {
- if(value_or_instance) {
- auto &calls = signal->calls;
- calls.erase(std::remove_if(calls.begin(), calls.end(), [value_or_instance](const auto &delegate) {
- return delegate.instance() == value_or_instance;
- }), calls.end());
- }
- }
- /*! @brief Disconnects all the listeners from a signal. */
- void disconnect() {
- signal->calls.clear();
- }
- private:
- difference_type offset;
- signal_type *signal;
- };
- /**
- * @brief Deduction guide.
- *
- * It allows to deduce the function type of a sink directly from the signal it
- * refers to.
- *
- * @tparam Ret Return type of a function type.
- * @tparam Args Types of arguments of a function type.
- */
- template<typename Ret, typename... Args>
- sink(sigh<Ret(Args...)> &) ENTT_NOEXCEPT -> sink<Ret(Args...)>;
- }
- #endif
- // #include "entity.hpp"
- #ifndef ENTT_ENTITY_ENTITY_HPP
- #define ENTT_ENTITY_ENTITY_HPP
- #include <cstddef>
- #include <cstdint>
- #include <type_traits>
- // #include "../config/config.h"
- namespace entt {
- /**
- * @brief Entity traits.
- *
- * Primary template isn't defined on purpose. All the specializations give a
- * compile-time error unless the template parameter is an accepted entity type.
- */
- template<typename, typename = void>
- struct entt_traits;
- /**
- * @brief Entity traits for enumeration types.
- * @tparam Type The type to check.
- */
- template<typename Type>
- struct entt_traits<Type, std::enable_if_t<std::is_enum_v<Type>>>
- : entt_traits<std::underlying_type_t<Type>>
- {};
- /**
- * @brief Entity traits for a 16 bits entity identifier.
- *
- * A 16 bits entity identifier guarantees:
- *
- * * 12 bits for the entity number (up to 4k entities).
- * * 4 bit for the version (resets in [0-15]).
- */
- template<>
- struct entt_traits<std::uint16_t> {
- /*! @brief Underlying entity type. */
- using entity_type = std::uint16_t;
- /*! @brief Underlying version type. */
- using version_type = std::uint8_t;
- /*! @brief Difference type. */
- using difference_type = std::int16_t;
- /*! @brief Mask to use to get the entity number out of an identifier. */
- static constexpr entity_type entity_mask = 0xFFF;
- /*! @brief Mask to use to get the version out of an identifier. */
- static constexpr entity_type version_mask = 0xF;
- /*! @brief Extent of the entity number within an identifier. */
- static constexpr std::size_t entity_shift = 12u;
- };
- /**
- * @brief Entity traits for a 32 bits entity identifier.
- *
- * A 32 bits entity identifier guarantees:
- *
- * * 20 bits for the entity number (suitable for almost all the games).
- * * 12 bit for the version (resets in [0-4095]).
- */
- template<>
- struct entt_traits<std::uint32_t> {
- /*! @brief Underlying entity type. */
- using entity_type = std::uint32_t;
- /*! @brief Underlying version type. */
- using version_type = std::uint16_t;
- /*! @brief Difference type. */
- using difference_type = std::int32_t;
- /*! @brief Mask to use to get the entity number out of an identifier. */
- static constexpr entity_type entity_mask = 0xFFFFF;
- /*! @brief Mask to use to get the version out of an identifier. */
- static constexpr entity_type version_mask = 0xFFF;
- /*! @brief Extent of the entity number within an identifier. */
- static constexpr std::size_t entity_shift = 20u;
- };
- /**
- * @brief Entity traits for a 64 bits entity identifier.
- *
- * A 64 bits entity identifier guarantees:
- *
- * * 32 bits for the entity number (an indecently large number).
- * * 32 bit for the version (an indecently large number).
- */
- template<>
- struct entt_traits<std::uint64_t> {
- /*! @brief Underlying entity type. */
- using entity_type = std::uint64_t;
- /*! @brief Underlying version type. */
- using version_type = std::uint32_t;
- /*! @brief Difference type. */
- using difference_type = std::int64_t;
- /*! @brief Mask to use to get the entity number out of an identifier. */
- static constexpr entity_type entity_mask = 0xFFFFFFFF;
- /*! @brief Mask to use to get the version out of an identifier. */
- static constexpr entity_type version_mask = 0xFFFFFFFF;
- /*! @brief Extent of the entity number within an identifier. */
- static constexpr std::size_t entity_shift = 32u;
- };
- /**
- * @brief Converts an entity type to its underlying type.
- * @tparam Entity The value type.
- * @param entity The value to convert.
- * @return The integral representation of the given value.
- */
- template<typename Entity>
- [[nodiscard]] constexpr auto to_integral(const Entity entity) ENTT_NOEXCEPT {
- return static_cast<typename entt_traits<Entity>::entity_type>(entity);
- }
- /*! @brief Null object for all entity identifiers. */
- struct null_t {
- /**
- * @brief Converts the null object to identifiers of any type.
- * @tparam Entity Type of entity identifier.
- * @return The null representation for the given identifier.
- */
- template<typename Entity>
- [[nodiscard]] constexpr operator Entity() const ENTT_NOEXCEPT {
- return Entity{entt_traits<Entity>::entity_mask};
- }
- /**
- * @brief Compares two null objects.
- * @return True in all cases.
- */
- [[nodiscard]] constexpr bool operator==(null_t) const ENTT_NOEXCEPT {
- return true;
- }
- /**
- * @brief Compares two null objects.
- * @return False in all cases.
- */
- [[nodiscard]] constexpr bool operator!=(null_t) const ENTT_NOEXCEPT {
- return false;
- }
- /**
- * @brief Compares a null object and an entity identifier of any type.
- * @tparam Entity Type of entity identifier.
- * @param entity Entity identifier with which to compare.
- * @return False if the two elements differ, true otherwise.
- */
- template<typename Entity>
- [[nodiscard]] constexpr bool operator==(const Entity entity) const ENTT_NOEXCEPT {
- return (to_integral(entity) & entt_traits<Entity>::entity_mask) == to_integral(static_cast<Entity>(*this));
- }
- /**
- * @brief Compares a null object and an entity identifier of any type.
- * @tparam Entity Type of entity identifier.
- * @param entity Entity identifier with which to compare.
- * @return True if the two elements differ, false otherwise.
- */
- template<typename Entity>
- [[nodiscard]] constexpr bool operator!=(const Entity entity) const ENTT_NOEXCEPT {
- return !(entity == *this);
- }
- };
- /**
- * @brief Compares a null object and an entity identifier of any type.
- * @tparam Entity Type of entity identifier.
- * @param entity Entity identifier with which to compare.
- * @param other A null object yet to be converted.
- * @return False if the two elements differ, true otherwise.
- */
- template<typename Entity>
- [[nodiscard]] constexpr bool operator==(const Entity entity, null_t other) ENTT_NOEXCEPT {
- return other.operator==(entity);
- }
- /**
- * @brief Compares a null object and an entity identifier of any type.
- * @tparam Entity Type of entity identifier.
- * @param entity Entity identifier with which to compare.
- * @param other A null object yet to be converted.
- * @return True if the two elements differ, false otherwise.
- */
- template<typename Entity>
- [[nodiscard]] constexpr bool operator!=(const Entity entity, null_t other) ENTT_NOEXCEPT {
- return !(other == entity);
- }
- /**
- * Internal details not to be documented.
- * @endcond
- */
- /**
- * @brief Compile-time constant for null entities.
- *
- * There exist implicit conversions from this variable to entity identifiers of
- * any allowed type. Similarly, there exist comparision operators between the
- * null entity and any other entity identifier.
- */
- inline constexpr null_t null{};
- }
- #endif
- // #include "fwd.hpp"
- #ifndef ENTT_ENTITY_FWD_HPP
- #define ENTT_ENTITY_FWD_HPP
- // #include "../core/fwd.hpp"
- namespace entt {
- template <typename>
- class basic_registry;
- template<typename...>
- class basic_view;
- template<typename>
- class basic_runtime_view;
- template<typename...>
- class basic_group;
- template<typename>
- class basic_observer;
- template <typename>
- struct basic_actor;
- template<typename>
- struct basic_handle;
- template<typename>
- class basic_snapshot;
- template<typename>
- class basic_snapshot_loader;
- template<typename>
- class basic_continuous_loader;
- /*! @brief Default entity identifier. */
- enum class entity: id_type {};
- /*! @brief Alias declaration for the most common use case. */
- using registry = basic_registry<entity>;
- /*! @brief Alias declaration for the most common use case. */
- using observer = basic_observer<entity>;
- /*! @brief Alias declaration for the most common use case. */
- using actor [[deprecated("Consider using the handle class instead")]] = basic_actor<entity>;
- /*! @brief Alias declaration for the most common use case. */
- using handle = basic_handle<entity>;
- /*! @brief Alias declaration for the most common use case. */
- using const_handle = basic_handle<const entity>;
- /*! @brief Alias declaration for the most common use case. */
- using snapshot = basic_snapshot<entity>;
- /*! @brief Alias declaration for the most common use case. */
- using snapshot_loader = basic_snapshot_loader<entity>;
- /*! @brief Alias declaration for the most common use case. */
- using continuous_loader = basic_continuous_loader<entity>;
- /**
- * @brief Alias declaration for the most common use case.
- * @tparam Types Types of components iterated by the view.
- */
- template<typename... Types>
- using view = basic_view<entity, Types...>;
- /*! @brief Alias declaration for the most common use case. */
- using runtime_view = basic_runtime_view<entity>;
- /**
- * @brief Alias declaration for the most common use case.
- * @tparam Types Types of components iterated by the group.
- */
- template<typename... Types>
- using group = basic_group<entity, Types...>;
- }
- #endif
- // #include "group.hpp"
- #ifndef ENTT_ENTITY_GROUP_HPP
- #define ENTT_ENTITY_GROUP_HPP
- #include <tuple>
- #include <utility>
- #include <type_traits>
- // #include "../config/config.h"
- // #include "../core/type_traits.hpp"
- // #include "entity.hpp"
- // #include "fwd.hpp"
- // #include "pool.hpp"
- #ifndef ENTT_ENTITY_POOL_HPP
- #define ENTT_ENTITY_POOL_HPP
- #include <type_traits>
- // #include "storage.hpp"
- #ifndef ENTT_ENTITY_STORAGE_HPP
- #define ENTT_ENTITY_STORAGE_HPP
- #include <algorithm>
- #include <iterator>
- #include <utility>
- #include <vector>
- #include <cstddef>
- #include <type_traits>
- // #include "../config/config.h"
- // #include "../core/algorithm.hpp"
- // #include "../core/type_traits.hpp"
- // #include "entity.hpp"
- // #include "sparse_set.hpp"
- #ifndef ENTT_ENTITY_SPARSE_SET_HPP
- #define ENTT_ENTITY_SPARSE_SET_HPP
- #include <iterator>
- #include <utility>
- #include <vector>
- #include <memory>
- #include <cstddef>
- #include <type_traits>
- // #include "../config/config.h"
- // #include "../core/algorithm.hpp"
- // #include "entity.hpp"
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @brief Basic sparse set implementation.
- *
- * Sparse set or packed array or whatever is the name users give it.<br/>
- * Two arrays: an _external_ one and an _internal_ one; a _sparse_ one and a
- * _packed_ one; one used for direct access through contiguous memory, the other
- * one used to get the data through an extra level of indirection.<br/>
- * This is largely used by the registry to offer users the fastest access ever
- * to the components. Views and groups in general are almost entirely designed
- * around sparse sets.
- *
- * This type of data structure is widely documented in the literature and on the
- * web. This is nothing more than a customized implementation suitable for the
- * purpose of the framework.
- *
- * @note
- * Internal data structures arrange elements to maximize performance. There are
- * no guarantees that entities are returned in the insertion order when iterate
- * a sparse set. Do not make assumption on the order in any case.
- *
- * @tparam Entity A valid entity type (see entt_traits for more details).
- */
- template<typename Entity>
- class sparse_set {
- static_assert(ENTT_PAGE_SIZE && ((ENTT_PAGE_SIZE & (ENTT_PAGE_SIZE - 1)) == 0), "ENTT_PAGE_SIZE must be a power of two");
- static constexpr auto entt_per_page = ENTT_PAGE_SIZE / sizeof(Entity);
- using traits_type = entt_traits<Entity>;
- using page_type = std::unique_ptr<Entity[]>;
- class sparse_set_iterator final {
- friend class sparse_set<Entity>;
- using packed_type = std::vector<Entity>;
- using index_type = typename traits_type::difference_type;
- sparse_set_iterator(const packed_type &ref, const index_type idx) ENTT_NOEXCEPT
- : packed{&ref}, index{idx}
- {}
- public:
- using difference_type = index_type;
- using value_type = Entity;
- using pointer = const value_type *;
- using reference = const value_type &;
- using iterator_category = std::random_access_iterator_tag;
- sparse_set_iterator() ENTT_NOEXCEPT = default;
- sparse_set_iterator & operator++() ENTT_NOEXCEPT {
- return --index, *this;
- }
- sparse_set_iterator operator++(int) ENTT_NOEXCEPT {
- iterator orig = *this;
- return ++(*this), orig;
- }
- sparse_set_iterator & operator--() ENTT_NOEXCEPT {
- return ++index, *this;
- }
- sparse_set_iterator operator--(int) ENTT_NOEXCEPT {
- sparse_set_iterator orig = *this;
- return operator--(), orig;
- }
- sparse_set_iterator & operator+=(const difference_type value) ENTT_NOEXCEPT {
- index -= value;
- return *this;
- }
- sparse_set_iterator operator+(const difference_type value) const ENTT_NOEXCEPT {
- sparse_set_iterator copy = *this;
- return (copy += value);
- }
- sparse_set_iterator & operator-=(const difference_type value) ENTT_NOEXCEPT {
- return (*this += -value);
- }
- sparse_set_iterator operator-(const difference_type value) const ENTT_NOEXCEPT {
- return (*this + -value);
- }
- difference_type operator-(const sparse_set_iterator &other) const ENTT_NOEXCEPT {
- return other.index - index;
- }
- [[nodiscard]] reference operator[](const difference_type value) const {
- const auto pos = size_type(index-value-1u);
- return (*packed)[pos];
- }
- [[nodiscard]] bool operator==(const sparse_set_iterator &other) const ENTT_NOEXCEPT {
- return other.index == index;
- }
- [[nodiscard]] bool operator!=(const sparse_set_iterator &other) const ENTT_NOEXCEPT {
- return !(*this == other);
- }
- [[nodiscard]] bool operator<(const sparse_set_iterator &other) const ENTT_NOEXCEPT {
- return index > other.index;
- }
- [[nodiscard]] bool operator>(const sparse_set_iterator &other) const ENTT_NOEXCEPT {
- return index < other.index;
- }
- [[nodiscard]] bool operator<=(const sparse_set_iterator &other) const ENTT_NOEXCEPT {
- return !(*this > other);
- }
- [[nodiscard]] bool operator>=(const sparse_set_iterator &other) const ENTT_NOEXCEPT {
- return !(*this < other);
- }
- [[nodiscard]] pointer operator->() const {
- const auto pos = size_type(index-1u);
- return &(*packed)[pos];
- }
- [[nodiscard]] reference operator*() const {
- return *operator->();
- }
- private:
- const packed_type *packed;
- index_type index;
- };
- [[nodiscard]] auto page(const Entity entt) const ENTT_NOEXCEPT {
- return size_type{(to_integral(entt) & traits_type::entity_mask) / entt_per_page};
- }
- [[nodiscard]] auto offset(const Entity entt) const ENTT_NOEXCEPT {
- return size_type{to_integral(entt) & (entt_per_page - 1)};
- }
- [[nodiscard]] page_type & assure(const std::size_t pos) {
- if(!(pos < sparse.size())) {
- sparse.resize(pos+1);
- }
- if(!sparse[pos]) {
- sparse[pos].reset(new entity_type[entt_per_page]);
- // null is safe in all cases for our purposes
- for(auto *first = sparse[pos].get(), *last = first + entt_per_page; first != last; ++first) {
- *first = null;
- }
- }
- return sparse[pos];
- }
- public:
- /*! @brief Underlying entity identifier. */
- using entity_type = Entity;
- /*! @brief Unsigned integer type. */
- using size_type = std::size_t;
- /*! @brief Random access iterator type. */
- using iterator = sparse_set_iterator;
- /*! @brief Reverse iterator type. */
- using reverse_iterator = const entity_type *;
- /*! @brief Default constructor. */
- sparse_set() = default;
- /*! @brief Default move constructor. */
- sparse_set(sparse_set &&) = default;
- /*! @brief Default destructor. */
- virtual ~sparse_set() = default;
- /*! @brief Default move assignment operator. @return This sparse set. */
- sparse_set & operator=(sparse_set &&) = default;
- /**
- * @brief Increases the capacity of a sparse set.
- *
- * If the new capacity is greater than the current capacity, new storage is
- * allocated, otherwise the method does nothing.
- *
- * @param cap Desired capacity.
- */
- void reserve(const size_type cap) {
- packed.reserve(cap);
- }
- /**
- * @brief Returns the number of elements that a sparse set has currently
- * allocated space for.
- * @return Capacity of the sparse set.
- */
- [[nodiscard]] size_type capacity() const ENTT_NOEXCEPT {
- return packed.capacity();
- }
- /*! @brief Requests the removal of unused capacity. */
- void shrink_to_fit() {
- // conservative approach
- if(packed.empty()) {
- sparse.clear();
- }
- sparse.shrink_to_fit();
- packed.shrink_to_fit();
- }
- /**
- * @brief Returns the extent of a sparse set.
- *
- * The extent of a sparse set is also the size of the internal sparse array.
- * There is no guarantee that the internal packed array has the same size.
- * Usually the size of the internal sparse array is equal or greater than
- * the one of the internal packed array.
- *
- * @return Extent of the sparse set.
- */
- [[nodiscard]] size_type extent() const ENTT_NOEXCEPT {
- return sparse.size() * entt_per_page;
- }
- /**
- * @brief Returns the number of elements in a sparse set.
- *
- * The number of elements is also the size of the internal packed array.
- * There is no guarantee that the internal sparse array has the same size.
- * Usually the size of the internal sparse array is equal or greater than
- * the one of the internal packed array.
- *
- * @return Number of elements.
- */
- [[nodiscard]] size_type size() const ENTT_NOEXCEPT {
- return packed.size();
- }
- /**
- * @brief Checks whether a sparse set is empty.
- * @return True if the sparse set is empty, false otherwise.
- */
- [[nodiscard]] bool empty() const ENTT_NOEXCEPT {
- return packed.empty();
- }
- /**
- * @brief Direct access to the internal packed array.
- *
- * The returned pointer is such that range `[data(), data() + size()]` is
- * always a valid range, even if the container is empty.
- *
- * @note
- * Entities are in the reverse order as returned by the `begin`/`end`
- * iterators.
- *
- * @return A pointer to the internal packed array.
- */
- [[nodiscard]] const entity_type * data() const ENTT_NOEXCEPT {
- return packed.data();
- }
- /**
- * @brief Returns an iterator to the beginning.
- *
- * The returned iterator points to the first entity of the internal packed
- * array. If the sparse set is empty, the returned iterator will be equal to
- * `end()`.
- *
- * @return An iterator to the first entity of the internal packed array.
- */
- [[nodiscard]] iterator begin() const ENTT_NOEXCEPT {
- const typename traits_type::difference_type pos = packed.size();
- return iterator{packed, pos};
- }
- /**
- * @brief Returns an iterator to the end.
- *
- * The returned iterator points to the element following the last entity in
- * the internal packed array. Attempting to dereference the returned
- * iterator results in undefined behavior.
- *
- * @return An iterator to the element following the last entity of the
- * internal packed array.
- */
- [[nodiscard]] iterator end() const ENTT_NOEXCEPT {
- return iterator{packed, {}};
- }
- /**
- * @brief Returns a reverse iterator to the beginning.
- *
- * The returned iterator points to the first entity of the reversed internal
- * packed array. If the sparse set is empty, the returned iterator will be
- * equal to `rend()`.
- *
- * @return An iterator to the first entity of the reversed internal packed
- * array.
- */
- [[nodiscard]] reverse_iterator rbegin() const ENTT_NOEXCEPT {
- return packed.data();
- }
- /**
- * @brief Returns a reverse iterator to the end.
- *
- * The returned iterator points to the element following the last entity in
- * the reversed internal packed array. Attempting to dereference the
- * returned iterator results in undefined behavior.
- *
- * @return An iterator to the element following the last entity of the
- * reversed internal packed array.
- */
- [[nodiscard]] reverse_iterator rend() const ENTT_NOEXCEPT {
- return rbegin() + packed.size();
- }
- /**
- * @brief Finds an entity.
- * @param entt A valid entity identifier.
- * @return An iterator to the given entity if it's found, past the end
- * iterator otherwise.
- */
- [[nodiscard]] iterator find(const entity_type entt) const {
- return contains(entt) ? --(end() - index(entt)) : end();
- }
- /**
- * @brief Checks if a sparse set contains an entity.
- * @param entt A valid entity identifier.
- * @return True if the sparse set contains the entity, false otherwise.
- */
- [[nodiscard]] bool contains(const entity_type entt) const {
- const auto curr = page(entt);
- // testing against null permits to avoid accessing the packed array
- return (curr < sparse.size() && sparse[curr] && sparse[curr][offset(entt)] != null);
- }
- /**
- * @brief Returns the position of an entity in a sparse set.
- *
- * @warning
- * Attempting to get the position of an entity that doesn't belong to the
- * sparse set results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * sparse set doesn't contain the given entity.
- *
- * @param entt A valid entity identifier.
- * @return The position of the entity in the sparse set.
- */
- [[nodiscard]] size_type index(const entity_type entt) const {
- ENTT_ASSERT(contains(entt));
- return size_type{to_integral(sparse[page(entt)][offset(entt)])};
- }
- /**
- * @brief Assigns an entity to a sparse set.
- *
- * @warning
- * Attempting to assign an entity that already belongs to the sparse set
- * results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * sparse set already contains the given entity.
- *
- * @param entt A valid entity identifier.
- */
- void emplace(const entity_type entt) {
- ENTT_ASSERT(!contains(entt));
- assure(page(entt))[offset(entt)] = entity_type(static_cast<typename traits_type::entity_type>(packed.size()));
- packed.push_back(entt);
- }
- /**
- * @brief Assigns one or more entities to a sparse set.
- *
- * @warning
- * Attempting to assign an entity that already belongs to the sparse set
- * results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * sparse set already contains the given entity.
- *
- * @tparam It Type of input iterator.
- * @param first An iterator to the first element of the range of entities.
- * @param last An iterator past the last element of the range of entities.
- */
- template<typename It>
- void insert(It first, It last) {
- auto next = static_cast<typename traits_type::entity_type>(packed.size());
- packed.insert(packed.end(), first, last);
- while(first != last) {
- const auto entt = *(first++);
- ENTT_ASSERT(!contains(entt));
- assure(page(entt))[offset(entt)] = entity_type(next++);
- }
- }
- /**
- * @brief Removes an entity from a sparse set.
- *
- * @warning
- * Attempting to remove an entity that doesn't belong to the sparse set
- * results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * sparse set doesn't contain the given entity.
- *
- * @param entt A valid entity identifier.
- */
- void erase(const entity_type entt) {
- ENTT_ASSERT(contains(entt));
- const auto curr = page(entt);
- const auto pos = offset(entt);
- packed[size_type{to_integral(sparse[curr][pos])}] = packed.back();
- sparse[page(packed.back())][offset(packed.back())] = sparse[curr][pos];
- sparse[curr][pos] = null;
- packed.pop_back();
- }
- /**
- * @brief Swaps two entities in the internal packed array.
- *
- * For what it's worth, this function affects both the internal sparse array
- * and the internal packed array. Users should not care of that anyway.
- *
- * @warning
- * Attempting to swap entities that don't belong to the sparse set results
- * in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * sparse set doesn't contain the given entities.
- *
- * @param lhs A valid entity identifier.
- * @param rhs A valid entity identifier.
- */
- virtual void swap(const entity_type lhs, const entity_type rhs) {
- auto &from = sparse[page(lhs)][offset(lhs)];
- auto &to = sparse[page(rhs)][offset(rhs)];
- std::swap(packed[size_type{to_integral(from)}], packed[size_type{to_integral(to)}]);
- std::swap(from, to);
- }
- /**
- * @brief Sort elements according to the given comparison function.
- *
- * Sort the elements so that iterating the range with a couple of iterators
- * returns them in the expected order. See `begin` and `end` for more
- * details.
- *
- * The comparison function object must return `true` if the first element
- * is _less_ than the second one, `false` otherwise. The signature of the
- * comparison function should be equivalent to the following:
- *
- * @code{.cpp}
- * bool(const Entity, const Entity);
- * @endcode
- *
- * Moreover, the comparison function object shall induce a
- * _strict weak ordering_ on the values.
- *
- * The sort function oject must offer a member function template
- * `operator()` that accepts three arguments:
- *
- * * An iterator to the first element of the range to sort.
- * * An iterator past the last element of the range to sort.
- * * A comparison function to use to compare the elements.
- *
- * @tparam Compare Type of comparison function object.
- * @tparam Sort Type of sort function object.
- * @tparam Args Types of arguments to forward to the sort function object.
- * @param first An iterator to the first element of the range to sort.
- * @param last An iterator past the last element of the range to sort.
- * @param compare A valid comparison function object.
- * @param algo A valid sort function object.
- * @param args Arguments to forward to the sort function object, if any.
- */
- template<typename Compare, typename Sort = std_sort, typename... Args>
- void sort(iterator first, iterator last, Compare compare, Sort algo = Sort{}, Args &&... args) {
- ENTT_ASSERT(!(last < first));
- ENTT_ASSERT(!(last > end()));
- const auto length = std::distance(first, last);
- const auto skip = std::distance(last, end());
- const auto to = packed.rend() - skip;
- const auto from = to - length;
- algo(from, to, std::move(compare), std::forward<Args>(args)...);
- for(size_type pos = skip, end = skip+length; pos < end; ++pos) {
- sparse[page(packed[pos])][offset(packed[pos])] = entity_type(static_cast<typename traits_type::entity_type>(pos));
- }
- }
- /**
- * @brief Sort elements according to the given comparison function.
- *
- * @sa sort
- *
- * This function is a slightly slower version of `sort` that invokes the
- * caller to indicate which entities are swapped.<br/>
- * It's recommended when the caller wants to sort its own data structures to
- * align them with the order induced in the sparse set.
- *
- * The signature of the callback should be equivalent to the following:
- *
- * @code{.cpp}
- * bool(const Entity, const Entity);
- * @endcode
- *
- * @tparam Apply Type of function object to invoke to notify the caller.
- * @tparam Compare Type of comparison function object.
- * @tparam Sort Type of sort function object.
- * @tparam Args Types of arguments to forward to the sort function object.
- * @param first An iterator to the first element of the range to sort.
- * @param last An iterator past the last element of the range to sort.
- * @param apply A valid function object to use as a callback.
- * @param compare A valid comparison function object.
- * @param algo A valid sort function object.
- * @param args Arguments to forward to the sort function object, if any.
- */
- template<typename Apply, typename Compare, typename Sort = std_sort, typename... Args>
- void arrange(iterator first, iterator last, Apply apply, Compare compare, Sort algo = Sort{}, Args &&... args) {
- ENTT_ASSERT(!(last < first));
- ENTT_ASSERT(!(last > end()));
- const auto length = std::distance(first, last);
- const auto skip = std::distance(last, end());
- const auto to = packed.rend() - skip;
- const auto from = to - length;
- algo(from, to, std::move(compare), std::forward<Args>(args)...);
- for(size_type pos = skip, end = skip+length; pos < end; ++pos) {
- auto curr = pos;
- auto next = index(packed[curr]);
- while(curr != next) {
- apply(packed[curr], packed[next]);
- sparse[page(packed[curr])][offset(packed[curr])] = entity_type(static_cast<typename traits_type::entity_type>(curr));
- curr = next;
- next = index(packed[curr]);
- }
- }
- }
- /**
- * @brief Sort entities according to their order in another sparse set.
- *
- * Entities that are part of both the sparse sets are ordered internally
- * according to the order they have in `other`. All the other entities goes
- * to the end of the list and there are no guarantees on their order.<br/>
- * In other terms, this function can be used to impose the same order on two
- * sets by using one of them as a master and the other one as a slave.
- *
- * Iterating the sparse set with a couple of iterators returns elements in
- * the expected order after a call to `respect`. See `begin` and `end` for
- * more details.
- *
- * @param other The sparse sets that imposes the order of the entities.
- */
- void respect(const sparse_set &other) {
- const auto to = other.end();
- auto from = other.begin();
- size_type pos = packed.size() - 1;
- while(pos && from != to) {
- if(contains(*from)) {
- if(*from != packed[pos]) {
- swap(packed[pos], *from);
- }
- --pos;
- }
- ++from;
- }
- }
- /**
- * @brief Clears a sparse set.
- */
- void clear() ENTT_NOEXCEPT {
- sparse.clear();
- packed.clear();
- }
- private:
- std::vector<page_type> sparse;
- std::vector<entity_type> packed;
- };
- }
- #endif
- namespace entt {
- /**
- * @brief Basic storage implementation.
- *
- * This class is a refinement of a sparse set that associates an object to an
- * entity. The main purpose of this class is to extend sparse sets to store
- * components in a registry. It guarantees fast access both to the elements and
- * to the entities.
- *
- * @note
- * Entities and objects have the same order. It's guaranteed both in case of raw
- * access (either to entities or objects) and when using random or input access
- * iterators.
- *
- * @note
- * Internal data structures arrange elements to maximize performance. There are
- * no guarantees that objects are returned in the insertion order when iterate
- * a storage. Do not make assumption on the order in any case.
- *
- * @warning
- * Empty types aren't explicitly instantiated. Therefore, many of the functions
- * normally available for non-empty types will not be available for empty ones.
- *
- * @sa sparse_set<Entity>
- *
- * @tparam Entity A valid entity type (see entt_traits for more details).
- * @tparam Type Type of objects assigned to the entities.
- */
- template<typename Entity, typename Type, typename = std::void_t<>>
- class storage: public sparse_set<Entity> {
- static_assert(std::is_move_constructible_v<Type> && std::is_move_assignable_v<Type>, "The managed type must be at least move constructible and assignable");
- using underlying_type = sparse_set<Entity>;
- using traits_type = entt_traits<Entity>;
- template<bool Const>
- class storage_iterator final {
- friend class storage<Entity, Type>;
- using instance_type = std::conditional_t<Const, const std::vector<Type>, std::vector<Type>>;
- using index_type = typename traits_type::difference_type;
- storage_iterator(instance_type &ref, const index_type idx) ENTT_NOEXCEPT
- : instances{&ref}, index{idx}
- {}
- public:
- using difference_type = index_type;
- using value_type = Type;
- using pointer = std::conditional_t<Const, const value_type *, value_type *>;
- using reference = std::conditional_t<Const, const value_type &, value_type &>;
- using iterator_category = std::random_access_iterator_tag;
- storage_iterator() ENTT_NOEXCEPT = default;
- storage_iterator & operator++() ENTT_NOEXCEPT {
- return --index, *this;
- }
- storage_iterator operator++(int) ENTT_NOEXCEPT {
- storage_iterator orig = *this;
- return ++(*this), orig;
- }
- storage_iterator & operator--() ENTT_NOEXCEPT {
- return ++index, *this;
- }
- storage_iterator operator--(int) ENTT_NOEXCEPT {
- storage_iterator orig = *this;
- return operator--(), orig;
- }
- storage_iterator & operator+=(const difference_type value) ENTT_NOEXCEPT {
- index -= value;
- return *this;
- }
- storage_iterator operator+(const difference_type value) const ENTT_NOEXCEPT {
- storage_iterator copy = *this;
- return (copy += value);
- }
- storage_iterator & operator-=(const difference_type value) ENTT_NOEXCEPT {
- return (*this += -value);
- }
- storage_iterator operator-(const difference_type value) const ENTT_NOEXCEPT {
- return (*this + -value);
- }
- difference_type operator-(const storage_iterator &other) const ENTT_NOEXCEPT {
- return other.index - index;
- }
- [[nodiscard]] reference operator[](const difference_type value) const ENTT_NOEXCEPT {
- const auto pos = size_type(index-value-1);
- return (*instances)[pos];
- }
- [[nodiscard]] bool operator==(const storage_iterator &other) const ENTT_NOEXCEPT {
- return other.index == index;
- }
- [[nodiscard]] bool operator!=(const storage_iterator &other) const ENTT_NOEXCEPT {
- return !(*this == other);
- }
- [[nodiscard]] bool operator<(const storage_iterator &other) const ENTT_NOEXCEPT {
- return index > other.index;
- }
- [[nodiscard]] bool operator>(const storage_iterator &other) const ENTT_NOEXCEPT {
- return index < other.index;
- }
- [[nodiscard]] bool operator<=(const storage_iterator &other) const ENTT_NOEXCEPT {
- return !(*this > other);
- }
- [[nodiscard]] bool operator>=(const storage_iterator &other) const ENTT_NOEXCEPT {
- return !(*this < other);
- }
- [[nodiscard]] pointer operator->() const ENTT_NOEXCEPT {
- const auto pos = size_type(index-1u);
- return &(*instances)[pos];
- }
- [[nodiscard]] reference operator*() const ENTT_NOEXCEPT {
- return *operator->();
- }
- private:
- instance_type *instances;
- index_type index;
- };
- public:
- /*! @brief Type of the objects associated with the entities. */
- using object_type = Type;
- /*! @brief Underlying entity identifier. */
- using entity_type = Entity;
- /*! @brief Unsigned integer type. */
- using size_type = std::size_t;
- /*! @brief Random access iterator type. */
- using iterator = storage_iterator<false>;
- /*! @brief Constant random access iterator type. */
- using const_iterator = storage_iterator<true>;
- /*! @brief Reverse iterator type. */
- using reverse_iterator = Type *;
- /*! @brief Constant reverse iterator type. */
- using const_reverse_iterator = const Type *;
- /**
- * @brief Increases the capacity of a storage.
- *
- * If the new capacity is greater than the current capacity, new storage is
- * allocated, otherwise the method does nothing.
- *
- * @param cap Desired capacity.
- */
- void reserve(const size_type cap) {
- underlying_type::reserve(cap);
- instances.reserve(cap);
- }
- /*! @brief Requests the removal of unused capacity. */
- void shrink_to_fit() {
- underlying_type::shrink_to_fit();
- instances.shrink_to_fit();
- }
- /**
- * @brief Direct access to the array of objects.
- *
- * The returned pointer is such that range `[raw(), raw() + size()]` is
- * always a valid range, even if the container is empty.
- *
- * @note
- * Objects are in the reverse order as returned by the `begin`/`end`
- * iterators.
- *
- * @return A pointer to the array of objects.
- */
- [[nodiscard]] const object_type * raw() const ENTT_NOEXCEPT {
- return instances.data();
- }
- /*! @copydoc raw */
- [[nodiscard]] object_type * raw() ENTT_NOEXCEPT {
- return const_cast<object_type *>(std::as_const(*this).raw());
- }
- /**
- * @brief Returns an iterator to the beginning.
- *
- * The returned iterator points to the first instance of the internal array.
- * If the storage is empty, the returned iterator will be equal to `end()`.
- *
- * @return An iterator to the first instance of the internal array.
- */
- [[nodiscard]] const_iterator cbegin() const ENTT_NOEXCEPT {
- const typename traits_type::difference_type pos = underlying_type::size();
- return const_iterator{instances, pos};
- }
- /*! @copydoc cbegin */
- [[nodiscard]] const_iterator begin() const ENTT_NOEXCEPT {
- return cbegin();
- }
- /*! @copydoc begin */
- [[nodiscard]] iterator begin() ENTT_NOEXCEPT {
- const typename traits_type::difference_type pos = underlying_type::size();
- return iterator{instances, pos};
- }
- /**
- * @brief Returns an iterator to the end.
- *
- * The returned iterator points to the element following the last instance
- * of the internal array. Attempting to dereference the returned iterator
- * results in undefined behavior.
- *
- * @return An iterator to the element following the last instance of the
- * internal array.
- */
- [[nodiscard]] const_iterator cend() const ENTT_NOEXCEPT {
- return const_iterator{instances, {}};
- }
- /*! @copydoc cend */
- [[nodiscard]] const_iterator end() const ENTT_NOEXCEPT {
- return cend();
- }
- /*! @copydoc end */
- [[nodiscard]] iterator end() ENTT_NOEXCEPT {
- return iterator{instances, {}};
- }
- /**
- * @brief Returns a reverse iterator to the beginning.
- *
- * The returned iterator points to the first instance of the reversed
- * internal array. If the storage is empty, the returned iterator will be
- * equal to `rend()`.
- *
- * @return An iterator to the first instance of the reversed internal array.
- */
- [[nodiscard]] const_reverse_iterator crbegin() const ENTT_NOEXCEPT {
- return instances.data();
- }
- /*! @copydoc crbegin */
- [[nodiscard]] const_reverse_iterator rbegin() const ENTT_NOEXCEPT {
- return crbegin();
- }
- /*! @copydoc rbegin */
- [[nodiscard]] reverse_iterator rbegin() ENTT_NOEXCEPT {
- return instances.data();
- }
- /**
- * @brief Returns a reverse iterator to the end.
- *
- * The returned iterator points to the element following the last instance
- * of the reversed internal array. Attempting to dereference the returned
- * iterator results in undefined behavior.
- *
- * @return An iterator to the element following the last instance of the
- * reversed internal array.
- */
- [[nodiscard]] const_reverse_iterator crend() const ENTT_NOEXCEPT {
- return crbegin() + instances.size();
- }
- /*! @copydoc crend */
- [[nodiscard]] const_reverse_iterator rend() const ENTT_NOEXCEPT {
- return crend();
- }
- /*! @copydoc rend */
- [[nodiscard]] reverse_iterator rend() ENTT_NOEXCEPT {
- return rbegin() + instances.size();
- }
- /**
- * @brief Returns the object associated with an entity.
- *
- * @warning
- * Attempting to use an entity that doesn't belong to the storage results in
- * undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * storage doesn't contain the given entity.
- *
- * @param entt A valid entity identifier.
- * @return The object associated with the entity.
- */
- [[nodiscard]] const object_type & get(const entity_type entt) const {
- return instances[underlying_type::index(entt)];
- }
- /*! @copydoc get */
- [[nodiscard]] object_type & get(const entity_type entt) {
- return const_cast<object_type &>(std::as_const(*this).get(entt));
- }
- /**
- * @brief Returns a pointer to the object associated with an entity, if any.
- * @param entt A valid entity identifier.
- * @return The object associated with the entity, if any.
- */
- [[nodiscard]] const object_type * try_get(const entity_type entt) const {
- return underlying_type::contains(entt) ? (instances.data() + underlying_type::index(entt)) : nullptr;
- }
- /*! @copydoc try_get */
- [[nodiscard]] object_type * try_get(const entity_type entt) {
- return const_cast<object_type *>(std::as_const(*this).try_get(entt));
- }
- /**
- * @brief Assigns an entity to a storage and constructs its object.
- *
- * This version accept both types that can be constructed in place directly
- * and types like aggregates that do not work well with a placement new as
- * performed usually under the hood during an _emplace back_.
- *
- * @warning
- * Attempting to use an entity that already belongs to the storage results
- * in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * storage already contains the given entity.
- *
- * @tparam Args Types of arguments to use to construct the object.
- * @param entt A valid entity identifier.
- * @param args Parameters to use to construct an object for the entity.
- */
- template<typename... Args>
- void emplace(const entity_type entt, Args &&... args) {
- if constexpr(std::is_aggregate_v<object_type>) {
- instances.push_back(Type{std::forward<Args>(args)...});
- } else {
- instances.emplace_back(std::forward<Args>(args)...);
- }
- // entity goes after component in case constructor throws
- underlying_type::emplace(entt);
- }
- /**
- * @brief Assigns one or more entities to a storage and constructs their
- * objects from a given instance.
- *
- * @warning
- * Attempting to assign an entity that already belongs to the storage
- * results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * storage already contains the given entity.
- *
- * @tparam It Type of input iterator.
- * @param first An iterator to the first element of the range of entities.
- * @param last An iterator past the last element of the range of entities.
- * @param value An instance of the object to construct.
- */
- template<typename It>
- void insert(It first, It last, const object_type &value = {}) {
- instances.insert(instances.end(), std::distance(first, last), value);
- // entities go after components in case constructors throw
- underlying_type::insert(first, last);
- }
- /**
- * @brief Assigns one or more entities to a storage and constructs their
- * objects from a given range.
- *
- * @sa construct
- *
- * @tparam EIt Type of input iterator.
- * @tparam CIt Type of input iterator.
- * @param first An iterator to the first element of the range of entities.
- * @param last An iterator past the last element of the range of entities.
- * @param from An iterator to the first element of the range of objects.
- * @param to An iterator past the last element of the range of objects.
- */
- template<typename EIt, typename CIt>
- void insert(EIt first, EIt last, CIt from, CIt to) {
- instances.insert(instances.end(), from, to);
- // entities go after components in case constructors throw
- underlying_type::insert(first, last);
- }
- /**
- * @brief Removes an entity from a storage and destroys its object.
- *
- * @warning
- * Attempting to use an entity that doesn't belong to the storage results in
- * undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * storage doesn't contain the given entity.
- *
- * @param entt A valid entity identifier.
- */
- void erase(const entity_type entt) {
- auto other = std::move(instances.back());
- instances[underlying_type::index(entt)] = std::move(other);
- instances.pop_back();
- underlying_type::erase(entt);
- }
- /**
- * @brief Swaps entities and objects in the internal packed arrays.
- *
- * @warning
- * Attempting to swap entities that don't belong to the sparse set results
- * in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * sparse set doesn't contain the given entities.
- *
- * @param lhs A valid entity identifier.
- * @param rhs A valid entity identifier.
- */
- void swap(const entity_type lhs, const entity_type rhs) override {
- std::swap(instances[underlying_type::index(lhs)], instances[underlying_type::index(rhs)]);
- underlying_type::swap(lhs, rhs);
- }
- /**
- * @brief Sort elements according to the given comparison function.
- *
- * Sort the elements so that iterating the range with a couple of iterators
- * returns them in the expected order. See `begin` and `end` for more
- * details.
- *
- * The comparison function object must return `true` if the first element
- * is _less_ than the second one, `false` otherwise. The signature of the
- * comparison function should be equivalent to one of the following:
- *
- * @code{.cpp}
- * bool(const Entity, const Entity);
- * bool(const Type &, const Type &);
- * @endcode
- *
- * Moreover, the comparison function object shall induce a
- * _strict weak ordering_ on the values.
- *
- * The sort function oject must offer a member function template
- * `operator()` that accepts three arguments:
- *
- * * An iterator to the first element of the range to sort.
- * * An iterator past the last element of the range to sort.
- * * A comparison function to use to compare the elements.
- *
- * @warning
- * Empty types are never instantiated. Therefore, only comparison function
- * objects that require to return entities rather than components are
- * accepted.
- *
- * @tparam Compare Type of comparison function object.
- * @tparam Sort Type of sort function object.
- * @tparam Args Types of arguments to forward to the sort function object.
- * @param first An iterator to the first element of the range to sort.
- * @param last An iterator past the last element of the range to sort.
- * @param compare A valid comparison function object.
- * @param algo A valid sort function object.
- * @param args Arguments to forward to the sort function object, if any.
- */
- template<typename Compare, typename Sort = std_sort, typename... Args>
- void sort(iterator first, iterator last, Compare compare, Sort algo = Sort{}, Args &&... args) {
- ENTT_ASSERT(!(last < first));
- ENTT_ASSERT(!(last > end()));
- const auto from = underlying_type::begin() + std::distance(begin(), first);
- const auto to = from + std::distance(first, last);
- const auto apply = [this](const auto lhs, const auto rhs) {
- std::swap(instances[underlying_type::index(lhs)], instances[underlying_type::index(rhs)]);
- };
- if constexpr(std::is_invocable_v<Compare, const object_type &, const object_type &>) {
- underlying_type::arrange(from, to, std::move(apply), [this, compare = std::move(compare)](const auto lhs, const auto rhs) {
- return compare(std::as_const(instances[underlying_type::index(lhs)]), std::as_const(instances[underlying_type::index(rhs)]));
- }, std::move(algo), std::forward<Args>(args)...);
- } else {
- underlying_type::arrange(from, to, std::move(apply), std::move(compare), std::move(algo), std::forward<Args>(args)...);
- }
- }
- /*! @brief Clears a storage. */
- void clear() {
- underlying_type::clear();
- instances.clear();
- }
- private:
- std::vector<object_type> instances;
- };
- /*! @copydoc storage */
- template<typename Entity, typename Type>
- class storage<Entity, Type, std::enable_if_t<is_eto_eligible_v<Type>>>: public sparse_set<Entity> {
- using underlying_type = sparse_set<Entity>;
- public:
- /*! @brief Type of the objects associated with the entities. */
- using object_type = Type;
- /*! @brief Underlying entity identifier. */
- using entity_type = Entity;
- /*! @brief Unsigned integer type. */
- using size_type = std::size_t;
- /**
- * @brief Assigns an entity to a storage and constructs its object.
- *
- * @warning
- * Attempting to use an entity that already belongs to the storage results
- * in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * storage already contains the given entity.
- *
- * @tparam Args Types of arguments to use to construct the object.
- * @param entt A valid entity identifier.
- * @param args Parameters to use to construct an object for the entity.
- */
- template<typename... Args>
- void emplace(const entity_type entt, Args &&... args) {
- [[maybe_unused]] object_type instance{std::forward<Args>(args)...};
- underlying_type::emplace(entt);
- }
- /**
- * @brief Assigns one or more entities to a storage.
- *
- * @warning
- * Attempting to assign an entity that already belongs to the storage
- * results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * storage already contains the given entity.
- *
- * @tparam It Type of input iterator.
- * @param first An iterator to the first element of the range of entities.
- * @param last An iterator past the last element of the range of entities.
- */
- template<typename It>
- void insert(It first, It last, const object_type & = {}) {
- underlying_type::insert(first, last);
- }
- };
- }
- #endif
- namespace entt {
- /**
- * @brief Applies component-to-pool conversion and defines the resulting type as
- * the member typedef type.
- *
- * Formally:
- *
- * * If the component type is a non-const one, the member typedef type is the
- * declared storage type.
- * * If the component type is a const one, the member typedef type is the
- * declared storage type, except it has a const-qualifier added.
- *
- * @tparam Entity A valid entity type (see entt_traits for more details).
- * @tparam Type Type of objects assigned to the entities.
- */
- template<typename Entity, typename Type, typename = void>
- struct pool {
- /*! @brief Resulting type after component-to-pool conversion. */
- using type = storage<Entity, Type>;
- };
- /*! @copydoc pool */
- template<typename Entity, typename Type>
- struct pool<Entity, const Type> {
- /*! @brief Resulting type after component-to-pool conversion. */
- using type = std::add_const_t<typename pool<Entity, std::remove_const_t<Type>>::type>;
- };
- /**
- * @brief Alias declaration to use to make component-to-pool conversions.
- * @tparam Entity A valid entity type (see entt_traits for more details).
- * @tparam Type Type of objects assigned to the entities.
- */
- template<typename Entity, typename Type>
- using pool_t = typename pool<Entity, Type>::type;
- }
- #endif
- // #include "sparse_set.hpp"
- // #include "utility.hpp"
- #ifndef ENTT_ENTITY_UTILITY_HPP
- #define ENTT_ENTITY_UTILITY_HPP
- // #include "../core/type_traits.hpp"
- namespace entt {
- /**
- * @brief Alias for exclusion lists.
- * @tparam Type List of types.
- */
- template<typename... Type>
- struct exclude_t: type_list<Type...> {};
- /**
- * @brief Variable template for exclusion lists.
- * @tparam Type List of types.
- */
- template<typename... Type>
- inline constexpr exclude_t<Type...> exclude{};
- /**
- * @brief Alias for lists of observed components.
- * @tparam Type List of types.
- */
- template<typename... Type>
- struct get_t: type_list<Type...>{};
- /**
- * @brief Variable template for lists of observed components.
- * @tparam Type List of types.
- */
- template<typename... Type>
- inline constexpr get_t<Type...> get{};
- }
- #endif
- namespace entt {
- /**
- * @brief Group.
- *
- * Primary template isn't defined on purpose. All the specializations give a
- * compile-time error, but for a few reasonable cases.
- */
- template<typename...>
- class basic_group;
- /**
- * @brief Non-owning group.
- *
- * A non-owning group returns all entities and only the entities that have at
- * least the given components. Moreover, it's guaranteed that the entity list
- * is tightly packed in memory for fast iterations.
- *
- * @b Important
- *
- * Iterators aren't invalidated if:
- *
- * * New instances of the given components are created and assigned to entities.
- * * The entity currently pointed is modified (as an example, if one of the
- * given components is removed from the entity to which the iterator points).
- * * The entity currently pointed is destroyed.
- *
- * In all other cases, modifying the pools iterated by the group in any way
- * invalidates all the iterators and using them results in undefined behavior.
- *
- * @note
- * Groups share references to the underlying data structures of the registry
- * that generated them. Therefore any change to the entities and to the
- * components made by means of the registry are immediately reflected by all the
- * groups.<br/>
- * Moreover, sorting a non-owning group affects all the instances of the same
- * group (it means that users don't have to call `sort` on each instance to sort
- * all of them because they _share_ entities and components).
- *
- * @warning
- * Lifetime of a group must not overcome that of the registry that generated it.
- * In any other case, attempting to use a group results in undefined behavior.
- *
- * @tparam Entity A valid entity type (see entt_traits for more details).
- * @tparam Exclude Types of components used to filter the group.
- * @tparam Get Type of components observed by the group.
- */
- template<typename Entity, typename... Exclude, typename... Get>
- class basic_group<Entity, exclude_t<Exclude...>, get_t<Get...>> {
- /*! @brief A registry is allowed to create groups. */
- friend class basic_registry<Entity>;
- template<typename Component>
- using pool_type = pool_t<Entity, Component>;
- class group_proxy {
- friend class basic_group<Entity, exclude_t<Exclude...>, get_t<Get...>>;
- class proxy_iterator {
- friend class group_proxy;
- using it_type = typename sparse_set<Entity>::iterator;
- using ref_type = decltype(std::tuple_cat(std::declval<std::conditional_t<is_eto_eligible_v<Get>, std::tuple<>, std::tuple<pool_type<Get> *>>>()...));
- proxy_iterator(it_type from, ref_type ref) ENTT_NOEXCEPT
- : it{from},
- pools{ref}
- {}
- public:
- using difference_type = std::ptrdiff_t;
- using value_type = decltype(std::tuple_cat(
- std::declval<std::tuple<Entity>>(),
- std::declval<std::conditional_t<is_eto_eligible_v<Get>, std::tuple<>, std::tuple<Get>>>()...
- ));
- using pointer = void;
- using reference = decltype(std::tuple_cat(
- std::declval<std::tuple<Entity>>(),
- std::declval<std::conditional_t<is_eto_eligible_v<Get>, std::tuple<>, std::tuple<Get &>>>()...
- ));
- using iterator_category = std::input_iterator_tag;
- proxy_iterator & operator++() ENTT_NOEXCEPT {
- return ++it, *this;
- }
- proxy_iterator operator++(int) ENTT_NOEXCEPT {
- proxy_iterator orig = *this;
- return ++(*this), orig;
- }
- [[nodiscard]] reference operator*() const ENTT_NOEXCEPT {
- return std::apply([entt = *it](auto *... cpool) { return reference{entt, cpool->get(entt)...}; }, pools);
- }
- [[nodiscard]] bool operator==(const proxy_iterator &other) const ENTT_NOEXCEPT {
- return other.it == it;
- }
- [[nodiscard]] bool operator!=(const proxy_iterator &other) const ENTT_NOEXCEPT {
- return !(*this == other);
- }
- private:
- it_type it{};
- ref_type pools{};
- };
- group_proxy(const sparse_set<Entity> &ref, std::tuple<pool_type<Get> *...> gpools)
- : handler{&ref},
- pools{gpools}
- {}
- public:
- using iterator = proxy_iterator;
- [[nodiscard]] iterator begin() const ENTT_NOEXCEPT {
- return proxy_iterator{handler->begin(), std::tuple_cat([](auto *cpool) {
- if constexpr(is_eto_eligible_v<typename std::decay_t<decltype(*cpool)>::object_type>) {
- return std::make_tuple();
- } else {
- return std::make_tuple(cpool);
- }
- }(std::get<pool_type<Get> *>(pools))...)};
- }
- [[nodiscard]] iterator end() const ENTT_NOEXCEPT {
- return proxy_iterator{handler->end(), std::tuple_cat([](auto *cpool) {
- if constexpr(is_eto_eligible_v<typename std::decay_t<decltype(*cpool)>::object_type>) {
- return std::make_tuple();
- } else {
- return std::make_tuple(cpool);
- }
- }(std::get<pool_type<Get> *>(pools))...)};
- }
- private:
- const sparse_set<Entity> *handler;
- std::tuple<pool_type<Get> *...> pools;
- };
- basic_group(sparse_set<Entity> &ref, pool_type<Get> &... gpool) ENTT_NOEXCEPT
- : handler{&ref},
- pools{&gpool...}
- {}
- template<typename Func, typename... Weak>
- void traverse(Func func, type_list<Weak...>) const {
- for(const auto entt: *handler) {
- if constexpr(std::is_invocable_v<Func, decltype(get<Weak>({}))...>) {
- func(std::get<pool_type<Weak> *>(pools)->get(entt)...);
- } else {
- func(entt, std::get<pool_type<Weak> *>(pools)->get(entt)...);
- }
- }
- }
- public:
- /*! @brief Underlying entity identifier. */
- using entity_type = Entity;
- /*! @brief Unsigned integer type. */
- using size_type = std::size_t;
- /*! @brief Random access iterator type. */
- using iterator = typename sparse_set<Entity>::iterator;
- /*! @brief Reversed iterator type. */
- using reverse_iterator = typename sparse_set<Entity>::reverse_iterator;
- /**
- * @brief Returns the number of existing components of the given type.
- * @tparam Component Type of component of which to return the size.
- * @return Number of existing components of the given type.
- */
- template<typename Component>
- [[nodiscard]] size_type size() const ENTT_NOEXCEPT {
- return std::get<pool_type<Component> *>(pools)->size();
- }
- /**
- * @brief Returns the number of entities that have the given components.
- * @return Number of entities that have the given components.
- */
- [[nodiscard]] size_type size() const ENTT_NOEXCEPT {
- return handler->size();
- }
- /**
- * @brief Returns the number of elements that a group has currently
- * allocated space for.
- * @return Capacity of the group.
- */
- [[nodiscard]] size_type capacity() const ENTT_NOEXCEPT {
- return handler->capacity();
- }
- /*! @brief Requests the removal of unused capacity. */
- void shrink_to_fit() {
- handler->shrink_to_fit();
- }
- /**
- * @brief Checks whether a group or some pools are empty.
- * @tparam Component Types of components in which one is interested.
- * @return True if the group or the pools are empty, false otherwise.
- */
- template<typename... Component>
- [[nodiscard]] bool empty() const ENTT_NOEXCEPT {
- if constexpr(sizeof...(Component) == 0) {
- return handler->empty();
- } else {
- return (std::get<pool_type<Component> *>(pools)->empty() && ...);
- }
- }
- /**
- * @brief Direct access to the list of components of a given pool.
- *
- * The returned pointer is such that range
- * `[raw<Component>(), raw<Component>() + size<Component>()]` is always a
- * valid range, even if the container is empty.
- *
- * @note
- * Components are in the reverse order as returned by the `begin`/`end`
- * iterators.
- *
- * @tparam Component Type of component in which one is interested.
- * @return A pointer to the array of components.
- */
- template<typename Component>
- [[nodiscard]] Component * raw() const ENTT_NOEXCEPT {
- return std::get<pool_type<Component> *>(pools)->raw();
- }
- /**
- * @brief Direct access to the list of entities of a given pool.
- *
- * The returned pointer is such that range
- * `[data<Component>(), data<Component>() + size<Component>()]` is always a
- * valid range, even if the container is empty.
- *
- * @note
- * Entities are in the reverse order as returned by the `begin`/`end`
- * iterators.
- *
- * @tparam Component Type of component in which one is interested.
- * @return A pointer to the array of entities.
- */
- template<typename Component>
- [[nodiscard]] const entity_type * data() const ENTT_NOEXCEPT {
- return std::get<pool_type<Component> *>(pools)->data();
- }
- /**
- * @brief Direct access to the list of entities.
- *
- * The returned pointer is such that range `[data(), data() + size()]` is
- * always a valid range, even if the container is empty.
- *
- * @note
- * Entities are in the reverse order as returned by the `begin`/`end`
- * iterators.
- *
- * @return A pointer to the array of entities.
- */
- [[nodiscard]] const entity_type * data() const ENTT_NOEXCEPT {
- return handler->data();
- }
- /**
- * @brief Returns an iterator to the first entity of the group.
- *
- * The returned iterator points to the first entity of the group. If the
- * group is empty, the returned iterator will be equal to `end()`.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the first entity of the group.
- */
- [[nodiscard]] iterator begin() const ENTT_NOEXCEPT {
- return handler->begin();
- }
- /**
- * @brief Returns an iterator that is past the last entity of the group.
- *
- * The returned iterator points to the entity following the last entity of
- * the group. Attempting to dereference the returned iterator results in
- * undefined behavior.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the entity following the last entity of the
- * group.
- */
- [[nodiscard]] iterator end() const ENTT_NOEXCEPT {
- return handler->end();
- }
- /**
- * @brief Returns an iterator to the first entity of the reversed group.
- *
- * The returned iterator points to the first entity of the reversed group.
- * If the group is empty, the returned iterator will be equal to `rend()`.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the first entity of the reversed group.
- */
- [[nodiscard]] reverse_iterator rbegin() const ENTT_NOEXCEPT {
- return handler->rbegin();
- }
- /**
- * @brief Returns an iterator that is past the last entity of the reversed
- * group.
- *
- * The returned iterator points to the entity following the last entity of
- * the reversed group. Attempting to dereference the returned iterator
- * results in undefined behavior.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the entity following the last entity of the
- * reversed group.
- */
- [[nodiscard]] reverse_iterator rend() const ENTT_NOEXCEPT {
- return handler->rend();
- }
- /**
- * @brief Returns the first entity of the group, if any.
- * @return The first entity of the group if one exists, the null entity
- * otherwise.
- */
- [[nodiscard]] entity_type front() const {
- const auto it = begin();
- return it != end() ? *it : null;
- }
- /**
- * @brief Returns the last entity of the group, if any.
- * @return The last entity of the group if one exists, the null entity
- * otherwise.
- */
- [[nodiscard]] entity_type back() const {
- const auto it = rbegin();
- return it != rend() ? *it : null;
- }
- /**
- * @brief Finds an entity.
- * @param entt A valid entity identifier.
- * @return An iterator to the given entity if it's found, past the end
- * iterator otherwise.
- */
- [[nodiscard]] iterator find(const entity_type entt) const {
- const auto it = handler->find(entt);
- return it != end() && *it == entt ? it : end();
- }
- /**
- * @brief Returns the identifier that occupies the given position.
- * @param pos Position of the element to return.
- * @return The identifier that occupies the given position.
- */
- [[nodiscard]] entity_type operator[](const size_type pos) const {
- return begin()[pos];
- }
- /**
- * @brief Checks if a group contains an entity.
- * @param entt A valid entity identifier.
- * @return True if the group contains the given entity, false otherwise.
- */
- [[nodiscard]] bool contains(const entity_type entt) const {
- return handler->contains(entt);
- }
- /**
- * @brief Returns the components assigned to the given entity.
- *
- * Prefer this function instead of `registry::get` during iterations. It has
- * far better performance than its counterpart.
- *
- * @warning
- * Attempting to use an invalid component type results in a compilation
- * error. Attempting to use an entity that doesn't belong to the group
- * results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * group doesn't contain the given entity.
- *
- * @tparam Component Types of components to get.
- * @param entt A valid entity identifier.
- * @return The components assigned to the entity.
- */
- template<typename... Component>
- [[nodiscard]] decltype(auto) get([[maybe_unused]] const entity_type entt) const {
- ENTT_ASSERT(contains(entt));
- if constexpr(sizeof...(Component) == 1) {
- return (std::get<pool_type<Component> *>(pools)->get(entt), ...);
- } else {
- return std::tuple<decltype(get<Component>({}))...>{get<Component>(entt)...};
- }
- }
- /**
- * @brief Iterates entities and components and applies the given function
- * object to them.
- *
- * The function object is invoked for each entity. It is provided with the
- * entity itself and a set of references to non-empty components. The
- * _constness_ of the components is as requested.<br/>
- * The signature of the function must be equivalent to one of the following
- * forms:
- *
- * @code{.cpp}
- * void(const entity_type, Type &...);
- * void(Type &...);
- * @endcode
- *
- * @note
- * Empty types aren't explicitly instantiated and therefore they are never
- * returned during iterations.
- *
- * @tparam Func Type of the function object to invoke.
- * @param func A valid function object.
- */
- template<typename Func>
- void each(Func func) const {
- using get_type_list = type_list_cat_t<std::conditional_t<is_eto_eligible_v<Get>, type_list<>, type_list<Get>>...>;
- traverse(std::move(func), get_type_list{});
- }
- /**
- * @brief Returns an iterable object to use to _visit_ the group.
- *
- * The iterable object returns tuples that contain the current entity and a
- * set of references to its non-empty components. The _constness_ of the
- * components is as requested.
- *
- * @note
- * Empty types aren't explicitly instantiated and therefore they are never
- * returned during iterations.
- *
- * @return An iterable object to use to _visit_ the group.
- */
- [[nodiscard]] auto proxy() const ENTT_NOEXCEPT {
- return group_proxy{*handler, pools};
- }
- /**
- * @brief Sort a group according to the given comparison function.
- *
- * Sort the group so that iterating it with a couple of iterators returns
- * entities and components in the expected order. See `begin` and `end` for
- * more details.
- *
- * The comparison function object must return `true` if the first element
- * is _less_ than the second one, `false` otherwise. The signature of the
- * comparison function should be equivalent to one of the following:
- *
- * @code{.cpp}
- * bool(std::tuple<Component &...>, std::tuple<Component &...>);
- * bool(const Component &..., const Component &...);
- * bool(const Entity, const Entity);
- * @endcode
- *
- * Where `Component` are such that they are iterated by the group.<br/>
- * Moreover, the comparison function object shall induce a
- * _strict weak ordering_ on the values.
- *
- * The sort function oject must offer a member function template
- * `operator()` that accepts three arguments:
- *
- * * An iterator to the first element of the range to sort.
- * * An iterator past the last element of the range to sort.
- * * A comparison function to use to compare the elements.
- *
- * @tparam Component Optional types of components to compare.
- * @tparam Compare Type of comparison function object.
- * @tparam Sort Type of sort function object.
- * @tparam Args Types of arguments to forward to the sort function object.
- * @param compare A valid comparison function object.
- * @param algo A valid sort function object.
- * @param args Arguments to forward to the sort function object, if any.
- */
- template<typename... Component, typename Compare, typename Sort = std_sort, typename... Args>
- void sort(Compare compare, Sort algo = Sort{}, Args &&... args) {
- if constexpr(sizeof...(Component) == 0) {
- static_assert(std::is_invocable_v<Compare, const entity_type, const entity_type>, "Invalid comparison function");
- handler->sort(handler->begin(), handler->end(), std::move(compare), std::move(algo), std::forward<Args>(args)...);
- } else if constexpr(sizeof...(Component) == 1) {
- handler->sort(handler->begin(), handler->end(), [this, compare = std::move(compare)](const entity_type lhs, const entity_type rhs) {
- return compare((std::get<pool_type<Component> *>(pools)->get(lhs), ...), (std::get<pool_type<Component> *>(pools)->get(rhs), ...));
- }, std::move(algo), std::forward<Args>(args)...);
- } else {
- handler->sort(handler->begin(), handler->end(), [this, compare = std::move(compare)](const entity_type lhs, const entity_type rhs) {
- return compare(std::tuple<decltype(get<Component>({}))...>{std::get<pool_type<Component> *>(pools)->get(lhs)...}, std::tuple<decltype(get<Component>({}))...>{std::get<pool_type<Component> *>(pools)->get(rhs)...});
- }, std::move(algo), std::forward<Args>(args)...);
- }
- }
- /**
- * @brief Sort the shared pool of entities according to the given component.
- *
- * Non-owning groups of the same type share with the registry a pool of
- * entities with its own order that doesn't depend on the order of any pool
- * of components. Users can order the underlying data structure so that it
- * respects the order of the pool of the given component.
- *
- * @note
- * The shared pool of entities and thus its order is affected by the changes
- * to each and every pool that it tracks. Therefore changes to those pools
- * can quickly ruin the order imposed to the pool of entities shared between
- * the non-owning groups.
- *
- * @tparam Component Type of component to use to impose the order.
- */
- template<typename Component>
- void sort() const {
- handler->respect(*std::get<pool_type<Component> *>(pools));
- }
- private:
- sparse_set<entity_type> *handler;
- const std::tuple<pool_type<Get> *...> pools;
- };
- /**
- * @brief Owning group.
- *
- * Owning groups return all entities and only the entities that have at least
- * the given components. Moreover:
- *
- * * It's guaranteed that the entity list is tightly packed in memory for fast
- * iterations.
- * * It's guaranteed that the lists of owned components are tightly packed in
- * memory for even faster iterations and to allow direct access.
- * * They stay true to the order of the owned components and all instances have
- * the same order in memory.
- *
- * The more types of components are owned by a group, the faster it is to
- * iterate them.
- *
- * @b Important
- *
- * Iterators aren't invalidated if:
- *
- * * New instances of the given components are created and assigned to entities.
- * * The entity currently pointed is modified (as an example, if one of the
- * given components is removed from the entity to which the iterator points).
- * * The entity currently pointed is destroyed.
- *
- * In all other cases, modifying the pools iterated by the group in any way
- * invalidates all the iterators and using them results in undefined behavior.
- *
- * @note
- * Groups share references to the underlying data structures of the registry
- * that generated them. Therefore any change to the entities and to the
- * components made by means of the registry are immediately reflected by all the
- * groups.
- * Moreover, sorting an owning group affects all the instance of the same group
- * (it means that users don't have to call `sort` on each instance to sort all
- * of them because they share the underlying data structure).
- *
- * @warning
- * Lifetime of a group must not overcome that of the registry that generated it.
- * In any other case, attempting to use a group results in undefined behavior.
- *
- * @tparam Entity A valid entity type (see entt_traits for more details).
- * @tparam Exclude Types of components used to filter the group.
- * @tparam Get Types of components observed by the group.
- * @tparam Owned Types of components owned by the group.
- */
- template<typename Entity, typename... Exclude, typename... Get, typename... Owned>
- class basic_group<Entity, exclude_t<Exclude...>, get_t<Get...>, Owned...> {
- /*! @brief A registry is allowed to create groups. */
- friend class basic_registry<Entity>;
- template<typename Component>
- using pool_type = pool_t<Entity, Component>;
- template<typename Component>
- using component_iterator = decltype(std::declval<pool_type<Component>>().begin());
- class group_proxy {
- friend class basic_group<Entity, exclude_t<Exclude...>, get_t<Get...>, Owned...>;
- class proxy_iterator {
- friend class group_proxy;
- using it_type = typename sparse_set<Entity>::iterator;
- using owned_type = decltype(std::tuple_cat(std::declval<std::conditional_t<is_eto_eligible_v<Owned>, std::tuple<>, std::tuple<component_iterator<Owned>>>>()...));
- using get_type = decltype(std::tuple_cat(std::declval<std::conditional_t<is_eto_eligible_v<Get>, std::tuple<>, std::tuple<pool_type<Get> *>>>()...));
- proxy_iterator(it_type from, owned_type oref, get_type gref) ENTT_NOEXCEPT
- : it{from},
- owned{oref},
- get{gref}
- {}
- public:
- using difference_type = std::ptrdiff_t;
- using value_type = decltype(std::tuple_cat(
- std::declval<std::tuple<Entity>>(),
- std::declval<std::conditional_t<is_eto_eligible_v<Owned>, std::tuple<>, std::tuple<Owned>>>()...,
- std::declval<std::conditional_t<is_eto_eligible_v<Get>, std::tuple<>, std::tuple<Get>>>()...
- ));
- using pointer = void;
- using reference = decltype(std::tuple_cat(
- std::declval<std::tuple<Entity>>(),
- std::declval<std::conditional_t<is_eto_eligible_v<Owned>, std::tuple<>, std::tuple<Owned &>>>()...,
- std::declval<std::conditional_t<is_eto_eligible_v<Get>, std::tuple<>, std::tuple<Get &>>>()...
- ));
- using iterator_category = std::input_iterator_tag;
- proxy_iterator & operator++() ENTT_NOEXCEPT {
- return ++it, std::apply([](auto &&... curr) { (++curr, ...); }, owned), *this;
- }
- proxy_iterator operator++(int) ENTT_NOEXCEPT {
- proxy_iterator orig = *this;
- return ++(*this), orig;
- }
- [[nodiscard]] reference operator*() const ENTT_NOEXCEPT {
- return std::tuple_cat(
- std::make_tuple(*it),
- std::apply([](auto &&... curr) { return std::forward_as_tuple(*curr...); }, owned),
- std::apply([entt = *it](auto &&... curr) { return std::forward_as_tuple(curr->get(entt)...); }, get)
- );
- }
- [[nodiscard]] bool operator==(const proxy_iterator &other) const ENTT_NOEXCEPT {
- return other.it == it;
- }
- [[nodiscard]] bool operator!=(const proxy_iterator &other) const ENTT_NOEXCEPT {
- return !(*this == other);
- }
- private:
- it_type it{};
- owned_type owned{};
- get_type get{};
- };
- group_proxy(std::tuple<pool_type<Owned> *..., pool_type<Get> *...> cpools, const std::size_t &extent)
- : pools{cpools},
- length{&extent}
- {}
- public:
- using iterator = proxy_iterator;
- [[nodiscard]] iterator begin() const ENTT_NOEXCEPT {
- return proxy_iterator{
- std::get<0>(pools)->sparse_set<Entity>::end() - *length,
- std::tuple_cat([length = *length](auto *cpool) {
- if constexpr(is_eto_eligible_v<typename std::decay_t<decltype(*cpool)>::object_type>) {
- return std::make_tuple();
- } else {
- return std::make_tuple(cpool->end() - length);
- }
- }(std::get<pool_type<Owned> *>(pools))...),
- std::tuple_cat([](auto *cpool) {
- if constexpr(is_eto_eligible_v<typename std::decay_t<decltype(*cpool)>::object_type>) {
- return std::make_tuple();
- } else {
- return std::make_tuple(cpool);
- }
- }(std::get<pool_type<Get> *>(pools))...)
- };
- }
- [[nodiscard]] iterator end() const ENTT_NOEXCEPT {
- return proxy_iterator{
- std::get<0>(pools)->sparse_set<Entity>::end(),
- std::tuple_cat([](auto *cpool) {
- if constexpr(is_eto_eligible_v<typename std::decay_t<decltype(*cpool)>::object_type>) {
- return std::make_tuple();
- } else {
- return std::make_tuple(cpool->end());
- }
- }(std::get<pool_type<Owned> *>(pools))...),
- std::tuple_cat([](auto *cpool) {
- if constexpr(is_eto_eligible_v<typename std::decay_t<decltype(*cpool)>::object_type>) {
- return std::make_tuple();
- } else {
- return std::make_tuple(cpool);
- }
- }(std::get<pool_type<Get> *>(pools))...)
- };
- }
- private:
- const std::tuple<pool_type<Owned> *..., pool_type<Get> *...> pools;
- const std::size_t *length;
- };
- basic_group(const std::size_t &extent, pool_type<Owned> &... opool, pool_type<Get> &... gpool) ENTT_NOEXCEPT
- : pools{&opool..., &gpool...},
- length{&extent}
- {}
- template<typename Func, typename... Strong, typename... Weak>
- void traverse(Func func, type_list<Strong...>, type_list<Weak...>) const {
- [[maybe_unused]] auto it = std::make_tuple((std::get<pool_type<Strong> *>(pools)->end() - *length)...);
- [[maybe_unused]] auto data = std::get<0>(pools)->sparse_set<entity_type>::end() - *length;
- for(auto next = *length; next; --next) {
- if constexpr(std::is_invocable_v<Func, decltype(get<Strong>({}))..., decltype(get<Weak>({}))...>) {
- if constexpr(sizeof...(Weak) == 0) {
- func(*(std::get<component_iterator<Strong>>(it)++)...);
- } else {
- const auto entt = *(data++);
- func(*(std::get<component_iterator<Strong>>(it)++)..., std::get<pool_type<Weak> *>(pools)->get(entt)...);
- }
- } else {
- const auto entt = *(data++);
- func(entt, *(std::get<component_iterator<Strong>>(it)++)..., std::get<pool_type<Weak> *>(pools)->get(entt)...);
- }
- }
- }
- public:
- /*! @brief Underlying entity identifier. */
- using entity_type = Entity;
- /*! @brief Unsigned integer type. */
- using size_type = std::size_t;
- /*! @brief Random access iterator type. */
- using iterator = typename sparse_set<Entity>::iterator;
- /*! @brief Reversed iterator type. */
- using reverse_iterator = typename sparse_set<Entity>::reverse_iterator;
- /**
- * @brief Returns the number of existing components of the given type.
- * @tparam Component Type of component of which to return the size.
- * @return Number of existing components of the given type.
- */
- template<typename Component>
- [[nodiscard]] size_type size() const ENTT_NOEXCEPT {
- return std::get<pool_type<Component> *>(pools)->size();
- }
- /**
- * @brief Returns the number of entities that have the given components.
- * @return Number of entities that have the given components.
- */
- [[nodiscard]] size_type size() const ENTT_NOEXCEPT {
- return *length;
- }
- /**
- * @brief Checks whether a group or some pools are empty.
- * @tparam Component Types of components in which one is interested.
- * @return True if the group or the pools are empty, false otherwise.
- */
- template<typename... Component>
- [[nodiscard]] bool empty() const ENTT_NOEXCEPT {
- if constexpr(sizeof...(Component) == 0) {
- return !*length;
- } else {
- return (std::get<pool_type<Component> *>(pools)->empty() && ...);
- }
- }
- /**
- * @brief Direct access to the list of components of a given pool.
- *
- * The returned pointer is such that range
- * `[raw<Component>(), raw<Component>() + size<Component>()]` is always a
- * valid range, even if the container is empty.<br/>
- * Moreover, in case the group owns the given component, the range
- * `[raw<Component>(), raw<Component>() + size()]` is such that it contains
- * the instances that are part of the group itself.
- *
- * @note
- * Components are in the reverse order as returned by the `begin`/`end`
- * iterators.
- *
- * @tparam Component Type of component in which one is interested.
- * @return A pointer to the array of components.
- */
- template<typename Component>
- [[nodiscard]] Component * raw() const ENTT_NOEXCEPT {
- return std::get<pool_type<Component> *>(pools)->raw();
- }
- /**
- * @brief Direct access to the list of entities of a given pool.
- *
- * The returned pointer is such that range
- * `[data<Component>(), data<Component>() + size<Component>()]` is always a
- * valid range, even if the container is empty.<br/>
- * Moreover, in case the group owns the given component, the range
- * `[data<Component>(), data<Component>() + size()]` is such that it
- * contains the entities that are part of the group itself.
- *
- * @note
- * Entities are in the reverse order as returned by the `begin`/`end`
- * iterators.
- *
- * @tparam Component Type of component in which one is interested.
- * @return A pointer to the array of entities.
- */
- template<typename Component>
- [[nodiscard]] const entity_type * data() const ENTT_NOEXCEPT {
- return std::get<pool_type<Component> *>(pools)->data();
- }
- /**
- * @brief Direct access to the list of entities.
- *
- * The returned pointer is such that range `[data(), data() + size()]` is
- * always a valid range, even if the container is empty.
- *
- * @note
- * Entities are in the reverse order as returned by the `begin`/`end`
- * iterators.
- *
- * @return A pointer to the array of entities.
- */
- [[nodiscard]] const entity_type * data() const ENTT_NOEXCEPT {
- return std::get<0>(pools)->data();
- }
- /**
- * @brief Returns an iterator to the first entity of the group.
- *
- * The returned iterator points to the first entity of the group. If the
- * group is empty, the returned iterator will be equal to `end()`.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the first entity of the group.
- */
- [[nodiscard]] iterator begin() const ENTT_NOEXCEPT {
- return std::get<0>(pools)->sparse_set<entity_type>::end() - *length;
- }
- /**
- * @brief Returns an iterator that is past the last entity of the group.
- *
- * The returned iterator points to the entity following the last entity of
- * the group. Attempting to dereference the returned iterator results in
- * undefined behavior.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the entity following the last entity of the
- * group.
- */
- [[nodiscard]] iterator end() const ENTT_NOEXCEPT {
- return std::get<0>(pools)->sparse_set<entity_type>::end();
- }
- /**
- * @brief Returns an iterator to the first entity of the reversed group.
- *
- * The returned iterator points to the first entity of the reversed group.
- * If the group is empty, the returned iterator will be equal to `rend()`.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the first entity of the reversed group.
- */
- [[nodiscard]] reverse_iterator rbegin() const ENTT_NOEXCEPT {
- return std::get<0>(pools)->sparse_set<entity_type>::rbegin();
- }
- /**
- * @brief Returns an iterator that is past the last entity of the reversed
- * group.
- *
- * The returned iterator points to the entity following the last entity of
- * the reversed group. Attempting to dereference the returned iterator
- * results in undefined behavior.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the entity following the last entity of the
- * reversed group.
- */
- [[nodiscard]] reverse_iterator rend() const ENTT_NOEXCEPT {
- return std::get<0>(pools)->sparse_set<entity_type>::rbegin() + *length;
- }
- /**
- * @brief Returns the first entity of the group, if any.
- * @return The first entity of the group if one exists, the null entity
- * otherwise.
- */
- [[nodiscard]] entity_type front() const {
- const auto it = begin();
- return it != end() ? *it : null;
- }
- /**
- * @brief Returns the last entity of the group, if any.
- * @return The last entity of the group if one exists, the null entity
- * otherwise.
- */
- [[nodiscard]] entity_type back() const {
- const auto it = rbegin();
- return it != rend() ? *it : null;
- }
- /**
- * @brief Finds an entity.
- * @param entt A valid entity identifier.
- * @return An iterator to the given entity if it's found, past the end
- * iterator otherwise.
- */
- [[nodiscard]] iterator find(const entity_type entt) const {
- const auto it = std::get<0>(pools)->find(entt);
- return it != end() && it >= begin() && *it == entt ? it : end();
- }
- /**
- * @brief Returns the identifier that occupies the given position.
- * @param pos Position of the element to return.
- * @return The identifier that occupies the given position.
- */
- [[nodiscard]] entity_type operator[](const size_type pos) const {
- return begin()[pos];
- }
- /**
- * @brief Checks if a group contains an entity.
- * @param entt A valid entity identifier.
- * @return True if the group contains the given entity, false otherwise.
- */
- [[nodiscard]] bool contains(const entity_type entt) const {
- return std::get<0>(pools)->contains(entt) && (std::get<0>(pools)->index(entt) < (*length));
- }
- /**
- * @brief Returns the components assigned to the given entity.
- *
- * Prefer this function instead of `registry::get` during iterations. It has
- * far better performance than its counterpart.
- *
- * @warning
- * Attempting to use an invalid component type results in a compilation
- * error. Attempting to use an entity that doesn't belong to the group
- * results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * group doesn't contain the given entity.
- *
- * @tparam Component Types of components to get.
- * @param entt A valid entity identifier.
- * @return The components assigned to the entity.
- */
- template<typename... Component>
- [[nodiscard]] decltype(auto) get([[maybe_unused]] const entity_type entt) const {
- ENTT_ASSERT(contains(entt));
- if constexpr(sizeof...(Component) == 1) {
- return (std::get<pool_type<Component> *>(pools)->get(entt), ...);
- } else {
- return std::tuple<decltype(get<Component>({}))...>{get<Component>(entt)...};
- }
- }
- /**
- * @brief Iterates entities and components and applies the given function
- * object to them.
- *
- * The function object is invoked for each entity. It is provided with the
- * entity itself and a set of references to non-empty components. The
- * _constness_ of the components is as requested.<br/>
- * The signature of the function must be equivalent to one of the following
- * forms:
- *
- * @code{.cpp}
- * void(const entity_type, Type &...);
- * void(Type &...);
- * @endcode
- *
- * @note
- * Empty types aren't explicitly instantiated and therefore they are never
- * returned during iterations.
- *
- * @tparam Func Type of the function object to invoke.
- * @param func A valid function object.
- */
- template<typename Func>
- void each(Func func) const {
- using owned_type_list = type_list_cat_t<std::conditional_t<is_eto_eligible_v<Owned>, type_list<>, type_list<Owned>>...>;
- using get_type_list = type_list_cat_t<std::conditional_t<is_eto_eligible_v<Get>, type_list<>, type_list<Get>>...>;
- traverse(std::move(func), owned_type_list{}, get_type_list{});
- }
- /**
- * @brief Returns an iterable object to use to _visit_ the group.
- *
- * The iterable object returns tuples that contain the current entity and a
- * set of references to its non-empty components. The _constness_ of the
- * components is as requested.
- *
- * @note
- * Empty types aren't explicitly instantiated and therefore they are never
- * returned during iterations.
- *
- * @return An iterable object to use to _visit_ the group.
- */
- [[nodiscard]] auto proxy() const ENTT_NOEXCEPT {
- return group_proxy{pools, *length};
- }
- /**
- * @brief Sort a group according to the given comparison function.
- *
- * Sort the group so that iterating it with a couple of iterators returns
- * entities and components in the expected order. See `begin` and `end` for
- * more details.
- *
- * The comparison function object must return `true` if the first element
- * is _less_ than the second one, `false` otherwise. The signature of the
- * comparison function should be equivalent to one of the following:
- *
- * @code{.cpp}
- * bool(std::tuple<Component &...>, std::tuple<Component &...>);
- * bool(const Component &, const Component &);
- * bool(const Entity, const Entity);
- * @endcode
- *
- * Where `Component` are either owned types or not but still such that they
- * are iterated by the group.<br/>
- * Moreover, the comparison function object shall induce a
- * _strict weak ordering_ on the values.
- *
- * The sort function oject must offer a member function template
- * `operator()` that accepts three arguments:
- *
- * * An iterator to the first element of the range to sort.
- * * An iterator past the last element of the range to sort.
- * * A comparison function to use to compare the elements.
- *
- * @tparam Component Optional types of components to compare.
- * @tparam Compare Type of comparison function object.
- * @tparam Sort Type of sort function object.
- * @tparam Args Types of arguments to forward to the sort function object.
- * @param compare A valid comparison function object.
- * @param algo A valid sort function object.
- * @param args Arguments to forward to the sort function object, if any.
- */
- template<typename... Component, typename Compare, typename Sort = std_sort, typename... Args>
- void sort(Compare compare, Sort algo = Sort{}, Args &&... args) {
- auto *cpool = std::get<0>(pools);
- if constexpr(sizeof...(Component) == 0) {
- static_assert(std::is_invocable_v<Compare, const entity_type, const entity_type>, "Invalid comparison function");
- cpool->sort(cpool->end()-*length, cpool->end(), std::move(compare), std::move(algo), std::forward<Args>(args)...);
- } else if constexpr(sizeof...(Component) == 1) {
- cpool->sort(cpool->end()-*length, cpool->end(), [this, compare = std::move(compare)](const entity_type lhs, const entity_type rhs) {
- return compare((std::get<pool_type<Component> *>(pools)->get(lhs), ...), (std::get<pool_type<Component> *>(pools)->get(rhs), ...));
- }, std::move(algo), std::forward<Args>(args)...);
- } else {
- cpool->sort(cpool->end()-*length, cpool->end(), [this, compare = std::move(compare)](const entity_type lhs, const entity_type rhs) {
- return compare(std::tuple<decltype(get<Component>({}))...>{std::get<pool_type<Component> *>(pools)->get(lhs)...}, std::tuple<decltype(get<Component>({}))...>{std::get<pool_type<Component> *>(pools)->get(rhs)...});
- }, std::move(algo), std::forward<Args>(args)...);
- }
- [this](auto *head, auto *... other) {
- for(auto next = *length; next; --next) {
- const auto pos = next - 1;
- [[maybe_unused]] const auto entt = head->data()[pos];
- (other->swap(other->data()[pos], entt), ...);
- }
- }(std::get<pool_type<Owned> *>(pools)...);
- }
- private:
- const std::tuple<pool_type<Owned> *..., pool_type<Get> *...> pools;
- const size_type *length;
- };
- }
- #endif
- // #include "runtime_view.hpp"
- #ifndef ENTT_ENTITY_RUNTIME_VIEW_HPP
- #define ENTT_ENTITY_RUNTIME_VIEW_HPP
- #include <iterator>
- #include <vector>
- #include <utility>
- #include <algorithm>
- #include <type_traits>
- // #include "../config/config.h"
- // #include "sparse_set.hpp"
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @brief Runtime view.
- *
- * Runtime views iterate over those entities that have at least all the given
- * components in their bags. During initialization, a runtime view looks at the
- * number of entities available for each component and picks up a reference to
- * the smallest set of candidate entities in order to get a performance boost
- * when iterate.<br/>
- * Order of elements during iterations are highly dependent on the order of the
- * underlying data structures. See sparse_set and its specializations for more
- * details.
- *
- * @b Important
- *
- * Iterators aren't invalidated if:
- *
- * * New instances of the given components are created and assigned to entities.
- * * The entity currently pointed is modified (as an example, if one of the
- * given components is removed from the entity to which the iterator points).
- * * The entity currently pointed is destroyed.
- *
- * In all the other cases, modifying the pools of the given components in any
- * way invalidates all the iterators and using them results in undefined
- * behavior.
- *
- * @note
- * Views share references to the underlying data structures of the registry that
- * generated them. Therefore any change to the entities and to the components
- * made by means of the registry are immediately reflected by the views, unless
- * a pool was missing when the view was built (in this case, the view won't
- * have a valid reference and won't be updated accordingly).
- *
- * @warning
- * Lifetime of a view must not overcome that of the registry that generated it.
- * In any other case, attempting to use a view results in undefined behavior.
- *
- * @tparam Entity A valid entity type (see entt_traits for more details).
- */
- template<typename Entity>
- class basic_runtime_view {
- /*! @brief A registry is allowed to create views. */
- friend class basic_registry<Entity>;
- using underlying_iterator = typename sparse_set<Entity>::iterator;
- class view_iterator final {
- friend class basic_runtime_view<Entity>;
- view_iterator(const std::vector<const sparse_set<Entity> *> &cpools, const std::vector<const sparse_set<Entity> *> &ignore, underlying_iterator curr) ENTT_NOEXCEPT
- : pools{&cpools},
- filter{&ignore},
- it{curr}
- {
- if(it != (*pools)[0]->end() && !valid()) {
- ++(*this);
- }
- }
- [[nodiscard]] bool valid() const {
- return std::all_of(pools->begin()++, pools->end(), [entt = *it](const auto *curr) { return curr->contains(entt); })
- && std::none_of(filter->cbegin(), filter->cend(), [entt = *it](const auto *curr) { return curr && curr->contains(entt); });
- }
- public:
- using difference_type = typename underlying_iterator::difference_type;
- using value_type = typename underlying_iterator::value_type;
- using pointer = typename underlying_iterator::pointer;
- using reference = typename underlying_iterator::reference;
- using iterator_category = std::bidirectional_iterator_tag;
- view_iterator() ENTT_NOEXCEPT = default;
- view_iterator & operator++() {
- while(++it != (*pools)[0]->end() && !valid());
- return *this;
- }
- view_iterator operator++(int) {
- view_iterator orig = *this;
- return ++(*this), orig;
- }
- view_iterator & operator--() ENTT_NOEXCEPT {
- while(--it != (*pools)[0]->begin() && !valid());
- return *this;
- }
- view_iterator operator--(int) ENTT_NOEXCEPT {
- view_iterator orig = *this;
- return operator--(), orig;
- }
- [[nodiscard]] bool operator==(const view_iterator &other) const ENTT_NOEXCEPT {
- return other.it == it;
- }
- [[nodiscard]] bool operator!=(const view_iterator &other) const ENTT_NOEXCEPT {
- return !(*this == other);
- }
- [[nodiscard]] pointer operator->() const {
- return it.operator->();
- }
- [[nodiscard]] reference operator*() const {
- return *operator->();
- }
- private:
- const std::vector<const sparse_set<Entity> *> *pools;
- const std::vector<const sparse_set<Entity> *> *filter;
- underlying_iterator it;
- };
- basic_runtime_view(std::vector<const sparse_set<Entity> *> cpools, std::vector<const sparse_set<Entity> *> epools) ENTT_NOEXCEPT
- : pools{std::move(cpools)},
- filter{std::move(epools)}
- {
- const auto it = std::min_element(pools.begin(), pools.end(), [](const auto *lhs, const auto *rhs) {
- return (!lhs && rhs) || (lhs && rhs && lhs->size() < rhs->size());
- });
- // brings the best candidate (if any) on front of the vector
- std::rotate(pools.begin(), it, pools.end());
- }
- [[nodiscard]] bool valid() const {
- return !pools.empty() && pools.front();
- }
- public:
- /*! @brief Underlying entity identifier. */
- using entity_type = Entity;
- /*! @brief Unsigned integer type. */
- using size_type = std::size_t;
- /*! @brief Bidirectional iterator type. */
- using iterator = view_iterator;
- /**
- * @brief Estimates the number of entities that have the given components.
- * @return Estimated number of entities that have the given components.
- */
- [[nodiscard]] size_type size() const {
- return valid() ? pools.front()->size() : size_type{};
- }
- /**
- * @brief Checks if the view is definitely empty.
- * @return True if the view is definitely empty, false otherwise.
- */
- [[nodiscard]] bool empty() const {
- return !valid() || pools.front()->empty();
- }
- /**
- * @brief Returns an iterator to the first entity that has the given
- * components.
- *
- * The returned iterator points to the first entity that has the given
- * components. If the view is empty, the returned iterator will be equal to
- * `end()`.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the first entity that has the given components.
- */
- [[nodiscard]] iterator begin() const {
- return valid() ? iterator{pools, filter, pools[0]->begin()} : iterator{};
- }
- /**
- * @brief Returns an iterator that is past the last entity that has the
- * given components.
- *
- * The returned iterator points to the entity following the last entity that
- * has the given components. Attempting to dereference the returned iterator
- * results in undefined behavior.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the entity following the last entity that has the
- * given components.
- */
- [[nodiscard]] iterator end() const {
- return valid() ? iterator{pools, filter, pools[0]->end()} : iterator{};
- }
- /**
- * @brief Checks if a view contains an entity.
- * @param entt A valid entity identifier.
- * @return True if the view contains the given entity, false otherwise.
- */
- [[nodiscard]] bool contains(const entity_type entt) const {
- return valid() && std::all_of(pools.cbegin(), pools.cend(), [entt](const auto *curr) { return curr->contains(entt); })
- && std::none_of(filter.cbegin(), filter.cend(), [entt](const auto *curr) { return curr && curr->contains(entt); });
- }
- /**
- * @brief Iterates entities and applies the given function object to them.
- *
- * The function object is invoked for each entity. It is provided only with
- * the entity itself. To get the components, users can use the registry with
- * which the view was built.<br/>
- * The signature of the function should be equivalent to the following:
- *
- * @code{.cpp}
- * void(const entity_type);
- * @endcode
- *
- * @tparam Func Type of the function object to invoke.
- * @param func A valid function object.
- */
- template<typename Func>
- void each(Func func) const {
- for(const auto entity: *this) {
- func(entity);
- }
- }
- private:
- std::vector<const sparse_set<Entity> *> pools;
- std::vector<const sparse_set<Entity> *> filter;
- };
- }
- #endif
- // #include "sparse_set.hpp"
- // #include "storage.hpp"
- // #include "utility.hpp"
- // #include "view.hpp"
- #ifndef ENTT_ENTITY_VIEW_HPP
- #define ENTT_ENTITY_VIEW_HPP
- #include <iterator>
- #include <array>
- #include <tuple>
- #include <utility>
- #include <algorithm>
- #include <type_traits>
- // #include "../config/config.h"
- // #include "../core/type_traits.hpp"
- // #include "entity.hpp"
- // #include "fwd.hpp"
- // #include "pool.hpp"
- // #include "sparse_set.hpp"
- // #include "utility.hpp"
- namespace entt {
- /**
- * @brief View.
- *
- * Primary template isn't defined on purpose. All the specializations give a
- * compile-time error, but for a few reasonable cases.
- */
- template<typename...>
- class basic_view;
- /**
- * @brief Multi component view.
- *
- * Multi component views iterate over those entities that have at least all the
- * given components in their bags. During initialization, a multi component view
- * looks at the number of entities available for each component and uses the
- * smallest set in order to get a performance boost when iterate.
- *
- * @b Important
- *
- * Iterators aren't invalidated if:
- *
- * * New instances of the given components are created and assigned to entities.
- * * The entity currently pointed is modified (as an example, if one of the
- * given components is removed from the entity to which the iterator points).
- * * The entity currently pointed is destroyed.
- *
- * In all other cases, modifying the pools iterated by the view in any way
- * invalidates all the iterators and using them results in undefined behavior.
- *
- * @note
- * Views share references to the underlying data structures of the registry that
- * generated them. Therefore any change to the entities and to the components
- * made by means of the registry are immediately reflected by views.
- *
- * @warning
- * Lifetime of a view must not overcome that of the registry that generated it.
- * In any other case, attempting to use a view results in undefined behavior.
- *
- * @tparam Entity A valid entity type (see entt_traits for more details).
- * @tparam Exclude Types of components used to filter the view.
- * @tparam Component Types of components iterated by the view.
- */
- template<typename Entity, typename... Exclude, typename... Component>
- class basic_view<Entity, exclude_t<Exclude...>, Component...> {
- /*! @brief A registry is allowed to create views. */
- friend class basic_registry<Entity>;
- template<typename Comp>
- using pool_type = pool_t<Entity, Comp>;
- template<typename Comp>
- using component_iterator = decltype(std::declval<pool_type<Comp>>().begin());
- using unchecked_type = std::array<const sparse_set<Entity> *, (sizeof...(Component) - 1)>;
- using filter_type = std::array<const sparse_set<Entity> *, sizeof...(Exclude)>;
- template<typename It>
- class view_iterator final {
- friend class basic_view<Entity, exclude_t<Exclude...>, Component...>;
- view_iterator(It from, It to, It curr, unchecked_type other, filter_type ignore) ENTT_NOEXCEPT
- : first{from},
- last{to},
- it{curr},
- unchecked{other},
- filter{ignore}
- {
- if(it != last && !valid()) {
- ++(*this);
- }
- }
- [[nodiscard]] bool valid() const {
- return std::all_of(unchecked.cbegin(), unchecked.cend(), [entt = *it](const sparse_set<Entity> *curr) { return curr->contains(entt); })
- && (sizeof...(Exclude) == 0 || std::none_of(filter.cbegin(), filter.cend(), [entt = *it](const sparse_set<Entity> *cpool) { return cpool->contains(entt); }));
- }
- public:
- using difference_type = typename std::iterator_traits<It>::difference_type;
- using value_type = typename std::iterator_traits<It>::value_type;
- using pointer = typename std::iterator_traits<It>::pointer;
- using reference = typename std::iterator_traits<It>::reference;
- using iterator_category = std::bidirectional_iterator_tag;
- view_iterator() ENTT_NOEXCEPT = default;
- view_iterator & operator++() {
- while(++it != last && !valid());
- return *this;
- }
- view_iterator operator++(int) {
- view_iterator orig = *this;
- return ++(*this), orig;
- }
- view_iterator & operator--() ENTT_NOEXCEPT {
- while(--it != first && !valid());
- return *this;
- }
- view_iterator operator--(int) ENTT_NOEXCEPT {
- view_iterator orig = *this;
- return operator--(), orig;
- }
- [[nodiscard]] bool operator==(const view_iterator &other) const ENTT_NOEXCEPT {
- return other.it == it;
- }
- [[nodiscard]] bool operator!=(const view_iterator &other) const ENTT_NOEXCEPT {
- return !(*this == other);
- }
- [[nodiscard]] pointer operator->() const {
- return &*it;
- }
- [[nodiscard]] reference operator*() const {
- return *operator->();
- }
- private:
- It first;
- It last;
- It it;
- unchecked_type unchecked;
- filter_type filter;
- };
- class view_proxy {
- friend class basic_view<Entity, exclude_t<Exclude...>, Component...>;
- using proxy_view_iterator = view_iterator<typename sparse_set<Entity>::iterator>;
- class proxy_iterator {
- friend class view_proxy;
- using ref_type = decltype(std::tuple_cat(std::declval<std::conditional_t<is_eto_eligible_v<Component>, std::tuple<>, std::tuple<pool_type<Component> *>>>()...));
- proxy_iterator(proxy_view_iterator from, ref_type ref) ENTT_NOEXCEPT
- : it{from},
- pools{ref}
- {}
- public:
- using difference_type = std::ptrdiff_t;
- using value_type = decltype(std::tuple_cat(
- std::declval<std::tuple<Entity>>(),
- std::declval<std::conditional_t<is_eto_eligible_v<Component>, std::tuple<>, std::tuple<Component>>>()...
- ));
- using pointer = void;
- using reference = decltype(std::tuple_cat(
- std::declval<std::tuple<Entity>>(),
- std::declval<std::conditional_t<is_eto_eligible_v<Component>, std::tuple<>, std::tuple<Component &>>>()...
- ));
- using iterator_category = std::input_iterator_tag;
- proxy_iterator & operator++() ENTT_NOEXCEPT {
- return ++it, *this;
- }
- proxy_iterator operator++(int) ENTT_NOEXCEPT {
- proxy_iterator orig = *this;
- return ++(*this), orig;
- }
- [[nodiscard]] reference operator*() const ENTT_NOEXCEPT {
- return std::apply([entt = *it](auto *... cpool) { return reference{entt, cpool->get(entt)...}; }, pools);
- }
- [[nodiscard]] bool operator==(const proxy_iterator &other) const ENTT_NOEXCEPT {
- return other.it == it;
- }
- [[nodiscard]] bool operator!=(const proxy_iterator &other) const ENTT_NOEXCEPT {
- return !(*this == other);
- }
- private:
- proxy_view_iterator it{};
- const ref_type pools{};
- };
- view_proxy(proxy_view_iterator from, proxy_view_iterator to, std::tuple<pool_type<Component> *...> ref)
- : first{from},
- last{to},
- pools{ref}
- {}
- public:
- using iterator = proxy_iterator;
- [[nodiscard]] iterator begin() const ENTT_NOEXCEPT {
- return proxy_iterator{first, std::tuple_cat([](auto *cpool) {
- if constexpr(is_eto_eligible_v<typename std::decay_t<decltype(*cpool)>::object_type>) {
- return std::make_tuple();
- } else {
- return std::make_tuple(cpool);
- }
- }(std::get<pool_type<Component> *>(pools))...)};
- }
- [[nodiscard]] iterator end() const ENTT_NOEXCEPT {
- return proxy_iterator{last, std::tuple_cat([](auto *cpool) {
- if constexpr(is_eto_eligible_v<typename std::decay_t<decltype(*cpool)>::object_type>) {
- return std::make_tuple();
- } else {
- return std::make_tuple(cpool);
- }
- }(std::get<pool_type<Component> *>(pools))...)};
- }
- private:
- proxy_view_iterator first;
- proxy_view_iterator last;
- const std::tuple<pool_type<Component> *...> pools;
- };
- basic_view(pool_type<Component> &... component, unpack_as_t<const sparse_set<Entity>, Exclude> &... epool) ENTT_NOEXCEPT
- : pools{&component...},
- view{candidate()},
- filter{&epool...}
- {}
- [[nodiscard]] const sparse_set<Entity> * candidate() const ENTT_NOEXCEPT {
- return (std::min)({ static_cast<const sparse_set<Entity> *>(std::get<pool_type<Component> *>(pools))... }, [](const auto *lhs, const auto *rhs) {
- return lhs->size() < rhs->size();
- });
- }
- [[nodiscard]] unchecked_type unchecked(const sparse_set<Entity> *cpool) const {
- std::size_t pos{};
- unchecked_type other{};
- ((std::get<pool_type<Component> *>(pools) == cpool ? nullptr : (other[pos] = std::get<pool_type<Component> *>(pools), other[pos++])), ...);
- return other;
- }
- template<typename Comp, typename Other>
- [[nodiscard]] decltype(auto) get([[maybe_unused]] component_iterator<Comp> &it, [[maybe_unused]] pool_type<Other> *cpool, [[maybe_unused]] const Entity entt) const {
- if constexpr(std::is_same_v<Comp, Other>) {
- return *it;
- } else {
- return cpool->get(entt);
- }
- }
- template<typename Comp, typename Func, typename... Type>
- void traverse(Func func, type_list<Type...>) const {
- if constexpr(std::disjunction_v<std::is_same<Comp, Type>...>) {
- auto it = std::get<pool_type<Comp> *>(pools)->begin();
- for(const auto entt: static_cast<const sparse_set<entity_type> &>(*std::get<pool_type<Comp> *>(pools))) {
- if(((std::is_same_v<Comp, Component> || std::get<pool_type<Component> *>(pools)->contains(entt)) && ...)
- && (sizeof...(Exclude) == 0 || std::none_of(filter.cbegin(), filter.cend(), [entt](const sparse_set<Entity> *cpool) { return cpool->contains(entt); })))
- {
- if constexpr(std::is_invocable_v<Func, decltype(get<Type>({}))...>) {
- func(get<Comp, Type>(it, std::get<pool_type<Type> *>(pools), entt)...);
- } else {
- func(entt, get<Comp, Type>(it, std::get<pool_type<Type> *>(pools), entt)...);
- }
- }
- ++it;
- }
- } else {
- for(const auto entt: static_cast<const sparse_set<entity_type> &>(*std::get<pool_type<Comp> *>(pools))) {
- if(((std::is_same_v<Comp, Component> || std::get<pool_type<Component> *>(pools)->contains(entt)) && ...)
- && (sizeof...(Exclude) == 0 || std::none_of(filter.cbegin(), filter.cend(), [entt](const sparse_set<Entity> *cpool) { return cpool->contains(entt); })))
- {
- if constexpr(std::is_invocable_v<Func, decltype(get<Type>({}))...>) {
- func(std::get<pool_type<Type> *>(pools)->get(entt)...);
- } else {
- func(entt, std::get<pool_type<Type> *>(pools)->get(entt)...);
- }
- }
- }
- }
- }
- template<typename Func, typename... Type>
- void iterate(Func func, type_list<Type...>) const {
- const auto last = view->data() + view->size();
- auto first = view->data();
- while(first != last) {
- if((std::get<pool_type<Component> *>(pools)->contains(*first) && ...)
- && (sizeof...(Exclude) == 0 || std::none_of(filter.cbegin(), filter.cend(), [entt = *first](const sparse_set<Entity> *cpool) { return cpool->contains(entt); })))
- {
- const auto base = *(first++);
- const auto chunk = (std::min)({ (std::get<pool_type<Component> *>(pools)->size() - std::get<pool_type<Component> *>(pools)->index(base))... });
- size_type length{};
- for(++length;
- length < chunk
- && ((*(std::get<pool_type<Component> *>(pools)->data() + std::get<pool_type<Component> *>(pools)->index(base) + length) == *first) && ...)
- && (sizeof...(Exclude) == 0 || std::none_of(filter.cbegin(), filter.cend(), [entt = *first](const sparse_set<Entity> *cpool) { return cpool->contains(entt); }));
- ++length, ++first);
- func(view->data() + view->index(base), (std::get<pool_type<Type> *>(pools)->raw() + std::get<pool_type<Type> *>(pools)->index(base))..., length);
- } else {
- ++first;
- }
- }
- }
- public:
- /*! @brief Underlying entity identifier. */
- using entity_type = Entity;
- /*! @brief Unsigned integer type. */
- using size_type = std::size_t;
- /*! @brief Bidirectional iterator type. */
- using iterator = view_iterator<typename sparse_set<entity_type>::iterator>;
- /*! @brief Reverse iterator type. */
- using reverse_iterator = view_iterator<typename sparse_set<entity_type>::reverse_iterator>;
- /**
- * @brief Returns the number of existing components of the given type.
- *
- * This isn't the number of entities iterated by the view.
- *
- * @tparam Comp Type of component of which to return the size.
- * @return Number of existing components of the given type.
- */
- template<typename Comp>
- [[nodiscard]] size_type size() const ENTT_NOEXCEPT {
- return std::get<pool_type<Comp> *>(pools)->size();
- }
- /**
- * @brief Estimates the number of entities iterated by the view.
- * @return Estimated number of entities iterated by the view.
- */
- [[nodiscard]] size_type size() const ENTT_NOEXCEPT {
- return (std::min)({ std::get<pool_type<Component> *>(pools)->size()... });
- }
- /**
- * @brief Checks whether a view or some pools are empty.
- *
- * The view is definitely empty if one of the pools it uses is empty. In all
- * other cases, the view may be empty and not return entities even if this
- * function returns false.
- *
- * @tparam Comp Types of components in which one is interested.
- * @return True if the view or the pools are empty, false otherwise.
- */
- template<typename... Comp>
- [[nodiscard]] bool empty() const ENTT_NOEXCEPT {
- if constexpr(sizeof...(Comp) == 0) {
- return (std::get<pool_type<Component> *>(pools)->empty() || ...);
- } else {
- return (std::get<pool_type<Comp> *>(pools)->empty() && ...);
- }
- }
- /**
- * @brief Direct access to the list of components of a given pool.
- *
- * The returned pointer is such that range
- * `[raw<Comp>(), raw<Comp>() + size<Comp>()]` is always a valid range, even
- * if the container is empty.
- *
- * @note
- * Components are in the reverse order as returned by the `begin`/`end`
- * iterators.
- *
- * @tparam Comp Type of component in which one is interested.
- * @return A pointer to the array of components.
- */
- template<typename Comp>
- [[nodiscard]] Comp * raw() const ENTT_NOEXCEPT {
- return std::get<pool_type<Comp> *>(pools)->raw();
- }
- /**
- * @brief Direct access to the list of entities of a given pool.
- *
- * The returned pointer is such that range
- * `[data<Comp>(), data<Comp>() + size<Comp>()]` is always a valid range,
- * even if the container is empty.
- *
- * @note
- * Entities are in the reverse order as returned by the `begin`/`end`
- * iterators.
- *
- * @tparam Comp Type of component in which one is interested.
- * @return A pointer to the array of entities.
- */
- template<typename Comp>
- [[nodiscard]] const entity_type * data() const ENTT_NOEXCEPT {
- return std::get<pool_type<Comp> *>(pools)->data();
- }
- /**
- * @brief Returns an iterator to the first entity of the view.
- *
- * The returned iterator points to the first entity of the view. If the view
- * is empty, the returned iterator will be equal to `end()`.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the first entity of the view.
- */
- [[nodiscard]] iterator begin() const {
- return iterator{view->begin(), view->end(), view->begin(), unchecked(view), filter};
- }
- /**
- * @brief Returns an iterator that is past the last entity of the view.
- *
- * The returned iterator points to the entity following the last entity of
- * the view. Attempting to dereference the returned iterator results in
- * undefined behavior.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the entity following the last entity of the view.
- */
- [[nodiscard]] iterator end() const {
- return iterator{view->begin(), view->end(), view->end(), unchecked(view), filter};
- }
- /**
- * @brief Returns an iterator to the first entity of the reversed view.
- *
- * The returned iterator points to the first entity of the reversed view. If
- * the view is empty, the returned iterator will be equal to `rend()`.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the first entity of the reversed view.
- */
- [[nodiscard]] reverse_iterator rbegin() const {
- return reverse_iterator{view->rbegin(), view->rend(), view->rbegin(), unchecked(view), filter};
- }
- /**
- * @brief Returns an iterator that is past the last entity of the reversed
- * view.
- *
- * The returned iterator points to the entity following the last entity of
- * the reversed view. Attempting to dereference the returned iterator
- * results in undefined behavior.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the entity following the last entity of the
- * reversed view.
- */
- [[nodiscard]] reverse_iterator rend() const {
- return reverse_iterator{view->rbegin(), view->rend(), view->rend(), unchecked(view), filter};
- }
- /**
- * @brief Returns the first entity of the view, if any.
- * @return The first entity of the view if one exists, the null entity
- * otherwise.
- */
- [[nodiscard]] entity_type front() const {
- const auto it = begin();
- return it != end() ? *it : null;
- }
- /**
- * @brief Returns the last entity of the view, if any.
- * @return The last entity of the view if one exists, the null entity
- * otherwise.
- */
- [[nodiscard]] entity_type back() const {
- const auto it = rbegin();
- return it != rend() ? *it : null;
- }
- /**
- * @brief Finds an entity.
- * @param entt A valid entity identifier.
- * @return An iterator to the given entity if it's found, past the end
- * iterator otherwise.
- */
- [[nodiscard]] iterator find(const entity_type entt) const {
- iterator it{view->begin(), view->end(), view->find(entt), unchecked(view), filter};
- return (it != end() && *it == entt) ? it : end();
- }
- /**
- * @brief Checks if a view contains an entity.
- * @param entt A valid entity identifier.
- * @return True if the view contains the given entity, false otherwise.
- */
- [[nodiscard]] bool contains(const entity_type entt) const {
- return (std::get<pool_type<Component> *>(pools)->contains(entt) && ...)
- && (sizeof...(Exclude) == 0 || std::none_of(filter.begin(), filter.end(), [entt](const auto *cpool) { return cpool->contains(entt); }));
- }
- /**
- * @brief Returns the components assigned to the given entity.
- *
- * Prefer this function instead of `registry::get` during iterations. It has
- * far better performance than its counterpart.
- *
- * @warning
- * Attempting to use an invalid component type results in a compilation
- * error. Attempting to use an entity that doesn't belong to the view
- * results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * view doesn't contain the given entity.
- *
- * @tparam Comp Types of components to get.
- * @param entt A valid entity identifier.
- * @return The components assigned to the entity.
- */
- template<typename... Comp>
- [[nodiscard]] decltype(auto) get([[maybe_unused]] const entity_type entt) const {
- ENTT_ASSERT(contains(entt));
- if constexpr(sizeof...(Comp) == 0) {
- static_assert(sizeof...(Component) == 1, "Invalid component type");
- return (std::get<pool_type<Component> *>(pools)->get(entt), ...);
- } else if constexpr(sizeof...(Comp) == 1) {
- return (std::get<pool_type<Comp> *>(pools)->get(entt), ...);
- } else {
- return std::tuple<decltype(get<Comp>({}))...>{get<Comp>(entt)...};
- }
- }
- /**
- * @brief Iterates entities and components and applies the given function
- * object to them.
- *
- * The function object is invoked for each entity. It is provided with the
- * entity itself and a set of references to non-empty components. The
- * _constness_ of the components is as requested.<br/>
- * The signature of the function must be equivalent to one of the following
- * forms:
- *
- * @code{.cpp}
- * void(const entity_type, Type &...);
- * void(Type &...);
- * @endcode
- *
- * @note
- * Empty types aren't explicitly instantiated and therefore they are never
- * returned during iterations.
- *
- * @tparam Func Type of the function object to invoke.
- * @param func A valid function object.
- */
- template<typename Func>
- void each(Func func) const {
- view = candidate();
- ((std::get<pool_type<Component> *>(pools) == view ? each<Component>(std::move(func)) : void()), ...);
- }
- /**
- * @brief Iterates entities and components and applies the given function
- * object to them.
- *
- * The pool of the suggested component is used to lead the iterations. The
- * returned entities will therefore respect the order of the pool associated
- * with that type.<br/>
- * It is no longer guaranteed that the performance is the best possible, but
- * there will be greater control over the order of iteration.
- *
- * @sa each
- *
- * @tparam Comp Type of component to use to enforce the iteration order.
- * @tparam Func Type of the function object to invoke.
- * @param func A valid function object.
- */
- template<typename Comp, typename Func>
- void each(Func func) const {
- using non_empty_type = type_list_cat_t<std::conditional_t<is_eto_eligible_v<Component>, type_list<>, type_list<Component>>...>;
- traverse<Comp>(std::move(func), non_empty_type{});
- }
- /**
- * @brief Returns an iterable object to use to _visit_ the view.
- *
- * The iterable object returns tuples that contain the current entity and a
- * set of references to its non-empty components. The _constness_ of the
- * components is as requested.
- *
- * @note
- * Empty types aren't explicitly instantiated and therefore they are never
- * returned during iterations.
- *
- * @return An iterable object to use to _visit_ the view.
- */
- [[nodiscard]] auto proxy() const ENTT_NOEXCEPT {
- view = candidate();
- return view_proxy{begin(), end(), pools};
- }
- /**
- * @brief Returns an iterable object to use to _visit_ the view.
- *
- * The pool of the suggested component is used to lead the iterations. The
- * returned elements will therefore respect the order of the pool associated
- * with that type.<br/>
- * It is no longer guaranteed that the performance is the best possible, but
- * there will be greater control over the order of iteration.
- *
- * @sa each
- *
- * @tparam Comp Type of component to use to enforce the iteration order.
- * @return An iterable object to use to _visit_ the view.
- */
- template<typename Comp>
- [[nodiscard]] auto proxy() const ENTT_NOEXCEPT {
- const sparse_set<entity_type> *cpool = std::get<pool_type<Comp> *>(pools);
- iterator first{cpool->begin(), cpool->end(), cpool->begin(), unchecked(cpool), filter};
- iterator last{cpool->begin(), cpool->end(), cpool->end(), unchecked(cpool), filter};
- return view_proxy{std::move(first), std::move(last), pools};
- }
- /**
- * @brief Chunked iteration for entities and components
- *
- * Chunked iteration tries to spot chunks in the sets of entities and
- * components and return them one at a time along with their sizes.<br/>
- * This type of iteration is intended where it's known a priori that the
- * creation of entities and components takes place in chunk, which is
- * actually quite common. In this case, various optimizations can be applied
- * downstream to obtain even better performances from the views.
- *
- * The signature of the function must be equivalent to the following:
- *
- * @code{.cpp}
- * void(const entity_type *, Type *..., size_type);
- * @endcode
- *
- * The arguments are as follows:
- *
- * * A pointer to the entities belonging to the chunk.
- * * Pointers to the components associated with the returned entities.
- * * The length of the chunk.
- *
- * Note that the callback can be invoked 0 or more times and no guarantee is
- * given on the order of the elements.
- *
- * @note
- * Empty types aren't explicitly instantiated and therefore they are never
- * returned during iterations.
- *
- * @tparam Func Type of the function object to invoke.
- * @param func A valid function object.
- */
- template<typename Func>
- void chunked(Func func) const {
- using non_empty_type = type_list_cat_t<std::conditional_t<is_eto_eligible_v<Component>, type_list<>, type_list<Component>>...>;
- view = candidate();
- iterate(std::move(func), non_empty_type{});
- }
- private:
- const std::tuple<pool_type<Component> *...> pools;
- mutable const sparse_set<entity_type>* view;
- filter_type filter;
- };
- /**
- * @brief Single component view specialization.
- *
- * Single component views are specialized in order to get a boost in terms of
- * performance. This kind of views can access the underlying data structure
- * directly and avoid superfluous checks.
- *
- * @b Important
- *
- * Iterators aren't invalidated if:
- *
- * * New instances of the given component are created and assigned to entities.
- * * The entity currently pointed is modified (as an example, the given
- * component is removed from the entity to which the iterator points).
- * * The entity currently pointed is destroyed.
- *
- * In all other cases, modifying the pool iterated by the view in any way
- * invalidates all the iterators and using them results in undefined behavior.
- *
- * @note
- * Views share a reference to the underlying data structure of the registry that
- * generated them. Therefore any change to the entities and to the components
- * made by means of the registry are immediately reflected by views.
- *
- * @warning
- * Lifetime of a view must not overcome that of the registry that generated it.
- * In any other case, attempting to use a view results in undefined behavior.
- *
- * @tparam Entity A valid entity type (see entt_traits for more details).
- * @tparam Component Type of component iterated by the view.
- */
- template<typename Entity, typename Component>
- class basic_view<Entity, exclude_t<>, Component> {
- /*! @brief A registry is allowed to create views. */
- friend class basic_registry<Entity>;
- using pool_type = pool_t<Entity, Component>;
- class view_proxy {
- friend class basic_view<Entity, exclude_t<>, Component>;
- class proxy_iterator {
- friend class view_proxy;
- using it_type = std::conditional_t<
- is_eto_eligible_v<Component>,
- std::tuple<typename sparse_set<Entity>::iterator>,
- std::tuple<typename sparse_set<Entity>::iterator, decltype(std::declval<pool_type>().begin())>
- >;
- proxy_iterator(it_type from) ENTT_NOEXCEPT
- : it{from}
- {}
- public:
- using difference_type = std::ptrdiff_t;
- using value_type = std::conditional_t<is_eto_eligible_v<Component>, std::tuple<Entity>, std::tuple<Entity, Component>>;
- using pointer = void;
- using reference = std::conditional_t<is_eto_eligible_v<Component>, std::tuple<Entity>, std::tuple<Entity, Component &>>;
- using iterator_category = std::input_iterator_tag;
- proxy_iterator & operator++() ENTT_NOEXCEPT {
- return std::apply([](auto &&... curr) { (++curr, ...); }, it), *this;
- }
- proxy_iterator operator++(int) ENTT_NOEXCEPT {
- proxy_iterator orig = *this;
- return ++(*this), orig;
- }
- [[nodiscard]] reference operator*() const ENTT_NOEXCEPT {
- return std::apply([](auto &&... curr) { return reference{*curr...}; }, it);
- }
- [[nodiscard]] bool operator==(const proxy_iterator &other) const ENTT_NOEXCEPT {
- return std::get<0>(other.it) == std::get<0>(it);
- }
- [[nodiscard]] bool operator!=(const proxy_iterator &other) const ENTT_NOEXCEPT {
- return !(*this == other);
- }
- private:
- it_type it{};
- };
- view_proxy(pool_type &ref)
- : pool{&ref}
- {}
- public:
- using iterator = proxy_iterator;
- [[nodiscard]] iterator begin() const ENTT_NOEXCEPT {
- if constexpr(is_eto_eligible_v<Component>) {
- return proxy_iterator{std::make_tuple(pool->sparse_set<entity_type>::begin())};
- } else {
- return proxy_iterator{std::make_tuple(pool->sparse_set<entity_type>::begin(), pool->begin())};
- }
- }
- [[nodiscard]] iterator end() const ENTT_NOEXCEPT {
- if constexpr(is_eto_eligible_v<Component>) {
- return proxy_iterator{std::make_tuple(pool->sparse_set<entity_type>::end())};
- } else {
- return proxy_iterator{std::make_tuple(pool->sparse_set<entity_type>::end(), pool->end())};
- }
- }
- private:
- pool_type *pool;
- };
- basic_view(pool_type &ref) ENTT_NOEXCEPT
- : pool{&ref}
- {}
- public:
- /*! @brief Type of component iterated by the view. */
- using raw_type = Component;
- /*! @brief Underlying entity identifier. */
- using entity_type = Entity;
- /*! @brief Unsigned integer type. */
- using size_type = std::size_t;
- /*! @brief Random access iterator type. */
- using iterator = typename sparse_set<Entity>::iterator;
- /*! @brief Reversed iterator type. */
- using reverse_iterator = typename sparse_set<Entity>::reverse_iterator;
- /**
- * @brief Returns the number of entities that have the given component.
- * @return Number of entities that have the given component.
- */
- [[nodiscard]] size_type size() const ENTT_NOEXCEPT {
- return pool->size();
- }
- /**
- * @brief Checks whether a view is empty.
- * @return True if the view is empty, false otherwise.
- */
- [[nodiscard]] bool empty() const ENTT_NOEXCEPT {
- return pool->empty();
- }
- /**
- * @brief Direct access to the list of components.
- *
- * The returned pointer is such that range `[raw(), raw() + size()]` is
- * always a valid range, even if the container is empty.
- *
- * @note
- * Components are in the reverse order as returned by the `begin`/`end`
- * iterators.
- *
- * @return A pointer to the array of components.
- */
- [[nodiscard]] raw_type * raw() const ENTT_NOEXCEPT {
- return pool->raw();
- }
- /**
- * @brief Direct access to the list of entities.
- *
- * The returned pointer is such that range `[data(), data() + size()]` is
- * always a valid range, even if the container is empty.
- *
- * @note
- * Entities are in the reverse order as returned by the `begin`/`end`
- * iterators.
- *
- * @return A pointer to the array of entities.
- */
- [[nodiscard]] const entity_type * data() const ENTT_NOEXCEPT {
- return pool->data();
- }
- /**
- * @brief Returns an iterator to the first entity of the view.
- *
- * The returned iterator points to the first entity of the view. If the view
- * is empty, the returned iterator will be equal to `end()`.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the first entity of the view.
- */
- [[nodiscard]] iterator begin() const ENTT_NOEXCEPT {
- return pool->sparse_set<Entity>::begin();
- }
- /**
- * @brief Returns an iterator that is past the last entity of the view.
- *
- * The returned iterator points to the entity following the last entity of
- * the view. Attempting to dereference the returned iterator results in
- * undefined behavior.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the entity following the last entity of the view.
- */
- [[nodiscard]] iterator end() const ENTT_NOEXCEPT {
- return pool->sparse_set<Entity>::end();
- }
- /**
- * @brief Returns an iterator to the first entity of the reversed view.
- *
- * The returned iterator points to the first entity of the reversed view. If
- * the view is empty, the returned iterator will be equal to `rend()`.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the first entity of the reversed view.
- */
- [[nodiscard]] reverse_iterator rbegin() const ENTT_NOEXCEPT {
- return pool->sparse_set<Entity>::rbegin();
- }
- /**
- * @brief Returns an iterator that is past the last entity of the reversed
- * view.
- *
- * The returned iterator points to the entity following the last entity of
- * the reversed view. Attempting to dereference the returned iterator
- * results in undefined behavior.
- *
- * @note
- * Iterators stay true to the order imposed to the underlying data
- * structures.
- *
- * @return An iterator to the entity following the last entity of the
- * reversed view.
- */
- [[nodiscard]] reverse_iterator rend() const ENTT_NOEXCEPT {
- return pool->sparse_set<Entity>::rend();
- }
- /**
- * @brief Returns the first entity of the view, if any.
- * @return The first entity of the view if one exists, the null entity
- * otherwise.
- */
- [[nodiscard]] entity_type front() const {
- const auto it = begin();
- return it != end() ? *it : null;
- }
- /**
- * @brief Returns the last entity of the view, if any.
- * @return The last entity of the view if one exists, the null entity
- * otherwise.
- */
- [[nodiscard]] entity_type back() const {
- const auto it = rbegin();
- return it != rend() ? *it : null;
- }
- /**
- * @brief Finds an entity.
- * @param entt A valid entity identifier.
- * @return An iterator to the given entity if it's found, past the end
- * iterator otherwise.
- */
- [[nodiscard]] iterator find(const entity_type entt) const {
- const auto it = pool->find(entt);
- return it != end() && *it == entt ? it : end();
- }
- /**
- * @brief Returns the identifier that occupies the given position.
- * @param pos Position of the element to return.
- * @return The identifier that occupies the given position.
- */
- [[nodiscard]] entity_type operator[](const size_type pos) const {
- return begin()[pos];
- }
- /**
- * @brief Checks if a view contains an entity.
- * @param entt A valid entity identifier.
- * @return True if the view contains the given entity, false otherwise.
- */
- [[nodiscard]] bool contains(const entity_type entt) const {
- return pool->contains(entt);
- }
- /**
- * @brief Returns the component assigned to the given entity.
- *
- * Prefer this function instead of `registry::get` during iterations. It has
- * far better performance than its counterpart.
- *
- * @warning
- * Attempting to use an entity that doesn't belong to the view results in
- * undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * view doesn't contain the given entity.
- *
- * @param entt A valid entity identifier.
- * @return The component assigned to the entity.
- */
- template<typename Comp = Component>
- [[nodiscard]] decltype(auto) get(const entity_type entt) const {
- static_assert(std::is_same_v<Comp, Component>, "Invalid component type");
- ENTT_ASSERT(contains(entt));
- return pool->get(entt);
- }
- /**
- * @brief Iterates entities and components and applies the given function
- * object to them.
- *
- * The function object is invoked for each entity. It is provided with the
- * entity itself and a reference to the component if it's a non-empty one.
- * The _constness_ of the component is as requested.<br/>
- * The signature of the function must be equivalent to one of the following
- * forms:
- *
- * @code{.cpp}
- * void(const entity_type, Component &);
- * void(Component &);
- * @endcode
- *
- * @note
- * Empty types aren't explicitly instantiated and therefore they are never
- * returned during iterations.
- *
- * @tparam Func Type of the function object to invoke.
- * @param func A valid function object.
- */
- template<typename Func>
- void each(Func func) const {
- if constexpr(is_eto_eligible_v<Component>) {
- if constexpr(std::is_invocable_v<Func>) {
- for(auto pos = pool->size(); pos; --pos) {
- func();
- }
- } else {
- for(const auto entt: *this) {
- func(entt);
- }
- }
- } else {
- if constexpr(std::is_invocable_v<Func, decltype(get({}))>) {
- for(auto &&component: *pool) {
- func(component);
- }
- } else {
- auto raw = pool->begin();
- for(const auto entt: *this) {
- func(entt, *(raw++));
- }
- }
- }
- }
- /**
- * @brief Returns an iterable object to use to _visit_ the view.
- *
- * The iterable object returns tuples that contain the current entity and a
- * reference to its component if it's a non-empty one. The _constness_ of
- * the component is as requested.
- *
- * @note
- * Empty types aren't explicitly instantiated and therefore they are never
- * returned during iterations.
- *
- * @return An iterable object to use to _visit_ the view.
- */
- [[nodiscard]] auto proxy() const ENTT_NOEXCEPT {
- return view_proxy{*pool};
- }
- private:
- pool_type *pool;
- };
- }
- #endif
- namespace entt {
- /**
- * @brief Fast and reliable entity-component system.
- *
- * The registry is the core class of the entity-component framework.<br/>
- * It stores entities and arranges pools of components on a per request basis.
- * By means of a registry, users can manage entities and components, then create
- * views or groups to iterate them.
- *
- * @tparam Entity A valid entity type (see entt_traits for more details).
- */
- template<typename Entity>
- class basic_registry {
- using traits_type = entt_traits<Entity>;
- template<typename Component>
- struct pool_handler final: storage<Entity, Component> {
- static_assert(std::is_same_v<Component, std::decay_t<Component>>, "Invalid component type");
- [[nodiscard]] auto on_construct() ENTT_NOEXCEPT {
- return sink{construction};
- }
- [[nodiscard]] auto on_update() ENTT_NOEXCEPT {
- return sink{update};
- }
- [[nodiscard]] auto on_destroy() ENTT_NOEXCEPT {
- return sink{destruction};
- }
- template<typename... Args>
- decltype(auto) emplace(basic_registry &owner, const Entity entt, Args &&... args) {
- storage<entity_type, Component>::emplace(entt, std::forward<Args>(args)...);
- construction.publish(owner, entt);
- if constexpr(!is_eto_eligible_v<Component>) {
- return this->get(entt);
- }
- }
- template<typename It, typename... Args>
- void insert(basic_registry &owner, It first, It last, Args &&... args) {
- storage<entity_type, Component>::insert(first, last, std::forward<Args>(args)...);
- if(!construction.empty()) {
- while(first != last) { construction.publish(owner, *(first++)); }
- }
- }
- void remove(basic_registry &owner, const Entity entt) {
- destruction.publish(owner, entt);
- this->erase(entt);
- }
- template<typename It>
- void remove(basic_registry &owner, It first, It last) {
- if(std::distance(first, last) == std::distance(this->begin(), this->end())) {
- if(!destruction.empty()) {
- while(first != last) { destruction.publish(owner, *(first++)); }
- }
- this->clear();
- } else {
- while(first != last) { this->remove(owner, *(first++)); }
- }
- }
- template<typename... Func>
- decltype(auto) patch(basic_registry &owner, const Entity entt, [[maybe_unused]] Func &&... func) {
- if constexpr(is_eto_eligible_v<Component>) {
- update.publish(owner, entt);
- } else {
- (std::forward<Func>(func)(this->get(entt)), ...);
- update.publish(owner, entt);
- return this->get(entt);
- }
- }
- decltype(auto) replace(basic_registry &owner, const Entity entt, Component component) {
- return patch(owner, entt, [&component](auto &&curr) { curr = std::move(component); });
- }
- private:
- sigh<void(basic_registry &, const Entity)> construction{};
- sigh<void(basic_registry &, const Entity)> destruction{};
- sigh<void(basic_registry &, const Entity)> update{};
- };
- struct pool_data {
- id_type type_id{};
- std::unique_ptr<sparse_set<Entity>> pool{};
- void(* remove)(sparse_set<Entity> &, basic_registry &, const Entity){};
- };
- template<typename...>
- struct group_handler;
- template<typename... Exclude, typename... Get, typename... Owned>
- struct group_handler<exclude_t<Exclude...>, get_t<Get...>, Owned...> {
- static_assert(std::conjunction_v<std::is_same<Owned, std::decay_t<Owned>>..., std::is_same<Get, std::decay_t<Get>>..., std::is_same<Exclude, std::decay_t<Exclude>>...>, "One or more component types are invalid");
- std::conditional_t<sizeof...(Owned) == 0, sparse_set<Entity>, std::size_t> current{};
- template<typename Component>
- void maybe_valid_if(basic_registry &owner, const Entity entt) {
- [[maybe_unused]] const auto cpools = std::forward_as_tuple(owner.assure<Owned>()...);
- const auto is_valid = ((std::is_same_v<Component, Owned> || std::get<pool_handler<Owned> &>(cpools).contains(entt)) && ...)
- && ((std::is_same_v<Component, Get> || owner.assure<Get>().contains(entt)) && ...)
- && ((std::is_same_v<Component, Exclude> || !owner.assure<Exclude>().contains(entt)) && ...);
- if constexpr(sizeof...(Owned) == 0) {
- if(is_valid && !current.contains(entt)) {
- current.emplace(entt);
- }
- } else {
- if(is_valid && !(std::get<0>(cpools).index(entt) < current)) {
- const auto pos = current++;
- (std::get<pool_handler<Owned> &>(cpools).swap(std::get<pool_handler<Owned> &>(cpools).data()[pos], entt), ...);
- }
- }
- }
- void discard_if([[maybe_unused]] basic_registry &owner, const Entity entt) {
- if constexpr(sizeof...(Owned) == 0) {
- if(current.contains(entt)) {
- current.erase(entt);
- }
- } else {
- if(const auto cpools = std::forward_as_tuple(owner.assure<Owned>()...); std::get<0>(cpools).contains(entt) && (std::get<0>(cpools).index(entt) < current)) {
- const auto pos = --current;
- (std::get<pool_handler<Owned> &>(cpools).swap(std::get<pool_handler<Owned> &>(cpools).data()[pos], entt), ...);
- }
- }
- }
- };
- struct group_data {
- std::size_t size;
- std::unique_ptr<void, void(*)(void *)> group;
- bool (* owned)(const id_type) ENTT_NOEXCEPT;
- bool (* get)(const id_type) ENTT_NOEXCEPT;
- bool (* exclude)(const id_type) ENTT_NOEXCEPT;
- };
- struct variable_data {
- id_type type_id;
- std::unique_ptr<void, void(*)(void *)> value;
- };
- template<typename Component>
- [[nodiscard]] const pool_handler<Component> & assure() const {
- const sparse_set<entity_type> *cpool;
- if constexpr(ENTT_FAST_PATH(has_type_index_v<Component>)) {
- const auto index = type_index<Component>::value();
- if(!(index < pools.size())) {
- pools.resize(size_type(index+1u));
- }
- if(auto &&pdata = pools[index]; !pdata.pool) {
- pdata.type_id = type_info<Component>::id();
- pdata.pool.reset(new pool_handler<Component>());
- pdata.remove = [](sparse_set<entity_type> &target, basic_registry &owner, const entity_type entt) {
- static_cast<pool_handler<Component> &>(target).remove(owner, entt);
- };
- }
- cpool = pools[index].pool.get();
- } else {
- if(const auto it = std::find_if(pools.cbegin(), pools.cend(), [id = type_info<Component>::id()](const auto &pdata) { return id == pdata.type_id; }); it == pools.cend()) {
- cpool = pools.emplace_back(pool_data{
- type_info<Component>::id(),
- std::unique_ptr<sparse_set<entity_type>>{new pool_handler<Component>()},
- [](sparse_set<entity_type> &target, basic_registry &owner, const entity_type entt) {
- static_cast<pool_handler<Component> &>(target).remove(owner, entt);
- }
- }).pool.get();
- } else {
- cpool = it->pool.get();
- }
- }
- return *static_cast<const pool_handler<Component> *>(cpool);
- }
- template<typename Component>
- [[nodiscard]] pool_handler<Component> & assure() {
- return const_cast<pool_handler<Component> &>(std::as_const(*this).template assure<Component>());
- }
- public:
- /*! @brief Underlying entity identifier. */
- using entity_type = Entity;
- /*! @brief Underlying version type. */
- using version_type = typename traits_type::version_type;
- /*! @brief Unsigned integer type. */
- using size_type = std::size_t;
- /*! @brief Default constructor. */
- basic_registry() = default;
- /*! @brief Default move constructor. */
- basic_registry(basic_registry &&) = default;
- /*! @brief Default move assignment operator. @return This registry. */
- basic_registry & operator=(basic_registry &&) = default;
- /**
- * @brief Prepares a pool for the given type if required.
- * @tparam Component Type of component for which to prepare a pool.
- */
- template<typename Component>
- void prepare() {
- // suppress the warning due to the [[nodiscard]] attribute
- static_cast<void>(assure<Component>());
- }
- /**
- * @brief Returns the number of existing components of the given type.
- * @tparam Component Type of component of which to return the size.
- * @return Number of existing components of the given type.
- */
- template<typename Component>
- [[nodiscard]] size_type size() const {
- return assure<Component>().size();
- }
- /**
- * @brief Returns the number of entities created so far.
- * @return Number of entities created so far.
- */
- [[nodiscard]] size_type size() const ENTT_NOEXCEPT {
- return entities.size();
- }
- /**
- * @brief Returns the number of entities still in use.
- * @return Number of entities still in use.
- */
- [[nodiscard]] size_type alive() const {
- auto sz = entities.size();
- auto curr = destroyed;
- for(; curr != null; --sz) {
- curr = entities[to_integral(curr) & traits_type::entity_mask];
- }
- return sz;
- }
- /**
- * @brief Increases the capacity of the registry or of the pools for the
- * given components.
- *
- * If no components are specified, the capacity of the registry is
- * increased, that is the number of entities it contains. Otherwise the
- * capacity of the pools for the given components is increased.<br/>
- * In both cases, if the new capacity is greater than the current capacity,
- * new storage is allocated, otherwise the method does nothing.
- *
- * @tparam Component Types of components for which to reserve storage.
- * @param cap Desired capacity.
- */
- template<typename... Component>
- void reserve(const size_type cap) {
- if constexpr(sizeof...(Component) == 0) {
- entities.reserve(cap);
- } else {
- (assure<Component>().reserve(cap), ...);
- }
- }
- /**
- * @brief Returns the capacity of the pool for the given component.
- * @tparam Component Type of component in which one is interested.
- * @return Capacity of the pool of the given component.
- */
- template<typename Component>
- [[nodiscard]] size_type capacity() const {
- return assure<Component>().capacity();
- }
- /**
- * @brief Returns the number of entities that a registry has currently
- * allocated space for.
- * @return Capacity of the registry.
- */
- [[nodiscard]] size_type capacity() const ENTT_NOEXCEPT {
- return entities.capacity();
- }
- /**
- * @brief Requests the removal of unused capacity for the given components.
- * @tparam Component Types of components for which to reclaim unused
- * capacity.
- */
- template<typename... Component>
- void shrink_to_fit() {
- (assure<Component>().shrink_to_fit(), ...);
- }
- /**
- * @brief Checks whether the registry or the pools of the given components
- * are empty.
- *
- * A registry is considered empty when it doesn't contain entities that are
- * still in use.
- *
- * @tparam Component Types of components in which one is interested.
- * @return True if the registry or the pools of the given components are
- * empty, false otherwise.
- */
- template<typename... Component>
- [[nodiscard]] bool empty() const {
- if constexpr(sizeof...(Component) == 0) {
- return !alive();
- } else {
- return (assure<Component>().empty() && ...);
- }
- }
- /**
- * @brief Direct access to the list of components of a given pool.
- *
- * The returned pointer is such that range
- * `[raw<Component>(), raw<Component>() + size<Component>()]` is always a
- * valid range, even if the container is empty.
- *
- * Components are in the reverse order as imposed by the sorting
- * functionalities.
- *
- * @note
- * Empty components aren't explicitly instantiated. Therefore, this function
- * isn't available for them. A compilation error will occur if invoked.
- *
- * @tparam Component Type of component in which one is interested.
- * @return A pointer to the array of components of the given type.
- */
- template<typename Component>
- [[nodiscard]] const Component * raw() const {
- return assure<Component>().raw();
- }
- /*! @copydoc raw */
- template<typename Component>
- [[nodiscard]] Component * raw() {
- return const_cast<Component *>(std::as_const(*this).template raw<Component>());
- }
- /**
- * @brief Direct access to the list of entities of a given pool.
- *
- * The returned pointer is such that range
- * `[data<Component>(), data<Component>() + size<Component>()]` is always a
- * valid range, even if the container is empty.
- *
- * Entities are in the reverse order as imposed by the sorting
- * functionalities.
- *
- * @tparam Component Type of component in which one is interested.
- * @return A pointer to the array of entities.
- */
- template<typename Component>
- [[nodiscard]] const entity_type * data() const {
- return assure<Component>().data();
- }
- /**
- * @brief Direct access to the list of entities of a registry.
- *
- * The returned pointer is such that range `[data(), data() + size()]` is
- * always a valid range, even if the container is empty.
- *
- * @warning
- * This list contains both valid and destroyed entities and isn't suitable
- * for direct use.
- *
- * @return A pointer to the array of entities.
- */
- [[nodiscard]] const entity_type * data() const ENTT_NOEXCEPT {
- return entities.data();
- }
- /**
- * @brief Checks if an entity identifier refers to a valid entity.
- * @param entity An entity identifier, either valid or not.
- * @return True if the identifier is valid, false otherwise.
- */
- [[nodiscard]] bool valid(const entity_type entity) const {
- const auto pos = size_type(to_integral(entity) & traits_type::entity_mask);
- return (pos < entities.size() && entities[pos] == entity);
- }
- /**
- * @brief Returns the entity identifier without the version.
- * @param entity An entity identifier, either valid or not.
- * @return The entity identifier without the version.
- */
- [[nodiscard]] static entity_type entity(const entity_type entity) ENTT_NOEXCEPT {
- return entity_type{to_integral(entity) & traits_type::entity_mask};
- }
- /**
- * @brief Returns the version stored along with an entity identifier.
- * @param entity An entity identifier, either valid or not.
- * @return The version stored along with the given entity identifier.
- */
- [[nodiscard]] static version_type version(const entity_type entity) ENTT_NOEXCEPT {
- return version_type(to_integral(entity) >> traits_type::entity_shift);
- }
- /**
- * @brief Returns the actual version for an entity identifier.
- *
- * @warning
- * Attempting to use an entity that doesn't belong to the registry results
- * in undefined behavior. An entity belongs to the registry even if it has
- * been previously destroyed and/or recycled.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * registry doesn't own the given entity.
- *
- * @param entity A valid entity identifier.
- * @return Actual version for the given entity identifier.
- */
- [[nodiscard]] version_type current(const entity_type entity) const {
- const auto pos = size_type(to_integral(entity) & traits_type::entity_mask);
- ENTT_ASSERT(pos < entities.size());
- return version_type(to_integral(entities[pos]) >> traits_type::entity_shift);
- }
- /**
- * @brief Creates a new entity and returns it.
- *
- * There are two kinds of possible entity identifiers:
- *
- * * Newly created ones in case no entities have been previously destroyed.
- * * Recycled ones with updated versions.
- *
- * @return A valid entity identifier.
- */
- entity_type create() {
- entity_type entt;
- if(destroyed == null) {
- entt = entities.emplace_back(entity_type{static_cast<typename traits_type::entity_type>(entities.size())});
- // traits_type::entity_mask is reserved to allow for null identifiers
- ENTT_ASSERT(to_integral(entt) < traits_type::entity_mask);
- } else {
- const auto curr = to_integral(destroyed);
- const auto version = to_integral(entities[curr]) & (traits_type::version_mask << traits_type::entity_shift);
- destroyed = entity_type{to_integral(entities[curr]) & traits_type::entity_mask};
- entt = entities[curr] = entity_type{curr | version};
- }
- return entt;
- }
- /**
- * @brief Creates a new entity and returns it.
- *
- * @sa create
- *
- * If the requested entity isn't in use, the suggested identifier is created
- * and returned. Otherwise, a new one will be generated for this purpose.
- *
- * @param hint A desired entity identifier.
- * @return A valid entity identifier.
- */
- [[nodiscard]] entity_type create(const entity_type hint) {
- ENTT_ASSERT(hint != null);
- entity_type entt;
- if(const auto req = (to_integral(hint) & traits_type::entity_mask); !(req < entities.size())) {
- entities.reserve(req + 1);
- for(auto pos = entities.size(); pos < req; ++pos) {
- entities.emplace_back(destroyed);
- destroyed = entity_type{static_cast<typename traits_type::entity_type>(pos)};
- }
- entt = entities.emplace_back(hint);
- } else if(const auto curr = (to_integral(entities[req]) & traits_type::entity_mask); req == curr) {
- entt = create();
- } else {
- auto *it = &destroyed;
- for(; (to_integral(*it) & traits_type::entity_mask) != req; it = &entities[to_integral(*it) & traits_type::entity_mask]);
- *it = entity_type{curr | (to_integral(*it) & (traits_type::version_mask << traits_type::entity_shift))};
- entt = entities[req] = hint;
- }
- return entt;
- }
- /**
- * @brief Assigns each element in a range an entity.
- *
- * @sa create
- *
- * @tparam It Type of forward iterator.
- * @param first An iterator to the first element of the range to generate.
- * @param last An iterator past the last element of the range to generate.
- */
- template<typename It>
- void create(It first, It last) {
- std::generate(first, last, [this]() { return create(); });
- }
- /**
- * @brief Assigns entities to an empty registry.
- *
- * This function is intended for use in conjunction with `raw`.<br/>
- * Don't try to inject ranges of randomly generated entities. There is no
- * guarantee that a registry will continue to work properly in this case.
- *
- * @warning
- * An assertion will abort the execution at runtime in debug mode if all
- * pools aren't empty.
- *
- * @tparam It Type of input iterator.
- * @param first An iterator to the first element of the range of entities.
- * @param last An iterator past the last element of the range of entities.
- */
- template<typename It>
- void assign(It first, It last) {
- ENTT_ASSERT(std::all_of(pools.cbegin(), pools.cend(), [](auto &&pdata) { return !pdata.pool || pdata.pool->empty(); }));
- entities.assign(first, last);
- destroyed = null;
- for(std::size_t pos{}, end = entities.size(); pos < end; ++pos) {
- if((to_integral(entities[pos]) & traits_type::entity_mask) != pos) {
- const auto version = to_integral(entities[pos]) & (traits_type::version_mask << traits_type::entity_shift);
- entities[pos] = entity_type{to_integral(destroyed) | version};
- destroyed = entity_type{static_cast<typename traits_type::entity_type>(pos)};
- }
- }
- }
- /**
- * @brief Destroys an entity.
- *
- * When an entity is destroyed, its version is updated and the identifier
- * can be recycled at any time.
- *
- * @sa remove_all
- *
- * @param entity A valid entity identifier.
- */
- void destroy(const entity_type entity) {
- destroy(entity, version_type((to_integral(entity) >> traits_type::entity_shift) + 1));
- }
- /**
- * @brief Destroys an entity.
- *
- * If the entity isn't already destroyed, the suggested version is used
- * instead of the implicitly generated one.
- *
- * @sa remove_all
- *
- * @param entity A valid entity identifier.
- * @param version A desired version upon destruction.
- */
- void destroy(const entity_type entity, const version_type version) {
- remove_all(entity);
- // lengthens the implicit list of destroyed entities
- const auto entt = to_integral(entity) & traits_type::entity_mask;
- entities[entt] = entity_type{to_integral(destroyed) | (typename traits_type::entity_type{version} << traits_type::entity_shift)};
- destroyed = entity_type{entt};
- }
- /**
- * @brief Destroys all the entities in a range.
- *
- * @sa destroy
- *
- * @tparam It Type of input iterator.
- * @param first An iterator to the first element of the range of entities.
- * @param last An iterator past the last element of the range of entities.
- */
- template<typename It>
- void destroy(It first, It last) {
- while(first != last) { destroy(*(first++)); }
- }
- /**
- * @brief Assigns the given component to an entity.
- *
- * A new instance of the given component is created and initialized with the
- * arguments provided (the component must have a proper constructor or be of
- * aggregate type). Then the component is assigned to the given entity.
- *
- * @warning
- * Attempting to use an invalid entity or to assign a component to an entity
- * that already owns it results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode in case of
- * invalid entity or if the entity already owns an instance of the given
- * component.
- *
- * @tparam Component Type of component to create.
- * @tparam Args Types of arguments to use to construct the component.
- * @param entity A valid entity identifier.
- * @param args Parameters to use to initialize the component.
- * @return A reference to the newly created component.
- */
- template<typename Component, typename... Args>
- decltype(auto) emplace(const entity_type entity, Args &&... args) {
- ENTT_ASSERT(valid(entity));
- return assure<Component>().emplace(*this, entity, std::forward<Args>(args)...);
- }
- /**
- * @brief Assigns each entity in a range the given component.
- *
- * @sa emplace
- *
- * @tparam Component Type of component to create.
- * @tparam It Type of input iterator.
- * @param first An iterator to the first element of the range of entities.
- * @param last An iterator past the last element of the range of entities.
- * @param value An instance of the component to assign.
- */
- template<typename Component, typename It>
- void insert(It first, It last, const Component &value = {}) {
- ENTT_ASSERT(std::all_of(first, last, [this](const auto entity) { return valid(entity); }));
- assure<Component>().insert(*this, first, last, value);
- }
- /**
- * @brief Assigns each entity in a range the given components.
- *
- * @sa emplace
- *
- * @tparam Component Type of component to create.
- * @tparam EIt Type of input iterator.
- * @tparam CIt Type of input iterator.
- * @param first An iterator to the first element of the range of entities.
- * @param last An iterator past the last element of the range of entities.
- * @param from An iterator to the first element of the range of components.
- * @param to An iterator past the last element of the range of components.
- */
- template<typename Component, typename EIt, typename CIt>
- void insert(EIt first, EIt last, CIt from, CIt to) {
- static_assert(std::is_constructible_v<Component, typename std::iterator_traits<CIt>::value_type>, "Invalid value type");
- ENTT_ASSERT(std::all_of(first, last, [this](const auto entity) { return valid(entity); }));
- assure<Component>().insert(*this, first, last, from, to);
- }
- /**
- * @brief Assigns or replaces the given component for an entity.
- *
- * Equivalent to the following snippet (pseudocode):
- *
- * @code{.cpp}
- * auto &component = registry.has<Component>(entity) ? registry.replace<Component>(entity, args...) : registry.emplace<Component>(entity, args...);
- * @endcode
- *
- * Prefer this function anyway because it has slightly better performance.
- *
- * @warning
- * Attempting to use an invalid entity results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode in case of
- * invalid entity.
- *
- * @tparam Component Type of component to assign or replace.
- * @tparam Args Types of arguments to use to construct the component.
- * @param entity A valid entity identifier.
- * @param args Parameters to use to initialize the component.
- * @return A reference to the newly created component.
- */
- template<typename Component, typename... Args>
- decltype(auto) emplace_or_replace(const entity_type entity, Args &&... args) {
- ENTT_ASSERT(valid(entity));
- auto &cpool = assure<Component>();
- return cpool.contains(entity)
- ? cpool.replace(*this, entity, Component{std::forward<Args>(args)...})
- : cpool.emplace(*this, entity, std::forward<Args>(args)...);
- }
- /**
- * @brief Patches the given component for an entity.
- *
- * The signature of the functions should be equivalent to the following:
- *
- * @code{.cpp}
- * void(Component &);
- * @endcode
- *
- * @note
- * Empty types aren't explicitly instantiated and therefore they are never
- * returned. However, this function can be used to trigger an update signal
- * for them.
- *
- * @warning
- * Attempting to use an invalid entity or to patch a component of an entity
- * that doesn't own it results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode in case of
- * invalid entity or if the entity doesn't own an instance of the given
- * component.
- *
- * @tparam Component Type of component to patch.
- * @tparam Func Types of the function objects to invoke.
- * @param entity A valid entity identifier.
- * @param func Valid function objects.
- * @return A reference to the patched component.
- */
- template<typename Component, typename... Func>
- decltype(auto) patch(const entity_type entity, Func &&... func) {
- ENTT_ASSERT(valid(entity));
- return assure<Component>().patch(*this, entity, std::forward<Func>(func)...);
- }
- /**
- * @brief Replaces the given component for an entity.
- *
- * A new instance of the given component is created and initialized with the
- * arguments provided (the component must have a proper constructor or be of
- * aggregate type). Then the component is assigned to the given entity.
- *
- * @warning
- * Attempting to use an invalid entity or to replace a component of an
- * entity that doesn't own it results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode in case of
- * invalid entity or if the entity doesn't own an instance of the given
- * component.
- *
- * @tparam Component Type of component to replace.
- * @tparam Args Types of arguments to use to construct the component.
- * @param entity A valid entity identifier.
- * @param args Parameters to use to initialize the component.
- * @return A reference to the component being replaced.
- */
- template<typename Component, typename... Args>
- decltype(auto) replace(const entity_type entity, Args &&... args) {
- return assure<Component>().replace(*this, entity, Component{std::forward<Args>(args)...});
- }
- /**
- * @brief Removes the given components from an entity.
- *
- * @warning
- * Attempting to use an invalid entity or to remove a component from an
- * entity that doesn't own it results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode in case of
- * invalid entity or if the entity doesn't own an instance of the given
- * component.
- *
- * @tparam Component Types of components to remove.
- * @param entity A valid entity identifier.
- */
- template<typename... Component>
- void remove(const entity_type entity) {
- ENTT_ASSERT(valid(entity));
- (assure<Component>().remove(*this, entity), ...);
- }
- /**
- * @brief Removes the given components from all the entities in a range.
- *
- * @see remove
- *
- * @tparam Component Types of components to remove.
- * @tparam It Type of input iterator.
- * @param first An iterator to the first element of the range of entities.
- * @param last An iterator past the last element of the range of entities.
- */
- template<typename... Component, typename It>
- void remove(It first, It last) {
- ENTT_ASSERT(std::all_of(first, last, [this](const auto entity) { return valid(entity); }));
- (assure<Component>().remove(*this, first, last), ...);
- }
- /**
- * @brief Removes the given components from an entity.
- *
- * Equivalent to the following snippet (pseudocode):
- *
- * @code{.cpp}
- * if(registry.has<Component>(entity)) { registry.remove<Component>(entity) }
- * @endcode
- *
- * Prefer this function anyway because it has slightly better performance.
- *
- * @warning
- * Attempting to use an invalid entity results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode in case of
- * invalid entity.
- *
- * @tparam Component Types of components to remove.
- * @param entity A valid entity identifier.
- * @return The number of components actually removed.
- */
- template<typename... Component>
- size_type remove_if_exists(const entity_type entity) {
- ENTT_ASSERT(valid(entity));
- return ([this, entity](auto &&cpool) {
- return cpool.contains(entity) ? (cpool.remove(*this, entity), true) : false;
- }(assure<Component>()) + ... + size_type{});
- }
- /**
- * @brief Removes all the components from an entity and makes it orphaned.
- *
- * @warning
- * In case there are listeners that observe the destruction of components
- * and assign other components to the entity in their bodies, the result of
- * invoking this function may not be as expected. In the worst case, it
- * could lead to undefined behavior.
- *
- * @warning
- * Attempting to use an invalid entity results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode in case of
- * invalid entity.
- *
- * @param entity A valid entity identifier.
- */
- void remove_all(const entity_type entity) {
- ENTT_ASSERT(valid(entity));
- for(auto pos = pools.size(); pos; --pos) {
- if(auto &pdata = pools[pos-1]; pdata.pool && pdata.pool->contains(entity)) {
- pdata.remove(*pdata.pool, *this, entity);
- }
- }
- }
- /**
- * @brief Checks if an entity has all the given components.
- *
- * @warning
- * Attempting to use an invalid entity results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode in case of
- * invalid entity.
- *
- * @tparam Component Components for which to perform the check.
- * @param entity A valid entity identifier.
- * @return True if the entity has all the components, false otherwise.
- */
- template<typename... Component>
- [[nodiscard]] bool has(const entity_type entity) const {
- ENTT_ASSERT(valid(entity));
- return (assure<Component>().contains(entity) && ...);
- }
- /**
- * @brief Checks if an entity has at least one of the given components.
- *
- * @warning
- * Attempting to use an invalid entity results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode in case of
- * invalid entity.
- *
- * @tparam Component Components for which to perform the check.
- * @param entity A valid entity identifier.
- * @return True if the entity has at least one of the given components,
- * false otherwise.
- */
- template<typename... Component>
- [[nodiscard]] bool any(const entity_type entity) const {
- ENTT_ASSERT(valid(entity));
- return (assure<Component>().contains(entity) || ...);
- }
- /**
- * @brief Returns references to the given components for an entity.
- *
- * @warning
- * Attempting to use an invalid entity or to get a component from an entity
- * that doesn't own it results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode in case of
- * invalid entity or if the entity doesn't own an instance of the given
- * component.
- *
- * @tparam Component Types of components to get.
- * @param entity A valid entity identifier.
- * @return References to the components owned by the entity.
- */
- template<typename... Component>
- [[nodiscard]] decltype(auto) get([[maybe_unused]] const entity_type entity) const {
- ENTT_ASSERT(valid(entity));
- if constexpr(sizeof...(Component) == 1) {
- return (assure<Component>().get(entity), ...);
- } else {
- return std::forward_as_tuple(get<Component>(entity)...);
- }
- }
- /*! @copydoc get */
- template<typename... Component>
- [[nodiscard]] decltype(auto) get([[maybe_unused]] const entity_type entity) {
- ENTT_ASSERT(valid(entity));
- if constexpr(sizeof...(Component) == 1) {
- return (assure<Component>().get(entity), ...);
- } else {
- return std::forward_as_tuple(get<Component>(entity)...);
- }
- }
- /**
- * @brief Returns a reference to the given component for an entity.
- *
- * In case the entity doesn't own the component, the parameters provided are
- * used to construct it.<br/>
- * Equivalent to the following snippet (pseudocode):
- *
- * @code{.cpp}
- * auto &component = registry.has<Component>(entity) ? registry.get<Component>(entity) : registry.emplace<Component>(entity, args...);
- * @endcode
- *
- * Prefer this function anyway because it has slightly better performance.
- *
- * @warning
- * Attempting to use an invalid entity results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode in case of
- * invalid entity.
- *
- * @tparam Component Type of component to get.
- * @tparam Args Types of arguments to use to construct the component.
- * @param entity A valid entity identifier.
- * @param args Parameters to use to initialize the component.
- * @return Reference to the component owned by the entity.
- */
- template<typename Component, typename... Args>
- [[nodiscard]] decltype(auto) get_or_emplace(const entity_type entity, Args &&... args) {
- ENTT_ASSERT(valid(entity));
- auto &cpool = assure<Component>();
- return cpool.contains(entity) ? cpool.get(entity) : cpool.emplace(*this, entity, std::forward<Args>(args)...);
- }
- /**
- * @brief Returns pointers to the given components for an entity.
- *
- * @warning
- * Attempting to use an invalid entity results in undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode in case of
- * invalid entity.
- *
- * @tparam Component Types of components to get.
- * @param entity A valid entity identifier.
- * @return Pointers to the components owned by the entity.
- */
- template<typename... Component>
- [[nodiscard]] auto try_get([[maybe_unused]] const entity_type entity) const {
- ENTT_ASSERT(valid(entity));
- if constexpr(sizeof...(Component) == 1) {
- return (assure<Component>().try_get(entity), ...);
- } else {
- return std::make_tuple(try_get<Component>(entity)...);
- }
- }
- /*! @copydoc try_get */
- template<typename... Component>
- [[nodiscard]] auto try_get([[maybe_unused]] const entity_type entity) {
- ENTT_ASSERT(valid(entity));
- if constexpr(sizeof...(Component) == 1) {
- return (assure<Component>().try_get(entity), ...);
- } else {
- return std::make_tuple(try_get<Component>(entity)...);
- }
- }
- /**
- * @brief Clears a whole registry or the pools for the given components.
- * @tparam Component Types of components to remove from their entities.
- */
- template<typename... Component>
- void clear() {
- if constexpr(sizeof...(Component) == 0) {
- // useless this-> used to suppress a warning with clang
- each([this](const auto entity) { this->destroy(entity); });
- } else {
- ([this](auto &&cpool) {
- cpool.remove(*this, cpool.sparse_set<entity_type>::begin(), cpool.sparse_set<entity_type>::end());
- }(assure<Component>()), ...);
- }
- }
- /**
- * @brief Iterates all the entities that are still in use.
- *
- * The function object is invoked for each entity that is still in use.<br/>
- * The signature of the function should be equivalent to the following:
- *
- * @code{.cpp}
- * void(const Entity);
- * @endcode
- *
- * This function is fairly slow and should not be used frequently. However,
- * it's useful for iterating all the entities still in use, regardless of
- * their components.
- *
- * @tparam Func Type of the function object to invoke.
- * @param func A valid function object.
- */
- template<typename Func>
- void each(Func func) const {
- if(destroyed == null) {
- for(auto pos = entities.size(); pos; --pos) {
- func(entities[pos-1]);
- }
- } else {
- for(auto pos = entities.size(); pos; --pos) {
- if(const auto entt = entities[pos - 1]; (to_integral(entt) & traits_type::entity_mask) == (pos - 1)) {
- func(entt);
- }
- }
- }
- }
- /**
- * @brief Checks if an entity has components assigned.
- * @param entity A valid entity identifier.
- * @return True if the entity has no components assigned, false otherwise.
- */
- [[nodiscard]] bool orphan(const entity_type entity) const {
- ENTT_ASSERT(valid(entity));
- return std::none_of(pools.cbegin(), pools.cend(), [entity](auto &&pdata) { return pdata.pool && pdata.pool->contains(entity); });
- }
- /**
- * @brief Iterates orphans and applies them the given function object.
- *
- * The function object is invoked for each entity that is still in use and
- * has no components assigned.<br/>
- * The signature of the function should be equivalent to the following:
- *
- * @code{.cpp}
- * void(const Entity);
- * @endcode
- *
- * This function can be very slow and should not be used frequently.
- *
- * @tparam Func Type of the function object to invoke.
- * @param func A valid function object.
- */
- template<typename Func>
- void orphans(Func func) const {
- each([this, &func](const auto entity) {
- if(orphan(entity)) {
- func(entity);
- }
- });
- }
- /**
- * @brief Returns a sink object for the given component.
- *
- * A sink is an opaque object used to connect listeners to components.<br/>
- * The sink returned by this function can be used to receive notifications
- * whenever a new instance of the given component is created and assigned to
- * an entity.
- *
- * The function type for a listener is equivalent to:
- *
- * @code{.cpp}
- * void(registry<Entity> &, Entity);
- * @endcode
- *
- * Listeners are invoked **after** the component has been assigned to the
- * entity.
- *
- * @sa sink
- *
- * @tparam Component Type of component of which to get the sink.
- * @return A temporary sink object.
- */
- template<typename Component>
- [[nodiscard]] auto on_construct() {
- return assure<Component>().on_construct();
- }
- /**
- * @brief Returns a sink object for the given component.
- *
- * A sink is an opaque object used to connect listeners to components.<br/>
- * The sink returned by this function can be used to receive notifications
- * whenever an instance of the given component is explicitly updated.
- *
- * The function type for a listener is equivalent to:
- *
- * @code{.cpp}
- * void(registry<Entity> &, Entity);
- * @endcode
- *
- * Listeners are invoked **after** the component has been updated.
- *
- * @sa sink
- *
- * @tparam Component Type of component of which to get the sink.
- * @return A temporary sink object.
- */
- template<typename Component>
- [[nodiscard]] auto on_update() {
- return assure<Component>().on_update();
- }
- /**
- * @brief Returns a sink object for the given component.
- *
- * A sink is an opaque object used to connect listeners to components.<br/>
- * The sink returned by this function can be used to receive notifications
- * whenever an instance of the given component is removed from an entity and
- * thus destroyed.
- *
- * The function type for a listener is equivalent to:
- *
- * @code{.cpp}
- * void(registry<Entity> &, Entity);
- * @endcode
- *
- * Listeners are invoked **before** the component has been removed from the
- * entity.
- *
- * @sa sink
- *
- * @tparam Component Type of component of which to get the sink.
- * @return A temporary sink object.
- */
- template<typename Component>
- [[nodiscard]] auto on_destroy() {
- return assure<Component>().on_destroy();
- }
- /**
- * @brief Returns a view for the given components.
- *
- * This kind of objects are created on the fly and share with the registry
- * its internal data structures.<br/>
- * Feel free to discard a view after the use. Creating and destroying a view
- * is an incredibly cheap operation because they do not require any type of
- * initialization.<br/>
- * As a rule of thumb, storing a view should never be an option.
- *
- * Views do their best to iterate the smallest set of candidate entities.
- * In particular:
- *
- * * Single component views are incredibly fast and iterate a packed array
- * of entities, all of which has the given component.
- * * Multi component views look at the number of entities available for each
- * component and pick up a reference to the smallest set of candidates to
- * test for the given components.
- *
- * Views in no way affect the functionalities of the registry nor those of
- * the underlying pools.
- *
- * @note
- * Multi component views are pretty fast. However their performance tend to
- * degenerate when the number of components to iterate grows up and the most
- * of the entities have all the given components.<br/>
- * To get a performance boost, consider using a group instead.
- *
- * @tparam Component Type of components used to construct the view.
- * @tparam Exclude Types of components used to filter the view.
- * @return A newly created view.
- */
- template<typename... Component, typename... Exclude>
- [[nodiscard]] basic_view<Entity, exclude_t<Exclude...>, Component...> view(exclude_t<Exclude...> = {}) const {
- static_assert(sizeof...(Component) > 0, "Exclusion-only views are not supported");
- return { assure<std::decay_t<Component>>()..., assure<Exclude>()... };
- }
- /*! @copydoc view */
- template<typename... Component, typename... Exclude>
- [[nodiscard]] basic_view<Entity, exclude_t<Exclude...>, Component...> view(exclude_t<Exclude...> = {}) {
- static_assert(sizeof...(Component) > 0, "Exclusion-only views are not supported");
- return { assure<std::decay_t<Component>>()..., assure<Exclude>()... };
- }
- /**
- * @brief Returns a runtime view for the given components.
- *
- * This kind of objects are created on the fly and share with the registry
- * its internal data structures.<br/>
- * Users should throw away the view after use. Fortunately, creating and
- * destroying a runtime view is an incredibly cheap operation because they
- * do not require any type of initialization.<br/>
- * As a rule of thumb, storing a view should never be an option.
- *
- * Runtime views are to be used when users want to construct a view from
- * some external inputs and don't know at compile-time what are the required
- * components.
- *
- * @tparam ItComp Type of input iterator for the components to use to
- * construct the view.
- * @tparam ItExcl Type of input iterator for the components to use to filter
- * the view.
- * @param first An iterator to the first element of the range of components
- * to use to construct the view.
- * @param last An iterator past the last element of the range of components
- * to use to construct the view.
- * @param from An iterator to the first element of the range of components
- * to use to filter the view.
- * @param to An iterator past the last element of the range of components to
- * use to filter the view.
- * @return A newly created runtime view.
- */
- template<typename ItComp, typename ItExcl = id_type *>
- [[nodiscard]] basic_runtime_view<Entity> runtime_view(ItComp first, ItComp last, ItExcl from = {}, ItExcl to = {}) const {
- std::vector<const sparse_set<Entity> *> component(std::distance(first, last));
- std::vector<const sparse_set<Entity> *> filter(std::distance(from, to));
- std::transform(first, last, component.begin(), [this](const auto ctype) {
- const auto it = std::find_if(pools.cbegin(), pools.cend(), [ctype](auto &&pdata) { return pdata.pool && pdata.type_id == ctype; });
- return it == pools.cend() ? nullptr : it->pool.get();
- });
- std::transform(from, to, filter.begin(), [this](const auto ctype) {
- const auto it = std::find_if(pools.cbegin(), pools.cend(), [ctype](auto &&pdata) { return pdata.pool && pdata.type_id == ctype; });
- return it == pools.cend() ? nullptr : it->pool.get();
- });
- return { std::move(component), std::move(filter) };
- }
- /**
- * @brief Returns a group for the given components.
- *
- * This kind of objects are created on the fly and share with the registry
- * its internal data structures.<br/>
- * Feel free to discard a group after the use. Creating and destroying a
- * group is an incredibly cheap operation because they do not require any
- * type of initialization, but for the first time they are requested.<br/>
- * As a rule of thumb, storing a group should never be an option.
- *
- * Groups support exclusion lists and can own types of components. The more
- * types are owned by a group, the faster it is to iterate entities and
- * components.<br/>
- * However, groups also affect some features of the registry such as the
- * creation and destruction of components, which will consequently be
- * slightly slower (nothing that can be noticed in most cases).
- *
- * @note
- * Pools of components that are owned by a group cannot be sorted anymore.
- * The group takes the ownership of the pools and arrange components so as
- * to iterate them as fast as possible.
- *
- * @tparam Owned Types of components owned by the group.
- * @tparam Get Types of components observed by the group.
- * @tparam Exclude Types of components used to filter the group.
- * @return A newly created group.
- */
- template<typename... Owned, typename... Get, typename... Exclude>
- [[nodiscard]] basic_group<Entity, exclude_t<Exclude...>, get_t<Get...>, Owned...> group(get_t<Get...>, exclude_t<Exclude...> = {}) {
- static_assert(sizeof...(Owned) + sizeof...(Get) > 0, "Exclusion-only views are not supported");
- static_assert(sizeof...(Owned) + sizeof...(Get) + sizeof...(Exclude) > 1, "Single component groups are not allowed");
- using handler_type = group_handler<exclude_t<Exclude...>, get_t<std::decay_t<Get>...>, std::decay_t<Owned>...>;
- const auto cpools = std::forward_as_tuple(assure<std::decay_t<Owned>>()..., assure<std::decay_t<Get>>()...);
- constexpr auto size = sizeof...(Owned) + sizeof...(Get) + sizeof...(Exclude);
- handler_type *handler = nullptr;
- if(auto it = std::find_if(groups.cbegin(), groups.cend(), [size](const auto &gdata) {
- return gdata.size == size
- && (gdata.owned(type_info<std::decay_t<Owned>>::id()) && ...)
- && (gdata.get(type_info<std::decay_t<Get>>::id()) && ...)
- && (gdata.exclude(type_info<Exclude>::id()) && ...);
- }); it != groups.cend())
- {
- handler = static_cast<handler_type *>(it->group.get());
- }
- if(!handler) {
- group_data candidate = {
- size,
- { new handler_type{}, [](void *instance) { delete static_cast<handler_type *>(instance); } },
- []([[maybe_unused]] const id_type ctype) ENTT_NOEXCEPT { return ((ctype == type_info<std::decay_t<Owned>>::id()) || ...); },
- []([[maybe_unused]] const id_type ctype) ENTT_NOEXCEPT { return ((ctype == type_info<std::decay_t<Get>>::id()) || ...); },
- []([[maybe_unused]] const id_type ctype) ENTT_NOEXCEPT { return ((ctype == type_info<Exclude>::id()) || ...); },
- };
- handler = static_cast<handler_type *>(candidate.group.get());
- const void *maybe_valid_if = nullptr;
- const void *discard_if = nullptr;
- if constexpr(sizeof...(Owned) == 0) {
- groups.push_back(std::move(candidate));
- } else {
- ENTT_ASSERT(std::all_of(groups.cbegin(), groups.cend(), [size](const auto &gdata) {
- const auto overlapping = (0u + ... + gdata.owned(type_info<std::decay_t<Owned>>::id()));
- const auto sz = overlapping + (0u + ... + gdata.get(type_info<std::decay_t<Get>>::id())) + (0u + ... + gdata.exclude(type_info<Exclude>::id()));
- return !overlapping || ((sz == size) || (sz == gdata.size));
- }));
- const auto next = std::find_if_not(groups.cbegin(), groups.cend(), [size](const auto &gdata) {
- return !(0u + ... + gdata.owned(type_info<std::decay_t<Owned>>::id())) || (size > gdata.size);
- });
- const auto prev = std::find_if(std::make_reverse_iterator(next), groups.crend(), [](const auto &gdata) {
- return (0u + ... + gdata.owned(type_info<std::decay_t<Owned>>::id()));
- });
- maybe_valid_if = (next == groups.cend() ? maybe_valid_if : next->group.get());
- discard_if = (prev == groups.crend() ? discard_if : prev->group.get());
- groups.insert(next, std::move(candidate));
- }
- (on_construct<std::decay_t<Owned>>().before(maybe_valid_if).template connect<&handler_type::template maybe_valid_if<std::decay_t<Owned>>>(*handler), ...);
- (on_construct<std::decay_t<Get>>().before(maybe_valid_if).template connect<&handler_type::template maybe_valid_if<std::decay_t<Get>>>(*handler), ...);
- (on_destroy<Exclude>().before(maybe_valid_if).template connect<&handler_type::template maybe_valid_if<Exclude>>(*handler), ...);
- (on_destroy<std::decay_t<Owned>>().before(discard_if).template connect<&handler_type::discard_if>(*handler), ...);
- (on_destroy<std::decay_t<Get>>().before(discard_if).template connect<&handler_type::discard_if>(*handler), ...);
- (on_construct<Exclude>().before(discard_if).template connect<&handler_type::discard_if>(*handler), ...);
- if constexpr(sizeof...(Owned) == 0) {
- for(const auto entity: view<Owned..., Get...>(exclude<Exclude...>)) {
- handler->current.emplace(entity);
- }
- } else {
- // we cannot iterate backwards because we want to leave behind valid entities in case of owned types
- for(auto *first = std::get<0>(cpools).data(), *last = first + std::get<0>(cpools).size(); first != last; ++first) {
- handler->template maybe_valid_if<std::tuple_element_t<0, std::tuple<std::decay_t<Owned>...>>>(*this, *first);
- }
- }
- }
- if constexpr(sizeof...(Owned) == 0) {
- return { handler->current, std::get<pool_handler<std::decay_t<Get>> &>(cpools)... };
- } else {
- return { handler->current, std::get<pool_handler<std::decay_t<Owned>> &>(cpools)... , std::get<pool_handler<std::decay_t<Get>> &>(cpools)... };
- }
- }
- /**
- * @brief Returns a group for the given components.
- *
- * @sa group
- *
- * @tparam Owned Types of components owned by the group.
- * @tparam Get Types of components observed by the group.
- * @tparam Exclude Types of components used to filter the group.
- * @return A newly created group.
- */
- template<typename... Owned, typename... Get, typename... Exclude>
- [[nodiscard]] basic_group<Entity, exclude_t<Exclude...>, get_t<Get...>, Owned...> group(get_t<Get...>, exclude_t<Exclude...> = {}) const {
- static_assert(std::conjunction_v<std::is_const<Owned>..., std::is_const<Get>...>, "Invalid non-const type");
- return const_cast<basic_registry *>(this)->group<Owned...>(get_t<Get...>{}, exclude<Exclude...>);
- }
- /**
- * @brief Returns a group for the given components.
- *
- * @sa group
- *
- * @tparam Owned Types of components owned by the group.
- * @tparam Exclude Types of components used to filter the group.
- * @return A newly created group.
- */
- template<typename... Owned, typename... Exclude>
- [[nodiscard]] basic_group<Entity, exclude_t<Exclude...>, get_t<>, Owned...> group(exclude_t<Exclude...> = {}) {
- return group<Owned...>(get_t<>{}, exclude<Exclude...>);
- }
- /**
- * @brief Returns a group for the given components.
- *
- * @sa group
- *
- * @tparam Owned Types of components owned by the group.
- * @tparam Exclude Types of components used to filter the group.
- * @return A newly created group.
- */
- template<typename... Owned, typename... Exclude>
- [[nodiscard]] basic_group<Entity, exclude_t<Exclude...>, get_t<>, Owned...> group(exclude_t<Exclude...> = {}) const {
- static_assert(std::conjunction_v<std::is_const<Owned>...>, "Invalid non-const type");
- return const_cast<basic_registry *>(this)->group<Owned...>(exclude<Exclude...>);
- }
- /**
- * @brief Checks whether the given components belong to any group.
- * @tparam Component Types of components in which one is interested.
- * @return True if the pools of the given components are sortable, false
- * otherwise.
- */
- template<typename... Component>
- [[nodiscard]] bool sortable() const {
- return std::none_of(groups.cbegin(), groups.cend(), [](auto &&gdata) { return (gdata.owned(type_info<std::decay_t<Component>>::id()) || ...); });
- }
- /**
- * @brief Checks whether a group can be sorted.
- * @tparam Owned Types of components owned by the group.
- * @tparam Get Types of components observed by the group.
- * @tparam Exclude Types of components used to filter the group.
- * @return True if the group can be sorted, false otherwise.
- */
- template<typename... Owned, typename... Get, typename... Exclude>
- [[nodiscard]] bool sortable(const basic_group<Entity, exclude_t<Exclude...>, get_t<Get...>, Owned...> &) ENTT_NOEXCEPT {
- constexpr auto size = sizeof...(Owned) + sizeof...(Get) + sizeof...(Exclude);
- return std::find_if(groups.cbegin(), groups.cend(), [size](const auto &gdata) {
- return (0u + ... + gdata.owned(type_info<std::decay_t<Owned>>::id())) && (size < gdata.size);
- }) == groups.cend();
- }
- /**
- * @brief Sorts the pool of entities for the given component.
- *
- * The order of the elements in a pool is highly affected by assignments
- * of components to entities and deletions. Components are arranged to
- * maximize the performance during iterations and users should not make any
- * assumption on the order.<br/>
- * This function can be used to impose an order to the elements in the pool
- * of the given component. The order is kept valid until a component of the
- * given type is assigned or removed from an entity.
- *
- * The comparison function object must return `true` if the first element
- * is _less_ than the second one, `false` otherwise. The signature of the
- * comparison function should be equivalent to one of the following:
- *
- * @code{.cpp}
- * bool(const Entity, const Entity);
- * bool(const Component &, const Component &);
- * @endcode
- *
- * Moreover, the comparison function object shall induce a
- * _strict weak ordering_ on the values.
- *
- * The sort function oject must offer a member function template
- * `operator()` that accepts three arguments:
- *
- * * An iterator to the first element of the range to sort.
- * * An iterator past the last element of the range to sort.
- * * A comparison function to use to compare the elements.
- *
- * The comparison funtion object received by the sort function object hasn't
- * necessarily the type of the one passed along with the other parameters to
- * this member function.
- *
- * @warning
- * Pools of components owned by a group cannot be sorted.<br/>
- * An assertion will abort the execution at runtime in debug mode in case
- * the pool is owned by a group.
- *
- * @tparam Component Type of components to sort.
- * @tparam Compare Type of comparison function object.
- * @tparam Sort Type of sort function object.
- * @tparam Args Types of arguments to forward to the sort function object.
- * @param compare A valid comparison function object.
- * @param algo A valid sort function object.
- * @param args Arguments to forward to the sort function object, if any.
- */
- template<typename Component, typename Compare, typename Sort = std_sort, typename... Args>
- void sort(Compare compare, Sort algo = Sort{}, Args &&... args) {
- ENTT_ASSERT(sortable<Component>());
- auto &cpool = assure<Component>();
- cpool.sort(cpool.begin(), cpool.end(), std::move(compare), std::move(algo), std::forward<Args>(args)...);
- }
- /**
- * @brief Sorts two pools of components in the same way.
- *
- * The order of the elements in a pool is highly affected by assignments
- * of components to entities and deletions. Components are arranged to
- * maximize the performance during iterations and users should not make any
- * assumption on the order.
- *
- * It happens that different pools of components must be sorted the same way
- * because of runtime and/or performance constraints. This function can be
- * used to order a pool of components according to the order between the
- * entities in another pool of components.
- *
- * @b How @b it @b works
- *
- * Being `A` and `B` the two sets where `B` is the master (the one the order
- * of which rules) and `A` is the slave (the one to sort), after a call to
- * this function an iterator for `A` will return the entities according to
- * the following rules:
- *
- * * All the entities in `A` that are also in `B` are returned first
- * according to the order they have in `B`.
- * * All the entities in `A` that are not in `B` are returned in no
- * particular order after all the other entities.
- *
- * Any subsequent change to `B` won't affect the order in `A`.
- *
- * @warning
- * Pools of components owned by a group cannot be sorted.<br/>
- * An assertion will abort the execution at runtime in debug mode in case
- * the pool is owned by a group.
- *
- * @tparam To Type of components to sort.
- * @tparam From Type of components to use to sort.
- */
- template<typename To, typename From>
- void sort() {
- ENTT_ASSERT(sortable<To>());
- assure<To>().respect(assure<From>());
- }
- /**
- * @brief Visits an entity and returns the types for its components.
- *
- * The signature of the function should be equivalent to the following:
- *
- * @code{.cpp}
- * void(const id_type);
- * @endcode
- *
- * Returned identifiers are those of the components owned by the entity.
- *
- * @sa type_info
- *
- * @warning
- * It's not specified whether a component attached to or removed from the
- * given entity during the visit is returned or not to the caller.
- *
- * @tparam Func Type of the function object to invoke.
- * @param entity A valid entity identifier.
- * @param func A valid function object.
- */
- template<typename Func>
- void visit(entity_type entity, Func func) const {
- for(auto pos = pools.size(); pos; --pos) {
- if(const auto &pdata = pools[pos-1]; pdata.pool && pdata.pool->contains(entity)) {
- func(pdata.type_id);
- }
- }
- }
- /**
- * @brief Visits a registry and returns the types for its components.
- *
- * The signature of the function should be equivalent to the following:
- *
- * @code{.cpp}
- * void(const id_type);
- * @endcode
- *
- * Returned identifiers are those of the components managed by the registry.
- *
- * @sa type_info
- *
- * @warning
- * It's not specified whether a component for which a pool is created during
- * the visit is returned or not to the caller.
- *
- * @tparam Func Type of the function object to invoke.
- * @param func A valid function object.
- */
- template<typename Func>
- void visit(Func func) const {
- for(auto pos = pools.size(); pos; --pos) {
- if(const auto &pdata = pools[pos-1]; pdata.pool) {
- func(pdata.type_id);
- }
- }
- }
- /**
- * @brief Binds an object to the context of the registry.
- *
- * If the value already exists it is overwritten, otherwise a new instance
- * of the given type is created and initialized with the arguments provided.
- *
- * @tparam Type Type of object to set.
- * @tparam Args Types of arguments to use to construct the object.
- * @param args Parameters to use to initialize the value.
- * @return A reference to the newly created object.
- */
- template<typename Type, typename... Args>
- Type & set(Args &&... args) {
- unset<Type>();
- vars.push_back(variable_data{type_info<Type>::id(), { new Type{std::forward<Args>(args)...}, [](void *instance) { delete static_cast<Type *>(instance); } }});
- return *static_cast<Type *>(vars.back().value.get());
- }
- /**
- * @brief Unsets a context variable if it exists.
- * @tparam Type Type of object to set.
- */
- template<typename Type>
- void unset() {
- vars.erase(std::remove_if(vars.begin(), vars.end(), [](auto &&var) {
- return var.type_id == type_info<Type>::id();
- }), vars.end());
- }
- /**
- * @brief Binds an object to the context of the registry.
- *
- * In case the context doesn't contain the given object, the parameters
- * provided are used to construct it.
- *
- * @tparam Type Type of object to set.
- * @tparam Args Types of arguments to use to construct the object.
- * @param args Parameters to use to initialize the object.
- * @return A reference to the object in the context of the registry.
- */
- template<typename Type, typename... Args>
- [[nodiscard]] Type & ctx_or_set(Args &&... args) {
- auto *value = try_ctx<Type>();
- return value ? *value : set<Type>(std::forward<Args>(args)...);
- }
- /**
- * @brief Returns a pointer to an object in the context of the registry.
- * @tparam Type Type of object to get.
- * @return A pointer to the object if it exists in the context of the
- * registry, a null pointer otherwise.
- */
- template<typename Type>
- [[nodiscard]] const Type * try_ctx() const {
- auto it = std::find_if(vars.cbegin(), vars.cend(), [](auto &&var) { return var.type_id == type_info<Type>::id(); });
- return it == vars.cend() ? nullptr : static_cast<const Type *>(it->value.get());
- }
- /*! @copydoc try_ctx */
- template<typename Type>
- [[nodiscard]] Type * try_ctx() {
- return const_cast<Type *>(std::as_const(*this).template try_ctx<Type>());
- }
- /**
- * @brief Returns a reference to an object in the context of the registry.
- *
- * @warning
- * Attempting to get a context variable that doesn't exist results in
- * undefined behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode in case of
- * invalid requests.
- *
- * @tparam Type Type of object to get.
- * @return A valid reference to the object in the context of the registry.
- */
- template<typename Type>
- [[nodiscard]] const Type & ctx() const {
- const auto *instance = try_ctx<Type>();
- ENTT_ASSERT(instance);
- return *instance;
- }
- /*! @copydoc ctx */
- template<typename Type>
- [[nodiscard]] Type & ctx() {
- return const_cast<Type &>(std::as_const(*this).template ctx<Type>());
- }
- /**
- * @brief Visits a registry and returns the types for its context variables.
- *
- * The signature of the function should be equivalent to the following:
- *
- * @code{.cpp}
- * void(const id_type);
- * @endcode
- *
- * Returned identifiers are those of the context variables currently set.
- *
- * @sa type_info
- *
- * @warning
- * It's not specified whether a context variable created during the visit is
- * returned or not to the caller.
- *
- * @tparam Func Type of the function object to invoke.
- * @param func A valid function object.
- */
- template<typename Func>
- void ctx(Func func) const {
- for(auto pos = vars.size(); pos; --pos) {
- func(vars[pos-1].type_id);
- }
- }
- private:
- std::vector<group_data> groups{};
- mutable std::vector<pool_data> pools{};
- std::vector<entity_type> entities{};
- std::vector<variable_data> vars{};
- entity_type destroyed{null};
- };
- }
- #endif
- // #include "entity.hpp"
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @brief Dedicated to those who aren't confident with the
- * entity-component-system architecture.
- *
- * Tiny wrapper around a registry, for all those users that aren't confident
- * with entity-component-system architecture and prefer to iterate objects
- * directly.
- *
- * @tparam Entity A valid entity type (see entt_traits for more details).
- */
- template<typename Entity>
- struct [[deprecated("Consider using the handle class instead")]] basic_actor {
- /*! @brief Type of registry used internally. */
- using registry_type = basic_registry<Entity>;
- /*! @brief Underlying entity identifier. */
- using entity_type = Entity;
- basic_actor() ENTT_NOEXCEPT
- : entt{null}, reg{nullptr}
- {}
- /**
- * @brief Move constructor.
- *
- * After actor move construction, instances that have been moved from are
- * placed in a valid but unspecified state. It's highly discouraged to
- * continue using them.
- *
- * @param other The instance to move from.
- */
- basic_actor(basic_actor &&other) ENTT_NOEXCEPT
- : entt{other.entt}, reg{other.reg}
- {
- other.entt = null;
- }
- /**
- * @brief Constructs an actor from a given registry.
- * @param ref An instance of the registry class.
- */
- explicit basic_actor(registry_type &ref)
- : entt{ref.create()}, reg{&ref}
- {}
- /**
- * @brief Constructs an actor from a given entity.
- * @param entity A valid entity identifier.
- * @param ref An instance of the registry class.
- */
- explicit basic_actor(entity_type entity, registry_type &ref) ENTT_NOEXCEPT
- : entt{entity}, reg{&ref}
- {
- ENTT_ASSERT(ref.valid(entity));
- }
- /*! @brief Default destructor. */
- virtual ~basic_actor() {
- if(*this) {
- reg->destroy(entt);
- }
- }
- /**
- * @brief Move assignment operator.
- *
- * After actor move assignment, instances that have been moved from are
- * placed in a valid but unspecified state. It's highly discouraged to
- * continue using them.
- *
- * @param other The instance to move from.
- * @return This actor.
- */
- basic_actor & operator=(basic_actor &&other) ENTT_NOEXCEPT {
- if(this != &other) {
- auto tmp{std::move(other)};
- std::swap(reg, tmp.reg);
- std::swap(entt, tmp.entt);
- }
- return *this;
- }
- /**
- * @brief Assigns the given component to an actor.
- *
- * A new instance of the given component is created and initialized with the
- * arguments provided (the component must have a proper constructor or be of
- * aggregate type). Then the component is assigned to the actor.<br/>
- * In case the actor already has a component of the given type, it's
- * replaced with the new one.
- *
- * @tparam Component Type of the component to create.
- * @tparam Args Types of arguments to use to construct the component.
- * @param args Parameters to use to initialize the component.
- * @return A reference to the newly created component.
- */
- template<typename Component, typename... Args>
- decltype(auto) assign(Args &&... args) {
- return reg->template emplace_or_replace<Component>(entt, std::forward<Args>(args)...);
- }
- /**
- * @brief Removes the given component from an actor.
- * @tparam Component Type of the component to remove.
- */
- template<typename Component>
- void remove() {
- reg->template remove<Component>(entt);
- }
- /**
- * @brief Checks if an actor has the given components.
- * @tparam Component Components for which to perform the check.
- * @return True if the actor has all the components, false otherwise.
- */
- template<typename... Component>
- [[nodiscard]] bool has() const {
- return reg->template has<Component...>(entt);
- }
- /**
- * @brief Returns references to the given components for an actor.
- * @tparam Component Types of components to get.
- * @return References to the components owned by the actor.
- */
- template<typename... Component>
- [[nodiscard]] decltype(auto) get() const {
- return std::as_const(*reg).template get<Component...>(entt);
- }
- /*! @copydoc get */
- template<typename... Component>
- [[nodiscard]] decltype(auto) get() {
- return reg->template get<Component...>(entt);
- }
- /**
- * @brief Returns pointers to the given components for an actor.
- * @tparam Component Types of components to get.
- * @return Pointers to the components owned by the actor.
- */
- template<typename... Component>
- [[nodiscard]] auto try_get() const {
- return std::as_const(*reg).template try_get<Component...>(entt);
- }
- /*! @copydoc try_get */
- template<typename... Component>
- [[nodiscard]] auto try_get() {
- return reg->template try_get<Component...>(entt);
- }
- /**
- * @brief Returns a reference to the underlying registry.
- * @return A reference to the underlying registry.
- */
- [[nodiscard]] const registry_type & backend() const ENTT_NOEXCEPT {
- return *reg;
- }
- /*! @copydoc backend */
- [[nodiscard]] registry_type & backend() ENTT_NOEXCEPT {
- return const_cast<registry_type &>(std::as_const(*this).backend());
- }
- /**
- * @brief Returns the entity associated with an actor.
- * @return The entity associated with the actor.
- */
- [[nodiscard]] entity_type entity() const ENTT_NOEXCEPT {
- return entt;
- }
- /**
- * @brief Checks if an actor refers to a valid entity or not.
- * @return True if the actor refers to a valid entity, false otherwise.
- */
- [[nodiscard]] explicit operator bool() const {
- return reg && reg->valid(entt);
- }
- private:
- entity_type entt;
- registry_type *reg;
- };
- }
- #endif
- // #include "entity/entity.hpp"
- // #include "entity/group.hpp"
- // #include "entity/handle.hpp"
- #ifndef ENTT_ENTITY_HANDLE_HPP
- #define ENTT_ENTITY_HANDLE_HPP
- // #include "registry.hpp"
- namespace entt {
- /**
- * @brief Non-owning handle to an entity.
- *
- * Tiny wrapper around a registry and an entity.
- *
- * @tparam Entity A valid entity type (see entt_traits for more details).
- */
- template<typename Entity>
- struct basic_handle {
- /*! @brief Underlying entity identifier. */
- using entity_type = std::remove_const_t<Entity>;
- /*! @brief Type of registry accepted by the handle. */
- using registry_type = std::conditional_t<
- std::is_const_v<Entity>,
- const basic_registry<entity_type>,
- basic_registry<entity_type>
- >;
- /**
- * @brief Constructs a handle from a given registry and entity.
- * @param ref An instance of the registry class.
- * @param value An entity identifier.
- */
- basic_handle(registry_type &ref, entity_type value = null) ENTT_NOEXCEPT
- : reg{&ref}, entt{value}
- {}
- /**
- * @brief Assigns an entity to a handle.
- * @param value An entity identifier.
- * @return This handle.
- */
- basic_handle & operator=(const entity_type value) ENTT_NOEXCEPT {
- entt = value;
- return *this;
- }
- /**
- * @brief Assigns the null object to a handle.
- * @return This handle.
- */
- basic_handle & operator=(null_t) ENTT_NOEXCEPT {
- return (*this = static_cast<entity_type>(null));
- }
- /**
- * @brief Constructs a const handle from a non-const one.
- * @return A const handle referring to the same entity.
- */
- [[nodiscard]] operator basic_handle<const entity_type>() const ENTT_NOEXCEPT {
- return {*reg, entt};
- }
- /**
- * @brief Converts a handle to its underlying entity.
- * @return An entity identifier.
- */
- [[nodiscard]] operator entity_type() const ENTT_NOEXCEPT {
- return entity();
- }
- /**
- * @brief Checks if a handle refers to a valid entity or not.
- * @return True if the handle refers to a valid entity, false otherwise.
- */
- [[nodiscard]] explicit operator bool() const {
- return reg->valid(entt);
- }
- /**
- * @brief Returns a reference to the underlying registry.
- * @return A reference to the underlying registry.
- */
- [[nodiscard]] registry_type & registry() const ENTT_NOEXCEPT {
- return *reg;
- }
- /**
- * @brief Returns the entity associated with a handle.
- * @return The entity associated with the handle.
- */
- [[nodiscard]] entity_type entity() const ENTT_NOEXCEPT {
- return entt;
- }
- /**
- * @brief Assigns the given component to a handle.
- * @sa basic_registry::emplace
- * @tparam Component Type of component to create.
- * @tparam Args Types of arguments to use to construct the component.
- * @param args Parameters to use to initialize the component.
- * @return A reference to the newly created component.
- */
- template<typename Component, typename... Args>
- decltype(auto) emplace(Args &&... args) const {
- return reg->template emplace<Component>(entt, std::forward<Args>(args)...);
- }
- /**
- * @brief Assigns or replaces the given component for a handle.
- * @sa basic_registry::emplace_or_replace
- * @tparam Component Type of component to assign or replace.
- * @tparam Args Types of arguments to use to construct the component.
- * @param args Parameters to use to initialize the component.
- * @return A reference to the newly created component.
- */
- template<typename Component, typename... Args>
- decltype(auto) emplace_or_replace(Args &&... args) const {
- return reg->template emplace_or_replace<Component>(entt, std::forward<Args>(args)...);
- }
- /**
- * @brief Patches the given component for a handle.
- * @sa basic_registry::patch
- * @tparam Component Type of component to patch.
- * @tparam Func Types of the function objects to invoke.
- * @param func Valid function objects.
- * @return A reference to the patched component.
- */
- template<typename Component, typename... Func>
- decltype(auto) patch(Func &&... func) const {
- return reg->template patch<Component>(entt, std::forward<Func>(func)...);
- }
- /**
- * @brief Replaces the given component for a handle.
- * @sa basic_registry::replace
- * @tparam Component Type of component to replace.
- * @tparam Args Types of arguments to use to construct the component.
- * @param args Parameters to use to initialize the component.
- * @return A reference to the component being replaced.
- */
- template<typename Component, typename... Args>
- decltype(auto) replace(Args &&... args) const {
- return reg->template replace<Component>(entt, std::forward<Args>(args)...);
- }
- /**
- * @brief Removes the given components from a handle.
- * @sa basic_registry::remove
- * @tparam Component Types of components to remove.
- */
- template<typename... Components>
- void remove() const {
- reg->template remove<Components...>(entt);
- }
- /**
- * @brief Removes the given components from a handle.
- * @sa basic_registry::remove_if_exists
- * @tparam Component Types of components to remove.
- * @return The number of components actually removed.
- */
- template<typename... Components>
- decltype(auto) remove_if_exists() const {
- return reg->template remove_if_exists<Components...>(entt);
- }
- /**
- * @brief Removes all the components from a handle and makes it orphaned.
- * @sa basic_registry::remove_all
- */
- void remove_all() const {
- reg->remove_all(entt);
- }
- /**
- * @brief Checks if a handle has all the given components.
- * @sa basic_registry::has
- * @tparam Component Components for which to perform the check.
- * @return True if the handle has all the components, false otherwise.
- */
- template<typename... Components>
- [[nodiscard]] decltype(auto) has() const {
- return reg->template has<Components...>(entt);
- }
- /**
- * @brief Checks if a handle has at least one of the given components.
- * @sa basic_registry::any
- * @tparam Component Components for which to perform the check.
- * @return True if the handle has at least one of the given components,
- * false otherwise.
- */
- template<typename... Components>
- [[nodiscard]] decltype(auto) any() const {
- return reg->template any<Components...>(entt);
- }
- /**
- * @brief Returns references to the given components for a handle.
- * @sa basic_registry::get
- * @tparam Component Types of components to get.
- * @return References to the components owned by the handle.
- */
- template<typename... Components>
- [[nodiscard]] decltype(auto) get() const {
- return reg->template get<Components...>(entt);
- }
- /**
- * @brief Returns a reference to the given component for a handle.
- * @sa basic_registry::get_or_emplace
- * @tparam Component Type of component to get.
- * @tparam Args Types of arguments to use to construct the component.
- * @param args Parameters to use to initialize the component.
- * @return Reference to the component owned by the handle.
- */
- template<typename Component, typename... Args>
- [[nodiscard]] decltype(auto) get_or_emplace(Args &&... args) const {
- return reg->template get_or_emplace<Component>(entt, std::forward<Args>(args)...);
- }
- /**
- * @brief Returns pointers to the given components for a handle.
- * @sa basic_registry::try_get
- * @tparam Component Types of components to get.
- * @return Pointers to the components owned by the handle.
- */
- template<typename... Components>
- [[nodiscard]] decltype(auto) try_get() const {
- return reg->template try_get<Components...>(entt);
- }
- /**
- * @brief Checks if a handle has components assigned.
- * @return True if the handle has no components assigned, false otherwise.
- */
- [[nodiscard]] bool orphan() const {
- return reg->orphan(entt);
- }
- /**
- * @brief Visits a handle and returns the types for its components.
- * @sa basic_registry::visit
- * @tparam Func Type of the function object to invoke.
- * @param func A valid function object.
- */
- template<typename Func>
- void visit(Func &&func) const {
- reg->visit(entt, std::forward<Func>(func));
- }
- private:
- registry_type *reg;
- entity_type entt;
- };
- /**
- * @brief Deduction guide.
- * @tparam Entity A valid entity type (see entt_traits for more details).
- */
- template<typename Entity>
- basic_handle(basic_registry<Entity> &, Entity) -> basic_handle<Entity>;
- /**
- * @brief Deduction guide.
- * @tparam Entity A valid entity type (see entt_traits for more details).
- */
- template<typename Entity>
- basic_handle(const basic_registry<Entity> &, Entity) -> basic_handle<const Entity>;
- }
- #endif
- // #include "entity/helper.hpp"
- #ifndef ENTT_ENTITY_HELPER_HPP
- #define ENTT_ENTITY_HELPER_HPP
- #include <type_traits>
- // #include "../config/config.h"
- // #include "../core/type_traits.hpp"
- // #include "../signal/delegate.hpp"
- // #include "registry.hpp"
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @brief Converts a registry to a view.
- * @tparam Const Constness of the accepted registry.
- * @tparam Entity A valid entity type (see entt_traits for more details).
- */
- template<bool Const, typename Entity>
- struct as_view {
- /*! @brief Type of registry to convert. */
- using registry_type = std::conditional_t<Const, const basic_registry<Entity>, basic_registry<Entity>>;
- /**
- * @brief Constructs a converter for a given registry.
- * @param source A valid reference to a registry.
- */
- as_view(registry_type &source) ENTT_NOEXCEPT: reg{source} {}
- /**
- * @brief Conversion function from a registry to a view.
- * @tparam Exclude Types of components used to filter the view.
- * @tparam Component Type of components used to construct the view.
- * @return A newly created view.
- */
- template<typename Exclude, typename... Component>
- operator basic_view<Entity, Exclude, Component...>() const {
- return reg.template view<Component...>(Exclude{});
- }
- private:
- registry_type ®
- };
- /**
- * @brief Deduction guide.
- *
- * It allows to deduce the constness of a registry directly from the instance
- * provided to the constructor.
- *
- * @tparam Entity A valid entity type (see entt_traits for more details).
- */
- template<typename Entity>
- as_view(basic_registry<Entity> &) ENTT_NOEXCEPT -> as_view<false, Entity>;
- /*! @copydoc as_view */
- template<typename Entity>
- as_view(const basic_registry<Entity> &) ENTT_NOEXCEPT -> as_view<true, Entity>;
- /**
- * @brief Converts a registry to a group.
- * @tparam Const Constness of the accepted registry.
- * @tparam Entity A valid entity type (see entt_traits for more details).
- */
- template<bool Const, typename Entity>
- struct as_group {
- /*! @brief Type of registry to convert. */
- using registry_type = std::conditional_t<Const, const basic_registry<Entity>, basic_registry<Entity>>;
- /**
- * @brief Constructs a converter for a given registry.
- * @param source A valid reference to a registry.
- */
- as_group(registry_type &source) ENTT_NOEXCEPT: reg{source} {}
- /**
- * @brief Conversion function from a registry to a group.
- * @tparam Exclude Types of components used to filter the group.
- * @tparam Get Types of components observed by the group.
- * @tparam Owned Types of components owned by the group.
- * @return A newly created group.
- */
- template<typename Exclude, typename Get, typename... Owned>
- operator basic_group<Entity, Exclude, Get, Owned...>() const {
- return reg.template group<Owned...>(Get{}, Exclude{});
- }
- private:
- registry_type ®
- };
- /**
- * @brief Deduction guide.
- *
- * It allows to deduce the constness of a registry directly from the instance
- * provided to the constructor.
- *
- * @tparam Entity A valid entity type (see entt_traits for more details).
- */
- template<typename Entity>
- as_group(basic_registry<Entity> &) ENTT_NOEXCEPT -> as_group<false, Entity>;
- /*! @copydoc as_group */
- template<typename Entity>
- as_group(const basic_registry<Entity> &) ENTT_NOEXCEPT -> as_group<true, Entity>;
- /**
- * @brief Helper to create a listener that directly invokes a member function.
- * @tparam Member Member function to invoke on a component of the given type.
- * @tparam Entity A valid entity type (see entt_traits for more details).
- * @param reg A registry that contains the given entity and its components.
- * @param entt Entity from which to get the component.
- */
- template<auto Member, typename Entity = entity>
- void invoke(basic_registry<Entity> ®, const Entity entt) {
- static_assert(std::is_member_function_pointer_v<decltype(Member)>, "Invalid pointer to non-static member function");
- delegate<void(basic_registry<Entity> &, const Entity)> func;
- func.template connect<Member>(reg.template get<member_class_t<decltype(Member)>>(entt));
- func(reg, entt);
- }
- /**
- * @brief Returns the entity associated with a given component.
- * @tparam Entity A valid entity type (see entt_traits for more details).
- * @tparam Component Type of component.
- * @param reg A registry that contains the given entity and its components.
- * @param component A valid component instance.
- * @return The entity associated with the given component.
- */
- template<typename Entity, typename Component>
- Entity to_entity(const basic_registry<Entity> ®, const Component &component) {
- return *(reg.template data<Component>() + (&component - reg.template raw<Component>()));
- }
- }
- #endif
- // #include "entity/observer.hpp"
- #ifndef ENTT_ENTITY_OBSERVER_HPP
- #define ENTT_ENTITY_OBSERVER_HPP
- #include <limits>
- #include <cstddef>
- #include <cstdint>
- #include <utility>
- #include <type_traits>
- // #include "../config/config.h"
- // #include "../core/type_traits.hpp"
- // #include "registry.hpp"
- // #include "storage.hpp"
- // #include "utility.hpp"
- // #include "entity.hpp"
- // #include "fwd.hpp"
- namespace entt {
- /*! @brief Grouping matcher. */
- template<typename...>
- struct matcher {};
- /**
- * @brief Collector.
- *
- * Primary template isn't defined on purpose. All the specializations give a
- * compile-time error, but for a few reasonable cases.
- */
- template<typename...>
- struct basic_collector;
- /**
- * @brief Collector.
- *
- * A collector contains a set of rules (literally, matchers) to use to track
- * entities.<br/>
- * Its main purpose is to generate a descriptor that allows an observer to know
- * how to connect to a registry.
- */
- template<>
- struct basic_collector<> {
- /**
- * @brief Adds a grouping matcher to the collector.
- * @tparam AllOf Types of components tracked by the matcher.
- * @tparam NoneOf Types of components used to filter out entities.
- * @return The updated collector.
- */
- template<typename... AllOf, typename... NoneOf>
- static constexpr auto group(exclude_t<NoneOf...> = {}) ENTT_NOEXCEPT {
- return basic_collector<matcher<type_list<>, type_list<>, type_list<NoneOf...>, AllOf...>>{};
- }
- /**
- * @brief Adds an observing matcher to the collector.
- * @tparam AnyOf Type of component for which changes should be detected.
- * @return The updated collector.
- */
- template<typename AnyOf>
- static constexpr auto update() ENTT_NOEXCEPT {
- return basic_collector<matcher<type_list<>, type_list<>, AnyOf>>{};
- }
- };
- /**
- * @brief Collector.
- * @copydetails basic_collector<>
- * @tparam Reject Untracked types used to filter out entities.
- * @tparam Require Untracked types required by the matcher.
- * @tparam Rule Specific details of the current matcher.
- * @tparam Other Other matchers.
- */
- template<typename... Reject, typename... Require, typename... Rule, typename... Other>
- struct basic_collector<matcher<type_list<Reject...>, type_list<Require...>, Rule...>, Other...> {
- /*! @brief Current matcher. */
- using current_type = matcher<type_list<Reject...>, type_list<Require...>, Rule...>;
- /**
- * @brief Adds a grouping matcher to the collector.
- * @tparam AllOf Types of components tracked by the matcher.
- * @tparam NoneOf Types of components used to filter out entities.
- * @return The updated collector.
- */
- template<typename... AllOf, typename... NoneOf>
- static constexpr auto group(exclude_t<NoneOf...> = {}) ENTT_NOEXCEPT {
- return basic_collector<matcher<type_list<>, type_list<>, type_list<NoneOf...>, AllOf...>, current_type, Other...>{};
- }
- /**
- * @brief Adds an observing matcher to the collector.
- * @tparam AnyOf Type of component for which changes should be detected.
- * @return The updated collector.
- */
- template<typename AnyOf>
- static constexpr auto update() ENTT_NOEXCEPT {
- return basic_collector<matcher<type_list<>, type_list<>, AnyOf>, current_type, Other...>{};
- }
- /**
- * @brief Updates the filter of the last added matcher.
- * @tparam AllOf Types of components required by the matcher.
- * @tparam NoneOf Types of components used to filter out entities.
- * @return The updated collector.
- */
- template<typename... AllOf, typename... NoneOf>
- static constexpr auto where(exclude_t<NoneOf...> = {}) ENTT_NOEXCEPT {
- using extended_type = matcher<type_list<Reject..., NoneOf...>, type_list<Require..., AllOf...>, Rule...>;
- return basic_collector<extended_type, Other...>{};
- }
- };
- /*! @brief Variable template used to ease the definition of collectors. */
- inline constexpr basic_collector<> collector{};
- /**
- * @brief Observer.
- *
- * An observer returns all the entities and only the entities that fit the
- * requirements of at least one matcher. Moreover, it's guaranteed that the
- * entity list is tightly packed in memory for fast iterations.<br/>
- * In general, observers don't stay true to the order of any set of components.
- *
- * Observers work mainly with two types of matchers, provided through a
- * collector:
- *
- * * Observing matcher: an observer will return at least all the living entities
- * for which one or more of the given components have been updated and not yet
- * destroyed.
- * * Grouping matcher: an observer will return at least all the living entities
- * that would have entered the given group if it existed and that would have
- * not yet left it.
- *
- * If an entity respects the requirements of multiple matchers, it will be
- * returned once and only once by the observer in any case.
- *
- * Matchers support also filtering by means of a _where_ clause that accepts
- * both a list of types and an exclusion list.<br/>
- * Whenever a matcher finds that an entity matches its requirements, the
- * condition of the filter is verified before to register the entity itself.
- * Moreover, a registered entity isn't returned by the observer if the condition
- * set by the filter is broken in the meantime.
- *
- * @b Important
- *
- * Iterators aren't invalidated if:
- *
- * * New instances of the given components are created and assigned to entities.
- * * The entity currently pointed is modified (as an example, if one of the
- * given components is removed from the entity to which the iterator points).
- * * The entity currently pointed is destroyed.
- *
- * In all the other cases, modifying the pools of the given components in any
- * way invalidates all the iterators and using them results in undefined
- * behavior.
- *
- * @warning
- * Lifetime of an observer doesn't necessarily have to overcome that of the
- * registry to which it is connected. However, the observer must be disconnected
- * from the registry before being destroyed to avoid crashes due to dangling
- * pointers.
- *
- * @tparam Entity A valid entity type (see entt_traits for more details).
- */
- template<typename Entity>
- class basic_observer {
- using payload_type = std::uint32_t;
- template<typename>
- struct matcher_handler;
- template<typename... Reject, typename... Require, typename AnyOf>
- struct matcher_handler<matcher<type_list<Reject...>, type_list<Require...>, AnyOf>> {
- template<std::size_t Index>
- static void maybe_valid_if(basic_observer &obs, const basic_registry<Entity> ®, const Entity entt) {
- if(reg.template has<Require...>(entt) && !reg.template any<Reject...>(entt)) {
- if(auto *comp = obs.view.try_get(entt); !comp) {
- obs.view.emplace(entt);
- }
- obs.view.get(entt) |= (1 << Index);
- }
- }
- template<std::size_t Index>
- static void discard_if(basic_observer &obs, const basic_registry<Entity> &, const Entity entt) {
- if(auto *value = obs.view.try_get(entt); value && !(*value &= (~(1 << Index)))) {
- obs.view.erase(entt);
- }
- }
- template<std::size_t Index>
- static void connect(basic_observer &obs, basic_registry<Entity> ®) {
- (reg.template on_destroy<Require>().template connect<&discard_if<Index>>(obs), ...);
- (reg.template on_construct<Reject>().template connect<&discard_if<Index>>(obs), ...);
- reg.template on_update<AnyOf>().template connect<&maybe_valid_if<Index>>(obs);
- reg.template on_destroy<AnyOf>().template connect<&discard_if<Index>>(obs);
- }
- static void disconnect(basic_observer &obs, basic_registry<Entity> ®) {
- (reg.template on_destroy<Require>().disconnect(obs), ...);
- (reg.template on_construct<Reject>().disconnect(obs), ...);
- reg.template on_update<AnyOf>().disconnect(obs);
- reg.template on_destroy<AnyOf>().disconnect(obs);
- }
- };
- template<typename... Reject, typename... Require, typename... NoneOf, typename... AllOf>
- struct matcher_handler<matcher<type_list<Reject...>, type_list<Require...>, type_list<NoneOf...>, AllOf...>> {
- template<std::size_t Index>
- static void maybe_valid_if(basic_observer &obs, const basic_registry<Entity> ®, const Entity entt) {
- if(reg.template has<AllOf..., Require...>(entt) && !reg.template any<NoneOf..., Reject...>(entt)) {
- if(auto *comp = obs.view.try_get(entt); !comp) {
- obs.view.emplace(entt);
- }
- obs.view.get(entt) |= (1 << Index);
- }
- }
- template<std::size_t Index>
- static void discard_if(basic_observer &obs, const basic_registry<Entity> &, const Entity entt) {
- if(auto *value = obs.view.try_get(entt); value && !(*value &= (~(1 << Index)))) {
- obs.view.erase(entt);
- }
- }
- template<std::size_t Index>
- static void connect(basic_observer &obs, basic_registry<Entity> ®) {
- (reg.template on_destroy<Require>().template connect<&discard_if<Index>>(obs), ...);
- (reg.template on_construct<Reject>().template connect<&discard_if<Index>>(obs), ...);
- (reg.template on_construct<AllOf>().template connect<&maybe_valid_if<Index>>(obs), ...);
- (reg.template on_destroy<NoneOf>().template connect<&maybe_valid_if<Index>>(obs), ...);
- (reg.template on_destroy<AllOf>().template connect<&discard_if<Index>>(obs), ...);
- (reg.template on_construct<NoneOf>().template connect<&discard_if<Index>>(obs), ...);
- }
- static void disconnect(basic_observer &obs, basic_registry<Entity> ®) {
- (reg.template on_destroy<Require>().disconnect(obs), ...);
- (reg.template on_construct<Reject>().disconnect(obs), ...);
- (reg.template on_construct<AllOf>().disconnect(obs), ...);
- (reg.template on_destroy<NoneOf>().disconnect(obs), ...);
- (reg.template on_destroy<AllOf>().disconnect(obs), ...);
- (reg.template on_construct<NoneOf>().disconnect(obs), ...);
- }
- };
- template<typename... Matcher>
- static void disconnect(basic_observer &obs, basic_registry<Entity> ®) {
- (matcher_handler<Matcher>::disconnect(obs, reg), ...);
- }
- template<typename... Matcher, std::size_t... Index>
- void connect(basic_registry<Entity> ®, std::index_sequence<Index...>) {
- static_assert(sizeof...(Matcher) < std::numeric_limits<payload_type>::digits, "Too many matchers");
- (matcher_handler<Matcher>::template connect<Index>(*this, reg), ...);
- release = &basic_observer::disconnect<Matcher...>;
- }
- public:
- /*! @brief Underlying entity identifier. */
- using entity_type = Entity;
- /*! @brief Unsigned integer type. */
- using size_type = std::size_t;
- /*! @brief Random access iterator type. */
- using iterator = typename sparse_set<Entity>::iterator;
- /*! @brief Default constructor. */
- basic_observer()
- : target{}, release{}, view{}
- {}
- /*! @brief Default copy constructor, deleted on purpose. */
- basic_observer(const basic_observer &) = delete;
- /*! @brief Default move constructor, deleted on purpose. */
- basic_observer(basic_observer &&) = delete;
- /**
- * @brief Creates an observer and connects it to a given registry.
- * @tparam Matcher Types of matchers to use to initialize the observer.
- * @param reg A valid reference to a registry.
- */
- template<typename... Matcher>
- basic_observer(basic_registry<entity_type> ®, basic_collector<Matcher...>)
- : target{®},
- release{},
- view{}
- {
- connect<Matcher...>(reg, std::index_sequence_for<Matcher...>{});
- }
- /*! @brief Default destructor. */
- ~basic_observer() = default;
- /**
- * @brief Default copy assignment operator, deleted on purpose.
- * @return This observer.
- */
- basic_observer & operator=(const basic_observer &) = delete;
- /**
- * @brief Default move assignment operator, deleted on purpose.
- * @return This observer.
- */
- basic_observer & operator=(basic_observer &&) = delete;
- /**
- * @brief Connects an observer to a given registry.
- * @tparam Matcher Types of matchers to use to initialize the observer.
- * @param reg A valid reference to a registry.
- */
- template<typename... Matcher>
- void connect(basic_registry<entity_type> ®, basic_collector<Matcher...>) {
- disconnect();
- connect<Matcher...>(reg, std::index_sequence_for<Matcher...>{});
- target = ®
- view.clear();
- }
- /*! @brief Disconnects an observer from the registry it keeps track of. */
- void disconnect() {
- if(release) {
- release(*this, *target);
- release = nullptr;
- }
- }
- /**
- * @brief Returns the number of elements in an observer.
- * @return Number of elements.
- */
- [[nodiscard]] size_type size() const ENTT_NOEXCEPT {
- return view.size();
- }
- /**
- * @brief Checks whether an observer is empty.
- * @return True if the observer is empty, false otherwise.
- */
- [[nodiscard]] bool empty() const ENTT_NOEXCEPT {
- return view.empty();
- }
- /**
- * @brief Direct access to the list of entities of the observer.
- *
- * The returned pointer is such that range `[data(), data() + size()]` is
- * always a valid range, even if the container is empty.
- *
- * @note
- * Entities are in the reverse order as returned by the `begin`/`end`
- * iterators.
- *
- * @return A pointer to the array of entities.
- */
- [[nodiscard]] const entity_type * data() const ENTT_NOEXCEPT {
- return view.data();
- }
- /**
- * @brief Returns an iterator to the first entity of the observer.
- *
- * The returned iterator points to the first entity of the observer. If the
- * container is empty, the returned iterator will be equal to `end()`.
- *
- * @return An iterator to the first entity of the observer.
- */
- [[nodiscard]] iterator begin() const ENTT_NOEXCEPT {
- return view.sparse_set<entity_type>::begin();
- }
- /**
- * @brief Returns an iterator that is past the last entity of the observer.
- *
- * The returned iterator points to the entity following the last entity of
- * the observer. Attempting to dereference the returned iterator results in
- * undefined behavior.
- *
- * @return An iterator to the entity following the last entity of the
- * observer.
- */
- [[nodiscard]] iterator end() const ENTT_NOEXCEPT {
- return view.sparse_set<entity_type>::end();
- }
- /*! @brief Clears the underlying container. */
- void clear() ENTT_NOEXCEPT {
- view.clear();
- }
- /**
- * @brief Iterates entities and applies the given function object to them.
- *
- * The function object is invoked for each entity.<br/>
- * The signature of the function must be equivalent to the following form:
- *
- * @code{.cpp}
- * void(const entity_type);
- * @endcode
- *
- * @tparam Func Type of the function object to invoke.
- * @param func A valid function object.
- */
- template<typename Func>
- void each(Func func) const {
- for(const auto entity: *this) {
- func(entity);
- }
- }
- /**
- * @brief Iterates entities and applies the given function object to them,
- * then clears the observer.
- *
- * @sa each
- *
- * @tparam Func Type of the function object to invoke.
- * @param func A valid function object.
- */
- template<typename Func>
- void each(Func func) {
- std::as_const(*this).each(std::move(func));
- clear();
- }
- private:
- basic_registry<entity_type> *target;
- void(* release)(basic_observer &, basic_registry<entity_type> &);
- storage<entity_type, payload_type> view;
- };
- }
- #endif
- // #include "entity/pool.hpp"
- // #include "entity/registry.hpp"
- // #include "entity/runtime_view.hpp"
- // #include "entity/snapshot.hpp"
- #ifndef ENTT_ENTITY_SNAPSHOT_HPP
- #define ENTT_ENTITY_SNAPSHOT_HPP
- #include <array>
- #include <vector>
- #include <cstddef>
- #include <utility>
- #include <iterator>
- #include <type_traits>
- #include <unordered_map>
- // #include "../config/config.h"
- // #include "entity.hpp"
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @brief Utility class to create snapshots from a registry.
- *
- * A _snapshot_ can be either a dump of the entire registry or a narrower
- * selection of components of interest.<br/>
- * This type can be used in both cases if provided with a correctly configured
- * output archive.
- *
- * @tparam Entity A valid entity type (see entt_traits for more details).
- */
- template<typename Entity>
- class basic_snapshot {
- /*! @brief A registry is allowed to create snapshots. */
- friend class basic_registry<Entity>;
- using traits_type = entt_traits<Entity>;
- template<typename Component, typename Archive, typename It>
- void get(Archive &archive, std::size_t sz, It first, It last) const {
- archive(typename traits_type::entity_type(sz));
- while(first != last) {
- const auto entt = *(first++);
- if(reg->template has<Component>(entt)) {
- if constexpr(std::is_empty_v<Component>) {
- archive(entt);
- } else {
- archive(entt, reg->template get<Component>(entt));
- }
- }
- }
- }
- template<typename... Component, typename Archive, typename It, std::size_t... Indexes>
- void component(Archive &archive, It first, It last, std::index_sequence<Indexes...>) const {
- std::array<std::size_t, sizeof...(Indexes)> size{};
- auto begin = first;
- while(begin != last) {
- const auto entt = *(begin++);
- ((reg->template has<Component>(entt) ? ++size[Indexes] : size[Indexes]), ...);
- }
- (get<Component>(archive, size[Indexes], first, last), ...);
- }
- public:
- /*! @brief Underlying entity identifier. */
- using entity_type = Entity;
- /**
- * @brief Constructs an instance that is bound to a given registry.
- * @param source A valid reference to a registry.
- */
- basic_snapshot(const basic_registry<entity_type> &source) ENTT_NOEXCEPT
- : reg{&source}
- {}
- /*! @brief Default move constructor. */
- basic_snapshot(basic_snapshot &&) = default;
- /*! @brief Default move assignment operator. @return This snapshot. */
- basic_snapshot & operator=(basic_snapshot &&) = default;
- /**
- * @brief Puts aside all the entities from the underlying registry.
- *
- * Entities are serialized along with their versions. Destroyed entities are
- * taken in consideration as well by this function.
- *
- * @tparam Archive Type of output archive.
- * @param archive A valid reference to an output archive.
- * @return An object of this type to continue creating the snapshot.
- */
- template<typename Archive>
- const basic_snapshot & entities(Archive &archive) const {
- const auto sz = reg->size();
- auto first = reg->data();
- const auto last = first + sz;
- archive(typename traits_type::entity_type(sz));
- while(first != last) {
- archive(*(first++));
- }
- return *this;
- }
- /**
- * @brief Puts aside the given components.
- *
- * Each instance is serialized together with the entity to which it belongs.
- * Entities are serialized along with their versions.
- *
- * @tparam Component Types of components to serialize.
- * @tparam Archive Type of output archive.
- * @param archive A valid reference to an output archive.
- * @return An object of this type to continue creating the snapshot.
- */
- template<typename... Component, typename Archive>
- const basic_snapshot & component(Archive &archive) const {
- (component<Component>(archive, reg->template data<Component>(), reg->template data<Component>() + reg->template size<Component>()), ...);
- return *this;
- }
- /**
- * @brief Puts aside the given components for the entities in a range.
- *
- * Each instance is serialized together with the entity to which it belongs.
- * Entities are serialized along with their versions.
- *
- * @tparam Component Types of components to serialize.
- * @tparam Archive Type of output archive.
- * @tparam It Type of input iterator.
- * @param archive A valid reference to an output archive.
- * @param first An iterator to the first element of the range to serialize.
- * @param last An iterator past the last element of the range to serialize.
- * @return An object of this type to continue creating the snapshot.
- */
- template<typename... Component, typename Archive, typename It>
- const basic_snapshot & component(Archive &archive, It first, It last) const {
- component<Component...>(archive, first, last, std::index_sequence_for<Component...>{});
- return *this;
- }
- private:
- const basic_registry<entity_type> *reg;
- };
- /**
- * @brief Utility class to restore a snapshot as a whole.
- *
- * A snapshot loader requires that the destination registry be empty and loads
- * all the data at once while keeping intact the identifiers that the entities
- * originally had.<br/>
- * An example of use is the implementation of a save/restore utility.
- *
- * @tparam Entity A valid entity type (see entt_traits for more details).
- */
- template<typename Entity>
- class basic_snapshot_loader {
- /*! @brief A registry is allowed to create snapshot loaders. */
- friend class basic_registry<Entity>;
- using traits_type = entt_traits<Entity>;
- template<typename Type, typename Archive>
- void assign(Archive &archive) const {
- typename traits_type::entity_type length{};
- archive(length);
- entity_type entt{};
- if constexpr(std::is_empty_v<Type>) {
- while(length--) {
- archive(entt);
- const auto entity = reg->valid(entt) ? entt : reg->create(entt);
- ENTT_ASSERT(entity == entt);
- reg->template emplace<Type>(entity);
- }
- } else {
- Type instance{};
- while(length--) {
- archive(entt, instance);
- const auto entity = reg->valid(entt) ? entt : reg->create(entt);
- ENTT_ASSERT(entity == entt);
- reg->template emplace<Type>(entity, std::move(instance));
- }
- }
- }
- public:
- /*! @brief Underlying entity identifier. */
- using entity_type = Entity;
- /**
- * @brief Constructs an instance that is bound to a given registry.
- * @param source A valid reference to a registry.
- */
- basic_snapshot_loader(basic_registry<entity_type> &source) ENTT_NOEXCEPT
- : reg{&source}
- {
- // restoring a snapshot as a whole requires a clean registry
- ENTT_ASSERT(reg->empty());
- }
- /*! @brief Default move constructor. */
- basic_snapshot_loader(basic_snapshot_loader &&) = default;
- /*! @brief Default move assignment operator. @return This loader. */
- basic_snapshot_loader & operator=(basic_snapshot_loader &&) = default;
- /**
- * @brief Restores entities that were in use during serialization.
- *
- * This function restores the entities that were in use during serialization
- * and gives them the versions they originally had.
- *
- * @tparam Archive Type of input archive.
- * @param archive A valid reference to an input archive.
- * @return A valid loader to continue restoring data.
- */
- template<typename Archive>
- const basic_snapshot_loader & entities(Archive &archive) const {
- typename traits_type::entity_type length{};
- archive(length);
- std::vector<entity_type> all(length);
- for(decltype(length) pos{}; pos < length; ++pos) {
- archive(all[pos]);
- }
- reg->assign(all.cbegin(), all.cend());
- return *this;
- }
- /**
- * @brief Restores components and assigns them to the right entities.
- *
- * The template parameter list must be exactly the same used during
- * serialization. In the event that the entity to which the component is
- * assigned doesn't exist yet, the loader will take care to create it with
- * the version it originally had.
- *
- * @tparam Component Types of components to restore.
- * @tparam Archive Type of input archive.
- * @param archive A valid reference to an input archive.
- * @return A valid loader to continue restoring data.
- */
- template<typename... Component, typename Archive>
- const basic_snapshot_loader & component(Archive &archive) const {
- (assign<Component>(archive), ...);
- return *this;
- }
- /**
- * @brief Destroys those entities that have no components.
- *
- * In case all the entities were serialized but only part of the components
- * was saved, it could happen that some of the entities have no components
- * once restored.<br/>
- * This functions helps to identify and destroy those entities.
- *
- * @return A valid loader to continue restoring data.
- */
- const basic_snapshot_loader & orphans() const {
- reg->orphans([this](const auto entt) {
- reg->destroy(entt);
- });
- return *this;
- }
- private:
- basic_registry<entity_type> *reg;
- };
- /**
- * @brief Utility class for _continuous loading_.
- *
- * A _continuous loader_ is designed to load data from a source registry to a
- * (possibly) non-empty destination. The loader can accommodate in a registry
- * more than one snapshot in a sort of _continuous loading_ that updates the
- * destination one step at a time.<br/>
- * Identifiers that entities originally had are not transferred to the target.
- * Instead, the loader maps remote identifiers to local ones while restoring a
- * snapshot.<br/>
- * An example of use is the implementation of a client-server applications with
- * the requirement of transferring somehow parts of the representation side to
- * side.
- *
- * @tparam Entity A valid entity type (see entt_traits for more details).
- */
- template<typename Entity>
- class basic_continuous_loader {
- using traits_type = entt_traits<Entity>;
- void destroy(Entity entt) {
- const auto it = remloc.find(entt);
- if(it == remloc.cend()) {
- const auto local = reg->create();
- remloc.emplace(entt, std::make_pair(local, true));
- reg->destroy(local);
- }
- }
- void restore(Entity entt) {
- const auto it = remloc.find(entt);
- if(it == remloc.cend()) {
- const auto local = reg->create();
- remloc.emplace(entt, std::make_pair(local, true));
- } else {
- remloc[entt].first = reg->valid(remloc[entt].first) ? remloc[entt].first : reg->create();
- // set the dirty flag
- remloc[entt].second = true;
- }
- }
- template<typename Container>
- auto update(int, Container &container)
- -> decltype(typename Container::mapped_type{}, void()) {
- // map like container
- Container other;
- for(auto &&pair: container) {
- using first_type = std::remove_const_t<typename std::decay_t<decltype(pair)>::first_type>;
- using second_type = typename std::decay_t<decltype(pair)>::second_type;
- if constexpr(std::is_same_v<first_type, entity_type> && std::is_same_v<second_type, entity_type>) {
- other.emplace(map(pair.first), map(pair.second));
- } else if constexpr(std::is_same_v<first_type, entity_type>) {
- other.emplace(map(pair.first), std::move(pair.second));
- } else {
- static_assert(std::is_same_v<second_type, entity_type>, "Neither the key nor the value are of entity type");
- other.emplace(std::move(pair.first), map(pair.second));
- }
- }
- std::swap(container, other);
- }
- template<typename Container>
- auto update(char, Container &container)
- -> decltype(typename Container::value_type{}, void()) {
- // vector like container
- static_assert(std::is_same_v<typename Container::value_type, entity_type>, "Invalid value type");
- for(auto &&entt: container) {
- entt = map(entt);
- }
- }
- template<typename Other, typename Type, typename Member>
- void update([[maybe_unused]] Other &instance, [[maybe_unused]] Member Type:: *member) {
- if constexpr(!std::is_same_v<Other, Type>) {
- return;
- } else if constexpr(std::is_same_v<Member, entity_type>) {
- instance.*member = map(instance.*member);
- } else {
- // maybe a container? let's try...
- update(0, instance.*member);
- }
- }
- template<typename Component>
- void remove_if_exists() {
- for(auto &&ref: remloc) {
- const auto local = ref.second.first;
- if(reg->valid(local)) {
- reg->template remove_if_exists<Component>(local);
- }
- }
- }
- template<typename Other, typename Archive, typename... Type, typename... Member>
- void assign(Archive &archive, [[maybe_unused]] Member Type:: *... member) {
- typename traits_type::entity_type length{};
- archive(length);
- entity_type entt{};
- if constexpr(std::is_empty_v<Other>) {
- while(length--) {
- archive(entt);
- restore(entt);
- reg->template emplace_or_replace<Other>(map(entt));
- }
- } else {
- Other instance{};
- while(length--) {
- archive(entt, instance);
- (update(instance, member), ...);
- restore(entt);
- reg->template emplace_or_replace<Other>(map(entt), std::move(instance));
- }
- }
- }
- public:
- /*! @brief Underlying entity identifier. */
- using entity_type = Entity;
- /**
- * @brief Constructs an instance that is bound to a given registry.
- * @param source A valid reference to a registry.
- */
- basic_continuous_loader(basic_registry<entity_type> &source) ENTT_NOEXCEPT
- : reg{&source}
- {}
- /*! @brief Default move constructor. */
- basic_continuous_loader(basic_continuous_loader &&) = default;
- /*! @brief Default move assignment operator. @return This loader. */
- basic_continuous_loader & operator=(basic_continuous_loader &&) = default;
- /**
- * @brief Restores entities that were in use during serialization.
- *
- * This function restores the entities that were in use during serialization
- * and creates local counterparts for them if required.
- *
- * @tparam Archive Type of input archive.
- * @param archive A valid reference to an input archive.
- * @return A non-const reference to this loader.
- */
- template<typename Archive>
- basic_continuous_loader & entities(Archive &archive) {
- typename traits_type::entity_type length{};
- entity_type entt{};
- archive(length);
- for(decltype(length) pos{}; pos < length; ++pos) {
- archive(entt);
- if(const auto entity = (to_integral(entt) & traits_type::entity_mask); entity == pos) {
- restore(entt);
- } else {
- destroy(entt);
- }
- }
- return *this;
- }
- /**
- * @brief Restores components and assigns them to the right entities.
- *
- * The template parameter list must be exactly the same used during
- * serialization. In the event that the entity to which the component is
- * assigned doesn't exist yet, the loader will take care to create a local
- * counterpart for it.<br/>
- * Members can be either data members of type entity_type or containers of
- * entities. In both cases, the loader will visit them and update the
- * entities by replacing each one with its local counterpart.
- *
- * @tparam Component Type of component to restore.
- * @tparam Archive Type of input archive.
- * @tparam Type Types of components to update with local counterparts.
- * @tparam Member Types of members to update with their local counterparts.
- * @param archive A valid reference to an input archive.
- * @param member Members to update with their local counterparts.
- * @return A non-const reference to this loader.
- */
- template<typename... Component, typename Archive, typename... Type, typename... Member>
- basic_continuous_loader & component(Archive &archive, Member Type:: *... member) {
- (remove_if_exists<Component>(), ...);
- (assign<Component>(archive, member...), ...);
- return *this;
- }
- /**
- * @brief Helps to purge entities that no longer have a conterpart.
- *
- * Users should invoke this member function after restoring each snapshot,
- * unless they know exactly what they are doing.
- *
- * @return A non-const reference to this loader.
- */
- basic_continuous_loader & shrink() {
- auto it = remloc.begin();
- while(it != remloc.cend()) {
- const auto local = it->second.first;
- bool &dirty = it->second.second;
- if(dirty) {
- dirty = false;
- ++it;
- } else {
- if(reg->valid(local)) {
- reg->destroy(local);
- }
- it = remloc.erase(it);
- }
- }
- return *this;
- }
- /**
- * @brief Destroys those entities that have no components.
- *
- * In case all the entities were serialized but only part of the components
- * was saved, it could happen that some of the entities have no components
- * once restored.<br/>
- * This functions helps to identify and destroy those entities.
- *
- * @return A non-const reference to this loader.
- */
- basic_continuous_loader & orphans() {
- reg->orphans([this](const auto entt) {
- reg->destroy(entt);
- });
- return *this;
- }
- /**
- * @brief Tests if a loader knows about a given entity.
- * @param entt An entity identifier.
- * @return True if `entity` is managed by the loader, false otherwise.
- */
- [[nodiscard]] bool contains(entity_type entt) const ENTT_NOEXCEPT {
- return (remloc.find(entt) != remloc.cend());
- }
- /**
- * @brief Returns the identifier to which an entity refers.
- * @param entt An entity identifier.
- * @return The local identifier if any, the null entity otherwise.
- */
- [[nodiscard]] entity_type map(entity_type entt) const ENTT_NOEXCEPT {
- const auto it = remloc.find(entt);
- entity_type other = null;
- if(it != remloc.cend()) {
- other = it->second.first;
- }
- return other;
- }
- private:
- std::unordered_map<entity_type, std::pair<entity_type, bool>> remloc;
- basic_registry<entity_type> *reg;
- };
- }
- #endif
- // #include "entity/sparse_set.hpp"
- // #include "entity/storage.hpp"
- // #include "entity/utility.hpp"
- // #include "entity/view.hpp"
- // #include "locator/locator.hpp"
- #ifndef ENTT_LOCATOR_LOCATOR_HPP
- #define ENTT_LOCATOR_LOCATOR_HPP
- #include <memory>
- #include <utility>
- // #include "../config/config.h"
- #ifndef ENTT_CONFIG_CONFIG_H
- #define ENTT_CONFIG_CONFIG_H
- #ifndef ENTT_NOEXCEPT
- # define ENTT_NOEXCEPT noexcept
- #endif
- #ifndef ENTT_HS_SUFFIX
- # define ENTT_HS_SUFFIX _hs
- #endif
- #ifndef ENTT_HWS_SUFFIX
- # define ENTT_HWS_SUFFIX _hws
- #endif
- #ifndef ENTT_USE_ATOMIC
- # define ENTT_MAYBE_ATOMIC(Type) Type
- #else
- # include <atomic>
- # define ENTT_MAYBE_ATOMIC(Type) std::atomic<Type>
- #endif
- #ifndef ENTT_ID_TYPE
- # include <cstdint>
- # define ENTT_ID_TYPE std::uint32_t
- #endif
- #ifndef ENTT_PAGE_SIZE
- # define ENTT_PAGE_SIZE 32768
- #endif
- #ifndef ENTT_ASSERT
- # include <cassert>
- # define ENTT_ASSERT(condition) assert(condition)
- #endif
- #ifndef ENTT_NO_ETO
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::is_empty<Type>
- #else
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::false_type
- #endif
- #ifndef ENTT_STANDARD_CPP
- # if defined __clang__ || (defined __GNUC__ && __GNUC__ > 8)
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined __GNUC__
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined _MSC_VER
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __FUNCSIG__
- # define ENTT_PRETTY_FUNCTION_PREFIX '<'
- # define ENTT_PRETTY_FUNCTION_SUFFIX '>'
- # endif
- #endif
- #ifndef ENTT_STANDALONE
- # define ENTT_FAST_PATH(...) false
- #else
- # define ENTT_FAST_PATH(Cond) Cond
- #endif
- #endif
- namespace entt {
- /**
- * @brief Service locator, nothing more.
- *
- * A service locator can be used to do what it promises: locate services.<br/>
- * Usually service locators are tightly bound to the services they expose and
- * thus it's hard to define a general purpose class to do that. This template
- * based implementation tries to fill the gap and to get rid of the burden of
- * defining a different specific locator for each application.
- *
- * @tparam Service Type of service managed by the locator.
- */
- template<typename Service>
- struct service_locator {
- /*! @brief Type of service offered. */
- using service_type = Service;
- /*! @brief Default constructor, deleted on purpose. */
- service_locator() = delete;
- /*! @brief Default destructor, deleted on purpose. */
- ~service_locator() = delete;
- /**
- * @brief Tests if a valid service implementation is set.
- * @return True if the service is set, false otherwise.
- */
- [[nodiscard]] static bool empty() ENTT_NOEXCEPT {
- return !static_cast<bool>(service);
- }
- /**
- * @brief Returns a weak pointer to a service implementation, if any.
- *
- * Clients of a service shouldn't retain references to it. The recommended
- * way is to retrieve the service implementation currently set each and
- * every time the need of using it arises. Otherwise users can incur in
- * unexpected behaviors.
- *
- * @return A reference to the service implementation currently set, if any.
- */
- [[nodiscard]] static std::weak_ptr<Service> get() ENTT_NOEXCEPT {
- return service;
- }
- /**
- * @brief Returns a weak reference to a service implementation, if any.
- *
- * Clients of a service shouldn't retain references to it. The recommended
- * way is to retrieve the service implementation currently set each and
- * every time the need of using it arises. Otherwise users can incur in
- * unexpected behaviors.
- *
- * @warning
- * In case no service implementation has been set, a call to this function
- * results in undefined behavior.
- *
- * @return A reference to the service implementation currently set, if any.
- */
- [[nodiscard]] static Service & ref() ENTT_NOEXCEPT {
- return *service;
- }
- /**
- * @brief Sets or replaces a service.
- * @tparam Impl Type of the new service to use.
- * @tparam Args Types of arguments to use to construct the service.
- * @param args Parameters to use to construct the service.
- */
- template<typename Impl = Service, typename... Args>
- static void set(Args &&... args) {
- service = std::make_shared<Impl>(std::forward<Args>(args)...);
- }
- /**
- * @brief Sets or replaces a service.
- * @param ptr Service to use to replace the current one.
- */
- static void set(std::shared_ptr<Service> ptr) {
- ENTT_ASSERT(static_cast<bool>(ptr));
- service = std::move(ptr);
- }
- /**
- * @brief Resets a service.
- *
- * The service is no longer valid after a reset.
- */
- static void reset() {
- service.reset();
- }
- private:
- inline static std::shared_ptr<Service> service = nullptr;
- };
- }
- #endif
- // #include "meta/container.hpp"
- #ifndef ENTT_META_CONTAINER_HPP
- #define ENTT_META_CONTAINER_HPP
- #include <array>
- #include <map>
- #include <set>
- #include <unordered_map>
- #include <unordered_set>
- #include <utility>
- #include <vector>
- // #include "../config/config.h"
- #ifndef ENTT_CONFIG_CONFIG_H
- #define ENTT_CONFIG_CONFIG_H
- #ifndef ENTT_NOEXCEPT
- # define ENTT_NOEXCEPT noexcept
- #endif
- #ifndef ENTT_HS_SUFFIX
- # define ENTT_HS_SUFFIX _hs
- #endif
- #ifndef ENTT_HWS_SUFFIX
- # define ENTT_HWS_SUFFIX _hws
- #endif
- #ifndef ENTT_USE_ATOMIC
- # define ENTT_MAYBE_ATOMIC(Type) Type
- #else
- # include <atomic>
- # define ENTT_MAYBE_ATOMIC(Type) std::atomic<Type>
- #endif
- #ifndef ENTT_ID_TYPE
- # include <cstdint>
- # define ENTT_ID_TYPE std::uint32_t
- #endif
- #ifndef ENTT_PAGE_SIZE
- # define ENTT_PAGE_SIZE 32768
- #endif
- #ifndef ENTT_ASSERT
- # include <cassert>
- # define ENTT_ASSERT(condition) assert(condition)
- #endif
- #ifndef ENTT_NO_ETO
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::is_empty<Type>
- #else
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::false_type
- #endif
- #ifndef ENTT_STANDARD_CPP
- # if defined __clang__ || (defined __GNUC__ && __GNUC__ > 8)
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined __GNUC__
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined _MSC_VER
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __FUNCSIG__
- # define ENTT_PRETTY_FUNCTION_PREFIX '<'
- # define ENTT_PRETTY_FUNCTION_SUFFIX '>'
- # endif
- #endif
- #ifndef ENTT_STANDALONE
- # define ENTT_FAST_PATH(...) false
- #else
- # define ENTT_FAST_PATH(Cond) Cond
- #endif
- #endif
- // #include "type_traits.hpp"
- #ifndef ENTT_META_TYPE_TRAITS_HPP
- #define ENTT_META_TYPE_TRAITS_HPP
- #include <type_traits>
- namespace entt {
- /**
- * @brief Traits class template to be specialized to enable support for meta
- * sequence containers.
- */
- template<typename>
- struct meta_sequence_container_traits;
- /**
- * @brief Traits class template to be specialized to enable support for meta
- * associative containers.
- */
- template<typename>
- struct meta_associative_container_traits;
- /**
- * @brief Provides the member constant `value` to true if support for meta
- * sequence containers is enabled for the given type, false otherwise.
- * @tparam Type Potentially sequence container type.
- */
- template<typename Type, typename = void>
- struct has_meta_sequence_container_traits: std::false_type {};
- /*! @copydoc has_meta_sequence_container_traits */
- template<typename Type>
- struct has_meta_sequence_container_traits<Type, std::void_t<typename meta_sequence_container_traits<Type>::value_type>>
- : std::true_type
- {};
- /**
- * @brief Helper variable template.
- * @tparam Type Potentially sequence container type.
- */
- template<typename Type>
- inline constexpr auto has_meta_sequence_container_traits_v = has_meta_sequence_container_traits<Type>::value;
- /**
- * @brief Provides the member constant `value` to true if support for meta
- * associative containers is enabled for the given type, false otherwise.
- * @tparam Type Potentially associative container type.
- */
- template<typename, typename = void>
- struct has_meta_associative_container_traits: std::false_type {};
- /*! @copydoc has_meta_associative_container_traits */
- template<typename Type>
- struct has_meta_associative_container_traits<Type, std::void_t<typename meta_associative_container_traits<Type>::key_type>>
- : std::true_type
- {};
- /**
- * @brief Helper variable template.
- * @tparam Type Potentially associative container type.
- */
- template<typename Type>
- inline constexpr auto has_meta_associative_container_traits_v = has_meta_associative_container_traits<Type>::value;
- /**
- * @brief Provides the member constant `value` to true if a meta associative
- * container claims to wrap a key-only type, false otherwise.
- * @tparam Type Potentially key-only meta associative container type.
- */
- template<typename, typename = void>
- struct is_key_only_meta_associative_container: std::true_type {};
- /*! @copydoc is_key_only_meta_associative_container */
- template<typename Type>
- struct is_key_only_meta_associative_container<Type, std::void_t<typename meta_associative_container_traits<Type>::mapped_type>>
- : std::false_type
- {};
- /**
- * @brief Helper variable template.
- * @tparam Type Potentially key-only meta associative container type.
- */
- template<typename Type>
- inline constexpr auto is_key_only_meta_associative_container_v = is_key_only_meta_associative_container<Type>::value;
- /**
- * @brief Provides the member constant `value` to true if a given type is a
- * pointer-like type from the point of view of the meta system, false otherwise.
- * @tparam Type Potentially pointer-like type.
- */
- template<typename>
- struct is_meta_pointer_like: std::false_type {};
- /**
- * @brief Helper variable template.
- * @tparam Type Potentially pointer-like type.
- */
- template<typename Type>
- inline constexpr auto is_meta_pointer_like_v = is_meta_pointer_like<Type>::value;
- }
- #endif
- namespace entt {
- namespace internal {
- template<typename Container, template<typename> class... Trait>
- struct container_traits: public Trait<Container>... {};
- /**
- * @brief Basic STL-compatible container traits
- * @tparam Container The type of the container.
- */
- template<typename Container>
- struct basic_container {
- /*! @brief Iterator type of the container. */
- using iterator = typename Container::iterator;
- /*! @brief Unsigned integer type. */
- using size_type = typename Container::size_type;
- /*! @brief Value type of the container. */
- using value_type = typename Container::value_type;
- /**
- * @brief Returns the size of the given container.
- * @param cont The container for which to return the size.
- * @return The size of the given container.
- */
- [[nodiscard]] static size_type size(const Container &cont) ENTT_NOEXCEPT {
- return cont.size();
- }
- /**
- * @brief Returns an iterator to the first element of the given container.
- * @param cont The container for which to return the iterator.
- * @return An iterator to the first element of the given container.
- */
- [[nodiscard]] static iterator begin(Container &cont) {
- return cont.begin();
- }
- /**
- * @brief Returns an iterator past the last element of the given container.
- * @param cont The container for which to return the iterator.
- * @return An iterator past the last element of the given container.
- */
- [[nodiscard]] static iterator end(Container &cont) {
- return cont.end();
- }
- };
- /**
- * @brief Basic STL-compatible associative container traits
- * @tparam Container The type of the container.
- */
- template<typename Container>
- struct basic_associative_container {
- /*! @brief Key type of the sequence container. */
- using key_type = typename Container::key_type;
- /**
- * @brief Returns an iterator to the element with key equivalent to the given
- * one, if any.
- * @param cont The container in which to search for the element.
- * @param key The key of the element to search.
- * @return An iterator to the element with the given key, if any.
- */
- [[nodiscard]] static typename Container::iterator find(Container &cont, const key_type &key) {
- return cont.find(key);
- }
- };
- /**
- * @brief Basic STL-compatible dynamic container traits
- * @tparam Container The type of the container.
- */
- template<typename Container>
- struct basic_dynamic_container {
- /**
- * @brief Clears the content of the given container.
- * @param cont The container for which to clear the content.
- * @return True in case of success, false otherwise.
- */
- [[nodiscard]] static bool clear(Container &cont) {
- return cont.clear(), true;
- }
- };
- /**
- * @brief Basic STL-compatible dynamic associative container traits
- * @tparam Container The type of the container.
- */
- template<typename Container>
- struct basic_dynamic_associative_container {
- /**
- * @brief Removes the specified element from the given container.
- * @param cont The container from which to remove the element.
- * @param key The element to remove.
- * @return A bool denoting whether the removal took place.
- */
- [[nodiscard]] static bool erase(Container &cont, const typename Container::key_type &key) {
- const auto sz = cont.size();
- return cont.erase(key) != sz;
- }
- };
- /**
- * @brief Basic STL-compatible sequence container traits
- * @tparam Container The type of the container.
- */
- template<typename Container>
- struct basic_sequence_container {
- /**
- * @brief Returns a reference to the element at the specified location of the
- * given container (no bounds checking is performed).
- * @param cont The container from which to get the element.
- * @param pos The position of the element to return.
- * @return A reference to the requested element.
- */
- [[nodiscard]] static typename Container::value_type & get(Container &cont, typename Container::size_type pos) {
- return cont[pos];
- }
- };
- /**
- * @brief STL-compatible dynamic associative key-only container traits
- * @tparam Container The type of the container.
- */
- template<typename Container>
- struct dynamic_associative_key_only_container {
- /**
- * @brief Inserts an element into the given container.
- * @param cont The container in which to insert the element.
- * @param key The element to insert.
- * @return A bool denoting whether the insertion took place.
- */
- [[nodiscard]] static bool insert(Container &cont, const typename Container::key_type &key) {
- return cont.insert(key).second;
- }
- };
- /**
- * @brief STL-compatible dynamic key-value associative container traits
- * @tparam Container The type of the container.
- */
- template<typename Container>
- struct dynamic_associative_key_value_container {
- /**
- * @brief Inserts an element (a key/value pair) into the given container.
- * @param cont The container in which to insert the element.
- * @param key The key of the element to insert.
- * @param value The value of the element to insert.
- * @return A bool denoting whether the insertion took place.
- */
- [[nodiscard]] static bool insert(Container &cont, const typename Container::key_type &key, const typename Container::mapped_type &value) {
- return cont.insert(std::make_pair(key, value)).second;
- }
- };
- /**
- * @brief STL-compatible dynamic sequence container traits
- * @tparam Container The type of the container.
- */
- template<typename Container>
- struct dynamic_sequence_container {
- /**
- * @brief Resizes the given container to contain the given number of elements.
- * @param cont The container to resize.
- * @param sz The new size of the container.
- * @return True in case of success, false otherwise.
- */
- [[nodiscard]] static bool resize(Container &cont, typename Container::size_type sz) {
- return (cont.resize(sz), true);
- }
- /**
- * @brief Inserts an element at the specified location of the given container.
- * @param cont The container into which to insert the element.
- * @param it Iterator before which the element will be inserted.
- * @param value Element value to insert.
- * @return A pair consisting of an iterator to the inserted element (in case
- * of success) and a bool denoting whether the insertion took place.
- */
- [[nodiscard]] static std::pair<typename Container::iterator, bool> insert(Container &cont, typename Container::iterator it, const typename Container::value_type &value) {
- return { cont.insert(it, value), true };
- }
- /**
- * @brief Removes the element at the specified location from the given container.
- * @param cont The container from which to remove the element.
- * @param it Iterator to the element to remove.
- * @return A pair consisting of an iterator following the last removed
- * element (in case of success) and a bool denoting whether the insertion
- * took place.
- */
- [[nodiscard]] static std::pair<typename Container::iterator, bool> erase(Container &cont, typename Container::iterator it) {
- return { cont.erase(it), true };
- }
- };
- /**
- * @brief STL-compatible fixed sequence container traits
- * @tparam Container The type of the container.
- */
- template<typename Container>
- struct fixed_sequence_container {
- /**
- * @brief Does nothing.
- * @return False to indicate failure in all cases.
- */
- [[nodiscard]] static bool resize(const Container &, typename Container::size_type) {
- return false;
- }
- /**
- * @brief Does nothing.
- * @return False to indicate failure in all cases.
- */
- [[nodiscard]] static bool clear(const Container &) {
- return false;
- }
- /**
- * @brief Does nothing.
- * @return A pair consisting of an invalid iterator and a false value to
- * indicate failure in all cases.
- */
- [[nodiscard]] static std::pair<typename Container::iterator, bool> insert(const Container &, typename Container::iterator, const typename Container::value_type &) {
- return { {}, false };
- }
- /**
- * @brief Does nothing.
- * @return A pair consisting of an invalid iterator and a false value to
- * indicate failure in all cases.
- */
- [[nodiscard]] static std::pair<typename Container::iterator, bool> erase(const Container &, typename Container::iterator) {
- return { {}, false };
- }
- };
- }
- /**
- * @brief Meta sequence container traits for `std::vector`s of any type.
- * @tparam Type The type of elements.
- * @tparam Args Other arguments.
- */
- template<typename Type, typename... Args>
- struct meta_sequence_container_traits<std::vector<Type, Args...>>
- : internal::container_traits<
- std::vector<Type, Args...>,
- internal::basic_container,
- internal::basic_dynamic_container,
- internal::basic_sequence_container,
- internal::dynamic_sequence_container
- >
- {};
- /**
- * @brief Meta sequence container traits for `std::array`s of any type.
- * @tparam Type The type of elements.
- * @tparam N The number of elements.
- */
- template<typename Type, auto N>
- struct meta_sequence_container_traits<std::array<Type, N>>
- : internal::container_traits<
- std::array<Type, N>,
- internal::basic_container,
- internal::basic_sequence_container,
- internal::fixed_sequence_container
- >
- {};
- /**
- * @brief Meta associative container traits for `std::map`s of any type.
- * @tparam Key The key type of elements.
- * @tparam Value The value type of elements.
- * @tparam Args Other arguments.
- */
- template<typename Key, typename Value, typename... Args>
- struct meta_associative_container_traits<std::map<Key, Value, Args...>>
- : internal::container_traits<
- std::map<Key, Value, Args...>,
- internal::basic_container,
- internal::basic_associative_container,
- internal::basic_dynamic_container,
- internal::basic_dynamic_associative_container,
- internal::dynamic_associative_key_value_container
- >
- {
- /*! @brief Mapped type of the sequence container. */
- using mapped_type = typename std::map<Key, Value, Args...>::mapped_type;
- };
- /**
- * @brief Meta associative container traits for `std::unordered_map`s of any
- * type.
- * @tparam Key The key type of elements.
- * @tparam Value The value type of elements.
- * @tparam Args Other arguments.
- */
- template<typename Key, typename Value, typename... Args>
- struct meta_associative_container_traits<std::unordered_map<Key, Value, Args...>>
- : internal::container_traits<
- std::unordered_map<Key, Value, Args...>,
- internal::basic_container,
- internal::basic_associative_container,
- internal::basic_dynamic_container,
- internal::basic_dynamic_associative_container,
- internal::dynamic_associative_key_value_container
- >
- {
- /*! @brief Mapped type of the sequence container. */
- using mapped_type = typename std::unordered_map<Key, Value, Args...>::mapped_type;
- };
- /**
- * @brief Meta associative container traits for `std::set`s of any type.
- * @tparam Key The type of elements.
- * @tparam Args Other arguments.
- */
- template<typename Key, typename... Args>
- struct meta_associative_container_traits<std::set<Key, Args...>>
- : internal::container_traits<
- std::set<Key, Args...>,
- internal::basic_container,
- internal::basic_associative_container,
- internal::basic_dynamic_container,
- internal::basic_dynamic_associative_container,
- internal::dynamic_associative_key_only_container
- >
- {};
- /**
- * @brief Meta associative container traits for `std::unordered_set`s of any
- * type.
- * @tparam Key The type of elements.
- * @tparam Args Other arguments.
- */
- template<typename Key, typename... Args>
- struct meta_associative_container_traits<std::unordered_set<Key, Args...>>
- : internal::container_traits<
- std::unordered_set<Key, Args...>,
- internal::basic_container,
- internal::basic_associative_container,
- internal::basic_dynamic_container,
- internal::basic_dynamic_associative_container,
- internal::dynamic_associative_key_only_container
- >
- {};
- }
- #endif
- // #include "meta/ctx.hpp"
- #ifndef ENTT_META_CTX_HPP
- #define ENTT_META_CTX_HPP
- // #include "../core/attribute.h"
- #ifndef ENTT_CORE_ATTRIBUTE_H
- #define ENTT_CORE_ATTRIBUTE_H
- #ifndef ENTT_EXPORT
- # if defined _WIN32 || defined __CYGWIN__ || defined _MSC_VER
- # define ENTT_EXPORT __declspec(dllexport)
- # define ENTT_IMPORT __declspec(dllimport)
- # define ENTT_HIDDEN
- # elif defined __GNUC__ && __GNUC__ >= 4
- # define ENTT_EXPORT __attribute__((visibility("default")))
- # define ENTT_IMPORT __attribute__((visibility("default")))
- # define ENTT_HIDDEN __attribute__((visibility("hidden")))
- # else /* Unsupported compiler */
- # define ENTT_EXPORT
- # define ENTT_IMPORT
- # define ENTT_HIDDEN
- # endif
- #endif
- #ifndef ENTT_API
- # if defined ENTT_API_EXPORT
- # define ENTT_API ENTT_EXPORT
- # elif defined ENTT_API_IMPORT
- # define ENTT_API ENTT_IMPORT
- # else /* No API */
- # define ENTT_API
- # endif
- #endif
- #endif
- // #include "../config/config.h"
- namespace entt {
- /**
- * @cond TURN_OFF_DOXYGEN
- * Internal details not to be documented.
- */
- namespace internal {
- struct meta_type_node;
- struct ENTT_API meta_context {
- // we could use the lines below but VS2017 returns with an ICE if combined with ENTT_API despite the code being valid C++
- // inline static meta_type_node *local = nullptr;
- // inline static meta_type_node **global = &local;
- [[nodiscard]] static meta_type_node * & local() ENTT_NOEXCEPT {
- static meta_type_node *chain = nullptr;
- return chain;
- }
- [[nodiscard]] static meta_type_node ** & global() ENTT_NOEXCEPT {
- static meta_type_node **chain = &local();
- return chain;
- }
- };
- }
- /**
- * Internal details not to be documented.
- * @endcond
- */
- /*! @brief Opaque container for a meta context. */
- struct meta_ctx {
- /**
- * @brief Binds the meta system to a given context.
- * @param other A valid context to which to bind.
- */
- static void bind(meta_ctx other) ENTT_NOEXCEPT {
- internal::meta_context::global() = other.ctx;
- }
- private:
- internal::meta_type_node **ctx{&internal::meta_context::local()};
- };
- }
- #endif
- // #include "meta/factory.hpp"
- #ifndef ENTT_META_FACTORY_HPP
- #define ENTT_META_FACTORY_HPP
- #include <array>
- #include <cstddef>
- #include <functional>
- #include <tuple>
- #include <type_traits>
- #include <utility>
- // #include "../config/config.h"
- // #include "../core/fwd.hpp"
- #ifndef ENTT_CORE_FWD_HPP
- #define ENTT_CORE_FWD_HPP
- // #include "../config/config.h"
- #ifndef ENTT_CONFIG_CONFIG_H
- #define ENTT_CONFIG_CONFIG_H
- #ifndef ENTT_NOEXCEPT
- # define ENTT_NOEXCEPT noexcept
- #endif
- #ifndef ENTT_HS_SUFFIX
- # define ENTT_HS_SUFFIX _hs
- #endif
- #ifndef ENTT_HWS_SUFFIX
- # define ENTT_HWS_SUFFIX _hws
- #endif
- #ifndef ENTT_USE_ATOMIC
- # define ENTT_MAYBE_ATOMIC(Type) Type
- #else
- # include <atomic>
- # define ENTT_MAYBE_ATOMIC(Type) std::atomic<Type>
- #endif
- #ifndef ENTT_ID_TYPE
- # include <cstdint>
- # define ENTT_ID_TYPE std::uint32_t
- #endif
- #ifndef ENTT_PAGE_SIZE
- # define ENTT_PAGE_SIZE 32768
- #endif
- #ifndef ENTT_ASSERT
- # include <cassert>
- # define ENTT_ASSERT(condition) assert(condition)
- #endif
- #ifndef ENTT_NO_ETO
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::is_empty<Type>
- #else
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::false_type
- #endif
- #ifndef ENTT_STANDARD_CPP
- # if defined __clang__ || (defined __GNUC__ && __GNUC__ > 8)
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined __GNUC__
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined _MSC_VER
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __FUNCSIG__
- # define ENTT_PRETTY_FUNCTION_PREFIX '<'
- # define ENTT_PRETTY_FUNCTION_SUFFIX '>'
- # endif
- #endif
- #ifndef ENTT_STANDALONE
- # define ENTT_FAST_PATH(...) false
- #else
- # define ENTT_FAST_PATH(Cond) Cond
- #endif
- #endif
- namespace entt {
- /*! @brief Alias declaration for type identifiers. */
- using id_type = ENTT_ID_TYPE;
- }
- #endif
- // #include "../core/type_info.hpp"
- #ifndef ENTT_CORE_TYPE_INFO_HPP
- #define ENTT_CORE_TYPE_INFO_HPP
- #include <string_view>
- // #include "../config/config.h"
- // #include "../core/attribute.h"
- #ifndef ENTT_CORE_ATTRIBUTE_H
- #define ENTT_CORE_ATTRIBUTE_H
- #ifndef ENTT_EXPORT
- # if defined _WIN32 || defined __CYGWIN__ || defined _MSC_VER
- # define ENTT_EXPORT __declspec(dllexport)
- # define ENTT_IMPORT __declspec(dllimport)
- # define ENTT_HIDDEN
- # elif defined __GNUC__ && __GNUC__ >= 4
- # define ENTT_EXPORT __attribute__((visibility("default")))
- # define ENTT_IMPORT __attribute__((visibility("default")))
- # define ENTT_HIDDEN __attribute__((visibility("hidden")))
- # else /* Unsupported compiler */
- # define ENTT_EXPORT
- # define ENTT_IMPORT
- # define ENTT_HIDDEN
- # endif
- #endif
- #ifndef ENTT_API
- # if defined ENTT_API_EXPORT
- # define ENTT_API ENTT_EXPORT
- # elif defined ENTT_API_IMPORT
- # define ENTT_API ENTT_IMPORT
- # else /* No API */
- # define ENTT_API
- # endif
- #endif
- #endif
- // #include "hashed_string.hpp"
- #ifndef ENTT_CORE_HASHED_STRING_HPP
- #define ENTT_CORE_HASHED_STRING_HPP
- #include <cstddef>
- #include <cstdint>
- // #include "../config/config.h"
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @cond TURN_OFF_DOXYGEN
- * Internal details not to be documented.
- */
- namespace internal {
- template<typename>
- struct fnv1a_traits;
- template<>
- struct fnv1a_traits<std::uint32_t> {
- using type = std::uint32_t;
- static constexpr std::uint32_t offset = 2166136261;
- static constexpr std::uint32_t prime = 16777619;
- };
- template<>
- struct fnv1a_traits<std::uint64_t> {
- using type = std::uint64_t;
- static constexpr std::uint64_t offset = 14695981039346656037ull;
- static constexpr std::uint64_t prime = 1099511628211ull;
- };
- }
- /**
- * Internal details not to be documented.
- * @endcond
- */
- /**
- * @brief Zero overhead unique identifier.
- *
- * A hashed string is a compile-time tool that allows users to use
- * human-readable identifers in the codebase while using their numeric
- * counterparts at runtime.<br/>
- * Because of that, a hashed string can also be used in constant expressions if
- * required.
- *
- * @tparam Char Character type.
- */
- template<typename Char>
- class basic_hashed_string {
- using traits_type = internal::fnv1a_traits<id_type>;
- struct const_wrapper {
- // non-explicit constructor on purpose
- constexpr const_wrapper(const Char *curr) ENTT_NOEXCEPT: str{curr} {}
- const Char *str;
- };
- // Fowler–Noll–Vo hash function v. 1a - the good
- [[nodiscard]] static constexpr id_type helper(const Char *curr) ENTT_NOEXCEPT {
- auto value = traits_type::offset;
- while(*curr != 0) {
- value = (value ^ static_cast<traits_type::type>(*(curr++))) * traits_type::prime;
- }
- return value;
- }
- public:
- /*! @brief Character type. */
- using value_type = Char;
- /*! @brief Unsigned integer type. */
- using hash_type = id_type;
- /**
- * @brief Returns directly the numeric representation of a string.
- *
- * Forcing template resolution avoids implicit conversions. An
- * human-readable identifier can be anything but a plain, old bunch of
- * characters.<br/>
- * Example of use:
- * @code{.cpp}
- * const auto value = basic_hashed_string<char>::to_value("my.png");
- * @endcode
- *
- * @tparam N Number of characters of the identifier.
- * @param str Human-readable identifer.
- * @return The numeric representation of the string.
- */
- template<std::size_t N>
- [[nodiscard]] static constexpr hash_type value(const value_type (&str)[N]) ENTT_NOEXCEPT {
- return helper(str);
- }
- /**
- * @brief Returns directly the numeric representation of a string.
- * @param wrapper Helps achieving the purpose by relying on overloading.
- * @return The numeric representation of the string.
- */
- [[nodiscard]] static hash_type value(const_wrapper wrapper) ENTT_NOEXCEPT {
- return helper(wrapper.str);
- }
- /**
- * @brief Returns directly the numeric representation of a string view.
- * @param str Human-readable identifer.
- * @param size Length of the string to hash.
- * @return The numeric representation of the string.
- */
- [[nodiscard]] static hash_type value(const value_type *str, std::size_t size) ENTT_NOEXCEPT {
- id_type partial{traits_type::offset};
- while(size--) { partial = (partial^(str++)[0])*traits_type::prime; }
- return partial;
- }
- /*! @brief Constructs an empty hashed string. */
- constexpr basic_hashed_string() ENTT_NOEXCEPT
- : str{nullptr}, hash{}
- {}
- /**
- * @brief Constructs a hashed string from an array of const characters.
- *
- * Forcing template resolution avoids implicit conversions. An
- * human-readable identifier can be anything but a plain, old bunch of
- * characters.<br/>
- * Example of use:
- * @code{.cpp}
- * basic_hashed_string<char> hs{"my.png"};
- * @endcode
- *
- * @tparam N Number of characters of the identifier.
- * @param curr Human-readable identifer.
- */
- template<std::size_t N>
- constexpr basic_hashed_string(const value_type (&curr)[N]) ENTT_NOEXCEPT
- : str{curr}, hash{helper(curr)}
- {}
- /**
- * @brief Explicit constructor on purpose to avoid constructing a hashed
- * string directly from a `const value_type *`.
- * @param wrapper Helps achieving the purpose by relying on overloading.
- */
- explicit constexpr basic_hashed_string(const_wrapper wrapper) ENTT_NOEXCEPT
- : str{wrapper.str}, hash{helper(wrapper.str)}
- {}
- /**
- * @brief Returns the human-readable representation of a hashed string.
- * @return The string used to initialize the instance.
- */
- [[nodiscard]] constexpr const value_type * data() const ENTT_NOEXCEPT {
- return str;
- }
- /**
- * @brief Returns the numeric representation of a hashed string.
- * @return The numeric representation of the instance.
- */
- [[nodiscard]] constexpr hash_type value() const ENTT_NOEXCEPT {
- return hash;
- }
- /*! @copydoc data */
- [[nodiscard]] constexpr operator const value_type *() const ENTT_NOEXCEPT { return data(); }
- /**
- * @brief Returns the numeric representation of a hashed string.
- * @return The numeric representation of the instance.
- */
- [[nodiscard]] constexpr operator hash_type() const ENTT_NOEXCEPT { return value(); }
- /**
- * @brief Compares two hashed strings.
- * @param other Hashed string with which to compare.
- * @return True if the two hashed strings are identical, false otherwise.
- */
- [[nodiscard]] constexpr bool operator==(const basic_hashed_string &other) const ENTT_NOEXCEPT {
- return hash == other.hash;
- }
- private:
- const value_type *str;
- hash_type hash;
- };
- /**
- * @brief Deduction guide.
- *
- * It allows to deduce the character type of the hashed string directly from a
- * human-readable identifer provided to the constructor.
- *
- * @tparam Char Character type.
- * @tparam N Number of characters of the identifier.
- * @param str Human-readable identifer.
- */
- template<typename Char, std::size_t N>
- basic_hashed_string(const Char (&str)[N]) ENTT_NOEXCEPT
- -> basic_hashed_string<Char>;
- /**
- * @brief Compares two hashed strings.
- * @tparam Char Character type.
- * @param lhs A valid hashed string.
- * @param rhs A valid hashed string.
- * @return True if the two hashed strings are identical, false otherwise.
- */
- template<typename Char>
- [[nodiscard]] constexpr bool operator!=(const basic_hashed_string<Char> &lhs, const basic_hashed_string<Char> &rhs) ENTT_NOEXCEPT {
- return !(lhs == rhs);
- }
- /*! @brief Aliases for common character types. */
- using hashed_string = basic_hashed_string<char>;
- /*! @brief Aliases for common character types. */
- using hashed_wstring = basic_hashed_string<wchar_t>;
- }
- /**
- * @brief User defined literal for hashed strings.
- * @param str The literal without its suffix.
- * @return A properly initialized hashed string.
- */
- [[nodiscard]] constexpr entt::hashed_string operator"" ENTT_HS_SUFFIX(const char *str, std::size_t) ENTT_NOEXCEPT {
- return entt::hashed_string{str};
- }
- /**
- * @brief User defined literal for hashed wstrings.
- * @param str The literal without its suffix.
- * @return A properly initialized hashed wstring.
- */
- [[nodiscard]] constexpr entt::hashed_wstring operator"" ENTT_HWS_SUFFIX(const wchar_t *str, std::size_t) ENTT_NOEXCEPT {
- return entt::hashed_wstring{str};
- }
- #endif
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @cond TURN_OFF_DOXYGEN
- * Internal details not to be documented.
- */
- namespace internal {
- struct ENTT_API type_index {
- [[nodiscard]] static id_type next() ENTT_NOEXCEPT {
- static ENTT_MAYBE_ATOMIC(id_type) value{};
- return value++;
- }
- };
- template<typename Type>
- [[nodiscard]] constexpr auto type_name() ENTT_NOEXCEPT {
- #if defined ENTT_PRETTY_FUNCTION
- std::string_view pretty_function{ENTT_PRETTY_FUNCTION};
- auto first = pretty_function.find_first_not_of(' ', pretty_function.find_first_of(ENTT_PRETTY_FUNCTION_PREFIX)+1);
- auto value = pretty_function.substr(first, pretty_function.find_last_of(ENTT_PRETTY_FUNCTION_SUFFIX) - first);
- return value;
- #else
- return std::string_view{};
- #endif
- }
- }
- /**
- * Internal details not to be documented.
- * @endcond
- */
- /**
- * @brief Type index.
- * @tparam Type Type for which to generate a sequential identifier.
- */
- template<typename Type, typename = void>
- struct ENTT_API type_index {
- /**
- * @brief Returns the sequential identifier of a given type.
- * @return The sequential identifier of a given type.
- */
- [[nodiscard]] static id_type value() ENTT_NOEXCEPT {
- static const id_type value = internal::type_index::next();
- return value;
- }
- };
- /**
- * @brief Provides the member constant `value` to true if a given type is
- * indexable, false otherwise.
- * @tparam Type Potentially indexable type.
- */
- template<typename, typename = void>
- struct has_type_index: std::false_type {};
- /*! @brief has_type_index */
- template<typename Type>
- struct has_type_index<Type, std::void_t<decltype(type_index<Type>::value())>>: std::true_type {};
- /**
- * @brief Helper variable template.
- * @tparam Type Potentially indexable type.
- */
- template<typename Type>
- inline constexpr bool has_type_index_v = has_type_index<Type>::value;
- /**
- * @brief Type info.
- * @tparam Type Type for which to generate information.
- */
- template<typename Type, typename = void>
- struct type_info {
- /**
- * @brief Returns the numeric representation of a given type.
- * @return The numeric representation of the given type.
- */
- #if defined ENTT_PRETTY_FUNCTION_CONSTEXPR
- [[nodiscard]] static constexpr id_type id() ENTT_NOEXCEPT {
- constexpr auto value = hashed_string::value(ENTT_PRETTY_FUNCTION);
- return value;
- }
- #elif defined ENTT_PRETTY_FUNCTION
- [[nodiscard]] static id_type id() ENTT_NOEXCEPT {
- static const auto value = hashed_string::value(ENTT_PRETTY_FUNCTION);
- return value;
- }
- #else
- [[nodiscard]] static id_type id() ENTT_NOEXCEPT {
- return type_index<Type>::value();
- }
- #endif
- /**
- * @brief Returns the name of a given type.
- * @return The name of the given type.
- */
- #if defined ENTT_PRETTY_FUNCTION_CONSTEXPR
- [[nodiscard]] static constexpr std::string_view name() ENTT_NOEXCEPT {
- constexpr auto value = internal::type_name<Type>();
- return value;
- }
- #elif defined ENTT_PRETTY_FUNCTION
- [[nodiscard]] static std::string_view name() ENTT_NOEXCEPT {
- static const auto value = internal::type_name<Type>();
- return value;
- }
- #else
- [[nodiscard]] static constexpr std::string_view name() ENTT_NOEXCEPT {
- return internal::type_name<Type>();
- }
- #endif
- };
- }
- #endif
- // #include "../core/type_traits.hpp"
- #ifndef ENTT_CORE_TYPE_TRAITS_HPP
- #define ENTT_CORE_TYPE_TRAITS_HPP
- #include <cstddef>
- #include <utility>
- #include <type_traits>
- // #include "../config/config.h"
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @brief Using declaration to be used to _repeat_ the same type a number of
- * times equal to the size of a given parameter pack.
- * @tparam Type A type to repeat.
- */
- template<typename Type, typename>
- using unpack_as_t = Type;
- /**
- * @brief Helper variable template to be used to _repeat_ the same value a
- * number of times equal to the size of a given parameter pack.
- * @tparam Value A value to repeat.
- */
- template<auto Value, typename>
- inline constexpr auto unpack_as_v = Value;
- /**
- * @brief Wraps a static constant.
- * @tparam Value A static constant.
- */
- template<auto Value>
- using integral_constant = std::integral_constant<decltype(Value), Value>;
- /**
- * @brief Alias template to ease the creation of named values.
- * @tparam Value A constant value at least convertible to `id_type`.
- */
- template<id_type Value>
- using tag = integral_constant<Value>;
- /**
- * @brief Utility class to disambiguate overloaded functions.
- * @tparam N Number of choices available.
- */
- template<std::size_t N>
- struct choice_t
- // Unfortunately, doxygen cannot parse such a construct.
- /*! @cond TURN_OFF_DOXYGEN */
- : choice_t<N-1>
- /*! @endcond */
- {};
- /*! @copybrief choice_t */
- template<>
- struct choice_t<0> {};
- /**
- * @brief Variable template for the choice trick.
- * @tparam N Number of choices available.
- */
- template<std::size_t N>
- inline constexpr choice_t<N> choice{};
- /*! @brief A class to use to push around lists of types, nothing more. */
- template<typename...>
- struct type_list {};
- /*! @brief Primary template isn't defined on purpose. */
- template<typename>
- struct type_list_size;
- /**
- * @brief Compile-time number of elements in a type list.
- * @tparam Type Types provided by the type list.
- */
- template<typename... Type>
- struct type_list_size<type_list<Type...>>
- : std::integral_constant<std::size_t, sizeof...(Type)>
- {};
- /**
- * @brief Helper variable template.
- * @tparam List Type list.
- */
- template<class List>
- inline constexpr auto type_list_size_v = type_list_size<List>::value;
- /*! @brief Primary template isn't defined on purpose. */
- template<typename...>
- struct type_list_cat;
- /*! @brief Concatenates multiple type lists. */
- template<>
- struct type_list_cat<> {
- /*! @brief A type list composed by the types of all the type lists. */
- using type = type_list<>;
- };
- /**
- * @brief Concatenates multiple type lists.
- * @tparam Type Types provided by the first type list.
- * @tparam Other Types provided by the second type list.
- * @tparam List Other type lists, if any.
- */
- template<typename... Type, typename... Other, typename... List>
- struct type_list_cat<type_list<Type...>, type_list<Other...>, List...> {
- /*! @brief A type list composed by the types of all the type lists. */
- using type = typename type_list_cat<type_list<Type..., Other...>, List...>::type;
- };
- /**
- * @brief Concatenates multiple type lists.
- * @tparam Type Types provided by the type list.
- */
- template<typename... Type>
- struct type_list_cat<type_list<Type...>> {
- /*! @brief A type list composed by the types of all the type lists. */
- using type = type_list<Type...>;
- };
- /**
- * @brief Helper type.
- * @tparam List Type lists to concatenate.
- */
- template<typename... List>
- using type_list_cat_t = typename type_list_cat<List...>::type;
- /*! @brief Primary template isn't defined on purpose. */
- template<typename>
- struct type_list_unique;
- /**
- * @brief Removes duplicates types from a type list.
- * @tparam Type One of the types provided by the given type list.
- * @tparam Other The other types provided by the given type list.
- */
- template<typename Type, typename... Other>
- struct type_list_unique<type_list<Type, Other...>> {
- /*! @brief A type list without duplicate types. */
- using type = std::conditional_t<
- std::disjunction_v<std::is_same<Type, Other>...>,
- typename type_list_unique<type_list<Other...>>::type,
- type_list_cat_t<type_list<Type>, typename type_list_unique<type_list<Other...>>::type>
- >;
- };
- /*! @brief Removes duplicates types from a type list. */
- template<>
- struct type_list_unique<type_list<>> {
- /*! @brief A type list without duplicate types. */
- using type = type_list<>;
- };
- /**
- * @brief Helper type.
- * @tparam Type A type list.
- */
- template<typename Type>
- using type_list_unique_t = typename type_list_unique<Type>::type;
- /**
- * @brief Provides the member constant `value` to true if a given type is
- * equality comparable, false otherwise.
- * @tparam Type Potentially equality comparable type.
- */
- template<typename Type, typename = std::void_t<>>
- struct is_equality_comparable: std::false_type {};
- /*! @copydoc is_equality_comparable */
- template<typename Type>
- struct is_equality_comparable<Type, std::void_t<decltype(std::declval<Type>() == std::declval<Type>())>>
- : std::true_type
- {};
- /**
- * @brief Helper variable template.
- * @tparam Type Potentially equality comparable type.
- */
- template<class Type>
- inline constexpr auto is_equality_comparable_v = is_equality_comparable<Type>::value;
- /**
- * @brief Provides the member constant `value` to true if a given type is empty
- * and the empty type optimization is enabled, false otherwise.
- * @tparam Type Potential empty type.
- */
- template<typename Type, typename = void>
- struct is_eto_eligible
- : ENTT_IS_EMPTY(Type)
- {};
- /**
- * @brief Helper variable template.
- * @tparam Type Potential empty type.
- */
- template<typename Type>
- inline constexpr auto is_eto_eligible_v = is_eto_eligible<Type>::value;
- /**
- * @brief Extracts the class of a non-static member object or function.
- * @tparam Member A pointer to a non-static member object or function.
- */
- template<typename Member>
- class member_class {
- static_assert(std::is_member_pointer_v<Member>, "Invalid pointer type to non-static member object or function");
- template<typename Class, typename Ret, typename... Args>
- static Class * clazz(Ret(Class:: *)(Args...));
- template<typename Class, typename Ret, typename... Args>
- static Class * clazz(Ret(Class:: *)(Args...) const);
- template<typename Class, typename Type>
- static Class * clazz(Type Class:: *);
- public:
- /*! @brief The class of the given non-static member object or function. */
- using type = std::remove_pointer_t<decltype(clazz(std::declval<Member>()))>;
- };
- /**
- * @brief Helper type.
- * @tparam Member A pointer to a non-static member object or function.
- */
- template<typename Member>
- using member_class_t = typename member_class<Member>::type;
- }
- #endif
- // #include "internal.hpp"
- #ifndef ENTT_META_INTERNAL_HPP
- #define ENTT_META_INTERNAL_HPP
- #include <cstddef>
- #include <functional>
- #include <iterator>
- #include <type_traits>
- #include <utility>
- // #include "../core/attribute.h"
- // #include "../config/config.h"
- // #include "../core/fwd.hpp"
- // #include "../core/type_info.hpp"
- // #include "../core/type_traits.hpp"
- // #include "type_traits.hpp"
- namespace entt {
- class meta_any;
- struct meta_handle;
- /**
- * @cond TURN_OFF_DOXYGEN
- * Internal details not to be documented.
- */
- namespace internal {
- class meta_storage {
- using storage_type = std::aligned_storage_t<sizeof(void *), alignof(void *)>;
- using copy_fn_type = void(meta_storage &, const meta_storage &);
- using steal_fn_type = void(meta_storage &, meta_storage &);
- using destroy_fn_type = void(meta_storage &);
- template<typename Type, typename = std::void_t<>>
- struct type_traits {
- template<typename... Args>
- static void instance(meta_storage &buffer, Args &&... args) {
- buffer.instance = new Type{std::forward<Args>(args)...};
- new (&buffer.storage) Type *{static_cast<Type *>(buffer.instance)};
- }
- static void destroy(meta_storage &buffer) {
- delete static_cast<Type *>(buffer.instance);
- }
- static void copy(meta_storage &to, const meta_storage &from) {
- to.instance = new Type{*static_cast<const Type *>(from.instance)};
- new (&to.storage) Type *{static_cast<Type *>(to.instance)};
- }
- static void steal(meta_storage &to, meta_storage &from) {
- new (&to.storage) Type *{static_cast<Type *>(from.instance)};
- to.instance = from.instance;
- }
- };
- template<typename Type>
- struct type_traits<Type, std::enable_if_t<sizeof(Type) <= sizeof(void *) && std::is_nothrow_move_constructible_v<Type>>> {
- template<typename... Args>
- static void instance(meta_storage &buffer, Args &&... args) {
- buffer.instance = new (&buffer.storage) Type{std::forward<Args>(args)...};
- }
- static void destroy(meta_storage &buffer) {
- static_cast<Type *>(buffer.instance)->~Type();
- }
- static void copy(meta_storage &to, const meta_storage &from) {
- to.instance = new (&to.storage) Type{*static_cast<const Type *>(from.instance)};
- }
- static void steal(meta_storage &to, meta_storage &from) {
- to.instance = new (&to.storage) Type{std::move(*static_cast<Type *>(from.instance))};
- destroy(from);
- }
- };
- public:
- /*! @brief Default constructor. */
- meta_storage() ENTT_NOEXCEPT
- : storage{},
- instance{},
- destroy_fn{},
- copy_fn{},
- steal_fn{}
- {}
- template<typename Type, typename... Args>
- explicit meta_storage(std::in_place_type_t<Type>, [[maybe_unused]] Args &&... args)
- : meta_storage{}
- {
- if constexpr(!std::is_void_v<Type>) {
- type_traits<Type>::instance(*this, std::forward<Args>(args)...);
- destroy_fn = &type_traits<Type>::destroy;
- copy_fn = &type_traits<Type>::copy;
- steal_fn = &type_traits<Type>::steal;
- }
- }
- template<typename Type>
- meta_storage(std::reference_wrapper<Type> value)
- : meta_storage{}
- {
- instance = &value.get();
- }
- template<typename Type, typename = std::enable_if_t<!std::is_same_v<std::remove_cv_t<std::remove_reference_t<Type>>, meta_storage>>>
- meta_storage(Type &&value)
- : meta_storage{std::in_place_type<std::remove_cv_t<std::remove_reference_t<Type>>>, std::forward<Type>(value)}
- {}
- meta_storage(const meta_storage &other)
- : meta_storage{}
- {
- (other.copy_fn ? other.copy_fn : [](auto &to, const auto &from) { to.instance = from.instance; })(*this, other);
- destroy_fn = other.destroy_fn;
- copy_fn = other.copy_fn;
- steal_fn = other.steal_fn;
- }
- meta_storage(meta_storage &&other)
- : meta_storage{}
- {
- swap(*this, other);
- }
- ~meta_storage() {
- if(destroy_fn) {
- destroy_fn(*this);
- }
- }
- meta_storage & operator=(meta_storage other) {
- swap(other, *this);
- return *this;
- }
- [[nodiscard]] const void * data() const ENTT_NOEXCEPT {
- return instance;
- }
- [[nodiscard]] void * data() ENTT_NOEXCEPT {
- return const_cast<void *>(std::as_const(*this).data());
- }
- template<typename Type, typename... Args>
- void emplace(Args &&... args) {
- *this = meta_storage{std::in_place_type<Type>, std::forward<Args>(args)...};
- }
- [[nodiscard]] meta_storage ref() const ENTT_NOEXCEPT {
- meta_storage other{};
- other.instance = instance;
- return other;
- }
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- return !(instance == nullptr);
- }
- friend void swap(meta_storage &lhs, meta_storage &rhs) {
- using std::swap;
- if(lhs.steal_fn && rhs.steal_fn) {
- meta_storage buffer{};
- lhs.steal_fn(buffer, lhs);
- rhs.steal_fn(lhs, rhs);
- lhs.steal_fn(rhs, buffer);
- } else if(lhs.steal_fn) {
- lhs.steal_fn(rhs, lhs);
- } else if(rhs.steal_fn) {
- rhs.steal_fn(lhs, rhs);
- } else {
- swap(lhs.instance, rhs.instance);
- }
- swap(lhs.destroy_fn, rhs.destroy_fn);
- swap(lhs.copy_fn, rhs.copy_fn);
- swap(lhs.steal_fn, rhs.steal_fn);
- }
- private:
- storage_type storage;
- void *instance;
- destroy_fn_type *destroy_fn;
- copy_fn_type *copy_fn;
- steal_fn_type *steal_fn;
- };
- struct meta_type_node;
- struct meta_prop_node {
- meta_prop_node * next;
- meta_any(* const key)();
- meta_any(* const value)();
- };
- struct meta_base_node {
- meta_type_node * const parent;
- meta_base_node * next;
- meta_type_node *(* const type)() ENTT_NOEXCEPT;
- const void *(* const cast)(const void *) ENTT_NOEXCEPT;
- };
- struct meta_conv_node {
- meta_type_node * const parent;
- meta_conv_node * next;
- meta_type_node *(* const type)() ENTT_NOEXCEPT;
- meta_any(* const conv)(const void *);
- };
- struct meta_ctor_node {
- using size_type = std::size_t;
- meta_type_node * const parent;
- meta_ctor_node * next;
- meta_prop_node * prop;
- const size_type size;
- meta_type_node *(* const arg)(size_type) ENTT_NOEXCEPT;
- meta_any(* const invoke)(meta_any * const);
- };
- struct meta_data_node {
- id_type id;
- meta_type_node * const parent;
- meta_data_node * next;
- meta_prop_node * prop;
- const bool is_static;
- meta_type_node *(* const type)() ENTT_NOEXCEPT;
- bool(* const set)(meta_handle, meta_any);
- meta_any(* const get)(meta_handle);
- };
- struct meta_func_node {
- using size_type = std::size_t;
- id_type id;
- meta_type_node * const parent;
- meta_func_node * next;
- meta_prop_node * prop;
- const size_type size;
- const bool is_const;
- const bool is_static;
- meta_type_node *(* const ret)() ENTT_NOEXCEPT;
- meta_type_node *(* const arg)(size_type) ENTT_NOEXCEPT;
- meta_any(* const invoke)(meta_handle, meta_any *);
- };
- struct meta_type_node {
- using size_type = std::size_t;
- const id_type type_id;
- id_type id;
- meta_type_node * next;
- meta_prop_node * prop;
- const bool is_void;
- const bool is_integral;
- const bool is_floating_point;
- const bool is_array;
- const bool is_enum;
- const bool is_union;
- const bool is_class;
- const bool is_pointer;
- const bool is_function_pointer;
- const bool is_member_object_pointer;
- const bool is_member_function_pointer;
- const bool is_pointer_like;
- const bool is_sequence_container;
- const bool is_associative_container;
- const size_type rank;
- size_type(* const extent)(size_type);
- bool(* const compare)(const void *, const void *);
- meta_type_node *(* const remove_pointer)() ENTT_NOEXCEPT;
- meta_type_node *(* const remove_extent)() ENTT_NOEXCEPT;
- meta_base_node *base{nullptr};
- meta_conv_node *conv{nullptr};
- meta_ctor_node *ctor{nullptr};
- meta_data_node *data{nullptr};
- meta_func_node *func{nullptr};
- void(* dtor)(void *){nullptr};
- };
- template<typename Node>
- class meta_range {
- struct range_iterator {
- using difference_type = std::ptrdiff_t;
- using value_type = Node;
- using pointer = value_type *;
- using reference = value_type &;
- using iterator_category = std::forward_iterator_tag;
- range_iterator() ENTT_NOEXCEPT = default;
- range_iterator(Node *head) ENTT_NOEXCEPT
- : node{head}
- {}
- range_iterator & operator++() ENTT_NOEXCEPT {
- return node = node->next, *this;
- }
- range_iterator operator++(int) ENTT_NOEXCEPT {
- range_iterator orig = *this;
- return ++(*this), orig;
- }
- [[nodiscard]] bool operator==(const range_iterator &other) const ENTT_NOEXCEPT {
- return other.node == node;
- }
- [[nodiscard]] bool operator!=(const range_iterator &other) const ENTT_NOEXCEPT {
- return !(*this == other);
- }
- [[nodiscard]] pointer operator->() const ENTT_NOEXCEPT {
- return node;
- }
- [[nodiscard]] reference operator*() const ENTT_NOEXCEPT {
- return *operator->();
- }
- private:
- Node *node{nullptr};
- };
- public:
- using iterator = range_iterator;
- meta_range() ENTT_NOEXCEPT = default;
- meta_range(Node *head)
- : node{head}
- {}
- [[nodiscard]] iterator begin() const ENTT_NOEXCEPT {
- return iterator{node};
- }
- [[nodiscard]] iterator end() const ENTT_NOEXCEPT {
- return iterator{};
- }
- private:
- Node *node{nullptr};
- };
- template<auto Member, typename Op>
- auto find_if(const Op &op, const meta_type_node *node)
- -> std::decay_t<decltype(node->*Member)> {
- std::decay_t<decltype(node->*Member)> ret = nullptr;
- for(auto &&curr: meta_range{node->*Member}) {
- if(op(&curr)) {
- ret = &curr;
- break;
- }
- }
- if(!ret) {
- for(auto &&curr: meta_range{node->base}) {
- if(ret = find_if<Member>(op, curr.type()); ret) {
- break;
- }
- }
- }
- return ret;
- }
- template<typename Type>
- class ENTT_API meta_node {
- static_assert(std::is_same_v<Type, std::remove_cv_t<std::remove_reference_t<Type>>>, "Invalid type");
- [[nodiscard]] static bool compare(const void *lhs, const void *rhs) {
- if constexpr(!std::is_function_v<Type> && is_equality_comparable_v<Type>) {
- return *static_cast<const Type *>(lhs) == *static_cast<const Type *>(rhs);
- } else {
- return lhs == rhs;
- }
- }
- template<std::size_t... Index>
- [[nodiscard]] static auto extent(meta_type_node::size_type dim, std::index_sequence<Index...>) {
- meta_type_node::size_type ext{};
- ((ext = (dim == Index ? std::extent_v<Type, Index> : ext)), ...);
- return ext;
- }
- public:
- [[nodiscard]] static meta_type_node * resolve() ENTT_NOEXCEPT {
- static meta_type_node node{
- type_info<Type>::id(),
- {},
- nullptr,
- nullptr,
- std::is_void_v<Type>,
- std::is_integral_v<Type>,
- std::is_floating_point_v<Type>,
- std::is_array_v<Type>,
- std::is_enum_v<Type>,
- std::is_union_v<Type>,
- std::is_class_v<Type>,
- std::is_pointer_v<Type>,
- std::is_pointer_v<Type> && std::is_function_v<std::remove_pointer_t<Type>>,
- std::is_member_object_pointer_v<Type>,
- std::is_member_function_pointer_v<Type>,
- is_meta_pointer_like_v<Type>,
- has_meta_sequence_container_traits_v<Type>,
- has_meta_associative_container_traits_v<Type>,
- std::rank_v<Type>,
- [](meta_type_node::size_type dim) {
- return extent(dim, std::make_index_sequence<std::rank_v<Type>>{});
- },
- &compare, // workaround for an issue with VS2017
- &meta_node<std::remove_const_t<std::remove_pointer_t<Type>>>::resolve,
- &meta_node<std::remove_const_t<std::remove_extent_t<Type>>>::resolve
- };
- return &node;
- }
- };
- template<typename... Type>
- struct meta_info: meta_node<std::remove_cv_t<std::remove_reference_t<Type>>...> {};
- }
- /**
- * Internal details not to be documented.
- * @endcond
- */
- }
- #endif
- // #include "meta.hpp"
- #ifndef ENTT_META_META_HPP
- #define ENTT_META_META_HPP
- #include <algorithm>
- #include <array>
- #include <cstddef>
- #include <iterator>
- #include <functional>
- #include <type_traits>
- #include <utility>
- // #include "../config/config.h"
- // #include "../core/fwd.hpp"
- // #include "../core/utility.hpp"
- #ifndef ENTT_CORE_UTILITY_HPP
- #define ENTT_CORE_UTILITY_HPP
- #include <utility>
- // #include "../config/config.h"
- namespace entt {
- /*! @brief Identity function object (waiting for C++20). */
- struct identity {
- /**
- * @brief Returns its argument unchanged.
- * @tparam Type Type of the argument.
- * @param value The actual argument.
- * @return The submitted value as-is.
- */
- template<class Type>
- [[nodiscard]] constexpr Type && operator()(Type &&value) const ENTT_NOEXCEPT {
- return std::forward<Type>(value);
- }
- };
- /**
- * @brief Constant utility to disambiguate overloaded members of a class.
- * @tparam Type Type of the desired overload.
- * @tparam Class Type of class to which the member belongs.
- * @param member A valid pointer to a member.
- * @return Pointer to the member.
- */
- template<typename Type, typename Class>
- [[nodiscard]] constexpr auto overload(Type Class:: *member) ENTT_NOEXCEPT { return member; }
- /**
- * @brief Constant utility to disambiguate overloaded functions.
- * @tparam Func Function type of the desired overload.
- * @param func A valid pointer to a function.
- * @return Pointer to the function.
- */
- template<typename Func>
- [[nodiscard]] constexpr auto overload(Func *func) ENTT_NOEXCEPT { return func; }
- /**
- * @brief Helper type for visitors.
- * @tparam Func Types of function objects.
- */
- template<class... Func>
- struct overloaded: Func... {
- using Func::operator()...;
- };
- /**
- * @brief Deduction guide.
- * @tparam Func Types of function objects.
- */
- template<class... Func>
- overloaded(Func...) -> overloaded<Func...>;
- /**
- * @brief Basic implementation of a y-combinator.
- * @tparam Func Type of a potentially recursive function.
- */
- template<class Func>
- struct y_combinator {
- /**
- * @brief Constructs a y-combinator from a given function.
- * @param recursive A potentially recursive function.
- */
- y_combinator(Func recursive):
- func{std::move(recursive)}
- {}
- /**
- * @brief Invokes a y-combinator and therefore its underlying function.
- * @tparam Args Types of arguments to use to invoke the underlying function.
- * @param args Parameters to use to invoke the underlying function.
- * @return Return value of the underlying function, if any.
- */
- template <class... Args>
- decltype(auto) operator()(Args &&... args) const {
- return func(*this, std::forward<Args>(args)...);
- }
- /*! @copydoc operator()() */
- template <class... Args>
- decltype(auto) operator()(Args &&... args) {
- return func(*this, std::forward<Args>(args)...);
- }
- private:
- Func func;
- };
- }
- #endif
- // #include "ctx.hpp"
- // #include "internal.hpp"
- // #include "range.hpp"
- #ifndef ENTT_META_RANGE_HPP
- #define ENTT_META_RANGE_HPP
- // #include "internal.hpp"
- namespace entt {
- /**
- * @brief Iterable range to use to iterate all types of meta objects.
- * @tparam Type Type of meta objects iterated.
- */
- template<typename Type>
- class meta_range {
- struct range_iterator {
- using difference_type = std::ptrdiff_t;
- using value_type = Type;
- using pointer = void;
- using reference = value_type;
- using iterator_category = std::input_iterator_tag;
- using node_type = typename Type::node_type;
- range_iterator() ENTT_NOEXCEPT = default;
- range_iterator(node_type *head) ENTT_NOEXCEPT
- : it{head}
- {}
- range_iterator & operator++() ENTT_NOEXCEPT {
- return ++it, *this;
- }
- range_iterator operator++(int) ENTT_NOEXCEPT {
- range_iterator orig = *this;
- return ++(*this), orig;
- }
- [[nodiscard]] reference operator*() const ENTT_NOEXCEPT {
- return it.operator->();
- }
- [[nodiscard]] bool operator==(const range_iterator &other) const ENTT_NOEXCEPT {
- return other.it == it;
- }
- [[nodiscard]] bool operator!=(const range_iterator &other) const ENTT_NOEXCEPT {
- return !(*this == other);
- }
- private:
- typename internal::meta_range<node_type>::iterator it{};
- };
- public:
- /*! @brief Node type. */
- using node_type = typename Type::node_type;
- /*! @brief Input iterator type. */
- using iterator = range_iterator;
- /*! @brief Default constructor. */
- meta_range() ENTT_NOEXCEPT = default;
- /**
- * @brief Constructs a meta range from a given node.
- * @param head The underlying node with which to construct the range.
- */
- meta_range(node_type *head)
- : node{head}
- {}
- /**
- * @brief Returns an iterator to the beginning.
- * @return An iterator to the first meta object of the range.
- */
- [[nodiscard]] iterator begin() const ENTT_NOEXCEPT {
- return iterator{node};
- }
- /**
- * @brief Returns an iterator to the end.
- * @return An iterator to the element following the last meta object of the
- * range.
- */
- [[nodiscard]] iterator end() const ENTT_NOEXCEPT {
- return iterator{};
- }
- private:
- node_type *node{nullptr};
- };
- }
- #endif
- // #include "type_traits.hpp"
- namespace entt {
- class meta_type;
- class meta_any;
- /*! @brief Proxy object for sequence containers. */
- class meta_sequence_container {
- template<typename>
- struct meta_sequence_container_proxy;
- class meta_iterator;
- public:
- /*! @brief Unsigned integer type. */
- using size_type = std::size_t;
- /*! @brief Meta iterator type. */
- using iterator = meta_iterator;
- /*! @brief Default constructor. */
- meta_sequence_container() ENTT_NOEXCEPT
- : instance{nullptr}
- {}
- /**
- * @brief Construct a proxy object for sequence containers.
- * @tparam Type Type of container to wrap.
- * @param container The container to wrap.
- */
- template<typename Type>
- meta_sequence_container(Type *container) ENTT_NOEXCEPT
- : value_type_fn{&meta_sequence_container_proxy<Type>::value_type},
- size_fn{&meta_sequence_container_proxy<Type>::size},
- resize_fn{&meta_sequence_container_proxy<Type>::resize},
- clear_fn{&meta_sequence_container_proxy<Type>::clear},
- begin_fn{&meta_sequence_container_proxy<Type>::begin},
- end_fn{&meta_sequence_container_proxy<Type>::end},
- insert_fn{&meta_sequence_container_proxy<Type>::insert},
- erase_fn{&meta_sequence_container_proxy<Type>::erase},
- get_fn{&meta_sequence_container_proxy<Type>::get},
- instance{container}
- {}
- [[nodiscard]] inline meta_type value_type() const ENTT_NOEXCEPT;
- [[nodiscard]] inline size_type size() const ENTT_NOEXCEPT;
- inline bool resize(size_type) const;
- inline bool clear();
- [[nodiscard]] inline iterator begin();
- [[nodiscard]] inline iterator end();
- inline std::pair<iterator, bool> insert(iterator, meta_any);
- inline std::pair<iterator, bool> erase(iterator);
- [[nodiscard]] inline meta_any operator[](size_type);
- [[nodiscard]] inline explicit operator bool() const ENTT_NOEXCEPT;
- private:
- meta_type(* value_type_fn)() ENTT_NOEXCEPT;
- size_type(* size_fn)(const void *) ENTT_NOEXCEPT;
- bool(* resize_fn)(void *, size_type);
- bool(* clear_fn)(void *);
- iterator(* begin_fn)(void *);
- iterator(* end_fn)(void *);
- std::pair<iterator, bool>(* insert_fn)(void *, iterator, meta_any);
- std::pair<iterator, bool>(* erase_fn)(void *, iterator);
- meta_any(* get_fn)(void *, size_type);
- void *instance;
- };
- /*! @brief Proxy object for associative containers. */
- class meta_associative_container {
- template<typename>
- struct meta_associative_container_proxy;
- class meta_iterator;
- public:
- /*! @brief Unsigned integer type. */
- using size_type = std::size_t;
- /*! @brief Meta iterator type. */
- using iterator = meta_iterator;
- /*! @brief Default constructor. */
- meta_associative_container() ENTT_NOEXCEPT
- : instance{nullptr}
- {}
- /**
- * @brief Construct a proxy object for associative containers.
- * @tparam Type Type of container to wrap.
- * @param container The container to wrap.
- */
- template<typename Type>
- meta_associative_container(Type *container) ENTT_NOEXCEPT
- : key_only_container{is_key_only_meta_associative_container_v<Type>},
- key_type_fn{&meta_associative_container_proxy<Type>::key_type},
- mapped_type_fn{&meta_associative_container_proxy<Type>::mapped_type},
- value_type_fn{&meta_associative_container_proxy<Type>::value_type},
- size_fn{&meta_associative_container_proxy<Type>::size},
- clear_fn{&meta_associative_container_proxy<Type>::clear},
- begin_fn{&meta_associative_container_proxy<Type>::begin},
- end_fn{&meta_associative_container_proxy<Type>::end},
- insert_fn{&meta_associative_container_proxy<Type>::insert},
- erase_fn{&meta_associative_container_proxy<Type>::erase},
- find_fn{&meta_associative_container_proxy<Type>::find},
- instance{container}
- {}
- [[nodiscard]] inline bool key_only() const ENTT_NOEXCEPT;
- [[nodiscard]] inline meta_type key_type() const ENTT_NOEXCEPT;
- [[nodiscard]] inline meta_type mapped_type() const ENTT_NOEXCEPT;
- [[nodiscard]] inline meta_type value_type() const ENTT_NOEXCEPT;
- [[nodiscard]] inline size_type size() const ENTT_NOEXCEPT;
- inline bool clear();
- [[nodiscard]] inline iterator begin();
- [[nodiscard]] inline iterator end();
- inline bool insert(meta_any, meta_any);
- inline bool erase(meta_any);
- [[nodiscard]] inline iterator find(meta_any);
- [[nodiscard]] inline explicit operator bool() const ENTT_NOEXCEPT;
- private:
- bool key_only_container;
- meta_type(* key_type_fn)() ENTT_NOEXCEPT;
- meta_type(* mapped_type_fn)() ENTT_NOEXCEPT;
- meta_type(* value_type_fn)() ENTT_NOEXCEPT;
- size_type(* size_fn)(const void *) ENTT_NOEXCEPT;
- bool(* clear_fn)(void *);
- iterator(* begin_fn)(void *);
- iterator(* end_fn)(void *);
- bool(* insert_fn)(void *, meta_any, meta_any);
- bool(* erase_fn)(void *, meta_any);
- iterator(* find_fn)(void *, meta_any);
- void *instance;
- };
- /**
- * @brief Opaque wrapper for values of any type.
- *
- * This class uses a technique called small buffer optimization (SBO) to get rid
- * of memory allocations if possible. This should improve overall performance.
- */
- class meta_any {
- using dereference_operator_type = meta_any(meta_any &);
- template<typename Type>
- [[nodiscard]] static meta_any dereference_operator(meta_any &any) {
- if constexpr(is_meta_pointer_like_v<Type>) {
- if constexpr(std::is_const_v<std::remove_reference_t<decltype(*std::declval<Type>())>>) {
- return *any.cast<Type>();
- } else {
- return std::ref(*any.cast<Type>());
- }
- } else {
- return {};
- }
- }
- template<typename Type>
- [[nodiscard]] static meta_sequence_container meta_sequence_container_factory([[maybe_unused]] void *container) ENTT_NOEXCEPT {
- if constexpr(has_meta_sequence_container_traits_v<Type>) {
- return static_cast<Type *>(container);
- } else {
- return {};
- }
- }
- template<typename Type>
- [[nodiscard]] static meta_associative_container meta_associative_container_factory([[maybe_unused]] void *container) ENTT_NOEXCEPT {
- if constexpr(has_meta_associative_container_traits_v<Type>) {
- return static_cast<Type *>(container);
- } else {
- return {};
- }
- }
- public:
- /*! @brief Default constructor. */
- meta_any() ENTT_NOEXCEPT
- : storage{},
- node{},
- deref{nullptr},
- seq_factory{nullptr},
- assoc_factory{nullptr}
- {}
- /**
- * @brief Constructs a meta any by directly initializing the new object.
- * @tparam Type Type of object to use to initialize the wrapper.
- * @tparam Args Types of arguments to use to construct the new instance.
- * @param args Parameters to use to construct the instance.
- */
- template<typename Type, typename... Args>
- explicit meta_any(std::in_place_type_t<Type>, [[maybe_unused]] Args &&... args)
- : storage(std::in_place_type<Type>, std::forward<Args>(args)...),
- node{internal::meta_info<Type>::resolve()},
- deref{&dereference_operator<Type>},
- seq_factory{&meta_sequence_container_factory<Type>},
- assoc_factory{&meta_associative_container_factory<Type>}
- {}
- /**
- * @brief Constructs a meta any that holds an unmanaged object.
- * @tparam Type Type of object to use to initialize the wrapper.
- * @param value An instance of an object to use to initialize the wrapper.
- */
- template<typename Type>
- meta_any(std::reference_wrapper<Type> value)
- : storage{value},
- node{internal::meta_info<Type>::resolve()},
- deref{&dereference_operator<Type>},
- seq_factory{&meta_sequence_container_factory<Type>},
- assoc_factory{&meta_associative_container_factory<Type>}
- {}
- /**
- * @brief Constructs a meta any from a given value.
- * @tparam Type Type of object to use to initialize the wrapper.
- * @param value An instance of an object to use to initialize the wrapper.
- */
- template<typename Type, typename = std::enable_if_t<!std::is_same_v<std::remove_cv_t<std::remove_reference_t<Type>>, meta_any>>>
- meta_any(Type &&value)
- : meta_any{std::in_place_type<std::remove_cv_t<std::remove_reference_t<Type>>>, std::forward<Type>(value)}
- {}
- /**
- * @brief Copy constructor.
- * @param other The instance to copy from.
- */
- meta_any(const meta_any &other) = default;
- /**
- * @brief Move constructor.
- * @param other The instance to move from.
- */
- meta_any(meta_any &&other)
- : meta_any{}
- {
- swap(*this, other);
- }
- /*! @brief Frees the internal storage, whatever it means. */
- ~meta_any() {
- if(node && node->dtor) {
- node->dtor(storage.data());
- }
- }
- /**
- * @brief Assignment operator.
- * @param other The instance to assign from.
- * @return This meta any object.
- */
- meta_any & operator=(meta_any other) {
- swap(other, *this);
- return *this;
- }
- /**
- * @brief Returns the meta type of the underlying object.
- * @return The meta type of the underlying object, if any.
- */
- [[nodiscard]] inline meta_type type() const ENTT_NOEXCEPT;
- /**
- * @brief Returns an opaque pointer to the contained instance.
- * @return An opaque pointer the contained instance, if any.
- */
- [[nodiscard]] const void * data() const ENTT_NOEXCEPT {
- return storage.data();
- }
- /*! @copydoc data */
- [[nodiscard]] void * data() ENTT_NOEXCEPT {
- return storage.data();
- }
- /**
- * @brief Tries to cast an instance to a given type.
- * @tparam Type Type to which to cast the instance.
- * @return A (possibly null) pointer to the contained instance.
- */
- template<typename Type>
- [[nodiscard]] const Type * try_cast() const {
- if(node) {
- if(const auto type_id = internal::meta_info<Type>::resolve()->type_id; node->type_id == type_id) {
- return static_cast<const Type *>(storage.data());
- } else if(const auto *base = internal::find_if<&internal::meta_type_node::base>([type_id](const auto *curr) { return curr->type()->type_id == type_id; }, node); base) {
- return static_cast<const Type *>(base->cast(storage.data()));
- }
- }
- return nullptr;
- }
- /*! @copydoc try_cast */
- template<typename Type>
- [[nodiscard]] Type * try_cast() {
- return const_cast<Type *>(std::as_const(*this).try_cast<Type>());
- }
- /**
- * @brief Tries to cast an instance to a given type.
- *
- * The type of the instance must be such that the cast is possible.
- *
- * @warning
- * Attempting to perform a cast that isn't viable results in undefined
- * behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode in case
- * the cast is not feasible.
- *
- * @tparam Type Type to which to cast the instance.
- * @return A reference to the contained instance.
- */
- template<typename Type>
- [[nodiscard]] const Type & cast() const {
- auto * const actual = try_cast<Type>();
- ENTT_ASSERT(actual);
- return *actual;
- }
- /*! @copydoc cast */
- template<typename Type>
- [[nodiscard]] Type & cast() {
- return const_cast<Type &>(std::as_const(*this).cast<Type>());
- }
- /**
- * @brief Tries to convert an instance to a given type and returns it.
- * @tparam Type Type to which to convert the instance.
- * @return A valid meta any object if the conversion is possible, an invalid
- * one otherwise.
- */
- template<typename Type>
- [[nodiscard]] meta_any convert() const {
- if(node) {
- if(const auto type_id = internal::meta_info<Type>::resolve()->type_id; node->type_id == type_id) {
- return *this;
- } else if(const auto * const conv = internal::find_if<&internal::meta_type_node::conv>([type_id](const auto *curr) { return curr->type()->type_id == type_id; }, node); conv) {
- return conv->conv(storage.data());
- }
- }
- return {};
- }
- /**
- * @brief Tries to convert an instance to a given type.
- * @tparam Type Type to which to convert the instance.
- * @return True if the conversion is possible, false otherwise.
- */
- template<typename Type>
- bool convert() {
- bool valid = (node && node->type_id == internal::meta_info<Type>::resolve()->type_id);
- if(!valid) {
- if(auto any = std::as_const(*this).convert<Type>(); any) {
- swap(any, *this);
- valid = true;
- }
- }
- return valid;
- }
- /**
- * @brief Replaces the contained object by creating a new instance directly.
- * @tparam Type Type of object to use to initialize the wrapper.
- * @tparam Args Types of arguments to use to construct the new instance.
- * @param args Parameters to use to construct the instance.
- */
- template<typename Type, typename... Args>
- void emplace(Args &&... args) {
- *this = meta_any{std::in_place_type<Type>, std::forward<Args>(args)...};
- }
- /**
- * @brief Aliasing constructor.
- * @return A meta any that shares a reference to an unmanaged object.
- */
- [[nodiscard]] meta_any ref() const ENTT_NOEXCEPT {
- meta_any other{};
- other.node = node;
- other.storage = storage.ref();
- other.deref = deref;
- other.seq_factory = seq_factory;
- other.assoc_factory = assoc_factory;
- return other;
- }
- /**
- * @brief Returns a sequence container proxy.
- * @return A sequence container proxy for the underlying object.
- */
- [[nodiscard]] meta_sequence_container as_sequence_container() ENTT_NOEXCEPT {
- return seq_factory(storage.data());
- }
- /**
- * @brief Returns an associative container proxy.
- * @return An associative container proxy for the underlying object.
- */
- [[nodiscard]] meta_associative_container as_associative_container() ENTT_NOEXCEPT {
- return assoc_factory(storage.data());
- }
- /**
- * @brief Indirection operator for dereferencing opaque objects.
- * @return A meta any that shares a reference to an unmanaged object if the
- * wrapped element is dereferenceable, an invalid meta any otherwise.
- */
- [[nodiscard]] meta_any operator*() ENTT_NOEXCEPT {
- return deref(*this);
- }
- /**
- * @brief Returns false if a wrapper is empty, true otherwise.
- * @return False if the wrapper is empty, true otherwise.
- */
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- return !(node == nullptr);
- }
- /**
- * @brief Checks if two wrappers differ in their content.
- * @param other Wrapper with which to compare.
- * @return False if the two objects differ in their content, true otherwise.
- */
- [[nodiscard]] bool operator==(const meta_any &other) const {
- return (!node && !other.node) || (node && other.node && node->type_id == other.node->type_id && node->compare(storage.data(), other.storage.data()));
- }
- /**
- * @brief Swaps two meta any objects.
- * @param lhs A valid meta any object.
- * @param rhs A valid meta any object.
- */
- friend void swap(meta_any &lhs, meta_any &rhs) {
- using std::swap;
- swap(lhs.storage, rhs.storage);
- swap(lhs.node, rhs.node);
- swap(lhs.deref, rhs.deref);
- swap(lhs.seq_factory, rhs.seq_factory);
- swap(lhs.assoc_factory, rhs.assoc_factory);
- }
- private:
- internal::meta_storage storage;
- internal::meta_type_node *node;
- dereference_operator_type *deref;
- meta_sequence_container(* seq_factory)(void *);
- meta_associative_container(* assoc_factory)(void *);
- };
- /**
- * @brief Checks if two wrappers differ in their content.
- * @param lhs A meta any object, either empty or not.
- * @param rhs A meta any object, either empty or not.
- * @return True if the two wrappers differ in their content, false otherwise.
- */
- [[nodiscard]] inline bool operator!=(const meta_any &lhs, const meta_any &rhs) ENTT_NOEXCEPT {
- return !(lhs == rhs);
- }
- /**
- * @brief Opaque pointers to instances of any type.
- *
- * A handle doesn't perform copies and isn't responsible for the contained
- * object. It doesn't prolong the lifetime of the pointed instance.<br/>
- * Handles are used to generate meta references to actual objects when needed.
- */
- struct meta_handle {
- /*! @brief Default constructor. */
- meta_handle() = default;
- /**
- * @brief Creates a handle that points to an unmanaged object.
- * @tparam Type Type of object to use to initialize the handle.
- * @param value An instance of an object to use to initialize the handle.
- */
- template<typename Type, typename = std::enable_if_t<!std::is_same_v<std::remove_cv_t<std::remove_reference_t<Type>>, meta_handle>>>
- meta_handle(Type &&value) ENTT_NOEXCEPT
- : meta_handle{}
- {
- if constexpr(std::is_same_v<std::remove_cv_t<std::remove_reference_t<Type>>, meta_any>) {
- any = value.ref();
- } else {
- static_assert(std::is_lvalue_reference_v<Type>, "Lvalue reference required");
- any = std::ref(value);
- }
- }
- /**
- * @brief Dereference operator for accessing the contained opaque object.
- * @return A meta any that shares a reference to an unmanaged object.
- */
- [[nodiscard]] meta_any operator*() const {
- return any;
- }
- /**
- * @brief Access operator for accessing the contained opaque object.
- * @return A meta any that shares a reference to an unmanaged object.
- */
- [[nodiscard]] meta_any * operator->() {
- return &any;
- }
- private:
- meta_any any;
- };
- /*! @brief Opaque wrapper for meta properties of any type. */
- struct meta_prop {
- /*! @brief Node type. */
- using node_type = internal::meta_prop_node;
- /**
- * @brief Constructs an instance from a given node.
- * @param curr The underlying node with which to construct the instance.
- */
- meta_prop(const node_type *curr = nullptr) ENTT_NOEXCEPT
- : node{curr}
- {}
- /**
- * @brief Returns the stored key.
- * @return A meta any containing the key stored with the property.
- */
- [[nodiscard]] meta_any key() const {
- return node->key();
- }
- /**
- * @brief Returns the stored value.
- * @return A meta any containing the value stored with the property.
- */
- [[nodiscard]] meta_any value() const {
- return node->value();
- }
- /**
- * @brief Returns true if a meta object is valid, false otherwise.
- * @return True if the meta object is valid, false otherwise.
- */
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- return !(node == nullptr);
- }
- private:
- const node_type *node;
- };
- /*! @brief Opaque wrapper for meta base classes. */
- struct meta_base {
- /*! @brief Node type. */
- using node_type = internal::meta_base_node;
- /*! @copydoc meta_prop::meta_prop */
- meta_base(const node_type *curr = nullptr) ENTT_NOEXCEPT
- : node{curr}
- {}
- /**
- * @brief Returns the meta type to which a meta object belongs.
- * @return The meta type to which the meta object belongs.
- */
- [[nodiscard]] inline meta_type parent() const ENTT_NOEXCEPT;
- /*! @copydoc meta_any::type */
- [[nodiscard]] inline meta_type type() const ENTT_NOEXCEPT;
- /**
- * @brief Casts an instance from a parent type to a base type.
- * @param instance The instance to cast.
- * @return An opaque pointer to the base type.
- */
- [[nodiscard]] const void * cast(const void *instance) const ENTT_NOEXCEPT {
- return node->cast(instance);
- }
- /**
- * @brief Returns true if a meta object is valid, false otherwise.
- * @return True if the meta object is valid, false otherwise.
- */
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- return !(node == nullptr);
- }
- private:
- const node_type *node;
- };
- /*! @brief Opaque wrapper for meta conversion functions. */
- struct meta_conv {
- /*! @brief Node type. */
- using node_type = internal::meta_conv_node;
- /*! @copydoc meta_prop::meta_prop */
- meta_conv(const node_type *curr = nullptr) ENTT_NOEXCEPT
- : node{curr}
- {}
- /*! @copydoc meta_base::parent */
- [[nodiscard]] inline meta_type parent() const ENTT_NOEXCEPT;
- /*! @copydoc meta_any::type */
- [[nodiscard]] inline meta_type type() const ENTT_NOEXCEPT;
- /**
- * @brief Converts an instance to the underlying type.
- * @param instance The instance to convert.
- * @return An opaque pointer to the instance to convert.
- */
- [[nodiscard]] meta_any convert(const void *instance) const {
- return node->conv(instance);
- }
- /**
- * @brief Returns true if a meta object is valid, false otherwise.
- * @return True if the meta object is valid, false otherwise.
- */
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- return !(node == nullptr);
- }
- private:
- const node_type *node;
- };
- /*! @brief Opaque wrapper for meta constructors. */
- struct meta_ctor {
- /*! @brief Node type. */
- using node_type = internal::meta_ctor_node;
- /*! @brief Unsigned integer type. */
- using size_type = typename node_type::size_type;
- /*! @copydoc meta_prop::meta_prop */
- meta_ctor(const node_type *curr = nullptr) ENTT_NOEXCEPT
- : node{curr}
- {}
- /*! @copydoc meta_base::parent */
- [[nodiscard]] inline meta_type parent() const ENTT_NOEXCEPT;
- /**
- * @brief Returns the number of arguments accepted by a meta constructor.
- * @return The number of arguments accepted by the meta constructor.
- */
- [[nodiscard]] size_type size() const ENTT_NOEXCEPT {
- return node->size;
- }
- /**
- * @brief Returns the meta type of the i-th argument of a meta constructor.
- * @param index The index of the argument of which to return the meta type.
- * @return The meta type of the i-th argument of a meta constructor, if any.
- */
- [[nodiscard]] meta_type arg(size_type index) const ENTT_NOEXCEPT;
- /**
- * @brief Creates an instance of the underlying type, if possible.
- *
- * To create a valid instance, the parameters must be such that a cast or
- * conversion to the required types is possible. Otherwise, an empty and
- * thus invalid wrapper is returned.
- *
- * @param args Parameters to use to construct the instance.
- * @param sz Number of parameters to use to construct the instance.
- * @return A meta any containing the new instance, if any.
- */
- [[nodiscard]] meta_any invoke(meta_any * const args, const std::size_t sz) const {
- return sz == size() ? node->invoke(args) : meta_any{};
- }
- /**
- * @copybrief invoke
- *
- * @sa invoke
- *
- * @tparam Args Types of arguments to use to construct the instance.
- * @param args Parameters to use to construct the instance.
- * @return A meta any containing the new instance, if any.
- */
- template<typename... Args>
- [[nodiscard]] meta_any invoke([[maybe_unused]] Args &&... args) const {
- std::array<meta_any, sizeof...(Args)> arguments{std::forward<Args>(args)...};
- return invoke(arguments.data(), sizeof...(Args));
- }
- /**
- * @brief Returns a range to use to visit all meta properties.
- * @return An iterable range to use to visit all meta properties.
- */
- [[nodiscard]] meta_range<meta_prop> prop() const ENTT_NOEXCEPT {
- return node->prop;
- }
- /**
- * @brief Returns the property associated with a given key.
- * @param key The key to use to search for a property.
- * @return The property associated with the given key, if any.
- */
- [[nodiscard]] meta_prop prop(meta_any key) const {
- internal::meta_range range{node->prop};
- return std::find_if(range.begin(), range.end(), [&key](const auto &curr) { return curr.key() == key; }).operator->();
- }
- /**
- * @brief Returns true if a meta object is valid, false otherwise.
- * @return True if the meta object is valid, false otherwise.
- */
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- return !(node == nullptr);
- }
- private:
- const node_type *node;
- };
- /*! @brief Opaque wrapper for meta data. */
- struct meta_data {
- /*! @brief Node type. */
- using node_type = internal::meta_data_node;
- /*! @copydoc meta_prop::meta_prop */
- meta_data(const node_type *curr = nullptr) ENTT_NOEXCEPT
- : node{curr}
- {}
- /*! @copydoc meta_type::id */
- [[nodiscard]] id_type id() const ENTT_NOEXCEPT {
- return node->id;
- }
- /*! @copydoc meta_base::parent */
- [[nodiscard]] inline meta_type parent() const ENTT_NOEXCEPT;
- /**
- * @brief Indicates whether a meta data is constant or not.
- * @return True if the meta data is constant, false otherwise.
- */
- [[nodiscard]] bool is_const() const ENTT_NOEXCEPT {
- return (node->set == nullptr);
- }
- /**
- * @brief Indicates whether a meta data is static or not.
- * @return True if the meta data is static, false otherwise.
- */
- [[nodiscard]] bool is_static() const ENTT_NOEXCEPT {
- return node->is_static;
- }
- /*! @copydoc meta_any::type */
- [[nodiscard]] inline meta_type type() const ENTT_NOEXCEPT;
- /**
- * @brief Sets the value of a given variable.
- *
- * It must be possible to cast the instance to the parent type of the meta
- * data. Otherwise, invoking the setter results in an undefined
- * behavior.<br/>
- * The type of the value must be such that a cast or conversion to the type
- * of the variable is possible. Otherwise, invoking the setter does nothing.
- *
- * @tparam Type Type of value to assign.
- * @param instance An opaque instance of the underlying type.
- * @param value Parameter to use to set the underlying variable.
- * @return True in case of success, false otherwise.
- */
- template<typename Type>
- bool set(meta_handle instance, Type &&value) const {
- return node->set && node->set(std::move(instance), std::forward<Type>(value));
- }
- /**
- * @brief Gets the value of a given variable.
- *
- * It must be possible to cast the instance to the parent type of the meta
- * data. Otherwise, invoking the getter results in an undefined behavior.
- *
- * @param instance An opaque instance of the underlying type.
- * @return A meta any containing the value of the underlying variable.
- */
- [[nodiscard]] meta_any get(meta_handle instance) const {
- return node->get(std::move(instance));
- }
- /*! @copydoc meta_ctor::prop */
- [[nodiscard]] meta_range<meta_prop> prop() const ENTT_NOEXCEPT {
- return node->prop;
- }
- /**
- * @brief Returns the property associated with a given key.
- * @param key The key to use to search for a property.
- * @return The property associated with the given key, if any.
- */
- [[nodiscard]] meta_prop prop(meta_any key) const {
- internal::meta_range range{node->prop};
- return std::find_if(range.begin(), range.end(), [&key](const auto &curr) { return curr.key() == key; }).operator->();
- }
- /**
- * @brief Returns true if a meta object is valid, false otherwise.
- * @return True if the meta object is valid, false otherwise.
- */
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- return !(node == nullptr);
- }
- private:
- const node_type *node;
- };
- /*! @brief Opaque wrapper for meta functions. */
- struct meta_func {
- /*! @brief Node type. */
- using node_type = internal::meta_func_node;
- /*! @brief Unsigned integer type. */
- using size_type = typename node_type::size_type;
- /*! @copydoc meta_prop::meta_prop */
- meta_func(const node_type *curr = nullptr) ENTT_NOEXCEPT
- : node{curr}
- {}
- /*! @copydoc meta_type::id */
- [[nodiscard]] id_type id() const ENTT_NOEXCEPT {
- return node->id;
- }
- /*! @copydoc meta_base::parent */
- [[nodiscard]] inline meta_type parent() const ENTT_NOEXCEPT;
- /**
- * @brief Returns the number of arguments accepted by a meta function.
- * @return The number of arguments accepted by the meta function.
- */
- [[nodiscard]] size_type size() const ENTT_NOEXCEPT {
- return node->size;
- }
- /**
- * @brief Indicates whether a meta function is constant or not.
- * @return True if the meta function is constant, false otherwise.
- */
- [[nodiscard]] bool is_const() const ENTT_NOEXCEPT {
- return node->is_const;
- }
- /**
- * @brief Indicates whether a meta function is static or not.
- * @return True if the meta function is static, false otherwise.
- */
- [[nodiscard]] bool is_static() const ENTT_NOEXCEPT {
- return node->is_static;
- }
- /**
- * @brief Returns the meta type of the return type of a meta function.
- * @return The meta type of the return type of the meta function.
- */
- [[nodiscard]] inline meta_type ret() const ENTT_NOEXCEPT;
- /**
- * @brief Returns the meta type of the i-th argument of a meta function.
- * @param index The index of the argument of which to return the meta type.
- * @return The meta type of the i-th argument of a meta function, if any.
- */
- [[nodiscard]] inline meta_type arg(size_type index) const ENTT_NOEXCEPT;
- /**
- * @brief Invokes the underlying function, if possible.
- *
- * To invoke a meta function, the parameters must be such that a cast or
- * conversion to the required types is possible. Otherwise, an empty and
- * thus invalid wrapper is returned.<br/>
- * It must be possible to cast the instance to the parent type of the meta
- * function. Otherwise, invoking the underlying function results in an
- * undefined behavior.
- *
- * @param instance An opaque instance of the underlying type.
- * @param args Parameters to use to invoke the function.
- * @param sz Number of parameters to use to invoke the function.
- * @return A meta any containing the returned value, if any.
- */
- [[nodiscard]] meta_any invoke(meta_handle instance, meta_any * const args, const std::size_t sz) const {
- return sz == size() ? node->invoke(instance, args) : meta_any{};
- }
- /**
- * @copybrief invoke
- *
- * @sa invoke
- *
- * @tparam Args Types of arguments to use to invoke the function.
- * @param instance An opaque instance of the underlying type.
- * @param args Parameters to use to invoke the function.
- * @return A meta any containing the new instance, if any.
- */
- template<typename... Args>
- meta_any invoke(meta_handle instance, Args &&... args) const {
- std::array<meta_any, sizeof...(Args)> arguments{std::forward<Args>(args)...};
- return invoke(instance, arguments.data(), sizeof...(Args));
- }
- /*! @copydoc meta_ctor::prop */
- [[nodiscard]] meta_range<meta_prop> prop() const ENTT_NOEXCEPT {
- return node->prop;
- }
- /**
- * @brief Returns the property associated with a given key.
- * @param key The key to use to search for a property.
- * @return The property associated with the given key, if any.
- */
- [[nodiscard]] meta_prop prop(meta_any key) const {
- internal::meta_range range{node->prop};
- return std::find_if(range.begin(), range.end(), [&key](const auto &curr) { return curr.key() == key; }).operator->();
- }
- /**
- * @brief Returns true if a meta object is valid, false otherwise.
- * @return True if the meta object is valid, false otherwise.
- */
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- return !(node == nullptr);
- }
- private:
- const node_type *node;
- };
- /*! @brief Opaque wrapper for meta types. */
- class meta_type {
- template<typename... Args, std::size_t... Indexes>
- [[nodiscard]] auto ctor(std::index_sequence<Indexes...>) const {
- internal::meta_range range{node->ctor};
- return std::find_if(range.begin(), range.end(), [](const auto &candidate) {
- return candidate.size == sizeof...(Args) && ([](auto *from, auto *to) {
- return (from->type_id == to->type_id)
- || internal::find_if<&node_type::base>([to](const auto *curr) { return curr->type()->type_id == to->type_id; }, from)
- || internal::find_if<&node_type::conv>([to](const auto *curr) { return curr->type()->type_id == to->type_id; }, from);
- }(internal::meta_info<Args>::resolve(), candidate.arg(Indexes)) && ...);
- }).operator->();
- }
- public:
- /*! @brief Node type. */
- using node_type = internal::meta_type_node;
- /*! @brief Unsigned integer type. */
- using size_type = typename node_type::size_type;
- /*! @copydoc meta_prop::meta_prop */
- meta_type(node_type *curr = nullptr) ENTT_NOEXCEPT
- : node{curr}
- {}
- /**
- * @brief Returns the type id of the underlying type.
- * @return The type id of the underlying type.
- */
- [[nodiscard]] id_type type_id() const ENTT_NOEXCEPT {
- return node->type_id;
- }
- /**
- * @brief Returns the identifier assigned to a meta object.
- * @return The identifier assigned to the meta object.
- */
- [[nodiscard]] id_type id() const ENTT_NOEXCEPT {
- return node->id;
- }
- /**
- * @brief Checks whether a type refers to void or not.
- * @return True if the underlying type is void, false otherwise.
- */
- [[nodiscard]] bool is_void() const ENTT_NOEXCEPT {
- return node->is_void;
- }
- /**
- * @brief Checks whether a type refers to an integral type or not.
- * @return True if the underlying type is an integral type, false otherwise.
- */
- [[nodiscard]] bool is_integral() const ENTT_NOEXCEPT {
- return node->is_integral;
- }
- /**
- * @brief Checks whether a type refers to a floating-point type or not.
- * @return True if the underlying type is a floating-point type, false
- * otherwise.
- */
- [[nodiscard]] bool is_floating_point() const ENTT_NOEXCEPT {
- return node->is_floating_point;
- }
- /**
- * @brief Checks whether a type refers to an array type or not.
- * @return True if the underlying type is an array type, false otherwise.
- */
- [[nodiscard]] bool is_array() const ENTT_NOEXCEPT {
- return node->is_array;
- }
- /**
- * @brief Checks whether a type refers to an enum or not.
- * @return True if the underlying type is an enum, false otherwise.
- */
- [[nodiscard]] bool is_enum() const ENTT_NOEXCEPT {
- return node->is_enum;
- }
- /**
- * @brief Checks whether a type refers to an union or not.
- * @return True if the underlying type is an union, false otherwise.
- */
- [[nodiscard]] bool is_union() const ENTT_NOEXCEPT {
- return node->is_union;
- }
- /**
- * @brief Checks whether a type refers to a class or not.
- * @return True if the underlying type is a class, false otherwise.
- */
- [[nodiscard]] bool is_class() const ENTT_NOEXCEPT {
- return node->is_class;
- }
- /**
- * @brief Checks whether a type refers to a pointer or not.
- * @return True if the underlying type is a pointer, false otherwise.
- */
- [[nodiscard]] bool is_pointer() const ENTT_NOEXCEPT {
- return node->is_pointer;
- }
- /**
- * @brief Checks whether a type refers to a function pointer or not.
- * @return True if the underlying type is a function pointer, false
- * otherwise.
- */
- [[nodiscard]] bool is_function_pointer() const ENTT_NOEXCEPT {
- return node->is_function_pointer;
- }
- /**
- * @brief Checks whether a type refers to a pointer to data member or not.
- * @return True if the underlying type is a pointer to data member, false
- * otherwise.
- */
- [[nodiscard]] bool is_member_object_pointer() const ENTT_NOEXCEPT {
- return node->is_member_object_pointer;
- }
- /**
- * @brief Checks whether a type refers to a pointer to member function or
- * not.
- * @return True if the underlying type is a pointer to member function,
- * false otherwise.
- */
- [[nodiscard]] bool is_member_function_pointer() const ENTT_NOEXCEPT {
- return node->is_member_function_pointer;
- }
- /**
- * @brief Checks whether a type is a pointer-like type or not.
- * @return True if the underlying type is a pointer-like one, false
- * otherwise.
- */
- [[nodiscard]] bool is_pointer_like() const ENTT_NOEXCEPT {
- return node->is_pointer_like;
- }
- /**
- * @brief Checks whether a type refers to a sequence container or not.
- * @return True if the underlying type is a sequence container, false
- * otherwise.
- */
- [[nodiscard]] bool is_sequence_container() const ENTT_NOEXCEPT {
- return node->is_sequence_container;
- }
- /**
- * @brief Checks whether a type refers to an associative container or not.
- * @return True if the underlying type is an associative container, false
- * otherwise.
- */
- [[nodiscard]] bool is_associative_container() const ENTT_NOEXCEPT {
- return node->is_associative_container;
- }
- /**
- * @brief If a type refers to an array type, provides the number of
- * dimensions of the array.
- * @return The number of dimensions of the array if the underlying type is
- * an array type, 0 otherwise.
- */
- [[nodiscard]] size_type rank() const ENTT_NOEXCEPT {
- return node->rank;
- }
- /**
- * @brief If a type refers to an array type, provides the number of elements
- * along the given dimension of the array.
- * @param dim The dimension of which to return the number of elements.
- * @return The number of elements along the given dimension of the array if
- * the underlying type is an array type, 0 otherwise.
- */
- [[nodiscard]] size_type extent(size_type dim = {}) const ENTT_NOEXCEPT {
- return node->extent(dim);
- }
- /**
- * @brief Provides the meta type for which the pointer is defined.
- * @return The meta type for which the pointer is defined or this meta type
- * if it doesn't refer to a pointer type.
- */
- [[nodiscard]] meta_type remove_pointer() const ENTT_NOEXCEPT {
- return node->remove_pointer();
- }
- /**
- * @brief Provides the meta type for which the array is defined.
- * @return The meta type for which the array is defined or this meta type
- * if it doesn't refer to an array type.
- */
- [[nodiscard]] meta_type remove_extent() const ENTT_NOEXCEPT {
- return node->remove_extent();
- }
- /**
- * @brief Returns a range to use to visit top-level meta bases.
- * @return An iterable range to use to visit top-level meta bases.
- */
- [[nodiscard]] meta_range<meta_base> base() const ENTT_NOEXCEPT {
- return node->base;
- }
- /**
- * @brief Returns the meta base associated with a given identifier.
- * @param id Unique identifier.
- * @return The meta base associated with the given identifier, if any.
- */
- [[nodiscard]] meta_base base(const id_type id) const {
- return internal::find_if<&node_type::base>([id](const auto *curr) {
- return curr->type()->id == id;
- }, node);
- }
- /**
- * @brief Returns a range to use to visit top-level meta conversion
- * functions.
- * @return An iterable range to use to visit top-level meta conversion
- * functions.
- */
- [[nodiscard]] meta_range<meta_conv> conv() const ENTT_NOEXCEPT {
- return node->conv;
- }
- /**
- * @brief Returns the meta conversion function associated with a given type.
- * @tparam Type The type to use to search for a meta conversion function.
- * @return The meta conversion function associated with the given type, if
- * any.
- */
- template<typename Type>
- [[nodiscard]] meta_conv conv() const {
- return internal::find_if<&node_type::conv>([type_id = internal::meta_info<Type>::resolve()->type_id](const auto *curr) {
- return curr->type()->type_id == type_id;
- }, node);
- }
- /**
- * @brief Returns a range to use to visit top-level meta constructors.
- * @return An iterable range to use to visit top-level meta constructors.
- */
- [[nodiscard]] meta_range<meta_ctor> ctor() const ENTT_NOEXCEPT {
- return node->ctor;
- }
- /**
- * @brief Returns the meta constructor that accepts a given list of types of
- * arguments.
- * @return The requested meta constructor, if any.
- */
- template<typename... Args>
- [[nodiscard]] meta_ctor ctor() const {
- return ctor<Args...>(std::index_sequence_for<Args...>{});
- }
- /**
- * @brief Returns a range to use to visit top-level meta data.
- * @return An iterable range to use to visit top-level meta data.
- */
- [[nodiscard]] meta_range<meta_data> data() const ENTT_NOEXCEPT {
- return node->data;
- }
- /**
- * @brief Returns the meta data associated with a given identifier.
- *
- * The meta data of the base classes will also be visited, if any.
- *
- * @param id Unique identifier.
- * @return The meta data associated with the given identifier, if any.
- */
- [[nodiscard]] meta_data data(const id_type id) const {
- return internal::find_if<&node_type::data>([id](const auto *curr) {
- return curr->id == id;
- }, node);
- }
- /**
- * @brief Returns a range to use to visit top-level meta functions.
- * @return An iterable range to use to visit top-level meta functions.
- */
- [[nodiscard]] meta_range<meta_func> func() const ENTT_NOEXCEPT {
- return node->func;
- }
- /**
- * @brief Returns the meta function associated with a given identifier.
- *
- * The meta functions of the base classes will also be visited, if any.
- *
- * @param id Unique identifier.
- * @return The meta function associated with the given identifier, if any.
- */
- [[nodiscard]] meta_func func(const id_type id) const {
- return internal::find_if<&node_type::func>([id](const auto *curr) {
- return curr->id == id;
- }, node);
- }
- /**
- * @brief Creates an instance of the underlying type, if possible.
- *
- * To create a valid instance, the parameters must be such that a cast or
- * conversion to the required types is possible. Otherwise, an empty and
- * thus invalid wrapper is returned.
- *
- * @param args Parameters to use to construct the instance.
- * @param sz Number of parameters to use to construct the instance.
- * @return A meta any containing the new instance, if any.
- */
- [[nodiscard]] meta_any construct(meta_any * const args, const std::size_t sz) const {
- meta_any any{};
- internal::find_if<&node_type::ctor>([args, sz, &any](const auto *curr) {
- return (curr->size == sz) && (any = curr->invoke(args));
- }, node);
- return any;
- }
- /**
- * @copybrief construct
- *
- * @sa construct
- *
- * @tparam Args Types of arguments to use to construct the instance.
- * @param args Parameters to use to construct the instance.
- * @return A meta any containing the new instance, if any.
- */
- template<typename... Args>
- [[nodiscard]] meta_any construct(Args &&... args) const {
- std::array<meta_any, sizeof...(Args)> arguments{std::forward<Args>(args)...};
- return construct(arguments.data(), sizeof...(Args));
- }
- /**
- * @brief Returns a range to use to visit top-level meta properties.
- * @return An iterable range to use to visit top-level meta properties.
- */
- [[nodiscard]] meta_range<meta_prop> prop() const ENTT_NOEXCEPT {
- return node->prop;
- }
- /**
- * @brief Returns the property associated with a given key.
- *
- * Properties of the base classes will also be visited, if any.
- *
- * @param key The key to use to search for a property.
- * @return The property associated with the given key, if any.
- */
- [[nodiscard]] meta_prop prop(meta_any key) const {
- return internal::find_if<&node_type::prop>([key = std::move(key)](const auto *curr) {
- return curr->key() == key;
- }, node);
- }
- /**
- * @brief Returns true if a meta object is valid, false otherwise.
- * @return True if the meta object is valid, false otherwise.
- */
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- return !(node == nullptr);
- }
- /**
- * @brief Checks if two meta objects refer to the same type.
- * @param other The meta object with which to compare.
- * @return True if the two meta objects refer to the same type, false
- * otherwise.
- */
- [[nodiscard]] bool operator==(const meta_type &other) const ENTT_NOEXCEPT {
- return (!node && !other.node) || (node && other.node && node->type_id == other.node->type_id);
- }
- /**
- * @brief Resets a meta type and all its parts.
- *
- * This function resets a meta type and all its data members, member
- * functions and properties, as well as its constructors, destructors and
- * conversion functions if any.<br/>
- * Base classes aren't reset but the link between the two types is removed.
- *
- * The meta type is also removed from the list of searchable types.
- */
- void reset() ENTT_NOEXCEPT {
- auto** it = internal::meta_context::global();
- while (*it && *it != node) {
- it = &(*it)->next;
- }
- if(*it) {
- *it = (*it)->next;
- }
- const auto unregister_all = y_combinator{
- [](auto &&self, auto **curr, auto... member) {
- while(*curr) {
- auto *prev = *curr;
- (self(&(prev->*member)), ...);
- *curr = prev->next;
- prev->next = nullptr;
- }
- }
- };
-
- unregister_all(&node->prop);
- unregister_all(&node->base);
- unregister_all(&node->conv);
- unregister_all(&node->ctor, &internal::meta_ctor_node::prop);
- unregister_all(&node->data, &internal::meta_data_node::prop);
- unregister_all(&node->func, &internal::meta_func_node::prop);
-
- node->id = {};
- node->dtor = nullptr;
- }
- private:
- node_type *node;
- };
- /**
- * @brief Checks if two meta objects refer to the same type.
- * @param lhs A meta object, either valid or not.
- * @param rhs A meta object, either valid or not.
- * @return False if the two meta objects refer to the same node, true otherwise.
- */
- [[nodiscard]] inline bool operator!=(const meta_type &lhs, const meta_type &rhs) ENTT_NOEXCEPT {
- return !(lhs == rhs);
- }
- [[nodiscard]] inline meta_type meta_any::type() const ENTT_NOEXCEPT {
- return node;
- }
- [[nodiscard]] inline meta_type meta_base::parent() const ENTT_NOEXCEPT {
- return node->parent;
- }
- [[nodiscard]] inline meta_type meta_base::type() const ENTT_NOEXCEPT {
- return node->type();
- }
- [[nodiscard]] inline meta_type meta_conv::parent() const ENTT_NOEXCEPT {
- return node->parent;
- }
- [[nodiscard]] inline meta_type meta_conv::type() const ENTT_NOEXCEPT {
- return node->type();
- }
- [[nodiscard]] inline meta_type meta_ctor::parent() const ENTT_NOEXCEPT {
- return node->parent;
- }
- [[nodiscard]] inline meta_type meta_ctor::arg(size_type index) const ENTT_NOEXCEPT {
- return index < size() ? node->arg(index) : nullptr;
- }
- [[nodiscard]] inline meta_type meta_data::parent() const ENTT_NOEXCEPT {
- return node->parent;
- }
- [[nodiscard]] inline meta_type meta_data::type() const ENTT_NOEXCEPT {
- return node->type();
- }
- [[nodiscard]] inline meta_type meta_func::parent() const ENTT_NOEXCEPT {
- return node->parent;
- }
- [[nodiscard]] inline meta_type meta_func::ret() const ENTT_NOEXCEPT {
- return node->ret();
- }
- [[nodiscard]] inline meta_type meta_func::arg(size_type index) const ENTT_NOEXCEPT {
- return index < size() ? node->arg(index) : nullptr;
- }
- /*! @brief Opaque iterator for meta sequence containers. */
- class meta_sequence_container::meta_iterator {
- /*! @brief A meta sequence container can access the underlying iterator. */
- friend class meta_sequence_container;
- template<typename It>
- static void incr(meta_any any) {
- ++any.cast<It>();
- }
- template<typename It>
- [[nodiscard]] static meta_any deref(meta_any any) {
- if constexpr(std::is_const_v<std::remove_reference_t<decltype(*std::declval<It>())>>) {
- return *any.cast<It>();
- } else {
- return std::ref(*any.cast<It>());
- }
- }
- public:
- /*! @brief Signed integer type. */
- using difference_type = std::ptrdiff_t;
- /*! @brief Type of elements returned by the iterator. */
- using value_type = meta_any;
- /*! @brief Pointer type, `void` on purpose. */
- using pointer = void;
- /*! @brief Reference type, it is **not** an actual reference. */
- using reference = value_type;
- /*! @brief Iterator category. */
- using iterator_category = std::input_iterator_tag;
- /*! @brief Default constructor. */
- meta_iterator() ENTT_NOEXCEPT = default;
- /**
- * @brief Constructs a meta iterator from a given iterator.
- * @tparam It Type of actual iterator with which to build the meta iterator.
- * @param iter The actual iterator with which to build the meta iterator.
- */
- template<typename It>
- meta_iterator(It iter)
- : next_fn{&incr<It>},
- get_fn{&deref<It>},
- handle{std::move(iter)}
- {}
- /*! @brief Pre-increment operator. @return This iterator. */
- meta_iterator & operator++() ENTT_NOEXCEPT {
- return next_fn(handle.ref()), *this;
- }
- /*! @brief Post-increment operator. @return This iterator. */
- meta_iterator operator++(int) ENTT_NOEXCEPT {
- meta_iterator orig = *this;
- return ++(*this), orig;
- }
- /**
- * @brief Checks if two meta iterators refer to the same element.
- * @param other The meta iterator with which to compare.
- * @return True if the two meta iterators refer to the same element, false
- * otherwise.
- */
- [[nodiscard]] bool operator==(const meta_iterator &other) const ENTT_NOEXCEPT {
- return handle == other.handle;
- }
- /**
- * @brief Checks if two meta iterators refer to the same element.
- * @param other The meta iterator with which to compare.
- * @return False if the two meta iterators refer to the same element, true
- * otherwise.
- */
- [[nodiscard]] bool operator!=(const meta_iterator &other) const ENTT_NOEXCEPT {
- return !(*this == other);
- }
- /**
- * @brief Indirection operator.
- * @return The element to which the meta pointer points.
- */
- [[nodiscard]] reference operator*() const {
- return get_fn(handle.ref());
- }
- /**
- * @brief Returns false if an iterator is invalid, true otherwise.
- * @return False if the iterator is invalid, true otherwise.
- */
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- return static_cast<bool>(handle);
- }
- private:
- void(* next_fn)(meta_any);
- meta_any(* get_fn)(meta_any);
- meta_any handle;
- };
- template<typename Type>
- struct meta_sequence_container::meta_sequence_container_proxy {
- using traits_type = meta_sequence_container_traits<Type>;
- [[nodiscard]] static meta_type value_type() ENTT_NOEXCEPT {
- return internal::meta_info<typename traits_type::value_type>::resolve();
- }
- [[nodiscard]] static size_type size(const void *container) ENTT_NOEXCEPT {
- return traits_type::size(*static_cast<const Type *>(container));
- }
- [[nodiscard]] static bool resize(void *container, size_type sz) {
- return traits_type::resize(*static_cast<Type *>(container), sz);
- }
- [[nodiscard]] static bool clear(void *container) {
- return traits_type::clear(*static_cast<Type *>(container));
- }
- [[nodiscard]] static iterator begin(void *container) {
- return iterator{traits_type::begin(*static_cast<Type *>(container))};
- }
- [[nodiscard]] static iterator end(void *container) {
- return iterator{traits_type::end(*static_cast<Type *>(container))};
- }
- [[nodiscard]] static std::pair<iterator, bool> insert(void *container, iterator it, meta_any value) {
- if(const auto *v_ptr = value.try_cast<typename traits_type::value_type>(); v_ptr || value.convert<typename traits_type::value_type>()) {
- auto ret = traits_type::insert(*static_cast<Type *>(container), it.handle.cast<typename traits_type::iterator>(), v_ptr ? *v_ptr : value.cast<typename traits_type::value_type>());
- return {iterator{std::move(ret.first)}, ret.second};
- }
- return {};
- }
- [[nodiscard]] static std::pair<iterator, bool> erase(void *container, iterator it) {
- auto ret = traits_type::erase(*static_cast<Type *>(container), it.handle.cast<typename traits_type::iterator>());
- return {iterator{std::move(ret.first)}, ret.second};
- }
- [[nodiscard]] static meta_any get(void *container, size_type pos) {
- return std::ref(traits_type::get(*static_cast<Type *>(container), pos));
- }
- };
- /**
- * @brief Returns the value meta type of the wrapped container type.
- * @return The value meta type of the wrapped container type.
- */
- [[nodiscard]] inline meta_type meta_sequence_container::value_type() const ENTT_NOEXCEPT {
- return value_type_fn();
- }
- /**
- * @brief Returns the size of the wrapped container.
- * @return The size of the wrapped container.
- */
- [[nodiscard]] inline meta_sequence_container::size_type meta_sequence_container::size() const ENTT_NOEXCEPT {
- return size_fn(instance);
- }
- /**
- * @brief Resizes the wrapped container to contain a given number of elements.
- * @param sz The new size of the container.
- * @return True in case of success, false otherwise.
- */
- inline bool meta_sequence_container::resize(size_type sz) const {
- return resize_fn(instance, sz);
- }
- /**
- * @brief Clears the content of the wrapped container.
- * @return True in case of success, false otherwise.
- */
- inline bool meta_sequence_container::clear() {
- return clear_fn(instance);
- }
- /**
- * @brief Returns a meta iterator to the first element of the wrapped container.
- * @return A meta iterator to the first element of the wrapped container.
- */
- [[nodiscard]] inline meta_sequence_container::iterator meta_sequence_container::begin() {
- return begin_fn(instance);
- }
- /**
- * @brief Returns a meta iterator that is past the last element of the wrapped
- * container.
- * @return A meta iterator that is past the last element of the wrapped
- * container.
- */
- [[nodiscard]] inline meta_sequence_container::iterator meta_sequence_container::end() {
- return end_fn(instance);
- }
- /**
- * @brief Inserts an element at a specified location of the wrapped container.
- * @param it Meta iterator before which the element will be inserted.
- * @param value Element value to insert.
- * @return A pair consisting of a meta iterator to the inserted element (in
- * case of success) and a bool denoting whether the insertion took place.
- */
- inline std::pair<meta_sequence_container::iterator, bool> meta_sequence_container::insert(iterator it, meta_any value) {
- return insert_fn(instance, it, value.ref());
- }
- /**
- * @brief Removes the specified element from the wrapped container.
- * @param it Meta iterator to the element to remove.
- * @return A pair consisting of a meta iterator following the last removed
- * element (in case of success) and a bool denoting whether the insertion
- * took place.
- */
- inline std::pair<meta_sequence_container::iterator, bool> meta_sequence_container::erase(iterator it) {
- return erase_fn(instance, it);
- }
- /**
- * @brief Returns a reference to the element at a specified location of the
- * wrapped container (no bounds checking is performed).
- * @param pos The position of the element to return.
- * @return A reference to the requested element properly wrapped.
- */
- [[nodiscard]] inline meta_any meta_sequence_container::operator[](size_type pos) {
- return get_fn(instance, pos);
- }
- /**
- * @brief Returns false if a proxy is invalid, true otherwise.
- * @return False if the proxy is invalid, true otherwise.
- */
- [[nodiscard]] inline meta_sequence_container::operator bool() const ENTT_NOEXCEPT {
- return (instance != nullptr);
- }
- /*! @brief Opaque iterator for meta associative containers. */
- class meta_associative_container::meta_iterator {
- template<typename It>
- static void incr(meta_any any) {
- ++any.cast<It>();
- }
- template<bool KeyOnly, typename It>
- [[nodiscard]] static meta_any key(meta_any any) {
- if constexpr(KeyOnly) {
- return *any.cast<It>();
- } else {
- return any.cast<It>()->first;
- }
- }
- template<bool KeyOnly, typename It>
- [[nodiscard]] static meta_any value([[maybe_unused]] meta_any any) {
- if constexpr(KeyOnly) {
- return meta_any{};
- } else {
- return std::ref(any.cast<It>()->second);
- }
- }
- public:
- /*! @brief Signed integer type. */
- using difference_type = std::ptrdiff_t;
- /*! @brief Type of elements returned by the iterator. */
- using value_type = std::pair<meta_any, meta_any>;
- /*! @brief Pointer type, `void` on purpose. */
- using pointer = void;
- /*! @brief Reference type, it is **not** an actual reference. */
- using reference = value_type;
- /*! @brief Iterator category. */
- using iterator_category = std::input_iterator_tag;
- /*! @brief Default constructor. */
- meta_iterator() ENTT_NOEXCEPT = default;
- /**
- * @brief Constructs a meta iterator from a given iterator.
- * @tparam KeyOnly True if the associative container is also key-only, false
- * otherwise.
- * @tparam It Type of actual iterator with which to build the meta iterator.
- * @param iter The actual iterator with which to build the meta iterator.
- */
- template<bool KeyOnly, typename It>
- meta_iterator(std::integral_constant<bool, KeyOnly>, It iter)
- : next_fn{&incr<It>},
- key_fn{&key<KeyOnly, It>},
- value_fn{&value<KeyOnly, It>},
- handle{std::move(iter)}
- {}
- /*! @brief Pre-increment operator. @return This iterator. */
- meta_iterator & operator++() ENTT_NOEXCEPT {
- return next_fn(handle.ref()), *this;
- }
- /*! @brief Post-increment operator. @return This iterator. */
- meta_iterator operator++(int) ENTT_NOEXCEPT {
- meta_iterator orig = *this;
- return ++(*this), orig;
- }
- /**
- * @brief Checks if two meta iterators refer to the same element.
- * @param other The meta iterator with which to compare.
- * @return True if the two meta iterators refer to the same element, false
- * otherwise.
- */
- [[nodiscard]] bool operator==(const meta_iterator &other) const ENTT_NOEXCEPT {
- return handle == other.handle;
- }
- /**
- * @brief Checks if two meta iterators refer to the same element.
- * @param other The meta iterator with which to compare.
- * @return False if the two meta iterators refer to the same element, true
- * otherwise.
- */
- [[nodiscard]] bool operator!=(const meta_iterator &other) const ENTT_NOEXCEPT {
- return !(*this == other);
- }
- /**
- * @brief Indirection operator.
- * @return The element to which the meta pointer points.
- */
- [[nodiscard]] reference operator*() const {
- return { key_fn(handle.ref()), value_fn(handle.ref()) };
- }
- /**
- * @brief Returns false if an iterator is invalid, true otherwise.
- * @return False if the iterator is invalid, true otherwise.
- */
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- return static_cast<bool>(handle);
- }
- private:
- void(* next_fn)(meta_any);
- meta_any(* key_fn)(meta_any);
- meta_any(* value_fn)(meta_any);
- meta_any handle;
- };
- template<typename Type>
- struct meta_associative_container::meta_associative_container_proxy {
- using traits_type = meta_associative_container_traits<Type>;
- [[nodiscard]] static meta_type key_type() ENTT_NOEXCEPT {
- return internal::meta_info<typename traits_type::key_type>::resolve();
- }
- [[nodiscard]] static meta_type mapped_type() ENTT_NOEXCEPT {
- if constexpr(is_key_only_meta_associative_container_v<Type>) {
- return meta_type{};
- } else {
- return internal::meta_info<typename traits_type::mapped_type>::resolve();
- }
- }
- [[nodiscard]] static meta_type value_type() ENTT_NOEXCEPT {
- return internal::meta_info<typename traits_type::value_type>::resolve();
- }
- [[nodiscard]] static size_type size(const void *container) ENTT_NOEXCEPT {
- return traits_type::size(*static_cast<const Type *>(container));
- }
- [[nodiscard]] static bool clear(void *container) {
- return traits_type::clear(*static_cast<Type *>(container));
- }
- [[nodiscard]] static iterator begin(void *container) {
- return iterator{is_key_only_meta_associative_container<Type>{}, traits_type::begin(*static_cast<Type *>(container))};
- }
- [[nodiscard]] static iterator end(void *container) {
- return iterator{is_key_only_meta_associative_container<Type>{}, traits_type::end(*static_cast<Type *>(container))};
- }
- [[nodiscard]] static bool insert(void *container, meta_any key, meta_any value) {
- if(const auto *k_ptr = key.try_cast<typename traits_type::key_type>(); k_ptr || key.convert<typename traits_type::key_type>()) {
- if constexpr(is_key_only_meta_associative_container_v<Type>) {
- return traits_type::insert(*static_cast<Type *>(container), k_ptr ? *k_ptr : key.cast<typename traits_type::key_type>());
- } else {
- if(auto *m_ptr = value.try_cast<typename traits_type::mapped_type>(); m_ptr || value.convert<typename traits_type::mapped_type>()) {
- return traits_type::insert(*static_cast<Type *>(container), k_ptr ? *k_ptr : key.cast<typename traits_type::key_type>(), m_ptr ? *m_ptr : value.cast<typename traits_type::mapped_type>());
- }
- }
- }
- return false;
- }
- [[nodiscard]] static bool erase(void *container, meta_any key) {
- if(const auto *k_ptr = key.try_cast<typename traits_type::key_type>(); k_ptr || key.convert<typename traits_type::key_type>()) {
- return traits_type::erase(*static_cast<Type *>(container), k_ptr ? *k_ptr : key.cast<typename traits_type::key_type>());
- }
- return false;
- }
- [[nodiscard]] static iterator find(void *container, meta_any key) {
- if(const auto *k_ptr = key.try_cast<typename traits_type::key_type>(); k_ptr || key.convert<typename traits_type::key_type>()) {
- return iterator{is_key_only_meta_associative_container<Type>{}, traits_type::find(*static_cast<Type *>(container), k_ptr ? *k_ptr : key.cast<typename traits_type::key_type>())};
- }
- return {};
- }
- };
- /**
- * @brief Returns true if the associative container is also key-only, false
- * otherwise.
- * @return True if the associative container is also key-only, false otherwise.
- */
- [[nodiscard]] inline bool meta_associative_container::key_only() const ENTT_NOEXCEPT {
- return key_only_container;
- }
- /**
- * @brief Returns the key meta type of the wrapped container type.
- * @return The key meta type of the wrapped container type.
- */
- [[nodiscard]] inline meta_type meta_associative_container::key_type() const ENTT_NOEXCEPT {
- return key_type_fn();
- }
- /**
- * @brief Returns the mapped meta type of the wrapped container type.
- * @return The mapped meta type of the wrapped container type.
- */
- [[nodiscard]] inline meta_type meta_associative_container::mapped_type() const ENTT_NOEXCEPT {
- return mapped_type_fn();
- }
- /*! @copydoc meta_sequence_container::value_type */
- [[nodiscard]] inline meta_type meta_associative_container::value_type() const ENTT_NOEXCEPT {
- return value_type_fn();
- }
- /*! @copydoc meta_sequence_container::size */
- [[nodiscard]] inline meta_associative_container::size_type meta_associative_container::size() const ENTT_NOEXCEPT {
- return size_fn(instance);
- }
- /*! @copydoc meta_sequence_container::clear */
- inline bool meta_associative_container::clear() {
- return clear_fn(instance);
- }
- /*! @copydoc meta_sequence_container::begin */
- [[nodiscard]] inline meta_associative_container::iterator meta_associative_container::begin() {
- return begin_fn(instance);
- }
- /*! @copydoc meta_sequence_container::end */
- [[nodiscard]] inline meta_associative_container::iterator meta_associative_container::end() {
- return end_fn(instance);
- }
- /**
- * @brief Inserts an element (a key/value pair) into the wrapped container.
- * @param key The key of the element to insert.
- * @param value The value of the element to insert.
- * @return A bool denoting whether the insertion took place.
- */
- inline bool meta_associative_container::insert(meta_any key, meta_any value = {}) {
- return insert_fn(instance, key.ref(), value.ref());
- }
- /**
- * @brief Removes the specified element from the wrapped container.
- * @param key The key of the element to remove.
- * @return A bool denoting whether the removal took place.
- */
- inline bool meta_associative_container::erase(meta_any key) {
- return erase_fn(instance, key.ref());
- }
- /**
- * @brief Returns an iterator to the element with key equivalent to a given
- * one, if any.
- * @param key The key of the element to search.
- * @return An iterator to the element with the given key, if any.
- */
- [[nodiscard]] inline meta_associative_container::iterator meta_associative_container::find(meta_any key) {
- return find_fn(instance, key.ref());
- }
- /**
- * @brief Returns false if a proxy is invalid, true otherwise.
- * @return False if the proxy is invalid, true otherwise.
- */
- [[nodiscard]] inline meta_associative_container::operator bool() const ENTT_NOEXCEPT {
- return (instance != nullptr);
- }
- }
- #endif
- // #include "policy.hpp"
- #ifndef ENTT_META_POLICY_HPP
- #define ENTT_META_POLICY_HPP
- namespace entt {
- /*! @brief Empty class type used to request the _as ref_ policy. */
- struct as_ref_t {};
- /*! @brief Disambiguation tag. */
- inline constexpr as_ref_t as_ref;
- /*! @brief Empty class type used to request the _as-is_ policy. */
- struct as_is_t {};
- /*! @brief Empty class type used to request the _as void_ policy. */
- struct as_void_t {};
- }
- #endif
- namespace entt {
- /**
- * @cond TURN_OFF_DOXYGEN
- * Internal details not to be documented.
- */
- namespace internal {
- template<typename, bool = false>
- struct meta_function_helper;
- template<typename Ret, typename... Args, bool Const>
- struct meta_function_helper<Ret(Args...), Const> {
- using return_type = std::remove_cv_t<std::remove_reference_t<Ret>>;
- using args_type = std::tuple<std::remove_cv_t<std::remove_reference_t<Args>>...>;
- static constexpr auto is_const = Const;
- [[nodiscard]] static auto arg(typename internal::meta_func_node::size_type index) ENTT_NOEXCEPT {
- return std::array<meta_type_node *, sizeof...(Args)>{{meta_info<Args>::resolve()...}}[index];
- }
- };
- template<typename Ret, typename... Args, typename Class>
- constexpr meta_function_helper<Ret(Args...), true>
- to_meta_function_helper(Ret(Class:: *)(Args...) const);
- template<typename Ret, typename... Args, typename Class>
- constexpr meta_function_helper<Ret(Args...)>
- to_meta_function_helper(Ret(Class:: *)(Args...));
- template<typename Ret, typename... Args>
- constexpr meta_function_helper<Ret(Args...)>
- to_meta_function_helper(Ret(*)(Args...));
- constexpr void to_meta_function_helper(...);
- template<typename Candidate>
- using meta_function_helper_t = decltype(to_meta_function_helper(std::declval<Candidate>()));
- template<typename Type, typename... Args, std::size_t... Indexes>
- [[nodiscard]] meta_any construct(meta_any * const args, std::index_sequence<Indexes...>) {
- [[maybe_unused]] auto direct = std::make_tuple((args+Indexes)->try_cast<Args>()...);
- return ((std::get<Indexes>(direct) || (args+Indexes)->convert<Args>()) && ...)
- ? Type{(std::get<Indexes>(direct) ? *std::get<Indexes>(direct) : (args+Indexes)->cast<Args>())...}
- : meta_any{};
- }
- template<typename Type, auto Data>
- [[nodiscard]] bool setter([[maybe_unused]] meta_handle instance, [[maybe_unused]] meta_any value) {
- bool accepted = false;
- if constexpr(std::is_function_v<std::remove_reference_t<std::remove_pointer_t<decltype(Data)>>> || std::is_member_function_pointer_v<decltype(Data)>) {
- using helper_type = meta_function_helper_t<decltype(Data)>;
- using data_type = std::tuple_element_t<!std::is_member_function_pointer_v<decltype(Data)>, typename helper_type::args_type>;
- if(auto * const clazz = instance->try_cast<Type>(); clazz) {
- if(auto * const direct = value.try_cast<data_type>(); direct || value.convert<data_type>()) {
- std::invoke(Data, *clazz, direct ? *direct : value.cast<data_type>());
- accepted = true;
- }
- }
- } else if constexpr(std::is_member_object_pointer_v<decltype(Data)>) {
- using data_type = std::remove_cv_t<std::remove_reference_t<decltype(std::declval<Type>().*Data)>>;
- if constexpr(!std::is_array_v<data_type>) {
- if(auto * const clazz = instance->try_cast<Type>(); clazz) {
- if(auto * const direct = value.try_cast<data_type>(); direct || value.convert<data_type>()) {
- std::invoke(Data, clazz) = (direct ? *direct : value.cast<data_type>());
- accepted = true;
- }
- }
- }
- } else {
- using data_type = std::remove_cv_t<std::remove_reference_t<decltype(*Data)>>;
- if constexpr(!std::is_array_v<data_type>) {
- if(auto * const direct = value.try_cast<data_type>(); direct || value.convert<data_type>()) {
- *Data = (direct ? *direct : value.cast<data_type>());
- accepted = true;
- }
- }
- }
- return accepted;
- }
- template<typename Type, auto Data, typename Policy>
- [[nodiscard]] meta_any getter([[maybe_unused]] meta_handle instance) {
- [[maybe_unused]] auto dispatch = [](auto &&value) {
- if constexpr(std::is_same_v<Policy, as_void_t>) {
- return meta_any{std::in_place_type<void>, std::forward<decltype(value)>(value)};
- } else if constexpr(std::is_same_v<Policy, as_ref_t>) {
- return meta_any{std::ref(std::forward<decltype(value)>(value))};
- } else {
- static_assert(std::is_same_v<Policy, as_is_t>, "Policy not supported");
- return meta_any{std::forward<decltype(value)>(value)};
- }
- };
- if constexpr(std::is_function_v<std::remove_reference_t<std::remove_pointer_t<decltype(Data)>>> || std::is_member_function_pointer_v<decltype(Data)>) {
- auto * const clazz = instance->try_cast<Type>();
- return clazz ? dispatch(std::invoke(Data, *clazz)) : meta_any{};
- } else if constexpr(std::is_member_object_pointer_v<decltype(Data)>) {
- if constexpr(std::is_array_v<std::remove_cv_t<std::remove_reference_t<decltype(std::declval<Type>().*Data)>>>) {
- return meta_any{};
- } else {
- auto * const clazz = instance->try_cast<Type>();
- return clazz ? dispatch(std::invoke(Data, clazz)) : meta_any{};
- }
- } else if constexpr(std::is_pointer_v<std::decay_t<decltype(Data)>>) {
- if constexpr(std::is_array_v<std::remove_pointer_t<decltype(Data)>>) {
- return meta_any{};
- } else {
- return dispatch(*Data);
- }
- } else {
- return dispatch(Data);
- }
- }
- template<typename Type, auto Candidate, typename Policy, std::size_t... Indexes>
- [[nodiscard]] meta_any invoke([[maybe_unused]] meta_handle instance, meta_any *args, std::index_sequence<Indexes...>) {
- using helper_type = meta_function_helper_t<decltype(Candidate)>;
- auto dispatch = [](auto *... params) {
- if constexpr(std::is_void_v<typename helper_type::return_type> || std::is_same_v<Policy, as_void_t>) {
- std::invoke(Candidate, *params...);
- return meta_any{std::in_place_type<void>};
- } else if constexpr(std::is_same_v<Policy, as_ref_t>) {
- return meta_any{std::ref(std::invoke(Candidate, *params...))};
- } else {
- static_assert(std::is_same_v<Policy, as_is_t>, "Policy not supported");
- return meta_any{std::invoke(Candidate, *params...)};
- }
- };
- [[maybe_unused]] const auto direct = std::make_tuple([](meta_any *any, auto *value) {
- using arg_type = std::remove_reference_t<decltype(*value)>;
- if(!value && any->convert<arg_type>()) {
- value = any->try_cast<arg_type>();
- }
- return value;
- }(args+Indexes, (args+Indexes)->try_cast<std::tuple_element_t<Indexes, typename helper_type::args_type>>())...);
- if constexpr(std::is_function_v<std::remove_reference_t<std::remove_pointer_t<decltype(Candidate)>>>) {
- return (std::get<Indexes>(direct) && ...) ? dispatch(std::get<Indexes>(direct)...) : meta_any{};
- } else {
- auto * const clazz = instance->try_cast<Type>();
- return (clazz && (std::get<Indexes>(direct) && ...)) ? dispatch(clazz, std::get<Indexes>(direct)...) : meta_any{};
- }
- }
- }
- /**
- * Internal details not to be documented.
- * @endcond
- */
- /**
- * @brief Meta factory to be used for reflection purposes.
- *
- * The meta factory is an utility class used to reflect types, data members and
- * functions of all sorts. This class ensures that the underlying web of types
- * is built correctly and performs some checks in debug mode to ensure that
- * there are no subtle errors at runtime.
- */
- template<typename...>
- class meta_factory;
- /**
- * @brief Extended meta factory to be used for reflection purposes.
- * @tparam Type Reflected type for which the factory was created.
- * @tparam Spec Property specialization pack used to disambiguate overloads.
- */
- template<typename Type, typename... Spec>
- class meta_factory<Type, Spec...>: public meta_factory<Type> {
- [[nodiscard]] bool exists(const meta_any &key, const internal::meta_prop_node *node) ENTT_NOEXCEPT {
- return node && (node->key() == key || exists(key, node->next));
- }
- template<std::size_t Step = 0, std::size_t... Index, typename... Property, typename... Other>
- void unpack(std::index_sequence<Index...>, std::tuple<Property...> property, Other &&... other) {
- unroll<Step>(choice<3>, std::move(std::get<Index>(property))..., std::forward<Other>(other)...);
- }
- template<std::size_t Step = 0, typename... Property, typename... Other>
- void unroll(choice_t<3>, std::tuple<Property...> property, Other &&... other) {
- unpack<Step>(std::index_sequence_for<Property...>{}, std::move(property), std::forward<Other>(other)...);
- }
- template<std::size_t Step = 0, typename... Property, typename... Other>
- void unroll(choice_t<2>, std::pair<Property...> property, Other &&... other) {
- assign<Step>(std::move(property.first), std::move(property.second));
- unroll<Step+1>(choice<3>, std::forward<Other>(other)...);
- }
- template<std::size_t Step = 0, typename Property, typename... Other>
- std::enable_if_t<!std::is_invocable_v<Property>>
- unroll(choice_t<1>, Property &&property, Other &&... other) {
- assign<Step>(std::forward<Property>(property));
- unroll<Step+1>(choice<3>, std::forward<Other>(other)...);
- }
- template<std::size_t Step = 0, typename Func, typename... Other>
- void unroll(choice_t<0>, Func &&invocable, Other &&... other) {
- unroll<Step>(choice<3>, std::forward<Func>(invocable)(), std::forward<Other>(other)...);
- }
- template<std::size_t>
- void unroll(choice_t<0>) {}
- template<std::size_t = 0, typename Key, typename... Value>
- void assign(Key &&key, Value &&... value) {
- static const auto property{std::make_tuple(std::forward<Key>(key), std::forward<Value>(value)...)};
- static internal::meta_prop_node node{
- nullptr,
- []() -> meta_any {
- return std::get<0>(property);
- },
- []() -> meta_any {
- if constexpr(sizeof...(Value) == 0) {
- return {};
- } else {
- return std::get<1>(property);
- }
- }
- };
- ENTT_ASSERT(!exists(node.key(), *curr));
- node.next = *curr;
- *curr = &node;
- }
- public:
- /**
- * @brief Constructs an extended factory from a given node.
- * @param target The underlying node to which to assign the properties.
- */
- meta_factory(internal::meta_prop_node **target) ENTT_NOEXCEPT
- : curr{target}
- {}
- /**
- * @brief Assigns a property to the last meta object created.
- *
- * Both the key and the value (if any) must be at least copy constructible.
- *
- * @tparam PropertyOrKey Type of the property or property key.
- * @tparam Value Optional type of the property value.
- * @param property_or_key Property or property key.
- * @param value Optional property value.
- * @return A meta factory for the parent type.
- */
- template<typename PropertyOrKey, typename... Value>
- auto prop(PropertyOrKey &&property_or_key, Value &&... value) && {
- if constexpr(sizeof...(Value) == 0) {
- unroll(choice<3>, std::forward<PropertyOrKey>(property_or_key));
- } else {
- assign(std::forward<PropertyOrKey>(property_or_key), std::forward<Value>(value)...);
- }
- return meta_factory<Type, Spec..., PropertyOrKey, Value...>{curr};
- }
- /**
- * @brief Assigns properties to the last meta object created.
- *
- * Both the keys and the values (if any) must be at least copy
- * constructible.
- *
- * @tparam Property Types of the properties.
- * @param property Properties to assign to the last meta object created.
- * @return A meta factory for the parent type.
- */
- template <typename... Property>
- auto props(Property... property) && {
- unroll(choice<3>, std::forward<Property>(property)...);
- return meta_factory<Type, Spec..., Property...>{curr};
- }
- private:
- internal::meta_prop_node **curr;
- };
- /**
- * @brief Basic meta factory to be used for reflection purposes.
- * @tparam Type Reflected type for which the factory was created.
- */
- template<typename Type>
- class meta_factory<Type> {
- template<typename Node>
- bool exists(const Node *candidate, const Node *node) ENTT_NOEXCEPT {
- return node && (node == candidate || exists(candidate, node->next));
- }
- template<typename Node>
- bool exists(const id_type id, const Node *node) ENTT_NOEXCEPT {
- return node && (node->id == id || exists(id, node->next));
- }
- public:
- /**
- * @brief Makes a meta type _searchable_.
- * @param id Optional unique identifier.
- * @return An extended meta factory for the given type.
- */
- auto type(const id_type id = type_info<Type>::id()) {
- auto * const node = internal::meta_info<Type>::resolve();
- ENTT_ASSERT(!exists(id, *internal::meta_context::global()));
- ENTT_ASSERT(!exists(node, *internal::meta_context::global()));
- node->id = id;
- node->next = *internal::meta_context::global();
- *internal::meta_context::global() = node;
- return meta_factory<Type, Type>{&node->prop};
- }
- /**
- * @brief Assigns a meta base to a meta type.
- *
- * A reflected base class must be a real base class of the reflected type.
- *
- * @tparam Base Type of the base class to assign to the meta type.
- * @return A meta factory for the parent type.
- */
- template<typename Base>
- auto base() ENTT_NOEXCEPT {
- static_assert(std::is_base_of_v<Base, Type>, "Invalid base type");
- auto * const type = internal::meta_info<Type>::resolve();
- static internal::meta_base_node node{
- type,
- nullptr,
- &internal::meta_info<Base>::resolve,
- [](const void *instance) ENTT_NOEXCEPT -> const void * {
- return static_cast<const Base *>(static_cast<const Type *>(instance));
- }
- };
- ENTT_ASSERT(!exists(&node, type->base));
- node.next = type->base;
- type->base = &node;
- return meta_factory<Type>{};
- }
- /**
- * @brief Assigns a meta conversion function to a meta type.
- *
- * The given type must be such that an instance of the reflected type can be
- * converted to it.
- *
- * @tparam To Type of the conversion function to assign to the meta type.
- * @return A meta factory for the parent type.
- */
- template<typename To>
- auto conv() ENTT_NOEXCEPT {
- static_assert(std::is_convertible_v<Type, To>, "Could not convert to the required type");
- auto * const type = internal::meta_info<Type>::resolve();
- static internal::meta_conv_node node{
- type,
- nullptr,
- &internal::meta_info<To>::resolve,
- [](const void *instance) -> meta_any {
- return static_cast<To>(*static_cast<const Type *>(instance));
- }
- };
- ENTT_ASSERT(!exists(&node, type->conv));
- node.next = type->conv;
- type->conv = &node;
- return meta_factory<Type>{};
- }
- /**
- * @brief Assigns a meta conversion function to a meta type.
- *
- * Conversion functions can be either free functions or member
- * functions.<br/>
- * In case of free functions, they must accept a const reference to an
- * instance of the parent type as an argument. In case of member functions,
- * they should have no arguments at all.
- *
- * @tparam Candidate The actual function to use for the conversion.
- * @return A meta factory for the parent type.
- */
- template<auto Candidate>
- auto conv() ENTT_NOEXCEPT {
- using conv_type = std::invoke_result_t<decltype(Candidate), Type &>;
- auto * const type = internal::meta_info<Type>::resolve();
- static internal::meta_conv_node node{
- type,
- nullptr,
- &internal::meta_info<conv_type>::resolve,
- [](const void *instance) -> meta_any {
- return std::invoke(Candidate, *static_cast<const Type *>(instance));
- }
- };
- ENTT_ASSERT(!exists(&node, type->conv));
- node.next = type->conv;
- type->conv = &node;
- return meta_factory<Type>{};
- }
- /**
- * @brief Assigns a meta constructor to a meta type.
- *
- * Free functions can be assigned to meta types in the role of constructors.
- * All that is required is that they return an instance of the underlying
- * type.<br/>
- * From a client's point of view, nothing changes if a constructor of a meta
- * type is a built-in one or a free function.
- *
- * @tparam Func The actual function to use as a constructor.
- * @tparam Policy Optional policy (no policy set by default).
- * @return An extended meta factory for the parent type.
- */
- template<auto Func, typename Policy = as_is_t>
- auto ctor() ENTT_NOEXCEPT {
- using helper_type = internal::meta_function_helper_t<decltype(Func)>;
- static_assert(std::is_same_v<typename helper_type::return_type, Type>, "The function doesn't return an object of the required type");
- auto * const type = internal::meta_info<Type>::resolve();
- static internal::meta_ctor_node node{
- type,
- nullptr,
- nullptr,
- std::tuple_size_v<typename helper_type::args_type>,
- &helper_type::arg,
- [](meta_any * const any) {
- return internal::invoke<Type, Func, Policy>({}, any, std::make_index_sequence<std::tuple_size_v<typename helper_type::args_type>>{});
- }
- };
- ENTT_ASSERT(!exists(&node, type->ctor));
- node.next = type->ctor;
- type->ctor = &node;
- return meta_factory<Type, std::integral_constant<decltype(Func), Func>>{&node.prop};
- }
- /**
- * @brief Assigns a meta constructor to a meta type.
- *
- * A meta constructor is uniquely identified by the types of its arguments
- * and is such that there exists an actual constructor of the underlying
- * type that can be invoked with parameters whose types are those given.
- *
- * @tparam Args Types of arguments to use to construct an instance.
- * @return An extended meta factory for the parent type.
- */
- template<typename... Args>
- auto ctor() ENTT_NOEXCEPT {
- using helper_type = internal::meta_function_helper_t<Type(*)(Args...)>;
- auto * const type = internal::meta_info<Type>::resolve();
- static internal::meta_ctor_node node{
- type,
- nullptr,
- nullptr,
- std::tuple_size_v<typename helper_type::args_type>,
- &helper_type::arg,
- [](meta_any * const any) {
- return internal::construct<Type, std::remove_cv_t<std::remove_reference_t<Args>>...>(any, std::make_index_sequence<std::tuple_size_v<typename helper_type::args_type>>{});
- }
- };
- ENTT_ASSERT(!exists(&node, type->ctor));
- node.next = type->ctor;
- type->ctor = &node;
- return meta_factory<Type, Type(Args...)>{&node.prop};
- }
- /**
- * @brief Assigns a meta destructor to a meta type.
- *
- * Free functions can be assigned to meta types in the role of destructors.
- * The signature of the function should identical to the following:
- *
- * @code{.cpp}
- * void(Type &);
- * @endcode
- *
- * The purpose is to give users the ability to free up resources that
- * require special treatment before an object is actually destroyed.
- *
- * @tparam Func The actual function to use as a destructor.
- * @return A meta factory for the parent type.
- */
- template<auto Func>
- auto dtor() ENTT_NOEXCEPT {
- static_assert(std::is_invocable_v<decltype(Func), Type &>, "The function doesn't accept an object of the type provided");
- auto * const type = internal::meta_info<Type>::resolve();
- ENTT_ASSERT(!type->dtor);
- type->dtor = [](void *instance) {
- if(instance) {
- std::invoke(Func, *static_cast<Type *>(instance));
- }
- };
- return meta_factory<Type>{};
- }
- /**
- * @brief Assigns a meta data to a meta type.
- *
- * Both data members and static and global variables, as well as constants
- * of any kind, can be assigned to a meta type.<br/>
- * From a client's point of view, all the variables associated with the
- * reflected object will appear as if they were part of the type itself.
- *
- * @tparam Data The actual variable to attach to the meta type.
- * @tparam Policy Optional policy (no policy set by default).
- * @param id Unique identifier.
- * @return An extended meta factory for the parent type.
- */
- template<auto Data, typename Policy = as_is_t>
- auto data(const id_type id) ENTT_NOEXCEPT {
- if constexpr(std::is_member_object_pointer_v<decltype(Data)>) {
- return data<Data, Data, Policy>(id);
- } else {
- using data_type = std::remove_pointer_t<std::decay_t<decltype(Data)>>;
- auto * const type = internal::meta_info<Type>::resolve();
- static internal::meta_data_node node{
- {},
- type,
- nullptr,
- nullptr,
- true,
- &internal::meta_info<data_type>::resolve,
- []() -> std::remove_const_t<decltype(internal::meta_data_node::set)> {
- if constexpr(std::is_same_v<Type, data_type> || std::is_const_v<data_type>) {
- return nullptr;
- } else {
- return &internal::setter<Type, Data>;
- }
- }(),
- &internal::getter<Type, Data, Policy>
- };
- ENTT_ASSERT(!exists(id, type->data));
- ENTT_ASSERT(!exists(&node, type->data));
- node.id = id;
- node.next = type->data;
- type->data = &node;
- return meta_factory<Type, std::integral_constant<decltype(Data), Data>>{&node.prop};
- }
- }
- /**
- * @brief Assigns a meta data to a meta type by means of its setter and
- * getter.
- *
- * Setters and getters can be either free functions, member functions or a
- * mix of them.<br/>
- * In case of free functions, setters and getters must accept a reference to
- * an instance of the parent type as their first argument. A setter has then
- * an extra argument of a type convertible to that of the parameter to
- * set.<br/>
- * In case of member functions, getters have no arguments at all, while
- * setters has an argument of a type convertible to that of the parameter to
- * set.
- *
- * @tparam Setter The actual function to use as a setter.
- * @tparam Getter The actual function to use as a getter.
- * @tparam Policy Optional policy (no policy set by default).
- * @param id Unique identifier.
- * @return An extended meta factory for the parent type.
- */
- template<auto Setter, auto Getter, typename Policy = as_is_t>
- auto data(const id_type id) ENTT_NOEXCEPT {
- using underlying_type = std::remove_reference_t<std::invoke_result_t<decltype(Getter), Type &>>;
- auto * const type = internal::meta_info<Type>::resolve();
- static internal::meta_data_node node{
- {},
- type,
- nullptr,
- nullptr,
- false,
- &internal::meta_info<underlying_type>::resolve,
- []() -> std::remove_const_t<decltype(internal::meta_data_node::set)> {
- if constexpr(std::is_same_v<decltype(Setter), std::nullptr_t> || (std::is_member_object_pointer_v<decltype(Setter)> && std::is_const_v<underlying_type>)) {
- return nullptr;
- } else {
- return &internal::setter<Type, Setter>;
- }
- }(),
- &internal::getter<Type, Getter, Policy>
- };
- ENTT_ASSERT(!exists(id, type->data));
- ENTT_ASSERT(!exists(&node, type->data));
- node.id = id;
- node.next = type->data;
- type->data = &node;
- return meta_factory<Type, std::integral_constant<decltype(Setter), Setter>, std::integral_constant<decltype(Getter), Getter>>{&node.prop};
- }
- /**
- * @brief Assigns a meta funcion to a meta type.
- *
- * Both member functions and free functions can be assigned to a meta
- * type.<br/>
- * From a client's point of view, all the functions associated with the
- * reflected object will appear as if they were part of the type itself.
- *
- * @tparam Candidate The actual function to attach to the meta type.
- * @tparam Policy Optional policy (no policy set by default).
- * @param id Unique identifier.
- * @return An extended meta factory for the parent type.
- */
- template<auto Candidate, typename Policy = as_is_t>
- auto func(const id_type id) ENTT_NOEXCEPT {
- using helper_type = internal::meta_function_helper_t<decltype(Candidate)>;
- auto * const type = internal::meta_info<Type>::resolve();
- static internal::meta_func_node node{
- {},
- type,
- nullptr,
- nullptr,
- std::tuple_size_v<typename helper_type::args_type>,
- helper_type::is_const,
- !std::is_member_function_pointer_v<decltype(Candidate)>,
- &internal::meta_info<std::conditional_t<std::is_same_v<Policy, as_void_t>, void, typename helper_type::return_type>>::resolve,
- &helper_type::arg,
- [](meta_handle instance, meta_any *args) {
- return internal::invoke<Type, Candidate, Policy>(*instance, args, std::make_index_sequence<std::tuple_size_v<typename helper_type::args_type>>{});
- }
- };
- ENTT_ASSERT(!exists(id, type->func));
- ENTT_ASSERT(!exists(&node, type->func));
- node.id = id;
- node.next = type->func;
- type->func = &node;
- return meta_factory<Type, std::integral_constant<decltype(Candidate), Candidate>>{&node.prop};
- }
- };
- /**
- * @brief Utility function to use for reflection.
- *
- * This is the point from which everything starts.<br/>
- * By invoking this function with a type that is not yet reflected, a meta type
- * is created to which it will be possible to attach meta objects through a
- * dedicated factory.
- *
- * @tparam Type Type to reflect.
- * @return A meta factory for the given type.
- */
- template<typename Type>
- [[nodiscard]] auto meta() ENTT_NOEXCEPT {
- auto * const node = internal::meta_info<Type>::resolve();
- // extended meta factory to allow assigning properties to opaque meta types
- return meta_factory<Type, Type>{&node->prop};
- }
- }
- #endif
- // #include "meta/internal.hpp"
- // #include "meta/meta.hpp"
- // #include "meta/pointer.hpp"
- #ifndef ENTT_META_POINTER_HPP
- #define ENTT_META_POINTER_HPP
- #include <memory>
- #include <type_traits>
- // #include "type_traits.hpp"
- namespace entt {
- /**
- * @brief Makes plain pointers pointer-like types for the meta system.
- * @tparam Type Element type.
- */
- template<typename Type>
- struct is_meta_pointer_like<Type *>
- : std::true_type
- {};
- /**
- * @brief Makes `std::shared_ptr`s of any type pointer-like types for the meta
- * system.
- * @tparam Type Element type.
- */
- template<typename Type>
- struct is_meta_pointer_like<std::shared_ptr<Type>>
- : std::true_type
- {};
- /**
- * @brief Makes `std::unique_ptr`s of any type pointer-like types for the meta
- * system.
- * @tparam Type Element type.
- * @tparam Args Other arguments.
- */
- template<typename Type, typename... Args>
- struct is_meta_pointer_like<std::unique_ptr<Type, Args...>>
- : std::true_type
- {};
- }
- #endif
- // #include "meta/policy.hpp"
- // #include "meta/range.hpp"
- // #include "meta/resolve.hpp"
- #ifndef ENTT_META_RESOLVE_HPP
- #define ENTT_META_RESOLVE_HPP
- #include <algorithm>
- // #include "ctx.hpp"
- // #include "meta.hpp"
- // #include "range.hpp"
- namespace entt {
- /**
- * @brief Returns the meta type associated with a given type.
- * @tparam Type Type to use to search for a meta type.
- * @return The meta type associated with the given type, if any.
- */
- template<typename Type>
- [[nodiscard]] meta_type resolve() ENTT_NOEXCEPT {
- return internal::meta_info<Type>::resolve();
- }
- /**
- * @brief Returns a range to use to visit all meta types.
- * @return An iterable range to use to visit all meta types.
- */
- [[nodiscard]] inline meta_range<meta_type> resolve() {
- return *internal::meta_context::global();
- }
- /**
- * @brief Returns the meta type associated with a given identifier, if any.
- * @param id Unique identifier.
- * @return The meta type associated with the given identifier, if any.
- */
- [[nodiscard]] inline meta_type resolve_id(const id_type id) ENTT_NOEXCEPT {
- internal::meta_range range{*internal::meta_context::global()};
- return std::find_if(range.begin(), range.end(), [id](const auto &curr) { return curr.id == id; }).operator->();
- }
- /**
- * @brief Returns the meta type associated with a given type id, if any.
- * @param id Unique identifier.
- * @return The meta type associated with the given type id, if any.
- */
- [[nodiscard]] inline meta_type resolve_type(const id_type id) ENTT_NOEXCEPT {
- internal::meta_range range{*internal::meta_context::global()};
- return std::find_if(range.begin(), range.end(), [id](const auto &curr) { return curr.type_id == id; }).operator->();
- }
- }
- #endif
- // #include "meta/type_traits.hpp"
- // #include "platform/android-ndk-r17.hpp"
- #ifndef ENTT_PLATFORM_ANDROID_NDK_R17_HPP
- #define ENTT_PLATFORM_ANDROID_NDK_R17_HPP
- /**
- * @cond TURN_OFF_DOXYGEN
- * Internal details not to be documented.
- */
- #ifdef __ANDROID__
- #include <android/ndk-version.h>
- #if __NDK_MAJOR__ == 17
- #include <functional>
- #include <type_traits>
- #include <utility>
- namespace std {
- namespace internal {
- template<typename Func, typename... Args>
- constexpr auto is_invocable(int) -> decltype(std::invoke(std::declval<Func>(), std::declval<Args>()...), std::true_type{});
- template<typename, typename...>
- constexpr std::false_type is_invocable(...);
- template<typename Ret, typename Func, typename... Args>
- constexpr auto is_invocable_r(int)
- -> std::enable_if_t<decltype(std::is_convertible_v<decltype(std::invoke(std::declval<Func>(), std::declval<Args>()...)), Ret>, std::true_type>;
- template<typename, typename, typename...>
- constexpr std::false_type is_invocable_r(...);
- }
- template<typename Func, typename... Args>
- struct is_invocable: decltype(internal::is_invocable<Func, Args...>(0)) {};
- template<typename Func, typename... Argsv>
- inline constexpr bool is_invocable_v = std::is_invocable<Func, Args...>::value;
- template<typename Ret, typename Func, typename... Args>
- struct is_invocable_r: decltype(internal::is_invocable_r<Ret, Func, Args...>(0)) {};
- template<typename Ret, typename Func, typename... Args>
- inline constexpr bool is_invocable_r_v = std::is_invocable_r<Ret, Func, Args...>::value;
- template<typename Func, typename...Args>
- struct invoke_result {
- using type = decltype(std::invoke(std::declval<Func>(), std::declval<Args>()...));
- };
- template<typename Func, typename... Args>
- using invoke_result_t = typename std::invoke_result<Func, Args...>::type;
- }
- #endif
- #endif
- /**
- * Internal details not to be documented.
- * @endcond
- */
- #endif
- // #include "process/process.hpp"
- #ifndef ENTT_PROCESS_PROCESS_HPP
- #define ENTT_PROCESS_PROCESS_HPP
- #include <utility>
- #include <type_traits>
- // #include "../config/config.h"
- #ifndef ENTT_CONFIG_CONFIG_H
- #define ENTT_CONFIG_CONFIG_H
- #ifndef ENTT_NOEXCEPT
- # define ENTT_NOEXCEPT noexcept
- #endif
- #ifndef ENTT_HS_SUFFIX
- # define ENTT_HS_SUFFIX _hs
- #endif
- #ifndef ENTT_HWS_SUFFIX
- # define ENTT_HWS_SUFFIX _hws
- #endif
- #ifndef ENTT_USE_ATOMIC
- # define ENTT_MAYBE_ATOMIC(Type) Type
- #else
- # include <atomic>
- # define ENTT_MAYBE_ATOMIC(Type) std::atomic<Type>
- #endif
- #ifndef ENTT_ID_TYPE
- # include <cstdint>
- # define ENTT_ID_TYPE std::uint32_t
- #endif
- #ifndef ENTT_PAGE_SIZE
- # define ENTT_PAGE_SIZE 32768
- #endif
- #ifndef ENTT_ASSERT
- # include <cassert>
- # define ENTT_ASSERT(condition) assert(condition)
- #endif
- #ifndef ENTT_NO_ETO
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::is_empty<Type>
- #else
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::false_type
- #endif
- #ifndef ENTT_STANDARD_CPP
- # if defined __clang__ || (defined __GNUC__ && __GNUC__ > 8)
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined __GNUC__
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined _MSC_VER
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __FUNCSIG__
- # define ENTT_PRETTY_FUNCTION_PREFIX '<'
- # define ENTT_PRETTY_FUNCTION_SUFFIX '>'
- # endif
- #endif
- #ifndef ENTT_STANDALONE
- # define ENTT_FAST_PATH(...) false
- #else
- # define ENTT_FAST_PATH(Cond) Cond
- #endif
- #endif
- // #include "../core/type_traits.hpp"
- #ifndef ENTT_CORE_TYPE_TRAITS_HPP
- #define ENTT_CORE_TYPE_TRAITS_HPP
- #include <cstddef>
- #include <utility>
- #include <type_traits>
- // #include "../config/config.h"
- #ifndef ENTT_CONFIG_CONFIG_H
- #define ENTT_CONFIG_CONFIG_H
- #ifndef ENTT_NOEXCEPT
- # define ENTT_NOEXCEPT noexcept
- #endif
- #ifndef ENTT_HS_SUFFIX
- # define ENTT_HS_SUFFIX _hs
- #endif
- #ifndef ENTT_HWS_SUFFIX
- # define ENTT_HWS_SUFFIX _hws
- #endif
- #ifndef ENTT_USE_ATOMIC
- # define ENTT_MAYBE_ATOMIC(Type) Type
- #else
- # include <atomic>
- # define ENTT_MAYBE_ATOMIC(Type) std::atomic<Type>
- #endif
- #ifndef ENTT_ID_TYPE
- # include <cstdint>
- # define ENTT_ID_TYPE std::uint32_t
- #endif
- #ifndef ENTT_PAGE_SIZE
- # define ENTT_PAGE_SIZE 32768
- #endif
- #ifndef ENTT_ASSERT
- # include <cassert>
- # define ENTT_ASSERT(condition) assert(condition)
- #endif
- #ifndef ENTT_NO_ETO
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::is_empty<Type>
- #else
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::false_type
- #endif
- #ifndef ENTT_STANDARD_CPP
- # if defined __clang__ || (defined __GNUC__ && __GNUC__ > 8)
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined __GNUC__
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined _MSC_VER
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __FUNCSIG__
- # define ENTT_PRETTY_FUNCTION_PREFIX '<'
- # define ENTT_PRETTY_FUNCTION_SUFFIX '>'
- # endif
- #endif
- #ifndef ENTT_STANDALONE
- # define ENTT_FAST_PATH(...) false
- #else
- # define ENTT_FAST_PATH(Cond) Cond
- #endif
- #endif
- // #include "fwd.hpp"
- #ifndef ENTT_CORE_FWD_HPP
- #define ENTT_CORE_FWD_HPP
- // #include "../config/config.h"
- namespace entt {
- /*! @brief Alias declaration for type identifiers. */
- using id_type = ENTT_ID_TYPE;
- }
- #endif
- namespace entt {
- /**
- * @brief Using declaration to be used to _repeat_ the same type a number of
- * times equal to the size of a given parameter pack.
- * @tparam Type A type to repeat.
- */
- template<typename Type, typename>
- using unpack_as_t = Type;
- /**
- * @brief Helper variable template to be used to _repeat_ the same value a
- * number of times equal to the size of a given parameter pack.
- * @tparam Value A value to repeat.
- */
- template<auto Value, typename>
- inline constexpr auto unpack_as_v = Value;
- /**
- * @brief Wraps a static constant.
- * @tparam Value A static constant.
- */
- template<auto Value>
- using integral_constant = std::integral_constant<decltype(Value), Value>;
- /**
- * @brief Alias template to ease the creation of named values.
- * @tparam Value A constant value at least convertible to `id_type`.
- */
- template<id_type Value>
- using tag = integral_constant<Value>;
- /**
- * @brief Utility class to disambiguate overloaded functions.
- * @tparam N Number of choices available.
- */
- template<std::size_t N>
- struct choice_t
- // Unfortunately, doxygen cannot parse such a construct.
- /*! @cond TURN_OFF_DOXYGEN */
- : choice_t<N-1>
- /*! @endcond */
- {};
- /*! @copybrief choice_t */
- template<>
- struct choice_t<0> {};
- /**
- * @brief Variable template for the choice trick.
- * @tparam N Number of choices available.
- */
- template<std::size_t N>
- inline constexpr choice_t<N> choice{};
- /*! @brief A class to use to push around lists of types, nothing more. */
- template<typename...>
- struct type_list {};
- /*! @brief Primary template isn't defined on purpose. */
- template<typename>
- struct type_list_size;
- /**
- * @brief Compile-time number of elements in a type list.
- * @tparam Type Types provided by the type list.
- */
- template<typename... Type>
- struct type_list_size<type_list<Type...>>
- : std::integral_constant<std::size_t, sizeof...(Type)>
- {};
- /**
- * @brief Helper variable template.
- * @tparam List Type list.
- */
- template<class List>
- inline constexpr auto type_list_size_v = type_list_size<List>::value;
- /*! @brief Primary template isn't defined on purpose. */
- template<typename...>
- struct type_list_cat;
- /*! @brief Concatenates multiple type lists. */
- template<>
- struct type_list_cat<> {
- /*! @brief A type list composed by the types of all the type lists. */
- using type = type_list<>;
- };
- /**
- * @brief Concatenates multiple type lists.
- * @tparam Type Types provided by the first type list.
- * @tparam Other Types provided by the second type list.
- * @tparam List Other type lists, if any.
- */
- template<typename... Type, typename... Other, typename... List>
- struct type_list_cat<type_list<Type...>, type_list<Other...>, List...> {
- /*! @brief A type list composed by the types of all the type lists. */
- using type = typename type_list_cat<type_list<Type..., Other...>, List...>::type;
- };
- /**
- * @brief Concatenates multiple type lists.
- * @tparam Type Types provided by the type list.
- */
- template<typename... Type>
- struct type_list_cat<type_list<Type...>> {
- /*! @brief A type list composed by the types of all the type lists. */
- using type = type_list<Type...>;
- };
- /**
- * @brief Helper type.
- * @tparam List Type lists to concatenate.
- */
- template<typename... List>
- using type_list_cat_t = typename type_list_cat<List...>::type;
- /*! @brief Primary template isn't defined on purpose. */
- template<typename>
- struct type_list_unique;
- /**
- * @brief Removes duplicates types from a type list.
- * @tparam Type One of the types provided by the given type list.
- * @tparam Other The other types provided by the given type list.
- */
- template<typename Type, typename... Other>
- struct type_list_unique<type_list<Type, Other...>> {
- /*! @brief A type list without duplicate types. */
- using type = std::conditional_t<
- std::disjunction_v<std::is_same<Type, Other>...>,
- typename type_list_unique<type_list<Other...>>::type,
- type_list_cat_t<type_list<Type>, typename type_list_unique<type_list<Other...>>::type>
- >;
- };
- /*! @brief Removes duplicates types from a type list. */
- template<>
- struct type_list_unique<type_list<>> {
- /*! @brief A type list without duplicate types. */
- using type = type_list<>;
- };
- /**
- * @brief Helper type.
- * @tparam Type A type list.
- */
- template<typename Type>
- using type_list_unique_t = typename type_list_unique<Type>::type;
- /**
- * @brief Provides the member constant `value` to true if a given type is
- * equality comparable, false otherwise.
- * @tparam Type Potentially equality comparable type.
- */
- template<typename Type, typename = std::void_t<>>
- struct is_equality_comparable: std::false_type {};
- /*! @copydoc is_equality_comparable */
- template<typename Type>
- struct is_equality_comparable<Type, std::void_t<decltype(std::declval<Type>() == std::declval<Type>())>>
- : std::true_type
- {};
- /**
- * @brief Helper variable template.
- * @tparam Type Potentially equality comparable type.
- */
- template<class Type>
- inline constexpr auto is_equality_comparable_v = is_equality_comparable<Type>::value;
- /**
- * @brief Provides the member constant `value` to true if a given type is empty
- * and the empty type optimization is enabled, false otherwise.
- * @tparam Type Potential empty type.
- */
- template<typename Type, typename = void>
- struct is_eto_eligible
- : ENTT_IS_EMPTY(Type)
- {};
- /**
- * @brief Helper variable template.
- * @tparam Type Potential empty type.
- */
- template<typename Type>
- inline constexpr auto is_eto_eligible_v = is_eto_eligible<Type>::value;
- /**
- * @brief Extracts the class of a non-static member object or function.
- * @tparam Member A pointer to a non-static member object or function.
- */
- template<typename Member>
- class member_class {
- static_assert(std::is_member_pointer_v<Member>, "Invalid pointer type to non-static member object or function");
- template<typename Class, typename Ret, typename... Args>
- static Class * clazz(Ret(Class:: *)(Args...));
- template<typename Class, typename Ret, typename... Args>
- static Class * clazz(Ret(Class:: *)(Args...) const);
- template<typename Class, typename Type>
- static Class * clazz(Type Class:: *);
- public:
- /*! @brief The class of the given non-static member object or function. */
- using type = std::remove_pointer_t<decltype(clazz(std::declval<Member>()))>;
- };
- /**
- * @brief Helper type.
- * @tparam Member A pointer to a non-static member object or function.
- */
- template<typename Member>
- using member_class_t = typename member_class<Member>::type;
- }
- #endif
- namespace entt {
- /**
- * @brief Base class for processes.
- *
- * This class stays true to the CRTP idiom. Derived classes must specify what's
- * the intended type for elapsed times.<br/>
- * A process should expose publicly the following member functions whether
- * required:
- *
- * * @code{.cpp}
- * void update(Delta, void *);
- * @endcode
- *
- * It's invoked once per tick until a process is explicitly aborted or it
- * terminates either with or without errors. Even though it's not mandatory to
- * declare this member function, as a rule of thumb each process should at
- * least define it to work properly. The `void *` parameter is an opaque
- * pointer to user data (if any) forwarded directly to the process during an
- * update.
- *
- * * @code{.cpp}
- * void init();
- * @endcode
- *
- * It's invoked when the process joins the running queue of a scheduler. This
- * happens as soon as it's attached to the scheduler if the process is a top
- * level one, otherwise when it replaces its parent if the process is a
- * continuation.
- *
- * * @code{.cpp}
- * void succeeded();
- * @endcode
- *
- * It's invoked in case of success, immediately after an update and during the
- * same tick.
- *
- * * @code{.cpp}
- * void failed();
- * @endcode
- *
- * It's invoked in case of errors, immediately after an update and during the
- * same tick.
- *
- * * @code{.cpp}
- * void aborted();
- * @endcode
- *
- * It's invoked only if a process is explicitly aborted. There is no guarantee
- * that it executes in the same tick, this depends solely on whether the
- * process is aborted immediately or not.
- *
- * Derived classes can change the internal state of a process by invoking the
- * `succeed` and `fail` protected member functions and even pause or unpause the
- * process itself.
- *
- * @sa scheduler
- *
- * @tparam Derived Actual type of process that extends the class template.
- * @tparam Delta Type to use to provide elapsed time.
- */
- template<typename Derived, typename Delta>
- class process {
- enum class state: unsigned int {
- UNINITIALIZED = 0,
- RUNNING,
- PAUSED,
- SUCCEEDED,
- FAILED,
- ABORTED,
- FINISHED
- };
- template<typename Target = Derived>
- auto next(integral_constant<state::UNINITIALIZED>)
- -> decltype(std::declval<Target>().init(), void()) {
- static_cast<Target *>(this)->init();
- }
- template<typename Target = Derived>
- auto next(integral_constant<state::RUNNING>, Delta delta, void *data)
- -> decltype(std::declval<Target>().update(delta, data), void()) {
- static_cast<Target *>(this)->update(delta, data);
- }
- template<typename Target = Derived>
- auto next(integral_constant<state::SUCCEEDED>)
- -> decltype(std::declval<Target>().succeeded(), void()) {
- static_cast<Target *>(this)->succeeded();
- }
- template<typename Target = Derived>
- auto next(integral_constant<state::FAILED>)
- -> decltype(std::declval<Target>().failed(), void()) {
- static_cast<Target *>(this)->failed();
- }
- template<typename Target = Derived>
- auto next(integral_constant<state::ABORTED>)
- -> decltype(std::declval<Target>().aborted(), void()) {
- static_cast<Target *>(this)->aborted();
- }
- void next(...) const ENTT_NOEXCEPT {}
- protected:
- /**
- * @brief Terminates a process with success if it's still alive.
- *
- * The function is idempotent and it does nothing if the process isn't
- * alive.
- */
- void succeed() ENTT_NOEXCEPT {
- if(alive()) {
- current = state::SUCCEEDED;
- }
- }
- /**
- * @brief Terminates a process with errors if it's still alive.
- *
- * The function is idempotent and it does nothing if the process isn't
- * alive.
- */
- void fail() ENTT_NOEXCEPT {
- if(alive()) {
- current = state::FAILED;
- }
- }
- /**
- * @brief Stops a process if it's in a running state.
- *
- * The function is idempotent and it does nothing if the process isn't
- * running.
- */
- void pause() ENTT_NOEXCEPT {
- if(current == state::RUNNING) {
- current = state::PAUSED;
- }
- }
- /**
- * @brief Restarts a process if it's paused.
- *
- * The function is idempotent and it does nothing if the process isn't
- * paused.
- */
- void unpause() ENTT_NOEXCEPT {
- if(current == state::PAUSED) {
- current = state::RUNNING;
- }
- }
- public:
- /*! @brief Type used to provide elapsed time. */
- using delta_type = Delta;
- /*! @brief Default destructor. */
- virtual ~process() {
- static_assert(std::is_base_of_v<process, Derived>, "Incorrect use of the class template");
- }
- /**
- * @brief Aborts a process if it's still alive.
- *
- * The function is idempotent and it does nothing if the process isn't
- * alive.
- *
- * @param immediately Requests an immediate operation.
- */
- void abort(const bool immediately = false) {
- if(alive()) {
- current = state::ABORTED;
- if(immediately) {
- tick({});
- }
- }
- }
- /**
- * @brief Returns true if a process is either running or paused.
- * @return True if the process is still alive, false otherwise.
- */
- [[nodiscard]] bool alive() const ENTT_NOEXCEPT {
- return current == state::RUNNING || current == state::PAUSED;
- }
- /**
- * @brief Returns true if a process is already terminated.
- * @return True if the process is terminated, false otherwise.
- */
- [[nodiscard]] bool dead() const ENTT_NOEXCEPT {
- return current == state::FINISHED;
- }
- /**
- * @brief Returns true if a process is currently paused.
- * @return True if the process is paused, false otherwise.
- */
- [[nodiscard]] bool paused() const ENTT_NOEXCEPT {
- return current == state::PAUSED;
- }
- /**
- * @brief Returns true if a process terminated with errors.
- * @return True if the process terminated with errors, false otherwise.
- */
- [[nodiscard]] bool rejected() const ENTT_NOEXCEPT {
- return stopped;
- }
- /**
- * @brief Updates a process and its internal state if required.
- * @param delta Elapsed time.
- * @param data Optional data.
- */
- void tick(const Delta delta, void *data = nullptr) {
- switch (current) {
- case state::UNINITIALIZED:
- next(integral_constant<state::UNINITIALIZED>{});
- current = state::RUNNING;
- break;
- case state::RUNNING:
- next(integral_constant<state::RUNNING>{}, delta, data);
- break;
- default:
- // suppress warnings
- break;
- }
- // if it's dead, it must be notified and removed immediately
- switch(current) {
- case state::SUCCEEDED:
- next(integral_constant<state::SUCCEEDED>{});
- current = state::FINISHED;
- break;
- case state::FAILED:
- next(integral_constant<state::FAILED>{});
- current = state::FINISHED;
- stopped = true;
- break;
- case state::ABORTED:
- next(integral_constant<state::ABORTED>{});
- current = state::FINISHED;
- stopped = true;
- break;
- default:
- // suppress warnings
- break;
- }
- }
- private:
- state current{state::UNINITIALIZED};
- bool stopped{false};
- };
- /**
- * @brief Adaptor for lambdas and functors to turn them into processes.
- *
- * Lambdas and functors can't be used directly with a scheduler for they are not
- * properly defined processes with managed life cycles.<br/>
- * This class helps in filling the gap and turning lambdas and functors into
- * full featured processes usable by a scheduler.
- *
- * The signature of the function call operator should be equivalent to the
- * following:
- *
- * @code{.cpp}
- * void(Delta delta, void *data, auto succeed, auto fail);
- * @endcode
- *
- * Where:
- *
- * * `delta` is the elapsed time.
- * * `data` is an opaque pointer to user data if any, `nullptr` otherwise.
- * * `succeed` is a function to call when a process terminates with success.
- * * `fail` is a function to call when a process terminates with errors.
- *
- * The signature of the function call operator of both `succeed` and `fail`
- * is equivalent to the following:
- *
- * @code{.cpp}
- * void();
- * @endcode
- *
- * Usually users shouldn't worry about creating adaptors. A scheduler will
- * create them internally each and avery time a lambda or a functor is used as
- * a process.
- *
- * @sa process
- * @sa scheduler
- *
- * @tparam Func Actual type of process.
- * @tparam Delta Type to use to provide elapsed time.
- */
- template<typename Func, typename Delta>
- struct process_adaptor: process<process_adaptor<Func, Delta>, Delta>, private Func {
- /**
- * @brief Constructs a process adaptor from a lambda or a functor.
- * @tparam Args Types of arguments to use to initialize the actual process.
- * @param args Parameters to use to initialize the actual process.
- */
- template<typename... Args>
- process_adaptor(Args &&... args)
- : Func{std::forward<Args>(args)...}
- {}
- /**
- * @brief Updates a process and its internal state if required.
- * @param delta Elapsed time.
- * @param data Optional data.
- */
- void update(const Delta delta, void *data) {
- Func::operator()(delta, data, [this]() { this->succeed(); }, [this]() { this->fail(); });
- }
- };
- }
- #endif
- // #include "process/scheduler.hpp"
- #ifndef ENTT_PROCESS_SCHEDULER_HPP
- #define ENTT_PROCESS_SCHEDULER_HPP
- #include <vector>
- #include <memory>
- #include <utility>
- #include <algorithm>
- #include <type_traits>
- // #include "../config/config.h"
- // #include "process.hpp"
- namespace entt {
- /**
- * @brief Cooperative scheduler for processes.
- *
- * A cooperative scheduler runs processes and helps managing their life cycles.
- *
- * Each process is invoked once per tick. If a process terminates, it's
- * removed automatically from the scheduler and it's never invoked again.<br/>
- * A process can also have a child. In this case, the process is replaced with
- * its child when it terminates if it returns with success. In case of errors,
- * both the process and its child are discarded.
- *
- * Example of use (pseudocode):
- *
- * @code{.cpp}
- * scheduler.attach([](auto delta, void *, auto succeed, auto fail) {
- * // code
- * }).then<my_process>(arguments...);
- * @endcode
- *
- * In order to invoke all scheduled processes, call the `update` member function
- * passing it the elapsed time to forward to the tasks.
- *
- * @sa process
- *
- * @tparam Delta Type to use to provide elapsed time.
- */
- template<typename Delta>
- class scheduler {
- struct process_handler {
- using instance_type = std::unique_ptr<void, void(*)(void *)>;
- using update_fn_type = bool(process_handler &, Delta, void *);
- using abort_fn_type = void(process_handler &, bool);
- using next_type = std::unique_ptr<process_handler>;
- instance_type instance;
- update_fn_type *update;
- abort_fn_type *abort;
- next_type next;
- };
- struct continuation {
- continuation(process_handler *ref)
- : handler{ref}
- {
- ENTT_ASSERT(handler);
- }
- template<typename Proc, typename... Args>
- continuation then(Args &&... args) {
- static_assert(std::is_base_of_v<process<Proc, Delta>, Proc>, "Invalid process type");
- auto proc = typename process_handler::instance_type{new Proc{std::forward<Args>(args)...}, &scheduler::deleter<Proc>};
- handler->next.reset(new process_handler{std::move(proc), &scheduler::update<Proc>, &scheduler::abort<Proc>, nullptr});
- handler = handler->next.get();
- return *this;
- }
- template<typename Func>
- continuation then(Func &&func) {
- return then<process_adaptor<std::decay_t<Func>, Delta>>(std::forward<Func>(func));
- }
- private:
- process_handler *handler;
- };
- template<typename Proc>
- [[nodiscard]] static bool update(process_handler &handler, const Delta delta, void *data) {
- auto *process = static_cast<Proc *>(handler.instance.get());
- process->tick(delta, data);
- auto dead = process->dead();
- if(dead) {
- if(handler.next && !process->rejected()) {
- handler = std::move(*handler.next);
- // forces the process to exit the uninitialized state
- dead = handler.update(handler, {}, nullptr);
- } else {
- handler.instance.reset();
- }
- }
- return dead;
- }
- template<typename Proc>
- static void abort(process_handler &handler, const bool immediately) {
- static_cast<Proc *>(handler.instance.get())->abort(immediately);
- }
- template<typename Proc>
- static void deleter(void *proc) {
- delete static_cast<Proc *>(proc);
- }
- public:
- /*! @brief Unsigned integer type. */
- using size_type = std::size_t;
- /*! @brief Default constructor. */
- scheduler() = default;
- /*! @brief Default move constructor. */
- scheduler(scheduler &&) = default;
- /*! @brief Default move assignment operator. @return This scheduler. */
- scheduler & operator=(scheduler &&) = default;
- /**
- * @brief Number of processes currently scheduled.
- * @return Number of processes currently scheduled.
- */
- [[nodiscard]] size_type size() const ENTT_NOEXCEPT {
- return handlers.size();
- }
- /**
- * @brief Returns true if at least a process is currently scheduled.
- * @return True if there are scheduled processes, false otherwise.
- */
- [[nodiscard]] bool empty() const ENTT_NOEXCEPT {
- return handlers.empty();
- }
- /**
- * @brief Discards all scheduled processes.
- *
- * Processes aren't aborted. They are discarded along with their children
- * and never executed again.
- */
- void clear() {
- handlers.clear();
- }
- /**
- * @brief Schedules a process for the next tick.
- *
- * Returned value is an opaque object that can be used to attach a child to
- * the given process. The child is automatically scheduled when the process
- * terminates and only if the process returns with success.
- *
- * Example of use (pseudocode):
- *
- * @code{.cpp}
- * // schedules a task in the form of a process class
- * scheduler.attach<my_process>(arguments...)
- * // appends a child in the form of a lambda function
- * .then([](auto delta, void *, auto succeed, auto fail) {
- * // code
- * })
- * // appends a child in the form of another process class
- * .then<my_other_process>();
- * @endcode
- *
- * @tparam Proc Type of process to schedule.
- * @tparam Args Types of arguments to use to initialize the process.
- * @param args Parameters to use to initialize the process.
- * @return An opaque object to use to concatenate processes.
- */
- template<typename Proc, typename... Args>
- auto attach(Args &&... args) {
- static_assert(std::is_base_of_v<process<Proc, Delta>, Proc>, "Invalid process type");
- auto proc = typename process_handler::instance_type{new Proc{std::forward<Args>(args)...}, &scheduler::deleter<Proc>};
- process_handler handler{std::move(proc), &scheduler::update<Proc>, &scheduler::abort<Proc>, nullptr};
- // forces the process to exit the uninitialized state
- handler.update(handler, {}, nullptr);
- return continuation{&handlers.emplace_back(std::move(handler))};
- }
- /**
- * @brief Schedules a process for the next tick.
- *
- * A process can be either a lambda or a functor. The scheduler wraps both
- * of them in a process adaptor internally.<br/>
- * The signature of the function call operator should be equivalent to the
- * following:
- *
- * @code{.cpp}
- * void(Delta delta, void *data, auto succeed, auto fail);
- * @endcode
- *
- * Where:
- *
- * * `delta` is the elapsed time.
- * * `data` is an opaque pointer to user data if any, `nullptr` otherwise.
- * * `succeed` is a function to call when a process terminates with success.
- * * `fail` is a function to call when a process terminates with errors.
- *
- * The signature of the function call operator of both `succeed` and `fail`
- * is equivalent to the following:
- *
- * @code{.cpp}
- * void();
- * @endcode
- *
- * Returned value is an opaque object that can be used to attach a child to
- * the given process. The child is automatically scheduled when the process
- * terminates and only if the process returns with success.
- *
- * Example of use (pseudocode):
- *
- * @code{.cpp}
- * // schedules a task in the form of a lambda function
- * scheduler.attach([](auto delta, void *, auto succeed, auto fail) {
- * // code
- * })
- * // appends a child in the form of another lambda function
- * .then([](auto delta, void *, auto succeed, auto fail) {
- * // code
- * })
- * // appends a child in the form of a process class
- * .then<my_process>(arguments...);
- * @endcode
- *
- * @sa process_adaptor
- *
- * @tparam Func Type of process to schedule.
- * @param func Either a lambda or a functor to use as a process.
- * @return An opaque object to use to concatenate processes.
- */
- template<typename Func>
- auto attach(Func &&func) {
- using Proc = process_adaptor<std::decay_t<Func>, Delta>;
- return attach<Proc>(std::forward<Func>(func));
- }
- /**
- * @brief Updates all scheduled processes.
- *
- * All scheduled processes are executed in no specific order.<br/>
- * If a process terminates with success, it's replaced with its child, if
- * any. Otherwise, if a process terminates with an error, it's removed along
- * with its child.
- *
- * @param delta Elapsed time.
- * @param data Optional data.
- */
- void update(const Delta delta, void *data = nullptr) {
- bool clean = false;
- for(auto pos = handlers.size(); pos; --pos) {
- auto &handler = handlers[pos-1];
- const bool dead = handler.update(handler, delta, data);
- clean = clean || dead;
- }
- if(clean) {
- handlers.erase(std::remove_if(handlers.begin(), handlers.end(), [](auto &handler) {
- return !handler.instance;
- }), handlers.end());
- }
- }
- /**
- * @brief Aborts all scheduled processes.
- *
- * Unless an immediate operation is requested, the abort is scheduled for
- * the next tick. Processes won't be executed anymore in any case.<br/>
- * Once a process is fully aborted and thus finished, it's discarded along
- * with its child, if any.
- *
- * @param immediately Requests an immediate operation.
- */
- void abort(const bool immediately = false) {
- decltype(handlers) exec;
- exec.swap(handlers);
- for(auto &&handler: exec) {
- handler.abort(handler, immediately);
- }
- std::move(handlers.begin(), handlers.end(), std::back_inserter(exec));
- handlers.swap(exec);
- }
- private:
- std::vector<process_handler> handlers{};
- };
- }
- #endif
- // #include "resource/cache.hpp"
- #ifndef ENTT_RESOURCE_CACHE_HPP
- #define ENTT_RESOURCE_CACHE_HPP
- #include <memory>
- #include <type_traits>
- #include <unordered_map>
- #include <utility>
- // #include "../config/config.h"
- #ifndef ENTT_CONFIG_CONFIG_H
- #define ENTT_CONFIG_CONFIG_H
- #ifndef ENTT_NOEXCEPT
- # define ENTT_NOEXCEPT noexcept
- #endif
- #ifndef ENTT_HS_SUFFIX
- # define ENTT_HS_SUFFIX _hs
- #endif
- #ifndef ENTT_HWS_SUFFIX
- # define ENTT_HWS_SUFFIX _hws
- #endif
- #ifndef ENTT_USE_ATOMIC
- # define ENTT_MAYBE_ATOMIC(Type) Type
- #else
- # include <atomic>
- # define ENTT_MAYBE_ATOMIC(Type) std::atomic<Type>
- #endif
- #ifndef ENTT_ID_TYPE
- # include <cstdint>
- # define ENTT_ID_TYPE std::uint32_t
- #endif
- #ifndef ENTT_PAGE_SIZE
- # define ENTT_PAGE_SIZE 32768
- #endif
- #ifndef ENTT_ASSERT
- # include <cassert>
- # define ENTT_ASSERT(condition) assert(condition)
- #endif
- #ifndef ENTT_NO_ETO
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::is_empty<Type>
- #else
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::false_type
- #endif
- #ifndef ENTT_STANDARD_CPP
- # if defined __clang__ || (defined __GNUC__ && __GNUC__ > 8)
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined __GNUC__
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined _MSC_VER
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __FUNCSIG__
- # define ENTT_PRETTY_FUNCTION_PREFIX '<'
- # define ENTT_PRETTY_FUNCTION_SUFFIX '>'
- # endif
- #endif
- #ifndef ENTT_STANDALONE
- # define ENTT_FAST_PATH(...) false
- #else
- # define ENTT_FAST_PATH(Cond) Cond
- #endif
- #endif
- // #include "../core/fwd.hpp"
- #ifndef ENTT_CORE_FWD_HPP
- #define ENTT_CORE_FWD_HPP
- // #include "../config/config.h"
- #ifndef ENTT_CONFIG_CONFIG_H
- #define ENTT_CONFIG_CONFIG_H
- #ifndef ENTT_NOEXCEPT
- # define ENTT_NOEXCEPT noexcept
- #endif
- #ifndef ENTT_HS_SUFFIX
- # define ENTT_HS_SUFFIX _hs
- #endif
- #ifndef ENTT_HWS_SUFFIX
- # define ENTT_HWS_SUFFIX _hws
- #endif
- #ifndef ENTT_USE_ATOMIC
- # define ENTT_MAYBE_ATOMIC(Type) Type
- #else
- # include <atomic>
- # define ENTT_MAYBE_ATOMIC(Type) std::atomic<Type>
- #endif
- #ifndef ENTT_ID_TYPE
- # include <cstdint>
- # define ENTT_ID_TYPE std::uint32_t
- #endif
- #ifndef ENTT_PAGE_SIZE
- # define ENTT_PAGE_SIZE 32768
- #endif
- #ifndef ENTT_ASSERT
- # include <cassert>
- # define ENTT_ASSERT(condition) assert(condition)
- #endif
- #ifndef ENTT_NO_ETO
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::is_empty<Type>
- #else
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::false_type
- #endif
- #ifndef ENTT_STANDARD_CPP
- # if defined __clang__ || (defined __GNUC__ && __GNUC__ > 8)
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined __GNUC__
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined _MSC_VER
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __FUNCSIG__
- # define ENTT_PRETTY_FUNCTION_PREFIX '<'
- # define ENTT_PRETTY_FUNCTION_SUFFIX '>'
- # endif
- #endif
- #ifndef ENTT_STANDALONE
- # define ENTT_FAST_PATH(...) false
- #else
- # define ENTT_FAST_PATH(Cond) Cond
- #endif
- #endif
- namespace entt {
- /*! @brief Alias declaration for type identifiers. */
- using id_type = ENTT_ID_TYPE;
- }
- #endif
- // #include "handle.hpp"
- #ifndef ENTT_RESOURCE_HANDLE_HPP
- #define ENTT_RESOURCE_HANDLE_HPP
- #include <memory>
- #include <utility>
- // #include "../config/config.h"
- // #include "fwd.hpp"
- #ifndef ENTT_RESOURCE_FWD_HPP
- #define ENTT_RESOURCE_FWD_HPP
- namespace entt {
- template<typename>
- struct resource_cache;
- template<typename>
- class resource_handle;
- template<typename, typename>
- class resource_loader;
- }
- #endif
- namespace entt {
- /**
- * @brief Shared resource handle.
- *
- * A shared resource handle is a small class that wraps a resource and keeps it
- * alive even if it's deleted from the cache. It can be either copied or
- * moved. A handle shares a reference to the same resource with all the other
- * handles constructed for the same identifier.<br/>
- * As a rule of thumb, resources should never be copied nor moved. Handles are
- * the way to go to keep references to them.
- *
- * @tparam Resource Type of resource managed by a handle.
- */
- template<typename Resource>
- class resource_handle {
- /*! @brief Resource handles are friends of their caches. */
- friend struct resource_cache<Resource>;
- resource_handle(std::shared_ptr<Resource> res) ENTT_NOEXCEPT
- : resource{std::move(res)}
- {}
- public:
- /*! @brief Default constructor. */
- resource_handle() ENTT_NOEXCEPT = default;
- /**
- * @brief Gets a reference to the managed resource.
- *
- * @warning
- * The behavior is undefined if the handle doesn't contain a resource.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * handle is empty.
- *
- * @return A reference to the managed resource.
- */
- [[nodiscard]] const Resource & get() const ENTT_NOEXCEPT {
- ENTT_ASSERT(static_cast<bool>(resource));
- return *resource;
- }
- /*! @copydoc get */
- [[nodiscard]] Resource & get() ENTT_NOEXCEPT {
- return const_cast<Resource &>(std::as_const(*this).get());
- }
- /*! @copydoc get */
- [[nodiscard]] operator const Resource & () const ENTT_NOEXCEPT {
- return get();
- }
- /*! @copydoc get */
- [[nodiscard]] operator Resource & () ENTT_NOEXCEPT {
- return get();
- }
- /*! @copydoc get */
- [[nodiscard]] const Resource & operator *() const ENTT_NOEXCEPT {
- return get();
- }
- /*! @copydoc get */
- [[nodiscard]] Resource & operator *() ENTT_NOEXCEPT {
- return get();
- }
- /**
- * @brief Gets a pointer to the managed resource.
- *
- * @warning
- * The behavior is undefined if the handle doesn't contain a resource.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * handle is empty.
- *
- * @return A pointer to the managed resource or `nullptr` if the handle
- * contains no resource at all.
- */
- [[nodiscard]] const Resource * operator->() const ENTT_NOEXCEPT {
- ENTT_ASSERT(static_cast<bool>(resource));
- return resource.get();
- }
- /*! @copydoc operator-> */
- [[nodiscard]] Resource * operator->() ENTT_NOEXCEPT {
- return const_cast<Resource *>(std::as_const(*this).operator->());
- }
- /**
- * @brief Returns true if a handle contains a resource, false otherwise.
- * @return True if the handle contains a resource, false otherwise.
- */
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- return static_cast<bool>(resource);
- }
- private:
- std::shared_ptr<Resource> resource;
- };
- }
- #endif
- // #include "loader.hpp"
- #ifndef ENTT_RESOURCE_LOADER_HPP
- #define ENTT_RESOURCE_LOADER_HPP
- #include <memory>
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @brief Base class for resource loaders.
- *
- * Resource loaders must inherit from this class and stay true to the CRTP
- * idiom. Moreover, a resource loader must expose a public, const member
- * function named `load` that accepts a variable number of arguments and returns
- * a shared pointer to the resource just created.<br/>
- * As an example:
- *
- * @code{.cpp}
- * struct my_resource {};
- *
- * struct my_loader: entt::resource_loader<my_loader, my_resource> {
- * std::shared_ptr<my_resource> load(int) const {
- * // use the integer value somehow
- * return std::make_shared<my_resource>();
- * }
- * };
- * @endcode
- *
- * In general, resource loaders should not have a state or retain data of any
- * type. They should let the cache manage their resources instead.
- *
- * @note
- * Base class and CRTP idiom aren't strictly required with the current
- * implementation. One could argue that a cache can easily work with loaders of
- * any type. However, future changes won't be breaking ones by forcing the use
- * of a base class today and that's why the model is already in its place.
- *
- * @tparam Loader Type of the derived class.
- * @tparam Resource Type of resource for which to use the loader.
- */
- template<typename Loader, typename Resource>
- class resource_loader {
- /*! @brief Resource loaders are friends of their caches. */
- friend struct resource_cache<Resource>;
- /**
- * @brief Loads the resource and returns it.
- * @tparam Args Types of arguments for the loader.
- * @param args Arguments for the loader.
- * @return The resource just loaded or an empty pointer in case of errors.
- */
- template<typename... Args>
- [[nodiscard]] std::shared_ptr<Resource> get(Args &&... args) const {
- return static_cast<const Loader *>(this)->load(std::forward<Args>(args)...);
- }
- };
- }
- #endif
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @brief Simple cache for resources of a given type.
- *
- * Minimal implementation of a cache for resources of a given type. It doesn't
- * offer much functionalities but it's suitable for small or medium sized
- * applications and can be freely inherited to add targeted functionalities for
- * large sized applications.
- *
- * @tparam Resource Type of resources managed by a cache.
- */
- template<typename Resource>
- struct resource_cache {
- /*! @brief Unsigned integer type. */
- using size_type = std::size_t;
- /*! @brief Type of resources managed by a cache. */
- using resource_type = Resource;
- /*! @brief Default constructor. */
- resource_cache() = default;
- /*! @brief Default move constructor. */
- resource_cache(resource_cache &&) = default;
- /*! @brief Default move assignment operator. @return This cache. */
- resource_cache & operator=(resource_cache &&) = default;
- /**
- * @brief Number of resources managed by a cache.
- * @return Number of resources currently stored.
- */
- [[nodiscard]] size_type size() const ENTT_NOEXCEPT {
- return resources.size();
- }
- /**
- * @brief Returns true if a cache contains no resources, false otherwise.
- * @return True if the cache contains no resources, false otherwise.
- */
- [[nodiscard]] bool empty() const ENTT_NOEXCEPT {
- return resources.empty();
- }
- /**
- * @brief Clears a cache and discards all its resources.
- *
- * Handles are not invalidated and the memory used by a resource isn't
- * freed as long as at least a handle keeps the resource itself alive.
- */
- void clear() ENTT_NOEXCEPT {
- resources.clear();
- }
- /**
- * @brief Loads the resource that corresponds to a given identifier.
- *
- * In case an identifier isn't already present in the cache, it loads its
- * resource and stores it aside for future uses. Arguments are forwarded
- * directly to the loader in order to construct properly the requested
- * resource.
- *
- * @note
- * If the identifier is already present in the cache, this function does
- * nothing and the arguments are simply discarded.
- *
- * @warning
- * If the resource cannot be loaded correctly, the returned handle will be
- * invalid and any use of it will result in undefined behavior.
- *
- * @tparam Loader Type of loader to use to load the resource if required.
- * @tparam Args Types of arguments to use to load the resource if required.
- * @param id Unique resource identifier.
- * @param args Arguments to use to load the resource if required.
- * @return A handle for the given resource.
- */
- template<typename Loader, typename... Args>
- resource_handle<Resource> load(const id_type id, Args &&... args) {
- static_assert(std::is_base_of_v<resource_loader<Loader, Resource>, Loader>, "Invalid loader type");
- resource_handle<Resource> resource{};
- if(auto it = resources.find(id); it == resources.cend()) {
- if(auto instance = Loader{}.get(std::forward<Args>(args)...); instance) {
- resources[id] = instance;
- resource = std::move(instance);
- }
- } else {
- resource = it->second;
- }
- return resource;
- }
- /**
- * @brief Reloads a resource or loads it for the first time if not present.
- *
- * Equivalent to the following snippet (pseudocode):
- *
- * @code{.cpp}
- * cache.discard(id);
- * cache.load(id, args...);
- * @endcode
- *
- * Arguments are forwarded directly to the loader in order to construct
- * properly the requested resource.
- *
- * @warning
- * If the resource cannot be loaded correctly, the returned handle will be
- * invalid and any use of it will result in undefined behavior.
- *
- * @tparam Loader Type of loader to use to load the resource.
- * @tparam Args Types of arguments to use to load the resource.
- * @param id Unique resource identifier.
- * @param args Arguments to use to load the resource.
- * @return A handle for the given resource.
- */
- template<typename Loader, typename... Args>
- resource_handle<Resource> reload(const id_type id, Args &&... args) {
- return (discard(id), load<Loader>(id, std::forward<Args>(args)...));
- }
- /**
- * @brief Creates a temporary handle for a resource.
- *
- * Arguments are forwarded directly to the loader in order to construct
- * properly the requested resource. The handle isn't stored aside and the
- * cache isn't in charge of the lifetime of the resource itself.
- *
- * @tparam Loader Type of loader to use to load the resource.
- * @tparam Args Types of arguments to use to load the resource.
- * @param args Arguments to use to load the resource.
- * @return A handle for the given resource.
- */
- template<typename Loader, typename... Args>
- [[nodiscard]] resource_handle<Resource> temp(Args &&... args) const {
- return { Loader{}.get(std::forward<Args>(args)...) };
- }
- /**
- * @brief Creates a handle for a given resource identifier.
- *
- * A resource handle can be in a either valid or invalid state. In other
- * terms, a resource handle is properly initialized with a resource if the
- * cache contains the resource itself. Otherwise the returned handle is
- * uninitialized and accessing it results in undefined behavior.
- *
- * @sa resource_handle
- *
- * @param id Unique resource identifier.
- * @return A handle for the given resource.
- */
- [[nodiscard]] resource_handle<Resource> handle(const id_type id) const {
- auto it = resources.find(id);
- return { it == resources.end() ? nullptr : it->second };
- }
- /**
- * @brief Checks if a cache contains a given identifier.
- * @param id Unique resource identifier.
- * @return True if the cache contains the resource, false otherwise.
- */
- [[nodiscard]] bool contains(const id_type id) const {
- return (resources.find(id) != resources.cend());
- }
- /**
- * @brief Discards the resource that corresponds to a given identifier.
- *
- * Handles are not invalidated and the memory used by the resource isn't
- * freed as long as at least a handle keeps the resource itself alive.
- *
- * @param id Unique resource identifier.
- */
- void discard(const id_type id) {
- if(auto it = resources.find(id); it != resources.end()) {
- resources.erase(it);
- }
- }
- /**
- * @brief Iterates all resources.
- *
- * The function object is invoked for each element. It is provided with
- * either the resource identifier, the resource handle or both of them.<br/>
- * The signature of the function must be equivalent to one of the following
- * forms:
- *
- * @code{.cpp}
- * void(const entt::id_type);
- * void(entt::resource_handle<Resource>);
- * void(const entt::id_type, entt::resource_handle<Resource>);
- * @endcode
- *
- * @tparam Func Type of the function object to invoke.
- * @param func A valid function object.
- */
- template <typename Func>
- void each(Func func) const {
- auto begin = resources.begin();
- auto end = resources.end();
- while(begin != end) {
- auto curr = begin++;
- if constexpr(std::is_invocable_v<Func, id_type>) {
- func(curr->first);
- } else if constexpr(std::is_invocable_v<Func, resource_handle<Resource>>) {
- func(resource_handle{ curr->second });
- } else {
- func(curr->first, resource_handle{ curr->second });
- }
- }
- }
- private:
- std::unordered_map<id_type, std::shared_ptr<Resource>> resources;
- };
- }
- #endif
- // #include "resource/handle.hpp"
- // #include "resource/loader.hpp"
- // #include "signal/delegate.hpp"
- #ifndef ENTT_SIGNAL_DELEGATE_HPP
- #define ENTT_SIGNAL_DELEGATE_HPP
- #include <tuple>
- #include <cstddef>
- #include <utility>
- #include <functional>
- #include <type_traits>
- // #include "../config/config.h"
- #ifndef ENTT_CONFIG_CONFIG_H
- #define ENTT_CONFIG_CONFIG_H
- #ifndef ENTT_NOEXCEPT
- # define ENTT_NOEXCEPT noexcept
- #endif
- #ifndef ENTT_HS_SUFFIX
- # define ENTT_HS_SUFFIX _hs
- #endif
- #ifndef ENTT_HWS_SUFFIX
- # define ENTT_HWS_SUFFIX _hws
- #endif
- #ifndef ENTT_USE_ATOMIC
- # define ENTT_MAYBE_ATOMIC(Type) Type
- #else
- # include <atomic>
- # define ENTT_MAYBE_ATOMIC(Type) std::atomic<Type>
- #endif
- #ifndef ENTT_ID_TYPE
- # include <cstdint>
- # define ENTT_ID_TYPE std::uint32_t
- #endif
- #ifndef ENTT_PAGE_SIZE
- # define ENTT_PAGE_SIZE 32768
- #endif
- #ifndef ENTT_ASSERT
- # include <cassert>
- # define ENTT_ASSERT(condition) assert(condition)
- #endif
- #ifndef ENTT_NO_ETO
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::is_empty<Type>
- #else
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::false_type
- #endif
- #ifndef ENTT_STANDARD_CPP
- # if defined __clang__ || (defined __GNUC__ && __GNUC__ > 8)
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined __GNUC__
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined _MSC_VER
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __FUNCSIG__
- # define ENTT_PRETTY_FUNCTION_PREFIX '<'
- # define ENTT_PRETTY_FUNCTION_SUFFIX '>'
- # endif
- #endif
- #ifndef ENTT_STANDALONE
- # define ENTT_FAST_PATH(...) false
- #else
- # define ENTT_FAST_PATH(Cond) Cond
- #endif
- #endif
- namespace entt {
- /**
- * @cond TURN_OFF_DOXYGEN
- * Internal details not to be documented.
- */
- namespace internal {
- template<typename Ret, typename... Args>
- auto function_pointer(Ret(*)(Args...)) -> Ret(*)(Args...);
- template<typename Ret, typename Type, typename... Args, typename Other>
- auto function_pointer(Ret(*)(Type, Args...), Other &&) -> Ret(*)(Args...);
- template<typename Class, typename Ret, typename... Args, typename... Other>
- auto function_pointer(Ret(Class:: *)(Args...), Other &&...) -> Ret(*)(Args...);
- template<typename Class, typename Ret, typename... Args, typename... Other>
- auto function_pointer(Ret(Class:: *)(Args...) const, Other &&...) -> Ret(*)(Args...);
- template<typename Class, typename Type, typename... Other>
- auto function_pointer(Type Class:: *, Other &&...) -> Type(*)();
- template<typename... Type>
- using function_pointer_t = decltype(internal::function_pointer(std::declval<Type>()...));
- template<typename... Class, typename Ret, typename... Args>
- [[nodiscard]] constexpr auto index_sequence_for(Ret(*)(Args...)) {
- return std::index_sequence_for<Class..., Args...>{};
- }
- }
- /**
- * Internal details not to be documented.
- * @endcond
- */
- /*! @brief Used to wrap a function or a member of a specified type. */
- template<auto>
- struct connect_arg_t {};
- /*! @brief Constant of type connect_arg_t used to disambiguate calls. */
- template<auto Func>
- inline constexpr connect_arg_t<Func> connect_arg{};
- /**
- * @brief Basic delegate implementation.
- *
- * Primary template isn't defined on purpose. All the specializations give a
- * compile-time error unless the template parameter is a function type.
- */
- template<typename>
- class delegate;
- /**
- * @brief Utility class to use to send around functions and members.
- *
- * Unmanaged delegate for function pointers and members. Users of this class are
- * in charge of disconnecting instances before deleting them.
- *
- * A delegate can be used as a general purpose invoker without memory overhead
- * for free functions possibly with payloads and bound or unbound members.
- *
- * @tparam Ret Return type of a function type.
- * @tparam Args Types of arguments of a function type.
- */
- template<typename Ret, typename... Args>
- class delegate<Ret(Args...)> {
- template<auto Candidate, std::size_t... Index>
- [[nodiscard]] auto wrap(std::index_sequence<Index...>) ENTT_NOEXCEPT {
- return [](const void *, Args... args) -> Ret {
- [[maybe_unused]] const auto arguments = std::forward_as_tuple(std::forward<Args>(args)...);
- return Ret(std::invoke(Candidate, std::forward<std::tuple_element_t<Index, std::tuple<Args...>>>(std::get<Index>(arguments))...));
- };
- }
- template<auto Candidate, typename Type, std::size_t... Index>
- [[nodiscard]] auto wrap(Type &, std::index_sequence<Index...>) ENTT_NOEXCEPT {
- return [](const void *payload, Args... args) -> Ret {
- [[maybe_unused]] const auto arguments = std::forward_as_tuple(std::forward<Args>(args)...);
- Type *curr = static_cast<Type *>(const_cast<std::conditional_t<std::is_const_v<Type>, const void *, void *>>(payload));
- return Ret(std::invoke(Candidate, *curr, std::forward<std::tuple_element_t<Index, std::tuple<Args...>>>(std::get<Index>(arguments))...));
- };
- }
- template<auto Candidate, typename Type, std::size_t... Index>
- [[nodiscard]] auto wrap(Type *, std::index_sequence<Index...>) ENTT_NOEXCEPT {
- return [](const void *payload, Args... args) -> Ret {
- [[maybe_unused]] const auto arguments = std::forward_as_tuple(std::forward<Args>(args)...);
- Type *curr = static_cast<Type *>(const_cast<std::conditional_t<std::is_const_v<Type>, const void *, void *>>(payload));
- return Ret(std::invoke(Candidate, curr, std::forward<std::tuple_element_t<Index, std::tuple<Args...>>>(std::get<Index>(arguments))...));
- };
- }
- public:
- /*! @brief Function type of the contained target. */
- using function_type = Ret(const void *, Args...);
- /*! @brief Function type of the delegate. */
- using type = Ret(Args...);
- /*! @brief Return type of the delegate. */
- using result_type = Ret;
- /*! @brief Default constructor. */
- delegate() ENTT_NOEXCEPT
- : fn{nullptr}, data{nullptr}
- {}
- /**
- * @brief Constructs a delegate and connects a free function or an unbound
- * member.
- * @tparam Candidate Function or member to connect to the delegate.
- */
- template<auto Candidate>
- delegate(connect_arg_t<Candidate>) ENTT_NOEXCEPT {
- connect<Candidate>();
- }
- /**
- * @brief Constructs a delegate and connects a free function with payload or
- * a bound member.
- * @tparam Candidate Function or member to connect to the delegate.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid object that fits the purpose.
- */
- template<auto Candidate, typename Type>
- delegate(connect_arg_t<Candidate>, Type &&value_or_instance) ENTT_NOEXCEPT {
- connect<Candidate>(std::forward<Type>(value_or_instance));
- }
- /**
- * @brief Constructs a delegate and connects an user defined function with
- * optional payload.
- * @param function Function to connect to the delegate.
- * @param payload User defined arbitrary data.
- */
- delegate(function_type *function, const void *payload = nullptr) ENTT_NOEXCEPT {
- connect(function, payload);
- }
- /**
- * @brief Connects a free function or an unbound member to a delegate.
- * @tparam Candidate Function or member to connect to the delegate.
- */
- template<auto Candidate>
- void connect() ENTT_NOEXCEPT {
- data = nullptr;
- if constexpr(std::is_invocable_r_v<Ret, decltype(Candidate), Args...>) {
- fn = [](const void *, Args... args) -> Ret {
- return Ret(std::invoke(Candidate, std::forward<Args>(args)...));
- };
- } else if constexpr(std::is_member_pointer_v<decltype(Candidate)>) {
- fn = wrap<Candidate>(internal::index_sequence_for<std::tuple_element_t<0, std::tuple<Args...>>>(internal::function_pointer_t<decltype(Candidate)>{}));
- } else {
- fn = wrap<Candidate>(internal::index_sequence_for(internal::function_pointer_t<decltype(Candidate)>{}));
- }
- }
- /**
- * @brief Connects a free function with payload or a bound member to a
- * delegate.
- *
- * The delegate isn't responsible for the connected object or the payload.
- * Users must always guarantee that the lifetime of the instance overcomes
- * the one of the delegate.<br/>
- * When used to connect a free function with payload, its signature must be
- * such that the instance is the first argument before the ones used to
- * define the delegate itself.
- *
- * @tparam Candidate Function or member to connect to the delegate.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid reference that fits the purpose.
- */
- template<auto Candidate, typename Type>
- void connect(Type &value_or_instance) ENTT_NOEXCEPT {
- data = &value_or_instance;
- if constexpr(std::is_invocable_r_v<Ret, decltype(Candidate), Type &, Args...>) {
- fn = [](const void *payload, Args... args) -> Ret {
- Type *curr = static_cast<Type *>(const_cast<std::conditional_t<std::is_const_v<Type>, const void *, void *>>(payload));
- return Ret(std::invoke(Candidate, *curr, std::forward<Args>(args)...));
- };
- } else {
- fn = wrap<Candidate>(value_or_instance, internal::index_sequence_for(internal::function_pointer_t<decltype(Candidate), Type>{}));
- }
- }
- /**
- * @brief Connects a free function with payload or a bound member to a
- * delegate.
- *
- * @sa connect(Type &)
- *
- * @tparam Candidate Function or member to connect to the delegate.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid pointer that fits the purpose.
- */
- template<auto Candidate, typename Type>
- void connect(Type *value_or_instance) ENTT_NOEXCEPT {
- data = value_or_instance;
- if constexpr(std::is_invocable_r_v<Ret, decltype(Candidate), Type *, Args...>) {
- fn = [](const void *payload, Args... args) -> Ret {
- Type *curr = static_cast<Type *>(const_cast<std::conditional_t<std::is_const_v<Type>, const void *, void *>>(payload));
- return Ret(std::invoke(Candidate, curr, std::forward<Args>(args)...));
- };
- } else {
- fn = wrap<Candidate>(value_or_instance, internal::index_sequence_for(internal::function_pointer_t<decltype(Candidate), Type>{}));
- }
- }
- /**
- * @brief Connects an user defined function with optional payload to a
- * delegate.
- *
- * The delegate isn't responsible for the connected object or the payload.
- * Users must always guarantee that the lifetime of an instance overcomes
- * the one of the delegate.<br/>
- * The payload is returned as the first argument to the target function in
- * all cases.
- *
- * @param function Function to connect to the delegate.
- * @param payload User defined arbitrary data.
- */
- void connect(function_type *function, const void *payload = nullptr) ENTT_NOEXCEPT {
- fn = function;
- data = payload;
- }
- /**
- * @brief Resets a delegate.
- *
- * After a reset, a delegate cannot be invoked anymore.
- */
- void reset() ENTT_NOEXCEPT {
- fn = nullptr;
- data = nullptr;
- }
- /**
- * @brief Returns the instance or the payload linked to a delegate, if any.
- * @return An opaque pointer to the underlying data.
- */
- [[nodiscard]] const void * instance() const ENTT_NOEXCEPT {
- return data;
- }
- /**
- * @brief Triggers a delegate.
- *
- * The delegate invokes the underlying function and returns the result.
- *
- * @warning
- * Attempting to trigger an invalid delegate results in undefined
- * behavior.<br/>
- * An assertion will abort the execution at runtime in debug mode if the
- * delegate has not yet been set.
- *
- * @param args Arguments to use to invoke the underlying function.
- * @return The value returned by the underlying function.
- */
- Ret operator()(Args... args) const {
- ENTT_ASSERT(fn);
- return fn(data, std::forward<Args>(args)...);
- }
- /**
- * @brief Checks whether a delegate actually stores a listener.
- * @return False if the delegate is empty, true otherwise.
- */
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- // no need to test also data
- return !(fn == nullptr);
- }
- /**
- * @brief Compares the contents of two delegates.
- * @param other Delegate with which to compare.
- * @return False if the two contents differ, true otherwise.
- */
- [[nodiscard]] bool operator==(const delegate<Ret(Args...)> &other) const ENTT_NOEXCEPT {
- return fn == other.fn && data == other.data;
- }
- private:
- function_type *fn;
- const void *data;
- };
- /**
- * @brief Compares the contents of two delegates.
- * @tparam Ret Return type of a function type.
- * @tparam Args Types of arguments of a function type.
- * @param lhs A valid delegate object.
- * @param rhs A valid delegate object.
- * @return True if the two contents differ, false otherwise.
- */
- template<typename Ret, typename... Args>
- [[nodiscard]] bool operator!=(const delegate<Ret(Args...)> &lhs, const delegate<Ret(Args...)> &rhs) ENTT_NOEXCEPT {
- return !(lhs == rhs);
- }
- /**
- * @brief Deduction guide.
- * @tparam Candidate Function or member to connect to the delegate.
- */
- template<auto Candidate>
- delegate(connect_arg_t<Candidate>) ENTT_NOEXCEPT
- -> delegate<std::remove_pointer_t<internal::function_pointer_t<decltype(Candidate)>>>;
- /**
- * @brief Deduction guide.
- * @tparam Candidate Function or member to connect to the delegate.
- * @tparam Type Type of class or type of payload.
- */
- template<auto Candidate, typename Type>
- delegate(connect_arg_t<Candidate>, Type &&) ENTT_NOEXCEPT
- -> delegate<std::remove_pointer_t<internal::function_pointer_t<decltype(Candidate), Type>>>;
- /*! @brief Deduction guide. */
- template<typename Ret, typename... Args>
- delegate(Ret(*)(const void *, Args...), const void * = nullptr) ENTT_NOEXCEPT
- -> delegate<Ret(Args...)>;
- }
- #endif
- // #include "signal/dispatcher.hpp"
- #ifndef ENTT_SIGNAL_DISPATCHER_HPP
- #define ENTT_SIGNAL_DISPATCHER_HPP
- #include <cstddef>
- #include <memory>
- #include <type_traits>
- #include <utility>
- #include <vector>
- // #include "../config/config.h"
- // #include "../core/fwd.hpp"
- #ifndef ENTT_CORE_FWD_HPP
- #define ENTT_CORE_FWD_HPP
- // #include "../config/config.h"
- #ifndef ENTT_CONFIG_CONFIG_H
- #define ENTT_CONFIG_CONFIG_H
- #ifndef ENTT_NOEXCEPT
- # define ENTT_NOEXCEPT noexcept
- #endif
- #ifndef ENTT_HS_SUFFIX
- # define ENTT_HS_SUFFIX _hs
- #endif
- #ifndef ENTT_HWS_SUFFIX
- # define ENTT_HWS_SUFFIX _hws
- #endif
- #ifndef ENTT_USE_ATOMIC
- # define ENTT_MAYBE_ATOMIC(Type) Type
- #else
- # include <atomic>
- # define ENTT_MAYBE_ATOMIC(Type) std::atomic<Type>
- #endif
- #ifndef ENTT_ID_TYPE
- # include <cstdint>
- # define ENTT_ID_TYPE std::uint32_t
- #endif
- #ifndef ENTT_PAGE_SIZE
- # define ENTT_PAGE_SIZE 32768
- #endif
- #ifndef ENTT_ASSERT
- # include <cassert>
- # define ENTT_ASSERT(condition) assert(condition)
- #endif
- #ifndef ENTT_NO_ETO
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::is_empty<Type>
- #else
- # include <type_traits>
- # define ENTT_IS_EMPTY(Type) std::false_type
- #endif
- #ifndef ENTT_STANDARD_CPP
- # if defined __clang__ || (defined __GNUC__ && __GNUC__ > 8)
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined __GNUC__
- # define ENTT_PRETTY_FUNCTION __PRETTY_FUNCTION__
- # define ENTT_PRETTY_FUNCTION_PREFIX '='
- # define ENTT_PRETTY_FUNCTION_SUFFIX ']'
- # elif defined _MSC_VER
- # define ENTT_PRETTY_FUNCTION_CONSTEXPR
- # define ENTT_PRETTY_FUNCTION __FUNCSIG__
- # define ENTT_PRETTY_FUNCTION_PREFIX '<'
- # define ENTT_PRETTY_FUNCTION_SUFFIX '>'
- # endif
- #endif
- #ifndef ENTT_STANDALONE
- # define ENTT_FAST_PATH(...) false
- #else
- # define ENTT_FAST_PATH(Cond) Cond
- #endif
- #endif
- namespace entt {
- /*! @brief Alias declaration for type identifiers. */
- using id_type = ENTT_ID_TYPE;
- }
- #endif
- // #include "../core/type_info.hpp"
- #ifndef ENTT_CORE_TYPE_INFO_HPP
- #define ENTT_CORE_TYPE_INFO_HPP
- #include <string_view>
- // #include "../config/config.h"
- // #include "../core/attribute.h"
- #ifndef ENTT_CORE_ATTRIBUTE_H
- #define ENTT_CORE_ATTRIBUTE_H
- #ifndef ENTT_EXPORT
- # if defined _WIN32 || defined __CYGWIN__ || defined _MSC_VER
- # define ENTT_EXPORT __declspec(dllexport)
- # define ENTT_IMPORT __declspec(dllimport)
- # define ENTT_HIDDEN
- # elif defined __GNUC__ && __GNUC__ >= 4
- # define ENTT_EXPORT __attribute__((visibility("default")))
- # define ENTT_IMPORT __attribute__((visibility("default")))
- # define ENTT_HIDDEN __attribute__((visibility("hidden")))
- # else /* Unsupported compiler */
- # define ENTT_EXPORT
- # define ENTT_IMPORT
- # define ENTT_HIDDEN
- # endif
- #endif
- #ifndef ENTT_API
- # if defined ENTT_API_EXPORT
- # define ENTT_API ENTT_EXPORT
- # elif defined ENTT_API_IMPORT
- # define ENTT_API ENTT_IMPORT
- # else /* No API */
- # define ENTT_API
- # endif
- #endif
- #endif
- // #include "hashed_string.hpp"
- #ifndef ENTT_CORE_HASHED_STRING_HPP
- #define ENTT_CORE_HASHED_STRING_HPP
- #include <cstddef>
- #include <cstdint>
- // #include "../config/config.h"
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @cond TURN_OFF_DOXYGEN
- * Internal details not to be documented.
- */
- namespace internal {
- template<typename>
- struct fnv1a_traits;
- template<>
- struct fnv1a_traits<std::uint32_t> {
- using type = std::uint32_t;
- static constexpr std::uint32_t offset = 2166136261;
- static constexpr std::uint32_t prime = 16777619;
- };
- template<>
- struct fnv1a_traits<std::uint64_t> {
- using type = std::uint64_t;
- static constexpr std::uint64_t offset = 14695981039346656037ull;
- static constexpr std::uint64_t prime = 1099511628211ull;
- };
- }
- /**
- * Internal details not to be documented.
- * @endcond
- */
- /**
- * @brief Zero overhead unique identifier.
- *
- * A hashed string is a compile-time tool that allows users to use
- * human-readable identifers in the codebase while using their numeric
- * counterparts at runtime.<br/>
- * Because of that, a hashed string can also be used in constant expressions if
- * required.
- *
- * @tparam Char Character type.
- */
- template<typename Char>
- class basic_hashed_string {
- using traits_type = internal::fnv1a_traits<id_type>;
- struct const_wrapper {
- // non-explicit constructor on purpose
- constexpr const_wrapper(const Char *curr) ENTT_NOEXCEPT: str{curr} {}
- const Char *str;
- };
- // Fowler–Noll–Vo hash function v. 1a - the good
- [[nodiscard]] static constexpr id_type helper(const Char *curr) ENTT_NOEXCEPT {
- auto value = traits_type::offset;
- while(*curr != 0) {
- value = (value ^ static_cast<traits_type::type>(*(curr++))) * traits_type::prime;
- }
- return value;
- }
- public:
- /*! @brief Character type. */
- using value_type = Char;
- /*! @brief Unsigned integer type. */
- using hash_type = id_type;
- /**
- * @brief Returns directly the numeric representation of a string.
- *
- * Forcing template resolution avoids implicit conversions. An
- * human-readable identifier can be anything but a plain, old bunch of
- * characters.<br/>
- * Example of use:
- * @code{.cpp}
- * const auto value = basic_hashed_string<char>::to_value("my.png");
- * @endcode
- *
- * @tparam N Number of characters of the identifier.
- * @param str Human-readable identifer.
- * @return The numeric representation of the string.
- */
- template<std::size_t N>
- [[nodiscard]] static constexpr hash_type value(const value_type (&str)[N]) ENTT_NOEXCEPT {
- return helper(str);
- }
- /**
- * @brief Returns directly the numeric representation of a string.
- * @param wrapper Helps achieving the purpose by relying on overloading.
- * @return The numeric representation of the string.
- */
- [[nodiscard]] static hash_type value(const_wrapper wrapper) ENTT_NOEXCEPT {
- return helper(wrapper.str);
- }
- /**
- * @brief Returns directly the numeric representation of a string view.
- * @param str Human-readable identifer.
- * @param size Length of the string to hash.
- * @return The numeric representation of the string.
- */
- [[nodiscard]] static hash_type value(const value_type *str, std::size_t size) ENTT_NOEXCEPT {
- id_type partial{traits_type::offset};
- while(size--) { partial = (partial^(str++)[0])*traits_type::prime; }
- return partial;
- }
- /*! @brief Constructs an empty hashed string. */
- constexpr basic_hashed_string() ENTT_NOEXCEPT
- : str{nullptr}, hash{}
- {}
- /**
- * @brief Constructs a hashed string from an array of const characters.
- *
- * Forcing template resolution avoids implicit conversions. An
- * human-readable identifier can be anything but a plain, old bunch of
- * characters.<br/>
- * Example of use:
- * @code{.cpp}
- * basic_hashed_string<char> hs{"my.png"};
- * @endcode
- *
- * @tparam N Number of characters of the identifier.
- * @param curr Human-readable identifer.
- */
- template<std::size_t N>
- constexpr basic_hashed_string(const value_type (&curr)[N]) ENTT_NOEXCEPT
- : str{curr}, hash{helper(curr)}
- {}
- /**
- * @brief Explicit constructor on purpose to avoid constructing a hashed
- * string directly from a `const value_type *`.
- * @param wrapper Helps achieving the purpose by relying on overloading.
- */
- explicit constexpr basic_hashed_string(const_wrapper wrapper) ENTT_NOEXCEPT
- : str{wrapper.str}, hash{helper(wrapper.str)}
- {}
- /**
- * @brief Returns the human-readable representation of a hashed string.
- * @return The string used to initialize the instance.
- */
- [[nodiscard]] constexpr const value_type * data() const ENTT_NOEXCEPT {
- return str;
- }
- /**
- * @brief Returns the numeric representation of a hashed string.
- * @return The numeric representation of the instance.
- */
- [[nodiscard]] constexpr hash_type value() const ENTT_NOEXCEPT {
- return hash;
- }
- /*! @copydoc data */
- [[nodiscard]] constexpr operator const value_type *() const ENTT_NOEXCEPT { return data(); }
- /**
- * @brief Returns the numeric representation of a hashed string.
- * @return The numeric representation of the instance.
- */
- [[nodiscard]] constexpr operator hash_type() const ENTT_NOEXCEPT { return value(); }
- /**
- * @brief Compares two hashed strings.
- * @param other Hashed string with which to compare.
- * @return True if the two hashed strings are identical, false otherwise.
- */
- [[nodiscard]] constexpr bool operator==(const basic_hashed_string &other) const ENTT_NOEXCEPT {
- return hash == other.hash;
- }
- private:
- const value_type *str;
- hash_type hash;
- };
- /**
- * @brief Deduction guide.
- *
- * It allows to deduce the character type of the hashed string directly from a
- * human-readable identifer provided to the constructor.
- *
- * @tparam Char Character type.
- * @tparam N Number of characters of the identifier.
- * @param str Human-readable identifer.
- */
- template<typename Char, std::size_t N>
- basic_hashed_string(const Char (&str)[N]) ENTT_NOEXCEPT
- -> basic_hashed_string<Char>;
- /**
- * @brief Compares two hashed strings.
- * @tparam Char Character type.
- * @param lhs A valid hashed string.
- * @param rhs A valid hashed string.
- * @return True if the two hashed strings are identical, false otherwise.
- */
- template<typename Char>
- [[nodiscard]] constexpr bool operator!=(const basic_hashed_string<Char> &lhs, const basic_hashed_string<Char> &rhs) ENTT_NOEXCEPT {
- return !(lhs == rhs);
- }
- /*! @brief Aliases for common character types. */
- using hashed_string = basic_hashed_string<char>;
- /*! @brief Aliases for common character types. */
- using hashed_wstring = basic_hashed_string<wchar_t>;
- }
- /**
- * @brief User defined literal for hashed strings.
- * @param str The literal without its suffix.
- * @return A properly initialized hashed string.
- */
- [[nodiscard]] constexpr entt::hashed_string operator"" ENTT_HS_SUFFIX(const char *str, std::size_t) ENTT_NOEXCEPT {
- return entt::hashed_string{str};
- }
- /**
- * @brief User defined literal for hashed wstrings.
- * @param str The literal without its suffix.
- * @return A properly initialized hashed wstring.
- */
- [[nodiscard]] constexpr entt::hashed_wstring operator"" ENTT_HWS_SUFFIX(const wchar_t *str, std::size_t) ENTT_NOEXCEPT {
- return entt::hashed_wstring{str};
- }
- #endif
- // #include "fwd.hpp"
- namespace entt {
- /**
- * @cond TURN_OFF_DOXYGEN
- * Internal details not to be documented.
- */
- namespace internal {
- struct ENTT_API type_index {
- [[nodiscard]] static id_type next() ENTT_NOEXCEPT {
- static ENTT_MAYBE_ATOMIC(id_type) value{};
- return value++;
- }
- };
- template<typename Type>
- [[nodiscard]] constexpr auto type_name() ENTT_NOEXCEPT {
- #if defined ENTT_PRETTY_FUNCTION
- std::string_view pretty_function{ENTT_PRETTY_FUNCTION};
- auto first = pretty_function.find_first_not_of(' ', pretty_function.find_first_of(ENTT_PRETTY_FUNCTION_PREFIX)+1);
- auto value = pretty_function.substr(first, pretty_function.find_last_of(ENTT_PRETTY_FUNCTION_SUFFIX) - first);
- return value;
- #else
- return std::string_view{};
- #endif
- }
- }
- /**
- * Internal details not to be documented.
- * @endcond
- */
- /**
- * @brief Type index.
- * @tparam Type Type for which to generate a sequential identifier.
- */
- template<typename Type, typename = void>
- struct ENTT_API type_index {
- /**
- * @brief Returns the sequential identifier of a given type.
- * @return The sequential identifier of a given type.
- */
- [[nodiscard]] static id_type value() ENTT_NOEXCEPT {
- static const id_type value = internal::type_index::next();
- return value;
- }
- };
- /**
- * @brief Provides the member constant `value` to true if a given type is
- * indexable, false otherwise.
- * @tparam Type Potentially indexable type.
- */
- template<typename, typename = void>
- struct has_type_index: std::false_type {};
- /*! @brief has_type_index */
- template<typename Type>
- struct has_type_index<Type, std::void_t<decltype(type_index<Type>::value())>>: std::true_type {};
- /**
- * @brief Helper variable template.
- * @tparam Type Potentially indexable type.
- */
- template<typename Type>
- inline constexpr bool has_type_index_v = has_type_index<Type>::value;
- /**
- * @brief Type info.
- * @tparam Type Type for which to generate information.
- */
- template<typename Type, typename = void>
- struct type_info {
- /**
- * @brief Returns the numeric representation of a given type.
- * @return The numeric representation of the given type.
- */
- #if defined ENTT_PRETTY_FUNCTION_CONSTEXPR
- [[nodiscard]] static constexpr id_type id() ENTT_NOEXCEPT {
- constexpr auto value = hashed_string::value(ENTT_PRETTY_FUNCTION);
- return value;
- }
- #elif defined ENTT_PRETTY_FUNCTION
- [[nodiscard]] static id_type id() ENTT_NOEXCEPT {
- static const auto value = hashed_string::value(ENTT_PRETTY_FUNCTION);
- return value;
- }
- #else
- [[nodiscard]] static id_type id() ENTT_NOEXCEPT {
- return type_index<Type>::value();
- }
- #endif
- /**
- * @brief Returns the name of a given type.
- * @return The name of the given type.
- */
- #if defined ENTT_PRETTY_FUNCTION_CONSTEXPR
- [[nodiscard]] static constexpr std::string_view name() ENTT_NOEXCEPT {
- constexpr auto value = internal::type_name<Type>();
- return value;
- }
- #elif defined ENTT_PRETTY_FUNCTION
- [[nodiscard]] static std::string_view name() ENTT_NOEXCEPT {
- static const auto value = internal::type_name<Type>();
- return value;
- }
- #else
- [[nodiscard]] static constexpr std::string_view name() ENTT_NOEXCEPT {
- return internal::type_name<Type>();
- }
- #endif
- };
- }
- #endif
- // #include "sigh.hpp"
- #ifndef ENTT_SIGNAL_SIGH_HPP
- #define ENTT_SIGNAL_SIGH_HPP
- #include <vector>
- #include <utility>
- #include <iterator>
- #include <algorithm>
- #include <functional>
- #include <type_traits>
- // #include "../config/config.h"
- // #include "delegate.hpp"
- // #include "fwd.hpp"
- #ifndef ENTT_SIGNAL_FWD_HPP
- #define ENTT_SIGNAL_FWD_HPP
- namespace entt {
- template<typename>
- class delegate;
- class dispatcher;
- template<typename>
- class emitter;
- class connection;
- struct scoped_connection;
- template<typename>
- class sink;
- template<typename>
- class sigh;
- }
- #endif
- namespace entt {
- /**
- * @brief Sink class.
- *
- * Primary template isn't defined on purpose. All the specializations give a
- * compile-time error unless the template parameter is a function type.
- *
- * @tparam Function A valid function type.
- */
- template<typename Function>
- class sink;
- /**
- * @brief Unmanaged signal handler.
- *
- * Primary template isn't defined on purpose. All the specializations give a
- * compile-time error unless the template parameter is a function type.
- *
- * @tparam Function A valid function type.
- */
- template<typename Function>
- class sigh;
- /**
- * @brief Unmanaged signal handler.
- *
- * It works directly with references to classes and pointers to member functions
- * as well as pointers to free functions. Users of this class are in charge of
- * disconnecting instances before deleting them.
- *
- * This class serves mainly two purposes:
- *
- * * Creating signals to use later to notify a bunch of listeners.
- * * Collecting results from a set of functions like in a voting system.
- *
- * @tparam Ret Return type of a function type.
- * @tparam Args Types of arguments of a function type.
- */
- template<typename Ret, typename... Args>
- class sigh<Ret(Args...)> {
- /*! @brief A sink is allowed to modify a signal. */
- friend class sink<Ret(Args...)>;
- public:
- /*! @brief Unsigned integer type. */
- using size_type = std::size_t;
- /*! @brief Sink type. */
- using sink_type = sink<Ret(Args...)>;
- /**
- * @brief Instance type when it comes to connecting member functions.
- * @tparam Class Type of class to which the member function belongs.
- */
- template<typename Class>
- using instance_type = Class *;
- /**
- * @brief Number of listeners connected to the signal.
- * @return Number of listeners currently connected.
- */
- [[nodiscard]] size_type size() const ENTT_NOEXCEPT {
- return calls.size();
- }
- /**
- * @brief Returns false if at least a listener is connected to the signal.
- * @return True if the signal has no listeners connected, false otherwise.
- */
- [[nodiscard]] bool empty() const ENTT_NOEXCEPT {
- return calls.empty();
- }
- /**
- * @brief Triggers a signal.
- *
- * All the listeners are notified. Order isn't guaranteed.
- *
- * @param args Arguments to use to invoke listeners.
- */
- void publish(Args... args) const {
- for(auto &&call: std::as_const(calls)) {
- call(args...);
- }
- }
- /**
- * @brief Collects return values from the listeners.
- *
- * The collector must expose a call operator with the following properties:
- *
- * * The return type is either `void` or such that it's convertible to
- * `bool`. In the second case, a true value will stop the iteration.
- * * The list of parameters is empty if `Ret` is `void`, otherwise it
- * contains a single element such that `Ret` is convertible to it.
- *
- * @tparam Func Type of collector to use, if any.
- * @param func A valid function object.
- * @param args Arguments to use to invoke listeners.
- */
- template<typename Func>
- void collect(Func func, Args... args) const {
- for(auto &&call: calls) {
- if constexpr(std::is_void_v<Ret>) {
- if constexpr(std::is_invocable_r_v<bool, Func>) {
- call(args...);
- if(func()) { break; }
- } else {
- call(args...);
- func();
- }
- } else {
- if constexpr(std::is_invocable_r_v<bool, Func, Ret>) {
- if(func(call(args...))) { break; }
- } else {
- func(call(args...));
- }
- }
- }
- }
- private:
- std::vector<delegate<Ret(Args...)>> calls;
- };
- /**
- * @brief Connection class.
- *
- * Opaque object the aim of which is to allow users to release an already
- * estabilished connection without having to keep a reference to the signal or
- * the sink that generated it.
- */
- class connection {
- /*! @brief A sink is allowed to create connection objects. */
- template<typename>
- friend class sink;
- connection(delegate<void(void *)> fn, void *ref)
- : disconnect{fn}, signal{ref}
- {}
- public:
- /*! @brief Default constructor. */
- connection() = default;
- /**
- * @brief Checks whether a connection is properly initialized.
- * @return True if the connection is properly initialized, false otherwise.
- */
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- return static_cast<bool>(disconnect);
- }
- /*! @brief Breaks the connection. */
- void release() {
- if(disconnect) {
- disconnect(signal);
- disconnect.reset();
- }
- }
- private:
- delegate<void(void *)> disconnect;
- void *signal{};
- };
- /**
- * @brief Scoped connection class.
- *
- * Opaque object the aim of which is to allow users to release an already
- * estabilished connection without having to keep a reference to the signal or
- * the sink that generated it.<br/>
- * A scoped connection automatically breaks the link between the two objects
- * when it goes out of scope.
- */
- struct scoped_connection {
- /*! @brief Default constructor. */
- scoped_connection() = default;
- /**
- * @brief Constructs a scoped connection from a basic connection.
- * @param other A valid connection object.
- */
- scoped_connection(const connection &other)
- : conn{other}
- {}
- /*! @brief Default copy constructor, deleted on purpose. */
- scoped_connection(const scoped_connection &) = delete;
- /*! @brief Automatically breaks the link on destruction. */
- ~scoped_connection() {
- conn.release();
- }
- /**
- * @brief Default copy assignment operator, deleted on purpose.
- * @return This scoped connection.
- */
- scoped_connection & operator=(const scoped_connection &) = delete;
- /**
- * @brief Acquires a connection.
- * @param other The connection object to acquire.
- * @return This scoped connection.
- */
- scoped_connection & operator=(connection other) {
- conn = std::move(other);
- return *this;
- }
- /**
- * @brief Checks whether a scoped connection is properly initialized.
- * @return True if the connection is properly initialized, false otherwise.
- */
- [[nodiscard]] explicit operator bool() const ENTT_NOEXCEPT {
- return static_cast<bool>(conn);
- }
- /*! @brief Breaks the connection. */
- void release() {
- conn.release();
- }
- private:
- connection conn;
- };
- /**
- * @brief Sink class.
- *
- * A sink is used to connect listeners to signals and to disconnect them.<br/>
- * The function type for a listener is the one of the signal to which it
- * belongs.
- *
- * The clear separation between a signal and a sink permits to store the former
- * as private data member without exposing the publish functionality to the
- * users of the class.
- *
- * @warning
- * Lifetime of a sink must not overcome that of the signal to which it refers.
- * In any other case, attempting to use a sink results in undefined behavior.
- *
- * @tparam Ret Return type of a function type.
- * @tparam Args Types of arguments of a function type.
- */
- template<typename Ret, typename... Args>
- class sink<Ret(Args...)> {
- using signal_type = sigh<Ret(Args...)>;
- using difference_type = typename std::iterator_traits<typename decltype(signal_type::calls)::iterator>::difference_type;
- template<auto Candidate, typename Type>
- static void release(Type value_or_instance, void *signal) {
- sink{*static_cast<signal_type *>(signal)}.disconnect<Candidate>(value_or_instance);
- }
- template<auto Candidate>
- static void release(void *signal) {
- sink{*static_cast<signal_type *>(signal)}.disconnect<Candidate>();
- }
- public:
- /**
- * @brief Constructs a sink that is allowed to modify a given signal.
- * @param ref A valid reference to a signal object.
- */
- sink(sigh<Ret(Args...)> &ref) ENTT_NOEXCEPT
- : offset{},
- signal{&ref}
- {}
- /**
- * @brief Returns false if at least a listener is connected to the sink.
- * @return True if the sink has no listeners connected, false otherwise.
- */
- [[nodiscard]] bool empty() const ENTT_NOEXCEPT {
- return signal->calls.empty();
- }
- /**
- * @brief Returns a sink that connects before a given free function or an
- * unbound member.
- * @tparam Function A valid free function pointer.
- * @return A properly initialized sink object.
- */
- template<auto Function>
- [[nodiscard]] sink before() {
- delegate<Ret(Args...)> call{};
- call.template connect<Function>();
- const auto &calls = signal->calls;
- const auto it = std::find(calls.cbegin(), calls.cend(), std::move(call));
- sink other{*this};
- other.offset = std::distance(it, calls.cend());
- return other;
- }
- /**
- * @brief Returns a sink that connects before a free function with payload
- * or a bound member.
- * @tparam Candidate Member or free function to look for.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid object that fits the purpose.
- * @return A properly initialized sink object.
- */
- template<auto Candidate, typename Type>
- [[nodiscard]] sink before(Type &&value_or_instance) {
- delegate<Ret(Args...)> call{};
- call.template connect<Candidate>(value_or_instance);
- const auto &calls = signal->calls;
- const auto it = std::find(calls.cbegin(), calls.cend(), std::move(call));
- sink other{*this};
- other.offset = std::distance(it, calls.cend());
- return other;
- }
- /**
- * @brief Returns a sink that connects before a given instance or specific
- * payload.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid object that fits the purpose.
- * @return A properly initialized sink object.
- */
- template<typename Type>
- [[nodiscard]] sink before(Type &value_or_instance) {
- return before(&value_or_instance);
- }
- /**
- * @brief Returns a sink that connects before a given instance or specific
- * payload.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid pointer that fits the purpose.
- * @return A properly initialized sink object.
- */
- template<typename Type>
- [[nodiscard]] sink before(Type *value_or_instance) {
- sink other{*this};
- if(value_or_instance) {
- const auto &calls = signal->calls;
- const auto it = std::find_if(calls.cbegin(), calls.cend(), [value_or_instance](const auto &delegate) {
- return delegate.instance() == value_or_instance;
- });
- other.offset = std::distance(it, calls.cend());
- }
- return other;
- }
- /**
- * @brief Returns a sink that connects before anything else.
- * @return A properly initialized sink object.
- */
- [[nodiscard]] sink before() {
- sink other{*this};
- other.offset = signal->calls.size();
- return other;
- }
- /**
- * @brief Connects a free function or an unbound member to a signal.
- *
- * The signal handler performs checks to avoid multiple connections for the
- * same function.
- *
- * @tparam Candidate Function or member to connect to the signal.
- * @return A properly initialized connection object.
- */
- template<auto Candidate>
- connection connect() {
- disconnect<Candidate>();
- delegate<Ret(Args...)> call{};
- call.template connect<Candidate>();
- signal->calls.insert(signal->calls.end() - offset, std::move(call));
- delegate<void(void *)> conn{};
- conn.template connect<&release<Candidate>>();
- return { std::move(conn), signal };
- }
- /**
- * @brief Connects a free function with payload or a bound member to a
- * signal.
- *
- * The signal isn't responsible for the connected object or the payload.
- * Users must always guarantee that the lifetime of the instance overcomes
- * the one of the signal. On the other side, the signal handler performs
- * checks to avoid multiple connections for the same function.<br/>
- * When used to connect a free function with payload, its signature must be
- * such that the instance is the first argument before the ones used to
- * define the signal itself.
- *
- * @tparam Candidate Function or member to connect to the signal.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid object that fits the purpose.
- * @return A properly initialized connection object.
- */
- template<auto Candidate, typename Type>
- connection connect(Type &&value_or_instance) {
- disconnect<Candidate>(value_or_instance);
- delegate<Ret(Args...)> call{};
- call.template connect<Candidate>(value_or_instance);
- signal->calls.insert(signal->calls.end() - offset, std::move(call));
- delegate<void(void *)> conn{};
- conn.template connect<&release<Candidate, Type>>(value_or_instance);
- return { std::move(conn), signal };
- }
- /**
- * @brief Disconnects a free function or an unbound member from a signal.
- * @tparam Candidate Function or member to disconnect from the signal.
- */
- template<auto Candidate>
- void disconnect() {
- auto &calls = signal->calls;
- delegate<Ret(Args...)> call{};
- call.template connect<Candidate>();
- calls.erase(std::remove(calls.begin(), calls.end(), std::move(call)), calls.end());
- }
- /**
- * @brief Disconnects a free function with payload or a bound member from a
- * signal.
- * @tparam Candidate Function or member to disconnect from the signal.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid object that fits the purpose.
- */
- template<auto Candidate, typename Type>
- void disconnect(Type &&value_or_instance) {
- auto &calls = signal->calls;
- delegate<Ret(Args...)> call{};
- call.template connect<Candidate>(value_or_instance);
- calls.erase(std::remove(calls.begin(), calls.end(), std::move(call)), calls.end());
- }
- /**
- * @brief Disconnects free functions with payload or bound members from a
- * signal.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid object that fits the purpose.
- */
- template<typename Type>
- void disconnect(Type &value_or_instance) {
- disconnect(&value_or_instance);
- }
- /**
- * @brief Disconnects free functions with payload or bound members from a
- * signal.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid object that fits the purpose.
- */
- template<typename Type>
- void disconnect(Type *value_or_instance) {
- if(value_or_instance) {
- auto &calls = signal->calls;
- calls.erase(std::remove_if(calls.begin(), calls.end(), [value_or_instance](const auto &delegate) {
- return delegate.instance() == value_or_instance;
- }), calls.end());
- }
- }
- /*! @brief Disconnects all the listeners from a signal. */
- void disconnect() {
- signal->calls.clear();
- }
- private:
- difference_type offset;
- signal_type *signal;
- };
- /**
- * @brief Deduction guide.
- *
- * It allows to deduce the function type of a sink directly from the signal it
- * refers to.
- *
- * @tparam Ret Return type of a function type.
- * @tparam Args Types of arguments of a function type.
- */
- template<typename Ret, typename... Args>
- sink(sigh<Ret(Args...)> &) ENTT_NOEXCEPT -> sink<Ret(Args...)>;
- }
- #endif
- namespace entt {
- /**
- * @brief Basic dispatcher implementation.
- *
- * A dispatcher can be used either to trigger an immediate event or to enqueue
- * events to be published all together once per tick.<br/>
- * Listeners are provided in the form of member functions. For each event of
- * type `Event`, listeners are such that they can be invoked with an argument of
- * type `Event &`, no matter what the return type is.
- *
- * The dispatcher creates instances of the `sigh` class internally. Refer to the
- * documentation of the latter for more details.
- */
- class dispatcher {
- struct basic_pool {
- virtual ~basic_pool() = default;
- virtual void publish() = 0;
- virtual void disconnect(void *) = 0;
- virtual void clear() ENTT_NOEXCEPT = 0;
- [[nodiscard]] virtual id_type type_id() const ENTT_NOEXCEPT = 0;
- };
- template<typename Event>
- struct pool_handler final: basic_pool {
- using signal_type = sigh<void(Event &)>;
- using sink_type = typename signal_type::sink_type;
- void publish() override {
- const auto length = events.size();
- for(std::size_t pos{}; pos < length; ++pos) {
- signal.publish(events[pos]);
- }
- events.erase(events.cbegin(), events.cbegin()+length);
- }
- void disconnect(void *instance) override {
- sink().disconnect(instance);
- }
- void clear() ENTT_NOEXCEPT override {
- events.clear();
- }
- [[nodiscard]] sink_type sink() ENTT_NOEXCEPT {
- return entt::sink{signal};
- }
- template<typename... Args>
- void trigger(Args &&... args) {
- Event instance{std::forward<Args>(args)...};
- signal.publish(instance);
- }
- template<typename... Args>
- void enqueue(Args &&... args) {
- if constexpr(std::is_aggregate_v<Event>) {
- events.push_back(Event{std::forward<Args>(args)...});
- } else {
- events.emplace_back(std::forward<Args>(args)...);
- }
- }
- [[nodiscard]] id_type type_id() const ENTT_NOEXCEPT override {
- return type_info<Event>::id();
- }
- private:
- signal_type signal{};
- std::vector<Event> events;
- };
- template<typename Event>
- [[nodiscard]] pool_handler<Event> & assure() {
- static_assert(std::is_same_v<Event, std::decay_t<Event>>, "Invalid event type");
- if constexpr(ENTT_FAST_PATH(has_type_index_v<Event>)) {
- const auto index = type_index<Event>::value();
- if(!(index < pools.size())) {
- pools.resize(index+1u);
- }
- if(!pools[index]) {
- pools[index].reset(new pool_handler<Event>{});
- }
- return static_cast<pool_handler<Event> &>(*pools[index]);
- } else {
- auto it = std::find_if(pools.begin(), pools.end(), [id = type_info<Event>::id()](const auto &cpool) { return id == cpool->type_id(); });
- return static_cast<pool_handler<Event> &>(it == pools.cend() ? *pools.emplace_back(new pool_handler<Event>{}) : **it);
- }
- }
- public:
- /**
- * @brief Returns a sink object for the given event.
- *
- * A sink is an opaque object used to connect listeners to events.
- *
- * The function type for a listener is _compatible_ with:
- * @code{.cpp}
- * void(Event &);
- * @endcode
- *
- * The order of invocation of the listeners isn't guaranteed.
- *
- * @sa sink
- *
- * @tparam Event Type of event of which to get the sink.
- * @return A temporary sink object.
- */
- template<typename Event>
- [[nodiscard]] auto sink() {
- return assure<Event>().sink();
- }
- /**
- * @brief Triggers an immediate event of the given type.
- *
- * All the listeners registered for the given type are immediately notified.
- * The event is discarded after the execution.
- *
- * @tparam Event Type of event to trigger.
- * @tparam Args Types of arguments to use to construct the event.
- * @param args Arguments to use to construct the event.
- */
- template<typename Event, typename... Args>
- void trigger(Args &&... args) {
- assure<Event>().trigger(std::forward<Args>(args)...);
- }
- /**
- * @brief Triggers an immediate event of the given type.
- *
- * All the listeners registered for the given type are immediately notified.
- * The event is discarded after the execution.
- *
- * @tparam Event Type of event to trigger.
- * @param event An instance of the given type of event.
- */
- template<typename Event>
- void trigger(Event &&event) {
- assure<std::decay_t<Event>>().trigger(std::forward<Event>(event));
- }
- /**
- * @brief Enqueues an event of the given type.
- *
- * An event of the given type is queued. No listener is invoked. Use the
- * `update` member function to notify listeners when ready.
- *
- * @tparam Event Type of event to enqueue.
- * @tparam Args Types of arguments to use to construct the event.
- * @param args Arguments to use to construct the event.
- */
- template<typename Event, typename... Args>
- void enqueue(Args &&... args) {
- assure<Event>().enqueue(std::forward<Args>(args)...);
- }
- /**
- * @brief Enqueues an event of the given type.
- *
- * An event of the given type is queued. No listener is invoked. Use the
- * `update` member function to notify listeners when ready.
- *
- * @tparam Event Type of event to enqueue.
- * @param event An instance of the given type of event.
- */
- template<typename Event>
- void enqueue(Event &&event) {
- assure<std::decay_t<Event>>().enqueue(std::forward<Event>(event));
- }
- /**
- * @brief Utility function to disconnect everything related to a given value
- * or instance from a dispatcher.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid object that fits the purpose.
- */
- template<typename Type>
- void disconnect(Type &value_or_instance) {
- disconnect(&value_or_instance);
- }
- /**
- * @brief Utility function to disconnect everything related to a given value
- * or instance from a dispatcher.
- * @tparam Type Type of class or type of payload.
- * @param value_or_instance A valid object that fits the purpose.
- */
- template<typename Type>
- void disconnect(Type *value_or_instance) {
- for(auto &&cpool: pools) {
- if(cpool) {
- cpool->disconnect(value_or_instance);
- }
- }
- }
- /**
- * @brief Discards all the events queued so far.
- *
- * If no types are provided, the dispatcher will clear all the existing
- * pools.
- *
- * @tparam Event Type of events to discard.
- */
- template<typename... Event>
- void clear() {
- if constexpr(sizeof...(Event) == 0) {
- for(auto &&cpool: pools) {
- if(cpool) {
- cpool->clear();
- }
- }
- } else {
- (assure<Event>().clear(), ...);
- }
- }
- /**
- * @brief Delivers all the pending events of the given type.
- *
- * This method is blocking and it doesn't return until all the events are
- * delivered to the registered listeners. It's responsibility of the users
- * to reduce at a minimum the time spent in the bodies of the listeners.
- *
- * @tparam Event Type of events to send.
- */
- template<typename Event>
- void update() {
- assure<Event>().publish();
- }
- /**
- * @brief Delivers all the pending events.
- *
- * This method is blocking and it doesn't return until all the events are
- * delivered to the registered listeners. It's responsibility of the users
- * to reduce at a minimum the time spent in the bodies of the listeners.
- */
- void update() const {
- for(auto pos = pools.size(); pos; --pos) {
- if(auto &&cpool = pools[pos-1]; cpool) {
- cpool->publish();
- }
- }
- }
- private:
- std::vector<std::unique_ptr<basic_pool>> pools;
- };
- }
- #endif
- // #include "signal/emitter.hpp"
- #ifndef ENTT_SIGNAL_EMITTER_HPP
- #define ENTT_SIGNAL_EMITTER_HPP
- #include <algorithm>
- #include <functional>
- #include <iterator>
- #include <list>
- #include <memory>
- #include <type_traits>
- #include <utility>
- #include <vector>
- // #include "../config/config.h"
- // #include "../core/fwd.hpp"
- // #include "../core/type_info.hpp"
- namespace entt {
- /**
- * @brief General purpose event emitter.
- *
- * The emitter class template follows the CRTP idiom. To create a custom emitter
- * type, derived classes must inherit directly from the base class as:
- *
- * @code{.cpp}
- * struct my_emitter: emitter<my_emitter> {
- * // ...
- * }
- * @endcode
- *
- * Pools for the type of events are created internally on the fly. It's not
- * required to specify in advance the full list of accepted types.<br/>
- * Moreover, whenever an event is published, an emitter provides the listeners
- * with a reference to itself along with a reference to the event. Therefore
- * listeners have an handy way to work with it without incurring in the need of
- * capturing a reference to the emitter.
- *
- * @tparam Derived Actual type of emitter that extends the class template.
- */
- template<typename Derived>
- class emitter {
- struct basic_pool {
- virtual ~basic_pool() = default;
- virtual bool empty() const ENTT_NOEXCEPT = 0;
- virtual void clear() ENTT_NOEXCEPT = 0;
- virtual id_type type_id() const ENTT_NOEXCEPT = 0;
- };
- template<typename Event>
- struct pool_handler final: basic_pool {
- using listener_type = std::function<void(Event &, Derived &)>;
- using element_type = std::pair<bool, listener_type>;
- using container_type = std::list<element_type>;
- using connection_type = typename container_type::iterator;
- [[nodiscard]] bool empty() const ENTT_NOEXCEPT override {
- auto pred = [](auto &&element) { return element.first; };
- return std::all_of(once_list.cbegin(), once_list.cend(), pred) &&
- std::all_of(on_list.cbegin(), on_list.cend(), pred);
- }
- void clear() ENTT_NOEXCEPT override {
- if(publishing) {
- for(auto &&element: once_list) {
- element.first = true;
- }
- for(auto &&element: on_list) {
- element.first = true;
- }
- } else {
- once_list.clear();
- on_list.clear();
- }
- }
- connection_type once(listener_type listener) {
- return once_list.emplace(once_list.cend(), false, std::move(listener));
- }
- connection_type on(listener_type listener) {
- return on_list.emplace(on_list.cend(), false, std::move(listener));
- }
- void erase(connection_type conn) {
- conn->first = true;
- if(!publishing) {
- auto pred = [](auto &&element) { return element.first; };
- once_list.remove_if(pred);
- on_list.remove_if(pred);
- }
- }
- void publish(Event &event, Derived &ref) {
- container_type swap_list;
- once_list.swap(swap_list);
- publishing = true;
- for(auto &&element: on_list) {
- element.first ? void() : element.second(event, ref);
- }
- for(auto &&element: swap_list) {
- element.first ? void() : element.second(event, ref);
- }
- publishing = false;
- on_list.remove_if([](auto &&element) { return element.first; });
- }
- [[nodiscard]] id_type type_id() const ENTT_NOEXCEPT override {
- return type_info<Event>::id();
- }
- private:
- bool publishing{false};
- container_type once_list{};
- container_type on_list{};
- };
- template<typename Event>
- [[nodiscard]] const pool_handler<Event> & assure() const {
- static_assert(std::is_same_v<Event, std::decay_t<Event>>, "Invalid event type");
- if constexpr(ENTT_FAST_PATH(has_type_index_v<Event>)) {
- const auto index = type_index<Event>::value();
- if(!(index < pools.size())) {
- pools.resize(index+1u);
- }
- if(!pools[index]) {
- pools[index].reset(new pool_handler<Event>{});
- }
- return static_cast<pool_handler<Event> &>(*pools[index]);
- } else {
- auto it = std::find_if(pools.begin(), pools.end(), [id = type_info<Event>::id()](const auto &cpool) { return id == cpool->type_id(); });
- return static_cast<pool_handler<Event> &>(it == pools.cend() ? *pools.emplace_back(new pool_handler<Event>{}) : **it);
- }
- }
- template<typename Event>
- [[nodiscard]] pool_handler<Event> & assure() {
- return const_cast<pool_handler<Event> &>(std::as_const(*this).template assure<Event>());
- }
- public:
- /** @brief Type of listeners accepted for the given event. */
- template<typename Event>
- using listener = typename pool_handler<Event>::listener_type;
- /**
- * @brief Generic connection type for events.
- *
- * Type of the connection object returned by the event emitter whenever a
- * listener for the given type is registered.<br/>
- * It can be used to break connections still in use.
- *
- * @tparam Event Type of event for which the connection is created.
- */
- template<typename Event>
- struct connection: private pool_handler<Event>::connection_type {
- /** @brief Event emitters are friend classes of connections. */
- friend class emitter;
- /*! @brief Default constructor. */
- connection() = default;
- /**
- * @brief Creates a connection that wraps its underlying instance.
- * @param conn A connection object to wrap.
- */
- connection(typename pool_handler<Event>::connection_type conn)
- : pool_handler<Event>::connection_type{std::move(conn)}
- {}
- };
- /*! @brief Default constructor. */
- emitter() = default;
- /*! @brief Default destructor. */
- virtual ~emitter() {
- static_assert(std::is_base_of_v<emitter<Derived>, Derived>, "Incorrect use of the class template");
- }
- /*! @brief Default move constructor. */
- emitter(emitter &&) = default;
- /*! @brief Default move assignment operator. @return This emitter. */
- emitter & operator=(emitter &&) = default;
- /**
- * @brief Emits the given event.
- *
- * All the listeners registered for the specific event type are invoked with
- * the given event. The event type must either have a proper constructor for
- * the arguments provided or be an aggregate type.
- *
- * @tparam Event Type of event to publish.
- * @tparam Args Types of arguments to use to construct the event.
- * @param args Parameters to use to initialize the event.
- */
- template<typename Event, typename... Args>
- void publish(Args &&... args) {
- Event instance{std::forward<Args>(args)...};
- assure<Event>().publish(instance, *static_cast<Derived *>(this));
- }
- /**
- * @brief Registers a long-lived listener with the event emitter.
- *
- * This method can be used to register a listener designed to be invoked
- * more than once for the given event type.<br/>
- * The connection returned by the method can be freely discarded. It's meant
- * to be used later to disconnect the listener if required.
- *
- * The listener is as a callable object that can be moved and the type of
- * which is _compatible_ with `void(Event &, Derived &)`.
- *
- * @note
- * Whenever an event is emitted, the emitter provides the listener with a
- * reference to the derived class. Listeners don't have to capture those
- * instances for later uses.
- *
- * @tparam Event Type of event to which to connect the listener.
- * @param instance The listener to register.
- * @return Connection object that can be used to disconnect the listener.
- */
- template<typename Event>
- connection<Event> on(listener<Event> instance) {
- return assure<Event>().on(std::move(instance));
- }
- /**
- * @brief Registers a short-lived listener with the event emitter.
- *
- * This method can be used to register a listener designed to be invoked
- * only once for the given event type.<br/>
- * The connection returned by the method can be freely discarded. It's meant
- * to be used later to disconnect the listener if required.
- *
- * The listener is as a callable object that can be moved and the type of
- * which is _compatible_ with `void(Event &, Derived &)`.
- *
- * @note
- * Whenever an event is emitted, the emitter provides the listener with a
- * reference to the derived class. Listeners don't have to capture those
- * instances for later uses.
- *
- * @tparam Event Type of event to which to connect the listener.
- * @param instance The listener to register.
- * @return Connection object that can be used to disconnect the listener.
- */
- template<typename Event>
- connection<Event> once(listener<Event> instance) {
- return assure<Event>().once(std::move(instance));
- }
- /**
- * @brief Disconnects a listener from the event emitter.
- *
- * Do not use twice the same connection to disconnect a listener, it results
- * in undefined behavior. Once used, discard the connection object.
- *
- * @tparam Event Type of event of the connection.
- * @param conn A valid connection.
- */
- template<typename Event>
- void erase(connection<Event> conn) {
- assure<Event>().erase(std::move(conn));
- }
- /**
- * @brief Disconnects all the listeners for the given event type.
- *
- * All the connections previously returned for the given event are
- * invalidated. Using them results in undefined behavior.
- *
- * @tparam Event Type of event to reset.
- */
- template<typename Event>
- void clear() {
- assure<Event>().clear();
- }
- /**
- * @brief Disconnects all the listeners.
- *
- * All the connections previously returned are invalidated. Using them
- * results in undefined behavior.
- */
- void clear() ENTT_NOEXCEPT {
- for(auto &&cpool: pools) {
- if(cpool) {
- cpool->clear();
- }
- }
- }
- /**
- * @brief Checks if there are listeners registered for the specific event.
- * @tparam Event Type of event to test.
- * @return True if there are no listeners registered, false otherwise.
- */
- template<typename Event>
- [[nodiscard]] bool empty() const {
- return assure<Event>().empty();
- }
- /**
- * @brief Checks if there are listeners registered with the event emitter.
- * @return True if there are no listeners registered, false otherwise.
- */
- [[nodiscard]] bool empty() const ENTT_NOEXCEPT {
- return std::all_of(pools.cbegin(), pools.cend(), [](auto &&cpool) {
- return !cpool || cpool->empty();
- });
- }
- private:
- mutable std::vector<std::unique_ptr<basic_pool>> pools{};
- };
- }
- #endif
- // #include "signal/sigh.hpp"
|