12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491 |
- //===--- Format.cpp - Format C++ code -------------------------------------===//
- //
- // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
- // See https://llvm.org/LICENSE.txt for license information.
- // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
- //
- //===----------------------------------------------------------------------===//
- ///
- /// \file
- /// This file implements functions declared in Format.h. This will be
- /// split into separate files as we go.
- ///
- //===----------------------------------------------------------------------===//
- #include "clang/Format/Format.h"
- #include "AffectedRangeManager.h"
- #include "BreakableToken.h"
- #include "ContinuationIndenter.h"
- #include "DefinitionBlockSeparator.h"
- #include "FormatInternal.h"
- #include "FormatTokenLexer.h"
- #include "NamespaceEndCommentsFixer.h"
- #include "QualifierAlignmentFixer.h"
- #include "SortJavaScriptImports.h"
- #include "TokenAnalyzer.h"
- #include "TokenAnnotator.h"
- #include "UnwrappedLineFormatter.h"
- #include "UnwrappedLineParser.h"
- #include "UsingDeclarationsSorter.h"
- #include "WhitespaceManager.h"
- #include "clang/Basic/Diagnostic.h"
- #include "clang/Basic/DiagnosticOptions.h"
- #include "clang/Basic/SourceManager.h"
- #include "clang/Lex/Lexer.h"
- #include "clang/Tooling/Inclusions/HeaderIncludes.h"
- #include "llvm/ADT/STLExtras.h"
- #include "llvm/ADT/StringRef.h"
- #include "llvm/Support/Allocator.h"
- #include "llvm/Support/Debug.h"
- #include "llvm/Support/Path.h"
- #include "llvm/Support/Regex.h"
- #include "llvm/Support/VirtualFileSystem.h"
- #include "llvm/Support/YAMLTraits.h"
- #include <algorithm>
- #include <memory>
- #include <mutex>
- #include <numeric>
- #include <string>
- #include <unordered_map>
- #define DEBUG_TYPE "format-formatter"
- using clang::format::FormatStyle;
- LLVM_YAML_IS_SEQUENCE_VECTOR(clang::format::FormatStyle::RawStringFormat)
- namespace llvm {
- namespace yaml {
- template <> struct ScalarEnumerationTraits<FormatStyle::LanguageKind> {
- static void enumeration(IO &IO, FormatStyle::LanguageKind &Value) {
- IO.enumCase(Value, "Cpp", FormatStyle::LK_Cpp);
- IO.enumCase(Value, "Java", FormatStyle::LK_Java);
- IO.enumCase(Value, "JavaScript", FormatStyle::LK_JavaScript);
- IO.enumCase(Value, "ObjC", FormatStyle::LK_ObjC);
- IO.enumCase(Value, "Proto", FormatStyle::LK_Proto);
- IO.enumCase(Value, "TableGen", FormatStyle::LK_TableGen);
- IO.enumCase(Value, "TextProto", FormatStyle::LK_TextProto);
- IO.enumCase(Value, "CSharp", FormatStyle::LK_CSharp);
- IO.enumCase(Value, "Json", FormatStyle::LK_Json);
- }
- };
- template <> struct ScalarEnumerationTraits<FormatStyle::LanguageStandard> {
- static void enumeration(IO &IO, FormatStyle::LanguageStandard &Value) {
- IO.enumCase(Value, "c++03", FormatStyle::LS_Cpp03);
- IO.enumCase(Value, "C++03", FormatStyle::LS_Cpp03); // Legacy alias
- IO.enumCase(Value, "Cpp03", FormatStyle::LS_Cpp03); // Legacy alias
- IO.enumCase(Value, "c++11", FormatStyle::LS_Cpp11);
- IO.enumCase(Value, "C++11", FormatStyle::LS_Cpp11); // Legacy alias
- IO.enumCase(Value, "c++14", FormatStyle::LS_Cpp14);
- IO.enumCase(Value, "c++17", FormatStyle::LS_Cpp17);
- IO.enumCase(Value, "c++20", FormatStyle::LS_Cpp20);
- IO.enumCase(Value, "Latest", FormatStyle::LS_Latest);
- IO.enumCase(Value, "Cpp11", FormatStyle::LS_Latest); // Legacy alias
- IO.enumCase(Value, "Auto", FormatStyle::LS_Auto);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::LambdaBodyIndentationKind> {
- static void enumeration(IO &IO,
- FormatStyle::LambdaBodyIndentationKind &Value) {
- IO.enumCase(Value, "Signature", FormatStyle::LBI_Signature);
- IO.enumCase(Value, "OuterScope", FormatStyle::LBI_OuterScope);
- }
- };
- template <> struct ScalarEnumerationTraits<FormatStyle::UseTabStyle> {
- static void enumeration(IO &IO, FormatStyle::UseTabStyle &Value) {
- IO.enumCase(Value, "Never", FormatStyle::UT_Never);
- IO.enumCase(Value, "false", FormatStyle::UT_Never);
- IO.enumCase(Value, "Always", FormatStyle::UT_Always);
- IO.enumCase(Value, "true", FormatStyle::UT_Always);
- IO.enumCase(Value, "ForIndentation", FormatStyle::UT_ForIndentation);
- IO.enumCase(Value, "ForContinuationAndIndentation",
- FormatStyle::UT_ForContinuationAndIndentation);
- IO.enumCase(Value, "AlignWithSpaces", FormatStyle::UT_AlignWithSpaces);
- }
- };
- template <> struct ScalarEnumerationTraits<FormatStyle::JavaScriptQuoteStyle> {
- static void enumeration(IO &IO, FormatStyle::JavaScriptQuoteStyle &Value) {
- IO.enumCase(Value, "Leave", FormatStyle::JSQS_Leave);
- IO.enumCase(Value, "Single", FormatStyle::JSQS_Single);
- IO.enumCase(Value, "Double", FormatStyle::JSQS_Double);
- }
- };
- template <> struct ScalarEnumerationTraits<FormatStyle::ShortBlockStyle> {
- static void enumeration(IO &IO, FormatStyle::ShortBlockStyle &Value) {
- IO.enumCase(Value, "Never", FormatStyle::SBS_Never);
- IO.enumCase(Value, "false", FormatStyle::SBS_Never);
- IO.enumCase(Value, "Always", FormatStyle::SBS_Always);
- IO.enumCase(Value, "true", FormatStyle::SBS_Always);
- IO.enumCase(Value, "Empty", FormatStyle::SBS_Empty);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::QualifierAlignmentStyle> {
- static void enumeration(IO &IO, FormatStyle::QualifierAlignmentStyle &Value) {
- IO.enumCase(Value, "Leave", FormatStyle::QAS_Leave);
- IO.enumCase(Value, "Left", FormatStyle::QAS_Left);
- IO.enumCase(Value, "Right", FormatStyle::QAS_Right);
- IO.enumCase(Value, "Custom", FormatStyle::QAS_Custom);
- }
- };
- template <> struct ScalarEnumerationTraits<FormatStyle::ShortFunctionStyle> {
- static void enumeration(IO &IO, FormatStyle::ShortFunctionStyle &Value) {
- IO.enumCase(Value, "None", FormatStyle::SFS_None);
- IO.enumCase(Value, "false", FormatStyle::SFS_None);
- IO.enumCase(Value, "All", FormatStyle::SFS_All);
- IO.enumCase(Value, "true", FormatStyle::SFS_All);
- IO.enumCase(Value, "Inline", FormatStyle::SFS_Inline);
- IO.enumCase(Value, "InlineOnly", FormatStyle::SFS_InlineOnly);
- IO.enumCase(Value, "Empty", FormatStyle::SFS_Empty);
- }
- };
- template <> struct ScalarEnumerationTraits<FormatStyle::AlignConsecutiveStyle> {
- static void enumeration(IO &IO, FormatStyle::AlignConsecutiveStyle &Value) {
- IO.enumCase(Value, "None", FormatStyle::ACS_None);
- IO.enumCase(Value, "Consecutive", FormatStyle::ACS_Consecutive);
- IO.enumCase(Value, "AcrossEmptyLines", FormatStyle::ACS_AcrossEmptyLines);
- IO.enumCase(Value, "AcrossComments", FormatStyle::ACS_AcrossComments);
- IO.enumCase(Value, "AcrossEmptyLinesAndComments",
- FormatStyle::ACS_AcrossEmptyLinesAndComments);
- // For backward compatibility.
- IO.enumCase(Value, "true", FormatStyle::ACS_Consecutive);
- IO.enumCase(Value, "false", FormatStyle::ACS_None);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::ArrayInitializerAlignmentStyle> {
- static void enumeration(IO &IO,
- FormatStyle::ArrayInitializerAlignmentStyle &Value) {
- IO.enumCase(Value, "None", FormatStyle::AIAS_None);
- IO.enumCase(Value, "Left", FormatStyle::AIAS_Left);
- IO.enumCase(Value, "Right", FormatStyle::AIAS_Right);
- }
- };
- template <> struct ScalarEnumerationTraits<FormatStyle::ShortIfStyle> {
- static void enumeration(IO &IO, FormatStyle::ShortIfStyle &Value) {
- IO.enumCase(Value, "Never", FormatStyle::SIS_Never);
- IO.enumCase(Value, "WithoutElse", FormatStyle::SIS_WithoutElse);
- IO.enumCase(Value, "OnlyFirstIf", FormatStyle::SIS_OnlyFirstIf);
- IO.enumCase(Value, "AllIfsAndElse", FormatStyle::SIS_AllIfsAndElse);
- // For backward compatibility.
- IO.enumCase(Value, "Always", FormatStyle::SIS_OnlyFirstIf);
- IO.enumCase(Value, "false", FormatStyle::SIS_Never);
- IO.enumCase(Value, "true", FormatStyle::SIS_WithoutElse);
- }
- };
- template <> struct ScalarEnumerationTraits<FormatStyle::ShortLambdaStyle> {
- static void enumeration(IO &IO, FormatStyle::ShortLambdaStyle &Value) {
- IO.enumCase(Value, "None", FormatStyle::SLS_None);
- IO.enumCase(Value, "false", FormatStyle::SLS_None);
- IO.enumCase(Value, "Empty", FormatStyle::SLS_Empty);
- IO.enumCase(Value, "Inline", FormatStyle::SLS_Inline);
- IO.enumCase(Value, "All", FormatStyle::SLS_All);
- IO.enumCase(Value, "true", FormatStyle::SLS_All);
- }
- };
- template <> struct ScalarEnumerationTraits<FormatStyle::BinPackStyle> {
- static void enumeration(IO &IO, FormatStyle::BinPackStyle &Value) {
- IO.enumCase(Value, "Auto", FormatStyle::BPS_Auto);
- IO.enumCase(Value, "Always", FormatStyle::BPS_Always);
- IO.enumCase(Value, "Never", FormatStyle::BPS_Never);
- }
- };
- template <> struct ScalarEnumerationTraits<FormatStyle::TrailingCommaStyle> {
- static void enumeration(IO &IO, FormatStyle::TrailingCommaStyle &Value) {
- IO.enumCase(Value, "None", FormatStyle::TCS_None);
- IO.enumCase(Value, "Wrapped", FormatStyle::TCS_Wrapped);
- }
- };
- template <> struct ScalarEnumerationTraits<FormatStyle::BinaryOperatorStyle> {
- static void enumeration(IO &IO, FormatStyle::BinaryOperatorStyle &Value) {
- IO.enumCase(Value, "All", FormatStyle::BOS_All);
- IO.enumCase(Value, "true", FormatStyle::BOS_All);
- IO.enumCase(Value, "None", FormatStyle::BOS_None);
- IO.enumCase(Value, "false", FormatStyle::BOS_None);
- IO.enumCase(Value, "NonAssignment", FormatStyle::BOS_NonAssignment);
- }
- };
- template <> struct ScalarEnumerationTraits<FormatStyle::BraceBreakingStyle> {
- static void enumeration(IO &IO, FormatStyle::BraceBreakingStyle &Value) {
- IO.enumCase(Value, "Attach", FormatStyle::BS_Attach);
- IO.enumCase(Value, "Linux", FormatStyle::BS_Linux);
- IO.enumCase(Value, "Mozilla", FormatStyle::BS_Mozilla);
- IO.enumCase(Value, "Stroustrup", FormatStyle::BS_Stroustrup);
- IO.enumCase(Value, "Allman", FormatStyle::BS_Allman);
- IO.enumCase(Value, "Whitesmiths", FormatStyle::BS_Whitesmiths);
- IO.enumCase(Value, "GNU", FormatStyle::BS_GNU);
- IO.enumCase(Value, "WebKit", FormatStyle::BS_WebKit);
- IO.enumCase(Value, "Custom", FormatStyle::BS_Custom);
- }
- };
- template <>
- struct ScalarEnumerationTraits<
- FormatStyle::BraceWrappingAfterControlStatementStyle> {
- static void
- enumeration(IO &IO,
- FormatStyle::BraceWrappingAfterControlStatementStyle &Value) {
- IO.enumCase(Value, "Never", FormatStyle::BWACS_Never);
- IO.enumCase(Value, "MultiLine", FormatStyle::BWACS_MultiLine);
- IO.enumCase(Value, "Always", FormatStyle::BWACS_Always);
- // For backward compatibility.
- IO.enumCase(Value, "false", FormatStyle::BWACS_Never);
- IO.enumCase(Value, "true", FormatStyle::BWACS_Always);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::BreakConstructorInitializersStyle> {
- static void
- enumeration(IO &IO, FormatStyle::BreakConstructorInitializersStyle &Value) {
- IO.enumCase(Value, "BeforeColon", FormatStyle::BCIS_BeforeColon);
- IO.enumCase(Value, "BeforeComma", FormatStyle::BCIS_BeforeComma);
- IO.enumCase(Value, "AfterColon", FormatStyle::BCIS_AfterColon);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::BreakInheritanceListStyle> {
- static void enumeration(IO &IO,
- FormatStyle::BreakInheritanceListStyle &Value) {
- IO.enumCase(Value, "BeforeColon", FormatStyle::BILS_BeforeColon);
- IO.enumCase(Value, "BeforeComma", FormatStyle::BILS_BeforeComma);
- IO.enumCase(Value, "AfterColon", FormatStyle::BILS_AfterColon);
- IO.enumCase(Value, "AfterComma", FormatStyle::BILS_AfterComma);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::PackConstructorInitializersStyle> {
- static void
- enumeration(IO &IO, FormatStyle::PackConstructorInitializersStyle &Value) {
- IO.enumCase(Value, "Never", FormatStyle::PCIS_Never);
- IO.enumCase(Value, "BinPack", FormatStyle::PCIS_BinPack);
- IO.enumCase(Value, "CurrentLine", FormatStyle::PCIS_CurrentLine);
- IO.enumCase(Value, "NextLine", FormatStyle::PCIS_NextLine);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::EmptyLineAfterAccessModifierStyle> {
- static void
- enumeration(IO &IO, FormatStyle::EmptyLineAfterAccessModifierStyle &Value) {
- IO.enumCase(Value, "Never", FormatStyle::ELAAMS_Never);
- IO.enumCase(Value, "Leave", FormatStyle::ELAAMS_Leave);
- IO.enumCase(Value, "Always", FormatStyle::ELAAMS_Always);
- }
- };
- template <>
- struct ScalarEnumerationTraits<
- FormatStyle::EmptyLineBeforeAccessModifierStyle> {
- static void
- enumeration(IO &IO, FormatStyle::EmptyLineBeforeAccessModifierStyle &Value) {
- IO.enumCase(Value, "Never", FormatStyle::ELBAMS_Never);
- IO.enumCase(Value, "Leave", FormatStyle::ELBAMS_Leave);
- IO.enumCase(Value, "LogicalBlock", FormatStyle::ELBAMS_LogicalBlock);
- IO.enumCase(Value, "Always", FormatStyle::ELBAMS_Always);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::PPDirectiveIndentStyle> {
- static void enumeration(IO &IO, FormatStyle::PPDirectiveIndentStyle &Value) {
- IO.enumCase(Value, "None", FormatStyle::PPDIS_None);
- IO.enumCase(Value, "AfterHash", FormatStyle::PPDIS_AfterHash);
- IO.enumCase(Value, "BeforeHash", FormatStyle::PPDIS_BeforeHash);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::IndentExternBlockStyle> {
- static void enumeration(IO &IO, FormatStyle::IndentExternBlockStyle &Value) {
- IO.enumCase(Value, "AfterExternBlock", FormatStyle::IEBS_AfterExternBlock);
- IO.enumCase(Value, "Indent", FormatStyle::IEBS_Indent);
- IO.enumCase(Value, "NoIndent", FormatStyle::IEBS_NoIndent);
- IO.enumCase(Value, "true", FormatStyle::IEBS_Indent);
- IO.enumCase(Value, "false", FormatStyle::IEBS_NoIndent);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::ReturnTypeBreakingStyle> {
- static void enumeration(IO &IO, FormatStyle::ReturnTypeBreakingStyle &Value) {
- IO.enumCase(Value, "None", FormatStyle::RTBS_None);
- IO.enumCase(Value, "All", FormatStyle::RTBS_All);
- IO.enumCase(Value, "TopLevel", FormatStyle::RTBS_TopLevel);
- IO.enumCase(Value, "TopLevelDefinitions",
- FormatStyle::RTBS_TopLevelDefinitions);
- IO.enumCase(Value, "AllDefinitions", FormatStyle::RTBS_AllDefinitions);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::BreakTemplateDeclarationsStyle> {
- static void enumeration(IO &IO,
- FormatStyle::BreakTemplateDeclarationsStyle &Value) {
- IO.enumCase(Value, "No", FormatStyle::BTDS_No);
- IO.enumCase(Value, "MultiLine", FormatStyle::BTDS_MultiLine);
- IO.enumCase(Value, "Yes", FormatStyle::BTDS_Yes);
- // For backward compatibility.
- IO.enumCase(Value, "false", FormatStyle::BTDS_MultiLine);
- IO.enumCase(Value, "true", FormatStyle::BTDS_Yes);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::DefinitionReturnTypeBreakingStyle> {
- static void
- enumeration(IO &IO, FormatStyle::DefinitionReturnTypeBreakingStyle &Value) {
- IO.enumCase(Value, "None", FormatStyle::DRTBS_None);
- IO.enumCase(Value, "All", FormatStyle::DRTBS_All);
- IO.enumCase(Value, "TopLevel", FormatStyle::DRTBS_TopLevel);
- // For backward compatibility.
- IO.enumCase(Value, "false", FormatStyle::DRTBS_None);
- IO.enumCase(Value, "true", FormatStyle::DRTBS_All);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::NamespaceIndentationKind> {
- static void enumeration(IO &IO,
- FormatStyle::NamespaceIndentationKind &Value) {
- IO.enumCase(Value, "None", FormatStyle::NI_None);
- IO.enumCase(Value, "Inner", FormatStyle::NI_Inner);
- IO.enumCase(Value, "All", FormatStyle::NI_All);
- }
- };
- template <> struct ScalarEnumerationTraits<FormatStyle::BracketAlignmentStyle> {
- static void enumeration(IO &IO, FormatStyle::BracketAlignmentStyle &Value) {
- IO.enumCase(Value, "Align", FormatStyle::BAS_Align);
- IO.enumCase(Value, "DontAlign", FormatStyle::BAS_DontAlign);
- IO.enumCase(Value, "AlwaysBreak", FormatStyle::BAS_AlwaysBreak);
- IO.enumCase(Value, "BlockIndent", FormatStyle::BAS_BlockIndent);
- // For backward compatibility.
- IO.enumCase(Value, "true", FormatStyle::BAS_Align);
- IO.enumCase(Value, "false", FormatStyle::BAS_DontAlign);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::EscapedNewlineAlignmentStyle> {
- static void enumeration(IO &IO,
- FormatStyle::EscapedNewlineAlignmentStyle &Value) {
- IO.enumCase(Value, "DontAlign", FormatStyle::ENAS_DontAlign);
- IO.enumCase(Value, "Left", FormatStyle::ENAS_Left);
- IO.enumCase(Value, "Right", FormatStyle::ENAS_Right);
- // For backward compatibility.
- IO.enumCase(Value, "true", FormatStyle::ENAS_Left);
- IO.enumCase(Value, "false", FormatStyle::ENAS_Right);
- }
- };
- template <> struct ScalarEnumerationTraits<FormatStyle::OperandAlignmentStyle> {
- static void enumeration(IO &IO, FormatStyle::OperandAlignmentStyle &Value) {
- IO.enumCase(Value, "DontAlign", FormatStyle::OAS_DontAlign);
- IO.enumCase(Value, "Align", FormatStyle::OAS_Align);
- IO.enumCase(Value, "AlignAfterOperator",
- FormatStyle::OAS_AlignAfterOperator);
- // For backward compatibility.
- IO.enumCase(Value, "true", FormatStyle::OAS_Align);
- IO.enumCase(Value, "false", FormatStyle::OAS_DontAlign);
- }
- };
- template <> struct ScalarEnumerationTraits<FormatStyle::PointerAlignmentStyle> {
- static void enumeration(IO &IO, FormatStyle::PointerAlignmentStyle &Value) {
- IO.enumCase(Value, "Middle", FormatStyle::PAS_Middle);
- IO.enumCase(Value, "Left", FormatStyle::PAS_Left);
- IO.enumCase(Value, "Right", FormatStyle::PAS_Right);
- // For backward compatibility.
- IO.enumCase(Value, "true", FormatStyle::PAS_Left);
- IO.enumCase(Value, "false", FormatStyle::PAS_Right);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::SeparateDefinitionStyle> {
- static void enumeration(IO &IO, FormatStyle::SeparateDefinitionStyle &Value) {
- IO.enumCase(Value, "Leave", FormatStyle::SDS_Leave);
- IO.enumCase(Value, "Always", FormatStyle::SDS_Always);
- IO.enumCase(Value, "Never", FormatStyle::SDS_Never);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::SpaceAroundPointerQualifiersStyle> {
- static void
- enumeration(IO &IO, FormatStyle::SpaceAroundPointerQualifiersStyle &Value) {
- IO.enumCase(Value, "Default", FormatStyle::SAPQ_Default);
- IO.enumCase(Value, "Before", FormatStyle::SAPQ_Before);
- IO.enumCase(Value, "After", FormatStyle::SAPQ_After);
- IO.enumCase(Value, "Both", FormatStyle::SAPQ_Both);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::ReferenceAlignmentStyle> {
- static void enumeration(IO &IO, FormatStyle::ReferenceAlignmentStyle &Value) {
- IO.enumCase(Value, "Pointer", FormatStyle::RAS_Pointer);
- IO.enumCase(Value, "Middle", FormatStyle::RAS_Middle);
- IO.enumCase(Value, "Left", FormatStyle::RAS_Left);
- IO.enumCase(Value, "Right", FormatStyle::RAS_Right);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::SpaceBeforeParensStyle> {
- static void enumeration(IO &IO, FormatStyle::SpaceBeforeParensStyle &Value) {
- IO.enumCase(Value, "Never", FormatStyle::SBPO_Never);
- IO.enumCase(Value, "ControlStatements",
- FormatStyle::SBPO_ControlStatements);
- IO.enumCase(Value, "ControlStatementsExceptControlMacros",
- FormatStyle::SBPO_ControlStatementsExceptControlMacros);
- IO.enumCase(Value, "NonEmptyParentheses",
- FormatStyle::SBPO_NonEmptyParentheses);
- IO.enumCase(Value, "Always", FormatStyle::SBPO_Always);
- IO.enumCase(Value, "Custom", FormatStyle::SBPO_Custom);
- // For backward compatibility.
- IO.enumCase(Value, "false", FormatStyle::SBPO_Never);
- IO.enumCase(Value, "true", FormatStyle::SBPO_ControlStatements);
- IO.enumCase(Value, "ControlStatementsExceptForEachMacros",
- FormatStyle::SBPO_ControlStatementsExceptControlMacros);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::BitFieldColonSpacingStyle> {
- static void enumeration(IO &IO,
- FormatStyle::BitFieldColonSpacingStyle &Value) {
- IO.enumCase(Value, "Both", FormatStyle::BFCS_Both);
- IO.enumCase(Value, "None", FormatStyle::BFCS_None);
- IO.enumCase(Value, "Before", FormatStyle::BFCS_Before);
- IO.enumCase(Value, "After", FormatStyle::BFCS_After);
- }
- };
- template <> struct ScalarEnumerationTraits<FormatStyle::SortIncludesOptions> {
- static void enumeration(IO &IO, FormatStyle::SortIncludesOptions &Value) {
- IO.enumCase(Value, "Never", FormatStyle::SI_Never);
- IO.enumCase(Value, "CaseInsensitive", FormatStyle::SI_CaseInsensitive);
- IO.enumCase(Value, "CaseSensitive", FormatStyle::SI_CaseSensitive);
- // For backward compatibility.
- IO.enumCase(Value, "false", FormatStyle::SI_Never);
- IO.enumCase(Value, "true", FormatStyle::SI_CaseSensitive);
- }
- };
- template <>
- struct ScalarEnumerationTraits<FormatStyle::SortJavaStaticImportOptions> {
- static void enumeration(IO &IO,
- FormatStyle::SortJavaStaticImportOptions &Value) {
- IO.enumCase(Value, "Before", FormatStyle::SJSIO_Before);
- IO.enumCase(Value, "After", FormatStyle::SJSIO_After);
- }
- };
- template <> struct ScalarEnumerationTraits<FormatStyle::SpacesInAnglesStyle> {
- static void enumeration(IO &IO, FormatStyle::SpacesInAnglesStyle &Value) {
- IO.enumCase(Value, "Never", FormatStyle::SIAS_Never);
- IO.enumCase(Value, "Always", FormatStyle::SIAS_Always);
- IO.enumCase(Value, "Leave", FormatStyle::SIAS_Leave);
- // For backward compatibility.
- IO.enumCase(Value, "false", FormatStyle::SIAS_Never);
- IO.enumCase(Value, "true", FormatStyle::SIAS_Always);
- }
- };
- template <> struct MappingTraits<FormatStyle> {
- static void mapping(IO &IO, FormatStyle &Style) {
- // When reading, read the language first, we need it for getPredefinedStyle.
- IO.mapOptional("Language", Style.Language);
- if (IO.outputting()) {
- StringRef Styles[] = {"LLVM", "Google", "Chromium", "Mozilla",
- "WebKit", "GNU", "Microsoft"};
- for (StringRef StyleName : Styles) {
- FormatStyle PredefinedStyle;
- if (getPredefinedStyle(StyleName, Style.Language, &PredefinedStyle) &&
- Style == PredefinedStyle) {
- IO.mapOptional("# BasedOnStyle", StyleName);
- break;
- }
- }
- } else {
- StringRef BasedOnStyle;
- IO.mapOptional("BasedOnStyle", BasedOnStyle);
- if (!BasedOnStyle.empty()) {
- FormatStyle::LanguageKind OldLanguage = Style.Language;
- FormatStyle::LanguageKind Language =
- ((FormatStyle *)IO.getContext())->Language;
- if (!getPredefinedStyle(BasedOnStyle, Language, &Style)) {
- IO.setError(Twine("Unknown value for BasedOnStyle: ", BasedOnStyle));
- return;
- }
- Style.Language = OldLanguage;
- }
- }
- // For backward compatibility.
- if (!IO.outputting()) {
- IO.mapOptional("AlignEscapedNewlinesLeft", Style.AlignEscapedNewlines);
- IO.mapOptional("DerivePointerBinding", Style.DerivePointerAlignment);
- IO.mapOptional("IndentFunctionDeclarationAfterType",
- Style.IndentWrappedFunctionNames);
- IO.mapOptional("PointerBindsToType", Style.PointerAlignment);
- IO.mapOptional("SpaceAfterControlStatementKeyword",
- Style.SpaceBeforeParens);
- }
- IO.mapOptional("AccessModifierOffset", Style.AccessModifierOffset);
- IO.mapOptional("AlignAfterOpenBracket", Style.AlignAfterOpenBracket);
- IO.mapOptional("AlignArrayOfStructures", Style.AlignArrayOfStructures);
- IO.mapOptional("AlignConsecutiveMacros", Style.AlignConsecutiveMacros);
- IO.mapOptional("AlignConsecutiveAssignments",
- Style.AlignConsecutiveAssignments);
- IO.mapOptional("AlignConsecutiveBitFields",
- Style.AlignConsecutiveBitFields);
- IO.mapOptional("AlignConsecutiveDeclarations",
- Style.AlignConsecutiveDeclarations);
- IO.mapOptional("AlignEscapedNewlines", Style.AlignEscapedNewlines);
- IO.mapOptional("AlignOperands", Style.AlignOperands);
- IO.mapOptional("AlignTrailingComments", Style.AlignTrailingComments);
- IO.mapOptional("AllowAllArgumentsOnNextLine",
- Style.AllowAllArgumentsOnNextLine);
- IO.mapOptional("AllowAllParametersOfDeclarationOnNextLine",
- Style.AllowAllParametersOfDeclarationOnNextLine);
- IO.mapOptional("AllowShortEnumsOnASingleLine",
- Style.AllowShortEnumsOnASingleLine);
- IO.mapOptional("AllowShortBlocksOnASingleLine",
- Style.AllowShortBlocksOnASingleLine);
- IO.mapOptional("AllowShortCaseLabelsOnASingleLine",
- Style.AllowShortCaseLabelsOnASingleLine);
- IO.mapOptional("AllowShortFunctionsOnASingleLine",
- Style.AllowShortFunctionsOnASingleLine);
- IO.mapOptional("AllowShortLambdasOnASingleLine",
- Style.AllowShortLambdasOnASingleLine);
- IO.mapOptional("AllowShortIfStatementsOnASingleLine",
- Style.AllowShortIfStatementsOnASingleLine);
- IO.mapOptional("AllowShortLoopsOnASingleLine",
- Style.AllowShortLoopsOnASingleLine);
- IO.mapOptional("AlwaysBreakAfterDefinitionReturnType",
- Style.AlwaysBreakAfterDefinitionReturnType);
- IO.mapOptional("AlwaysBreakAfterReturnType",
- Style.AlwaysBreakAfterReturnType);
- // If AlwaysBreakAfterDefinitionReturnType was specified but
- // AlwaysBreakAfterReturnType was not, initialize the latter from the
- // former for backwards compatibility.
- if (Style.AlwaysBreakAfterDefinitionReturnType != FormatStyle::DRTBS_None &&
- Style.AlwaysBreakAfterReturnType == FormatStyle::RTBS_None) {
- if (Style.AlwaysBreakAfterDefinitionReturnType == FormatStyle::DRTBS_All)
- Style.AlwaysBreakAfterReturnType = FormatStyle::RTBS_AllDefinitions;
- else if (Style.AlwaysBreakAfterDefinitionReturnType ==
- FormatStyle::DRTBS_TopLevel)
- Style.AlwaysBreakAfterReturnType =
- FormatStyle::RTBS_TopLevelDefinitions;
- }
- IO.mapOptional("AlwaysBreakBeforeMultilineStrings",
- Style.AlwaysBreakBeforeMultilineStrings);
- IO.mapOptional("AlwaysBreakTemplateDeclarations",
- Style.AlwaysBreakTemplateDeclarations);
- IO.mapOptional("AttributeMacros", Style.AttributeMacros);
- IO.mapOptional("BinPackArguments", Style.BinPackArguments);
- IO.mapOptional("BinPackParameters", Style.BinPackParameters);
- IO.mapOptional("BraceWrapping", Style.BraceWrapping);
- IO.mapOptional("BreakBeforeBinaryOperators",
- Style.BreakBeforeBinaryOperators);
- IO.mapOptional("BreakBeforeConceptDeclarations",
- Style.BreakBeforeConceptDeclarations);
- IO.mapOptional("BreakBeforeBraces", Style.BreakBeforeBraces);
- bool BreakBeforeInheritanceComma = false;
- IO.mapOptional("BreakBeforeInheritanceComma", BreakBeforeInheritanceComma);
- IO.mapOptional("BreakInheritanceList", Style.BreakInheritanceList);
- // If BreakBeforeInheritanceComma was specified but
- // BreakInheritance was not, initialize the latter from the
- // former for backwards compatibility.
- if (BreakBeforeInheritanceComma &&
- Style.BreakInheritanceList == FormatStyle::BILS_BeforeColon)
- Style.BreakInheritanceList = FormatStyle::BILS_BeforeComma;
- IO.mapOptional("BreakBeforeTernaryOperators",
- Style.BreakBeforeTernaryOperators);
- bool BreakConstructorInitializersBeforeComma = false;
- IO.mapOptional("BreakConstructorInitializersBeforeComma",
- BreakConstructorInitializersBeforeComma);
- IO.mapOptional("BreakConstructorInitializers",
- Style.BreakConstructorInitializers);
- // If BreakConstructorInitializersBeforeComma was specified but
- // BreakConstructorInitializers was not, initialize the latter from the
- // former for backwards compatibility.
- if (BreakConstructorInitializersBeforeComma &&
- Style.BreakConstructorInitializers == FormatStyle::BCIS_BeforeColon)
- Style.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
- IO.mapOptional("BreakAfterJavaFieldAnnotations",
- Style.BreakAfterJavaFieldAnnotations);
- IO.mapOptional("BreakStringLiterals", Style.BreakStringLiterals);
- IO.mapOptional("ColumnLimit", Style.ColumnLimit);
- IO.mapOptional("CommentPragmas", Style.CommentPragmas);
- IO.mapOptional("QualifierAlignment", Style.QualifierAlignment);
- // Default Order for Left/Right based Qualifier alignment.
- if (Style.QualifierAlignment == FormatStyle::QAS_Right) {
- Style.QualifierOrder = {"type", "const", "volatile"};
- } else if (Style.QualifierAlignment == FormatStyle::QAS_Left) {
- Style.QualifierOrder = {"const", "volatile", "type"};
- } else if (Style.QualifierAlignment == FormatStyle::QAS_Custom) {
- IO.mapOptional("QualifierOrder", Style.QualifierOrder);
- }
- IO.mapOptional("CompactNamespaces", Style.CompactNamespaces);
- IO.mapOptional("ConstructorInitializerIndentWidth",
- Style.ConstructorInitializerIndentWidth);
- IO.mapOptional("ContinuationIndentWidth", Style.ContinuationIndentWidth);
- IO.mapOptional("Cpp11BracedListStyle", Style.Cpp11BracedListStyle);
- IO.mapOptional("DeriveLineEnding", Style.DeriveLineEnding);
- IO.mapOptional("DerivePointerAlignment", Style.DerivePointerAlignment);
- IO.mapOptional("DisableFormat", Style.DisableFormat);
- IO.mapOptional("EmptyLineAfterAccessModifier",
- Style.EmptyLineAfterAccessModifier);
- IO.mapOptional("EmptyLineBeforeAccessModifier",
- Style.EmptyLineBeforeAccessModifier);
- IO.mapOptional("ExperimentalAutoDetectBinPacking",
- Style.ExperimentalAutoDetectBinPacking);
- IO.mapOptional("PackConstructorInitializers",
- Style.PackConstructorInitializers);
- // For backward compatibility:
- // The default value of ConstructorInitializerAllOnOneLineOrOnePerLine was
- // false unless BasedOnStyle was Google or Chromium whereas that of
- // AllowAllConstructorInitializersOnNextLine was always true, so the
- // equivalent default value of PackConstructorInitializers is PCIS_NextLine
- // for Google/Chromium or PCIS_BinPack otherwise. If the deprecated options
- // had a non-default value while PackConstructorInitializers has a default
- // value, set the latter to an equivalent non-default value if needed.
- StringRef BasedOn;
- IO.mapOptional("BasedOnStyle", BasedOn);
- const bool IsGoogleOrChromium = BasedOn.equals_insensitive("google") ||
- BasedOn.equals_insensitive("chromium");
- bool OnCurrentLine = IsGoogleOrChromium;
- bool OnNextLine = true;
- IO.mapOptional("ConstructorInitializerAllOnOneLineOrOnePerLine",
- OnCurrentLine);
- IO.mapOptional("AllowAllConstructorInitializersOnNextLine", OnNextLine);
- if (!IsGoogleOrChromium) {
- if (Style.PackConstructorInitializers == FormatStyle::PCIS_BinPack &&
- OnCurrentLine) {
- Style.PackConstructorInitializers = OnNextLine
- ? FormatStyle::PCIS_NextLine
- : FormatStyle::PCIS_CurrentLine;
- }
- } else if (Style.PackConstructorInitializers ==
- FormatStyle::PCIS_NextLine) {
- if (!OnCurrentLine)
- Style.PackConstructorInitializers = FormatStyle::PCIS_BinPack;
- else if (!OnNextLine)
- Style.PackConstructorInitializers = FormatStyle::PCIS_CurrentLine;
- }
- IO.mapOptional("FixNamespaceComments", Style.FixNamespaceComments);
- IO.mapOptional("ForEachMacros", Style.ForEachMacros);
- IO.mapOptional("IfMacros", Style.IfMacros);
- IO.mapOptional("IncludeBlocks", Style.IncludeStyle.IncludeBlocks);
- IO.mapOptional("IncludeCategories", Style.IncludeStyle.IncludeCategories);
- IO.mapOptional("IncludeIsMainRegex", Style.IncludeStyle.IncludeIsMainRegex);
- IO.mapOptional("IncludeIsMainSourceRegex",
- Style.IncludeStyle.IncludeIsMainSourceRegex);
- IO.mapOptional("IndentAccessModifiers", Style.IndentAccessModifiers);
- IO.mapOptional("IndentCaseLabels", Style.IndentCaseLabels);
- IO.mapOptional("IndentCaseBlocks", Style.IndentCaseBlocks);
- IO.mapOptional("IndentGotoLabels", Style.IndentGotoLabels);
- IO.mapOptional("IndentPPDirectives", Style.IndentPPDirectives);
- IO.mapOptional("IndentExternBlock", Style.IndentExternBlock);
- IO.mapOptional("IndentRequires", Style.IndentRequires);
- IO.mapOptional("IndentWidth", Style.IndentWidth);
- IO.mapOptional("IndentWrappedFunctionNames",
- Style.IndentWrappedFunctionNames);
- IO.mapOptional("InsertTrailingCommas", Style.InsertTrailingCommas);
- IO.mapOptional("JavaImportGroups", Style.JavaImportGroups);
- IO.mapOptional("JavaScriptQuotes", Style.JavaScriptQuotes);
- IO.mapOptional("JavaScriptWrapImports", Style.JavaScriptWrapImports);
- IO.mapOptional("KeepEmptyLinesAtTheStartOfBlocks",
- Style.KeepEmptyLinesAtTheStartOfBlocks);
- IO.mapOptional("LambdaBodyIndentation", Style.LambdaBodyIndentation);
- IO.mapOptional("MacroBlockBegin", Style.MacroBlockBegin);
- IO.mapOptional("MacroBlockEnd", Style.MacroBlockEnd);
- IO.mapOptional("MaxEmptyLinesToKeep", Style.MaxEmptyLinesToKeep);
- IO.mapOptional("NamespaceIndentation", Style.NamespaceIndentation);
- IO.mapOptional("NamespaceMacros", Style.NamespaceMacros);
- IO.mapOptional("ObjCBinPackProtocolList", Style.ObjCBinPackProtocolList);
- IO.mapOptional("ObjCBlockIndentWidth", Style.ObjCBlockIndentWidth);
- IO.mapOptional("ObjCBreakBeforeNestedBlockParam",
- Style.ObjCBreakBeforeNestedBlockParam);
- IO.mapOptional("ObjCSpaceAfterProperty", Style.ObjCSpaceAfterProperty);
- IO.mapOptional("ObjCSpaceBeforeProtocolList",
- Style.ObjCSpaceBeforeProtocolList);
- IO.mapOptional("PenaltyBreakAssignment", Style.PenaltyBreakAssignment);
- IO.mapOptional("PenaltyBreakBeforeFirstCallParameter",
- Style.PenaltyBreakBeforeFirstCallParameter);
- IO.mapOptional("PenaltyBreakComment", Style.PenaltyBreakComment);
- IO.mapOptional("PenaltyBreakFirstLessLess",
- Style.PenaltyBreakFirstLessLess);
- IO.mapOptional("PenaltyBreakOpenParenthesis",
- Style.PenaltyBreakOpenParenthesis);
- IO.mapOptional("PenaltyBreakString", Style.PenaltyBreakString);
- IO.mapOptional("PenaltyBreakTemplateDeclaration",
- Style.PenaltyBreakTemplateDeclaration);
- IO.mapOptional("PenaltyExcessCharacter", Style.PenaltyExcessCharacter);
- IO.mapOptional("PenaltyReturnTypeOnItsOwnLine",
- Style.PenaltyReturnTypeOnItsOwnLine);
- IO.mapOptional("PenaltyIndentedWhitespace",
- Style.PenaltyIndentedWhitespace);
- IO.mapOptional("PointerAlignment", Style.PointerAlignment);
- IO.mapOptional("PPIndentWidth", Style.PPIndentWidth);
- IO.mapOptional("RawStringFormats", Style.RawStringFormats);
- IO.mapOptional("ReferenceAlignment", Style.ReferenceAlignment);
- IO.mapOptional("ReflowComments", Style.ReflowComments);
- IO.mapOptional("RemoveBracesLLVM", Style.RemoveBracesLLVM);
- IO.mapOptional("SeparateDefinitionBlocks", Style.SeparateDefinitionBlocks);
- IO.mapOptional("ShortNamespaceLines", Style.ShortNamespaceLines);
- IO.mapOptional("SortIncludes", Style.SortIncludes);
- IO.mapOptional("SortJavaStaticImport", Style.SortJavaStaticImport);
- IO.mapOptional("SortUsingDeclarations", Style.SortUsingDeclarations);
- IO.mapOptional("SpaceAfterCStyleCast", Style.SpaceAfterCStyleCast);
- IO.mapOptional("SpaceAfterLogicalNot", Style.SpaceAfterLogicalNot);
- IO.mapOptional("SpaceAfterTemplateKeyword",
- Style.SpaceAfterTemplateKeyword);
- IO.mapOptional("SpaceBeforeAssignmentOperators",
- Style.SpaceBeforeAssignmentOperators);
- IO.mapOptional("SpaceBeforeCaseColon", Style.SpaceBeforeCaseColon);
- IO.mapOptional("SpaceBeforeCpp11BracedList",
- Style.SpaceBeforeCpp11BracedList);
- IO.mapOptional("SpaceBeforeCtorInitializerColon",
- Style.SpaceBeforeCtorInitializerColon);
- IO.mapOptional("SpaceBeforeInheritanceColon",
- Style.SpaceBeforeInheritanceColon);
- IO.mapOptional("SpaceBeforeParens", Style.SpaceBeforeParens);
- IO.mapOptional("SpaceBeforeParensOptions", Style.SpaceBeforeParensOptions);
- IO.mapOptional("SpaceAroundPointerQualifiers",
- Style.SpaceAroundPointerQualifiers);
- IO.mapOptional("SpaceBeforeRangeBasedForLoopColon",
- Style.SpaceBeforeRangeBasedForLoopColon);
- IO.mapOptional("SpaceInEmptyBlock", Style.SpaceInEmptyBlock);
- IO.mapOptional("SpaceInEmptyParentheses", Style.SpaceInEmptyParentheses);
- IO.mapOptional("SpacesBeforeTrailingComments",
- Style.SpacesBeforeTrailingComments);
- IO.mapOptional("SpacesInAngles", Style.SpacesInAngles);
- IO.mapOptional("SpacesInConditionalStatement",
- Style.SpacesInConditionalStatement);
- IO.mapOptional("SpacesInContainerLiterals",
- Style.SpacesInContainerLiterals);
- IO.mapOptional("SpacesInCStyleCastParentheses",
- Style.SpacesInCStyleCastParentheses);
- IO.mapOptional("SpacesInLineCommentPrefix",
- Style.SpacesInLineCommentPrefix);
- IO.mapOptional("SpacesInParentheses", Style.SpacesInParentheses);
- IO.mapOptional("SpacesInSquareBrackets", Style.SpacesInSquareBrackets);
- IO.mapOptional("SpaceBeforeSquareBrackets",
- Style.SpaceBeforeSquareBrackets);
- IO.mapOptional("BitFieldColonSpacing", Style.BitFieldColonSpacing);
- IO.mapOptional("Standard", Style.Standard);
- IO.mapOptional("StatementAttributeLikeMacros",
- Style.StatementAttributeLikeMacros);
- IO.mapOptional("StatementMacros", Style.StatementMacros);
- IO.mapOptional("TabWidth", Style.TabWidth);
- IO.mapOptional("TypenameMacros", Style.TypenameMacros);
- IO.mapOptional("UseCRLF", Style.UseCRLF);
- IO.mapOptional("UseTab", Style.UseTab);
- IO.mapOptional("WhitespaceSensitiveMacros",
- Style.WhitespaceSensitiveMacros);
- }
- };
- template <> struct MappingTraits<FormatStyle::BraceWrappingFlags> {
- static void mapping(IO &IO, FormatStyle::BraceWrappingFlags &Wrapping) {
- IO.mapOptional("AfterCaseLabel", Wrapping.AfterCaseLabel);
- IO.mapOptional("AfterClass", Wrapping.AfterClass);
- IO.mapOptional("AfterControlStatement", Wrapping.AfterControlStatement);
- IO.mapOptional("AfterEnum", Wrapping.AfterEnum);
- IO.mapOptional("AfterFunction", Wrapping.AfterFunction);
- IO.mapOptional("AfterNamespace", Wrapping.AfterNamespace);
- IO.mapOptional("AfterObjCDeclaration", Wrapping.AfterObjCDeclaration);
- IO.mapOptional("AfterStruct", Wrapping.AfterStruct);
- IO.mapOptional("AfterUnion", Wrapping.AfterUnion);
- IO.mapOptional("AfterExternBlock", Wrapping.AfterExternBlock);
- IO.mapOptional("BeforeCatch", Wrapping.BeforeCatch);
- IO.mapOptional("BeforeElse", Wrapping.BeforeElse);
- IO.mapOptional("BeforeLambdaBody", Wrapping.BeforeLambdaBody);
- IO.mapOptional("BeforeWhile", Wrapping.BeforeWhile);
- IO.mapOptional("IndentBraces", Wrapping.IndentBraces);
- IO.mapOptional("SplitEmptyFunction", Wrapping.SplitEmptyFunction);
- IO.mapOptional("SplitEmptyRecord", Wrapping.SplitEmptyRecord);
- IO.mapOptional("SplitEmptyNamespace", Wrapping.SplitEmptyNamespace);
- }
- };
- template <> struct MappingTraits<FormatStyle::SpaceBeforeParensCustom> {
- static void mapping(IO &IO, FormatStyle::SpaceBeforeParensCustom &Spacing) {
- IO.mapOptional("AfterControlStatements", Spacing.AfterControlStatements);
- IO.mapOptional("AfterForeachMacros", Spacing.AfterForeachMacros);
- IO.mapOptional("AfterFunctionDefinitionName",
- Spacing.AfterFunctionDefinitionName);
- IO.mapOptional("AfterFunctionDeclarationName",
- Spacing.AfterFunctionDeclarationName);
- IO.mapOptional("AfterIfMacros", Spacing.AfterIfMacros);
- IO.mapOptional("AfterOverloadedOperator", Spacing.AfterOverloadedOperator);
- IO.mapOptional("BeforeNonEmptyParentheses",
- Spacing.BeforeNonEmptyParentheses);
- }
- };
- template <> struct MappingTraits<FormatStyle::RawStringFormat> {
- static void mapping(IO &IO, FormatStyle::RawStringFormat &Format) {
- IO.mapOptional("Language", Format.Language);
- IO.mapOptional("Delimiters", Format.Delimiters);
- IO.mapOptional("EnclosingFunctions", Format.EnclosingFunctions);
- IO.mapOptional("CanonicalDelimiter", Format.CanonicalDelimiter);
- IO.mapOptional("BasedOnStyle", Format.BasedOnStyle);
- }
- };
- template <> struct MappingTraits<FormatStyle::SpacesInLineComment> {
- static void mapping(IO &IO, FormatStyle::SpacesInLineComment &Space) {
- // Transform the maximum to signed, to parse "-1" correctly
- int signedMaximum = static_cast<int>(Space.Maximum);
- IO.mapOptional("Minimum", Space.Minimum);
- IO.mapOptional("Maximum", signedMaximum);
- Space.Maximum = static_cast<unsigned>(signedMaximum);
- if (Space.Maximum != -1u) {
- Space.Minimum = std::min(Space.Minimum, Space.Maximum);
- }
- }
- };
- // Allows to read vector<FormatStyle> while keeping default values.
- // IO.getContext() should contain a pointer to the FormatStyle structure, that
- // will be used to get default values for missing keys.
- // If the first element has no Language specified, it will be treated as the
- // default one for the following elements.
- template <> struct DocumentListTraits<std::vector<FormatStyle>> {
- static size_t size(IO &IO, std::vector<FormatStyle> &Seq) {
- return Seq.size();
- }
- static FormatStyle &element(IO &IO, std::vector<FormatStyle> &Seq,
- size_t Index) {
- if (Index >= Seq.size()) {
- assert(Index == Seq.size());
- FormatStyle Template;
- if (!Seq.empty() && Seq[0].Language == FormatStyle::LK_None) {
- Template = Seq[0];
- } else {
- Template = *((const FormatStyle *)IO.getContext());
- Template.Language = FormatStyle::LK_None;
- }
- Seq.resize(Index + 1, Template);
- }
- return Seq[Index];
- }
- };
- } // namespace yaml
- } // namespace llvm
- namespace clang {
- namespace format {
- const std::error_category &getParseCategory() {
- static const ParseErrorCategory C{};
- return C;
- }
- std::error_code make_error_code(ParseError e) {
- return std::error_code(static_cast<int>(e), getParseCategory());
- }
- inline llvm::Error make_string_error(const llvm::Twine &Message) {
- return llvm::make_error<llvm::StringError>(Message,
- llvm::inconvertibleErrorCode());
- }
- const char *ParseErrorCategory::name() const noexcept {
- return "clang-format.parse_error";
- }
- std::string ParseErrorCategory::message(int EV) const {
- switch (static_cast<ParseError>(EV)) {
- case ParseError::Success:
- return "Success";
- case ParseError::Error:
- return "Invalid argument";
- case ParseError::Unsuitable:
- return "Unsuitable";
- case ParseError::BinPackTrailingCommaConflict:
- return "trailing comma insertion cannot be used with bin packing";
- case ParseError::InvalidQualifierSpecified:
- return "Invalid qualifier specified in QualifierOrder";
- case ParseError::DuplicateQualifierSpecified:
- return "Duplicate qualifier specified in QualfierOrder";
- case ParseError::MissingQualifierType:
- return "Missing type in QualfierOrder";
- case ParseError::MissingQualifierOrder:
- return "Missing QualfierOrder";
- }
- llvm_unreachable("unexpected parse error");
- }
- static void expandPresetsBraceWrapping(FormatStyle &Expanded) {
- if (Expanded.BreakBeforeBraces == FormatStyle::BS_Custom)
- return;
- Expanded.BraceWrapping = {/*AfterCaseLabel=*/false,
- /*AfterClass=*/false,
- /*AfterControlStatement=*/FormatStyle::BWACS_Never,
- /*AfterEnum=*/false,
- /*AfterFunction=*/false,
- /*AfterNamespace=*/false,
- /*AfterObjCDeclaration=*/false,
- /*AfterStruct=*/false,
- /*AfterUnion=*/false,
- /*AfterExternBlock=*/false,
- /*BeforeCatch=*/false,
- /*BeforeElse=*/false,
- /*BeforeLambdaBody=*/false,
- /*BeforeWhile=*/false,
- /*IndentBraces=*/false,
- /*SplitEmptyFunction=*/true,
- /*SplitEmptyRecord=*/true,
- /*SplitEmptyNamespace=*/true};
- switch (Expanded.BreakBeforeBraces) {
- case FormatStyle::BS_Linux:
- Expanded.BraceWrapping.AfterClass = true;
- Expanded.BraceWrapping.AfterFunction = true;
- Expanded.BraceWrapping.AfterNamespace = true;
- break;
- case FormatStyle::BS_Mozilla:
- Expanded.BraceWrapping.AfterClass = true;
- Expanded.BraceWrapping.AfterEnum = true;
- Expanded.BraceWrapping.AfterFunction = true;
- Expanded.BraceWrapping.AfterStruct = true;
- Expanded.BraceWrapping.AfterUnion = true;
- Expanded.BraceWrapping.AfterExternBlock = true;
- Expanded.IndentExternBlock = FormatStyle::IEBS_AfterExternBlock;
- Expanded.BraceWrapping.SplitEmptyFunction = true;
- Expanded.BraceWrapping.SplitEmptyRecord = false;
- break;
- case FormatStyle::BS_Stroustrup:
- Expanded.BraceWrapping.AfterFunction = true;
- Expanded.BraceWrapping.BeforeCatch = true;
- Expanded.BraceWrapping.BeforeElse = true;
- break;
- case FormatStyle::BS_Allman:
- Expanded.BraceWrapping.AfterCaseLabel = true;
- Expanded.BraceWrapping.AfterClass = true;
- Expanded.BraceWrapping.AfterControlStatement = FormatStyle::BWACS_Always;
- Expanded.BraceWrapping.AfterEnum = true;
- Expanded.BraceWrapping.AfterFunction = true;
- Expanded.BraceWrapping.AfterNamespace = true;
- Expanded.BraceWrapping.AfterObjCDeclaration = true;
- Expanded.BraceWrapping.AfterStruct = true;
- Expanded.BraceWrapping.AfterUnion = true;
- Expanded.BraceWrapping.AfterExternBlock = true;
- Expanded.IndentExternBlock = FormatStyle::IEBS_AfterExternBlock;
- Expanded.BraceWrapping.BeforeCatch = true;
- Expanded.BraceWrapping.BeforeElse = true;
- Expanded.BraceWrapping.BeforeLambdaBody = true;
- break;
- case FormatStyle::BS_Whitesmiths:
- Expanded.BraceWrapping.AfterCaseLabel = true;
- Expanded.BraceWrapping.AfterClass = true;
- Expanded.BraceWrapping.AfterControlStatement = FormatStyle::BWACS_Always;
- Expanded.BraceWrapping.AfterEnum = true;
- Expanded.BraceWrapping.AfterFunction = true;
- Expanded.BraceWrapping.AfterNamespace = true;
- Expanded.BraceWrapping.AfterObjCDeclaration = true;
- Expanded.BraceWrapping.AfterStruct = true;
- Expanded.BraceWrapping.AfterExternBlock = true;
- Expanded.IndentExternBlock = FormatStyle::IEBS_AfterExternBlock;
- Expanded.BraceWrapping.BeforeCatch = true;
- Expanded.BraceWrapping.BeforeElse = true;
- Expanded.BraceWrapping.BeforeLambdaBody = true;
- break;
- case FormatStyle::BS_GNU:
- Expanded.BraceWrapping = {
- /*AfterCaseLabel=*/true,
- /*AfterClass=*/true,
- /*AfterControlStatement=*/FormatStyle::BWACS_Always,
- /*AfterEnum=*/true,
- /*AfterFunction=*/true,
- /*AfterNamespace=*/true,
- /*AfterObjCDeclaration=*/true,
- /*AfterStruct=*/true,
- /*AfterUnion=*/true,
- /*AfterExternBlock=*/true,
- /*BeforeCatch=*/true,
- /*BeforeElse=*/true,
- /*BeforeLambdaBody=*/false,
- /*BeforeWhile=*/true,
- /*IndentBraces=*/true,
- /*SplitEmptyFunction=*/true,
- /*SplitEmptyRecord=*/true,
- /*SplitEmptyNamespace=*/true};
- Expanded.IndentExternBlock = FormatStyle::IEBS_AfterExternBlock;
- break;
- case FormatStyle::BS_WebKit:
- Expanded.BraceWrapping.AfterFunction = true;
- break;
- default:
- break;
- }
- }
- static void expandPresetsSpaceBeforeParens(FormatStyle &Expanded) {
- if (Expanded.SpaceBeforeParens == FormatStyle::SBPO_Custom)
- return;
- // Reset all flags
- Expanded.SpaceBeforeParensOptions = {};
- switch (Expanded.SpaceBeforeParens) {
- case FormatStyle::SBPO_Never:
- break;
- case FormatStyle::SBPO_ControlStatements:
- Expanded.SpaceBeforeParensOptions.AfterControlStatements = true;
- Expanded.SpaceBeforeParensOptions.AfterForeachMacros = true;
- Expanded.SpaceBeforeParensOptions.AfterIfMacros = true;
- break;
- case FormatStyle::SBPO_ControlStatementsExceptControlMacros:
- Expanded.SpaceBeforeParensOptions.AfterControlStatements = true;
- break;
- case FormatStyle::SBPO_NonEmptyParentheses:
- Expanded.SpaceBeforeParensOptions.BeforeNonEmptyParentheses = true;
- break;
- case FormatStyle::SBPO_Always:
- break;
- default:
- break;
- }
- }
- FormatStyle getLLVMStyle(FormatStyle::LanguageKind Language) {
- FormatStyle LLVMStyle;
- LLVMStyle.InheritsParentConfig = false;
- LLVMStyle.Language = Language;
- LLVMStyle.AccessModifierOffset = -2;
- LLVMStyle.AlignEscapedNewlines = FormatStyle::ENAS_Right;
- LLVMStyle.AlignAfterOpenBracket = FormatStyle::BAS_Align;
- LLVMStyle.AlignArrayOfStructures = FormatStyle::AIAS_None;
- LLVMStyle.AlignOperands = FormatStyle::OAS_Align;
- LLVMStyle.AlignTrailingComments = true;
- LLVMStyle.AlignConsecutiveAssignments = FormatStyle::ACS_None;
- LLVMStyle.AlignConsecutiveBitFields = FormatStyle::ACS_None;
- LLVMStyle.AlignConsecutiveDeclarations = FormatStyle::ACS_None;
- LLVMStyle.AlignConsecutiveMacros = FormatStyle::ACS_None;
- LLVMStyle.AllowAllArgumentsOnNextLine = true;
- LLVMStyle.AllowAllParametersOfDeclarationOnNextLine = true;
- LLVMStyle.AllowShortEnumsOnASingleLine = true;
- LLVMStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_All;
- LLVMStyle.AllowShortBlocksOnASingleLine = FormatStyle::SBS_Never;
- LLVMStyle.AllowShortCaseLabelsOnASingleLine = false;
- LLVMStyle.AllowShortIfStatementsOnASingleLine = FormatStyle::SIS_Never;
- LLVMStyle.AllowShortLambdasOnASingleLine = FormatStyle::SLS_All;
- LLVMStyle.AllowShortLoopsOnASingleLine = false;
- LLVMStyle.AlwaysBreakAfterReturnType = FormatStyle::RTBS_None;
- LLVMStyle.AlwaysBreakAfterDefinitionReturnType = FormatStyle::DRTBS_None;
- LLVMStyle.AlwaysBreakBeforeMultilineStrings = false;
- LLVMStyle.AlwaysBreakTemplateDeclarations = FormatStyle::BTDS_MultiLine;
- LLVMStyle.AttributeMacros.push_back("__capability");
- LLVMStyle.BinPackArguments = true;
- LLVMStyle.BinPackParameters = true;
- LLVMStyle.BreakBeforeBinaryOperators = FormatStyle::BOS_None;
- LLVMStyle.BreakBeforeConceptDeclarations = true;
- LLVMStyle.BreakBeforeTernaryOperators = true;
- LLVMStyle.BreakBeforeBraces = FormatStyle::BS_Attach;
- LLVMStyle.BraceWrapping = {/*AfterCaseLabel=*/false,
- /*AfterClass=*/false,
- /*AfterControlStatement=*/FormatStyle::BWACS_Never,
- /*AfterEnum=*/false,
- /*AfterFunction=*/false,
- /*AfterNamespace=*/false,
- /*AfterObjCDeclaration=*/false,
- /*AfterStruct=*/false,
- /*AfterUnion=*/false,
- /*AfterExternBlock=*/false,
- /*BeforeCatch=*/false,
- /*BeforeElse=*/false,
- /*BeforeLambdaBody=*/false,
- /*BeforeWhile=*/false,
- /*IndentBraces=*/false,
- /*SplitEmptyFunction=*/true,
- /*SplitEmptyRecord=*/true,
- /*SplitEmptyNamespace=*/true};
- LLVMStyle.IndentExternBlock = FormatStyle::IEBS_AfterExternBlock;
- LLVMStyle.BreakAfterJavaFieldAnnotations = false;
- LLVMStyle.BreakConstructorInitializers = FormatStyle::BCIS_BeforeColon;
- LLVMStyle.BreakInheritanceList = FormatStyle::BILS_BeforeColon;
- LLVMStyle.BreakStringLiterals = true;
- LLVMStyle.ColumnLimit = 80;
- LLVMStyle.CommentPragmas = "^ IWYU pragma:";
- LLVMStyle.CompactNamespaces = false;
- LLVMStyle.ConstructorInitializerIndentWidth = 4;
- LLVMStyle.ContinuationIndentWidth = 4;
- LLVMStyle.Cpp11BracedListStyle = true;
- // Off by default Qualifier ordering
- LLVMStyle.QualifierAlignment = FormatStyle::QAS_Leave;
- LLVMStyle.DeriveLineEnding = true;
- LLVMStyle.DerivePointerAlignment = false;
- LLVMStyle.EmptyLineAfterAccessModifier = FormatStyle::ELAAMS_Never;
- LLVMStyle.EmptyLineBeforeAccessModifier = FormatStyle::ELBAMS_LogicalBlock;
- LLVMStyle.ExperimentalAutoDetectBinPacking = false;
- LLVMStyle.PackConstructorInitializers = FormatStyle::PCIS_BinPack;
- LLVMStyle.FixNamespaceComments = true;
- LLVMStyle.ForEachMacros.push_back("foreach");
- LLVMStyle.ForEachMacros.push_back("Q_FOREACH");
- LLVMStyle.ForEachMacros.push_back("BOOST_FOREACH");
- LLVMStyle.IfMacros.push_back("KJ_IF_MAYBE");
- LLVMStyle.IncludeStyle.IncludeCategories = {
- {"^\"(llvm|llvm-c|clang|clang-c)/", 2, 0, false},
- {"^(<|\"(gtest|gmock|isl|json)/)", 3, 0, false},
- {".*", 1, 0, false}};
- LLVMStyle.IncludeStyle.IncludeIsMainRegex = "(Test)?$";
- LLVMStyle.IncludeStyle.IncludeBlocks = tooling::IncludeStyle::IBS_Preserve;
- LLVMStyle.IndentAccessModifiers = false;
- LLVMStyle.IndentCaseLabels = false;
- LLVMStyle.IndentCaseBlocks = false;
- LLVMStyle.IndentGotoLabels = true;
- LLVMStyle.IndentPPDirectives = FormatStyle::PPDIS_None;
- LLVMStyle.IndentRequires = false;
- LLVMStyle.IndentWrappedFunctionNames = false;
- LLVMStyle.IndentWidth = 2;
- LLVMStyle.PPIndentWidth = -1;
- LLVMStyle.InsertTrailingCommas = FormatStyle::TCS_None;
- LLVMStyle.JavaScriptQuotes = FormatStyle::JSQS_Leave;
- LLVMStyle.JavaScriptWrapImports = true;
- LLVMStyle.TabWidth = 8;
- LLVMStyle.LambdaBodyIndentation = FormatStyle::LBI_Signature;
- LLVMStyle.MaxEmptyLinesToKeep = 1;
- LLVMStyle.KeepEmptyLinesAtTheStartOfBlocks = true;
- LLVMStyle.NamespaceIndentation = FormatStyle::NI_None;
- LLVMStyle.ObjCBinPackProtocolList = FormatStyle::BPS_Auto;
- LLVMStyle.ObjCBlockIndentWidth = 2;
- LLVMStyle.ObjCBreakBeforeNestedBlockParam = true;
- LLVMStyle.ObjCSpaceAfterProperty = false;
- LLVMStyle.ObjCSpaceBeforeProtocolList = true;
- LLVMStyle.PointerAlignment = FormatStyle::PAS_Right;
- LLVMStyle.ReferenceAlignment = FormatStyle::RAS_Pointer;
- LLVMStyle.SeparateDefinitionBlocks = FormatStyle::SDS_Leave;
- LLVMStyle.ShortNamespaceLines = 1;
- LLVMStyle.SpacesBeforeTrailingComments = 1;
- LLVMStyle.Standard = FormatStyle::LS_Latest;
- LLVMStyle.UseCRLF = false;
- LLVMStyle.UseTab = FormatStyle::UT_Never;
- LLVMStyle.ReflowComments = true;
- LLVMStyle.RemoveBracesLLVM = false;
- LLVMStyle.SpacesInParentheses = false;
- LLVMStyle.SpacesInSquareBrackets = false;
- LLVMStyle.SpaceInEmptyBlock = false;
- LLVMStyle.SpaceInEmptyParentheses = false;
- LLVMStyle.SpacesInContainerLiterals = true;
- LLVMStyle.SpacesInCStyleCastParentheses = false;
- LLVMStyle.SpacesInLineCommentPrefix = {/*Minimum=*/1, /*Maximum=*/-1u};
- LLVMStyle.SpaceAfterCStyleCast = false;
- LLVMStyle.SpaceAfterLogicalNot = false;
- LLVMStyle.SpaceAfterTemplateKeyword = true;
- LLVMStyle.SpaceAroundPointerQualifiers = FormatStyle::SAPQ_Default;
- LLVMStyle.SpaceBeforeCaseColon = false;
- LLVMStyle.SpaceBeforeCtorInitializerColon = true;
- LLVMStyle.SpaceBeforeInheritanceColon = true;
- LLVMStyle.SpaceBeforeParens = FormatStyle::SBPO_ControlStatements;
- LLVMStyle.SpaceBeforeParensOptions.AfterControlStatements = true;
- LLVMStyle.SpaceBeforeParensOptions.AfterForeachMacros = true;
- LLVMStyle.SpaceBeforeParensOptions.AfterIfMacros = true;
- LLVMStyle.SpaceBeforeRangeBasedForLoopColon = true;
- LLVMStyle.SpaceBeforeAssignmentOperators = true;
- LLVMStyle.SpaceBeforeCpp11BracedList = false;
- LLVMStyle.SpaceBeforeSquareBrackets = false;
- LLVMStyle.BitFieldColonSpacing = FormatStyle::BFCS_Both;
- LLVMStyle.SpacesInAngles = FormatStyle::SIAS_Never;
- LLVMStyle.SpacesInConditionalStatement = false;
- LLVMStyle.PenaltyBreakAssignment = prec::Assignment;
- LLVMStyle.PenaltyBreakComment = 300;
- LLVMStyle.PenaltyBreakFirstLessLess = 120;
- LLVMStyle.PenaltyBreakString = 1000;
- LLVMStyle.PenaltyExcessCharacter = 1000000;
- LLVMStyle.PenaltyReturnTypeOnItsOwnLine = 60;
- LLVMStyle.PenaltyBreakBeforeFirstCallParameter = 19;
- LLVMStyle.PenaltyBreakOpenParenthesis = 0;
- LLVMStyle.PenaltyBreakTemplateDeclaration = prec::Relational;
- LLVMStyle.PenaltyIndentedWhitespace = 0;
- LLVMStyle.DisableFormat = false;
- LLVMStyle.SortIncludes = FormatStyle::SI_CaseSensitive;
- LLVMStyle.SortJavaStaticImport = FormatStyle::SJSIO_Before;
- LLVMStyle.SortUsingDeclarations = true;
- LLVMStyle.StatementAttributeLikeMacros.push_back("Q_EMIT");
- LLVMStyle.StatementMacros.push_back("Q_UNUSED");
- LLVMStyle.StatementMacros.push_back("QT_REQUIRE_VERSION");
- LLVMStyle.WhitespaceSensitiveMacros.push_back("STRINGIZE");
- LLVMStyle.WhitespaceSensitiveMacros.push_back("PP_STRINGIZE");
- LLVMStyle.WhitespaceSensitiveMacros.push_back("BOOST_PP_STRINGIZE");
- LLVMStyle.WhitespaceSensitiveMacros.push_back("NS_SWIFT_NAME");
- LLVMStyle.WhitespaceSensitiveMacros.push_back("CF_SWIFT_NAME");
- // Defaults that differ when not C++.
- if (Language == FormatStyle::LK_TableGen) {
- LLVMStyle.SpacesInContainerLiterals = false;
- }
- if (LLVMStyle.isJson()) {
- LLVMStyle.ColumnLimit = 0;
- }
- return LLVMStyle;
- }
- FormatStyle getGoogleStyle(FormatStyle::LanguageKind Language) {
- if (Language == FormatStyle::LK_TextProto) {
- FormatStyle GoogleStyle = getGoogleStyle(FormatStyle::LK_Proto);
- GoogleStyle.Language = FormatStyle::LK_TextProto;
- return GoogleStyle;
- }
- FormatStyle GoogleStyle = getLLVMStyle(Language);
- GoogleStyle.AccessModifierOffset = -1;
- GoogleStyle.AlignEscapedNewlines = FormatStyle::ENAS_Left;
- GoogleStyle.AllowShortIfStatementsOnASingleLine =
- FormatStyle::SIS_WithoutElse;
- GoogleStyle.AllowShortLoopsOnASingleLine = true;
- GoogleStyle.AlwaysBreakBeforeMultilineStrings = true;
- GoogleStyle.AlwaysBreakTemplateDeclarations = FormatStyle::BTDS_Yes;
- GoogleStyle.DerivePointerAlignment = true;
- GoogleStyle.IncludeStyle.IncludeCategories = {{"^<ext/.*\\.h>", 2, 0, false},
- {"^<.*\\.h>", 1, 0, false},
- {"^<.*", 2, 0, false},
- {".*", 3, 0, false}};
- GoogleStyle.IncludeStyle.IncludeIsMainRegex = "([-_](test|unittest))?$";
- GoogleStyle.IncludeStyle.IncludeBlocks = tooling::IncludeStyle::IBS_Regroup;
- GoogleStyle.IndentCaseLabels = true;
- GoogleStyle.KeepEmptyLinesAtTheStartOfBlocks = false;
- GoogleStyle.ObjCBinPackProtocolList = FormatStyle::BPS_Never;
- GoogleStyle.ObjCSpaceAfterProperty = false;
- GoogleStyle.ObjCSpaceBeforeProtocolList = true;
- GoogleStyle.PackConstructorInitializers = FormatStyle::PCIS_NextLine;
- GoogleStyle.PointerAlignment = FormatStyle::PAS_Left;
- GoogleStyle.RawStringFormats = {
- {
- FormatStyle::LK_Cpp,
- /*Delimiters=*/
- {
- "cc",
- "CC",
- "cpp",
- "Cpp",
- "CPP",
- "c++",
- "C++",
- },
- /*EnclosingFunctionNames=*/
- {},
- /*CanonicalDelimiter=*/"",
- /*BasedOnStyle=*/"google",
- },
- {
- FormatStyle::LK_TextProto,
- /*Delimiters=*/
- {
- "pb",
- "PB",
- "proto",
- "PROTO",
- },
- /*EnclosingFunctionNames=*/
- {
- "EqualsProto",
- "EquivToProto",
- "PARSE_PARTIAL_TEXT_PROTO",
- "PARSE_TEST_PROTO",
- "PARSE_TEXT_PROTO",
- "ParseTextOrDie",
- "ParseTextProtoOrDie",
- "ParseTestProto",
- "ParsePartialTestProto",
- },
- /*CanonicalDelimiter=*/"pb",
- /*BasedOnStyle=*/"google",
- },
- };
- GoogleStyle.SpacesBeforeTrailingComments = 2;
- GoogleStyle.Standard = FormatStyle::LS_Auto;
- GoogleStyle.PenaltyReturnTypeOnItsOwnLine = 200;
- GoogleStyle.PenaltyBreakBeforeFirstCallParameter = 1;
- if (Language == FormatStyle::LK_Java) {
- GoogleStyle.AlignAfterOpenBracket = FormatStyle::BAS_DontAlign;
- GoogleStyle.AlignOperands = FormatStyle::OAS_DontAlign;
- GoogleStyle.AlignTrailingComments = false;
- GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
- GoogleStyle.AllowShortIfStatementsOnASingleLine = FormatStyle::SIS_Never;
- GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
- GoogleStyle.BreakBeforeBinaryOperators = FormatStyle::BOS_NonAssignment;
- GoogleStyle.ColumnLimit = 100;
- GoogleStyle.SpaceAfterCStyleCast = true;
- GoogleStyle.SpacesBeforeTrailingComments = 1;
- } else if (Language == FormatStyle::LK_JavaScript) {
- GoogleStyle.AlignAfterOpenBracket = FormatStyle::BAS_AlwaysBreak;
- GoogleStyle.AlignOperands = FormatStyle::OAS_DontAlign;
- GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
- // TODO: still under discussion whether to switch to SLS_All.
- GoogleStyle.AllowShortLambdasOnASingleLine = FormatStyle::SLS_Empty;
- GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
- GoogleStyle.BreakBeforeTernaryOperators = false;
- // taze:, triple slash directives (`/// <...`), tslint:, and @see, which is
- // commonly followed by overlong URLs.
- GoogleStyle.CommentPragmas = "(taze:|^/[ \t]*<|tslint:|@see)";
- // TODO: enable once decided, in particular re disabling bin packing.
- // https://google.github.io/styleguide/jsguide.html#features-arrays-trailing-comma
- // GoogleStyle.InsertTrailingCommas = FormatStyle::TCS_Wrapped;
- GoogleStyle.MaxEmptyLinesToKeep = 3;
- GoogleStyle.NamespaceIndentation = FormatStyle::NI_All;
- GoogleStyle.SpacesInContainerLiterals = false;
- GoogleStyle.JavaScriptQuotes = FormatStyle::JSQS_Single;
- GoogleStyle.JavaScriptWrapImports = false;
- } else if (Language == FormatStyle::LK_Proto) {
- GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
- GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
- GoogleStyle.SpacesInContainerLiterals = false;
- GoogleStyle.Cpp11BracedListStyle = false;
- // This affects protocol buffer options specifications and text protos.
- // Text protos are currently mostly formatted inside C++ raw string literals
- // and often the current breaking behavior of string literals is not
- // beneficial there. Investigate turning this on once proper string reflow
- // has been implemented.
- GoogleStyle.BreakStringLiterals = false;
- } else if (Language == FormatStyle::LK_ObjC) {
- GoogleStyle.AlwaysBreakBeforeMultilineStrings = false;
- GoogleStyle.ColumnLimit = 100;
- // "Regroup" doesn't work well for ObjC yet (main header heuristic,
- // relationship between ObjC standard library headers and other heades,
- // #imports, etc.)
- GoogleStyle.IncludeStyle.IncludeBlocks =
- tooling::IncludeStyle::IBS_Preserve;
- } else if (Language == FormatStyle::LK_CSharp) {
- GoogleStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Empty;
- GoogleStyle.AllowShortIfStatementsOnASingleLine = FormatStyle::SIS_Never;
- GoogleStyle.BreakStringLiterals = false;
- GoogleStyle.ColumnLimit = 100;
- GoogleStyle.NamespaceIndentation = FormatStyle::NI_All;
- }
- return GoogleStyle;
- }
- FormatStyle getChromiumStyle(FormatStyle::LanguageKind Language) {
- FormatStyle ChromiumStyle = getGoogleStyle(Language);
- // Disable include reordering across blocks in Chromium code.
- // - clang-format tries to detect that foo.h is the "main" header for
- // foo.cc and foo_unittest.cc via IncludeIsMainRegex. However, Chromium
- // uses many other suffices (_win.cc, _mac.mm, _posix.cc, _browsertest.cc,
- // _private.cc, _impl.cc etc) in different permutations
- // (_win_browsertest.cc) so disable this until IncludeIsMainRegex has a
- // better default for Chromium code.
- // - The default for .cc and .mm files is different (r357695) for Google style
- // for the same reason. The plan is to unify this again once the main
- // header detection works for Google's ObjC code, but this hasn't happened
- // yet. Since Chromium has some ObjC code, switching Chromium is blocked
- // on that.
- // - Finally, "If include reordering is harmful, put things in different
- // blocks to prevent it" has been a recommendation for a long time that
- // people are used to. We'll need a dev education push to change this to
- // "If include reordering is harmful, put things in a different block and
- // _prepend that with a comment_ to prevent it" before changing behavior.
- ChromiumStyle.IncludeStyle.IncludeBlocks =
- tooling::IncludeStyle::IBS_Preserve;
- if (Language == FormatStyle::LK_Java) {
- ChromiumStyle.AllowShortIfStatementsOnASingleLine =
- FormatStyle::SIS_WithoutElse;
- ChromiumStyle.BreakAfterJavaFieldAnnotations = true;
- ChromiumStyle.ContinuationIndentWidth = 8;
- ChromiumStyle.IndentWidth = 4;
- // See styleguide for import groups:
- // https://chromium.googlesource.com/chromium/src/+/refs/heads/main/styleguide/java/java.md#Import-Order
- ChromiumStyle.JavaImportGroups = {
- "android",
- "androidx",
- "com",
- "dalvik",
- "junit",
- "org",
- "com.google.android.apps.chrome",
- "org.chromium",
- "java",
- "javax",
- };
- ChromiumStyle.SortIncludes = FormatStyle::SI_CaseSensitive;
- } else if (Language == FormatStyle::LK_JavaScript) {
- ChromiumStyle.AllowShortIfStatementsOnASingleLine = FormatStyle::SIS_Never;
- ChromiumStyle.AllowShortLoopsOnASingleLine = false;
- } else {
- ChromiumStyle.AllowAllParametersOfDeclarationOnNextLine = false;
- ChromiumStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
- ChromiumStyle.AllowShortIfStatementsOnASingleLine = FormatStyle::SIS_Never;
- ChromiumStyle.AllowShortLoopsOnASingleLine = false;
- ChromiumStyle.BinPackParameters = false;
- ChromiumStyle.DerivePointerAlignment = false;
- if (Language == FormatStyle::LK_ObjC)
- ChromiumStyle.ColumnLimit = 80;
- }
- return ChromiumStyle;
- }
- FormatStyle getMozillaStyle() {
- FormatStyle MozillaStyle = getLLVMStyle();
- MozillaStyle.AllowAllParametersOfDeclarationOnNextLine = false;
- MozillaStyle.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_Inline;
- MozillaStyle.AlwaysBreakAfterReturnType = FormatStyle::RTBS_TopLevel;
- MozillaStyle.AlwaysBreakAfterDefinitionReturnType =
- FormatStyle::DRTBS_TopLevel;
- MozillaStyle.AlwaysBreakTemplateDeclarations = FormatStyle::BTDS_Yes;
- MozillaStyle.BinPackParameters = false;
- MozillaStyle.BinPackArguments = false;
- MozillaStyle.BreakBeforeBraces = FormatStyle::BS_Mozilla;
- MozillaStyle.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
- MozillaStyle.BreakInheritanceList = FormatStyle::BILS_BeforeComma;
- MozillaStyle.ConstructorInitializerIndentWidth = 2;
- MozillaStyle.ContinuationIndentWidth = 2;
- MozillaStyle.Cpp11BracedListStyle = false;
- MozillaStyle.FixNamespaceComments = false;
- MozillaStyle.IndentCaseLabels = true;
- MozillaStyle.ObjCSpaceAfterProperty = true;
- MozillaStyle.ObjCSpaceBeforeProtocolList = false;
- MozillaStyle.PenaltyReturnTypeOnItsOwnLine = 200;
- MozillaStyle.PointerAlignment = FormatStyle::PAS_Left;
- MozillaStyle.SpaceAfterTemplateKeyword = false;
- return MozillaStyle;
- }
- FormatStyle getWebKitStyle() {
- FormatStyle Style = getLLVMStyle();
- Style.AccessModifierOffset = -4;
- Style.AlignAfterOpenBracket = FormatStyle::BAS_DontAlign;
- Style.AlignOperands = FormatStyle::OAS_DontAlign;
- Style.AlignTrailingComments = false;
- Style.AllowShortBlocksOnASingleLine = FormatStyle::SBS_Empty;
- Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All;
- Style.BreakBeforeBraces = FormatStyle::BS_WebKit;
- Style.BreakConstructorInitializers = FormatStyle::BCIS_BeforeComma;
- Style.Cpp11BracedListStyle = false;
- Style.ColumnLimit = 0;
- Style.FixNamespaceComments = false;
- Style.IndentWidth = 4;
- Style.NamespaceIndentation = FormatStyle::NI_Inner;
- Style.ObjCBlockIndentWidth = 4;
- Style.ObjCSpaceAfterProperty = true;
- Style.PointerAlignment = FormatStyle::PAS_Left;
- Style.SpaceBeforeCpp11BracedList = true;
- Style.SpaceInEmptyBlock = true;
- return Style;
- }
- FormatStyle getGNUStyle() {
- FormatStyle Style = getLLVMStyle();
- Style.AlwaysBreakAfterDefinitionReturnType = FormatStyle::DRTBS_All;
- Style.AlwaysBreakAfterReturnType = FormatStyle::RTBS_AllDefinitions;
- Style.BreakBeforeBinaryOperators = FormatStyle::BOS_All;
- Style.BreakBeforeBraces = FormatStyle::BS_GNU;
- Style.BreakBeforeTernaryOperators = true;
- Style.Cpp11BracedListStyle = false;
- Style.ColumnLimit = 79;
- Style.FixNamespaceComments = false;
- Style.SpaceBeforeParens = FormatStyle::SBPO_Always;
- Style.Standard = FormatStyle::LS_Cpp03;
- return Style;
- }
- FormatStyle getMicrosoftStyle(FormatStyle::LanguageKind Language) {
- FormatStyle Style = getLLVMStyle(Language);
- Style.ColumnLimit = 120;
- Style.TabWidth = 4;
- Style.IndentWidth = 4;
- Style.UseTab = FormatStyle::UT_Never;
- Style.BreakBeforeBraces = FormatStyle::BS_Custom;
- Style.BraceWrapping.AfterClass = true;
- Style.BraceWrapping.AfterControlStatement = FormatStyle::BWACS_Always;
- Style.BraceWrapping.AfterEnum = true;
- Style.BraceWrapping.AfterFunction = true;
- Style.BraceWrapping.AfterNamespace = true;
- Style.BraceWrapping.AfterObjCDeclaration = true;
- Style.BraceWrapping.AfterStruct = true;
- Style.BraceWrapping.AfterExternBlock = true;
- Style.IndentExternBlock = FormatStyle::IEBS_AfterExternBlock;
- Style.BraceWrapping.BeforeCatch = true;
- Style.BraceWrapping.BeforeElse = true;
- Style.BraceWrapping.BeforeWhile = false;
- Style.PenaltyReturnTypeOnItsOwnLine = 1000;
- Style.AllowShortEnumsOnASingleLine = false;
- Style.AllowShortFunctionsOnASingleLine = FormatStyle::SFS_None;
- Style.AllowShortCaseLabelsOnASingleLine = false;
- Style.AllowShortIfStatementsOnASingleLine = FormatStyle::SIS_Never;
- Style.AllowShortLoopsOnASingleLine = false;
- Style.AlwaysBreakAfterDefinitionReturnType = FormatStyle::DRTBS_None;
- Style.AlwaysBreakAfterReturnType = FormatStyle::RTBS_None;
- return Style;
- }
- FormatStyle getNoStyle() {
- FormatStyle NoStyle = getLLVMStyle();
- NoStyle.DisableFormat = true;
- NoStyle.SortIncludes = FormatStyle::SI_Never;
- NoStyle.SortUsingDeclarations = false;
- return NoStyle;
- }
- bool getPredefinedStyle(StringRef Name, FormatStyle::LanguageKind Language,
- FormatStyle *Style) {
- if (Name.equals_insensitive("llvm")) {
- *Style = getLLVMStyle(Language);
- } else if (Name.equals_insensitive("chromium")) {
- *Style = getChromiumStyle(Language);
- } else if (Name.equals_insensitive("mozilla")) {
- *Style = getMozillaStyle();
- } else if (Name.equals_insensitive("google")) {
- *Style = getGoogleStyle(Language);
- } else if (Name.equals_insensitive("webkit")) {
- *Style = getWebKitStyle();
- } else if (Name.equals_insensitive("gnu")) {
- *Style = getGNUStyle();
- } else if (Name.equals_insensitive("microsoft")) {
- *Style = getMicrosoftStyle(Language);
- } else if (Name.equals_insensitive("none")) {
- *Style = getNoStyle();
- } else if (Name.equals_insensitive("inheritparentconfig")) {
- Style->InheritsParentConfig = true;
- } else {
- return false;
- }
- Style->Language = Language;
- return true;
- }
- ParseError validateQualifierOrder(FormatStyle *Style) {
- // If its empty then it means don't do anything.
- if (Style->QualifierOrder.empty())
- return ParseError::MissingQualifierOrder;
- // Ensure the list contains only currently valid qualifiers.
- for (const auto &Qualifier : Style->QualifierOrder) {
- if (Qualifier == "type")
- continue;
- auto token =
- LeftRightQualifierAlignmentFixer::getTokenFromQualifier(Qualifier);
- if (token == tok::identifier)
- return ParseError::InvalidQualifierSpecified;
- }
- // Ensure the list is unqiue (no duplicates).
- std::set<std::string> UniqueQualifiers(Style->QualifierOrder.begin(),
- Style->QualifierOrder.end());
- if (Style->QualifierOrder.size() != UniqueQualifiers.size()) {
- LLVM_DEBUG(llvm::dbgs()
- << "Duplicate Qualifiers " << Style->QualifierOrder.size()
- << " vs " << UniqueQualifiers.size() << "\n");
- return ParseError::DuplicateQualifierSpecified;
- }
- auto type = std::find(Style->QualifierOrder.begin(),
- Style->QualifierOrder.end(), "type");
- if (type == Style->QualifierOrder.end())
- return ParseError::MissingQualifierType;
- return ParseError::Success;
- }
- std::error_code parseConfiguration(llvm::MemoryBufferRef Config,
- FormatStyle *Style, bool AllowUnknownOptions,
- llvm::SourceMgr::DiagHandlerTy DiagHandler,
- void *DiagHandlerCtxt) {
- assert(Style);
- FormatStyle::LanguageKind Language = Style->Language;
- assert(Language != FormatStyle::LK_None);
- if (Config.getBuffer().trim().empty())
- return make_error_code(ParseError::Error);
- Style->StyleSet.Clear();
- std::vector<FormatStyle> Styles;
- llvm::yaml::Input Input(Config, /*Ctxt=*/nullptr, DiagHandler,
- DiagHandlerCtxt);
- // DocumentListTraits<vector<FormatStyle>> uses the context to get default
- // values for the fields, keys for which are missing from the configuration.
- // Mapping also uses the context to get the language to find the correct
- // base style.
- Input.setContext(Style);
- Input.setAllowUnknownKeys(AllowUnknownOptions);
- Input >> Styles;
- if (Input.error())
- return Input.error();
- for (unsigned i = 0; i < Styles.size(); ++i) {
- // Ensures that only the first configuration can skip the Language option.
- if (Styles[i].Language == FormatStyle::LK_None && i != 0)
- return make_error_code(ParseError::Error);
- // Ensure that each language is configured at most once.
- for (unsigned j = 0; j < i; ++j) {
- if (Styles[i].Language == Styles[j].Language) {
- LLVM_DEBUG(llvm::dbgs()
- << "Duplicate languages in the config file on positions "
- << j << " and " << i << "\n");
- return make_error_code(ParseError::Error);
- }
- }
- }
- // Look for a suitable configuration starting from the end, so we can
- // find the configuration for the specific language first, and the default
- // configuration (which can only be at slot 0) after it.
- FormatStyle::FormatStyleSet StyleSet;
- bool LanguageFound = false;
- for (const FormatStyle &Style : llvm::reverse(Styles)) {
- if (Style.Language != FormatStyle::LK_None)
- StyleSet.Add(Style);
- if (Style.Language == Language)
- LanguageFound = true;
- }
- if (!LanguageFound) {
- if (Styles.empty() || Styles[0].Language != FormatStyle::LK_None)
- return make_error_code(ParseError::Unsuitable);
- FormatStyle DefaultStyle = Styles[0];
- DefaultStyle.Language = Language;
- StyleSet.Add(std::move(DefaultStyle));
- }
- *Style = *StyleSet.Get(Language);
- if (Style->InsertTrailingCommas != FormatStyle::TCS_None &&
- Style->BinPackArguments) {
- // See comment on FormatStyle::TSC_Wrapped.
- return make_error_code(ParseError::BinPackTrailingCommaConflict);
- }
- if (Style->QualifierAlignment != FormatStyle::QAS_Leave)
- return make_error_code(validateQualifierOrder(Style));
- return make_error_code(ParseError::Success);
- }
- std::string configurationAsText(const FormatStyle &Style) {
- std::string Text;
- llvm::raw_string_ostream Stream(Text);
- llvm::yaml::Output Output(Stream);
- // We use the same mapping method for input and output, so we need a non-const
- // reference here.
- FormatStyle NonConstStyle = Style;
- expandPresetsBraceWrapping(NonConstStyle);
- expandPresetsSpaceBeforeParens(NonConstStyle);
- Output << NonConstStyle;
- return Stream.str();
- }
- llvm::Optional<FormatStyle>
- FormatStyle::FormatStyleSet::Get(FormatStyle::LanguageKind Language) const {
- if (!Styles)
- return None;
- auto It = Styles->find(Language);
- if (It == Styles->end())
- return None;
- FormatStyle Style = It->second;
- Style.StyleSet = *this;
- return Style;
- }
- void FormatStyle::FormatStyleSet::Add(FormatStyle Style) {
- assert(Style.Language != LK_None &&
- "Cannot add a style for LK_None to a StyleSet");
- assert(
- !Style.StyleSet.Styles &&
- "Cannot add a style associated with an existing StyleSet to a StyleSet");
- if (!Styles)
- Styles = std::make_shared<MapType>();
- (*Styles)[Style.Language] = std::move(Style);
- }
- void FormatStyle::FormatStyleSet::Clear() { Styles.reset(); }
- llvm::Optional<FormatStyle>
- FormatStyle::GetLanguageStyle(FormatStyle::LanguageKind Language) const {
- return StyleSet.Get(Language);
- }
- namespace {
- class BracesRemover : public TokenAnalyzer {
- public:
- BracesRemover(const Environment &Env, const FormatStyle &Style)
- : TokenAnalyzer(Env, Style) {}
- std::pair<tooling::Replacements, unsigned>
- analyze(TokenAnnotator &Annotator,
- SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
- FormatTokenLexer &Tokens) override {
- AffectedRangeMgr.computeAffectedLines(AnnotatedLines);
- tooling::Replacements Result;
- removeBraces(AnnotatedLines, Result);
- return {Result, 0};
- }
- private:
- // Remove optional braces.
- void removeBraces(SmallVectorImpl<AnnotatedLine *> &Lines,
- tooling::Replacements &Result) {
- const auto &SourceMgr = Env.getSourceManager();
- for (AnnotatedLine *Line : Lines) {
- removeBraces(Line->Children, Result);
- if (!Line->Affected)
- continue;
- for (FormatToken *Token = Line->First; Token; Token = Token->Next) {
- if (!Token->Optional)
- continue;
- assert(Token->isOneOf(tok::l_brace, tok::r_brace));
- const auto Start = Token == Line->Last
- ? Token->WhitespaceRange.getBegin()
- : Token->Tok.getLocation();
- const auto Range =
- CharSourceRange::getCharRange(Start, Token->Tok.getEndLoc());
- cantFail(Result.add(tooling::Replacement(SourceMgr, Range, "")));
- }
- }
- }
- };
- class JavaScriptRequoter : public TokenAnalyzer {
- public:
- JavaScriptRequoter(const Environment &Env, const FormatStyle &Style)
- : TokenAnalyzer(Env, Style) {}
- std::pair<tooling::Replacements, unsigned>
- analyze(TokenAnnotator &Annotator,
- SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
- FormatTokenLexer &Tokens) override {
- AffectedRangeMgr.computeAffectedLines(AnnotatedLines);
- tooling::Replacements Result;
- requoteJSStringLiteral(AnnotatedLines, Result);
- return {Result, 0};
- }
- private:
- // Replaces double/single-quoted string literal as appropriate, re-escaping
- // the contents in the process.
- void requoteJSStringLiteral(SmallVectorImpl<AnnotatedLine *> &Lines,
- tooling::Replacements &Result) {
- for (AnnotatedLine *Line : Lines) {
- requoteJSStringLiteral(Line->Children, Result);
- if (!Line->Affected)
- continue;
- for (FormatToken *FormatTok = Line->First; FormatTok;
- FormatTok = FormatTok->Next) {
- StringRef Input = FormatTok->TokenText;
- if (FormatTok->Finalized || !FormatTok->isStringLiteral() ||
- // NB: testing for not starting with a double quote to avoid
- // breaking `template strings`.
- (Style.JavaScriptQuotes == FormatStyle::JSQS_Single &&
- !Input.startswith("\"")) ||
- (Style.JavaScriptQuotes == FormatStyle::JSQS_Double &&
- !Input.startswith("\'")))
- continue;
- // Change start and end quote.
- bool IsSingle = Style.JavaScriptQuotes == FormatStyle::JSQS_Single;
- SourceLocation Start = FormatTok->Tok.getLocation();
- auto Replace = [&](SourceLocation Start, unsigned Length,
- StringRef ReplacementText) {
- auto Err = Result.add(tooling::Replacement(
- Env.getSourceManager(), Start, Length, ReplacementText));
- // FIXME: handle error. For now, print error message and skip the
- // replacement for release version.
- if (Err) {
- llvm::errs() << llvm::toString(std::move(Err)) << "\n";
- assert(false);
- }
- };
- Replace(Start, 1, IsSingle ? "'" : "\"");
- Replace(FormatTok->Tok.getEndLoc().getLocWithOffset(-1), 1,
- IsSingle ? "'" : "\"");
- // Escape internal quotes.
- bool Escaped = false;
- for (size_t i = 1; i < Input.size() - 1; i++) {
- switch (Input[i]) {
- case '\\':
- if (!Escaped && i + 1 < Input.size() &&
- ((IsSingle && Input[i + 1] == '"') ||
- (!IsSingle && Input[i + 1] == '\''))) {
- // Remove this \, it's escaping a " or ' that no longer needs
- // escaping
- Replace(Start.getLocWithOffset(i), 1, "");
- continue;
- }
- Escaped = !Escaped;
- break;
- case '\"':
- case '\'':
- if (!Escaped && IsSingle == (Input[i] == '\'')) {
- // Escape the quote.
- Replace(Start.getLocWithOffset(i), 0, "\\");
- }
- Escaped = false;
- break;
- default:
- Escaped = false;
- break;
- }
- }
- }
- }
- }
- };
- class Formatter : public TokenAnalyzer {
- public:
- Formatter(const Environment &Env, const FormatStyle &Style,
- FormattingAttemptStatus *Status)
- : TokenAnalyzer(Env, Style), Status(Status) {}
- std::pair<tooling::Replacements, unsigned>
- analyze(TokenAnnotator &Annotator,
- SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
- FormatTokenLexer &Tokens) override {
- tooling::Replacements Result;
- deriveLocalStyle(AnnotatedLines);
- AffectedRangeMgr.computeAffectedLines(AnnotatedLines);
- for (AnnotatedLine *Line : AnnotatedLines)
- Annotator.calculateFormattingInformation(*Line);
- Annotator.setCommentLineLevels(AnnotatedLines);
- WhitespaceManager Whitespaces(
- Env.getSourceManager(), Style,
- Style.DeriveLineEnding
- ? WhitespaceManager::inputUsesCRLF(
- Env.getSourceManager().getBufferData(Env.getFileID()),
- Style.UseCRLF)
- : Style.UseCRLF);
- ContinuationIndenter Indenter(Style, Tokens.getKeywords(),
- Env.getSourceManager(), Whitespaces, Encoding,
- BinPackInconclusiveFunctions);
- unsigned Penalty =
- UnwrappedLineFormatter(&Indenter, &Whitespaces, Style,
- Tokens.getKeywords(), Env.getSourceManager(),
- Status)
- .format(AnnotatedLines, /*DryRun=*/false,
- /*AdditionalIndent=*/0,
- /*FixBadIndentation=*/false,
- /*FirstStartColumn=*/Env.getFirstStartColumn(),
- /*NextStartColumn=*/Env.getNextStartColumn(),
- /*LastStartColumn=*/Env.getLastStartColumn());
- for (const auto &R : Whitespaces.generateReplacements())
- if (Result.add(R))
- return std::make_pair(Result, 0);
- return std::make_pair(Result, Penalty);
- }
- private:
- bool
- hasCpp03IncompatibleFormat(const SmallVectorImpl<AnnotatedLine *> &Lines) {
- for (const AnnotatedLine *Line : Lines) {
- if (hasCpp03IncompatibleFormat(Line->Children))
- return true;
- for (FormatToken *Tok = Line->First->Next; Tok; Tok = Tok->Next) {
- if (!Tok->hasWhitespaceBefore()) {
- if (Tok->is(tok::coloncolon) && Tok->Previous->is(TT_TemplateOpener))
- return true;
- if (Tok->is(TT_TemplateCloser) &&
- Tok->Previous->is(TT_TemplateCloser))
- return true;
- }
- }
- }
- return false;
- }
- int countVariableAlignments(const SmallVectorImpl<AnnotatedLine *> &Lines) {
- int AlignmentDiff = 0;
- for (const AnnotatedLine *Line : Lines) {
- AlignmentDiff += countVariableAlignments(Line->Children);
- for (FormatToken *Tok = Line->First; Tok && Tok->Next; Tok = Tok->Next) {
- if (!Tok->is(TT_PointerOrReference))
- continue;
- bool SpaceBefore = Tok->hasWhitespaceBefore();
- bool SpaceAfter = Tok->Next->hasWhitespaceBefore();
- if (SpaceBefore && !SpaceAfter)
- ++AlignmentDiff;
- if (!SpaceBefore && SpaceAfter)
- --AlignmentDiff;
- }
- }
- return AlignmentDiff;
- }
- void
- deriveLocalStyle(const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
- bool HasBinPackedFunction = false;
- bool HasOnePerLineFunction = false;
- for (AnnotatedLine *Line : AnnotatedLines) {
- if (!Line->First->Next)
- continue;
- FormatToken *Tok = Line->First->Next;
- while (Tok->Next) {
- if (Tok->is(PPK_BinPacked))
- HasBinPackedFunction = true;
- if (Tok->is(PPK_OnePerLine))
- HasOnePerLineFunction = true;
- Tok = Tok->Next;
- }
- }
- if (Style.DerivePointerAlignment) {
- Style.PointerAlignment = countVariableAlignments(AnnotatedLines) <= 0
- ? FormatStyle::PAS_Left
- : FormatStyle::PAS_Right;
- Style.ReferenceAlignment = FormatStyle::RAS_Pointer;
- }
- if (Style.Standard == FormatStyle::LS_Auto)
- Style.Standard = hasCpp03IncompatibleFormat(AnnotatedLines)
- ? FormatStyle::LS_Latest
- : FormatStyle::LS_Cpp03;
- BinPackInconclusiveFunctions =
- HasBinPackedFunction || !HasOnePerLineFunction;
- }
- bool BinPackInconclusiveFunctions;
- FormattingAttemptStatus *Status;
- };
- /// TrailingCommaInserter inserts trailing commas into container literals.
- /// E.g.:
- /// const x = [
- /// 1,
- /// ];
- /// TrailingCommaInserter runs after formatting. To avoid causing a required
- /// reformatting (and thus reflow), it never inserts a comma that'd exceed the
- /// ColumnLimit.
- ///
- /// Because trailing commas disable binpacking of arrays, TrailingCommaInserter
- /// is conceptually incompatible with bin packing.
- class TrailingCommaInserter : public TokenAnalyzer {
- public:
- TrailingCommaInserter(const Environment &Env, const FormatStyle &Style)
- : TokenAnalyzer(Env, Style) {}
- std::pair<tooling::Replacements, unsigned>
- analyze(TokenAnnotator &Annotator,
- SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
- FormatTokenLexer &Tokens) override {
- AffectedRangeMgr.computeAffectedLines(AnnotatedLines);
- tooling::Replacements Result;
- insertTrailingCommas(AnnotatedLines, Result);
- return {Result, 0};
- }
- private:
- /// Inserts trailing commas in [] and {} initializers if they wrap over
- /// multiple lines.
- void insertTrailingCommas(SmallVectorImpl<AnnotatedLine *> &Lines,
- tooling::Replacements &Result) {
- for (AnnotatedLine *Line : Lines) {
- insertTrailingCommas(Line->Children, Result);
- if (!Line->Affected)
- continue;
- for (FormatToken *FormatTok = Line->First; FormatTok;
- FormatTok = FormatTok->Next) {
- if (FormatTok->NewlinesBefore == 0)
- continue;
- FormatToken *Matching = FormatTok->MatchingParen;
- if (!Matching || !FormatTok->getPreviousNonComment())
- continue;
- if (!(FormatTok->is(tok::r_square) &&
- Matching->is(TT_ArrayInitializerLSquare)) &&
- !(FormatTok->is(tok::r_brace) && Matching->is(TT_DictLiteral)))
- continue;
- FormatToken *Prev = FormatTok->getPreviousNonComment();
- if (Prev->is(tok::comma) || Prev->is(tok::semi))
- continue;
- // getEndLoc is not reliably set during re-lexing, use text length
- // instead.
- SourceLocation Start =
- Prev->Tok.getLocation().getLocWithOffset(Prev->TokenText.size());
- // If inserting a comma would push the code over the column limit, skip
- // this location - it'd introduce an unstable formatting due to the
- // required reflow.
- unsigned ColumnNumber =
- Env.getSourceManager().getSpellingColumnNumber(Start);
- if (ColumnNumber > Style.ColumnLimit)
- continue;
- // Comma insertions cannot conflict with each other, and this pass has a
- // clean set of Replacements, so the operation below cannot fail.
- cantFail(Result.add(
- tooling::Replacement(Env.getSourceManager(), Start, 0, ",")));
- }
- }
- }
- };
- // This class clean up the erroneous/redundant code around the given ranges in
- // file.
- class Cleaner : public TokenAnalyzer {
- public:
- Cleaner(const Environment &Env, const FormatStyle &Style)
- : TokenAnalyzer(Env, Style),
- DeletedTokens(FormatTokenLess(Env.getSourceManager())) {}
- // FIXME: eliminate unused parameters.
- std::pair<tooling::Replacements, unsigned>
- analyze(TokenAnnotator &Annotator,
- SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
- FormatTokenLexer &Tokens) override {
- // FIXME: in the current implementation the granularity of affected range
- // is an annotated line. However, this is not sufficient. Furthermore,
- // redundant code introduced by replacements does not necessarily
- // intercept with ranges of replacements that result in the redundancy.
- // To determine if some redundant code is actually introduced by
- // replacements(e.g. deletions), we need to come up with a more
- // sophisticated way of computing affected ranges.
- AffectedRangeMgr.computeAffectedLines(AnnotatedLines);
- checkEmptyNamespace(AnnotatedLines);
- for (auto *Line : AnnotatedLines)
- cleanupLine(Line);
- return {generateFixes(), 0};
- }
- private:
- void cleanupLine(AnnotatedLine *Line) {
- for (auto *Child : Line->Children) {
- cleanupLine(Child);
- }
- if (Line->Affected) {
- cleanupRight(Line->First, tok::comma, tok::comma);
- cleanupRight(Line->First, TT_CtorInitializerColon, tok::comma);
- cleanupRight(Line->First, tok::l_paren, tok::comma);
- cleanupLeft(Line->First, tok::comma, tok::r_paren);
- cleanupLeft(Line->First, TT_CtorInitializerComma, tok::l_brace);
- cleanupLeft(Line->First, TT_CtorInitializerColon, tok::l_brace);
- cleanupLeft(Line->First, TT_CtorInitializerColon, tok::equal);
- }
- }
- bool containsOnlyComments(const AnnotatedLine &Line) {
- for (FormatToken *Tok = Line.First; Tok != nullptr; Tok = Tok->Next) {
- if (Tok->isNot(tok::comment))
- return false;
- }
- return true;
- }
- // Iterate through all lines and remove any empty (nested) namespaces.
- void checkEmptyNamespace(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines) {
- std::set<unsigned> DeletedLines;
- for (unsigned i = 0, e = AnnotatedLines.size(); i != e; ++i) {
- auto &Line = *AnnotatedLines[i];
- if (Line.startsWithNamespace()) {
- checkEmptyNamespace(AnnotatedLines, i, i, DeletedLines);
- }
- }
- for (auto Line : DeletedLines) {
- FormatToken *Tok = AnnotatedLines[Line]->First;
- while (Tok) {
- deleteToken(Tok);
- Tok = Tok->Next;
- }
- }
- }
- // The function checks if the namespace, which starts from \p CurrentLine, and
- // its nested namespaces are empty and delete them if they are empty. It also
- // sets \p NewLine to the last line checked.
- // Returns true if the current namespace is empty.
- bool checkEmptyNamespace(SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
- unsigned CurrentLine, unsigned &NewLine,
- std::set<unsigned> &DeletedLines) {
- unsigned InitLine = CurrentLine, End = AnnotatedLines.size();
- if (Style.BraceWrapping.AfterNamespace) {
- // If the left brace is in a new line, we should consume it first so that
- // it does not make the namespace non-empty.
- // FIXME: error handling if there is no left brace.
- if (!AnnotatedLines[++CurrentLine]->startsWith(tok::l_brace)) {
- NewLine = CurrentLine;
- return false;
- }
- } else if (!AnnotatedLines[CurrentLine]->endsWith(tok::l_brace)) {
- return false;
- }
- while (++CurrentLine < End) {
- if (AnnotatedLines[CurrentLine]->startsWith(tok::r_brace))
- break;
- if (AnnotatedLines[CurrentLine]->startsWithNamespace()) {
- if (!checkEmptyNamespace(AnnotatedLines, CurrentLine, NewLine,
- DeletedLines))
- return false;
- CurrentLine = NewLine;
- continue;
- }
- if (containsOnlyComments(*AnnotatedLines[CurrentLine]))
- continue;
- // If there is anything other than comments or nested namespaces in the
- // current namespace, the namespace cannot be empty.
- NewLine = CurrentLine;
- return false;
- }
- NewLine = CurrentLine;
- if (CurrentLine >= End)
- return false;
- // Check if the empty namespace is actually affected by changed ranges.
- if (!AffectedRangeMgr.affectsCharSourceRange(CharSourceRange::getCharRange(
- AnnotatedLines[InitLine]->First->Tok.getLocation(),
- AnnotatedLines[CurrentLine]->Last->Tok.getEndLoc())))
- return false;
- for (unsigned i = InitLine; i <= CurrentLine; ++i) {
- DeletedLines.insert(i);
- }
- return true;
- }
- // Checks pairs {start, start->next},..., {end->previous, end} and deletes one
- // of the token in the pair if the left token has \p LK token kind and the
- // right token has \p RK token kind. If \p DeleteLeft is true, the left token
- // is deleted on match; otherwise, the right token is deleted.
- template <typename LeftKind, typename RightKind>
- void cleanupPair(FormatToken *Start, LeftKind LK, RightKind RK,
- bool DeleteLeft) {
- auto NextNotDeleted = [this](const FormatToken &Tok) -> FormatToken * {
- for (auto *Res = Tok.Next; Res; Res = Res->Next)
- if (!Res->is(tok::comment) &&
- DeletedTokens.find(Res) == DeletedTokens.end())
- return Res;
- return nullptr;
- };
- for (auto *Left = Start; Left;) {
- auto *Right = NextNotDeleted(*Left);
- if (!Right)
- break;
- if (Left->is(LK) && Right->is(RK)) {
- deleteToken(DeleteLeft ? Left : Right);
- for (auto *Tok = Left->Next; Tok && Tok != Right; Tok = Tok->Next)
- deleteToken(Tok);
- // If the right token is deleted, we should keep the left token
- // unchanged and pair it with the new right token.
- if (!DeleteLeft)
- continue;
- }
- Left = Right;
- }
- }
- template <typename LeftKind, typename RightKind>
- void cleanupLeft(FormatToken *Start, LeftKind LK, RightKind RK) {
- cleanupPair(Start, LK, RK, /*DeleteLeft=*/true);
- }
- template <typename LeftKind, typename RightKind>
- void cleanupRight(FormatToken *Start, LeftKind LK, RightKind RK) {
- cleanupPair(Start, LK, RK, /*DeleteLeft=*/false);
- }
- // Delete the given token.
- inline void deleteToken(FormatToken *Tok) {
- if (Tok)
- DeletedTokens.insert(Tok);
- }
- tooling::Replacements generateFixes() {
- tooling::Replacements Fixes;
- std::vector<FormatToken *> Tokens;
- std::copy(DeletedTokens.begin(), DeletedTokens.end(),
- std::back_inserter(Tokens));
- // Merge multiple continuous token deletions into one big deletion so that
- // the number of replacements can be reduced. This makes computing affected
- // ranges more efficient when we run reformat on the changed code.
- unsigned Idx = 0;
- while (Idx < Tokens.size()) {
- unsigned St = Idx, End = Idx;
- while ((End + 1) < Tokens.size() &&
- Tokens[End]->Next == Tokens[End + 1]) {
- ++End;
- }
- auto SR = CharSourceRange::getCharRange(Tokens[St]->Tok.getLocation(),
- Tokens[End]->Tok.getEndLoc());
- auto Err =
- Fixes.add(tooling::Replacement(Env.getSourceManager(), SR, ""));
- // FIXME: better error handling. for now just print error message and skip
- // for the release version.
- if (Err) {
- llvm::errs() << llvm::toString(std::move(Err)) << "\n";
- assert(false && "Fixes must not conflict!");
- }
- Idx = End + 1;
- }
- return Fixes;
- }
- // Class for less-than inequality comparason for the set `RedundantTokens`.
- // We store tokens in the order they appear in the translation unit so that
- // we do not need to sort them in `generateFixes()`.
- struct FormatTokenLess {
- FormatTokenLess(const SourceManager &SM) : SM(SM) {}
- bool operator()(const FormatToken *LHS, const FormatToken *RHS) const {
- return SM.isBeforeInTranslationUnit(LHS->Tok.getLocation(),
- RHS->Tok.getLocation());
- }
- const SourceManager &SM;
- };
- // Tokens to be deleted.
- std::set<FormatToken *, FormatTokenLess> DeletedTokens;
- };
- class ObjCHeaderStyleGuesser : public TokenAnalyzer {
- public:
- ObjCHeaderStyleGuesser(const Environment &Env, const FormatStyle &Style)
- : TokenAnalyzer(Env, Style), IsObjC(false) {}
- std::pair<tooling::Replacements, unsigned>
- analyze(TokenAnnotator &Annotator,
- SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
- FormatTokenLexer &Tokens) override {
- assert(Style.Language == FormatStyle::LK_Cpp);
- IsObjC = guessIsObjC(Env.getSourceManager(), AnnotatedLines,
- Tokens.getKeywords());
- tooling::Replacements Result;
- return {Result, 0};
- }
- bool isObjC() { return IsObjC; }
- private:
- static bool
- guessIsObjC(const SourceManager &SourceManager,
- const SmallVectorImpl<AnnotatedLine *> &AnnotatedLines,
- const AdditionalKeywords &Keywords) {
- // Keep this array sorted, since we are binary searching over it.
- static constexpr llvm::StringLiteral FoundationIdentifiers[] = {
- "CGFloat",
- "CGPoint",
- "CGPointMake",
- "CGPointZero",
- "CGRect",
- "CGRectEdge",
- "CGRectInfinite",
- "CGRectMake",
- "CGRectNull",
- "CGRectZero",
- "CGSize",
- "CGSizeMake",
- "CGVector",
- "CGVectorMake",
- "NSAffineTransform",
- "NSArray",
- "NSAttributedString",
- "NSBlockOperation",
- "NSBundle",
- "NSCache",
- "NSCalendar",
- "NSCharacterSet",
- "NSCountedSet",
- "NSData",
- "NSDataDetector",
- "NSDecimal",
- "NSDecimalNumber",
- "NSDictionary",
- "NSEdgeInsets",
- "NSHashTable",
- "NSIndexPath",
- "NSIndexSet",
- "NSInteger",
- "NSInvocationOperation",
- "NSLocale",
- "NSMapTable",
- "NSMutableArray",
- "NSMutableAttributedString",
- "NSMutableCharacterSet",
- "NSMutableData",
- "NSMutableDictionary",
- "NSMutableIndexSet",
- "NSMutableOrderedSet",
- "NSMutableSet",
- "NSMutableString",
- "NSNumber",
- "NSNumberFormatter",
- "NSObject",
- "NSOperation",
- "NSOperationQueue",
- "NSOperationQueuePriority",
- "NSOrderedSet",
- "NSPoint",
- "NSPointerArray",
- "NSQualityOfService",
- "NSRange",
- "NSRect",
- "NSRegularExpression",
- "NSSet",
- "NSSize",
- "NSString",
- "NSTimeZone",
- "NSUInteger",
- "NSURL",
- "NSURLComponents",
- "NSURLQueryItem",
- "NSUUID",
- "NSValue",
- "UIImage",
- "UIView",
- };
- for (auto Line : AnnotatedLines) {
- if (Line->First && (Line->First->TokenText.startswith("#") ||
- Line->First->TokenText == "__pragma" ||
- Line->First->TokenText == "_Pragma"))
- continue;
- for (const FormatToken *FormatTok = Line->First; FormatTok;
- FormatTok = FormatTok->Next) {
- if ((FormatTok->Previous && FormatTok->Previous->is(tok::at) &&
- (FormatTok->Tok.getObjCKeywordID() != tok::objc_not_keyword ||
- FormatTok->isOneOf(tok::numeric_constant, tok::l_square,
- tok::l_brace))) ||
- (FormatTok->Tok.isAnyIdentifier() &&
- std::binary_search(std::begin(FoundationIdentifiers),
- std::end(FoundationIdentifiers),
- FormatTok->TokenText)) ||
- FormatTok->is(TT_ObjCStringLiteral) ||
- FormatTok->isOneOf(Keywords.kw_NS_CLOSED_ENUM, Keywords.kw_NS_ENUM,
- Keywords.kw_NS_OPTIONS, TT_ObjCBlockLBrace,
- TT_ObjCBlockLParen, TT_ObjCDecl, TT_ObjCForIn,
- TT_ObjCMethodExpr, TT_ObjCMethodSpecifier,
- TT_ObjCProperty)) {
- LLVM_DEBUG(llvm::dbgs()
- << "Detected ObjC at location "
- << FormatTok->Tok.getLocation().printToString(
- SourceManager)
- << " token: " << FormatTok->TokenText << " token type: "
- << getTokenTypeName(FormatTok->getType()) << "\n");
- return true;
- }
- if (guessIsObjC(SourceManager, Line->Children, Keywords))
- return true;
- }
- }
- return false;
- }
- bool IsObjC;
- };
- struct IncludeDirective {
- StringRef Filename;
- StringRef Text;
- unsigned Offset;
- int Category;
- int Priority;
- };
- struct JavaImportDirective {
- StringRef Identifier;
- StringRef Text;
- unsigned Offset;
- std::vector<StringRef> AssociatedCommentLines;
- bool IsStatic;
- };
- } // end anonymous namespace
- // Determines whether 'Ranges' intersects with ('Start', 'End').
- static bool affectsRange(ArrayRef<tooling::Range> Ranges, unsigned Start,
- unsigned End) {
- for (auto Range : Ranges) {
- if (Range.getOffset() < End &&
- Range.getOffset() + Range.getLength() > Start)
- return true;
- }
- return false;
- }
- // Returns a pair (Index, OffsetToEOL) describing the position of the cursor
- // before sorting/deduplicating. Index is the index of the include under the
- // cursor in the original set of includes. If this include has duplicates, it is
- // the index of the first of the duplicates as the others are going to be
- // removed. OffsetToEOL describes the cursor's position relative to the end of
- // its current line.
- // If `Cursor` is not on any #include, `Index` will be UINT_MAX.
- static std::pair<unsigned, unsigned>
- FindCursorIndex(const SmallVectorImpl<IncludeDirective> &Includes,
- const SmallVectorImpl<unsigned> &Indices, unsigned Cursor) {
- unsigned CursorIndex = UINT_MAX;
- unsigned OffsetToEOL = 0;
- for (int i = 0, e = Includes.size(); i != e; ++i) {
- unsigned Start = Includes[Indices[i]].Offset;
- unsigned End = Start + Includes[Indices[i]].Text.size();
- if (!(Cursor >= Start && Cursor < End))
- continue;
- CursorIndex = Indices[i];
- OffsetToEOL = End - Cursor;
- // Put the cursor on the only remaining #include among the duplicate
- // #includes.
- while (--i >= 0 && Includes[CursorIndex].Text == Includes[Indices[i]].Text)
- CursorIndex = i;
- break;
- }
- return std::make_pair(CursorIndex, OffsetToEOL);
- }
- // Replace all "\r\n" with "\n".
- std::string replaceCRLF(const std::string &Code) {
- std::string NewCode;
- size_t Pos = 0, LastPos = 0;
- do {
- Pos = Code.find("\r\n", LastPos);
- if (Pos == LastPos) {
- ++LastPos;
- continue;
- }
- if (Pos == std::string::npos) {
- NewCode += Code.substr(LastPos);
- break;
- }
- NewCode += Code.substr(LastPos, Pos - LastPos) + "\n";
- LastPos = Pos + 2;
- } while (Pos != std::string::npos);
- return NewCode;
- }
- // Sorts and deduplicate a block of includes given by 'Includes' alphabetically
- // adding the necessary replacement to 'Replaces'. 'Includes' must be in strict
- // source order.
- // #include directives with the same text will be deduplicated, and only the
- // first #include in the duplicate #includes remains. If the `Cursor` is
- // provided and put on a deleted #include, it will be moved to the remaining
- // #include in the duplicate #includes.
- static void sortCppIncludes(const FormatStyle &Style,
- const SmallVectorImpl<IncludeDirective> &Includes,
- ArrayRef<tooling::Range> Ranges, StringRef FileName,
- StringRef Code, tooling::Replacements &Replaces,
- unsigned *Cursor) {
- tooling::IncludeCategoryManager Categories(Style.IncludeStyle, FileName);
- unsigned IncludesBeginOffset = Includes.front().Offset;
- unsigned IncludesEndOffset =
- Includes.back().Offset + Includes.back().Text.size();
- unsigned IncludesBlockSize = IncludesEndOffset - IncludesBeginOffset;
- if (!affectsRange(Ranges, IncludesBeginOffset, IncludesEndOffset))
- return;
- SmallVector<unsigned, 16> Indices;
- Indices.resize(Includes.size());
- std::iota(Indices.begin(), Indices.end(), 0);
- if (Style.SortIncludes == FormatStyle::SI_CaseInsensitive) {
- llvm::stable_sort(Indices, [&](unsigned LHSI, unsigned RHSI) {
- const auto LHSFilenameLower = Includes[LHSI].Filename.lower();
- const auto RHSFilenameLower = Includes[RHSI].Filename.lower();
- return std::tie(Includes[LHSI].Priority, LHSFilenameLower,
- Includes[LHSI].Filename) <
- std::tie(Includes[RHSI].Priority, RHSFilenameLower,
- Includes[RHSI].Filename);
- });
- } else {
- llvm::stable_sort(Indices, [&](unsigned LHSI, unsigned RHSI) {
- return std::tie(Includes[LHSI].Priority, Includes[LHSI].Filename) <
- std::tie(Includes[RHSI].Priority, Includes[RHSI].Filename);
- });
- }
- // The index of the include on which the cursor will be put after
- // sorting/deduplicating.
- unsigned CursorIndex;
- // The offset from cursor to the end of line.
- unsigned CursorToEOLOffset;
- if (Cursor)
- std::tie(CursorIndex, CursorToEOLOffset) =
- FindCursorIndex(Includes, Indices, *Cursor);
- // Deduplicate #includes.
- Indices.erase(std::unique(Indices.begin(), Indices.end(),
- [&](unsigned LHSI, unsigned RHSI) {
- return Includes[LHSI].Text.trim() ==
- Includes[RHSI].Text.trim();
- }),
- Indices.end());
- int CurrentCategory = Includes.front().Category;
- // If the #includes are out of order, we generate a single replacement fixing
- // the entire block. Otherwise, no replacement is generated.
- // In case Style.IncldueStyle.IncludeBlocks != IBS_Preserve, this check is not
- // enough as additional newlines might be added or removed across #include
- // blocks. This we handle below by generating the updated #imclude blocks and
- // comparing it to the original.
- if (Indices.size() == Includes.size() && llvm::is_sorted(Indices) &&
- Style.IncludeStyle.IncludeBlocks == tooling::IncludeStyle::IBS_Preserve)
- return;
- std::string result;
- for (unsigned Index : Indices) {
- if (!result.empty()) {
- result += "\n";
- if (Style.IncludeStyle.IncludeBlocks ==
- tooling::IncludeStyle::IBS_Regroup &&
- CurrentCategory != Includes[Index].Category)
- result += "\n";
- }
- result += Includes[Index].Text;
- if (Cursor && CursorIndex == Index)
- *Cursor = IncludesBeginOffset + result.size() - CursorToEOLOffset;
- CurrentCategory = Includes[Index].Category;
- }
- // If the #includes are out of order, we generate a single replacement fixing
- // the entire range of blocks. Otherwise, no replacement is generated.
- if (replaceCRLF(result) == replaceCRLF(std::string(Code.substr(
- IncludesBeginOffset, IncludesBlockSize))))
- return;
- auto Err = Replaces.add(tooling::Replacement(
- FileName, Includes.front().Offset, IncludesBlockSize, result));
- // FIXME: better error handling. For now, just skip the replacement for the
- // release version.
- if (Err) {
- llvm::errs() << llvm::toString(std::move(Err)) << "\n";
- assert(false);
- }
- }
- namespace {
- const char CppIncludeRegexPattern[] =
- R"(^[\t\ ]*#[\t\ ]*(import|include)[^"<]*(["<][^">]*[">]))";
- } // anonymous namespace
- tooling::Replacements sortCppIncludes(const FormatStyle &Style, StringRef Code,
- ArrayRef<tooling::Range> Ranges,
- StringRef FileName,
- tooling::Replacements &Replaces,
- unsigned *Cursor) {
- unsigned Prev = llvm::StringSwitch<size_t>(Code)
- .StartsWith("\xEF\xBB\xBF", 3) // UTF-8 BOM
- .Default(0);
- unsigned SearchFrom = 0;
- llvm::Regex IncludeRegex(CppIncludeRegexPattern);
- SmallVector<StringRef, 4> Matches;
- SmallVector<IncludeDirective, 16> IncludesInBlock;
- // In compiled files, consider the first #include to be the main #include of
- // the file if it is not a system #include. This ensures that the header
- // doesn't have hidden dependencies
- // (http://llvm.org/docs/CodingStandards.html#include-style).
- //
- // FIXME: Do some validation, e.g. edit distance of the base name, to fix
- // cases where the first #include is unlikely to be the main header.
- tooling::IncludeCategoryManager Categories(Style.IncludeStyle, FileName);
- bool FirstIncludeBlock = true;
- bool MainIncludeFound = false;
- bool FormattingOff = false;
- // '[' must be the first and '-' the last character inside [...].
- llvm::Regex RawStringRegex(
- "R\"([][A-Za-z0-9_{}#<>%:;.?*+/^&\\$|~!=,'-]*)\\(");
- SmallVector<StringRef, 2> RawStringMatches;
- std::string RawStringTermination = ")\"";
- for (;;) {
- auto Pos = Code.find('\n', SearchFrom);
- StringRef Line =
- Code.substr(Prev, (Pos != StringRef::npos ? Pos : Code.size()) - Prev);
- StringRef Trimmed = Line.trim();
- // #includes inside raw string literals need to be ignored.
- // or we will sort the contents of the string.
- // Skip past until we think we are at the rawstring literal close.
- if (RawStringRegex.match(Trimmed, &RawStringMatches)) {
- std::string CharSequence = RawStringMatches[1].str();
- RawStringTermination = ")" + CharSequence + "\"";
- FormattingOff = true;
- }
- if (Trimmed.contains(RawStringTermination)) {
- FormattingOff = false;
- }
- if (Trimmed == "// clang-format off" || Trimmed == "/* clang-format off */")
- FormattingOff = true;
- else if (Trimmed == "// clang-format on" ||
- Trimmed == "/* clang-format on */")
- FormattingOff = false;
- const bool EmptyLineSkipped =
- Trimmed.empty() &&
- (Style.IncludeStyle.IncludeBlocks == tooling::IncludeStyle::IBS_Merge ||
- Style.IncludeStyle.IncludeBlocks ==
- tooling::IncludeStyle::IBS_Regroup);
- bool MergeWithNextLine = Trimmed.endswith("\\");
- if (!FormattingOff && !MergeWithNextLine) {
- if (IncludeRegex.match(Line, &Matches)) {
- StringRef IncludeName = Matches[2];
- if (Line.contains("/*") && !Line.contains("*/")) {
- // #include with a start of a block comment, but without the end.
- // Need to keep all the lines until the end of the comment together.
- // FIXME: This is somehow simplified check that probably does not work
- // correctly if there are multiple comments on a line.
- Pos = Code.find("*/", SearchFrom);
- Line = Code.substr(
- Prev, (Pos != StringRef::npos ? Pos + 2 : Code.size()) - Prev);
- }
- int Category = Categories.getIncludePriority(
- IncludeName,
- /*CheckMainHeader=*/!MainIncludeFound && FirstIncludeBlock);
- int Priority = Categories.getSortIncludePriority(
- IncludeName, !MainIncludeFound && FirstIncludeBlock);
- if (Category == 0)
- MainIncludeFound = true;
- IncludesInBlock.push_back(
- {IncludeName, Line, Prev, Category, Priority});
- } else if (!IncludesInBlock.empty() && !EmptyLineSkipped) {
- sortCppIncludes(Style, IncludesInBlock, Ranges, FileName, Code,
- Replaces, Cursor);
- IncludesInBlock.clear();
- if (Trimmed.startswith("#pragma hdrstop")) // Precompiled headers.
- FirstIncludeBlock = true;
- else
- FirstIncludeBlock = false;
- }
- }
- if (Pos == StringRef::npos || Pos + 1 == Code.size())
- break;
- if (!MergeWithNextLine)
- Prev = Pos + 1;
- SearchFrom = Pos + 1;
- }
- if (!IncludesInBlock.empty()) {
- sortCppIncludes(Style, IncludesInBlock, Ranges, FileName, Code, Replaces,
- Cursor);
- }
- return Replaces;
- }
- // Returns group number to use as a first order sort on imports. Gives UINT_MAX
- // if the import does not match any given groups.
- static unsigned findJavaImportGroup(const FormatStyle &Style,
- StringRef ImportIdentifier) {
- unsigned LongestMatchIndex = UINT_MAX;
- unsigned LongestMatchLength = 0;
- for (unsigned I = 0; I < Style.JavaImportGroups.size(); I++) {
- const std::string &GroupPrefix = Style.JavaImportGroups[I];
- if (ImportIdentifier.startswith(GroupPrefix) &&
- GroupPrefix.length() > LongestMatchLength) {
- LongestMatchIndex = I;
- LongestMatchLength = GroupPrefix.length();
- }
- }
- return LongestMatchIndex;
- }
- // Sorts and deduplicates a block of includes given by 'Imports' based on
- // JavaImportGroups, then adding the necessary replacement to 'Replaces'.
- // Import declarations with the same text will be deduplicated. Between each
- // import group, a newline is inserted, and within each import group, a
- // lexicographic sort based on ASCII value is performed.
- static void sortJavaImports(const FormatStyle &Style,
- const SmallVectorImpl<JavaImportDirective> &Imports,
- ArrayRef<tooling::Range> Ranges, StringRef FileName,
- StringRef Code, tooling::Replacements &Replaces) {
- unsigned ImportsBeginOffset = Imports.front().Offset;
- unsigned ImportsEndOffset =
- Imports.back().Offset + Imports.back().Text.size();
- unsigned ImportsBlockSize = ImportsEndOffset - ImportsBeginOffset;
- if (!affectsRange(Ranges, ImportsBeginOffset, ImportsEndOffset))
- return;
- SmallVector<unsigned, 16> Indices;
- Indices.resize(Imports.size());
- std::iota(Indices.begin(), Indices.end(), 0);
- SmallVector<unsigned, 16> JavaImportGroups;
- JavaImportGroups.reserve(Imports.size());
- for (const JavaImportDirective &Import : Imports)
- JavaImportGroups.push_back(findJavaImportGroup(Style, Import.Identifier));
- bool StaticImportAfterNormalImport =
- Style.SortJavaStaticImport == FormatStyle::SJSIO_After;
- llvm::sort(Indices, [&](unsigned LHSI, unsigned RHSI) {
- // Negating IsStatic to push static imports above non-static imports.
- return std::make_tuple(!Imports[LHSI].IsStatic ^
- StaticImportAfterNormalImport,
- JavaImportGroups[LHSI], Imports[LHSI].Identifier) <
- std::make_tuple(!Imports[RHSI].IsStatic ^
- StaticImportAfterNormalImport,
- JavaImportGroups[RHSI], Imports[RHSI].Identifier);
- });
- // Deduplicate imports.
- Indices.erase(std::unique(Indices.begin(), Indices.end(),
- [&](unsigned LHSI, unsigned RHSI) {
- return Imports[LHSI].Text == Imports[RHSI].Text;
- }),
- Indices.end());
- bool CurrentIsStatic = Imports[Indices.front()].IsStatic;
- unsigned CurrentImportGroup = JavaImportGroups[Indices.front()];
- std::string result;
- for (unsigned Index : Indices) {
- if (!result.empty()) {
- result += "\n";
- if (CurrentIsStatic != Imports[Index].IsStatic ||
- CurrentImportGroup != JavaImportGroups[Index])
- result += "\n";
- }
- for (StringRef CommentLine : Imports[Index].AssociatedCommentLines) {
- result += CommentLine;
- result += "\n";
- }
- result += Imports[Index].Text;
- CurrentIsStatic = Imports[Index].IsStatic;
- CurrentImportGroup = JavaImportGroups[Index];
- }
- // If the imports are out of order, we generate a single replacement fixing
- // the entire block. Otherwise, no replacement is generated.
- if (replaceCRLF(result) == replaceCRLF(std::string(Code.substr(
- Imports.front().Offset, ImportsBlockSize))))
- return;
- auto Err = Replaces.add(tooling::Replacement(FileName, Imports.front().Offset,
- ImportsBlockSize, result));
- // FIXME: better error handling. For now, just skip the replacement for the
- // release version.
- if (Err) {
- llvm::errs() << llvm::toString(std::move(Err)) << "\n";
- assert(false);
- }
- }
- namespace {
- const char JavaImportRegexPattern[] =
- "^[\t ]*import[\t ]+(static[\t ]*)?([^\t ]*)[\t ]*;";
- } // anonymous namespace
- tooling::Replacements sortJavaImports(const FormatStyle &Style, StringRef Code,
- ArrayRef<tooling::Range> Ranges,
- StringRef FileName,
- tooling::Replacements &Replaces) {
- unsigned Prev = 0;
- unsigned SearchFrom = 0;
- llvm::Regex ImportRegex(JavaImportRegexPattern);
- SmallVector<StringRef, 4> Matches;
- SmallVector<JavaImportDirective, 16> ImportsInBlock;
- std::vector<StringRef> AssociatedCommentLines;
- bool FormattingOff = false;
- for (;;) {
- auto Pos = Code.find('\n', SearchFrom);
- StringRef Line =
- Code.substr(Prev, (Pos != StringRef::npos ? Pos : Code.size()) - Prev);
- StringRef Trimmed = Line.trim();
- if (Trimmed == "// clang-format off")
- FormattingOff = true;
- else if (Trimmed == "// clang-format on")
- FormattingOff = false;
- if (ImportRegex.match(Line, &Matches)) {
- if (FormattingOff) {
- // If at least one import line has formatting turned off, turn off
- // formatting entirely.
- return Replaces;
- }
- StringRef Static = Matches[1];
- StringRef Identifier = Matches[2];
- bool IsStatic = false;
- if (Static.contains("static")) {
- IsStatic = true;
- }
- ImportsInBlock.push_back(
- {Identifier, Line, Prev, AssociatedCommentLines, IsStatic});
- AssociatedCommentLines.clear();
- } else if (Trimmed.size() > 0 && !ImportsInBlock.empty()) {
- // Associating comments within the imports with the nearest import below
- AssociatedCommentLines.push_back(Line);
- }
- Prev = Pos + 1;
- if (Pos == StringRef::npos || Pos + 1 == Code.size())
- break;
- SearchFrom = Pos + 1;
- }
- if (!ImportsInBlock.empty())
- sortJavaImports(Style, ImportsInBlock, Ranges, FileName, Code, Replaces);
- return Replaces;
- }
- bool isMpegTS(StringRef Code) {
- // MPEG transport streams use the ".ts" file extension. clang-format should
- // not attempt to format those. MPEG TS' frame format starts with 0x47 every
- // 189 bytes - detect that and return.
- return Code.size() > 188 && Code[0] == 0x47 && Code[188] == 0x47;
- }
- bool isLikelyXml(StringRef Code) { return Code.ltrim().startswith("<"); }
- tooling::Replacements sortIncludes(const FormatStyle &Style, StringRef Code,
- ArrayRef<tooling::Range> Ranges,
- StringRef FileName, unsigned *Cursor) {
- tooling::Replacements Replaces;
- if (!Style.SortIncludes || Style.DisableFormat)
- return Replaces;
- if (isLikelyXml(Code))
- return Replaces;
- if (Style.Language == FormatStyle::LanguageKind::LK_JavaScript &&
- isMpegTS(Code))
- return Replaces;
- if (Style.Language == FormatStyle::LanguageKind::LK_JavaScript)
- return sortJavaScriptImports(Style, Code, Ranges, FileName);
- if (Style.Language == FormatStyle::LanguageKind::LK_Java)
- return sortJavaImports(Style, Code, Ranges, FileName, Replaces);
- sortCppIncludes(Style, Code, Ranges, FileName, Replaces, Cursor);
- return Replaces;
- }
- template <typename T>
- static llvm::Expected<tooling::Replacements>
- processReplacements(T ProcessFunc, StringRef Code,
- const tooling::Replacements &Replaces,
- const FormatStyle &Style) {
- if (Replaces.empty())
- return tooling::Replacements();
- auto NewCode = applyAllReplacements(Code, Replaces);
- if (!NewCode)
- return NewCode.takeError();
- std::vector<tooling::Range> ChangedRanges = Replaces.getAffectedRanges();
- StringRef FileName = Replaces.begin()->getFilePath();
- tooling::Replacements FormatReplaces =
- ProcessFunc(Style, *NewCode, ChangedRanges, FileName);
- return Replaces.merge(FormatReplaces);
- }
- llvm::Expected<tooling::Replacements>
- formatReplacements(StringRef Code, const tooling::Replacements &Replaces,
- const FormatStyle &Style) {
- // We need to use lambda function here since there are two versions of
- // `sortIncludes`.
- auto SortIncludes = [](const FormatStyle &Style, StringRef Code,
- std::vector<tooling::Range> Ranges,
- StringRef FileName) -> tooling::Replacements {
- return sortIncludes(Style, Code, Ranges, FileName);
- };
- auto SortedReplaces =
- processReplacements(SortIncludes, Code, Replaces, Style);
- if (!SortedReplaces)
- return SortedReplaces.takeError();
- // We need to use lambda function here since there are two versions of
- // `reformat`.
- auto Reformat = [](const FormatStyle &Style, StringRef Code,
- std::vector<tooling::Range> Ranges,
- StringRef FileName) -> tooling::Replacements {
- return reformat(Style, Code, Ranges, FileName);
- };
- return processReplacements(Reformat, Code, *SortedReplaces, Style);
- }
- namespace {
- inline bool isHeaderInsertion(const tooling::Replacement &Replace) {
- return Replace.getOffset() == UINT_MAX && Replace.getLength() == 0 &&
- llvm::Regex(CppIncludeRegexPattern)
- .match(Replace.getReplacementText());
- }
- inline bool isHeaderDeletion(const tooling::Replacement &Replace) {
- return Replace.getOffset() == UINT_MAX && Replace.getLength() == 1;
- }
- // FIXME: insert empty lines between newly created blocks.
- tooling::Replacements
- fixCppIncludeInsertions(StringRef Code, const tooling::Replacements &Replaces,
- const FormatStyle &Style) {
- if (!Style.isCpp())
- return Replaces;
- tooling::Replacements HeaderInsertions;
- std::set<llvm::StringRef> HeadersToDelete;
- tooling::Replacements Result;
- for (const auto &R : Replaces) {
- if (isHeaderInsertion(R)) {
- // Replacements from \p Replaces must be conflict-free already, so we can
- // simply consume the error.
- llvm::consumeError(HeaderInsertions.add(R));
- } else if (isHeaderDeletion(R)) {
- HeadersToDelete.insert(R.getReplacementText());
- } else if (R.getOffset() == UINT_MAX) {
- llvm::errs() << "Insertions other than header #include insertion are "
- "not supported! "
- << R.getReplacementText() << "\n";
- } else {
- llvm::consumeError(Result.add(R));
- }
- }
- if (HeaderInsertions.empty() && HeadersToDelete.empty())
- return Replaces;
- StringRef FileName = Replaces.begin()->getFilePath();
- tooling::HeaderIncludes Includes(FileName, Code, Style.IncludeStyle);
- for (const auto &Header : HeadersToDelete) {
- tooling::Replacements Replaces =
- Includes.remove(Header.trim("\"<>"), Header.startswith("<"));
- for (const auto &R : Replaces) {
- auto Err = Result.add(R);
- if (Err) {
- // Ignore the deletion on conflict.
- llvm::errs() << "Failed to add header deletion replacement for "
- << Header << ": " << llvm::toString(std::move(Err))
- << "\n";
- }
- }
- }
- llvm::Regex IncludeRegex = llvm::Regex(CppIncludeRegexPattern);
- llvm::SmallVector<StringRef, 4> Matches;
- for (const auto &R : HeaderInsertions) {
- auto IncludeDirective = R.getReplacementText();
- bool Matched = IncludeRegex.match(IncludeDirective, &Matches);
- assert(Matched && "Header insertion replacement must have replacement text "
- "'#include ...'");
- (void)Matched;
- auto IncludeName = Matches[2];
- auto Replace =
- Includes.insert(IncludeName.trim("\"<>"), IncludeName.startswith("<"));
- if (Replace) {
- auto Err = Result.add(*Replace);
- if (Err) {
- llvm::consumeError(std::move(Err));
- unsigned NewOffset =
- Result.getShiftedCodePosition(Replace->getOffset());
- auto Shifted = tooling::Replacement(FileName, NewOffset, 0,
- Replace->getReplacementText());
- Result = Result.merge(tooling::Replacements(Shifted));
- }
- }
- }
- return Result;
- }
- } // anonymous namespace
- llvm::Expected<tooling::Replacements>
- cleanupAroundReplacements(StringRef Code, const tooling::Replacements &Replaces,
- const FormatStyle &Style) {
- // We need to use lambda function here since there are two versions of
- // `cleanup`.
- auto Cleanup = [](const FormatStyle &Style, StringRef Code,
- std::vector<tooling::Range> Ranges,
- StringRef FileName) -> tooling::Replacements {
- return cleanup(Style, Code, Ranges, FileName);
- };
- // Make header insertion replacements insert new headers into correct blocks.
- tooling::Replacements NewReplaces =
- fixCppIncludeInsertions(Code, Replaces, Style);
- return processReplacements(Cleanup, Code, NewReplaces, Style);
- }
- namespace internal {
- std::pair<tooling::Replacements, unsigned>
- reformat(const FormatStyle &Style, StringRef Code,
- ArrayRef<tooling::Range> Ranges, unsigned FirstStartColumn,
- unsigned NextStartColumn, unsigned LastStartColumn, StringRef FileName,
- FormattingAttemptStatus *Status) {
- FormatStyle Expanded = Style;
- expandPresetsBraceWrapping(Expanded);
- expandPresetsSpaceBeforeParens(Expanded);
- if (Expanded.DisableFormat)
- return {tooling::Replacements(), 0};
- if (isLikelyXml(Code))
- return {tooling::Replacements(), 0};
- if (Expanded.Language == FormatStyle::LK_JavaScript && isMpegTS(Code))
- return {tooling::Replacements(), 0};
- // JSON only needs the formatting passing.
- if (Style.isJson()) {
- std::vector<tooling::Range> Ranges(1, tooling::Range(0, Code.size()));
- auto Env = Environment::make(Code, FileName, Ranges, FirstStartColumn,
- NextStartColumn, LastStartColumn);
- if (!Env)
- return {};
- // Perform the actual formatting pass.
- tooling::Replacements Replaces =
- Formatter(*Env, Style, Status).process().first;
- // add a replacement to remove the "x = " from the result.
- if (!Replaces.add(tooling::Replacement(FileName, 0, 4, ""))) {
- // apply the reformatting changes and the removal of "x = ".
- if (applyAllReplacements(Code, Replaces)) {
- return {Replaces, 0};
- }
- }
- return {tooling::Replacements(), 0};
- }
- typedef std::function<std::pair<tooling::Replacements, unsigned>(
- const Environment &)>
- AnalyzerPass;
- SmallVector<AnalyzerPass, 4> Passes;
- if (Style.isCpp() && Style.QualifierAlignment != FormatStyle::QAS_Leave) {
- Passes.emplace_back([&](const Environment &Env) {
- return QualifierAlignmentFixer(Env, Expanded, Code, Ranges,
- FirstStartColumn, NextStartColumn,
- LastStartColumn, FileName)
- .process();
- });
- }
- if (Style.isCpp() && Style.RemoveBracesLLVM)
- Passes.emplace_back([&](const Environment &Env) {
- return BracesRemover(Env, Expanded).process();
- });
- if (Style.Language == FormatStyle::LK_Cpp) {
- if (Style.FixNamespaceComments)
- Passes.emplace_back([&](const Environment &Env) {
- return NamespaceEndCommentsFixer(Env, Expanded).process();
- });
- if (Style.SortUsingDeclarations)
- Passes.emplace_back([&](const Environment &Env) {
- return UsingDeclarationsSorter(Env, Expanded).process();
- });
- }
- if (Style.SeparateDefinitionBlocks != FormatStyle::SDS_Leave)
- Passes.emplace_back([&](const Environment &Env) {
- return DefinitionBlockSeparator(Env, Expanded).process();
- });
- if (Style.isJavaScript() && Style.JavaScriptQuotes != FormatStyle::JSQS_Leave)
- Passes.emplace_back([&](const Environment &Env) {
- return JavaScriptRequoter(Env, Expanded).process();
- });
- Passes.emplace_back([&](const Environment &Env) {
- return Formatter(Env, Expanded, Status).process();
- });
- if (Style.isJavaScript() &&
- Style.InsertTrailingCommas == FormatStyle::TCS_Wrapped)
- Passes.emplace_back([&](const Environment &Env) {
- return TrailingCommaInserter(Env, Expanded).process();
- });
- auto Env = Environment::make(Code, FileName, Ranges, FirstStartColumn,
- NextStartColumn, LastStartColumn);
- if (!Env)
- return {};
- llvm::Optional<std::string> CurrentCode = None;
- tooling::Replacements Fixes;
- unsigned Penalty = 0;
- for (size_t I = 0, E = Passes.size(); I < E; ++I) {
- std::pair<tooling::Replacements, unsigned> PassFixes = Passes[I](*Env);
- auto NewCode = applyAllReplacements(
- CurrentCode ? StringRef(*CurrentCode) : Code, PassFixes.first);
- if (NewCode) {
- Fixes = Fixes.merge(PassFixes.first);
- Penalty += PassFixes.second;
- if (I + 1 < E) {
- CurrentCode = std::move(*NewCode);
- Env = Environment::make(
- *CurrentCode, FileName,
- tooling::calculateRangesAfterReplacements(Fixes, Ranges),
- FirstStartColumn, NextStartColumn, LastStartColumn);
- if (!Env)
- return {};
- }
- }
- }
- return {Fixes, Penalty};
- }
- } // namespace internal
- tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
- ArrayRef<tooling::Range> Ranges,
- StringRef FileName,
- FormattingAttemptStatus *Status) {
- return internal::reformat(Style, Code, Ranges,
- /*FirstStartColumn=*/0,
- /*NextStartColumn=*/0,
- /*LastStartColumn=*/0, FileName, Status)
- .first;
- }
- tooling::Replacements cleanup(const FormatStyle &Style, StringRef Code,
- ArrayRef<tooling::Range> Ranges,
- StringRef FileName) {
- // cleanups only apply to C++ (they mostly concern ctor commas etc.)
- if (Style.Language != FormatStyle::LK_Cpp)
- return tooling::Replacements();
- auto Env = Environment::make(Code, FileName, Ranges);
- if (!Env)
- return {};
- return Cleaner(*Env, Style).process().first;
- }
- tooling::Replacements reformat(const FormatStyle &Style, StringRef Code,
- ArrayRef<tooling::Range> Ranges,
- StringRef FileName, bool *IncompleteFormat) {
- FormattingAttemptStatus Status;
- auto Result = reformat(Style, Code, Ranges, FileName, &Status);
- if (!Status.FormatComplete)
- *IncompleteFormat = true;
- return Result;
- }
- tooling::Replacements fixNamespaceEndComments(const FormatStyle &Style,
- StringRef Code,
- ArrayRef<tooling::Range> Ranges,
- StringRef FileName) {
- auto Env = Environment::make(Code, FileName, Ranges);
- if (!Env)
- return {};
- return NamespaceEndCommentsFixer(*Env, Style).process().first;
- }
- tooling::Replacements separateDefinitionBlocks(const FormatStyle &Style,
- StringRef Code,
- ArrayRef<tooling::Range> Ranges,
- StringRef FileName) {
- auto Env = Environment::make(Code, FileName, Ranges);
- if (!Env)
- return {};
- return DefinitionBlockSeparator(*Env, Style).process().first;
- }
- tooling::Replacements sortUsingDeclarations(const FormatStyle &Style,
- StringRef Code,
- ArrayRef<tooling::Range> Ranges,
- StringRef FileName) {
- auto Env = Environment::make(Code, FileName, Ranges);
- if (!Env)
- return {};
- return UsingDeclarationsSorter(*Env, Style).process().first;
- }
- LangOptions getFormattingLangOpts(const FormatStyle &Style) {
- LangOptions LangOpts;
- FormatStyle::LanguageStandard LexingStd = Style.Standard;
- if (LexingStd == FormatStyle::LS_Auto)
- LexingStd = FormatStyle::LS_Latest;
- if (LexingStd == FormatStyle::LS_Latest)
- LexingStd = FormatStyle::LS_Cpp20;
- LangOpts.CPlusPlus = 1;
- LangOpts.CPlusPlus11 = LexingStd >= FormatStyle::LS_Cpp11;
- LangOpts.CPlusPlus14 = LexingStd >= FormatStyle::LS_Cpp14;
- LangOpts.CPlusPlus17 = LexingStd >= FormatStyle::LS_Cpp17;
- LangOpts.CPlusPlus20 = LexingStd >= FormatStyle::LS_Cpp20;
- LangOpts.Char8 = LexingStd >= FormatStyle::LS_Cpp20;
- LangOpts.LineComment = 1;
- bool AlternativeOperators = Style.isCpp();
- LangOpts.CXXOperatorNames = AlternativeOperators ? 1 : 0;
- LangOpts.Bool = 1;
- LangOpts.ObjC = 1;
- LangOpts.MicrosoftExt = 1; // To get kw___try, kw___finally.
- LangOpts.DeclSpecKeyword = 1; // To get __declspec.
- LangOpts.C99 = 1; // To get kw_restrict for non-underscore-prefixed restrict.
- return LangOpts;
- }
- const char *StyleOptionHelpDescription =
- "Coding style, currently supports:\n"
- " LLVM, GNU, Google, Chromium, Microsoft, Mozilla, WebKit.\n"
- "Use -style=file to load style configuration from\n"
- ".clang-format file located in one of the parent\n"
- "directories of the source file (or current\n"
- "directory for stdin).\n"
- "Use -style=file:<format_file_path> to explicitly specify"
- "the configuration file.\n"
- "Use -style=\"{key: value, ...}\" to set specific\n"
- "parameters, e.g.:\n"
- " -style=\"{BasedOnStyle: llvm, IndentWidth: 8}\"";
- static FormatStyle::LanguageKind getLanguageByFileName(StringRef FileName) {
- if (FileName.endswith(".java"))
- return FormatStyle::LK_Java;
- if (FileName.endswith_insensitive(".js") ||
- FileName.endswith_insensitive(".mjs") ||
- FileName.endswith_insensitive(".ts"))
- return FormatStyle::LK_JavaScript; // (module) JavaScript or TypeScript.
- if (FileName.endswith(".m") || FileName.endswith(".mm"))
- return FormatStyle::LK_ObjC;
- if (FileName.endswith_insensitive(".proto") ||
- FileName.endswith_insensitive(".protodevel"))
- return FormatStyle::LK_Proto;
- if (FileName.endswith_insensitive(".textpb") ||
- FileName.endswith_insensitive(".pb.txt") ||
- FileName.endswith_insensitive(".textproto") ||
- FileName.endswith_insensitive(".asciipb"))
- return FormatStyle::LK_TextProto;
- if (FileName.endswith_insensitive(".td"))
- return FormatStyle::LK_TableGen;
- if (FileName.endswith_insensitive(".cs"))
- return FormatStyle::LK_CSharp;
- if (FileName.endswith_insensitive(".json"))
- return FormatStyle::LK_Json;
- return FormatStyle::LK_Cpp;
- }
- FormatStyle::LanguageKind guessLanguage(StringRef FileName, StringRef Code) {
- const auto GuessedLanguage = getLanguageByFileName(FileName);
- if (GuessedLanguage == FormatStyle::LK_Cpp) {
- auto Extension = llvm::sys::path::extension(FileName);
- // If there's no file extension (or it's .h), we need to check the contents
- // of the code to see if it contains Objective-C.
- if (Extension.empty() || Extension == ".h") {
- auto NonEmptyFileName = FileName.empty() ? "guess.h" : FileName;
- Environment Env(Code, NonEmptyFileName, /*Ranges=*/{});
- ObjCHeaderStyleGuesser Guesser(Env, getLLVMStyle());
- Guesser.process();
- if (Guesser.isObjC())
- return FormatStyle::LK_ObjC;
- }
- }
- return GuessedLanguage;
- }
- const char *DefaultFormatStyle = "file";
- const char *DefaultFallbackStyle = "LLVM";
- llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>>
- loadAndParseConfigFile(StringRef ConfigFile, llvm::vfs::FileSystem *FS,
- FormatStyle *Style, bool AllowUnknownOptions) {
- llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Text =
- FS->getBufferForFile(ConfigFile.str());
- if (auto EC = Text.getError())
- return EC;
- if (auto EC = parseConfiguration(*Text.get(), Style, AllowUnknownOptions))
- return EC;
- return Text;
- }
- llvm::Expected<FormatStyle> getStyle(StringRef StyleName, StringRef FileName,
- StringRef FallbackStyleName,
- StringRef Code, llvm::vfs::FileSystem *FS,
- bool AllowUnknownOptions) {
- if (!FS) {
- FS = llvm::vfs::getRealFileSystem().get();
- }
- FormatStyle Style = getLLVMStyle(guessLanguage(FileName, Code));
- FormatStyle FallbackStyle = getNoStyle();
- if (!getPredefinedStyle(FallbackStyleName, Style.Language, &FallbackStyle))
- return make_string_error("Invalid fallback style \"" + FallbackStyleName);
- llvm::SmallVector<std::unique_ptr<llvm::MemoryBuffer>, 1>
- ChildFormatTextToApply;
- if (StyleName.startswith("{")) {
- // Parse YAML/JSON style from the command line.
- StringRef Source = "<command-line>";
- if (std::error_code ec =
- parseConfiguration(llvm::MemoryBufferRef(StyleName, Source), &Style,
- AllowUnknownOptions))
- return make_string_error("Error parsing -style: " + ec.message());
- if (Style.InheritsParentConfig)
- ChildFormatTextToApply.emplace_back(
- llvm::MemoryBuffer::getMemBuffer(StyleName, Source, false));
- else
- return Style;
- }
- // User provided clang-format file using -style=file:path/to/format/file.
- if (!Style.InheritsParentConfig &&
- StyleName.startswith_insensitive("file:")) {
- auto ConfigFile = StyleName.substr(5);
- llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Text =
- loadAndParseConfigFile(ConfigFile, FS, &Style, AllowUnknownOptions);
- if (auto EC = Text.getError())
- return make_string_error("Error reading " + ConfigFile + ": " +
- EC.message());
- LLVM_DEBUG(llvm::dbgs()
- << "Using configuration file " << ConfigFile << "\n");
- if (!Style.InheritsParentConfig)
- return Style;
- // Search for parent configs starting from the parent directory of
- // ConfigFile.
- FileName = ConfigFile;
- ChildFormatTextToApply.emplace_back(std::move(*Text));
- }
- // If the style inherits the parent configuration it is a command line
- // configuration, which wants to inherit, so we have to skip the check of the
- // StyleName.
- if (!Style.InheritsParentConfig && !StyleName.equals_insensitive("file")) {
- if (!getPredefinedStyle(StyleName, Style.Language, &Style))
- return make_string_error("Invalid value for -style");
- if (!Style.InheritsParentConfig)
- return Style;
- }
- // Reset possible inheritance
- Style.InheritsParentConfig = false;
- // Look for .clang-format/_clang-format file in the file's parent directories.
- SmallString<128> UnsuitableConfigFiles;
- SmallString<128> Path(FileName);
- if (std::error_code EC = FS->makeAbsolute(Path))
- return make_string_error(EC.message());
- llvm::SmallVector<std::string, 2> FilesToLookFor;
- FilesToLookFor.push_back(".clang-format");
- FilesToLookFor.push_back("_clang-format");
- auto dropDiagnosticHandler = [](const llvm::SMDiagnostic &, void *) {};
- auto applyChildFormatTexts = [&](FormatStyle *Style) {
- for (const auto &MemBuf : llvm::reverse(ChildFormatTextToApply)) {
- auto EC = parseConfiguration(*MemBuf, Style, AllowUnknownOptions,
- dropDiagnosticHandler);
- // It was already correctly parsed.
- assert(!EC);
- static_cast<void>(EC);
- }
- };
- for (StringRef Directory = Path; !Directory.empty();
- Directory = llvm::sys::path::parent_path(Directory)) {
- auto Status = FS->status(Directory);
- if (!Status ||
- Status->getType() != llvm::sys::fs::file_type::directory_file) {
- continue;
- }
- for (const auto &F : FilesToLookFor) {
- SmallString<128> ConfigFile(Directory);
- llvm::sys::path::append(ConfigFile, F);
- LLVM_DEBUG(llvm::dbgs() << "Trying " << ConfigFile << "...\n");
- Status = FS->status(ConfigFile.str());
- if (Status &&
- (Status->getType() == llvm::sys::fs::file_type::regular_file)) {
- llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Text =
- loadAndParseConfigFile(ConfigFile, FS, &Style, AllowUnknownOptions);
- if (auto EC = Text.getError()) {
- if (EC == ParseError::Unsuitable) {
- if (!UnsuitableConfigFiles.empty())
- UnsuitableConfigFiles.append(", ");
- UnsuitableConfigFiles.append(ConfigFile);
- continue;
- }
- return make_string_error("Error reading " + ConfigFile + ": " +
- EC.message());
- }
- LLVM_DEBUG(llvm::dbgs()
- << "Using configuration file " << ConfigFile << "\n");
- if (!Style.InheritsParentConfig) {
- if (ChildFormatTextToApply.empty())
- return Style;
- LLVM_DEBUG(llvm::dbgs() << "Applying child configurations\n");
- applyChildFormatTexts(&Style);
- return Style;
- }
- LLVM_DEBUG(llvm::dbgs() << "Inherits parent configuration\n");
- // Reset inheritance of style
- Style.InheritsParentConfig = false;
- ChildFormatTextToApply.emplace_back(std::move(*Text));
- // Breaking out of the inner loop, since we don't want to parse
- // .clang-format AND _clang-format, if both exist. Then we continue the
- // inner loop (parent directories) in search for the parent
- // configuration.
- break;
- }
- }
- }
- if (!UnsuitableConfigFiles.empty())
- return make_string_error("Configuration file(s) do(es) not support " +
- getLanguageName(Style.Language) + ": " +
- UnsuitableConfigFiles);
- if (!ChildFormatTextToApply.empty()) {
- LLVM_DEBUG(llvm::dbgs()
- << "Applying child configurations on fallback style\n");
- applyChildFormatTexts(&FallbackStyle);
- }
- return FallbackStyle;
- }
- } // namespace format
- } // namespace clang
|