win32-api 1.4.7 → 1.4.8

data/CHANGES

@@ -1,3 +1,9 @@
+== 1.4.8 - 16-Jan-2011
+* A binary for both 1.8.x and 1.9.x is now shipped as part of the binary
+  build. A stub file is used to dynamically require the correct binary based
+  on your current version of Ruby.
+* Some updates to the Rakefile to help build multiple binaries.
+
 == 1.4.7 - 4-Dec-2010
 * An internal error formatting function now resorts to the default
   LANGID on error 1815 (ERROR_RESOURCE_LANG_NOT_FOUND). Thanks go to

data/README

@@ -1,20 +1,20 @@
 = Description
   This is a drop-in replacement for the Win32API library currently part of
   Ruby's standard library.
-	
+
 = Synopsis
   require 'win32/api'
   include Win32
-   
+
   # Typical example - Get user name
   buf = 0.chr * 260
   len = [buf.length].pack('L')
-   
+
   GetUserName = API.new('GetUserName', 'PP', 'I', 'advapi32')
   GetUserName.call(buf, len)
-   
+
   puts buf.strip
-   
+
   # Callback example - Enumerate windows
   EnumWindows     = API.new('EnumWindows', 'KP', 'L', 'user32')
   GetWindowText   = API.new('GetWindowText', 'LPI', 'I', 'user32')
@@ -24,18 +24,18 @@
     puts buf.strip unless buf.strip.empty?
     buf.index(param).nil? ? true : false
   }
-   
+
   EnumWindows.call(EnumWindowsProc, 'UEDIT32')
- 
+
   # Raw function pointer example - System beep
   LoadLibrary    = API.new('LoadLibrary', 'P', 'L')
   GetProcAddress = API.new('GetProcAddress', 'LP', 'L')
- 
+
   hlib = LoadLibrary.call('user32')
   addr = GetProcAddress.call(hlib, 'MessageBeep')
   func = Win32::API::Function.new(addr, 'L', 'L')
   func.call(0)
-   
+
 = Differences between win32-api and Win32API
   * This library has callback support
   * This library supports raw function pointers.
@@ -47,50 +47,55 @@
     return type and DLL.
   * Removed the support for lower case prototype and return types. Always
     use capital letters.
-   
+
 = Developer's Notes
   The current Win32API library that ships with the standard library has been
   slated for removal from Ruby 2.0 and it will not receive any updates in the
   Ruby 1.8.x branch. I have far too many libraries invested in it to let it
   die at this point.
-   
+
   In addition, the current Win32API library was written in the bad old Ruby
   1.6.x days, which means it doesn't use the newer allocation framework.
   There were several other refactorings that I felt it needed to more closely
   match how it was actually being used in practice.
-   
+
   The first order of business was changing the order of the arguments. By
   moving the DLL name from first to last, I was able to provide reasonable
   default arguments for the prototype, return type and the DLL. Only the
   function name is required now.
-   
+
   There was a laundry list of other refactorings that were needed: sensical
   instance variable names with proper accessors, removing support for lower
   case prototype and return value characters that no one used in practice,
   better naming conventions, the addition of RDoc ready comments and,
   especially, callback and raw function pointer support.
-  
+
   Most importantly, we can now add, modify and fix any features that we feel
   best benefit our end users.
 
+= Multiple Binaries
+  As of win32-api 1.4.8 a binary gem is shipped that contains binaries for
+  both Ruby 1.8 and Ruby 1.9. The file under lib/win32 dynamically requires
+  the correct binary based on your version of Ruby.
+
 = Documentation
   The source file contains inline RDoc documentation. If you installed
   this file as a gem, then you have the docs. Run "gem server" and point
   your browser at http://localhost:8808 to see them.
-   
+
 = Warranty
   This package is provided "as is" and without any express or
   implied warranties, including, without limitation, the implied
   warranties of merchantability and fitness for a particular purpose.
-   
+
 = Known Issues
   Possible callback issues when dealing with multi-threaded applications.
-   
+
   Please submit any bug reports to the project page at
   http://www.rubyforge.org/projects/win32utils.
 
 = Copyright
-  (C) 2003-2010 Daniel J. Berger
+  (C) 2003-2011 Daniel J. Berger
   All Rights Reserved
 
 = License

data/Rakefile

@@ -5,22 +5,28 @@ require 'rbconfig'
 include Config
 
 CLEAN.include(
-  'lib',
   '**/*.gem',               # Gem files
   '**/*.rbc',               # Rubinius
   '**/*.o',                 # C object file
   '**/*.log',               # Ruby extension build log
   '**/Makefile',            # C Makefile
-  '**/conftest.dSYM',       # OS X build directory
+  '**/*.def',               # Definition files
+  '**/*.exp',
+  '**/*.lib',
+  '**/*.pdb',
+  '**/*.obj',
+  '**/*.stackdump',         # Junk that can happen on Windows
   "**/*.#{CONFIG['DLEXT']}" # C shared object
 )
 
