win32screenshot 0.0.4 → 0.0.5

data/.gitignore

@@ -2,5 +2,4 @@ coverage
 rdoc
 pkg
 .idea
-*.bmp
-*.png
+spec/tmp

data/History.rdoc

@@ -1,3 +1,17 @@
+= 0.0.5 2010-07-07
+* Added method window_area for capturing specified area of the window instead of full window (Jarmo Pertman)
+  Usage: Win32::Screenshot.window_area(title, x1, y1, x2, y2) {|width, height, bmp|}
+* Added method foreground_area for capturing area of the foreground (Jarmo Pertman)
+  Usage: Win32::Screenshot.foreground_area(x1, y1, x2, y2) {|width, height, bmp|}
+* Added method desktop_area for capturing area of the visible view (Jarmo Pertman)
+  Usage: Win32::Screenshot.desktop_area(x1, y1, x2, y2) {|width, height, bmp|}
+* Added method hwnd_area for capturing area of the window with specified handle (Jarmo Pertman)
+  Usage: Win32::Screenshot.hwnd_area(hwnd, x1, y1, x2, y2) {|width, height, bmp|}
+
+== Internal changes
+* Removed usage of ShowWindow with parameter SW_SHOW when trying to bring window to front due it's behaviour of resizing window if it was maximized (Jarmo Pertman)
+* Using FFI::Struct when searching window handle (Roger Pack)
+
 = 0.0.4 2010-05-27 - A Complete Overhaul
 * Fixed a bug where taking of screenshots failed on some sizes of windows (thanks for the tip from Tony Popiel)
 * Blocks should be used when taking screenshots for cleaning up resources after usage (Aslak Hellesøy)

data/README.rdoc

@@ -16,25 +16,50 @@ other formats like png.
   Win32::Screenshot.foreground do |width, height, bmp|
     File.open("picture1.bmp", "wb") {|file| file.puts bmp}
   end
-  
+
+  # take a screenshot of the area of the foreground where upper left x and y
+  # coordinates are 0 and 10, width is 100 and height is 200
+  Win32::Screenshot.foreground_area(0, 10, 100, 200) do |width, height, bmp|
+    File.open("picture2.bmp", "wb") {|file| file.puts bmp}
+  end
+
   # take a screenshot of the screen
   Win32::Screenshot.desktop do |width, height, bmp|
-    File.open("picture2.bmp", "wb") {|file| file.puts bmp}
+    File.open("picture3.bmp", "wb") {|file| file.puts bmp}
+  end
+
+  # take a screenshot of the area of the desktop where upper left x and y
+  # coordinates are 0 and 10, width is 100 and height is 200
+  Win32::Screenshot.desktop_area(0, 10, 100, 200) do |width, height, bmp|
+    File.open("picture4.bmp", "wb") {|file| file.puts bmp}
   end
   
   # take a screenshot of the window, which has a text part of it's title
   Win32::Screenshot.window("Internet Explorer") do |width, height, bmp|
-    File.open("picture3.bmp", "wb") {|file| file.puts bmp}
+    File.open("picture5.bmp", "wb") {|file| file.puts bmp}
   end
   
   # take a screenshot of the window, which matches regexp against it's title
   Win32::Screenshot.window(/Internet Explorer/) do |width, height, bmp|
-    File.open("picture4.bmp", "wb") {|file| file.puts bmp}
+    File.open("picture6.bmp", "wb") {|file| file.puts bmp}
+  end
+
+  # take a screenshot of the area of the window where upper left x and y
+  # coordinates are 0 and 10, width is 100 and height is 200
+  Win32::Screenshot.window_area("Internet Explorer", 0, 10, 100, 200) do |width, height, bmp|
+    File.open("picture7.bmp", "wb") {|file| file.puts bmp}
   end
   
   # take a screenshot of the window with specified window handle
   Win32::Screenshot.hwnd(window_handle) do |width, height, bmp|
-    File.open("picture5.bmp", "wb") {|file| file.puts bmp}
+    File.open("picture8.bmp", "wb") {|file| file.puts bmp}
+  end
+
+  # take a screenshot of the area of the window with a window handle
+  # where upper left x and y
+  # coordinates are 0 and 10, width is 100 and height is 200
+  Win32::Screenshot.hwnd_area(window_handle, 0, 10, 100, 200) do |width, height, bmp|
+    File.open("picture9.bmp", "wb") {|file| file.puts bmp}
   end
 
   # convert a screenshot to the png format with RMagick
@@ -43,7 +68,7 @@ other formats like png.
   Win32::Screenshot.hwnd(window_handle) do |width, height, bmp|
     img = Magick::Image.from_blob(bmp)
     png = img[0].to_blob {self.format = 'PNG'}
