LLDB  mainline
Public Member Functions | Public Attributes | List of all members
CommandObjectCommandsScriptAdd::CommandOptions Class Reference
Inheritance diagram for CommandObjectCommandsScriptAdd::CommandOptions:
Inheritance graph
[legend]
Collaboration diagram for CommandObjectCommandsScriptAdd::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< OptionDefinition > GetDefinitions () 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 bool 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

std::string m_class_name
 
std::string m_funct_name
 
std::string m_short_help
 
ScriptedCommandSynchronicity m_synchronicity
 

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

Constructor & Destructor Documentation

◆ CommandOptions()

CommandObjectCommandsScriptAdd::CommandOptions::CommandOptions ( )
inline

Definition at line 1561 of file CommandObjectCommands.cpp.

◆ ~CommandOptions()

CommandObjectCommandsScriptAdd::CommandOptions::~CommandOptions ( )
overridedefault

Member Function Documentation

◆ GetDefinitions()

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

Reimplemented from lldb_private::Options.

Definition at line 1610 of file CommandObjectCommands.cpp.

References g_script_add_options.

◆ OptionParsingStarting()

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

◆ SetOptionValue()

Status CommandObjectCommandsScriptAdd::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 1567 of file CommandObjectCommands.cpp.

References lldb_private::Status::SetErrorStringWithFormat(), and lldb_private::Status::Success().

Member Data Documentation

◆ m_class_name

std::string CommandObjectCommandsScriptAdd::CommandOptions::m_class_name

Definition at line 1616 of file CommandObjectCommands.cpp.

◆ m_funct_name

std::string CommandObjectCommandsScriptAdd::CommandOptions::m_funct_name

Definition at line 1617 of file CommandObjectCommands.cpp.

◆ m_short_help

std::string CommandObjectCommandsScriptAdd::CommandOptions::m_short_help

Definition at line 1618 of file CommandObjectCommands.cpp.

◆ m_synchronicity

ScriptedCommandSynchronicity CommandObjectCommandsScriptAdd::CommandOptions::m_synchronicity

Definition at line 1619 of file CommandObjectCommands.cpp.


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