#include <SBLaunchInfo.h>

Collaboration diagram for lldb::SBLaunchInfo:

Public Member Functions
	SBLaunchInfo (const char **argv)

	~SBLaunchInfo ()

	SBLaunchInfo (const SBLaunchInfo &rhs)

SBLaunchInfo &	operator= (const SBLaunchInfo &rhs)

lldb::pid_t	GetProcessID ()

uint32_t	GetUserID ()

uint32_t	GetGroupID ()

bool	UserIDIsValid ()

bool	GroupIDIsValid ()

void	SetUserID (uint32_t uid)

void	SetGroupID (uint32_t gid)

SBFileSpec	GetExecutableFile ()

void	SetExecutableFile (SBFileSpec exe_file, bool add_as_first_arg)
	Set the executable file that will be used to launch the process and optionally set it as the first argument in the argument vector. More...

SBListener	GetListener ()
	Get the listener that will be used to receive process events. More...

void	SetListener (SBListener &listener)
	Set the listener that will be used to receive process events. More...

uint32_t	GetNumArguments ()

const char *	GetArgumentAtIndex (uint32_t idx)

void	SetArguments (const char **argv, bool append)

uint32_t	GetNumEnvironmentEntries ()

const char *	GetEnvironmentEntryAtIndex (uint32_t idx)

void	SetEnvironmentEntries (const char **envp, bool append)
	Update this object with the given environment variables. More...

void	SetEnvironment (const SBEnvironment &env, bool append)
	Update this object with the given environment variables. More...

SBEnvironment	GetEnvironment ()
	Return the environment variables of this object. More...

void	Clear ()

const char *	GetWorkingDirectory () const

void	SetWorkingDirectory (const char *working_dir)

uint32_t	GetLaunchFlags ()

void	SetLaunchFlags (uint32_t flags)

const char *	GetProcessPluginName ()

void	SetProcessPluginName (const char *plugin_name)

const char *	GetShell ()

void	SetShell (const char *path)

bool	GetShellExpandArguments ()

void	SetShellExpandArguments (bool expand)

uint32_t	GetResumeCount ()

void	SetResumeCount (uint32_t c)

bool	AddCloseFileAction (int fd)

bool	AddDuplicateFileAction (int fd, int dup_fd)

bool	AddOpenFileAction (int fd, const char *path, bool read, bool write)

bool	AddSuppressFileAction (int fd, bool read, bool write)

void	SetLaunchEventData (const char *data)

const char *	GetLaunchEventData () const

bool	GetDetachOnError () const

void	SetDetachOnError (bool enable)

const char *	GetScriptedProcessClassName () const

void	SetScriptedProcessClassName (const char *class_name)

lldb::SBStructuredData	GetScriptedProcessDictionary () const

void	SetScriptedProcessDictionary (lldb::SBStructuredData dict)

Protected Member Functions
const lldb_private::ProcessLaunchInfo &	ref () const

void	set_ref (const lldb_private::ProcessLaunchInfo &info)

Protected Attributes
std::shared_ptr< lldb_private::SBLaunchInfoImpl >	m_opaque_sp

Friends
class	SBPlatform

class	SBTarget

Detailed Description

Definition at line 23 of file SBLaunchInfo.h.

Constructor & Destructor Documentation

◆ SBLaunchInfo() [1/2]

SBLaunchInfo::SBLaunchInfo ( const char ** argv )

Definition at line 42 of file SBLaunchInfo.cpp.

References LLDB_RECORD_CONSTRUCTOR, and m_opaque_sp.

◆ ~SBLaunchInfo()

SBLaunchInfo::~SBLaunchInfo ( )

default

◆ SBLaunchInfo() [2/2]

SBLaunchInfo::SBLaunchInfo ( const SBLaunchInfo & rhs )

Definition at line 51 of file SBLaunchInfo.cpp.

References LLDB_RECORD_CONSTRUCTOR, and m_opaque_sp.

Member Function Documentation

◆ AddCloseFileAction()

bool SBLaunchInfo::AddCloseFileAction ( int fd )

Definition at line 296 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ AddDuplicateFileAction()

bool SBLaunchInfo::AddDuplicateFileAction	(	int	fd,
		int	dup_fd
	)

Definition at line 302 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ AddOpenFileAction()

bool SBLaunchInfo::AddOpenFileAction	(	int	fd,
		const char *	path,
		bool	read,
		bool	write
	)

Definition at line 309 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ AddSuppressFileAction()

