CMake/Source/cmVariableWatch.h
Kitware Robot 0b96ae1f6a Revise C++ coding style using clang-format with "east const"
Run the `clang-format.bash` script to update all our C and C++ code to a
new style defined by `.clang-format`, now with "east const" enforcement.
Use `clang-format` version 18.

* If you reached this commit for a line in `git blame`, re-run the blame
  operation starting at the parent of this commit to see older history
  for the content.

* See the parent commit for instructions to rebase a change across this
  style transition commit.

Issue: #26123
2025-01-23 13:09:50 -05:00

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 (*)(std::string const&, int, void*, char const*,
cmMakefile const*);
using DeleteData = void (*)(void*);
cmVariableWatch();
~cmVariableWatch();
/**
* Add watch to the variable
*/
bool AddWatch(std::string const& variable, WatchMethod method,
void* client_data = nullptr, DeleteData delete_data = nullptr);
void RemoveWatch(std::string const& variable, WatchMethod method,
void* client_data = nullptr);
/**
* This method is called when variable is accessed
*/
bool VariableAccessed(std::string const& variable, int access_type,
char const* newValue, cmMakefile const* 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 std::string const& 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(Pair const&) = delete;
Pair& operator=(Pair const&) = delete;
};
using VectorOfPairs = std::vector<std::shared_ptr<Pair>>;
using StringToVectorOfPairs = std::map<std::string, VectorOfPairs>;
StringToVectorOfPairs WatchMap;
};