+CLOBBER.include('lib') # Generated when building binaries
+
 make = CONFIG['host_os'] =~ /mingw|cygwin/i ? 'make' : 'nmake'
 
 desc 'Build the ruby.exe.manifest if it does not already exist'
 task :build_manifest do
   version = CONFIG['host_os'].split('_')[1]
-   
+
   if version && version.to_i >= 80
     unless File.exist?(File.join(CONFIG['bindir'], 'ruby.exe.manifest'))
       Dir.chdir(CONFIG['bindir']) do
@@ -30,33 +36,54 @@ task :build_manifest do
   end
 end
 
-desc 'Install the win32-api library (non-gem)'
-task :install => [:build] do
-  Dir.chdir('ext'){
-    sh "#{make} install"
-  }
-end
-
-desc "Build Win32::API (but don't install it)"
+desc "Build the win32-api library"
 task :build => [:clean, :build_manifest] do
   Dir.chdir('ext') do
     ruby "extconf.rb"
     sh make
-    cp "api.so", "win32" # For the test suite
+    cp 'api.so', 'win32' # For testing
   end
 end
 
 namespace 'gem' do
-  desc 'Build a standard gem'
-  task :create => [:clean] do 
+  desc 'Build the win32-api gem'
+  task :create => [:clean] do
     spec = eval(IO.read('win32-api.gemspec'))
     Gem::Builder.new(spec).build
   end
 
   desc 'Build a binary gem'
-  task :binary => [:build] do
-    mkdir_p 'lib/win32'
-    cp 'ext/api.so', 'lib/win32'
+  task :binary, :ruby18, :ruby19 do |task, args|
+    args.with_defaults(
+      :ruby18 => "c:/ruby/bin/ruby",
+      :ruby19 => "c:/ruby19/bin/ruby"
+    )
+
+    Rake::Task[:clobber].invoke
+    mkdir_p 'lib/win32/ruby18/win32'
+    mkdir_p 'lib/win32/ruby19/win32'
+
+    args.each{ |key, rubyx|
+      Dir.chdir('ext') do
+        sh "make distclean" rescue nil
+        sh "#{rubyx} extconf.rb"
+        sh "make"
+        if key.to_s == 'ruby18'
+          cp 'api.so', '../lib/win32/ruby18/win32/api.so'
+        else
+          cp 'api.so', '../lib/win32/ruby19/win32/api.so'
+        end
+      end
+    }
+
+    # Create a stub file that automatically require's the correct binary
+    File.open('lib/win32/api.rb', 'w'){ |fh|
+      fh.puts "if RUBY_VERSION.to_f >= 1.9"
+      fh.puts "  require File.join(File.dirname(__FILE__), 'ruby19/win32/api')"
+      fh.puts "else"
+      fh.puts "  require File.join(File.dirname(__FILE__), 'ruby18/win32/api')"
+      fh.puts "end"
+    }
 
     spec = eval(IO.read('win32-api.gemspec'))
     spec.platform = Gem::Platform::CURRENT

data/ext/win32/api.c

@@ -17,7 +17,7 @@
 #endif
 
 #define MAX_BUF 1024
-#define WINDOWS_API_VERSION "1.4.7"
+#define WINDOWS_API_VERSION "1.4.8"
 
 #define _T_VOID     0
 #define _T_LONG     1
@@ -237,8 +237,8 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
    FARPROC fProc;
    Win32API* ptr;
    int i;
-   char* first  = "A";
-   char* second = "W";
+   const char* first  = "A";
+   const char* second = "W";
    VALUE v_proc, v_proto, v_return, v_dll;
 
    rb_scan_args(argc, argv, "13", &v_proc, &v_proto, &v_return, &v_dll);
@@ -257,7 +257,7 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
 
    // Set an arbitrary limit of 20 parameters
    if(20 < RARRAY_LEN(v_proto))
-      rb_raise(rb_eArgError, "too many parameters: %d\n", RARRAY_LEN(v_proto));
+      rb_raise(rb_eArgError, "too many parameters: %d", RARRAY_LEN(v_proto));
 
    // Set the default dll to 'kernel32'
    if(NIL_P(v_dll))
@@ -763,7 +763,7 @@ static VALUE api_call(int argc, VALUE* argv, VALUE self){
       }
       else{
          rb_raise(rb_eArgError,
-            "wrong number of parameters: expected %d, got %d",
+            "wrong number of parameters: expected %li, got %li",
             RARRAY_LEN(v_proto), RARRAY_LEN(v_args)
          );
       }
