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