win32-api 1.4.2 → 1.4.3

data/CHANGES

@@ -1,107 +1,111 @@
-= 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
+= 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

@@ -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/README

@@ -1,103 +1,103 @@
-= 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.
-   * Resorts to wide character functions (where possible) when $KCODE is set
-     to UTF8.
-   
-= 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.
-   
-= 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.
-   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-2009 Daniel J. Berger
-   All Rights Reserved
-
-= License
-   Ruby's
-
-= Authors
-   Daniel J. Berger
-   Park Heesob
+= 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.
+   * Resorts to wide character functions (where possible) when $KCODE is set
+     to UTF8.
+   
+= 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.
+   
+= 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.
+   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-2009 Daniel J. Berger
+   All Rights Reserved
+
+= License
+   Ruby's
+
+= Authors
+   Daniel J. Berger
+   Park Heesob

data/Rakefile

@@ -0,0 +1,146 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rbconfig'
+include Config
+
+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 "nmake install"
+   }
+end
+
+task :install_gem do
+   ruby 'win32-api.gemspec'
+   file = Dir["*.gem"].first
+   sh "gem install #{file}"
+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")
+      then
+         sh "nmake distclean"
+         rm "win32/api.so" if File.exists?("win32/api.so")
+         rm "api.so" if File.exists?("api.so") 
+      end
+   end
+end
+
+desc "Build Win32::API (but don't install it)"
+task :build => [:clean, :build_manifest] do
+   Dir.chdir('ext') do
+      ruby "extconf.rb"
+      sh "nmake"
+      mv "api.so", "win32" # For the test suite
+   end
+end
+
+desc "Build a standard gem"
+task :build_gem => [:clean] do 
+   spec = Gem::Specification.new do |gem|
+      gem.name         = "win32-api"
+      gem.version      = "1.4.3"
+      gem.authors      = ["Daniel J. Berger", "Park Heesob"]
+      gem.email        = "djberg96@gmail.com"
+      gem.homepage     = "http://www.rubyforge.org/projects/win32utils"
+      gem.rubyforge_project = "win32utils"
+      gem.platform     = Gem::Platform::RUBY
+      gem.summary      = "A superior replacement for Win32API"
+      gem.has_rdoc     = true
+      gem.test_files   = Dir['test/test*']
+      gem.extensions   = ['ext/extconf.rb']
+      gem.license      = 'Artistic 2.0'
+      files            = Dir["ext/win32/api.c"] + Dir["test/*"]
+      files.delete_if{ |f| f.include?('CVS') }
+      gem.files = files
+      gem.extra_rdoc_files = ['README', 'CHANGES', 'MANIFEST', 'ext/win32/api.c']
+      gem.rubyforge_project = 'win32utils'
+      gem.required_ruby_version = '>= 1.8.2'
+      
+      gem.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
+         advantages over Win32API, including callback support, raw function
+         pointers, an additional string type, and more.
+      EOF
+   end
+
+   Gem::Builder.new(spec).build
+end
+
+desc "Build a binary gem"
+task :build_binary_gem => [:build] do
+   mkdir_p 'lib/win32'
+   mv 'ext/win32/api.so', 'lib/win32'
+   rm_rf 'lib/ffi'
+   rm_rf 'lib/jruby'
+
+   task :build_binary_gem => [:clean]
+
+   spec = Gem::Specification.new do |gem|
+      gem.name         = "win32-api"
+      gem.version      = "1.4.3"
+      gem.authors      = ["Daniel J. Berger", "Park Heesob"]
+      gem.email        = "djberg96@gmail.com"
+      gem.homepage     = "http://www.rubyforge.org/projects/win32utils"
+      gem.rubyforge_project = "win32utils"
+      gem.platform     = Gem::Platform::CURRENT
+      gem.summary      = "A superior replacement for Win32API"
+      gem.has_rdoc     = true
+      gem.test_files   = Dir['test/test*']
+      gem.license      = 'Artistic 2.0'
+      files            = Dir["lib/win32/api.so"] + Dir["test/*"]
+      files.delete_if{ |f| f.include?('CVS') }
+      gem.files = files
+      gem.extra_rdoc_files = ['README', 'CHANGES', 'MANIFEST', 'ext/win32/api.c']
+      gem.rubyforge_project = 'win32utils'
+      gem.required_ruby_version = '>= 1.8.2'
+      
+      gem.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
+         advantages over Win32API, including callback support, raw function
+         pointers, an additional string type, and more.
+      EOF
+   end
+
+   Gem::Builder.new(spec).build
+end
+
+Rake::TestTask.new('test') do |test|
+   if RUBY_PLATFORM.match('java')
+      test.libs << 'lib/ffi'
+      test.test_files = Dir['test/test_win32_api.rb']
+   else
+      task :test => [:build]
+      test.libs << 'ext'
+      test.libs.delete('lib')
+   end
+
+   test.warning = true
+   test.verbose = true
+end
+
+task :test do
+   Rake.application[:clean].execute
+
+Rake::TestTask.new('test_jruby') do |test|
+   test.warning = true
+end