CMake/Source/cmVariableWatch.h

99 lines
2.5 KiB
C
Raw Normal View History

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
2003-01-08 20:59:52 +03:00
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
2003-01-08 20:59:52 +03:00
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.
============================================================================*/
2003-01-08 20:59:52 +03:00
#ifndef cmVariableWatch_h
#define cmVariableWatch_h
#include <cmConfigure.h> // IWYU pragma: keep
#include <map>
#include <string>
#include <vector>
2003-01-08 20:59:52 +03:00
2007-04-11 23:13:05 +04:00
class cmMakefile;
2003-01-08 20:59:52 +03:00
/** \class cmVariableWatch
* \brief Helper class for watching of variable accesses.
*
* Calls function when variable is accessed
*/
class cmVariableWatch
{
public:
2006-03-10 19:13:15 +03:00
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);
2003-01-08 20:59:52 +03:00
cmVariableWatch();
~cmVariableWatch();
/**
* Add watch to the variable
*/
bool AddWatch(const std::string& variable, WatchMethod method,
2016-06-27 23:44:16 +03:00
void* client_data = CM_NULLPTR,
DeleteData delete_data = CM_NULLPTR);
void RemoveWatch(const std::string& variable, WatchMethod method,
2016-06-27 23:44:16 +03:00
void* client_data = CM_NULLPTR);
2003-01-08 20:59:52 +03:00
/**
* This method is called when variable is accessed
*/
bool VariableAccessed(const std::string& variable, int access_type,
const char* newValue, const cmMakefile* mf) const;
2003-01-08 20:59:52 +03:00
/**
* Different access types.
*/
enum
{
2007-04-11 23:13:05 +04:00
VARIABLE_READ_ACCESS = 0,
UNKNOWN_VARIABLE_READ_ACCESS,
UNKNOWN_VARIABLE_DEFINED_ACCESS,
2007-04-11 23:13:05 +04:00
VARIABLE_MODIFIED_ACCESS,
VARIABLE_REMOVED_ACCESS,
NO_ACCESS
};
2007-04-11 23:13:05 +04:00
/**
* Return the access as string
*/
static const char* GetAccessAsString(int access_type);
2003-01-08 20:59:52 +03:00
protected:
struct Pair
{
2006-03-15 19:02:08 +03:00
WatchMethod Method;
void* ClientData;
DeleteData DeleteDataCall;
Pair()
2016-06-27 23:44:16 +03:00
: Method(CM_NULLPTR)
, ClientData(CM_NULLPTR)
, DeleteDataCall(CM_NULLPTR)
{
}
~Pair()
{
if (this->DeleteDataCall && this->ClientData) {
this->DeleteDataCall(this->ClientData);
}
}
2003-01-08 20:59:52 +03:00
};
typedef std::vector<Pair*> VectorOfPairs;
typedef std::map<std::string, VectorOfPairs> StringToVectorOfPairs;
2003-01-08 20:59:52 +03:00
2006-03-15 19:02:08 +03:00
StringToVectorOfPairs WatchMap;
2003-01-08 20:59:52 +03:00
};
#endif