CMake/Source/cmFindIncludeRule.h

84 lines
1.8 KiB
C
Raw Normal View History

/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2000 National Library of Medicine
All rights reserved.
See COPYRIGHT.txt for copyright details.
=========================================================================*/
#ifndef cmFindIncludeRule_h
#define cmFindIncludeRule_h
#include "cmStandardIncludes.h"
#include "cmRuleMaker.h"
/** \class cmFindIncludeRule
* \brief Define a rule that searches for an include file.
*
2001-01-11 16:04:28 +03:00
* cmFindIncludeRule is used to define a CMake variable include
* path location by specifying a file and list of directories.
*/
class cmFindIncludeRule : public cmRuleMaker
{
public:
/**
* This is a virtual constructor for the rule.
*/
virtual cmRuleMaker* Clone()
{
return new cmFindIncludeRule;
}
/**
* This is called when the rule is first encountered in
* the CMakeLists.txt file.
*/
virtual bool Invoke(std::vector<std::string>& args);
/**
* This is called at the end after all the information
* specified by the rules is accumulated.
*/
virtual void FinalPass() { }
/**
* This determines if the rule gets propagated down
* to makefiles located in subdirectories.
*/
virtual bool IsInherited()
{return true;}
/**
* The name of the rule as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "FIND_INCLUDE";}
/**
* Succinct documentation.
*/
virtual const char* TerseDocumentation()
{
return "Find an include path.";
}
/**
* More documentation.
*/
virtual const char* FullDocumentation()
{
return
2001-01-11 16:04:28 +03:00
"FIND_INCLUDE(DEFINE try1 try2 ...)";
}
};
#endif