LLDB mainline
Public Member Functions | Protected Member Functions | List of all members
lldb_private::CommandObjectParsed Class Referenceabstract

#include <CommandObject.h>

Inherits lldb_private::CommandObject.

Inherited by CommandObjectBreakpointClear, CommandObjectBreakpointCommandAdd, CommandObjectBreakpointCommandDelete, CommandObjectBreakpointCommandList, CommandObjectBreakpointDelete, CommandObjectBreakpointDisable, CommandObjectBreakpointEnable, CommandObjectBreakpointList, CommandObjectBreakpointModify, CommandObjectBreakpointNameAdd, CommandObjectBreakpointNameConfigure, CommandObjectBreakpointNameDelete, CommandObjectBreakpointNameList, CommandObjectBreakpointRead, CommandObjectBreakpointSet, CommandObjectBreakpointWrite, CommandObjectCommandsAddRegex, CommandObjectCommandsContainerAdd, CommandObjectCommandsContainerDelete, CommandObjectCommandsDelete, CommandObjectCommandsScriptAdd, CommandObjectCommandsScriptClear, CommandObjectCommandsScriptDelete, CommandObjectCommandsScriptImport, CommandObjectCommandsScriptList, CommandObjectCommandsSource, CommandObjectCommandsUnalias, CommandObjectDiagnosticsDump, CommandObjectFrameDiagnose, CommandObjectFrameInfo, CommandObjectFrameRecognizerAdd, CommandObjectFrameRecognizerClear, CommandObjectFrameRecognizerInfo, CommandObjectFrameRecognizerList, CommandObjectFrameSelect, CommandObjectFrameVariable, CommandObjectLogDisable, CommandObjectLogDump, CommandObjectLogEnable, CommandObjectLogList, CommandObjectLogTimerDisable, CommandObjectLogTimerDump, CommandObjectLogTimerEnable, CommandObjectLogTimerIncrement, CommandObjectLogTimerReset, CommandObjectMemoryFind, CommandObjectMemoryHistory, CommandObjectMemoryRead, CommandObjectMemoryRegion, CommandObjectMemoryTagRead, CommandObjectMemoryTagWrite, CommandObjectMemoryWrite, CommandObjectMultiwordItaniumABI_Demangle, CommandObjectMultiwordObjC_TaggedPointer_Info, CommandObjectObjC_ClassTable_Dump, CommandObjectPlatformConnect, CommandObjectPlatformDisconnect, CommandObjectPlatformFClose, CommandObjectPlatformFOpen, CommandObjectPlatformFRead, CommandObjectPlatformFWrite, CommandObjectPlatformFileExists, CommandObjectPlatformGetFile, CommandObjectPlatformGetPermissions, CommandObjectPlatformGetSize, CommandObjectPlatformInstall, CommandObjectPlatformList, CommandObjectPlatformMkDir, CommandObjectPlatformProcessAttach, CommandObjectPlatformProcessInfo, CommandObjectPlatformProcessLaunch, CommandObjectPlatformProcessList, CommandObjectPlatformPutFile, CommandObjectPlatformSelect, CommandObjectPlatformSettings, CommandObjectPlatformStatus, CommandObjectPluginLoad, CommandObjectProcessConnect, CommandObjectProcessContinue, CommandObjectProcessDetach, CommandObjectProcessGDBRemotePacketHistory, CommandObjectProcessGDBRemotePacketSend, CommandObjectProcessGDBRemotePacketXferSize, CommandObjectProcessGDBRemoteSpeedTest, CommandObjectProcessHandle, CommandObjectProcessInterrupt, CommandObjectProcessKDPPacketSend, CommandObjectProcessKill, CommandObjectProcessLaunchOrAttach, CommandObjectProcessLoad, CommandObjectProcessMinidumpDump, CommandObjectProcessSaveCore, CommandObjectProcessSignal, CommandObjectProcessStatus, CommandObjectProcessTraceStop, CommandObjectProcessUnload, CommandObjectRegisterInfo, CommandObjectRegisterRead, CommandObjectRegisterWrite, CommandObjectScriptingExtensionList, CommandObjectScriptingObjectParsed, CommandObjectSessionHistory, CommandObjectSessionSave, CommandObjectSettingsClear, CommandObjectSettingsList, CommandObjectSettingsRead, CommandObjectSettingsShow, CommandObjectSettingsWrite, CommandObjectSourceCacheClear, CommandObjectSourceCacheDump, CommandObjectSourceInfo, CommandObjectSourceList, CommandObjectStatsDisable, CommandObjectStatsDump, CommandObjectStatsEnable, CommandObjectTargetCreate, CommandObjectTargetDelete, CommandObjectTargetDumpSectionLoadList, CommandObjectTargetDumpTypesystem, CommandObjectTargetList, CommandObjectTargetModulesAdd, CommandObjectTargetModulesDumpClangPCMInfo, CommandObjectTargetModulesList, CommandObjectTargetModulesLookup, CommandObjectTargetModulesModuleAutoComplete, CommandObjectTargetModulesSearchPathsAdd, CommandObjectTargetModulesSearchPathsClear, CommandObjectTargetModulesSearchPathsInsert, CommandObjectTargetModulesSearchPathsList, CommandObjectTargetModulesSearchPathsQuery, CommandObjectTargetModulesShowUnwind, CommandObjectTargetModulesSourceFileAutoComplete, CommandObjectTargetSelect, CommandObjectTargetShowLaunchEnvironment, CommandObjectTargetStopHookAdd, CommandObjectTargetStopHookDelete, CommandObjectTargetStopHookEnableDisable, CommandObjectTargetStopHookList, CommandObjectTargetSymbolsAdd, CommandObjectTargetVariable, CommandObjectThreadContinue, CommandObjectThreadJump, CommandObjectThreadList, CommandObjectThreadPlanDiscard, CommandObjectThreadPlanPrune, CommandObjectThreadSelect, CommandObjectThreadStepWithTypeAndScope, CommandObjectThreadUntil, CommandObjectTraceDump, CommandObjectTraceDumpFunctionCalls, CommandObjectTraceDumpInstructions, CommandObjectTraceLoad, CommandObjectTraceSave, CommandObjectTraceSchema, CommandObjectTypeCategoryDefine, CommandObjectTypeCategoryDelete, CommandObjectTypeCategoryDisable, CommandObjectTypeCategoryEnable, CommandObjectTypeCategoryList, CommandObjectTypeFilterAdd, CommandObjectTypeFormatAdd, CommandObjectTypeFormatterClear, CommandObjectTypeFormatterDelete, CommandObjectTypeFormatterList< FormatterType >, CommandObjectTypeSummaryAdd, CommandObjectTypeSynthAdd, CommandObjectWatchpointCommandAdd, CommandObjectWatchpointCommandDelete, CommandObjectWatchpointCommandList, CommandObjectWatchpointDelete, CommandObjectWatchpointDisable, CommandObjectWatchpointEnable, CommandObjectWatchpointIgnore, CommandObjectWatchpointList, CommandObjectWatchpointModify, CommandObjectWatchpointSetVariable, CommandObjectWithFrameRecognizerArg, lldb_private::CommandObjectApropos, lldb_private::CommandObjectDisassemble, lldb_private::CommandObjectGUI, lldb_private::CommandObjectHelp, lldb_private::CommandObjectIterateOverThreads, lldb_private::CommandObjectMultipleThreads, lldb_private::CommandObjectQuit, lldb_private::CommandObjectVersion, lldb_private::CommandPluginInterfaceImplementation, lldb_private::ctf::CommandObjectThreadTraceExportCTF, lldb_private::trace_intel_pt::CommandObjectProcessTraceStartIntelPT, sddarwinlog_private::EnableCommand, and sddarwinlog_private::StatusCommand.

