Module: Curses
- Defined in:
- ext/curses/curses.c,
ext/curses/curses.c
Overview
Description
An implementation of the CRT screen handling and optimization library.
Structures and such
Classes
-
Curses::Window - class with the means to draw a window or box
-
Curses::MouseEvent - class for collecting mouse events
Modules
- Curses
-
The curses implementation
- Curses::Key
-
Collection of constants for keypress events
Examples
-
hello.rb
:include: sample/hello.rb
-
rain.rb
:include: sample/rain.rb
Defined Under Namespace
Modules: Key Classes: MouseEvent, Pad, Window
Constant Summary collapse
- VERSION =
Identifies curses library version.
-
“ncurses 5.9.20110404”
-
“PDCurses 3.4 - Public Domain 2008”
-
“curses (SVR4)” (System V curses)
-
“curses (unknown)” (The original BSD curses? NetBSD maybe.)
-
version
Class Method Summary collapse
-
.addch(ch) ⇒ Object
Add a character
ch
, with attributes, then advance the cursor. -
.addstr(str) ⇒ Object
add a string of characters
str
, to the window and advance cursor. -
.assume_default_colors(fg, bg) ⇒ Object
tells which colors to paint for color pair 0.
-
.attroff(attrs) ⇒ Object
Turns off the named attributes
attrs
without affecting any others. -
.attron(attrs) ⇒ Object
Turns on the named attributes
attrs
without turning any other attributes on or off. -
.attrset(attrs) ⇒ Object
Sets the current attributes of the given window to
attrs
. -
.beep ⇒ Object
Sounds an audible alarm on the terminal, if possible; otherwise it flashes the screen (visual bell).
-
.bkgd(ch) ⇒ Object
Window background manipulation routines.
-
.bkgdset(ch) ⇒ Object
Manipulate the background of the named window with character Integer
ch
. -
.can_change_color? ⇒ Boolean
Returns
true
orfalse
depending on whether the terminal can change color attributes. -
.cbreak ⇒ Object
Put the terminal into cbreak mode.
-
.clear ⇒ Object
Clears every position on the screen completely, so that a subsequent call by Curses.refresh for the screen/window will be repainted from scratch.
-
.close_screen ⇒ Object
A program should always call Curses.close_screen before exiting or escaping from curses mode temporarily.
-
.closed? ⇒ Boolean
Returns
true
if the window/screen has been closed, without any subsequent Curses.refresh calls, returnsfalse
otherwise. -
.clrtoeol ⇒ Object
Clears to the end of line, that the cursor is currently on.
-
.color_content(color) ⇒ Object
Returns an 3 item Array of the RGB values in
color
. -
.color_pair(attrs) ⇒ Object
Sets the color pair attributes to
attrs
. -
.color_pairs ⇒ Object
Returns the COLOR_PAIRS available, if the curses library supports it.
-
.colors ⇒ Object
returns COLORS.
-
.cols ⇒ Object
Returns the number of columns on the screen.
-
.crmode ⇒ Object
Put the terminal into cbreak mode.
-
.curs_set(visibility) ⇒ Object
Sets Cursor Visibility.
-
.def_prog_mode ⇒ Object
Save the current terminal modes as the “program” state for use by the Curses.reset_prog_mode.
-
.delch ⇒ Object
Delete the character under the cursor.
-
.deleteln ⇒ Object
Delete the line under the cursor.
-
.doupdate ⇒ Object
Refreshes the windows and lines.
-
.echo ⇒ Object
Enables characters typed by the user to be echoed by Curses.getch as they are typed.
-
.erase ⇒ Object
Erase the screen.
-
.ESCDELAY ⇒ Object
Returns the total time, in milliseconds, for which curses will await a character sequence, e.g., a function key.
-
.ESCDELAY=(value) ⇒ Object
Sets the ESCDELAY to Integer
value
. -
.flash ⇒ Object
Flashes the screen, for visual alarm on the terminal, if possible; otherwise it sounds the alert.
-
.get_char ⇒ Object
Read and returns a character or function key from the window.
-
.getch ⇒ Object
Read and returns a character from the window.
-
.getmouse ⇒ Object
Returns coordinates of the mouse.
-
.getstr ⇒ Object
This is equivalent to a series f Curses::Window.getch calls.
-
.has_colors? ⇒ Boolean
Returns
true
orfalse
depending on whether the terminal has color capabilities. -
.inch ⇒ Object
Returns the character at the current position.
-
.init_color(color, r, g, b) ⇒ Object
Changes the definition of a color.
-
.init_pair(pair, f, b) ⇒ Object
Changes the definition of a color-pair.
-
.init_screen ⇒ Object
Initialize a standard screen.
-
.insch(ch) ⇒ Object
Insert a character
ch
, before the cursor. -
.insertln ⇒ Object
Inserts a line above the cursor, and the bottom line is lost.
-
.keyboard_encoding ⇒ Object
Returns the encoding for keyboard input.
-
.keyboard_encoding=(encoding) ⇒ Object
Sets the encoding for keyboard input.
-
.keyname(c) ⇒ Object
Returns the character string corresponding to key
c
. -
.lines ⇒ Object
Returns the number of lines on the screen.
-
.mouseinterval(interval) ⇒ Object
The Curses.mouseinterval function sets the maximum time (in thousands of a second) that can elapse between press and release events for them to be recognized as a click.
-
.mousemask(mask) ⇒ Object
Returns the
mask
of the reportable events. -
.nl ⇒ Object
Enable the underlying display device to translate the return key into newline on input, and whether it translates newline into return and line-feed on output (in either case, the call Curses.addch(‘n’) does the equivalent of return and line feed on the virtual screen).
-
.nocbreak ⇒ Object
Put the terminal into normal mode (out of cbreak mode).
-
.nocrmode ⇒ Object
Put the terminal into normal mode (out of cbreak mode).
-
.noecho ⇒ Object
Disables characters typed by the user to be echoed by Curses.getch as they are typed.
-
.nonl ⇒ Object
Disable the underlying display device to translate the return key into newline on input.
-
.noraw ⇒ Object
Put the terminal out of raw mode.
-
.pair_content(pair) ⇒ Object
Returns a 2 item Array, with the foreground and background color, in
pair
. -
.pair_number(attrs) ⇒ Object
Returns the Fixnum color pair number of attributes
attrs
. -
.raw ⇒ Object
Put the terminal into raw mode.
-
.refresh ⇒ Object
Refreshes the windows and lines.
-
.reset_prog_mode ⇒ Object
Reset the current terminal modes to the saved state by the Curses.def_prog_mode.
-
.resizeterm(lines, cols) ⇒ Object
Resize the current term to Fixnum
lines
and Fixnumcols
. -
.resizeterm(lines, cols) ⇒ Object
Resize the current term to Fixnum
lines
and Fixnumcols
. -
.scrl(num) ⇒ Object
Scrolls the current window Fixnum
num
lines. -
.setpos(y, x) ⇒ Object
A setter for the position of the cursor, using coordinates
x
andy
. -
.setscrreg(top, bottom) ⇒ Object
call-seq: setscrreg(top, bottom).
-
.standend ⇒ Object
Enables the Normal display (no highlight).
-
.standout ⇒ Object
Enables the best highlighting mode of the terminal.
-
.start_color ⇒ Object
Initializes the color attributes, for terminals that support it.
-
.stdscr ⇒ Object
The Standard Screen.
-
.TABSIZE ⇒ Object
Returns the number of positions in a tab.
-
.TABSIZE=(value) ⇒ Object
Sets the TABSIZE to Integer
value
. -
.terminal_encoding ⇒ Object
Returns the encoding for terminal output.
-
.terminal_encoding=(encoding) ⇒ Object
Sets the encoding for terminal output.
-
.timeout=(delay) ⇒ Object
Sets block and non-blocking reads for the window.
-
.unget_char(ch) ⇒ Object
Places
ch
back onto the input queue to be returned by the next call to Curses.get_char etc. -
.ungetch(ch) ⇒ Object
Places
ch
back onto the input queue to be returned by the next call to Curses.getch. -
.ungetmouse(mevent) ⇒ Object
It pushes a KEY_MOUSE event onto the input queue, and associates with that event the given state data and screen-relative character-cell coordinates.
-
.use_default_colors ⇒ Object
tells the curses library to use terminal’s default colors.
Class Method Details
.addch(ch) ⇒ Object
Add a character ch
, with attributes, then advance the cursor.
see also the system manual for curs_addch(3)
617 618 619 620 621 622 623 |
# File 'ext/curses/curses.c', line 617
static VALUE
curses_addch(VALUE obj, VALUE ch)
{
curses_stdscr();
addch(NUM2CH(ch));
return Qnil;
}
|
.addstr(str) ⇒ Object
add a string of characters str
, to the window and advance cursor
647 648 649 650 651 652 653 654 655 656 657 |
# File 'ext/curses/curses.c', line 647
static VALUE
curses_addstr(VALUE obj, VALUE str)
{
StringValue(str);
str = rb_str_export_to_enc(str, terminal_encoding);
curses_stdscr();
if (!NIL_P(str)) {
addstr(StringValueCStr(str));
}
return Qnil;
}
|
.assume_default_colors(fg, bg) ⇒ Object
tells which colors to paint for color pair 0.
see also the system manual for default_colors(3)
1007 1008 1009 1010 1011 1012 1013 |
# File 'ext/curses/curses.c', line 1007
static VALUE
curses_assume_default_colors(VALUE obj, VALUE fg, VALUE bg)
{
curses_stdscr();
assume_default_colors(NUM2INT(fg), NUM2INT(bg));
return Qnil;
}
|
.attroff(attrs) ⇒ Object
Turns off the named attributes attrs
without affecting any others.
See also Curses::Window.attrset for additional information.
897 898 899 900 901 902 903 |
# File 'ext/curses/curses.c', line 897
static VALUE
curses_attroff(VALUE obj, VALUE attrs)
{
curses_stdscr();
return window_attroff(rb_stdscr,attrs);
/* return INT2FIX(attroff(NUM2INT(attrs))); */
}
|
.attron(attrs) ⇒ Object
Turns on the named attributes attrs
without turning any other attributes on or off.
See also Curses::Window.attrset for additional information.
914 915 916 917 918 919 920 |
# File 'ext/curses/curses.c', line 914
static VALUE
curses_attron(VALUE obj, VALUE attrs)
{
curses_stdscr();
return window_attron(rb_stdscr,attrs);
/* return INT2FIX(attroff(NUM2INT(attrs))); */
}
|
.attrset(attrs) ⇒ Object
Sets the current attributes of the given window to attrs
.
see also Curses::Window.attrset
931 932 933 934 935 936 937 |
# File 'ext/curses/curses.c', line 931
static VALUE
curses_attrset(VALUE obj, VALUE attrs)
{
curses_stdscr();
return window_attrset(rb_stdscr,attrs);
/* return INT2FIX(attroff(NUM2INT(attrs))); */
}
|
.beep ⇒ Object
Sounds an audible alarm on the terminal, if possible; otherwise it flashes the screen (visual bell).
see also Curses.flash
476 477 478 479 480 481 482 483 484 |
# File 'ext/curses/curses.c', line 476
static VALUE
curses_beep(VALUE obj)
{
#ifdef HAVE_BEEP
curses_stdscr();
beep();
#endif
return Qnil;
}
|
.bkgd(ch) ⇒ Object
Window background manipulation routines.
Set the background property of the current and then apply the character Integer ch
setting to every character position in that window.
see also the system manual for curs_bkgd(3)
973 974 975 976 977 978 979 980 981 982 |
# File 'ext/curses/curses.c', line 973
static VALUE
curses_bkgd(VALUE obj, VALUE ch)
{
#ifdef HAVE_BKGD
curses_stdscr();
return (bkgd(NUM2ULONG(ch)) == OK) ? Qtrue : Qfalse;
#else
return Qfalse;
#endif
}
|
.bkgdset(ch) ⇒ Object
Manipulate the background of the named window with character Integer ch
The background becomes a property of the character and moves with the character through any scrolling and insert/delete line/character operations.
see also the system manual for curs_bkgd(3)
952 953 954 955 956 957 958 959 960 |
# File 'ext/curses/curses.c', line 952
static VALUE
curses_bkgdset(VALUE obj, VALUE ch)
{
#ifdef HAVE_BKGDSET
curses_stdscr();
bkgdset(NUM2ULONG(ch));
#endif
return Qnil;
}
|
.can_change_color? ⇒ Boolean
Returns true
or false
depending on whether the terminal can change color attributes
1185 1186 1187 1188 1189 1190 |
# File 'ext/curses/curses.c', line 1185
static VALUE
curses_can_change_color(VALUE obj)
{
curses_stdscr();
return can_change_color() ? Qtrue : Qfalse;
}
|
.cbreak ⇒ Object
Put the terminal into cbreak mode.
Normally, the tty driver buffers typed characters until a newline or carriage return is typed. The Curses.cbreak routine disables line buffering and erase/kill character-processing (interrupt and flow control characters are unaffected), making characters typed by the user immediately available to the program.
The Curses.nocbreak routine returns the terminal to normal (cooked) mode.
Initially the terminal may or may not be in cbreak mode, as the mode is inherited; therefore, a program should call Curses.cbreak or Curses.nocbreak explicitly. Most interactive programs using curses set the cbreak mode. Note that Curses.cbreak overrides Curses.raw.
see also Curses.raw
407 408 409 410 411 412 413 |
# File 'ext/curses/curses.c', line 407
static VALUE
curses_cbreak(VALUE obj)
{
curses_stdscr();
cbreak();
return Qnil;
}
|
.clear ⇒ Object
Clears every position on the screen completely, so that a subsequent call by Curses.refresh for the screen/window will be repainted from scratch.
248 249 250 251 252 253 254 |
# File 'ext/curses/curses.c', line 248
static VALUE
curses_clear(VALUE obj)
{
curses_stdscr();
wclear(stdscr);
return Qnil;
}
|
.close_screen ⇒ Object
A program should always call Curses.close_screen before exiting or escaping from curses mode temporarily. This routine restores tty modes, moves the cursor to the lower left-hand corner of the screen and resets the terminal into the proper non-visual mode.
Calling Curses.refresh or Curses.doupdate after a temporary escape causes the program to resume visual mode.
188 189 190 191 192 193 194 195 196 197 198 |
# File 'ext/curses/curses.c', line 188
static VALUE
curses_close_screen(void)
{
curses_stdscr();
#ifdef HAVE_ISENDWIN
if (!isendwin())
#endif
endwin();
rb_stdscr = 0;
return Qnil;
}
|
.closed? ⇒ Boolean
Returns true
if the window/screen has been closed, without any subsequent Curses.refresh calls, returns false
otherwise.
228 229 230 231 232 233 234 235 236 |
# File 'ext/curses/curses.c', line 228
static VALUE
curses_closed(void)
{
curses_stdscr();
if (isendwin()) {
return Qtrue;
}
return Qfalse;
}
|
.clrtoeol ⇒ Object
Clears to the end of line, that the cursor is currently on.
278 279 280 281 282 283 284 |
# File 'ext/curses/curses.c', line 278
static VALUE
curses_clrtoeol(void)
{
curses_stdscr();
clrtoeol();
return Qnil;
}
|
.color_content(color) ⇒ Object
Returns an 3 item Array of the RGB values in color
1213 1214 1215 1216 1217 1218 1219 1220 1221 |
# File 'ext/curses/curses.c', line 1213
static VALUE
curses_color_content(VALUE obj, VALUE color)
{
short r,g,b;
curses_stdscr();
color_content(NUM2INT(color),&r,&g,&b);
return rb_ary_new3(3,INT2FIX(r),INT2FIX(g),INT2FIX(b));
}
|
.color_pair(attrs) ⇒ Object
Sets the color pair attributes to attrs
.
This should be equivalent to Curses.attrset(COLOR_PAIR(attrs
))
TODO: validate that equivalency
1266 1267 1268 1269 1270 |
# File 'ext/curses/curses.c', line 1266
static VALUE
curses_color_pair(VALUE obj, VALUE attrs)
{
return INT2FIX(COLOR_PAIR(NUM2INT(attrs)));
}
|
.color_pairs ⇒ Object
Returns the COLOR_PAIRS available, if the curses library supports it.
1230 1231 1232 1233 1234 |
# File 'ext/curses/curses.c', line 1230
static VALUE
curses_color_pairs(VALUE obj)
{
return INT2FIX(COLOR_PAIRS);
}
|
.colors ⇒ Object
returns COLORS
1198 1199 1200 1201 1202 |
# File 'ext/curses/curses.c', line 1198
static VALUE
curses_colors(VALUE obj)
{
return INT2FIX(COLORS);
}
|
.cols ⇒ Object
Returns the number of columns on the screen
810 811 812 813 814 |
# File 'ext/curses/curses.c', line 810
static VALUE
curses_cols(void)
{
return INT2FIX(COLS);
}
|
.crmode ⇒ Object
Put the terminal into cbreak mode.
Normally, the tty driver buffers typed characters until a newline or carriage return is typed. The Curses.cbreak routine disables line buffering and erase/kill character-processing (interrupt and flow control characters are unaffected), making characters typed by the user immediately available to the program.
The Curses.nocbreak routine returns the terminal to normal (cooked) mode.
Initially the terminal may or may not be in cbreak mode, as the mode is inherited; therefore, a program should call Curses.cbreak or Curses.nocbreak explicitly. Most interactive programs using curses set the cbreak mode. Note that Curses.cbreak overrides Curses.raw.
see also Curses.raw
407 408 409 410 411 412 413 |
# File 'ext/curses/curses.c', line 407
static VALUE
curses_cbreak(VALUE obj)
{
curses_stdscr();
cbreak();
return Qnil;
}
|
.curs_set(visibility) ⇒ Object
Sets Cursor Visibility. 0: invisible 1: visible 2: very visible
825 826 827 828 829 830 831 832 833 834 835 |
# File 'ext/curses/curses.c', line 825
static VALUE
curses_curs_set(VALUE obj, VALUE visibility)
{
#ifdef HAVE_CURS_SET
int n;
curses_stdscr();
return (n = curs_set(NUM2INT(visibility)) != ERR) ? INT2FIX(n) : Qnil;
#else
return Qnil;
#endif
}
|
.def_prog_mode ⇒ Object
Save the current terminal modes as the “program” state for use by the Curses.reset_prog_mode
This is done automatically by Curses.init_screen
1476 1477 1478 1479 1480 1481 |
# File 'ext/curses/curses.c', line 1476
static VALUE
curses_def_prog_mode(VALUE obj)
{
curses_stdscr();
return def_prog_mode() == OK ? Qtrue : Qfalse;
}
|
.delch ⇒ Object
Delete the character under the cursor
728 729 730 731 732 733 734 |
# File 'ext/curses/curses.c', line 728
static VALUE
curses_delch(VALUE obj)
{
curses_stdscr();
delch();
return Qnil;
}
|
.deleteln ⇒ Object
Delete the line under the cursor.
742 743 744 745 746 747 748 749 750 |
# File 'ext/curses/curses.c', line 742
static VALUE
curses_deleteln(VALUE obj)
{
curses_stdscr();
#if defined(HAVE_DELETELN) || defined(deleteln)
deleteln();
#endif
return Qnil;
}
|
.doupdate ⇒ Object
Refreshes the windows and lines.
Curses.doupdate allows multiple updates with more efficiency than Curses.refresh alone.
308 309 310 311 312 313 314 315 316 317 318 |
# File 'ext/curses/curses.c', line 308
static VALUE
curses_doupdate(VALUE obj)
{
curses_stdscr();
#ifdef HAVE_DOUPDATE
doupdate();
#else
refresh();
#endif
return Qnil;
}
|
.echo ⇒ Object
Enables characters typed by the user to be echoed by Curses.getch as they are typed.
326 327 328 329 330 331 332 |
# File 'ext/curses/curses.c', line 326
static VALUE
curses_echo(VALUE obj)
{
curses_stdscr();
echo();
return Qnil;
}
|
.erase ⇒ Object
Erase the screen.
262 263 264 265 266 267 268 |
# File 'ext/curses/curses.c', line 262
static VALUE
curses_erase(VALUE obj)
{
curses_stdscr();
werase(stdscr);
return Qnil;
}
|
.ESCDELAY ⇒ Object
Returns the total time, in milliseconds, for which curses will await a character sequence, e.g., a function key
1069 1070 1071 1072 1073 |
# File 'ext/curses/curses.c', line 1069
static VALUE
curses_escdelay_get(VALUE obj)
{
return INT2NUM(ESCDELAY);
}
|
.ESCDELAY=(value) ⇒ Object
Sets the ESCDELAY to Integer value
1054 1055 1056 1057 1058 1059 |
# File 'ext/curses/curses.c', line 1054
static VALUE
curses_escdelay_set(VALUE obj, VALUE val)
{
ESCDELAY = NUM2INT(val);
return INT2NUM(ESCDELAY);
}
|
.flash ⇒ Object
Flashes the screen, for visual alarm on the terminal, if possible; otherwise it sounds the alert.
see also Curses.beep
494 495 496 497 498 499 500 501 502 |
# File 'ext/curses/curses.c', line 494
static VALUE
curses_flash(VALUE obj)
{
#ifdef HAVE_FLASH
curses_stdscr();
flash();
#endif
return Qnil;
}
|
.get_char ⇒ Object
Read and returns a character or function key from the window. A single or multibyte character is represented by a String, and a function key is represented by an Integer. Returns nil if no input is ready.
See Curses::Key to all the function KEY_* available
2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 |
# File 'ext/curses/curses.c', line 2822
static VALUE
curses_get_char(VALUE obj)
{
#ifdef HAVE_GET_WCH
struct get_wch_arg arg;
curses_stdscr();
rb_thread_call_without_gvl(get_wch_func, &arg, RUBY_UBF_IO, 0);
switch (arg.retval) {
case OK:
return keyboard_uint_chr(arg.ch);
case KEY_CODE_YES:
return UINT2NUM(arg.ch);
}
return Qnil;
#else
int c;
curses_stdscr();
rb_thread_call_without_gvl(getch_func, &c, RUBY_UBF_IO, 0);
if (c > 0xff) {
return INT2NUM(c);
}
else if (c >= 0) {
return keyboard_uint_chr(c);
}
else {
return Qnil;
}
#endif
}
|
.getch ⇒ Object
Read and returns a character from the window.
See Curses::Key to all the function KEY_* available
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 |
# File 'ext/curses/curses.c', line 675
static VALUE
curses_getch(VALUE obj)
{
int c;
curses_stdscr();
rb_thread_call_without_gvl(getch_func, &c, RUBY_UBF_IO, 0);
if (c == EOF) return Qnil;
if (rb_isprint(c)) {
char ch = (char)c;
return rb_external_str_new_with_enc(&ch, 1, keyboard_encoding);
}
return UINT2NUM(c);
}
|
.getmouse ⇒ Object
Returns coordinates of the mouse.
This will read and pop the mouse event data off the queue
See the BUTTON*, ALL_MOUSE_EVENTS and REPORT_MOUSE_POSITION constants, to examine the mask of the event
1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 |
# File 'ext/curses/curses.c', line 1336
static VALUE
curses_getmouse(VALUE obj)
{
struct mousedata *mdata;
VALUE val;
curses_stdscr();
val = TypedData_Make_Struct(cMouseEvent,struct mousedata,
&mousedata_type,mdata);
mdata->mevent = (MEVENT*)xmalloc(sizeof(MEVENT));
return (getmouse(mdata->mevent) == OK) ? val : Qnil;
}
|
.getstr ⇒ Object
This is equivalent to a series f Curses::Window.getch calls
712 713 714 715 716 717 718 719 720 |
# File 'ext/curses/curses.c', line 712
static VALUE
curses_getstr(VALUE obj)
{
char rtn[GETSTR_BUF_SIZE];
curses_stdscr();
rb_thread_call_without_gvl(getstr_func, rtn, RUBY_UBF_IO, 0);
return rb_external_str_new_with_enc(rtn, strlen(rtn), keyboard_encoding);
}
|
.has_colors? ⇒ Boolean
Returns true
or false
depending on whether the terminal has color capabilities.
1173 1174 1175 1176 1177 1178 |
# File 'ext/curses/curses.c', line 1173
static VALUE
curses_has_colors(VALUE obj)
{
curses_stdscr();
return has_colors() ? Qtrue : Qfalse;
}
|
.inch ⇒ Object
Returns the character at the current position.
602 603 604 605 606 607 |
# File 'ext/curses/curses.c', line 602
static VALUE
curses_inch(VALUE obj)
{
curses_stdscr();
return CH2FIX(inch());
}
|
.init_color(color, r, g, b) ⇒ Object
Changes the definition of a color. It takes four arguments:
-
the number of the color to be changed,
color
-
the amount of red,
r
-
the amount of green,
g
-
the amount of blue,
b
The value of the first argument must be between 0 and COLORS. (See the section Colors for the default color index.) Each of the last three arguments must be a value between 0 and 1000. When Curses.init_color is used, all occurrences of that color on the screen immediately change to the new definition.
1159 1160 1161 1162 1163 1164 1165 1166 |
# File 'ext/curses/curses.c', line 1159
static VALUE
curses_init_color(VALUE obj, VALUE color, VALUE r, VALUE g, VALUE b)
{
/* may have to raise exception on ERR */
curses_stdscr();
return (init_color(NUM2INT(color),NUM2INT(r),
NUM2INT(g),NUM2INT(b)) == OK) ? Qtrue : Qfalse;
}
|
.init_pair(pair, f, b) ⇒ Object
Changes the definition of a color-pair.
It takes three arguments: the number of the color-pair to be changed pair
, the foreground color number f
, and the background color number b
.
If the color-pair was previously initialized, the screen is refreshed and all occurrences of that color-pair are changed to the new definition.
1135 1136 1137 1138 1139 1140 1141 |
# File 'ext/curses/curses.c', line 1135
static VALUE
curses_init_pair(VALUE obj, VALUE pair, VALUE f, VALUE b)
{
/* may have to raise exception on ERR */
curses_stdscr();
return (init_pair(NUM2INT(pair),NUM2INT(f),NUM2INT(b)) == OK) ? Qtrue : Qfalse;
}
|
.init_screen ⇒ Object
Initialize a standard screen
see also Curses.stdscr
150 151 152 153 154 155 156 157 158 159 160 161 |
# File 'ext/curses/curses.c', line 150
static VALUE
curses_init_screen(void)
{
if (rb_stdscr) return rb_stdscr;
initscr();
if (stdscr == 0) {
rb_raise(rb_eRuntimeError, "can't initialize curses");
}
clear();
rb_stdscr = prep_window(cWindow, stdscr);
return rb_stdscr;
}
|
.insch(ch) ⇒ Object
Insert a character ch
, before the cursor.
632 633 634 635 636 637 638 |
# File 'ext/curses/curses.c', line 632
static VALUE
curses_insch(VALUE obj, VALUE ch)
{
curses_stdscr();
insch(NUM2CH(ch));
return Qnil;
}
|
.insertln ⇒ Object
Inserts a line above the cursor, and the bottom line is lost
758 759 760 761 762 763 764 765 766 |
# File 'ext/curses/curses.c', line 758
static VALUE
curses_insertln(VALUE obj)
{
curses_stdscr();
#if defined(HAVE_INSERTLN) || defined(insertln)
insertln();
#endif
return Qnil;
}
|
.keyboard_encoding ⇒ Object
Returns the encoding for keyboard input.
2711 2712 2713 2714 2715 |
# File 'ext/curses/curses.c', line 2711
static VALUE
curses_get_keyboard_encoding(VALUE obj)
{
return rb_enc_from_encoding(keyboard_encoding);
}
|
.keyboard_encoding=(encoding) ⇒ Object
Sets the encoding for keyboard input.
2723 2724 2725 2726 2727 2728 |
# File 'ext/curses/curses.c', line 2723
static VALUE
curses_set_keyboard_encoding(VALUE obj, VALUE enc)
{
keyboard_encoding = rb_to_encoding(enc);
return enc;
}
|
.keyname(c) ⇒ Object
Returns the character string corresponding to key c
774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 |
# File 'ext/curses/curses.c', line 774
static VALUE
curses_keyname(VALUE obj, VALUE c)
{
#ifdef HAVE_KEYNAME
int cc = curses_char(c);
const char *name;
curses_stdscr();
name = keyname(cc);
if (name) {
return rb_str_new_cstr(name);
}
else {
return Qnil;
}
#else
return Qnil;
#endif
}
|
.lines ⇒ Object
Returns the number of lines on the screen
799 800 801 802 803 |
# File 'ext/curses/curses.c', line 799
static VALUE
curses_lines(void)
{
return INT2FIX(LINES);
}
|
.mouseinterval(interval) ⇒ Object
The Curses.mouseinterval function sets the maximum time (in thousands of a second) that can elapse between press and release events for them to be recognized as a click.
Use Curses.mouseinterval(0) to disable click resolution. This function returns the previous interval value.
Use Curses.mouseinterval(-1) to obtain the interval without altering it.
The default is one sixth of a second.
1383 1384 1385 1386 1387 1388 |
# File 'ext/curses/curses.c', line 1383
static VALUE
curses_mouseinterval(VALUE obj, VALUE interval)
{
curses_stdscr();
return mouseinterval(NUM2INT(interval)) ? Qtrue : Qfalse;
}
|
.mousemask(mask) ⇒ Object
Returns the mask
of the reportable events
1396 1397 1398 1399 1400 1401 |
# File 'ext/curses/curses.c', line 1396
static VALUE
curses_mousemask(VALUE obj, VALUE mask)
{
curses_stdscr();
return INT2NUM(mousemask(NUM2UINT(mask),NULL));
}
|
.nl ⇒ Object
Enable the underlying display device to translate the return key into newline on input, and whether it translates newline into return and line-feed on output (in either case, the call Curses.addch(‘n’) does the equivalent of return and line feed on the virtual screen).
Initially, these translations do occur. If you disable them using Curses.nonl, curses will be able to make better use of the line-feed capability, resulting in faster cursor motion. Also, curses will then be able to detect the return key.
444 445 446 447 448 449 450 |
# File 'ext/curses/curses.c', line 444
static VALUE
curses_nl(VALUE obj)
{
curses_stdscr();
nl();
return Qnil;
}
|
.nocbreak ⇒ Object
Put the terminal into normal mode (out of cbreak mode).
See Curses.cbreak for more detail.
422 423 424 425 426 427 428 |
# File 'ext/curses/curses.c', line 422
static VALUE
curses_nocbreak(VALUE obj)
{
curses_stdscr();
nocbreak();
return Qnil;
}
|
.nocrmode ⇒ Object
Put the terminal into normal mode (out of cbreak mode).
See Curses.cbreak for more detail.
422 423 424 425 426 427 428 |
# File 'ext/curses/curses.c', line 422
static VALUE
curses_nocbreak(VALUE obj)
{
curses_stdscr();
nocbreak();
return Qnil;
}
|
.noecho ⇒ Object
Disables characters typed by the user to be echoed by Curses.getch as they are typed.
340 341 342 343 344 345 346 |
# File 'ext/curses/curses.c', line 340
static VALUE
curses_noecho(VALUE obj)
{
curses_stdscr();
noecho();
return Qnil;
}
|
.nonl ⇒ Object
Disable the underlying display device to translate the return key into newline on input
See Curses.nl for more detail
460 461 462 463 464 465 466 |
# File 'ext/curses/curses.c', line 460
static VALUE
curses_nonl(VALUE obj)
{
curses_stdscr();
nonl();
return Qnil;
}
|
.noraw ⇒ Object
Put the terminal out of raw mode.
see Curses.raw for more detail
377 378 379 380 381 382 383 |
# File 'ext/curses/curses.c', line 377
static VALUE
curses_noraw(VALUE obj)
{
curses_stdscr();
noraw();
return Qnil;
}
|
.pair_content(pair) ⇒ Object
Returns a 2 item Array, with the foreground and background color, in pair
1246 1247 1248 1249 1250 1251 1252 1253 1254 |
# File 'ext/curses/curses.c', line 1246
static VALUE
curses_pair_content(VALUE obj, VALUE pair)
{
short f,b;
curses_stdscr();
pair_content(NUM2INT(pair),&f,&b);
return rb_ary_new3(2,INT2FIX(f),INT2FIX(b));
}
|
.pair_number(attrs) ⇒ Object
Returns the Fixnum color pair number of attributes attrs
.
1278 1279 1280 1281 1282 1283 |
# File 'ext/curses/curses.c', line 1278
static VALUE
curses_pair_number(VALUE obj, VALUE attrs)
{
curses_stdscr();
return INT2FIX(PAIR_NUMBER(NUM2LONG(attrs)));
}
|
.raw ⇒ Object
Put the terminal into raw mode.
Raw mode is similar to Curses.cbreak mode, in that characters typed are immediately passed through to the user program.
The differences are that in raw mode, the interrupt, quit, suspend, and flow control characters are all passed through uninterpreted, instead of generating a signal. The behavior of the BREAK key depends on other bits in the tty driver that are not set by curses.
362 363 364 365 366 367 368 |
# File 'ext/curses/curses.c', line 362
static VALUE
curses_raw(VALUE obj)
{
curses_stdscr();
raw();
return Qnil;
}
|
.refresh ⇒ Object
Refreshes the windows and lines.
292 293 294 295 296 297 298 |
# File 'ext/curses/curses.c', line 292
static VALUE
curses_refresh(VALUE obj)
{
curses_stdscr();
refresh();
return Qnil;
}
|
.reset_prog_mode ⇒ Object
Reset the current terminal modes to the saved state by the Curses.def_prog_mode
This is done automatically by Curses.close_screen
1495 1496 1497 1498 1499 1500 |
# File 'ext/curses/curses.c', line 1495
static VALUE
curses_reset_prog_mode(VALUE obj)
{
curses_stdscr();
return reset_prog_mode() == OK ? Qtrue : Qfalse;
}
|
.resizeterm(lines, cols) ⇒ Object
Resize the current term to Fixnum lines
and Fixnum cols
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 |
# File 'ext/curses/curses.c', line 1093
static VALUE
curses_resizeterm(VALUE obj, VALUE lin, VALUE col)
{
#if defined(HAVE_RESIZETERM)
curses_stdscr();
return (resizeterm(NUM2INT(lin),NUM2INT(col)) == OK) ? Qtrue : Qfalse;
#else
return Qnil;
#endif
}
|
.resizeterm(lines, cols) ⇒ Object
Resize the current term to Fixnum lines
and Fixnum cols
1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 |
# File 'ext/curses/curses.c', line 1093
static VALUE
curses_resizeterm(VALUE obj, VALUE lin, VALUE col)
{
#if defined(HAVE_RESIZETERM)
curses_stdscr();
return (resizeterm(NUM2INT(lin),NUM2INT(col)) == OK) ? Qtrue : Qfalse;
#else
return Qnil;
#endif
}
|
.scrl(num) ⇒ Object
Scrolls the current window Fixnum num
lines. The current cursor position is not changed.
For positive num
, it scrolls up.
For negative num
, it scrolls down.
849 850 851 852 853 854 855 856 857 858 859 |
# File 'ext/curses/curses.c', line 849
static VALUE
curses_scrl(VALUE obj, VALUE n)
{
/* may have to raise exception on ERR */
#ifdef HAVE_SCRL
curses_stdscr();
return (scrl(NUM2INT(n)) == OK) ? Qtrue : Qfalse;
#else
return Qfalse;
#endif
}
|
.setpos(y, x) ⇒ Object
A setter for the position of the cursor, using coordinates x
and y
555 556 557 558 559 560 561 |
# File 'ext/curses/curses.c', line 555
static VALUE
curses_setpos(VALUE obj, VALUE y, VALUE x)
{
curses_stdscr();
move(NUM2INT(y), NUM2INT(x));
return Qnil;
}
|
.setscrreg(top, bottom) ⇒ Object
call-seq:
setscrreg(top, bottom)
Set a software scrolling region in a window. top
and bottom
are lines numbers of the margin.
If this option and Curses.scrollok are enabled, an attempt to move off the bottom margin line causes all lines in the scrolling region to scroll one line in the direction of the first line. Only the text of the window is scrolled.
876 877 878 879 880 881 882 883 884 885 886 |
# File 'ext/curses/curses.c', line 876
static VALUE
curses_setscrreg(VALUE obj, VALUE top, VALUE bottom)
{
/* may have to raise exception on ERR */
#ifdef HAVE_SETSCRREG
curses_stdscr();
return (setscrreg(NUM2INT(top), NUM2INT(bottom)) == OK) ? Qtrue : Qfalse;
#else
return Qfalse;
#endif
}
|
.standend ⇒ Object
Enables the Normal display (no highlight)
This is equivalent to Curses.attron(A_NORMAL)
see also Curses::Window.attrset for additional information.
589 590 591 592 593 594 595 |
# File 'ext/curses/curses.c', line 589
static VALUE
curses_standend(VALUE obj)
{
curses_stdscr();
standend();
return Qnil;
}
|
.standout ⇒ Object
Enables the best highlighting mode of the terminal.
This is equivalent to Curses:Window.attron(A_STANDOUT)
see also Curses::Window.attrset additional information
572 573 574 575 576 577 578 |
# File 'ext/curses/curses.c', line 572
static VALUE
curses_standout(VALUE obj)
{
curses_stdscr();
standout();
return Qnil;
}
|
.start_color ⇒ Object
Initializes the color attributes, for terminals that support it.
This must be called, in order to use color attributes. It is good practice to call it just after Curses.init_screen
1113 1114 1115 1116 1117 1118 1119 |
# File 'ext/curses/curses.c', line 1113
static VALUE
curses_start_color(VALUE obj)
{
/* may have to raise exception on ERR */
curses_stdscr();
return (start_color() == OK) ? Qtrue : Qfalse;
}
|
.stdscr ⇒ Object
The Standard Screen.
Upon initializing curses, a default window called stdscr, which is the size of the terminal screen, is created.
Many curses functions use this window.
.TABSIZE ⇒ Object
Returns the number of positions in a tab.
1039 1040 1041 1042 1043 |
# File 'ext/curses/curses.c', line 1039
static VALUE
curses_tabsize_get(VALUE ojb)
{
return INT2NUM(TABSIZE);
}
|
.TABSIZE=(value) ⇒ Object
Sets the TABSIZE to Integer value
1025 1026 1027 1028 1029 1030 |
# File 'ext/curses/curses.c', line 1025
static VALUE
curses_tabsize_set(VALUE obj, VALUE val)
{
TABSIZE = NUM2INT(val);
return INT2NUM(TABSIZE);
}
|
.terminal_encoding ⇒ Object
Returns the encoding for terminal output.
2736 2737 2738 2739 2740 |
# File 'ext/curses/curses.c', line 2736
static VALUE
curses_get_terminal_encoding(VALUE obj)
{
return rb_enc_from_encoding(terminal_encoding);
}
|
.terminal_encoding=(encoding) ⇒ Object
Sets the encoding for terminal output.
2748 2749 2750 2751 2752 2753 |
# File 'ext/curses/curses.c', line 2748
static VALUE
curses_set_terminal_encoding(VALUE obj, VALUE enc)
{
terminal_encoding = rb_to_encoding(enc);
return enc;
}
|
.timeout=(delay) ⇒ Object
Sets block and non-blocking reads for the window.
-
If delay is negative, blocking read is used (i.e., waits indefinitely for input).
-
If delay is zero, then non-blocking read is used (i.e., read returns ERR if no input is waiting).
-
If delay is positive, then read blocks for delay milliseconds, and returns ERR if there is still no input.
.unget_char(ch) ⇒ Object
Places ch
back onto the input queue to be returned by the next call to Curses.get_char etc.
There is just one input queue for all windows.
2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 |
# File 'ext/curses/curses.c', line 2764
static VALUE
curses_unget_char(VALUE obj, VALUE ch)
{
ID id_ord;
unsigned int c;
curses_stdscr();
if (FIXNUM_P(ch)) {
ungetch(NUM2UINT(ch));
}
else {
StringValue(ch);
CONST_ID(id_ord, "ord");
c = NUM2UINT(rb_funcall(ch, id_ord, 0));
#ifdef HAVE_UNGET_WCH
unget_wch(c);
#else
if (c > 0xff) {
rb_raise(rb_eRangeError, "Out of range: %u", c);
}
ungetch(c);
#endif
}
return Qnil;
}
|
.ungetch(ch) ⇒ Object
Places ch
back onto the input queue to be returned by the next call to Curses.getch.
There is just one input queue for all windows.
535 536 537 538 539 540 541 542 |
# File 'ext/curses/curses.c', line 535
static VALUE
curses_ungetch(VALUE obj, VALUE ch)
{
int c = curses_char(ch);
curses_stdscr();
ungetch(c);
return Qnil;
}
|
.ungetmouse(mevent) ⇒ Object
It pushes a KEY_MOUSE event onto the input queue, and associates with that event the given state data and screen-relative character-cell coordinates.
The Curses.ungetmouse function behaves analogously to Curses.ungetch.
1357 1358 1359 1360 1361 1362 1363 1364 1365 |
# File 'ext/curses/curses.c', line 1357
static VALUE
curses_ungetmouse(VALUE obj, VALUE mevent)
{
struct mousedata *mdata;
curses_stdscr();
GetMOUSE(mevent,mdata);
return (ungetmouse(mdata->mevent) == OK) ? Qtrue : Qfalse;
}
|
.use_default_colors ⇒ Object
tells the curses library to use terminal’s default colors.
see also the system manual for default_colors(3)
990 991 992 993 994 995 996 |
# File 'ext/curses/curses.c', line 990
static VALUE
curses_use_default_colors(VALUE obj)
{
curses_stdscr();
use_default_colors();
return Qnil;
}
|