win32screenshot 0.0.8 → 1.0.0

data/lib/win32/util.rb

@@ -1,93 +0,0 @@
-module Win32
-  class Screenshot
-    class Util
-      class << self
-
-        def all_desktop_windows
-          titles = []
-          window_callback = FFI::Function.new(:bool, [ :long, :pointer ], { :convention => :stdcall }) do |hwnd, param|
-            titles << [window_title(hwnd), hwnd]
-            true
-          end
-
-          BitmapMaker.enum_windows(window_callback, nil)
-          titles
-        end
-        
-        # just returns a long list of hwnd's...
-        # unless with_info is true
-        # then it will return all hwnds with full info about each window
-        def windows_hierarchy with_info = false          
-          all = {}
-          desktop_hwnd = BitmapMaker.desktop_window
-          root = {:hwnd => desktop_hwnd, :children => []}
-          root.merge!(get_info(desktop_hwnd)) if with_info
-          parents = []
-          parents << root
-          window_callback = FFI::Function.new(:bool, [ :long, :pointer ], { :convention => :stdcall }) do |hwnd, param|
-            # this is a child of the most recent parent
-            myself = {:hwnd => hwnd, :children => []}
-            myself.merge!(get_info(hwnd)) if with_info
-            parents[-1][:children] << myself
-            parents << myself
-            if !all[hwnd]
-              all[hwnd] = true
-              BitmapMaker.enum_child_windows(hwnd, window_callback, nil)
-            end
-            
-            parents.pop
-            true
-          end
-          BitmapMaker.enum_child_windows(desktop_hwnd, window_callback, nil)
-          root
-        end
-        
-        def get_info hwnd
-          {:title => window_title(hwnd), 
-          :class => window_class(hwnd), 
-          :dimensions => dimensions_for(hwnd), 
-          :starting_coordinates => location_of(hwnd)
-          }
-        end  
-        
-        def window_title hwnd
-          title_length = BitmapMaker.window_text_length(hwnd) + 1
-          title = FFI::MemoryPointer.new :char, title_length
-          BitmapMaker.window_text(hwnd, title, title_length)
-          title.read_string
-        end
-        
-        def window_class hwnd
-          title = FFI::MemoryPointer.new :char, 100
-          BitmapMaker.class_name(hwnd, title, 99)
-          title.read_string
-        end
-
-        def window_hwnd(title_query)
-          hwnd = BitmapMaker.hwnd(title_query)
-          raise "window with title '#{title_query}' was not found!" unless hwnd
-          hwnd
-        end
-        
-        def location_of(hwnd)
-          rect = [0, 0, 0, 0].pack('L4')
-          BitmapMaker.window_rect(hwnd, rect)
-          x, y, width, height = rect.unpack('L4')
-          return x, y
-        end
-
-        def dimensions_for(hwnd)
-          rect = [0, 0, 0, 0].pack('L4')
-          BitmapMaker.client_rect(hwnd, rect)
-          _, _, width, height = rect.unpack('L4')
-          return width, height
-        end
-        
-        def window_process_id(hwnd)
-          BitmapMaker.get_process_id_from_hwnd(hwnd)
-        end
-
-      end
-    end
-  end
-end

data/spec/win32_screenshot_spec.rb

