curses 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ffb4ca786694addf62474419a581e2df4f642340
-  data.tar.gz: 46bc085418181e1ee2ffe5e452851bfe1226b598
+  metadata.gz: fd42ffddd24b08972de01756f8c09237392a11d3
+  data.tar.gz: bb74122d9d1c3ca14431e7332ef7ac874248c07c
 SHA512:
-  metadata.gz: 2dfa514179c05a02749464dfd6283938460eed244ebecdc0006f0f1042c6b73b7d0064dedcd05a747f6446e3cc08fd5e99da63110d0896582f076e89febce5e4
-  data.tar.gz: c411cf4a0a022b1f1f01edec0486f3df77280e1885f4304aa42295c7138138fc618bf8fa3c84cbaf2a7d9e4d5e1040199c3201e72581ed41f17ed1330c5b4b2d
+  metadata.gz: 5f6e6219093b2c87c729f4db408fb3b8e7839e358f61e6fb424d66947c4561ccce0897b8da982bafba81148ac676f85399597dfbcf8f3724e4a85bc693bb4768
+  data.tar.gz: 8dde4ae7c4e5327d3b496cad6ce95e7c7490f2c23ccc8f8bda3ee4fcc232ebbee02c1e11deacb9c45940bd4714ff89e0b83ace99a7f21efc3a677de0e04a723b

data/README.md

@@ -1,5 +1,8 @@
 # curses
 
