win32-api 1.2.2-x86-mswin32-60 → 1.3.0-x86-mswin32-60

data/CHANGES

@@ -1,3 +1,16 @@
+= 1.3.0 - 1-Jan-2009
+* Fixed RubyForge bug #23395, which was caused by inadvertently modifying
+  a variable within a loop. This caused callbacks to fail in certain
+  situations.
+* Added the Win32::API::LoadLibraryError and Win32::API::PrototypeError classes
+  to provide more fine grained handling of possible error conditions in the
+  constructor. These are both subclasses of Win32::API::Error.
+* Removed the Win32::API::CallbackError class.
+* Changed the upper limit on prototypes from 16 to 20. It turns out that
+  there are actually Windows functions with more than 16 prototypes.
+* Refactored a high iteration test so that it counts as only one test
+  instead of 1000.
+
 = 1.2.2 - 27-Nov-2008
 * Fixed bug in the error message for illegal prototypes and illegal return
   types where the character in question would come out as empty or garbage.

data/MANIFEST

@@ -1,10 +1,10 @@
-* CHANGES
-* MANIFEST
-* README
-* Rakefile
-* win32-api.gemspec
-* ext/extconf.rb
-* ext/win32/api.c
-* test/test_win32_api.rb
-* test/test_win32_api_callback.rb
+* CHANGES
+* MANIFEST
+* README
+* Rakefile
+* win32-api.gemspec
+* ext/extconf.rb
+* ext/win32/api.c
+* test/test_win32_api.rb
+* test/test_win32_api_callback.rb
 * test/test_win32_api_function.rb

data/ext/win32/api.c

@@ -2,7 +2,7 @@
 #include <windows.h>
 
 #define MAX_BUF 1024
-#define WINDOWS_API_VERSION "1.2.2"
+#define WINDOWS_API_VERSION "1.3.0"
 
 #define _T_VOID     0
 #define _T_LONG     1
@@ -11,14 +11,14 @@
 #define _T_CALLBACK 4
 #define _T_STRING   5
 
-VALUE cAPIError, cCallbackError;
+VALUE cAPIError, cAPIProtoError, cAPILoadError;
 static VALUE ActiveCallback = Qnil;
 
 typedef struct {
     HANDLE library;
     FARPROC function;
     int return_type;
-    int prototype[16];
+    int prototype[20];
 } Win32API;
 
 static void api_free(Win32API* ptr){
@@ -122,7 +122,7 @@ static VALUE callback_init(int argc, VALUE* argv, VALUE self)
          case 'I': case 'L': case 'P': case 'V': case 'S':
             break;
          default:
-            rb_raise(cCallbackError, "Illegal prototype '%c'",
+            rb_raise(cAPIProtoError, "Illegal prototype '%c'",
                RSTRING(v_proto)->ptr[i]
             );
       }
@@ -136,7 +136,7 @@ static VALUE callback_init(int argc, VALUE* argv, VALUE self)
          case 'I': case 'L': case 'P': case 'V': case 'S':
             break;
          default:
-            rb_raise(cCallbackError, "Illegal return type '%s'",
+            rb_raise(cAPIProtoError, "Illegal return type '%s'",
                RSTRING(v_return)->ptr
             );
       }
@@ -214,8 +214,8 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
       rb_ary_push(v_proto, rb_str_new2("V"));
    }
 
-   // Set an arbitrary limit of 16 parameters
-   if(16 < RARRAY(v_proto)->len)
+   // Set an arbitrary limit of 20 parameters
+   if(20 < RARRAY(v_proto)->len)
       rb_raise(rb_eArgError, "too many parameters: %d\n", RARRAY(v_proto)->len);
 
    // Set the default dll to 'kernel32'
