1 //===-- SBSymbolContext.cpp -------------------------------------*- 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 #include "lldb/API/SBSymbolContext.h"
10 #include "lldb/API/SBStream.h"
11 #include "lldb/Core/Module.h"
12 #include "lldb/Symbol/Function.h"
13 #include "lldb/Symbol/Symbol.h"
14 #include "lldb/Symbol/SymbolContext.h"
15 #include "lldb/Utility/Log.h"
16 
17 using namespace lldb;
18 using namespace lldb_private;
19 
20 SBSymbolContext::SBSymbolContext() : m_opaque_ap() {}
21 
22 SBSymbolContext::SBSymbolContext(const SymbolContext *sc_ptr) : m_opaque_ap() {
23   if (sc_ptr)
24     m_opaque_ap.reset(new SymbolContext(*sc_ptr));
25 }
26 
27 SBSymbolContext::SBSymbolContext(const SBSymbolContext &rhs) : m_opaque_ap() {
28   if (rhs.IsValid()) {
29     if (m_opaque_ap)
30       *m_opaque_ap = *rhs.m_opaque_ap;
31     else
32       ref() = *rhs.m_opaque_ap;
33   }
34 }
35 
36 SBSymbolContext::~SBSymbolContext() {}
37 
38 const SBSymbolContext &SBSymbolContext::operator=(const SBSymbolContext &rhs) {
39   if (this != &rhs) {
40     if (rhs.IsValid())
41       m_opaque_ap.reset(new lldb_private::SymbolContext(*rhs.m_opaque_ap));
42   }
43   return *this;
44 }
45 
46 void SBSymbolContext::SetSymbolContext(const SymbolContext *sc_ptr) {
47   if (sc_ptr) {
48     if (m_opaque_ap)
49       *m_opaque_ap = *sc_ptr;
50     else
51       m_opaque_ap.reset(new SymbolContext(*sc_ptr));
52   } else {
53     if (m_opaque_ap)
54       m_opaque_ap->Clear(true);
55   }
56 }
57 
58 bool SBSymbolContext::IsValid() const { return m_opaque_ap != NULL; }
59 
60 SBModule SBSymbolContext::GetModule() {
61   Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
62 
63   SBModule sb_module;
64   ModuleSP module_sp;
65   if (m_opaque_ap) {
66     module_sp = m_opaque_ap->module_sp;
67     sb_module.SetSP(module_sp);
68   }
69 
70   if (log) {
71     SBStream sstr;
72     sb_module.GetDescription(sstr);
73     log->Printf("SBSymbolContext(%p)::GetModule () => SBModule(%p): %s",
74                 static_cast<void *>(m_opaque_ap.get()),
75                 static_cast<void *>(module_sp.get()), sstr.GetData());
76   }
77 
78   return sb_module;
79 }
80 
81 SBCompileUnit SBSymbolContext::GetCompileUnit() {
82   return SBCompileUnit(m_opaque_ap ? m_opaque_ap->comp_unit : NULL);
83 }
84 
85 SBFunction SBSymbolContext::GetFunction() {
86   Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
87 
88   Function *function = NULL;
89 
90   if (m_opaque_ap)
91     function = m_opaque_ap->function;
92 
93   SBFunction sb_function(function);
94 
95   if (log)
96     log->Printf("SBSymbolContext(%p)::GetFunction () => SBFunction(%p)",
97                 static_cast<void *>(m_opaque_ap.get()),
98                 static_cast<void *>(function));
99 
100   return sb_function;
101 }
102 
103 SBBlock SBSymbolContext::GetBlock() {
104   return SBBlock(m_opaque_ap ? m_opaque_ap->block : NULL);
105 }
106 
107 SBLineEntry SBSymbolContext::GetLineEntry() {
108   Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
109 
110   SBLineEntry sb_line_entry;
111   if (m_opaque_ap)
112     sb_line_entry.SetLineEntry(m_opaque_ap->line_entry);
113 
114   if (log) {
115     log->Printf("SBSymbolContext(%p)::GetLineEntry () => SBLineEntry(%p)",
116                 static_cast<void *>(m_opaque_ap.get()),
117                 static_cast<void *>(sb_line_entry.get()));
118   }
119 
120   return sb_line_entry;
121 }
122 
123 SBSymbol SBSymbolContext::GetSymbol() {
124   Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_API));
125 
126   Symbol *symbol = NULL;
127 
128   if (m_opaque_ap)
129     symbol = m_opaque_ap->symbol;
130 
131   SBSymbol sb_symbol(symbol);
132 
133   if (log)
134     log->Printf("SBSymbolContext(%p)::GetSymbol () => SBSymbol(%p)",
135                 static_cast<void *>(m_opaque_ap.get()),
136                 static_cast<void *>(symbol));
137 
138   return sb_symbol;
139 }
140 
141 void SBSymbolContext::SetModule(lldb::SBModule module) {
142   ref().module_sp = module.GetSP();
143 }
144 
145 void SBSymbolContext::SetCompileUnit(lldb::SBCompileUnit compile_unit) {
146   ref().comp_unit = compile_unit.get();
147 }
148 
149 void SBSymbolContext::SetFunction(lldb::SBFunction function) {
150   ref().function = function.get();
151 }
152 
153 void SBSymbolContext::SetBlock(lldb::SBBlock block) {
154   ref().block = block.GetPtr();
155 }
156 
157 void SBSymbolContext::SetLineEntry(lldb::SBLineEntry line_entry) {
158   if (line_entry.IsValid())
159     ref().line_entry = line_entry.ref();
160   else
161     ref().line_entry.Clear();
162 }
163 
164 void SBSymbolContext::SetSymbol(lldb::SBSymbol symbol) {
165   ref().symbol = symbol.get();
166 }
167 
168 lldb_private::SymbolContext *SBSymbolContext::operator->() const {
169   return m_opaque_ap.get();
170 }
171 
172 const lldb_private::SymbolContext &SBSymbolContext::operator*() const {
173   assert(m_opaque_ap.get());
174   return *m_opaque_ap;
175 }
176 
177 lldb_private::SymbolContext &SBSymbolContext::operator*() {
178   if (m_opaque_ap == NULL)
179     m_opaque_ap.reset(new SymbolContext);
180   return *m_opaque_ap;
181 }
182 
183 lldb_private::SymbolContext &SBSymbolContext::ref() {
184   if (m_opaque_ap == NULL)
185     m_opaque_ap.reset(new SymbolContext);
186   return *m_opaque_ap;
187 }
188 
189 lldb_private::SymbolContext *SBSymbolContext::get() const {
190   return m_opaque_ap.get();
191 }
192 
193 bool SBSymbolContext::GetDescription(SBStream &description) {
194   Stream &strm = description.ref();
195 
196   if (m_opaque_ap) {
197     m_opaque_ap->GetDescription(&strm, lldb::eDescriptionLevelFull, NULL);
198   } else
199     strm.PutCString("No value");
200 
201   return true;
202 }
203 
204 SBSymbolContext
205 SBSymbolContext::GetParentOfInlinedScope(const SBAddress &curr_frame_pc,
206                                          SBAddress &parent_frame_addr) const {
207   SBSymbolContext sb_sc;
208   if (m_opaque_ap.get() && curr_frame_pc.IsValid()) {
209     if (m_opaque_ap->GetParentOfInlinedScope(curr_frame_pc.ref(), sb_sc.ref(),
210                                              parent_frame_addr.ref()))
211       return sb_sc;
212   }
213   return SBSymbolContext();
214 }
215