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]*)$" 124 // We are using a hand written implementation because it is significantly more 125 // efficient then 126 // using the general purpose regular expression library. 127 size_t idx = 0; 128 if (basename.size() > 0 && basename[0] == '~') 129 idx = 1; 130 131 if (basename.size() <= idx) 132 return false; // Empty string or "~" 133 134 if (!std::isalpha(basename[idx]) && basename[idx] != '_') 135 return false; // First charater (after removing the possible '~'') isn't in 136 // [A-Za-z_] 137 138 // Read all characters matching [A-Za-z_0-9] 139 ++idx; 140 while (idx < basename.size()) { 141 if (!std::isalnum(basename[idx]) && basename[idx] != '_') 142 break; 143 ++idx; 144 } 145 146 // We processed all characters. It is a vaild basename. 147 if (idx == basename.size()) 148 return true; 149 150 return false; 151 } 152 153 bool CPlusPlusLanguage::MethodName::TrySimplifiedParse() { 154 // This method tries to parse simple method definitions 155 // which are presumably most comman in user programs. 156 // Definitions that can be parsed by this function don't have return types 157 // and templates in the name. 158 // A::B::C::fun(std::vector<T> &) const 159 size_t arg_start, arg_end; 160 llvm::StringRef full(m_full.GetCString()); 161 llvm::StringRef parens("()", 2); 162 if (ReverseFindMatchingChars(full, parens, arg_start, arg_end)) { 163 m_arguments = full.substr(arg_start, arg_end - arg_start + 1); 164 if (arg_end + 1 < full.size()) 165 m_qualifiers = full.substr(arg_end + 1).ltrim(); 166 167 if (arg_start == 0) 168 return false; 169 size_t basename_end = arg_start; 170 size_t context_start = 0; 171 size_t context_end = full.rfind(':', basename_end); 172 if (context_end == llvm::StringRef::npos) 173 m_basename = full.substr(0, basename_end); 174 else { 175 if (context_start < context_end) 176 m_context = full.substr(context_start, context_end - 1 - context_start); 177 const size_t basename_begin = context_end + 1; 178 m_basename = full.substr(basename_begin, basename_end - basename_begin); 179 } 180 181 if (IsTrivialBasename(m_basename)) { 182 return true; 183 } else { 184 // The C++ basename doesn't match our regular expressions so this can't 185 // be a valid C++ method, clear everything out and indicate an error 186 m_context = llvm::StringRef(); 187 m_basename = llvm::StringRef(); 188 m_arguments = llvm::StringRef(); 189 m_qualifiers = llvm::StringRef(); 190 return false; 191 } 192 } 193 return false; 194 } 195 196 void CPlusPlusLanguage::MethodName::Parse() { 197 if (!m_parsed && m_full) { 198 if (TrySimplifiedParse()) { 199 m_parse_error = false; 200 } else { 201 CPlusPlusNameParser parser(m_full.GetStringRef()); 202 if (auto function = parser.ParseAsFunctionDefinition()) { 203 m_basename = function.getValue().name.basename; 204 m_context = function.getValue().name.context; 205 m_arguments = function.getValue().arguments; 206 m_qualifiers = function.getValue().qualifiers; 207 m_parse_error = false; 208 } else { 209 m_parse_error = true; 210 } 211 } 212 m_parsed = true; 213 } 214 } 215 216 llvm::StringRef CPlusPlusLanguage::MethodName::GetBasename() { 217 if (!m_parsed) 218 Parse(); 219 return m_basename; 220 } 221 222 llvm::StringRef CPlusPlusLanguage::MethodName::GetContext() { 223 if (!m_parsed) 224 Parse(); 225 return m_context; 226 } 227 228 llvm::StringRef CPlusPlusLanguage::MethodName::GetArguments() { 229 if (!m_parsed) 230 Parse(); 231 return m_arguments; 232 } 233 234 llvm::StringRef CPlusPlusLanguage::MethodName::GetQualifiers() { 235 if (!m_parsed) 236 Parse(); 237 return m_qualifiers; 238 } 239 240 std::string CPlusPlusLanguage::MethodName::GetScopeQualifiedName() { 241 if (!m_parsed) 242 Parse(); 243 if (m_context.empty()) 244 return m_basename; 245 246 std::string res; 247 res += m_context; 248 res += "::"; 249 res += m_basename; 250 return res; 251 } 252 253 bool CPlusPlusLanguage::IsCPPMangledName(const char *name) { 254 // FIXME!! we should really run through all the known C++ Language 255 // plugins and ask each one if this is a C++ mangled name 256 257 if (name == nullptr) 258 return false; 259 260 // MSVC style mangling 261 if (name[0] == '?') 262 return true; 263 264 return (name[0] != '\0' && name[0] == '_' && name[1] == 'Z'); 265 } 266 267 bool CPlusPlusLanguage::ExtractContextAndIdentifier( 268 const char *name, llvm::StringRef &context, llvm::StringRef &identifier) { 269 CPlusPlusNameParser parser(name); 270 if (auto full_name = parser.ParseAsFullName()) { 271 identifier = full_name.getValue().basename; 272 context = full_name.getValue().context; 273 return true; 274 } 275 return false; 276 } 277 278 /// Given a mangled function `mangled`, replace all the primitive function type 279 /// arguments of `search` with type `replace`. 280 static ConstString SubsPrimitiveParmItanium(llvm::StringRef mangled, 281 llvm::StringRef search, 282 llvm::StringRef replace) { 283 Log *log = GetLogIfAllCategoriesSet(LIBLLDB_LOG_LANGUAGE); 284 285 const size_t max_len = 286 mangled.size() + mangled.count(search) * replace.size() + 1; 287 288 // Make a temporary buffer to fix up the mangled parameter types and copy the 289 // original there 290 std::string output_buf; 291 output_buf.reserve(max_len); 292 output_buf.insert(0, mangled.str()); 293 ptrdiff_t replaced_offset = 0; 294 295 auto swap_parms_hook = [&](const char *parsee) { 296 if (!parsee || !*parsee) 297 return; 298 299 // Check whether we've found a substitutee 300 llvm::StringRef s(parsee); 301 if (s.startswith(search)) { 302 // account for the case where a replacement is of a different length to 303 // the original 304 replaced_offset += replace.size() - search.size(); 305 306 ptrdiff_t replace_idx = (mangled.size() - s.size()) + replaced_offset; 307 output_buf.erase(replace_idx, search.size()); 308 output_buf.insert(replace_idx, replace.str()); 309 } 310 }; 311 312 // FastDemangle will call our hook for each instance of a primitive type, 313 // allowing us to perform substitution 314 const char *const demangled = 315 FastDemangle(mangled.str().c_str(), mangled.size(), swap_parms_hook); 316 317 if (log) 318 log->Printf("substituted mangling for %s:{%s} %s:{%s}\n", 319 mangled.str().c_str(), demangled, output_buf.c_str(), 320 FastDemangle(output_buf.c_str())); 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 427 AddCXXSynthetic( 428 cpp_category_sp, 429 lldb_private::formatters::LibcxxBitsetSyntheticFrontEndCreator, 430 "libc++ std::bitset synthetic children", 431 ConstString("^std::__(ndk)?1::bitset<.+>(( )?&)?$"), stl_synth_flags, 432 true); 433 AddCXXSynthetic( 434 cpp_category_sp, 435 lldb_private::formatters::LibcxxStdVectorSyntheticFrontEndCreator, 436 "libc++ std::vector synthetic children", 437 ConstString("^std::__(ndk)?1::vector<.+>(( )?&)?$"), stl_synth_flags, 438 true); 439 AddCXXSynthetic( 440 cpp_category_sp, 441 lldb_private::formatters::LibcxxStdForwardListSyntheticFrontEndCreator, 442 "libc++ std::forward_list synthetic children", 443 ConstString("^std::__(ndk)?1::forward_list<.+>(( )?&)?$"), 444 stl_synth_flags, true); 445 AddCXXSynthetic( 446 cpp_category_sp, 447 lldb_private::formatters::LibcxxStdListSyntheticFrontEndCreator, 448 "libc++ std::list synthetic children", 449 ConstString("^std::__(ndk)?1::list<.+>(( )?&)?$"), stl_synth_flags, true); 450 AddCXXSynthetic( 451 cpp_category_sp, 452 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, 453 "libc++ std::map synthetic children", 454 ConstString("^std::__(ndk)?1::map<.+> >(( )?&)?$"), stl_synth_flags, 455 true); 456 AddCXXSynthetic( 457 cpp_category_sp, 458 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, 459 "libc++ std::set synthetic children", 460 ConstString("^std::__(ndk)?1::set<.+> >(( )?&)?$"), stl_synth_flags, 461 true); 462 AddCXXSynthetic( 463 cpp_category_sp, 464 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, 465 "libc++ std::multiset synthetic children", 466 ConstString("^std::__(ndk)?1::multiset<.+> >(( )?&)?$"), stl_synth_flags, 467 true); 468 AddCXXSynthetic( 469 cpp_category_sp, 470 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, 471 "libc++ std::multimap synthetic children", 472 ConstString("^std::__(ndk)?1::multimap<.+> >(( )?&)?$"), stl_synth_flags, 473 true); 474 AddCXXSynthetic( 475 cpp_category_sp, 476 lldb_private::formatters::LibcxxStdUnorderedMapSyntheticFrontEndCreator, 477 "libc++ std::unordered containers synthetic children", 478 ConstString("^(std::__(ndk)?1::)unordered_(multi)?(map|set)<.+> >$"), 479 stl_synth_flags, true); 480 AddCXXSynthetic( 481 cpp_category_sp, 482 lldb_private::formatters::LibcxxInitializerListSyntheticFrontEndCreator, 483 "libc++ std::initializer_list synthetic children", 484 ConstString("^std::initializer_list<.+>(( )?&)?$"), stl_synth_flags, 485 true); 486 AddCXXSynthetic(cpp_category_sp, LibcxxQueueFrontEndCreator, 487 "libc++ std::queue synthetic children", 488 ConstString("^std::__(ndk)?1::queue<.+>(( )?&)?$"), 489 stl_synth_flags, true); 490 AddCXXSynthetic(cpp_category_sp, LibcxxTupleFrontEndCreator, 491 "libc++ std::tuple synthetic children", 492 ConstString("^std::__(ndk)?1::tuple<.*>(( )?&)?$"), stl_synth_flags, 493 true); 494 AddCXXSynthetic( 495 cpp_category_sp, 496 lldb_private::formatters::LibcxxAtomicSyntheticFrontEndCreator, 497 "libc++ std::atomic synthetic children", 498 ConstString("^std::__(ndk)?1::atomic<.+>$"), stl_synth_flags, true); 499 500 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 501 RegularExpressionSP(new RegularExpression( 502 llvm::StringRef("^(std::__(ndk)?1::)deque<.+>(( )?&)?$"))), 503 SyntheticChildrenSP(new ScriptedSyntheticChildren( 504 stl_synth_flags, 505 "lldb.formatters.cpp.libcxx.stddeque_SynthProvider"))); 506 507 AddCXXSynthetic( 508 cpp_category_sp, 509 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator, 510 "shared_ptr synthetic children", 511 ConstString("^(std::__(ndk)?1::)shared_ptr<.+>(( )?&)?$"), 512 stl_synth_flags, true); 513 AddCXXSynthetic( 514 cpp_category_sp, 515 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator, 516 "weak_ptr synthetic children", 517 ConstString("^(std::__(ndk)?1::)weak_ptr<.+>(( )?&)?$"), stl_synth_flags, 518 true); 519 520 stl_summary_flags.SetDontShowChildren(false); 521 stl_summary_flags.SetSkipPointers(false); 522 AddCXXSummary(cpp_category_sp, 523 lldb_private::formatters::LibcxxContainerSummaryProvider, 524 "libc++ std::bitset summary provider", 525 ConstString("^std::__(ndk)?1::bitset<.+>(( )?&)?$"), 526 stl_summary_flags, true); 527 AddCXXSummary(cpp_category_sp, 528 lldb_private::formatters::LibcxxContainerSummaryProvider, 529 "libc++ std::vector summary provider", 530 ConstString("^std::__(ndk)?1::vector<.+>(( )?&)?$"), 531 stl_summary_flags, true); 532 AddCXXSummary(cpp_category_sp, 533 lldb_private::formatters::LibcxxContainerSummaryProvider, 534 "libc++ std::list summary provider", 535 ConstString("^std::__(ndk)?1::forward_list<.+>(( )?&)?$"), 536 stl_summary_flags, true); 537 AddCXXSummary(cpp_category_sp, 538 lldb_private::formatters::LibcxxContainerSummaryProvider, 539 "libc++ std::list summary provider", 540 ConstString("^std::__(ndk)?1::list<.+>(( )?&)?$"), 541 stl_summary_flags, true); 542 AddCXXSummary(cpp_category_sp, 543 lldb_private::formatters::LibcxxContainerSummaryProvider, 544 "libc++ std::map summary provider", 545 ConstString("^std::__(ndk)?1::map<.+>(( )?&)?$"), 546 stl_summary_flags, true); 547 AddCXXSummary(cpp_category_sp, 548 lldb_private::formatters::LibcxxContainerSummaryProvider, 549 "libc++ std::deque summary provider", 550 ConstString("^std::__(ndk)?1::deque<.+>(( )?&)?$"), 551 stl_summary_flags, true); 552 AddCXXSummary(cpp_category_sp, 553 lldb_private::formatters::LibcxxContainerSummaryProvider, 554 "libc++ std::queue summary provider", 555 ConstString("^std::__(ndk)?1::queue<.+>(( )?&)?$"), 556 stl_summary_flags, true); 557 AddCXXSummary(cpp_category_sp, 558 lldb_private::formatters::LibcxxContainerSummaryProvider, 559 "libc++ std::set summary provider", 560 ConstString("^std::__(ndk)?1::set<.+>(( )?&)?$"), 561 stl_summary_flags, true); 562 AddCXXSummary(cpp_category_sp, 563 lldb_private::formatters::LibcxxContainerSummaryProvider, 564 "libc++ std::multiset summary provider", 565 ConstString("^std::__(ndk)?1::multiset<.+>(( )?&)?$"), 566 stl_summary_flags, true); 567 AddCXXSummary(cpp_category_sp, 568 lldb_private::formatters::LibcxxContainerSummaryProvider, 569 "libc++ std::multimap summary provider", 570 ConstString("^std::__(ndk)?1::multimap<.+>(( )?&)?$"), 571 stl_summary_flags, true); 572 AddCXXSummary( 573 cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider, 574 "libc++ std::unordered containers summary provider", 575 ConstString("^(std::__(ndk)?1::)unordered_(multi)?(map|set)<.+> >$"), 576 stl_summary_flags, true); 577 AddCXXSummary(cpp_category_sp, LibcxxContainerSummaryProvider, 578 "libc++ std::tuple summary provider", 579 ConstString("^std::__(ndk)?1::tuple<.*>(( )?&)?$"), stl_summary_flags, 580 true); 581 AddCXXSummary( 582 cpp_category_sp, lldb_private::formatters::LibCxxAtomicSummaryProvider, 583 "libc++ std::atomic summary provider", 584 ConstString("^std::__(ndk)?1::atomic<.+>$"), stl_summary_flags, true); 585 586 stl_summary_flags.SetSkipPointers(true); 587 588 AddCXXSummary(cpp_category_sp, 589 lldb_private::formatters::LibcxxSmartPointerSummaryProvider, 590 "libc++ std::shared_ptr summary provider", 591 ConstString("^std::__(ndk)?1::shared_ptr<.+>(( )?&)?$"), 592 stl_summary_flags, true); 593 AddCXXSummary(cpp_category_sp, 594 lldb_private::formatters::LibcxxSmartPointerSummaryProvider, 595 "libc++ std::weak_ptr summary provider", 596 ConstString("^std::__(ndk)?1::weak_ptr<.+>(( )?&)?$"), 597 stl_summary_flags, true); 598 599 AddCXXSynthetic( 600 cpp_category_sp, 601 lldb_private::formatters::LibCxxVectorIteratorSyntheticFrontEndCreator, 602 "std::vector iterator synthetic children", 603 ConstString("^std::__(ndk)?1::__wrap_iter<.+>$"), stl_synth_flags, true); 604 605 AddCXXSynthetic( 606 cpp_category_sp, 607 lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEndCreator, 608 "std::map iterator synthetic children", 609 ConstString("^std::__(ndk)?1::__map_iterator<.+>$"), stl_synth_flags, 610 true); 611 612 AddCXXSynthetic( 613 cpp_category_sp, lldb_private::formatters::LibcxxFunctionFrontEndCreator, 614 "std::function synthetic value provider", 615 ConstString("^std::__(ndk)?1::function<.+>$"), stl_synth_flags, true); 616 #endif 617 } 618 619 static void LoadLibStdcppFormatters(lldb::TypeCategoryImplSP cpp_category_sp) { 620 if (!cpp_category_sp) 621 return; 622 623 TypeSummaryImpl::Flags stl_summary_flags; 624 stl_summary_flags.SetCascades(true) 625 .SetSkipPointers(false) 626 .SetSkipReferences(false) 627 .SetDontShowChildren(true) 628 .SetDontShowValue(true) 629 .SetShowMembersOneLiner(false) 630 .SetHideItemNames(false); 631 632 lldb::TypeSummaryImplSP std_string_summary_sp( 633 new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p}")); 634 635 lldb::TypeSummaryImplSP cxx11_string_summary_sp(new CXXFunctionSummaryFormat( 636 stl_summary_flags, LibStdcppStringSummaryProvider, 637 "libstdc++ c++11 std::string summary provider")); 638 lldb::TypeSummaryImplSP cxx11_wstring_summary_sp(new CXXFunctionSummaryFormat( 639 stl_summary_flags, LibStdcppWStringSummaryProvider, 640 "libstdc++ c++11 std::wstring summary provider")); 641 642 cpp_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::string"), 643 std_string_summary_sp); 644 cpp_category_sp->GetTypeSummariesContainer()->Add( 645 ConstString("std::basic_string<char>"), std_string_summary_sp); 646 cpp_category_sp->GetTypeSummariesContainer()->Add( 647 ConstString("std::basic_string<char,std::char_traits<char>,std::" 648 "allocator<char> >"), 649 std_string_summary_sp); 650 cpp_category_sp->GetTypeSummariesContainer()->Add( 651 ConstString("std::basic_string<char, std::char_traits<char>, " 652 "std::allocator<char> >"), 653 std_string_summary_sp); 654 655 cpp_category_sp->GetTypeSummariesContainer()->Add( 656 ConstString("std::__cxx11::string"), cxx11_string_summary_sp); 657 cpp_category_sp->GetTypeSummariesContainer()->Add( 658 ConstString("std::__cxx11::basic_string<char, std::char_traits<char>, " 659 "std::allocator<char> >"), 660 cxx11_string_summary_sp); 661 662 // making sure we force-pick the summary for printing wstring (_M_p is a 663 // wchar_t*) 664 lldb::TypeSummaryImplSP std_wstring_summary_sp( 665 new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p%S}")); 666 667 cpp_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::wstring"), 668 std_wstring_summary_sp); 669 cpp_category_sp->GetTypeSummariesContainer()->Add( 670 ConstString("std::basic_string<wchar_t>"), std_wstring_summary_sp); 671 cpp_category_sp->GetTypeSummariesContainer()->Add( 672 ConstString("std::basic_string<wchar_t,std::char_traits<wchar_t>,std::" 673 "allocator<wchar_t> >"), 674 std_wstring_summary_sp); 675 cpp_category_sp->GetTypeSummariesContainer()->Add( 676 ConstString("std::basic_string<wchar_t, std::char_traits<wchar_t>, " 677 "std::allocator<wchar_t> >"), 678 std_wstring_summary_sp); 679 680 cpp_category_sp->GetTypeSummariesContainer()->Add( 681 ConstString("std::__cxx11::wstring"), cxx11_wstring_summary_sp); 682 cpp_category_sp->GetTypeSummariesContainer()->Add( 683 ConstString("std::__cxx11::basic_string<wchar_t, " 684 "std::char_traits<wchar_t>, std::allocator<wchar_t> >"), 685 cxx11_wstring_summary_sp); 686 687 #ifndef LLDB_DISABLE_PYTHON 688 689 SyntheticChildren::Flags stl_synth_flags; 690 stl_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences( 691 false); 692 693 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 694 RegularExpressionSP( 695 new RegularExpression(llvm::StringRef("^std::vector<.+>(( )?&)?$"))), 696 SyntheticChildrenSP(new ScriptedSyntheticChildren( 697 stl_synth_flags, 698 "lldb.formatters.cpp.gnu_libstdcpp.StdVectorSynthProvider"))); 699 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 700 RegularExpressionSP( 701 new RegularExpression(llvm::StringRef("^std::map<.+> >(( )?&)?$"))), 702 SyntheticChildrenSP(new ScriptedSyntheticChildren( 703 stl_synth_flags, 704 "lldb.formatters.cpp.gnu_libstdcpp.StdMapSynthProvider"))); 705 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 706 RegularExpressionSP(new RegularExpression( 707 llvm::StringRef("^std::(__cxx11::)?list<.+>(( )?&)?$"))), 708 SyntheticChildrenSP(new ScriptedSyntheticChildren( 709 stl_synth_flags, 710 "lldb.formatters.cpp.gnu_libstdcpp.StdListSynthProvider"))); 711 stl_summary_flags.SetDontShowChildren(false); 712 stl_summary_flags.SetSkipPointers(true); 713 cpp_category_sp->GetRegexTypeSummariesContainer()->Add( 714 RegularExpressionSP( 715 new RegularExpression(llvm::StringRef("^std::vector<.+>(( )?&)?$"))), 716 TypeSummaryImplSP( 717 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}"))); 718 cpp_category_sp->GetRegexTypeSummariesContainer()->Add( 719 RegularExpressionSP( 720 new RegularExpression(llvm::StringRef("^std::map<.+> >(( )?&)?$"))), 721 TypeSummaryImplSP( 722 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}"))); 723 cpp_category_sp->GetRegexTypeSummariesContainer()->Add( 724 RegularExpressionSP(new RegularExpression( 725 llvm::StringRef("^std::(__cxx11::)?list<.+>(( )?&)?$"))), 726 TypeSummaryImplSP( 727 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}"))); 728 729 AddCXXSynthetic( 730 cpp_category_sp, 731 lldb_private::formatters::LibStdcppVectorIteratorSyntheticFrontEndCreator, 732 "std::vector iterator synthetic children", 733 ConstString("^__gnu_cxx::__normal_iterator<.+>$"), stl_synth_flags, true); 734 735 AddCXXSynthetic( 736 cpp_category_sp, 737 lldb_private::formatters::LibstdcppMapIteratorSyntheticFrontEndCreator, 738 "std::map iterator synthetic children", 739 ConstString("^std::_Rb_tree_iterator<.+>$"), stl_synth_flags, true); 740 741 AddCXXSynthetic( 742 cpp_category_sp, 743 lldb_private::formatters::LibStdcppUniquePtrSyntheticFrontEndCreator, 744 "std::unique_ptr synthetic children", 745 ConstString("^std::unique_ptr<.+>(( )?&)?$"), stl_synth_flags, true); 746 AddCXXSynthetic( 747 cpp_category_sp, 748 lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator, 749 "std::shared_ptr synthetic children", 750 ConstString("^std::shared_ptr<.+>(( )?&)?$"), stl_synth_flags, true); 751 AddCXXSynthetic( 752 cpp_category_sp, 753 lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator, 754 "std::weak_ptr synthetic children", 755 ConstString("^std::weak_ptr<.+>(( )?&)?$"), stl_synth_flags, true); 756 AddCXXSynthetic( 757 cpp_category_sp, 758 lldb_private::formatters::LibStdcppTupleSyntheticFrontEndCreator, 759 "std::tuple synthetic children", ConstString("^std::tuple<.+>(( )?&)?$"), 760 stl_synth_flags, true); 761 762 AddCXXSummary(cpp_category_sp, 763 lldb_private::formatters::LibStdcppUniquePointerSummaryProvider, 764 "libstdc++ std::unique_ptr summary provider", 765 ConstString("^std::unique_ptr<.+>(( )?&)?$"), stl_summary_flags, 766 true); 767 AddCXXSummary(cpp_category_sp, 768 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider, 769 "libstdc++ std::shared_ptr summary provider", 770 ConstString("^std::shared_ptr<.+>(( )?&)?$"), stl_summary_flags, 771 true); 772 AddCXXSummary(cpp_category_sp, 773 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider, 774 "libstdc++ std::weak_ptr summary provider", 775 ConstString("^std::weak_ptr<.+>(( )?&)?$"), stl_summary_flags, 776 true); 777 #endif 778 } 779 780 static void LoadSystemFormatters(lldb::TypeCategoryImplSP cpp_category_sp) { 781 if (!cpp_category_sp) 782 return; 783 784 TypeSummaryImpl::Flags string_flags; 785 string_flags.SetCascades(true) 786 .SetSkipPointers(true) 787 .SetSkipReferences(false) 788 .SetDontShowChildren(true) 789 .SetDontShowValue(false) 790 .SetShowMembersOneLiner(false) 791 .SetHideItemNames(false); 792 793 TypeSummaryImpl::Flags string_array_flags; 794 string_array_flags.SetCascades(true) 795 .SetSkipPointers(true) 796 .SetSkipReferences(false) 797 .SetDontShowChildren(true) 798 .SetDontShowValue(true) 799 .SetShowMembersOneLiner(false) 800 .SetHideItemNames(false); 801 802 #ifndef LLDB_DISABLE_PYTHON 803 // FIXME because of a bug in the FormattersContainer we need to add a summary 804 // for both X* and const X* (<rdar://problem/12717717>) 805 AddCXXSummary( 806 cpp_category_sp, lldb_private::formatters::Char16StringSummaryProvider, 807 "char16_t * summary provider", ConstString("char16_t *"), string_flags); 808 AddCXXSummary(cpp_category_sp, 809 lldb_private::formatters::Char16StringSummaryProvider, 810 "char16_t [] summary provider", 811 ConstString("char16_t \\[[0-9]+\\]"), string_array_flags, true); 812 813 AddCXXSummary( 814 cpp_category_sp, lldb_private::formatters::Char32StringSummaryProvider, 815 "char32_t * summary provider", ConstString("char32_t *"), string_flags); 816 AddCXXSummary(cpp_category_sp, 817 lldb_private::formatters::Char32StringSummaryProvider, 818 "char32_t [] summary provider", 819 ConstString("char32_t \\[[0-9]+\\]"), string_array_flags, true); 820 821 AddCXXSummary( 822 cpp_category_sp, lldb_private::formatters::WCharStringSummaryProvider, 823 "wchar_t * summary provider", ConstString("wchar_t *"), string_flags); 824 AddCXXSummary(cpp_category_sp, 825 lldb_private::formatters::WCharStringSummaryProvider, 826 "wchar_t * summary provider", 827 ConstString("wchar_t \\[[0-9]+\\]"), string_array_flags, true); 828 829 AddCXXSummary( 830 cpp_category_sp, lldb_private::formatters::Char16StringSummaryProvider, 831 "unichar * summary provider", ConstString("unichar *"), string_flags); 832 833 TypeSummaryImpl::Flags widechar_flags; 834 widechar_flags.SetDontShowValue(true) 835 .SetSkipPointers(true) 836 .SetSkipReferences(false) 837 .SetCascades(true) 838 .SetDontShowChildren(true) 839 .SetHideItemNames(true) 840 .SetShowMembersOneLiner(false); 841 842 AddCXXSummary( 843 cpp_category_sp, lldb_private::formatters::Char16SummaryProvider, 844 "char16_t summary provider", ConstString("char16_t"), widechar_flags); 845 AddCXXSummary( 846 cpp_category_sp, lldb_private::formatters::Char32SummaryProvider, 847 "char32_t summary provider", ConstString("char32_t"), widechar_flags); 848 AddCXXSummary(cpp_category_sp, lldb_private::formatters::WCharSummaryProvider, 849 "wchar_t summary provider", ConstString("wchar_t"), 850 widechar_flags); 851 852 AddCXXSummary( 853 cpp_category_sp, lldb_private::formatters::Char16SummaryProvider, 854 "unichar summary provider", ConstString("unichar"), widechar_flags); 855 #endif 856 } 857 858 std::unique_ptr<Language::TypeScavenger> CPlusPlusLanguage::GetTypeScavenger() { 859 class CPlusPlusTypeScavenger : public Language::ImageListTypeScavenger { 860 public: 861 virtual CompilerType AdjustForInclusion(CompilerType &candidate) override { 862 LanguageType lang_type(candidate.GetMinimumLanguage()); 863 if (!Language::LanguageIsC(lang_type) && 864 !Language::LanguageIsCPlusPlus(lang_type)) 865 return CompilerType(); 866 if (candidate.IsTypedefType()) 867 return candidate.GetTypedefedType(); 868 return candidate; 869 } 870 }; 871 872 return std::unique_ptr<TypeScavenger>(new CPlusPlusTypeScavenger()); 873 } 874 875 lldb::TypeCategoryImplSP CPlusPlusLanguage::GetFormatters() { 876 static llvm::once_flag g_initialize; 877 static TypeCategoryImplSP g_category; 878 879 llvm::call_once(g_initialize, [this]() -> void { 880 DataVisualization::Categories::GetCategory(GetPluginName(), g_category); 881 if (g_category) { 882 LoadLibCxxFormatters(g_category); 883 LoadLibStdcppFormatters(g_category); 884 LoadSystemFormatters(g_category); 885 } 886 }); 887 return g_category; 888 } 889 890 HardcodedFormatters::HardcodedSummaryFinder 891 CPlusPlusLanguage::GetHardcodedSummaries() { 892 static llvm::once_flag g_initialize; 893 static ConstString g_vectortypes("VectorTypes"); 894 static HardcodedFormatters::HardcodedSummaryFinder g_formatters; 895 896 llvm::call_once(g_initialize, []() -> void { 897 g_formatters.push_back( 898 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType, 899 FormatManager &) -> TypeSummaryImpl::SharedPointer { 900 static CXXFunctionSummaryFormat::SharedPointer formatter_sp( 901 new CXXFunctionSummaryFormat( 902 TypeSummaryImpl::Flags(), 903 lldb_private::formatters::CXXFunctionPointerSummaryProvider, 904 "Function pointer summary provider")); 905 if (valobj.GetCompilerType().IsFunctionPointerType()) { 906 return formatter_sp; 907 } 908 return nullptr; 909 }); 910 g_formatters.push_back( 911 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType, 912 FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer { 913 static CXXFunctionSummaryFormat::SharedPointer formatter_sp( 914 new CXXFunctionSummaryFormat( 915 TypeSummaryImpl::Flags() 916 .SetCascades(true) 917 .SetDontShowChildren(true) 918 .SetHideItemNames(true) 919 .SetShowMembersOneLiner(true) 920 .SetSkipPointers(true) 921 .SetSkipReferences(false), 922 lldb_private::formatters::VectorTypeSummaryProvider, 923 "vector_type pointer summary provider")); 924 if (valobj.GetCompilerType().IsVectorType(nullptr, nullptr)) { 925 if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled()) 926 return formatter_sp; 927 } 928 return nullptr; 929 }); 930 g_formatters.push_back( 931 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType, 932 FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer { 933 static CXXFunctionSummaryFormat::SharedPointer formatter_sp( 934 new CXXFunctionSummaryFormat( 935 TypeSummaryImpl::Flags() 936 .SetCascades(true) 937 .SetDontShowChildren(true) 938 .SetHideItemNames(true) 939 .SetShowMembersOneLiner(true) 940 .SetSkipPointers(true) 941 .SetSkipReferences(false), 942 lldb_private::formatters::BlockPointerSummaryProvider, 943 "block pointer summary provider")); 944 if (valobj.GetCompilerType().IsBlockPointerType(nullptr)) { 945 return formatter_sp; 946 } 947 return nullptr; 948 }); 949 }); 950 951 return g_formatters; 952 } 953 954 HardcodedFormatters::HardcodedSyntheticFinder 955 CPlusPlusLanguage::GetHardcodedSynthetics() { 956 static llvm::once_flag g_initialize; 957 static ConstString g_vectortypes("VectorTypes"); 958 static HardcodedFormatters::HardcodedSyntheticFinder g_formatters; 959 960 llvm::call_once(g_initialize, []() -> void { 961 g_formatters.push_back([](lldb_private::ValueObject &valobj, 962 lldb::DynamicValueType, 963 FormatManager & 964 fmt_mgr) -> SyntheticChildren::SharedPointer { 965 static CXXSyntheticChildren::SharedPointer formatter_sp( 966 new CXXSyntheticChildren( 967 SyntheticChildren::Flags() 968 .SetCascades(true) 969 .SetSkipPointers(true) 970 .SetSkipReferences(true) 971 .SetNonCacheable(true), 972 "vector_type synthetic children", 973 lldb_private::formatters::VectorTypeSyntheticFrontEndCreator)); 974 if (valobj.GetCompilerType().IsVectorType(nullptr, nullptr)) { 975 if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled()) 976 return formatter_sp; 977 } 978 return nullptr; 979 }); 980 g_formatters.push_back([](lldb_private::ValueObject &valobj, 981 lldb::DynamicValueType, 982 FormatManager & 983 fmt_mgr) -> SyntheticChildren::SharedPointer { 984 static CXXSyntheticChildren::SharedPointer formatter_sp( 985 new CXXSyntheticChildren( 986 SyntheticChildren::Flags() 987 .SetCascades(true) 988 .SetSkipPointers(true) 989 .SetSkipReferences(true) 990 .SetNonCacheable(true), 991 "block pointer synthetic children", 992 lldb_private::formatters::BlockPointerSyntheticFrontEndCreator)); 993 if (valobj.GetCompilerType().IsBlockPointerType(nullptr)) { 994 return formatter_sp; 995 } 996 return nullptr; 997 }); 998 999 }); 1000 1001 return g_formatters; 1002 } 1003