contrib/llvm/tools/lldb/source/Plugins/Language/CPlusPlus/CPlusPlusLanguage.cpp

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