Inheritance diagram for CommandObjectSourceInfo:

[legend]

Classes
class	CommandOptions

Public Member Functions
	CommandObjectSourceInfo (CommandInterpreter &interpreter)

	~CommandObjectSourceInfo () override=default

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

Protected Member Functions
uint32_t	DumpLinesInSymbolContexts (Stream &strm, const SymbolContextList &sc_list, const ModuleList &module_list, const FileSpec &file_spec)

uint32_t	DumpFileLinesInCompUnit (Stream &strm, Module module, CompileUnit cu, const FileSpec &file_spec)

uint32_t	DumpFileLinesInModule (Stream &strm, Module *module, const FileSpec &file_spec)

size_t	GetSymbolContextsForAddress (const ModuleList &module_list, lldb::addr_t addr, SymbolContextList &sc_list, StreamString &error_strm)

bool	DumpLinesInFunctions (CommandReturnObject &result)

bool	DumpLinesForAddress (CommandReturnObject &result)

bool	DumpLinesForFile (CommandReturnObject &result)

bool	DumpLinesForFrame (CommandReturnObject &result)

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 ()

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
CommandOptions	m_options

ModuleList	m_module_list

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

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)

Detailed Description

Definition at line 39 of file CommandObjectSource.cpp.

Constructor & Destructor Documentation

◆ CommandObjectSourceInfo()

CommandObjectSourceInfo::CommandObjectSourceInfo ( CommandInterpreter & interpreter )

inline

Definition at line 118 of file CommandObjectSource.cpp.

◆ ~CommandObjectSourceInfo()

CommandObjectSourceInfo::~CommandObjectSourceInfo ( )

overridedefault

Member Function Documentation

◆ DoExecute()

void CommandObjectSourceInfo::DoExecute	(	Args &	command,
		CommandReturnObject &	result
	)

inlineoverrideprotectedvirtual

Implements lldb_private::CommandObjectParsed.

Definition at line 535 of file CommandObjectSource.cpp.

References CommandObjectSourceInfo::CommandOptions::address, lldb_private::CommandReturnObject::AppendError(), lldb_private::CommandReturnObject::AppendWarningWithFormat(), lldb_private::ModuleList::Clear(), DumpLinesForAddress(), DumpLinesForFile(), DumpLinesForFrame(), DumpLinesInFunctions(), lldb::eReturnStatusFailed, lldb::eReturnStatusSuccessFinishResult, CommandObjectSourceInfo::CommandOptions::file_name, lldb_private::ModuleList::FindModules(), lldb_private::ArchSpec::GetAddressByteSize(), lldb_private::Target::GetArchitecture(), lldb_private::CommandReturnObject::GetErrorStream(), lldb_private::Target::GetImages(), lldb_private::CommandReturnObject::GetOutputStream(), lldb_private::ModuleList::GetSize(), lldb_private::CommandObject::GetTarget(), lldb_private::ModuleList::IsEmpty(), LLDB_INVALID_ADDRESS, m_module_list, m_options, CommandObjectSourceInfo::CommandOptions::modules, lldb_private::Stream::SetAddressByteSize(), lldb_private::CommandReturnObject::SetStatus(), and CommandObjectSourceInfo::CommandOptions::symbol_name.

◆ DumpFileLinesInCompUnit()

uint32_t CommandObjectSourceInfo::DumpFileLinesInCompUnit	(	Stream &	strm,
		Module *	module,
		CompileUnit *	cu,
		const FileSpec &	file_spec
	)

inlineprotected

Definition at line 195 of file CommandObjectSource.cpp.

References lldb_private::ConstString::AsCString(), lldb::eDescriptionLevelBrief, CommandObjectSourceInfo::CommandOptions::end_line, lldb_private::SupportFileList::FindFileIndex(), lldb_private::CompileUnit::FindLineEntry(), lldb_private::LineEntry::GetDescription(), lldb_private::FileSpec::GetDirectory(), lldb_private::LineEntry::GetFile(), lldb_private::FileSpec::GetFilename(), lldb_private::Module::GetFileSpec(), lldb_private::SupportFileList::GetFileSpecAtIndex(), lldb_private::CompileUnit::GetPrimaryFile(), lldb_private::CompileUnit::GetSupportFiles(), lldb_private::CommandObject::GetTarget(), lldb_private::LineEntry::line, m_options, CommandObjectSourceInfo::CommandOptions::num_lines, CommandObjectSourceInfo::CommandOptions::start_line, and UINT32_MAX.

Referenced by DumpFileLinesInModule().

◆ DumpFileLinesInModule()

uint32_t CommandObjectSourceInfo::DumpFileLinesInModule	(	Stream &	strm,
		Module *	module,
		const FileSpec &	file_spec
	)

inlineprotected

Definition at line 276 of file CommandObjectSource.cpp.

References DumpFileLinesInCompUnit(), lldb_private::Module::GetCompileUnitAtIndex(), and lldb_private::Module::GetNumCompileUnits().

Referenced by DumpLinesForFile().

◆ DumpLinesForAddress()

bool CommandObjectSourceInfo::DumpLinesForAddress ( CommandReturnObject & result )

inlineprotected

Definition at line 461 of file CommandObjectSource.cpp.

References CommandObjectSourceInfo::CommandOptions::address, lldb_private::CommandReturnObject::AppendErrorWithFormat(), DumpLinesInSymbolContexts(), lldb_private::StreamString::GetData(), lldb_private::Target::GetImages(), lldb_private::CommandReturnObject::GetOutputStream(), GetSymbolContextsForAddress(), lldb_private::CommandObject::GetTarget(), and m_options.

Referenced by DoExecute().

◆ DumpLinesForFile()

bool CommandObjectSourceInfo::DumpLinesForFile ( CommandReturnObject & result )

