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
|
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file LICENSE.rst or https://cmake.org/licensing for details. */
#pragma once
#include "cmConfigure.h" // IWYU pragma: keep
#include <string>
#include <utility>
#include <vector>
#include "cmFindCommon.h"
#include "cmStateTypes.h"
class cmConfigureLog;
class cmExecutionStatus;
class cmMakefile;
/** \class cmFindBase
* \brief Base class for most FIND_XXX commands.
*
* cmFindBase is a parent class for cmFindProgramCommand, cmFindPathCommand,
* and cmFindLibraryCommand, cmFindFileCommand
*/
class cmFindBase : public cmFindCommon
{
public:
cmFindBase(std::string findCommandName, cmExecutionStatus& status);
~cmFindBase() override;
/**
* This is called when the command is first encountered in
* the CMakeLists.txt file.
*/
virtual bool ParseArguments(std::vector<std::string> const& args);
/**
* To check validity of a found path using user's validator, if any
*/
bool Validate(std::string const& path) const;
protected:
friend class cmFindBaseDebugState;
void ExpandPaths();
bool IsFound() const override;
bool IsDefined() const override;
void NormalizeFindResult();
void StoreFindResult(std::string const& value);
// actual find command name
std::string FindCommandName;
// use by command during find
std::string VariableDocumentation;
cmStateEnums::CacheEntryType VariableType = cmStateEnums::UNINITIALIZED;
std::string VariableName;
std::vector<std::string> Names;
bool NamesPerDir = false;
bool NamesPerDirAllowed = false;
// CMAKE_*_PATH CMAKE_SYSTEM_*_PATH FRAMEWORK|LIBRARY|INCLUDE|PROGRAM
std::string EnvironmentPath; // LIB,INCLUDE
bool AlreadyInCacheWithoutMetaInfo = false;
bool StoreResultInCache = true;
bool Required = false;
std::string ValidatorName;
private:
enum class FindState
{
Undefined,
Found,
NotFound,
};
// see if the VariableName is already set,
// also copy the documentation from the cache to VariableDocumentation
// if it has documentation in the cache
FindState GetInitialState();
FindState InitialState = FindState::Undefined;
// Add pieces of the search.
void FillPackageRootPath();
void FillCMakeVariablePath();
void FillCMakeEnvironmentPath();
void FillUserHintsPath();
void FillSystemEnvironmentPath();
void FillCMakeSystemVariablePath();
void FillUserGuessPath();
};
class cmFindBaseDebugState : public cmFindCommonDebugState
{
public:
explicit cmFindBaseDebugState(cmFindBase const* findBase);
~cmFindBaseDebugState() override;
private:
void FoundAtImpl(std::string const& path, std::string regexName) override;
void FailedAtImpl(std::string const& path, std::string regexName) override;
struct DebugLibState
{
DebugLibState() = default;
DebugLibState(std::string&& n, std::string p)
: regexName(n)
, path(std::move(p))
{
}
std::string regexName;
std::string path;
};
void WriteDebug() const override;
#ifndef CMAKE_BOOTSTRAP
void WriteEvent(cmConfigureLog& log, cmMakefile const& mf) const override;
std::vector<std::pair<VariableSource, std::string>> ExtraSearchVariables()
const override;
#endif
cmFindBase const* const FindBaseCommand;
std::vector<DebugLibState> FailedSearchLocations;
DebugLibState FoundSearchLocation;
};
|
