#include <CommandInterpreter.h>

Inheritance diagram for lldb_private::CommandInterpreter:

[legend]

Collaboration diagram for lldb_private::CommandInterpreter:

[legend]

Public Types
enum	{ eBroadcastBitThreadShouldExit = (1 << 0), eBroadcastBitResetPrompt = (1 << 1), eBroadcastBitQuitCommandReceived = (1 << 2), eBroadcastBitAsynchronousOutputData = (1 << 3), eBroadcastBitAsynchronousErrorData = (1 << 4) }

enum	ChildrenOmissionWarningStatus { eNoOmission = 0, eUnwarnedOmission = 1, eWarnedOmission = 2 }
	Tristate boolean to manage children omission warnings. More...

enum	CommandTypes { eCommandTypesBuiltin = 0x0001, eCommandTypesUserDef = 0x0002, eCommandTypesUserMW = 0x0004, eCommandTypesAliases = 0x0008, eCommandTypesHidden = 0x0010, eCommandTypesAllThem = 0xFFFF }

Public Types inherited from lldb_private::IOHandlerDelegate
enum	Completion { Completion::None, Completion::LLDBCommand, Completion::Expression }

Public Member Functions
	CommandInterpreter (Debugger &debugger, bool synchronous_execution)

	~CommandInterpreter () override=default

ConstString &	GetBroadcasterClass () const override
	This needs to be filled in if you are going to register the broadcaster with the broadcaster manager and do broadcaster class matching. More...

void	SourceInitFileCwd (CommandReturnObject &result)

void	SourceInitFileHome (CommandReturnObject &result, bool is_repl)

void	SourceInitFileGlobal (CommandReturnObject &result)

bool	AddCommand (llvm::StringRef name, const lldb::CommandObjectSP &cmd_sp, bool can_replace)

Status	AddUserCommand (llvm::StringRef name, const lldb::CommandObjectSP &cmd_sp, bool can_replace)

lldb::CommandObjectSP	GetCommandSPExact (llvm::StringRef cmd, bool include_aliases=false) const

CommandObject *	GetCommandObject (llvm::StringRef cmd, StringList matches=nullptr, StringList descriptions=nullptr) const

CommandObject *	GetUserCommandObject (llvm::StringRef cmd, StringList matches=nullptr, StringList descriptions=nullptr) const

bool	CommandExists (llvm::StringRef cmd) const
	Determine whether a root level, built-in command with this name exists. More...

bool	AliasExists (llvm::StringRef cmd) const
	Determine whether an alias command with this name exists. More...

bool	UserCommandExists (llvm::StringRef cmd) const
	Determine whether a root-level user command with this name exists. More...

bool	UserMultiwordCommandExists (llvm::StringRef cmd) const
	Determine whether a root-level user multiword command with this name exists. More...

CommandObjectMultiword *	VerifyUserMultiwordCmdPath (Args &path, bool leaf_is_command, Status &result)
	Look up the command pointed to by path encoded in the arguments of the incoming command object. More...

CommandAlias *	AddAlias (llvm::StringRef alias_name, lldb::CommandObjectSP &command_obj_sp, llvm::StringRef args_string=llvm::StringRef())

bool	RemoveCommand (llvm::StringRef cmd)

bool	RemoveAlias (llvm::StringRef alias_name)

bool	GetAliasFullName (llvm::StringRef cmd, std::string &full_name) const

bool	RemoveUserMultiword (llvm::StringRef multiword_name)

void	RemoveAllUserMultiword ()

bool	RemoveUser (llvm::StringRef alias_name)

void	RemoveAllUser ()

const CommandAlias *	GetAlias (llvm::StringRef alias_name) const

CommandObject *	BuildAliasResult (llvm::StringRef alias_name, std::string &raw_input_string, std::string &alias_result, CommandReturnObject &result)

bool	HandleCommand (const char *command_line, LazyBool add_to_history, const ExecutionContext &override_context, CommandReturnObject &result)

bool	HandleCommand (const char *command_line, LazyBool add_to_history, CommandReturnObject &result)

bool	WasInterrupted () const

void	HandleCommands (const StringList &commands, const ExecutionContext &context, const CommandInterpreterRunOptions &options, CommandReturnObject &result)
	Execute a list of commands in sequence. More...

void	HandleCommands (const StringList &commands, const CommandInterpreterRunOptions &options, CommandReturnObject &result)

void	HandleCommandsFromFile (FileSpec &file, const ExecutionContext &context, const CommandInterpreterRunOptions &options, CommandReturnObject &result)
	Execute a list of commands from a file. More...

void	HandleCommandsFromFile (FileSpec &file, const CommandInterpreterRunOptions &options, CommandReturnObject &result)

CommandObject *	GetCommandObjectForCommand (llvm::StringRef &command_line)

std::optional< std::string >	GetAutoSuggestionForCommand (llvm::StringRef line)
	Returns the auto-suggestion string that should be added to the given command line. More...

void	HandleCompletion (CompletionRequest &request)

void	HandleCompletionMatches (CompletionRequest &request)

int	GetCommandNamesMatchingPartialString (const char *cmd_cstr, bool include_aliases, StringList &matches, StringList &descriptions)

void	GetHelp (CommandReturnObject &result, uint32_t types=eCommandTypesAllThem)

void	GetAliasHelp (const char *alias_name, StreamString &help_string)

void	OutputFormattedHelpText (Stream &strm, llvm::StringRef prefix, llvm::StringRef help_text)

void	OutputFormattedHelpText (Stream &stream, llvm::StringRef command_word, llvm::StringRef separator, llvm::StringRef help_text, size_t max_word_len)

void	OutputHelpText (Stream &stream, llvm::StringRef command_word, llvm::StringRef separator, llvm::StringRef help_text, uint32_t max_word_len)

Debugger &	GetDebugger ()

ExecutionContext	GetExecutionContext () const

lldb::PlatformSP	GetPlatform (bool prefer_target_platform)

const char *	ProcessEmbeddedScriptCommands (const char *arg)

void	UpdatePrompt (llvm::StringRef prompt)

bool	Confirm (llvm::StringRef message, bool default_answer)

void	LoadCommandDictionary ()

void	Initialize ()

void	Clear ()

bool	HasCommands () const

bool	HasAliases () const

bool	HasUserCommands () const

bool	HasUserMultiwordCommands () const

bool	HasAliasOptions () const

void	BuildAliasCommandArgs (CommandObject alias_cmd_obj, const char alias_name, Args &cmd_args, std::string &raw_input_string, CommandReturnObject &result)

int	GetOptionArgumentPosition (const char *in_string)
	Picks the number out of a string of the form "%NNN", otherwise return 0. More...

void	SkipLLDBInitFiles (bool skip_lldbinit_files)

void	SkipAppInitFiles (bool skip_app_init_files)

bool	GetSynchronous ()

void	FindCommandsForApropos (llvm::StringRef word, StringList &commands_found, StringList &commands_help, bool search_builtin_commands, bool search_user_commands, bool search_alias_commands, bool search_user_mw_commands)

bool	GetBatchCommandMode ()

bool	SetBatchCommandMode (bool value)

void	ChildrenTruncated ()

void	SetReachedMaximumDepth ()

void	PrintWarningsIfNecessary (Stream &s, const std::string &cmd_name)

CommandHistory &	GetCommandHistory ()

bool	IsActive ()

CommandInterpreterRunResult	RunCommandInterpreter (CommandInterpreterRunOptions &options)

