1 //===-- CPlusPlusLanguage.cpp -----------------------------------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "CPlusPlusLanguage.h"
22 // Other libraries and framework includes
23 #include "llvm/ADT/StringRef.h"
26 #include "lldb/Core/PluginManager.h"
27 #include "lldb/Core/UniqueCStringMap.h"
28 #include "lldb/DataFormatters/CXXFunctionPointer.h"
29 #include "lldb/DataFormatters/DataVisualization.h"
30 #include "lldb/DataFormatters/FormattersHelpers.h"
31 #include "lldb/DataFormatters/VectorType.h"
32 #include "lldb/Utility/ConstString.h"
33 #include "lldb/Utility/FastDemangle.h"
34 #include "lldb/Utility/Log.h"
35 #include "lldb/Utility/RegularExpression.h"
37 #include "BlockPointer.h"
38 #include "CPlusPlusNameParser.h"
39 #include "CxxStringTypes.h"
41 #include "LibCxxAtomic.h"
42 #include "LibStdcpp.h"
45 using namespace lldb_private;
46 using namespace lldb_private::formatters;
48 void CPlusPlusLanguage::Initialize() {
49 PluginManager::RegisterPlugin(GetPluginNameStatic(), "C++ Language",
53 void CPlusPlusLanguage::Terminate() {
54 PluginManager::UnregisterPlugin(CreateInstance);
57 lldb_private::ConstString CPlusPlusLanguage::GetPluginNameStatic() {
58 static ConstString g_name("cplusplus");
62 //------------------------------------------------------------------
63 // PluginInterface protocol
64 //------------------------------------------------------------------
66 lldb_private::ConstString CPlusPlusLanguage::GetPluginName() {
67 return GetPluginNameStatic();
70 uint32_t CPlusPlusLanguage::GetPluginVersion() { return 1; }
72 //------------------------------------------------------------------
74 //------------------------------------------------------------------
76 Language *CPlusPlusLanguage::CreateInstance(lldb::LanguageType language) {
77 if (Language::LanguageIsCPlusPlus(language))
78 return new CPlusPlusLanguage();
82 void CPlusPlusLanguage::MethodName::Clear() {
84 m_basename = llvm::StringRef();
85 m_context = llvm::StringRef();
86 m_arguments = llvm::StringRef();
87 m_qualifiers = llvm::StringRef();
89 m_parse_error = false;
92 static bool ReverseFindMatchingChars(const llvm::StringRef &s,
93 const llvm::StringRef &left_right_chars,
94 size_t &left_pos, size_t &right_pos,
95 size_t pos = llvm::StringRef::npos) {
96 assert(left_right_chars.size() == 2);
97 left_pos = llvm::StringRef::npos;
98 const char left_char = left_right_chars[0];
99 const char right_char = left_right_chars[1];
100 pos = s.find_last_of(left_right_chars, pos);
101 if (pos == llvm::StringRef::npos || s[pos] == left_char)
105 while (pos > 0 && depth > 0) {
106 pos = s.find_last_of(left_right_chars, pos);
107 if (pos == llvm::StringRef::npos)
109 if (s[pos] == left_char) {
112 return left_pos < right_pos;
114 } else if (s[pos] == right_char) {
121 static bool IsTrivialBasename(const llvm::StringRef &basename) {
122 // Check that the basename matches with the following regular expression
123 // "^~?([A-Za-z_][A-Za-z_0-9]*)$"
124 // We are using a hand written implementation because it is significantly more
126 // using the general purpose regular expression library.
128 if (basename.size() > 0 && basename[0] == '~')
131 if (basename.size() <= idx)
132 return false; // Empty string or "~"
134 if (!std::isalpha(basename[idx]) && basename[idx] != '_')
135 return false; // First charater (after removing the possible '~'') isn't in
138 // Read all characters matching [A-Za-z_0-9]
140 while (idx < basename.size()) {
141 if (!std::isalnum(basename[idx]) && basename[idx] != '_')
146 // We processed all characters. It is a vaild basename.
147 if (idx == basename.size())
153 bool CPlusPlusLanguage::MethodName::TrySimplifiedParse() {
154 // This method tries to parse simple method definitions
155 // which are presumably most comman in user programs.
156 // Definitions that can be parsed by this function don't have return types
157 // and templates in the name.
158 // A::B::C::fun(std::vector<T> &) const
159 size_t arg_start, arg_end;
160 llvm::StringRef full(m_full.GetCString());
161 llvm::StringRef parens("()", 2);
162 if (ReverseFindMatchingChars(full, parens, arg_start, arg_end)) {
163 m_arguments = full.substr(arg_start, arg_end - arg_start + 1);
164 if (arg_end + 1 < full.size())
165 m_qualifiers = full.substr(arg_end + 1).ltrim();
169 size_t basename_end = arg_start;
170 size_t context_start = 0;
171 size_t context_end = full.rfind(':', basename_end);
172 if (context_end == llvm::StringRef::npos)
173 m_basename = full.substr(0, basename_end);
175 if (context_start < context_end)
176 m_context = full.substr(context_start, context_end - 1 - context_start);
177 const size_t basename_begin = context_end + 1;
178 m_basename = full.substr(basename_begin, basename_end - basename_begin);
181 if (IsTrivialBasename(m_basename)) {
184 // The C++ basename doesn't match our regular expressions so this can't
185 // be a valid C++ method, clear everything out and indicate an error
186 m_context = llvm::StringRef();
187 m_basename = llvm::StringRef();
188 m_arguments = llvm::StringRef();
189 m_qualifiers = llvm::StringRef();
196 void CPlusPlusLanguage::MethodName::Parse() {
197 if (!m_parsed && m_full) {
198 if (TrySimplifiedParse()) {
199 m_parse_error = false;
201 CPlusPlusNameParser parser(m_full.GetStringRef());
202 if (auto function = parser.ParseAsFunctionDefinition()) {
203 m_basename = function.getValue().name.basename;
204 m_context = function.getValue().name.context;
205 m_arguments = function.getValue().arguments;
206 m_qualifiers = function.getValue().qualifiers;
207 m_parse_error = false;
209 m_parse_error = true;
216 llvm::StringRef CPlusPlusLanguage::MethodName::GetBasename() {
222 llvm::StringRef CPlusPlusLanguage::MethodName::GetContext() {
228 llvm::StringRef CPlusPlusLanguage::MethodName::GetArguments() {
234 llvm::StringRef CPlusPlusLanguage::MethodName::GetQualifiers() {
240 std::string CPlusPlusLanguage::MethodName::GetScopeQualifiedName() {
243 if (m_context.empty())
253 bool CPlusPlusLanguage::IsCPPMangledName(const char *name) {
254 // FIXME, we should really run through all the known C++ Language plugins and
256 // this is a C++ mangled name, but we can put that off till there is actually
260 return (name != nullptr && name[0] == '_' && name[1] == 'Z');
263 bool CPlusPlusLanguage::ExtractContextAndIdentifier(
264 const char *name, llvm::StringRef &context, llvm::StringRef &identifier) {
265 CPlusPlusNameParser parser(name);
266 if (auto full_name = parser.ParseAsFullName()) {
267 identifier = full_name.getValue().basename;
268 context = full_name.getValue().context;
274 /// Given a mangled function `mangled`, replace all the primitive function type
275 /// arguments of `search` with type `replace`.
276 static ConstString SubsPrimitiveParmItanium(llvm::StringRef mangled,
277 llvm::StringRef search,
278 llvm::StringRef replace) {
279 Log *log = GetLogIfAllCategoriesSet(LIBLLDB_LOG_LANGUAGE);
281 const size_t max_len =
282 mangled.size() + mangled.count(search) * replace.size() + 1;
284 // Make a temporary buffer to fix up the mangled parameter types and copy the
286 std::string output_buf;
287 output_buf.reserve(max_len);
288 output_buf.insert(0, mangled.str());
289 ptrdiff_t replaced_offset = 0;
291 auto swap_parms_hook = [&](const char *parsee) {
292 if (!parsee || !*parsee)
295 // Check whether we've found a substitutee
296 llvm::StringRef s(parsee);
297 if (s.startswith(search)) {
298 // account for the case where a replacement is of a different length to
300 replaced_offset += replace.size() - search.size();
302 ptrdiff_t replace_idx = (mangled.size() - s.size()) + replaced_offset;
303 output_buf.erase(replace_idx, search.size());
304 output_buf.insert(replace_idx, replace.str());
308 // FastDemangle will call our hook for each instance of a primitive type,
309 // allowing us to perform substitution
310 const char *const demangled =
311 FastDemangle(mangled.str().c_str(), mangled.size(), swap_parms_hook);
314 log->Printf("substituted mangling for %s:{%s} %s:{%s}\n",
315 mangled.str().c_str(), demangled, output_buf.c_str(),
316 FastDemangle(output_buf.c_str()));
318 return output_buf == mangled ? ConstString() : ConstString(output_buf);
321 uint32_t CPlusPlusLanguage::FindAlternateFunctionManglings(
322 const ConstString mangled_name, std::set<ConstString> &alternates) {
323 const auto start_size = alternates.size();
324 /// Get a basic set of alternative manglings for the given symbol `name`, by
325 /// making a few basic possible substitutions on basic types, storage duration
326 /// and `const`ness for the given symbol. The output parameter `alternates`
327 /// is filled with a best-guess, non-exhaustive set of different manglings
328 /// for the given name.
330 // Maybe we're looking for a const symbol but the debug info told us it was
332 if (!strncmp(mangled_name.GetCString(), "_ZN", 3) &&
333 strncmp(mangled_name.GetCString(), "_ZNK", 4)) {
334 std::string fixed_scratch("_ZNK");
335 fixed_scratch.append(mangled_name.GetCString() + 3);
336 alternates.insert(ConstString(fixed_scratch));
339 // Maybe we're looking for a static symbol but we thought it was global...
340 if (!strncmp(mangled_name.GetCString(), "_Z", 2) &&
341 strncmp(mangled_name.GetCString(), "_ZL", 3)) {
342 std::string fixed_scratch("_ZL");
343 fixed_scratch.append(mangled_name.GetCString() + 2);
344 alternates.insert(ConstString(fixed_scratch));
347 // `char` is implementation defined as either `signed` or `unsigned`. As a
348 // result a char parameter has 3 possible manglings: 'c'-char, 'a'-signed
349 // char, 'h'-unsigned char. If we're looking for symbols with a signed char
350 // parameter, try finding matches which have the general case 'c'.
351 if (ConstString char_fixup =
352 SubsPrimitiveParmItanium(mangled_name.GetStringRef(), "a", "c"))
353 alternates.insert(char_fixup);
355 // long long parameter mangling 'x', may actually just be a long 'l' argument
356 if (ConstString long_fixup =
357 SubsPrimitiveParmItanium(mangled_name.GetStringRef(), "x", "l"))
358 alternates.insert(long_fixup);
360 // unsigned long long parameter mangling 'y', may actually just be unsigned
362 if (ConstString ulong_fixup =
363 SubsPrimitiveParmItanium(mangled_name.GetStringRef(), "y", "m"))
364 alternates.insert(ulong_fixup);
366 return alternates.size() - start_size;
369 static void LoadLibCxxFormatters(lldb::TypeCategoryImplSP cpp_category_sp) {
370 if (!cpp_category_sp)
373 TypeSummaryImpl::Flags stl_summary_flags;
374 stl_summary_flags.SetCascades(true)
375 .SetSkipPointers(false)
376 .SetSkipReferences(false)
377 .SetDontShowChildren(true)
378 .SetDontShowValue(true)
379 .SetShowMembersOneLiner(false)
380 .SetHideItemNames(false);
382 #ifndef LLDB_DISABLE_PYTHON
383 lldb::TypeSummaryImplSP std_string_summary_sp(new CXXFunctionSummaryFormat(
384 stl_summary_flags, lldb_private::formatters::LibcxxStringSummaryProvider,
385 "std::string summary provider"));
386 lldb::TypeSummaryImplSP std_wstring_summary_sp(new CXXFunctionSummaryFormat(
387 stl_summary_flags, lldb_private::formatters::LibcxxWStringSummaryProvider,
388 "std::wstring summary provider"));
390 cpp_category_sp->GetTypeSummariesContainer()->Add(
391 ConstString("std::__1::string"), std_string_summary_sp);
392 cpp_category_sp->GetTypeSummariesContainer()->Add(
393 ConstString("std::__ndk1::string"), std_string_summary_sp);
394 cpp_category_sp->GetTypeSummariesContainer()->Add(
395 ConstString("std::__1::basic_string<char, std::__1::char_traits<char>, "
396 "std::__1::allocator<char> >"),
397 std_string_summary_sp);
398 cpp_category_sp->GetTypeSummariesContainer()->Add(
399 ConstString("std::__ndk1::basic_string<char, "
400 "std::__ndk1::char_traits<char>, "
401 "std::__ndk1::allocator<char> >"),
402 std_string_summary_sp);
404 cpp_category_sp->GetTypeSummariesContainer()->Add(
405 ConstString("std::__1::wstring"), std_wstring_summary_sp);
406 cpp_category_sp->GetTypeSummariesContainer()->Add(
407 ConstString("std::__ndk1::wstring"), std_wstring_summary_sp);
408 cpp_category_sp->GetTypeSummariesContainer()->Add(
409 ConstString("std::__1::basic_string<wchar_t, "
410 "std::__1::char_traits<wchar_t>, "
411 "std::__1::allocator<wchar_t> >"),
412 std_wstring_summary_sp);
413 cpp_category_sp->GetTypeSummariesContainer()->Add(
414 ConstString("std::__ndk1::basic_string<wchar_t, "
415 "std::__ndk1::char_traits<wchar_t>, "
416 "std::__ndk1::allocator<wchar_t> >"),
417 std_wstring_summary_sp);
419 SyntheticChildren::Flags stl_synth_flags;
420 stl_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences(
425 lldb_private::formatters::LibcxxStdVectorSyntheticFrontEndCreator,
426 "libc++ std::vector synthetic children",
427 ConstString("^std::__(ndk)?1::vector<.+>(( )?&)?$"), stl_synth_flags,
431 lldb_private::formatters::LibcxxStdListSyntheticFrontEndCreator,
432 "libc++ std::list synthetic children",
433 ConstString("^std::__(ndk)?1::list<.+>(( )?&)?$"), stl_synth_flags, true);
436 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator,
437 "libc++ std::map synthetic children",
438 ConstString("^std::__(ndk)?1::map<.+> >(( )?&)?$"), stl_synth_flags,
442 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator,
443 "libc++ std::set synthetic children",
444 ConstString("^std::__(ndk)?1::set<.+> >(( )?&)?$"), stl_synth_flags,
448 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator,
449 "libc++ std::multiset synthetic children",
450 ConstString("^std::__(ndk)?1::multiset<.+> >(( )?&)?$"), stl_synth_flags,
454 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator,
455 "libc++ std::multimap synthetic children",
456 ConstString("^std::__(ndk)?1::multimap<.+> >(( )?&)?$"), stl_synth_flags,
460 lldb_private::formatters::LibcxxStdUnorderedMapSyntheticFrontEndCreator,
461 "libc++ std::unordered containers synthetic children",
462 ConstString("^(std::__(ndk)?1::)unordered_(multi)?(map|set)<.+> >$"),
463 stl_synth_flags, true);
466 lldb_private::formatters::LibcxxInitializerListSyntheticFrontEndCreator,
467 "libc++ std::initializer_list synthetic children",
468 ConstString("^std::initializer_list<.+>(( )?&)?$"), stl_synth_flags,
472 lldb_private::formatters::LibcxxAtomicSyntheticFrontEndCreator,
473 "libc++ std::atomic synthetic children",
474 ConstString("^std::__(ndk)?1::atomic<.+>$"), stl_synth_flags, true);
476 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add(
477 RegularExpressionSP(new RegularExpression(
478 llvm::StringRef("^(std::__(ndk)?1::)deque<.+>(( )?&)?$"))),
479 SyntheticChildrenSP(new ScriptedSyntheticChildren(
481 "lldb.formatters.cpp.libcxx.stddeque_SynthProvider")));
485 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator,
486 "shared_ptr synthetic children",
487 ConstString("^(std::__(ndk)?1::)shared_ptr<.+>(( )?&)?$"),
488 stl_synth_flags, true);
491 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator,
492 "weak_ptr synthetic children",
493 ConstString("^(std::__(ndk)?1::)weak_ptr<.+>(( )?&)?$"), stl_synth_flags,
496 stl_summary_flags.SetDontShowChildren(false);
497 stl_summary_flags.SetSkipPointers(false);
498 AddCXXSummary(cpp_category_sp,
499 lldb_private::formatters::LibcxxContainerSummaryProvider,
500 "libc++ std::vector summary provider",
501 ConstString("^std::__(ndk)?1::vector<.+>(( )?&)?$"),
502 stl_summary_flags, true);
503 AddCXXSummary(cpp_category_sp,
504 lldb_private::formatters::LibcxxContainerSummaryProvider,
505 "libc++ std::list summary provider",
506 ConstString("^std::__(ndk)?1::list<.+>(( )?&)?$"),
507 stl_summary_flags, true);
508 AddCXXSummary(cpp_category_sp,
509 lldb_private::formatters::LibcxxContainerSummaryProvider,
510 "libc++ std::map summary provider",
511 ConstString("^std::__(ndk)?1::map<.+>(( )?&)?$"),
512 stl_summary_flags, true);
513 AddCXXSummary(cpp_category_sp,
514 lldb_private::formatters::LibcxxContainerSummaryProvider,
515 "libc++ std::deque summary provider",
516 ConstString("^std::__(ndk)?1::deque<.+>(( )?&)?$"),
517 stl_summary_flags, true);
518 AddCXXSummary(cpp_category_sp,
519 lldb_private::formatters::LibcxxContainerSummaryProvider,
520 "libc++ std::set summary provider",
521 ConstString("^std::__(ndk)?1::set<.+>(( )?&)?$"),
522 stl_summary_flags, true);
523 AddCXXSummary(cpp_category_sp,
524 lldb_private::formatters::LibcxxContainerSummaryProvider,
525 "libc++ std::multiset summary provider",
526 ConstString("^std::__(ndk)?1::multiset<.+>(( )?&)?$"),
527 stl_summary_flags, true);
528 AddCXXSummary(cpp_category_sp,
529 lldb_private::formatters::LibcxxContainerSummaryProvider,
530 "libc++ std::multimap summary provider",
531 ConstString("^std::__(ndk)?1::multimap<.+>(( )?&)?$"),
532 stl_summary_flags, true);
534 cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider,
535 "libc++ std::unordered containers summary provider",
536 ConstString("^(std::__(ndk)?1::)unordered_(multi)?(map|set)<.+> >$"),
537 stl_summary_flags, true);
539 cpp_category_sp, lldb_private::formatters::LibCxxAtomicSummaryProvider,
540 "libc++ std::atomic summary provider",
541 ConstString("^std::__(ndk)?1::atomic<.+>$"), stl_summary_flags, true);
543 stl_summary_flags.SetSkipPointers(true);
545 AddCXXSummary(cpp_category_sp,
546 lldb_private::formatters::LibcxxSmartPointerSummaryProvider,
547 "libc++ std::shared_ptr summary provider",
548 ConstString("^std::__(ndk)?1::shared_ptr<.+>(( )?&)?$"),
549 stl_summary_flags, true);
550 AddCXXSummary(cpp_category_sp,
551 lldb_private::formatters::LibcxxSmartPointerSummaryProvider,
552 "libc++ std::weak_ptr summary provider",
553 ConstString("^std::__(ndk)?1::weak_ptr<.+>(( )?&)?$"),
554 stl_summary_flags, true);
558 lldb_private::formatters::LibCxxVectorIteratorSyntheticFrontEndCreator,
559 "std::vector iterator synthetic children",
560 ConstString("^std::__(ndk)?1::__wrap_iter<.+>$"), stl_synth_flags, true);
564 lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEndCreator,
565 "std::map iterator synthetic children",
566 ConstString("^std::__(ndk)?1::__map_iterator<.+>$"), stl_synth_flags,
570 cpp_category_sp, lldb_private::formatters::LibcxxFunctionFrontEndCreator,
571 "std::function synthetic value provider",
572 ConstString("^std::__(ndk)?1::function<.+>$"), stl_synth_flags, true);
576 static void LoadLibStdcppFormatters(lldb::TypeCategoryImplSP cpp_category_sp) {
577 if (!cpp_category_sp)
580 TypeSummaryImpl::Flags stl_summary_flags;
581 stl_summary_flags.SetCascades(true)
582 .SetSkipPointers(false)
583 .SetSkipReferences(false)
584 .SetDontShowChildren(true)
585 .SetDontShowValue(true)
586 .SetShowMembersOneLiner(false)
587 .SetHideItemNames(false);
589 lldb::TypeSummaryImplSP std_string_summary_sp(
590 new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p}"));
592 lldb::TypeSummaryImplSP cxx11_string_summary_sp(new CXXFunctionSummaryFormat(
593 stl_summary_flags, LibStdcppStringSummaryProvider,
594 "libstdc++ c++11 std::string summary provider"));
595 lldb::TypeSummaryImplSP cxx11_wstring_summary_sp(new CXXFunctionSummaryFormat(
596 stl_summary_flags, LibStdcppWStringSummaryProvider,
597 "libstdc++ c++11 std::wstring summary provider"));
599 cpp_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::string"),
600 std_string_summary_sp);
601 cpp_category_sp->GetTypeSummariesContainer()->Add(
602 ConstString("std::basic_string<char>"), std_string_summary_sp);
603 cpp_category_sp->GetTypeSummariesContainer()->Add(
604 ConstString("std::basic_string<char,std::char_traits<char>,std::"
605 "allocator<char> >"),
606 std_string_summary_sp);
607 cpp_category_sp->GetTypeSummariesContainer()->Add(
608 ConstString("std::basic_string<char, std::char_traits<char>, "
609 "std::allocator<char> >"),
610 std_string_summary_sp);
612 cpp_category_sp->GetTypeSummariesContainer()->Add(
613 ConstString("std::__cxx11::string"), cxx11_string_summary_sp);
614 cpp_category_sp->GetTypeSummariesContainer()->Add(
615 ConstString("std::__cxx11::basic_string<char, std::char_traits<char>, "
616 "std::allocator<char> >"),
617 cxx11_string_summary_sp);
619 // making sure we force-pick the summary for printing wstring (_M_p is a
621 lldb::TypeSummaryImplSP std_wstring_summary_sp(
622 new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p%S}"));
624 cpp_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::wstring"),
625 std_wstring_summary_sp);
626 cpp_category_sp->GetTypeSummariesContainer()->Add(
627 ConstString("std::basic_string<wchar_t>"), std_wstring_summary_sp);
628 cpp_category_sp->GetTypeSummariesContainer()->Add(
629 ConstString("std::basic_string<wchar_t,std::char_traits<wchar_t>,std::"
630 "allocator<wchar_t> >"),
631 std_wstring_summary_sp);
632 cpp_category_sp->GetTypeSummariesContainer()->Add(
633 ConstString("std::basic_string<wchar_t, std::char_traits<wchar_t>, "
634 "std::allocator<wchar_t> >"),
635 std_wstring_summary_sp);
637 cpp_category_sp->GetTypeSummariesContainer()->Add(
638 ConstString("std::__cxx11::wstring"), cxx11_wstring_summary_sp);
639 cpp_category_sp->GetTypeSummariesContainer()->Add(
640 ConstString("std::__cxx11::basic_string<wchar_t, "
641 "std::char_traits<wchar_t>, std::allocator<wchar_t> >"),
642 cxx11_wstring_summary_sp);
644 #ifndef LLDB_DISABLE_PYTHON
646 SyntheticChildren::Flags stl_synth_flags;
647 stl_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences(
650 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add(
652 new RegularExpression(llvm::StringRef("^std::vector<.+>(( )?&)?$"))),
653 SyntheticChildrenSP(new ScriptedSyntheticChildren(
655 "lldb.formatters.cpp.gnu_libstdcpp.StdVectorSynthProvider")));
656 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add(
658 new RegularExpression(llvm::StringRef("^std::map<.+> >(( )?&)?$"))),
659 SyntheticChildrenSP(new ScriptedSyntheticChildren(
661 "lldb.formatters.cpp.gnu_libstdcpp.StdMapSynthProvider")));
662 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add(
663 RegularExpressionSP(new RegularExpression(
664 llvm::StringRef("^std::(__cxx11::)?list<.+>(( )?&)?$"))),
665 SyntheticChildrenSP(new ScriptedSyntheticChildren(
667 "lldb.formatters.cpp.gnu_libstdcpp.StdListSynthProvider")));
668 stl_summary_flags.SetDontShowChildren(false);
669 stl_summary_flags.SetSkipPointers(true);
670 cpp_category_sp->GetRegexTypeSummariesContainer()->Add(
672 new RegularExpression(llvm::StringRef("^std::vector<.+>(( )?&)?$"))),
674 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}")));
675 cpp_category_sp->GetRegexTypeSummariesContainer()->Add(
677 new RegularExpression(llvm::StringRef("^std::map<.+> >(( )?&)?$"))),
679 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}")));
680 cpp_category_sp->GetRegexTypeSummariesContainer()->Add(
681 RegularExpressionSP(new RegularExpression(
682 llvm::StringRef("^std::(__cxx11::)?list<.+>(( )?&)?$"))),
684 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}")));
688 lldb_private::formatters::LibStdcppVectorIteratorSyntheticFrontEndCreator,
689 "std::vector iterator synthetic children",
690 ConstString("^__gnu_cxx::__normal_iterator<.+>$"), stl_synth_flags, true);
694 lldb_private::formatters::LibstdcppMapIteratorSyntheticFrontEndCreator,
695 "std::map iterator synthetic children",
696 ConstString("^std::_Rb_tree_iterator<.+>$"), stl_synth_flags, true);
700 lldb_private::formatters::LibStdcppUniquePtrSyntheticFrontEndCreator,
701 "std::unique_ptr synthetic children",
702 ConstString("^std::unique_ptr<.+>(( )?&)?$"), stl_synth_flags, true);
705 lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator,
706 "std::shared_ptr synthetic children",
707 ConstString("^std::shared_ptr<.+>(( )?&)?$"), stl_synth_flags, true);
710 lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator,
711 "std::weak_ptr synthetic children",
712 ConstString("^std::weak_ptr<.+>(( )?&)?$"), stl_synth_flags, true);
715 lldb_private::formatters::LibStdcppTupleSyntheticFrontEndCreator,
716 "std::tuple synthetic children", ConstString("^std::tuple<.+>(( )?&)?$"),
717 stl_synth_flags, true);
719 AddCXXSummary(cpp_category_sp,
720 lldb_private::formatters::LibStdcppUniquePointerSummaryProvider,
721 "libstdc++ std::unique_ptr summary provider",
722 ConstString("^std::unique_ptr<.+>(( )?&)?$"), stl_summary_flags,
724 AddCXXSummary(cpp_category_sp,
725 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider,
726 "libstdc++ std::shared_ptr summary provider",
727 ConstString("^std::shared_ptr<.+>(( )?&)?$"), stl_summary_flags,
729 AddCXXSummary(cpp_category_sp,
730 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider,
731 "libstdc++ std::weak_ptr summary provider",
732 ConstString("^std::weak_ptr<.+>(( )?&)?$"), stl_summary_flags,
737 static void LoadSystemFormatters(lldb::TypeCategoryImplSP cpp_category_sp) {
738 if (!cpp_category_sp)
741 TypeSummaryImpl::Flags string_flags;
742 string_flags.SetCascades(true)
743 .SetSkipPointers(true)
744 .SetSkipReferences(false)
745 .SetDontShowChildren(true)
746 .SetDontShowValue(false)
747 .SetShowMembersOneLiner(false)
748 .SetHideItemNames(false);
750 TypeSummaryImpl::Flags string_array_flags;
751 string_array_flags.SetCascades(true)
752 .SetSkipPointers(true)
753 .SetSkipReferences(false)
754 .SetDontShowChildren(true)
755 .SetDontShowValue(true)
756 .SetShowMembersOneLiner(false)
757 .SetHideItemNames(false);
759 #ifndef LLDB_DISABLE_PYTHON
760 // FIXME because of a bug in the FormattersContainer we need to add a summary
761 // for both X* and const X* (<rdar://problem/12717717>)
763 cpp_category_sp, lldb_private::formatters::Char16StringSummaryProvider,
764 "char16_t * summary provider", ConstString("char16_t *"), string_flags);
765 AddCXXSummary(cpp_category_sp,
766 lldb_private::formatters::Char16StringSummaryProvider,
767 "char16_t [] summary provider",
768 ConstString("char16_t \\[[0-9]+\\]"), string_array_flags, true);
771 cpp_category_sp, lldb_private::formatters::Char32StringSummaryProvider,
772 "char32_t * summary provider", ConstString("char32_t *"), string_flags);
773 AddCXXSummary(cpp_category_sp,
774 lldb_private::formatters::Char32StringSummaryProvider,
775 "char32_t [] summary provider",
776 ConstString("char32_t \\[[0-9]+\\]"), string_array_flags, true);
779 cpp_category_sp, lldb_private::formatters::WCharStringSummaryProvider,
780 "wchar_t * summary provider", ConstString("wchar_t *"), string_flags);
781 AddCXXSummary(cpp_category_sp,
782 lldb_private::formatters::WCharStringSummaryProvider,
783 "wchar_t * summary provider",
784 ConstString("wchar_t \\[[0-9]+\\]"), string_array_flags, true);
787 cpp_category_sp, lldb_private::formatters::Char16StringSummaryProvider,
788 "unichar * summary provider", ConstString("unichar *"), string_flags);
790 TypeSummaryImpl::Flags widechar_flags;
791 widechar_flags.SetDontShowValue(true)
792 .SetSkipPointers(true)
793 .SetSkipReferences(false)
795 .SetDontShowChildren(true)
796 .SetHideItemNames(true)
797 .SetShowMembersOneLiner(false);
800 cpp_category_sp, lldb_private::formatters::Char16SummaryProvider,
801 "char16_t summary provider", ConstString("char16_t"), widechar_flags);
803 cpp_category_sp, lldb_private::formatters::Char32SummaryProvider,
804 "char32_t summary provider", ConstString("char32_t"), widechar_flags);
805 AddCXXSummary(cpp_category_sp, lldb_private::formatters::WCharSummaryProvider,
806 "wchar_t summary provider", ConstString("wchar_t"),
810 cpp_category_sp, lldb_private::formatters::Char16SummaryProvider,
811 "unichar summary provider", ConstString("unichar"), widechar_flags);
815 std::unique_ptr<Language::TypeScavenger> CPlusPlusLanguage::GetTypeScavenger() {
816 class CPlusPlusTypeScavenger : public Language::ImageListTypeScavenger {
818 virtual CompilerType AdjustForInclusion(CompilerType &candidate) override {
819 LanguageType lang_type(candidate.GetMinimumLanguage());
820 if (!Language::LanguageIsC(lang_type) &&
821 !Language::LanguageIsCPlusPlus(lang_type))
822 return CompilerType();
823 if (candidate.IsTypedefType())
824 return candidate.GetTypedefedType();
829 return std::unique_ptr<TypeScavenger>(new CPlusPlusTypeScavenger());
832 lldb::TypeCategoryImplSP CPlusPlusLanguage::GetFormatters() {
833 static llvm::once_flag g_initialize;
834 static TypeCategoryImplSP g_category;
836 llvm::call_once(g_initialize, [this]() -> void {
837 DataVisualization::Categories::GetCategory(GetPluginName(), g_category);
839 LoadLibCxxFormatters(g_category);
840 LoadLibStdcppFormatters(g_category);
841 LoadSystemFormatters(g_category);
847 HardcodedFormatters::HardcodedSummaryFinder
848 CPlusPlusLanguage::GetHardcodedSummaries() {
849 static llvm::once_flag g_initialize;
850 static ConstString g_vectortypes("VectorTypes");
851 static HardcodedFormatters::HardcodedSummaryFinder g_formatters;
853 llvm::call_once(g_initialize, []() -> void {
854 g_formatters.push_back(
855 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType,
856 FormatManager &) -> TypeSummaryImpl::SharedPointer {
857 static CXXFunctionSummaryFormat::SharedPointer formatter_sp(
858 new CXXFunctionSummaryFormat(
859 TypeSummaryImpl::Flags(),
860 lldb_private::formatters::CXXFunctionPointerSummaryProvider,
861 "Function pointer summary provider"));
862 if (valobj.GetCompilerType().IsFunctionPointerType()) {
867 g_formatters.push_back(
868 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType,
869 FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer {
870 static CXXFunctionSummaryFormat::SharedPointer formatter_sp(
871 new CXXFunctionSummaryFormat(
872 TypeSummaryImpl::Flags()
874 .SetDontShowChildren(true)
875 .SetHideItemNames(true)
876 .SetShowMembersOneLiner(true)
877 .SetSkipPointers(true)
878 .SetSkipReferences(false),
879 lldb_private::formatters::VectorTypeSummaryProvider,
880 "vector_type pointer summary provider"));
881 if (valobj.GetCompilerType().IsVectorType(nullptr, nullptr)) {
882 if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled())
887 g_formatters.push_back(
888 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType,
889 FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer {
890 static CXXFunctionSummaryFormat::SharedPointer formatter_sp(
891 new CXXFunctionSummaryFormat(
892 TypeSummaryImpl::Flags()
894 .SetDontShowChildren(true)
895 .SetHideItemNames(true)
896 .SetShowMembersOneLiner(true)
897 .SetSkipPointers(true)
898 .SetSkipReferences(false),
899 lldb_private::formatters::BlockPointerSummaryProvider,
900 "block pointer summary provider"));
901 if (valobj.GetCompilerType().IsBlockPointerType(nullptr)) {
911 HardcodedFormatters::HardcodedSyntheticFinder
912 CPlusPlusLanguage::GetHardcodedSynthetics() {
913 static llvm::once_flag g_initialize;
914 static ConstString g_vectortypes("VectorTypes");
915 static HardcodedFormatters::HardcodedSyntheticFinder g_formatters;
917 llvm::call_once(g_initialize, []() -> void {
918 g_formatters.push_back([](lldb_private::ValueObject &valobj,
919 lldb::DynamicValueType,
921 fmt_mgr) -> SyntheticChildren::SharedPointer {
922 static CXXSyntheticChildren::SharedPointer formatter_sp(
923 new CXXSyntheticChildren(
924 SyntheticChildren::Flags()
926 .SetSkipPointers(true)
927 .SetSkipReferences(true)
928 .SetNonCacheable(true),
929 "vector_type synthetic children",
930 lldb_private::formatters::VectorTypeSyntheticFrontEndCreator));
931 if (valobj.GetCompilerType().IsVectorType(nullptr, nullptr)) {
932 if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled())
937 g_formatters.push_back([](lldb_private::ValueObject &valobj,
938 lldb::DynamicValueType,
940 fmt_mgr) -> SyntheticChildren::SharedPointer {
941 static CXXSyntheticChildren::SharedPointer formatter_sp(
942 new CXXSyntheticChildren(
943 SyntheticChildren::Flags()
945 .SetSkipPointers(true)
946 .SetSkipReferences(true)
947 .SetNonCacheable(true),
948 "block pointer synthetic children",
949 lldb_private::formatters::BlockPointerSyntheticFrontEndCreator));
950 if (valobj.GetCompilerType().IsBlockPointerType(nullptr)) {