CMake/Source/cmLocalGenerator.h

390 lines
15 KiB
C
Raw Normal View History

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
2002-08-31 00:00:35 +04:00
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt 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 License for more information.
============================================================================*/
2002-08-31 00:00:35 +04:00
#ifndef cmLocalGenerator_h
#define cmLocalGenerator_h
#include "cmStandardIncludes.h"
#include "cmState.h"
#include "cmake.h"
#include "cmOutputConverter.h"
2002-08-31 00:00:35 +04:00
class cmMakefile;
class cmGlobalGenerator;
class cmGeneratorTarget;
class cmTarget;
class cmTargetManifest;
class cmSourceFile;
class cmCustomCommand;
class cmCustomCommandGenerator;
2002-08-31 00:00:35 +04:00
/** \class cmLocalGenerator
* \brief Create required build files for a directory.
*
* Subclasses of this abstract class generate makefiles, DSP, etc for various
2011-03-19 13:41:00 +03:00
* platforms. This class should never be constructed directly. A
2002-08-31 00:00:35 +04:00
* GlobalGenerator will create it and invoke the appropriate commands on it.
*/
class cmLocalGenerator : public cmOutputConverter
2002-08-31 00:00:35 +04:00
{
public:
cmLocalGenerator(cmGlobalGenerator* gg, cmLocalGenerator* parent,
cmState::Snapshot snapshot);
2002-09-05 17:04:55 +04:00
virtual ~cmLocalGenerator();
2011-10-13 21:51:18 +04:00
2002-08-31 00:00:35 +04:00
/**
2011-10-13 21:51:18 +04:00
* Generate the makefile for this directory.
2002-08-31 00:00:35 +04:00
*/
virtual void Generate() {}
2002-08-31 00:00:35 +04:00
virtual void ComputeHomeRelativeOutputPath() {}
2011-10-13 21:51:18 +04:00
/**
* Calls TraceVSDependencies() on all targets of this generator.
*/
void TraceDependencies();
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 GenerateTargetManifest();
2002-08-31 00:00:35 +04:00
///! Get the makefile for this generator
cmMakefile *GetMakefile() {
return this->Makefile; }
2011-10-13 21:51:18 +04:00
///! Get the makefile for this generator, const version
const cmMakefile *GetMakefile() const {
return this->Makefile; }
2011-10-13 21:51:18 +04:00
2002-08-31 00:00:35 +04:00
///! Get the GlobalGenerator this is associated with
cmGlobalGenerator *GetGlobalGenerator() {
return this->GlobalGenerator; }
2011-03-26 16:31:59 +03:00
const cmGlobalGenerator *GetGlobalGenerator() const {
return this->GlobalGenerator; }
2002-08-31 00:00:35 +04:00
cmState* GetState() const;
cmState::Snapshot GetStateSnapshot() const;
2011-10-13 21:51:18 +04:00
///! set/get the parent generator
cmLocalGenerator* GetParent() const {return this->Parent;}
///! set/get the children
void AddChild(cmLocalGenerator* g) { this->Children.push_back(g); }
std::vector<cmLocalGenerator*>& GetChildren() { return this->Children; }
2011-10-13 21:51:18 +04:00
void AddArchitectureFlags(std::string& flags,
cmGeneratorTarget const* target,
const std::string&lang, const std::string& config);
void AddLanguageFlags(std::string& flags, const std::string& lang,
const std::string& config);
void AddCMP0018Flags(std::string &flags, cmTarget const* target,
std::string const& lang, const std::string& config);
void AddVisibilityPresetFlags(std::string &flags, cmTarget const* target,
const std::string& lang);
void AddConfigVariableFlags(std::string& flags, const std::string& var,
const std::string& config);
void AddCompilerRequirementFlag(std::string &flags, cmTarget const* target,
const std::string& lang);
2011-03-20 14:16:43 +03:00
///! Append flags to a string.
virtual void AppendFlags(std::string& flags, const std::string& newFlags);
2007-05-10 22:43:55 +04:00
virtual void AppendFlags(std::string& flags, const char* newFlags);
virtual void AppendFlagEscape(std::string& flags,
const std::string& rawFlag);
2005-02-04 01:42:55 +03:00
///! Get the include flags for the current makefile and language
2011-11-07 14:49:33 +04:00
std::string GetIncludeFlags(const std::vector<std::string> &includes,
cmGeneratorTarget* target,
const std::string& lang,
bool forceFullPaths = false,
bool forResponseFile = false,
const std::string& config = "");
/**
* Encode a list of preprocessor definitions for the compiler
* command line.
*/
void AppendDefines(std::set<std::string>& defines,
const char* defines_list);
void AppendDefines(std::set<std::string>& defines,
std::string defines_list)
{
this->AppendDefines(defines, defines_list.c_str());
}
void AppendDefines(std::set<std::string>& defines,
const std::vector<std::string> &defines_vec);
/**
* Join a set of defines into a definesString with a space separator.
*/
void JoinDefines(const std::set<std::string>& 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);
const char* 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);
virtual std::string ConvertToIncludeReference(std::string const& path,
OutputFormat format = SHELL,
bool forceFullPaths = false);
/** Called from command-line hook to clear dependencies. */
2011-10-13 21:51:18 +04:00
virtual void ClearDependencies(cmMakefile* /* mf */,
bool /* verbose */) {}
2011-10-13 21:51:18 +04:00
/** Called from command-line hook to update dependencies. */
virtual bool UpdateDependencies(const char* /* tgtInfo */,
bool /*verbose*/,
bool /*color*/)
{ return true; }
2005-05-12 18:49:56 +04:00
/** Get the include flags for the current makefile and language. */
void GetIncludeDirectories(std::vector<std::string>& dirs,
cmGeneratorTarget* target,
const std::string& lang = "C",
const std::string& config = "",
bool stripImplicitInclDirs = true) const;
void AddCompileOptions(std::string& flags, cmTarget* target,
const std::string& lang, const std::string& config);
void AddCompileDefinitions(std::set<std::string>& defines,
cmTarget const* target,
const std::string& config,
const std::string& lang);
/** 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.
2012-06-16 14:58:06 +04:00
virtual void GetIndividualFileTargets(std::vector<std::string>&) {}
// Create a struct to hold the varibles passed into
// ExpandRuleVariables
struct RuleVariables
{
RuleVariables()
{
memset(this, 0, sizeof(*this));
}
cmTarget* CMTarget;
const char* TargetPDB;
const char* TargetCompilePDB;
const char* TargetVersionMajor;
const char* TargetVersionMinor;
const char* Language;
const char* Objects;
const char* Target;
const char* LinkLibraries;
const char* Source;
const char* AssemblySource;
const char* PreprocessedSource;
const char* Output;
const char* Object;
const char* ObjectDir;
const char* ObjectFileDir;
const char* Flags;
const char* ObjectsQuoted;
Support building shared libraries or modules without soname (#13155) Add a boolean target property NO_SONAME which may be used to disable soname for the specified shared library or module even if the platform supports it. This property should be useful for private shared libraries or various plugins which live in private directories and have not been designed to be found or loaded globally. Replace references to <CMAKE_SHARED_LIBRARY_SONAME_${LANG}_FLAG> and hard-coded -install_name flags with a conditional <SONAME_FLAG> which is expanded to the value of the CMAKE_SHARED_LIBRARY_SONAME_${LANG}_FLAG definition as long as soname supports is enabled for the target in question. Keep expanding CMAKE_SHARED_LIBRARY_SONAME_${LANG}_FLAG in rules in case third party projects still use it. Such projects would not yet use NO_SONAME so the adjacent <TARGET_SONAME> will always be expanded. Make <TARGET_INSTALLNAME_DIR> NO_SONAME aware as well. Since -install_name is soname on OS X, this should not be a problem if this variable is expanded only if soname is enabled. The Ninja generator performs rule variable substitution only once globally per rule to put its own placeholders. Final substitution is performed by ninja at build time. Therefore we cannot conditionally replace the soname placeholders on a per-target basis. Rather than omitting $SONAME from rules.ninja, simply do not write its contents for targets which have NO_SONAME. Since 3 variables are affected by NO_SONAME ($SONAME, $SONAME_FLAG, $INSTALLNAME_DIR), set them only if soname is enabled.
2012-04-22 17:42:55 +04:00
const char* SONameFlag;
const char* TargetSOName;
const char* TargetInstallNameDir;
const char* LinkFlags;
const char* LanguageCompileFlags;
const char* Defines;
const char* RuleLauncher;
const char* DependencyFile;
const char* FilterPrefix;
};
2006-02-20 22:37:24 +03:00
/**
* Get the relative path from the generator output directory to a
* per-target support directory.
*/
virtual std::string GetTargetDirectory(cmTarget 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.
*/
cmIML_INT_uint64_t GetBackwardsCompatibility();
/**
* Test whether compatibility is set to a given version or lower.
*/
bool NeedBackwardsCompatibility_2_4();
/**
* Generate a Mac OS X application bundle Info.plist file.
*/
2014-02-07 02:31:47 +04:00
void GenerateAppleInfoPList(cmTarget* target, const std::string& targetName,
const char* fname);
/**
* Generate a Mac OS X framework Info.plist file.
*/
void GenerateFrameworkInfoPList(cmTarget* target,
2014-02-07 02:31:47 +04:00
const std::string& targetName,
const char* fname);
/** Construct a comment for a custom command. */
std::string ConstructComment(cmCustomCommandGenerator const& ccg,
const char* default_comment = "");
// Compute object file names.
std::string GetObjectFileNameWithoutTarget(const cmSourceFile& source,
std::string const& dir_max,
bool* hasSourceExtension = 0);
/** Fill out the static linker flags for the given target. */
void GetStaticLibraryFlags(std::string& flags,
std::string const& config,
cmTarget* target);
2006-03-10 21:54:57 +03:00
/** Fill out these strings for the given target. Libraries to link,
* flags, and linkflags. */
2011-10-13 21:51:18 +04:00
void GetTargetFlags(std::string& linkLibs,
2006-02-20 22:37:24 +03:00
std::string& flags,
std::string& linkFlags,
std::string& frameworkPath,
std::string& linkPath,
cmGeneratorTarget* target,
bool useWatcomQuote);
2011-10-13 21:51:18 +04:00
virtual void ComputeObjectFilenames(
std::map<cmSourceFile const*, std::string>& mapping,
cmGeneratorTarget const* gt = 0);
bool IsWindowsShell() const;
bool IsWatcomWMake() const;
bool IsMinGWMake() const;
bool IsNMake() const;
void IssueMessage(cmake::MessageType t, std::string const& text) const;
void ComputeObjectMaxPath();
protected:
2006-02-20 22:37:24 +03:00
///! put all the libraries for a target on into the given stream
2015-05-19 10:47:18 +03:00
void OutputLinkLibraries(std::string& linkLibraries,
std::string& frameworkPath,
std::string& linkPath,
cmGeneratorTarget &,
bool relink,
bool forResponseFile,
bool useWatcomQuote);
2011-10-13 21:51:18 +04:00
// Expand rule variables in CMake of the type found in language rules
void ExpandRuleVariables(std::string& string,
const RuleVariables& replaceValues);
2005-04-12 21:27:07 +04:00
// Expand rule variables in a single string
std::string ExpandRuleVariable(std::string const& variable,
const RuleVariables& replaceValues);
const char* GetRuleLauncher(cmTarget* target, const std::string& prop);
void InsertRuleLauncher(std::string& s, cmTarget* target,
const std::string& prop);
2011-10-13 21:51:18 +04:00
/** Convert a target to a utility target for unsupported
2006-03-10 21:54:57 +03:00
* languages of a generator */
void AddBuildTargetRule(const std::string& llang,
cmGeneratorTarget& target);
2011-10-13 21:51:18 +04:00
///! add a custom command to build a .o file that is part of a target
void AddCustomCommandToCreateObject(const char* ofname,
const std::string& lang,
cmSourceFile& source,
cmGeneratorTarget& target);
// Create Custom Targets and commands for unsupported languages
// The set passed in should contain the languages supported by the
// generator directly. Any targets containing files that are not
// of the types listed will be compiled as custom commands and added
// to a custom target.
void CreateCustomTargetsAndCommands(std::set<std::string> const&);
// Handle old-style install rules stored in the targets.
void GenerateTargetInstallRules(
std::ostream& os, const std::string& config,
std::vector<std::string> const& configurationTypes);
std::string& CreateSafeUniqueObjectFileName(const std::string& sin,
std::string const& dir_max);
virtual std::string ConvertToLinkReference(std::string const& lib,
OutputFormat format = SHELL);
/** Check whether the native build system supports the given
definition. Issues a warning. */
virtual bool CheckDefinition(std::string const& define) const;
2006-03-15 19:02:08 +03:00
cmMakefile *Makefile;
cmState::Snapshot StateSnapshot;
2006-03-15 19:02:08 +03:00
cmGlobalGenerator *GlobalGenerator;
cmLocalGenerator* Parent;
std::vector<cmLocalGenerator*> Children;
std::map<std::string, std::string> UniqueObjectNamesMap;
std::string::size_type ObjectPathMax;
std::set<std::string> ObjectMaxPathViolations;
std::set<cmTarget const*> WarnCMP0063;
bool EmitUniversalBinaryFlags;
// Hack for ExpandRuleVariable until object-oriented version is
// committed.
2006-03-15 19:02:08 +03:00
std::string TargetImplib;
cmIML_INT_uint64_t BackwardsCompatibility;
bool BackwardsCompatibilityFinal;
private:
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);
2002-08-31 00:00:35 +04:00
};
#endif