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