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

#include <CommandObjectHelp.h>

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

Classes

class  CommandOptions
 

Public Member Functions

 CommandObjectHelp (CommandInterpreter &interpreter)
 
 ~CommandObjectHelp () override
 
void HandleCompletion (CompletionRequest &request) override
 This default version handles calling option argument completions and then calls HandleArgumentCompletion if the cursor is on an argument, not an option.
 
OptionsGetOptions () override
 
- Public Member Functions inherited from lldb_private::CommandObjectParsed
 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
 
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 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)
 
FlagsGetFlags ()
 The flags accessor.
 
const FlagsGetFlags () 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)
 
virtual void Execute (const char *args_string, CommandReturnObject &result)=0
 

Static Public Member Functions

static void GenerateAdditionalHelpAvenuesMessage (Stream *s, llvm::StringRef command, llvm::StringRef prefix, llvm::StringRef subcommand, bool include_upropos=true, bool include_type_lookup=true)
 
- 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 ArgumentTableEntryFindArgumentDataByType (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< ArgumentRepetitionTypeArgRepetitionFromString (llvm::StringRef string)
 

Protected Member Functions

void DoExecute (Args &command, CommandReturnObject &result) override
 
- Protected Member Functions inherited from lldb_private::CommandObjectParsed
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 ()
 
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.
 
void Cleanup ()
 

Private Attributes

CommandOptions m_options
 

Additional Inherited Members

- Public Types inherited from lldb_private::CommandObject
typedef llvm::StringRef() ArgumentHelpCallbackFunction()
 
typedef std::vector< CommandArgumentDataCommandArgumentEntry
 
typedef std::map< std::string, lldb::CommandObjectSPCommandMap
 
- Static Protected Member Functions inherited from lldb_private::CommandObject
static void AddIDsArgumentData (CommandArgumentEntry &arg, lldb::CommandArgumentType ID, lldb::CommandArgumentType IDRange)
 
- Protected Attributes inherited from lldb_private::CommandObject
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_private::CommandOverrideCallbackWithResult m_command_override_callback
 
void * m_command_override_baton
 
bool m_is_user_command = false
 

Detailed Description

Definition at line 20 of file CommandObjectHelp.h.

Constructor & Destructor Documentation

◆ CommandObjectHelp()

CommandObjectHelp::CommandObjectHelp ( CommandInterpreter interpreter)

◆ ~CommandObjectHelp()

CommandObjectHelp::~CommandObjectHelp ( )
overridedefault

Member Function Documentation

◆ DoExecute()

void CommandObjectHelp::DoExecute ( Args command,
CommandReturnObject result 
)
overrideprotectedvirtual

Implements lldb_private::CommandObjectParsed.

Definition at line 77 of file CommandObjectHelp.cpp.

References lldb_private::CommandReturnObject::AppendError(), lldb_private::StringList::Clear(), lldb::eArgTypeLastArg, lldb_private::CommandInterpreter::eCommandTypesAliases, lldb_private::CommandInterpreter::eCommandTypesBuiltin, lldb_private::CommandInterpreter::eCommandTypesHidden, lldb_private::CommandInterpreter::eCommandTypesUserDef, lldb_private::CommandInterpreter::eCommandTypesUserMW, lldb_private::Args::entries(), lldb::eReturnStatusSuccessFinishNoResult, GenerateAdditionalHelpAvenuesMessage(), lldb_private::CommandObject::GenerateHelpText(), lldb_private::CommandInterpreter::GetAlias(), lldb_private::CommandAlias::GetAliasExpansion(), lldb_private::CommandInterpreter::GetAliasFullName(), lldb_private::Args::GetArgumentCount(), lldb_private::CommandObject::GetArgumentHelp(), lldb_private::CommandObject::GetCommandName(), lldb_private::CommandInterpreter::GetCommandObject(), lldb_private::CommandInterpreter::GetCommandPrefix(), lldb_private::Args::GetCommandString(), lldb_private::StreamString::GetData(), lldb_private::CommandInterpreter::GetHelp(), lldb_private::CommandReturnObject::GetOutputStream(), lldb_private::StringList::GetSize(), lldb_private::StreamString::GetString(), lldb_private::StringList::GetStringAtIndex(), lldb_private::CommandObject::GetSubcommandObject(), lldb_private::CommandObject::IsAlias(), lldb_private::CommandObject::IsMultiwordObject(), lldb_private::CommandObject::LookupArgumentName(), lldb_private::CommandObject::m_interpreter, m_options, lldb_private::CommandObjectHelp::CommandOptions::m_show_aliases, lldb_private::CommandObjectHelp::CommandOptions::m_show_hidden, lldb_private::CommandObjectHelp::CommandOptions::m_show_user_defined, lldb_private::Stream::Printf(), and lldb_private::CommandReturnObject::SetStatus().

◆ GenerateAdditionalHelpAvenuesMessage()

void CommandObjectHelp::GenerateAdditionalHelpAvenuesMessage ( Stream s,
llvm::StringRef  command,
llvm::StringRef  prefix,
llvm::StringRef  subcommand,
bool  include_upropos = true,
bool  include_type_lookup = true 
)
static

◆ GetOptions()

Options * lldb_private::CommandObjectHelp::GetOptions ( )
inlineoverridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 76 of file CommandObjectHelp.h.

References m_options.

◆ HandleCompletion()

void CommandObjectHelp::HandleCompletion ( CompletionRequest request)
overridevirtual

This default version handles calling option argument completions and then calls HandleArgumentCompletion if the cursor is on an argument, not an option.

Don't override this method, override HandleArgumentCompletion instead unless you have special reasons.

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

Reimplemented from lldb_private::CommandObject.

Definition at line 202 of file CommandObjectHelp.cpp.

References lldb_private::CommandInterpreter::GetCommandObject(), lldb_private::CompletionRequest::GetCursorIndex(), lldb_private::CompletionRequest::GetParsedLine(), lldb_private::CommandObject::HandleCompletion(), lldb_private::CommandInterpreter::HandleCompletionMatches(), lldb_private::CommandObject::m_interpreter, and lldb_private::CompletionRequest::ShiftArguments().

Member Data Documentation

◆ m_options

CommandOptions lldb_private::CommandObjectHelp::m_options
private

Definition at line 82 of file CommandObjectHelp.h.

Referenced by DoExecute(), and GetOptions().


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