#include <Emulation.h>

Inheritance diagram for Konsole::Emulation:

[legend]

Public Types
enum class	KeyboardCursorShape { BlockCursor = 0 , UnderlineCursor = 1 , IBeamCursor = 2 }

Public Types inherited from QObject
typedef	QObjectList

Signals
void	changeTabTextColorRequest (int color)

void	cursorChanged (KeyboardCursorShape cursorShape, bool blinkingCursorEnabled)

void	flowControlKeyPressed (bool suspendKeyPressed)

void	handleCommandFromKeyboard (KeyboardTranslator::Command command)

void	imageResizeRequest (const QSize &sizz)

void	imageSizeChanged (int lineCount, int columnCount)

void	imageSizeInitialized ()

void	outputChanged ()

void	outputFromKeypressEvent (void)

void	profileChangeCommandReceived (const QString &text)

void	programBracketedPasteModeChanged (bool bracketedPasteMode)

void	programUsesMouseChanged (bool usesMouse)

void	sendData (const char *data, int len)

void	stateSet (int state)

void	titleChanged (int title, const QString &newTitle)

void	useUtf8Request (bool)

void	zmodemDetected ()

Public Slots
void	receiveData (const char *buffer, int len)

virtual void	sendKeyEvent (QKeyEvent *, bool fromPaste)

virtual void	sendMouseEvent (int buttons, int column, int line, int eventType)

virtual void	sendString (const char *string, int length=-1)=0

virtual void	sendText (const QString &text)=0

virtual void	setImageSize (int lines, int columns)

Public Member Functions
	Emulation ()

virtual void	clearEntireScreen ()=0

void	clearHistory ()

const QTextCodec *	codec () const

ScreenWindow *	createWindow ()

virtual char	eraseChar () const

const HistoryType &	history () const

QSize	imageSize () const

QString	keyBindings () const

int	lineCount () const

bool	programBracketedPasteMode () const

bool	programUsesMouse () const

virtual void	reset ()=0

void	setCodec (const QTextCodec *)

void	setHistory (const HistoryType &)

void	setKeyBindings (const QString &name)

bool	utf8 () const

virtual void	writeToStream (TerminalCharacterDecoder *decoder)

virtual void	writeToStream (TerminalCharacterDecoder *decoder, int startLine, int endLine)

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Protected Types
enum	EmulationCodec { LocaleCodec = 0 , Utf8Codec = 1 }

Protected Slots
void	bufferedUpdate ()

Protected Member Functions
virtual void	receiveChar (QChar ch)

virtual void	resetMode (int mode)=0

void	setCodec (EmulationCodec codec)

virtual void	setMode (int mode)=0

void	setScreen (int index)

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Protected Attributes
std::unique_ptr< Screen >	_alternateScreen

const QTextCodec *	_codec

Screen *	_currentScreen

std::unique_ptr< QTextDecoder >	_decoder

const KeyboardTranslator *	_keyTranslator

std::unique_ptr< Screen >	_primaryScreen

std::vector< std::unique_ptr< ScreenWindow > >	_windows

Additional Inherited Members
Properties inherited from QObject
	objectName

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

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)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Detailed Description

Base class for terminal emulation back-ends.

The back-end is responsible for decoding an incoming character stream and producing an output image of characters.

When input from the terminal is received, the receiveData() slot should be called with the data which has arrived. The emulation will process the data and update the screen image accordingly. The codec used to decode the incoming character stream into the unicode characters used internally can be specified using setCodec()

The size of the screen image can be specified by calling setImageSize() with the desired number of lines and columns. When new lines are added, old content is moved into a history store, which can be set by calling setHistory().

The screen image can be accessed by creating a ScreenWindow onto this emulation by calling createWindow(). Screen windows provide access to a section of the output. Each screen window covers the same number of lines and columns as the image size returned by imageSize(). The screen window can be moved up and down and provides transparent access to both the current on-screen image and the previous output. The screen windows Q_EMIT an outputChanged signal when the section of the image they are looking at changes. Graphical views can then render the contents of a screen window, listening for notifications of output changes from the screen window which they are associated with and updating accordingly.

