win32screenshot 2.1.0 → 4.0.0

data/lib/win32/screenshot/bitmap_maker.rb

@@ -1,100 +1,121 @@
-module Win32
-  module Screenshot
-    # @private
-    # This is an internal class for taking the actual screenshots and not part of a public API.
-    class BitmapMaker
-      class << self
-        extend FFI::Library
-
-        ffi_lib 'user32', 'gdi32'
-        ffi_convention :stdcall
-
-        # user32.dll
-        attach_function :window_dc, :GetWindowDC,
-                        [:long], :long
-        attach_function :client_dc, :GetDC,
-                        [:long], :long
-        attach_function :client_rect, :GetClientRect,
-                        [:long, :pointer], :bool
-        attach_function :window_rect, :GetWindowRect,
-                        [:long, :pointer], :bool
-        attach_function :foreground_window, :GetForegroundWindow,
-                        [], :long
-        attach_function :desktop_window, :GetDesktopWindow,
-                        [], :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
-
-        def capture_all(hwnd, context)
-          width, height = dimensions_for(hwnd, context)
-          capture_area(hwnd, context, 0, 0, width, height)
-        end
-
-        SRCCOPY = 0x00CC0020
-        DIB_RGB_COLORS = 0
-
-        def capture_area(hwnd, context, x1, y1, x2, y2)
-          hScreenDC = send("#{context}_dc", hwnd)
-          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, x1, y1, 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')
-
-          Image.new(bmFileHeader + bmInfo + lpvpxldata.read_string(bitmap_size), w, h)
-        ensure
-          lpvpxldata.free
-          delete_object(hmemBM)
-          delete_dc(hmemDC)
-          release_dc(0, hScreenDC)
-        end
-
-        def dimensions_for(hwnd, context)
-          rect = [0, 0, 0, 0].pack('l4')
-          BitmapMaker.send("#{context}_rect", hwnd.to_i, rect)
-          left, top, width, height = rect.unpack('l4')
-
-          if context == :window
-            [width + 1 - left, height + 1 - top]
-          else
-            [width, height]
-          end
-        end
-
-      end
-    end
-  end
-end
+module Win32
+  module Screenshot
+    # @private
+    # This is an internal class for taking the actual screenshots and not part of a public API.
+    class BitmapMaker
+      class << self
+        extend FFI::Library
+
+        ffi_lib 'user32', 'gdi32'
+        ffi_convention :stdcall
+
+        # user32.dll
+        attach_function :window_dc, :GetWindowDC,
+                        [:long], :long
+        attach_function :window_rect, :GetWindowRect,
+                        [:long, :pointer], :bool
+        attach_function :foreground_window, :GetForegroundWindow,
+                        [], :long
+        attach_function :desktop_window, :GetDesktopWindow,
+                        [], :long
+        attach_function :print_window, :PrintWindow,
+                        [:long, :long, :int], :bool
+        attach_function :get_system_metrics, :GetSystemMetrics,
+                        [:int], :int
+
+        # 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 :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
+        attach_function :bit_blt, :BitBlt,
+                        [:long, :int, :int, :int, :int, :long, :int, :int, :long], :bool
+
+        DIB_RGB_COLORS = 0
+        PW_RENDERFULLCONTENT = 0x00000002
+        SRCCOPY = 0x00CC0020
+
+        SM_XVIRTUALSCREEN = 76
+        SM_YVIRTUALSCREEN = 77
+        SM_CXVIRTUALSCREEN = 78
+        SM_CYVIRTUALSCREEN = 79
+
+        def capture_window(hwnd)
+          width, height = dimensions_for(hwnd)
+
+          hScreenDC, hmemDC, hmemBM = prepare_object(hwnd, width, height)
+          print_window(hwnd, hmemDC, PW_RENDERFULLCONTENT)
+          create_bitmap(hScreenDC, hmemDC, hmemBM, width, height)
+        end
+
+        def capture_screen(hwnd)
+          left, top, width, height = desktop.dimensions
+
+          hScreenDC, hmemDC, hmemBM = prepare_object(hwnd, width, height)
+          bit_blt(hmemDC, 0, 0, width, height, hScreenDC, left, top, SRCCOPY)
+          create_bitmap(hScreenDC, hmemDC, hmemBM, width, height)
+        end
+
+        def prepare_object(hwnd, width, height)
+          hScreenDC = window_dc(hwnd)
+          hmemDC = create_compatible_dc(hScreenDC)
+          hmemBM = create_compatible_bitmap(hScreenDC, width, height)
+          select_object(hmemDC, hmemBM)
+          [hScreenDC, hmemDC, hmemBM]
+        end
+
+        def create_bitmap(hScreenDC, hmemDC, hmemBM, width, height)
+          bitmap_size = width * height * 3 + width % 4 * height
+          lpvpxldata = FFI::MemoryPointer.new(bitmap_size)
+
+          # Bitmap header
+          # http://www.fortunecity.com/skyscraper/windows/364/bmpffrmt.html
+          bmInfo = [40, width, height, 1, 24, 0, 0, 0, 0, 0, 0, 0].pack('L3S2L6')
+          di_bits(hmemDC, hmemBM, 0, height, lpvpxldata, bmInfo, DIB_RGB_COLORS)
+
+          bmFileHeader = [
+                  19778,
+                  bitmap_size + 40 + 14,
+                  0,
+                  0,
+                  54
+          ].pack('SLSSL')
+
+          Image.new(bmFileHeader + bmInfo + lpvpxldata.read_string(bitmap_size), width, height)
+        ensure
+          lpvpxldata.free
+          delete_object(hmemBM)
+          delete_dc(hmemDC)
+          release_dc(0, hScreenDC)
+        end
+
+        def desktop
+          Win32::Screenshot::Desktop.new(
+               get_system_metrics(SM_XVIRTUALSCREEN),
+               get_system_metrics(SM_YVIRTUALSCREEN),
+               get_system_metrics(SM_CXVIRTUALSCREEN),
+               get_system_metrics(SM_CYVIRTUALSCREEN)
+          )
+        end
+
+        def dimensions_for(hwnd)
+          rect = [0, 0, 0, 0].pack('l4')
+          window_rect(hwnd.to_i, rect)
+          left, top, width, height = rect.unpack('l4')
+
+          [width - left, height - top]
+        end
+      end
+    end
+  end
+end

