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