LLDB mainline
CommandObjectSourceList::CommandOptions Class Reference
Inheritance diagram for CommandObjectSourceList::CommandOptions:
[legend]

Public Member Functions

 CommandOptions ()=default
 ~CommandOptions () override=default
Status SetOptionValue (uint32_t option_idx, llvm::StringRef option_arg, ExecutionContext *execution_context) override
 Set the value of an option.
void OptionParsingStarting (ExecutionContext *execution_context) override
llvm::ArrayRef< OptionDefinitionGetDefinitions () override
Public Member Functions inherited from lldb_private::Options
 Options ()
virtual ~Options ()
void BuildGetoptTable ()
void BuildValidOptionSets ()
uint32_t NumCommandOptions ()
OptionGetLongOptions ()
 Get the option definitions to use when parsing Args options.
void OptionSeen (int short_option)
llvm::Error VerifyOptions ()
llvm::Error VerifyPartialOptions ()
void OutputFormattedUsageText (Stream &strm, const OptionDefinition &option_def, uint32_t output_max_columns, bool use_color)
void GenerateOptionUsage (Stream &strm, CommandObject &cmd, uint32_t screen_width, bool use_color)
bool SupportsLongOption (const char *long_option)
void NotifyOptionParsingStarting (ExecutionContext *execution_context)
llvm::Expected< ArgsParse (const Args &args, ExecutionContext *execution_context, lldb::PlatformSP platform_sp, bool require_validation)
 Parse the provided arguments.
llvm::Expected< ArgsParseAlias (const Args &args, OptionArgVector *option_arg_vector, std::string &input_line)
OptionElementVector ParseForCompletion (const Args &args, uint32_t cursor_index)
Status NotifyOptionParsingFinished (ExecutionContext *execution_context)
bool HandleOptionCompletion (lldb_private::CompletionRequest &request, OptionElementVector &option_map, CommandInterpreter &interpreter)
 Handles the generic bits of figuring out whether we are in an option, and if so completing it.
virtual void HandleOptionArgumentCompletion (lldb_private::CompletionRequest &request, OptionElementVector &opt_element_vector, int opt_element_index, CommandInterpreter &interpreter)
 Handles the generic bits of figuring out whether we are in an option, and if so completing it.

Public Attributes

FileSpec file_spec
std::string file_name
std::string symbol_name
lldb::addr_t address
uint32_t start_line
uint32_t num_lines
std::vector< std::string > modules
bool show_bp_locs
bool reverse

Additional Inherited Members

Protected Types inherited from lldb_private::Options
typedef std::set< int > OptionSet
typedef std::vector< OptionSetOptionSetVector
Protected Member Functions inherited from lldb_private::Options
OptionSetVectorGetRequiredOptions ()
OptionSetVectorGetOptionalOptions ()
bool IsASubset (const OptionSet &set_a, const OptionSet &set_b)
size_t OptionsSetDiff (const OptionSet &set_a, const OptionSet &set_b, OptionSet &diffs)
void OptionsSetUnion (const OptionSet &set_a, const OptionSet &set_b, OptionSet &union_set)
virtual Status OptionParsingFinished (ExecutionContext *execution_context)
Protected Attributes inherited from lldb_private::Options
std::vector< Optionm_getopt_table
OptionSet m_seen_options
OptionSetVector m_required_options
OptionSetVector m_optional_options

Detailed Description

Definition at line 602 of file CommandObjectSource.cpp.

Constructor & Destructor Documentation

◆ CommandOptions()

CommandObjectSourceList::CommandOptions::CommandOptions ( )
default

◆ ~CommandOptions()

CommandObjectSourceList::CommandOptions::~CommandOptions ( )
overridedefault

Member Function Documentation

◆ GetDefinitions()

llvm::ArrayRef< OptionDefinition > CommandObjectSourceList::CommandOptions::GetDefinitions ( )
inlineoverridevirtual

Reimplemented from lldb_private::Options.

Definition at line 681 of file CommandObjectSource.cpp.

Referenced by SetOptionValue().

◆ OptionParsingStarting()

void CommandObjectSourceList::CommandOptions::OptionParsingStarting ( ExecutionContext * execution_context)
inlineoverridevirtual

◆ SetOptionValue()

Status CommandObjectSourceList::CommandOptions::SetOptionValue ( uint32_t option_idx,
llvm::StringRef option_arg,
ExecutionContext * execution_context )
inlineoverridevirtual

Set the value of an option.

Parameters
[in]option_idxThe index into the "struct option" array that was returned by Options::GetLongOptions().
[in]option_argThe argument value for the option that the user entered, or nullptr if there is no argument for the current option.
[in]execution_contextThe execution context to use for evaluating the option. May be nullptr if the option is to be evaluated outside any particular context.
See also
Args::ParseOptions (Options&)
man getopt_long_only

Implements lldb_private::Options.

Definition at line 608 of file CommandObjectSource.cpp.

References address, lldb_private::Status::AsCString(), error(), file_name, lldb_private::Status::FromErrorStringWithFormat(), GetDefinitions(), lldb_private::OptionValueFileColonLine::GetFileSpec(), lldb_private::OptionValueFileColonLine::GetLineNumber(), lldb_private::FileSpec::GetPath(), LLDB_INVALID_ADDRESS, modules, num_lines, reverse, lldb_private::OptionValueFileColonLine::SetValueFromString(), show_bp_locs, start_line, lldb_private::Status::Success(), symbol_name, and lldb_private::OptionArgParser::ToAddress().

Member Data Documentation

◆ address

lldb::addr_t CommandObjectSourceList::CommandOptions::address

Definition at line 689 of file CommandObjectSource.cpp.

Referenced by OptionParsingStarting(), and SetOptionValue().

◆ file_name

std::string CommandObjectSourceList::CommandOptions::file_name

Definition at line 687 of file CommandObjectSource.cpp.

Referenced by OptionParsingStarting(), and SetOptionValue().

◆ file_spec

FileSpec CommandObjectSourceList::CommandOptions::file_spec

Definition at line 686 of file CommandObjectSource.cpp.

Referenced by OptionParsingStarting().

◆ modules

std::vector<std::string> CommandObjectSourceList::CommandOptions::modules

Definition at line 692 of file CommandObjectSource.cpp.

Referenced by OptionParsingStarting(), and SetOptionValue().

◆ num_lines

uint32_t CommandObjectSourceList::CommandOptions::num_lines

Definition at line 691 of file CommandObjectSource.cpp.

Referenced by OptionParsingStarting(), and SetOptionValue().

◆ reverse

bool CommandObjectSourceList::CommandOptions::reverse

Definition at line 694 of file CommandObjectSource.cpp.

Referenced by OptionParsingStarting(), and SetOptionValue().

◆ show_bp_locs

bool CommandObjectSourceList::CommandOptions::show_bp_locs

Definition at line 693 of file CommandObjectSource.cpp.

Referenced by OptionParsingStarting(), and SetOptionValue().

◆ start_line

uint32_t CommandObjectSourceList::CommandOptions::start_line

Definition at line 690 of file CommandObjectSource.cpp.

Referenced by OptionParsingStarting(), and SetOptionValue().

◆ symbol_name

std::string CommandObjectSourceList::CommandOptions::symbol_name

Definition at line 688 of file CommandObjectSource.cpp.

Referenced by OptionParsingStarting(), and SetOptionValue().


The documentation for this class was generated from the following file: