curses 1.5.4 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c363e2ee899bf325f21d679cdf68e78caec9959d8ae8d631e51aaefdf361470
-  data.tar.gz: f12600ce5a6c645604cc74813def3c0afa9fed11c2e4117f4c53d374b3b77018
+  metadata.gz: c6c663a808bf8a6c76299105512ed71e57db768054d26ffd51527b254b6fed9f
+  data.tar.gz: 6c088c90e25573f398d2051b84be37c394acace504948ed831d039e1e625efe2
 SHA512:
-  metadata.gz: ee80959584814c5102f2e2e881c3da795833d4c682cd952b5484ad11d2aa14130916fef00fea1d42d345d3d75a1ced642fd0bb9b839414fa90615cace0ad34f8
-  data.tar.gz: de4842e3f63642306b6a914084d5979c12d81263eeffdf82f2b0c56fc1da8c3ccadb400971a8541811d0244c456428f42fb6e5c20655fb163e77f5571ec8a1c4
+  metadata.gz: e4404453e5b9c2d2db0697131c1253f3363d553e51f7427822e4ec7d5c70b3959a457cb4791c694be979d54bf0dec13dbf2b7904bab6115a0b7722979982829c
+  data.tar.gz: 5a6e4d31948c5808601fec0e34633b185586657af4e6bb8d95e07b9144991e0ff3e5f15584985997e9847232510d55c99b9b9821a052ef7784607a1aa2f8214b

data/.github/workflows/push_gem.yml

@@ -24,7 +24,7 @@ jobs:
     steps:
       # Set up
       - name: Harden Runner
-        uses: step-security/harden-runner@5ef0c079ce82195b2a36a210272d6b661572d83e # v2.14.2
+        uses: step-security/harden-runner@a90bcbc6539c36a85cdfeb73f7e2f433735f215b # v2.15.0
         with:
           egress-policy: audit
 

data/README.md

@@ -53,7 +53,7 @@ Type the following command, and see `[rdoc]` of curses:
 
 ## Limitations
 
-* curses.gem doesn't support more than 256 color pairs.  See https://reversed.top/2019-02-05/more-than-256-curses-color-pairs/ for details.
+* On ncurses 6+ compiled with extended color support, more than 256 color pairs are supported transparently via the extended colors API (`init_extended_pair`, etc.). Use `Curses.support_extended_colors?` to check at runtime.
 
 ## Developers
 