@@ -944,6 +944,6 @@ void Init_api(){
 
    /* Constants */
 
-   /* 1.4.7: The version of the win32-api library */
+   /* 1.4.8: The version of the win32-api library */
    rb_define_const(cAPI, "VERSION", rb_str_new2(WINDOWS_API_VERSION));
 }

data/test/test_win32_api.rb

@@ -21,7 +21,7 @@ class TC_Win32_API < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('1.4.7', API::VERSION)
+      assert_equal('1.4.8', API::VERSION)
    end
 
    def test_constructor_basic
@@ -97,22 +97,30 @@ class TC_Win32_API < Test::Unit::TestCase
       assert_raise(API::PrototypeError){ API.new('GetUserName', 'PL', 'X', 'advapi32') }
    end
 
-   def test_constructor_expected_failure_messages
-      assert_raise_message("Unable to load function 'Zap', 'ZapA', or 'ZapW'"){
-         API.new('Zap')
-      }
+   test "constructor returns expected error message if function not found" do
+     msg = "Unable to load function "
+     assert_raise_message(msg + "'Zap', 'ZapA', or 'ZapW'"){ API.new('Zap') }
+     assert_raise_message(msg + "'strxxx'"){ API.new('strxxx', 'P', 'L', 'msvcrt') }
+   end
 
-      assert_raise_message("Unable to load function 'strxxx'"){
-         API.new('strxxx', 'P', 'L', 'msvcrt')
-      }
+   test "constructor returns expected error message if prototype is invalid" do
+     msg = "Illegal prototype 'X'"
+     assert_raise_message(msg){ API.new('GetUserName', 'X', 'I', 'advapi32') }
+   end
 
-      assert_raise_message("Illegal prototype 'X'"){
-         API.new('GetUserName', 'X', 'I', 'advapi32')
-      }
+   test "constructor returns expected error message if return type is invalid" do
+     msg = "Illegal return type 'Y'"
+     assert_raise_message(msg){ API.new('GetUserName', 'PL', 'Y', 'advapi32') }
+   end
 
-      assert_raise_message("Illegal return type 'Y'"){
-         API.new('GetUserName', 'PL', 'Y', 'advapi32')
-      }
+   test "constructor returns expected error message if too many parameters" do
+     msg = "too many parameters: 25"
+     assert_raise_message(msg){ API.new('GetFileAttributes', 'S' * 25, 'L') }
+   end
+
+   test "call method returns expected error message if too many parameters" do
+     msg = "wrong number of parameters: expected 2, got 3"
+     assert_raise_message(msg){ @str.call('test', 'test', 'test') }
    end
 
    def test_call_expected_failures

data/win32-api.gemspec

@@ -2,7 +2,7 @@ require 'rubygems'
 
 Gem::Specification.new do |spec|
   spec.name       = 'win32-api'
-  spec.version    = '1.4.7'
+  spec.version    = '1.4.8'
   spec.authors    = ['Daniel J. Berger', 'Park Heesob']
   spec.license    = 'Artistic 2.0'
   spec.email      = 'djberg96@gmail.com'
@@ -13,13 +13,13 @@ Gem::Specification.new do |spec|
   spec.test_files = Dir['test/test*']
   spec.extensions = ['ext/extconf.rb']
   spec.files      = Dir['**/*'].reject{ |f| f.include?('git') }
-   
+
   spec.rubyforge_project = 'win32utils'
   spec.required_ruby_version = '>= 1.8.2'
   spec.extra_rdoc_files = ['README', 'CHANGES', 'MANIFEST', 'ext/win32/api.c']
-   
-  spec.add_development_dependency('test-unit', '>= 2.0.6')
-   
+
+  spec.add_development_dependency('test-unit', '>= 2.1.2')
+
   spec.description = <<-EOF
     The Win32::API library is meant as a replacement for the Win32API
     library that ships as part of the standard library. It contains several

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: win32-api
 version: !ruby/object:Gem::Version 
-  hash: 9
+  hash: 23
   prerelease: false
   segments: 
   - 1
   - 4
-  - 7
-  version: 1.4.7
+  - 8
+  version: 1.4.8
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-04 00:00:00 -07:00
+date: 2011-01-16 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -27,12 +27,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 15
         segments: 
         - 2
-        - 0
-        - 6
-        version: 2.0.6
+        - 1
+        - 2
+        version: 2.1.2
   type: :development
   version_requirements: *id001
 description: "    The Win32::API library is meant as a replacement for the Win32API\n    library that ships as part of the standard library. It contains several\n    advantages over Win32API, including callback support, raw function\n    pointers, an additional string type, and more.\n"