/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying file Copyright.txt or https://cmake.org/licensing for details. */ #pragma once #include "cmConfigure.h" // IWYU pragma: keep #include #include #include #include #include #include #include #include #include #include #include #include "cmCustomCommandTypes.h" #include "cmListFileCache.h" #include "cmMessageType.h" #include "cmOutputConverter.h" #include "cmPolicies.h" #include "cmStateSnapshot.h" #include "cmValue.h" class cmCompiledGeneratorExpression; class cmComputeLinkInformation; class cmCustomCommand; class cmCustomCommandGenerator; class cmCustomCommandLines; class cmGeneratorTarget; class cmGlobalGenerator; class cmImplicitDependsList; class cmLinkLineComputer; class cmMakefile; class cmRulePlaceholderExpander; class cmSourceFile; class cmState; class cmTarget; class cmake; template class cmRange; /** Flag if byproducts shall also be considered. */ enum class cmSourceOutputKind { OutputOnly, OutputOrByproduct }; /** What scanner to use for dependencies lookup. */ enum class cmDependencyScannerKind { CMake, Compiler }; /** Target and source file which have a specific output. */ struct cmSourcesWithOutput { /** Target with byproduct. */ cmTarget* Target = nullptr; /** Source file with output or byproduct. */ cmSourceFile* Source = nullptr; bool SourceIsByproduct = false; }; /** \class cmLocalGenerator * \brief Create required build files for a directory. * * Subclasses of this abstract class generate makefiles, DSP, etc for various * platforms. This class should never be constructed directly. A * GlobalGenerator will create it and invoke the appropriate commands on it. */ class cmLocalGenerator : public cmOutputConverter { public: cmLocalGenerator(cmGlobalGenerator* gg, cmMakefile* makefile); virtual ~cmLocalGenerator(); /** * Generate the makefile for this directory. */ virtual void Generate() {} virtual void ComputeHomeRelativeOutputPath() {} /** * Calls TraceVSDependencies() on all targets of this generator. */ void TraceDependencies() const; virtual void AddHelperCommands() {} /** * Generate the install rules files in this directory. */ void GenerateInstallRules(); /** * Generate the test files for tests. */ void GenerateTestFiles(); /** * Generate a manifest of target files that will be built. */ void ComputeTargetManifest(); bool ComputeTargetCompileFeatures(); bool IsRootMakefile() const; //! Get the makefile for this generator cmMakefile* GetMakefile() { return this->Makefile; } //! Get the makefile for this generator, const version const cmMakefile* GetMakefile() const { return this->Makefile; } //! Get the GlobalGenerator this is associated with cmGlobalGenerator* GetGlobalGenerator() { return this->GlobalGenerator; } const cmGlobalGenerator* GetGlobalGenerator() const { return this->GlobalGenerator; } virtual cmRulePlaceholderExpander* CreateRulePlaceholderExpander() const; std::string GetLinkLibsCMP0065(std::string const& linkLanguage, cmGeneratorTarget& tgt) const; cmState* GetState() const; cmStateSnapshot GetStateSnapshot() const; void AddArchitectureFlags(std::string& flags, cmGeneratorTarget const* target, const std::string& lang, const std::string& config, const std::string& filterArch = std::string()); void AddLanguageFlags(std::string& flags, cmGeneratorTarget const* target, const std::string& lang, const std::string& config); void AddLanguageFlagsForLinking(std::string& flags, cmGeneratorTarget const* target, const std::string& lang, const std::string& config); void AddCMP0018Flags(std::string& flags, cmGeneratorTarget const* target, std::string const& lang, const std::string& config); void AddVisibilityPresetFlags(std::string& flags, cmGeneratorTarget const* target, const std::string& lang); void AddConfigVariableFlags(std::string& flags, const std::string& var, const std::string& config); void AddCompilerRequirementFlag(std::string& flags, cmGeneratorTarget const* target, const std::string& lang, const std::string& config); void AddColorDiagnosticsFlags(std::string& flags, const std::string& lang); //! Append flags to a string. virtual void AppendFlags(std::string& flags, const std::string& newFlags) const; virtual void AppendFlags(std::string& flags, const std::vector>& newFlags) const; virtual void AppendFlagEscape(std::string& flags, const std::string& rawFlag) const; void AddISPCDependencies(cmGeneratorTarget* target); void AddPchDependencies(cmGeneratorTarget* target); void AddUnityBuild(cmGeneratorTarget* target); virtual void AddXCConfigSources(cmGeneratorTarget* /* target */) {} void AppendIPOLinkerFlags(std::string& flags, cmGeneratorTarget* target, const std::string& config, const std::string& lang); void AppendPositionIndependentLinkerFlags(std::string& flags, cmGeneratorTarget* target, const std::string& config, const std::string& lang); bool AppendLWYUFlags(std::string& flags, const cmGeneratorTarget* target, const std::string& lang); //! Get the include flags for the current makefile and language std::string GetIncludeFlags(std::vector const& includes, cmGeneratorTarget* target, std::string const& lang, std::string const& config, bool forResponseFile = false); using GeneratorTargetVector = std::vector>; const GeneratorTargetVector& GetGeneratorTargets() const { return this->GeneratorTargets; } const GeneratorTargetVector& GetOwnedImportedGeneratorTargets() const { return this->OwnedImportedGeneratorTargets; } void AddGeneratorTarget(std::unique_ptr gt); void AddImportedGeneratorTarget(cmGeneratorTarget* gt); void AddOwnedImportedGeneratorTarget(std::unique_ptr gt); cmGeneratorTarget* FindLocalNonAliasGeneratorTarget( const std::string& name) const; cmGeneratorTarget* FindGeneratorTargetToUse(const std::string& name) const; /** * Process a list of include directories */ void AppendIncludeDirectories(std::vector& includes, std::string const& includes_list, const cmSourceFile& sourceFile) const; void AppendIncludeDirectories(std::vector& includes, const std::vector& includes_vec, const cmSourceFile& sourceFile) const; /** * Encode a list of preprocessor definitions for the compiler * command line. */ void AppendDefines(std::set& defines, std::string const& defines_list) const; void AppendDefines(std::set>& defines, std::string const& defines_list) const; void AppendDefines(std::set>& defines, const std::vector>& defines_vec) const; /** * Encode a list of compile options for the compiler * command line. */ void AppendCompileOptions(std::string& options, std::string const& options_list, const char* regex = nullptr) const; void AppendCompileOptions(std::string& options, const std::vector& options_vec, const char* regex = nullptr) const; void AppendCompileOptions(std::vector>& options, const std::vector>& options_vec, const char* regex = nullptr) const; /** * Join a set of defines into a definesString with a space separator. */ void JoinDefines(const std::set& defines, std::string& definesString, const std::string& lang); /** Lookup and append options associated with a particular feature. */ void AppendFeatureOptions(std::string& flags, const std::string& lang, const char* feature); cmValue GetFeature(const std::string& feature, const std::string& config); /** \brief Get absolute path to dependency \a name * * Translate a dependency as given in CMake code to the name to * appear in a generated build file. * - If \a name is a utility target, returns false. * - If \a name is a CMake target, it will be transformed to the real output * location of that target for the given configuration. * - If \a name is the full path to a file, it will be returned. * - Otherwise \a name is treated as a relative path with respect to * the source directory of this generator. This should only be * used for dependencies of custom commands. */ bool GetRealDependency(const std::string& name, const std::string& config, std::string& dep); /** Called from command-line hook to clear dependencies. */ virtual void ClearDependencies(cmMakefile* /* mf */, bool /* verbose */) {} /** Called from command-line hook to update dependencies. */ virtual bool UpdateDependencies(const std::string& /* tgtInfo */, bool /*verbose*/, bool /*color*/) { return true; } /** @brief Get the include directories for the current makefile and language * and optional the compiler implicit include directories. * * @arg stripImplicitDirs Strip all directories found in * CMAKE__IMPLICIT_INCLUDE_DIRECTORIES from the result. * @arg appendAllImplicitDirs Append all directories found in * CMAKE__IMPLICIT_INCLUDE_DIRECTORIES to the result. */ std::vector> GetIncludeDirectoriesImplicit( cmGeneratorTarget const* target, std::string const& lang = "C", std::string const& config = "", bool stripImplicitDirs = true, bool appendAllImplicitDirs = false) const; /** @brief Get the include directories for the current makefile and language * and optional the compiler implicit include directories. * * @arg dirs Directories are appended to this list */ void GetIncludeDirectoriesImplicit(std::vector& dirs, cmGeneratorTarget const* target, const std::string& lang = "C", const std::string& config = "", bool stripImplicitDirs = true, bool appendAllImplicitDirs = false) const; /** @brief Get the include directories for the current makefile and language. * @arg dirs Include directories are appended to this list */ void GetIncludeDirectories(std::vector& dirs, cmGeneratorTarget const* target, const std::string& lang = "C", const std::string& config = "") const; /** @brief Get the include directories for the current makefile and language. * @return The include directory list */ std::vector> GetIncludeDirectories( cmGeneratorTarget const* target, std::string const& lang = "C", std::string const& config = "") const; void AddCompileOptions(std::string& flags, cmGeneratorTarget* target, const std::string& lang, const std::string& config); void AddCompileOptions(std::vector>& flags, cmGeneratorTarget* target, const std::string& lang, const std::string& config); /** * Add a custom PRE_BUILD, PRE_LINK, or POST_BUILD command to a target. */ cmTarget* AddCustomCommandToTarget( const std::string& target, cmCustomCommandType type, std::unique_ptr cc, cmObjectLibraryCommands objLibCommands = cmObjectLibraryCommands::Reject); /** * Add a custom command to a source file. */ cmSourceFile* AddCustomCommandToOutput(std::unique_ptr cc, bool replace = false); /** * Add a utility to the build. A utility target is a command that is run * every time the target is built. */ cmTarget* AddUtilityCommand(const std::string& utilityName, bool excludeFromAll, std::unique_ptr cc); virtual std::string CreateUtilityOutput( std::string const& targetName, std::vector const& byproducts, cmListFileBacktrace const& bt); virtual std::vector MakeCustomCommandGenerators( cmCustomCommand const& cc, std::string const& config); std::vector ExpandCustomCommandOutputPaths( cmCompiledGeneratorExpression const& cge, std::string const& config); std::vector ExpandCustomCommandOutputGenex( std::string const& o, cmListFileBacktrace const& bt); /** * Add target byproducts. */ void AddTargetByproducts(cmTarget* target, const std::vector& byproducts, cmListFileBacktrace const& bt, cmCommandOrigin origin); enum class OutputRole { Primary, Byproduct, }; /** * Add source file outputs. */ void AddSourceOutputs(cmSourceFile* source, std::vector const& outputs, OutputRole role, cmListFileBacktrace const& bt, cmCommandOrigin origin); /** * Return the target if the provided source name is a byproduct of a utility * target or a PRE_BUILD, PRE_LINK, or POST_BUILD command. * Return the source file which has the provided source name as output. */ cmSourcesWithOutput GetSourcesWithOutput(const std::string& name) const; /** * Is there a source file that has the provided source name as an output? * If so then return it. */ cmSourceFile* GetSourceFileWithOutput( const std::string& name, cmSourceOutputKind kind = cmSourceOutputKind::OutputOnly) const; std::string GetProjectName() const; /** Compute the language used to compile the given source file. */ std::string GetSourceFileLanguage(const cmSourceFile& source); // Fill the vector with the target names for the object files, // preprocessed files and assembly files. void GetIndividualFileTargets(std::vector&) {} /** * Get the relative path from the generator output directory to a * per-target support directory. */ virtual std::string GetTargetDirectory( cmGeneratorTarget const* target) const; /** * Get the level of backwards compatibility requested by the project * in this directory. This is the value of the CMake variable * CMAKE_BACKWARDS_COMPATIBILITY whose format is * "major.minor[.patch]". The returned integer is encoded as * * CMake_VERSION_ENCODE(major, minor, patch) * * and is monotonically increasing with the CMake version. */ KWIML_INT_uint64_t GetBackwardsCompatibility(); /** * Test whether compatibility is set to a given version or lower. */ bool NeedBackwardsCompatibility_2_4(); cmPolicies::PolicyStatus GetPolicyStatus(cmPolicies::PolicyID id) const; cmake* GetCMakeInstance() const; std::string const& GetSourceDirectory() const; std::string const& GetBinaryDirectory() const; std::string const& GetCurrentBinaryDirectory() const; std::string const& GetCurrentSourceDirectory() const; /** * Generate a macOS application bundle Info.plist file. */ void GenerateAppleInfoPList(cmGeneratorTarget* target, const std::string& targetName, const std::string& fname); /** * Generate a macOS framework Info.plist file. */ void GenerateFrameworkInfoPList(cmGeneratorTarget* target, const std::string& targetName, const std::string& fname); /** Construct a comment for a custom command. */ std::string ConstructComment(cmCustomCommandGenerator const& ccg, const char* default_comment = "") const; // Compute object file names. std::string GetObjectFileNameWithoutTarget( const cmSourceFile& source, std::string const& dir_max, bool* hasSourceExtension = nullptr, char const* customOutputExtension = nullptr); /** Fill out the static linker flags for the given target. */ void GetStaticLibraryFlags(std::string& flags, std::string const& config, std::string const& linkLanguage, cmGeneratorTarget* target); std::vector> GetStaticLibraryFlags( std::string const& config, std::string const& linkLanguage, cmGeneratorTarget* target); /** Fill out these strings for the given target. Libraries to link, * flags, and linkflags. */ void GetDeviceLinkFlags(cmLinkLineComputer& linkLineComputer, const std::string& config, std::string& linkLibs, std::string& linkFlags, std::string& frameworkPath, std::string& linkPath, cmGeneratorTarget* target); void GetTargetFlags(cmLinkLineComputer* linkLineComputer, const std::string& config, std::string& linkLibs, std::string& flags, std::string& linkFlags, std::string& frameworkPath, std::string& linkPath, cmGeneratorTarget* target); void GetTargetFlags( cmLinkLineComputer* linkLineComputer, const std::string& config, std::vector>& linkLibs, std::string& flags, std::vector>& linkFlags, std::string& frameworkPath, std::vector>& linkPath, cmGeneratorTarget* target); void GetTargetDefines(cmGeneratorTarget const* target, std::string const& config, std::string const& lang, std::set& defines) const; std::set> GetTargetDefines(cmGeneratorTarget const* target, std::string const& config, std::string const& lang) const; void GetTargetCompileFlags(cmGeneratorTarget* target, std::string const& config, std::string const& lang, std::string& flags, std::string const& arch); std::vector> GetTargetCompileFlags( cmGeneratorTarget* target, std::string const& config, std::string const& lang, std::string const& arch = std::string()); std::string GetFrameworkFlags(std::string const& l, std::string const& config, cmGeneratorTarget* target); virtual std::string GetTargetFortranFlags(cmGeneratorTarget const* target, std::string const& config); virtual void ComputeObjectFilenames( std::map& mapping, cmGeneratorTarget const* gt = nullptr); bool IsWindowsShell() const; bool IsWatcomWMake() const; bool IsMinGWMake() const; bool IsNMake() const; bool IsNinjaMulti() const; void IssueMessage(MessageType t, std::string const& text) const; void CreateEvaluationFileOutputs(); void CreateEvaluationFileOutputs(const std::string& config); void ProcessEvaluationFiles(std::vector& generatedFiles); cmValue GetRuleLauncher(cmGeneratorTarget* target, const std::string& prop); protected: // The default implementation converts to a Windows shortpath to // help older toolchains handle spaces and such. A generator may // override this to avoid that conversion. virtual std::string ConvertToIncludeReference( std::string const& path, cmOutputConverter::OutputFormat format); //! put all the libraries for a target on into the given stream void OutputLinkLibraries(cmComputeLinkInformation* pcli, cmLinkLineComputer* linkLineComputer, std::string& linkLibraries, std::string& frameworkPath, std::string& linkPath); void OutputLinkLibraries(cmComputeLinkInformation* pcli, cmLinkLineComputer* linkLineComputer, std::vector>& linkLibraries, std::string& frameworkPath, std::vector>& linkPath); // Handle old-style install rules stored in the targets. void GenerateTargetInstallRules( std::ostream& os, const std::string& config, std::vector const& configurationTypes); virtual void AddGeneratorSpecificInstallSetup(std::ostream&) {} std::string& CreateSafeUniqueObjectFileName(const std::string& sin, std::string const& dir_max); /** Check whether the native build system supports the given definition. Issues a warning. */ virtual bool CheckDefinition(std::string const& define) const; cmMakefile* Makefile; cmListFileBacktrace DirectoryBacktrace; cmGlobalGenerator* GlobalGenerator; std::map UniqueObjectNamesMap; std::string::size_type ObjectPathMax; std::set ObjectMaxPathViolations; std::vector EnvCPATH; using GeneratorTargetMap = std::unordered_map; GeneratorTargetMap GeneratorTargetSearchIndex; GeneratorTargetVector GeneratorTargets; std::set WarnCMP0063; GeneratorTargetMap ImportedGeneratorTargets; GeneratorTargetVector OwnedImportedGeneratorTargets; std::map AliasTargets; std::map Compilers; std::map VariableMappings; std::string CompilerSysroot; std::string LinkerSysroot; std::unordered_map AppleArchSysroots; bool EmitUniversalBinaryFlags; KWIML_INT_uint64_t BackwardsCompatibility; bool BackwardsCompatibilityFinal; private: /** * See LinearGetSourceFileWithOutput for background information */ cmTarget* LinearGetTargetWithOutput(const std::string& name) const; /** * Generalized old version of GetSourceFileWithOutput kept for * backward-compatibility. It implements a linear search and supports * relative file paths. It is used as a fall back by GetSourceFileWithOutput * and GetSourcesWithOutput. */ cmSourceFile* LinearGetSourceFileWithOutput(const std::string& name, cmSourceOutputKind kind, bool& byproduct) const; struct SourceEntry { cmSourcesWithOutput Sources; }; // A map for fast output to input look up. using OutputToSourceMap = std::unordered_map; OutputToSourceMap OutputToSource; void UpdateOutputToSourceMap(std::string const& byproduct, cmTarget* target, cmListFileBacktrace const& bt, cmCommandOrigin origin); void UpdateOutputToSourceMap(std::string const& output, cmSourceFile* source, OutputRole role, cmListFileBacktrace const& bt, cmCommandOrigin origin); void AddSharedFlags(std::string& flags, const std::string& lang, bool shared); bool GetShouldUseOldFlags(bool shared, const std::string& lang) const; void AddPositionIndependentFlags(std::string& flags, std::string const& l, int targetType); void ComputeObjectMaxPath(); bool AllAppleArchSysrootsAreTheSame(const std::vector& archs, cmValue sysroot); void CopyPchCompilePdb(const std::string& config, cmGeneratorTarget* target, const std::string& ReuseFrom, cmGeneratorTarget* reuseTarget, std::vector const& extensions); struct UnityBatchedSource { cmSourceFile* Source = nullptr; std::vector Configs; UnityBatchedSource(cmSourceFile* sf) : Source(sf) { } }; struct UnitySource { std::string Path; bool PerConfig = false; UnitySource(std::string path, bool perConfig) : Path(std::move(path)) , PerConfig(perConfig) { } }; UnitySource WriteUnitySource( cmGeneratorTarget* target, std::vector const& configs, cmRange::const_iterator> sources, cmValue beforeInclude, cmValue afterInclude, std::string filename) const; void WriteUnitySourceInclude(std::ostream& unity_file, cm::optional const& cond, std::string const& sf_full_path, cmValue beforeInclude, cmValue afterInclude, cmValue uniqueIdName) const; std::vector AddUnityFilesModeAuto( cmGeneratorTarget* target, std::string const& lang, std::vector const& configs, std::vector const& filtered_sources, cmValue beforeInclude, cmValue afterInclude, std::string const& filename_base, size_t batchSize); std::vector AddUnityFilesModeGroup( cmGeneratorTarget* target, std::string const& lang, std::vector const& configs, std::vector const& filtered_sources, cmValue beforeInclude, cmValue afterInclude, std::string const& filename_base); }; #if !defined(CMAKE_BOOTSTRAP) bool cmLocalGeneratorCheckObjectName(std::string& objName, std::string::size_type dir_len, std::string::size_type max_total_len); #endif namespace detail { void AddCustomCommandToTarget(cmLocalGenerator& lg, cmCommandOrigin origin, cmTarget* target, cmCustomCommandType type, std::unique_ptr cc); cmSourceFile* AddCustomCommandToOutput(cmLocalGenerator& lg, cmCommandOrigin origin, std::unique_ptr cc, bool replace); void AppendCustomCommandToOutput(cmLocalGenerator& lg, const cmListFileBacktrace& lfbt, const std::string& output, const std::vector& depends, const cmImplicitDependsList& implicit_depends, const cmCustomCommandLines& commandLines); void AddUtilityCommand(cmLocalGenerator& lg, cmCommandOrigin origin, cmTarget* target, std::unique_ptr cc); std::vector ComputeISPCObjectSuffixes(cmGeneratorTarget* target); std::vector ComputeISPCExtraObjects( std::string const& objectName, std::string const& buildDirectory, std::vector const& ispcSuffixes); }