lldb_private::OptionValueString Class Reference

#include <OptionValueString.h>

Inheritance diagram for lldb_private::OptionValueString:

Public Types
enum	Options { eOptionEncodeCharacterEscapeSequences = (1u << 0) }
typedef Status(*	ValidatorCallback) (const char *string, void *baton)
Public Types inherited from lldb_private::OptionValue
enum	Type {   eTypeInvalid = 0 , eTypeArch , eTypeArgs , eTypeArray ,   eTypeBoolean , eTypeChar , eTypeDictionary , eTypeEnum ,   eTypeFileLineColumn , eTypeFileSpec , eTypeFileSpecList , eTypeFormat ,   eTypeLanguage , eTypePathMap , eTypeProperties , eTypeRegex ,   eTypeSInt64 , eTypeString , eTypeUInt64 , eTypeUUID ,   eTypeFormatEntity }
enum	{   eDumpOptionName = (1u << 0) , eDumpOptionType = (1u << 1) , eDumpOptionValue = (1u << 2) , eDumpOptionDescription = (1u << 3) ,   eDumpOptionRaw = (1u << 4) , eDumpOptionCommand = (1u << 5) , eDumpOptionDefaultValue = (1u << 6) , eDumpGroupValue = (eDumpOptionName | eDumpOptionType | eDumpOptionValue) ,   eDumpGroupHelp , eDumpGroupExport = (eDumpOptionCommand | eDumpOptionName | eDumpOptionValue) }

Public Member Functions
	OptionValueString ()=default
	OptionValueString (ValidatorCallback validator, void *baton=nullptr)
	OptionValueString (const char *value)
	OptionValueString (const char *current_value, const char *default_value)
	OptionValueString (const char *value, ValidatorCallback validator, void *baton=nullptr)
	OptionValueString (const char *current_value, const char *default_value, ValidatorCallback validator, void *baton=nullptr)
	~OptionValueString () override=default
OptionValue::Type	GetType () const override
void	DumpValue (const ExecutionContext *exe_ctx, Stream &strm, uint32_t dump_mask) override
llvm::json::Value	ToJSON (const ExecutionContext *exe_ctx) const override
Status	SetValueFromString (llvm::StringRef value, VarSetOperationType op=eVarSetOperationAssign) override
void	Clear () override
Flags &	GetOptions ()
const Flags &	GetOptions () const
const char *	operator= (const char *value)
const char *	GetCurrentValue () const
llvm::StringRef	GetCurrentValueAsRef () const
const char *	GetDefaultValue () const
llvm::StringRef	GetDefaultValueAsRef () const
Status	SetCurrentValue (llvm::StringRef value)
Status	AppendToCurrentValue (const char *value)
void	SetDefaultValue (const char *value)
bool	IsCurrentValueEmpty () const
bool	IsDefaultValueEmpty () const
void	SetValidator (ValidatorCallback validator, void *baton=nullptr)
Public Member Functions inherited from lldb_private::Cloneable< OptionValueString, OptionValue >
std::shared_ptr< typename OptionValue::TopmostBase >	Clone () const override
Public Member Functions inherited from lldb_private::OptionValue
	OptionValue ()=default
virtual	~OptionValue ()=default
	OptionValue (const OptionValue &other)