void	GetLLDBCommandsFromIOHandler (const char prompt, IOHandlerDelegate &delegate, void baton=nullptr)

void	GetPythonCommandsFromIOHandler (const char prompt, IOHandlerDelegate &delegate, void baton=nullptr)

const char *	GetCommandPrefix ()

bool	GetExpandRegexAliases () const

bool	GetPromptOnQuit () const

void	SetPromptOnQuit (bool enable)

bool	GetSaveSessionOnQuit () const

void	SetSaveSessionOnQuit (bool enable)

bool	GetOpenTranscriptInEditor () const

void	SetOpenTranscriptInEditor (bool enable)

FileSpec	GetSaveSessionDirectory () const

void	SetSaveSessionDirectory (llvm::StringRef path)

bool	GetEchoCommands () const

void	SetEchoCommands (bool enable)

bool	GetEchoCommentCommands () const

void	SetEchoCommentCommands (bool enable)

bool	GetRepeatPreviousCommand () const

bool	GetRequireCommandOverwrite () const

const CommandObject::CommandMap &	GetUserCommands () const

const CommandObject::CommandMap &	GetUserMultiwordCommands () const

const CommandObject::CommandMap &	GetCommands () const

const CommandObject::CommandMap &	GetAliases () const

void	AllowExitCodeOnQuit (bool allow)
	Specify if the command interpreter should allow that the user can specify a custom exit code when calling 'quit'. More...

bool	SetQuitExitCode (int exit_code)
	Sets the exit code for the quit command. More...

int	GetQuitExitCode (bool &exited) const
	Returns the exit code that the user has specified when running the 'quit' command. More...

void	ResolveCommand (const char *command_line, CommandReturnObject &result)

bool	GetStopCmdSourceOnError () const

lldb::IOHandlerSP	GetIOHandler (bool force_create=false, CommandInterpreterRunOptions *options=nullptr)

bool	GetSpaceReplPrompts () const

bool	SaveTranscript (CommandReturnObject &result, std::optional< std::string > output_file=std::nullopt)
	Save the current debugger session transcript to a file on disk. More...

FileSpec	GetCurrentSourceDir ()

bool	IsInteractive ()

bool	IOHandlerInterrupt (IOHandler &io_handler) override

Public Member Functions inherited from lldb_private::Broadcaster
	Broadcaster (lldb::BroadcasterManagerSP manager_sp, const char *name)
	Construct with a broadcaster with a name. More...

virtual	~Broadcaster ()
	Destructor. More...

void	CheckInWithManager ()

void	BroadcastEvent (lldb::EventSP &event_sp)
	Broadcast an event which has no associated data. More...

void	BroadcastEventIfUnique (lldb::EventSP &event_sp)

void	BroadcastEvent (uint32_t event_type, const lldb::EventDataSP &event_data_sp)

void	BroadcastEvent (uint32_t event_type, EventData *event_data=nullptr)

void	BroadcastEventIfUnique (uint32_t event_type, EventData *event_data=nullptr)

void	Clear ()

virtual void	AddInitialEventsToListener (const lldb::ListenerSP &listener_sp, uint32_t requested_events)

uint32_t	AddListener (const lldb::ListenerSP &listener_sp, uint32_t event_mask)
	Listen for any events specified by event_mask. More...

ConstString	GetBroadcasterName ()
	Get the NULL terminated C string name of this Broadcaster object. More...

bool	GetEventNames (Stream &s, const uint32_t event_mask, bool prefix_with_broadcaster_name) const
	Get the event name(s) for one or more event bits. More...

void	SetEventName (uint32_t event_mask, const char *name)
	Set the name for an event bit. More...

const char *	GetEventName (uint32_t event_mask) const

bool	EventTypeHasListeners (uint32_t event_type)

bool	RemoveListener (const lldb::ListenerSP &listener_sp, uint32_t event_mask=UINT32_MAX)
	Removes a Listener from this broadcasters list and frees the event bits specified by event_mask that were previously acquired by listener (assuming listener was listening to this object) for other listener objects to use. More...

bool	HijackBroadcaster (const lldb::ListenerSP &listener_sp, uint32_t event_mask=UINT32_MAX)
	Provides a simple mechanism to temporarily redirect events from broadcaster. More...

bool	IsHijackedForEvent (uint32_t event_mask)

void	RestoreBroadcaster ()
	Restore the state of the Broadcaster from a previous hijack attempt. More...

lldb::BroadcasterManagerSP	GetManager ()

Public Member Functions inherited from lldb_private::Properties
	Properties ()=default

	Properties (const lldb::OptionValuePropertiesSP &collection_sp)

virtual	~Properties ()=default

virtual lldb::OptionValuePropertiesSP	GetValueProperties () const

virtual lldb::OptionValueSP	GetPropertyValue (const ExecutionContext *exe_ctx, llvm::StringRef property_path, bool will_modify, Status &error) const

virtual Status	SetPropertyValue (const ExecutionContext *exe_ctx, VarSetOperationType op, llvm::StringRef property_path, llvm::StringRef value)

virtual Status	DumpPropertyValue (const ExecutionContext *exe_ctx, Stream &strm, llvm::StringRef property_path, uint32_t dump_mask, bool is_json=false)

virtual void	DumpAllPropertyValues (const ExecutionContext *exe_ctx, Stream &strm, uint32_t dump_mask, bool is_json=false)

virtual void	DumpAllDescriptions (CommandInterpreter &interpreter, Stream &strm) const

size_t	Apropos (llvm::StringRef keyword, std::vector< const Property * > &matching_properties) const

lldb::OptionValuePropertiesSP	GetSubProperty (const ExecutionContext *exe_ctx, ConstString name)

Public Member Functions inherited from lldb_private::IOHandlerDelegate
	IOHandlerDelegate (Completion completion=Completion::None)

virtual	~IOHandlerDelegate ()=default

virtual void	IOHandlerActivated (IOHandler &io_handler, bool interactive)

virtual void	IOHandlerDeactivated (IOHandler &io_handler)

virtual std::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 bool	IOHandlerIsInputComplete (IOHandler &io_handler, StringList &lines)
	Called to determine whether typing enter after the last line in lines should end input. More...

virtual const char *	IOHandlerGetCommandPrefix ()

virtual const char *	IOHandlerGetHelpPrologue ()

Static Public Member Functions
static ConstString &	GetStaticBroadcasterClass ()

Static Public Member Functions inherited from lldb_private::Properties
static const char *	GetExperimentalSettingsName ()

static bool	IsSettingExperimental (llvm::StringRef setting)

Static Public Attributes
static const char *	g_no_argument = "<no-argument>"

static const char *	g_need_argument = "<need-argument>"

static const char *	g_argument = "<argument>"

Protected Member Functions
void	IOHandlerInputComplete (IOHandler &io_handler, std::string &line) override
	Called when a line or lines have been retrieved. More...

ConstString	IOHandlerGetControlSequence (char ch) override

void	GetProcessOutput ()

bool	DidProcessStopAbnormally () const

void	SetSynchronous (bool value)

lldb::CommandObjectSP	GetCommandSP (llvm::StringRef cmd, bool include_aliases=true, bool exact=true, StringList matches=nullptr, StringList descriptions=nullptr) const

Protected Member Functions inherited from lldb_private::Broadcaster
BroadcasterImplSP	GetBroadcasterImpl ()

