LLDB  mainline
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | List of all members
lldb_private::CommandObject Class Referenceabstract

#include <CommandObject.h>

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

Classes

struct  ArgumentHelpCallback
 
struct  ArgumentTableEntry
 Entries in the main argument information table. More...
 
struct  CommandArgumentData
 Used to build individual command argument lists. More...
 

Public Types

typedef llvm::StringRef() ArgumentHelpCallbackFunction()
 
typedef std::vector< CommandArgumentDataCommandArgumentEntry
 
typedef std::map< std::string, lldb::CommandObjectSP > CommandMap
 

Public Member Functions

 CommandObject (CommandInterpreter &interpreter, llvm::StringRef name, llvm::StringRef help="", llvm::StringRef syntax="", uint32_t flags=0)
 
virtual ~CommandObject ()=default
 
CommandInterpreterGetCommandInterpreter ()
 
DebuggerGetDebugger ()
 
virtual llvm::StringRef GetHelp ()
 
virtual llvm::StringRef GetHelpLong ()
 
virtual llvm::StringRef GetSyntax ()
 
llvm::StringRef GetCommandName () const
 
virtual void SetHelp (llvm::StringRef str)
 
virtual void SetHelpLong (llvm::StringRef str)
 
void SetSyntax (llvm::StringRef str)
 
virtual bool IsRemovable () const
 
virtual bool IsMultiwordObject ()
 
bool IsUserCommand ()
 
void SetIsUserCommand (bool is_user)
 
virtual CommandObjectMultiwordGetAsMultiwordCommand ()
 
virtual bool IsAlias ()
 
virtual bool IsDashDashCommand ()
 
virtual lldb::CommandObjectSP GetSubcommandSP (llvm::StringRef sub_cmd, StringList *matches=nullptr)
 
virtual lldb::CommandObjectSP GetSubcommandSPExact (llvm::StringRef sub_cmd)
 
virtual CommandObjectGetSubcommandObject (llvm::StringRef sub_cmd, StringList *matches=nullptr)
 
void FormatLongHelpText (Stream &output_strm, llvm::StringRef long_help)
 
void GenerateHelpText (CommandReturnObject &result)
 
virtual void GenerateHelpText (Stream &result)
 
virtual bool LoadSubCommand (llvm::StringRef cmd_name, const lldb::CommandObjectSP &command_obj)
 
virtual llvm::Error LoadUserSubcommand (llvm::StringRef cmd_name, const lldb::CommandObjectSP &command_obj, bool can_replace)
 
virtual bool WantsRawCommandString ()=0
 
virtual bool WantsCompletion ()
 
virtual OptionsGetOptions ()
 
int GetNumArgumentEntries ()
 
CommandArgumentEntryGetArgumentEntryAtIndex (int idx)
 
void GetFormattedCommandArguments (Stream &str, uint32_t opt_set_mask=LLDB_OPT_SET_ALL)
 
bool IsPairType (ArgumentRepetitionType arg_repeat_type)
 
bool ParseOptions (Args &args, CommandReturnObject &result)
 
void SetCommandName (llvm::StringRef name)
 
virtual void HandleCompletion (CompletionRequest &request)
 This default version handles calling option argument completions and then calls HandleArgumentCompletion if the cursor is on an argument, not an option. More...
 
virtual void HandleArgumentCompletion (CompletionRequest &request, OptionElementVector &opt_element_vector)
 The input array contains a parsed version of the line. More...
 
bool HelpTextContainsWord (llvm::StringRef search_word, bool search_short_help=true, bool search_long_help=true, bool search_syntax=true, bool search_options=true)
 
FlagsGetFlags ()
 The flags accessor. More...
 
const FlagsGetFlags () const
 The flags const accessor. More...
 
virtual llvm::Optional< std::stringGetRepeatCommand (Args &current_command_args, uint32_t index)
 Get the command that appropriate for a "repeat" of the current command. More...
 
bool HasOverrideCallback () const
 
