CMake/Source/cmFunctionBlocker.h

54 lines
1.7 KiB
C
Raw Normal View History

/*============================================================================
CMake - Cross Platform Makefile Generator
Copyright 2000-2009 Kitware, Inc., Insight Software Consortium
2001-04-20 01:39:03 +04:00
Distributed under the OSI-approved BSD License (the "License");
see accompanying file Copyright.txt for details.
2001-04-20 01:39:03 +04:00
This software is distributed WITHOUT ANY WARRANTY; without even the
implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
See the License for more information.
============================================================================*/
2001-04-20 01:39:03 +04:00
#ifndef cmFunctionBlocker_h
#define cmFunctionBlocker_h
#include "cmStandardIncludes.h"
#include "cmExecutionStatus.h"
#include "cmListFileCache.h"
2001-04-20 01:39:03 +04:00
class cmMakefile;
/** \class cmFunctionBlocker
* \brief A class that defines an interface for blocking cmake functions
*
* This is the superclass for any classes that need to block a cmake function
*/
class cmFunctionBlocker
{
public:
/**
* should a function be blocked
*/
virtual bool IsFunctionBlocked(const cmListFileFunction& lff,
cmMakefile&mf,
cmExecutionStatus &status) = 0;
2001-04-20 01:39:03 +04:00
/**
2001-05-04 16:46:05 +04:00
* should this function blocker be removed, useful when one function adds a
* blocker and another must remove it
2001-04-20 01:39:03 +04:00
*/
2002-12-13 17:18:01 +03:00
virtual bool ShouldRemove(const cmListFileFunction&,
2002-06-19 01:20:27 +04:00
cmMakefile&) {return false;}
2001-05-04 16:46:05 +04:00
2001-06-04 18:18:03 +04:00
virtual ~cmFunctionBlocker() {}
/** Set/Get the context in which this blocker is created. */
void SetStartingContext(cmListFileContext const& lfc)
{ this->StartingContext = lfc; }
cmListFileContext const& GetStartingContext()
{ return this->StartingContext; }
private:
cmListFileContext StartingContext;
2001-04-20 01:39:03 +04:00
};
#endif