win32console 1.2.0-x86-mingw32

data/lib/Win32/Console.rb

@@ -0,0 +1,372 @@
+# Win32::Console:  an object implementing the Win32 API Console functions
+# Copyright (C) 2003 Gonzalo Garramuno (ggarramuno@aol.com)
+#
+# Original Win32API_Console was:
+# Copyright (C) 2001 Michael L. Semon (mlsemon@sega.net)
+
+begin
+  # If Console.so is available, use that.  Otherwise, we define
+  # equivalent functions in ruby (a tad slower)
+  # That dll should define everything in an identical interface
+  # to all the ruby code that the rescue below defines.
+
+  require "Console.so"
+  STDERR.print "Using faster, DLL Console.so\n" if $DEBUG
+
+rescue Exception
+
+  STDERR.print "Using slower, non-DLL Console.rb\n" if $DEBUG
+
+  require 'Win32/Console/constants.rb'
+  require 'Win32/Console/api.rb'
+
+end  # rescue
+
+module Win32
+  class Console
+
+    VERSION = '1.0'
+
+    include Win32::Console::Constants
+
+    def initialize( t = nil )
+      if t and ( t == STD_INPUT_HANDLE or t == STD_OUTPUT_HANDLE or
+                 t == STD_ERROR_HANDLE )
+        @handle = API.GetStdHandle( t )
+      else
+        param1 = GENERIC_READ    | GENERIC_WRITE
+        param2 = FILE_SHARE_READ | FILE_SHARE_WRITE
+        @handle = API.CreateConsoleScreenBuffer( param1, param2,
+                                                 CONSOLE_TEXTMODE_BUFFER )
+      end
+    end
+
+    def Display
+      return API.SetConsoleActiveScreenBuffer(@handle)
+    end
+
+    def Select(type)
+      return API.SetStdHandle(type,@handle)
+    end
+
+    def Title(title = nil)
+      if title
+        return API.SetConsoleTitle(title)
+      else
+        return API.GetConsoleTitle()
+      end
+    end
+
+    def WriteChar(s, col, row)
+      API.WriteConsoleOutputCharacter( @handle, s, col, row )
+    end
+
+    def ReadChar(size, col, row)
+      buffer = ' ' * size
+      if API.ReadConsoleOutputCharacter( @handle, buffer, size, col, row )
+        return buffer
+      else
+        return nil
+      end
+    end
+
+    def WriteAttr(attr, col, row)
+      API.WriteConsoleOutputAttribute( @handle, attr, col, row )
+    end
+
+    def ReadAttr(size, col, row)
+      x = API.ReadConsoleOutputAttribute( @handle, size, col, row )
+      return x.unpack('c'*size)
+    end
+
+    def Cursor(*t)
+      col, row, size, visi = t
+      if col
+        row = -1 if !row
+        if col < 0 or row < 0
+          curr_col, curr_row = API.GetConsoleScreenBufferInfo(@handle)
+          col = curr_col if col < 0
+          row = curr_row if row < 0
+        end
+        API.SetConsoleCursorPosition( @handle, col, row )
+        if size and visi
+          curr_size, curr_visi = API.GetConsoleCursorInfo( @handle )
+          size = curr_size if size < 0
+          visi = curr_visi if visi < 0
+          size = 1 if size < 1
+          size = 99 if size > 99
+          API.SetConsoleCursorInfo( @handle, size, visi )
+        end
+      else
+        d, d, curr_col, curr_row = API.GetConsoleScreenBufferInfo(@handle)
+        curr_size, curr_visi = API.GetConsoleCursorInfo( @handle )
+        return [ curr_col, curr_row, curr_size, curr_visi ]
+      end
+    end
+
+    def Write(s)
+      API.WriteConsole( @handle, s )
+    end
+
+    def WriteFile(s)
+      API.WriteFile( @handle, s)
+    end
+
+    def ReadRect( left, top, right, bottom )
+      col = right  - left + 1
+      row = bottom - top  + 1
+      size = col * row
+      buffer = ' ' * size * 4
+      if API.ReadConsoleOutput( @handle, buffer, col, row, 0, 0,
+                               left, top, right, bottom )
+        #return buffer.unpack('US'*size)  # for unicode
+        return buffer.unpack('axS'*size)  # for ascii
+      else
+        return nil
+      end
+    end
+
+    def WriteRect( buffer, left, top, right, bottom )
+      col = right  - left + 1
+      row = bottom - top  + 1
+      API.WriteConsoleOutput( @handle, buffer, col, row, 0, 0,
+                             left, top, right, bottom )
+    end
+
+    def Scroll( left1, top1, right1, bottom1,
+               col, row, char, attr,
+               left2, top2, right2, bottom2 )
+      API.ScrollConsoleScreenBuffer(@handle, left1, top1, right1, bottom1,
+                                    col, row, char, attr,
+                                    left2, top2, right2, bottom2)
+    end
+
+    def MaxWindow(flag = nil)
+      if !flag
+        info = API.GetConsoleScreenBufferInfo(@handle)
+        return info[9], info[10]
+      else
+        return API.GetLargestConsoleWindowSize(@handle)
+      end
+    end
+
+    def Info()
+      return API.GetConsoleScreenBufferInfo( @handle )
+    end
+
+    def GetEvents()
+      return API.GetNumberOfConsoleInputEvents(@handle)
+    end
+
+    def Flush()
+      return API.FlushConsoleInputBuffer(@handle)
+    end
+
+    def InputChar(number = nil)
+      number = 1 unless number
+      buffer = ' ' * number
+      if API.ReadConsole(@handle, buffer, number) == number
+        return buffer
+      else
+        return nil
+      end
+    end
+
+    def Input()
+      API.ReadConsoleInput(@handle)
+    end
+
+    def PeekInput()
+      API.PeekConsoleInput(@handle)
+    end
+
+    def Mode(mode = nil)
+      if mode
+        mode = mode.pack('L') if mode === Array
+        API.SetConsoleMode(@handle, mode)
+      else
+        begin
+          x =  API.GetConsoleMode(@handle)
+          return x
+        rescue
+          return 9999
+        end
+      end
+    end
+
+    def WriteInput(*t)
+      API.WriteConsoleInput(@handle, *t)
+    end
+
+    def Attr(*attr)
+      if attr.size > 0
+        API.SetConsoleTextAttribute( @handle, attr[0] )
+      else
+        info = API.GetConsoleScreenBufferInfo( @handle )
+        return info[4]
+      end
+    end
+
+    def Size(*t)
+      if t.size == 0
+        col, row = API.GetConsoleScreenBufferInfo(@handle )
+        return [col, row]
+      else
+        row = -1 if !t[1]
+        col = -1 if !t[0]
+        if col < 0 or row < 0
+          curr_col, curr_row = Size()
+          col = curr_col if col < 0
+          row = curr_row if row < 0
+        end
+        API.SetConsoleScreenBufferSize(@handle, row, col)
+      end
+    end
+
+    def Window(*t)
+      if t.size != 5
+        info = API.GetConsoleScreenBufferInfo( @handle )
+        return info[5..8]
+      else
+        API.SetConsoleWindowInfo(@handle, t[0], t[1], t[2], t[3], t[4])
+      end
+    end
+
+    def FillAttr(attr, number = 1, col = -1, row = -1)
+      if col < 0 or row < 0
+        d, d, curr_col, curr_row = API.GetConsoleScreenBufferInfo(@handle)
+        col = curr_col if col < 0
+        row = curr_row if row < 0
+      end
+      API.FillConsoleOutputAttribute(@handle, attr, number, col, row)
+    end
+
+    def FillChar(char, number, col = -1, row = -1)
+      if col < 0 or row < 0
+        d, d, curr_col, curr_row = API.GetConsoleScreenBufferInfo(@handle)
+        col = curr_col if col < 0
+        row = curr_row if row < 0
+      end
+      API.FillConsoleOutputCharacter(@handle, char[0], number, col, row)
+    end
+
+    def Cls()
+      attr = ATTR_NORMAL
+      x, y = Size()
+      left, top, right , bottom = Window()
+      vx = right  - left
+      vy = bottom - top
+      FillChar(' ', x*y, 0, 0)
+      FillAttr(attr, x*y, 0, 0)
+      Cursor(0,0)
+      Window(1,0,0,vx,vy)
+    end
+
+    def Console.Free()
+      API.FreeConsole()
+    end
+
+    def Console.Alloc()
+      API.AllocConsole()
+    end
+
+    def Console.MouseButtons()
+      API.GetNumberOfConsoleMouseButtons()
+    end
+
+    def Console.InputCP(codepage=nil)
+      if codepage
+        API.SetConsoleCP(codepage)
+      else
+        return API.GetConsoleCP()
+      end
+    end
+
+    def Console.OutputCP(codepage=nil)
+      if codepage
+        API.SetConsoleOutputCP(codepage)
+      else
+        return API.GetConsoleOutputCP()
+      end
+    end
+
+    def Console.GenerateCtrlEvent( type=nil, pid=nil )
+      type = API.constant('CTRL_C_EVENT') if type == nil
+      pid  = 0 if pid == nil
+      API.GenerateConsoleCtrlEvent(type, pid)
+    end
+
+  end
+end
+
+
+FG_BLACK        = 0
+FG_BLUE         = Win32::Console::API.constant("FOREGROUND_BLUE")
+FG_LIGHTBLUE    = Win32::Console::API.constant("FOREGROUND_BLUE")|
+                  Win32::Console::API.constant("FOREGROUND_INTENSITY")
+FG_RED          = Win32::Console::API.constant("FOREGROUND_RED")
+FG_LIGHTRED     = Win32::Console::API.constant("FOREGROUND_RED")|
+                  Win32::Console::API.constant("FOREGROUND_INTENSITY")
+FG_GREEN        = Win32::Console::API.constant("FOREGROUND_GREEN")
+FG_LIGHTGREEN   = Win32::Console::API.constant("FOREGROUND_GREEN")|
+                  Win32::Console::API.constant("FOREGROUND_INTENSITY")
+FG_MAGENTA      = Win32::Console::API.constant("FOREGROUND_RED")|
+                  Win32::Console::API.constant("FOREGROUND_BLUE")
+FG_LIGHTMAGENTA = Win32::Console::API.constant("FOREGROUND_RED")|
+                  Win32::Console::API.constant("FOREGROUND_BLUE")|
+                  Win32::Console::API.constant("FOREGROUND_INTENSITY")
+FG_CYAN         = Win32::Console::API.constant("FOREGROUND_GREEN")|
+                  Win32::Console::API.constant("FOREGROUND_BLUE")
+FG_LIGHTCYAN    = Win32::Console::API.constant("FOREGROUND_GREEN")|
+                  Win32::Console::API.constant("FOREGROUND_BLUE")|
+                  Win32::Console::API.constant("FOREGROUND_INTENSITY")
+FG_BROWN        = Win32::Console::API.constant("FOREGROUND_RED")|
+                  Win32::Console::API.constant("FOREGROUND_GREEN")
+FG_YELLOW       = Win32::Console::API.constant("FOREGROUND_RED")|
+                  Win32::Console::API.constant("FOREGROUND_GREEN")|
+                  Win32::Console::API.constant("FOREGROUND_INTENSITY")
+FG_GRAY         = Win32::Console::API.constant("FOREGROUND_RED")|
+                  Win32::Console::API.constant("FOREGROUND_GREEN")|
+                  Win32::Console::API.constant("FOREGROUND_BLUE")
+FG_WHITE        = Win32::Console::API.constant("FOREGROUND_RED")|
+                  Win32::Console::API.constant("FOREGROUND_GREEN")|
+                  Win32::Console::API.constant("FOREGROUND_BLUE")|
+                  Win32::Console::API.constant("FOREGROUND_INTENSITY")
+
+BG_BLACK        = 0
+BG_BLUE         = Win32::Console::API.constant("BACKGROUND_BLUE")
+BG_LIGHTBLUE    = Win32::Console::API.constant("BACKGROUND_BLUE")|
+                  Win32::Console::API.constant("BACKGROUND_INTENSITY")
+BG_RED          = Win32::Console::API.constant("BACKGROUND_RED")
+BG_LIGHTRED     = Win32::Console::API.constant("BACKGROUND_RED")|
+                  Win32::Console::API.constant("BACKGROUND_INTENSITY")
+BG_GREEN        = Win32::Console::API.constant("BACKGROUND_GREEN")
+BG_LIGHTGREEN   = Win32::Console::API.constant("BACKGROUND_GREEN")|
+                  Win32::Console::API.constant("BACKGROUND_INTENSITY")
+BG_MAGENTA      = Win32::Console::API.constant("BACKGROUND_RED")|
+                  Win32::Console::API.constant("BACKGROUND_BLUE")
+BG_LIGHTMAGENTA = Win32::Console::API.constant("BACKGROUND_RED")|
+                  Win32::Console::API.constant("BACKGROUND_BLUE")|
+                  Win32::Console::API.constant("BACKGROUND_INTENSITY")
+BG_CYAN         = Win32::Console::API.constant("BACKGROUND_GREEN")|
+                  Win32::Console::API.constant("BACKGROUND_BLUE")
+BG_LIGHTCYAN    = Win32::Console::API.constant("BACKGROUND_GREEN")|
+                  Win32::Console::API.constant("BACKGROUND_BLUE")|
+                  Win32::Console::API.constant("BACKGROUND_INTENSITY")
+BG_BROWN        = Win32::Console::API.constant("BACKGROUND_RED")|
+                  Win32::Console::API.constant("BACKGROUND_GREEN")
+BG_YELLOW       = Win32::Console::API.constant("BACKGROUND_RED")|
+                  Win32::Console::API.constant("BACKGROUND_GREEN")|
+                  Win32::Console::API.constant("BACKGROUND_INTENSITY")
+BG_GRAY         = Win32::Console::API.constant("BACKGROUND_RED")|
+                  Win32::Console::API.constant("BACKGROUND_GREEN")|
+                  Win32::Console::API.constant("BACKGROUND_BLUE")
+BG_WHITE        = Win32::Console::API.constant("BACKGROUND_RED")|
+                  Win32::Console::API.constant("BACKGROUND_GREEN")|
+                  Win32::Console::API.constant("BACKGROUND_BLUE")|
+                  Win32::Console::API.constant("BACKGROUND_INTENSITY")
+
+ATTR_NORMAL  = FG_GRAY  | BG_BLACK
+ATTR_INVERSE = FG_BLACK | BG_GRAY
+
+include Win32::Console::Constants

