ffi-ncurses 0.3.2 → 0.3.3

data/History.txt

@@ -1,3 +1,23 @@
+== 0.3.3 / 2010-08-24
+
+* Depends on ffi again (>= 0.6.3)
+* Now compatible with ffi-0.6.3
+  - thanks and apologies to all those who requested this change months
+    ago
+* Included keydefs.rb by default
+* Examples have been tested with:
+  - jruby-1.5.1
+  - rbx-1.0.0-20100514
+  - ree-1.8.7-2010.02
+  - ruby-1.8.6-p399
+    Note: the examples require "ffi-ncurses/ord-shim" to add
+    Integer#ord
+  - ruby-1.8.7-p299
+  - ruby-1.9.2-p0
+* Removed attempt to load XCurses (PDCurses)
+* Removed dependency on bones
+  - no Rakefile any more - just use gem build ffi-ncurses.gemspec
+
 == 0.3.2 / 2009-02-16
 
 * Bug fix:

data/README.rdoc

@@ -1,9 +1,10 @@
-= ffi-ncurses 
+= ffi-ncurses
 
 Author: Sean O'Halpin
 
-A wrapper for ncurses 5.x. Tested on Mac OS X 10.4 (Tiger) and Ubuntu
-8.04 with ruby 1.8.6 using ruby-ffi (>= 0.2.0) and JRuby 1.1.6.
+A wrapper for ncurses 5.x. Tested on Ubuntu 8.04 to 10.04 and Mac OS X
+10.4 (Tiger) with ruby 1.8.6, 1.8.7 and 1.9.x using ffi (>= 0.6.3) and
+JRuby 1.5.1.
 
 The API is a transliteration of the C API rather than an attempt to
 provide an idiomatic Ruby object-oriented API. The intent is to
@@ -20,13 +21,13 @@ directory for real working examples.
 
 == Install
 
-ruby 1.8.6:
+ruby 1.8.x:
 
-$ sudo gem install ffi ffi-ncurses
+  $ sudo gem install ffi-ncurses
 
-jruby 1.1.6:
+jruby 1.5.1:
 
-$ jruby -S gem install ffi-ncurses
+  $ jruby -S gem install ffi-ncurses
 
 == Usage
 
@@ -71,9 +72,9 @@ or as included methods:
 == Set up screen
 
   require 'ffi-ncurses'
-  
+
   FFI::NCurses.initscr
-  begin	
+  begin
     ...
   ensure
     FFI::NCurses.endwin
@@ -90,12 +91,12 @@ or as included methods:
   FFI::NCurses.keypad(stdscr, true)
 
 == Colours
-  
+
   start_color
   init_pair(1, FFI::NCurses::COLOR_BLACK, FFI::NCurses::COLOR_RED)
   attr_set FFI::NCurses::A_NORMAL, 1, nil
-  addch(?A)
-  addch(?Z | COLOR_PAIR(1))
+  addch("A"[0].ord) # works in both 1.8.x and 1.9.x
+  addch("Z"[0].ord | COLOR_PAIR(1))
 
 == Cursor
 
@@ -179,7 +180,7 @@ You can specify which variant of curses you want to use by setting the
 environment variable +RUBY_FFI_NCURSES_LIB+ to the one you want. For
 example, to use PDCurses X11 curses lib, use:
 
-  RUBY_FFI_NCURSES_LIB=XCurses ruby examples/hello.rb 
+  RUBY_FFI_NCURSES_LIB=XCurses ruby examples/hello.rb
 
 You can use this to specify +ncursesw+ for example. Please note that
 only the bog standard ncurses lib has been in any way tested as of
@@ -193,15 +194,6 @@ There are some macros in darwin ncurses.h which I haven't
 implemented yet. I'm working on it but if there are any you
 desperately need let me know.
 
-== +curscr+ and +newscr+ for JRuby
-
-These global variables are not often used but are required for certain
-situations (e.g. doing a wrefresh after shelling out and for the
-get/setsyx macros).
-
-This requires the implementation of +find_sym+ in JRuby (expected in
-JRuby 1.1.7).
-
 == Tests
 
 This is tricky - I'm not sure exactly how to properly test a wrapper

data/examples/example-attributes.rb

@@ -7,23 +7,23 @@ include FFI::NCurses
 initscr
 begin
   attributes = %w[
-    A_BLINK     
-    A_BOLD      
+    A_BLINK
+    A_BOLD
     A_DIM
     A_NORMAL
-    A_REVERSE   
-    A_STANDOUT  
-    A_UNDERLINE 
+    A_REVERSE
+    A_STANDOUT
+    A_UNDERLINE
   ]
   alt_attributes = %w[
     A_ALTCHARSET
     A_HORIZONTAL
-    A_INVIS     
-    A_LEFT      
-    A_LOW       
-    A_PROTECT     
-    A_RIGHT     
-    A_TOP       
+    A_INVIS
+    A_LEFT
+    A_LOW
+    A_PROTECT
+    A_RIGHT
+    A_TOP
     A_VERTICAL
   ]
 

