2001-01-11 13:04:28 +00:00
|
|
|
/*=========================================================================
|
|
|
|
|
|
|
|
Program: Insight Segmentation & Registration Toolkit
|
|
|
|
Module: $RCSfile$
|
|
|
|
Language: C++
|
|
|
|
Date: $Date$
|
|
|
|
Version: $Revision$
|
|
|
|
|
2002-01-21 20:30:43 +00:00
|
|
|
Copyright (c) 2002 Insight Consortium. All rights reserved.
|
|
|
|
See ITKCopyright.txt or http://www.itk.org/HTML/Copyright.htm for details.
|
2001-01-11 13:04:28 +00:00
|
|
|
|
2002-01-21 20:30:43 +00: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 13:04:28 +00:00
|
|
|
|
|
|
|
=========================================================================*/
|
2001-01-18 16:20:24 +00:00
|
|
|
#ifndef cmFindProgramCommand_h
|
|
|
|
#define cmFindProgramCommand_h
|
2001-01-05 16:41:20 +00:00
|
|
|
|
|
|
|
#include "cmStandardIncludes.h"
|
2001-01-18 16:20:24 +00:00
|
|
|
#include "cmCommand.h"
|
2001-01-05 16:41:20 +00:00
|
|
|
|
2001-01-18 16:20:24 +00:00
|
|
|
/** \class cmFindProgramCommand
|
|
|
|
* \brief Define a command to search for an executable program.
|
2001-01-11 13:04:28 +00:00
|
|
|
*
|
2001-01-18 16:20:24 +00:00
|
|
|
* cmFindProgramCommand is used to define a CMake variable
|
|
|
|
* that specifies an executable program. The command searches
|
2001-01-11 19:47:38 +00:00
|
|
|
* in the current path (e.g., PATH environment variable) for
|
|
|
|
* an executable that matches one of the supplied names.
|
2001-01-11 13:04:28 +00:00
|
|
|
*/
|
2001-01-18 16:20:24 +00:00
|
|
|
class cmFindProgramCommand : public cmCommand
|
2001-01-05 16:41:20 +00:00
|
|
|
{
|
|
|
|
public:
|
2001-01-11 13:04:28 +00:00
|
|
|
/**
|
2001-01-18 16:20:24 +00:00
|
|
|
* This is a virtual constructor for the command.
|
2001-01-11 13:04:28 +00:00
|
|
|
*/
|
2001-01-18 16:20:24 +00:00
|
|
|
virtual cmCommand* Clone()
|
2001-01-05 16:41:20 +00:00
|
|
|
{
|
2001-01-18 16:20:24 +00:00
|
|
|
return new cmFindProgramCommand;
|
2001-01-05 16:41:20 +00:00
|
|
|
}
|
2001-01-11 13:04:28 +00:00
|
|
|
|
|
|
|
/**
|
2001-01-18 16:20:24 +00:00
|
|
|
* This is called when the command is first encountered in
|
2001-01-11 13:04:28 +00:00
|
|
|
* the CMakeLists.txt file.
|
|
|
|
*/
|
2001-09-20 19:08:30 +00:00
|
|
|
virtual bool InitialPass(std::vector<std::string> const& args);
|
2001-01-11 13:04:28 +00:00
|
|
|
|
|
|
|
/**
|
2001-01-18 16:20:24 +00:00
|
|
|
* This determines if the command gets propagated down
|
2001-01-11 13:04:28 +00:00
|
|
|
* to makefiles located in subdirectories.
|
|
|
|
*/
|
2002-04-11 21:02:10 +00:00
|
|
|
virtual bool IsInherited() { return false; }
|
2001-01-05 16:41:20 +00:00
|
|
|
|
2001-01-11 13:04:28 +00:00
|
|
|
/**
|
2001-01-18 16:20:24 +00:00
|
|
|
* The name of the command as specified in CMakeList.txt.
|
2001-01-11 13:04:28 +00:00
|
|
|
*/
|
2001-02-26 22:14:33 +00:00
|
|
|
virtual const char* GetName() { return "FIND_PROGRAM";}
|
2001-01-11 13:04:28 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Succinct documentation.
|
|
|
|
*/
|
2001-01-12 19:35:15 +00:00
|
|
|
virtual const char* GetTerseDocumentation()
|
2001-01-05 16:41:20 +00:00
|
|
|
{
|
2001-01-11 13:04:28 +00:00
|
|
|
return "Find an executable program.";
|
2001-01-05 16:41:20 +00:00
|
|
|
}
|
|
|
|
|
2001-01-11 13:04:28 +00:00
|
|
|
/**
|
|
|
|
* More documentation.
|
|
|
|
*/
|
2001-01-12 19:35:15 +00:00
|
|
|
virtual const char* GetFullDocumentation()
|
2001-01-05 16:41:20 +00:00
|
|
|
{
|
2001-01-11 13:04:28 +00:00
|
|
|
return
|
2002-05-12 15:31:45 +00:00
|
|
|
"FIND_PROGRAM(DEFINE_NAME executableName [NAMES name1 name2 name3...] [PATHS path1 path2 path3...] [NO_SYSTEM_PATH] [DOC helpstring]) "
|
2001-11-26 23:24:47 +00:00
|
|
|
"Find the executable in the system PATH or in any extra paths specified in the command."
|
2002-05-12 15:31:45 +00:00
|
|
|
"A cache entry called DEFILE_NAME is created to store the result. NOTFOUND is the value"
|
2001-11-26 23:24:47 +00:00
|
|
|
" used if the program was not found. If DOC is specified the next argument is the "
|
2002-05-12 15:31:45 +00:00
|
|
|
"documentation string for the cache entry NAME."
|
|
|
|
"If NO_SYSTEM_PATH is specified the contents of system PATH is not used";
|
2001-01-05 16:41:20 +00:00
|
|
|
}
|
2001-02-26 17:07:53 +00:00
|
|
|
|
|
|
|
cmTypeMacro(cmFindProgramCommand, cmCommand);
|
2001-01-05 16:41:20 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
#endif
|