mirror of
https://github.com/Kitware/CMake.git
synced 2025-05-09 14:57:08 +08:00
bdca8b01d2
#pragma once is a widely supported compiler pragma, even though it is not part of the C++ standard. Many of the issues keeping #pragma once from being standardized (distributed filesystems, build farms, hard links, etc.) do not apply to CMake - it is easy to build CMake on a single machine. CMake also does not install any header files which can be consumed by other projects (though cmCPluginAPI.h has been deliberately omitted from this conversion in case anyone is still using it.) Finally, #pragma once has been required to build CMake since at least August 2017 (7f29bbe6 enabled server mode unconditionally, which had been using #pragma once since September 2016 (b13d3e0d)). The fact that we now require C++11 filters out old compilers, and it is unlikely that there is a compiler which supports C++11 but does not support #pragma once.
83 lines
2.0 KiB
C++
83 lines
2.0 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#pragma once
|
|
|
|
#include "cmConfigure.h" // IWYU pragma: keep
|
|
|
|
#include <map>
|
|
#include <memory>
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
class cmMakefile;
|
|
|
|
/** \class cmVariableWatch
|
|
* \brief Helper class for watching of variable accesses.
|
|
*
|
|
* Calls function when variable is accessed
|
|
*/
|
|
class cmVariableWatch
|
|
{
|
|
public:
|
|
using WatchMethod = void (*)(const std::string&, int, void*, const char*,
|
|
const cmMakefile*);
|
|
using DeleteData = void (*)(void*);
|
|
|
|
cmVariableWatch();
|
|
~cmVariableWatch();
|
|
|
|
/**
|
|
* Add watch to the variable
|
|
*/
|
|
bool AddWatch(const std::string& variable, WatchMethod method,
|
|
void* client_data = nullptr, DeleteData delete_data = nullptr);
|
|
void RemoveWatch(const std::string& variable, WatchMethod method,
|
|
void* client_data = nullptr);
|
|
|
|
/**
|
|
* This method is called when variable is accessed
|
|
*/
|
|
bool VariableAccessed(const std::string& variable, int access_type,
|
|
const char* newValue, const cmMakefile* mf) const;
|
|
|
|
/**
|
|
* Different access types.
|
|
*/
|
|
enum
|
|
{
|
|
VARIABLE_READ_ACCESS,
|
|
UNKNOWN_VARIABLE_READ_ACCESS,
|
|
UNKNOWN_VARIABLE_DEFINED_ACCESS,
|
|
VARIABLE_MODIFIED_ACCESS,
|
|
VARIABLE_REMOVED_ACCESS,
|
|
NO_ACCESS
|
|
};
|
|
|
|
/**
|
|
* Return the access as string
|
|
*/
|
|
static const std::string& GetAccessAsString(int access_type);
|
|
|
|
protected:
|
|
struct Pair
|
|
{
|
|
WatchMethod Method = nullptr;
|
|
void* ClientData = nullptr;
|
|
DeleteData DeleteDataCall = nullptr;
|
|
~Pair()
|
|
{
|
|
if (this->DeleteDataCall && this->ClientData) {
|
|
this->DeleteDataCall(this->ClientData);
|
|
}
|
|
}
|
|
Pair() = default;
|
|
Pair(const Pair&) = delete;
|
|
Pair& operator=(const Pair&) = delete;
|
|
};
|
|
|
|
using VectorOfPairs = std::vector<std::shared_ptr<Pair>>;
|
|
using StringToVectorOfPairs = std::map<std::string, VectorOfPairs>;
|
|
|
|
StringToVectorOfPairs WatchMap;
|
|
};
|