data/examples/example-colour.rb

@@ -3,6 +3,7 @@
 # Sean O'Halpin, 2009-02-15
 #
 require 'ffi-ncurses'
+require 'ffi-ncurses/ord-shim'  # for 1.8.6 compatibility
 include FFI::NCurses
 
 initscr
@@ -12,7 +13,7 @@ begin
 
   # initialize colour
   start_color
-  
+
   # set up colour pairs
   #             Background       Foreground
   init_pair(0,  Colour::BLACK,   Colour::BLACK)
@@ -32,26 +33,26 @@ begin
   init_pair(13, Colour::BLACK,   Colour::MAGENTA)
   init_pair(14, Colour::BLACK,   Colour::CYAN)
   init_pair(15, Colour::BLACK,   Colour::WHITE)
-  
+
   0.upto(15) do |i|
     attr_set A_NORMAL, i, nil
-    addch(?A + i)
+    addch("A"[0].ord + i)
   end
-  
+
   # add character and attribute together
-  addch(?Z | COLOR_PAIR(1)) # red
+  addch("Z"[0].ord | COLOR_PAIR(1)) # red
 
   # reset attribute and colour to default
   attr_set A_NORMAL, 0, nil
-  
+
   # start new line
   addstr "\n"
-  
+
   # how to add a single space
-  addch(' '[0])
+  addch(' '[0].ord)
   # or
   addstr(" ")
-  
+
   addstr "Press any key"
 
   # display and pause for key press

data/examples/example-keys.rb

@@ -12,7 +12,7 @@ begin
   curs_set 0
   ch = 0
   name = "none"
-  while ch != 27
+  while ch != 27                # Escape
     clear
     addstr "Press any key (Escape to exit): "
     printw "name: %s dec: %d char: [%c]", :string, name, :int, ch, :int, ch

data/examples/example-mouse.rb

@@ -4,6 +4,7 @@
 #
 require 'ffi-ncurses'
 require 'ffi-ncurses/mouse'
+require 'ffi-ncurses/ord-shim'  # for 1.8.6 compatibility
 
 include FFI::NCurses
 
@@ -19,7 +20,7 @@ begin
   mouse_event = MEVENT.new
   ch = 0
   addstr "Click mouse buttons anywhere on the screen. q to quit\n"
-  until ch == ?q do
+  until ch == "q"[0].ord do
     ch = getch
     case ch
     when KEY_MOUSE
@@ -36,7 +37,7 @@ begin
         row = getcury(stdscr) + 1
         move row, 0
         move mouse_event[:y], mouse_event[:x]
-        addch " "[0] | WA_STANDOUT
+        addch " "[0].ord | WA_STANDOUT
         move row, 0
       end
     else

data/examples/example.rb

@@ -5,7 +5,9 @@
 # Sean O'Halpin, 2009-01-18
 #
 require 'ffi-ncurses'
-begin	
+require 'ffi-ncurses/ord-shim'  # for 1.8.6 compatibility
+
+begin
   # the methods can be called as module methods
   FFI::NCurses.initscr
   FFI::NCurses.clear
@@ -26,7 +28,7 @@ begin
   move 10, 10
   standout
   # hmmm.. you have to jump through some hoops to avoid temporary variables
-  # 
+  #
   printw("Hi! maxyx %d %d\n", *([:int, :int].zip(getmaxyx(FFI::NCurses.stdscr)).flatten))
   # easier to do this
   #addstr(sprintf("paryx %d %d\n", *getparyx(FFI::NCurses.stdscr)))
@@ -49,15 +51,15 @@ begin
   init_pair(14, FFI::NCurses::Colour::BLACK, FFI::NCurses::Colour::MAGENTA)
   init_pair(15, FFI::NCurses::Colour::BLACK, FFI::NCurses::Colour::CYAN)
   init_pair(16, FFI::NCurses::Colour::BLACK, FFI::NCurses::Colour::WHITE)
-  
+
   1.upto(16) do |i|
     attr_set FFI::NCurses::A_NORMAL, i, nil
-    addch(?A - 1 + i)
+    addch("A"[0].ord - 1 + i)
   end
   attr_set FFI::NCurses::A_HORIZONTAL, 0, nil
-  addch(?Z | COLOR_PAIR(3))
+  addch("Z"[0].ord | COLOR_PAIR(3))
   attr_set A_BOLD, 2, nil
-  addch ?S
+  addch "S"[0].ord
 
   refresh
   ch = getch
@@ -94,15 +96,10 @@ begin
   wrefresh(win)
   ch = wgetch(win)
   delwin(win)
