Struct simics_api_sys::text_console_backend_interface

#[repr(C)]
pub struct text_console_backend_interface {
    pub input: Option<unsafe extern "C" fn(obj: *mut conf_object_t, key: text_console_key_t, modifiers: text_console_modifier_t)>,
    pub request_refresh: Option<unsafe extern "C" fn(obj: *mut conf_object_t)>,
    pub set_visible: Option<unsafe extern "C" fn(obj: *mut conf_object_t, visible: bool)>,
    pub line_length: Option<unsafe extern "C" fn(obj: *mut conf_object_t, line_num: c_int) -> c_int>,
    pub line_wrap: Option<unsafe extern "C" fn(obj: *mut conf_object_t, line_num: c_int) -> bool>,
    pub set_size: Option<unsafe extern "C" fn(obj: *mut conf_object_t, width: c_int, height: c_int)>,
    pub set_default_colours: Option<unsafe extern "C" fn(obj: *mut conf_object_t, default_fg_col: uint32, default_bg_col: uint32)>,
}

Fields

input: Option<unsafe extern "C" fn(obj: *mut conf_object_t, key: text_console_key_t, modifiers: text_console_modifier_t)>

Send a key press to the backend.

request_refresh: Option<unsafe extern "C" fn(obj: *mut conf_object_t)>

Request that the backend should refresh the whole console screen. Shortly after this call, the frontend can expect a call to text_console_frontend.refresh_screen.

set_visible: Option<unsafe extern "C" fn(obj: *mut conf_object_t, visible: bool)>

Indicate to the backend whether the frontend is visible, e.g. if the console window is hidden by other windows or minimised. The backend may then choose not to call any text or cursor update functions in the text_console_frontend interface.

line_length: Option<unsafe extern "C" fn(obj: *mut conf_object_t, line_num: c_int) -> c_int>

Returns 1 + the maximum column on the given line with a printable character. The frontend may use this information for e.g. user marking and copying text. line_num is 0-based and indexes over the screen for positive values and negative values to indicate scrollback lines.

line_wrap: Option<unsafe extern "C" fn(obj: *mut conf_object_t, line_num: c_int) -> bool>

Indicate whether the specified line was not finished with an explicit carriage return by the user, and hence wraps to the next line. The frontend may use this information for e.g. user marking and copying text. line_num is 0-based and indexes over the screen for positive values and negative values to indicate scrollback lines.

set_size: Option<unsafe extern "C" fn(obj: *mut conf_object_t, width: c_int, height: c_int)>

Tell the console to change the screen size. Note that this is visible to the target software this call therefore impacts the simulation. An immediate call to text_console_frontend.set_size will follow a call to this function.

set_default_colours: Option<unsafe extern "C" fn(obj: *mut conf_object_t, default_fg_col: uint32, default_bg_col: uint32)>

Tell the console to change the default text colours. An immediate call to text_console_frontend.set_default_colours will follow a call to this function.

Trait Implementations

impl Clone for text_console_backend_interface

fn clone(&self) -> text_console_backend_interface

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for text_console_backend_interface

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for text_console_backend_interface

fn default() -> text_console_backend_interface

Returns the “default value” for a type.

impl Hash for text_console_backend_interface

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for text_console_backend_interface

fn cmp(&self, other: &text_console_backend_interface) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for text_console_backend_interface

fn eq(&self, other: &text_console_backend_interface) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for text_console_backend_interface

fn partial_cmp( &self, other: &text_console_backend_interface, ) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for text_console_backend_interface

impl Eq for text_console_backend_interface

impl StructuralPartialEq for text_console_backend_interface