win-gdi32-ruby 0.0.1 → 0.1.3

data/README

@@ -1,3 +1,7 @@
-== WinUser32Ruby
+= WinGdi32Ruby
 
-win-user32-ruby is a Ruby wrapper for common user32.dll functions. It will provide the foundation for building a Ruby based automated GUI test suite. The goal is for the user of this library to not have to be a Win32 expert in order to script GUIs.
+== v0.1.3
+* Added OpenBitmap
+
+== v0.1.1
+* Fixed bug requiring absolute path to BitmapHelper.dll

data/Rakefile

@@ -13,7 +13,7 @@ require 'spec/rake/spectask'
 
 spec = Gem::Specification.new do |s|
   s.name = 'win-gdi32-ruby'
-  s.version = '0.0.1'
+  s.version = '0.1.3'
   s.has_rdoc = true
   s.extra_rdoc_files = ['README', 'LICENSE']
   s.summary = 'Ruby wrapper for the gdi32.dll on Windows.'
@@ -21,10 +21,14 @@ spec = Gem::Specification.new do |s|
   s.author = 'Jerry Fernholz'
   s.email = 'jerry.fernholz@gmail.com'
   # s.executables = ['your_executable_here']
-  s.files = %w(LICENSE README Rakefile) + Dir.glob("{bin,lib,spec}/**/*")
+  s.files = %w(LICENSE README Rakefile) + 
+    Dir.glob("{bin,lib,spec}/**/*").reject! { |fn| fn.include?('bmp') || fn.include?('main.rb') }
   s.require_path = "lib"
   s.bindir = "bin"
   s.add_dependency('win32-api', '>= 1.4.2')
+  s.homepage = 'http://rubyforge.org/projects/win-user32-ruby'
+  s.rubyforge_project = 'win-user32-ruby'
+  s.rdoc_options = ['-m', 'README']
 end
 
 Rake::GemPackageTask.new(spec) do |p|

data/lib/gdi32/system_const.rb

@@ -4,19 +4,19 @@
 # Constants related to the Win32 API
 
 module WinGdi32Ruby
-  SRCCOPY = 0x00CC0020 # dest = source
-  SRCPAINT = 0x00EE0086 # dest = source OR dest
-  SRCAND = 0x008800C6 # dest = source AND dest
-  SRCINVERT = 0x00660046 # dest = source XOR dest
-  SRCERASE = 0x00440328 # dest = source AND (NOT dest )
-  NOTSRCCOPY = 0x00330008 # dest = (NOT source)
-  NOTSRCERASE = 0x001100A6 # dest = (NOT src) AND (NOT dest)
-  MERGECOPY = 0x00C000CA # dest = (source AND pattern)
-  MERGEPAINT = 0x00BB0226 # dest = (NOT source) OR dest
-  PATCOPY = 0x00F00021 # dest = pattern
-  PATPAINT = 0x00FB0A09 # dest = DPSnoo
-  PATINVERT = 0x005A0049 # dest = pattern XOR dest
-  DSTINVERT = 0x00550009 # dest = (NOT dest)
-  BLACKNESS = 0x00000042 # dest = BLACK
-  WHITENESS = 0x00FF0062 # dest = WHITE
+  SRCCOPY = 0x00CC0020 #:nodoc: dest = source
+  SRCPAINT = 0x00EE0086 #:nodoc: dest = source OR dest
+  SRCAND = 0x008800C6 #:nodoc: dest = source AND dest
+  SRCINVERT = 0x00660046 #:nodoc: dest = source XOR dest
+  SRCERASE = 0x00440328 #:nodoc: dest = source AND (NOT dest )
+  NOTSRCCOPY = 0x00330008 #:nodoc: dest = (NOT source)
+  NOTSRCERASE = 0x001100A6 #:nodoc: dest = (NOT src) AND (NOT dest)
+  MERGECOPY = 0x00C000CA #:nodoc: dest = (source AND pattern)
+  MERGEPAINT = 0x00BB0226 #:nodoc: dest = (NOT source) OR dest
+  PATCOPY = 0x00F00021 #:nodoc: dest = pattern
+  PATPAINT = 0x00FB0A09 #:nodoc: dest = DPSnoo
+  PATINVERT = 0x005A0049 #:nodoc: dest = pattern XOR dest
+  DSTINVERT = 0x00550009 #:nodoc: dest = (NOT dest)
+  BLACKNESS = 0x00000042 #:nodoc: dest = BLACK
+  WHITENESS = 0x00FF0062 #:nodoc: dest = WHITE
 end

