RubyGems - sleipnir-api - Versions diffs - 0.3.0 → 0.4.0 - Mend

sleipnir-api 0.3.0 → 0.4.0

Files changed (25) hide show

data/History.txt +72 -40
data/Manifest.txt +10 -1
data/README.txt +10 -0
data/TODO.txt +5 -4
data/examples/screenshot.rb +33 -0
data/lib/sleipnir_api.rb +6 -2
data/lib/sleipnir_api/bitmap.rb +113 -0
data/lib/sleipnir_api/ffi.rb +4 -0
data/lib/sleipnir_api/ffi/base.rb +22 -0
data/lib/sleipnir_api/ffi/gdi32.rb +165 -0
data/lib/sleipnir_api/ffi/kernel32.rb +20 -0
data/lib/sleipnir_api/ffi/struct.rb +246 -0
data/lib/sleipnir_api/ffi/user32.rb +116 -0
data/lib/sleipnir_api/process.rb +6 -3
data/lib/sleipnir_api/profile.rb +6 -3
data/lib/sleipnir_api/profile/ini.rb +2 -2
data/lib/sleipnir_api/profile/section.rb +2 -2
data/lib/sleipnir_api/registry.rb +3 -3
data/lib/sleipnir_api/screen_captor.rb +138 -0
data/lib/sleipnir_api/sleipnir.rb +35 -0
data/lib/sleipnir_api/tab.rb +90 -5
data/lib/sleipnir_api/version.rb +1 -1
data/spec/sleipnir_api/ffi_spec.rb +38 -0
metadata +12 -3
data/lib/sleipnir_api/win32api.rb +0 -17

data/History.txt CHANGED

@@ -1,52 +1,84 @@
+== 0.4.0 / 2007-10-28
+=== New API:
+* SleipnirAPI::Sleipnir
+  +bring_window_to_top+:: brings the Sleipnir window to the top of the Z order.
+  +save_active_tab+:: protect actived tab.
+  +capture_browser+:: capture sleipnir window.
+* SleipnirAPI::Tab
+  +capture_page+:: save screenshot to specified file.
+  +sleipnir_ieview_hwnd+:: get Sleipnir_IEView window handle.
+  +embedding_ie_hwnd+:: get Internet Explorer_Server window handle.
+  +client_area+:: return body.clientLeft, body.clientTop, body.clientWidth, body.clientHeight
+  +embedding_ie_area+:: return browser width, height including scrollbar and border.
+  +compatible_mode+:: new method to get compatMode.
+  <tt>compatible_mode?</tt>:: new method to return whether documet is compatMode or not.
+  +get_elements_by_tag+:: wrapper of getElementsByTag.
+  <tt>closed?</tt>:: return true closed tab.
 == 0.3.0 / 2007-09-23
-* API changes:
-  * SleipnirAPI::Tab
-    +search+:: support Sleipnir 2.x.
-  * SleipnirAPI::Security
-    +enable?+:: support multiple arguments.
-    +disable?+:: ditto.
-  * SleipnirAPI::Sleipnir
-    +profile+:: support default keyword arguments.
-    +exec_command+:: support SleipnirAPI::Command object.
-* New API:
-  * SleipnirAPI::Command
-    * new class to represent Sleipnir menu commands.
-      it can specify SleipnirAPI::Sleipnir#exec_command.
-  * SleipnirAPI::Profile::Ini
-    * new class to represent ini file.
-  * SleipnirAPI::Profile::Seciton
-    * new class to represent ini section.
-  * SleipnirAPI::Profile::Key
-    * new class to represent ini section key.
-  * SleipnirAPI::Profile
-    +ini+:: get SleipnirAPI::Profile::Ini object.
-  * SleipnirAPI::Tab
-    +watir+:: get Watir object [experimental].
-    +elem_by_tag+:: get IHTMLElement. (shortcut of document.getElementsByTagName).
-    +base_uri+:: get document base (<base> or location.href).
-    +base_uris+:: get base uri in <head>.
-  * SleipnirAPI::Security
-    +enable!+:: set security config.
-    +disable!+:: ditto.
+=== API changes:
+* SleipnirAPI::Tab
+  +search+:: support Sleipnir 2.x.
+* SleipnirAPI::Security
+  <tt>enable?</tt>:: support multiple arguments.
+  <tt>disable?</tt>:: ditto.
+* SleipnirAPI::Sleipnir
+  +profile+:: support default keyword arguments.
+  +exec_command+:: support SleipnirAPI::Command object.
+=== New API:
+* SleipnirAPI::Command
+  * new class to represent Sleipnir menu commands.
+    it can specify SleipnirAPI::Sleipnir#exec_command.
+* SleipnirAPI::Profile::Ini
+  * new class to represent ini file.
+* SleipnirAPI::Profile::Section
+  * new class to represent ini section.
+* SleipnirAPI::Profile::Key
+  * new class to represent ini section key.
+* SleipnirAPI::Profile
+  +ini+:: get SleipnirAPI::Profile::Ini object.
+* SleipnirAPI::Tab
+  +watir+:: get Watir object [experimental].
+  +elem_by_tag+:: get IHTMLElement. (shortcut of document.getElementsByTagName).
+  +base_uri+:: get document base (<base> or location.href).
+  +base_uris+:: get base uri in <head>.
+* SleipnirAPI::Security
+  +enable!+:: set security config.
+  +disable!+:: ditto.
 == 0.2.1 / 2007-07-30