@@ -1,194 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe Win32::Screenshot do
-  include SpecHelper
-
-  before :all do
-    @notepad = IO.popen("notepad").pid
-    @iexplore = Dir.chdir("c:/program files/Internet Explorer") do; IO.popen(".\\iexplore about:blank").pid; end
-    @calc = IO.popen("calc").pid
-    wait_for_programs_to_open
-    cleanup
-  end
-
-  it "captures foreground" do
-    Win32::Screenshot.foreground do |width, height, bmp|
-      check_image(bmp, 'foreground')
-      hwnd = Win32::Screenshot::BitmapMaker.foreground_window
-      [width, height].should == Win32::Screenshot::Util.dimensions_for(hwnd)
-    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 - cannot be negative!")
-  end
-
-  it "captures desktop" do
-    Win32::Screenshot.desktop do |width, height, bmp|
-      check_image(bmp, 'desktop')
-      hwnd = Win32::Screenshot::BitmapMaker.desktop_window
-      [width, height].should == Win32::Screenshot::Util.dimensions_for(hwnd)
-    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 - cannot be negative!")
-  end
-
-  it "captures maximized window by window title" do
-    title = "Internet Explorer"
-    maximize(title)
-    Win32::Screenshot.window(title) do |width, height, bmp|
-      check_image(bmp, 'iexplore')
-      hwnd = Win32::Screenshot::BitmapMaker.hwnd(title)
-      [width, height].should == Win32::Screenshot::Util.dimensions_for(hwnd)
-    end
-  end
-
-  it "captures minimized window by window title as a regexp" do
-    title = /calculator/i
-    minimize(title)
-    Win32::Screenshot.window(title) do |width, height, bmp|
-      check_image(bmp, 'calc')
-      hwnd = Win32::Screenshot::BitmapMaker.hwnd(title)
-      [width, height].should == Win32::Screenshot::Util.dimensions_for(hwnd)
-    end
-  end
-  
-  it "can also search by window class name" do
-    good_pid = Win32::Screenshot::BitmapMaker.hwnd(/calculator/i)
-    good_pid.should_not be_nil
-    good_pid.should == Win32::Screenshot::BitmapMaker.hwnd(/calcframe/i, true)
-  end
-  
-  it "can find sub windows as well" do
-    # search for an IE sub-window by class (doesn't have text)
-    Win32::Screenshot::BitmapMaker.hwnd(/CommandBarClass/i, true).should_not be_nil
-  end
-
-  it "captures small windows" do
-    title = /Notepad/
-    resize(title)
-    Win32::Screenshot.window(title) do |width, height, bmp|
-      check_image(bmp, 'notepad')
-      # we should get the size of the picture because
-      # screenshot doesn't include titlebar and the size
-      # varies between different themes and Windows versions
-      hwnd = Win32::Screenshot::BitmapMaker.hwnd(title)
-      [width, height].should == Win32::Screenshot::Util.dimensions_for(hwnd)
-    end
-  end
-
-  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)
-    expected_width, expected_height = Win32::Screenshot::Util.dimensions_for(hwnd)
-    Win32::Screenshot.window_area(title, 0, 0, expected_width, expected_height) do |width, height, bmp|
-      check_image(bmp, 'calc_area_full_window')
-      width.should == expected_width
-      height.should == expected_height
-    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 - cannot be negative!")
-  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 - cannot have x1 > x2 or y1 > y2!")
-  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 - cannot have x1 > x2 or y1 > y2!")
-  end
-
-  it "doesn't allow to capture area of the window with too big coordinates" do
-    title = /calculator/i
-    hwnd = Win32::Screenshot::BitmapMaker.hwnd(title)
-    expected_width, expected_height = Win32::Screenshot::Util.dimensions_for(hwnd)
-    lambda {Win32::Screenshot.window_area(title, 0, 0, 10, 1000) {|width, height, bmp| check_image('calc3')}}.
-            should raise_exception("specified coordinates (0, 0, 10, 1000) are invalid - maximum are x2=#{expected_width} and y2=#{expected_height}!")
-  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|
-      check_image(bmp, 'calc_hwnd')
-      [width, height].should == Win32::Screenshot::Util.dimensions_for(hwnd)
-    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 - cannot be negative!")
-  end
-
-  it "captures based on coordinates" do
-    hwnd = Win32::Screenshot::BitmapMaker.hwnd(/calculator/i)
-    bmp1 = bmp2 = nil
-    Win32::Screenshot.hwnd_area(hwnd, 100, 100, 170, 180) do |width, height, bmp|; bmp1 = bmp; end
-    Win32::Screenshot.hwnd_area(hwnd, 0, 0, 70, 80) do |width, height, bmp|; bmp2 = bmp; end
-    bmp1.length.should == bmp2.length
-    bmp1.should_not == bmp2
-  end
-
-  it "allows window titles to include regular expressions' special characters" do
-    lambda {Win32::Screenshot::BitmapMaker.hwnd("Window title *^$?([.")}.should_not raise_exception
-  end
-
-  it "raises an 'no block given' Exception if no block was given" do
-    lambda {Win32::Screenshot.foreground}.should raise_exception(LocalJumpError)
-  end
-
-  after :all do
-    for name in [/calculator/i,  /Notepad/, /Internet Explorer/] do
-      # kill them in a jruby friendly way
-      pid = Win32::Screenshot::Util.window_process_id(Win32::Screenshot::Util.window_hwnd(name))
-      system("taskkill /PID #{pid}")
-    end
-  end
-end

