blob: 1fff696e9ad0e5083bf33fe343993c382ae433f6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/*=========================================================================
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 cmFindProgramCommand_h
#define cmFindProgramCommand_h
#include "cmStandardIncludes.h"
#include "cmCommand.h"
/** \class cmFindProgramCommand
* \brief Define a command to search for an executable program.
*
* cmFindProgramCommand 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 cmFindProgramCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmFindProgramCommand;
}
/**
* 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_PROGRAM";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Find an executable program.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
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."
"A cache entry called DEFILE_NAME is created to store the result. NOTFOUND is the value"
" used if the program was not found. 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
|
