package lambda-term
Install
Dune Dependency
Authors
Maintainers
Sources
sha512=78648768644058337e22c79cf1fbb1a36472b24f11b1dc0461fc38419be6ec01b02d8d0ac45fed0bc99f91ba4c0f19d3bda113e834e064bee973b734527b9766
doc/lambda-term/LTerm_windows/index.html
Module LTerm_windowsSource
Windows specific functions
All these functions return Lwt_sys.Not_available on Unix.
Codepage functions
Returns the current ANSI codepage.
Returns the input codepage used by the console attached to the current process.
Sets the input codepage used by the console attached to the current process.
Returns the output codepage used by the console attached to the current process.
Sets the output codepage used by the console attached to the current process.
Console input
read_console_input fd reads one input from the given file descriptor.
Console info
type text_attributes = {foreground : int;(*The foreground color. Only bits 0 to 3 matters, other are ignored.
*)background : int;(*The background color. Only bits 0 to 3 matters, other are ignored.
*)
}Type of text attributes.
type console_screen_buffer_info = {size : LTerm_geom.size;(*The size of the console buffer.
*)cursor_position : LTerm_geom.coord;(*The line and column of the cursor.
*)attributes : text_attributes;(*Text attributes.
*)window : LTerm_geom.rect;(*The displayed windows in the console buffer.
*)maximum_window_size : LTerm_geom.size;(*The maximum window size for the current screen.
*)
}Type of informations about a console.
get_console_screen_buffer_info fd returns the current informations about the given console.
Console modes
type console_mode = {cm_echo_input : bool;cm_insert_mode : bool;cm_line_input : bool;cm_mouse_input : bool;cm_processed_input : bool;cm_quick_edit_mode : bool;cm_window_input : bool;
}Console modes.
Returns the mode of the given console.
Sets the mode of the given console.
Console cursor
Returns the size and visible status of the cursor on the given console. The size is a percentage between 1 and 100.
set_console_cursor_info fd size visible sets the size and visible status of the cursor on the given console.
Move the cursor to the specified location in the screen buffer.
Text attributes
set_console_text_attribute fd attributes
Rendering
type char_info = {ci_char : Zed_char.t;(*The unicode character.
*)ci_foreground : int;(*The foreground color.
*)ci_background : int;(*The background color.
*)
}val write_console_output :
Lwt_unix.file_descr ->
char_info array array ->
LTerm_geom.size ->
LTerm_geom.coord ->
LTerm_geom.rect ->
LTerm_geom.rectwrite_console_output fd chars size coord rect writes the given matrix of characters with their attributes on the given console at given position.
val fill_console_output_character :
Lwt_unix.file_descr ->
Uchar.t ->
int ->
LTerm_geom.coord ->
intfill_console_output_character fd char count coord writes count times char starting at coord on the given console.