win32-api 1.3.0-x86-mswin32-80 → 1.4.0-x86-mswin32-80

data/CHANGES

@@ -1,3 +1,13 @@
+= 1.4.0 - 19-Feb-2009
+* Now compatible with Ruby 1.9.x.
+* In what will go down as, "It seemed like a good idea at the time", I have
+  removed the feature where W (wide) character functions were used first if
+  your $KCODE environment variable was set to "UTF8". It caused too many
+  headaches in practice, especially amongst Rails users. You must now always
+  explicitly specify 'W' in the constructor if that's what you want.
+* Fixed RF bug #23944 - bad error message for MSVCRT functions that failed
+  to load properly.
+
 = 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

data/ext/win32/api.c

@@ -1,8 +1,23 @@
 #include <ruby.h>
 #include <windows.h>
 
+// Ruby 1.9.x
+#ifndef RSTRING_PTR
+#define RSTRING_PTR(s) (RSTRING(s)->ptr)
+#endif
+#ifndef RSTRING_LEN
+#define RSTRING_LEN(s) (RSTRING(s)->len)
+#endif
+
+#ifndef RARRAY_PTR
+#define RARRAY_PTR(a) (RARRAY(a)->ptr)
+#endif
+#ifndef RARRAY_LEN
+#define RARRAY_LEN(a) (RARRAY(a)->len)
+#endif
+
 #define MAX_BUF 1024
-#define WINDOWS_API_VERSION "1.3.0"
+#define WINDOWS_API_VERSION "1.4.0"
 
 #define _T_VOID     0
 #define _T_LONG     1
@@ -117,27 +132,27 @@ static VALUE callback_init(int argc, VALUE* argv, VALUE self)
    rb_scan_args(argc, argv, "11&", &v_proto, &v_return, &v_proc);
 
    /* Validate prototype characters */