data/lib/win-gdi32-ruby.rb

@@ -1,12 +1,14 @@
 # Author:: Jerry Fernholz
 # Date:: 21 May 2009
 #
+# Parts of this library where adapted from the CapIt project posted on
+# codeproject.com by Barretto VN:
+# see http://www.codeproject.com/KB/GDI/barry_s_screen_capture.aspx for more details
+
 require 'win32/api'
 
 require 'gdi32/system_const'
 
-require 'win-user32-ruby'
-#require 'gdi32sys'
 require 'timeout'
 
 module WinGdi32Ruby
@@ -17,122 +19,172 @@ module WinGdi32Ruby
   # +name+:: Name of the Win32 function to be called
   # +param_type+:: Array of parameter type hints
   # +return_value+:: Type hint for the return value
-  # Example: <tt>user32 'FindWindow', ['P', 'P'], 'L'</tt>
-  # => calls the <i>FindWindow</i> function
+  # Example: <tt>gdi32 'CreateDC', 'SSSP', 'L'</tt>
   def gdi32(name, param_type, return_value)
     API.new name, param_type, return_value, 'gdi32'
   end
-  
+
+  def bitmap_helper(name, param_type, return_value)
+    path = File.expand_path(File.dirname(__FILE__))
+    sb = API.new name, param_type, return_value, path + '/BitmapHelper.dll'
+  end
+
   class Gdi32
-    def Gdi32.create_dc(driver = 'DISPLAY', device = '', output = '', mode = 0)
+    # Save the specified bitmap to a file
+    # +hwnd+:: Handle to the main window (used to get the system pallete)
+    # +hbitmap+:: Handle to the bitmap to save
+    # +filename+:: Filename for the bitmap
+    # *Returns*:: Void
+    def Gdi32.save_bitmap(hbitmap, filename)
+      # Used to get palette
+      hwnd = hbitmap
+
+      sb = bitmap_helper 'SaveBitmap', 'LLS', 'V'
+
+      sb.call hwnd, hbitmap, filename
+    end
+
+    # Loads a bitmap from a BMP file
+    # +filename+:: name of file to load
+    # *Returns*:: an array containing a handle to the bitmap and a handle to the palette
+    #       <tt>[hbitmap, hpalette]</tt>
+    def Gdi32.load_bitmap(filename)
+      sb = bitmap_helper 'OpenBitmap', 'SP', 'I'
+
+      # Prepare array for return values
+      bm_plt = [0, 0].pack('L*')
+      raise "Failed to load '#{filename}'" unless sb.call(filename, bm_plt )
+      hbitmap, hpalette = bm_plt.unpack('L*')
+
+      [hbitmap, hpalette]
+    end
+
+    # Captures the window as a bitmap
+    # +left+, +top+. +right+, +bottom+:: specifies the rectangle to capture
+    # *Returns*:: a bitmap handle
+    def Gdi32.capture(left, top, right, bottom)
+      # create a DC for the screen and a memory DC compatible to screen DC
+      hscr_dc = Gdi32.create_dc
+      hmem_dc = Gdi32.create_compatible_dc(hscr_dc)
+
+      width = right - left
+      height = bottom - top
+
+      # create a bitmap compatible with the screen DC
+      hbitmap = Gdi32.create_compatible_bitmap(hscr_dc, width, height)
+
+      # select new bitmap into memory DC
+      holdbitmap =   Gdi32.select_object(hmem_dc, hbitmap)
+      
+      # bitblt screen DC to memory DC
+      Gdi32.bit_blt(hscr_dc, left, top, width, height, hmem_dc)
+      
+      # select old bitmap back into memory DC and get handle to bitmap of the screen
+      hbitmap = Gdi32.select_object(hmem_dc, holdbitmap);
+
+      # clean up
+      Gdi32.delete_dc(hscr_dc);
+      Gdi32.delete_dc(hmem_dc);
+      
+      # return handle to the bitmap
+      hbitmap
+    end
+    protected
+    # The +create_dc+ function creates a device context (DC) for a device using the specified name
+    # +driver+:: Pointer to a null-terminated character string that specifies either 'DISPLAY' or the name of a specific display device or the name of a print provider, which is usually 'WINSPOOL'
+    # +device+:: Pointer to a null-terminated character string that specifies the name of the specific output device being used. The +device+ parameter must be used.
+    # +data+:: Pointer to a _DEVMODE_ structure containing device-specific initialization data for the device driver. The DocumentProperties function retrieves this structure filled in for a specified device. The data parameter must be 0 if the device driver is to use the default initialization (if any) specified by the user. If +driver+ is DISPLAY, then +data+ must be 0. The display device's current DEVMODE is used.
+    # *Returns*:: Non-zero DC handle on success
+    def Gdi32.create_dc(driver = 'DISPLAY', device = '', data = 0)
       cd = gdi32 'CreateDC', 'SSSP', 'L'
 
