KDevelop::IDebugSession Class Reference

#include <idebugsession.h>

Inheritance diagram for KDevelop::IDebugSession:

Public Types
enum	DebuggerState {   NotStartedState, StartingState, ActiveState, PausedState,   StoppingState, StoppedState, EndedState }
enum	event_t {   program_state_changed = 1, program_exited, debugger_exited, thread_or_frame_changed,   debugger_busy, debugger_ready, program_running, connected_to_program }

Public Slots
virtual void	interruptDebugger ()=0
virtual void	jumpToCursor ()=0
virtual void	killDebuggerNow ()=0
virtual void	restartDebugger ()=0
virtual void	run ()=0
virtual void	runToCursor ()=0
virtual void	stepInto ()=0
virtual void	stepIntoInstruction ()=0
virtual void	stepOut ()=0
virtual void	stepOver ()=0
virtual void	stepOverInstruction ()=0
virtual void	stopDebugger ()=0

Signals
void	clearExecutionPoint ()
void	event (IDebugSession::event_t e)
void	finished ()
void	raiseFramestackViews ()
void	showStepInDisassemble (const QString &addr)
void	showStepInSource (const QUrl &file, int line, const QString &addr)
void	stateChanged (KDevelop::IDebugSession::DebuggerState state)

Public Member Functions
	IDebugSession ()
	~IDebugSession () override
virtual IBreakpointController *	breakpointController () const =0
virtual QPair< QUrl, int >	convertToLocalUrl (const QPair< QUrl, int > &remoteUrl) const
virtual QPair< QUrl, int >	convertToRemoteUrl (const QPair< QUrl, int > &localUrl) const
QString	currentAddr () const
int	currentLine () const
QUrl	currentUrl () const
virtual bool	event (QEvent *e)
virtual IFrameStackModel *	frameStackModel () const =0
bool	isRunning () const
virtual bool	restartAvaliable () const =0
virtual DebuggerState	state () const =0
virtual IVariableController *	variableController () const =0
Public Member Functions inherited from QObject
	QObject (QObject *parent)
	QObject (QObject *parent, const char *name)
virtual	~QObject ()
bool	blockSignals (bool block)
QObject *	child (const char *objName, const char *inheritsClass, bool recursiveSearch) const
const QObjectList &	children () const
const char *	className () const
bool	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *receiver, const char *method)
void	dumpObjectInfo ()
void	dumpObjectTree ()
QList< QByteArray >	dynamicPropertyNames () const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name) const
QList< T >	findChildren (const QRegExp &regExp) const
QList< T >	findChildren (const QString &name) const
bool	inherits (const char *className) const
void	insertChild (QObject *object)
void	installEventFilter (QObject *filterObj)
bool	isA (const char *className) const
bool	isWidgetType () const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const
void	moveToThread (QThread *targetThread)
const char *	name () const
const char *	name (const char *defaultName) const
QString	objectName () const
QObject *	parent () const
QVariant	property (const char *name) const
void	removeChild (QObject *object)
void	removeEventFilter (QObject *obj)
void	setName (const char *name)
void	setObjectName (const QString &name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const
int	startTimer (int interval)
QThread *	thread () const

Protected Member Functions
void	clearCurrentPosition ()
virtual void	raiseEvent (event_t e)
void	setCurrentPosition (const QUrl &url, int line, const QString &addr)
Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char *signal, const QObject *object, const char *method)
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const char *signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const char *signal)
int	receivers (const char *signal) const
QObject *	sender () const
int	senderSignalIndex () const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Static Public Member Functions inherited from QObject
bool	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
bool	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
QString	trUtf8 (const char *sourceText, const char *disambiguation, int n)
Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)
Properties inherited from QObject
	objectName

Detailed Description

Definition at line 24 of file idebugsession.h.

Member Enumeration Documentation

DebuggerState

enum KDevelop::IDebugSession::DebuggerState

Enumerator
NotStartedState
StartingState
ActiveState
PausedState
StoppingState
StoppedState
EndedState

Definition at line 31 of file idebugsession.h.

event_t

enum KDevelop::IDebugSession::event_t

Enumerator
program_state_changed
program_exited
debugger_exited
thread_or_frame_changed
debugger_busy
debugger_ready
program_running
connected_to_program

Definition at line 42 of file idebugsession.h.

Constructor & Destructor Documentation

IDebugSession()

KDevelop::IDebugSession::IDebugSession

(

)

Definition at line 32 of file idebugsession.cpp.

~IDebugSession()

KDevelop::IDebugSession::~IDebugSession ( )

override

Definition at line 39 of file idebugsession.cpp.

Member Function Documentation

breakpointController()

virtual IBreakpointController* KDevelop::IDebugSession::breakpointController ( ) const

pure virtual

Returns

the breakpoint controller of this session

Note

Implementations must ensure that a breakpoint controller always exists (even if it is a dummy stub implementation that does nothing), and that it does not change during the lifetime of a session.

clearCurrentPosition()

void KDevelop::IDebugSession::clearCurrentPosition ( )

protected

Definition at line 71 of file idebugsession.cpp.

clearExecutionPoint

void KDevelop::IDebugSession::clearExecutionPoint ( )

