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, LibcxxTupleFrontEndCreator, 477 "libc++ std::tuple synthetic children", 478 ConstString("^std::__(ndk)?1::tuple<.*>(( )?&)?$"), stl_synth_flags, 479 true); 480 AddCXXSynthetic( 481 cpp_category_sp, 482 lldb_private::formatters::LibcxxAtomicSyntheticFrontEndCreator, 483 "libc++ std::atomic synthetic children", 484 ConstString("^std::__(ndk)?1::atomic<.+>$"), stl_synth_flags, true); 485 486 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 487 RegularExpressionSP(new RegularExpression( 488 llvm::StringRef("^(std::__(ndk)?1::)deque<.+>(( )?&)?$"))), 489 SyntheticChildrenSP(new ScriptedSyntheticChildren( 490 stl_synth_flags, 491 "lldb.formatters.cpp.libcxx.stddeque_SynthProvider"))); 492 493 AddCXXSynthetic( 494 cpp_category_sp, 495 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator, 496 "shared_ptr synthetic children", 497 ConstString("^(std::__(ndk)?1::)shared_ptr<.+>(( )?&)?$"), 498 stl_synth_flags, true); 499 AddCXXSynthetic( 500 cpp_category_sp, 501 lldb_private::formatters::LibcxxSharedPtrSyntheticFrontEndCreator, 502 "weak_ptr synthetic children", 503 ConstString("^(std::__(ndk)?1::)weak_ptr<.+>(( )?&)?$"), stl_synth_flags, 504 true); 505 506 stl_summary_flags.SetDontShowChildren(false); 507 stl_summary_flags.SetSkipPointers(false); 508 AddCXXSummary(cpp_category_sp, 509 lldb_private::formatters::LibcxxContainerSummaryProvider, 510 "libc++ std::vector summary provider", 511 ConstString("^std::__(ndk)?1::vector<.+>(( )?&)?$"), 512 stl_summary_flags, true); 513 AddCXXSummary(cpp_category_sp, 514 lldb_private::formatters::LibcxxContainerSummaryProvider, 515 "libc++ std::list summary provider", 516 ConstString("^std::__(ndk)?1::forward_list<.+>(( )?&)?$"), 517 stl_summary_flags, true); 518 AddCXXSummary(cpp_category_sp, 519 lldb_private::formatters::LibcxxContainerSummaryProvider, 520 "libc++ std::list summary provider", 521 ConstString("^std::__(ndk)?1::list<.+>(( )?&)?$"), 522 stl_summary_flags, true); 523 AddCXXSummary(cpp_category_sp, 524 lldb_private::formatters::LibcxxContainerSummaryProvider, 525 "libc++ std::map summary provider", 526 ConstString("^std::__(ndk)?1::map<.+>(( )?&)?$"), 527 stl_summary_flags, true); 528 AddCXXSummary(cpp_category_sp, 529 lldb_private::formatters::LibcxxContainerSummaryProvider, 530 "libc++ std::deque summary provider", 531 ConstString("^std::__(ndk)?1::deque<.+>(( )?&)?$"), 532 stl_summary_flags, true); 533 AddCXXSummary(cpp_category_sp, 534 lldb_private::formatters::LibcxxContainerSummaryProvider, 535 "libc++ std::set summary provider", 536 ConstString("^std::__(ndk)?1::set<.+>(( )?&)?$"), 537 stl_summary_flags, true); 538 AddCXXSummary(cpp_category_sp, 539 lldb_private::formatters::LibcxxContainerSummaryProvider, 540 "libc++ std::multiset summary provider", 541 ConstString("^std::__(ndk)?1::multiset<.+>(( )?&)?$"), 542 stl_summary_flags, true); 543 AddCXXSummary(cpp_category_sp, 544 lldb_private::formatters::LibcxxContainerSummaryProvider, 545 "libc++ std::multimap summary provider", 546 ConstString("^std::__(ndk)?1::multimap<.+>(( )?&)?$"), 547 stl_summary_flags, true); 548 AddCXXSummary( 549 cpp_category_sp, lldb_private::formatters::LibcxxContainerSummaryProvider, 550 "libc++ std::unordered containers summary provider", 551 ConstString("^(std::__(ndk)?1::)unordered_(multi)?(map|set)<.+> >$"), 552 stl_summary_flags, true); 553 AddCXXSummary(cpp_category_sp, LibcxxContainerSummaryProvider, 554 "libc++ std::tuple summary provider", 555 ConstString("^std::__(ndk)?1::tuple<.*>(( )?&)?$"), stl_summary_flags, 556 true); 557 AddCXXSummary( 558 cpp_category_sp, lldb_private::formatters::LibCxxAtomicSummaryProvider, 559 "libc++ std::atomic summary provider", 560 ConstString("^std::__(ndk)?1::atomic<.+>$"), stl_summary_flags, true); 561 562 stl_summary_flags.SetSkipPointers(true); 563 564 AddCXXSummary(cpp_category_sp, 565 lldb_private::formatters::LibcxxSmartPointerSummaryProvider, 566 "libc++ std::shared_ptr summary provider", 567 ConstString("^std::__(ndk)?1::shared_ptr<.+>(( )?&)?$"), 568 stl_summary_flags, true); 569 AddCXXSummary(cpp_category_sp, 570 lldb_private::formatters::LibcxxSmartPointerSummaryProvider, 571 "libc++ std::weak_ptr summary provider", 572 ConstString("^std::__(ndk)?1::weak_ptr<.+>(( )?&)?$"), 573 stl_summary_flags, true); 574 575 AddCXXSynthetic( 576 cpp_category_sp, 577 lldb_private::formatters::LibCxxVectorIteratorSyntheticFrontEndCreator, 578 "std::vector iterator synthetic children", 579 ConstString("^std::__(ndk)?1::__wrap_iter<.+>$"), stl_synth_flags, true); 580 581 AddCXXSynthetic( 582 cpp_category_sp, 583 lldb_private::formatters::LibCxxMapIteratorSyntheticFrontEndCreator, 584 "std::map iterator synthetic children", 585 ConstString("^std::__(ndk)?1::__map_iterator<.+>$"), stl_synth_flags, 586 true); 587 588 AddCXXSynthetic( 589 cpp_category_sp, lldb_private::formatters::LibcxxFunctionFrontEndCreator, 590 "std::function synthetic value provider", 591 ConstString("^std::__(ndk)?1::function<.+>$"), stl_synth_flags, true); 592 #endif 593 } 594 595 static void LoadLibStdcppFormatters(lldb::TypeCategoryImplSP cpp_category_sp) { 596 if (!cpp_category_sp) 597 return; 598 599 TypeSummaryImpl::Flags stl_summary_flags; 600 stl_summary_flags.SetCascades(true) 601 .SetSkipPointers(false) 602 .SetSkipReferences(false) 603 .SetDontShowChildren(true) 604 .SetDontShowValue(true) 605 .SetShowMembersOneLiner(false) 606 .SetHideItemNames(false); 607 608 lldb::TypeSummaryImplSP std_string_summary_sp( 609 new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p}")); 610 611 lldb::TypeSummaryImplSP cxx11_string_summary_sp(new CXXFunctionSummaryFormat( 612 stl_summary_flags, LibStdcppStringSummaryProvider, 613 "libstdc++ c++11 std::string summary provider")); 614 lldb::TypeSummaryImplSP cxx11_wstring_summary_sp(new CXXFunctionSummaryFormat( 615 stl_summary_flags, LibStdcppWStringSummaryProvider, 616 "libstdc++ c++11 std::wstring summary provider")); 617 618 cpp_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::string"), 619 std_string_summary_sp); 620 cpp_category_sp->GetTypeSummariesContainer()->Add( 621 ConstString("std::basic_string<char>"), std_string_summary_sp); 622 cpp_category_sp->GetTypeSummariesContainer()->Add( 623 ConstString("std::basic_string<char,std::char_traits<char>,std::" 624 "allocator<char> >"), 625 std_string_summary_sp); 626 cpp_category_sp->GetTypeSummariesContainer()->Add( 627 ConstString("std::basic_string<char, std::char_traits<char>, " 628 "std::allocator<char> >"), 629 std_string_summary_sp); 630 631 cpp_category_sp->GetTypeSummariesContainer()->Add( 632 ConstString("std::__cxx11::string"), cxx11_string_summary_sp); 633 cpp_category_sp->GetTypeSummariesContainer()->Add( 634 ConstString("std::__cxx11::basic_string<char, std::char_traits<char>, " 635 "std::allocator<char> >"), 636 cxx11_string_summary_sp); 637 638 // making sure we force-pick the summary for printing wstring (_M_p is a 639 // wchar_t*) 640 lldb::TypeSummaryImplSP std_wstring_summary_sp( 641 new StringSummaryFormat(stl_summary_flags, "${var._M_dataplus._M_p%S}")); 642 643 cpp_category_sp->GetTypeSummariesContainer()->Add(ConstString("std::wstring"), 644 std_wstring_summary_sp); 645 cpp_category_sp->GetTypeSummariesContainer()->Add( 646 ConstString("std::basic_string<wchar_t>"), std_wstring_summary_sp); 647 cpp_category_sp->GetTypeSummariesContainer()->Add( 648 ConstString("std::basic_string<wchar_t,std::char_traits<wchar_t>,std::" 649 "allocator<wchar_t> >"), 650 std_wstring_summary_sp); 651 cpp_category_sp->GetTypeSummariesContainer()->Add( 652 ConstString("std::basic_string<wchar_t, std::char_traits<wchar_t>, " 653 "std::allocator<wchar_t> >"), 654 std_wstring_summary_sp); 655 656 cpp_category_sp->GetTypeSummariesContainer()->Add( 657 ConstString("std::__cxx11::wstring"), cxx11_wstring_summary_sp); 658 cpp_category_sp->GetTypeSummariesContainer()->Add( 659 ConstString("std::__cxx11::basic_string<wchar_t, " 660 "std::char_traits<wchar_t>, std::allocator<wchar_t> >"), 661 cxx11_wstring_summary_sp); 662 663 #ifndef LLDB_DISABLE_PYTHON 664 665 SyntheticChildren::Flags stl_synth_flags; 666 stl_synth_flags.SetCascades(true).SetSkipPointers(false).SetSkipReferences( 667 false); 668 669 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 670 RegularExpressionSP( 671 new RegularExpression(llvm::StringRef("^std::vector<.+>(( )?&)?$"))), 672 SyntheticChildrenSP(new ScriptedSyntheticChildren( 673 stl_synth_flags, 674 "lldb.formatters.cpp.gnu_libstdcpp.StdVectorSynthProvider"))); 675 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 676 RegularExpressionSP( 677 new RegularExpression(llvm::StringRef("^std::map<.+> >(( )?&)?$"))), 678 SyntheticChildrenSP(new ScriptedSyntheticChildren( 679 stl_synth_flags, 680 "lldb.formatters.cpp.gnu_libstdcpp.StdMapSynthProvider"))); 681 cpp_category_sp->GetRegexTypeSyntheticsContainer()->Add( 682 RegularExpressionSP(new RegularExpression( 683 llvm::StringRef("^std::(__cxx11::)?list<.+>(( )?&)?$"))), 684 SyntheticChildrenSP(new ScriptedSyntheticChildren( 685 stl_synth_flags, 686 "lldb.formatters.cpp.gnu_libstdcpp.StdListSynthProvider"))); 687 stl_summary_flags.SetDontShowChildren(false); 688 stl_summary_flags.SetSkipPointers(true); 689 cpp_category_sp->GetRegexTypeSummariesContainer()->Add( 690 RegularExpressionSP( 691 new RegularExpression(llvm::StringRef("^std::vector<.+>(( )?&)?$"))), 692 TypeSummaryImplSP( 693 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}"))); 694 cpp_category_sp->GetRegexTypeSummariesContainer()->Add( 695 RegularExpressionSP( 696 new RegularExpression(llvm::StringRef("^std::map<.+> >(( )?&)?$"))), 697 TypeSummaryImplSP( 698 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}"))); 699 cpp_category_sp->GetRegexTypeSummariesContainer()->Add( 700 RegularExpressionSP(new RegularExpression( 701 llvm::StringRef("^std::(__cxx11::)?list<.+>(( )?&)?$"))), 702 TypeSummaryImplSP( 703 new StringSummaryFormat(stl_summary_flags, "size=${svar%#}"))); 704 705 AddCXXSynthetic( 706 cpp_category_sp, 707 lldb_private::formatters::LibStdcppVectorIteratorSyntheticFrontEndCreator, 708 "std::vector iterator synthetic children", 709 ConstString("^__gnu_cxx::__normal_iterator<.+>$"), stl_synth_flags, true); 710 711 AddCXXSynthetic( 712 cpp_category_sp, 713 lldb_private::formatters::LibstdcppMapIteratorSyntheticFrontEndCreator, 714 "std::map iterator synthetic children", 715 ConstString("^std::_Rb_tree_iterator<.+>$"), stl_synth_flags, true); 716 717 AddCXXSynthetic( 718 cpp_category_sp, 719 lldb_private::formatters::LibStdcppUniquePtrSyntheticFrontEndCreator, 720 "std::unique_ptr synthetic children", 721 ConstString("^std::unique_ptr<.+>(( )?&)?$"), stl_synth_flags, true); 722 AddCXXSynthetic( 723 cpp_category_sp, 724 lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator, 725 "std::shared_ptr synthetic children", 726 ConstString("^std::shared_ptr<.+>(( )?&)?$"), stl_synth_flags, true); 727 AddCXXSynthetic( 728 cpp_category_sp, 729 lldb_private::formatters::LibStdcppSharedPtrSyntheticFrontEndCreator, 730 "std::weak_ptr synthetic children", 731 ConstString("^std::weak_ptr<.+>(( )?&)?$"), stl_synth_flags, true); 732 AddCXXSynthetic( 733 cpp_category_sp, 734 lldb_private::formatters::LibStdcppTupleSyntheticFrontEndCreator, 735 "std::tuple synthetic children", ConstString("^std::tuple<.+>(( )?&)?$"), 736 stl_synth_flags, true); 737 738 AddCXXSummary(cpp_category_sp, 739 lldb_private::formatters::LibStdcppUniquePointerSummaryProvider, 740 "libstdc++ std::unique_ptr summary provider", 741 ConstString("^std::unique_ptr<.+>(( )?&)?$"), stl_summary_flags, 742 true); 743 AddCXXSummary(cpp_category_sp, 744 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider, 745 "libstdc++ std::shared_ptr summary provider", 746 ConstString("^std::shared_ptr<.+>(( )?&)?$"), stl_summary_flags, 747 true); 748 AddCXXSummary(cpp_category_sp, 749 lldb_private::formatters::LibStdcppSmartPointerSummaryProvider, 750 "libstdc++ std::weak_ptr summary provider", 751 ConstString("^std::weak_ptr<.+>(( )?&)?$"), stl_summary_flags, 752 true); 753 #endif 754 } 755 756 static void LoadSystemFormatters(lldb::TypeCategoryImplSP cpp_category_sp) { 757 if (!cpp_category_sp) 758 return; 759 760 TypeSummaryImpl::Flags string_flags; 761 string_flags.SetCascades(true) 762 .SetSkipPointers(true) 763 .SetSkipReferences(false) 764 .SetDontShowChildren(true) 765 .SetDontShowValue(false) 766 .SetShowMembersOneLiner(false) 767 .SetHideItemNames(false); 768 769 TypeSummaryImpl::Flags string_array_flags; 770 string_array_flags.SetCascades(true) 771 .SetSkipPointers(true) 772 .SetSkipReferences(false) 773 .SetDontShowChildren(true) 774 .SetDontShowValue(true) 775 .SetShowMembersOneLiner(false) 776 .SetHideItemNames(false); 777 778 #ifndef LLDB_DISABLE_PYTHON 779 // FIXME because of a bug in the FormattersContainer we need to add a summary 780 // for both X* and const X* (<rdar://problem/12717717>) 781 AddCXXSummary( 782 cpp_category_sp, lldb_private::formatters::Char16StringSummaryProvider, 783 "char16_t * summary provider", ConstString("char16_t *"), string_flags); 784 AddCXXSummary(cpp_category_sp, 785 lldb_private::formatters::Char16StringSummaryProvider, 786 "char16_t [] summary provider", 787 ConstString("char16_t \\[[0-9]+\\]"), string_array_flags, true); 788 789 AddCXXSummary( 790 cpp_category_sp, lldb_private::formatters::Char32StringSummaryProvider, 791 "char32_t * summary provider", ConstString("char32_t *"), string_flags); 792 AddCXXSummary(cpp_category_sp, 793 lldb_private::formatters::Char32StringSummaryProvider, 794 "char32_t [] summary provider", 795 ConstString("char32_t \\[[0-9]+\\]"), string_array_flags, true); 796 797 AddCXXSummary( 798 cpp_category_sp, lldb_private::formatters::WCharStringSummaryProvider, 799 "wchar_t * summary provider", ConstString("wchar_t *"), string_flags); 800 AddCXXSummary(cpp_category_sp, 801 lldb_private::formatters::WCharStringSummaryProvider, 802 "wchar_t * summary provider", 803 ConstString("wchar_t \\[[0-9]+\\]"), string_array_flags, true); 804 805 AddCXXSummary( 806 cpp_category_sp, lldb_private::formatters::Char16StringSummaryProvider, 807 "unichar * summary provider", ConstString("unichar *"), string_flags); 808 809 TypeSummaryImpl::Flags widechar_flags; 810 widechar_flags.SetDontShowValue(true) 811 .SetSkipPointers(true) 812 .SetSkipReferences(false) 813 .SetCascades(true) 814 .SetDontShowChildren(true) 815 .SetHideItemNames(true) 816 .SetShowMembersOneLiner(false); 817 818 AddCXXSummary( 819 cpp_category_sp, lldb_private::formatters::Char16SummaryProvider, 820 "char16_t summary provider", ConstString("char16_t"), widechar_flags); 821 AddCXXSummary( 822 cpp_category_sp, lldb_private::formatters::Char32SummaryProvider, 823 "char32_t summary provider", ConstString("char32_t"), widechar_flags); 824 AddCXXSummary(cpp_category_sp, lldb_private::formatters::WCharSummaryProvider, 825 "wchar_t summary provider", ConstString("wchar_t"), 826 widechar_flags); 827 828 AddCXXSummary( 829 cpp_category_sp, lldb_private::formatters::Char16SummaryProvider, 830 "unichar summary provider", ConstString("unichar"), widechar_flags); 831 #endif 832 } 833 834 std::unique_ptr<Language::TypeScavenger> CPlusPlusLanguage::GetTypeScavenger() { 835 class CPlusPlusTypeScavenger : public Language::ImageListTypeScavenger { 836 public: 837 virtual CompilerType AdjustForInclusion(CompilerType &candidate) override { 838 LanguageType lang_type(candidate.GetMinimumLanguage()); 839 if (!Language::LanguageIsC(lang_type) && 840 !Language::LanguageIsCPlusPlus(lang_type)) 841 return CompilerType(); 842 if (candidate.IsTypedefType()) 843 return candidate.GetTypedefedType(); 844 return candidate; 845 } 846 }; 847 848 return std::unique_ptr<TypeScavenger>(new CPlusPlusTypeScavenger()); 849 } 850 851 lldb::TypeCategoryImplSP CPlusPlusLanguage::GetFormatters() { 852 static llvm::once_flag g_initialize; 853 static TypeCategoryImplSP g_category; 854 855 llvm::call_once(g_initialize, [this]() -> void { 856 DataVisualization::Categories::GetCategory(GetPluginName(), g_category); 857 if (g_category) { 858 LoadLibCxxFormatters(g_category); 859 LoadLibStdcppFormatters(g_category); 860 LoadSystemFormatters(g_category); 861 } 862 }); 863 return g_category; 864 } 865 866 HardcodedFormatters::HardcodedSummaryFinder 867 CPlusPlusLanguage::GetHardcodedSummaries() { 868 static llvm::once_flag g_initialize; 869 static ConstString g_vectortypes("VectorTypes"); 870 static HardcodedFormatters::HardcodedSummaryFinder g_formatters; 871 872 llvm::call_once(g_initialize, []() -> void { 873 g_formatters.push_back( 874 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType, 875 FormatManager &) -> TypeSummaryImpl::SharedPointer { 876 static CXXFunctionSummaryFormat::SharedPointer formatter_sp( 877 new CXXFunctionSummaryFormat( 878 TypeSummaryImpl::Flags(), 879 lldb_private::formatters::CXXFunctionPointerSummaryProvider, 880 "Function pointer summary provider")); 881 if (valobj.GetCompilerType().IsFunctionPointerType()) { 882 return formatter_sp; 883 } 884 return nullptr; 885 }); 886 g_formatters.push_back( 887 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType, 888 FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer { 889 static CXXFunctionSummaryFormat::SharedPointer formatter_sp( 890 new CXXFunctionSummaryFormat( 891 TypeSummaryImpl::Flags() 892 .SetCascades(true) 893 .SetDontShowChildren(true) 894 .SetHideItemNames(true) 895 .SetShowMembersOneLiner(true) 896 .SetSkipPointers(true) 897 .SetSkipReferences(false), 898 lldb_private::formatters::VectorTypeSummaryProvider, 899 "vector_type pointer summary provider")); 900 if (valobj.GetCompilerType().IsVectorType(nullptr, nullptr)) { 901 if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled()) 902 return formatter_sp; 903 } 904 return nullptr; 905 }); 906 g_formatters.push_back( 907 [](lldb_private::ValueObject &valobj, lldb::DynamicValueType, 908 FormatManager &fmt_mgr) -> TypeSummaryImpl::SharedPointer { 909 static CXXFunctionSummaryFormat::SharedPointer formatter_sp( 910 new CXXFunctionSummaryFormat( 911 TypeSummaryImpl::Flags() 912 .SetCascades(true) 913 .SetDontShowChildren(true) 914 .SetHideItemNames(true) 915 .SetShowMembersOneLiner(true) 916 .SetSkipPointers(true) 917 .SetSkipReferences(false), 918 lldb_private::formatters::BlockPointerSummaryProvider, 919 "block pointer summary provider")); 920 if (valobj.GetCompilerType().IsBlockPointerType(nullptr)) { 921 return formatter_sp; 922 } 923 return nullptr; 924 }); 925 }); 926 927 return g_formatters; 928 } 929 930 HardcodedFormatters::HardcodedSyntheticFinder 931 CPlusPlusLanguage::GetHardcodedSynthetics() { 932 static llvm::once_flag g_initialize; 933 static ConstString g_vectortypes("VectorTypes"); 934 static HardcodedFormatters::HardcodedSyntheticFinder g_formatters; 935 936 llvm::call_once(g_initialize, []() -> void { 937 g_formatters.push_back([](lldb_private::ValueObject &valobj, 938 lldb::DynamicValueType, 939 FormatManager & 940 fmt_mgr) -> SyntheticChildren::SharedPointer { 941 static CXXSyntheticChildren::SharedPointer formatter_sp( 942 new CXXSyntheticChildren( 943 SyntheticChildren::Flags() 944 .SetCascades(true) 945 .SetSkipPointers(true) 946 .SetSkipReferences(true) 947 .SetNonCacheable(true), 948 "vector_type synthetic children", 949 lldb_private::formatters::VectorTypeSyntheticFrontEndCreator)); 950 if (valobj.GetCompilerType().IsVectorType(nullptr, nullptr)) { 951 if (fmt_mgr.GetCategory(g_vectortypes)->IsEnabled()) 952 return formatter_sp; 953 } 954 return nullptr; 955 }); 956 g_formatters.push_back([](lldb_private::ValueObject &valobj, 957 lldb::DynamicValueType, 958 FormatManager & 959 fmt_mgr) -> SyntheticChildren::SharedPointer { 960 static CXXSyntheticChildren::SharedPointer formatter_sp( 961 new CXXSyntheticChildren( 962 SyntheticChildren::Flags() 963 .SetCascades(true) 964 .SetSkipPointers(true) 965 .SetSkipReferences(true) 966 .SetNonCacheable(true), 967 "block pointer synthetic children", 968 lldb_private::formatters::BlockPointerSyntheticFrontEndCreator)); 969 if (valobj.GetCompilerType().IsBlockPointerType(nullptr)) { 970 return formatter_sp; 971 } 972 return nullptr; 973 }); 974 975 }); 976 977 return g_formatters; 978 } 979