-* grepnir:
-  * minor bug fix.
+=== command:
+* minor bug fix.
 == 0.2.0 / 2007-07-29
+=== command:
 * Added grepnir command to search Sleipnir tab.
-* API changes:
-  * SleipnirAPI::Tab
-    +window+:: support block argument.
-    +document+:: ditto.
-    +browser+:: ditto.
-    +location+:: ditto.
-    +close+:: now take +force+ optional argument to close navigate locked tab.
-    +hilight+:: support multiple keywords.
-    +selection_text+:: add new method to get selected text.
+=== API changes:
+* SleipnirAPI::Tab
+  +window+:: support block argument.
+  +document+:: ditto.
+  +browser+:: ditto.
+  +location+:: ditto.
+  +close+:: now take +force+ optional argument to close navigate locked tab.
+  +hilight+:: support multiple keywords.
+  +selection_text+:: add new method to get selected text.
 == 0.1.0 / 2007-07-22

data/Manifest.txt CHANGED

@@ -11,16 +11,24 @@ examples/command_list.rb
 examples/open_last_url_by_firefox.rb
 examples/open_selected_links.rb
 examples/reload.rb
+examples/screenshot.rb
 helper/rake.rb
 helper/rake/rake.rb
 helper/rake/rake_sh_filter.rb
 helper/rake/util.rb
 lib/sleipnir_api.rb
+lib/sleipnir_api/bitmap.rb
 lib/sleipnir_api/cli/base.rb
 lib/sleipnir_api/cli/grepnir.rb
 lib/sleipnir_api/command.rb
 lib/sleipnir_api/commands.rb
 lib/sleipnir_api/dialog.rb
+lib/sleipnir_api/ffi.rb
+lib/sleipnir_api/ffi/base.rb
+lib/sleipnir_api/ffi/gdi32.rb
+lib/sleipnir_api/ffi/kernel32.rb
+lib/sleipnir_api/ffi/struct.rb
+lib/sleipnir_api/ffi/user32.rb
 lib/sleipnir_api/key_state.rb
 lib/sleipnir_api/output.rb
 lib/sleipnir_api/process.rb
@@ -30,6 +38,7 @@ lib/sleipnir_api/profile/key.rb
 lib/sleipnir_api/profile/section.rb
 lib/sleipnir_api/profile/util.rb
 lib/sleipnir_api/registry.rb
+lib/sleipnir_api/screen_captor.rb
 lib/sleipnir_api/searcher.rb
 lib/sleipnir_api/security.rb
 lib/sleipnir_api/sleipnir.rb
@@ -37,7 +46,6 @@ lib/sleipnir_api/tab.rb
 lib/sleipnir_api/tabbed_ie.rb
 lib/sleipnir_api/util.rb
 lib/sleipnir_api/version.rb
-lib/sleipnir_api/win32api.rb
 scripts/gesture2rb.rb
 scripts/make_gesture.rb
 scripts/rdoc_filter.rb
@@ -48,6 +56,7 @@ spec/matchers/exit_with.rb
 spec/matchers/path_eql.rb
 spec/sleipnir_api/cli/grepnir_spec.rb
 spec/sleipnir_api/dialog_mock_spec.rb
+spec/sleipnir_api/ffi_spec.rb
 spec/sleipnir_api/key_state_mock_spec.rb
 spec/sleipnir_api/output_spec.rb
 spec/sleipnir_api/profile_mock_spec.rb

data/README.txt CHANGED