data/curses.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new { |s|
   s.name = "curses"
-  s.version = "1.5.4"
+  s.version = "1.6.0"
   s.author = ["Shugo Maeda", 'Eric Hodel']
   s.email = ["shugo@ruby-lang.org", 'drbrain@segment7.net']
   s.homepage = "https://github.com/ruby/curses"

data/ext/curses/curses.c

@@ -1321,7 +1321,11 @@ curses_init_pair(VALUE obj, VALUE pair, VALUE f, VALUE b)
 {
     /* may have to raise exception on ERR */
     curses_stdscr();
+#ifdef HAVE_INIT_EXTENDED_PAIR
+    return (init_extended_pair(NUM2INT(pair), NUM2INT(f), NUM2INT(b)) == OK) ? Qtrue : Qfalse;
+#else
     return (init_pair(NUM2INT(pair),NUM2INT(f),NUM2INT(b)) == OK) ? Qtrue : Qfalse;
+#endif
 }
 
 /*
@@ -1345,8 +1349,13 @@ curses_init_color(VALUE obj, VALUE color, VALUE r, VALUE g, VALUE b)
 {
     /* may have to raise exception on ERR */
     curses_stdscr();
+#ifdef HAVE_INIT_EXTENDED_COLOR
+    return (init_extended_color(NUM2INT(color), NUM2INT(r),
+				NUM2INT(g), NUM2INT(b)) == OK) ? Qtrue : Qfalse;
+#else
     return (init_color(NUM2INT(color),NUM2INT(r),
 		       NUM2INT(g),NUM2INT(b)) == OK) ? Qtrue : Qfalse;
+#endif
 }
 
 /*
@@ -1397,11 +1406,22 @@ curses_colors(VALUE obj)
 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));
+#ifdef HAVE_EXTENDED_COLOR_CONTENT
+    {
+	int r, g, b;
+	if (extended_color_content(NUM2INT(color), &r, &g, &b) == ERR)
+	    return Qnil;
+	return rb_ary_new3(3, INT2FIX(r), INT2FIX(g), INT2FIX(b));
+    }
+#else
+    {
+	short r, g, b;
+	if (color_content(NUM2INT(color), &r, &g, &b) == ERR)
+	    return Qnil;
+	return rb_ary_new3(3, INT2FIX(r), INT2FIX(g), INT2FIX(b));
+    }
+#endif
 }
 
 
@@ -1430,11 +1450,22 @@ curses_color_pairs(VALUE obj)
 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));
+#ifdef HAVE_EXTENDED_PAIR_CONTENT
+    {
+	int f, b;
+	if (extended_pair_content(NUM2INT(pair), &f, &b) == ERR)
+	    return Qnil;
+	return rb_ary_new3(2, INT2FIX(f), INT2FIX(b));
+    }
+#else
+    {
+	short f, b;
+	if (pair_content(NUM2INT(pair), &f, &b) == ERR)
+	    return Qnil;
+	return rb_ary_new3(2, INT2FIX(f), INT2FIX(b));
+    }
+#endif
 }
 
 /*
@@ -1465,6 +1496,41 @@ curses_pair_number(VALUE obj, VALUE attrs)
     curses_stdscr();
     return INT2FIX(PAIR_NUMBER(NUM2CHTYPE(attrs)));
 }
+
+/*
+ * Document-method: Curses.support_extended_colors?
+ *
+ * Returns +true+ if the ncurses library was compiled with extended color
+ * support (i.e., init_extended_pair, init_extended_color, etc. are available),
+ * +false+ otherwise.
+ */
+static VALUE
+curses_support_extended_colors(VALUE obj)
+{
+#if defined(HAVE_INIT_EXTENDED_PAIR) && defined(HAVE_INIT_EXTENDED_COLOR) && \
+    defined(HAVE_EXTENDED_COLOR_CONTENT) && defined(HAVE_EXTENDED_PAIR_CONTENT)
+    return Qtrue;
+#else
+    return Qfalse;
+#endif
+}
+
+/*
+ * Document-method: Curses.reset_color_pairs
+ *
+ * Resets all color pairs to undefined. Requires ncurses 6.1+.
+ */
+#ifdef HAVE_RESET_COLOR_PAIRS
+static VALUE
+curses_reset_color_pairs(VALUE obj)
+{
+    curses_stdscr();
+    reset_color_pairs();
+    return Qnil;
+}
+#else
+#define curses_reset_color_pairs rb_f_notimplement
+#endif
 #endif /* USE_COLOR */
 
 #ifdef USE_MOUSE
@@ -2717,7 +2783,7 @@ window_setscrreg(VALUE obj, VALUE top, VALUE bottom)
 #endif
 }
 
