summaryrefslogtreecommitdiff
path: root/Source/cmEndWhileCommand.h
diff options
context:
space:
mode:
Diffstat (limited to 'Source/cmEndWhileCommand.h')
-rw-r--r--Source/cmEndWhileCommand.h79
1 files changed, 79 insertions, 0 deletions
diff --git a/Source/cmEndWhileCommand.h b/Source/cmEndWhileCommand.h
new file mode 100644
index 000000000..635ad5a7f
--- /dev/null
+++ b/Source/cmEndWhileCommand.h
@@ -0,0 +1,79 @@
+/*============================================================================
+ 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 cmEndWhileCommand_h
+#define cmEndWhileCommand_h
+
+#include "cmCommand.h"
+
+/** \class cmEndWhileCommand
+ * \brief ends a while loop
+ *
+ * cmEndWhileCommand ends a while loop
+ */
+class cmEndWhileCommand : public cmCommand
+{
+public:
+ /**
+ * This is a virtual constructor for the command.
+ */
+ virtual cmCommand* Clone()
+ {
+ return new cmEndWhileCommand;
+ }
+
+ /**
+ * Override cmCommand::InvokeInitialPass to get arguments before
+ * expansion.
+ */
+ virtual bool InvokeInitialPass(std::vector<cmListFileArgument> const& args,
+ cmExecutionStatus &status);
+
+ /**
+ * 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 "endwhile";}
+
+ /**
+ * Succinct documentation.
+ */
+ virtual const char* GetTerseDocumentation() const
+ {
+ return "Ends a list of commands in a while block.";
+ }
+
+ /**
+ * More documentation.
+ */
+ virtual const char* GetFullDocumentation() const
+ {
+ return
+ " endwhile(expression)\n"
+ "See the while command.";
+ }
+
+ cmTypeMacro(cmEndWhileCommand, cmCommand);
+};
+
+
+#endif