diff options
author | Andy Cedilnik <andy.cedilnik@kitware.com> | 2007-04-11 19:13:05 (GMT) |
---|---|---|
committer | Andy Cedilnik <andy.cedilnik@kitware.com> | 2007-04-11 19:13:05 (GMT) |
commit | f9f1ccadb370b7b3466d491b1824104d81a15308 (patch) | |
tree | 8428b8e66ce907c5befa5b86fa3fb6773722e8c4 /Source/cmVariableWatchCommand.h | |
parent | 76e5344590f6259fcfc73d35e286509f9e260678 (diff) | |
download | CMake-f9f1ccadb370b7b3466d491b1824104d81a15308.zip CMake-f9f1ccadb370b7b3466d491b1824104d81a15308.tar.gz CMake-f9f1ccadb370b7b3466d491b1824104d81a15308.tar.bz2 |
ENH: Add variable watch command
Diffstat (limited to 'Source/cmVariableWatchCommand.h')
-rw-r--r-- | Source/cmVariableWatchCommand.h | 98 |
1 files changed, 98 insertions, 0 deletions
diff --git a/Source/cmVariableWatchCommand.h b/Source/cmVariableWatchCommand.h new file mode 100644 index 0000000..244aea9 --- /dev/null +++ b/Source/cmVariableWatchCommand.h @@ -0,0 +1,98 @@ +/*========================================================================= + + Program: CMake - Cross-Platform Makefile Generator + Module: $RCSfile$ + Language: C++ + Date: $Date$ + Version: $Revision$ + + Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved. + See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details. + + This software is distributed WITHOUT ANY WARRANTY; without even + the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR + PURPOSE. See the above copyright notices for more information. + +=========================================================================*/ +#ifndef cmVariableWatchCommand_h +#define cmVariableWatchCommand_h + +#include "cmCommand.h" + +class cmVariableWatchCommandHandler +{ +public: + typedef std::vector<std::string> VectorOfCommands; + VectorOfCommands Commands; +}; + +/** \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() + { + return new cmVariableWatchCommand; + } + + //! Default constructor + cmVariableWatchCommand(); + + /** + * This is called when the command is first encountered in + * the CMakeLists.txt file. + */ + virtual bool InitialPass(std::vector<std::string> const& args); + + /** + * This determines if the command is invoked when in script mode. + */ + virtual bool IsScriptable() { return true; } + + /** + * The name of the command as specified in CMakeList.txt. + */ + virtual const char* GetName() { return "VARIABLE_WATCH";} + + /** + * Succinct documentation. + */ + virtual const char* GetTerseDocumentation() + { + return "Watch the CMake variable for change."; + } + + /** + * More documentation. + */ + virtual const char* GetFullDocumentation() + { + return + " VARIABLE_WATCH(<variable name> [<command to execute>])\n" + "If the specified variable changes, the message will be printed about " + "the variable being changed. If the command is spceified, the command " + "will be executed. The command will receive the following arguments:" + " COMMAND(<variable> <access> <value> <current list file> <stack>)"; + } + + cmTypeMacro(cmVariableWatchCommand, cmCommand); + + void VariableAccessed(const std::string& variable, int access_type, + const char* newValue, const cmMakefile* mf); + +protected: + std::map<std::string, cmVariableWatchCommandHandler> Handlers; + + bool InCallback; +}; + + +#endif + + |