-    File.open("picture6.png", "wb") {|file| file.puts png}
+    File.open("picture10.png", "wb") {|file| file.puts png}
   end
 
 == Copyright

data/Rakefile

@@ -2,6 +2,7 @@
 
 require 'rubygems'
 require 'rake'
+require 'os'
 
 begin
   require 'jeweler'
@@ -18,7 +19,12 @@ begin
     gem.add_dependency "ffi"
 
     gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_development_dependency "rmagick"
+    gem.add_development_dependency 'os'
+    if OS.java?
+      gem.add_development_dependency "rmagick4j"
+    else
+      gem.add_development_dependency "rmagick"
+    end
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -50,3 +56,8 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+desc "Remove all temporary files"
+task :clobber => [:clobber_rdoc, :clobber_rcov] do
+  rm_r "spec/tmp"
+end

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/lib/win32/screenshot.rb

@@ -8,27 +8,87 @@ module Win32
       # captures foreground
       def foreground(&proc)
         hwnd = BitmapMaker.foreground_window
-        BitmapMaker.capture(hwnd, &proc)
+        BitmapMaker.capture_all(hwnd, &proc)
       end
 
-      # captures desktop
+      # captures area of the foreground
+      # where *x1* and *y1* are 0 in the upper left corner and
+      # *x2* specifies the width and *y2* the height of the area to be captured
+      def foreground_area(x1, y1, x2, y2, &proc)
+        hwnd = BitmapMaker.foreground_window
+        validate_coordinates(hwnd, x1, y1, x2, y2)
+        BitmapMaker.capture_area(hwnd, x1, y1, x2, y2, &proc)
+      end
+
+      # captures visible view of the screen
+      #
+      # to make screenshot of the real desktop, all
+      # windows must be minimized before
       def desktop(&proc)
         hwnd = BitmapMaker.desktop_window
-        BitmapMaker.capture(hwnd, &proc)
+        BitmapMaker.capture_all(hwnd, &proc)
+      end
+
+      # captures area of the visible view of the screen
+      # where *x1* and *y1* are 0 in the upper left corner and
+      # *x2* specifies the width and *y2* the height of the area to be captured
+      #
+      # to make screenshot of the real desktop, all
+      # windows must be minimized before
+      def desktop_area(x1, y1, x2, y2, &proc)
+        hwnd = BitmapMaker.desktop_window
+        validate_coordinates(hwnd, x1, y1, x2, y2)
+        BitmapMaker.capture_area(hwnd, x1, y1, x2, y2, &proc)
       end
 
       # captures window with a *title_query* and waits *pause* (by default is 0.5)
       # seconds after trying to set window to the foreground
       def window(title_query, pause=0.5, &proc)
-        hwnd = BitmapMaker.hwnd(title_query)
-        raise "window with title '#{title_query}' was not found!" unless hwnd
+        hwnd = window_hwnd(title_query)
         hwnd(hwnd, pause, &proc)
       end
 
+      # captures area of the window with a *title_query*
+      # where *x1* and *y1* are 0 in the upper left corner and
+      # *x2* specifies the width and *y2* the height of the area to be captured
+      def window_area(title_query, x1, y1, x2, y2, pause=0.5, &proc)
+        hwnd = window_hwnd(title_query)
+        hwnd_area(hwnd, x1, y1, x2, y2, pause, &proc)
+      end
+
       # captures by window handle
       def hwnd(hwnd, pause=0.5, &proc)
         BitmapMaker.prepare_window(hwnd, pause)
-        BitmapMaker.capture(hwnd, &proc)
+        BitmapMaker.capture_all(hwnd, &proc)
+      end
+
+      # captures area of the window with a handle of *hwnd*
+      # where *x1* and *y1* are 0 in the upper left corner and
+      # *x2* specifies the width and *y2* the height of the area to be captured
+      def hwnd_area(hwnd, x1, y1, x2, y2, pause=0.5, &proc)
+        validate_coordinates(hwnd, x1, y1, x2, y2)
+        BitmapMaker.prepare_window(hwnd, pause)
+        BitmapMaker.capture_area(hwnd, x1, y1, x2, y2, &proc)
+      end
+
+      private
+
+      def window_hwnd(title_query)
+        hwnd = BitmapMaker.hwnd(title_query)
+        raise "window with title '#{title_query}' was not found!" unless hwnd
+        hwnd
+      end
+
+      def validate_coordinates(hwnd, *coords)
+        specified_coordinates = coords.join(', ')
+        invalid = coords.any? {|c| c < 0}
+
+        x1, y1, x2, y2 = *coords
+        invalid ||= x1 >= x2 || y1 >= y2
+
+        max_x1, max_y1, max_x2, max_y2 = BitmapMaker.dimensions_for(hwnd)
+        invalid ||= x2 > max_x2 || y2 > max_y2
+        raise "specified coordinates (#{specified_coordinates}) are invalid!" if invalid
       end
     end
 

