2002-08-31 00:00:35 +04:00
|
|
|
/*=========================================================================
|
|
|
|
|
2002-10-24 02:03:27 +04:00
|
|
|
Program: CMake - Cross-Platform Makefile Generator
|
2002-08-31 00:00:35 +04:00
|
|
|
Module: $RCSfile$
|
|
|
|
Language: C++
|
|
|
|
Date: $Date$
|
|
|
|
Version: $Revision$
|
|
|
|
|
2002-10-24 02:03:27 +04:00
|
|
|
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-31 00:00:35 +04: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 18:07:24 +03:00
|
|
|
#include "cmTarget.h" // For cmTargets
|
|
|
|
|
2002-08-31 00:00:35 +04:00
|
|
|
class cmake;
|
|
|
|
class cmMakefile;
|
|
|
|
class cmLocalGenerator;
|
2005-02-04 01:42:55 +03:00
|
|
|
class cmTarget;
|
2002-08-31 00:00:35 +04: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 23:24:49 +04:00
|
|
|
cmGlobalGenerator();
|
2002-08-31 00:00:35 +04:00
|
|
|
virtual ~cmGlobalGenerator();
|
|
|
|
|
|
|
|
///! Create a local generator appropriate to this Global Generator
|
|
|
|
virtual cmLocalGenerator *CreateLocalGenerator();
|
|
|
|
|
|
|
|
///! Get the name for this generator
|
2003-07-08 05:52:10 +04:00
|
|
|
virtual const char *GetName() const { return "Generic"; };
|
|
|
|
|
|
|
|
/** Get the documentation entry for this generator. */
|
|
|
|
virtual void GetDocumentation(cmDocumentationEntry& entry) const;
|
2002-08-31 00:00:35 +04: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.
|
|
|
|
*/
|
2004-09-03 20:03:41 +04:00
|
|
|
void SetLanguageEnabled(const char*, cmMakefile* mf);
|
2002-08-31 00:00:35 +04:00
|
|
|
bool GetLanguageEnabled(const char*);
|
|
|
|
void ClearEnabledLanguages();
|
2004-09-22 22:42:05 +04:00
|
|
|
void GetEnabledLanguages(std::vector<std::string>& lang);
|
2002-08-31 00:00:35 +04:00
|
|
|
/**
|
|
|
|
* Try to determine system infomation such as shared library
|
|
|
|
* extension, pthreads, byte order etc.
|
|
|
|
*/
|
2006-03-10 21:54:57 +03:00
|
|
|
virtual void EnableLanguage(std::vector<std::string>const& languages,
|
|
|
|
cmMakefile *);
|
2002-08-31 00:00:35 +04:00
|
|
|
|
2002-09-13 18:42:50 +04:00
|
|
|
/**
|
|
|
|
* Try to determine system infomation, get it from another generator
|
|
|
|
*/
|
2002-11-08 23:46:08 +03:00
|
|
|
virtual void EnableLanguagesFromGenerator(cmGlobalGenerator *gen);
|
2002-09-13 18:42:50 +04:00
|
|
|
|
2002-08-31 00:00:35 +04: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,
|
2002-09-20 21:15:56 +04:00
|
|
|
const char *projectName, const char *targetName,
|
2004-08-05 00:33:10 +04:00
|
|
|
std::string *output, cmMakefile* mf);
|
2002-08-31 00:00:35 +04:00
|
|
|
|
2005-02-22 17:12:10 +03: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,
|
2006-06-01 23:51:24 +04:00
|
|
|
bool clean, bool fast);
|
2006-03-15 19:02:08 +03:00
|
|
|
virtual std::string GenerateBuildCommand
|
|
|
|
(const char* makeProgram,
|
|
|
|
const char *projectName, const char* additionalOptions,
|
|
|
|
const char *targetName,
|
2006-06-01 23:51:24 +04:00
|
|
|
const char* config, bool ignoreErrors, bool fast);
|
2006-03-15 19:02:08 +03:00
|
|
|
|
2005-02-22 17:12:10 +03:00
|
|
|
|
2002-08-31 00:00:35 +04:00
|
|
|
///! Set the CMake instance
|
2006-05-25 17:47:30 +04:00
|
|
|
void SetCMakeInstance(cmake *cm);
|
2002-08-31 00:00:35 +04:00
|
|
|
|
|
|
|
///! Get the CMake instance
|
2006-03-15 19:02:08 +03:00
|
|
|
cmake *GetCMakeInstance() { return this->CMakeInstance; };
|
|
|
|
|
|
|
|
void SetConfiguredFilesPath(const char* s){this->ConfiguredFilesPath = s;}
|
|
|
|
cmLocalGenerator* GetLocalGenerator(int p) {
|
|
|
|
return this->LocalGenerators[p];}
|
|
|
|
void GetLocalGenerators(std::vector<cmLocalGenerator *>&g) {
|
|
|
|
g = this->LocalGenerators;}
|
2002-08-31 00:00:35 +04:00
|
|
|
|
2005-03-18 18:41:41 +03:00
|
|
|
void AddLocalGenerator(cmLocalGenerator *lg);
|
2006-03-30 22:33:48 +04:00
|
|
|
|
|
|
|
void AddInstallComponent(const char* component);
|
2006-08-31 18:47:00 +04:00
|
|
|
void EnableInstallTarget();
|
2005-03-18 18:41:41 +03:00
|
|
|
|
2003-08-04 06:34:37 +04:00
|
|
|
static int s_TryCompileTimeout;
|
2003-01-21 00:59:02 +03:00
|
|
|
|
2006-03-15 19:02:08 +03:00
|
|
|
bool GetForceUnixPaths() {return this->ForceUnixPaths;}
|
2006-04-27 05:31:39 +04:00
|
|
|
bool GetToolSupportsColor() { return this->ToolSupportsColor; }
|
2004-09-03 20:03:41 +04:00
|
|
|
///! return the language for the given extension
|
|
|
|
const char* GetLanguageFromExtension(const char* ext);
|
2004-09-22 22:42:05 +04:00
|
|
|
///! is an extension to be ignored
|
|
|
|
bool IgnoreFile(const char* ext);
|
|
|
|
///! What is the preference for linkers and this language (None or Prefered)
|
|
|
|
const char* GetLinkerPreference(const char* lang);
|
|
|
|
///! What is the output extension for a given language.
|
|
|
|
const char* GetLanguageOutputExtensionForLanguage(const char* lang);
|
|
|
|
///! What is the output extension for a given source file extension.
|
|
|
|
const char* GetLanguageOutputExtensionFromExtension(const char* lang);
|
2005-02-25 00:04:54 +03:00
|
|
|
|
2006-02-25 01:35:35 +03:00
|
|
|
///! What is the configurations directory variable called?
|
|
|
|
virtual const char* GetCMakeCFGInitDirectory() { return "."; }
|
|
|
|
|
2005-02-25 00:04:54 +03:00
|
|
|
/**
|
|
|
|
* Convert the given remote path to a relative path with respect to
|
|
|
|
* the given local path. The local path must be given in component
|
|
|
|
* form (see SystemTools::SplitPath) without a trailing slash. The
|
|
|
|
* remote path must use forward slashes and not already be escaped
|
|
|
|
* or quoted.
|
|
|
|
*/
|
|
|
|
std::string ConvertToRelativePath(const std::vector<std::string>& local,
|
|
|
|
const char* remote);
|
|
|
|
|
2006-06-16 00:17:11 +04:00
|
|
|
/** Get whether the generator should use a script for link commands. */
|
|
|
|
bool GetUseLinkScript() { return this->UseLinkScript; }
|
|
|
|
|
2005-05-02 23:50:42 +04:00
|
|
|
/*
|
|
|
|
* Determine what program to use for building the project.
|
|
|
|
*/
|
|
|
|
void FindMakeProgram(cmMakefile*);
|
|
|
|
|
2005-06-20 22:00:48 +04:00
|
|
|
///! Find a target by name by searching the local generators.
|
|
|
|
cmTarget* FindTarget(const char* project, const char* name);
|
|
|
|
|
2005-09-13 18:39:42 +04:00
|
|
|
///! Find a local generator by its startdirectory
|
|
|
|
cmLocalGenerator* FindLocalGenerator(const char* start_dir);
|
|
|
|
|
2006-03-03 20:58:48 +03:00
|
|
|
/** 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);
|
2006-02-03 19:36:11 +03:00
|
|
|
|
2006-04-04 19:48:19 +04:00
|
|
|
/** 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; }
|
|
|
|
|
2006-05-11 18:40:28 +04:00
|
|
|
void AddTarget(cmTargets::value_type &v) {
|
|
|
|
this->TotalTargets[v.first] = &v.second;};
|
2006-04-11 20:51:20 +04:00
|
|
|
|
2006-04-11 19:06:19 +04:00
|
|
|
/** Support for multiple custom command outputs. */
|
|
|
|
virtual void CheckMultipleOutputs(cmMakefile* mf, bool verbose);
|
|
|
|
|
2006-04-10 21:44:39 +04:00
|
|
|
virtual const char* GetAllTargetName() { return "ALL_BUILD"; }
|
|
|
|
virtual const char* GetInstallTargetName() { return "INSTALL"; }
|
2006-08-29 18:03:47 +04:00
|
|
|
virtual const char* GetInstallLocalTargetName() { return 0; }
|
2006-04-10 21:44:39 +04:00
|
|
|
virtual const char* GetPreinstallTargetName() { return 0; }
|
|
|
|
virtual const char* GetTestTargetName() { return "RUN_TESTS"; }
|
|
|
|
virtual const char* GetPackageTargetName() { return "PACKAGE"; }
|
2006-04-17 23:26:54 +04:00
|
|
|
virtual const char* GetPackageSourceTargetName(){ return 0; }
|
2006-04-10 21:44:39 +04:00
|
|
|
virtual const char* GetEditCacheTargetName() { return 0; }
|
|
|
|
virtual const char* GetRebuildCacheTargetName() { return 0; }
|
|
|
|
|
2002-08-31 00:00:35 +04:00
|
|
|
protected:
|
2006-03-16 18:53:14 +03:00
|
|
|
// Fill the ProjectMap, this must be called after LocalGenerators
|
2006-03-10 21:54:57 +03:00
|
|
|
// has been populated.
|
2005-01-21 20:26:32 +03:00
|
|
|
void FillProjectMap();
|
2004-03-10 00:28:44 +03:00
|
|
|
bool IsExcluded(cmLocalGenerator* root, cmLocalGenerator* gen);
|
2005-02-25 00:04:54 +03:00
|
|
|
|
|
|
|
void ConfigureRelativePaths();
|
2006-06-19 22:57:57 +04:00
|
|
|
bool RelativePathsConfigured;
|
2005-04-02 00:48:46 +04:00
|
|
|
void SetupTests();
|
2006-01-14 02:18:32 +03:00
|
|
|
|
2006-02-23 18:07:24 +03: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);
|
|
|
|
|
2006-06-16 00:17:11 +04:00
|
|
|
bool UseLinkScript;
|
2006-03-15 19:02:08 +03:00
|
|
|
bool ForceUnixPaths;
|
2006-04-27 05:31:39 +04:00
|
|
|
bool ToolSupportsColor;
|
2006-03-15 19:02:08 +03:00
|
|
|
cmStdString FindMakeProgramFile;
|
|
|
|
cmStdString ConfiguredFilesPath;
|
|
|
|
cmake *CMakeInstance;
|
|
|
|
std::vector<cmLocalGenerator *> LocalGenerators;
|
2005-01-21 20:26:32 +03:00
|
|
|
// map from project name to vector of local generators in that project
|
2006-03-15 19:02:08 +03:00
|
|
|
std::map<cmStdString, std::vector<cmLocalGenerator*> > ProjectMap;
|
2002-08-31 00:00:35 +04:00
|
|
|
|
2006-03-30 22:33:48 +04:00
|
|
|
// Set of named installation components requested by the project.
|
|
|
|
std::set<cmStdString> InstallComponents;
|
2006-08-31 18:47:00 +04:00
|
|
|
bool InstallTargetEnabled;
|
2006-03-30 22:33:48 +04:00
|
|
|
|
2006-04-04 19:48:19 +04:00
|
|
|
// Manifest of all targets that will be built for each configuration.
|
|
|
|
// This is computed just before local generators generate.
|
|
|
|
cmTargetManifest TargetManifest;
|
|
|
|
|
2002-08-31 00:00:35 +04:00
|
|
|
private:
|
2004-09-22 22:42:05 +04:00
|
|
|
// If you add a new map here, make sure it is copied
|
|
|
|
// in EnableLanguagesFromGenerator
|
2006-03-15 19:02:08 +03: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, cmStdString> LanguageToLinkerPreference;
|
2005-02-25 00:04:54 +03:00
|
|
|
|
2005-05-16 22:17:30 +04:00
|
|
|
// The paths to the tops of the source and binary trees used for
|
|
|
|
// relative path computation. A path must be either in the source
|
|
|
|
// tree or the build tree to be converted to a relative path. The
|
|
|
|
// ConfigureRelativePaths method may set these to be empty when
|
|
|
|
// using relative paths is unsafe.
|
2006-03-15 19:02:08 +03:00
|
|
|
std::string RelativePathTopSource;
|
|
|
|
std::string RelativePathTopBinary;
|
2006-04-11 20:51:20 +04:00
|
|
|
|
|
|
|
// this is used to improve performance
|
|
|
|
std::map<cmStdString,cmTarget *> TotalTargets;
|
2002-08-31 00:00:35 +04:00
|
|
|
};
|
|
|
|
|
|
|
|
#endif
|