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