data/lib/win32/screenshot/bitmap_maker.rb

@@ -63,13 +63,15 @@ module Win32
       attach_function :release_dc, :ReleaseDC,
                       [:long, :long], :int
 
+
       EnumWindowCallback = Proc.new do |hwnd, param|
+        searched_window = WindowStruct.new param
         title_length = window_text_length(hwnd) + 1
         title = FFI::MemoryPointer.new :char, title_length
         window_text(hwnd, title, title_length)
         title = title.read_string
-        if title =~ Regexp.new(param.read_string) && window_visible(hwnd)
-          param.write_long hwnd
+        if title =~ Regexp.new(searched_window[:title].read_string) && window_visible(hwnd)
+          searched_window[:hwnd] = hwnd
           false
         else
           true
@@ -78,24 +80,22 @@ module Win32
 
       module_function
 
-      def hwnd(window_title)
-        window_title = window_title.to_s
-        window_params = FFI::MemoryPointer.from_string(window_title)
-        enum_windows(EnumWindowCallback, window_params)
-        if window_title != window_params.read_string
-          # hwnd found
-          window_params.read_long
-        else
-          nil
-        end
+      class WindowStruct < FFI::Struct
+        layout :title, :pointer,
+               :hwnd, :long
       end
 
-      SW_SHOW = 5
+      def hwnd(window_title)
+        window = WindowStruct.new
+        window_title = FFI::MemoryPointer.from_string(window_title.to_s)
+        window[:title] = window_title
+        enum_windows(EnumWindowCallback, window.to_ptr)
+        window[:hwnd] == 0 ? nil : window[:hwnd] 
+      end
 
       def prepare_window(hwnd, pause)
         restore(hwnd) if minimized(hwnd)
         set_foreground(hwnd)
-        show_window(hwnd, SW_SHOW)
         sleep pause
       end
 
@@ -122,16 +122,16 @@ module Win32
         x1, y1, x2, y2 = rect.unpack('L4')
       end
 
-      def capture(hwnd, &proc)
-        hScreenDC = dc(hwnd)
+      def capture_all(hwnd, &proc)
         x1, y1, x2, y2 = dimensions_for(hwnd)
-        __capture(hScreenDC, x1, y1, x2, y2, &proc)
+        capture_area(hwnd, x1, y1, x2, y2, &proc)
       end
 
       SRCCOPY = 0x00CC0020
       DIB_RGB_COLORS = 0
 
-      def __capture(hScreenDC, x1, y1, x2, y2, &proc)
+      def capture_area(hwnd, x1, y1, x2, y2, &proc)
+        hScreenDC = dc(hwnd)
         w = x2-x1
         h = y2-y1
 

data/spec/spec_helper.rb

@@ -1,9 +1,11 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'win32/screenshot'
+require 'rubygems'
 require 'spec'
 require 'spec/autorun'
-require 'rmagick'
+require 'RMagick'
+require 'fileutils'
 
 module SpecHelper
   SW_MAXIMIZE = 3
@@ -23,12 +25,14 @@ module SpecHelper
                   [:long, :long, :int, :int, :int, :int, :int], :bool
 
   def check_image(bmp, file=nil)
-    File.open("#{file}.bmp", "wb") {|io| io.write(bmp)} unless file.nil?
+    temp_dir = File.join(File.dirname(__FILE__), 'tmp')
+    FileUtils.mkdir temp_dir unless File.exists?(temp_dir)
+    File.open(File.join(temp_dir, "#{file}.bmp"), "wb") {|io| io.write(bmp)} unless file.nil?
     bmp[0..1].should == 'BM'
     img = Magick::Image.from_blob(bmp)
     png = img[0].to_blob {self.format = 'PNG'}
     png[0..3].should == "\211PNG"
-    File.open("#{file}.png", "wb") {|io| io.puts(png)} unless file.nil?
+    File.open(File.join(temp_dir, "#{file}.png"), "wb") {|io| io.puts(png)} unless file.nil?
   end
 
   def wait_for_programs_to_open

data/spec/win32_screenshot_spec.rb

@@ -23,6 +23,19 @@ describe "win32-screenshot" do
     end
   end
 
+  it "captures area of the foreground" do
+    Win32::Screenshot.foreground_area(30, 30, 100, 150) do |width, height, bmp|
+      check_image(bmp, 'foreground_area')
+      width.should == 70
+      height.should == 120
+    end
+  end
+
+  it "doesn't allow to capture area of the foreground with invalid coordinates" do
+    lambda {Win32::Screenshot.foreground_area(0, 0, -1, 100) {|width, height, bmp| check_image('foreground2')}}.
+            should raise_exception("specified coordinates (0, 0, -1, 100) are invalid!")
+  end
+
   it "captures desktop" do
     Win32::Screenshot.desktop do |width, height, bmp|
       check_image(bmp, 'desktop')