data/spec/win32_screenshot_util_spec.rb

@@ -1,75 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe Win32::Screenshot::Util do
-  include SpecHelper
-
-  before :all do
-    # should not have any running calculators yet...
-    proc {Win32::Screenshot::Util.window_hwnd("Calculator") }.should raise_exception("window with title 'Calculator' was not found!")
-    @calc = IO.popen("calc").pid
-    wait_for_calculator_to_open
-    @calc_hwnd = Win32::Screenshot::Util.window_hwnd("Calculator")
-  end
-
-  it ".all_desktop_windows enumerates all available windows" do
-    all_windows = Win32::Screenshot::Util.all_desktop_windows
-    all_windows.should_not be_empty
-    all_windows[0].should be_an(Array)
-    all_windows[0][0].should be_a(String)
-    all_windows[0][1].should be_a(Fixnum)
-
-    calculator = all_windows.find {|title, hwnd| title =~ /Calculator/}
-    calculator.should_not be_nil
-    calculator[0].should == "Calculator"
-    calculator[1].should == @calc_hwnd
-  end
-
-  it ".window_title returns title of a specified window's handle" do
-    Win32::Screenshot::Util.window_title(@calc_hwnd).should == "Calculator"
-  end
-
-  it ".dimensions_for window handle returns dimensions of the window in pixels" do
-    width, height = Win32::Screenshot::Util.dimensions_for(@calc_hwnd)
-    width.should be > 100
-    height.should be > 100
-  end
-  
-  it ".window_class returns classname of a specified window's handle" do
-    Win32::Screenshot::Util.window_class(@calc_hwnd).should == "CalcFrame"
-  end
-  
-  it ".get_info returns lots of info about an hwnd" do
-    desktop_hwnd = Win32::Screenshot::BitmapMaker.desktop_window
-    info = Win32::Screenshot::Util.get_info desktop_hwnd
-    info.should be_a(Hash)
-    info.keys.map {|k| k.to_s}.sort.should == ["class", "dimensions", "starting_coordinates", "title"]
-  end
-  
-  it ".windows_hierarchy returns hwnds" do
-    a = Win32::Screenshot::Util.windows_hierarchy
-    # should have root as "desktop"
-    # though in reality some windows might not be descendants of the desktop 
-    # (see the WinCheat source which discusses this further)
-    # but we don't worry about that edge case yet
-    a.should be_a(Hash)
-    a[:children].should be_an(Array)
-    a[:children].length.should be > 0
-    a[:children][0].should be_a(Hash)
-    a[:hwnd].should == Win32::Screenshot::BitmapMaker.desktop_window
-  end
-  
-  it ".windows_hierarchy can return info" do
-    a = Win32::Screenshot::Util.windows_hierarchy true
-    # check for right structure
-    for hash_example in [a, a[:children][0]] do
-      hash_example.keys.map {|k| k.to_s}.sort.should == ["children", "class", "dimensions", "hwnd", "starting_coordinates", "title"]
-    end
-  end
-  
-  after :all do
-    # tests our hwnd -> pid method, and conveniently, shuts down the calculator process
-    calc_pid = Win32::Screenshot::Util.window_process_id(@calc_hwnd)
-    system("taskkill /PID #{calc_pid}")
-    proc {Win32::Screenshot::Util.window_hwnd("Calculator") }.should raise_exception("window with title 'Calculator' was not found!")
-  end
-end