inlineprotected

Definition at line 484 of file CommandObjectSource.cpp.

References lldb_private::CommandReturnObject::AppendErrorWithFormat(), DumpFileLinesInModule(), CommandObjectSourceInfo::CommandOptions::file_name, lldb_private::Target::GetImages(), lldb_private::ModuleList::GetModulePointerAtIndex(), lldb_private::CommandReturnObject::GetOutputStream(), lldb_private::ModuleList::GetSize(), lldb_private::CommandObject::GetTarget(), m_module_list, and m_options.

Referenced by DoExecute().

◆ DumpLinesForFrame()

bool CommandObjectSourceInfo::DumpLinesForFrame ( CommandReturnObject & result )

inlineprotected

Definition at line 509 of file CommandObjectSource.cpp.

References lldb_private::SymbolContextList::Append(), lldb_private::CommandReturnObject::AppendError(), DumpLinesInSymbolContexts(), lldb_private::ExecutionContext::GetFramePtr(), lldb_private::CommandReturnObject::GetOutputStream(), lldb_private::StackFrame::GetSymbolContext(), lldb_private::StackFrame::HasDebugInformation(), and lldb_private::CommandObject::m_exe_ctx.

Referenced by DoExecute().

◆ DumpLinesInFunctions()

bool CommandObjectSourceInfo::DumpLinesInFunctions ( CommandReturnObject & result )

inlineprotected

Definition at line 369 of file CommandObjectSource.cpp.

References lldb_private::SymbolContextList::Append(), lldb_private::CommandReturnObject::AppendErrorWithFormat(), lldb_private::CommandReturnObject::AppendWarningWithFormat(), lldb_private::ConstString::AsCString(), lldb_private::Address::CalculateSymbolContextFunction(), DumpLinesInSymbolContexts(), lldb_private::ModuleList::FindFunctions(), lldb_private::ModuleList::FindFunctionSymbols(), lldb_private::ArchSpec::GetAddressByteSize(), lldb_private::Target::GetArchitecture(), lldb_private::AddressRange::GetBaseAddress(), lldb_private::AddressRange::GetByteSize(), lldb_private::StreamString::GetData(), lldb_private::Address::GetFileAddress(), lldb_private::Target::GetImages(), lldb_private::Address::GetLoadAddress(), lldb_private::CommandReturnObject::GetOutputStream(), lldb_private::ModuleList::GetSize(), lldb_private::SymbolContextList::GetSize(), GetSymbolContextsForAddress(), lldb_private::CommandObject::GetTarget(), lldb_private::ModuleFunctionSearchOptions::include_inlines, lldb_private::ModuleFunctionSearchOptions::include_symbols, LLDB_INVALID_ADDRESS, m_module_list, m_options, and CommandObjectSourceInfo::CommandOptions::symbol_name.

Referenced by DoExecute().

◆ DumpLinesInSymbolContexts()

uint32_t CommandObjectSourceInfo::DumpLinesInSymbolContexts	(	Stream &	strm,
		const SymbolContextList &	sc_list,
		const ModuleList &	module_list,
		const FileSpec &	file_spec
	)

inlineprotected

◆ GetOptions()

Options * CommandObjectSourceInfo::GetOptions ( )

inlineoverridevirtual

Reimplemented from lldb_private::CommandObject.

Definition at line 128 of file CommandObjectSource.cpp.

References m_options.

◆ GetSymbolContextsForAddress()

size_t CommandObjectSourceInfo::GetSymbolContextsForAddress	(	const ModuleList &	module_list,
		lldb::addr_t	addr,
		SymbolContextList &	sc_list,
		StreamString &	error_strm
	)

inlineprotected

Definition at line 297 of file CommandObjectSource.cpp.

References lldb_private::SymbolContextList::AppendIfUnique(), lldb_private::SymbolContext::Clear(), lldb_private::Address::Dump(), lldb_private::Address::DumpStyleModuleWithFileAddress, lldb_private::StreamString::GetData(), lldb_private::ModuleList::GetIndexForModule(), lldb_private::Address::GetModule(), lldb_private::ModuleList::GetModuleAtIndex(), lldb_private::Target::GetSectionLoadList(), lldb_private::ModuleList::GetSize(), lldb_private::CommandObject::GetTarget(), lldb_private::SectionLoadList::IsEmpty(), LLDB_INVALID_INDEX32, lldb_private::Stream::Printf(), and lldb_private::SectionLoadList::ResolveLoadAddress().

Referenced by DumpLinesForAddress(), and DumpLinesInFunctions().

Member Data Documentation

◆ m_module_list

ModuleList CommandObjectSourceInfo::m_module_list

protected

Definition at line 593 of file CommandObjectSource.cpp.

Referenced by DoExecute(), DumpLinesForFile(), and DumpLinesInFunctions().

◆ m_options

CommandOptions CommandObjectSourceInfo::m_options

protected

Definition at line 592 of file CommandObjectSource.cpp.

Referenced by DoExecute(), DumpFileLinesInCompUnit(), DumpLinesForAddress(), DumpLinesForFile(), DumpLinesInFunctions(), DumpLinesInSymbolContexts(), and GetOptions().

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

CommandObjectSource.cpp

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CommandObjectSourceInfo()

◆ ~CommandObjectSourceInfo()

Member Function Documentation

◆ DoExecute()

◆ DumpFileLinesInCompUnit()

◆ DumpFileLinesInModule()

◆ DumpLinesForAddress()

◆ DumpLinesForFile()

◆ DumpLinesForFrame()

◆ DumpLinesInFunctions()

◆ DumpLinesInSymbolContexts()

◆ GetOptions()

◆ GetSymbolContextsForAddress()

Member Data Documentation

◆ m_module_list

◆ m_options