Inheritance diagram for CommandObjectTypeSummaryAdd:
Collaboration diagram for CommandObjectTypeSummaryAdd:
Classes | |
| class | CommandOptions |
Public Types | |
| enum | SummaryFormatType { eRegularSummary, eRegexSummary, eNamedSummary } |
 Public Types inherited from lldb_private::CommandObject | |
| typedef llvm::StringRef() | ArgumentHelpCallbackFunction() |
| typedef std::vector< CommandArgumentData > | CommandArgumentEntry |
| typedef std::map< std::string, lldb::CommandObjectSP > | CommandMap |
| Public Types inherited from lldb_private::IOHandlerDelegate | |
| enum | Completion { Completion::None, Completion::LLDBCommand, Completion::Expression } |
Public Member Functions | |
| CommandObjectTypeSummaryAdd (CommandInterpreter &interpreter) | |
| ~CommandObjectTypeSummaryAdd () override=default | |
| void | IOHandlerActivated (IOHandler &io_handler, bool interactive) override |
| void | IOHandlerInputComplete (IOHandler &io_handler, std::string &data) override |
| Called when a line or lines have been retrieved. More... | |
| 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 | |
| bool | 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 | WantsCompletion () |
| int | GetNumArgumentEntries () |
| CommandArgumentEntry * | GetArgumentEntryAtIndex (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) |
| Flags & | GetFlags () |
| The flags accessor. More... | |
| const Flags & | GetFlags () const |
| The flags const accessor. More... | |
| virtual llvm::Optional< std::string > | GetRepeatCommand (Args ¤t_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) |
| Public Member Functions inherited from lldb_private::IOHandlerDelegateMultiline | |
| IOHandlerDelegateMultiline (const char *end_line, Completion completion=Completion::None) | |
| ~IOHandlerDelegateMultiline () override=default | |
| ConstString | IOHandlerGetControlSequence (char ch) override |
| bool | IOHandlerIsInputComplete (IOHandler &io_handler, StringList &lines) override |
| Called to determine whether typing enter after the last line in lines should end input. More... | |
| Public Member Functions inherited from lldb_private::IOHandlerDelegate | |
| IOHandlerDelegate (Completion completion=Completion::None) | |
| virtual | ~IOHandlerDelegate ()=default |
| virtual void | IOHandlerDeactivated (IOHandler &io_handler) |
| virtual llvm::Optional< std::string > | IOHandlerSuggestion (IOHandler &io_handler, llvm::StringRef line) |
| virtual void | IOHandlerComplete (IOHandler &io_handler, CompletionRequest &request) |
| virtual const char * | IOHandlerGetFixIndentationCharacters () |
| virtual int | IOHandlerFixIndentation (IOHandler &io_handler, const StringList &lines, int cursor_position) |
| Called when a new line is created or one of an identified set of indentation characters is typed. More... | |
| virtual void | IOHandlerInputInterrupted (IOHandler &io_handler, std::string &data) |
| virtual const char * | IOHandlerGetCommandPrefix () |
| virtual const char * | IOHandlerGetHelpPrologue () |
| virtual bool | IOHandlerInterrupt (IOHandler &io_handler) |
Static Public Member Functions | |
| static bool | AddSummary (ConstString type_name, lldb::TypeSummaryImplSP entry, SummaryFormatType type, std::string category, Status *error=nullptr) |
| 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) |
Protected Member Functions | |
| bool | DoExecute (Args &command, CommandReturnObject &result) override |
| Protected Member Functions inherited from lldb_private::CommandObjectParsed | |
| 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 & | GetSelectedOrDummyTarget (bool prefer_dummy=false) |
| Target & | GetSelectedTarget () |
| Target & | GetDummyTarget () |
| Thread * | GetDefaultThread () |
| bool | CheckRequirements (CommandReturnObject &result) |
| Check the command to make sure anything required by this command is available. More... | |
| void | Cleanup () |
Private Member Functions | |
| Options * | GetOptions () override |
| bool | Execute_ScriptSummary (Args &command, CommandReturnObject &result) |
| bool | Execute_StringSummary (Args &command, CommandReturnObject &result) |
Private Attributes | |
| CommandOptions | m_options |
Additional Inherited Members | |
| 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 | |
| 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 |
| Flags | m_flags |
| std::vector< CommandArgumentEntry > | m_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 |
| Protected Attributes inherited from lldb_private::IOHandlerDelegateMultiline | |
| const std::string | m_end_line |
| Protected Attributes inherited from lldb_private::IOHandlerDelegate | |
| Completion | m_completion |
Detailed Description
Definition at line 102 of file CommandObjectType.cpp.
Member Enumeration Documentation
◆ SummaryFormatType
| Enumerator | |
|---|---|
| eRegularSummary | |
| eRegexSummary | |
| eNamedSummary | |
Definition at line 141 of file CommandObjectType.cpp.
Constructor & Destructor Documentation
◆ CommandObjectTypeSummaryAdd()
| CommandObjectTypeSummaryAdd::CommandObjectTypeSummaryAdd | ( | CommandInterpreter & | interpreter | ) |
Definition at line 1446 of file CommandObjectType.cpp.
References lldb_private::CommandObject::CommandArgumentData::arg_repetition, lldb_private::CommandObject::CommandArgumentData::arg_type, lldb_private::eArgRepeatPlus, lldb::eArgTypeName, lldb_private::CommandObject::m_arguments, and lldb_private::CommandObject::SetHelpLong().
◆ ~CommandObjectTypeSummaryAdd()
|
overridedefault |
Member Function Documentation
◆ AddSummary()
|
static |
Referenced by IOHandlerInputComplete().
◆ DoExecute()
|
overrideprotectedvirtual |
Implements lldb_private::CommandObjectParsed.
Definition at line 1491 of file CommandObjectType.cpp.
◆ Execute_ScriptSummary()
|
private |
◆ Execute_StringSummary()
|
private |
Definition at line 1374 of file CommandObjectType.cpp.
References lldb_private::formatters::AddSummary(), lldb_private::CommandReturnObject::AppendError(), lldb_private::CommandReturnObject::AppendErrorWithFormat(), lldb_private::Args::entries(), lldb::eReturnStatusSuccessFinishNoResult, error(), lldb_private::Args::GetArgumentCount(), lldb_private::CommandReturnObject::SetStatus(), and lldb_private::CommandReturnObject::Succeeded().
◆ GetOptions()
|
inlineoverrideprivatevirtual |
Reimplemented from lldb_private::CommandObject.
Definition at line 134 of file CommandObjectType.cpp.
◆ IOHandlerActivated()
|
inlineoverridevirtual |
Reimplemented from lldb_private::IOHandlerDelegate.
Definition at line 147 of file CommandObjectType.cpp.
References lldb_private::IOHandler::GetOutputStreamFileSP().
◆ IOHandlerInputComplete()
|
inlineoverridevirtual |
Called when a line or lines have been retrieved.
This function can handle the current line and possibly call IOHandler::SetIsDone(true) when the IO handler is done like when "quit" is entered as a command, of when an empty line is received. It is up to the delegate to determine when a line should cause a IOHandler to exit.
Implements lldb_private::IOHandlerDelegate.
Definition at line 162 of file CommandObjectType.cpp.
References AddSummary(), lldb_private::StringList::CopyList(), eNamedSummary, eRegexSummary, eRegularSummary, error(), lldb_private::ScriptInterpreter::GenerateTypeScriptFunction(), lldb_private::IOHandler::GetErrorStreamFileSP(), lldb_private::StringList::GetSize(), lldb_private::IOHandler::GetUserData(), lldb_private::IOHandler::SetIsDone(), lldb_private::StringList::SplitIntoLines(), and string().
Member Data Documentation
◆ m_options
|
private |
Definition at line 132 of file CommandObjectType.cpp.
The documentation for this class was generated from the following file:
