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 /// Returns the methods return-type. 60 /// 61 /// Currently returns an empty llvm::StringRef 62 /// if the return-type is a function pointer. 63 llvm::StringRef GetReturnType(); 64 65 bool ContainsPath(llvm::StringRef path); 66 67 private: 68 /// Returns the Basename of this method without a template parameter 69 /// list, if any. 70 /// 71 // Examples: 72 // 73 // +--------------------------------+---------+ 74 // | MethodName | Returns | 75 // +--------------------------------+---------+ 76 // | void func() | func | 77 // | void func<int>() | func | 78 // | void func<std::vector<int>>() | func | 79 // +--------------------------------+---------+ 80 llvm::StringRef GetBasenameNoTemplateParameters(); 81 82 protected: 83 void Parse(); 84 bool TrySimplifiedParse(); 85 86 ConstString m_full; // Full name: 87 // "size_t lldb::SBTarget::GetBreakpointAtIndex(unsigned 88 // int) const" 89 llvm::StringRef m_basename; // Basename: "GetBreakpointAtIndex" 90 llvm::StringRef m_context; // Decl context: "lldb::SBTarget" 91 llvm::StringRef m_arguments; // Arguments: "(unsigned int)" 92 llvm::StringRef m_qualifiers; // Qualifiers: "const" 93 llvm::StringRef m_return_type; // Return type: "size_t" 94 bool m_parsed = false; 95 bool m_parse_error = false; 96 }; 97 98 CPlusPlusLanguage() = default; 99 100 ~CPlusPlusLanguage() override = default; 101 102 lldb::LanguageType GetLanguageType() const override { 103 return lldb::eLanguageTypeC_plus_plus; 104 } 105 106 std::unique_ptr<TypeScavenger> GetTypeScavenger() override; 107 lldb::TypeCategoryImplSP GetFormatters() override; 108 109 HardcodedFormatters::HardcodedSummaryFinder GetHardcodedSummaries() override; 110 111 HardcodedFormatters::HardcodedSyntheticFinder 112 GetHardcodedSynthetics() override; 113 114 bool IsNilReference(ValueObject &valobj) override; 115 116 llvm::StringRef GetNilReferenceSummaryString() override { return "nullptr"; } 117 118 bool IsSourceFile(llvm::StringRef file_path) const override; 119 120 const Highlighter *GetHighlighter() const override { return &m_highlighter; } 121 122 // Static Functions 123 static void Initialize(); 124 125 static void Terminate(); 126 127 static lldb_private::Language *CreateInstance(lldb::LanguageType language); 128 129 static llvm::StringRef GetPluginNameStatic() { return "cplusplus"; } 130 131 bool SymbolNameFitsToLanguage(Mangled mangled) const override; 132 133 bool DemangledNameContainsPath(llvm::StringRef path, 134 ConstString demangled) const override; 135 136 ConstString 137 GetDemangledFunctionNameWithoutArguments(Mangled mangled) const override; 138 139 bool GetFunctionDisplayName(const SymbolContext *sc, 140 const ExecutionContext *exe_ctx, 141 FunctionNameRepresentation representation, 142 Stream &s) override; 143 144 static bool IsCPPMangledName(llvm::StringRef name); 145 146 // Extract C++ context and identifier from a string using heuristic matching 147 // (as opposed to 148 // CPlusPlusLanguage::MethodName which has to have a fully qualified C++ name 149 // with parens and arguments. 150 // If the name is a lone C identifier (e.g. C) or a qualified C identifier 151 // (e.g. A::B::C) it will return true, 152 // and identifier will be the identifier (C and C respectively) and the 153 // context will be "" and "A::B" respectively. 154 // If the name fails the heuristic matching for a qualified or unqualified 155 // C/C++ identifier, then it will return false 156 // and identifier and context will be unchanged. 157 158 static bool ExtractContextAndIdentifier(const char *name, 159 llvm::StringRef &context, 160 llvm::StringRef &identifier); 161 162 std::vector<ConstString> 163 GenerateAlternateFunctionManglings(const ConstString mangled) const override; 164 165 ConstString FindBestAlternateFunctionMangledName( 166 const Mangled mangled, const SymbolContext &sym_ctx) const override; 167 168 llvm::StringRef GetInstanceVariableName() override { return "this"; } 169 170 // PluginInterface protocol 171 llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); } 172 }; 173 174 } // namespace lldb_private 175 176 #endif // LLDB_SOURCE_PLUGINS_LANGUAGE_CPLUSPLUS_CPLUSPLUSLANGUAGE_H 177