const char *	GetHijackingListenerName ()

Private Types
enum	CommandHandlingState { CommandHandlingState::eIdle, CommandHandlingState::eInProgress, CommandHandlingState::eInterrupted }

Private Member Functions
void	OverrideExecutionContext (const ExecutionContext &override_context)

void	RestoreExecutionContext ()

Status	PreprocessCommand (std::string &command)

void	SourceInitFile (FileSpec file, CommandReturnObject &result)

CommandObject *	ResolveCommandImpl (std::string &command_line, CommandReturnObject &result)

void	FindCommandsForApropos (llvm::StringRef word, StringList &commands_found, StringList &commands_help, const CommandObject::CommandMap &command_map)

void	PrintCommandOutput (IOHandler &io_handler, llvm::StringRef str, bool is_stdout)

bool	EchoCommandNonInteractive (llvm::StringRef line, const Flags &io_handler_flags) const

void	StartHandlingCommand ()

void	FinishHandlingCommand ()

bool	InterruptCommand ()

Private Attributes
std::atomic< CommandHandlingState >	m_command_state

int	m_iohandler_nesting_level = 0

Debugger &	m_debugger

std::stack< ExecutionContext >	m_overriden_exe_contexts

bool	m_synchronous_execution

bool	m_skip_lldbinit_files

bool	m_skip_app_init_files

CommandObject::CommandMap	m_command_dict

CommandObject::CommandMap	m_alias_dict

CommandObject::CommandMap	m_user_dict

CommandObject::CommandMap	m_user_mw_dict

CommandHistory	m_command_history

std::string	m_repeat_command

lldb::IOHandlerSP	m_command_io_handler_sp

char	m_comment_char

bool	m_batch_command_mode

ChildrenOmissionWarningStatus	m_truncation_warning
	Whether we truncated a value's list of children and whether the user has been told. More...

ChildrenOmissionWarningStatus	m_max_depth_warning
	Whether we reached the maximum child nesting depth and whether the user has been told. More...

uint32_t	m_command_source_depth

std::vector< FileSpec >	m_command_source_dirs
	A stack of directory paths. More...

std::vector< uint32_t >	m_command_source_flags

CommandInterpreterRunResult	m_result

std::optional< int >	m_quit_exit_code

bool	m_allow_exit_code = false

StreamString	m_transcript_stream

Friends
class	Debugger

Additional Inherited Members
Protected Types inherited from lldb_private::Broadcaster
typedef std::shared_ptr< BroadcasterImpl >	BroadcasterImplSP

typedef std::weak_ptr< BroadcasterImpl >	BroadcasterImplWP

Protected Attributes inherited from lldb_private::Properties
lldb::OptionValuePropertiesSP	m_collection_sp

Protected Attributes inherited from lldb_private::IOHandlerDelegate
Completion	m_completion

Detailed Description

Definition at line 215 of file CommandInterpreter.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
eBroadcastBitThreadShouldExit
eBroadcastBitResetPrompt
eBroadcastBitQuitCommandReceived
eBroadcastBitAsynchronousOutputData
eBroadcastBitAsynchronousErrorData

Definition at line 219 of file CommandInterpreter.h.

◆ ChildrenOmissionWarningStatus

enum lldb_private::CommandInterpreter::ChildrenOmissionWarningStatus

Tristate boolean to manage children omission warnings.

Enumerator
eNoOmission	No children were omitted.
eUnwarnedOmission	Children omitted, and not yet notified.
eWarnedOmission	Children omitted and notified.

Definition at line 228 of file CommandInterpreter.h.

◆ CommandHandlingState

enum lldb_private::CommandInterpreter::CommandHandlingState

strongprivate

Enumerator
eIdle
eInProgress
eInterrupted

Definition at line 691 of file CommandInterpreter.h.

◆ CommandTypes

enum lldb_private::CommandInterpreter::CommandTypes

Enumerator
eCommandTypesBuiltin
eCommandTypesUserDef
eCommandTypesUserMW
eCommandTypesAliases
eCommandTypesHidden
eCommandTypesAllThem

Definition at line 234 of file CommandInterpreter.h.

Constructor & Destructor Documentation

◆ CommandInterpreter()

CommandInterpreter::CommandInterpreter	(	Debugger &	debugger,
		bool	synchronous_execution
	)

Definition at line 127 of file CommandInterpreter.cpp.

References lldb_private::Broadcaster::CheckInWithManager(), eBroadcastBitQuitCommandReceived, eBroadcastBitResetPrompt, eBroadcastBitThreadShouldExit, lldb_private::Properties::m_collection_sp, lldb_private::Broadcaster::SetEventName(), and SetSynchronous().

◆ ~CommandInterpreter()

lldb_private::CommandInterpreter::~CommandInterpreter ( )

overridedefault

Member Function Documentation

◆ AddAlias()

CommandAlias* lldb_private::CommandInterpreter::AddAlias	(	llvm::StringRef	alias_name,
		lldb::CommandObjectSP &	command_obj_sp,
		llvm::StringRef	args_string = `llvm::StringRef()`
	)

Referenced by Initialize().

◆ AddCommand()

bool lldb_private::CommandInterpreter::AddCommand	(	llvm::StringRef	name,
		const lldb::CommandObjectSP &	cmd_sp,
		bool	can_replace
	)

◆ AddUserCommand()

Status lldb_private::CommandInterpreter::AddUserCommand	(	llvm::StringRef	name,
		const lldb::CommandObjectSP &	cmd_sp,
		bool	can_replace
	)

Referenced by lldb::SBCommandInterpreter::AddCommand(), and lldb::SBCommandInterpreter::AddMultiwordCommand().

◆ AliasExists()

bool lldb_private::CommandInterpreter::AliasExists ( llvm::StringRef cmd ) const

Determine whether an alias command with this name exists.

Referenced by lldb::SBCommandInterpreter::AliasExists().

◆ AllowExitCodeOnQuit()

void CommandInterpreter::AllowExitCodeOnQuit ( bool allow )

Specify if the command interpreter should allow that the user can specify a custom exit code when calling 'quit'.

Definition at line 218 of file CommandInterpreter.cpp.

References m_allow_exit_code, and m_quit_exit_code.

Referenced by lldb::SBCommandInterpreter::AllowExitCodeOnQuit().

◆ BuildAliasCommandArgs()

void lldb_private::CommandInterpreter::BuildAliasCommandArgs	(	CommandObject *	alias_cmd_obj,
		const char *	alias_name,
		Args &	cmd_args,
		std::string &	raw_input_string,
		CommandReturnObject &	result
	)

◆ BuildAliasResult()

CommandObject* lldb_private::CommandInterpreter::BuildAliasResult	(	llvm::StringRef	alias_name,
		std::string &	raw_input_string,
		std::string &	alias_result,
		CommandReturnObject &	result
	)

◆ ChildrenTruncated()

void lldb_private::CommandInterpreter::ChildrenTruncated ( )

inline

Definition at line 507 of file CommandInterpreter.h.

References eNoOmission, eUnwarnedOmission, and m_truncation_warning.

◆ Clear()

void CommandInterpreter::Clear ( )

Definition at line 509 of file CommandInterpreter.cpp.

References m_command_io_handler_sp.

◆ CommandExists()

bool lldb_private::CommandInterpreter::CommandExists ( llvm::StringRef cmd ) const

Determine whether a root level, built-in command with this name exists.

Referenced by lldb::SBCommandInterpreter::CommandExists().

