Source/cmWhileCommand.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmWhileCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2008-01-23 15:27:59 $
   7   Version:   $Revision: 1.9 $
   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 cmWhileCommand_h
  18 #define cmWhileCommand_h
  19
  20 #include "cmCommand.h"
  21 #include "cmFunctionBlocker.h"
  22 #include "cmListFileCache.h"
  23
  24 /** \class cmWhileFunctionBlocker
  25  * \brief subclass of function blocker
  26  *
  27  *
  28  */
  29 class cmWhileFunctionBlocker : public cmFunctionBlocker
  30 {
  31 public:
  32   cmWhileFunctionBlocker() {Executing = false; Depth=0;}
  33   virtual ~cmWhileFunctionBlocker() {}
  34   virtual bool IsFunctionBlocked(const cmListFileFunction& lff,
  35                                  cmMakefile &mf,
  36                                  cmExecutionStatus &);
  37   virtual bool ShouldRemove(const cmListFileFunction& lff, cmMakefile &mf);
  38   virtual void ScopeEnded(cmMakefile &mf);
  39
  40   std::vector<cmListFileArgument> Args;
  41   std::vector<cmListFileFunction> Functions;
  42   bool Executing;
  43 private:
  44   int Depth;
  45 };
  46
  47 /** \class cmWhileCommand
  48  * \brief starts a while loop
  49  *
  50  * cmWhileCommand starts a while loop
  51  */
  52 class cmWhileCommand : public cmCommand
  53 {
  54 public:
  55   /**
  56    * This is a virtual constructor for the command.
  57    */
  58   virtual cmCommand* Clone()
  59     {
  60     return new cmWhileCommand;
  61     }
  62
  63   /**
  64    * This overrides the default InvokeInitialPass implementation.
  65    * It records the arguments before expansion.
  66    */
  67   virtual bool InvokeInitialPass(const std::vector<cmListFileArgument>& args,
  68                                  cmExecutionStatus &);
  69
  70   /**
  71    * This is called when the command is first encountered in
  72    * the CMakeLists.txt file.
  73    */
  74   virtual bool InitialPass(std::vector<std::string> const&,
  75                            cmExecutionStatus &) { return false; }
  76
  77   /**
  78    * This determines if the command is invoked when in script mode.
  79    */
  80   virtual bool IsScriptable() { return true; }
  81
  82   /**
  83    * The name of the command as specified in CMakeList.txt.
  84    */
  85   virtual const char* GetName() { return "while";}
  86
  87   /**
  88    * Succinct documentation.
  89    */
  90   virtual const char* GetTerseDocumentation()
  91     {
  92     return "Evaluate a group of commands while a condition is true";
  93     }
  94
  95   /**
  96    * More documentation.
  97    */
  98   virtual const char* GetFullDocumentation()
  99     {
 100     return
 101       "  while(condition)\n"
 102       "    COMMAND1(ARGS ...)\n"
 103       "    COMMAND2(ARGS ...)\n"
 104       "    ...\n"
 105       "  endwhile(condition)\n"
 106       "All commands between while and the matching endwhile are recorded "
 107       "without being invoked.  Once the endwhile is evaluated, the "
 108       "recorded list of commands is invoked as long as the condition "
 109       "is true. The condition is evaluated using the same logic as the "
 110       "if command.";
 111     }
 112
 113   cmTypeMacro(cmWhileCommand, cmCommand);
 114 };
 115
 116
 117 #endif