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/Log.h"
33#include "lldb/Utility/Stream.h"
34
35#include "llvm/ADT/Twine.h"
36
37using namespace lldb;
38using namespace lldb_private;
39
40Variable::Variable(lldb::user_id_t uid, const char *name, const char *mangled,
41 const lldb::SymbolFileTypeSP &symfile_type_sp,
42 ValueType scope, SymbolContextScope *context,
43 const RangeList &scope_range, Declaration *decl_ptr,
44 const DWARFExpressionList &location_list, bool external,
45 bool artificial, bool location_is_constant_data,
46 bool static_member)
47 : UserID(uid), m_name(name), m_mangled(ConstString(mangled)),
48 m_symfile_type_sp(symfile_type_sp), m_scope(scope),
49 m_owner_scope(context), m_scope_range(scope_range),
50 m_declaration(decl_ptr), m_location_list(location_list), m_external(external),
51 m_artificial(artificial), m_loc_is_const_data(location_is_constant_data),
52 m_static_member(static_member) {}
53
54Variable::~Variable() = default;
55
59 return lang;
60
62 if ((lang = func->GetLanguage()) != lldb::eLanguageTypeUnknown)
63 return lang;
64 } else if (auto *comp_unit =
66 if ((lang = comp_unit->GetLanguage()) != lldb::eLanguageTypeUnknown)
67 return lang;
68 }
69
71}
72
75 if (name)
76 return name;
77 return m_name;
78}
79
81
83 if (m_name == name)
84 return true;
85 SymbolContext variable_sc;
87
88 return m_mangled.NameMatches(name);
89}
90bool Variable::NameMatches(const RegularExpression &regex) const {
91 if (regex.Execute(m_name.AsCString()))
92 return true;
93 if (m_mangled)
94 return m_mangled.NameMatches(regex);
95 return false;
96}
97
100 return m_symfile_type_sp->GetType();
101 return nullptr;
102}
103
104void Variable::Dump(Stream *s, bool show_context) const {
105 s->Printf("%p: ", static_cast<const void *>(this));
106 s->Indent();
107 *s << "Variable" << (const UserID &)*this;
108
109 if (m_name)
110 *s << ", name = \"" << m_name << "\"";
111
112 if (m_symfile_type_sp) {
113 Type *type = m_symfile_type_sp->GetType();
114 if (type) {
115 s->Format(", type = {{{0:x-16}} {1} (", type->GetID(), type);
116 type->DumpTypeName(s);
117 s->PutChar(')');
118 }
119 }
120
121 if (m_scope != eValueTypeInvalid) {
122 s->PutCString(", scope = ");
123 switch (m_scope) {
125 s->PutCString(m_external ? "global" : "static");
126 break;
128 s->PutCString("parameter");
129 break;
131 s->PutCString("local");
132 break;
134 s->PutCString("thread local");
135 break;
136 default:
137 s->AsRawOstream() << "??? (" << m_scope << ')';
138 }
139 }
140
141 if (show_context && m_owner_scope != nullptr) {
142 s->PutCString(", context = ( ");
144 s->PutCString(" )");
145 }
146
147 bool show_fullpaths = false;
148 m_declaration.Dump(s, show_fullpaths);
149
150 if (m_location_list.IsValid()) {
151 s->PutCString(", location = ");
152 ABISP abi;
153 if (m_owner_scope) {
155 if (module_sp)
156 abi = ABI::FindPlugin(ProcessSP(), module_sp->GetArchitecture());
157 }
159 }
160
161 if (m_external)
162 s->PutCString(", external");
163
164 if (m_artificial)
165 s->PutCString(", artificial");
166
167 s->EOL();
168}
169
170bool Variable::DumpDeclaration(Stream *s, bool show_fullpaths,
171 bool show_module) {
172 bool dumped_declaration_info = false;
173 if (m_owner_scope) {
174 SymbolContext sc;
176 sc.block = nullptr;
177 sc.line_entry.Clear();
178 bool show_inlined_frames = false;
179 const bool show_function_arguments = true;
180 const bool show_function_name = true;
181
182 dumped_declaration_info = sc.DumpStopContext(
183 s, nullptr, Address(), show_fullpaths, show_module, show_inlined_frames,
184 show_function_arguments, show_function_name);
185
186 if (sc.function)
187 s->PutChar(':');
188 }
189 if (m_declaration.DumpStopContext(s, false))
190 dumped_declaration_info = true;
191 return dumped_declaration_info;
192}
193
194size_t Variable::MemorySize() const { return sizeof(Variable); }
195
197 Type *type = GetType();
198 if (type)
200 return CompilerDeclContext();
201}
202
204 Type *type = GetType();
205 return type ? type->GetSymbolFile()->GetDeclForUID(GetID()) : CompilerDecl();
206}
207
209 if (m_owner_scope) {
211 sc->variable = this;
212 } else
213 sc->Clear(false);
214}
215
217 if (frame) {
218 Function *function =
219 frame->GetSymbolContext(eSymbolContextFunction).function;
220 if (function) {
221 TargetSP target_sp(frame->CalculateTarget());
222
223 addr_t loclist_base_load_addr =
225 target_sp.get());
226 if (loclist_base_load_addr == LLDB_INVALID_ADDRESS)
227 return false;
228 // It is a location list. We just need to tell if the location list
229 // contains the current address when converted to a load address
231 loclist_base_load_addr,
233 target_sp.get()));
234 }
235 }
236 return false;
237}
238
240 // Be sure to resolve the address to section offset prior to calling this
241 // function.
242 if (address.IsSectionOffset()) {
243 // We need to check if the address is valid for both scope range and value
244 // range.
245 // Empty scope range means block range.
246 bool valid_in_scope_range =
248 address.GetFileAddress()) != nullptr;
249 if (!valid_in_scope_range)
250 return false;
251 SymbolContext sc;
253 if (sc.module_sp == address.GetModule()) {
254 // Is the variable is described by a single location?
256 // Yes it is, the location is valid.
257 return true;
258 }
259
260 if (sc.function) {
261 addr_t loclist_base_file_addr =
263 if (loclist_base_file_addr == LLDB_INVALID_ADDRESS)
264 return false;
265 // It is a location list. We just need to tell if the location list
266 // contains the current address when converted to a load address
267 return m_location_list.ContainsAddress(loclist_base_file_addr,
268 address.GetFileAddress());
269 }
270 }
271 }
272 return false;
273}
274
276 switch (m_scope) {
279 return frame != nullptr;
280
285 return true;
286
289 if (frame) {
290 // We don't have a location list, we just need to see if the block that
291 // this variable was defined in is currently
292 Block *deepest_frame_block =
293 frame->GetSymbolContext(eSymbolContextBlock).block;
294 if (deepest_frame_block) {
295 SymbolContext variable_sc;
296 CalculateSymbolContext(&variable_sc);
297
298 // Check for static or global variable defined at the compile unit
299 // level that wasn't defined in a block
300 if (variable_sc.block == nullptr)
301 return true;
302
303 // Check if the variable is valid in the current block
304 if (variable_sc.block != deepest_frame_block &&
305 !variable_sc.block->Contains(deepest_frame_block))
306 return false;
307
308 // If no scope range is specified then it means that the scope is the
309 // same as the scope of the enclosing lexical block.
311 return true;
312
313 addr_t file_address = frame->GetFrameCodeAddress().GetFileAddress();
314 return m_scope_range.FindEntryThatContains(file_address) != nullptr;
315 }
316 }
317 break;
318
319 default:
320 break;
321 }
322 return false;
323}
324
326 llvm::StringRef variable_expr_path, ExecutionContextScope *scope,
327 GetVariableCallback callback, void *baton, VariableList &variable_list,
328 ValueObjectList &valobj_list) {
330 if (!callback || variable_expr_path.empty()) {
331 error.SetErrorString("unknown error");
332 return error;
333 }
334
335 switch (variable_expr_path.front()) {
336 case '*':
338 variable_expr_path.drop_front(), scope, callback, baton, variable_list,
339 valobj_list);
340 if (error.Fail()) {
341 error.SetErrorString("unknown error");
342 return error;
343 }
344 for (uint32_t i = 0; i < valobj_list.GetSize();) {
345 Status tmp_error;
346 ValueObjectSP valobj_sp(
347 valobj_list.GetValueObjectAtIndex(i)->Dereference(tmp_error));
348 if (tmp_error.Fail()) {
349 variable_list.RemoveVariableAtIndex(i);
350 valobj_list.RemoveValueObjectAtIndex(i);
351 } else {
352 valobj_list.SetValueObjectAtIndex(i, valobj_sp);
353 ++i;
354 }
355 }
356 return error;
357 case '&': {
359 variable_expr_path.drop_front(), scope, callback, baton, variable_list,
360 valobj_list);
361 if (error.Success()) {
362 for (uint32_t i = 0; i < valobj_list.GetSize();) {
363 Status tmp_error;
364 ValueObjectSP valobj_sp(
365 valobj_list.GetValueObjectAtIndex(i)->AddressOf(tmp_error));
366 if (tmp_error.Fail()) {
367 variable_list.RemoveVariableAtIndex(i);
368 valobj_list.RemoveValueObjectAtIndex(i);
369 } else {
370 valobj_list.SetValueObjectAtIndex(i, valobj_sp);
371 ++i;
372 }
373 }
374 } else {
375 error.SetErrorString("unknown error");
376 }
377 return error;
378 } break;
379
380 default: {
381 static RegularExpression g_regex(
382 llvm::StringRef("^([A-Za-z_:][A-Za-z_0-9:]*)(.*)"));
383 llvm::SmallVector<llvm::StringRef, 2> matches;
384 variable_list.Clear();
385 if (!g_regex.Execute(variable_expr_path, &matches)) {
386 error.SetErrorStringWithFormatv(
387 "unable to extract a variable name from '{0}'", variable_expr_path);
388 return error;
389 }
390 std::string variable_name = matches[1].str();
391 if (!callback(baton, variable_name.c_str(), variable_list)) {
392 error.SetErrorString("unknown error");
393 return error;
394 }
395 uint32_t i = 0;
396 while (i < variable_list.GetSize()) {
397 VariableSP var_sp(variable_list.GetVariableAtIndex(i));
398 ValueObjectSP valobj_sp;
399 if (!var_sp) {
400 variable_list.RemoveVariableAtIndex(i);
401 continue;
402 }
403 ValueObjectSP variable_valobj_sp(
404 ValueObjectVariable::Create(scope, var_sp));
405 if (!variable_valobj_sp) {
406 variable_list.RemoveVariableAtIndex(i);
407 continue;
408 }
409
410 llvm::StringRef variable_sub_expr_path =
411 variable_expr_path.drop_front(variable_name.size());
412 if (!variable_sub_expr_path.empty()) {
413 valobj_sp = variable_valobj_sp->GetValueForExpressionPath(
414 variable_sub_expr_path);
415 if (!valobj_sp) {
416 error.SetErrorStringWithFormatv(
417 "invalid expression path '{0}' for variable '{1}'",
418 variable_sub_expr_path, var_sp->GetName().GetCString());
419 variable_list.RemoveVariableAtIndex(i);
420 continue;
421 }
422 } else {
423 // Just the name of a variable with no extras
424 valobj_sp = variable_valobj_sp;
425 }
426
427 valobj_list.Append(valobj_sp);
428 ++i;
429 }
430
431 if (variable_list.GetSize() > 0) {
432 error.Clear();
433 return error;
434 }
435 } break;
436 }
437 error.SetErrorString("unknown error");
438 return error;
439}
440
441bool Variable::DumpLocations(Stream *s, const Address &address) {
442 SymbolContext sc;
444 ABISP abi;
445 if (m_owner_scope) {
447 if (module_sp)
448 abi = ABI::FindPlugin(ProcessSP(), module_sp->GetArchitecture());
449 }
450
451 const addr_t file_addr = address.GetFileAddress();
452 if (sc.function) {
453 addr_t loclist_base_file_addr =
455 if (loclist_base_file_addr == LLDB_INVALID_ADDRESS)
456 return false;
458 loclist_base_file_addr, file_addr,
459 abi.get());
460 }
461 return false;
462}
463
464static void PrivateAutoComplete(
465 StackFrame *frame, llvm::StringRef partial_path,
466 const llvm::Twine
467 &prefix_path, // Anything that has been resolved already will be in here
468 const CompilerType &compiler_type, CompletionRequest &request);
469
471 StackFrame *frame, const std::string &partial_member_name,
472 llvm::StringRef partial_path,
473 const llvm::Twine
474 &prefix_path, // Anything that has been resolved already will be in here
475 const CompilerType &compiler_type, CompletionRequest &request) {
476
477 // We are in a type parsing child members
478 const uint32_t num_bases = compiler_type.GetNumDirectBaseClasses();
479
480 if (num_bases > 0) {
481 for (uint32_t i = 0; i < num_bases; ++i) {
482 CompilerType base_class_type =
483 compiler_type.GetDirectBaseClassAtIndex(i, nullptr);
484
485 PrivateAutoCompleteMembers(frame, partial_member_name, partial_path,
486 prefix_path,
487 base_class_type.GetCanonicalType(), request);
488 }
489 }
490
491 const uint32_t num_vbases = compiler_type.GetNumVirtualBaseClasses();
492
493 if (num_vbases > 0) {
494 for (uint32_t i = 0; i < num_vbases; ++i) {
495 CompilerType vbase_class_type =
496 compiler_type.GetVirtualBaseClassAtIndex(i, nullptr);
497
498 PrivateAutoCompleteMembers(frame, partial_member_name, partial_path,
499 prefix_path,
500 vbase_class_type.GetCanonicalType(), request);
501 }
502 }
503
504 // We are in a type parsing child members
505 const uint32_t num_fields = compiler_type.GetNumFields();
506
507 if (num_fields > 0) {
508 for (uint32_t i = 0; i < num_fields; ++i) {
509 std::string member_name;
510
511 CompilerType member_compiler_type = compiler_type.GetFieldAtIndex(
512 i, member_name, nullptr, nullptr, nullptr);
513
514 if (partial_member_name.empty()) {
515 request.AddCompletion((prefix_path + member_name).str());
516 } else if (llvm::StringRef(member_name)
517 .starts_with(partial_member_name)) {
518 if (member_name == partial_member_name) {
520 frame, partial_path,
521 prefix_path + member_name, // Anything that has been resolved
522 // already will be in here
523 member_compiler_type.GetCanonicalType(), request);
524 } else if (partial_path.empty()) {
525 request.AddCompletion((prefix_path + member_name).str());
526 }
527 }
528 }
529 }
530}
531
533 StackFrame *frame, llvm::StringRef partial_path,
534 const llvm::Twine
535 &prefix_path, // Anything that has been resolved already will be in here
536 const CompilerType &compiler_type, CompletionRequest &request) {
537 // printf ("\nPrivateAutoComplete()\n\tprefix_path = '%s'\n\tpartial_path =
538 // '%s'\n", prefix_path.c_str(), partial_path.c_str());
539 std::string remaining_partial_path;
540
541 const lldb::TypeClass type_class = compiler_type.GetTypeClass();
542 if (partial_path.empty()) {
543 if (compiler_type.IsValid()) {
544 switch (type_class) {
545 default:
546 case eTypeClassArray:
547 case eTypeClassBlockPointer:
548 case eTypeClassBuiltin:
549 case eTypeClassComplexFloat:
550 case eTypeClassComplexInteger:
551 case eTypeClassEnumeration:
552 case eTypeClassFunction:
553 case eTypeClassMemberPointer:
554 case eTypeClassReference:
555 case eTypeClassTypedef:
556 case eTypeClassVector: {
557 request.AddCompletion(prefix_path.str());
558 } break;
559
560 case eTypeClassClass:
561 case eTypeClassStruct:
562 case eTypeClassUnion:
563 if (prefix_path.str().back() != '.')
564 request.AddCompletion((prefix_path + ".").str());
565 break;
566
567 case eTypeClassObjCObject:
568 case eTypeClassObjCInterface:
569 break;
570 case eTypeClassObjCObjectPointer:
571 case eTypeClassPointer: {
572 bool omit_empty_base_classes = true;
573 if (llvm::expectedToStdOptional(
574 compiler_type.GetNumChildren(omit_empty_base_classes, nullptr))
575 .value_or(0))
576 request.AddCompletion((prefix_path + "->").str());
577 else {
578 request.AddCompletion(prefix_path.str());
579 }
580 } break;
581 }
582 } else {
583 if (frame) {
584 const bool get_file_globals = true;
585
586 VariableList *variable_list = frame->GetVariableList(get_file_globals,
587 nullptr);
588
589 if (variable_list) {
590 for (const VariableSP &var_sp : *variable_list)
591 request.AddCompletion(var_sp->GetName().AsCString());
592 }
593 }
594 }
595 } else {
596 const char ch = partial_path[0];
597 switch (ch) {
598 case '*':
599 if (prefix_path.str().empty()) {
600 PrivateAutoComplete(frame, partial_path.substr(1), "*", compiler_type,
601 request);
602 }
603 break;
604
605 case '&':
606 if (prefix_path.isTriviallyEmpty()) {
607 PrivateAutoComplete(frame, partial_path.substr(1), std::string("&"),
608 compiler_type, request);
609 }
610 break;
611
612 case '-':
613 if (partial_path.size() > 1 && partial_path[1] == '>' &&
614 !prefix_path.str().empty()) {
615 switch (type_class) {
616 case lldb::eTypeClassPointer: {
617 CompilerType pointee_type(compiler_type.GetPointeeType());
618 if (partial_path.size() > 2 && partial_path[2]) {
619 // If there is more after the "->", then search deeper
620 PrivateAutoComplete(frame, partial_path.substr(2),
621 prefix_path + "->",
622 pointee_type.GetCanonicalType(), request);
623 } else {
624 // Nothing after the "->", so list all members
626 frame, std::string(), std::string(), prefix_path + "->",
627 pointee_type.GetCanonicalType(), request);
628 }
629 } break;
630 default:
631 break;
632 }
633 }
634 break;
635
636 case '.':
637 if (compiler_type.IsValid()) {
638 switch (type_class) {
639 case lldb::eTypeClassUnion:
640 case lldb::eTypeClassStruct:
641 case lldb::eTypeClassClass:
642 if (partial_path.size() > 1 && partial_path[1]) {
643 // If there is more after the ".", then search deeper
644 PrivateAutoComplete(frame, partial_path.substr(1),
645 prefix_path + ".", compiler_type, request);
646
647 } else {
648 // Nothing after the ".", so list all members
649 PrivateAutoCompleteMembers(frame, std::string(), partial_path,
650 prefix_path + ".", compiler_type,
651 request);
652 }
653 break;
654 default:
655 break;
656 }
657 }
658 break;
659 default:
660 if (isalpha(ch) || ch == '_' || ch == '$') {
661 const size_t partial_path_len = partial_path.size();
662 size_t pos = 1;
663 while (pos < partial_path_len) {
664 const char curr_ch = partial_path[pos];
665 if (isalnum(curr_ch) || curr_ch == '_' || curr_ch == '$') {
666 ++pos;
667 continue;
668 }
669 break;
670 }
671
672 std::string token(std::string(partial_path), 0, pos);
673 remaining_partial_path = std::string(partial_path.substr(pos));
674
675 if (compiler_type.IsValid()) {
676 PrivateAutoCompleteMembers(frame, token, remaining_partial_path,
677 prefix_path, compiler_type, request);
678 } else if (frame) {
679 // We haven't found our variable yet
680 const bool get_file_globals = true;
681
682 VariableList *variable_list =
683 frame->GetVariableList(get_file_globals, nullptr);
684
685 if (!variable_list)
686 break;
687
688 for (VariableSP var_sp : *variable_list) {
689
690 if (!var_sp)
691 continue;
692
693 llvm::StringRef variable_name = var_sp->GetName().GetStringRef();
694 if (variable_name.starts_with(token)) {
695 if (variable_name == token) {
696 Type *variable_type = var_sp->GetType();
697 if (variable_type) {
698 CompilerType variable_compiler_type(
699 variable_type->GetForwardCompilerType());
701 frame, remaining_partial_path,
702 prefix_path + token, // Anything that has been resolved
703 // already will be in here
704 variable_compiler_type.GetCanonicalType(), request);
705 } else {
706 request.AddCompletion((prefix_path + variable_name).str());
707 }
708 } else if (remaining_partial_path.empty()) {
709 request.AddCompletion((prefix_path + variable_name).str());
710 }
711 }
712 }
713 }
714 }
715 break;
716 }
717 }
718}
719
721 CompletionRequest &request) {
722 CompilerType compiler_type;
723
725 "", compiler_type, request);
726}
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:470
static void PrivateAutoComplete(StackFrame *frame, llvm::StringRef partial_path, const llvm::Twine &prefix_path, const CompilerType &compiler_type, CompletionRequest &request)
Definition: Variable.cpp:532
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:211
A section + offset based address class.
Definition: Address.h:62
lldb::addr_t GetLoadAddress(Target *target) const
Get the load address.
Definition: Address.cpp:313
lldb::ModuleSP GetModule() const
Get accessor for the module for this address.
Definition: Address.cpp:285
lldb::addr_t GetFileAddress() const
Get the file address.
Definition: Address.cpp:293
bool IsSectionOffset() const
Check if an address is section offset.
Definition: Address.h:342
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
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...
llvm::Expected< uint32_t > GetNumChildren(bool omit_empty_base_classes, const ExecutionContext *exe_ctx) const
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:188
"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 separated 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:391
ConstString GetName(NamePreference preference=ePreferDemangled) const
Best name get accessor.
Definition: Mangled.cpp:335
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:43
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
Address GetFrameCodeAddressForSymbolication()
Get the current code Address suitable for symbolication, may not be the same as GetFrameCodeAddress()...
Definition: StackFrame.cpp:222
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:180
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:353
llvm::raw_ostream & AsRawOstream()
Returns a raw_ostream that forwards the data to this Stream object.
Definition: Stream.h:401
size_t Indent(llvm::StringRef s="")
Indent the current line in the stream.
Definition: Stream.cpp:157
size_t Printf(const char *format,...) __attribute__((format(printf
Output printf formatted output to the stream.
Definition: Stream.cpp:134
size_t PutCString(llvm::StringRef cstr)
Output a C string to the stream.
Definition: Stream.cpp:65
size_t PutChar(char ch)
Definition: Stream.cpp:131
size_t EOL()
Output and End of Line character to the stream.
Definition: Stream.cpp:155
"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:34
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.
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, bool show_function_display_name=false, std::optional< Stream::HighlightSettings > settings=std::nullopt) const
Dump the stop context in this object to a Stream.
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:232
virtual CompilerDecl GetDeclForUID(lldb::user_id_t uid)
Definition: SymbolFile.h:228
CompilerType GetForwardCompilerType()
Definition: Type.cpp:766
SymbolFile * GetSymbolFile()
Definition: Type.h:440
void DumpTypeName(Stream *s)
Definition: Type.cpp:442
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:170
const RangeList & GetScopeRange() const
Definition: Variable.h:68
bool IsInScope(StackFrame *frame)
Definition: Variable.cpp:275
static void AutoComplete(const ExecutionContext &exe_ctx, CompletionRequest &request)
Definition: Variable.cpp:720
CompilerDeclContext GetDeclContext()
Definition: Variable.cpp:196
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:239
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:80
static Status GetValuesForVariableExpressionPath(llvm::StringRef variable_expr_path, ExecutionContextScope *scope, GetVariableCallback callback, void *baton, VariableList &variable_list, ValueObjectList &valobj_list)
Definition: Variable.cpp:325
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:82
void Dump(Stream *s, bool show_context) const
Definition: Variable.cpp:104
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:73
CompilerDecl GetDecl()
Definition: Variable.cpp:203
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:208
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:40
bool DumpLocations(Stream *s, const Address &address)
Definition: Variable.cpp:441
lldb::LanguageType GetLanguage() const
Definition: Variable.cpp:56
size_t MemorySize() const
Definition: Variable.cpp:194
bool LocationIsValidForFrame(StackFrame *frame)
Definition: Variable.cpp:216
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:82
A class that represents a running process on the host machine.
Definition: SBAddress.h:15
std::shared_ptr< lldb_private::ABI > ABISP
Definition: lldb-forward.h:313
@ eDescriptionLevelBrief
std::shared_ptr< lldb_private::ValueObject > ValueObjectSP
Definition: lldb-forward.h:478
LanguageType
Programming language type.
@ eLanguageTypeUnknown
Unknown or invalid language value.
std::shared_ptr< lldb_private::Process > ProcessSP
Definition: lldb-forward.h:385
std::shared_ptr< lldb_private::SymbolFileType > SymbolFileTypeSP
Definition: lldb-forward.h:435
std::shared_ptr< lldb_private::Variable > VariableSP
Definition: lldb-forward.h:480
uint64_t user_id_t
Definition: lldb-types.h:82
uint64_t addr_t
Definition: lldb-types.h:80
std::shared_ptr< lldb_private::Target > TargetSP
Definition: lldb-forward.h:442
std::shared_ptr< lldb_private::Module > ModuleSP
Definition: lldb-forward.h:369
@ 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:22
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