void SetOverrideCallback (lldb::CommandOverrideCallback callback, void *baton)
 
void SetOverrideCallback (lldb::CommandOverrideCallbackWithResult callback, void *baton)
 
bool InvokeOverrideCallback (const char **argv, CommandReturnObject &result)
 
virtual bool Execute (const char *args_string, CommandReturnObject &result)=0
 

Static Public Member Functions

static const char * GetArgumentTypeAsCString (const lldb::CommandArgumentType arg_type)
 
static const char * GetArgumentDescriptionAsCString (const lldb::CommandArgumentType arg_type)
 
static lldb::CommandArgumentType LookupArgumentName (llvm::StringRef arg_name)
 
static const ArgumentTableEntryFindArgumentDataByType (lldb::CommandArgumentType arg_type)
 
static void GetArgumentHelp (Stream &str, lldb::CommandArgumentType arg_type, CommandInterpreter &interpreter)
 
static const char * GetArgumentName (lldb::CommandArgumentType arg_type)
 

Protected Member Functions

bool ParseOptionsAndNotify (Args &args, CommandReturnObject &result, OptionGroupOptions &group_options, ExecutionContext &exe_ctx)
 
virtual const char * GetInvalidTargetDescription ()
 
virtual const char * GetInvalidProcessDescription ()
 
virtual const char * GetInvalidThreadDescription ()
 
virtual const char * GetInvalidFrameDescription ()
 
virtual const char * GetInvalidRegContextDescription ()
 
TargetGetSelectedOrDummyTarget (bool prefer_dummy=false)
 
TargetGetSelectedTarget ()
 
TargetGetDummyTarget ()
 
ThreadGetDefaultThread ()
 
bool CheckRequirements (CommandReturnObject &result)
 Check the command to make sure anything required by this command is available. More...
 
void Cleanup ()
 

Static Protected Member Functions

static void AddIDsArgumentData (CommandArgumentEntry &arg, lldb::CommandArgumentType ID, lldb::CommandArgumentType IDRange)
 

Protected Attributes

CommandInterpreterm_interpreter
 
ExecutionContext m_exe_ctx
 
std::unique_lock< std::recursive_mutex > m_api_locker
 
std::string m_cmd_name
 
std::string m_cmd_help_short
 
std::string m_cmd_help_long
 
std::string m_cmd_syntax
 
Flags m_flags
 
std::vector< CommandArgumentEntrym_arguments
 
lldb::CommandOverrideCallback m_deprecated_command_override_callback
 
lldb::CommandOverrideCallbackWithResult m_command_override_callback
 
void * m_command_override_baton
 
bool m_is_user_command = false
 

Detailed Description

Definition at line 68 of file CommandObject.h.

Member Typedef Documentation

◆ ArgumentHelpCallbackFunction

typedef llvm::StringRef() lldb_private::CommandObject::ArgumentHelpCallbackFunction()

Definition at line 70 of file CommandObject.h.

◆ CommandArgumentEntry

Definition at line 107 of file CommandObject.h.

◆ CommandMap

typedef std::map<std::string, lldb::CommandObjectSP> lldb_private::CommandObject::CommandMap

Definition at line 109 of file CommandObject.h.

Constructor & Destructor Documentation

◆ CommandObject()

CommandObject::CommandObject ( CommandInterpreter interpreter,
llvm::StringRef  name,
llvm::StringRef  help = "",
llvm::StringRef  syntax = "",
uint32_t  flags = 0 
)

Definition at line 43 of file CommandObject.cpp.

References m_cmd_help_short, m_cmd_syntax, and string().

◆ ~CommandObject()

virtual lldb_private::CommandObject::~CommandObject ( )
virtualdefault

Member Function Documentation

◆ AddIDsArgumentData()

void CommandObject::AddIDsArgumentData ( CommandArgumentEntry arg,
lldb::CommandArgumentType  ID,
lldb::CommandArgumentType  IDRange 
)
staticprotected

