mirror of
https://github.com/Kitware/CMake.git
synced 2026-01-07 06:09:52 -06:00
a1ad0a699b
Previously the command did not allow naming targets on the LHS that were not created in the calling directory. Lift this restriction to enable more flexible use by projects. Targets named on the RHS will need to be looked up during generation in the scope of the call site rather than the scope of the LHS target. Introduce an internal syntax in `[INTERFACE_]LINK_LIBRARIES` properties to specify target names that need to be looked up in a directory other than that containing the target on which the property is set. Add minimal documentation of the syntax to help users that encounter it. Unfortunately CMake previously did allow such calls in the case that only `INTERFACE` libraries are specified, but those libraries would be looked up in the target's directory rather than the caller's. Add policy `CMP0079` to enable the new behavior with new lookup scope in a compatible way. Fixes: #17943
1028 lines
33 KiB
C++
1028 lines
33 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#ifndef cmMakefile_h
|
|
#define cmMakefile_h
|
|
|
|
#include "cmConfigure.h" // IWYU pragma: keep
|
|
|
|
#include "cmsys/RegularExpression.hxx"
|
|
#include <deque>
|
|
#include <map>
|
|
#include <memory> // IWYU pragma: keep
|
|
#include <set>
|
|
#include <stack>
|
|
#include <stddef.h>
|
|
#include <string>
|
|
#include <unordered_map>
|
|
#include <vector>
|
|
|
|
#include "cmAlgorithms.h"
|
|
#include "cmListFileCache.h"
|
|
#include "cmNewLineStyle.h"
|
|
#include "cmPolicies.h"
|
|
#include "cmSourceFileLocationKind.h"
|
|
#include "cmStateSnapshot.h"
|
|
#include "cmStateTypes.h"
|
|
#include "cmTarget.h"
|
|
#include "cmake.h"
|
|
|
|
#if defined(CMAKE_BUILD_WITH_CMAKE)
|
|
# include "cmSourceGroup.h"
|
|
#endif
|
|
|
|
class cmCommand;
|
|
class cmCompiledGeneratorExpression;
|
|
class cmCustomCommandLines;
|
|
class cmExecutionStatus;
|
|
class cmExpandedCommandArgument;
|
|
class cmExportBuildFileGenerator;
|
|
class cmFunctionBlocker;
|
|
class cmGeneratorExpressionEvaluationFile;
|
|
class cmGlobalGenerator;
|
|
class cmInstallGenerator;
|
|
class cmMessenger;
|
|
class cmSourceFile;
|
|
class cmState;
|
|
class cmTest;
|
|
class cmTestGenerator;
|
|
class cmVariableWatch;
|
|
|
|
/** A type-safe wrapper for a string representing a directory id. */
|
|
class cmDirectoryId
|
|
{
|
|
public:
|
|
cmDirectoryId(std::string s);
|
|
std::string String;
|
|
};
|
|
|
|
/** \class cmMakefile
|
|
* \brief Process the input CMakeLists.txt file.
|
|
*
|
|
* Process and store into memory the input CMakeLists.txt file.
|
|
* Each CMakeLists.txt file is parsed and the commands found there
|
|
* are added into the build process.
|
|
*/
|
|
class cmMakefile
|
|
{
|
|
CM_DISABLE_COPY(cmMakefile)
|
|
|
|
public:
|
|
/* Mark a variable as used */
|
|
void MarkVariableAsUsed(const std::string& var);
|
|
/* return true if a variable has been initialized */
|
|
bool VariableInitialized(const std::string&) const;
|
|
|
|
/**
|
|
* Construct an empty makefile.
|
|
*/
|
|
cmMakefile(cmGlobalGenerator* globalGenerator,
|
|
const cmStateSnapshot& snapshot);
|
|
|
|
/**
|
|
* Destructor.
|
|
*/
|
|
~cmMakefile();
|
|
|
|
cmDirectoryId GetDirectoryId() const;
|
|
|
|
bool ReadListFile(const char* filename);
|
|
|
|
bool ReadDependentFile(const char* filename, bool noPolicyScope = true);
|
|
|
|
bool ProcessBuildsystemFile(const char* filename);
|
|
|
|
/**
|
|
* Add a function blocker to this makefile
|
|
*/
|
|
void AddFunctionBlocker(cmFunctionBlocker* fb);
|
|
|
|
/// @return whether we are processing the top CMakeLists.txt file.
|
|
bool IsRootMakefile() const;
|
|
|
|
/**
|
|
* Remove the function blocker whose scope ends with the given command.
|
|
* This returns ownership of the function blocker object.
|
|
*/
|
|
std::unique_ptr<cmFunctionBlocker> RemoveFunctionBlocker(
|
|
cmFunctionBlocker* fb, const cmListFileFunction& lff);
|
|
|
|
/**
|
|
* Try running cmake and building a file. This is used for dynalically
|
|
* loaded commands, not as part of the usual build process.
|
|
*/
|
|
int TryCompile(const std::string& srcdir, const std::string& bindir,
|
|
const std::string& projectName, const std::string& targetName,
|
|
bool fast, int jobs,
|
|
const std::vector<std::string>* cmakeArgs,
|
|
std::string& output);
|
|
|
|
bool GetIsSourceFileTryCompile() const;
|
|
|
|
/**
|
|
* Help enforce global target name uniqueness.
|
|
*/
|
|
bool EnforceUniqueName(std::string const& name, std::string& msg,
|
|
bool isCustom = false) const;
|
|
|
|
/**
|
|
* Perform FinalPass, Library dependency analysis etc before output of the
|
|
* makefile.
|
|
*/
|
|
void ConfigureFinalPass();
|
|
|
|
/**
|
|
* run the final pass on all commands.
|
|
*/
|
|
void FinalPass();
|
|
|
|
/** How to handle custom commands for object libraries */
|
|
enum ObjectLibraryCommands
|
|
{
|
|
RejectObjectLibraryCommands,
|
|
AcceptObjectLibraryCommands
|
|
};
|
|
|
|
/** Add a custom command to the build. */
|
|
void AddCustomCommandToTarget(
|
|
const std::string& target, const std::vector<std::string>& byproducts,
|
|
const std::vector<std::string>& depends,
|
|
const cmCustomCommandLines& commandLines, cmTarget::CustomCommandType type,
|
|
const char* comment, const char* workingDir, bool escapeOldStyle = true,
|
|
bool uses_terminal = false, const std::string& depfile = "",
|
|
bool command_expand_lists = false,
|
|
ObjectLibraryCommands objLibraryCommands = RejectObjectLibraryCommands);
|
|
cmSourceFile* AddCustomCommandToOutput(
|
|
const std::vector<std::string>& outputs,
|
|
const std::vector<std::string>& byproducts,
|
|
const std::vector<std::string>& depends,
|
|
const std::string& main_dependency,
|
|
const cmCustomCommandLines& commandLines, const char* comment,
|
|
const char* workingDir, bool replace = false, bool escapeOldStyle = true,
|
|
bool uses_terminal = false, bool command_expand_lists = false,
|
|
const std::string& depfile = "");
|
|
cmSourceFile* AddCustomCommandToOutput(
|
|
const std::string& output, const std::vector<std::string>& depends,
|
|
const std::string& main_dependency,
|
|
const cmCustomCommandLines& commandLines, const char* comment,
|
|
const char* workingDir, bool replace = false, bool escapeOldStyle = true,
|
|
bool uses_terminal = false, bool command_expand_lists = false,
|
|
const std::string& depfile = "");
|
|
void AddCustomCommandOldStyle(const std::string& target,
|
|
const std::vector<std::string>& outputs,
|
|
const std::vector<std::string>& depends,
|
|
const std::string& source,
|
|
const cmCustomCommandLines& commandLines,
|
|
const char* comment);
|
|
|
|
/**
|
|
* Add a define flag to the build.
|
|
*/
|
|
void AddDefineFlag(std::string const& definition);
|
|
void RemoveDefineFlag(std::string const& definition);
|
|
void AddCompileDefinition(std::string const& definition);
|
|
void AddCompileOption(std::string const& option);
|
|
void AddLinkOption(std::string const& option);
|
|
|
|
/** Create a new imported target with the name and type given. */
|
|
cmTarget* AddImportedTarget(const std::string& name,
|
|
cmStateEnums::TargetType type, bool global);
|
|
|
|
cmTarget* AddNewTarget(cmStateEnums::TargetType type,
|
|
const std::string& name);
|
|
|
|
/**
|
|
* Add an executable to the build.
|
|
*/
|
|
cmTarget* AddExecutable(const std::string& exename,
|
|
const std::vector<std::string>& srcs,
|
|
bool excludeFromAll = false);
|
|
|
|
/** Where the target originated from. */
|
|
enum class TargetOrigin
|
|
{
|
|
Project,
|
|
Generator
|
|
};
|
|
|
|
/**
|
|
* Add a utility to the build. A utility target is a command that
|
|
* is run every time the target is built.
|
|
*/
|
|
cmTarget* AddUtilityCommand(const std::string& utilityName,
|
|
TargetOrigin origin, bool excludeFromAll,
|
|
const std::vector<std::string>& depends,
|
|
const char* workingDirectory,
|
|
const char* command, const char* arg1 = nullptr,
|
|
const char* arg2 = nullptr,
|
|
const char* arg3 = nullptr,
|
|
const char* arg4 = nullptr);
|
|
cmTarget* AddUtilityCommand(
|
|
const std::string& utilityName, TargetOrigin origin, bool excludeFromAll,
|
|
const char* workingDirectory, const std::vector<std::string>& depends,
|
|
const cmCustomCommandLines& commandLines, bool escapeOldStyle = true,
|
|
const char* comment = nullptr, bool uses_terminal = false,
|
|
bool command_expand_lists = false);
|
|
cmTarget* AddUtilityCommand(
|
|
const std::string& utilityName, TargetOrigin origin, bool excludeFromAll,
|
|
const char* workingDirectory, const std::vector<std::string>& byproducts,
|
|
const std::vector<std::string>& depends,
|
|
const cmCustomCommandLines& commandLines, bool escapeOldStyle = true,
|
|
const char* comment = nullptr, bool uses_terminal = false,
|
|
bool command_expand_lists = false);
|
|
|
|
/**
|
|
* Add a subdirectory to the build.
|
|
*/
|
|
void AddSubDirectory(const std::string& fullSrcDir,
|
|
const std::string& fullBinDir, bool excludeFromAll,
|
|
bool immediate);
|
|
|
|
void Configure();
|
|
|
|
/**
|
|
* Configure a subdirectory
|
|
*/
|
|
void ConfigureSubDirectory(cmMakefile* mf);
|
|
|
|
/**
|
|
* Add an include directory to the build.
|
|
*/
|
|
void AddIncludeDirectories(const std::vector<std::string>& incs,
|
|
bool before = false);
|
|
|
|
/**
|
|
* Add a variable definition to the build. This variable
|
|
* can be used in CMake to refer to lists, directories, etc.
|
|
*/
|
|
void AddDefinition(const std::string& name, const char* value);
|
|
///! Add a definition to this makefile and the global cmake cache.
|
|
void AddCacheDefinition(const std::string& name, const char* value,
|
|
const char* doc, cmStateEnums::CacheEntryType type,
|
|
bool force = false);
|
|
|
|
/**
|
|
* Add bool variable definition to the build.
|
|
*/
|
|
void AddDefinition(const std::string& name, bool);
|
|
|
|
/**
|
|
* Remove a variable definition from the build. This is not valid
|
|
* for cache entries, and will only affect the current makefile.
|
|
*/
|
|
void RemoveDefinition(const std::string& name);
|
|
///! Remove a definition from the cache.
|
|
void RemoveCacheDefinition(const std::string& name);
|
|
|
|
/**
|
|
* Specify the name of the project for this build.
|
|
*/
|
|
void SetProjectName(std::string const& name);
|
|
|
|
/** Get the configurations to be generated. */
|
|
std::string GetConfigurations(std::vector<std::string>& configs,
|
|
bool single = true) const;
|
|
|
|
/**
|
|
* Set the name of the library.
|
|
*/
|
|
cmTarget* AddLibrary(const std::string& libname,
|
|
cmStateEnums::TargetType type,
|
|
const std::vector<std::string>& srcs,
|
|
bool excludeFromAll = false);
|
|
void AddAlias(const std::string& libname, const std::string& tgt);
|
|
|
|
//@{
|
|
/**
|
|
* Set, Push, Pop policy values for CMake.
|
|
*/
|
|
bool SetPolicy(cmPolicies::PolicyID id, cmPolicies::PolicyStatus status);
|
|
bool SetPolicy(const char* id, cmPolicies::PolicyStatus status);
|
|
cmPolicies::PolicyStatus GetPolicyStatus(cmPolicies::PolicyID id,
|
|
bool parent_scope = false) const;
|
|
bool SetPolicyVersion(std::string const& version_min,
|
|
std::string const& version_max);
|
|
void RecordPolicies(cmPolicies::PolicyMap& pm);
|
|
//@}
|
|
|
|
/** Helper class to push and pop policies automatically. */
|
|
class PolicyPushPop
|
|
{
|
|
public:
|
|
PolicyPushPop(cmMakefile* m);
|
|
~PolicyPushPop();
|
|
|
|
private:
|
|
cmMakefile* Makefile;
|
|
};
|
|
friend class PolicyPushPop;
|
|
|
|
/**
|
|
* Determine if the given context, name pair has already been reported
|
|
* in context of CMP0054.
|
|
*/
|
|
bool HasCMP0054AlreadyBeenReported(const cmListFileContext& context) const;
|
|
|
|
bool IgnoreErrorsCMP0061() const;
|
|
|
|
std::string const& GetHomeDirectory() const;
|
|
std::string const& GetHomeOutputDirectory() const;
|
|
|
|
/**
|
|
* Set CMAKE_SCRIPT_MODE_FILE variable when running a -P script.
|
|
*/
|
|
void SetScriptModeFile(std::string const& scriptfile);
|
|
|
|
/**
|
|
* Set CMAKE_ARGC, CMAKE_ARGV0 ... variables.
|
|
*/
|
|
void SetArgcArgv(const std::vector<std::string>& args);
|
|
|
|
std::string const& GetCurrentSourceDirectory() const;
|
|
std::string const& GetCurrentBinaryDirectory() const;
|
|
|
|
//@}
|
|
|
|
/**
|
|
* Set a regular expression that include files must match
|
|
* in order to be considered as part of the depend information.
|
|
*/
|
|
void SetIncludeRegularExpression(const char* regex)
|
|
{
|
|
this->SetProperty("INCLUDE_REGULAR_EXPRESSION", regex);
|
|
}
|
|
const char* GetIncludeRegularExpression() const
|
|
{
|
|
return this->GetProperty("INCLUDE_REGULAR_EXPRESSION");
|
|
}
|
|
|
|
/**
|
|
* Set a regular expression that include files that are not found
|
|
* must match in order to be considered a problem.
|
|
*/
|
|
void SetComplainRegularExpression(const std::string& regex)
|
|
{
|
|
this->ComplainFileRegularExpression = regex;
|
|
}
|
|
const char* GetComplainRegularExpression() const
|
|
{
|
|
return this->ComplainFileRegularExpression.c_str();
|
|
}
|
|
|
|
/**
|
|
* Get the list of targets
|
|
*/
|
|
cmTargets& GetTargets() { return this->Targets; }
|
|
/**
|
|
* Get the list of targets, const version
|
|
*/
|
|
const cmTargets& GetTargets() const { return this->Targets; }
|
|
const std::vector<cmTarget*>& GetOwnedImportedTargets() const
|
|
{
|
|
return this->ImportedTargetsOwned;
|
|
}
|
|
std::vector<cmTarget*> GetImportedTargets() const;
|
|
|
|
cmTarget* FindLocalNonAliasTarget(const std::string& name) const;
|
|
|
|
/** Find a target to use in place of the given name. The target
|
|
returned may be imported or built within the project. */
|
|
cmTarget* FindTargetToUse(const std::string& name,
|
|
bool excludeAliases = false) const;
|
|
bool IsAlias(const std::string& name) const;
|
|
|
|
std::map<std::string, std::string> GetAliasTargets() const
|
|
{
|
|
return this->AliasTargets;
|
|
}
|
|
|
|
/**
|
|
* Mark include directories as system directories.
|
|
*/
|
|
void AddSystemIncludeDirectories(const std::set<std::string>& incs);
|
|
|
|
/** Get a cmSourceFile pointer for a given source name, if the name is
|
|
* not found, then a null pointer is returned.
|
|
*/
|
|
cmSourceFile* GetSource(
|
|
const std::string& sourceName,
|
|
cmSourceFileLocationKind kind = cmSourceFileLocationKind::Ambiguous) const;
|
|
|
|
/** Create the source file and return it. generated
|
|
* indicates if it is a generated file, this is used in determining
|
|
* how to create the source file instance e.g. name
|
|
*/
|
|
cmSourceFile* CreateSource(
|
|
const std::string& sourceName, bool generated = false,
|
|
cmSourceFileLocationKind kind = cmSourceFileLocationKind::Ambiguous);
|
|
|
|
/** Get a cmSourceFile pointer for a given source name, if the name is
|
|
* not found, then create the source file and return it. generated
|
|
* indicates if it is a generated file, this is used in determining
|
|
* how to create the source file instance e.g. name
|
|
*/
|
|
cmSourceFile* GetOrCreateSource(
|
|
const std::string& sourceName, bool generated = false,
|
|
cmSourceFileLocationKind kind = cmSourceFileLocationKind::Ambiguous);
|
|
|
|
void AddTargetObject(std::string const& tgtName, std::string const& objFile);
|
|
|
|
/**
|
|
* Given a variable name, return its value (as a string).
|
|
* If the variable is not found in this makefile instance, the
|
|
* cache is then queried.
|
|
*/
|
|
const char* GetDefinition(const std::string&) const;
|
|
const char* GetSafeDefinition(const std::string&) const;
|
|
std::string GetRequiredDefinition(const std::string& name) const;
|
|
bool IsDefinitionSet(const std::string&) const;
|
|
/**
|
|
* Get the list of all variables in the current space. If argument
|
|
* cacheonly is specified and is greater than 0, then only cache
|
|
* variables will be listed.
|
|
*/
|
|
std::vector<std::string> GetDefinitions() const;
|
|
|
|
/**
|
|
* Test a boolean variable to see if it is true or false.
|
|
* If the variable is not found in this makefile instance, the
|
|
* cache is then queried.
|
|
* Returns false if no entry defined.
|
|
*/
|
|
bool IsOn(const std::string& name) const;
|
|
bool IsSet(const std::string& name) const;
|
|
|
|
/** Return whether the target platform is 32-bit. */
|
|
bool PlatformIs32Bit() const;
|
|
|
|
/** Return whether the target platform is 64-bit. */
|
|
bool PlatformIs64Bit() const;
|
|
/** Return whether the target platform is x32. */
|
|
bool PlatformIsx32() const;
|
|
|
|
/** Apple SDK Type */
|
|
enum class AppleSDK
|
|
{
|
|
MacOS,
|
|
IPhoneOS,
|
|
IPhoneSimulator,
|
|
AppleTVOS,
|
|
AppleTVSimulator,
|
|
WatchOS,
|
|
WatchSimulator,
|
|
};
|
|
|
|
/** What SDK type points CMAKE_OSX_SYSROOT to? */
|
|
AppleSDK GetAppleSDKType() const;
|
|
|
|
/** Return whether the target platform is Apple iOS. */
|
|
bool PlatformIsAppleEmbedded() const;
|
|
|
|
/** Retrieve soname flag for the specified language if supported */
|
|
const char* GetSONameFlag(const std::string& language) const;
|
|
|
|
/**
|
|
* Get a list of preprocessor define flags.
|
|
*/
|
|
std::string GetDefineFlags() const { return this->DefineFlags; }
|
|
|
|
/**
|
|
* Make sure CMake can write this file
|
|
*/
|
|
bool CanIWriteThisFile(std::string const& fileName) const;
|
|
|
|
#if defined(CMAKE_BUILD_WITH_CMAKE)
|
|
/**
|
|
* Get the vector source groups.
|
|
*/
|
|
const std::vector<cmSourceGroup>& GetSourceGroups() const
|
|
{
|
|
return this->SourceGroups;
|
|
}
|
|
|
|
/**
|
|
* Get the source group
|
|
*/
|
|
cmSourceGroup* GetSourceGroup(const std::vector<std::string>& name) const;
|
|
|
|
/**
|
|
* Add a root source group for consideration when adding a new source.
|
|
*/
|
|
void AddSourceGroup(const std::string& name, const char* regex = nullptr);
|
|
|
|
/**
|
|
* Add a source group for consideration when adding a new source.
|
|
* name is tokenized.
|
|
*/
|
|
void AddSourceGroup(const std::vector<std::string>& name,
|
|
const char* regex = nullptr);
|
|
|
|
/**
|
|
* Get and existing or create a new source group.
|
|
*/
|
|
cmSourceGroup* GetOrCreateSourceGroup(
|
|
const std::vector<std::string>& folders);
|
|
|
|
/**
|
|
* Get and existing or create a new source group.
|
|
* The name will be tokenized.
|
|
*/
|
|
cmSourceGroup* GetOrCreateSourceGroup(const std::string& name);
|
|
|
|
/**
|
|
* find what source group this source is in
|
|
*/
|
|
cmSourceGroup* FindSourceGroup(const std::string& source,
|
|
std::vector<cmSourceGroup>& groups) const;
|
|
#endif
|
|
|
|
/**
|
|
* Get the vector of list files on which this makefile depends
|
|
*/
|
|
const std::vector<std::string>& GetListFiles() const
|
|
{
|
|
return this->ListFiles;
|
|
}
|
|
///! When the file changes cmake will be re-run from the build system.
|
|
void AddCMakeDependFile(const std::string& file)
|
|
{
|
|
this->ListFiles.push_back(file);
|
|
}
|
|
void AddCMakeDependFilesFromUser();
|
|
|
|
std::string FormatListFileStack() const;
|
|
|
|
/**
|
|
* Get the current context backtrace.
|
|
*/
|
|
cmListFileBacktrace GetBacktrace() const;
|
|
cmListFileBacktrace GetBacktrace(cmCommandContext const& lfc) const;
|
|
cmListFileContext GetExecutionContext() const;
|
|
|
|
/**
|
|
* Get the vector of files created by this makefile
|
|
*/
|
|
const std::vector<std::string>& GetOutputFiles() const
|
|
{
|
|
return this->OutputFiles;
|
|
}
|
|
void AddCMakeOutputFile(const std::string& file)
|
|
{
|
|
this->OutputFiles.push_back(file);
|
|
}
|
|
|
|
/**
|
|
* Expand all defined variables in the string.
|
|
* Defined variables come from the this->Definitions map.
|
|
* They are expanded with ${var} where var is the
|
|
* entry in the this->Definitions map. Also \@var\@ is
|
|
* expanded to match autoconf style expansions.
|
|
*/
|
|
const std::string& ExpandVariablesInString(std::string& source) const;
|
|
const std::string& ExpandVariablesInString(
|
|
std::string& source, bool escapeQuotes, bool noEscapes,
|
|
bool atOnly = false, const char* filename = nullptr, long line = -1,
|
|
bool removeEmpty = false, bool replaceAt = false) const;
|
|
|
|
/**
|
|
* Remove any remaining variables in the string. Anything with ${var} or
|
|
* \@var\@ will be removed.
|
|
*/
|
|
void RemoveVariablesInString(std::string& source, bool atOnly = false) const;
|
|
|
|
/**
|
|
* Expand variables in the makefiles ivars such as link directories etc
|
|
*/
|
|
void ExpandVariablesCMP0019();
|
|
|
|
/**
|
|
* Replace variables and #cmakedefine lines in the given string.
|
|
* See cmConfigureFileCommand for details.
|
|
*/
|
|
void ConfigureString(const std::string& input, std::string& output,
|
|
bool atOnly, bool escapeQuotes) const;
|
|
|
|
/**
|
|
* Copy file but change lines according to ConfigureString
|
|
*/
|
|
int ConfigureFile(const char* infile, const char* outfile, bool copyonly,
|
|
bool atOnly, bool escapeQuotes,
|
|
cmNewLineStyle = cmNewLineStyle());
|
|
|
|
/**
|
|
* Print a command's invocation
|
|
*/
|
|
void PrintCommandTrace(const cmListFileFunction& lff) const;
|
|
|
|
/**
|
|
* Execute a single CMake command. Returns true if the command
|
|
* succeeded or false if it failed.
|
|
*/
|
|
bool ExecuteCommand(const cmListFileFunction& lff,
|
|
cmExecutionStatus& status);
|
|
|
|
///! Enable support for named language, if nil then all languages are
|
|
/// enabled.
|
|
void EnableLanguage(std::vector<std::string> const& languages,
|
|
bool optional);
|
|
|
|
cmState* GetState() const;
|
|
|
|
/**
|
|
* Get the variable watch. This is used to determine when certain variables
|
|
* are accessed.
|
|
*/
|
|
#ifdef CMAKE_BUILD_WITH_CMAKE
|
|
cmVariableWatch* GetVariableWatch() const;
|
|
#endif
|
|
|
|
///! Display progress or status message.
|
|
void DisplayStatus(const char*, float) const;
|
|
|
|
/**
|
|
* Expand the given list file arguments into the full set after
|
|
* variable replacement and list expansion.
|
|
*/
|
|
bool ExpandArguments(std::vector<cmListFileArgument> const& inArgs,
|
|
std::vector<std::string>& outArgs,
|
|
const char* filename = nullptr) const;
|
|
|
|
bool ExpandArguments(std::vector<cmListFileArgument> const& inArgs,
|
|
std::vector<cmExpandedCommandArgument>& outArgs,
|
|
const char* filename = nullptr) const;
|
|
|
|
/**
|
|
* Get the instance
|
|
*/
|
|
cmake* GetCMakeInstance() const;
|
|
cmMessenger* GetMessenger() const;
|
|
cmGlobalGenerator* GetGlobalGenerator() const;
|
|
|
|
/**
|
|
* Get all the source files this makefile knows about
|
|
*/
|
|
const std::vector<cmSourceFile*>& GetSourceFiles() const
|
|
{
|
|
return this->SourceFiles;
|
|
}
|
|
|
|
/**
|
|
* Is there a source file that has the provided source file as an output?
|
|
* if so then return it
|
|
*/
|
|
cmSourceFile* GetSourceFileWithOutput(const std::string& outName) const;
|
|
|
|
///! Add a new cmTest to the list of tests for this makefile.
|
|
cmTest* CreateTest(const std::string& testName);
|
|
|
|
/** Get a cmTest pointer for a given test name, if the name is
|
|
* not found, then a null pointer is returned.
|
|
*/
|
|
cmTest* GetTest(const std::string& testName) const;
|
|
|
|
/**
|
|
* Get all tests that run under the given configuration.
|
|
*/
|
|
void GetTests(const std::string& config, std::vector<cmTest*>& tests);
|
|
|
|
/**
|
|
* Return a location of a file in cmake or custom modules directory
|
|
*/
|
|
std::string GetModulesFile(const char* name) const;
|
|
|
|
///! Set/Get a property of this directory
|
|
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, bool chain) const;
|
|
bool GetPropertyAsBool(const std::string& prop) const;
|
|
std::vector<std::string> GetPropertyKeys() const;
|
|
|
|
///! Initialize a makefile from its parent
|
|
void InitializeFromParent(cmMakefile* parent);
|
|
|
|
void AddInstallGenerator(cmInstallGenerator* g)
|
|
{
|
|
if (g) {
|
|
this->InstallGenerators.push_back(g);
|
|
}
|
|
}
|
|
std::vector<cmInstallGenerator*>& GetInstallGenerators()
|
|
{
|
|
return this->InstallGenerators;
|
|
}
|
|
const std::vector<cmInstallGenerator*>& GetInstallGenerators() const
|
|
{
|
|
return this->InstallGenerators;
|
|
}
|
|
|
|
void AddTestGenerator(cmTestGenerator* g)
|
|
{
|
|
if (g) {
|
|
this->TestGenerators.push_back(g);
|
|
}
|
|
}
|
|
const std::vector<cmTestGenerator*>& GetTestGenerators() const
|
|
{
|
|
return this->TestGenerators;
|
|
}
|
|
|
|
class FunctionPushPop
|
|
{
|
|
public:
|
|
FunctionPushPop(cmMakefile* mf, std::string const& fileName,
|
|
cmPolicies::PolicyMap const& pm);
|
|
~FunctionPushPop();
|
|
|
|
void Quiet() { this->ReportError = false; }
|
|
|
|
private:
|
|
cmMakefile* Makefile;
|
|
bool ReportError;
|
|
};
|
|
|
|
class MacroPushPop
|
|
{
|
|
public:
|
|
MacroPushPop(cmMakefile* mf, std::string const& fileName,
|
|
cmPolicies::PolicyMap const& pm);
|
|
~MacroPushPop();
|
|
|
|
void Quiet() { this->ReportError = false; }
|
|
|
|
private:
|
|
cmMakefile* Makefile;
|
|
bool ReportError;
|
|
};
|
|
|
|
void PushFunctionScope(std::string const& fileName,
|
|
cmPolicies::PolicyMap const& pm);
|
|
void PopFunctionScope(bool reportError);
|
|
void PushMacroScope(std::string const& fileName,
|
|
cmPolicies::PolicyMap const& pm);
|
|
void PopMacroScope(bool reportError);
|
|
void PushScope();
|
|
void PopScope();
|
|
void RaiseScope(const std::string& var, const char* value);
|
|
|
|
// push and pop loop scopes
|
|
void PushLoopBlockBarrier();
|
|
void PopLoopBlockBarrier();
|
|
|
|
/** Helper class to push and pop scopes automatically. */
|
|
class ScopePushPop
|
|
{
|
|
CM_DISABLE_COPY(ScopePushPop)
|
|
public:
|
|
ScopePushPop(cmMakefile* m)
|
|
: Makefile(m)
|
|
{
|
|
this->Makefile->PushScope();
|
|
}
|
|
~ScopePushPop() { this->Makefile->PopScope(); }
|
|
|
|
private:
|
|
cmMakefile* Makefile;
|
|
};
|
|
|
|
void IssueMessage(cmake::MessageType t, std::string const& text) const;
|
|
|
|
/** Set whether or not to report a CMP0000 violation. */
|
|
void SetCheckCMP0000(bool b) { this->CheckCMP0000 = b; }
|
|
|
|
bool CheckCMP0037(std::string const& targetName,
|
|
cmStateEnums::TargetType targetType) const;
|
|
|
|
cmStringRange GetIncludeDirectoriesEntries() const;
|
|
cmBacktraceRange GetIncludeDirectoriesBacktraces() const;
|
|
cmStringRange GetCompileOptionsEntries() const;
|
|
cmBacktraceRange GetCompileOptionsBacktraces() const;
|
|
cmStringRange GetCompileDefinitionsEntries() const;
|
|
cmBacktraceRange GetCompileDefinitionsBacktraces() const;
|
|
cmStringRange GetLinkOptionsEntries() const;
|
|
cmBacktraceRange GetLinkOptionsBacktraces() const;
|
|
|
|
std::set<std::string> const& GetSystemIncludeDirectories() const
|
|
{
|
|
return this->SystemIncludeDirectories;
|
|
}
|
|
|
|
bool PolicyOptionalWarningEnabled(std::string const& var);
|
|
|
|
bool AddRequiredTargetFeature(cmTarget* target, const std::string& feature,
|
|
std::string* error = nullptr) const;
|
|
|
|
bool CompileFeatureKnown(cmTarget const* target, const std::string& feature,
|
|
std::string& lang, std::string* error) const;
|
|
|
|
const char* CompileFeaturesAvailable(const std::string& lang,
|
|
std::string* error) const;
|
|
|
|
bool HaveStandardAvailable(cmTarget const* target, std::string const& lang,
|
|
const std::string& feature) const;
|
|
|
|
bool IsLaterStandard(std::string const& lang, std::string const& lhs,
|
|
std::string const& rhs);
|
|
|
|
void PushLoopBlock();
|
|
void PopLoopBlock();
|
|
bool IsLoopBlock() const;
|
|
|
|
void ClearMatches();
|
|
void StoreMatches(cmsys::RegularExpression& re);
|
|
|
|
cmStateSnapshot GetStateSnapshot() const;
|
|
|
|
const char* GetDefineFlagsCMP0059() const;
|
|
|
|
std::string GetExecutionFilePath() const;
|
|
|
|
void EnforceDirectoryLevelRules() const;
|
|
|
|
void AddEvaluationFile(
|
|
const std::string& inputFile,
|
|
std::unique_ptr<cmCompiledGeneratorExpression> outputName,
|
|
std::unique_ptr<cmCompiledGeneratorExpression> condition,
|
|
bool inputIsContent);
|
|
std::vector<cmGeneratorExpressionEvaluationFile*> GetEvaluationFiles() const;
|
|
|
|
std::vector<cmExportBuildFileGenerator*> GetExportBuildFileGenerators()
|
|
const;
|
|
void RemoveExportBuildFileGeneratorCMP0024(cmExportBuildFileGenerator* gen);
|
|
void AddExportBuildFileGenerator(cmExportBuildFileGenerator* gen);
|
|
|
|
// Maintain a stack of package roots to allow nested PACKAGE_ROOT_PATH
|
|
// searches
|
|
std::deque<std::vector<std::string>> FindPackageRootPathStack;
|
|
|
|
void MaybeWarnCMP0074(std::string const& pkg);
|
|
|
|
protected:
|
|
// add link libraries and directories to the target
|
|
void AddGlobalLinkInformation(cmTarget& target);
|
|
|
|
// Check for a an unused variable
|
|
void LogUnused(const char* reason, const std::string& name) const;
|
|
|
|
mutable std::set<cmListFileContext> CMP0054ReportedIds;
|
|
|
|
// libraries, classes, and executables
|
|
mutable cmTargets Targets;
|
|
std::map<std::string, std::string> AliasTargets;
|
|
|
|
typedef std::vector<cmSourceFile*> SourceFileVec;
|
|
SourceFileVec SourceFiles;
|
|
|
|
// Because cmSourceFile names are compared in a fuzzy way (see
|
|
// cmSourceFileLocation::Match()) we can't have a straight mapping from
|
|
// filename to cmSourceFile. To make lookups more efficient we store the
|
|
// Name portion of the cmSourceFileLocation and then compare on the list of
|
|
// cmSourceFiles that might match that name. Note that on platforms which
|
|
// have a case-insensitive filesystem we store the key in all lowercase.
|
|
typedef std::unordered_map<std::string, SourceFileVec> SourceFileMap;
|
|
SourceFileMap SourceFileSearchIndex;
|
|
|
|
// For "Known" paths we can store a direct filename to cmSourceFile map
|
|
std::unordered_map<std::string, cmSourceFile*> KnownFileSearchIndex;
|
|
|
|
// Tests
|
|
std::map<std::string, cmTest*> Tests;
|
|
|
|
// The set of include directories that are marked as system include
|
|
// directories.
|
|
std::set<std::string> SystemIncludeDirectories;
|
|
|
|
std::vector<std::string> ListFiles;
|
|
std::vector<std::string> OutputFiles;
|
|
|
|
std::vector<cmInstallGenerator*> InstallGenerators;
|
|
std::vector<cmTestGenerator*> TestGenerators;
|
|
|
|
std::string ComplainFileRegularExpression;
|
|
std::string DefineFlags;
|
|
|
|
// Track the value of the computed DEFINITIONS property.
|
|
std::string DefineFlagsOrig;
|
|
|
|
#if defined(CMAKE_BUILD_WITH_CMAKE)
|
|
std::vector<cmSourceGroup> SourceGroups;
|
|
size_t ObjectLibrariesSourceGroupIndex;
|
|
#endif
|
|
|
|
std::vector<cmCommand*> FinalPassCommands;
|
|
cmGlobalGenerator* GlobalGenerator;
|
|
bool IsFunctionBlocked(const cmListFileFunction& lff,
|
|
cmExecutionStatus& status);
|
|
|
|
private:
|
|
cmStateSnapshot StateSnapshot;
|
|
cmListFileBacktrace Backtrace;
|
|
|
|
void ReadListFile(cmListFile const& listFile,
|
|
const std::string& filenametoread);
|
|
|
|
bool ParseDefineFlag(std::string const& definition, bool remove);
|
|
|
|
bool EnforceUniqueDir(const std::string& srcPath,
|
|
const std::string& binPath) const;
|
|
|
|
typedef std::vector<cmFunctionBlocker*> FunctionBlockersType;
|
|
FunctionBlockersType FunctionBlockers;
|
|
std::vector<FunctionBlockersType::size_type> FunctionBlockerBarriers;
|
|
void PushFunctionBlockerBarrier();
|
|
void PopFunctionBlockerBarrier(bool reportError = true);
|
|
|
|
std::stack<int> LoopBlockCounter;
|
|
|
|
mutable cmsys::RegularExpression cmDefineRegex;
|
|
mutable cmsys::RegularExpression cmDefine01Regex;
|
|
mutable cmsys::RegularExpression cmAtVarRegex;
|
|
mutable cmsys::RegularExpression cmNamedCurly;
|
|
|
|
std::vector<cmMakefile*> UnConfiguredDirectories;
|
|
std::vector<cmExportBuildFileGenerator*> ExportBuildFileGenerators;
|
|
|
|
std::vector<cmGeneratorExpressionEvaluationFile*> EvaluationFiles;
|
|
|
|
std::vector<cmExecutionStatus*> ExecutionStatusStack;
|
|
friend class cmMakefileCall;
|
|
friend class cmParseFileScope;
|
|
|
|
std::vector<cmTarget*> ImportedTargetsOwned;
|
|
typedef std::unordered_map<std::string, cmTarget*> TargetMap;
|
|
TargetMap ImportedTargets;
|
|
|
|
// Internal policy stack management.
|
|
void PushPolicy(bool weak = false,
|
|
cmPolicies::PolicyMap const& pm = cmPolicies::PolicyMap());
|
|
void PopPolicy();
|
|
void PopSnapshot(bool reportError = true);
|
|
friend class cmCMakePolicyCommand;
|
|
class IncludeScope;
|
|
|
|
friend class IncludeScope;
|
|
class ListFileScope;
|
|
|
|
friend class ListFileScope;
|
|
class BuildsystemFileScope;
|
|
|
|
friend class BuildsystemFileScope;
|
|
|
|
// CMP0053 == old
|
|
cmake::MessageType ExpandVariablesInStringOld(
|
|
std::string& errorstr, std::string& source, bool escapeQuotes,
|
|
bool noEscapes, bool atOnly, const char* filename, long line,
|
|
bool removeEmpty, bool replaceAt) const;
|
|
// CMP0053 == new
|
|
cmake::MessageType ExpandVariablesInStringNew(
|
|
std::string& errorstr, std::string& source, bool escapeQuotes,
|
|
bool noEscapes, bool atOnly, const char* filename, long line,
|
|
bool removeEmpty, bool replaceAt) const;
|
|
/**
|
|
* Old version of GetSourceFileWithOutput(const std::string&) kept for
|
|
* backward-compatibility. It implements a linear search and support
|
|
* relative file paths. It is used as a fall back by
|
|
* GetSourceFileWithOutput(const std::string&).
|
|
*/
|
|
cmSourceFile* LinearGetSourceFileWithOutput(const std::string& cname) const;
|
|
|
|
// A map for fast output to input look up.
|
|
typedef std::unordered_map<std::string, cmSourceFile*> OutputToSourceMap;
|
|
OutputToSourceMap OutputToSource;
|
|
|
|
void UpdateOutputToSourceMap(std::vector<std::string> const& outputs,
|
|
cmSourceFile* source);
|
|
void UpdateOutputToSourceMap(std::string const& output,
|
|
cmSourceFile* source);
|
|
|
|
bool AddRequiredTargetCFeature(cmTarget* target, const std::string& feature,
|
|
std::string* error = nullptr) const;
|
|
|
|
bool AddRequiredTargetCxxFeature(cmTarget* target,
|
|
const std::string& feature,
|
|
std::string* error = nullptr) const;
|
|
|
|
void CheckNeededCLanguage(const std::string& feature, bool& needC90,
|
|
bool& needC99, bool& needC11) const;
|
|
void CheckNeededCxxLanguage(const std::string& feature, bool& needCxx98,
|
|
bool& needCxx11, bool& needCxx14,
|
|
bool& needCxx17, bool& needCxx20) const;
|
|
|
|
bool HaveCStandardAvailable(cmTarget const* target,
|
|
const std::string& feature) const;
|
|
bool HaveCxxStandardAvailable(cmTarget const* target,
|
|
const std::string& feature) const;
|
|
|
|
void CheckForUnusedVariables() const;
|
|
|
|
// Unused variable flags
|
|
bool WarnUnused;
|
|
bool CheckSystemVars;
|
|
bool CheckCMP0000;
|
|
std::set<std::string> WarnedCMP0074;
|
|
bool IsSourceFileTryCompile;
|
|
mutable bool SuppressWatches;
|
|
};
|
|
|
|
#endif
|