1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273 |
- /* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
- file Copyright.txt or https://cmake.org/licensing for details. */
- #include "cmake.h"
- #include <algorithm>
- #include <array>
- #include <chrono>
- #include <cstdio>
- #include <cstdlib>
- #include <cstring>
- #include <initializer_list>
- #include <iomanip>
- #include <iostream>
- #include <sstream>
- #include <stdexcept>
- #include <utility>
- #include <cm/memory>
- #include <cm/optional>
- #include <cm/string_view>
- #if defined(_WIN32) && !defined(__CYGWIN__) && !defined(CMAKE_BOOT_MINGW)
- # include <cm/iterator>
- #endif
- #include <cmext/algorithm>
- #include <cmext/string_view>
- #include "cmsys/FStream.hxx"
- #include "cmsys/Glob.hxx"
- #include "cmsys/RegularExpression.hxx"
- #include "cm_sys_stat.h"
- #include "cmBuildOptions.h"
- #include "cmCMakePath.h"
- #include "cmCMakePresetsGraph.h"
- #include "cmCommandLineArgument.h"
- #include "cmCommands.h"
- #ifdef CMake_ENABLE_DEBUGGER
- # include "cmDebuggerAdapter.h"
- # ifdef _WIN32
- # include "cmDebuggerWindowsPipeConnection.h"
- # else //!_WIN32
- # include "cmDebuggerPosixPipeConnection.h"
- # endif //_WIN32
- #endif
- #include "cmDocumentation.h"
- #include "cmDocumentationEntry.h"
- #include "cmDuration.h"
- #include "cmExternalMakefileProjectGenerator.h"
- #include "cmFileTimeCache.h"
- #include "cmGeneratorTarget.h"
- #include "cmGlobCacheEntry.h"
- #include "cmGlobalGenerator.h"
- #include "cmGlobalGeneratorFactory.h"
- #include "cmLinkLineComputer.h"
- #include "cmLocalGenerator.h"
- #include "cmMakefile.h"
- #if !defined(CMAKE_BOOTSTRAP)
- # include "cmMakefileProfilingData.h"
- #endif
- #include "cmJSONState.h"
- #include "cmList.h"
- #include "cmMessenger.h"
- #include "cmState.h"
- #include "cmStateDirectory.h"
- #include "cmStringAlgorithms.h"
- #include "cmSystemTools.h"
- #include "cmTarget.h"
- #include "cmTargetLinkLibraryType.h"
- #include "cmUVProcessChain.h"
- #include "cmUtils.hxx"
- #include "cmVersionConfig.h"
- #include "cmWorkingDirectory.h"
- #if !defined(CMAKE_BOOTSTRAP)
- # include <unordered_map>
- # include <cm3p/curl/curl.h>
- # include <cm3p/json/writer.h>
- # include "cmConfigureLog.h"
- # include "cmFileAPI.h"
- # include "cmGraphVizWriter.h"
- # include "cmVariableWatch.h"
- #endif
- #if defined(__MINGW32__) && defined(CMAKE_BOOTSTRAP)
- # define CMAKE_BOOT_MINGW
- #endif
- // include the generator
- #if defined(_WIN32) && !defined(__CYGWIN__)
- # if !defined(CMAKE_BOOT_MINGW)
- # include <cmext/memory>
- # include "cmGlobalBorlandMakefileGenerator.h"
- # include "cmGlobalJOMMakefileGenerator.h"
- # include "cmGlobalNMakeMakefileGenerator.h"
- # include "cmGlobalVisualStudio12Generator.h"
- # include "cmGlobalVisualStudio14Generator.h"
- # include "cmGlobalVisualStudioVersionedGenerator.h"
- # include "cmVSSetupHelper.h"
- # define CMAKE_HAVE_VS_GENERATORS
- # endif
- # include "cmGlobalMSYSMakefileGenerator.h"
- # include "cmGlobalMinGWMakefileGenerator.h"
- #else
- #endif
- #if defined(CMAKE_USE_WMAKE)
- # include "cmGlobalWatcomWMakeGenerator.h"
- #endif
- #if !defined(CMAKE_BOOTSTRAP)
- # include "cmGlobalNinjaGenerator.h"
- # include "cmGlobalUnixMakefileGenerator3.h"
- #elif defined(CMAKE_BOOTSTRAP_MAKEFILES)
- # include "cmGlobalUnixMakefileGenerator3.h"
- #elif defined(CMAKE_BOOTSTRAP_NINJA)
- # include "cmGlobalNinjaGenerator.h"
- #endif
- #if !defined(CMAKE_BOOTSTRAP)
- # include "cmExtraCodeBlocksGenerator.h"
- # include "cmExtraCodeLiteGenerator.h"
- # include "cmExtraEclipseCDT4Generator.h"
- # include "cmExtraKateGenerator.h"
- # include "cmExtraSublimeTextGenerator.h"
- #endif
- // NOTE: the __linux__ macro is predefined on Android host too, but
- // main CMakeLists.txt filters out this generator by host name.
- #if (defined(__linux__) && !defined(__ANDROID__)) || defined(_WIN32)
- # include "cmGlobalGhsMultiGenerator.h"
- #endif
- #if defined(__APPLE__)
- # if !defined(CMAKE_BOOTSTRAP)
- # include "cmGlobalXCodeGenerator.h"
- # define CMAKE_USE_XCODE 1
- # endif
- # include <sys/resource.h>
- # include <sys/time.h>
- #endif
- namespace {
- #if !defined(CMAKE_BOOTSTRAP)
- using JsonValueMapType = std::unordered_map<std::string, Json::Value>;
- #endif
- auto IgnoreAndTrueLambda = [](std::string const&, cmake*) -> bool {
- return true;
- };
- using CommandArgument =
- cmCommandLineArgument<bool(std::string const& value, cmake* state)>;
- #ifndef CMAKE_BOOTSTRAP
- void cmWarnUnusedCliWarning(const std::string& variable, int /*unused*/,
- void* ctx, const char* /*unused*/,
- const cmMakefile* /*unused*/)
- {
- cmake* cm = reinterpret_cast<cmake*>(ctx);
- cm->MarkCliAsUsed(variable);
- }
- #endif
- bool cmakeCheckStampFile(const std::string& stampName)
- {
- // The stamp file does not exist. Use the stamp dependencies to
- // determine whether it is really out of date. This works in
- // conjunction with cmLocalVisualStudio7Generator to avoid
- // repeatedly re-running CMake when the user rebuilds the entire
- // solution.
- std::string stampDepends = cmStrCat(stampName, ".depend");
- #if defined(_WIN32) || defined(__CYGWIN__)
- cmsys::ifstream fin(stampDepends.c_str(), std::ios::in | std::ios::binary);
- #else
- cmsys::ifstream fin(stampDepends.c_str());
- #endif
- if (!fin) {
- // The stamp dependencies file cannot be read. Just assume the
- // build system is really out of date.
- std::cout << "CMake is re-running because " << stampName
- << " dependency file is missing.\n";
- return false;
- }
- // Compare the stamp dependencies against the dependency file itself.
- {
- cmFileTimeCache ftc;
- std::string dep;
- while (cmSystemTools::GetLineFromStream(fin, dep)) {
- int result;
- if (!dep.empty() && dep[0] != '#' &&
- (!ftc.Compare(stampDepends, dep, &result) || result < 0)) {
- // The stamp depends file is older than this dependency. The
- // build system is really out of date.
- /* clang-format off */
- std::cout << "CMake is re-running because " << stampName
- << " is out-of-date.\n"
- " the file '" << dep << "'\n"
- " is newer than '" << stampDepends << "'\n"
- " result='" << result << "'\n";
- /* clang-format on */
- return false;
- }
- }
- }
- // The build system is up to date. The stamp file has been removed
- // by the VS IDE due to a "rebuild" request. Restore it atomically.
- std::ostringstream stampTempStream;
- stampTempStream << stampName << ".tmp" << cmSystemTools::RandomSeed();
- std::string stampTemp = stampTempStream.str();
- {
- // TODO: Teach cmGeneratedFileStream to use a random temp file (with
- // multiple tries in unlikely case of conflict) and use that here.
- cmsys::ofstream stamp(stampTemp.c_str());
- stamp << "# CMake generation timestamp file for this directory.\n";
- }
- std::string err;
- if (cmSystemTools::RenameFile(stampTemp, stampName,
- cmSystemTools::Replace::Yes, &err) ==
- cmSystemTools::RenameResult::Success) {
- // CMake does not need to re-run because the stamp file is up-to-date.
- return true;
- }
- cmSystemTools::RemoveFile(stampTemp);
- cmSystemTools::Error(
- cmStrCat("Cannot restore timestamp \"", stampName, "\": ", err));
- return false;
- }
- bool cmakeCheckStampList(const std::string& stampList)
- {
- // If the stamp list does not exist CMake must rerun to generate it.
- if (!cmSystemTools::FileExists(stampList)) {
- std::cout << "CMake is re-running because generate.stamp.list "
- "is missing.\n";
- return false;
- }
- cmsys::ifstream fin(stampList.c_str());
- if (!fin) {
- std::cout << "CMake is re-running because generate.stamp.list "
- "could not be read.\n";
- return false;
- }
- // Check each stamp.
- std::string stampName;
- while (cmSystemTools::GetLineFromStream(fin, stampName)) {
- if (!cmakeCheckStampFile(stampName)) {
- return false;
- }
- }
- return true;
- }
- } // namespace
- cmDocumentationEntry cmake::CMAKE_STANDARD_OPTIONS_TABLE[18] = {
- { "-S <path-to-source>", "Explicitly specify a source directory." },
- { "-B <path-to-build>", "Explicitly specify a build directory." },
- { "-C <initial-cache>", "Pre-load a script to populate the cache." },
- { "-D <var>[:<type>]=<value>", "Create or update a cmake cache entry." },
- { "-U <globbing_expr>", "Remove matching entries from CMake cache." },
- { "-G <generator-name>", "Specify a build system generator." },
- { "-T <toolset-name>", "Specify toolset name if supported by generator." },
- { "-A <platform-name>", "Specify platform name if supported by generator." },
- { "--toolchain <file>", "Specify toolchain file [CMAKE_TOOLCHAIN_FILE]." },
- { "--install-prefix <directory>",
- "Specify install directory [CMAKE_INSTALL_PREFIX]." },
- { "-Wdev", "Enable developer warnings." },
- { "-Wno-dev", "Suppress developer warnings." },
- { "-Werror=dev", "Make developer warnings errors." },
- { "-Wno-error=dev", "Make developer warnings not errors." },
- { "-Wdeprecated", "Enable deprecation warnings." },
- { "-Wno-deprecated", "Suppress deprecation warnings." },
- { "-Werror=deprecated",
- "Make deprecated macro and function warnings "
- "errors." },
- { "-Wno-error=deprecated",
- "Make deprecated macro and function warnings "
- "not errors." }
- };
- cmake::cmake(Role role, cmState::Mode mode, cmState::ProjectKind projectKind)
- : CMakeWorkingDirectory(cmSystemTools::GetCurrentWorkingDirectory())
- , FileTimeCache(cm::make_unique<cmFileTimeCache>())
- #ifndef CMAKE_BOOTSTRAP
- , VariableWatch(cm::make_unique<cmVariableWatch>())
- #endif
- , State(cm::make_unique<cmState>(mode, projectKind))
- , Messenger(cm::make_unique<cmMessenger>())
- {
- this->TraceFile.close();
- this->CurrentSnapshot = this->State->CreateBaseSnapshot();
- #ifdef __APPLE__
- struct rlimit rlp;
- if (!getrlimit(RLIMIT_STACK, &rlp)) {
- if (rlp.rlim_cur != rlp.rlim_max) {
- rlp.rlim_cur = rlp.rlim_max;
- setrlimit(RLIMIT_STACK, &rlp);
- }
- }
- #endif
- this->AddDefaultGenerators();
- this->AddDefaultExtraGenerators();
- if (role == RoleScript || role == RoleProject) {
- this->AddScriptingCommands();
- }
- if (role == RoleProject) {
- this->AddProjectCommands();
- }
- if (mode == cmState::Project || mode == cmState::Help) {
- this->LoadEnvironmentPresets();
- }
- // Make sure we can capture the build tool output.
- cmSystemTools::EnableVSConsoleOutput();
- // Set up a list of source and header extensions.
- // These are used to find files when the extension is not given.
- {
- auto setupExts = [](FileExtensions& exts,
- std::initializer_list<cm::string_view> extList) {
- // Fill ordered vector
- exts.ordered.reserve(extList.size());
- for (cm::string_view ext : extList) {
- exts.ordered.emplace_back(ext);
- }
- // Fill unordered set
- exts.unordered.insert(exts.ordered.begin(), exts.ordered.end());
- };
- // The "c" extension MUST precede the "C" extension.
- setupExts(this->CLikeSourceFileExtensions,
- { "c", "C", "c++", "cc", "cpp", "cxx", "cu", "mpp", "m", "M",
- "mm", "ixx", "cppm", "ccm", "cxxm", "c++m" });
- setupExts(this->HeaderFileExtensions,
- { "h", "hh", "h++", "hm", "hpp", "hxx", "in", "txx" });
- setupExts(this->CudaFileExtensions, { "cu" });
- setupExts(this->FortranFileExtensions,
- { "f", "F", "for", "f77", "f90", "f95", "f03" });
- setupExts(this->HipFileExtensions, { "hip" });
- setupExts(this->ISPCFileExtensions, { "ispc" });
- }
- }
- cmake::~cmake() = default;
- #if !defined(CMAKE_BOOTSTRAP)
- Json::Value cmake::ReportVersionJson() const
- {
- Json::Value version = Json::objectValue;
- version["string"] = CMake_VERSION;
- version["major"] = CMake_VERSION_MAJOR;
- version["minor"] = CMake_VERSION_MINOR;
- version["suffix"] = CMake_VERSION_SUFFIX;
- version["isDirty"] = (CMake_VERSION_IS_DIRTY == 1);
- version["patch"] = CMake_VERSION_PATCH;
- return version;
- }
- Json::Value cmake::ReportCapabilitiesJson() const
- {
- Json::Value obj = Json::objectValue;
- // Version information:
- obj["version"] = this->ReportVersionJson();
- // Generators:
- std::vector<cmake::GeneratorInfo> generatorInfoList;
- this->GetRegisteredGenerators(generatorInfoList);
- auto* curlVersion = curl_version_info(CURLVERSION_FIRST);
- JsonValueMapType generatorMap;
- for (cmake::GeneratorInfo const& gi : generatorInfoList) {
- if (gi.isAlias) { // skip aliases, they are there for compatibility reasons
- // only
- continue;
- }
- if (gi.extraName.empty()) {
- Json::Value gen = Json::objectValue;
- gen["name"] = gi.name;
- gen["toolsetSupport"] = gi.supportsToolset;
- gen["platformSupport"] = gi.supportsPlatform;
- if (!gi.supportedPlatforms.empty()) {
- Json::Value supportedPlatforms = Json::arrayValue;
- for (std::string const& platform : gi.supportedPlatforms) {
- supportedPlatforms.append(platform);
- }
- gen["supportedPlatforms"] = std::move(supportedPlatforms);
- }
- gen["extraGenerators"] = Json::arrayValue;
- generatorMap[gi.name] = gen;
- } else {
- Json::Value& gen = generatorMap[gi.baseName];
- gen["extraGenerators"].append(gi.extraName);
- }
- }
- Json::Value generators = Json::arrayValue;
- for (auto const& i : generatorMap) {
- generators.append(i.second);
- }
- obj["generators"] = generators;
- obj["fileApi"] = cmFileAPI::ReportCapabilities();
- obj["serverMode"] = false;
- obj["tls"] = static_cast<bool>(curlVersion->features & CURL_VERSION_SSL);
- # ifdef CMake_ENABLE_DEBUGGER
- obj["debugger"] = true;
- # else
- obj["debugger"] = false;
- # endif
- return obj;
- }
- #endif
- std::string cmake::ReportCapabilities() const
- {
- std::string result;
- #if !defined(CMAKE_BOOTSTRAP)
- Json::FastWriter writer;
- result = writer.write(this->ReportCapabilitiesJson());
- #else
- result = "Not supported";
- #endif
- return result;
- }
- void cmake::CleanupCommandsAndMacros()
- {
- this->CurrentSnapshot = this->State->Reset();
- this->State->RemoveUserDefinedCommands();
- this->CurrentSnapshot.SetDefaultDefinitions();
- // FIXME: InstalledFiles probably belongs in the global generator.
- this->InstalledFiles.clear();
- }
- #ifndef CMAKE_BOOTSTRAP
- void cmake::SetWarningFromPreset(const std::string& name,
- const cm::optional<bool>& warning,
- const cm::optional<bool>& error)
- {
- if (warning) {
- if (*warning) {
- this->DiagLevels[name] = std::max(this->DiagLevels[name], DIAG_WARN);
- } else {
- this->DiagLevels[name] = DIAG_IGNORE;
- }
- }
- if (error) {
- if (*error) {
- this->DiagLevels[name] = DIAG_ERROR;
- } else {
- this->DiagLevels[name] = std::min(this->DiagLevels[name], DIAG_WARN);
- }
- }
- }
- void cmake::ProcessPresetVariables()
- {
- for (auto const& var : this->UnprocessedPresetVariables) {
- if (!var.second) {
- continue;
- }
- cmStateEnums::CacheEntryType type = cmStateEnums::UNINITIALIZED;
- if (!var.second->Type.empty()) {
- type = cmState::StringToCacheEntryType(var.second->Type);
- }
- this->ProcessCacheArg(var.first, var.second->Value, type);
- }
- }
- void cmake::PrintPresetVariables()
- {
- bool first = true;
- for (auto const& var : this->UnprocessedPresetVariables) {
- if (!var.second) {
- continue;
- }
- cmStateEnums::CacheEntryType type = cmStateEnums::UNINITIALIZED;
- if (!var.second->Type.empty()) {
- type = cmState::StringToCacheEntryType(var.second->Type);
- }
- if (first) {
- std::cout << "Preset CMake variables:\n\n";
- first = false;
- }
- std::cout << " " << var.first;
- if (type != cmStateEnums::UNINITIALIZED) {
- std::cout << ':' << cmState::CacheEntryTypeToString(type);
- }
- std::cout << "=\"" << var.second->Value << "\"\n";
- }
- if (!first) {
- std::cout << '\n';
- }
- this->UnprocessedPresetVariables.clear();
- }
- void cmake::ProcessPresetEnvironment()
- {
- for (auto const& var : this->UnprocessedPresetEnvironment) {
- if (var.second) {
- cmSystemTools::PutEnv(cmStrCat(var.first, '=', *var.second));
- }
- }
- }
- void cmake::PrintPresetEnvironment()
- {
- bool first = true;
- for (auto const& var : this->UnprocessedPresetEnvironment) {
- if (!var.second) {
- continue;
- }
- if (first) {
- std::cout << "Preset environment variables:\n\n";
- first = false;
- }
- std::cout << " " << var.first << "=\"" << *var.second << "\"\n";
- }
- if (!first) {
- std::cout << '\n';
- }
- this->UnprocessedPresetEnvironment.clear();
- }
- #endif
- // Parse the args
- bool cmake::SetCacheArgs(const std::vector<std::string>& args)
- {
- auto DefineLambda = [](std::string const& entry, cmake* state) -> bool {
- std::string var;
- std::string value;
- cmStateEnums::CacheEntryType type = cmStateEnums::UNINITIALIZED;
- if (cmState::ParseCacheEntry(entry, var, value, type)) {
- #ifndef CMAKE_BOOTSTRAP
- state->UnprocessedPresetVariables.erase(var);
- #endif
- state->ProcessCacheArg(var, value, type);
- } else {
- cmSystemTools::Error(cmStrCat("Parse error in command line argument: ",
- entry, "\n Should be: VAR:type=value\n"));
- return false;
- }
- return true;
- };
- auto WarningLambda = [](cm::string_view entry, cmake* state) -> bool {
- bool foundNo = false;
- bool foundError = false;
- if (cmHasLiteralPrefix(entry, "no-")) {
- foundNo = true;
- entry.remove_prefix(3);
- }
- if (cmHasLiteralPrefix(entry, "error=")) {
- foundError = true;
- entry.remove_prefix(6);
- }
- if (entry.empty()) {
- cmSystemTools::Error("No warning name provided.");
- return false;
- }
- std::string const name = std::string(entry);
- if (!foundNo && !foundError) {
- // -W<name>
- state->DiagLevels[name] = std::max(state->DiagLevels[name], DIAG_WARN);
- } else if (foundNo && !foundError) {
- // -Wno<name>
- state->DiagLevels[name] = DIAG_IGNORE;
- } else if (!foundNo && foundError) {
- // -Werror=<name>
- state->DiagLevels[name] = DIAG_ERROR;
- } else {
- // -Wno-error=<name>
- // This can downgrade an error to a warning, but should not enable
- // or disable a warning in the first place.
- auto dli = state->DiagLevels.find(name);
- if (dli != state->DiagLevels.end()) {
- dli->second = std::min(dli->second, DIAG_WARN);
- }
- }
- return true;
- };
- auto UnSetLambda = [](std::string const& entryPattern,
- cmake* state) -> bool {
- cmsys::RegularExpression regex(
- cmsys::Glob::PatternToRegex(entryPattern, true, true));
- // go through all cache entries and collect the vars which will be
- // removed
- std::vector<std::string> entriesToDelete;
- std::vector<std::string> cacheKeys = state->State->GetCacheEntryKeys();
- for (std::string const& ck : cacheKeys) {
- cmStateEnums::CacheEntryType t = state->State->GetCacheEntryType(ck);
- if (t != cmStateEnums::STATIC) {
- if (regex.find(ck)) {
- entriesToDelete.push_back(ck);
- }
- }
- }
- // now remove them from the cache
- for (std::string const& currentEntry : entriesToDelete) {
- #ifndef CMAKE_BOOTSTRAP
- state->UnprocessedPresetVariables.erase(currentEntry);
- #endif
- state->State->RemoveCacheEntry(currentEntry);
- }
- return true;
- };
- auto ScriptLambda = [&](std::string const& path, cmake* state) -> bool {
- #ifdef CMake_ENABLE_DEBUGGER
- // Script mode doesn't hit the usual code path in cmake::Run() that starts
- // the debugger, so start it manually here instead.
- if (!this->StartDebuggerIfEnabled()) {
- return false;
- }
- #endif
- // Register fake project commands that hint misuse in script mode.
- GetProjectCommandsInScriptMode(state->GetState());
- // Documented behavior of CMAKE{,_CURRENT}_{SOURCE,BINARY}_DIR is to be
- // set to $PWD for -P mode.
- state->SetWorkingMode(SCRIPT_MODE);
- state->SetHomeDirectory(cmSystemTools::GetCurrentWorkingDirectory());
- state->SetHomeOutputDirectory(cmSystemTools::GetCurrentWorkingDirectory());
- state->ReadListFile(args, path);
- return true;
- };
- auto PrefixLambda = [&](std::string const& path, cmake* state) -> bool {
- const std::string var = "CMAKE_INSTALL_PREFIX";
- cmStateEnums::CacheEntryType type = cmStateEnums::PATH;
- cmCMakePath absolutePath(path);
- if (absolutePath.IsAbsolute()) {
- #ifndef CMAKE_BOOTSTRAP
- state->UnprocessedPresetVariables.erase(var);
- #endif
- state->ProcessCacheArg(var, path, type);
- return true;
- }
- cmSystemTools::Error("Absolute paths are required for --install-prefix");
- return false;
- };
- auto ToolchainLambda = [&](std::string const& path, cmake* state) -> bool {
- const std::string var = "CMAKE_TOOLCHAIN_FILE";
- cmStateEnums::CacheEntryType type = cmStateEnums::FILEPATH;
- #ifndef CMAKE_BOOTSTRAP
- state->UnprocessedPresetVariables.erase(var);
- #endif
- state->ProcessCacheArg(var, path, type);
- return true;
- };
- std::vector<CommandArgument> arguments = {
- CommandArgument{ "-D", "-D must be followed with VAR=VALUE.",
- CommandArgument::Values::One,
- CommandArgument::RequiresSeparator::No, DefineLambda },
- CommandArgument{ "-W", "-W must be followed with [no-]<name>.",
- CommandArgument::Values::One,
- CommandArgument::RequiresSeparator::No, WarningLambda },
- CommandArgument{ "-U", "-U must be followed with VAR.",
- CommandArgument::Values::One,
- CommandArgument::RequiresSeparator::No, UnSetLambda },
- CommandArgument{
- "-C", "-C must be followed by a file name.",
- CommandArgument::Values::One, CommandArgument::RequiresSeparator::No,
- [&](std::string const& value, cmake* state) -> bool {
- if (value.empty()) {
- cmSystemTools::Error("No file name specified for -C");
- return false;
- }
- cmSystemTools::Stdout("loading initial cache file " + value + "\n");
- // Resolve script path specified on command line
- // relative to $PWD.
- auto path = cmSystemTools::CollapseFullPath(value);
- state->ReadListFile(args, path);
- return true;
- } },
- CommandArgument{ "-P", "-P must be followed by a file name.",
- CommandArgument::Values::One,
- CommandArgument::RequiresSeparator::No, ScriptLambda },
- CommandArgument{ "--toolchain", "No file specified for --toolchain",
- CommandArgument::Values::One, ToolchainLambda },
- CommandArgument{ "--install-prefix",
- "No install directory specified for --install-prefix",
- CommandArgument::Values::One, PrefixLambda },
- CommandArgument{ "--find-package", CommandArgument::Values::Zero,
- IgnoreAndTrueLambda },
- };
- for (decltype(args.size()) i = 1; i < args.size(); ++i) {
- std::string const& arg = args[i];
- if (arg == "--" && this->GetWorkingMode() == SCRIPT_MODE) {
- // Stop processing CMake args and avoid possible errors
- // when arbitrary args are given to CMake script.
- break;
- }
- for (auto const& m : arguments) {
- if (m.matches(arg)) {
- const bool parsedCorrectly = m.parse(arg, i, args, this);
- if (!parsedCorrectly) {
- return false;
- }
- }
- }
- }
- if (this->GetWorkingMode() == FIND_PACKAGE_MODE) {
- return this->FindPackage(args);
- }
- return true;
- }
- void cmake::ProcessCacheArg(const std::string& var, const std::string& value,
- cmStateEnums::CacheEntryType type)
- {
- // The value is transformed if it is a filepath for example, so
- // we can't compare whether the value is already in the cache until
- // after we call AddCacheEntry.
- bool haveValue = false;
- std::string cachedValue;
- if (this->WarnUnusedCli) {
- if (cmValue v = this->State->GetInitializedCacheValue(var)) {
- haveValue = true;
- cachedValue = *v;
- }
- }
- this->AddCacheEntry(
- var, value, "No help, variable specified on the command line.", type);
- if (this->WarnUnusedCli) {
- if (!haveValue ||
- cachedValue != *this->State->GetInitializedCacheValue(var)) {
- this->WatchUnusedCli(var);
- }
- }
- }
- void cmake::ReadListFile(const std::vector<std::string>& args,
- const std::string& path)
- {
- // if a generator was not yet created, temporarily create one
- cmGlobalGenerator* gg = this->GetGlobalGenerator();
- // if a generator was not specified use a generic one
- std::unique_ptr<cmGlobalGenerator> gen;
- if (!gg) {
- gen = cm::make_unique<cmGlobalGenerator>(this);
- gg = gen.get();
- }
- // read in the list file to fill the cache
- if (!path.empty()) {
- this->CurrentSnapshot = this->State->Reset();
- cmStateSnapshot snapshot = this->GetCurrentSnapshot();
- snapshot.GetDirectory().SetCurrentBinary(this->GetHomeOutputDirectory());
- snapshot.GetDirectory().SetCurrentSource(this->GetHomeDirectory());
- snapshot.SetDefaultDefinitions();
- cmMakefile mf(gg, snapshot);
- if (this->GetWorkingMode() != NORMAL_MODE) {
- std::string file(cmSystemTools::CollapseFullPath(path));
- cmSystemTools::ConvertToUnixSlashes(file);
- mf.SetScriptModeFile(file);
- mf.SetArgcArgv(args);
- }
- if (!cmSystemTools::FileExists(path, true)) {
- cmSystemTools::Error("Not a file: " + path);
- }
- if (!mf.ReadListFile(path)) {
- cmSystemTools::Error("Error processing file: " + path);
- }
- }
- }
- bool cmake::FindPackage(const std::vector<std::string>& args)
- {
- this->SetHomeDirectory(cmSystemTools::GetCurrentWorkingDirectory());
- this->SetHomeOutputDirectory(cmSystemTools::GetCurrentWorkingDirectory());
- this->SetGlobalGenerator(cm::make_unique<cmGlobalGenerator>(this));
- cmStateSnapshot snapshot = this->GetCurrentSnapshot();
- snapshot.GetDirectory().SetCurrentBinary(
- cmSystemTools::GetCurrentWorkingDirectory());
- snapshot.GetDirectory().SetCurrentSource(
- cmSystemTools::GetCurrentWorkingDirectory());
- // read in the list file to fill the cache
- snapshot.SetDefaultDefinitions();
- auto mfu = cm::make_unique<cmMakefile>(this->GetGlobalGenerator(), snapshot);
- cmMakefile* mf = mfu.get();
- this->GlobalGenerator->AddMakefile(std::move(mfu));
- mf->SetArgcArgv(args);
- std::string systemFile = mf->GetModulesFile("CMakeFindPackageMode.cmake");
- mf->ReadListFile(systemFile);
- std::string language = mf->GetSafeDefinition("LANGUAGE");
- std::string mode = mf->GetSafeDefinition("MODE");
- std::string packageName = mf->GetSafeDefinition("NAME");
- bool packageFound = mf->IsOn("PACKAGE_FOUND");
- bool quiet = mf->IsOn("PACKAGE_QUIET");
- if (!packageFound) {
- if (!quiet) {
- printf("%s not found.\n", packageName.c_str());
- }
- } else if (mode == "EXIST"_s) {
- if (!quiet) {
- printf("%s found.\n", packageName.c_str());
- }
- } else if (mode == "COMPILE"_s) {
- std::string includes = mf->GetSafeDefinition("PACKAGE_INCLUDE_DIRS");
- cmList includeDirs{ includes };
- this->GlobalGenerator->CreateGenerationObjects();
- const auto& lg = this->GlobalGenerator->LocalGenerators[0];
- std::string includeFlags =
- lg->GetIncludeFlags(includeDirs, nullptr, language, std::string());
- std::string definitions = mf->GetSafeDefinition("PACKAGE_DEFINITIONS");
- printf("%s %s\n", includeFlags.c_str(), definitions.c_str());
- } else if (mode == "LINK"_s) {
- const char* targetName = "dummy";
- std::vector<std::string> srcs;
- cmTarget* tgt = mf->AddExecutable(targetName, srcs, true);
- tgt->SetProperty("LINKER_LANGUAGE", language);
- std::string libs = mf->GetSafeDefinition("PACKAGE_LIBRARIES");
- cmList libList{ libs };
- for (std::string const& lib : libList) {
- tgt->AddLinkLibrary(*mf, lib, GENERAL_LibraryType);
- }
- std::string buildType = mf->GetSafeDefinition("CMAKE_BUILD_TYPE");
- buildType = cmSystemTools::UpperCase(buildType);
- std::string linkLibs;
- std::string frameworkPath;
- std::string linkPath;
- std::string flags;
- std::string linkFlags;
- this->GlobalGenerator->CreateGenerationObjects();
- cmGeneratorTarget* gtgt =
- this->GlobalGenerator->FindGeneratorTarget(tgt->GetName());
- cmLocalGenerator* lg = gtgt->GetLocalGenerator();
- cmLinkLineComputer linkLineComputer(lg,
- lg->GetStateSnapshot().GetDirectory());
- lg->GetTargetFlags(&linkLineComputer, buildType, linkLibs, flags,
- linkFlags, frameworkPath, linkPath, gtgt);
- linkLibs = frameworkPath + linkPath + linkLibs;
- printf("%s\n", linkLibs.c_str());
- /* if ( use_win32 )
- {
- tgt->SetProperty("WIN32_EXECUTABLE", "ON");
- }
- if ( use_macbundle)
- {
- tgt->SetProperty("MACOSX_BUNDLE", "ON");
- }*/
- }
- return packageFound;
- }
- void cmake::LoadEnvironmentPresets()
- {
- std::string envGenVar;
- bool hasEnvironmentGenerator = false;
- if (cmSystemTools::GetEnv("CMAKE_GENERATOR", envGenVar)) {
- hasEnvironmentGenerator = true;
- this->EnvironmentGenerator = envGenVar;
- }
- auto readGeneratorVar = [&](std::string const& name, std::string& key) {
- std::string varValue;
- if (cmSystemTools::GetEnv(name, varValue)) {
- if (hasEnvironmentGenerator) {
- key = varValue;
- } else if (!this->GetIsInTryCompile()) {
- std::string message =
- cmStrCat("Warning: Environment variable ", name,
- " will be ignored, because CMAKE_GENERATOR is not set.");
- cmSystemTools::Message(message, "Warning");
- }
- }
- };
- readGeneratorVar("CMAKE_GENERATOR_INSTANCE", this->GeneratorInstance);
- readGeneratorVar("CMAKE_GENERATOR_PLATFORM", this->GeneratorPlatform);
- readGeneratorVar("CMAKE_GENERATOR_TOOLSET", this->GeneratorToolset);
- }
- namespace {
- enum class ListPresets
- {
- None,
- Configure,
- Build,
- Test,
- Package,
- Workflow,
- All,
- };
- }
- // Parse the args
- void cmake::SetArgs(const std::vector<std::string>& args)
- {
- bool haveToolset = false;
- bool havePlatform = false;
- bool haveBArg = false;
- std::string possibleUnknownArg;
- std::string extraProvidedPath;
- #if !defined(CMAKE_BOOTSTRAP)
- std::string profilingFormat;
- std::string profilingOutput;
- std::string presetName;
- ListPresets listPresets = ListPresets::None;
- #endif
- auto EmptyStringArgLambda = [](std::string const&, cmake* state) -> bool {
- state->IssueMessage(
- MessageType::WARNING,
- "Ignoring empty string (\"\") provided on the command line.");
- return true;
- };
- auto SourceArgLambda = [](std::string const& value, cmake* state) -> bool {
- if (value.empty()) {
- cmSystemTools::Error("No source directory specified for -S");
- return false;
- }
- std::string path = cmSystemTools::CollapseFullPath(value);
- cmSystemTools::ConvertToUnixSlashes(path);
- state->SetHomeDirectoryViaCommandLine(path);
- return true;
- };
- auto BuildArgLambda = [&](std::string const& value, cmake* state) -> bool {
- if (value.empty()) {
- cmSystemTools::Error("No build directory specified for -B");
- return false;
- }
- std::string path = cmSystemTools::CollapseFullPath(value);
- cmSystemTools::ConvertToUnixSlashes(path);
- state->SetHomeOutputDirectory(path);
- haveBArg = true;
- return true;
- };
- auto PlatformLambda = [&](std::string const& value, cmake* state) -> bool {
- if (havePlatform) {
- cmSystemTools::Error("Multiple -A options not allowed");
- return false;
- }
- state->SetGeneratorPlatform(value);
- havePlatform = true;
- return true;
- };
- auto ToolsetLambda = [&](std::string const& value, cmake* state) -> bool {
- if (haveToolset) {
- cmSystemTools::Error("Multiple -T options not allowed");
- return false;
- }
- state->SetGeneratorToolset(value);
- haveToolset = true;
- return true;
- };
- std::vector<CommandArgument> arguments = {
- CommandArgument{ "", CommandArgument::Values::Zero, EmptyStringArgLambda },
- CommandArgument{ "-S", "No source directory specified for -S",
- CommandArgument::Values::One,
- CommandArgument::RequiresSeparator::No, SourceArgLambda },
- CommandArgument{ "-H", "No source directory specified for -H",
- CommandArgument::Values::One,
- CommandArgument::RequiresSeparator::No, SourceArgLambda },
- CommandArgument{ "-O", CommandArgument::Values::Zero,
- IgnoreAndTrueLambda },
- CommandArgument{ "-B", "No build directory specified for -B",
- CommandArgument::Values::One,
- CommandArgument::RequiresSeparator::No, BuildArgLambda },
- CommandArgument{ "--fresh", CommandArgument::Values::Zero,
- [](std::string const&, cmake* cm) -> bool {
- cm->FreshCache = true;
- return true;
- } },
- CommandArgument{ "-P", "-P must be followed by a file name.",
- CommandArgument::Values::One,
- CommandArgument::RequiresSeparator::No,
- IgnoreAndTrueLambda },
- CommandArgument{ "-D", "-D must be followed with VAR=VALUE.",
- CommandArgument::Values::One,
- CommandArgument::RequiresSeparator::No,
- IgnoreAndTrueLambda },
- CommandArgument{ "-C", "-C must be followed by a file name.",
- CommandArgument::Values::One,
- CommandArgument::RequiresSeparator::No,
- IgnoreAndTrueLambda },
- CommandArgument{
- "-U", "-U must be followed with VAR.", CommandArgument::Values::One,
- CommandArgument::RequiresSeparator::No, IgnoreAndTrueLambda },
- CommandArgument{ "-W", "-W must be followed with [no-]<name>.",
- CommandArgument::Values::One,
- CommandArgument::RequiresSeparator::No,
- IgnoreAndTrueLambda },
- CommandArgument{ "-A", "No platform specified for -A",
- CommandArgument::Values::One,
- CommandArgument::RequiresSeparator::No, PlatformLambda },
- CommandArgument{ "-T", "No toolset specified for -T",
- CommandArgument::Values::One,
- CommandArgument::RequiresSeparator::No, ToolsetLambda },
- CommandArgument{ "--toolchain", "No file specified for --toolchain",
- CommandArgument::Values::One, IgnoreAndTrueLambda },
- CommandArgument{ "--install-prefix",
- "No install directory specified for --install-prefix",
- CommandArgument::Values::One, IgnoreAndTrueLambda },
- CommandArgument{ "--check-build-system", CommandArgument::Values::Two,
- [](std::string const& value, cmake* state) -> bool {
- cmList values{ value };
- state->CheckBuildSystemArgument = values[0];
- state->ClearBuildSystem = (atoi(values[1].c_str()) > 0);
- return true;
- } },
- CommandArgument{ "--check-stamp-file", CommandArgument::Values::One,
- [](std::string const& value, cmake* state) -> bool {
- state->CheckStampFile = value;
- return true;
- } },
- CommandArgument{ "--check-stamp-list", CommandArgument::Values::One,
- [](std::string const& value, cmake* state) -> bool {
- state->CheckStampList = value;
- return true;
- } },
- CommandArgument{ "--regenerate-during-build",
- CommandArgument::Values::Zero,
- [](std::string const&, cmake* state) -> bool {
- state->RegenerateDuringBuild = true;
- return true;
- } },
- CommandArgument{ "--find-package", CommandArgument::Values::Zero,
- IgnoreAndTrueLambda },
- CommandArgument{ "--graphviz", "No file specified for --graphviz",
- CommandArgument::Values::One,
- [](std::string const& value, cmake* state) -> bool {
- std::string path =
- cmSystemTools::CollapseFullPath(value);
- cmSystemTools::ConvertToUnixSlashes(path);
- state->GraphVizFile = path;
- return true;
- } },
- CommandArgument{ "--debug-trycompile", CommandArgument::Values::Zero,
- [](std::string const&, cmake* state) -> bool {
- std::cout << "debug trycompile on\n";
- state->DebugTryCompileOn();
- return true;
- } },
- CommandArgument{ "--debug-output", CommandArgument::Values::Zero,
- [](std::string const&, cmake* state) -> bool {
- std::cout << "Running with debug output on.\n";
- state->SetDebugOutputOn(true);
- return true;
- } },
- CommandArgument{ "--log-level", "Invalid level specified for --log-level",
- CommandArgument::Values::One,
- [](std::string const& value, cmake* state) -> bool {
- const auto logLevel = StringToLogLevel(value);
- if (logLevel == Message::LogLevel::LOG_UNDEFINED) {
- cmSystemTools::Error(
- "Invalid level specified for --log-level");
- return false;
- }
- state->SetLogLevel(logLevel);
- state->LogLevelWasSetViaCLI = true;
- return true;
- } },
- // This is supported for backward compatibility. This option only
- // appeared in the 3.15.x release series and was renamed to
- // --log-level in 3.16.0
- CommandArgument{ "--loglevel", "Invalid level specified for --loglevel",
- CommandArgument::Values::One,
- [](std::string const& value, cmake* state) -> bool {
- const auto logLevel = StringToLogLevel(value);
- if (logLevel == Message::LogLevel::LOG_UNDEFINED) {
- cmSystemTools::Error(
- "Invalid level specified for --loglevel");
- return false;
- }
- state->SetLogLevel(logLevel);
- state->LogLevelWasSetViaCLI = true;
- return true;
- } },
- CommandArgument{ "--log-context", CommandArgument::Values::Zero,
- [](std::string const&, cmake* state) -> bool {
- state->SetShowLogContext(true);
- return true;
- } },
- CommandArgument{
- "--debug-find", CommandArgument::Values::Zero,
- [](std::string const&, cmake* state) -> bool {
- std::cout << "Running with debug output on for the `find` commands.\n";
- state->SetDebugFindOutput(true);
- return true;
- } },
- CommandArgument{
- "--debug-find-pkg", "Provide a package argument for --debug-find-pkg",
- CommandArgument::Values::One, CommandArgument::RequiresSeparator::Yes,
- [](std::string const& value, cmake* state) -> bool {
- std::vector<std::string> find_pkgs(cmTokenize(value, ","));
- std::cout << "Running with debug output on for the 'find' commands "
- "for package(s)";
- for (auto const& v : find_pkgs) {
- std::cout << ' ' << v;
- state->SetDebugFindOutputPkgs(v);
- }
- std::cout << ".\n";
- return true;
- } },
- CommandArgument{
- "--debug-find-var", CommandArgument::Values::One,
- CommandArgument::RequiresSeparator::Yes,
- [](std::string const& value, cmake* state) -> bool {
- std::vector<std::string> find_vars(cmTokenize(value, ","));
- std::cout << "Running with debug output on for the variable(s)";
- for (auto const& v : find_vars) {
- std::cout << ' ' << v;
- state->SetDebugFindOutputVars(v);
- }
- std::cout << ".\n";
- return true;
- } },
- CommandArgument{ "--trace", CommandArgument::Values::Zero,
- [](std::string const&, cmake* state) -> bool {
- std::cout << "Put cmake in trace mode.\n";
- state->SetTrace(true);
- state->SetTraceExpand(false);
- return true;
- } },
- CommandArgument{ "--trace-expand", CommandArgument::Values::Zero,
- [](std::string const&, cmake* state) -> bool {
- std::cout << "Put cmake in trace mode, but with "
- "variables expanded.\n";
- state->SetTrace(true);
- state->SetTraceExpand(true);
- return true;
- } },
- CommandArgument{
- "--trace-format", "Invalid format specified for --trace-format",
- CommandArgument::Values::One,
- [](std::string const& value, cmake* state) -> bool {
- std::cout << "Put cmake in trace mode and sets the "
- "trace output format.\n";
- state->SetTrace(true);
- const auto traceFormat = StringToTraceFormat(value);
- if (traceFormat == TraceFormat::Undefined) {
- cmSystemTools::Error("Invalid format specified for --trace-format. "
- "Valid formats are human, json-v1.");
- return false;
- }
- state->SetTraceFormat(traceFormat);
- return true;
- } },
- CommandArgument{ "--trace-source", "No file specified for --trace-source",
- CommandArgument::Values::OneOrMore,
- [](std::string const& values, cmake* state) -> bool {
- std::cout << "Put cmake in trace mode, but output only "
- "lines of a specified file. Multiple "
- "options are allowed.\n";
- for (auto file :
- cmSystemTools::SplitString(values, ';')) {
- cmSystemTools::ConvertToUnixSlashes(file);
- state->AddTraceSource(file);
- }
- state->SetTrace(true);
- return true;
- } },
- CommandArgument{ "--trace-redirect",
- "No file specified for --trace-redirect",
- CommandArgument::Values::One,
- [](std::string const& value, cmake* state) -> bool {
- std::cout
- << "Put cmake in trace mode and redirect trace "
- "output to a file instead of stderr.\n";
- std::string file(value);
- cmSystemTools::ConvertToUnixSlashes(file);
- state->SetTraceFile(file);
- state->SetTrace(true);
- return true;
- } },
- CommandArgument{ "--warn-uninitialized", CommandArgument::Values::Zero,
- [](std::string const&, cmake* state) -> bool {
- std::cout << "Warn about uninitialized values.\n";
- state->SetWarnUninitialized(true);
- return true;
- } },
- CommandArgument{ "--warn-unused-vars", CommandArgument::Values::Zero,
- IgnoreAndTrueLambda }, // Option was removed.
- CommandArgument{ "--no-warn-unused-cli", CommandArgument::Values::Zero,
- [](std::string const&, cmake* state) -> bool {
- std::cout
- << "Not searching for unused variables given on the "
- "command line.\n";
- state->SetWarnUnusedCli(false);
- return true;
- } },
- CommandArgument{
- "--check-system-vars", CommandArgument::Values::Zero,
- [](std::string const&, cmake* state) -> bool {
- std::cout << "Also check system files when warning about unused and "
- "uninitialized variables.\n";
- state->SetCheckSystemVars(true);
- return true;
- } },
- CommandArgument{
- "--compile-no-warning-as-error", CommandArgument::Values::Zero,
- [](std::string const&, cmake* state) -> bool {
- std::cout << "Ignoring COMPILE_WARNING_AS_ERROR target property and "
- "CMAKE_COMPILE_WARNING_AS_ERROR variable.\n";
- state->SetIgnoreWarningAsError(true);
- return true;
- } },
- CommandArgument{ "--debugger", CommandArgument::Values::Zero,
- [](std::string const&, cmake* state) -> bool {
- #ifdef CMake_ENABLE_DEBUGGER
- std::cout << "Running with debugger on.\n";
- state->SetDebuggerOn(true);
- return true;
- #else
- static_cast<void>(state);
- cmSystemTools::Error(
- "CMake was not built with support for --debugger");
- return false;
- #endif
- } },
- CommandArgument{ "--debugger-pipe",
- "No path specified for --debugger-pipe",
- CommandArgument::Values::One,
- [](std::string const& value, cmake* state) -> bool {
- #ifdef CMake_ENABLE_DEBUGGER
- state->DebuggerPipe = value;
- return true;
- #else
- static_cast<void>(value);
- static_cast<void>(state);
- cmSystemTools::Error("CMake was not built with support "
- "for --debugger-pipe");
- return false;
- #endif
- } },
- CommandArgument{
- "--debugger-dap-log", "No file specified for --debugger-dap-log",
- CommandArgument::Values::One,
- [](std::string const& value, cmake* state) -> bool {
- #ifdef CMake_ENABLE_DEBUGGER
- std::string path = cmSystemTools::CollapseFullPath(value);
- cmSystemTools::ConvertToUnixSlashes(path);
- state->DebuggerDapLogFile = path;
- return true;
- #else
- static_cast<void>(value);
- static_cast<void>(state);
- cmSystemTools::Error(
- "CMake was not built with support for --debugger-dap-log");
- return false;
- #endif
- } },
- };
- #if defined(CMAKE_HAVE_VS_GENERATORS)
- arguments.emplace_back("--vs-solution-file", CommandArgument::Values::One,
- [](std::string const& value, cmake* state) -> bool {
- state->VSSolutionFile = value;
- return true;
- });
- #endif
- #if !defined(CMAKE_BOOTSTRAP)
- arguments.emplace_back("--profiling-format",
- "No format specified for --profiling-format",
- CommandArgument::Values::One,
- [&](std::string const& value, cmake*) -> bool {
- profilingFormat = value;
- return true;
- });
- arguments.emplace_back(
- "--profiling-output", "No path specified for --profiling-output",
- CommandArgument::Values::One,
- [&](std::string const& value, cmake*) -> bool {
- profilingOutput = cmSystemTools::CollapseFullPath(value);
- cmSystemTools::ConvertToUnixSlashes(profilingOutput);
- return true;
- });
- arguments.emplace_back("--preset", "No preset specified for --preset",
- CommandArgument::Values::One,
- [&](std::string const& value, cmake*) -> bool {
- presetName = value;
- return true;
- });
- arguments.emplace_back(
- "--list-presets", CommandArgument::Values::ZeroOrOne,
- [&](std::string const& value, cmake*) -> bool {
- if (value.empty() || value == "configure") {
- listPresets = ListPresets::Configure;
- } else if (value == "build") {
- listPresets = ListPresets::Build;
- } else if (value == "test") {
- listPresets = ListPresets::Test;
- } else if (value == "package") {
- listPresets = ListPresets::Package;
- } else if (value == "workflow") {
- listPresets = ListPresets::Workflow;
- } else if (value == "all") {
- listPresets = ListPresets::All;
- } else {
- cmSystemTools::Error(
- "Invalid value specified for --list-presets.\n"
- "Valid values are configure, build, test, package, or all. "
- "When no value is passed the default is configure.");
- return false;
- }
- return true;
- });
- #endif
- bool badGeneratorName = false;
- CommandArgument generatorCommand(
- "-G", "No generator specified for -G", CommandArgument::Values::One,
- CommandArgument::RequiresSeparator::No,
- [&](std::string const& value, cmake* state) -> bool {
- bool valid = state->CreateAndSetGlobalGenerator(value, true);
- badGeneratorName = !valid;
- return valid;
- });
- for (decltype(args.size()) i = 1; i < args.size(); ++i) {
- // iterate each argument
- std::string const& arg = args[i];
- if (this->GetWorkingMode() == SCRIPT_MODE && arg == "--") {
- // Stop processing CMake args and avoid possible errors
- // when arbitrary args are given to CMake script.
- break;
- }
- // Generator flag has special handling for when to print help
- // so it becomes the exception
- if (generatorCommand.matches(arg)) {
- bool parsed = generatorCommand.parse(arg, i, args, this);
- if (!parsed && !badGeneratorName) {
- this->PrintGeneratorList();
- return;
- }
- continue;
- }
- bool matched = false;
- bool parsedCorrectly = true; // needs to be true so we can ignore
- // arguments so as -E
- for (auto const& m : arguments) {
- if (m.matches(arg)) {
- matched = true;
- parsedCorrectly = m.parse(arg, i, args, this);
- break;
- }
- }
- // We have an issue where arguments to a "-P" script mode
- // can be provided before the "-P" argument. This means
- // that we need to lazily check this argument after checking
- // all args.
- // Additionally it can't be the source/binary tree location
- if (!parsedCorrectly) {
- cmSystemTools::Error("Run 'cmake --help' for all supported options.");
- exit(1);
- } else if (!matched && cmHasLiteralPrefix(arg, "-")) {
- possibleUnknownArg = arg;
- } else if (!matched) {
- bool parsedDirectory = this->SetDirectoriesFromFile(arg);
- if (!parsedDirectory) {
- extraProvidedPath = arg;
- }
- }
- }
- if (!extraProvidedPath.empty() && this->GetWorkingMode() == NORMAL_MODE) {
- this->IssueMessage(MessageType::WARNING,
- cmStrCat("Ignoring extra path from command line:\n \"",
- extraProvidedPath, "\""));
- }
- if (!possibleUnknownArg.empty() && this->GetWorkingMode() != SCRIPT_MODE) {
- cmSystemTools::Error(cmStrCat("Unknown argument ", possibleUnknownArg));
- cmSystemTools::Error("Run 'cmake --help' for all supported options.");
- exit(1);
- }
- // Empty instance, platform and toolset if only a generator is specified
- if (this->GlobalGenerator) {
- this->GeneratorInstance = "";
- if (!this->GeneratorPlatformSet) {
- this->GeneratorPlatform = "";
- }
- if (!this->GeneratorToolsetSet) {
- this->GeneratorToolset = "";
- }
- }
- #if !defined(CMAKE_BOOTSTRAP)
- if (!profilingOutput.empty() || !profilingFormat.empty()) {
- if (profilingOutput.empty()) {
- cmSystemTools::Error(
- "--profiling-format specified but no --profiling-output!");
- return;
- }
- if (profilingFormat == "google-trace"_s) {
- try {
- this->ProfilingOutput =
- cm::make_unique<cmMakefileProfilingData>(profilingOutput);
- } catch (std::runtime_error& e) {
- cmSystemTools::Error(
- cmStrCat("Could not start profiling: ", e.what()));
- return;
- }
- } else {
- cmSystemTools::Error("Invalid format specified for --profiling-format");
- return;
- }
- }
- #endif
- const bool haveSourceDir = !this->GetHomeDirectory().empty();
- const bool haveBinaryDir = !this->GetHomeOutputDirectory().empty();
- const bool havePreset =
- #ifdef CMAKE_BOOTSTRAP
- false;
- #else
- !presetName.empty();
- #endif
- if (this->CurrentWorkingMode == cmake::NORMAL_MODE && !haveSourceDir &&
- !haveBinaryDir && !havePreset) {
- this->IssueMessage(
- MessageType::WARNING,
- "No source or binary directory provided. Both will be assumed to be "
- "the same as the current working directory, but note that this "
- "warning will become a fatal error in future CMake releases.");
- }
- if (!haveSourceDir) {
- this->SetHomeDirectory(cmSystemTools::GetCurrentWorkingDirectory());
- }
- if (!haveBinaryDir) {
- this->SetHomeOutputDirectory(cmSystemTools::GetCurrentWorkingDirectory());
- }
- #if !defined(CMAKE_BOOTSTRAP)
- if (listPresets != ListPresets::None || !presetName.empty()) {
- cmCMakePresetsGraph presetsGraph;
- auto result = presetsGraph.ReadProjectPresets(this->GetHomeDirectory());
- if (result != true) {
- std::string errorMsg =
- cmStrCat("Could not read presets from ", this->GetHomeDirectory(), ":",
- presetsGraph.parseState.GetErrorMessage());
- cmSystemTools::Error(errorMsg);
- return;
- }
- if (listPresets != ListPresets::None) {
- if (listPresets == ListPresets::Configure) {
- this->PrintPresetList(presetsGraph);
- } else if (listPresets == ListPresets::Build) {
- presetsGraph.PrintBuildPresetList();
- } else if (listPresets == ListPresets::Test) {
- presetsGraph.PrintTestPresetList();
- } else if (listPresets == ListPresets::Package) {
- presetsGraph.PrintPackagePresetList();
- } else if (listPresets == ListPresets::Workflow) {
- presetsGraph.PrintWorkflowPresetList();
- } else if (listPresets == ListPresets::All) {
- presetsGraph.PrintAllPresets();
- }
- this->SetWorkingMode(WorkingMode::HELP_MODE);
- return;
- }
- auto preset = presetsGraph.ConfigurePresets.find(presetName);
- if (preset == presetsGraph.ConfigurePresets.end()) {
- cmSystemTools::Error(cmStrCat("No such preset in ",
- this->GetHomeDirectory(), ": \"",
- presetName, '"'));
- this->PrintPresetList(presetsGraph);
- return;
- }
- if (preset->second.Unexpanded.Hidden) {
- cmSystemTools::Error(cmStrCat("Cannot use hidden preset in ",
- this->GetHomeDirectory(), ": \"",
- presetName, '"'));
- this->PrintPresetList(presetsGraph);
- return;
- }
- auto const& expandedPreset = preset->second.Expanded;
- if (!expandedPreset) {
- cmSystemTools::Error(cmStrCat("Could not evaluate preset \"",
- preset->second.Unexpanded.Name,
- "\": Invalid macro expansion"));
- return;
- }
- if (!expandedPreset->ConditionResult) {
- cmSystemTools::Error(cmStrCat("Could not use disabled preset \"",
- preset->second.Unexpanded.Name, "\""));
- return;
- }
- if (!this->State->IsCacheLoaded() && !haveBArg &&
- !expandedPreset->BinaryDir.empty()) {
- this->SetHomeOutputDirectory(expandedPreset->BinaryDir);
- }
- if (!this->GlobalGenerator && !expandedPreset->Generator.empty()) {
- if (!this->CreateAndSetGlobalGenerator(expandedPreset->Generator,
- false)) {
- return;
- }
- }
- this->UnprocessedPresetVariables = expandedPreset->CacheVariables;
- this->UnprocessedPresetEnvironment = expandedPreset->Environment;
- if (!expandedPreset->InstallDir.empty() &&
- !this->State->GetInitializedCacheValue("CMAKE_INSTALL_PREFIX")) {
- this->UnprocessedPresetVariables["CMAKE_INSTALL_PREFIX"] = {
- "PATH", expandedPreset->InstallDir
- };
- }
- if (!expandedPreset->ToolchainFile.empty() &&
- !this->State->GetInitializedCacheValue("CMAKE_TOOLCHAIN_FILE")) {
- this->UnprocessedPresetVariables["CMAKE_TOOLCHAIN_FILE"] = {
- "FILEPATH", expandedPreset->ToolchainFile
- };
- }
- if (!expandedPreset->ArchitectureStrategy ||
- expandedPreset->ArchitectureStrategy ==
- cmCMakePresetsGraph::ArchToolsetStrategy::Set) {
- if (!this->GeneratorPlatformSet &&
- !expandedPreset->Architecture.empty()) {
- this->SetGeneratorPlatform(expandedPreset->Architecture);
- }
- }
- if (!expandedPreset->ToolsetStrategy ||
- expandedPreset->ToolsetStrategy ==
- cmCMakePresetsGraph::ArchToolsetStrategy::Set) {
- if (!this->GeneratorToolsetSet && !expandedPreset->Toolset.empty()) {
- this->SetGeneratorToolset(expandedPreset->Toolset);
- }
- }
- this->SetWarningFromPreset("dev", expandedPreset->WarnDev,
- expandedPreset->ErrorDev);
- this->SetWarningFromPreset("deprecated", expandedPreset->WarnDeprecated,
- expandedPreset->ErrorDeprecated);
- if (expandedPreset->WarnUninitialized == true) {
- this->SetWarnUninitialized(true);
- }
- if (expandedPreset->WarnUnusedCli == false) {
- this->SetWarnUnusedCli(false);
- }
- if (expandedPreset->WarnSystemVars == true) {
- this->SetCheckSystemVars(true);
- }
- if (expandedPreset->DebugOutput == true) {
- this->SetDebugOutputOn(true);
- }
- if (expandedPreset->DebugTryCompile == true) {
- this->DebugTryCompileOn();
- }
- if (expandedPreset->DebugFind == true) {
- this->SetDebugFindOutput(true);
- }
- if (expandedPreset->TraceMode &&
- expandedPreset->TraceMode !=
- cmCMakePresetsGraph::TraceEnableMode::Disable) {
- this->SetTrace(true);
- if (expandedPreset->TraceMode ==
- cmCMakePresetsGraph::TraceEnableMode::Expand) {
- this->SetTraceExpand(true);
- }
- }
- if (expandedPreset->TraceFormat) {
- this->SetTrace(true);
- this->SetTraceFormat(*expandedPreset->TraceFormat);
- }
- if (!expandedPreset->TraceSource.empty()) {
- this->SetTrace(true);
- for (std::string const& filePaths : expandedPreset->TraceSource) {
- this->AddTraceSource(filePaths);
- }
- }
- if (!expandedPreset->TraceRedirect.empty()) {
- this->SetTrace(true);
- this->SetTraceFile(expandedPreset->TraceRedirect);
- }
- }
- #endif
- }
- namespace {
- using LevelsPair = std::pair<cm::string_view, Message::LogLevel>;
- using LevelsPairArray = std::array<LevelsPair, 7>;
- const LevelsPairArray& getStringToLogLevelPairs()
- {
- static const LevelsPairArray levels = {
- { { "error", Message::LogLevel::LOG_ERROR },
- { "warning", Message::LogLevel::LOG_WARNING },
- { "notice", Message::LogLevel::LOG_NOTICE },
- { "status", Message::LogLevel::LOG_STATUS },
- { "verbose", Message::LogLevel::LOG_VERBOSE },
- { "debug", Message::LogLevel::LOG_DEBUG },
- { "trace", Message::LogLevel::LOG_TRACE } }
- };
- return levels;
- }
- } // namespace
- Message::LogLevel cmake::StringToLogLevel(cm::string_view levelStr)
- {
- const LevelsPairArray& levels = getStringToLogLevelPairs();
- const auto levelStrLowCase =
- cmSystemTools::LowerCase(std::string{ levelStr });
- // NOLINTNEXTLINE(readability-qualified-auto)
- const auto it = std::find_if(levels.cbegin(), levels.cend(),
- [&levelStrLowCase](const LevelsPair& p) {
- return p.first == levelStrLowCase;
- });
- return (it != levels.cend()) ? it->second : Message::LogLevel::LOG_UNDEFINED;
- }
- std::string cmake::LogLevelToString(Message::LogLevel level)
- {
- const LevelsPairArray& levels = getStringToLogLevelPairs();
- // NOLINTNEXTLINE(readability-qualified-auto)
- const auto it =
- std::find_if(levels.cbegin(), levels.cend(),
- [&level](const LevelsPair& p) { return p.second == level; });
- const cm::string_view levelStrLowerCase =
- (it != levels.cend()) ? it->first : "undefined";
- std::string levelStrUpperCase =
- cmSystemTools::UpperCase(std::string{ levelStrLowerCase });
- return levelStrUpperCase;
- }
- cmake::TraceFormat cmake::StringToTraceFormat(const std::string& traceStr)
- {
- using TracePair = std::pair<std::string, TraceFormat>;
- static const std::vector<TracePair> levels = {
- { "human", TraceFormat::Human },
- { "json-v1", TraceFormat::JSONv1 },
- };
- const auto traceStrLowCase = cmSystemTools::LowerCase(traceStr);
- const auto it = std::find_if(levels.cbegin(), levels.cend(),
- [&traceStrLowCase](const TracePair& p) {
- return p.first == traceStrLowCase;
- });
- return (it != levels.cend()) ? it->second : TraceFormat::Undefined;
- }
- void cmake::SetTraceFile(const std::string& file)
- {
- this->TraceFile.close();
- this->TraceFile.open(file.c_str());
- if (!this->TraceFile) {
- cmSystemTools::Error(cmStrCat("Error opening trace file ", file, ": ",
- cmSystemTools::GetLastSystemError()));
- return;
- }
- std::cout << "Trace will be written to " << file << '\n';
- }
- void cmake::PrintTraceFormatVersion()
- {
- if (!this->GetTrace()) {
- return;
- }
- std::string msg;
- switch (this->GetTraceFormat()) {
- case TraceFormat::JSONv1: {
- #ifndef CMAKE_BOOTSTRAP
- Json::Value val;
- Json::Value version;
- Json::StreamWriterBuilder builder;
- builder["indentation"] = "";
- version["major"] = 1;
- version["minor"] = 2;
- val["version"] = version;
- msg = Json::writeString(builder, val);
- #endif
- break;
- }
- case TraceFormat::Human:
- msg = "";
- break;
- case TraceFormat::Undefined:
- msg = "INTERNAL ERROR: Trace format is Undefined";
- break;
- }
- if (msg.empty()) {
- return;
- }
- auto& f = this->GetTraceFile();
- if (f) {
- f << msg << '\n';
- } else {
- cmSystemTools::Message(msg);
- }
- }
- void cmake::SetTraceRedirect(cmake* other)
- {
- this->Trace = other->Trace;
- this->TraceExpand = other->TraceExpand;
- this->TraceFormatVar = other->TraceFormatVar;
- this->TraceOnlyThisSources = other->TraceOnlyThisSources;
- this->TraceRedirect = other;
- }
- bool cmake::SetDirectoriesFromFile(const std::string& arg)
- {
- // Check if the argument refers to a CMakeCache.txt or
- // CMakeLists.txt file.
- std::string listPath;
- std::string cachePath;
- bool is_source_dir = false;
- bool is_empty_directory = false;
- if (cmSystemTools::FileIsDirectory(arg)) {
- std::string path = cmSystemTools::CollapseFullPath(arg);
- cmSystemTools::ConvertToUnixSlashes(path);
- std::string cacheFile = cmStrCat(path, "/CMakeCache.txt");
- std::string listFile = cmStrCat(path, "/CMakeLists.txt");
- is_empty_directory = true;
- if (cmSystemTools::FileExists(cacheFile)) {
- cachePath = path;
- is_empty_directory = false;
- }
- if (cmSystemTools::FileExists(listFile)) {
- listPath = path;
- is_empty_directory = false;
- is_source_dir = true;
- }
- } else if (cmSystemTools::FileExists(arg)) {
- std::string fullPath = cmSystemTools::CollapseFullPath(arg);
- std::string name = cmSystemTools::GetFilenameName(fullPath);
- name = cmSystemTools::LowerCase(name);
- if (name == "cmakecache.txt"_s) {
- cachePath = cmSystemTools::GetFilenamePath(fullPath);
- } else if (name == "cmakelists.txt"_s) {
- listPath = cmSystemTools::GetFilenamePath(fullPath);
- }
- } else {
- // Specified file or directory does not exist. Try to set things
- // up to produce a meaningful error message.
- std::string fullPath = cmSystemTools::CollapseFullPath(arg);
- std::string name = cmSystemTools::GetFilenameName(fullPath);
- name = cmSystemTools::LowerCase(name);
- if (name == "cmakecache.txt"_s || name == "cmakelists.txt"_s) {
- listPath = cmSystemTools::GetFilenamePath(fullPath);
- } else {
- listPath = fullPath;
- }
- }
- // If there is a CMakeCache.txt file, use its settings.
- if (!cachePath.empty()) {
- if (this->LoadCache(cachePath)) {
- cmValue existingValue =
- this->State->GetCacheEntryValue("CMAKE_HOME_DIRECTORY");
- if (existingValue) {
- this->SetHomeOutputDirectory(cachePath);
- this->SetHomeDirectory(*existingValue);
- return true;
- }
- }
- }
- bool no_source_tree = this->GetHomeDirectory().empty();
- bool no_build_tree = this->GetHomeOutputDirectory().empty();
- // When invoked with a path that points to an existing CMakeCache
- // This function is called multiple times with the same path
- const bool passed_same_path = (listPath == this->GetHomeDirectory()) ||
- (listPath == this->GetHomeOutputDirectory());
- bool used_provided_path =
- (passed_same_path || is_source_dir || no_build_tree);
- // If there is a CMakeLists.txt file, use it as the source tree.
- if (!listPath.empty()) {
- // When invoked with a path that points to an existing CMakeCache
- // This function is called multiple times with the same path
- if (is_source_dir) {
- this->SetHomeDirectoryViaCommandLine(listPath);
- if (no_build_tree) {
- std::string cwd = cmSystemTools::GetCurrentWorkingDirectory();
- this->SetHomeOutputDirectory(cwd);
- }
- } else if (no_source_tree && no_build_tree) {
- this->SetHomeDirectory(listPath);
- std::string cwd = cmSystemTools::GetCurrentWorkingDirectory();
- this->SetHomeOutputDirectory(cwd);
- } else if (no_build_tree) {
- this->SetHomeOutputDirectory(listPath);
- }
- } else {
- if (no_source_tree) {
- // We didn't find a CMakeLists.txt and it wasn't specified
- // with -S. Assume it is the path to the source tree
- std::string full = cmSystemTools::CollapseFullPath(arg);
- this->SetHomeDirectory(full);
- }
- if (no_build_tree && !no_source_tree && is_empty_directory) {
- // passed `-S <path> <build_dir> when build_dir is an empty directory
- std::string full = cmSystemTools::CollapseFullPath(arg);
- this->SetHomeOutputDirectory(full);
- } else if (no_build_tree) {
- // We didn't find a CMakeCache.txt and it wasn't specified
- // with -B. Assume the current working directory as the build tree.
- std::string cwd = cmSystemTools::GetCurrentWorkingDirectory();
- this->SetHomeOutputDirectory(cwd);
- used_provided_path = false;
- }
- }
- return used_provided_path;
- }
- // at the end of this CMAKE_ROOT and CMAKE_COMMAND should be added to the
- // cache
- int cmake::AddCMakePaths()
- {
- // Save the value in the cache
- this->AddCacheEntry("CMAKE_COMMAND", cmSystemTools::GetCMakeCommand(),
- "Path to CMake executable.", cmStateEnums::INTERNAL);
- #ifndef CMAKE_BOOTSTRAP
- this->AddCacheEntry("CMAKE_CTEST_COMMAND", cmSystemTools::GetCTestCommand(),
- "Path to ctest program executable.",
- cmStateEnums::INTERNAL);
- this->AddCacheEntry("CMAKE_CPACK_COMMAND", cmSystemTools::GetCPackCommand(),
- "Path to cpack program executable.",
- cmStateEnums::INTERNAL);
- #endif
- if (!cmSystemTools::FileExists(
- (cmSystemTools::GetCMakeRoot() + "/Modules/CMake.cmake"))) {
- // couldn't find modules
- cmSystemTools::Error(
- "Could not find CMAKE_ROOT !!!\n"
- "CMake has most likely not been installed correctly.\n"
- "Modules directory not found in\n" +
- cmSystemTools::GetCMakeRoot());
- return 0;
- }
- this->AddCacheEntry("CMAKE_ROOT", cmSystemTools::GetCMakeRoot(),
- "Path to CMake installation.", cmStateEnums::INTERNAL);
- return 1;
- }
- void cmake::AddDefaultExtraGenerators()
- {
- #if !defined(CMAKE_BOOTSTRAP)
- this->ExtraGenerators.push_back(cmExtraCodeBlocksGenerator::GetFactory());
- this->ExtraGenerators.push_back(cmExtraCodeLiteGenerator::GetFactory());
- this->ExtraGenerators.push_back(cmExtraEclipseCDT4Generator::GetFactory());
- this->ExtraGenerators.push_back(cmExtraKateGenerator::GetFactory());
- this->ExtraGenerators.push_back(cmExtraSublimeTextGenerator::GetFactory());
- #endif
- }
- void cmake::GetRegisteredGenerators(std::vector<GeneratorInfo>& generators,
- bool includeNamesWithPlatform) const
- {
- for (const auto& gen : this->Generators) {
- std::vector<std::string> names = gen->GetGeneratorNames();
- if (includeNamesWithPlatform) {
- cm::append(names, gen->GetGeneratorNamesWithPlatform());
- }
- for (std::string const& name : names) {
- GeneratorInfo info;
- info.supportsToolset = gen->SupportsToolset();
- info.supportsPlatform = gen->SupportsPlatform();
- info.supportedPlatforms = gen->GetKnownPlatforms();
- info.defaultPlatform = gen->GetDefaultPlatformName();
- info.name = name;
- info.baseName = name;
- info.isAlias = false;
- generators.push_back(std::move(info));
- }
- }
- for (cmExternalMakefileProjectGeneratorFactory* eg : this->ExtraGenerators) {
- const std::vector<std::string> genList =
- eg->GetSupportedGlobalGenerators();
- for (std::string const& gen : genList) {
- GeneratorInfo info;
- info.name = cmExternalMakefileProjectGenerator::CreateFullGeneratorName(
- gen, eg->GetName());
- info.baseName = gen;
- info.extraName = eg->GetName();
- info.supportsPlatform = false;
- info.supportsToolset = false;
- info.isAlias = false;
- generators.push_back(std::move(info));
- }
- for (std::string const& a : eg->Aliases) {
- GeneratorInfo info;
- info.name = a;
- if (!genList.empty()) {
- info.baseName = genList.at(0);
- }
- info.extraName = eg->GetName();
- info.supportsPlatform = false;
- info.supportsToolset = false;
- info.isAlias = true;
- generators.push_back(std::move(info));
- }
- }
- }
- static std::pair<std::unique_ptr<cmExternalMakefileProjectGenerator>,
- std::string>
- createExtraGenerator(
- const std::vector<cmExternalMakefileProjectGeneratorFactory*>& in,
- const std::string& name)
- {
- for (cmExternalMakefileProjectGeneratorFactory* i : in) {
- const std::vector<std::string> generators =
- i->GetSupportedGlobalGenerators();
- if (i->GetName() == name) { // Match aliases
- return { i->CreateExternalMakefileProjectGenerator(), generators.at(0) };
- }
- for (std::string const& g : generators) {
- const std::string fullName =
- cmExternalMakefileProjectGenerator::CreateFullGeneratorName(
- g, i->GetName());
- if (fullName == name) {
- return { i->CreateExternalMakefileProjectGenerator(), g };
- }
- }
- }
- return { nullptr, name };
- }
- std::unique_ptr<cmGlobalGenerator> cmake::CreateGlobalGenerator(
- const std::string& gname, bool allowArch)
- {
- std::pair<std::unique_ptr<cmExternalMakefileProjectGenerator>, std::string>
- extra = createExtraGenerator(this->ExtraGenerators, gname);
- std::unique_ptr<cmExternalMakefileProjectGenerator>& extraGenerator =
- extra.first;
- const std::string& name = extra.second;
- std::unique_ptr<cmGlobalGenerator> generator;
- for (const auto& g : this->Generators) {
- generator = g->CreateGlobalGenerator(name, allowArch, this);
- if (generator) {
- break;
- }
- }
- if (generator) {
- generator->SetExternalMakefileProjectGenerator(std::move(extraGenerator));
- }
- return generator;
- }
- bool cmake::CreateAndSetGlobalGenerator(const std::string& name,
- bool allowArch)
- {
- auto gen = this->CreateGlobalGenerator(name, allowArch);
- if (!gen) {
- std::string kdevError;
- std::string vsError;
- if (name.find("KDevelop3", 0) != std::string::npos) {
- kdevError = "\nThe KDevelop3 generator is not supported anymore.";
- }
- if (!allowArch && cmHasLiteralPrefix(name, "Visual Studio ") &&
- name.length() >= cmStrLen("Visual Studio xx xxxx ")) {
- vsError = "\nUsing platforms in Visual Studio generator names is not "
- "supported in CMakePresets.json.";
- }
- cmSystemTools::Error(
- cmStrCat("Could not create named generator ", name, kdevError, vsError));
- this->PrintGeneratorList();
- return false;
- }
- this->SetGlobalGenerator(std::move(gen));
- return true;
- }
- #ifndef CMAKE_BOOTSTRAP
- void cmake::PrintPresetList(const cmCMakePresetsGraph& graph) const
- {
- std::vector<GeneratorInfo> generators;
- this->GetRegisteredGenerators(generators, false);
- auto filter =
- [&generators](const cmCMakePresetsGraph::ConfigurePreset& preset) -> bool {
- if (preset.Generator.empty()) {
- return true;
- }
- auto condition = [&preset](const GeneratorInfo& info) -> bool {
- return info.name == preset.Generator;
- };
- auto it = std::find_if(generators.begin(), generators.end(), condition);
- return it != generators.end();
- };
- graph.PrintConfigurePresetList(filter);
- }
- #endif
- void cmake::SetHomeDirectoryViaCommandLine(std::string const& path)
- {
- if (path.empty()) {
- return;
- }
- auto prev_path = this->GetHomeDirectory();
- if (prev_path != path && !prev_path.empty() &&
- this->GetWorkingMode() == NORMAL_MODE) {
- this->IssueMessage(MessageType::WARNING,
- cmStrCat("Ignoring extra path from command line:\n \"",
- prev_path, "\""));
- }
- this->SetHomeDirectory(path);
- }
- void cmake::SetHomeDirectory(const std::string& dir)
- {
- this->State->SetSourceDirectory(dir);
- if (this->CurrentSnapshot.IsValid()) {
- this->CurrentSnapshot.SetDefinition("CMAKE_SOURCE_DIR", dir);
- }
- if (this->State->GetProjectKind() == cmState::ProjectKind::Normal) {
- this->Messenger->SetTopSource(this->GetHomeDirectory());
- } else {
- this->Messenger->SetTopSource(cm::nullopt);
- }
- }
- std::string const& cmake::GetHomeDirectory() const
- {
- return this->State->GetSourceDirectory();
- }
- void cmake::SetHomeOutputDirectory(const std::string& dir)
- {
- this->State->SetBinaryDirectory(dir);
- if (this->CurrentSnapshot.IsValid()) {
- this->CurrentSnapshot.SetDefinition("CMAKE_BINARY_DIR", dir);
- }
- }
- std::string const& cmake::GetHomeOutputDirectory() const
- {
- return this->State->GetBinaryDirectory();
- }
- std::string cmake::FindCacheFile(const std::string& binaryDir)
- {
- std::string cachePath = binaryDir;
- cmSystemTools::ConvertToUnixSlashes(cachePath);
- std::string cacheFile = cmStrCat(cachePath, "/CMakeCache.txt");
- if (!cmSystemTools::FileExists(cacheFile)) {
- // search in parent directories for cache
- std::string cmakeFiles = cmStrCat(cachePath, "/CMakeFiles");
- if (cmSystemTools::FileExists(cmakeFiles)) {
- std::string cachePathFound =
- cmSystemTools::FileExistsInParentDirectories("CMakeCache.txt",
- cachePath, "/");
- if (!cachePathFound.empty()) {
- cachePath = cmSystemTools::GetFilenamePath(cachePathFound);
- }
- }
- }
- return cachePath;
- }
- void cmake::SetGlobalGenerator(std::unique_ptr<cmGlobalGenerator> gg)
- {
- if (!gg) {
- cmSystemTools::Error("Error SetGlobalGenerator called with null");
- return;
- }
- if (this->GlobalGenerator) {
- // restore the original environment variables CXX and CC
- std::string env = "CC=";
- if (!this->CCEnvironment.empty()) {
- env += this->CCEnvironment;
- cmSystemTools::PutEnv(env);
- } else {
- cmSystemTools::UnPutEnv(env);
- }
- env = "CXX=";
- if (!this->CXXEnvironment.empty()) {
- env += this->CXXEnvironment;
- cmSystemTools::PutEnv(env);
- } else {
- cmSystemTools::UnPutEnv(env);
- }
- }
- // set the new
- this->GlobalGenerator = std::move(gg);
- // set the global flag for unix style paths on cmSystemTools as soon as
- // the generator is set. This allows gmake to be used on windows.
- cmSystemTools::SetForceUnixPaths(this->GlobalGenerator->GetForceUnixPaths());
- // Save the environment variables CXX and CC
- if (!cmSystemTools::GetEnv("CXX", this->CXXEnvironment)) {
- this->CXXEnvironment.clear();
- }
- if (!cmSystemTools::GetEnv("CC", this->CCEnvironment)) {
- this->CCEnvironment.clear();
- }
- }
- int cmake::DoPreConfigureChecks()
- {
- // Make sure the Source directory contains a CMakeLists.txt file.
- std::string srcList = cmStrCat(this->GetHomeDirectory(), "/CMakeLists.txt");
- if (!cmSystemTools::FileExists(srcList)) {
- std::ostringstream err;
- if (cmSystemTools::FileIsDirectory(this->GetHomeDirectory())) {
- err << "The source directory \"" << this->GetHomeDirectory()
- << "\" does not appear to contain CMakeLists.txt.\n";
- } else if (cmSystemTools::FileExists(this->GetHomeDirectory())) {
- err << "The source directory \"" << this->GetHomeDirectory()
- << "\" is a file, not a directory.\n";
- } else {
- err << "The source directory \"" << this->GetHomeDirectory()
- << "\" does not exist.\n";
- }
- err << "Specify --help for usage, or press the help button on the CMake "
- "GUI.";
- cmSystemTools::Error(err.str());
- return -2;
- }
- // do a sanity check on some values
- if (this->State->GetInitializedCacheValue("CMAKE_HOME_DIRECTORY")) {
- std::string cacheStart =
- cmStrCat(*this->State->GetInitializedCacheValue("CMAKE_HOME_DIRECTORY"),
- "/CMakeLists.txt");
- if (!cmSystemTools::SameFile(cacheStart, srcList)) {
- std::string message =
- cmStrCat("The source \"", srcList, "\" does not match the source \"",
- cacheStart,
- "\" used to generate cache. Re-run cmake with a different "
- "source directory.");
- cmSystemTools::Error(message);
- return -2;
- }
- } else {
- return 0;
- }
- return 1;
- }
- struct SaveCacheEntry
- {
- std::string key;
- std::string value;
- std::string help;
- cmStateEnums::CacheEntryType type;
- };
- int cmake::HandleDeleteCacheVariables(const std::string& var)
- {
- cmList argsSplit{ var, cmList::EmptyElements::Yes };
- // erase the property to avoid infinite recursion
- this->State->SetGlobalProperty("__CMAKE_DELETE_CACHE_CHANGE_VARS_", "");
- if (this->GetIsInTryCompile()) {
- return 0;
- }
- std::vector<SaveCacheEntry> saved;
- std::ostringstream warning;
- warning
- << "You have changed variables that require your cache to be deleted.\n"
- "Configure will be re-run and you may have to reset some variables.\n"
- "The following variables have changed:\n";
- for (auto i = argsSplit.begin(); i != argsSplit.end(); ++i) {
- SaveCacheEntry save;
- save.key = *i;
- warning << *i << "= ";
- i++;
- if (i != argsSplit.end()) {
- save.value = *i;
- warning << *i << '\n';
- } else {
- warning << '\n';
- i -= 1;
- }
- cmValue existingValue = this->State->GetCacheEntryValue(save.key);
- if (existingValue) {
- save.type = this->State->GetCacheEntryType(save.key);
- if (cmValue help =
- this->State->GetCacheEntryProperty(save.key, "HELPSTRING")) {
- save.help = *help;
- }
- } else {
- save.type = cmStateEnums::CacheEntryType::UNINITIALIZED;
- }
- saved.push_back(std::move(save));
- }
- // remove the cache
- this->DeleteCache(this->GetHomeOutputDirectory());
- // load the empty cache
- this->LoadCache();
- // restore the changed compilers
- for (SaveCacheEntry const& i : saved) {
- this->AddCacheEntry(i.key, i.value, i.help, i.type);
- }
- cmSystemTools::Message(warning.str());
- // avoid reconfigure if there were errors
- if (!cmSystemTools::GetErrorOccurredFlag()) {
- // re-run configure
- return this->Configure();
- }
- return 0;
- }
- int cmake::Configure()
- {
- #if !defined(CMAKE_BOOTSTRAP)
- auto profilingRAII = this->CreateProfilingEntry("project", "configure");
- #endif
- DiagLevel diagLevel;
- if (this->DiagLevels.count("deprecated") == 1) {
- diagLevel = this->DiagLevels["deprecated"];
- if (diagLevel == DIAG_IGNORE) {
- this->SetSuppressDeprecatedWarnings(true);
- this->SetDeprecatedWarningsAsErrors(false);
- } else if (diagLevel == DIAG_WARN) {
- this->SetSuppressDeprecatedWarnings(false);
- this->SetDeprecatedWarningsAsErrors(false);
- } else if (diagLevel == DIAG_ERROR) {
- this->SetSuppressDeprecatedWarnings(false);
- this->SetDeprecatedWarningsAsErrors(true);
- }
- }
- if (this->DiagLevels.count("dev") == 1) {
- bool setDeprecatedVariables = false;
- cmValue cachedWarnDeprecated =
- this->State->GetCacheEntryValue("CMAKE_WARN_DEPRECATED");
- cmValue cachedErrorDeprecated =
- this->State->GetCacheEntryValue("CMAKE_ERROR_DEPRECATED");
- // don't overwrite deprecated warning setting from a previous invocation
- if (!cachedWarnDeprecated && !cachedErrorDeprecated) {
- setDeprecatedVariables = true;
- }
- diagLevel = this->DiagLevels["dev"];
- if (diagLevel == DIAG_IGNORE) {
- this->SetSuppressDevWarnings(true);
- this->SetDevWarningsAsErrors(false);
- if (setDeprecatedVariables) {
- this->SetSuppressDeprecatedWarnings(true);
- this->SetDeprecatedWarningsAsErrors(false);
- }
- } else if (diagLevel == DIAG_WARN) {
- this->SetSuppressDevWarnings(false);
- this->SetDevWarningsAsErrors(false);
- if (setDeprecatedVariables) {
- this->SetSuppressDeprecatedWarnings(false);
- this->SetDeprecatedWarningsAsErrors(false);
- }
- } else if (diagLevel == DIAG_ERROR) {
- this->SetSuppressDevWarnings(false);
- this->SetDevWarningsAsErrors(true);
- if (setDeprecatedVariables) {
- this->SetSuppressDeprecatedWarnings(false);
- this->SetDeprecatedWarningsAsErrors(true);
- }
- }
- }
- // Cache variables may have already been set by a previous invocation,
- // so we cannot rely on command line options alone. Always ensure our
- // messenger is in sync with the cache.
- cmValue value = this->State->GetCacheEntryValue("CMAKE_WARN_DEPRECATED");
- this->Messenger->SetSuppressDeprecatedWarnings(value && value.IsOff());
- value = this->State->GetCacheEntryValue("CMAKE_ERROR_DEPRECATED");
- this->Messenger->SetDeprecatedWarningsAsErrors(value.IsOn());
- value = this->State->GetCacheEntryValue("CMAKE_SUPPRESS_DEVELOPER_WARNINGS");
- this->Messenger->SetSuppressDevWarnings(value.IsOn());
- value = this->State->GetCacheEntryValue("CMAKE_SUPPRESS_DEVELOPER_ERRORS");
- this->Messenger->SetDevWarningsAsErrors(value && value.IsOff());
- int ret = this->ActualConfigure();
- cmValue delCacheVars =
- this->State->GetGlobalProperty("__CMAKE_DELETE_CACHE_CHANGE_VARS_");
- if (delCacheVars && !delCacheVars->empty()) {
- return this->HandleDeleteCacheVariables(*delCacheVars);
- }
- return ret;
- }
- int cmake::ActualConfigure()
- {
- // Construct right now our path conversion table before it's too late:
- this->UpdateConversionPathTable();
- this->CleanupCommandsAndMacros();
- cmSystemTools::RemoveADirectory(this->GetHomeOutputDirectory() +
- "/CMakeFiles/CMakeScratch");
- int res = this->DoPreConfigureChecks();
- if (res < 0) {
- return -2;
- }
- if (!res) {
- this->AddCacheEntry(
- "CMAKE_HOME_DIRECTORY", this->GetHomeDirectory(),
- "Source directory with the top level CMakeLists.txt file for this "
- "project",
- cmStateEnums::INTERNAL);
- }
- // We want to create the package redirects directory as early as possible,
- // but not before pre-configure checks have passed. This ensures we get
- // errors about inappropriate source/binary directories first.
- const auto redirectsDir =
- cmStrCat(this->GetHomeOutputDirectory(), "/CMakeFiles/pkgRedirects");
- cmSystemTools::RemoveADirectory(redirectsDir);
- if (!cmSystemTools::MakeDirectory(redirectsDir)) {
- cmSystemTools::Error(
- cmStrCat("Unable to (re)create the private pkgRedirects directory:\n ",
- redirectsDir,
- "\n"
- "This may be caused by not having read/write access to "
- "the build directory.\n"
- "Try specifying a location with read/write access like:\n"
- " cmake -B build\n"
- "If using a CMake presets file, ensure that preset parameter\n"
- "'binaryDir' expands to a writable directory.\n"));
- return -1;
- }
- this->AddCacheEntry("CMAKE_FIND_PACKAGE_REDIRECTS_DIR", redirectsDir,
- "Value Computed by CMake.", cmStateEnums::STATIC);
- // no generator specified on the command line
- if (!this->GlobalGenerator) {
- cmValue genName = this->State->GetInitializedCacheValue("CMAKE_GENERATOR");
- cmValue extraGenName =
- this->State->GetInitializedCacheValue("CMAKE_EXTRA_GENERATOR");
- if (genName) {
- std::string fullName =
- cmExternalMakefileProjectGenerator::CreateFullGeneratorName(
- *genName, extraGenName ? *extraGenName : "");
- this->GlobalGenerator = this->CreateGlobalGenerator(fullName);
- }
- if (this->GlobalGenerator) {
- // set the global flag for unix style paths on cmSystemTools as
- // soon as the generator is set. This allows gmake to be used
- // on windows.
- cmSystemTools::SetForceUnixPaths(
- this->GlobalGenerator->GetForceUnixPaths());
- } else {
- this->CreateDefaultGlobalGenerator();
- }
- if (!this->GlobalGenerator) {
- cmSystemTools::Error("Could not create generator");
- return -1;
- }
- }
- cmValue genName = this->State->GetInitializedCacheValue("CMAKE_GENERATOR");
- if (genName) {
- if (!this->GlobalGenerator->MatchesGeneratorName(*genName)) {
- std::string message = cmStrCat(
- "Error: generator : ", this->GlobalGenerator->GetName(), '\n',
- "Does not match the generator used previously: ", *genName, '\n',
- "Either remove the CMakeCache.txt file and CMakeFiles "
- "directory or choose a different binary directory.");
- cmSystemTools::Error(message);
- return -2;
- }
- }
- if (!genName) {
- this->AddCacheEntry("CMAKE_GENERATOR", this->GlobalGenerator->GetName(),
- "Name of generator.", cmStateEnums::INTERNAL);
- this->AddCacheEntry(
- "CMAKE_EXTRA_GENERATOR", this->GlobalGenerator->GetExtraGeneratorName(),
- "Name of external makefile project generator.", cmStateEnums::INTERNAL);
- if (!this->State->GetInitializedCacheValue("CMAKE_TOOLCHAIN_FILE")) {
- std::string envToolchain;
- if (cmSystemTools::GetEnv("CMAKE_TOOLCHAIN_FILE", envToolchain) &&
- !envToolchain.empty()) {
- this->AddCacheEntry("CMAKE_TOOLCHAIN_FILE", envToolchain,
- "The CMake toolchain file",
- cmStateEnums::FILEPATH);
- }
- }
- }
- if (cmValue instance =
- this->State->GetInitializedCacheValue("CMAKE_GENERATOR_INSTANCE")) {
- if (this->GeneratorInstanceSet && this->GeneratorInstance != *instance) {
- std::string message = cmStrCat(
- "Error: generator instance: ", this->GeneratorInstance, '\n',
- "Does not match the instance used previously: ", *instance, '\n',
- "Either remove the CMakeCache.txt file and CMakeFiles "
- "directory or choose a different binary directory.");
- cmSystemTools::Error(message);
- return -2;
- }
- } else {
- this->AddCacheEntry("CMAKE_GENERATOR_INSTANCE", this->GeneratorInstance,
- "Generator instance identifier.",
- cmStateEnums::INTERNAL);
- }
- if (cmValue platformName =
- this->State->GetInitializedCacheValue("CMAKE_GENERATOR_PLATFORM")) {
- if (this->GeneratorPlatformSet &&
- this->GeneratorPlatform != *platformName) {
- std::string message = cmStrCat(
- "Error: generator platform: ", this->GeneratorPlatform, '\n',
- "Does not match the platform used previously: ", *platformName, '\n',
- "Either remove the CMakeCache.txt file and CMakeFiles "
- "directory or choose a different binary directory.");
- cmSystemTools::Error(message);
- return -2;
- }
- } else {
- this->AddCacheEntry("CMAKE_GENERATOR_PLATFORM", this->GeneratorPlatform,
- "Name of generator platform.", cmStateEnums::INTERNAL);
- }
- if (cmValue tsName =
- this->State->GetInitializedCacheValue("CMAKE_GENERATOR_TOOLSET")) {
- if (this->GeneratorToolsetSet && this->GeneratorToolset != *tsName) {
- std::string message =
- cmStrCat("Error: generator toolset: ", this->GeneratorToolset, '\n',
- "Does not match the toolset used previously: ", *tsName, '\n',
- "Either remove the CMakeCache.txt file and CMakeFiles "
- "directory or choose a different binary directory.");
- cmSystemTools::Error(message);
- return -2;
- }
- } else {
- this->AddCacheEntry("CMAKE_GENERATOR_TOOLSET", this->GeneratorToolset,
- "Name of generator toolset.", cmStateEnums::INTERNAL);
- }
- if (!this->State->GetInitializedCacheValue("CMAKE_TEST_LAUNCHER")) {
- cm::optional<std::string> testLauncher =
- cmSystemTools::GetEnvVar("CMAKE_TEST_LAUNCHER");
- if (testLauncher && !testLauncher->empty()) {
- std::string message = "Test launcher to run tests executable.";
- this->AddCacheEntry("CMAKE_TEST_LAUNCHER", *testLauncher, message,
- cmStateEnums::STRING);
- }
- }
- if (!this->State->GetInitializedCacheValue(
- "CMAKE_CROSSCOMPILING_EMULATOR")) {
- cm::optional<std::string> emulator =
- cmSystemTools::GetEnvVar("CMAKE_CROSSCOMPILING_EMULATOR");
- if (emulator && !emulator->empty()) {
- std::string message =
- "Emulator to run executables and tests when cross compiling.";
- this->AddCacheEntry("CMAKE_CROSSCOMPILING_EMULATOR", *emulator, message,
- cmStateEnums::STRING);
- }
- }
- // reset any system configuration information, except for when we are
- // InTryCompile. With TryCompile the system info is taken from the parent's
- // info to save time
- if (!this->GetIsInTryCompile()) {
- this->GlobalGenerator->ClearEnabledLanguages();
- }
- #if !defined(CMAKE_BOOTSTRAP)
- this->FileAPI = cm::make_unique<cmFileAPI>(this);
- this->FileAPI->ReadQueries();
- if (!this->GetIsInTryCompile()) {
- this->TruncateOutputLog("CMakeConfigureLog.yaml");
- this->ConfigureLog = cm::make_unique<cmConfigureLog>(
- cmStrCat(this->GetHomeOutputDirectory(), "/CMakeFiles"_s),
- this->FileAPI->GetConfigureLogVersions());
- }
- #endif
- // actually do the configure
- auto startTime = std::chrono::steady_clock::now();
- this->GlobalGenerator->Configure();
- auto endTime = std::chrono::steady_clock::now();
- if (this->GetWorkingMode() == cmake::NORMAL_MODE) {
- std::ostringstream msg;
- if (cmSystemTools::GetErrorOccurredFlag()) {
- msg << "Configuring incomplete, errors occurred!";
- } else {
- auto ms = std::chrono::duration_cast<std::chrono::milliseconds>(
- endTime - startTime);
- msg << "Configuring done (" << std::fixed << std::setprecision(1)
- << ms.count() / 1000.0L << "s)";
- }
- this->UpdateProgress(msg.str(), -1);
- }
- #if !defined(CMAKE_BOOTSTRAP)
- this->ConfigureLog.reset();
- #endif
- // Before saving the cache
- // if the project did not define one of the entries below, add them now
- // so users can edit the values in the cache:
- // We used to always present LIBRARY_OUTPUT_PATH and
- // EXECUTABLE_OUTPUT_PATH. They are now documented as old-style and
- // should no longer be used. Therefore we present them only if the
- // project requires compatibility with CMake 2.4. We detect this
- // here by looking for the old CMAKE_BACKWARDS_COMPATIBILITY
- // variable created when CMP0001 is not set to NEW.
- if (this->State->GetInitializedCacheValue("CMAKE_BACKWARDS_COMPATIBILITY")) {
- if (!this->State->GetInitializedCacheValue("LIBRARY_OUTPUT_PATH")) {
- this->AddCacheEntry(
- "LIBRARY_OUTPUT_PATH", "",
- "Single output directory for building all libraries.",
- cmStateEnums::PATH);
- }
- if (!this->State->GetInitializedCacheValue("EXECUTABLE_OUTPUT_PATH")) {
- this->AddCacheEntry(
- "EXECUTABLE_OUTPUT_PATH", "",
- "Single output directory for building all executables.",
- cmStateEnums::PATH);
- }
- }
- const auto& mf = this->GlobalGenerator->GetMakefiles()[0];
- if (mf->IsOn("CTEST_USE_LAUNCHERS") &&
- !this->State->GetGlobalProperty("RULE_LAUNCH_COMPILE")) {
- cmSystemTools::Error(
- "CTEST_USE_LAUNCHERS is enabled, but the "
- "RULE_LAUNCH_COMPILE global property is not defined.\n"
- "Did you forget to include(CTest) in the toplevel "
- "CMakeLists.txt ?");
- }
- this->State->SaveVerificationScript(this->GetHomeOutputDirectory(),
- this->Messenger.get());
- this->SaveCache(this->GetHomeOutputDirectory());
- if (cmSystemTools::GetErrorOccurredFlag()) {
- return -1;
- }
- return 0;
- }
- std::unique_ptr<cmGlobalGenerator> cmake::EvaluateDefaultGlobalGenerator()
- {
- if (!this->EnvironmentGenerator.empty()) {
- auto gen = this->CreateGlobalGenerator(this->EnvironmentGenerator);
- if (!gen) {
- cmSystemTools::Error("CMAKE_GENERATOR was set but the specified "
- "generator doesn't exist. Using CMake default.");
- } else {
- return gen;
- }
- }
- #if defined(_WIN32) && !defined(__CYGWIN__) && !defined(CMAKE_BOOT_MINGW)
- std::string found;
- // Try to find the newest VS installed on the computer and
- // use that as a default if -G is not specified
- const std::string vsregBase = "HKEY_LOCAL_MACHINE\\SOFTWARE\\Microsoft\\";
- static const char* const vsVariants[] = {
- /* clang-format needs this comment to break after the opening brace */
- "VisualStudio\\", "VCExpress\\", "WDExpress\\"
- };
- struct VSVersionedGenerator
- {
- const char* MSVersion;
- const char* GeneratorName;
- };
- static VSVersionedGenerator const vsGenerators[] = {
- { "14.0", "Visual Studio 14 2015" }, //
- { "12.0", "Visual Studio 12 2013" }, //
- };
- static const char* const vsEntries[] = {
- "\\Setup\\VC;ProductDir", //
- ";InstallDir" //
- };
- if (cmVSSetupAPIHelper(17).IsVSInstalled()) {
- found = "Visual Studio 17 2022";
- } else if (cmVSSetupAPIHelper(16).IsVSInstalled()) {
- found = "Visual Studio 16 2019";
- } else if (cmVSSetupAPIHelper(15).IsVSInstalled()) {
- found = "Visual Studio 15 2017";
- } else {
- for (VSVersionedGenerator const* g = cm::cbegin(vsGenerators);
- found.empty() && g != cm::cend(vsGenerators); ++g) {
- for (const char* const* v = cm::cbegin(vsVariants);
- found.empty() && v != cm::cend(vsVariants); ++v) {
- for (const char* const* e = cm::cbegin(vsEntries);
- found.empty() && e != cm::cend(vsEntries); ++e) {
- std::string const reg = vsregBase + *v + g->MSVersion + *e;
- std::string dir;
- if (cmSystemTools::ReadRegistryValue(reg, dir,
- cmSystemTools::KeyWOW64_32) &&
- cmSystemTools::PathExists(dir)) {
- found = g->GeneratorName;
- }
- }
- }
- }
- }
- auto gen = this->CreateGlobalGenerator(found);
- if (!gen) {
- gen = cm::make_unique<cmGlobalNMakeMakefileGenerator>(this);
- }
- return std::unique_ptr<cmGlobalGenerator>(std::move(gen));
- #elif defined(CMAKE_BOOTSTRAP_NINJA)
- return std::unique_ptr<cmGlobalGenerator>(
- cm::make_unique<cmGlobalNinjaGenerator>(this));
- #else
- return std::unique_ptr<cmGlobalGenerator>(
- cm::make_unique<cmGlobalUnixMakefileGenerator3>(this));
- #endif
- }
- void cmake::CreateDefaultGlobalGenerator()
- {
- auto gen = this->EvaluateDefaultGlobalGenerator();
- #if defined(_WIN32) && !defined(__CYGWIN__) && !defined(CMAKE_BOOT_MINGW)
- // This print could be unified for all platforms
- std::cout << "-- Building for: " << gen->GetName() << '\n';
- #endif
- this->SetGlobalGenerator(std::move(gen));
- }
- void cmake::PreLoadCMakeFiles()
- {
- std::vector<std::string> args;
- std::string pre_load = this->GetHomeDirectory();
- if (!pre_load.empty()) {
- pre_load += "/PreLoad.cmake";
- if (cmSystemTools::FileExists(pre_load)) {
- this->ReadListFile(args, pre_load);
- }
- }
- pre_load = this->GetHomeOutputDirectory();
- if (!pre_load.empty()) {
- pre_load += "/PreLoad.cmake";
- if (cmSystemTools::FileExists(pre_load)) {
- this->ReadListFile(args, pre_load);
- }
- }
- }
- #ifdef CMake_ENABLE_DEBUGGER
- bool cmake::StartDebuggerIfEnabled()
- {
- if (!this->GetDebuggerOn()) {
- return true;
- }
- if (DebugAdapter == nullptr) {
- if (this->GetDebuggerPipe().empty()) {
- std::cerr
- << "Error: --debugger-pipe must be set when debugging is enabled.\n";
- return false;
- }
- try {
- DebugAdapter = std::make_shared<cmDebugger::cmDebuggerAdapter>(
- std::make_shared<cmDebugger::cmDebuggerPipeConnection>(
- this->GetDebuggerPipe()),
- this->GetDebuggerDapLogFile());
- } catch (const std::runtime_error& error) {
- std::cerr << "Error: Failed to create debugger adapter.\n";
- std::cerr << error.what() << "\n";
- return false;
- }
- Messenger->SetDebuggerAdapter(DebugAdapter);
- }
- return true;
- }
- void cmake::StopDebuggerIfNeeded(int exitCode)
- {
- if (!this->GetDebuggerOn()) {
- return;
- }
- // The debug adapter may have failed to start (e.g. invalid pipe path).
- if (DebugAdapter != nullptr) {
- DebugAdapter->ReportExitCode(exitCode);
- DebugAdapter.reset();
- }
- }
- #endif
- // handle a command line invocation
- int cmake::Run(const std::vector<std::string>& args, bool noconfigure)
- {
- // Process the arguments
- this->SetArgs(args);
- if (cmSystemTools::GetErrorOccurredFlag()) {
- return -1;
- }
- if (this->GetWorkingMode() == HELP_MODE) {
- return 0;
- }
- // Log the trace format version to the desired output
- if (this->GetTrace()) {
- this->PrintTraceFormatVersion();
- }
- // If we are given a stamp list file check if it is really out of date.
- if (!this->CheckStampList.empty() &&
- cmakeCheckStampList(this->CheckStampList)) {
- return 0;
- }
- // If we are given a stamp file check if it is really out of date.
- if (!this->CheckStampFile.empty() &&
- cmakeCheckStampFile(this->CheckStampFile)) {
- return 0;
- }
- if (this->GetWorkingMode() == NORMAL_MODE) {
- if (this->FreshCache) {
- this->DeleteCache(this->GetHomeOutputDirectory());
- }
- // load the cache
- if (this->LoadCache() < 0) {
- cmSystemTools::Error("Error executing cmake::LoadCache(). Aborting.\n");
- return -1;
- }
- } else {
- if (this->FreshCache) {
- cmSystemTools::Error("--fresh allowed only when configuring a project");
- return -1;
- }
- this->AddCMakePaths();
- }
- #ifndef CMAKE_BOOTSTRAP
- this->ProcessPresetVariables();
- this->ProcessPresetEnvironment();
- #endif
- // Add any cache args
- if (!this->SetCacheArgs(args)) {
- cmSystemTools::Error("Run 'cmake --help' for all supported options.");
- return -1;
- }
- #ifndef CMAKE_BOOTSTRAP
- this->PrintPresetVariables();
- this->PrintPresetEnvironment();
- #endif
- // In script mode we terminate after running the script.
- if (this->GetWorkingMode() != NORMAL_MODE) {
- if (cmSystemTools::GetErrorOccurredFlag()) {
- return -1;
- }
- return this->HasScriptModeExitCode() ? this->GetScriptModeExitCode() : 0;
- }
- // If MAKEFLAGS are given in the environment, remove the environment
- // variable. This will prevent try-compile from succeeding when it
- // should fail (if "-i" is an option). We cannot simply test
- // whether "-i" is given and remove it because some make programs
- // encode the MAKEFLAGS variable in a strange way.
- if (cmSystemTools::HasEnv("MAKEFLAGS")) {
- cmSystemTools::PutEnv("MAKEFLAGS=");
- }
- this->PreLoadCMakeFiles();
- if (noconfigure) {
- return 0;
- }
- // now run the global generate
- // Check the state of the build system to see if we need to regenerate.
- if (!this->CheckBuildSystem()) {
- return 0;
- }
- #ifdef CMake_ENABLE_DEBUGGER
- if (!this->StartDebuggerIfEnabled()) {
- return -1;
- }
- #endif
- int ret = this->Configure();
- if (ret) {
- #if defined(CMAKE_HAVE_VS_GENERATORS)
- if (!this->VSSolutionFile.empty() && this->GlobalGenerator) {
- // CMake is running to regenerate a Visual Studio build tree
- // during a build from the VS IDE. The build files cannot be
- // regenerated, so we should stop the build.
- cmSystemTools::Message("CMake Configure step failed. "
- "Build files cannot be regenerated correctly. "
- "Attempting to stop IDE build.");
- cmGlobalVisualStudioGenerator& gg =
- cm::static_reference_cast<cmGlobalVisualStudioGenerator>(
- this->GlobalGenerator);
- gg.CallVisualStudioMacro(cmGlobalVisualStudioGenerator::MacroStop,
- this->VSSolutionFile);
- }
- #endif
- return ret;
- }
- ret = this->Generate();
- if (ret) {
- cmSystemTools::Message("CMake Generate step failed. "
- "Build files cannot be regenerated correctly.");
- return ret;
- }
- std::string message = cmStrCat("Build files have been written to: ",
- this->GetHomeOutputDirectory());
- this->UpdateProgress(message, -1);
- return ret;
- }
- int cmake::Generate()
- {
- if (!this->GlobalGenerator) {
- return -1;
- }
- #if !defined(CMAKE_BOOTSTRAP)
- auto profilingRAII = this->CreateProfilingEntry("project", "generate");
- #endif
- auto startTime = std::chrono::steady_clock::now();
- if (!this->GlobalGenerator->Compute()) {
- return -1;
- }
- this->GlobalGenerator->Generate();
- auto endTime = std::chrono::steady_clock::now();
- {
- auto ms = std::chrono::duration_cast<std::chrono::milliseconds>(endTime -
- startTime);
- std::ostringstream msg;
- msg << "Generating done (" << std::fixed << std::setprecision(1)
- << ms.count() / 1000.0L << "s)";
- this->UpdateProgress(msg.str(), -1);
- }
- if (!this->GraphVizFile.empty()) {
- std::cout << "Generate graphviz: " << this->GraphVizFile << '\n';
- this->GenerateGraphViz(this->GraphVizFile);
- }
- if (this->WarnUnusedCli) {
- this->RunCheckForUnusedVariables();
- }
- if (cmSystemTools::GetErrorOccurredFlag()) {
- return -1;
- }
- // Save the cache again after a successful Generate so that any internal
- // variables created during Generate are saved. (Specifically target GUIDs
- // for the Visual Studio and Xcode generators.)
- this->SaveCache(this->GetHomeOutputDirectory());
- #if !defined(CMAKE_BOOTSTRAP)
- this->GetGlobalGenerator()->WriteInstallJson();
- this->FileAPI->WriteReplies();
- #endif
- return 0;
- }
- void cmake::AddCacheEntry(const std::string& key, cmValue value,
- cmValue helpString, int type)
- {
- this->State->AddCacheEntry(key, value, helpString,
- static_cast<cmStateEnums::CacheEntryType>(type));
- this->UnwatchUnusedCli(key);
- if (key == "CMAKE_WARN_DEPRECATED"_s) {
- this->Messenger->SetSuppressDeprecatedWarnings(value && value.IsOff());
- } else if (key == "CMAKE_ERROR_DEPRECATED"_s) {
- this->Messenger->SetDeprecatedWarningsAsErrors(value.IsOn());
- } else if (key == "CMAKE_SUPPRESS_DEVELOPER_WARNINGS"_s) {
- this->Messenger->SetSuppressDevWarnings(value.IsOn());
- } else if (key == "CMAKE_SUPPRESS_DEVELOPER_ERRORS"_s) {
- this->Messenger->SetDevWarningsAsErrors(value && value.IsOff());
- }
- }
- bool cmake::DoWriteGlobVerifyTarget() const
- {
- return this->State->DoWriteGlobVerifyTarget();
- }
- std::string const& cmake::GetGlobVerifyScript() const
- {
- return this->State->GetGlobVerifyScript();
- }
- std::string const& cmake::GetGlobVerifyStamp() const
- {
- return this->State->GetGlobVerifyStamp();
- }
- void cmake::AddGlobCacheEntry(const cmGlobCacheEntry& entry,
- const std::string& variable,
- cmListFileBacktrace const& backtrace)
- {
- this->State->AddGlobCacheEntry(entry, variable, backtrace,
- this->Messenger.get());
- }
- std::vector<cmGlobCacheEntry> cmake::GetGlobCacheEntries() const
- {
- return this->State->GetGlobCacheEntries();
- }
- std::vector<std::string> cmake::GetAllExtensions() const
- {
- std::vector<std::string> allExt = this->CLikeSourceFileExtensions.ordered;
- allExt.insert(allExt.end(), this->HeaderFileExtensions.ordered.begin(),
- this->HeaderFileExtensions.ordered.end());
- // cuda extensions are also in SourceFileExtensions so we ignore it here
- allExt.insert(allExt.end(), this->FortranFileExtensions.ordered.begin(),
- this->FortranFileExtensions.ordered.end());
- allExt.insert(allExt.end(), this->HipFileExtensions.ordered.begin(),
- this->HipFileExtensions.ordered.end());
- allExt.insert(allExt.end(), this->ISPCFileExtensions.ordered.begin(),
- this->ISPCFileExtensions.ordered.end());
- return allExt;
- }
- std::string cmake::StripExtension(const std::string& file) const
- {
- auto dotpos = file.rfind('.');
- if (dotpos != std::string::npos) {
- #if defined(_WIN32) || defined(__APPLE__)
- auto ext = cmSystemTools::LowerCase(file.substr(dotpos + 1));
- #else
- auto ext = cm::string_view(file).substr(dotpos + 1);
- #endif
- if (this->IsAKnownExtension(ext)) {
- return file.substr(0, dotpos);
- }
- }
- return file;
- }
- cmValue cmake::GetCacheDefinition(const std::string& name) const
- {
- return this->State->GetInitializedCacheValue(name);
- }
- void cmake::AddScriptingCommands() const
- {
- GetScriptingCommands(this->GetState());
- }
- void cmake::AddProjectCommands() const
- {
- GetProjectCommands(this->GetState());
- }
- void cmake::AddDefaultGenerators()
- {
- #if defined(_WIN32) && !defined(__CYGWIN__)
- # if !defined(CMAKE_BOOT_MINGW)
- this->Generators.push_back(
- cmGlobalVisualStudioVersionedGenerator::NewFactory17());
- this->Generators.push_back(
- cmGlobalVisualStudioVersionedGenerator::NewFactory16());
- this->Generators.push_back(
- cmGlobalVisualStudioVersionedGenerator::NewFactory15());
- this->Generators.push_back(cmGlobalVisualStudio14Generator::NewFactory());
- this->Generators.push_back(cmGlobalVisualStudio12Generator::NewFactory());
- this->Generators.push_back(cmGlobalBorlandMakefileGenerator::NewFactory());
- this->Generators.push_back(cmGlobalNMakeMakefileGenerator::NewFactory());
- this->Generators.push_back(cmGlobalJOMMakefileGenerator::NewFactory());
- # endif
- this->Generators.push_back(cmGlobalMSYSMakefileGenerator::NewFactory());
- this->Generators.push_back(cmGlobalMinGWMakefileGenerator::NewFactory());
- #endif
- #if !defined(CMAKE_BOOTSTRAP)
- # if (defined(__linux__) && !defined(__ANDROID__)) || defined(_WIN32)
- this->Generators.push_back(cmGlobalGhsMultiGenerator::NewFactory());
- # endif
- this->Generators.push_back(cmGlobalUnixMakefileGenerator3::NewFactory());
- this->Generators.push_back(cmGlobalNinjaGenerator::NewFactory());
- this->Generators.push_back(cmGlobalNinjaMultiGenerator::NewFactory());
- #elif defined(CMAKE_BOOTSTRAP_NINJA)
- this->Generators.push_back(cmGlobalNinjaGenerator::NewFactory());
- #elif defined(CMAKE_BOOTSTRAP_MAKEFILES)
- this->Generators.push_back(cmGlobalUnixMakefileGenerator3::NewFactory());
- #endif
- #if defined(CMAKE_USE_WMAKE)
- this->Generators.push_back(cmGlobalWatcomWMakeGenerator::NewFactory());
- #endif
- #ifdef CMAKE_USE_XCODE
- this->Generators.push_back(cmGlobalXCodeGenerator::NewFactory());
- #endif
- }
- bool cmake::ParseCacheEntry(const std::string& entry, std::string& var,
- std::string& value,
- cmStateEnums::CacheEntryType& type)
- {
- return cmState::ParseCacheEntry(entry, var, value, type);
- }
- int cmake::LoadCache()
- {
- // could we not read the cache
- if (!this->LoadCache(this->GetHomeOutputDirectory())) {
- // if it does exist, but isn't readable then warn the user
- std::string cacheFile =
- cmStrCat(this->GetHomeOutputDirectory(), "/CMakeCache.txt");
- if (cmSystemTools::FileExists(cacheFile)) {
- cmSystemTools::Error(
- "There is a CMakeCache.txt file for the current binary tree but "
- "cmake does not have permission to read it. Please check the "
- "permissions of the directory you are trying to run CMake on.");
- return -1;
- }
- }
- // setup CMAKE_ROOT and CMAKE_COMMAND
- if (!this->AddCMakePaths()) {
- return -3;
- }
- return 0;
- }
- bool cmake::LoadCache(const std::string& path)
- {
- std::set<std::string> emptySet;
- return this->LoadCache(path, true, emptySet, emptySet);
- }
- bool cmake::LoadCache(const std::string& path, bool internal,
- std::set<std::string>& excludes,
- std::set<std::string>& includes)
- {
- bool result = this->State->LoadCache(path, internal, excludes, includes);
- static const auto entries = { "CMAKE_CACHE_MAJOR_VERSION",
- "CMAKE_CACHE_MINOR_VERSION" };
- for (auto const& entry : entries) {
- this->UnwatchUnusedCli(entry);
- }
- return result;
- }
- bool cmake::SaveCache(const std::string& path)
- {
- bool result = this->State->SaveCache(path, this->GetMessenger());
- static const auto entries = { "CMAKE_CACHE_MAJOR_VERSION",
- "CMAKE_CACHE_MINOR_VERSION",
- "CMAKE_CACHE_PATCH_VERSION",
- "CMAKE_CACHEFILE_DIR" };
- for (auto const& entry : entries) {
- this->UnwatchUnusedCli(entry);
- }
- return result;
- }
- bool cmake::DeleteCache(const std::string& path)
- {
- return this->State->DeleteCache(path);
- }
- void cmake::SetProgressCallback(ProgressCallbackType f)
- {
- this->ProgressCallback = std::move(f);
- }
- void cmake::UpdateProgress(const std::string& msg, float prog)
- {
- if (this->ProgressCallback && !this->GetIsInTryCompile()) {
- this->ProgressCallback(msg, prog);
- }
- }
- bool cmake::GetIsInTryCompile() const
- {
- return this->State->GetProjectKind() == cmState::ProjectKind::TryCompile;
- }
- void cmake::AppendGlobalGeneratorsDocumentation(
- std::vector<cmDocumentationEntry>& v)
- {
- const auto defaultGenerator = this->EvaluateDefaultGlobalGenerator();
- const auto defaultName = defaultGenerator->GetName();
- auto foundDefaultOne = false;
- for (const auto& g : this->Generators) {
- v.emplace_back(g->GetDocumentation());
- if (!foundDefaultOne && cmHasPrefix(v.back().Name, defaultName)) {
- v.back().CustomNamePrefix = '*';
- foundDefaultOne = true;
- }
- }
- }
- void cmake::AppendExtraGeneratorsDocumentation(
- std::vector<cmDocumentationEntry>& v)
- {
- for (cmExternalMakefileProjectGeneratorFactory* eg : this->ExtraGenerators) {
- const std::string doc = eg->GetDocumentation();
- const std::string name = eg->GetName();
- // Aliases:
- for (std::string const& a : eg->Aliases) {
- v.emplace_back(cmDocumentationEntry{ a, doc });
- }
- // Full names:
- for (std::string const& g : eg->GetSupportedGlobalGenerators()) {
- v.emplace_back(cmDocumentationEntry{
- cmExternalMakefileProjectGenerator::CreateFullGeneratorName(g, name),
- doc });
- }
- }
- }
- std::vector<cmDocumentationEntry> cmake::GetGeneratorsDocumentation()
- {
- std::vector<cmDocumentationEntry> v;
- this->AppendGlobalGeneratorsDocumentation(v);
- this->AppendExtraGeneratorsDocumentation(v);
- return v;
- }
- void cmake::PrintGeneratorList()
- {
- #ifndef CMAKE_BOOTSTRAP
- cmDocumentation doc;
- auto generators = this->GetGeneratorsDocumentation();
- doc.AppendSection("Generators", generators);
- std::cerr << '\n';
- doc.PrintDocumentation(cmDocumentation::ListGenerators, std::cerr);
- #endif
- }
- void cmake::UpdateConversionPathTable()
- {
- // Update the path conversion table with any specified file:
- cmValue tablepath =
- this->State->GetInitializedCacheValue("CMAKE_PATH_TRANSLATION_FILE");
- if (tablepath) {
- cmsys::ifstream table(tablepath->c_str());
- if (!table) {
- cmSystemTools::Error("CMAKE_PATH_TRANSLATION_FILE set to " + *tablepath +
- ". CMake can not open file.");
- cmSystemTools::ReportLastSystemError("CMake can not open file.");
- } else {
- std::string a;
- std::string b;
- while (!table.eof()) {
- // two entries per line
- table >> a;
- table >> b;
- cmSystemTools::AddTranslationPath(a, b);
- }
- }
- }
- }
- int cmake::CheckBuildSystem()
- {
- // We do not need to rerun CMake. Check dependency integrity.
- const bool verbose = isCMakeVerbose();
- // This method will check the integrity of the build system if the
- // option was given on the command line. It reads the given file to
- // determine whether CMake should rerun.
- // If no file is provided for the check, we have to rerun.
- if (this->CheckBuildSystemArgument.empty()) {
- if (verbose) {
- cmSystemTools::Stdout("Re-run cmake no build system arguments\n");
- }
- return 1;
- }
- // If the file provided does not exist, we have to rerun.
- if (!cmSystemTools::FileExists(this->CheckBuildSystemArgument)) {
- if (verbose) {
- std::ostringstream msg;
- msg << "Re-run cmake missing file: " << this->CheckBuildSystemArgument
- << '\n';
- cmSystemTools::Stdout(msg.str());
- }
- return 1;
- }
- // Read the rerun check file and use it to decide whether to do the
- // global generate.
- // Actually, all we need is the `set` command.
- cmake cm(RoleScript, cmState::Unknown);
- cm.SetHomeDirectory("");
- cm.SetHomeOutputDirectory("");
- cm.GetCurrentSnapshot().SetDefaultDefinitions();
- cmGlobalGenerator gg(&cm);
- cmMakefile mf(&gg, cm.GetCurrentSnapshot());
- if (!mf.ReadListFile(this->CheckBuildSystemArgument) ||
- cmSystemTools::GetErrorOccurredFlag()) {
- if (verbose) {
- std::ostringstream msg;
- msg << "Re-run cmake error reading : " << this->CheckBuildSystemArgument
- << '\n';
- cmSystemTools::Stdout(msg.str());
- }
- // There was an error reading the file. Just rerun.
- return 1;
- }
- if (this->ClearBuildSystem) {
- // Get the generator used for this build system.
- std::string genName = mf.GetSafeDefinition("CMAKE_DEPENDS_GENERATOR");
- if (!cmNonempty(genName)) {
- genName = "Unix Makefiles";
- }
- // Create the generator and use it to clear the dependencies.
- std::unique_ptr<cmGlobalGenerator> ggd =
- this->CreateGlobalGenerator(genName);
- if (ggd) {
- cm.GetCurrentSnapshot().SetDefaultDefinitions();
- cmMakefile mfd(ggd.get(), cm.GetCurrentSnapshot());
- auto lgd = ggd->CreateLocalGenerator(&mfd);
- lgd->ClearDependencies(&mfd, verbose);
- }
- }
- // If any byproduct of makefile generation is missing we must re-run.
- cmList products{ mf.GetDefinition("CMAKE_MAKEFILE_PRODUCTS") };
- for (auto const& p : products) {
- if (!cmSystemTools::PathExists(p)) {
- if (verbose) {
- cmSystemTools::Stdout(
- cmStrCat("Re-run cmake, missing byproduct: ", p, '\n'));
- }
- return 1;
- }
- }
- // Get the set of dependencies and outputs.
- cmList depends{ mf.GetDefinition("CMAKE_MAKEFILE_DEPENDS") };
- cmList outputs;
- if (!depends.empty()) {
- outputs.assign(mf.GetDefinition("CMAKE_MAKEFILE_OUTPUTS"));
- }
- if (depends.empty() || outputs.empty()) {
- // Not enough information was provided to do the test. Just rerun.
- if (verbose) {
- cmSystemTools::Stdout("Re-run cmake no CMAKE_MAKEFILE_DEPENDS "
- "or CMAKE_MAKEFILE_OUTPUTS :\n");
- }
- return 1;
- }
- // Find the newest dependency.
- auto dep = depends.begin();
- std::string dep_newest = *dep++;
- for (; dep != depends.end(); ++dep) {
- int result = 0;
- if (this->FileTimeCache->Compare(dep_newest, *dep, &result)) {
- if (result < 0) {
- dep_newest = *dep;
- }
- } else {
- if (verbose) {
- cmSystemTools::Stdout(
- "Re-run cmake: build system dependency is missing\n");
- }
- return 1;
- }
- }
- // Find the oldest output.
- auto out = outputs.begin();
- std::string out_oldest = *out++;
- for (; out != outputs.end(); ++out) {
- int result = 0;
- if (this->FileTimeCache->Compare(out_oldest, *out, &result)) {
- if (result > 0) {
- out_oldest = *out;
- }
- } else {
- if (verbose) {
- cmSystemTools::Stdout(
- "Re-run cmake: build system output is missing\n");
- }
- return 1;
- }
- }
- // If any output is older than any dependency then rerun.
- {
- int result = 0;
- if (!this->FileTimeCache->Compare(out_oldest, dep_newest, &result) ||
- result < 0) {
- if (verbose) {
- std::ostringstream msg;
- msg << "Re-run cmake file: " << out_oldest
- << " older than: " << dep_newest << '\n';
- cmSystemTools::Stdout(msg.str());
- }
- return 1;
- }
- }
- // No need to rerun.
- return 0;
- }
- void cmake::TruncateOutputLog(const char* fname)
- {
- std::string fullPath = cmStrCat(this->GetHomeOutputDirectory(), '/', fname);
- struct stat st;
- if (::stat(fullPath.c_str(), &st)) {
- return;
- }
- if (!this->State->GetInitializedCacheValue("CMAKE_CACHEFILE_DIR")) {
- cmSystemTools::RemoveFile(fullPath);
- return;
- }
- off_t fsize = st.st_size;
- const off_t maxFileSize = 50 * 1024;
- if (fsize < maxFileSize) {
- // TODO: truncate file
- return;
- }
- }
- void cmake::MarkCliAsUsed(const std::string& variable)
- {
- this->UsedCliVariables[variable] = true;
- }
- void cmake::GenerateGraphViz(const std::string& fileName) const
- {
- #ifndef CMAKE_BOOTSTRAP
- cmGraphVizWriter gvWriter(fileName, this->GetGlobalGenerator());
- std::string settingsFile =
- cmStrCat(this->GetHomeOutputDirectory(), "/CMakeGraphVizOptions.cmake");
- std::string fallbackSettingsFile =
- cmStrCat(this->GetHomeDirectory(), "/CMakeGraphVizOptions.cmake");
- gvWriter.ReadSettings(settingsFile, fallbackSettingsFile);
- gvWriter.Write();
- #endif
- }
- void cmake::SetProperty(const std::string& prop, cmValue value)
- {
- this->State->SetGlobalProperty(prop, value);
- }
- void cmake::AppendProperty(const std::string& prop, const std::string& value,
- bool asString)
- {
- this->State->AppendGlobalProperty(prop, value, asString);
- }
- cmValue cmake::GetProperty(const std::string& prop)
- {
- return this->State->GetGlobalProperty(prop);
- }
- bool cmake::GetPropertyAsBool(const std::string& prop)
- {
- return this->State->GetGlobalPropertyAsBool(prop);
- }
- cmInstalledFile* cmake::GetOrCreateInstalledFile(cmMakefile* mf,
- const std::string& name)
- {
- auto i = this->InstalledFiles.find(name);
- if (i != this->InstalledFiles.end()) {
- cmInstalledFile& file = i->second;
- return &file;
- }
- cmInstalledFile& file = this->InstalledFiles[name];
- file.SetName(mf, name);
- return &file;
- }
- cmInstalledFile const* cmake::GetInstalledFile(const std::string& name) const
- {
- auto i = this->InstalledFiles.find(name);
- if (i != this->InstalledFiles.end()) {
- cmInstalledFile const& file = i->second;
- return &file;
- }
- return nullptr;
- }
- int cmake::GetSystemInformation(std::vector<std::string>& args)
- {
- // so create the directory
- std::string resultFile;
- std::string cwd = cmSystemTools::GetCurrentWorkingDirectory();
- std::string destPath = cwd + "/__cmake_systeminformation";
- cmSystemTools::RemoveADirectory(destPath);
- if (!cmSystemTools::MakeDirectory(destPath)) {
- std::cerr << "Error: --system-information must be run from a "
- "writable directory!\n";
- return 1;
- }
- // process the arguments
- bool writeToStdout = true;
- for (unsigned int i = 1; i < args.size(); ++i) {
- std::string const& arg = args[i];
- if (cmHasLiteralPrefix(arg, "-G")) {
- std::string value = arg.substr(2);
- if (value.empty()) {
- ++i;
- if (i >= args.size()) {
- cmSystemTools::Error("No generator specified for -G");
- this->PrintGeneratorList();
- return -1;
- }
- value = args[i];
- }
- auto gen = this->CreateGlobalGenerator(value);
- if (!gen) {
- cmSystemTools::Error("Could not create named generator " + value);
- this->PrintGeneratorList();
- } else {
- this->SetGlobalGenerator(std::move(gen));
- }
- }
- // no option assume it is the output file
- else {
- if (!cmSystemTools::FileIsFullPath(arg)) {
- resultFile = cmStrCat(cwd, '/');
- }
- resultFile += arg;
- writeToStdout = false;
- }
- }
- // we have to find the module directory, so we can copy the files
- this->AddCMakePaths();
- std::string modulesPath =
- cmStrCat(cmSystemTools::GetCMakeRoot(), "/Modules");
- std::string inFile = cmStrCat(modulesPath, "/SystemInformation.cmake");
- std::string outFile = cmStrCat(destPath, "/CMakeLists.txt");
- // Copy file
- if (!cmsys::SystemTools::CopyFileAlways(inFile, outFile)) {
- std::cerr << "Error copying file \"" << inFile << "\" to \"" << outFile
- << "\".\n";
- return 1;
- }
- // do we write to a file or to stdout?
- if (resultFile.empty()) {
- resultFile = cmStrCat(cwd, "/__cmake_systeminformation/results.txt");
- }
- {
- // now run cmake on the CMakeLists file
- cmWorkingDirectory workdir(destPath);
- if (workdir.Failed()) {
- // We created the directory and we were able to copy the CMakeLists.txt
- // file to it, so we wouldn't expect to get here unless the default
- // permissions are questionable or some other process has deleted the
- // directory
- std::cerr << "Failed to change to directory " << destPath << " : "
- << std::strerror(workdir.GetLastResult()) << '\n';
- return 1;
- }
- std::vector<std::string> args2;
- args2.push_back(args[0]);
- args2.push_back(destPath);
- args2.push_back("-DRESULT_FILE=" + resultFile);
- int res = this->Run(args2, false);
- if (res != 0) {
- std::cerr << "Error: --system-information failed on internal CMake!\n";
- return res;
- }
- }
- // echo results to stdout if needed
- if (writeToStdout) {
- FILE* fin = cmsys::SystemTools::Fopen(resultFile, "r");
- if (fin) {
- const int bufferSize = 4096;
- char buffer[bufferSize];
- size_t n;
- while ((n = fread(buffer, 1, bufferSize, fin)) > 0) {
- for (char* c = buffer; c < buffer + n; ++c) {
- putc(*c, stdout);
- }
- fflush(stdout);
- }
- fclose(fin);
- }
- }
- // clean up the directory
- cmSystemTools::RemoveADirectory(destPath);
- return 0;
- }
- void cmake::IssueMessage(MessageType t, std::string const& text,
- cmListFileBacktrace const& backtrace) const
- {
- this->Messenger->IssueMessage(t, text, backtrace);
- }
- std::vector<std::string> cmake::GetDebugConfigs()
- {
- cmList configs;
- if (cmValue config_list =
- this->State->GetGlobalProperty("DEBUG_CONFIGURATIONS")) {
- // Expand the specified list and convert to upper-case.
- configs.assign(*config_list);
- configs.transform(cmList::TransformAction::TOUPPER);
- }
- // If no configurations were specified, use a default list.
- if (configs.empty()) {
- configs.emplace_back("DEBUG");
- }
- return std::move(configs.data());
- }
- int cmake::Build(int jobs, std::string dir, std::vector<std::string> targets,
- std::string config, std::vector<std::string> nativeOptions,
- cmBuildOptions& buildOptions, bool verbose,
- const std::string& presetName, bool listPresets)
- {
- this->SetHomeDirectory("");
- this->SetHomeOutputDirectory("");
- #if !defined(CMAKE_BOOTSTRAP)
- if (!presetName.empty() || listPresets) {
- this->SetHomeDirectory(cmSystemTools::GetCurrentWorkingDirectory());
- this->SetHomeOutputDirectory(cmSystemTools::GetCurrentWorkingDirectory());
- cmCMakePresetsGraph settingsFile;
- auto result = settingsFile.ReadProjectPresets(this->GetHomeDirectory());
- if (result != true) {
- cmSystemTools::Error(
- cmStrCat("Could not read presets from ", this->GetHomeDirectory(), ":",
- settingsFile.parseState.GetErrorMessage()));
- return 1;
- }
- if (listPresets) {
- settingsFile.PrintBuildPresetList();
- return 0;
- }
- auto presetPair = settingsFile.BuildPresets.find(presetName);
- if (presetPair == settingsFile.BuildPresets.end()) {
- cmSystemTools::Error(cmStrCat("No such build preset in ",
- this->GetHomeDirectory(), ": \"",
- presetName, '"'));
- settingsFile.PrintBuildPresetList();
- return 1;
- }
- if (presetPair->second.Unexpanded.Hidden) {
- cmSystemTools::Error(cmStrCat("Cannot use hidden build preset in ",
- this->GetHomeDirectory(), ": \"",
- presetName, '"'));
- settingsFile.PrintBuildPresetList();
- return 1;
- }
- auto const& expandedPreset = presetPair->second.Expanded;
- if (!expandedPreset) {
- cmSystemTools::Error(cmStrCat("Could not evaluate build preset \"",
- presetName,
- "\": Invalid macro expansion"));
- settingsFile.PrintBuildPresetList();
- return 1;
- }
- if (!expandedPreset->ConditionResult) {
- cmSystemTools::Error(cmStrCat("Cannot use disabled build preset in ",
- this->GetHomeDirectory(), ": \"",
- presetName, '"'));
- settingsFile.PrintBuildPresetList();
- return 1;
- }
- auto configurePresetPair =
- settingsFile.ConfigurePresets.find(expandedPreset->ConfigurePreset);
- if (configurePresetPair == settingsFile.ConfigurePresets.end()) {
- cmSystemTools::Error(cmStrCat("No such configure preset in ",
- this->GetHomeDirectory(), ": \"",
- expandedPreset->ConfigurePreset, '"'));
- this->PrintPresetList(settingsFile);
- return 1;
- }
- if (configurePresetPair->second.Unexpanded.Hidden) {
- cmSystemTools::Error(cmStrCat("Cannot use hidden configure preset in ",
- this->GetHomeDirectory(), ": \"",
- expandedPreset->ConfigurePreset, '"'));
- this->PrintPresetList(settingsFile);
- return 1;
- }
- auto const& expandedConfigurePreset = configurePresetPair->second.Expanded;
- if (!expandedConfigurePreset) {
- cmSystemTools::Error(cmStrCat("Could not evaluate configure preset \"",
- expandedPreset->ConfigurePreset,
- "\": Invalid macro expansion"));
- return 1;
- }
- if (!expandedConfigurePreset->BinaryDir.empty()) {
- dir = expandedConfigurePreset->BinaryDir;
- }
- this->UnprocessedPresetEnvironment = expandedPreset->Environment;
- this->ProcessPresetEnvironment();
- if ((jobs == cmake::DEFAULT_BUILD_PARALLEL_LEVEL ||
- jobs == cmake::NO_BUILD_PARALLEL_LEVEL) &&
- expandedPreset->Jobs) {
- jobs = *expandedPreset->Jobs;
- }
- if (targets.empty()) {
- targets.insert(targets.begin(), expandedPreset->Targets.begin(),
- expandedPreset->Targets.end());
- }
- if (config.empty()) {
- config = expandedPreset->Configuration;
- }
- if (!buildOptions.Clean && expandedPreset->CleanFirst) {
- buildOptions.Clean = *expandedPreset->CleanFirst;
- }
- if (buildOptions.ResolveMode == PackageResolveMode::Default &&
- expandedPreset->ResolvePackageReferences) {
- buildOptions.ResolveMode = *expandedPreset->ResolvePackageReferences;
- }
- if (!verbose && expandedPreset->Verbose) {
- verbose = *expandedPreset->Verbose;
- }
- if (nativeOptions.empty()) {
- nativeOptions.insert(nativeOptions.begin(),
- expandedPreset->NativeToolOptions.begin(),
- expandedPreset->NativeToolOptions.end());
- }
- }
- #endif
- if (!cmSystemTools::FileIsDirectory(dir)) {
- std::cerr << "Error: " << dir << " is not a directory\n";
- return 1;
- }
- std::string cachePath = FindCacheFile(dir);
- if (!this->LoadCache(cachePath)) {
- std::cerr << "Error: could not load cache\n";
- return 1;
- }
- cmValue cachedGenerator = this->State->GetCacheEntryValue("CMAKE_GENERATOR");
- if (!cachedGenerator) {
- std::cerr << "Error: could not find CMAKE_GENERATOR in Cache\n";
- return 1;
- }
- auto gen = this->CreateGlobalGenerator(*cachedGenerator);
- if (!gen) {
- std::cerr << "Error: could not create CMAKE_GENERATOR \""
- << *cachedGenerator << "\"\n";
- return 1;
- }
- this->SetGlobalGenerator(std::move(gen));
- cmValue cachedGeneratorInstance =
- this->State->GetCacheEntryValue("CMAKE_GENERATOR_INSTANCE");
- if (cachedGeneratorInstance) {
- cmMakefile mf(this->GetGlobalGenerator(), this->GetCurrentSnapshot());
- if (!this->GlobalGenerator->SetGeneratorInstance(*cachedGeneratorInstance,
- &mf)) {
- return 1;
- }
- }
- cmValue cachedGeneratorPlatform =
- this->State->GetCacheEntryValue("CMAKE_GENERATOR_PLATFORM");
- if (cachedGeneratorPlatform) {
- cmMakefile mf(this->GetGlobalGenerator(), this->GetCurrentSnapshot());
- if (!this->GlobalGenerator->SetGeneratorPlatform(*cachedGeneratorPlatform,
- &mf)) {
- return 1;
- }
- }
- cmValue cachedGeneratorToolset =
- this->State->GetCacheEntryValue("CMAKE_GENERATOR_TOOLSET");
- if (cachedGeneratorToolset) {
- cmMakefile mf(this->GetGlobalGenerator(), this->GetCurrentSnapshot());
- if (!this->GlobalGenerator->SetGeneratorToolset(*cachedGeneratorToolset,
- true, &mf)) {
- return 1;
- }
- }
- std::string projName;
- cmValue cachedProjectName =
- this->State->GetCacheEntryValue("CMAKE_PROJECT_NAME");
- if (!cachedProjectName) {
- std::cerr << "Error: could not find CMAKE_PROJECT_NAME in Cache\n";
- return 1;
- }
- projName = *cachedProjectName;
- if (this->State->GetCacheEntryValue("CMAKE_VERBOSE_MAKEFILE").IsOn()) {
- verbose = true;
- }
- #ifdef CMAKE_HAVE_VS_GENERATORS
- // For VS generators, explicitly check if regeneration is necessary before
- // actually starting the build. If not done separately from the build
- // itself, there is the risk of building an out-of-date solution file due
- // to limitations of the underlying build system.
- std::string const stampList = cachePath + "/" + "CMakeFiles/" +
- cmGlobalVisualStudio12Generator::GetGenerateStampList();
- // Note that the stampList file only exists for VS generators.
- if (cmSystemTools::FileExists(stampList)) {
- this->AddScriptingCommands();
- if (!cmakeCheckStampList(stampList)) {
- // Correctly initialize the home (=source) and home output (=binary)
- // directories, which is required for running the generation step.
- std::string homeOrig = this->GetHomeDirectory();
- std::string homeOutputOrig = this->GetHomeOutputDirectory();
- this->SetDirectoriesFromFile(cachePath);
- this->AddProjectCommands();
- int ret = this->Configure();
- if (ret) {
- cmSystemTools::Message("CMake Configure step failed. "
- "Build files cannot be regenerated correctly.");
- return ret;
- }
- ret = this->Generate();
- if (ret) {
- cmSystemTools::Message("CMake Generate step failed. "
- "Build files cannot be regenerated correctly.");
- return ret;
- }
- std::string message = cmStrCat("Build files have been written to: ",
- this->GetHomeOutputDirectory());
- this->UpdateProgress(message, -1);
- // Restore the previously set directories to their original value.
- this->SetHomeDirectory(homeOrig);
- this->SetHomeOutputDirectory(homeOutputOrig);
- }
- }
- #endif
- if (!this->GlobalGenerator->ReadCacheEntriesForBuild(*this->State)) {
- return 1;
- }
- this->GlobalGenerator->PrintBuildCommandAdvice(std::cerr, jobs);
- std::stringstream ostr;
- // `cmGlobalGenerator::Build` logs metadata about what directory and commands
- // are being executed to the `output` parameter. If CMake is verbose, print
- // this out.
- std::ostream& verbose_ostr = verbose ? std::cout : ostr;
- int buildresult = this->GlobalGenerator->Build(
- jobs, "", dir, projName, targets, verbose_ostr, "", config, buildOptions,
- verbose, cmDuration::zero(), cmSystemTools::OUTPUT_PASSTHROUGH,
- nativeOptions);
- return buildresult;
- }
- bool cmake::Open(const std::string& dir, bool dryRun)
- {
- this->SetHomeDirectory("");
- this->SetHomeOutputDirectory("");
- if (!cmSystemTools::FileIsDirectory(dir)) {
- std::cerr << "Error: " << dir << " is not a directory\n";
- return false;
- }
- std::string cachePath = FindCacheFile(dir);
- if (!this->LoadCache(cachePath)) {
- std::cerr << "Error: could not load cache\n";
- return false;
- }
- cmValue genName = this->State->GetCacheEntryValue("CMAKE_GENERATOR");
- if (!genName) {
- std::cerr << "Error: could not find CMAKE_GENERATOR in Cache\n";
- return false;
- }
- cmValue extraGenName =
- this->State->GetInitializedCacheValue("CMAKE_EXTRA_GENERATOR");
- std::string fullName =
- cmExternalMakefileProjectGenerator::CreateFullGeneratorName(
- *genName, extraGenName ? *extraGenName : "");
- std::unique_ptr<cmGlobalGenerator> gen =
- this->CreateGlobalGenerator(fullName);
- if (!gen) {
- std::cerr << "Error: could not create CMAKE_GENERATOR \"" << fullName
- << "\"\n";
- return false;
- }
- cmValue cachedProjectName =
- this->State->GetCacheEntryValue("CMAKE_PROJECT_NAME");
- if (!cachedProjectName) {
- std::cerr << "Error: could not find CMAKE_PROJECT_NAME in Cache\n";
- return false;
- }
- return gen->Open(dir, *cachedProjectName, dryRun);
- }
- #if !defined(CMAKE_BOOTSTRAP)
- template <typename T>
- const T* cmake::FindPresetForWorkflow(
- cm::static_string_view type,
- const std::map<std::string, cmCMakePresetsGraph::PresetPair<T>>& presets,
- const cmCMakePresetsGraph::WorkflowPreset::WorkflowStep& step)
- {
- auto it = presets.find(step.PresetName);
- if (it == presets.end()) {
- cmSystemTools::Error(cmStrCat("No such ", type, " preset in ",
- this->GetHomeDirectory(), ": \"",
- step.PresetName, '"'));
- return nullptr;
- }
- if (it->second.Unexpanded.Hidden) {
- cmSystemTools::Error(cmStrCat("Cannot use hidden ", type, " preset in ",
- this->GetHomeDirectory(), ": \"",
- step.PresetName, '"'));
- return nullptr;
- }
- if (!it->second.Expanded) {
- cmSystemTools::Error(cmStrCat("Could not evaluate ", type, " preset \"",
- step.PresetName,
- "\": Invalid macro expansion"));
- return nullptr;
- }
- if (!it->second.Expanded->ConditionResult) {
- cmSystemTools::Error(cmStrCat("Cannot use disabled ", type, " preset in ",
- this->GetHomeDirectory(), ": \"",
- step.PresetName, '"'));
- return nullptr;
- }
- return &*it->second.Expanded;
- }
- std::function<int()> cmake::BuildWorkflowStep(
- const std::vector<std::string>& args)
- {
- cmUVProcessChainBuilder builder;
- builder.AddCommand(args)
- .SetExternalStream(cmUVProcessChainBuilder::Stream_OUTPUT, stdout)
- .SetExternalStream(cmUVProcessChainBuilder::Stream_ERROR, stderr);
- return [builder]() -> int {
- auto chain = builder.Start();
- chain.Wait();
- return static_cast<int>(chain.GetStatus(0).ExitStatus);
- };
- }
- #endif
- int cmake::Workflow(const std::string& presetName,
- WorkflowListPresets listPresets, WorkflowFresh fresh)
- {
- #ifndef CMAKE_BOOTSTRAP
- this->SetHomeDirectory(cmSystemTools::GetCurrentWorkingDirectory());
- this->SetHomeOutputDirectory(cmSystemTools::GetCurrentWorkingDirectory());
- cmCMakePresetsGraph settingsFile;
- auto result = settingsFile.ReadProjectPresets(this->GetHomeDirectory());
- if (result != true) {
- cmSystemTools::Error(cmStrCat("Could not read presets from ",
- this->GetHomeDirectory(), ":",
- settingsFile.parseState.GetErrorMessage()));
- return 1;
- }
- if (listPresets == WorkflowListPresets::Yes) {
- settingsFile.PrintWorkflowPresetList();
- return 0;
- }
- auto presetPair = settingsFile.WorkflowPresets.find(presetName);
- if (presetPair == settingsFile.WorkflowPresets.end()) {
- cmSystemTools::Error(cmStrCat("No such workflow preset in ",
- this->GetHomeDirectory(), ": \"", presetName,
- '"'));
- settingsFile.PrintWorkflowPresetList();
- return 1;
- }
- if (presetPair->second.Unexpanded.Hidden) {
- cmSystemTools::Error(cmStrCat("Cannot use hidden workflow preset in ",
- this->GetHomeDirectory(), ": \"", presetName,
- '"'));
- settingsFile.PrintWorkflowPresetList();
- return 1;
- }
- auto const& expandedPreset = presetPair->second.Expanded;
- if (!expandedPreset) {
- cmSystemTools::Error(cmStrCat("Could not evaluate workflow preset \"",
- presetName, "\": Invalid macro expansion"));
- settingsFile.PrintWorkflowPresetList();
- return 1;
- }
- if (!expandedPreset->ConditionResult) {
- cmSystemTools::Error(cmStrCat("Cannot use disabled workflow preset in ",
- this->GetHomeDirectory(), ": \"", presetName,
- '"'));
- settingsFile.PrintWorkflowPresetList();
- return 1;
- }
- struct CalculatedStep
- {
- int StepNumber;
- cm::static_string_view Type;
- std::string Name;
- std::function<int()> Action;
- CalculatedStep(int stepNumber, cm::static_string_view type,
- std::string name, std::function<int()> action)
- : StepNumber(stepNumber)
- , Type(type)
- , Name(std::move(name))
- , Action(std::move(action))
- {
- }
- };
- std::vector<CalculatedStep> steps;
- steps.reserve(expandedPreset->Steps.size());
- int stepNumber = 1;
- for (auto const& step : expandedPreset->Steps) {
- switch (step.PresetType) {
- case cmCMakePresetsGraph::WorkflowPreset::WorkflowStep::Type::
- Configure: {
- auto const* configurePreset = this->FindPresetForWorkflow(
- "configure"_s, settingsFile.ConfigurePresets, step);
- if (!configurePreset) {
- return 1;
- }
- std::vector<std::string> args{ cmSystemTools::GetCMakeCommand(),
- "--preset", step.PresetName };
- if (fresh == WorkflowFresh::Yes) {
- args.emplace_back("--fresh");
- }
- steps.emplace_back(stepNumber, "configure"_s, step.PresetName,
- this->BuildWorkflowStep(args));
- } break;
- case cmCMakePresetsGraph::WorkflowPreset::WorkflowStep::Type::Build: {
- auto const* buildPreset = this->FindPresetForWorkflow(
- "build"_s, settingsFile.BuildPresets, step);
- if (!buildPreset) {
- return 1;
- }
- steps.emplace_back(
- stepNumber, "build"_s, step.PresetName,
- this->BuildWorkflowStep({ cmSystemTools::GetCMakeCommand(),
- "--build", "--preset", step.PresetName }));
- } break;
- case cmCMakePresetsGraph::WorkflowPreset::WorkflowStep::Type::Test: {
- auto const* testPreset = this->FindPresetForWorkflow(
- "test"_s, settingsFile.TestPresets, step);
- if (!testPreset) {
- return 1;
- }
- steps.emplace_back(
- stepNumber, "test"_s, step.PresetName,
- this->BuildWorkflowStep({ cmSystemTools::GetCTestCommand(),
- "--preset", step.PresetName }));
- } break;
- case cmCMakePresetsGraph::WorkflowPreset::WorkflowStep::Type::Package: {
- auto const* packagePreset = this->FindPresetForWorkflow(
- "package"_s, settingsFile.PackagePresets, step);
- if (!packagePreset) {
- return 1;
- }
- steps.emplace_back(
- stepNumber, "package"_s, step.PresetName,
- this->BuildWorkflowStep({ cmSystemTools::GetCPackCommand(),
- "--preset", step.PresetName }));
- } break;
- }
- stepNumber++;
- }
- int stepResult;
- bool first = true;
- for (auto const& step : steps) {
- if (!first) {
- std::cout << "\n";
- }
- std::cout << "Executing workflow step " << step.StepNumber << " of "
- << steps.size() << ": " << step.Type << " preset \"" << step.Name
- << "\"\n\n"
- << std::flush;
- if ((stepResult = step.Action()) != 0) {
- return stepResult;
- }
- first = false;
- }
- #endif
- return 0;
- }
- void cmake::WatchUnusedCli(const std::string& var)
- {
- #ifndef CMAKE_BOOTSTRAP
- this->VariableWatch->AddWatch(var, cmWarnUnusedCliWarning, this);
- if (!cm::contains(this->UsedCliVariables, var)) {
- this->UsedCliVariables[var] = false;
- }
- #endif
- }
- void cmake::UnwatchUnusedCli(const std::string& var)
- {
- #ifndef CMAKE_BOOTSTRAP
- this->VariableWatch->RemoveWatch(var, cmWarnUnusedCliWarning);
- this->UsedCliVariables.erase(var);
- #endif
- }
- void cmake::RunCheckForUnusedVariables()
- {
- #ifndef CMAKE_BOOTSTRAP
- bool haveUnused = false;
- std::ostringstream msg;
- msg << "Manually-specified variables were not used by the project:";
- for (auto const& it : this->UsedCliVariables) {
- if (!it.second) {
- haveUnused = true;
- msg << "\n " << it.first;
- }
- }
- if (haveUnused) {
- this->IssueMessage(MessageType::WARNING, msg.str());
- }
- #endif
- }
- bool cmake::GetSuppressDevWarnings() const
- {
- return this->Messenger->GetSuppressDevWarnings();
- }
- void cmake::SetSuppressDevWarnings(bool b)
- {
- std::string value;
- // equivalent to -Wno-dev
- if (b) {
- value = "TRUE";
- }
- // equivalent to -Wdev
- else {
- value = "FALSE";
- }
- this->AddCacheEntry("CMAKE_SUPPRESS_DEVELOPER_WARNINGS", value,
- "Suppress Warnings that are meant for"
- " the author of the CMakeLists.txt files.",
- cmStateEnums::INTERNAL);
- }
- bool cmake::GetSuppressDeprecatedWarnings() const
- {
- return this->Messenger->GetSuppressDeprecatedWarnings();
- }
- void cmake::SetSuppressDeprecatedWarnings(bool b)
- {
- std::string value;
- // equivalent to -Wno-deprecated
- if (b) {
- value = "FALSE";
- }
- // equivalent to -Wdeprecated
- else {
- value = "TRUE";
- }
- this->AddCacheEntry("CMAKE_WARN_DEPRECATED", value,
- "Whether to issue warnings for deprecated "
- "functionality.",
- cmStateEnums::INTERNAL);
- }
- bool cmake::GetDevWarningsAsErrors() const
- {
- return this->Messenger->GetDevWarningsAsErrors();
- }
- void cmake::SetDevWarningsAsErrors(bool b)
- {
- std::string value;
- // equivalent to -Werror=dev
- if (b) {
- value = "FALSE";
- }
- // equivalent to -Wno-error=dev
- else {
- value = "TRUE";
- }
- this->AddCacheEntry("CMAKE_SUPPRESS_DEVELOPER_ERRORS", value,
- "Suppress errors that are meant for"
- " the author of the CMakeLists.txt files.",
- cmStateEnums::INTERNAL);
- }
- bool cmake::GetDeprecatedWarningsAsErrors() const
- {
- return this->Messenger->GetDeprecatedWarningsAsErrors();
- }
- void cmake::SetDeprecatedWarningsAsErrors(bool b)
- {
- std::string value;
- // equivalent to -Werror=deprecated
- if (b) {
- value = "TRUE";
- }
- // equivalent to -Wno-error=deprecated
- else {
- value = "FALSE";
- }
- this->AddCacheEntry("CMAKE_ERROR_DEPRECATED", value,
- "Whether to issue deprecation errors for macros"
- " and functions.",
- cmStateEnums::INTERNAL);
- }
- void cmake::SetDebugFindOutputPkgs(std::string const& args)
- {
- this->DebugFindPkgs.emplace(args);
- }
- void cmake::SetDebugFindOutputVars(std::string const& args)
- {
- this->DebugFindVars.emplace(args);
- }
- bool cmake::GetDebugFindOutput(std::string const& var) const
- {
- return this->DebugFindVars.count(var);
- }
- bool cmake::GetDebugFindPkgOutput(std::string const& pkg) const
- {
- return this->DebugFindPkgs.count(pkg);
- }
- #if !defined(CMAKE_BOOTSTRAP)
- cmMakefileProfilingData& cmake::GetProfilingOutput()
- {
- return *(this->ProfilingOutput);
- }
- bool cmake::IsProfilingEnabled() const
- {
- return static_cast<bool>(this->ProfilingOutput);
- }
- #endif
|