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: Error, Field, Form, Item, Menu, 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
TYPE_ALPHA = 
INT2NUM(TYPE_CODE_ALPHA)
TYPE_ALNUM = 
INT2NUM(TYPE_CODE_ALNUM)
TYPE_ENUM = 
INT2NUM(TYPE_CODE_ENUM)
TYPE_INTEGER = 
INT2NUM(TYPE_CODE_INTEGER)
TYPE_NUMERIC = 
INT2NUM(TYPE_CODE_NUMERIC)
TYPE_REGEXP = 
INT2NUM(TYPE_CODE_REGEXP)

Class Method Summary collapse

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)



760
761
762
763
764
765
766
 
# File 'ext/curses/curses.c', line 760

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



790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
 
# File 'ext/curses/curses.c', line 790

static VALUE
curses_addstr(VALUE obj, VALUE str)
{
    StringValue(str);
#if defined(HAVE_ADDNWSTR) && defined(_WIN32)
    str = rb_str_export_to_enc(str, get_wide_encoding());
    curses_stdscr();
    if (!NIL_P(str)) {
	addnwstr((wchar_t *)RSTRING_PTR(str), RSTRING_LEN(str) / sizeof(wchar_t));
    }
#else
    str = rb_str_export_to_enc(str, terminal_encoding);
    curses_stdscr();
    if (!NIL_P(str)) {
	addstr(StringValueCStr(str));
    }
#endif
    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)



1158
1159
1160
1161
1162
1163
1164
 
# File 'ext/curses/curses.c', line 1158

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.



1048
1049
1050
1051
1052
1053
1054
 
# File 'ext/curses/curses.c', line 1048

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.



1065
1066
1067
1068
1069
1070
1071
 
# File 'ext/curses/curses.c', line 1065

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



1082
1083
1084
1085
1086
1087
1088
 
# File 'ext/curses/curses.c', line 1082

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



619
620
621
622
623
624
625
626
627
 
# File 'ext/curses/curses.c', line 619

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)



1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
 
# File 'ext/curses/curses.c', line 1124