bool SBLaunchInfo::AddSuppressFileAction	(	int	fd,
		bool	read,
		bool	write
	)

Definition at line 317 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ Clear()

void SBLaunchInfo::Clear ( )

Definition at line 211 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetArgumentAtIndex()

const char * SBLaunchInfo::GetArgumentAtIndex ( uint32_t idx )

Definition at line 150 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ GetDetachOnError()

bool SBLaunchInfo::GetDetachOnError ( ) const

Definition at line 344 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_CONST_NO_ARGS, and m_opaque_sp.

◆ GetEnvironment()

SBEnvironment SBLaunchInfo::GetEnvironment ( )

Return the environment variables of this object.

Returns: An lldb::SBEnvironment object which is a copy of the SBLaunchInfo's environment.

Definition at line 205 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, m_opaque_sp, and lldb::SBEnvironment.

◆ GetEnvironmentEntryAtIndex()

const char * SBLaunchInfo::GetEnvironmentEntryAtIndex ( uint32_t idx )

Definition at line 178 of file SBLaunchInfo.cpp.

References GetNumEnvironmentEntries(), LLDB_RECORD_METHOD, and m_opaque_sp.

◆ GetExecutableFile()

SBFileSpec SBLaunchInfo::GetExecutableFile ( )

Definition at line 117 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, m_opaque_sp, and lldb::SBFileSpec.

◆ GetGroupID()

uint32_t SBLaunchInfo::GetGroupID ( )

Definition at line 87 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetLaunchEventData()

const char * SBLaunchInfo::GetLaunchEventData ( ) const

Definition at line 331 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_CONST_NO_ARGS, and m_opaque_sp.

◆ GetLaunchFlags()

uint32_t SBLaunchInfo::GetLaunchFlags ( )

Definition at line 231 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetListener()

SBListener SBLaunchInfo::GetListener ( )

Get the listener that will be used to receive process events.

If no listener has been set via a call to SBLaunchInfo::SetListener(), then an invalid SBListener will be returned (SBListener::IsValid() will return false). If a listener has been set, then the valid listener object will be returned.

Definition at line 131 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, LLDB_RECORD_RESULT, m_opaque_sp, and lldb::SBListener.

◆ GetNumArguments()

uint32_t SBLaunchInfo::GetNumArguments ( )

Definition at line 144 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetNumEnvironmentEntries()

uint32_t SBLaunchInfo::GetNumEnvironmentEntries ( )

Definition at line 172 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

Referenced by GetEnvironmentEntryAtIndex().

◆ GetProcessID()

lldb::pid_t SBLaunchInfo::GetProcessID ( )

Definition at line 75 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetProcessPluginName()

const char * SBLaunchInfo::GetProcessPluginName ( )

Definition at line 243 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetResumeCount()

uint32_t SBLaunchInfo::GetResumeCount ( )

Definition at line 284 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetScriptedProcessClassName()

const char * SBLaunchInfo::GetScriptedProcessClassName ( ) const

Definition at line 350 of file SBLaunchInfo.cpp.

References lldb_private::ConstString::AsCString(), LLDB_RECORD_METHOD_CONST_NO_ARGS, and m_opaque_sp.

◆ GetScriptedProcessDictionary()

lldb::SBStructuredData SBLaunchInfo::GetScriptedProcessDictionary ( ) const

Definition at line 367 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_CONST_NO_ARGS, LLDB_RECORD_RESULT, lldb::SBStructuredData::m_impl_up, and m_opaque_sp.

◆ GetShell()

const char * SBLaunchInfo::GetShell ( )

Definition at line 256 of file SBLaunchInfo.cpp.

References lldb_private::ConstString::AsCString(), LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetShellExpandArguments()

bool SBLaunchInfo::GetShellExpandArguments ( )

Definition at line 271 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetUserID()

uint32_t SBLaunchInfo::GetUserID ( )

Definition at line 81 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ GetWorkingDirectory()

const char * SBLaunchInfo::GetWorkingDirectory ( ) const

Definition at line 217 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_CONST_NO_ARGS, and m_opaque_sp.

◆ GroupIDIsValid()

bool SBLaunchInfo::GroupIDIsValid ( )

Definition at line 99 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

◆ operator=()

SBLaunchInfo & SBLaunchInfo::operator= ( const SBLaunchInfo & rhs )

Definition at line 57 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, LLDB_RECORD_RESULT, and m_opaque_sp.

◆ ref()

