win32-api 1.1.0 → 1.2.0

data/CHANGES

@@ -1,3 +1,12 @@
+= 1.2.0 - 22-Jul-2008
+* Added support for the 'S' (string) prototype and return type. It can be
+  used instead of 'P' (pointer) for const char*.
+* Some internal refactoring. The attempts to load ANSI and/or Wide character
+  versions of functions are skipped for MSVCRT functions, since they do not
+  exist. This eliminates some unnecessary LoadLibrary() calls.
+* Added a couple of gem building Rake tasks.
+* Added a few more tests.
+
 = 1.1.0 - 12-Jun-2008
 * Added the Windows::API::Function class. This is a subclass of Win32::API
   meant only for use with raw function pointers.

data/README

@@ -39,10 +39,12 @@
 = Differences between win32-api and Win32API
    * This library has callback support
    * This library supports raw function pointers.
+   * This library supports a separate string type for const char* (S).
    * Argument order change. The DLL name is now last, not first.
-   * Removed the 'N' and 'n'. Always use 'L' for longs now.
+   * Removed the 'N' and 'n' prototypes. Always use 'L' for longs now.
    * Sensible default arguments for the prototype, return type and DLL name.
-   * Reader methods for the function name, prototype, return type and DLL.
+   * Reader methods for the function name, effective function name, prototype,
+     return type and DLL.
    * Removed the support for lower case prototype and return types. Always
      use capital letters.
    * Resorts to wide character functions (where possible) when $KCODE is set
@@ -82,9 +84,12 @@
    implied warranties, including, without limitation, the implied
    warranties of merchantability and fitness for a particular purpose.
    
-= Known Bugs
-   None that I'm aware of. Please submit any bug reports to the project page
-   at http://www.rubyforge.org/projects/win32utils.
+= Known Issues
+   Possible callback issues when dealing with multi-threaded applications.
+   We are working on this for the next 1.2.x release.
+   
+   Please submit any bug reports to the project page at
+   http://www.rubyforge.org/projects/win32utils.
 
 = Copyright
    (C) 2003-2008 Daniel J. Berger
@@ -95,4 +100,4 @@
 
 = Authors
    Daniel J. Berger
-   Park Heesob
+   Park Heesob

data/ext/win32/api.c

@@ -2,13 +2,14 @@
 #include <windows.h>
 
 #define MAX_BUF 1024
-#define WINDOWS_API_VERSION "1.1.0"
+#define WINDOWS_API_VERSION "1.2.0"
 
 #define _T_VOID     0
 #define _T_LONG     1
 #define _T_POINTER  2
 #define _T_INTEGER  3
 #define _T_CALLBACK 4
+#define _T_STRING   5
 
 VALUE cAPIError, cCallbackError;
 
@@ -80,8 +81,8 @@ char* StringError(DWORD dwError){
  * 
  * The +prototype+ is the function prototype for the callback function. This
  * is a string. The possible valid characters are 'I' (integer), 'L' (long),
- * 'V' (void), or 'P' (pointer). Unlike API objects, API::Callback objects
- * do not have a default prototype.
+ * 'V' (void), 'P' (pointer) or 'S' (string). Unlike API objects, API::Callback
+ * objects do not have a default prototype.
  * 
  * The +return+ argument is the return type for the callback function. The
  * valid characters are the same as for the +prototype+. The default is
@@ -93,6 +94,7 @@ char* StringError(DWORD dwError){
  * 
  *    EnumWindows = API.new('EnumWindows', 'KP', 'L', 'user32')
  *    GetWindowText = API.new('GetWindowText', 'LPI', 'I', 'user32')
+ * 
  *    EnumWindowsProc = API::Callback.new('LP', 'I'){ |handle, param|
  *       buf = "\0" * 200
  *       GetWindowText.call(handle, buf, 200);
@@ -112,7 +114,7 @@ static VALUE callback_init(int argc, VALUE* argv, VALUE self)
    /* Validate prototype characters */
    for(i = 0; i < RSTRING(v_proto)->len; i++){
       switch(RSTRING(v_proto)->ptr[i]){
-         case 'I': case 'L': case 'P': case 'V':
+         case 'I': case 'L': case 'P': case 'V': case 'S':
             break;
          default:
             rb_raise(cCallbackError, "Illegal prototype '%c'",
@@ -139,8 +141,13 @@ static VALUE callback_init(int argc, VALUE* argv, VALUE self)
  * 
  * The +prototype+ is the function prototype for +function+. This can be a
  * string or an array of characters.  The possible valid characters are 'I'
- * (integer), 'L' (long), 'V' (void), 'P' (pointer), or 'K' (callback).
+ * (integer), 'L' (long), 'V' (void), 'P' (pointer), 'K' (callback) or 'S'
+ * (string).
+ *
  * The default is void ('V').
+ *
+ * Constant (const char*) strings should use 'S'. Pass by reference string
+ * buffers should use 'P'. The former is faster, but cannot be modified.
  * 
  * The +return+ argument is the return type for the function.  The valid
  * characters are the same as for the +prototype+.  The default is 'L' (long).
@@ -227,33 +234,44 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
       second = "A";
    }
 
+   // Skip the ANSI and Wide function checks for MSVCRT functions.
    if(!fProc){
-      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));
-
-      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));
+      if(!strcmp(RSTRING(v_dll)->ptr, "msvcrt")){
+         rb_raise(
+            cAPIError,
+            "GetProcAddress() failed for '%s': %s",
+            RSTRING(v_proc)->ptr,
+            StringError(GetLastError())
+         );
+      }
+      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));
 
          if(!fProc){
-            rb_raise(
-               cAPIError,
-               "GetProcAddress() failed for '%s', '%s' and '%s': %s",
-               RSTRING(v_proc)->ptr,
-               RSTRING(v_ascii)->ptr,
-               RSTRING(v_unicode)->ptr,
-               StringError(GetLastError())
-            );
+            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));
+
+            if(!fProc){
+               rb_raise(
+                  cAPIError,
+                  "GetProcAddress() failed for '%s', '%s' and '%s': %s",
+                  RSTRING(v_proc)->ptr,
+                  RSTRING(v_ascii)->ptr,
+                  RSTRING(v_unicode)->ptr,
+                  StringError(GetLastError())
+               );
+            }
+            else{
+               rb_iv_set(self, "@effective_function_name", v_unicode);
+            }
          }
          else{
-            rb_iv_set(self, "@effective_function_name", v_unicode);
+            rb_iv_set(self, "@effective_function_name", v_ascii);
          }
       }
