LLDB  mainline
OptionGroupVariable.cpp
Go to the documentation of this file.
1 //===-- OptionGroupVariable.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 
10 
12 #include "lldb/Host/OptionParser.h"
14 #include "lldb/Target/Target.h"
15 #include "lldb/Utility/Status.h"
16 
17 using namespace lldb;
18 using namespace lldb_private;
19 
20 // if you add any options here, remember to update the counters in
21 // OptionGroupVariable::GetNumDefinitions()
22 static constexpr OptionDefinition g_variable_options[] = {
23  {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "no-args", 'a',
24  OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone,
25  "Omit function arguments."},
26  {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "no-recognized-args", 't',
27  OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone,
28  "Omit recognized function arguments."},
29  {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "no-locals", 'l',
30  OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone,
31  "Omit local variables."},
32  {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "show-globals", 'g',
33  OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone,
34  "Show the current frame source file global and static variables."},
35  {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "show-declaration", 'c',
36  OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone,
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',
40  OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeRegularExpression,
41  "The <variable-name> argument for name lookups are regular expressions."},
42  {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "scope", 's',
43  OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone,
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',
49  OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeName,
50  "Specify a summary string to use to format the variable output."},
51 };
52 
53 static Status ValidateNamedSummary(const char *str, void *) {
54  if (!str || !str[0])
55  return Status("must specify a valid named summary");
56  TypeSummaryImplSP summary_sp;
57  if (!DataVisualization::NamedSummaryFormats::GetSummaryFormat(
58  ConstString(str), summary_sp))
59  return Status("must specify a valid named summary");
60  return Status();
61 }
62 
63 static 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 
69 OptionGroupVariable::OptionGroupVariable(bool show_frame_options)
70  : OptionGroup(), include_frame_options(show_frame_options),
71  summary(ValidateNamedSummary), summary_string(ValidateSummaryString) {}
72 
74 
75 Status
77  llvm::StringRef option_arg,
78  ExecutionContext *execution_context) {
79  Status error;
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':
109  error = summary_string.SetCurrentValue(option_arg);
110  break;
111  default:
112  error.SetErrorStringWithFormat("unrecognized short option '%c'",
113  short_option);
114  break;
115  }
116 
117  return error;
118 }
119 
121  ExecutionContext *execution_context) {
122  show_args = true; // Frame option only
123  show_recognized_args = true; // Frame option only
124  show_locals = true; // Frame option only
125  show_globals = false; // Frame option only
126  show_decl = false;
127  use_regex = false;
128  show_scope = false;
129  summary.Clear();
131 }
132 
133 #define NUM_FRAME_OPTS 3
134 
135 llvm::ArrayRef<OptionDefinition> OptionGroupVariable::GetDefinitions() {
136  auto result = llvm::makeArrayRef(g_variable_options);
137  // Show the "--no-args", "--no-locals" and "--show-globals" options if we are
138  // showing frame specific options
140  return result;
141 
142  // Skip the "--no-args", "--no-locals" and "--show-globals" options if we are
143  // not showing frame specific options (globals only)
144  return result.drop_front(NUM_FRAME_OPTS);
145 }
Enumerations for broadcasting.
Definition: SBLaunchInfo.h:14
static Status ValidateNamedSummary(const char *str, void *)
Status SetOptionValue(uint32_t option_idx, llvm::StringRef option_value, ExecutionContext *execution_context) override
"lldb/Target/ExecutionContext.h" A class that contains an execution context.
#define NUM_FRAME_OPTS
static constexpr OptionDefinition g_variable_options[]
static Status ValidateSummaryString(const char *str, void *)
#define LLDB_OPT_SET_2
Definition: lldb-defines.h:112
void OptionParsingStarting(ExecutionContext *execution_context) override
Status SetCurrentValue(const char *)=delete
A uniqued constant string class.
Definition: ConstString.h:38
Definition: SBAddress.h:15
int SetErrorStringWithFormat(const char *format,...) __attribute__((format(printf
Set the current error string to a formatted error string.
Definition: Status.cpp:255
#define LLDB_OPT_SET_1
Definition: lldb-defines.h:111
An error handling class.
Definition: Status.h:44
llvm::ArrayRef< OptionDefinition > GetDefinitions() override