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