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 plugins and 255 // ask each one if 256 // this is a C++ mangled name, but we can put that off till there is actually 257 // more than one 258 // we care about. 259 260 return (name != nullptr && name[0] == '_' && name[1] == 'Z'); 261 } 262 263 bool CPlusPlusLanguage::ExtractContextAndIdentifier( 264 const char *name, llvm::StringRef &context, llvm::StringRef &identifier) { 265 CPlusPlusNameParser parser(name); 266 if (auto full_name = parser.ParseAsFullName()) { 267 identifier = full_name.getValue().basename; 268 context = full_name.getValue().context; 269 return true; 270 } 271 return false; 272 } 273 274 /// Given a mangled function `mangled`, replace all the primitive function type 275 /// arguments of `search` with type `replace`. 276 static ConstString SubsPrimitiveParmItanium(llvm::StringRef mangled, 277 llvm::StringRef search, 278 llvm::StringRef replace) { 279 Log *log = GetLogIfAllCategoriesSet(LIBLLDB_LOG_LANGUAGE); 280 281 const size_t max_len = 282 mangled.size() + mangled.count(search) * replace.size() + 1; 283 284 // Make a temporary buffer to fix up the mangled parameter types and copy the 285 // original there 286 std::string output_buf; 287 output_buf.reserve(max_len); 288 output_buf.insert(0, mangled.str()); 289 ptrdiff_t replaced_offset = 0; 290 291 auto swap_parms_hook = [&](const char *parsee) { 292 if (!parsee || !*parsee) 293 return; 294 295 // Check whether we've found a substitutee 296 llvm::StringRef s(parsee); 297 if (s.startswith(search)) { 298 // account for the case where a replacement is of a different length to 299 // the original 300 replaced_offset += replace.size() - search.size(); 301 302 ptrdiff_t replace_idx = (mangled.size() - s.size()) + replaced_offset; 303 output_buf.erase(replace_idx, search.size()); 304 output_buf.insert(replace_idx, replace.str()); 305 } 306 }; 307 308 // FastDemangle will call our hook for each instance of a primitive type, 309 // allowing us to perform substitution 310 const char *const demangled = 311 FastDemangle(mangled.str().c_str(), mangled.size(), swap_parms_hook); 312 313 if (log) 314 log->Printf("substituted mangling for %s:{%s} %s:{%s}\n", 315 mangled.str().c_str(), demangled, output_buf.c_str(), 316 FastDemangle(output_buf.c_str())); 317 318 return output_buf == mangled ? ConstString() : ConstString(output_buf); 319 } 320 321 uint32_t CPlusPlusLanguage::FindAlternateFunctionManglings( 322 const ConstString mangled_name, std::set<ConstString> &alternates) { 323 const auto start_size = alternates.size(); 324 /// Get a basic set of alternative manglings for the given symbol `name`, by 325 /// making a few basic possible substitutions on basic types, storage duration 326 /// and `const`ness for the given symbol. The output parameter `alternates` 327 /// is filled with a best-guess, non-exhaustive set of different manglings 328 /// for the given name. 329 330 // Maybe we're looking for a const symbol but the debug info told us it was 331 // non-const... 332 if (!strncmp(mangled_name.GetCString(), "_ZN", 3) && 333 strncmp(mangled_name.GetCString(), "_ZNK", 4)) { 334 std::string fixed_scratch("_ZNK"); 335 fixed_scratch.append(mangled_name.GetCString() + 3); 336 alternates.insert(ConstString(fixed_scratch)); 337 } 338 339 // Maybe we're looking for a static symbol but we thought it was global... 340 if (!strncmp(mangled_name.GetCString(), "_Z", 2) && 341 strncmp(mangled_name.GetCString(), "_ZL", 3)) { 342 std::string fixed_scratch("_ZL"); 343 fixed_scratch.append(mangled_name.GetCString() + 2); 344 alternates.insert(ConstString(fixed_scratch)); 345 } 346 347 // `char` is implementation defined as either `signed` or `unsigned`. As a 348 // result a char parameter has 3 possible manglings: 'c'-char, 'a'-signed 349 // char, 'h'-unsigned char. If we're looking for symbols with a signed char 350 // parameter, try finding matches which have the general case 'c'. 351 if (ConstString char_fixup = 352 SubsPrimitiveParmItanium(mangled_name.GetStringRef(), "a", "c")) 353 alternates.insert(char_fixup); 354 355 // long long parameter mangling 'x', may actually just be a long 'l' argument 356 if (ConstString long_fixup = 357 SubsPrimitiveParmItanium(mangled_name.GetStringRef(), "x", "l")) 358 alternates.insert(long_fixup); 359 360 // unsigned long long parameter mangling 'y', may actually just be unsigned 361 // long 'm' argument 362 if (ConstString ulong_fixup = 363 SubsPrimitiveParmItanium(mangled_name.GetStringRef(), "y", "m")) 364 alternates.insert(ulong_fixup); 365 366 return alternates.size() - start_size; 367 } 368 369 static void LoadLibCxxFormatters(lldb::TypeCategoryImplSP cpp_category_sp) { 370 if (!cpp_category_sp) 371 return; 372 373 TypeSummaryImpl::Flags stl_summary_flags; 374 stl_summary_flags.SetCascades(true) 375 .SetSkipPointers(false) 376 .SetSkipReferences(false) 377 .SetDontShowChildren(true) 378 .SetDontShowValue(true) 379 .SetShowMembersOneLiner(false) 380 .SetHideItemNames(false); 381 382 #ifndef LLDB_DISABLE_PYTHON 383 lldb::TypeSummaryImplSP std_string_summary_sp(new CXXFunctionSummaryFormat( 384 stl_summary_flags, lldb_private::formatters::LibcxxStringSummaryProvider, 385 "std::string summary provider")); 386 lldb::TypeSummaryImplSP std_wstring_summary_sp(new CXXFunctionSummaryFormat( 387 stl_summary_flags, lldb_private::formatters::LibcxxWStringSummaryProvider, 388 "std::wstring summary provider")); 389 390 cpp_category_sp->GetTypeSummariesContainer()->Add( 391 ConstString("std::__1::string"), std_string_summary_sp); 392 cpp_category_sp->GetTypeSummariesContainer()->Add( 393 ConstString("std::__ndk1::string"), std_string_summary_sp); 394 cpp_category_sp->GetTypeSummariesContainer()->Add( 395 ConstString("std::__1::basic_string<char, std::__1::char_traits<char>, " 396 "std::__1::allocator<char> >"), 397 std_string_summary_sp); 398 cpp_category_sp->GetTypeSummariesContainer()->Add( 399 ConstString("std::__ndk1::basic_string<char, " 400 "std::__ndk1::char_traits<char>, " 401 "std::__ndk1::allocator<char> >"), 402 std_string_summary_sp); 403 404 cpp_category_sp->GetTypeSummariesContainer()->Add( 405 ConstString("std::__1::wstring"), std_wstring_summary_sp); 406 cpp_category_sp->GetTypeSummariesContainer()->Add( 407 ConstString("std::__ndk1::wstring"), std_wstring_summary_sp); 408 cpp_category_sp->GetTypeSummariesContainer()->Add( 409 ConstString("std::__1::basic_string<wchar_t, " 410 "std::__1::char_traits<wchar_t>, " 411 "std::__1::allocator<wchar_t> >"), 412 std_wstring_summary_sp); 413 cpp_category_sp->GetTypeSummariesContainer()->Add( 414 ConstString("std::__ndk1::basic_string<wchar_t, " 415 "std::__ndk1::char_traits<wchar_t>, " 416 "std::__ndk1::allocator<wchar_t> >"), 417 std_wstring_summary_sp); 418 419 SyntheticChildren::Flags stl_synth_flags; 420 stl_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences( 421 false); 422 423 AddCXXSynthetic( 424 cpp_category_sp, 425 lldb_private::formatters::LibcxxStdVectorSyntheticFrontEndCreator, 426 "libc++ std::vector synthetic children", 427 ConstString("^std::__(ndk)?1::vector<.+>(( )?&)?$"), stl_synth_flags, 428 true); 429 AddCXXSynthetic( 430 cpp_category_sp, 431 lldb_private::formatters::LibcxxStdForwardListSyntheticFrontEndCreator, 432 "libc++ std::forward_list synthetic children", 433 ConstString("^std::__(ndk)?1::forward_list<.+>(( )?&)?$"), 434 stl_synth_flags, true); 435 AddCXXSynthetic( 436 cpp_category_sp, 437 lldb_private::formatters::LibcxxStdListSyntheticFrontEndCreator, 438 "libc++ std::list synthetic children", 439 ConstString("^std::__(ndk)?1::list<.+>(( )?&)?$"), stl_synth_flags, true); 440 AddCXXSynthetic( 441 cpp_category_sp, 442 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, 443 "libc++ std::map synthetic children", 444 ConstString("^std::__(ndk)?1::map<.+> >(( )?&)?$"), stl_synth_flags, 445 true); 446 AddCXXSynthetic( 447 cpp_category_sp, 448 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, 449 "libc++ std::set synthetic children", 450 ConstString("^std::__(ndk)?1::set<.+> >(( )?&)?$"), stl_synth_flags, 451 true); 452 AddCXXSynthetic( 453 cpp_category_sp, 454 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, 455 "libc++ std::multiset synthetic children", 456 ConstString("^std::__(ndk)?1::multiset<.+> >(( )?&)?$"), stl_synth_flags, 457 true); 458 AddCXXSynthetic( 459 cpp_category_sp, 460 lldb_private::formatters::LibcxxStdMapSyntheticFrontEndCreator, 461 "libc++ std::multimap synthetic children", 462 ConstString("^std::__(ndk)?1::multimap<.+> >(( )?&)?$"), stl_synth_flags, 463 true); 464 AddCXXSynthetic( 465 cpp_category_sp, 466 lldb_private::formatters::LibcxxStdUnorderedMapSyntheticFrontEndCreator, 467 "libc++ std::unordered containers synthetic children", 468 ConstString("^(std::__(ndk)?1::)unordered_(multi)?(map|set)<.+> >$"), 469 stl_synth_flags, true); 470 AddCXXSynthetic( 471 cpp_category_sp, 472 lldb_private::formatters::LibcxxInitializerListSyntheticFrontEndCreator, 473 "libc++ std::initializer_list synthetic children", 474 ConstString("^std::initializer_list<.+>(( )?&)?$"), stl_synth_flags, 475 true); 476 AddCXXSynthetic(cpp_category_sp, LibcxxQueueFrontEndCreator, 477 "libc++ std::queue synthetic children", 478 ConstString("^std::__(ndk)?1::queue<.+>(( )?&)?$"), 479 stl_synth_flags, true); 480 AddCXXSynthetic(cpp_category_sp, LibcxxTupleFrontEndCreator, 481 "libc++ std::tuple synthetic children", 482 ConstString("^std::__(ndk)?1::tuple<.*>(( )?&)?$"), stl_synth_flags, 483 true); 484 AddCXXSynthetic( 485 cpp_category_sp, 486 lldb_private::formatters::LibcxxAtomicSyntheticFrontEndCreator, 487 "libc++ std::atomic synthetic children", 488 ConstString("^std::__(ndk)?1::atomic<.+>$"), stl_synth_flags, true); 489 490 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 491 RegularExpressionSP(new RegularExpression( 492 llvm::StringRef("^(std::__(ndk)?1::)deque<.+>(( )?&)?$"))), 493 SyntheticChildrenSP(new ScriptedSyntheticChildren( 494 stl_synth_flags, 495 "lldb.formatters.cpp.libcxx.stddeque_SynthProvider"))); 496 497 AddCXXSynthetic( 498 cpp_category_sp, 499 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator, 500 "shared_ptr synthetic children", 501 ConstString("^(std::__(ndk)?1::)shared_ptr<.+>(( )?&)?$"), 502 stl_synth_flags, true); 503 AddCXXSynthetic( 504 cpp_category_sp, 505 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator, 506 "weak_ptr synthetic children", 507 ConstString("^(std::__(ndk)?1::)weak_ptr<.+>(( )?&)?$"), stl_synth_flags, 508 true); 509 510 stl_summary_flags.SetDontShowChildren(false); 511 stl_summary_flags.SetSkipPointers(false); 512 AddCXXSummary(cpp_category_sp, 513 lldb_private::formatters::LibcxxContainerSummaryProvider, 514 "libc++ std::vector summary provider", 515 ConstString("^std::__(ndk)?1::vector<.+>(( )?&)?$"), 516 stl_summary_flags, true); 517 AddCXXSummary(cpp_category_sp, 518 lldb_private::formatters::LibcxxContainerSummaryProvider, 519 "libc++ std::list summary provider", 520 ConstString("^std::__(ndk)?1::forward_list<.+>(( )?&)?$"), 521 stl_summary_flags, true); 522 AddCXXSummary(cpp_category_sp, 523 lldb_private::formatters::LibcxxContainerSummaryProvider, 524 "libc++ std::list summary provider", 525 ConstString("^std::__(ndk)?1::list<.+>(( )?&)?$"), 526 stl_summary_flags, true); 527 AddCXXSummary(cpp_category_sp, 528 lldb_private::formatters::LibcxxContainerSummaryProvider, 529 "libc++ std::map summary provider", 530 ConstString("^std::__(ndk)?1::map<.+>(( )?&)?$"), 531 stl_summary_flags, true); 532 AddCXXSummary(cpp_category_sp, 533 lldb_private::formatters::LibcxxContainerSummaryProvider, 534 "libc++ std::deque summary provider", 535 ConstString("^std::__(ndk)?1::deque<.+>(( )?&)?$"), 536 stl_summary_flags, true); 537 AddCXXSummary(cpp_category_sp, 538 lldb_private::formatters::LibcxxContainerSummaryProvider, 539 "libc++ std::queue summary provider", 540 ConstString("^std::__(ndk)?1::queue<.+>(( )?&)?$"), 541 stl_summary_flags, true); 542 AddCXXSummary(cpp_category_sp, 543 lldb_private::formatters::LibcxxContainerSummaryProvider, 544 "libc++ std::set summary provider", 545 ConstString("^std::__(ndk)?1::set<.+>(( )?&)?$"), 546 stl_summary_flags, true); 547 AddCXXSummary(cpp_category_sp, 548 lldb_private::formatters::LibcxxContainerSummaryProvider, 549 "libc++ std::multiset summary provider", 550 ConstString("^std::__(ndk)?1::multiset<.+>(( )?&)?$"), 551 stl_summary_flags, true); 552 AddCXXSummary(cpp_category_sp, 553 lldb_private::formatters::LibcxxContainerSummaryProvider, 554 "libc++ std::multimap summary provider", 555 ConstString("^std::__(ndk)?1::multimap<.+>(( )?&)?$"), 556 stl_summary_flags, true); 557 AddCXXSummary( 558 cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider, 559 "libc++ std::unordered containers summary provider", 560 ConstString("^(std::__(ndk)?1::)unordered_(multi)?(map|set)<.+> >$"), 561 stl_summary_flags, true); 562 AddCXXSummary(cpp_category_sp, LibcxxContainerSummaryProvider, 563 "libc++ std::tuple summary provider", 564 ConstString("^std::__(ndk)?1::tuple<.*>(( )?&)?$"), stl_summary_flags, 565 true); 566 AddCXXSummary( 567 cpp_category_sp, lldb_private::formatters::LibCxxAtomicSummaryProvider, 568 "libc++ std::atomic summary provider", 569 ConstString("^std::__(ndk)?1::atomic<.+>$"), stl_summary_flags, true); 570 571 stl_summary_flags.SetSkipPointers(true); 572 573 AddCXXSummary(cpp_category_sp, 574 lldb_private::formatters::LibcxxSmartPointerSummaryProvider, 575 "libc++ std::shared_ptr summary provider", 576 ConstString("^std::__(ndk)?1::shared_ptr<.+>(( )?&)?$"), 577 stl_summary_flags, true); 578 AddCXXSummary(cpp_category_sp, 579 lldb_private::formatters::LibcxxSmartPointerSummaryProvider, 580 "libc++ std::weak_ptr summary provider", 581 ConstString("^std::__(ndk)?1::weak_ptr<.+>(( )?&)?$"), 582 stl_summary_flags, true); 583 584 AddCXXSynthetic( 585 cpp_category_sp, 586 lldb_private::formatters::LibCxxVectorIteratorSyntheticFrontEndCreator, 587 "std::vector iterator synthetic children", 588 ConstString("^std::__(ndk)?1::__wrap_iter<.+>$"), stl_synth_flags, true); 589 590 AddCXXSynthetic( 591 cpp_category_sp, 592 lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEndCreator, 593 "std::map iterator synthetic children", 594 ConstString("^std::__(ndk)?1::__map_iterator<.+>$"), stl_synth_flags, 595 true); 596 597 AddCXXSynthetic( 598 cpp_category_sp, lldb_private::formatters::LibcxxFunctionFrontEndCreator, 599 "std::function synthetic value provider", 600 ConstString("^std::__(ndk)?1::function<.+>$"), stl_synth_flags, true); 601 #endif 602 } 603 604 static void LoadLibStdcppFormatters(lldb::TypeCategoryImplSP cpp_category_sp) { 605 if (!cpp_category_sp) 606 return; 607 608 TypeSummaryImpl::Flags stl_summary_flags; 609 stl_summary_flags.SetCascades(true) 610 .SetSkipPointers(false) 611 .SetSkipReferences(false) 612 .SetDontShowChildren(true) 613 .SetDontShowValue(true) 614 .SetShowMembersOneLiner(false) 615 .SetHideItemNames(false); 616 617 lldb::TypeSummaryImplSP std_string_summary_sp( 618 new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p}")); 619 620 lldb::TypeSummaryImplSP cxx11_string_summary_sp(new CXXFunctionSummaryFormat( 621 stl_summary_flags, LibStdcppStringSummaryProvider, 622 "libstdc++ c++11 std::string summary provider")); 623 lldb::TypeSummaryImplSP cxx11_wstring_summary_sp(new CXXFunctionSummaryFormat( 624 stl_summary_flags, LibStdcppWStringSummaryProvider, 625 "libstdc++ c++11 std::wstring summary provider")); 626 627 cpp_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::string"), 628 std_string_summary_sp); 629 cpp_category_sp->GetTypeSummariesContainer()->Add( 630 ConstString("std::basic_string<char>"), std_string_summary_sp); 631 cpp_category_sp->GetTypeSummariesContainer()->Add( 632 ConstString("std::basic_string<char,std::char_traits<char>,std::" 633 "allocator<char> >"), 634 std_string_summary_sp); 635 cpp_category_sp->GetTypeSummariesContainer()->Add( 636 ConstString("std::basic_string<char, std::char_traits<char>, " 637 "std::allocator<char> >"), 638 std_string_summary_sp); 639 640 cpp_category_sp->GetTypeSummariesContainer()->Add( 641 ConstString("std::__cxx11::string"), cxx11_string_summary_sp); 642 cpp_category_sp->GetTypeSummariesContainer()->Add( 643 ConstString("std::__cxx11::basic_string<char, std::char_traits<char>, " 644 "std::allocator<char> >"), 645 cxx11_string_summary_sp); 646 647 // making sure we force-pick the summary for printing wstring (_M_p is a 648 // wchar_t*) 649 lldb::TypeSummaryImplSP std_wstring_summary_sp( 650 new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p%S}")); 651 652 cpp_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::wstring"), 653 std_wstring_summary_sp); 654 cpp_category_sp->GetTypeSummariesContainer()->Add( 655 ConstString("std::basic_string<wchar_t>"), std_wstring_summary_sp); 656 cpp_category_sp->GetTypeSummariesContainer()->Add( 657 ConstString("std::basic_string<wchar_t,std::char_traits<wchar_t>,std::" 658 "allocator<wchar_t> >"), 659 std_wstring_summary_sp); 660 cpp_category_sp->GetTypeSummariesContainer()->Add( 661 ConstString("std::basic_string<wchar_t, std::char_traits<wchar_t>, " 662 "std::allocator<wchar_t> >"), 663 std_wstring_summary_sp); 664 665 cpp_category_sp->GetTypeSummariesContainer()->Add( 666 ConstString("std::__cxx11::wstring"), cxx11_wstring_summary_sp); 667 cpp_category_sp->GetTypeSummariesContainer()->Add( 668 ConstString("std::__cxx11::basic_string<wchar_t, " 669 "std::char_traits<wchar_t>, std::allocator<wchar_t> >"), 670 cxx11_wstring_summary_sp); 671 672 #ifndef LLDB_DISABLE_PYTHON 673 674 SyntheticChildren::Flags stl_synth_flags; 675 stl_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences( 676 false); 677 678 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 679 RegularExpressionSP( 680 new RegularExpression(llvm::StringRef("^std::vector<.+>(( )?&)?$"))), 681 SyntheticChildrenSP(new ScriptedSyntheticChildren( 682 stl_synth_flags, 683 "lldb.formatters.cpp.gnu_libstdcpp.StdVectorSynthProvider"))); 684 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 685 RegularExpressionSP( 686 new RegularExpression(llvm::StringRef("^std::map<.+> >(( )?&)?$"))), 687 SyntheticChildrenSP(new ScriptedSyntheticChildren( 688 stl_synth_flags, 689 "lldb.formatters.cpp.gnu_libstdcpp.StdMapSynthProvider"))); 690 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 691 RegularExpressionSP(new RegularExpression( 692 llvm::StringRef("^std::(__cxx11::)?list<.+>(( )?&)?$"))), 693 SyntheticChildrenSP(new ScriptedSyntheticChildren( 694 stl_synth_flags, 695 "lldb.formatters.cpp.gnu_libstdcpp.StdListSynthProvider"))); 696 stl_summary_flags.SetDontShowChildren(false); 697 stl_summary_flags.SetSkipPointers(true); 698 cpp_category_sp->GetRegexTypeSummariesContainer()->Add( 699 RegularExpressionSP( 700 new RegularExpression(llvm::StringRef("^std::vector<.+>(( )?&)?$"))), 701 TypeSummaryImplSP( 702 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}"))); 703 cpp_category_sp->GetRegexTypeSummariesContainer()->Add( 704 RegularExpressionSP( 705 new RegularExpression(llvm::StringRef("^std::map<.+> >(( )?&)?$"))), 706 TypeSummaryImplSP( 707 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}"))); 708 cpp_category_sp->GetRegexTypeSummariesContainer()->Add( 709 RegularExpressionSP(new RegularExpression( 710 llvm::StringRef("^std::(__cxx11::)?list<.+>(( )?&)?$"))), 711 TypeSummaryImplSP( 712 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}"))); 713 714 AddCXXSynthetic( 715 cpp_category_sp, 716 lldb_private::formatters::LibStdcppVectorIteratorSyntheticFrontEndCreator, 717 "std::vector iterator synthetic children", 718 ConstString("^__gnu_cxx::__normal_iterator<.+>$"), stl_synth_flags, true); 719 720 AddCXXSynthetic( 721 cpp_category_sp, 722 lldb_private::formatters::LibstdcppMapIteratorSyntheticFrontEndCreator, 723 "std::map iterator synthetic children", 724 ConstString("^std::_Rb_tree_iterator<.+>$"), stl_synth_flags, true); 725 726 AddCXXSynthetic( 727 cpp_category_sp, 728 lldb_private::formatters::LibStdcppUniquePtrSyntheticFrontEndCreator, 729 "std::unique_ptr synthetic children", 730 ConstString("^std::unique_ptr<.+>(( )?&)?$"), stl_synth_flags, true); 731 AddCXXSynthetic( 732 cpp_category_sp, 733 lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator, 734 "std::shared_ptr synthetic children", 735 ConstString("^std::shared_ptr<.+>(( )?&)?$"), stl_synth_flags, true); 736 AddCXXSynthetic( 737 cpp_category_sp, 738 lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator, 739 "std::weak_ptr synthetic children", 740 ConstString("^std::weak_ptr<.+>(( )?&)?$"), stl_synth_flags, true); 741 AddCXXSynthetic( 742 cpp_category_sp, 743 lldb_private::formatters::LibStdcppTupleSyntheticFrontEndCreator, 744 "std::tuple synthetic children", ConstString("^std::tuple<.+>(( )?&)?$"), 745 stl_synth_flags, true); 746 747 AddCXXSummary(cpp_category_sp, 748 lldb_private::formatters::LibStdcppUniquePointerSummaryProvider, 749 "libstdc++ std::unique_ptr summary provider", 750 ConstString("^std::unique_ptr<.+>(( )?&)?$"), stl_summary_flags, 751 true); 752 AddCXXSummary(cpp_category_sp, 753 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider, 754 "libstdc++ std::shared_ptr summary provider", 755 ConstString("^std::shared_ptr<.+>(( )?&)?$"), stl_summary_flags, 756 true); 757 AddCXXSummary(cpp_category_sp, 758 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider, 759 "libstdc++ std::weak_ptr summary provider", 760 ConstString("^std::weak_ptr<.+>(( )?&)?$"), stl_summary_flags, 761 true); 762 #endif 763 } 764 765 static void LoadSystemFormatters(lldb::TypeCategoryImplSP cpp_category_sp) { 766 if (!cpp_category_sp) 767 return; 768 769 TypeSummaryImpl::Flags string_flags; 770 string_flags.SetCascades(true) 771 .SetSkipPointers(true) 772 .SetSkipReferences(false) 773 .SetDontShowChildren(true) 774 .SetDontShowValue(false) 775 .SetShowMembersOneLiner(false) 776 .SetHideItemNames(false); 777 778 TypeSummaryImpl::Flags string_array_flags; 779 string_array_flags.SetCascades(true) 780 .SetSkipPointers(true) 781 .SetSkipReferences(false) 782 .SetDontShowChildren(true) 783 .SetDontShowValue(true) 784 .SetShowMembersOneLiner(false) 785 .SetHideItemNames(false); 786 787 #ifndef LLDB_DISABLE_PYTHON 788 // FIXME because of a bug in the FormattersContainer we need to add a summary 789 // for both X* and const X* (<rdar://problem/12717717>) 790 AddCXXSummary( 791 cpp_category_sp, lldb_private::formatters::Char16StringSummaryProvider, 792 "char16_t * summary provider", ConstString("char16_t *"), string_flags); 793 AddCXXSummary(cpp_category_sp, 794 lldb_private::formatters::Char16StringSummaryProvider, 795 "char16_t [] summary provider", 796 ConstString("char16_t \\[[0-9]+\\]"), string_array_flags, true); 797 798 AddCXXSummary( 799 cpp_category_sp, lldb_private::formatters::Char32StringSummaryProvider, 800 "char32_t * summary provider", ConstString("char32_t *"), string_flags); 801 AddCXXSummary(cpp_category_sp, 802 lldb_private::formatters::Char32StringSummaryProvider, 803 "char32_t [] summary provider", 804 ConstString("char32_t \\[[0-9]+\\]"), string_array_flags, true); 805 806 AddCXXSummary( 807 cpp_category_sp, lldb_private::formatters::WCharStringSummaryProvider, 808 "wchar_t * summary provider", ConstString("wchar_t *"), string_flags); 809 AddCXXSummary(cpp_category_sp, 810 lldb_private::formatters::WCharStringSummaryProvider, 811 "wchar_t * summary provider", 812 ConstString("wchar_t \\[[0-9]+\\]"), string_array_flags, true); 813 814 AddCXXSummary( 815 cpp_category_sp, lldb_private::formatters::Char16StringSummaryProvider, 816 "unichar * summary provider", ConstString("unichar *"), string_flags); 817 818 TypeSummaryImpl::Flags widechar_flags; 819 widechar_flags.SetDontShowValue(true) 820 .SetSkipPointers(true) 821 .SetSkipReferences(false) 822 .SetCascades(true) 823 .SetDontShowChildren(true) 824 .SetHideItemNames(true) 825 .SetShowMembersOneLiner(false); 826 827 AddCXXSummary( 828 cpp_category_sp, lldb_private::formatters::Char16SummaryProvider, 829 "char16_t summary provider", ConstString("char16_t"), widechar_flags); 830 AddCXXSummary( 831 cpp_category_sp, lldb_private::formatters::Char32SummaryProvider, 832 "char32_t summary provider", ConstString("char32_t"), widechar_flags); 833 AddCXXSummary(cpp_category_sp, lldb_private::formatters::WCharSummaryProvider, 834 "wchar_t summary provider", ConstString("wchar_t"), 835 widechar_flags); 836 837 AddCXXSummary( 838 cpp_category_sp, lldb_private::formatters::Char16SummaryProvider, 839 "unichar summary provider", ConstString("unichar"), widechar_flags); 840 #endif 841 } 842 843 std::unique_ptr<Language::TypeScavenger> CPlusPlusLanguage::GetTypeScavenger() { 844 class CPlusPlusTypeScavenger : public Language::ImageListTypeScavenger { 845 public: 846 virtual CompilerType AdjustForInclusion(CompilerType &candidate) override { 847 LanguageType lang_type(candidate.GetMinimumLanguage()); 848 if (!Language::LanguageIsC(lang_type) && 849 !Language::LanguageIsCPlusPlus(lang_type)) 850 return CompilerType(); 851 if (candidate.IsTypedefType()) 852 return candidate.GetTypedefedType(); 853 return candidate; 854 } 855 }; 856 857 return std::unique_ptr<TypeScavenger>(new CPlusPlusTypeScavenger()); 858 } 859 860 lldb::TypeCategoryImplSP CPlusPlusLanguage::GetFormatters() { 861 static llvm::once_flag g_initialize; 862 static TypeCategoryImplSP g_category; 863 864 llvm::call_once(g_initialize, [this]() -> void { 865 DataVisualization::Categories::GetCategory(GetPluginName(), g_category); 866 if (g_category) { 867 LoadLibCxxFormatters(g_category); 868 LoadLibStdcppFormatters(g_category); 869 LoadSystemFormatters(g_category); 870 } 871 }); 872 return g_category; 873 } 874 875 HardcodedFormatters::HardcodedSummaryFinder 876 CPlusPlusLanguage::GetHardcodedSummaries() { 877 static llvm::once_flag g_initialize; 878 static ConstString g_vectortypes("VectorTypes"); 879 static HardcodedFormatters::HardcodedSummaryFinder g_formatters; 880 881 llvm::call_once(g_initialize, []() -> void { 882 g_formatters.push_back( 883 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType, 884 FormatManager &) -> TypeSummaryImpl::SharedPointer { 885 static CXXFunctionSummaryFormat::SharedPointer formatter_sp( 886 new CXXFunctionSummaryFormat( 887 TypeSummaryImpl::Flags(), 888 lldb_private::formatters::CXXFunctionPointerSummaryProvider, 889 "Function pointer summary provider")); 890 if (valobj.GetCompilerType().IsFunctionPointerType()) { 891 return formatter_sp; 892 } 893 return nullptr; 894 }); 895 g_formatters.push_back( 896 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType, 897 FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer { 898 static CXXFunctionSummaryFormat::SharedPointer formatter_sp( 899 new CXXFunctionSummaryFormat( 900 TypeSummaryImpl::Flags() 901 .SetCascades(true) 902 .SetDontShowChildren(true) 903 .SetHideItemNames(true) 904 .SetShowMembersOneLiner(true) 905 .SetSkipPointers(true) 906 .SetSkipReferences(false), 907 lldb_private::formatters::VectorTypeSummaryProvider, 908 "vector_type pointer summary provider")); 909 if (valobj.GetCompilerType().IsVectorType(nullptr, nullptr)) { 910 if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled()) 911 return formatter_sp; 912 } 913 return nullptr; 914 }); 915 g_formatters.push_back( 916 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType, 917 FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer { 918 static CXXFunctionSummaryFormat::SharedPointer formatter_sp( 919 new CXXFunctionSummaryFormat( 920 TypeSummaryImpl::Flags() 921 .SetCascades(true) 922 .SetDontShowChildren(true) 923 .SetHideItemNames(true) 924 .SetShowMembersOneLiner(true) 925 .SetSkipPointers(true) 926 .SetSkipReferences(false), 927 lldb_private::formatters::BlockPointerSummaryProvider, 928 "block pointer summary provider")); 929 if (valobj.GetCompilerType().IsBlockPointerType(nullptr)) { 930 return formatter_sp; 931 } 932 return nullptr; 933 }); 934 }); 935 936 return g_formatters; 937 } 938 939 HardcodedFormatters::HardcodedSyntheticFinder 940 CPlusPlusLanguage::GetHardcodedSynthetics() { 941 static llvm::once_flag g_initialize; 942 static ConstString g_vectortypes("VectorTypes"); 943 static HardcodedFormatters::HardcodedSyntheticFinder g_formatters; 944 945 llvm::call_once(g_initialize, []() -> void { 946 g_formatters.push_back([](lldb_private::ValueObject &valobj, 947 lldb::DynamicValueType, 948 FormatManager & 949 fmt_mgr) -> SyntheticChildren::SharedPointer { 950 static CXXSyntheticChildren::SharedPointer formatter_sp( 951 new CXXSyntheticChildren( 952 SyntheticChildren::Flags() 953 .SetCascades(true) 954 .SetSkipPointers(true) 955 .SetSkipReferences(true) 956 .SetNonCacheable(true), 957 "vector_type synthetic children", 958 lldb_private::formatters::VectorTypeSyntheticFrontEndCreator)); 959 if (valobj.GetCompilerType().IsVectorType(nullptr, nullptr)) { 960 if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled()) 961 return formatter_sp; 962 } 963 return nullptr; 964 }); 965 g_formatters.push_back([](lldb_private::ValueObject &valobj, 966 lldb::DynamicValueType, 967 FormatManager & 968 fmt_mgr) -> SyntheticChildren::SharedPointer { 969 static CXXSyntheticChildren::SharedPointer formatter_sp( 970 new CXXSyntheticChildren( 971 SyntheticChildren::Flags() 972 .SetCascades(true) 973 .SetSkipPointers(true) 974 .SetSkipReferences(true) 975 .SetNonCacheable(true), 976 "block pointer synthetic children", 977 lldb_private::formatters::BlockPointerSyntheticFrontEndCreator)); 978 if (valobj.GetCompilerType().IsBlockPointerType(nullptr)) { 979 return formatter_sp; 980 } 981 return nullptr; 982 }); 983 984 }); 985 986 return g_formatters; 987 } 988