DumpValueObjectOptions.h

Go to the documentation of this file.

//===-- DumpValueObjectOptions.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_DATAFORMATTERS_DUMPVALUEOBJECTOPTIONS_H
#define LLDB_DATAFORMATTERS_DUMPVALUEOBJECTOPTIONS_H
 
#include <string>
 
#include "lldb/lldb-private.h"
#include "lldb/lldb-public.h"
 
#include <functional>
#include <string>
 
namespace lldb_private {
 
class DumpValueObjectOptions {
public:
  struct PointerDepth {
    enum class Mode { Always, Default, Never } m_mode;
    uint32_t m_count;
 
    PointerDepth Decremented() const {
      if (m_count > 0)
        return PointerDepth{m_mode, m_count - 1};
      return PointerDepth{m_mode, m_count};
    }
 
    bool CanAllowExpansion() const;
  };
 
  struct PointerAsArraySettings {
    size_t m_element_count = 0;
    size_t m_base_element = 0;
    size_t m_stride = 0;
 
    PointerAsArraySettings() = default;
 
    PointerAsArraySettings(size_t elem_count, size_t base_elem = 0,
                           size_t stride = 1)
        : m_element_count(elem_count), m_base_element(base_elem),
          m_stride(stride) {}
 
    operator bool() { return m_element_count > 0; }
  };
 
  typedef std::function<bool(ConstString, ConstString,
                             const DumpValueObjectOptions &, Stream &)>
      DeclPrintingHelper;
 
  typedef std::function<bool(ConstString)> ChildPrintingDecider;
 
  static const DumpValueObjectOptions DefaultOptions() {
    static DumpValueObjectOptions g_default_options;
 
    return g_default_options;
  }
 
  DumpValueObjectOptions();
 
  DumpValueObjectOptions(ValueObject &valobj);
 
  DumpValueObjectOptions &
  SetMaximumPointerDepth(PointerDepth depth = {PointerDepth::Mode::Never, 0});
 
  DumpValueObjectOptions &SetMaximumDepth(uint32_t depth, bool is_default);
 
  DumpValueObjectOptions &SetDeclPrintingHelper(DeclPrintingHelper helper);
 
  DumpValueObjectOptions &SetChildPrintingDecider(ChildPrintingDecider decider);
 
  DumpValueObjectOptions &SetShowTypes(bool show = false);
 
  DumpValueObjectOptions &SetShowLocation(bool show = false);
 
  DumpValueObjectOptions &SetUseObjectiveC(bool use = false);
 
  DumpValueObjectOptions &SetShowSummary(bool show = true);
 
  DumpValueObjectOptions &
  SetUseDynamicType(lldb::DynamicValueType dyn = lldb::eNoDynamicValues);
 
  DumpValueObjectOptions &SetUseSyntheticValue(bool use_synthetic = true);
 
  DumpValueObjectOptions &SetScopeChecked(bool check = true);
 
  DumpValueObjectOptions &SetFlatOutput(bool flat = false);
 
  DumpValueObjectOptions &SetOmitSummaryDepth(uint32_t depth = 0);
 
  DumpValueObjectOptions &SetIgnoreCap(bool ignore = false);
 
  DumpValueObjectOptions &SetRawDisplay();
 
  DumpValueObjectOptions &SetFormat(lldb::Format format = lldb::eFormatDefault);
 
  DumpValueObjectOptions &
  SetSummary(lldb::TypeSummaryImplSP summary = lldb::TypeSummaryImplSP());
 
  DumpValueObjectOptions &SetRootValueObjectName(const char *name = nullptr);
 
  DumpValueObjectOptions &SetHideRootType(bool hide_root_type = false);
 
  DumpValueObjectOptions &SetHideRootName(bool hide_root_name);
 
  DumpValueObjectOptions &SetHideName(bool hide_name = false);
 
  DumpValueObjectOptions &SetHideValue(bool hide_value = false);
 
  DumpValueObjectOptions &SetHidePointerValue(bool hide = false);
 
  DumpValueObjectOptions &SetVariableFormatDisplayLanguage(
      lldb::LanguageType lang = lldb::eLanguageTypeUnknown);
 
  DumpValueObjectOptions &SetRunValidator(bool run = true);
 
  DumpValueObjectOptions &SetUseTypeDisplayName(bool dis = false);
 
  DumpValueObjectOptions &SetAllowOnelinerMode(bool oneliner = false);
 
  DumpValueObjectOptions &SetRevealEmptyAggregates(bool reveal = true);
 
  DumpValueObjectOptions &SetElementCount(uint32_t element_count = 0);
 
  DumpValueObjectOptions &
  SetPointerAsArray(const PointerAsArraySettings &ptr_array);
 
  uint32_t m_max_depth = UINT32_MAX;
  bool m_max_depth_is_default = true;
  lldb::DynamicValueType m_use_dynamic = lldb::eNoDynamicValues;
  uint32_t m_omit_summary_depth = 0;
  lldb::Format m_format = lldb::eFormatDefault;
  lldb::TypeSummaryImplSP m_summary_sp;
  std::string m_root_valobj_name;
  lldb::LanguageType m_varformat_language = lldb::eLanguageTypeUnknown;
  PointerDepth m_max_ptr_depth;
  DeclPrintingHelper m_decl_printing_helper;
  ChildPrintingDecider m_child_printing_decider;
  PointerAsArraySettings m_pointer_as_array;
  bool m_use_synthetic : 1;
  bool m_scope_already_checked : 1;
  bool m_flat_output : 1;
  bool m_ignore_cap : 1;
  bool m_show_types : 1;
  bool m_show_location : 1;
  bool m_use_objc : 1;
  bool m_hide_root_type : 1;
  bool m_hide_root_name : 1;
  bool m_hide_name : 1;
  bool m_hide_value : 1;
  bool m_run_validator : 1;
  bool m_use_type_display_name : 1;
  bool m_allow_oneliner_mode : 1;
  bool m_hide_pointer_value : 1;
  bool m_reveal_empty_aggregates : 1;
};
 
} // namespace lldb_private
 
#endif // LLDB_DATAFORMATTERS_DUMPVALUEOBJECTOPTIONS_H