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

#include <UserSettingsController.h>

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

Public Member Functions

 Properties ()
 
 Properties (const lldb::OptionValuePropertiesSP &collection_sp)
 
virtual ~Properties ()
 
virtual lldb::OptionValuePropertiesSP GetValueProperties () const
 
virtual lldb::OptionValueSP GetPropertyValue (const ExecutionContext *exe_ctx, llvm::StringRef property_path, Status &error) const
 
virtual Status SetPropertyValue (const ExecutionContext *exe_ctx, VarSetOperationType op, llvm::StringRef property_path, llvm::StringRef value)
 
virtual Status DumpPropertyValue (const ExecutionContext *exe_ctx, Stream &strm, llvm::StringRef property_path, uint32_t dump_mask, bool is_json=false)
 
virtual void DumpAllPropertyValues (const ExecutionContext *exe_ctx, Stream &strm, uint32_t dump_mask, bool is_json=false)
 
virtual void DumpAllDescriptions (CommandInterpreter &interpreter, Stream &strm) const
 
size_t Apropos (llvm::StringRef keyword, std::vector< const Property * > &matching_properties) const
 
template<typename T >
T GetPropertyAtIndexAs (uint32_t idx, T default_value, const ExecutionContext *exe_ctx=nullptr) const
 
template<typename T , typename U = typename std::remove_pointer<T>::type, std::enable_if_t< std::is_pointer_v< T >, bool > = true>
const U * GetPropertyAtIndexAs (uint32_t idx, const ExecutionContext *exe_ctx=nullptr) const
 
template<typename T >
bool SetPropertyAtIndex (uint32_t idx, T t, const ExecutionContext *exe_ctx=nullptr) const
 

Static Public Member Functions

static llvm::StringRef GetExperimentalSettingsName ()
 
static bool IsSettingExperimental (llvm::StringRef setting)
 

Protected Attributes

lldb::OptionValuePropertiesSP m_collection_sp
 

Detailed Description

Definition at line 33 of file UserSettingsController.h.

Constructor & Destructor Documentation

◆ Properties() [1/2]

Properties::Properties ( )
default

◆ Properties() [2/2]

Properties::Properties ( const lldb::OptionValuePropertiesSP &  collection_sp)

Definition at line 35 of file UserSettingsController.cpp.

◆ ~Properties()

Properties::~Properties ( )
virtualdefault

Member Function Documentation

◆ Apropos()

size_t Properties::Apropos ( llvm::StringRef  keyword,
std::vector< const Property * > &  matching_properties 
) const

Definition at line 99 of file UserSettingsController.cpp.

References GetValueProperties().

Referenced by lldb_private::CommandObjectApropos::DoExecute().

◆ DumpAllDescriptions()

void Properties::DumpAllDescriptions ( CommandInterpreter &  interpreter,
Stream &  strm 
) const
virtual

Definition at line 75 of file UserSettingsController.cpp.

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

Referenced by CommandObjectSettingsList::DoExecute().

◆ DumpAllPropertyValues()

void Properties::DumpAllPropertyValues ( const ExecutionContext *  exe_ctx,
Stream &  strm,
uint32_t  dump_mask,
bool  is_json = false 
)
virtual

Definition at line 61 of file UserSettingsController.cpp.

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

Referenced by CommandObjectSettingsShow::DoExecute(), and CommandObjectSettingsWrite::DoExecute().

◆ DumpPropertyValue()

Status Properties::DumpPropertyValue ( const ExecutionContext *  exe_ctx,
Stream &  strm,
llvm::StringRef  property_path,
uint32_t  dump_mask,
bool  is_json = false 
)
virtual

Definition at line 84 of file UserSettingsController.cpp.

References error(), and GetValueProperties().

◆ GetExperimentalSettingsName()

llvm::StringRef Properties::GetExperimentalSettingsName ( )
static

Definition at line 108 of file UserSettingsController.cpp.

Referenced by lldb_private::OptionValueProperties::GetSubValue(), IsSettingExperimental(), lldb_private::ProcessProperties::ProcessProperties(), and lldb_private::TargetProperties::TargetProperties().

◆ GetPropertyAtIndexAs() [1/2]

template<typename T , typename U = typename std::remove_pointer<T>::type, std::enable_if_t< std::is_pointer_v< T >, bool > = true>
const U * lldb_private::Properties::GetPropertyAtIndexAs ( uint32_t  idx,
const ExecutionContext *  exe_ctx = nullptr 
) const
inline

