blob: ae9ade73e989e3ea1ae1ce3083651a39fc4d5ede [file] [log] [blame]
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or 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.
/* clang-format off */
namespace std {
template <class T> struct hash;
/* clang-format on */
class cmExecutionStatus;
class cmSearchPath;
/** \class cmFindPackageCommand
* \brief Load settings from an external project.
* cmFindPackageCommand
class cmFindPackageCommand : public cmFindCommon
/*! A sorting order strategy to be applied to recovered package folders (see
enum /*class*/ SortOrderType
/*! A sorting direction to be applied to recovered package folders (see
enum /*class*/ SortDirectionType
/*! 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);
class PathLabel : public cmFindCommon::PathLabel
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
bool HandlePackageMode(HandlePackageModeType type);
bool FindConfig();
bool FindPrefixedConfig();
bool FindFrameworkConfig();
bool FindAppBundleConfig();
enum PolicyScopeRule
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 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;
std::string DebugBuffer;
/*! 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);