◆ CheckRequirements()

bool CommandObject::CheckRequirements ( CommandReturnObject result)
protected

Check the command to make sure anything required by this command is available.

Parameters
[out]resultA command result object, if it is not okay to run the command this will be filled in with a suitable error.
Returns
true if it is okay to run this command, false otherwise.

Definition at line 147 of file CommandObject.cpp.

References lldb_private::CommandReturnObject::AppendError(), lldb::eStateAttaching, lldb::eStateConnected, lldb::eStateCrashed, lldb::eStateDetached, lldb::eStateExited, lldb::eStateInvalid, lldb::eStateLaunching, lldb::eStateRunning, lldb::eStateStepping, lldb::eStateStopped, lldb::eStateSuspended, lldb::eStateUnloaded, lldb_private::Flags::Get(), lldb_private::Target::GetAPIMutex(), lldb_private::CommandInterpreter::GetExecutionContext(), GetFlags(), lldb_private::ExecutionContext::GetFramePtr(), GetInvalidFrameDescription(), GetInvalidProcessDescription(), GetInvalidRegContextDescription(), GetInvalidTargetDescription(), GetInvalidThreadDescription(), lldb_private::ExecutionContext::GetProcessPtr(), lldb_private::ExecutionContext::GetRegisterContext(), lldb_private::Process::GetState(), lldb_private::ExecutionContext::GetTargetPtr(), lldb_private::ExecutionContext::GetThreadPtr(), lldb_private::Target::GetTrace(), lldb_private::ExecutionContext::HasFrameScope(), lldb_private::ExecutionContext::HasProcessScope(), lldb_private::ExecutionContext::HasTargetScope(), lldb_private::ExecutionContext::HasThreadScope(), m_api_locker, m_exe_ctx, and m_interpreter.

Referenced by lldb_private::CommandObjectParsed::Execute(), and lldb_private::CommandObjectRaw::Execute().

◆ Cleanup()

void CommandObject::Cleanup ( )
protected

◆ Execute()

virtual bool lldb_private::CommandObject::Execute ( const char *  args_string,
CommandReturnObject result 
)
pure virtual

◆ FindArgumentDataByType()

const CommandObject::ArgumentTableEntry * CommandObject::FindArgumentDataByType ( lldb::CommandArgumentType  arg_type)
static

Definition at line 369 of file CommandObject.cpp.

References lldb::eArgTypeLastArg, and lldb_private::g_argument_table.

Referenced by GetArgumentHelp(), and GetArgumentName().

◆ FormatLongHelpText()

void CommandObject::FormatLongHelpText ( Stream output_strm,
llvm::StringRef  long_help 
)

◆ GenerateHelpText() [1/2]

void CommandObject::GenerateHelpText ( CommandReturnObject result)

◆ GenerateHelpText() [2/2]

void CommandObject::GenerateHelpText ( Stream result)
virtual

◆ GetArgumentDescriptionAsCString()

const char * CommandObject::GetArgumentDescriptionAsCString ( const lldb::CommandArgumentType  arg_type)
static

◆ GetArgumentEntryAtIndex()

CommandObject::CommandArgumentEntry * CommandObject::GetArgumentEntryAtIndex ( int  idx)

Definition at line 361 of file CommandObject.cpp.

References m_arguments.

◆ GetArgumentHelp()

void CommandObject::GetArgumentHelp ( Stream str,
lldb::CommandArgumentType  arg_type,
CommandInterpreter interpreter 
)
static

◆ GetArgumentName()

const char * CommandObject::GetArgumentName ( lldb::CommandArgumentType  arg_type)
static

◆ GetArgumentTypeAsCString()

const char * CommandObject::GetArgumentTypeAsCString ( const lldb::CommandArgumentType  arg_type)
static

◆ GetAsMultiwordCommand()

virtual CommandObjectMultiword* lldb_private::CommandObject::GetAsMultiwordCommand ( )
inlinevirtual

