diff options
Diffstat (limited to 'Source/cmWhileCommand.h')
-rw-r--r-- | Source/cmWhileCommand.h | 101 |
1 files changed, 101 insertions, 0 deletions
diff --git a/Source/cmWhileCommand.h b/Source/cmWhileCommand.h new file mode 100644 index 000000000..e111ae40d --- /dev/null +++ b/Source/cmWhileCommand.h @@ -0,0 +1,101 @@ +/*============================================================================ + 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 cmWhileCommand_h +#define cmWhileCommand_h + +#include "cmCommand.h" +#include "cmFunctionBlocker.h" +#include "cmListFileCache.h" + +class cmWhileFunctionBlocker : public cmFunctionBlocker +{ +public: + cmWhileFunctionBlocker() {this->Depth=0;} + virtual ~cmWhileFunctionBlocker() {} + virtual bool IsFunctionBlocked(const cmListFileFunction& lff, + cmMakefile &mf, + cmExecutionStatus &); + virtual bool ShouldRemove(const cmListFileFunction& lff, cmMakefile &mf); + + std::vector<cmListFileArgument> Args; + std::vector<cmListFileFunction> Functions; +private: + int Depth; +}; + +/// \brief Starts a while loop +class cmWhileCommand : public cmCommand +{ +public: + /** + * This is a virtual constructor for the command. + */ + virtual cmCommand* Clone() + { + return new cmWhileCommand; + } + + /** + * This overrides the default InvokeInitialPass implementation. + * It records the arguments before expansion. + */ + virtual bool InvokeInitialPass(const std::vector<cmListFileArgument>& args, + cmExecutionStatus &); + + /** + * This is called when the command is first encountered in + * the CMakeLists.txt file. + */ + virtual bool InitialPass(std::vector<std::string> const&, + cmExecutionStatus &) { return false; } + + /** + * This determines if the command is invoked when in script mode. + */ + virtual bool IsScriptable() const { return true; } + + /** + * The name of the command as specified in CMakeList.txt. + */ + virtual const char* GetName() const { return "while";} + + /** + * Succinct documentation. + */ + virtual const char* GetTerseDocumentation() const + { + return "Evaluate a group of commands while a condition is true"; + } + + /** + * More documentation. + */ + virtual const char* GetFullDocumentation() const + { + return + " while(condition)\n" + " COMMAND1(ARGS ...)\n" + " COMMAND2(ARGS ...)\n" + " ...\n" + " endwhile(condition)\n" + "All commands between while and the matching endwhile are recorded " + "without being invoked. Once the endwhile is evaluated, the " + "recorded list of commands is invoked as long as the condition " + "is true. The condition is evaluated using the same logic as the " + "if command."; + } + + cmTypeMacro(cmWhileCommand, cmCommand); +}; + + +#endif |