◆ Confirm()

bool lldb_private::CommandInterpreter::Confirm	(	llvm::StringRef	message,
		bool	default_answer
	)

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

◆ DidProcessStopAbnormally()

bool lldb_private::CommandInterpreter::DidProcessStopAbnormally ( ) const

protected

◆ EchoCommandNonInteractive()

bool lldb_private::CommandInterpreter::EchoCommandNonInteractive	(	llvm::StringRef	line,
		const Flags &	io_handler_flags
	)		const

private

◆ FindCommandsForApropos() [1/2]

void lldb_private::CommandInterpreter::FindCommandsForApropos	(	llvm::StringRef	word,
		StringList &	commands_found,
		StringList &	commands_help,
		bool	search_builtin_commands,
		bool	search_user_commands,
		bool	search_alias_commands,
		bool	search_user_mw_commands
	)

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

◆ FindCommandsForApropos() [2/2]

void lldb_private::CommandInterpreter::FindCommandsForApropos	(	llvm::StringRef	word,
		StringList &	commands_found,
		StringList &	commands_help,
		const CommandObject::CommandMap &	command_map
	)

private

◆ FinishHandlingCommand()

void lldb_private::CommandInterpreter::FinishHandlingCommand ( )

private

◆ GetAlias()

const CommandAlias* lldb_private::CommandInterpreter::GetAlias ( llvm::StringRef alias_name ) const

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

◆ GetAliases()

const CommandObject::CommandMap& lldb_private::CommandInterpreter::GetAliases ( ) const

inline

Definition at line 591 of file CommandInterpreter.h.

References m_alias_dict.

◆ GetAliasFullName()

bool lldb_private::CommandInterpreter::GetAliasFullName	(	llvm::StringRef	cmd,
		std::string &	full_name
	)		const

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

◆ GetAliasHelp()

void lldb_private::CommandInterpreter::GetAliasHelp	(	const char *	alias_name,
		StreamString &	help_string
	)

◆ GetAutoSuggestionForCommand()

std::optional<std::string> lldb_private::CommandInterpreter::GetAutoSuggestionForCommand ( llvm::StringRef line )

Returns the auto-suggestion string that should be added to the given command line.

Referenced by lldb_private::IOHandlerDelegate::IOHandlerSuggestion().

◆ GetBatchCommandMode()

bool lldb_private::CommandInterpreter::GetBatchCommandMode ( )

inline

Definition at line 499 of file CommandInterpreter.h.

References m_batch_command_mode.

◆ GetBroadcasterClass()

ConstString& lldb_private::CommandInterpreter::GetBroadcasterClass ( ) const

inlineoverridevirtual

This needs to be filled in if you are going to register the broadcaster with the broadcaster manager and do broadcaster class matching.

FIXME: Probably should make a ManagedBroadcaster subclass with all the bits needed to work with the BroadcasterManager, so that it is clearer how to add one.

Reimplemented from lldb_private::Broadcaster.

Definition at line 259 of file CommandInterpreter.h.

References GetStaticBroadcasterClass().

◆ GetCommandHistory()

CommandHistory& lldb_private::CommandInterpreter::GetCommandHistory ( )

inline

Definition at line 537 of file CommandInterpreter.h.

References m_command_history.

◆ GetCommandNamesMatchingPartialString()

int lldb_private::CommandInterpreter::GetCommandNamesMatchingPartialString	(	const char *	cmd_cstr,
		bool	include_aliases,
		StringList &	matches,
		StringList &	descriptions
	)

◆ GetCommandObject()

CommandObject* lldb_private::CommandInterpreter::GetCommandObject	(	llvm::StringRef	cmd,
		StringList *	matches = `nullptr`,
		StringList *	descriptions = `nullptr`
	)		const

Referenced by lldb_private::CommandObjectHelp::DoExecute(), lldb_private::CommandObjectHelp::HandleCompletion(), and lldb_private::StructuredDataPlugin::InitializeBasePluginForDebugger().

◆ GetCommandObjectForCommand()

CommandObject* lldb_private::CommandInterpreter::GetCommandObjectForCommand ( llvm::StringRef & command_line )

Referenced by lldb_private::StructuredDataDarwinLog::DebuggerInitialize(), lldb_private::REPL::RunLoop(), and lldb::SBCommandInterpreter::SetCommandOverrideCallback().

◆ GetCommandPrefix()

const char* lldb_private::CommandInterpreter::GetCommandPrefix ( )

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

◆ GetCommands()

const CommandObject::CommandMap& lldb_private::CommandInterpreter::GetCommands ( ) const

inline

Definition at line 587 of file CommandInterpreter.h.

References m_command_dict.

◆ GetCommandSP()

lldb::CommandObjectSP lldb_private::CommandInterpreter::GetCommandSP	(	llvm::StringRef	cmd,
		bool	include_aliases = `true`,
		bool	exact = `true`,
		StringList *	matches = `nullptr`,
		StringList *	descriptions = `nullptr`
	)		const

protected

◆ GetCommandSPExact()

lldb::CommandObjectSP lldb_private::CommandInterpreter::GetCommandSPExact	(	llvm::StringRef	cmd,
		bool	include_aliases = `false`
	)		const

Referenced by Initialize().

◆ GetCurrentSourceDir()

FileSpec lldb_private::CommandInterpreter::GetCurrentSourceDir ( )

◆ GetDebugger()

Debugger& lldb_private::CommandInterpreter::GetDebugger ( )

inline

Definition at line 446 of file CommandInterpreter.h.

References m_debugger.

◆ GetEchoCommands()

bool CommandInterpreter::GetEchoCommands ( ) const

Definition at line 196 of file CommandInterpreter.cpp.

References lldb_private::Properties::m_collection_sp.

◆ GetEchoCommentCommands()

bool CommandInterpreter::GetEchoCommentCommands ( ) const

Definition at line 207 of file CommandInterpreter.cpp.

References lldb_private::Properties::m_collection_sp.

◆ GetExecutionContext()

ExecutionContext lldb_private::CommandInterpreter::GetExecutionContext ( ) const

◆ GetExpandRegexAliases()

bool CommandInterpreter::GetExpandRegexAliases ( ) const

Definition at line 147 of file CommandInterpreter.cpp.

References lldb_private::Properties::m_collection_sp.

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

◆ GetHelp()

void lldb_private::CommandInterpreter::GetHelp	(	CommandReturnObject &	result,
		uint32_t	types = `eCommandTypesAllThem`
	)

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

◆ GetIOHandler()

lldb::IOHandlerSP lldb_private::CommandInterpreter::GetIOHandler	(	bool	force_create = `false`,
		CommandInterpreterRunOptions *	options = `nullptr`
	)

Referenced by lldb_private::REPL::IOHandlerInputComplete().

◆ GetLLDBCommandsFromIOHandler()

void lldb_private::CommandInterpreter::GetLLDBCommandsFromIOHandler	(	const char *	prompt,
		IOHandlerDelegate &	delegate,
		void *	baton = `nullptr`
	)

◆ GetOpenTranscriptInEditor()

bool CommandInterpreter::GetOpenTranscriptInEditor ( ) const

Definition at line 175 of file CommandInterpreter.cpp.

References lldb_private::Properties::m_collection_sp.

◆ GetOptionArgumentPosition()

int lldb_private::CommandInterpreter::GetOptionArgumentPosition ( const char * in_string )