-      hdc = cd.call driver, device, output, mode
+      # +output+:: This parameter is ignored and should be set to ''. It is provided only for compatibility with 16-bit Windows
+      output = ''
+      hdc = cd.call driver, device, output, data
     end
 
+    # The +create_compatible_dc+ function creates a memory device context (DC) compatible with the specified device.
+    # +hdc+:: Handle to existing DC. If this +hdc+ is 0, the function creates a memory DC compatible with the application's current screen
+    # *Returns*:: Non-zero DC handle on success, zero on error
     def Gdi32.create_compatible_dc(hdc)
       ccd = gdi32 'CreateCompatibleDC', 'L', 'L'
 
       hmemdc = ccd.call hdc
     end
 
+    # Frees the specified DC
+    # +hdc+:: Handle to DC to be freed
     def Gdi32.delete_dc(hdc)
       dd = gdi32 'DeleteDC', 'L', 'I'
 
       dd.call(hdc) != 0
     end
 
+    # The +create_compatible_bitmap+ function creates a bitmap compatible with the device that is associated with the specified device context.
+    # +src_dc+:: Handle to device context
+    # +width+:: Bitmap width in pixels
+    # +height+:: Bitmap height in pixels
+    # *Returns*:: Handle to bitmap or zero on error
     def Gdi32.create_compatible_bitmap(src_dc, width, height)
       ccb = gdi32 'CreateCompatibleBitmap', 'LII', 'L'
 
       hbitmap = ccb.call src_dc, width, height
     end
 
-    def Gdi32.select_object(mem_dc, bitmap_dc)
+    # The +select_object+ function selects an object into the specified device context (+mem_dc+). The new object replaces the previous object of the same type.
+    # +mem_dc+:: Handle to the device context into which the object will be selected
+    # +obj_dc+:: Handle to object to be selected
+    # *Returns*:: If the selected object is not a region and the function succeeds, the return value is a handle to the object being replaced. If the selected object is a region and the function succeeds, the return value is one of the following values: SIMPLEREGION, COMPLEXREGION, NULLREGION. Returns zero or HGDI_ERROR on error.
+    def Gdi32.select_object(mem_dc, obj_dc)
       so = gdi32 'SelectObject', 'LL', 'L'
 
-      hobj = so.call mem_dc, bitmap_dc
+      hobj = so.call mem_dc, obj_dc
     end
 
+    # The BitBlt function performs a bit-block transfer of the color data corresponding to a rectangle of pixels from the specified source device context into a destination device context.
+    # +src_dc+:: Handle to the source DC
+    # +src_x+:: X-coordinate to the upper-left corner of the source rectangle
+    # +src_y+:: Y-coordinate to the upper-left corner of the source rectangle
+    # +width+:: Width of the source and destination rectangle
+    # +height+:: Height of the source and destination rectangle
+    # +dest_dc+:: Destination device context
+    # +dest_x+:: X-coordinate to the upper-left corner of the destination rectangle
+    # +dest_y+:: Y-coordinate to the upper-left corner of the destination rectangle
+    # +opcode+:: Specifies a raster-operation code. These codes define how the color data for the source rectangle is to be combined with the color data for the destination rectangle to achieve the final color
+    # *Returns*:: Non-zero on success, zero otherwise
     def Gdi32.bit_blt(src_dc, src_x, src_y, width, height, dest_dc, dest_x = 0, dest_y = 0, opcode = SRCCOPY)
       bb = gdi32 'BitBlt', 'LIIIILIIL', 'I'
 
       bb.call(dest_dc, dest_x, dest_y, width, height, src_dc, src_x, src_y, opcode) != 0
     end
+  end
 
-    def Gdi32.save_bitmap(hwn, hbitmap, filename)
-      #SaveBitmap(HWND hWnd, HBITMAP hBitmap, LPSTR lpstrFilename);
-      sb = API.new 'SaveBitmap', 'LLS', 'V', 'ScreenCapture'
-
-      sb.call hwn, hbitmap, filename
+  def bytewise_file_compare(fn1, fn2)
+    # Open both files as binary
+    begin
+      f1, f2 = File.open(fn1, 'rb'), File.open(fn2, 'rb')
+    rescue => e
+      puts e
+      return false
     end
