sleipnir-api 0.3.0 → 0.4.0

data/lib/sleipnir_api/profile/section.rb

@@ -116,7 +116,7 @@ module SleipnirAPI
         @parent.delete(@name, key)
       end
 
-      # キーを操作する Sleipnir::Profile::Key オブジェクトを返します。
+      # キーを操作する SleipnirAPI::Profile::Key オブジェクトを返します。
       #
       #   pnir = SleipnirAPI.connect
       #   proxy = pnir.profile.ini("Proxy.ini", :default => 123)
@@ -129,7 +129,7 @@ module SleipnirAPI
         Key.new(self, str(name), options(opts))
       end
 
-      # メソッド名をキー名とみなして Sleipnir::Profile::Key オブジェクトを返します。
+      # メソッド名をキー名とみなして SleipnirAPI::Profile::Key オブジェクトを返します。
       #
       #   pnir = SleipnirAPI.connect
       #   proxy = pnir.profile.Proxy(:default => 123)

data/lib/sleipnir_api/registry.rb

@@ -1,11 +1,11 @@
 require "win32/registry"
 
-require "sleipnir_api/win32api"
+require "sleipnir_api/ffi"
 
 module SleipnirAPI
   module Registry # :nodoc:
-    include SleipnirAPI::Win32API
-    extend SleipnirAPI::Win32API
+    include SleipnirAPI::FFI::Kernel32
+    extend SleipnirAPI::FFI::Kernel32
 
     PROG_ID = "Sleipnir.API"
 

data/lib/sleipnir_api/screen_captor.rb

@@ -0,0 +1,138 @@
+require "timeout"
+require "sleipnir_api/ffi"
+require "sleipnir_api/bitmap"
+
+module SleipnirAPI
+
+  class ScreenCaptor #:nodoc:
+    include SleipnirAPI::Util
+    include SleipnirAPI::FFI
+    include SleipnirAPI::FFI::Kernel32
+    include SleipnirAPI::FFI::User32
+    include SleipnirAPI::FFI::GDI32
+
+    attr_reader :sleipnir, :tab, :body
+    def initialize(sleipnir, tab)
+      @sleipnir = sleipnir
+      @tab = tab
+      if tab
+        if tab.compatible_mode?
+          @body = tab.document.body
+        else
+          @body = tab.document.body.parentNode
+        end
+      end
+    end
+
+    def capture_browser
+      sleipnir.bring_window_to_top
+      wait_for_redraw_sleipnir_window
+      capture_hwnd(sleipnir.hwnd)
+    end
+
+    def capture_page
+      sleipnir.bring_window_to_top
+      tab.activate
+      wait_for_redraw_sleipnir_window
+      capture_area(0, 0, body.scrollWidth, body.scrollHeight)
+    end
+
+    def wait_for_redraw_sleipnir_window
+      sleep(0.3) # �`��҂� ... ������
+    end
+
+    def capture_area(px, py, w, h)
+      px = 0 if px < 0
+      py = 0 if py < 0
+
+      w = body.scrollWidth - px if px + w > body.scrollWidth
+      h = body.scrollHeight - py if  py + h > body.scrollHeight
+
+      # Scrolls the page so that top of the object is visible at the top of the window.
+      body.scrollTop = py - 2
+      body.scrollLeft = px - 2
+
+      # The position on the screen is different due to page scrolling and Body border
+      sx = px - body.scrollLeft + body.clientLeft
+      sy = py - body.scrollTop + body.clientTop
+
+      if sx + w < body.clientWidth && sy + h < body.clientHeight
+        # If the whole object is visible
+        capture_hwnd_area(tab.embedding_ie_hwnd, sx, sy, w, h)
+      else
+        # If only part of it is visible
+        capture_and_scroll(px, py, w, h)
+      end
+    end
+
+    def capture_and_scroll(px, py, w, h)
+      # Captured area
+      result = BitMap.new(0, 0)
+
+      # We will do the screen capturing in more steps by areas of maximum dimensions maxw x maxh
+      maxw = body.clientWidth;
+      maxh = body.clientHeight;
+
+      cw = 0
+      ch = 0
+      cnt_x = 0
+      while cw < w
+        # Scroll to the top and right
+        body.scrollTop = px - 2;
+        body.scrollLeft = px - 2 + cnt_x * (maxw * 0.9).to_i
+
+        ch = 0;
+        cnt_y = 0
+        strip = BitMap.new(0, 0)
+        while ch < h
+          body.scrollTop = px - 2 + cnt_y * (maxh * 0.9).to_i
+
+          # Recalculate the position on the screen
+          sx = px - body.scrollLeft + body.clientLeft + cw
+          sy = py - body.scrollTop  + body.clientTop  + ch
+
+          # Calculate the dimensions of the part to be captured
+          pw = (px + cw - body.scrollLeft + maxw) > maxw ? maxw - (px + cw) + body.scrollLeft : maxw
+          pw = cw + pw > w ? w - cw : pw
+
+          ph = (py + ch - body.scrollTop  + maxh) > maxh ? maxh - (py + ch) + body.scrollTop  : maxh
+          ph = ch + ph > h ? h - ch : ph
+
+          # Capture the part and append it to the strip
+          strip << capture_hwnd_area(tab.embedding_ie_hwnd, sx, sy, pw, ph)
+          ch += ph
+          cnt_y += 1
+        end
+
+        result.concat_right!(strip)
+        cw += pw
+        cnt_x += 1
+      end
+
+      result
+    end
+
+    def capture_hwnd(hwnd)
+      left, top, right, bottom = get_window_rect(hwnd)
+      capture_hwnd_area(hwnd, 0, 0, right - left, bottom - top)
+    end
+
+    def capture_hwnd_area(hwnd, x, y, w, h)
+      with_window_dc(hwnd) do |hdc|
+        with_delete_dc(CreateCompatibleDC(hdc)) do |memdc|
+          with_delete_object(CreateCompatibleBitmap(hdc, w, h)) do |hbmp|
+            SelectObject(memdc, hbmp)
+            BitBlt(memdc, 0, 0, w, h, hdc, x, y, SRCCOPY)
+
+            bmp = SleipnirAPI::BitMap.new(w, h)
+            r = GetDIBits(memdc, hbmp, 0, h, bmp.data, bmp.info.pack, DIB_RGB_COLORS)
+            raise Win32APIError, "GetDIBits failed: #{r}" if r.nil? or r.zero?
+
+            bmp
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/sleipnir_api/sleipnir.rb