Picks the number out of a string of the form "%NNN", otherwise return 0.

◆ GetPlatform()

lldb::PlatformSP lldb_private::CommandInterpreter::GetPlatform ( bool prefer_target_platform )

Referenced by lldb_private::CommandCompletions::ProcessIDs(), and lldb_private::CommandCompletions::ProcessNames().

◆ GetProcessOutput()

void lldb_private::CommandInterpreter::GetProcessOutput ( )

protected

◆ GetPromptOnQuit()

bool CommandInterpreter::GetPromptOnQuit ( ) const

Definition at line 153 of file CommandInterpreter.cpp.

References lldb_private::Properties::m_collection_sp.

Referenced by lldb::SBCommandInterpreter::GetPromptOnQuit(), lldb_private::REPL::IOHandlerInputComplete(), and lldb_private::CommandObjectQuit::ShouldAskForConfirmation().

◆ GetPythonCommandsFromIOHandler()

void lldb_private::CommandInterpreter::GetPythonCommandsFromIOHandler	(	const char *	prompt,
		IOHandlerDelegate &	delegate,
		void *	baton = `nullptr`
	)

◆ GetQuitExitCode()

int CommandInterpreter::GetQuitExitCode ( bool & exited ) const

Returns the exit code that the user has specified when running the 'quit' command.

Parameters

[out] exited Set to true if the user has called quit with a custom exit code.

Definition at line 231 of file CommandInterpreter.cpp.

References m_quit_exit_code.

Referenced by lldb::SBCommandInterpreter::GetQuitStatus(), and lldb::SBCommandInterpreter::HasCustomQuitExitCode().

◆ GetRepeatPreviousCommand()

bool CommandInterpreter::GetRepeatPreviousCommand ( ) const

Definition at line 259 of file CommandInterpreter.cpp.

References lldb_private::Properties::m_collection_sp.

◆ GetRequireCommandOverwrite()

bool CommandInterpreter::GetRequireCommandOverwrite ( ) const

Definition at line 265 of file CommandInterpreter.cpp.

References lldb_private::Properties::m_collection_sp.

◆ GetSaveSessionDirectory()

FileSpec CommandInterpreter::GetSaveSessionDirectory ( ) const

Definition at line 186 of file CommandInterpreter.cpp.

References lldb_private::Properties::m_collection_sp.

◆ GetSaveSessionOnQuit()

bool CommandInterpreter::GetSaveSessionOnQuit ( ) const

Definition at line 164 of file CommandInterpreter.cpp.

References lldb_private::Properties::m_collection_sp.

Referenced by lldb_private::Debugger::Destroy().

◆ GetSpaceReplPrompts()

bool CommandInterpreter::GetSpaceReplPrompts ( ) const

Definition at line 253 of file CommandInterpreter.cpp.

References lldb_private::Properties::m_collection_sp.

Referenced by lldb_private::REPL::IOHandlerInputComplete().

◆ GetStaticBroadcasterClass()

ConstString & CommandInterpreter::GetStaticBroadcasterClass ( )

static

Definition at line 122 of file CommandInterpreter.cpp.

Referenced by GetBroadcasterClass().

◆ GetStopCmdSourceOnError()

bool CommandInterpreter::GetStopCmdSourceOnError ( ) const

Definition at line 247 of file CommandInterpreter.cpp.

References lldb_private::Properties::m_collection_sp.

◆ GetSynchronous()

bool lldb_private::CommandInterpreter::GetSynchronous ( )

Referenced by lldb_private::Target::Launch().

◆ GetUserCommandObject()

CommandObject* lldb_private::CommandInterpreter::GetUserCommandObject	(	llvm::StringRef	cmd,
		StringList *	matches = `nullptr`,
		StringList *	descriptions = `nullptr`
	)		const

Referenced by lldb_private::CommandCompletions::CompleteModifiableCmdPathArgs().

◆ GetUserCommands()

const CommandObject::CommandMap& lldb_private::CommandInterpreter::GetUserCommands ( ) const

inline

Definition at line 579 of file CommandInterpreter.h.

References m_user_dict.

◆ GetUserMultiwordCommands()

const CommandObject::CommandMap& lldb_private::CommandInterpreter::GetUserMultiwordCommands ( ) const

inline

Definition at line 583 of file CommandInterpreter.h.

References m_user_mw_dict.

◆ HandleCommand() [1/2]

bool lldb_private::CommandInterpreter::HandleCommand	(	const char *	command_line,
		LazyBool	add_to_history,
		CommandReturnObject &	result
	)

◆ HandleCommand() [2/2]

bool lldb_private::CommandInterpreter::HandleCommand	(	const char *	command_line,
		LazyBool	add_to_history,
		const ExecutionContext &	override_context,
		CommandReturnObject &	result
	)

Referenced by lldb_private::CommandObjectRegexCommand::DoExecute(), lldb::SBCommandInterpreter::HandleCommand(), lldb_private::REPL::IOHandlerInputComplete(), and sddarwinlog_private::RunEnableCommand().

◆ HandleCommands() [1/2]

void lldb_private::CommandInterpreter::HandleCommands	(	const StringList &	commands,
		const CommandInterpreterRunOptions &	options,
		CommandReturnObject &	result
	)

◆ HandleCommands() [2/2]

void lldb_private::CommandInterpreter::HandleCommands	(	const StringList &	commands,
		const ExecutionContext &	context,
		const CommandInterpreterRunOptions &	options,
		CommandReturnObject &	result
	)

Execute a list of commands in sequence.

Parameters

[in]	commands	The list of commands to execute.
[in,out]	context	The execution context in which to run the commands.
[in]	options	This object holds the options used to control when to stop, whether to execute commands, etc.
[out]	result	This is marked as succeeding with no output if all commands execute safely, and failed with some explanation if we aborted executing the commands at some point.

Referenced by lldb_private::BreakpointOptions::BreakpointOptionsCallbackFunction(), and lldb_private::Target::StopHookCommandLine::HandleStop().

◆ HandleCommandsFromFile() [1/2]

void lldb_private::CommandInterpreter::HandleCommandsFromFile	(	FileSpec &	file,
		const CommandInterpreterRunOptions &	options,
		CommandReturnObject &	result
	)

◆ HandleCommandsFromFile() [2/2]

void lldb_private::CommandInterpreter::HandleCommandsFromFile	(	FileSpec &	file,
		const ExecutionContext &	context,
		const CommandInterpreterRunOptions &	options,
		CommandReturnObject &	result
	)

Execute a list of commands from a file.

Parameters

[in]	file	The file from which to read in commands.
[in,out]	context	The execution context in which to run the commands.
[in]	options	This object holds the options used to control when to stop, whether to execute commands, etc.
[out]	result	This is marked as succeeding with no output if all commands execute safely, and failed with some explanation if we aborted executing the commands at some point.

Referenced by lldb::SBCommandInterpreter::HandleCommandsFromFile().

◆ HandleCompletion()

void lldb_private::CommandInterpreter::HandleCompletion ( CompletionRequest & request )

Referenced by lldb::SBCommandInterpreter::HandleCompletionWithDescriptions(), lldb_private::REPL::IOHandlerComplete(), and lldb_private::IOHandlerDelegate::IOHandlerComplete().

◆ HandleCompletionMatches()

void lldb_private::CommandInterpreter::HandleCompletionMatches ( CompletionRequest & request )

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

◆ HasAliases()

bool lldb_private::CommandInterpreter::HasAliases ( ) const

