LLDB  mainline
Public Types | Public Member Functions | Protected Attributes | List of all members
lldb_private::OptionValueString Class Reference

#include <OptionValueString.h>

Inheritance diagram for lldb_private::OptionValueString:
Inheritance graph
[legend]
Collaboration diagram for lldb_private::OptionValueString:
Collaboration graph
[legend]

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,
  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), eDumpGroupValue = (eDumpOptionName | eDumpOptionType | eDumpOptionValue), eDumpGroupHelp,
  eDumpGroupExport = (eDumpOptionCommand | eDumpOptionName | eDumpOptionValue)
}
 

Public Member Functions

 OptionValueString ()
 
 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
 
Status SetValueFromString (llvm::StringRef value, VarSetOperationType op=eVarSetOperationAssign) override
 
Status SetValueFromString (const char *, VarSetOperationType=eVarSetOperationAssign)=delete
 
bool Clear () override
 
lldb::OptionValueSP DeepCopy () const 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 (const char *)=delete
 
Status SetCurrentValue (llvm::StringRef value)
 
Status AppendToCurrentValue (const char *value)
 
void SetDefaultValue (const char *value)
 
bool IsCurrentValueEmpty () const
 
bool IsDefaultValueEmpty () const
 
- Public Member Functions inherited from lldb_private::OptionValue
 OptionValue ()
 
 OptionValue (const OptionValue &rhs)
 
virtual ~OptionValue ()=default
 
virtual bool ValueIsTransparent () const
 
virtual const char * GetTypeAsCString () const
 
virtual size_t AutoComplete (CommandInterpreter &interpreter, CompletionRequest &request)
 
virtual lldb::OptionValueSP GetSubValue (const ExecutionContext *exe_ctx, llvm::StringRef name, bool will_modify, Status &error) const
 
virtual Status SetSubValue (const ExecutionContext *exe_ctx, VarSetOperationType op, llvm::StringRef name, llvm::StringRef value)
 
virtual bool IsAggregateValue () const
 
virtual ConstString GetName () const
 
virtual bool DumpQualifiedName (Stream &strm) const
 
uint32_t GetTypeAsMask ()
 
uint64_t GetUInt64Value (uint64_t fail_value, bool *success_ptr)
 
OptionValueArch * GetAsArch ()
 
const OptionValueArch * GetAsArch () const
 
OptionValueArray * GetAsArray ()
 
const OptionValueArray * GetAsArray () const
 
OptionValueArgs * GetAsArgs ()
 
const OptionValueArgs * GetAsArgs () const
 
OptionValueBoolean * GetAsBoolean ()
 
OptionValueChar * GetAsChar ()
 
const OptionValueBoolean * GetAsBoolean () const
 
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 GetBooleanValue (bool fail_value=false) const
 
bool SetBooleanValue (bool new_value)
 
char GetCharValue (char fail_value) const
 
char SetCharValue (char new_value)
 
int64_t GetEnumerationValue (int64_t fail_value=-1) const
 
bool SetEnumerationValue (int64_t value)
 
FileSpec GetFileSpecValue () const
 
bool SetFileSpecValue (const FileSpec &file_spec)
 
FileSpecList GetFileSpecListValue () const
 
lldb::Format GetFormatValue (lldb::Format fail_value=lldb::eFormatDefault) const
 
bool SetFormatValue (lldb::Format new_value)
 
lldb::LanguageType GetLanguageValue (lldb::LanguageType fail_value=lldb::eLanguageTypeUnknown) const
 
bool SetLanguageValue (lldb::LanguageType new_language)
 
const FormatEntity::Entry * GetFormatEntity () const
 
const RegularExpression * GetRegexValue () const
 
int64_t GetSInt64Value (int64_t fail_value=0) const
 
bool SetSInt64Value (int64_t new_value)
 
llvm::StringRef GetStringValue (llvm::StringRef fail_value) const
 
llvm::StringRef GetStringValue () const
 
bool SetStringValue (llvm::StringRef new_value)
 
uint64_t GetUInt64Value (uint64_t fail_value=0) const
 
bool SetUInt64Value (uint64_t new_value)
 
UUID GetUUIDValue () const
 
bool SetUUIDValue (const UUID &uuid)
 
bool OptionWasSet () const
 
void SetOptionWasSet ()
 
void SetParent (const lldb::OptionValueSP &parent_sp)
 
void SetValueChangedCallback (OptionValueChangedCallback callback, void *baton)
 
void NotifyValueChanged ()
 

Protected Attributes

std::string m_current_value
 
std::string m_default_value
 
Flags m_options
 
ValidatorCallback m_validator
 
void * m_validator_baton
 
- Protected Attributes inherited from lldb_private::OptionValue
lldb::OptionValueWP m_parent_wp
 
OptionValueChangedCallback m_callback
 
void * m_baton
 
bool m_value_was_set
 

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)
 

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 ( )
inline

Definition at line 26 of file OptionValueString.h.

◆ OptionValueString() [2/6]

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

Definition at line 30 of file OptionValueString.h.

◆ OptionValueString() [3/6]

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

Definition at line 34 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 43 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 52 of file OptionValueString.h.

References m_current_value, and m_default_value.

◆ OptionValueString() [6/6]

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

Definition at line 62 of file OptionValueString.h.

References m_current_value, m_default_value, and ~OptionValueString().

