LLDB mainline
Variable.cpp
Go to the documentation of this file.
1//===-- Variable.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
10
11#include "lldb/Core/Module.h"
14#include "lldb/Symbol/Block.h"
21#include "lldb/Symbol/Type.h"
24#include "lldb/Target/ABI.h"
25#include "lldb/Target/Process.h"
28#include "lldb/Target/Target.h"
29#include "lldb/Target/Thread.h"
31#include "lldb/Utility/Stream.h"
32
33#include "llvm/ADT/Twine.h"
34
35using namespace lldb;
36using namespace lldb_private;
37
38Variable::Variable(lldb::user_id_t uid, const char *name, const char *mangled,
39 const lldb::SymbolFileTypeSP &symfile_type_sp,
40 ValueType scope, SymbolContextScope *context,
41 const RangeList &scope_range, Declaration *decl_ptr,
42 const DWARFExpressionList &location_list, bool external,
43 bool artificial, bool location_is_constant_data,
44 bool static_member)
45 : UserID(uid), m_name(name), m_mangled(ConstString(mangled)),
46 m_symfile_type_sp(symfile_type_sp), m_scope(scope),
47 m_owner_scope(context), m_scope_range(scope_range),
48 m_declaration(decl_ptr), m_location_list(location_list), m_external(external),
49 m_artificial(artificial), m_loc_is_const_data(location_is_constant_data),
50 m_static_member(static_member) {}
51
52Variable::~Variable() = default;
53
57 return lang;
58
60 if ((lang = func->GetLanguage()) != lldb::eLanguageTypeUnknown)
61 return lang;
62 } else if (auto *comp_unit =
64 if ((lang = comp_unit->GetLanguage()) != lldb::eLanguageTypeUnknown)
65 return lang;
66 }
67
69}
70
73 if (name)
74 return name;
75 return m_name;
76}
77
79
81 if (m_name == name)
82 return true;
83 SymbolContext variable_sc;
85
86 return m_mangled.NameMatches(name);
87}
88bool Variable::NameMatches(const RegularExpression &regex) const {
89 if (regex.Execute(m_name.AsCString()))
90 return true;
91 if (m_mangled)
92 return m_mangled.NameMatches(regex);
93 return false;
94}
95
98 return m_symfile_type_sp->GetType();
99 return nullptr;
100}
101
102void Variable::Dump(Stream *s, bool show_context) const {
103 s->Printf("%p: ", static_cast<const void *>(this));
104 s->Indent();
105 *s << "Variable" << (const UserID &)*this;
106
107 if (m_name)
108 *s << ", name = \"" << m_name << "\"";
109
110 if (m_symfile_type_sp) {
111 Type *type = m_symfile_type_sp->GetType();
112 if (type) {
113 s->Format(", type = {{{0:x-16}} {1} (", type->GetID(), type);
114 type->DumpTypeName(s);
115 s->PutChar(')');
116 }
117 }
118
119 if (m_scope != eValueTypeInvalid) {
120 s->PutCString(", scope = ");
121 switch (m_scope) {
123 s->PutCString(m_external ? "global" : "static");
124 break;
126 s->PutCString("parameter");
127 break;
129 s->PutCString("local");
130 break;
132 s->PutCString("thread local");
133 break;
134 default:
135 s->AsRawOstream() << "??? (" << m_scope << ')';
136 }
137 }
138
139 if (show_context && m_owner_scope != nullptr) {
140 s->PutCString(", context = ( ");
142 s->PutCString(" )");
143 }
144
145 bool show_fullpaths = false;
146 m_declaration.Dump(s, show_fullpaths);
147
148 if (m_location_list.IsValid()) {
149 s->PutCString(", location = ");
150 ABISP abi;
151 if (m_owner_scope) {
153 if (module_sp)
154 abi = ABI::FindPlugin(ProcessSP(), module_sp->GetArchitecture());
155 }
157 }
158
159 if (m_external)
160 s->PutCString(", external");
161
162 if (m_artificial)
163 s->PutCString(", artificial");
164
165 s->EOL();
166}
167
168bool Variable::DumpDeclaration(Stream *s, bool show_fullpaths,
169 bool show_module) {
170 bool dumped_declaration_info = false;
171 if (m_owner_scope) {
172 SymbolContext sc;
174 sc.block = nullptr;
175 sc.line_entry.Clear();
176 bool show_inlined_frames = false;
177 const bool show_function_arguments = true;
178 const bool show_function_name = true;
179
180 dumped_declaration_info = sc.DumpStopContext(
181 s, nullptr, Address(), show_fullpaths, show_module, show_inlined_frames,
182 show_function_arguments, show_function_name);
183
184 if (sc.function)
185 s->PutChar(':');
186 }
187 if (m_declaration.DumpStopContext(s, false))
188 dumped_declaration_info = true;
189 return dumped_declaration_info;
190}
191
192size_t Variable::MemorySize() const { return sizeof(Variable); }
193
195 Type *type = GetType();
196 if (type)
198 return CompilerDeclContext();
199}
200
202 Type *type = GetType();
203 return type ? type->GetSymbolFile()->GetDeclForUID(GetID()) : CompilerDecl();
204}
205
207 if (m_owner_scope) {
209 sc->variable = this;
210 } else
211 sc->Clear(false);
212}
213
215 if (frame) {
216 Function *function =
217 frame->GetSymbolContext(eSymbolContextFunction).function;
218 if (function) {
219 TargetSP target_sp(frame->CalculateTarget());
220
221 addr_t loclist_base_load_addr =
223 target_sp.get());
224 if (loclist_base_load_addr == LLDB_INVALID_ADDRESS)
225 return false;
226 // It is a location list. We just need to tell if the location list
227 // contains the current address when converted to a load address
229 loclist_base_load_addr,
230 frame->GetFrameCodeAddress().GetLoadAddress(target_sp.get()));
231 }
232 }
233 return false;
234}
235
237 // Be sure to resolve the address to section offset prior to calling this
238 // function.
239 if (address.IsSectionOffset()) {
240 // We need to check if the address is valid for both scope range and value
241 // range.
242 // Empty scope range means block range.
243 bool valid_in_scope_range =
245 address.GetFileAddress()) != nullptr;
246 if (!valid_in_scope_range)
247 return false;
248 SymbolContext sc;
250 if (sc.module_sp == address.GetModule()) {
251 // Is the variable is described by a single location?
253 // Yes it is, the location is valid.
254 return true;
255 }
256
257 if (sc.function) {
258 addr_t loclist_base_file_addr =
260 if (loclist_base_file_addr == LLDB_INVALID_ADDRESS)
261 return false;
262 // It is a location list. We just need to tell if the location list
263 // contains the current address when converted to a load address
264 return m_location_list.ContainsAddress(loclist_base_file_addr,
265 address.GetFileAddress());
266 }
267 }
268 }
269 return false;
270}
271
273 switch (m_scope) {
276 return frame != nullptr;
277
282 return true;
283
286 if (frame) {
287 // We don't have a location list, we just need to see if the block that
288 // this variable was defined in is currently
289 Block *deepest_frame_block =
290 frame->GetSymbolContext(eSymbolContextBlock).block;
291 if (deepest_frame_block) {
292 SymbolContext variable_sc;
293 CalculateSymbolContext(&variable_sc);
294
295 // Check for static or global variable defined at the compile unit
296 // level that wasn't defined in a block
297 if (variable_sc.block == nullptr)
298 return true;
299
300 // Check if the variable is valid in the current block
301 if (variable_sc.block != deepest_frame_block &&
302 !variable_sc.block->Contains(deepest_frame_block))
303 return false;
304
305 // If no scope range is specified then it means that the scope is the
306 // same as the scope of the enclosing lexical block.
308 return true;
309
310 addr_t file_address = frame->GetFrameCodeAddress().GetFileAddress();
311 return m_scope_range.FindEntryThatContains(file_address) != nullptr;
312 }
313 }
314 break;
315
316 default:
317 break;
318 }
319 return false;
320}
321
323 llvm::StringRef variable_expr_path, ExecutionContextScope *scope,
324 GetVariableCallback callback, void *baton, VariableList &variable_list,
325 ValueObjectList &valobj_list) {
327 if (!callback || variable_expr_path.empty()) {
328 error.SetErrorString("unknown error");
329 return error;
330 }
331
332 switch (variable_expr_path.front()) {
333 case '*':
335 variable_expr_path.drop_front(), scope, callback, baton, variable_list,
336 valobj_list);
337 if (error.Fail()) {
338 error.SetErrorString("unknown error");
339 return error;
340 }
341 for (uint32_t i = 0; i < valobj_list.GetSize();) {
342 Status tmp_error;
343 ValueObjectSP valobj_sp(
344 valobj_list.GetValueObjectAtIndex(i)->Dereference(tmp_error));
345 if (tmp_error.Fail()) {
346 variable_list.RemoveVariableAtIndex(i);
347 valobj_list.RemoveValueObjectAtIndex(i);
348 } else {
349 valobj_list.SetValueObjectAtIndex(i, valobj_sp);
350 ++i;
351 }
352 }
353 return error;
354 case '&': {
356 variable_expr_path.drop_front(), scope, callback, baton, variable_list,
357 valobj_list);
358 if (error.Success()) {
359 for (uint32_t i = 0; i < valobj_list.GetSize();) {
360 Status tmp_error;
361 ValueObjectSP valobj_sp(
362 valobj_list.GetValueObjectAtIndex(i)->AddressOf(tmp_error));
363 if (tmp_error.Fail()) {
364 variable_list.RemoveVariableAtIndex(i);
365 valobj_list.RemoveValueObjectAtIndex(i);
366 } else {
367 valobj_list.SetValueObjectAtIndex(i, valobj_sp);
368 ++i;
369 }
370 }
371 } else {
372 error.SetErrorString("unknown error");
373 }
374 return error;
375 } break;
376
377 default: {
378 static RegularExpression g_regex(
379 llvm::StringRef("^([A-Za-z_:][A-Za-z_0-9:]*)(.*)"));
380 llvm::SmallVector<llvm::StringRef, 2> matches;
381 variable_list.Clear();
382 if (!g_regex.Execute(variable_expr_path, &matches)) {
383 error.SetErrorStringWithFormatv(
384 "unable to extract a variable name from '{0}'", variable_expr_path);
385 return error;
386 }
387 std::string variable_name = matches[1].str();
388 if (!callback(baton, variable_name.c_str(), variable_list)) {
389 error.SetErrorString("unknown error");
390 return error;
391 }
392 uint32_t i = 0;
393 while (i < variable_list.GetSize()) {
394 VariableSP var_sp(variable_list.GetVariableAtIndex(i));
395 ValueObjectSP valobj_sp;
396 if (!var_sp) {
397 variable_list.RemoveVariableAtIndex(i);
398 continue;
399 }
400 ValueObjectSP variable_valobj_sp(
401 ValueObjectVariable::Create(scope, var_sp));
402 if (!variable_valobj_sp) {
403 variable_list.RemoveVariableAtIndex(i);
404 continue;
405 }
406
407 llvm::StringRef variable_sub_expr_path =
408 variable_expr_path.drop_front(variable_name.size());
409 if (!variable_sub_expr_path.empty()) {
410 valobj_sp = variable_valobj_sp->GetValueForExpressionPath(
411 variable_sub_expr_path);
412 if (!valobj_sp) {
413 error.SetErrorStringWithFormatv(
414 "invalid expression path '{0}' for variable '{1}'",
415 variable_sub_expr_path, var_sp->GetName().GetCString());
416 variable_list.RemoveVariableAtIndex(i);
417 continue;
418 }
419 } else {
420 // Just the name of a variable with no extras
421 valobj_sp = variable_valobj_sp;
422 }
423
424 valobj_list.Append(valobj_sp);
425 ++i;
426 }
427
428 if (variable_list.GetSize() > 0) {
429 error.Clear();
430 return error;
431 }
432 } break;
433 }
434 error.SetErrorString("unknown error");
435 return error;
436}
437
438bool Variable::DumpLocations(Stream *s, const Address &address) {
439 SymbolContext sc;
441 ABISP abi;
442 if (m_owner_scope) {
444 if (module_sp)
445 abi = ABI::FindPlugin(ProcessSP(), module_sp->GetArchitecture());
446 }
447
448 const addr_t file_addr = address.GetFileAddress();
449 if (sc.function) {
450 addr_t loclist_base_file_addr =
452 if (loclist_base_file_addr == LLDB_INVALID_ADDRESS)
453 return false;
455 loclist_base_file_addr, file_addr,
456 abi.get());
457 }
458 return false;
459}
460
461static void PrivateAutoComplete(
462 StackFrame *frame, llvm::StringRef partial_path,
463 const llvm::Twine
464 &prefix_path, // Anything that has been resolved already will be in here
465 const CompilerType &compiler_type, CompletionRequest &request);
466
468 StackFrame *frame, const std::string &partial_member_name,
469 llvm::StringRef partial_path,
470 const llvm::Twine
471 &prefix_path, // Anything that has been resolved already will be in here
472 const CompilerType &compiler_type, CompletionRequest &request) {
473
474 // We are in a type parsing child members
475 const uint32_t num_bases = compiler_type.GetNumDirectBaseClasses();
476
477 if (num_bases > 0) {
478 for (uint32_t i = 0; i < num_bases; ++i) {
479 CompilerType base_class_type =
480 compiler_type.GetDirectBaseClassAtIndex(i, nullptr);
481
482 PrivateAutoCompleteMembers(frame, partial_member_name, partial_path,
483 prefix_path,
484 base_class_type.GetCanonicalType(), request);
485 }
486 }
487
488 const uint32_t num_vbases = compiler_type.GetNumVirtualBaseClasses();
489
490 if (num_vbases > 0) {
491 for (uint32_t i = 0; i < num_vbases; ++i) {
492 CompilerType vbase_class_type =
493 compiler_type.GetVirtualBaseClassAtIndex(i, nullptr);
494
495 PrivateAutoCompleteMembers(frame, partial_member_name, partial_path,
496 prefix_path,
497 vbase_class_type.GetCanonicalType(), request);
498 }
499 }
500
501 // We are in a type parsing child members
502 const uint32_t num_fields = compiler_type.GetNumFields();
503
504 if (num_fields > 0) {
505 for (uint32_t i = 0; i < num_fields; ++i) {
506 std::string member_name;
507
508 CompilerType member_compiler_type = compiler_type.GetFieldAtIndex(
509 i, member_name, nullptr, nullptr, nullptr);
510
511 if (partial_member_name.empty() ||
512 llvm::StringRef(member_name).startswith(partial_member_name)) {
513 if (member_name == partial_member_name) {
515 frame, partial_path,
516 prefix_path + member_name, // Anything that has been resolved
517 // already will be in here
518 member_compiler_type.GetCanonicalType(), request);
519 } else {
520 request.AddCompletion((prefix_path + member_name).str());
521 }
522 }
523 }
524 }
525}
526
528 StackFrame *frame, llvm::StringRef partial_path,
529 const llvm::Twine
530 &prefix_path, // Anything that has been resolved already will be in here
531 const CompilerType &compiler_type, CompletionRequest &request) {
532 // printf ("\nPrivateAutoComplete()\n\tprefix_path = '%s'\n\tpartial_path =
533 // '%s'\n", prefix_path.c_str(), partial_path.c_str());
534 std::string remaining_partial_path;
535
536 const lldb::TypeClass type_class = compiler_type.GetTypeClass();
537 if (partial_path.empty()) {
538 if (compiler_type.IsValid()) {
539 switch (type_class) {
540 default:
541 case eTypeClassArray:
542 case eTypeClassBlockPointer:
543 case eTypeClassBuiltin:
544 case eTypeClassComplexFloat:
545 case eTypeClassComplexInteger:
546 case eTypeClassEnumeration:
547 case eTypeClassFunction:
548 case eTypeClassMemberPointer:
549 case eTypeClassReference:
550 case eTypeClassTypedef:
551 case eTypeClassVector: {
552 request.AddCompletion(prefix_path.str());
553 } break;
554
555 case eTypeClassClass:
556 case eTypeClassStruct:
557 case eTypeClassUnion:
558 if (prefix_path.str().back() != '.')
559 request.AddCompletion((prefix_path + ".").str());
560 break;
561
562 case eTypeClassObjCObject:
563 case eTypeClassObjCInterface:
564 break;
565 case eTypeClassObjCObjectPointer:
566 case eTypeClassPointer: {
567 bool omit_empty_base_classes = true;
568 if (compiler_type.GetNumChildren(omit_empty_base_classes, nullptr) > 0)
569 request.AddCompletion((prefix_path + "->").str());
570 else {
571 request.AddCompletion(prefix_path.str());
572 }
573 } break;
574 }
575 } else {
576 if (frame) {
577 const bool get_file_globals = true;
578
579 VariableList *variable_list = frame->GetVariableList(get_file_globals,
580 nullptr);
581
582 if (variable_list) {
583 for (const VariableSP &var_sp : *variable_list)
584 request.AddCompletion(var_sp->GetName().AsCString());
585 }
586 }
587 }
588 } else {
589 const char ch = partial_path[0];
590 switch (ch) {
591 case '*':
592 if (prefix_path.str().empty()) {
593 PrivateAutoComplete(frame, partial_path.substr(1), "*", compiler_type,
594 request);
595 }
596 break;
597
598 case '&':
599 if (prefix_path.isTriviallyEmpty()) {
600 PrivateAutoComplete(frame, partial_path.substr(1), std::string("&"),
601 compiler_type, request);
602 }
603 break;
604
605 case '-':
606 if (partial_path.size() > 1 && partial_path[1] == '>' &&
607 !prefix_path.str().empty()) {
608 switch (type_class) {
609 case lldb::eTypeClassPointer: {
610 CompilerType pointee_type(compiler_type.GetPointeeType());
611 if (partial_path.size() > 2 && partial_path[2]) {
612 // If there is more after the "->", then search deeper
613 PrivateAutoComplete(frame, partial_path.substr(2),
614 prefix_path + "->",
615 pointee_type.GetCanonicalType(), request);
616 } else {
617 // Nothing after the "->", so list all members
619 frame, std::string(), std::string(), prefix_path + "->",
620 pointee_type.GetCanonicalType(), request);
621 }
622 } break;
623 default:
624 break;
625 }
626 }
627 break;
628
629 case '.':
630 if (compiler_type.IsValid()) {
631 switch (type_class) {
632 case lldb::eTypeClassUnion:
633 case lldb::eTypeClassStruct:
634 case lldb::eTypeClassClass:
635 if (partial_path.size() > 1 && partial_path[1]) {
636 // If there is more after the ".", then search deeper
637 PrivateAutoComplete(frame, partial_path.substr(1),
638 prefix_path + ".", compiler_type, request);
639
640 } else {
641 // Nothing after the ".", so list all members
642 PrivateAutoCompleteMembers(frame, std::string(), partial_path,
643 prefix_path + ".", compiler_type,
644 request);
645 }
646 break;
647 default:
648 break;
649 }
650 }
651 break;
652 default:
653 if (isalpha(ch) || ch == '_' || ch == '$') {
654 const size_t partial_path_len = partial_path.size();
655 size_t pos = 1;
656 while (pos < partial_path_len) {
657 const char curr_ch = partial_path[pos];
658 if (isalnum(curr_ch) || curr_ch == '_' || curr_ch == '$') {
659 ++pos;
660 continue;
661 }
662 break;
663 }
664
665 std::string token(std::string(partial_path), 0, pos);
666 remaining_partial_path = std::string(partial_path.substr(pos));
667
668 if (compiler_type.IsValid()) {
669 PrivateAutoCompleteMembers(frame, token, remaining_partial_path,
670 prefix_path, compiler_type, request);
671 } else if (frame) {
672 // We haven't found our variable yet
673 const bool get_file_globals = true;
674
675 VariableList *variable_list =
676 frame->GetVariableList(get_file_globals, nullptr);
677
678 if (!variable_list)
679 break;
680
681 for (VariableSP var_sp : *variable_list) {
682
683 if (!var_sp)
684 continue;
685
686 llvm::StringRef variable_name = var_sp->GetName().GetStringRef();
687 if (variable_name.startswith(token)) {
688 if (variable_name == token) {
689 Type *variable_type = var_sp->GetType();
690 if (variable_type) {
691 CompilerType variable_compiler_type(
692 variable_type->GetForwardCompilerType());
694 frame, remaining_partial_path,
695 prefix_path + token, // Anything that has been resolved
696 // already will be in here
697 variable_compiler_type.GetCanonicalType(), request);
698 } else {
699 request.AddCompletion((prefix_path + variable_name).str());
700 }
701 } else if (remaining_partial_path.empty()) {
702 request.AddCompletion((prefix_path + variable_name).str());
703 }
704 }
705 }
706 }
707 }
708 break;
709 }
710 }
711}
712
714 CompletionRequest &request) {
715 CompilerType compiler_type;
716
718 "", compiler_type, request);
719}
static llvm::raw_ostream & error(Stream &strm)
static void PrivateAutoCompleteMembers(StackFrame *frame, const std::string &partial_member_name, llvm::StringRef partial_path, const llvm::Twine &prefix_path, const CompilerType &compiler_type, CompletionRequest &request)
Definition: Variable.cpp:467
static void PrivateAutoComplete(StackFrame *frame, llvm::StringRef partial_path, const llvm::Twine &prefix_path, const CompilerType &compiler_type, CompletionRequest &request)
Definition: Variable.cpp:527
static lldb::ABISP FindPlugin(lldb::ProcessSP process_sp, const ArchSpec &arch)
Definition: ABI.cpp:27
Address & GetBaseAddress()
Get accessor for the base address of the range.
Definition: AddressRange.h:209
A section + offset based address class.
Definition: Address.h:59
lldb::addr_t GetLoadAddress(Target *target) const
Get the load address.
Definition: Address.cpp:311
lldb::ModuleSP GetModule() const
Get accessor for the module for this address.
Definition: Address.cpp:283
lldb::addr_t GetFileAddress() const
Get the file address.
Definition: Address.cpp:291
bool IsSectionOffset() const
Check if an address is section offset.
Definition: Address.h:332
A class that describes a single lexical block.
Definition: Block.h:41
bool Contains(lldb::addr_t range_offset) const
Check if an offset is in one of the block offset ranges.
Definition: Block.cpp:180
Represents a generic declaration context in a program.
Represents a generic declaration such as a function declaration.
Definition: CompilerDecl.h:28
Generic representation of a type in a programming language.
Definition: CompilerType.h:36
CompilerType GetVirtualBaseClassAtIndex(size_t idx, uint32_t *bit_offset_ptr) const
CompilerType GetFieldAtIndex(size_t idx, std::string &name, uint64_t *bit_offset_ptr, uint32_t *bitfield_bit_size_ptr, bool *is_bitfield_ptr) const
lldb::TypeClass GetTypeClass() const
uint32_t GetNumVirtualBaseClasses() const
uint32_t GetNumFields() const
uint32_t GetNumDirectBaseClasses() const
uint32_t GetNumChildren(bool omit_empty_base_classes, const ExecutionContext *exe_ctx) const
CompilerType GetDirectBaseClassAtIndex(size_t idx, uint32_t *bit_offset_ptr) const
CompilerType GetPointeeType() const
If this type is a pointer type, return the type that the pointer points to, else return an invalid ty...
CompilerType GetCanonicalType() const
"lldb/Utility/ArgCompletionRequest.h"
void AddCompletion(llvm::StringRef completion, llvm::StringRef description="", CompletionMode mode=CompletionMode::Normal)
Adds a possible completion string.
llvm::StringRef GetCursorArgumentPrefix() const
A uniqued constant string class.
Definition: ConstString.h:40
const char * AsCString(const char *value_if_empty=nullptr) const
Get the string value as a C string.
Definition: ConstString.h:182
"lldb/Expression/DWARFExpressionList.h" Encapsulates a range map from file address range to a single ...
void GetDescription(Stream *s, lldb::DescriptionLevel level, ABI *abi) const
Dump all locaitons with each seperated by new line.
bool IsValid() const
Return true if the location expression contains data.
bool DumpLocations(Stream *s, lldb::DescriptionLevel level, lldb::addr_t func_load_addr, lldb::addr_t file_addr, ABI *abi) const
Dump locations that contains file_addr if it's valid.
bool ContainsAddress(lldb::addr_t func_load_addr, lldb::addr_t addr) const
Search for a load address in the dwarf location list.
A class that describes the declaration location of a lldb object.
Definition: Declaration.h:24
void Dump(Stream *s, bool show_fullpaths) const
Dump a description of this object to a Stream.
Definition: Declaration.cpp:14
bool DumpStopContext(Stream *s, bool show_fullpaths) const
Definition: Declaration.cpp:35
"lldb/Target/ExecutionContextScope.h" Inherit from this if your object can reconstruct its execution ...
"lldb/Target/ExecutionContext.h" A class that contains an execution context.
StackFrame * GetFramePtr() const
Returns a pointer to the frame object.
A class that describes a function.
Definition: Function.h:399
const AddressRange & GetAddressRange()
Definition: Function.h:447
bool NameMatches(ConstString name) const
Check if "name" matches either the mangled or demangled name.
Definition: Mangled.h:171
lldb::LanguageType GuessLanguage() const
Try to guess the language from the mangling.
Definition: Mangled.cpp:379
ConstString GetName(NamePreference preference=ePreferDemangled) const
Best name get accessor.
Definition: Mangled.cpp:323
const Entry * FindEntryThatContains(B addr) const
Definition: RangeMap.h:338
bool IsEmpty() const
Definition: RangeMap.h:293
bool Execute(llvm::StringRef string, llvm::SmallVectorImpl< llvm::StringRef > *matches=nullptr) const
Execute a regular expression match using the compiled regular expression that is already in this obje...
This base class provides an interface to stack frames.
Definition: StackFrame.h:41
VariableList * GetVariableList(bool get_file_globals, Status *error_ptr)
Retrieve the list of variables that are in scope at this StackFrame's pc.
Definition: StackFrame.cpp:424
const SymbolContext & GetSymbolContext(lldb::SymbolContextItem resolve_scope)
Provide a SymbolContext for this StackFrame's current pc value.
Definition: StackFrame.cpp:300
const Address & GetFrameCodeAddress()
Get an Address for the current pc value in this StackFrame.
Definition: StackFrame.cpp:190
lldb::TargetSP CalculateTarget() override
An error handling class.
Definition: Status.h:44
bool Fail() const
Test for error condition.
Definition: Status.cpp:181
A stream class that can stream formatted output to a file.
Definition: Stream.h:28
void Format(const char *format, Args &&... args)
Definition: Stream.h:309
llvm::raw_ostream & AsRawOstream()
Returns a raw_ostream that forwards the data to this Stream object.
Definition: Stream.h:357
size_t Indent(llvm::StringRef s="")
Indent the current line in the stream.
Definition: Stream.cpp:130
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
Definition: Stream.cpp:107
size_t PutCString(llvm::StringRef cstr)
Output a C string to the stream.
Definition: Stream.cpp:63
size_t PutChar(char ch)
Definition: Stream.cpp:104
size_t EOL()
Output and End of Line character to the stream.
Definition: Stream.cpp:128
"lldb/Symbol/SymbolContextScope.h" Inherit from this if your object is part of a symbol context and c...
virtual void DumpSymbolContext(Stream *s)=0
Dump the object's symbol context to the stream s.
virtual Function * CalculateSymbolContextFunction()
virtual CompileUnit * CalculateSymbolContextCompileUnit()
virtual void CalculateSymbolContext(SymbolContext *sc)=0
Reconstruct the object's symbol context into sc.
virtual lldb::ModuleSP CalculateSymbolContextModule()
Defines a symbol context baton that can be handed other debug core functions.
Definition: SymbolContext.h:33
bool DumpStopContext(Stream *s, ExecutionContextScope *exe_scope, const Address &so_addr, bool show_fullpaths, bool show_module, bool show_inlined_frames, bool show_function_arguments, bool show_function_name) const
Dump the stop context in this object to a Stream.
Function * function
The Function for a given query.
Block * block
The Block for a given query.
lldb::ModuleSP module_sp
The Module for a given query.
void Clear(bool clear_target)
Clear the object's state.
Variable * variable
The global variable matching the given query.
LineEntry line_entry
The LineEntry for a given query.
virtual CompilerDeclContext GetDeclContextContainingUID(lldb::user_id_t uid)
Definition: SymbolFile.h:233
virtual CompilerDecl GetDeclForUID(lldb::user_id_t uid)
Definition: SymbolFile.h:227
CompilerType GetForwardCompilerType()
Definition: Type.cpp:668
SymbolFile * GetSymbolFile()
Definition: Type.h:125
void DumpTypeName(Stream *s)
Definition: Type.cpp:313
A collection of ValueObject values that.
void SetValueObjectAtIndex(size_t idx, const lldb::ValueObjectSP &valobj_sp)
void Append(const lldb::ValueObjectSP &val_obj_sp)
lldb::ValueObjectSP GetValueObjectAtIndex(size_t idx)
lldb::ValueObjectSP RemoveValueObjectAtIndex(size_t idx)
static lldb::ValueObjectSP Create(ExecutionContextScope *exe_scope, const lldb::VariableSP &var_sp)
lldb::VariableSP GetVariableAtIndex(size_t idx) const
lldb::VariableSP RemoveVariableAtIndex(size_t idx)
bool DumpDeclaration(Stream *s, bool show_fullpaths, bool show_module)
Definition: Variable.cpp:168
const RangeList & GetScopeRange() const
Definition: Variable.h:68
bool IsInScope(StackFrame *frame)
Definition: Variable.cpp:272
static void AutoComplete(const ExecutionContext &exe_ctx, CompletionRequest &request)
Definition: Variable.cpp:713
CompilerDeclContext GetDeclContext()
Definition: Variable.cpp:194
unsigned m_artificial
Non-zero if the variable is not explicitly declared in source.
Definition: Variable.h:137
unsigned m_external
Visible outside the containing compile unit?
Definition: Variable.h:135
bool LocationIsValidForAddress(const Address &address)
Definition: Variable.cpp:236
lldb::SymbolFileTypeSP m_symfile_type_sp
The type pointer of the variable (int, struct, class, etc) global, parameter, local.
Definition: Variable.h:122
RangeList m_scope_range
The list of ranges inside the owner's scope where this variable is valid.
Definition: Variable.h:128
ConstString GetUnqualifiedName() const
Definition: Variable.cpp:78
static Status GetValuesForVariableExpressionPath(llvm::StringRef variable_expr_path, ExecutionContextScope *scope, GetVariableCallback callback, void *baton, VariableList &variable_list, ValueObjectList &valobj_list)
Definition: Variable.cpp:322
Mangled m_mangled
The mangled name of the variable.
Definition: Variable.h:119
bool NameMatches(ConstString name) const
Since a variable can have a basename "i" and also a mangled named "_ZN12_GLOBAL__N_11iE" and a demang...
Definition: Variable.cpp:80
void Dump(Stream *s, bool show_context) const
Definition: Variable.cpp:102
lldb::ValueType m_scope
Definition: Variable.h:123
SymbolContextScope * m_owner_scope
The symbol file scope that this variable was defined in.
Definition: Variable.h:125
ConstString GetName() const
Definition: Variable.cpp:71
CompilerDecl GetDecl()
Definition: Variable.cpp:201
ConstString m_name
The basename of the variable (no namespaces).
Definition: Variable.h:117
Declaration m_declaration
Declaration location for this item.
Definition: Variable.h:130
void CalculateSymbolContext(SymbolContext *sc)
Definition: Variable.cpp:206
Variable(lldb::user_id_t uid, const char *name, const char *mangled, const lldb::SymbolFileTypeSP &symfile_type_sp, lldb::ValueType scope, SymbolContextScope *owner_scope, const RangeList &scope_range, Declaration *decl, const DWARFExpressionList &location, bool external, bool artificial, bool location_is_constant_data, bool static_member=false)
Constructors and Destructors.
Definition: Variable.cpp:38
bool DumpLocations(Stream *s, const Address &address)
Definition: Variable.cpp:438
lldb::LanguageType GetLanguage() const
Definition: Variable.cpp:54
size_t MemorySize() const
Definition: Variable.cpp:192
bool LocationIsValidForFrame(StackFrame *frame)
Definition: Variable.cpp:214
DWARFExpressionList m_location_list
The location of this variable that can be fed to DWARFExpression::Evaluate().
Definition: Variable.h:133
#define LLDB_INVALID_ADDRESS
Definition: lldb-defines.h:76
A class that represents a running process on the host machine.
Definition: SBAttachInfo.h:14
Definition: SBAddress.h:15
std::shared_ptr< lldb_private::ABI > ABISP
Definition: lldb-forward.h:300
@ eDescriptionLevelBrief
std::shared_ptr< lldb_private::ValueObject > ValueObjectSP
Definition: lldb-forward.h:458
LanguageType
Programming language type.
@ eLanguageTypeUnknown
Unknown or invalid language value.
std::shared_ptr< lldb_private::Process > ProcessSP
Definition: lldb-forward.h:368
std::shared_ptr< lldb_private::SymbolFileType > SymbolFileTypeSP
Definition: lldb-forward.h:416
std::shared_ptr< lldb_private::Variable > VariableSP
Definition: lldb-forward.h:460
uint64_t user_id_t
Definition: lldb-types.h:80
uint64_t addr_t
Definition: lldb-types.h:79
std::shared_ptr< lldb_private::Target > TargetSP
Definition: lldb-forward.h:423
std::shared_ptr< lldb_private::Module > ModuleSP
Definition: lldb-forward.h:354
@ eValueTypeInvalid
@ eValueTypeVariableGlobal
globals variable
@ eValueTypeConstResult
constant result variables
@ eValueTypeVariableLocal
function local variables
@ eValueTypeVariableArgument
function argument variables
@ eValueTypeRegister
stack frame register value
@ eValueTypeVariableStatic
static variable
@ eValueTypeRegisterSet
A collection of stack frame register values.
@ eValueTypeVariableThreadLocal
thread local storage variable
void Clear()
Clear the object's state.
Definition: LineEntry.cpp:33
A mix in class that contains a generic user ID.
Definition: UserID.h:31
lldb::user_id_t GetID() const
Get accessor for the user ID.
Definition: UserID.h:47