data/lib/win32console.rb

@@ -0,0 +1 @@
+require 'Win32/Console/ANSI'

data/test/test_cursor.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "Win32/Console"
+
+
+a = Win32::Console.new(STD_OUTPUT_HANDLE)
+
+puts "Setting cursor to visible and 100% fat"
+a.Cursor(-1,-1,100,1)

data/test/test_mouse.rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require "Win32/Console"
+
+a = Win32::Console.new()
+puts "# of Mouse buttons: #{Win32::Console.MouseButtons}"

data/test/test_readinput.rb

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+require "Win32/Console"
+
+include Win32::Console::Constants
+a = Win32::Console.new(STD_INPUT_HANDLE)
+
+puts "InputChar: Type a phrase then ENTER, please:"
+
+x1 = a.InputChar(1)
+puts "Your phrase starts with the character #{x1}"
+
+
+fdwMode = ENABLE_WINDOW_INPUT | ENABLE_MOUSE_INPUT
+
+a.Mode(fdwMode)
+
+puts
+puts "PeekInput: Type a character without ENTER or do something, please:"
+
+while (x1 = a.PeekInput()).size < 1
+end
+
+if x1[0] == KEY_EVENT
+  puts "You typed #{x1[5]}='#{x1[5].chr}'"
+else
+  print "You did not typed, but "
+  case x1[0]
+  when MOUSE_EVENT
+    puts "used mouse"
+  when WINDOW_BUFFER_SIZE_EVENT
+    puts "resize window"
+  when MENU_EVENT
+    puts "called menu"
+  when FOCUS_EVENT
+    puts "changed focus"
+  else
+    puts "...should never get here"
+  end
+end
+
+puts
+puts "Input (as PeekInput keeps event, this reuses PeekInput value):"
+x1 = a.Input()
+if x1[0] == KEY_EVENT
+  puts "You typed #{x1[5]}='#{x1[5].chr}'"
+else
+  print "You did not typed, but "
+  case x1[0]
+  when MOUSE_EVENT
+    puts "used mouse"
+  when WINDOW_BUFFER_SIZE_EVENT
+    puts "resize window"
+  when MENU_EVENT
+    puts "called menu"
+  when FOCUS_EVENT
+    puts "changed focus"
+  else
+    puts "...should never get here"
+  end
+end
+

