windows-api 0.2.4 → 0.3.0

data/CHANGES

@@ -1,3 +1,9 @@
+= 0.3.0 - 1-Feb-2009
+* No longer explicitly checks for an error in the constructor. It lets the
+  underlying Win32::API library deal with it.
+* More dynamic handling and setting of the MSVCRT_DLL variable.
+* Added a WideString implementation. Internal use only.
+
 = 0.2.4 - 18-Jul-2008
 * Eliminated unnecessary LoadLibrary() attempts for functions that explicitly
   end with an 'A' or 'W', and all MSVCRT functions, since they have no 'A'

data/MANIFEST

@@ -4,4 +4,5 @@
 * Rakefile
 * windows-api.gemspec
 * lib/windows/api.rb
+* lib/windows/wide_string.rb
 * test/test_windows_api.rb

data/lib/windows/api.rb

@@ -12,7 +12,7 @@ module Windows
       if CONFIG['host_os'].split('_')[1].to_i >= 80 &&
          File.exists?(File.join(CONFIG['bindir'], 'ruby.exe.manifest'))
       then
-         MSVCRT_DLL = 'msvcr80'
+         MSVCRT_DLL = 'msvcr' + CONFIG['host_os'].split('_')[1]
       else
          MSVCRT_DLL = 'msvcrt'
       end
@@ -25,11 +25,8 @@ module Windows
       extend Forwardable
 
       # The version of this library
-      VERSION = '0.2.4'
+      VERSION = '0.3.0'
       
-      # Error typically raised if any of the Windows::API methods fail
-      class Error < RuntimeError; end
-
       # The methods from Win32::API are delegated to the appropriate object
       def_delegators(:@api, :function_name, :dll_name, :prototype)
       def_delegators(:@api, :return_type, :effective_function_name)
@@ -288,7 +285,6 @@ module Windows
          @auto_unicode = bool
       end
 
-
       # call-seq:
       #    API.new(func, proto='V', rtype='L', dll='kernel32')
       # 
@@ -334,11 +330,7 @@ module Windows
          @dll_name      = dll
          @boolean       = rtype == 'B' ? true : false         
          
-         begin
-            @api = Win32::API.new(func, proto, rtype, dll)
-         rescue RuntimeError => err
-            raise Error, err
-         end
+         @api = Win32::API.new(func, proto, rtype, dll)
          
          api_a = nil
          api_w = nil
@@ -352,7 +344,7 @@ module Windows
          # msvcrt functions never have explicit ANSI or Wide character
          # versions.
          # 
-         if Windows::API.auto_unicode && dll.downcase != 'msvcrt'
+         if Windows::API.auto_unicode && dll !~ /msvcr/i
             begin
                unless ['A', 'W'].include?(func[-1].chr)
                   api_a = Win32::API.new("#{func}A", proto, rtype, dll)

data/lib/windows/wide_string.rb

@@ -0,0 +1,60 @@
+require 'windows/unicode'
+require 'windows/msvcrt/string'
+
+# This is a class that simplifies wide string handling. It is NOT meant
+# for general consumption, but for internal use by the Win32Utils Team.
+# Use at your own risk.
+# 
+class WideString < String
+   include Windows::Unicode
+   include Windows::MSVCRT::String
+   
+   ACP  = CP_ACP
+   UTF7 = CP_UTF7
+   UTF8 = CP_UTF8
+   
+   # Get or set the encoding of the wide string object
+   #
+   attr_accessor :encoding
+   
+   # Creates a new wide +string+ with the given +encoding+, or UTF8 if
+   # no encoding is specified.
+   #
+   def initialize(string, encoding = UTF8)
+      super(multi_to_wide(string, encoding))
+      @encoding = encoding
+   end
+   
+   # Returns the multibyte version of the wide string.
+   #
+   def to_multi
+      wide_to_multi(self, @encoding)      
+   end
+
+   # Replaces the wide string with a multibyte version.
+   #   
+   def to_multi!
+      self.replace(wide_to_multi(self, @encoding))  
+   end
+   
+   alias to_s to_multi
+   alias to_str to_multi
+   alias inspect to_multi
+   
+   # Strips the trailing two null characters from the string.
+   #
+   def wstrip
+      self[0..-3] if string[-2..-1] == "\000\000"
+   end
+   
+   # The length of the wide string in chars.
+   #
+   def length
+      wcslen(self) * 2      
+   end
+   
+   # The size of the wide string in bytes.
+   def size
+      wcslen(self)      
+   end   
+end

data/test/test_wide_string.rb