signal

convertToLocalUrl()

QPair< QUrl, int > KDevelop::IDebugSession::convertToLocalUrl ( const QPair< QUrl, int > &  remoteUrl ) const

virtual

Returns the local Url for a source file used in the current debug session.

The default implementation just returns the url and is sufficient for local debuggers. Remote debuggers can implement a path mapping mechanism.

Definition at line 61 of file idebugsession.cpp.

convertToRemoteUrl()

QPair< QUrl, int > KDevelop::IDebugSession::convertToRemoteUrl ( const QPair< QUrl, int > &  localUrl ) const

virtual

Returns the remote Url for a source file used in the current debug session.

The default implementation just returns the url and is sufficient for local debuggers. Remote debuggers can implement a path mapping mechanism.

Definition at line 66 of file idebugsession.cpp.

currentAddr()

QString KDevelop::IDebugSession::currentAddr

(

)

const

Definition at line 114 of file idebugsession.cpp.

currentLine()

int KDevelop::IDebugSession::currentLine

(

)

const

Definition at line 107 of file idebugsession.cpp.

currentUrl()

QUrl KDevelop::IDebugSession::currentUrl

(

)

const

Definition at line 100 of file idebugsession.cpp.

event [1/2]

void KDevelop::IDebugSession::event ( IDebugSession::event_t  e )

signal

This signal is emitted whenever the given event in a program happens.

See DESIGN.txt for expected handled of each event.

NOTE: this signal should never be emitted directly. Instead, use raiseEvent.

event() [2/2]

virtual bool QObject::event

finished

void KDevelop::IDebugSession::finished ( )

signal

frameStackModel()

virtual IFrameStackModel* KDevelop::IDebugSession::frameStackModel ( ) const

pure virtual

Returns

the frame stack model of this session

Note

Implementations must ensure that a frame stack model always exists (even if it is a dummy stub implementation that does nothing), and that it does not change during the lifetime of a session.

interruptDebugger

virtual void KDevelop::IDebugSession::interruptDebugger ( )

pure virtualslot

isRunning()

bool KDevelop::IDebugSession::isRunning

(

)

const

Returns if the debugee is currently running.

This includes paused.

Definition at line 43 of file idebugsession.cpp.

jumpToCursor

virtual void KDevelop::IDebugSession::jumpToCursor ( )

pure virtualslot

killDebuggerNow

virtual void KDevelop::IDebugSession::killDebuggerNow ( )

pure virtualslot

Kills the debugger process synchronously if it is still running.

raiseEvent()

void KDevelop::IDebugSession::raiseEvent ( event_t  e )

protectedvirtual

Raises the specified event.

Should be used instead of emitting 'event' directly, since this method can perform additional book-keeping for events. FIXME: it might make sense to automatically route events to all debugger components, as opposed to requiring that they connect to any signal.

Definition at line 49 of file idebugsession.cpp.

raiseFramestackViews

void KDevelop::IDebugSession::raiseFramestackViews ( )

signal

restartAvaliable()

virtual bool KDevelop::IDebugSession::restartAvaliable ( ) const

pure virtual

Should return if restart is currently available.

restartDebugger

virtual void KDevelop::IDebugSession::restartDebugger ( )

pure virtualslot

run

virtual void KDevelop::IDebugSession::run ( )

pure virtualslot

runToCursor

virtual void KDevelop::IDebugSession::runToCursor ( )

pure virtualslot

setCurrentPosition()

void KDevelop::IDebugSession::setCurrentPosition ( const QUrl &  url, int  line, const QString &  addr  )

protected

Sets new position and emits showStepInSource or showStepInDisassemble (if source file is unavailable) signal.

Definition at line 82 of file idebugsession.cpp.

showStepInDisassemble

void KDevelop::IDebugSession::showStepInDisassemble ( const QString &  addr )

signal

showStepInSource

void KDevelop::IDebugSession::showStepInSource ( const QUrl &  file, int  line, const QString &  addr  )

signal

state()

virtual DebuggerState KDevelop::IDebugSession::state ( ) const

pure virtual

Current state of the debug session.

stateChanged

void KDevelop::IDebugSession::stateChanged ( KDevelop::IDebugSession::DebuggerState  state )

signal

stepInto

virtual void KDevelop::IDebugSession::stepInto ( )

pure virtualslot

stepIntoInstruction

virtual void KDevelop::IDebugSession::stepIntoInstruction ( )

pure virtualslot

stepOut

virtual void KDevelop::IDebugSession::stepOut ( )

pure virtualslot

stepOver

virtual void KDevelop::IDebugSession::stepOver ( )

pure virtualslot

stepOverInstruction

virtual void KDevelop::IDebugSession::stepOverInstruction ( )

pure virtualslot

stopDebugger

virtual void KDevelop::IDebugSession::stopDebugger ( )

pure virtualslot

variableController()

virtual IVariableController* KDevelop::IDebugSession::variableController ( ) const

pure virtual

Returns

the variable controller of this session

Note

Implementations must ensure that a variable controller always exists (even if it is a dummy stub implementation that does nothing), and that it does not change during the lifetime of a session.

---

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

• idebugsession.h
• idebugsession.cpp