LLDB mainline
SBCompileUnit.cpp
Go to the documentation of this file.
1//===-- SBCompileUnit.cpp -------------------------------------------------===//
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
11#include "lldb/API/SBStream.h"
12#include "lldb/Core/Module.h"
17#include "lldb/Symbol/Type.h"
20
21using namespace lldb;
22using namespace lldb_private;
23
25
27 : m_opaque_ptr(lldb_object_ptr) {}
28
30 : m_opaque_ptr(rhs.m_opaque_ptr) {
31 LLDB_INSTRUMENT_VA(this, rhs);
32}
33
35 LLDB_INSTRUMENT_VA(this, rhs);
36
38 return *this;
39}
40
42
45
46 SBFileSpec file_spec;
47 if (m_opaque_ptr)
49 return file_spec;
50}
51
54
55 if (m_opaque_ptr) {
56 LineTable *line_table = m_opaque_ptr->GetLineTable();
57 if (line_table) {
58 return line_table->GetSize();
59 }
60 }
61 return 0;
62}
63
65 LLDB_INSTRUMENT_VA(this, idx);
66
67 SBLineEntry sb_line_entry;
68 if (m_opaque_ptr) {
69 LineTable *line_table = m_opaque_ptr->GetLineTable();
70 if (line_table) {
71 LineEntry line_entry;
72 if (line_table->GetLineEntryAtIndex(idx, line_entry))
73 sb_line_entry.SetLineEntry(line_entry);
74 }
75 }
76
77 return sb_line_entry;
78}
79
81 bool exact) const {
82 LLDB_INSTRUMENT_VA(this, line_entry, exact);
83
84 if (!m_opaque_ptr || !line_entry.IsValid())
85 return UINT32_MAX;
86
87 LineEntry found_line_entry;
88
89 return m_opaque_ptr->FindLineEntry(0, line_entry.GetLine(),
90 line_entry.GetFileSpec().get(), exact,
91 &line_entry.ref());
92}
93
95 SBFileSpec *inline_file_spec) const {
96 LLDB_INSTRUMENT_VA(this, start_idx, line, inline_file_spec);
97
98 const bool exact = true;
99 return FindLineEntryIndex(start_idx, line, inline_file_spec, exact);
100}
101
103 SBFileSpec *inline_file_spec,
104 bool exact) const {
105 LLDB_INSTRUMENT_VA(this, start_idx, line, inline_file_spec, exact);
106
107 uint32_t index = UINT32_MAX;
108 if (m_opaque_ptr) {
109 FileSpec file_spec;
110 if (inline_file_spec && inline_file_spec->IsValid())
111 file_spec = inline_file_spec->ref();
112 else
113 file_spec = m_opaque_ptr->GetPrimaryFile();
114
115 LineEntry line_entry;
117 start_idx, line, inline_file_spec ? inline_file_spec->get() : nullptr,
118 exact, &line_entry);
119 }
120
121 return index;
122}
123
125 LLDB_INSTRUMENT_VA(this);
126
127 if (m_opaque_ptr)
128 return m_opaque_ptr->GetSupportFiles().GetSize();
129
130 return 0;
131}
132
134 LLDB_INSTRUMENT_VA(this, type_mask);
135
136 SBTypeList sb_type_list;
137
138 if (!m_opaque_ptr)
139 return sb_type_list;
140
141 ModuleSP module_sp(m_opaque_ptr->GetModule());
142 if (!module_sp)
143 return sb_type_list;
144
145 SymbolFile *symfile = module_sp->GetSymbolFile();
146 if (!symfile)
147 return sb_type_list;
148
149 TypeClass type_class = static_cast<TypeClass>(type_mask);
150 TypeList type_list;
151 symfile->GetTypes(m_opaque_ptr, type_class, type_list);
152 sb_type_list.m_opaque_up->Append(type_list);
153 return sb_type_list;
154}
155
157 LLDB_INSTRUMENT_VA(this, idx);
158
159 SBFileSpec sb_file_spec;
160 if (m_opaque_ptr) {
161 FileSpec spec = m_opaque_ptr->GetSupportFiles().GetFileSpecAtIndex(idx);
162 sb_file_spec.SetFileSpec(spec);
163 }
164
165 return sb_file_spec;
166}
167
169 const SBFileSpec &sb_file,
170 bool full) {
171 LLDB_INSTRUMENT_VA(this, start_idx, sb_file, full);
172
173 if (m_opaque_ptr) {
174 const FileSpecList &support_files = m_opaque_ptr->GetSupportFiles();
175 return support_files.FindFileIndex(start_idx, sb_file.ref(), full);
176 }
177 return 0;
178}
179
181 LLDB_INSTRUMENT_VA(this);
182
183 if (m_opaque_ptr)
184 return m_opaque_ptr->GetLanguage();
186}
187
189 LLDB_INSTRUMENT_VA(this);
190 return this->operator bool();
191}
192SBCompileUnit::operator bool() const {
193 LLDB_INSTRUMENT_VA(this);
194
195 return m_opaque_ptr != nullptr;
196}
197
199 LLDB_INSTRUMENT_VA(this, rhs);
200
201 return m_opaque_ptr == rhs.m_opaque_ptr;
202}
203
205 LLDB_INSTRUMENT_VA(this, rhs);
206
207 return m_opaque_ptr != rhs.m_opaque_ptr;
208}
209
211 return m_opaque_ptr;
212}
213
215 return *m_opaque_ptr;
216}
217
219
221 m_opaque_ptr = lldb_object_ptr;
222}
223
225 LLDB_INSTRUMENT_VA(this, description);
226
227 Stream &strm = description.ref();
228
229 if (m_opaque_ptr) {
230 m_opaque_ptr->Dump(&strm, false);
231 } else
232 strm.PutCString("No value");
233
234 return true;
235}
#define LLDB_INSTRUMENT_VA(...)
bool operator==(const lldb::SBCompileUnit &rhs) const
const lldb_private::CompileUnit * operator->() const
uint32_t FindLineEntryIndex(lldb::SBLineEntry &line_entry, bool exact=false) const
lldb::SBFileSpec GetFileSpec() const
lldb::SBTypeList GetTypes(uint32_t type_mask=lldb::eTypeClassAny)
Get all types matching type_mask from debug info in this compile unit.
const lldb::SBCompileUnit & operator=(const lldb::SBCompileUnit &rhs)
bool GetDescription(lldb::SBStream &description)
const lldb_private::CompileUnit & operator*() const
lldb::SBLineEntry GetLineEntryAtIndex(uint32_t idx) const
lldb_private::CompileUnit * get()
lldb_private::CompileUnit * m_opaque_ptr
Definition: SBCompileUnit.h:93
void reset(lldb_private::CompileUnit *lldb_object_ptr)
uint32_t GetNumSupportFiles() const
uint32_t FindSupportFileIndex(uint32_t start_idx, const SBFileSpec &sb_file, bool full)
SBFileSpec GetSupportFileAtIndex(uint32_t idx) const
uint32_t GetNumLineEntries() const
bool operator!=(const lldb::SBCompileUnit &rhs) const
lldb::LanguageType GetLanguage()
void SetFileSpec(const lldb_private::FileSpec &fspec)
Definition: SBFileSpec.cpp:164
const lldb_private::FileSpec & ref() const
Definition: SBFileSpec.cpp:162
const lldb_private::FileSpec * get() const
Definition: SBFileSpec.cpp:154
lldb_private::LineEntry & ref()
void SetLineEntry(const lldb_private::LineEntry &lldb_object_ref)
Definition: SBLineEntry.cpp:43
bool IsValid() const
Definition: SBLineEntry.cpp:70
uint32_t GetLine() const
Definition: SBLineEntry.cpp:90
lldb::SBFileSpec GetFileSpec() const
Definition: SBLineEntry.cpp:80
lldb_private::Stream & ref()
Definition: SBStream.cpp:176
std::unique_ptr< lldb_private::TypeListImpl > m_opaque_up
Definition: SBType.h:266
A class that describes a compilation unit.
Definition: CompileUnit.h:41
void Dump(Stream *s, bool show_context) const
Dump the compile unit contents to the stream s.
const FileSpec & GetPrimaryFile() const
Return the primary source file associated with this compile unit.
Definition: CompileUnit.h:227
const FileSpecList & GetSupportFiles()
Get the compile unit's support file list.
uint32_t FindLineEntry(uint32_t start_idx, uint32_t line, const FileSpec *file_spec_ptr, bool exact, LineEntry *line_entry)
Find the line entry by line and optional inlined file spec.
lldb::LanguageType GetLanguage()
LineTable * GetLineTable()
Get the line table for the compile unit.
A file utility class.
Definition: FileSpec.h:56
A line table class.
Definition: LineTable.h:40
bool GetLineEntryAtIndex(uint32_t idx, LineEntry &line_entry)
Get the line entry from the line table at index idx.
Definition: LineTable.cpp:179
uint32_t GetSize() const
Gets the size of the line table in number of line table entries.
Definition: LineTable.cpp:177
lldb::ModuleSP GetModule() const
Get const accessor for the module pointer.
Definition: ModuleChild.cpp:24
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
size_t PutCString(llvm::StringRef cstr)
Output a C string to the stream.
Definition: Stream.cpp:63
Provides public interface for all SymbolFiles.
Definition: SymbolFile.h:47
virtual void GetTypes(lldb_private::SymbolContextScope *sc_scope, lldb::TypeClass type_mask, lldb_private::TypeList &type_list)=0
#define UINT32_MAX
Definition: lldb-defines.h:19
A class that represents a running process on the host machine.
Definition: SBAddress.h:15
LanguageType
Programming language type.
@ eLanguageTypeUnknown
Unknown or invalid language value.
A line table entry class.
Definition: LineEntry.h:20