xref: /freebsd-src/contrib/llvm-project/lldb/source/Plugins/Language/CPlusPlus/CPlusPlusLanguage.cpp (revision cb14a3fe5122c879eae1fb480ed7ce82a699ddb6)
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",
771       "^std::__[[:alnum:]]+::map<.+> >(( )?&)?$", stl_synth_flags, true);
772   AddCXXSynthetic(
773       cpp_category_sp,
774       lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator,
775       "libc++ std::set synthetic children",
776       "^std::__[[:alnum:]]+::set<.+> >(( )?&)?$", 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,
801                   true);
802   AddCXXSynthetic(cpp_category_sp, LibcxxTupleFrontEndCreator,
803                   "libc++ std::tuple synthetic children",
804                   "^std::__[[:alnum:]]+::tuple<.*>(( )?&)?$", stl_synth_flags,
805                   true);
806   AddCXXSynthetic(cpp_category_sp, LibcxxOptionalSyntheticFrontEndCreator,
807                   "libc++ std::optional synthetic children",
808                   "^std::__[[:alnum:]]+::optional<.+>(( )?&)?$",
809                   stl_synth_flags, true);
810   AddCXXSynthetic(cpp_category_sp, LibcxxVariantFrontEndCreator,
811                   "libc++ std::variant synthetic children",
812                   "^std::__[[:alnum:]]+::variant<.+>(( )?&)?$", stl_synth_flags,
813                   true);
814   AddCXXSynthetic(
815       cpp_category_sp,
816       lldb_private::formatters::LibcxxAtomicSyntheticFrontEndCreator,
817       "libc++ std::atomic synthetic children",
818       "^std::__[[:alnum:]]+::atomic<.+>$", stl_synth_flags, true);
819   AddCXXSynthetic(
820       cpp_category_sp,
821       lldb_private::formatters::LibcxxStdSpanSyntheticFrontEndCreator,
822       "libc++ std::span synthetic children",
823       "^std::__[[:alnum:]]+::span<.+>(( )?&)?$", stl_deref_flags, true);
824   AddCXXSynthetic(
825       cpp_category_sp,
826       lldb_private::formatters::LibcxxStdRangesRefViewSyntheticFrontEndCreator,
827       "libc++ std::ranges::ref_view synthetic children",
828       "^std::__[[:alnum:]]+::ranges::ref_view<.+>(( )?&)?$", stl_deref_flags,
829       true);
830 
831   cpp_category_sp->AddTypeSynthetic(
832       "^(std::__[[:alnum:]]+::)deque<.+>(( )?&)?$", eFormatterMatchRegex,
833       SyntheticChildrenSP(new ScriptedSyntheticChildren(
834           stl_synth_flags,
835           "lldb.formatters.cpp.libcxx.stddeque_SynthProvider")));
836 
837   AddCXXSynthetic(
838       cpp_category_sp,
839       lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator,
840       "shared_ptr synthetic children",
841       "^(std::__[[:alnum:]]+::)shared_ptr<.+>(( )?&)?$", stl_synth_flags, true);
842 
843   static constexpr const char *const libcxx_std_unique_ptr_regex =
844       "^std::__[[:alnum:]]+::unique_ptr<.+>(( )?&)?$";
845   AddCXXSynthetic(
846       cpp_category_sp,
847       lldb_private::formatters::LibcxxUniquePtrSyntheticFrontEndCreator,
848       "unique_ptr synthetic children", libcxx_std_unique_ptr_regex,
849       stl_synth_flags, true);
850 
851   AddCXXSynthetic(
852       cpp_category_sp,
853       lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator,
854       "weak_ptr synthetic children",
855       "^(std::__[[:alnum:]]+::)weak_ptr<.+>(( )?&)?$", stl_synth_flags, true);
856   AddCXXSummary(cpp_category_sp,
857                 lldb_private::formatters::LibcxxFunctionSummaryProvider,
858                 "libc++ std::function summary provider",
859                 "^std::__[[:alnum:]]+::function<.+>$", stl_summary_flags, true);
860 
861   static constexpr const char *const libcxx_std_coroutine_handle_regex =
862       "^std::__[[:alnum:]]+::coroutine_handle<.+>(( )?&)?$";
863   AddCXXSynthetic(
864       cpp_category_sp,
865       lldb_private::formatters::StdlibCoroutineHandleSyntheticFrontEndCreator,
866       "coroutine_handle synthetic children", libcxx_std_coroutine_handle_regex,
867       stl_deref_flags, true);
868 
869   stl_summary_flags.SetDontShowChildren(false);
870   stl_summary_flags.SetSkipPointers(false);
871   AddCXXSummary(
872       cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider,
873       "libc++ std::bitset summary provider",
874       "^std::__[[:alnum:]]+::bitset<.+>(( )?&)?$", stl_summary_flags, true);
875   AddCXXSummary(
876       cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider,
877       "libc++ std::vector summary provider",
878       "^std::__[[:alnum:]]+::vector<.+>(( )?&)?$", stl_summary_flags, true);
879   AddCXXSummary(cpp_category_sp,
880                 lldb_private::formatters::LibcxxContainerSummaryProvider,
881                 "libc++ std::list summary provider",
882                 "^std::__[[:alnum:]]+::forward_list<.+>(( )?&)?$",
883                 stl_summary_flags, true);
884   AddCXXSummary(
885       cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider,
886       "libc++ std::list summary provider",
887       // A POSIX variant of: "^std::__(?!cxx11:)[[:alnum:]]+::list<.+>(( )?&)?$"
888       // so that it does not clash with: "^std::(__cxx11::)?list<.+>(( )?&)?$"
889       "^std::__([A-Zabd-z0-9]|cx?[A-Za-wyz0-9]|cxx1?[A-Za-z02-9]|"
890       "cxx11[[:alnum:]])[[:alnum:]]*::list<.+>(( )?&)?$",
891       stl_summary_flags, true);
892   AddCXXSummary(
893       cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider,
894       "libc++ std::map summary provider",
895       "^std::__[[:alnum:]]+::map<.+>(( )?&)?$", stl_summary_flags, true);
896   AddCXXSummary(
897       cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider,
898       "libc++ std::deque summary provider",
899       "^std::__[[:alnum:]]+::deque<.+>(( )?&)?$", stl_summary_flags, true);
900   AddCXXSummary(
901       cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider,
902       "libc++ std::queue summary provider",
903       "^std::__[[:alnum:]]+::queue<.+>(( )?&)?$", stl_summary_flags, true);
904   AddCXXSummary(
905       cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider,
906       "libc++ std::set summary provider",
907       "^std::__[[:alnum:]]+::set<.+>(( )?&)?$", stl_summary_flags, true);
908   AddCXXSummary(
909       cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider,
910       "libc++ std::multiset summary provider",
911       "^std::__[[:alnum:]]+::multiset<.+>(( )?&)?$", stl_summary_flags, true);
912   AddCXXSummary(
913       cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider,
914       "libc++ std::multimap summary provider",
915       "^std::__[[:alnum:]]+::multimap<.+>(( )?&)?$", stl_summary_flags, true);
916   AddCXXSummary(cpp_category_sp,
917                 lldb_private::formatters::LibcxxContainerSummaryProvider,
918                 "libc++ std::unordered containers summary provider",
919                 "^(std::__[[:alnum:]]+::)unordered_(multi)?(map|set)<.+> >$",
920                 stl_summary_flags, true);
921   AddCXXSummary(cpp_category_sp, LibcxxContainerSummaryProvider,
922                 "libc++ std::tuple summary provider",
923                 "^std::__[[:alnum:]]+::tuple<.*>(( )?&)?$", stl_summary_flags,
924                 true);
925   AddCXXSummary(cpp_category_sp,
926                 lldb_private::formatters::LibCxxAtomicSummaryProvider,
927                 "libc++ std::atomic summary provider",
928                 "^std::__[[:alnum:]]+::atomic<.+>$", stl_summary_flags, true);
929   AddCXXSummary(
930       cpp_category_sp, lldb_private::formatters::GenericOptionalSummaryProvider,
931       "libc++ std::optional summary provider",
932       "^std::__[[:alnum:]]+::optional<.+>(( )?&)?$", stl_summary_flags, true);
933   AddCXXSummary(
934       cpp_category_sp, lldb_private::formatters::LibcxxVariantSummaryProvider,
935       "libc++ std::variant summary provider",
936       "^std::__[[:alnum:]]+::variant<.+>(( )?&)?$", stl_summary_flags, true);
937   AddCXXSummary(
938       cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider,
939       "libc++ std::span summary provider",
940       "^std::__[[:alnum:]]+::span<.+>(( )?&)?$", stl_summary_flags, true);
941 
942   stl_summary_flags.SetSkipPointers(true);
943 
944   AddCXXSummary(cpp_category_sp,
945                 lldb_private::formatters::LibcxxSmartPointerSummaryProvider,
946                 "libc++ std::shared_ptr summary provider",
947                 "^std::__[[:alnum:]]+::shared_ptr<.+>(( )?&)?$",
948                 stl_summary_flags, true);
949   AddCXXSummary(cpp_category_sp,
950                 lldb_private::formatters::LibcxxSmartPointerSummaryProvider,
951                 "libc++ std::weak_ptr summary provider",
952                 "^std::__[[:alnum:]]+::weak_ptr<.+>(( )?&)?$",
953                 stl_summary_flags, true);
954   AddCXXSummary(cpp_category_sp,
955                 lldb_private::formatters::LibcxxUniquePointerSummaryProvider,
956                 "libc++ std::unique_ptr summary provider",
957                 libcxx_std_unique_ptr_regex, stl_summary_flags, true);
958 
959   AddCXXSummary(cpp_category_sp,
960                 lldb_private::formatters::StdlibCoroutineHandleSummaryProvider,
961                 "libc++ std::coroutine_handle summary provider",
962                 libcxx_std_coroutine_handle_regex, stl_summary_flags, true);
963 
964   AddCXXSynthetic(
965       cpp_category_sp,
966       lldb_private::formatters::LibCxxVectorIteratorSyntheticFrontEndCreator,
967       "std::vector iterator synthetic children",
968       "^std::__[[:alnum:]]+::__wrap_iter<.+>$", stl_synth_flags, true);
969 
970   AddCXXSynthetic(
971       cpp_category_sp,
972       lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEndCreator,
973       "std::map iterator synthetic children",
974       "^std::__[[:alnum:]]+::__map_(const_)?iterator<.+>$", stl_synth_flags,
975       true);
976 
977   AddCXXSynthetic(cpp_category_sp,
978                   lldb_private::formatters::
979                       LibCxxUnorderedMapIteratorSyntheticFrontEndCreator,
980                   "std::unordered_map iterator synthetic children",
981                   "^std::__[[:alnum:]]+::__hash_map_(const_)?iterator<.+>$",
982                   stl_synth_flags, true);
983   // Chrono duration typedefs
984   cpp_category_sp->AddTypeSummary(
985       "^std::__[[:alnum:]]+::chrono::nanoseconds", eFormatterMatchRegex,
986       TypeSummaryImplSP(new StringSummaryFormat(
987           eTypeOptionHideChildren | eTypeOptionHideValue, "${var.__rep_} ns")));
988   cpp_category_sp->AddTypeSummary(
989       "^std::__[[:alnum:]]+::chrono::microseconds", eFormatterMatchRegex,
990       TypeSummaryImplSP(new StringSummaryFormat(
991           eTypeOptionHideChildren | eTypeOptionHideValue, "${var.__rep_} µs")));
992   cpp_category_sp->AddTypeSummary(
993       "^std::__[[:alnum:]]+::chrono::milliseconds", eFormatterMatchRegex,
994       TypeSummaryImplSP(new StringSummaryFormat(
995           eTypeOptionHideChildren | eTypeOptionHideValue, "${var.__rep_} ms")));
996   cpp_category_sp->AddTypeSummary(
997       "^std::__[[:alnum:]]+::chrono::seconds", eFormatterMatchRegex,
998       TypeSummaryImplSP(new StringSummaryFormat(
999           eTypeOptionHideChildren | eTypeOptionHideValue, "${var.__rep_} s")));
1000   cpp_category_sp->AddTypeSummary(
1001       "^std::__[[:alnum:]]+::chrono::minutes", eFormatterMatchRegex,
1002       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
1003                                                     eTypeOptionHideValue,
1004                                                 "${var.__rep_} min")));
1005   cpp_category_sp->AddTypeSummary(
1006       "^std::__[[:alnum:]]+::chrono::hours", eFormatterMatchRegex,
1007       TypeSummaryImplSP(new StringSummaryFormat(
1008           eTypeOptionHideChildren | eTypeOptionHideValue, "${var.__rep_} h")));
1009 
1010   cpp_category_sp->AddTypeSummary(
1011       "^std::__[[:alnum:]]+::chrono::days", eFormatterMatchRegex,
1012       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
1013                                                     eTypeOptionHideValue,
1014                                                 "${var.__rep_} days")));
1015   cpp_category_sp->AddTypeSummary(
1016       "^std::__[[:alnum:]]+::chrono::weeks", eFormatterMatchRegex,
1017       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
1018                                                     eTypeOptionHideValue,
1019                                                 "${var.__rep_} weeks")));
1020   cpp_category_sp->AddTypeSummary(
1021       "^std::__[[:alnum:]]+::chrono::months", eFormatterMatchRegex,
1022       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
1023                                                     eTypeOptionHideValue,
1024                                                 "${var.__rep_} months")));
1025   cpp_category_sp->AddTypeSummary(
1026       "^std::__[[:alnum:]]+::chrono::years", eFormatterMatchRegex,
1027       TypeSummaryImplSP(new StringSummaryFormat(eTypeOptionHideChildren |
1028                                                     eTypeOptionHideValue,
1029                                                 "${var.__rep_} years")));
1030   cpp_category_sp->AddTypeSummary(
1031       "^std::__[[:alnum:]]+::chrono::seconds", eFormatterMatchRegex,
1032       TypeSummaryImplSP(new StringSummaryFormat(
1033           eTypeOptionHideChildren | eTypeOptionHideValue, "${var.__rep_} s")));
1034 }
1035 
1036 static void LoadLibStdcppFormatters(lldb::TypeCategoryImplSP cpp_category_sp) {
1037   if (!cpp_category_sp)
1038     return;
1039 
1040   TypeSummaryImpl::Flags stl_summary_flags;
1041   stl_summary_flags.SetCascades(true)
1042       .SetSkipPointers(false)
1043       .SetSkipReferences(false)
1044       .SetDontShowChildren(true)
1045       .SetDontShowValue(true)
1046       .SetShowMembersOneLiner(false)
1047       .SetHideItemNames(false);
1048 
1049   lldb::TypeSummaryImplSP std_string_summary_sp(
1050       new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p}"));
1051 
1052   lldb::TypeSummaryImplSP cxx11_string_summary_sp(new CXXFunctionSummaryFormat(
1053       stl_summary_flags, LibStdcppStringSummaryProvider,
1054       "libstdc++ c++11 std::string summary provider"));
1055   lldb::TypeSummaryImplSP cxx11_wstring_summary_sp(new CXXFunctionSummaryFormat(
1056       stl_summary_flags, LibStdcppWStringSummaryProvider,
1057       "libstdc++ c++11 std::wstring summary provider"));
1058 
1059   cpp_category_sp->AddTypeSummary("std::string", eFormatterMatchExact,
1060                                   std_string_summary_sp);
1061   cpp_category_sp->AddTypeSummary("std::basic_string<char>",
1062                                   eFormatterMatchExact, std_string_summary_sp);
1063   cpp_category_sp->AddTypeSummary(
1064       "std::basic_string<char,std::char_traits<char>,std::allocator<char> >",
1065       eFormatterMatchExact, std_string_summary_sp);
1066   cpp_category_sp->AddTypeSummary(
1067       "std::basic_string<char, std::char_traits<char>, std::allocator<char> >",
1068       eFormatterMatchExact, std_string_summary_sp);
1069 
1070   cpp_category_sp->AddTypeSummary("std::__cxx11::string", eFormatterMatchExact,
1071                                   cxx11_string_summary_sp);
1072   cpp_category_sp->AddTypeSummary(
1073       "std::__cxx11::basic_string<char, std::char_traits<char>, "
1074       "std::allocator<char> >",
1075       eFormatterMatchExact, cxx11_string_summary_sp);
1076   cpp_category_sp->AddTypeSummary("std::__cxx11::basic_string<unsigned char, "
1077                                   "std::char_traits<unsigned char>, "
1078                                   "std::allocator<unsigned char> >",
1079                                   eFormatterMatchExact,
1080                                   cxx11_string_summary_sp);
1081 
1082   // making sure we force-pick the summary for printing wstring (_M_p is a
1083   // wchar_t*)
1084   lldb::TypeSummaryImplSP std_wstring_summary_sp(
1085       new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p%S}"));
1086 
1087   cpp_category_sp->AddTypeSummary("std::wstring", eFormatterMatchExact,
1088                                   std_wstring_summary_sp);
1089   cpp_category_sp->AddTypeSummary("std::basic_string<wchar_t>",
1090                                   eFormatterMatchExact, std_wstring_summary_sp);
1091   cpp_category_sp->AddTypeSummary("std::basic_string<wchar_t,std::char_traits<"
1092                                   "wchar_t>,std::allocator<wchar_t> >",
1093                                   eFormatterMatchExact, std_wstring_summary_sp);
1094   cpp_category_sp->AddTypeSummary(
1095       "std::basic_string<wchar_t, std::char_traits<wchar_t>, "
1096       "std::allocator<wchar_t> >",
1097       eFormatterMatchExact, std_wstring_summary_sp);
1098 
1099   cpp_category_sp->AddTypeSummary("std::__cxx11::wstring", eFormatterMatchExact,
1100                                   cxx11_wstring_summary_sp);
1101   cpp_category_sp->AddTypeSummary(
1102       "std::__cxx11::basic_string<wchar_t, std::char_traits<wchar_t>, "
1103       "std::allocator<wchar_t> >",
1104       eFormatterMatchExact, cxx11_wstring_summary_sp);
1105 
1106   SyntheticChildren::Flags stl_synth_flags;
1107   stl_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences(
1108       false);
1109   SyntheticChildren::Flags stl_deref_flags = stl_synth_flags;
1110   stl_deref_flags.SetFrontEndWantsDereference();
1111 
1112   cpp_category_sp->AddTypeSynthetic(
1113       "^std::vector<.+>(( )?&)?$", eFormatterMatchRegex,
1114       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1115           stl_synth_flags,
1116           "lldb.formatters.cpp.gnu_libstdcpp.StdVectorSynthProvider")));
1117   cpp_category_sp->AddTypeSynthetic(
1118       "^std::map<.+> >(( )?&)?$", eFormatterMatchRegex,
1119       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1120           stl_synth_flags,
1121           "lldb.formatters.cpp.gnu_libstdcpp.StdMapLikeSynthProvider")));
1122   cpp_category_sp->AddTypeSynthetic(
1123       "^std::deque<.+>(( )?&)?$", eFormatterMatchRegex,
1124       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1125           stl_deref_flags,
1126           "lldb.formatters.cpp.gnu_libstdcpp.StdDequeSynthProvider")));
1127   cpp_category_sp->AddTypeSynthetic(
1128       "^std::set<.+> >(( )?&)?$", eFormatterMatchRegex,
1129       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1130           stl_deref_flags,
1131           "lldb.formatters.cpp.gnu_libstdcpp.StdMapLikeSynthProvider")));
1132   cpp_category_sp->AddTypeSynthetic(
1133       "^std::multimap<.+> >(( )?&)?$", eFormatterMatchRegex,
1134       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1135           stl_deref_flags,
1136           "lldb.formatters.cpp.gnu_libstdcpp.StdMapLikeSynthProvider")));
1137   cpp_category_sp->AddTypeSynthetic(
1138       "^std::multiset<.+> >(( )?&)?$", eFormatterMatchRegex,
1139       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1140           stl_deref_flags,
1141           "lldb.formatters.cpp.gnu_libstdcpp.StdMapLikeSynthProvider")));
1142   cpp_category_sp->AddTypeSynthetic(
1143       "^std::unordered_(multi)?(map|set)<.+> >$", eFormatterMatchRegex,
1144       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1145           stl_deref_flags,
1146           "lldb.formatters.cpp.gnu_libstdcpp.StdUnorderedMapSynthProvider")));
1147   cpp_category_sp->AddTypeSynthetic(
1148       "^std::(__cxx11::)?list<.+>(( )?&)?$", eFormatterMatchRegex,
1149       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1150           stl_deref_flags,
1151           "lldb.formatters.cpp.gnu_libstdcpp.StdListSynthProvider")));
1152   cpp_category_sp->AddTypeSynthetic(
1153       "^std::(__cxx11::)?forward_list<.+>(( )?&)?$", eFormatterMatchRegex,
1154       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1155           stl_synth_flags,
1156           "lldb.formatters.cpp.gnu_libstdcpp.StdForwardListSynthProvider")));
1157   cpp_category_sp->AddTypeSynthetic(
1158       "^std::variant<.+>$", eFormatterMatchRegex,
1159       SyntheticChildrenSP(new ScriptedSyntheticChildren(
1160           stl_synth_flags,
1161           "lldb.formatters.cpp.gnu_libstdcpp.VariantSynthProvider")));
1162 
1163   stl_summary_flags.SetDontShowChildren(false);
1164   stl_summary_flags.SetSkipPointers(false);
1165   cpp_category_sp->AddTypeSummary("^std::bitset<.+>(( )?&)?$",
1166                                   eFormatterMatchRegex,
1167                                   TypeSummaryImplSP(new StringSummaryFormat(
1168                                       stl_summary_flags, "size=${svar%#}")));
1169   cpp_category_sp->AddTypeSummary("^std::vector<.+>(( )?&)?$",
1170                                   eFormatterMatchRegex,
1171                                   TypeSummaryImplSP(new StringSummaryFormat(
1172                                       stl_summary_flags, "size=${svar%#}")));
1173   cpp_category_sp->AddTypeSummary("^std::map<.+> >(( )?&)?$",
1174                                   eFormatterMatchRegex,
1175                                   TypeSummaryImplSP(new StringSummaryFormat(
1176                                       stl_summary_flags, "size=${svar%#}")));
1177   cpp_category_sp->AddTypeSummary("^std::set<.+> >(( )?&)?$",
1178                                   eFormatterMatchRegex,
1179                                   TypeSummaryImplSP(new StringSummaryFormat(
1180                                       stl_summary_flags, "size=${svar%#}")));
1181   cpp_category_sp->AddTypeSummary("^std::deque<.+>(( )?&)?$",
1182                                   eFormatterMatchRegex,
1183                                   TypeSummaryImplSP(new StringSummaryFormat(
1184                                       stl_summary_flags, "size=${svar%#}")));
1185   cpp_category_sp->AddTypeSummary("^std::multimap<.+> >(( )?&)?$",
1186                                   eFormatterMatchRegex,
1187                                   TypeSummaryImplSP(new StringSummaryFormat(
1188                                       stl_summary_flags, "size=${svar%#}")));
1189   cpp_category_sp->AddTypeSummary("^std::multiset<.+> >(( )?&)?$",
1190                                   eFormatterMatchRegex,
1191                                   TypeSummaryImplSP(new StringSummaryFormat(
1192                                       stl_summary_flags, "size=${svar%#}")));
1193   cpp_category_sp->AddTypeSummary("^std::unordered_(multi)?(map|set)<.+> >$",
1194                                   eFormatterMatchRegex,
1195                                   TypeSummaryImplSP(new StringSummaryFormat(
1196                                       stl_summary_flags, "size=${svar%#}")));
1197   cpp_category_sp->AddTypeSummary("^std::(__cxx11::)?list<.+>(( )?&)?$",
1198                                   eFormatterMatchRegex,
1199                                   TypeSummaryImplSP(new StringSummaryFormat(
1200                                       stl_summary_flags, "size=${svar%#}")));
1201   cpp_category_sp->AddTypeSummary(
1202       "^std::(__cxx11::)?forward_list<.+>(( )?&)?$", eFormatterMatchRegex,
1203       TypeSummaryImplSP(new ScriptSummaryFormat(
1204           stl_summary_flags,
1205           "lldb.formatters.cpp.gnu_libstdcpp.ForwardListSummaryProvider")));
1206   cpp_category_sp->AddTypeSummary(
1207       "^std::variant<.+>$", eFormatterMatchRegex,
1208       TypeSummaryImplSP(new ScriptSummaryFormat(
1209           stl_summary_flags,
1210           "lldb.formatters.cpp.gnu_libstdcpp.VariantSummaryProvider")));
1211 
1212   AddCXXSynthetic(
1213       cpp_category_sp,
1214       lldb_private::formatters::LibStdcppVectorIteratorSyntheticFrontEndCreator,
1215       "std::vector iterator synthetic children",
1216       "^__gnu_cxx::__normal_iterator<.+>$", stl_synth_flags, true);
1217 
1218   AddCXXSynthetic(
1219       cpp_category_sp,
1220       lldb_private::formatters::LibstdcppMapIteratorSyntheticFrontEndCreator,
1221       "std::map iterator synthetic children", "^std::_Rb_tree_iterator<.+>$",
1222       stl_synth_flags, true);
1223 
1224   AddCXXSynthetic(
1225       cpp_category_sp,
1226       lldb_private::formatters::LibStdcppUniquePtrSyntheticFrontEndCreator,
1227       "std::unique_ptr synthetic children", "^std::unique_ptr<.+>(( )?&)?$",
1228       stl_synth_flags, true);
1229   AddCXXSynthetic(
1230       cpp_category_sp,
1231       lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator,
1232       "std::shared_ptr synthetic children", "^std::shared_ptr<.+>(( )?&)?$",
1233       stl_synth_flags, true);
1234   AddCXXSynthetic(
1235       cpp_category_sp,
1236       lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator,
1237       "std::weak_ptr synthetic children", "^std::weak_ptr<.+>(( )?&)?$",
1238       stl_synth_flags, true);
1239   AddCXXSynthetic(
1240       cpp_category_sp,
1241       lldb_private::formatters::LibStdcppTupleSyntheticFrontEndCreator,
1242       "std::tuple synthetic children", "^std::tuple<.+>(( )?&)?$",
1243       stl_synth_flags, true);
1244 
1245   static constexpr const char *const libstdcpp_std_coroutine_handle_regex =
1246       "^std::coroutine_handle<.+>(( )?&)?$";
1247   AddCXXSynthetic(
1248       cpp_category_sp,
1249       lldb_private::formatters::StdlibCoroutineHandleSyntheticFrontEndCreator,
1250       "std::coroutine_handle synthetic children",
1251       libstdcpp_std_coroutine_handle_regex, stl_deref_flags, true);
1252 
1253   AddCXXSynthetic(
1254       cpp_category_sp,
1255       lldb_private::formatters::LibStdcppBitsetSyntheticFrontEndCreator,
1256       "std::bitset synthetic child", "^std::bitset<.+>(( )?&)?$",
1257       stl_deref_flags, true);
1258 
1259   AddCXXSynthetic(
1260       cpp_category_sp,
1261       lldb_private::formatters::LibStdcppOptionalSyntheticFrontEndCreator,
1262       "std::optional synthetic child", "^std::optional<.+>(( )?&)?$",
1263       stl_deref_flags, true);
1264 
1265   AddCXXSummary(cpp_category_sp,
1266                 lldb_private::formatters::LibStdcppUniquePointerSummaryProvider,
1267                 "libstdc++ std::unique_ptr summary provider",
1268                 "^std::unique_ptr<.+>(( )?&)?$", stl_summary_flags, true);
1269   AddCXXSummary(cpp_category_sp,
1270                 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider,
1271                 "libstdc++ std::shared_ptr summary provider",
1272                 "^std::shared_ptr<.+>(( )?&)?$", stl_summary_flags, true);
1273   AddCXXSummary(cpp_category_sp,
1274                 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider,
1275                 "libstdc++ std::weak_ptr summary provider",
1276                 "^std::weak_ptr<.+>(( )?&)?$", stl_summary_flags, true);
1277   AddCXXSummary(cpp_category_sp,
1278                 lldb_private::formatters::StdlibCoroutineHandleSummaryProvider,
1279                 "libstdc++ std::coroutine_handle summary provider",
1280                 libstdcpp_std_coroutine_handle_regex, stl_summary_flags, true);
1281   AddCXXSummary(cpp_category_sp,
1282                 lldb_private::formatters::GenericOptionalSummaryProvider,
1283                 "libstd++ std::optional summary provider",
1284                 "^std::optional<.+>(( )?&)?$", stl_summary_flags, true);
1285 }
1286 
1287 static void LoadSystemFormatters(lldb::TypeCategoryImplSP cpp_category_sp) {
1288   if (!cpp_category_sp)
1289     return;
1290 
1291   TypeSummaryImpl::Flags string_flags;
1292   string_flags.SetCascades(true)
1293       .SetSkipPointers(true)
1294       .SetSkipReferences(false)
1295       .SetDontShowChildren(true)
1296       .SetDontShowValue(false)
1297       .SetShowMembersOneLiner(false)
1298       .SetHideItemNames(false);
1299 
1300   TypeSummaryImpl::Flags string_array_flags;
1301   string_array_flags.SetCascades(true)
1302       .SetSkipPointers(true)
1303       .SetSkipReferences(false)
1304       .SetDontShowChildren(true)
1305       .SetDontShowValue(true)
1306       .SetShowMembersOneLiner(false)
1307       .SetHideItemNames(false);
1308 
1309   AddCXXSummary(cpp_category_sp,
1310                 lldb_private::formatters::Char8StringSummaryProvider,
1311                 "char8_t * summary provider", "char8_t *", string_flags);
1312   AddCXXSummary(cpp_category_sp,
1313                 lldb_private::formatters::Char8StringSummaryProvider,
1314                 "char8_t [] summary provider", "char8_t ?\\[[0-9]+\\]",
1315                 string_array_flags, true);
1316 
1317   AddCXXSummary(cpp_category_sp,
1318                 lldb_private::formatters::Char16StringSummaryProvider,
1319                 "char16_t * summary provider", "char16_t *", string_flags);
1320   AddCXXSummary(cpp_category_sp,
1321                 lldb_private::formatters::Char16StringSummaryProvider,
1322                 "char16_t [] summary provider", "char16_t ?\\[[0-9]+\\]",
1323                 string_array_flags, true);
1324 
1325   AddCXXSummary(cpp_category_sp,
1326                 lldb_private::formatters::Char32StringSummaryProvider,
1327                 "char32_t * summary provider", "char32_t *", string_flags);
1328   AddCXXSummary(cpp_category_sp,
1329                 lldb_private::formatters::Char32StringSummaryProvider,
1330                 "char32_t [] summary provider", "char32_t ?\\[[0-9]+\\]",
1331                 string_array_flags, true);
1332 
1333   AddCXXSummary(cpp_category_sp,
1334                 lldb_private::formatters::WCharStringSummaryProvider,
1335                 "wchar_t * summary provider", "wchar_t *", string_flags);
1336   AddCXXSummary(cpp_category_sp,
1337                 lldb_private::formatters::WCharStringSummaryProvider,
1338                 "wchar_t * summary provider", "wchar_t ?\\[[0-9]+\\]",
1339                 string_array_flags, true);
1340 
1341   AddCXXSummary(cpp_category_sp,
1342                 lldb_private::formatters::Char16StringSummaryProvider,
1343                 "unichar * summary provider", "unichar *", string_flags);
1344 
1345   TypeSummaryImpl::Flags widechar_flags;
1346   widechar_flags.SetDontShowValue(true)
1347       .SetSkipPointers(true)
1348       .SetSkipReferences(false)
1349       .SetCascades(true)
1350       .SetDontShowChildren(true)
1351       .SetHideItemNames(true)
1352       .SetShowMembersOneLiner(false);
1353 
1354   AddCXXSummary(cpp_category_sp, lldb_private::formatters::Char8SummaryProvider,
1355                 "char8_t summary provider", "char8_t", widechar_flags);
1356   AddCXXSummary(cpp_category_sp,
1357                 lldb_private::formatters::Char16SummaryProvider,
1358                 "char16_t summary provider", "char16_t", widechar_flags);
1359   AddCXXSummary(cpp_category_sp,
1360                 lldb_private::formatters::Char32SummaryProvider,
1361                 "char32_t summary provider", "char32_t", widechar_flags);
1362   AddCXXSummary(cpp_category_sp, lldb_private::formatters::WCharSummaryProvider,
1363                 "wchar_t summary provider", "wchar_t", widechar_flags);
1364 
1365   AddCXXSummary(cpp_category_sp,
1366                 lldb_private::formatters::Char16SummaryProvider,
1367                 "unichar summary provider", "unichar", widechar_flags);
1368 }
1369 
1370 std::unique_ptr<Language::TypeScavenger> CPlusPlusLanguage::GetTypeScavenger() {
1371   class CPlusPlusTypeScavenger : public Language::ImageListTypeScavenger {
1372   public:
1373     CompilerType AdjustForInclusion(CompilerType &candidate) override {
1374       LanguageType lang_type(candidate.GetMinimumLanguage());
1375       if (!Language::LanguageIsC(lang_type) &&
1376           !Language::LanguageIsCPlusPlus(lang_type))
1377         return CompilerType();
1378       if (candidate.IsTypedefType())
1379         return candidate.GetTypedefedType();
1380       return candidate;
1381     }
1382   };
1383 
1384   return std::unique_ptr<TypeScavenger>(new CPlusPlusTypeScavenger());
1385 }
1386 
1387 lldb::TypeCategoryImplSP CPlusPlusLanguage::GetFormatters() {
1388   static llvm::once_flag g_initialize;
1389   static TypeCategoryImplSP g_category;
1390 
1391   llvm::call_once(g_initialize, [this]() -> void {
1392     DataVisualization::Categories::GetCategory(ConstString(GetPluginName()),
1393                                                g_category);
1394     if (g_category) {
1395       LoadLibStdcppFormatters(g_category);
1396       LoadLibCxxFormatters(g_category);
1397       LoadSystemFormatters(g_category);
1398     }
1399   });
1400   return g_category;
1401 }
1402 
1403 HardcodedFormatters::HardcodedSummaryFinder
1404 CPlusPlusLanguage::GetHardcodedSummaries() {
1405   static llvm::once_flag g_initialize;
1406   static ConstString g_vectortypes("VectorTypes");
1407   static HardcodedFormatters::HardcodedSummaryFinder g_formatters;
1408 
1409   llvm::call_once(g_initialize, []() -> void {
1410     g_formatters.push_back(
1411         [](lldb_private::ValueObject &valobj, lldb::DynamicValueType,
1412            FormatManager &) -> TypeSummaryImpl::SharedPointer {
1413           static CXXFunctionSummaryFormat::SharedPointer formatter_sp(
1414               new CXXFunctionSummaryFormat(
1415                   TypeSummaryImpl::Flags(),
1416                   lldb_private::formatters::CXXFunctionPointerSummaryProvider,
1417                   "Function pointer summary provider"));
1418           if (CompilerType CT = valobj.GetCompilerType();
1419               CT.IsFunctionPointerType() || CT.IsMemberFunctionPointerType() ||
1420               valobj.GetValueType() == lldb::eValueTypeVTableEntry) {
1421             return formatter_sp;
1422           }
1423           return nullptr;
1424         });
1425     g_formatters.push_back(
1426         [](lldb_private::ValueObject &valobj, lldb::DynamicValueType,
1427            FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer {
1428           static CXXFunctionSummaryFormat::SharedPointer formatter_sp(
1429               new CXXFunctionSummaryFormat(
1430                   TypeSummaryImpl::Flags()
1431                       .SetCascades(true)
1432                       .SetDontShowChildren(true)
1433                       .SetHideItemNames(true)
1434                       .SetShowMembersOneLiner(true)
1435                       .SetSkipPointers(true)
1436                       .SetSkipReferences(false),
1437                   lldb_private::formatters::VectorTypeSummaryProvider,
1438                   "vector_type pointer summary provider"));
1439           if (valobj.GetCompilerType().IsVectorType()) {
1440             if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled())
1441               return formatter_sp;
1442           }
1443           return nullptr;
1444         });
1445     g_formatters.push_back(
1446         [](lldb_private::ValueObject &valobj, lldb::DynamicValueType,
1447            FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer {
1448           static CXXFunctionSummaryFormat::SharedPointer formatter_sp(
1449               new CXXFunctionSummaryFormat(
1450                   TypeSummaryImpl::Flags()
1451                       .SetCascades(true)
1452                       .SetDontShowChildren(true)
1453                       .SetHideItemNames(true)
1454                       .SetShowMembersOneLiner(true)
1455                       .SetSkipPointers(true)
1456                       .SetSkipReferences(false),
1457                   lldb_private::formatters::BlockPointerSummaryProvider,
1458                   "block pointer summary provider"));
1459           if (valobj.GetCompilerType().IsBlockPointerType()) {
1460             return formatter_sp;
1461           }
1462           return nullptr;
1463         });
1464   });
1465 
1466   return g_formatters;
1467 }
1468 
1469 HardcodedFormatters::HardcodedSyntheticFinder
1470 CPlusPlusLanguage::GetHardcodedSynthetics() {
1471   static llvm::once_flag g_initialize;
1472   static ConstString g_vectortypes("VectorTypes");
1473   static HardcodedFormatters::HardcodedSyntheticFinder g_formatters;
1474 
1475   llvm::call_once(g_initialize, []() -> void {
1476     g_formatters.push_back([](lldb_private::ValueObject &valobj,
1477                               lldb::DynamicValueType, FormatManager &fmt_mgr)
1478                                -> SyntheticChildren::SharedPointer {
1479       static CXXSyntheticChildren::SharedPointer formatter_sp(
1480           new CXXSyntheticChildren(
1481               SyntheticChildren::Flags()
1482                   .SetCascades(true)
1483                   .SetSkipPointers(true)
1484                   .SetSkipReferences(true)
1485                   .SetNonCacheable(true),
1486               "vector_type synthetic children",
1487               lldb_private::formatters::VectorTypeSyntheticFrontEndCreator));
1488       if (valobj.GetCompilerType().IsVectorType()) {
1489         if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled())
1490           return formatter_sp;
1491       }
1492       return nullptr;
1493     });
1494     g_formatters.push_back([](lldb_private::ValueObject &valobj,
1495                               lldb::DynamicValueType, FormatManager &fmt_mgr)
1496                                -> SyntheticChildren::SharedPointer {
1497       static CXXSyntheticChildren::SharedPointer formatter_sp(
1498           new CXXSyntheticChildren(
1499               SyntheticChildren::Flags()
1500                   .SetCascades(true)
1501                   .SetSkipPointers(true)
1502                   .SetSkipReferences(true)
1503                   .SetNonCacheable(true),
1504               "block pointer synthetic children",
1505               lldb_private::formatters::BlockPointerSyntheticFrontEndCreator));
1506       if (valobj.GetCompilerType().IsBlockPointerType()) {
1507         return formatter_sp;
1508       }
1509       return nullptr;
1510     });
1511   });
1512 
1513   return g_formatters;
1514 }
1515 
1516 bool CPlusPlusLanguage::IsNilReference(ValueObject &valobj) {
1517   if (!Language::LanguageIsCPlusPlus(valobj.GetObjectRuntimeLanguage()) ||
1518       !valobj.IsPointerType())
1519     return false;
1520   bool canReadValue = true;
1521   bool isZero = valobj.GetValueAsUnsigned(0, &canReadValue) == 0;
1522   return canReadValue && isZero;
1523 }
1524 
1525 bool CPlusPlusLanguage::IsSourceFile(llvm::StringRef file_path) const {
1526   const auto suffixes = {".cpp", ".cxx", ".c++", ".cc",  ".c",
1527                          ".h",   ".hh",  ".hpp", ".hxx", ".h++"};
1528   for (auto suffix : suffixes) {
1529     if (file_path.ends_with_insensitive(suffix))
1530       return true;
1531   }
1532 
1533   // Check if we're in a STL path (where the files usually have no extension
1534   // that we could check for.
1535   return file_path.contains("/usr/include/c++/");
1536 }
1537 
1538 bool CPlusPlusLanguage::GetFunctionDisplayName(
1539     const SymbolContext *sc, const ExecutionContext *exe_ctx,
1540     FunctionNameRepresentation representation, Stream &s) {
1541   switch (representation) {
1542   case FunctionNameRepresentation::eNameWithArgs: {
1543     // Print the function name with arguments in it
1544     if (sc->function) {
1545       ExecutionContextScope *exe_scope =
1546           exe_ctx ? exe_ctx->GetBestExecutionContextScope() : nullptr;
1547       const char *cstr = sc->function->GetName().AsCString(nullptr);
1548       if (cstr) {
1549         const InlineFunctionInfo *inline_info = nullptr;
1550         VariableListSP variable_list_sp;
1551         bool get_function_vars = true;
1552         if (sc->block) {
1553           Block *inline_block = sc->block->GetContainingInlinedBlock();
1554 
1555           if (inline_block) {
1556             get_function_vars = false;
1557             inline_info = sc->block->GetInlinedFunctionInfo();
1558             if (inline_info)
1559               variable_list_sp = inline_block->GetBlockVariableList(true);
1560           }
1561         }
1562 
1563         if (get_function_vars) {
1564           variable_list_sp =
1565               sc->function->GetBlock(true).GetBlockVariableList(true);
1566         }
1567 
1568         if (inline_info) {
1569           s.PutCString(cstr);
1570           s.PutCString(" [inlined] ");
1571           cstr = inline_info->GetName().GetCString();
1572         }
1573 
1574         VariableList args;
1575         if (variable_list_sp)
1576           variable_list_sp->AppendVariablesWithScope(eValueTypeVariableArgument,
1577                                                      args);
1578         if (args.GetSize() > 0) {
1579           if (!PrettyPrintFunctionNameWithArgs(s, cstr, exe_scope, args))
1580             return false;
1581         } else {
1582           s.PutCString(cstr);
1583         }
1584         return true;
1585       }
1586     } else if (sc->symbol) {
1587       const char *cstr = sc->symbol->GetName().AsCString(nullptr);
1588       if (cstr) {
1589         s.PutCString(cstr);
1590         return true;
1591       }
1592     }
1593   } break;
1594   default:
1595     return false;
1596   }
1597 
1598   return false;
1599 }
1600