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

#include <OptionValueFormatEntity.h>

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

Public Member Functions

 OptionValueFormatEntity (const char *default_format)
 
 ~OptionValueFormatEntity () 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
 
void AutoComplete (CommandInterpreter &interpreter, CompletionRequest &request) override
 
FormatEntity::Entry & GetCurrentValue ()
 
const FormatEntity::Entry & GetCurrentValue () const
 
void SetCurrentValue (const FormatEntity::Entry &value)
 
FormatEntity::Entry & GetDefaultValue ()
 
const FormatEntity::Entry & GetDefaultValue () const
 
- Public Member Functions inherited from lldb_private::Cloneable< OptionValueFormatEntity, 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

std::string m_current_format
 
std::string m_default_format
 
FormatEntity::Entry m_current_entry
 
FormatEntity::Entry m_default_entry
 
- 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 17 of file OptionValueFormatEntity.h.

Constructor & Destructor Documentation

◆ OptionValueFormatEntity()

OptionValueFormatEntity::OptionValueFormatEntity ( const char *  default_format)

Definition at line 18 of file OptionValueFormatEntity.cpp.

References error(), m_current_entry, m_current_format, m_default_entry, m_default_format, and lldb_private::FormatEntity::Parse().

◆ ~OptionValueFormatEntity()

lldb_private::OptionValueFormatEntity::~OptionValueFormatEntity ( )
overridedefault

Member Function Documentation

◆ AutoComplete()

void OptionValueFormatEntity::AutoComplete ( CommandInterpreter &  interpreter,
CompletionRequest &  request 
)
overridevirtual

Reimplemented from lldb_private::OptionValue.

Definition at line 119 of file OptionValueFormatEntity.cpp.

References lldb_private::FormatEntity::AutoComplete().

◆ Clear()

void OptionValueFormatEntity::Clear ( )
overridevirtual

Implements lldb_private::OptionValue.

Definition at line 30 of file OptionValueFormatEntity.cpp.

References m_current_entry, m_current_format, m_default_entry, m_default_format, and lldb_private::OptionValue::m_value_was_set.

Referenced by SetValueFromString().

◆ DumpValue()

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

Implements lldb_private::OptionValue.

Definition at line 50 of file OptionValueFormatEntity.cpp.

References lldb_private::OptionValue::eDumpOptionType, lldb_private::OptionValue::eDumpOptionValue, EscapeBackticks(), lldb_private::OptionValue::GetTypeAsCString(), m_current_format, lldb_private::Stream::Printf(), and lldb_private::Stream::PutCString().

◆ GetCurrentValue() [1/2]

FormatEntity::Entry & lldb_private::OptionValueFormatEntity::GetCurrentValue ( )
inline

Definition at line 44 of file OptionValueFormatEntity.h.

References m_current_entry.

◆ GetCurrentValue() [2/2]

const FormatEntity::Entry & lldb_private::OptionValueFormatEntity::GetCurrentValue ( ) const
inline

Definition at line 46 of file OptionValueFormatEntity.h.

References m_current_entry.

◆ GetDefaultValue() [1/2]

FormatEntity::Entry & lldb_private::OptionValueFormatEntity::GetDefaultValue ( )
inline

Definition at line 52 of file OptionValueFormatEntity.h.

References m_default_entry.

◆ GetDefaultValue() [2/2]

const FormatEntity::Entry & lldb_private::OptionValueFormatEntity::GetDefaultValue ( ) const
inline

Definition at line 54 of file OptionValueFormatEntity.h.

References m_default_entry.

◆ GetType()

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

Implements lldb_private::OptionValue.

Definition at line 26 of file OptionValueFormatEntity.h.

References lldb_private::OptionValue::eTypeFormatEntity.

◆ SetCurrentValue()

void lldb_private::OptionValueFormatEntity::SetCurrentValue ( const FormatEntity::Entry &  value)
inline

Definition at line 48 of file OptionValueFormatEntity.h.

References m_current_entry.

◆ SetValueFromString()

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

Reimplemented from lldb_private::OptionValue.

Definition at line 70 of file OptionValueFormatEntity.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_entry, m_current_format, lldb_private::OptionValue::m_value_was_set, lldb_private::OptionValue::NotifyValueChanged(), lldb_private::FormatEntity::Parse(), and lldb_private::OptionValue::SetValueFromString().

◆ ToJSON()

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

Reimplemented from lldb_private::OptionValue.

Definition at line 64 of file OptionValueFormatEntity.cpp.

References EscapeBackticks(), and m_current_format.

Member Data Documentation

◆ m_current_entry

FormatEntity::Entry lldb_private::OptionValueFormatEntity::m_current_entry
protected

Definition at line 59 of file OptionValueFormatEntity.h.

Referenced by Clear(), GetCurrentValue(), OptionValueFormatEntity(), SetCurrentValue(), and SetValueFromString().

◆ m_current_format

std::string lldb_private::OptionValueFormatEntity::m_current_format
protected

Definition at line 57 of file OptionValueFormatEntity.h.

Referenced by Clear(), DumpValue(), OptionValueFormatEntity(), SetValueFromString(), and ToJSON().

◆ m_default_entry

FormatEntity::Entry lldb_private::OptionValueFormatEntity::m_default_entry
protected

Definition at line 60 of file OptionValueFormatEntity.h.

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

◆ m_default_format

std::string lldb_private::OptionValueFormatEntity::m_default_format
protected

Definition at line 58 of file OptionValueFormatEntity.h.

Referenced by Clear(), and OptionValueFormatEntity().

The documentation for this class was generated from the following files:
Generated on Thu Dec 7 2023 01:30:21 for LLDB by doxygen 1.9.6