win32-api 1.4.6-x86-mingw32

data/CHANGES

@@ -0,0 +1,132 @@
+== 1.4.6 - 9-Feb-2010
+* Fixed a warning that showed up with MinGW/gcc caused by an unnecessary
+  pointer dereference.
+* Some updates to the Rakefile and gemspec. Gem building is now handled via
+  Rake tasks.
+* Minor updates to the test suite.
+
+== 1.4.5 - 24-Aug-2009
+* Reverted the change in 1.4.4. We need unsigned longs in a few cases.
+  Consequently, you should upgrade windows-pr to 1.0.8 or later because
+  some return values were set to -1 instead of 0xFFFFFFFF as they are now.
+* Updated one test to validate return value from failed function.
+
+== 1.4.4 - 18-Aug-2009
+* Fixed a bug where functions that returned a long return type were unsigned
+  instead of signed.
+* The Rakefile has been refactored somewhat, including the removal of FFI
+  related tasks. Those are now in a separate branch in the repository.
+* The test-unit library is now a development dependency instead of a runtime
+  dependency.
+
+== 1.4.3 - 23-Jun-2009
+* Bug fix for mingw.
+* License now set to Artistic 2.0.
+
+== 1.4.2 - 31-May-2009
+* Updated the internal StringError() function to better handle the possibility
+  of the English .mui file not being found. Thanks go to Michel Demazure for
+  the spot.
+
+== 1.4.1 - 29-May-2009
+* Callback handling improvements.
+* Updated the gemspec description.
+
+== 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
+  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.
+* Passing a bad return type to Win32::API::Callback now raises an error.
+* Updated the error message for illegal return types to say, "Illegal return
+  type" instead of "Illegal prototype" as it did previously.
+* The error message for a bad function name passed to Win32::API.new now
+  matches JRuby's FFI error message.
+* Improved the handling of msvcrt functions with regards to skipping 'A'
+  and 'W' checks. Previously it was checking against the literal string
+  'msvcrt'. Now it checks against any string that starts with 'msvcr'.
+* Added test-unit 2.x as a prerequisite.
+* Added tests for the Win32::API::Callback#address method.
+* Added tests to all Win32::API classes that explicitly check error messages.
+
+== 1.2.1 - 14-Nov-2008
+* Fixed and updated callback handling.
+* Fixed wide string return handling for pointers and strings.
+* Added the Win32::API::Callback#address instance method.
+* All errors are now in English instead of your native language, because
+  that's what Ruby itself does.
+
+== 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.
+* Some documentation updates in the source and README files.
+
+== 1.0.6 - 18-Apr-2008
+* Added the effective_function_name method. This allows you to see what the
+  actual function name is that was defined, e.g. GetUserNameA vs GetUserNameW.
+* Replaced an instance of _tcscmp with strcmp. The case in question was always
+  going to be ASCII.
+* Cleaned up some -W3 warnings.
+* Added the build_manifest task to the Rakefile, which is automatically run if
+  you're using a version of Ruby built with VC++ 8 or later. This builds a
+  ruby.exe.manifest file (if it doesn't already exist).
+
+== 1.0.5 - 20-Nov-2007
+* The API.new method now defaults to "W" (wide character functions) before "A"
+  (ANSI functions) if the $KCODE global variable is set to 'u' (UTF8).
+* Minor improvements to the Rakefile.
+
+== 1.0.4 - 26-Oct-2007
+* Fixed a bug where methods that returned pointers ('P') could choke if the
+  resulting pointer was 0 or NULL. In this case, nil is now returned instead.
+* Tweak to the extconf.rb file that helps the gem build it from source
+  properly.
+
+== 1.0.3 - 28-Sep-2007
+* Fixed a subtle but dangerous copy-on-write bug in the API#call method.
+
+== 1.0.2 - 28-Sep-2007
+* Fixed a bug in an internal struct member that was causing segfaults. Thanks
+  go to Lars Olsson for the spot.
+* Fixed the 'install' task in the Rakefile. This only affected native builds,
+  not the prebuilt binary.
+* Added a few more tests.
+
+== 1.0.1 - 27-Sep-2007
+* Functions declared with a void prototype no longer require an explicit nil
+  argument to fulfill the arity requirement. You can still call them with an
+  explicit nil if you wish, however.
+* Fixed the gemspec for the native build.
+
+== 1.0.0 - 14-Sep-2007
+* Initial release

data/MANIFEST

@@ -0,0 +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
+* test/test_win32_api_function.rb

data/README

@@ -0,0 +1,101 @@
+= 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')
+  EnumWindowsProc = API::Callback.new('LP', 'I'){ |handle, param|
+    buf = "\0" * 200
+    GetWindowText.call(handle, buf, 200);
+    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.
+  * 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' prototypes. Always use 'L' for longs now.
+  * Sensible default arguments for the prototype, return type and DLL name.
+  * 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.
+   
+= 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.
+
+= 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
+  All Rights Reserved
+
+= License
+  Artistic 2.0
+
+= Authors
+  Daniel J. Berger
+  Park Heesob

data/Rakefile

@@ -0,0 +1,105 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rbconfig'
+include Config
+
+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
+        sh "mt -inputresource:ruby.exe;2 -out:ruby.exe.manifest"
+      end
+    end
+  end
+end
+
+desc 'Install the win32-api library (non-gem)'
+task :install => [:build] do
+  Dir.chdir('ext'){
+    sh "#{make} install"
+  }
+end
+
+desc 'Clean any build files for Win32::API'
+task :clean do
+  Dir.chdir('ext') do
+    if File.exists?('api.so') || File.exists?('win32/api.so') ||
+      File.exists?('api.obj') || File.exists?('Makefile')
+    then
+      sh "#{make} distclean"
+      rm 'win32/api.so' if File.exists?('win32/api.so')
+      rm 'api.so' if File.exists?('api.so') 
+    end
+  end
+
+  # Cleanup any files generated by the build_binary_gem task
+  rm_rf('lib') if File.exists?('lib')
+  Dir["*.gem"].each{ |f| File.delete(f) }
+end
+
+desc "Build Win32::API (but don't install it)"
+task :build => [:clean, :build_manifest] do
+  Dir.chdir('ext') do
+    ruby "extconf.rb"
+    sh make
+    cp "api.so", "win32" # For the test suite
+  end
+end
+
+namespace 'gem' do
+  desc 'Build a standard 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'
+
+    spec = eval(IO.read('win32-api.gemspec'))
+    spec.platform = Gem::Platform::CURRENT
+    spec.extensions = nil
+    spec.files = spec.files.reject{ |f| f.include?('ext') }
+
+    Gem::Builder.new(spec).build
+  end
+
+  desc 'Install the gem'
+  task :install => [:create] do
+    file = Dir["*.gem"].first
+    sh "gem install #{file}"
+  end
+end
+
+namespace 'test' do
+  Rake::TestTask.new(:all) do |test|
+    task :all => [:build]
+    test.libs << 'ext'
+    test.warning = true
+    test.verbose = true
+  end
+
+  Rake::TestTask.new(:callback) do |test|
+    task :callback => [:build]
+    test.test_files = FileList['test/test_win32_api_callback.rb']
+    test.libs << 'ext'
+    test.warning = true
+    test.verbose = true
+  end
+
+  Rake::TestTask.new(:function) do |test|
+    task :function => [:build]
+    test.test_files = FileList['test/test_win32_api_function.rb']
+    test.libs << 'ext'
+    test.warning = true
+    test.verbose = true
+  end
+end

data/ext/win32/api.c

@@ -0,0 +1,946 @@
+#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.4.5"
+
+#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, cAPIProtoError, cAPILoadError;
+static VALUE ActiveCallback = Qnil;
+
+typedef struct {
+    HANDLE library;
+    FARPROC function;
+    int return_type;
+    int prototype[20];
+} Win32API;
+
+static void api_free(Win32API* ptr){
+   if(ptr->library)
+      FreeLibrary(ptr->library);
+
+   if(ptr)
+      free(ptr);
+}
+
+static VALUE api_allocate(VALUE klass){
+   Win32API* ptr = malloc(sizeof(Win32API));
+   return Data_Wrap_Struct(klass, 0, api_free, ptr);
+}
+
+/* Helper function that converts the error number returned by GetLastError()
+ * into a human readable string. Note that we always use English for error
+ * output because that's what Ruby itself does.
+ *
+ * Internal use only.
+ */
+char* StringError(DWORD dwError){
+   LPVOID lpMsgBuf;
+   static char buf[MAX_PATH];
+   DWORD dwLen;
+
+   // Assume ASCII error messages from the Windows API
+   dwLen = FormatMessageA(
+      FORMAT_MESSAGE_ALLOCATE_BUFFER |
+      FORMAT_MESSAGE_FROM_SYSTEM |
+      FORMAT_MESSAGE_IGNORE_INSERTS,
+      NULL,
+      dwError,
+      MAKELANGID(LANG_ENGLISH, SUBLANG_ENGLISH_US),
+      (LPSTR)&lpMsgBuf,
+      0,
+      NULL
+   );
+
+   /* It appears that Windows doesn't necessarily ship with the DLL
+    * required to always use English error messages. Check for error
+    * ERROR_MUI_FILE_NOT_FOUND (15100), and try again if necessary.
+    */
+   if(!dwLen && GetLastError() == 15100){
+      dwLen = FormatMessageA(
+         FORMAT_MESSAGE_ALLOCATE_BUFFER |
+         FORMAT_MESSAGE_FROM_SYSTEM |
+         FORMAT_MESSAGE_IGNORE_INSERTS,
+         NULL,
+         dwError,
+         0,
+         (LPSTR)&lpMsgBuf,
+         0,
+         NULL
+      );
+   }
+
+   if(!dwLen){
+      rb_raise(
+         cAPIError,
+         "Attempt to format message failed (error = '%d')",
+         GetLastError()
+      );
+   }
+
+   memset(buf, 0, MAX_PATH);
+
+   /* remove \r\n */
+#ifdef HAVE_STRNCPY_S
+   strncpy_s(buf, MAX_PATH, lpMsgBuf, dwLen - 2);
+#else
+   strncpy(buf, lpMsgBuf, dwLen - 2);
+#endif
+
+   LocalFree(lpMsgBuf);
+
+   return buf;
+}
+
+/*
+ * call-seq:
+ *    Win32::API::Callback.new(prototype, return='L'){ |proto| ... }
+ *
+ * Creates and returns a new Win32::API::Callback object. The prototype
+ * arguments are yielded back to the block in the same order they were
+ * declared.
+ *
+ * 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), '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
+ * 'L' (long).
+ *
+ * Example:
+ *    require 'win32/api'
+ *    include Win32
+ *
+ *    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);
+ *       puts buf.strip unless buf.strip.empty?
+ *       buf.index(param).nil? ? true : false
+ *    }
+ *
+ *    EnumWindows.call(EnumWindowsProc, 'UEDIT32')
+ */
+static VALUE callback_init(int argc, VALUE* argv, VALUE self)
+{
+   void *find_callback(VALUE,int);
+   VALUE v_proto, v_return, v_proc;
+   int i;
+
+   rb_scan_args(argc, argv, "11&", &v_proto, &v_return, &v_proc);
+
+   /* Validate prototype characters */
+   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_PTR(v_proto)[i]
+            );
+      }
+   }
+
+   if(NIL_P(v_return) || RARRAY_LEN(v_return) == 0){
+      v_return = rb_str_new2("L");
+   }
+   else{
+      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_PTR(v_return)
+            );
+      }
+   }
+
+   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)find_callback(self,RSTRING_LEN(v_proto))));
+   ActiveCallback = self;
+
+   return self;
+}
+
+/*
+ * call-seq:
+ *    Win32::API.new(function, prototype='V', return='L', dll='kernel32')
+ *
+ * Creates and returns a new Win32::API object. The +function+ is the name
+ * of the Windows function.
+ *
+ * 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), '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).
+ *
+ * The +dll+ is the name of the DLL file that the function is exported from.
+ * The default is 'kernel32'.
+ *
+ * If the function cannot be found then an API::Error is raised (a subclass
+ * of RuntimeError).
+ *
+ * Example:
+ *
+ *    require 'win32/api'
+ *    include Win32
+ *
+ *    buf = 0.chr * 260
+ *    len = [buf.length].pack('L')
+ *
+ *    GetUserName = API.new('GetUserName', 'PP', 'I', 'advapi32')
+ *    GetUserName.call(buf, len)
+ *
+ *    puts buf.strip
+ */
+static VALUE api_init(int argc, VALUE* argv, VALUE self)
+{
+   HMODULE hLibrary;
+   FARPROC fProc;
+   Win32API* ptr;
+   int i;
+   char* first  = "A";
+   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);
+
+   Data_Get_Struct(self, Win32API, ptr);
+
+   // Convert a string prototype to an array of characters
+   if(rb_respond_to(v_proto, rb_intern("split")))
+      v_proto = rb_str_split(v_proto, "");
+
+   // Convert a nil or empty prototype to 'V' (void) automatically
+   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_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))
+      v_dll = rb_str_new2("kernel32");
+
+   // Set the default return type to 'L' (DWORD)
+   if(NIL_P(v_return))
+      v_return = rb_str_new2("L");
+
+   SafeStringValue(v_dll);
+   SafeStringValue(v_proc);
+
+   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_PTR(v_dll),
+         StringError(GetLastError())
+      );
+   }
+
+   ptr->library = hLibrary;
+
+   /* 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::LoadLibraryError.
+    */
+
+   fProc = GetProcAddress(hLibrary, TEXT(RSTRING_PTR(v_proc)));
+
+   // Skip the ANSI and Wide function checks for MSVCRT functions.
+   if(!fProc){
+      if(strstr(RSTRING_PTR(v_dll), "msvcr")){
+         rb_raise(
+            cAPILoadError,
+            "Unable to load function '%s'",
+            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_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_PTR(v_unicode)));
+
+            if(!fProc){
+               rb_raise(
+                  cAPILoadError,
+                  "Unable to load function '%s', '%s', or '%s'",
+                  RSTRING_PTR(v_proc),
+                  RSTRING_PTR(v_ascii),
+                  RSTRING_PTR(v_unicode)
+               );
+            }
+            else{
+               rb_iv_set(self, "@effective_function_name", v_unicode);
+            }
+         }
+         else{
+            rb_iv_set(self, "@effective_function_name", v_ascii);
+         }
+      }
+   }
+   else{
+      rb_iv_set(self, "@effective_function_name", v_proc);
+   }
+
+   ptr->function = fProc;
+
+   // Push the numeric prototypes onto our int array for later use.
+
+   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;
+         case 'P':
+            ptr->prototype[i] = _T_POINTER;
+            break;
+         case 'I': case 'B':
+            ptr->prototype[i] = _T_INTEGER;
+            break;
+         case 'V':
+            ptr->prototype[i] = _T_VOID;
+            break;
+         case 'K':
+            ptr->prototype[i] = _T_CALLBACK;
+            break;
+         case 'S':
+            ptr->prototype[i] = _T_STRING;
+            break;
+         default:
+            rb_raise(cAPIProtoError, "Illegal prototype '%s'",
+               StringValuePtr(RARRAY_PTR(v_proto)[i])
+            );
+      }
+   }
+
+   // Store the return type for later use.
+
+   // Automatically convert empty strings or nil to type void.
+   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_PTR(v_return)){
+         case 'L':
+            ptr->return_type = _T_LONG;
+            break;
+         case 'P':
+            ptr->return_type = _T_POINTER;
+            break;
+         case 'I': case 'B':
+            ptr->return_type = _T_INTEGER;
+            break;
+         case 'V':
+            ptr->return_type = _T_VOID;
+            break;
+         case 'S':
+            ptr->return_type = _T_STRING;
+            break;
+         default:
+            rb_raise(cAPIProtoError, "Illegal return type '%s'",
+               RSTRING_PTR(v_return)
+            );
+      }
+   }
+
+   rb_iv_set(self, "@dll_name", v_dll);
+   rb_iv_set(self, "@function_name", v_proc);
+   rb_iv_set(self, "@prototype", v_proto);
+   rb_iv_set(self, "@return_type", v_return);
+
+   return self;
+}
+
+/*
+ * call-seq:
+ *
+ *    API::Function.new(address, prototype = 'V', return_type = 'L')
+ *
+ * Creates and returns an API::Function object. This object is similar to an
+ * API object, except that instead of a character function name you pass a
+ * function pointer address as the first argument, and there's no associated
+ * DLL file.
+ *
+ * Once you have your API::Function object you can then call it the same way
+ * you would an API object.
+ *
+ * Example:
+ *
+ *    require 'win32/api'
+ *    include Win32
+ *
+ *    LoadLibrary = API.new('LoadLibrary', 'P', 'L')
+ *    GetProcAddress = API.new('GetProcAddress', 'LP', 'L')
+ *
+ *    # Play a system beep
+ *    hlib = LoadLibrary.call('user32')
+ *    addr = GetProcAddress.call(hlib, 'MessageBeep')
+ *    func = Win32::API::Function.new(addr, 'L', 'L')
+ *    func.call(0)
+ */
+static VALUE func_init(int argc, VALUE* argv, VALUE self){
+   Win32API* ptr;
+   int i;
+   VALUE v_address, v_proto, v_return;
+
+   rb_scan_args(argc, argv, "12", &v_address, &v_proto, &v_return);
+
+   Data_Get_Struct(self, Win32API, ptr);
+
+   // Convert a string prototype to an array of characters
+   if(rb_respond_to(v_proto, rb_intern("split")))
+      v_proto = rb_str_split(v_proto, "");
+
+   // Convert a nil or empty prototype to 'V' (void) automatically
+   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_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))
+      v_return = rb_str_new2("L");
+
+   ptr->function = (FARPROC)NUM2LONG(v_address);
+
+   // Push the numeric prototypes onto our int array for later use.
+
+   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;
+         case 'P':
+            ptr->prototype[i] = _T_POINTER;
+            break;
+         case 'I': case 'B':
+            ptr->prototype[i] = _T_INTEGER;
+            break;
+         case 'V':
+            ptr->prototype[i] = _T_VOID;
+            break;
+         case 'K':
+            ptr->prototype[i] = _T_CALLBACK;
+            break;
+         case 'S':
+            ptr->prototype[i] = _T_STRING;
+            break;
+         default:
+            rb_raise(cAPIProtoError, "Illegal prototype '%s'",
+               StringValuePtr(RARRAY_PTR(v_proto)[i])
+            );
+      }
+   }
+
+   // Store the return type for later use.
+
+   // Automatically convert empty strings or nil to type void.
+   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_PTR(v_return)){
+         case 'L':
+            ptr->return_type = _T_LONG;
+            break;
+         case 'P':
+            ptr->return_type = _T_POINTER;
+            break;
+         case 'I': case 'B':
+            ptr->return_type = _T_INTEGER;
+            break;
+         case 'V':
+            ptr->return_type = _T_VOID;
+            break;
+         case 'S':
+            ptr->return_type = _T_STRING;
+            break;
+         default:
+            rb_raise(cAPIProtoError, "Illegal return type '%s'",
+               RSTRING_PTR(v_return)
+            );
+      }
+   }
+
+   rb_iv_set(self, "@address", v_address);
+   rb_iv_set(self, "@prototype", v_proto);
+   rb_iv_set(self, "@return_type", v_return);
+
+   return self;
+}
+
+typedef struct {
+   DWORD params[20];
+} CALLPARAM;
+
+
+DWORD CallbackFunction(CALLPARAM param, VALUE callback)
+{
+  VALUE v_proto, v_return, v_proc, v_retval;
+  VALUE argv[20];
+  int i, argc;
+  char *a_proto;
+  char *a_return;
+
+  if(callback && !NIL_P(callback)){
+    v_proto = rb_iv_get(callback, "@prototype");
+    a_proto = RSTRING_PTR(v_proto);
+
+    v_return = rb_iv_get(callback, "@return_type");
+    a_return = RSTRING_PTR(v_return);
+
+    v_proc = rb_iv_get(callback, "@function");
+    argc = RSTRING_LEN(v_proto);
+
+    for(i=0; i < RSTRING_LEN(v_proto); i++){
+      argv[i] = Qnil;
+      switch(a_proto[i]){
+        case 'L':
+          argv[i] = ULONG2NUM(param.params[i]);
+          break;
+        case 'P':
+          if(param.params[i])
+            argv[i] = rb_str_new2((char *)param.params[i]);
+          break;
+        case 'I':
+          argv[i] = INT2NUM(param.params[i]);
+          break;
+        default:
+          rb_raise(cAPIProtoError, "Illegal prototype '%s'", a_proto[i]);
+      }
+    }
+
+    v_retval = rb_funcall2(v_proc, rb_intern("call"), argc, argv);
+
+    /* Handle true and false explicitly, as some CALLBACK functions
+     * require TRUE or FALSE to break out of loops, etc.
+     */
+    if(v_retval == Qtrue)
+      return TRUE;
+    else if(v_retval == Qfalse)
+      return FALSE;
+
+    switch (*a_return) {
+      case 'I':
+        return NUM2INT(v_retval);
+        break;
+      case 'L':
+        return NUM2ULONG(v_retval);
+        break;
+      case 'S':
+        return (unsigned long)RSTRING_PTR(v_retval);
+        break;
+      case 'P':
+        if(NIL_P(v_retval)){
+          return 0;
+        }
+        else if(FIXNUM_P(v_retval)){
+          return NUM2ULONG(v_retval);
+        }
+        else{
+          StringValue(v_retval);
+          rb_str_modify(v_retval);
+          return (unsigned long)StringValuePtr(v_retval);
+        }
+        break;
+    }
+  }
+
+  return 0;
+}
+
+#define CALLBACK0(x) DWORD CALLBACK CallbackFunction0_##x() {\
+   CALLPARAM param = {0};\
+   param.params[0] = 0;\
+   return CallbackFunction(param,FuncTable[0][x]);\
+}
+
+#define CALLBACK1(x) DWORD CALLBACK CallbackFunction1_##x(DWORD p1) {\
+   CALLPARAM param = {p1};\
+   return CallbackFunction(param,FuncTable[1][x]);\
+}
+
+#define CALLBACK2(x) DWORD CALLBACK CallbackFunction2_##x(\
+DWORD p1, DWORD p2){\
+   CALLPARAM param = {p1,p2};\
+   return CallbackFunction(param,FuncTable[2][x]);\
+}
+
+#define CALLBACK3(x) DWORD CALLBACK CallbackFunction3_##x(\
+DWORD p1, DWORD p2, DWORD p3){\
+   CALLPARAM param = {p1,p2,p3};\
+   return CallbackFunction(param,FuncTable[3][x]);\
+}
+
+#define CALLBACK4(x) DWORD CALLBACK CallbackFunction4_##x(\
+DWORD p1, DWORD p2, DWORD p3, DWORD p4){\
+   CALLPARAM param = {p1,p2,p3,p4};\
+   return CallbackFunction(param,FuncTable[4][x]);\
+}
+
+#define CALLBACK5(x) DWORD CALLBACK CallbackFunction5_##x(\
+   DWORD p1, DWORD p2, DWORD p3, DWORD p4, DWORD p5\
+){\
+   CALLPARAM param = {p1,p2,p3,p4,p5};\
+   return CallbackFunction(param,FuncTable[5][x]);\
+}
+
+#define CALLBACK6(x) DWORD CALLBACK CallbackFunction6_##x(\
+   DWORD p1, DWORD p2, DWORD p3, DWORD p4, DWORD p5, DWORD p6\
+){\
+   CALLPARAM param = {p1,p2,p3,p4,p5,p6};\
+   return CallbackFunction(param,FuncTable[6][x]);\
+}
+
+#define CALLBACK7(x) DWORD CALLBACK CallbackFunction7_##x(\
+   DWORD p1, DWORD p2, DWORD p3, DWORD p4, DWORD p5, DWORD p6, DWORD p7\
+){\
+   CALLPARAM param = {p1,p2,p3,p4,p5,p6,p7};\
+   return CallbackFunction(param,FuncTable[7][x]);\
+}
+
+#define CALLBACK8(x) DWORD CALLBACK CallbackFunction8_##x(\
+   DWORD p1, DWORD p2, DWORD p3, DWORD p4,\
+   DWORD p5, DWORD p6, DWORD p7, DWORD p8\
+){\
+   CALLPARAM param = {p1,p2,p3,p4,p5,p6,p7,p8};\
+   return CallbackFunction(param,FuncTable[8][x]);\
+}
+
+#define CALLBACK9(x) DWORD CALLBACK CallbackFunction9_##x(\
+   DWORD p1, DWORD p2, DWORD p3, DWORD p4, DWORD p5,\
+   DWORD p6, DWORD p7, DWORD p8, DWORD p9\
+){\
+   CALLPARAM param = {p1,p2,p3,p4,p5,p6,p7,p8,p9};\
+   return CallbackFunction(param,FuncTable[9][x]);\
+}
+
+#define DEFCALLBACK(x) CALLBACK##x(0)\
+CALLBACK##x(1)\
+CALLBACK##x(2)\
+CALLBACK##x(3)\
+CALLBACK##x(4)\
+CALLBACK##x(5)\
+CALLBACK##x(6)\
+CALLBACK##x(7)\
+CALLBACK##x(8)\
+CALLBACK##x(9)
+
+#define CF(x,y)	CallbackFunction##x##_##y
+
+static VALUE FuncTable[10][10];
+
+DEFCALLBACK(0)
+DEFCALLBACK(1)
+DEFCALLBACK(2)
+DEFCALLBACK(3)
+DEFCALLBACK(4)
+DEFCALLBACK(5)
+DEFCALLBACK(6)
+DEFCALLBACK(7)
+DEFCALLBACK(8)
+DEFCALLBACK(9)
+
+void *CallbackTable[10][10] = {
+{CF(0,0),CF(0,1),CF(0,2),CF(0,3),CF(0,4),CF(0,5),CF(0,6),CF(0,7),CF(0,8),CF(0,9)},
+{CF(1,0),CF(1,1),CF(1,2),CF(1,3),CF(1,4),CF(1,5),CF(1,6),CF(1,7),CF(1,8),CF(1,9)},
+{CF(2,0),CF(2,1),CF(2,2),CF(2,3),CF(2,4),CF(2,5),CF(2,6),CF(2,7),CF(2,8),CF(2,9)},
+{CF(3,0),CF(3,1),CF(3,2),CF(3,3),CF(3,4),CF(3,5),CF(3,6),CF(3,7),CF(3,8),CF(3,9)},
+{CF(4,0),CF(4,1),CF(4,2),CF(4,3),CF(4,4),CF(4,5),CF(4,6),CF(4,7),CF(4,8),CF(4,9)},
+{CF(5,0),CF(5,1),CF(5,2),CF(5,3),CF(5,4),CF(5,5),CF(5,6),CF(5,7),CF(5,8),CF(5,9)},
+{CF(6,0),CF(6,1),CF(6,2),CF(6,3),CF(6,4),CF(6,5),CF(6,6),CF(6,7),CF(6,8),CF(6,9)},
+{CF(7,0),CF(7,1),CF(7,2),CF(7,3),CF(7,4),CF(7,5),CF(7,6),CF(7,7),CF(7,8),CF(7,9)},
+{CF(8,0),CF(8,1),CF(8,2),CF(8,3),CF(8,4),CF(8,5),CF(8,6),CF(8,7),CF(8,8),CF(8,9)},
+{CF(9,0),CF(9,1),CF(9,2),CF(9,3),CF(9,4),CF(9,5),CF(9,6),CF(9,7),CF(9,8),CF(9,9)}};
+
+
+void *find_callback(VALUE obj,int len)
+{
+   int i;
+   for(i=0;i<10;i++)
+   {
+       if(FuncTable[len][i]==0)
+          break;
+   }
+   if(i>=10)
+      rb_raise(cAPIError,"too many callbacks are defined.");
+   FuncTable[len][i] = obj;
+   return CallbackTable[len][i];
+}
+
+/*
+ * call-seq:
+ *    Win32::API#call(arg1, arg2, ...)
+ *
+ * Calls the function pointer with the given arguments (if any). Note that,
+ * while this method will catch some prototype mismatches (raising a TypeError
+ * in the process), it is not fulproof.  It is ultimately your job to make
+ * sure the arguments match the +prototype+ specified in the constructor.
+ *
+ * For convenience, nil is converted to NULL, true is converted to TRUE (1)
+ * and false is converted to FALSE (0).
+ */
+static VALUE api_call(int argc, VALUE* argv, VALUE self){
+   VALUE v_proto, v_args, v_arg, v_return;
+   Win32API* ptr;
+   unsigned long return_value;
+   int i = 0;
+   int len;
+
+   struct{
+      unsigned long params[20];
+   } param;
+
+   Data_Get_Struct(self, Win32API, ptr);
+
+   rb_scan_args(argc, argv, "0*", &v_args);
+
+   v_proto = rb_iv_get(self, "@prototype");
+
+   // For void prototypes, allow either no args or an explicit nil
+   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_LEN(v_proto), RARRAY_LEN(v_args)
+         );
+      }
+   }
+
+   len = RARRAY_LEN(v_proto);
+
+   for(i = 0; i < len; i++){
+      v_arg = RARRAY_PTR(v_args)[i];
+
+      // Convert nil to NULL.  Otherwise convert as appropriate.
+      if(NIL_P(v_arg))
+         param.params[i] = (unsigned long)NULL;
+      else if(v_arg == Qtrue)
+         param.params[i] = TRUE;
+      else if(v_arg == Qfalse)
+         param.params[i] = FALSE;
+      else
+         switch(ptr->prototype[i]){
+            case _T_LONG:
+               param.params[i] = NUM2ULONG(v_arg);
+               break;
+            case _T_INTEGER:
+               param.params[i] = NUM2INT(v_arg);
+               break;
+            case _T_POINTER:
+               if(FIXNUM_P(v_arg)){
+                  param.params[i] = NUM2ULONG(v_arg);
+               }
+               else{
+                  StringValue(v_arg);
+                  rb_str_modify(v_arg);
+                  param.params[i] = (unsigned long)StringValuePtr(v_arg);
+               }
+               break;
+            case _T_CALLBACK:
+               ActiveCallback = v_arg;
+               v_proto = rb_iv_get(ActiveCallback, "@prototype");
+               param.params[i] = (LPARAM)NUM2ULONG(rb_iv_get(ActiveCallback, "@address"));;
+               break;
+            case _T_STRING:
+               param.params[i] = (unsigned long)RSTRING_PTR(v_arg);
+               break;
+            default:
+               param.params[i] = NUM2ULONG(v_arg);
+         }
+   }
+
+   /* Call the function, get the return value */
+   return_value = ptr->function(param);
+
+
+   /* Return the appropriate type based on the return type specified
+    * in the constructor.
+    */
+   switch(ptr->return_type){
+      case _T_INTEGER:
+         v_return = INT2NUM(return_value);
+         break;
+      case _T_LONG:
+         v_return = ULONG2NUM(return_value);
+         break;
+      case _T_VOID:
+         v_return = Qnil;
+         break;
+      case _T_POINTER:
+         if(!return_value){
+            v_return = Qnil;
+         }
+         else{
+            VALUE v_efunc = rb_iv_get(self, "@effective_function_name");
+            char* efunc = RSTRING_PTR(v_efunc);
+            if(efunc[strlen(efunc)-1] == 'W'){
+               v_return = rb_str_new(
+                  (TCHAR*)return_value,
+                  wcslen((wchar_t*)return_value)*2
+               );
+            }
+            else{
+               v_return = rb_str_new2((TCHAR*)return_value);
+            }
+         }
+         break;
+      case _T_STRING:
+         {
+            VALUE v_efunc = rb_iv_get(self, "@effective_function_name");
+            char* efunc = RSTRING_PTR(v_efunc);
+
+            if(efunc[strlen(efunc)-1] == 'W'){
+               v_return = rb_str_new(
+                  (TCHAR*)return_value,
+                  wcslen((wchar_t*)return_value)*2
+               );
+            }
+            else{
+               v_return = rb_str_new2((TCHAR*)return_value);
+            }
+         }
+         break;
+      default:
+         v_return = INT2NUM(0);
+   }
+
+   return v_return;
+}
+
+/*
+ * Wraps the Windows API functions in a Ruby interface.
+ */
+void Init_api(){
+   VALUE mWin32, cAPI, cCallback, cFunction;
+
+   /* Modules and Classes */
+
+   /* The Win32 module serves as a namespace only */
+   mWin32 = rb_define_module("Win32");
+
+   /* The API class encapsulates a function pointer to Windows API function */
+   cAPI = rb_define_class_under(mWin32, "API", rb_cObject);
+
+   /* The API::Callback class encapsulates a Windows CALLBACK function */
+   cCallback = rb_define_class_under(cAPI, "Callback", rb_cObject);
+
+   /* The API::Function class encapsulates a raw function pointer */
+   cFunction = rb_define_class_under(cAPI, "Function", cAPI);
+
+   /* The API::Error class serves as a base class for other errors */
+   cAPIError = rb_define_class_under(cAPI, "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);
+
+   /* Win32::API Instance Methods */
+   rb_define_method(cAPI, "initialize", api_init, -1);
+   rb_define_method(cAPI, "call", api_call, -1);
+
+   /* Win32::API::Callback Instance Methods */
+   rb_define_method(cCallback, "initialize", callback_init, -1);
+
+   /* Win32::API::Function Instance Methods */
+   rb_define_method(cFunction, "initialize", func_init, -1);
+
+   /* The name of the DLL that exports the API function */
+   rb_define_attr(cAPI, "dll_name", 1, 0);
+
+   /* The name of the function passed to the constructor */
+   rb_define_attr(cAPI, "function_name", 1, 0);
+
+   /* The name of the actual function that is returned by the constructor.
+    * For example, if you passed 'GetUserName' to the constructor, then the
+    * effective function name would be either 'GetUserNameA' or 'GetUserNameW'.
+    */
+   rb_define_attr(cAPI, "effective_function_name", 1, 0);
+
+   /* The prototype, returned as an array of characters */
+   rb_define_attr(cAPI, "prototype", 1, 0);
+
+   /* 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 */
+
+   /* The prototype, returned as an array of characters */
+   rb_define_attr(cCallback, "prototype", 1, 0);
+
+   /* 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 */
+   rb_define_attr(cCallback, "address", 1, 0);
+   rb_define_attr(cFunction, "address", 1, 0);
+
+   /* Constants */
+
+   /* 1.4.5: The version of the win32-api library */
+   rb_define_const(cAPI, "VERSION", rb_str_new2(WINDOWS_API_VERSION));
+}