curses 1.4.7 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0170d14a883cec80159b24d85a55741eb721b1863f5eb1d67aea90cf2f54d28c
-  data.tar.gz: 6abb516cc2e6d83eff1c63c2b2f0c27e0e621e759846ba5bf6d5c27beca09a89
+  metadata.gz: b7821de0b5980058b3b4adb34b39ba47e875102ce604bcff147583280af163d0
+  data.tar.gz: c8276542d1753d2e6d75097410b4bf13d75e37024c12fb8906a3b9f2b34e4c08
 SHA512:
-  metadata.gz: d9b13bba5b82c8d2e0a0628698c5e87ac3d9f258f57df8323ecf4157e2704b278fb47103ad112b25b7d780b5ea5fe6cffa3bea9e629a501f4b09d88e2eba96f3
-  data.tar.gz: be30e6050811c9091a7765b0a4aa3f349a9e498edae1cdbf90b4ae34b29c8881a4a5c508a449aeaba8132a5cf0b207b731fe1960bc5dd8b3335837197c5c23cb
+  metadata.gz: bcb0b093de4c2716b505d7905263ed808601d599fa0038dd300365f77280ec730636b92697a8a3ca515ebe21ed8979209ce4c9852c956755e414788b21b5f86a
+  data.tar.gz: 1cd648fb5c3ec64a3fb221f42e4048f5edd096fa5cba801faaf247fc153a77598948a29b62026141802f5e07126857f4b9291569f1b51c1c72d2efdcf13674d3

data/.github/workflows/push_gem.yml

@@ -24,23 +24,23 @@ jobs:
     steps:
       # Set up
       - name: Harden Runner
-        uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
+        uses: step-security/harden-runner@v2
         with:
           egress-policy: audit
 
-      - uses: actions/checkout@0ad4b8fadaa221de15dcec353f45205ec38ea70b # v4.1.4
+      - uses: actions/checkout@v4
         with:
           submodules: true
 
       - name: Set up Ruby
-        uses: ruby/setup-ruby@cacc9f1c0b3f4eb8a16a6bb0ed10897b43b9de49 # v1.176.0
+        uses: ruby/setup-ruby@v1
         with:
           bundler-cache: true
           ruby-version: ruby
 
       # Release
       - name: Publish to RubyGems
-        uses: rubygems/release-gem@612653d273a73bdae1df8453e090060bb4db5f31 # v1
+        uses: rubygems/release-gem@v1
 
       - name: Create GitHub release
         run: |

data/README.md

@@ -46,7 +46,13 @@ _with `/usr/local/opt/ncurses` the path where homebrew installed ncurses on your
 
 ## Documentation
 
-See [https://www.rubydoc.info/gems/curses](https://www.rubydoc.info/gems/curses).
+Type the following command, and see `[rdoc]` of curses:
+
+    > gem server -l
+
+## 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.
 
 ## Developers
 
@@ -55,6 +61,7 @@ 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).
+
 ## License
 
 curses is released under the Ruby and 2-clause BSD licenses.  See COPYING for

data/curses.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new { |s|
   s.name = "curses"
-  s.version = "1.4.7"
+  s.version = "1.5.0"
   s.author = ["Shugo Maeda", 'Eric Hodel']
   s.email = ["shugo@ruby-lang.org", 'drbrain@segment7.net']
   s.homepage = "https://github.com/ruby/curses"
@@ -9,7 +9,7 @@ Gem::Specification.new { |s|
   s.files = `git ls-files --recurse-submodules -z`.split("\x0")
   s.extensions = ["ext/curses/extconf.rb"]
   s.require_path = "lib"
-  s.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
+  s.required_ruby_version = Gem::Requirement.new('>= 3.0')
   s.licenses = ['Ruby', 'BSD-2-Clause']
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'

data/ext/curses/curses.c

@@ -98,8 +98,13 @@ rb_obj2chtype_inline(VALUE x)
 
 static VALUE mCurses;
 static VALUE mKey;
+#ifdef HAVE_NEWTERM
+static VALUE cScreen;
+#endif
 static VALUE cWindow;
+#ifdef HAVE_NEWPAD
 static VALUE cPad;
+#endif
 #ifdef USE_MOUSE
 static VALUE cMouseEvent;
 #endif
@@ -220,6 +225,7 @@ check_curses_error(int error)
 
 struct windata {
     WINDOW *window;
+    int is_stdscr;
 };
 
 static VALUE window_attroff(VALUE obj, VALUE attrs);
@@ -242,7 +248,7 @@ static void
 window_free(void *p)
 {
     struct windata *winp = p;
-    if (winp->window && winp->window != stdscr) delwin(winp->window);
+    if (winp->window && !winp->is_stdscr) delwin(winp->window);
     winp->window = 0;
     xfree(winp);
 }
@@ -263,7 +269,7 @@ static const rb_data_type_t windata_type = {
 };
 
 static VALUE
-prep_window(VALUE class, WINDOW *window)
+prep_window(VALUE class, WINDOW *window, int is_stdscr)
 {
     VALUE obj;
     struct windata *winp;
@@ -275,6 +281,7 @@ prep_window(VALUE class, WINDOW *window)
     obj = rb_obj_alloc(class);
     TypedData_Get_Struct(obj, struct windata, &windata_type, winp);
     winp->window = window;
+    winp->is_stdscr = is_stdscr;
 
     return obj;
 }
@@ -311,7 +318,7 @@ curses_init_screen(VALUE self)
     }
     rb_set_end_proc(curses_finalize, 0);
     clear();
-    rb_stdscr = prep_window(cWindow, stdscr);
+    rb_stdscr = prep_window(cWindow, stdscr, 1);
     return rb_stdscr;
 }
 
