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,
  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), 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
 
Status SetValueFromString (llvm::StringRef value, VarSetOperationType op=eVarSetOperationAssign) override
 
void Clear () override
 
FlagsGetOptions ()
 
const FlagsGetOptions () 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
 
- Public Member Functions inherited from lldb_private::Cloneable< OptionValueString, OptionValue >
std::shared_ptr< typename OptionValue ::TopmostBaseClone () const override
 
- Public Member Functions inherited from lldb_private::OptionValue
 OptionValue ()=default
 
virtual ~OptionValue ()=default
 
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, 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)
 
OptionValueArchGetAsArch ()
 
const OptionValueArchGetAsArch () const
 
OptionValueArrayGetAsArray ()
 
const OptionValueArrayGetAsArray () const
 
OptionValueArgsGetAsArgs ()
 
const OptionValueArgsGetAsArgs () const
 
OptionValueBooleanGetAsBoolean ()
 
OptionValueCharGetAsChar ()
 
const OptionValueBooleanGetAsBoolean () const
 
const OptionValueCharGetAsChar () const
 
OptionValueDictionaryGetAsDictionary ()
 
const OptionValueDictionaryGetAsDictionary () const
 
OptionValueEnumerationGetAsEnumeration ()
 
const OptionValueEnumerationGetAsEnumeration () const
 
OptionValueFileSpecGetAsFileSpec ()
 
const OptionValueFileSpecGetAsFileSpec () const
 
OptionValueFileSpecListGetAsFileSpecList ()
 
const OptionValueFileSpecListGetAsFileSpecList () const
 
OptionValueFormatGetAsFormat ()
 
const OptionValueFormatGetAsFormat () const
 
OptionValueLanguageGetAsLanguage ()
 
const OptionValueLanguageGetAsLanguage () const
 
OptionValuePathMappingsGetAsPathMappings ()
 
const OptionValuePathMappingsGetAsPathMappings () const
 
OptionValuePropertiesGetAsProperties ()
 
const OptionValuePropertiesGetAsProperties () const
 
OptionValueRegexGetAsRegex ()
 
const OptionValueRegexGetAsRegex () const
 
OptionValueSInt64GetAsSInt64 ()
 
const OptionValueSInt64GetAsSInt64 () const
 
OptionValueStringGetAsString ()
 
const OptionValueStringGetAsString () const
 
OptionValueUInt64GetAsUInt64 ()
 
const OptionValueUInt64GetAsUInt64 () const
 
OptionValueUUIDGetAsUUID ()
 
const OptionValueUUIDGetAsUUID () const
 
OptionValueFormatEntityGetAsFormatEntity ()
 
const OptionValueFormatEntityGetAsFormatEntity () 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::EntryGetFormatEntity () const
 
const RegularExpressionGetRegexValue () 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)
 
lldb::OptionValueSP GetParent () const
 
void SetValueChangedCallback (std::function< void()> callback)
 
void NotifyValueChanged ()
 

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
 
- Protected Member Functions inherited from lldb_private::OptionValue
virtual lldb::OptionValueSP Clone () const =0
 

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

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.

◆ 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, 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 54 of file OptionValueString.h.

References m_current_value, and m_default_value.

◆ ~OptionValueString()

lldb_private::OptionValueString::~OptionValueString ( )
overridedefault

Member Function Documentation

◆ AppendToCurrentValue()

Status OptionValueString::AppendToCurrentValue ( const char *  value)

Definition at line 130 of file OptionValueString.cpp.

References error(), and string().

◆ Clear()

void lldb_private::OptionValueString::Clear ( )
inlineoverridevirtual

◆ DumpValue()

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

◆ GetCurrentValue()

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

Definition at line 92 of file OptionValueString.h.

References m_current_value.

Referenced by CommandObjectProcessKDPPacketSend::DoExecute().

◆ GetCurrentValueAsRef()

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

Definition at line 93 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 95 of file OptionValueString.h.

References m_default_value.

◆ GetDefaultValueAsRef()

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

Definition at line 96 of file OptionValueString.h.

References m_default_value.

◆ GetOptions() [1/2]

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

Definition at line 83 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 85 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 109 of file OptionValueString.h.

References m_current_value.

◆ IsDefaultValueEmpty()

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

Definition at line 111 of file OptionValueString.h.

References m_default_value.

◆ operator=()

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

Definition at line 87 of file OptionValueString.h.

References m_current_value, and SetCurrentValue().

◆ SetCurrentValue()

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

◆ SetDefaultValue()

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

Definition at line 102 of file OptionValueString.h.

References m_default_value.

◆ SetValueFromString()

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

Member Data Documentation

◆ m_current_value

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

◆ m_default_value

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

◆ m_options

Flags lldb_private::OptionValueString::m_options
protected

Definition at line 116 of file OptionValueString.h.

Referenced by GetOptions().

◆ m_validator

ValidatorCallback lldb_private::OptionValueString::m_validator = nullptr
protected

Definition at line 117 of file OptionValueString.h.

◆ m_validator_baton

void* lldb_private::OptionValueString::m_validator_baton = nullptr
protected

Definition at line 118 of file OptionValueString.h.


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