CMake/Source/cmFindProgramCommand.h

88 lines
2.7 KiB
C
Raw Normal View History

2001-01-11 16:04:28 +03:00
/*=========================================================================
Program: CMake - Cross-Platform Makefile Generator
2001-01-11 16:04:28 +03:00
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.
2001-01-11 16:04:28 +03:00
2002-01-21 23:30:43 +03:00
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.
2001-01-11 16:04:28 +03:00
=========================================================================*/
2001-01-18 19:20:24 +03:00
#ifndef cmFindProgramCommand_h
#define cmFindProgramCommand_h
#include "cmStandardIncludes.h"
2001-01-18 19:20:24 +03:00
#include "cmCommand.h"
2001-01-18 19:20:24 +03:00
/** \class cmFindProgramCommand
* \brief Define a command to search for an executable program.
2001-01-11 16:04:28 +03:00
*
2001-01-18 19:20:24 +03:00
* cmFindProgramCommand is used to define a CMake variable
* that specifies an executable program. The command searches
2001-01-11 22:47:38 +03:00
* in the current path (e.g., PATH environment variable) for
* an executable that matches one of the supplied names.
2001-01-11 16:04:28 +03:00
*/
2001-01-18 19:20:24 +03:00
class cmFindProgramCommand : public cmCommand
{
public:
2001-01-11 16:04:28 +03:00
/**
2001-01-18 19:20:24 +03:00
* This is a virtual constructor for the command.
2001-01-11 16:04:28 +03:00
*/
2001-01-18 19:20:24 +03:00
virtual cmCommand* Clone()
{
2001-01-18 19:20:24 +03:00
return new cmFindProgramCommand;
}
2001-01-11 16:04:28 +03:00
/**
2001-01-18 19:20:24 +03:00
* This is called when the command is first encountered in
2001-01-11 16:04:28 +03:00
* the CMakeLists.txt file.
*/
virtual bool InitialPass(std::vector<std::string> const& args);
2001-01-11 16:04:28 +03:00
/**
2001-01-18 19:20:24 +03:00
* This determines if the command gets propagated down
2001-01-11 16:04:28 +03:00
* to makefiles located in subdirectories.
*/
2002-04-12 01:02:10 +04:00
virtual bool IsInherited() { return false; }
2001-01-11 16:04:28 +03:00
/**
2001-01-18 19:20:24 +03:00
* The name of the command as specified in CMakeList.txt.
2001-01-11 16:04:28 +03:00
*/
2001-02-27 01:14:33 +03:00
virtual const char* GetName() { return "FIND_PROGRAM";}
2001-01-11 16:04:28 +03:00
/**
* Succinct documentation.
*/
2001-01-12 22:35:15 +03:00
virtual const char* GetTerseDocumentation()
{
2001-01-11 16:04:28 +03:00
return "Find an executable program.";
}
2001-01-11 16:04:28 +03:00
/**
* More documentation.
*/
2001-01-12 22:35:15 +03:00
virtual const char* GetFullDocumentation()
{
2001-01-11 16:04:28 +03:00
return
"FIND_PROGRAM(DEFINE_NAME executableName [NAMES name1 name2 name3...] [PATHS path1 path2 path3...] [NO_SYSTEM_PATH] [DOC helpstring]) "
"Find the executable in the system PATH or in any extra paths specified in the command."
2003-01-31 21:50:42 +03:00
"A cache entry called DEFILE_NAME is created to store the result. DEFILE_NAME-NOTFOUND is the value"
" used if the program was not found. CMake will continue to look as long as the value "
"is NOTFOUND If DOC is specified the next argument is the "
"documentation string for the cache entry NAME."
"If NO_SYSTEM_PATH is specified the contents of system PATH is not used";
}
cmTypeMacro(cmFindProgramCommand, cmCommand);
};
#endif