-  
+
 rescue Object => e
   FFI::NCurses.endwin
   raise
 ensure
   FFI::NCurses.endwin
-#   FFI::NCurses.class_eval {
-#     require 'pp'
-#     pp @unattached_functions
-
-#   }
 end

data/examples/ncurses-example.rb

@@ -6,8 +6,8 @@
 # Copyright (C) 2002 Tobias Peters <t-peters@users.berlios.de>
 #
 # The following license applys only to this file. It is less restrictive
-# than the license for the rest of the ncurses-ruby distribution. 
-# I've adapted this file from someone else, see below. 
+# than the license for the rest of the ncurses-ruby distribution.
+# I've adapted this file from someone else, see below.
 #
 # Permission is hereby granted, free of charge, to any person
 # obtaining a copy of this file
@@ -16,10 +16,10 @@
 # publish, distribute, sublicense, and/or sell copies of the Software,
 # and to permit persons to whom the Software is furnished to do so,
 # subject to the following conditions:
-# 
+#
 # The above copyright notice and this permission notice shall be
 # included in all copies or substantial portions of the Software.
-# 
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
@@ -36,7 +36,7 @@
 # statement:
 
 # Copyright (c) 2000 by Harry Henry Gebel
-# 
+#
 # Permission is hereby granted, free of charge, to any person
 # obtaining a copy of this software and associated documentation files
 # (the "Software"), to deal in the Software without restriction,
@@ -44,10 +44,10 @@
 # publish, distribute, sublicense, and/or sell copies of the Software,
 # and to permit persons to whom the Software is furnished to do so,
 # subject to the following conditions:
-# 
+#
 # The above copyright notice and this permission notice shall be
 # included in all copies or substantial portions of the Software.
-# 
+#
 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 # EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 # MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
@@ -57,9 +57,8 @@
 # CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 # SOFTWARE.
 
-
-
 require "ffi-ncurses"
+require 'ffi-ncurses/ord-shim'  # for 1.8.6 compatibility
 
 module NcursesExtension
   def method_missing(method, *args, &block)

data/ffi-ncurses.gemspec

@@ -2,15 +2,50 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ffi-ncurses}
-  s.version = "0.3.0"
-
+  s.version = "0.3.3"
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sean O'Halpin"]
-  s.date = %q{2009-02-15}
-  s.description = %q{}
+  s.date = %q{2009-02-24}
+  s.description = <<-EOT
+A wrapper for ncurses 5.x. Tested on Ubuntu 8.04 to 10.04 and Mac OS X
+10.4 (Tiger) with ruby 1.8.6, 1.8.7 and 1.9.x using ffi (>= 0.6.3) and
+JRuby 1.5.1.
+
+The API is a transliteration of the C API rather than an attempt to
+provide an idiomatic Ruby object-oriented API.
+
+See the examples directory for real working examples.
+EOT
   s.email = %q{sean.ohalpin@gmail.com}
   s.extra_rdoc_files = ["History.txt", "README.rdoc"]
-  s.files = ["History.txt", "README.rdoc", "Rakefile", "examples/doc-eg1.rb", "examples/doc-eg2.rb", "examples/example-attributes.rb", "examples/example-colour.rb", "examples/example-cursor.rb", "examples/example-getsetsyx.rb", "examples/example-hello.rb", "examples/example-jruby.rb", "examples/example-keys.rb", "examples/example-mouse.rb", "examples/example-printw-variadic.rb", "examples/example-softkeys.rb", "examples/example-stdscr.rb", "examples/example-windows.rb", "examples/example.rb", "ffi-ncurses.gemspec", "lib/ffi-ncurses.rb", "lib/ffi-ncurses/darwin.rb", "lib/ffi-ncurses/keydefs.rb", "lib/ffi-ncurses/mouse.rb", "lib/ffi-ncurses/winstruct.rb"]
+  s.files = [
+             "History.txt",
+             "README.rdoc",
+             "examples/doc-eg1.rb",
+             "examples/doc-eg2.rb",
+             "examples/doc-eg3.rb",
+             "examples/example-attributes.rb",
+             "examples/example-colour.rb",
+             "examples/example-cursor.rb",
+             "examples/example-getsetsyx.rb",
+             "examples/example-hello.rb",
+             "examples/example-jruby.rb",
+             "examples/example-keys.rb",
+             "examples/example-mouse.rb",
+             "examples/example-printw-variadic.rb",
+             "examples/example-softkeys.rb",
+             "examples/example-stdscr.rb",
+             "examples/example-windows.rb",
+             "examples/example.rb",
+             "examples/ncurses-example.rb",
+             "ffi-ncurses.gemspec",
+             "lib/ffi-ncurses.rb",
+             "lib/ffi-ncurses/darwin.rb",
+             "lib/ffi-ncurses/keydefs.rb",
+             "lib/ffi-ncurses/mouse.rb",
+             "lib/ffi-ncurses/ord-shim.rb",
+             "lib/ffi-ncurses/winstruct.rb"
+            ]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/seanohalpin/ffi-ncurses}
   s.rdoc_options = ["--main", "README.rdoc"]