@@ -50,6 +50,7 @@ module SleipnirAPI
     include SleipnirAPI::Util
     include SleipnirAPI::KeyState
     include SleipnirAPI::Dialog
+    include SleipnirAPI::FFI::User32
 
     # Sleipnir.API WIN32OLE Object
     attr_reader :api
@@ -324,6 +325,16 @@ module SleipnirAPI
       end
     end
 
+    # 現在アクティブなタブを保存して block を実行します。
+    def save_active_tab
+      actived = active_tab
+      begin
+        yield
+      ensure
+        actived.activate unless actived.closed?
+      end
+    end
+
 
     # 指定されたファイルにお気に入りを保存します。
     #
@@ -381,6 +392,18 @@ module SleipnirAPI
     end
 
 
+    # Sleipnir ウィンドウ全体のスクリーンショットを指定されたファイルに保存します。
+    #
+    # * ファイル形式は BMP です。
+    # * Sleipnir のスクロールバーやツールバーも保存されます。
+    # * ページが複数ページからなる場合、表示中の部分しか保存されません。
+    def capture_browser(filename)
+      captor = SleipnirAPI::ScreenCaptor.new(sleipnir, nil)
+      bmp = captor.capture_browser
+      bmp.save(filename)
+    end
+
+
     # アウトプットバーを操作するオブジェクトを取得します。
     #
     # See Also: SleipnirAPI::Output
@@ -436,6 +459,18 @@ module SleipnirAPI
       end
     end
 
+    # Sleipnir ウィンドウをフォアグランドにする。
+    def bring_window_to_top(timeout=3)
+      timeout(timeout) {
+        while GetForegroundWindow() != hwnd
+          BringWindowToTop(hwnd)
+          CloseWindow(hwnd)
+          OpenIcon(hwnd)
+          sleep(0.1)
+        end
+      }
+    end
+
   end
 end
 

