CMake/Source/cmTarget.h

351 lines
11 KiB
C
Raw Normal View History

/*============================================================================
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 cmTarget_h
#define cmTarget_h
#include "cmStandardIncludes.h"
#include "cmCustomCommand.h"
#include "cmListFileCache.h"
#include "cmPolicies.h"
#include "cmPropertyMap.h"
#include <cmsys/auto_ptr.hxx>
#if defined(CMAKE_BUILD_WITH_CMAKE)
#ifdef CMake_HAVE_CXX_UNORDERED_MAP
#include <unordered_map>
#else
#include <cmsys/hash_map.hxx>
#endif
#endif
class cmake;
class cmMakefile;
2002-09-28 00:24:10 +04:00
class cmSourceFile;
class cmGlobalGenerator;
class cmListFileBacktrace;
class cmTarget;
class cmGeneratorTarget;
class cmTargetTraceDependencies;
class cmTargetInternals;
class cmTargetInternalPointer
{
public:
cmTargetInternalPointer();
cmTargetInternalPointer(cmTargetInternalPointer const& r);
~cmTargetInternalPointer();
cmTargetInternalPointer& operator=(cmTargetInternalPointer const& r);
cmTargetInternals* operator->() const { return this->Pointer; }
cmTargetInternals* Get() const { return this->Pointer; }
private:
cmTargetInternals* Pointer;
};
/** \class cmTarget
* \brief Represent a library or executable target loaded from a makefile.
*
* cmTarget represents a target loaded from
* a makefile.
*/
class cmTarget
{
public:
cmTarget();
enum CustomCommandType
{
PRE_BUILD,
PRE_LINK,
POST_BUILD
};
2003-06-03 18:30:23 +04:00
/**
* Return the type of target.
*/
cmState::TargetType GetType() const { return this->TargetTypeValue; }
/**
* Set the target type
*/
void SetType(cmState::TargetType f, const std::string& name);
void MarkAsImported(bool global = false);
///! Set/Get the name of the target
const std::string& GetName() const { return this->Name; }
///! Set the cmMakefile that owns this target
void SetMakefile(cmMakefile* mf);
cmMakefile* GetMakefile() const { return this->Makefile; }
#define DECLARE_TARGET_POLICY(POLICY) \
cmPolicies::PolicyStatus GetPolicyStatus##POLICY() const \
{ \
return this->PolicyMap.Get(cmPolicies::POLICY); \
}
CM_FOR_EACH_TARGET_POLICY(DECLARE_TARGET_POLICY)
#undef DECLARE_TARGET_POLICY
/**
* Get the list of the custom commands for this target
*/
std::vector<cmCustomCommand> const& GetPreBuildCommands() const
{
return this->PreBuildCommands;
}
std::vector<cmCustomCommand> const& GetPreLinkCommands() const
{
return this->PreLinkCommands;
}
std::vector<cmCustomCommand> const& GetPostBuildCommands() const
{
return this->PostBuildCommands;
}
void AddPreBuildCommand(cmCustomCommand const& cmd)
{
this->PreBuildCommands.push_back(cmd);
}
void AddPreLinkCommand(cmCustomCommand const& cmd)
{
this->PreLinkCommands.push_back(cmd);
}
void AddPostBuildCommand(cmCustomCommand const& cmd)
{
this->PostBuildCommands.push_back(cmd);
}
/**
* Add sources to the target.
*/
void AddSources(std::vector<std::string> const& srcs);
void AddTracedSources(std::vector<std::string> const& srcs);
cmSourceFile* AddSourceCMP0049(const std::string& src);
cmSourceFile* AddSource(const std::string& src);
//* how we identify a library, by name and type
typedef std::pair<std::string, cmTargetLinkLibraryType> LibraryID;
typedef std::vector<LibraryID> LinkLibraryVectorType;
const LinkLibraryVectorType& GetOriginalLinkLibraries() const
{
return this->OriginalLinkLibraries;
}
/**
* Clear the dependency information recorded for this target, if any.
*/
2014-02-07 02:31:47 +04:00
void ClearDependencyInformation(cmMakefile& mf, const std::string& target);
void AddLinkLibrary(cmMakefile& mf, const std::string& target,
const std::string& lib, cmTargetLinkLibraryType llt);
enum TLLSignature
{
KeywordTLLSignature,
PlainTLLSignature
};
bool PushTLLCommandTrace(TLLSignature signature,
cmListFileContext const& lfc);
void GetTllSignatureTraces(std::ostream& s, TLLSignature sig) const;
2002-05-04 00:34:05 +04:00
void MergeLinkLibraries(cmMakefile& mf, const std::string& selfname,
const LinkLibraryVectorType& libs);
2002-05-04 00:34:05 +04:00
const std::vector<std::string>& GetLinkDirectories() const;
2014-02-07 02:31:47 +04:00
void AddLinkDirectory(const std::string& d);
2001-05-23 19:31:43 +04:00
/**
* Set the path where this target should be installed. This is relative to
* INSTALL_PREFIX
*/
std::string GetInstallPath() const { return this->InstallPath; }
void SetInstallPath(const char* name) { this->InstallPath = name; }
/**
* Set the path where this target (if it has a runtime part) should be
* installed. This is relative to INSTALL_PREFIX
*/
std::string GetRuntimeInstallPath() const
{
return this->RuntimeInstallPath;
}
void SetRuntimeInstallPath(const char* name)
{
this->RuntimeInstallPath = name;
}
/**
* Get/Set whether there is an install rule for this target.
*/
bool GetHaveInstallRule() const { return this->HaveInstallRule; }
2006-03-15 19:02:08 +03:00
void SetHaveInstallRule(bool h) { this->HaveInstallRule = h; }
/** Add a utility on which this project depends. A utility is an executable
* name as would be specified to the ADD_EXECUTABLE or UTILITY_SOURCE
* commands. It is not a full path nor does it have an extension.
*/
2016-06-27 23:44:16 +03:00
void AddUtility(const std::string& u, cmMakefile* makefile = CM_NULLPTR);
///! Get the utilities used by this target
std::set<std::string> const& GetUtilities() const { return this->Utilities; }
2014-02-07 02:31:47 +04:00
cmListFileBacktrace const* GetUtilityBacktrace(const std::string& u) const;
2001-06-13 21:49:24 +04:00
2002-12-21 01:15:45 +03:00
///! Set/Get a property of this target file
void SetProperty(const std::string& prop, const char* value);
void AppendProperty(const std::string& prop, const char* value,
bool asString = false);
const char* GetProperty(const std::string& prop) const;
const char* GetProperty(const std::string& prop, cmMakefile* context) const;
bool GetPropertyAsBool(const std::string& prop) const;
void CheckProperty(const std::string& prop, cmMakefile* context) const;
bool IsImported() const { return this->IsImportedTarget; }
bool IsImportedGloballyVisible() const
{
return this->ImportedGloballyVisible;
}
2002-12-21 01:15:45 +03:00
// Get the properties
cmPropertyMap& GetProperties() const { return this->Properties; }
bool GetMappedConfig(std::string const& desired_config, const char** loc,
const char** imp, std::string& suffix) const;
/** Return whether this target is an executable with symbol exports
enabled. */
bool IsExecutableWithExports() const;
/** Return whether this target is a shared library Framework on
Apple. */
bool IsFrameworkOnApple() const;
/** Return whether this target is an executable Bundle on Apple. */
bool IsAppBundleOnApple() const;
/** Get a backtrace from the creation of the target. */
cmListFileBacktrace const& GetBacktrace() const;
void InsertInclude(std::string const& entry, cmListFileBacktrace const& bt,
bool before = false);
void InsertCompileOption(std::string const& entry,
cmListFileBacktrace const& bt, bool before = false);
void InsertCompileDefinition(std::string const& entry,
cmListFileBacktrace const& bt);
void AppendBuildInterfaceIncludes();
std::string GetDebugGeneratorExpressions(const std::string& value,
cmTargetLinkLibraryType llt) const;
void AddSystemIncludeDirectories(const std::set<std::string>& incs);
std::set<std::string> const& GetSystemIncludeDirectories() const
{
return this->SystemIncludeDirectories;
}
cmStringRange GetIncludeDirectoriesEntries() const;
cmBacktraceRange GetIncludeDirectoriesBacktraces() const;
cmStringRange GetCompileOptionsEntries() const;
cmBacktraceRange GetCompileOptionsBacktraces() const;
cmStringRange GetCompileFeaturesEntries() const;
cmBacktraceRange GetCompileFeaturesBacktraces() const;
cmStringRange GetCompileDefinitionsEntries() const;
cmBacktraceRange GetCompileDefinitionsBacktraces() const;
cmStringRange GetSourceEntries() const;
cmBacktraceRange GetSourceBacktraces() const;
cmStringRange GetLinkImplementationEntries() const;
cmBacktraceRange GetLinkImplementationBacktraces() const;
struct StrictTargetComparison
{
bool operator()(cmTarget const* t1, cmTarget const* t2) const;
};
2002-05-01 22:00:21 +04:00
private:
bool HandleLocationPropertyPolicy(cmMakefile* context) const;
const char* GetSuffixVariableInternal(bool implib) const;
const char* GetPrefixVariableInternal(bool implib) const;
// Use a makefile variable to set a default for the given property.
// If the variable is not defined use the given default instead.
void SetPropertyDefault(const std::string& property,
const char* default_value);
std::string ImportedGetFullPath(const std::string& config,
bool implib) const;
private:
mutable cmPropertyMap Properties;
std::set<std::string> SystemIncludeDirectories;
std::set<std::string> LinkDirectoriesEmmitted;
std::set<std::string> Utilities;
std::map<std::string, cmListFileBacktrace> UtilityBacktraces;
cmPolicies::PolicyMap PolicyMap;
2006-03-15 19:02:08 +03:00
std::string Name;
std::string InstallPath;
std::string RuntimeInstallPath;
std::vector<std::string> LinkDirectories;
2006-03-15 19:02:08 +03:00
std::vector<cmCustomCommand> PreBuildCommands;
std::vector<cmCustomCommand> PreLinkCommands;
std::vector<cmCustomCommand> PostBuildCommands;
std::vector<std::pair<TLLSignature, cmListFileContext> > TLLCommands;
2006-03-15 19:02:08 +03:00
LinkLibraryVectorType PrevLinkedLibraries;
LinkLibraryVectorType OriginalLinkLibraries;
cmMakefile* Makefile;
cmTargetInternalPointer Internal;
cmState::TargetType TargetTypeValue;
2006-03-15 19:02:08 +03:00
bool HaveInstallRule;
bool RecordDependencies;
bool DLLPlatform;
bool IsAndroid;
bool IsImportedTarget;
bool ImportedGloballyVisible;
bool BuildInterfaceIncludesAppended;
std::string ProcessSourceItemCMP0049(const std::string& s);
/** Return whether or not the target has a DLL import library. */
bool HasImportLibrary() const;
// Internal representation details.
friend class cmTargetInternals;
friend class cmGeneratorTarget;
friend class cmTargetTraceDependencies;
cmListFileBacktrace Backtrace;
};
#ifdef CMAKE_BUILD_WITH_CMAKE
#ifdef CMake_HAVE_CXX_UNORDERED_MAP
typedef std::unordered_map<std::string, cmTarget> cmTargets;
#else
typedef cmsys::hash_map<std::string, cmTarget> cmTargets;
#endif
#else
typedef std::map<std::string, cmTarget> cmTargets;
#endif
class cmTargetSet : public std::set<std::string>
{
};
class cmTargetManifest : public std::map<std::string, cmTargetSet>
{
};
#endif