◆ GetCommandInterpreter()

CommandInterpreter& lldb_private::CommandObject::GetCommandInterpreter ( )
inline

◆ GetCommandName()

llvm::StringRef CommandObject::GetCommandName ( ) const

◆ GetDebugger()

Debugger & CommandObject::GetDebugger ( )

◆ GetDefaultThread()

Thread * CommandObject::GetDefaultThread ( )
protected

◆ GetDummyTarget()

Target & CommandObject::GetDummyTarget ( )
protected

◆ GetFlags() [1/2]

Flags& lldb_private::CommandObject::GetFlags ( )
inline

The flags accessor.

Returns
A reference to the Flags member variable.

Definition at line 262 of file CommandObject.h.

References m_flags.

Referenced by CheckRequirements().

◆ GetFlags() [2/2]

const Flags& lldb_private::CommandObject::GetFlags ( ) const
inline

The flags const accessor.

Returns
A const reference to the Flags member variable.

Definition at line 268 of file CommandObject.h.

References m_flags.

◆ GetFormattedCommandArguments()

void CommandObject::GetFormattedCommandArguments ( Stream str,
uint32_t  opt_set_mask = LLDB_OPT_SET_ALL 
)

◆ GetHelp()

llvm::StringRef CommandObject::GetHelp ( )
virtual

◆ GetHelpLong()

llvm::StringRef CommandObject::GetHelpLong ( )
virtual

◆ GetInvalidFrameDescription()

virtual const char* lldb_private::CommandObject::GetInvalidFrameDescription ( )
inlineprotectedvirtual

Definition at line 333 of file CommandObject.h.

Referenced by CheckRequirements().

◆ GetInvalidProcessDescription()

virtual const char* lldb_private::CommandObject::GetInvalidProcessDescription ( )
inlineprotectedvirtual

Definition at line 325 of file CommandObject.h.

Referenced by CheckRequirements().

◆ GetInvalidRegContextDescription()

virtual const char* lldb_private::CommandObject::GetInvalidRegContextDescription ( )
inlineprotectedvirtual

Definition at line 337 of file CommandObject.h.

Referenced by CheckRequirements().

◆ GetInvalidTargetDescription()

virtual const char* lldb_private::CommandObject::GetInvalidTargetDescription ( )
inlineprotectedvirtual

Definition at line 321 of file CommandObject.h.

Referenced by CheckRequirements().

◆ GetInvalidThreadDescription()

virtual const char* lldb_private::CommandObject::GetInvalidThreadDescription ( )
inlineprotectedvirtual

Definition at line 329 of file CommandObject.h.

Referenced by CheckRequirements().

◆ GetNumArgumentEntries()

int CommandObject::GetNumArgumentEntries ( )

Definition at line 358 of file CommandObject.cpp.

References m_arguments.

Referenced by GenerateHelpText().

◆ GetOptions()

Options * CommandObject::GetOptions ( )
virtual