static VALUE
curses_bkgd(VALUE obj, VALUE ch)
{
#ifdef HAVE_BKGD
    curses_stdscr();
    return (bkgd(NUM2CHTYPE(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)



1103
1104
1105
1106
1107
1108
1109
1110
1111
 
# File 'ext/curses/curses.c', line 1103

static VALUE
curses_bkgdset(VALUE obj, VALUE ch)
{
#ifdef HAVE_BKGDSET
    curses_stdscr();
    bkgdset(NUM2CHTYPE(ch));
#endif
    return Qnil;
}

.can_change_color? ⇒ Boolean

Returns true or false depending on whether the terminal can change color attributes

Returns:

  • (Boolean) 


1336
1337
1338
1339
1340
1341
 
# File 'ext/curses/curses.c', line 1336

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



550
551
552
553
554
555
556
 
# File 'ext/curses/curses.c', line 550

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.



391
392
393
394
395
396
397
 
# File 'ext/curses/curses.c', line 391

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.



331
332
333
334
335
336
337
338
339
340
341
 
# File 'ext/curses/curses.c', line 331

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.

Returns:

  • (Boolean) 


371
372
373
374
375
376
377
378
379
 
# File 'ext/curses/curses.c', line 371

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.



421
422
423
424
425
426
427
 
# File 'ext/curses/curses.c', line 421

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



1364
1365
1366
1367
1368
1369
1370
1371
1372
 
# File 'ext/curses/curses.c', line 1364

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



1417
1418
1419
1420
1421
 
# File 'ext/curses/curses.c', line 1417

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.



1381
1382
1383
1384
1385
 
# File 'ext/curses/curses.c', line 1381

static VALUE
curses_color_pairs(VALUE obj)
{
    return INT2FIX(COLOR_PAIRS);
}

.colors ⇒ Object

returns COLORS



1349
1350
1351
1352
1353
 
# File 'ext/curses/curses.c', line 1349

static VALUE
curses_colors(VALUE obj)
{
    return INT2FIX(COLORS);
}

.cols ⇒ Object

Returns the number of columns on the screen



961
962
963
964
965
 
# File 'ext/curses/curses.c', line 961

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



550
551
552
553
554
555
556
 
# File 'ext/curses/curses.c', line 550

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



976
977
978
979
980
981
982
983
984
985
986
 
# File 'ext/curses/curses.c', line 976

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



1627
1628
1629
1630
1631
1632
 
# File 'ext/curses/curses.c', line 1627

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



879
880
881
882
883
884
885
 
# File 'ext/curses/curses.c', line 879

static VALUE
curses_delch(VALUE obj)
{
    curses_stdscr();
    delch();
    return Qnil;
}

.deleteln ⇒ Object

Delete the line under the cursor.



893
894
895
896
897
898
899
900
901
 
# File 'ext/curses/curses.c', line 893

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.



451
452
453
454
455
456
457
458
459
460
461
 
# File 'ext/curses/curses.c', line 451

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.



469
470
471
472
473
474
475
 
# File 'ext/curses/curses.c', line 469

static VALUE
curses_echo(VALUE obj)
{
    curses_stdscr();
    echo();
    return Qnil;
}

.erase ⇒ Object

Erase the screen.



405
406
407
408
409
410
411
 
# File 'ext/curses/curses.c', line 405

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



1220
1221
1222
1223
1224
 
# File 'ext/curses/curses.c', line 1220

static VALUE
curses_escdelay_get(VALUE obj)
{
    return INT2NUM(ESCDELAY);
}

.ESCDELAY=(value) ⇒ Object

Sets the ESCDELAY to Integer value



1205
1206
1207
1208
1209
1210
 
# File 'ext/curses/curses.c', line 1205

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



637
638
639
640
641
642
643
644
645
 
# File 'ext/curses/curses.c', line 637

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



4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
 
# File 'ext/curses/curses.c', line 4523

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 key_code_value(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
}

.get_key_modifiers ⇒ Object 



4620
4621
4622
4623
4624
 
# File 'ext/curses/curses.c', line 4620

static VALUE
curses_get_key_modifiers(VALUE obj)
{
    return ULONG2NUM(PDC_get_key_modifiers());
}

.getch ⇒ Object

Read and returns a character from the window.

See Curses::Key to all the function KEY_* available



826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
 
# File 'ext/curses/curses.c', line 826

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



1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
 
# File 'ext/curses/curses.c', line 1487

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



863
864
865
866
867
868
869
870
871
 
# File 'ext/curses/curses.c', line 863

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.

Returns:

  • (Boolean) 


1324
1325
1326
1327
1328
1329
 
# File 'ext/curses/curses.c', line 1324

static VALUE
curses_has_colors(VALUE obj)
{
    curses_stdscr();
    return has_colors() ? Qtrue : Qfalse;
}

.inch ⇒ Object

Returns the character at the current position.



745
746
747
748
749
750
 
# File 'ext/curses/curses.c', line 745

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.



1310
1311
1312
1313
1314
1315
1316
1317
 
# File 'ext/curses/curses.c', line 1310

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.



1286
1287
1288
1289
1290
1291
1292
 
# File 'ext/curses/curses.c', line 1286

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



292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'ext/curses/curses.c', line 292

static VALUE
curses_init_screen(void)
{
    if (rb_stdscr) return rb_stdscr;
    initscr();
    if (stdscr == 0) {
	rb_raise(rb_eRuntimeError, "can't initialize curses");
    }
    rb_set_end_proc(curses_finalize, 0);
    clear();
    rb_stdscr = prep_window(cWindow, stdscr);
    return rb_stdscr;
}

.insch(ch) ⇒ Object

Insert a character ch, before the cursor.



775
776
777
778
779
780
781
 
# File 'ext/curses/curses.c', line 775

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



909
910
911
912
913
914
915
916
917
 
# File 'ext/curses/curses.c', line 909

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.



4399
4400
4401
4402
4403
 
# File 'ext/curses/curses.c', line 4399

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.



4411
4412
4413
4414
4415
4416
 
# File 'ext/curses/curses.c', line 4411

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



925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'ext/curses/curses.c', line 925

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



950
951
952
953
954
 
# File 'ext/curses/curses.c', line 950

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.



1534
1535
1536
1537
1538
1539
 
# File 'ext/curses/curses.c', line 1534

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



1547
1548
1549
1550
1551
1552
 
# File 'ext/curses/curses.c', line 1547

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.



587
588
589
590
591
592
593
 
# File 'ext/curses/curses.c', line 587

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.



565
566
567
568
569
570
571
 
# File 'ext/curses/curses.c', line 565

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.



565
566
567
568
569
570
571
 
# File 'ext/curses/curses.c', line 565

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.



483
484
485
486
487
488
489
 
# File 'ext/curses/curses.c', line 483

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



603
604
605
606
607
608
609
 
# File 'ext/curses/curses.c', line 603

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



520
521
522
523
524
525
526
 
# File 'ext/curses/curses.c', line 520

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



1397
1398
1399
1400
1401
1402
1403
1404
1405
 
# File 'ext/curses/curses.c', line 1397

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.



1429
1430
1431
1432
1433
1434
 
# File 'ext/curses/curses.c', line 1429

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.



505
506
507
508
509
510
511
 
# File 'ext/curses/curses.c', line 505

static VALUE
curses_raw(VALUE obj)
{
    curses_stdscr();
    raw();
    return Qnil;
}

.refresh ⇒ Object

Refreshes the windows and lines.



435
436
437
438
439
440
441
 
# File 'ext/curses/curses.c', line 435

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



1646
1647
1648
1649
1650
1651
 
# File 'ext/curses/curses.c', line 1646

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



1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
 
# File 'ext/curses/curses.c', line 1244

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



1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
 
# File 'ext/curses/curses.c', line 1244

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
}

.return_key_modifiers(flag) ⇒ Object 



4626
4627
4628
4629
4630
 
# File 'ext/curses/curses.c', line 4626

static VALUE
curses_return_key_modifiers(VALUE obj, VALUE flag)
{
    return INT2NUM(PDC_return_key_modifiers(RTEST(flag)));
}

.save_key_modifiers(flag) ⇒ Object 



4632
4633
4634
4635
4636
 
# File 'ext/curses/curses.c', line 4632

static VALUE
curses_save_key_modifiers(VALUE obj, VALUE flag)
{
    return INT2NUM(PDC_save_key_modifiers(RTEST(flag)));
}

.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.



1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
 
# File 'ext/curses/curses.c', line 1000

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



698
699
700
701
702
703
704
 
# File 'ext/curses/curses.c', line 698

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.



1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
 
# File 'ext/curses/curses.c', line 1027

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.



732
733
734
735
736
737
738
 
# File 'ext/curses/curses.c', line 732

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



715
716
717
718
719
720
721
 
# File 'ext/curses/curses.c', line 715

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



1264
1265
1266
1267
1268
1269
1270
 
# File 'ext/curses/curses.c', line 1264

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.



1190
1191
1192
1193
1194
 
# File 'ext/curses/curses.c', line 1190

static VALUE
curses_tabsize_get(VALUE ojb)
{
    return INT2NUM(TABSIZE);
}

.TABSIZE=(value) ⇒ Object

Sets the TABSIZE to Integer value



1176
1177
1178
1179
1180
1181
 
# File 'ext/curses/curses.c', line 1176

static VALUE
curses_tabsize_set(VALUE obj, VALUE val)
{
    TABSIZE = NUM2INT(val);
    return INT2NUM(TABSIZE);
}

.terminal_encoding ⇒ Object

Returns the encoding for terminal output.



4424
4425
4426
4427
4428
 
# File 'ext/curses/curses.c', line 4424

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.



4436
4437
4438
4439
4440
4441
 
# File 'ext/curses/curses.c', line 4436

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.



4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
 
# File 'ext/curses/curses.c', line 4452

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.



678
679
680
681
682
683
684
685
 
# File 'ext/curses/curses.c', line 678

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.



1508
1509
1510
1511
1512
1513
1514
1515
1516
 
# File 'ext/curses/curses.c', line 1508

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)



1141
1142
1143
1144
1145
1146
1147
 
# File 'ext/curses/curses.c', line 1141

static VALUE
curses_use_default_colors(VALUE obj)
{
    curses_stdscr();
    use_default_colors();
    return Qnil;
}