The emulation also is also responsible for converting input from the connected views such as keypresses and mouse activity into a character string which can be sent to the terminal program. Key presses can be processed by calling the sendKeyEvent() slot, while mouse events can be processed using the sendMouseEvent() slot. When the character stream has been produced, the emulation will Q_EMIT a sendData() signal with a pointer to the character buffer. This data should be fed to the standard input of the terminal process. The translation of key presses into an output character stream is performed using a lookup in a set of key bindings which map key sequences to output character sequences. The name of the key bindings set used can be specified using setKeyBindings()

The emulation maintains certain state information which changes depending on the input received. The emulation can be reset back to its starting state by calling reset().

The emulation also maintains an activity state, which specifies whether terminal is currently active ( when data is received ), normal ( when the terminal is idle or receiving user input ) or trying to alert the user ( also known as a "Bell" event ). The stateSet() signal is emitted whenever the activity state is set. This can be used to determine how long the emulation has been active/idle for and also respond to a 'bell' event in different ways.

Definition at line 119 of file Emulation.h.

Member Enumeration Documentation

◆ EmulationCodec

enum Konsole::Emulation::EmulationCodec

protected

Definition at line 466 of file Emulation.h.

◆ KeyboardCursorShape

enum class Konsole::Emulation::KeyboardCursorShape

strong

This enum describes the available shapes for the keyboard cursor.

See setKeyboardCursorShape()

Enumerator
BlockCursor	A rectangular block which covers the entire area of the cursor character.
UnderlineCursor	A single flat line which occupies the space at the bottom of the cursor character's area.
IBeamCursor	An cursor shaped like the capital letter 'I', similar to the IBeam cursor used in Qt/KDE text editors.

Definition at line 128 of file Emulation.h.

Constructor & Destructor Documentation

◆ Emulation()

Emulation::Emulation ( )

Constructs a new terminal emulation.

Definition at line 50 of file Emulation.cpp.

Member Function Documentation

◆ bufferedUpdate

void Emulation::bufferedUpdate ( )

protectedslot

Schedules an update of attached views.

Repeated calls to bufferedUpdate() in close succession will result in only a single update, much like the Qt buffered update of widgets.

Definition at line 337 of file Emulation.cpp.

◆ changeTabTextColorRequest

void Konsole::Emulation::changeTabTextColorRequest ( int color )

signal

Requests that the color of the text used to represent the tabs associated with this emulation be changed.

This is a Konsole-specific extension from pre-KDE 4 times.

TODO: Document how the parameter works.

◆ clearEntireScreen()

virtual void Konsole::Emulation::clearEntireScreen ( )

pure virtual

Copies the current image into the history and clears the screen.

Implemented in Konsole::Vt102Emulation.

◆ clearHistory()

void Emulation::clearHistory ( )

Clears the history scroll.

Definition at line 127 of file Emulation.cpp.

◆ codec()

const QTextCodec * Konsole::Emulation::codec ( ) const

inline

Returns the codec used to decode incoming characters.

See setCodec()

Definition at line 200 of file Emulation.h.

◆ createWindow()

ScreenWindow * Emulation::createWindow ( )

Creates a new window onto the output from this emulation.

The contents of the window are then rendered by views which are set to use this window using the TerminalDisplay::setScreenWindow() method.

Definition at line 98 of file Emulation.cpp.

◆ cursorChanged

void Konsole::Emulation::cursorChanged	(	KeyboardCursorShape	cursorShape,
		bool	blinkingCursorEnabled )

signal

Emitted when the cursor shape or its blinking state is changed via DECSCUSR sequences.

Parameters

cursorShape	One of 3 possible values in KeyboardCursorShape enum
blinkingCursorEnabled	Whether to enable blinking or not

◆ eraseChar()

char Emulation::eraseChar ( ) const

virtual

TODO Document me.

Reimplemented in Konsole::Vt102Emulation.

Definition at line 347 of file Emulation.cpp.

◆ flowControlKeyPressed

void Konsole::Emulation::flowControlKeyPressed ( bool suspendKeyPressed )

signal

Emitted when a flow control key combination ( Ctrl+S or Ctrl+Q ) is pressed.

Parameters

suspendKeyPressed True if Ctrl+S was pressed to suspend output or Ctrl+Q to resume output.

◆ history()

const HistoryType & Emulation::history ( ) const

Returns the history store used by this emulation.

See setHistory()

Definition at line 138 of file Emulation.cpp.

◆ imageResizeRequest

void Konsole::Emulation::imageResizeRequest ( const QSize & sizz )

signal

Emitted after receiving the escape sequence which asks to change the terminal emulator's size.

◆ imageSize()

QSize Emulation::imageSize ( ) const

Returns the size of the screen image which the emulation produces.

Definition at line 372 of file Emulation.cpp.

◆ imageSizeChanged

void Konsole::Emulation::imageSizeChanged	(	int	lineCount,
		int	columnCount )

signal

Emitted when the program running in the terminal changes the screen size.

◆ imageSizeInitialized

void Konsole::Emulation::imageSizeInitialized ( )

signal

Emitted when the setImageSize() is called on this emulation for the first time.

◆ keyBindings()

QString Emulation::keyBindings ( ) const

Returns the name of the emulation's current key bindings.

See setKeyBindings()

Definition at line 172 of file Emulation.cpp.

◆ lineCount()

int Emulation::lineCount ( ) const

Returns the total number of lines, including those stored in the history.

Definition at line 317 of file Emulation.cpp.

◆ outputChanged

void Konsole::Emulation::outputChanged ( )

signal

Emitted when the contents of the screen image change.

The emulation buffers the updates from successive image changes, and only emits outputChanged() at sensible intervals when there is a lot of terminal activity.

Normally there is no need for objects other than the screen windows created with createWindow() to listen for this signal.

ScreenWindow objects created using createWindow() will Q_EMIT their own outputChanged() signal in response to this signal.

◆ profileChangeCommandReceived

void Konsole::Emulation::profileChangeCommandReceived ( const QString & text )

signal

Emitted when the terminal program requests to change various properties of the terminal display.

A profile change command occurs when a special escape sequence, followed by a string containing a series of name and value pairs is received. This string can be parsed using a ProfileCommandParser instance.

Parameters

text	A string expected to contain a series of key and value pairs in the form: name=value;name2=value2 ...

◆ programBracketedPasteMode()

bool Emulation::programBracketedPasteMode ( ) const

Definition at line 88 of file Emulation.cpp.

◆ programUsesMouse()

bool Emulation::programUsesMouse ( ) const

Returns true if the active terminal program wants mouse input events.

The programUsesMouseChanged() signal is emitted when this changes.

Definition at line 78 of file Emulation.cpp.

◆ programUsesMouseChanged

void Konsole::Emulation::programUsesMouseChanged ( bool usesMouse )

signal

This is emitted when the program running in the shell indicates whether or not it is interested in mouse events.

Parameters

usesMouse This will be true if the program wants to be informed about mouse events or false otherwise.

◆ receiveChar()

void Emulation::receiveChar ( QChar ch )

protectedvirtual

Processes an incoming character.

See receiveData() ch A unicode character code.

Reimplemented in Konsole::Vt102Emulation.

Definition at line 177 of file Emulation.cpp.

◆ receiveData

void Emulation::receiveData	(	const char *	buffer,
		int	len )

slot

Processes an incoming stream of characters.

receiveData() decodes the incoming character buffer using the current codec(), and then calls receiveChar() for each unicode character in the resulting buffer.

receiveData() also starts a timer which causes the outputChanged() signal to be emitted when it expires. The timer allows multiple updates in quick succession to be buffered into a single outputChanged() signal emission.

Parameters

buffer	A string of characters received from the terminal program.
len	The length of `buffer`

Definition at line 230 of file Emulation.cpp.

◆ reset()

virtual void Konsole::Emulation::reset ( )

pure virtual

Resets the state of the terminal.

Implemented in Konsole::Vt102Emulation.

◆ sendData

void Konsole::Emulation::sendData	(	const char *	data,
		int	len )

signal

Emitted when a buffer of data is ready to send to the standard input of the terminal.

Parameters

