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

Public Member Functions

 CommandOptions ()=default
 
 ~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

FileSpec log_file
 
OptionValueUInt64 buffer_size
 
LogHandlerKind handler = eLogHandlerStream
 
uint32_t log_options = 0
 

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 82 of file CommandObjectLog.cpp.

Constructor & Destructor Documentation

◆ CommandOptions()

CommandObjectLogEnable::CommandOptions::CommandOptions ( )
default

◆ ~CommandOptions()

CommandObjectLogEnable::CommandOptions::~CommandOptions ( )
overridedefault

Member Function Documentation

◆ GetDefinitions()

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

Reimplemented from lldb_private::Options.

Definition at line 148 of file CommandObjectLog.cpp.

◆ OptionParsingStarting()

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

Implements lldb_private::Options.

Definition at line 141 of file CommandObjectLog.cpp.

References lldb_private::eLogHandlerStream.

◆ SetOptionValue()

Status CommandObjectLogEnable::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 88 of file CommandObjectLog.cpp.

References error(), lldb_private::eVarSetOperationAssign, LLDB_LOG_OPTION_APPEND, LLDB_LOG_OPTION_BACKTRACE, LLDB_LOG_OPTION_PREPEND_FILE_FUNCTION, LLDB_LOG_OPTION_PREPEND_PROC_AND_THREAD, LLDB_LOG_OPTION_PREPEND_SEQUENCE, LLDB_LOG_OPTION_PREPEND_THREAD_NAME, LLDB_LOG_OPTION_PREPEND_TIMESTAMP, and LLDB_LOG_OPTION_VERBOSE.

Member Data Documentation

◆ buffer_size

OptionValueUInt64 CommandObjectLogEnable::CommandOptions::buffer_size

Definition at line 153 of file CommandObjectLog.cpp.

◆ handler

LogHandlerKind CommandObjectLogEnable::CommandOptions::handler = eLogHandlerStream

Definition at line 154 of file CommandObjectLog.cpp.

◆ log_file

FileSpec CommandObjectLogEnable::CommandOptions::log_file

Definition at line 152 of file CommandObjectLog.cpp.

◆ log_options

uint32_t CommandObjectLogEnable::CommandOptions::log_options = 0

Definition at line 155 of file CommandObjectLog.cpp.


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