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