data	The buffer of data ready to be sent
len	The length of `data` in bytes

◆ sendKeyEvent

void Emulation::sendKeyEvent	(	QKeyEvent *	ev,
		bool	fromPaste )

virtualslot

Interprets a key press event and emits the sendData() signal with the resulting character stream.

Definition at line 204 of file Emulation.cpp.

◆ sendMouseEvent

void Emulation::sendMouseEvent	(	int	buttons,
		int	column,
		int	line,
		int	eventType )

virtualslot

Converts information about a mouse event into an xterm-compatible escape sequence and emits the character sequence via sendData()

Definition at line 220 of file Emulation.cpp.

◆ sendString

void Emulation::sendString	(	const char *	string,
		int	length = -1 )

pure virtualslot

Sends a string of characters to the foreground terminal process.

Parameters

string	The characters to send.
length	Length of `string` or if set to a negative value, `string` will be treated as a null-terminated string and its length will be determined automatically.

Definition at line 215 of file Emulation.cpp.

◆ sendText

virtual void Konsole::Emulation::sendText ( const QString & text )

pure virtualslot

Interprets a sequence of characters and sends the result to the terminal.

This is equivalent to calling sendKeyEvent() for each character in text in succession.

◆ setCodec() [1/2]

void Emulation::setCodec ( const QTextCodec * qtc )

Sets the codec used to decode incoming characters.

Definition at line 143 of file Emulation.cpp.

◆ setCodec() [2/2]

void Emulation::setCodec ( EmulationCodec codec )

protected

Definition at line 156 of file Emulation.cpp.

◆ setHistory()

void Emulation::setHistory ( const HistoryType & t )

Sets the history store used by this emulation.

When new lines are added to the output, older lines at the top of the screen are transferred to a history store.

The number of lines which are kept and the storage location depend on the type of store.

Definition at line 131 of file Emulation.cpp.

◆ setImageSize

void Emulation::setImageSize	(	int	lines,
		int	columns )

virtualslot

Change the size of the emulation's image.

Definition at line 352 of file Emulation.cpp.

◆ setKeyBindings()

void Emulation::setKeyBindings ( const QString & name )

Sets the key bindings used to key events ( received through sendKeyEvent() ) into character streams to send to the terminal.

Definition at line 164 of file Emulation.cpp.

◆ setScreen()

void Emulation::setScreen ( int index )

protected

Sets the active screen.

The terminal has two screens, primary and alternate. The primary screen is used by default. When certain interactive programs such as Vim are run, they trigger a switch to the alternate screen.

Parameters

index 0 to switch to the primary screen, or 1 to switch to the alternate screen

Definition at line 115 of file Emulation.cpp.

◆ stateSet

void Konsole::Emulation::stateSet ( int state )

signal

Emitted when the activity state of the emulation is set.

Parameters

state The new activity state, one of NOTIFYNORMAL, NOTIFYACTIVITY or NOTIFYBELL

◆ titleChanged

void Konsole::Emulation::titleChanged	(	int	title,
		const QString &	newTitle )

signal

Emitted when the program running in the terminal wishes to update the session's title.

This also allows terminal programs to customize other aspects of the terminal emulation display.

This signal is emitted when the escape sequence "\033]ARG;VALUE\007" is received in the input string, where ARG is a number specifying what should change and VALUE is a string specifying the new value.

TODO: The name of this method is not very accurate since this method is used to perform a whole range of tasks besides just setting the user-title of the session.

Parameters

title

Specifies what to change.

0 - Set window icon text and session title to newTitle
1 - Set window icon text to newTitle
2 - Set session title to newTitle
11 - Set the session's default background color to newTitle, where newTitle can be an HTML-style string ("#RRGGBB") or a named color (eg 'red', 'blue'). See http://doc.trolltech.com/4.2/qcolor.html#setNamedColor for more details.
31 - Supposedly treats newTitle as a URL and opens it (NOT IMPLEMENTED)
32 - Sets the icon associated with the session. newTitle is the name of the icon to use, which can be the name of any icon in the current KDE icon theme (eg: 'konsole', 'kate', 'folder_home')

newTitle Specifies the new title