Referenced by lldb::SBCommandInterpreter::HasAliases().

◆ HasAliasOptions()

bool lldb_private::CommandInterpreter::HasAliasOptions ( ) const

Referenced by lldb::SBCommandInterpreter::HasAliasOptions().

◆ HasCommands()

bool lldb_private::CommandInterpreter::HasCommands ( ) const

Referenced by lldb::SBCommandInterpreter::HasCommands().

◆ HasUserCommands()

bool lldb_private::CommandInterpreter::HasUserCommands ( ) const

◆ HasUserMultiwordCommands()

bool lldb_private::CommandInterpreter::HasUserMultiwordCommands ( ) const

◆ Initialize()

void CommandInterpreter::Initialize ( )

Definition at line 271 of file CommandInterpreter.cpp.

References AddAlias(), GetCommandSPExact(), lldb_private::StreamString::GetString(), lldb_private::Debugger::GetUseColor(), LLDB_SCOPED_TIMER, LoadCommandDictionary(), m_debugger, lldb_private::Stream::Printf(), lldb_private::CommandAlias::SetHelp(), lldb_private::CommandAlias::SetHelpLong(), and lldb_private::CommandObject::SetSyntax().

◆ InterruptCommand()

bool lldb_private::CommandInterpreter::InterruptCommand ( )

private

◆ IOHandlerGetControlSequence()

ConstString lldb_private::CommandInterpreter::IOHandlerGetControlSequence ( char ch )

inlineoverrideprotectedvirtual

Reimplemented from lldb_private::IOHandlerDelegate.

Definition at line 646 of file CommandInterpreter.h.

◆ IOHandlerInputComplete()

void lldb_private::CommandInterpreter::IOHandlerInputComplete	(	IOHandler &	io_handler,
		std::string &	data
	)

overrideprotectedvirtual

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.

◆ IOHandlerInterrupt()

bool lldb_private::CommandInterpreter::IOHandlerInterrupt ( IOHandler & io_handler )

overridevirtual

Reimplemented from lldb_private::IOHandlerDelegate.

◆ IsActive()

bool lldb_private::CommandInterpreter::IsActive ( )

Referenced by lldb::SBCommandInterpreter::IsActive().

◆ IsInteractive()

bool lldb_private::CommandInterpreter::IsInteractive ( )

Referenced by lldb::SBCommandInterpreter::IsInteractive().

◆ LoadCommandDictionary()

void CommandInterpreter::LoadCommandDictionary ( )

Definition at line 529 of file CommandInterpreter.cpp.

References lldb_private::CommandCompletions::eSourceFileCompletion, lldb_private::CommandCompletions::eSymbolCompletion, LLDB_SCOPED_TIMER, m_command_dict, REGISTER_COMMAND_OBJECT, and string().

Referenced by Initialize().

◆ OutputFormattedHelpText() [1/2]

void lldb_private::CommandInterpreter::OutputFormattedHelpText	(	Stream &	stream,
		llvm::StringRef	command_word,
		llvm::StringRef	separator,
		llvm::StringRef	help_text,
		size_t	max_word_len
	)

◆ OutputFormattedHelpText() [2/2]

void lldb_private::CommandInterpreter::OutputFormattedHelpText	(	Stream &	strm,
		llvm::StringRef	prefix,
		llvm::StringRef	help_text
	)

Referenced by lldb_private::CommandObjectApropos::DoExecute(), lldb_private::Property::DumpDescription(), lldb_private::CommandObject::FormatLongHelpText(), lldb_private::CommandObjectMultiword::GenerateHelpText(), lldb_private::CommandObject::GenerateHelpText(), and lldb_private::CommandObject::GetArgumentHelp().

◆ OutputHelpText()

void lldb_private::CommandInterpreter::OutputHelpText	(	Stream &	stream,
		llvm::StringRef	command_word,
		llvm::StringRef	separator,
		llvm::StringRef	help_text,
		uint32_t	max_word_len
	)

Referenced by lldb_private::CommandObject::GetArgumentHelp().

◆ OverrideExecutionContext()

void lldb_private::CommandInterpreter::OverrideExecutionContext ( const ExecutionContext & override_context )

private

◆ PreprocessCommand()

Status lldb_private::CommandInterpreter::PreprocessCommand ( std::string & command )

private

◆ PrintCommandOutput()

void lldb_private::CommandInterpreter::PrintCommandOutput	(	IOHandler &	io_handler,
		llvm::StringRef	str,
		bool	is_stdout
	)

private

◆ PrintWarningsIfNecessary()

void lldb_private::CommandInterpreter::PrintWarningsIfNecessary	(	Stream &	s,
		const std::string &	cmd_name
	)

inline

Definition at line 517 of file CommandInterpreter.h.

References eUnwarnedOmission, eWarnedOmission, m_max_depth_warning, m_truncation_warning, and lldb_private::Stream::Printf().

◆ ProcessEmbeddedScriptCommands()

const char * CommandInterpreter::ProcessEmbeddedScriptCommands ( const char * arg )

Definition at line 513 of file CommandInterpreter.cpp.

Referenced by lldb_private::CommandObjectParsed::Execute().

◆ RemoveAlias()

bool lldb_private::CommandInterpreter::RemoveAlias ( llvm::StringRef alias_name )

◆ RemoveAllUser()

void lldb_private::CommandInterpreter::RemoveAllUser ( )

inline

Definition at line 341 of file CommandInterpreter.h.

References m_user_dict.

◆ RemoveAllUserMultiword()

void lldb_private::CommandInterpreter::RemoveAllUserMultiword ( )

inline

Definition at line 337 of file CommandInterpreter.h.

References m_user_mw_dict.

◆ RemoveCommand()

bool lldb_private::CommandInterpreter::RemoveCommand ( llvm::StringRef cmd )

◆ RemoveUser()

bool lldb_private::CommandInterpreter::RemoveUser ( llvm::StringRef alias_name )

◆ RemoveUserMultiword()

bool lldb_private::CommandInterpreter::RemoveUserMultiword ( llvm::StringRef multiword_name )

◆ ResolveCommand()

void CommandInterpreter::ResolveCommand	(	const char *	command_line,
		CommandReturnObject &	result
	)

Definition at line 238 of file CommandInterpreter.cpp.

References lldb_private::CommandReturnObject::AppendMessageWithFormat(), lldb::eReturnStatusSuccessFinishResult, ResolveCommandImpl(), lldb_private::CommandReturnObject::SetStatus(), and string().

Referenced by lldb::SBCommandInterpreter::ResolveCommand().

◆ ResolveCommandImpl()

CommandObject* lldb_private::CommandInterpreter::ResolveCommandImpl	(	std::string &	command_line,
		CommandReturnObject &	result
	)

private

Referenced by ResolveCommand().

◆ RestoreExecutionContext()

void lldb_private::CommandInterpreter::RestoreExecutionContext ( )

private

◆ RunCommandInterpreter()

CommandInterpreterRunResult lldb_private::CommandInterpreter::RunCommandInterpreter ( CommandInterpreterRunOptions & options )

Referenced by lldb::SBDebugger::RunCommandInterpreter().

◆ SaveTranscript()

bool lldb_private::CommandInterpreter::SaveTranscript	(	CommandReturnObject &	result,
		std::optional< std::string >	output_file = `std::nullopt`
	)

Save the current debugger session transcript to a file on disk.

Parameters