-      else{
-         rb_iv_set(self, "@effective_function_name", v_ascii);
-      }
    }
    else{
       rb_iv_set(self, "@effective_function_name", v_proc);
@@ -281,6 +299,9 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
          case 'K':
             ptr->prototype[i] = _T_CALLBACK;
             break;
+         case 'S':
+            ptr->prototype[i] = _T_STRING;
+            break;
          default:
             rb_raise(cAPIError, "Illegal prototype '%s'", RARRAY(v_proto)->ptr[i]);
       }
@@ -308,6 +329,9 @@ static VALUE api_init(int argc, VALUE* argv, VALUE self)
          case 'V':
             ptr->return_type = _T_VOID;
             break;
+         case 'S':
+            ptr->return_type = _T_STRING;
+            break;
          default:
             rb_raise(cAPIError, "Illegal prototype '%s'", RARRAY(v_proto)->ptr[i]);
       }
@@ -397,6 +421,9 @@ static VALUE func_init(int argc, VALUE* argv, VALUE self){
          case 'K':
             ptr->prototype[i] = _T_CALLBACK;
             break;
+         case 'S':
+            ptr->prototype[i] = _T_STRING;
+            break;
          default:
             rb_raise(cAPIError, "Illegal prototype '%s'", RARRAY(v_proto)->ptr[i]);
       }
@@ -424,6 +451,9 @@ static VALUE func_init(int argc, VALUE* argv, VALUE self){
          case 'V':
             ptr->return_type = _T_VOID;
             break;
+         case 'S':
+            ptr->return_type = _T_STRING;
+            break;
          default:
             rb_raise(cAPIError, "Illegal prototype '%s'", RARRAY(v_proto)->ptr[i]);
       }
@@ -495,6 +525,9 @@ DWORD CallbackFunction(PARAM param)
            case 'L':
               return NUM2ULONG(v_retval);    
               break;