@@ -1443,7 +1450,7 @@ curses_pair_content(VALUE obj, VALUE pair)
 static VALUE
 curses_color_pair(VALUE obj, VALUE attrs)
 {
-    return INT2FIX(COLOR_PAIR(NUM2INT(attrs)));
+    return CHTYPE2NUM(COLOR_PAIR(NUM2CHTYPE(attrs)));
 }
 
 /*
@@ -1456,7 +1463,7 @@ static VALUE
 curses_pair_number(VALUE obj, VALUE attrs)
 {
     curses_stdscr();
-    return INT2FIX(PAIR_NUMBER(NUM2LONG(attrs)));
+    return INT2FIX(PAIR_NUMBER(NUM2CHTYPE(attrs)));
 }
 #endif /* USE_COLOR */
 
@@ -1683,6 +1690,121 @@ curses_reset_prog_mode(VALUE obj)
 #define curses_reset_prog_mode rb_f_notimplement
 #endif
 
+/*-------------------------- class Screen --------------------------*/
+
+#ifdef HAVE_NEWTERM
+
+struct screendata {
+    SCREEN *screen;
+    VALUE stdscr;
+};
+
+NORETURN(static void no_screen(void));
+static void
+no_screen(void)
+{
+    rb_raise(rb_eRuntimeError, "no screen");
+}
+
+#define GetSCREEN(obj, screenp) do {\
+    TypedData_Get_Struct((obj), struct screendata, &screendata_type, (screenp));\
+    if ((screenp)->screen == 0) no_screen();\
+} while (0)
+
+static void
+screen_gc_mark(void *p)
+{
+    struct screendata *screenp = p;
+
+    rb_gc_mark(screenp->stdscr);
+}    
+
+static void
+screen_free(void *p)
+{
+    struct screendata *screenp = p;
+    if (screenp->screen) delscreen(screenp->screen);
+    screenp->screen = 0;
+    xfree(screenp);
+}
+
+static size_t
+screen_memsize(const void *p)
+{
+    const struct screendata *screenp = p;
+    size_t size = sizeof(*screenp);
+    if (!screenp) return 0;
+    if (screenp->screen) size += CURSES_SIZEOF_SCREEN;
+    return size;
+}
+
+static const rb_data_type_t screendata_type = {
+    "screendata",
+    {screen_gc_mark, screen_free, screen_memsize,}
+};
+
+/* returns a Curses::Screen object */
+static VALUE
+screen_s_allocate(VALUE class)
+{
+    struct screendata *screenp;
+
+    return TypedData_Make_Struct(class, struct screendata, &screendata_type, screenp);
+}
+
+/*
+ * Document-method: Curses::Screen.new
+ * call-seq: new(outf, inf, type=nil)
+ *
+ * Construct a new Curses::Screen.
+ */
+static VALUE
+screen_initialize(int argc, VALUE *argv, VALUE obj)
+{
+    VALUE outf, inf, type;
+    struct screendata *screenp;
+    rb_io_t *outfptr, *infptr;
+
+    rb_scan_args(argc, argv, "21", &outf, &inf, &type);
+    TypedData_Get_Struct(obj, struct screendata, &screendata_type, screenp);
+    if (screenp->screen) delscreen(screenp->screen);
+    Check_Type(outf, T_FILE);
+    RB_IO_POINTER(outf, outfptr);
+    rb_io_check_writable(outfptr);
+    Check_Type(inf, T_FILE);
+    RB_IO_POINTER(inf, infptr);
+    rb_io_check_readable(infptr);
+    screenp->screen = newterm(NIL_P(type) ? NULL : StringValueCStr(type),
+                              rb_io_stdio_file(outfptr),
+                              rb_io_stdio_file(infptr));
+    screenp->stdscr = Qnil;
+
+    return obj;
+}
+
+/*
+ * Document-method: Curses::Screen.set_term
+ * call-seq: set_term
+ *
+ * Set the current terminal.
+ */
+static VALUE
+screen_set_term(VALUE obj)
+{
+    struct screendata *screenp;
+
+    GetSCREEN(obj, screenp);
+    set_term(screenp->screen);
+    if (NIL_P(screenp->stdscr)) {
+        screenp->stdscr = prep_window(cWindow, stdscr, 1);
+    }
+    rb_stdscr = screenp->stdscr;
+
+    return Qnil;
+}
+
+#endif /* HAVE_NEWTERM */
+
 /*-------------------------- class Window --------------------------*/
 
 /* returns a Curses::Window object */
