Skip to content

Commit f62f13d

Browse files
JDevlieghereJDevlieghere
authored
[lldb] Store the return SBValueList in the CommandReturnObject (#127566)
There are a lot of lldb commands whose result is really one or more ValueObjects that we then print with the ValueObjectPrinter. Now that we have the ability to access the SBCommandReturnObject through a callback (#125006), we can store the resultant ValueObjects in the return object, allowing an IDE to access the SBValues and do its own rich formatting. rdar://143965453
1 parent b0e24d1 commit f62f13d

File tree

13 files changed

+91
-23
lines changed

13 files changed

+91
-23
lines changed

‎lldb/include/lldb/API/SBCommandReturnObject.h‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,6 +136,8 @@ class LLDB_API SBCommandReturnObject {
136136

137137
void SetError(const char *error_cstr);
138138

139+
lldb::SBValueList GetValues(lldb::DynamicValueType use_dynamic);
140+
139141
protected:
140142
friend class SBCommandInterpreter;
141143
friend class SBOptions;

‎lldb/include/lldb/API/SBValue.h‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -442,6 +442,7 @@ class LLDB_API SBValue {
442442

443443
protected:
444444
friend class SBBlock;
445+
friend class SBCommandReturnObject;
445446
friend class SBFrame;
446447
friend class SBModule;
447448
friend class SBTarget;

‎lldb/include/lldb/Interpreter/CommandReturnObject.h‎

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
#include "lldb/Utility/StreamString.h"
1515
#include "lldb/Utility/StreamTee.h"
1616
#include "lldb/Utility/StructuredData.h"
17+
#include "lldb/ValueObject/ValueObjectList.h"
1718
#include "lldb/lldb-private.h"
1819

1920
#include "llvm/ADT/StringRef.h"
@@ -134,7 +135,7 @@ class CommandReturnObject {
134135
__attribute__((format(printf, 2, 3)));
135136

136137
template <typename... Args>
137-
void AppendMessageWithFormatv(const char *format, Args &&... args) {
138+
void AppendMessageWithFormatv(const char *format, Args &&...args) {
138139
AppendMessage(llvm::formatv(format, std::forward<Args>(args)...).str());
139140
}
140141

@@ -144,12 +145,12 @@ class CommandReturnObject {
144145
}
145146

146147
template <typename... Args>
147-
void AppendWarningWithFormatv(const char *format, Args &&... args) {
148+
void AppendWarningWithFormatv(const char *format, Args &&...args) {
148149
AppendWarning(llvm::formatv(format, std::forward<Args>(args)...).str());
149150
}
150151

151152
template <typename... Args>
152-
void AppendErrorWithFormatv(const char *format, Args &&... args) {
153+
void AppendErrorWithFormatv(const char *format, Args &&...args) {
153154
AppendError(llvm::formatv(format, std::forward<Args>(args)...).str());
154155
}
155156

@@ -165,6 +166,10 @@ class CommandReturnObject {
165166
return m_diagnostic_indent;
166167
}
167168

169+
const ValueObjectList &GetValueObjectList() const { return m_value_objects; }
170+
171+
ValueObjectList &GetValueObjectList() { return m_value_objects; }
172+
168173
lldb::ReturnStatus GetStatus() const;
169174

170175
void SetStatus(lldb::ReturnStatus status);
@@ -197,6 +202,9 @@ class CommandReturnObject {
197202

198203
lldb::ReturnStatus m_status = lldb::eReturnStatusStarted;
199204

205+
/// An optionally empty list of values produced by this command.
206+
ValueObjectList m_value_objects;
207+
200208
bool m_did_change_process_state = false;
201209
bool m_suppress_immediate_output = false;
202210

‎lldb/include/lldb/ValueObject/ValueObjectList.h‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,6 @@ class ValueObject;
2222
/// A collection of ValueObject values that.
2323
class ValueObjectList {
2424
public:
25-
const ValueObjectList &operator=(const ValueObjectList &rhs);
26-
2725
void Append(const lldb::ValueObjectSP &val_obj_sp);
2826

2927
void Append(const ValueObjectList &valobj_list);

‎lldb/source/API/SBCommandReturnObject.cpp‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,14 @@
1212
#include "lldb/API/SBFile.h"
1313
#include "lldb/API/SBStream.h"
1414
#include "lldb/API/SBStructuredData.h"
15+
#include "lldb/API/SBValue.h"
16+
#include "lldb/API/SBValueList.h"
1517
#include "lldb/Core/StructuredDataImpl.h"
1618
#include "lldb/Interpreter/CommandReturnObject.h"
1719
#include "lldb/Utility/ConstString.h"
1820
#include "lldb/Utility/Instrumentation.h"
1921
#include "lldb/Utility/Status.h"
22+
#include "lldb/lldb-forward.h"
2023

2124
using namespace lldb;
2225
using namespace lldb_private;
@@ -356,3 +359,18 @@ void SBCommandReturnObject::SetError(const char *error_cstr) {
356359
if (error_cstr)
357360
ref().AppendError(error_cstr);
358361
}
362+
363+
SBValueList
364+
SBCommandReturnObject::GetValues(lldb::DynamicValueType use_dynamic) {
365+
LLDB_INSTRUMENT_VA(this, use_dynamic);
366+
367+
SBValueList value_list;
368+
for (ValueObjectSP value_object_sp :
369+
ref().GetValueObjectList().GetObjects()) {
370+
SBValue value_sb;
371+
value_sb.SetSP(value_object_sp, use_dynamic);
372+
value_list.Append(value_sb);
373+
}
374+
375+
return value_list;
376+
}

‎lldb/source/Commands/CommandObjectDWIMPrint.cpp‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -205,6 +205,9 @@ void CommandObjectDWIMPrint::DoExecute(StringRef command,
205205
ExpressionResults expr_result = target.EvaluateExpression(
206206
expr, exe_scope, valobj_sp, eval_options, &fixed_expression);
207207

208+
if (valobj_sp)
209+
result.GetValueObjectList().Append(valobj_sp);
210+
208211
// Record the position of the expression in the command.
209212
std::optional<uint16_t> indent;
210213
if (fixed_expression.empty()) {

‎lldb/source/Commands/CommandObjectExpression.cpp‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -434,6 +434,8 @@ bool CommandObjectExpression::EvaluateExpression(llvm::StringRef expr,
434434
}
435435

436436
if (result_valobj_sp) {
437+
result.GetValueObjectList().Append(result_valobj_sp);
438+
437439
Format format = m_format_options.GetFormat();
438440

439441
if (result_valobj_sp->GetError().Success()) {

‎lldb/source/Commands/CommandObjectFrame.cpp‎

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,7 @@ class CommandObjectFrameDiagnose : public CommandObjectParsed {
152152
return;
153153
}
154154

155+
result.GetValueObjectList().Append(valobj_sp);
155156
DumpValueObjectOptions::DeclPrintingHelper helper =
156157
[&valobj_sp](ConstString type, ConstString var,
157158
const DumpValueObjectOptions &opts,
@@ -317,10 +318,10 @@ class CommandObjectFrameSelect : public CommandObjectParsed {
317318
} else if (*m_options.relative_frame_offset > 0) {
318319
// I don't want "up 20" where "20" takes you past the top of the stack
319320
// to produce an error, but rather to just go to the top. OTOH, start
320-
// by seeing if the requested frame exists, in which case we can avoid
321+
// by seeing if the requested frame exists, in which case we can avoid
321322
// counting the stack here...
322-
const uint32_t frame_requested = frame_idx
323-
+ *m_options.relative_frame_offset;
323+
const uint32_t frame_requested =
324+
frame_idx + *m_options.relative_frame_offset;
324325
StackFrameSP frame_sp = thread->GetStackFrameAtIndex(frame_requested);
325326
if (frame_sp)
326327
frame_idx = frame_requested;
@@ -515,8 +516,8 @@ may even involve JITing and running code in the target program.)");
515516

516517
if (error.Fail() && (!variable_list || variable_list->GetSize() == 0)) {
517518
result.AppendError(error.AsCString());
518-
519519
}
520+
520521
ValueObjectSP valobj_sp;
521522

522523
TypeSummaryImplSP summary_format_sp;
@@ -564,6 +565,8 @@ may even involve JITing and running code in the target program.)");
564565
valobj_sp = frame->GetValueObjectForFrameVariable(
565566
var_sp, m_varobj_options.use_dynamic);
566567
if (valobj_sp) {
568+
result.GetValueObjectList().Append(valobj_sp);
569+
567570
std::string scope_string;
568571
if (m_option_variable.show_scope)
569572
scope_string = GetScopeString(var_sp).str();
@@ -604,6 +607,8 @@ may even involve JITing and running code in the target program.)");
604607
entry.ref(), m_varobj_options.use_dynamic, expr_path_options,
605608
var_sp, error);
606609
if (valobj_sp) {
610+
result.GetValueObjectList().Append(valobj_sp);
611+
607612
std::string scope_string;
608613
if (m_option_variable.show_scope)
609614
scope_string = GetScopeString(var_sp).str();
@@ -653,6 +658,8 @@ may even involve JITing and running code in the target program.)");
653658
valobj_sp = frame->GetValueObjectForFrameVariable(
654659
var_sp, m_varobj_options.use_dynamic);
655660
if (valobj_sp) {
661+
result.GetValueObjectList().Append(valobj_sp);
662+
656663
// When dumping all variables, don't print any variables that are
657664
// not in scope to avoid extra unneeded output
658665
if (valobj_sp->IsInScope()) {
@@ -694,6 +701,7 @@ may even involve JITing and running code in the target program.)");
694701
recognized_frame->GetRecognizedArguments();
695702
if (recognized_arg_list) {
696703
for (auto &rec_value_sp : recognized_arg_list->GetObjects()) {
704+
result.GetValueObjectList().Append(rec_value_sp);
697705
options.SetFormat(m_option_format.GetFormat());
698706
options.SetVariableFormatDisplayLanguage(
699707
rec_value_sp->GetPreferredDisplayLanguage());

‎lldb/source/Commands/CommandObjectTarget.cpp‎

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -803,7 +803,9 @@ class CommandObjectTargetVariable : public CommandObjectParsed {
803803
protected:
804804
void DumpGlobalVariableList(const ExecutionContext &exe_ctx,
805805
const SymbolContext &sc,
806-
const VariableList &variable_list, Stream &s) {
806+
const VariableList &variable_list,
807+
CommandReturnObject &result) {
808+
Stream &s = result.GetOutputStream();
807809
if (variable_list.Empty())
808810
return;
809811
if (sc.module_sp) {
@@ -824,15 +826,16 @@ class CommandObjectTargetVariable : public CommandObjectParsed {
824826
ValueObjectSP valobj_sp(ValueObjectVariable::Create(
825827
exe_ctx.GetBestExecutionContextScope(), var_sp));
826828

827-
if (valobj_sp)
829+
if (valobj_sp) {
830+
result.GetValueObjectList().Append(valobj_sp);
828831
DumpValueObject(s, var_sp, valobj_sp, var_sp->GetName().GetCString());
832+
}
829833
}
830834
}
831835

832836
void DoExecute(Args &args, CommandReturnObject &result) override {
833837
Target *target = m_exe_ctx.GetTargetPtr();
834838
const size_t argc = args.GetArgumentCount();
835-
Stream &s = result.GetOutputStream();
836839

837840
if (argc > 0) {
838841
for (const Args::ArgEntry &arg : args) {
@@ -874,7 +877,7 @@ class CommandObjectTargetVariable : public CommandObjectParsed {
874877
m_exe_ctx.GetBestExecutionContextScope(), var_sp);
875878

876879
if (valobj_sp)
877-
DumpValueObject(s, var_sp, valobj_sp,
880+
DumpValueObject(result.GetOutputStream(), var_sp, valobj_sp,
878881
use_var_name ? var_sp->GetName().GetCString()
879882
: arg.c_str());
880883
}
@@ -903,7 +906,8 @@ class CommandObjectTargetVariable : public CommandObjectParsed {
903906
if (comp_unit_varlist_sp) {
904907
size_t count = comp_unit_varlist_sp->GetSize();
905908
if (count > 0) {
906-
DumpGlobalVariableList(m_exe_ctx, sc, *comp_unit_varlist_sp, s);
909+
DumpGlobalVariableList(m_exe_ctx, sc, *comp_unit_varlist_sp,
910+
result);
907911
success = true;
908912
}
909913
}
@@ -964,15 +968,16 @@ class CommandObjectTargetVariable : public CommandObjectParsed {
964968
VariableListSP comp_unit_varlist_sp(
965969
sc.comp_unit->GetVariableList(can_create));
966970
if (comp_unit_varlist_sp)
967-
DumpGlobalVariableList(m_exe_ctx, sc, *comp_unit_varlist_sp, s);
971+
DumpGlobalVariableList(m_exe_ctx, sc, *comp_unit_varlist_sp,
972+
result);
968973
} else if (sc.module_sp) {
969974
// Get all global variables for this module
970975
lldb_private::RegularExpression all_globals_regex(
971976
llvm::StringRef(".")); // Any global with at least one character
972977
VariableList variable_list;
973978
sc.module_sp->FindGlobalVariables(all_globals_regex, UINT32_MAX,
974979
variable_list);
975-
DumpGlobalVariableList(m_exe_ctx, sc, variable_list, s);
980+
DumpGlobalVariableList(m_exe_ctx, sc, variable_list, result);
976981
}
977982
}
978983
}

‎lldb/source/ValueObject/ValueObjectList.cpp‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,6 @@
1616
using namespace lldb;
1717
using namespace lldb_private;
1818

19-
const ValueObjectList &ValueObjectList::operator=(const ValueObjectList &rhs) {
20-
if (this != &rhs)
21-
m_value_objects = rhs.m_value_objects;
22-
return *this;
23-
}
24-
2519
void ValueObjectList::Append(const ValueObjectSP &val_obj_sp) {
2620
m_value_objects.push_back(val_obj_sp);
2721
}

0 commit comments

Comments
 (0)