CMake/Source/cmFindIncludeCommand.h
2001-04-26 09:38:31 -04:00

82 lines
1.9 KiB
C++

/*=========================================================================
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 cmFindIncludeCommand_h
#define cmFindIncludeCommand_h
#include "cmStandardIncludes.h"
#include "cmCommand.h"
/** \class cmFindIncludeCommand
* \brief Define a command that searches for an include file.
*
* cmFindIncludeCommand is used to define a CMake variable include
* path location by specifying a file and list of directories.
*/
class cmFindIncludeCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmFindIncludeCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool Invoke(std::vector<std::string>& args);
/**
* This determines if the command gets propagated down
* to makefiles located in subdirectories.
*/
virtual bool IsInherited()
{return true;}
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "FIND_INCLUDE";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Find an include path for a given header file.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
"FIND_INCLUDE(DEFINE_PATH DEFINE_INCLUDE includeName extraPath1 extraPath2 ...)\n"
"If the include file is found, then DEFINE_PATH is set to the path\n"
"where it was found and DEFINE_NAME is set to includeName";
}
cmTypeMacro(cmFindIncludeCommand, cmCommand);
};
#endif