1 //===-- CPlusPlusLanguage.cpp ---------------------------------------------===//
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 #include "CPlusPlusLanguage.h"
10 
11 #include <cctype>
12 #include <cstring>
13 
14 #include <functional>
15 #include <memory>
16 #include <mutex>
17 #include <set>
18 
19 #include "llvm/ADT/StringRef.h"
20 #include "llvm/Demangle/ItaniumDemangle.h"
21 
22 #include "lldb/Core/Mangled.h"
23 #include "lldb/Core/Module.h"
24 #include "lldb/Core/PluginManager.h"
25 #include "lldb/Core/UniqueCStringMap.h"
26 #include "lldb/DataFormatters/CXXFunctionPointer.h"
27 #include "lldb/DataFormatters/DataVisualization.h"
28 #include "lldb/DataFormatters/FormattersHelpers.h"
29 #include "lldb/DataFormatters/VectorType.h"
30 #include "lldb/Symbol/SymbolFile.h"
31 #include "lldb/Utility/ConstString.h"
32 #include "lldb/Utility/Log.h"
33 #include "lldb/Utility/RegularExpression.h"
34 
35 #include "BlockPointer.h"
36 #include "CPlusPlusNameParser.h"
37 #include "CxxStringTypes.h"
38 #include "LibCxx.h"
39 #include "LibCxxAtomic.h"
40 #include "LibCxxVariant.h"
41 #include "LibStdcpp.h"
42 #include "MSVCUndecoratedNameParser.h"
43 
44 using namespace lldb;
45 using namespace lldb_private;
46 using namespace lldb_private::formatters;
47 
48 LLDB_PLUGIN_DEFINE(CPlusPlusLanguage)
49 
50 void CPlusPlusLanguage::Initialize() {
51   PluginManager::RegisterPlugin(GetPluginNameStatic(), "C++ Language",
52                                 CreateInstance);
53 }
54 
55 void CPlusPlusLanguage::Terminate() {
56   PluginManager::UnregisterPlugin(CreateInstance);
57 }
58 
59 lldb_private::ConstString CPlusPlusLanguage::GetPluginNameStatic() {
60   static ConstString g_name("cplusplus");
61   return g_name;
62 }
63 
64 bool CPlusPlusLanguage::SymbolNameFitsToLanguage(Mangled mangled) const {
65   const char *mangled_name = mangled.GetMangledName().GetCString();
66   return mangled_name && CPlusPlusLanguage::IsCPPMangledName(mangled_name);
67 }
68 
69 ConstString CPlusPlusLanguage::GetDemangledFunctionNameWithoutArguments(
70     Mangled mangled) const {
71   const char *mangled_name_cstr = mangled.GetMangledName().GetCString();
72   ConstString demangled_name = mangled.GetDemangledName();
73   if (demangled_name && mangled_name_cstr && mangled_name_cstr[0]) {
74     if (mangled_name_cstr[0] == '_' && mangled_name_cstr[1] == 'Z' &&
75         (mangled_name_cstr[2] != 'T' && // avoid virtual table, VTT structure,
76                                         // typeinfo structure, and typeinfo
77                                         // mangled_name
78          mangled_name_cstr[2] != 'G' && // avoid guard variables
79          mangled_name_cstr[2] != 'Z'))  // named local entities (if we
80                                         // eventually handle eSymbolTypeData,
81                                         // we will want this back)
82     {
83       CPlusPlusLanguage::MethodName cxx_method(demangled_name);
84       if (!cxx_method.GetBasename().empty()) {
85         std::string shortname;
86         if (!cxx_method.GetContext().empty())
87           shortname = cxx_method.GetContext().str() + "::";
88         shortname += cxx_method.GetBasename().str();
89         return ConstString(shortname);
90       }
91     }
92   }
93   if (demangled_name)
94     return demangled_name;
95   return mangled.GetMangledName();
96 }
97 
98 // Static Functions
99 
100 Language *CPlusPlusLanguage::CreateInstance(lldb::LanguageType language) {
101   // Use plugin for C++ but not for Objective-C++ (which has its own plugin).
102   if (Language::LanguageIsCPlusPlus(language) &&
103       language != eLanguageTypeObjC_plus_plus)
104     return new CPlusPlusLanguage();
105   return nullptr;
106 }
107 
108 void CPlusPlusLanguage::MethodName::Clear() {
109   m_full.Clear();
110   m_basename = llvm::StringRef();
111   m_context = llvm::StringRef();
112   m_arguments = llvm::StringRef();
113   m_qualifiers = llvm::StringRef();
114   m_parsed = false;
115   m_parse_error = false;
116 }
117 
118 static bool ReverseFindMatchingChars(const llvm::StringRef &s,
119                                      const llvm::StringRef &left_right_chars,
120                                      size_t &left_pos, size_t &right_pos,
121                                      size_t pos = llvm::StringRef::npos) {
122   assert(left_right_chars.size() == 2);
123   left_pos = llvm::StringRef::npos;
124   const char left_char = left_right_chars[0];
125   const char right_char = left_right_chars[1];
126   pos = s.find_last_of(left_right_chars, pos);
127   if (pos == llvm::StringRef::npos || s[pos] == left_char)
128     return false;
129   right_pos = pos;
130   uint32_t depth = 1;
131   while (pos > 0 && depth > 0) {
132     pos = s.find_last_of(left_right_chars, pos);
133     if (pos == llvm::StringRef::npos)
134       return false;
135     if (s[pos] == left_char) {
136       if (--depth == 0) {
137         left_pos = pos;
138         return left_pos < right_pos;
139       }
140     } else if (s[pos] == right_char) {
141       ++depth;
142     }
143   }
144   return false;
145 }
146 
147 static bool IsTrivialBasename(const llvm::StringRef &basename) {
148   // Check that the basename matches with the following regular expression
149   // "^~?([A-Za-z_][A-Za-z_0-9]*)$" We are using a hand written implementation
150   // because it is significantly more efficient then using the general purpose
151   // regular expression library.
152   size_t idx = 0;
153   if (basename.size() > 0 && basename[0] == '~')
154     idx = 1;
155 
156   if (basename.size() <= idx)
157     return false; // Empty string or "~"
158 
159   if (!std::isalpha(basename[idx]) && basename[idx] != '_')
160     return false; // First character (after removing the possible '~'') isn't in
161                   // [A-Za-z_]
162 
163   // Read all characters matching [A-Za-z_0-9]
164   ++idx;
165   while (idx < basename.size()) {
166     if (!std::isalnum(basename[idx]) && basename[idx] != '_')
167       break;
168     ++idx;
169   }
170 
171   // We processed all characters. It is a vaild basename.
172   return idx == basename.size();
173 }
174 
175 bool CPlusPlusLanguage::MethodName::TrySimplifiedParse() {
176   // This method tries to parse simple method definitions which are presumably
177   // most comman in user programs. Definitions that can be parsed by this
178   // function don't have return types and templates in the name.
179   // A::B::C::fun(std::vector<T> &) const
180   size_t arg_start, arg_end;
181   llvm::StringRef full(m_full.GetCString());
182   llvm::StringRef parens("()", 2);
183   if (ReverseFindMatchingChars(full, parens, arg_start, arg_end)) {
184     m_arguments = full.substr(arg_start, arg_end - arg_start + 1);
185     if (arg_end + 1 < full.size())
186       m_qualifiers = full.substr(arg_end + 1).ltrim();
187 
188     if (arg_start == 0)
189       return false;
190     size_t basename_end = arg_start;
191     size_t context_start = 0;
192     size_t context_end = full.rfind(':', basename_end);
193     if (context_end == llvm::StringRef::npos)
194       m_basename = full.substr(0, basename_end);
195     else {
196       if (context_start < context_end)
197         m_context = full.substr(context_start, context_end - 1 - context_start);
198       const size_t basename_begin = context_end + 1;
199       m_basename = full.substr(basename_begin, basename_end - basename_begin);
200     }
201 
202     if (IsTrivialBasename(m_basename)) {
203       return true;
204     } else {
205       // The C++ basename doesn't match our regular expressions so this can't
206       // be a valid C++ method, clear everything out and indicate an error
207       m_context = llvm::StringRef();
208       m_basename = llvm::StringRef();
209       m_arguments = llvm::StringRef();
210       m_qualifiers = llvm::StringRef();
211       return false;
212     }
213   }
214   return false;
215 }
216 
217 void CPlusPlusLanguage::MethodName::Parse() {
218   if (!m_parsed && m_full) {
219     if (TrySimplifiedParse()) {
220       m_parse_error = false;
221     } else {
222       CPlusPlusNameParser parser(m_full.GetStringRef());
223       if (auto function = parser.ParseAsFunctionDefinition()) {
224         m_basename = function.getValue().name.basename;
225         m_context = function.getValue().name.context;
226         m_arguments = function.getValue().arguments;
227         m_qualifiers = function.getValue().qualifiers;
228         m_parse_error = false;
229       } else {
230         m_parse_error = true;
231       }
232     }
233     m_parsed = true;
234   }
235 }
236 
237 llvm::StringRef CPlusPlusLanguage::MethodName::GetBasename() {
238   if (!m_parsed)
239     Parse();
240   return m_basename;
241 }
242 
243 llvm::StringRef CPlusPlusLanguage::MethodName::GetContext() {
244   if (!m_parsed)
245     Parse();
246   return m_context;
247 }
248 
249 llvm::StringRef CPlusPlusLanguage::MethodName::GetArguments() {
250   if (!m_parsed)
251     Parse();
252   return m_arguments;
253 }
254 
255 llvm::StringRef CPlusPlusLanguage::MethodName::GetQualifiers() {
256   if (!m_parsed)
257     Parse();
258   return m_qualifiers;
259 }
260 
261 std::string CPlusPlusLanguage::MethodName::GetScopeQualifiedName() {
262   if (!m_parsed)
263     Parse();
264   if (m_context.empty())
265     return std::string(m_basename);
266 
267   std::string res;
268   res += m_context;
269   res += "::";
270   res += m_basename;
271   return res;
272 }
273 
274 bool CPlusPlusLanguage::IsCPPMangledName(llvm::StringRef name) {
275   // FIXME!! we should really run through all the known C++ Language plugins
276   // and ask each one if this is a C++ mangled name
277 
278   Mangled::ManglingScheme scheme = Mangled::GetManglingScheme(name);
279 
280   if (scheme == Mangled::eManglingSchemeNone)
281     return false;
282 
283   return true;
284 }
285 
286 bool CPlusPlusLanguage::ExtractContextAndIdentifier(
287     const char *name, llvm::StringRef &context, llvm::StringRef &identifier) {
288   if (MSVCUndecoratedNameParser::IsMSVCUndecoratedName(name))
289     return MSVCUndecoratedNameParser::ExtractContextAndIdentifier(name, context,
290                                                                   identifier);
291 
292   CPlusPlusNameParser parser(name);
293   if (auto full_name = parser.ParseAsFullName()) {
294     identifier = full_name.getValue().basename;
295     context = full_name.getValue().context;
296     return true;
297   }
298   return false;
299 }
300 
301 namespace {
302 class NodeAllocator {
303   llvm::BumpPtrAllocator Alloc;
304 
305 public:
306   void reset() { Alloc.Reset(); }
307 
308   template <typename T, typename... Args> T *makeNode(Args &&... args) {
309     return new (Alloc.Allocate(sizeof(T), alignof(T)))
310         T(std::forward<Args>(args)...);
311   }
312 
313   void *allocateNodeArray(size_t sz) {
314     return Alloc.Allocate(sizeof(llvm::itanium_demangle::Node *) * sz,
315                           alignof(llvm::itanium_demangle::Node *));
316   }
317 };
318 
319 template <typename Derived>
320 class ManglingSubstitutor
321     : public llvm::itanium_demangle::AbstractManglingParser<Derived,
322                                                             NodeAllocator> {
323   using Base =
324       llvm::itanium_demangle::AbstractManglingParser<Derived, NodeAllocator>;
325 
326 public:
327   ManglingSubstitutor() : Base(nullptr, nullptr) {}
328 
329   template <typename... Ts>
330   ConstString substitute(llvm::StringRef Mangled, Ts &&... Vals) {
331     this->getDerived().reset(Mangled, std::forward<Ts>(Vals)...);
332     return substituteImpl(Mangled);
333   }
334 
335 protected:
336   void reset(llvm::StringRef Mangled) {
337     Base::reset(Mangled.begin(), Mangled.end());
338     Written = Mangled.begin();
339     Result.clear();
340     Substituted = false;
341   }
342 
343   ConstString substituteImpl(llvm::StringRef Mangled) {
344     Log *log = GetLogIfAllCategoriesSet(LIBLLDB_LOG_LANGUAGE);
345     if (this->parse() == nullptr) {
346       LLDB_LOG(log, "Failed to substitute mangling in {0}", Mangled);
347       return ConstString();
348     }
349     if (!Substituted)
350       return ConstString();
351 
352     // Append any trailing unmodified input.
353     appendUnchangedInput();
354     LLDB_LOG(log, "Substituted mangling {0} -> {1}", Mangled, Result);
355     return ConstString(Result);
356   }
357 
358   void trySubstitute(llvm::StringRef From, llvm::StringRef To) {
359     if (!llvm::StringRef(currentParserPos(), this->numLeft()).startswith(From))
360       return;
361 
362     // We found a match. Append unmodified input up to this point.
363     appendUnchangedInput();
364 
365     // And then perform the replacement.
366     Result += To;
367     Written += From.size();
368     Substituted = true;
369   }
370 
371 private:
372   /// Input character until which we have constructed the respective output
373   /// already.
374   const char *Written;
375 
376   llvm::SmallString<128> Result;
377 
378   /// Whether we have performed any substitutions.
379   bool Substituted;
380 
381   const char *currentParserPos() const { return this->First; }
382 
383   void appendUnchangedInput() {
384     Result +=
385         llvm::StringRef(Written, std::distance(Written, currentParserPos()));
386     Written = currentParserPos();
387   }
388 };
389 
390 /// Given a mangled function `Mangled`, replace all the primitive function type
391 /// arguments of `Search` with type `Replace`.
392 class TypeSubstitutor : public ManglingSubstitutor<TypeSubstitutor> {
393   llvm::StringRef Search;
394   llvm::StringRef Replace;
395 
396 public:
397   void reset(llvm::StringRef Mangled, llvm::StringRef Search,
398              llvm::StringRef Replace) {
399     ManglingSubstitutor::reset(Mangled);
400     this->Search = Search;
401     this->Replace = Replace;
402   }
403 
404   llvm::itanium_demangle::Node *parseType() {
405     trySubstitute(Search, Replace);
406     return ManglingSubstitutor::parseType();
407   }
408 };
409 
410 class CtorDtorSubstitutor : public ManglingSubstitutor<CtorDtorSubstitutor> {
411 public:
412   llvm::itanium_demangle::Node *
413   parseCtorDtorName(llvm::itanium_demangle::Node *&SoFar, NameState *State) {
414     trySubstitute("C1", "C2");
415     trySubstitute("D1", "D2");
416     return ManglingSubstitutor::parseCtorDtorName(SoFar, State);
417   }
418 };
419 } // namespace
420 
421 std::vector<ConstString> CPlusPlusLanguage::GenerateAlternateFunctionManglings(
422     const ConstString mangled_name) const {
423   std::vector<ConstString> alternates;
424 
425   /// Get a basic set of alternative manglings for the given symbol `name`, by
426   /// making a few basic possible substitutions on basic types, storage duration
427   /// and `const`ness for the given symbol. The output parameter `alternates`
428   /// is filled with a best-guess, non-exhaustive set of different manglings
429   /// for the given name.
430 
431   // Maybe we're looking for a const symbol but the debug info told us it was
432   // non-const...
433   if (!strncmp(mangled_name.GetCString(), "_ZN", 3) &&
434       strncmp(mangled_name.GetCString(), "_ZNK", 4)) {
435     std::string fixed_scratch("_ZNK");
436     fixed_scratch.append(mangled_name.GetCString() + 3);
437     alternates.push_back(ConstString(fixed_scratch));
438   }
439 
440   // Maybe we're looking for a static symbol but we thought it was global...
441   if (!strncmp(mangled_name.GetCString(), "_Z", 2) &&
442       strncmp(mangled_name.GetCString(), "_ZL", 3)) {
443     std::string fixed_scratch("_ZL");
444     fixed_scratch.append(mangled_name.GetCString() + 2);
445     alternates.push_back(ConstString(fixed_scratch));
446   }
447 
448   TypeSubstitutor TS;
449   // `char` is implementation defined as either `signed` or `unsigned`.  As a
450   // result a char parameter has 3 possible manglings: 'c'-char, 'a'-signed
451   // char, 'h'-unsigned char.  If we're looking for symbols with a signed char
452   // parameter, try finding matches which have the general case 'c'.
453   if (ConstString char_fixup =
454           TS.substitute(mangled_name.GetStringRef(), "a", "c"))
455     alternates.push_back(char_fixup);
456 
457   // long long parameter mangling 'x', may actually just be a long 'l' argument
458   if (ConstString long_fixup =
459           TS.substitute(mangled_name.GetStringRef(), "x", "l"))
460     alternates.push_back(long_fixup);
461 
462   // unsigned long long parameter mangling 'y', may actually just be unsigned
463   // long 'm' argument
464   if (ConstString ulong_fixup =
465           TS.substitute(mangled_name.GetStringRef(), "y", "m"))
466     alternates.push_back(ulong_fixup);
467 
468   if (ConstString ctor_fixup =
469           CtorDtorSubstitutor().substitute(mangled_name.GetStringRef()))
470     alternates.push_back(ctor_fixup);
471 
472   return alternates;
473 }
474 
475 ConstString CPlusPlusLanguage::FindBestAlternateFunctionMangledName(
476     const Mangled mangled, const SymbolContext &sym_ctx) const {
477   ConstString demangled = mangled.GetDemangledName();
478   if (!demangled)
479     return ConstString();
480 
481   CPlusPlusLanguage::MethodName cpp_name(demangled);
482   std::string scope_qualified_name = cpp_name.GetScopeQualifiedName();
483 
484   if (!scope_qualified_name.size())
485     return ConstString();
486 
487   if (!sym_ctx.module_sp)
488     return ConstString();
489 
490   lldb_private::SymbolFile *sym_file = sym_ctx.module_sp->GetSymbolFile();
491   if (!sym_file)
492     return ConstString();
493 
494   std::vector<ConstString> alternates;
495   sym_file->GetMangledNamesForFunction(scope_qualified_name, alternates);
496 
497   std::vector<ConstString> param_and_qual_matches;
498   std::vector<ConstString> param_matches;
499   for (size_t i = 0; i < alternates.size(); i++) {
500     ConstString alternate_mangled_name = alternates[i];
501     Mangled mangled(alternate_mangled_name);
502     ConstString demangled = mangled.GetDemangledName();
503 
504     CPlusPlusLanguage::MethodName alternate_cpp_name(demangled);
505     if (!cpp_name.IsValid())
506       continue;
507 
508     if (alternate_cpp_name.GetArguments() == cpp_name.GetArguments()) {
509       if (alternate_cpp_name.GetQualifiers() == cpp_name.GetQualifiers())
510         param_and_qual_matches.push_back(alternate_mangled_name);
511       else
512         param_matches.push_back(alternate_mangled_name);
513     }
514   }
515 
516   if (param_and_qual_matches.size())
517     return param_and_qual_matches[0]; // It is assumed that there will be only
518                                       // one!
519   else if (param_matches.size())
520     return param_matches[0]; // Return one of them as a best match
521   else
522     return ConstString();
523 }
524 
525 static void LoadLibCxxFormatters(lldb::TypeCategoryImplSP cpp_category_sp) {
526   if (!cpp_category_sp)
527     return;
528 
529   TypeSummaryImpl::Flags stl_summary_flags;
530   stl_summary_flags.SetCascades(true)
531       .SetSkipPointers(false)
532       .SetSkipReferences(false)
533       .SetDontShowChildren(true)
534       .SetDontShowValue(true)
535       .SetShowMembersOneLiner(false)
536       .SetHideItemNames(false);
537 
538   AddCXXSummary(cpp_category_sp,
539                 lldb_private::formatters::LibcxxStringSummaryProviderASCII,
540                 "std::string summary provider",
541                 ConstString("^std::__[[:alnum:]]+::string$"), stl_summary_flags,
542                 true);
543   AddCXXSummary(cpp_category_sp,
544                 lldb_private::formatters::LibcxxStringSummaryProviderASCII,
545                 "std::string summary provider",
546                 ConstString("^std::__[[:alnum:]]+::basic_string<char, "
547                             "std::__[[:alnum:]]+::char_traits<char>, "
548                             "std::__[[:alnum:]]+::allocator<char> >$"),
549                 stl_summary_flags, true);
550   AddCXXSummary(cpp_category_sp,
551                 lldb_private::formatters::LibcxxStringSummaryProviderASCII,
552                 "std::string summary provider",
553                 ConstString("^std::__[[:alnum:]]+::basic_string<unsigned char, "
554                             "std::__[[:alnum:]]+::char_traits<unsigned char>, "
555                             "std::__[[:alnum:]]+::allocator<unsigned char> >$"),
556                 stl_summary_flags, true);
557 
558   AddCXXSummary(cpp_category_sp,
559                 lldb_private::formatters::LibcxxStringSummaryProviderUTF16,
560                 "std::u16string summary provider",
561                 ConstString("^std::__[[:alnum:]]+::basic_string<char16_t, "
562                             "std::__[[:alnum:]]+::char_traits<char16_t>, "
563                             "std::__[[:alnum:]]+::allocator<char16_t> >$"),
564                 stl_summary_flags, true);
565 
566   AddCXXSummary(cpp_category_sp,
567                 lldb_private::formatters::LibcxxStringSummaryProviderUTF32,
568                 "std::u32string summary provider",
569                 ConstString("^std::__[[:alnum:]]+::basic_string<char32_t, "
570                             "std::__[[:alnum:]]+::char_traits<char32_t>, "
571                             "std::__[[:alnum:]]+::allocator<char32_t> >$"),
572                 stl_summary_flags, true);
573 
574   AddCXXSummary(
575       cpp_category_sp, lldb_private::formatters::LibcxxWStringSummaryProvider,
576       "std::wstring summary provider",
577       ConstString("^std::__[[:alnum:]]+::wstring$"), stl_summary_flags, true);
578   AddCXXSummary(cpp_category_sp,
579                 lldb_private::formatters::LibcxxWStringSummaryProvider,
580                 "std::wstring summary provider",
581                 ConstString("^std::__[[:alnum:]]+::basic_string<wchar_t, "
582                             "std::__[[:alnum:]]+::char_traits<wchar_t>, "
583                             "std::__[[:alnum:]]+::allocator<wchar_t> >$"),
584                 stl_summary_flags, true);
585 
586   SyntheticChildren::Flags stl_synth_flags;
587   stl_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences(
588       false);
589   SyntheticChildren::Flags stl_deref_flags = stl_synth_flags;
590   stl_deref_flags.SetFrontEndWantsDereference();
591 
592   AddCXXSynthetic(
593       cpp_category_sp,
594       lldb_private::formatters::LibcxxBitsetSyntheticFrontEndCreator,
595       "libc++ std::bitset synthetic children",
596       ConstString("^std::__[[:alnum:]]+::bitset<.+>(( )?&)?$"), stl_deref_flags,
597       true);
598   AddCXXSynthetic(
599       cpp_category_sp,
600       lldb_private::formatters::LibcxxStdVectorSyntheticFrontEndCreator,
601       "libc++ std::vector synthetic children",
602       ConstString("^std::__[[:alnum:]]+::vector<.+>(( )?&)?$"), stl_deref_flags,
603       true);
604   AddCXXSynthetic(
605       cpp_category_sp,
606       lldb_private::formatters::LibcxxStdForwardListSyntheticFrontEndCreator,
607       "libc++ std::forward_list synthetic children",
608       ConstString("^std::__[[:alnum:]]+::forward_list<.+>(( )?&)?$"),
609       stl_synth_flags, true);
610   AddCXXSynthetic(
611       cpp_category_sp,
612       lldb_private::formatters::LibcxxStdListSyntheticFrontEndCreator,
613       "libc++ std::list synthetic children",
614       // A POSIX variant of: "^std::__(?!cxx11:)[[:alnum:]]+::list<.+>(( )?&)?$"
615       // so that it does not clash with: "^std::(__cxx11::)?list<.+>(( )?&)?$"
616       ConstString("^std::__([A-Zabd-z0-9]|cx?[A-Za-wyz0-9]|cxx1?[A-Za-z02-9]|"
617                   "cxx11[[:alnum:]])[[:alnum:]]*::list<.+>(( )?&)?$"),
618       stl_deref_flags, true);
619   AddCXXSynthetic(
620       cpp_category_sp,
621       lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator,
622       "libc++ std::map synthetic children",
623       ConstString("^std::__[[:alnum:]]+::map<.+> >(( )?&)?$"), stl_synth_flags,
624       true);
625   AddCXXSynthetic(
626       cpp_category_sp,
627       lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator,
628       "libc++ std::set synthetic children",
629       ConstString("^std::__[[:alnum:]]+::set<.+> >(( )?&)?$"), stl_deref_flags,
630       true);
631   AddCXXSynthetic(
632       cpp_category_sp,
633       lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator,
634       "libc++ std::multiset synthetic children",
635       ConstString("^std::__[[:alnum:]]+::multiset<.+> >(( )?&)?$"),
636       stl_deref_flags, true);
637   AddCXXSynthetic(
638       cpp_category_sp,
639       lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator,
640       "libc++ std::multimap synthetic children",
641       ConstString("^std::__[[:alnum:]]+::multimap<.+> >(( )?&)?$"),
642       stl_synth_flags, true);
643   AddCXXSynthetic(
644       cpp_category_sp,
645       lldb_private::formatters::LibcxxStdUnorderedMapSyntheticFrontEndCreator,
646       "libc++ std::unordered containers synthetic children",
647       ConstString("^(std::__[[:alnum:]]+::)unordered_(multi)?(map|set)<.+> >$"),
648       stl_synth_flags, true);
649   AddCXXSynthetic(
650       cpp_category_sp,
651       lldb_private::formatters::LibcxxInitializerListSyntheticFrontEndCreator,
652       "libc++ std::initializer_list synthetic children",
653       ConstString("^std::initializer_list<.+>(( )?&)?$"), stl_synth_flags,
654       true);
655   AddCXXSynthetic(cpp_category_sp, LibcxxQueueFrontEndCreator,
656                   "libc++ std::queue synthetic children",
657                   ConstString("^std::__[[:alnum:]]+::queue<.+>(( )?&)?$"),
658                   stl_synth_flags, true);
659   AddCXXSynthetic(cpp_category_sp, LibcxxTupleFrontEndCreator,
660                   "libc++ std::tuple synthetic children",
661                   ConstString("^std::__[[:alnum:]]+::tuple<.*>(( )?&)?$"),
662                   stl_synth_flags, true);
663   AddCXXSynthetic(cpp_category_sp, LibcxxOptionalFrontEndCreator,
664                   "libc++ std::optional synthetic children",
665                   ConstString("^std::__[[:alnum:]]+::optional<.+>(( )?&)?$"),
666                   stl_synth_flags, true);
667   AddCXXSynthetic(cpp_category_sp, LibcxxVariantFrontEndCreator,
668                   "libc++ std::variant synthetic children",
669                   ConstString("^std::__[[:alnum:]]+::variant<.+>(( )?&)?$"),
670                   stl_synth_flags, true);
671   AddCXXSynthetic(
672       cpp_category_sp,
673       lldb_private::formatters::LibcxxAtomicSyntheticFrontEndCreator,
674       "libc++ std::atomic synthetic children",
675       ConstString("^std::__[[:alnum:]]+::atomic<.+>$"), stl_synth_flags, true);
676 
677   cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add(
678       RegularExpression("^(std::__[[:alnum:]]+::)deque<.+>(( )?&)?$"),
679       SyntheticChildrenSP(new ScriptedSyntheticChildren(
680           stl_synth_flags,
681           "lldb.formatters.cpp.libcxx.stddeque_SynthProvider")));
682 
683   AddCXXSynthetic(
684       cpp_category_sp,
685       lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator,
686       "shared_ptr synthetic children",
687       ConstString("^(std::__[[:alnum:]]+::)shared_ptr<.+>(( )?&)?$"),
688       stl_synth_flags, true);
689 
690   ConstString libcxx_std_unique_ptr_regex(
691       "^std::__[[:alnum:]]+::unique_ptr<.+>(( )?&)?$");
692   AddCXXSynthetic(
693       cpp_category_sp,
694       lldb_private::formatters::LibcxxUniquePtrSyntheticFrontEndCreator,
695       "unique_ptr synthetic children", libcxx_std_unique_ptr_regex,
696       stl_synth_flags, true);
697 
698   AddCXXSynthetic(
699       cpp_category_sp,
700       lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator,
701       "weak_ptr synthetic children",
702       ConstString("^(std::__[[:alnum:]]+::)weak_ptr<.+>(( )?&)?$"),
703       stl_synth_flags, true);
704   AddCXXSummary(cpp_category_sp,
705                 lldb_private::formatters::LibcxxFunctionSummaryProvider,
706                 "libc++ std::function summary provider",
707                 ConstString("^std::__[[:alnum:]]+::function<.+>$"),
708                 stl_summary_flags, true);
709 
710   stl_summary_flags.SetDontShowChildren(false);
711   stl_summary_flags.SetSkipPointers(false);
712   AddCXXSummary(cpp_category_sp,
713                 lldb_private::formatters::LibcxxContainerSummaryProvider,
714                 "libc++ std::bitset summary provider",
715                 ConstString("^std::__[[:alnum:]]+::bitset<.+>(( )?&)?$"),
716                 stl_summary_flags, true);
717   AddCXXSummary(cpp_category_sp,
718                 lldb_private::formatters::LibcxxContainerSummaryProvider,
719                 "libc++ std::vector summary provider",
720                 ConstString("^std::__[[:alnum:]]+::vector<.+>(( )?&)?$"),
721                 stl_summary_flags, true);
722   AddCXXSummary(cpp_category_sp,
723                 lldb_private::formatters::LibcxxContainerSummaryProvider,
724                 "libc++ std::list summary provider",
725                 ConstString("^std::__[[:alnum:]]+::forward_list<.+>(( )?&)?$"),
726                 stl_summary_flags, true);
727   AddCXXSummary(
728       cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider,
729       "libc++ std::list summary provider",
730       // A POSIX variant of: "^std::__(?!cxx11:)[[:alnum:]]+::list<.+>(( )?&)?$"
731       // so that it does not clash with: "^std::(__cxx11::)?list<.+>(( )?&)?$"
732       ConstString("^std::__([A-Zabd-z0-9]|cx?[A-Za-wyz0-9]|cxx1?[A-Za-z02-9]|"
733                   "cxx11[[:alnum:]])[[:alnum:]]*::list<.+>(( )?&)?$"),
734       stl_summary_flags, true);
735   AddCXXSummary(cpp_category_sp,
736                 lldb_private::formatters::LibcxxContainerSummaryProvider,
737                 "libc++ std::map summary provider",
738                 ConstString("^std::__[[:alnum:]]+::map<.+>(( )?&)?$"),
739                 stl_summary_flags, true);
740   AddCXXSummary(cpp_category_sp,
741                 lldb_private::formatters::LibcxxContainerSummaryProvider,
742                 "libc++ std::deque summary provider",
743                 ConstString("^std::__[[:alnum:]]+::deque<.+>(( )?&)?$"),
744                 stl_summary_flags, true);
745   AddCXXSummary(cpp_category_sp,
746                 lldb_private::formatters::LibcxxContainerSummaryProvider,
747                 "libc++ std::queue summary provider",
748                 ConstString("^std::__[[:alnum:]]+::queue<.+>(( )?&)?$"),
749                 stl_summary_flags, true);
750   AddCXXSummary(cpp_category_sp,
751                 lldb_private::formatters::LibcxxContainerSummaryProvider,
752                 "libc++ std::set summary provider",
753                 ConstString("^std::__[[:alnum:]]+::set<.+>(( )?&)?$"),
754                 stl_summary_flags, true);
755   AddCXXSummary(cpp_category_sp,
756                 lldb_private::formatters::LibcxxContainerSummaryProvider,
757                 "libc++ std::multiset summary provider",
758                 ConstString("^std::__[[:alnum:]]+::multiset<.+>(( )?&)?$"),
759                 stl_summary_flags, true);
760   AddCXXSummary(cpp_category_sp,
761                 lldb_private::formatters::LibcxxContainerSummaryProvider,
762                 "libc++ std::multimap summary provider",
763                 ConstString("^std::__[[:alnum:]]+::multimap<.+>(( )?&)?$"),
764                 stl_summary_flags, true);
765   AddCXXSummary(
766       cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider,
767       "libc++ std::unordered containers summary provider",
768       ConstString("^(std::__[[:alnum:]]+::)unordered_(multi)?(map|set)<.+> >$"),
769       stl_summary_flags, true);
770   AddCXXSummary(cpp_category_sp, LibcxxContainerSummaryProvider,
771                 "libc++ std::tuple summary provider",
772                 ConstString("^std::__[[:alnum:]]+::tuple<.*>(( )?&)?$"),
773                 stl_summary_flags, true);
774   AddCXXSummary(cpp_category_sp,
775                 lldb_private::formatters::LibCxxAtomicSummaryProvider,
776                 "libc++ std::atomic summary provider",
777                 ConstString("^std::__[[:alnum:]]+::atomic<.+>$"),
778                 stl_summary_flags, true);
779   AddCXXSummary(cpp_category_sp,
780                 lldb_private::formatters::LibcxxOptionalSummaryProvider,
781                 "libc++ std::optional summary provider",
782                 ConstString("^std::__[[:alnum:]]+::optional<.+>(( )?&)?$"),
783                 stl_summary_flags, true);
784   AddCXXSummary(cpp_category_sp,
785                 lldb_private::formatters::LibcxxVariantSummaryProvider,
786                 "libc++ std::variant summary provider",
787                 ConstString("^std::__[[:alnum:]]+::variant<.+>(( )?&)?$"),
788                 stl_summary_flags, true);
789 
790   stl_summary_flags.SetSkipPointers(true);
791 
792   AddCXXSummary(cpp_category_sp,
793                 lldb_private::formatters::LibcxxSmartPointerSummaryProvider,
794                 "libc++ std::shared_ptr summary provider",
795                 ConstString("^std::__[[:alnum:]]+::shared_ptr<.+>(( )?&)?$"),
796                 stl_summary_flags, true);
797   AddCXXSummary(cpp_category_sp,
798                 lldb_private::formatters::LibcxxSmartPointerSummaryProvider,
799                 "libc++ std::weak_ptr summary provider",
800                 ConstString("^std::__[[:alnum:]]+::weak_ptr<.+>(( )?&)?$"),
801                 stl_summary_flags, true);
802   AddCXXSummary(cpp_category_sp,
803                 lldb_private::formatters::LibcxxUniquePointerSummaryProvider,
804                 "libc++ std::unique_ptr summary provider",
805                 libcxx_std_unique_ptr_regex, stl_summary_flags, true);
806 
807   AddCXXSynthetic(
808       cpp_category_sp,
809       lldb_private::formatters::LibCxxVectorIteratorSyntheticFrontEndCreator,
810       "std::vector iterator synthetic children",
811       ConstString("^std::__[[:alnum:]]+::__wrap_iter<.+>$"), stl_synth_flags,
812       true);
813 
814   AddCXXSynthetic(
815       cpp_category_sp,
816       lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEndCreator,
817       "std::map iterator synthetic children",
818       ConstString("^std::__[[:alnum:]]+::__map_iterator<.+>$"), stl_synth_flags,
819       true);
820 }
821 
822 static void LoadLibStdcppFormatters(lldb::TypeCategoryImplSP cpp_category_sp) {
823   if (!cpp_category_sp)
824     return;
825 
826   TypeSummaryImpl::Flags stl_summary_flags;
827   stl_summary_flags.SetCascades(true)
828       .SetSkipPointers(false)
829       .SetSkipReferences(false)
830       .SetDontShowChildren(true)
831       .SetDontShowValue(true)
832       .SetShowMembersOneLiner(false)
833       .SetHideItemNames(false);
834 
835   lldb::TypeSummaryImplSP std_string_summary_sp(
836       new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p}"));
837 
838   lldb::TypeSummaryImplSP cxx11_string_summary_sp(new CXXFunctionSummaryFormat(
839       stl_summary_flags, LibStdcppStringSummaryProvider,
840       "libstdc++ c++11 std::string summary provider"));
841   lldb::TypeSummaryImplSP cxx11_wstring_summary_sp(new CXXFunctionSummaryFormat(
842       stl_summary_flags, LibStdcppWStringSummaryProvider,
843       "libstdc++ c++11 std::wstring summary provider"));
844 
845   cpp_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::string"),
846                                                     std_string_summary_sp);
847   cpp_category_sp->GetTypeSummariesContainer()->Add(
848       ConstString("std::basic_string<char>"), std_string_summary_sp);
849   cpp_category_sp->GetTypeSummariesContainer()->Add(
850       ConstString("std::basic_string<char,std::char_traits<char>,std::"
851                   "allocator<char> >"),
852       std_string_summary_sp);
853   cpp_category_sp->GetTypeSummariesContainer()->Add(
854       ConstString("std::basic_string<char, std::char_traits<char>, "
855                   "std::allocator<char> >"),
856       std_string_summary_sp);
857 
858   cpp_category_sp->GetTypeSummariesContainer()->Add(
859       ConstString("std::__cxx11::string"), cxx11_string_summary_sp);
860   cpp_category_sp->GetTypeSummariesContainer()->Add(
861       ConstString("std::__cxx11::basic_string<char, std::char_traits<char>, "
862                   "std::allocator<char> >"),
863       cxx11_string_summary_sp);
864   cpp_category_sp->GetTypeSummariesContainer()->Add(
865       ConstString("std::__cxx11::basic_string<unsigned char, "
866                   "std::char_traits<unsigned char>, "
867                   "std::allocator<unsigned char> >"),
868       cxx11_string_summary_sp);
869 
870   // making sure we force-pick the summary for printing wstring (_M_p is a
871   // wchar_t*)
872   lldb::TypeSummaryImplSP std_wstring_summary_sp(
873       new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p%S}"));
874 
875   cpp_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::wstring"),
876                                                     std_wstring_summary_sp);
877   cpp_category_sp->GetTypeSummariesContainer()->Add(
878       ConstString("std::basic_string<wchar_t>"), std_wstring_summary_sp);
879   cpp_category_sp->GetTypeSummariesContainer()->Add(
880       ConstString("std::basic_string<wchar_t,std::char_traits<wchar_t>,std::"
881                   "allocator<wchar_t> >"),
882       std_wstring_summary_sp);
883   cpp_category_sp->GetTypeSummariesContainer()->Add(
884       ConstString("std::basic_string<wchar_t, std::char_traits<wchar_t>, "
885                   "std::allocator<wchar_t> >"),
886       std_wstring_summary_sp);
887 
888   cpp_category_sp->GetTypeSummariesContainer()->Add(
889       ConstString("std::__cxx11::wstring"), cxx11_wstring_summary_sp);
890   cpp_category_sp->GetTypeSummariesContainer()->Add(
891       ConstString("std::__cxx11::basic_string<wchar_t, "
892                   "std::char_traits<wchar_t>, std::allocator<wchar_t> >"),
893       cxx11_wstring_summary_sp);
894 
895   SyntheticChildren::Flags stl_synth_flags;
896   stl_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences(
897       false);
898 
899   cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add(
900       RegularExpression("^std::vector<.+>(( )?&)?$"),
901       SyntheticChildrenSP(new ScriptedSyntheticChildren(
902           stl_synth_flags,
903           "lldb.formatters.cpp.gnu_libstdcpp.StdVectorSynthProvider")));
904   cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add(
905       RegularExpression("^std::map<.+> >(( )?&)?$"),
906       SyntheticChildrenSP(new ScriptedSyntheticChildren(
907           stl_synth_flags,
908           "lldb.formatters.cpp.gnu_libstdcpp.StdMapSynthProvider")));
909   cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add(
910       RegularExpression("^std::(__cxx11::)?list<.+>(( )?&)?$"),
911       SyntheticChildrenSP(new ScriptedSyntheticChildren(
912           stl_synth_flags,
913           "lldb.formatters.cpp.gnu_libstdcpp.StdListSynthProvider")));
914   stl_summary_flags.SetDontShowChildren(false);
915   stl_summary_flags.SetSkipPointers(true);
916   cpp_category_sp->GetRegexTypeSummariesContainer()->Add(
917       RegularExpression("^std::vector<.+>(( )?&)?$"),
918       TypeSummaryImplSP(
919           new StringSummaryFormat(stl_summary_flags, "size=${svar%#}")));
920   cpp_category_sp->GetRegexTypeSummariesContainer()->Add(
921       RegularExpression("^std::map<.+> >(( )?&)?$"),
922       TypeSummaryImplSP(
923           new StringSummaryFormat(stl_summary_flags, "size=${svar%#}")));
924   cpp_category_sp->GetRegexTypeSummariesContainer()->Add(
925       RegularExpression("^std::(__cxx11::)?list<.+>(( )?&)?$"),
926       TypeSummaryImplSP(
927           new StringSummaryFormat(stl_summary_flags, "size=${svar%#}")));
928 
929   AddCXXSynthetic(
930       cpp_category_sp,
931       lldb_private::formatters::LibStdcppVectorIteratorSyntheticFrontEndCreator,
932       "std::vector iterator synthetic children",
933       ConstString("^__gnu_cxx::__normal_iterator<.+>$"), stl_synth_flags, true);
934 
935   AddCXXSynthetic(
936       cpp_category_sp,
937       lldb_private::formatters::LibstdcppMapIteratorSyntheticFrontEndCreator,
938       "std::map iterator synthetic children",
939       ConstString("^std::_Rb_tree_iterator<.+>$"), stl_synth_flags, true);
940 
941   AddCXXSynthetic(
942       cpp_category_sp,
943       lldb_private::formatters::LibStdcppUniquePtrSyntheticFrontEndCreator,
944       "std::unique_ptr synthetic children",
945       ConstString("^std::unique_ptr<.+>(( )?&)?$"), stl_synth_flags, true);
946   AddCXXSynthetic(
947       cpp_category_sp,
948       lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator,
949       "std::shared_ptr synthetic children",
950       ConstString("^std::shared_ptr<.+>(( )?&)?$"), stl_synth_flags, true);
951   AddCXXSynthetic(
952       cpp_category_sp,
953       lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator,
954       "std::weak_ptr synthetic children",
955       ConstString("^std::weak_ptr<.+>(( )?&)?$"), stl_synth_flags, true);
956   AddCXXSynthetic(
957       cpp_category_sp,
958       lldb_private::formatters::LibStdcppTupleSyntheticFrontEndCreator,
959       "std::tuple synthetic children", ConstString("^std::tuple<.+>(( )?&)?$"),
960       stl_synth_flags, true);
961 
962   AddCXXSummary(cpp_category_sp,
963                 lldb_private::formatters::LibStdcppUniquePointerSummaryProvider,
964                 "libstdc++ std::unique_ptr summary provider",
965                 ConstString("^std::unique_ptr<.+>(( )?&)?$"), stl_summary_flags,
966                 true);
967   AddCXXSummary(cpp_category_sp,
968                 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider,
969                 "libstdc++ std::shared_ptr summary provider",
970                 ConstString("^std::shared_ptr<.+>(( )?&)?$"), stl_summary_flags,
971                 true);
972   AddCXXSummary(cpp_category_sp,
973                 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider,
974                 "libstdc++ std::weak_ptr summary provider",
975                 ConstString("^std::weak_ptr<.+>(( )?&)?$"), stl_summary_flags,
976                 true);
977 }
978 
979 static void LoadSystemFormatters(lldb::TypeCategoryImplSP cpp_category_sp) {
980   if (!cpp_category_sp)
981     return;
982 
983   TypeSummaryImpl::Flags string_flags;
984   string_flags.SetCascades(true)
985       .SetSkipPointers(true)
986       .SetSkipReferences(false)
987       .SetDontShowChildren(true)
988       .SetDontShowValue(false)
989       .SetShowMembersOneLiner(false)
990       .SetHideItemNames(false);
991 
992   TypeSummaryImpl::Flags string_array_flags;
993   string_array_flags.SetCascades(true)
994       .SetSkipPointers(true)
995       .SetSkipReferences(false)
996       .SetDontShowChildren(true)
997       .SetDontShowValue(true)
998       .SetShowMembersOneLiner(false)
999       .SetHideItemNames(false);
1000 
1001   // FIXME because of a bug in the FormattersContainer we need to add a summary
1002   // for both X* and const X* (<rdar://problem/12717717>)
1003   AddCXXSummary(
1004       cpp_category_sp, lldb_private::formatters::Char8StringSummaryProvider,
1005       "char8_t * summary provider", ConstString("char8_t *"), string_flags);
1006   AddCXXSummary(cpp_category_sp,
1007                 lldb_private::formatters::Char8StringSummaryProvider,
1008                 "char8_t [] summary provider",
1009                 ConstString("char8_t ?\\[[0-9]+\\]"), string_array_flags, true);
1010 
1011   AddCXXSummary(
1012       cpp_category_sp, lldb_private::formatters::Char16StringSummaryProvider,
1013       "char16_t * summary provider", ConstString("char16_t *"), string_flags);
1014   AddCXXSummary(cpp_category_sp,
1015                 lldb_private::formatters::Char16StringSummaryProvider,
1016                 "char16_t [] summary provider",
1017                 ConstString("char16_t ?\\[[0-9]+\\]"), string_array_flags, true);
1018 
1019   AddCXXSummary(
1020       cpp_category_sp, lldb_private::formatters::Char32StringSummaryProvider,
1021       "char32_t * summary provider", ConstString("char32_t *"), string_flags);
1022   AddCXXSummary(cpp_category_sp,
1023                 lldb_private::formatters::Char32StringSummaryProvider,
1024                 "char32_t [] summary provider",
1025                 ConstString("char32_t ?\\[[0-9]+\\]"), string_array_flags, true);
1026 
1027   AddCXXSummary(
1028       cpp_category_sp, lldb_private::formatters::WCharStringSummaryProvider,
1029       "wchar_t * summary provider", ConstString("wchar_t *"), string_flags);
1030   AddCXXSummary(cpp_category_sp,
1031                 lldb_private::formatters::WCharStringSummaryProvider,
1032                 "wchar_t * summary provider",
1033                 ConstString("wchar_t ?\\[[0-9]+\\]"), string_array_flags, true);
1034 
1035   AddCXXSummary(
1036       cpp_category_sp, lldb_private::formatters::Char16StringSummaryProvider,
1037       "unichar * summary provider", ConstString("unichar *"), string_flags);
1038 
1039   TypeSummaryImpl::Flags widechar_flags;
1040   widechar_flags.SetDontShowValue(true)
1041       .SetSkipPointers(true)
1042       .SetSkipReferences(false)
1043       .SetCascades(true)
1044       .SetDontShowChildren(true)
1045       .SetHideItemNames(true)
1046       .SetShowMembersOneLiner(false);
1047 
1048   AddCXXSummary(cpp_category_sp, lldb_private::formatters::Char8SummaryProvider,
1049                 "char8_t summary provider", ConstString("char8_t"),
1050                 widechar_flags);
1051   AddCXXSummary(
1052       cpp_category_sp, lldb_private::formatters::Char16SummaryProvider,
1053       "char16_t summary provider", ConstString("char16_t"), widechar_flags);
1054   AddCXXSummary(
1055       cpp_category_sp, lldb_private::formatters::Char32SummaryProvider,
1056       "char32_t summary provider", ConstString("char32_t"), widechar_flags);
1057   AddCXXSummary(cpp_category_sp, lldb_private::formatters::WCharSummaryProvider,
1058                 "wchar_t summary provider", ConstString("wchar_t"),
1059                 widechar_flags);
1060 
1061   AddCXXSummary(
1062       cpp_category_sp, lldb_private::formatters::Char16SummaryProvider,
1063       "unichar summary provider", ConstString("unichar"), widechar_flags);
1064 }
1065 
1066 std::unique_ptr<Language::TypeScavenger> CPlusPlusLanguage::GetTypeScavenger() {
1067   class CPlusPlusTypeScavenger : public Language::ImageListTypeScavenger {
1068   public:
1069     CompilerType AdjustForInclusion(CompilerType &candidate) override {
1070       LanguageType lang_type(candidate.GetMinimumLanguage());
1071       if (!Language::LanguageIsC(lang_type) &&
1072           !Language::LanguageIsCPlusPlus(lang_type))
1073         return CompilerType();
1074       if (candidate.IsTypedefType())
1075         return candidate.GetTypedefedType();
1076       return candidate;
1077     }
1078   };
1079 
1080   return std::unique_ptr<TypeScavenger>(new CPlusPlusTypeScavenger());
1081 }
1082 
1083 lldb::TypeCategoryImplSP CPlusPlusLanguage::GetFormatters() {
1084   static llvm::once_flag g_initialize;
1085   static TypeCategoryImplSP g_category;
1086 
1087   llvm::call_once(g_initialize, [this]() -> void {
1088     DataVisualization::Categories::GetCategory(ConstString(GetPluginName()),
1089                                                g_category);
1090     if (g_category) {
1091       LoadLibStdcppFormatters(g_category);
1092       LoadLibCxxFormatters(g_category);
1093       LoadSystemFormatters(g_category);
1094     }
1095   });
1096   return g_category;
1097 }
1098 
1099 HardcodedFormatters::HardcodedSummaryFinder
1100 CPlusPlusLanguage::GetHardcodedSummaries() {
1101   static llvm::once_flag g_initialize;
1102   static ConstString g_vectortypes("VectorTypes");
1103   static HardcodedFormatters::HardcodedSummaryFinder g_formatters;
1104 
1105   llvm::call_once(g_initialize, []() -> void {
1106     g_formatters.push_back(
1107         [](lldb_private::ValueObject &valobj, lldb::DynamicValueType,
1108            FormatManager &) -> TypeSummaryImpl::SharedPointer {
1109           static CXXFunctionSummaryFormat::SharedPointer formatter_sp(
1110               new CXXFunctionSummaryFormat(
1111                   TypeSummaryImpl::Flags(),
1112                   lldb_private::formatters::CXXFunctionPointerSummaryProvider,
1113                   "Function pointer summary provider"));
1114           if (valobj.GetCompilerType().IsFunctionPointerType()) {
1115             return formatter_sp;
1116           }
1117           return nullptr;
1118         });
1119     g_formatters.push_back(
1120         [](lldb_private::ValueObject &valobj, lldb::DynamicValueType,
1121            FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer {
1122           static CXXFunctionSummaryFormat::SharedPointer formatter_sp(
1123               new CXXFunctionSummaryFormat(
1124                   TypeSummaryImpl::Flags()
1125                       .SetCascades(true)
1126                       .SetDontShowChildren(true)
1127                       .SetHideItemNames(true)
1128                       .SetShowMembersOneLiner(true)
1129                       .SetSkipPointers(true)
1130                       .SetSkipReferences(false),
1131                   lldb_private::formatters::VectorTypeSummaryProvider,
1132                   "vector_type pointer summary provider"));
1133           if (valobj.GetCompilerType().IsVectorType()) {
1134             if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled())
1135               return formatter_sp;
1136           }
1137           return nullptr;
1138         });
1139     g_formatters.push_back(
1140         [](lldb_private::ValueObject &valobj, lldb::DynamicValueType,
1141            FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer {
1142           static CXXFunctionSummaryFormat::SharedPointer formatter_sp(
1143               new CXXFunctionSummaryFormat(
1144                   TypeSummaryImpl::Flags()
1145                       .SetCascades(true)
1146                       .SetDontShowChildren(true)
1147                       .SetHideItemNames(true)
1148                       .SetShowMembersOneLiner(true)
1149                       .SetSkipPointers(true)
1150                       .SetSkipReferences(false),
1151                   lldb_private::formatters::BlockPointerSummaryProvider,
1152                   "block pointer summary provider"));
1153           if (valobj.GetCompilerType().IsBlockPointerType()) {
1154             return formatter_sp;
1155           }
1156           return nullptr;
1157         });
1158   });
1159 
1160   return g_formatters;
1161 }
1162 
1163 HardcodedFormatters::HardcodedSyntheticFinder
1164 CPlusPlusLanguage::GetHardcodedSynthetics() {
1165   static llvm::once_flag g_initialize;
1166   static ConstString g_vectortypes("VectorTypes");
1167   static HardcodedFormatters::HardcodedSyntheticFinder g_formatters;
1168 
1169   llvm::call_once(g_initialize, []() -> void {
1170     g_formatters.push_back([](lldb_private::ValueObject &valobj,
1171                               lldb::DynamicValueType, FormatManager &fmt_mgr)
1172                                -> SyntheticChildren::SharedPointer {
1173       static CXXSyntheticChildren::SharedPointer formatter_sp(
1174           new CXXSyntheticChildren(
1175               SyntheticChildren::Flags()
1176                   .SetCascades(true)
1177                   .SetSkipPointers(true)
1178                   .SetSkipReferences(true)
1179                   .SetNonCacheable(true),
1180               "vector_type synthetic children",
1181               lldb_private::formatters::VectorTypeSyntheticFrontEndCreator));
1182       if (valobj.GetCompilerType().IsVectorType()) {
1183         if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled())
1184           return formatter_sp;
1185       }
1186       return nullptr;
1187     });
1188     g_formatters.push_back([](lldb_private::ValueObject &valobj,
1189                               lldb::DynamicValueType, FormatManager &fmt_mgr)
1190                                -> SyntheticChildren::SharedPointer {
1191       static CXXSyntheticChildren::SharedPointer formatter_sp(
1192           new CXXSyntheticChildren(
1193               SyntheticChildren::Flags()
1194                   .SetCascades(true)
1195                   .SetSkipPointers(true)
1196                   .SetSkipReferences(true)
1197                   .SetNonCacheable(true),
1198               "block pointer synthetic children",
1199               lldb_private::formatters::BlockPointerSyntheticFrontEndCreator));
1200       if (valobj.GetCompilerType().IsBlockPointerType()) {
1201         return formatter_sp;
1202       }
1203       return nullptr;
1204     });
1205   });
1206 
1207   return g_formatters;
1208 }
1209 
1210 bool CPlusPlusLanguage::IsNilReference(ValueObject &valobj) {
1211   if (!Language::LanguageIsCPlusPlus(valobj.GetObjectRuntimeLanguage()) ||
1212       !valobj.IsPointerType())
1213     return false;
1214   bool canReadValue = true;
1215   bool isZero = valobj.GetValueAsUnsigned(0, &canReadValue) == 0;
1216   return canReadValue && isZero;
1217 }
1218 
1219 bool CPlusPlusLanguage::IsSourceFile(llvm::StringRef file_path) const {
1220   const auto suffixes = {".cpp", ".cxx", ".c++", ".cc",  ".c",
1221                          ".h",   ".hh",  ".hpp", ".hxx", ".h++"};
1222   for (auto suffix : suffixes) {
1223     if (file_path.endswith_insensitive(suffix))
1224       return true;
1225   }
1226 
1227   // Check if we're in a STL path (where the files usually have no extension
1228   // that we could check for.
1229   return file_path.contains("/usr/include/c++/");
1230 }
1231