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

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

OptionValueBoolean m_stop_on_error
OptionValueBoolean m_silent_run
OptionValueBoolean m_stop_on_continue
OptionValueBoolean m_cmd_relative_to_command_file

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 76 of file CommandObjectCommands.cpp.

Constructor & Destructor Documentation

◆ CommandOptions()

CommandObjectCommandsSource::CommandOptions::CommandOptions ( )

Definition at line 78 of file CommandObjectCommands.cpp.

◆ ~CommandOptions()

CommandObjectCommandsSource::CommandOptions::~CommandOptions ( )

Member Function Documentation

◆ GetDefinitions()

llvm::ArrayRef<OptionDefinition> CommandObjectCommandsSource::CommandOptions::GetDefinitions ( )

Reimplemented from lldb_private::Options.

Definition at line 120 of file CommandObjectCommands.cpp.

◆ OptionParsingStarting()

void CommandObjectCommandsSource::CommandOptions::OptionParsingStarting ( ExecutionContext execution_context)

Implements lldb_private::Options.

Definition at line 113 of file CommandObjectCommands.cpp.

◆ SetOptionValue()

Status CommandObjectCommandsSource::CommandOptions::SetOptionValue ( uint32_t  option_idx,
llvm::StringRef  option_arg,
ExecutionContext execution_context 

Set the value of an option.

[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 84 of file CommandObjectCommands.cpp.

References error().

Member Data Documentation

◆ m_cmd_relative_to_command_file

OptionValueBoolean CommandObjectCommandsSource::CommandOptions::m_cmd_relative_to_command_file

Definition at line 129 of file CommandObjectCommands.cpp.

◆ m_silent_run

OptionValueBoolean CommandObjectCommandsSource::CommandOptions::m_silent_run

Definition at line 127 of file CommandObjectCommands.cpp.

◆ m_stop_on_continue

OptionValueBoolean CommandObjectCommandsSource::CommandOptions::m_stop_on_continue

Definition at line 128 of file CommandObjectCommands.cpp.

◆ m_stop_on_error

OptionValueBoolean CommandObjectCommandsSource::CommandOptions::m_stop_on_error

Definition at line 126 of file CommandObjectCommands.cpp.

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