Module: Curses
- Defined in:
- 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: hello.rb
-
rain.rb
:include: rain.rb
Defined Under Namespace
Modules: Key Classes: MouseEvent, Window
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. -
.attroff(attrs) ⇒ Object
Turns on the named attributes
attrs
without affecting any others. -
.attron(attrs) ⇒ Object
Turns off 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 normal mode (out of 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.
-
.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
Flashs the screen, for visual alarm on the terminal, if possible; otherwise it sounds the alert.
-
.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 capbilities. -
.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.
-
.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 ⇒ 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
. -
.timeout=(delay) ⇒ Object
Sets block and non-blocking reads for the window.
-
.ungetch(ch) ⇒ Object
Places
ch
back onto the input queue to be returned by the next call to Curses.getch. -
.ungetmouse ⇒ 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)
578 579 580 581 582 583 584 |
# File 'curses.c', line 578
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
608 609 610 611 612 613 614 615 616 617 618 |
# File 'curses.c', line 608
static VALUE
curses_addstr(VALUE obj, VALUE str)
{
StringValue(str);
str = rb_str_export_locale(str);
curses_stdscr();
if (!NIL_P(str)) {
addstr(StringValueCStr(str));
}
return Qnil;
}
|
.attroff(attrs) ⇒ Object
Turns on the named attributes attrs
without affecting any others.
See also Curses::Window.attrset for additional information.
857 858 859 860 861 862 863 |
# File 'curses.c', line 857
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 off the named attributes attrs
without turning any other attributes on or off.
See also Curses::Window.attrset for additional information.
874 875 876 877 878 879 880 |
# File 'curses.c', line 874
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
891 892 893 894 895 896 897 |
# File 'curses.c', line 891
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
437 438 439 440 441 442 443 444 445 |
# File 'curses.c', line 437
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)
933 934 935 936 937 938 939 940 941 942 |
# File 'curses.c', line 933
static VALUE
curses_bkgd(VALUE obj, VALUE ch)
{
#ifdef HAVE_BKGD
curses_stdscr();
return (bkgd(NUM2CH(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)
912 913 914 915 916 917 918 919 920 |
# File 'curses.c', line 912
static VALUE
curses_bkgdset(VALUE obj, VALUE ch)
{
#ifdef HAVE_BKGDSET
curses_stdscr();
bkgdset(NUM2CH(ch));
#endif
return Qnil;
}
|
.can_change_color? ⇒ Boolean
Returns true
or false
depending on whether the terminal can change color attributes
1128 1129 1130 1131 1132 1133 |
# File 'curses.c', line 1128
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
368 369 370 371 372 373 374 |
# File 'curses.c', line 368
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.
226 227 228 229 230 231 232 |
# File 'curses.c', line 226
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.
166 167 168 169 170 171 172 173 174 175 176 |
# File 'curses.c', line 166
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.
206 207 208 209 210 211 212 213 214 |
# File 'curses.c', line 206
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.
239 240 241 242 243 244 245 |
# File 'curses.c', line 239
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
1156 1157 1158 1159 1160 1161 1162 1163 1164 |
# File 'curses.c', line 1156
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
1209 1210 1211 1212 1213 |
# File 'curses.c', line 1209
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.
1173 1174 1175 1176 1177 |
# File 'curses.c', line 1173
static VALUE
curses_color_pairs(VALUE obj)
{
return INT2FIX(COLOR_PAIRS);
}
|
.colors ⇒ Object
returns COLORS
1141 1142 1143 1144 1145 |
# File 'curses.c', line 1141
static VALUE
curses_colors(VALUE obj)
{
return INT2FIX(COLORS);
}
|
.cols ⇒ Object
Returns the number of columns on the screen
771 772 773 774 775 |
# File 'curses.c', line 771
static VALUE
curses_cols(void)
{
return INT2FIX(COLS);
}
|
.crmode ⇒ Object
Put the terminal into normal mode (out of cbreak mode).
See Curses.cbreak for more detail.
383 384 385 386 387 388 389 |
# File 'curses.c', line 383
static VALUE
curses_nocbreak(VALUE obj)
{
curses_stdscr();
nocbreak();
return Qnil;
}
|
.curs_set(visibility) ⇒ Object
Sets Cursor Visibility. 0: invisible 1: visible 2: very visible
786 787 788 789 790 791 792 793 794 795 796 |
# File 'curses.c', line 786
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
1403 1404 1405 1406 1407 1408 |
# File 'curses.c', line 1403
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
689 690 691 692 693 694 695 |
# File 'curses.c', line 689
static VALUE
curses_delch(VALUE obj)
{
curses_stdscr();
delch();
return Qnil;
}
|
.deleteln ⇒ Object
Delete the line under the cursor.
703 704 705 706 707 708 709 710 711 |
# File 'curses.c', line 703
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.
269 270 271 272 273 274 275 276 277 278 279 |
# File 'curses.c', line 269
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.
287 288 289 290 291 292 293 |
# File 'curses.c', line 287
static VALUE
curses_echo(VALUE obj)
{
curses_stdscr();
echo();
return Qnil;
}
|
.ESCDELAY ⇒ Object
Returns the total time, in milliseconds, for which curses will await a character sequence, e.g., a function key
1012 1013 1014 1015 1016 |
# File 'curses.c', line 1012
static VALUE
curses_escdelay_get(VALUE obj)
{
return INT2NUM(ESCDELAY);
}
|
.ESCDELAY=(value) ⇒ Object
Sets the ESCDELAY to Integer value
997 998 999 1000 1001 1002 |
# File 'curses.c', line 997
static VALUE
curses_escdelay_set(VALUE obj, VALUE val)
{
ESCDELAY = NUM2INT(val);
return INT2NUM(ESCDELAY);
}
|
.flash ⇒ Object
Flashs the screen, for visual alarm on the terminal, if possible; otherwise it sounds the alert.
see also Curses.beep
455 456 457 458 459 460 461 462 463 |
# File 'curses.c', line 455
static VALUE
curses_flash(VALUE obj)
{
#ifdef HAVE_FLASH
curses_stdscr();
flash();
#endif
return Qnil;
}
|
.getch ⇒ Object
Read and returns a character from the window.
See Curses::Key to all the function KEY_* available
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 |
# File 'curses.c', line 636
static VALUE
curses_getch(VALUE obj)
{
int c;
curses_stdscr();
rb_thread_blocking_region(getch_func, (void *)&c, RUBY_UBF_IO, 0);
if (c == EOF) return Qnil;
if (rb_isprint(c)) {
char ch = (char)c;
return rb_locale_str_new(&ch, 1);
}
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
1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 |
# File 'curses.c', line 1263
static VALUE
curses_getmouse(VALUE obj)
{
struct mousedata *mdata;
VALUE val;
curses_stdscr();
val = Data_Make_Struct(cMouseEvent,struct mousedata,
0,curses_mousedata_free,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
673 674 675 676 677 678 679 680 681 |
# File 'curses.c', line 673
static VALUE
curses_getstr(VALUE obj)
{
char rtn[GETSTR_BUF_SIZE];
curses_stdscr();
rb_thread_blocking_region(getstr_func, (void *)rtn, RUBY_UBF_IO, 0);
return rb_locale_str_new_cstr(rtn);
}
|
.has_colors? ⇒ Boolean
Returns true
or false
depending on whether the terminal has color capbilities.
1116 1117 1118 1119 1120 1121 |
# File 'curses.c', line 1116
static VALUE
curses_has_colors(VALUE obj)
{
curses_stdscr();
return has_colors() ? Qtrue : Qfalse;
}
|
.inch ⇒ Object
Returns the character at the current position.
563 564 565 566 567 568 |
# File 'curses.c', line 563
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.
1102 1103 1104 1105 1106 1107 1108 1109 |
# File 'curses.c', line 1102
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.
1078 1079 1080 1081 1082 1083 1084 |
# File 'curses.c', line 1078
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
127 128 129 130 131 132 133 134 135 136 137 138 139 |
# File 'curses.c', line 127
static VALUE
curses_init_screen(void)
{
rb_secure(4);
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.
593 594 595 596 597 598 599 |
# File 'curses.c', line 593
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
719 720 721 722 723 724 725 726 727 |
# File 'curses.c', line 719
static VALUE
curses_insertln(VALUE obj)
{
curses_stdscr();
#if defined(HAVE_INSERTLN) || defined(insertln)
insertln();
#endif
return Qnil;
}
|
.keyname(c) ⇒ Object
Returns the character string corresponding to key c
735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 |
# File 'curses.c', line 735
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
760 761 762 763 764 |
# File 'curses.c', line 760
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.
1310 1311 1312 1313 1314 1315 |
# File 'curses.c', line 1310
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
1323 1324 1325 1326 1327 1328 |
# File 'curses.c', line 1323
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.
405 406 407 408 409 410 411 |
# File 'curses.c', line 405
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.
383 384 385 386 387 388 389 |
# File 'curses.c', line 383
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.
383 384 385 386 387 388 389 |
# File 'curses.c', line 383
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.
301 302 303 304 305 306 307 |
# File 'curses.c', line 301
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
421 422 423 424 425 426 427 |
# File 'curses.c', line 421
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
338 339 340 341 342 343 344 |
# File 'curses.c', line 338
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
1189 1190 1191 1192 1193 1194 1195 1196 1197 |
# File 'curses.c', line 1189
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
.
1221 1222 1223 1224 1225 1226 |
# File 'curses.c', line 1221
static VALUE
curses_pair_number(VALUE obj, VALUE attrs)
{
curses_stdscr();
return INT2FIX(PAIR_NUMBER(NUM2INT(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.
323 324 325 326 327 328 329 |
# File 'curses.c', line 323
static VALUE
curses_raw(VALUE obj)
{
curses_stdscr();
raw();
return Qnil;
}
|
.refresh ⇒ Object
Refreshes the windows and lines.
253 254 255 256 257 258 259 |
# File 'curses.c', line 253
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
1422 1423 1424 1425 1426 1427 |
# File 'curses.c', line 1422
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
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 |
# File 'curses.c', line 1036
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
1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 |
# File 'curses.c', line 1036
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.
810 811 812 813 814 815 816 817 818 819 820 |
# File 'curses.c', line 810
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
516 517 518 519 520 521 522 |
# File 'curses.c', line 516
static VALUE
curses_setpos(VALUE obj, VALUE y, VALUE x)
{
curses_stdscr();
move(NUM2INT(y), NUM2INT(x));
return Qnil;
}
|
.setscrreg ⇒ 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.
837 838 839 840 841 842 843 844 845 846 847 |
# File 'curses.c', line 837
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.
550 551 552 553 554 555 556 |
# File 'curses.c', line 550
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
533 534 535 536 537 538 539 |
# File 'curses.c', line 533
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
1056 1057 1058 1059 1060 1061 1062 |
# File 'curses.c', line 1056
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.
982 983 984 985 986 |
# File 'curses.c', line 982
static VALUE
curses_tabsize_get(VALUE ojb)
{
return INT2NUM(TABSIZE);
}
|
.TABSIZE=(value) ⇒ Object
Sets the TABSIZE to Integer value
968 969 970 971 972 973 |
# File 'curses.c', line 968
static VALUE
curses_tabsize_set(VALUE obj, VALUE val)
{
TABSIZE = NUM2INT(val);
return INT2NUM(TABSIZE);
}
|
.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.
.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.
496 497 498 499 500 501 502 503 |
# File 'curses.c', line 496
static VALUE
curses_ungetch(VALUE obj, VALUE ch)
{
int c = curses_char(ch);
curses_stdscr();
ungetch(c);
return Qnil;
}
|
.ungetmouse ⇒ 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.
1284 1285 1286 1287 1288 1289 1290 1291 1292 |
# File 'curses.c', line 1284
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)
950 951 952 953 954 955 956 |
# File 'curses.c', line 950
static VALUE
curses_use_default_colors(VALUE obj)
{
curses_stdscr();
use_default_colors();
return Qnil;
}
|