CMake/Source/cmGlobalGenerator.h

331 lines
13 KiB
C
Raw Normal View History

2002-08-30 20:00:35 +00:00
/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
2002-08-30 20:00:35 +00:00
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
2002-08-30 20:00:35 +00:00
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef cmGlobalGenerator_h
#define cmGlobalGenerator_h
#include "cmStandardIncludes.h"
2006-02-23 15:07:24 +00:00
#include "cmTarget.h" // For cmTargets
2002-08-30 20:00:35 +00:00
class cmake;
class cmMakefile;
class cmLocalGenerator;
2007-06-15 20:07:16 +00:00
class cmExternalMakefileProjectGenerator;
2005-02-03 22:42:55 +00:00
class cmTarget;
class cmTargetExport;
class cmInstallTargetGenerator;
class cmInstallFilesGenerator;
2002-08-30 20:00:35 +00:00
/** \class cmGlobalGenerator
* \brief Responable 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
2002-09-04 19:24:49 +00:00
cmGlobalGenerator();
2002-08-30 20:00:35 +00:00
virtual ~cmGlobalGenerator();
///! Create a local generator appropriate to this Global Generator
virtual cmLocalGenerator *CreateLocalGenerator();
///! Get the name for this generator
virtual const char *GetName() const { return "Generic"; };
/** Get the documentation entry for this generator. */
virtual void GetDocumentation(cmDocumentationEntry& entry) const;
2002-08-30 20:00:35 +00:00
/**
* 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.
*/
virtual void Generate();
/**
* Set/Get and Clear the enabled languages.
*/
void SetLanguageEnabled(const char*, cmMakefile* mf);
bool GetLanguageEnabled(const char*) const;
2002-08-30 20:00:35 +00:00
void ClearEnabledLanguages();
void GetEnabledLanguages(std::vector<std::string>& lang);
2002-08-30 20:00:35 +00:00
/**
* Try to determine system infomation such as shared library
* extension, pthreads, byte order etc.
*/
2006-03-10 18:54:57 +00:00
virtual void EnableLanguage(std::vector<std::string>const& languages,
cmMakefile *, bool optional);
2002-08-30 20:00:35 +00:00
2002-09-13 14:42:50 +00:00
/**
* Try to determine system infomation, get it from another generator
*/
virtual void EnableLanguagesFromGenerator(cmGlobalGenerator *gen);
2002-09-13 14:42:50 +00:00
2002-08-30 20:00:35 +00:00
/**
* Try running cmake and building a file. This is used for dynalically
* loaded commands, not as part of the usual build process.
*/
virtual int TryCompile(const char *srcdir, const char *bindir,
const char *projectName, const char *targetName,
std::string *output, cmMakefile* mf);
2002-08-30 20:00:35 +00:00
/**
* 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.
*/
virtual int Build(const char *srcdir, const char *bindir,
const char *projectName, const char *targetName,
std::string *output,
const char *makeProgram, const char *config,
bool clean, bool fast,
double timeout);
2006-03-15 16:02:08 +00:00
virtual std::string GenerateBuildCommand
(const char* makeProgram,
const char *projectName, const char* additionalOptions,
const char *targetName,
const char* config, bool ignoreErrors, bool fast);
2006-03-15 16:02:08 +00:00
2002-08-30 20:00:35 +00:00
///! Set the CMake instance
void SetCMakeInstance(cmake *cm);
2002-08-30 20:00:35 +00:00
///! Get the CMake instance
2006-03-15 16:02:08 +00:00
cmake *GetCMakeInstance() { return this->CMakeInstance; };
void SetConfiguredFilesPath(const char* s){this->ConfiguredFilesPath = s;}
const std::vector<cmLocalGenerator *>& GetLocalGenerators() const {
return this->LocalGenerators;}
2002-08-30 20:00:35 +00:00
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);
2007-06-15 20:07:16 +00:00
const char* GetExtraGeneratorName() const;
void AddInstallComponent(const char* component);
///! Add one installed target to the sets of the exports
void AddTargetToExports(const char* exportSet, cmTarget* target,
cmInstallTargetGenerator* archive,
cmInstallTargetGenerator* runTime,
cmInstallTargetGenerator* library,
cmInstallTargetGenerator* framework,
cmInstallTargetGenerator* bundle,
cmInstallFilesGenerator* publicHeaders);
///! Get the export target set with the given name
const std::vector<cmTargetExport*>* GetExportSet(const char* name) const;
/** Add a file to the manifest of generated targets for a configuration. */
void AddToManifest(const char* config, std::string const& f);
void EnableInstallTarget();
int TryCompileTimeout;
2006-03-15 16:02:08 +00:00
bool GetForceUnixPaths() {return this->ForceUnixPaths;}
bool GetToolSupportsColor() { return this->ToolSupportsColor; }
2007-06-08 16:42:29 +00:00
void SetToolSupportsColor(bool enable) { this->ToolSupportsColor = enable; }
///! return the language for the given extension
const char* GetLanguageFromExtension(const char* ext);
///! is an extension to be ignored
bool IgnoreFile(const char* ext);
///! What is the preference for linkers and this language (None or Prefered)
int GetLinkerPreference(const char* lang);
///! What is the object file extension for a given source file?
const char* GetLanguageOutputExtension(cmSourceFile const&);
2006-02-24 22:35:35 +00:00
///! What is the configurations directory variable called?
virtual const char* GetCMakeCFGInitDirectory() { return "."; }
/** Get whether the generator should use a script for link commands. */
bool GetUseLinkScript() { return this->UseLinkScript; }
/** Get whether the generator should produce special marks on rules
producing symbolic (non-file) outputs. */
bool GetNeedSymbolicMark() { return this->NeedSymbolicMark; }
2005-05-02 19:50:42 +00:00
/*
* Determine what program to use for building the project.
*/
void FindMakeProgram(cmMakefile*);
///! Find a target by name by searching the local generators.
2007-07-20 12:36:16 +00:00
cmTarget* FindTarget(const char* project,
const char* name,
bool useImportedTargets);
/** Determine if a name resolves to a framework on disk or a built target
that is a framework. */
bool NameResolvesToFramework(const std::string& libname);
/** If check to see if the target is linked to by any other
target in the project */
bool IsDependedOn(const char* project, cmTarget* target);
///! Find a local generator by its startdirectory
cmLocalGenerator* FindLocalGenerator(const char* start_dir);
/** 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 char* prefix,
const char* config,
const char* 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() { return this->TargetManifest; }
/** Get the content of a directory on disk including the target
files to be generated. This may be called only during the
generation step. It is intended for use only by
cmComputeLinkInformation. */
std::set<cmStdString> const& GetDirectoryContent(std::string const& dir,
bool needDisk);
void AddTarget(cmTargets::value_type &v);
virtual const char* GetAllTargetName() { return "ALL_BUILD"; }
virtual const char* GetInstallTargetName() { return "INSTALL"; }
virtual const char* GetInstallLocalTargetName() { return 0; }
virtual const char* GetInstallStripTargetName() { return 0; }
virtual const char* GetPreinstallTargetName() { return 0; }
virtual const char* GetTestTargetName() { return "RUN_TESTS"; }
virtual const char* GetPackageTargetName() { return "PACKAGE"; }
virtual const char* GetPackageSourceTargetName(){ return 0; }
virtual const char* GetEditCacheTargetName() { return 0; }
virtual const char* GetRebuildCacheTargetName() { return 0; }
virtual const char* GetCleanTargetName() { return 0; }
// Class to track a set of dependencies.
class TargetDependSet: public std::set<cmTarget const*> {};
// what targets does the specified target depend on
TargetDependSet const& GetTargetDepends(cmTarget const& target);
2007-07-20 12:36:16 +00:00
const std::map<cmStdString, 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);
2002-08-30 20:00:35 +00:00
protected:
void SetLanguageEnabledFlag(const char* l, cmMakefile* mf);
void SetLanguageEnabledMaps(const char* l, cmMakefile* mf);
2006-03-16 15:53:14 +00:00
// Fill the ProjectMap, this must be called after LocalGenerators
2006-03-10 18:54:57 +00:00
// has been populated.
void FillProjectMap();
void CheckLocalGenerators();
bool IsExcluded(cmLocalGenerator* root, cmLocalGenerator* gen);
bool IsExcluded(cmLocalGenerator* root, cmTarget& target);
void FillLocalGeneratorToTargetMap();
2006-02-23 15:07:24 +00:00
void CreateDefaultGlobalTargets(cmTargets* targets);
cmTarget CreateGlobalTarget(const char* name, const char* message,
const cmCustomCommandLines* commandLines,
std::vector<std::string> depends, bool depends_on_all = false);
bool NeedSymbolicMark;
bool UseLinkScript;
2006-03-15 16:02:08 +00:00
bool ForceUnixPaths;
bool ToolSupportsColor;
2006-03-15 16:02:08 +00:00
cmStdString FindMakeProgramFile;
cmStdString ConfiguredFilesPath;
cmake *CMakeInstance;
std::vector<cmLocalGenerator *> LocalGenerators;
cmLocalGenerator* CurrentLocalGenerator;
// map from project name to vector of local generators in that project
2006-03-15 16:02:08 +00:00
std::map<cmStdString, std::vector<cmLocalGenerator*> > ProjectMap;
std::map<cmLocalGenerator*, std::set<cmTarget const*> >
LocalGeneratorToTargetMap;
2002-08-30 20:00:35 +00:00
// Set of named installation components requested by the project.
std::set<cmStdString> InstallComponents;
bool InstallTargetEnabled;
// Sets of named target exports
std::map<cmStdString, std::vector<cmTargetExport*> > ExportSets;
// Manifest of all targets that will be built for each configuration.
// This is computed just before local generators generate.
cmTargetManifest TargetManifest;
2002-08-30 20:00:35 +00:00
private:
float FirstTimeProgress;
// If you add a new map here, make sure it is copied
// in EnableLanguagesFromGenerator
2006-03-15 16:02:08 +00:00
std::map<cmStdString, bool> IgnoreExtensions;
std::map<cmStdString, bool> LanguageEnabled;
std::map<cmStdString, cmStdString> OutputExtensions;
std::map<cmStdString, cmStdString> LanguageToOutputExtension;
std::map<cmStdString, cmStdString> ExtensionToLanguage;
std::map<cmStdString, int> LanguageToLinkerPreference;
2006-04-11 16:51:20 +00:00
// this is used to improve performance
std::map<cmStdString,cmTarget *> TotalTargets;
std::map<cmStdString,cmTarget *> ImportedTotalTargets;
cmExternalMakefileProjectGenerator* ExtraGenerator;
// track files replaced during a Generate
std::vector<std::string> FilesReplacedDuringGenerate;
// Track inter-target dependencies.
bool ConsiderTargetDepends(cmTarget const* depender,
TargetDependSet& depender_depends,
const char* dependee_name);
bool FindDependency(cmTarget const* goal, cmTarget const* current,
std::vector<cmTarget const*>& steps);
typedef std::map<cmTarget const*, TargetDependSet> TargetDependMap;
TargetDependMap TargetDependencies;
// Cache directory content and target files to be built.
struct DirectoryContent: public std::set<cmStdString>
{
typedef std::set<cmStdString> derived;
bool LoadedFromDisk;
DirectoryContent(): LoadedFromDisk(false) {}
DirectoryContent(DirectoryContent const& dc):
derived(dc), LoadedFromDisk(dc.LoadedFromDisk) {}
};
std::map<cmStdString, DirectoryContent> DirectoryContentMap;
2002-08-30 20:00:35 +00:00
};
#endif