LLDB mainline
OptionGroupVariable.cpp
Go to the documentation of this file.
1//===-- OptionGroupVariable.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
14#include "lldb/Target/Target.h"
15#include "lldb/Utility/Status.h"
16
17using namespace lldb;
18using namespace lldb_private;
19
20// if you add any options here, remember to update the counters in
21// OptionGroupVariable::GetNumDefinitions()
23 {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "no-args", 'a',
25 "Omit function arguments."},
26 {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "no-recognized-args", 't',
28 "Omit recognized function arguments."},
29 {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "no-locals", 'l',
31 "Omit local variables."},
32 {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "show-globals", 'g',
34 "Show the current frame source file global and static variables."},
35 {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "show-declaration", 'c',
37 "Show variable declaration information (source file and line where the "
38 "variable was declared)."},
39 {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "regex", 'r',
41 "The <variable-name> argument for name lookups are regular expressions."},
42 {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "scope", 's',
44 "Show variable scope (argument, local, global, static)."},
45 {LLDB_OPT_SET_1, false, "summary", 'y', OptionParser::eRequiredArgument,
46 nullptr, {}, 0, eArgTypeName,
47 "Specify the summary that the variable output should use."},
48 {LLDB_OPT_SET_2, false, "summary-string", 'z',
50 "Specify a summary string to use to format the variable output."},
51};
52
53static Status ValidateNamedSummary(const char *str, void *) {
54 if (!str || !str[0])
55 return Status("must specify a valid named summary");
56 TypeSummaryImplSP summary_sp;
58 ConstString(str), summary_sp))
59 return Status("must specify a valid named summary");
60 return Status();
61}
62
63static Status ValidateSummaryString(const char *str, void *) {
64 if (!str || !str[0])
65 return Status("must specify a non-empty summary string");
66 return Status();
67}
68
70 : include_frame_options(show_frame_options), show_args(false),
71 show_recognized_args(false), show_locals(false), show_globals(false),
72 use_regex(false), show_scope(false), show_decl(false),
73 summary(ValidateNamedSummary), summary_string(ValidateSummaryString) {}
74
77 llvm::StringRef option_arg,
78 ExecutionContext *execution_context) {
81 option_idx += 3;
82 const int short_option = g_variable_options[option_idx].short_option;
83 switch (short_option) {
84 case 'r':
85 use_regex = true;
86 break;
87 case 'a':
88 show_args = false;
89 break;
90 case 'l':
91 show_locals = false;
92 break;
93 case 'g':
94 show_globals = true;
95 break;
96 case 'c':
97 show_decl = true;
98 break;
99 case 's':
100 show_scope = true;
101 break;
102 case 't':
103 show_recognized_args = false;
104 break;
105 case 'y':
106 error = summary.SetCurrentValue(option_arg);
107 break;
108 case 'z':
110 break;
111 default:
112 llvm_unreachable("Unimplemented option");
113 }
114
115 return error;
116}
117
119 ExecutionContext *execution_context) {
120 show_args = true; // Frame option only
121 show_recognized_args = true; // Frame option only
122 show_locals = true; // Frame option only
123 show_globals = false; // Frame option only
124 show_decl = false;
125 use_regex = false;
126 show_scope = false;
127 summary.Clear();
129}
130
131#define NUM_FRAME_OPTS 3
132
133llvm::ArrayRef<OptionDefinition> OptionGroupVariable::GetDefinitions() {
134 auto result = llvm::ArrayRef(g_variable_options);
135 // Show the "--no-args", "--no-locals" and "--show-globals" options if we are
136 // showing frame specific options
138 return result;
139
140 // Skip the "--no-args", "--no-locals" and "--show-globals" options if we are
141 // not showing frame specific options (globals only)
142 return result.drop_front(NUM_FRAME_OPTS);
143}
static llvm::raw_ostream & error(Stream &strm)
#define NUM_FRAME_OPTS
static Status ValidateSummaryString(const char *str, void *)
static Status ValidateNamedSummary(const char *str, void *)
static constexpr OptionDefinition g_variable_options[]
A uniqued constant string class.
Definition: ConstString.h:39
static bool GetSummaryFormat(ConstString type, lldb::TypeSummaryImplSP &entry)
"lldb/Target/ExecutionContext.h" A class that contains an execution context.
Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_value, ExecutionContext *execution_context) override
llvm::ArrayRef< OptionDefinition > GetDefinitions() override
OptionGroupVariable(bool show_frame_options)
void OptionParsingStarting(ExecutionContext *execution_context) override
Status SetCurrentValue(llvm::StringRef value)
An error handling class.
Definition: Status.h:44
#define LLDB_OPT_SET_1
Definition: lldb-defines.h:102
#define LLDB_OPT_SET_2
Definition: lldb-defines.h:103
A class that represents a running process on the host machine.
Definition: SBAddress.h:15
@ eArgTypeRegularExpression
int short_option
Single character for this option.