curses 1.4.1 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 857d0a003f909b9e148855feb1d7b5eca2487aab1d22c544e0fdf560a92293b5
-  data.tar.gz: 49329a8c35c0e157c5cba591eb317bf9acf2672af16c8e826aa22ab0ada59cda
+  metadata.gz: d8f509004a715c7c6215130a814987b82b964d9dcf3606e6a289e1666b3a5577
+  data.tar.gz: 0e54526e4d59b8e7d4b154403d71e7bae99db4cfe0dea25ce381f737f265bfef
 SHA512:
-  metadata.gz: 7330fdebb60f3871c10d74685ea5c7ed0194ba7630d0def5cd65de72a3e32e48df343b290ed7e718a116eae1eeab52b5f32d58a4e16e64db6210da9fea19d99e
-  data.tar.gz: 77d3c8bcc7183642917311d0cbde1d14f55771b133adb2b7953a052a02672053a5bdc3dd0fc0ab78963383d1e114c9b4534df643be05cb17c2adfdcfca8d7c1a
+  metadata.gz: 168a0e62efe441de9fa4f737c4f83085f48f4c9330a4f9d2f0eb98beed3bb1a39ec68beb3ee59fa4ba78000c6805a51e039c4c99a8540d7e84b805620749ba17
+  data.tar.gz: deed017c806a7cc9fddb233ad58d52c545473f578238fb514bed2af63003e2ec74488edfdb0c281ed255e47d16b487ce0a74d0d2e24b43a9c3ea4a00f900e2f2

data/.github/workflows/ubuntu.yml

@@ -6,7 +6,7 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: [ head, 2.7, 2.6, 2.5 ]
+        ruby: [ head, 3.1, 2.7, 2.6 ]
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2

data/.github/workflows/windows.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: windows-latest
     strategy:
       matrix:
-        ruby: [ 'mingw', 'mswin', '2.7', '2.6', '2.5' ]
+        ruby: [ 'mingw', 'mswin', '2.7', '2.6' ]
     steps:
     - uses: actions/checkout@v2
       with:

data/History.md

@@ -1,3 +1,26 @@
+### 1.4.4 / 2022-02-03
+
+Bug fixes:
+
+* Define Curses.colors even if COLORS is a macro.
+  Issue #69 by dvarrui.
+* Use require instead of require_relative.
+  Pull request #68 by dvarrui.
+
+### 1.4.3 / 2022-01-06
+
+New features:
+
+* Added flushinp, menu mark, fore and back functions.
+  Pull request #66 by Isty001.
+
+### 1.4.2 / 2021-06-14
+
+New features:
+
+* Added samples for addch, attron, mouse tracking and colors.
+  Pull request #62 by coezbek.
+
 ### 1.4.1 / 2021-05-22
 
 Bug fixes:

data/curses.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new { |s|
   s.name = "curses"
-  s.version = "1.4.1"
+  s.version = "1.4.4"
   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.1.0')
+  s.required_ruby_version = Gem::Requirement.new('>= 2.6.0')
   s.licenses = ['Ruby', 'BSD-2-Clause']
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'rake'

data/ext/curses/curses.c

@@ -620,6 +620,20 @@ curses_nonl(VALUE obj)
     return Qnil;
 }
 
+/*
+ * Document-method: Curses.flushinp
+ *
+ * The flushinp routine throws away any typeahead that has been
+ * typed by the user and has not yet been read by the program.
+ */
+static VALUE
+curses_flushinp(VALUE obj)
+{
+    curses_stdscr();
+    flushinp();
+    return Qnil;
+}
+
 /*
  * Document-method: Curses.beep
  *
@@ -1352,9 +1366,9 @@ curses_can_change_color(VALUE obj)
     return can_change_color() ? Qtrue : Qfalse;
 }
 
-#if defined(HAVE_COLORS)
+#if defined(HAVE_COLORS) || defined(COLORS)
 /*
- * Document-method: Curses.color
+ * Document-method: Curses.colors
  *
  * returns COLORS
  */
@@ -1384,7 +1398,7 @@ curses_color_content(VALUE obj, VALUE color)
 }
 
 
