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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
|
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or https://cmake.org/licensing for details. */
#ifndef cmFindPackageCommand_h
#define cmFindPackageCommand_h
#include "cmConfigure.h" // IWYU pragma: keep
#include <cstddef>
#include <functional>
#include <map>
#include <set>
#include <string>
#include <vector>
#include "cm_kwiml.h"
#include "cmFindCommon.h"
#include "cmPolicies.h"
// IWYU insists we should forward-declare instead of including <functional>,
// but we cannot forward-declare reliably because some C++ standard libraries
// put the template in an inline namespace.
#ifdef CMAKE_IWYU_FORWARD_STD_HASH
/* clang-format off */
namespace std {
template <class T> struct hash;
}
/* clang-format on */
#endif
class cmExecutionStatus;
class cmSearchPath;
/** \class cmFindPackageCommand
* \brief Load settings from an external project.
*
* cmFindPackageCommand
*/
class cmFindPackageCommand : public cmFindCommon
{
public:
/*! A sorting order strategy to be applied to recovered package folders (see
* FIND_PACKAGE_SORT_ORDER)*/
enum /*class*/ SortOrderType
{
None,
Name_order,
Natural
};
/*! A sorting direction to be applied to recovered package folders (see
* FIND_PACKAGE_SORT_DIRECTION)*/
enum /*class*/ SortDirectionType
{
Asc,
Dec
};
/*! sorts a given list of string based on the input sort parameters */
static void Sort(std::vector<std::string>::iterator begin,
std::vector<std::string>::iterator end, SortOrderType order,
SortDirectionType dir);
cmFindPackageCommand(cmExecutionStatus& status);
bool InitialPass(std::vector<std::string> const& args);
private:
class PathLabel : public cmFindCommon::PathLabel
{
protected:
PathLabel();
public:
PathLabel(const std::string& label)
: cmFindCommon::PathLabel(label)
{
}
static PathLabel UserRegistry;
static PathLabel Builds;
static PathLabel SystemRegistry;
};
bool FindPackageUsingModuleMode();
bool FindPackageUsingConfigMode();
// Add additional search path labels and groups not present in the
// parent class
void AppendSearchPathGroups();
void AppendSuccessInformation();
void AppendToFoundProperty(bool found);
void SetModuleVariables(const std::string& components);
bool FindModule(bool& found);
void AddFindDefinition(const std::string& var, const char* val);
void RestoreFindDefinitions();
enum /*class*/ HandlePackageModeType
{
Module,
Config
};
bool HandlePackageMode(HandlePackageModeType type);
bool FindConfig();
bool FindPrefixedConfig();
bool FindFrameworkConfig();
bool FindAppBundleConfig();
enum PolicyScopeRule
{
NoPolicyScope,
DoPolicyScope
};
bool ReadListFile(const std::string& f, PolicyScopeRule psr);
void StoreVersionFound();
void ComputePrefixes();
void FillPrefixesPackageRoot();
void FillPrefixesCMakeEnvironment();
void FillPrefixesCMakeVariable();
void FillPrefixesSystemEnvironment();
void FillPrefixesUserRegistry();
void FillPrefixesSystemRegistry();
void FillPrefixesCMakeSystemVariable();
void FillPrefixesUserGuess();
void FillPrefixesUserHints();
void LoadPackageRegistryDir(std::string const& dir, cmSearchPath& outPaths);
void LoadPackageRegistryWinUser();
void LoadPackageRegistryWinSystem();
void LoadPackageRegistryWin(bool user, unsigned int view,
cmSearchPath& outPaths);
bool CheckPackageRegistryEntry(const std::string& fname,
cmSearchPath& outPaths);
bool SearchDirectory(std::string const& dir);
bool CheckDirectory(std::string const& dir);
bool FindConfigFile(std::string const& dir, std::string& file);
bool CheckVersion(std::string const& config_file);
bool CheckVersionFile(std::string const& version_file,
std::string& result_version);
bool SearchPrefix(std::string const& prefix);
bool SearchFrameworkPrefix(std::string const& prefix_in);
bool SearchAppBundlePrefix(std::string const& prefix_in);
friend class cmFindPackageFileList;
struct OriginalDef
{
bool exists;
std::string value;
};
std::map<std::string, OriginalDef> OriginalDefs;
std::map<std::string, cmPolicies::PolicyID> DeprecatedFindModules;
std::string Name;
std::string Variable;
std::string Version;
unsigned int VersionMajor;
unsigned int VersionMinor;
unsigned int VersionPatch;
unsigned int VersionTweak;
unsigned int VersionCount;
bool VersionExact;
std::string FileFound;
std::string VersionFound;
unsigned int VersionFoundMajor;
unsigned int VersionFoundMinor;
unsigned int VersionFoundPatch;
unsigned int VersionFoundTweak;
unsigned int VersionFoundCount;
KWIML_INT_uint64_t RequiredCMakeVersion;
bool Quiet;
bool Required;
bool UseConfigFiles;
bool UseFindModules;
bool NoUserRegistry;
bool NoSystemRegistry;
bool DebugMode;
bool UseLib32Paths;
bool UseLib64Paths;
bool UseLibx32Paths;
bool UseRealPath;
bool PolicyScope;
std::string LibraryArchitecture;
std::vector<std::string> Names;
std::vector<std::string> Configs;
std::set<std::string> IgnoredPaths;
/*! the selected sortOrder (None by default)*/
SortOrderType SortOrder;
/*! the selected sortDirection (Asc by default)*/
SortDirectionType SortDirection;
struct ConfigFileInfo
{
std::string filename;
std::string version;
bool operator<(ConfigFileInfo const& rhs) const
{
return this->filename < rhs.filename;
}
bool operator==(ConfigFileInfo const& rhs) const
{
return this->filename == rhs.filename;
}
bool operator!=(ConfigFileInfo const& rhs) const
{
return !(*this == rhs);
}
};
std::vector<ConfigFileInfo> ConsideredConfigs;
friend struct std::hash<ConfigFileInfo>;
};
namespace std {
template <>
struct hash<cmFindPackageCommand::ConfigFileInfo>
{
using argument_type = cmFindPackageCommand::ConfigFileInfo;
using result_type = size_t;
result_type operator()(argument_type const& s) const noexcept
{
result_type const h(std::hash<std::string>{}(s.filename));
return h;
}
};
}
bool cmFindPackage(std::vector<std::string> const& args,
cmExecutionStatus& status);
#endif
|