@@ -33,6 +46,19 @@ describe "win32-screenshot" do
     end
   end
 
+  it "captures area of the desktop" do
+    Win32::Screenshot.desktop_area(30, 30, 100, 150) do |width, height, bmp|
+      check_image(bmp, 'desktop_area')
+      width.should == 70
+      height.should == 120
+    end
+  end
+
+  it "doesn't allow to capture area of the desktop with invalid coordinates" do
+    lambda {Win32::Screenshot.desktop_area(0, 0, -1, 100) {|width, height, bmp| check_image('desktop2')}}.
+            should raise_exception("specified coordinates (0, 0, -1, 100) are invalid!")
+  end
+
   it "captures maximized window by window title" do
     title = "Internet Explorer"
     maximize(title)
@@ -72,7 +98,51 @@ describe "win32-screenshot" do
     end
   end
 
-  it "captures by hwnd" do
+  it "captures area of the window" do
+    title = /calculator/i
+    Win32::Screenshot.window_area(title, 30, 30, 100, 150) do |width, height, bmp|
+      check_image(bmp, 'calc_area')
+      width.should == 70
+      height.should == 120
+    end
+  end
+
+  it "captures whole window if window size is specified as coordinates" do
+    title = /calculator/i
+    hwnd = Win32::Screenshot::BitmapMaker.hwnd(title)
+    dimensions = Win32::Screenshot::BitmapMaker.dimensions_for(hwnd)
+    Win32::Screenshot.window_area(title, 0, 0, dimensions[2], dimensions[3]) do |width, height, bmp|
+      check_image(bmp, 'calc_area_full_window')
+      width.should == dimensions[2]
+      height.should == dimensions[3]
+    end
+  end
+
+  it "doesn't allow to capture area of the window with negative coordinates" do
+    title = /calculator/i
+    lambda {Win32::Screenshot.window_area(title, 0, 0, -1, 100) {|width, height, bmp| check_image('calc2')}}.
+            should raise_exception("specified coordinates (0, 0, -1, 100) are invalid!")
+  end
+
+  it "doesn't allow to capture area of the window if coordinates are the same" do
+    title = /calculator/i
+    lambda {Win32::Screenshot.window_area(title, 10, 0, 10, 20) {|width, height, bmp| check_image('calc4')}}.
+            should raise_exception("specified coordinates (10, 0, 10, 20) are invalid!")
+  end
+
+  it "doesn't allow to capture area of the window if second coordinate is smaller than first one" do
+    title = /calculator/i
+    lambda {Win32::Screenshot.window_area(title, 0, 10, 10, 9) {|width, height, bmp| check_image('calc5')}}.
+            should raise_exception("specified coordinates (0, 10, 10, 9) are invalid!")
+  end
+
+  it "doesn't allow to capture area of the window with too big coordinates" do
+    title = /calculator/i
+    lambda {Win32::Screenshot.window_area(title, 0, 0, 10, 10000) {|width, height, bmp| check_image('calc3')}}.
+            should raise_exception("specified coordinates (0, 0, 10, 10000) are invalid!")
+  end
+
+  it "captures by window with handle" do
     title = /calculator/i
     hwnd = Win32::Screenshot::BitmapMaker.hwnd(title)
     Win32::Screenshot.hwnd(hwnd) do |width, height, bmp|
@@ -83,6 +153,21 @@ describe "win32-screenshot" do
     end
   end
 
+  it "captures area of the window with handle" do
+    hwnd = Win32::Screenshot::BitmapMaker.hwnd(/calculator/i)
+    Win32::Screenshot.hwnd_area(hwnd, 30, 30, 100, 150) do |width, height, bmp|
+      check_image(bmp, 'calc_hwnd_area')
+      width.should == 70
+      height.should == 120
+    end
+  end
+
+  it "doesn't allow to capture area of the window with handle with invalid coordinates" do
+    hwnd = Win32::Screenshot::BitmapMaker.hwnd(/calculator/i)
+    lambda {Win32::Screenshot.hwnd_area(hwnd, 0, 0, -1, 100) {|width, height, bmp| check_image('desktop2')}}.
+            should raise_exception("specified coordinates (0, 0, -1, 100) are invalid!")
+  end
+
   after :all do
     Process.kill 9, @notepad
     Process.kill 9, @iexplore

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Jarmo Pertman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-27 00:00:00 +03:00
+date: 2010-07-07 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,7 +45,7 @@ dependencies:
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rmagick
+  name: os
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
@@ -56,6 +56,18 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rmagick
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: Capture Screenshots on Windows with Ruby
 email: 
 - jarmo.p@gmail.com