Add Windows console constants

Expose Windows input constants for console event consumers.

Author: nobu

ext/io/console/console.c

@@ -2406,6 +2406,25 @@ Init_console(void)
 void
 InitVM_console(void)
 {
+    /* :nodoc: */
+    VALUE mConsole = rb_define_module_under(rb_cIO, "Console");
+#ifdef _WIN32
+    /* :nodoc: */
+    VALUE mWindows = rb_define_module_under(mConsole, "Windows");
+#define define_win32_const(name) rb_define_const(mWindows, #name, UINT2NUM(name))
+    EACH_VK(define_win32_const,;);
+    define_win32_const(RIGHT_ALT_PRESSED);
+    define_win32_const(LEFT_ALT_PRESSED);
+    define_win32_const(RIGHT_CTRL_PRESSED);
+    define_win32_const(LEFT_CTRL_PRESSED);
+    define_win32_const(SHIFT_PRESSED);
+    define_win32_const(NUMLOCK_ON);
+    define_win32_const(SCROLLLOCK_ON);
+    define_win32_const(CAPSLOCK_ON);
+    define_win32_const(ENHANCED_KEY);
+#undef define_win32_const
+#endif
+
     rb_define_method(rb_cIO, "raw", console_raw, -1);
     rb_define_method(rb_cIO, "raw!", console_set_raw, -1);
     rb_define_method(rb_cIO, "cooked", console_cooked, 0);
@@ -2466,7 +2485,6 @@ InitVM_console(void)
     }
     {
 	/* :nodoc: */
-	VALUE mConsole = rb_define_module_under(rb_cIO, "Console");
 	VALUE version = rb_obj_freeze(rb_str_new_cstr(IO_CONSOLE_VERSION));
 	ID cid, deprecate_constant = rb_intern_const("deprecate_constant");
 	rb_define_const(mConsole, "VERSION", version);

ext/io/console/depend

@@ -1,9 +1,8 @@
-win32_vk.inc: win32_vk.list
+win32_vk.inc: win32_vk.list $(srcdir)/extract-vk.rb
 
 .list.inc:
 	( \
-	$(RUBY) -e "ARGF.read.scan(/^\w+,\s*\KVK_\w+/){|n|puts(%Q[#ifndef #{n}\n# define #{n} UNDEFINED_VK\n#endif])}" \
-	$< && \
+	$(RUBY) $(srcdir)/extract-vk.rb $< && \
 	gperf --ignore-case -L ANSI-C -E -C -P -p -j1 -i 1 -g -o -t -K ofs -N console_win32_vk -k* $< \
 	| sed -f $(top_srcdir)/tool/gperf.sed \
 	) > $(@F)

ext/io/console/extract-vk.rb

@@ -0,0 +1,7 @@
+code = [+""]
+ARGF.read.scan(/^\w+,\s*\KVK_\w+/) do |n|
+  puts("#ifndef #{n}\n# define #{n} UNDEFINED_VK\n#endif")
+  code << +"" if n.size + code.last.size > 60
+  code.last << " x(#{n})z"
+end
+puts ["#define EACH_VK(x,z)", code].join(" \\\n    "), ""

ext/io/console/win32_vk.inc

@@ -45,6 +45,7 @@ Gem::Specification.new do |s|
       lib/ffi/io/console/native_console.rb
       lib/ffi/io/console/stty_console.rb
       lib/ffi/io/console/stub_console.rb
+      lib/ffi/io/console/windows_constants.rb
       lib/ffi/io/console/version.rb
     ])
   end

io-console.gemspec

@@ -44,6 +44,7 @@ class Mode
 when /linux/
   libs << 'linux' << 'stty'
 when /mswin|win32|ming/i
+  require_relative 'console/windows_constants'
   # If Windows, stty is not possible, always use the stub version
 else
   libs << 'stty'

lib/ffi/io/console.rb

@@ -1,4 +1,7 @@
 # Methods common to all backend impls
+module IO::Console
+end
+
 class IO
   # TODO: Windows version uses "conin$" and "conout$" instead of /dev/tty
   def self.console(sym = nil, *args)

lib/ffi/io/console/common.rb

@@ -0,0 +1,26 @@
+module IO::Console::Windows
+  VK_TAB = 0x09
+  VK_RETURN = 0x0d
+  VK_SHIFT = 0x10
+  VK_CONTROL = 0x11
+  VK_MENU = 0x12
+  VK_END = 0x23
+  VK_HOME = 0x24
+  VK_LEFT = 0x25
+  VK_UP = 0x26
+  VK_RIGHT = 0x27
+  VK_DOWN = 0x28
+  VK_DELETE = 0x2e
+  VK_DIVIDE = 0x6f
+  VK_LMENU = 0xa4
+
+  RIGHT_ALT_PRESSED = 0x0001
+  LEFT_ALT_PRESSED = 0x0002
+  RIGHT_CTRL_PRESSED = 0x0004
+  LEFT_CTRL_PRESSED = 0x0008
+  SHIFT_PRESSED = 0x0010
+  NUMLOCK_ON = 0x0020
+  SCROLLLOCK_ON = 0x0040
+  CAPSLOCK_ON = 0x0080
+  ENHANCED_KEY = 0x0100
+end

lib/ffi/io/console/windows_constants.rb

@@ -7,6 +7,10 @@
 end
 
 class TestIO_Console < Test::Unit::TestCase
+  def test_console_namespace
+    assert_kind_of(Module, IO::Console)
+  end unless RUBY_ENGINE == "jruby" && RbConfig::CONFIG["host_os"] !~ /mswin|mingw/
+
   HOST_OS = RbConfig::CONFIG['host_os']
 
   def test_version
@@ -720,6 +724,26 @@ def test_pressed_invalid
   end
 end
 
+RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ and TestIO_Console.class_eval do
+  def test_virtual_key_constants
+    {
+      VK_TAB: 0x09, VK_RETURN: 0x0d, VK_SHIFT: 0x10,
+      VK_CONTROL: 0x11, VK_MENU: 0x12, VK_END: 0x23,
+      VK_HOME: 0x24, VK_LEFT: 0x25, VK_UP: 0x26,
+      VK_RIGHT: 0x27, VK_DOWN: 0x28, VK_DELETE: 0x2e,
+      VK_DIVIDE: 0x6f, VK_LMENU: 0xa4,
+      RIGHT_ALT_PRESSED: 0x0001, LEFT_ALT_PRESSED: 0x0002,
+      RIGHT_CTRL_PRESSED: 0x0004, LEFT_CTRL_PRESSED: 0x0008,
+      SHIFT_PRESSED: 0x0010, NUMLOCK_ON: 0x0020,
+      SCROLLLOCK_ON: 0x0040, CAPSLOCK_ON: 0x0080,
+      ENHANCED_KEY: 0x0100,
+    }.each do |name, value|
+      assert_equal(value, IO::Console::Windows.const_get(name, false))
+      assert_false(IO::Console.const_defined?(name, false))
+    end
+  end
+end
+
 RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ and defined?(IO.console) and IO.console and \
 TestIO_Console.class_eval do
   def test_output_console_mode