output_file	The file path to which the session transcript will be written. Since the argument is optional, an arbitrary temporary file will be create when no argument is passed.
result	This is used to pass function output and error messages.

Returns: true if the session transcript was successfully written to disk, false otherwise.

Referenced by lldb_private::Debugger::Destroy().

◆ SetBatchCommandMode()

bool lldb_private::CommandInterpreter::SetBatchCommandMode ( bool value )

inline

Definition at line 501 of file CommandInterpreter.h.

References m_batch_command_mode.

◆ SetEchoCommands()

void CommandInterpreter::SetEchoCommands ( bool enable )

Definition at line 202 of file CommandInterpreter.cpp.

References lldb_private::Properties::m_collection_sp.

◆ SetEchoCommentCommands()

void CommandInterpreter::SetEchoCommentCommands ( bool enable )

Definition at line 213 of file CommandInterpreter.cpp.

References lldb_private::Properties::m_collection_sp.

◆ SetOpenTranscriptInEditor()

void CommandInterpreter::SetOpenTranscriptInEditor ( bool enable )

Definition at line 181 of file CommandInterpreter.cpp.

References lldb_private::Properties::m_collection_sp.

◆ SetPromptOnQuit()

void CommandInterpreter::SetPromptOnQuit ( bool enable )

Definition at line 159 of file CommandInterpreter.cpp.

References lldb_private::Properties::m_collection_sp.

Referenced by lldb_private::REPL::IOHandlerInputComplete(), and lldb::SBCommandInterpreter::SetPromptOnQuit().

◆ SetQuitExitCode()

bool CommandInterpreter::SetQuitExitCode ( int exit_code )

Sets the exit code for the quit command.

Parameters

[in] exit_code The exit code that the driver should return on exit.

Returns: True if the exit code was successfully set; false if the interpreter doesn't allow custom exit codes.

See also: AllowExitCodeOnQuit

Definition at line 224 of file CommandInterpreter.cpp.

References m_allow_exit_code, and m_quit_exit_code.

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

◆ SetReachedMaximumDepth()

void lldb_private::CommandInterpreter::SetReachedMaximumDepth ( )

inline

Definition at line 512 of file CommandInterpreter.h.

References eNoOmission, eUnwarnedOmission, and m_max_depth_warning.

◆ SetSaveSessionDirectory()

void CommandInterpreter::SetSaveSessionDirectory ( llvm::StringRef path )

Definition at line 191 of file CommandInterpreter.cpp.

References lldb_private::Properties::m_collection_sp.

◆ SetSaveSessionOnQuit()

void CommandInterpreter::SetSaveSessionOnQuit ( bool enable )

Definition at line 170 of file CommandInterpreter.cpp.

References lldb_private::Properties::m_collection_sp.

◆ SetSynchronous()

void lldb_private::CommandInterpreter::SetSynchronous ( bool value )

protected

Referenced by CommandInterpreter().

◆ SkipAppInitFiles()

void lldb_private::CommandInterpreter::SkipAppInitFiles ( bool skip_app_init_files )

inline

Definition at line 486 of file CommandInterpreter.h.

References m_skip_app_init_files.

Referenced by lldb::SBDebugger::Create().

◆ SkipLLDBInitFiles()

void lldb_private::CommandInterpreter::SkipLLDBInitFiles ( bool skip_lldbinit_files )

inline

Definition at line 482 of file CommandInterpreter.h.

References m_skip_lldbinit_files.

Referenced by lldb::SBDebugger::Create().

◆ SourceInitFile()

void lldb_private::CommandInterpreter::SourceInitFile	(	FileSpec	file,
		CommandReturnObject &	result
	)

private

◆ SourceInitFileCwd()

void lldb_private::CommandInterpreter::SourceInitFileCwd ( CommandReturnObject & result )

Referenced by lldb::SBCommandInterpreter::SourceInitFileInCurrentWorkingDirectory().

◆ SourceInitFileGlobal()

void lldb_private::CommandInterpreter::SourceInitFileGlobal ( CommandReturnObject & result )

Referenced by lldb::SBCommandInterpreter::SourceInitFileInGlobalDirectory().

◆ SourceInitFileHome()

void lldb_private::CommandInterpreter::SourceInitFileHome	(	CommandReturnObject &	result,
		bool	is_repl
	)

Referenced by lldb::SBCommandInterpreter::SourceInitFileInHomeDirectory().

◆ StartHandlingCommand()

void lldb_private::CommandInterpreter::StartHandlingCommand ( )

private

◆ UpdatePrompt()

void lldb_private::CommandInterpreter::UpdatePrompt ( llvm::StringRef prompt )

◆ UserCommandExists()

bool lldb_private::CommandInterpreter::UserCommandExists ( llvm::StringRef cmd ) const

Determine whether a root-level user command with this name exists.

◆ UserMultiwordCommandExists()

bool lldb_private::CommandInterpreter::UserMultiwordCommandExists ( llvm::StringRef cmd ) const

Determine whether a root-level user multiword command with this name exists.

◆ VerifyUserMultiwordCmdPath()

CommandObjectMultiword* lldb_private::CommandInterpreter::VerifyUserMultiwordCmdPath	(	Args &	path,
		bool	leaf_is_command,
		Status &	result
	)

Look up the command pointed to by path encoded in the arguments of the incoming command object.

If all the path components exist and are all actual commands - not aliases, and the leaf command is a multiword command, return the command. Otherwise return nullptr, and put a useful diagnostic in the Status object.

Parameters

[in]	path	An Args object holding the path in its arguments
[in]	leaf_is_command	If true, return the container of the leaf name rather than looking up the whole path as a leaf command. The leaf needn't exist in this case.
[in,out]	result	If the path is not found, this error shows where we got off track.

Returns: If found, a pointer to the CommandObjectMultiword pointed to by path, or to the container of the leaf element is is_leaf_command. Returns nullptr under two circumstances: 1) The command in not found (check error.Fail) 2) is_leaf is true and the path has only a leaf. We don't have a dummy "contains everything MWC, so we return null here, but in this case error.Success is true.

Referenced by lldb_private::CommandCompletions::CompleteModifiableCmdPathArgs().

◆ WasInterrupted()

bool lldb_private::CommandInterpreter::WasInterrupted ( ) const

Referenced by lldb::SBCommandInterpreter::WasInterrupted().

Friends And Related Function Documentation

◆ Debugger

friend class Debugger

friend

Definition at line 640 of file CommandInterpreter.h.

Member Data Documentation

◆ g_argument

const char * CommandInterpreter::g_argument = "<argument>"

static

Definition at line 249 of file CommandInterpreter.h.

Referenced by lldb_private::CommandAlias::GetAliasExpansion(), and lldb_private::CommandAlias::IsDashDashCommand().

◆ g_need_argument

const char * CommandInterpreter::g_need_argument = "<need-argument>"

static

Definition at line 248 of file CommandInterpreter.h.

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

◆ g_no_argument

const char * CommandInterpreter::g_no_argument = "<no-argument>"

static

Definition at line 247 of file CommandInterpreter.h.

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

◆ m_alias_dict

CommandObject::CommandMap lldb_private::CommandInterpreter::m_alias_dict

private

Definition at line 718 of file CommandInterpreter.h.

Referenced by GetAliases().

◆ m_allow_exit_code

bool lldb_private::CommandInterpreter::m_allow_exit_code = false

private

Definition at line 748 of file CommandInterpreter.h.

