Coverage Report

Created: 2022-01-18 06:27

/Users/buildslave/jenkins/workspace/coverage/llvm-project/lldb/include/lldb/DataFormatters/FormatManager.h
Line
Count
Source (jump to first uncovered line)
1
//===-- FormatManager.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_FORMATMANAGER_H
10
#define LLDB_DATAFORMATTERS_FORMATMANAGER_H
11
12
#include <atomic>
13
#include <initializer_list>
14
#include <map>
15
#include <mutex>
16
#include <vector>
17
18
#include "lldb/lldb-enumerations.h"
19
#include "lldb/lldb-public.h"
20
21
#include "lldb/DataFormatters/FormatCache.h"
22
#include "lldb/DataFormatters/FormatClasses.h"
23
#include "lldb/DataFormatters/FormattersContainer.h"
24
#include "lldb/DataFormatters/LanguageCategory.h"
25
#include "lldb/DataFormatters/TypeCategory.h"
26
#include "lldb/DataFormatters/TypeCategoryMap.h"
27
28
namespace lldb_private {
29
30
// this file (and its. cpp) contain the low-level implementation of LLDB Data
31
// Visualization class DataVisualization is the high-level front-end of this
32
// feature clients should refer to that class as the entry-point into the data
33
// formatters unless they have a good reason to bypass it and prefer to use
34
// this file's objects directly
35
36
class FormatManager : public IFormatChangeListener {
37
  typedef FormattersContainer<TypeSummaryImpl> NamedSummariesMap;
38
  typedef TypeCategoryMap::MapType::iterator CategoryMapIterator;
39
40
public:
41
  typedef std::map<lldb::LanguageType, LanguageCategory::UniquePointer>
42
      LanguageCategories;
43
44
  FormatManager();
45
46
662
  ~FormatManager() override = default;
47
48
401
  NamedSummariesMap &GetNamedSummaryContainer() {
49
401
    return m_named_summaries_map;
50
401
  }
51
52
  void
53
  EnableCategory(ConstString category_name,
54
0
                 TypeCategoryMap::Position pos = TypeCategoryMap::Default) {
55
0
    EnableCategory(category_name, pos, {});
56
0
  }
57
58
  void EnableCategory(ConstString category_name,
59
1.36k
                      TypeCategoryMap::Position pos, lldb::LanguageType lang) {
60
1.36k
    TypeCategoryMap::ValueSP category_sp;
61
1.36k
    if (m_categories_map.Get(category_name, category_sp) && category_sp) {
62
1.36k
      m_categories_map.Enable(category_sp, pos);
63
1.36k
      category_sp->AddLanguage(lang);
64
1.36k
    }
65
1.36k
  }
66
67
76
  void DisableCategory(ConstString category_name) {
68
76
    m_categories_map.Disable(category_name);
69
76
  }
70
71
  void
72
  EnableCategory(const lldb::TypeCategoryImplSP &category,
73
7
                 TypeCategoryMap::Position pos = TypeCategoryMap::Default) {
74
7
    m_categories_map.Enable(category, pos);
75
7
  }
76
77
2
  void DisableCategory(const lldb::TypeCategoryImplSP &category) {
78
2
    m_categories_map.Disable(category);
79
2
  }
80
81
  void EnableAllCategories();
82
83
  void DisableAllCategories();
84
85
61
  bool DeleteCategory(ConstString category_name) {
86
61
    return m_categories_map.Delete(category_name);
87
61
  }
88
89
0
  void ClearCategories() { return m_categories_map.Clear(); }
90
91
0
  uint32_t GetCategoriesCount() { return m_categories_map.GetCount(); }
92
93
232
  lldb::TypeCategoryImplSP GetCategoryAtIndex(size_t index) {
94
232
    return m_categories_map.GetAtIndex(index);
95
232
  }
96
97
  void ForEachCategory(TypeCategoryMap::ForEachCallback callback);
98
99
  lldb::TypeCategoryImplSP GetCategory(const char *category_name = nullptr,
100
0
                                       bool can_create = true) {
101
0
    if (!category_name)
102
0
      return GetCategory(m_default_category_name);
103
0
    return GetCategory(ConstString(category_name));
104
0
  }
105
106
  lldb::TypeCategoryImplSP GetCategory(ConstString category_name,
107
                                       bool can_create = true);
108
109
  lldb::TypeFormatImplSP
110
  GetFormatForType(lldb::TypeNameSpecifierImplSP type_sp);
111
112
  lldb::TypeSummaryImplSP
113
  GetSummaryForType(lldb::TypeNameSpecifierImplSP type_sp);
114
115
  lldb::TypeFilterImplSP
116
  GetFilterForType(lldb::TypeNameSpecifierImplSP type_sp);
117
118
  lldb::ScriptedSyntheticChildrenSP
119
  GetSyntheticForType(lldb::TypeNameSpecifierImplSP type_sp);
120
121
  lldb::TypeFormatImplSP GetFormat(ValueObject &valobj,
122
                                   lldb::DynamicValueType use_dynamic);
123
124
  lldb::TypeSummaryImplSP GetSummaryFormat(ValueObject &valobj,
125
                                           lldb::DynamicValueType use_dynamic);
126
127
  lldb::SyntheticChildrenSP
128
  GetSyntheticChildren(ValueObject &valobj, lldb::DynamicValueType use_dynamic);
129
130
  bool
131
  AnyMatches(ConstString type_name,
132
             TypeCategoryImpl::FormatCategoryItems items =
133
                 TypeCategoryImpl::ALL_ITEM_TYPES,
134
             bool only_enabled = true, const char **matching_category = nullptr,
135
0
             TypeCategoryImpl::FormatCategoryItems *matching_type = nullptr) {
136
0
    return m_categories_map.AnyMatches(type_name, items, only_enabled,
137
0
                                       matching_category, matching_type);
138
0
  }
139
140
  static bool GetFormatFromCString(const char *format_cstr,
141
                                   bool partial_match_ok, lldb::Format &format);
142
143
  static char GetFormatAsFormatChar(lldb::Format format);
144
145
  static const char *GetFormatAsCString(lldb::Format format);
146
147
  // when DataExtractor dumps a vectorOfT, it uses a predefined format for each
148
  // item this method returns it, or eFormatInvalid if vector_format is not a
149
  // vectorOf
150
  static lldb::Format GetSingleItemFormat(lldb::Format vector_format);
151
152
  // this returns true if the ValueObjectPrinter is *highly encouraged* to
153
  // actually represent this ValueObject in one-liner format If this object has
154
  // a summary formatter, however, we should not try and do one-lining, just
155
  // let the summary do the right thing
156
  bool ShouldPrintAsOneLiner(ValueObject &valobj);
157
158
  void Changed() override;
159
160
1.23M
  uint32_t GetCurrentRevision() override { return m_last_revision; }
161
162
  static FormattersMatchVector
163
21.9k
  GetPossibleMatches(ValueObject &valobj, lldb::DynamicValueType use_dynamic) {
164
21.9k
    FormattersMatchVector matches;
165
21.9k
    GetPossibleMatches(valobj, valobj.GetCompilerType(),
166
21.9k
                       use_dynamic, matches, false, false, false, true);
167
21.9k
    return matches;
168
21.9k
  }
169
170
  static ConstString GetTypeForCache(ValueObject &, lldb::DynamicValueType);
171
172
  LanguageCategory *GetCategoryForLanguage(lldb::LanguageType lang_type);
173
174
  static std::vector<lldb::LanguageType>
175
  GetCandidateLanguages(lldb::LanguageType lang_type);
176
177
private:
178
  static void GetPossibleMatches(ValueObject &valobj,
179
                                 CompilerType compiler_type,
180
                                 lldb::DynamicValueType use_dynamic,
181
                                 FormattersMatchVector &entries,
182
                                 bool did_strip_ptr, bool did_strip_ref,
183
                                 bool did_strip_typedef,
184
                                 bool root_level = false);
185
186
  std::atomic<uint32_t> m_last_revision;
187
  FormatCache m_format_cache;
188
  std::recursive_mutex m_language_categories_mutex;
189
  LanguageCategories m_language_categories_map;
190
  NamedSummariesMap m_named_summaries_map;
191
  TypeCategoryMap m_categories_map;
192
193
  ConstString m_default_category_name;
194
  ConstString m_system_category_name;
195
  ConstString m_vectortypes_category_name;
196
197
  template <typename ImplSP>
198
  ImplSP Get(ValueObject &valobj, lldb::DynamicValueType use_dynamic);
199
  template <typename ImplSP> ImplSP GetCached(FormattersMatchData &match_data);
200
  template <typename ImplSP> ImplSP GetHardcoded(FormattersMatchData &);
201
202
0
  TypeCategoryMap &GetCategories() { return m_categories_map; }
203
204
  // These functions are meant to initialize formatters that are very low-
205
  // level/global in nature and do not naturally belong in any language. The
206
  // intent is that most formatters go in language-specific categories.
207
  // Eventually, the runtimes should also be allowed to vend their own
208
  // formatters, and then one could put formatters that depend on specific
209
  // library load events in the language runtimes, on an as-needed basis
210
  void LoadSystemFormatters();
211
212
  void LoadVectorFormatters();
213
214
  friend class FormattersMatchData;
215
};
216
217
} // namespace lldb_private
218
219
#endif // LLDB_DATAFORMATTERS_FORMATMANAGER_H