@@ -6,6 +6,7 @@ sleipnir-api は {Sleipnir}[http://www.fenrir.co.jp/sleipnir2-the-world/] の
 COM サーバ (Sleipnir.API) を操作するための Ruby ライブラリです。
 WIN32OLE オブジェクトをラップし、Ruby らしいインターフェイスを提供します。
+また、Sleipnir ウィンドウのスクリーンショットを保存することができます。
 API 仕様は SleipnirAPI を参照してください。
@@ -46,6 +47,15 @@ sleipnir-api は _grepnir_ コマンドが付属しています。
 * Sleipnir 2.xx でのテストはあまりしていません。
+=== ACKNOWLEDGMENTS
+* スクリーンショットの取得周りのコードの多くは Perl の
+  {Win32::CaptureIE}[http://search.cpan.org/~psme/Win32-CaptureIE/]
+  および
+  {Win32::Screenshot}[http://search.cpan.org/~psme/Win32-Screenshot/]
+  を参考にさせていただきました。
 === COPYRIGHT
 Copyright (c) 2007 MIYAMUKO Katsuyuki.

data/TODO.txt CHANGED

@@ -1,5 +1,7 @@
 == TODO
+* スクロール位置が移動しないリロード
+  * exec_command じゃタブごとにできない
 * hilight を自前で実装する
   * Sleipnir 2.x じゃサポートしていない
   * 1.66 で hilight を同じページに対して何回も実行するとだんだん重くなる
@@ -9,10 +11,9 @@
   * sleipnir shell
 * JavaScript の実行
 * Sleipnir の起動・終了を WMI を使わずに実装。
-* Sleipnir の終了時に Window Handle をちゃんと見る。
-* Sleipnir の IE コンポーネント部分の Window Handle の取得。
-  * Internet Explorer_Server
-* ウィンドウの screen shot
+* screen shot
+  * ページごと
+  * ImageMagik
 * Sleipnir.API proxy interface
   * JSON-RPC
   * XML-RPC

data/examples/screenshot.rb ADDED

@@ -0,0 +1,33 @@
+require "thread"
+require "digest"
+$LOAD_PATH << File.join(File.dirname(__FILE__), "../lib")
+require "sleipnir_api"
+lock = Mutex.new
+pnir = SleipnirAPI.connect
+worker = ARGV.collect {|url|
+  Thread.start {
+    tab = lock.synchronize {
+      if url =~ /[a-z]+:\/\//
+        pnir.new_tab(url)
+      else
+        pnir.new_tab("file://#{File.expand_path(url)}")
+      end
+    }
+    sleep 0.1 while tab.busy?
+    sleep 1 # �ꉞ
+    lock.synchronize {
+      digest = Digest::MD5.hexdigest(url)
+      filename = "#{digest}.bmp"
+      puts "#{url} => #{filename}"
+      tab.capture_page(filename)
+    }
+    tab.close
+  }
+}
+worker.each do |t|
+  t.join
+end

data/lib/sleipnir_api.rb CHANGED

@@ -131,7 +131,7 @@ module SleipnirAPI
       unless SleipnirAPI::Process.exist?
         SleipnirAPI::Process.create
       end
-      connect(quit_on_finish, &block)
+      connect0(quit_on_finish, &block)
     end
     #
@@ -154,10 +154,14 @@ module SleipnirAPI
     #     puts tab.document.location.href
     #   end
     #
-    def connect(quit_on_finish = false)
+    def connect(quit_on_finish = false, &block)
       unless SleipnirAPI::Process.exist?
         raise SleipnirAPI::ConnectError, "Sleipnir.API does not running"
       end
+      connect0(quit_on_finish, &block)
+    end
+    def connect0(quit_on_finish) #:nodoc:
       pnir = SleipnirAPI::Sleipnir.new(create_sleipnir_ole_object)
       return pnir unless block_given?

data/lib/sleipnir_api/bitmap.rb ADDED

@@ -0,0 +1,113 @@
+require "sleipnir_api/ffi"
+module SleipnirAPI
+  class BitMapSizeError < StandardError #:nodoc:
+  end
+  class BitMap #:nodoc:
+    include SleipnirAPI::FFI::GDI32
+    attr_reader :width, :height
+    def initialize(width, height)
+      @width = width
+      @height = height
+      @data = nil
+    end
+    def header_size
+      BITMAPINFOHEADER.packed_size + BITMAPFILEHEADER.packed_size
+    end
+    def data_size
+      width * height * 4
+    end
+    def data
+      @data ||= "\0" * data_size
+    end
+    def rows
+      (0..height).map{|i| data[i * width * 4, width * 4] }
+    end
+    def replace(bmp)
+      @width = bmp.width
+      @height = bmp.height
+      @data = bmp.data
+    end
+    def concat_bottom!(bmp)
+      if width.zero?
+        replace(bmp)
+      else
+        check_bitmap_size(:width, @width, bmp.width)
+        @data << bmp.data
+        @height += bmp.height
+      end
+    end
+    alias << concat_bottom!
+    def concat_right!(bmp)
+      if height.zero?
+        replace(bmp)
+      else
+        check_bitmap_size(:height, @height, bmp.height)
+        @data = rows.zip(bmp.rows).flatten.join
+        @width += bmp.width
+      end
+    end
+    def check_bitmap_size(key, expected, actual)
+      if expected != actual
+        raise BitMapSizeError, "wrong bitmap #{key}: expected #{expected}px, but was #{actual}px."
+      end
+    end
+    private :check_bitmap_size
+    def create_bitmapfileheader
+      header = BITMAPFILEHEADER.new
+      header.bfType    = "BM".unpack("S")[0]
+      header.bfSize    = header_size + data_size
+      header.bfOffBits = header_size
+      header
+    end
+    alias header create_bitmapfileheader
+    def create_bitmapinfo
+      info = BITMAPINFO.new
+      info.bmiHeader.biSize        = BITMAPINFOHEADER.packed_size
+      info.bmiHeader.biWidth       = width
+      info.bmiHeader.biHeight      = -height # negative because we want top-down bitmap
+      info.bmiHeader.biPlanes      = 1
+      info.bmiHeader.biBitCount    = 32      # we want RGBQUAD data
+      info.bmiHeader.biCompression = BI_RGB
+      info
+    end
+    alias info create_bitmapinfo
+    def save(filename)
+      open(filename, "wb") do |w|
+        pack {|data|
+          w.write data
+        }
+      end
+    end
+    def pack(&block)
+      v = [create_bitmapfileheader.pack, create_bitmapinfo.bmiHeader.pack, @data]
+      if block
+        v.each(&block)
+      else
+        v.join
+      end
+    end
+    def inspect
+      "#<%s:0x%x @width=%d @height=%d @data=...>" % [self.class, self.object_id << 1, @height, @width]
+    end
+  end
+end

data/lib/sleipnir_api/ffi.rb ADDED

@@ -0,0 +1,4 @@
+require "sleipnir_api/ffi/struct"
+require "sleipnir_api/ffi/kernel32"
+require "sleipnir_api/ffi/user32"
+require "sleipnir_api/ffi/gdi32"

data/lib/sleipnir_api/ffi/base.rb ADDED

@@ -0,0 +1,22 @@
+require "Win32API"
+module SleipnirAPI
+  module FFI #:nodoc:
+  end
+  class Win32APIError < StandardError #:nodoc:
+  end
+end
+module SleipnirAPI::FFI
+  module Base #:nodoc:
+    def define_ffi_entry(const, args, ret, lib, entry=const.to_s)
+      api = ::Win32API.new(lib, entry, args, ret)
+      const_set(const, api)
+      define_method(const) do |*args|
+        api.call(*args)
+      end
+      module_function const
+    end
+  end
+end

data/lib/sleipnir_api/ffi/gdi32.rb ADDED

@@ -0,0 +1,165 @@
+require "sleipnir_api/ffi/base"
+require "sleipnir_api/ffi/struct"
+module SleipnirAPI::FFI
+  module GDI32 #:nodoc:
+    extend SleipnirAPI::FFI::Base
+    extend SleipnirAPI::FFI::CStruct
+    define_c_type(:uint8, :BYTE)
+    define_c_type(:uint16, :WORD)
+    define_c_type(:uint32, :DWORD)
+    define_c_type(:int32, :LONG)
+    define_c_struct(:RGBQUAD) {
+      BYTE :rgbBlue
+      BYTE :rgbGreen
+      BYTE :rgbRed
+      BYTE :rgbReserved
+    }
+    define_c_struct(:BITMAPINFOHEADER) {
+      DWORD      :biSize
+      LONG       :biWidth
+      LONG       :biHeight
+      WORD       :biPlanes
+      WORD       :biBitCount
+      DWORD      :biCompression
+      DWORD      :biSizeImage
+      LONG       :biXPelsPerMeter
+      LONG       :biYPelsPerMeter
+      DWORD      :biClrUsed
+      DWORD      :biClrImportant
+    }
+    define_c_struct(:BITMAPINFO) {
+      BITMAPINFOHEADER    :bmiHeader
+      RGBQUAD             :bmiColors, :dim => 1
+    }
+    define_c_struct(:BITMAPFILEHEADER) {
+      WORD    :bfType
+      DWORD   :bfSize, :offset => 2
+      WORD    :bfReserved1
+      WORD    :bfReserved2
+      DWORD   :bfOffBits, :offset => 10
+    }
+    DRIVERVERSION = 0
+    TECHNOLOGY    = 2
+    HORZSIZE      = 4
+    VERTSIZE      = 6
+    HORZRES       = 8
+    VERTRES       = 10
+    BITSPIXEL     = 12
+    PLANES        = 14
+    NUMBRUSHES    = 16
+    NUMPENS       = 18
+    NUMMARKERS    = 20
+    NUMFONTS      = 22
+    NUMCOLORS     = 24
+    PDEVICESIZE   = 26
+    CURVECAPS     = 28
+    LINECAPS      = 30
+    POLYGONALCAPS = 32
+    TEXTCAPS      = 34
+    CLIPCAPS      = 36
+    RASTERCAPS    = 38
+    ASPECTX       = 40
+    ASPECTY       = 42
+    ASPECTXY      = 44
+    DIB_RGB_COLORS = 0
+    DIB_PAL_COLORS = 1
+    # Raster operations
+    SRCCOPY      = 0x00CC0020
+    SRCPAINT     = 0x00EE0086
+    SRCAND       = 0x008800C6
+    SRCINVERT    = 0x00660046
+    SRCERASE     = 0x00440328
+    NOTSRCCOPY   = 0x00330008
+    NOTSRCERASE  = 0x001100A6
+    MERGECOPY    = 0x00C000CA
+    MERGEPAINT   = 0x00BB0226
+    PATCOPY      = 0x00F00021
+    PATPAINT     = 0x00FB0A09
+    PATINVERT    = 0x005A0049
+    DSTINVERT    = 0x00550009
+    BLACKNESS    = 0x00000042
+    WHITENESS    = 0x00FF0062
+    # constants for the biCompression field
+    BI_RGB       = 0
+    BI_RLE8      = 1
+    BI_RLE4      = 2
+    BI_BITFIELDS = 3
+    BI_JPEG      = 4
+    BI_PNG       = 5
+    define_ffi_entry(:BitBlt, 'LIIIILIIL', 'B', 'gdi32')
+    define_ffi_entry(:CreateCompatibleDC, 'L', 'L', 'gdi32')
+    define_ffi_entry(:CreateCompatibleBitmap, 'LII', 'L', 'gdi32')
+    define_ffi_entry(:DeleteDC, 'L', 'B', 'gdi32')
+    define_ffi_entry(:DeleteObject, 'L', 'B', 'gdi32')
+    define_ffi_entry(:GetDIBits, 'LLIIPPI', 'I', 'gdi32')
+    define_ffi_entry(:SelectObject, 'LL', 'L', 'gdi32')
+    module_function
+    def with_delete_dc(hdc)
+      begin
+        yield hdc
+      ensure
+        DeleteDC(hdc)
+      end
+    end
+    def with_delete_object(obj)
+      begin
+        yield obj
+      ensure
+        DeleteObject(obj)
+      end
+    end
+  end
+end
+__END__
+from WinGDI.h
+typedef struct tagBITMAPINFOHEADER{
+        DWORD      biSize;
+        LONG       biWidth;
+        LONG       biHeight;
+        WORD       biPlanes;
+        WORD       biBitCount;
+        DWORD      biCompression;
+        DWORD      biSizeImage;
+        LONG       biXPelsPerMeter;
+        LONG       biYPelsPerMeter;
+        DWORD      biClrUsed;
+        DWORD      biClrImportant;
+} BITMAPINFOHEADER, FAR *LPBITMAPINFOHEADER, *PBITMAPINFOHEADER;
+typedef struct tagRGBQUAD {
+        BYTE    rgbBlue;
+        BYTE    rgbGreen;
+        BYTE    rgbRed;
+        BYTE    rgbReserved;
+} RGBQUAD;
+typedef struct tagBITMAPINFO {
+    BITMAPINFOHEADER    bmiHeader;
+    RGBQUAD             bmiColors[1];
+} BITMAPINFO, FAR *LPBITMAPINFO, *PBITMAPINFO;
+typedef struct tagBITMAPFILEHEADER {
+        WORD    bfType;
+        DWORD   bfSize;
+        WORD    bfReserved1;
+        WORD    bfReserved2;
+        DWORD   bfOffBits;
+} BITMAPFILEHEADER, FAR *LPBITMAPFILEHEADER, *PBITMAPFILEHEADER;