OptionValue &	operator= (const OptionValue &other)
virtual bool	ValueIsTransparent () const
virtual const char *	GetTypeAsCString () const
virtual lldb::OptionValueSP	DeepCopy (const lldb::OptionValueSP &new_parent) const
virtual void	AutoComplete (CommandInterpreter &interpreter, CompletionRequest &request)
virtual lldb::OptionValueSP	GetSubValue (const ExecutionContext *exe_ctx, llvm::StringRef name, Status &error) const
virtual Status	SetSubValue (const ExecutionContext *exe_ctx, VarSetOperationType op, llvm::StringRef name, llvm::StringRef value)
virtual bool	IsAggregateValue () const
virtual llvm::StringRef	GetName () const
virtual bool	DumpQualifiedName (Stream &strm) const
uint32_t	GetTypeAsMask ()
OptionValueArch *	GetAsArch ()
const OptionValueArch *	GetAsArch () const
OptionValueArray *	GetAsArray ()
const OptionValueArray *	GetAsArray () const
OptionValueArgs *	GetAsArgs ()
const OptionValueArgs *	GetAsArgs () const
OptionValueBoolean *	GetAsBoolean ()
const OptionValueBoolean *	GetAsBoolean () const
OptionValueChar *	GetAsChar ()
const OptionValueChar *	GetAsChar () const
OptionValueDictionary *	GetAsDictionary ()
const OptionValueDictionary *	GetAsDictionary () const
OptionValueEnumeration *	GetAsEnumeration ()
const OptionValueEnumeration *	GetAsEnumeration () const
OptionValueFileSpec *	GetAsFileSpec ()
const OptionValueFileSpec *	GetAsFileSpec () const
OptionValueFileSpecList *	GetAsFileSpecList ()
const OptionValueFileSpecList *	GetAsFileSpecList () const
OptionValueFormat *	GetAsFormat ()
const OptionValueFormat *	GetAsFormat () const
OptionValueLanguage *	GetAsLanguage ()
const OptionValueLanguage *	GetAsLanguage () const
OptionValuePathMappings *	GetAsPathMappings ()
const OptionValuePathMappings *	GetAsPathMappings () const
OptionValueProperties *	GetAsProperties ()
const OptionValueProperties *	GetAsProperties () const
OptionValueRegex *	GetAsRegex ()
const OptionValueRegex *	GetAsRegex () const
OptionValueSInt64 *	GetAsSInt64 ()
const OptionValueSInt64 *	GetAsSInt64 () const
OptionValueString *	GetAsString ()
const OptionValueString *	GetAsString () const
OptionValueUInt64 *	GetAsUInt64 ()
const OptionValueUInt64 *	GetAsUInt64 () const
OptionValueUUID *	GetAsUUID ()
const OptionValueUUID *	GetAsUUID () const
OptionValueFormatEntity *	GetAsFormatEntity ()
const OptionValueFormatEntity *	GetAsFormatEntity () const
bool	AppendFileSpecValue (FileSpec file_spec)
bool	OptionWasSet () const
void	SetOptionWasSet ()
void	SetParent (const lldb::OptionValueSP &parent_sp)
lldb::OptionValueSP	GetParent () const
void	SetValueChangedCallback (std::function< void()> callback)
void	NotifyValueChanged ()
template<typename T, std::enable_if_t<!std::is_pointer_v< T >, bool > = true>
std::optional< T >	GetValueAs () const
template<typename T, typename U = typename std::remove_const< typename std::remove_pointer<T>::type>::type, std::enable_if_t< std::is_pointer_v< T >, bool > = true>
T	GetValueAs () const
bool	SetValueAs (bool v)
bool	SetValueAs (char v)
bool	SetValueAs (uint64_t v)
bool	SetValueAs (int64_t v)
bool	SetValueAs (UUID v)
bool	SetValueAs (llvm::StringRef v)
bool	SetValueAs (lldb::LanguageType v)
bool	SetValueAs (lldb::Format v)
bool	SetValueAs (FileSpec v)
bool	SetValueAs (ArchSpec v)
bool	SetValueAs (const FormatEntity::Entry &v)
template<typename T, std::enable_if_t< std::is_enum_v< T >, bool > = true>
bool	SetValueAs (T t)

Protected Attributes
std::string	m_current_value
std::string	m_default_value
Flags	m_options
ValidatorCallback	m_validator = nullptr
void *	m_validator_baton = nullptr
Protected Attributes inherited from lldb_private::OptionValue
lldb::OptionValueWP	m_parent_wp
std::function< void()>	m_callback
bool	m_value_was_set = false

Additional Inherited Members
Static Public Member Functions inherited from lldb_private::OptionValue
static const char *	GetBuiltinTypeAsCString (Type t)
static uint32_t	ConvertTypeToMask (OptionValue::Type type)
static OptionValue::Type	ConvertTypeMaskToType (uint32_t type_mask)
static lldb::OptionValueSP	CreateValueFromCStringForTypeMask (const char *value_cstr, uint32_t type_mask, Status &error)
Protected Types inherited from lldb_private::OptionValue
using	TopmostBase = OptionValue

Detailed Description

Definition at line 20 of file OptionValueString.h.

Member Typedef Documentation

ValidatorCallback

typedef Status(* lldb_private::OptionValueString::ValidatorCallback) (const char *string, void *baton)

Definition at line 22 of file OptionValueString.h.

Member Enumeration Documentation

Options

enum lldb_private::OptionValueString::Options

Enumerator
eOptionEncodeCharacterEscapeSequences

Definition at line 24 of file OptionValueString.h.

