twisted.conch.insults.helper.TerminalBuffer

Undocumented

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.

Add the given printable bytes to the terminal.

Line feeds in bytes will be replaced with carriage return / line feed pairs.

Add one byte to the terminal at the cursor and make consequent state updates.

If b is a carriage return, move the cursor to the beginning of the current row.

If b is a line feed, move the cursor to the next row or scroll down if the cursor is already in the last row.

Otherwise, if b is printable, put it at the cursor position (inserting or overwriting as dictated by the current mode) and move the cursor.

Move the cursor up n lines.

Move the cursor down n lines.

Move the cursor left n columns.

Move the cursor right n columns.

Move the cursor to the given line and column.

Move the cursor home.

Move the cursor down one line, performing scrolling if necessary.

Move the cursor up one line, performing scrolling if necessary.

Update the cursor position attributes and scroll down if appropriate.

Save the cursor position, character attribute, character set, and origin mode selection.

Restore the previously saved cursor position, character attribute, character set, and origin mode selection.

If no cursor state was previously saved, move the cursor to the home position.

Set the given modes on the terminal.

Reset the given modes on the terminal.

Enable the given modes.

Track which modes have been enabled so that the implementations of other insults.ITerminalTransport methods can be properly implemented to respect these settings.

Disable the given modes.

Cause keypad to generate control functions.

Cursor key mode selects the type of characters generated by cursor keys.

Cause keypad to generate normal characters.

Select a character set.

charSet should be one of CS_US, CS_UK, CS_DRAWING, CS_ALTERNATE, or CS_ALTERNATE_SPECIAL.

which should be one of G0 or G1.

Activate the G0 character set.

Activate the G1 character set.

Shift to the G2 character set for a single character.

Shift to the G3 character set for a single character.

Enabled one or more character attributes.

Arguments should be one or more of UNDERLINE, REVERSE_VIDEO, BLINK, or BOLD. NORMAL may also be specified to disable all character attributes.

Erase the entire cursor line.

Erase from the cursor to the end of line, including cursor position.

Erase from the cursor to the beginning of the line, including the cursor position.

Erase the entire display.

Erase from the cursor to the end of the display, including the cursor position.

Erase from the cursor to the beginning of the display, including the cursor position.

Delete n characters starting at the cursor position.

Characters to the right of deleted characters are shifted to the left.

Insert n lines at the cursor position.

Lines below the cursor are shifted down. Lines moved past the bottom margin are lost. This command is ignored when the cursor is outside the scroll region.

Delete n lines starting at the cursor position.

Lines below the cursor are shifted up. This command is ignored when the cursor is outside the scroll region.

Return a Deferred that fires with a two-tuple of (x, y) indicating the cursor position.

Reset the terminal to its initial state.

Called when an unsupported control sequence is received.

Undocumented

Similar to getPeer, but returns an address describing this side of the connection.

Get the remote address of this connection.

Treat this method with caution. It is the unfortunate result of the CGI and Jabber standards, but should not be considered reliable for the usual host of reasons; port forwarding, proxying, firewalls, IP masquerading, etc.

Close my connection, after writing all pending data.

Note that if there is a registered producer on a transport it will not be closed until the producer has been unregistered.

Write an iterable of byte strings to the physical connection.

If possible, make sure that all of the data is written to the socket at once, without first copying it all into a single byte string.

Set a tab stop at the current cursor position.

Clear the tab stop at the current cursor position.

Clear all tab stops.

Make the current line the top or bottom half of a double-height, double-width line.

If top is True, the current line is the top half. Otherwise, it is the bottom half.

Make the current line a single-width, single-height line.

Make the current line a double-width line.