@@ -1743,7 +1865,7 @@ window_subwin(VALUE obj, VALUE height, VALUE width, VALUE top, VALUE left)
     l = NUM2INT(left);
     GetWINDOW(obj, winp);
     window = subwin(winp->window, h, w, t, l);
-    win = prep_window(rb_obj_class(obj), window);
+    win = prep_window(rb_obj_class(obj), window, 0);
 
     return win;
 }
@@ -1772,7 +1894,7 @@ window_derwin(VALUE obj, VALUE height, VALUE width, VALUE top, VALUE left)
     l = NUM2INT(left);
     GetWINDOW(obj, winp);
     window = derwin(winp->window, h, w, t, l);
-    win = prep_window(rb_obj_class(obj), window);
+    win = prep_window(rb_obj_class(obj), window, 0);
 
     return win;
 }
@@ -2672,7 +2794,7 @@ window_attroff(VALUE obj, VALUE attrs)
     struct windata *winp;
 
     GetWINDOW(obj,winp);
-    return INT2FIX(wattroff(winp->window,NUM2INT(attrs)));
+    return INT2FIX(wattroff(winp->window,NUM2CHTYPE(attrs)));
 #else
     return Qtrue;
 #endif
@@ -2695,10 +2817,10 @@ window_attron(VALUE obj, VALUE attrs)
     VALUE val;
 
     GetWINDOW(obj,winp);
-    val = INT2FIX(wattron(winp->window,NUM2INT(attrs)));
+    val = INT2FIX(wattron(winp->window,NUM2CHTYPE(attrs)));
     if (rb_block_given_p()) {
 	rb_yield(val);
-	wattroff(winp->window,NUM2INT(attrs));
+	wattroff(winp->window,NUM2CHTYPE(attrs));
 	return val;
     }
     else{
@@ -2742,7 +2864,7 @@ window_attrset(VALUE obj, VALUE attrs)
     struct windata *winp;
 
     GetWINDOW(obj,winp);
-    return INT2FIX(wattrset(winp->window,NUM2INT(attrs)));
+    return INT2FIX(wattrset(winp->window,NUM2CHTYPE(attrs)));
 #else
     return Qtrue;
 #endif
@@ -2810,6 +2932,31 @@ window_getbkgd(VALUE obj)
 #endif
 }
 
+/*
+ * Document-method: Curses::Window.chgat
+ * call-seq: chgat(n, attrs)
+ *
+ * Changes the attributes of a given number of characters starting at
+ * the current cursor location.
+ */
+static VALUE
+window_chgat(VALUE obj, VALUE n, VALUE attrs)
+{
+#ifdef HAVE_WCHGAT
+    chtype a = NUM2CHTYPE(attrs);
+    attr_t attr;
+    short pair;
+    struct windata *winp;
+
+    GetWINDOW(obj,winp);
+    attr = a & A_ATTRIBUTES;
+    pair = PAIR_NUMBER(attr);
+    return (wchgat(winp->window, NUM2INT(n), attr, pair, NULL) == OK) ? Qtrue : Qfalse;
+#else
+    return Qnil;
+#endif
+}
+
 /*
  * Document-method: Curses::Window.resize
  * call-seq: resize(lines, cols)
@@ -2986,7 +3133,7 @@ pad_subpad(VALUE obj, VALUE height, VALUE width, VALUE begin_x, VALUE begin_y)
     y = NUM2INT(begin_y);
     GetWINDOW(obj, padp);
     sub_pad = subpad(padp->window, h, w, x, y);
-    pad = prep_window(rb_obj_class(obj), sub_pad);
+    pad = prep_window(rb_obj_class(obj), sub_pad, 0);
 
     return pad;
 }
@@ -4973,6 +5120,34 @@ Init_curses(void)
         rb_define_const(mCurses, "VERSION", version);
     }
 
+#ifdef HAVE_NEWTERM
+    /*
+     * Document-class: Curses::Screen
+     *
+     * == Description
+     *
+     * A Screen represents a terminal.
+     * A program that outputs to more than one terminal should create a Screen
+     *  for each terminal instead of calling Curses.init_screen.
+     *
+     * == Usage
+     *
+     *   require "curses"
+     *
+     *   screen = Screen.new(STDOUT, STDIN, "xterm")
+     *   screen.set_term
+     *   
+     *   Curses.addstr("Hit any key")
+     *   Curses.refresh
+     *   Curses.getch
+     *   Curses.close_screen
+     */
+    cScreen = rb_define_class_under(mCurses, "Screen", rb_cObject);
+    rb_define_alloc_func(cScreen, screen_s_allocate);
+    rb_define_method(cScreen, "initialize", screen_initialize, -1);
+    rb_define_method(cScreen, "set_term", screen_set_term, 0);
+#endif
+
     /*
      * Document-class: Curses::Window
      *
@@ -5064,6 +5239,7 @@ Init_curses(void)
     rb_define_method(cWindow, "bkgdset", window_bkgdset, 1);
     rb_define_method(cWindow, "bkgd", window_bkgd, 1);
     rb_define_method(cWindow, "getbkgd", window_getbkgd, 0);
+    rb_define_method(cWindow, "chgat", window_chgat, 2);
 
     rb_define_method(cWindow, "nodelay=", window_nodelay, 1);
     rb_define_method(cWindow, "timeout=", window_timeout, 1);

data/ext/curses/extconf.rb

@@ -121,7 +121,8 @@ if header_library
               touchwin untouchwin wtouchln is_linetouched is_wintouched
               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)
+              newpad unget_wch get_wch wget_wch PDC_get_key_modifiers
+              chgat wchgat newterm)
     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
@@ -220,7 +221,7 @@ if header_library
     have_func("form_driver_w")
   end
 
-  ["WINDOW", "MEVENT", "ITEM", "MENU", "FIELD", "FORM"].each do |type|
+  ["WINDOW", "MEVENT", "ITEM", "MENU", "FIELD", "FORM", "SCREEN"].each do |type|
     checking_for("sizeof(#{type}) is available") {
       if try_compile(<<EOF, Shellwords.join($defs))
 #if defined(HAVE_PDCURSES_H)

data/lib/curses.rb

@@ -87,3 +87,10 @@ if defined?(Curses::Menu)
   end
 end
 
+module Curses
+  module_function
+
+  def chgat(...)
+    Curses.stdscr.chgat(...)
+  end
+end

data/sample/attr_demo.rb

@@ -26,7 +26,9 @@ begin
     addstr([*('a'..'z'), *('0'..'9')].join + "\n")
   }
   getch
-
+  setpos(0, 0)
+  chgat(6, A_UNDERLINE)
+  getch
 ensure
   close_screen
-end
+end

data/sample/screen.rb

@@ -0,0 +1,9 @@
+require "curses"
+
+screen = Curses::Screen.new(STDOUT, STDIN, "xterm")
+screen.set_term
+
+Curses.addstr("Hit any key")
+Curses.refresh
+Curses.getch
+Curses.close_screen

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: curses
 version: !ruby/object:Gem::Version
-  version: 1.4.7
+  version: 1.5.0
 platform: ruby
 authors:
 - Shugo Maeda
 - Eric Hodel
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-22 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -39,7 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
 email:
 - shugo@ruby-lang.org
 - drbrain@segment7.net
@@ -75,6 +73,7 @@ files:
 - sample/mouse.rb
 - sample/mouse_move.rb
 - sample/rain.rb
+- sample/screen.rb
 - sample/view.rb
 - sample/view2.rb
 - vendor/PDCurses/.gitignore
@@ -326,7 +325,6 @@ licenses:
 - Ruby
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -334,15 +332,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A Ruby binding for curses, ncurses, and PDCurses. curses is an extension
   library for text UI applications. Formerly part of the Ruby standard library, [curses