1 //===-- DataVisualization.cpp ---------------------------------------*- C++
2 //-*-===//
3 //
4 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
5 // See https://llvm.org/LICENSE.txt for license information.
6 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "lldb/DataFormatters/DataVisualization.h"
11 
12 
13 using namespace lldb;
14 using namespace lldb_private;
15 
16 static FormatManager &GetFormatManager() {
17   static FormatManager g_format_manager;
18   return g_format_manager;
19 }
20 
21 void DataVisualization::ForceUpdate() { GetFormatManager().Changed(); }
22 
23 uint32_t DataVisualization::GetCurrentRevision() {
24   return GetFormatManager().GetCurrentRevision();
25 }
26 
27 bool DataVisualization::ShouldPrintAsOneLiner(ValueObject &valobj) {
28   return GetFormatManager().ShouldPrintAsOneLiner(valobj);
29 }
30 
31 lldb::TypeFormatImplSP
32 DataVisualization::GetFormat(ValueObject &valobj,
33                              lldb::DynamicValueType use_dynamic) {
34   return GetFormatManager().GetFormat(valobj, use_dynamic);
35 }
36 
37 lldb::TypeFormatImplSP
38 DataVisualization::GetFormatForType(lldb::TypeNameSpecifierImplSP type_sp) {
39   return GetFormatManager().GetFormatForType(type_sp);
40 }
41 
42 lldb::TypeSummaryImplSP
43 DataVisualization::GetSummaryFormat(ValueObject &valobj,
44                                     lldb::DynamicValueType use_dynamic) {
45   return GetFormatManager().GetSummaryFormat(valobj, use_dynamic);
46 }
47 
48 lldb::TypeSummaryImplSP
49 DataVisualization::GetSummaryForType(lldb::TypeNameSpecifierImplSP type_sp) {
50   return GetFormatManager().GetSummaryForType(type_sp);
51 }
52 
53 lldb::SyntheticChildrenSP
54 DataVisualization::GetSyntheticChildren(ValueObject &valobj,
55                                         lldb::DynamicValueType use_dynamic) {
56   return GetFormatManager().GetSyntheticChildren(valobj, use_dynamic);
57 }
58 
59 lldb::TypeFilterImplSP
60 DataVisualization::GetFilterForType(lldb::TypeNameSpecifierImplSP type_sp) {
61   return GetFormatManager().GetFilterForType(type_sp);
62 }
63 
64 lldb::ScriptedSyntheticChildrenSP
65 DataVisualization::GetSyntheticForType(lldb::TypeNameSpecifierImplSP type_sp) {
66   return GetFormatManager().GetSyntheticForType(type_sp);
67 }
68 
69 lldb::TypeValidatorImplSP
70 DataVisualization::GetValidator(ValueObject &valobj,
71                                 lldb::DynamicValueType use_dynamic) {
72   return GetFormatManager().GetValidator(valobj, use_dynamic);
73 }
74 
75 lldb::TypeValidatorImplSP
76 DataVisualization::GetValidatorForType(lldb::TypeNameSpecifierImplSP type_sp) {
77   return GetFormatManager().GetValidatorForType(type_sp);
78 }
79 
80 bool DataVisualization::AnyMatches(
81     ConstString type_name, TypeCategoryImpl::FormatCategoryItems items,
82     bool only_enabled, const char **matching_category,
83     TypeCategoryImpl::FormatCategoryItems *matching_type) {
84   return GetFormatManager().AnyMatches(type_name, items, only_enabled,
85                                        matching_category, matching_type);
86 }
87 
88 bool DataVisualization::Categories::GetCategory(ConstString category,
89                                                 lldb::TypeCategoryImplSP &entry,
90                                                 bool allow_create) {
91   entry = GetFormatManager().GetCategory(category, allow_create);
92   return (entry.get() != nullptr);
93 }
94 
95 bool DataVisualization::Categories::GetCategory(
96     lldb::LanguageType language, lldb::TypeCategoryImplSP &entry) {
97   if (LanguageCategory *lang_category =
98           GetFormatManager().GetCategoryForLanguage(language))
99     entry = lang_category->GetCategory();
100   return (entry.get() != nullptr);
101 }
102 
103 void DataVisualization::Categories::Add(ConstString category) {
104   GetFormatManager().GetCategory(category);
105 }
106 
107 bool DataVisualization::Categories::Delete(ConstString category) {
108   GetFormatManager().DisableCategory(category);
109   return GetFormatManager().DeleteCategory(category);
110 }
111 
112 void DataVisualization::Categories::Clear() {
113   GetFormatManager().ClearCategories();
114 }
115 
116 void DataVisualization::Categories::Clear(ConstString category) {
117   GetFormatManager().GetCategory(category)->Clear(
118       eFormatCategoryItemSummary | eFormatCategoryItemRegexSummary);
119 }
120 
121 void DataVisualization::Categories::Enable(ConstString category,
122                                            TypeCategoryMap::Position pos) {
123   if (GetFormatManager().GetCategory(category)->IsEnabled())
124     GetFormatManager().DisableCategory(category);
125   GetFormatManager().EnableCategory(category, pos, {});
126 }
127 
128 void DataVisualization::Categories::Enable(lldb::LanguageType lang_type) {
129   if (LanguageCategory *lang_category =
130           GetFormatManager().GetCategoryForLanguage(lang_type))
131     lang_category->Enable();
132 }
133 
134 void DataVisualization::Categories::Disable(ConstString category) {
135   if (GetFormatManager().GetCategory(category)->IsEnabled())
136     GetFormatManager().DisableCategory(category);
137 }
138 
139 void DataVisualization::Categories::Disable(lldb::LanguageType lang_type) {
140   if (LanguageCategory *lang_category =
141           GetFormatManager().GetCategoryForLanguage(lang_type))
142     lang_category->Disable();
143 }
144 
145 void DataVisualization::Categories::Enable(
146     const lldb::TypeCategoryImplSP &category, TypeCategoryMap::Position pos) {
147   if (category.get()) {
148     if (category->IsEnabled())
149       GetFormatManager().DisableCategory(category);
150     GetFormatManager().EnableCategory(category, pos);
151   }
152 }
153 
154 void DataVisualization::Categories::Disable(
155     const lldb::TypeCategoryImplSP &category) {
156   if (category.get() && category->IsEnabled())
157     GetFormatManager().DisableCategory(category);
158 }
159 
160 void DataVisualization::Categories::EnableStar() {
161   GetFormatManager().EnableAllCategories();
162 }
163 
164 void DataVisualization::Categories::DisableStar() {
165   GetFormatManager().DisableAllCategories();
166 }
167 
168 void DataVisualization::Categories::ForEach(
169     TypeCategoryMap::ForEachCallback callback) {
170   GetFormatManager().ForEachCategory(callback);
171 }
172 
173 uint32_t DataVisualization::Categories::GetCount() {
174   return GetFormatManager().GetCategoriesCount();
175 }
176 
177 lldb::TypeCategoryImplSP
178 DataVisualization::Categories::GetCategoryAtIndex(size_t index) {
179   return GetFormatManager().GetCategoryAtIndex(index);
180 }
181 
182 bool DataVisualization::NamedSummaryFormats::GetSummaryFormat(
183     ConstString type, lldb::TypeSummaryImplSP &entry) {
184   return GetFormatManager().GetNamedSummaryContainer().Get(type, entry);
185 }
186 
187 void DataVisualization::NamedSummaryFormats::Add(
188     ConstString type, const lldb::TypeSummaryImplSP &entry) {
189   GetFormatManager().GetNamedSummaryContainer().Add(
190       FormatManager::GetValidTypeName(type), entry);
191 }
192 
193 bool DataVisualization::NamedSummaryFormats::Delete(ConstString type) {
194   return GetFormatManager().GetNamedSummaryContainer().Delete(type);
195 }
196 
197 void DataVisualization::NamedSummaryFormats::Clear() {
198   GetFormatManager().GetNamedSummaryContainer().Clear();
199 }
200 
201 void DataVisualization::NamedSummaryFormats::ForEach(
202     std::function<bool(ConstString, const lldb::TypeSummaryImplSP &)>
203         callback) {
204   GetFormatManager().GetNamedSummaryContainer().ForEach(callback);
205 }
206 
207 uint32_t DataVisualization::NamedSummaryFormats::GetCount() {
208   return GetFormatManager().GetNamedSummaryContainer().GetCount();
209 }
210