const lldb_private::ProcessLaunchInfo & SBLaunchInfo::ref ( ) const

protected

Definition at line 67 of file SBLaunchInfo.cpp.

References m_opaque_sp.

Referenced by lldb::SBPlatform::Launch(), lldb::SBTarget::Launch(), and lldb::SBTarget::SetLaunchInfo().

◆ set_ref()

void SBLaunchInfo::set_ref ( const lldb_private::ProcessLaunchInfo & info )

protected

Definition at line 71 of file SBLaunchInfo.cpp.

References m_opaque_sp.

Referenced by lldb::SBTarget::GetLaunchInfo(), lldb::SBPlatform::Launch(), and lldb::SBTarget::Launch().

◆ SetArguments()

void SBLaunchInfo::SetArguments	(	const char **	argv,
		bool	append
	)

Definition at line 157 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

Referenced by lldb::SBTarget::LaunchSimple().

◆ SetDetachOnError()

void SBLaunchInfo::SetDetachOnError ( bool enable )

Definition at line 338 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetEnvironment()

void SBLaunchInfo::SetEnvironment	(	const SBEnvironment &	env,
		bool	append
	)

Update this object with the given environment variables.

If append is false, the provided environment will replace the existing environment. Otherwise, existing values will be updated of left untouched accordingly.

Parameters

[in]	env	The new environment variables.
[in]	append	Flag that controls whether to replace the existing environment.

Definition at line 193 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, m_opaque_sp, and lldb::SBEnvironment::ref().

Referenced by SetEnvironmentEntries().

◆ SetEnvironmentEntries()

void SBLaunchInfo::SetEnvironmentEntries	(	const char **	envp,
		bool	append
	)

Update this object with the given environment variables.

If append is false, the provided environment will replace the existing environment. Otherwise, existing values will be updated of left untouched accordingly.

Parameters

[in]	envp	The new environment variables as a list of strings with the following format name=value
[in]	append	Flag that controls whether to replace the existing environment.

Definition at line 187 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, lldb::SBEnvironment, and SetEnvironment().

Referenced by lldb::SBTarget::LaunchSimple().

◆ SetExecutableFile()

void SBLaunchInfo::SetExecutableFile	(	SBFileSpec	exe_file,
		bool	add_as_first_arg
	)

Set the executable file that will be used to launch the process and optionally set it as the first argument in the argument vector.

This only needs to be specified if clients wish to carefully control the exact path will be used to launch a binary. If you create a target with a symlink, that symlink will get resolved in the target and the resolved path will get used to launch the process. Calling this function can help you still launch your process using the path of your choice.

If this function is not called prior to launching with SBTarget::Launch(...), the target will use the resolved executable path that was used to create the target.

Parameters

[in]	exe_file	The override path to use when launching the executable.
[in]	add_as_first_arg	If true, then the path will be inserted into the argument vector prior to launching. Otherwise the argument vector will be left alone.

Definition at line 123 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, m_opaque_sp, and lldb::SBFileSpec::ref().

Referenced by lldb::SBTarget::LaunchSimple().

◆ SetGroupID()

void SBLaunchInfo::SetGroupID ( uint32_t gid )

Definition at line 111 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetLaunchEventData()

void SBLaunchInfo::SetLaunchEventData ( const char * data )

Definition at line 324 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetLaunchFlags()

void SBLaunchInfo::SetLaunchFlags ( uint32_t flags )

Definition at line 237 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetListener()

void SBLaunchInfo::SetListener ( SBListener & listener )

Set the listener that will be used to receive process events.

By default the SBDebugger, which has a listener, that the SBTarget belongs to will listen for the process events. Calling this function allows a different listener to be used to listen for process events.

Definition at line 137 of file SBLaunchInfo.cpp.

References lldb::SBListener::GetSP(), LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetProcessPluginName()

void SBLaunchInfo::SetProcessPluginName ( const char * plugin_name )

Definition at line 249 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetResumeCount()

void SBLaunchInfo::SetResumeCount ( uint32_t c )

Definition at line 290 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetScriptedProcessClassName()

void SBLaunchInfo::SetScriptedProcessClassName ( const char * class_name )

Definition at line 360 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetScriptedProcessDictionary()

void SBLaunchInfo::SetScriptedProcessDictionary ( lldb::SBStructuredData dict )

Definition at line 380 of file SBLaunchInfo.cpp.

References lldb_private::Stream::AsRawOstream(), error(), lldb::SBStructuredData::GetAsJSON(), LLDB_RECORD_METHOD, m_opaque_sp, and lldb::SBStream::ref().

