windows-api 0.2.2 → 0.2.3

data/CHANGES

@@ -1,3 +1,7 @@
+= 0.2.3 - 26-Apr-2008
+* Improved API.auto_constant and API.auto_method handling for functions that
+  start with a lower case character or an underscore.
+
 = 0.2.2 - 17-Apr-2008
 * Added the Windows::MSVCRT_DLL constant so that users can specify MSVCRT_DLL
   for the DLL name and it will do the right thing, instead of having to worry

data/README

@@ -33,6 +33,10 @@
    module Windows
       module Foo
          API.auto_namespace = 'Windows::Foo'
+         API.auto_constant  = true
+         API.auto_method    = true
+         API.auto_unicode   = true
+         
          API.new('GetComputerName', 'PP', 'B')
       end
    end
@@ -41,7 +45,7 @@
    module Windows
       module Foo
          GetComputerName  = Win32API.new('kernel32', 'GetComputerName', 'PP', 'I')
-         GetComputerNameA = Win32API.new('kernel32', GetComputerNameA', 'PP', 'I')
+         GetComputerNameA = Win32API.new('kernel32', 'GetComputerNameA', 'PP', 'I')
          GetComputerNameW = Win32API.new('kernel32', 'GetComputerNameW', 'PP', 'I')
 
          def GetComputerName(p1, p2)
@@ -62,9 +66,8 @@
    * Automatic constant generation.
    * Automatic definition of ANSI and Unicode method wrappers, including
      special handling for boolean methods.
-   * Most arguments to the constructor are optional, with sensible defaults.
-   * Four attributes added to API objects - dll_name, function_name, prototype
-     and return_type.
+   * Ability to use more familiar Windows data types, e.g. DWORD.
+   * Automatic handling of msvcrt vs msvcrXX via MSVCRT_DLL constant.
 
 = More documentation
    See the RDoc documentation, which should have been automatically generated

data/lib/windows/api.rb

@@ -18,7 +18,7 @@ module Windows
    end
 
    class API
-      VERSION = '0.2.2'
+      VERSION = '0.2.3'
       
       class Error < RuntimeError; end
       
@@ -354,9 +354,12 @@ module Windows
             rescue RuntimeError
             end
          end
-         
+
+         func_upper = nil
+
          # Automatically define a constant matching the function name if the
-         # auto_constant option is set.
+         # auto_constant option is set. Lower case method names will have a
+         # capitalized equivalent created, e.g. Memcpy for memcpy, etc.
          # 
          if Windows::API.auto_constant && Windows::API.auto_namespace
             if Windows::API.auto_namespace != 'Windows'
@@ -364,8 +367,18 @@ module Windows
             else
                namespace = Windows::API.auto_namespace
             end
-            
-            namespace.const_set(func, @api)
+
+            # Convert e.g. 'strstr' to 'Strstr' as an equivalent constant
+            if ('A'..'Z').include?(func[0].chr)
+               namespace.const_set(func, @api)
+            else
+               func_upper = func.dup
+               if func_upper[0].chr == '_'
+                  func_upper = func_upper[1, func_upper.length]
+               end
+               func_upper[0, 1] = func_upper[0].chr.capitalize
+               namespace.const_set(func_upper, @api)
+            end
             
             # Automatically define the explicit ANSI and Unicode functions
             # as constants as well, if appropriate.
@@ -398,18 +411,24 @@ module Windows
                end
             end
 
+            # Use the upper case function equivalent if defined
+            call_func = func_upper || func
+
+            # Remove leading underscores from msvcrt functions
+            func = func[1, func.length] if func[0].chr == '_'
+
             if @boolean
                string = <<-EOC
                   module #{Windows::API.auto_namespace} 
                      def #{func}(#{proto})
-                        #{func}.call(#{proto}) != 0
+                        #{call_func}.call(#{proto}) != 0
                      end
                   EOC
                   
                if api_a
                   string << %Q{
                      def #{func}A(#{proto})
-                        #{func}A.call(#{proto}) != 0
+                        #{call_func}A.call(#{proto}) != 0
                      end
                   }
                end
@@ -417,7 +436,7 @@ module Windows
                if api_w
                   string << %Q{
                      def #{func}W(#{proto})
-                        #{func}W.call(#{proto}) != 0
+                        #{call_func}W.call(#{proto}) != 0
                      end
                   }
                end
@@ -425,16 +444,16 @@ module Windows
                string << 'end'
             else
                string = <<-EOC
-                  module #{Windows::API.auto_namespace} 
+                  module #{Windows::API.auto_namespace}
                      def #{func}(#{proto})
-                        #{func}.call(#{proto})
+                        #{call_func}.call(#{proto})
                      end
                   EOC
-                  
+
                if api_a
                   string << %Q{
                      def #{func}A(#{proto})
-                        #{func}A.call(#{proto})
+                        #{call_func}A.call(#{proto})
                      end
                   }
                end
@@ -442,7 +461,7 @@ module Windows
                if api_w
                   string << %Q{
                      def #{func}W(#{proto})
-                        #{func}W.call(#{proto})
+                        #{call_func}W.call(#{proto})
                      end
                   }
                end

data/test/tc_windows_api.rb

@@ -31,19 +31,31 @@ module Windows
       API.auto_method   = true
       $bar_method = API.new('GetUserName', 'PP', 'I', 'advapi32')
    end
+
+   module Baz
+      API.auto_namespace = 'Windows::Baz'
+      API.auto_constant  = true
+      API.auto_method    = true
+      API.auto_unicode   = false
+
+      API.new('strstr', 'PP', 'P', 'msvcrt')
+      API.new('_umask', 'I', 'I', 'msvcrt')
+      API.new('waveOutGetNumDevs', 'V', 'I', 'winmm')
+   end
 end
 
 class TC_Windows_API < Test::Unit::TestCase
    include Windows::Test
    include Windows::Foo
    include Windows::Bar
+   include Windows::Baz
 
    def setup
       @buf = 0.chr * 256
    end
 
    def test_version
-      assert_equal('0.2.2', API::VERSION)
+      assert_equal('0.2.3', API::VERSION)
    end
    
    def test_full_data_types
@@ -53,7 +65,21 @@ class TC_Windows_API < Test::Unit::TestCase
    end
    
    def test_msvcrt_constant
-      assert_equal(true, ['msvcrt', 'msvcr80'].include?(Windows::MSVCRT))
+      assert_equal(true, ['msvcrt', 'msvcr80'].include?(Windows::MSVCRT_DLL))
+   end
+
+   # Validate that functions like 'strstr' get an uppercase constant like 'Strstr'
+   def test_lower_case_to_capitalized_constant
+      assert_not_nil(Windows::Baz::Strstr)
+      assert_not_nil(Windows::Baz::Umask)
+      assert_not_nil(Windows::Baz::WaveOutGetNumDevs)
+   end
+
+   def test_lower_case_auto_methods
+      assert_respond_to(self, :strstr)
+      assert_respond_to(self, :umask)
+      assert_respond_to(self, :waveOutGetNumDevs)
+      assert_equal('llo', strstr('hello', 'l'))
    end
 
    def test_auto_unicode

data/windows-api.gemspec

@@ -2,7 +2,7 @@ require "rubygems"
 
 spec = Gem::Specification.new do |gem|
    gem.name        = "windows-api"
-   gem.version     = "0.2.2"
+   gem.version     = "0.2.3"
    gem.author      = "Daniel J. Berger"
    gem.email       = "djberg96@gmail.com"
    gem.homepage    = "http://www.rubyforge.org/projects/win32utils"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: windows-api
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Daniel J. Berger
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-04-17 00:00:00 -06:00
+date: 2008-04-26 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency