| //===-- OptionGroupVariable.cpp -------------------------------------------===// |
| // |
| // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. |
| // See https://llvm.org/LICENSE.txt for license information. |
| // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception |
| // |
| //===----------------------------------------------------------------------===// |
| |
| #include "lldb/Interpreter/OptionGroupVariable.h" |
| |
| #include "lldb/DataFormatters/DataVisualization.h" |
| #include "lldb/Host/OptionParser.h" |
| #include "lldb/Interpreter/CommandInterpreter.h" |
| #include "lldb/Target/Target.h" |
| #include "lldb/Utility/Status.h" |
| |
| using namespace lldb; |
| using namespace lldb_private; |
| |
| // if you add any options here, remember to update the counters in |
| // OptionGroupVariable::GetNumDefinitions() |
| static constexpr OptionDefinition g_variable_options[] = { |
| {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "no-args", 'a', |
| OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, |
| "Omit function arguments."}, |
| {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "no-recognized-args", 't', |
| OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, |
| "Omit recognized function arguments."}, |
| {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "no-locals", 'l', |
| OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, |
| "Omit local variables."}, |
| {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "show-globals", 'g', |
| OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, |
| "Show the current frame source file global and static variables."}, |
| {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "show-declaration", 'c', |
| OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, |
| "Show variable declaration information (source file and line where the " |
| "variable was declared)."}, |
| {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "regex", 'r', |
| OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeRegularExpression, |
| "The <variable-name> argument for name lookups are regular expressions."}, |
| {LLDB_OPT_SET_1 | LLDB_OPT_SET_2, false, "scope", 's', |
| OptionParser::eNoArgument, nullptr, {}, 0, eArgTypeNone, |
| "Show variable scope (argument, local, global, static)."}, |
| {LLDB_OPT_SET_1, false, "summary", 'y', OptionParser::eRequiredArgument, |
| nullptr, {}, 0, eArgTypeName, |
| "Specify the summary that the variable output should use."}, |
| {LLDB_OPT_SET_2, false, "summary-string", 'z', |
| OptionParser::eRequiredArgument, nullptr, {}, 0, eArgTypeName, |
| "Specify a summary string to use to format the variable output."}, |
| }; |
| |
| static Status ValidateNamedSummary(const char *str, void *) { |
| if (!str || !str[0]) |
| return Status("must specify a valid named summary"); |
| TypeSummaryImplSP summary_sp; |
| if (!DataVisualization::NamedSummaryFormats::GetSummaryFormat( |
| ConstString(str), summary_sp)) |
| return Status("must specify a valid named summary"); |
| return Status(); |
| } |
| |
| static Status ValidateSummaryString(const char *str, void *) { |
| if (!str || !str[0]) |
| return Status("must specify a non-empty summary string"); |
| return Status(); |
| } |
| |
| OptionGroupVariable::OptionGroupVariable(bool show_frame_options) |
| : include_frame_options(show_frame_options), summary(ValidateNamedSummary), |
| summary_string(ValidateSummaryString) {} |
| |
| Status |
| OptionGroupVariable::SetOptionValue(uint32_t option_idx, |
| llvm::StringRef option_arg, |
| ExecutionContext *execution_context) { |
| Status error; |
| if (!include_frame_options) |
| option_idx += 3; |
| const int short_option = g_variable_options[option_idx].short_option; |
| switch (short_option) { |
| case 'r': |
| use_regex = true; |
| break; |
| case 'a': |
| show_args = false; |
| break; |
| case 'l': |
| show_locals = false; |
| break; |
| case 'g': |
| show_globals = true; |
| break; |
| case 'c': |
| show_decl = true; |
| break; |
| case 's': |
| show_scope = true; |
| break; |
| case 't': |
| show_recognized_args = false; |
| break; |
| case 'y': |
| error = summary.SetCurrentValue(option_arg); |
| break; |
| case 'z': |
| error = summary_string.SetCurrentValue(option_arg); |
| break; |
| default: |
| llvm_unreachable("Unimplemented option"); |
| } |
| |
| return error; |
| } |
| |
| void OptionGroupVariable::OptionParsingStarting( |
| ExecutionContext *execution_context) { |
| show_args = true; // Frame option only |
| show_recognized_args = true; // Frame option only |
| show_locals = true; // Frame option only |
| show_globals = false; // Frame option only |
| show_decl = false; |
| use_regex = false; |
| show_scope = false; |
| summary.Clear(); |
| summary_string.Clear(); |
| } |
| |
| #define NUM_FRAME_OPTS 3 |
| |
| llvm::ArrayRef<OptionDefinition> OptionGroupVariable::GetDefinitions() { |
| auto result = llvm::makeArrayRef(g_variable_options); |
| // Show the "--no-args", "--no-locals" and "--show-globals" options if we are |
| // showing frame specific options |
| if (include_frame_options) |
| return result; |
| |
| // Skip the "--no-args", "--no-locals" and "--show-globals" options if we are |
| // not showing frame specific options (globals only) |
| return result.drop_front(NUM_FRAME_OPTS); |
| } |