-#if defined(USE_COLOR) && defined(HAVE_WCOLOR_SET)
+#if defined(USE_COLOR) && ((defined(HAVE_WATTR_SET) && defined(HAVE_WATTR_GET)) || defined(HAVE_WCOLOR_SET))
 /*
  * Document-method: Curses::Window.color_set
  * call-seq: color_set(col)
@@ -2729,13 +2795,26 @@ static VALUE
 window_color_set(VALUE obj, VALUE col)
 {
     struct windata *winp;
-    int res;
 
     GetWINDOW(obj, winp);
-    res = wcolor_set(winp->window, NUM2INT(col), NULL);
-    return (res == OK) ? Qtrue : Qfalse;
+#if defined(HAVE_WATTR_SET) && defined(HAVE_WATTR_GET)
+    /* Use wattr_set to support pair numbers > 255; preserve existing attrs. */
+    {
+	attr_t attrs;
+#ifdef NCURSES_PAIRS_T
+	NCURSES_PAIRS_T current_pair;
+#else
+	short current_pair;
+#endif
+	if (wattr_get(winp->window, &attrs, &current_pair, NULL) == ERR)
+	    return Qfalse;
+	return (wattr_set(winp->window, attrs, NUM2INT(col), NULL) == OK) ? Qtrue : Qfalse;
+    }
+#else
+    return (wcolor_set(winp->window, NUM2INT(col), NULL) == OK) ? Qtrue : Qfalse;
+#endif
 }
-#endif /* defined(USE_COLOR) && defined(HAVE_WCOLOR_SET) */
+#endif /* defined(USE_COLOR) && ((defined(HAVE_WATTR_SET) && defined(HAVE_WATTR_GET)) || defined(HAVE_WCOLOR_SET)) */
 
 /*
  * Document-method: Curses::Window.scroll
@@ -2870,6 +2949,60 @@ window_attrset(VALUE obj, VALUE attrs)
 #endif
 }
 
+/*
+ * Document-method: Curses::Window.attr_set
+ * call-seq: attr_set(attrs, pair)
+ *
+ * Sets the current attributes and color pair of the given window.
+ * Unlike Curses::Window.attrset, this method accepts an extended color
+ * pair number (> 255) when the ncurses extended colors API is available.
+ *
+ * Returns +true+ on success, +false+ on failure.
+ *
+ * see also system manual curs_attr(3)
+ */
+#ifdef HAVE_WATTR_SET
+static VALUE
+window_attr_set(VALUE obj, VALUE attrs, VALUE pair)
+{
+    struct windata *winp;
+
+    GetWINDOW(obj, winp);
+    return (wattr_set(winp->window, NUM2UINT(attrs), NUM2INT(pair), NULL) == OK) ? Qtrue : Qfalse;
+}
+#endif
+
+/*
+ * Document-method: Curses::Window.attr_get
+ * call-seq: attr_get => [attrs, pair]
+ *
+ * Returns a 2-element Array of the current attributes and color pair
+ * of the given window. The color pair number may exceed 255 when the
+ * ncurses extended colors API is available.
+ *
+ * Returns +nil+ on failure.
+ *
+ * see also system manual curs_attr(3)
+ */
+#ifdef HAVE_WATTR_GET
+static VALUE
+window_attr_get(VALUE obj)
+{
+    struct windata *winp;
+    attr_t attrs;
+#ifdef NCURSES_PAIRS_T
+    NCURSES_PAIRS_T pair;
+#else
+    short pair;
+#endif
+
+    GetWINDOW(obj, winp);
+    if (wattr_get(winp->window, &attrs, &pair, NULL) == ERR)
+	return Qnil;
+    return rb_ary_new3(2, UINT2NUM(attrs), INT2NUM(pair));
+}
+#endif
+
 /*
  * Document-method: Curses::Window.bkgdset
  * call-seq: bkgdset(ch)
@@ -5071,6 +5204,8 @@ Init_curses(void)
     rb_define_module_function(mCurses, "pair_content", curses_pair_content, 1);
     rb_define_module_function(mCurses, "color_pair", curses_color_pair, 1);
     rb_define_module_function(mCurses, "pair_number", curses_pair_number, 1);
+    rb_define_module_function(mCurses, "support_extended_colors?", curses_support_extended_colors, 0);
+    rb_define_module_function(mCurses, "reset_color_pairs", curses_reset_color_pairs, 0);
 #endif /* USE_COLOR */
 #ifdef USE_MOUSE
     rb_define_module_function(mCurses, "getmouse", curses_getmouse, 0);
