| /*============================================================================ |
| CMake - Cross Platform Makefile Generator |
| Copyright 2000-2009 Kitware, Inc., Insight Software Consortium |
| |
| Distributed under the OSI-approved BSD License (the "License"); |
| see accompanying file Copyright.txt for details. |
| |
| This software is distributed WITHOUT ANY WARRANTY; without even the |
| implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. |
| See the License for more information. |
| ============================================================================*/ |
| |
| #ifndef cmGlobalGenerator_h |
| #define cmGlobalGenerator_h |
| |
| #include "cmStandardIncludes.h" |
| |
| #include "cmTarget.h" // For cmTargets |
| #include "cmTargetDepend.h" // For cmTargetDependSet |
| #include "cmSystemTools.h" // for cmSystemTools::OutputOption |
| #include "cmExportSetMap.h" // For cmExportSetMap |
| #include "cmGeneratorTarget.h" |
| #include "cmGeneratorExpression.h" |
| #include "cmState.h" |
| |
| #if defined(CMAKE_BUILD_WITH_CMAKE) |
| # include "cmFileLockPool.h" |
| # ifdef CMake_HAVE_CXX11_UNORDERED_MAP |
| # include <unordered_map> |
| # else |
| # include <cmsys/hash_map.hxx> |
| # endif |
| #endif |
| |
| class cmake; |
| class cmGeneratorTarget; |
| class cmGeneratorExpressionEvaluationFile; |
| class cmMakefile; |
| class cmLocalGenerator; |
| class cmExternalMakefileProjectGenerator; |
| class cmTarget; |
| class cmInstallTargetGenerator; |
| class cmInstallFilesGenerator; |
| class cmExportBuildFileGenerator; |
| class cmQtAutoGenerators; |
| |
| /** \class cmGlobalGenerator |
| * \brief Responsible for overseeing the generation process for the entire tree |
| * |
| * Subclasses of this class generate makefiles for various |
| * platforms. |
| */ |
| class cmGlobalGenerator |
| { |
| public: |
| ///! Free any memory allocated with the GlobalGenerator |
| cmGlobalGenerator(cmake* cm); |
| virtual ~cmGlobalGenerator(); |
| |
| cmLocalGenerator* MakeLocalGenerator( |
| cmState::Snapshot snapshot = cmState::Snapshot(), |
| cmLocalGenerator* parent = 0); |
| |
| ///! Get the name for this generator |
| virtual std::string GetName() const { return "Generic"; } |
| |
| /** Check whether the given name matches the current generator. */ |
| virtual bool MatchesGeneratorName(const std::string& name) const |
| { return this->GetName() == name; } |
| |
| /** Tell the generator about the target system. */ |
| virtual bool SetSystemName(std::string const&, cmMakefile*) |
| { return true; } |
| |
| /** Set the generator-specific platform name. Returns true if platform |
| is supported and false otherwise. */ |
| virtual bool SetGeneratorPlatform(std::string const& p, cmMakefile* mf); |
| |
| /** Set the generator-specific toolset name. Returns true if toolset |
| is supported and false otherwise. */ |
| virtual bool SetGeneratorToolset(std::string const& ts, cmMakefile* mf); |
| |
| /** |
| * Create LocalGenerators and process the CMakeLists files. This does not |
| * actually produce any makefiles, DSPs, etc. |
| */ |
| virtual void Configure(); |
| |
| /** |
| * Generate the all required files for building this project/tree. This |
| * basically creates a series of LocalGenerators for each directory and |
| * requests that they Generate. |
| */ |
| void DoGenerate(); |
| |
| /** |
| * Set/Get and Clear the enabled languages. |
| */ |
| void SetLanguageEnabled(const std::string&, cmMakefile* mf); |
| bool GetLanguageEnabled(const std::string&) const; |
| void ClearEnabledLanguages(); |
| void GetEnabledLanguages(std::vector<std::string>& lang) const; |
| /** |
| * Try to determine system information such as shared library |
| * extension, pthreads, byte order etc. |
| */ |
| virtual void EnableLanguage(std::vector<std::string>const& languages, |
| cmMakefile *, bool optional); |
| |
| /** |
| * Resolve the CMAKE_<lang>_COMPILER setting for the given language. |
| * Intended to be called from EnableLanguage. |
| */ |
| void ResolveLanguageCompiler(const std::string &lang, cmMakefile *mf, |
| bool optional) const; |
| |
| /** |
| * Try to determine system information, get it from another generator |
| */ |
| virtual void EnableLanguagesFromGenerator(cmGlobalGenerator *gen, |
| cmMakefile* mf); |
| |
| /** |
| * Try running cmake and building a file. This is used for dynamically |
| * loaded commands, not as part of the usual build process. |
| */ |
| int TryCompile(const std::string& srcdir, const std::string& bindir, |
| const std::string& projectName, |
| const std::string& targetName, |
| bool fast, std::string& output, cmMakefile* mf); |
| |
| |
| /** |
| * Build a file given the following information. This is a more direct call |
| * that is used by both CTest and TryCompile. If target name is NULL or |
| * empty then all is assumed. clean indicates if a "make clean" should be |
| * done first. |
| */ |
| int Build(const std::string& srcdir, const std::string& bindir, |
| const std::string& projectName, const std::string& targetName, |
| std::string& output, |
| const std::string& makeProgram, const std::string& config, |
| bool clean, bool fast, bool verbose, |
| double timeout, |
| cmSystemTools::OutputOption outputflag=cmSystemTools::OUTPUT_NONE, |
| std::vector<std::string> const& nativeOptions = |
| std::vector<std::string>()); |
| |
| virtual void GenerateBuildCommand( |
| std::vector<std::string>& makeCommand, |
| const std::string& makeProgram, |
| const std::string& projectName, const std::string& projectDir, |
| const std::string& targetName, const std::string& config, |
| bool fast, bool verbose, |
| std::vector<std::string> const& makeOptions = std::vector<std::string>() |
| ); |
| |
| /** Generate a "cmake --build" call for a given target and config. */ |
| std::string GenerateCMakeBuildCommand(const std::string& target, |
| const std::string& config, |
| const std::string& native, |
| bool ignoreErrors); |
| |
| ///! Get the CMake instance |
| cmake *GetCMakeInstance() const { return this->CMakeInstance; } |
| |
| void SetConfiguredFilesPath(cmGlobalGenerator* gen); |
| const std::vector<cmLocalGenerator *>& GetLocalGenerators() const { |
| return this->LocalGenerators;} |
| |
| cmLocalGenerator* GetCurrentLocalGenerator() |
| {return this->CurrentLocalGenerator;} |
| |
| void SetCurrentLocalGenerator(cmLocalGenerator* lg) |
| {this->CurrentLocalGenerator = lg;} |
| |
| void AddLocalGenerator(cmLocalGenerator *lg); |
| |
| ///! Set an generator for an "external makefile based project" |
| void SetExternalMakefileProjectGenerator( |
| cmExternalMakefileProjectGenerator *extraGenerator); |
| |
| std::string GetExtraGeneratorName() const; |
| |
| void AddInstallComponent(const char* component); |
| |
| const std::set<std::string>* GetInstallComponents() const |
| { return &this->InstallComponents; } |
| |
| cmExportSetMap& GetExportSets() {return this->ExportSets;} |
| |
| /** Add a file to the manifest of generated targets for a configuration. */ |
| void AddToManifest(const std::string& config, std::string const& f); |
| |
| void EnableInstallTarget(); |
| |
| int TryCompileTimeout; |
| |
| bool GetForceUnixPaths() const { return this->ForceUnixPaths; } |
| bool GetToolSupportsColor() const { return this->ToolSupportsColor; } |
| |
| ///! return the language for the given extension |
| std::string GetLanguageFromExtension(const char* ext) const; |
| ///! is an extension to be ignored |
| bool IgnoreFile(const char* ext) const; |
| ///! What is the preference for linkers and this language (None or Preferred) |
| int GetLinkerPreference(const std::string& lang) const; |
| ///! What is the object file extension for a given source file? |
| std::string GetLanguageOutputExtension(cmSourceFile const&) const; |
| |
| ///! What is the configurations directory variable called? |
| virtual const char* GetCMakeCFGIntDir() const { return "."; } |
| |
| ///! expand CFGIntDir for a configuration |
| virtual std::string ExpandCFGIntDir(const std::string& str, |
| const std::string& config) const; |
| |
| /** Get whether the generator should use a script for link commands. */ |
| bool GetUseLinkScript() const { return this->UseLinkScript; } |
| |
| /** Get whether the generator should produce special marks on rules |
| producing symbolic (non-file) outputs. */ |
| bool GetNeedSymbolicMark() const { return this->NeedSymbolicMark; } |
| |
| /* |
| * Determine what program to use for building the project. |
| */ |
| virtual void FindMakeProgram(cmMakefile*); |
| |
| #if defined(_WIN32) && !defined(__CYGWIN__) |
| /** Is this the Visual Studio 6 generator? */ |
| virtual bool IsForVS6() const { return false; } |
| #endif |
| |
| ///! Find a target by name by searching the local generators. |
| cmTarget* FindTarget(const std::string& name, |
| bool excludeAliases = false) const; |
| |
| void AddAlias(const std::string& name, cmTarget *tgt); |
| bool IsAlias(const std::string& name) const; |
| |
| /** Determine if a name resolves to a framework on disk or a built target |
| that is a framework. */ |
| bool NameResolvesToFramework(const std::string& libname) const; |
| |
| ///! Find a local generator by its startdirectory |
| cmLocalGenerator* FindLocalGenerator(const std::string& start_dir) const; |
| |
| /** Append the subdirectory for the given configuration. If anything is |
| appended the given prefix and suffix will be appended around it, which |
| is useful for leading or trailing slashes. */ |
| virtual void AppendDirectoryForConfig(const std::string& prefix, |
| const std::string& config, |
| const std::string& suffix, |
| std::string& dir); |
| |
| /** Get the manifest of all targets that will be built for each |
| configuration. This is valid during generation only. */ |
| cmTargetManifest const& GetTargetManifest() const |
| { return this->TargetManifest; } |
| |
| /** Get the content of a directory. Directory listings are cached |
| and re-loaded from disk only when modified. During the generation |
| step the content will include the target files to be built even if |
| they do not yet exist. */ |
| std::set<std::string> const& GetDirectoryContent(std::string const& dir, |
| bool needDisk = true); |
| |
| void AddTarget(cmTarget* t); |
| |
| static bool IsReservedTarget(std::string const& name); |
| |
| virtual const char* GetAllTargetName() const { return "ALL_BUILD"; } |
| virtual const char* GetInstallTargetName() const { return "INSTALL"; } |
| virtual const char* GetInstallLocalTargetName() const { return 0; } |
| virtual const char* GetInstallStripTargetName() const { return 0; } |
| virtual const char* GetPreinstallTargetName() const { return 0; } |
| virtual const char* GetTestTargetName() const { return "RUN_TESTS"; } |
| virtual const char* GetPackageTargetName() const { return "PACKAGE"; } |
| virtual const char* GetPackageSourceTargetName() const { return 0; } |
| virtual const char* GetEditCacheTargetName() const { return 0; } |
| virtual const char* GetRebuildCacheTargetName() const { return 0; } |
| virtual const char* GetCleanTargetName() const { return 0; } |
| |
| // Lookup edit_cache target command preferred by this generator. |
| virtual std::string GetEditCacheCommand() const { return ""; } |
| |
| // Class to track a set of dependencies. |
| typedef cmTargetDependSet TargetDependSet; |
| |
| // what targets does the specified target depend on directly |
| // via a target_link_libraries or add_dependencies |
| TargetDependSet const& GetTargetDirectDepends(cmTarget const& target); |
| |
| /** Get per-target generator information. */ |
| cmGeneratorTarget* GetGeneratorTarget(cmTarget const*) const; |
| |
| const std::map<std::string, std::vector<cmLocalGenerator*> >& GetProjectMap() |
| const {return this->ProjectMap;} |
| |
| // track files replaced during a Generate |
| void FileReplacedDuringGenerate(const std::string& filename); |
| void GetFilesReplacedDuringGenerate(std::vector<std::string>& filenames); |
| |
| void AddRuleHash(const std::vector<std::string>& outputs, |
| std::string const& content); |
| |
| /** Return whether the given binary directory is unused. */ |
| bool BinaryDirectoryIsNew(const std::string& dir) |
| { |
| return this->BinaryDirectories.insert(dir).second; |
| } |
| /** Supported systems creates a GUID for the given name */ |
| virtual void CreateGUID(const std::string&) {} |
| |
| /** Return true if the generated build tree may contain multiple builds. |
| i.e. "Can I build Debug and Release in the same tree?" */ |
| virtual bool IsMultiConfig() { return false; } |
| |
| std::string GetSharedLibFlagsForLanguage(std::string const& lang) const; |
| |
| /** Generate an <output>.rule file path for a given command output. */ |
| virtual std::string GenerateRuleFile(std::string const& output) const; |
| |
| static std::string EscapeJSON(const std::string& s); |
| |
| void AddEvaluationFile(const std::string &inputFile, |
| cmsys::auto_ptr<cmCompiledGeneratorExpression> outputName, |
| cmMakefile *makefile, |
| cmsys::auto_ptr<cmCompiledGeneratorExpression> condition, |
| bool inputIsContent); |
| |
| void ProcessEvaluationFiles(); |
| |
| std::map<std::string, cmExportBuildFileGenerator*>& GetBuildExportSets() |
| {return this->BuildExportSets;} |
| void AddBuildExportSet(cmExportBuildFileGenerator*); |
| void AddBuildExportExportSet(cmExportBuildFileGenerator*); |
| bool IsExportedTargetsFile(const std::string &filename) const; |
| bool GenerateImportFile(const std::string &file); |
| cmExportBuildFileGenerator* |
| GetExportedTargetsFile(const std::string &filename) const; |
| void AddCMP0042WarnTarget(const std::string& target); |
| |
| virtual void ComputeTargetObjectDirectory(cmGeneratorTarget* gt) const; |
| |
| bool GenerateCPackPropertiesFile(); |
| |
| void CreateEvaluationSourceFiles(std::string const& config) const; |
| |
| void SetFilenameTargetDepends(cmSourceFile* sf, |
| std::set<cmTarget const*> tgts); |
| std::set<cmTarget const*> const& |
| GetFilenameTargetDepends(cmSourceFile* sf) const; |
| |
| #if defined(CMAKE_BUILD_WITH_CMAKE) |
| cmFileLockPool& GetFileLockPool() { return FileLockPool; } |
| #endif |
| |
| std::string MakeSilentFlag; |
| protected: |
| virtual void Generate(); |
| |
| typedef std::vector<cmLocalGenerator*> GeneratorVector; |
| // for a project collect all its targets by following depend |
| // information, and also collect all the targets |
| void GetTargetSets(TargetDependSet& projectTargets, |
| TargetDependSet& originalTargets, |
| cmLocalGenerator* root, GeneratorVector const&); |
| bool IsRootOnlyTarget(cmTarget* target) const; |
| void AddTargetDepends(cmTarget const* target, |
| TargetDependSet& projectTargets); |
| void SetLanguageEnabledFlag(const std::string& l, cmMakefile* mf); |
| void SetLanguageEnabledMaps(const std::string& l, cmMakefile* mf); |
| void FillExtensionToLanguageMap(const std::string& l, cmMakefile* mf); |
| |
| virtual bool ComputeTargetDepends(); |
| |
| virtual bool CheckALLOW_DUPLICATE_CUSTOM_TARGETS() const; |
| |
| typedef std::vector<std::pair<cmQtAutoGenerators, |
| cmTarget const*> > AutogensType; |
| void CreateQtAutoGeneratorsTargets(AutogensType& autogens); |
| |
| std::string SelectMakeProgram(const std::string& makeProgram, |
| const std::string& makeDefault = "") const; |
| |
| // Fill the ProjectMap, this must be called after LocalGenerators |
| // has been populated. |
| void FillProjectMap(); |
| void CheckLocalGenerators(); |
| bool IsExcluded(cmLocalGenerator* root, cmLocalGenerator* gen) const; |
| bool IsExcluded(cmLocalGenerator* root, cmTarget const& target) const; |
| void FillLocalGeneratorToTargetMap(); |
| void CreateDefaultGlobalTargets(cmTargets* targets); |
| cmTarget CreateGlobalTarget(const std::string& name, const char* message, |
| const cmCustomCommandLines* commandLines, |
| std::vector<std::string> depends, const char* workingDir, |
| bool uses_terminal); |
| |
| bool NeedSymbolicMark; |
| bool UseLinkScript; |
| bool ForceUnixPaths; |
| bool ToolSupportsColor; |
| std::string FindMakeProgramFile; |
| std::string ConfiguredFilesPath; |
| cmake *CMakeInstance; |
| std::vector<cmLocalGenerator *> LocalGenerators; |
| cmLocalGenerator* CurrentLocalGenerator; |
| // map from project name to vector of local generators in that project |
| std::map<std::string, std::vector<cmLocalGenerator*> > ProjectMap; |
| std::map<cmLocalGenerator*, std::set<cmTarget const*> > |
| LocalGeneratorToTargetMap; |
| |
| // Set of named installation components requested by the project. |
| std::set<std::string> InstallComponents; |
| bool InstallTargetEnabled; |
| // Sets of named target exports |
| cmExportSetMap ExportSets; |
| std::map<std::string, cmExportBuildFileGenerator*> BuildExportSets; |
| std::map<std::string, cmExportBuildFileGenerator*> BuildExportExportSets; |
| |
| // Manifest of all targets that will be built for each configuration. |
| // This is computed just before local generators generate. |
| cmTargetManifest TargetManifest; |
| |
| // All targets in the entire project. |
| #if defined(CMAKE_BUILD_WITH_CMAKE) |
| #ifdef CMake_HAVE_CXX11_UNORDERED_MAP |
| typedef std::unordered_map<std::string, cmTarget*> TargetMap; |
| #else |
| typedef cmsys::hash_map<std::string, cmTarget*> TargetMap; |
| #endif |
| #else |
| typedef std::map<std::string,cmTarget *> TargetMap; |
| #endif |
| TargetMap TotalTargets; |
| TargetMap AliasTargets; |
| TargetMap ImportedTargets; |
| std::vector<cmGeneratorExpressionEvaluationFile*> EvaluationFiles; |
| |
| const char* GetPredefinedTargetsFolder(); |
| virtual bool UseFolderProperty(); |
| |
| private: |
| ///! Create a local generator appropriate to this Global Generator |
| virtual cmLocalGenerator *CreateLocalGenerator(cmLocalGenerator* parent, |
| cmState::Snapshot snapshot); |
| |
| cmMakefile* TryCompileOuterMakefile; |
| float FirstTimeProgress; |
| // If you add a new map here, make sure it is copied |
| // in EnableLanguagesFromGenerator |
| std::map<std::string, bool> IgnoreExtensions; |
| std::set<std::string> LanguagesReady; // Ready for try_compile |
| std::map<std::string, std::string> OutputExtensions; |
| std::map<std::string, std::string> LanguageToOutputExtension; |
| std::map<std::string, std::string> ExtensionToLanguage; |
| std::map<std::string, int> LanguageToLinkerPreference; |
| std::map<std::string, std::string> LanguageToOriginalSharedLibFlags; |
| |
| // Record hashes for rules and outputs. |
| struct RuleHash { char Data[32]; }; |
| std::map<std::string, RuleHash> RuleHashes; |
| void CheckRuleHashes(); |
| void CheckRuleHashes(std::string const& pfile, std::string const& home); |
| void WriteRuleHashes(std::string const& pfile); |
| |
| void WriteSummary(); |
| void WriteSummary(cmTarget* target); |
| void FinalizeTargetCompileInfo(); |
| |
| virtual void ForceLinkerLanguages(); |
| |
| virtual void PrintCompilerAdvice(std::ostream& os, std::string const& lang, |
| const char* envVar) const; |
| void CheckCompilerIdCompatibility(cmMakefile* mf, |
| std::string const& lang) const; |
| |
| cmExternalMakefileProjectGenerator* ExtraGenerator; |
| |
| // track files replaced during a Generate |
| std::vector<std::string> FilesReplacedDuringGenerate; |
| |
| // Store computed inter-target dependencies. |
| typedef std::map<cmTarget const*, TargetDependSet> TargetDependMap; |
| TargetDependMap TargetDependencies; |
| |
| // Per-target generator information. |
| cmGeneratorTargetsType GeneratorTargets; |
| friend class cmake; |
| void CreateGeneratorTargets(cmMakefile* mf); |
| void CreateGeneratorTargets(); |
| |
| void ClearGeneratorMembers(); |
| |
| virtual const char* GetBuildIgnoreErrorsFlag() const { return 0; } |
| |
| // Cache directory content and target files to be built. |
| struct DirectoryContent |
| { |
| long LastDiskTime; |
| std::set<std::string> All; |
| std::set<std::string> Generated; |
| DirectoryContent(): LastDiskTime(-1) {} |
| DirectoryContent(DirectoryContent const& dc): |
| LastDiskTime(dc.LastDiskTime), All(dc.All), Generated(dc.Generated) {} |
| }; |
| std::map<std::string, DirectoryContent> DirectoryContentMap; |
| |
| // Set of binary directories on disk. |
| std::set<std::string> BinaryDirectories; |
| |
| // track targets to issue CMP0042 warning for. |
| std::set<std::string> CMP0042WarnTargets; |
| |
| mutable std::map<cmSourceFile*, std::set<cmTarget const*> > |
| FilenameTargetDepends; |
| |
| #if defined(CMAKE_BUILD_WITH_CMAKE) |
| // Pool of file locks |
| cmFileLockPool FileLockPool; |
| #endif |
| }; |
| |
| #endif |