bdca8b01d2
#pragma once is a widely supported compiler pragma, even though it is not part of the C++ standard. Many of the issues keeping #pragma once from being standardized (distributed filesystems, build farms, hard links, etc.) do not apply to CMake - it is easy to build CMake on a single machine. CMake also does not install any header files which can be consumed by other projects (though cmCPluginAPI.h has been deliberately omitted from this conversion in case anyone is still using it.) Finally, #pragma once has been required to build CMake since at least August 2017 (7f29bbe6enabled server mode unconditionally, which had been using #pragma once since September 2016 (b13d3e0d)). The fact that we now require C++11 filters out old compilers, and it is unlikely that there is a compiler which supports C++11 but does not support #pragma once.
96 lines
2.4 KiB
C++
96 lines
2.4 KiB
C++
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
|
|
file Copyright.txt or https://cmake.org/licensing for details. */
|
|
#pragma once
|
|
|
|
#include "cmConfigure.h" // IWYU pragma: keep
|
|
|
|
#include <string>
|
|
#include <utility>
|
|
#include <vector>
|
|
|
|
#include "cmFindCommon.h"
|
|
|
|
class cmExecutionStatus;
|
|
|
|
/** \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(cmExecutionStatus& status);
|
|
virtual ~cmFindBase() = default;
|
|
|
|
/**
|
|
* This is called when the command is first encountered in
|
|
* the CMakeLists.txt file.
|
|
*/
|
|
virtual bool ParseArguments(std::vector<std::string> const& args);
|
|
|
|
protected:
|
|
friend class cmFindBaseDebugState;
|
|
void ExpandPaths();
|
|
|
|
// see if the VariableName is already set in the cache,
|
|
// also copy the documentation from the cache to VariableDocumentation
|
|
// if it has documentation in the cache
|
|
bool CheckForVariableInCache();
|
|
|
|
// use by command during find
|
|
std::string VariableDocumentation;
|
|
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 AlreadyInCache = false;
|
|
bool AlreadyInCacheWithoutMetaInfo = false;
|
|
|
|
bool Required = false;
|
|
|
|
private:
|
|
// Add pieces of the search.
|
|
void FillPackageRootPath();
|
|
void FillCMakeVariablePath();
|
|
void FillCMakeEnvironmentPath();
|
|
void FillUserHintsPath();
|
|
void FillSystemEnvironmentPath();
|
|
void FillCMakeSystemVariablePath();
|
|
void FillUserGuessPath();
|
|
};
|
|
|
|
class cmFindBaseDebugState
|
|
{
|
|
public:
|
|
explicit cmFindBaseDebugState(std::string name, cmFindBase const* findBase);
|
|
~cmFindBaseDebugState();
|
|
|
|
void FoundAt(std::string const& path, std::string regexName = std::string());
|
|
void FailedAt(std::string const& path,
|
|
std::string regexName = std::string());
|
|
|
|
private:
|
|
struct DebugLibState
|
|
{
|
|
DebugLibState() = default;
|
|
DebugLibState(std::string&& n, std::string p)
|
|
: regexName(n)
|
|
, path(std::move(p))
|
|
{
|
|
}
|
|
std::string regexName;
|
|
std::string path;
|
|
};
|
|
|
|
cmFindBase const* FindCommand;
|
|
std::string CommandName;
|
|
std::vector<DebugLibState> FailedSearchLocations;
|
|
DebugLibState FoundSearchLocation;
|
|
};
|