Inheritance diagram for CommandObjectScriptingObjectParsed::CommandOptions:

[legend]

Classes
struct	EnumValueStorage

Public Member Functions
	CommandOptions (CommandInterpreter &interpreter, StructuredData::GenericSP cmd_obj_sp)
	~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< OptionDefinition >	GetDefinitions () override
Status	SetOptionsFromArray (StructuredData::Dictionary &options)
size_t	GetNumOptions ()
void	PrepareOptionsForCompletion (CompletionRequest &request, OptionElementVector &option_vec, ExecutionContext *exe_ctx)
void	ProcessCompletionDict (CompletionRequest &request, StructuredData::DictionarySP &completion_dict_sp)
void	HandleOptionArgumentCompletion (lldb_private::CompletionRequest &request, OptionElementVector &option_vec, int opt_element_index, CommandInterpreter &interpreter) override
	Handles the generic bits of figuring out whether we are in an option, and if so completing it.
Public Member Functions inherited from lldb_private::Options
	Options ()
virtual	~Options ()
void	BuildGetoptTable ()
void	BuildValidOptionSets ()
uint32_t	NumCommandOptions ()
Option *	GetLongOptions ()
	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< Args >	Parse (const Args &args, ExecutionContext *execution_context, lldb::PlatformSP platform_sp, bool require_validation)
	Parse the provided arguments.