Public Member Functions

 CommandObjectParsed (CommandInterpreter &interpreter, const char *name, const char *help=nullptr, const char *syntax=nullptr, uint32_t flags=0)
 
 ~CommandObjectParsed () override=default
 
void Execute (const char *args_string, CommandReturnObject &result) override
 
- Public Member Functions inherited from lldb_private::CommandObject
 CommandObject (CommandInterpreter &interpreter, llvm::StringRef name, llvm::StringRef help="", llvm::StringRef syntax="", uint32_t flags=0)
 
virtual ~CommandObject ()=default
 
CommandInterpreter & GetCommandInterpreter ()
 
Debugger & GetDebugger ()
 
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 CommandObjectMultiword * GetAsMultiwordCommand ()
 
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 CommandObject * GetSubcommandObject (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 Options * GetOptions ()
 
void AddSimpleArgumentList (lldb::CommandArgumentType arg_type, ArgumentRepetitionType repetition_type=eArgRepeatPlain)
 
void AddIDsArgumentData (IDType type)
 
int GetNumArgumentEntries ()
 
CommandArgumentEntry * GetArgumentEntryAtIndex (int idx)
 
void GetFormattedCommandArguments (Stream &str, uint32_t opt_set_mask=LLDB_OPT_SET_ALL)
 
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.
 
virtual void HandleArgumentCompletion (CompletionRequest &request, OptionElementVector &opt_element_vector)
 The default version handles argument definitions that have only one argument type, and use one of the argument types that have an entry in the CommonCompletions.
 
bool HelpTextContainsWord (llvm::StringRef search_word, bool search_short_help=true, bool search_long_help=true, bool search_syntax=true, bool search_options=true)
 
Flags & GetFlags ()
 The flags accessor.
 
const Flags & GetFlags () const
 The flags const accessor.
 
virtual std::optional< std::string > GetRepeatCommand (Args &current_command_args, uint32_t index)
 Get the command that appropriate for a "repeat" of the current command.
 
bool HasOverrideCallback () const
 
void SetOverrideCallback (lldb::CommandOverrideCallback callback, void *baton)
 
void SetOverrideCallback (lldb_private::CommandOverrideCallbackWithResult callback, void *baton)
 
bool InvokeOverrideCallback (const char **argv, CommandReturnObject &result)
 
void SetOriginalCommandString (std::string s)
 Set the command input as it appeared in the terminal.
 
virtual void Execute (const char *args_string, CommandReturnObject &result)=0
 

Protected Member Functions

virtual void DoExecute (Args &command, CommandReturnObject &result)=0
 
bool WantsRawCommandString () override
 
- Protected Member Functions inherited from lldb_private::CommandObject
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 ()
 
Target & GetDummyTarget ()
 
Target & GetTarget ()
 
Thread * GetDefaultThread ()
 
bool CheckRequirements (CommandReturnObject &result)
 Check the command to make sure anything required by this command is available.
 
void Cleanup ()
 

Additional Inherited Members

- Public Types inherited from lldb_private::CommandObject
enum  IDType { eBreakpointArgs = 0 , eWatchpointArgs = 1 }
 
typedef llvm::StringRef() ArgumentHelpCallbackFunction()
 
typedef std::vector< CommandArgumentData > CommandArgumentEntry
 
typedef std::map< std::string, lldb::CommandObjectSP, std::less<> > CommandMap
 
- Static Public Member Functions inherited from lldb_private::CommandObject
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 ArgumentTableEntry * FindArgumentDataByType (lldb::CommandArgumentType arg_type)
 
static void GetArgumentHelp (Stream &str, lldb::CommandArgumentType arg_type, CommandInterpreter &interpreter)
 
static const char * GetArgumentName (lldb::CommandArgumentType arg_type)
 
static bool IsPairType (ArgumentRepetitionType arg_repeat_type)
 
static std::optional< ArgumentRepetitionType > ArgRepetitionFromString (llvm::StringRef string)
 
- Protected Attributes inherited from lldb_private::CommandObject
CommandInterpreter & m_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
 
std::string m_original_command
 
Flags m_flags
 
std::vector< CommandArgumentEntry > m_arguments
 
lldb::CommandOverrideCallback m_deprecated_command_override_callback
 
lldb_private::CommandOverrideCallbackWithResult m_command_override_callback
 
void * m_command_override_baton
 
bool m_is_user_command = false
 

Detailed Description

Definition at line 425 of file CommandObject.h.

Constructor & Destructor Documentation

◆ CommandObjectParsed()

lldb_private::CommandObjectParsed::CommandObjectParsed ( CommandInterpreter &  interpreter,
const char *  name,
const char *  help = nullptr,
const char *  syntax = nullptr,
uint32_t  flags = 0 
)
inline

Definition at line 427 of file CommandObject.h.

◆ ~CommandObjectParsed()

lldb_private::CommandObjectParsed::~CommandObjectParsed ( )
overridedefault

Member Function Documentation

◆ DoExecute()

virtual void lldb_private::CommandObjectParsed::DoExecute ( Args &  command,
CommandReturnObject &  result 
)
protectedpure virtual

Implemented in CommandObjectCommandsUnalias, CommandObjectCommandsDelete, CommandObjectScriptingObjectParsed, CommandObjectDiagnosticsDump, lldb_private::CommandObjectGUI, CommandObjectLogEnable, CommandObjectLogDisable, CommandObjectLogList, CommandObjectLogDump, CommandObjectLogTimerEnable, CommandObjectLogTimerDisable, CommandObjectLogTimerDump, CommandObjectLogTimerReset, CommandObjectLogTimerIncrement, CommandObjectPlatformSelect, CommandObjectPlatformList, CommandObjectPlatformStatus, CommandObjectPlatformConnect, CommandObjectPlatformDisconnect, CommandObjectPlatformSettings, CommandObjectPlatformMkDir, CommandObjectPlatformFOpen, CommandObjectPlatformFClose, CommandObjectPlatformFRead, CommandObjectPlatformFWrite, CommandObjectPlatformGetFile, CommandObjectPlatformGetSize, CommandObjectPlatformGetPermissions, CommandObjectPlatformFileExists, CommandObjectPlatformPutFile, CommandObjectPlatformProcessLaunch, CommandObjectPlatformProcessList, CommandObjectPlatformProcessInfo, CommandObjectPlatformInstall, lldb_private::CommandObjectQuit, CommandObjectSessionSave, CommandObjectSettingsShow, CommandObjectSettingsWrite, CommandObjectSettingsList, CommandObjectTargetList, CommandObjectTargetSelect, CommandObjectTargetDelete, CommandObjectTargetShowLaunchEnvironment, CommandObjectTargetVariable, CommandObjectTargetModulesAdd, CommandObjectTargetModulesLoad, CommandObjectTargetSymbolsAdd, CommandObjectThreadJump, CommandObjectThreadPlanDiscard, CommandObjectThreadPlanPrune, CommandObjectTraceDumpFunctionCalls, CommandObjectTraceDumpInstructions, lldb_private::CommandObjectVersion, lldb_private::ctf::CommandObjectThreadTraceExportCTF, lldb_private::CommandPluginInterfaceImplementation, lldb_private::CommandObjectApropos, CommandObjectBreakpointSet, CommandObjectBreakpointModify, CommandObjectBreakpointEnable, CommandObjectBreakpointDisable, CommandObjectBreakpointList, CommandObjectBreakpointClear, CommandObjectBreakpointDelete, CommandObjectBreakpointNameConfigure, CommandObjectBreakpointNameAdd, CommandObjectBreakpointNameDelete, CommandObjectBreakpointNameList, CommandObjectBreakpointRead, CommandObjectBreakpointWrite, CommandObjectBreakpointCommandAdd, CommandObjectBreakpointCommandDelete, CommandObjectBreakpointCommandList, CommandObjectCommandsSource, CommandObjectCommandsAddRegex, CommandObjectCommandsScriptImport, CommandObjectCommandsScriptAdd, CommandObjectCommandsScriptList, CommandObjectCommandsScriptClear, CommandObjectCommandsScriptDelete, CommandObjectCommandsContainerAdd, CommandObjectCommandsContainerDelete, lldb_private::CommandObjectDisassemble, CommandObjectFrameDiagnose, CommandObjectFrameInfo, CommandObjectFrameSelect, CommandObjectFrameVariable, CommandObjectFrameRecognizerAdd, CommandObjectFrameRecognizerClear, CommandObjectWithFrameRecognizerArg, CommandObjectFrameRecognizerList, CommandObjectFrameRecognizerInfo, lldb_private::CommandObjectHelp, CommandObjectMemoryRead, CommandObjectMemoryFind, CommandObjectMemoryWrite, CommandObjectMemoryHistory, CommandObjectMemoryRegion, CommandObjectMemoryTagRead, CommandObjectMemoryTagWrite, CommandObjectPlatformProcessAttach, CommandObjectPluginLoad, CommandObjectProcessAttach, CommandObjectProcessContinue, CommandObjectProcessDetach, CommandObjectProcessConnect, CommandObjectProcessLoad, CommandObjectProcessUnload, CommandObjectProcessSignal, CommandObjectProcessInterrupt, CommandObjectProcessKill, CommandObjectProcessSaveCore, CommandObjectProcessStatus, CommandObjectProcessTraceStop, CommandObjectRegisterRead, CommandObjectRegisterWrite, CommandObjectRegisterInfo, CommandObjectScriptingExtensionList, CommandObjectSessionHistory, CommandObjectSettingsRead, CommandObjectSettingsClear, CommandObjectSourceInfo, CommandObjectSourceList, CommandObjectSourceCacheDump, CommandObjectSourceCacheClear, CommandObjectStatsEnable, CommandObjectStatsDisable, CommandObjectStatsDump, CommandObjectTargetCreate, CommandObjectTargetModulesSearchPathsAdd, CommandObjectTargetModulesSearchPathsClear, CommandObjectTargetModulesSearchPathsInsert, CommandObjectTargetModulesSearchPathsList, CommandObjectTargetModulesSearchPathsQuery, CommandObjectTargetModulesDumpObjfile, CommandObjectTargetModulesDumpSymtab, CommandObjectTargetModulesDumpSections, CommandObjectTargetModulesDumpClangPCMInfo, CommandObjectTargetModulesDumpClangAST, CommandObjectTargetModulesDumpSymfile, CommandObjectTargetModulesDumpLineTable, CommandObjectTargetModulesDumpSeparateDebugInfoFiles, CommandObjectTargetModulesList, CommandObjectTargetModulesShowUnwind, CommandObjectTargetModulesLookup, CommandObjectTargetStopHookAdd, CommandObjectTargetStopHookDelete, CommandObjectTargetStopHookEnableDisable, CommandObjectTargetStopHookList, CommandObjectTargetDumpTypesystem, CommandObjectTargetDumpSectionLoadList, CommandObjectThreadStepWithTypeAndScope, CommandObjectThreadContinue, CommandObjectThreadUntil, CommandObjectThreadSelect, CommandObjectThreadList, CommandObjectThreadPlanList, lldb_private::CommandObjectIterateOverThreads, lldb_private::CommandObjectMultipleThreads, CommandObjectTraceSave, CommandObjectTraceLoad, CommandObjectTraceDump, CommandObjectTraceSchema, CommandObjectTypeSummaryAdd, CommandObjectTypeSynthAdd, CommandObjectTypeFormatAdd, CommandObjectTypeFormatterDelete, CommandObjectTypeFormatterClear, CommandObjectTypeFormatterList< FormatterType >, CommandObjectTypeCategoryDefine, CommandObjectTypeCategoryEnable, CommandObjectTypeCategoryDelete, CommandObjectTypeCategoryDisable, CommandObjectTypeCategoryList, CommandObjectTypeFilterAdd, CommandObjectWatchpointList, CommandObjectWatchpointEnable, CommandObjectWatchpointDisable, CommandObjectWatchpointDelete, CommandObjectWatchpointIgnore, CommandObjectWatchpointModify, CommandObjectWatchpointSetVariable, CommandObjectWatchpointCommandAdd, CommandObjectWatchpointCommandDelete, CommandObjectWatchpointCommandList, CommandObjectMultiwordItaniumABI_Demangle, CommandObjectObjC_ClassTable_Dump, CommandObjectMultiwordObjC_TaggedPointer_Info, CommandObjectProcessGDBRemoteSpeedTest, CommandObjectProcessGDBRemotePacketHistory, CommandObjectProcessGDBRemotePacketXferSize, CommandObjectProcessGDBRemotePacketSend, CommandObjectProcessKDPPacketSend, CommandObjectProcessMinidumpDump, sddarwinlog_private::EnableCommand, sddarwinlog_private::StatusCommand, lldb_private::trace_intel_pt::CommandObjectProcessTraceStartIntelPT, CommandObjectProcessLaunch, and CommandObjectProcessHandle.

Referenced by Execute().

◆ Execute()

void CommandObjectParsed::Execute ( const char *  args_string,
CommandReturnObject &  result 
)
overridevirtual
Parameters
offset_in_commandis on what column args_string appears, if applicable. This enables diagnostics that refer back to the user input.

Implements lldb_private::CommandObject.

Definition at line 792 of file CommandObject.cpp.

References lldb_private::Args::AppendArguments(), lldb_private::CommandReturnObject::AppendErrorWithFormatv(), lldb_private::Args::ArgEntry::c_str(), lldb_private::CommandObject::CheckRequirements(), lldb_private::CommandObject::Cleanup(), DoExecute(), lldb_private::Args::entries(), error(), lldb_private::Args::GetArgumentCount(), lldb_private::CommandObject::GetCommandName(), lldb_private::Args::GetConstArgumentVector(), lldb_private::Args::ArgEntry::GetQuoteChar(), lldb_private::CommandObject::HasOverrideCallback(), lldb_private::CommandInterpreter::IncreaseCommandUsage(), lldb_private::CommandObject::InvokeOverrideCallback(), lldb_private::CommandObject::m_arguments, lldb_private::CommandObject::m_interpreter, lldb_private::CommandObject::ParseOptions(), lldb_private::CommandInterpreter::PreprocessToken(), lldb_private::Args::ArgEntry::ref(), and lldb_private::Args::ReplaceArgumentAtIndex().

◆ WantsRawCommandString()

bool lldb_private::CommandObjectParsed::WantsRawCommandString ( )
inlineoverrideprotectedvirtual

Implements lldb_private::CommandObject.

Definition at line 439 of file CommandObject.h.

The documentation for this class was generated from the following files:
Generated on Sun Aug 3 2025 04:27:03 for LLDB by doxygen 1.9.6