CMake/Source/cmFindPathCommand.h

82 lines
1.8 KiB
C
Raw Normal View History

2001-04-26 17:38:31 +04:00
/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2000 National Path of Medicine
All rights reserved.
See COPYRIGHT.txt for copyright details.
=========================================================================*/
#ifndef cmFindPathCommand_h
#define cmFindPathCommand_h
#include "cmStandardIncludes.h"
#include "cmCommand.h"
/** \class cmFindPathCommand
* \brief Define a command to search for a library.
*
* cmFindPathCommand is used to define a CMake variable
* that specifies a library. The command searches for a given
* file in a list of directories.
*/
class cmFindPathCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmFindPathCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args);
2001-04-26 17:38:31 +04:00
/**
* 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_PATH";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Find a path for a file.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
"FIND_PATH(PATH_DEFINE fileName path1 path2 path3...)\n"
"If the file is found, then PATH_DEFINE is set to the path where it was found";
}
cmTypeMacro(cmFindPathCommand, cmCommand);
};
#endif