1 //===-- DumpValueObjectOptions.h --------------------------------*- C++ -*-===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #ifndef LLDB_DATAFORMATTERS_DUMPVALUEOBJECTOPTIONS_H
10 #define LLDB_DATAFORMATTERS_DUMPVALUEOBJECTOPTIONS_H
11 
12 #include <string>
13 
14 #include "lldb/lldb-private.h"
15 #include "lldb/lldb-public.h"
16 
17 #include <functional>
18 #include <string>
19 
20 namespace lldb_private {
21 
22 class DumpValueObjectOptions {
23 public:
24   struct PointerDepth {
25     enum class Mode { Always, Default, Never } m_mode;
26     uint32_t m_count;
27 
28     PointerDepth operator--() const {
29       if (m_count > 0)
30         return PointerDepth{m_mode, m_count - 1};
31       return PointerDepth{m_mode, m_count};
32     }
33 
34     bool CanAllowExpansion() const;
35   };
36 
37   struct PointerAsArraySettings {
38     size_t m_element_count = 0;
39     size_t m_base_element = 0;
40     size_t m_stride = 0;
41 
42     PointerAsArraySettings() = default;
43 
44     PointerAsArraySettings(size_t elem_count, size_t base_elem = 0,
45                            size_t stride = 1)
m_element_countPointerAsArraySettings46         : m_element_count(elem_count), m_base_element(base_elem),
47           m_stride(stride) {}
48 
49     operator bool() { return m_element_count > 0; }
50   };
51 
52   typedef std::function<bool(ConstString, ConstString,
53                              const DumpValueObjectOptions &, Stream &)>
54       DeclPrintingHelper;
55 
DefaultOptions()56   static const DumpValueObjectOptions DefaultOptions() {
57     static DumpValueObjectOptions g_default_options;
58 
59     return g_default_options;
60   }
61 
62   DumpValueObjectOptions();
63 
64   DumpValueObjectOptions(ValueObject &valobj);
65 
66   DumpValueObjectOptions &
67   SetMaximumPointerDepth(PointerDepth depth = {PointerDepth::Mode::Never, 0});
68 
69   DumpValueObjectOptions &SetMaximumDepth(uint32_t depth, bool is_default);
70 
71   DumpValueObjectOptions &SetDeclPrintingHelper(DeclPrintingHelper helper);
72 
73   DumpValueObjectOptions &SetShowTypes(bool show = false);
74 
75   DumpValueObjectOptions &SetShowLocation(bool show = false);
76 
77   DumpValueObjectOptions &SetUseObjectiveC(bool use = false);
78 
79   DumpValueObjectOptions &SetShowSummary(bool show = true);
80 
81   DumpValueObjectOptions &
82   SetUseDynamicType(lldb::DynamicValueType dyn = lldb::eNoDynamicValues);
83 
84   DumpValueObjectOptions &SetUseSyntheticValue(bool use_synthetic = true);
85 
86   DumpValueObjectOptions &SetScopeChecked(bool check = true);
87 
88   DumpValueObjectOptions &SetFlatOutput(bool flat = false);
89 
90   DumpValueObjectOptions &SetOmitSummaryDepth(uint32_t depth = 0);
91 
92   DumpValueObjectOptions &SetIgnoreCap(bool ignore = false);
93 
94   DumpValueObjectOptions &SetRawDisplay();
95 
96   DumpValueObjectOptions &SetFormat(lldb::Format format = lldb::eFormatDefault);
97 
98   DumpValueObjectOptions &
99   SetSummary(lldb::TypeSummaryImplSP summary = lldb::TypeSummaryImplSP());
100 
101   DumpValueObjectOptions &SetRootValueObjectName(const char *name = nullptr);
102 
103   DumpValueObjectOptions &SetHideRootType(bool hide_root_type = false);
104 
105   DumpValueObjectOptions &SetHideName(bool hide_name = false);
106 
107   DumpValueObjectOptions &SetHideValue(bool hide_value = false);
108 
109   DumpValueObjectOptions &SetHidePointerValue(bool hide = false);
110 
111   DumpValueObjectOptions &SetVariableFormatDisplayLanguage(
112       lldb::LanguageType lang = lldb::eLanguageTypeUnknown);
113 
114   DumpValueObjectOptions &SetRunValidator(bool run = true);
115 
116   DumpValueObjectOptions &SetUseTypeDisplayName(bool dis = false);
117 
118   DumpValueObjectOptions &SetAllowOnelinerMode(bool oneliner = false);
119 
120   DumpValueObjectOptions &SetRevealEmptyAggregates(bool reveal = true);
121 
122   DumpValueObjectOptions &SetElementCount(uint32_t element_count = 0);
123 
124   DumpValueObjectOptions &
125   SetPointerAsArray(const PointerAsArraySettings &ptr_array);
126 
127   uint32_t m_max_depth = UINT32_MAX;
128   bool m_max_depth_is_default = true;
129   lldb::DynamicValueType m_use_dynamic = lldb::eNoDynamicValues;
130   uint32_t m_omit_summary_depth = 0;
131   lldb::Format m_format = lldb::eFormatDefault;
132   lldb::TypeSummaryImplSP m_summary_sp;
133   std::string m_root_valobj_name;
134   lldb::LanguageType m_varformat_language = lldb::eLanguageTypeUnknown;
135   PointerDepth m_max_ptr_depth;
136   DeclPrintingHelper m_decl_printing_helper;
137   PointerAsArraySettings m_pointer_as_array;
138   bool m_use_synthetic : 1;
139   bool m_scope_already_checked : 1;
140   bool m_flat_output : 1;
141   bool m_ignore_cap : 1;
142   bool m_show_types : 1;
143   bool m_show_location : 1;
144   bool m_use_objc : 1;
145   bool m_hide_root_type : 1;
146   bool m_hide_name : 1;
147   bool m_hide_value : 1;
148   bool m_run_validator : 1;
149   bool m_use_type_display_name : 1;
150   bool m_allow_oneliner_mode : 1;
151   bool m_hide_pointer_value : 1;
152   bool m_reveal_empty_aggregates : 1;
153 };
154 
155 } // namespace lldb_private
156 
157 #endif // LLDB_DATAFORMATTERS_DUMPVALUEOBJECTOPTIONS_H
158