@@ -233,7 +233,7 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
 
    // The most likely cause of failure is a bad DLL load path
    if(!hLibrary){
-      rb_raise(cAPIError, "LoadLibrary() function failed for '%s': %s",
+      rb_raise(cAPILoadError, "LoadLibrary() function failed for '%s': %s",
          RSTRING(v_dll)->ptr,
          StringError(GetLastError())
       );
@@ -257,7 +257,7 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
    if(!fProc){
       if(strstr(RSTRING(v_dll)->ptr, "msvcr")){
          rb_raise(
-            cAPIError,
+            cAPILoadError,
             "Unable to load function '%s'",
             RSTRING(v_proc)->ptr,
             StringError(GetLastError())
@@ -275,7 +275,7 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
 
             if(!fProc){
                rb_raise(
-                  cAPIError,
+                  cAPILoadError,
                   "Unable to load function '%s', '%s', or '%s'",
                   RSTRING(v_proc)->ptr,
                   RSTRING(v_ascii)->ptr,
@@ -321,7 +321,7 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
             ptr->prototype[i] = _T_STRING;
             break;
          default:
-            rb_raise(cAPIError, "Illegal prototype '%s'",
+            rb_raise(cAPIProtoError, "Illegal prototype '%s'",
                StringValuePtr(RARRAY(v_proto)->ptr[i])
             );
       }
@@ -353,7 +353,7 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
             ptr->return_type = _T_STRING;
             break;
          default:
-            rb_raise(cAPIError, "Illegal return type '%s'",
+            rb_raise(cAPIProtoError, "Illegal return type '%s'",
                RSTRING(v_return)->ptr
             );
       }
@@ -413,8 +413,8 @@ static VALUE func_init(int argc, VALUE* argv, VALUE self){
       rb_ary_push(v_proto, rb_str_new2("V"));
    }
 
-   // Set an arbitrary limit of 16 parameters
-   if(16 < RARRAY(v_proto)->len)
+   // Set an arbitrary limit of 20 parameters
+   if(20 < RARRAY(v_proto)->len)
       rb_raise(rb_eArgError, "too many parameters: %d\n", RARRAY(v_proto)->len);
 
    // Set the default return type to 'L' (DWORD)
@@ -447,7 +447,7 @@ static VALUE func_init(int argc, VALUE* argv, VALUE self){
             ptr->prototype[i] = _T_STRING;
             break;
          default:
-            rb_raise(cAPIError, "Illegal prototype '%s'",
+            rb_raise(cAPIProtoError, "Illegal prototype '%s'",
                StringValuePtr(RARRAY(v_proto)->ptr[i])
             );
       }
@@ -479,7 +479,7 @@ static VALUE func_init(int argc, VALUE* argv, VALUE self){
             ptr->return_type = _T_STRING;
             break;
          default:
-            rb_raise(cAPIError, "Illegal return type '%s'",
+            rb_raise(cAPIProtoError, "Illegal return type '%s'",
                RSTRING(v_return)->ptr
             );
       }
@@ -493,14 +493,14 @@ static VALUE func_init(int argc, VALUE* argv, VALUE self){
 }
 
 typedef struct {
-   DWORD params[16];
+   DWORD params[20];
 } CALLPARAM;
 
 
 DWORD CallbackFunction(CALLPARAM param)
 {
     VALUE v_proto, v_return, v_proc, v_retval;
-    VALUE argv[16];
+    VALUE argv[20];
     int i, argc;
     char *a_proto;
     char *a_return;
@@ -529,7 +529,7 @@ DWORD CallbackFunction(CALLPARAM param)
                  argv[i] = INT2NUM(param.params[i]);
                  break;
               default:
-                 rb_raise(cCallbackError, "Illegal prototype '%s'",
+                 rb_raise(cAPIProtoError, "Illegal prototype '%s'",
                     RSTRING(a_proto[i])->ptr
                  );
             }
@@ -671,9 +671,10 @@ static VALUE api_call(int argc, VALUE* argv, VALUE self){
    Win32API* ptr;
    unsigned long return_value;
    int i = 0;
+   int len;
 
    struct{
-      unsigned long params[16];
+      unsigned long params[20];
    } param;
 
    Data_Get_Struct(self, Win32API, ptr);
@@ -682,7 +683,7 @@ static VALUE api_call(int argc, VALUE* argv, VALUE self){
 
    v_proto = rb_iv_get(self, "@prototype");
 
-   /* For void prototypes, allow either no args or an explicit nil */
+   // For void prototypes, allow either no args or an explicit nil
    if(RARRAY(v_proto)->len != RARRAY(v_args)->len){
       char* c = StringValuePtr(RARRAY(v_proto)->ptr[0]);
       if(!strcmp(c, "V")){
@@ -696,10 +697,12 @@ static VALUE api_call(int argc, VALUE* argv, VALUE self){
       }
    }
 
-   for(i = 0; i < RARRAY(v_proto)->len; i++){
+   len = RARRAY(v_proto)->len;
+
+   for(i = 0; i < len; i++){
       v_arg = RARRAY(v_args)->ptr[i];
 
-      /* Convert nil to NULL.  Otherwise convert as appropriate. */
+      // Convert nil to NULL.  Otherwise convert as appropriate.
       if(NIL_P(v_arg))
          param.params[i] = (unsigned long)NULL;
       else if(v_arg == Qtrue)
@@ -815,11 +818,14 @@ void Init_api(){
    /* The API::Function class encapsulates a raw function pointer */
    cFunction = rb_define_class_under(cAPI, "Function", cAPI);
 
-   /* The API::Error class is raised if the constructor fails */
+   /* The API::Error class serves as a base class for other errors */
    cAPIError = rb_define_class_under(cAPI, "Error", rb_eRuntimeError);
 
-   /* The API::Callback::Error class is raised if the constructor fails */
-   cCallbackError = rb_define_class_under(cCallback, "Error", rb_eRuntimeError);
+   /* The LoadError class is raised if a function cannot be found or loaded */
+   cAPILoadError = rb_define_class_under(cAPI, "LoadLibraryError", cAPIError);
+
+   /* The PrototypeError class is raised if an invalid prototype is passed */
+   cAPIProtoError = rb_define_class_under(cAPI, "PrototypeError", cAPIError);
 
    /* Miscellaneous */
    rb_define_alloc_func(cAPI, api_allocate);

data/test/test_win32_api.rb

@@ -20,7 +20,7 @@ class TC_Win32_API < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('1.2.2', API::VERSION)
+      assert_equal('1.3.0', API::VERSION)
    end
 
    def test_constructor_basic
@@ -79,17 +79,17 @@ class TC_Win32_API < Test::Unit::TestCase
    end
    
    def test_constructor_high_iteration
-      1000.times{
-         assert_nothing_raised{ API.new('GetUserName', 'P', 'P', 'advapi32') }
+      assert_nothing_raised{
+         1000.times{ API.new('GetUserName', 'P', 'P', 'advapi32') }
       }
    end
    
    def test_constructor_expected_failures
       assert_raise(ArgumentError){ API.new }
-      assert_raise(ArgumentError){ API.new('GetUserName', ('L' * 17), 'X') }
-      assert_raise(API::Error){ API.new('GetUserName', 'PL', 'I', 'foo') }
-      assert_raise(API::Error){ API.new('GetUserName', 'X', 'I', 'kernel32') }
-      assert_raise(API::Error){ API.new('GetUserName', 'PL', 'X', 'kernel32') }
+      assert_raise(ArgumentError){ API.new('GetUserName', ('L' * 21), 'X') }
+      assert_raise(API::LoadLibraryError){ API.new('GetUserName', 'PL', 'I', 'foo') }
+      assert_raise(API::PrototypeError){ API.new('GetUserName', 'X', 'I', 'advapi32') }
+      assert_raise(API::PrototypeError){ API.new('GetUserName', 'PL', 'X', 'advapi32') }
    end
 
    def test_constructor_expected_failure_messages
@@ -113,7 +113,19 @@ class TC_Win32_API < Test::Unit::TestCase
    def test_call_expected_failures
       assert_raise(TypeError){ @gcd.call('test', @buf) }
    end
-   
+
+   def test_error_classes
+      assert_not_nil(Win32::API::Error)
+      assert_not_nil(Win32::API::LoadLibraryError)
+      assert_not_nil(Win32::API::PrototypeError)
+   end
+
+   def test_error_class_relationships
+      assert_kind_of(RuntimeError, Win32::API::Error.new)
+      assert_kind_of(Win32::API::Error, Win32::API::LoadLibraryError.new)
+      assert_kind_of(Win32::API::Error, Win32::API::PrototypeError.new)
+   end
+
    def teardown
       @buf = nil
       @gcd = nil

data/test/test_win32_api_callback.rb

@@ -56,8 +56,8 @@ class TC_Win32_API_Callback < Test::Unit::TestCase
    end
    
    def test_constructor_expected_errors
-      assert_raise(API::Callback::Error){ API::Callback.new('X') }
-      assert_raise(API::Callback::Error){ API::Callback.new('L', 'Y') }
+      assert_raise(API::PrototypeError){ API::Callback.new('X') }
+      assert_raise(API::PrototypeError){ API::Callback.new('L', 'Y') }
    end
 
    def test_constructor_expected_error_messages

data/test/test_win32_api_function.rb

@@ -45,8 +45,8 @@ class TC_Win32_API_Function < Test::Unit::TestCase
    def test_expected_errors_from_arguments
       assert_raise(ArgumentError){ Win32::API::Function.new }
       assert_raise(TypeError){ Win32::API::Function.new('L') }
-      assert_raise(Win32::API::Error){ Win32::API::Function.new(1, 'X') }
-      assert_raise(Win32::API::Error){ Win32::API::Function.new(1, 'X', 'Y') }
+      assert_raise(Win32::API::PrototypeError){ Win32::API::Function.new(1, 'X') }
+      assert_raise(Win32::API::PrototypeError){ Win32::API::Function.new(1, 'X', 'Y') }
    end
 
    def test_expected_error_messages

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: win32-api
 version: !ruby/object:Gem::Version 
-  version: 1.2.2
+  version: 1.3.0
 platform: x86-mswin32-60
 authors: 
 - Daniel J. Berger
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-27 00:00:00 -07:00
+date: 2009-01-01 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -56,7 +56,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: win32utils
-rubygems_version: 1.3.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: A superior replacement for Win32API