-   for(i = 0; i < RSTRING(v_proto)->len; i++){
-      switch(RSTRING(v_proto)->ptr[i]){
+   for(i = 0; i < RSTRING_LEN(v_proto); i++){
+      switch(RSTRING_PTR(v_proto)[i]){
          case 'I': case 'L': case 'P': case 'V': case 'S':
             break;
          default:
             rb_raise(cAPIProtoError, "Illegal prototype '%c'",
-               RSTRING(v_proto)->ptr[i]
+               RSTRING_PTR(v_proto)[i]
             );
       }
    }
 
-   if(NIL_P(v_return) || RARRAY(v_return)->len == 0){
+   if(NIL_P(v_return) || RARRAY_LEN(v_return) == 0){
       v_return = rb_str_new2("L");
    }
    else{
-      switch(*(char*)RSTRING(v_return)->ptr){
+      switch(*(char*)RSTRING_PTR(v_return)){
          case 'I': case 'L': case 'P': case 'V': case 'S':
             break;
          default:
             rb_raise(cAPIProtoError, "Illegal return type '%s'",
-               RSTRING(v_return)->ptr
+               RSTRING_PTR(v_return)
             );
       }
    }
@@ -145,7 +160,7 @@ static VALUE callback_init(int argc, VALUE* argv, VALUE self)
    rb_iv_set(self, "@function", v_proc);
    rb_iv_set(self, "@prototype", v_proto);
    rb_iv_set(self, "@return_type", v_return);
-   rb_iv_set(self, "@address", ULONG2NUM((LPARAM)CallbackTable[RSTRING(v_proto)->len]));
+   rb_iv_set(self, "@address", ULONG2NUM((LPARAM)CallbackTable[RSTRING_LEN(v_proto)]));
    ActiveCallback = self;
 
    return self;
@@ -209,14 +224,14 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
       v_proto = rb_str_split(v_proto, "");
 
    // Convert a nil or empty prototype to 'V' (void) automatically
-   if(NIL_P(v_proto) || RARRAY(v_proto)->len == 0){
+   if(NIL_P(v_proto) || RARRAY_LEN(v_proto) == 0){
       v_proto = rb_ary_new();
       rb_ary_push(v_proto, rb_str_new2("V"));
    }
 
    // 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);
+   if(20 < RARRAY_LEN(v_proto))
+      rb_raise(rb_eArgError, "too many parameters: %d\n", RARRAY_LEN(v_proto));
 
    // Set the default dll to 'kernel32'
    if(NIL_P(v_dll))
@@ -229,12 +244,12 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
    SafeStringValue(v_dll);
    SafeStringValue(v_proc);
 
-   hLibrary = LoadLibrary(TEXT(RSTRING(v_dll)->ptr));
+   hLibrary = LoadLibrary(TEXT(RSTRING_PTR(v_dll)));
 
    // The most likely cause of failure is a bad DLL load path
    if(!hLibrary){
       rb_raise(cAPILoadError, "LoadLibrary() function failed for '%s': %s",
-         RSTRING(v_dll)->ptr,
+         RSTRING_PTR(v_dll),
          StringError(GetLastError())
       );
    }
@@ -243,43 +258,37 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
 
    /* Attempt to get the function.  If it fails, try again with an 'A'
     * appended.  If that fails, try again with a 'W' appended. If that
-    * still fails, raise an API::Error.
+    * still fails, raise an API::LoadLibraryError.
     */
-   fProc = GetProcAddress(hLibrary, TEXT(RSTRING(v_proc)->ptr));
 
-   // The order of 'A' and 'W' is reversed if $KCODE is set to 'UTF8'.
-   if(!strcmp(rb_get_kcode(), "UTF8")){
-      first  = "W";
-      second = "A";
-   }
+   fProc = GetProcAddress(hLibrary, TEXT(RSTRING_PTR(v_proc)));
 
    // Skip the ANSI and Wide function checks for MSVCRT functions.
    if(!fProc){
-      if(strstr(RSTRING(v_dll)->ptr, "msvcr")){
+      if(strstr(RSTRING_PTR(v_dll), "msvcr")){
          rb_raise(
             cAPILoadError,
             "Unable to load function '%s'",
-            RSTRING(v_proc)->ptr,
-            StringError(GetLastError())
+            RSTRING_PTR(v_proc)
          );
       }
       else{
          VALUE v_ascii = rb_str_new3(v_proc);
          v_ascii = rb_str_cat(v_ascii, first, 1);
-         fProc = GetProcAddress(hLibrary, TEXT(RSTRING(v_ascii)->ptr));
+         fProc = GetProcAddress(hLibrary, TEXT(RSTRING_PTR(v_ascii)));
 
          if(!fProc){
             VALUE v_unicode = rb_str_new3(v_proc);
             v_unicode = rb_str_cat(v_unicode, second, 1);
-            fProc = GetProcAddress(hLibrary, TEXT(RSTRING(v_unicode)->ptr));
+            fProc = GetProcAddress(hLibrary, TEXT(RSTRING_PTR(v_unicode)));
 
             if(!fProc){
                rb_raise(
                   cAPILoadError,
                   "Unable to load function '%s', '%s', or '%s'",
-                  RSTRING(v_proc)->ptr,
-                  RSTRING(v_ascii)->ptr,
-                  RSTRING(v_unicode)->ptr
+                  RSTRING_PTR(v_proc),
+                  RSTRING_PTR(v_ascii),
+                  RSTRING_PTR(v_unicode)
                );
             }
             else{
@@ -299,9 +308,9 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
 
    // Push the numeric prototypes onto our int array for later use.
 
-   for(i = 0; i < RARRAY(v_proto)->len; i++){
-      SafeStringValue(RARRAY(v_proto)->ptr[i]);
-      switch(*(char*)StringValuePtr(RARRAY(v_proto)->ptr[i])){
+   for(i = 0; i < RARRAY_LEN(v_proto); i++){
+      SafeStringValue(RARRAY_PTR(v_proto)[i]);
+      switch(*(char*)StringValuePtr(RARRAY_PTR(v_proto)[i])){
          case 'L':
             ptr->prototype[i] = _T_LONG;
             break;
@@ -322,7 +331,7 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
             break;
          default:
             rb_raise(cAPIProtoError, "Illegal prototype '%s'",
-               StringValuePtr(RARRAY(v_proto)->ptr[i])
+               StringValuePtr(RARRAY_PTR(v_proto)[i])
             );
       }
    }
@@ -330,13 +339,13 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
    // Store the return type for later use.
 
    // Automatically convert empty strings or nil to type void.
-   if(NIL_P(v_return) || RSTRING(v_return)->len == 0){
+   if(NIL_P(v_return) || RSTRING_LEN(v_return) == 0){
       v_return = rb_str_new2("V");
       ptr->return_type = _T_VOID;
    }
    else{
       SafeStringValue(v_return);
-      switch(*RSTRING(v_return)->ptr){
+      switch(*RSTRING_PTR(v_return)){
          case 'L':
             ptr->return_type = _T_LONG;
             break;
@@ -354,7 +363,7 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
             break;
          default:
             rb_raise(cAPIProtoError, "Illegal return type '%s'",
-               RSTRING(v_return)->ptr
+               RSTRING_PTR(v_return)
             );
       }
    }
@@ -408,14 +417,14 @@ static VALUE func_init(int argc, VALUE* argv, VALUE self){
       v_proto = rb_str_split(v_proto, "");
 
    // Convert a nil or empty prototype to 'V' (void) automatically
-   if(NIL_P(v_proto) || RARRAY(v_proto)->len == 0){
+   if(NIL_P(v_proto) || RARRAY_LEN(v_proto) == 0){
       v_proto = rb_ary_new();
       rb_ary_push(v_proto, rb_str_new2("V"));
    }
 
    // 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);
+   if(20 < RARRAY_LEN(v_proto))
+      rb_raise(rb_eArgError, "too many parameters: %d\n", RARRAY_LEN(v_proto));
 
    // Set the default return type to 'L' (DWORD)
    if(NIL_P(v_return))
@@ -425,9 +434,9 @@ static VALUE func_init(int argc, VALUE* argv, VALUE self){
 
    // Push the numeric prototypes onto our int array for later use.
 
-   for(i = 0; i < RARRAY(v_proto)->len; i++){
-      SafeStringValue(RARRAY(v_proto)->ptr[i]);
-      switch(*(char*)StringValuePtr(RARRAY(v_proto)->ptr[i])){
+   for(i = 0; i < RARRAY_LEN(v_proto); i++){
+      SafeStringValue(RARRAY_PTR(v_proto)[i]);
+      switch(*(char*)StringValuePtr(RARRAY_PTR(v_proto)[i])){
          case 'L':
             ptr->prototype[i] = _T_LONG;
             break;
@@ -448,7 +457,7 @@ static VALUE func_init(int argc, VALUE* argv, VALUE self){
             break;
          default:
             rb_raise(cAPIProtoError, "Illegal prototype '%s'",
-               StringValuePtr(RARRAY(v_proto)->ptr[i])
+               StringValuePtr(RARRAY_PTR(v_proto)[i])
             );
       }
    }
@@ -456,13 +465,13 @@ static VALUE func_init(int argc, VALUE* argv, VALUE self){
    // Store the return type for later use.
 
    // Automatically convert empty strings or nil to type void.
-   if(NIL_P(v_return) || RSTRING(v_return)->len == 0){
+   if(NIL_P(v_return) || RSTRING_LEN(v_return) == 0){
       v_return = rb_str_new2("V");
       ptr->return_type = _T_VOID;
    }
    else{
       SafeStringValue(v_return);
-      switch(*RSTRING(v_return)->ptr){
+      switch(*RSTRING_PTR(v_return)){
          case 'L':
             ptr->return_type = _T_LONG;
             break;
@@ -480,7 +489,7 @@ static VALUE func_init(int argc, VALUE* argv, VALUE self){
             break;
          default:
             rb_raise(cAPIProtoError, "Illegal return type '%s'",
-               RSTRING(v_return)->ptr
+               RSTRING_PTR(v_return)
             );
       }
    }
@@ -507,15 +516,15 @@ DWORD CallbackFunction(CALLPARAM param)
 
     if(!NIL_P(ActiveCallback)){
         v_proto = rb_iv_get(ActiveCallback, "@prototype");
-        a_proto = RSTRING(v_proto)->ptr;
+        a_proto = RSTRING_PTR(v_proto);
 
         v_return = rb_iv_get(ActiveCallback, "@return_type");
-        a_return = RSTRING(v_return)->ptr;
+        a_return = RSTRING_PTR(v_return);
 
         v_proc = rb_iv_get(ActiveCallback, "@function");
-        argc = RSTRING(v_proto)->len;
+        argc = RSTRING_LEN(v_proto);
 
-        for(i=0; i < RSTRING(v_proto)->len; i++){
+        for(i=0; i < RSTRING_LEN(v_proto); i++){
            argv[i] = Qnil;
            switch(a_proto[i]){
               case 'L':
@@ -530,7 +539,7 @@ DWORD CallbackFunction(CALLPARAM param)
                  break;
               default:
                  rb_raise(cAPIProtoError, "Illegal prototype '%s'",
-                    RSTRING(a_proto[i])->ptr
+                    RSTRING_PTR(a_proto[i])
                  );
             }
         }
@@ -553,7 +562,7 @@ DWORD CallbackFunction(CALLPARAM param)
               return NUM2ULONG(v_retval);
               break;
            case 'S':
-              return (unsigned long)RSTRING(v_retval)->ptr;
+              return (unsigned long)RSTRING_PTR(v_retval);
               break;
            case 'P':
               if(NIL_P(v_retval)){
@@ -684,23 +693,23 @@ 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
-   if(RARRAY(v_proto)->len != RARRAY(v_args)->len){
-      char* c = StringValuePtr(RARRAY(v_proto)->ptr[0]);
+   if(RARRAY_LEN(v_proto) != RARRAY_LEN(v_args)){
+      char* c = StringValuePtr(RARRAY_PTR(v_proto)[0]);
       if(!strcmp(c, "V")){
          rb_ary_push(v_args, Qnil);
       }
       else{
          rb_raise(rb_eArgError,
             "wrong number of parameters: expected %d, got %d",
-            RARRAY(v_proto)->len, RARRAY(v_args)->len
+            RARRAY_LEN(v_proto), RARRAY_LEN(v_args)
          );
       }
    }
 
-   len = RARRAY(v_proto)->len;
+   len = RARRAY_LEN(v_proto);
 
    for(i = 0; i < len; i++){
-      v_arg = RARRAY(v_args)->ptr[i];
+      v_arg = RARRAY_PTR(v_args)[i];
 
       // Convert nil to NULL.  Otherwise convert as appropriate.
       if(NIL_P(v_arg))
@@ -730,10 +739,10 @@ static VALUE api_call(int argc, VALUE* argv, VALUE self){
             case _T_CALLBACK:
                ActiveCallback = v_arg;
                v_proto = rb_iv_get(ActiveCallback, "@prototype");
-               param.params[i] = (LPARAM)CallbackTable[RSTRING(v_proto)->len];
+               param.params[i] = (LPARAM)CallbackTable[RSTRING_LEN(v_proto)];
                break;
             case _T_STRING:
-               param.params[i] = (unsigned long)RSTRING(v_arg)->ptr;
+               param.params[i] = (unsigned long)RSTRING_PTR(v_arg);
                break;
             default:
                param.params[i] = NUM2ULONG(v_arg);
@@ -763,7 +772,7 @@ static VALUE api_call(int argc, VALUE* argv, VALUE self){
          }
          else{
             VALUE v_efunc = rb_iv_get(self, "@effective_function_name");
-            char* efunc = RSTRING(v_efunc)->ptr;
+            char* efunc = RSTRING_PTR(v_efunc);
             if(efunc[strlen(efunc)-1] == 'W'){
                v_return = rb_str_new(
                   (TCHAR*)return_value,
@@ -778,7 +787,7 @@ static VALUE api_call(int argc, VALUE* argv, VALUE self){
       case _T_STRING:
          {
             VALUE v_efunc = rb_iv_get(self, "@effective_function_name");
-            char* efunc = RSTRING(v_efunc)->ptr;
+            char* efunc = RSTRING_PTR(v_efunc);
 
             if(efunc[strlen(efunc)-1] == 'W'){
                v_return = rb_str_new(

data/test/test_win32_api.rb

@@ -20,7 +20,7 @@ class TC_Win32_API < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('1.3.0', API::VERSION)
+      assert_equal('1.4.0', API::VERSION)
    end
 
    def test_constructor_basic

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: win32-api
 version: !ruby/object:Gem::Version 
-  version: 1.3.0
+  version: 1.4.0
 platform: x86-mswin32-80
 authors: 
 - Daniel J. Berger
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-10 00:00:00 -07:00
+date: 2009-02-20 00:00:00 -07:00
 default_executable: 
 dependencies: []