Constructor & Destructor Documentation

OptionValueString() [1/6]

lldb_private::OptionValueString::OptionValueString ( )

default

OptionValueString() [2/6]

lldb_private::OptionValueString::OptionValueString ( ValidatorCallback validator, void * baton = nullptr )

inline

Definition at line 28 of file OptionValueString.h.

References m_validator, m_validator_baton, and lldb_private::validator.

OptionValueString() [3/6]

lldb_private::OptionValueString::OptionValueString ( const char * value )

inline

Definition at line 31 of file OptionValueString.h.

References m_current_value, and m_default_value.

OptionValueString() [4/6]

lldb_private::OptionValueString::OptionValueString ( const char * current_value, const char * default_value )

inline

Definition at line 38 of file OptionValueString.h.

References m_current_value, and m_default_value.

OptionValueString() [5/6]

lldb_private::OptionValueString::OptionValueString ( const char * value, ValidatorCallback validator, void * baton = nullptr )

inline

Definition at line 45 of file OptionValueString.h.

References m_current_value, m_default_value, m_validator, m_validator_baton, and lldb_private::validator.

OptionValueString() [6/6]

lldb_private::OptionValueString::OptionValueString ( const char * current_value, const char * default_value, ValidatorCallback validator, void * baton = nullptr )

inline

Definition at line 54 of file OptionValueString.h.

References m_current_value, m_default_value, m_validator, m_validator_baton, and lldb_private::validator.

~OptionValueString()

lldb_private::OptionValueString::~OptionValueString ( )

overridedefault

Member Function Documentation

AppendToCurrentValue()

Status OptionValueString::AppendToCurrentValue

(

const char *

value

)

Definition at line 140 of file OptionValueString.cpp.

References error(), m_current_value, m_validator, m_validator_baton, and lldb_private::Status.

Clear()

void lldb_private::OptionValueString::Clear ( )

inlineoverridevirtual

Implements lldb_private::OptionValue.

Definition at line 80 of file OptionValueString.h.

References m_current_value, m_default_value, and lldb_private::OptionValue::m_value_was_set.

Referenced by SetValueFromString().

DumpValue()

void OptionValueString::DumpValue ( const ExecutionContext * exe_ctx, Stream & strm, uint32_t dump_mask )

overridevirtual

Implements lldb_private::OptionValue.

Definition at line 34 of file OptionValueString.cpp.

References DumpString(), lldb_private::OptionValue::eDumpOptionDefaultValue, lldb_private::OptionValue::eDumpOptionRaw, lldb_private::OptionValue::eDumpOptionType, lldb_private::OptionValue::eDumpOptionValue, eOptionEncodeCharacterEscapeSequences, lldb_private::OptionValue::GetTypeAsCString(), m_current_value, m_default_value, m_options, lldb_private::OptionValue::m_value_was_set, lldb_private::Stream::Printf(), and lldb_private::Stream::PutCString().

GetCurrentValue()

const char * lldb_private::OptionValueString::GetCurrentValue ( ) const

inline

Definition at line 96 of file OptionValueString.h.

References m_current_value.

Referenced by PlatformDarwinProperties::GetIgnoredExceptions().

GetCurrentValueAsRef()

llvm::StringRef lldb_private::OptionValueString::GetCurrentValueAsRef ( ) const

inline

Definition at line 97 of file OptionValueString.h.

References m_current_value.

GetDefaultValue()

const char * lldb_private::OptionValueString::GetDefaultValue ( ) const

inline

Definition at line 99 of file OptionValueString.h.

References m_default_value.

GetDefaultValueAsRef()

llvm::StringRef lldb_private::OptionValueString::GetDefaultValueAsRef ( ) const

inline

Definition at line 100 of file OptionValueString.h.

References m_default_value.

GetOptions() [1/2]

Flags & lldb_private::OptionValueString::GetOptions ( )

inline

Definition at line 87 of file OptionValueString.h.

References m_options.

GetOptions() [2/2]

const Flags & lldb_private::OptionValueString::GetOptions ( ) const

inline

Definition at line 89 of file OptionValueString.h.

References m_options.

GetType()

OptionValue::Type lldb_private::OptionValueString::GetType ( ) const

inlineoverridevirtual

Implements lldb_private::OptionValue.

Definition at line 67 of file OptionValueString.h.

References lldb_private::OptionValue::eTypeString.

IsCurrentValueEmpty()

