Index of values

A
add [Terminal]

add a s returns a set containing all elements of s plus a.

alt [Terminal]
B
black [Terminal]
blue [Terminal]
buffered_in [Terminal]

Return the size of the buffered contents of a given input channel that has not been read yet.

buffered_line_in [Terminal]

Return the size of the buffered contents of a given input channel that has not been read yet, from current position until '\n'.

button_of_event [Terminal]

Return the clicked mouse button of a given event.

C
char_of_event [Terminal]

Return the char of a given event.

clear_eol [Terminal.Descr]
clear_eol [Terminal]

clear_eol oc () clears from the cursor position to the end of the line.

clear_line [Terminal.Descr]
clear_line [Terminal]

clear_line oc () is a combination of move_to_bol oc () and clear_eol oc ().

clear_screen [Terminal.Descr]
clear_screen [Terminal]

clear_screen oc () clears all of a given screen buffer.

color [Terminal.Descr]
color [Terminal]

color oc ~reset ~bold ~underscore ~blink ~reverse ~concealed ~foreground ~background () sets the color for writing.

control [Terminal]
cyan [Terminal]
D
dark_blue [Terminal]
dark_cyan [Terminal]
dark_gray [Terminal]
dark_green [Terminal]
dark_magenta [Terminal]
dark_red [Terminal]
dark_yellow [Terminal]
E
empty [Terminal]

The empty set.

escape_sequence_of_event [Terminal]

Represent a given event as escape sequence.

G
gray [Terminal]
grayscale [Terminal]

The grayscale colors.

green [Terminal]
I
input [Terminal.Descr]

Same as Unix.read.

input_event [Terminal.Descr]

Read one event from a given file descriptor.

input_line_utf8 [Terminal.Descr]
input_line_utf8 [Terminal]

Read from a given input channel until a newline.

is_char [Terminal]

Check whether a given event contains some char or not.

is_clicked [Terminal]

Check whether a given event means some mouse button is clicked.

is_empty [Terminal.Descr]

Check whether a given file descriptor is empty or having any events.

is_key [Terminal]

Check whether a given event contains some key or not.

is_resized [Terminal]

Check whether a given event means the terminal window has been resized.

is_string [Terminal]

Check whether a given event contains some string(non-escape sequence) or not.

is_terminal [Terminal.Descr]

Same as Unix.isatty.

is_terminal_in [Terminal]

is_terminal_in ic returns true if a given input channel is associated to the terminal.

is_terminal_out [Terminal]

is_terminal_out oc returns true if a given output channel is associated to the terminal.

K
key_of_event [Terminal]

Return the key of a given event.

L
locale_of_utf8 [Terminal]

In windows, encode a string from UTF-8 to the active code page.

M
magenta [Terminal]
mem [Terminal]

mem a s is true if a is included in s.

meta [Terminal]
mode [Terminal.Descr]
mode [Terminal]

mode ic ~echo ~canonical ~control_c ~mouse f saves, changes, and restores the mode of a given input channel.

move [Terminal.Descr]
move [Terminal]

move oc x y moves the cursor in relative coordinates from the current position.

move_to_bol [Terminal.Descr]
move_to_bol [Terminal]

move_to_bol oc () moves the cursor to the beginning of the line.

O
output [Terminal.Descr]

Same as Unix.write, but the returned type is unit.

output_newline [Terminal.Descr]

Write "\n" (in POSIX) or "\r\n" (in Windows).

output_string [Terminal.Descr]

Same as output_substring fd s 0 (String.length s).

output_string_utf8 [Terminal.Descr]
output_string_utf8 [Terminal]

Write a UTF-8 encoded string to a given output channel.

output_substring [Terminal.Descr]

Same as output but take a string instead of a bytes.

output_substring_utf8 [Terminal.Descr]
output_substring_utf8 [Terminal]

Write a part of a UTF-8 encoded string to a given output channel.

P
position [Terminal.Descr]
position [Terminal]

position oc gets the cursor position in absolute coordinates.

position_of_event [Terminal]

Return the pointed position of a given event.

R
red [Terminal]
rgb [Terminal]

The RGB colors.

S
save [Terminal.Descr]
save [Terminal]

save oc f saves and restores the current position and the color.

screen [Terminal.Descr]
screen [Terminal]

screen oc ~size ~cursor ~wrap f saves the current screen buffer, uses new screen buffer, and restores it.

scroll [Terminal.Descr]
scroll [Terminal]

scroll oc y scrolls the contents in the current view port.

set_position [Terminal.Descr]
set_position [Terminal]

set_position oc x y moves the cursor in absolute coordinates.

set_size [Terminal.Descr]
set_size [Terminal]

set_size oc width height sets the size of the current screen buffer.

shift [Terminal]
shift_of_event [Terminal]

Return the shift state of a given event.

show_cursor [Terminal.Descr]
show_cursor [Terminal]

show_cursor oc flag show or hide the cursor.

size [Terminal.Descr]
size [Terminal]

size oc gets the size of the current screen buffer.

size_of_event [Terminal]

Return the new window size of a given event.

string_of_event [Terminal]

Return the string of a given event.

supports_256 [Terminal]

Check whether the terminal supports 256 color.

system_16 [Terminal]

The 16 system colors.

T
title [Terminal]

title t f saves the old window title, sets it to a given string t, and restores it.

title_utf8 [Terminal]

title_utf8 t f saves the old window title, sets it to a given UTF-8 encoded string t, and restores it.

U
utf8_of_locale [Terminal]

In windows, encode a string from the active code page to UTF-8.

V
view [Terminal.Descr]
view [Terminal]

view oc gets the range of the current view port that is a part of the current screen buffer.

W
white [Terminal]
wrap [Terminal.Descr]
wrap [Terminal]

wrap oc flag enables or disables line wrapping.

Y
yellow [Terminal]