data/lib/win32/screenshot/desktop.rb

@@ -0,0 +1,5 @@
+Win32::Screenshot::Desktop = Struct.new(:left, :top, :width, :height) do
+   def dimensions
+      [left, top, width, height]
+   end
+end

data/lib/win32/screenshot/take.rb

@@ -1,109 +1,79 @@
-module Win32
-  module Screenshot
-    # Capture Screenshots on Windows with Ruby
-    class Take
-
-      class << self
-        # Takes a screenshot of the specified object or it's area.
-        #
-        # @example Take a screenshot of the window with the specified title
-        #   Win32::Screenshot::Take.of(:window, :title => "Windows Internet Explorer")
-        #
-        # @example Take a screenshot of the foreground
-        #   Win32::Screenshot::Take.of(:foreground)
-        #
-        # @example Take a screenshot of the specified window's top-left corner's area
-        #   Win32::Screenshot::Take.of(:window, :title => /internet/i, :area => [10, 10, 20, 20])
-        #
-        # @example Take a screenshot of the window with the specified handle
-        #   Win32::Screenshot::Take.of(:window, :hwnd => 123456)
-        #
-        # @example Take a screenshot of the window's client area (e.g. without title bar) with the specified handle
-        #   Win32::Screenshot::Take.of(:window, :hwnd => 123456, :context => :client)
-        #
-        # @example Take a screenshot of the child window with the specified internal class name
-        #   Win32::Screenshot::Take.of(:rautomation, RAutomation::Window.new(:hwnd => 123456).child(:class => "Internet Explorer_Server"))
-        #
-        # @param [Symbol] what the type of the object to take a screenshot of,
-        #   possible values are _:foreground_, _:desktop_ and _:window_.
-        # @param [Hash] opts options are optional for specifying an _:area_ and/or _:context_ to take a screenshot.
-        #   It is possible to specify as many options as are needed for searching for the unique window.
-        #   By default the first window with matching identifiers will be taken screenshot of.
-        #   It is possible to use in addition to other options a 0-based _:index_ option to search for other windows if multiple
-        #   windows match the specified criteria.
-        # @option opts [String, Symbol] :context Context to take a screenshot of. Can be _:window_ or _:client_. Defaults to _:window_
-        # @option opts [String, Regexp] :title Title of the window
-        # @option opts [String, Regexp] :text Visible text of the window
-        # @option opts [String, Regexp] :class Internal class name of the window
-        # @option opts [String, Fixnum] :hwnd Window handle in decimal format
-        # @option opts [String, Fixnum] :pid Window process ID (PID)
-        # @option opts [String, Fixnum] :index 0-based index to specify n-th window to take a screenshot of if
-        #   all other criteria match
-        # @option opts [RAutomation::Window] :rautomation RAutomation::Window object to take a screenshot of. Useful for
-        #   taking screenshots of the child windows
-        # @return [Image] the {Image} of the specified object
-        def of(what, opts = {})
-          valid_whats = [:foreground, :desktop, :window]
-          raise "It is not possible to take a screenshot of '#{what}', possible values are #{valid_whats.join(", ")}" unless valid_whats.include?(what)
-
-          self.send(what, {:context => :window}.merge(opts))
-        end
-
-        alias_method :new, :of
-
-        private
-
-        def foreground(opts)
-          hwnd = BitmapMaker.foreground_window
-          take_screenshot(hwnd, opts)
-        end
-
-        def desktop(opts)
-          hwnd = BitmapMaker.desktop_window
-          take_screenshot(hwnd, opts)
-        end
-
-        def window(opts)
-          area = {:area => opts.delete(:area)}
-          context = {:context => opts.delete(:context)}
-          win = opts[:rautomation] || RAutomation::Window.new(opts)
-          timeout = Time.now + 10
-          until win.active?
-            if Time.now >= timeout
-              Kernel.warn "[WARN] Failed to set window '#{win.locators.inspect}' into focus for taking the screenshot"
-              break
-            end
-            win.activate
-          end
-          take_screenshot(win.hwnd, opts.merge(context).merge(area || {}))
-        end
-
-        def take_screenshot(hwnd, opts)
-          if opts[:area]
-            validate_coordinates(hwnd, opts[:context], *opts[:area])
-            BitmapMaker.capture_area(hwnd, opts[:context], *opts[:area])
-          else
-            BitmapMaker.capture_all(hwnd, opts[:context])
-          end
-        end
-
-        def validate_coordinates(hwnd, context, x1, y1, x2, y2)
-          specified_coordinates = "x1: #{x1}, y1: #{y1}, x2: #{x2}, y2: #{y2}"
-          if [x1, y1, x2, y2].any? {|c| c < 0}
-            raise "specified coordinates (#{specified_coordinates}) are invalid - cannot be negative!"
-          end
-
-          if x1 >= x2 || y1 >= y2
-            raise "specified coordinates (#{specified_coordinates}) are invalid - cannot be x1 >= x2 or y1 >= y2!"
-          end
-
-          max_width, max_height = BitmapMaker.dimensions_for(hwnd, context)
-          if x2 > max_width || y2 > max_height
-            raise "specified coordinates (#{specified_coordinates}) are invalid - maximum x2: #{max_width} and y2: #{max_height}!"
-          end
-        end
-
-      end
-    end
-  end
-end
+module Win32
+  module Screenshot
+    # Capture Screenshots on Windows with Ruby
+    class Take
+
+      class << self
+        # Takes a screenshot of the specified object.
+        #
+        # @example Take a screenshot of the window with the specified title
+        #   Win32::Screenshot::Take.of(:window, :title => "Windows Internet Explorer")
+        #
+        # @example Take a screenshot of the foreground
+        #   Win32::Screenshot::Take.of(:foreground)
+        #
+        # @example Take a screenshot of the desktop
+        #   Win32::Screenshot::Take.of(:desktop)
+        #
+        # @example Take a screenshot of the window with the specified handle
+        #   Win32::Screenshot::Take.of(:window, :hwnd => 123456)
+        #
+        # @example Take a screenshot of the window's client area (e.g. without title bar) with the specified handle
+        #   Win32::Screenshot::Take.of(:window, :hwnd => 123456, :context => :client)
+        #
+        # @example Take a screenshot of the child window with the specified internal class name
+        #   Win32::Screenshot::Take.of(:rautomation, RAutomation::Window.new(:hwnd => 123456).child(:class => "Internet Explorer_Server"))
+        #
+        # @param [Symbol] what the type of the object to take a screenshot of,
+        #   possible values are _:foreground_, _:desktop_ and _:window_.
+        # @param [Hash] opts options are optional for specifying _:context_ to take a screenshot.
+        #   It is possible to specify as many options as are needed for searching for the unique window.
+        #   By default the first window with matching identifiers will be taken screenshot of.
+        #   It is possible to use in addition to other options a 0-based _:index_ option to search for other windows if multiple
+        #   windows match the specified criteria.
+        # @option opts [String, Regexp] :title Title of the window
+        # @option opts [String, Regexp] :text Visible text of the window
+        # @option opts [String, Fixnum] :hwnd Window handle in decimal format
+        # @option opts [String, Fixnum] :pid Window process ID (PID)
+        # @option opts [String, Fixnum] :index 0-based index to specify n-th window to take a screenshot of if
+        #   all other criteria match
+        # @option opts [RAutomation::Window] :rautomation RAutomation::Window object to take a screenshot of. Useful for
+        #   taking screenshots of the child windows
+        # @return [Image] the {Image} of the specified object
+        def of(what, opts = {})
+          valid_whats = [:foreground, :desktop, :window]
+          raise "It is not possible to take a screenshot of '#{what}', possible values are #{valid_whats.join(", ")}" unless valid_whats.include?(what)
+
+          self.send(what, opts)
+        end
+
+        alias_method :new, :of
+
+        private
+
+        def foreground(opts)
+          hwnd = BitmapMaker.foreground_window
+          BitmapMaker.capture_window(hwnd)
+        end
+
+        def desktop(opts)
+          hwnd = BitmapMaker.desktop_window
+          BitmapMaker.capture_screen(hwnd)
+        end
+
+        def window(opts)
+          win = opts[:rautomation] || RAutomation::Window.new(opts)
+          timeout = Time.now + 10
+          until win.active?
+            if Time.now >= timeout
+              Kernel.warn "[WARN] Failed to set window '#{win.locators.inspect}' into focus for taking the screenshot"
+              break
+            end
+            win.activate
+          end
+          BitmapMaker.capture_window(win.hwnd)
+        end
+      end
+    end
+  end
+end

data/lib/win32/screenshot/version.rb

@@ -1,5 +1,5 @@
-module Win32
-  module Screenshot
-    VERSION = "2.1.0"
-  end
-end
+module Win32
+  module Screenshot
+    VERSION = "4.0.0"
+  end
+end

data/lib/win32/screenshot.rb

@@ -1,11 +1,12 @@
-require 'ffi'
-require 'mini_magick'
-require 'rautomation'
-
-require File.dirname(__FILE__) + '/screenshot/version'
-require File.dirname(__FILE__) + '/screenshot/take'
-require File.dirname(__FILE__) + '/screenshot/image'
-require File.dirname(__FILE__) + '/screenshot/bitmap_maker'
-
-# add bundled ImageMagick into path
-ENV["PATH"] = "#{File.dirname(__FILE__) + "/../../ext/ImageMagick-6.9.3-0-portable-Q16-x86"};#{ENV["PATH"]}"
+require 'ffi'
+require 'mini_magick'
+require 'rautomation'
+
+require File.dirname(__FILE__) + '/screenshot/version'
+require File.dirname(__FILE__) + '/screenshot/take'
+require File.dirname(__FILE__) + '/screenshot/image'
+require File.dirname(__FILE__) + '/screenshot/bitmap_maker'
+require File.dirname(__FILE__) + '/screenshot/desktop'
+
+# add bundled ImageMagick into path
+ENV["PATH"] = "#{File.dirname(__FILE__) + "/../../ext/ImageMagick-7.0.9-8-portable-Q16-x86"};#{ENV["PATH"]}"

data/spec/spec_helper.rb

@@ -1,47 +1,47 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-require 'win32/screenshot'
-require 'rspec'
-require 'fileutils'
-
-module SpecHelper
-  HWND_TOPMOST = -1
-  HWND_NOTOPMOST = -2
-  SWP_NOSIZE = 1
-  SWP_NOMOVE = 2
-  SWP_SHOWWINDOW = 40
-
-  extend FFI::Library
-  ffi_lib 'user32'
-  ffi_convention :stdcall
-
-  # user32.dll
-  attach_function :set_window_pos, :SetWindowPos,
-                  [:long, :long, :int, :int, :int, :int, :int], :bool
-  
-  def save_and_verify_image(img, file=nil)
-    FileUtils.mkdir @temp_dir unless File.exists?(@temp_dir)
-    file_name = File.join @temp_dir, "#{file}.bmp"
-    img.write file_name
-    img.bitmap[0..1].should == 'BM'
-  end
-
-  def resize title
-    hwnd = RAutomation::Window.new(:title => title).hwnd
-    set_window_pos(hwnd,
-                   HWND_TOPMOST,
-                   0, 0, 150, 238,
-                   SWP_NOMOVE)
-    set_window_pos(hwnd,
-                   HWND_NOTOPMOST,
-                   0, 0, 0, 0,
-                   SWP_SHOWWINDOW | SWP_NOMOVE | SWP_NOSIZE)
-    sleep 1
-  end
-end
-
-RSpec.configure do |config|
-  config.include(SpecHelper)
-  config.before(:suite) {FileUtils.rm Dir.glob(File.join(File.dirname(__FILE__), "tmp/*"))}
-  config.before(:all) {@temp_dir = File.join(File.dirname(__FILE__), 'tmp')}
-end
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'win32/screenshot'
+require 'rspec'
+require 'fileutils'
+
+module SpecHelper
+  HWND_TOPMOST = -1
+  HWND_NOTOPMOST = -2
+  SWP_NOSIZE = 1
+  SWP_NOMOVE = 2
+  SWP_SHOWWINDOW = 40
+
+  extend FFI::Library
+  ffi_lib 'user32'
+  ffi_convention :stdcall
+
+  # user32.dll
+  attach_function :set_window_pos, :SetWindowPos,
+                  [:long, :long, :int, :int, :int, :int, :int], :bool
+  
+  def save_and_verify_image(img, file=nil)
+    FileUtils.mkdir @temp_dir unless File.exists?(@temp_dir)
+    file_name = File.join @temp_dir, "#{file}.bmp"
+    img.write file_name
+    expect(img.bitmap[0..1]).to eq('BM')
+  end
+
+  def resize title
+    hwnd = RAutomation::Window.new(:title => title).hwnd
+    set_window_pos(hwnd,
+                   HWND_TOPMOST,
+                   0, 0, 150, 238,
+                   SWP_NOMOVE)
+    set_window_pos(hwnd,
+                   HWND_NOTOPMOST,
+                   0, 0, 0, 0,
+                   SWP_SHOWWINDOW | SWP_NOMOVE | SWP_NOSIZE)
+    sleep 1
+  end
+end
+
+RSpec.configure do |config|
+  config.include(SpecHelper)
+  config.before(:suite) {FileUtils.rm Dir.glob(File.join(File.dirname(__FILE__), "tmp/*"))}
+  config.before(:all) {@temp_dir = File.join(File.dirname(__FILE__), 'tmp')}
+end