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