Reimplemented in CommandObjectProcessGDBRemoteSpeedTest, CommandObjectTargetStopHookAdd, CommandObjectRenderScriptRuntimeAllocationList, CommandObjectRenderScriptRuntimeAllocationDump, CommandObjectRenderScriptRuntimeKernelBreakpointSet, CommandObjectRenderScriptRuntimeReductionBreakpointSet, CommandObjectTargetSymbolsAdd, CommandObjectTargetModulesLookup, CommandObjectTargetModulesShowUnwind, CommandObjectTargetModulesList, CommandObjectTargetModulesLoad, CommandObjectTargetModulesAdd, CommandObjectTraceDumpInfo, CommandObjectTraceDumpInstructions, CommandObjectTargetModulesDumpLineTable, CommandObjectBreakpointWrite, CommandObjectTraceDumpFunctionCalls, CommandObjectBreakpointRead, CommandObjectBreakpointNameList, CommandObjectTargetModulesDumpSymtab, CommandObjectBreakpointNameDelete, CommandObjectBreakpointNameAdd, CommandObjectThreadPlanList, CommandObjectPlatformShell, CommandObjectBreakpointNameConfigure, CommandObjectMemoryRegion, CommandObjectPlatformProcessAttach, CommandObjectThreadJump, CommandObjectProcessHandle, CommandObjectThreadReturn, CommandObjectProcessStatus, CommandObjectBreakpointDelete, CommandObjectCommandsScriptAdd, CommandObjectProcessSaveCore, CommandObjectMemoryWrite, CommandObjectThreadInfo, CommandObjectCommandsScriptImport, CommandObjectBreakpointClear, CommandObjectPlatformProcessList, CommandObjectPlatformProcessLaunch, CommandObjectBreakpointList, CommandObjectProcessLoad, CommandObjectCommandsAddRegex, CommandObjectSettingsClear, CommandObjectWatchpointSetExpression, CommandObjectTypeFormatterList< FormatterType >, CommandObjectMemoryFind, CommandObjectProcessConnect, CommandObjectThreadUntil, CommandObjectObjC_ClassTable_Dump, CommandObjectTypeFormatterClear, CommandObjectProcessMinidumpDump, CommandObjectProcessKDPPacketSend, CommandObjectProcessDetach, CommandObjectWatchpointSetVariable, sddarwinlog_private::EnableCommand, CommandObjectBreakpointModify, CommandObjectTargetVariable, CommandObjectFrameRecognizerAdd, CommandObjectProcessContinue, CommandObjectTypeFormatterDelete, CommandObjectSourceList, CommandObjectPlatformFWrite, CommandObjectWatchpointModify, CommandObjectPlatformFRead, CommandObjectWatchpointIgnore, CommandObjectTypeFormatAdd, CommandObjectTargetDelete, CommandObjectPlatformFOpen, CommandObjectBreakpointCommandDelete, CommandObjectPlatformMkDir, CommandObjectWatchpointDelete, CommandObjectFrameVariable, CommandObjectSettingsRead, CommandObjectPlatformSettings, CommandObjectThreadStepWithTypeAndScope, CommandObjectProcessAttach, CommandObjectTypeSynthAdd, CommandObjectTraceSchema, CommandObjectLogDump, CommandObjectMemoryRead, CommandObjectSettingsWrite, CommandObjectPlatformConnect, CommandObjectFrameSelect, CommandObjectTraceDump, CommandObjectCommandsAlias, CommandObjectBreakpointSet, CommandObjectTargetCreate, CommandObjectTraceLoad, CommandObjectMemoryTagWrite, CommandObjectPlatformSelect, CommandObjectWatchpointList, CommandObjectProcessLaunch, CommandObjectTypeSummaryAdd, CommandObjectFrameDiagnose, CommandObjectSourceInfo, CommandObjectThreadBacktrace, CommandObjectBreakpointCommandAdd, lldb_private::CommandObjectProxy, CommandObjectStatsDump, lldb_private::trace_intel_pt::CommandObjectProcessTraceStartIntelPT, CommandObjectWatchpointCommandAdd, CommandObjectRegisterRead, CommandObjectLogEnable, lldb_private::CommandObjectHelp, CommandObjectCommandsSource, lldb_private::CommandObjectDisassemble, CommandObjectSettingsSet, CommandObjectTraceSave, CommandObjectSessionHistory, CommandObjectDiagnosticsDump, lldb_private::CommandObjectExpression, lldb_private::trace_intel_pt::CommandObjectThreadTraceStartIntelPT, lldb_private::ctf::CommandObjectThreadTraceExportCTF, lldb_private::CommandAlias, and lldb_private::CommandObjectScript.

Definition at line 100 of file CommandObject.cpp.

Referenced by GenerateHelpText(), lldb_private::CommandObjectProxy::GetOptions(), GetSyntax(), HandleCompletion(), HelpTextContainsWord(), and ParseOptions().