data/test/test_readoutput.rb

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require "Win32/Console"
+
+include Win32::Console::Constants
+a = Win32::Console.new(STD_OUTPUT_HANDLE)
+
+puts <<'EOF'
+This is a simple
+test of test to grab
+from the console.
+Hopefully this will work
+easily and merrily.
+This is a simple
+test of test to grab
+from the console.
+Hopefully this will work
+easily and merrily.
+This is a simple
+test of test to grab
+from the console.
+Hopefully this will work
+easily and merrily.
+EOF
+
+x1 = a.ReadChar(10,10,10)
+x2 = a.ReadAttr(10,10,10)
+x3 = a.ReadRect(10,10,20,10)
+puts "ReadChar .#{x1}."
+puts x2.class, x2.size
+print "ReadAttr ."
+for i in x2
+  print "#{i}|"
+end
+print "\nReadRect ."
+
+i = 0
+while i < x3.length-1
+  print "#{x3[i]}"
+  i += 2
+end
+print "\n          "
+i = 1
+while i < x3.length-1
+  print "#{x3[i]}|"
+  i += 2
+end
+print "\n"
+
+#puts "read=",x1
+#print "Attributes:",x2
+

data/test/test_sendevent.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+require "Win32/Console"
+
+
+i = 0
+begin
+while i < 99
+  if i == 10
+    Win32::Console::GenerateCtrlEvent()
+  end
+  i = i.next
+end
+rescue Exception
+end
+
+puts "if i=10, then OK!  i=#{i}"

