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   protected:
62     void Parse();
63     bool TrySimplifiedParse();
64 
65     ConstString m_full; // Full name:
66                         // "lldb::SBTarget::GetBreakpointAtIndex(unsigned int)
67                         // const"
68     llvm::StringRef m_basename;   // Basename:     "GetBreakpointAtIndex"
69     llvm::StringRef m_context;    // Decl context: "lldb::SBTarget"
70     llvm::StringRef m_arguments;  // Arguments:    "(unsigned int)"
71     llvm::StringRef m_qualifiers; // Qualifiers:   "const"
72     bool m_parsed = false;
73     bool m_parse_error = false;
74   };
75 
76   CPlusPlusLanguage() = default;
77 
78   ~CPlusPlusLanguage() override = default;
79 
80   lldb::LanguageType GetLanguageType() const override {
81     return lldb::eLanguageTypeC_plus_plus;
82   }
83 
84   std::unique_ptr<TypeScavenger> GetTypeScavenger() override;
85   lldb::TypeCategoryImplSP GetFormatters() override;
86 
87   HardcodedFormatters::HardcodedSummaryFinder GetHardcodedSummaries() override;
88 
89   HardcodedFormatters::HardcodedSyntheticFinder
90   GetHardcodedSynthetics() override;
91 
92   bool IsNilReference(ValueObject &valobj) override;
93 
94   llvm::StringRef GetNilReferenceSummaryString() override { return "nullptr"; }
95 
96   bool IsSourceFile(llvm::StringRef file_path) const override;
97 
98   const Highlighter *GetHighlighter() const override { return &m_highlighter; }
99 
100   // Static Functions
101   static void Initialize();
102 
103   static void Terminate();
104 
105   static lldb_private::Language *CreateInstance(lldb::LanguageType language);
106 
107   static llvm::StringRef GetPluginNameStatic() { return "cplusplus"; }
108 
109   bool SymbolNameFitsToLanguage(Mangled mangled) const override;
110 
111   bool DemangledNameContainsPath(llvm::StringRef path,
112                                  ConstString demangled) const override;
113 
114   ConstString
115   GetDemangledFunctionNameWithoutArguments(Mangled mangled) const override;
116 
117   static bool IsCPPMangledName(llvm::StringRef name);
118 
119   // Extract C++ context and identifier from a string using heuristic matching
120   // (as opposed to
121   // CPlusPlusLanguage::MethodName which has to have a fully qualified C++ name
122   // with parens and arguments.
123   // If the name is a lone C identifier (e.g. C) or a qualified C identifier
124   // (e.g. A::B::C) it will return true,
125   // and identifier will be the identifier (C and C respectively) and the
126   // context will be "" and "A::B" respectively.
127   // If the name fails the heuristic matching for a qualified or unqualified
128   // C/C++ identifier, then it will return false
129   // and identifier and context will be unchanged.
130 
131   static bool ExtractContextAndIdentifier(const char *name,
132                                           llvm::StringRef &context,
133                                           llvm::StringRef &identifier);
134 
135   std::vector<ConstString>
136   GenerateAlternateFunctionManglings(const ConstString mangled) const override;
137 
138   ConstString FindBestAlternateFunctionMangledName(
139       const Mangled mangled, const SymbolContext &sym_ctx) const override;
140 
141   // PluginInterface protocol
142   llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
143 };
144 
145 } // namespace lldb_private
146 
147 #endif // LLDB_SOURCE_PLUGINS_LANGUAGE_CPLUSPLUS_CPLUSPLUSLANGUAGE_H
148