1 //===-- CPlusPlusLanguage.cpp -----------------------------------*- C++ -*-===// 2 // 3 // The LLVM Compiler Infrastructure 4 // 5 // This file is distributed under the University of Illinois Open Source 6 // License. See LICENSE.TXT for details. 7 // 8 //===----------------------------------------------------------------------===// 9 10 #include "CPlusPlusLanguage.h" 11 12 // C Includes 13 #include <cctype> 14 #include <cstring> 15 16 // C++ Includes 17 #include <functional> 18 #include <memory> 19 #include <mutex> 20 #include <set> 21 22 // Other libraries and framework includes 23 #include "llvm/ADT/StringRef.h" 24 25 // Project includes 26 #include "lldb/Core/PluginManager.h" 27 #include "lldb/Core/UniqueCStringMap.h" 28 #include "lldb/DataFormatters/CXXFunctionPointer.h" 29 #include "lldb/DataFormatters/DataVisualization.h" 30 #include "lldb/DataFormatters/FormattersHelpers.h" 31 #include "lldb/DataFormatters/VectorType.h" 32 #include "lldb/Utility/ConstString.h" 33 #include "lldb/Utility/FastDemangle.h" 34 #include "lldb/Utility/Log.h" 35 #include "lldb/Utility/RegularExpression.h" 36 37 #include "BlockPointer.h" 38 #include "CPlusPlusNameParser.h" 39 #include "CxxStringTypes.h" 40 #include "LibCxx.h" 41 #include "LibCxxAtomic.h" 42 #include "LibStdcpp.h" 43 44 using namespace lldb; 45 using namespace lldb_private; 46 using namespace lldb_private::formatters; 47 48 void CPlusPlusLanguage::Initialize() { 49 PluginManager::RegisterPlugin(GetPluginNameStatic(), "C++ Language", 50 CreateInstance); 51 } 52 53 void CPlusPlusLanguage::Terminate() { 54 PluginManager::UnregisterPlugin(CreateInstance); 55 } 56 57 lldb_private::ConstString CPlusPlusLanguage::GetPluginNameStatic() { 58 static ConstString g_name("cplusplus"); 59 return g_name; 60 } 61 62 //------------------------------------------------------------------ 63 // PluginInterface protocol 64 //------------------------------------------------------------------ 65 66 lldb_private::ConstString CPlusPlusLanguage::GetPluginName() { 67 return GetPluginNameStatic(); 68 } 69 70 uint32_t CPlusPlusLanguage::GetPluginVersion() { return 1; } 71 72 //------------------------------------------------------------------ 73 // Static Functions 74 //------------------------------------------------------------------ 75 76 Language *CPlusPlusLanguage::CreateInstance(lldb::LanguageType language) { 77 if (Language::LanguageIsCPlusPlus(language)) 78 return new CPlusPlusLanguage(); 79 return nullptr; 80 } 81 82 void CPlusPlusLanguage::MethodName::Clear() { 83 m_full.Clear(); 84 m_basename = llvm::StringRef(); 85 m_context = llvm::StringRef(); 86 m_arguments = llvm::StringRef(); 87 m_qualifiers = llvm::StringRef(); 88 m_parsed = false; 89 m_parse_error = false; 90 } 91 92 static bool ReverseFindMatchingChars(const llvm::StringRef &s, 93 const llvm::StringRef &left_right_chars, 94 size_t &left_pos, size_t &right_pos, 95 size_t pos = llvm::StringRef::npos) { 96 assert(left_right_chars.size() == 2); 97 left_pos = llvm::StringRef::npos; 98 const char left_char = left_right_chars[0]; 99 const char right_char = left_right_chars[1]; 100 pos = s.find_last_of(left_right_chars, pos); 101 if (pos == llvm::StringRef::npos || s[pos] == left_char) 102 return false; 103 right_pos = pos; 104 uint32_t depth = 1; 105 while (pos > 0 && depth > 0) { 106 pos = s.find_last_of(left_right_chars, pos); 107 if (pos == llvm::StringRef::npos) 108 return false; 109 if (s[pos] == left_char) { 110 if (--depth == 0) { 111 left_pos = pos; 112 return left_pos < right_pos; 113 } 114 } else if (s[pos] == right_char) { 115 ++depth; 116 } 117 } 118 return false; 119 } 120 121 static bool IsTrivialBasename(const llvm::StringRef &basename) { 122 // Check that the basename matches with the following regular expression 123 // "^~?([A-Za-z_][A-Za-z_0-9]*)$" We are using a hand written implementation 124 // because it is significantly more efficient then using the general purpose 125 // regular expression library. 126 size_t idx = 0; 127 if (basename.size() > 0 && basename[0] == '~') 128 idx = 1; 129 130 if (basename.size() <= idx) 131 return false; // Empty string or "~" 132 133 if (!std::isalpha(basename[idx]) && basename[idx] != '_') 134 return false; // First charater (after removing the possible '~'') isn't in 135 // [A-Za-z_] 136 137 // Read all characters matching [A-Za-z_0-9] 138 ++idx; 139 while (idx < basename.size()) { 140 if (!std::isalnum(basename[idx]) && basename[idx] != '_') 141 break; 142 ++idx; 143 } 144 145 // We processed all characters. It is a vaild basename. 146 if (idx == basename.size()) 147 return true; 148 149 return false; 150 } 151 152 bool CPlusPlusLanguage::MethodName::TrySimplifiedParse() { 153 // This method tries to parse simple method definitions which are presumably 154 // most comman in user programs. Definitions that can be parsed by this 155 // function don't have return types and templates in the name. 156 // A::B::C::fun(std::vector<T> &) const 157 size_t arg_start, arg_end; 158 llvm::StringRef full(m_full.GetCString()); 159 llvm::StringRef parens("()", 2); 160 if (ReverseFindMatchingChars(full, parens, arg_start, arg_end)) { 161 m_arguments = full.substr(arg_start, arg_end - arg_start + 1); 162 if (arg_end + 1 < full.size()) 163 m_qualifiers = full.substr(arg_end + 1).ltrim(); 164 165 if (arg_start == 0) 166 return false; 167 size_t basename_end = arg_start; 168 size_t context_start = 0; 169 size_t context_end = full.rfind(':', basename_end); 170 if (context_end == llvm::StringRef::npos) 171 m_basename = full.substr(0, basename_end); 172 else { 173 if (context_start < context_end) 174 m_context = full.substr(context_start, context_end - 1 - context_start); 175 const size_t basename_begin = context_end + 1; 176 m_basename = full.substr(basename_begin, basename_end - basename_begin); 177 } 178 179 if (IsTrivialBasename(m_basename)) { 180 return true; 181 } else { 182 // The C++ basename doesn't match our regular expressions so this can't 183 // be a valid C++ method, clear everything out and indicate an error 184 m_context = llvm::StringRef(); 185 m_basename = llvm::StringRef(); 186 m_arguments = llvm::StringRef(); 187 m_qualifiers = llvm::StringRef(); 188 return false; 189 } 190 } 191 return false; 192 } 193 194 void CPlusPlusLanguage::MethodName::Parse() { 195 if (!m_parsed && m_full) { 196 if (TrySimplifiedParse()) { 197 m_parse_error = false; 198 } else { 199 CPlusPlusNameParser parser(m_full.GetStringRef()); 200 if (auto function = parser.ParseAsFunctionDefinition()) { 201 m_basename = function.getValue().name.basename; 202 m_context = function.getValue().name.context; 203 m_arguments = function.getValue().arguments; 204 m_qualifiers = function.getValue().qualifiers; 205 m_parse_error = false; 206 } else { 207 m_parse_error = true; 208 } 209 } 210 m_parsed = true; 211 } 212 } 213 214 llvm::StringRef CPlusPlusLanguage::MethodName::GetBasename() { 215 if (!m_parsed) 216 Parse(); 217 return m_basename; 218 } 219 220 llvm::StringRef CPlusPlusLanguage::MethodName::GetContext() { 221 if (!m_parsed) 222 Parse(); 223 return m_context; 224 } 225 226 llvm::StringRef CPlusPlusLanguage::MethodName::GetArguments() { 227 if (!m_parsed) 228 Parse(); 229 return m_arguments; 230 } 231 232 llvm::StringRef CPlusPlusLanguage::MethodName::GetQualifiers() { 233 if (!m_parsed) 234 Parse(); 235 return m_qualifiers; 236 } 237 238 std::string CPlusPlusLanguage::MethodName::GetScopeQualifiedName() { 239 if (!m_parsed) 240 Parse(); 241 if (m_context.empty()) 242 return m_basename; 243 244 std::string res; 245 res += m_context; 246 res += "::"; 247 res += m_basename; 248 return res; 249 } 250 251 bool CPlusPlusLanguage::IsCPPMangledName(const char *name) { 252 // FIXME!! we should really run through all the known C++ Language plugins 253 // and ask each one if this is a C++ mangled name 254 255 if (name == nullptr) 256 return false; 257 258 // MSVC style mangling 259 if (name[0] == '?') 260 return true; 261 262 return (name[0] != '\0' && name[0] == '_' && name[1] == 'Z'); 263 } 264 265 bool CPlusPlusLanguage::ExtractContextAndIdentifier( 266 const char *name, llvm::StringRef &context, llvm::StringRef &identifier) { 267 CPlusPlusNameParser parser(name); 268 if (auto full_name = parser.ParseAsFullName()) { 269 identifier = full_name.getValue().basename; 270 context = full_name.getValue().context; 271 return true; 272 } 273 return false; 274 } 275 276 /// Given a mangled function `mangled`, replace all the primitive function type 277 /// arguments of `search` with type `replace`. 278 static ConstString SubsPrimitiveParmItanium(llvm::StringRef mangled, 279 llvm::StringRef search, 280 llvm::StringRef replace) { 281 Log *log = GetLogIfAllCategoriesSet(LIBLLDB_LOG_LANGUAGE); 282 283 const size_t max_len = 284 mangled.size() + mangled.count(search) * replace.size() + 1; 285 286 // Make a temporary buffer to fix up the mangled parameter types and copy the 287 // original there 288 std::string output_buf; 289 output_buf.reserve(max_len); 290 output_buf.insert(0, mangled.str()); 291 ptrdiff_t replaced_offset = 0; 292 293 auto swap_parms_hook = [&](const char *parsee) { 294 if (!parsee || !*parsee) 295 return; 296 297 // Check whether we've found a substitutee 298 llvm::StringRef s(parsee); 299 if (s.startswith(search)) { 300 // account for the case where a replacement is of a different length to 301 // the original 302 replaced_offset += replace.size() - search.size(); 303 304 ptrdiff_t replace_idx = (mangled.size() - s.size()) + replaced_offset; 305 output_buf.erase(replace_idx, search.size()); 306 output_buf.insert(replace_idx, replace.str()); 307 } 308 }; 309 310 // FastDemangle will call our hook for each instance of a primitive type, 311 // allowing us to perform substitution 312 char *const demangled = 313 FastDemangle(mangled.str().c_str(), mangled.size(), swap_parms_hook); 314 315 if (log) 316 log->Printf("substituted mangling for %s:{%s} %s:{%s}\n", 317 mangled.str().c_str(), demangled, output_buf.c_str(), 318 FastDemangle(output_buf.c_str())); 319 // FastDemangle malloc'd this string. 320 free(demangled); 321 322 return output_buf == mangled ? ConstString() : ConstString(output_buf); 323 } 324 325 uint32_t CPlusPlusLanguage::FindAlternateFunctionManglings( 326 const ConstString mangled_name, std::set<ConstString> &alternates) { 327 const auto start_size = alternates.size(); 328 /// Get a basic set of alternative manglings for the given symbol `name`, by 329 /// making a few basic possible substitutions on basic types, storage duration 330 /// and `const`ness for the given symbol. The output parameter `alternates` 331 /// is filled with a best-guess, non-exhaustive set of different manglings 332 /// for the given name. 333 334 // Maybe we're looking for a const symbol but the debug info told us it was 335 // non-const... 336 if (!strncmp(mangled_name.GetCString(), "_ZN", 3) && 337 strncmp(mangled_name.GetCString(), "_ZNK", 4)) { 338 std::string fixed_scratch("_ZNK"); 339 fixed_scratch.append(mangled_name.GetCString() + 3); 340 alternates.insert(ConstString(fixed_scratch)); 341 } 342 343 // Maybe we're looking for a static symbol but we thought it was global... 344 if (!strncmp(mangled_name.GetCString(), "_Z", 2) && 345 strncmp(mangled_name.GetCString(), "_ZL", 3)) { 346 std::string fixed_scratch("_ZL"); 347 fixed_scratch.append(mangled_name.GetCString() + 2); 348 alternates.insert(ConstString(fixed_scratch)); 349 } 350 351 // `char` is implementation defined as either `signed` or `unsigned`. As a 352 // result a char parameter has 3 possible manglings: 'c'-char, 'a'-signed 353 // char, 'h'-unsigned char. If we're looking for symbols with a signed char 354 // parameter, try finding matches which have the general case 'c'. 355 if (ConstString char_fixup = 356 SubsPrimitiveParmItanium(mangled_name.GetStringRef(), "a", "c")) 357 alternates.insert(char_fixup); 358 359 // long long parameter mangling 'x', may actually just be a long 'l' argument 360 if (ConstString long_fixup = 361 SubsPrimitiveParmItanium(mangled_name.GetStringRef(), "x", "l")) 362 alternates.insert(long_fixup); 363 364 // unsigned long long parameter mangling 'y', may actually just be unsigned 365 // long 'm' argument 366 if (ConstString ulong_fixup = 367 SubsPrimitiveParmItanium(mangled_name.GetStringRef(), "y", "m")) 368 alternates.insert(ulong_fixup); 369 370 return alternates.size() - start_size; 371 } 372 373 static void LoadLibCxxFormatters(lldb::TypeCategoryImplSP cpp_category_sp) { 374 if (!cpp_category_sp) 375 return; 376 377 TypeSummaryImpl::Flags stl_summary_flags; 378 stl_summary_flags.SetCascades(true) 379 .SetSkipPointers(false) 380 .SetSkipReferences(false) 381 .SetDontShowChildren(true) 382 .SetDontShowValue(true) 383 .SetShowMembersOneLiner(false) 384 .SetHideItemNames(false); 385 386 #ifndef LLDB_DISABLE_PYTHON 387 lldb::TypeSummaryImplSP std_string_summary_sp(new CXXFunctionSummaryFormat( 388 stl_summary_flags, lldb_private::formatters::LibcxxStringSummaryProvider, 389 "std::string summary provider")); 390 lldb::TypeSummaryImplSP std_wstring_summary_sp(new CXXFunctionSummaryFormat( 391 stl_summary_flags, lldb_private::formatters::LibcxxWStringSummaryProvider, 392 "std::wstring summary provider")); 393 394 cpp_category_sp->GetTypeSummariesContainer()->Add( 395 ConstString("std::__1::string"), std_string_summary_sp); 396 cpp_category_sp->GetTypeSummariesContainer()->Add( 397 ConstString("std::__ndk1::string"), std_string_summary_sp); 398 cpp_category_sp->GetTypeSummariesContainer()->Add( 399 ConstString("std::__1::basic_string<char, std::__1::char_traits<char>, " 400 "std::__1::allocator<char> >"), 401 std_string_summary_sp); 402 cpp_category_sp->GetTypeSummariesContainer()->Add( 403 ConstString("std::__ndk1::basic_string<char, " 404 "std::__ndk1::char_traits<char>, " 405 "std::__ndk1::allocator<char> >"), 406 std_string_summary_sp); 407 408 cpp_category_sp->GetTypeSummariesContainer()->Add( 409 ConstString("std::__1::wstring"), std_wstring_summary_sp); 410 cpp_category_sp->GetTypeSummariesContainer()->Add( 411 ConstString("std::__ndk1::wstring"), std_wstring_summary_sp); 412 cpp_category_sp->GetTypeSummariesContainer()->Add( 413 ConstString("std::__1::basic_string<wchar_t, " 414 "std::__1::char_traits<wchar_t>, " 415 "std::__1::allocator<wchar_t> >"), 416 std_wstring_summary_sp); 417 cpp_category_sp->GetTypeSummariesContainer()->Add( 418 ConstString("std::__ndk1::basic_string<wchar_t, " 419 "std::__ndk1::char_traits<wchar_t>, " 420 "std::__ndk1::allocator<wchar_t> >"), 421 std_wstring_summary_sp); 422 423 SyntheticChildren::Flags stl_synth_flags; 424 stl_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences( 425 false); 426 SyntheticChildren::Flags stl_deref_flags = stl_synth_flags; 427 stl_deref_flags.SetFrontEndWantsDereference(); 428 429 AddCXXSynthetic( 430 cpp_category_sp, 431 lldb_private::formatters::LibcxxBitsetSyntheticFrontEndCreator, 432 "libc++ std::bitset synthetic children", 433 ConstString("^std::__(ndk)?1::bitset<.+>(( )?&)?$"), stl_deref_flags, 434 true); 435 AddCXXSynthetic( 436 cpp_category_sp, 437 lldb_private::formatters::LibcxxStdVectorSyntheticFrontEndCreator, 438 "libc++ std::vector synthetic children", 439 ConstString("^std::__(ndk)?1::vector<.+>(( )?&)?$"), stl_deref_flags, 440 true); 441 AddCXXSynthetic( 442 cpp_category_sp, 443 lldb_private::formatters::LibcxxStdForwardListSyntheticFrontEndCreator, 444 "libc++ std::forward_list synthetic children", 445 ConstString("^std::__(ndk)?1::forward_list<.+>(( )?&)?$"), 446 stl_synth_flags, true); 447 AddCXXSynthetic( 448 cpp_category_sp, 449 lldb_private::formatters::LibcxxStdListSyntheticFrontEndCreator, 450 "libc++ std::list synthetic children", 451 ConstString("^std::__(ndk)?1::list<.+>(( )?&)?$"), stl_synth_flags, true); 452 AddCXXSynthetic( 453 cpp_category_sp, 454 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, 455 "libc++ std::map synthetic children", 456 ConstString("^std::__(ndk)?1::map<.+> >(( )?&)?$"), stl_synth_flags, 457 true); 458 AddCXXSynthetic( 459 cpp_category_sp, 460 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, 461 "libc++ std::set synthetic children", 462 ConstString("^std::__(ndk)?1::set<.+> >(( )?&)?$"), stl_deref_flags, 463 true); 464 AddCXXSynthetic( 465 cpp_category_sp, 466 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, 467 "libc++ std::multiset synthetic children", 468 ConstString("^std::__(ndk)?1::multiset<.+> >(( )?&)?$"), stl_deref_flags, 469 true); 470 AddCXXSynthetic( 471 cpp_category_sp, 472 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, 473 "libc++ std::multimap synthetic children", 474 ConstString("^std::__(ndk)?1::multimap<.+> >(( )?&)?$"), stl_synth_flags, 475 true); 476 AddCXXSynthetic( 477 cpp_category_sp, 478 lldb_private::formatters::LibcxxStdUnorderedMapSyntheticFrontEndCreator, 479 "libc++ std::unordered containers synthetic children", 480 ConstString("^(std::__(ndk)?1::)unordered_(multi)?(map|set)<.+> >$"), 481 stl_synth_flags, true); 482 AddCXXSynthetic( 483 cpp_category_sp, 484 lldb_private::formatters::LibcxxInitializerListSyntheticFrontEndCreator, 485 "libc++ std::initializer_list synthetic children", 486 ConstString("^std::initializer_list<.+>(( )?&)?$"), stl_synth_flags, 487 true); 488 AddCXXSynthetic(cpp_category_sp, LibcxxQueueFrontEndCreator, 489 "libc++ std::queue synthetic children", 490 ConstString("^std::__(ndk)?1::queue<.+>(( )?&)?$"), 491 stl_synth_flags, true); 492 AddCXXSynthetic(cpp_category_sp, LibcxxTupleFrontEndCreator, 493 "libc++ std::tuple synthetic children", 494 ConstString("^std::__(ndk)?1::tuple<.*>(( )?&)?$"), stl_synth_flags, 495 true); 496 AddCXXSynthetic(cpp_category_sp, LibcxxOptionalFrontEndCreator, 497 "libc++ std::optional synthetic children", 498 ConstString("^std::__(ndk)?1::optional<.+>(( )?&)?$"), 499 stl_synth_flags, true); 500 AddCXXSynthetic( 501 cpp_category_sp, 502 lldb_private::formatters::LibcxxAtomicSyntheticFrontEndCreator, 503 "libc++ std::atomic synthetic children", 504 ConstString("^std::__(ndk)?1::atomic<.+>$"), stl_synth_flags, true); 505 506 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 507 RegularExpressionSP(new RegularExpression( 508 llvm::StringRef("^(std::__(ndk)?1::)deque<.+>(( )?&)?$"))), 509 SyntheticChildrenSP(new ScriptedSyntheticChildren( 510 stl_synth_flags, 511 "lldb.formatters.cpp.libcxx.stddeque_SynthProvider"))); 512 513 AddCXXSynthetic( 514 cpp_category_sp, 515 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator, 516 "shared_ptr synthetic children", 517 ConstString("^(std::__(ndk)?1::)shared_ptr<.+>(( )?&)?$"), 518 stl_synth_flags, true); 519 AddCXXSynthetic( 520 cpp_category_sp, 521 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator, 522 "weak_ptr synthetic children", 523 ConstString("^(std::__(ndk)?1::)weak_ptr<.+>(( )?&)?$"), stl_synth_flags, 524 true); 525 526 stl_summary_flags.SetDontShowChildren(false); 527 stl_summary_flags.SetSkipPointers(false); 528 AddCXXSummary(cpp_category_sp, 529 lldb_private::formatters::LibcxxContainerSummaryProvider, 530 "libc++ std::bitset summary provider", 531 ConstString("^std::__(ndk)?1::bitset<.+>(( )?&)?$"), 532 stl_summary_flags, true); 533 AddCXXSummary(cpp_category_sp, 534 lldb_private::formatters::LibcxxContainerSummaryProvider, 535 "libc++ std::vector summary provider", 536 ConstString("^std::__(ndk)?1::vector<.+>(( )?&)?$"), 537 stl_summary_flags, true); 538 AddCXXSummary(cpp_category_sp, 539 lldb_private::formatters::LibcxxContainerSummaryProvider, 540 "libc++ std::list summary provider", 541 ConstString("^std::__(ndk)?1::forward_list<.+>(( )?&)?$"), 542 stl_summary_flags, true); 543 AddCXXSummary(cpp_category_sp, 544 lldb_private::formatters::LibcxxContainerSummaryProvider, 545 "libc++ std::list summary provider", 546 ConstString("^std::__(ndk)?1::list<.+>(( )?&)?$"), 547 stl_summary_flags, true); 548 AddCXXSummary(cpp_category_sp, 549 lldb_private::formatters::LibcxxContainerSummaryProvider, 550 "libc++ std::map summary provider", 551 ConstString("^std::__(ndk)?1::map<.+>(( )?&)?$"), 552 stl_summary_flags, true); 553 AddCXXSummary(cpp_category_sp, 554 lldb_private::formatters::LibcxxContainerSummaryProvider, 555 "libc++ std::deque summary provider", 556 ConstString("^std::__(ndk)?1::deque<.+>(( )?&)?$"), 557 stl_summary_flags, true); 558 AddCXXSummary(cpp_category_sp, 559 lldb_private::formatters::LibcxxContainerSummaryProvider, 560 "libc++ std::queue summary provider", 561 ConstString("^std::__(ndk)?1::queue<.+>(( )?&)?$"), 562 stl_summary_flags, true); 563 AddCXXSummary(cpp_category_sp, 564 lldb_private::formatters::LibcxxContainerSummaryProvider, 565 "libc++ std::set summary provider", 566 ConstString("^std::__(ndk)?1::set<.+>(( )?&)?$"), 567 stl_summary_flags, true); 568 AddCXXSummary(cpp_category_sp, 569 lldb_private::formatters::LibcxxContainerSummaryProvider, 570 "libc++ std::multiset summary provider", 571 ConstString("^std::__(ndk)?1::multiset<.+>(( )?&)?$"), 572 stl_summary_flags, true); 573 AddCXXSummary(cpp_category_sp, 574 lldb_private::formatters::LibcxxContainerSummaryProvider, 575 "libc++ std::multimap summary provider", 576 ConstString("^std::__(ndk)?1::multimap<.+>(( )?&)?$"), 577 stl_summary_flags, true); 578 AddCXXSummary( 579 cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider, 580 "libc++ std::unordered containers summary provider", 581 ConstString("^(std::__(ndk)?1::)unordered_(multi)?(map|set)<.+> >$"), 582 stl_summary_flags, true); 583 AddCXXSummary(cpp_category_sp, LibcxxContainerSummaryProvider, 584 "libc++ std::tuple summary provider", 585 ConstString("^std::__(ndk)?1::tuple<.*>(( )?&)?$"), stl_summary_flags, 586 true); 587 AddCXXSummary( 588 cpp_category_sp, lldb_private::formatters::LibCxxAtomicSummaryProvider, 589 "libc++ std::atomic summary provider", 590 ConstString("^std::__(ndk)?1::atomic<.+>$"), stl_summary_flags, true); 591 AddCXXSummary(cpp_category_sp, 592 lldb_private::formatters::LibcxxOptionalSummaryProvider, 593 "libc++ std::optional summary provider", 594 ConstString("^std::__(ndk)?1::optional<.+>(( )?&)?$"), 595 stl_summary_flags, true); 596 597 stl_summary_flags.SetSkipPointers(true); 598 599 AddCXXSummary(cpp_category_sp, 600 lldb_private::formatters::LibcxxSmartPointerSummaryProvider, 601 "libc++ std::shared_ptr summary provider", 602 ConstString("^std::__(ndk)?1::shared_ptr<.+>(( )?&)?$"), 603 stl_summary_flags, true); 604 AddCXXSummary(cpp_category_sp, 605 lldb_private::formatters::LibcxxSmartPointerSummaryProvider, 606 "libc++ std::weak_ptr summary provider", 607 ConstString("^std::__(ndk)?1::weak_ptr<.+>(( )?&)?$"), 608 stl_summary_flags, true); 609 610 AddCXXSynthetic( 611 cpp_category_sp, 612 lldb_private::formatters::LibCxxVectorIteratorSyntheticFrontEndCreator, 613 "std::vector iterator synthetic children", 614 ConstString("^std::__(ndk)?1::__wrap_iter<.+>$"), stl_synth_flags, true); 615 616 AddCXXSynthetic( 617 cpp_category_sp, 618 lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEndCreator, 619 "std::map iterator synthetic children", 620 ConstString("^std::__(ndk)?1::__map_iterator<.+>$"), stl_synth_flags, 621 true); 622 623 AddCXXSynthetic( 624 cpp_category_sp, lldb_private::formatters::LibcxxFunctionFrontEndCreator, 625 "std::function synthetic value provider", 626 ConstString("^std::__(ndk)?1::function<.+>$"), stl_synth_flags, true); 627 #endif 628 } 629 630 static void LoadLibStdcppFormatters(lldb::TypeCategoryImplSP cpp_category_sp) { 631 if (!cpp_category_sp) 632 return; 633 634 TypeSummaryImpl::Flags stl_summary_flags; 635 stl_summary_flags.SetCascades(true) 636 .SetSkipPointers(false) 637 .SetSkipReferences(false) 638 .SetDontShowChildren(true) 639 .SetDontShowValue(true) 640 .SetShowMembersOneLiner(false) 641 .SetHideItemNames(false); 642 643 lldb::TypeSummaryImplSP std_string_summary_sp( 644 new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p}")); 645 646 lldb::TypeSummaryImplSP cxx11_string_summary_sp(new CXXFunctionSummaryFormat( 647 stl_summary_flags, LibStdcppStringSummaryProvider, 648 "libstdc++ c++11 std::string summary provider")); 649 lldb::TypeSummaryImplSP cxx11_wstring_summary_sp(new CXXFunctionSummaryFormat( 650 stl_summary_flags, LibStdcppWStringSummaryProvider, 651 "libstdc++ c++11 std::wstring summary provider")); 652 653 cpp_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::string"), 654 std_string_summary_sp); 655 cpp_category_sp->GetTypeSummariesContainer()->Add( 656 ConstString("std::basic_string<char>"), std_string_summary_sp); 657 cpp_category_sp->GetTypeSummariesContainer()->Add( 658 ConstString("std::basic_string<char,std::char_traits<char>,std::" 659 "allocator<char> >"), 660 std_string_summary_sp); 661 cpp_category_sp->GetTypeSummariesContainer()->Add( 662 ConstString("std::basic_string<char, std::char_traits<char>, " 663 "std::allocator<char> >"), 664 std_string_summary_sp); 665 666 cpp_category_sp->GetTypeSummariesContainer()->Add( 667 ConstString("std::__cxx11::string"), cxx11_string_summary_sp); 668 cpp_category_sp->GetTypeSummariesContainer()->Add( 669 ConstString("std::__cxx11::basic_string<char, std::char_traits<char>, " 670 "std::allocator<char> >"), 671 cxx11_string_summary_sp); 672 673 // making sure we force-pick the summary for printing wstring (_M_p is a 674 // wchar_t*) 675 lldb::TypeSummaryImplSP std_wstring_summary_sp( 676 new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p%S}")); 677 678 cpp_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::wstring"), 679 std_wstring_summary_sp); 680 cpp_category_sp->GetTypeSummariesContainer()->Add( 681 ConstString("std::basic_string<wchar_t>"), std_wstring_summary_sp); 682 cpp_category_sp->GetTypeSummariesContainer()->Add( 683 ConstString("std::basic_string<wchar_t,std::char_traits<wchar_t>,std::" 684 "allocator<wchar_t> >"), 685 std_wstring_summary_sp); 686 cpp_category_sp->GetTypeSummariesContainer()->Add( 687 ConstString("std::basic_string<wchar_t, std::char_traits<wchar_t>, " 688 "std::allocator<wchar_t> >"), 689 std_wstring_summary_sp); 690 691 cpp_category_sp->GetTypeSummariesContainer()->Add( 692 ConstString("std::__cxx11::wstring"), cxx11_wstring_summary_sp); 693 cpp_category_sp->GetTypeSummariesContainer()->Add( 694 ConstString("std::__cxx11::basic_string<wchar_t, " 695 "std::char_traits<wchar_t>, std::allocator<wchar_t> >"), 696 cxx11_wstring_summary_sp); 697 698 #ifndef LLDB_DISABLE_PYTHON 699 700 SyntheticChildren::Flags stl_synth_flags; 701 stl_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences( 702 false); 703 704 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 705 RegularExpressionSP( 706 new RegularExpression(llvm::StringRef("^std::vector<.+>(( )?&)?$"))), 707 SyntheticChildrenSP(new ScriptedSyntheticChildren( 708 stl_synth_flags, 709 "lldb.formatters.cpp.gnu_libstdcpp.StdVectorSynthProvider"))); 710 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 711 RegularExpressionSP( 712 new RegularExpression(llvm::StringRef("^std::map<.+> >(( )?&)?$"))), 713 SyntheticChildrenSP(new ScriptedSyntheticChildren( 714 stl_synth_flags, 715 "lldb.formatters.cpp.gnu_libstdcpp.StdMapSynthProvider"))); 716 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 717 RegularExpressionSP(new RegularExpression( 718 llvm::StringRef("^std::(__cxx11::)?list<.+>(( )?&)?$"))), 719 SyntheticChildrenSP(new ScriptedSyntheticChildren( 720 stl_synth_flags, 721 "lldb.formatters.cpp.gnu_libstdcpp.StdListSynthProvider"))); 722 stl_summary_flags.SetDontShowChildren(false); 723 stl_summary_flags.SetSkipPointers(true); 724 cpp_category_sp->GetRegexTypeSummariesContainer()->Add( 725 RegularExpressionSP( 726 new RegularExpression(llvm::StringRef("^std::vector<.+>(( )?&)?$"))), 727 TypeSummaryImplSP( 728 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}"))); 729 cpp_category_sp->GetRegexTypeSummariesContainer()->Add( 730 RegularExpressionSP( 731 new RegularExpression(llvm::StringRef("^std::map<.+> >(( )?&)?$"))), 732 TypeSummaryImplSP( 733 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}"))); 734 cpp_category_sp->GetRegexTypeSummariesContainer()->Add( 735 RegularExpressionSP(new RegularExpression( 736 llvm::StringRef("^std::(__cxx11::)?list<.+>(( )?&)?$"))), 737 TypeSummaryImplSP( 738 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}"))); 739 740 AddCXXSynthetic( 741 cpp_category_sp, 742 lldb_private::formatters::LibStdcppVectorIteratorSyntheticFrontEndCreator, 743 "std::vector iterator synthetic children", 744 ConstString("^__gnu_cxx::__normal_iterator<.+>$"), stl_synth_flags, true); 745 746 AddCXXSynthetic( 747 cpp_category_sp, 748 lldb_private::formatters::LibstdcppMapIteratorSyntheticFrontEndCreator, 749 "std::map iterator synthetic children", 750 ConstString("^std::_Rb_tree_iterator<.+>$"), stl_synth_flags, true); 751 752 AddCXXSynthetic( 753 cpp_category_sp, 754 lldb_private::formatters::LibStdcppUniquePtrSyntheticFrontEndCreator, 755 "std::unique_ptr synthetic children", 756 ConstString("^std::unique_ptr<.+>(( )?&)?$"), stl_synth_flags, true); 757 AddCXXSynthetic( 758 cpp_category_sp, 759 lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator, 760 "std::shared_ptr synthetic children", 761 ConstString("^std::shared_ptr<.+>(( )?&)?$"), stl_synth_flags, true); 762 AddCXXSynthetic( 763 cpp_category_sp, 764 lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator, 765 "std::weak_ptr synthetic children", 766 ConstString("^std::weak_ptr<.+>(( )?&)?$"), stl_synth_flags, true); 767 AddCXXSynthetic( 768 cpp_category_sp, 769 lldb_private::formatters::LibStdcppTupleSyntheticFrontEndCreator, 770 "std::tuple synthetic children", ConstString("^std::tuple<.+>(( )?&)?$"), 771 stl_synth_flags, true); 772 773 AddCXXSummary(cpp_category_sp, 774 lldb_private::formatters::LibStdcppUniquePointerSummaryProvider, 775 "libstdc++ std::unique_ptr summary provider", 776 ConstString("^std::unique_ptr<.+>(( )?&)?$"), stl_summary_flags, 777 true); 778 AddCXXSummary(cpp_category_sp, 779 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider, 780 "libstdc++ std::shared_ptr summary provider", 781 ConstString("^std::shared_ptr<.+>(( )?&)?$"), stl_summary_flags, 782 true); 783 AddCXXSummary(cpp_category_sp, 784 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider, 785 "libstdc++ std::weak_ptr summary provider", 786 ConstString("^std::weak_ptr<.+>(( )?&)?$"), stl_summary_flags, 787 true); 788 #endif 789 } 790 791 static void LoadSystemFormatters(lldb::TypeCategoryImplSP cpp_category_sp) { 792 if (!cpp_category_sp) 793 return; 794 795 TypeSummaryImpl::Flags string_flags; 796 string_flags.SetCascades(true) 797 .SetSkipPointers(true) 798 .SetSkipReferences(false) 799 .SetDontShowChildren(true) 800 .SetDontShowValue(false) 801 .SetShowMembersOneLiner(false) 802 .SetHideItemNames(false); 803 804 TypeSummaryImpl::Flags string_array_flags; 805 string_array_flags.SetCascades(true) 806 .SetSkipPointers(true) 807 .SetSkipReferences(false) 808 .SetDontShowChildren(true) 809 .SetDontShowValue(true) 810 .SetShowMembersOneLiner(false) 811 .SetHideItemNames(false); 812 813 #ifndef LLDB_DISABLE_PYTHON 814 // FIXME because of a bug in the FormattersContainer we need to add a summary 815 // for both X* and const X* (<rdar://problem/12717717>) 816 AddCXXSummary( 817 cpp_category_sp, lldb_private::formatters::Char16StringSummaryProvider, 818 "char16_t * summary provider", ConstString("char16_t *"), string_flags); 819 AddCXXSummary(cpp_category_sp, 820 lldb_private::formatters::Char16StringSummaryProvider, 821 "char16_t [] summary provider", 822 ConstString("char16_t \\[[0-9]+\\]"), string_array_flags, true); 823 824 AddCXXSummary( 825 cpp_category_sp, lldb_private::formatters::Char32StringSummaryProvider, 826 "char32_t * summary provider", ConstString("char32_t *"), string_flags); 827 AddCXXSummary(cpp_category_sp, 828 lldb_private::formatters::Char32StringSummaryProvider, 829 "char32_t [] summary provider", 830 ConstString("char32_t \\[[0-9]+\\]"), string_array_flags, true); 831 832 AddCXXSummary( 833 cpp_category_sp, lldb_private::formatters::WCharStringSummaryProvider, 834 "wchar_t * summary provider", ConstString("wchar_t *"), string_flags); 835 AddCXXSummary(cpp_category_sp, 836 lldb_private::formatters::WCharStringSummaryProvider, 837 "wchar_t * summary provider", 838 ConstString("wchar_t \\[[0-9]+\\]"), string_array_flags, true); 839 840 AddCXXSummary( 841 cpp_category_sp, lldb_private::formatters::Char16StringSummaryProvider, 842 "unichar * summary provider", ConstString("unichar *"), string_flags); 843 844 TypeSummaryImpl::Flags widechar_flags; 845 widechar_flags.SetDontShowValue(true) 846 .SetSkipPointers(true) 847 .SetSkipReferences(false) 848 .SetCascades(true) 849 .SetDontShowChildren(true) 850 .SetHideItemNames(true) 851 .SetShowMembersOneLiner(false); 852 853 AddCXXSummary( 854 cpp_category_sp, lldb_private::formatters::Char16SummaryProvider, 855 "char16_t summary provider", ConstString("char16_t"), widechar_flags); 856 AddCXXSummary( 857 cpp_category_sp, lldb_private::formatters::Char32SummaryProvider, 858 "char32_t summary provider", ConstString("char32_t"), widechar_flags); 859 AddCXXSummary(cpp_category_sp, lldb_private::formatters::WCharSummaryProvider, 860 "wchar_t summary provider", ConstString("wchar_t"), 861 widechar_flags); 862 863 AddCXXSummary( 864 cpp_category_sp, lldb_private::formatters::Char16SummaryProvider, 865 "unichar summary provider", ConstString("unichar"), widechar_flags); 866 #endif 867 } 868 869 std::unique_ptr<Language::TypeScavenger> CPlusPlusLanguage::GetTypeScavenger() { 870 class CPlusPlusTypeScavenger : public Language::ImageListTypeScavenger { 871 public: 872 virtual CompilerType AdjustForInclusion(CompilerType &candidate) override { 873 LanguageType lang_type(candidate.GetMinimumLanguage()); 874 if (!Language::LanguageIsC(lang_type) && 875 !Language::LanguageIsCPlusPlus(lang_type)) 876 return CompilerType(); 877 if (candidate.IsTypedefType()) 878 return candidate.GetTypedefedType(); 879 return candidate; 880 } 881 }; 882 883 return std::unique_ptr<TypeScavenger>(new CPlusPlusTypeScavenger()); 884 } 885 886 lldb::TypeCategoryImplSP CPlusPlusLanguage::GetFormatters() { 887 static llvm::once_flag g_initialize; 888 static TypeCategoryImplSP g_category; 889 890 llvm::call_once(g_initialize, [this]() -> void { 891 DataVisualization::Categories::GetCategory(GetPluginName(), g_category); 892 if (g_category) { 893 LoadLibCxxFormatters(g_category); 894 LoadLibStdcppFormatters(g_category); 895 LoadSystemFormatters(g_category); 896 } 897 }); 898 return g_category; 899 } 900 901 HardcodedFormatters::HardcodedSummaryFinder 902 CPlusPlusLanguage::GetHardcodedSummaries() { 903 static llvm::once_flag g_initialize; 904 static ConstString g_vectortypes("VectorTypes"); 905 static HardcodedFormatters::HardcodedSummaryFinder g_formatters; 906 907 llvm::call_once(g_initialize, []() -> void { 908 g_formatters.push_back( 909 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType, 910 FormatManager &) -> TypeSummaryImpl::SharedPointer { 911 static CXXFunctionSummaryFormat::SharedPointer formatter_sp( 912 new CXXFunctionSummaryFormat( 913 TypeSummaryImpl::Flags(), 914 lldb_private::formatters::CXXFunctionPointerSummaryProvider, 915 "Function pointer summary provider")); 916 if (valobj.GetCompilerType().IsFunctionPointerType()) { 917 return formatter_sp; 918 } 919 return nullptr; 920 }); 921 g_formatters.push_back( 922 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType, 923 FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer { 924 static CXXFunctionSummaryFormat::SharedPointer formatter_sp( 925 new CXXFunctionSummaryFormat( 926 TypeSummaryImpl::Flags() 927 .SetCascades(true) 928 .SetDontShowChildren(true) 929 .SetHideItemNames(true) 930 .SetShowMembersOneLiner(true) 931 .SetSkipPointers(true) 932 .SetSkipReferences(false), 933 lldb_private::formatters::VectorTypeSummaryProvider, 934 "vector_type pointer summary provider")); 935 if (valobj.GetCompilerType().IsVectorType(nullptr, nullptr)) { 936 if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled()) 937 return formatter_sp; 938 } 939 return nullptr; 940 }); 941 g_formatters.push_back( 942 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType, 943 FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer { 944 static CXXFunctionSummaryFormat::SharedPointer formatter_sp( 945 new CXXFunctionSummaryFormat( 946 TypeSummaryImpl::Flags() 947 .SetCascades(true) 948 .SetDontShowChildren(true) 949 .SetHideItemNames(true) 950 .SetShowMembersOneLiner(true) 951 .SetSkipPointers(true) 952 .SetSkipReferences(false), 953 lldb_private::formatters::BlockPointerSummaryProvider, 954 "block pointer summary provider")); 955 if (valobj.GetCompilerType().IsBlockPointerType(nullptr)) { 956 return formatter_sp; 957 } 958 return nullptr; 959 }); 960 }); 961 962 return g_formatters; 963 } 964 965 HardcodedFormatters::HardcodedSyntheticFinder 966 CPlusPlusLanguage::GetHardcodedSynthetics() { 967 static llvm::once_flag g_initialize; 968 static ConstString g_vectortypes("VectorTypes"); 969 static HardcodedFormatters::HardcodedSyntheticFinder g_formatters; 970 971 llvm::call_once(g_initialize, []() -> void { 972 g_formatters.push_back([](lldb_private::ValueObject &valobj, 973 lldb::DynamicValueType, 974 FormatManager & 975 fmt_mgr) -> SyntheticChildren::SharedPointer { 976 static CXXSyntheticChildren::SharedPointer formatter_sp( 977 new CXXSyntheticChildren( 978 SyntheticChildren::Flags() 979 .SetCascades(true) 980 .SetSkipPointers(true) 981 .SetSkipReferences(true) 982 .SetNonCacheable(true), 983 "vector_type synthetic children", 984 lldb_private::formatters::VectorTypeSyntheticFrontEndCreator)); 985 if (valobj.GetCompilerType().IsVectorType(nullptr, nullptr)) { 986 if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled()) 987 return formatter_sp; 988 } 989 return nullptr; 990 }); 991 g_formatters.push_back([](lldb_private::ValueObject &valobj, 992 lldb::DynamicValueType, 993 FormatManager & 994 fmt_mgr) -> SyntheticChildren::SharedPointer { 995 static CXXSyntheticChildren::SharedPointer formatter_sp( 996 new CXXSyntheticChildren( 997 SyntheticChildren::Flags() 998 .SetCascades(true) 999 .SetSkipPointers(true) 1000 .SetSkipReferences(true) 1001 .SetNonCacheable(true), 1002 "block pointer synthetic children", 1003 lldb_private::formatters::BlockPointerSyntheticFrontEndCreator)); 1004 if (valobj.GetCompilerType().IsBlockPointerType(nullptr)) { 1005 return formatter_sp; 1006 } 1007 return nullptr; 1008 }); 1009 1010 }); 1011 1012 return g_formatters; 1013 } 1014