+[![Build Status](https://travis-ci.org/ruby/curses.svg?branch=master)](https://travis-ci.org/ruby/curses)
+[![Build status](https://ci.appveyor.com/api/projects/status/kdvksgjo4fyd3c4m/branch/master?svg=true)](https://ci.appveyor.com/project/ruby/curses/branch/master)
+
 * https://github.com/ruby/curses
 * https://github.com/ruby/curses/issues
 
@@ -17,17 +20,52 @@ with the release of Ruby 2.1.0. (see [ruby/ruby@9c5b2fd][2])
 
 ## Developers
 
-After checking out the source, run:
+After checking out the repo, run `bundle install` to install dependencies.
+
+To compile the extension library, run `bundle exec rake compile`.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `curses.gemspec`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Cross compilation for Windows on Debian GNU/Linux based platforms
+
+1. Install development environment fo 32- and 64-bit Windows.
+
+    $ sudo apt-get install mingw-w64
+
+2. Install rake-compiler.
+
+    $ gem install rake-compiler
 
-    $ rake newb
+3. Compile multiple versions of Ruby.
 
-This task will install any missing dependencies, run the tests/specs,
-and generate the RDoc.
+    $ rake-compiler cross-ruby HOST=i686-w64-mingw32 VERSION=2.2.6
+    $ rake-compiler cross-ruby HOST=i686-w64-mingw32 VERSION=2.3.3
+    $ rake-compiler cross-ruby HOST=i686-w64-mingw32 VERSION=2.4.0
+    $ rake-compiler cross-ruby HOST=x86_64-w64-mingw32 VERSION=2.2.6
+    $ rake-compiler cross-ruby HOST=x86_64-w64-mingw32 VERSION=2.3.3
+    $ rake-compiler cross-ruby HOST=x86_64-w64-mingw32 VERSION=2.4.0
+
+3. Compile PDCurses.
+
+    $ rake build:pdcurses
+
+5. Compile curses.gem.
+
+    $ rake RUBY_CC_VERSION=2.3.3:2.4.0 cross clean compile native gem
+
+Binary gems are generated in pkg/.
 
 ## License
 
 curses is released under the Ruby and 2-clause BSD licenses.  See COPYING for
 details.
 
+Binary gems for mingw32 include a forked version of PDCurses, which is in
+the public domain:
+
+  https://github.com/Bill-Gray/PDCurses
+
+The version for Win32 console mode in the win32 subdirectory is used.
+
 [1]: https://bugs.ruby-lang.org/issues/8584
 [2]: https://github.com/ruby/ruby/commit/9c5b2fd8aa0fd343ad094d47a638cfd3f6ae0a81

data/ext/curses/curses.c

@@ -73,6 +73,9 @@ static VALUE cMouseEvent;
 
 static VALUE rb_stdscr;
 
+static rb_encoding *keyboard_encoding;
+static rb_encoding *terminal_encoding;
+
 struct windata {
     WINDOW *window;
 };
@@ -250,6 +253,23 @@ curses_clear(VALUE obj)
     return Qnil;
 }
 
+#ifdef HAVE_WERASE
+/*
+ * Document-method: Curses.erase
+ *
+ * Erase the screen.
+ */
+static VALUE
+curses_erase(VALUE obj)
+{
+    curses_stdscr();
+    werase(stdscr);
+    return Qnil;
+}
+#else
+#define curses_erase rb_f_notimplement
+#endif
+
 /*
  * Document-method: Curses.clrtoeol
  *
@@ -628,7 +648,7 @@ static VALUE
 curses_addstr(VALUE obj, VALUE str)
 {
     StringValue(str);
-    str = rb_str_export_locale(str);
+    str = rb_str_export_to_enc(str, terminal_encoding);
     curses_stdscr();
     if (!NIL_P(str)) {
 	addstr(StringValueCStr(str));
@@ -663,7 +683,7 @@ curses_getch(VALUE obj)
     if (rb_isprint(c)) {
 	char ch = (char)c;
 
-	return rb_locale_str_new(&ch, 1);
+	return rb_external_str_new_with_enc(&ch, 1, keyboard_encoding);
     }
     return UINT2NUM(c);
 }
@@ -696,7 +716,7 @@ curses_getstr(VALUE obj)
 
     curses_stdscr();
     rb_thread_call_without_gvl(getstr_func, rtn, RUBY_UBF_IO, 0);
-    return rb_locale_str_new_cstr(rtn);
+    return rb_external_str_new_with_enc(rtn, strlen(rtn), keyboard_encoding);
 }
 
 /*
@@ -869,7 +889,8 @@ curses_setscrreg(VALUE obj, VALUE top, VALUE bottom)
  * Document-method: Curses.attroff
  * call-seq: attroff(attrs)
  *
- * Turns on the named attributes +attrs+ without affecting any others.
+ * Turns off the named attributes +attrs+
+ * without affecting any others.
  *
  * See also Curses::Window.attrset for additional information.
  */
@@ -885,7 +906,7 @@ curses_attroff(VALUE obj, VALUE attrs)
  * Document-method: Curses.attron
  * call-seq: attron(attrs)
  *
- * Turns off the named attributes +attrs+
+ * Turns on the named attributes +attrs+
  * without turning any other attributes on or off.
  *
  * See also Curses::Window.attrset for additional information.
@@ -1562,6 +1583,26 @@ window_clear(VALUE obj)
     return Qnil;
 }
 
+#ifdef HAVE_WERASE
+/*
+ * Document-method: Curses::Window.erase
+ *
+ * Erase the window.
+ */
+static VALUE
+window_erase(VALUE obj)
+{
+    struct windata *winp;
+
+    GetWINDOW(obj, winp);
+    werase(winp->window);
+
+    return Qnil;
+}
+#else
+#define curses_erase rb_f_notimplement
+#endif
+
 /*
  * Document-method: Curses::Window.clrtoeol
  *
@@ -1618,6 +1659,26 @@ window_noutrefresh(VALUE obj)
     return Qnil;
 }
 
+#ifdef HAVE_REDRAWWIN
+/*
+ * Document-method: Curses::Window.redraw
+ *
+ * Dedraws the entire window.
+ */
+static VALUE
+window_redraw(VALUE obj)
+{
+    struct windata *winp;
+
+    GetWINDOW(obj, winp);
+    redrawwin(winp->window);
+
+    return Qnil;
+}
+#else
+#define window_redraw rb_f_notimplement
+#endif
+
 /*
  * Document-method: Curses::Window.move
  * call-seq: move(y,x)
@@ -1921,7 +1982,7 @@ window_addstr(VALUE obj, VALUE str)
 	struct windata *winp;
 
 	StringValue(str);
-	str = rb_str_export_locale(str);
+	str = rb_str_export_to_enc(str, terminal_encoding);
 	GetWINDOW(obj, winp);
 	waddstr(winp->window, StringValueCStr(str));
     }
@@ -1981,7 +2042,7 @@ window_getch(VALUE obj)
     if (rb_isprint(c)) {
 	char ch = (char)c;
 
-	return rb_locale_str_new(&ch, 1);
+	return rb_external_str_new_with_enc(&ch, 1, keyboard_encoding);
     }
     return UINT2NUM(c);
 }
@@ -2018,7 +2079,8 @@ window_getstr(VALUE obj)
     GetWINDOW(obj, winp);
     arg.win = winp->window;
     rb_thread_call_without_gvl(wgetstr_func, (void *)&arg, RUBY_UBF_IO, 0);
-    return rb_locale_str_new_cstr(arg.rtn);
+    return rb_external_str_new_with_enc(arg.rtn, strlen(arg.rtn),
+				       	keyboard_encoding);
 }
 
 /*
@@ -2219,7 +2281,8 @@ window_scrl(VALUE obj, VALUE n)
  * Document-method: Curses::Window.attroff
  * call-seq: attroff(attrs)
  *
- * Turns on the named attributes +attrs+ without affecting any others.
+ * Turns off the named attributes +attrs+
+ * without affecting any others.
  *
  * See also Curses::Window.attrset
  */
@@ -2240,7 +2303,7 @@ window_attroff(VALUE obj, VALUE attrs)
  * Document-method: Curses::Window.attron
  * call-seq: attron(attrs)
  *
- * Turns off the named attributes +attrs+
+ * Turns on the named attributes +attrs+
  * without turning any other attributes on or off.
  *
  * See also Curses::Window.attrset
@@ -2622,6 +2685,216 @@ pad_noutrefresh(VALUE obj, VALUE pminrow, VALUE pmincol, VALUE sminrow,
 }
 #endif /* HAVE_NEWPAD */
 
+/*
+ * Document-method: Curses.keyboard_encoding
+ * call-seq: Curses.keyboard_encoding
+ *
+ * Returns the encoding for keyboard input.
+ */
+static VALUE
+curses_get_keyboard_encoding(VALUE obj)
+{
+    return rb_enc_from_encoding(keyboard_encoding);
+}
+
+/*
+ * Document-method: Curses.keyboard_encoding=
+ * call-seq: Curses.keyboard_encoding = encoding
+ *
+ * Sets the encoding for keyboard input.
+ */
+static VALUE
+curses_set_keyboard_encoding(VALUE obj, VALUE enc)
+{
+    keyboard_encoding = rb_to_encoding(enc);
+    return enc;
+}
+
+/*
+ * Document-method: Curses.terminal_encoding
+ * call-seq: Curses.terminal_encoding
+ *
+ * Returns the encoding for terminal output.
+ */
+static VALUE
+curses_get_terminal_encoding(VALUE obj)
+{
+    return rb_enc_from_encoding(terminal_encoding);
+}
+
+/*
+ * Document-method: Curses.terminal_encoding=
+ * call-seq: Curses.terminal_encoding = encoding
+ *
+ * Sets the encoding for terminal output.
+ */
+static VALUE
+curses_set_terminal_encoding(VALUE obj, VALUE enc)
+{
+    terminal_encoding = rb_to_encoding(enc);
+    return enc;
+}
+
+/*
+ * Document-method: Curses.unget_char
+ * call-seq: unget_char(ch)
+ *
+ * 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.
+ */
+static VALUE
+curses_unget_char(VALUE obj, VALUE ch)
+{
+#ifdef HAVE_UNGET_WCH
+    ID id_ord;
+#endif
+
+    curses_stdscr();
+    if (FIXNUM_P(ch)) {
+	ungetch(NUM2UINT(ch));
+    }
+    else {
+	StringValue(ch);
+#ifdef HAVE_UNGET_WCH
+	CONST_ID(id_ord, "ord");
+	unget_wch(NUM2UINT(rb_funcall(ch, id_ord, 0)));
+#else
+	ungetch(NUM2UINT(ch));
+#endif
+    }
+    return Qnil;
+}
+
+static VALUE
+keyboard_uint_chr(unsigned int ch)
+{
+    return rb_enc_uint_chr(ch, keyboard_encoding);
+}
+
+#ifdef HAVE_GET_WCH
+struct get_wch_arg {
+    int retval;
+    wint_t ch;
+};
+
+static void *
+get_wch_func(void *_arg)
+{
+    struct get_wch_arg *arg = (struct get_wch_arg *) _arg;
+    arg->retval = get_wch(&arg->ch);
+    return 0;
+}
+#endif
+
+/*
+ * Document-method: Curses.get_char
+ *
+ * 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
+ *
+ */
+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
+}
+
+
+#ifdef HAVE_WGET_WCH
+struct wget_wch_arg {
+    WINDOW *win;
+    int retval;
+    wint_t ch;
+};
+
+static void *
+wget_wch_func(void *_arg)
+{
+    struct wget_wch_arg *arg = (struct wget_wch_arg *) _arg;
+    arg->retval = wget_wch(arg->win, &arg->ch);
+    return 0;
+}
+#endif
+
+/*
+ * Document-method: Curses::Window.get_char
+ *
+ * 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
+ *
+ */
+static VALUE
+window_get_char(VALUE obj)
+{
+#ifdef HAVE_WGET_WCH
+    struct windata *winp;
+    struct wget_wch_arg arg;
+
+    GetWINDOW(obj, winp);
+    arg.win = winp->window;
+    rb_thread_call_without_gvl(wget_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
+    struct windata *winp;
+    struct wgetch_arg arg;
+
+    GetWINDOW(obj, winp);
+    arg.win = winp->window;
+    rb_thread_call_without_gvl(wgetch_func, (void *)&arg, RUBY_UBF_IO, 0);
+    if (arg.c > 0xff) {
+	return INT2NUM(arg.c);
+    }
+    else if (arg.c >= 0) {
+	return keyboard_uint_chr(arg.c);
+    }
+    else {
+	return Qnil;
+    }
+#endif
+}
+
 /*------------------------- Initialization -------------------------*/
 
 /*
@@ -2656,6 +2929,8 @@ pad_noutrefresh(VALUE obj, VALUE pminrow, VALUE pmincol, VALUE sminrow,
 void
 Init_curses(void)
 {
+    keyboard_encoding = terminal_encoding = rb_locale_encoding();
+
     mCurses    = rb_define_module("Curses");
 
     /*
@@ -2707,6 +2982,7 @@ Init_curses(void)
     rb_define_module_function(mCurses, "refresh", curses_refresh, 0);
     rb_define_module_function(mCurses, "doupdate", curses_doupdate, 0);
     rb_define_module_function(mCurses, "clear", curses_clear, 0);
+    rb_define_module_function(mCurses, "erase", curses_erase, 0);
     rb_define_module_function(mCurses, "clrtoeol", curses_clrtoeol, 0);
     rb_define_module_function(mCurses, "echo", curses_echo, 0);
     rb_define_module_function(mCurses, "noecho", curses_noecho, 0);
@@ -2770,6 +3046,12 @@ Init_curses(void)
     rb_define_module_function(mCurses, "timeout=", curses_timeout, 1);
     rb_define_module_function(mCurses, "def_prog_mode", curses_def_prog_mode, 0);
     rb_define_module_function(mCurses, "reset_prog_mode", curses_reset_prog_mode, 0);
+    rb_define_module_function(mCurses, "keyboard_encoding", curses_get_keyboard_encoding, 0);
+    rb_define_module_function(mCurses, "keyboard_encoding=", curses_set_keyboard_encoding, 1);
+    rb_define_module_function(mCurses, "terminal_encoding", curses_get_terminal_encoding, 0);
+    rb_define_module_function(mCurses, "terminal_encoding=", curses_set_terminal_encoding, 1);
+    rb_define_module_function(mCurses, "unget_char", curses_unget_char, 1);
+    rb_define_module_function(mCurses, "get_char", curses_get_char, 0);
 
     {
         VALUE version;
@@ -2808,23 +3090,23 @@ Init_curses(void)
      *
      * == Usage
      *
-     *   require 'curses'
+     *   require "curses"
      *
-     *   Curses.init_screen()
+     *   Curses.init_screen
      *
      *   my_str = "LOOK! PONIES!"
-     *   bwin = Curses::Window.new( 10, (my_str.length + 10),
-     *                             (Curses.lines - 10) / 2,
-     *                             (Curses.cols - (my_str.length + 10)) / 2 )
+     *
+     *   height, width = 12, my_str.length + 10
+     *   top, left = (Curses.lines - height) / 2, (Curses.cols - width) / 2
+     *   bwin = Curses::Window.new(height, width, top, left)
      *   bwin.box("\\", "/")
      *   bwin.refresh
-     *   win = bwin.subwin( 6, my_str.length + 6,
-     *                     (Curses.lines - 6) / 2,
-     *                     (Curses.cols - (my_str.length + 6)) / 2 )
-     *   win.setpos(2,3)
+     *
+     *   win = bwin.subwin(height - 4, width - 4, top + 2, left + 2)
+     *   win.setpos(2, 3)
      *   win.addstr(my_str)
      *   # or even
-     *   win << "\nORLY"
+     *   win << "\nOH REALLY?"
      *   win << "\nYES!! " + my_str
      *   win.refresh
      *   win.getch
@@ -2837,9 +3119,11 @@ Init_curses(void)
     rb_define_method(cWindow, "subwin", window_subwin, 4);
     rb_define_method(cWindow, "close", window_close, 0);
     rb_define_method(cWindow, "clear", window_clear, 0);
+    rb_define_method(cWindow, "erase", window_erase, 0);
     rb_define_method(cWindow, "clrtoeol", window_clrtoeol, 0);
     rb_define_method(cWindow, "refresh", window_refresh, 0);
     rb_define_method(cWindow, "noutrefresh", window_noutrefresh, 0);
+    rb_define_method(cWindow, "redraw", window_redraw, 0);
     rb_define_method(cWindow, "box", window_box, -1);
     rb_define_method(cWindow, "move", window_move, 2);
     rb_define_method(cWindow, "setpos", window_setpos, 2);
@@ -2883,6 +3167,8 @@ Init_curses(void)
     rb_define_method(cWindow, "nodelay=", window_nodelay, 1);
     rb_define_method(cWindow, "timeout=", window_timeout, 1);
 
+    rb_define_method(cWindow, "get_char", window_get_char, 0);
+
 #ifdef HAVE_NEWPAD
     /*
      * Document-class: Curses::Pad