1 //===-- CPlusPlusLanguage.h -------------------------------------*- C++ -*-===// 2 // 3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. 4 // See https://llvm.org/LICENSE.txt for license information. 5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception 6 // 7 //===----------------------------------------------------------------------===// 8 9 #ifndef LLDB_SOURCE_PLUGINS_LANGUAGE_CPLUSPLUS_CPLUSPLUSLANGUAGE_H 10 #define LLDB_SOURCE_PLUGINS_LANGUAGE_CPLUSPLUS_CPLUSPLUSLANGUAGE_H 11 12 #include <set> 13 #include <vector> 14 15 #include "llvm/ADT/StringRef.h" 16 17 #include "Plugins/Language/ClangCommon/ClangHighlighter.h" 18 #include "lldb/Target/Language.h" 19 #include "lldb/Utility/ConstString.h" 20 #include "lldb/lldb-private.h" 21 22 namespace lldb_private { 23 24 class CPlusPlusLanguage : public Language { 25 ClangHighlighter m_highlighter; 26 27 public: 28 class MethodName { 29 public: 30 MethodName() 31 : m_full(), m_basename(), m_context(), m_arguments(), m_qualifiers() {} 32 33 MethodName(ConstString s) 34 : m_full(s), m_basename(), m_context(), m_arguments(), m_qualifiers(), 35 m_parsed(false), m_parse_error(false) {} 36 37 void Clear(); 38 39 bool IsValid() { 40 if (!m_parsed) 41 Parse(); 42 if (m_parse_error) 43 return false; 44 return (bool)m_full; 45 } 46 47 ConstString GetFullName() const { return m_full; } 48 49 std::string GetScopeQualifiedName(); 50 51 llvm::StringRef GetBasename(); 52 53 llvm::StringRef GetContext(); 54 55 llvm::StringRef GetArguments(); 56 57 llvm::StringRef GetQualifiers(); 58 59 bool ContainsPath(llvm::StringRef path); 60 61 private: 62 /// Returns the Basename of this method without a template parameter 63 /// list, if any. 64 /// 65 // Examples: 66 // 67 // +--------------------------------+---------+ 68 // | MethodName | Returns | 69 // +--------------------------------+---------+ 70 // | void func() | func | 71 // | void func<int>() | func | 72 // | void func<std::vector<int>>() | func | 73 // +--------------------------------+---------+ 74 llvm::StringRef GetBasenameNoTemplateParameters(); 75 76 protected: 77 void Parse(); 78 bool TrySimplifiedParse(); 79 80 ConstString m_full; // Full name: 81 // "lldb::SBTarget::GetBreakpointAtIndex(unsigned int) 82 // const" 83 llvm::StringRef m_basename; // Basename: "GetBreakpointAtIndex" 84 llvm::StringRef m_context; // Decl context: "lldb::SBTarget" 85 llvm::StringRef m_arguments; // Arguments: "(unsigned int)" 86 llvm::StringRef m_qualifiers; // Qualifiers: "const" 87 bool m_parsed = false; 88 bool m_parse_error = false; 89 }; 90 91 CPlusPlusLanguage() = default; 92 93 ~CPlusPlusLanguage() override = default; 94 95 lldb::LanguageType GetLanguageType() const override { 96 return lldb::eLanguageTypeC_plus_plus; 97 } 98 99 std::unique_ptr<TypeScavenger> GetTypeScavenger() override; 100 lldb::TypeCategoryImplSP GetFormatters() override; 101 102 HardcodedFormatters::HardcodedSummaryFinder GetHardcodedSummaries() override; 103 104 HardcodedFormatters::HardcodedSyntheticFinder 105 GetHardcodedSynthetics() override; 106 107 bool IsNilReference(ValueObject &valobj) override; 108 109 llvm::StringRef GetNilReferenceSummaryString() override { return "nullptr"; } 110 111 bool IsSourceFile(llvm::StringRef file_path) const override; 112 113 const Highlighter *GetHighlighter() const override { return &m_highlighter; } 114 115 // Static Functions 116 static void Initialize(); 117 118 static void Terminate(); 119 120 static lldb_private::Language *CreateInstance(lldb::LanguageType language); 121 122 static llvm::StringRef GetPluginNameStatic() { return "cplusplus"; } 123 124 bool SymbolNameFitsToLanguage(Mangled mangled) const override; 125 126 bool DemangledNameContainsPath(llvm::StringRef path, 127 ConstString demangled) const override; 128 129 ConstString 130 GetDemangledFunctionNameWithoutArguments(Mangled mangled) const override; 131 132 static bool IsCPPMangledName(llvm::StringRef name); 133 134 // Extract C++ context and identifier from a string using heuristic matching 135 // (as opposed to 136 // CPlusPlusLanguage::MethodName which has to have a fully qualified C++ name 137 // with parens and arguments. 138 // If the name is a lone C identifier (e.g. C) or a qualified C identifier 139 // (e.g. A::B::C) it will return true, 140 // and identifier will be the identifier (C and C respectively) and the 141 // context will be "" and "A::B" respectively. 142 // If the name fails the heuristic matching for a qualified or unqualified 143 // C/C++ identifier, then it will return false 144 // and identifier and context will be unchanged. 145 146 static bool ExtractContextAndIdentifier(const char *name, 147 llvm::StringRef &context, 148 llvm::StringRef &identifier); 149 150 std::vector<ConstString> 151 GenerateAlternateFunctionManglings(const ConstString mangled) const override; 152 153 ConstString FindBestAlternateFunctionMangledName( 154 const Mangled mangled, const SymbolContext &sym_ctx) const override; 155 156 // PluginInterface protocol 157 llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); } 158 }; 159 160 } // namespace lldb_private 161 162 #endif // LLDB_SOURCE_PLUGINS_LANGUAGE_CPLUSPLUS_CPLUSPLUSLANGUAGE_H 163