FormatTest.cpp 251 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510451145124513451445154516451745184519452045214522452345244525452645274528452945304531453245334534453545364537453845394540454145424543454445454546454745484549455045514552455345544555455645574558455945604561456245634564456545664567456845694570457145724573457445754576457745784579458045814582458345844585458645874588458945904591459245934594459545964597459845994600460146024603460446054606460746084609461046114612461346144615461646174618461946204621462246234624462546264627462846294630463146324633463446354636463746384639464046414642464346444645464646474648464946504651465246534654465546564657465846594660466146624663466446654666466746684669467046714672467346744675467646774678467946804681468246834684468546864687468846894690469146924693469446954696469746984699470047014702470347044705470647074708470947104711471247134714471547164717471847194720472147224723472447254726472747284729473047314732473347344735473647374738473947404741474247434744474547464747474847494750475147524753475447554756475747584759476047614762476347644765476647674768476947704771477247734774477547764777477847794780478147824783478447854786478747884789479047914792479347944795479647974798479948004801480248034804480548064807480848094810481148124813481448154816481748184819482048214822482348244825482648274828482948304831483248334834483548364837483848394840484148424843484448454846484748484849485048514852485348544855485648574858485948604861486248634864486548664867486848694870487148724873487448754876487748784879488048814882488348844885488648874888488948904891489248934894489548964897489848994900490149024903490449054906490749084909491049114912491349144915491649174918491949204921492249234924492549264927492849294930493149324933493449354936493749384939494049414942494349444945494649474948494949504951495249534954495549564957495849594960496149624963496449654966496749684969497049714972497349744975497649774978497949804981498249834984498549864987498849894990499149924993499449954996499749984999500050015002500350045005500650075008500950105011501250135014501550165017501850195020502150225023502450255026502750285029503050315032503350345035503650375038503950405041504250435044504550465047504850495050505150525053505450555056505750585059506050615062506350645065506650675068506950705071507250735074507550765077507850795080508150825083508450855086508750885089509050915092509350945095509650975098509951005101510251035104510551065107510851095110511151125113511451155116511751185119512051215122512351245125512651275128512951305131513251335134513551365137513851395140514151425143514451455146514751485149515051515152515351545155515651575158515951605161516251635164516551665167516851695170517151725173517451755176517751785179518051815182518351845185518651875188518951905191519251935194519551965197519851995200520152025203520452055206520752085209521052115212521352145215521652175218521952205221522252235224522552265227522852295230523152325233523452355236523752385239524052415242524352445245524652475248524952505251525252535254525552565257525852595260526152625263526452655266526752685269527052715272527352745275527652775278527952805281528252835284528552865287528852895290529152925293529452955296529752985299530053015302530353045305530653075308530953105311531253135314531553165317531853195320532153225323532453255326532753285329533053315332533353345335533653375338533953405341534253435344534553465347534853495350535153525353535453555356535753585359536053615362536353645365536653675368536953705371537253735374537553765377537853795380538153825383538453855386538753885389539053915392539353945395539653975398539954005401540254035404540554065407540854095410541154125413541454155416541754185419542054215422542354245425542654275428542954305431543254335434543554365437543854395440544154425443544454455446544754485449545054515452545354545455545654575458545954605461546254635464546554665467546854695470547154725473547454755476547754785479548054815482548354845485548654875488548954905491549254935494549554965497549854995500550155025503550455055506550755085509551055115512551355145515551655175518551955205521552255235524552555265527552855295530553155325533553455355536553755385539554055415542554355445545554655475548554955505551555255535554555555565557555855595560556155625563556455655566556755685569557055715572557355745575557655775578557955805581558255835584558555865587558855895590559155925593559455955596559755985599560056015602560356045605560656075608560956105611561256135614561556165617561856195620562156225623562456255626562756285629563056315632563356345635563656375638563956405641564256435644564556465647564856495650565156525653565456555656565756585659566056615662566356645665566656675668566956705671567256735674567556765677567856795680568156825683568456855686568756885689569056915692569356945695569656975698569957005701570257035704570557065707570857095710571157125713571457155716571757185719572057215722572357245725572657275728572957305731573257335734573557365737573857395740574157425743574457455746574757485749575057515752575357545755575657575758575957605761576257635764576557665767576857695770577157725773577457755776577757785779578057815782578357845785578657875788578957905791579257935794579557965797579857995800580158025803580458055806580758085809581058115812581358145815581658175818581958205821582258235824582558265827582858295830583158325833583458355836583758385839584058415842584358445845584658475848584958505851585258535854585558565857585858595860586158625863586458655866586758685869587058715872587358745875587658775878587958805881588258835884588558865887588858895890589158925893589458955896589758985899590059015902590359045905590659075908590959105911591259135914591559165917591859195920592159225923592459255926592759285929593059315932593359345935593659375938593959405941594259435944594559465947594859495950595159525953595459555956595759585959596059615962596359645965596659675968596959705971597259735974597559765977597859795980598159825983598459855986598759885989599059915992599359945995599659975998599960006001600260036004600560066007600860096010601160126013601460156016601760186019602060216022602360246025602660276028602960306031603260336034603560366037603860396040604160426043604460456046604760486049605060516052605360546055605660576058605960606061606260636064606560666067606860696070607160726073607460756076607760786079608060816082608360846085608660876088608960906091609260936094609560966097609860996100610161026103610461056106610761086109611061116112611361146115611661176118611961206121612261236124612561266127612861296130613161326133613461356136613761386139614061416142614361446145614661476148614961506151615261536154615561566157615861596160616161626163616461656166616761686169617061716172617361746175617661776178617961806181618261836184618561866187618861896190619161926193619461956196619761986199620062016202620362046205620662076208620962106211621262136214621562166217621862196220622162226223622462256226622762286229623062316232623362346235623662376238623962406241624262436244624562466247624862496250625162526253625462556256625762586259626062616262626362646265626662676268626962706271627262736274627562766277627862796280628162826283628462856286628762886289629062916292629362946295629662976298629963006301630263036304630563066307630863096310631163126313631463156316631763186319632063216322632363246325632663276328632963306331633263336334633563366337633863396340634163426343634463456346634763486349635063516352635363546355635663576358635963606361636263636364636563666367636863696370637163726373637463756376637763786379638063816382638363846385638663876388638963906391639263936394639563966397639863996400640164026403640464056406640764086409641064116412641364146415641664176418641964206421642264236424642564266427642864296430643164326433643464356436643764386439644064416442644364446445644664476448644964506451645264536454645564566457645864596460646164626463646464656466646764686469647064716472647364746475647664776478647964806481648264836484648564866487648864896490649164926493649464956496649764986499650065016502650365046505650665076508650965106511651265136514651565166517651865196520652165226523652465256526652765286529653065316532653365346535653665376538653965406541654265436544654565466547654865496550655165526553655465556556655765586559656065616562656365646565656665676568656965706571657265736574657565766577657865796580658165826583658465856586658765886589659065916592659365946595659665976598659966006601660266036604660566066607660866096610661166126613661466156616661766186619662066216622662366246625662666276628662966306631663266336634663566366637663866396640664166426643664466456646664766486649665066516652665366546655665666576658665966606661666266636664666566666667666866696670667166726673667466756676667766786679668066816682668366846685668666876688668966906691669266936694669566966697669866996700670167026703670467056706670767086709671067116712671367146715671667176718671967206721672267236724672567266727672867296730673167326733673467356736673767386739674067416742674367446745674667476748674967506751675267536754675567566757675867596760676167626763676467656766676767686769677067716772677367746775
  1. //===- unittest/Format/FormatTest.cpp - Formatting unit tests -------------===//
  2. //
  3. // The LLVM Compiler Infrastructure
  4. //
  5. // This file is distributed under the University of Illinois Open Source
  6. // License. See LICENSE.TXT for details.
  7. //
  8. //===----------------------------------------------------------------------===//
  9. #define DEBUG_TYPE "format-test"
  10. #include "clang/Format/Format.h"
  11. #include "clang/Lex/Lexer.h"
  12. #include "llvm/Support/Debug.h"
  13. #include "gtest/gtest.h"
  14. namespace clang {
  15. namespace format {
  16. class FormatTest : public ::testing::Test {
  17. protected:
  18. std::string format(llvm::StringRef Code, unsigned Offset, unsigned Length,
  19. const FormatStyle &Style) {
  20. DEBUG(llvm::errs() << "---\n");
  21. std::vector<tooling::Range> Ranges(1, tooling::Range(Offset, Length));
  22. tooling::Replacements Replaces = reformat(Style, Code, Ranges);
  23. ReplacementCount = Replaces.size();
  24. std::string Result = applyAllReplacements(Code, Replaces);
  25. EXPECT_NE("", Result);
  26. DEBUG(llvm::errs() << "\n" << Result << "\n\n");
  27. return Result;
  28. }
  29. std::string
  30. format(llvm::StringRef Code, const FormatStyle &Style = getLLVMStyle()) {
  31. return format(Code, 0, Code.size(), Style);
  32. }
  33. std::string messUp(llvm::StringRef Code) {
  34. std::string MessedUp(Code.str());
  35. bool InComment = false;
  36. bool InPreprocessorDirective = false;
  37. bool JustReplacedNewline = false;
  38. for (unsigned i = 0, e = MessedUp.size() - 1; i != e; ++i) {
  39. if (MessedUp[i] == '/' && MessedUp[i + 1] == '/') {
  40. if (JustReplacedNewline)
  41. MessedUp[i - 1] = '\n';
  42. InComment = true;
  43. } else if (MessedUp[i] == '#' && (JustReplacedNewline || i == 0)) {
  44. if (i != 0)
  45. MessedUp[i - 1] = '\n';
  46. InPreprocessorDirective = true;
  47. } else if (MessedUp[i] == '\\' && MessedUp[i + 1] == '\n') {
  48. MessedUp[i] = ' ';
  49. MessedUp[i + 1] = ' ';
  50. } else if (MessedUp[i] == '\n') {
  51. if (InComment) {
  52. InComment = false;
  53. } else if (InPreprocessorDirective) {
  54. InPreprocessorDirective = false;
  55. } else {
  56. JustReplacedNewline = true;
  57. MessedUp[i] = ' ';
  58. }
  59. } else if (MessedUp[i] != ' ') {
  60. JustReplacedNewline = false;
  61. }
  62. }
  63. return MessedUp;
  64. }
  65. FormatStyle getLLVMStyleWithColumns(unsigned ColumnLimit) {
  66. FormatStyle Style = getLLVMStyle();
  67. Style.ColumnLimit = ColumnLimit;
  68. return Style;
  69. }
  70. FormatStyle getGoogleStyleWithColumns(unsigned ColumnLimit) {
  71. FormatStyle Style = getGoogleStyle();
  72. Style.ColumnLimit = ColumnLimit;
  73. return Style;
  74. }
  75. void verifyFormat(llvm::StringRef Code,
  76. const FormatStyle &Style = getLLVMStyle()) {
  77. EXPECT_EQ(Code.str(), format(messUp(Code), Style));
  78. }
  79. void verifyGoogleFormat(llvm::StringRef Code) {
  80. verifyFormat(Code, getGoogleStyle());
  81. }
  82. void verifyIndependentOfContext(llvm::StringRef text) {
  83. verifyFormat(text);
  84. verifyFormat(llvm::Twine("void f() { " + text + " }").str());
  85. }
  86. int ReplacementCount;
  87. };
  88. TEST_F(FormatTest, MessUp) {
  89. EXPECT_EQ("1 2 3", messUp("1 2 3"));
  90. EXPECT_EQ("1 2 3\n", messUp("1\n2\n3\n"));
  91. EXPECT_EQ("a\n//b\nc", messUp("a\n//b\nc"));
  92. EXPECT_EQ("a\n#b\nc", messUp("a\n#b\nc"));
  93. EXPECT_EQ("a\n#b c d\ne", messUp("a\n#b\\\nc\\\nd\ne"));
  94. }
  95. //===----------------------------------------------------------------------===//
  96. // Basic function tests.
  97. //===----------------------------------------------------------------------===//
  98. TEST_F(FormatTest, DoesNotChangeCorrectlyFormattedCode) {
  99. EXPECT_EQ(";", format(";"));
  100. }
  101. TEST_F(FormatTest, FormatsGlobalStatementsAt0) {
  102. EXPECT_EQ("int i;", format(" int i;"));
  103. EXPECT_EQ("\nint i;", format(" \n\t \v \f int i;"));
  104. EXPECT_EQ("int i;\nint j;", format(" int i; int j;"));
  105. EXPECT_EQ("int i;\nint j;", format(" int i;\n int j;"));
  106. }
  107. TEST_F(FormatTest, FormatsUnwrappedLinesAtFirstFormat) {
  108. EXPECT_EQ("int i;", format("int\ni;"));
  109. }
  110. TEST_F(FormatTest, FormatsNestedBlockStatements) {
  111. EXPECT_EQ("{\n {\n {}\n }\n}", format("{{{}}}"));
  112. }
  113. TEST_F(FormatTest, FormatsNestedCall) {
  114. verifyFormat("Method(f1, f2(f3));");
  115. verifyFormat("Method(f1(f2, f3()));");
  116. verifyFormat("Method(f1(f2, (f3())));");
  117. }
  118. TEST_F(FormatTest, NestedNameSpecifiers) {
  119. verifyFormat("vector< ::Type> v;");
  120. verifyFormat("::ns::SomeFunction(::ns::SomeOtherFunction())");
  121. verifyFormat("static constexpr bool Bar = decltype(bar())::value;");
  122. }
  123. TEST_F(FormatTest, OnlyGeneratesNecessaryReplacements) {
  124. EXPECT_EQ("if (a) {\n"
  125. " f();\n"
  126. "}",
  127. format("if(a){f();}"));
  128. EXPECT_EQ(4, ReplacementCount);
  129. EXPECT_EQ("if (a) {\n"
  130. " f();\n"
  131. "}",
  132. format("if (a) {\n"
  133. " f();\n"
  134. "}"));
  135. EXPECT_EQ(0, ReplacementCount);
  136. }
  137. TEST_F(FormatTest, RemovesTrailingWhitespaceOfFormattedLine) {
  138. EXPECT_EQ("int a;\nint b;", format("int a; \nint b;", 0, 0, getLLVMStyle()));
  139. EXPECT_EQ("int a;", format("int a; "));
  140. EXPECT_EQ("int a;\n", format("int a; \n \n \n "));
  141. EXPECT_EQ("int a;\nint b; ",
  142. format("int a; \nint b; ", 0, 0, getLLVMStyle()));
  143. }
  144. TEST_F(FormatTest, FormatsCorrectRegionForLeadingWhitespace) {
  145. EXPECT_EQ("int b;\nint a;",
  146. format("int b;\n int a;", 7, 0, getLLVMStyle()));
  147. EXPECT_EQ("int b;\n int a;",
  148. format("int b;\n int a;", 6, 0, getLLVMStyle()));
  149. EXPECT_EQ("#define A \\\n"
  150. " int a; \\\n"
  151. " int b;",
  152. format("#define A \\\n"
  153. " int a; \\\n"
  154. " int b;",
  155. 26, 0, getLLVMStyleWithColumns(12)));
  156. EXPECT_EQ("#define A \\\n"
  157. " int a; \\\n"
  158. " int b;",
  159. format("#define A \\\n"
  160. " int a; \\\n"
  161. " int b;",
  162. 25, 0, getLLVMStyleWithColumns(12)));
  163. }
  164. TEST_F(FormatTest, RemovesWhitespaceWhenTriggeredOnEmptyLine) {
  165. EXPECT_EQ("int a;\n\n int b;",
  166. format("int a;\n \n\n int b;", 7, 0, getLLVMStyle()));
  167. EXPECT_EQ("int a;\n\n int b;",
  168. format("int a;\n \n\n int b;", 9, 0, getLLVMStyle()));
  169. }
  170. TEST_F(FormatTest, RemovesEmptyLines) {
  171. EXPECT_EQ("class C {\n"
  172. " int i;\n"
  173. "};",
  174. format("class C {\n"
  175. " int i;\n"
  176. "\n"
  177. "};"));
  178. // Don't remove empty lines in more complex control statements.
  179. EXPECT_EQ("void f() {\n"
  180. " if (a) {\n"
  181. " f();\n"
  182. "\n"
  183. " } else if (b) {\n"
  184. " f();\n"
  185. " }\n"
  186. "}",
  187. format("void f() {\n"
  188. " if (a) {\n"
  189. " f();\n"
  190. "\n"
  191. " } else if (b) {\n"
  192. " f();\n"
  193. "\n"
  194. " }\n"
  195. "\n"
  196. "}"));
  197. // FIXME: This is slightly inconsistent.
  198. EXPECT_EQ("namespace {\n"
  199. "int i;\n"
  200. "}",
  201. format("namespace {\n"
  202. "int i;\n"
  203. "\n"
  204. "}"));
  205. EXPECT_EQ("namespace {\n"
  206. "int i;\n"
  207. "\n"
  208. "} // namespace",
  209. format("namespace {\n"
  210. "int i;\n"
  211. "\n"
  212. "} // namespace"));
  213. }
  214. TEST_F(FormatTest, ReformatsMovedLines) {
  215. EXPECT_EQ(
  216. "template <typename T> T *getFETokenInfo() const {\n"
  217. " return static_cast<T *>(FETokenInfo);\n"
  218. "}\n"
  219. " int a; // <- Should not be formatted",
  220. format(
  221. "template<typename T>\n"
  222. "T *getFETokenInfo() const { return static_cast<T*>(FETokenInfo); }\n"
  223. " int a; // <- Should not be formatted",
  224. 9, 5, getLLVMStyle()));
  225. }
  226. //===----------------------------------------------------------------------===//
  227. // Tests for control statements.
  228. //===----------------------------------------------------------------------===//
  229. TEST_F(FormatTest, FormatIfWithoutCompoundStatement) {
  230. verifyFormat("if (true)\n f();\ng();");
  231. verifyFormat("if (a)\n if (b)\n if (c)\n g();\nh();");
  232. verifyFormat("if (a)\n if (b) {\n f();\n }\ng();");
  233. FormatStyle AllowsMergedIf = getLLVMStyle();
  234. AllowsMergedIf.AllowShortIfStatementsOnASingleLine = true;
  235. verifyFormat("if (a)\n"
  236. " // comment\n"
  237. " f();",
  238. AllowsMergedIf);
  239. verifyFormat("if (a)\n"
  240. " ;",
  241. AllowsMergedIf);
  242. verifyFormat("if (a)\n"
  243. " if (b) return;",
  244. AllowsMergedIf);
  245. verifyFormat("if (a) // Can't merge this\n"
  246. " f();\n",
  247. AllowsMergedIf);
  248. verifyFormat("if (a) /* still don't merge */\n"
  249. " f();",
  250. AllowsMergedIf);
  251. verifyFormat("if (a) { // Never merge this\n"
  252. " f();\n"
  253. "}",
  254. AllowsMergedIf);
  255. verifyFormat("if (a) { /* Never merge this */\n"
  256. " f();\n"
  257. "}",
  258. AllowsMergedIf);
  259. EXPECT_EQ("if (a) return;", format("if(a)\nreturn;", 7, 1, AllowsMergedIf));
  260. EXPECT_EQ("if (a) return; // comment",
  261. format("if(a)\nreturn; // comment", 20, 1, AllowsMergedIf));
  262. AllowsMergedIf.ColumnLimit = 14;
  263. verifyFormat("if (a) return;", AllowsMergedIf);
  264. verifyFormat("if (aaaaaaaaa)\n"
  265. " return;",
  266. AllowsMergedIf);
  267. AllowsMergedIf.ColumnLimit = 13;
  268. verifyFormat("if (a)\n return;", AllowsMergedIf);
  269. }
  270. TEST_F(FormatTest, FormatLoopsWithoutCompoundStatement) {
  271. FormatStyle AllowsMergedLoops = getLLVMStyle();
  272. AllowsMergedLoops.AllowShortLoopsOnASingleLine = true;
  273. verifyFormat("while (true) continue;", AllowsMergedLoops);
  274. verifyFormat("for (;;) continue;", AllowsMergedLoops);
  275. verifyFormat("for (int &v : vec) v *= 2;", AllowsMergedLoops);
  276. verifyFormat("while (true)\n"
  277. " ;",
  278. AllowsMergedLoops);
  279. verifyFormat("for (;;)\n"
  280. " ;",
  281. AllowsMergedLoops);
  282. verifyFormat("for (;;)\n"
  283. " for (;;) continue;",
  284. AllowsMergedLoops);
  285. verifyFormat("for (;;) // Can't merge this\n"
  286. " continue;",
  287. AllowsMergedLoops);
  288. verifyFormat("for (;;) /* still don't merge */\n"
  289. " continue;",
  290. AllowsMergedLoops);
  291. }
  292. TEST_F(FormatTest, ParseIfElse) {
  293. verifyFormat("if (true)\n"
  294. " if (true)\n"
  295. " if (true)\n"
  296. " f();\n"
  297. " else\n"
  298. " g();\n"
  299. " else\n"
  300. " h();\n"
  301. "else\n"
  302. " i();");
  303. verifyFormat("if (true)\n"
  304. " if (true)\n"
  305. " if (true) {\n"
  306. " if (true)\n"
  307. " f();\n"
  308. " } else {\n"
  309. " g();\n"
  310. " }\n"
  311. " else\n"
  312. " h();\n"
  313. "else {\n"
  314. " i();\n"
  315. "}");
  316. verifyFormat("void f() {\n"
  317. " if (a) {\n"
  318. " } else {\n"
  319. " }\n"
  320. "}");
  321. }
  322. TEST_F(FormatTest, ElseIf) {
  323. verifyFormat("if (a) {\n} else if (b) {\n}");
  324. verifyFormat("if (a)\n"
  325. " f();\n"
  326. "else if (b)\n"
  327. " g();\n"
  328. "else\n"
  329. " h();");
  330. }
  331. TEST_F(FormatTest, FormatsForLoop) {
  332. verifyFormat(
  333. "for (int VeryVeryLongLoopVariable = 0; VeryVeryLongLoopVariable < 10;\n"
  334. " ++VeryVeryLongLoopVariable)\n"
  335. " ;");
  336. verifyFormat("for (;;)\n"
  337. " f();");
  338. verifyFormat("for (;;) {\n}");
  339. verifyFormat("for (;;) {\n"
  340. " f();\n"
  341. "}");
  342. verifyFormat("for (int i = 0; (i < 10); ++i) {\n}");
  343. verifyFormat(
  344. "for (std::vector<UnwrappedLine>::iterator I = UnwrappedLines.begin(),\n"
  345. " E = UnwrappedLines.end();\n"
  346. " I != E; ++I) {\n}");
  347. verifyFormat(
  348. "for (MachineFun::iterator IIII = PrevIt, EEEE = F.end(); IIII != EEEE;\n"
  349. " ++IIIII) {\n}");
  350. verifyFormat("for (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaa =\n"
  351. " aaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaa;\n"
  352. " aaaaaaaaaaa != aaaaaaaaaaaaaaaaaaa; ++aaaaaaaaaaa) {\n}");
  353. verifyFormat("for (llvm::ArrayRef<NamedDecl *>::iterator\n"
  354. " I = FD->getDeclsInPrototypeScope().begin(),\n"
  355. " E = FD->getDeclsInPrototypeScope().end();\n"
  356. " I != E; ++I) {\n}");
  357. // FIXME: Not sure whether we want extra identation in line 3 here:
  358. verifyFormat(
  359. "for (aaaaaaaaaaaaaaaaa aaaaaaaaaaa = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;\n"
  360. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa !=\n"
  361. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  362. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);\n"
  363. " ++aaaaaaaaaaa) {\n}");
  364. verifyFormat("for (int aaaaaaaaaaa = 1; aaaaaaaaaaa <= bbbbbbbbbbbbbbb;\n"
  365. " aaaaaaaaaaa++, bbbbbbbbbbbbbbbbb++) {\n"
  366. "}");
  367. verifyFormat("for (some_namespace::SomeIterator iter( // force break\n"
  368. " aaaaaaaaaa);\n"
  369. " iter; ++iter) {\n"
  370. "}");
  371. FormatStyle NoBinPacking = getLLVMStyle();
  372. NoBinPacking.BinPackParameters = false;
  373. verifyFormat("for (int aaaaaaaaaaa = 1;\n"
  374. " aaaaaaaaaaa <= aaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaa,\n"
  375. " aaaaaaaaaaaaaaaa,\n"
  376. " aaaaaaaaaaaaaaaa,\n"
  377. " aaaaaaaaaaaaaaaa);\n"
  378. " aaaaaaaaaaa++, bbbbbbbbbbbbbbbbb++) {\n"
  379. "}",
  380. NoBinPacking);
  381. verifyFormat(
  382. "for (std::vector<UnwrappedLine>::iterator I = UnwrappedLines.begin(),\n"
  383. " E = UnwrappedLines.end();\n"
  384. " I != E;\n"
  385. " ++I) {\n}",
  386. NoBinPacking);
  387. }
  388. TEST_F(FormatTest, RangeBasedForLoops) {
  389. verifyFormat("for (auto aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa :\n"
  390. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}");
  391. verifyFormat("for (auto aaaaaaaaaaaaaaaaaaaaa :\n"
  392. " aaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaa, aaaaaaaaaaaaa)) {\n}");
  393. verifyFormat("for (const aaaaaaaaaaaaaaaaaaaaa &aaaaaaaaa :\n"
  394. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}");
  395. }
  396. TEST_F(FormatTest, FormatsWhileLoop) {
  397. verifyFormat("while (true) {\n}");
  398. verifyFormat("while (true)\n"
  399. " f();");
  400. verifyFormat("while () {\n}");
  401. verifyFormat("while () {\n"
  402. " f();\n"
  403. "}");
  404. }
  405. TEST_F(FormatTest, FormatsDoWhile) {
  406. verifyFormat("do {\n"
  407. " do_something();\n"
  408. "} while (something());");
  409. verifyFormat("do\n"
  410. " do_something();\n"
  411. "while (something());");
  412. }
  413. TEST_F(FormatTest, FormatsSwitchStatement) {
  414. verifyFormat("switch (x) {\n"
  415. "case 1:\n"
  416. " f();\n"
  417. " break;\n"
  418. "case kFoo:\n"
  419. "case ns::kBar:\n"
  420. "case kBaz:\n"
  421. " break;\n"
  422. "default:\n"
  423. " g();\n"
  424. " break;\n"
  425. "}");
  426. verifyFormat("switch (x) {\n"
  427. "case 1: {\n"
  428. " f();\n"
  429. " break;\n"
  430. "}\n"
  431. "}");
  432. verifyFormat("switch (x) {\n"
  433. "case 1: {\n"
  434. " f();\n"
  435. " {\n"
  436. " g();\n"
  437. " h();\n"
  438. " }\n"
  439. " break;\n"
  440. "}\n"
  441. "}");
  442. verifyFormat("switch (x) {\n"
  443. "case 1: {\n"
  444. " f();\n"
  445. " if (foo) {\n"
  446. " g();\n"
  447. " h();\n"
  448. " }\n"
  449. " break;\n"
  450. "}\n"
  451. "}");
  452. verifyFormat("switch (x) {\n"
  453. "case 1: {\n"
  454. " f();\n"
  455. " g();\n"
  456. "} break;\n"
  457. "}");
  458. verifyFormat("switch (test)\n"
  459. " ;");
  460. verifyFormat("switch (x) {\n"
  461. "default: {\n"
  462. " // Do nothing.\n"
  463. "}\n"
  464. "}");
  465. verifyFormat("switch (x) {\n"
  466. "// comment\n"
  467. "// if 1, do f()\n"
  468. "case 1:\n"
  469. " f();\n"
  470. "}");
  471. verifyFormat("switch (x) {\n"
  472. "case 1:\n"
  473. " // Do amazing stuff\n"
  474. " {\n"
  475. " f();\n"
  476. " g();\n"
  477. " }\n"
  478. " break;\n"
  479. "}");
  480. verifyFormat("#define A \\\n"
  481. " switch (x) { \\\n"
  482. " case a: \\\n"
  483. " foo = b; \\\n"
  484. " }", getLLVMStyleWithColumns(20));
  485. verifyFormat("#define OPERATION_CASE(name) \\\n"
  486. " case OP_name: \\\n"
  487. " return operations::Operation##name\n",
  488. getLLVMStyleWithColumns(40));
  489. verifyGoogleFormat("switch (x) {\n"
  490. " case 1:\n"
  491. " f();\n"
  492. " break;\n"
  493. " case kFoo:\n"
  494. " case ns::kBar:\n"
  495. " case kBaz:\n"
  496. " break;\n"
  497. " default:\n"
  498. " g();\n"
  499. " break;\n"
  500. "}");
  501. verifyGoogleFormat("switch (x) {\n"
  502. " case 1: {\n"
  503. " f();\n"
  504. " break;\n"
  505. " }\n"
  506. "}");
  507. verifyGoogleFormat("switch (test)\n"
  508. " ;");
  509. verifyGoogleFormat("#define OPERATION_CASE(name) \\\n"
  510. " case OP_name: \\\n"
  511. " return operations::Operation##name\n");
  512. verifyGoogleFormat("Operation codeToOperation(OperationCode OpCode) {\n"
  513. " // Get the correction operation class.\n"
  514. " switch (OpCode) {\n"
  515. " CASE(Add);\n"
  516. " CASE(Subtract);\n"
  517. " default:\n"
  518. " return operations::Unknown;\n"
  519. " }\n"
  520. "#undef OPERATION_CASE\n"
  521. "}");
  522. verifyFormat("DEBUG({\n"
  523. " switch (x) {\n"
  524. " case A:\n"
  525. " f();\n"
  526. " break;\n"
  527. " // On B:\n"
  528. " case B:\n"
  529. " g();\n"
  530. " break;\n"
  531. " }\n"
  532. "});");
  533. }
  534. TEST_F(FormatTest, FormatsLabels) {
  535. verifyFormat("void f() {\n"
  536. " some_code();\n"
  537. "test_label:\n"
  538. " some_other_code();\n"
  539. " {\n"
  540. " some_more_code();\n"
  541. " another_label:\n"
  542. " some_more_code();\n"
  543. " }\n"
  544. "}");
  545. verifyFormat("some_code();\n"
  546. "test_label:\n"
  547. "some_other_code();");
  548. }
  549. //===----------------------------------------------------------------------===//
  550. // Tests for comments.
  551. //===----------------------------------------------------------------------===//
  552. TEST_F(FormatTest, UnderstandsSingleLineComments) {
  553. verifyFormat("//* */");
  554. verifyFormat("// line 1\n"
  555. "// line 2\n"
  556. "void f() {}\n");
  557. verifyFormat("void f() {\n"
  558. " // Doesn't do anything\n"
  559. "}");
  560. verifyFormat("SomeObject\n"
  561. " // Calling someFunction on SomeObject\n"
  562. " .someFunction();");
  563. verifyFormat("void f(int i, // some comment (probably for i)\n"
  564. " int j, // some comment (probably for j)\n"
  565. " int k); // some comment (probably for k)");
  566. verifyFormat("void f(int i,\n"
  567. " // some comment (probably for j)\n"
  568. " int j,\n"
  569. " // some comment (probably for k)\n"
  570. " int k);");
  571. verifyFormat("int i // This is a fancy variable\n"
  572. " = 5; // with nicely aligned comment.");
  573. verifyFormat("// Leading comment.\n"
  574. "int a; // Trailing comment.");
  575. verifyFormat("int a; // Trailing comment\n"
  576. " // on 2\n"
  577. " // or 3 lines.\n"
  578. "int b;");
  579. verifyFormat("int a; // Trailing comment\n"
  580. "\n"
  581. "// Leading comment.\n"
  582. "int b;");
  583. verifyFormat("int a; // Comment.\n"
  584. " // More details.\n"
  585. "int bbbb; // Another comment.");
  586. verifyFormat(
  587. "int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa; // comment\n"
  588. "int bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; // comment\n"
  589. "int cccccccccccccccccccccccccccccc; // comment\n"
  590. "int ddd; // looooooooooooooooooooooooong comment\n"
  591. "int aaaaaaaaaaaaaaaaaaaaaaa; // comment\n"
  592. "int bbbbbbbbbbbbbbbbbbbbb; // comment\n"
  593. "int ccccccccccccccccccc; // comment");
  594. verifyFormat("#include \"a\" // comment\n"
  595. "#include \"a/b/c\" // comment");
  596. verifyFormat("#include <a> // comment\n"
  597. "#include <a/b/c> // comment");
  598. EXPECT_EQ("#include \\\n"
  599. " \"a\" // comment\n"
  600. "#include \"a/b/c\" // comment",
  601. format("#include \\\n"
  602. " \"a\" // comment\n"
  603. "#include \"a/b/c\" // comment"));
  604. verifyFormat("enum E {\n"
  605. " // comment\n"
  606. " VAL_A, // comment\n"
  607. " VAL_B\n"
  608. "};");
  609. verifyFormat(
  610. "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n"
  611. " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; // Trailing comment");
  612. verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n"
  613. " // Comment inside a statement.\n"
  614. " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;");
  615. verifyFormat(
  616. "bool aaaaaaaaaaaaa = // comment\n"
  617. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
  618. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
  619. verifyFormat("int aaaa; // aaaaa\n"
  620. "int aa; // aaaaaaa",
  621. getLLVMStyleWithColumns(20));
  622. EXPECT_EQ("void f() { // This does something ..\n"
  623. "}\n"
  624. "int a; // This is unrelated",
  625. format("void f() { // This does something ..\n"
  626. " }\n"
  627. "int a; // This is unrelated"));
  628. EXPECT_EQ("class C {\n"
  629. " void f() { // This does something ..\n"
  630. " } // awesome..\n"
  631. "\n"
  632. " int a; // This is unrelated\n"
  633. "};",
  634. format("class C{void f() { // This does something ..\n"
  635. " } // awesome..\n"
  636. " \n"
  637. "int a; // This is unrelated\n"
  638. "};"));
  639. EXPECT_EQ("int i; // single line trailing comment",
  640. format("int i;\\\n// single line trailing comment"));
  641. verifyGoogleFormat("int a; // Trailing comment.");
  642. verifyFormat("someFunction(anotherFunction( // Force break.\n"
  643. " parameter));");
  644. verifyGoogleFormat("#endif // HEADER_GUARD");
  645. verifyFormat("const char *test[] = {\n"
  646. " // A\n"
  647. " \"aaaa\",\n"
  648. " // B\n"
  649. " \"aaaaa\",\n"
  650. "};");
  651. verifyGoogleFormat(
  652. "aaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  653. " aaaaaaaaaaaaaaaaaaaaaa); // 81_cols_with_this_comment");
  654. EXPECT_EQ("D(a, {\n"
  655. " // test\n"
  656. " int a;\n"
  657. "});",
  658. format("D(a, {\n"
  659. "// test\n"
  660. "int a;\n"
  661. "});"));
  662. EXPECT_EQ("lineWith(); // comment\n"
  663. "// at start\n"
  664. "otherLine();",
  665. format("lineWith(); // comment\n"
  666. "// at start\n"
  667. "otherLine();"));
  668. EXPECT_EQ("lineWith(); // comment\n"
  669. " // at start\n"
  670. "otherLine();",
  671. format("lineWith(); // comment\n"
  672. " // at start\n"
  673. "otherLine();"));
  674. EXPECT_EQ("lineWith(); // comment\n"
  675. "// at start\n"
  676. "otherLine(); // comment",
  677. format("lineWith(); // comment\n"
  678. "// at start\n"
  679. "otherLine(); // comment"));
  680. EXPECT_EQ("lineWith();\n"
  681. "// at start\n"
  682. "otherLine(); // comment",
  683. format("lineWith();\n"
  684. " // at start\n"
  685. "otherLine(); // comment"));
  686. EXPECT_EQ("// first\n"
  687. "// at start\n"
  688. "otherLine(); // comment",
  689. format("// first\n"
  690. " // at start\n"
  691. "otherLine(); // comment"));
  692. EXPECT_EQ("f();\n"
  693. "// first\n"
  694. "// at start\n"
  695. "otherLine(); // comment",
  696. format("f();\n"
  697. "// first\n"
  698. " // at start\n"
  699. "otherLine(); // comment"));
  700. }
  701. TEST_F(FormatTest, CanFormatCommentsLocally) {
  702. EXPECT_EQ("int a; // comment\n"
  703. "int b; // comment",
  704. format("int a; // comment\n"
  705. "int b; // comment",
  706. 0, 0, getLLVMStyle()));
  707. EXPECT_EQ("int a; // comment\n"
  708. " // line 2\n"
  709. "int b;",
  710. format("int a; // comment\n"
  711. " // line 2\n"
  712. "int b;",
  713. 28, 0, getLLVMStyle()));
  714. EXPECT_EQ("int aaaaaa; // comment\n"
  715. "int b;\n"
  716. "int c; // unrelated comment",
  717. format("int aaaaaa; // comment\n"
  718. "int b;\n"
  719. "int c; // unrelated comment",
  720. 31, 0, getLLVMStyle()));
  721. }
  722. TEST_F(FormatTest, RemovesTrailingWhitespaceOfComments) {
  723. EXPECT_EQ("// comment", format("// comment "));
  724. EXPECT_EQ("int aaaaaaa, bbbbbbb; // comment",
  725. format("int aaaaaaa, bbbbbbb; // comment ",
  726. getLLVMStyleWithColumns(33)));
  727. EXPECT_EQ("// comment\\\n", format("// comment\\\n \t \v \f "));
  728. EXPECT_EQ("// comment \\\n", format("// comment \\\n \t \v \f "));
  729. }
  730. TEST_F(FormatTest, UnderstandsBlockComments) {
  731. verifyFormat("f(/*noSpaceAfterParameterNamingComment=*/true);");
  732. EXPECT_EQ(
  733. "f(aaaaaaaaaaaaaaaaaaaaaaaaa, /* Trailing comment for aa... */\n"
  734. " bbbbbbbbbbbbbbbbbbbbbbbbb);",
  735. format("f(aaaaaaaaaaaaaaaaaaaaaaaaa , \\\n/* Trailing comment for aa... */\n"
  736. " bbbbbbbbbbbbbbbbbbbbbbbbb);"));
  737. EXPECT_EQ(
  738. "f(aaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  739. " /* Leading comment for bb... */ bbbbbbbbbbbbbbbbbbbbbbbbb);",
  740. format("f(aaaaaaaaaaaaaaaaaaaaaaaaa , \n"
  741. "/* Leading comment for bb... */ bbbbbbbbbbbbbbbbbbbbbbbbb);"));
  742. EXPECT_EQ(
  743. "void aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  744. " aaaaaaaaaaaaaaaaaa,\n"
  745. " aaaaaaaaaaaaaaaaaa) { /*aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa*/\n"
  746. "}",
  747. format("void aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  748. " aaaaaaaaaaaaaaaaaa ,\n"
  749. " aaaaaaaaaaaaaaaaaa) { /*aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa*/\n"
  750. "}"));
  751. FormatStyle NoBinPacking = getLLVMStyle();
  752. NoBinPacking.BinPackParameters = false;
  753. verifyFormat("aaaaaaaa(/* parameter 1 */ aaaaaa,\n"
  754. " /* parameter 2 */ aaaaaa,\n"
  755. " /* parameter 3 */ aaaaaa,\n"
  756. " /* parameter 4 */ aaaaaa);",
  757. NoBinPacking);
  758. }
  759. TEST_F(FormatTest, AlignsBlockComments) {
  760. EXPECT_EQ("/*\n"
  761. " * Really multi-line\n"
  762. " * comment.\n"
  763. " */\n"
  764. "void f() {}",
  765. format(" /*\n"
  766. " * Really multi-line\n"
  767. " * comment.\n"
  768. " */\n"
  769. " void f() {}"));
  770. EXPECT_EQ("class C {\n"
  771. " /*\n"
  772. " * Another multi-line\n"
  773. " * comment.\n"
  774. " */\n"
  775. " void f() {}\n"
  776. "};",
  777. format("class C {\n"
  778. "/*\n"
  779. " * Another multi-line\n"
  780. " * comment.\n"
  781. " */\n"
  782. "void f() {}\n"
  783. "};"));
  784. EXPECT_EQ("/*\n"
  785. " 1. This is a comment with non-trivial formatting.\n"
  786. " 1.1. We have to indent/outdent all lines equally\n"
  787. " 1.1.1. to keep the formatting.\n"
  788. " */",
  789. format(" /*\n"
  790. " 1. This is a comment with non-trivial formatting.\n"
  791. " 1.1. We have to indent/outdent all lines equally\n"
  792. " 1.1.1. to keep the formatting.\n"
  793. " */"));
  794. EXPECT_EQ("/*\n"
  795. "Don't try to outdent if there's not enough indentation.\n"
  796. "*/",
  797. format(" /*\n"
  798. " Don't try to outdent if there's not enough indentation.\n"
  799. " */"));
  800. EXPECT_EQ("int i; /* Comment with empty...\n"
  801. " *\n"
  802. " * line. */",
  803. format("int i; /* Comment with empty...\n"
  804. " *\n"
  805. " * line. */"));
  806. }
  807. TEST_F(FormatTest, CorrectlyHandlesLengthOfBlockComments) {
  808. EXPECT_EQ("double *x; /* aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  809. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa */",
  810. format("double *x; /* aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  811. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa */"));
  812. EXPECT_EQ(
  813. "void ffffffffffff(\n"
  814. " int aaaaaaaa, int bbbbbbbb,\n"
  815. " int cccccccccccc) { /*\n"
  816. " aaaaaaaaaa\n"
  817. " aaaaaaaaaaaaa\n"
  818. " bbbbbbbbbbbbbb\n"
  819. " bbbbbbbbbb\n"
  820. " */\n"
  821. "}",
  822. format("void ffffffffffff(int aaaaaaaa, int bbbbbbbb, int cccccccccccc)\n"
  823. "{ /*\n"
  824. " aaaaaaaaaa aaaaaaaaaaaaa\n"
  825. " bbbbbbbbbbbbbb bbbbbbbbbb\n"
  826. " */\n"
  827. "}",
  828. getLLVMStyleWithColumns(40)));
  829. }
  830. TEST_F(FormatTest, DontBreakNonTrailingBlockComments) {
  831. EXPECT_EQ("void\n"
  832. "ffffffffff(int aaaaa /* test */);",
  833. format("void ffffffffff(int aaaaa /* test */);",
  834. getLLVMStyleWithColumns(35)));
  835. }
  836. TEST_F(FormatTest, SplitsLongCxxComments) {
  837. EXPECT_EQ("// A comment that\n"
  838. "// doesn't fit on\n"
  839. "// one line",
  840. format("// A comment that doesn't fit on one line",
  841. getLLVMStyleWithColumns(20)));
  842. EXPECT_EQ("// a b c d\n"
  843. "// e f g\n"
  844. "// h i j k",
  845. format("// a b c d e f g h i j k",
  846. getLLVMStyleWithColumns(10)));
  847. EXPECT_EQ("// a b c d\n"
  848. "// e f g\n"
  849. "// h i j k",
  850. format("\\\n// a b c d e f g h i j k",
  851. getLLVMStyleWithColumns(10)));
  852. EXPECT_EQ("if (true) // A comment that\n"
  853. " // doesn't fit on\n"
  854. " // one line",
  855. format("if (true) // A comment that doesn't fit on one line ",
  856. getLLVMStyleWithColumns(30)));
  857. EXPECT_EQ("// Don't_touch_leading_whitespace",
  858. format("// Don't_touch_leading_whitespace",
  859. getLLVMStyleWithColumns(20)));
  860. EXPECT_EQ("// Add leading\n"
  861. "// whitespace",
  862. format("//Add leading whitespace", getLLVMStyleWithColumns(20)));
  863. EXPECT_EQ("// whitespace", format("//whitespace", getLLVMStyle()));
  864. EXPECT_EQ("// Even if it makes the line exceed the column\n"
  865. "// limit",
  866. format("//Even if it makes the line exceed the column limit",
  867. getLLVMStyleWithColumns(51)));
  868. EXPECT_EQ("//--But not here", format("//--But not here", getLLVMStyle()));
  869. EXPECT_EQ("// A comment before\n"
  870. "// a macro\n"
  871. "// definition\n"
  872. "#define a b",
  873. format("// A comment before a macro definition\n"
  874. "#define a b",
  875. getLLVMStyleWithColumns(20)));
  876. EXPECT_EQ("void ffffff(int aaaaaaaaa, // wwww\n"
  877. " int a, int bbb, // xxxxxxx\n"
  878. " // yyyyyyyyy\n"
  879. " int c, int d, int e) {}",
  880. format("void ffffff(\n"
  881. " int aaaaaaaaa, // wwww\n"
  882. " int a,\n"
  883. " int bbb, // xxxxxxx yyyyyyyyy\n"
  884. " int c, int d, int e) {}",
  885. getLLVMStyleWithColumns(40)));
  886. EXPECT_EQ("//\t aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  887. format("//\t aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  888. getLLVMStyleWithColumns(20)));
  889. }
  890. TEST_F(FormatTest, DontSplitLineCommentsWithEscapedNewlines) {
  891. EXPECT_EQ("// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n"
  892. "// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n"
  893. "// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  894. format("// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n"
  895. "// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n"
  896. "// aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"));
  897. EXPECT_EQ("int a; // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n"
  898. " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n"
  899. " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  900. format("int a; // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n"
  901. " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n"
  902. " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  903. getLLVMStyleWithColumns(50)));
  904. // FIXME: One day we might want to implement adjustment of leading whitespace
  905. // of the consecutive lines in this kind of comment:
  906. EXPECT_EQ("int\n"
  907. "a; // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n"
  908. " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n"
  909. " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  910. format("int a; // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n"
  911. " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\\\n"
  912. " // AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA",
  913. getLLVMStyleWithColumns(49)));
  914. }
  915. TEST_F(FormatTest, PriorityOfCommentBreaking) {
  916. EXPECT_EQ("if (xxx ==\n"
  917. " yyy && // aaaaaaaaaaaa bbbbbbbbb\n"
  918. " zzz)\n"
  919. " q();",
  920. format("if (xxx == yyy && // aaaaaaaaaaaa bbbbbbbbb\n"
  921. " zzz) q();",
  922. getLLVMStyleWithColumns(40)));
  923. EXPECT_EQ("if (xxxxxxxxxx ==\n"
  924. " yyy && // aaaaaa bbbbbbbb cccc\n"
  925. " zzz)\n"
  926. " q();",
  927. format("if (xxxxxxxxxx == yyy && // aaaaaa bbbbbbbb cccc\n"
  928. " zzz) q();",
  929. getLLVMStyleWithColumns(40)));
  930. EXPECT_EQ("if (xxxxxxxxxx &&\n"
  931. " yyy || // aaaaaa bbbbbbbb cccc\n"
  932. " zzz)\n"
  933. " q();",
  934. format("if (xxxxxxxxxx && yyy || // aaaaaa bbbbbbbb cccc\n"
  935. " zzz) q();",
  936. getLLVMStyleWithColumns(40)));
  937. EXPECT_EQ("fffffffff(&xxx, // aaaaaaaaaaaa\n"
  938. " // bbbbbbbbbbb\n"
  939. " zzz);",
  940. format("fffffffff(&xxx, // aaaaaaaaaaaa bbbbbbbbbbb\n"
  941. " zzz);",
  942. getLLVMStyleWithColumns(40)));
  943. }
  944. TEST_F(FormatTest, MultiLineCommentsInDefines) {
  945. EXPECT_EQ("#define A(x) /* \\\n"
  946. " a comment \\\n"
  947. " inside */ \\\n"
  948. " f();",
  949. format("#define A(x) /* \\\n"
  950. " a comment \\\n"
  951. " inside */ \\\n"
  952. " f();",
  953. getLLVMStyleWithColumns(17)));
  954. EXPECT_EQ("#define A( \\\n"
  955. " x) /* \\\n"
  956. " a comment \\\n"
  957. " inside */ \\\n"
  958. " f();",
  959. format("#define A( \\\n"
  960. " x) /* \\\n"
  961. " a comment \\\n"
  962. " inside */ \\\n"
  963. " f();",
  964. getLLVMStyleWithColumns(17)));
  965. }
  966. TEST_F(FormatTest, ParsesCommentsAdjacentToPPDirectives) {
  967. EXPECT_EQ("namespace {}\n// Test\n#define A",
  968. format("namespace {}\n // Test\n#define A"));
  969. EXPECT_EQ("namespace {}\n/* Test */\n#define A",
  970. format("namespace {}\n /* Test */\n#define A"));
  971. EXPECT_EQ("namespace {}\n/* Test */ #define A",
  972. format("namespace {}\n /* Test */ #define A"));
  973. }
  974. TEST_F(FormatTest, SplitsLongLinesInComments) {
  975. EXPECT_EQ("/* This is a long\n"
  976. " * comment that\n"
  977. " * doesn't\n"
  978. " * fit on one line.\n"
  979. " */",
  980. format("/* "
  981. "This is a long "
  982. "comment that "
  983. "doesn't "
  984. "fit on one line. */",
  985. getLLVMStyleWithColumns(20)));
  986. EXPECT_EQ("/* a b c d\n"
  987. " * e f g\n"
  988. " * h i j k\n"
  989. " */",
  990. format("/* a b c d e f g h i j k */",
  991. getLLVMStyleWithColumns(10)));
  992. EXPECT_EQ("/* a b c d\n"
  993. " * e f g\n"
  994. " * h i j k\n"
  995. " */",
  996. format("\\\n/* a b c d e f g h i j k */",
  997. getLLVMStyleWithColumns(10)));
  998. EXPECT_EQ("/*\n"
  999. "This is a long\n"
  1000. "comment that doesn't\n"
  1001. "fit on one line.\n"
  1002. "*/",
  1003. format("/*\n"
  1004. "This is a long "
  1005. "comment that doesn't "
  1006. "fit on one line. \n"
  1007. "*/", getLLVMStyleWithColumns(20)));
  1008. EXPECT_EQ("/*\n"
  1009. " * This is a long\n"
  1010. " * comment that\n"
  1011. " * doesn't fit on\n"
  1012. " * one line.\n"
  1013. " */",
  1014. format("/* \n"
  1015. " * This is a long "
  1016. " comment that "
  1017. " doesn't fit on "
  1018. " one line. \n"
  1019. " */", getLLVMStyleWithColumns(20)));
  1020. EXPECT_EQ("/*\n"
  1021. " * This_is_a_comment_with_words_that_dont_fit_on_one_line\n"
  1022. " * so_it_should_be_broken\n"
  1023. " * wherever_a_space_occurs\n"
  1024. " */",
  1025. format("/*\n"
  1026. " * This_is_a_comment_with_words_that_dont_fit_on_one_line "
  1027. " so_it_should_be_broken "
  1028. " wherever_a_space_occurs \n"
  1029. " */",
  1030. getLLVMStyleWithColumns(20)));
  1031. EXPECT_EQ("/*\n"
  1032. " * This_comment_can_not_be_broken_into_lines\n"
  1033. " */",
  1034. format("/*\n"
  1035. " * This_comment_can_not_be_broken_into_lines\n"
  1036. " */",
  1037. getLLVMStyleWithColumns(20)));
  1038. EXPECT_EQ("{\n"
  1039. " /*\n"
  1040. " This is another\n"
  1041. " long comment that\n"
  1042. " doesn't fit on one\n"
  1043. " line 1234567890\n"
  1044. " */\n"
  1045. "}",
  1046. format("{\n"
  1047. "/*\n"
  1048. "This is another "
  1049. " long comment that "
  1050. " doesn't fit on one"
  1051. " line 1234567890\n"
  1052. "*/\n"
  1053. "}", getLLVMStyleWithColumns(20)));
  1054. EXPECT_EQ("{\n"
  1055. " /*\n"
  1056. " * This i s\n"
  1057. " * another comment\n"
  1058. " * t hat doesn' t\n"
  1059. " * fit on one l i\n"
  1060. " * n e\n"
  1061. " */\n"
  1062. "}",
  1063. format("{\n"
  1064. "/*\n"
  1065. " * This i s"
  1066. " another comment"
  1067. " t hat doesn' t"
  1068. " fit on one l i"
  1069. " n e\n"
  1070. " */\n"
  1071. "}", getLLVMStyleWithColumns(20)));
  1072. EXPECT_EQ("/*\n"
  1073. " * This is a long\n"
  1074. " * comment that\n"
  1075. " * doesn't fit on\n"
  1076. " * one line\n"
  1077. " */",
  1078. format(" /*\n"
  1079. " * This is a long comment that doesn't fit on one line\n"
  1080. " */", getLLVMStyleWithColumns(20)));
  1081. EXPECT_EQ("{\n"
  1082. " if (something) /* This is a\n"
  1083. " long\n"
  1084. " comment */\n"
  1085. " ;\n"
  1086. "}",
  1087. format("{\n"
  1088. " if (something) /* This is a long comment */\n"
  1089. " ;\n"
  1090. "}",
  1091. getLLVMStyleWithColumns(30)));
  1092. EXPECT_EQ("/* A comment before\n"
  1093. " * a macro\n"
  1094. " * definition */\n"
  1095. "#define a b",
  1096. format("/* A comment before a macro definition */\n"
  1097. "#define a b",
  1098. getLLVMStyleWithColumns(20)));
  1099. EXPECT_EQ("/* some comment\n"
  1100. " * a comment\n"
  1101. "* that we break\n"
  1102. " * another comment\n"
  1103. "* we have to break\n"
  1104. "* a left comment\n"
  1105. " */",
  1106. format(" /* some comment\n"
  1107. " * a comment that we break\n"
  1108. " * another comment we have to break\n"
  1109. "* a left comment\n"
  1110. " */",
  1111. getLLVMStyleWithColumns(20)));
  1112. EXPECT_EQ("/*\n"
  1113. "\n"
  1114. "\n"
  1115. " */\n",
  1116. format(" /* \n"
  1117. " \n"
  1118. " \n"
  1119. " */\n"));
  1120. }
  1121. TEST_F(FormatTest, SplitsLongLinesInCommentsInPreprocessor) {
  1122. EXPECT_EQ("#define X \\\n"
  1123. " /* \\\n"
  1124. " Test \\\n"
  1125. " Macro comment \\\n"
  1126. " with a long \\\n"
  1127. " line \\\n"
  1128. " */ \\\n"
  1129. " A + B",
  1130. format("#define X \\\n"
  1131. " /*\n"
  1132. " Test\n"
  1133. " Macro comment with a long line\n"
  1134. " */ \\\n"
  1135. " A + B",
  1136. getLLVMStyleWithColumns(20)));
  1137. EXPECT_EQ("#define X \\\n"
  1138. " /* Macro comment \\\n"
  1139. " with a long \\\n"
  1140. " line */ \\\n"
  1141. " A + B",
  1142. format("#define X \\\n"
  1143. " /* Macro comment with a long\n"
  1144. " line */ \\\n"
  1145. " A + B",
  1146. getLLVMStyleWithColumns(20)));
  1147. EXPECT_EQ("#define X \\\n"
  1148. " /* Macro comment \\\n"
  1149. " * with a long \\\n"
  1150. " * line */ \\\n"
  1151. " A + B",
  1152. format("#define X \\\n"
  1153. " /* Macro comment with a long line */ \\\n"
  1154. " A + B",
  1155. getLLVMStyleWithColumns(20)));
  1156. }
  1157. TEST_F(FormatTest, CommentsInStaticInitializers) {
  1158. EXPECT_EQ(
  1159. "static SomeType type = { aaaaaaaaaaaaaaaaaaaa, /* comment */\n"
  1160. " aaaaaaaaaaaaaaaaaaaa /* comment */,\n"
  1161. " /* comment */ aaaaaaaaaaaaaaaaaaaa,\n"
  1162. " aaaaaaaaaaaaaaaaaaaa, // comment\n"
  1163. " aaaaaaaaaaaaaaaaaaaa };",
  1164. format("static SomeType type = { aaaaaaaaaaaaaaaaaaaa , /* comment */\n"
  1165. " aaaaaaaaaaaaaaaaaaaa /* comment */ ,\n"
  1166. " /* comment */ aaaaaaaaaaaaaaaaaaaa ,\n"
  1167. " aaaaaaaaaaaaaaaaaaaa , // comment\n"
  1168. " aaaaaaaaaaaaaaaaaaaa };"));
  1169. verifyFormat("static SomeType type = { aaaaaaaaaaa, // comment for aa...\n"
  1170. " bbbbbbbbbbb, ccccccccccc };");
  1171. verifyFormat("static SomeType type = { aaaaaaaaaaa,\n"
  1172. " // comment for bb....\n"
  1173. " bbbbbbbbbbb, ccccccccccc };");
  1174. verifyGoogleFormat(
  1175. "static SomeType type = {aaaaaaaaaaa, // comment for aa...\n"
  1176. " bbbbbbbbbbb, ccccccccccc};");
  1177. verifyGoogleFormat("static SomeType type = {aaaaaaaaaaa,\n"
  1178. " // comment for bb....\n"
  1179. " bbbbbbbbbbb, ccccccccccc};");
  1180. verifyFormat("S s = { { a, b, c }, // Group #1\n"
  1181. " { d, e, f }, // Group #2\n"
  1182. " { g, h, i } }; // Group #3");
  1183. verifyFormat("S s = { { // Group #1\n"
  1184. " a, b, c },\n"
  1185. " { // Group #2\n"
  1186. " d, e, f },\n"
  1187. " { // Group #3\n"
  1188. " g, h, i } };");
  1189. EXPECT_EQ("S s = {\n"
  1190. " // Some comment\n"
  1191. " a,\n"
  1192. "\n"
  1193. " // Comment after empty line\n"
  1194. " b\n"
  1195. "}",
  1196. format("S s = {\n"
  1197. " // Some comment\n"
  1198. " a,\n"
  1199. " \n"
  1200. " // Comment after empty line\n"
  1201. " b\n"
  1202. "}"));
  1203. EXPECT_EQ("S s = {\n"
  1204. " /* Some comment */\n"
  1205. " a,\n"
  1206. "\n"
  1207. " /* Comment after empty line */\n"
  1208. " b\n"
  1209. "}",
  1210. format("S s = {\n"
  1211. " /* Some comment */\n"
  1212. " a,\n"
  1213. " \n"
  1214. " /* Comment after empty line */\n"
  1215. " b\n"
  1216. "}"));
  1217. verifyFormat("const uint8_t aaaaaaaaaaaaaaaaaaaaaa[0] = {\n"
  1218. " 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // comment\n"
  1219. " 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, // comment\n"
  1220. " 0x00, 0x00, 0x00, 0x00 // comment\n"
  1221. "};");
  1222. }
  1223. TEST_F(FormatTest, IgnoresIf0Contents) {
  1224. EXPECT_EQ("#if 0\n"
  1225. "}{)(&*(^%%#%@! fsadj f;ldjs ,:;| <<<>>>][)(][\n"
  1226. "#endif\n"
  1227. "void f() {}",
  1228. format("#if 0\n"
  1229. "}{)(&*(^%%#%@! fsadj f;ldjs ,:;| <<<>>>][)(][\n"
  1230. "#endif\n"
  1231. "void f( ) { }"));
  1232. EXPECT_EQ("#if false\n"
  1233. "void f( ) { }\n"
  1234. "#endif\n"
  1235. "void g() {}\n",
  1236. format("#if false\n"
  1237. "void f( ) { }\n"
  1238. "#endif\n"
  1239. "void g( ) { }\n"));
  1240. EXPECT_EQ("enum E {\n"
  1241. " One,\n"
  1242. " Two,\n"
  1243. "#if 0\n"
  1244. "Three,\n"
  1245. " Four,\n"
  1246. "#endif\n"
  1247. " Five\n"
  1248. "};",
  1249. format("enum E {\n"
  1250. " One,Two,\n"
  1251. "#if 0\n"
  1252. "Three,\n"
  1253. " Four,\n"
  1254. "#endif\n"
  1255. " Five};"));
  1256. EXPECT_EQ("enum F {\n"
  1257. " One,\n"
  1258. "#if 1\n"
  1259. " Two,\n"
  1260. "#if 0\n"
  1261. "Three,\n"
  1262. " Four,\n"
  1263. "#endif\n"
  1264. " Five\n"
  1265. "#endif\n"
  1266. "};",
  1267. format("enum F {\n"
  1268. "One,\n"
  1269. "#if 1\n"
  1270. "Two,\n"
  1271. "#if 0\n"
  1272. "Three,\n"
  1273. " Four,\n"
  1274. "#endif\n"
  1275. "Five\n"
  1276. "#endif\n"
  1277. "};"));
  1278. EXPECT_EQ("enum G {\n"
  1279. " One,\n"
  1280. "#if 0\n"
  1281. "Two,\n"
  1282. "#else\n"
  1283. " Three,\n"
  1284. "#endif\n"
  1285. " Four\n"
  1286. "};",
  1287. format("enum G {\n"
  1288. "One,\n"
  1289. "#if 0\n"
  1290. "Two,\n"
  1291. "#else\n"
  1292. "Three,\n"
  1293. "#endif\n"
  1294. "Four\n"
  1295. "};"));
  1296. EXPECT_EQ("enum H {\n"
  1297. " One,\n"
  1298. "#if 0\n"
  1299. "#ifdef Q\n"
  1300. "Two,\n"
  1301. "#else\n"
  1302. "Three,\n"
  1303. "#endif\n"
  1304. "#endif\n"
  1305. " Four\n"
  1306. "};",
  1307. format("enum H {\n"
  1308. "One,\n"
  1309. "#if 0\n"
  1310. "#ifdef Q\n"
  1311. "Two,\n"
  1312. "#else\n"
  1313. "Three,\n"
  1314. "#endif\n"
  1315. "#endif\n"
  1316. "Four\n"
  1317. "};"));
  1318. EXPECT_EQ("enum I {\n"
  1319. " One,\n"
  1320. "#if /* test */ 0 || 1\n"
  1321. "Two,\n"
  1322. "Three,\n"
  1323. "#endif\n"
  1324. " Four\n"
  1325. "};",
  1326. format("enum I {\n"
  1327. "One,\n"
  1328. "#if /* test */ 0 || 1\n"
  1329. "Two,\n"
  1330. "Three,\n"
  1331. "#endif\n"
  1332. "Four\n"
  1333. "};"));
  1334. EXPECT_EQ("enum J {\n"
  1335. " One,\n"
  1336. "#if 0\n"
  1337. "#if 0\n"
  1338. "Two,\n"
  1339. "#else\n"
  1340. "Three,\n"
  1341. "#endif\n"
  1342. "Four,\n"
  1343. "#endif\n"
  1344. " Five\n"
  1345. "};",
  1346. format("enum J {\n"
  1347. "One,\n"
  1348. "#if 0\n"
  1349. "#if 0\n"
  1350. "Two,\n"
  1351. "#else\n"
  1352. "Three,\n"
  1353. "#endif\n"
  1354. "Four,\n"
  1355. "#endif\n"
  1356. "Five\n"
  1357. "};"));
  1358. }
  1359. //===----------------------------------------------------------------------===//
  1360. // Tests for classes, namespaces, etc.
  1361. //===----------------------------------------------------------------------===//
  1362. TEST_F(FormatTest, DoesNotBreakSemiAfterClassDecl) {
  1363. verifyFormat("class A {};");
  1364. }
  1365. TEST_F(FormatTest, UnderstandsAccessSpecifiers) {
  1366. verifyFormat("class A {\n"
  1367. "public:\n"
  1368. "public: // comment\n"
  1369. "protected:\n"
  1370. "private:\n"
  1371. " void f() {}\n"
  1372. "};");
  1373. verifyGoogleFormat("class A {\n"
  1374. " public:\n"
  1375. " protected:\n"
  1376. " private:\n"
  1377. " void f() {}\n"
  1378. "};");
  1379. }
  1380. TEST_F(FormatTest, SeparatesLogicalBlocks) {
  1381. EXPECT_EQ("class A {\n"
  1382. "public:\n"
  1383. " void f();\n"
  1384. "\n"
  1385. "private:\n"
  1386. " void g() {}\n"
  1387. " // test\n"
  1388. "protected:\n"
  1389. " int h;\n"
  1390. "};",
  1391. format("class A {\n"
  1392. "public:\n"
  1393. "void f();\n"
  1394. "private:\n"
  1395. "void g() {}\n"
  1396. "// test\n"
  1397. "protected:\n"
  1398. "int h;\n"
  1399. "};"));
  1400. EXPECT_EQ("class A {\n"
  1401. "protected:\n"
  1402. "public:\n"
  1403. " void f();\n"
  1404. "};",
  1405. format("class A {\n"
  1406. "protected:\n"
  1407. "\n"
  1408. "public:\n"
  1409. "\n"
  1410. " void f();\n"
  1411. "};"));
  1412. }
  1413. TEST_F(FormatTest, FormatsClasses) {
  1414. verifyFormat("class A : public B {};");
  1415. verifyFormat("class A : public ::B {};");
  1416. verifyFormat(
  1417. "class AAAAAAAAAAAAAAAAAAAA : public BBBBBBBBBBBBBBBBBBBBBBBBBBBBBB,\n"
  1418. " public CCCCCCCCCCCCCCCCCCCCCCCCCCCCCC {};");
  1419. verifyFormat("class AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA\n"
  1420. " : public BBBBBBBBBBBBBBBBBBBBBBBBBBBBBB,\n"
  1421. " public CCCCCCCCCCCCCCCCCCCCCCCCCCCCCC {};");
  1422. verifyFormat(
  1423. "class A : public B, public C, public D, public E, public F {};");
  1424. verifyFormat("class AAAAAAAAAAAA : public B,\n"
  1425. " public C,\n"
  1426. " public D,\n"
  1427. " public E,\n"
  1428. " public F,\n"
  1429. " public G {};");
  1430. verifyFormat("class\n"
  1431. " ReallyReallyLongClassName {\n"
  1432. " int i;\n"
  1433. "};",
  1434. getLLVMStyleWithColumns(32));
  1435. verifyFormat("struct aaaaaaaaaaaaa : public aaaaaaaaaaaaaaaaaaa< // break\n"
  1436. " aaaaaaaaaaaaaaaa> {};");
  1437. verifyFormat("struct aaaaaaaaaaaaaaaaaaaa\n"
  1438. " : public aaaaaaaaaaaaaaaaaaa<aaaaaaaaaaaaaaaaaaaaa,\n"
  1439. " aaaaaaaaaaaaaaaaaaaaaa> {};");
  1440. }
  1441. TEST_F(FormatTest, FormatsVariableDeclarationsAfterStructOrClass) {
  1442. verifyFormat("class A {\n} a, b;");
  1443. verifyFormat("struct A {\n} a, b;");
  1444. verifyFormat("union A {\n} a;");
  1445. }
  1446. TEST_F(FormatTest, FormatsEnum) {
  1447. verifyFormat("enum {\n"
  1448. " Zero,\n"
  1449. " One = 1,\n"
  1450. " Two = One + 1,\n"
  1451. " Three = (One + Two),\n"
  1452. " Four = (Zero && (One ^ Two)) | (One << Two),\n"
  1453. " Five = (One, Two, Three, Four, 5)\n"
  1454. "};");
  1455. verifyGoogleFormat("enum {\n"
  1456. " Zero,\n"
  1457. " One = 1,\n"
  1458. " Two = One + 1,\n"
  1459. " Three = (One + Two),\n"
  1460. " Four = (Zero && (One ^ Two)) | (One << Two),\n"
  1461. " Five = (One, Two, Three, Four, 5)\n"
  1462. "};");
  1463. verifyFormat("enum Enum {};");
  1464. verifyFormat("enum {};");
  1465. verifyFormat("enum X E {} d;");
  1466. verifyFormat("enum __attribute__((...)) E {} d;");
  1467. verifyFormat("enum __declspec__((...)) E {} d;");
  1468. verifyFormat("enum X f() {\n a();\n return 42;\n}");
  1469. verifyFormat("enum {\n"
  1470. " Bar = Foo<int, int>::value\n"
  1471. "};");
  1472. }
  1473. TEST_F(FormatTest, FormatsEnumsWithErrors) {
  1474. verifyFormat("enum Type {\n"
  1475. " One = 0;\n" // These semicolons should be commas.
  1476. " Two = 1;\n"
  1477. "};");
  1478. verifyFormat("namespace n {\n"
  1479. "enum Type {\n"
  1480. " One,\n"
  1481. " Two,\n" // missing };
  1482. " int i;\n"
  1483. "}\n"
  1484. "void g() {}");
  1485. }
  1486. TEST_F(FormatTest, FormatsEnumStruct) {
  1487. verifyFormat("enum struct {\n"
  1488. " Zero,\n"
  1489. " One = 1,\n"
  1490. " Two = One + 1,\n"
  1491. " Three = (One + Two),\n"
  1492. " Four = (Zero && (One ^ Two)) | (One << Two),\n"
  1493. " Five = (One, Two, Three, Four, 5)\n"
  1494. "};");
  1495. verifyFormat("enum struct Enum {};");
  1496. verifyFormat("enum struct {};");
  1497. verifyFormat("enum struct X E {} d;");
  1498. verifyFormat("enum struct __attribute__((...)) E {} d;");
  1499. verifyFormat("enum struct __declspec__((...)) E {} d;");
  1500. verifyFormat("enum struct X f() {\n a();\n return 42;\n}");
  1501. }
  1502. TEST_F(FormatTest, FormatsEnumClass) {
  1503. verifyFormat("enum class {\n"
  1504. " Zero,\n"
  1505. " One = 1,\n"
  1506. " Two = One + 1,\n"
  1507. " Three = (One + Two),\n"
  1508. " Four = (Zero && (One ^ Two)) | (One << Two),\n"
  1509. " Five = (One, Two, Three, Four, 5)\n"
  1510. "};");
  1511. verifyFormat("enum class Enum {};");
  1512. verifyFormat("enum class {};");
  1513. verifyFormat("enum class X E {} d;");
  1514. verifyFormat("enum class __attribute__((...)) E {} d;");
  1515. verifyFormat("enum class __declspec__((...)) E {} d;");
  1516. verifyFormat("enum class X f() {\n a();\n return 42;\n}");
  1517. }
  1518. TEST_F(FormatTest, FormatsEnumTypes) {
  1519. verifyFormat("enum X : int {\n"
  1520. " A,\n"
  1521. " B\n"
  1522. "};");
  1523. verifyFormat("enum X : std::uint32_t {\n"
  1524. " A,\n"
  1525. " B\n"
  1526. "};");
  1527. }
  1528. TEST_F(FormatTest, FormatsBitfields) {
  1529. verifyFormat("struct Bitfields {\n"
  1530. " unsigned sClass : 8;\n"
  1531. " unsigned ValueKind : 2;\n"
  1532. "};");
  1533. }
  1534. TEST_F(FormatTest, FormatsNamespaces) {
  1535. verifyFormat("namespace some_namespace {\n"
  1536. "class A {};\n"
  1537. "void f() { f(); }\n"
  1538. "}");
  1539. verifyFormat("namespace {\n"
  1540. "class A {};\n"
  1541. "void f() { f(); }\n"
  1542. "}");
  1543. verifyFormat("inline namespace X {\n"
  1544. "class A {};\n"
  1545. "void f() { f(); }\n"
  1546. "}");
  1547. verifyFormat("using namespace some_namespace;\n"
  1548. "class A {};\n"
  1549. "void f() { f(); }");
  1550. // This code is more common than we thought; if we
  1551. // layout this correctly the semicolon will go into
  1552. // its own line, which is undesireable.
  1553. verifyFormat("namespace {};");
  1554. verifyFormat("namespace {\n"
  1555. "class A {};\n"
  1556. "};");
  1557. verifyFormat("namespace {\n"
  1558. "int SomeVariable = 0; // comment\n"
  1559. "} // namespace");
  1560. EXPECT_EQ("#ifndef HEADER_GUARD\n"
  1561. "#define HEADER_GUARD\n"
  1562. "namespace my_namespace {\n"
  1563. "int i;\n"
  1564. "} // my_namespace\n"
  1565. "#endif // HEADER_GUARD",
  1566. format("#ifndef HEADER_GUARD\n"
  1567. " #define HEADER_GUARD\n"
  1568. " namespace my_namespace {\n"
  1569. "int i;\n"
  1570. "} // my_namespace\n"
  1571. "#endif // HEADER_GUARD"));
  1572. FormatStyle Style = getLLVMStyle();
  1573. Style.NamespaceIndentation = FormatStyle::NI_All;
  1574. EXPECT_EQ("namespace out {\n"
  1575. " int i;\n"
  1576. " namespace in {\n"
  1577. " int i;\n"
  1578. " } // namespace\n"
  1579. "} // namespace",
  1580. format("namespace out {\n"
  1581. "int i;\n"
  1582. "namespace in {\n"
  1583. "int i;\n"
  1584. "} // namespace\n"
  1585. "} // namespace",
  1586. Style));
  1587. Style.NamespaceIndentation = FormatStyle::NI_Inner;
  1588. EXPECT_EQ("namespace out {\n"
  1589. "int i;\n"
  1590. "namespace in {\n"
  1591. " int i;\n"
  1592. "} // namespace\n"
  1593. "} // namespace",
  1594. format("namespace out {\n"
  1595. "int i;\n"
  1596. "namespace in {\n"
  1597. "int i;\n"
  1598. "} // namespace\n"
  1599. "} // namespace",
  1600. Style));
  1601. }
  1602. TEST_F(FormatTest, FormatsExternC) { verifyFormat("extern \"C\" {\nint a;"); }
  1603. TEST_F(FormatTest, FormatsInlineASM) {
  1604. verifyFormat("asm(\"xyz\" : \"=a\"(a), \"=d\"(b) : \"a\"(data));");
  1605. verifyFormat(
  1606. "asm(\"movq\\t%%rbx, %%rsi\\n\\t\"\n"
  1607. " \"cpuid\\n\\t\"\n"
  1608. " \"xchgq\\t%%rbx, %%rsi\\n\\t\"\n"
  1609. " : \"=a\"(*rEAX), \"=S\"(*rEBX), \"=c\"(*rECX), \"=d\"(*rEDX)\n"
  1610. " : \"a\"(value));");
  1611. }
  1612. TEST_F(FormatTest, FormatTryCatch) {
  1613. // FIXME: Handle try-catch explicitly in the UnwrappedLineParser, then we'll
  1614. // also not create single-line-blocks.
  1615. verifyFormat("try {\n"
  1616. " throw a * b;\n"
  1617. "}\n"
  1618. "catch (int a) {\n"
  1619. " // Do nothing.\n"
  1620. "}\n"
  1621. "catch (...) {\n"
  1622. " exit(42);\n"
  1623. "}");
  1624. // Function-level try statements.
  1625. verifyFormat("int f() try { return 4; }\n"
  1626. "catch (...) {\n"
  1627. " return 5;\n"
  1628. "}");
  1629. verifyFormat("class A {\n"
  1630. " int a;\n"
  1631. " A() try : a(0) {}\n"
  1632. " catch (...) {\n"
  1633. " throw;\n"
  1634. " }\n"
  1635. "};\n");
  1636. }
  1637. TEST_F(FormatTest, FormatObjCTryCatch) {
  1638. verifyFormat("@try {\n"
  1639. " f();\n"
  1640. "}\n"
  1641. "@catch (NSException e) {\n"
  1642. " @throw;\n"
  1643. "}\n"
  1644. "@finally {\n"
  1645. " exit(42);\n"
  1646. "}");
  1647. }
  1648. TEST_F(FormatTest, StaticInitializers) {
  1649. verifyFormat("static SomeClass SC = { 1, 'a' };");
  1650. verifyFormat(
  1651. "static SomeClass WithALoooooooooooooooooooongName = {\n"
  1652. " 100000000, \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n"
  1653. "};");
  1654. // Here, everything other than the "}" would fit on a line.
  1655. verifyFormat("static int LooooooooooooooooooooooooongVariable[1] = {\n"
  1656. " 100000000000000000000000\n"
  1657. "};");
  1658. EXPECT_EQ("S s = { a, b };", format("S s = {\n"
  1659. " a,\n"
  1660. "\n"
  1661. " b\n"
  1662. "};"));
  1663. // FIXME: This would fit into the column limit if we'd fit "{ {" on the first
  1664. // line. However, the formatting looks a bit off and this probably doesn't
  1665. // happen often in practice.
  1666. verifyFormat("static int Variable[1] = {\n"
  1667. " { 1000000000000000000000000000000000000 }\n"
  1668. "};",
  1669. getLLVMStyleWithColumns(40));
  1670. }
  1671. TEST_F(FormatTest, DesignatedInitializers) {
  1672. verifyFormat("const struct A a = { .a = 1, .b = 2 };");
  1673. verifyFormat("const struct A a = { .aaaaaaaaaa = 1,\n"
  1674. " .bbbbbbbbbb = 2,\n"
  1675. " .cccccccccc = 3,\n"
  1676. " .dddddddddd = 4,\n"
  1677. " .eeeeeeeeee = 5 };");
  1678. verifyFormat("const struct Aaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaa = {\n"
  1679. " .aaaaaaaaaaaaaaaaaaaaaaaaaaa = 1,\n"
  1680. " .bbbbbbbbbbbbbbbbbbbbbbbbbbb = 2,\n"
  1681. " .ccccccccccccccccccccccccccc = 3,\n"
  1682. " .ddddddddddddddddddddddddddd = 4,\n"
  1683. " .eeeeeeeeeeeeeeeeeeeeeeeeeee = 5\n"
  1684. "};");
  1685. verifyGoogleFormat("const struct A a = {.a = 1, .b = 2};");
  1686. }
  1687. TEST_F(FormatTest, NestedStaticInitializers) {
  1688. verifyFormat("static A x = { { {} } };\n");
  1689. verifyFormat("static A x = { { { init1, init2, init3, init4 },\n"
  1690. " { init1, init2, init3, init4 } } };");
  1691. verifyFormat("somes Status::global_reps[3] = {\n"
  1692. " { kGlobalRef, OK_CODE, NULL, NULL, NULL },\n"
  1693. " { kGlobalRef, CANCELLED_CODE, NULL, NULL, NULL },\n"
  1694. " { kGlobalRef, UNKNOWN_CODE, NULL, NULL, NULL }\n"
  1695. "};");
  1696. verifyGoogleFormat("SomeType Status::global_reps[3] = {\n"
  1697. " {kGlobalRef, OK_CODE, NULL, NULL, NULL},\n"
  1698. " {kGlobalRef, CANCELLED_CODE, NULL, NULL, NULL},\n"
  1699. " {kGlobalRef, UNKNOWN_CODE, NULL, NULL, NULL}};");
  1700. verifyFormat(
  1701. "CGRect cg_rect = { { rect.fLeft, rect.fTop },\n"
  1702. " { rect.fRight - rect.fLeft, rect.fBottom - rect.fTop"
  1703. " } };");
  1704. verifyFormat(
  1705. "SomeArrayOfSomeType a = { { { 1, 2, 3 }, { 1, 2, 3 },\n"
  1706. " { 111111111111111111111111111111,\n"
  1707. " 222222222222222222222222222222,\n"
  1708. " 333333333333333333333333333333 },\n"
  1709. " { 1, 2, 3 }, { 1, 2, 3 } } };");
  1710. verifyFormat(
  1711. "SomeArrayOfSomeType a = { { { 1, 2, 3 } }, { { 1, 2, 3 } },\n"
  1712. " { { 111111111111111111111111111111,\n"
  1713. " 222222222222222222222222222222,\n"
  1714. " 333333333333333333333333333333 } },\n"
  1715. " { { 1, 2, 3 } }, { { 1, 2, 3 } } };");
  1716. verifyGoogleFormat(
  1717. "SomeArrayOfSomeType a = {\n"
  1718. " {{1, 2, 3}}, {{1, 2, 3}},\n"
  1719. " {{111111111111111111111111111111, 222222222222222222222222222222,\n"
  1720. " 333333333333333333333333333333}},\n"
  1721. " {{1, 2, 3}}, {{1, 2, 3}}};");
  1722. // FIXME: We might at some point want to handle this similar to parameter
  1723. // lists, where we have an option to put each on a single line.
  1724. verifyFormat(
  1725. "struct {\n"
  1726. " unsigned bit;\n"
  1727. " const char *const name;\n"
  1728. "} kBitsToOs[] = { { kOsMac, \"Mac\" }, { kOsWin, \"Windows\" },\n"
  1729. " { kOsLinux, \"Linux\" }, { kOsCrOS, \"Chrome OS\" } };");
  1730. }
  1731. TEST_F(FormatTest, FormatsSmallMacroDefinitionsInSingleLine) {
  1732. verifyFormat("#define ALooooooooooooooooooooooooooooooooooooooongMacro("
  1733. " \\\n"
  1734. " aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)");
  1735. }
  1736. TEST_F(FormatTest, DoesNotBreakPureVirtualFunctionDefinition) {
  1737. verifyFormat(
  1738. "virtual void write(ELFWriter *writerrr,\n"
  1739. " OwningPtr<FileOutputBuffer> &buffer) = 0;");
  1740. }
  1741. TEST_F(FormatTest, LayoutUnknownPPDirective) {
  1742. EXPECT_EQ("#123 \"A string literal\"",
  1743. format(" # 123 \"A string literal\""));
  1744. EXPECT_EQ("#;", format("#;"));
  1745. verifyFormat("#\n;\n;\n;");
  1746. }
  1747. TEST_F(FormatTest, UnescapedEndOfLineEndsPPDirective) {
  1748. EXPECT_EQ("#line 42 \"test\"\n",
  1749. format("# \\\n line \\\n 42 \\\n \"test\"\n"));
  1750. EXPECT_EQ("#define A B\n", format("# \\\n define \\\n A \\\n B\n",
  1751. getLLVMStyleWithColumns(12)));
  1752. }
  1753. TEST_F(FormatTest, EndOfFileEndsPPDirective) {
  1754. EXPECT_EQ("#line 42 \"test\"",
  1755. format("# \\\n line \\\n 42 \\\n \"test\""));
  1756. EXPECT_EQ("#define A B", format("# \\\n define \\\n A \\\n B"));
  1757. }
  1758. TEST_F(FormatTest, IndentsPPDirectiveInReducedSpace) {
  1759. verifyFormat("#define A(BB)", getLLVMStyleWithColumns(13));
  1760. verifyFormat("#define A( \\\n BB)", getLLVMStyleWithColumns(12));
  1761. verifyFormat("#define A( \\\n A, B)", getLLVMStyleWithColumns(12));
  1762. // FIXME: We never break before the macro name.
  1763. verifyFormat("#define AA( \\\n B)", getLLVMStyleWithColumns(12));
  1764. verifyFormat("#define A A\n#define A A");
  1765. verifyFormat("#define A(X) A\n#define A A");
  1766. verifyFormat("#define Something Other", getLLVMStyleWithColumns(23));
  1767. verifyFormat("#define Something \\\n Other", getLLVMStyleWithColumns(22));
  1768. }
  1769. TEST_F(FormatTest, HandlePreprocessorDirectiveContext) {
  1770. EXPECT_EQ("// somecomment\n"
  1771. "#include \"a.h\"\n"
  1772. "#define A( \\\n"
  1773. " A, B)\n"
  1774. "#include \"b.h\"\n"
  1775. "// somecomment\n",
  1776. format(" // somecomment\n"
  1777. " #include \"a.h\"\n"
  1778. "#define A(A,\\\n"
  1779. " B)\n"
  1780. " #include \"b.h\"\n"
  1781. " // somecomment\n",
  1782. getLLVMStyleWithColumns(13)));
  1783. }
  1784. TEST_F(FormatTest, LayoutSingleHash) { EXPECT_EQ("#\na;", format("#\na;")); }
  1785. TEST_F(FormatTest, LayoutCodeInMacroDefinitions) {
  1786. EXPECT_EQ("#define A \\\n"
  1787. " c; \\\n"
  1788. " e;\n"
  1789. "f;",
  1790. format("#define A c; e;\n"
  1791. "f;",
  1792. getLLVMStyleWithColumns(14)));
  1793. }
  1794. TEST_F(FormatTest, LayoutRemainingTokens) { EXPECT_EQ("{}", format("{}")); }
  1795. TEST_F(FormatTest, AlwaysFormatsEntireMacroDefinitions) {
  1796. EXPECT_EQ("int i;\n"
  1797. "#define A \\\n"
  1798. " int i; \\\n"
  1799. " int j\n"
  1800. "int k;",
  1801. format("int i;\n"
  1802. "#define A \\\n"
  1803. " int i ; \\\n"
  1804. " int j\n"
  1805. "int k;",
  1806. 8, 0, getGoogleStyle())); // 8: position of "#define".
  1807. EXPECT_EQ("int i;\n"
  1808. "#define A \\\n"
  1809. " int i; \\\n"
  1810. " int j\n"
  1811. "int k;",
  1812. format("int i;\n"
  1813. "#define A \\\n"
  1814. " int i ; \\\n"
  1815. " int j\n"
  1816. "int k;",
  1817. 45, 0, getGoogleStyle())); // 45: position of "j".
  1818. }
  1819. TEST_F(FormatTest, MacroDefinitionInsideStatement) {
  1820. EXPECT_EQ("int x,\n"
  1821. "#define A\n"
  1822. " y;",
  1823. format("int x,\n#define A\ny;"));
  1824. }
  1825. TEST_F(FormatTest, HashInMacroDefinition) {
  1826. EXPECT_EQ("#define A(c) L#c", format("#define A(c) L#c", getLLVMStyle()));
  1827. verifyFormat("#define A \\\n b #c;", getLLVMStyleWithColumns(11));
  1828. verifyFormat("#define A \\\n"
  1829. " { \\\n"
  1830. " f(#c); \\\n"
  1831. " }",
  1832. getLLVMStyleWithColumns(11));
  1833. verifyFormat("#define A(X) \\\n"
  1834. " void function##X()",
  1835. getLLVMStyleWithColumns(22));
  1836. verifyFormat("#define A(a, b, c) \\\n"
  1837. " void a##b##c()",
  1838. getLLVMStyleWithColumns(22));
  1839. verifyFormat("#define A void # ## #", getLLVMStyleWithColumns(22));
  1840. }
  1841. TEST_F(FormatTest, RespectWhitespaceInMacroDefinitions) {
  1842. verifyFormat("#define A (1)");
  1843. }
  1844. TEST_F(FormatTest, EmptyLinesInMacroDefinitions) {
  1845. EXPECT_EQ("#define A b;", format("#define A \\\n"
  1846. " \\\n"
  1847. " b;",
  1848. getLLVMStyleWithColumns(25)));
  1849. EXPECT_EQ("#define A \\\n"
  1850. " \\\n"
  1851. " a; \\\n"
  1852. " b;",
  1853. format("#define A \\\n"
  1854. " \\\n"
  1855. " a; \\\n"
  1856. " b;",
  1857. getLLVMStyleWithColumns(11)));
  1858. EXPECT_EQ("#define A \\\n"
  1859. " a; \\\n"
  1860. " \\\n"
  1861. " b;",
  1862. format("#define A \\\n"
  1863. " a; \\\n"
  1864. " \\\n"
  1865. " b;",
  1866. getLLVMStyleWithColumns(11)));
  1867. }
  1868. TEST_F(FormatTest, MacroDefinitionsWithIncompleteCode) {
  1869. verifyFormat("#define A :");
  1870. verifyFormat("#define SOMECASES \\\n"
  1871. " case 1: \\\n"
  1872. " case 2\n",
  1873. getLLVMStyleWithColumns(20));
  1874. verifyFormat("#define A template <typename T>");
  1875. verifyFormat("#define STR(x) #x\n"
  1876. "f(STR(this_is_a_string_literal{));");
  1877. verifyFormat("#pragma omp threadprivate( \\\n"
  1878. " y)), // expected-warning",
  1879. getLLVMStyleWithColumns(28));
  1880. }
  1881. TEST_F(FormatTest, MacrosWithoutTrailingSemicolon) {
  1882. verifyFormat("SOME_TYPE_NAME abc;"); // Gated on the newline.
  1883. EXPECT_EQ("class A : public QObject {\n"
  1884. " Q_OBJECT\n"
  1885. "\n"
  1886. " A() {}\n"
  1887. "};",
  1888. format("class A : public QObject {\n"
  1889. " Q_OBJECT\n"
  1890. "\n"
  1891. " A() {\n}\n"
  1892. "} ;"));
  1893. EXPECT_EQ("SOME_MACRO\n"
  1894. "namespace {\n"
  1895. "void f();\n"
  1896. "}",
  1897. format("SOME_MACRO\n"
  1898. " namespace {\n"
  1899. "void f( );\n"
  1900. "}"));
  1901. // Only if the identifier contains at least 5 characters.
  1902. EXPECT_EQ("HTTP f();",
  1903. format("HTTP\nf();"));
  1904. EXPECT_EQ("MACRO\nf();",
  1905. format("MACRO\nf();"));
  1906. // Only if everything is upper case.
  1907. EXPECT_EQ("class A : public QObject {\n"
  1908. " Q_Object A() {}\n"
  1909. "};",
  1910. format("class A : public QObject {\n"
  1911. " Q_Object\n"
  1912. "\n"
  1913. " A() {\n}\n"
  1914. "} ;"));
  1915. }
  1916. TEST_F(FormatTest, MacroCallsWithoutTrailingSemicolon) {
  1917. EXPECT_EQ("INITIALIZE_PASS_BEGIN(ScopDetection, \"polly-detect\")\n"
  1918. "INITIALIZE_AG_DEPENDENCY(AliasAnalysis)\n"
  1919. "INITIALIZE_PASS_DEPENDENCY(DominatorTree)\n"
  1920. "class X {};\n"
  1921. "INITIALIZE_PASS_END(ScopDetection, \"polly-detect\")\n"
  1922. "int *createScopDetectionPass() { return 0; }",
  1923. format(" INITIALIZE_PASS_BEGIN(ScopDetection, \"polly-detect\")\n"
  1924. " INITIALIZE_AG_DEPENDENCY(AliasAnalysis)\n"
  1925. " INITIALIZE_PASS_DEPENDENCY(DominatorTree)\n"
  1926. " class X {};\n"
  1927. " INITIALIZE_PASS_END(ScopDetection, \"polly-detect\")\n"
  1928. " int *createScopDetectionPass() { return 0; }"));
  1929. // FIXME: We could probably treat IPC_BEGIN_MESSAGE_MAP/IPC_END_MESSAGE_MAP as
  1930. // braces, so that inner block is indented one level more.
  1931. EXPECT_EQ("int q() {\n"
  1932. " IPC_BEGIN_MESSAGE_MAP(WebKitTestController, message)\n"
  1933. " IPC_MESSAGE_HANDLER(xxx, qqq)\n"
  1934. " IPC_END_MESSAGE_MAP()\n"
  1935. "}",
  1936. format("int q() {\n"
  1937. " IPC_BEGIN_MESSAGE_MAP(WebKitTestController, message)\n"
  1938. " IPC_MESSAGE_HANDLER(xxx, qqq)\n"
  1939. " IPC_END_MESSAGE_MAP()\n"
  1940. "}"));
  1941. // These must not be recognized as macros.
  1942. EXPECT_EQ("int q() {\n"
  1943. " f(x);\n"
  1944. " f(x) {}\n"
  1945. " f(x)->g();\n"
  1946. " f(x)->*g();\n"
  1947. " f(x).g();\n"
  1948. " f(x) = x;\n"
  1949. " f(x) += x;\n"
  1950. " f(x) -= x;\n"
  1951. " f(x) *= x;\n"
  1952. " f(x) /= x;\n"
  1953. " f(x) %= x;\n"
  1954. " f(x) &= x;\n"
  1955. " f(x) |= x;\n"
  1956. " f(x) ^= x;\n"
  1957. " f(x) >>= x;\n"
  1958. " f(x) <<= x;\n"
  1959. " f(x)[y].z();\n"
  1960. " LOG(INFO) << x;\n"
  1961. " ifstream(x) >> x;\n"
  1962. "}\n",
  1963. format("int q() {\n"
  1964. " f(x)\n;\n"
  1965. " f(x)\n {}\n"
  1966. " f(x)\n->g();\n"
  1967. " f(x)\n->*g();\n"
  1968. " f(x)\n.g();\n"
  1969. " f(x)\n = x;\n"
  1970. " f(x)\n += x;\n"
  1971. " f(x)\n -= x;\n"
  1972. " f(x)\n *= x;\n"
  1973. " f(x)\n /= x;\n"
  1974. " f(x)\n %= x;\n"
  1975. " f(x)\n &= x;\n"
  1976. " f(x)\n |= x;\n"
  1977. " f(x)\n ^= x;\n"
  1978. " f(x)\n >>= x;\n"
  1979. " f(x)\n <<= x;\n"
  1980. " f(x)\n[y].z();\n"
  1981. " LOG(INFO)\n << x;\n"
  1982. " ifstream(x)\n >> x;\n"
  1983. "}\n"));
  1984. EXPECT_EQ("int q() {\n"
  1985. " f(x)\n"
  1986. " if (1) {\n"
  1987. " }\n"
  1988. " f(x)\n"
  1989. " while (1) {\n"
  1990. " }\n"
  1991. " f(x)\n"
  1992. " g(x);\n"
  1993. " f(x)\n"
  1994. " try {\n"
  1995. " q();\n"
  1996. " }\n"
  1997. " catch (...) {\n"
  1998. " }\n"
  1999. "}\n",
  2000. format("int q() {\n"
  2001. "f(x)\n"
  2002. "if (1) {}\n"
  2003. "f(x)\n"
  2004. "while (1) {}\n"
  2005. "f(x)\n"
  2006. "g(x);\n"
  2007. "f(x)\n"
  2008. "try { q(); } catch (...) {}\n"
  2009. "}\n"));
  2010. EXPECT_EQ("class A {\n"
  2011. " A() : t(0) {}\n"
  2012. " A(X x)\n" // FIXME: function-level try blocks are broken.
  2013. " try : t(0) {\n"
  2014. " }\n"
  2015. " catch (...) {\n"
  2016. " }\n"
  2017. "};",
  2018. format("class A {\n"
  2019. " A()\n : t(0) {}\n"
  2020. " A(X x)\n"
  2021. " try : t(0) {} catch (...) {}\n"
  2022. "};"));
  2023. }
  2024. TEST_F(FormatTest, LayoutMacroDefinitionsStatementsSpanningBlocks) {
  2025. verifyFormat("#define A \\\n"
  2026. " f({ \\\n"
  2027. " g(); \\\n"
  2028. " });", getLLVMStyleWithColumns(11));
  2029. }
  2030. TEST_F(FormatTest, IndentPreprocessorDirectivesAtZero) {
  2031. EXPECT_EQ("{\n {\n#define A\n }\n}", format("{{\n#define A\n}}"));
  2032. }
  2033. TEST_F(FormatTest, FormatHashIfNotAtStartOfLine) {
  2034. verifyFormat("{\n { a #c; }\n}");
  2035. }
  2036. TEST_F(FormatTest, FormatUnbalancedStructuralElements) {
  2037. EXPECT_EQ("#define A \\\n { \\\n {\nint i;",
  2038. format("#define A { {\nint i;", getLLVMStyleWithColumns(11)));
  2039. EXPECT_EQ("#define A \\\n } \\\n }\nint i;",
  2040. format("#define A } }\nint i;", getLLVMStyleWithColumns(11)));
  2041. }
  2042. TEST_F(FormatTest, EscapedNewlineAtStartOfToken) {
  2043. EXPECT_EQ(
  2044. "#define A \\\n int i; \\\n int j;",
  2045. format("#define A \\\nint i;\\\n int j;", getLLVMStyleWithColumns(11)));
  2046. EXPECT_EQ("template <class T> f();", format("\\\ntemplate <class T> f();"));
  2047. }
  2048. TEST_F(FormatTest, NoEscapedNewlineHandlingInBlockComments) {
  2049. EXPECT_EQ("/* \\ \\ \\\n*/", format("\\\n/* \\ \\ \\\n*/"));
  2050. }
  2051. TEST_F(FormatTest, CalculateSpaceOnConsecutiveLinesInMacro) {
  2052. verifyFormat("#define A \\\n"
  2053. " int v( \\\n"
  2054. " a); \\\n"
  2055. " int i;",
  2056. getLLVMStyleWithColumns(11));
  2057. }
  2058. TEST_F(FormatTest, MixingPreprocessorDirectivesAndNormalCode) {
  2059. EXPECT_EQ(
  2060. "#define ALooooooooooooooooooooooooooooooooooooooongMacro("
  2061. " \\\n"
  2062. " aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)\n"
  2063. "\n"
  2064. "AlooooooooooooooooooooooooooooooooooooooongCaaaaaaaaaal(\n"
  2065. " aLooooooooooooooooooooooonPaaaaaaaaaaaaaaaaaaaaarmmmm);\n",
  2066. format(" #define ALooooooooooooooooooooooooooooooooooooooongMacro("
  2067. "\\\n"
  2068. "aLoooooooooooooooooooooooongFuuuuuuuuuuuuuunctiooooooooo)\n"
  2069. " \n"
  2070. " AlooooooooooooooooooooooooooooooooooooooongCaaaaaaaaaal(\n"
  2071. " aLooooooooooooooooooooooonPaaaaaaaaaaaaaaaaaaaaarmmmm);\n"));
  2072. }
  2073. TEST_F(FormatTest, LayoutStatementsAroundPreprocessorDirectives) {
  2074. EXPECT_EQ("int\n"
  2075. "#define A\n"
  2076. " a;",
  2077. format("int\n#define A\na;", getGoogleStyle()));
  2078. verifyFormat("functionCallTo(\n"
  2079. " someOtherFunction(\n"
  2080. " withSomeParameters, whichInSequence,\n"
  2081. " areLongerThanALine(andAnotherCall,\n"
  2082. "#define A B\n"
  2083. " withMoreParamters,\n"
  2084. " whichStronglyInfluenceTheLayout),\n"
  2085. " andMoreParameters),\n"
  2086. " trailing);",
  2087. getLLVMStyleWithColumns(69));
  2088. verifyFormat("Foo::Foo()\n"
  2089. "#ifdef BAR\n"
  2090. " : baz(0)\n"
  2091. "#endif\n"
  2092. "{\n"
  2093. "}");
  2094. }
  2095. TEST_F(FormatTest, LayoutBlockInsideParens) {
  2096. EXPECT_EQ("functionCall({ int i; });", format(" functionCall ( {int i;} );"));
  2097. EXPECT_EQ("functionCall({\n"
  2098. " int i;\n"
  2099. " int j;\n"
  2100. "});",
  2101. format(" functionCall ( {int i;int j;} );"));
  2102. EXPECT_EQ("functionCall({\n"
  2103. " int i;\n"
  2104. " int j;\n"
  2105. " },\n"
  2106. " aaaa, bbbb, cccc);",
  2107. format(" functionCall ( {int i;int j;}, aaaa, bbbb, cccc);"));
  2108. EXPECT_EQ("functionCall(aaaa, bbbb, { int i; });",
  2109. format(" functionCall (aaaa, bbbb, {int i;});"));
  2110. EXPECT_EQ("functionCall(aaaa, bbbb, {\n"
  2111. " int i;\n"
  2112. " int j;\n"
  2113. "});",
  2114. format(" functionCall (aaaa, bbbb, {int i;int j;});"));
  2115. EXPECT_EQ("functionCall(aaaa, bbbb, { int i; });",
  2116. format(" functionCall (aaaa, bbbb, {int i;});"));
  2117. verifyFormat(
  2118. "Aaa({\n"
  2119. " int i; // break\n"
  2120. " },\n"
  2121. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
  2122. " ccccccccccccccccc));");
  2123. verifyFormat("DEBUG({\n"
  2124. " if (a)\n"
  2125. " f();\n"
  2126. "});");
  2127. }
  2128. TEST_F(FormatTest, LayoutBlockInsideStatement) {
  2129. EXPECT_EQ("SOME_MACRO { int i; }\n"
  2130. "int i;",
  2131. format(" SOME_MACRO {int i;} int i;"));
  2132. }
  2133. TEST_F(FormatTest, LayoutNestedBlocks) {
  2134. verifyFormat("void AddOsStrings(unsigned bitmask) {\n"
  2135. " struct s {\n"
  2136. " int i;\n"
  2137. " };\n"
  2138. " s kBitsToOs[] = { { 10 } };\n"
  2139. " for (int i = 0; i < 10; ++i)\n"
  2140. " return;\n"
  2141. "}");
  2142. verifyFormat("call(parameter, {\n"
  2143. " something();\n"
  2144. " // Comment using all columns.\n"
  2145. " somethingelse();\n"
  2146. "});",
  2147. getLLVMStyleWithColumns(40));
  2148. EXPECT_EQ("call(parameter, {\n"
  2149. " something();\n"
  2150. " // Comment too\n"
  2151. " // looooooooooong.\n"
  2152. " somethingElse();\n"
  2153. "});",
  2154. format("call(parameter, {\n"
  2155. " something();\n"
  2156. " // Comment too looooooooooong.\n"
  2157. " somethingElse();\n"
  2158. "});",
  2159. getLLVMStyleWithColumns(29)));
  2160. EXPECT_EQ("DEBUG({ int i; });", format("DEBUG({ int i; });"));
  2161. EXPECT_EQ("DEBUG({\n"
  2162. " int i;\n"
  2163. "\n"
  2164. " // comment\n"
  2165. " int j;\n"
  2166. "});",
  2167. format("DEBUG({\n"
  2168. " int i;\n"
  2169. "\n"
  2170. " // comment\n"
  2171. " int j;\n"
  2172. "});"));
  2173. }
  2174. TEST_F(FormatTest, PutEmptyBlocksIntoOneLine) {
  2175. EXPECT_EQ("{}", format("{}"));
  2176. verifyFormat("enum E {};");
  2177. verifyFormat("enum E {}");
  2178. }
  2179. //===----------------------------------------------------------------------===//
  2180. // Line break tests.
  2181. //===----------------------------------------------------------------------===//
  2182. TEST_F(FormatTest, PreventConfusingIndents) {
  2183. verifyFormat(
  2184. "SomeLongMethodName(SomeReallyLongMethod(CallOtherReallyLongMethod(\n"
  2185. " parameter, parameter, parameter)),\n"
  2186. " SecondLongCall(parameter));");
  2187. verifyFormat(
  2188. "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2189. " aaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2190. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n"
  2191. " aaaaaaaaaaaaaaaaaaaaaaaa);");
  2192. verifyFormat(
  2193. "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2194. " [aaaaaaaaaaaaaaaaaaaaaaaa\n"
  2195. " [aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa]\n"
  2196. " [aaaaaaaaaaaaaaaaaaaaaaaa]];");
  2197. verifyFormat(
  2198. "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa<\n"
  2199. " aaaaaaaaaaaaaaaaaaaaaaaa<\n"
  2200. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa>,\n"
  2201. " aaaaaaaaaaaaaaaaaaaaaaaa>;");
  2202. verifyFormat("int a = bbbb && ccc && fffff(\n"
  2203. "#define A Just forcing a new line\n"
  2204. " ddd);");
  2205. }
  2206. TEST_F(FormatTest, LineBreakingInBinaryExpressions) {
  2207. verifyFormat(
  2208. "bool aaaaaaa =\n"
  2209. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaa).aaaaaaaaaaaaaaaaaaa() ||\n"
  2210. " bbbbbbbb();");
  2211. verifyFormat("bool aaaaaaaaaaaaaaaaaaaaa =\n"
  2212. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa != bbbbbbbbbbbbbbbbbb &&\n"
  2213. " ccccccccc == ddddddddddd;");
  2214. verifyFormat("aaaaaa = aaaaaaa(aaaaaaa, // break\n"
  2215. " aaaaaa) &&\n"
  2216. " bbbbbb && cccccc;");
  2217. verifyFormat("aaaaaa = aaaaaaa(aaaaaaa, // break\n"
  2218. " aaaaaa) >>\n"
  2219. " bbbbbb;");
  2220. verifyFormat("Whitespaces.addUntouchableComment(\n"
  2221. " SourceMgr.getSpellingColumnNumber(\n"
  2222. " TheLine.Last->FormatTok.Tok.getLocation()) -\n"
  2223. " 1);");
  2224. verifyFormat("if ((aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
  2225. " bbbbbbbbbbbbbbbbbb) && // aaaaaaaaaaaaaaaa\n"
  2226. " cccccc) {\n}");
  2227. // If the LHS of a comparison is not a binary expression itself, the
  2228. // additional linebreak confuses many people.
  2229. verifyFormat(
  2230. "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2231. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) > 5) {\n"
  2232. "}");
  2233. verifyFormat(
  2234. "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2235. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) == 5) {\n"
  2236. "}");
  2237. verifyFormat(
  2238. "if (aaaaaaaaaaaaaaaaaaaaaaaaaa.aaaaaaaaaaaaaaaaaaaaaa(\n"
  2239. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) == 5) {\n"
  2240. "}");
  2241. // Even explicit parentheses stress the precedence enough to make the
  2242. // additional break unnecessary.
  2243. verifyFormat(
  2244. "if ((aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n"
  2245. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) == 5) {\n"
  2246. "}");
  2247. // This cases is borderline, but with the indentation it is still readable.
  2248. verifyFormat(
  2249. "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2250. " aaaaaaaaaaaaaaa) > aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n"
  2251. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n"
  2252. "}",
  2253. getLLVMStyleWithColumns(75));
  2254. // If the LHS is a binary expression, we should still use the additional break
  2255. // as otherwise the formatting hides the operator precedence.
  2256. verifyFormat(
  2257. "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n"
  2258. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n"
  2259. " 5) {\n"
  2260. "}");
  2261. FormatStyle OnePerLine = getLLVMStyle();
  2262. OnePerLine.BinPackParameters = false;
  2263. verifyFormat(
  2264. "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
  2265. " aaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
  2266. " aaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}",
  2267. OnePerLine);
  2268. }
  2269. TEST_F(FormatTest, ExpressionIndentation) {
  2270. verifyFormat("bool value = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n"
  2271. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n"
  2272. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n"
  2273. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n"
  2274. " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb +\n"
  2275. " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb &&\n"
  2276. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n"
  2277. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa >\n"
  2278. " ccccccccccccccccccccccccccccccccccccccccc;");
  2279. verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n"
  2280. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n"
  2281. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n"
  2282. " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}");
  2283. verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n"
  2284. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n"
  2285. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n"
  2286. " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}");
  2287. verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ==\n"
  2288. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *\n"
  2289. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa +\n"
  2290. " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}");
  2291. verifyFormat("if () {\n"
  2292. "} else if (aaaaa && bbbbb > // break\n"
  2293. " ccccc) {\n"
  2294. "}");
  2295. // Presence of a trailing comment used to change indentation of b.
  2296. verifyFormat("return aaaaaaaaaaaaaaaaaaa +\n"
  2297. " b;\n"
  2298. "return aaaaaaaaaaaaaaaaaaa +\n"
  2299. " b; //",
  2300. getLLVMStyleWithColumns(30));
  2301. }
  2302. TEST_F(FormatTest, ExpressionIndentationBreakingBeforeOperators) {
  2303. // Not sure what the best system is here. Like this, the LHS can be found
  2304. // immediately above an operator (everything with the same or a higher
  2305. // indent). The RHS is aligned right of the operator and so compasses
  2306. // everything until something with the same indent as the operator is found.
  2307. // FIXME: Is this a good system?
  2308. FormatStyle Style = getLLVMStyle();
  2309. Style.BreakBeforeBinaryOperators = true;
  2310. verifyFormat(
  2311. "bool value = aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2312. " + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2313. " + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2314. " == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2315. " * bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n"
  2316. " + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\n"
  2317. " && aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2318. " * aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2319. " > ccccccccccccccccccccccccccccccccccccccccc;",
  2320. Style);
  2321. verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2322. " * aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2323. " + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2324. " == bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}",
  2325. Style);
  2326. verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2327. " + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2328. " * aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2329. " == bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}",
  2330. Style);
  2331. verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2332. " == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2333. " * aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2334. " + bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb) {\n}",
  2335. Style);
  2336. verifyFormat("if () {\n"
  2337. "} else if (aaaaa && bbbbb // break\n"
  2338. " > ccccc) {\n"
  2339. "}",
  2340. Style);
  2341. }
  2342. TEST_F(FormatTest, ConstructorInitializers) {
  2343. verifyFormat("Constructor() : Initializer(FitsOnTheLine) {}");
  2344. verifyFormat("Constructor() : Inttializer(FitsOnTheLine) {}",
  2345. getLLVMStyleWithColumns(45));
  2346. verifyFormat("Constructor()\n"
  2347. " : Inttializer(FitsOnTheLine) {}",
  2348. getLLVMStyleWithColumns(44));
  2349. verifyFormat("Constructor()\n"
  2350. " : Inttializer(FitsOnTheLine) {}",
  2351. getLLVMStyleWithColumns(43));
  2352. verifyFormat(
  2353. "SomeClass::Constructor()\n"
  2354. " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaaaa(aaaaaaaaaaaa) {}");
  2355. verifyFormat(
  2356. "SomeClass::Constructor()\n"
  2357. " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n"
  2358. " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}");
  2359. verifyFormat(
  2360. "SomeClass::Constructor()\n"
  2361. " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n"
  2362. " aaaaaaaaaaaaaaa(aaaaaaaaaaaa) {}");
  2363. verifyFormat("Constructor()\n"
  2364. " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa),\n"
  2365. " aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  2366. " aaaaaaaaaaaaaaaaaaaaaaaaaaa),\n"
  2367. " aaaaaaaaaaaaaaaaaaaaaaa() {}");
  2368. verifyFormat("Constructor()\n"
  2369. " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2370. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}");
  2371. verifyFormat("Constructor(int Parameter = 0)\n"
  2372. " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaa),\n"
  2373. " aaaaaaaaaaaa(aaaaaaaaaaaaaaaaa) {}");
  2374. verifyFormat("Constructor()\n"
  2375. " : aaaaaaaaaaaaaaaaaaaa(a), bbbbbbbbbbbbbbbbbbbbbbbb(b) {\n"
  2376. "}",
  2377. getLLVMStyleWithColumns(60));
  2378. // Here a line could be saved by splitting the second initializer onto two
  2379. // lines, but that is not desireable.
  2380. verifyFormat("Constructor()\n"
  2381. " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaa),\n"
  2382. " aaaaaaaaaaa(aaaaaaaaaaa),\n"
  2383. " aaaaaaaaaaaaaaaaaaaaat(aaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}");
  2384. FormatStyle OnePerLine = getLLVMStyle();
  2385. OnePerLine.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
  2386. verifyFormat("SomeClass::Constructor()\n"
  2387. " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n"
  2388. " aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n"
  2389. " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}",
  2390. OnePerLine);
  2391. verifyFormat("SomeClass::Constructor()\n"
  2392. " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), // Some comment\n"
  2393. " aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n"
  2394. " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}",
  2395. OnePerLine);
  2396. verifyFormat("MyClass::MyClass(int var)\n"
  2397. " : some_var_(var), // 4 space indent\n"
  2398. " some_other_var_(var + 1) { // lined up\n"
  2399. "}",
  2400. OnePerLine);
  2401. verifyFormat("Constructor()\n"
  2402. " : aaaaa(aaaaaa),\n"
  2403. " aaaaa(aaaaaa),\n"
  2404. " aaaaa(aaaaaa),\n"
  2405. " aaaaa(aaaaaa),\n"
  2406. " aaaaa(aaaaaa) {}",
  2407. OnePerLine);
  2408. verifyFormat("Constructor()\n"
  2409. " : aaaaa(aaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaa,\n"
  2410. " aaaaaaaaaaaaaaaaaaaaaa) {}",
  2411. OnePerLine);
  2412. }
  2413. TEST_F(FormatTest, MemoizationTests) {
  2414. // This breaks if the memoization lookup does not take \c Indent and
  2415. // \c LastSpace into account.
  2416. verifyFormat(
  2417. "extern CFRunLoopTimerRef\n"
  2418. "CFRunLoopTimerCreate(CFAllocatorRef allocato, CFAbsoluteTime fireDate,\n"
  2419. " CFTimeInterval interval, CFOptionFlags flags,\n"
  2420. " CFIndex order, CFRunLoopTimerCallBack callout,\n"
  2421. " CFRunLoopTimerContext *context) {}");
  2422. // Deep nesting somewhat works around our memoization.
  2423. verifyFormat(
  2424. "aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(\n"
  2425. " aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(\n"
  2426. " aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(\n"
  2427. " aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(aaaaa(\n"
  2428. " aaaaa())))))))))))))))))))))))))))))))))))))));",
  2429. getLLVMStyleWithColumns(65));
  2430. verifyFormat(
  2431. "aaaaa(\n"
  2432. " aaaaa,\n"
  2433. " aaaaa(\n"
  2434. " aaaaa,\n"
  2435. " aaaaa(\n"
  2436. " aaaaa,\n"
  2437. " aaaaa(\n"
  2438. " aaaaa,\n"
  2439. " aaaaa(\n"
  2440. " aaaaa,\n"
  2441. " aaaaa(\n"
  2442. " aaaaa,\n"
  2443. " aaaaa(\n"
  2444. " aaaaa,\n"
  2445. " aaaaa(\n"
  2446. " aaaaa,\n"
  2447. " aaaaa(\n"
  2448. " aaaaa,\n"
  2449. " aaaaa(\n"
  2450. " aaaaa,\n"
  2451. " aaaaa(\n"
  2452. " aaaaa,\n"
  2453. " aaaaa(\n"
  2454. " aaaaa,\n"
  2455. " aaaaa))))))))))));",
  2456. getLLVMStyleWithColumns(65));
  2457. verifyFormat(
  2458. "a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(a(), a), a), a), a),\n"
  2459. " a),\n"
  2460. " a),\n"
  2461. " a),\n"
  2462. " a),\n"
  2463. " a),\n"
  2464. " a),\n"
  2465. " a),\n"
  2466. " a),\n"
  2467. " a),\n"
  2468. " a),\n"
  2469. " a),\n"
  2470. " a),\n"
  2471. " a),\n"
  2472. " a),\n"
  2473. " a),\n"
  2474. " a),\n"
  2475. " a)",
  2476. getLLVMStyleWithColumns(65));
  2477. // This test takes VERY long when memoization is broken.
  2478. FormatStyle OnePerLine = getLLVMStyle();
  2479. OnePerLine.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
  2480. OnePerLine.BinPackParameters = false;
  2481. std::string input = "Constructor()\n"
  2482. " : aaaa(a,\n";
  2483. for (unsigned i = 0, e = 80; i != e; ++i) {
  2484. input += " a,\n";
  2485. }
  2486. input += " a) {}";
  2487. verifyFormat(input, OnePerLine);
  2488. }
  2489. TEST_F(FormatTest, BreaksAsHighAsPossible) {
  2490. verifyFormat(
  2491. "void f() {\n"
  2492. " if ((aaaaaaaaaaaaaaaaaaaaaaaaaaaaa && aaaaaaaaaaaaaaaaaaaaaaaaaa) ||\n"
  2493. " (bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb && bbbbbbbbbbbbbbbbbbbbbbbbbb))\n"
  2494. " f();\n"
  2495. "}");
  2496. verifyFormat("if (Intervals[i].getRange().getFirst() <\n"
  2497. " Intervals[i - 1].getRange().getLast()) {\n}");
  2498. }
  2499. TEST_F(FormatTest, BreaksFunctionDeclarations) {
  2500. // Principially, we break function declarations in a certain order:
  2501. // 1) break amongst arguments.
  2502. verifyFormat("Aaaaaaaaaaaaaa bbbbbbbbbbbbbb(Cccccccccccccc cccccccccccccc,\n"
  2503. " Cccccccccccccc cccccccccccccc);");
  2504. verifyFormat(
  2505. "template <class TemplateIt>\n"
  2506. "SomeReturnType SomeFunction(TemplateIt begin, TemplateIt end,\n"
  2507. " TemplateIt *stop) {}");
  2508. // 2) break after return type.
  2509. verifyFormat(
  2510. "Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2511. " bbbbbbbbbbbbbb(Cccccccccccccc cccccccccccccccccccccccccc);",
  2512. getGoogleStyle());
  2513. // 3) break after (.
  2514. verifyFormat(
  2515. "Aaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbbbbbbb(\n"
  2516. " Cccccccccccccccccccccccccccccc cccccccccccccccccccccccccccccccc);",
  2517. getGoogleStyle());
  2518. // 4) break before after nested name specifiers.
  2519. verifyFormat(
  2520. "Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2521. " SomeClasssssssssssssssssssssssssssssssssssssss::\n"
  2522. " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(Cccccccccccccc cccccccccc);",
  2523. getGoogleStyle());
  2524. // However, there are exceptions, if a sufficient amount of lines can be
  2525. // saved.
  2526. // FIXME: The precise cut-offs wrt. the number of saved lines might need some
  2527. // more adjusting.
  2528. verifyFormat("Aaaaaaaaaaaaaaaaaa bbbbbbbbbbbbbb(Cccccccccccccc cccccccccc,\n"
  2529. " Cccccccccccccc cccccccccc,\n"
  2530. " Cccccccccccccc cccccccccc,\n"
  2531. " Cccccccccccccc cccccccccc,\n"
  2532. " Cccccccccccccc cccccccccc);");
  2533. verifyFormat(
  2534. "Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2535. " bbbbbbbbbbb(Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n"
  2536. " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n"
  2537. " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc);",
  2538. getGoogleStyle());
  2539. verifyFormat(
  2540. "Aaaaaaaaaa bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(Cccccccccccccc cccccccccc,\n"
  2541. " Cccccccccccccc cccccccccc,\n"
  2542. " Cccccccccccccc cccccccccc,\n"
  2543. " Cccccccccccccc cccccccccc,\n"
  2544. " Cccccccccccccc cccccccccc,\n"
  2545. " Cccccccccccccc cccccccccc,\n"
  2546. " Cccccccccccccc cccccccccc);");
  2547. verifyFormat("Aaaaaaaaaa bbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(\n"
  2548. " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n"
  2549. " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n"
  2550. " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc,\n"
  2551. " Cccccccccccccc cccccccccc, Cccccccccccccc cccccccccc);");
  2552. // Break after multi-line parameters.
  2553. verifyFormat("void aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2554. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2555. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  2556. " bbbb bbbb);");
  2557. // Treat overloaded operators like other functions.
  2558. verifyFormat("SomeLoooooooooooooooooooooooooogType\n"
  2559. "operator>(const SomeLoooooooooooooooooooooooooogType &other);");
  2560. verifyFormat("SomeLoooooooooooooooooooooooooogType\n"
  2561. "operator>>(const SomeLooooooooooooooooooooooooogType &other);");
  2562. verifyGoogleFormat(
  2563. "SomeLoooooooooooooooooooooooooooooogType operator<<(\n"
  2564. " const SomeLooooooooogType &a, const SomeLooooooooogType &b);");
  2565. }
  2566. TEST_F(FormatTest, TrailingReturnType) {
  2567. verifyFormat("auto foo() -> int;\n");
  2568. verifyFormat("struct S {\n"
  2569. " auto bar() const -> int;\n"
  2570. "};");
  2571. verifyFormat("template <size_t Order, typename T>\n"
  2572. "auto load_img(const std::string &filename)\n"
  2573. " -> alias::tensor<Order, T, mem::tag::cpu> {}");
  2574. // Not trailing return types.
  2575. verifyFormat("void f() { auto a = b->c(); }");
  2576. }
  2577. TEST_F(FormatTest, BreaksFunctionDeclarationsWithTrailingTokens) {
  2578. // Avoid breaking before trailing 'const'.
  2579. verifyFormat("void someLongFunction(\n"
  2580. " int someLongParameter) const {}",
  2581. getLLVMStyleWithColumns(46));
  2582. FormatStyle Style = getGoogleStyle();
  2583. Style.ColumnLimit = 47;
  2584. verifyFormat("void\n"
  2585. "someLongFunction(int someLongParameter) const {\n}",
  2586. getLLVMStyleWithColumns(47));
  2587. verifyFormat("void someLongFunction(\n"
  2588. " int someLongParameter) const {}",
  2589. Style);
  2590. verifyFormat("LoooooongReturnType\n"
  2591. "someLoooooooongFunction() const {}",
  2592. getLLVMStyleWithColumns(47));
  2593. verifyFormat("LoooooongReturnType someLoooooooongFunction()\n"
  2594. " const {}",
  2595. Style);
  2596. // Avoid breaking before other trailing annotations, if they are not
  2597. // function-like.
  2598. verifyFormat("void SomeFunction(aaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  2599. " aaaaaaaaaaaaaaaaaaaaaaaaaa) OVERRIDE;");
  2600. verifyFormat("void SomeFunction(aaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  2601. " aaaaaaaaaaaaaaaaaaaaaaaaaa) OVERRIDE FINAL;");
  2602. verifyFormat("void SomeFunction(aaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  2603. " aaaaaaaaaaaaaaaaaaaaaaaaaa) override final;");
  2604. // Breaking before function-like trailing annotations is fine to keep them
  2605. // close to their arguments.
  2606. verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n"
  2607. " LOCKS_EXCLUDED(aaaaaaaaaaaaa);");
  2608. verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) const\n"
  2609. " LOCKS_EXCLUDED(aaaaaaaaaaaaa);");
  2610. verifyFormat("void aaaaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) const\n"
  2611. " LOCKS_EXCLUDED(aaaaaaaaaaaaa) {}");
  2612. verifyFormat(
  2613. "void aaaaaaaaaaaaaaaaaa()\n"
  2614. " __attribute__((aaaaaaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaa,\n"
  2615. " aaaaaaaaaaaaaaaaaaaaaaaaa));");
  2616. verifyFormat("bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2617. " __attribute__((unused));");
  2618. verifyFormat(
  2619. "bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2620. " GUARDED_BY(aaaaaaaaaaaa);",
  2621. getGoogleStyle());
  2622. verifyFormat(
  2623. "bool aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2624. " GUARDED_BY(aaaaaaaaaaaa);",
  2625. getGoogleStyle());
  2626. }
  2627. TEST_F(FormatTest, BreaksDesireably) {
  2628. verifyFormat("if (aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa) ||\n"
  2629. " aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa) ||\n"
  2630. " aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaa)) {\n}");
  2631. verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2632. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)) {\n"
  2633. "}");
  2634. verifyFormat(
  2635. "aaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  2636. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {}");
  2637. verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2638. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2639. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa));");
  2640. verifyFormat(
  2641. "aaaaaaaa(aaaaaaaaaaaaa, aaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2642. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)),\n"
  2643. " aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2644. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)));");
  2645. verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
  2646. " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
  2647. verifyFormat(
  2648. "void f() {\n"
  2649. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa &&\n"
  2650. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);\n"
  2651. "}");
  2652. verifyFormat(
  2653. "aaaaaa(new Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2654. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa));");
  2655. verifyFormat(
  2656. "aaaaaa(aaa, new Aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2657. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa));");
  2658. verifyFormat(
  2659. "aaaaaaaaaaaaaaaaa(\n"
  2660. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  2661. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
  2662. // Indent consistently indenpendent of call expression.
  2663. verifyFormat("aaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbb.ccccccccccccccccc(\n"
  2664. " dddddddddddddddddddddddddddddd));\n"
  2665. "aaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(\n"
  2666. " dddddddddddddddddddddddddddddd));");
  2667. // This test case breaks on an incorrect memoization, i.e. an optimization not
  2668. // taking into account the StopAt value.
  2669. verifyFormat(
  2670. "return aaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaa ||\n"
  2671. " aaaaaaaaaaa(aaaaaaaaa) || aaaaaaaaaaaaaaaaaaaaaaa ||\n"
  2672. " aaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaa ||\n"
  2673. " (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
  2674. verifyFormat("{\n {\n {\n"
  2675. " Annotation.SpaceRequiredBefore =\n"
  2676. " Line.Tokens[i - 1].Tok.isNot(tok::l_paren) &&\n"
  2677. " Line.Tokens[i - 1].Tok.isNot(tok::l_square);\n"
  2678. " }\n }\n}");
  2679. // Break on an outer level if there was a break on an inner level.
  2680. EXPECT_EQ("f(g(h(a, // comment\n"
  2681. " b, c),\n"
  2682. " d, e),\n"
  2683. " x, y);",
  2684. format("f(g(h(a, // comment\n"
  2685. " b, c), d, e), x, y);"));
  2686. // Prefer breaking similar line breaks.
  2687. verifyFormat(
  2688. "const int kTrackingOptions = NSTrackingMouseMoved |\n"
  2689. " NSTrackingMouseEnteredAndExited |\n"
  2690. " NSTrackingActiveAlways;");
  2691. }
  2692. TEST_F(FormatTest, FormatsOneParameterPerLineIfNecessary) {
  2693. FormatStyle NoBinPacking = getGoogleStyle();
  2694. NoBinPacking.BinPackParameters = false;
  2695. verifyFormat("f(aaaaaaaaaaaaaaaaaaaa,\n"
  2696. " aaaaaaaaaaaaaaaaaaaa,\n"
  2697. " aaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaa);",
  2698. NoBinPacking);
  2699. verifyFormat("aaaaaaa(aaaaaaaaaaaaa,\n"
  2700. " aaaaaaaaaaaaa,\n"
  2701. " aaaaaaaaaaaaa(aaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaa));",
  2702. NoBinPacking);
  2703. verifyFormat(
  2704. "aaaaaaaa(aaaaaaaaaaaaa,\n"
  2705. " aaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2706. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)),\n"
  2707. " aaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2708. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)));",
  2709. NoBinPacking);
  2710. verifyFormat("aaaaaaaaaaaaaaa(aaaaaaaaa, aaaaaaaaa, aaaaaaaaaaaaaaaaaaaaa)\n"
  2711. " .aaaaaaaaaaaaaaaaaa();",
  2712. NoBinPacking);
  2713. verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2714. " aaaaaaaaaa, aaaaaaaaaa, aaaaaaaaaa, aaaaaaaaaaa);",
  2715. NoBinPacking);
  2716. verifyFormat(
  2717. "aaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  2718. " aaaaaaaaaaaa,\n"
  2719. " aaaaaaaaaaaa);",
  2720. NoBinPacking);
  2721. verifyFormat(
  2722. "somefunction(someotherFunction(ddddddddddddddddddddddddddddddddddd,\n"
  2723. " ddddddddddddddddddddddddddddd),\n"
  2724. " test);",
  2725. NoBinPacking);
  2726. verifyFormat("std::vector<aaaaaaaaaaaaaaaaaaaaaaa,\n"
  2727. " aaaaaaaaaaaaaaaaaaaaaaa,\n"
  2728. " aaaaaaaaaaaaaaaaaaaaaaa> aaaaaaaaaaaaaaaaaa;",
  2729. NoBinPacking);
  2730. verifyFormat("a(\"a\"\n"
  2731. " \"a\",\n"
  2732. " a);");
  2733. NoBinPacking.AllowAllParametersOfDeclarationOnNextLine = false;
  2734. verifyFormat("void aaaaaaaaaa(aaaaaaaaa,\n"
  2735. " aaaaaaaaa,\n"
  2736. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);",
  2737. NoBinPacking);
  2738. verifyFormat(
  2739. "void f() {\n"
  2740. " aaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaa, aaaaaaaaa, aaaaaaaaaaaaaaaaaaaaa)\n"
  2741. " .aaaaaaa();\n"
  2742. "}",
  2743. NoBinPacking);
  2744. verifyFormat(
  2745. "template <class SomeType, class SomeOtherType>\n"
  2746. "SomeType SomeFunction(SomeType Type, SomeOtherType OtherType) {}",
  2747. NoBinPacking);
  2748. }
  2749. TEST_F(FormatTest, AdaptiveOnePerLineFormatting) {
  2750. FormatStyle Style = getLLVMStyleWithColumns(15);
  2751. Style.ExperimentalAutoDetectBinPacking = true;
  2752. EXPECT_EQ("aaa(aaaa,\n"
  2753. " aaaa,\n"
  2754. " aaaa);\n"
  2755. "aaa(aaaa,\n"
  2756. " aaaa,\n"
  2757. " aaaa);",
  2758. format("aaa(aaaa,\n" // one-per-line
  2759. " aaaa,\n"
  2760. " aaaa );\n"
  2761. "aaa(aaaa, aaaa, aaaa);", // inconclusive
  2762. Style));
  2763. EXPECT_EQ("aaa(aaaa, aaaa,\n"
  2764. " aaaa);\n"
  2765. "aaa(aaaa, aaaa,\n"
  2766. " aaaa);",
  2767. format("aaa(aaaa, aaaa,\n" // bin-packed
  2768. " aaaa );\n"
  2769. "aaa(aaaa, aaaa, aaaa);", // inconclusive
  2770. Style));
  2771. }
  2772. TEST_F(FormatTest, FormatsBuilderPattern) {
  2773. verifyFormat(
  2774. "return llvm::StringSwitch<Reference::Kind>(name)\n"
  2775. " .StartsWith(\".eh_frame_hdr\", ORDER_EH_FRAMEHDR)\n"
  2776. " .StartsWith(\".eh_frame\", ORDER_EH_FRAME)\n"
  2777. " .StartsWith(\".init\", ORDER_INIT)\n"
  2778. " .StartsWith(\".fini\", ORDER_FINI)\n"
  2779. " .StartsWith(\".hash\", ORDER_HASH)\n"
  2780. " .Default(ORDER_TEXT);\n");
  2781. verifyFormat("return aaaaaaaaaaaaaaaaa->aaaaa().aaaaaaaaaaaaa().aaaaaa() <\n"
  2782. " aaaaaaaaaaaaaaa->aaaaa().aaaaaaaaaaaaa().aaaaaa();");
  2783. verifyFormat(
  2784. "aaaaaaa->aaaaaaa->aaaaaaaaaaaaaaaa(\n"
  2785. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n"
  2786. " ->aaaaaaaa(aaaaaaaaaaaaaaa);");
  2787. verifyFormat(
  2788. "aaaaaaaaaaaaaaaaaaa()->aaaaaa(bbbbb)->aaaaaaaaaaaaaaaaaaa( // break\n"
  2789. " aaaaaaaaaaaaaa);");
  2790. verifyFormat(
  2791. "aaaaaaaaaaaaaaaaaaaaaaa *aaaaaaaaa =\n"
  2792. " aaaaaa->aaaaaaaaaaaa()\n"
  2793. " ->aaaaaaaaaaaaaaaa(\n"
  2794. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n"
  2795. " ->aaaaaaaaaaaaaaaaa();");
  2796. verifyFormat(
  2797. "someobj->Add((new util::filetools::Handler(dir))\n"
  2798. " ->OnEvent1(NewPermanentCallback(\n"
  2799. " this, &HandlerHolderClass::EventHandlerCBA))\n"
  2800. " ->OnEvent2(NewPermanentCallback(\n"
  2801. " this, &HandlerHolderClass::EventHandlerCBB))\n"
  2802. " ->OnEvent3(NewPermanentCallback(\n"
  2803. " this, &HandlerHolderClass::EventHandlerCBC))\n"
  2804. " ->OnEvent5(NewPermanentCallback(\n"
  2805. " this, &HandlerHolderClass::EventHandlerCBD))\n"
  2806. " ->OnEvent6(NewPermanentCallback(\n"
  2807. " this, &HandlerHolderClass::EventHandlerCBE)));");
  2808. verifyFormat(
  2809. "aaaaaaaaaaa().aaaaaaaaaaa().aaaaaaaaaaa().aaaaaaaaaaa().aaaaaaaaaaa();");
  2810. verifyFormat("aaaaaaaaaaaaaaa()\n"
  2811. " .aaaaaaaaaaaaaaa()\n"
  2812. " .aaaaaaaaaaaaaaa()\n"
  2813. " .aaaaaaaaaaaaaaa()\n"
  2814. " .aaaaaaaaaaaaaaa();");
  2815. verifyFormat("aaaaaaaaaaaaaaa.aaaaaaaaaaaaaaa()\n"
  2816. " .aaaaaaaaaaaaaaa()\n"
  2817. " .aaaaaaaaaaaaaaa()\n"
  2818. " .aaaaaaaaaaaaaaa();");
  2819. verifyFormat("aaaaaaaaaaaaaaa.aaaaaaaaaaaaaaa()\n"
  2820. " .aaaaaaaaaaaaaaa.aaaaaaaaaaaaaaa()\n"
  2821. " .aaaaaaaaaaaaaaa();");
  2822. verifyFormat("aaaaaaaaaaaaa->aaaaaaaaaaaaaaaaaaaaaaaa()\n"
  2823. " ->aaaaaaaaaaaaaae(0)\n"
  2824. " ->aaaaaaaaaaaaaaa();");
  2825. // Prefer not to break after empty parentheses.
  2826. verifyFormat("FirstToken->WhitespaceRange.getBegin().getLocWithOffset(\n"
  2827. " First->LastNewlineOffset);");
  2828. }
  2829. TEST_F(FormatTest, BreaksAccordingToOperatorPrecedence) {
  2830. verifyFormat(
  2831. "if (aaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
  2832. " bbbbbbbbbbbbbbbbbbbbbbbbb && ccccccccccccccccccccccccc) {\n}");
  2833. verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaa && bbbbbbbbbbbbbbbbbbbbbbbbb ||\n"
  2834. " ccccccccccccccccccccccccc) {\n}");
  2835. verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaa || bbbbbbbbbbbbbbbbbbbbbbbbb ||\n"
  2836. " ccccccccccccccccccccccccc) {\n}");
  2837. verifyFormat(
  2838. "if ((aaaaaaaaaaaaaaaaaaaaaaaaa || bbbbbbbbbbbbbbbbbbbbbbbbb) &&\n"
  2839. " ccccccccccccccccccccccccc) {\n}");
  2840. verifyFormat("return aaaa & AAAAAAAAAAAAAAAAAAAAAAAAAAAAA ||\n"
  2841. " bbbb & BBBBBBBBBBBBBBBBBBBBBBBBBBBBB ||\n"
  2842. " cccc & CCCCCCCCCCCCCCCCCCCCCCCCCC ||\n"
  2843. " dddd & DDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDDD;");
  2844. verifyFormat("if ((aaaaaaaaaa != aaaaaaaaaaaaaaa ||\n"
  2845. " aaaaaaaaaaaaaaaaaaaaaaaa() >= aaaaaaaaaaaaaaaaaaaa) &&\n"
  2846. " aaaaaaaaaaaaaaa != aa) {\n}");
  2847. }
  2848. TEST_F(FormatTest, BreaksAfterAssignments) {
  2849. verifyFormat(
  2850. "unsigned Cost =\n"
  2851. " TTI.getMemoryOpCost(I->getOpcode(), VectorTy, SI->getAlignment(),\n"
  2852. " SI->getPointerAddressSpaceee());\n");
  2853. verifyFormat(
  2854. "CharSourceRange LineRange = CharSourceRange::getTokenRange(\n"
  2855. " Line.Tokens.front().Tok.getLo(), Line.Tokens.back().Tok.getLoc());");
  2856. verifyFormat(
  2857. "aaaaaaaaaaaaaaaaaaaaaaaaaa aaaa = aaaaaaaaaaaaaa(0).aaaa().aaaaaaaaa(\n"
  2858. " aaaaaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaaaaaaa);");
  2859. verifyFormat("unsigned OriginalStartColumn =\n"
  2860. " SourceMgr.getSpellingColumnNumber(\n"
  2861. " Current.FormatTok.getStartOfNonWhitespace()) -\n"
  2862. " 1;");
  2863. }
  2864. TEST_F(FormatTest, AlignsAfterAssignments) {
  2865. verifyFormat(
  2866. "int Result = aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
  2867. " aaaaaaaaaaaaaaaaaaaaaaaaa;");
  2868. verifyFormat(
  2869. "Result += aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
  2870. " aaaaaaaaaaaaaaaaaaaaaaaaa;");
  2871. verifyFormat(
  2872. "Result >>= aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
  2873. " aaaaaaaaaaaaaaaaaaaaaaaaa;");
  2874. verifyFormat(
  2875. "int Result = (aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
  2876. " aaaaaaaaaaaaaaaaaaaaaaaaa);");
  2877. verifyFormat(
  2878. "double LooooooooooooooooooooooooongResult = aaaaaaaaaaaaaaaaaaaaaaaa +\n"
  2879. " aaaaaaaaaaaaaaaaaaaaaaaa +\n"
  2880. " aaaaaaaaaaaaaaaaaaaaaaaa;");
  2881. }
  2882. TEST_F(FormatTest, AlignsAfterReturn) {
  2883. verifyFormat(
  2884. "return aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
  2885. " aaaaaaaaaaaaaaaaaaaaaaaaa;");
  2886. verifyFormat(
  2887. "return (aaaaaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaa +\n"
  2888. " aaaaaaaaaaaaaaaaaaaaaaaaa);");
  2889. verifyFormat(
  2890. "return aaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa >=\n"
  2891. " aaaaaaaaaaaaaaaaaaaaaa();");
  2892. verifyFormat(
  2893. "return (aaaaaaaaaaaaaaaaaaaaaa + aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa >=\n"
  2894. " aaaaaaaaaaaaaaaaaaaaaa());");
  2895. verifyFormat("return aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2896. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
  2897. verifyFormat("return aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2898. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) &&\n"
  2899. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
  2900. verifyFormat("return\n"
  2901. " // true if code is one of a or b.\n"
  2902. " code == a || code == b;");
  2903. }
  2904. TEST_F(FormatTest, BreaksConditionalExpressions) {
  2905. verifyFormat(
  2906. "aaaa(aaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2907. " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2908. " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
  2909. verifyFormat(
  2910. "aaaa(aaaaaaaaaaaaaaaaaaaa, aaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2911. " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
  2912. verifyFormat(
  2913. "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaa ? aaaa(aaaaaa)\n"
  2914. " : aaaaaaaaaaaaa);");
  2915. verifyFormat(
  2916. "aaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  2917. " aaaaaaaaaaaaaaaa ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2918. " : aaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  2919. " aaaaaaaaaaaaa);");
  2920. verifyFormat(
  2921. "aaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  2922. " aaaaaaaaaaaaaaaa ?: aaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  2923. " aaaaaaaaaaaaa);");
  2924. verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2925. " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2926. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n"
  2927. " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2928. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
  2929. verifyFormat("aaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  2930. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2931. " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2932. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n"
  2933. " : aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2934. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n"
  2935. " aaaaaaaaaaaaaaaaaaaaaaaaaaa);");
  2936. verifyFormat("aaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  2937. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2938. " ?: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  2939. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa),\n"
  2940. " aaaaaaaaaaaaaaaaaaaaaaaaaaa);");
  2941. verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2942. " ? aaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2943. " : aaaaaaaaaaaaaaaaaaaaaaaaaaa;");
  2944. verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaa =\n"
  2945. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2946. " ? aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2947. " : aaaaaaaaaaaaaaaa;");
  2948. verifyFormat(
  2949. "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2950. " ? aaaaaaaaaaaaaaa\n"
  2951. " : aaaaaaaaaaaaaaa;");
  2952. verifyFormat("f(aaaaaaaaaaaaaaaa == // force break\n"
  2953. " aaaaaaaaa\n"
  2954. " ? b\n"
  2955. " : c);");
  2956. verifyFormat(
  2957. "unsigned Indent =\n"
  2958. " format(TheLine.First, IndentForLevel[TheLine.Level] >= 0\n"
  2959. " ? IndentForLevel[TheLine.Level]\n"
  2960. " : TheLine * 2,\n"
  2961. " TheLine.InPPDirective, PreviousEndOfLineColumn);",
  2962. getLLVMStyleWithColumns(70));
  2963. verifyFormat("bool aaaaaa = aaaaaaaaaaaaa //\n"
  2964. " ? aaaaaaaaaaaaaaa\n"
  2965. " : bbbbbbbbbbbbbbb //\n"
  2966. " ? ccccccccccccccc\n"
  2967. " : ddddddddddddddd;");
  2968. verifyFormat("bool aaaaaa = aaaaaaaaaaaaa //\n"
  2969. " ? aaaaaaaaaaaaaaa\n"
  2970. " : (bbbbbbbbbbbbbbb //\n"
  2971. " ? ccccccccccccccc\n"
  2972. " : ddddddddddddddd);");
  2973. FormatStyle NoBinPacking = getLLVMStyle();
  2974. NoBinPacking.BinPackParameters = false;
  2975. verifyFormat(
  2976. "void f() {\n"
  2977. " g(aaa,\n"
  2978. " aaaaaaaaaa == aaaaaaaaaa ? aaaa : aaaaa,\n"
  2979. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2980. " ? aaaaaaaaaaaaaaa\n"
  2981. " : aaaaaaaaaaaaaaa);\n"
  2982. "}",
  2983. NoBinPacking);
  2984. verifyFormat(
  2985. "void f() {\n"
  2986. " g(aaa,\n"
  2987. " aaaaaaaaaa == aaaaaaaaaa ? aaaa : aaaaa,\n"
  2988. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa == aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  2989. " ?: aaaaaaaaaaaaaaa);\n"
  2990. "}",
  2991. NoBinPacking);
  2992. }
  2993. TEST_F(FormatTest, DeclarationsOfMultipleVariables) {
  2994. verifyFormat("bool aaaaaaaaaaaaaaaaa = aaaaaa->aaaaaaaaaaaaaaaaa(),\n"
  2995. " aaaaaaaaaaa = aaaaaa->aaaaaaaaaaa();");
  2996. verifyFormat("bool a = true, b = false;");
  2997. verifyFormat("bool aaaaaaaaaaaaaaaaaaaaaaaaa =\n"
  2998. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaa),\n"
  2999. " bbbbbbbbbbbbbbbbbbbbbbbbb =\n"
  3000. " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb(bbbbbbbbbbbbbbbb);");
  3001. verifyFormat(
  3002. "bool aaaaaaaaaaaaaaaaaaaaa =\n"
  3003. " bbbbbbbbbbbbbbbbbbbbbbbbbbbb && cccccccccccccccccccccccccccc,\n"
  3004. " d = e && f;");
  3005. verifyFormat("aaaaaaaaa a = aaaaaaaaaaaaaaaaaaaa, b = bbbbbbbbbbbbbbbbbbbb,\n"
  3006. " c = cccccccccccccccccccc, d = dddddddddddddddddddd;");
  3007. verifyFormat("aaaaaaaaa *a = aaaaaaaaaaaaaaaaaaa, *b = bbbbbbbbbbbbbbbbbbb,\n"
  3008. " *c = ccccccccccccccccccc, *d = ddddddddddddddddddd;");
  3009. verifyFormat("aaaaaaaaa ***a = aaaaaaaaaaaaaaaaaaa, ***b = bbbbbbbbbbbbbbb,\n"
  3010. " ***c = ccccccccccccccccccc, ***d = ddddddddddddddd;");
  3011. // FIXME: If multiple variables are defined, the "*" needs to move to the new
  3012. // line. Also fix indent for breaking after the type, this looks bad.
  3013. verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa*\n"
  3014. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa = aaaaaaaaaaaaaaaaaaa,\n"
  3015. " *b = bbbbbbbbbbbbbbbbbbb;",
  3016. getGoogleStyle());
  3017. // Not ideal, but pointer-with-type does not allow much here.
  3018. verifyGoogleFormat(
  3019. "aaaaaaaaa* a = aaaaaaaaaaaaaaaaaaa, *b = bbbbbbbbbbbbbbbbbbb,\n"
  3020. " *b = bbbbbbbbbbbbbbbbbbb, *d = ddddddddddddddddddd;");
  3021. }
  3022. TEST_F(FormatTest, ConditionalExpressionsInBrackets) {
  3023. verifyFormat("arr[foo ? bar : baz];");
  3024. verifyFormat("f()[foo ? bar : baz];");
  3025. verifyFormat("(a + b)[foo ? bar : baz];");
  3026. verifyFormat("arr[foo ? (4 > 5 ? 4 : 5) : 5 < 5 ? 5 : 7];");
  3027. }
  3028. TEST_F(FormatTest, AlignsStringLiterals) {
  3029. verifyFormat("loooooooooooooooooooooooooongFunction(\"short literal \"\n"
  3030. " \"short literal\");");
  3031. verifyFormat(
  3032. "looooooooooooooooooooooooongFunction(\n"
  3033. " \"short literal\"\n"
  3034. " \"looooooooooooooooooooooooooooooooooooooooooooooooong literal\");");
  3035. verifyFormat("someFunction(\"Always break between multi-line\"\n"
  3036. " \" string literals\",\n"
  3037. " and, other, parameters);");
  3038. EXPECT_EQ("fun + \"1243\" /* comment */\n"
  3039. " \"5678\";",
  3040. format("fun + \"1243\" /* comment */\n"
  3041. " \"5678\";",
  3042. getLLVMStyleWithColumns(28)));
  3043. EXPECT_EQ(
  3044. "aaaaaa = \"aaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaaaa \"\n"
  3045. " \"aaaaaaaaaaaaaaaaaaaaa\"\n"
  3046. " \"aaaaaaaaaaaaaaaa\";",
  3047. format("aaaaaa ="
  3048. "\"aaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaaaaaaaa "
  3049. "aaaaaaaaaaaaaaaaaaaaa\" "
  3050. "\"aaaaaaaaaaaaaaaa\";"));
  3051. verifyFormat("a = a + \"a\"\n"
  3052. " \"a\"\n"
  3053. " \"a\";");
  3054. verifyFormat("f(\"a\", \"b\"\n"
  3055. " \"c\");");
  3056. verifyFormat(
  3057. "#define LL_FORMAT \"ll\"\n"
  3058. "printf(\"aaaaa: %d, bbbbbb: %\" LL_FORMAT \"d, cccccccc: %\" LL_FORMAT\n"
  3059. " \"d, ddddddddd: %\" LL_FORMAT \"d\");");
  3060. verifyFormat("#define A(X) \\\n"
  3061. " \"aaaaa\" #X \"bbbbbb\" \\\n"
  3062. " \"ccccc\"",
  3063. getLLVMStyleWithColumns(23));
  3064. verifyFormat("#define A \"def\"\n"
  3065. "f(\"abc\" A \"ghi\"\n"
  3066. " \"jkl\");");
  3067. }
  3068. TEST_F(FormatTest, AlwaysBreakBeforeMultilineStrings) {
  3069. FormatStyle NoBreak = getLLVMStyle();
  3070. NoBreak.AlwaysBreakBeforeMultilineStrings = false;
  3071. FormatStyle Break = getLLVMStyle();
  3072. Break.AlwaysBreakBeforeMultilineStrings = true;
  3073. verifyFormat("aaaa = \"bbbb\"\n"
  3074. " \"cccc\";",
  3075. NoBreak);
  3076. verifyFormat("aaaa =\n"
  3077. " \"bbbb\"\n"
  3078. " \"cccc\";",
  3079. Break);
  3080. verifyFormat("aaaa(\"bbbb\"\n"
  3081. " \"cccc\");",
  3082. NoBreak);
  3083. verifyFormat("aaaa(\n"
  3084. " \"bbbb\"\n"
  3085. " \"cccc\");",
  3086. Break);
  3087. verifyFormat("aaaa(qqq, \"bbbb\"\n"
  3088. " \"cccc\");",
  3089. NoBreak);
  3090. verifyFormat("aaaa(qqq,\n"
  3091. " \"bbbb\"\n"
  3092. " \"cccc\");",
  3093. Break);
  3094. // Don't break if there is no column gain.
  3095. verifyFormat("f(\"aaaa\"\n"
  3096. " \"bbbb\");",
  3097. Break);
  3098. // Treat literals with escaped newlines like multi-line string literals.
  3099. EXPECT_EQ("x = \"a\\\n"
  3100. "b\\\n"
  3101. "c\";",
  3102. format("x = \"a\\\n"
  3103. "b\\\n"
  3104. "c\";",
  3105. NoBreak));
  3106. EXPECT_EQ("x =\n"
  3107. " \"a\\\n"
  3108. "b\\\n"
  3109. "c\";",
  3110. format("x = \"a\\\n"
  3111. "b\\\n"
  3112. "c\";",
  3113. Break));
  3114. }
  3115. TEST_F(FormatTest, AlignsPipes) {
  3116. verifyFormat(
  3117. "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3118. " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3119. " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
  3120. verifyFormat(
  3121. "aaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaa\n"
  3122. " << aaaaaaaaaaaaaaaaaaaa;");
  3123. verifyFormat(
  3124. "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3125. " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
  3126. verifyFormat(
  3127. "llvm::outs() << \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"\n"
  3128. " \"bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb\"\n"
  3129. " << \"ccccccccccccccccccccccccccccccccccccccccccccccccc\";");
  3130. verifyFormat(
  3131. "aaaaaaaa << (aaaaaaaaaaaaaaaaaaa << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3132. " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n"
  3133. " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
  3134. verifyFormat("return out << \"somepacket = {\\n\"\n"
  3135. " << \" aaaaaa = \" << pkt.aaaaaa << \"\\n\"\n"
  3136. " << \" bbbb = \" << pkt.bbbb << \"\\n\"\n"
  3137. " << \" cccccc = \" << pkt.cccccc << \"\\n\"\n"
  3138. " << \" ddd = [\" << pkt.ddd << \"]\\n\"\n"
  3139. " << \"}\";");
  3140. verifyFormat("llvm::outs() << \"aaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaa\n"
  3141. " << \"aaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaa\n"
  3142. " << \"aaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaa;");
  3143. verifyFormat(
  3144. "llvm::outs() << \"aaaaaaaaaaaaaaaaa = \" << aaaaaaaaaaaaaaaaa\n"
  3145. " << \"bbbbbbbbbbbbbbbbb = \" << bbbbbbbbbbbbbbbbb\n"
  3146. " << \"ccccccccccccccccc = \" << ccccccccccccccccc\n"
  3147. " << \"ddddddddddddddddd = \" << ddddddddddddddddd\n"
  3148. " << \"eeeeeeeeeeeeeeeee = \" << eeeeeeeeeeeeeeeee;");
  3149. verifyFormat("llvm::outs() << aaaaaaaaaaaaaaaaaaaaaaaa << \"=\"\n"
  3150. " << bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;");
  3151. verifyFormat(
  3152. "void f() {\n"
  3153. " llvm::outs() << \"aaaaaaaaaaaaaaaaaaaa: \"\n"
  3154. " << aaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaa);\n"
  3155. "}");
  3156. // Breaking before the first "<<" is generally not desirable.
  3157. verifyFormat(
  3158. "llvm::errs()\n"
  3159. " << \"aaaaaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3160. " << \"aaaaaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3161. " << \"aaaaaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3162. " << \"aaaaaaaaaaaaaaaaaaa: \" << aaaaaaaaaaaaaaaaaaaaaaaaaaaa;",
  3163. getLLVMStyleWithColumns(70));
  3164. verifyFormat("llvm::errs() << \"aaaaaaaaaaaaaaaaaaa: \"\n"
  3165. " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3166. " << \"aaaaaaaaaaaaaaaaaaa: \"\n"
  3167. " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3168. " << \"aaaaaaaaaaaaaaaaaaa: \"\n"
  3169. " << aaaaaaaaaaaaaaaaaaaaaaaaaaaa;",
  3170. getLLVMStyleWithColumns(70));
  3171. // But sometimes, breaking before the first "<<" is desirable.
  3172. verifyFormat("Diag(aaaaaaaaaaaaaaaaaaaaaaaaaaaaa, bbbbbbbbb)\n"
  3173. " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3174. " << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
  3175. verifyFormat("SemaRef.Diag(Loc, diag::note_for_range_begin_end)\n"
  3176. " << BEF << IsTemplate << Description << E->getType();");
  3177. verifyFormat(
  3178. "llvm::errs() << aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3179. " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();");
  3180. // Incomplete string literal.
  3181. EXPECT_EQ("llvm::errs() << \"\n"
  3182. " << a;",
  3183. format("llvm::errs() << \"\n<<a;"));
  3184. }
  3185. TEST_F(FormatTest, UnderstandsEquals) {
  3186. verifyFormat(
  3187. "aaaaaaaaaaaaaaaaa =\n"
  3188. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
  3189. verifyFormat(
  3190. "if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n"
  3191. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}");
  3192. verifyFormat(
  3193. "if (a) {\n"
  3194. " f();\n"
  3195. "} else if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n"
  3196. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n"
  3197. "}");
  3198. verifyFormat("if (int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa =\n"
  3199. " 100000000 + 10000000) {\n}");
  3200. }
  3201. TEST_F(FormatTest, WrapsAtFunctionCallsIfNecessary) {
  3202. verifyFormat("LoooooooooooooooooooooooooooooooooooooongObject\n"
  3203. " .looooooooooooooooooooooooooooooooooooooongFunction();");
  3204. verifyFormat("LoooooooooooooooooooooooooooooooooooooongObject\n"
  3205. " ->looooooooooooooooooooooooooooooooooooooongFunction();");
  3206. verifyFormat(
  3207. "LooooooooooooooooooooooooooooooooongObject->shortFunction(Parameter1,\n"
  3208. " Parameter2);");
  3209. verifyFormat(
  3210. "ShortObject->shortFunction(\n"
  3211. " LooooooooooooooooooooooooooooooooooooooooooooooongParameter1,\n"
  3212. " LooooooooooooooooooooooooooooooooooooooooooooooongParameter2);");
  3213. verifyFormat("loooooooooooooongFunction(\n"
  3214. " LoooooooooooooongObject->looooooooooooooooongFunction());");
  3215. verifyFormat(
  3216. "function(LoooooooooooooooooooooooooooooooooooongObject\n"
  3217. " ->loooooooooooooooooooooooooooooooooooooooongFunction());");
  3218. verifyFormat("EXPECT_CALL(SomeObject, SomeFunction(Parameter))\n"
  3219. " .WillRepeatedly(Return(SomeValue));");
  3220. verifyFormat("SomeMap[std::pair(aaaaaaaaaaaa, bbbbbbbbbbbbbbb)]\n"
  3221. " .insert(ccccccccccccccccccccccc);");
  3222. verifyFormat("aaaaa(aaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  3223. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa).aaaaa(aaaaa),\n"
  3224. " aaaaaaaaaaaaaaaaaaaaa);");
  3225. verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  3226. " aaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa)->aaaaaaaaa());");
  3227. verifyFormat(
  3228. "aaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  3229. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)\n"
  3230. " .aaaaaaaaaaaaaaa(aa(aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  3231. " aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  3232. " aaaaaaaaaaaaaaaaaaaaaaaaaaa));");
  3233. verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3234. " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3235. " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3236. " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa()) {\n"
  3237. "}");
  3238. // Here, it is not necessary to wrap at "." or "->".
  3239. verifyFormat("if (aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaa) ||\n"
  3240. " aaaa.aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa) {\n}");
  3241. verifyFormat(
  3242. "aaaaaaaaaaa->aaaaaaaaa(\n"
  3243. " aaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  3244. " aaaaaaaaaaaaaaaaaa->aaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaa));\n");
  3245. verifyFormat(
  3246. "aaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  3247. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa().aaaaaaaaaaaaaaaaa());");
  3248. verifyFormat("a->aaaaaa()->aaaaaaaaaaa(aaaaaaaa()->aaaaaa()->aaaaa() *\n"
  3249. " aaaaaaaaa()->aaaaaa()->aaaaa());");
  3250. verifyFormat("a->aaaaaa()->aaaaaaaaaaa(aaaaaaaa()->aaaaaa()->aaaaa() ||\n"
  3251. " aaaaaaaaa()->aaaaaa()->aaaaa());");
  3252. // FIXME: Should we break before .a()?
  3253. verifyFormat("aaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  3254. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa).a();");
  3255. FormatStyle NoBinPacking = getLLVMStyle();
  3256. NoBinPacking.BinPackParameters = false;
  3257. verifyFormat("aaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaa)\n"
  3258. " .aaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaa)\n"
  3259. " .aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaa,\n"
  3260. " aaaaaaaaaaaaaaaaaaa,\n"
  3261. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);",
  3262. NoBinPacking);
  3263. // If there is a subsequent call, change to hanging indentation.
  3264. verifyFormat(
  3265. "aaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  3266. " aaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaa))\n"
  3267. " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();");
  3268. verifyFormat(
  3269. "aaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  3270. " aaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaa));");
  3271. }
  3272. TEST_F(FormatTest, WrapsTemplateDeclarations) {
  3273. verifyFormat("template <typename T>\n"
  3274. "virtual void loooooooooooongFunction(int Param1, int Param2);");
  3275. verifyFormat("template <typename T>\n"
  3276. "// T should be one of {A, B}.\n"
  3277. "virtual void loooooooooooongFunction(int Param1, int Param2);");
  3278. verifyFormat(
  3279. "template <typename T>\n"
  3280. "using comment_to_xml_conversion = comment_to_xml_conversion<T, int>;");
  3281. verifyFormat("template <typename T>\n"
  3282. "void f(int Paaaaaaaaaaaaaaaaaaaaaaaaaaaaaaram1,\n"
  3283. " int Paaaaaaaaaaaaaaaaaaaaaaaaaaaaaaram2);");
  3284. verifyFormat(
  3285. "template <typename T>\n"
  3286. "void looooooooooooooooooooongFunction(int Paaaaaaaaaaaaaaaaaaaaram1,\n"
  3287. " int Paaaaaaaaaaaaaaaaaaaaram2);");
  3288. verifyFormat(
  3289. "template <typename T>\n"
  3290. "aaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaa,\n"
  3291. " aaaaaaaaaaaaaaaaaaaaaaaaaa<T>::aaaaaaaaaa,\n"
  3292. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
  3293. verifyFormat("template <typename T>\n"
  3294. "void aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  3295. " int aaaaaaaaaaaaaaaaaaaaaa);");
  3296. verifyFormat(
  3297. "template <typename T1, typename T2 = char, typename T3 = char,\n"
  3298. " typename T4 = char>\n"
  3299. "void f();");
  3300. verifyFormat(
  3301. "aaaaaaaaaaaaaaaaaaaaaaaa<aaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaa>(\n"
  3302. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
  3303. verifyFormat("a<aaaaaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaaaaa>(\n"
  3304. " a(aaaaaaaaaaaaaaaaaa, aaaaaaaaaaaaaaaa));");
  3305. verifyFormat("template <typename T> class C {};");
  3306. verifyFormat("template <typename T> void f();");
  3307. verifyFormat("template <typename T> void f() {}");
  3308. verifyFormat(
  3309. "aaaaaaaaaaaaa<aaaaaaaaaa, aaaaaaaaaaa,\n"
  3310. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  3311. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa> *aaaa =\n"
  3312. " new aaaaaaaaaaaaa<aaaaaaaaaa, aaaaaaaaaaa,\n"
  3313. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  3314. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa>(\n"
  3315. " bbbbbbbbbbbbbbbbbbbbbbbb);",
  3316. getLLVMStyleWithColumns(72));
  3317. FormatStyle AlwaysBreak = getLLVMStyle();
  3318. AlwaysBreak.AlwaysBreakTemplateDeclarations = true;
  3319. verifyFormat("template <typename T>\nclass C {};", AlwaysBreak);
  3320. verifyFormat("template <typename T>\nvoid f();", AlwaysBreak);
  3321. verifyFormat("template <typename T>\nvoid f() {}", AlwaysBreak);
  3322. verifyFormat("void aaaaaaaaaaaaaaaaaaa<aaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  3323. " bbbbbbbbbbbbbbbbbbbbbbbbbbbb>(\n"
  3324. " ccccccccccccccccccccccccccccccccccccccccccccccc);");
  3325. verifyFormat("template <template <typename> class Fooooooo,\n"
  3326. " template <typename> class Baaaaaaar>\n"
  3327. "struct C {};",
  3328. AlwaysBreak);
  3329. }
  3330. TEST_F(FormatTest, WrapsAtNestedNameSpecifiers) {
  3331. verifyFormat(
  3332. "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n"
  3333. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();");
  3334. verifyFormat(
  3335. "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n"
  3336. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  3337. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa());");
  3338. // FIXME: Should we have the extra indent after the second break?
  3339. verifyFormat(
  3340. "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n"
  3341. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n"
  3342. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();");
  3343. verifyFormat(
  3344. "aaaaaaaaaaaaaaa(bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb::\n"
  3345. " cccccccccccccccccccccccccccccccccccccccccccccc());");
  3346. // Breaking at nested name specifiers is generally not desirable.
  3347. verifyFormat(
  3348. "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  3349. " aaaaaaaaaaaaaaaaaaaaaaa);");
  3350. verifyFormat(
  3351. "aaaaaaaaaaaaaaaaaa(aaaaaaaa, aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n"
  3352. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  3353. " aaaaaaaaaaaaaaaaaaaaa);",
  3354. getLLVMStyleWithColumns(74));
  3355. verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa::\n"
  3356. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3357. " .aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa();");
  3358. }
  3359. TEST_F(FormatTest, UnderstandsTemplateParameters) {
  3360. verifyFormat("A<int> a;");
  3361. verifyFormat("A<A<A<int> > > a;");
  3362. verifyFormat("A<A<A<int, 2>, 3>, 4> a;");
  3363. verifyFormat("bool x = a < 1 || 2 > a;");
  3364. verifyFormat("bool x = 5 < f<int>();");
  3365. verifyFormat("bool x = f<int>() > 5;");
  3366. verifyFormat("bool x = 5 < a<int>::x;");
  3367. verifyFormat("bool x = a < 4 ? a > 2 : false;");
  3368. verifyFormat("bool x = f() ? a < 2 : a > 2;");
  3369. verifyGoogleFormat("A<A<int>> a;");
  3370. verifyGoogleFormat("A<A<A<int>>> a;");
  3371. verifyGoogleFormat("A<A<A<A<int>>>> a;");
  3372. verifyGoogleFormat("A<A<int> > a;");
  3373. verifyGoogleFormat("A<A<A<int> > > a;");
  3374. verifyGoogleFormat("A<A<A<A<int> > > > a;");
  3375. EXPECT_EQ("A<A<A<A>>> a;", format("A<A<A<A> >> a;", getGoogleStyle()));
  3376. EXPECT_EQ("A<A<A<A>>> a;", format("A<A<A<A>> > a;", getGoogleStyle()));
  3377. verifyFormat("test >> a >> b;");
  3378. verifyFormat("test << a >> b;");
  3379. verifyFormat("f<int>();");
  3380. verifyFormat("template <typename T> void f() {}");
  3381. // Not template parameters.
  3382. verifyFormat("return a < b && c > d;");
  3383. verifyFormat("void f() {\n"
  3384. " while (a < b && c > d) {\n"
  3385. " }\n"
  3386. "}");
  3387. verifyFormat("template <typename... Types>\n"
  3388. "typename enable_if<0 < sizeof...(Types)>::type Foo() {}");
  3389. verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  3390. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaa >> aaaaa);",
  3391. getLLVMStyleWithColumns(60));
  3392. }
  3393. TEST_F(FormatTest, UnderstandsBinaryOperators) {
  3394. verifyFormat("COMPARE(a, ==, b);");
  3395. }
  3396. TEST_F(FormatTest, UnderstandsPointersToMembers) {
  3397. verifyFormat("int A::*x;");
  3398. verifyFormat("int (S::*func)(void *);");
  3399. verifyFormat("void f() { int (S::*func)(void *); }");
  3400. verifyFormat("typedef bool *(Class::*Member)() const;");
  3401. verifyFormat("void f() {\n"
  3402. " (a->*f)();\n"
  3403. " a->*x;\n"
  3404. " (a.*f)();\n"
  3405. " ((*a).*f)();\n"
  3406. " a.*x;\n"
  3407. "}");
  3408. verifyFormat("void f() {\n"
  3409. " (a->*aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa)(\n"
  3410. " aaaa, bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb);\n"
  3411. "}");
  3412. FormatStyle Style = getLLVMStyle();
  3413. Style.PointerBindsToType = true;
  3414. verifyFormat("typedef bool* (Class::*Member)() const;", Style);
  3415. }
  3416. TEST_F(FormatTest, UnderstandsUnaryOperators) {
  3417. verifyFormat("int a = -2;");
  3418. verifyFormat("f(-1, -2, -3);");
  3419. verifyFormat("a[-1] = 5;");
  3420. verifyFormat("int a = 5 + -2;");
  3421. verifyFormat("if (i == -1) {\n}");
  3422. verifyFormat("if (i != -1) {\n}");
  3423. verifyFormat("if (i > -1) {\n}");
  3424. verifyFormat("if (i < -1) {\n}");
  3425. verifyFormat("++(a->f());");
  3426. verifyFormat("--(a->f());");
  3427. verifyFormat("(a->f())++;");
  3428. verifyFormat("a[42]++;");
  3429. verifyFormat("if (!(a->f())) {\n}");
  3430. verifyFormat("a-- > b;");
  3431. verifyFormat("b ? -a : c;");
  3432. verifyFormat("n * sizeof char16;");
  3433. verifyFormat("n * alignof char16;", getGoogleStyle());
  3434. verifyFormat("sizeof(char);");
  3435. verifyFormat("alignof(char);", getGoogleStyle());
  3436. verifyFormat("return -1;");
  3437. verifyFormat("switch (a) {\n"
  3438. "case -1:\n"
  3439. " break;\n"
  3440. "}");
  3441. verifyFormat("#define X -1");
  3442. verifyFormat("#define X -kConstant");
  3443. verifyFormat("const NSPoint kBrowserFrameViewPatternOffset = { -5, +3 };");
  3444. verifyFormat("const NSPoint kBrowserFrameViewPatternOffset = { +5, -3 };");
  3445. verifyFormat("int a = /* confusing comment */ -1;");
  3446. // FIXME: The space after 'i' is wrong, but hopefully, this is a rare case.
  3447. verifyFormat("int a = i /* confusing comment */++;");
  3448. }
  3449. TEST_F(FormatTest, IndentsRelativeToUnaryOperators) {
  3450. verifyFormat("if (!aaaaaaaaaa( // break\n"
  3451. " aaaaa)) {\n"
  3452. "}");
  3453. verifyFormat("aaaaaaaaaa(!aaaaaaaaaa( // break\n"
  3454. " aaaaa));");
  3455. // Only indent relative to unary operators if the expression is nested.
  3456. verifyFormat("*aaa = aaaaaaa( // break\n"
  3457. " bbbbbb);");
  3458. }
  3459. TEST_F(FormatTest, UnderstandsOverloadedOperators) {
  3460. verifyFormat("bool operator<();");
  3461. verifyFormat("bool operator>();");
  3462. verifyFormat("bool operator=();");
  3463. verifyFormat("bool operator==();");
  3464. verifyFormat("bool operator!=();");
  3465. verifyFormat("int operator+();");
  3466. verifyFormat("int operator++();");
  3467. verifyFormat("bool operator();");
  3468. verifyFormat("bool operator()();");
  3469. verifyFormat("bool operator[]();");
  3470. verifyFormat("operator bool();");
  3471. verifyFormat("operator int();");
  3472. verifyFormat("operator void *();");
  3473. verifyFormat("operator SomeType<int>();");
  3474. verifyFormat("operator SomeType<int, int>();");
  3475. verifyFormat("operator SomeType<SomeType<int> >();");
  3476. verifyFormat("void *operator new(std::size_t size);");
  3477. verifyFormat("void *operator new[](std::size_t size);");
  3478. verifyFormat("void operator delete(void *ptr);");
  3479. verifyFormat("void operator delete[](void *ptr);");
  3480. verifyFormat("template <typename AAAAAAA, typename BBBBBBB>\n"
  3481. "AAAAAAA operator/(const AAAAAAA &a, BBBBBBB &b);");
  3482. verifyFormat(
  3483. "ostream &operator<<(ostream &OutputStream,\n"
  3484. " SomeReallyLongType WithSomeReallyLongValue);");
  3485. verifyFormat("bool operator<(const aaaaaaaaaaaaaaaaaaaaa &left,\n"
  3486. " const aaaaaaaaaaaaaaaaaaaaa &right) {\n"
  3487. " return left.group < right.group;\n"
  3488. "}");
  3489. verifyFormat("SomeType &operator=(const SomeType &S);");
  3490. verifyGoogleFormat("operator void*();");
  3491. verifyGoogleFormat("operator SomeType<SomeType<int>>();");
  3492. verifyFormat("using A::operator+;");
  3493. }
  3494. TEST_F(FormatTest, UnderstandsNewAndDelete) {
  3495. verifyFormat("void f() {\n"
  3496. " A *a = new A;\n"
  3497. " A *a = new (placement) A;\n"
  3498. " delete a;\n"
  3499. " delete (A *)a;\n"
  3500. "}");
  3501. }
  3502. TEST_F(FormatTest, UnderstandsUsesOfStarAndAmp) {
  3503. verifyFormat("int *f(int *a) {}");
  3504. verifyFormat("int main(int argc, char **argv) {}");
  3505. verifyFormat("Test::Test(int b) : a(b * b) {}");
  3506. verifyIndependentOfContext("f(a, *a);");
  3507. verifyFormat("void g() { f(*a); }");
  3508. verifyIndependentOfContext("int a = b * 10;");
  3509. verifyIndependentOfContext("int a = 10 * b;");
  3510. verifyIndependentOfContext("int a = b * c;");
  3511. verifyIndependentOfContext("int a += b * c;");
  3512. verifyIndependentOfContext("int a -= b * c;");
  3513. verifyIndependentOfContext("int a *= b * c;");
  3514. verifyIndependentOfContext("int a /= b * c;");
  3515. verifyIndependentOfContext("int a = *b;");
  3516. verifyIndependentOfContext("int a = *b * c;");
  3517. verifyIndependentOfContext("int a = b * *c;");
  3518. verifyIndependentOfContext("return 10 * b;");
  3519. verifyIndependentOfContext("return *b * *c;");
  3520. verifyIndependentOfContext("return a & ~b;");
  3521. verifyIndependentOfContext("f(b ? *c : *d);");
  3522. verifyIndependentOfContext("int a = b ? *c : *d;");
  3523. verifyIndependentOfContext("*b = a;");
  3524. verifyIndependentOfContext("a * ~b;");
  3525. verifyIndependentOfContext("a * !b;");
  3526. verifyIndependentOfContext("a * +b;");
  3527. verifyIndependentOfContext("a * -b;");
  3528. verifyIndependentOfContext("a * ++b;");
  3529. verifyIndependentOfContext("a * --b;");
  3530. verifyIndependentOfContext("a[4] * b;");
  3531. verifyIndependentOfContext("a[a * a] = 1;");
  3532. verifyIndependentOfContext("f() * b;");
  3533. verifyIndependentOfContext("a * [self dostuff];");
  3534. verifyIndependentOfContext("int x = a * (a + b);");
  3535. verifyIndependentOfContext("(a *)(a + b);");
  3536. verifyIndependentOfContext("int *pa = (int *)&a;");
  3537. verifyIndependentOfContext("return sizeof(int **);");
  3538. verifyIndependentOfContext("return sizeof(int ******);");
  3539. verifyIndependentOfContext("return (int **&)a;");
  3540. verifyIndependentOfContext("f((*PointerToArray)[10]);");
  3541. verifyFormat("void f(Type (*parameter)[10]) {}");
  3542. verifyGoogleFormat("return sizeof(int**);");
  3543. verifyIndependentOfContext("Type **A = static_cast<Type **>(P);");
  3544. verifyGoogleFormat("Type** A = static_cast<Type**>(P);");
  3545. verifyFormat("auto a = [](int **&, int ***) {};");
  3546. verifyFormat("typedef typeof(int(int, int)) *MyFunc;");
  3547. verifyIndependentOfContext("InvalidRegions[*R] = 0;");
  3548. verifyIndependentOfContext("A<int *> a;");
  3549. verifyIndependentOfContext("A<int **> a;");
  3550. verifyIndependentOfContext("A<int *, int *> a;");
  3551. verifyIndependentOfContext(
  3552. "const char *const p = reinterpret_cast<const char *const>(q);");
  3553. verifyIndependentOfContext("A<int **, int **> a;");
  3554. verifyIndependentOfContext("void f(int *a = d * e, int *b = c * d);");
  3555. verifyFormat("for (char **a = b; *a; ++a) {\n}");
  3556. verifyFormat("for (; a && b;) {\n}");
  3557. verifyFormat(
  3558. "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa(\n"
  3559. " aaaaaaaaaaaaaaaaaaaaaaaaaaaa, *aaaaaaaaaaaaaaaaaaaaaaaaaaaaa);");
  3560. verifyGoogleFormat("int main(int argc, char** argv) {}");
  3561. verifyGoogleFormat("A<int*> a;");
  3562. verifyGoogleFormat("A<int**> a;");
  3563. verifyGoogleFormat("A<int*, int*> a;");
  3564. verifyGoogleFormat("A<int**, int**> a;");
  3565. verifyGoogleFormat("f(b ? *c : *d);");
  3566. verifyGoogleFormat("int a = b ? *c : *d;");
  3567. verifyGoogleFormat("Type* t = **x;");
  3568. verifyGoogleFormat("Type* t = *++*x;");
  3569. verifyGoogleFormat("*++*x;");
  3570. verifyGoogleFormat("Type* t = const_cast<T*>(&*x);");
  3571. verifyGoogleFormat("Type* t = x++ * y;");
  3572. verifyGoogleFormat(
  3573. "const char* const p = reinterpret_cast<const char* const>(q);");
  3574. verifyIndependentOfContext("a = *(x + y);");
  3575. verifyIndependentOfContext("a = &(x + y);");
  3576. verifyIndependentOfContext("*(x + y).call();");
  3577. verifyIndependentOfContext("&(x + y)->call();");
  3578. verifyFormat("void f() { &(*I).first; }");
  3579. verifyIndependentOfContext("f(b * /* confusing comment */ ++c);");
  3580. verifyFormat(
  3581. "int *MyValues = {\n"
  3582. " *A, // Operator detection might be confused by the '{'\n"
  3583. " *BB // Operator detection might be confused by previous comment\n"
  3584. "};");
  3585. verifyIndependentOfContext("if (int *a = &b)");
  3586. verifyIndependentOfContext("if (int &a = *b)");
  3587. verifyIndependentOfContext("if (a & b[i])");
  3588. verifyIndependentOfContext("if (a::b::c::d & b[i])");
  3589. verifyIndependentOfContext("if (*b[i])");
  3590. verifyIndependentOfContext("if (int *a = (&b))");
  3591. verifyIndependentOfContext("while (int *a = &b)");
  3592. verifyIndependentOfContext("size = sizeof *a;");
  3593. verifyFormat("void f() {\n"
  3594. " for (const int &v : Values) {\n"
  3595. " }\n"
  3596. "}");
  3597. verifyFormat("for (int i = a * a; i < 10; ++i) {\n}");
  3598. verifyFormat("for (int i = 0; i < a * a; ++i) {\n}");
  3599. verifyGoogleFormat("for (int i = 0; i * 2 < z; i *= 2) {\n}");
  3600. verifyFormat("#define MACRO \\\n"
  3601. " int *i = a * b; \\\n"
  3602. " void f(a *b);",
  3603. getLLVMStyleWithColumns(19));
  3604. verifyIndependentOfContext("A = new SomeType *[Length];");
  3605. verifyIndependentOfContext("A = new SomeType *[Length]();");
  3606. verifyIndependentOfContext("T **t = new T *;");
  3607. verifyIndependentOfContext("T **t = new T *();");
  3608. verifyGoogleFormat("A = new SomeType* [Length]();");
  3609. verifyGoogleFormat("A = new SomeType* [Length];");
  3610. verifyGoogleFormat("T** t = new T*;");
  3611. verifyGoogleFormat("T** t = new T*();");
  3612. FormatStyle PointerLeft = getLLVMStyle();
  3613. PointerLeft.PointerBindsToType = true;
  3614. verifyFormat("delete *x;", PointerLeft);
  3615. }
  3616. TEST_F(FormatTest, UnderstandsAttributes) {
  3617. verifyFormat("SomeType s __attribute__((unused)) (InitValue);");
  3618. }
  3619. TEST_F(FormatTest, UnderstandsEllipsis) {
  3620. verifyFormat("int printf(const char *fmt, ...);");
  3621. verifyFormat("template <class... Ts> void Foo(Ts... ts) { Foo(ts...); }");
  3622. verifyFormat("template <class... Ts> void Foo(Ts *... ts) {}");
  3623. FormatStyle PointersLeft = getLLVMStyle();
  3624. PointersLeft.PointerBindsToType = true;
  3625. verifyFormat("template <class... Ts> void Foo(Ts*... ts) {}", PointersLeft);
  3626. }
  3627. TEST_F(FormatTest, AdaptivelyFormatsPointersAndReferences) {
  3628. EXPECT_EQ("int *a;\n"
  3629. "int *a;\n"
  3630. "int *a;",
  3631. format("int *a;\n"
  3632. "int* a;\n"
  3633. "int *a;",
  3634. getGoogleStyle()));
  3635. EXPECT_EQ("int* a;\n"
  3636. "int* a;\n"
  3637. "int* a;",
  3638. format("int* a;\n"
  3639. "int* a;\n"
  3640. "int *a;",
  3641. getGoogleStyle()));
  3642. EXPECT_EQ("int *a;\n"
  3643. "int *a;\n"
  3644. "int *a;",
  3645. format("int *a;\n"
  3646. "int * a;\n"
  3647. "int * a;",
  3648. getGoogleStyle()));
  3649. }
  3650. TEST_F(FormatTest, UnderstandsRvalueReferences) {
  3651. verifyFormat("int f(int &&a) {}");
  3652. verifyFormat("int f(int a, char &&b) {}");
  3653. verifyFormat("void f() { int &&a = b; }");
  3654. verifyGoogleFormat("int f(int a, char&& b) {}");
  3655. verifyGoogleFormat("void f() { int&& a = b; }");
  3656. verifyIndependentOfContext("A<int &&> a;");
  3657. verifyIndependentOfContext("A<int &&, int &&> a;");
  3658. verifyGoogleFormat("A<int&&> a;");
  3659. verifyGoogleFormat("A<int&&, int&&> a;");
  3660. // Not rvalue references:
  3661. verifyFormat("template <bool B, bool C> class A {\n"
  3662. " static_assert(B && C, \"Something is wrong\");\n"
  3663. "};");
  3664. verifyGoogleFormat("#define IF(a, b, c) if (a && (b == c))");
  3665. verifyGoogleFormat("#define WHILE(a, b, c) while (a && (b == c))");
  3666. }
  3667. TEST_F(FormatTest, FormatsBinaryOperatorsPrecedingEquals) {
  3668. verifyFormat("void f() {\n"
  3669. " x[aaaaaaaaa -\n"
  3670. " b] = 23;\n"
  3671. "}",
  3672. getLLVMStyleWithColumns(15));
  3673. }
  3674. TEST_F(FormatTest, FormatsCasts) {
  3675. verifyFormat("Type *A = static_cast<Type *>(P);");
  3676. verifyFormat("Type *A = (Type *)P;");
  3677. verifyFormat("Type *A = (vector<Type *, int *>)P;");
  3678. verifyFormat("int a = (int)(2.0f);");
  3679. verifyFormat("int a = (int)2.0f;");
  3680. verifyFormat("x[(int32)y];");
  3681. verifyFormat("x = (int32)y;");
  3682. verifyFormat("#define AA(X) sizeof(((X *)NULL)->a)");
  3683. verifyFormat("int a = (int)*b;");
  3684. verifyFormat("int a = (int)2.0f;");
  3685. verifyFormat("int a = (int)~0;");
  3686. verifyFormat("int a = (int)++a;");
  3687. verifyFormat("int a = (int)sizeof(int);");
  3688. verifyFormat("int a = (int)+2;");
  3689. verifyFormat("my_int a = (my_int)2.0f;");
  3690. verifyFormat("my_int a = (my_int)sizeof(int);");
  3691. verifyFormat("return (my_int)aaa;");
  3692. verifyFormat("#define x ((int)-1)");
  3693. verifyFormat("#define p(q) ((int *)&q)");
  3694. // FIXME: Without type knowledge, this can still fall apart miserably.
  3695. verifyFormat("void f() { my_int a = (my_int) * b; }");
  3696. verifyFormat("void f() { return P ? (my_int) * P : (my_int)0; }");
  3697. verifyFormat("my_int a = (my_int) ~0;");
  3698. verifyFormat("my_int a = (my_int)++ a;");
  3699. verifyFormat("my_int a = (my_int) + 2;");
  3700. // Don't break after a cast's
  3701. verifyFormat("int aaaaaaaaaaaaaaaaaaaaaaaaaaa =\n"
  3702. " (aaaaaaaaaaaaaaaaaaaaaaaaaa *)(aaaaaaaaaaaaaaaaaaaaaa +\n"
  3703. " bbbbbbbbbbbbbbbbbbbbbb);");
  3704. // These are not casts.
  3705. verifyFormat("void f(int *) {}");
  3706. verifyFormat("f(foo)->b;");
  3707. verifyFormat("f(foo).b;");
  3708. verifyFormat("f(foo)(b);");
  3709. verifyFormat("f(foo)[b];");
  3710. verifyFormat("[](foo) { return 4; }(bar);");
  3711. verifyFormat("(*funptr)(foo)[4];");
  3712. verifyFormat("funptrs[4](foo)[4];");
  3713. verifyFormat("void f(int *);");
  3714. verifyFormat("void f(int *) = 0;");
  3715. verifyFormat("void f(SmallVector<int>) {}");
  3716. verifyFormat("void f(SmallVector<int>);");
  3717. verifyFormat("void f(SmallVector<int>) = 0;");
  3718. verifyFormat("void f(int i = (kValue) * kMask) {}");
  3719. verifyFormat("void f(int i = (kA * kB) & kMask) {}");
  3720. verifyFormat("int a = sizeof(int) * b;");
  3721. verifyFormat("int a = alignof(int) * b;", getGoogleStyle());
  3722. verifyFormat("template <> void f<int>(int i) SOME_ANNOTATION;");
  3723. verifyFormat("f(\"%\" SOME_MACRO(ll) \"d\");");
  3724. verifyFormat("aaaaa &operator=(const aaaaa &) LLVM_DELETED_FUNCTION;");
  3725. // These are not casts, but at some point were confused with casts.
  3726. verifyFormat("virtual void foo(int *) override;");
  3727. verifyFormat("virtual void foo(char &) const;");
  3728. verifyFormat("virtual void foo(int *a, char *) const;");
  3729. verifyFormat("int a = sizeof(int *) + b;");
  3730. verifyFormat("int a = alignof(int *) + b;", getGoogleStyle());
  3731. verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa *foo = (aaaaaaaaaaaaaaaaa *)\n"
  3732. " bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb;");
  3733. // FIXME: The indentation here is not ideal.
  3734. verifyFormat(
  3735. "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3736. " [bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = (*cccccccccccccccc)\n"
  3737. " [dddddddddddddddddddddddddddddddddddddddddddddddddddddddd];");
  3738. }
  3739. TEST_F(FormatTest, FormatsFunctionTypes) {
  3740. verifyFormat("A<bool()> a;");
  3741. verifyFormat("A<SomeType()> a;");
  3742. verifyFormat("A<void (*)(int, std::string)> a;");
  3743. verifyFormat("A<void *(int)>;");
  3744. verifyFormat("void *(*a)(int *, SomeType *);");
  3745. verifyFormat("int (*func)(void *);");
  3746. verifyFormat("void f() { int (*func)(void *); }");
  3747. verifyFormat("template <class CallbackClass>\n"
  3748. "using MyCallback = void (CallbackClass::*)(SomeObject *Data);");
  3749. verifyGoogleFormat("A<void*(int*, SomeType*)>;");
  3750. verifyGoogleFormat("void* (*a)(int);");
  3751. verifyGoogleFormat(
  3752. "template <class CallbackClass>\n"
  3753. "using MyCallback = void (CallbackClass::*)(SomeObject* Data);");
  3754. // Other constructs can look somewhat like function types:
  3755. verifyFormat("A<sizeof(*x)> a;");
  3756. verifyFormat("#define DEREF_AND_CALL_F(x) f(*x)");
  3757. verifyFormat("some_var = function(*some_pointer_var)[0];");
  3758. verifyFormat("void f() { function(*some_pointer_var)[0] = 10; }");
  3759. }
  3760. TEST_F(FormatTest, BreaksLongDeclarations) {
  3761. verifyFormat("typedef LoooooooooooooooooooooooooooooooooooooooongType\n"
  3762. " AnotherNameForTheLongType;",
  3763. getGoogleStyle());
  3764. verifyFormat("LoooooooooooooooooooooooooooooooooooooooongType\n"
  3765. " LoooooooooooooooooooooooooooooooooooooooongVariable;",
  3766. getGoogleStyle());
  3767. verifyFormat("LoooooooooooooooooooooooooooooooooooooooongType const\n"
  3768. " LoooooooooooooooooooooooooooooooooooooooongVariable;",
  3769. getGoogleStyle());
  3770. verifyFormat("LoooooooooooooooooooooooooooooooooooooooongReturnType\n"
  3771. " LoooooooooooooooooooooooooooooooongFunctionDeclaration();",
  3772. getGoogleStyle());
  3773. verifyFormat("LoooooooooooooooooooooooooooooooooooooooongReturnType\n"
  3774. "LooooooooooooooooooooooooooooooooooongFunctionDefinition() {}");
  3775. verifyFormat("LoooooooooooooooooooooooooooooooooooooooongReturnType const\n"
  3776. "LooooooooooooooooooooooooooooooooooongFunctionDefinition() {}");
  3777. // FIXME: Without the comment, this breaks after "(".
  3778. verifyFormat("LoooooooooooooooooooooooooooooooooooooooongType // break\n"
  3779. " (*LoooooooooooooooooooooooooooongFunctionTypeVarialbe)();",
  3780. getGoogleStyle());
  3781. verifyFormat("int *someFunction(int LoooooooooooooooooooongParam1,\n"
  3782. " int LoooooooooooooooooooongParam2) {}");
  3783. verifyFormat(
  3784. "TypeSpecDecl *TypeSpecDecl::Create(ASTContext &C, DeclContext *DC,\n"
  3785. " SourceLocation L, IdentifierIn *II,\n"
  3786. " Type *T) {}");
  3787. verifyFormat("ReallyLongReturnType<TemplateParam1, TemplateParam2>\n"
  3788. "ReallyReallyLongFunctionName(\n"
  3789. " const std::string &SomeParameter,\n"
  3790. " const SomeType<string, SomeOtherTemplateParameter> &\n"
  3791. " ReallyReallyLongParameterName,\n"
  3792. " const SomeType<string, SomeOtherTemplateParameter> &\n"
  3793. " AnotherLongParameterName) {}");
  3794. verifyFormat("template <typename A>\n"
  3795. "SomeLoooooooooooooooooooooongType<\n"
  3796. " typename some_namespace::SomeOtherType<A>::Type>\n"
  3797. "Function() {}");
  3798. verifyGoogleFormat(
  3799. "aaaaaaaaaaaaaaaa::aaaaaaaaaaaaaaaa<aaaaaaaaaaaaa, aaaaaaaaaaaa>\n"
  3800. " aaaaaaaaaaaaaaaaaaaaaaa;");
  3801. verifyGoogleFormat(
  3802. "TypeSpecDecl* TypeSpecDecl::Create(ASTContext& C, DeclContext* DC,\n"
  3803. " SourceLocation L) {}");
  3804. verifyGoogleFormat(
  3805. "some_namespace::LongReturnType\n"
  3806. "long_namespace::SomeVeryLongClass::SomeVeryLongFunction(\n"
  3807. " int first_long_parameter, int second_parameter) {}");
  3808. verifyGoogleFormat("template <typename T>\n"
  3809. "aaaaaaaa::aaaaa::aaaaaa<T, aaaaaaaaaaaaaaaaaaaaaaaaa>\n"
  3810. "aaaaaaaaaaaaaaaaaaaaaaaa<T>::aaaaaaa() {}");
  3811. verifyGoogleFormat("A<A<A>> aaaaaaaaaa(int aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  3812. " int aaaaaaaaaaaaaaaaaaaaaaa);");
  3813. }
  3814. TEST_F(FormatTest, FormatsArrays) {
  3815. verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaa[aaaaaaaaaaaaaaaaaaaaaaaaa]\n"
  3816. " [bbbbbbbbbbbbbbbbbbbbbbbbb] = c;");
  3817. verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3818. " [bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = ccccccccccc;");
  3819. verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3820. " [a][bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = cccccccc;");
  3821. verifyFormat("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  3822. " [aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa]\n"
  3823. " [bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb] = ccccccccccc;");
  3824. verifyFormat(
  3825. "llvm::outs() << \"aaaaaaaaaaaa: \"\n"
  3826. " << (*aaaaaaaiaaaaaaa)[aaaaaaaaaaaaaaaaaaaaaaaaa]\n"
  3827. " [aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa];");
  3828. }
  3829. TEST_F(FormatTest, LineStartsWithSpecialCharacter) {
  3830. verifyFormat("(a)->b();");
  3831. verifyFormat("--a;");
  3832. }
  3833. TEST_F(FormatTest, HandlesIncludeDirectives) {
  3834. verifyFormat("#include <string>\n"
  3835. "#include <a/b/c.h>\n"
  3836. "#include \"a/b/string\"\n"
  3837. "#include \"string.h\"\n"
  3838. "#include \"string.h\"\n"
  3839. "#include <a-a>\n"
  3840. "#include < path with space >\n"
  3841. "#include \"abc.h\" // this is included for ABC\n"
  3842. "#include \"some long include\" // with a comment\n"
  3843. "#include \"some very long include paaaaaaaaaaaaaaaaaaaaaaath\"",
  3844. getLLVMStyleWithColumns(35));
  3845. verifyFormat("#import <string>");
  3846. verifyFormat("#import <a/b/c.h>");
  3847. verifyFormat("#import \"a/b/string\"");
  3848. verifyFormat("#import \"string.h\"");
  3849. verifyFormat("#import \"string.h\"");
  3850. verifyFormat("#if __has_include(<strstream>)\n"
  3851. "#include <strstream>\n"
  3852. "#endif");
  3853. }
  3854. //===----------------------------------------------------------------------===//
  3855. // Error recovery tests.
  3856. //===----------------------------------------------------------------------===//
  3857. TEST_F(FormatTest, IncompleteParameterLists) {
  3858. FormatStyle NoBinPacking = getLLVMStyle();
  3859. NoBinPacking.BinPackParameters = false;
  3860. verifyFormat("void aaaaaaaaaaaaaaaaaa(int level,\n"
  3861. " double *min_x,\n"
  3862. " double *max_x,\n"
  3863. " double *min_y,\n"
  3864. " double *max_y,\n"
  3865. " double *min_z,\n"
  3866. " double *max_z, ) {}",
  3867. NoBinPacking);
  3868. }
  3869. TEST_F(FormatTest, IncorrectCodeTrailingStuff) {
  3870. verifyFormat("void f() { return; }\n42");
  3871. verifyFormat("void f() {\n"
  3872. " if (0)\n"
  3873. " return;\n"
  3874. "}\n"
  3875. "42");
  3876. verifyFormat("void f() { return }\n42");
  3877. verifyFormat("void f() {\n"
  3878. " if (0)\n"
  3879. " return\n"
  3880. "}\n"
  3881. "42");
  3882. }
  3883. TEST_F(FormatTest, IncorrectCodeMissingSemicolon) {
  3884. EXPECT_EQ("void f() { return }", format("void f ( ) { return }"));
  3885. EXPECT_EQ("void f() {\n"
  3886. " if (a)\n"
  3887. " return\n"
  3888. "}",
  3889. format("void f ( ) { if ( a ) return }"));
  3890. EXPECT_EQ("namespace N {\n"
  3891. "void f()\n"
  3892. "}",
  3893. format("namespace N { void f() }"));
  3894. EXPECT_EQ("namespace N {\n"
  3895. "void f() {}\n"
  3896. "void g()\n"
  3897. "}",
  3898. format("namespace N { void f( ) { } void g( ) }"));
  3899. }
  3900. TEST_F(FormatTest, IndentationWithinColumnLimitNotPossible) {
  3901. verifyFormat("int aaaaaaaa =\n"
  3902. " // Overlylongcomment\n"
  3903. " b;",
  3904. getLLVMStyleWithColumns(20));
  3905. verifyFormat("function(\n"
  3906. " ShortArgument,\n"
  3907. " LoooooooooooongArgument);\n",
  3908. getLLVMStyleWithColumns(20));
  3909. }
  3910. TEST_F(FormatTest, IncorrectAccessSpecifier) {
  3911. verifyFormat("public:");
  3912. verifyFormat("class A {\n"
  3913. "public\n"
  3914. " void f() {}\n"
  3915. "};");
  3916. verifyFormat("public\n"
  3917. "int qwerty;");
  3918. verifyFormat("public\n"
  3919. "B {}");
  3920. verifyFormat("public\n"
  3921. "{}");
  3922. verifyFormat("public\n"
  3923. "B { int x; }");
  3924. }
  3925. TEST_F(FormatTest, IncorrectCodeUnbalancedBraces) {
  3926. verifyFormat("{");
  3927. verifyFormat("#})");
  3928. }
  3929. TEST_F(FormatTest, IncorrectCodeDoNoWhile) {
  3930. verifyFormat("do {\n}");
  3931. verifyFormat("do {\n}\n"
  3932. "f();");
  3933. verifyFormat("do {\n}\n"
  3934. "wheeee(fun);");
  3935. verifyFormat("do {\n"
  3936. " f();\n"
  3937. "}");
  3938. }
  3939. TEST_F(FormatTest, IncorrectCodeMissingParens) {
  3940. verifyFormat("if {\n foo;\n foo();\n}");
  3941. verifyFormat("switch {\n foo;\n foo();\n}");
  3942. verifyFormat("for {\n foo;\n foo();\n}");
  3943. verifyFormat("while {\n foo;\n foo();\n}");
  3944. verifyFormat("do {\n foo;\n foo();\n} while;");
  3945. }
  3946. TEST_F(FormatTest, DoesNotTouchUnwrappedLinesWithErrors) {
  3947. verifyFormat("namespace {\n"
  3948. "class Foo { Foo (\n"
  3949. "};\n"
  3950. "} // comment");
  3951. }
  3952. TEST_F(FormatTest, IncorrectCodeErrorDetection) {
  3953. EXPECT_EQ("{\n{}\n", format("{\n{\n}\n"));
  3954. EXPECT_EQ("{\n {}\n", format("{\n {\n}\n"));
  3955. EXPECT_EQ("{\n {}\n", format("{\n {\n }\n"));
  3956. EXPECT_EQ("{\n {}\n }\n}\n", format("{\n {\n }\n }\n}\n"));
  3957. EXPECT_EQ("{\n"
  3958. " {\n"
  3959. " breakme(\n"
  3960. " qwe);\n"
  3961. "}\n",
  3962. format("{\n"
  3963. " {\n"
  3964. " breakme(qwe);\n"
  3965. "}\n",
  3966. getLLVMStyleWithColumns(10)));
  3967. }
  3968. TEST_F(FormatTest, LayoutCallsInsideBraceInitializers) {
  3969. verifyFormat("int x = {\n"
  3970. " avariable,\n"
  3971. " b(alongervariable)\n"
  3972. "};",
  3973. getLLVMStyleWithColumns(25));
  3974. }
  3975. TEST_F(FormatTest, LayoutBraceInitializersInReturnStatement) {
  3976. verifyFormat("return (a)(b) { 1, 2, 3 };");
  3977. }
  3978. TEST_F(FormatTest, LayoutCxx11ConstructorBraceInitializers) {
  3979. verifyFormat("vector<int> x{ 1, 2, 3, 4 };");
  3980. verifyFormat("vector<T> x{ {}, {}, {}, {} };");
  3981. verifyFormat("f({ 1, 2 });");
  3982. verifyFormat("auto v = Foo{ 1 };");
  3983. verifyFormat("f({ 1, 2 }, { { 2, 3 }, { 4, 5 } }, c, { d });");
  3984. verifyFormat("Class::Class : member{ 1, 2, 3 } {}");
  3985. verifyFormat("new vector<int>{ 1, 2, 3 };");
  3986. verifyFormat("new int[3]{ 1, 2, 3 };");
  3987. verifyFormat("return { arg1, arg2 };");
  3988. verifyFormat("return { arg1, SomeType{ parameter } };");
  3989. verifyFormat("new T{ arg1, arg2 };");
  3990. verifyFormat("f(MyMap[{ composite, key }]);");
  3991. verifyFormat("class Class {\n"
  3992. " T member = { arg1, arg2 };\n"
  3993. "};");
  3994. verifyFormat(
  3995. "foo = aaaaaaaaaaa ? vector<int>{ aaaaaaaaaaaaaaaaaaaaaaaaaaa,\n"
  3996. " aaaaaaaaaaaaaaaaaaaa, aaaaa }\n"
  3997. " : vector<int>{ bbbbbbbbbbbbbbbbbbbbbbbbbbb,\n"
  3998. " bbbbbbbbbbbbbbbbbbbb, bbbbb };");
  3999. verifyFormat("DoSomethingWithVector({} /* No data */);");
  4000. verifyFormat("DoSomethingWithVector({ {} /* No data */ }, { { 1, 2 } });");
  4001. verifyFormat(
  4002. "someFunction(OtherParam, BracedList{\n"
  4003. " // comment 1 (Forcing interesting break)\n"
  4004. " param1, param2,\n"
  4005. " // comment 2\n"
  4006. " param3, param4\n"
  4007. " });");
  4008. verifyFormat(
  4009. "std::this_thread::sleep_for(\n"
  4010. " std::chrono::nanoseconds{ std::chrono::seconds{ 1 } } / 5);");
  4011. FormatStyle NoSpaces = getLLVMStyle();
  4012. NoSpaces.Cpp11BracedListStyle = true;
  4013. verifyFormat("vector<int> x{1, 2, 3, 4};", NoSpaces);
  4014. verifyFormat("vector<T> x{{}, {}, {}, {}};", NoSpaces);
  4015. verifyFormat("f({1, 2});", NoSpaces);
  4016. verifyFormat("auto v = Foo{-1};", NoSpaces);
  4017. verifyFormat("f({1, 2}, {{2, 3}, {4, 5}}, c, {d});", NoSpaces);
  4018. verifyFormat("Class::Class : member{1, 2, 3} {}", NoSpaces);
  4019. verifyFormat("new vector<int>{1, 2, 3};", NoSpaces);
  4020. verifyFormat("new int[3]{1, 2, 3};", NoSpaces);
  4021. verifyFormat("return {arg1, arg2};", NoSpaces);
  4022. verifyFormat("return {arg1, SomeType{parameter}};", NoSpaces);
  4023. verifyFormat("new T{arg1, arg2};", NoSpaces);
  4024. verifyFormat("f(MyMap[{composite, key}]);", NoSpaces);
  4025. verifyFormat("class Class {\n"
  4026. " T member = {arg1, arg2};\n"
  4027. "};",
  4028. NoSpaces);
  4029. }
  4030. TEST_F(FormatTest, FormatsBracedListsinColumnLayout) {
  4031. verifyFormat("vector<int> x = { 1, 22, 333, 4444, 55555, 666666, 7777777,\n"
  4032. " 1, 22, 333, 4444, 55555, 666666, 7777777,\n"
  4033. " 1, 22, 333, 4444, 55555, 666666, 7777777,\n"
  4034. " 1, 22, 333, 4444, 55555, 666666, 7777777,\n"
  4035. " 1, 22, 333, 4444, 55555, 666666, 7777777,\n"
  4036. " 1, 22, 333, 4444, 55555, 666666, 7777777 };");
  4037. verifyFormat("vector<int> x = { 1, 22, 333, 4444, 55555, 666666, 7777777,\n"
  4038. " // line comment\n"
  4039. " 1, 22, 333, 4444, 55555, 666666, 7777777,\n"
  4040. " 1, 22, 333, 4444, 55555,\n"
  4041. " // line comment\n"
  4042. " 1, 22, 333, 4444, 55555, 666666, 7777777,\n"
  4043. " 1, 22, 333, 4444, 55555, 666666, 7777777 };");
  4044. verifyFormat(
  4045. "vector<int> x = { 1, 22, 333, 4444, 55555, 666666, 7777777,\n"
  4046. " 1, 22, 333, 4444, 55555, 666666, 7777777,\n"
  4047. " 1, 22, 333, 4444, 55555, 666666, // comment\n"
  4048. " 7777777, 1, 22, 333, 4444, 55555, 666666,\n"
  4049. " 7777777, 1, 22, 333, 4444, 55555, 666666,\n"
  4050. " 7777777, 1, 22, 333, 4444, 55555, 666666,\n"
  4051. " 7777777 };");
  4052. verifyFormat("static const uint16_t CallerSavedRegs64Bittttt[] = {\n"
  4053. " X86::RAX, X86::RDX, X86::RCX, X86::RSI, X86::RDI,\n"
  4054. " X86::R8, X86::R9, X86::R10, X86::R11, 0\n"
  4055. "};");
  4056. verifyFormat("vector<int> x = { 1, 1, 1, 1,\n"
  4057. " 1, 1, 1, 1 };",
  4058. getLLVMStyleWithColumns(39));
  4059. verifyFormat("vector<int> x = { 1, 1, 1, 1,\n"
  4060. " 1, 1, 1, 1 };",
  4061. getLLVMStyleWithColumns(38));
  4062. verifyFormat("vector<int> aaaaaaaaaaaaaaaaaaaaaa = {\n"
  4063. " 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1\n"
  4064. "};",
  4065. getLLVMStyleWithColumns(40));
  4066. // Trailing commas.
  4067. verifyFormat("vector<int> x = { 1, 1, 1, 1,\n"
  4068. " 1, 1, 1, 1, };",
  4069. getLLVMStyleWithColumns(39));
  4070. verifyFormat("vector<int> x = {\n"
  4071. " 1, 1, 1, 1, 1, 1, 1, 1, //\n"
  4072. "};",
  4073. getLLVMStyleWithColumns(39));
  4074. verifyFormat("vector<int> x = { 1, 1, 1, 1,\n"
  4075. " 1, 1, 1, 1,\n"
  4076. " /**/ /**/ };",
  4077. getLLVMStyleWithColumns(39));
  4078. verifyFormat("return { { aaaaaaaaaaaaaaaaaaaaa }, { aaaaaaaaaaaaaaaaaaa },\n"
  4079. " { aaaaaaaaaaaaaaaaaaaaa }, { aaaaaaaaaaaaaaaaa } };",
  4080. getLLVMStyleWithColumns(60));
  4081. }
  4082. TEST_F(FormatTest, PullTrivialFunctionDefinitionsIntoSingleLine) {
  4083. verifyFormat("void f() { return 42; }");
  4084. verifyFormat("void f() {\n"
  4085. " // Comment\n"
  4086. "}");
  4087. verifyFormat("{\n"
  4088. "#error {\n"
  4089. " int a;\n"
  4090. "}");
  4091. verifyFormat("{\n"
  4092. " int a;\n"
  4093. "#error {\n"
  4094. "}");
  4095. verifyFormat("void f() {} // comment");
  4096. verifyFormat("void f() { int a; } // comment");
  4097. verifyFormat("void f() {\n"
  4098. "} // comment",
  4099. getLLVMStyleWithColumns(15));
  4100. verifyFormat("void f() { return 42; }", getLLVMStyleWithColumns(23));
  4101. verifyFormat("void f() {\n return 42;\n}", getLLVMStyleWithColumns(22));
  4102. verifyFormat("void f() {}", getLLVMStyleWithColumns(11));
  4103. verifyFormat("void f() {\n}", getLLVMStyleWithColumns(10));
  4104. }
  4105. TEST_F(FormatTest, UnderstandContextOfRecordTypeKeywords) {
  4106. // Elaborate type variable declarations.
  4107. verifyFormat("struct foo a = { bar };\nint n;");
  4108. verifyFormat("class foo a = { bar };\nint n;");
  4109. verifyFormat("union foo a = { bar };\nint n;");
  4110. // Elaborate types inside function definitions.
  4111. verifyFormat("struct foo f() {}\nint n;");
  4112. verifyFormat("class foo f() {}\nint n;");
  4113. verifyFormat("union foo f() {}\nint n;");
  4114. // Templates.
  4115. verifyFormat("template <class X> void f() {}\nint n;");
  4116. verifyFormat("template <struct X> void f() {}\nint n;");
  4117. verifyFormat("template <union X> void f() {}\nint n;");
  4118. // Actual definitions...
  4119. verifyFormat("struct {\n} n;");
  4120. verifyFormat(
  4121. "template <template <class T, class Y>, class Z> class X {\n} n;");
  4122. verifyFormat("union Z {\n int n;\n} x;");
  4123. verifyFormat("class MACRO Z {\n} n;");
  4124. verifyFormat("class MACRO(X) Z {\n} n;");
  4125. verifyFormat("class __attribute__(X) Z {\n} n;");
  4126. verifyFormat("class __declspec(X) Z {\n} n;");
  4127. verifyFormat("class A##B##C {\n} n;");
  4128. verifyFormat("class alignas(16) Z {\n} n;");
  4129. // Redefinition from nested context:
  4130. verifyFormat("class A::B::C {\n} n;");
  4131. // Template definitions.
  4132. verifyFormat(
  4133. "template <typename F>\n"
  4134. "Matcher(const Matcher<F> &Other,\n"
  4135. " typename enable_if_c<is_base_of<F, T>::value &&\n"
  4136. " !is_same<F, T>::value>::type * = 0)\n"
  4137. " : Implementation(new ImplicitCastMatcher<F>(Other)) {}");
  4138. // FIXME: This is still incorrectly handled at the formatter side.
  4139. verifyFormat("template <> struct X < 15, i<3 && 42 < 50 && 33 < 28> {};");
  4140. // FIXME:
  4141. // This now gets parsed incorrectly as class definition.
  4142. // verifyFormat("class A<int> f() {\n}\nint n;");
  4143. // Elaborate types where incorrectly parsing the structural element would
  4144. // break the indent.
  4145. verifyFormat("if (true)\n"
  4146. " class X x;\n"
  4147. "else\n"
  4148. " f();\n");
  4149. // This is simply incomplete. Formatting is not important, but must not crash.
  4150. verifyFormat("class A:");
  4151. }
  4152. TEST_F(FormatTest, DoNotInterfereWithErrorAndWarning) {
  4153. verifyFormat("#error Leave all white!!!!! space* alone!\n");
  4154. verifyFormat("#warning Leave all white!!!!! space* alone!\n");
  4155. EXPECT_EQ("#error 1", format(" # error 1"));
  4156. EXPECT_EQ("#warning 1", format(" # warning 1"));
  4157. }
  4158. TEST_F(FormatTest, FormatHashIfExpressions) {
  4159. // FIXME: Come up with a better indentation for #elif.
  4160. verifyFormat(
  4161. "#if !defined(AAAAAAA) && (defined CCCCCC || defined DDDDDD) && \\\n"
  4162. " defined(BBBBBBBB)\n"
  4163. "#elif !defined(AAAAAA) && (defined CCCCC || defined DDDDDD) && \\\n"
  4164. " defined(BBBBBBBB)\n"
  4165. "#endif",
  4166. getLLVMStyleWithColumns(65));
  4167. }
  4168. TEST_F(FormatTest, MergeHandlingInTheFaceOfPreprocessorDirectives) {
  4169. FormatStyle AllowsMergedIf = getGoogleStyle();
  4170. AllowsMergedIf.AllowShortIfStatementsOnASingleLine = true;
  4171. verifyFormat("void f() { f(); }\n#error E", AllowsMergedIf);
  4172. verifyFormat("if (true) return 42;\n#error E", AllowsMergedIf);
  4173. verifyFormat("if (true)\n#error E\n return 42;", AllowsMergedIf);
  4174. EXPECT_EQ("if (true) return 42;",
  4175. format("if (true)\nreturn 42;", AllowsMergedIf));
  4176. FormatStyle ShortMergedIf = AllowsMergedIf;
  4177. ShortMergedIf.ColumnLimit = 25;
  4178. verifyFormat("#define A \\\n"
  4179. " if (true) return 42;",
  4180. ShortMergedIf);
  4181. verifyFormat("#define A \\\n"
  4182. " f(); \\\n"
  4183. " if (true)\n"
  4184. "#define B",
  4185. ShortMergedIf);
  4186. verifyFormat("#define A \\\n"
  4187. " f(); \\\n"
  4188. " if (true)\n"
  4189. "g();",
  4190. ShortMergedIf);
  4191. verifyFormat("{\n"
  4192. "#ifdef A\n"
  4193. " // Comment\n"
  4194. " if (true) continue;\n"
  4195. "#endif\n"
  4196. " // Comment\n"
  4197. " if (true) continue;",
  4198. ShortMergedIf);
  4199. }
  4200. TEST_F(FormatTest, BlockCommentsInControlLoops) {
  4201. verifyFormat("if (0) /* a comment in a strange place */ {\n"
  4202. " f();\n"
  4203. "}");
  4204. verifyFormat("if (0) /* a comment in a strange place */ {\n"
  4205. " f();\n"
  4206. "} /* another comment */ else /* comment #3 */ {\n"
  4207. " g();\n"
  4208. "}");
  4209. verifyFormat("while (0) /* a comment in a strange place */ {\n"
  4210. " f();\n"
  4211. "}");
  4212. verifyFormat("for (;;) /* a comment in a strange place */ {\n"
  4213. " f();\n"
  4214. "}");
  4215. verifyFormat("do /* a comment in a strange place */ {\n"
  4216. " f();\n"
  4217. "} /* another comment */ while (0);");
  4218. }
  4219. TEST_F(FormatTest, BlockComments) {
  4220. EXPECT_EQ("/* */ /* */ /* */\n/* */ /* */ /* */",
  4221. format("/* *//* */ /* */\n/* *//* */ /* */"));
  4222. EXPECT_EQ("/* */ a /* */ b;", format(" /* */ a/* */ b;"));
  4223. EXPECT_EQ("#define A /*123*/ \\\n"
  4224. " b\n"
  4225. "/* */\n"
  4226. "someCall(\n"
  4227. " parameter);",
  4228. format("#define A /*123*/ b\n"
  4229. "/* */\n"
  4230. "someCall(parameter);",
  4231. getLLVMStyleWithColumns(15)));
  4232. EXPECT_EQ("#define A\n"
  4233. "/* */ someCall(\n"
  4234. " parameter);",
  4235. format("#define A\n"
  4236. "/* */someCall(parameter);",
  4237. getLLVMStyleWithColumns(15)));
  4238. EXPECT_EQ("/*\n**\n*/", format("/*\n**\n*/"));
  4239. EXPECT_EQ("/*\n"
  4240. "*\n"
  4241. " * aaaaaa\n"
  4242. "*aaaaaa\n"
  4243. "*/",
  4244. format("/*\n"
  4245. "*\n"
  4246. " * aaaaaa aaaaaa\n"
  4247. "*/",
  4248. getLLVMStyleWithColumns(10)));
  4249. EXPECT_EQ("/*\n"
  4250. "**\n"
  4251. "* aaaaaa\n"
  4252. "*aaaaaa\n"
  4253. "*/",
  4254. format("/*\n"
  4255. "**\n"
  4256. "* aaaaaa aaaaaa\n"
  4257. "*/",
  4258. getLLVMStyleWithColumns(10)));
  4259. FormatStyle NoBinPacking = getLLVMStyle();
  4260. NoBinPacking.BinPackParameters = false;
  4261. EXPECT_EQ("someFunction(1, /* comment 1 */\n"
  4262. " 2, /* comment 2 */\n"
  4263. " 3, /* comment 3 */\n"
  4264. " aaaa,\n"
  4265. " bbbb);",
  4266. format("someFunction (1, /* comment 1 */\n"
  4267. " 2, /* comment 2 */ \n"
  4268. " 3, /* comment 3 */\n"
  4269. "aaaa, bbbb );",
  4270. NoBinPacking));
  4271. verifyFormat(
  4272. "bool aaaaaaaaaaaaa = /* comment: */ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
  4273. " aaaaaaaaaaaaaaaaaaaaaaaaaaaa;");
  4274. EXPECT_EQ(
  4275. "bool aaaaaaaaaaaaa = /* trailing comment */\n"
  4276. " aaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
  4277. " aaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaa;",
  4278. format(
  4279. "bool aaaaaaaaaaaaa = /* trailing comment */\n"
  4280. " aaaaaaaaaaaaaaaaaaaaaaaaaaa||aaaaaaaaaaaaaaaaaaaaaaaaa ||\n"
  4281. " aaaaaaaaaaaaaaaaaaaaaaaaaaaa || aaaaaaaaaaaaaaaaaaaaaaaaaa;"));
  4282. EXPECT_EQ(
  4283. "int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa; /* comment */\n"
  4284. "int bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; /* comment */\n"
  4285. "int cccccccccccccccccccccccccccccc; /* comment */\n",
  4286. format("int aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa; /* comment */\n"
  4287. "int bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb; /* comment */\n"
  4288. "int cccccccccccccccccccccccccccccc; /* comment */\n"));
  4289. verifyFormat("void f(int * /* unused */) {}");
  4290. EXPECT_EQ("/*\n"
  4291. " **\n"
  4292. " */",
  4293. format("/*\n"
  4294. " **\n"
  4295. " */"));
  4296. EXPECT_EQ("/*\n"
  4297. " *q\n"
  4298. " */",
  4299. format("/*\n"
  4300. " *q\n"
  4301. " */"));
  4302. EXPECT_EQ("/*\n"
  4303. " * q\n"
  4304. " */",
  4305. format("/*\n"
  4306. " * q\n"
  4307. " */"));
  4308. EXPECT_EQ("/*\n"
  4309. " **/",
  4310. format("/*\n"
  4311. " **/"));
  4312. EXPECT_EQ("/*\n"
  4313. " ***/",
  4314. format("/*\n"
  4315. " ***/"));
  4316. }
  4317. TEST_F(FormatTest, BlockCommentsInMacros) {
  4318. EXPECT_EQ("#define A \\\n"
  4319. " { \\\n"
  4320. " /* one line */ \\\n"
  4321. " someCall();",
  4322. format("#define A { \\\n"
  4323. " /* one line */ \\\n"
  4324. " someCall();",
  4325. getLLVMStyleWithColumns(20)));
  4326. EXPECT_EQ("#define A \\\n"
  4327. " { \\\n"
  4328. " /* previous */ \\\n"
  4329. " /* one line */ \\\n"
  4330. " someCall();",
  4331. format("#define A { \\\n"
  4332. " /* previous */ \\\n"
  4333. " /* one line */ \\\n"
  4334. " someCall();",
  4335. getLLVMStyleWithColumns(20)));
  4336. }
  4337. TEST_F(FormatTest, BlockCommentsAtEndOfLine) {
  4338. EXPECT_EQ("a = {\n"
  4339. " 1111 /* */\n"
  4340. "};",
  4341. format("a = {1111 /* */\n"
  4342. "};",
  4343. getLLVMStyleWithColumns(15)));
  4344. EXPECT_EQ("a = {\n"
  4345. " 1111 /* */\n"
  4346. "};",
  4347. format("a = {1111 /* */\n"
  4348. "};",
  4349. getLLVMStyleWithColumns(15)));
  4350. // FIXME: The formatting is still wrong here.
  4351. EXPECT_EQ("a = {\n"
  4352. " 1111 /* a\n"
  4353. " */\n"
  4354. "};",
  4355. format("a = {1111 /* a */\n"
  4356. "};",
  4357. getLLVMStyleWithColumns(15)));
  4358. }
  4359. TEST_F(FormatTest, IndentLineCommentsInStartOfBlockAtEndOfFile) {
  4360. // FIXME: This is not what we want...
  4361. verifyFormat("{\n"
  4362. "// a"
  4363. "// b");
  4364. }
  4365. TEST_F(FormatTest, FormatStarDependingOnContext) {
  4366. verifyFormat("void f(int *a);");
  4367. verifyFormat("void f() { f(fint * b); }");
  4368. verifyFormat("class A {\n void f(int *a);\n};");
  4369. verifyFormat("class A {\n int *a;\n};");
  4370. verifyFormat("namespace a {\n"
  4371. "namespace b {\n"
  4372. "class A {\n"
  4373. " void f() {}\n"
  4374. " int *a;\n"
  4375. "};\n"
  4376. "}\n"
  4377. "}");
  4378. }
  4379. TEST_F(FormatTest, SpecialTokensAtEndOfLine) {
  4380. verifyFormat("while");
  4381. verifyFormat("operator");
  4382. }
  4383. //===----------------------------------------------------------------------===//
  4384. // Objective-C tests.
  4385. //===----------------------------------------------------------------------===//
  4386. TEST_F(FormatTest, FormatForObjectiveCMethodDecls) {
  4387. verifyFormat("- (void)sendAction:(SEL)aSelector to:(BOOL)anObject;");
  4388. EXPECT_EQ("- (NSUInteger)indexOfObject:(id)anObject;",
  4389. format("-(NSUInteger)indexOfObject:(id)anObject;"));
  4390. EXPECT_EQ("- (NSInteger)Mthod1;", format("-(NSInteger)Mthod1;"));
  4391. EXPECT_EQ("+ (id)Mthod2;", format("+(id)Mthod2;"));
  4392. EXPECT_EQ("- (NSInteger)Method3:(id)anObject;",
  4393. format("-(NSInteger)Method3:(id)anObject;"));
  4394. EXPECT_EQ("- (NSInteger)Method4:(id)anObject;",
  4395. format("-(NSInteger)Method4:(id)anObject;"));
  4396. EXPECT_EQ("- (NSInteger)Method5:(id)anObject:(id)AnotherObject;",
  4397. format("-(NSInteger)Method5:(id)anObject:(id)AnotherObject;"));
  4398. EXPECT_EQ("- (id)Method6:(id)A:(id)B:(id)C:(id)D;",
  4399. format("- (id)Method6:(id)A:(id)B:(id)C:(id)D;"));
  4400. EXPECT_EQ(
  4401. "- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;",
  4402. format(
  4403. "- (void)sendAction:(SEL)aSelector to:(id)anObject forAllCells:(BOOL)flag;"));
  4404. // Very long objectiveC method declaration.
  4405. verifyFormat("- (NSUInteger)indexOfObject:(id)anObject\n"
  4406. " inRange:(NSRange)range\n"
  4407. " outRange:(NSRange)out_range\n"
  4408. " outRange1:(NSRange)out_range1\n"
  4409. " outRange2:(NSRange)out_range2\n"
  4410. " outRange3:(NSRange)out_range3\n"
  4411. " outRange4:(NSRange)out_range4\n"
  4412. " outRange5:(NSRange)out_range5\n"
  4413. " outRange6:(NSRange)out_range6\n"
  4414. " outRange7:(NSRange)out_range7\n"
  4415. " outRange8:(NSRange)out_range8\n"
  4416. " outRange9:(NSRange)out_range9;");
  4417. verifyFormat("- (int)sum:(vector<int>)numbers;");
  4418. verifyGoogleFormat("- (void)setDelegate:(id<Protocol>)delegate;");
  4419. // FIXME: In LLVM style, there should be a space in front of a '<' for ObjC
  4420. // protocol lists (but not for template classes):
  4421. //verifyFormat("- (void)setDelegate:(id <Protocol>)delegate;");
  4422. verifyFormat("- (int (*)())foo:(int (*)())f;");
  4423. verifyGoogleFormat("- (int (*)())foo:(int (*)())foo;");
  4424. // If there's no return type (very rare in practice!), LLVM and Google style
  4425. // agree.
  4426. verifyFormat("- foo;");
  4427. verifyFormat("- foo:(int)f;");
  4428. verifyGoogleFormat("- foo:(int)foo;");
  4429. }
  4430. TEST_F(FormatTest, FormatObjCBlocks) {
  4431. verifyFormat("int (^Block)(int, int);");
  4432. verifyFormat("int (^Block1)(int, int) = ^(int i, int j)");
  4433. }
  4434. TEST_F(FormatTest, FormatObjCInterface) {
  4435. verifyFormat("@interface Foo : NSObject <NSSomeDelegate> {\n"
  4436. "@public\n"
  4437. " int field1;\n"
  4438. "@protected\n"
  4439. " int field2;\n"
  4440. "@private\n"
  4441. " int field3;\n"
  4442. "@package\n"
  4443. " int field4;\n"
  4444. "}\n"
  4445. "+ (id)init;\n"
  4446. "@end");
  4447. verifyGoogleFormat("@interface Foo : NSObject<NSSomeDelegate> {\n"
  4448. " @public\n"
  4449. " int field1;\n"
  4450. " @protected\n"
  4451. " int field2;\n"
  4452. " @private\n"
  4453. " int field3;\n"
  4454. " @package\n"
  4455. " int field4;\n"
  4456. "}\n"
  4457. "+ (id)init;\n"
  4458. "@end");
  4459. verifyFormat("@interface /* wait for it */ Foo\n"
  4460. "+ (id)init;\n"
  4461. "// Look, a comment!\n"
  4462. "- (int)answerWith:(int)i;\n"
  4463. "@end");
  4464. verifyFormat("@interface Foo\n"
  4465. "@end\n"
  4466. "@interface Bar\n"
  4467. "@end");
  4468. verifyFormat("@interface Foo : Bar\n"
  4469. "+ (id)init;\n"
  4470. "@end");
  4471. verifyFormat("@interface Foo : /**/ Bar /**/ <Baz, /**/ Quux>\n"
  4472. "+ (id)init;\n"
  4473. "@end");
  4474. verifyGoogleFormat("@interface Foo : Bar<Baz, Quux>\n"
  4475. "+ (id)init;\n"
  4476. "@end");
  4477. verifyFormat("@interface Foo (HackStuff)\n"
  4478. "+ (id)init;\n"
  4479. "@end");
  4480. verifyFormat("@interface Foo ()\n"
  4481. "+ (id)init;\n"
  4482. "@end");
  4483. verifyFormat("@interface Foo (HackStuff) <MyProtocol>\n"
  4484. "+ (id)init;\n"
  4485. "@end");
  4486. verifyGoogleFormat("@interface Foo (HackStuff)<MyProtocol>\n"
  4487. "+ (id)init;\n"
  4488. "@end");
  4489. verifyFormat("@interface Foo {\n"
  4490. " int _i;\n"
  4491. "}\n"
  4492. "+ (id)init;\n"
  4493. "@end");
  4494. verifyFormat("@interface Foo : Bar {\n"
  4495. " int _i;\n"
  4496. "}\n"
  4497. "+ (id)init;\n"
  4498. "@end");
  4499. verifyFormat("@interface Foo : Bar <Baz, Quux> {\n"
  4500. " int _i;\n"
  4501. "}\n"
  4502. "+ (id)init;\n"
  4503. "@end");
  4504. verifyFormat("@interface Foo (HackStuff) {\n"
  4505. " int _i;\n"
  4506. "}\n"
  4507. "+ (id)init;\n"
  4508. "@end");
  4509. verifyFormat("@interface Foo () {\n"
  4510. " int _i;\n"
  4511. "}\n"
  4512. "+ (id)init;\n"
  4513. "@end");
  4514. verifyFormat("@interface Foo (HackStuff) <MyProtocol> {\n"
  4515. " int _i;\n"
  4516. "}\n"
  4517. "+ (id)init;\n"
  4518. "@end");
  4519. }
  4520. TEST_F(FormatTest, FormatObjCImplementation) {
  4521. verifyFormat("@implementation Foo : NSObject {\n"
  4522. "@public\n"
  4523. " int field1;\n"
  4524. "@protected\n"
  4525. " int field2;\n"
  4526. "@private\n"
  4527. " int field3;\n"
  4528. "@package\n"
  4529. " int field4;\n"
  4530. "}\n"
  4531. "+ (id)init {\n}\n"
  4532. "@end");
  4533. verifyGoogleFormat("@implementation Foo : NSObject {\n"
  4534. " @public\n"
  4535. " int field1;\n"
  4536. " @protected\n"
  4537. " int field2;\n"
  4538. " @private\n"
  4539. " int field3;\n"
  4540. " @package\n"
  4541. " int field4;\n"
  4542. "}\n"
  4543. "+ (id)init {\n}\n"
  4544. "@end");
  4545. verifyFormat("@implementation Foo\n"
  4546. "+ (id)init {\n"
  4547. " if (true)\n"
  4548. " return nil;\n"
  4549. "}\n"
  4550. "// Look, a comment!\n"
  4551. "- (int)answerWith:(int)i {\n"
  4552. " return i;\n"
  4553. "}\n"
  4554. "+ (int)answerWith:(int)i {\n"
  4555. " return i;\n"
  4556. "}\n"
  4557. "@end");
  4558. verifyFormat("@implementation Foo\n"
  4559. "@end\n"
  4560. "@implementation Bar\n"
  4561. "@end");
  4562. verifyFormat("@implementation Foo : Bar\n"
  4563. "+ (id)init {\n}\n"
  4564. "- (void)foo {\n}\n"
  4565. "@end");
  4566. verifyFormat("@implementation Foo {\n"
  4567. " int _i;\n"
  4568. "}\n"
  4569. "+ (id)init {\n}\n"
  4570. "@end");
  4571. verifyFormat("@implementation Foo : Bar {\n"
  4572. " int _i;\n"
  4573. "}\n"
  4574. "+ (id)init {\n}\n"
  4575. "@end");
  4576. verifyFormat("@implementation Foo (HackStuff)\n"
  4577. "+ (id)init {\n}\n"
  4578. "@end");
  4579. verifyFormat("@implementation ObjcClass\n"
  4580. "- (void)method;\n"
  4581. "{}\n"
  4582. "@end");
  4583. }
  4584. TEST_F(FormatTest, FormatObjCProtocol) {
  4585. verifyFormat("@protocol Foo\n"
  4586. "@property(weak) id delegate;\n"
  4587. "- (NSUInteger)numberOfThings;\n"
  4588. "@end");
  4589. verifyFormat("@protocol MyProtocol <NSObject>\n"
  4590. "- (NSUInteger)numberOfThings;\n"
  4591. "@end");
  4592. verifyGoogleFormat("@protocol MyProtocol<NSObject>\n"
  4593. "- (NSUInteger)numberOfThings;\n"
  4594. "@end");
  4595. verifyFormat("@protocol Foo;\n"
  4596. "@protocol Bar;\n");
  4597. verifyFormat("@protocol Foo\n"
  4598. "@end\n"
  4599. "@protocol Bar\n"
  4600. "@end");
  4601. verifyFormat("@protocol myProtocol\n"
  4602. "- (void)mandatoryWithInt:(int)i;\n"
  4603. "@optional\n"
  4604. "- (void)optional;\n"
  4605. "@required\n"
  4606. "- (void)required;\n"
  4607. "@optional\n"
  4608. "@property(assign) int madProp;\n"
  4609. "@end\n");
  4610. verifyFormat("@property(nonatomic, assign, readonly)\n"
  4611. " int *looooooooooooooooooooooooooooongNumber;\n"
  4612. "@property(nonatomic, assign, readonly)\n"
  4613. " NSString *looooooooooooooooooooooooooooongName;");
  4614. }
  4615. TEST_F(FormatTest, FormatObjCMethodDeclarations) {
  4616. verifyFormat("- (void)doSomethingWith:(GTMFoo *)theFoo\n"
  4617. " rect:(NSRect)theRect\n"
  4618. " interval:(float)theInterval {\n"
  4619. "}");
  4620. verifyFormat("- (void)shortf:(GTMFoo *)theFoo\n"
  4621. " longKeyword:(NSRect)theRect\n"
  4622. " evenLongerKeyword:(float)theInterval\n"
  4623. " error:(NSError **)theError {\n"
  4624. "}");
  4625. }
  4626. TEST_F(FormatTest, FormatObjCMethodExpr) {
  4627. verifyFormat("[foo bar:baz];");
  4628. verifyFormat("return [foo bar:baz];");
  4629. verifyFormat("f([foo bar:baz]);");
  4630. verifyFormat("f(2, [foo bar:baz]);");
  4631. verifyFormat("f(2, a ? b : c);");
  4632. verifyFormat("[[self initWithInt:4] bar:[baz quux:arrrr]];");
  4633. // Unary operators.
  4634. verifyFormat("int a = +[foo bar:baz];");
  4635. verifyFormat("int a = -[foo bar:baz];");
  4636. verifyFormat("int a = ![foo bar:baz];");
  4637. verifyFormat("int a = ~[foo bar:baz];");
  4638. verifyFormat("int a = ++[foo bar:baz];");
  4639. verifyFormat("int a = --[foo bar:baz];");
  4640. verifyFormat("int a = sizeof [foo bar:baz];");
  4641. verifyFormat("int a = alignof [foo bar:baz];", getGoogleStyle());
  4642. verifyFormat("int a = &[foo bar:baz];");
  4643. verifyFormat("int a = *[foo bar:baz];");
  4644. // FIXME: Make casts work, without breaking f()[4].
  4645. //verifyFormat("int a = (int)[foo bar:baz];");
  4646. //verifyFormat("return (int)[foo bar:baz];");
  4647. //verifyFormat("(void)[foo bar:baz];");
  4648. verifyFormat("return (MyType *)[self.tableView cellForRowAtIndexPath:cell];");
  4649. // Binary operators.
  4650. verifyFormat("[foo bar:baz], [foo bar:baz];");
  4651. verifyFormat("[foo bar:baz] = [foo bar:baz];");
  4652. verifyFormat("[foo bar:baz] *= [foo bar:baz];");
  4653. verifyFormat("[foo bar:baz] /= [foo bar:baz];");
  4654. verifyFormat("[foo bar:baz] %= [foo bar:baz];");
  4655. verifyFormat("[foo bar:baz] += [foo bar:baz];");
  4656. verifyFormat("[foo bar:baz] -= [foo bar:baz];");
  4657. verifyFormat("[foo bar:baz] <<= [foo bar:baz];");
  4658. verifyFormat("[foo bar:baz] >>= [foo bar:baz];");
  4659. verifyFormat("[foo bar:baz] &= [foo bar:baz];");
  4660. verifyFormat("[foo bar:baz] ^= [foo bar:baz];");
  4661. verifyFormat("[foo bar:baz] |= [foo bar:baz];");
  4662. verifyFormat("[foo bar:baz] ? [foo bar:baz] : [foo bar:baz];");
  4663. verifyFormat("[foo bar:baz] || [foo bar:baz];");
  4664. verifyFormat("[foo bar:baz] && [foo bar:baz];");
  4665. verifyFormat("[foo bar:baz] | [foo bar:baz];");
  4666. verifyFormat("[foo bar:baz] ^ [foo bar:baz];");
  4667. verifyFormat("[foo bar:baz] & [foo bar:baz];");
  4668. verifyFormat("[foo bar:baz] == [foo bar:baz];");
  4669. verifyFormat("[foo bar:baz] != [foo bar:baz];");
  4670. verifyFormat("[foo bar:baz] >= [foo bar:baz];");
  4671. verifyFormat("[foo bar:baz] <= [foo bar:baz];");
  4672. verifyFormat("[foo bar:baz] > [foo bar:baz];");
  4673. verifyFormat("[foo bar:baz] < [foo bar:baz];");
  4674. verifyFormat("[foo bar:baz] >> [foo bar:baz];");
  4675. verifyFormat("[foo bar:baz] << [foo bar:baz];");
  4676. verifyFormat("[foo bar:baz] - [foo bar:baz];");
  4677. verifyFormat("[foo bar:baz] + [foo bar:baz];");
  4678. verifyFormat("[foo bar:baz] * [foo bar:baz];");
  4679. verifyFormat("[foo bar:baz] / [foo bar:baz];");
  4680. verifyFormat("[foo bar:baz] % [foo bar:baz];");
  4681. // Whew!
  4682. verifyFormat("return in[42];");
  4683. verifyFormat("for (id foo in [self getStuffFor:bla]) {\n"
  4684. "}");
  4685. verifyFormat("[self stuffWithInt:(4 + 2) float:4.5];");
  4686. verifyFormat("[self stuffWithInt:a ? b : c float:4.5];");
  4687. verifyFormat("[self stuffWithInt:a ? [self foo:bar] : c];");
  4688. verifyFormat("[self stuffWithInt:a ? (e ? f : g) : c];");
  4689. verifyFormat("[cond ? obj1 : obj2 methodWithParam:param]");
  4690. verifyFormat("[button setAction:@selector(zoomOut:)];");
  4691. verifyFormat("[color getRed:&r green:&g blue:&b alpha:&a];");
  4692. verifyFormat("arr[[self indexForFoo:a]];");
  4693. verifyFormat("throw [self errorFor:a];");
  4694. verifyFormat("@throw [self errorFor:a];");
  4695. verifyFormat("[(id)foo bar:(id)baz quux:(id)snorf];");
  4696. verifyFormat("[(id)foo bar:(id) ? baz : quux];");
  4697. verifyFormat("4 > 4 ? (id)a : (id)baz;");
  4698. // This tests that the formatter doesn't break after "backing" but before ":",
  4699. // which would be at 80 columns.
  4700. verifyFormat(
  4701. "void f() {\n"
  4702. " if ((self = [super initWithContentRect:contentRect\n"
  4703. " styleMask:styleMask ?: otherMask\n"
  4704. " backing:NSBackingStoreBuffered\n"
  4705. " defer:YES]))");
  4706. verifyFormat(
  4707. "[foo checkThatBreakingAfterColonWorksOk:\n"
  4708. " [bar ifItDoes:reduceOverallLineLengthLikeInThisCase]];");
  4709. verifyFormat("[myObj short:arg1 // Force line break\n"
  4710. " longKeyword:arg2 != nil ? arg2 : @\"longKeyword\"\n"
  4711. " evenLongerKeyword:arg3 ?: @\"evenLongerKeyword\"\n"
  4712. " error:arg4];");
  4713. verifyFormat(
  4714. "void f() {\n"
  4715. " popup_window_.reset([[RenderWidgetPopupWindow alloc]\n"
  4716. " initWithContentRect:NSMakeRect(origin_global.x, origin_global.y,\n"
  4717. " pos.width(), pos.height())\n"
  4718. " styleMask:NSBorderlessWindowMask\n"
  4719. " backing:NSBackingStoreBuffered\n"
  4720. " defer:NO]);\n"
  4721. "}");
  4722. verifyFormat("[contentsContainer replaceSubview:[subviews objectAtIndex:0]\n"
  4723. " with:contentsNativeView];");
  4724. verifyFormat(
  4725. "[pboard addTypes:[NSArray arrayWithObject:kBookmarkButtonDragType]\n"
  4726. " owner:nillllll];");
  4727. verifyFormat(
  4728. "[pboard setData:[NSData dataWithBytes:&button length:sizeof(button)]\n"
  4729. " forType:kBookmarkButtonDragType];");
  4730. verifyFormat("[defaultCenter addObserver:self\n"
  4731. " selector:@selector(willEnterFullscreen)\n"
  4732. " name:kWillEnterFullscreenNotification\n"
  4733. " object:nil];");
  4734. verifyFormat("[image_rep drawInRect:drawRect\n"
  4735. " fromRect:NSZeroRect\n"
  4736. " operation:NSCompositeCopy\n"
  4737. " fraction:1.0\n"
  4738. " respectFlipped:NO\n"
  4739. " hints:nil];");
  4740. verifyFormat(
  4741. "scoped_nsobject<NSTextField> message(\n"
  4742. " // The frame will be fixed up when |-setMessageText:| is called.\n"
  4743. " [[NSTextField alloc] initWithFrame:NSMakeRect(0, 0, 0, 0)]);");
  4744. verifyFormat("[self aaaaaa:bbbbbbbbbbbbb\n"
  4745. " aaaaaaaaaa:bbbbbbbbbbbbbbbbb\n"
  4746. " aaaaa:bbbbbbbbbbb + bbbbbbbbbbbb\n"
  4747. " aaaa:bbb];");
  4748. }
  4749. TEST_F(FormatTest, ObjCAt) {
  4750. verifyFormat("@autoreleasepool");
  4751. verifyFormat("@catch");
  4752. verifyFormat("@class");
  4753. verifyFormat("@compatibility_alias");
  4754. verifyFormat("@defs");
  4755. verifyFormat("@dynamic");
  4756. verifyFormat("@encode");
  4757. verifyFormat("@end");
  4758. verifyFormat("@finally");
  4759. verifyFormat("@implementation");
  4760. verifyFormat("@import");
  4761. verifyFormat("@interface");
  4762. verifyFormat("@optional");
  4763. verifyFormat("@package");
  4764. verifyFormat("@private");
  4765. verifyFormat("@property");
  4766. verifyFormat("@protected");
  4767. verifyFormat("@protocol");
  4768. verifyFormat("@public");
  4769. verifyFormat("@required");
  4770. verifyFormat("@selector");
  4771. verifyFormat("@synchronized");
  4772. verifyFormat("@synthesize");
  4773. verifyFormat("@throw");
  4774. verifyFormat("@try");
  4775. EXPECT_EQ("@interface", format("@ interface"));
  4776. // The precise formatting of this doesn't matter, nobody writes code like
  4777. // this.
  4778. verifyFormat("@ /*foo*/ interface");
  4779. }
  4780. TEST_F(FormatTest, ObjCSnippets) {
  4781. verifyFormat("@autoreleasepool {\n"
  4782. " foo();\n"
  4783. "}");
  4784. verifyFormat("@class Foo, Bar;");
  4785. verifyFormat("@compatibility_alias AliasName ExistingClass;");
  4786. verifyFormat("@dynamic textColor;");
  4787. verifyFormat("char *buf1 = @encode(int *);");
  4788. verifyFormat("char *buf1 = @encode(typeof(4 * 5));");
  4789. verifyFormat("char *buf1 = @encode(int **);");
  4790. verifyFormat("Protocol *proto = @protocol(p1);");
  4791. verifyFormat("SEL s = @selector(foo:);");
  4792. verifyFormat("@synchronized(self) {\n"
  4793. " f();\n"
  4794. "}");
  4795. verifyFormat("@synthesize dropArrowPosition = dropArrowPosition_;");
  4796. verifyGoogleFormat("@synthesize dropArrowPosition = dropArrowPosition_;");
  4797. verifyFormat("@property(assign, nonatomic) CGFloat hoverAlpha;");
  4798. verifyFormat("@property(assign, getter=isEditable) BOOL editable;");
  4799. verifyGoogleFormat("@property(assign, getter=isEditable) BOOL editable;");
  4800. verifyFormat("@import foo.bar;\n"
  4801. "@import baz;");
  4802. }
  4803. TEST_F(FormatTest, ObjCLiterals) {
  4804. verifyFormat("@\"String\"");
  4805. verifyFormat("@1");
  4806. verifyFormat("@+4.8");
  4807. verifyFormat("@-4");
  4808. verifyFormat("@1LL");
  4809. verifyFormat("@.5");
  4810. verifyFormat("@'c'");
  4811. verifyFormat("@true");
  4812. verifyFormat("NSNumber *smallestInt = @(-INT_MAX - 1);");
  4813. verifyFormat("NSNumber *piOverTwo = @(M_PI / 2);");
  4814. verifyFormat("NSNumber *favoriteColor = @(Green);");
  4815. verifyFormat("NSString *path = @(getenv(\"PATH\"));");
  4816. verifyFormat("@[");
  4817. verifyFormat("@[]");
  4818. verifyFormat(
  4819. "NSArray *array = @[ @\" Hey \", NSApp, [NSNumber numberWithInt:42] ];");
  4820. verifyFormat("return @[ @3, @[], @[ @4, @5 ] ];");
  4821. verifyFormat("@{");
  4822. verifyFormat("@{}");
  4823. verifyFormat("@{ @\"one\" : @1 }");
  4824. verifyFormat("return @{ @\"one\" : @1 };");
  4825. verifyFormat("@{ @\"one\" : @1, }");
  4826. verifyFormat("@{ @\"one\" : @{ @2 : @1 } }");
  4827. verifyFormat("@{ @\"one\" : @{ @2 : @1 }, }");
  4828. verifyFormat("@{ 1 > 2 ? @\"one\" : @\"two\" : 1 > 2 ? @1 : @2 }");
  4829. verifyFormat("[self setDict:@{}");
  4830. verifyFormat("[self setDict:@{ @1 : @2 }");
  4831. verifyFormat("NSLog(@\"%@\", @{ @1 : @2, @2 : @3 }[@1]);");
  4832. verifyFormat(
  4833. "NSDictionary *masses = @{ @\"H\" : @1.0078, @\"He\" : @4.0026 };");
  4834. verifyFormat(
  4835. "NSDictionary *settings = @{ AVEncoderKey : @(AVAudioQualityMax) };");
  4836. // FIXME: Nested and multi-line array and dictionary literals need more work.
  4837. verifyFormat(
  4838. "NSDictionary *d = @{ @\"nam\" : NSUserNam(), @\"dte\" : [NSDate date],\n"
  4839. " @\"processInfo\" : [NSProcessInfo processInfo] };");
  4840. verifyFormat(
  4841. "@{ NSFontAttributeNameeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee :\n"
  4842. " regularFont, };");
  4843. }
  4844. TEST_F(FormatTest, ReformatRegionAdjustsIndent) {
  4845. EXPECT_EQ("{\n"
  4846. "{\n"
  4847. "a;\n"
  4848. "b;\n"
  4849. "}\n"
  4850. "}",
  4851. format("{\n"
  4852. "{\n"
  4853. "a;\n"
  4854. " b;\n"
  4855. "}\n"
  4856. "}",
  4857. 13, 2, getLLVMStyle()));
  4858. EXPECT_EQ("{\n"
  4859. "{\n"
  4860. " a;\n"
  4861. "b;\n"
  4862. "}\n"
  4863. "}",
  4864. format("{\n"
  4865. "{\n"
  4866. " a;\n"
  4867. "b;\n"
  4868. "}\n"
  4869. "}",
  4870. 9, 2, getLLVMStyle()));
  4871. EXPECT_EQ("{\n"
  4872. "{\n"
  4873. "public:\n"
  4874. " b;\n"
  4875. "}\n"
  4876. "}",
  4877. format("{\n"
  4878. "{\n"
  4879. "public:\n"
  4880. " b;\n"
  4881. "}\n"
  4882. "}",
  4883. 17, 2, getLLVMStyle()));
  4884. EXPECT_EQ("{\n"
  4885. "{\n"
  4886. "a;\n"
  4887. "}\n"
  4888. "{\n"
  4889. " b; //\n"
  4890. "}\n"
  4891. "}",
  4892. format("{\n"
  4893. "{\n"
  4894. "a;\n"
  4895. "}\n"
  4896. "{\n"
  4897. " b; //\n"
  4898. "}\n"
  4899. "}",
  4900. 22, 2, getLLVMStyle()));
  4901. EXPECT_EQ(" {\n"
  4902. " a; //\n"
  4903. " }",
  4904. format(" {\n"
  4905. "a; //\n"
  4906. " }",
  4907. 4, 2, getLLVMStyle()));
  4908. EXPECT_EQ("void f() {}\n"
  4909. "void g() {}",
  4910. format("void f() {}\n"
  4911. "void g() {}",
  4912. 13, 0, getLLVMStyle()));
  4913. EXPECT_EQ("int a; // comment\n"
  4914. " // line 2\n"
  4915. "int b;",
  4916. format("int a; // comment\n"
  4917. " // line 2\n"
  4918. " int b;",
  4919. 35, 0, getLLVMStyle()));
  4920. EXPECT_EQ(" int a;\n"
  4921. " void\n"
  4922. " ffffff() {\n"
  4923. " }",
  4924. format(" int a;\n"
  4925. "void ffffff() {}",
  4926. 11, 0, getLLVMStyleWithColumns(11)));
  4927. }
  4928. TEST_F(FormatTest, BreakStringLiterals) {
  4929. EXPECT_EQ("\"some text \"\n"
  4930. "\"other\";",
  4931. format("\"some text other\";", getLLVMStyleWithColumns(12)));
  4932. EXPECT_EQ("\"some text \"\n"
  4933. "\"other\";",
  4934. format("\\\n\"some text other\";", getLLVMStyleWithColumns(12)));
  4935. EXPECT_EQ(
  4936. "#define A \\\n"
  4937. " \"some \" \\\n"
  4938. " \"text \" \\\n"
  4939. " \"other\";",
  4940. format("#define A \"some text other\";", getLLVMStyleWithColumns(12)));
  4941. EXPECT_EQ(
  4942. "#define A \\\n"
  4943. " \"so \" \\\n"
  4944. " \"text \" \\\n"
  4945. " \"other\";",
  4946. format("#define A \"so text other\";", getLLVMStyleWithColumns(12)));
  4947. EXPECT_EQ("\"some text\"",
  4948. format("\"some text\"", getLLVMStyleWithColumns(1)));
  4949. EXPECT_EQ("\"some text\"",
  4950. format("\"some text\"", getLLVMStyleWithColumns(11)));
  4951. EXPECT_EQ("\"some \"\n"
  4952. "\"text\"",
  4953. format("\"some text\"", getLLVMStyleWithColumns(10)));
  4954. EXPECT_EQ("\"some \"\n"
  4955. "\"text\"",
  4956. format("\"some text\"", getLLVMStyleWithColumns(7)));
  4957. EXPECT_EQ("\"some\"\n"
  4958. "\" tex\"\n"
  4959. "\"t\"",
  4960. format("\"some text\"", getLLVMStyleWithColumns(6)));
  4961. EXPECT_EQ("\"some\"\n"
  4962. "\" tex\"\n"
  4963. "\" and\"",
  4964. format("\"some tex and\"", getLLVMStyleWithColumns(6)));
  4965. EXPECT_EQ("\"some\"\n"
  4966. "\"/tex\"\n"
  4967. "\"/and\"",
  4968. format("\"some/tex/and\"", getLLVMStyleWithColumns(6)));
  4969. EXPECT_EQ("variable =\n"
  4970. " \"long string \"\n"
  4971. " \"literal\";",
  4972. format("variable = \"long string literal\";",
  4973. getLLVMStyleWithColumns(20)));
  4974. EXPECT_EQ("variable = f(\n"
  4975. " \"long string \"\n"
  4976. " \"literal\",\n"
  4977. " short,\n"
  4978. " loooooooooooooooooooong);",
  4979. format("variable = f(\"long string literal\", short, "
  4980. "loooooooooooooooooooong);",
  4981. getLLVMStyleWithColumns(20)));
  4982. EXPECT_EQ("f(g(\"long string \"\n"
  4983. " \"literal\"),\n"
  4984. " b);",
  4985. format("f(g(\"long string literal\"), b);",
  4986. getLLVMStyleWithColumns(20)));
  4987. EXPECT_EQ("f(g(\"long string \"\n"
  4988. " \"literal\",\n"
  4989. " a),\n"
  4990. " b);",
  4991. format("f(g(\"long string literal\", a), b);",
  4992. getLLVMStyleWithColumns(20)));
  4993. EXPECT_EQ(
  4994. "f(\"one two\".split(\n"
  4995. " variable));",
  4996. format("f(\"one two\".split(variable));", getLLVMStyleWithColumns(20)));
  4997. EXPECT_EQ("f(\"one two three four five six \"\n"
  4998. " \"seven\".split(\n"
  4999. " really_looooong_variable));",
  5000. format("f(\"one two three four five six seven\"."
  5001. "split(really_looooong_variable));",
  5002. getLLVMStyleWithColumns(33)));
  5003. EXPECT_EQ("f(\"some \"\n"
  5004. " \"text\",\n"
  5005. " other);",
  5006. format("f(\"some text\", other);", getLLVMStyleWithColumns(10)));
  5007. // Only break as a last resort.
  5008. verifyFormat(
  5009. "aaaaaaaaaaaaaaaaaaaa(\n"
  5010. " aaaaaaaaaaaaaaaaaaaa,\n"
  5011. " aaaaaa(\"aaa aaaaa aaa aaa aaaaa aaa aaaaa aaa aaa aaaaaa\"));");
  5012. EXPECT_EQ(
  5013. "\"splitmea\"\n"
  5014. "\"trandomp\"\n"
  5015. "\"oint\"",
  5016. format("\"splitmeatrandompoint\"", getLLVMStyleWithColumns(10)));
  5017. EXPECT_EQ(
  5018. "\"split/\"\n"
  5019. "\"pathat/\"\n"
  5020. "\"slashes\"",
  5021. format("\"split/pathat/slashes\"", getLLVMStyleWithColumns(10)));
  5022. EXPECT_EQ(
  5023. "\"split/\"\n"
  5024. "\"pathat/\"\n"
  5025. "\"slashes\"",
  5026. format("\"split/pathat/slashes\"", getLLVMStyleWithColumns(10)));
  5027. EXPECT_EQ("\"split at \"\n"
  5028. "\"spaces/at/\"\n"
  5029. "\"slashes.at.any$\"\n"
  5030. "\"non-alphanumeric%\"\n"
  5031. "\"1111111111characte\"\n"
  5032. "\"rs\"",
  5033. format("\"split at "
  5034. "spaces/at/"
  5035. "slashes.at."
  5036. "any$non-"
  5037. "alphanumeric%"
  5038. "1111111111characte"
  5039. "rs\"",
  5040. getLLVMStyleWithColumns(20)));
  5041. // Verify that splitting the strings understands
  5042. // Style::AlwaysBreakBeforeMultilineStrings.
  5043. EXPECT_EQ("aaaaaaaaaaaa(aaaaaaaaaaaaa,\n"
  5044. " \"aaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaa \"\n"
  5045. " \"aaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaa\");",
  5046. format("aaaaaaaaaaaa(aaaaaaaaaaaaa, \"aaaaaaaaaaaaaaaaaaaaaa "
  5047. "aaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaaaaaa "
  5048. "aaaaaaaaaaaaaaaaaaaaaa\");",
  5049. getGoogleStyle()));
  5050. EXPECT_EQ("llvm::outs() << \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \"\n"
  5051. " \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\";",
  5052. format("llvm::outs() << "
  5053. "\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa aaaaaaaaaaaaaaaaaa"
  5054. "aaaaaaaaaaaaaaaaaaa\";"));
  5055. EXPECT_EQ("ffff(\n"
  5056. " {\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa \"\n"
  5057. " \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"});",
  5058. format("ffff({\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa "
  5059. "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\"});",
  5060. getGoogleStyle()));
  5061. FormatStyle AlignLeft = getLLVMStyleWithColumns(12);
  5062. AlignLeft.AlignEscapedNewlinesLeft = true;
  5063. EXPECT_EQ(
  5064. "#define A \\\n"
  5065. " \"some \" \\\n"
  5066. " \"text \" \\\n"
  5067. " \"other\";",
  5068. format("#define A \"some text other\";", AlignLeft));
  5069. }
  5070. TEST_F(FormatTest, BreaksWideStringLiterals) {
  5071. EXPECT_EQ(
  5072. "u8\"utf8 string \"\n"
  5073. "u8\"literal\";",
  5074. format("u8\"utf8 string literal\";", getGoogleStyleWithColumns(16)));
  5075. EXPECT_EQ(
  5076. "u\"utf16 string \"\n"
  5077. "u\"literal\";",
  5078. format("u\"utf16 string literal\";", getGoogleStyleWithColumns(16)));
  5079. EXPECT_EQ(
  5080. "U\"utf32 string \"\n"
  5081. "U\"literal\";",
  5082. format("U\"utf32 string literal\";", getGoogleStyleWithColumns(16)));
  5083. EXPECT_EQ("L\"wide string \"\n"
  5084. "L\"literal\";",
  5085. format("L\"wide string literal\";", getGoogleStyleWithColumns(16)));
  5086. }
  5087. TEST_F(FormatTest, BreaksRawStringLiterals) {
  5088. EXPECT_EQ("R\"x(raw )x\"\n"
  5089. "R\"x(literal)x\";",
  5090. format("R\"x(raw literal)x\";", getGoogleStyleWithColumns(15)));
  5091. EXPECT_EQ("uR\"x(raw )x\"\n"
  5092. "uR\"x(literal)x\";",
  5093. format("uR\"x(raw literal)x\";", getGoogleStyleWithColumns(16)));
  5094. EXPECT_EQ("u8R\"x(raw )x\"\n"
  5095. "u8R\"x(literal)x\";",
  5096. format("u8R\"x(raw literal)x\";", getGoogleStyleWithColumns(17)));
  5097. EXPECT_EQ("LR\"x(raw )x\"\n"
  5098. "LR\"x(literal)x\";",
  5099. format("LR\"x(raw literal)x\";", getGoogleStyleWithColumns(16)));
  5100. EXPECT_EQ("UR\"x(raw )x\"\n"
  5101. "UR\"x(literal)x\";",
  5102. format("UR\"x(raw literal)x\";", getGoogleStyleWithColumns(16)));
  5103. }
  5104. TEST_F(FormatTest, BreaksStringLiteralsWithin_TMacro) {
  5105. FormatStyle Style = getLLVMStyleWithColumns(20);
  5106. EXPECT_EQ(
  5107. "_T(\"aaaaaaaaaaaaaa\")\n"
  5108. "_T(\"aaaaaaaaaaaaaa\")\n"
  5109. "_T(\"aaaaaaaaaaaa\")",
  5110. format(" _T(\"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\")", Style));
  5111. EXPECT_EQ("f(x, _T(\"aaaaaaaaa\")\n"
  5112. " _T(\"aaaaaa\"),\n"
  5113. " z);",
  5114. format("f(x, _T(\"aaaaaaaaaaaaaaa\"), z);", Style));
  5115. // FIXME: Handle embedded spaces in one iteration.
  5116. // EXPECT_EQ("_T(\"aaaaaaaaaaaaa\")\n"
  5117. // "_T(\"aaaaaaaaaaaaa\")\n"
  5118. // "_T(\"aaaaaaaaaaaaa\")\n"
  5119. // "_T(\"a\")",
  5120. // format(" _T ( \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\" )",
  5121. // getLLVMStyleWithColumns(20)));
  5122. EXPECT_EQ(
  5123. "_T ( \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\" )",
  5124. format(" _T ( \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\" )", Style));
  5125. }
  5126. TEST_F(FormatTest, DontSplitStringLiteralsWithEscapedNewlines) {
  5127. EXPECT_EQ(
  5128. "aaaaaaaaaaa = \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n"
  5129. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n"
  5130. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\";",
  5131. format("aaaaaaaaaaa = \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n"
  5132. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\\\n"
  5133. " aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa\";"));
  5134. }
  5135. TEST_F(FormatTest, CountsCharactersInMultilineRawStringLiterals) {
  5136. EXPECT_EQ("f(g(R\"x(raw literal)x\", a), b);",
  5137. format("f(g(R\"x(raw literal)x\", a), b);", getGoogleStyle()));
  5138. EXPECT_EQ("fffffffffff(g(R\"x(\n"
  5139. "multiline raw string literal xxxxxxxxxxxxxx\n"
  5140. ")x\",\n"
  5141. " a),\n"
  5142. " b);",
  5143. format("fffffffffff(g(R\"x(\n"
  5144. "multiline raw string literal xxxxxxxxxxxxxx\n"
  5145. ")x\", a), b);",
  5146. getGoogleStyleWithColumns(20)));
  5147. EXPECT_EQ("fffffffffff(\n"
  5148. " g(R\"x(qqq\n"
  5149. "multiline raw string literal xxxxxxxxxxxxxx\n"
  5150. ")x\",\n"
  5151. " a),\n"
  5152. " b);",
  5153. format("fffffffffff(g(R\"x(qqq\n"
  5154. "multiline raw string literal xxxxxxxxxxxxxx\n"
  5155. ")x\", a), b);",
  5156. getGoogleStyleWithColumns(20)));
  5157. EXPECT_EQ("fffffffffff(R\"x(\n"
  5158. "multiline raw string literal xxxxxxxxxxxxxx\n"
  5159. ")x\");",
  5160. format("fffffffffff(R\"x(\n"
  5161. "multiline raw string literal xxxxxxxxxxxxxx\n"
  5162. ")x\");",
  5163. getGoogleStyleWithColumns(20)));
  5164. EXPECT_EQ("fffffffffff(R\"x(\n"
  5165. "multiline raw string literal xxxxxxxxxxxxxx\n"
  5166. ")x\" +\n"
  5167. " bbbbbb);",
  5168. format("fffffffffff(R\"x(\n"
  5169. "multiline raw string literal xxxxxxxxxxxxxx\n"
  5170. ")x\" + bbbbbb);",
  5171. getGoogleStyleWithColumns(20)));
  5172. }
  5173. TEST_F(FormatTest, SkipsUnknownStringLiterals) {
  5174. verifyFormat("string a = \"unterminated;");
  5175. EXPECT_EQ("function(\"unterminated,\n"
  5176. " OtherParameter);",
  5177. format("function( \"unterminated,\n"
  5178. " OtherParameter);"));
  5179. }
  5180. TEST_F(FormatTest, DoesNotTryToParseUDLiteralsInPreCpp11Code) {
  5181. EXPECT_EQ("#define x(_a) printf(\"foo\" _a);",
  5182. format("#define x(_a) printf(\"foo\"_a);", getLLVMStyle()));
  5183. }
  5184. TEST_F(FormatTest, BreakStringLiteralsBeforeUnbreakableTokenSequence) {
  5185. EXPECT_EQ("someFunction(\"aaabbbcccd\"\n"
  5186. " \"ddeeefff\");",
  5187. format("someFunction(\"aaabbbcccdddeeefff\");",
  5188. getLLVMStyleWithColumns(25)));
  5189. EXPECT_EQ("someFunction1234567890(\n"
  5190. " \"aaabbbcccdddeeefff\");",
  5191. format("someFunction1234567890(\"aaabbbcccdddeeefff\");",
  5192. getLLVMStyleWithColumns(26)));
  5193. EXPECT_EQ("someFunction1234567890(\n"
  5194. " \"aaabbbcccdddeeeff\"\n"
  5195. " \"f\");",
  5196. format("someFunction1234567890(\"aaabbbcccdddeeefff\");",
  5197. getLLVMStyleWithColumns(25)));
  5198. EXPECT_EQ("someFunction1234567890(\n"
  5199. " \"aaabbbcccdddeeeff\"\n"
  5200. " \"f\");",
  5201. format("someFunction1234567890(\"aaabbbcccdddeeefff\");",
  5202. getLLVMStyleWithColumns(24)));
  5203. EXPECT_EQ("someFunction(\"aaabbbcc \"\n"
  5204. " \"ddde \"\n"
  5205. " \"efff\");",
  5206. format("someFunction(\"aaabbbcc ddde efff\");",
  5207. getLLVMStyleWithColumns(25)));
  5208. EXPECT_EQ("someFunction(\"aaabbbccc \"\n"
  5209. " \"ddeeefff\");",
  5210. format("someFunction(\"aaabbbccc ddeeefff\");",
  5211. getLLVMStyleWithColumns(25)));
  5212. EXPECT_EQ("someFunction1234567890(\n"
  5213. " \"aaabb \"\n"
  5214. " \"cccdddeeefff\");",
  5215. format("someFunction1234567890(\"aaabb cccdddeeefff\");",
  5216. getLLVMStyleWithColumns(25)));
  5217. EXPECT_EQ("#define A \\\n"
  5218. " string s = \\\n"
  5219. " \"123456789\" \\\n"
  5220. " \"0\"; \\\n"
  5221. " int i;",
  5222. format("#define A string s = \"1234567890\"; int i;",
  5223. getLLVMStyleWithColumns(20)));
  5224. // FIXME: Put additional penalties on breaking at non-whitespace locations.
  5225. EXPECT_EQ("someFunction(\"aaabbbcc \"\n"
  5226. " \"dddeeeff\"\n"
  5227. " \"f\");",
  5228. format("someFunction(\"aaabbbcc dddeeefff\");",
  5229. getLLVMStyleWithColumns(25)));
  5230. }
  5231. TEST_F(FormatTest, DoNotBreakStringLiteralsInEscapeSequence) {
  5232. EXPECT_EQ("\"\\a\"",
  5233. format("\"\\a\"", getLLVMStyleWithColumns(3)));
  5234. EXPECT_EQ("\"\\\"",
  5235. format("\"\\\"", getLLVMStyleWithColumns(2)));
  5236. EXPECT_EQ("\"test\"\n"
  5237. "\"\\n\"",
  5238. format("\"test\\n\"", getLLVMStyleWithColumns(7)));
  5239. EXPECT_EQ("\"tes\\\\\"\n"
  5240. "\"n\"",
  5241. format("\"tes\\\\n\"", getLLVMStyleWithColumns(7)));
  5242. EXPECT_EQ("\"\\\\\\\\\"\n"
  5243. "\"\\n\"",
  5244. format("\"\\\\\\\\\\n\"", getLLVMStyleWithColumns(7)));
  5245. EXPECT_EQ("\"\\uff01\"",
  5246. format("\"\\uff01\"", getLLVMStyleWithColumns(7)));
  5247. EXPECT_EQ("\"\\uff01\"\n"
  5248. "\"test\"",
  5249. format("\"\\uff01test\"", getLLVMStyleWithColumns(8)));
  5250. EXPECT_EQ("\"\\Uff01ff02\"",
  5251. format("\"\\Uff01ff02\"", getLLVMStyleWithColumns(11)));
  5252. EXPECT_EQ("\"\\x000000000001\"\n"
  5253. "\"next\"",
  5254. format("\"\\x000000000001next\"", getLLVMStyleWithColumns(16)));
  5255. EXPECT_EQ("\"\\x000000000001next\"",
  5256. format("\"\\x000000000001next\"", getLLVMStyleWithColumns(15)));
  5257. EXPECT_EQ("\"\\x000000000001\"",
  5258. format("\"\\x000000000001\"", getLLVMStyleWithColumns(7)));
  5259. EXPECT_EQ("\"test\"\n"
  5260. "\"\\000000\"\n"
  5261. "\"000001\"",
  5262. format("\"test\\000000000001\"", getLLVMStyleWithColumns(9)));
  5263. EXPECT_EQ("\"test\\000\"\n"
  5264. "\"00000000\"\n"
  5265. "\"1\"",
  5266. format("\"test\\000000000001\"", getLLVMStyleWithColumns(10)));
  5267. // FIXME: We probably don't need to care about escape sequences in raw
  5268. // literals.
  5269. EXPECT_EQ("R\"(\\x)\"\n"
  5270. "R\"(\\x00)\"\n",
  5271. format("R\"(\\x\\x00)\"\n", getGoogleStyleWithColumns(7)));
  5272. }
  5273. TEST_F(FormatTest, DoNotCreateUnreasonableUnwrappedLines) {
  5274. verifyFormat("void f() {\n"
  5275. " return g() {}\n"
  5276. " void h() {}");
  5277. verifyFormat("if (foo)\n"
  5278. " return { forgot_closing_brace();\n"
  5279. "test();");
  5280. verifyFormat("int a[] = { void forgot_closing_brace() { f();\n"
  5281. "g();\n"
  5282. "}");
  5283. }
  5284. TEST_F(FormatTest, FormatsClosingBracesInEmptyNestedBlocks) {
  5285. verifyFormat("class X {\n"
  5286. " void f() {\n"
  5287. " }\n"
  5288. "};",
  5289. getLLVMStyleWithColumns(12));
  5290. }
  5291. TEST_F(FormatTest, ConfigurableIndentWidth) {
  5292. FormatStyle EightIndent = getLLVMStyleWithColumns(18);
  5293. EightIndent.IndentWidth = 8;
  5294. verifyFormat("void f() {\n"
  5295. " someFunction();\n"
  5296. " if (true) {\n"
  5297. " f();\n"
  5298. " }\n"
  5299. "}",
  5300. EightIndent);
  5301. verifyFormat("class X {\n"
  5302. " void f() {\n"
  5303. " }\n"
  5304. "};",
  5305. EightIndent);
  5306. verifyFormat("int x[] = {\n"
  5307. " call(),\n"
  5308. " call(),\n"
  5309. "};",
  5310. EightIndent);
  5311. }
  5312. TEST_F(FormatTest, ConfigurableFunctionDeclarationIndentAfterType) {
  5313. verifyFormat("void\n"
  5314. "f();",
  5315. getLLVMStyleWithColumns(8));
  5316. }
  5317. TEST_F(FormatTest, ConfigurableUseOfTab) {
  5318. FormatStyle Tab = getLLVMStyleWithColumns(42);
  5319. Tab.IndentWidth = 8;
  5320. Tab.UseTab = FormatStyle::UT_Always;
  5321. Tab.AlignEscapedNewlinesLeft = true;
  5322. EXPECT_EQ("if (aaaaaaaa && // q\n"
  5323. " bb)\t\t// w\n"
  5324. "\t;",
  5325. format("if (aaaaaaaa &&// q\n"
  5326. "bb)// w\n"
  5327. ";",
  5328. Tab));
  5329. EXPECT_EQ("if (aaa && bbb) // w\n"
  5330. "\t;",
  5331. format("if(aaa&&bbb)// w\n"
  5332. ";",
  5333. Tab));
  5334. verifyFormat("class X {\n"
  5335. "\tvoid f() {\n"
  5336. "\t\tsomeFunction(parameter1,\n"
  5337. "\t\t\t parameter2);\n"
  5338. "\t}\n"
  5339. "};",
  5340. Tab);
  5341. verifyFormat("#define A \\\n"
  5342. "\tvoid f() { \\\n"
  5343. "\t\tsomeFunction( \\\n"
  5344. "\t\t parameter1, \\\n"
  5345. "\t\t parameter2); \\\n"
  5346. "\t}",
  5347. Tab);
  5348. EXPECT_EQ("void f() {\n"
  5349. "\tf();\n"
  5350. "\tg();\n"
  5351. "}",
  5352. format("void f() {\n"
  5353. "\tf();\n"
  5354. "\tg();\n"
  5355. "}",
  5356. 0, 0, Tab));
  5357. EXPECT_EQ("void f() {\n"
  5358. "\tf();\n"
  5359. "\tg();\n"
  5360. "}",
  5361. format("void f() {\n"
  5362. "\tf();\n"
  5363. "\tg();\n"
  5364. "}",
  5365. 16, 0, Tab));
  5366. EXPECT_EQ("void f() {\n"
  5367. " \tf();\n"
  5368. "\tg();\n"
  5369. "}",
  5370. format("void f() {\n"
  5371. " \tf();\n"
  5372. " \tg();\n"
  5373. "}",
  5374. 21, 0, Tab));
  5375. Tab.TabWidth = 4;
  5376. Tab.IndentWidth = 8;
  5377. verifyFormat("class TabWidth4Indent8 {\n"
  5378. "\t\tvoid f() {\n"
  5379. "\t\t\t\tsomeFunction(parameter1,\n"
  5380. "\t\t\t\t\t\t\t parameter2);\n"
  5381. "\t\t}\n"
  5382. "};",
  5383. Tab);
  5384. Tab.TabWidth = 4;
  5385. Tab.IndentWidth = 4;
  5386. verifyFormat("class TabWidth4Indent4 {\n"
  5387. "\tvoid f() {\n"
  5388. "\t\tsomeFunction(parameter1,\n"
  5389. "\t\t\t\t\t parameter2);\n"
  5390. "\t}\n"
  5391. "};",
  5392. Tab);
  5393. Tab.TabWidth = 8;
  5394. Tab.IndentWidth = 4;
  5395. verifyFormat("class TabWidth8Indent4 {\n"
  5396. " void f() {\n"
  5397. "\tsomeFunction(parameter1,\n"
  5398. "\t\t parameter2);\n"
  5399. " }\n"
  5400. "};",
  5401. Tab);
  5402. Tab.TabWidth = 8;
  5403. Tab.IndentWidth = 8;
  5404. EXPECT_EQ("/*\n"
  5405. "\t a\t\tcomment\n"
  5406. "\t in multiple lines\n"
  5407. " */",
  5408. format(" /*\t \t \n"
  5409. " \t \t a\t\tcomment\t \t\n"
  5410. " \t \t in multiple lines\t\n"
  5411. " \t */",
  5412. Tab));
  5413. Tab.UseTab = FormatStyle::UT_ForIndentation;
  5414. EXPECT_EQ("if (aaaaaaaa && // q\n"
  5415. " bb) // w\n"
  5416. "\t;",
  5417. format("if (aaaaaaaa &&// q\n"
  5418. "bb)// w\n"
  5419. ";",
  5420. Tab));
  5421. verifyFormat("class X {\n"
  5422. "\tvoid f() {\n"
  5423. "\t\tsomeFunction(parameter1,\n"
  5424. "\t\t parameter2);\n"
  5425. "\t}\n"
  5426. "};",
  5427. Tab);
  5428. verifyFormat("{\n"
  5429. "\tQ({\n"
  5430. "\t\t int a;\n"
  5431. "\t\t someFunction(aaaaaaaaaa,\n"
  5432. "\t\t bbbbbbbbb);\n"
  5433. "\t },\n"
  5434. "\t p);\n"
  5435. "}",
  5436. Tab);
  5437. EXPECT_EQ("{\n"
  5438. "\t/* aaaa\n"
  5439. "\t bbbb */\n"
  5440. "}",
  5441. format("{\n"
  5442. "/* aaaa\n"
  5443. " bbbb */\n"
  5444. "}",
  5445. Tab));
  5446. EXPECT_EQ("{\n"
  5447. "\t/*\n"
  5448. "\t aaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  5449. "\t bbbbbbbbbbbbb\n"
  5450. "\t*/\n"
  5451. "}",
  5452. format("{\n"
  5453. "/*\n"
  5454. " aaaaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbb\n"
  5455. "*/\n"
  5456. "}",
  5457. Tab));
  5458. EXPECT_EQ("{\n"
  5459. "\t// aaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  5460. "\t// bbbbbbbbbbbbb\n"
  5461. "}",
  5462. format("{\n"
  5463. "\t// aaaaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbb\n"
  5464. "}",
  5465. Tab));
  5466. EXPECT_EQ("{\n"
  5467. "\t/*\n"
  5468. "\t aaaaaaaaaaaaaaaaaaaaaaaaaa\n"
  5469. "\t bbbbbbbbbbbbb\n"
  5470. "\t*/\n"
  5471. "}",
  5472. format("{\n"
  5473. "\t/*\n"
  5474. "\t aaaaaaaaaaaaaaaaaaaaaaaaaa bbbbbbbbbbbbb\n"
  5475. "\t*/\n"
  5476. "}",
  5477. Tab));
  5478. EXPECT_EQ("{\n"
  5479. "\t/*\n"
  5480. "\n"
  5481. "\t*/\n"
  5482. "}",
  5483. format("{\n"
  5484. "\t/*\n"
  5485. "\n"
  5486. "\t*/\n"
  5487. "}",
  5488. Tab));
  5489. EXPECT_EQ("{\n"
  5490. "\t/*\n"
  5491. " asdf\n"
  5492. "\t*/\n"
  5493. "}",
  5494. format("{\n"
  5495. "\t/*\n"
  5496. " asdf\n"
  5497. "\t*/\n"
  5498. "}",
  5499. Tab));
  5500. Tab.UseTab = FormatStyle::UT_Never;
  5501. EXPECT_EQ("/*\n"
  5502. " a\t\tcomment\n"
  5503. " in multiple lines\n"
  5504. " */",
  5505. format(" /*\t \t \n"
  5506. " \t \t a\t\tcomment\t \t\n"
  5507. " \t \t in multiple lines\t\n"
  5508. " \t */",
  5509. Tab));
  5510. EXPECT_EQ("/* some\n"
  5511. " comment */",
  5512. format(" \t \t /* some\n"
  5513. " \t \t comment */",
  5514. Tab));
  5515. EXPECT_EQ("int a; /* some\n"
  5516. " comment */",
  5517. format(" \t \t int a; /* some\n"
  5518. " \t \t comment */",
  5519. Tab));
  5520. EXPECT_EQ("int a; /* some\n"
  5521. "comment */",
  5522. format(" \t \t int\ta; /* some\n"
  5523. " \t \t comment */",
  5524. Tab));
  5525. EXPECT_EQ("f(\"\t\t\"); /* some\n"
  5526. " comment */",
  5527. format(" \t \t f(\"\t\t\"); /* some\n"
  5528. " \t \t comment */",
  5529. Tab));
  5530. EXPECT_EQ("{\n"
  5531. " /*\n"
  5532. " * Comment\n"
  5533. " */\n"
  5534. " int i;\n"
  5535. "}",
  5536. format("{\n"
  5537. "\t/*\n"
  5538. "\t * Comment\n"
  5539. "\t */\n"
  5540. "\t int i;\n"
  5541. "}"));
  5542. }
  5543. TEST_F(FormatTest, CalculatesOriginalColumn) {
  5544. EXPECT_EQ("\"qqqqqqqqqqqqqqqqqqqqqqqqqq\\\n"
  5545. "q\"; /* some\n"
  5546. " comment */",
  5547. format(" \"qqqqqqqqqqqqqqqqqqqqqqqqqq\\\n"
  5548. "q\"; /* some\n"
  5549. " comment */",
  5550. getLLVMStyle()));
  5551. EXPECT_EQ("// qqqqqqqqqqqqqqqqqqqqqqqqqq\n"
  5552. "/* some\n"
  5553. " comment */",
  5554. format("// qqqqqqqqqqqqqqqqqqqqqqqqqq\n"
  5555. " /* some\n"
  5556. " comment */",
  5557. getLLVMStyle()));
  5558. EXPECT_EQ("// qqqqqqqqqqqqqqqqqqqqqqqqqq\\\n"
  5559. "qqq\n"
  5560. "/* some\n"
  5561. " comment */",
  5562. format("// qqqqqqqqqqqqqqqqqqqqqqqqqq\\\n"
  5563. "qqq\n"
  5564. " /* some\n"
  5565. " comment */",
  5566. getLLVMStyle()));
  5567. EXPECT_EQ("inttt qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq\\\n"
  5568. "wwww; /* some\n"
  5569. " comment */",
  5570. format(" inttt qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqq\\\n"
  5571. "wwww; /* some\n"
  5572. " comment */",
  5573. getLLVMStyle()));
  5574. }
  5575. TEST_F(FormatTest, ConfigurableSpaceAfterControlStatementKeyword) {
  5576. FormatStyle NoSpace = getLLVMStyle();
  5577. NoSpace.SpaceAfterControlStatementKeyword = false;
  5578. verifyFormat("while(true)\n"
  5579. " continue;", NoSpace);
  5580. verifyFormat("for(;;)\n"
  5581. " continue;", NoSpace);
  5582. verifyFormat("if(true)\n"
  5583. " f();\n"
  5584. "else if(true)\n"
  5585. " f();", NoSpace);
  5586. verifyFormat("do {\n"
  5587. " do_something();\n"
  5588. "} while(something());", NoSpace);
  5589. verifyFormat("switch(x) {\n"
  5590. "default:\n"
  5591. " break;\n"
  5592. "}", NoSpace);
  5593. }
  5594. TEST_F(FormatTest, ConfigurableSpacesInParentheses) {
  5595. FormatStyle Spaces = getLLVMStyle();
  5596. Spaces.SpacesInParentheses = true;
  5597. verifyFormat("call( x, y, z );", Spaces);
  5598. verifyFormat("while ( (bool)1 )\n"
  5599. " continue;", Spaces);
  5600. verifyFormat("for ( ;; )\n"
  5601. " continue;", Spaces);
  5602. verifyFormat("if ( true )\n"
  5603. " f();\n"
  5604. "else if ( true )\n"
  5605. " f();", Spaces);
  5606. verifyFormat("do {\n"
  5607. " do_something( (int)i );\n"
  5608. "} while ( something() );", Spaces);
  5609. verifyFormat("switch ( x ) {\n"
  5610. "default:\n"
  5611. " break;\n"
  5612. "}", Spaces);
  5613. Spaces.SpacesInParentheses = false;
  5614. Spaces.SpacesInCStyleCastParentheses = true;
  5615. verifyFormat("Type *A = ( Type * )P;", Spaces);
  5616. verifyFormat("Type *A = ( vector<Type *, int *> )P;", Spaces);
  5617. verifyFormat("x = ( int32 )y;", Spaces);
  5618. verifyFormat("int a = ( int )(2.0f);", Spaces);
  5619. verifyFormat("#define AA(X) sizeof((( X * )NULL)->a)", Spaces);
  5620. verifyFormat("my_int a = ( my_int )sizeof(int);", Spaces);
  5621. verifyFormat("#define x (( int )-1)", Spaces);
  5622. Spaces.SpacesInParentheses = false;
  5623. Spaces.SpaceInEmptyParentheses = true;
  5624. verifyFormat("call(x, y, z);", Spaces);
  5625. verifyFormat("call( )", Spaces);
  5626. // Run the first set of tests again with
  5627. // Spaces.SpacesInParentheses = false,
  5628. // Spaces.SpaceInEmptyParentheses = true and
  5629. // Spaces.SpacesInCStyleCastParentheses = true
  5630. Spaces.SpacesInParentheses = false,
  5631. Spaces.SpaceInEmptyParentheses = true;
  5632. Spaces.SpacesInCStyleCastParentheses = true;
  5633. verifyFormat("call(x, y, z);", Spaces);
  5634. verifyFormat("while (( bool )1)\n"
  5635. " continue;", Spaces);
  5636. verifyFormat("for (;;)\n"
  5637. " continue;", Spaces);
  5638. verifyFormat("if (true)\n"
  5639. " f( );\n"
  5640. "else if (true)\n"
  5641. " f( );", Spaces);
  5642. verifyFormat("do {\n"
  5643. " do_something(( int )i);\n"
  5644. "} while (something( ));", Spaces);
  5645. verifyFormat("switch (x) {\n"
  5646. "default:\n"
  5647. " break;\n"
  5648. "}", Spaces);
  5649. }
  5650. TEST_F(FormatTest, ConfigurableSpaceBeforeAssignmentOperators) {
  5651. verifyFormat("int a = 5;");
  5652. verifyFormat("a += 42;");
  5653. verifyFormat("a or_eq 8;");
  5654. FormatStyle Spaces = getLLVMStyle();
  5655. Spaces.SpaceBeforeAssignmentOperators = false;
  5656. verifyFormat("int a= 5;", Spaces);
  5657. verifyFormat("a+= 42;", Spaces);
  5658. verifyFormat("a or_eq 8;", Spaces);
  5659. }
  5660. TEST_F(FormatTest, LinuxBraceBreaking) {
  5661. FormatStyle BreakBeforeBrace = getLLVMStyle();
  5662. BreakBeforeBrace.BreakBeforeBraces = FormatStyle::BS_Linux;
  5663. verifyFormat("namespace a\n"
  5664. "{\n"
  5665. "class A\n"
  5666. "{\n"
  5667. " void f()\n"
  5668. " {\n"
  5669. " if (true) {\n"
  5670. " a();\n"
  5671. " b();\n"
  5672. " }\n"
  5673. " }\n"
  5674. " void g()\n"
  5675. " {\n"
  5676. " return;\n"
  5677. " }\n"
  5678. "}\n"
  5679. "}",
  5680. BreakBeforeBrace);
  5681. }
  5682. TEST_F(FormatTest, StroustrupBraceBreaking) {
  5683. FormatStyle BreakBeforeBrace = getLLVMStyle();
  5684. BreakBeforeBrace.BreakBeforeBraces = FormatStyle::BS_Stroustrup;
  5685. verifyFormat("namespace a {\n"
  5686. "class A {\n"
  5687. " void f()\n"
  5688. " {\n"
  5689. " if (true) {\n"
  5690. " a();\n"
  5691. " b();\n"
  5692. " }\n"
  5693. " }\n"
  5694. " void g()\n"
  5695. " {\n"
  5696. " return;\n"
  5697. " }\n"
  5698. "}\n"
  5699. "}",
  5700. BreakBeforeBrace);
  5701. }
  5702. TEST_F(FormatTest, AllmanBraceBreaking) {
  5703. FormatStyle BreakBeforeBrace = getLLVMStyle();
  5704. BreakBeforeBrace.BreakBeforeBraces = FormatStyle::BS_Allman;
  5705. verifyFormat("namespace a\n"
  5706. "{\n"
  5707. "class A\n"
  5708. "{\n"
  5709. " void f()\n"
  5710. " {\n"
  5711. " if (true)\n"
  5712. " {\n"
  5713. " a();\n"
  5714. " b();\n"
  5715. " }\n"
  5716. " }\n"
  5717. " void g()\n"
  5718. " {\n"
  5719. " return;\n"
  5720. " }\n"
  5721. "}\n"
  5722. "}",
  5723. BreakBeforeBrace);
  5724. verifyFormat("void f()\n"
  5725. "{\n"
  5726. " if (true)\n"
  5727. " {\n"
  5728. " a();\n"
  5729. " }\n"
  5730. " else if (false)\n"
  5731. " {\n"
  5732. " b();\n"
  5733. " }\n"
  5734. " else\n"
  5735. " {\n"
  5736. " c();\n"
  5737. " }\n"
  5738. "}\n",
  5739. BreakBeforeBrace);
  5740. verifyFormat("void f()\n"
  5741. "{\n"
  5742. " for (int i = 0; i < 10; ++i)\n"
  5743. " {\n"
  5744. " a();\n"
  5745. " }\n"
  5746. " while (false)\n"
  5747. " {\n"
  5748. " b();\n"
  5749. " }\n"
  5750. " do\n"
  5751. " {\n"
  5752. " c();\n"
  5753. " } while (false)\n"
  5754. "}\n",
  5755. BreakBeforeBrace);
  5756. verifyFormat("void f(int a)\n"
  5757. "{\n"
  5758. " switch (a)\n"
  5759. " {\n"
  5760. " case 0:\n"
  5761. " break;\n"
  5762. " case 1:\n"
  5763. " {\n"
  5764. " break;\n"
  5765. " }\n"
  5766. " case 2:\n"
  5767. " {\n"
  5768. " }\n"
  5769. " break;\n"
  5770. " default:\n"
  5771. " break;\n"
  5772. " }\n"
  5773. "}\n",
  5774. BreakBeforeBrace);
  5775. verifyFormat("enum X\n"
  5776. "{\n"
  5777. " Y = 0,\n"
  5778. "}\n",
  5779. BreakBeforeBrace);
  5780. FormatStyle BreakBeforeBraceShortIfs = BreakBeforeBrace;
  5781. BreakBeforeBraceShortIfs.AllowShortIfStatementsOnASingleLine = true;
  5782. BreakBeforeBraceShortIfs.AllowShortLoopsOnASingleLine = true;
  5783. verifyFormat("void f(bool b)\n"
  5784. "{\n"
  5785. " if (b)\n"
  5786. " {\n"
  5787. " return;\n"
  5788. " }\n"
  5789. "}\n",
  5790. BreakBeforeBraceShortIfs);
  5791. verifyFormat("void f(bool b)\n"
  5792. "{\n"
  5793. " if (b) return;\n"
  5794. "}\n",
  5795. BreakBeforeBraceShortIfs);
  5796. verifyFormat("void f(bool b)\n"
  5797. "{\n"
  5798. " while (b)\n"
  5799. " {\n"
  5800. " return;\n"
  5801. " }\n"
  5802. "}\n",
  5803. BreakBeforeBraceShortIfs);
  5804. }
  5805. TEST_F(FormatTest, CatchExceptionReferenceBinding) {
  5806. verifyFormat("void f() {\n"
  5807. " try {\n"
  5808. " }\n"
  5809. " catch (const Exception &e) {\n"
  5810. " }\n"
  5811. "}\n",
  5812. getLLVMStyle());
  5813. }
  5814. TEST_F(FormatTest, UnderstandsPragmas) {
  5815. verifyFormat("#pragma omp reduction(| : var)");
  5816. verifyFormat("#pragma omp reduction(+ : var)");
  5817. }
  5818. bool allStylesEqual(ArrayRef<FormatStyle> Styles) {
  5819. for (size_t i = 1; i < Styles.size(); ++i)
  5820. if (!(Styles[0] == Styles[i]))
  5821. return false;
  5822. return true;
  5823. }
  5824. TEST_F(FormatTest, GetsPredefinedStyleByName) {
  5825. FormatStyle Styles[3];
  5826. Styles[0] = getLLVMStyle();
  5827. EXPECT_TRUE(getPredefinedStyle("LLVM", &Styles[1]));
  5828. EXPECT_TRUE(getPredefinedStyle("lLvM", &Styles[2]));
  5829. EXPECT_TRUE(allStylesEqual(Styles));
  5830. Styles[0] = getGoogleStyle();
  5831. EXPECT_TRUE(getPredefinedStyle("Google", &Styles[1]));
  5832. EXPECT_TRUE(getPredefinedStyle("gOOgle", &Styles[2]));
  5833. EXPECT_TRUE(allStylesEqual(Styles));
  5834. Styles[0] = getChromiumStyle();
  5835. EXPECT_TRUE(getPredefinedStyle("Chromium", &Styles[1]));
  5836. EXPECT_TRUE(getPredefinedStyle("cHRoMiUM", &Styles[2]));
  5837. EXPECT_TRUE(allStylesEqual(Styles));
  5838. Styles[0] = getMozillaStyle();
  5839. EXPECT_TRUE(getPredefinedStyle("Mozilla", &Styles[1]));
  5840. EXPECT_TRUE(getPredefinedStyle("moZILla", &Styles[2]));
  5841. EXPECT_TRUE(allStylesEqual(Styles));
  5842. Styles[0] = getWebKitStyle();
  5843. EXPECT_TRUE(getPredefinedStyle("WebKit", &Styles[1]));
  5844. EXPECT_TRUE(getPredefinedStyle("wEbKit", &Styles[2]));
  5845. EXPECT_TRUE(allStylesEqual(Styles));
  5846. EXPECT_FALSE(getPredefinedStyle("qwerty", &Styles[0]));
  5847. }
  5848. TEST_F(FormatTest, ParsesConfiguration) {
  5849. FormatStyle Style = {};
  5850. #define CHECK_PARSE(TEXT, FIELD, VALUE) \
  5851. EXPECT_NE(VALUE, Style.FIELD); \
  5852. EXPECT_EQ(0, parseConfiguration(TEXT, &Style).value()); \
  5853. EXPECT_EQ(VALUE, Style.FIELD)
  5854. #define CHECK_PARSE_BOOL(FIELD) \
  5855. Style.FIELD = false; \
  5856. EXPECT_EQ(0, parseConfiguration(#FIELD ": true", &Style).value()); \
  5857. EXPECT_TRUE(Style.FIELD); \
  5858. EXPECT_EQ(0, parseConfiguration(#FIELD ": false", &Style).value()); \
  5859. EXPECT_FALSE(Style.FIELD);
  5860. CHECK_PARSE_BOOL(AlignEscapedNewlinesLeft);
  5861. CHECK_PARSE_BOOL(AlignTrailingComments);
  5862. CHECK_PARSE_BOOL(AllowAllParametersOfDeclarationOnNextLine);
  5863. CHECK_PARSE_BOOL(AllowShortIfStatementsOnASingleLine);
  5864. CHECK_PARSE_BOOL(AllowShortLoopsOnASingleLine);
  5865. CHECK_PARSE_BOOL(AlwaysBreakTemplateDeclarations);
  5866. CHECK_PARSE_BOOL(BinPackParameters);
  5867. CHECK_PARSE_BOOL(BreakBeforeBinaryOperators);
  5868. CHECK_PARSE_BOOL(BreakConstructorInitializersBeforeComma);
  5869. CHECK_PARSE_BOOL(ConstructorInitializerAllOnOneLineOrOnePerLine);
  5870. CHECK_PARSE_BOOL(DerivePointerBinding);
  5871. CHECK_PARSE_BOOL(IndentCaseLabels);
  5872. CHECK_PARSE_BOOL(ObjCSpaceBeforeProtocolList);
  5873. CHECK_PARSE_BOOL(PointerBindsToType);
  5874. CHECK_PARSE_BOOL(Cpp11BracedListStyle);
  5875. CHECK_PARSE_BOOL(IndentFunctionDeclarationAfterType);
  5876. CHECK_PARSE_BOOL(SpacesInParentheses);
  5877. CHECK_PARSE_BOOL(SpaceInEmptyParentheses);
  5878. CHECK_PARSE_BOOL(SpacesInCStyleCastParentheses);
  5879. CHECK_PARSE_BOOL(SpaceAfterControlStatementKeyword);
  5880. CHECK_PARSE_BOOL(SpaceBeforeAssignmentOperators);
  5881. CHECK_PARSE("AccessModifierOffset: -1234", AccessModifierOffset, -1234);
  5882. CHECK_PARSE("ConstructorInitializerIndentWidth: 1234",
  5883. ConstructorInitializerIndentWidth, 1234u);
  5884. CHECK_PARSE("ColumnLimit: 1234", ColumnLimit, 1234u);
  5885. CHECK_PARSE("MaxEmptyLinesToKeep: 1234", MaxEmptyLinesToKeep, 1234u);
  5886. CHECK_PARSE("PenaltyExcessCharacter: 1234", PenaltyExcessCharacter, 1234u);
  5887. CHECK_PARSE("PenaltyReturnTypeOnItsOwnLine: 1234",
  5888. PenaltyReturnTypeOnItsOwnLine, 1234u);
  5889. CHECK_PARSE("SpacesBeforeTrailingComments: 1234",
  5890. SpacesBeforeTrailingComments, 1234u);
  5891. CHECK_PARSE("IndentWidth: 32", IndentWidth, 32u);
  5892. Style.Standard = FormatStyle::LS_Auto;
  5893. CHECK_PARSE("Standard: Cpp03", Standard, FormatStyle::LS_Cpp03);
  5894. CHECK_PARSE("Standard: Cpp11", Standard, FormatStyle::LS_Cpp11);
  5895. CHECK_PARSE("Standard: C++03", Standard, FormatStyle::LS_Cpp03);
  5896. CHECK_PARSE("Standard: C++11", Standard, FormatStyle::LS_Cpp11);
  5897. CHECK_PARSE("Standard: Auto", Standard, FormatStyle::LS_Auto);
  5898. Style.UseTab = FormatStyle::UT_ForIndentation;
  5899. CHECK_PARSE("UseTab: false", UseTab, FormatStyle::UT_Never);
  5900. CHECK_PARSE("UseTab: true", UseTab, FormatStyle::UT_Always);
  5901. CHECK_PARSE("UseTab: Never", UseTab, FormatStyle::UT_Never);
  5902. CHECK_PARSE("UseTab: ForIndentation", UseTab, FormatStyle::UT_ForIndentation);
  5903. CHECK_PARSE("UseTab: Always", UseTab, FormatStyle::UT_Always);
  5904. Style.ColumnLimit = 123;
  5905. FormatStyle BaseStyle = getLLVMStyle();
  5906. CHECK_PARSE("BasedOnStyle: LLVM", ColumnLimit, BaseStyle.ColumnLimit);
  5907. CHECK_PARSE("BasedOnStyle: LLVM\nColumnLimit: 1234", ColumnLimit, 1234u);
  5908. Style.BreakBeforeBraces = FormatStyle::BS_Stroustrup;
  5909. CHECK_PARSE("BreakBeforeBraces: Attach", BreakBeforeBraces,
  5910. FormatStyle::BS_Attach);
  5911. CHECK_PARSE("BreakBeforeBraces: Linux", BreakBeforeBraces,
  5912. FormatStyle::BS_Linux);
  5913. CHECK_PARSE("BreakBeforeBraces: Stroustrup", BreakBeforeBraces,
  5914. FormatStyle::BS_Stroustrup);
  5915. Style.NamespaceIndentation = FormatStyle::NI_All;
  5916. CHECK_PARSE("NamespaceIndentation: None", NamespaceIndentation,
  5917. FormatStyle::NI_None);
  5918. CHECK_PARSE("NamespaceIndentation: Inner", NamespaceIndentation,
  5919. FormatStyle::NI_Inner);
  5920. CHECK_PARSE("NamespaceIndentation: All", NamespaceIndentation,
  5921. FormatStyle::NI_All);
  5922. #undef CHECK_PARSE
  5923. #undef CHECK_PARSE_BOOL
  5924. }
  5925. TEST_F(FormatTest, ConfigurationRoundTripTest) {
  5926. FormatStyle Style = getLLVMStyle();
  5927. std::string YAML = configurationAsText(Style);
  5928. FormatStyle ParsedStyle = {};
  5929. EXPECT_EQ(0, parseConfiguration(YAML, &ParsedStyle).value());
  5930. EXPECT_EQ(Style, ParsedStyle);
  5931. }
  5932. TEST_F(FormatTest, WorksFor8bitEncodings) {
  5933. EXPECT_EQ("\"\xce\xe4\xed\xe0\xe6\xe4\xfb \xe2 \"\n"
  5934. "\"\xf1\xf2\xf3\xe4\xb8\xed\xf3\xfe \"\n"
  5935. "\"\xe7\xe8\xec\xed\xfe\xfe \"\n"
  5936. "\"\xef\xee\xf0\xf3...\"",
  5937. format("\"\xce\xe4\xed\xe0\xe6\xe4\xfb \xe2 "
  5938. "\xf1\xf2\xf3\xe4\xb8\xed\xf3\xfe \xe7\xe8\xec\xed\xfe\xfe "
  5939. "\xef\xee\xf0\xf3...\"",
  5940. getLLVMStyleWithColumns(12)));
  5941. }
  5942. // FIXME: Encode Cyrillic and CJK characters below to appease MS compilers.
  5943. #if !defined(_MSC_VER)
  5944. TEST_F(FormatTest, CountsUTF8CharactersProperly) {
  5945. verifyFormat("\"Однажды в студёную зимнюю пору...\"",
  5946. getLLVMStyleWithColumns(35));
  5947. verifyFormat("\"一 二 三 四 五 六 七 八 九 十\"",
  5948. getLLVMStyleWithColumns(31));
  5949. verifyFormat("// Однажды в студёную зимнюю пору...",
  5950. getLLVMStyleWithColumns(36));
  5951. verifyFormat("// 一 二 三 四 五 六 七 八 九 十",
  5952. getLLVMStyleWithColumns(32));
  5953. verifyFormat("/* Однажды в студёную зимнюю пору... */",
  5954. getLLVMStyleWithColumns(39));
  5955. verifyFormat("/* 一 二 三 四 五 六 七 八 九 十 */",
  5956. getLLVMStyleWithColumns(35));
  5957. }
  5958. TEST_F(FormatTest, SplitsUTF8Strings) {
  5959. EXPECT_EQ(
  5960. "\"Однажды, в \"\n"
  5961. "\"студёную \"\n"
  5962. "\"зимнюю \"\n"
  5963. "\"пору,\"",
  5964. format("\"Однажды, в студёную зимнюю пору,\"",
  5965. getLLVMStyleWithColumns(13)));
  5966. EXPECT_EQ("\"一 二 三 \"\n"
  5967. "\"四 五六 \"\n"
  5968. "\"七 八 九 \"\n"
  5969. "\"十\"",
  5970. format("\"一 二 三 四 五六 七 八 九 十\"",
  5971. getLLVMStyleWithColumns(11)));
  5972. EXPECT_EQ("\"一\t二 \"\n"
  5973. "\"\t三 \"\n"
  5974. "\"四 五\t六 \"\n"
  5975. "\"\t七 \"\n"
  5976. "\"八九十\tqq\"",
  5977. format("\"一\t二 \t三 四 五\t六 \t七 八九十\tqq\"",
  5978. getLLVMStyleWithColumns(11)));
  5979. }
  5980. TEST_F(FormatTest, HandlesDoubleWidthCharsInMultiLineStrings) {
  5981. EXPECT_EQ("const char *sssss =\n"
  5982. " \"一二三四五六七八\\\n"
  5983. " 九 十\";",
  5984. format("const char *sssss = \"一二三四五六七八\\\n"
  5985. " 九 十\";",
  5986. getLLVMStyleWithColumns(30)));
  5987. }
  5988. TEST_F(FormatTest, SplitsUTF8LineComments) {
  5989. EXPECT_EQ("// Я из лесу\n"
  5990. "// вышел; был\n"
  5991. "// сильный\n"
  5992. "// мороз.",
  5993. format("// Я из лесу вышел; был сильный мороз.",
  5994. getLLVMStyleWithColumns(13)));
  5995. EXPECT_EQ("// 一二三\n"
  5996. "// 四五六七\n"
  5997. "// 八 九\n"
  5998. "// 十",
  5999. format("// 一二三 四五六七 八 九 十", getLLVMStyleWithColumns(9)));
  6000. }
  6001. TEST_F(FormatTest, SplitsUTF8BlockComments) {
  6002. EXPECT_EQ("/* Гляжу,\n"
  6003. " * поднимается\n"
  6004. " * медленно в\n"
  6005. " * гору\n"
  6006. " * Лошадка,\n"
  6007. " * везущая\n"
  6008. " * хворосту\n"
  6009. " * воз. */",
  6010. format("/* Гляжу, поднимается медленно в гору\n"
  6011. " * Лошадка, везущая хворосту воз. */",
  6012. getLLVMStyleWithColumns(13)));
  6013. EXPECT_EQ(
  6014. "/* 一二三\n"
  6015. " * 四五六七\n"
  6016. " * 八 九\n"
  6017. " * 十 */",
  6018. format("/* 一二三 四五六七 八 九 十 */", getLLVMStyleWithColumns(9)));
  6019. EXPECT_EQ("/* 𝓣𝓮𝓼𝓽 𝔣𝔬𝔲𝔯\n"
  6020. " * 𝕓𝕪𝕥𝕖\n"
  6021. " * 𝖀𝕿𝕱-𝟠 */",
  6022. format("/* 𝓣𝓮𝓼𝓽 𝔣𝔬𝔲𝔯 𝕓𝕪𝕥𝕖 𝖀𝕿𝕱-𝟠 */", getLLVMStyleWithColumns(12)));
  6023. }
  6024. #endif // _MSC_VER
  6025. TEST_F(FormatTest, ConstructorInitializerIndentWidth) {
  6026. FormatStyle Style = getLLVMStyle();
  6027. Style.ConstructorInitializerIndentWidth = 4;
  6028. verifyFormat(
  6029. "SomeClass::Constructor()\n"
  6030. " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n"
  6031. " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}",
  6032. Style);
  6033. Style.ConstructorInitializerIndentWidth = 2;
  6034. verifyFormat(
  6035. "SomeClass::Constructor()\n"
  6036. " : aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n"
  6037. " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}",
  6038. Style);
  6039. Style.ConstructorInitializerIndentWidth = 0;
  6040. verifyFormat(
  6041. "SomeClass::Constructor()\n"
  6042. ": aaaaaaaaaaaaa(aaaaaaaaaaaaaa), aaaaaaaaaaaaa(aaaaaaaaaaaaaa),\n"
  6043. " aaaaaaaaaaaaa(aaaaaaaaaaaaaa) {}",
  6044. Style);
  6045. Style.BreakConstructorInitializersBeforeComma = true;
  6046. Style.ConstructorInitializerIndentWidth = 4;
  6047. verifyFormat("SomeClass::Constructor()\n"
  6048. " : a(a)\n"
  6049. " , b(b)\n"
  6050. " , c(c) {}",
  6051. Style);
  6052. Style.ConstructorInitializerIndentWidth = 2;
  6053. verifyFormat("SomeClass::Constructor()\n"
  6054. " : a(a)\n"
  6055. " , b(b)\n"
  6056. " , c(c) {}",
  6057. Style);
  6058. Style.ConstructorInitializerIndentWidth = 0;
  6059. verifyFormat("SomeClass::Constructor()\n"
  6060. ": a(a)\n"
  6061. ", b(b)\n"
  6062. ", c(c) {}",
  6063. Style);
  6064. Style.ConstructorInitializerAllOnOneLineOrOnePerLine = true;
  6065. Style.ConstructorInitializerIndentWidth = 4;
  6066. verifyFormat(
  6067. "SomeClass::Constructor()\n"
  6068. " : aaaaaaaa(aaaaaaaa), aaaaaaaa(aaaaaaaa), aaaaaaaa(aaaaaaaa) {}",
  6069. Style);
  6070. Style.ConstructorInitializerIndentWidth = 4;
  6071. Style.ColumnLimit = 60;
  6072. verifyFormat("SomeClass::Constructor()\n"
  6073. " : aaaaaaaa(aaaaaaaa)\n"
  6074. " , aaaaaaaa(aaaaaaaa)\n"
  6075. " , aaaaaaaa(aaaaaaaa) {}",
  6076. Style);
  6077. }
  6078. TEST_F(FormatTest, FormatsWithWebKitStyle) {
  6079. FormatStyle Style = getWebKitStyle();
  6080. // Don't indent in outer namespaces.
  6081. verifyFormat("namespace outer {\n"
  6082. "int i;\n"
  6083. "namespace inner {\n"
  6084. " int i;\n"
  6085. "} // namespace inner\n"
  6086. "} // namespace outer\n"
  6087. "namespace other_outer {\n"
  6088. "int i;\n"
  6089. "}",
  6090. Style);
  6091. // Don't indent case labels.
  6092. verifyFormat("switch (variable) {\n"
  6093. "case 1:\n"
  6094. "case 2:\n"
  6095. " doSomething();\n"
  6096. " break;\n"
  6097. "default:\n"
  6098. " ++variable;\n"
  6099. "}",
  6100. Style);
  6101. // Wrap before binary operators.
  6102. EXPECT_EQ(
  6103. "void f()\n"
  6104. "{\n"
  6105. " if (aaaaaaaaaaaaaaaa\n"
  6106. " && bbbbbbbbbbbbbbbbbbbbbbbb\n"
  6107. " && (cccccccccccccccccccccccccc || dddddddddddddddddddd))\n"
  6108. " return;\n"
  6109. "}",
  6110. format(
  6111. "void f() {\n"
  6112. "if (aaaaaaaaaaaaaaaa\n"
  6113. "&& bbbbbbbbbbbbbbbbbbbbbbbb\n"
  6114. "&& (cccccccccccccccccccccccccc || dddddddddddddddddddd))\n"
  6115. "return;\n"
  6116. "}",
  6117. Style));
  6118. // Constructor initializers are formatted one per line with the "," on the
  6119. // new line.
  6120. verifyFormat("Constructor()\n"
  6121. " : aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaaaaaaaaaaaaaaa)\n"
  6122. " , aaaaaaaaaaaaaaaaaaaaaaaa(aaaaaaaaaaaaaa, // break\n"
  6123. " aaaaaaaaaaaaaa)\n"
  6124. " , aaaaaaaaaaaaaaaaaaaaaaa()\n{\n}",
  6125. Style);
  6126. // Access specifiers should be aligned left.
  6127. verifyFormat("class C {\n"
  6128. "public:\n"
  6129. " int i;\n"
  6130. "};",
  6131. Style);
  6132. // Do not align comments.
  6133. verifyFormat("int a; // Do not\n"
  6134. "double b; // align comments.",
  6135. Style);
  6136. // Accept input's line breaks.
  6137. EXPECT_EQ("if (aaaaaaaaaaaaaaa\n"
  6138. " || bbbbbbbbbbbbbbb) {\n"
  6139. " i++;\n"
  6140. "}",
  6141. format("if (aaaaaaaaaaaaaaa\n"
  6142. "|| bbbbbbbbbbbbbbb) { i++; }",
  6143. Style));
  6144. EXPECT_EQ("if (aaaaaaaaaaaaaaa || bbbbbbbbbbbbbbb) {\n"
  6145. " i++;\n"
  6146. "}",
  6147. format("if (aaaaaaaaaaaaaaa || bbbbbbbbbbbbbbb) { i++; }", Style));
  6148. }
  6149. TEST_F(FormatTest, FormatsProtocolBufferDefinitions) {
  6150. // It seems that clang-format can format protocol buffer definitions
  6151. // (see https://code.google.com/p/protobuf/).
  6152. verifyFormat("message SomeMessage {\n"
  6153. " required int32 field1 = 1;\n"
  6154. " optional string field2 = 2 [default = \"2\"]\n"
  6155. "}");
  6156. }
  6157. TEST_F(FormatTest, FormatsLambdas) {
  6158. verifyFormat("int c = [b]() mutable {\n"
  6159. " return [&b] { return b++; }();\n"
  6160. "}();\n");
  6161. verifyFormat("int c = [&] {\n"
  6162. " [=] { return b++; }();\n"
  6163. "}();\n");
  6164. verifyFormat("int c = [&, &a, a] {\n"
  6165. " [=, c, &d] { return b++; }();\n"
  6166. "}();\n");
  6167. verifyFormat("int c = [&a, &a, a] {\n"
  6168. " [=, a, b, &c] { return b++; }();\n"
  6169. "}();\n");
  6170. verifyFormat("auto c = { [&a, &a, a] {\n"
  6171. " [=, a, b, &c] { return b++; }();\n"
  6172. "} }\n");
  6173. verifyFormat("auto c = { [&a, &a, a] { [=, a, b, &c] {}(); } }\n");
  6174. verifyFormat("void f() {\n"
  6175. " other(x.begin(), x.end(), [&](int, int) { return 1; });\n"
  6176. "}\n");
  6177. verifyFormat("void f() {\n"
  6178. " other(x.begin(), //\n"
  6179. " x.end(), //\n"
  6180. " [&](int, int) { return 1; });\n"
  6181. "}\n");
  6182. // Not lambdas.
  6183. verifyFormat("constexpr char hello[]{ \"hello\" };");
  6184. verifyFormat("double &operator[](int i) { return 0; }\n"
  6185. "int i;");
  6186. }
  6187. TEST_F(FormatTest, FormatsBlocks) {
  6188. // FIXME: Make whitespace formatting consistent. Ask a ObjC dev how
  6189. // it would ideally look.
  6190. verifyFormat("[operation setCompletionBlock:^{ [self onOperationDone]; }];");
  6191. verifyFormat("int i = {[operation setCompletionBlock : ^{ [self "
  6192. "onOperationDone]; }] };");
  6193. }
  6194. TEST_F(FormatTest, SupportsCRLF) {
  6195. EXPECT_EQ("int a;\r\n"
  6196. "int b;\r\n"
  6197. "int c;\r\n",
  6198. format("int a;\r\n"
  6199. " int b;\r\n"
  6200. " int c;\r\n",
  6201. getLLVMStyle()));
  6202. EXPECT_EQ("int a;\r\n"
  6203. "int b;\r\n"
  6204. "int c;\r\n",
  6205. format("int a;\r\n"
  6206. " int b;\n"
  6207. " int c;\r\n",
  6208. getLLVMStyle()));
  6209. EXPECT_EQ("int a;\n"
  6210. "int b;\n"
  6211. "int c;\n",
  6212. format("int a;\r\n"
  6213. " int b;\n"
  6214. " int c;\n",
  6215. getLLVMStyle()));
  6216. EXPECT_EQ("\"aaaaaaa \"\r\n"
  6217. "\"bbbbbbb\";\r\n",
  6218. format("\"aaaaaaa bbbbbbb\";\r\n", getLLVMStyleWithColumns(10)));
  6219. EXPECT_EQ("#define A \\\r\n"
  6220. " b; \\\r\n"
  6221. " c; \\\r\n"
  6222. " d;\r\n",
  6223. format("#define A \\\r\n"
  6224. " b; \\\r\n"
  6225. " c; d; \r\n",
  6226. getGoogleStyle()));
  6227. }
  6228. } // end namespace tooling
  6229. } // end namespace clang