◆ SetShell()

void SBLaunchInfo::SetShell ( const char * path )

Definition at line 265 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetShellExpandArguments()

void SBLaunchInfo::SetShellExpandArguments ( bool expand )

Definition at line 277 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetUserID()

void SBLaunchInfo::SetUserID ( uint32_t uid )

Definition at line 105 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

◆ SetWorkingDirectory()

void SBLaunchInfo::SetWorkingDirectory ( const char * working_dir )

Definition at line 224 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD, and m_opaque_sp.

Referenced by lldb::SBTarget::LaunchSimple().

◆ UserIDIsValid()

bool SBLaunchInfo::UserIDIsValid ( )

Definition at line 93 of file SBLaunchInfo.cpp.

References LLDB_RECORD_METHOD_NO_ARGS, and m_opaque_sp.

Friends And Related Function Documentation

◆ SBPlatform

friend class SBPlatform

friend

Definition at line 183 of file SBLaunchInfo.h.

◆ SBTarget

friend class SBTarget

friend

Definition at line 184 of file SBLaunchInfo.h.

Member Data Documentation

◆ m_opaque_sp

std::shared_ptr<lldb_private::SBLaunchInfoImpl> lldb::SBLaunchInfo::m_opaque_sp

protected

Definition at line 189 of file SBLaunchInfo.h.

Referenced by AddCloseFileAction(), AddDuplicateFileAction(), AddOpenFileAction(), AddSuppressFileAction(), Clear(), GetArgumentAtIndex(), GetDetachOnError(), GetEnvironment(), GetEnvironmentEntryAtIndex(), GetExecutableFile(), GetGroupID(), GetLaunchEventData(), GetLaunchFlags(), GetListener(), GetNumArguments(), GetNumEnvironmentEntries(), GetProcessID(), GetProcessPluginName(), GetResumeCount(), GetScriptedProcessClassName(), GetScriptedProcessDictionary(), GetShell(), GetShellExpandArguments(), GetUserID(), GetWorkingDirectory(), GroupIDIsValid(), operator=(), ref(), SBLaunchInfo(), set_ref(), SetArguments(), SetDetachOnError(), SetEnvironment(), SetExecutableFile(), SetGroupID(), SetLaunchEventData(), SetLaunchFlags(), SetListener(), SetProcessPluginName(), SetResumeCount(), SetScriptedProcessClassName(), SetScriptedProcessDictionary(), SetShell(), SetShellExpandArguments(), SetUserID(), SetWorkingDirectory(), and UserIDIsValid().

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

Public Member Functions

Protected Member Functions

Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ SBLaunchInfo() [1/2]

◆ ~SBLaunchInfo()

◆ SBLaunchInfo() [2/2]

Member Function Documentation

◆ AddCloseFileAction()

◆ AddDuplicateFileAction()

◆ AddOpenFileAction()

◆ AddSuppressFileAction()

◆ Clear()

◆ GetArgumentAtIndex()

◆ GetDetachOnError()

◆ GetEnvironment()

◆ GetEnvironmentEntryAtIndex()

◆ GetExecutableFile()

◆ GetGroupID()

◆ GetLaunchEventData()

◆ GetLaunchFlags()

◆ GetListener()

◆ GetNumArguments()

◆ GetNumEnvironmentEntries()

◆ GetProcessID()

◆ GetProcessPluginName()

◆ GetResumeCount()

◆ GetScriptedProcessClassName()

◆ GetScriptedProcessDictionary()

◆ GetShell()

◆ GetShellExpandArguments()

◆ GetUserID()

◆ GetWorkingDirectory()

◆ GroupIDIsValid()

◆ operator=()

◆ ref()

◆ set_ref()

◆ SetArguments()

◆ SetDetachOnError()

◆ SetEnvironment()

◆ SetEnvironmentEntries()

◆ SetExecutableFile()

◆ SetGroupID()

◆ SetLaunchEventData()

◆ SetLaunchFlags()

◆ SetListener()

◆ SetProcessPluginName()

◆ SetResumeCount()

◆ SetScriptedProcessClassName()

◆ SetScriptedProcessDictionary()

◆ SetShell()

◆ SetShellExpandArguments()

◆ SetUserID()

◆ SetWorkingDirectory()

◆ UserIDIsValid()

Friends And Related Function Documentation

◆ SBPlatform

◆ SBTarget

Member Data Documentation

◆ m_opaque_sp