Source/cmForEachCommand.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmForEachCommand.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-07-17 14:48:05 $
   7   Version:   $Revision: 1.5 $
   8
   9   Copyright (c) 2002 Insight Consortium. All rights reserved.
  10   See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm 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 cmForEachCommand_h
  18 #define cmForEachCommand_h
  19
  20 #include "cmStandardIncludes.h"
  21 #include "cmCommand.h"
  22 #include "cmFunctionBlocker.h"
  23
  24 /** \class cmForEachFunctionBlocker
  25  * \brief subclass of function blocker
  26  *
  27  *
  28  */
  29 class cmForEachFunctionBlocker : public cmFunctionBlocker
  30 {
  31 public:
  32   cmForEachFunctionBlocker() {m_Executing = false;}
  33   virtual ~cmForEachFunctionBlocker() {}
  34   virtual bool IsFunctionBlocked(const char *name,
  35                                  const std::vector<std::string> &args,
  36                                  cmMakefile &mf);
  37   virtual bool ShouldRemove(const char *name,
  38                             const std::vector<std::string> &args,
  39                             cmMakefile &mf);
  40   virtual void ScopeEnded(cmMakefile &mf);
  41
  42   virtual int NeedExpandedVariables () { return 0; };
  43
  44   std::vector<std::string> m_Args;
  45   std::vector<std::string> m_Commands;
  46   std::vector<std::vector<std::string> > m_CommandArguments;
  47   bool m_Executing;
  48 };
  49
  50 /** \class cmForEachCommand
  51  * \brief starts an if block
  52  *
  53  * cmForEachCommand starts an if block
  54  */
  55 class cmForEachCommand : public cmCommand
  56 {
  57 public:
  58   /**
  59    * This is a virtual constructor for the command.
  60    */
  61   virtual cmCommand* Clone()
  62     {
  63     return new cmForEachCommand;
  64     }
  65
  66   /**
  67    * This is called when the command is first encountered in
  68    * the CMakeLists.txt file.
  69    */
  70   virtual bool InitialPass(std::vector<std::string> const& args);
  71
  72   /**
  73    * This determines if the command gets propagated down
  74    * to makefiles located in subdirectories.
  75    */
  76   virtual bool IsInherited() {return true;}
  77
  78   /**
  79    * The name of the command as specified in CMakeList.txt.
  80    */
  81   virtual const char* GetName() { return "FOREACH";}
  82
  83   /**
  84    * Succinct documentation.
  85    */
  86   virtual const char* GetTerseDocumentation()
  87     {
  88     return "start a foreach loop";
  89     }
  90
  91   /**
  92    * More documentation.
  93    */
  94   virtual const char* GetFullDocumentation()
  95     {
  96     return
  97       "FOREACH (define arg1 arg2 arg2) Starts a foreach block.";
  98     }
  99
 100   cmTypeMacro(cmForEachCommand, cmCommand);
 101 };
 102
 103
 104 #endif