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