blob: 3c44221a841e7bb815c7cd8afc6f55f7985f315e (
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
87
88
89
90
91
92
93
|
/*=========================================================================
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 cmFindPathCommand_h
#define cmFindPathCommand_h
#include "cmCommand.h"
/** \class cmFindPathCommand
* \brief Define a command to search for a library.
*
* cmFindPathCommand is used to define a CMake variable
* that specifies a library. The command searches for a given
* file in a list of directories.
*/
class cmFindPathCommand : public cmCommand
{
public:
/**
* This is a virtual constructor for the command.
*/
virtual cmCommand* Clone()
{
return new cmFindPathCommand;
}
/**
* 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 is invoked when in script mode.
*/
virtual bool IsScriptable() { return true; }
/**
* The name of the command as specified in CMakeList.txt.
*/
virtual const char* GetName() {return "FIND_PATH";}
/**
* Succinct documentation.
*/
virtual const char* GetTerseDocumentation()
{
return "Find the directory containing a file.";
}
/**
* More documentation.
*/
virtual const char* GetFullDocumentation()
{
return
" FIND_PATH(<VAR> fileName path1 [path2 ...]\n"
" [DOC \"docstring\"])\n"
"Find the directory containing a file named by fileName. "
"A cache entry named by "
"<VAR> is created to store the result. If the file is not "
"found, the result will be <VAR>-NOTFOUND. If DOC is specified "
"then the next argument is treated as a documentation string for "
"the cache entry <VAR>. "
"The search proceeds first in paths listed in the CMAKE_INCLUDE_PATH "
"CMake variable (which is generally set by the user on the command line), "
"then in paths listed in the CMAKE_INCLUDE_PATH environment variable, "
"then in paths given to the command, and finally in paths listed in the "
"PATH environment variable.";
}
cmStdString FindHeaderInFrameworks( std::vector<std::string> path,
const char* var, const char* file);
cmTypeMacro(cmFindPathCommand, cmCommand);
};
#endif
|
