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