Source/cmWindowsRegistry.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 <cstdint> // IWYU pragma: keep
   8 #include <initializer_list>
   9 #include <string>
  10 #include <vector>
  11
  12 #include <cm/optional>
  13 #include <cm/string_view>
  14 #include <cmext/enum_set>
  15 #include <cmext/string_view>
  16
  17 class cmMakefile;
  18
  19 class cmWindowsRegistry
  20 {
  21 public:
  22   enum class View
  23   {
  24     Both,
  25     Target,
  26     Host,
  27     Reg64_32,
  28     Reg32_64,
  29     Reg32,
  30     Reg64
  31   };
  32
  33   // Registry supported types
  34   enum class ValueType : std::uint8_t
  35   {
  36     Reg_SZ,
  37     Reg_EXPAND_SZ,
  38     Reg_MULTI_SZ,
  39     Reg_DWORD,
  40     Reg_QWORD
  41   };
  42   using ValueTypeSet = cm::enum_set<ValueType>;
  43
  44   // All types as defined by enum ValueType
  45   static const ValueTypeSet AllTypes;
  46   // same as AllTYpes but without type REG_MULTI_SZ
  47   static const ValueTypeSet SimpleTypes;
  48
  49   cmWindowsRegistry(cmMakefile&,
  50                     const ValueTypeSet& supportedTypes = AllTypes);
  51
  52   // Helper routine to convert string to enum value
  53   static cm::optional<View> ToView(cm::string_view name);
  54   // Helper routine to convert enum to string
  55   static cm::string_view FromView(View view);
  56
  57   cm::optional<std::string> ReadValue(cm::string_view key,
  58                                       View view = View::Both,
  59                                       cm::string_view separator = "\0"_s)
  60   {
  61     return this->ReadValue(key, ""_s, view, separator);
  62   }
  63   cm::optional<std::string> ReadValue(cm::string_view key,
  64                                       cm::string_view name,
  65                                       View view = View::Both,
  66                                       cm::string_view separator = "\0"_s);
  67
  68   cm::optional<std::vector<std::string>> GetValueNames(cm::string_view key,
  69                                                        View view = View::Both);
  70   cm::optional<std::vector<std::string>> GetSubKeys(cm::string_view key,
  71                                                     View view = View::Both);
  72
  73   // Expand an expression which may contains multiple references
  74   // to registry keys.
  75   // Depending of the view specified, one or two expansions can be done.
  76   cm::optional<std::vector<std::string>> ExpandExpression(
  77     cm::string_view expression, View view, cm::string_view separator = "\0"_s);
  78
  79   cm::string_view GetLastError() const;
  80
  81 private:
  82 #if defined(_WIN32) && !defined(__CYGWIN__)
  83   std::vector<View> ComputeViews(View view);
  84
  85   int TargetSize = 0;
  86   ValueTypeSet SupportedTypes = AllTypes;
  87 #endif
  88   std::string LastError;
  89 };