◆ useUtf8Request

void Konsole::Emulation::useUtf8Request ( bool )

signal

Requests that the pty used by the terminal process be set to UTF 8 mode.

TODO: More documentation

◆ utf8()

bool Konsole::Emulation::utf8 ( ) const

inline

Convenience method.

Returns true if the current codec used to decode incoming characters is UTF-8

Definition at line 212 of file Emulation.h.

◆ writeToStream() [1/2]

void Emulation::writeToStream ( TerminalCharacterDecoder * decoder )

virtual

Copies the complete output history into stream, using decoder to convert the terminal characters into text.

Parameters

decoder A decoder which converts lines of terminal characters with appearance attributes into output text. PlainTextDecoder is the most commonly used decoder.

Definition at line 312 of file Emulation.cpp.

◆ writeToStream() [2/2]

void Emulation::writeToStream	(	TerminalCharacterDecoder *	decoder,
		int	startLine,
		int	endLine )

virtual

Copies the output history from startLine to endLine into stream, using decoder to convert the terminal characters into text.

Parameters

decoder	A decoder which converts lines of terminal characters with appearance attributes into output text. PlainTextDecoder is the most commonly used decoder.
startLine	Index of first line to copy
endLine	Index of last line to copy

Definition at line 307 of file Emulation.cpp.

◆ zmodemDetected

void Konsole::Emulation::zmodemDetected ( )

signal

TODO Document me.

Member Data Documentation

◆ _alternateScreen

std::unique_ptr<Screen> Konsole::Emulation::_alternateScreen

protected

Definition at line 476 of file Emulation.h.

◆ _codec

const QTextCodec* Konsole::Emulation::_codec

protected

Definition at line 481 of file Emulation.h.

◆ _currentScreen

Screen* Konsole::Emulation::_currentScreen

protected

Definition at line 471 of file Emulation.h.

◆ _decoder

std::unique_ptr<QTextDecoder> Konsole::Emulation::_decoder

protected

Definition at line 482 of file Emulation.h.

◆ _keyTranslator

const KeyboardTranslator* Konsole::Emulation::_keyTranslator

protected

Definition at line 483 of file Emulation.h.

◆ _primaryScreen

std::unique_ptr<Screen> Konsole::Emulation::_primaryScreen

protected

Definition at line 474 of file Emulation.h.

◆ _windows

std::vector<std::unique_ptr<ScreenWindow> > Konsole::Emulation::_windows

protected

Definition at line 469 of file Emulation.h.

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

Class Picker

Quick Links

About MauiKit Terminal

Konsole::Emulation

Public Types

Signals

Public Slots

Public Member Functions

Protected Types

Protected Slots

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ EmulationCodec

◆ KeyboardCursorShape

Constructor & Destructor Documentation

◆ Emulation()

Member Function Documentation

◆ bufferedUpdate

◆ changeTabTextColorRequest

◆ clearEntireScreen()

◆ clearHistory()

◆ codec()

◆ createWindow()

◆ cursorChanged

◆ eraseChar()

◆ flowControlKeyPressed

◆ history()

◆ imageResizeRequest

◆ imageSize()

◆ imageSizeChanged

◆ imageSizeInitialized

◆ keyBindings()

◆ lineCount()

◆ outputChanged

◆ profileChangeCommandReceived

◆ programBracketedPasteMode()

◆ programUsesMouse()

◆ programUsesMouseChanged

◆ receiveChar()

◆ receiveData

◆ reset()

◆ sendData

◆ sendKeyEvent

◆ sendMouseEvent

◆ sendString

◆ sendText

◆ setCodec() [1/2]

◆ setCodec() [2/2]

◆ setHistory()

◆ setImageSize

◆ setKeyBindings()

◆ setScreen()

◆ stateSet

◆ titleChanged

◆ useUtf8Request

◆ utf8()

◆ writeToStream() [1/2]

◆ writeToStream() [2/2]

◆ zmodemDetected

Member Data Documentation

◆ _alternateScreen

◆ _codec

◆ _currentScreen

◆ _decoder

◆ _keyTranslator

◆ _primaryScreen

◆ _windows