CMakeLua/Source/cmFunctionBlocker.h

   1 /*=========================================================================
   2
   3   Program:   CMake - Cross-Platform Makefile Generator
   4   Module:    $RCSfile: cmFunctionBlocker.h,v $
   5   Language:  C++
   6 <<<<<<< cmFunctionBlocker.h
   7   Date:      $Date: 2008/01/23 15:27:59 $
   8   Version:   $Revision: 1.12 $
   9 =======
  10   Date:      $Date: 2009-01-21 14:48:16 $
  11   Version:   $Revision: 1.13 $
  12 >>>>>>> 1.13
  13
  14   Copyright (c) 2002 Kitware, Inc., Insight Consortium.  All rights reserved.
  15   See Copyright.txt or http://www.cmake.org/HTML/Copyright.html for details.
  16
  17      This software is distributed WITHOUT ANY WARRANTY; without even
  18      the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  19      PURPOSE.  See the above copyright notices for more information.
  20
  21 =========================================================================*/
  22 #ifndef cmFunctionBlocker_h
  23 #define cmFunctionBlocker_h
  24
  25 #include "cmStandardIncludes.h"
  26 #include "cmExecutionStatus.h"
  27 #include "cmListFileCache.h"
  28 class cmMakefile;
  29
  30 /** \class cmFunctionBlocker
  31  * \brief A class that defines an interface for blocking cmake functions
  32  *
  33  * This is the superclass for any classes that need to block a cmake function
  34  */
  35 class cmFunctionBlocker
  36 {
  37 public:
  38   /**
  39    * should a function be blocked
  40    */
  41   virtual bool IsFunctionBlocked(const cmListFileFunction& lff,
  42                                  cmMakefile&mf,
  43                                  cmExecutionStatus &status) = 0;
  44
  45   /**
  46    * should this function blocker be removed, useful when one function adds a
  47    * blocker and another must remove it
  48    */
  49   virtual bool ShouldRemove(const cmListFileFunction&,
  50                             cmMakefile&) {return false;}
  51
  52   virtual ~cmFunctionBlocker() {}
  53
  54   /** Set/Get the context in which this blocker is created.  */
  55   void SetStartingContext(cmListFileContext const& lfc)
  56     { this->StartingContext = lfc; }
  57   cmListFileContext const& GetStartingContext()
  58     { return this->StartingContext; }
  59 private:
  60   cmListFileContext StartingContext;
  61 };
  62
  63 #endif