1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
|
/*============================================================================
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 cmVariableWatch_h
#define cmVariableWatch_h
#include <cmConfigure.h> // IWYU pragma: keep
#include <map>
#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:
typedef void (*WatchMethod)(const std::string& variable, int access_type,
void* client_data, const char* newValue,
const cmMakefile* mf);
typedef void (*DeleteData)(void* client_data);
cmVariableWatch();
~cmVariableWatch();
/**
* Add watch to the variable
*/
bool AddWatch(const std::string& variable, WatchMethod method,
void* client_data = CM_NULLPTR,
DeleteData delete_data = CM_NULLPTR);
void RemoveWatch(const std::string& variable, WatchMethod method,
void* client_data = CM_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 = 0,
UNKNOWN_VARIABLE_READ_ACCESS,
UNKNOWN_VARIABLE_DEFINED_ACCESS,
VARIABLE_MODIFIED_ACCESS,
VARIABLE_REMOVED_ACCESS,
NO_ACCESS
};
/**
* Return the access as string
*/
static const char* GetAccessAsString(int access_type);
protected:
struct Pair
{
WatchMethod Method;
void* ClientData;
DeleteData DeleteDataCall;
Pair()
: Method(CM_NULLPTR)
, ClientData(CM_NULLPTR)
, DeleteDataCall(CM_NULLPTR)
{
}
~Pair()
{
if (this->DeleteDataCall && this->ClientData) {
this->DeleteDataCall(this->ClientData);
}
}
};
typedef std::vector<Pair*> VectorOfPairs;
typedef std::map<std::string, VectorOfPairs> StringToVectorOfPairs;
StringToVectorOfPairs WatchMap;
};
#endif
|
