win32screenshot 0.0.8 → 1.0.0

data/.gitignore

@@ -2,4 +2,6 @@ coverage
 rdoc
 pkg
 .idea
-spec/tmp
+spec/tmp
+.yardoc/
+doc/

data/.yardopts

@@ -0,0 +1,6 @@
+--readme README.rdoc
+--no-private
+--hide-void-return
+--title "Win32::Screenshot"
+--files History.rdoc,LICENSE
+--default-return ""

data/History.rdoc

@@ -1,3 +1,10 @@
+= 1.0.0 2010-12-17 - The New Beginning
+* Bundling all necessary libraries/binaries with the gem - ImageMagick and RMagick are no more needed, finally!
+* Using MiniMagick to save images to gif, jpg and png format
+* Simplified and deleted a lot of code causing backwards incompatibility and major API changes!
+    Refer to the README.rdoc and documentation for the overview of the new and better API
+* From now on this library is following Semantic Versioning (http://semver.org) rules
+
 = 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):

data/README.rdoc

@@ -1,94 +1,40 @@
-= Win32::Screenshot (old name win32screenshot)
+= Win32::Screenshot
 
 * 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.
+Capture Screenshots on Windows with Ruby to bmp, gif, jpg or png formats!
+
+== INSTALL
+
+  gem install win32screenshot
 
 == 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 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("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("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("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("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
-  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("picture10.png", "wb") {|file| file.puts png}
-  end
-
-  #
-  # Win32::Screenshot has also some utility methods which can be used for various needs
+  # Take a screenshot of the window with the specified title
+  Win32::Screenshot::Take.of(:window, :title => "Windows Internet Explorer").write("image.bmp")
 
-  # enumerate all windows and return their titles and handles
-  Win32::Screenshot::Util.all_windows # => [["title1", 2345], ["title2", 3456]]
+  # Take a screenshot of the foreground
+  Win32::Screenshot::Take.of(:foreground).write("image.png")
 
-  # retrieve window title for the specified window handle
-  Win32::Screenshot::Util.window_title(2345) # => "title1"
+  # 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]).write("image.jpg")
 
-  # retrieve window handle for the specified title
-  Win32::Screenshot::Util.window_hwnd("title1") # => 2345
+  # Take a screenshot of the window with the specified handle
+  Win32::Screenshot::Take.of(:window, :hwnd => 123456).write("image.gif")
 
-  # title can be also a regular expression with first matching window retrieved
-  Win32::Screenshot::Util.window_hwnd(/tit.*1/) # => 2345
+  # 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")).write("image.png")
 
-  # retrive dimensions of a window with specified handle in an Array of [width, height]
-  # might be useful for using with different capture_area methods
-  Win32::Screenshot::Util.dimensions_for(2345) # => [100, 200]
+  # Use the bitmap blob for something else
+  image = Win32::Screenshot::Take.of(:window, :hwnd => 123456)
+  image.height # => height of the image
+  image.width  # => width of the image
+  image.bitmap # => bitmap blob
 
 == Copyright
 

data/Rakefile

@@ -2,7 +2,6 @@
 
 require 'rubygems'
 require 'rake'
-require 'os'
 
 begin
   require 'jeweler'
@@ -17,29 +16,20 @@ begin
     gem.rdoc_options = ["--main", "README.rdoc"]
 
     gem.add_dependency "ffi", "~>0"
+    gem.add_dependency "mini_magick", "~>3.1"
+    gem.add_dependency "rautomation", "~>0.2"
 
-    gem.add_development_dependency "rspec", ">= 1.2.9"
-    gem.add_development_dependency 'os'
-    if OS.java?
-      gem.add_development_dependency "rmagick4j"
-    else
-      gem.add_development_dependency "rmagick"
-    end
+    gem.add_development_dependency "rspec", "~>2.3"
   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
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.pattern = 'spec/**/*_spec.rb'
+RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
@@ -47,15 +37,8 @@ task :spec => :check_dependencies
 
 task :default => :spec
 
-require 'rake/rdoctask'
-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
+require 'yard'
+YARD::Rake::YardocTask.new
 
 desc "Remove all temporary files"
 task :clobber => [:clobber_rdoc, :clobber_rcov] do

data/VERSION

@@ -1 +1 @@
-0.0.8
+1.0.0

data/ext/ImageMagick-License.txt

@@ -0,0 +1,101 @@
+Before we get to the text of the license lets just review what the license says in simple terms:
+
+It allows you to:
+
+    * freely download and use ImageMagick software, in whole or in part, for personal, company internal, or commercial purposes;
+    * use ImageMagick software in packages or distributions that you create;
+    * link against a library under a different license;
+    * link code under a different license against a library under this license;
+    * merge code into a work under a different license;
+    * extend patent grants to any code using code under this license;
+    * and extend patent protection.
+
+It forbids you to:
+
+    * redistribute any piece of ImageMagick-originated software without proper attribution;
+    * use any marks owned by ImageMagick Studio LLC in any way that might state or imply that ImageMagick Studio LLC endorses your distribution;
+    * use any marks owned by ImageMagick Studio LLC in any way that might state or imply that you created the ImageMagick software in question.
+
+It requires you to:
+
+    * include a copy of the license in any redistribution you may make that includes ImageMagick software;
+    * provide clear attribution to ImageMagick Studio LLC for any distributions that include ImageMagick software.
+
+It does not require you to:
+
+    * include the source of the ImageMagick software itself, or of any modifications you may have made to it, in any redistribution you may assemble that includes it;
+    * submit changes that you make to the software back to the ImageMagick Studio LLC (though such feedback is encouraged).
+
+A few other clarifications include:
+
+    * ImageMagick is freely available without charge;
+    * you may include ImageMagick on a DVD as long as you comply with the terms of the license;
+    * you can give modified code away for free or sell it under the terms of the ImageMagick license or distribute the result under a different license, but you need to acknowledge the use of the ImageMagick software;
+    * the license is compatible with the GPL V3.
+    * when exporting the ImageMagick software, review its export classification.
+
+The legally binding and authoritative terms and conditions for use, reproduction, and distribution of ImageMagick follow:
+
+Copyright 1999-2011 ImageMagick Studio LLC, a non-profit organization dedicated to making software imaging solutions freely available.
+
+1. Definitions.
+
+License shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+Licensor shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+Legal Entity shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, control means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+You (or Your) shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+Source form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+Object form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+Work shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+Derivative Works shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+Contribution shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as Not a Contribution.
+
+Contributor shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+   1. You must give any other recipients of the Work or Derivative Works a copy of this License; and
+   2. You must cause any modified files to carry prominent notices stating that You changed the files; and
+   3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+   4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+APPENDIX: How to apply the ImageMagick License to your work
+
+To apply the ImageMagick License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the ImageMagick License (the "License"); you may not use
+   this file except in compliance with the License.  You may obtain a copy
+   of the License at
+
+     http://www.imagemagick.org/script/license.php
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+   WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+   License for the specific language governing permissions and limitations
+   under the License.

data/lib/win32/screenshot.rb

@@ -1,95 +1,14 @@
+require 'ffi'
+require 'stringio' # this is needed for MiniMagick for now
+require 'mini_magick'
+require 'rautomation'
+
+require File.dirname(__FILE__) + '/screenshot/extensions/rautomation/adapter/ffi/functions'
+require File.dirname(__FILE__) + '/screenshot/extensions/rautomation/adapter/ffi/window'
+require File.dirname(__FILE__) + '/screenshot/take'
+require File.dirname(__FILE__) + '/screenshot/image'
 require File.dirname(__FILE__) + '/screenshot/bitmap_maker'
-require File.dirname(__FILE__) + '/util'
 
-module Win32
-  # Captures screenshots with Ruby on Windows
-  class Screenshot
-    class << self
-
-      # captures foreground
-      def foreground(&proc)
-        hwnd = BitmapMaker.foreground_window
-        BitmapMaker.capture_all(hwnd, &proc)
-      end
-
-      # 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_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 = Util.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 = Util.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_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 validate_coordinates(hwnd, *coords)
-        specified_coordinates = coords.join(', ')
-        if coords.any? {|c| c < 0}
-          raise "specified coordinates (#{specified_coordinates}) are invalid - cannot be negative!"
-        end
-        x1, y1, x2, y2 = *coords
-        if x1 >= x2 || y1 >= y2
-          raise "specified coordinates (#{specified_coordinates}) are invalid - cannot have x1 > x2 or y1 > y2!"
-        end
-
-        max_width, max_height = Util.dimensions_for(hwnd)
-        if x2 > max_width || y2 > max_height
-          raise "specified coordinates (#{specified_coordinates}) are invalid - maximum are x2=#{max_width} and y2=#{max_height}!"
-        end
-      end
-    end
-
-  end
-end
+# environment variables for bundled MiniMagick
+ENV["PATH"] = "#{File.dirname(__FILE__) + "/../../ext"};#{ENV["PATH"]}"
+ENV["MAGICK_CODER_MODULE_PATH"] = File.dirname(__FILE__) + "/../../ext/modules/coders"