◆ ~OptionValueString()

lldb_private::OptionValueString::~OptionValueString ( )
overridedefault

Referenced by OptionValueString().

Member Function Documentation

◆ AppendToCurrentValue()

Status OptionValueString::AppendToCurrentValue ( const char *  value)

Definition at line 135 of file OptionValueString.cpp.

References lldb_private::Status::Fail().

Referenced by GetDefaultValueAsRef().

◆ Clear()

bool lldb_private::OptionValueString::Clear ( )
inlineoverridevirtual

Implements lldb_private::OptionValue.

Definition at line 88 of file OptionValueString.h.

References DeepCopy(), m_current_value, m_default_value, and lldb_private::OptionValue::m_value_was_set.

Referenced by lldb_private::OptionGroupVariable::OptionParsingStarting(), and lldb_private::OptionGroupString::OptionParsingStarting().

◆ DeepCopy()

lldb::OptionValueSP OptionValueString::DeepCopy ( ) const
overridevirtual

Implements lldb_private::OptionValue.

Definition at line 121 of file OptionValueString.cpp.

Referenced by Clear().

◆ DumpValue()

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

Implements lldb_private::OptionValue.

Definition at line 19 of file OptionValueString.cpp.

References lldb_private::Stream::Printf(), and lldb_private::Stream::PutCString().

Referenced by GetType().

◆ GetCurrentValue()

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

Definition at line 107 of file OptionValueString.h.

References m_current_value.

Referenced by CommandObjectProcessKDPPacketSend::DoExecute(), CommandObjectCommandsAlias::HandleAliasingNormalCommand(), and CommandObjectCommandsAlias::HandleAliasingRawCommand().

◆ GetCurrentValueAsRef()

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

Definition at line 108 of file OptionValueString.h.

References m_current_value.

Referenced by lldb_private::OptionValue::GetStringValue().

◆ GetDefaultValue()

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

Definition at line 110 of file OptionValueString.h.

References m_default_value.

◆ GetDefaultValueAsRef()

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

Definition at line 111 of file OptionValueString.h.

References AppendToCurrentValue(), m_default_value, and SetCurrentValue().

◆ GetOptions() [1/2]

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

Definition at line 98 of file OptionValueString.h.

References m_options.

Referenced by lldb_private::Property::Property().

◆ GetOptions() [2/2]

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

Definition at line 100 of file OptionValueString.h.

References m_options.

◆ GetType()

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

Implements lldb_private::OptionValue.

Definition at line 76 of file OptionValueString.h.

References DumpValue(), lldb_private::OptionValue::eTypeString, lldb_private::eVarSetOperationAssign, and SetValueFromString().

◆ IsCurrentValueEmpty()

bool lldb_private::OptionValueString::IsCurrentValueEmpty ( ) const
inline

Definition at line 125 of file OptionValueString.h.

References m_current_value.

◆ IsDefaultValueEmpty()

bool lldb_private::OptionValueString::IsDefaultValueEmpty ( ) const
inline

Definition at line 127 of file OptionValueString.h.

References m_default_value.

◆ operator=()

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

Definition at line 102 of file OptionValueString.h.

References m_current_value, and SetCurrentValue().

◆ SetCurrentValue() [1/2]

Status lldb_private::OptionValueString::SetCurrentValue ( const char *  )
delete

Referenced by GetDefaultValueAsRef(), operator=(), lldb_private::OptionGroupVariable::SetOptionValue(), and lldb_private::OptionValue::SetStringValue().

◆ SetCurrentValue() [2/2]

Status OptionValueString::SetCurrentValue ( llvm::StringRef  value)

Definition at line 125 of file OptionValueString.cpp.

References lldb_private::Status::Fail().

◆ SetDefaultValue()

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

Definition at line 118 of file OptionValueString.h.

References m_default_value.

◆ SetValueFromString() [1/2]

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

Reimplemented from lldb_private::OptionValue.

Definition at line 45 of file OptionValueString.cpp.

References 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::Fail(), and lldb_private::Status::SetErrorString().

Referenced by GetType(), and lldb_private::OptionGroupString::SetOptionValue().

◆ SetValueFromString() [2/2]

Status lldb_private::OptionValueString::SetValueFromString ( const char *  ,
VarSetOperationType  = eVarSetOperationAssign 
)
delete

Member Data Documentation

◆ m_current_value

std::string lldb_private::OptionValueString::m_current_value
protected

Definition at line 130 of file OptionValueString.h.

Referenced by Clear(), GetCurrentValue(), GetCurrentValueAsRef(), IsCurrentValueEmpty(), operator=(), and OptionValueString().

◆ m_default_value

std::string lldb_private::OptionValueString::m_default_value
protected

Definition at line 131 of file OptionValueString.h.

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

◆ m_options

Flags lldb_private::OptionValueString::m_options
protected

Definition at line 132 of file OptionValueString.h.

Referenced by GetOptions().

◆ m_validator

ValidatorCallback lldb_private::OptionValueString::m_validator
protected

Definition at line 133 of file OptionValueString.h.

◆ m_validator_baton

void* lldb_private::OptionValueString::m_validator_baton
protected

Definition at line 134 of file OptionValueString.h.

The documentation for this class was generated from the following files:
Generated on Mon Nov 4 2019 00:57:14 for LLDB by   doxygen 1.8.13