@@ -0,0 +1,53 @@
+require 'rubygems'
+gem 'test-unit'
+
+require 'test/unit'
+require 'windows/wide_string'
+
+class TC_WideString < Test::Unit::TestCase
+   def setup
+      @str_english = WideString.new('hello')
+      @str_greek   = WideString.new('Ελλάσ')      
+   end
+   
+   def test_length
+      assert_equal(10, @str_english.length)
+      assert_equal(10, @str_greek.length)
+   end
+   
+   def test_size
+      assert_equal(5, @str_english.size)
+      assert_equal(5, @str_greek.size)
+   end
+   
+   def test_to_multi
+      assert_respond_to(@str_english, :to_multi)
+      assert_equal('hello', @str_english.to_multi)  
+      assert_equal('Ελλάσ', @str_greek.to_multi)    
+   end
+   
+   def test_literal_string_value
+      assert_equal("h\000e\000l\000l\000o\000\000\000", @str_english)
+      assert_equal("\225\003\273\003\273\003\254\003\303\003\000\000", @str_greek)      
+   end
+   
+   def test_alias_to_s
+      assert_respond_to(@str_greek, :to_s)
+      assert_true(@str_greek.method(:to_s) == @str_greek.method(:to_multi))
+   end
+   
+   def test_alias_to_str
+      assert_respond_to(@str_greek, :to_str)
+      assert_true(@str_greek.method(:to_str) == @str_greek.method(:to_multi))
+   end
+   
+   def test_alias_inspect
+      assert_respond_to(@str_greek, :inspect)
+      assert_true(@str_greek.method(:inspect) == @str_greek.method(:to_multi))
+   end
+   
+   def teardown
+      @str_english = nil
+      @str_greek   = nil      
+   end   
+end

data/test/test_windows_api.rb

@@ -55,7 +55,7 @@ class TC_Windows_API < Test::Unit::TestCase
    end
 
    def test_version
-      assert_equal('0.2.4', API::VERSION)
+      assert_equal('0.3.0', API::VERSION)
    end
    
    def test_full_data_types
@@ -148,6 +148,15 @@ class TC_Windows_API < Test::Unit::TestCase
       assert_equal('ReadDirectoryChangesW', $read.effective_function_name)
    end
    
+   def test_bad_prototype_raises_error
+      assert_raise(Win32::API::PrototypeError){ Windows::API.new('GetCurrentDirectory', 'XL', 'L') }
+      assert_raise(Win32::API::PrototypeError){ Windows::API.new('GetCurrentDirectory', 'PL', 'X') }
+   end
+
+   def test_bad_function_raises_error
+      assert_raise(Win32::API::LoadLibraryError){ Windows::API.new('GetCurrentFooBar', 'LL', 'L') }
+   end
+   
    def teardown
       @buf = nil
    end

data/windows-api.gemspec

@@ -2,7 +2,7 @@ require "rubygems"
 
 spec = Gem::Specification.new do |gem|
    gem.name        = "windows-api"
-   gem.version     = "0.2.4"
+   gem.version     = "0.3.0"
    gem.author      = "Daniel J. Berger"
    gem.email       = "djberg96@gmail.com"
    gem.homepage    = "http://www.rubyforge.org/projects/win32utils"
@@ -16,10 +16,9 @@ spec = Gem::Specification.new do |gem|
    gem.files.reject! { |fn| fn.include? "CVS" }
    gem.require_path = "lib"
    gem.extra_rdoc_files = ["README", "CHANGES", "MANIFEST"]
-   gem.add_dependency("win32-api", ">= 1.0.5")
+   gem.add_dependency("win32-api", ">= 1.3.0")
 end
 
 if $0 == __FILE__
-   Gem.manage_gems
    Gem::Builder.new(spec).build
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: windows-api
 version: !ruby/object:Gem::Version 
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-19 00:00:00 -06:00
+date: 2009-02-01 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.5
+        version: 1.3.0
     version: 
 description: An easier way to create methods using Win32API
 email: djberg96@gmail.com
@@ -34,19 +34,20 @@ extra_rdoc_files:
 - MANIFEST
 files: 
 - lib/windows/api.rb
-- test/CVS
+- lib/windows/wide_string.rb
+- test/test_wide_string.rb
 - test/test_windows_api.rb
 - CHANGES
-- CVS
 - lib
 - MANIFEST
 - Rakefile
 - README
 - test
 - windows-api.gemspec
-- windows-api.gemspec~
 has_rdoc: true
 homepage: http://www.rubyforge.org/projects/win32utils
+licenses: []
+
 post_install_message: 
 rdoc_options: []
 
@@ -67,9 +68,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: win32utils
-rubygems_version: 1.2.0
+rubygems_version: 1.3.1
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: An easier way to create methods using Win32API
 test_files: 
 - test/test_windows_api.rb

data/windows-api.gemspec~

@@ -1,25 +0,0 @@
-require "rubygems"
-
-spec = Gem::Specification.new do |gem|
-   gem.name        = "windows-api"
-   gem.version     = "0.2.4"
-   gem.author      = "Daniel J. Berger"
-   gem.email       = "djberg96@gmail.com"
-   gem.homepage    = "http://www.rubyforge.org/projects/win32utils"
-   gem.rubyforge_project = "win32utils"
-   gem.platform    = Gem::Platform::RUBY
-   gem.summary     = "An easier way to create methods using Win32API"
-   gem.description = "An easier way to create methods using Win32API"
-   gem.test_file   = "test/tc_windows_api.rb"
-   gem.has_rdoc    = true
-   gem.files       = Dir["lib/windows/*.rb"] + Dir["test/*"] + Dir["[A-Z]*"]
-   gem.files.reject! { |fn| fn.include? "CVS" }
-   gem.require_path = "lib"
-   gem.extra_rdoc_files = ["README", "CHANGES", "MANIFEST"]
-   gem.add_dependency("win32-api", ">= 1.0.5")
-end
-
-if $0 == __FILE__
-   Gem.manage_gems
-   Gem::Builder.new(spec).build
-end