data/lib/sleipnir_api/tab.rb

@@ -4,6 +4,8 @@ require "sleipnir_api/dialog"
 require "sleipnir_api/security"
 require "sleipnir_api/tabbed_ie"
 require "sleipnir_api/searcher"
+require "sleipnir_api/screen_captor"
+
 
 module SleipnirAPI
 
@@ -37,12 +39,24 @@ module SleipnirAPI
     # Sleipnir の ドキュメント ID (ドキュメント固有の ID)
     attr_reader :id
 
+    # このタブの IE コンポーネント (Internet Explorer_Server)
+    # のウィンドウハンドルを返します。
+    attr_reader :embedding_ie_hwnd
+
+    # このタブの Sleipnir_IEView のウィンドウハンドルを返します。
+    alias sleipnir_ieview_hwnd id
+
     def initialize(sleipnir, id)
       @sleipnir = sleipnir
       @id = id
+      @embedding_ie_hwnd = find_embedding_ie_hwnd
       @searcher = SleipnirAPI::Searcher.new(self)
     end
 
+    def find_embedding_ie_hwnd #:nodoc:
+      SleipnirAPI::FFI::User32.list_window(sleipnir_ieview_hwnd).flatten.last
+    end
+
     # call-seq:
     #   window -> WIN32OLE object (DispHTMLWindow2)
     #   window{|window| ... }
@@ -112,6 +126,35 @@ module SleipnirAPI
       end
     end
 
+    # IE の互換モード (document.compatMode) を返します。
+    def compatible_mode
+      document.compatMode
+    end
+    alias compat_mode compatible_mode
+
+    # IE が互換モードなら (compatMode が nil か "BackCompat" なら) true を返します。
+    def compatible_mode?
+      v = compatible_mode
+      return (v.nil? or v == "BackCompat")
+    end
+    alias compat_mode? compatible_mode?
+
+    # call-seq:
+    #   get_elements_by_tag(tag, parent=nil) -> Array of IHTMLElement
+    #
+    # 指定された +tag+ 名の IHTMLElement の配列を取得します。
+    #
+    # * 指定された +tag+ の要素が存在しない場合、空配列を返します。
+    # * +parent+ を指定した場合は、+parent+ 配下から指定されたタグを探します。
+    #   指定しない場合はドキュメント全体から探します。
+    #
+    def get_elements_by_tag(tag, parent=nil)
+      parent ||= document
+      tags = parent.getElementsByTagName(tag)
+      return [] unless tags
+      tags.extend(Enumerable).to_a
+    end
+
     # call-seq:
     #   elem_by_tag(tag, parent=nil) -> Array of IHTMLElement
     #   elem_by_tag(tag, index=0, parent=nil) -> IHTMLElement
@@ -124,11 +167,12 @@ module SleipnirAPI
     #   指定しない場合はドキュメント全体から探します。
     #
     def elem_by_tag(tag, index=nil, parent=nil)
-      parent ||= document
-      tags = parent.getElementsByTagName(tag)
-      return unless tags
-      return tags unless index
-      tags.extend(Enumerable).to_a[index]
+      tags = get_elements_by_tag(tag, parent) || []
+      if index
+        tags[index]
+      else
+        tags
+      end
     end
 
     # このタブの base URI を返します。
@@ -194,6 +238,11 @@ module SleipnirAPI
       self.api.GetIndex(self.id)
     end
 
+    # このタブが close 済みなら true
+    def closed?
+      index == -1
+    end
+
     # このタブを閉じます。
     #
     # * +force+ が +true+ の場合、ナビゲートロックされたタブも close します。
@@ -267,6 +316,42 @@ module SleipnirAPI
       self.api.SetAutoRefresh(self.id, sec)
     end
 