Definition at line 91 of file UserSettingsController.h.

References m_collection_sp.

◆ GetPropertyAtIndexAs() [2/2]

template<typename T >
T lldb_private::Properties::GetPropertyAtIndexAs ( uint32_t  idx,
T  default_value,
const ExecutionContext *  exe_ctx = nullptr 
) const
inline

Definition at line 82 of file UserSettingsController.h.

References m_collection_sp.

Referenced by lldb_private::platform_android::PlatformAndroid::GetPropertyPackageName().

◆ GetPropertyValue()

lldb::OptionValueSP Properties::GetPropertyValue ( const ExecutionContext *  exe_ctx,
llvm::StringRef  property_path,
Status &  error 
) const
virtual

Definition at line 41 of file UserSettingsController.cpp.

References error(), and GetValueProperties().

Referenced by sddarwinlog_private::ParseAutoEnableOptions().

◆ GetValueProperties()

virtual lldb::OptionValuePropertiesSP lldb_private::Properties::GetValueProperties ( ) const
inlinevirtual

Definition at line 41 of file UserSettingsController.h.

References m_collection_sp.

Referenced by Apropos(), lldb_private::OptionValueProperties::CreateLocalCopy(), lldb_private::Debugger::Debugger(), lldb_private::process_gdb_remote::ProcessGDBRemote::DebuggerInitialize(), ProcessKDP::DebuggerInitialize(), CommandObjectSettingsList::DoExecute(), CommandObjectSettingsClear::DoExecute(), DumpAllDescriptions(), DumpAllPropertyValues(), DumpPropertyValue(), GetDebuggerPropertyForPlugins(), GetDebuggerPropertyForPluginsOldStyle(), ProcessOptionValueProperties::GetPropertyAtIndex(), ThreadOptionValueProperties::GetPropertyAtIndex(), TargetOptionValueProperties::GetPropertyAtIndex(), GetPropertyValue(), lldb_private::ProcessProperties::ProcessProperties(), SetPropertyValue(), lldb_private::CommandCompletions::SettingsNames(), and lldb_private::TargetProperties::TargetProperties().

◆ IsSettingExperimental()

bool Properties::IsSettingExperimental ( llvm::StringRef  setting)
static

Definition at line 113 of file UserSettingsController.cpp.

References GetExperimentalSettingsName().

Referenced by lldb_private::OptionValueProperties::GetSubValue(), and lldb_private::OptionValueProperties::SetSubValue().

◆ SetPropertyAtIndex()

template<typename T >
bool lldb_private::Properties::SetPropertyAtIndex ( uint32_t  idx,
T  t,
const ExecutionContext *  exe_ctx = nullptr 
) const
inline

Definition at line 97 of file UserSettingsController.h.

References m_collection_sp.

Referenced by lldb_private::TargetProperties::SetArg0(), lldb_private::Debugger::SetAutoIndent(), lldb_private::ModuleListProperties::SetClangModulesCachePath(), lldb_private::TargetProperties::SetDebugUtilityExpression(), lldb_private::TargetProperties::SetDefaultArchitecture(), lldb_private::ProcessProperties::SetDetachKeepsStopped(), lldb_private::TargetProperties::SetDetachOnError(), lldb_private::TargetProperties::SetDisableASLR(), lldb_private::ProcessProperties::SetDisableLangRuntimeUnwindPlans(), lldb_private::TargetProperties::SetDisableSTDIO(), lldb_private::TargetProperties::SetDisplayRecognizedArguments(), lldb_private::TargetProperties::SetDisplayRuntimeSupportValues(), lldb_private::CommandInterpreter::SetEchoCommands(), lldb_private::CommandInterpreter::SetEchoCommentCommands(), lldb_private::ModuleListProperties::SetEnableExternalLookup(), lldb_private::ModuleListProperties::SetEnableLLDBIndexCache(), lldb_private::Debugger::SetExternalEditor(), lldb_private::ProcessProperties::SetHighmemVirtualAddressableBits(), lldb_private::ProcessProperties::SetIgnoreBreakpointsInExpressions(), lldb_private::TargetProperties::SetInheritTCC(), lldb_private::ModuleListProperties::SetLLDBIndexCachePath(), lldb_private::CommandInterpreter::SetOpenTranscriptInEditor(), lldb_private::TargetProperties::SetPreferDynamicValue(), lldb_private::TargetProperties::SetPreloadSymbols(), lldb_private::Debugger::SetPrintDecls(), lldb_private::Debugger::SetPrompt(), lldb_private::CommandInterpreter::SetPromptOnQuit(), lldb_private::ProcessProperties::SetPythonOSPluginPath(), lldb_private::Debugger::SetREPLLanguage(), lldb_private::CommandInterpreter::SetSaveSessionDirectory(), lldb_private::CommandInterpreter::SetSaveSessionOnQuit(), lldb_private::Debugger::SetScriptLanguage(), lldb_private::Debugger::SetShowProgress(), lldb_private::TargetProperties::SetStandardErrorPath(), lldb_private::TargetProperties::SetStandardInputPath(), lldb_private::TargetProperties::SetStandardOutputPath(), lldb_private::ProcessProperties::SetStopOnSharedLibraryEvents(), lldb_private::Debugger::SetTabSize(), lldb_private::Debugger::SetTerminalWidth(), lldb_private::ProcessProperties::SetUnwindOnErrorInExpressions(), lldb_private::Debugger::SetUseColor(), lldb_private::Debugger::SetUseExternalEditor(), lldb_private::PlatformProperties::SetUseModuleCache(), lldb_private::Debugger::SetUseSourceCache(), and lldb_private::ProcessProperties::SetVirtualAddressableBits().

