CMake/Source/cmVariableWatchCommand.h

90 lines
2.5 KiB
C
Raw Normal View History

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
2007-04-11 23:13:05 +04:00
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
2007-04-11 23:13:05 +04: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.
============================================================================*/
2007-04-11 23:13:05 +04:00
#ifndef cmVariableWatchCommand_h
#define cmVariableWatchCommand_h
#include "cmCommand.h"
/** \class cmVariableWatchCommand
* \brief Watch when the variable changes and invoke command
*
*/
class cmVariableWatchCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
2007-04-11 23:13:05 +04:00
{
return new cmVariableWatchCommand;
}
//! Default constructor
cmVariableWatchCommand();
//! Destructor.
~cmVariableWatchCommand();
2007-04-11 23:13:05 +04:00
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args,
cmExecutionStatus &status);
2007-04-11 23:13:05 +04:00
/**
* This determines if the command is invoked when in script mode.
*/
virtual bool IsScriptable() const { return true; }
2007-04-11 23:13:05 +04:00
/** This command does not really have a final pass but it needs to
stay alive since it owns variable watch callback information. */
virtual bool HasFinalPass() const { return true; }
2007-04-11 23:13:05 +04:00
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() const { return "variable_watch";}
2007-04-11 23:13:05 +04:00
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation() const
2007-04-11 23:13:05 +04:00
{
return "Watch the CMake variable for change.";
}
2007-04-11 23:13:05 +04:00
/**
* More documentation.
*/
virtual const char* GetFullDocumentation() const
2007-04-11 23:13:05 +04:00
{
return
" variable_watch(<variable name> [<command to execute>])\n"
2007-04-11 23:13:05 +04:00
"If the specified variable changes, the message will be printed about "
2008-01-10 06:09:19 +03:00
"the variable being changed. If the command is specified, the command "
2007-04-11 23:13:05 +04:00
"will be executed. The command will receive the following arguments:"
" COMMAND(<variable> <access> <value> <current list file> <stack>)";
}
2007-04-11 23:13:05 +04:00
cmTypeMacro(cmVariableWatchCommand, cmCommand);
protected:
std::set<std::string> WatchedVariables;
2007-04-11 23:13:05 +04:00
};
#endif