data/test/test_title.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "Win32/Console"
+
+a = Win32::Console.new()
+
+title = a.Title()
+puts "Old title: \"#{title}\""
+
+a.Title("This is a new title")
+title = a.Title()
+puts "I just changed the title to '#{title}'"
+
+sleep(5)

data/test/test_write.rb

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+begin
+  require 'rubygems'
+  require 'term/ansicolor'
+  include Term::ANSIColor
+rescue LoadError
+  puts "You need term-ansicolor gem installed to run this test"
+  puts "Please 'gem install term-ansicolor' and try again."
+end
+
+require "benchmark"
+require "Win32/Console/ANSI"
+
+Benchmark.bm do |x|
+  num = 100
+  x.report("#{num} times") {
+    0.upto(num) {
+      print "\e[2J"
+
+      print red, bold, "Usage as constants:", reset, "\n"
+
+      print clear, "clear", reset, reset, "reset", reset,
+        bold, "bold", reset, dark, "dark", reset,
+        underscore, "underscore", reset, blink, "blink", reset,
+        negative, "negative", reset, concealed, "concealed", reset, "|\n",
+        black, "black", reset, red, "red", reset, green, "green", reset,
+        yellow, "yellow", reset, blue, "blue", reset, magenta, "magenta", reset,
+        cyan, "cyan", reset, white, "white", reset, "|\n",
+        on_black, "on_black", reset, on_red, "on_red", reset,
+        on_green, "on_green", reset, on_yellow, "on_yellow", reset,
+        on_blue, "on_blue", reset, on_magenta, "on_magenta", reset,
+        on_cyan, "on_cyan", reset, on_white, "on_white", reset, "|\n\n"
+      print "\e[s\e[20P.................."
+    }
+  }
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: win32console
+version: !ruby/object:Gem::Version 
+  version: 1.2.0
+platform: x86-mingw32
+authors: 
+- Original Library by Gonzalo Garramuno, Gem by Justin Bailey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-11-22 00:00:00 -02:00
+default_executable: 
+dependencies: []
+
+description: "This gem packages Gonzalo Garramuno's Win32::Console project, and includes a compiled binary for speed. The Win32::Console project's home can be found at:  http://rubyforge.org/projects/win32console  The gem project can be found at  http://rubyforge.org/projects/winconsole"
+email: ggarra @nospam@ advancedsl.com.ar, jgbailey @nospan@ gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.txt
+- README_GEM.txt
+- INSTALL.txt
+- HISTORY.txt
+- HISTORY_GEM.txt
+files: 
+- doc/Console.rdoc
+- doc/Console_ANSI.rdoc
+- ext/Console.cpp
+- ext/extconf.rb
+- lib/Win32/Console/ANSI.rb
+- lib/Win32/Console/api.rb
+- lib/Win32/Console/constants.rb
+- lib/Win32/Console.rb
+- lib/win32console.rb
+- test/test_cursor.rb
+- test/test_mouse.rb
+- test/test_readinput.rb
+- test/test_readoutput.rb
+- test/test_sendevent.rb
+- test/test_title.rb
+- test/test_write.rb
+- Rakefile
+- README.txt
+- README_GEM.txt
+- INSTALL.txt
+- HISTORY.txt
+- HISTORY_GEM.txt
+- lib/Console.so
+has_rdoc: true
+homepage: http://rubyforge.org/projects/winconsole
+post_install_message: 
+rdoc_options: 
+- --title
+- Win32Console Gem -- Gem for Win32::Console Project
+- --main
+- README_GEM.txt
+- --line-numbers
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: http://rubyforge.org/projects/winconsole
+rubygems_version: 1.3.0
+signing_key: 
+specification_version: 2
+summary: A library giving the Win32 console ANSI escape sequence support.
+test_files: []
+