package inquire

  1. Overview
  2. Docs
An OCaml library to create beautiful interactive CLIs

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (5)

Authors

  1. Thibaut Mattio

Maintainers

  1. Thibaut Mattio

Sources

inquire-0.2.1.tbz
sha256=0b88d89e24d4cbc0560a7c8d8ec51388990e1b27f24685029997afa52a7c720f
sha512=8b62860a8d15e41528a404a6f1b9968c3d79755607b5ea319af2e3e45516e672a785361d278279910928db4054e1800e87bcee0210ff3eabfb330713b368c827

doc/inquire.lambda-term/LTerm_windows/index.html

Module LTerm_windows

Windows specific functions

All these functions return Lwt_sys.Not_available on Unix.

Codepage functions
val get_acp : unit -> int

Returns the current ANSI codepage.

val get_console_cp : unit -> int

Returns the input codepage used by the console attached to the current process.

val set_console_cp : int -> unit

Sets the input codepage used by the console attached to the current process.

val get_console_output_cp : unit -> int

Returns the output codepage used by the console attached to the current process.

val set_console_output_cp : int -> unit

Sets the output codepage used by the console attached to the current process.

Console input
type input =
  1. | Resize
  2. | Key of LTerm_key.t
  3. | Mouse of LTerm_mouse.t
val read_console_input : Lwt_unix.file_descr -> input Lwt.t

read_console_input fd reads one input from the given file descriptor.

Console info
type text_attributes = {
  1. foreground : int;
    (*

    The foreground color. Only bits 0 to 3 matters, other are ignored.

    *)
  2. background : int;
    (*

    The background color. Only bits 0 to 3 matters, other are ignored.

    *)
}

Type of text attributes.

type console_screen_buffer_info = {
  1. size : LTerm_geom.size;
    (*

    The size of the console buffer.

    *)
  2. cursor_position : LTerm_geom.coord;
    (*

    The line and column of the cursor.

    *)
  3. attributes : text_attributes;
    (*

    Text attributes.

    *)
  4. window : LTerm_geom.rect;
    (*

    The displayed windows in the console buffer.

    *)
  5. maximum_window_size : LTerm_geom.size;
    (*

    The maximum window size for the current screen.

    *)
}

Type of informations about a console.

val get_console_screen_buffer_info : Lwt_unix.file_descr -> console_screen_buffer_info

get_console_screen_buffer_info fd returns the current informations about the given console.

Console modes
type console_mode = {
  1. cm_echo_input : bool;
  2. cm_insert_mode : bool;
  3. cm_line_input : bool;
  4. cm_mouse_input : bool;
  5. cm_processed_input : bool;
  6. cm_quick_edit_mode : bool;
  7. cm_window_input : bool;
}

Console modes.

val get_console_mode : Lwt_unix.file_descr -> console_mode

Returns the mode of the given console.

val set_console_mode : Lwt_unix.file_descr -> console_mode -> unit

Sets the mode of the given console.

Console cursor
val get_console_cursor_info : Lwt_unix.file_descr -> int * bool

Returns the size and visible status of the cursor on the given console. The size is a percentage between 1 and 100.

val set_console_cursor_info : Lwt_unix.file_descr -> int -> bool -> unit

set_console_cursor_info fd size visible sets the size and visible status of the cursor on the given console.

val set_console_cursor_position : Lwt_unix.file_descr -> LTerm_geom.coord -> unit

Move the cursor to the specified location in the screen buffer.

Text attributes
val set_console_text_attribute : Lwt_unix.file_descr -> text_attributes -> unit

set_console_text_attribute fd attributes

Rendering
type char_info = {
  1. ci_char : Zed_char.t;
    (*

    The unicode character.

    *)
  2. ci_foreground : int;
    (*

    The foreground color.

    *)
  3. ci_background : int;
    (*

    The background color.

    *)
}

write_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 -> int

fill_console_output_character fd char count coord writes count times char starting at coord on the given console.