blob: fce0b11896a7e5d459f4ac6dd674898df62c76f0 [file] [log] [blame]
/* Distributed under the OSI-approved BSD 3-Clause License. See accompanying
file Copyright.txt or for details. */
#ifndef cmFindBase_h
#define cmFindBase_h
#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
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);
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;
bool NamesPerDirAllowed;
std::string EnvironmentPath; // LIB,INCLUDE
bool AlreadyInCache;
bool AlreadyInCacheWithoutMetaInfo;
// Add pieces of the search.
void FillPackageRootPath();
void FillCMakeVariablePath();
void FillCMakeEnvironmentPath();
void FillUserHintsPath();
void FillSystemEnvironmentPath();
void FillCMakeSystemVariablePath();
void FillUserGuessPath();
class cmFindBaseDebugState
explicit cmFindBaseDebugState(std::string name, cmFindBase const* findBase);
void FoundAt(std::string const& path, std::string regexName = std::string());
void FailedAt(std::string const& path,
std::string regexName = std::string());
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;