StructuredDataImpl.h

Go to the documentation of this file.

//===-- StructuredDataImpl.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_CORE_STRUCTUREDDATAIMPL_H
#define LLDB_CORE_STRUCTUREDDATAIMPL_H
 
#include "lldb/Target/StructuredDataPlugin.h"
#include "lldb/Utility/Event.h"
#include "lldb/Utility/Status.h"
#include "lldb/Utility/Stream.h"
#include "lldb/Utility/StructuredData.h"
#include "lldb/lldb-enumerations.h"
#include "lldb/lldb-forward.h"
#include "llvm/ADT/StringRef.h"
 
#pragma mark--
#pragma mark StructuredDataImpl
 
namespace lldb_private {
 
class StructuredDataImpl {
public:
  StructuredDataImpl() = default;
 
  StructuredDataImpl(const StructuredDataImpl &rhs) = default;
 
  StructuredDataImpl(StructuredData::ObjectSP obj)
      : m_data_sp(std::move(obj)) {}
 
  StructuredDataImpl(const lldb::EventSP &event_sp)
      : m_plugin_wp(
            EventDataStructuredData::GetPluginFromEvent(event_sp.get())),
        m_data_sp(EventDataStructuredData::GetObjectFromEvent(event_sp.get())) {
  }
 
  ~StructuredDataImpl() = default;
 
  StructuredDataImpl &operator=(const StructuredDataImpl &rhs) = default;
 
  bool IsValid() const { return m_data_sp.get() != nullptr; }
 
  void Clear() {
    m_plugin_wp.reset();
    m_data_sp.reset();
  }
 
  Status GetAsJSON(Stream &stream) const {
    if (!m_data_sp)
      return Status::FromErrorString("No structured data.");
 
    llvm::json::OStream s(stream.AsRawOstream());
    m_data_sp->Serialize(s);
    return Status();
  }
 
  Status GetDescription(Stream &stream) const {
    if (!m_data_sp)
      return Status::FromErrorString("Cannot pretty print structured data: "
                                     "no data to print.");
 
    // Grab the plugin
    lldb::StructuredDataPluginSP plugin_sp = m_plugin_wp.lock();
 
    // If there's no plugin, call underlying data's dump method:
    if (!plugin_sp) {
      if (!m_data_sp)
        return Status::FromErrorString("No data to describe.");
      m_data_sp->GetDescription(stream);
      return Status();
    }
    // Get the data's description.
    return plugin_sp->GetDescription(m_data_sp, stream);
  }
 
  StructuredData::ObjectSP GetObjectSP() { return m_data_sp; }
 
  void SetObjectSP(const StructuredData::ObjectSP &obj) { m_data_sp = obj; }
 
  void SetValueForKey(llvm::StringRef key,
                      const StructuredData::ObjectSP &value) {
    if (!m_data_sp ||
        m_data_sp->GetType() != lldb::eStructuredDataTypeDictionary) {
      m_data_sp = StructuredData::FromKeyValue(key, value);
    } else if (StructuredData::Dictionary *dict =
                   m_data_sp->GetAsDictionary()) {
      dict->AddItem(key, value);
    }
  }
 
  void SetUnsignedIntegerValue(uint64_t value) {
    m_data_sp = StructuredData::FromInteger(value);
  }
 
  void SetSignedIntegerValue(int64_t value) {
    m_data_sp = StructuredData::FromInteger(value);
  }
 
  void SetFloatValue(double value) {
    m_data_sp = StructuredData::FromFloat(value);
  }
 
  void SetBooleanValue(bool value) {
    m_data_sp = StructuredData::FromBoolean(value);
  }
 
  void SetStringValue(llvm::StringRef value) {
    m_data_sp = StructuredData::FromString(value);
  }
 
  void SetGenericValue(void *value) {
    m_data_sp = StructuredData::FromGeneric(value);
  }
 
  lldb::StructuredDataType GetType() const {
    return (m_data_sp ? m_data_sp->GetType() :
        lldb::eStructuredDataTypeInvalid);
  }
 
  size_t GetSize() const {
    if (!m_data_sp)
      return 0;
 
    if (m_data_sp->GetType() == lldb::eStructuredDataTypeDictionary) {
      auto dict = m_data_sp->GetAsDictionary();
      return (dict->GetSize());
    } else if (m_data_sp->GetType() == lldb::eStructuredDataTypeArray) {
      auto array = m_data_sp->GetAsArray();
      return (array->GetSize());
    } else
      return 0;
  }
 
  StructuredData::ObjectSP GetValueForKey(const char *key) const {
    if (m_data_sp) {
      auto dict = m_data_sp->GetAsDictionary();
      if (dict)
        return dict->GetValueForKey(llvm::StringRef(key));
    }
    return StructuredData::ObjectSP();
  }
 
  StructuredData::ObjectSP GetItemAtIndex(size_t idx) const {
    if (m_data_sp) {
      auto array = m_data_sp->GetAsArray();
      if (array)
        return array->GetItemAtIndex(idx);
    }
    return StructuredData::ObjectSP();
  }
 
  uint64_t GetIntegerValue(uint64_t fail_value = 0) const {
    return (m_data_sp ? m_data_sp->GetUnsignedIntegerValue(fail_value)
                      : fail_value);
  }
 
  int64_t GetIntegerValue(int64_t fail_value = 0) const {
    return (m_data_sp ? m_data_sp->GetSignedIntegerValue(fail_value)
                      : fail_value);
  }
 
  double GetFloatValue(double fail_value = 0.0) const {
    return (m_data_sp ? m_data_sp->GetFloatValue(fail_value) : fail_value);
  }
 
  bool GetBooleanValue(bool fail_value = false) const {
    return (m_data_sp ? m_data_sp->GetBooleanValue(fail_value) : fail_value);
  }
 
  size_t GetStringValue(char *dst, size_t dst_len) const {
    if (!m_data_sp)
      return 0;
 
    llvm::StringRef result = m_data_sp->GetStringValue();
    if (result.empty())
      return 0;
 
    const size_t needed_len = result.size() + 1; // for the NULL byte.
    if (dst && dst_len != 0) {
      const size_t min_len = std::min(needed_len, dst_len);
      const size_t copy_len = min_len - 1; // exclude space for NULL byte.
      ::memcpy(dst, result.data(), copy_len);
      dst[copy_len] = '\0';
    }
 
    return needed_len;
  }
 
  void *GetGenericValue() const {
    if (!m_data_sp)
      return nullptr;
 
    StructuredData::Generic *generic_data = m_data_sp->GetAsGeneric();
    if (!generic_data)
      return nullptr;
 
    return generic_data->GetValue();
  }
 
  StructuredData::ObjectSP GetObjectSP() const { return m_data_sp; }
 
private:
  lldb::StructuredDataPluginWP m_plugin_wp;
  StructuredData::ObjectSP m_data_sp;
};
} // namespace lldb_private
#endif