text-console

Description

The text-console class provides a text user interface to a simulated machine. The console is typically connected to a simulated serial device. On Windows hosts, a text selection in the console is automatically copied to the clipboard. Text from the clipboard can be inserted in the console by pressing the middle mouse button. On Linux hosts, the console is implemented using an xterm.

Interfaces Implemented

conf_object, log_object, serial_device, extended_serial, keyboard_console, recorded

Notifiers

cell-change: Notifier that is triggered after the object's cell was changed.
object-delete: Notifier that is triggered just before Simics object is deleted.
queue-change: Notifier that is triggered after the object's clock was changed. New clock can be obtained with the SIM_object_clock function.

Commands for this class

break – set a string to break on
capture-start – capture output to file
capture-stop – stop output capture to file
close – close console window
disable-quiet – enable output redirection
disable-read-only – disable read-only mode
enable-quiet – disable output redirection
enable-read-only – enable read-only mode
info – print information about the object
input – send string to a console
input-file – input a file into a console
kbd-abort – send a keyboard abort signal
list-break-strings – list all active string breakpoints
open – open console window
playback-start – start traffic generator
playback-stop – stop traffic generation
record-start – start recording of output on the console
record-stop – stop recording of output on the console
status – print status of the object
unbreak – stop breaking on string
unbreak-id – remove a breakpoint
wait-for-string – wait for a string in a script branch
wait-then-write – wait for a string, then write an input string

Attributes

title: Required attribute; read/write access; type: s
The window title.
link: Pseudo attribute; read/write access; type: o|n
Deprecated. Do not use.
device: Optional attribute; read/write access; type: o|n|[os]
The device connected to the console, must implement one of the 'serial_device' or 'keyboard' interfaces.
recorder: Required attribute; read/write access; type: o
Recorder device for recording and playback of mouse and keyboard input.
history: Optional attribute; read/write access; type: d
Text history of previously printed text to the window.
history_length: Pseudo attribute; read/write access; type: i
Maximum history size in bytes.
output_timeout: Optional attribute; read/write access; type: i
Maximum number of seconds the xterm-console allows an xterm to start on. Default is 10 seconds.
no_window: Optional attribute; read/write access; type: b
If this flag is TRUE, no window will be opened. If it is FALSE, the output is redirected according to the output_file and quiet attributes.
output_file: Session attribute; read/write access; type: s
If the no_window attribute is TRUE, output will be directed to this file.
quiet: Optional attribute; read/write access; type: b
If the no_window attribute is set, this attribute controls whether or not the console output is redirected to Simics console. If set to TRUE, output is not redirected. If set to FALSE, output is redirected unless the output_file is set. If the no_window attribute is FALSE, then this attribute has no effect.
read_only: Optional attribute; read/write access; type: b
Don't accept any input from the window. (For batch execution).
bg_color: Optional attribute; read/write access; type: s
Default background color. Standard X11 color names or the "#rrggbb" syntax may be used.
fg_color: Optional attribute; read/write access; type: s
Default foreground color. Standard X11 color names or the "#rrggbb" syntax may be used.
scrollback: Optional attribute; read/write access; type: i
Number of lines of output saved on screen.
scrollbar: Optional attribute; read/write access; type: i
Non-zero if the window should have a scrollbar.
width: Optional attribute; read/write access; type: i
Default number of columns.
height: Optional attribute; read/write access; type: i
Default number of rows.
x11_font: Optional attribute; read/write access; type: s
Default font used for X11/Linux hosts. This is a regular X11 font specification string, for example "lucidasanstypewriter-18". Run the Linux xlsfonts command for more fonts.
x11_fontbold: Optional attribute; read/write access; type: s
Default bold-font used for X11/Linux hosts. See documentation for the x11_font attribute.
win32_font: Optional attribute; read/write access; type: s
Default font used for Windows hosts, on the format: "fontname:weight:pointsize". Default is "Lucida Console:Regular:10".
input_delayed: Pseudo attribute; write-only access; type: [sf]
(string, seconds) This attribute appends characters to the input queue, after the specified simulated time have elapsed.
input: Pseudo attribute; write-only access; type: s|[db]
Keyboard input queue. This attribute appends characters to input queue.
input_buf: Optional attribute; read/write access; type: s|d
Keyboard input buffer.
write_delayed: Optional attribute; read/write access; type: i
Flow control. Set if an attempt to send a char was blocked.
break_string: Pseudo attribute; write-only access; type: s
An output string causing Simics to trigger a Xterm_Break_String hap when the string is printed.
break_string_once: Pseudo attribute; write-only access; type: s
An output string causing Simics to trigger a Xterm_Break_String hap when the string is printed. The breakpoint is removed after the first occurrence.
string_breakpoint_list: Pseudo attribute; read-only access; type: [[isi]*]
List of all string breakpoints currently active. Each string breakpoint is a tuple of (id, string, trigger_once)
unbreak_string: Pseudo attribute; write-only access; type: s
Stop breaking on a specified string. Note that if a string is added several times, it also has to be removed the same number of times. I.e. if a hap callback is tied to a string and does not want to be called again, it should both remove the string and unregister the hap callback, since another hap callback may want to break on the same string again.
unbreak_id: Pseudo attribute; write-only access; type: i
Remove breakpoint based on breakpoint id.
break_string_id: Pseudo attribute; read-only access; type: Unknown
Return an id for a string that is set to break on. The id can be used as index for the Xterm_Break_String hap.
abort: Optional attribute; read/write access; type: b
Send a keyboard abort signal to the connected device.
char_1c_is_abort: Optional attribute; read/write access; type: b
Generate a keyboard abort signal when <ctrl>-/ is pressed.
backspace_is_delete: Optional attribute; read/write access; type: b
Set if the backspace key (0x08) should send the delete (0x7f) ASCII code. Default is FALSE.
application: Optional attribute; read/write access; type: s
Module xterm-console only: application that is started in the target process. Default is "xterm".
environment: Optional attribute; read/write access; type: [s*]
Module xterm-console only: list of strings that are added to the environment of the target process before the binary is executed.
application_args: Optional attribute; read/write access; type: [s*]
Module xterm-console only: list of arguments to pass to the target process
use_xterm_args: Optional attribute; read/write access; type: i
Module xterm-console only: if set to non-zero, the started application is assumed to accept xterm-style arguments. If this attribute is zero, attributes which map to xterm-arguments (such as "width" and "height") will have no effect. The default value of this attribute is zero if "application" is set to something other than "xterm", and non-zero otherwise.
kbd_event_queue: Optional attribute; read/write access; type: [[ii]*]
Keyboard event queue. Used when connected to a keyboard controller device, and not a serial device.
console_trace: Pseudo attribute; read/write access; type: i
If set to non-zero, console output will be sent to stdout in a format that is easy to parse.
trace_file: Pseudo attribute; read/write access; type: s
Name of file where to send the console trace, if enabled. If an empty string is given standard output is used. No trace is written to file unless console_trace is also enabled.
recording: Session attribute; read/write access; type: b
When enabled, all characters written to the console will be recorded. The record can be read from the attribute recorded-string.
recorded_string: Session attribute; read/write access; type: s
The characters that have been recorded when the attribute recording is true. Note that the recorded string will NOT be cleared when recording is reset.
raise_window: Pseudo attribute; write-only access; type: i
By writing any value to this attribute, the text console window moved in front of other windows on the display.
minimize_window: Pseudo attribute; write-only access; type: b
By writing TRUE to this attribute, the graphics console window is minimized. A write of FALSE restores it again.
input_terminal_type: Optional attribute; read/write access; type: s
What terminal type to emulate for keyboard inputs. Possible values are:
"standard": standard VT100/XTerm (default).
"microsoft": Microsoft's proprietary "VT100+" (only available on Windows hosts).
vt_demo: Optional attribute; read/write access; type: i
Add a microcheckpont at each CR.
vt_width: Optional attribute; read/write access; type: i
Width of emulated vt102 console.
vt_height: Optional attribute; read/write access; type: i
Height of emulated vt102 console.
vt_state: Optional attribute; read/write access; type: [i|s*]
VT100 state information.
vt_redraw: Pseudo attribute; write-only access; type: i
Force a redraw of the VT console.
vt_contents: Optional attribute; read/write access; type: [d|s*]
Visible contents of the emulated vt102 console. The string format is deprecated and only used for checkpoint compatibility.
vt102_emulation: Optional attribute; read/write access; type: b
Specifies if the console should the emulate vt102 protocol or not. Default is true. By disabling vt102 emulation, the user may be allowed to change the window size interactively, with the side-effect that simulation may not be deterministic from one run to another. This could also cause problems when reversing with Simics.

Provided By

xterm-console