◆ GetRepeatCommand()

virtual llvm::Optional<std::string> lldb_private::CommandObject::GetRepeatCommand ( Args current_command_args,
uint32_t  index 
)
inlinevirtual

Get the command that appropriate for a "repeat" of the current command.

Parameters
[in]current_command_argsThe command arguments.
Returns
llvm::None if there is no special repeat command - it will use the current command line. Otherwise a std::string containing the command to be repeated. If the string is empty, the command won't be allow repeating.

Reimplemented in CommandObjectTraceDumpInstructions, CommandObjectMemoryRegion, CommandObjectMemoryHistory, CommandObjectSourceList, CommandObjectMemoryRead, CommandObjectProcessLaunch, lldb_private::CommandObjectProxy, CommandPluginInterfaceImplementation, CommandObjectCommandsSource, lldb_private::CommandObjectMultiword, and CommandObjectThreadBacktrace.

Definition at line 281 of file CommandObject.h.

Referenced by lldb_private::CommandObjectMultiword::GetRepeatCommand(), and lldb_private::CommandObjectProxy::GetRepeatCommand().

◆ GetSelectedOrDummyTarget()

Target & CommandObject::GetSelectedOrDummyTarget ( bool  prefer_dummy = false)
protected

◆ GetSelectedTarget()

Target & CommandObject::GetSelectedTarget ( )
protected

◆ GetSubcommandObject()

virtual CommandObject* lldb_private::CommandObject::GetSubcommandObject ( llvm::StringRef  sub_cmd,
StringList matches = nullptr 
)
inlinevirtual

◆ GetSubcommandSP()

virtual lldb::CommandObjectSP lldb_private::CommandObject::GetSubcommandSP ( llvm::StringRef  sub_cmd,
StringList matches = nullptr 
)
inlinevirtual

◆ GetSubcommandSPExact()

virtual lldb::CommandObjectSP lldb_private::CommandObject::GetSubcommandSPExact ( llvm::StringRef  sub_cmd)
inlinevirtual

Reimplemented in lldb_private::CommandObjectMultiword.

Definition at line 165 of file CommandObject.h.

◆ GetSyntax()

llvm::StringRef CommandObject::GetSyntax ( )
virtual

◆ HandleArgumentCompletion()

virtual void lldb_private::CommandObject::HandleArgumentCompletion ( CompletionRequest request,
OptionElementVector opt_element_vector 
)
inlinevirtual

The input array contains a parsed version of the line.

We've constructed the map of options and their arguments as well if that is helpful for the completion.

Parameters
[in,out]requestThe completion request that needs to be answered.

