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