CommandObjectPlatformFOpen Class Reference

Inheritance diagram for CommandObjectPlatformFOpen:

Public Member Functions
	CommandObjectPlatformFOpen (CommandInterpreter &interpreter)
	~CommandObjectPlatformFOpen () override=default
void	DoExecute (Args &args, CommandReturnObject &result) override
Options *	GetOptions () 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
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)
virtual void	Execute (const char *args_string, CommandReturnObject &result)=0

Public Attributes
OptionPermissions	m_option_permissions
OptionGroupOptions	m_options

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 >	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 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 ()
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 ()
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_private::CommandOverrideCallbackWithResult	m_command_override_callback
void *	m_command_override_baton
bool	m_is_user_command = false

Detailed Description

Definition at line 462 of file CommandObjectPlatform.cpp.

Constructor & Destructor Documentation

CommandObjectPlatformFOpen()

CommandObjectPlatformFOpen::CommandObjectPlatformFOpen ( CommandInterpreter &  interpreter )

inline

Definition at line 464 of file CommandObjectPlatform.cpp.

References lldb_private::CommandObject::AddSimpleArgumentList(), and lldb::eArgTypeRemotePath.

~CommandObjectPlatformFOpen()

CommandObjectPlatformFOpen::~CommandObjectPlatformFOpen ( )

overridedefault

Member Function Documentation

DoExecute()

void CommandObjectPlatformFOpen::DoExecute ( Args &  args, CommandReturnObject &  result  )

inlineoverridevirtual

Implements lldb_private::CommandObjectParsed.

Definition at line 472 of file CommandObjectPlatform.cpp.

References lldb_private::CommandReturnObject::AppendError(), lldb_private::CommandReturnObject::AppendMessageWithFormat(), lldb_private::File::eOpenOptionCanCreate, lldb_private::File::eOpenOptionReadWrite, lldb::eReturnStatusSuccessFinishResult, error(), lldb_private::Args::GetCommandString(), lldb_private::CommandObject::GetDebugger(), lldb_private::OptionGroupOptions::GetGroupWithOption(), m_options, OptionPermissions::m_permissions, and lldb_private::CommandReturnObject::SetStatus().

GetOptions()

Options * CommandObjectPlatformFOpen::GetOptions ( )

inlineoverridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 502 of file CommandObjectPlatform.cpp.

References lldb_private::OptionGroupOptions::Append(), lldb_private::OptionGroupOptions::DidFinalize(), lldb_private::OptionGroupOptions::Finalize(), m_option_permissions, and m_options.

Member Data Documentation

m_option_permissions

OptionPermissions CommandObjectPlatformFOpen::m_option_permissions

Definition at line 510 of file CommandObjectPlatform.cpp.

Referenced by GetOptions().

m_options

OptionGroupOptions CommandObjectPlatformFOpen::m_options

Definition at line 511 of file CommandObjectPlatform.cpp.

Referenced by DoExecute(), and GetOptions().

---

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

• CommandObjectPlatform.cpp