Reimplemented in CommandObjectTargetStopHookEnableDisable, CommandObjectTargetStopHookDelete, CommandObjectTargetSymbolsAdd, CommandObjectTargetModulesAdd, CommandObjectBreakpointWrite, CommandObjectThreadPlanDiscard, CommandObjectBreakpointNameDelete, CommandObjectPlatformInstall, CommandObjectTargetModulesSourceFileAutoComplete, CommandObjectTargetModulesModuleAutoComplete, CommandObjectBreakpointNameAdd, CommandObjectCommandsScriptDelete, CommandObjectPlatformProcessInfo, CommandObjectCommandsScriptAdd, CommandObjectBreakpointDelete, CommandObjectThreadSiginfo, CommandObjectThreadException, CommandObjectThreadInfo, CommandObjectCommandsScriptImport, CommandObjectProcessSignal, CommandObjectThreadSelect, CommandObjectProcessUnload, CommandObjectTargetModulesSearchPathsInsert, CommandObjectPlatformPutFile, CommandObjectProcessLoad, CommandObjectSettingsClear, CommandObjectPlatformFileExists, CommandObjectBreakpointDisable, CommandObjectSettingsAppend, CommandObjectPlatformGetPermissions, CommandObjectFrameRecognizerDelete, CommandObjectBreakpointEnable, CommandObjectPlatformGetSize, CommandObjectSettingsInsertAfter, CommandObjectWatchpointSetVariable, CommandObjectBreakpointModify, CommandObjectPlatformGetFile, CommandObjectSettingsInsertBefore, CommandObjectTypeFormatterDelete, CommandObjectCommandsDelete, CommandObjectSettingsReplace, CommandObjectWatchpointModify, CommandObjectThreadContinue, CommandObjectCommandsUnalias, CommandObjectSettingsRemove, CommandObjectLogTimerIncrement, CommandObjectWatchpointIgnore, CommandObjectSettingsList, CommandObjectPlatformFOpen, CommandObjectWatchpointDelete, CommandObjectFrameVariable, CommandObjectThreadStepWithTypeAndScope, CommandObjectLogDump, CommandObjectWatchpointDisable, CommandObjectRegisterWrite, CommandObjectLogList, CommandObjectWatchpointEnable, CommandObjectFrameSelect, CommandObjectSettingsShow, CommandObjectTargetCreate, CommandObjectLogDisable, CommandObjectTraceLoad, CommandObjectLogEnable, CommandObjectProcessLaunch, lldb_private::CommandObjectProxy, CommandObjectSettingsSet, CommandObjectTraceSave, CommandObjectRegisterRead, CommandObjectCommandsSource, lldb_private::CommandAlias, CommandObjectPluginLoad, and CommandObjectSessionSave.

Definition at line 249 of file CommandObject.h.

Referenced by lldb_private::CommandObjectProxy::HandleArgumentCompletion(), and HandleCompletion().

◆ HandleCompletion()

void CommandObject::HandleCompletion ( CompletionRequest request)
virtual

◆ HasOverrideCallback()

bool lldb_private::CommandObject::HasOverrideCallback ( ) const
inline

◆ HelpTextContainsWord()

bool CommandObject::HelpTextContainsWord ( llvm::StringRef  search_word,
bool  search_short_help = true,
bool  search_long_help = true,
bool  search_syntax = true,
bool  search_options = true 
)

◆ InvokeOverrideCallback()

bool lldb_private::CommandObject::InvokeOverrideCallback ( const char **  argv,
CommandReturnObject result 
)
inline

◆ IsAlias()

virtual bool lldb_private::CommandObject::IsAlias ( )
inlinevirtual

Reimplemented in lldb_private::CommandAlias.

Definition at line 153 of file CommandObject.h.

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

◆ IsDashDashCommand()

virtual bool lldb_private::CommandObject::IsDashDashCommand ( )
inlinevirtual

◆ IsMultiwordObject()

virtual bool lldb_private::CommandObject::IsMultiwordObject ( )
inlinevirtual

◆ IsPairType()

bool CommandObject::IsPairType ( ArgumentRepetitionType  arg_repeat_type)

◆ IsRemovable()

virtual bool lldb_private::CommandObject::IsRemovable ( ) const
inlinevirtual

◆ IsUserCommand()

bool lldb_private::CommandObject::IsUserCommand ( )
inline

◆ LoadSubCommand()

virtual bool lldb_private::CommandObject::LoadSubCommand ( llvm::StringRef  cmd_name,
const lldb::CommandObjectSP &  command_obj 
)
inlinevirtual

◆ LoadUserSubcommand()

virtual llvm::Error lldb_private::CommandObject::LoadUserSubcommand ( llvm::StringRef  cmd_name,
const lldb::CommandObjectSP &  command_obj,
bool  can_replace 
)
inlinevirtual

Reimplemented in lldb_private::CommandObjectMultiword.

Definition at line 188 of file CommandObject.h.

◆ LookupArgumentName()

CommandArgumentType CommandObject::LookupArgumentName ( llvm::StringRef  arg_name)
static

◆ ParseOptions()

bool CommandObject::ParseOptions ( Args args,
CommandReturnObject result 
)

◆ ParseOptionsAndNotify()

