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

#include <OptionValueFormat.h>

Inheritance diagram for lldb_private::OptionValueFormat:
Inheritance graph
[legend]

Public Member Functions

 OptionValueFormat (lldb::Format value)
 
 OptionValueFormat (lldb::Format current_value, lldb::Format default_value)
 
 ~OptionValueFormat () 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) override
 
Status SetValueFromString (llvm::StringRef value, VarSetOperationType op=eVarSetOperationAssign) override
 
void Clear () override
 
lldb::Format GetCurrentValue () const
 
lldb::Format GetDefaultValue () const
 
void SetCurrentValue (lldb::Format value)
 
void SetDefaultValue (lldb::Format value)
 
- Public Member Functions inherited from lldb_private::Cloneable< OptionValueFormat, OptionValue >
std::shared_ptr< typename Base::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 Type GetType () const =0
 
virtual bool ValueIsTransparent () const
 
virtual const char * GetTypeAsCString () const
 
virtual void DumpValue (const ExecutionContext *exe_ctx, Stream &strm, uint32_t dump_mask)=0
 
virtual llvm::json::Value ToJSON (const ExecutionContext *exe_ctx)
 
virtual Status SetValueFromString (llvm::StringRef value, VarSetOperationType op=eVarSetOperationAssign)
 
virtual void Clear ()=0
 
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)
 
template<typename T , std::enable_if_t< std::is_enum_v< T >, bool > = true>
bool SetValueAs (T t)
 

Protected Attributes

lldb::Format m_current_value
 
lldb::Format m_default_value
 
- 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

- 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)
}
 
- 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
 
virtual lldb::OptionValueSP Clone () const =0
 

Detailed Description

Definition at line 16 of file OptionValueFormat.h.

Constructor & Destructor Documentation

◆ OptionValueFormat() [1/2]

lldb_private::OptionValueFormat::OptionValueFormat ( lldb::Format  value)
inline

Definition at line 19 of file OptionValueFormat.h.

◆ OptionValueFormat() [2/2]

lldb_private::OptionValueFormat::OptionValueFormat ( lldb::Format  current_value,
lldb::Format  default_value 
)
inline

Definition at line 22 of file OptionValueFormat.h.

◆ ~OptionValueFormat()

lldb_private::OptionValueFormat::~OptionValueFormat ( )
overridedefault

Member Function Documentation

◆ Clear()

void lldb_private::OptionValueFormat::Clear ( )
inlineoverridevirtual

Implements lldb_private::OptionValue.

Definition at line 40 of file OptionValueFormat.h.

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

Referenced by lldb_private::OptionGroupFormat::OptionParsingStarting(), and SetValueFromString().

◆ DumpValue()

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

Implements lldb_private::OptionValue.

Definition at line 18 of file OptionValueFormat.cpp.

References lldb_private::OptionValue::eDumpOptionType, lldb_private::OptionValue::eDumpOptionValue, lldb_private::FormatManager::GetFormatAsCString(), lldb_private::OptionValue::GetTypeAsCString(), m_current_value, lldb_private::Stream::Printf(), and lldb_private::Stream::PutCString().

◆ GetCurrentValue()

lldb::Format lldb_private::OptionValueFormat::GetCurrentValue ( ) const
inline

Definition at line 47 of file OptionValueFormat.h.

References m_current_value.

Referenced by CommandObjectMemoryRead::DoExecute(), and lldb_private::OptionGroupFormat::GetFormat().

◆ GetDefaultValue()

lldb::Format lldb_private::OptionValueFormat::GetDefaultValue ( ) const
inline

Definition at line 49 of file OptionValueFormat.h.

References m_default_value.

◆ GetType()

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

Implements lldb_private::OptionValue.

Definition at line 29 of file OptionValueFormat.h.

References lldb_private::OptionValue::eTypeFormat.

◆ SetCurrentValue()

void lldb_private::OptionValueFormat::SetCurrentValue ( lldb::Format  value)
inline

Definition at line 51 of file OptionValueFormat.h.

References m_current_value.

Referenced by CommandObjectMemoryRead::DoExecute(), and lldb_private::OptionGroupFormat::SetOptionValue().

◆ SetDefaultValue()

void lldb_private::OptionValueFormat::SetDefaultValue ( lldb::Format  value)
inline

Definition at line 53 of file OptionValueFormat.h.

References m_default_value.

◆ SetValueFromString()

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

Reimplemented from lldb_private::OptionValue.

Definition at line 33 of file OptionValueFormat.cpp.

References Clear(), 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, m_current_value, lldb_private::OptionValue::m_value_was_set, lldb_private::OptionValue::NotifyValueChanged(), lldb_private::OptionValue::SetValueFromString(), and lldb_private::OptionArgParser::ToFormat().

Referenced by lldb_private::OptionGroupFormat::SetOptionValue().

◆ ToJSON()

llvm::json::Value OptionValueFormat::ToJSON ( const ExecutionContext *  exe_ctx)
overridevirtual

Reimplemented from lldb_private::OptionValue.

Definition at line 29 of file OptionValueFormat.cpp.

References lldb_private::FormatManager::GetFormatAsCString(), and m_current_value.

Member Data Documentation

◆ m_current_value

lldb::Format lldb_private::OptionValueFormat::m_current_value
protected

Definition at line 56 of file OptionValueFormat.h.

Referenced by Clear(), DumpValue(), GetCurrentValue(), SetCurrentValue(), SetValueFromString(), and ToJSON().

◆ m_default_value

lldb::Format lldb_private::OptionValueFormat::m_default_value
protected

Definition at line 57 of file OptionValueFormat.h.

Referenced by Clear(), GetDefaultValue(), and SetDefaultValue().

The documentation for this class was generated from the following files:
Generated on Fri Dec 20 2024 17:28:57 for LLDB by doxygen 1.9.6