llvm::Expected< Args >	ParseAlias (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.

Static Public Member Functions
static Status	ParseUsageMaskFromArray (StructuredData::ObjectSP obj_sp, size_t counter, uint32_t &usage_mask)

Private Attributes
size_t	m_num_options = 0
std::unique_ptr< OptionDefinition >	m_options_definition_up
std::vector< std::vector< EnumValueStorage > >	m_enum_storage
std::vector< std::vector< OptionEnumValueElement > >	m_enum_vector
std::vector< std::string >	m_usage_container
CommandInterpreter &	m_interpreter
StructuredData::GenericSP	m_cmd_obj_sp

Static Private Attributes
static std::unordered_set< std::string >	g_string_storer

Additional Inherited Members
Protected Types inherited from lldb_private::Options
typedef std::set< int >	OptionSet
typedef std::vector< OptionSet >	OptionSetVector
Protected Member Functions inherited from lldb_private::Options
OptionSetVector &	GetRequiredOptions ()
OptionSetVector &	GetOptionalOptions ()
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< Option >	m_getopt_table
OptionSet	m_seen_options
OptionSetVector	m_required_options
OptionSetVector	m_optional_options

Detailed Description

Definition at line 1243 of file CommandObjectCommands.cpp.

Constructor & Destructor Documentation

◆ CommandOptions()

CommandObjectScriptingObjectParsed::CommandOptions::CommandOptions	(	CommandInterpreter &	interpreter,
		StructuredData::GenericSP	cmd_obj_sp )

inline

Definition at line 1245 of file CommandObjectCommands.cpp.

References m_cmd_obj_sp, and m_interpreter.

◆ ~CommandOptions()

CommandObjectScriptingObjectParsed::CommandOptions::~CommandOptions ( )

overridedefault

Member Function Documentation

◆ GetDefinitions()

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

inlineoverridevirtual

Reimplemented from lldb_private::Options.

Definition at line 1294 of file CommandObjectCommands.cpp.

References m_num_options, and m_options_definition_up.

Referenced by HandleOptionArgumentCompletion(), and PrepareOptionsForCompletion().

◆ GetNumOptions()

size_t CommandObjectScriptingObjectParsed::CommandOptions::GetNumOptions ( )

inline

Definition at line 1641 of file CommandObjectCommands.cpp.

References m_num_options.

◆ HandleOptionArgumentCompletion()

void CommandObjectScriptingObjectParsed::CommandOptions::HandleOptionArgumentCompletion	(	lldb_private::CompletionRequest &	request,
		OptionElementVector &	opt_element_vector,
		int	opt_element_index,
		CommandInterpreter &	interpreter )

inlineoverridevirtual

Handles the generic bits of figuring out whether we are in an option, and if so completing it.

Parameters

[in,out]	request	The completion request that we need to act upon.
[in]	interpreter	The command interpreter doing the completion.

Reimplemented from lldb_private::Options.

Definition at line 1729 of file CommandObjectCommands.cpp.

References lldb_private::CompletionRequest::GetCursorCharPos(), lldb_private::CommandInterpreter::GetDebugger(), GetDefinitions(), lldb_private::CommandInterpreter::GetExecutionContext(), lldb_private::Debugger::GetScriptInterpreter(), lldb_private::Options::HandleOptionArgumentCompletion(), lldb_private::ScriptInterpreter::HandleOptionArgumentCompletionForScriptedCommand(), m_cmd_obj_sp, PrepareOptionsForCompletion(), and ProcessCompletionDict().

◆ OptionParsingStarting()

void CommandObjectScriptingObjectParsed::CommandOptions::OptionParsingStarting ( ExecutionContext * execution_context )

inlineoverridevirtual

Implements lldb_private::Options.

Definition at line 1285 of file CommandObjectCommands.cpp.

References m_cmd_obj_sp, m_interpreter, and lldb_private::ScriptInterpreter::OptionParsingStartedForCommandObject().

Referenced by PrepareOptionsForCompletion().

◆ ParseUsageMaskFromArray()

Status CommandObjectScriptingObjectParsed::CommandOptions::ParseUsageMaskFromArray	(	StructuredData::ObjectSP	obj_sp,
		size_t	counter,
		uint32_t &	usage_mask )

inlinestatic

Definition at line 1300 of file CommandObjectCommands.cpp.

References error(), lldb_private::StructuredData::Array::ForEach(), lldb_private::Status::FromErrorStringWithFormatv(), lldb_private::StructuredData::Object::GetAsArray(), lldb_private::StructuredData::Array::GetItemAtIndex(), lldb_private::StructuredData::Array::GetSize(), lldb_private::StructuredData::Integer< N >::GetValue(), and LLDB_OPT_SET_ALL.

Referenced by CommandObjectScriptingObjectParsed::CommandObjectScriptingObjectParsed(), and SetOptionsFromArray().

◆ PrepareOptionsForCompletion()

void CommandObjectScriptingObjectParsed::CommandOptions::PrepareOptionsForCompletion	(	CompletionRequest &	request,
		OptionElementVector &	option_vec,
		ExecutionContext *	exe_ctx )

inline

Definition at line 1643 of file CommandObjectCommands.cpp.

References lldb_private::OptionArgElement::eBareDash, lldb_private::OptionArgElement::eBareDoubleDash, lldb_private::OptionArgElement::eUnrecognizedArg, lldb_private::Args::GetArgumentAtIndex(), GetDefinitions(), lldb_private::CompletionRequest::GetParsedLine(), lldb_private::Options::OptionParsingFinished(), OptionParsingStarting(), and SetOptionValue().

Referenced by HandleOptionArgumentCompletion().

◆ ProcessCompletionDict()

void CommandObjectScriptingObjectParsed::CommandOptions::ProcessCompletionDict	(	CompletionRequest &	request,
		StructuredData::DictionarySP &	completion_dict_sp )

inline

Definition at line 1678 of file CommandObjectCommands.cpp.

References lldb_private::CompletionRequest::AddCompletion(), lldb_private::StructuredData::Array::GetItemAtIndexAsString(), lldb_private::StructuredData::Array::GetSize(), lldb_private::Normal, and lldb_private::Partial.

Referenced by HandleOptionArgumentCompletion().

◆ SetOptionsFromArray()

Status CommandObjectScriptingObjectParsed::CommandOptions::SetOptionsFromArray ( StructuredData::Dictionary & options )

inline

Definition at line 1399 of file CommandObjectCommands.cpp.

◆ SetOptionValue()

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

inlineoverridevirtual

Set the value of an option.

Parameters

[in]	option_idx	The index into the "struct option" array that was returned by Options::GetLongOptions().
[in]	option_arg	The argument value for the option that the user entered, or nullptr if there is no argument for the current option.
[in]	execution_context	The execution context to use for evaluating the option. May be nullptr if the option is to be evaluated outside any particular context.