Source/cmDebuggerVariables.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 <atomic>
   8 #include <cstdint>
   9 #include <functional>
  10 #include <memory>
  11 #include <string>
  12 #include <utility>
  13 #include <vector>
  14
  15 #include <cm3p/cppdap/types.h> // IWYU pragma: keep
  16
  17 namespace cmDebugger {
  18 class cmDebuggerVariablesManager;
  19 }
  20
  21 namespace dap {
  22 struct Variable;
  23 }
  24
  25 namespace cmDebugger {
  26
  27 struct cmDebuggerVariableEntry
  28 {
  29   cmDebuggerVariableEntry()
  30     : cmDebuggerVariableEntry("", "", "")
  31   {
  32   }
  33   cmDebuggerVariableEntry(std::string name, std::string value,
  34                           std::string type)
  35     : Name(std::move(name))
  36     , Value(std::move(value))
  37     , Type(std::move(type))
  38   {
  39   }
  40   cmDebuggerVariableEntry(std::string name, std::string value)
  41     : Name(std::move(name))
  42     , Value(std::move(value))
  43     , Type("string")
  44   {
  45   }
  46   cmDebuggerVariableEntry(std::string name, const char* value)
  47     : Name(std::move(name))
  48     , Value(value == nullptr ? "" : value)
  49     , Type("string")
  50   {
  51   }
  52   cmDebuggerVariableEntry(std::string name, bool value)
  53     : Name(std::move(name))
  54     , Value(value ? "TRUE" : "FALSE")
  55     , Type("bool")
  56   {
  57   }
  58   cmDebuggerVariableEntry(std::string name, int64_t value)
  59     : Name(std::move(name))
  60     , Value(std::to_string(value))
  61     , Type("int")
  62   {
  63   }
  64   cmDebuggerVariableEntry(std::string name, int value)
  65     : Name(std::move(name))
  66     , Value(std::to_string(value))
  67     , Type("int")
  68   {
  69   }
  70   std::string const Name;
  71   std::string const Value;
  72   std::string const Type;
  73 };
  74
  75 class cmDebuggerVariables
  76 {
  77   static std::atomic<int64_t> NextId;
  78   int64_t Id;
  79   std::string Name;
  80   std::string Value;
  81
  82   std::function<std::vector<cmDebuggerVariableEntry>()> GetKeyValuesFunction;
  83   std::vector<std::shared_ptr<cmDebuggerVariables>> SubVariables;
  84   bool IgnoreEmptyStringEntries = false;
  85   bool EnableSorting = true;
  86
  87   virtual dap::array<dap::Variable> HandleVariablesRequest();
  88   friend class cmDebuggerVariablesManager;
  89
  90 protected:
  91   const bool SupportsVariableType;
  92   std::shared_ptr<cmDebuggerVariablesManager> VariablesManager;
  93   void EnumerateSubVariablesIfAny(
  94     dap::array<dap::Variable>& toBeReturned) const;
  95   void ClearSubVariables();
  96
  97 public:
  98   cmDebuggerVariables(
  99     std::shared_ptr<cmDebuggerVariablesManager> variablesManager,
 100     std::string name, bool supportsVariableType);
 101   cmDebuggerVariables(
 102     std::shared_ptr<cmDebuggerVariablesManager> variablesManager,
 103     std::string name, bool supportsVariableType,
 104     std::function<std::vector<cmDebuggerVariableEntry>()> getKeyValuesFunc);
 105   inline int64_t GetId() const noexcept { return this->Id; }
 106   inline std::string GetName() const noexcept { return this->Name; }
 107   inline std::string GetValue() const noexcept { return this->Value; }
 108   inline void SetValue(std::string const& value) noexcept
 109   {
 110     this->Value = value;
 111   }
 112   void AddSubVariables(std::shared_ptr<cmDebuggerVariables> const& variables);
 113   inline void SetIgnoreEmptyStringEntries(bool value) noexcept
 114   {
 115     this->IgnoreEmptyStringEntries = value;
 116   }
 117   inline void SetEnableSorting(bool value) noexcept
 118   {
 119     this->EnableSorting = value;
 120   }
 121   virtual ~cmDebuggerVariables();
 122 };
 123
 124 } // namespace cmDebugger