CMake/Source/cmFindFileCommand.h

57 lines
1.5 KiB
C++

/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
Module: $RCSfile$
Language: C++
Date: $Date$
Version: $Revision$
Copyright (c) 2002 Kitware, Inc., Insight Consortium. All rights reserved.
See Copyright.txt or http://www.cmake.org/HTML/Copyright.html 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 "cmFindPathCommand.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 cmFindPathCommand
{
public:
cmFindFileCommand();
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmFindFileCommand;
}
virtual const char* GetName() { return "FIND_FILE";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Find the full path to a file.";
}
cmTypeMacro(cmFindFileCommand, cmFindPathCommand);
};
#endif