win32-api 1.5.0-universal-mingw32

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 43f49890c4c1c03565dcebe7e0b9a1633e299d7c
+  data.tar.gz: 1fb103cb311aca0cca09355fa689b9343b1a44ce
+SHA512:
+  metadata.gz: 6d185f01c4f9f1e553acbace429ebe58e610c1209d90d8db1f6c92e4471f821ca05ce5652f6767210968edee583d84f67865d3402ea6c048f3591b35178fae67
+  data.tar.gz: 4de7942471cd2360ce77eeb925830d8aa7e274b46bae4efc5166bac8dabdc542da61acde4e7dd60f42ba69256471cfb160120ded5131b8f200b5ea1cda74825e

data/CHANGES

@@ -0,0 +1,154 @@
+== 1.5.0 - 22-Aug-2013
+* Fixes for Ruby x64.
+* There are now separate 32 and 64 bit binaries packaged for Ruby 2.x.
+* Updates to the Rakefile for the gem:binary task.
+* Some README updates, including Future Plans.
+
+== 1.4.9 - 14-Jul-2013
+* Added a binary for Ruby 2.0.
+* Add devkit to Rakefile for the gem:binary task.
+
+== 1.4.8 - 16-Jan-2011
+* A binary for both 1.8.x and 1.9.x is now shipped as part of the binary
+  build. A stub file is used to dynamically require the correct binary based
+  on your current version of Ruby.
+* Some updates to the Rakefile to help build multiple binaries.
+
+== 1.4.7 - 4-Dec-2010
+* An internal error formatting function now resorts to the default
+  LANGID on error 1815 (ERROR_RESOURCE_LANG_NOT_FOUND). Thanks go to
+  Little Snake for the spot.
+* Added a default Rake task and refactored the clean task.
+
+== 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,121 @@
+= 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.
+
+= Multiple Binaries
+  As of win32-api 1.4.8 a binary gem is shipped that contains binaries for
+  both Ruby 1.8, Ruby 1.9, and 2.x. For Ruby 2.x, both 32 and 64 bit binaries
+  are included as of release 1.5.0.
+
+  The file under lib/win32 dynamically requires the correct binary based on
+  your version of Ruby.
+
+= 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
+  https://github.com/djberg96/win32-api
+
+== Contributions
+  Although this library is free, please consider having your company
+  setup a gittip if used by your company professionally.
+
+  http://www.gittip.com/djberg96/
+
+= Future Plans
+  I really don't have future plans for this library since I believe FFI to
+  be the preferred C interface going forward. This library will still be
+  maintained, at least until all of the win32utils libraries have been
+  converted to use either FFI or an OLE approach.
+
+= Copyright
+  (C) 2003-2013 Daniel J. Berger
+  All Rights Reserved
+
+= License
+  Artistic 2.0
+
+= Authors
+  Daniel J. Berger
+  Park Heesob

data/Rakefile

@@ -0,0 +1,168 @@
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rbconfig'
+include RbConfig
+
+CLEAN.include(
+  '**/*.gem',               # Gem files
+  '**/*.rbc',               # Rubinius
+  '**/*.o',                 # C object file
+  '**/*.log',               # Ruby extension build log
+  '**/Makefile',            # C Makefile
+  '**/*.def',               # Definition files
+  '**/*.exp',
+  '**/*.lib',
+  '**/*.pdb',
+  '**/*.obj',
+  '**/*.stackdump',         # Junk that can happen on Windows
+  "**/*.#{CONFIG['DLEXT']}" # C shared object
+)
+
+CLOBBER.include('lib') # Generated when building binaries
+
+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 "Build the win32-api library"
+task :build => [:clean, :build_manifest] do
+  require 'devkit'
+  Dir.chdir('ext') do
+    ruby "extconf.rb"
+    sh make
+    cp 'api.so', 'win32' # For testing
+  end
+end
+
+namespace 'gem' do
+  require 'rubygems/package'
+
+  desc 'Build the win32-api gem'
+  task :create => [:clean] do
+    spec = eval(IO.read('win32-api.gemspec'))
+    if Gem::VERSION.to_f < 2.0
+      Gem::Builder.new(spec).build
+    else
+      Gem::Package.build(spec)
+    end
+  end
+
+  desc 'Build a binary gem'
+  task :binary, :ruby18, :ruby19, :ruby2_32, :ruby2_64 do |task, args|
+    require 'devkit'
+
+    # These are just what's on my system at the moment. Adjust as needed.
+    args.with_defaults(
+      :ruby18   => "c:/ruby187/bin/ruby",
+      :ruby19   => "c:/ruby/bin/ruby",
+      :ruby2_32 => "c:/ruby2/bin/ruby",
+      :ruby2_64 => "c:/ruby200-x64/bin/ruby"
+    )
+
+    Rake::Task[:clobber].invoke
+
+    mkdir_p 'lib/win32/ruby18/win32'
+    mkdir_p 'lib/win32/ruby19/win32'
+    mkdir_p 'lib/win32/ruby2_32/win32'
+    mkdir_p 'lib/win32/ruby2_64/win32'
+
+    args.each{ |key, rubyx|
+      # Adjust devkit paths as needed.
+      if `"#{rubyx}" -v` =~ /x64/i
+        ENV['PATH'] = "C:/Devkit64/bin;C:/Devkit64/mingw/bin;" + ENV['PATH']
+      else
+        ENV['PATH'] = "C:/Devkit/bin;C:/Devkit/mingw/bin;" + ENV['PATH']
+      end
+
+      Dir.chdir('ext') do
+        sh "make distclean" rescue nil
+        sh "#{rubyx} extconf.rb"
+        sh "make"
+
+        if key.to_s == 'ruby18'
+          cp 'api.so', '../lib/win32/ruby18/win32/api.so'
+        elsif key.to_s == 'ruby19'
+          cp 'api.so', '../lib/win32/ruby19/win32/api.so'
+        else
+          if `"#{rubyx}" -v` =~ /x64/i
+            cp 'api.so', '../lib/win32/ruby2_64/win32/api.so'
+          else
+            cp 'api.so', '../lib/win32/ruby2_32/win32/api.so'
+          end
+        end
+      end
+    }
+
+    # Create a stub file that automatically require's the correct binary
+    File.open('lib/win32/api.rb', 'w'){ |fh|
+      fh.puts "if RUBY_VERSION.to_f < 1.9"
+      fh.puts "  require File.join(File.dirname(__FILE__), 'ruby18/win32/api')"
+      fh.puts "elsif RUBY_VERSION.to_f < 2.0"
+      fh.puts "  require File.join(File.dirname(__FILE__), 'ruby19/win32/api')"
+      fh.puts "else"
+      fh.puts "  require 'rbconfig'"
+      fh.puts "  if RbConfig::CONFIG['arch'] =~ /x64/i"
+      fh.puts "    require File.join(File.dirname(__FILE__), 'ruby2_64/win32/api')"
+      fh.puts "  else"
+      fh.puts "    require File.join(File.dirname(__FILE__), 'ruby2_32/win32/api')"
+      fh.puts "  end"
+      fh.puts "end"
+    }
+
+    spec = eval(IO.read('win32-api.gemspec'))
+    spec.platform = Gem::Platform.new(['universal', 'mingw32'])
+    spec.extensions = nil
+    spec.files = spec.files.reject{ |f| f.include?('ext') }
+
+    if Gem::VERSION.to_f < 2.0
+      Gem::Builder.new(spec).build
+    else
+      Gem::Package.build(spec)
+    end
+  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
+
+task :default => 'test:all'