gfx-console

Description

The gfx-console class implements a graphical console, representing a computer screen. Several consoles may be present at any time. It also supports input of keyboard and mouse events. The objects of the gfx-console class should be connected to a graphics card device and a keyboard/mouse device. The console shows its content in gray-scale when the simulation is stopped. The method to provide mouse input is specified with the grab_button and grab_modifier attributes.

Interfaces Implemented

conf_object, log_object, gfx_console, keyboard_console, abs_pointer_activate, clipboard_peer, checkpoint, 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

auto-release – get/set auto-release flag
break – break on a graphics event specified by filename
close – close console window
delete – delete breakpoint
disable-input – ignore console input
disable-visual-feedback – disable visual feedback
enable-input – enable console input
enable-visual-feedback – enable visual feedback
grab-setup – set grab button and modifier
input – send string to a console
open – open console window
refresh – refresh console
save-bmp – save BMP image
save-break-xy – specify and save a graphical breakpoint
save-png – save PNG image

Attributes

x_size: Required attribute; read/write access; type: i
The width of the console.
y_size: Required attribute; read/write access; type: i
The height of the console.
recorder: Required attribute; read/write access; type: o
Recorder device for recording and playback of serial input.
depth: Optional attribute; read/write access; type: i
The simulated depth in bits per pixel (8, 16, 24 or 32).
keyboard: Optional attribute; read/write access; type: o|n
The console's keyboard device. Must implement the keyboard interface.
mouse: Optional attribute; read/write access; type: o|n
The console's mouse device. Must implement the mouse interface
double_x_limit: Optional attribute; read/write access; type: i
If the width of the console is less than or equal to this value, the width of every pixel will be doubled.
double_y_limit: Optional attribute; read/write access; type: i
If the height of the console is less than or equal to this value, the height of every pixel will be doubled.
try_open: Optional attribute; read/write access; type: i
If set to 1, the window will be opened. Close with 0.
rgb_colors: Optional attribute; read/write access; type: [[iii]{256}]
((r, g, b){256}) The color palette. 256 colors.
input_enable: Optional attribute; read/write access; type: b
Enable keyboard and mouse input to the console.
refresh: Pseudo attribute; write-only access; type: a
If set the console will be completely redrawn.
auto_release: Optional attribute; read/write access; type: i
Flag whether the graphics console automatically shall send a release event when the window focus is lost and keys still are pressed
microm_x: Session attribute; read/write access; type: i
Micrometers per horizontal pixel.
microm_y: Session attribute; read/write access; type: i
Micrometers per vertical pixel.
video: Optional attribute; read/write access; type: o|n
The console's video device. Used to import video breakpoint functions. Must implement the video interface.
save_break: Pseudo attribute; write-only access; type: [siiiis]
(source_obj, filename, left, top, right, bottom, comment) . Saves a graphical breakpoint rectangle (top,left)->(bottom,right) to filename.
break: Pseudo attribute; read-only access; type: Unknown
(source_obj, filename). Activate a graphical breakpoint previously saved to filename. Returns a breakpoint ID.
delete: Pseudo attribute; write-only access; type: i
Delete breakpoint with given ID.
fullscreen: Session attribute; read/write access; type: i
Set fullscreen mode. The console will only run in fullscreen while input grabbing is active. Note that not all graphics console implementations support fullscreen.
save_bmp: Pseudo attribute; write-only access; type: s
Save current console bitmap as a BMP file.
save_png: Pseudo attribute; write-only access; type: [sii]
Save current console bitmap as a PNG file. For additional integers are the width and height of the resulting image. They cannot be larger than the original image. If specified as 0, then the original image size is used.
grab_modifier: Optional attribute; read/write access; type: s
One of control, shift, alt and none. The modifier key used for grabbing and ungrabbing input for the console. When a modifier is selected, pressing only the middle mouse button cause the console to send this button event to the simulator. Currently only the left side modifier are interpreted.
grab_button: Optional attribute; read/write access; type: s
One of left, middle and right The grab button specifies which mouse button that is used to grab and ungrab input for the console.
kbd_type: Session attribute; read/write access; type: s
One of PC, PC_XI2, Sun, Mac or X11. By default the x11-console tries to find out what kind of keyboard that is connected to Simics, and use the raw key-codes from it. Since raw key-codes are used, the simulated machine must be setup with the same keyboard layout as the host. If the identification fails, Simics will use X11 cooked key symbols. The 'kbd_type' attribute allows manual setting of the keyboard type.
title: Optional attribute; read/write access; type: s
The console window title.
input_key_event: Pseudo attribute; write-only access; type: [ii]
Set to a enter a key event. The first list element is 0 for key down, 1 for key up. The second list element is the key code.
kbd_event_queue: Optional attribute; read/write access; type: [[ii]*]
Keyboard event queue.
abs_pointer: Optional attribute; read/write access; type: o|n
Absolute positioning pointer device connected to the console. Must implement the abs_pointer interface
abs_pointer_enabled: Optional attribute; read/write access; type: b
True if the absolute positioning pointer is enabled. The pointer can either be enabled statically in the script or from the device itself.
visual_feedback: Optional attribute; read/write access; type: b
Enable or disable visual feedback.
clipboard_peer: Optional attribute; read/write access; type: o|n
Clipboard peer object.
raise_window: Pseudo attribute; write-only access; type: b
By writing any value to this attribute, the graphics 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.
restore_window_size: Pseudo attribute; write-only access; type: b
By writing any value to this attribute, the graphics console window size will be restored to the size set by the simulation.

Provided By

x11-console