Source/cmEndWhileCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmEndWhileCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-01-23 15:27:59 $
   7   Version:   $Revision: 1.6 $
   8
   9   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  10   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  11
  12      This software is distributed WITHOUT ANY WARRANTY; without even
  13      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  14      PURPOSE.  See the above copyright notices for more information.
  15
  16 =========================================================================*/
  17 #ifndef cmEndWhileCommand_h
  18 #define cmEndWhileCommand_h
  19
  20 #include "cmCommand.h"
  21
  22 /** \class cmEndWhileCommand
  23  * \brief ends a while loop
  24  *
  25  * cmEndWhileCommand ends a while loop
  26  */
  27 class cmEndWhileCommand : public cmCommand
  28 {
  29 public:
  30   /**
  31    * This is a virtual constructor for the command.
  32    */
  33   virtual cmCommand* Clone()
  34     {
  35     return new cmEndWhileCommand;
  36     }
  37
  38   /**
  39    * Override cmCommand::InvokeInitialPass to get arguments before
  40    * expansion.
  41    */
  42   virtual bool InvokeInitialPass(std::vector<cmListFileArgument> const&,
  43                                  cmExecutionStatus &status);
  44
  45   /**
  46    * This is called when the command is first encountered in
  47    * the CMakeLists.txt file.
  48    */
  49   virtual bool InitialPass(std::vector<std::string> const&,
  50                            cmExecutionStatus &) {return false;}
  51
  52   /**
  53    * This determines if the command is invoked when in script mode.
  54    */
  55   virtual bool IsScriptable() { return true; }
  56
  57   /**
  58    * The name of the command as specified in CMakeList.txt.
  59    */
  60   virtual const char* GetName() { return "endwhile";}
  61
  62   /**
  63    * Succinct documentation.
  64    */
  65   virtual const char* GetTerseDocumentation()
  66     {
  67     return "Ends a list of commands in a while block.";
  68     }
  69
  70   /**
  71    * More documentation.
  72    */
  73   virtual const char* GetFullDocumentation()
  74     {
  75     return
  76       "  endwhile(expression)\n"
  77       "See the while command.";
  78     }
  79
  80   cmTypeMacro(cmEndWhileCommand, cmCommand);
  81 };
  82
  83
  84 #endif