+           case 'S':
+              return (unsigned long)RSTRING(v_retval)->ptr;
+              break;
            case 'P':
 	           if(NIL_P(v_retval)){
 	              return 0;
@@ -588,6 +621,9 @@ static VALUE api_call(int argc, VALUE* argv, VALUE self){
                ActiveCallback = v_arg;
                param.params[i] = (LPARAM)CallbackFunction;	
                break;
+            case _T_STRING:
+               param.params[i] = (unsigned long)RSTRING(v_arg)->ptr;
+               break;
             default:
                param.params[i] = NUM2ULONG(v_arg);
          }
@@ -615,6 +651,9 @@ static VALUE api_call(int argc, VALUE* argv, VALUE self){
          else
             v_return = rb_str_new2((TCHAR*)return_value);
          break;
+      case _T_STRING:
+         v_return = rb_str_new2((TCHAR*)return_value);
+         break;
       default:
          v_return = INT2NUM(0);
    }
@@ -676,7 +715,7 @@ void Init_api(){
    /* The prototype, returned as an array of characters */
    rb_define_attr(cAPI, "prototype", 1, 0);
    
-   /* The return type, returned as a single character, P, L, I, V or B */
+   /* The return type, returned as a single character, S, P, L, I, V or B */
    rb_define_attr(cAPI, "return_type", 1, 0);
    
    /* Win32::API::Callback Instance Methods */
@@ -684,7 +723,7 @@ void Init_api(){
    /* The prototype, returned as an array of characters */
    rb_define_attr(cCallback, "prototype", 1, 0);
       
-   /* The return type, returned as a single character, P, L, I, V or B */
+   /* The return type, returned as a single character, S, P, L, I, V or B */
    rb_define_attr(cCallback, "return_type", 1, 0);
 
    /* The numeric address of the function pointer */
@@ -692,6 +731,6 @@ void Init_api(){
  
    /* Constants */
    
-   /* 1.1.0: The version of this library, returned as a String */
+   /* 1.2.0: The version of this library, returned as a String */
    rb_define_const(cAPI, "VERSION", rb_str_new2(WINDOWS_API_VERSION));
 }

data/test/test_win32_api.rb

@@ -13,10 +13,18 @@ class TC_Win32_API < Test::Unit::TestCase
       @buf = 0.chr * 260
       @api = API.new('GetCurrentDirectory', 'LP')
       @gle = API.new('GetLastError', 'V', 'L')
+      @str = API.new('strstr', 'PP', 'P', 'msvcrt')
    end
 
    def test_version
-      assert_equal('1.1.0', API::VERSION)
+      assert_equal('1.2.0', API::VERSION)
+   end
+
+   def test_constructor_basic
+      assert_nothing_raised{ API.new('GetCurrentDirectory') }
+      assert_nothing_raised{ API.new('GetCurrentDirectory', 'LP') }
+      assert_nothing_raised{ API.new('GetCurrentDirectory', 'LP', 'L') }
+      assert_nothing_raised{ API.new('GetCurrentDirectory', 'LP', 'L', 'kernel32') }
    end
  
    def test_call
@@ -38,11 +46,13 @@ class TC_Win32_API < Test::Unit::TestCase
    def test_function_name
       assert_respond_to(@api, :function_name)
       assert_equal('GetCurrentDirectory', @api.function_name)
+      assert_equal('strstr', @str.function_name)
    end
    
    def test_effective_function_name
       assert_respond_to(@api, :effective_function_name)
       assert_equal('GetCurrentDirectoryA', @api.effective_function_name)
+      assert_equal('strstr', @str.effective_function_name)
 
       @api = API.new('GetCurrentDirectoryA', 'LP')
       assert_equal('GetCurrentDirectoryA', @api.effective_function_name)
@@ -68,9 +78,30 @@ class TC_Win32_API < Test::Unit::TestCase
    end
    
    def test_constructor_expected_failures
+      assert_raise(ArgumentError){ API.new }
       assert_raise(API::Error){ API.new('GetUserName', 'PL', 'I', 'foo') }
-      assert_raise(API::Error){ API.new('GetUserName', 'X', 'I', 'foo') }
-      assert_raise(API::Error){ API.new('GetUserName', 'PL', 'X', 'foo') }
+      assert_raise(API::Error){ API.new('GetUserName', 'X', 'I', 'kernel32') }
+      assert_raise(API::Error){ API.new('GetUserName', 'PL', 'X', 'kernel32') }
+   end
+
+   # Compare MSVCRT error messages vs regular error messages. This validates
+   # that we're skipping the 'A' and 'W' lookups for MSVCRT functions.
+   def test_constructor_expected_failure_messages
+      begin
+         API.new('GetBlah')
+      rescue API::Error => err
+         expected = "GetProcAddress() failed for 'GetBlah', 'GetBlahA' and "
+         expected += "'GetBlahW': The specified procedure could not be found."
+         assert_equal(expected, err.to_s)
+      end
+
+      begin
+         API.new('strxxx', 'P', 'P', 'msvcrt')
+      rescue API::Error => err
+         expected = "GetProcAddress() failed for 'strxxx': The specified "
+         expected += "procedure could not be found."
+         assert_equal(expected, err.to_s)
+      end
    end
    
    def test_call_expected_failures
@@ -81,5 +112,6 @@ class TC_Win32_API < Test::Unit::TestCase
       @buf = nil
       @api = nil
       @gle = nil
+      @str = nil
    end
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: win32-api
 version: !ruby/object:Gem::Version 
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Daniel J. Berger
+- Park Heesob
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2008-06-12 00:00:00 -06:00
+date: 2008-07-22 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -25,8 +26,6 @@ extra_rdoc_files:
 - MANIFEST
 - ext/win32/api.c
 files: 
-- ext/extconf.rb
-- ext/win32
 - ext/win32/api.c
 - test/test_win32_api.rb
 - test/test_win32_api_callback.rb
@@ -56,9 +55,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: win32utils
-rubygems_version: 1.1.1
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: A superior replacement for Win32API
-test_files: []
-
+test_files: 
+- test/test_win32_api.rb
+- test/test_win32_api_callback.rb
+- test/test_win32_api_function.rb