OptionValueDictionary.h

Go to the documentation of this file.

//===-- OptionValueDictionary.h ---------------------------------*- C++ -*-===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
 
#ifndef LLDB_INTERPRETER_OPTIONVALUEDICTIONARY_H
#define LLDB_INTERPRETER_OPTIONVALUEDICTIONARY_H
 
#include "lldb/Interpreter/OptionValue.h"
#include "lldb/lldb-private-types.h"
 
#include "llvm/ADT/StringMap.h"
 
namespace lldb_private {
 
class OptionValueDictionary
    : public Cloneable<OptionValueDictionary, OptionValue> {
public:
  OptionValueDictionary(uint32_t type_mask = UINT32_MAX,
                        OptionEnumValues enum_values = OptionEnumValues(),
                        bool raw_value_dump = true)
      : m_type_mask(type_mask), m_enum_values(enum_values),
        m_raw_value_dump(raw_value_dump) {}
 
  ~OptionValueDictionary() override = default;
 
  // Virtual subclass pure virtual overrides
 
  OptionValue::Type GetType() const override { return eTypeDictionary; }
 
  void DumpValue(const ExecutionContext *exe_ctx, Stream &strm,
                 uint32_t dump_mask) override;
 
  llvm::json::Value ToJSON(const ExecutionContext *exe_ctx) override;
 
  Status
  SetValueFromString(llvm::StringRef value,
                     VarSetOperationType op = eVarSetOperationAssign) override;
 
  void Clear() override {
    m_values.clear();
    m_value_was_set = false;
  }
 
  lldb::OptionValueSP
  DeepCopy(const lldb::OptionValueSP &new_parent) const override;
 
  bool IsAggregateValue() const override { return true; }
 
  bool IsHomogenous() const {
    return ConvertTypeMaskToType(m_type_mask) != eTypeInvalid;
  }
 
  // Subclass specific functions
 
  size_t GetNumValues() const { return m_values.size(); }
 
  lldb::OptionValueSP GetValueForKey(llvm::StringRef key) const;
 
  lldb::OptionValueSP GetSubValue(const ExecutionContext *exe_ctx,
                                  llvm::StringRef name,
                                  Status &error) const override;
 
  Status SetSubValue(const ExecutionContext *exe_ctx, VarSetOperationType op,
                     llvm::StringRef name, llvm::StringRef value) override;
 
  bool SetValueForKey(llvm::StringRef key, const lldb::OptionValueSP &value_sp,
                      bool can_replace = true);
 
  bool DeleteValueForKey(llvm::StringRef key);
 
  size_t GetArgs(Args &args) const;
 
  Status SetArgs(const Args &args, VarSetOperationType op);
 
protected:
  uint32_t m_type_mask;
  OptionEnumValues m_enum_values;
  llvm::StringMap<lldb::OptionValueSP> m_values;
  bool m_raw_value_dump;
};
 
} // namespace lldb_private
 
#endif // LLDB_INTERPRETER_OPTIONVALUEDICTIONARY_H