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

Public Member Functions

 CommandOptions (CommandInterpreter &interpreter)
 ~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

TypeSummaryImpl::Flags m_flags
FormatterMatchType m_match_type = eFormatterMatchExact
std::string m_format_string
ConstString m_name
std::string m_python_script
std::string m_python_function
bool m_is_add_script = false
std::string m_category
uint32_t m_ptr_match_depth = 1

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 125 of file CommandObjectType.cpp.

Constructor & Destructor Documentation

◆ CommandOptions()

CommandObjectTypeSummaryAdd::CommandOptions::CommandOptions ( CommandInterpreter & interpreter)
inline

Definition at line 127 of file CommandObjectType.cpp.

◆ ~CommandOptions()

CommandObjectTypeSummaryAdd::CommandOptions::~CommandOptions ( )
overridedefault

Member Function Documentation

◆ GetDefinitions()

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

Reimplemented from lldb_private::Options.

Definition at line 136 of file CommandObjectType.cpp.

◆ OptionParsingStarting()

void CommandObjectTypeSummaryAdd::CommandOptions::OptionParsingStarting ( ExecutionContext * execution_context)
overridevirtual

◆ SetOptionValue()

Status CommandObjectTypeSummaryAdd::CommandOptions::SetOptionValue ( uint32_t option_idx,
llvm::StringRef option_arg,
ExecutionContext * execution_context )
overridevirtual

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 1151 of file CommandObjectType.cpp.

References lldb::eFormatterMatchCallback, lldb::eFormatterMatchRegex, error(), lldb_private::Status::FromErrorString(), lldb_private::Status::FromErrorStringWithFormat(), m_category, m_flags, m_format_string, lldb_private::Options::m_getopt_table, m_is_add_script, m_match_type, m_name, m_ptr_match_depth, m_python_function, m_python_script, and lldb_private::OptionArgParser::ToBoolean().

Member Data Documentation

◆ m_category

std::string CommandObjectTypeSummaryAdd::CommandOptions::m_category

Definition at line 149 of file CommandObjectType.cpp.

Referenced by OptionParsingStarting(), and SetOptionValue().

◆ m_flags

TypeSummaryImpl::Flags CommandObjectTypeSummaryAdd::CommandOptions::m_flags

Definition at line 142 of file CommandObjectType.cpp.

Referenced by OptionParsingStarting(), and SetOptionValue().

◆ m_format_string

std::string CommandObjectTypeSummaryAdd::CommandOptions::m_format_string

Definition at line 144 of file CommandObjectType.cpp.

Referenced by OptionParsingStarting(), and SetOptionValue().

◆ m_is_add_script

bool CommandObjectTypeSummaryAdd::CommandOptions::m_is_add_script = false

Definition at line 148 of file CommandObjectType.cpp.

Referenced by OptionParsingStarting(), and SetOptionValue().

◆ m_match_type

FormatterMatchType CommandObjectTypeSummaryAdd::CommandOptions::m_match_type = eFormatterMatchExact

Definition at line 143 of file CommandObjectType.cpp.

Referenced by OptionParsingStarting(), and SetOptionValue().

◆ m_name

ConstString CommandObjectTypeSummaryAdd::CommandOptions::m_name

Definition at line 145 of file CommandObjectType.cpp.

Referenced by OptionParsingStarting(), and SetOptionValue().

◆ m_ptr_match_depth

uint32_t CommandObjectTypeSummaryAdd::CommandOptions::m_ptr_match_depth = 1

Definition at line 150 of file CommandObjectType.cpp.

Referenced by SetOptionValue().

◆ m_python_function

std::string CommandObjectTypeSummaryAdd::CommandOptions::m_python_function

Definition at line 147 of file CommandObjectType.cpp.

Referenced by OptionParsingStarting(), and SetOptionValue().

◆ m_python_script

std::string CommandObjectTypeSummaryAdd::CommandOptions::m_python_script

Definition at line 146 of file CommandObjectType.cpp.

Referenced by OptionParsingStarting(), and SetOptionValue().


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