cmLocalGenerator.cxx 157 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279428042814282428342844285428642874288428942904291429242934294429542964297429842994300430143024303430443054306430743084309431043114312431343144315431643174318431943204321432243234324432543264327432843294330433143324333433443354336433743384339434043414342434343444345434643474348434943504351435243534354435543564357435843594360436143624363436443654366436743684369437043714372437343744375437643774378437943804381438243834384438543864387438843894390439143924393439443954396439743984399440044014402440344044405440644074408440944104411441244134414441544164417441844194420442144224423442444254426442744284429443044314432443344344435443644374438443944404441444244434444444544464447444844494450445144524453445444554456445744584459446044614462446344644465446644674468446944704471447244734474447544764477447844794480448144824483448444854486448744884489449044914492449344944495449644974498449945004501450245034504450545064507450845094510
  1. /* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
  2. file Copyright.txt or https://cmake.org/licensing for details. */
  3. #include "cmLocalGenerator.h"
  4. #include <algorithm>
  5. #include <array>
  6. #include <cassert>
  7. #include <cstdio>
  8. #include <cstdlib>
  9. #include <initializer_list>
  10. #include <iterator>
  11. #include <sstream>
  12. #include <unordered_set>
  13. #include <utility>
  14. #include <vector>
  15. #include <cm/memory>
  16. #include <cm/string_view>
  17. #include <cmext/algorithm>
  18. #include <cmext/string_view>
  19. #include "cmsys/RegularExpression.hxx"
  20. #include "cmAlgorithms.h"
  21. #include "cmComputeLinkInformation.h"
  22. #include "cmCustomCommand.h"
  23. #include "cmCustomCommandGenerator.h"
  24. #include "cmCustomCommandLines.h"
  25. #include "cmCustomCommandTypes.h"
  26. #include "cmGeneratedFileStream.h"
  27. #include "cmGeneratorExpression.h"
  28. #include "cmGeneratorExpressionEvaluationFile.h"
  29. #include "cmGeneratorTarget.h"
  30. #include "cmGlobalGenerator.h"
  31. #include "cmInstallGenerator.h"
  32. #include "cmInstallScriptGenerator.h"
  33. #include "cmInstallTargetGenerator.h"
  34. #include "cmLinkLineComputer.h"
  35. #include "cmMakefile.h"
  36. #include "cmRange.h"
  37. #include "cmRulePlaceholderExpander.h"
  38. #include "cmSourceFile.h"
  39. #include "cmSourceFileLocation.h"
  40. #include "cmSourceFileLocationKind.h"
  41. #include "cmStandardLevelResolver.h"
  42. #include "cmState.h"
  43. #include "cmStateDirectory.h"
  44. #include "cmStateTypes.h"
  45. #include "cmStringAlgorithms.h"
  46. #include "cmSystemTools.h"
  47. #include "cmTarget.h"
  48. #include "cmTestGenerator.h"
  49. #include "cmValue.h"
  50. #include "cmVersion.h"
  51. #include "cmake.h"
  52. #if !defined(CMAKE_BOOTSTRAP)
  53. # define CM_LG_ENCODE_OBJECT_NAMES
  54. # include "cmCryptoHash.h"
  55. #endif
  56. #if defined(__HAIKU__)
  57. # include <FindDirectory.h>
  58. # include <StorageDefs.h>
  59. #endif
  60. // List of variables that are replaced when
  61. // rules are expanced. These variables are
  62. // replaced in the form <var> with GetSafeDefinition(var).
  63. // ${LANG} is replaced in the variable first with all enabled
  64. // languages.
  65. static auto ruleReplaceVars = { "CMAKE_${LANG}_COMPILER",
  66. "CMAKE_SHARED_LIBRARY_CREATE_${LANG}_FLAGS",
  67. "CMAKE_SHARED_MODULE_CREATE_${LANG}_FLAGS",
  68. "CMAKE_SHARED_MODULE_${LANG}_FLAGS",
  69. "CMAKE_SHARED_LIBRARY_${LANG}_FLAGS",
  70. "CMAKE_${LANG}_LINK_FLAGS",
  71. "CMAKE_SHARED_LIBRARY_SONAME_${LANG}_FLAG",
  72. "CMAKE_${LANG}_ARCHIVE",
  73. "CMAKE_AR",
  74. "CMAKE_CURRENT_SOURCE_DIR",
  75. "CMAKE_CURRENT_BINARY_DIR",
  76. "CMAKE_RANLIB",
  77. "CMAKE_LINKER",
  78. "CMAKE_MT",
  79. "CMAKE_CUDA_HOST_COMPILER",
  80. "CMAKE_CUDA_HOST_LINK_LAUNCHER",
  81. "CMAKE_CL_SHOWINCLUDES_PREFIX" };
  82. cmLocalGenerator::cmLocalGenerator(cmGlobalGenerator* gg, cmMakefile* makefile)
  83. : cmOutputConverter(makefile->GetStateSnapshot())
  84. , DirectoryBacktrace(makefile->GetBacktrace())
  85. {
  86. this->GlobalGenerator = gg;
  87. this->Makefile = makefile;
  88. this->AliasTargets = makefile->GetAliasTargets();
  89. this->EmitUniversalBinaryFlags = true;
  90. this->BackwardsCompatibility = 0;
  91. this->BackwardsCompatibilityFinal = false;
  92. this->ComputeObjectMaxPath();
  93. // Canonicalize entries of the CPATH environment variable the same
  94. // way detection of CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES does.
  95. {
  96. std::vector<std::string> cpath;
  97. cmSystemTools::GetPath(cpath, "CPATH");
  98. for (std::string const& cp : cpath) {
  99. if (cmSystemTools::FileIsFullPath(cp)) {
  100. this->EnvCPATH.emplace_back(cmSystemTools::CollapseFullPath(cp));
  101. }
  102. }
  103. }
  104. std::vector<std::string> enabledLanguages =
  105. this->GetState()->GetEnabledLanguages();
  106. if (cmValue sysrootCompile =
  107. this->Makefile->GetDefinition("CMAKE_SYSROOT_COMPILE")) {
  108. this->CompilerSysroot = *sysrootCompile;
  109. } else {
  110. this->CompilerSysroot = this->Makefile->GetSafeDefinition("CMAKE_SYSROOT");
  111. }
  112. if (cmValue sysrootLink =
  113. this->Makefile->GetDefinition("CMAKE_SYSROOT_LINK")) {
  114. this->LinkerSysroot = *sysrootLink;
  115. } else {
  116. this->LinkerSysroot = this->Makefile->GetSafeDefinition("CMAKE_SYSROOT");
  117. }
  118. if (cmValue appleArchSysroots =
  119. this->Makefile->GetDefinition("CMAKE_APPLE_ARCH_SYSROOTS")) {
  120. std::string const& appleArchs =
  121. this->Makefile->GetSafeDefinition("CMAKE_OSX_ARCHITECTURES");
  122. std::vector<std::string> archs;
  123. std::vector<std::string> sysroots;
  124. cmExpandList(appleArchs, archs);
  125. cmExpandList(*appleArchSysroots, sysroots, true);
  126. if (archs.size() == sysroots.size()) {
  127. for (size_t i = 0; i < archs.size(); ++i) {
  128. this->AppleArchSysroots[archs[i]] = sysroots[i];
  129. }
  130. } else {
  131. std::string const e =
  132. cmStrCat("CMAKE_APPLE_ARCH_SYSROOTS:\n ", *appleArchSysroots,
  133. "\n"
  134. "is not the same length as CMAKE_OSX_ARCHITECTURES:\n ",
  135. appleArchs);
  136. this->IssueMessage(MessageType::FATAL_ERROR, e);
  137. }
  138. }
  139. for (std::string const& lang : enabledLanguages) {
  140. if (lang == "NONE") {
  141. continue;
  142. }
  143. this->Compilers["CMAKE_" + lang + "_COMPILER"] = lang;
  144. this->VariableMappings["CMAKE_" + lang + "_COMPILER"] =
  145. this->Makefile->GetSafeDefinition("CMAKE_" + lang + "_COMPILER");
  146. std::string const& compilerArg1 = "CMAKE_" + lang + "_COMPILER_ARG1";
  147. std::string const& compilerTarget = "CMAKE_" + lang + "_COMPILER_TARGET";
  148. std::string const& compilerOptionTarget =
  149. "CMAKE_" + lang + "_COMPILE_OPTIONS_TARGET";
  150. std::string const& compilerExternalToolchain =
  151. "CMAKE_" + lang + "_COMPILER_EXTERNAL_TOOLCHAIN";
  152. std::string const& compilerOptionExternalToolchain =
  153. "CMAKE_" + lang + "_COMPILE_OPTIONS_EXTERNAL_TOOLCHAIN";
  154. std::string const& compilerOptionSysroot =
  155. "CMAKE_" + lang + "_COMPILE_OPTIONS_SYSROOT";
  156. this->VariableMappings[compilerArg1] =
  157. this->Makefile->GetSafeDefinition(compilerArg1);
  158. this->VariableMappings[compilerTarget] =
  159. this->Makefile->GetSafeDefinition(compilerTarget);
  160. this->VariableMappings[compilerOptionTarget] =
  161. this->Makefile->GetSafeDefinition(compilerOptionTarget);
  162. this->VariableMappings[compilerExternalToolchain] =
  163. this->Makefile->GetSafeDefinition(compilerExternalToolchain);
  164. this->VariableMappings[compilerOptionExternalToolchain] =
  165. this->Makefile->GetSafeDefinition(compilerOptionExternalToolchain);
  166. this->VariableMappings[compilerOptionSysroot] =
  167. this->Makefile->GetSafeDefinition(compilerOptionSysroot);
  168. for (std::string replaceVar : ruleReplaceVars) {
  169. if (replaceVar.find("${LANG}") != std::string::npos) {
  170. cmSystemTools::ReplaceString(replaceVar, "${LANG}", lang);
  171. }
  172. this->VariableMappings[replaceVar] =
  173. this->Makefile->GetSafeDefinition(replaceVar);
  174. }
  175. }
  176. }
  177. cmRulePlaceholderExpander* cmLocalGenerator::CreateRulePlaceholderExpander()
  178. const
  179. {
  180. return new cmRulePlaceholderExpander(this->Compilers, this->VariableMappings,
  181. this->CompilerSysroot,
  182. this->LinkerSysroot);
  183. }
  184. cmLocalGenerator::~cmLocalGenerator() = default;
  185. void cmLocalGenerator::IssueMessage(MessageType t,
  186. std::string const& text) const
  187. {
  188. this->GetCMakeInstance()->IssueMessage(t, text, this->DirectoryBacktrace);
  189. }
  190. void cmLocalGenerator::ComputeObjectMaxPath()
  191. {
  192. // Choose a maximum object file name length.
  193. #if defined(_WIN32) || defined(__CYGWIN__)
  194. this->ObjectPathMax = 250;
  195. #else
  196. this->ObjectPathMax = 1000;
  197. #endif
  198. cmValue plen = this->Makefile->GetDefinition("CMAKE_OBJECT_PATH_MAX");
  199. if (cmNonempty(plen)) {
  200. unsigned int pmax;
  201. if (sscanf(plen->c_str(), "%u", &pmax) == 1) {
  202. if (pmax >= 128) {
  203. this->ObjectPathMax = pmax;
  204. } else {
  205. std::ostringstream w;
  206. w << "CMAKE_OBJECT_PATH_MAX is set to " << pmax
  207. << ", which is less than the minimum of 128. "
  208. << "The value will be ignored.";
  209. this->IssueMessage(MessageType::AUTHOR_WARNING, w.str());
  210. }
  211. } else {
  212. std::ostringstream w;
  213. w << "CMAKE_OBJECT_PATH_MAX is set to \"" << *plen
  214. << "\", which fails to parse as a positive integer. "
  215. << "The value will be ignored.";
  216. this->IssueMessage(MessageType::AUTHOR_WARNING, w.str());
  217. }
  218. }
  219. this->ObjectMaxPathViolations.clear();
  220. }
  221. static void MoveSystemIncludesToEnd(std::vector<std::string>& includeDirs,
  222. const std::string& config,
  223. const std::string& lang,
  224. const cmGeneratorTarget* target)
  225. {
  226. if (!target) {
  227. return;
  228. }
  229. std::stable_sort(
  230. includeDirs.begin(), includeDirs.end(),
  231. [&target, &config, &lang](std::string const& a, std::string const& b) {
  232. return !target->IsSystemIncludeDirectory(a, config, lang) &&
  233. target->IsSystemIncludeDirectory(b, config, lang);
  234. });
  235. }
  236. static void MoveSystemIncludesToEnd(std::vector<BT<std::string>>& includeDirs,
  237. const std::string& config,
  238. const std::string& lang,
  239. const cmGeneratorTarget* target)
  240. {
  241. if (!target) {
  242. return;
  243. }
  244. std::stable_sort(includeDirs.begin(), includeDirs.end(),
  245. [target, &config, &lang](BT<std::string> const& a,
  246. BT<std::string> const& b) {
  247. return !target->IsSystemIncludeDirectory(a.Value, config,
  248. lang) &&
  249. target->IsSystemIncludeDirectory(b.Value, config, lang);
  250. });
  251. }
  252. void cmLocalGenerator::TraceDependencies() const
  253. {
  254. // Generate the rule files for each target.
  255. const auto& targets = this->GetGeneratorTargets();
  256. for (const auto& target : targets) {
  257. if (!target->IsInBuildSystem()) {
  258. continue;
  259. }
  260. target->TraceDependencies();
  261. }
  262. }
  263. void cmLocalGenerator::GenerateTestFiles()
  264. {
  265. if (!this->Makefile->IsOn("CMAKE_TESTING_ENABLED")) {
  266. return;
  267. }
  268. // Compute the set of configurations.
  269. std::vector<std::string> configurationTypes =
  270. this->Makefile->GetGeneratorConfigs(cmMakefile::OnlyMultiConfig);
  271. std::string config = this->Makefile->GetDefaultConfiguration();
  272. std::string file =
  273. cmStrCat(this->StateSnapshot.GetDirectory().GetCurrentBinary(),
  274. "/CTestTestfile.cmake");
  275. cmGeneratedFileStream fout(file);
  276. fout.SetCopyIfDifferent(true);
  277. fout << "# CMake generated Testfile for \n"
  278. "# Source directory: "
  279. << this->StateSnapshot.GetDirectory().GetCurrentSource()
  280. << "\n"
  281. "# Build directory: "
  282. << this->StateSnapshot.GetDirectory().GetCurrentBinary()
  283. << "\n"
  284. "# \n"
  285. "# This file includes the relevant testing commands "
  286. "required for \n"
  287. "# testing this directory and lists subdirectories to "
  288. "be tested as well.\n";
  289. std::string resourceSpecFile =
  290. this->Makefile->GetSafeDefinition("CTEST_RESOURCE_SPEC_FILE");
  291. if (!resourceSpecFile.empty()) {
  292. fout << "set(CTEST_RESOURCE_SPEC_FILE \"" << resourceSpecFile << "\")\n";
  293. }
  294. cmValue testIncludeFile = this->Makefile->GetProperty("TEST_INCLUDE_FILE");
  295. if (testIncludeFile) {
  296. fout << "include(\"" << *testIncludeFile << "\")\n";
  297. }
  298. cmValue testIncludeFiles = this->Makefile->GetProperty("TEST_INCLUDE_FILES");
  299. if (testIncludeFiles) {
  300. std::vector<std::string> includesList = cmExpandedList(*testIncludeFiles);
  301. for (std::string const& i : includesList) {
  302. fout << "include(\"" << i << "\")\n";
  303. }
  304. }
  305. // Ask each test generator to write its code.
  306. for (const auto& tester : this->Makefile->GetTestGenerators()) {
  307. tester->Compute(this);
  308. tester->Generate(fout, config, configurationTypes);
  309. }
  310. using vec_t = std::vector<cmStateSnapshot>;
  311. vec_t const& children = this->Makefile->GetStateSnapshot().GetChildren();
  312. for (cmStateSnapshot const& i : children) {
  313. // TODO: Use add_subdirectory instead?
  314. std::string outP = i.GetDirectory().GetCurrentBinary();
  315. outP = this->MaybeRelativeToCurBinDir(outP);
  316. outP = cmOutputConverter::EscapeForCMake(outP);
  317. fout << "subdirs(" << outP << ")\n";
  318. }
  319. // Add directory labels property
  320. cmValue directoryLabels =
  321. this->Makefile->GetDefinition("CMAKE_DIRECTORY_LABELS");
  322. cmValue labels = this->Makefile->GetProperty("LABELS");
  323. if (labels || directoryLabels) {
  324. fout << "set_directory_properties(PROPERTIES LABELS ";
  325. if (labels) {
  326. fout << cmOutputConverter::EscapeForCMake(*labels);
  327. }
  328. if (labels && directoryLabels) {
  329. fout << ";";
  330. }
  331. if (directoryLabels) {
  332. fout << cmOutputConverter::EscapeForCMake(*directoryLabels);
  333. }
  334. fout << ")\n";
  335. }
  336. }
  337. void cmLocalGenerator::CreateEvaluationFileOutputs()
  338. {
  339. std::vector<std::string> const& configs =
  340. this->Makefile->GetGeneratorConfigs(cmMakefile::IncludeEmptyConfig);
  341. for (std::string const& c : configs) {
  342. this->CreateEvaluationFileOutputs(c);
  343. }
  344. }
  345. void cmLocalGenerator::CreateEvaluationFileOutputs(std::string const& config)
  346. {
  347. for (const auto& geef : this->Makefile->GetEvaluationFiles()) {
  348. geef->CreateOutputFile(this, config);
  349. }
  350. }
  351. void cmLocalGenerator::ProcessEvaluationFiles(
  352. std::vector<std::string>& generatedFiles)
  353. {
  354. for (const auto& geef : this->Makefile->GetEvaluationFiles()) {
  355. geef->Generate(this);
  356. if (cmSystemTools::GetFatalErrorOccured()) {
  357. return;
  358. }
  359. std::vector<std::string> files = geef->GetFiles();
  360. std::sort(files.begin(), files.end());
  361. std::vector<std::string> intersection;
  362. std::set_intersection(files.begin(), files.end(), generatedFiles.begin(),
  363. generatedFiles.end(),
  364. std::back_inserter(intersection));
  365. if (!intersection.empty()) {
  366. cmSystemTools::Error("Files to be generated by multiple different "
  367. "commands: " +
  368. cmWrap('"', intersection, '"', " "));
  369. return;
  370. }
  371. cm::append(generatedFiles, files);
  372. std::inplace_merge(generatedFiles.begin(),
  373. generatedFiles.end() - files.size(),
  374. generatedFiles.end());
  375. }
  376. }
  377. void cmLocalGenerator::GenerateInstallRules()
  378. {
  379. // Compute the install prefix.
  380. cmValue installPrefix =
  381. this->Makefile->GetDefinition("CMAKE_INSTALL_PREFIX");
  382. std::string prefix = installPrefix;
  383. #if defined(_WIN32) && !defined(__CYGWIN__)
  384. if (!installPrefix) {
  385. if (!cmSystemTools::GetEnv("SystemDrive", prefix)) {
  386. prefix = "C:";
  387. }
  388. cmValue project_name = this->Makefile->GetDefinition("PROJECT_NAME");
  389. if (cmNonempty(project_name)) {
  390. prefix += "/Program Files/";
  391. prefix += *project_name;
  392. } else {
  393. prefix += "/InstalledCMakeProject";
  394. }
  395. }
  396. #elif defined(__HAIKU__)
  397. char dir[B_PATH_NAME_LENGTH];
  398. if (!installPrefix) {
  399. if (find_directory(B_SYSTEM_DIRECTORY, -1, false, dir, sizeof(dir)) ==
  400. B_OK) {
  401. prefix = dir;
  402. } else {
  403. prefix = "/boot/system";
  404. }
  405. }
  406. #else
  407. if (!installPrefix) {
  408. prefix = "/usr/local";
  409. }
  410. #endif
  411. if (cmValue stagingPrefix =
  412. this->Makefile->GetDefinition("CMAKE_STAGING_PREFIX")) {
  413. prefix = *stagingPrefix;
  414. }
  415. // Compute the set of configurations.
  416. std::vector<std::string> configurationTypes =
  417. this->Makefile->GetGeneratorConfigs(cmMakefile::OnlyMultiConfig);
  418. std::string config = this->Makefile->GetDefaultConfiguration();
  419. // Choose a default install configuration.
  420. std::string default_config = config;
  421. const char* default_order[] = { "RELEASE", "MINSIZEREL", "RELWITHDEBINFO",
  422. "DEBUG", nullptr };
  423. for (const char** c = default_order; *c && default_config.empty(); ++c) {
  424. for (std::string const& configurationType : configurationTypes) {
  425. if (cmSystemTools::UpperCase(configurationType) == *c) {
  426. default_config = configurationType;
  427. }
  428. }
  429. }
  430. if (default_config.empty() && !configurationTypes.empty()) {
  431. default_config = configurationTypes[0];
  432. }
  433. // Create the install script file.
  434. std::string file = this->StateSnapshot.GetDirectory().GetCurrentBinary();
  435. std::string homedir = this->GetState()->GetBinaryDirectory();
  436. int toplevel_install = 0;
  437. if (file == homedir) {
  438. toplevel_install = 1;
  439. }
  440. file += "/cmake_install.cmake";
  441. cmGeneratedFileStream fout(file);
  442. fout.SetCopyIfDifferent(true);
  443. // Write the header.
  444. /* clang-format off */
  445. fout << "# Install script for directory: "
  446. << this->StateSnapshot.GetDirectory().GetCurrentSource()
  447. << "\n\n"
  448. "# Set the install prefix\n"
  449. "if(NOT DEFINED CMAKE_INSTALL_PREFIX)\n"
  450. " set(CMAKE_INSTALL_PREFIX \"" << prefix << "\")\n"
  451. "endif()\n"
  452. << R"(string(REGEX REPLACE "/$" "" CMAKE_INSTALL_PREFIX )"
  453. << "\"${CMAKE_INSTALL_PREFIX}\")\n\n";
  454. /* clang-format on */
  455. // Write support code for generating per-configuration install rules.
  456. /* clang-format off */
  457. fout <<
  458. "# Set the install configuration name.\n"
  459. "if(NOT DEFINED CMAKE_INSTALL_CONFIG_NAME)\n"
  460. " if(BUILD_TYPE)\n"
  461. " string(REGEX REPLACE \"^[^A-Za-z0-9_]+\" \"\"\n"
  462. " CMAKE_INSTALL_CONFIG_NAME \"${BUILD_TYPE}\")\n"
  463. " else()\n"
  464. " set(CMAKE_INSTALL_CONFIG_NAME \"" << default_config << "\")\n"
  465. " endif()\n"
  466. " message(STATUS \"Install configuration: "
  467. "\\\"${CMAKE_INSTALL_CONFIG_NAME}\\\"\")\n"
  468. "endif()\n"
  469. "\n";
  470. /* clang-format on */
  471. // Write support code for dealing with component-specific installs.
  472. /* clang-format off */
  473. fout <<
  474. "# Set the component getting installed.\n"
  475. "if(NOT CMAKE_INSTALL_COMPONENT)\n"
  476. " if(COMPONENT)\n"
  477. " message(STATUS \"Install component: \\\"${COMPONENT}\\\"\")\n"
  478. " set(CMAKE_INSTALL_COMPONENT \"${COMPONENT}\")\n"
  479. " else()\n"
  480. " set(CMAKE_INSTALL_COMPONENT)\n"
  481. " endif()\n"
  482. "endif()\n"
  483. "\n";
  484. /* clang-format on */
  485. // Copy user-specified install options to the install code.
  486. if (cmValue so_no_exe =
  487. this->Makefile->GetDefinition("CMAKE_INSTALL_SO_NO_EXE")) {
  488. /* clang-format off */
  489. fout <<
  490. "# Install shared libraries without execute permission?\n"
  491. "if(NOT DEFINED CMAKE_INSTALL_SO_NO_EXE)\n"
  492. " set(CMAKE_INSTALL_SO_NO_EXE \"" << *so_no_exe << "\")\n"
  493. "endif()\n"
  494. "\n";
  495. /* clang-format on */
  496. }
  497. // Copy cmake cross compile state to install code.
  498. if (cmValue crosscompiling =
  499. this->Makefile->GetDefinition("CMAKE_CROSSCOMPILING")) {
  500. /* clang-format off */
  501. fout <<
  502. "# Is this installation the result of a crosscompile?\n"
  503. "if(NOT DEFINED CMAKE_CROSSCOMPILING)\n"
  504. " set(CMAKE_CROSSCOMPILING \"" << *crosscompiling << "\")\n"
  505. "endif()\n"
  506. "\n";
  507. /* clang-format on */
  508. }
  509. // Write default directory permissions.
  510. if (cmValue defaultDirPermissions = this->Makefile->GetDefinition(
  511. "CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS")) {
  512. /* clang-format off */
  513. fout <<
  514. "# Set default install directory permissions.\n"
  515. "if(NOT DEFINED CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS)\n"
  516. " set(CMAKE_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS \""
  517. << *defaultDirPermissions << "\")\n"
  518. "endif()\n"
  519. "\n";
  520. /* clang-format on */
  521. }
  522. // Write out CMAKE_GET_RUNTIME_DEPENDENCIES_PLATFORM so that
  523. // installed code that uses `file(GET_RUNTIME_DEPENDENCIES)`
  524. // has same platform variable as when running cmake
  525. if (cmValue platform = this->Makefile->GetDefinition(
  526. "CMAKE_GET_RUNTIME_DEPENDENCIES_PLATFORM")) {
  527. /* clang-format off */
  528. fout <<
  529. "# Set default install directory permissions.\n"
  530. "if(NOT DEFINED CMAKE_GET_RUNTIME_DEPENDENCIES_PLATFORM)\n"
  531. " set(CMAKE_GET_RUNTIME_DEPENDENCIES_PLATFORM \""
  532. << *platform << "\")\n"
  533. "endif()\n"
  534. "\n";
  535. /* clang-format on */
  536. }
  537. // Write out CMAKE_GET_RUNTIME_DEPENDENCIES_TOOL so that
  538. // installed code that uses `file(GET_RUNTIME_DEPENDENCIES)`
  539. // has same tool selected as when running cmake
  540. if (cmValue command =
  541. this->Makefile->GetDefinition("CMAKE_GET_RUNTIME_DEPENDENCIES_TOOL")) {
  542. /* clang-format off */
  543. fout <<
  544. "# Set default install directory permissions.\n"
  545. "if(NOT DEFINED CMAKE_GET_RUNTIME_DEPENDENCIES_TOOL)\n"
  546. " set(CMAKE_GET_RUNTIME_DEPENDENCIES_TOOL \""
  547. << *command << "\")\n"
  548. "endif()\n"
  549. "\n";
  550. /* clang-format on */
  551. }
  552. // Write out CMAKE_GET_RUNTIME_DEPENDENCIES_COMMAND so that
  553. // installed code that uses `file(GET_RUNTIME_DEPENDENCIES)`
  554. // has same path to the tool as when running cmake
  555. if (cmValue command = this->Makefile->GetDefinition(
  556. "CMAKE_GET_RUNTIME_DEPENDENCIES_COMMAND")) {
  557. /* clang-format off */
  558. fout <<
  559. "# Set default install directory permissions.\n"
  560. "if(NOT DEFINED CMAKE_GET_RUNTIME_DEPENDENCIES_COMMAND)\n"
  561. " set(CMAKE_GET_RUNTIME_DEPENDENCIES_COMMAND \""
  562. << *command << "\")\n"
  563. "endif()\n"
  564. "\n";
  565. /* clang-format on */
  566. }
  567. // Write out CMAKE_OBJDUMP so that installed code that uses
  568. // `file(GET_RUNTIME_DEPENDENCIES)` and hasn't specified
  569. // CMAKE_GET_RUNTIME_DEPENDENCIES_COMMAND has consistent
  570. // logic to fallback to CMAKE_OBJDUMP when `objdump` is
  571. // not on the path
  572. if (cmValue command = this->Makefile->GetDefinition("CMAKE_OBJDUMP")) {
  573. /* clang-format off */
  574. fout <<
  575. "# Set default install directory permissions.\n"
  576. "if(NOT DEFINED CMAKE_OBJDUMP)\n"
  577. " set(CMAKE_OBJDUMP \""
  578. << *command << "\")\n"
  579. "endif()\n"
  580. "\n";
  581. /* clang-format on */
  582. }
  583. this->AddGeneratorSpecificInstallSetup(fout);
  584. // Ask each install generator to write its code.
  585. cmPolicies::PolicyStatus status = this->GetPolicyStatus(cmPolicies::CMP0082);
  586. auto const& installers = this->Makefile->GetInstallGenerators();
  587. bool haveSubdirectoryInstall = false;
  588. bool haveInstallAfterSubdirectory = false;
  589. if (status == cmPolicies::WARN) {
  590. for (const auto& installer : installers) {
  591. installer->CheckCMP0082(haveSubdirectoryInstall,
  592. haveInstallAfterSubdirectory);
  593. installer->Generate(fout, config, configurationTypes);
  594. }
  595. } else {
  596. for (const auto& installer : installers) {
  597. installer->Generate(fout, config, configurationTypes);
  598. }
  599. }
  600. // Write rules from old-style specification stored in targets.
  601. this->GenerateTargetInstallRules(fout, config, configurationTypes);
  602. // Include install scripts from subdirectories.
  603. switch (status) {
  604. case cmPolicies::WARN:
  605. if (haveInstallAfterSubdirectory &&
  606. this->Makefile->PolicyOptionalWarningEnabled(
  607. "CMAKE_POLICY_WARNING_CMP0082")) {
  608. std::ostringstream e;
  609. e << cmPolicies::GetPolicyWarning(cmPolicies::CMP0082) << "\n";
  610. this->IssueMessage(MessageType::AUTHOR_WARNING, e.str());
  611. }
  612. CM_FALLTHROUGH;
  613. case cmPolicies::OLD: {
  614. std::vector<cmStateSnapshot> children =
  615. this->Makefile->GetStateSnapshot().GetChildren();
  616. if (!children.empty()) {
  617. fout << "if(NOT CMAKE_INSTALL_LOCAL_ONLY)\n";
  618. fout << " # Include the install script for each subdirectory.\n";
  619. for (cmStateSnapshot const& c : children) {
  620. if (!c.GetDirectory().GetPropertyAsBool("EXCLUDE_FROM_ALL")) {
  621. std::string odir = c.GetDirectory().GetCurrentBinary();
  622. cmSystemTools::ConvertToUnixSlashes(odir);
  623. fout << " include(\"" << odir << "/cmake_install.cmake\")\n";
  624. }
  625. }
  626. fout << "\n";
  627. fout << "endif()\n\n";
  628. }
  629. } break;
  630. case cmPolicies::REQUIRED_IF_USED:
  631. case cmPolicies::REQUIRED_ALWAYS:
  632. case cmPolicies::NEW:
  633. // NEW behavior is handled in
  634. // cmInstallSubdirectoryGenerator::GenerateScript()
  635. break;
  636. }
  637. // Record the install manifest.
  638. if (toplevel_install) {
  639. /* clang-format off */
  640. fout <<
  641. "if(CMAKE_INSTALL_COMPONENT)\n"
  642. " set(CMAKE_INSTALL_MANIFEST \"install_manifest_"
  643. "${CMAKE_INSTALL_COMPONENT}.txt\")\n"
  644. "else()\n"
  645. " set(CMAKE_INSTALL_MANIFEST \"install_manifest.txt\")\n"
  646. "endif()\n"
  647. "\n"
  648. "string(REPLACE \";\" \"\\n\" CMAKE_INSTALL_MANIFEST_CONTENT\n"
  649. " \"${CMAKE_INSTALL_MANIFEST_FILES}\")\n"
  650. "file(WRITE \"" << homedir << "/${CMAKE_INSTALL_MANIFEST}\"\n"
  651. " \"${CMAKE_INSTALL_MANIFEST_CONTENT}\")\n";
  652. /* clang-format on */
  653. }
  654. }
  655. void cmLocalGenerator::AddGeneratorTarget(
  656. std::unique_ptr<cmGeneratorTarget> gt)
  657. {
  658. cmGeneratorTarget* gt_ptr = gt.get();
  659. this->GeneratorTargets.push_back(std::move(gt));
  660. this->GeneratorTargetSearchIndex.emplace(gt_ptr->GetName(), gt_ptr);
  661. this->GlobalGenerator->IndexGeneratorTarget(gt_ptr);
  662. }
  663. void cmLocalGenerator::AddImportedGeneratorTarget(cmGeneratorTarget* gt)
  664. {
  665. this->ImportedGeneratorTargets.emplace(gt->GetName(), gt);
  666. this->GlobalGenerator->IndexGeneratorTarget(gt);
  667. }
  668. void cmLocalGenerator::AddOwnedImportedGeneratorTarget(
  669. std::unique_ptr<cmGeneratorTarget> gt)
  670. {
  671. this->OwnedImportedGeneratorTargets.push_back(std::move(gt));
  672. }
  673. cmGeneratorTarget* cmLocalGenerator::FindLocalNonAliasGeneratorTarget(
  674. const std::string& name) const
  675. {
  676. auto ti = this->GeneratorTargetSearchIndex.find(name);
  677. if (ti != this->GeneratorTargetSearchIndex.end()) {
  678. return ti->second;
  679. }
  680. return nullptr;
  681. }
  682. void cmLocalGenerator::ComputeTargetManifest()
  683. {
  684. // Collect the set of configuration types.
  685. std::vector<std::string> configNames =
  686. this->Makefile->GetGeneratorConfigs(cmMakefile::IncludeEmptyConfig);
  687. // Add our targets to the manifest for each configuration.
  688. const auto& targets = this->GetGeneratorTargets();
  689. for (const auto& target : targets) {
  690. if (!target->IsInBuildSystem()) {
  691. continue;
  692. }
  693. for (std::string const& c : configNames) {
  694. target->ComputeTargetManifest(c);
  695. }
  696. }
  697. }
  698. bool cmLocalGenerator::ComputeTargetCompileFeatures()
  699. {
  700. // Collect the set of configuration types.
  701. std::vector<std::string> configNames =
  702. this->Makefile->GetGeneratorConfigs(cmMakefile::IncludeEmptyConfig);
  703. using LanguagePair = std::pair<std::string, std::string>;
  704. std::vector<LanguagePair> pairedLanguages{
  705. { "OBJC", "C" }, { "OBJCXX", "CXX" }, { "CUDA", "CXX" }, { "HIP", "CXX" }
  706. };
  707. std::set<LanguagePair> inferredEnabledLanguages;
  708. for (auto const& lang : pairedLanguages) {
  709. if (this->Makefile->GetState()->GetLanguageEnabled(lang.first)) {
  710. inferredEnabledLanguages.insert(lang);
  711. }
  712. }
  713. // Process compile features of all targets.
  714. const auto& targets = this->GetGeneratorTargets();
  715. for (const auto& target : targets) {
  716. for (std::string const& c : configNames) {
  717. if (!target->ComputeCompileFeatures(c)) {
  718. return false;
  719. }
  720. }
  721. // Now that C/C++ _STANDARD values have been computed
  722. // set the values to ObjC/ObjCXX _STANDARD variables
  723. if (target->CanCompileSources()) {
  724. for (std::string const& c : configNames) {
  725. target->ComputeCompileFeatures(c, inferredEnabledLanguages);
  726. }
  727. }
  728. }
  729. return true;
  730. }
  731. bool cmLocalGenerator::IsRootMakefile() const
  732. {
  733. return !this->StateSnapshot.GetBuildsystemDirectoryParent().IsValid();
  734. }
  735. cmState* cmLocalGenerator::GetState() const
  736. {
  737. return this->GlobalGenerator->GetCMakeInstance()->GetState();
  738. }
  739. cmStateSnapshot cmLocalGenerator::GetStateSnapshot() const
  740. {
  741. return this->Makefile->GetStateSnapshot();
  742. }
  743. cmValue cmLocalGenerator::GetRuleLauncher(cmGeneratorTarget* target,
  744. const std::string& prop)
  745. {
  746. if (target) {
  747. return target->GetProperty(prop);
  748. }
  749. return this->Makefile->GetProperty(prop);
  750. }
  751. std::string cmLocalGenerator::ConvertToIncludeReference(
  752. std::string const& path, OutputFormat format)
  753. {
  754. return this->ConvertToOutputForExisting(path, format);
  755. }
  756. std::string cmLocalGenerator::GetIncludeFlags(
  757. std::vector<std::string> const& includeDirs, cmGeneratorTarget* target,
  758. std::string const& lang, std::string const& config, bool forResponseFile)
  759. {
  760. if (lang.empty()) {
  761. return "";
  762. }
  763. std::vector<std::string> includes = includeDirs;
  764. MoveSystemIncludesToEnd(includes, config, lang, target);
  765. OutputFormat shellFormat = forResponseFile ? RESPONSE : SHELL;
  766. std::ostringstream includeFlags;
  767. std::string const& includeFlag =
  768. this->Makefile->GetSafeDefinition(cmStrCat("CMAKE_INCLUDE_FLAG_", lang));
  769. bool quotePaths = false;
  770. if (this->Makefile->GetDefinition("CMAKE_QUOTE_INCLUDE_PATHS")) {
  771. quotePaths = true;
  772. }
  773. std::string sep = " ";
  774. bool repeatFlag = true;
  775. // should the include flag be repeated like ie. -IA -IB
  776. if (cmValue incSep = this->Makefile->GetDefinition(
  777. cmStrCat("CMAKE_INCLUDE_FLAG_SEP_", lang))) {
  778. // if there is a separator then the flag is not repeated but is only
  779. // given once i.e. -classpath a:b:c
  780. sep = incSep;
  781. repeatFlag = false;
  782. }
  783. // Support special system include flag if it is available and the
  784. // normal flag is repeated for each directory.
  785. cmValue sysIncludeFlag = nullptr;
  786. cmValue sysIncludeFlagWarning = nullptr;
  787. if (repeatFlag) {
  788. sysIncludeFlag = this->Makefile->GetDefinition(
  789. cmStrCat("CMAKE_INCLUDE_SYSTEM_FLAG_", lang));
  790. sysIncludeFlagWarning = this->Makefile->GetDefinition(
  791. cmStrCat("_CMAKE_INCLUDE_SYSTEM_FLAG_", lang, "_WARNING"));
  792. }
  793. cmValue fwSearchFlag = this->Makefile->GetDefinition(
  794. cmStrCat("CMAKE_", lang, "_FRAMEWORK_SEARCH_FLAG"));
  795. cmValue sysFwSearchFlag = this->Makefile->GetDefinition(
  796. cmStrCat("CMAKE_", lang, "_SYSTEM_FRAMEWORK_SEARCH_FLAG"));
  797. bool flagUsed = false;
  798. bool sysIncludeFlagUsed = false;
  799. std::set<std::string> emitted;
  800. #ifdef __APPLE__
  801. emitted.insert("/System/Library/Frameworks");
  802. #endif
  803. for (std::string const& i : includes) {
  804. if (cmNonempty(fwSearchFlag) && this->Makefile->IsOn("APPLE") &&
  805. cmSystemTools::IsPathToFramework(i)) {
  806. std::string const frameworkDir =
  807. cmSystemTools::CollapseFullPath(cmStrCat(i, "/../"));
  808. if (emitted.insert(frameworkDir).second) {
  809. if (sysFwSearchFlag && target &&
  810. target->IsSystemIncludeDirectory(i, config, lang)) {
  811. includeFlags << *sysFwSearchFlag;
  812. } else {
  813. includeFlags << *fwSearchFlag;
  814. }
  815. includeFlags << this->ConvertToOutputFormat(frameworkDir, shellFormat)
  816. << " ";
  817. }
  818. continue;
  819. }
  820. if (!flagUsed || repeatFlag) {
  821. if (sysIncludeFlag && target &&
  822. target->IsSystemIncludeDirectory(i, config, lang)) {
  823. includeFlags << *sysIncludeFlag;
  824. sysIncludeFlagUsed = true;
  825. } else {
  826. includeFlags << includeFlag;
  827. }
  828. flagUsed = true;
  829. }
  830. std::string includePath = this->ConvertToIncludeReference(i, shellFormat);
  831. if (quotePaths && !includePath.empty() && includePath.front() != '\"') {
  832. includeFlags << "\"";
  833. }
  834. includeFlags << includePath;
  835. if (quotePaths && !includePath.empty() && includePath.front() != '\"') {
  836. includeFlags << "\"";
  837. }
  838. includeFlags << sep;
  839. }
  840. if (sysIncludeFlagUsed && sysIncludeFlagWarning) {
  841. includeFlags << *sysIncludeFlagWarning;
  842. }
  843. std::string flags = includeFlags.str();
  844. // remove trailing separators
  845. if ((sep[0] != ' ') && !flags.empty() && flags.back() == sep[0]) {
  846. flags.back() = ' ';
  847. }
  848. return cmTrimWhitespace(flags);
  849. }
  850. void cmLocalGenerator::AddCompileOptions(std::string& flags,
  851. cmGeneratorTarget* target,
  852. const std::string& lang,
  853. const std::string& config)
  854. {
  855. std::vector<BT<std::string>> tmpFlags;
  856. this->AddCompileOptions(tmpFlags, target, lang, config);
  857. this->AppendFlags(flags, tmpFlags);
  858. }
  859. void cmLocalGenerator::AddCompileOptions(std::vector<BT<std::string>>& flags,
  860. cmGeneratorTarget* target,
  861. const std::string& lang,
  862. const std::string& config)
  863. {
  864. std::string langFlagRegexVar = cmStrCat("CMAKE_", lang, "_FLAG_REGEX");
  865. if (cmValue langFlagRegexStr =
  866. this->Makefile->GetDefinition(langFlagRegexVar)) {
  867. // Filter flags acceptable to this language.
  868. if (cmValue targetFlags = target->GetProperty("COMPILE_FLAGS")) {
  869. std::vector<std::string> opts;
  870. cmSystemTools::ParseWindowsCommandLine(targetFlags->c_str(), opts);
  871. // Re-escape these flags since COMPILE_FLAGS were already parsed
  872. // as a command line above.
  873. std::string compileOpts;
  874. this->AppendCompileOptions(compileOpts, opts, langFlagRegexStr->c_str());
  875. if (!compileOpts.empty()) {
  876. flags.emplace_back(std::move(compileOpts));
  877. }
  878. }
  879. std::vector<BT<std::string>> targetCompileOpts =
  880. target->GetCompileOptions(config, lang);
  881. // COMPILE_OPTIONS are escaped.
  882. this->AppendCompileOptions(flags, targetCompileOpts,
  883. langFlagRegexStr->c_str());
  884. } else {
  885. // Use all flags.
  886. if (cmValue targetFlags = target->GetProperty("COMPILE_FLAGS")) {
  887. // COMPILE_FLAGS are not escaped for historical reasons.
  888. std::string compileFlags;
  889. this->AppendFlags(compileFlags, *targetFlags);
  890. if (!compileFlags.empty()) {
  891. flags.emplace_back(std::move(compileFlags));
  892. }
  893. }
  894. std::vector<BT<std::string>> targetCompileOpts =
  895. target->GetCompileOptions(config, lang);
  896. // COMPILE_OPTIONS are escaped.
  897. this->AppendCompileOptions(flags, targetCompileOpts);
  898. }
  899. cmStandardLevelResolver standardResolver(this->Makefile);
  900. for (auto const& it : target->GetMaxLanguageStandards()) {
  901. cmValue standard = target->GetLanguageStandard(it.first, config);
  902. if (!standard) {
  903. continue;
  904. }
  905. if (standardResolver.IsLaterStandard(it.first, *standard, it.second)) {
  906. std::ostringstream e;
  907. e << "The COMPILE_FEATURES property of target \"" << target->GetName()
  908. << "\" was evaluated when computing the link "
  909. "implementation, and the \""
  910. << it.first << "_STANDARD\" was \"" << it.second
  911. << "\" for that computation. Computing the "
  912. "COMPILE_FEATURES based on the link implementation resulted in a "
  913. "higher \""
  914. << it.first << "_STANDARD\" \"" << *standard
  915. << "\". "
  916. "This is not permitted. The COMPILE_FEATURES may not both depend "
  917. "on "
  918. "and be depended on by the link implementation.\n";
  919. this->IssueMessage(MessageType::FATAL_ERROR, e.str());
  920. return;
  921. }
  922. }
  923. std::string compReqFlag;
  924. this->AddCompilerRequirementFlag(compReqFlag, target, lang, config);
  925. if (!compReqFlag.empty()) {
  926. flags.emplace_back(std::move(compReqFlag));
  927. }
  928. // Add compile flag for the MSVC compiler only.
  929. cmMakefile* mf = this->GetMakefile();
  930. if (cmValue jmc =
  931. mf->GetDefinition("CMAKE_" + lang + "_COMPILE_OPTIONS_JMC")) {
  932. // Handle Just My Code debugging flags, /JMC.
  933. // If the target is a Managed C++ one, /JMC is not compatible.
  934. if (target->GetManagedType(config) !=
  935. cmGeneratorTarget::ManagedType::Managed) {
  936. // add /JMC flags if target property VS_JUST_MY_CODE_DEBUGGING is set
  937. // to ON
  938. if (cmValue jmcExprGen =
  939. target->GetProperty("VS_JUST_MY_CODE_DEBUGGING")) {
  940. std::string isJMCEnabled =
  941. cmGeneratorExpression::Evaluate(*jmcExprGen, this, config);
  942. if (cmIsOn(isJMCEnabled)) {
  943. std::vector<std::string> optVec = cmExpandedList(*jmc);
  944. std::string jmcFlags;
  945. this->AppendCompileOptions(jmcFlags, optVec);
  946. if (!jmcFlags.empty()) {
  947. flags.emplace_back(std::move(jmcFlags));
  948. }
  949. }
  950. }
  951. }
  952. }
  953. }
  954. cmTarget* cmLocalGenerator::AddCustomCommandToTarget(
  955. const std::string& target, cmCustomCommandType type,
  956. std::unique_ptr<cmCustomCommand> cc, cmObjectLibraryCommands objLibCommands)
  957. {
  958. cmTarget* t = this->Makefile->GetCustomCommandTarget(
  959. target, objLibCommands, this->DirectoryBacktrace);
  960. if (!t) {
  961. return nullptr;
  962. }
  963. cc->SetBacktrace(this->DirectoryBacktrace);
  964. detail::AddCustomCommandToTarget(*this, cmCommandOrigin::Generator, t, type,
  965. std::move(cc));
  966. return t;
  967. }
  968. cmSourceFile* cmLocalGenerator::AddCustomCommandToOutput(
  969. std::unique_ptr<cmCustomCommand> cc, bool replace)
  970. {
  971. // Make sure there is at least one output.
  972. if (cc->GetOutputs().empty()) {
  973. cmSystemTools::Error("Attempt to add a custom rule with no output!");
  974. return nullptr;
  975. }
  976. cc->SetBacktrace(this->DirectoryBacktrace);
  977. return detail::AddCustomCommandToOutput(*this, cmCommandOrigin::Generator,
  978. std::move(cc), replace);
  979. }
  980. cmTarget* cmLocalGenerator::AddUtilityCommand(
  981. const std::string& utilityName, bool excludeFromAll,
  982. std::unique_ptr<cmCustomCommand> cc)
  983. {
  984. cmTarget* target =
  985. this->Makefile->AddNewUtilityTarget(utilityName, excludeFromAll);
  986. target->SetIsGeneratorProvided(true);
  987. if (cc->GetCommandLines().empty() && cc->GetDepends().empty()) {
  988. return target;
  989. }
  990. cc->SetBacktrace(this->DirectoryBacktrace);
  991. detail::AddUtilityCommand(*this, cmCommandOrigin::Generator, target,
  992. std::move(cc));
  993. return target;
  994. }
  995. std::vector<BT<std::string>> cmLocalGenerator::GetIncludeDirectoriesImplicit(
  996. cmGeneratorTarget const* target, std::string const& lang,
  997. std::string const& config, bool stripImplicitDirs,
  998. bool appendAllImplicitDirs) const
  999. {
  1000. std::vector<BT<std::string>> result;
  1001. // Do not repeat an include path.
  1002. std::set<std::string> emitted;
  1003. auto emitDir = [&result, &emitted](std::string const& dir) {
  1004. if (emitted.insert(dir).second) {
  1005. result.emplace_back(dir);
  1006. }
  1007. };
  1008. auto emitBT = [&result, &emitted](BT<std::string> const& dir) {
  1009. if (emitted.insert(dir.Value).second) {
  1010. result.emplace_back(dir);
  1011. }
  1012. };
  1013. // When automatic include directories are requested for a build then
  1014. // include the source and binary directories at the beginning of the
  1015. // include path to approximate include file behavior for an
  1016. // in-source build. This does not account for the case of a source
  1017. // file in a subdirectory of the current source directory but we
  1018. // cannot fix this because not all native build tools support
  1019. // per-source-file include paths.
  1020. if (this->Makefile->IsOn("CMAKE_INCLUDE_CURRENT_DIR")) {
  1021. // Current binary directory
  1022. emitDir(this->StateSnapshot.GetDirectory().GetCurrentBinary());
  1023. // Current source directory
  1024. emitDir(this->StateSnapshot.GetDirectory().GetCurrentSource());
  1025. }
  1026. if (!target) {
  1027. return result;
  1028. }
  1029. // Standard include directories to be added unconditionally at the end.
  1030. // These are intended to simulate additional implicit include directories.
  1031. std::vector<std::string> userStandardDirs;
  1032. {
  1033. std::string const value = this->Makefile->GetSafeDefinition(
  1034. cmStrCat("CMAKE_", lang, "_STANDARD_INCLUDE_DIRECTORIES"));
  1035. cmExpandList(value, userStandardDirs);
  1036. for (std::string& usd : userStandardDirs) {
  1037. cmSystemTools::ConvertToUnixSlashes(usd);
  1038. }
  1039. }
  1040. // Implicit include directories
  1041. std::vector<std::string> implicitDirs;
  1042. std::set<std::string> implicitSet;
  1043. // Include directories to be excluded as if they were implicit.
  1044. std::set<std::string> implicitExclude;
  1045. {
  1046. // Raw list of implicit include directories
  1047. // Start with "standard" directories that we unconditionally add below.
  1048. std::vector<std::string> impDirVec = userStandardDirs;
  1049. // Load implicit include directories for this language.
  1050. // We ignore this for Fortran because:
  1051. // * There are no standard library headers to avoid overriding.
  1052. // * Compilers like gfortran do not search their own implicit include
  1053. // directories for modules ('.mod' files).
  1054. if (lang != "Fortran") {
  1055. size_t const impDirVecOldSize = impDirVec.size();
  1056. if (this->Makefile->GetDefExpandList(
  1057. cmStrCat("CMAKE_", lang, "_IMPLICIT_INCLUDE_DIRECTORIES"),
  1058. impDirVec)) {
  1059. // FIXME: Use cmRange with 'advance()' when it supports non-const.
  1060. for (size_t i = impDirVecOldSize; i < impDirVec.size(); ++i) {
  1061. cmSystemTools::ConvertToUnixSlashes(impDirVec[i]);
  1062. }
  1063. }
  1064. }
  1065. // The Platform/UnixPaths module used to hard-code /usr/include for C, CXX,
  1066. // and CUDA in CMAKE_<LANG>_IMPLICIT_INCLUDE_DIRECTORIES, but those
  1067. // variables are now computed. On macOS the /usr/include directory is
  1068. // inside the platform SDK so the computed value does not contain it
  1069. // directly. In this case adding -I/usr/include can hide SDK headers so we
  1070. // must still exclude it.
  1071. if ((lang == "C" || lang == "CXX" || lang == "CUDA") &&
  1072. !cm::contains(impDirVec, "/usr/include") &&
  1073. std::find_if(impDirVec.begin(), impDirVec.end(),
  1074. [](std::string const& d) {
  1075. return cmHasLiteralSuffix(d, "/usr/include");
  1076. }) != impDirVec.end()) {
  1077. // Only exclude this hard coded path for backwards compatibility.
  1078. implicitExclude.emplace("/usr/include");
  1079. }
  1080. for (std::string const& i : impDirVec) {
  1081. if (implicitSet.insert(this->GlobalGenerator->GetRealPath(i)).second) {
  1082. implicitDirs.emplace_back(i);
  1083. }
  1084. }
  1085. }
  1086. bool const isCorCxx = (lang == "C" || lang == "CXX");
  1087. // Resolve symlinks in CPATH for comparison with resolved include paths.
  1088. // We do this here instead of when EnvCPATH is populated in case symlinks
  1089. // on disk have changed in the meantime.
  1090. std::set<std::string> resolvedEnvCPATH;
  1091. if (isCorCxx) {
  1092. for (std::string const& i : this->EnvCPATH) {
  1093. resolvedEnvCPATH.emplace(this->GlobalGenerator->GetRealPath(i));
  1094. }
  1095. }
  1096. // Checks if this is not an excluded (implicit) include directory.
  1097. auto notExcluded = [this, &implicitSet, &implicitExclude, &resolvedEnvCPATH,
  1098. isCorCxx](std::string const& dir) -> bool {
  1099. std::string const& real_dir = this->GlobalGenerator->GetRealPath(dir);
  1100. return
  1101. // Do not exclude directories that are not in any excluded set.
  1102. !(cm::contains(implicitSet, real_dir) ||
  1103. cm::contains(implicitExclude, dir))
  1104. // Do not exclude entries of the CPATH environment variable even though
  1105. // they are implicitly searched by the compiler. They are meant to be
  1106. // user-specified directories that can be re-ordered or converted to
  1107. // -isystem without breaking real compiler builtin headers.
  1108. || (isCorCxx && cm::contains(resolvedEnvCPATH, real_dir));
  1109. };
  1110. // Get the target-specific include directories.
  1111. std::vector<BT<std::string>> userDirs =
  1112. target->GetIncludeDirectories(config, lang);
  1113. // Support putting all the in-project include directories first if
  1114. // it is requested by the project.
  1115. if (this->Makefile->IsOn("CMAKE_INCLUDE_DIRECTORIES_PROJECT_BEFORE")) {
  1116. std::string const& topSourceDir = this->GetState()->GetSourceDirectory();
  1117. std::string const& topBinaryDir = this->GetState()->GetBinaryDirectory();
  1118. for (BT<std::string> const& udr : userDirs) {
  1119. // Emit this directory only if it is a subdirectory of the
  1120. // top-level source or binary tree.
  1121. if (cmSystemTools::ComparePath(udr.Value, topSourceDir) ||
  1122. cmSystemTools::ComparePath(udr.Value, topBinaryDir) ||
  1123. cmSystemTools::IsSubDirectory(udr.Value, topSourceDir) ||
  1124. cmSystemTools::IsSubDirectory(udr.Value, topBinaryDir)) {
  1125. if (notExcluded(udr.Value)) {
  1126. emitBT(udr);
  1127. }
  1128. }
  1129. }
  1130. }
  1131. // Emit remaining non implicit user directories.
  1132. for (BT<std::string> const& udr : userDirs) {
  1133. if (notExcluded(udr.Value)) {
  1134. emitBT(udr);
  1135. }
  1136. }
  1137. // Sort result
  1138. MoveSystemIncludesToEnd(result, config, lang, target);
  1139. // Append standard include directories for this language.
  1140. userDirs.reserve(userDirs.size() + userStandardDirs.size());
  1141. for (std::string& usd : userStandardDirs) {
  1142. emitDir(usd);
  1143. userDirs.emplace_back(std::move(usd));
  1144. }
  1145. // Append compiler implicit include directories
  1146. if (!stripImplicitDirs) {
  1147. // Append implicit directories that were requested by the user only
  1148. for (BT<std::string> const& udr : userDirs) {
  1149. if (cm::contains(implicitSet, cmSystemTools::GetRealPath(udr.Value))) {
  1150. emitBT(udr);
  1151. }
  1152. }
  1153. // Append remaining implicit directories (on demand)
  1154. if (appendAllImplicitDirs) {
  1155. for (std::string& imd : implicitDirs) {
  1156. emitDir(imd);
  1157. }
  1158. }
  1159. }
  1160. return result;
  1161. }
  1162. void cmLocalGenerator::GetIncludeDirectoriesImplicit(
  1163. std::vector<std::string>& dirs, cmGeneratorTarget const* target,
  1164. const std::string& lang, const std::string& config, bool stripImplicitDirs,
  1165. bool appendAllImplicitDirs) const
  1166. {
  1167. std::vector<BT<std::string>> tmp = this->GetIncludeDirectoriesImplicit(
  1168. target, lang, config, stripImplicitDirs, appendAllImplicitDirs);
  1169. dirs.reserve(dirs.size() + tmp.size());
  1170. for (BT<std::string>& v : tmp) {
  1171. dirs.emplace_back(std::move(v.Value));
  1172. }
  1173. }
  1174. std::vector<BT<std::string>> cmLocalGenerator::GetIncludeDirectories(
  1175. cmGeneratorTarget const* target, std::string const& lang,
  1176. std::string const& config) const
  1177. {
  1178. return this->GetIncludeDirectoriesImplicit(target, lang, config);
  1179. }
  1180. void cmLocalGenerator::GetIncludeDirectories(std::vector<std::string>& dirs,
  1181. cmGeneratorTarget const* target,
  1182. const std::string& lang,
  1183. const std::string& config) const
  1184. {
  1185. this->GetIncludeDirectoriesImplicit(dirs, target, lang, config);
  1186. }
  1187. void cmLocalGenerator::GetStaticLibraryFlags(std::string& flags,
  1188. std::string const& config,
  1189. std::string const& linkLanguage,
  1190. cmGeneratorTarget* target)
  1191. {
  1192. std::vector<BT<std::string>> tmpFlags =
  1193. this->GetStaticLibraryFlags(config, linkLanguage, target);
  1194. this->AppendFlags(flags, tmpFlags);
  1195. }
  1196. std::vector<BT<std::string>> cmLocalGenerator::GetStaticLibraryFlags(
  1197. std::string const& config, std::string const& linkLanguage,
  1198. cmGeneratorTarget* target)
  1199. {
  1200. const std::string configUpper = cmSystemTools::UpperCase(config);
  1201. std::vector<BT<std::string>> flags;
  1202. if (linkLanguage != "Swift") {
  1203. std::string staticLibFlags;
  1204. this->AppendFlags(
  1205. staticLibFlags,
  1206. this->Makefile->GetSafeDefinition("CMAKE_STATIC_LINKER_FLAGS"));
  1207. if (!configUpper.empty()) {
  1208. std::string name = "CMAKE_STATIC_LINKER_FLAGS_" + configUpper;
  1209. this->AppendFlags(staticLibFlags,
  1210. this->Makefile->GetSafeDefinition(name));
  1211. }
  1212. if (!staticLibFlags.empty()) {
  1213. flags.emplace_back(std::move(staticLibFlags));
  1214. }
  1215. }
  1216. std::string staticLibFlags;
  1217. this->AppendFlags(staticLibFlags,
  1218. target->GetSafeProperty("STATIC_LIBRARY_FLAGS"));
  1219. if (!configUpper.empty()) {
  1220. std::string name = "STATIC_LIBRARY_FLAGS_" + configUpper;
  1221. this->AppendFlags(staticLibFlags, target->GetSafeProperty(name));
  1222. }
  1223. if (!staticLibFlags.empty()) {
  1224. flags.emplace_back(std::move(staticLibFlags));
  1225. }
  1226. std::vector<BT<std::string>> staticLibOpts =
  1227. target->GetStaticLibraryLinkOptions(config, linkLanguage);
  1228. // STATIC_LIBRARY_OPTIONS are escaped.
  1229. this->AppendCompileOptions(flags, staticLibOpts);
  1230. return flags;
  1231. }
  1232. void cmLocalGenerator::GetDeviceLinkFlags(
  1233. cmLinkLineComputer& linkLineComputer, const std::string& config,
  1234. std::string& linkLibs, std::string& linkFlags, std::string& frameworkPath,
  1235. std::string& linkPath, cmGeneratorTarget* target)
  1236. {
  1237. cmGeneratorTarget::DeviceLinkSetter setter(*target);
  1238. cmComputeLinkInformation* pcli = target->GetLinkInformation(config);
  1239. if (pcli) {
  1240. // Compute the required device link libraries when
  1241. // resolving gpu lang device symbols
  1242. this->OutputLinkLibraries(pcli, &linkLineComputer, linkLibs, frameworkPath,
  1243. linkPath);
  1244. }
  1245. std::vector<std::string> linkOpts;
  1246. target->GetLinkOptions(linkOpts, config, "CUDA");
  1247. // LINK_OPTIONS are escaped.
  1248. this->AppendCompileOptions(linkFlags, linkOpts);
  1249. }
  1250. void cmLocalGenerator::GetTargetFlags(
  1251. cmLinkLineComputer* linkLineComputer, const std::string& config,
  1252. std::string& linkLibs, std::string& flags, std::string& linkFlags,
  1253. std::string& frameworkPath, std::string& linkPath, cmGeneratorTarget* target)
  1254. {
  1255. std::vector<BT<std::string>> linkFlagsList;
  1256. std::vector<BT<std::string>> linkPathList;
  1257. std::vector<BT<std::string>> linkLibsList;
  1258. this->GetTargetFlags(linkLineComputer, config, linkLibsList, flags,
  1259. linkFlagsList, frameworkPath, linkPathList, target);
  1260. this->AppendFlags(linkFlags, linkFlagsList);
  1261. this->AppendFlags(linkPath, linkPathList);
  1262. this->AppendFlags(linkLibs, linkLibsList);
  1263. }
  1264. void cmLocalGenerator::GetTargetFlags(
  1265. cmLinkLineComputer* linkLineComputer, const std::string& config,
  1266. std::vector<BT<std::string>>& linkLibs, std::string& flags,
  1267. std::vector<BT<std::string>>& linkFlags, std::string& frameworkPath,
  1268. std::vector<BT<std::string>>& linkPath, cmGeneratorTarget* target)
  1269. {
  1270. const std::string configUpper = cmSystemTools::UpperCase(config);
  1271. cmComputeLinkInformation* pcli = target->GetLinkInformation(config);
  1272. const char* libraryLinkVariable =
  1273. "CMAKE_SHARED_LINKER_FLAGS"; // default to shared library
  1274. const std::string linkLanguage =
  1275. linkLineComputer->GetLinkerLanguage(target, config);
  1276. switch (target->GetType()) {
  1277. case cmStateEnums::STATIC_LIBRARY:
  1278. linkFlags = this->GetStaticLibraryFlags(config, linkLanguage, target);
  1279. break;
  1280. case cmStateEnums::MODULE_LIBRARY:
  1281. libraryLinkVariable = "CMAKE_MODULE_LINKER_FLAGS";
  1282. CM_FALLTHROUGH;
  1283. case cmStateEnums::SHARED_LIBRARY: {
  1284. std::string sharedLibFlags;
  1285. if (linkLanguage != "Swift") {
  1286. sharedLibFlags = cmStrCat(
  1287. this->Makefile->GetSafeDefinition(libraryLinkVariable), ' ');
  1288. if (!configUpper.empty()) {
  1289. std::string build = cmStrCat(libraryLinkVariable, '_', configUpper);
  1290. sharedLibFlags += this->Makefile->GetSafeDefinition(build);
  1291. sharedLibFlags += " ";
  1292. }
  1293. if (this->Makefile->IsOn("WIN32") &&
  1294. !(this->Makefile->IsOn("CYGWIN") ||
  1295. this->Makefile->IsOn("MINGW"))) {
  1296. std::vector<cmSourceFile*> sources;
  1297. target->GetSourceFiles(sources, config);
  1298. std::string defFlag =
  1299. this->Makefile->GetSafeDefinition("CMAKE_LINK_DEF_FILE_FLAG");
  1300. for (cmSourceFile* sf : sources) {
  1301. if (sf->GetExtension() == "def") {
  1302. sharedLibFlags += defFlag;
  1303. sharedLibFlags +=
  1304. this->ConvertToOutputFormat(sf->ResolveFullPath(), SHELL);
  1305. sharedLibFlags += " ";
  1306. }
  1307. }
  1308. }
  1309. }
  1310. cmValue targetLinkFlags = target->GetProperty("LINK_FLAGS");
  1311. if (targetLinkFlags) {
  1312. sharedLibFlags += *targetLinkFlags;
  1313. sharedLibFlags += " ";
  1314. }
  1315. if (!configUpper.empty()) {
  1316. targetLinkFlags =
  1317. target->GetProperty(cmStrCat("LINK_FLAGS_", configUpper));
  1318. if (targetLinkFlags) {
  1319. sharedLibFlags += *targetLinkFlags;
  1320. sharedLibFlags += " ";
  1321. }
  1322. }
  1323. if (!sharedLibFlags.empty()) {
  1324. linkFlags.emplace_back(std::move(sharedLibFlags));
  1325. }
  1326. std::vector<BT<std::string>> linkOpts =
  1327. target->GetLinkOptions(config, linkLanguage);
  1328. // LINK_OPTIONS are escaped.
  1329. this->AppendCompileOptions(linkFlags, linkOpts);
  1330. if (pcli) {
  1331. this->OutputLinkLibraries(pcli, linkLineComputer, linkLibs,
  1332. frameworkPath, linkPath);
  1333. }
  1334. } break;
  1335. case cmStateEnums::EXECUTABLE: {
  1336. std::string exeFlags;
  1337. if (linkLanguage != "Swift") {
  1338. exeFlags = this->Makefile->GetSafeDefinition("CMAKE_EXE_LINKER_FLAGS");
  1339. exeFlags += " ";
  1340. if (!configUpper.empty()) {
  1341. exeFlags += this->Makefile->GetSafeDefinition(
  1342. cmStrCat("CMAKE_EXE_LINKER_FLAGS_", configUpper));
  1343. exeFlags += " ";
  1344. }
  1345. if (linkLanguage.empty()) {
  1346. cmSystemTools::Error(
  1347. "CMake can not determine linker language for target: " +
  1348. target->GetName());
  1349. return;
  1350. }
  1351. if (target->IsWin32Executable(config)) {
  1352. exeFlags += this->Makefile->GetSafeDefinition(
  1353. cmStrCat("CMAKE_", linkLanguage, "_CREATE_WIN32_EXE"));
  1354. exeFlags += " ";
  1355. } else {
  1356. exeFlags += this->Makefile->GetSafeDefinition(
  1357. cmStrCat("CMAKE_", linkLanguage, "_CREATE_CONSOLE_EXE"));
  1358. exeFlags += " ";
  1359. }
  1360. if (target->IsExecutableWithExports()) {
  1361. exeFlags += this->Makefile->GetSafeDefinition(
  1362. cmStrCat("CMAKE_EXE_EXPORTS_", linkLanguage, "_FLAG"));
  1363. exeFlags += " ";
  1364. }
  1365. }
  1366. this->AddLanguageFlagsForLinking(flags, target, linkLanguage, config);
  1367. if (pcli) {
  1368. this->OutputLinkLibraries(pcli, linkLineComputer, linkLibs,
  1369. frameworkPath, linkPath);
  1370. }
  1371. if (this->Makefile->IsOn("BUILD_SHARED_LIBS")) {
  1372. std::string sFlagVar = "CMAKE_SHARED_BUILD_" + linkLanguage + "_FLAGS";
  1373. exeFlags += this->Makefile->GetSafeDefinition(sFlagVar);
  1374. exeFlags += " ";
  1375. }
  1376. std::string cmp0065Flags =
  1377. this->GetLinkLibsCMP0065(linkLanguage, *target);
  1378. if (!cmp0065Flags.empty()) {
  1379. exeFlags += cmp0065Flags;
  1380. exeFlags += " ";
  1381. }
  1382. cmValue targetLinkFlags = target->GetProperty("LINK_FLAGS");
  1383. if (targetLinkFlags) {
  1384. exeFlags += *targetLinkFlags;
  1385. exeFlags += " ";
  1386. }
  1387. if (!configUpper.empty()) {
  1388. targetLinkFlags =
  1389. target->GetProperty(cmStrCat("LINK_FLAGS_", configUpper));
  1390. if (targetLinkFlags) {
  1391. exeFlags += *targetLinkFlags;
  1392. exeFlags += " ";
  1393. }
  1394. }
  1395. if (!exeFlags.empty()) {
  1396. linkFlags.emplace_back(std::move(exeFlags));
  1397. }
  1398. std::vector<BT<std::string>> linkOpts =
  1399. target->GetLinkOptions(config, linkLanguage);
  1400. // LINK_OPTIONS are escaped.
  1401. this->AppendCompileOptions(linkFlags, linkOpts);
  1402. } break;
  1403. default:
  1404. break;
  1405. }
  1406. std::string extraLinkFlags;
  1407. this->AppendPositionIndependentLinkerFlags(extraLinkFlags, target, config,
  1408. linkLanguage);
  1409. this->AppendIPOLinkerFlags(extraLinkFlags, target, config, linkLanguage);
  1410. if (!extraLinkFlags.empty()) {
  1411. linkFlags.emplace_back(std::move(extraLinkFlags));
  1412. }
  1413. }
  1414. void cmLocalGenerator::GetTargetCompileFlags(cmGeneratorTarget* target,
  1415. std::string const& config,
  1416. std::string const& lang,
  1417. std::string& flags,
  1418. std::string const& arch)
  1419. {
  1420. std::vector<BT<std::string>> tmpFlags =
  1421. this->GetTargetCompileFlags(target, config, lang, arch);
  1422. this->AppendFlags(flags, tmpFlags);
  1423. }
  1424. std::vector<BT<std::string>> cmLocalGenerator::GetTargetCompileFlags(
  1425. cmGeneratorTarget* target, std::string const& config,
  1426. std::string const& lang, std::string const& arch)
  1427. {
  1428. std::vector<BT<std::string>> flags;
  1429. std::string compileFlags;
  1430. cmMakefile* mf = this->GetMakefile();
  1431. // Add language-specific flags.
  1432. this->AddLanguageFlags(compileFlags, target, lang, config);
  1433. if (target->IsIPOEnabled(lang, config)) {
  1434. this->AppendFeatureOptions(compileFlags, lang, "IPO");
  1435. }
  1436. this->AddArchitectureFlags(compileFlags, target, lang, config, arch);
  1437. if (lang == "Fortran") {
  1438. this->AppendFlags(compileFlags,
  1439. this->GetTargetFortranFlags(target, config));
  1440. }
  1441. this->AddCMP0018Flags(compileFlags, target, lang, config);
  1442. this->AddVisibilityPresetFlags(compileFlags, target, lang);
  1443. this->AppendFlags(compileFlags, mf->GetDefineFlags());
  1444. this->AppendFlags(compileFlags,
  1445. this->GetFrameworkFlags(lang, config, target));
  1446. if (!compileFlags.empty()) {
  1447. flags.emplace_back(std::move(compileFlags));
  1448. }
  1449. this->AddCompileOptions(flags, target, lang, config);
  1450. return flags;
  1451. }
  1452. static std::string GetFrameworkFlags(const std::string& lang,
  1453. const std::string& config,
  1454. cmGeneratorTarget* target)
  1455. {
  1456. cmLocalGenerator* lg = target->GetLocalGenerator();
  1457. cmMakefile* mf = lg->GetMakefile();
  1458. if (!mf->IsOn("APPLE")) {
  1459. return std::string();
  1460. }
  1461. std::string fwSearchFlagVar = "CMAKE_" + lang + "_FRAMEWORK_SEARCH_FLAG";
  1462. cmValue fwSearchFlag = mf->GetDefinition(fwSearchFlagVar);
  1463. if (!cmNonempty(fwSearchFlag)) {
  1464. return std::string();
  1465. }
  1466. std::set<std::string> emitted;
  1467. #ifdef __APPLE__ /* don't insert this when crosscompiling e.g. to iphone */
  1468. emitted.insert("/System/Library/Frameworks");
  1469. #endif
  1470. std::vector<std::string> includes;
  1471. lg->GetIncludeDirectories(includes, target, "C", config);
  1472. // check all include directories for frameworks as this
  1473. // will already have added a -F for the framework
  1474. for (std::string const& include : includes) {
  1475. if (lg->GetGlobalGenerator()->NameResolvesToFramework(include)) {
  1476. std::string frameworkDir = cmStrCat(include, "/../");
  1477. frameworkDir = cmSystemTools::CollapseFullPath(frameworkDir);
  1478. emitted.insert(frameworkDir);
  1479. }
  1480. }
  1481. std::string flags;
  1482. if (cmComputeLinkInformation* cli = target->GetLinkInformation(config)) {
  1483. std::vector<std::string> const& frameworks = cli->GetFrameworkPaths();
  1484. for (std::string const& framework : frameworks) {
  1485. if (emitted.insert(framework).second) {
  1486. flags += *fwSearchFlag;
  1487. flags +=
  1488. lg->ConvertToOutputFormat(framework, cmOutputConverter::SHELL);
  1489. flags += " ";
  1490. }
  1491. }
  1492. }
  1493. return flags;
  1494. }
  1495. std::string cmLocalGenerator::GetFrameworkFlags(std::string const& l,
  1496. std::string const& config,
  1497. cmGeneratorTarget* target)
  1498. {
  1499. return ::GetFrameworkFlags(l, config, target);
  1500. }
  1501. void cmLocalGenerator::GetTargetDefines(cmGeneratorTarget const* target,
  1502. std::string const& config,
  1503. std::string const& lang,
  1504. std::set<std::string>& defines) const
  1505. {
  1506. std::set<BT<std::string>> tmp = this->GetTargetDefines(target, config, lang);
  1507. for (BT<std::string> const& v : tmp) {
  1508. defines.emplace(v.Value);
  1509. }
  1510. }
  1511. std::set<BT<std::string>> cmLocalGenerator::GetTargetDefines(
  1512. cmGeneratorTarget const* target, std::string const& config,
  1513. std::string const& lang) const
  1514. {
  1515. std::set<BT<std::string>> defines;
  1516. // Add the export symbol definition for shared library objects.
  1517. if (const std::string* exportMacro = target->GetExportMacro()) {
  1518. this->AppendDefines(defines, *exportMacro);
  1519. }
  1520. // Add preprocessor definitions for this target and configuration.
  1521. std::vector<BT<std::string>> targetDefines =
  1522. target->GetCompileDefinitions(config, lang);
  1523. this->AppendDefines(defines, targetDefines);
  1524. return defines;
  1525. }
  1526. std::string cmLocalGenerator::GetTargetFortranFlags(
  1527. cmGeneratorTarget const* /*unused*/, std::string const& /*unused*/)
  1528. {
  1529. // Implemented by specific generators that override this.
  1530. return std::string();
  1531. }
  1532. /**
  1533. * Output the linking rules on a command line. For executables,
  1534. * targetLibrary should be a NULL pointer. For libraries, it should point
  1535. * to the name of the library. This will not link a library against itself.
  1536. */
  1537. void cmLocalGenerator::OutputLinkLibraries(
  1538. cmComputeLinkInformation* pcli, cmLinkLineComputer* linkLineComputer,
  1539. std::string& linkLibraries, std::string& frameworkPath,
  1540. std::string& linkPath)
  1541. {
  1542. std::vector<BT<std::string>> linkLibrariesList;
  1543. std::vector<BT<std::string>> linkPathList;
  1544. this->OutputLinkLibraries(pcli, linkLineComputer, linkLibrariesList,
  1545. frameworkPath, linkPathList);
  1546. pcli->AppendValues(linkLibraries, linkLibrariesList);
  1547. pcli->AppendValues(linkPath, linkPathList);
  1548. }
  1549. void cmLocalGenerator::OutputLinkLibraries(
  1550. cmComputeLinkInformation* pcli, cmLinkLineComputer* linkLineComputer,
  1551. std::vector<BT<std::string>>& linkLibraries, std::string& frameworkPath,
  1552. std::vector<BT<std::string>>& linkPath)
  1553. {
  1554. cmComputeLinkInformation& cli = *pcli;
  1555. std::string linkLanguage = cli.GetLinkLanguage();
  1556. std::string libPathFlag;
  1557. if (cmValue value = this->Makefile->GetDefinition(
  1558. "CMAKE_" + cli.GetLinkLanguage() + "_LIBRARY_PATH_FLAG")) {
  1559. libPathFlag = *value;
  1560. } else {
  1561. libPathFlag =
  1562. this->Makefile->GetRequiredDefinition("CMAKE_LIBRARY_PATH_FLAG");
  1563. }
  1564. std::string libPathTerminator;
  1565. if (cmValue value = this->Makefile->GetDefinition(
  1566. "CMAKE_" + cli.GetLinkLanguage() + "_LIBRARY_PATH_TERMINATOR")) {
  1567. libPathTerminator = *value;
  1568. } else {
  1569. libPathTerminator =
  1570. this->Makefile->GetRequiredDefinition("CMAKE_LIBRARY_PATH_TERMINATOR");
  1571. }
  1572. // Add standard libraries for this language.
  1573. std::string stdLibString = this->Makefile->GetSafeDefinition(
  1574. cmStrCat("CMAKE_", cli.GetLinkLanguage(), "_STANDARD_LIBRARIES"));
  1575. // Append the framework search path flags.
  1576. std::string fwSearchFlag = this->Makefile->GetSafeDefinition(
  1577. cmStrCat("CMAKE_", linkLanguage, "_FRAMEWORK_SEARCH_FLAG"));
  1578. frameworkPath = linkLineComputer->ComputeFrameworkPath(cli, fwSearchFlag);
  1579. linkLineComputer->ComputeLinkPath(cli, libPathFlag, libPathTerminator,
  1580. linkPath);
  1581. linkLineComputer->ComputeLinkLibraries(cli, stdLibString, linkLibraries);
  1582. }
  1583. std::string cmLocalGenerator::GetLinkLibsCMP0065(
  1584. std::string const& linkLanguage, cmGeneratorTarget& tgt) const
  1585. {
  1586. std::string linkFlags;
  1587. // Flags to link an executable to shared libraries.
  1588. if (tgt.GetType() == cmStateEnums::EXECUTABLE &&
  1589. this->StateSnapshot.GetState()->GetGlobalPropertyAsBool(
  1590. "TARGET_SUPPORTS_SHARED_LIBS")) {
  1591. bool add_shlib_flags = false;
  1592. switch (tgt.GetPolicyStatusCMP0065()) {
  1593. case cmPolicies::WARN:
  1594. if (!tgt.GetPropertyAsBool("ENABLE_EXPORTS") &&
  1595. this->Makefile->PolicyOptionalWarningEnabled(
  1596. "CMAKE_POLICY_WARNING_CMP0065")) {
  1597. std::ostringstream w;
  1598. /* clang-format off */
  1599. w << cmPolicies::GetPolicyWarning(cmPolicies::CMP0065) << "\n"
  1600. "For compatibility with older versions of CMake, "
  1601. "additional flags may be added to export symbols on all "
  1602. "executables regardless of their ENABLE_EXPORTS property.";
  1603. /* clang-format on */
  1604. this->IssueMessage(MessageType::AUTHOR_WARNING, w.str());
  1605. }
  1606. CM_FALLTHROUGH;
  1607. case cmPolicies::OLD:
  1608. // OLD behavior is to always add the flags, except on AIX where
  1609. // we compute symbol exports if ENABLE_EXPORTS is on.
  1610. add_shlib_flags =
  1611. !(tgt.Target->IsAIX() && tgt.GetPropertyAsBool("ENABLE_EXPORTS"));
  1612. break;
  1613. case cmPolicies::REQUIRED_IF_USED:
  1614. case cmPolicies::REQUIRED_ALWAYS:
  1615. this->IssueMessage(
  1616. MessageType::FATAL_ERROR,
  1617. cmPolicies::GetRequiredPolicyError(cmPolicies::CMP0065));
  1618. CM_FALLTHROUGH;
  1619. case cmPolicies::NEW:
  1620. // NEW behavior is to only add the flags if ENABLE_EXPORTS is on,
  1621. // except on AIX where we compute symbol exports.
  1622. add_shlib_flags =
  1623. !tgt.Target->IsAIX() && tgt.GetPropertyAsBool("ENABLE_EXPORTS");
  1624. break;
  1625. }
  1626. if (add_shlib_flags) {
  1627. linkFlags = this->Makefile->GetSafeDefinition(
  1628. cmStrCat("CMAKE_SHARED_LIBRARY_LINK_", linkLanguage, "_FLAGS"));
  1629. }
  1630. }
  1631. return linkFlags;
  1632. }
  1633. bool cmLocalGenerator::AllAppleArchSysrootsAreTheSame(
  1634. const std::vector<std::string>& archs, cmValue sysroot)
  1635. {
  1636. if (!sysroot) {
  1637. return false;
  1638. }
  1639. return std::all_of(archs.begin(), archs.end(),
  1640. [this, sysroot](std::string const& arch) -> bool {
  1641. std::string const& archSysroot =
  1642. this->AppleArchSysroots[arch];
  1643. return cmIsOff(archSysroot) || sysroot == archSysroot;
  1644. });
  1645. }
  1646. void cmLocalGenerator::AddArchitectureFlags(std::string& flags,
  1647. cmGeneratorTarget const* target,
  1648. const std::string& lang,
  1649. const std::string& config,
  1650. const std::string& filterArch)
  1651. {
  1652. // Only add Apple specific flags on Apple platforms
  1653. if (this->Makefile->IsOn("APPLE") && this->EmitUniversalBinaryFlags) {
  1654. std::vector<std::string> archs;
  1655. target->GetAppleArchs(config, archs);
  1656. if (!archs.empty() &&
  1657. (lang == "C" || lang == "CXX" || lang == "OBJC" || lang == "OBJCXX" ||
  1658. lang == "ASM")) {
  1659. for (std::string const& arch : archs) {
  1660. if (filterArch.empty() || filterArch == arch) {
  1661. flags += " -arch ";
  1662. flags += arch;
  1663. }
  1664. }
  1665. }
  1666. cmValue sysroot = this->Makefile->GetDefinition("CMAKE_OSX_SYSROOT");
  1667. if (sysroot && *sysroot == "/") {
  1668. sysroot = nullptr;
  1669. }
  1670. std::string sysrootFlagVar = "CMAKE_" + lang + "_SYSROOT_FLAG";
  1671. cmValue sysrootFlag = this->Makefile->GetDefinition(sysrootFlagVar);
  1672. if (cmNonempty(sysrootFlag)) {
  1673. if (!this->AppleArchSysroots.empty() &&
  1674. !this->AllAppleArchSysrootsAreTheSame(archs, sysroot)) {
  1675. for (std::string const& arch : archs) {
  1676. std::string const& archSysroot = this->AppleArchSysroots[arch];
  1677. if (cmIsOff(archSysroot)) {
  1678. continue;
  1679. }
  1680. if (filterArch.empty() || filterArch == arch) {
  1681. flags += " -Xarch_" + arch + " ";
  1682. // Combine sysroot flag and path to work with -Xarch
  1683. std::string arch_sysroot = *sysrootFlag + archSysroot;
  1684. flags += this->ConvertToOutputFormat(arch_sysroot, SHELL);
  1685. }
  1686. }
  1687. } else if (cmNonempty(sysroot)) {
  1688. flags += " ";
  1689. flags += *sysrootFlag;
  1690. flags += " ";
  1691. flags += this->ConvertToOutputFormat(*sysroot, SHELL);
  1692. }
  1693. }
  1694. cmValue deploymentTarget =
  1695. this->Makefile->GetDefinition("CMAKE_OSX_DEPLOYMENT_TARGET");
  1696. std::string deploymentTargetFlagVar =
  1697. "CMAKE_" + lang + "_OSX_DEPLOYMENT_TARGET_FLAG";
  1698. cmValue deploymentTargetFlag =
  1699. this->Makefile->GetDefinition(deploymentTargetFlagVar);
  1700. if (cmNonempty(deploymentTargetFlag) && cmNonempty(deploymentTarget)) {
  1701. flags += " ";
  1702. flags += *deploymentTargetFlag;
  1703. flags += *deploymentTarget;
  1704. }
  1705. }
  1706. }
  1707. void cmLocalGenerator::AddLanguageFlags(std::string& flags,
  1708. cmGeneratorTarget const* target,
  1709. const std::string& lang,
  1710. const std::string& config)
  1711. {
  1712. // Add language-specific flags.
  1713. this->AddConfigVariableFlags(flags, cmStrCat("CMAKE_", lang, "_FLAGS"),
  1714. config);
  1715. std::string compiler = this->Makefile->GetSafeDefinition(
  1716. cmStrCat("CMAKE_", lang, "_COMPILER_ID"));
  1717. std::string compilerSimulateId = this->Makefile->GetSafeDefinition(
  1718. cmStrCat("CMAKE_", lang, "_SIMULATE_ID"));
  1719. if (lang == "Swift") {
  1720. if (cmValue v = target->GetProperty("Swift_LANGUAGE_VERSION")) {
  1721. if (cmSystemTools::VersionCompare(
  1722. cmSystemTools::OP_GREATER_EQUAL,
  1723. this->Makefile->GetDefinition("CMAKE_Swift_COMPILER_VERSION"),
  1724. "4.2")) {
  1725. this->AppendFlags(flags, "-swift-version " + *v);
  1726. }
  1727. }
  1728. } else if (lang == "CUDA") {
  1729. target->AddCUDAArchitectureFlags(flags);
  1730. target->AddCUDAToolkitFlags(flags);
  1731. } else if (lang == "ISPC") {
  1732. target->AddISPCTargetFlags(flags);
  1733. } else if (lang == "RC" &&
  1734. this->Makefile->GetSafeDefinition("CMAKE_RC_COMPILER")
  1735. .find("llvm-rc") != std::string::npos) {
  1736. compiler = this->Makefile->GetSafeDefinition("CMAKE_C_COMPILER_ID");
  1737. if (!compiler.empty()) {
  1738. compilerSimulateId =
  1739. this->Makefile->GetSafeDefinition("CMAKE_C_SIMULATE_ID");
  1740. } else {
  1741. compiler = this->Makefile->GetSafeDefinition("CMAKE_CXX_COMPILER_ID");
  1742. compilerSimulateId =
  1743. this->Makefile->GetSafeDefinition("CMAKE_CXX_SIMULATE_ID");
  1744. }
  1745. } else if (lang == "HIP") {
  1746. target->AddHIPArchitectureFlags(flags);
  1747. }
  1748. // Add VFS Overlay for Clang compilers
  1749. if (compiler == "Clang") {
  1750. if (cmValue vfsOverlay =
  1751. this->Makefile->GetDefinition("CMAKE_CLANG_VFS_OVERLAY")) {
  1752. if (compilerSimulateId == "MSVC") {
  1753. this->AppendCompileOptions(
  1754. flags,
  1755. std::vector<std::string>{ "-Xclang", "-ivfsoverlay", "-Xclang",
  1756. *vfsOverlay });
  1757. } else {
  1758. this->AppendCompileOptions(
  1759. flags, std::vector<std::string>{ "-ivfsoverlay", *vfsOverlay });
  1760. }
  1761. }
  1762. }
  1763. // Add MSVC runtime library flags. This is activated by the presence
  1764. // of a default selection whether or not it is overridden by a property.
  1765. cmValue msvcRuntimeLibraryDefault =
  1766. this->Makefile->GetDefinition("CMAKE_MSVC_RUNTIME_LIBRARY_DEFAULT");
  1767. if (cmNonempty(msvcRuntimeLibraryDefault)) {
  1768. cmValue msvcRuntimeLibraryValue =
  1769. target->GetProperty("MSVC_RUNTIME_LIBRARY");
  1770. if (!msvcRuntimeLibraryValue) {
  1771. msvcRuntimeLibraryValue = msvcRuntimeLibraryDefault;
  1772. }
  1773. std::string const msvcRuntimeLibrary = cmGeneratorExpression::Evaluate(
  1774. *msvcRuntimeLibraryValue, this, config, target);
  1775. if (!msvcRuntimeLibrary.empty()) {
  1776. if (cmValue msvcRuntimeLibraryOptions = this->Makefile->GetDefinition(
  1777. "CMAKE_" + lang + "_COMPILE_OPTIONS_MSVC_RUNTIME_LIBRARY_" +
  1778. msvcRuntimeLibrary)) {
  1779. this->AppendCompileOptions(flags, *msvcRuntimeLibraryOptions);
  1780. } else if ((this->Makefile->GetSafeDefinition(
  1781. "CMAKE_" + lang + "_COMPILER_ID") == "MSVC" ||
  1782. this->Makefile->GetSafeDefinition(
  1783. "CMAKE_" + lang + "_SIMULATE_ID") == "MSVC") &&
  1784. !cmSystemTools::GetErrorOccuredFlag()) {
  1785. // The compiler uses the MSVC ABI so it needs a known runtime library.
  1786. this->IssueMessage(MessageType::FATAL_ERROR,
  1787. "MSVC_RUNTIME_LIBRARY value '" +
  1788. msvcRuntimeLibrary + "' not known for this " +
  1789. lang + " compiler.");
  1790. }
  1791. }
  1792. }
  1793. }
  1794. void cmLocalGenerator::AddLanguageFlagsForLinking(
  1795. std::string& flags, cmGeneratorTarget const* target, const std::string& lang,
  1796. const std::string& config)
  1797. {
  1798. if (this->Makefile->IsOn("CMAKE_" + lang +
  1799. "_LINK_WITH_STANDARD_COMPILE_OPTION")) {
  1800. // This toolchain requires use of the language standard flag
  1801. // when linking in order to use the matching standard library.
  1802. // FIXME: If CMake gains an abstraction for standard library
  1803. // selection, this will have to be reconciled with it.
  1804. this->AddCompilerRequirementFlag(flags, target, lang, config);
  1805. }
  1806. this->AddLanguageFlags(flags, target, lang, config);
  1807. if (target->IsIPOEnabled(lang, config)) {
  1808. this->AppendFeatureOptions(flags, lang, "IPO");
  1809. }
  1810. }
  1811. cmGeneratorTarget* cmLocalGenerator::FindGeneratorTargetToUse(
  1812. const std::string& name) const
  1813. {
  1814. auto imported = this->ImportedGeneratorTargets.find(name);
  1815. if (imported != this->ImportedGeneratorTargets.end()) {
  1816. return imported->second;
  1817. }
  1818. // find local alias to imported target
  1819. auto aliased = this->AliasTargets.find(name);
  1820. if (aliased != this->AliasTargets.end()) {
  1821. imported = this->ImportedGeneratorTargets.find(aliased->second);
  1822. if (imported != this->ImportedGeneratorTargets.end()) {
  1823. return imported->second;
  1824. }
  1825. }
  1826. if (cmGeneratorTarget* t = this->FindLocalNonAliasGeneratorTarget(name)) {
  1827. return t;
  1828. }
  1829. return this->GetGlobalGenerator()->FindGeneratorTarget(name);
  1830. }
  1831. bool cmLocalGenerator::GetRealDependency(const std::string& inName,
  1832. const std::string& config,
  1833. std::string& dep)
  1834. {
  1835. // Older CMake code may specify the dependency using the target
  1836. // output file rather than the target name. Such code would have
  1837. // been written before there was support for target properties that
  1838. // modify the name so stripping down to just the file name should
  1839. // produce the target name in this case.
  1840. std::string name = cmSystemTools::GetFilenameName(inName);
  1841. // If the input name is the empty string, there is no real
  1842. // dependency. Short-circuit the other checks:
  1843. if (name.empty()) {
  1844. return false;
  1845. }
  1846. if (cmSystemTools::GetFilenameLastExtension(name) == ".exe") {
  1847. name = cmSystemTools::GetFilenameWithoutLastExtension(name);
  1848. }
  1849. // Look for a CMake target with the given name.
  1850. if (cmGeneratorTarget* target = this->FindGeneratorTargetToUse(name)) {
  1851. // make sure it is not just a coincidence that the target name
  1852. // found is part of the inName
  1853. if (cmSystemTools::FileIsFullPath(inName)) {
  1854. std::string tLocation;
  1855. if (target->GetType() >= cmStateEnums::EXECUTABLE &&
  1856. target->GetType() <= cmStateEnums::MODULE_LIBRARY) {
  1857. tLocation = target->GetLocation(config);
  1858. tLocation = cmSystemTools::GetFilenamePath(tLocation);
  1859. tLocation = cmSystemTools::CollapseFullPath(tLocation);
  1860. }
  1861. std::string depLocation =
  1862. cmSystemTools::GetFilenamePath(std::string(inName));
  1863. depLocation = cmSystemTools::CollapseFullPath(depLocation);
  1864. if (depLocation != tLocation) {
  1865. // it is a full path to a depend that has the same name
  1866. // as a target but is in a different location so do not use
  1867. // the target as the depend
  1868. dep = inName;
  1869. return true;
  1870. }
  1871. }
  1872. switch (target->GetType()) {
  1873. case cmStateEnums::EXECUTABLE:
  1874. case cmStateEnums::STATIC_LIBRARY:
  1875. case cmStateEnums::SHARED_LIBRARY:
  1876. case cmStateEnums::MODULE_LIBRARY:
  1877. case cmStateEnums::UNKNOWN_LIBRARY:
  1878. dep = target->GetFullPath(config, cmStateEnums::RuntimeBinaryArtifact,
  1879. /*realname=*/true);
  1880. return true;
  1881. case cmStateEnums::OBJECT_LIBRARY:
  1882. // An object library has no single file on which to depend.
  1883. // This was listed to get the target-level dependency.
  1884. case cmStateEnums::INTERFACE_LIBRARY:
  1885. // An interface library has no file on which to depend.
  1886. // This was listed to get the target-level dependency.
  1887. case cmStateEnums::UTILITY:
  1888. case cmStateEnums::GLOBAL_TARGET:
  1889. // A utility target has no file on which to depend. This was listed
  1890. // only to get the target-level dependency.
  1891. return false;
  1892. }
  1893. }
  1894. // The name was not that of a CMake target. It must name a file.
  1895. if (cmSystemTools::FileIsFullPath(inName)) {
  1896. // This is a full path. Return it as given.
  1897. dep = inName;
  1898. return true;
  1899. }
  1900. // Check for a source file in this directory that matches the
  1901. // dependency.
  1902. if (cmSourceFile* sf = this->Makefile->GetSource(inName)) {
  1903. dep = sf->ResolveFullPath();
  1904. return true;
  1905. }
  1906. // Treat the name as relative to the source directory in which it
  1907. // was given.
  1908. dep = cmStrCat(this->GetCurrentSourceDirectory(), '/', inName);
  1909. // If the in-source path does not exist, assume it instead lives in the
  1910. // binary directory.
  1911. if (!cmSystemTools::FileExists(dep)) {
  1912. dep = cmStrCat(this->GetCurrentBinaryDirectory(), '/', inName);
  1913. }
  1914. dep = cmSystemTools::CollapseFullPath(dep, this->GetBinaryDirectory());
  1915. return true;
  1916. }
  1917. void cmLocalGenerator::AddSharedFlags(std::string& flags,
  1918. const std::string& lang, bool shared)
  1919. {
  1920. std::string flagsVar;
  1921. // Add flags for dealing with shared libraries for this language.
  1922. if (shared) {
  1923. this->AppendFlags(flags,
  1924. this->Makefile->GetSafeDefinition(
  1925. cmStrCat("CMAKE_SHARED_LIBRARY_", lang, "_FLAGS")));
  1926. }
  1927. }
  1928. void cmLocalGenerator::AddCompilerRequirementFlag(
  1929. std::string& flags, cmGeneratorTarget const* target, const std::string& lang,
  1930. const std::string& config)
  1931. {
  1932. cmStandardLevelResolver standardResolver(this->Makefile);
  1933. std::string const& optionFlagDef =
  1934. standardResolver.GetCompileOptionDef(target, lang, config);
  1935. if (!optionFlagDef.empty()) {
  1936. cmValue opt = target->Target->GetMakefile()->GetDefinition(optionFlagDef);
  1937. if (opt) {
  1938. std::vector<std::string> optVec = cmExpandedList(*opt);
  1939. for (std::string const& i : optVec) {
  1940. this->AppendFlagEscape(flags, i);
  1941. }
  1942. }
  1943. }
  1944. }
  1945. static void AddVisibilityCompileOption(std::string& flags,
  1946. cmGeneratorTarget const* target,
  1947. cmLocalGenerator* lg,
  1948. const std::string& lang,
  1949. std::string* warnCMP0063)
  1950. {
  1951. std::string compileOption = "CMAKE_" + lang + "_COMPILE_OPTIONS_VISIBILITY";
  1952. cmValue opt = lg->GetMakefile()->GetDefinition(compileOption);
  1953. if (!opt) {
  1954. return;
  1955. }
  1956. std::string flagDefine = lang + "_VISIBILITY_PRESET";
  1957. cmValue prop = target->GetProperty(flagDefine);
  1958. if (!prop) {
  1959. return;
  1960. }
  1961. if (warnCMP0063) {
  1962. *warnCMP0063 += " " + flagDefine + "\n";
  1963. return;
  1964. }
  1965. if ((*prop != "hidden") && (*prop != "default") && (*prop != "protected") &&
  1966. (*prop != "internal")) {
  1967. std::ostringstream e;
  1968. e << "Target " << target->GetName() << " uses unsupported value \""
  1969. << *prop << "\" for " << flagDefine << "."
  1970. << " The supported values are: default, hidden, protected, and "
  1971. "internal.";
  1972. cmSystemTools::Error(e.str());
  1973. return;
  1974. }
  1975. std::string option = *opt + *prop;
  1976. lg->AppendFlags(flags, option);
  1977. }
  1978. static void AddInlineVisibilityCompileOption(std::string& flags,
  1979. cmGeneratorTarget const* target,
  1980. cmLocalGenerator* lg,
  1981. std::string* warnCMP0063,
  1982. const std::string& lang)
  1983. {
  1984. std::string compileOption =
  1985. cmStrCat("CMAKE_", lang, "_COMPILE_OPTIONS_VISIBILITY_INLINES_HIDDEN");
  1986. cmValue opt = lg->GetMakefile()->GetDefinition(compileOption);
  1987. if (!opt) {
  1988. return;
  1989. }
  1990. bool prop = target->GetPropertyAsBool("VISIBILITY_INLINES_HIDDEN");
  1991. if (!prop) {
  1992. return;
  1993. }
  1994. if (warnCMP0063) {
  1995. *warnCMP0063 += " VISIBILITY_INLINES_HIDDEN\n";
  1996. return;
  1997. }
  1998. lg->AppendFlags(flags, *opt);
  1999. }
  2000. void cmLocalGenerator::AddVisibilityPresetFlags(
  2001. std::string& flags, cmGeneratorTarget const* target, const std::string& lang)
  2002. {
  2003. if (lang.empty()) {
  2004. return;
  2005. }
  2006. std::string warnCMP0063;
  2007. std::string* pWarnCMP0063 = nullptr;
  2008. if (target->GetType() != cmStateEnums::SHARED_LIBRARY &&
  2009. target->GetType() != cmStateEnums::MODULE_LIBRARY &&
  2010. !target->IsExecutableWithExports()) {
  2011. switch (target->GetPolicyStatusCMP0063()) {
  2012. case cmPolicies::OLD:
  2013. return;
  2014. case cmPolicies::WARN:
  2015. pWarnCMP0063 = &warnCMP0063;
  2016. break;
  2017. default:
  2018. break;
  2019. }
  2020. }
  2021. AddVisibilityCompileOption(flags, target, this, lang, pWarnCMP0063);
  2022. if (lang == "CXX" || lang == "OBJCXX") {
  2023. AddInlineVisibilityCompileOption(flags, target, this, pWarnCMP0063, lang);
  2024. }
  2025. if (!warnCMP0063.empty() && this->WarnCMP0063.insert(target).second) {
  2026. std::ostringstream w;
  2027. /* clang-format off */
  2028. w <<
  2029. cmPolicies::GetPolicyWarning(cmPolicies::CMP0063) << "\n"
  2030. "Target \"" << target->GetName() << "\" of "
  2031. "type \"" << cmState::GetTargetTypeName(target->GetType()) << "\" "
  2032. "has the following visibility properties set for " << lang << ":\n" <<
  2033. warnCMP0063 <<
  2034. "For compatibility CMake is not honoring them for this target.";
  2035. /* clang-format on */
  2036. target->GetLocalGenerator()->GetCMakeInstance()->IssueMessage(
  2037. MessageType::AUTHOR_WARNING, w.str(), target->GetBacktrace());
  2038. }
  2039. }
  2040. void cmLocalGenerator::AddCMP0018Flags(std::string& flags,
  2041. cmGeneratorTarget const* target,
  2042. std::string const& lang,
  2043. const std::string& config)
  2044. {
  2045. int targetType = target->GetType();
  2046. bool shared = ((targetType == cmStateEnums::SHARED_LIBRARY) ||
  2047. (targetType == cmStateEnums::MODULE_LIBRARY));
  2048. if (this->GetShouldUseOldFlags(shared, lang)) {
  2049. this->AddSharedFlags(flags, lang, shared);
  2050. } else {
  2051. if (target->GetLinkInterfaceDependentBoolProperty(
  2052. "POSITION_INDEPENDENT_CODE", config)) {
  2053. this->AddPositionIndependentFlags(flags, lang, targetType);
  2054. }
  2055. if (shared) {
  2056. this->AppendFeatureOptions(flags, lang, "DLL");
  2057. }
  2058. }
  2059. }
  2060. bool cmLocalGenerator::GetShouldUseOldFlags(bool shared,
  2061. const std::string& lang) const
  2062. {
  2063. std::string originalFlags =
  2064. this->GlobalGenerator->GetSharedLibFlagsForLanguage(lang);
  2065. if (shared) {
  2066. std::string flagsVar = cmStrCat("CMAKE_SHARED_LIBRARY_", lang, "_FLAGS");
  2067. std::string const& flags = this->Makefile->GetSafeDefinition(flagsVar);
  2068. if (flags != originalFlags) {
  2069. switch (this->GetPolicyStatus(cmPolicies::CMP0018)) {
  2070. case cmPolicies::WARN: {
  2071. std::ostringstream e;
  2072. e << "Variable " << flagsVar
  2073. << " has been modified. CMake "
  2074. "will ignore the POSITION_INDEPENDENT_CODE target property "
  2075. "for "
  2076. "shared libraries and will use the "
  2077. << flagsVar
  2078. << " variable "
  2079. "instead. This may cause errors if the original content of "
  2080. << flagsVar << " was removed.\n"
  2081. << cmPolicies::GetPolicyWarning(cmPolicies::CMP0018);
  2082. this->IssueMessage(MessageType::AUTHOR_WARNING, e.str());
  2083. CM_FALLTHROUGH;
  2084. }
  2085. case cmPolicies::OLD:
  2086. return true;
  2087. case cmPolicies::REQUIRED_IF_USED:
  2088. case cmPolicies::REQUIRED_ALWAYS:
  2089. case cmPolicies::NEW:
  2090. return false;
  2091. }
  2092. }
  2093. }
  2094. return false;
  2095. }
  2096. void cmLocalGenerator::AddPositionIndependentFlags(std::string& flags,
  2097. std::string const& lang,
  2098. int targetType)
  2099. {
  2100. std::string picFlags;
  2101. if (targetType == cmStateEnums::EXECUTABLE) {
  2102. picFlags = this->Makefile->GetSafeDefinition(
  2103. cmStrCat("CMAKE_", lang, "_COMPILE_OPTIONS_PIE"));
  2104. }
  2105. if (picFlags.empty()) {
  2106. picFlags = this->Makefile->GetSafeDefinition(
  2107. cmStrCat("CMAKE_", lang, "_COMPILE_OPTIONS_PIC"));
  2108. }
  2109. if (!picFlags.empty()) {
  2110. std::vector<std::string> options = cmExpandedList(picFlags);
  2111. for (std::string const& o : options) {
  2112. this->AppendFlagEscape(flags, o);
  2113. }
  2114. }
  2115. }
  2116. void cmLocalGenerator::AddConfigVariableFlags(std::string& flags,
  2117. const std::string& var,
  2118. const std::string& config)
  2119. {
  2120. // Add the flags from the variable itself.
  2121. this->AppendFlags(flags, this->Makefile->GetSafeDefinition(var));
  2122. // Add the flags from the build-type specific variable.
  2123. if (!config.empty()) {
  2124. const std::string flagsVar =
  2125. cmStrCat(var, '_', cmSystemTools::UpperCase(config));
  2126. this->AppendFlags(flags, this->Makefile->GetSafeDefinition(flagsVar));
  2127. }
  2128. }
  2129. void cmLocalGenerator::AppendFlags(std::string& flags,
  2130. const std::string& newFlags) const
  2131. {
  2132. bool allSpaces = std::all_of(newFlags.begin(), newFlags.end(), cmIsSpace);
  2133. if (!newFlags.empty() && !allSpaces) {
  2134. if (!flags.empty()) {
  2135. flags += " ";
  2136. }
  2137. flags += newFlags;
  2138. }
  2139. }
  2140. void cmLocalGenerator::AppendFlags(
  2141. std::string& flags, const std::vector<BT<std::string>>& newFlags) const
  2142. {
  2143. for (BT<std::string> const& flag : newFlags) {
  2144. this->AppendFlags(flags, flag.Value);
  2145. }
  2146. }
  2147. void cmLocalGenerator::AppendFlagEscape(std::string& flags,
  2148. const std::string& rawFlag) const
  2149. {
  2150. this->AppendFlags(
  2151. flags,
  2152. this->EscapeForShell(rawFlag, false, false, false, this->IsNinjaMulti()));
  2153. }
  2154. void cmLocalGenerator::AddISPCDependencies(cmGeneratorTarget* target)
  2155. {
  2156. std::vector<std::string> enabledLanguages =
  2157. this->GetState()->GetEnabledLanguages();
  2158. if (std::find(enabledLanguages.begin(), enabledLanguages.end(), "ISPC") ==
  2159. enabledLanguages.end()) {
  2160. return;
  2161. }
  2162. cmValue ispcHeaderSuffixProp = target->GetProperty("ISPC_HEADER_SUFFIX");
  2163. assert(ispcHeaderSuffixProp);
  2164. std::vector<std::string> ispcArchSuffixes =
  2165. detail::ComputeISPCObjectSuffixes(target);
  2166. const bool extra_objects = (ispcArchSuffixes.size() > 1);
  2167. std::vector<std::string> configsList =
  2168. this->Makefile->GetGeneratorConfigs(cmMakefile::IncludeEmptyConfig);
  2169. for (std::string const& config : configsList) {
  2170. std::string rootObjectDir = target->GetObjectDirectory(config);
  2171. std::string headerDir = rootObjectDir;
  2172. if (cmValue prop = target->GetProperty("ISPC_HEADER_DIRECTORY")) {
  2173. headerDir = cmSystemTools::CollapseFullPath(
  2174. cmStrCat(this->GetBinaryDirectory(), '/', *prop));
  2175. }
  2176. std::vector<cmSourceFile*> sources;
  2177. target->GetSourceFiles(sources, config);
  2178. // build up the list of ispc headers and extra objects that this target is
  2179. // generating
  2180. for (cmSourceFile const* sf : sources) {
  2181. // Generate this object file's rule file.
  2182. const std::string& lang = sf->GetLanguage();
  2183. if (lang == "ISPC") {
  2184. std::string const& objectName = target->GetObjectName(sf);
  2185. // Drop both ".obj" and the source file extension
  2186. std::string ispcSource =
  2187. cmSystemTools::GetFilenameWithoutLastExtension(objectName);
  2188. ispcSource =
  2189. cmSystemTools::GetFilenameWithoutLastExtension(ispcSource);
  2190. auto headerPath =
  2191. cmStrCat(headerDir, '/', ispcSource, *ispcHeaderSuffixProp);
  2192. target->AddISPCGeneratedHeader(headerPath, config);
  2193. if (extra_objects) {
  2194. std::vector<std::string> objs = detail::ComputeISPCExtraObjects(
  2195. objectName, rootObjectDir, ispcArchSuffixes);
  2196. target->AddISPCGeneratedObject(std::move(objs), config);
  2197. }
  2198. }
  2199. }
  2200. }
  2201. }
  2202. void cmLocalGenerator::AddPchDependencies(cmGeneratorTarget* target)
  2203. {
  2204. std::vector<std::string> configsList =
  2205. this->Makefile->GetGeneratorConfigs(cmMakefile::IncludeEmptyConfig);
  2206. for (std::string const& config : configsList) {
  2207. // FIXME: Refactor collection of sources to not evaluate object
  2208. // libraries.
  2209. std::vector<cmSourceFile*> sources;
  2210. target->GetSourceFiles(sources, config);
  2211. const std::string configUpper = cmSystemTools::UpperCase(config);
  2212. static const std::array<std::string, 4> langs = { { "C", "CXX", "OBJC",
  2213. "OBJCXX" } };
  2214. bool haveAnyPch = false;
  2215. if (this->GetGlobalGenerator()->IsXcode()) {
  2216. for (const std::string& lang : langs) {
  2217. const std::string pchHeader = target->GetPchHeader(config, lang, "");
  2218. if (!pchHeader.empty()) {
  2219. haveAnyPch = true;
  2220. }
  2221. }
  2222. }
  2223. for (const std::string& lang : langs) {
  2224. auto langSources = std::count_if(
  2225. sources.begin(), sources.end(), [lang](cmSourceFile* sf) {
  2226. return lang == sf->GetLanguage() &&
  2227. !sf->GetProperty("SKIP_PRECOMPILE_HEADERS");
  2228. });
  2229. if (langSources == 0) {
  2230. continue;
  2231. }
  2232. std::vector<std::string> architectures;
  2233. if (!this->GetGlobalGenerator()->IsXcode()) {
  2234. target->GetAppleArchs(config, architectures);
  2235. }
  2236. if (architectures.empty()) {
  2237. architectures.emplace_back();
  2238. } else {
  2239. std::string useMultiArchPch;
  2240. for (const std::string& arch : architectures) {
  2241. const std::string pchHeader =
  2242. target->GetPchHeader(config, lang, arch);
  2243. if (!pchHeader.empty()) {
  2244. useMultiArchPch = cmStrCat(useMultiArchPch, ";-Xarch_", arch,
  2245. ";-include", pchHeader);
  2246. }
  2247. }
  2248. if (!useMultiArchPch.empty()) {
  2249. target->Target->AppendProperty(
  2250. cmStrCat(lang, "_COMPILE_OPTIONS_USE_PCH"),
  2251. cmStrCat("$<$<CONFIG:", config, ">:", useMultiArchPch, ">"));
  2252. }
  2253. }
  2254. for (const std::string& arch : architectures) {
  2255. const std::string pchSource = target->GetPchSource(config, lang, arch);
  2256. const std::string pchHeader = target->GetPchHeader(config, lang, arch);
  2257. if (pchSource.empty() || pchHeader.empty()) {
  2258. if (this->GetGlobalGenerator()->IsXcode() && haveAnyPch) {
  2259. for (auto* sf : sources) {
  2260. sf->SetProperty("SKIP_PRECOMPILE_HEADERS", "ON");
  2261. }
  2262. }
  2263. continue;
  2264. }
  2265. cmValue pchExtension =
  2266. this->Makefile->GetDefinition("CMAKE_PCH_EXTENSION");
  2267. if (pchExtension.IsEmpty()) {
  2268. continue;
  2269. }
  2270. cmValue ReuseFrom =
  2271. target->GetProperty("PRECOMPILE_HEADERS_REUSE_FROM");
  2272. auto* pch_sf = this->Makefile->GetOrCreateSource(
  2273. pchSource, false, cmSourceFileLocationKind::Known);
  2274. if (!this->GetGlobalGenerator()->IsXcode()) {
  2275. if (!ReuseFrom) {
  2276. target->AddSource(pchSource, true);
  2277. }
  2278. const std::string pchFile = target->GetPchFile(config, lang, arch);
  2279. // Exclude the pch files from linking
  2280. if (this->Makefile->IsOn("CMAKE_LINK_PCH")) {
  2281. if (!ReuseFrom) {
  2282. pch_sf->AppendProperty(
  2283. "OBJECT_OUTPUTS",
  2284. cmStrCat("$<$<CONFIG:", config, ">:", pchFile, ">"));
  2285. } else {
  2286. auto* reuseTarget =
  2287. this->GlobalGenerator->FindGeneratorTarget(*ReuseFrom);
  2288. if (this->Makefile->IsOn("CMAKE_PCH_COPY_COMPILE_PDB")) {
  2289. const std::string compilerId =
  2290. this->Makefile->GetSafeDefinition(
  2291. cmStrCat("CMAKE_", lang, "_COMPILER_ID"));
  2292. const std::string compilerVersion =
  2293. this->Makefile->GetSafeDefinition(
  2294. cmStrCat("CMAKE_", lang, "_COMPILER_VERSION"));
  2295. const std::string langFlags =
  2296. this->Makefile->GetSafeDefinition(
  2297. cmStrCat("CMAKE_", lang, "_FLAGS_", configUpper));
  2298. bool editAndContinueDebugInfo =
  2299. langFlags.find("/ZI") != std::string::npos ||
  2300. langFlags.find("-ZI") != std::string::npos;
  2301. bool enableDebuggingInformation =
  2302. langFlags.find("/Zi") != std::string::npos ||
  2303. langFlags.find("-Zi") != std::string::npos;
  2304. // MSVC 2008 is producing both .pdb and .idb files with /Zi.
  2305. bool msvc2008OrLess =
  2306. cmSystemTools::VersionCompare(cmSystemTools::OP_LESS,
  2307. compilerVersion, "16.0") &&
  2308. compilerId == "MSVC";
  2309. // but not when used via toolset -Tv90
  2310. if (this->Makefile->GetSafeDefinition(
  2311. "CMAKE_VS_PLATFORM_TOOLSET") == "v90") {
  2312. msvc2008OrLess = false;
  2313. }
  2314. if (editAndContinueDebugInfo || msvc2008OrLess) {
  2315. this->CopyPchCompilePdb(config, target, *ReuseFrom,
  2316. reuseTarget, { ".pdb", ".idb" });
  2317. } else if (enableDebuggingInformation) {
  2318. this->CopyPchCompilePdb(config, target, *ReuseFrom,
  2319. reuseTarget, { ".pdb" });
  2320. }
  2321. }
  2322. // Link to the pch object file
  2323. std::string pchSourceObj =
  2324. reuseTarget->GetPchFileObject(config, lang, arch);
  2325. if (target->GetType() != cmStateEnums::OBJECT_LIBRARY) {
  2326. std::string linkerProperty = "LINK_FLAGS_";
  2327. if (target->GetType() == cmStateEnums::STATIC_LIBRARY) {
  2328. linkerProperty = "STATIC_LIBRARY_FLAGS_";
  2329. }
  2330. target->Target->AppendProperty(
  2331. cmStrCat(linkerProperty, configUpper),
  2332. cmStrCat(" ",
  2333. this->ConvertToOutputFormat(pchSourceObj, SHELL)),
  2334. true);
  2335. } else if (reuseTarget->GetType() ==
  2336. cmStateEnums::OBJECT_LIBRARY) {
  2337. // FIXME: This can propagate more than one level, unlike
  2338. // the rest of the object files in an object library.
  2339. // Find another way to do this.
  2340. target->Target->AppendProperty(
  2341. "INTERFACE_LINK_LIBRARIES",
  2342. cmStrCat("$<$<CONFIG:", config,
  2343. ">:$<LINK_ONLY:", pchSourceObj, ">>"));
  2344. // We updated the link interface, so ensure it is recomputed.
  2345. target->ClearLinkInterfaceCache();
  2346. }
  2347. }
  2348. } else {
  2349. pch_sf->SetProperty("PCH_EXTENSION", pchExtension);
  2350. }
  2351. // Add pchHeader to source files, which will
  2352. // be grouped as "Precompile Header File"
  2353. auto* pchHeader_sf = this->Makefile->GetOrCreateSource(
  2354. pchHeader, false, cmSourceFileLocationKind::Known);
  2355. std::string err;
  2356. pchHeader_sf->ResolveFullPath(&err);
  2357. if (!err.empty()) {
  2358. std::ostringstream msg;
  2359. msg << "Unable to resolve full path of PCH-header '" << pchHeader
  2360. << "' assigned to target " << target->GetName()
  2361. << ", although its path is supposed to be known!";
  2362. this->IssueMessage(MessageType::FATAL_ERROR, msg.str());
  2363. }
  2364. target->AddSource(pchHeader);
  2365. }
  2366. }
  2367. }
  2368. }
  2369. }
  2370. void cmLocalGenerator::CopyPchCompilePdb(
  2371. const std::string& config, cmGeneratorTarget* target,
  2372. const std::string& ReuseFrom, cmGeneratorTarget* reuseTarget,
  2373. const std::vector<std::string>& extensions)
  2374. {
  2375. const std::string pdb_prefix =
  2376. this->GetGlobalGenerator()->IsMultiConfig() ? cmStrCat(config, "/") : "";
  2377. const std::string target_compile_pdb_dir =
  2378. cmStrCat(target->GetLocalGenerator()->GetCurrentBinaryDirectory(), "/",
  2379. target->GetName(), ".dir/");
  2380. const std::string copy_script = cmStrCat(
  2381. target_compile_pdb_dir, "copy_idb_pdb_", config.c_str(), ".cmake");
  2382. cmGeneratedFileStream file(copy_script);
  2383. file << "# CMake generated file\n";
  2384. file << "# The compiler generated pdb file needs to be written to disk\n"
  2385. << "# by mspdbsrv. The foreach retry loop is needed to make sure\n"
  2386. << "# the pdb file is ready to be copied.\n\n";
  2387. for (auto const& extension : extensions) {
  2388. const std::string from_file =
  2389. cmStrCat(reuseTarget->GetLocalGenerator()->GetCurrentBinaryDirectory(),
  2390. "/", ReuseFrom, ".dir/${PDB_PREFIX}", ReuseFrom, extension);
  2391. const std::string to_dir =
  2392. cmStrCat(target->GetLocalGenerator()->GetCurrentBinaryDirectory(), "/",
  2393. target->GetName(), ".dir/${PDB_PREFIX}");
  2394. const std::string to_file = cmStrCat(to_dir, ReuseFrom, extension);
  2395. std::string dest_file = to_file;
  2396. std::string const& prefix = target->GetSafeProperty("PREFIX");
  2397. if (!prefix.empty()) {
  2398. dest_file = cmStrCat(to_dir, prefix, ReuseFrom, extension);
  2399. }
  2400. file << "foreach(retry RANGE 1 30)\n";
  2401. file << " if (EXISTS \"" << from_file << "\" AND (NOT EXISTS \""
  2402. << dest_file << "\" OR NOT \"" << dest_file << " \" IS_NEWER_THAN \""
  2403. << from_file << "\"))\n";
  2404. file << " execute_process(COMMAND ${CMAKE_COMMAND} -E copy";
  2405. file << " \"" << from_file << "\""
  2406. << " \"" << to_dir << "\" RESULT_VARIABLE result "
  2407. << " ERROR_QUIET)\n";
  2408. file << " if (NOT result EQUAL 0)\n"
  2409. << " execute_process(COMMAND ${CMAKE_COMMAND}"
  2410. << " -E sleep 1)\n"
  2411. << " else()\n";
  2412. if (!prefix.empty()) {
  2413. file << " file(REMOVE \"" << dest_file << "\")\n";
  2414. file << " file(RENAME \"" << to_file << "\" \"" << dest_file << "\")\n";
  2415. }
  2416. file << " break()\n"
  2417. << " endif()\n";
  2418. file << " elseif(NOT EXISTS \"" << from_file << "\")\n"
  2419. << " execute_process(COMMAND ${CMAKE_COMMAND}"
  2420. << " -E sleep 1)\n"
  2421. << " endif()\n";
  2422. file << "endforeach()\n";
  2423. }
  2424. auto configGenex = [&](cm::string_view expr) -> std::string {
  2425. if (this->GetGlobalGenerator()->IsMultiConfig()) {
  2426. return cmStrCat("$<$<CONFIG:", config, ">:", expr, ">");
  2427. }
  2428. return std::string(expr);
  2429. };
  2430. cmCustomCommandLines commandLines = cmMakeSingleCommandLine(
  2431. { configGenex(cmSystemTools::GetCMakeCommand()),
  2432. configGenex(cmStrCat("-DPDB_PREFIX=", pdb_prefix)), configGenex("-P"),
  2433. configGenex(copy_script) });
  2434. const char* no_message = "";
  2435. std::vector<std::string> outputs;
  2436. outputs.push_back(configGenex(
  2437. cmStrCat(target_compile_pdb_dir, pdb_prefix, ReuseFrom, ".pdb")));
  2438. auto cc = cm::make_unique<cmCustomCommand>();
  2439. cc->SetCommandLines(commandLines);
  2440. cc->SetComment(no_message);
  2441. cc->SetCMP0116Status(cmPolicies::NEW);
  2442. cc->SetStdPipesUTF8(true);
  2443. if (this->GetGlobalGenerator()->IsVisualStudio()) {
  2444. cc->SetByproducts(outputs);
  2445. this->AddCustomCommandToTarget(
  2446. target->GetName(), cmCustomCommandType::PRE_BUILD, std::move(cc),
  2447. cmObjectLibraryCommands::Accept);
  2448. } else {
  2449. cc->SetOutputs(outputs);
  2450. cmSourceFile* copy_rule = this->AddCustomCommandToOutput(std::move(cc));
  2451. if (copy_rule) {
  2452. target->AddSource(copy_rule->ResolveFullPath());
  2453. }
  2454. }
  2455. target->Target->SetProperty("COMPILE_PDB_OUTPUT_DIRECTORY",
  2456. target_compile_pdb_dir);
  2457. }
  2458. namespace {
  2459. inline void RegisterUnitySources(cmGeneratorTarget* target, cmSourceFile* sf,
  2460. std::string const& filename)
  2461. {
  2462. target->AddSourceFileToUnityBatch(sf->ResolveFullPath());
  2463. sf->SetProperty("UNITY_SOURCE_FILE", filename);
  2464. }
  2465. }
  2466. cmLocalGenerator::UnitySource cmLocalGenerator::WriteUnitySource(
  2467. cmGeneratorTarget* target, std::vector<std::string> const& configs,
  2468. cmRange<std::vector<UnityBatchedSource>::const_iterator> sources,
  2469. cmValue beforeInclude, cmValue afterInclude, std::string filename) const
  2470. {
  2471. cmValue uniqueIdName = target->GetProperty("UNITY_BUILD_UNIQUE_ID");
  2472. cmGeneratedFileStream file(
  2473. filename, false, target->GetGlobalGenerator()->GetMakefileEncoding());
  2474. file.SetCopyIfDifferent(true);
  2475. file << "/* generated by CMake */\n\n";
  2476. bool perConfig = false;
  2477. for (UnityBatchedSource const& ubs : sources) {
  2478. cm::optional<std::string> cond;
  2479. if (ubs.Configs.size() != configs.size()) {
  2480. perConfig = true;
  2481. cond = std::string();
  2482. cm::string_view sep;
  2483. for (size_t ci : ubs.Configs) {
  2484. cond = cmStrCat(*cond, sep, "defined(CMAKE_UNITY_CONFIG_",
  2485. cmSystemTools::UpperCase(configs[ci]), ")");
  2486. sep = " || "_s;
  2487. }
  2488. }
  2489. RegisterUnitySources(target, ubs.Source, filename);
  2490. WriteUnitySourceInclude(file, cond, ubs.Source->ResolveFullPath(),
  2491. beforeInclude, afterInclude, uniqueIdName);
  2492. }
  2493. return UnitySource(std::move(filename), perConfig);
  2494. }
  2495. void cmLocalGenerator::WriteUnitySourceInclude(
  2496. std::ostream& unity_file, cm::optional<std::string> const& cond,
  2497. std::string const& sf_full_path, cmValue beforeInclude, cmValue afterInclude,
  2498. cmValue uniqueIdName) const
  2499. {
  2500. if (cond) {
  2501. unity_file << "#if " << *cond << "\n";
  2502. }
  2503. if (cmNonempty(uniqueIdName)) {
  2504. std::string pathToHash;
  2505. auto PathEqOrSubDir = [](std::string const& a, std::string const& b) {
  2506. return (cmSystemTools::ComparePath(a, b) ||
  2507. cmSystemTools::IsSubDirectory(a, b));
  2508. };
  2509. const auto path = cmSystemTools::GetFilenamePath(sf_full_path);
  2510. if (PathEqOrSubDir(path, this->GetBinaryDirectory())) {
  2511. pathToHash = "BLD_" +
  2512. cmSystemTools::RelativePath(this->GetBinaryDirectory(), sf_full_path);
  2513. } else if (PathEqOrSubDir(path, this->GetSourceDirectory())) {
  2514. pathToHash = "SRC_" +
  2515. cmSystemTools::RelativePath(this->GetSourceDirectory(), sf_full_path);
  2516. } else {
  2517. pathToHash = "ABS_" + sf_full_path;
  2518. }
  2519. unity_file << "/* " << pathToHash << " */\n"
  2520. << "#undef " << *uniqueIdName << "\n"
  2521. << "#define " << *uniqueIdName << " unity_"
  2522. #ifndef CMAKE_BOOTSTRAP
  2523. << cmSystemTools::ComputeStringMD5(pathToHash) << "\n"
  2524. #endif
  2525. ;
  2526. }
  2527. if (beforeInclude) {
  2528. unity_file << *beforeInclude << "\n";
  2529. }
  2530. unity_file << "#include \"" << sf_full_path << "\"\n";
  2531. if (afterInclude) {
  2532. unity_file << *afterInclude << "\n";
  2533. }
  2534. if (cond) {
  2535. unity_file << "#endif\n";
  2536. }
  2537. unity_file << "\n";
  2538. }
  2539. std::vector<cmLocalGenerator::UnitySource>
  2540. cmLocalGenerator::AddUnityFilesModeAuto(
  2541. cmGeneratorTarget* target, std::string const& lang,
  2542. std::vector<std::string> const& configs,
  2543. std::vector<UnityBatchedSource> const& filtered_sources,
  2544. cmValue beforeInclude, cmValue afterInclude,
  2545. std::string const& filename_base, size_t batchSize)
  2546. {
  2547. if (batchSize == 0) {
  2548. batchSize = filtered_sources.size();
  2549. }
  2550. std::vector<UnitySource> unity_files;
  2551. for (size_t itemsLeft = filtered_sources.size(), chunk, batch = 0;
  2552. itemsLeft > 0; itemsLeft -= chunk, ++batch) {
  2553. chunk = std::min(itemsLeft, batchSize);
  2554. std::string filename = cmStrCat(filename_base, "unity_", batch,
  2555. (lang == "C") ? "_c.c" : "_cxx.cxx");
  2556. auto const begin = filtered_sources.begin() + batch * batchSize;
  2557. auto const end = begin + chunk;
  2558. unity_files.emplace_back(this->WriteUnitySource(
  2559. target, configs, cmMakeRange(begin, end), beforeInclude, afterInclude,
  2560. std::move(filename)));
  2561. }
  2562. return unity_files;
  2563. }
  2564. std::vector<cmLocalGenerator::UnitySource>
  2565. cmLocalGenerator::AddUnityFilesModeGroup(
  2566. cmGeneratorTarget* target, std::string const& lang,
  2567. std::vector<std::string> const& configs,
  2568. std::vector<UnityBatchedSource> const& filtered_sources,
  2569. cmValue beforeInclude, cmValue afterInclude,
  2570. std::string const& filename_base)
  2571. {
  2572. std::vector<UnitySource> unity_files;
  2573. // sources organized by group name. Drop any source
  2574. // without a group
  2575. std::unordered_map<std::string, std::vector<UnityBatchedSource>>
  2576. explicit_mapping;
  2577. for (UnityBatchedSource const& ubs : filtered_sources) {
  2578. if (cmValue value = ubs.Source->GetProperty("UNITY_GROUP")) {
  2579. auto i = explicit_mapping.find(*value);
  2580. if (i == explicit_mapping.end()) {
  2581. std::vector<UnityBatchedSource> sources{ ubs };
  2582. explicit_mapping.emplace(*value, std::move(sources));
  2583. } else {
  2584. i->second.emplace_back(ubs);
  2585. }
  2586. }
  2587. }
  2588. for (auto const& item : explicit_mapping) {
  2589. auto const& name = item.first;
  2590. std::string filename = cmStrCat(filename_base, "unity_", name,
  2591. (lang == "C") ? "_c.c" : "_cxx.cxx");
  2592. unity_files.emplace_back(this->WriteUnitySource(
  2593. target, configs, cmMakeRange(item.second), beforeInclude, afterInclude,
  2594. std::move(filename)));
  2595. }
  2596. return unity_files;
  2597. }
  2598. void cmLocalGenerator::AddUnityBuild(cmGeneratorTarget* target)
  2599. {
  2600. if (!target->GetPropertyAsBool("UNITY_BUILD")) {
  2601. return;
  2602. }
  2603. std::vector<UnityBatchedSource> unitySources;
  2604. std::vector<std::string> configs =
  2605. this->Makefile->GetGeneratorConfigs(cmMakefile::IncludeEmptyConfig);
  2606. std::map<cmSourceFile const*, size_t> index;
  2607. for (size_t ci = 0; ci < configs.size(); ++ci) {
  2608. // FIXME: Refactor collection of sources to not evaluate object libraries.
  2609. std::vector<cmSourceFile*> sources;
  2610. target->GetSourceFiles(sources, configs[ci]);
  2611. for (cmSourceFile* sf : sources) {
  2612. auto mi = index.find(sf);
  2613. if (mi == index.end()) {
  2614. unitySources.emplace_back(sf);
  2615. std::map<cmSourceFile const*, size_t>::value_type entry(
  2616. sf, unitySources.size() - 1);
  2617. mi = index.insert(entry).first;
  2618. }
  2619. unitySources[mi->second].Configs.emplace_back(ci);
  2620. }
  2621. }
  2622. std::string filename_base =
  2623. cmStrCat(this->GetCurrentBinaryDirectory(), "/CMakeFiles/",
  2624. target->GetName(), ".dir/Unity/");
  2625. cmValue batchSizeString = target->GetProperty("UNITY_BUILD_BATCH_SIZE");
  2626. const size_t unityBatchSize = batchSizeString
  2627. ? static_cast<size_t>(std::atoi(batchSizeString->c_str()))
  2628. : 0;
  2629. cmValue beforeInclude =
  2630. target->GetProperty("UNITY_BUILD_CODE_BEFORE_INCLUDE");
  2631. cmValue afterInclude = target->GetProperty("UNITY_BUILD_CODE_AFTER_INCLUDE");
  2632. cmValue unityMode = target->GetProperty("UNITY_BUILD_MODE");
  2633. for (std::string lang : { "C", "CXX" }) {
  2634. std::vector<UnityBatchedSource> filtered_sources;
  2635. std::copy_if(unitySources.begin(), unitySources.end(),
  2636. std::back_inserter(filtered_sources),
  2637. [&](UnityBatchedSource const& ubs) -> bool {
  2638. cmSourceFile* sf = ubs.Source;
  2639. return sf->GetLanguage() == lang &&
  2640. !sf->GetPropertyAsBool("SKIP_UNITY_BUILD_INCLUSION") &&
  2641. !sf->GetPropertyAsBool("HEADER_FILE_ONLY") &&
  2642. !sf->GetProperty("COMPILE_OPTIONS") &&
  2643. !sf->GetProperty("COMPILE_DEFINITIONS") &&
  2644. !sf->GetProperty("COMPILE_FLAGS") &&
  2645. !sf->GetProperty("INCLUDE_DIRECTORIES");
  2646. });
  2647. std::vector<UnitySource> unity_files;
  2648. if (!unityMode || *unityMode == "BATCH") {
  2649. unity_files = AddUnityFilesModeAuto(
  2650. target, lang, configs, filtered_sources, beforeInclude, afterInclude,
  2651. filename_base, unityBatchSize);
  2652. } else if (unityMode && *unityMode == "GROUP") {
  2653. unity_files =
  2654. AddUnityFilesModeGroup(target, lang, configs, filtered_sources,
  2655. beforeInclude, afterInclude, filename_base);
  2656. } else {
  2657. // unity mode is set to an unsupported value
  2658. std::string e("Invalid UNITY_BUILD_MODE value of " + *unityMode +
  2659. " assigned to target " + target->GetName() +
  2660. ". Acceptable values are BATCH and GROUP.");
  2661. this->IssueMessage(MessageType::FATAL_ERROR, e);
  2662. }
  2663. for (UnitySource const& file : unity_files) {
  2664. auto* unity = this->GetMakefile()->GetOrCreateSource(file.Path);
  2665. target->AddSource(file.Path, true);
  2666. unity->SetProperty("SKIP_UNITY_BUILD_INCLUSION", "ON");
  2667. unity->SetProperty("UNITY_SOURCE_FILE", file.Path);
  2668. if (file.PerConfig) {
  2669. unity->SetProperty("COMPILE_DEFINITIONS",
  2670. "CMAKE_UNITY_CONFIG_$<UPPER_CASE:$<CONFIG>>");
  2671. }
  2672. }
  2673. }
  2674. }
  2675. void cmLocalGenerator::AppendIPOLinkerFlags(std::string& flags,
  2676. cmGeneratorTarget* target,
  2677. const std::string& config,
  2678. const std::string& lang)
  2679. {
  2680. if (!target->IsIPOEnabled(lang, config)) {
  2681. return;
  2682. }
  2683. switch (target->GetType()) {
  2684. case cmStateEnums::EXECUTABLE:
  2685. case cmStateEnums::SHARED_LIBRARY:
  2686. case cmStateEnums::MODULE_LIBRARY:
  2687. break;
  2688. default:
  2689. return;
  2690. }
  2691. const std::string name = "CMAKE_" + lang + "_LINK_OPTIONS_IPO";
  2692. cmValue rawFlagsList = this->Makefile->GetDefinition(name);
  2693. if (!rawFlagsList) {
  2694. return;
  2695. }
  2696. std::vector<std::string> flagsList = cmExpandedList(*rawFlagsList);
  2697. for (std::string const& o : flagsList) {
  2698. this->AppendFlagEscape(flags, o);
  2699. }
  2700. }
  2701. void cmLocalGenerator::AppendPositionIndependentLinkerFlags(
  2702. std::string& flags, cmGeneratorTarget* target, const std::string& config,
  2703. const std::string& lang)
  2704. {
  2705. // For now, only EXECUTABLE is concerned
  2706. if (target->GetType() != cmStateEnums::EXECUTABLE) {
  2707. return;
  2708. }
  2709. const char* PICValue = target->GetLinkPIEProperty(config);
  2710. if (PICValue == nullptr) {
  2711. // POSITION_INDEPENDENT_CODE is not set
  2712. return;
  2713. }
  2714. const std::string mode = cmIsOn(PICValue) ? "PIE" : "NO_PIE";
  2715. std::string supported = "CMAKE_" + lang + "_LINK_" + mode + "_SUPPORTED";
  2716. if (cmIsOff(this->Makefile->GetDefinition(supported))) {
  2717. return;
  2718. }
  2719. std::string name = "CMAKE_" + lang + "_LINK_OPTIONS_" + mode;
  2720. auto pieFlags = this->Makefile->GetSafeDefinition(name);
  2721. if (pieFlags.empty()) {
  2722. return;
  2723. }
  2724. std::vector<std::string> flagsList = cmExpandedList(pieFlags);
  2725. for (const auto& flag : flagsList) {
  2726. this->AppendFlagEscape(flags, flag);
  2727. }
  2728. }
  2729. bool cmLocalGenerator::AppendLWYUFlags(std::string& flags,
  2730. const cmGeneratorTarget* target,
  2731. const std::string& lang)
  2732. {
  2733. auto useLWYU = target->GetPropertyAsBool("LINK_WHAT_YOU_USE") &&
  2734. (target->GetType() == cmStateEnums::TargetType::EXECUTABLE ||
  2735. target->GetType() == cmStateEnums::TargetType::SHARED_LIBRARY ||
  2736. target->GetType() == cmStateEnums::TargetType::MODULE_LIBRARY);
  2737. if (useLWYU) {
  2738. const auto& lwyuFlag = this->GetMakefile()->GetSafeDefinition(
  2739. cmStrCat("CMAKE_", lang, "_LINK_WHAT_YOU_USE_FLAG"));
  2740. useLWYU = !lwyuFlag.empty();
  2741. if (useLWYU) {
  2742. std::vector<BT<std::string>> lwyuOpts;
  2743. lwyuOpts.emplace_back(lwyuFlag);
  2744. this->AppendFlags(flags, target->ResolveLinkerWrapper(lwyuOpts, lang));
  2745. }
  2746. }
  2747. return useLWYU;
  2748. }
  2749. void cmLocalGenerator::AppendCompileOptions(std::string& options,
  2750. std::string const& options_list,
  2751. const char* regex) const
  2752. {
  2753. // Short-circuit if there are no options.
  2754. if (options_list.empty()) {
  2755. return;
  2756. }
  2757. // Expand the list of options.
  2758. std::vector<std::string> options_vec = cmExpandedList(options_list);
  2759. this->AppendCompileOptions(options, options_vec, regex);
  2760. }
  2761. void cmLocalGenerator::AppendCompileOptions(
  2762. std::string& options, const std::vector<std::string>& options_vec,
  2763. const char* regex) const
  2764. {
  2765. if (regex != nullptr) {
  2766. // Filter flags upon specified reges.
  2767. cmsys::RegularExpression r(regex);
  2768. for (std::string const& opt : options_vec) {
  2769. if (r.find(opt)) {
  2770. this->AppendFlagEscape(options, opt);
  2771. }
  2772. }
  2773. } else {
  2774. for (std::string const& opt : options_vec) {
  2775. this->AppendFlagEscape(options, opt);
  2776. }
  2777. }
  2778. }
  2779. void cmLocalGenerator::AppendCompileOptions(
  2780. std::vector<BT<std::string>>& options,
  2781. const std::vector<BT<std::string>>& options_vec, const char* regex) const
  2782. {
  2783. if (regex != nullptr) {
  2784. // Filter flags upon specified regular expressions.
  2785. cmsys::RegularExpression r(regex);
  2786. for (BT<std::string> const& opt : options_vec) {
  2787. if (r.find(opt.Value)) {
  2788. std::string flag;
  2789. this->AppendFlagEscape(flag, opt.Value);
  2790. options.emplace_back(std::move(flag), opt.Backtrace);
  2791. }
  2792. }
  2793. } else {
  2794. for (BT<std::string> const& opt : options_vec) {
  2795. std::string flag;
  2796. this->AppendFlagEscape(flag, opt.Value);
  2797. options.emplace_back(std::move(flag), opt.Backtrace);
  2798. }
  2799. }
  2800. }
  2801. void cmLocalGenerator::AppendIncludeDirectories(
  2802. std::vector<std::string>& includes, const std::string& includes_list,
  2803. const cmSourceFile& sourceFile) const
  2804. {
  2805. // Short-circuit if there are no includes.
  2806. if (includes_list.empty()) {
  2807. return;
  2808. }
  2809. // Expand the list of includes.
  2810. std::vector<std::string> includes_vec = cmExpandedList(includes_list);
  2811. this->AppendIncludeDirectories(includes, includes_vec, sourceFile);
  2812. }
  2813. void cmLocalGenerator::AppendIncludeDirectories(
  2814. std::vector<std::string>& includes,
  2815. const std::vector<std::string>& includes_vec,
  2816. const cmSourceFile& sourceFile) const
  2817. {
  2818. std::unordered_set<std::string> uniqueIncludes;
  2819. for (const std::string& include : includes_vec) {
  2820. if (!cmSystemTools::FileIsFullPath(include)) {
  2821. std::ostringstream e;
  2822. e << "Found relative path while evaluating include directories of "
  2823. "\""
  2824. << sourceFile.GetLocation().GetName() << "\":\n \"" << include
  2825. << "\"\n";
  2826. this->IssueMessage(MessageType::FATAL_ERROR, e.str());
  2827. return;
  2828. }
  2829. std::string inc = include;
  2830. if (!cmIsOff(inc)) {
  2831. cmSystemTools::ConvertToUnixSlashes(inc);
  2832. }
  2833. if (uniqueIncludes.insert(inc).second) {
  2834. includes.push_back(std::move(inc));
  2835. }
  2836. }
  2837. }
  2838. void cmLocalGenerator::AppendDefines(std::set<std::string>& defines,
  2839. std::string const& defines_list) const
  2840. {
  2841. std::set<BT<std::string>> tmp;
  2842. this->AppendDefines(tmp, cmExpandListWithBacktrace(defines_list));
  2843. for (BT<std::string> const& i : tmp) {
  2844. defines.emplace(i.Value);
  2845. }
  2846. }
  2847. void cmLocalGenerator::AppendDefines(std::set<BT<std::string>>& defines,
  2848. std::string const& defines_list) const
  2849. {
  2850. // Short-circuit if there are no definitions.
  2851. if (defines_list.empty()) {
  2852. return;
  2853. }
  2854. // Expand the list of definitions.
  2855. this->AppendDefines(defines, cmExpandListWithBacktrace(defines_list));
  2856. }
  2857. void cmLocalGenerator::AppendDefines(
  2858. std::set<BT<std::string>>& defines,
  2859. const std::vector<BT<std::string>>& defines_vec) const
  2860. {
  2861. for (BT<std::string> const& d : defines_vec) {
  2862. // Skip unsupported definitions.
  2863. if (!this->CheckDefinition(d.Value)) {
  2864. continue;
  2865. }
  2866. defines.insert(d);
  2867. }
  2868. }
  2869. void cmLocalGenerator::JoinDefines(const std::set<std::string>& defines,
  2870. std::string& definesString,
  2871. const std::string& lang)
  2872. {
  2873. // Lookup the define flag for the current language.
  2874. std::string dflag = "-D";
  2875. if (!lang.empty()) {
  2876. cmValue df =
  2877. this->Makefile->GetDefinition(cmStrCat("CMAKE_", lang, "_DEFINE_FLAG"));
  2878. if (cmNonempty(df)) {
  2879. dflag = *df;
  2880. }
  2881. }
  2882. const char* itemSeparator = definesString.empty() ? "" : " ";
  2883. for (std::string const& define : defines) {
  2884. // Append the definition with proper escaping.
  2885. std::string def = dflag;
  2886. if (this->GetState()->UseWatcomWMake()) {
  2887. // The Watcom compiler does its own command line parsing instead
  2888. // of using the windows shell rules. Definitions are one of
  2889. // -DNAME
  2890. // -DNAME=<cpp-token>
  2891. // -DNAME="c-string with spaces and other characters(?@#$)"
  2892. //
  2893. // Watcom will properly parse each of these cases from the
  2894. // command line without any escapes. However we still have to
  2895. // get the '$' and '#' characters through WMake as '$$' and
  2896. // '$#'.
  2897. for (char c : define) {
  2898. if (c == '$' || c == '#') {
  2899. def += '$';
  2900. }
  2901. def += c;
  2902. }
  2903. } else {
  2904. // Make the definition appear properly on the command line. Use
  2905. // -DNAME="value" instead of -D"NAME=value" for historical reasons.
  2906. std::string::size_type eq = define.find('=');
  2907. def += define.substr(0, eq);
  2908. if (eq != std::string::npos) {
  2909. def += "=";
  2910. def += this->EscapeForShell(define.substr(eq + 1), true);
  2911. }
  2912. }
  2913. definesString += itemSeparator;
  2914. itemSeparator = " ";
  2915. definesString += def;
  2916. }
  2917. }
  2918. void cmLocalGenerator::AppendFeatureOptions(std::string& flags,
  2919. const std::string& lang,
  2920. const char* feature)
  2921. {
  2922. cmValue optionList = this->Makefile->GetDefinition(
  2923. cmStrCat("CMAKE_", lang, "_COMPILE_OPTIONS_", feature));
  2924. if (optionList) {
  2925. std::vector<std::string> options = cmExpandedList(*optionList);
  2926. for (std::string const& o : options) {
  2927. this->AppendFlagEscape(flags, o);
  2928. }
  2929. }
  2930. }
  2931. cmValue cmLocalGenerator::GetFeature(const std::string& feature,
  2932. const std::string& config)
  2933. {
  2934. std::string featureName = feature;
  2935. // TODO: Define accumulation policy for features (prepend, append,
  2936. // replace). Currently we always replace.
  2937. if (!config.empty()) {
  2938. featureName += "_";
  2939. featureName += cmSystemTools::UpperCase(config);
  2940. }
  2941. cmStateSnapshot snp = this->StateSnapshot;
  2942. while (snp.IsValid()) {
  2943. if (cmValue value = snp.GetDirectory().GetProperty(featureName)) {
  2944. return value;
  2945. }
  2946. snp = snp.GetBuildsystemDirectoryParent();
  2947. }
  2948. return nullptr;
  2949. }
  2950. std::string cmLocalGenerator::GetProjectName() const
  2951. {
  2952. return this->StateSnapshot.GetProjectName();
  2953. }
  2954. std::string cmLocalGenerator::ConstructComment(
  2955. cmCustomCommandGenerator const& ccg, const char* default_comment) const
  2956. {
  2957. // Check for a comment provided with the command.
  2958. if (ccg.GetComment()) {
  2959. return ccg.GetComment();
  2960. }
  2961. // Construct a reasonable default comment if possible.
  2962. if (!ccg.GetOutputs().empty()) {
  2963. std::string comment;
  2964. comment = "Generating ";
  2965. const char* sep = "";
  2966. for (std::string const& o : ccg.GetOutputs()) {
  2967. comment += sep;
  2968. comment += this->MaybeRelativeToCurBinDir(o);
  2969. sep = ", ";
  2970. }
  2971. return comment;
  2972. }
  2973. // Otherwise use the provided default.
  2974. return default_comment;
  2975. }
  2976. class cmInstallTargetGeneratorLocal : public cmInstallTargetGenerator
  2977. {
  2978. public:
  2979. cmInstallTargetGeneratorLocal(cmLocalGenerator* lg, std::string const& t,
  2980. std::string const& dest, bool implib)
  2981. : cmInstallTargetGenerator(
  2982. t, dest, implib, "", std::vector<std::string>(), "Unspecified",
  2983. cmInstallGenerator::SelectMessageLevel(lg->GetMakefile()), false,
  2984. false)
  2985. {
  2986. this->Compute(lg);
  2987. }
  2988. };
  2989. void cmLocalGenerator::GenerateTargetInstallRules(
  2990. std::ostream& os, const std::string& config,
  2991. std::vector<std::string> const& configurationTypes)
  2992. {
  2993. // Convert the old-style install specification from each target to
  2994. // an install generator and run it.
  2995. const auto& tgts = this->GetGeneratorTargets();
  2996. for (const auto& l : tgts) {
  2997. if (l->GetType() == cmStateEnums::INTERFACE_LIBRARY) {
  2998. continue;
  2999. }
  3000. // Include the user-specified pre-install script for this target.
  3001. if (cmValue preinstall = l->GetProperty("PRE_INSTALL_SCRIPT")) {
  3002. cmInstallScriptGenerator g(*preinstall, false, "", false, false);
  3003. g.Generate(os, config, configurationTypes);
  3004. }
  3005. // Install this target if a destination is given.
  3006. if (!l->Target->GetInstallPath().empty()) {
  3007. // Compute the full install destination. Note that converting
  3008. // to unix slashes also removes any trailing slash.
  3009. // We also skip over the leading slash given by the user.
  3010. std::string destination = l->Target->GetInstallPath().substr(1);
  3011. cmSystemTools::ConvertToUnixSlashes(destination);
  3012. if (destination.empty()) {
  3013. destination = ".";
  3014. }
  3015. // Generate the proper install generator for this target type.
  3016. switch (l->GetType()) {
  3017. case cmStateEnums::EXECUTABLE:
  3018. case cmStateEnums::STATIC_LIBRARY:
  3019. case cmStateEnums::MODULE_LIBRARY: {
  3020. // Use a target install generator.
  3021. cmInstallTargetGeneratorLocal g(this, l->GetName(), destination,
  3022. false);
  3023. g.Generate(os, config, configurationTypes);
  3024. } break;
  3025. case cmStateEnums::SHARED_LIBRARY: {
  3026. #if defined(_WIN32) || defined(__CYGWIN__)
  3027. // Special code to handle DLL. Install the import library
  3028. // to the normal destination and the DLL to the runtime
  3029. // destination.
  3030. cmInstallTargetGeneratorLocal g1(this, l->GetName(), destination,
  3031. true);
  3032. g1.Generate(os, config, configurationTypes);
  3033. // We also skip over the leading slash given by the user.
  3034. destination = l->Target->GetRuntimeInstallPath().substr(1);
  3035. cmSystemTools::ConvertToUnixSlashes(destination);
  3036. cmInstallTargetGeneratorLocal g2(this, l->GetName(), destination,
  3037. false);
  3038. g2.Generate(os, config, configurationTypes);
  3039. #else
  3040. // Use a target install generator.
  3041. cmInstallTargetGeneratorLocal g(this, l->GetName(), destination,
  3042. false);
  3043. g.Generate(os, config, configurationTypes);
  3044. #endif
  3045. } break;
  3046. default:
  3047. break;
  3048. }
  3049. }
  3050. // Include the user-specified post-install script for this target.
  3051. if (cmValue postinstall = l->GetProperty("POST_INSTALL_SCRIPT")) {
  3052. cmInstallScriptGenerator g(*postinstall, false, "", false, false);
  3053. g.Generate(os, config, configurationTypes);
  3054. }
  3055. }
  3056. }
  3057. #if defined(CM_LG_ENCODE_OBJECT_NAMES)
  3058. static bool cmLocalGeneratorShortenObjectName(std::string& objName,
  3059. std::string::size_type max_len)
  3060. {
  3061. // Check if the path can be shortened using an md5 sum replacement for
  3062. // a portion of the path.
  3063. std::string::size_type md5Len = 32;
  3064. std::string::size_type numExtraChars = objName.size() - max_len + md5Len;
  3065. std::string::size_type pos = objName.find('/', numExtraChars);
  3066. if (pos == std::string::npos) {
  3067. pos = objName.rfind('/', numExtraChars);
  3068. if (pos == std::string::npos || pos <= md5Len) {
  3069. return false;
  3070. }
  3071. }
  3072. // Replace the beginning of the path portion of the object name with
  3073. // its own md5 sum.
  3074. cmCryptoHash md5(cmCryptoHash::AlgoMD5);
  3075. std::string md5name = cmStrCat(md5.HashString(objName.substr(0, pos)),
  3076. cm::string_view(objName).substr(pos));
  3077. objName = md5name;
  3078. // The object name is now shorter, check if it is short enough.
  3079. return pos >= numExtraChars;
  3080. }
  3081. bool cmLocalGeneratorCheckObjectName(std::string& objName,
  3082. std::string::size_type dir_len,
  3083. std::string::size_type max_total_len)
  3084. {
  3085. // Enforce the maximum file name length if possible.
  3086. std::string::size_type max_obj_len = max_total_len;
  3087. if (dir_len < max_total_len) {
  3088. max_obj_len = max_total_len - dir_len;
  3089. if (objName.size() > max_obj_len) {
  3090. // The current object file name is too long. Try to shorten it.
  3091. return cmLocalGeneratorShortenObjectName(objName, max_obj_len);
  3092. }
  3093. // The object file name is short enough.
  3094. return true;
  3095. }
  3096. // The build directory in which the object will be stored is
  3097. // already too deep.
  3098. return false;
  3099. }
  3100. #endif
  3101. std::string& cmLocalGenerator::CreateSafeUniqueObjectFileName(
  3102. const std::string& sin, std::string const& dir_max)
  3103. {
  3104. // Look for an existing mapped name for this object file.
  3105. auto it = this->UniqueObjectNamesMap.find(sin);
  3106. // If no entry exists create one.
  3107. if (it == this->UniqueObjectNamesMap.end()) {
  3108. // Start with the original name.
  3109. std::string ssin = sin;
  3110. // Avoid full paths by removing leading slashes.
  3111. ssin.erase(0, ssin.find_first_not_of('/'));
  3112. // Avoid full paths by removing colons.
  3113. std::replace(ssin.begin(), ssin.end(), ':', '_');
  3114. // Avoid relative paths that go up the tree.
  3115. cmSystemTools::ReplaceString(ssin, "../", "__/");
  3116. // Avoid spaces.
  3117. std::replace(ssin.begin(), ssin.end(), ' ', '_');
  3118. // Mangle the name if necessary.
  3119. if (this->Makefile->IsOn("CMAKE_MANGLE_OBJECT_FILE_NAMES")) {
  3120. bool done;
  3121. int cc = 0;
  3122. char rpstr[100];
  3123. snprintf(rpstr, sizeof(rpstr), "_p_");
  3124. cmSystemTools::ReplaceString(ssin, "+", rpstr);
  3125. std::string sssin = sin;
  3126. do {
  3127. done = true;
  3128. for (it = this->UniqueObjectNamesMap.begin();
  3129. it != this->UniqueObjectNamesMap.end(); ++it) {
  3130. if (it->second == ssin) {
  3131. done = false;
  3132. }
  3133. }
  3134. if (done) {
  3135. break;
  3136. }
  3137. sssin = ssin;
  3138. cmSystemTools::ReplaceString(ssin, "_p_", rpstr);
  3139. snprintf(rpstr, sizeof(rpstr), "_p%d_", cc++);
  3140. } while (!done);
  3141. }
  3142. #if defined(CM_LG_ENCODE_OBJECT_NAMES)
  3143. if (!cmLocalGeneratorCheckObjectName(ssin, dir_max.size(),
  3144. this->ObjectPathMax)) {
  3145. // Warn if this is the first time the path has been seen.
  3146. if (this->ObjectMaxPathViolations.insert(dir_max).second) {
  3147. std::ostringstream m;
  3148. /* clang-format off */
  3149. m << "The object file directory\n"
  3150. << " " << dir_max << "\n"
  3151. << "has " << dir_max.size() << " characters. "
  3152. << "The maximum full path to an object file is "
  3153. << this->ObjectPathMax << " characters "
  3154. << "(see CMAKE_OBJECT_PATH_MAX). "
  3155. << "Object file\n"
  3156. << " " << ssin << "\n"
  3157. << "cannot be safely placed under this directory. "
  3158. << "The build may not work correctly.";
  3159. /* clang-format on */
  3160. this->IssueMessage(MessageType::WARNING, m.str());
  3161. }
  3162. }
  3163. #else
  3164. (void)dir_max;
  3165. #endif
  3166. // Insert the newly mapped object file name.
  3167. std::map<std::string, std::string>::value_type e(sin, ssin);
  3168. it = this->UniqueObjectNamesMap.insert(e).first;
  3169. }
  3170. // Return the map entry.
  3171. return it->second;
  3172. }
  3173. void cmLocalGenerator::ComputeObjectFilenames(
  3174. std::map<cmSourceFile const*, std::string>& /*unused*/,
  3175. cmGeneratorTarget const* /*unused*/)
  3176. {
  3177. }
  3178. bool cmLocalGenerator::IsWindowsShell() const
  3179. {
  3180. return this->GetState()->UseWindowsShell();
  3181. }
  3182. bool cmLocalGenerator::IsWatcomWMake() const
  3183. {
  3184. return this->GetState()->UseWatcomWMake();
  3185. }
  3186. bool cmLocalGenerator::IsMinGWMake() const
  3187. {
  3188. return this->GetState()->UseMinGWMake();
  3189. }
  3190. bool cmLocalGenerator::IsNMake() const
  3191. {
  3192. return this->GetState()->UseNMake();
  3193. }
  3194. bool cmLocalGenerator::IsNinjaMulti() const
  3195. {
  3196. return this->GetState()->UseNinjaMulti();
  3197. }
  3198. namespace {
  3199. std::string relativeIfUnder(std::string const& top, std::string const& cur,
  3200. std::string const& path)
  3201. {
  3202. // Use a path relative to 'cur' if it can be expressed without
  3203. // a `../` sequence that leaves 'top'.
  3204. if (cmSystemTools::IsSubDirectory(path, cur) ||
  3205. (cmSystemTools::IsSubDirectory(cur, top) &&
  3206. cmSystemTools::IsSubDirectory(path, top))) {
  3207. return cmSystemTools::ForceToRelativePath(cur, path);
  3208. }
  3209. return path;
  3210. }
  3211. }
  3212. std::string cmLocalGenerator::GetObjectFileNameWithoutTarget(
  3213. const cmSourceFile& source, std::string const& dir_max,
  3214. bool* hasSourceExtension, char const* customOutputExtension)
  3215. {
  3216. // Construct the object file name using the full path to the source
  3217. // file which is its only unique identification.
  3218. std::string const& fullPath = source.GetFullPath();
  3219. // Try referencing the source relative to the source tree.
  3220. std::string relFromSource = relativeIfUnder(
  3221. this->GetSourceDirectory(), this->GetCurrentSourceDirectory(), fullPath);
  3222. assert(!relFromSource.empty());
  3223. bool relSource = !cmSystemTools::FileIsFullPath(relFromSource);
  3224. bool subSource = relSource && relFromSource[0] != '.';
  3225. // Try referencing the source relative to the binary tree.
  3226. std::string relFromBinary = relativeIfUnder(
  3227. this->GetBinaryDirectory(), this->GetCurrentBinaryDirectory(), fullPath);
  3228. assert(!relFromBinary.empty());
  3229. bool relBinary = !cmSystemTools::FileIsFullPath(relFromBinary);
  3230. bool subBinary = relBinary && relFromBinary[0] != '.';
  3231. // Select a nice-looking reference to the source file to construct
  3232. // the object file name.
  3233. std::string objectName;
  3234. // XXX(clang-tidy): https://bugs.llvm.org/show_bug.cgi?id=44165
  3235. // NOLINTNEXTLINE(bugprone-branch-clone)
  3236. if ((relSource && !relBinary) || (subSource && !subBinary)) {
  3237. objectName = relFromSource;
  3238. } else if ((relBinary && !relSource) || (subBinary && !subSource) ||
  3239. relFromBinary.length() < relFromSource.length()) {
  3240. objectName = relFromBinary;
  3241. } else {
  3242. objectName = relFromSource;
  3243. }
  3244. // if it is still a full path check for the try compile case
  3245. // try compile never have in source sources, and should not
  3246. // have conflicting source file names in the same target
  3247. if (cmSystemTools::FileIsFullPath(objectName)) {
  3248. if (this->GetGlobalGenerator()->GetCMakeInstance()->GetIsInTryCompile()) {
  3249. objectName = cmSystemTools::GetFilenameName(source.GetFullPath());
  3250. }
  3251. }
  3252. // Ensure that for the CMakeFiles/<target>.dir/generated_source_file
  3253. // we don't end up having:
  3254. // CMakeFiles/<target>.dir/CMakeFiles/<target>.dir/generated_source_file.obj
  3255. cmValue unitySourceFile = source.GetProperty("UNITY_SOURCE_FILE");
  3256. cmValue pchExtension = source.GetProperty("PCH_EXTENSION");
  3257. const bool isPchObject = objectName.find("cmake_pch") != std::string::npos;
  3258. if (unitySourceFile || pchExtension || isPchObject) {
  3259. if (pchExtension) {
  3260. customOutputExtension = pchExtension->c_str();
  3261. }
  3262. cmsys::RegularExpression var("(CMakeFiles/[^/]+.dir/)");
  3263. if (var.find(objectName)) {
  3264. objectName.erase(var.start(), var.end() - var.start());
  3265. }
  3266. }
  3267. // Replace the original source file extension with the object file
  3268. // extension.
  3269. bool keptSourceExtension = true;
  3270. if (!source.GetPropertyAsBool("KEEP_EXTENSION")) {
  3271. // Decide whether this language wants to replace the source
  3272. // extension with the object extension. For CMake 2.4
  3273. // compatibility do this by default.
  3274. bool replaceExt = this->NeedBackwardsCompatibility_2_4();
  3275. if (!replaceExt) {
  3276. std::string lang = source.GetLanguage();
  3277. if (!lang.empty()) {
  3278. replaceExt = this->Makefile->IsOn(
  3279. cmStrCat("CMAKE_", lang, "_OUTPUT_EXTENSION_REPLACE"));
  3280. }
  3281. }
  3282. // Remove the source extension if it is to be replaced.
  3283. if (replaceExt || customOutputExtension) {
  3284. keptSourceExtension = false;
  3285. std::string::size_type dot_pos = objectName.rfind('.');
  3286. if (dot_pos != std::string::npos) {
  3287. objectName = objectName.substr(0, dot_pos);
  3288. }
  3289. }
  3290. // Store the new extension.
  3291. if (customOutputExtension) {
  3292. objectName += customOutputExtension;
  3293. } else {
  3294. objectName += this->GlobalGenerator->GetLanguageOutputExtension(source);
  3295. }
  3296. }
  3297. if (hasSourceExtension) {
  3298. *hasSourceExtension = keptSourceExtension;
  3299. }
  3300. // Convert to a safe name.
  3301. return this->CreateSafeUniqueObjectFileName(objectName, dir_max);
  3302. }
  3303. std::string cmLocalGenerator::GetSourceFileLanguage(const cmSourceFile& source)
  3304. {
  3305. return source.GetLanguage();
  3306. }
  3307. cmake* cmLocalGenerator::GetCMakeInstance() const
  3308. {
  3309. return this->GlobalGenerator->GetCMakeInstance();
  3310. }
  3311. std::string const& cmLocalGenerator::GetSourceDirectory() const
  3312. {
  3313. return this->GetCMakeInstance()->GetHomeDirectory();
  3314. }
  3315. std::string const& cmLocalGenerator::GetBinaryDirectory() const
  3316. {
  3317. return this->GetCMakeInstance()->GetHomeOutputDirectory();
  3318. }
  3319. std::string const& cmLocalGenerator::GetCurrentBinaryDirectory() const
  3320. {
  3321. return this->StateSnapshot.GetDirectory().GetCurrentBinary();
  3322. }
  3323. std::string const& cmLocalGenerator::GetCurrentSourceDirectory() const
  3324. {
  3325. return this->StateSnapshot.GetDirectory().GetCurrentSource();
  3326. }
  3327. std::string cmLocalGenerator::GetTargetDirectory(
  3328. const cmGeneratorTarget* /*unused*/) const
  3329. {
  3330. cmSystemTools::Error("GetTargetDirectory"
  3331. " called on cmLocalGenerator");
  3332. return "";
  3333. }
  3334. KWIML_INT_uint64_t cmLocalGenerator::GetBackwardsCompatibility()
  3335. {
  3336. // The computed version may change until the project is fully
  3337. // configured.
  3338. if (!this->BackwardsCompatibilityFinal) {
  3339. unsigned int major = 0;
  3340. unsigned int minor = 0;
  3341. unsigned int patch = 0;
  3342. if (cmValue value =
  3343. this->Makefile->GetDefinition("CMAKE_BACKWARDS_COMPATIBILITY")) {
  3344. switch (sscanf(value->c_str(), "%u.%u.%u", &major, &minor, &patch)) {
  3345. case 2:
  3346. patch = 0;
  3347. break;
  3348. case 1:
  3349. minor = 0;
  3350. patch = 0;
  3351. break;
  3352. default:
  3353. break;
  3354. }
  3355. }
  3356. this->BackwardsCompatibility = CMake_VERSION_ENCODE(major, minor, patch);
  3357. this->BackwardsCompatibilityFinal = true;
  3358. }
  3359. return this->BackwardsCompatibility;
  3360. }
  3361. bool cmLocalGenerator::NeedBackwardsCompatibility_2_4()
  3362. {
  3363. // Check the policy to decide whether to pay attention to this
  3364. // variable.
  3365. switch (this->GetPolicyStatus(cmPolicies::CMP0001)) {
  3366. case cmPolicies::WARN:
  3367. // WARN is just OLD without warning because user code does not
  3368. // always affect whether this check is done.
  3369. CM_FALLTHROUGH;
  3370. case cmPolicies::OLD:
  3371. // Old behavior is to check the variable.
  3372. break;
  3373. case cmPolicies::NEW:
  3374. // New behavior is to ignore the variable.
  3375. case cmPolicies::REQUIRED_IF_USED:
  3376. case cmPolicies::REQUIRED_ALWAYS:
  3377. // This will never be the case because the only way to require
  3378. // the setting is to require the user to specify version policy
  3379. // 2.6 or higher. Once we add that requirement then this whole
  3380. // method can be removed anyway.
  3381. return false;
  3382. }
  3383. // Compatibility is needed if CMAKE_BACKWARDS_COMPATIBILITY is set
  3384. // equal to or lower than the given version.
  3385. KWIML_INT_uint64_t actual_compat = this->GetBackwardsCompatibility();
  3386. return (actual_compat && actual_compat <= CMake_VERSION_ENCODE(2, 4, 255));
  3387. }
  3388. cmPolicies::PolicyStatus cmLocalGenerator::GetPolicyStatus(
  3389. cmPolicies::PolicyID id) const
  3390. {
  3391. return this->Makefile->GetPolicyStatus(id);
  3392. }
  3393. bool cmLocalGenerator::CheckDefinition(std::string const& define) const
  3394. {
  3395. // Many compilers do not support -DNAME(arg)=sdf so we disable it.
  3396. std::string::size_type pos = define.find_first_of("(=");
  3397. if (pos != std::string::npos) {
  3398. if (define[pos] == '(') {
  3399. std::ostringstream e;
  3400. /* clang-format off */
  3401. e << "WARNING: Function-style preprocessor definitions may not be "
  3402. << "passed on the compiler command line because many compilers "
  3403. << "do not support it.\n"
  3404. << "CMake is dropping a preprocessor definition: " << define << "\n"
  3405. << "Consider defining the macro in a (configured) header file.\n";
  3406. /* clang-format on */
  3407. cmSystemTools::Message(e.str());
  3408. return false;
  3409. }
  3410. }
  3411. // Many compilers do not support # in the value so we disable it.
  3412. if (define.find_first_of('#') != std::string::npos) {
  3413. std::ostringstream e;
  3414. /* clang-format off */
  3415. e << "WARNING: Preprocessor definitions containing '#' may not be "
  3416. << "passed on the compiler command line because many compilers "
  3417. << "do not support it.\n"
  3418. << "CMake is dropping a preprocessor definition: " << define << "\n"
  3419. << "Consider defining the macro in a (configured) header file.\n";
  3420. /* clang-format on */
  3421. cmSystemTools::Message(e.str());
  3422. return false;
  3423. }
  3424. // Assume it is supported.
  3425. return true;
  3426. }
  3427. static void cmLGInfoProp(cmMakefile* mf, cmGeneratorTarget* target,
  3428. const std::string& prop)
  3429. {
  3430. if (cmValue val = target->GetProperty(prop)) {
  3431. mf->AddDefinition(prop, *val);
  3432. }
  3433. }
  3434. void cmLocalGenerator::GenerateAppleInfoPList(cmGeneratorTarget* target,
  3435. const std::string& targetName,
  3436. const std::string& fname)
  3437. {
  3438. // Find the Info.plist template.
  3439. cmValue in = target->GetProperty("MACOSX_BUNDLE_INFO_PLIST");
  3440. std::string inFile = cmNonempty(in) ? *in : "MacOSXBundleInfo.plist.in";
  3441. if (!cmSystemTools::FileIsFullPath(inFile)) {
  3442. std::string inMod = this->Makefile->GetModulesFile(inFile);
  3443. if (!inMod.empty()) {
  3444. inFile = inMod;
  3445. }
  3446. }
  3447. if (!cmSystemTools::FileExists(inFile, true)) {
  3448. std::ostringstream e;
  3449. e << "Target " << target->GetName() << " Info.plist template \"" << inFile
  3450. << "\" could not be found.";
  3451. cmSystemTools::Error(e.str());
  3452. return;
  3453. }
  3454. // Convert target properties to variables in an isolated makefile
  3455. // scope to configure the file. If properties are set they will
  3456. // override user make variables. If not the configuration will fall
  3457. // back to the directory-level values set by the user.
  3458. cmMakefile* mf = this->Makefile;
  3459. cmMakefile::ScopePushPop varScope(mf);
  3460. mf->AddDefinition("MACOSX_BUNDLE_EXECUTABLE_NAME", targetName);
  3461. cmLGInfoProp(mf, target, "MACOSX_BUNDLE_INFO_STRING");
  3462. cmLGInfoProp(mf, target, "MACOSX_BUNDLE_ICON_FILE");
  3463. cmLGInfoProp(mf, target, "MACOSX_BUNDLE_GUI_IDENTIFIER");
  3464. cmLGInfoProp(mf, target, "MACOSX_BUNDLE_LONG_VERSION_STRING");
  3465. cmLGInfoProp(mf, target, "MACOSX_BUNDLE_BUNDLE_NAME");
  3466. cmLGInfoProp(mf, target, "MACOSX_BUNDLE_SHORT_VERSION_STRING");
  3467. cmLGInfoProp(mf, target, "MACOSX_BUNDLE_BUNDLE_VERSION");
  3468. cmLGInfoProp(mf, target, "MACOSX_BUNDLE_COPYRIGHT");
  3469. mf->ConfigureFile(inFile, fname, false, false, false);
  3470. }
  3471. void cmLocalGenerator::GenerateFrameworkInfoPList(
  3472. cmGeneratorTarget* target, const std::string& targetName,
  3473. const std::string& fname)
  3474. {
  3475. // Find the Info.plist template.
  3476. cmValue in = target->GetProperty("MACOSX_FRAMEWORK_INFO_PLIST");
  3477. std::string inFile = cmNonempty(in) ? *in : "MacOSXFrameworkInfo.plist.in";
  3478. if (!cmSystemTools::FileIsFullPath(inFile)) {
  3479. std::string inMod = this->Makefile->GetModulesFile(inFile);
  3480. if (!inMod.empty()) {
  3481. inFile = inMod;
  3482. }
  3483. }
  3484. if (!cmSystemTools::FileExists(inFile, true)) {
  3485. std::ostringstream e;
  3486. e << "Target " << target->GetName() << " Info.plist template \"" << inFile
  3487. << "\" could not be found.";
  3488. cmSystemTools::Error(e.str());
  3489. return;
  3490. }
  3491. // Convert target properties to variables in an isolated makefile
  3492. // scope to configure the file. If properties are set they will
  3493. // override user make variables. If not the configuration will fall
  3494. // back to the directory-level values set by the user.
  3495. cmMakefile* mf = this->Makefile;
  3496. cmMakefile::ScopePushPop varScope(mf);
  3497. mf->AddDefinition("MACOSX_FRAMEWORK_NAME", targetName);
  3498. cmLGInfoProp(mf, target, "MACOSX_FRAMEWORK_ICON_FILE");
  3499. cmLGInfoProp(mf, target, "MACOSX_FRAMEWORK_IDENTIFIER");
  3500. cmLGInfoProp(mf, target, "MACOSX_FRAMEWORK_SHORT_VERSION_STRING");
  3501. cmLGInfoProp(mf, target, "MACOSX_FRAMEWORK_BUNDLE_VERSION");
  3502. mf->ConfigureFile(inFile, fname, false, false, false);
  3503. }
  3504. namespace {
  3505. cm::string_view CustomOutputRoleKeyword(cmLocalGenerator::OutputRole role)
  3506. {
  3507. return (role == cmLocalGenerator::OutputRole::Primary ? "OUTPUT"_s
  3508. : "BYPRODUCTS"_s);
  3509. }
  3510. void CreateGeneratedSource(cmLocalGenerator& lg, const std::string& output,
  3511. cmLocalGenerator::OutputRole role,
  3512. cmCommandOrigin origin,
  3513. const cmListFileBacktrace& lfbt)
  3514. {
  3515. if (cmGeneratorExpression::Find(output) != std::string::npos) {
  3516. lg.GetCMakeInstance()->IssueMessage(
  3517. MessageType::FATAL_ERROR,
  3518. "Generator expressions in custom command outputs are not implemented!",
  3519. lfbt);
  3520. return;
  3521. }
  3522. // Make sure the file will not be generated into the source
  3523. // directory during an out of source build.
  3524. if (!lg.GetMakefile()->CanIWriteThisFile(output)) {
  3525. lg.GetCMakeInstance()->IssueMessage(
  3526. MessageType::FATAL_ERROR,
  3527. cmStrCat(CustomOutputRoleKeyword(role), " path\n ", output,
  3528. "\nin a source directory as an output of custom command."),
  3529. lfbt);
  3530. return;
  3531. }
  3532. // Make sure the output file name has no invalid characters.
  3533. std::string::size_type pos = output.find_first_of("#<>");
  3534. if (pos != std::string::npos) {
  3535. lg.GetCMakeInstance()->IssueMessage(
  3536. MessageType::FATAL_ERROR,
  3537. cmStrCat(CustomOutputRoleKeyword(role), " containing a \"", output[pos],
  3538. "\" is not allowed."),
  3539. lfbt);
  3540. return;
  3541. }
  3542. // Outputs without generator expressions from the project are already
  3543. // created and marked as generated. Do not mark them again, because
  3544. // other commands might have overwritten the property.
  3545. if (origin == cmCommandOrigin::Generator) {
  3546. lg.GetMakefile()->GetOrCreateGeneratedSource(output);
  3547. }
  3548. }
  3549. std::string ComputeCustomCommandRuleFileName(cmLocalGenerator& lg,
  3550. cmListFileBacktrace const& bt,
  3551. std::string const& output)
  3552. {
  3553. // If the output path has no generator expressions, use it directly.
  3554. if (cmGeneratorExpression::Find(output) == std::string::npos) {
  3555. return output;
  3556. }
  3557. // The output path contains a generator expression, but we must choose
  3558. // a single source file path to which to attach the custom command.
  3559. // Use some heuristics to provide a nice-looking name when possible.
  3560. // If the only genex is $<CONFIG>, replace that gracefully.
  3561. {
  3562. std::string simple = output;
  3563. cmSystemTools::ReplaceString(simple, "$<CONFIG>", "(CONFIG)");
  3564. if (cmGeneratorExpression::Find(simple) == std::string::npos) {
  3565. return simple;
  3566. }
  3567. }
  3568. // If the genex evaluates to the same value in all configurations, use that.
  3569. {
  3570. std::vector<std::string> allConfigOutputs =
  3571. lg.ExpandCustomCommandOutputGenex(output, bt);
  3572. if (allConfigOutputs.size() == 1) {
  3573. return allConfigOutputs.front();
  3574. }
  3575. }
  3576. // Fall back to a deterministic unique name.
  3577. cmCryptoHash h(cmCryptoHash::AlgoSHA256);
  3578. return cmStrCat(lg.GetCurrentBinaryDirectory(), "/CMakeFiles/",
  3579. h.HashString(output).substr(0, 16));
  3580. }
  3581. cmSourceFile* AddCustomCommand(cmLocalGenerator& lg, cmCommandOrigin origin,
  3582. std::unique_ptr<cmCustomCommand> cc,
  3583. bool replace)
  3584. {
  3585. cmMakefile* mf = lg.GetMakefile();
  3586. const auto& lfbt = cc->GetBacktrace();
  3587. const auto& outputs = cc->GetOutputs();
  3588. const auto& byproducts = cc->GetByproducts();
  3589. const auto& commandLines = cc->GetCommandLines();
  3590. // Choose a source file on which to store the custom command.
  3591. cmSourceFile* file = nullptr;
  3592. if (!commandLines.empty() && cc->HasMainDependency()) {
  3593. const auto& main_dependency = cc->GetMainDependency();
  3594. // The main dependency was specified. Use it unless a different
  3595. // custom command already used it.
  3596. file = mf->GetSource(main_dependency);
  3597. if (file && file->GetCustomCommand() && !replace) {
  3598. // The main dependency already has a custom command.
  3599. if (commandLines == file->GetCustomCommand()->GetCommandLines()) {
  3600. // The existing custom command is identical. Silently ignore
  3601. // the duplicate.
  3602. return file;
  3603. }
  3604. // The existing custom command is different. We need to
  3605. // generate a rule file for this new command.
  3606. file = nullptr;
  3607. } else if (!file) {
  3608. file = mf->CreateSource(main_dependency);
  3609. }
  3610. }
  3611. // Generate a rule file if the main dependency is not available.
  3612. if (!file) {
  3613. cmGlobalGenerator* gg = lg.GetGlobalGenerator();
  3614. // Construct a rule file associated with the first output produced.
  3615. std::string outName = gg->GenerateRuleFile(
  3616. ComputeCustomCommandRuleFileName(lg, lfbt, outputs[0]));
  3617. // Check if the rule file already exists.
  3618. file = mf->GetSource(outName, cmSourceFileLocationKind::Known);
  3619. if (file && file->GetCustomCommand() && !replace) {
  3620. // The rule file already exists.
  3621. if (commandLines != file->GetCustomCommand()->GetCommandLines()) {
  3622. lg.GetCMakeInstance()->IssueMessage(
  3623. MessageType::FATAL_ERROR,
  3624. cmStrCat("Attempt to add a custom rule to output\n ", outName,
  3625. "\nwhich already has a custom rule."),
  3626. lfbt);
  3627. }
  3628. return file;
  3629. }
  3630. // Create a cmSourceFile for the rule file.
  3631. if (!file) {
  3632. file = mf->CreateSource(outName, true, cmSourceFileLocationKind::Known);
  3633. }
  3634. file->SetProperty("__CMAKE_RULE", "1");
  3635. }
  3636. // Attach the custom command to the file.
  3637. if (file) {
  3638. cc->SetEscapeAllowMakeVars(true);
  3639. lg.AddSourceOutputs(file, outputs, cmLocalGenerator::OutputRole::Primary,
  3640. lfbt, origin);
  3641. lg.AddSourceOutputs(file, byproducts,
  3642. cmLocalGenerator::OutputRole::Byproduct, lfbt, origin);
  3643. file->SetCustomCommand(std::move(cc));
  3644. }
  3645. return file;
  3646. }
  3647. bool AnyOutputMatches(const std::string& name,
  3648. const std::vector<std::string>& outputs)
  3649. {
  3650. return std::any_of(outputs.begin(), outputs.end(),
  3651. [&name](std::string const& output) -> bool {
  3652. std::string::size_type pos = output.rfind(name);
  3653. // If the output matches exactly
  3654. return (pos != std::string::npos &&
  3655. pos == output.size() - name.size() &&
  3656. (pos == 0 || output[pos - 1] == '/'));
  3657. });
  3658. }
  3659. bool AnyTargetCommandOutputMatches(
  3660. const std::string& name, const std::vector<cmCustomCommand>& commands)
  3661. {
  3662. return std::any_of(commands.begin(), commands.end(),
  3663. [&name](cmCustomCommand const& command) -> bool {
  3664. return AnyOutputMatches(name, command.GetByproducts());
  3665. });
  3666. }
  3667. }
  3668. namespace detail {
  3669. void AddCustomCommandToTarget(cmLocalGenerator& lg, cmCommandOrigin origin,
  3670. cmTarget* target, cmCustomCommandType type,
  3671. std::unique_ptr<cmCustomCommand> cc)
  3672. {
  3673. // Add the command to the appropriate build step for the target.
  3674. cc->SetEscapeAllowMakeVars(true);
  3675. cc->SetTarget(target->GetName());
  3676. lg.AddTargetByproducts(target, cc->GetByproducts(), cc->GetBacktrace(),
  3677. origin);
  3678. switch (type) {
  3679. case cmCustomCommandType::PRE_BUILD:
  3680. target->AddPreBuildCommand(std::move(*cc));
  3681. break;
  3682. case cmCustomCommandType::PRE_LINK:
  3683. target->AddPreLinkCommand(std::move(*cc));
  3684. break;
  3685. case cmCustomCommandType::POST_BUILD:
  3686. target->AddPostBuildCommand(std::move(*cc));
  3687. break;
  3688. }
  3689. cc.reset();
  3690. }
  3691. cmSourceFile* AddCustomCommandToOutput(cmLocalGenerator& lg,
  3692. cmCommandOrigin origin,
  3693. std::unique_ptr<cmCustomCommand> cc,
  3694. bool replace)
  3695. {
  3696. return AddCustomCommand(lg, origin, std::move(cc), replace);
  3697. }
  3698. void AppendCustomCommandToOutput(cmLocalGenerator& lg,
  3699. const cmListFileBacktrace& lfbt,
  3700. const std::string& output,
  3701. const std::vector<std::string>& depends,
  3702. const cmImplicitDependsList& implicit_depends,
  3703. const cmCustomCommandLines& commandLines)
  3704. {
  3705. // Lookup an existing command.
  3706. cmSourceFile* sf = nullptr;
  3707. if (cmGeneratorExpression::Find(output) == std::string::npos) {
  3708. sf = lg.GetSourceFileWithOutput(output);
  3709. } else {
  3710. // This output path has a generator expression. Evaluate it to
  3711. // find the output for any configurations.
  3712. for (std::string const& out :
  3713. lg.ExpandCustomCommandOutputGenex(output, lfbt)) {
  3714. sf = lg.GetSourceFileWithOutput(out);
  3715. if (sf) {
  3716. break;
  3717. }
  3718. }
  3719. }
  3720. if (sf) {
  3721. if (cmCustomCommand* cc = sf->GetCustomCommand()) {
  3722. cc->AppendCommands(commandLines);
  3723. cc->AppendDepends(depends);
  3724. cc->AppendImplicitDepends(implicit_depends);
  3725. return;
  3726. }
  3727. }
  3728. // No existing command found.
  3729. lg.GetCMakeInstance()->IssueMessage(
  3730. MessageType::FATAL_ERROR,
  3731. cmStrCat("Attempt to APPEND to custom command with output\n ", output,
  3732. "\nwhich is not already a custom command output."),
  3733. lfbt);
  3734. }
  3735. void AddUtilityCommand(cmLocalGenerator& lg, cmCommandOrigin origin,
  3736. cmTarget* target, std::unique_ptr<cmCustomCommand> cc)
  3737. {
  3738. // They might be moved away
  3739. auto byproducts = cc->GetByproducts();
  3740. auto lfbt = cc->GetBacktrace();
  3741. // Use an empty comment to avoid generation of default comment.
  3742. if (!cc->GetComment()) {
  3743. cc->SetComment("");
  3744. }
  3745. // Create the generated symbolic output name of the utility target.
  3746. std::string output =
  3747. lg.CreateUtilityOutput(target->GetName(), byproducts, lfbt);
  3748. cc->SetOutputs(output);
  3749. cmSourceFile* rule = AddCustomCommand(lg, origin, std::move(cc),
  3750. /*replace=*/false);
  3751. if (rule) {
  3752. lg.AddTargetByproducts(target, byproducts, lfbt, origin);
  3753. }
  3754. target->AddSource(output);
  3755. }
  3756. std::vector<std::string> ComputeISPCObjectSuffixes(cmGeneratorTarget* target)
  3757. {
  3758. const std::string& targetProperty =
  3759. target->GetSafeProperty("ISPC_INSTRUCTION_SETS");
  3760. std::vector<std::string> ispcTargets;
  3761. if (!cmIsOff(targetProperty)) {
  3762. cmExpandList(targetProperty, ispcTargets);
  3763. for (auto& ispcTarget : ispcTargets) {
  3764. // transform targets into the suffixes
  3765. auto pos = ispcTarget.find('-');
  3766. auto target_suffix = ispcTarget.substr(0, pos);
  3767. if (target_suffix ==
  3768. "avx1") { // when targeting avx1 ISPC uses the 'avx' output string
  3769. target_suffix = "avx";
  3770. }
  3771. ispcTarget = target_suffix;
  3772. }
  3773. }
  3774. return ispcTargets;
  3775. }
  3776. std::vector<std::string> ComputeISPCExtraObjects(
  3777. std::string const& objectName, std::string const& buildDirectory,
  3778. std::vector<std::string> const& ispcSuffixes)
  3779. {
  3780. auto normalizedDir = cmSystemTools::CollapseFullPath(buildDirectory);
  3781. std::vector<std::string> computedObjects;
  3782. computedObjects.reserve(ispcSuffixes.size());
  3783. auto extension = cmSystemTools::GetFilenameLastExtension(objectName);
  3784. // We can't use cmSystemTools::GetFilenameWithoutLastExtension as it
  3785. // drops any directories in objectName
  3786. auto objNameNoExt = objectName;
  3787. std::string::size_type dot_pos = objectName.rfind('.');
  3788. if (dot_pos != std::string::npos) {
  3789. objNameNoExt.resize(dot_pos);
  3790. }
  3791. for (const auto& ispcTarget : ispcSuffixes) {
  3792. computedObjects.emplace_back(
  3793. cmStrCat(normalizedDir, "/", objNameNoExt, "_", ispcTarget, extension));
  3794. }
  3795. return computedObjects;
  3796. }
  3797. }
  3798. cmSourcesWithOutput cmLocalGenerator::GetSourcesWithOutput(
  3799. const std::string& name) const
  3800. {
  3801. // Linear search? Also see GetSourceFileWithOutput for detail.
  3802. if (!cmSystemTools::FileIsFullPath(name)) {
  3803. cmSourcesWithOutput sources;
  3804. sources.Target = this->LinearGetTargetWithOutput(name);
  3805. sources.Source = this->LinearGetSourceFileWithOutput(
  3806. name, cmSourceOutputKind::OutputOrByproduct, sources.SourceIsByproduct);
  3807. return sources;
  3808. }
  3809. // Otherwise we use an efficient lookup map.
  3810. auto o = this->OutputToSource.find(name);
  3811. if (o != this->OutputToSource.end()) {
  3812. return o->second.Sources;
  3813. }
  3814. return {};
  3815. }
  3816. cmSourceFile* cmLocalGenerator::GetSourceFileWithOutput(
  3817. const std::string& name, cmSourceOutputKind kind) const
  3818. {
  3819. // If the queried path is not absolute we use the backward compatible
  3820. // linear-time search for an output with a matching suffix.
  3821. if (!cmSystemTools::FileIsFullPath(name)) {
  3822. bool byproduct = false;
  3823. return this->LinearGetSourceFileWithOutput(name, kind, byproduct);
  3824. }
  3825. // Otherwise we use an efficient lookup map.
  3826. auto o = this->OutputToSource.find(name);
  3827. if (o != this->OutputToSource.end() &&
  3828. (!o->second.Sources.SourceIsByproduct ||
  3829. kind == cmSourceOutputKind::OutputOrByproduct)) {
  3830. // Source file could also be null pointer for example if we found the
  3831. // byproduct of a utility target, a PRE_BUILD, PRE_LINK, or POST_BUILD
  3832. // command of a target, or a not yet created custom command.
  3833. return o->second.Sources.Source;
  3834. }
  3835. return nullptr;
  3836. }
  3837. std::string cmLocalGenerator::CreateUtilityOutput(
  3838. std::string const& targetName, std::vector<std::string> const&,
  3839. cmListFileBacktrace const&)
  3840. {
  3841. std::string force =
  3842. cmStrCat(this->GetCurrentBinaryDirectory(), "/CMakeFiles/", targetName);
  3843. // The output is not actually created so mark it symbolic.
  3844. if (cmSourceFile* sf = this->Makefile->GetOrCreateGeneratedSource(force)) {
  3845. sf->SetProperty("SYMBOLIC", "1");
  3846. } else {
  3847. cmSystemTools::Error("Could not get source file entry for " + force);
  3848. }
  3849. return force;
  3850. }
  3851. std::vector<cmCustomCommandGenerator>
  3852. cmLocalGenerator::MakeCustomCommandGenerators(cmCustomCommand const& cc,
  3853. std::string const& config)
  3854. {
  3855. std::vector<cmCustomCommandGenerator> ccgs;
  3856. ccgs.emplace_back(cc, config, this);
  3857. return ccgs;
  3858. }
  3859. std::vector<std::string> cmLocalGenerator::ExpandCustomCommandOutputPaths(
  3860. cmCompiledGeneratorExpression const& cge, std::string const& config)
  3861. {
  3862. std::vector<std::string> paths = cmExpandedList(cge.Evaluate(this, config));
  3863. for (std::string& p : paths) {
  3864. p = cmSystemTools::CollapseFullPath(p, this->GetCurrentBinaryDirectory());
  3865. }
  3866. return paths;
  3867. }
  3868. std::vector<std::string> cmLocalGenerator::ExpandCustomCommandOutputGenex(
  3869. std::string const& o, cmListFileBacktrace const& bt)
  3870. {
  3871. std::vector<std::string> allConfigOutputs;
  3872. cmGeneratorExpression ge(bt);
  3873. std::unique_ptr<cmCompiledGeneratorExpression> cge = ge.Parse(o);
  3874. std::vector<std::string> configs =
  3875. this->Makefile->GetGeneratorConfigs(cmMakefile::IncludeEmptyConfig);
  3876. for (std::string const& config : configs) {
  3877. std::vector<std::string> configOutputs =
  3878. this->ExpandCustomCommandOutputPaths(*cge, config);
  3879. allConfigOutputs.reserve(allConfigOutputs.size() + configOutputs.size());
  3880. std::move(configOutputs.begin(), configOutputs.end(),
  3881. std::back_inserter(allConfigOutputs));
  3882. }
  3883. auto endUnique =
  3884. cmRemoveDuplicates(allConfigOutputs.begin(), allConfigOutputs.end());
  3885. allConfigOutputs.erase(endUnique, allConfigOutputs.end());
  3886. return allConfigOutputs;
  3887. }
  3888. void cmLocalGenerator::AddTargetByproducts(
  3889. cmTarget* target, const std::vector<std::string>& byproducts,
  3890. cmListFileBacktrace const& bt, cmCommandOrigin origin)
  3891. {
  3892. for (std::string const& o : byproducts) {
  3893. if (cmGeneratorExpression::Find(o) == std::string::npos) {
  3894. this->UpdateOutputToSourceMap(o, target, bt, origin);
  3895. continue;
  3896. }
  3897. // This byproduct path has a generator expression. Evaluate it to
  3898. // register the byproducts for all configurations.
  3899. for (std::string const& b : this->ExpandCustomCommandOutputGenex(o, bt)) {
  3900. this->UpdateOutputToSourceMap(b, target, bt, cmCommandOrigin::Generator);
  3901. }
  3902. }
  3903. }
  3904. void cmLocalGenerator::AddSourceOutputs(
  3905. cmSourceFile* source, const std::vector<std::string>& outputs,
  3906. OutputRole role, cmListFileBacktrace const& bt, cmCommandOrigin origin)
  3907. {
  3908. for (std::string const& o : outputs) {
  3909. if (cmGeneratorExpression::Find(o) == std::string::npos) {
  3910. this->UpdateOutputToSourceMap(o, source, role, bt, origin);
  3911. continue;
  3912. }
  3913. // This output path has a generator expression. Evaluate it to
  3914. // register the outputs for all configurations.
  3915. for (std::string const& out :
  3916. this->ExpandCustomCommandOutputGenex(o, bt)) {
  3917. this->UpdateOutputToSourceMap(out, source, role, bt,
  3918. cmCommandOrigin::Generator);
  3919. }
  3920. }
  3921. }
  3922. void cmLocalGenerator::UpdateOutputToSourceMap(std::string const& byproduct,
  3923. cmTarget* target,
  3924. cmListFileBacktrace const& bt,
  3925. cmCommandOrigin origin)
  3926. {
  3927. SourceEntry entry;
  3928. entry.Sources.Target = target;
  3929. auto pr = this->OutputToSource.emplace(byproduct, entry);
  3930. if (pr.second) {
  3931. CreateGeneratedSource(*this, byproduct, OutputRole::Byproduct, origin, bt);
  3932. } else {
  3933. SourceEntry& current = pr.first->second;
  3934. // Has the target already been set?
  3935. if (!current.Sources.Target) {
  3936. current.Sources.Target = target;
  3937. } else {
  3938. // Multiple custom commands/targets produce the same output (source file
  3939. // or target). See also comment in other UpdateOutputToSourceMap
  3940. // overload.
  3941. //
  3942. // TODO: Warn the user about this case.
  3943. }
  3944. }
  3945. }
  3946. void cmLocalGenerator::UpdateOutputToSourceMap(std::string const& output,
  3947. cmSourceFile* source,
  3948. OutputRole role,
  3949. cmListFileBacktrace const& bt,
  3950. cmCommandOrigin origin)
  3951. {
  3952. SourceEntry entry;
  3953. entry.Sources.Source = source;
  3954. entry.Sources.SourceIsByproduct = role == OutputRole::Byproduct;
  3955. auto pr = this->OutputToSource.emplace(output, entry);
  3956. if (pr.second) {
  3957. CreateGeneratedSource(*this, output, role, origin, bt);
  3958. } else {
  3959. SourceEntry& current = pr.first->second;
  3960. // Outputs take precedence over byproducts
  3961. if (!current.Sources.Source ||
  3962. (current.Sources.SourceIsByproduct && role == OutputRole::Primary)) {
  3963. current.Sources.Source = source;
  3964. current.Sources.SourceIsByproduct = false;
  3965. } else {
  3966. // Multiple custom commands produce the same output but may
  3967. // be attached to a different source file (MAIN_DEPENDENCY).
  3968. // LinearGetSourceFileWithOutput would return the first one,
  3969. // so keep the mapping for the first one.
  3970. //
  3971. // TODO: Warn the user about this case. However, the VS 8 generator
  3972. // triggers it for separate generate.stamp rules in ZERO_CHECK and
  3973. // individual targets.
  3974. }
  3975. }
  3976. }
  3977. cmTarget* cmLocalGenerator::LinearGetTargetWithOutput(
  3978. const std::string& name) const
  3979. {
  3980. // We go through the ordered vector of targets to get reproducible results
  3981. // should multiple names match.
  3982. for (cmTarget* t : this->Makefile->GetOrderedTargets()) {
  3983. // Does the output of any command match the source file name?
  3984. if (AnyTargetCommandOutputMatches(name, t->GetPreBuildCommands())) {
  3985. return t;
  3986. }
  3987. if (AnyTargetCommandOutputMatches(name, t->GetPreLinkCommands())) {
  3988. return t;
  3989. }
  3990. if (AnyTargetCommandOutputMatches(name, t->GetPostBuildCommands())) {
  3991. return t;
  3992. }
  3993. }
  3994. return nullptr;
  3995. }
  3996. cmSourceFile* cmLocalGenerator::LinearGetSourceFileWithOutput(
  3997. const std::string& name, cmSourceOutputKind kind, bool& byproduct) const
  3998. {
  3999. // Outputs take precedence over byproducts.
  4000. byproduct = false;
  4001. cmSourceFile* fallback = nullptr;
  4002. // Look through all the source files that have custom commands and see if the
  4003. // custom command has the passed source file as an output.
  4004. for (const auto& src : this->Makefile->GetSourceFiles()) {
  4005. // Does this source file have a custom command?
  4006. if (src->GetCustomCommand()) {
  4007. // Does the output of the custom command match the source file name?
  4008. if (AnyOutputMatches(name, src->GetCustomCommand()->GetOutputs())) {
  4009. // Return the first matching output.
  4010. return src.get();
  4011. }
  4012. if (kind == cmSourceOutputKind::OutputOrByproduct) {
  4013. if (AnyOutputMatches(name, src->GetCustomCommand()->GetByproducts())) {
  4014. // Do not return the source yet as there might be a matching output.
  4015. fallback = src.get();
  4016. }
  4017. }
  4018. }
  4019. }
  4020. // Did we find a byproduct?
  4021. byproduct = fallback != nullptr;
  4022. return fallback;
  4023. }