xref: /llvm-project/lldb/source/Plugins/Language/CPlusPlus/CPlusPlusLanguage.cpp (revision 0c02ea05c8414e72339e2521d1fdae54e91569bb)
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/Core/ValueObjectVariable.h"
27 #include "lldb/DataFormatters/CXXFunctionPointer.h"
28 #include "lldb/DataFormatters/DataVisualization.h"
29 #include "lldb/DataFormatters/FormattersHelpers.h"
30 #include "lldb/DataFormatters/VectorType.h"
31 #include "lldb/Symbol/SymbolFile.h"
32 #include "lldb/Symbol/VariableList.h"
33 #include "lldb/Utility/ConstString.h"
34 #include "lldb/Utility/LLDBLog.h"
35 #include "lldb/Utility/Log.h"
36 #include "lldb/Utility/RegularExpression.h"
37 
38 #include "BlockPointer.h"
39 #include "CPlusPlusNameParser.h"
40 #include "Coroutines.h"
41 #include "CxxStringTypes.h"
42 #include "Generic.h"
43 #include "LibCxx.h"
44 #include "LibCxxAtomic.h"
45 #include "LibCxxVariant.h"
46 #include "LibStdcpp.h"
47 #include "MSVCUndecoratedNameParser.h"
48 #include "lldb/lldb-enumerations.h"
49 
50 using namespace lldb;
51 using namespace lldb_private;
52 using namespace lldb_private::formatters;
53 
54 LLDB_PLUGIN_DEFINE(CPlusPlusLanguage)
55 
56 void CPlusPlusLanguage::Initialize() {
57   PluginManager::RegisterPlugin(GetPluginNameStatic(), "C++ Language",
58                                 CreateInstance);
59 }
60 
61 void CPlusPlusLanguage::Terminate() {
62   PluginManager::UnregisterPlugin(CreateInstance);
63 }
64 
65 bool CPlusPlusLanguage::SymbolNameFitsToLanguage(Mangled mangled) const {
66   const char *mangled_name = mangled.GetMangledName().GetCString();
67   return mangled_name && CPlusPlusLanguage::IsCPPMangledName(mangled_name);
68 }
69 
70 ConstString CPlusPlusLanguage::GetDemangledFunctionNameWithoutArguments(
71     Mangled mangled) const {
72   const char *mangled_name_cstr = mangled.GetMangledName().GetCString();
73   ConstString demangled_name = mangled.GetDemangledName();
74   if (demangled_name && mangled_name_cstr && mangled_name_cstr[0]) {
75     if (mangled_name_cstr[0] == '_' && mangled_name_cstr[1] == 'Z' &&
76         (mangled_name_cstr[2] != 'T' && // avoid virtual table, VTT structure,
77                                         // typeinfo structure, and typeinfo
78                                         // mangled_name
79          mangled_name_cstr[2] != 'G' && // avoid guard variables
80          mangled_name_cstr[2] != 'Z'))  // named local entities (if we
81                                         // eventually handle eSymbolTypeData,
82                                         // we will want this back)
83     {
84       CPlusPlusLanguage::MethodName cxx_method(demangled_name);
85       if (!cxx_method.GetBasename().empty()) {
86         std::string shortname;
87         if (!cxx_method.GetContext().empty())
88           shortname = cxx_method.GetContext().str() + "::";
89         shortname += cxx_method.GetBasename().str();
90         return ConstString(shortname);
91       }
92     }
93   }
94   if (demangled_name)
95     return demangled_name;
96   return mangled.GetMangledName();
97 }
98 
99 // Static Functions
100 
101 Language *CPlusPlusLanguage::CreateInstance(lldb::LanguageType language) {
102   // Use plugin for C++ but not for Objective-C++ (which has its own plugin).
103   if (Language::LanguageIsCPlusPlus(language) &&
104       language != eLanguageTypeObjC_plus_plus)
105     return new CPlusPlusLanguage();
106   return nullptr;
107 }
108 
109 void CPlusPlusLanguage::MethodName::Clear() {
110   m_full.Clear();
111   m_basename = llvm::StringRef();
112   m_context = llvm::StringRef();
113   m_arguments = llvm::StringRef();
114   m_qualifiers = llvm::StringRef();
115   m_return_type = llvm::StringRef();
116   m_parsed = false;
117   m_parse_error = false;
118 }
119 
120 static bool ReverseFindMatchingChars(const llvm::StringRef &s,
121                                      const llvm::StringRef &left_right_chars,
122                                      size_t &left_pos, size_t &right_pos,
123                                      size_t pos = llvm::StringRef::npos) {
124   assert(left_right_chars.size() == 2);
125   left_pos = llvm::StringRef::npos;
126   const char left_char = left_right_chars[0];
127   const char right_char = left_right_chars[1];
128   pos = s.find_last_of(left_right_chars, pos);
129   if (pos == llvm::StringRef::npos || s[pos] == left_char)
130     return false;
131   right_pos = pos;
132   uint32_t depth = 1;
133   while (pos > 0 && depth > 0) {
134     pos = s.find_last_of(left_right_chars, pos);
135     if (pos == llvm::StringRef::npos)
136       return false;
137     if (s[pos] == left_char) {
138       if (--depth == 0) {
139         left_pos = pos;
140         return left_pos < right_pos;
141       }
142     } else if (s[pos] == right_char) {
143       ++depth;
144     }
145   }
146   return false;
147 }
148 
149 static bool IsTrivialBasename(const llvm::StringRef &basename) {
150   // Check that the basename matches with the following regular expression
151   // "^~?([A-Za-z_][A-Za-z_0-9]*)$" We are using a hand written implementation
152   // because it is significantly more efficient then using the general purpose
153   // regular expression library.
154   size_t idx = 0;
155   if (basename.size() > 0 && basename[0] == '~')
156     idx = 1;
157 
158   if (basename.size() <= idx)
159     return false; // Empty string or "~"
160 
161   if (!std::isalpha(basename[idx]) && basename[idx] != '_')
162     return false; // First character (after removing the possible '~'') isn't in
163                   // [A-Za-z_]
164 
165   // Read all characters matching [A-Za-z_0-9]
166   ++idx;
167   while (idx < basename.size()) {
168     if (!std::isalnum(basename[idx]) && basename[idx] != '_')
169       break;
170     ++idx;
171   }
172 
173   // We processed all characters. It is a vaild basename.
174   return idx == basename.size();
175 }
176 
177 /// Writes out the function name in 'full_name' to 'out_stream'
178 /// but replaces each argument type with the variable name
179 /// and the corresponding pretty-printed value
180 static bool PrettyPrintFunctionNameWithArgs(Stream &out_stream,
181                                             char const *full_name,
182                                             ExecutionContextScope *exe_scope,
183                                             VariableList const &args) {
184   CPlusPlusLanguage::MethodName cpp_method{ConstString(full_name)};
185 
186   if (!cpp_method.IsValid())
187     return false;
188 
189   llvm::StringRef return_type = cpp_method.GetReturnType();
190   if (!return_type.empty()) {
191     out_stream.PutCString(return_type);
192     out_stream.PutChar(' ');
193   }
194 
195   out_stream.PutCString(cpp_method.GetScopeQualifiedName());
196   out_stream.PutChar('(');
197 
198   FormatEntity::PrettyPrintFunctionArguments(out_stream, args, exe_scope);
199 
200   out_stream.PutChar(')');
201 
202   llvm::StringRef qualifiers = cpp_method.GetQualifiers();
203   if (!qualifiers.empty()) {
204     out_stream.PutChar(' ');
205     out_stream.PutCString(qualifiers);
206   }
207 
208   return true;
209 }
210 
211 bool CPlusPlusLanguage::MethodName::TrySimplifiedParse() {
212   // This method tries to parse simple method definitions which are presumably
213   // most comman in user programs. Definitions that can be parsed by this
214   // function don't have return types and templates in the name.
215   // A::B::C::fun(std::vector<T> &) const
216   size_t arg_start, arg_end;
217   llvm::StringRef full(m_full.GetCString());
218   llvm::StringRef parens("()", 2);
219   if (ReverseFindMatchingChars(full, parens, arg_start, arg_end)) {
220     m_arguments = full.substr(arg_start, arg_end - arg_start + 1);
221     if (arg_end + 1 < full.size())
222       m_qualifiers = full.substr(arg_end + 1).ltrim();
223 
224     if (arg_start == 0)
225       return false;
226     size_t basename_end = arg_start;
227     size_t context_start = 0;
228     size_t context_end = full.rfind(':', basename_end);
229     if (context_end == llvm::StringRef::npos)
230       m_basename = full.substr(0, basename_end);
231     else {
232       if (context_start < context_end)
233         m_context = full.substr(context_start, context_end - 1 - context_start);
234       const size_t basename_begin = context_end + 1;
235       m_basename = full.substr(basename_begin, basename_end - basename_begin);
236     }
237 
238     if (IsTrivialBasename(m_basename)) {
239       return true;
240     } else {
241       // The C++ basename doesn't match our regular expressions so this can't
242       // be a valid C++ method, clear everything out and indicate an error
243       m_context = llvm::StringRef();
244       m_basename = llvm::StringRef();
245       m_arguments = llvm::StringRef();
246       m_qualifiers = llvm::StringRef();
247       m_return_type = llvm::StringRef();
248       return false;
249     }
250   }
251   return false;
252 }
253 
254 void CPlusPlusLanguage::MethodName::Parse() {
255   if (!m_parsed && m_full) {
256     if (TrySimplifiedParse()) {
257       m_parse_error = false;
258     } else {
259       CPlusPlusNameParser parser(m_full.GetStringRef());
260       if (auto function = parser.ParseAsFunctionDefinition()) {
261         m_basename = function->name.basename;
262         m_context = function->name.context;
263         m_arguments = function->arguments;
264         m_qualifiers = function->qualifiers;
265         m_return_type = function->return_type;
266         m_parse_error = false;
267       } else {
268         m_parse_error = true;
269       }
270     }
271     m_parsed = true;
272   }
273 }
274 
275 llvm::StringRef CPlusPlusLanguage::MethodName::GetBasename() {
276   if (!m_parsed)
277     Parse();
278   return m_basename;
279 }
280 
281 llvm::StringRef CPlusPlusLanguage::MethodName::GetContext() {
282   if (!m_parsed)
283     Parse();
284   return m_context;
285 }
286 
287 llvm::StringRef CPlusPlusLanguage::MethodName::GetArguments() {
288   if (!m_parsed)
289     Parse();
290   return m_arguments;
291 }
292 
293 llvm::StringRef CPlusPlusLanguage::MethodName::GetQualifiers() {
294   if (!m_parsed)
295     Parse();
296   return m_qualifiers;
297 }
298 
299 llvm::StringRef CPlusPlusLanguage::MethodName::GetReturnType() {
300   if (!m_parsed)
301     Parse();
302   return m_return_type;
303 }
304 
305 std::string CPlusPlusLanguage::MethodName::GetScopeQualifiedName() {
306   if (!m_parsed)
307     Parse();
308   if (m_context.empty())
309     return std::string(m_basename);
310 
311   std::string res;
312   res += m_context;
313   res += "::";
314   res += m_basename;
315   return res;
316 }
317 
318 llvm::StringRef
319 CPlusPlusLanguage::MethodName::GetBasenameNoTemplateParameters() {
320   llvm::StringRef basename = GetBasename();
321   size_t arg_start, arg_end;
322   llvm::StringRef parens("<>", 2);
323   if (ReverseFindMatchingChars(basename, parens, arg_start, arg_end))
324     return basename.substr(0, arg_start);
325 
326   return basename;
327 }
328 
329 bool CPlusPlusLanguage::MethodName::ContainsPath(llvm::StringRef path) {
330   if (!m_parsed)
331     Parse();
332 
333   // If we can't parse the incoming name, then just check that it contains path.
334   if (m_parse_error)
335     return m_full.GetStringRef().contains(path);
336 
337   llvm::StringRef identifier;
338   llvm::StringRef context;
339   std::string path_str = path.str();
340   bool success = CPlusPlusLanguage::ExtractContextAndIdentifier(
341       path_str.c_str(), context, identifier);
342   if (!success)
343     return m_full.GetStringRef().contains(path);
344 
345   // Basename may include template arguments.
346   // E.g.,
347   // GetBaseName(): func<int>
348   // identifier   : func
349   //
350   // ...but we still want to account for identifiers with template parameter
351   // lists, e.g., when users set breakpoints on template specializations.
352   //
353   // E.g.,
354   // GetBaseName(): func<uint32_t>
355   // identifier   : func<int32_t*>
356   //
357   // Try to match the basename with or without template parameters.
358   if (GetBasename() != identifier &&
359       GetBasenameNoTemplateParameters() != identifier)
360     return false;
361 
362   // Incoming path only had an identifier, so we match.
363   if (context.empty())
364     return true;
365   // Incoming path has context but this method does not, no match.
366   if (m_context.empty())
367     return false;
368 
369   llvm::StringRef haystack = m_context;
370   if (!haystack.consume_back(context))
371     return false;
372   if (haystack.empty() || !isalnum(haystack.back()))
373     return true;
374 
375   return false;
376 }
377 
378 bool CPlusPlusLanguage::IsCPPMangledName(llvm::StringRef name) {
379   // FIXME!! we should really run through all the known C++ Language plugins
380   // and ask each one if this is a C++ mangled name
381 
382   Mangled::ManglingScheme scheme = Mangled::GetManglingScheme(name);
383 
384   if (scheme == Mangled::eManglingSchemeNone)
385     return false;
386 
387   return true;
388 }
389 
390 bool CPlusPlusLanguage::DemangledNameContainsPath(llvm::StringRef path,
391                                                   ConstString demangled) const {
392   MethodName demangled_name(demangled);
393   return demangled_name.ContainsPath(path);
394 }
395 
396 bool CPlusPlusLanguage::ExtractContextAndIdentifier(
397     const char *name, llvm::StringRef &context, llvm::StringRef &identifier) {
398   if (MSVCUndecoratedNameParser::IsMSVCUndecoratedName(name))
399     return MSVCUndecoratedNameParser::ExtractContextAndIdentifier(name, context,
400                                                                   identifier);
401 
402   CPlusPlusNameParser parser(name);
403   if (auto full_name = parser.ParseAsFullName()) {
404     identifier = full_name->basename;
405     context = full_name->context;
406     return true;
407   }
408   return false;
409 }
410 
411 namespace {
412 class NodeAllocator {
413   llvm::BumpPtrAllocator Alloc;
414 
415 public:
416   void reset() { Alloc.Reset(); }
417 
418   template <typename T, typename... Args> T *makeNode(Args &&... args) {
419     return new (Alloc.Allocate(sizeof(T), alignof(T)))
420         T(std::forward<Args>(args)...);
421   }
422 
423   void *allocateNodeArray(size_t sz) {
424     return Alloc.Allocate(sizeof(llvm::itanium_demangle::Node *) * sz,
425                           alignof(llvm::itanium_demangle::Node *));
426   }
427 };
428 
429 template <typename Derived>
430 class ManglingSubstitutor
431     : public llvm::itanium_demangle::AbstractManglingParser<Derived,
432                                                             NodeAllocator> {
433   using Base =
434       llvm::itanium_demangle::AbstractManglingParser<Derived, NodeAllocator>;
435 
436 public:
437   ManglingSubstitutor() : Base(nullptr, nullptr) {}
438 
439   template <typename... Ts>
440   ConstString substitute(llvm::StringRef Mangled, Ts &&... Vals) {
441     this->getDerived().reset(Mangled, std::forward<Ts>(Vals)...);
442     return substituteImpl(Mangled);
443   }
444 
445 protected:
446   void reset(llvm::StringRef Mangled) {
447     Base::reset(Mangled.begin(), Mangled.end());
448     Written = Mangled.begin();
449     Result.clear();
450     Substituted = false;
451   }
452 
453   ConstString substituteImpl(llvm::StringRef Mangled) {
454     Log *log = GetLog(LLDBLog::Language);
455     if (this->parse() == nullptr) {
456       LLDB_LOG(log, "Failed to substitute mangling in {0}", Mangled);
457       return ConstString();
458     }
459     if (!Substituted)
460       return ConstString();
461 
462     // Append any trailing unmodified input.
463     appendUnchangedInput();
464     LLDB_LOG(log, "Substituted mangling {0} -> {1}", Mangled, Result);
465     return ConstString(Result);
466   }
467 
468   void trySubstitute(llvm::StringRef From, llvm::StringRef To) {
469     if (!llvm::StringRef(currentParserPos(), this->numLeft()).starts_with(From))
470       return;
471 
472     // We found a match. Append unmodified input up to this point.
473     appendUnchangedInput();
474 
475     // And then perform the replacement.
476     Result += To;
477     Written += From.size();
478     Substituted = true;
479   }
480 
481 private:
482   /// Input character until which we have constructed the respective output
483   /// already.
484   const char *Written = "";
485 
486   llvm::SmallString<128> Result;
487 
488   /// Whether we have performed any substitutions.
489   bool Substituted = false;
490 
491   const char *currentParserPos() const { return this->First; }
492 
493   void appendUnchangedInput() {
494     Result +=
495         llvm::StringRef(Written, std::distance(Written, currentParserPos()));
496     Written = currentParserPos();
497   }
498 };
499 
500 /// Given a mangled function `Mangled`, replace all the primitive function type
501 /// arguments of `Search` with type `Replace`.
502 class TypeSubstitutor : public ManglingSubstitutor<TypeSubstitutor> {
503   llvm::StringRef Search;
504   llvm::StringRef Replace;
505 
506 public:
507   void reset(llvm::StringRef Mangled, llvm::StringRef Search,
508              llvm::StringRef Replace) {
509     ManglingSubstitutor::reset(Mangled);
510     this->Search = Search;
511     this->Replace = Replace;
512   }
513 
514   llvm::itanium_demangle::Node *parseType() {
515     trySubstitute(Search, Replace);
516     return ManglingSubstitutor::parseType();
517   }
518 };
519 
520 class CtorDtorSubstitutor : public ManglingSubstitutor<CtorDtorSubstitutor> {
521 public:
522   llvm::itanium_demangle::Node *
523   parseCtorDtorName(llvm::itanium_demangle::Node *&SoFar, NameState *State) {
524     trySubstitute("C1", "C2");
525     trySubstitute("D1", "D2");
526     return ManglingSubstitutor::parseCtorDtorName(SoFar, State);
527   }
528 };
529 } // namespace
530 
531 std::vector<ConstString> CPlusPlusLanguage::GenerateAlternateFunctionManglings(
532     const ConstString mangled_name) const {
533   std::vector<ConstString> alternates;
534 
535   /// Get a basic set of alternative manglings for the given symbol `name`, by
536   /// making a few basic possible substitutions on basic types, storage duration
537   /// and `const`ness for the given symbol. The output parameter `alternates`
538   /// is filled with a best-guess, non-exhaustive set of different manglings
539   /// for the given name.
540 
541   // Maybe we're looking for a const symbol but the debug info told us it was
542   // non-const...
543   if (!strncmp(mangled_name.GetCString(), "_ZN", 3) &&
544       strncmp(mangled_name.GetCString(), "_ZNK", 4)) {
545     std::string fixed_scratch("_ZNK");
546     fixed_scratch.append(mangled_name.GetCString() + 3);
547     alternates.push_back(ConstString(fixed_scratch));
548   }
549 
550   // Maybe we're looking for a static symbol but we thought it was global...
551   if (!strncmp(mangled_name.GetCString(), "_Z", 2) &&
552       strncmp(mangled_name.GetCString(), "_ZL", 3)) {
553     std::string fixed_scratch("_ZL");
554     fixed_scratch.append(mangled_name.GetCString() + 2);
555     alternates.push_back(ConstString(fixed_scratch));
556   }
557 
558   TypeSubstitutor TS;
559   // `char` is implementation defined as either `signed` or `unsigned`.  As a
560   // result a char parameter has 3 possible manglings: 'c'-char, 'a'-signed
561   // char, 'h'-unsigned char.  If we're looking for symbols with a signed char
562   // parameter, try finding matches which have the general case 'c'.
563   if (ConstString char_fixup =
564           TS.substitute(mangled_name.GetStringRef(), "a", "c"))
565     alternates.push_back(char_fixup);
566 
567   // long long parameter mangling 'x', may actually just be a long 'l' argument
568   if (ConstString long_fixup =
569           TS.substitute(mangled_name.GetStringRef(), "x", "l"))
570     alternates.push_back(long_fixup);
571 
572   // unsigned long long parameter mangling 'y', may actually just be unsigned
573   // long 'm' argument
574   if (ConstString ulong_fixup =
575           TS.substitute(mangled_name.GetStringRef(), "y", "m"))
576     alternates.push_back(ulong_fixup);
577 
578   if (ConstString ctor_fixup =
579           CtorDtorSubstitutor().substitute(mangled_name.GetStringRef()))
580     alternates.push_back(ctor_fixup);
581 
582   return alternates;
583 }
584 
585 ConstString CPlusPlusLanguage::FindBestAlternateFunctionMangledName(
586     const Mangled mangled, const SymbolContext &sym_ctx) const {
587   ConstString demangled = mangled.GetDemangledName();
588   if (!demangled)
589     return ConstString();
590 
591   CPlusPlusLanguage::MethodName cpp_name(demangled);
592   std::string scope_qualified_name = cpp_name.GetScopeQualifiedName();
593 
594   if (!scope_qualified_name.size())
595     return ConstString();
596 
597   if (!sym_ctx.module_sp)
598     return ConstString();
599 
600   lldb_private::SymbolFile *sym_file = sym_ctx.module_sp->GetSymbolFile();
601   if (!sym_file)
602     return ConstString();
603 
604   std::vector<ConstString> alternates;
605   sym_file->GetMangledNamesForFunction(scope_qualified_name, alternates);
606 
607   std::vector<ConstString> param_and_qual_matches;
608   std::vector<ConstString> param_matches;
609   for (size_t i = 0; i < alternates.size(); i++) {
610     ConstString alternate_mangled_name = alternates[i];
611     Mangled mangled(alternate_mangled_name);
612     ConstString demangled = mangled.GetDemangledName();
613 
614     CPlusPlusLanguage::MethodName alternate_cpp_name(demangled);
615     if (!cpp_name.IsValid())
616       continue;
617 
618     if (alternate_cpp_name.GetArguments() == cpp_name.GetArguments()) {
619       if (alternate_cpp_name.GetQualifiers() == cpp_name.GetQualifiers())
620         param_and_qual_matches.push_back(alternate_mangled_name);
621       else
622         param_matches.push_back(alternate_mangled_name);
623     }
624   }
625 
626   if (param_and_qual_matches.size())
627     return param_and_qual_matches[0]; // It is assumed that there will be only
628                                       // one!
629   else if (param_matches.size())
630     return param_matches[0]; // Return one of them as a best match
631   else
632     return ConstString();
633 }
634 
635 static void LoadLibCxxFormatters(lldb::TypeCategoryImplSP cpp_category_sp) {
636   if (!cpp_category_sp)
637     return;
638 
639   TypeSummaryImpl::Flags stl_summary_flags;
640   stl_summary_flags.SetCascades(true)
641       .SetSkipPointers(false)
642       .SetSkipReferences(false)
643       .SetDontShowChildren(true)
644       .SetDontShowValue(true)
645       .SetShowMembersOneLiner(false)
646       .SetHideItemNames(false);
647 
648   AddCXXSummary(cpp_category_sp,
649                 lldb_private::formatters::LibcxxStringSummaryProviderASCII,
650                 "std::string summary provider", "^std::__[[:alnum:]]+::string$",
651                 stl_summary_flags, true);
652   AddCXXSummary(cpp_category_sp,
653                 lldb_private::formatters::LibcxxStringSummaryProviderASCII,
654                 "std::string summary provider",
655                 "^std::__[[:alnum:]]+::basic_string<char, "
656                 "std::__[[:alnum:]]+::char_traits<char>, "
657                 "std::__[[:alnum:]]+::allocator<char> >$",
658                 stl_summary_flags, true);
659   AddCXXSummary(cpp_category_sp,
660                 lldb_private::formatters::LibcxxStringSummaryProviderASCII,
661                 "std::string summary provider",
662                 "^std::__[[:alnum:]]+::basic_string<unsigned char, "
663                 "std::__[[:alnum:]]+::char_traits<unsigned char>, "
664                 "std::__[[:alnum:]]+::allocator<unsigned char> >$",
665                 stl_summary_flags, true);
666 
667   AddCXXSummary(cpp_category_sp,
668                 lldb_private::formatters::LibcxxStringSummaryProviderUTF16,
669                 "std::u16string summary provider",
670                 "^std::__[[:alnum:]]+::basic_string<char16_t, "
671                 "std::__[[:alnum:]]+::char_traits<char16_t>, "
672                 "std::__[[:alnum:]]+::allocator<char16_t> >$",
673                 stl_summary_flags, true);
674 
675   AddCXXSummary(cpp_category_sp,
676                 lldb_private::formatters::LibcxxStringSummaryProviderUTF32,
677                 "std::u32string summary provider",
678                 "^std::__[[:alnum:]]+::basic_string<char32_t, "
679                 "std::__[[:alnum:]]+::char_traits<char32_t>, "
680                 "std::__[[:alnum:]]+::allocator<char32_t> >$",
681                 stl_summary_flags, true);
682 
683   AddCXXSummary(cpp_category_sp,
684                 lldb_private::formatters::LibcxxWStringSummaryProvider,
685                 "std::wstring summary provider",
686                 "^std::__[[:alnum:]]+::wstring$", stl_summary_flags, true);
687   AddCXXSummary(cpp_category_sp,
688                 lldb_private::formatters::LibcxxWStringSummaryProvider,
689                 "std::wstring summary provider",
690                 "^std::__[[:alnum:]]+::basic_string<wchar_t, "
691                 "std::__[[:alnum:]]+::char_traits<wchar_t>, "
692                 "std::__[[:alnum:]]+::allocator<wchar_t> >$",
693                 stl_summary_flags, true);
694 
695   AddCXXSummary(cpp_category_sp,
696                 lldb_private::formatters::LibcxxStringViewSummaryProviderASCII,
697                 "std::string_view summary provider",
698                 "^std::__[[:alnum:]]+::string_view$", stl_summary_flags, true);
699   AddCXXSummary(cpp_category_sp,
700                 lldb_private::formatters::LibcxxStringViewSummaryProviderASCII,
701                 "std::string_view summary provider",
702                 "^std::__[[:alnum:]]+::basic_string_view<char, "
703                 "std::__[[:alnum:]]+::char_traits<char> >$",
704                 stl_summary_flags, true);
705   AddCXXSummary(cpp_category_sp,
706                 lldb_private::formatters::LibcxxStringViewSummaryProviderASCII,
707                 "std::string_view summary provider",
708                 "^std::__[[:alnum:]]+::basic_string_view<unsigned char, "
709                 "std::__[[:alnum:]]+::char_traits<unsigned char> >$",
710                 stl_summary_flags, true);
711 
712   AddCXXSummary(cpp_category_sp,
713                 lldb_private::formatters::LibcxxStringViewSummaryProviderUTF16,
714                 "std::u16string_view summary provider",
715                 "^std::__[[:alnum:]]+::basic_string_view<char16_t, "
716                 "std::__[[:alnum:]]+::char_traits<char16_t> >$",
717                 stl_summary_flags, true);
718 
719   AddCXXSummary(cpp_category_sp,
720                 lldb_private::formatters::LibcxxStringViewSummaryProviderUTF32,
721                 "std::u32string_view summary provider",
722                 "^std::__[[:alnum:]]+::basic_string_view<char32_t, "
723                 "std::__[[:alnum:]]+::char_traits<char32_t> >$",
724                 stl_summary_flags, true);
725 
726   AddCXXSummary(cpp_category_sp,
727                 lldb_private::formatters::LibcxxWStringViewSummaryProvider,
728                 "std::wstring_view summary provider",
729                 "^std::__[[:alnum:]]+::wstring_view$", stl_summary_flags, true);
730   AddCXXSummary(cpp_category_sp,
731                 lldb_private::formatters::LibcxxWStringViewSummaryProvider,
732                 "std::wstring_view summary provider",
733                 "^std::__[[:alnum:]]+::basic_string_view<wchar_t, "
734                 "std::__[[:alnum:]]+::char_traits<wchar_t> >$",
735                 stl_summary_flags, true);
736 
737   SyntheticChildren::Flags stl_synth_flags;
738   stl_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences(
739       false);
740   SyntheticChildren::Flags stl_deref_flags = stl_synth_flags;
741   stl_deref_flags.SetFrontEndWantsDereference();
742 
743   AddCXXSynthetic(
744       cpp_category_sp,
745       lldb_private::formatters::LibcxxBitsetSyntheticFrontEndCreator,
746       "libc++ std::bitset synthetic children",
747       "^std::__[[:alnum:]]+::bitset<.+>$", stl_deref_flags, true);
748   AddCXXSynthetic(
749       cpp_category_sp,
750       lldb_private::formatters::LibcxxStdVectorSyntheticFrontEndCreator,
751       "libc++ std::vector synthetic children",
752       "^std::__[[:alnum:]]+::vector<.+>$", stl_deref_flags, true);
753   AddCXXSynthetic(
754       cpp_category_sp,
755       lldb_private::formatters::LibcxxStdForwardListSyntheticFrontEndCreator,
756       "libc++ std::forward_list synthetic children",
757       "^std::__[[:alnum:]]+::forward_list<.+>$", stl_synth_flags, true);
758   AddCXXSynthetic(
759       cpp_category_sp,
760       lldb_private::formatters::LibcxxStdListSyntheticFrontEndCreator,
761       "libc++ std::list synthetic children",
762       // A POSIX variant of: "^std::__(?!cxx11:)[[:alnum:]]+::list<.+>$"
763       // so that it does not clash with: "^std::(__cxx11::)?list<.+>$"
764       "^std::__([A-Zabd-z0-9]|cx?[A-Za-wyz0-9]|cxx1?[A-Za-z02-9]|"
765       "cxx11[[:alnum:]])[[:alnum:]]*::list<.+>$",
766       stl_deref_flags, true);
767   AddCXXSynthetic(
768       cpp_category_sp,
769       lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator,
770       "libc++ std::map synthetic children", "^std::__[[:alnum:]]+::map<.+> >$",
771       stl_synth_flags, true);
772   AddCXXSynthetic(
773       cpp_category_sp,
774       lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator,
775       "libc++ std::set synthetic children", "^std::__[[:alnum:]]+::set<.+> >$",
776       stl_deref_flags, true);
777   AddCXXSynthetic(
778       cpp_category_sp,
779       lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator,
780       "libc++ std::multiset synthetic children",
781       "^std::__[[:alnum:]]+::multiset<.+> >$", stl_deref_flags, true);
782   AddCXXSynthetic(
783       cpp_category_sp,
784       lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator,
785       "libc++ std::multimap synthetic children",
786       "^std::__[[:alnum:]]+::multimap<.+> >$", stl_synth_flags, true);
787   AddCXXSynthetic(
788       cpp_category_sp,
789       lldb_private::formatters::LibcxxStdUnorderedMapSyntheticFrontEndCreator,
790       "libc++ std::unordered containers synthetic children",
791       "^std::__[[:alnum:]]+::unordered_(multi)?(map|set)<.+> >$",
792       stl_synth_flags, true);
793   AddCXXSynthetic(
794       cpp_category_sp,
795       lldb_private::formatters::LibcxxInitializerListSyntheticFrontEndCreator,
796       "libc++ std::initializer_list synthetic children",
797       "^std::initializer_list<.+>$", stl_synth_flags, true);
798   AddCXXSynthetic(cpp_category_sp, LibcxxQueueFrontEndCreator,
799                   "libc++ std::queue synthetic children",
800                   "^std::__[[:alnum:]]+::queue<.+>$", stl_synth_flags, true);
801   AddCXXSynthetic(cpp_category_sp, LibcxxTupleFrontEndCreator,
802                   "libc++ std::tuple synthetic children",
803                   "^std::__[[:alnum:]]+::tuple<.*>$", stl_synth_flags, true);
804   AddCXXSynthetic(cpp_category_sp, LibcxxOptionalSyntheticFrontEndCreator,
805                   "libc++ std::optional synthetic children",
806                   "^std::__[[:alnum:]]+::optional<.+>$", stl_synth_flags, true);
807   AddCXXSynthetic(cpp_category_sp, LibcxxVariantFrontEndCreator,
808                   "libc++ std::variant synthetic children",
809                   "^std::__[[:alnum:]]+::variant<.+>$", stl_synth_flags, true);
810   AddCXXSynthetic(
811       cpp_category_sp,
812       lldb_private::formatters::LibcxxAtomicSyntheticFrontEndCreator,
813       "libc++ std::atomic synthetic children",
814       "^std::__[[:alnum:]]+::atomic<.+>$", stl_synth_flags, true);
815   AddCXXSynthetic(
816       cpp_category_sp,
817       lldb_private::formatters::LibcxxStdSpanSyntheticFrontEndCreator,
818       "libc++ std::span synthetic children", "^std::__[[:alnum:]]+::span<.+>$",
819       stl_deref_flags, true);
820   AddCXXSynthetic(
821       cpp_category_sp,
822       lldb_private::formatters::LibcxxStdRangesRefViewSyntheticFrontEndCreator,
823       "libc++ std::ranges::ref_view synthetic children",
824       "^std::__[[:alnum:]]+::ranges::ref_view<.+>$", stl_deref_flags, true);
825 
826   cpp_category_sp->AddTypeSynthetic(
827       "^std::__[[:alnum:]]+::deque<.+>$", eFormatterMatchRegex,
828       SyntheticChildrenSP(new ScriptedSyntheticChildren(
829           stl_synth_flags,
830           "lldb.formatters.cpp.libcxx.stddeque_SynthProvider")));
831 
832   AddCXXSynthetic(
833       cpp_category_sp,
834       lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator,
835       "shared_ptr synthetic children", "^std::__[[:alnum:]]+::shared_ptr<.+>$",
836       stl_synth_flags, true);
837 
838   static constexpr const char *const libcxx_std_unique_ptr_regex =
839       "^std::__[[:alnum:]]+::unique_ptr<.+>$";
840   AddCXXSynthetic(
841       cpp_category_sp,
842       lldb_private::formatters::LibcxxUniquePtrSyntheticFrontEndCreator,
843       "unique_ptr synthetic children", libcxx_std_unique_ptr_regex,
844       stl_synth_flags, true);
845 
846   AddCXXSynthetic(
847       cpp_category_sp,
848       lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator,
849       "weak_ptr synthetic children", "^std::__[[:alnum:]]+::weak_ptr<.+>$",
850       stl_synth_flags, true);
851   AddCXXSummary(cpp_category_sp,
852                 lldb_private::formatters::LibcxxFunctionSummaryProvider,
853                 "libc++ std::function summary provider",
854                 "^std::__[[:alnum:]]+::function<.+>$", stl_summary_flags, true);
855 
856   static constexpr const char *const libcxx_std_coroutine_handle_regex =
857       "^std::__[[:alnum:]]+::coroutine_handle<.+>$";
858   AddCXXSynthetic(
859       cpp_category_sp,
860       lldb_private::formatters::StdlibCoroutineHandleSyntheticFrontEndCreator,
861       "coroutine_handle synthetic children", libcxx_std_coroutine_handle_regex,
862       stl_deref_flags, true);
863 
864   stl_summary_flags.SetDontShowChildren(false);
865   stl_summary_flags.SetSkipPointers(false);
866   AddCXXSummary(cpp_category_sp,
867                 lldb_private::formatters::LibcxxContainerSummaryProvider,
868                 "libc++ std::bitset summary provider",
869                 "^std::__[[:alnum:]]+::bitset<.+>$", stl_summary_flags, true);
870   AddCXXSummary(cpp_category_sp,
871                 lldb_private::formatters::LibcxxContainerSummaryProvider,
872                 "libc++ std::vector summary provider",
873                 "^std::__[[:alnum:]]+::vector<.+>$", stl_summary_flags, true);
874   AddCXXSummary(
875       cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider,
876       "libc++ std::list summary provider",
877       "^std::__[[:alnum:]]+::forward_list<.+>$", stl_summary_flags, true);
878   AddCXXSummary(
879       cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider,
880       "libc++ std::list summary provider",
881       // A POSIX variant of: "^std::__(?!cxx11:)[[:alnum:]]+::list<.+>$"
882       // so that it does not clash with: "^std::(__cxx11::)?list<.+>$"
883       "^std::__([A-Zabd-z0-9]|cx?[A-Za-wyz0-9]|cxx1?[A-Za-z02-9]|"
884       "cxx11[[:alnum:]])[[:alnum:]]*::list<.+>$",
885       stl_summary_flags, true);
886   AddCXXSummary(cpp_category_sp,
887                 lldb_private::formatters::LibcxxContainerSummaryProvider,
888                 "libc++ std::map summary provider",
889                 "^std::__[[:alnum:]]+::map<.+>$", stl_summary_flags, true);
890   AddCXXSummary(cpp_category_sp,
891                 lldb_private::formatters::LibcxxContainerSummaryProvider,
892                 "libc++ std::deque summary provider",
893                 "^std::__[[:alnum:]]+::deque<.+>$", stl_summary_flags, true);
894   AddCXXSummary(cpp_category_sp,
895                 lldb_private::formatters::LibcxxContainerSummaryProvider,
896                 "libc++ std::queue summary provider",
897                 "^std::__[[:alnum:]]+::queue<.+>$", stl_summary_flags, true);
898   AddCXXSummary(cpp_category_sp,
899                 lldb_private::formatters::LibcxxContainerSummaryProvider,
900                 "libc++ std::set summary provider",
901                 "^std::__[[:alnum:]]+::set<.+>$", stl_summary_flags, true);
902   AddCXXSummary(cpp_category_sp,
903                 lldb_private::formatters::LibcxxContainerSummaryProvider,
904                 "libc++ std::multiset summary provider",
905                 "^std::__[[:alnum:]]+::multiset<.+>$", stl_summary_flags, true);
906   AddCXXSummary(cpp_category_sp,
907                 lldb_private::formatters::LibcxxContainerSummaryProvider,
908                 "libc++ std::multimap summary provider",
909                 "^std::__[[:alnum:]]+::multimap<.+>$", stl_summary_flags, true);
910   AddCXXSummary(cpp_category_sp,
911                 lldb_private::formatters::LibcxxContainerSummaryProvider,
912                 "libc++ std::unordered containers summary provider",
913                 "^std::__[[:alnum:]]+::unordered_(multi)?(map|set)<.+> >$",
914                 stl_summary_flags, true);
915   AddCXXSummary(cpp_category_sp, LibcxxContainerSummaryProvider,
916                 "libc++ std::tuple summary provider",
917                 "^std::__[[:alnum:]]+::tuple<.*>$", stl_summary_flags, true);
918   AddCXXSummary(cpp_category_sp,
919                 lldb_private::formatters::LibCxxAtomicSummaryProvider,
920                 "libc++ std::atomic summary provider",
921                 "^std::__[[:alnum:]]+::atomic<.+>$", stl_summary_flags, true);
922   AddCXXSummary(cpp_category_sp,
923                 lldb_private::formatters::GenericOptionalSummaryProvider,
924                 "libc++ std::optional summary provider",
925                 "^std::__[[:alnum:]]+::optional<.+>$", stl_summary_flags, true);
926   AddCXXSummary(cpp_category_sp,
927                 lldb_private::formatters::LibcxxVariantSummaryProvider,
928                 "libc++ std::variant summary provider",
929                 "^std::__[[:alnum:]]+::variant<.+>$", stl_summary_flags, true);
930   AddCXXSummary(cpp_category_sp,
931                 lldb_private::formatters::LibcxxContainerSummaryProvider,
932                 "libc++ std::span summary provider",
933                 "^std::__[[:alnum:]]+::span<.+>$", stl_summary_flags, true);
934 
935   stl_summary_flags.SetSkipPointers(true);
936 
937   AddCXXSummary(cpp_category_sp,
938                 lldb_private::formatters::LibcxxSmartPointerSummaryProvider,
939                 "libc++ std::shared_ptr summary provider",
940                 "^std::__[[:alnum:]]+::shared_ptr<.+>$", stl_summary_flags,
941                 true);
942   AddCXXSummary(cpp_category_sp,
943                 lldb_private::formatters::LibcxxSmartPointerSummaryProvider,
944                 "libc++ std::weak_ptr summary provider",
945                 "^std::__[[:alnum:]]+::weak_ptr<.+>$", stl_summary_flags, true);
946   AddCXXSummary(cpp_category_sp,
947                 lldb_private::formatters::LibcxxUniquePointerSummaryProvider,
948                 "libc++ std::unique_ptr summary provider",
949                 libcxx_std_unique_ptr_regex, stl_summary_flags, true);
950 
951   AddCXXSummary(cpp_category_sp,
952                 lldb_private::formatters::StdlibCoroutineHandleSummaryProvider,
953                 "libc++ std::coroutine_handle summary provider",
954                 libcxx_std_coroutine_handle_regex, stl_summary_flags, true);
955 
956   AddCXXSynthetic(
957       cpp_category_sp,
958       lldb_private::formatters::LibCxxVectorIteratorSyntheticFrontEndCreator,
959       "std::vector iterator synthetic children",
960       "^std::__[[:alnum:]]+::__wrap_iter<.+>$", stl_synth_flags, true);
961 
962   AddCXXSynthetic(
963       cpp_category_sp,
964       lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEndCreator,
965       "std::map iterator synthetic children",
966       "^std::__[[:alnum:]]+::__map_(const_)?iterator<.+>$", stl_synth_flags,
967       true);
968 
969   AddCXXSynthetic(cpp_category_sp,
970                   lldb_private::formatters::
971                       LibCxxUnorderedMapIteratorSyntheticFrontEndCreator,
972                   "std::unordered_map iterator synthetic children",
973                   "^std::__[[:alnum:]]+::__hash_map_(const_)?iterator<.+>$",
974                   stl_synth_flags, true);
975   // Chrono duration typedefs
976   cpp_category_sp->AddTypeSummary(
977       "^std::__[[:alnum:]]+::chrono::nanoseconds", eFormatterMatchRegex,
978       TypeSummaryImplSP(new StringSummaryFormat(
979           eTypeOptionHideChildren | eTypeOptionHideValue, "${var.__rep_} ns")));
980   cpp_category_sp->AddTypeSummary(
981       "^std::__[[:alnum:]]+::chrono::microseconds", eFormatterMatchRegex,
982       TypeSummaryImplSP(new StringSummaryFormat(
983           eTypeOptionHideChildren | eTypeOptionHideValue, "${var.__rep_} µs")));
984   cpp_category_sp->AddTypeSummary(
985       "^std::__[[:alnum:]]+::chrono::milliseconds", eFormatterMatchRegex,
986       TypeSummaryImplSP(new StringSummaryFormat(
987           eTypeOptionHideChildren | eTypeOptionHideValue, "${var.__rep_} ms")));
988   cpp_category_sp->AddTypeSummary(
989       "^std::__[[:alnum:]]+::chrono::seconds", eFormatterMatchRegex,
990       TypeSummaryImplSP(new StringSummaryFormat(
991           eTypeOptionHideChildren | eTypeOptionHideValue, "${var.__rep_} s")));
992   cpp_category_sp->AddTypeSummary(
993       "^std::__[[:alnum:]]+::chrono::minutes", eFormatterMatchRegex,
994       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
995                                                     eTypeOptionHideValue,
996                                                 "${var.__rep_} min")));
997   cpp_category_sp->AddTypeSummary(
998       "^std::__[[:alnum:]]+::chrono::hours", eFormatterMatchRegex,
999       TypeSummaryImplSP(new StringSummaryFormat(
1000           eTypeOptionHideChildren | eTypeOptionHideValue, "${var.__rep_} h")));
1001 
1002   cpp_category_sp->AddTypeSummary(
1003       "^std::__[[:alnum:]]+::chrono::days", eFormatterMatchRegex,
1004       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
1005                                                     eTypeOptionHideValue,
1006                                                 "${var.__rep_} days")));
1007   cpp_category_sp->AddTypeSummary(
1008       "^std::__[[:alnum:]]+::chrono::weeks", eFormatterMatchRegex,
1009       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
1010                                                     eTypeOptionHideValue,
1011                                                 "${var.__rep_} weeks")));
1012   cpp_category_sp->AddTypeSummary(
1013       "^std::__[[:alnum:]]+::chrono::months", eFormatterMatchRegex,
1014       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
1015                                                     eTypeOptionHideValue,
1016                                                 "${var.__rep_} months")));
1017   cpp_category_sp->AddTypeSummary(
1018       "^std::__[[:alnum:]]+::chrono::years", eFormatterMatchRegex,
1019       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
1020                                                     eTypeOptionHideValue,
1021                                                 "${var.__rep_} years")));
1022   cpp_category_sp->AddTypeSummary(
1023       "^std::__[[:alnum:]]+::chrono::seconds", eFormatterMatchRegex,
1024       TypeSummaryImplSP(new StringSummaryFormat(
1025           eTypeOptionHideChildren | eTypeOptionHideValue, "${var.__rep_} s")));
1026 
1027   // Chrono time point types
1028 
1029   AddCXXSummary(cpp_category_sp,
1030                 lldb_private::formatters::LibcxxChronoSysSecondsSummaryProvider,
1031                 "libc++ std::chrono::sys_seconds summary provider",
1032                 "^std::__[[:alnum:]]+::chrono::time_point<"
1033                 "std::__[[:alnum:]]+::chrono::system_clock, "
1034                 "std::__[[:alnum:]]+::chrono::duration<long long, "
1035                 "std::__[[:alnum:]]+::ratio<1, 1> "
1036                 "> >$",
1037                 eTypeOptionHideChildren | eTypeOptionHideValue |
1038                     eTypeOptionCascade,
1039                 true);
1040   AddCXXSummary(cpp_category_sp,
1041                 lldb_private::formatters::LibcxxChronoSysDaysSummaryProvider,
1042                 "libc++ std::chrono::sys_seconds summary provider",
1043                 "^std::__[[:alnum:]]+::chrono::time_point<"
1044                 "std::__[[:alnum:]]+::chrono::system_clock, "
1045                 "std::__[[:alnum:]]+::chrono::duration<int, "
1046                 "std::__[[:alnum:]]+::ratio<86400, 1> "
1047                 "> >$",
1048                 eTypeOptionHideChildren | eTypeOptionHideValue |
1049                     eTypeOptionCascade,
1050                 true);
1051 
1052   // Chrono calendar types
1053 
1054   cpp_category_sp->AddTypeSummary(
1055       "^std::__[[:alnum:]]+::chrono::day$", eFormatterMatchRegex,
1056       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
1057                                                     eTypeOptionHideValue,
1058                                                 "day=${var.__d_%u}")));
1059 
1060   AddCXXSummary(cpp_category_sp,
1061                 lldb_private::formatters::LibcxxChronoMonthSummaryProvider,
1062                 "libc++ std::chrono::month summary provider",
1063                 "^std::__[[:alnum:]]+::chrono::month$",
1064                 eTypeOptionHideChildren | eTypeOptionHideValue, true);
1065 
1066   cpp_category_sp->AddTypeSummary(
1067       "^std::__[[:alnum:]]+::chrono::year$", eFormatterMatchRegex,
1068       TypeSummaryImplSP(new StringSummaryFormat(
1069           eTypeOptionHideChildren | eTypeOptionHideValue, "year=${var.__y_}")));
1070 
1071   AddCXXSummary(cpp_category_sp,
1072                 lldb_private::formatters::LibcxxChronoWeekdaySummaryProvider,
1073                 "libc++ std::chrono::weekday summary provider",
1074                 "^std::__[[:alnum:]]+::chrono::weekday$",
1075                 eTypeOptionHideChildren | eTypeOptionHideValue, true);
1076 
1077   cpp_category_sp->AddTypeSummary(
1078       "^std::__[[:alnum:]]+::chrono::weekday_indexed$", eFormatterMatchRegex,
1079       TypeSummaryImplSP(new StringSummaryFormat(
1080           eTypeOptionHideChildren | eTypeOptionHideValue,
1081           "${var.__wd_} index=${var.__idx_%u}")));
1082 
1083   cpp_category_sp->AddTypeSummary(
1084       "^std::__[[:alnum:]]+::chrono::weekday_last$", eFormatterMatchRegex,
1085       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
1086                                                     eTypeOptionHideValue,
1087                                                 "${var.__wd_} index=last")));
1088   cpp_category_sp->AddTypeSummary(
1089       "^std::__[[:alnum:]]+::chrono::month_day$", eFormatterMatchRegex,
1090       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
1091                                                     eTypeOptionHideValue,
1092                                                 "${var.__m_} ${var.__d_}")));
1093   cpp_category_sp->AddTypeSummary(
1094       "^std::__[[:alnum:]]+::chrono::month_day_last$", eFormatterMatchRegex,
1095       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
1096                                                     eTypeOptionHideValue,
1097                                                 "${var.__m_} day=last")));
1098 
1099   cpp_category_sp->AddTypeSummary(
1100       "^std::__[[:alnum:]]+::chrono::month_weekday$", eFormatterMatchRegex,
1101       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
1102                                                     eTypeOptionHideValue,
1103                                                 "${var.__m_} ${var.__wdi_}")));
1104 
1105   cpp_category_sp->AddTypeSummary(
1106       "^std::__[[:alnum:]]+::chrono::month_weekday_last$", eFormatterMatchRegex,
1107       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
1108                                                     eTypeOptionHideValue,
1109                                                 "${var.__m_} ${var.__wdl_}")));
1110 
1111   cpp_category_sp->AddTypeSummary(
1112       "^std::__[[:alnum:]]+::chrono::year_month$", eFormatterMatchRegex,
1113       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
1114                                                     eTypeOptionHideValue,
1115                                                 "${var.__y_} ${var.__m_}")));
1116 
1117   AddCXXSummary(
1118       cpp_category_sp,
1119       lldb_private::formatters::LibcxxChronoYearMonthDaySummaryProvider,
1120       "libc++ std::chrono::year_month_day summary provider",
1121       "^std::__[[:alnum:]]+::chrono::year_month_day$",
1122       eTypeOptionHideChildren | eTypeOptionHideValue, true);
1123 
1124   cpp_category_sp->AddTypeSummary(
1125       "^std::__[[:alnum:]]+::chrono::year_month_day_last$",
1126       eFormatterMatchRegex,
1127       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
1128                                                     eTypeOptionHideValue,
1129                                                 "${var.__y_} ${var.__mdl_}")));
1130 
1131   cpp_category_sp->AddTypeSummary(
1132       "^std::__[[:alnum:]]+::chrono::year_month_weekday$", eFormatterMatchRegex,
1133       TypeSummaryImplSP(new StringSummaryFormat(
1134           eTypeOptionHideChildren | eTypeOptionHideValue,
1135           "${var.__y_} ${var.__m_} ${var.__wdi_}")));
1136 
1137   cpp_category_sp->AddTypeSummary(
1138       "^std::__[[:alnum:]]+::chrono::year_month_weekday_last$",
1139       eFormatterMatchRegex,
1140       TypeSummaryImplSP(new StringSummaryFormat(
1141           eTypeOptionHideChildren | eTypeOptionHideValue,
1142           "${var.__y_} ${var.__m_} ${var.__wdl_}")));
1143 }
1144 
1145 static void LoadLibStdcppFormatters(lldb::TypeCategoryImplSP cpp_category_sp) {
1146   if (!cpp_category_sp)
1147     return;
1148 
1149   TypeSummaryImpl::Flags stl_summary_flags;
1150   stl_summary_flags.SetCascades(true)
1151       .SetSkipPointers(false)
1152       .SetSkipReferences(false)
1153       .SetDontShowChildren(true)
1154       .SetDontShowValue(true)
1155       .SetShowMembersOneLiner(false)
1156       .SetHideItemNames(false);
1157 
1158   lldb::TypeSummaryImplSP std_string_summary_sp(
1159       new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p}"));
1160 
1161   lldb::TypeSummaryImplSP cxx11_string_summary_sp(new CXXFunctionSummaryFormat(
1162       stl_summary_flags, LibStdcppStringSummaryProvider,
1163       "libstdc++ c++11 std::string summary provider"));
1164   lldb::TypeSummaryImplSP cxx11_wstring_summary_sp(new CXXFunctionSummaryFormat(
1165       stl_summary_flags, LibStdcppWStringSummaryProvider,
1166       "libstdc++ c++11 std::wstring summary provider"));
1167 
1168   cpp_category_sp->AddTypeSummary("std::string", eFormatterMatchExact,
1169                                   std_string_summary_sp);
1170   cpp_category_sp->AddTypeSummary("std::basic_string<char>",
1171                                   eFormatterMatchExact, std_string_summary_sp);
1172   cpp_category_sp->AddTypeSummary(
1173       "std::basic_string<char,std::char_traits<char>,std::allocator<char> >",
1174       eFormatterMatchExact, std_string_summary_sp);
1175   cpp_category_sp->AddTypeSummary(
1176       "std::basic_string<char, std::char_traits<char>, std::allocator<char> >",
1177       eFormatterMatchExact, std_string_summary_sp);
1178 
1179   cpp_category_sp->AddTypeSummary("std::__cxx11::string", eFormatterMatchExact,
1180                                   cxx11_string_summary_sp);
1181   cpp_category_sp->AddTypeSummary(
1182       "std::__cxx11::basic_string<char, std::char_traits<char>, "
1183       "std::allocator<char> >",
1184       eFormatterMatchExact, cxx11_string_summary_sp);
1185   cpp_category_sp->AddTypeSummary("std::__cxx11::basic_string<unsigned char, "
1186                                   "std::char_traits<unsigned char>, "
1187                                   "std::allocator<unsigned char> >",
1188                                   eFormatterMatchExact,
1189                                   cxx11_string_summary_sp);
1190 
1191   // making sure we force-pick the summary for printing wstring (_M_p is a
1192   // wchar_t*)
1193   lldb::TypeSummaryImplSP std_wstring_summary_sp(
1194       new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p%S}"));
1195 
1196   cpp_category_sp->AddTypeSummary("std::wstring", eFormatterMatchExact,
1197                                   std_wstring_summary_sp);
1198   cpp_category_sp->AddTypeSummary("std::basic_string<wchar_t>",
1199                                   eFormatterMatchExact, std_wstring_summary_sp);
1200   cpp_category_sp->AddTypeSummary("std::basic_string<wchar_t,std::char_traits<"
1201                                   "wchar_t>,std::allocator<wchar_t> >",
1202                                   eFormatterMatchExact, std_wstring_summary_sp);
1203   cpp_category_sp->AddTypeSummary(
1204       "std::basic_string<wchar_t, std::char_traits<wchar_t>, "
1205       "std::allocator<wchar_t> >",
1206       eFormatterMatchExact, std_wstring_summary_sp);
1207 
1208   cpp_category_sp->AddTypeSummary("std::__cxx11::wstring", eFormatterMatchExact,
1209                                   cxx11_wstring_summary_sp);
1210   cpp_category_sp->AddTypeSummary(
1211       "std::__cxx11::basic_string<wchar_t, std::char_traits<wchar_t>, "
1212       "std::allocator<wchar_t> >",
1213       eFormatterMatchExact, cxx11_wstring_summary_sp);
1214 
1215   SyntheticChildren::Flags stl_synth_flags;
1216   stl_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences(
1217       false);
1218   SyntheticChildren::Flags stl_deref_flags = stl_synth_flags;
1219   stl_deref_flags.SetFrontEndWantsDereference();
1220 
1221   cpp_category_sp->AddTypeSynthetic(
1222       "^std::vector<.+>(( )?&)?$", eFormatterMatchRegex,
1223       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1224           stl_synth_flags,
1225           "lldb.formatters.cpp.gnu_libstdcpp.StdVectorSynthProvider")));
1226   cpp_category_sp->AddTypeSynthetic(
1227       "^std::map<.+> >(( )?&)?$", eFormatterMatchRegex,
1228       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1229           stl_synth_flags,
1230           "lldb.formatters.cpp.gnu_libstdcpp.StdMapLikeSynthProvider")));
1231   cpp_category_sp->AddTypeSynthetic(
1232       "^std::deque<.+>(( )?&)?$", eFormatterMatchRegex,
1233       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1234           stl_deref_flags,
1235           "lldb.formatters.cpp.gnu_libstdcpp.StdDequeSynthProvider")));
1236   cpp_category_sp->AddTypeSynthetic(
1237       "^std::set<.+> >(( )?&)?$", eFormatterMatchRegex,
1238       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1239           stl_deref_flags,
1240           "lldb.formatters.cpp.gnu_libstdcpp.StdMapLikeSynthProvider")));
1241   cpp_category_sp->AddTypeSynthetic(
1242       "^std::multimap<.+> >(( )?&)?$", eFormatterMatchRegex,
1243       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1244           stl_deref_flags,
1245           "lldb.formatters.cpp.gnu_libstdcpp.StdMapLikeSynthProvider")));
1246   cpp_category_sp->AddTypeSynthetic(
1247       "^std::multiset<.+> >(( )?&)?$", eFormatterMatchRegex,
1248       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1249           stl_deref_flags,
1250           "lldb.formatters.cpp.gnu_libstdcpp.StdMapLikeSynthProvider")));
1251   cpp_category_sp->AddTypeSynthetic(
1252       "^std::unordered_(multi)?(map|set)<.+> >$", eFormatterMatchRegex,
1253       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1254           stl_deref_flags,
1255           "lldb.formatters.cpp.gnu_libstdcpp.StdUnorderedMapSynthProvider")));
1256   cpp_category_sp->AddTypeSynthetic(
1257       "^std::(__cxx11::)?list<.+>(( )?&)?$", eFormatterMatchRegex,
1258       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1259           stl_deref_flags,
1260           "lldb.formatters.cpp.gnu_libstdcpp.StdListSynthProvider")));
1261   cpp_category_sp->AddTypeSynthetic(
1262       "^std::(__cxx11::)?forward_list<.+>(( )?&)?$", eFormatterMatchRegex,
1263       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1264           stl_synth_flags,
1265           "lldb.formatters.cpp.gnu_libstdcpp.StdForwardListSynthProvider")));
1266   cpp_category_sp->AddTypeSynthetic(
1267       "^std::variant<.+>$", eFormatterMatchRegex,
1268       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1269           stl_synth_flags,
1270           "lldb.formatters.cpp.gnu_libstdcpp.VariantSynthProvider")));
1271 
1272   stl_summary_flags.SetDontShowChildren(false);
1273   stl_summary_flags.SetSkipPointers(false);
1274   cpp_category_sp->AddTypeSummary("^std::bitset<.+>(( )?&)?$",
1275                                   eFormatterMatchRegex,
1276                                   TypeSummaryImplSP(new StringSummaryFormat(
1277                                       stl_summary_flags, "size=${svar%#}")));
1278   cpp_category_sp->AddTypeSummary("^std::vector<.+>(( )?&)?$",
1279                                   eFormatterMatchRegex,
1280                                   TypeSummaryImplSP(new StringSummaryFormat(
1281                                       stl_summary_flags, "size=${svar%#}")));
1282   cpp_category_sp->AddTypeSummary("^std::map<.+> >(( )?&)?$",
1283                                   eFormatterMatchRegex,
1284                                   TypeSummaryImplSP(new StringSummaryFormat(
1285                                       stl_summary_flags, "size=${svar%#}")));
1286   cpp_category_sp->AddTypeSummary("^std::set<.+> >(( )?&)?$",
1287                                   eFormatterMatchRegex,
1288                                   TypeSummaryImplSP(new StringSummaryFormat(
1289                                       stl_summary_flags, "size=${svar%#}")));
1290   cpp_category_sp->AddTypeSummary("^std::deque<.+>(( )?&)?$",
1291                                   eFormatterMatchRegex,
1292                                   TypeSummaryImplSP(new StringSummaryFormat(
1293                                       stl_summary_flags, "size=${svar%#}")));
1294   cpp_category_sp->AddTypeSummary("^std::multimap<.+> >(( )?&)?$",
1295                                   eFormatterMatchRegex,
1296                                   TypeSummaryImplSP(new StringSummaryFormat(
1297                                       stl_summary_flags, "size=${svar%#}")));
1298   cpp_category_sp->AddTypeSummary("^std::multiset<.+> >(( )?&)?$",
1299                                   eFormatterMatchRegex,
1300                                   TypeSummaryImplSP(new StringSummaryFormat(
1301                                       stl_summary_flags, "size=${svar%#}")));
1302   cpp_category_sp->AddTypeSummary("^std::unordered_(multi)?(map|set)<.+> >$",
1303                                   eFormatterMatchRegex,
1304                                   TypeSummaryImplSP(new StringSummaryFormat(
1305                                       stl_summary_flags, "size=${svar%#}")));
1306   cpp_category_sp->AddTypeSummary("^std::(__cxx11::)?list<.+>(( )?&)?$",
1307                                   eFormatterMatchRegex,
1308                                   TypeSummaryImplSP(new StringSummaryFormat(
1309                                       stl_summary_flags, "size=${svar%#}")));
1310   cpp_category_sp->AddTypeSummary(
1311       "^std::(__cxx11::)?forward_list<.+>(( )?&)?$", eFormatterMatchRegex,
1312       TypeSummaryImplSP(new ScriptSummaryFormat(
1313           stl_summary_flags,
1314           "lldb.formatters.cpp.gnu_libstdcpp.ForwardListSummaryProvider")));
1315   cpp_category_sp->AddTypeSummary(
1316       "^std::variant<.+>$", eFormatterMatchRegex,
1317       TypeSummaryImplSP(new ScriptSummaryFormat(
1318           stl_summary_flags,
1319           "lldb.formatters.cpp.gnu_libstdcpp.VariantSummaryProvider")));
1320 
1321   AddCXXSynthetic(
1322       cpp_category_sp,
1323       lldb_private::formatters::LibStdcppVectorIteratorSyntheticFrontEndCreator,
1324       "std::vector iterator synthetic children",
1325       "^__gnu_cxx::__normal_iterator<.+>$", stl_synth_flags, true);
1326 
1327   AddCXXSynthetic(
1328       cpp_category_sp,
1329       lldb_private::formatters::LibstdcppMapIteratorSyntheticFrontEndCreator,
1330       "std::map iterator synthetic children", "^std::_Rb_tree_iterator<.+>$",
1331       stl_synth_flags, true);
1332 
1333   AddCXXSynthetic(
1334       cpp_category_sp,
1335       lldb_private::formatters::LibStdcppUniquePtrSyntheticFrontEndCreator,
1336       "std::unique_ptr synthetic children", "^std::unique_ptr<.+>(( )?&)?$",
1337       stl_synth_flags, true);
1338   AddCXXSynthetic(
1339       cpp_category_sp,
1340       lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator,
1341       "std::shared_ptr synthetic children", "^std::shared_ptr<.+>(( )?&)?$",
1342       stl_synth_flags, true);
1343   AddCXXSynthetic(
1344       cpp_category_sp,
1345       lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator,
1346       "std::weak_ptr synthetic children", "^std::weak_ptr<.+>(( )?&)?$",
1347       stl_synth_flags, true);
1348   AddCXXSynthetic(
1349       cpp_category_sp,
1350       lldb_private::formatters::LibStdcppTupleSyntheticFrontEndCreator,
1351       "std::tuple synthetic children", "^std::tuple<.+>(( )?&)?$",
1352       stl_synth_flags, true);
1353 
1354   static constexpr const char *const libstdcpp_std_coroutine_handle_regex =
1355       "^std::coroutine_handle<.+>(( )?&)?$";
1356   AddCXXSynthetic(
1357       cpp_category_sp,
1358       lldb_private::formatters::StdlibCoroutineHandleSyntheticFrontEndCreator,
1359       "std::coroutine_handle synthetic children",
1360       libstdcpp_std_coroutine_handle_regex, stl_deref_flags, true);
1361 
1362   AddCXXSynthetic(
1363       cpp_category_sp,
1364       lldb_private::formatters::LibStdcppBitsetSyntheticFrontEndCreator,
1365       "std::bitset synthetic child", "^std::bitset<.+>(( )?&)?$",
1366       stl_deref_flags, true);
1367 
1368   AddCXXSynthetic(
1369       cpp_category_sp,
1370       lldb_private::formatters::LibStdcppOptionalSyntheticFrontEndCreator,
1371       "std::optional synthetic child", "^std::optional<.+>(( )?&)?$",
1372       stl_deref_flags, true);
1373 
1374   AddCXXSummary(cpp_category_sp,
1375                 lldb_private::formatters::LibStdcppUniquePointerSummaryProvider,
1376                 "libstdc++ std::unique_ptr summary provider",
1377                 "^std::unique_ptr<.+>(( )?&)?$", stl_summary_flags, true);
1378   AddCXXSummary(cpp_category_sp,
1379                 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider,
1380                 "libstdc++ std::shared_ptr summary provider",
1381                 "^std::shared_ptr<.+>(( )?&)?$", stl_summary_flags, true);
1382   AddCXXSummary(cpp_category_sp,
1383                 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider,
1384                 "libstdc++ std::weak_ptr summary provider",
1385                 "^std::weak_ptr<.+>(( )?&)?$", stl_summary_flags, true);
1386   AddCXXSummary(cpp_category_sp,
1387                 lldb_private::formatters::StdlibCoroutineHandleSummaryProvider,
1388                 "libstdc++ std::coroutine_handle summary provider",
1389                 libstdcpp_std_coroutine_handle_regex, stl_summary_flags, true);
1390   AddCXXSummary(cpp_category_sp,
1391                 lldb_private::formatters::GenericOptionalSummaryProvider,
1392                 "libstd++ std::optional summary provider",
1393                 "^std::optional<.+>(( )?&)?$", stl_summary_flags, true);
1394 }
1395 
1396 static void LoadSystemFormatters(lldb::TypeCategoryImplSP cpp_category_sp) {
1397   if (!cpp_category_sp)
1398     return;
1399 
1400   TypeSummaryImpl::Flags string_flags;
1401   string_flags.SetCascades(true)
1402       .SetSkipPointers(true)
1403       .SetSkipReferences(false)
1404       .SetDontShowChildren(true)
1405       .SetDontShowValue(false)
1406       .SetShowMembersOneLiner(false)
1407       .SetHideItemNames(false);
1408 
1409   TypeSummaryImpl::Flags string_array_flags;
1410   string_array_flags.SetCascades(true)
1411       .SetSkipPointers(true)
1412       .SetSkipReferences(false)
1413       .SetDontShowChildren(true)
1414       .SetDontShowValue(true)
1415       .SetShowMembersOneLiner(false)
1416       .SetHideItemNames(false);
1417 
1418   AddCXXSummary(cpp_category_sp,
1419                 lldb_private::formatters::Char8StringSummaryProvider,
1420                 "char8_t * summary provider", "char8_t *", string_flags);
1421   AddCXXSummary(cpp_category_sp,
1422                 lldb_private::formatters::Char8StringSummaryProvider,
1423                 "char8_t [] summary provider", "char8_t ?\\[[0-9]+\\]",
1424                 string_array_flags, true);
1425 
1426   AddCXXSummary(cpp_category_sp,
1427                 lldb_private::formatters::Char16StringSummaryProvider,
1428                 "char16_t * summary provider", "char16_t *", string_flags);
1429   AddCXXSummary(cpp_category_sp,
1430                 lldb_private::formatters::Char16StringSummaryProvider,
1431                 "char16_t [] summary provider", "char16_t ?\\[[0-9]+\\]",
1432                 string_array_flags, true);
1433 
1434   AddCXXSummary(cpp_category_sp,
1435                 lldb_private::formatters::Char32StringSummaryProvider,
1436                 "char32_t * summary provider", "char32_t *", string_flags);
1437   AddCXXSummary(cpp_category_sp,
1438                 lldb_private::formatters::Char32StringSummaryProvider,
1439                 "char32_t [] summary provider", "char32_t ?\\[[0-9]+\\]",
1440                 string_array_flags, true);
1441 
1442   AddCXXSummary(cpp_category_sp,
1443                 lldb_private::formatters::WCharStringSummaryProvider,
1444                 "wchar_t * summary provider", "wchar_t *", string_flags);
1445   AddCXXSummary(cpp_category_sp,
1446                 lldb_private::formatters::WCharStringSummaryProvider,
1447                 "wchar_t * summary provider", "wchar_t ?\\[[0-9]+\\]",
1448                 string_array_flags, true);
1449 
1450   AddCXXSummary(cpp_category_sp,
1451                 lldb_private::formatters::Char16StringSummaryProvider,
1452                 "unichar * summary provider", "unichar *", string_flags);
1453 
1454   TypeSummaryImpl::Flags widechar_flags;
1455   widechar_flags.SetDontShowValue(true)
1456       .SetSkipPointers(true)
1457       .SetSkipReferences(false)
1458       .SetCascades(true)
1459       .SetDontShowChildren(true)
1460       .SetHideItemNames(true)
1461       .SetShowMembersOneLiner(false);
1462 
1463   AddCXXSummary(cpp_category_sp, lldb_private::formatters::Char8SummaryProvider,
1464                 "char8_t summary provider", "char8_t", widechar_flags);
1465   AddCXXSummary(cpp_category_sp,
1466                 lldb_private::formatters::Char16SummaryProvider,
1467                 "char16_t summary provider", "char16_t", widechar_flags);
1468   AddCXXSummary(cpp_category_sp,
1469                 lldb_private::formatters::Char32SummaryProvider,
1470                 "char32_t summary provider", "char32_t", widechar_flags);
1471   AddCXXSummary(cpp_category_sp, lldb_private::formatters::WCharSummaryProvider,
1472                 "wchar_t summary provider", "wchar_t", widechar_flags);
1473 
1474   AddCXXSummary(cpp_category_sp,
1475                 lldb_private::formatters::Char16SummaryProvider,
1476                 "unichar summary provider", "unichar", widechar_flags);
1477 }
1478 
1479 std::unique_ptr<Language::TypeScavenger> CPlusPlusLanguage::GetTypeScavenger() {
1480   class CPlusPlusTypeScavenger : public Language::ImageListTypeScavenger {
1481   public:
1482     CompilerType AdjustForInclusion(CompilerType &candidate) override {
1483       LanguageType lang_type(candidate.GetMinimumLanguage());
1484       if (!Language::LanguageIsC(lang_type) &&
1485           !Language::LanguageIsCPlusPlus(lang_type))
1486         return CompilerType();
1487       if (candidate.IsTypedefType())
1488         return candidate.GetTypedefedType();
1489       return candidate;
1490     }
1491   };
1492 
1493   return std::unique_ptr<TypeScavenger>(new CPlusPlusTypeScavenger());
1494 }
1495 
1496 lldb::TypeCategoryImplSP CPlusPlusLanguage::GetFormatters() {
1497   static llvm::once_flag g_initialize;
1498   static TypeCategoryImplSP g_category;
1499 
1500   llvm::call_once(g_initialize, [this]() -> void {
1501     DataVisualization::Categories::GetCategory(ConstString(GetPluginName()),
1502                                                g_category);
1503     if (g_category) {
1504       LoadLibStdcppFormatters(g_category);
1505       LoadLibCxxFormatters(g_category);
1506       LoadSystemFormatters(g_category);
1507     }
1508   });
1509   return g_category;
1510 }
1511 
1512 HardcodedFormatters::HardcodedSummaryFinder
1513 CPlusPlusLanguage::GetHardcodedSummaries() {
1514   static llvm::once_flag g_initialize;
1515   static ConstString g_vectortypes("VectorTypes");
1516   static HardcodedFormatters::HardcodedSummaryFinder g_formatters;
1517 
1518   llvm::call_once(g_initialize, []() -> void {
1519     g_formatters.push_back(
1520         [](lldb_private::ValueObject &valobj, lldb::DynamicValueType,
1521            FormatManager &) -> TypeSummaryImpl::SharedPointer {
1522           static CXXFunctionSummaryFormat::SharedPointer formatter_sp(
1523               new CXXFunctionSummaryFormat(
1524                   TypeSummaryImpl::Flags(),
1525                   lldb_private::formatters::CXXFunctionPointerSummaryProvider,
1526                   "Function pointer summary provider"));
1527           if (CompilerType CT = valobj.GetCompilerType();
1528               CT.IsFunctionPointerType() || CT.IsMemberFunctionPointerType() ||
1529               valobj.GetValueType() == lldb::eValueTypeVTableEntry) {
1530             return formatter_sp;
1531           }
1532           return nullptr;
1533         });
1534     g_formatters.push_back(
1535         [](lldb_private::ValueObject &valobj, lldb::DynamicValueType,
1536            FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer {
1537           static CXXFunctionSummaryFormat::SharedPointer formatter_sp(
1538               new CXXFunctionSummaryFormat(
1539                   TypeSummaryImpl::Flags()
1540                       .SetCascades(true)
1541                       .SetDontShowChildren(true)
1542                       .SetHideItemNames(true)
1543                       .SetShowMembersOneLiner(true)
1544                       .SetSkipPointers(true)
1545                       .SetSkipReferences(false),
1546                   lldb_private::formatters::VectorTypeSummaryProvider,
1547                   "vector_type pointer summary provider"));
1548           if (valobj.GetCompilerType().IsVectorType()) {
1549             if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled())
1550               return formatter_sp;
1551           }
1552           return nullptr;
1553         });
1554     g_formatters.push_back(
1555         [](lldb_private::ValueObject &valobj, lldb::DynamicValueType,
1556            FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer {
1557           static CXXFunctionSummaryFormat::SharedPointer formatter_sp(
1558               new CXXFunctionSummaryFormat(
1559                   TypeSummaryImpl::Flags()
1560                       .SetCascades(true)
1561                       .SetDontShowChildren(true)
1562                       .SetHideItemNames(true)
1563                       .SetShowMembersOneLiner(true)
1564                       .SetSkipPointers(true)
1565                       .SetSkipReferences(false),
1566                   lldb_private::formatters::BlockPointerSummaryProvider,
1567                   "block pointer summary provider"));
1568           if (valobj.GetCompilerType().IsBlockPointerType()) {
1569             return formatter_sp;
1570           }
1571           return nullptr;
1572         });
1573   });
1574 
1575   return g_formatters;
1576 }
1577 
1578 HardcodedFormatters::HardcodedSyntheticFinder
1579 CPlusPlusLanguage::GetHardcodedSynthetics() {
1580   static llvm::once_flag g_initialize;
1581   static ConstString g_vectortypes("VectorTypes");
1582   static HardcodedFormatters::HardcodedSyntheticFinder g_formatters;
1583 
1584   llvm::call_once(g_initialize, []() -> void {
1585     g_formatters.push_back([](lldb_private::ValueObject &valobj,
1586                               lldb::DynamicValueType, FormatManager &fmt_mgr)
1587                                -> SyntheticChildren::SharedPointer {
1588       static CXXSyntheticChildren::SharedPointer formatter_sp(
1589           new CXXSyntheticChildren(
1590               SyntheticChildren::Flags()
1591                   .SetCascades(true)
1592                   .SetSkipPointers(true)
1593                   .SetSkipReferences(true)
1594                   .SetNonCacheable(true),
1595               "vector_type synthetic children",
1596               lldb_private::formatters::VectorTypeSyntheticFrontEndCreator));
1597       if (valobj.GetCompilerType().IsVectorType()) {
1598         if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled())
1599           return formatter_sp;
1600       }
1601       return nullptr;
1602     });
1603     g_formatters.push_back([](lldb_private::ValueObject &valobj,
1604                               lldb::DynamicValueType, FormatManager &fmt_mgr)
1605                                -> SyntheticChildren::SharedPointer {
1606       static CXXSyntheticChildren::SharedPointer formatter_sp(
1607           new CXXSyntheticChildren(
1608               SyntheticChildren::Flags()
1609                   .SetCascades(true)
1610                   .SetSkipPointers(true)
1611                   .SetSkipReferences(true)
1612                   .SetNonCacheable(true),
1613               "block pointer synthetic children",
1614               lldb_private::formatters::BlockPointerSyntheticFrontEndCreator));
1615       if (valobj.GetCompilerType().IsBlockPointerType()) {
1616         return formatter_sp;
1617       }
1618       return nullptr;
1619     });
1620   });
1621 
1622   return g_formatters;
1623 }
1624 
1625 bool CPlusPlusLanguage::IsNilReference(ValueObject &valobj) {
1626   if (!Language::LanguageIsCPlusPlus(valobj.GetObjectRuntimeLanguage()) ||
1627       !valobj.IsPointerType())
1628     return false;
1629   bool canReadValue = true;
1630   bool isZero = valobj.GetValueAsUnsigned(0, &canReadValue) == 0;
1631   return canReadValue && isZero;
1632 }
1633 
1634 bool CPlusPlusLanguage::IsSourceFile(llvm::StringRef file_path) const {
1635   const auto suffixes = {".cpp", ".cxx", ".c++", ".cc",  ".c",
1636                          ".h",   ".hh",  ".hpp", ".hxx", ".h++"};
1637   for (auto suffix : suffixes) {
1638     if (file_path.ends_with_insensitive(suffix))
1639       return true;
1640   }
1641 
1642   // Check if we're in a STL path (where the files usually have no extension
1643   // that we could check for.
1644   return file_path.contains("/usr/include/c++/");
1645 }
1646 
1647 bool CPlusPlusLanguage::GetFunctionDisplayName(
1648     const SymbolContext *sc, const ExecutionContext *exe_ctx,
1649     FunctionNameRepresentation representation, Stream &s) {
1650   switch (representation) {
1651   case FunctionNameRepresentation::eNameWithArgs: {
1652     // Print the function name with arguments in it
1653     if (sc->function) {
1654       ExecutionContextScope *exe_scope =
1655           exe_ctx ? exe_ctx->GetBestExecutionContextScope() : nullptr;
1656       const char *cstr = sc->function->GetName().AsCString(nullptr);
1657       if (cstr) {
1658         const InlineFunctionInfo *inline_info = nullptr;
1659         VariableListSP variable_list_sp;
1660         bool get_function_vars = true;
1661         if (sc->block) {
1662           Block *inline_block = sc->block->GetContainingInlinedBlock();
1663 
1664           if (inline_block) {
1665             get_function_vars = false;
1666             inline_info = inline_block->GetInlinedFunctionInfo();
1667             if (inline_info)
1668               variable_list_sp = inline_block->GetBlockVariableList(true);
1669           }
1670         }
1671 
1672         if (get_function_vars) {
1673           variable_list_sp =
1674               sc->function->GetBlock(true).GetBlockVariableList(true);
1675         }
1676 
1677         if (inline_info) {
1678           s.PutCString(cstr);
1679           s.PutCString(" [inlined] ");
1680           cstr = inline_info->GetName().GetCString();
1681         }
1682 
1683         VariableList args;
1684         if (variable_list_sp)
1685           variable_list_sp->AppendVariablesWithScope(eValueTypeVariableArgument,
1686                                                      args);
1687         if (args.GetSize() > 0) {
1688           if (!PrettyPrintFunctionNameWithArgs(s, cstr, exe_scope, args))
1689             return false;
1690         } else {
1691           s.PutCString(cstr);
1692         }
1693         return true;
1694       }
1695     } else if (sc->symbol) {
1696       const char *cstr = sc->symbol->GetName().AsCString(nullptr);
1697       if (cstr) {
1698         s.PutCString(cstr);
1699         return true;
1700       }
1701     }
1702   } break;
1703   default:
1704     return false;
1705   }
1706 
1707   return false;
1708 }
1709