win32screenshot 0.0.7 → 0.0.8

data/History.rdoc

@@ -1,3 +1,14 @@
+= 0.0.8 2010-12-13
+* Renamed Win32::Screenshot::Util.all_windows to all_desktop_windows (Roger Pack)
+* Added methods to Win32::Screenshot::Util class (Roger Pack):
+  - window_process_id
+  - window_class
+  - windows_hierarchy_with_info
+  - get_info
+  - location_of
+* It's possible to search windows also by class name (Roger Pack)
+* Child windows will be also searched for (Roger Pack)
+
 = 0.0.7 2010-08-18
 * Supports now fully JRuby, 1.9.1 and 1.9.2 MRI!
 

data/Rakefile

@@ -16,7 +16,7 @@ begin
 
     gem.rdoc_options = ["--main", "README.rdoc"]
 
-    gem.add_dependency "ffi"
+    gem.add_dependency "ffi", "~>0"
 
     gem.add_development_dependency "rspec", ">= 1.2.9"
     gem.add_development_dependency 'os'

data/VERSION

@@ -1 +1 @@
-0.0.7
+0.0.8

data/lib/win32/screenshot/bitmap_maker.rb

@@ -13,17 +13,23 @@ module Win32
 
         # user32.dll
         attach_function :enum_windows, :EnumWindows,
-                        [:enum_callback, :pointer], :long
+                        [:enum_callback, :pointer], :int
+        attach_function :enum_child_windows, :EnumChildWindows,
+                        [:long, :enum_callback, :pointer], :int
         attach_function :window_text, :GetWindowTextA,
                         [:long, :pointer, :int], :int
         attach_function :window_text_length, :GetWindowTextLengthA,
                         [:long], :int
+        attach_function :class_name, :GetClassNameA,
+                         [:long, :pointer, :int], :int
         attach_function :window_visible, :IsWindowVisible,
                         [:long], :bool
         attach_function :dc, :GetDC,
                         [:long], :long
         attach_function :client_rect, :GetClientRect,
                         [:long, :pointer], :bool
+        attach_function :window_rect, :GetWindowRect,
+                        [:long, :pointer], :bool
         attach_function :minimized, :IsIconic,
                         [:long], :bool
         attach_function :show_window, :ShowWindow,
@@ -43,7 +49,6 @@ module Win32
         attach_function :set_active_window, :SetActiveWindow,
                         [:long], :long
 
-
         # gdi32.dll
         attach_function :create_compatible_dc, :CreateCompatibleDC,
                         [:long], :long
@@ -65,21 +70,37 @@ module Win32
 
         EnumWindowCallback = FFI::Function.new(:bool, [ :long, :pointer ], { :convention => :stdcall }) do |hwnd, param|
           searched_window = WindowStruct.new param
-          title = Util.window_title(hwnd)
+          if(searched_window[:search_class] != 0)
+            title = Util.window_class(hwnd)
+          else
+            title = Util.window_title(hwnd)
+          end
           if title =~ Regexp.new(searched_window[:title].read_string) && window_visible(hwnd)
             searched_window[:hwnd] = hwnd
             false
           else
-            true
+            if(searched_window[:search_class] != 0)
+              # if they're searching for a classname, enumerate children, too
+              enum_child_windows(hwnd, EnumWindowCallback, param)
+              if searched_window[:hwnd] != 0
+                # return early if already discovered
+                false 
+              else
+               true
+              end
+            else
+              true
+            end
           end
         end
 
         class WindowStruct < FFI::Struct
           layout :title, :pointer,
-                 :hwnd, :long
+                 :hwnd, :long,
+                 :search_class, :char # boolean
         end
 
-        def hwnd(window_title)
+        def hwnd(window_title, search_class = false)
           window = WindowStruct.new
           unless window_title.is_a?(Regexp)
             window_title = Regexp.escape(window_title.to_s)
@@ -88,10 +109,11 @@ module Win32
           end
           window_title = FFI::MemoryPointer.from_string(window_title)
           window[:title] = window_title
+          window[:search_class] = search_class ? 1 : 0
           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)
@@ -119,6 +141,12 @@ module Win32
             attach_thread_input(foreground_thread, other_thread, false) unless other_thread == foreground_thread
           end
         end
+        
+        def get_process_id_from_hwnd hwnd
+          out = FFI::MemoryPointer.new(:uint)
+          window_thread_process_id(hwnd, out)
+          out.get_uint32(0) # read_uint
+        end
 
         def capture_all(hwnd, &proc)
           width, height = Util.dimensions_for(hwnd)

data/lib/win32/util.rb

@@ -3,7 +3,7 @@ module Win32
     class Util
       class << self
 
-        def all_windows
+        def all_desktop_windows
           titles = []
           window_callback = FFI::Function.new(:bool, [ :long, :pointer ], { :convention => :stdcall }) do |hwnd, param|
             titles << [window_title(hwnd), hwnd]
@@ -13,19 +13,68 @@ module Win32
           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')
@@ -33,6 +82,10 @@ module Win32
           _, _, width, height = rect.unpack('L4')
           return width, height
         end
+        
+        def window_process_id(hwnd)
+          BitmapMaker.get_process_id_from_hwnd(hwnd)
+        end
 
       end
     end

data/spec/win32_screenshot_spec.rb

@@ -72,6 +72,17 @@ describe Win32::Screenshot do
       [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/
@@ -140,7 +151,7 @@ describe Win32::Screenshot do
       [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|
@@ -174,8 +185,10 @@ describe Win32::Screenshot do
   end
 
   after :all do
-    Process.kill 9, @notepad
-    Process.kill 9, @iexplore rescue nil # allow for a pre-existing IE to have been used.
-    Process.kill 9, @calc
+    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

@@ -4,13 +4,15 @@ 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_windows enumerates all available windows" do
-    all_windows = Win32::Screenshot::Util.all_windows
+  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)
@@ -32,7 +34,42 @@ describe Win32::Screenshot::Util do
     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
-    Process.kill 9, @calc
+    # 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

data/win32screenshot.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{win32screenshot}
-  s.version = "0.0.7"
+  s.version = "0.0.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jarmo Pertman", "Aslak Helles\303\270y"]
-  s.date = %q{2010-08-18}
+  s.date = %q{2010-12-13}
   s.description = %q{Capture Screenshots on Windows with Ruby}
   s.email = ["jarmo.p@gmail.com", "aslak.hellesoy@gmail.com"]
   s.extra_rdoc_files = [
@@ -49,18 +49,18 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<ffi>, [">= 0"])
+      s.add_runtime_dependency(%q<ffi>, ["~> 0"])
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_development_dependency(%q<os>, [">= 0"])
       s.add_development_dependency(%q<rmagick>, [">= 0"])
     else
-      s.add_dependency(%q<ffi>, [">= 0"])
+      s.add_dependency(%q<ffi>, ["~> 0"])
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<os>, [">= 0"])
       s.add_dependency(%q<rmagick>, [">= 0"])
     end
   else
-    s.add_dependency(%q<ffi>, [">= 0"])
+    s.add_dependency(%q<ffi>, ["~> 0"])
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
     s.add_dependency(%q<os>, [">= 0"])
     s.add_dependency(%q<rmagick>, [">= 0"])

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: win32screenshot
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: false
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Jarmo Pertman
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-18 00:00:00 +03:00
+date: 2010-12-13 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -25,7 +25,7 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
         hash: 3
         segments: