win32screenshot 0.0.2 → 0.0.4

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,6 @@
+coverage
+rdoc
+pkg
+.idea
+*.bmp
+*.png

data/History.rdoc

@@ -0,0 +1,23 @@
+= 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)
+* Changed library structure - it is now needed to require 'win32/screenshot' (Aslak Hellesøy)
+* Replaced Ruby::DL with Ruby-FFI for better VM support and less segfaults (Jarmo Pertman)
+* Added Ruby 1.9.1 support (Jarmo Pertman)
+* Win32::Screenshot.window restores window if it's minimized before taking screenshots and brings it to the foreground (Jarmo Pertman)
+* Changed some internal method names (Jarmo Pertman)
+* Replaced Test::Unit with RSpec and made specs more robust (Jarmo Pertman)
+
+PS! This version is not backwards compatible due to different method names and usage, but upgrading should be relatively easy nevertheless.
+
+= 0.0.3 2007-01-18
+* Fixed bug with too many callbacks
+* Added get_hwnd(Regexp)
+
+= 0.0.2 2006-12-02 
+* Added desktop method (patch from Ryan Schuft)
+* Added HTTP server example (patch from Ryan Schuft)
+* Added window(regexp) method
+
+= 0.0.1 2006-11-29
+* First release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jarmo Pertman, Aslak Hellesøy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,51 @@
+= Win32::Screenshot (old name win32screenshot)
+
+* http://github.com/jarmo/win32screenshot
+
+== DESCRIPTION
+
+Capture Screenshots on Windows with Ruby. This library captures
+screenshots in bmp format, but you may use RMagick to convert these to some
+other formats like png.
+
+== SYNOPSIS
+
+  require 'win32/screenshot'
+ 
+  # take a screenshot of the foreground window
+  Win32::Screenshot.foreground do |width, height, bmp|
+    File.open("picture1.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}
+  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}
+  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}
+  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}
+  end
+
+  # convert a screenshot to the png format with RMagick
+  require 'rmagick'
+  
+  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}
+  end
+
+== Copyright
+
+Copyright (c) 2010 Jarmo Pertman, Aslak Hellesøy. See LICENSE for details.

data/Rakefile

@@ -1,50 +1,52 @@
+# coding: utf-8
+
 require 'rubygems'
 require 'rake'
-require 'rake/clean'
-require 'rake/testtask'
-require 'rake/packagetask'
-require 'rake/gempackagetask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "win32screenshot"
+    gem.summary = %Q{Capture Screenshots on Windows with Ruby}
+    gem.description = %Q{Capture Screenshots on Windows with Ruby}
+    gem.email = ["jarmo.p@gmail.com", "aslak.hellesoy@gmail.com"]
+    gem.homepage = "http://github.com/jarmo/win32screenshot"
+    gem.authors = ["Jarmo Pertman", "Aslak Hellesøy"]
+
+    gem.rdoc_options = ["--main", "README.rdoc"]
+
+    gem.add_dependency "ffi"
+
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "rmagick"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
 require 'rake/rdoctask'
-require 'rake/contrib/rubyforgepublisher'
-require 'fileutils'
-require 'hoe'
-include FileUtils
-require File.join(File.dirname(__FILE__), 'lib', 'win32screenshot', 'version')
-
-AUTHOR = "Aslak Helles�y"
-EMAIL = "aslak.hellesoy@gmail.com"
-DESCRIPTION = "Capture Screenshots on Windows with Ruby"
-GEM_NAME = "win32screenshot"
-RUBYFORGE_PROJECT = "win32screenshot"
-HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
-RELEASE_TYPES = %w( gem ) # can use: gem, tar, zip
-
-
-NAME = "win32screenshot"
-REV = nil # UNCOMMENT IF REQUIRED: File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
-VERS = ENV['VERSION'] || (Win32screenshot::VERSION::STRING + (REV ? ".#{REV}" : ""))
-CLEAN.include ['**/.*.sw?', '*.gem', '.config']
-RDOC_OPTS = ['--quiet', '--title', "win32screenshot documentation",
-    "--opname", "index.html",
-    "--line-numbers", 
-    "--main", "README",
-    "--inline-source"]
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-hoe = Hoe.new(GEM_NAME, VERS) do |p|
-  p.author = AUTHOR 
-  p.description = DESCRIPTION
-  p.email = EMAIL
-  p.summary = DESCRIPTION
-  p.url = HOMEPATH
-  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
-  p.test_globs = ["test/**/*_test.rb"]
-  p.clean_globs = CLEAN  #An array of file patterns to delete on clean.
-  
-  # == Optional
-  #p.changes        - A description of the release's latest changes.
-  #p.extra_deps     - An array of rubygem dependencies.
-  #p.spec_extras    - A hash of extra values to set in the gemspec.
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Win32::Screenshot #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
 end
-          

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/lib/win32/screenshot.rb

@@ -0,0 +1,36 @@
+require 'win32/screenshot/bitmap_maker'
+
+module Win32
+  # Captures screenshots with Ruby on Windows
+  class Screenshot
+    class << self
+
+      # captures foreground
+      def foreground(&proc)
+        hwnd = BitmapMaker.foreground_window
+        BitmapMaker.capture(hwnd, &proc)
+      end
+
+      # captures desktop
+      def desktop(&proc)
+        hwnd = BitmapMaker.desktop_window
+        BitmapMaker.capture(hwnd, &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(hwnd, pause, &proc)
+      end
+
+      # captures by window handle
+      def hwnd(hwnd, pause=0.5, &proc)
+        BitmapMaker.prepare_window(hwnd, pause)
+        BitmapMaker.capture(hwnd, &proc)
+      end
+    end
+
+  end
+end

data/lib/win32/screenshot/bitmap_maker.rb

@@ -0,0 +1,168 @@
+require 'ffi'
+
+module Win32
+  class Screenshot
+    # internal methods
+    module BitmapMaker #:nodoc:all
+      extend FFI::Library
+
+      ffi_lib 'user32', 'kernel32', 'gdi32'
+      ffi_convention :stdcall
+
+      callback :enum_callback, [:long, :pointer], :bool
+
+      # user32.dll
+      attach_function :enum_windows, :EnumWindows,
+                      [:enum_callback, :pointer], :long
+      attach_function :window_text, :GetWindowTextA,
+                      [:long, :pointer, :int], :int
+      attach_function :window_text_length, :GetWindowTextLengthA,
+                      [:long], :int
+      attach_function :window_visible, :IsWindowVisible,
+                      [:long], :bool
+      attach_function :dc, :GetDC,
+                      [:long], :long
+      attach_function :client_rect, :GetClientRect,
+                      [:long, :pointer], :bool
+      attach_function :minimized, :IsIconic,
+                      [:long], :bool
+      attach_function :show_window, :ShowWindow,
+                      [:long, :int], :bool
+      attach_function :foreground_window, :GetForegroundWindow,
+                      [], :long
+      attach_function :desktop_window, :GetDesktopWindow,
+                      [], :long
+      attach_function :window_thread_process_id, :GetWindowThreadProcessId,
+                      [:long, :pointer], :long
+      attach_function :attach_thread_input, :AttachThreadInput,
+                      [:long, :long, :bool], :bool
+      attach_function :set_foreground_window, :SetForegroundWindow,
+                      [:long], :bool
+      attach_function :set_focus, :SetFocus,
+                      [:long], :bool
+
+      # kernel32.dll
+      attach_function :current_thread_id, :GetCurrentThreadId,
+                      [], :long
+
+      # gdi32.dll
+      attach_function :create_compatible_dc, :CreateCompatibleDC,
+                      [:long], :long
+      attach_function :create_compatible_bitmap, :CreateCompatibleBitmap,
+                      [:long, :int, :int], :long
+      attach_function :select_object, :SelectObject,
+                      [:long, :long], :long
+      attach_function :bit_blt, :BitBlt,
+                      [:long, :int, :int, :int, :int, :long, :int, :int, :long], :bool
+      attach_function :di_bits, :GetDIBits,
+                      [:long, :long, :int, :int, :pointer, :pointer, :int], :int
+      attach_function :delete_object, :DeleteObject,
+                      [:long], :bool
+      attach_function :delete_dc, :DeleteDC,
+                      [:long], :bool
+      attach_function :release_dc, :ReleaseDC,
+                      [:long, :long], :int
+
+      EnumWindowCallback = Proc.new do |hwnd, 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
+          false
+        else
+          true
+        end
+      end
+
+      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
+      end
+
+      SW_SHOW = 5
+
+      def prepare_window(hwnd, pause)
+        restore(hwnd) if minimized(hwnd)
+        set_foreground(hwnd)
+        show_window(hwnd, SW_SHOW)
+        sleep pause
+      end
+
+      SW_RESTORE = 9
+
+      def restore(hwnd)
+        show_window(hwnd, SW_RESTORE)
+      end
+
+      def set_foreground(hwnd)
+        if foreground_window != hwnd
+          foreground_thread = window_thread_process_id(current_thread_id, nil)
+          other_thread = window_thread_process_id(hwnd, nil)
+          attach_thread_input(foreground_thread, other_thread, true)
+          set_foreground_window(hwnd)
+          set_focus(hwnd)
+          attach_thread_input(foreground_thread, other_thread, false)
+        end
+      end
+
+      def dimensions_for(hwnd)
+        rect = [0, 0, 0, 0].pack('L4')
+        client_rect(hwnd, rect)
+        x1, y1, x2, y2 = rect.unpack('L4')
+      end
+
+      def capture(hwnd, &proc)
+        hScreenDC = dc(hwnd)
+        x1, y1, x2, y2 = dimensions_for(hwnd)
+        __capture(hScreenDC, x1, y1, x2, y2, &proc)
+      end
+
+      SRCCOPY = 0x00CC0020
+      DIB_RGB_COLORS = 0
+
+      def __capture(hScreenDC, x1, y1, x2, y2, &proc)
+        w = x2-x1
+        h = y2-y1
+
+        hmemDC = create_compatible_dc(hScreenDC)
+        hmemBM = create_compatible_bitmap(hScreenDC, w, h)
+        select_object(hmemDC, hmemBM)
+        bit_blt(hmemDC, 0, 0, w, h, hScreenDC, 0, 0, SRCCOPY)
+        bitmap_size = w * h * 3 + w % 4 * h
+        lpvpxldata = FFI::MemoryPointer.new(bitmap_size)
+
+        # Bitmap header
+        # http://www.fortunecity.com/skyscraper/windows/364/bmpffrmt.html
+        bmInfo = [40, w, h, 1, 24, 0, 0, 0, 0, 0, 0, 0].pack('L3S2L6')
+        di_bits(hmemDC, hmemBM, 0, h, lpvpxldata, bmInfo, DIB_RGB_COLORS)
+
+        bmFileHeader = [
+                19778,
+                bitmap_size + 40 + 14,
+                0,
+                0,
+                54
+        ].pack('SLSSL')
+
+        bmp_data = bmFileHeader + bmInfo + lpvpxldata.read_string(bitmap_size)
+        proc.call(w, h, bmp_data)
+      ensure
+        lpvpxldata.free
+        delete_object(hmemBM)
+        delete_dc(hmemDC)
+        release_dc(0, hScreenDC)
+      end
+    end
+  end
+end

data/lib/win32screenshot.rb

@@ -1,130 +1,3 @@
-Dir[File.join(File.dirname(__FILE__), 'win32screenshot/**/*.rb')].sort.each { |lib| require lib }
-
-require 'rubygems'
-require 'dl/import'
-
-module Win32
-  module Screenshot
-    extend DL::Importable
-
-    dlload "kernel32.dll","user32.dll","gdi32.dll"
-
-    USER32 = DL.dlopen("user32")
-    EnumWindows = USER32['EnumWindows', 'IPL']
-    GetWindowTextLength = USER32['GetWindowTextLengthA' ,'LI' ]
-    GetWindowText = USER32['GetWindowTextA', 'iLsL' ] 
-
-    SRCCOPY = 0xCC0020
-    GMEM_FIXED = 0
-    DIB_RGB_COLORS = 0
-
-    typealias "HBITMAP","unsigned int"
-    typealias "LPRECT","unsigned int*"
-
-    extern "HWND GetForegroundWindow()"
-    extern "HWND GetDesktopWindow()"
-    extern "BOOL GetWindowRect(HWND, LPRECT)"
-    extern "BOOL GetClientRect(HWND, LPRECT)"
-    extern "HDC GetDC(HWND)"
-    extern "HDC GetWindowDC(int)"
-    extern "HDC CreateCompatibleDC(HDC)"
-    extern "int GetDeviceCaps(HDC, int)"
-    extern "HBITMAP CreateCompatibleBitmap(HDC, int, int)"
-    extern "long SelectObject(HDC, HBITMAP)"
-    extern "long BitBlt(HDC, long, long, long, long, HDC, long, long, long)"
-    extern "void* GlobalAlloc(long, long)"
-    extern "void* GlobalLock(void*)"
-    extern "long GetDIBits(HDC, HBITMAP, long, long, void*, void*, long)"
-    extern "long GlobalUnlock(void*)"
-    extern "long GlobalFree(void*)"
-    extern "long DeleteObject(unsigned long)"
-    extern "long DeleteDC(HDC)"
-    extern "long ReleaseDC(long, HDC)"
-    extern "BOOL SetForegroundWindow(HWND)"
-
-    module_function
-    def capture(hScreenDC, x1, y1, x2, y2)
-      w = x2-x1
-      h = y2-y1
-
-      # Reserve some memory
-      hmemDC = createCompatibleDC(hScreenDC)
-      hmemBM = createCompatibleBitmap(hScreenDC, w, h)
-      selectObject(hmemDC, hmemBM)
-      bitBlt(hmemDC, 0, 0, w, h, hScreenDC, 0, 0, SRCCOPY)
-      hpxldata = globalAlloc(GMEM_FIXED, w * h * 3)
-      lpvpxldata = globalLock(hpxldata)
-
-      # Bitmap header
-      # http://www.fortunecity.com/skyscraper/windows/364/bmpffrmt.html
-      bmInfo = [40, w, h, 1, 24, 0, 0, 0, 0, 0, 0, 0].pack('LLLSSLLLLLL').to_ptr
-
-      getDIBits(hmemDC, hmemBM, 0, h, lpvpxldata, bmInfo, DIB_RGB_COLORS)
-
-      bmFileHeader = [
-        19778, 
-        (w * h * 3) + 40 + 14,
-        0, 
-        0, 
-        54
-      ].pack('SLSSL').to_ptr
-
-      data = bmFileHeader.to_s(14) + bmInfo.to_s(40) + lpvpxldata.to_s(w * h * 3)
-
-      globalUnlock(hpxldata)
-      globalFree(hpxldata)
-      deleteObject(hmemBM)
-      deleteDC(hmemDC)
-      releaseDC(0, hScreenDC)
- 
-      return [w, h, data]
-    end
-
-    def capture_hwnd(hwnd)
-      hScreenDC = getDC(hwnd)
-
-      # Find the dimensions of the window
-      rect = DL.malloc(DL.sizeof('LLLL'))
-      getClientRect(hwnd, rect)
-      x1, y1, x2, y2 = rect.to_a('LLLL')
-
-      capture(hScreenDC, x1, y1, x2, y2)
-    end
-  
-    module_function
-    def foreground
-      hwnd = getForegroundWindow
-      capture_hwnd(hwnd)
-    end
-
-    module_function
-    def desktop
-      hwnd = getDesktopWindow
-      capture_hwnd(hwnd)
-    end
-
-    module_function
-    def window(title_query, delay=0.1)
-      hwnd = nil
-
-      proc = DL.callback('ILL') do |curr_hwnd, lparam|
-        textLength, a = GetWindowTextLength.call(curr_hwnd)
-        captionBuffer = " " * (textLength+1)
-        t, textCaption = GetWindowText.call(curr_hwnd, captionBuffer, textLength+1)    
-        text = textCaption[1].to_s
-        if text =~ title_query
-          hwnd = curr_hwnd
-          0
-        else
-          1
-        end
-      end
-      EnumWindows.call(proc, 0)
-
-      raise "Couldn't find window with title matching #{title_query}" if hwnd.nil?
-      setForegroundWindow(hwnd)
-      sleep(delay)
-      capture_hwnd(hwnd)
-    end
-  end
-end
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+Kernel.warn %q(DEPRECATION: use "require 'win32/screenshot'" instead of "require 'win32screenshot'")
+require "win32/screenshot"