Source/cmFunctionBlocker.h

   1 /*=========================================================================
   2
   3   Program:   Insight Segmentation & Registration Toolkit
   4   Module:    $RCSfile: cmFunctionBlocker.h,v $
   5   Language:  C++
   6   Date:      $Date: 2002-06-18 21:20:27 $
   7   Version:   $Revision: 1.8 $
   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 cmFunctionBlocker_h
  18 #define cmFunctionBlocker_h
  19
  20 #include "cmStandardIncludes.h"
  21 class cmMakefile;
  22
  23 /** \class cmFunctionBlocker
  24  * \brief A class that defines an interface for blocking cmake functions
  25  *
  26  * This is the superclass for any classes that need to block a cmake function
  27  */
  28 class cmFunctionBlocker
  29 {
  30 public:
  31   /**
  32    * should a function be blocked
  33    */
  34   virtual bool IsFunctionBlocked(const char *name, const std::vector<std::string> &args,
  35                                  cmMakefile&mf) = 0;
  36
  37   /**
  38    * should this function blocker be removed, useful when one function adds a
  39    * blocker and another must remove it
  40    */
  41   virtual bool ShouldRemove(const char *,
  42                             const std::vector<std::string>&,
  43                             cmMakefile&) {return false;}
  44
  45   /**
  46    * When the end of a CMakeList file is reached this method is called.  It
  47    * is not called on the end of an INCLUDE cmake file, just at the end of a
  48    * regular CMakeList file
  49    */
  50   virtual void ScopeEnded(cmMakefile&) {}
  51
  52   virtual ~cmFunctionBlocker() {}
  53
  54   virtual int NeedExpandedVariables () { return 1; };
  55 };
  56
  57 #endif