◆ SetPropertyValue()

Status Properties::SetPropertyValue ( const ExecutionContext *  exe_ctx,
VarSetOperationType  op,
llvm::StringRef  property_path,
llvm::StringRef  value 
)
virtual

Reimplemented in lldb_private::Debugger.

Definition at line 49 of file UserSettingsController.cpp.

References error(), and GetValueProperties().

Referenced by lldb_private::Debugger::SetPropertyValue().

Member Data Documentation

◆ m_collection_sp

lldb::OptionValuePropertiesSP lldb_private::Properties::m_collection_sp
protected

Definition at line 103 of file UserSettingsController.h.

Referenced by lldb_private::TargetProperties::AppendExecutableSearchPaths(), lldb_private::TargetProperties::CheckJITObjectsDir(), lldb_private::CommandInterpreter::CommandInterpreter(), lldb_private::TargetProperties::ComputeEnvironment(), lldb_private::Debugger::Debugger(), DynamicLoaderDarwinKernelProperties::DynamicLoaderDarwinKernelProperties(), lldb_private::TargetProperties::GetExpressionPrefixContents(), lldb_private::ProcessProperties::GetExtraStartupCommands(), lldb_private::TargetProperties::GetInheritedEnvironment(), lldb_private::TargetProperties::GetInjectLocalVariables(), lldb_private::TargetProperties::GetMaximumDepthOfChildrenToDisplay(), lldb_private::ProcessProperties::GetOSPluginReportsAllThreads(), GetPropertyAtIndexAs(), lldb_private::TargetProperties::GetRunArguments(), lldb_private::TargetProperties::GetSourcePathMap(), lldb_private::TargetProperties::GetTargetEnvironment(), lldb_private::TargetProperties::GetUserSpecifiedTrapHandlerNames(), GetValueProperties(), lldb_private::ModuleListProperties::ModuleListProperties(), lldb_private::PlatformProperties::PlatformProperties(), lldb_private::trace_intel_pt::TraceIntelPT::PluginProperties::PluginProperties(), lldb_private::Process::Process(), lldb_private::ProcessExperimentalProperties::ProcessExperimentalProperties(), lldb_private::ProcessProperties::ProcessProperties(), lldb_private::PlatformProperties::SetDefaultModuleCacheDirectory(), lldb_private::TargetProperties::SetEnvironment(), lldb_private::ProcessProperties::SetExtraStartupCommands(), lldb_private::TargetProperties::SetInjectLocalVariables(), lldb_private::PlatformProperties::SetModuleCacheDirectory(), lldb_private::ProcessProperties::SetOSPluginReportsAllThreads(), SetPropertyAtIndex(), lldb_private::TargetProperties::SetRequireHardwareBreakpoints(), lldb_private::TargetProperties::SetRunArguments(), lldb_private::TargetProperties::SetUserSpecifiedTrapHandlerNames(), sddarwinlog_private::StructuredDataDarwinLogProperties::StructuredDataDarwinLogProperties(), lldb_private::TargetExperimentalProperties::TargetExperimentalProperties(), lldb_private::TargetProperties::TargetProperties(), and lldb_private::ThreadProperties::ThreadProperties().

The documentation for this class was generated from the following files:
Generated on Tue Sep 26 2023 13:32:46 for LLDB by doxygen 1.9.6