#include <OptionDefinition.h>

Public Member Functions
bool	HasShortOption () const
	Whether this has a short option character.

Public Attributes
uint32_t	usage_mask
	Used to mark options that can be used together.
bool	required
	This option is required (in the current usage level).
const char *	long_option
	Full name for this option.
int	short_option
	Single character for this option.
int	option_has_arg
	no_argument, required_argument or optional_argument
OptionValidator *	validator
	If non-NULL, option is valid iff \|validator->IsValid()\|, otherwise always valid.
OptionEnumValues	enum_values
	If not empty, an array of enum values.
uint32_t	completion_type
	The kind of completion for this option.
lldb::CommandArgumentType	argument_type
	Type of argument this option takes.
const char *	usage_text
	Full text explaining what this options does and what (if any) argument to pass it.

Detailed Description

Definition at line 20 of file OptionDefinition.h.

Member Function Documentation

◆ HasShortOption()

bool lldb_private::OptionDefinition::HasShortOption ( ) const

inline

Whether this has a short option character.

Definition at line 50 of file OptionDefinition.h.

References short_option.

Referenced by lldb_private::Options::GenerateOptionUsage(), and PrintOption().

Member Data Documentation

◆ argument_type

lldb::CommandArgumentType lldb_private::OptionDefinition::argument_type

Type of argument this option takes.

Definition at line 44 of file OptionDefinition.h.

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

◆ completion_type

uint32_t lldb_private::OptionDefinition::completion_type

The kind of completion for this option.

Contains values of the lldb::CompletionType enum.

Definition at line 42 of file OptionDefinition.h.

Referenced by CommandObjectScriptingObjectParsed::CommandOptions::SetOptionsFromArray().

◆ enum_values

OptionEnumValues lldb_private::OptionDefinition::enum_values

If not empty, an array of enum values.

Definition at line 39 of file OptionDefinition.h.

Referenced by lldb_private::Options::GenerateOptionUsage(), CommandObjectScriptingObjectParsed::CommandOptions::SetOptionsFromArray(), and CommandObjectCommandsScriptAdd::CommandOptions::SetOptionValue().

◆ long_option

const char* lldb_private::OptionDefinition::long_option

Full name for this option.

Definition at line 27 of file OptionDefinition.h.

Referenced by FindArgumentIndexForOption(), lldb_private::Options::HandleOptionCompletion(), lldb_private::OptionParser::Parse(), lldb_private::Options::Parse(), PrintOption(), and CommandObjectScriptingObjectParsed::CommandOptions::SetOptionsFromArray().

◆ option_has_arg

int lldb_private::OptionDefinition::option_has_arg

no_argument, required_argument or optional_argument

Definition at line 34 of file OptionDefinition.h.

Referenced by lldb_private::OptionParser::Parse(), lldb_private::Options::Parse(), lldb_private::Options::ParseAlias(), lldb_private::Options::ParseForCompletion(), PrintOption(), and CommandObjectScriptingObjectParsed::CommandOptions::SetOptionsFromArray().

◆ required

bool lldb_private::OptionDefinition::required

This option is required (in the current usage level).

Definition at line 25 of file OptionDefinition.h.

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

◆ short_option

int lldb_private::OptionDefinition::short_option

Single character for this option.

If the option doesn't use a short option character, this has to be a integer value that is not a printable ASCII code point and also unique in the used set of options.