bool CommandObject::ParseOptionsAndNotify ( Args args,
CommandReturnObject result,
OptionGroupOptions group_options,
ExecutionContext exe_ctx 
)
protected

◆ SetCommandName()

void CommandObject::SetCommandName ( llvm::StringRef  name)

Definition at line 84 of file CommandObject.cpp.

References m_cmd_name, and string().

◆ SetHelp()

void CommandObject::SetHelp ( llvm::StringRef  str)
virtual

Reimplemented in lldb_private::CommandAlias.

Definition at line 88 of file CommandObject.cpp.

References m_cmd_help_short, and string().

Referenced by lldb_private::CommandAlias::SetHelp().

◆ SetHelpLong()

void CommandObject::SetHelpLong ( llvm::StringRef  str)
virtual

◆ SetIsUserCommand()

void lldb_private::CommandObject::SetIsUserCommand ( bool  is_user)
inline

Definition at line 149 of file CommandObject.h.

References m_is_user_command.

◆ SetOverrideCallback() [1/2]

void lldb_private::CommandObject::SetOverrideCallback ( lldb::CommandOverrideCallback  callback,
void *  baton 
)
inline

◆ SetOverrideCallback() [2/2]

void lldb_private::CommandObject::SetOverrideCallback ( lldb::CommandOverrideCallbackWithResult  callback,
void *  baton 
)
inline

Definition at line 296 of file CommandObject.h.

References m_command_override_baton, and m_command_override_callback.

◆ SetSyntax()

void CommandObject::SetSyntax ( llvm::StringRef  str)

Definition at line 96 of file CommandObject.cpp.

References m_cmd_syntax, and string().

Referenced by lldb_private::CommandInterpreter::Initialize().

◆ WantsCompletion()

virtual bool lldb_private::CommandObject::WantsCompletion ( )
inlinevirtual

◆ WantsRawCommandString()

virtual bool lldb_private::CommandObject::WantsRawCommandString ( )
pure virtual

Member Data Documentation

◆ m_api_locker

std::unique_lock<std::recursive_mutex> lldb_private::CommandObject::m_api_locker
protected

Definition at line 371 of file CommandObject.h.

Referenced by CheckRequirements(), and Cleanup().

◆ m_arguments

std::vector<CommandArgumentEntry> lldb_private::CommandObject::m_arguments
protected

◆ m_cmd_help_long

std::string lldb_private::CommandObject::m_cmd_help_long
protected

◆ m_cmd_help_short

std::string lldb_private::CommandObject::m_cmd_help_short
protected

◆ m_cmd_name

std::string lldb_private::CommandObject::m_cmd_name
protected

◆ m_cmd_syntax

std::string lldb_private::CommandObject::m_cmd_syntax
protected

Definition at line 375 of file CommandObject.h.

Referenced by CommandObject(), GetSyntax(), and SetSyntax().

◆ m_command_override_baton

void* lldb_private::CommandObject::m_command_override_baton
protected

Definition at line 380 of file CommandObject.h.

Referenced by InvokeOverrideCallback(), and SetOverrideCallback().

◆ m_command_override_callback

lldb::CommandOverrideCallbackWithResult lldb_private::CommandObject::m_command_override_callback
protected

◆ m_deprecated_command_override_callback

lldb::CommandOverrideCallback lldb_private::CommandObject::m_deprecated_command_override_callback
protected

◆ m_exe_ctx

ExecutionContext lldb_private::CommandObject::m_exe_ctx
protected

◆ m_flags

Flags lldb_private::CommandObject::m_flags
protected

Definition at line 376 of file CommandObject.h.

Referenced by GetFlags(), and GetSelectedTarget().

◆ m_interpreter

CommandInterpreter& lldb_private::CommandObject::m_interpreter
protected

◆ m_is_user_command

bool lldb_private::CommandObject::m_is_user_command = false
protected

Definition at line 381 of file CommandObject.h.

Referenced by IsUserCommand(), and SetIsUserCommand().


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