@@ -5203,9 +5338,9 @@ Init_curses(void)
     rb_define_method(cWindow, "move", window_move, 2);
     rb_define_method(cWindow, "move_relative", window_move_relative, 2);
     rb_define_method(cWindow, "setpos", window_setpos, 2);
-#if defined(USE_COLOR) && defined(HAVE_WCOLOR_SET)
+#if defined(USE_COLOR) && ((defined(HAVE_WATTR_SET) && defined(HAVE_WATTR_GET)) || defined(HAVE_WCOLOR_SET))
     rb_define_method(cWindow, "color_set", window_color_set, 1);
-#endif /* USE_COLOR && HAVE_WCOLOR_SET */
+#endif
     rb_define_method(cWindow, "cury", window_cury, 0);
     rb_define_method(cWindow, "curx", window_curx, 0);
     rb_define_method(cWindow, "maxy", window_maxy, 0);
@@ -5236,6 +5371,12 @@ Init_curses(void)
     rb_define_method(cWindow, "attroff", window_attroff, 1);
     rb_define_method(cWindow, "attron", window_attron, 1);
     rb_define_method(cWindow, "attrset", window_attrset, 1);
+#ifdef HAVE_WATTR_SET
+    rb_define_method(cWindow, "attr_set", window_attr_set, 2);
+#endif
+#ifdef HAVE_WATTR_GET
+    rb_define_method(cWindow, "attr_get", window_attr_get, 0);
+#endif
     rb_define_method(cWindow, "bkgdset", window_bkgdset, 1);
     rb_define_method(cWindow, "bkgd", window_bkgd, 1);
     rb_define_method(cWindow, "getbkgd", window_getbkgd, 0);

data/ext/curses/extconf.rb

@@ -119,7 +119,9 @@ if header_library
               def_prog_mode reset_prog_mode timeout wtimeout nodelay
               init_color wcolor_set use_default_colors assume_default_colors
               newpad unget_wch get_wch wget_wch PDC_get_key_modifiers
-              chgat wchgat newterm)
+              chgat wchgat newterm
+              init_extended_color init_extended_pair extended_color_content
+              extended_pair_content reset_color_pairs wattr_set wattr_get)
     have_func(f) || (have_macro(f, curses) && $defs.push(format("-DHAVE_%s", f.upcase)))
   end
   convertible_int('chtype', [["#undef MOUSE_MOVED\n"]]+curses) or abort

data/sample/colors.rb

@@ -5,6 +5,7 @@ include Curses
 
 # The TERM environment variable should be set to xterm-256color etc. to
 # use 256 colors.  Curses.colors returns the color numbers of the terminal.
+# With ncurses 6+ extended color support, color_pairs may exceed 256.
 
 begin
   init_screen
@@ -14,14 +15,24 @@ begin
   else
     start_color
 
-    addstr "This Terminal supports #{colors} colors.\n"
-
-    Curses.colors.times { |i|
-      Curses.init_pair(i, i, 0)
-      attrset(color_pair(i))
+    extended = Curses.support_extended_colors?
+    addstr "This Terminal supports #{colors} colors, #{color_pairs} pairs"
+    addstr extended ? " (extended).\n" : ".\n"
+
+    (extended ? [512, color_pairs].min : colors).times { |i|
+      next if i == 0
+      Curses.init_pair(i, i % colors, (i / colors) % colors)
+      if extended
+        # color_pair() encodes into chtype and can't handle pairs > 255;
+        # use color_set on stdscr instead, which calls wattr_set internally.
+        stdscr.color_set(i)
+      else
+        attrset(color_pair(i))
+      end
       addstr("#{i.to_s.rjust(3)} ")
       addstr("\n") if i == 15 || (i > 16 && (i - 15) % 36 == 0)
     }
+    stdscr.color_set(0)
   end
 
   getch

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: curses
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 1.6.0
 platform: ruby
 authors:
 - Shugo Maeda