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:
MethodName()30     MethodName()
31         : m_full(), m_basename(), m_context(), m_arguments(), m_qualifiers() {}
32 
MethodName(ConstString s)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 
IsValid()39     bool IsValid() {
40       if (!m_parsed)
41         Parse();
42       if (m_parse_error)
43         return false;
44       return (bool)m_full;
45     }
46 
GetFullName()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 
GetLanguageType()102   lldb::LanguageType GetLanguageType() const override {
103     return lldb::eLanguageTypeC_plus_plus;
104   }
105 
GetUserEntryPointName()106   llvm::StringRef GetUserEntryPointName() const override { return "main"; }
107 
108   std::unique_ptr<TypeScavenger> GetTypeScavenger() override;
109   lldb::TypeCategoryImplSP GetFormatters() override;
110 
111   HardcodedFormatters::HardcodedSummaryFinder GetHardcodedSummaries() override;
112 
113   HardcodedFormatters::HardcodedSyntheticFinder
114   GetHardcodedSynthetics() override;
115 
116   bool IsNilReference(ValueObject &valobj) override;
117 
GetNilReferenceSummaryString()118   llvm::StringRef GetNilReferenceSummaryString() override { return "nullptr"; }
119 
120   bool IsSourceFile(llvm::StringRef file_path) const override;
121 
GetHighlighter()122   const Highlighter *GetHighlighter() const override { return &m_highlighter; }
123 
124   // Static Functions
125   static void Initialize();
126 
127   static void Terminate();
128 
129   static lldb_private::Language *CreateInstance(lldb::LanguageType language);
130 
GetPluginNameStatic()131   static llvm::StringRef GetPluginNameStatic() { return "cplusplus"; }
132 
133   bool SymbolNameFitsToLanguage(Mangled mangled) const override;
134 
135   bool DemangledNameContainsPath(llvm::StringRef path,
136                                  ConstString demangled) const override;
137 
138   ConstString
139   GetDemangledFunctionNameWithoutArguments(Mangled mangled) const override;
140 
141   bool GetFunctionDisplayName(const SymbolContext *sc,
142                               const ExecutionContext *exe_ctx,
143                               FunctionNameRepresentation representation,
144                               Stream &s) override;
145 
146   static bool IsCPPMangledName(llvm::StringRef name);
147 
148   // Extract C++ context and identifier from a string using heuristic matching
149   // (as opposed to
150   // CPlusPlusLanguage::MethodName which has to have a fully qualified C++ name
151   // with parens and arguments.
152   // If the name is a lone C identifier (e.g. C) or a qualified C identifier
153   // (e.g. A::B::C) it will return true,
154   // and identifier will be the identifier (C and C respectively) and the
155   // context will be "" and "A::B" respectively.
156   // If the name fails the heuristic matching for a qualified or unqualified
157   // C/C++ identifier, then it will return false
158   // and identifier and context will be unchanged.
159 
160   static bool ExtractContextAndIdentifier(const char *name,
161                                           llvm::StringRef &context,
162                                           llvm::StringRef &identifier);
163 
164   std::vector<ConstString>
165   GenerateAlternateFunctionManglings(const ConstString mangled) const override;
166 
167   ConstString FindBestAlternateFunctionMangledName(
168       const Mangled mangled, const SymbolContext &sym_ctx) const override;
169 
GetInstanceVariableName()170   llvm::StringRef GetInstanceVariableName() override { return "this"; }
171 
172   // PluginInterface protocol
GetPluginName()173   llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
174 };
175 
176 } // namespace lldb_private
177 
178 #endif // LLDB_SOURCE_PLUGINS_LANGUAGE_CPLUSPLUS_CPLUSPLUSLANGUAGE_H
179