LLDB  mainline
Public Member Functions | Public Attributes | List of all members
CommandObjectSourceList::CommandOptions Class Reference
Inheritance diagram for CommandObjectSourceList::CommandOptions:
Inheritance graph
[legend]
Collaboration diagram for CommandObjectSourceList::CommandOptions:
Collaboration graph
[legend]

Public Member Functions

 CommandOptions ()
 
 ~CommandOptions () override=default
 
Status SetOptionValue (uint32_t option_idx, llvm::StringRef option_arg, ExecutionContext *execution_context) override
 Set the value of an option. More...
 
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. More...
 
void OptionSeen (int short_option)
 
bool VerifyOptions (CommandReturnObject &result)
 
bool VerifyPartialOptions (CommandReturnObject &result)
 
void OutputFormattedUsageText (Stream &strm, const OptionDefinition &option_def, uint32_t output_max_columns)
 
void GenerateOptionUsage (Stream &strm, CommandObject *cmd, uint32_t screen_width)
 
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. More...
 
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. More...
 
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. More...
 

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::stringmodules
 
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 625 of file CommandObjectSource.cpp.

Constructor & Destructor Documentation

◆ CommandOptions()

CommandObjectSourceList::CommandOptions::CommandOptions ( )
inline

Definition at line 627 of file CommandObjectSource.cpp.

◆ ~CommandOptions()

CommandObjectSourceList::CommandOptions::~CommandOptions ( )
overridedefault

Member Function Documentation

◆ GetDefinitions()

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

Reimplemented from lldb_private::Options.

Definition at line 705 of file CommandObjectSource.cpp.

◆ OptionParsingStarting()

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

Implements lldb_private::Options.

Definition at line 693 of file CommandObjectSource.cpp.

References LLDB_INVALID_ADDRESS.

◆ 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 631 of file CommandObjectSource.cpp.

References lldb_private::Status::AsCString(), error(), lldb_private::OptionValueFileColonLine::GetFileSpec(), lldb_private::OptionValueFileColonLine::GetLineNumber(), lldb_private::FileSpec::GetPath(), LLDB_INVALID_ADDRESS, lldb_private::OptionValueFileColonLine::SetValueFromString(), string(), and lldb_private::Status::Success().

Member Data Documentation

◆ address

lldb::addr_t CommandObjectSourceList::CommandOptions::address

Definition at line 713 of file CommandObjectSource.cpp.

◆ file_name

std::string CommandObjectSourceList::CommandOptions::file_name

Definition at line 711 of file CommandObjectSource.cpp.

◆ file_spec

FileSpec CommandObjectSourceList::CommandOptions::file_spec

Definition at line 710 of file CommandObjectSource.cpp.

◆ modules

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

Definition at line 716 of file CommandObjectSource.cpp.

◆ num_lines

uint32_t CommandObjectSourceList::CommandOptions::num_lines

Definition at line 715 of file CommandObjectSource.cpp.

◆ reverse

bool CommandObjectSourceList::CommandOptions::reverse

Definition at line 718 of file CommandObjectSource.cpp.

◆ show_bp_locs

bool CommandObjectSourceList::CommandOptions::show_bp_locs

Definition at line 717 of file CommandObjectSource.cpp.

◆ start_line

uint32_t CommandObjectSourceList::CommandOptions::start_line

Definition at line 714 of file CommandObjectSource.cpp.

◆ symbol_name

std::string CommandObjectSourceList::CommandOptions::symbol_name

Definition at line 712 of file CommandObjectSource.cpp.


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