191 lines
6.9 KiB
C++
191 lines
6.9 KiB
C++
/*=========================================================================
|
|
|
|
Program: CMake - Cross-Platform Makefile Generator
|
|
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.
|
|
|
|
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"
|
|
|
|
class cmake;
|
|
class cmMakefile;
|
|
class cmLocalGenerator;
|
|
class cmTarget;
|
|
|
|
/** \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
|
|
cmGlobalGenerator();
|
|
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;
|
|
|
|
/**
|
|
* 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*);
|
|
void ClearEnabledLanguages();
|
|
void GetEnabledLanguages(std::vector<std::string>& lang);
|
|
/**
|
|
* Try to determine system infomation such as shared library
|
|
* extension, pthreads, byte order etc.
|
|
*/
|
|
virtual void EnableLanguage(std::vector<std::string>const& languages, cmMakefile *);
|
|
|
|
/**
|
|
* Try to determine system infomation, get it from another generator
|
|
*/
|
|
virtual void EnableLanguagesFromGenerator(cmGlobalGenerator *gen);
|
|
|
|
/**
|
|
* 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);
|
|
|
|
|
|
/**
|
|
* 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);
|
|
virtual std::string GenerateBuildCommand(const char* makeProgram,
|
|
const char *projectName, const char* additionalOptions, const char *targetName,
|
|
const char* config, bool ignoreErrors);
|
|
|
|
///! Set the CMake instance
|
|
void SetCMakeInstance(cmake *cm) {
|
|
this->m_CMakeInstance = cm; };
|
|
|
|
///! Get the CMake instance
|
|
cmake *GetCMakeInstance() {
|
|
return this->m_CMakeInstance; };
|
|
|
|
void SetConfiguredFilesPath(const char* s){m_ConfiguredFilesPath = s;}
|
|
void GetLocalGenerators(std::vector<cmLocalGenerator *>&g) { g = m_LocalGenerators;}
|
|
void AddLocalGenerator(cmLocalGenerator *lg);
|
|
|
|
static int s_TryCompileTimeout;
|
|
|
|
bool GetForceUnixPaths() {return m_ForceUnixPaths;}
|
|
///! 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)
|
|
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);
|
|
|
|
/**
|
|
* 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);
|
|
|
|
/*
|
|
* Determine what program to use for building the project.
|
|
*/
|
|
void FindMakeProgram(cmMakefile*);
|
|
|
|
///! Find a target by name by searching the local generators.
|
|
cmTarget* FindTarget(const char* project, const char* name);
|
|
|
|
///! Find a local generator by its startdirectory
|
|
cmLocalGenerator* FindLocalGenerator(const char* start_dir);
|
|
|
|
/** Append the subdirectory for the given configuration. */
|
|
virtual void AppendDirectoryForConfig(const char* config, std::string& dir);
|
|
|
|
protected:
|
|
// Fill the m_ProjectMap, this must be called after m_LocalGenerators has been populated.
|
|
void FillProjectMap();
|
|
bool IsExcluded(cmLocalGenerator* root, cmLocalGenerator* gen);
|
|
|
|
void ConfigureRelativePaths();
|
|
void SetupTests();
|
|
|
|
bool m_ForceUnixPaths;
|
|
cmStdString m_FindMakeProgramFile;
|
|
cmStdString m_ConfiguredFilesPath;
|
|
cmake *m_CMakeInstance;
|
|
std::vector<cmLocalGenerator *> m_LocalGenerators;
|
|
// map from project name to vector of local generators in that project
|
|
std::map<cmStdString, std::vector<cmLocalGenerator*> > m_ProjectMap;
|
|
|
|
private:
|
|
// If you add a new map here, make sure it is copied
|
|
// in EnableLanguagesFromGenerator
|
|
std::map<cmStdString, bool> m_IgnoreExtensions;
|
|
std::map<cmStdString, bool> m_LanguageEnabled;
|
|
std::map<cmStdString, cmStdString> m_OutputExtensions;
|
|
std::map<cmStdString, cmStdString> m_LanguageToOutputExtension;
|
|
std::map<cmStdString, cmStdString> m_ExtensionToLanguage;
|
|
std::map<cmStdString, cmStdString> m_LanguageToLinkerPreference;
|
|
|
|
// 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.
|
|
std::string m_RelativePathTopSource;
|
|
std::string m_RelativePathTopBinary;
|
|
};
|
|
|
|
#endif
|