CMake/Source/cmFindFileCommand.h
2002-04-11 17:02:10 -04:00

86 lines
2.4 KiB
C++

/*=========================================================================
Program: Insight Segmentation & Registration Toolkit
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2002 Insight Consortium. All rights reserved.
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notices for more information.
=========================================================================*/
#ifndef cmFindFileCommand_h
#define cmFindFileCommand_h
#include "cmStandardIncludes.h"
#include "cmCommand.h"
/** \class cmFindFileCommand
* \brief Define a command to search for an executable program.
*
* cmFindFileCommand is used to define a CMake variable
* that specifies an executable program. The command searches
* in the current path (e.g., PATH environment variable) for
* an executable that matches one of the supplied names.
*/
class cmFindFileCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmFindFileCommand;
}
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args);
/**
* This determines if the command gets propagated down
* to makefiles located in subdirectories.
*/
virtual bool IsInherited() { return false; }
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() { return "FIND_FILE";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Find a file.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
"FIND_FILE(NAME file extrapath extrapath ... [DOC docstring])"
"Find a file in the system PATH or in any extra paths specified in the command."
"A cache entry called NAME is created to store the result. NOTFOUND is the value"
" used if the file was not found. If DOC is specified the next argument is the "
"documentation string for the cache entry NAME.";
}
cmTypeMacro(cmFindFileCommand, cmCommand);
};
#endif