LLDB  mainline
CPlusPlusLanguage.h
Go to the documentation of this file.
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 
18 #include "lldb/Target/Language.h"
20 #include "lldb/lldb-private.h"
21 
22 namespace lldb_private {
23 
24 class CPlusPlusLanguage : public Language {
26 
27 public:
28  class MethodName {
29  public:
32 
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 
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 
104  }
105 
106  std::unique_ptr<TypeScavenger> GetTypeScavenger() override;
107  lldb::TypeCategoryImplSP GetFormatters() override;
108 
110 
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 
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 
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 
166  const Mangled mangled, const SymbolContext &sym_ctx) const override;
167 
168  // PluginInterface protocol
169  llvm::StringRef GetPluginName() override { return GetPluginNameStatic(); }
170 };
171 
172 } // namespace lldb_private
173 
174 #endif // LLDB_SOURCE_PLUGINS_LANGUAGE_CPLUSPLUS_CPLUSPLUSLANGUAGE_H
lldb_private::CPlusPlusLanguage::CreateInstance
static lldb_private::Language * CreateInstance(lldb::LanguageType language)
Definition: CPlusPlusLanguage.cpp:100
lldb_private::CPlusPlusLanguage::GetFormatters
lldb::TypeCategoryImplSP GetFormatters() override
lldb_private::CPlusPlusLanguage::GetDemangledFunctionNameWithoutArguments
ConstString GetDemangledFunctionNameWithoutArguments(Mangled mangled) const override
Definition: CPlusPlusLanguage.cpp:69
lldb_private::ExecutionContext
Definition: ExecutionContext.h:292
lldb_private::CPlusPlusLanguage::SymbolNameFitsToLanguage
bool SymbolNameFitsToLanguage(Mangled mangled) const override
Returns true iff the given symbol name is compatible with the mangling scheme of this language.
Definition: CPlusPlusLanguage.cpp:64
lldb_private::CPlusPlusLanguage::MethodName::Clear
void Clear()
Definition: CPlusPlusLanguage.cpp:108
lldb_private::CPlusPlusLanguage::~CPlusPlusLanguage
~CPlusPlusLanguage() override=default
lldb_private::CPlusPlusLanguage::MethodName::m_full
ConstString m_full
Definition: CPlusPlusLanguage.h:86
lldb_private::CPlusPlusLanguage::MethodName::GetReturnType
llvm::StringRef GetReturnType()
Returns the methods return-type.
Definition: CPlusPlusLanguage.cpp:298
lldb::LanguageType
LanguageType
Programming language type.
Definition: lldb-enumerations.h:443
lldb_private::CPlusPlusLanguage::MethodName::GetScopeQualifiedName
std::string GetScopeQualifiedName()
Definition: CPlusPlusLanguage.cpp:304
lldb_private::CPlusPlusLanguage::MethodName::GetBasename
llvm::StringRef GetBasename()
Definition: CPlusPlusLanguage.cpp:274
lldb_private::CPlusPlusLanguage::MethodName::GetContext
llvm::StringRef GetContext()
Definition: CPlusPlusLanguage.cpp:280
lldb_private::Stream
Definition: Stream.h:28
Language.h
lldb_private::CPlusPlusLanguage::MethodName::m_qualifiers
llvm::StringRef m_qualifiers
Definition: CPlusPlusLanguage.h:92
lldb_private::CPlusPlusLanguage::ExtractContextAndIdentifier
static bool ExtractContextAndIdentifier(const char *name, llvm::StringRef &context, llvm::StringRef &identifier)
Definition: CPlusPlusLanguage.cpp:397
lldb_private::CPlusPlusLanguage::MethodName::GetQualifiers
llvm::StringRef GetQualifiers()
Definition: CPlusPlusLanguage.cpp:292
lldb_private::CPlusPlusLanguage::MethodName::GetArguments
llvm::StringRef GetArguments()
Definition: CPlusPlusLanguage.cpp:286
lldb_private::SymbolContext
Definition: SymbolContext.h:33
lldb_private::CPlusPlusLanguage::MethodName::m_context
llvm::StringRef m_context
Definition: CPlusPlusLanguage.h:90
lldb_private::CPlusPlusLanguage::Terminate
static void Terminate()
Definition: CPlusPlusLanguage.cpp:60
lldb_private::Highlighter
Annotates source code with color attributes.
Definition: Highlighter.h:91
lldb_private::CPlusPlusLanguage::MethodName::ContainsPath
bool ContainsPath(llvm::StringRef path)
Definition: CPlusPlusLanguage.cpp:328
lldb_private::HardcodedFormatters::HardcodedSummaryFinder
HardcodedFormatterFinders< TypeSummaryImpl > HardcodedSummaryFinder
Definition: FormatClasses.h:41
lldb_private::CPlusPlusLanguage::CPlusPlusLanguage
CPlusPlusLanguage()=default
lldb_private::CPlusPlusLanguage::GetPluginName
llvm::StringRef GetPluginName() override
Definition: CPlusPlusLanguage.h:169
lldb_private::Language::FunctionNameRepresentation
FunctionNameRepresentation
Definition: Language.h:141
lldb_private::CPlusPlusLanguage::MethodName::GetFullName
ConstString GetFullName() const
Definition: CPlusPlusLanguage.h:47
lldb_private::CPlusPlusLanguage::GetTypeScavenger
std::unique_ptr< TypeScavenger > GetTypeScavenger() override
lldb_private::ConstString
Definition: ConstString.h:39
lldb_private::CPlusPlusLanguage::DemangledNameContainsPath
bool DemangledNameContainsPath(llvm::StringRef path, ConstString demangled) const override
Definition: CPlusPlusLanguage.cpp:391
lldb_private::CPlusPlusLanguage::m_highlighter
ClangHighlighter m_highlighter
Definition: CPlusPlusLanguage.h:25
ClangHighlighter.h
lldb_private::CPlusPlusLanguage::MethodName::m_return_type
llvm::StringRef m_return_type
Definition: CPlusPlusLanguage.h:93
string
string(SUBSTRING ${p} 10 -1 pStripped) if($
Definition: Plugins/CMakeLists.txt:40
lldb_private::CPlusPlusLanguage::MethodName::GetBasenameNoTemplateParameters
llvm::StringRef GetBasenameNoTemplateParameters()
Returns the Basename of this method without a template parameter list, if any.
Definition: CPlusPlusLanguage.cpp:318
lldb_private::CPlusPlusLanguage::FindBestAlternateFunctionMangledName
ConstString FindBestAlternateFunctionMangledName(const Mangled mangled, const SymbolContext &sym_ctx) const override
Definition: CPlusPlusLanguage.cpp:586
lldb-private.h
lldb_private::CPlusPlusLanguage::GetPluginNameStatic
static llvm::StringRef GetPluginNameStatic()
Definition: CPlusPlusLanguage.h:129
lldb_private::CPlusPlusLanguage::MethodName::MethodName
MethodName()
Definition: CPlusPlusLanguage.h:30
lldb_private::CPlusPlusLanguage::GenerateAlternateFunctionManglings
std::vector< ConstString > GenerateAlternateFunctionManglings(const ConstString mangled) const override
Definition: CPlusPlusLanguage.cpp:532
lldb_private::ValueObject
ValueObject:
Definition: ValueObject.h:105
lldb_private::CPlusPlusLanguage::MethodName::TrySimplifiedParse
bool TrySimplifiedParse()
Definition: CPlusPlusLanguage.cpp:210
lldb_private::Language
Definition: Language.h:29
lldb_private::CPlusPlusLanguage::IsNilReference
bool IsNilReference(ValueObject &valobj) override
lldb_private::CPlusPlusLanguage::MethodName::MethodName
MethodName(ConstString s)
Definition: CPlusPlusLanguage.h:33
lldb_private::CPlusPlusLanguage::MethodName
Definition: CPlusPlusLanguage.h:28
lldb_private::CPlusPlusLanguage::GetHardcodedSynthetics
HardcodedFormatters::HardcodedSyntheticFinder GetHardcodedSynthetics() override
lldb_private::CPlusPlusLanguage::Initialize
static void Initialize()
Definition: CPlusPlusLanguage.cpp:55
lldb_private::CPlusPlusLanguage::MethodName::m_parsed
bool m_parsed
Definition: CPlusPlusLanguage.h:94
lldb_private::CPlusPlusLanguage::GetLanguageType
lldb::LanguageType GetLanguageType() const override
Definition: CPlusPlusLanguage.h:102
lldb_private::CPlusPlusLanguage::IsCPPMangledName
static bool IsCPPMangledName(llvm::StringRef name)
Definition: CPlusPlusLanguage.cpp:379
lldb_private
A class that represents a running process on the host machine.
Definition: SBCommandInterpreterRunOptions.h:16
lldb_private::CPlusPlusLanguage::GetHighlighter
const Highlighter * GetHighlighter() const override
Definition: CPlusPlusLanguage.h:120
lldb_private::CPlusPlusLanguage
Definition: CPlusPlusLanguage.h:24
lldb_private::CPlusPlusLanguage::GetHardcodedSummaries
HardcodedFormatters::HardcodedSummaryFinder GetHardcodedSummaries() override
lldb_private::CPlusPlusLanguage::MethodName::m_arguments
llvm::StringRef m_arguments
Definition: CPlusPlusLanguage.h:91
lldb_private::ClangHighlighter
Definition: ClangHighlighter.h:20
ConstString.h
lldb_private::CPlusPlusLanguage::GetFunctionDisplayName
bool GetFunctionDisplayName(const SymbolContext *sc, const ExecutionContext *exe_ctx, FunctionNameRepresentation representation, Stream &s) override
lldb_private::CPlusPlusLanguage::GetNilReferenceSummaryString
llvm::StringRef GetNilReferenceSummaryString() override
Returns the summary string for ValueObjects for which IsNilReference() is true.
Definition: CPlusPlusLanguage.h:116
lldb_private::CPlusPlusLanguage::MethodName::IsValid
bool IsValid()
Definition: CPlusPlusLanguage.h:39
lldb_private::CPlusPlusLanguage::IsSourceFile
bool IsSourceFile(llvm::StringRef file_path) const override
lldb_private::CPlusPlusLanguage::MethodName::Parse
void Parse()
Definition: CPlusPlusLanguage.cpp:253
lldb_private::CPlusPlusLanguage::MethodName::m_basename
llvm::StringRef m_basename
Definition: CPlusPlusLanguage.h:89
lldb_private::CPlusPlusLanguage::MethodName::m_parse_error
bool m_parse_error
Definition: CPlusPlusLanguage.h:95
lldb_private::HardcodedFormatters::HardcodedSyntheticFinder
HardcodedFormatterFinders< SyntheticChildren > HardcodedSyntheticFinder
Definition: FormatClasses.h:42
lldb::eLanguageTypeC_plus_plus
@ eLanguageTypeC_plus_plus
ISO C++:1998.
Definition: lldb-enumerations.h:448