Source/cmFindCommon.h

   1 /* Distributed under the OSI-approved BSD 3-Clause License.  See accompanying
   2    file Copyright.txt or https://cmake.org/licensing for details.  */
   3 #pragma once
   4
   5 #include "cmConfigure.h" // IWYU pragma: keep
   6
   7 #include <map>
   8 #include <set>
   9 #include <string>
  10 #include <vector>
  11
  12 #include "cmPathLabel.h"
  13 #include "cmSearchPath.h"
  14 #include "cmWindowsRegistry.h"
  15
  16 class cmExecutionStatus;
  17 class cmMakefile;
  18
  19 /** \class cmFindCommon
  20  * \brief Base class for FIND_XXX implementations.
  21  *
  22  * cmFindCommon is a parent class for cmFindBase,
  23  * cmFindProgramCommand, cmFindPathCommand, cmFindLibraryCommand,
  24  * cmFindFileCommand, and cmFindPackageCommand.
  25  */
  26 class cmFindCommon
  27 {
  28 public:
  29   cmFindCommon(cmExecutionStatus& status);
  30
  31   void SetError(std::string const& e);
  32
  33   bool DebugModeEnabled() const { return this->DebugMode; }
  34
  35 protected:
  36   friend class cmSearchPath;
  37   friend class cmFindBaseDebugState;
  38
  39   /** Used to define groups of path labels */
  40   class PathGroup : public cmPathLabel
  41   {
  42   protected:
  43     PathGroup();
  44
  45   public:
  46     PathGroup(const std::string& label)
  47       : cmPathLabel(label)
  48     {
  49     }
  50     static PathGroup All;
  51   };
  52
  53   /* Individual path types */
  54   class PathLabel : public cmPathLabel
  55   {
  56   protected:
  57     PathLabel();
  58
  59   public:
  60     PathLabel(const std::string& label)
  61       : cmPathLabel(label)
  62     {
  63     }
  64     static PathLabel PackageRoot;
  65     static PathLabel CMake;
  66     static PathLabel CMakeEnvironment;
  67     static PathLabel Hints;
  68     static PathLabel SystemEnvironment;
  69     static PathLabel CMakeSystem;
  70     static PathLabel Guess;
  71   };
  72
  73   enum RootPathMode
  74   {
  75     RootPathModeNever,
  76     RootPathModeOnly,
  77     RootPathModeBoth
  78   };
  79
  80   /** Construct the various path groups and labels */
  81   void InitializeSearchPathGroups();
  82
  83   /** Place a set of search paths under the search roots.  */
  84   void RerootPaths(std::vector<std::string>& paths,
  85                    std::string* debugBuffer = nullptr);
  86
  87   /** Get ignored paths from CMAKE_[SYSTEM_]IGNORE_PATH variables.  */
  88   void GetIgnoredPaths(std::vector<std::string>& ignore);
  89   void GetIgnoredPaths(std::set<std::string>& ignore);
  90
  91   /** Get ignored paths from CMAKE_[SYSTEM_]IGNORE_PREFIX_PATH variables.  */
  92   void GetIgnoredPrefixPaths(std::vector<std::string>& ignore);
  93   void GetIgnoredPrefixPaths(std::set<std::string>& ignore);
  94
  95   /** Compute final search path list (reroot + trailing slash).  */
  96   enum class IgnorePaths
  97   {
  98     No,
  99     Yes,
 100   };
 101   void ComputeFinalPaths(IgnorePaths ignorePaths,
 102                          std::string* debugBuffer = nullptr);
 103
 104   /** Compute the current default root path mode.  */
 105   void SelectDefaultRootPathMode();
 106
 107   /** Compute the current default bundle/framework search policy.  */
 108   void SelectDefaultMacMode();
 109
 110   /** Compute the current default search modes based on global variables.  */
 111   void SelectDefaultSearchModes();
 112
 113   /** The `InitialPass` functions of the child classes should set
 114       this->DebugMode to the result of these.  */
 115   bool ComputeIfDebugModeWanted();
 116   bool ComputeIfDebugModeWanted(std::string const& var);
 117
 118   // Path arguments prior to path manipulation routines
 119   std::vector<std::string> UserHintsArgs;
 120   std::vector<std::string> UserGuessArgs;
 121
 122   std::string CMakePathName;
 123   RootPathMode FindRootPathMode;
 124
 125   bool CheckCommonArgument(std::string const& arg);
 126   void AddPathSuffix(std::string const& arg);
 127
 128   void DebugMessage(std::string const& msg) const;
 129   bool DebugMode;
 130   bool NoDefaultPath;
 131   bool NoPackageRootPath;
 132   bool NoCMakePath;
 133   bool NoCMakeEnvironmentPath;
 134   bool NoSystemEnvironmentPath;
 135   bool NoCMakeSystemPath;
 136   bool NoCMakeInstallPath;
 137   cmWindowsRegistry::View RegistryView = cmWindowsRegistry::View::Target;
 138
 139   std::vector<std::string> SearchPathSuffixes;
 140
 141   std::map<PathGroup, std::vector<PathLabel>> PathGroupLabelMap;
 142   std::vector<PathGroup> PathGroupOrder;
 143   std::map<std::string, PathLabel> PathLabelStringMap;
 144   std::map<PathLabel, cmSearchPath> LabeledPaths;
 145
 146   std::vector<std::string> SearchPaths;
 147   std::set<cmSearchPath::PathWithPrefix> SearchPathsEmitted;
 148
 149   bool SearchFrameworkFirst;
 150   bool SearchFrameworkOnly;
 151   bool SearchFrameworkLast;
 152
 153   bool SearchAppBundleFirst;
 154   bool SearchAppBundleOnly;
 155   bool SearchAppBundleLast;
 156
 157   cmMakefile* Makefile;
 158   cmExecutionStatus& Status;
 159 };