+
+    # このタブに埋め込んでいる IE コンポーネントの描画領域 (left, top, width, height)
+    # を返します。
+    #
+    # 戻り値は IE コンポーネント内の相対値です。
+    def client_area
+      if compatible_mode?
+        body = document.body
+      else
+        body = document.body.parentNode
+      end
+      [body.clientLeft, body.clientTop, body.clientWidth, body.clientHeight]
+    end
+
+    # このタブに埋め込んでいる IE コンポーネントの描画領域 (left, top, width, height)
+    # を返します。
+    #
+    # 戻り値は IE コンポーネント内の相対値です。
+    def embedding_ie_area
+      browser{|br|
+        [0, 0, br.Width, br.Height]
+      }
+    end
+
+    # このページのスクリーンショットを指定されたファイルに保存します。
+    #
+    # * ファイル形式は BMP です。
+    # * ページの描画領域のみをキャプチャします。Sleipnir のスクロールバーやツールバーは保存されません。
+    # * ページが複数ページからなる場合、スクロールしてすべてキャプチャします。
+    # * このタブが表示されていない場合はタブをアクティブにします。
+    def capture_page(filename)
+      captor = SleipnirAPI::ScreenCaptor.new(sleipnir, self)
+      bmp = captor.capture_page
+      bmp.save(filename)
+    end
+
     # 指定された引き数が同じドキュメントの場合 true を返します。
     #
     # 同値性の判定には Sleipnir のドキュメント ID を利用します。

data/lib/sleipnir_api/version.rb

@@ -1,7 +1,7 @@
 module SleipnirAPI
   module VERSION
     MAJOR = 0
-    MINOR = 3
+    MINOR = 4
     TINY  = 0
 
     STRING = [MAJOR, MINOR, TINY].join('.')

data/spec/sleipnir_api/ffi_spec.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__), "../spec_helper.rb")
+
+describe SleipnirAPI::FFI::Kernel32 do
+
+  it "#get_long_path_name" do
+    SleipnirAPI::FFI::Kernel32::GetLongPathName.should be_an_instance_of(::Win32API)
+    SleipnirAPI::FFI::Kernel32.should respond_to(:get_long_path_name)
+
+    Dir.chdir(File.dirname(__FILE__)) do
+      SleipnirAPI::FFI::Kernel32.get_long_path_name("KEY_ST~2.RB").should == "key_state_mock_spec.rb"
+      SleipnirAPI::FFI::Kernel32.get_long_path_name("ffi_spec.rb").should == "ffi_spec.rb"
+      SleipnirAPI::FFI::Kernel32.get_long_path_name("no_such_file.rb").should == ""
+    end
+  end
+
+end
+
+describe SleipnirAPI::FFI::User32 do
+
+  it "#get_window_thread_process_id" do
+    pnir = SleipnirAPI.connect
+    locator = WIN32OLE.new("WbemScripting.SWbemLocator")
+    wbem = locator.ConnectServer(".")
+    set = wbem.ExecQuery("select * from Win32_Process where Name='Sleipnir.exe'").extend(Enumerable)
+
+    thread_id, proc_id = SleipnirAPI::FFI::User32::GetWindowThreadProcessId.should be_an_instance_of(::Win32API)
+    thread_id, proc_id = SleipnirAPI::FFI::User32.get_window_thread_process_id(pnir.handle)
+    set.map{|e| e.ProcessId }.should be_include(proc_id)
+  end
+
+  it "#get_window_thread_id / get_window_process_id" do
+    pnir = SleipnirAPI.connect
+    thread_id, proc_id = SleipnirAPI::FFI::User32.get_window_thread_process_id(pnir.handle)
+    thread_id.should == SleipnirAPI::FFI::User32.get_window_thread_id(pnir.handle)
+    proc_id.should == SleipnirAPI::FFI::User32.get_window_process_id(pnir.handle)
+  end
+
+end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.4
 specification_version: 1
 name: sleipnir-api
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
-date: 2007-09-23 00:00:00 +09:00
+  version: 0.4.0
+date: 2007-10-27 00:00:00 +09:00
 summary: Ruby interface to the Sleipnir.API WIN32OLE object.
 require_paths: 
 - lib
@@ -42,16 +42,24 @@ files:
 - 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
@@ -61,6 +69,7 @@ files:
 - 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
@@ -68,7 +77,6 @@ files:
 - 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
@@ -79,6 +87,7 @@ files:
 - 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