@@ -18,20 +53,5 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{ffi-ncurses}
   s.rubygems_version = %q{1.3.1}
   s.summary = %q{FFI wrapper for ncurses}
-
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
-
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<ffi>, [">= 0.2.0"])
-      s.add_development_dependency(%q<bones>, [">= 2.4.0"])
-    else
-      s.add_dependency(%q<ffi>, [">= 0.2.0"])
-      s.add_dependency(%q<bones>, [">= 2.4.0"])
-    end
-  else
-    s.add_dependency(%q<ffi>, [">= 0.2.0"])
-    s.add_dependency(%q<bones>, [">= 2.4.0"])
-  end
+  s.add_dependency("ffi", ">= 0.6.3")
 end

data/lib/ffi-ncurses.rb

@@ -4,9 +4,16 @@
 # version 0.2.0 - 2009-01-18
 # version 0.3.0 - 2009-01-31
 # - added stdscr, newscr, curscr
-# requires ruby-ffi >= 0.2.0 or jruby >= 1.1.6
-# tested with ruby 1.8.6, jruby 1.1.6 on Ubuntu 8.04, Mac OS X 10.4
-# ncurses 5.x
+# version 0.3.3 - 2010-08-24
+# - compatible with ffi-0.6.3
+# - example working with ruby 1.9.x (using "q"[0].ord instead of ?q)
+# requires ruby-ffi >= 0.6.3 or jruby >= 1.1.6
+# tested with
+# - ruby 1.8.7, 1.9.x
+# - jruby 1.5.1
+# on
+# - Ubuntu 8.04, 9.04, 9.10, 10.04 (ncurses 5.7)
+# - Mac OS X 10.4 (ncurses 5.4)
 
 require 'ffi'
 
@@ -15,21 +22,20 @@ require 'ffi'
 
 module FFI
   module NCurses
-    VERSION = "0.3.2"
+    VERSION = "0.3.3"
     extend FFI::Library
 
     # use RUBY_FFI_NCURSES_LIB to specify exactly which lib you want, e.g. ncursesw, XCurses (from PDCurses)
     if ENV["RUBY_FFI_NCURSES_LIB"].to_s != ""
       LIB_HANDLE = ffi_lib( ENV["RUBY_FFI_NCURSES_LIB"] ).first
     else
-      LIB_HANDLE = ffi_lib( 'ncurses', 'libncurses.so.5', 'XCurses' ).first
+      LIB_HANDLE = ffi_lib(['ncursesw', 'ncurses']).first
     end
 
     begin
-            
+      symbols = [ "stdscr", "curscr", "newscr" ]
       if LIB_HANDLE.respond_to?(:find_symbol)
         # these symbols are defined in ncurses.h
-        symbols = [ "stdscr", "curscr", "newscr" ]
         SYMBOLS = Hash[*symbols.map { |sym| [sym, LIB_HANDLE.find_symbol(sym)]}.compact.flatten ]
         SYMBOLS.keys.each do |sym|
           # note that the symbol table entry in a dll for an exported
@@ -43,17 +49,17 @@ module FFI
           # variables need another level of indirection because they are
           # ~not~ shared between process instances - the sharing is of
           # code only
-          # p SYMBOLS[sym]
           define_method sym do
             SYMBOLS[sym].read_pointer
           end
           module_function sym
         end
       else
+        warn "#find_symbol not available - #{symbols.inspect} not defined"
       end
     rescue Object => e
     end
-    
+
     # this list of function signatures was generated by the file
     # generate-ffi-ncurses-function-signatures.rb and inserted here by hand
     # then edited a bit :)
@@ -475,7 +481,7 @@ module FFI
       end
     end
     include FixupInitscr
-    
+
     module Attributes
       # following definitions have been copied (almost verbatim) from ncurses.h
       NCURSES_ATTR_SHIFT = 8
@@ -516,11 +522,11 @@ module FFI
 
     require 'ffi-ncurses/winstruct'
     include WinStruct
-    
+
     module EmulatedFunctions
-      
+
       # these 'functions' are implemented as macros in ncurses
-      
+
       # I'm departing from the NCurses API here - makes no sense to
       # force people to use pointer return values when these are
       # implemented as macros to make them easy to use in C when we have
@@ -555,7 +561,7 @@ module FFI
 			    wmove(newscr, y, x)
         end
       end
-      
+
       def self.fixup(function, &block)
         if NCurses.unattached_functions.include?(function)
           block.call
@@ -583,3 +589,4 @@ module FFI
   end
 end
 
+require 'ffi-ncurses/keydefs'