-
-    # Captures the window as a bitmap
-    # +left+, +top+. +right+, +bottom+:: specifies the rectangle to capture
-    # *Returns*:: a bitmap handle
-    def Gdi32.capture(left, top, right, bottom)
-      #      // check for an empty rectangle
-      #      if (IsRectEmpty(lpRect)) return NULL;
-      #      // create a DC for the screen and create
-      #      // a memory DC compatible to screen DC
-      #
-      hScrDC = Gdi32.create_dc
-      hMemDC = Gdi32.create_compatible_dc(hScrDC)
-
-      # wrect = self.get_window_rect
-
-      nX = left
-      nY = top
-      nX2 = right
-      nY2 = bottom
-
-      #      xScrn = GetDeviceCaps(hScrDC, HORZRES);
-      #      yScrn = GetDeviceCaps(hScrDC, VERTRES);
-      #
-      #      //make sure bitmap rectangle is visible
-      #
-      #      if (nX < 0)
-      #        nX = 0;
-      #
-      #        if (nY < 0)
-      #          nY = 0;
-      #
-      #          if (nX2 > xScrn)
-      #            nX2 = xScrn;
-      #
-      #            if (nY2 > yScrn)
-      #              nY2 = yScrn;
-
-      puts nWidth = nX2 - nX;
-      puts nHeight = nY2 - nY;
-
-      #
-      #              // create a bitmap compatible with the screen DC
-      #
-      hBitmap = Gdi32.create_compatible_bitmap(hScrDC, nWidth, nHeight)
-      #
-      #              // select new bitmap into memory DC
-      #
-      hOldBitmap =   Gdi32.select_object(hMemDC, hBitmap)
-      #
-      #              // bitblt screen DC to memory DC
-      #
-      Gdi32.bit_blt(hScrDC, nX, nY, nWidth, nHeight, hMemDC)
-      #
-      #              // select old bitmap back into memory DC and get handle to
-      #              // bitmap of the screen
-      #
-      hBitmap = Gdi32.select_object(hMemDC, hOldBitmap);
-      #
-      #              // clean up
-      #
-      Gdi32.delete_dc(hScrDC);
-      Gdi32.delete_dc(hMemDC);
-      #
-      #              // return handle to the bitmap
-      #
-      hBitmap
+        
+    # Assume they don't match
+    same = false
+    i, fs1, fs2 = 0, File.stat(fn1), File.stat(fn2)
+    if fs1.size == fs2.size
+      same = true
+
+      bytes1 = []
+      f1.each_byte{|b| bytes1 << b}
+
+      f2.each_byte do |b|
+        if bytes1[i] != b
+          same = false
+        end
+        i += 1
+      end
     end
-  end
 
+    same
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: win-gdi32-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.3
 platform: ruby
 authors: 
 - Jerry Fernholz
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-19 00:00:00 -07:00
+date: 2009-06-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,18 +35,16 @@ files:
 - LICENSE
 - README
 - Rakefile
+- lib/BitmapHelper.dll
 - lib/gdi32
 - lib/gdi32/system_const.rb
-- lib/main.rb
-- lib/ScreenCapture.dll
-- lib/test.bmp
-- lib/test2.bmp
 - lib/win-gdi32-ruby.rb
 has_rdoc: true
-homepage: 
+homepage: http://rubyforge.org/projects/win-user32-ruby
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- -m
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -63,7 +61,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: win-user32-ruby
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2

data/lib/main.rb

@@ -1,26 +0,0 @@
-require 'win-gdi32-ruby'
-include WinGdi32Ruby
-
-require 'win-user32-ruby'
-include WinUser32Ruby
-
-
-wnd = Window.find_window('win-gdi32-ruby - NetBeans IDE 6.7 RC1')
-puts wnd.handle
-
-rect = wnd.get_window_rect
-hbitmap = Gdi32.capture(0,0,100,100)#*rect)
-Gdi32.save_bitmap(wnd.handle, hbitmap, 'test2.bmp')
-
-f1 = File.open('test.bmp', 'rb')
-f2 = File.open('test2.bmp', 'rb')
-
-i, l2 = 0, f2.readlines
-f1.readline.each do |l|
- if l2[i] == l
-   puts 'Same' 
- else
-   puts 'Diff'
- end
- i += 1
-end