-#if defined(HAVE_COLOR_PAIRS)
+#if defined(HAVE_COLOR_PAIRS) || defined(COLOR_PAIRS)
 /*
  * Document-method: Curses.color_pairs
  *
@@ -3618,6 +3632,121 @@ menu_set_format(VALUE obj, VALUE rows, VALUE cols)
     return obj;
 }
 
+/*
+ * Document-method: Curses::Menu#mark=
+ *
+ * call-seq:
+ *   mark=(str)
+ *
+ * Set the mark string to distinguish the selected items
+ */
+static VALUE
+menu_set_mark(VALUE obj, VALUE mark)
+{
+    struct menudata *menup;
+
+    GetMENU(obj, menup);
+    set_menu_mark(menup->menu, StringValueCStr(mark));
+
+    return obj;
+}
+
+/*
+ * Document-method: Curses::Menu#mark
+ *
+ * call-seq:
+ *   mark
+ *
+ * Get the Menu's mark string
+ */
+static VALUE
+menu_get_mark(VALUE obj)
+{
+    struct menudata *menup;
+    const char *mark;
+
+    GetMENU(obj, menup);
+    mark = menu_mark(menup->menu);
+
+    return rb_external_str_new_with_enc(mark, strlen(mark), terminal_encoding);
+}
+
+/*
+ * Document-method: Curses::Menu#fore=
+ *
+ * call-seq:
+ *   fore=(attr)
+ *
+ * Sets the foreground attribute of menu.
+ * This is the highlight used for selected menu items.
+ */
+static VALUE
+menu_set_fore(VALUE obj, VALUE attr)
+{
+    struct menudata *menup;
+
+    GetMENU(obj, menup);
+    set_menu_fore(menup->menu, NUM2CHTYPE(attr));
+
+    return attr;
+}
+
+/*
+ * Document-method: Curses::Menu#fore
+ *
+ * call-seq:
+ *   fore
+ *
+ * Sets the foreground attribute of menu.
+ * This is the highlight used for selected menu items.
+ */
+static VALUE
+menu_get_fore(VALUE obj, VALUE attr)
+{
+    struct menudata *menup;
+
+    GetMENU(obj, menup);
+
+    return CHTYPE2NUM(menu_fore(menup->menu));
+}
+
+/*
+ * Document-method: Curses::Menu#set_back
+ *
+ * call-seq:
+ *   set_back(attr)
+ *
+ * Get the background attribute of menu.
+ */
+static VALUE
+menu_set_back(VALUE obj, VALUE attr)
+{
+    struct menudata *menup;
+
+    GetMENU(obj, menup);
+    CHTYPE2NUM(set_menu_back(menup->menu, NUM2CHTYPE(attr)));
+
+    return attr;
+}
+
+/*
+ * Document-method: Curses::Menu#back
+ *
+ * call-seq:
+ *   back
+ *
+ * Get the background attribute of menu.
+ */
+static VALUE
+menu_get_back(VALUE obj, VALUE attr)
+{
+    struct menudata *menup;
+
+    GetMENU(obj, menup);
+
+    return CHTYPE2NUM(menu_back(menup->menu));
+}
+
 /*
  * Document-method: Curses::Menu#format
  *
@@ -4753,6 +4882,7 @@ Init_curses(void)
     rb_define_module_function(mCurses, "nocrmode", curses_nocbreak, 0);
     rb_define_module_function(mCurses, "nl", curses_nl, 0);
     rb_define_module_function(mCurses, "nonl", curses_nonl, 0);
+    rb_define_module_function(mCurses, "flushinp", curses_flushinp, 0);
     rb_define_module_function(mCurses, "beep", curses_beep, 0);
     rb_define_module_function(mCurses, "flash", curses_flash, 0);
     rb_define_module_function(mCurses, "ungetch", curses_ungetch, 1);
@@ -4988,6 +5118,12 @@ Init_curses(void)
     rb_define_method(cMenu, "scale", menu_scale, 0);
     rb_define_method(cMenu, "set_format", menu_set_format, 2);
     rb_define_method(cMenu, "format", menu_format_m, 0);
+    rb_define_method(cMenu, "mark=", menu_set_mark, 1);
+    rb_define_method(cMenu, "mark", menu_get_mark, 0);
+    rb_define_method(cMenu, "fore=", menu_set_fore, 1);
+    rb_define_method(cMenu, "fore", menu_get_fore, 0);
+    rb_define_method(cMenu, "back=", menu_set_back, 1);
+    rb_define_method(cMenu, "back", menu_get_back, 0);
     rb_define_method(cMenu, "set_opts", menu_set_opts, 1);
     rb_define_method(cMenu, "opts_on", menu_opts_on_m, 1);
     rb_define_method(cMenu, "opts_off", menu_opts_off_m, 1);

data/sample/addch.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# require_relative "../lib/curses"
+require 'curses'
+
+include Curses
+
+init_screen
+begin
+  addstr("The following letter A should be BOLD and UNDERLINED by using addch:\n")
+  addch('A'.ord | A_BOLD | A_UNDERLINE)
+
+  addstr("\nIt should look the same as when using attron and addstr:\n")
+  attron(A_BOLD | A_UNDERLINE)
+  addstr("A")
+  getch
+
+ensure
+  close_screen
+end

data/sample/attr_demo.rb

@@ -0,0 +1,32 @@
+require "curses"
+include Curses
+
+init_screen
+begin
+  attrs = {
+    A_NORMAL =>     'Normal display (no highlight)',
+    A_STANDOUT =>   'Best highlighting mode of the terminal',
+    A_UNDERLINE =>  'Underlining',
+    A_REVERSE =>    'Reverse video',
+    A_BLINK =>      'Blinking',
+    A_DIM =>        'Half bright',
+    A_BOLD =>       'Extra bright or bold',
+    A_PROTECT =>    'Protected mode',
+    A_INVIS =>      'Invisible or blank mode',
+    A_ALTCHARSET => 'Alternate character set',
+  }
+
+  longest_description = attrs.values.map(&:size).max
+  attrs.each { |attribute, description|
+
+    attrset(A_NORMAL)
+    addstr("#{description.ljust(longest_description)}: ")
+
+    attrset(attribute)
+    addstr([*('a'..'z'), *('0'..'9')].join + "\n")
+  }
+  getch
+
+ensure
+  close_screen
+end

data/sample/colors.rb

@@ -0,0 +1,26 @@
+require "curses"
+include Curses
+
+begin
+  init_screen
+
+  if !Curses.has_colors?
+    addstr "This Terminal does not support colors!"
+  else
+    start_color
+
+    addstr "This Terminal supports #{colors} colors.\n"
+
+    Curses.colors.times { |i|
+      Curses.init_pair(i, i, 0)
+      attrset(color_pair(i))
+      addstr("#{i.to_s.rjust(3)} ")
+      addstr("\n") if i == 15 || (i > 16 && (i - 15) % 36 == 0)
+    }
+  end
+
+  getch
+
+ensure
+  close_screen
+end

data/sample/mouse_move.rb

@@ -0,0 +1,75 @@
+#!/usr/bin/env ruby
+#
+# Mouse movement tracking using CSI 1003 and 1006 (SGR). Will print a cursor that moves with the mouse.
+#
+
+require "curses"
+include Curses
+
+@positions = []
+
+def draw_cursor(y, x, button, state)
+
+  # Keep a trail of 10 previous positions visible on the screen
+  if @positions.size >= 10
+    y_old, x_old = @positions.shift
+    setpos(y_old, x_old)
+    addstr(" ")
+  end
+
+  setpos(2, 1)
+  addstr("Mouse is at y=#{y.to_s.ljust(3)} x=#{x.to_s.ljust(3)} button=#{button.to_s.ljust(3)} #{'%08b' % button}")
+
+  setpos(y, x)
+  addstr("+")
+  @positions << [y, x]
+end
+
+init_screen
+crmode
+noecho
+stdscr.box('|', "-")
+setpos(1,1)
+addstr("Please move your mouse. Press 'q' to close.")
+
+begin
+  # Switch on mouse continous position reporting
+  print("\x1b[?1003h")
+
+  # Also enable SGR extended reporting, because otherwise we can only
+  # receive values up to 160x94. Everything else confuses Ruby Curses.
+  print("\x1b[?1006h")
+
+  loop do
+    c = get_char
+    case c
+    when "q"
+      return
+    when "\e" # ESC
+      case get_char
+      when '['
+        csi = ""
+        loop do
+          d = get_char
+          csi += d
+          if d.ord >= 0x40 && d.ord <= 0x7E
+            break
+          end
+        end
+        if /<(\d+);(\d+);(\d+)(m|M)/ =~ csi
+          button = $1.to_i
+          x = $2.to_i
+          y = $3.to_i
+          state = $4
+          draw_cursor(y, x, button, state)
+        end
+      end
+    end
+  end
+
+ensure
+  print("\x1b[?1003l")
+  print("\x1b[?1006l")
+  close_screen
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: curses
 version: !ruby/object:Gem::Version
-  version: 1.4.1
+  version: 1.4.4
 platform: ruby
 authors:
 - Shugo Maeda
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-22 00:00:00.000000000 Z
+date: 2022-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -64,10 +64,14 @@ files:
 - ext/curses/depend
 - ext/curses/extconf.rb
 - lib/curses.rb
+- sample/addch.rb
+- sample/attr_demo.rb
+- sample/colors.rb
 - sample/form.rb
 - sample/hello.rb
 - sample/menu.rb
 - sample/mouse.rb
+- sample/mouse_move.rb
 - sample/rain.rb
 - sample/view.rb
 - sample/view2.rb
@@ -328,14 +332,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
+rubygems_version: 3.4.0.dev
 signing_key:
 specification_version: 4
 summary: A Ruby binding for curses, ncurses, and PDCurses. curses is an extension