Referenced by AllowExitCodeOnQuit(), and SetQuitExitCode().

◆ m_batch_command_mode

bool lldb_private::CommandInterpreter::m_batch_command_mode

private

Definition at line 727 of file CommandInterpreter.h.

Referenced by GetBatchCommandMode(), and SetBatchCommandMode().

◆ m_command_dict

CommandObject::CommandMap lldb_private::CommandInterpreter::m_command_dict

private

Definition at line 714 of file CommandInterpreter.h.

Referenced by GetCommands(), and LoadCommandDictionary().

◆ m_command_history

CommandHistory lldb_private::CommandInterpreter::m_command_history

private

Definition at line 722 of file CommandInterpreter.h.

Referenced by GetCommandHistory().

◆ m_command_io_handler_sp

lldb::IOHandlerSP lldb_private::CommandInterpreter::m_command_io_handler_sp

private

Definition at line 725 of file CommandInterpreter.h.

Referenced by Clear().

◆ m_command_source_depth

uint32_t lldb_private::CommandInterpreter::m_command_source_depth

private

Definition at line 737 of file CommandInterpreter.h.

◆ m_command_source_dirs

std::vector<FileSpec> lldb_private::CommandInterpreter::m_command_source_dirs

private

A stack of directory paths.

When not empty, the last one is the directory of the file that's currently sourced.

Definition at line 740 of file CommandInterpreter.h.

◆ m_command_source_flags

std::vector<uint32_t> lldb_private::CommandInterpreter::m_command_source_flags

private

Definition at line 741 of file CommandInterpreter.h.

◆ m_command_state

std::atomic<CommandHandlingState> lldb_private::CommandInterpreter::m_command_state

private

Initial value:

{

CommandHandlingState::eIdle}

Definition at line 697 of file CommandInterpreter.h.

◆ m_comment_char

char lldb_private::CommandInterpreter::m_comment_char

private

Definition at line 726 of file CommandInterpreter.h.

◆ m_debugger

Debugger& lldb_private::CommandInterpreter::m_debugger

private

Definition at line 706 of file CommandInterpreter.h.

Referenced by GetDebugger(), and Initialize().

◆ m_iohandler_nesting_level

int lldb_private::CommandInterpreter::m_iohandler_nesting_level = 0

private

Definition at line 700 of file CommandInterpreter.h.

◆ m_max_depth_warning

ChildrenOmissionWarningStatus lldb_private::CommandInterpreter::m_max_depth_warning

private

Whether we reached the maximum child nesting depth and whether the user has been told.

Definition at line 733 of file CommandInterpreter.h.

Referenced by PrintWarningsIfNecessary(), and SetReachedMaximumDepth().

◆ m_overriden_exe_contexts

std::stack<ExecutionContext> lldb_private::CommandInterpreter::m_overriden_exe_contexts

private

Definition at line 710 of file CommandInterpreter.h.

◆ m_quit_exit_code

std::optional<int> lldb_private::CommandInterpreter::m_quit_exit_code

private

Definition at line 746 of file CommandInterpreter.h.

Referenced by AllowExitCodeOnQuit(), GetQuitExitCode(), and SetQuitExitCode().

◆ m_repeat_command

std::string lldb_private::CommandInterpreter::m_repeat_command

private

Definition at line 723 of file CommandInterpreter.h.

◆ m_result

CommandInterpreterRunResult lldb_private::CommandInterpreter::m_result

private

Definition at line 742 of file CommandInterpreter.h.

◆ m_skip_app_init_files

bool lldb_private::CommandInterpreter::m_skip_app_init_files

private

Definition at line 713 of file CommandInterpreter.h.

Referenced by SkipAppInitFiles().

◆ m_skip_lldbinit_files

bool lldb_private::CommandInterpreter::m_skip_lldbinit_files

private

Definition at line 712 of file CommandInterpreter.h.

Referenced by SkipLLDBInitFiles().

◆ m_synchronous_execution

bool lldb_private::CommandInterpreter::m_synchronous_execution

private

Definition at line 711 of file CommandInterpreter.h.

◆ m_transcript_stream

StreamString lldb_private::CommandInterpreter::m_transcript_stream

private

Definition at line 750 of file CommandInterpreter.h.

◆ m_truncation_warning

ChildrenOmissionWarningStatus lldb_private::CommandInterpreter::m_truncation_warning

private

Whether we truncated a value's list of children and whether the user has been told.

Definition at line 730 of file CommandInterpreter.h.

Referenced by ChildrenTruncated(), and PrintWarningsIfNecessary().

◆ m_user_dict

CommandObject::CommandMap lldb_private::CommandInterpreter::m_user_dict

private

Definition at line 719 of file CommandInterpreter.h.

Referenced by GetUserCommands(), and RemoveAllUser().

◆ m_user_mw_dict

CommandObject::CommandMap lldb_private::CommandInterpreter::m_user_mw_dict

private

Definition at line 721 of file CommandInterpreter.h.

Referenced by GetUserMultiwordCommands(), and RemoveAllUserMultiword().

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ ChildrenOmissionWarningStatus

◆ CommandHandlingState

◆ CommandTypes

Constructor & Destructor Documentation

◆ CommandInterpreter()

◆ ~CommandInterpreter()

Member Function Documentation

◆ AddAlias()

◆ AddCommand()

◆ AddUserCommand()

◆ AliasExists()

◆ AllowExitCodeOnQuit()

◆ BuildAliasCommandArgs()

◆ BuildAliasResult()

◆ ChildrenTruncated()

◆ Clear()

◆ CommandExists()

◆ Confirm()

◆ DidProcessStopAbnormally()

◆ EchoCommandNonInteractive()

◆ FindCommandsForApropos() [1/2]

◆ FindCommandsForApropos() [2/2]

◆ FinishHandlingCommand()

◆ GetAlias()

◆ GetAliases()

◆ GetAliasFullName()

◆ GetAliasHelp()

◆ GetAutoSuggestionForCommand()

◆ GetBatchCommandMode()

◆ GetBroadcasterClass()

◆ GetCommandHistory()

◆ GetCommandNamesMatchingPartialString()

◆ GetCommandObject()

◆ GetCommandObjectForCommand()

◆ GetCommandPrefix()

◆ GetCommands()

◆ GetCommandSP()

◆ GetCommandSPExact()

◆ GetCurrentSourceDir()

◆ GetDebugger()

◆ GetEchoCommands()

◆ GetEchoCommentCommands()

◆ GetExecutionContext()

◆ GetExpandRegexAliases()

◆ GetHelp()

◆ GetIOHandler()

◆ GetLLDBCommandsFromIOHandler()

◆ GetOpenTranscriptInEditor()

◆ GetOptionArgumentPosition()

◆ GetPlatform()

◆ GetProcessOutput()

◆ GetPromptOnQuit()

◆ GetPythonCommandsFromIOHandler()

◆ GetQuitExitCode()

◆ GetRepeatPreviousCommand()

◆ GetRequireCommandOverwrite()

◆ GetSaveSessionDirectory()

◆ GetSaveSessionOnQuit()

◆ GetSpaceReplPrompts()

◆ GetStaticBroadcasterClass()

◆ GetStopCmdSourceOnError()

◆ GetSynchronous()

◆ GetUserCommandObject()

◆ GetUserCommands()

◆ GetUserMultiwordCommands()

◆ HandleCommand() [1/2]

◆ HandleCommand() [2/2]