bool lldb_private::OptionValueString::IsCurrentValueEmpty ( ) const

inline

Definition at line 113 of file OptionValueString.h.

References m_current_value.

IsDefaultValueEmpty()

bool lldb_private::OptionValueString::IsDefaultValueEmpty ( ) const

inline

Definition at line 115 of file OptionValueString.h.

References m_default_value.

operator=()

const char * lldb_private::OptionValueString::operator= ( const char * value )

inline

Definition at line 91 of file OptionValueString.h.

References m_current_value, and SetCurrentValue().

SetCurrentValue()

Status OptionValueString::SetCurrentValue

(

llvm::StringRef

value

)

Definition at line 130 of file OptionValueString.cpp.

References error(), m_current_value, m_validator, m_validator_baton, and lldb_private::Status.

Referenced by operator=(), and SetValueFromString().

SetDefaultValue()

void lldb_private::OptionValueString::SetDefaultValue ( const char * value )

inline

Definition at line 106 of file OptionValueString.h.

References m_default_value.

SetValidator()

void lldb_private::OptionValueString::SetValidator ( ValidatorCallback validator, void * baton = nullptr )

inline

Definition at line 117 of file OptionValueString.h.

References m_validator, m_validator_baton, and lldb_private::validator.

Referenced by lldb_private::PlatformDarwin::DebuggerInitialize().

SetValueFromString()

Status OptionValueString::SetValueFromString ( llvm::StringRef value, VarSetOperationType op = eVarSetOperationAssign )

overridevirtual

Reimplemented from lldb_private::OptionValue.

Definition at line 54 of file OptionValueString.cpp.

References Clear(), lldb_private::Args::EncodeEscapeSequences(), eOptionEncodeCharacterEscapeSequences, error(), lldb_private::eVarSetOperationAppend, lldb_private::eVarSetOperationAssign, lldb_private::eVarSetOperationClear, lldb_private::eVarSetOperationInsertAfter, lldb_private::eVarSetOperationInsertBefore, lldb_private::eVarSetOperationInvalid, lldb_private::eVarSetOperationRemove, lldb_private::eVarSetOperationReplace, lldb_private::Status::FromErrorString(), m_current_value, m_options, m_validator, m_validator_baton, lldb_private::OptionValue::m_value_was_set, lldb_private::OptionValue::NotifyValueChanged(), SetCurrentValue(), and lldb_private::OptionValue::SetValueFromString().

ToJSON()

llvm::json::Value lldb_private::OptionValueString::ToJSON ( const ExecutionContext * exe_ctx ) const

inlineoverridevirtual

Implements lldb_private::OptionValue.

Definition at line 72 of file OptionValueString.h.

References m_current_value.

Member Data Documentation

m_current_value

std::string lldb_private::OptionValueString::m_current_value

protected

Definition at line 123 of file OptionValueString.h.

Referenced by AppendToCurrentValue(), Clear(), DumpValue(), GetCurrentValue(), GetCurrentValueAsRef(), IsCurrentValueEmpty(), operator=(), OptionValueString(), OptionValueString(), OptionValueString(), OptionValueString(), SetCurrentValue(), SetValueFromString(), and ToJSON().

m_default_value

std::string lldb_private::OptionValueString::m_default_value

protected

Definition at line 124 of file OptionValueString.h.

Referenced by Clear(), DumpValue(), GetDefaultValue(), GetDefaultValueAsRef(), IsDefaultValueEmpty(), OptionValueString(), OptionValueString(), OptionValueString(), OptionValueString(), and SetDefaultValue().

m_options

Flags lldb_private::OptionValueString::m_options

protected

Definition at line 125 of file OptionValueString.h.

Referenced by DumpValue(), GetOptions(), GetOptions(), and SetValueFromString().

m_validator

ValidatorCallback lldb_private::OptionValueString::m_validator = nullptr

protected

Definition at line 126 of file OptionValueString.h.

Referenced by AppendToCurrentValue(), OptionValueString(), OptionValueString(), OptionValueString(), SetCurrentValue(), SetValidator(), and SetValueFromString().

m_validator_baton

void* lldb_private::OptionValueString::m_validator_baton = nullptr

protected

Definition at line 127 of file OptionValueString.h.

Referenced by AppendToCurrentValue(), OptionValueString(), OptionValueString(), OptionValueString(), SetCurrentValue(), SetValidator(), and SetValueFromString().

---

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

• OptionValueString.h
• OptionValueString.cpp