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