mirror of
https://github.com/Kitware/CMake.git
synced 2026-08-12 12:15:34 +00:00
ca5d569524
Add an additional state to the cmake instance to track diagnostics. Use
this to initialize any new/reset states we create so that other contexts
will inherit the diagnostic state from presets / command-line options.
Modify the front-end to map presets and -W command-line options to
manipulation of this new diagnostic state. Remove old members for
storing diagnostic state. Rework how diagnostic state is persisted.
Deprecate old, non-standard spellings for manipulating diagnostics.
Deprecate old 'dev' spelling for CMD_AUTHOR.
Note that this is a work in progress. Messaging has not yet been
updated, so the new state is not yet being used to control diagnostics,
and some of the logic to update the old state has been stripped (and
will eventually be removed entirely). Backward compatibility support for
the deprecated CMAKE_{WARN,ERROR}_DEPRECATED variables is only partially
implemented. The GUI's interface for manipulating warnings is partially
broken and needs to be overhauled. These tasks are being done in
separate commits in order to minimize review burden and keep the changes
per commit / per merge request more manageable.
316 lines
12 KiB
C++
316 lines
12 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file LICENSE.rst or https://cmake.org/licensing for details. */
|
|
#pragma once
|
|
|
|
#include "cmConfigure.h" // IWYU pragma: keep
|
|
|
|
#include <functional>
|
|
#include <memory>
|
|
#include <set>
|
|
#include <string>
|
|
#include <unordered_map>
|
|
#include <unordered_set>
|
|
#include <utility>
|
|
#include <vector>
|
|
|
|
#include <cm/optional>
|
|
|
|
#include "cmDefinitions.h"
|
|
#include "cmDependencyProvider.h"
|
|
#include "cmLinkedTree.h"
|
|
#include "cmPolicies.h"
|
|
#include "cmProperty.h"
|
|
#include "cmPropertyDefinition.h"
|
|
#include "cmPropertyMap.h"
|
|
#include "cmStatePrivate.h"
|
|
#include "cmStateTypes.h"
|
|
#include "cmValue.h"
|
|
|
|
class cmCacheManager;
|
|
class cmGlobVerificationManager;
|
|
class cmMakefile;
|
|
class cmStateSnapshot;
|
|
class cmMessenger;
|
|
class cmExecutionStatus;
|
|
class cmListFileBacktrace;
|
|
struct cmGlobCacheEntry;
|
|
struct cmListFileArgument;
|
|
|
|
template <typename T>
|
|
class BT;
|
|
|
|
class cmState
|
|
{
|
|
friend class cmStateSnapshot;
|
|
|
|
public:
|
|
enum class Role
|
|
{
|
|
Internal,
|
|
Project,
|
|
Script,
|
|
FindPackage,
|
|
CTest,
|
|
CPack,
|
|
Help,
|
|
};
|
|
|
|
enum class TryCompile
|
|
{
|
|
No,
|
|
Yes,
|
|
};
|
|
|
|
cmState(Role role, TryCompile isTryCompile = TryCompile::No);
|
|
~cmState();
|
|
|
|
cmState(cmState const&) = delete;
|
|
cmState& operator=(cmState const&) = delete;
|
|
|
|
static std::string const& GetTargetTypeName(
|
|
cmStateEnums::TargetType targetType);
|
|
|
|
cmStateSnapshot CreateBaseSnapshot();
|
|
cmStateSnapshot CreateBuildsystemDirectorySnapshot(
|
|
cmStateSnapshot const& originSnapshot);
|
|
cmStateSnapshot CreateDeferCallSnapshot(
|
|
cmStateSnapshot const& originSnapshot, std::string const& fileName);
|
|
cmStateSnapshot CreateFunctionCallSnapshot(
|
|
cmStateSnapshot const& originSnapshot, std::string const& fileName);
|
|
cmStateSnapshot CreateMacroCallSnapshot(
|
|
cmStateSnapshot const& originSnapshot, std::string const& fileName);
|
|
cmStateSnapshot CreateIncludeFileSnapshot(
|
|
cmStateSnapshot const& originSnapshot, std::string const& fileName);
|
|
cmStateSnapshot CreateVariableScopeSnapshot(
|
|
cmStateSnapshot const& originSnapshot);
|
|
cmStateSnapshot CreateInlineListFileSnapshot(
|
|
cmStateSnapshot const& originSnapshot, std::string const& fileName);
|
|
cmStateSnapshot CreatePolicyScopeSnapshot(
|
|
cmStateSnapshot const& originSnapshot);
|
|
cmStateSnapshot Pop(cmStateSnapshot const& originSnapshot);
|
|
|
|
static cmStateEnums::CacheEntryType StringToCacheEntryType(
|
|
std::string const&);
|
|
static bool StringToCacheEntryType(std::string const&,
|
|
cmStateEnums::CacheEntryType& type);
|
|
static std::string const& CacheEntryTypeToString(
|
|
cmStateEnums::CacheEntryType);
|
|
static bool IsCacheEntryType(std::string const& key);
|
|
|
|
bool LoadCache(std::string const& path, bool internal,
|
|
std::set<std::string>& excludes,
|
|
std::set<std::string>& includes);
|
|
|
|
bool SaveCache(std::string const& path, cmMessenger* messenger);
|
|
|
|
bool DeleteCache(std::string const& path);
|
|
|
|
bool IsCacheLoaded() const;
|
|
|
|
std::vector<std::string> GetCacheEntryKeys() const;
|
|
cmValue GetCacheEntryValue(std::string const& key) const;
|
|
std::string GetSafeCacheEntryValue(std::string const& key) const;
|
|
cmValue GetInitializedCacheValue(std::string const& key) const;
|
|
cmStateEnums::CacheEntryType GetCacheEntryType(std::string const& key) const;
|
|
void SetCacheEntryValue(std::string const& key, std::string const& value);
|
|
|
|
void RemoveCacheEntry(std::string const& key);
|
|
|
|
void SetCacheEntryProperty(std::string const& key,
|
|
std::string const& propertyName,
|
|
std::string const& value);
|
|
void SetCacheEntryBoolProperty(std::string const& key,
|
|
std::string const& propertyName, bool value);
|
|
std::vector<std::string> GetCacheEntryPropertyList(std::string const& key);
|
|
cmValue GetCacheEntryProperty(std::string const& key,
|
|
std::string const& propertyName);
|
|
bool GetCacheEntryPropertyAsBool(std::string const& key,
|
|
std::string const& propertyName);
|
|
void AppendCacheEntryProperty(std::string const& key,
|
|
std::string const& property,
|
|
std::string const& value,
|
|
bool asString = false);
|
|
void RemoveCacheEntryProperty(std::string const& key,
|
|
std::string const& propertyName);
|
|
|
|
//! Break up a line like VAR:type="value" into var, type and value
|
|
static bool ParseCacheEntry(std::string const& entry, std::string& var,
|
|
std::string& value,
|
|
cmStateEnums::CacheEntryType& type);
|
|
|
|
// Define a property
|
|
void DefineProperty(std::string const& name, cmProperty::ScopeType scope,
|
|
std::string const& ShortDescription,
|
|
std::string const& FullDescription, bool chain = false,
|
|
std::string const& initializeFromVariable = "");
|
|
|
|
// get property definition
|
|
cmPropertyDefinition const* GetPropertyDefinition(
|
|
std::string const& name, cmProperty::ScopeType scope) const;
|
|
|
|
cmPropertyDefinitionMap const& GetPropertyDefinitions() const
|
|
{
|
|
return this->PropertyDefinitions;
|
|
}
|
|
|
|
bool IsPropertyChained(std::string const& name,
|
|
cmProperty::ScopeType scope) const;
|
|
|
|
void SetLanguageEnabled(std::string const& l);
|
|
bool GetLanguageEnabled(std::string const& l) const;
|
|
std::vector<std::string> GetEnabledLanguages() const;
|
|
void SetEnabledLanguages(std::vector<std::string> const& langs);
|
|
void ClearEnabledLanguages();
|
|
|
|
bool GetIsGeneratorMultiConfig() const;
|
|
void SetIsGeneratorMultiConfig(bool b);
|
|
|
|
using Command = std::function<bool(std::vector<cmListFileArgument> const&,
|
|
cmExecutionStatus&)>;
|
|
using BuiltinCommand = bool (*)(std::vector<std::string> const&,
|
|
cmExecutionStatus&);
|
|
|
|
// Returns a command from its name, case insensitive, or nullptr
|
|
Command GetCommand(std::string const& name) const;
|
|
// Returns a command from its name, or nullptr
|
|
Command GetCommandByExactName(std::string const& name) const;
|
|
|
|
void AddBuiltinCommand(std::string const& name, Command command);
|
|
void AddBuiltinCommand(std::string const& name, BuiltinCommand command);
|
|
void AddFlowControlCommand(std::string const& name, Command command);
|
|
void AddFlowControlCommand(std::string const& name, BuiltinCommand command);
|
|
void AddDisallowedCommand(std::string const& name, BuiltinCommand command,
|
|
cmPolicies::PolicyID policy, char const* message,
|
|
char const* additionalWarning = nullptr);
|
|
void AddRemovedCommand(std::string const& name, std::string const& message);
|
|
void AddUnexpectedCommand(std::string const& name, char const* error);
|
|
void AddUnexpectedFlowControlCommand(std::string const& name,
|
|
char const* error);
|
|
bool AddScriptedCommand(std::string const& name, BT<Command> command,
|
|
cmMakefile& mf);
|
|
void RemoveBuiltinCommand(std::string const& name);
|
|
void RemoveUserDefinedCommands();
|
|
std::vector<std::string> GetCommandNames() const;
|
|
|
|
void SetGlobalProperty(std::string const& prop, std::string const& value);
|
|
void SetGlobalProperty(std::string const& prop, cmValue value);
|
|
void AppendGlobalProperty(std::string const& prop, std::string const& value,
|
|
bool asString = false);
|
|
cmValue GetGlobalProperty(std::string const& prop);
|
|
bool GetGlobalPropertyAsBool(std::string const& prop);
|
|
|
|
std::string const& GetSourceDirectory() const;
|
|
void SetSourceDirectory(std::string const& sourceDirectory);
|
|
std::string const& GetBinaryDirectory() const;
|
|
void SetBinaryDirectory(std::string const& binaryDirectory);
|
|
|
|
void SetWindowsShell(bool windowsShell);
|
|
bool UseWindowsShell() const;
|
|
void SetWindowsVSIDE(bool windowsVSIDE);
|
|
bool UseWindowsVSIDE() const;
|
|
void SetGhsMultiIDE(bool ghsMultiIDE);
|
|
bool UseGhsMultiIDE() const;
|
|
void SetBorlandMake(bool borlandMake);
|
|
bool UseBorlandMake() const;
|
|
void SetWatcomWMake(bool watcomWMake);
|
|
bool UseWatcomWMake() const;
|
|
void SetMinGWMake(bool minGWMake);
|
|
bool UseMinGWMake() const;
|
|
void SetNMake(bool nMake);
|
|
bool UseNMake() const;
|
|
void SetMSYSShell(bool mSYSShell);
|
|
bool UseMSYSShell() const;
|
|
void SetNinja(bool ninja);
|
|
bool UseNinja() const;
|
|
void SetNinjaMulti(bool ninjaMulti);
|
|
bool UseNinjaMulti() const;
|
|
void SetFastbuildMake(bool fastbuildMake);
|
|
bool UseFastbuildMake() const;
|
|
|
|
unsigned int GetCacheMajorVersion() const;
|
|
unsigned int GetCacheMinorVersion() const;
|
|
|
|
void SetRoleToProjectForCMakeBuildVsReconfigure();
|
|
void SetRoleToHelpForListPresets();
|
|
Role GetRole() const;
|
|
std::string GetRoleString() const;
|
|
|
|
static std::string RoleToString(Role role);
|
|
|
|
TryCompile GetIsTryCompile() const;
|
|
|
|
void ClearDependencyProvider() { this->DependencyProvider.reset(); }
|
|
void SetDependencyProvider(cmDependencyProvider provider)
|
|
{
|
|
this->DependencyProvider = std::move(provider);
|
|
}
|
|
cm::optional<cmDependencyProvider> const& GetDependencyProvider() const
|
|
{
|
|
return this->DependencyProvider;
|
|
}
|
|
Command GetDependencyProviderCommand(
|
|
cmDependencyProvider::Method method) const;
|
|
|
|
void SetInTopLevelIncludes(bool inTopLevelIncludes)
|
|
{
|
|
this->ProcessingTopLevelIncludes = inTopLevelIncludes;
|
|
}
|
|
bool InTopLevelIncludes() const { return this->ProcessingTopLevelIncludes; }
|
|
|
|
private:
|
|
friend class cmake;
|
|
cmStateSnapshot Reset(cmStateSnapshot const& diagnosticState);
|
|
|
|
void AddCacheEntry(std::string const& key, cmValue value,
|
|
std::string const& helpString,
|
|
cmStateEnums::CacheEntryType type);
|
|
|
|
bool DoWriteGlobVerifyTarget() const;
|
|
std::string const& GetGlobVerifyScript() const;
|
|
std::string const& GetGlobVerifyStamp() const;
|
|
bool SaveVerificationScript(std::string const& path, cmMessenger* messenger);
|
|
void AddGlobCacheEntry(cmGlobCacheEntry const& entry,
|
|
std::string const& variable,
|
|
cmListFileBacktrace const& bt,
|
|
cmMessenger* messenger);
|
|
std::vector<cmGlobCacheEntry> GetGlobCacheEntries() const;
|
|
|
|
cmPropertyDefinitionMap PropertyDefinitions;
|
|
std::vector<std::string> EnabledLanguages;
|
|
std::unordered_map<std::string, Command> BuiltinCommands;
|
|
std::unordered_map<std::string, Command> ScriptedCommands;
|
|
std::unordered_set<std::string> FlowControlCommands;
|
|
cmPropertyMap GlobalProperties;
|
|
std::unique_ptr<cmCacheManager> CacheManager;
|
|
std::unique_ptr<cmGlobVerificationManager> GlobVerificationManager;
|
|
|
|
cmLinkedTree<cmStateDetail::BuildsystemDirectoryStateType>
|
|
BuildsystemDirectory;
|
|
|
|
cmLinkedTree<std::string> ExecutionListFiles;
|
|
|
|
cmLinkedTree<cmStateDetail::DiagnosticStackEntry> DiagnosticStack;
|
|
cmLinkedTree<cmStateDetail::PolicyStackEntry> PolicyStack;
|
|
cmLinkedTree<cmStateDetail::SnapshotDataType> SnapshotData;
|
|
cmLinkedTree<cmDefinitions> VarTree;
|
|
|
|
std::string SourceDirectory;
|
|
std::string BinaryDirectory;
|
|
bool IsGeneratorMultiConfig = false;
|
|
bool WindowsShell = false;
|
|
bool WindowsVSIDE = false;
|
|
bool GhsMultiIDE = false;
|
|
bool BorlandMake = false;
|
|
bool WatcomWMake = false;
|
|
bool MinGWMake = false;
|
|
bool NMake = false;
|
|
bool MSYSShell = false;
|
|
bool Ninja = false;
|
|
bool NinjaMulti = false;
|
|
bool FastbuildMake = false;
|
|
Role StateRole = Role::Internal;
|
|
TryCompile IsTryCompile = TryCompile::No;
|
|
cm::optional<cmDependencyProvider> DependencyProvider;
|
|
bool ProcessingTopLevelIncludes = false;
|
|
};
|