sleipnir-api 0.1.0

data/lib/sleipnir_api/sleipnir.rb

@@ -0,0 +1,489 @@
+require "sleipnir_api/util"
+require "sleipnir_api/tab"
+require "sleipnir_api/output"
+require "sleipnir_api/profile"
+require "sleipnir_api/key_state"
+require "sleipnir_api/dialog"
+
+module SleipnirAPI
+
+  #
+  # このクラスは Sleipnir の COM オブジェクト (Sleipnir.API) の wrapper クラスです。
+  # Sleipnir 全体を操作する API を定義しています。
+  #
+  # * このオブジェクトは SleipnirAPI.new または SleipnirAPI.connect で取得します。
+  # * SleipnirAPI::KeyState と SleipnirAPI::Dialog で定義されているメソッドが利用できます。
+  # * このクラスは Enumerable を include しています。
+  #
+  # 例:
+  #
+  #   pnir = SleipnirAPI.new
+  #   pnir.user_agent = "Ruby/SleipnirAPI"
+  #   pnir.new_tab
+  #   pnir.open("http://www.ruby-lang.org/", true)
+  #
+  #   pnir.count                         #=> 2
+  #   pnir.active_tab.index              #=> 1
+  #   pnir.switch_to_tab("about:blank")  #=> #<SleipnirAPI::Tab:24642128>
+  #   pnir.active_tab.index              #=> 0
+  #   pnir.tabs                          #=> [#<SleipnirAPI::Tab:24642128>, #<SleipnirAPI::Tab:6685682>]
+  #   pnir.active_tab.close              #=> nil
+  #   pnir.count                         #=> 1
+  #
+  #   # Enumerable method
+  #   read, unread = pnir.partition{|tab| tab.read? }
+  #   p read
+  #   p unread
+  #
+  #   alllinks = pnir.inject([]) do |acc,tab|
+  #     links = []
+  #     tab.document.getElementsByTagName("a").each do |a|
+  #       links << a.href if a.href and a.href != ""
+  #     end
+  #     acc + links
+  #   end
+  #   p alllinks
+  #
+  class Sleipnir
+    include Enumerable
+    include SleipnirAPI::Util
+    include SleipnirAPI::KeyState
+    include SleipnirAPI::Dialog
+
+    # Sleipnir.API WIN32OLE Object
+    attr_reader :api
+
+    # Sleipnir のウィンドウハンドル
+    attr_reader :handle
+
+    # Sleipnir のバージョン
+    attr_reader :version
+
+
+    def initialize(api)
+      @api = api
+      @version = api.Version
+      @handle = api.Handle
+    end
+
+    # self を返します。
+    def sleipnir
+      self
+    end
+
+    # Sleipnir 2.xx なら true
+    def v2?
+      self.version >= 200
+    end
+
+    # Sleipnir を終了します。
+    def quit
+      SleipnirAPI::Process.terminate!(self.handle)
+    end
+
+    # アドレスバーの文字列を取得します。
+    def address_bar_string
+      api.AddressBarString
+    end
+
+    # アドレスバーの文字列を設定します。
+    def address_bar_string=(str)
+      api.AddressBarString=(str) #:nodoc:
+    end
+
+    # 検索バーの文字列を取得します。
+    def search_bar_string
+      api.SearchBarString
+    end
+
+    # 検索バーの文字列を設定します。
+    def search_bar_string=(str)
+      api.SearchBarString=(str) #:nodoc:
+    end
+
+    # アクティブなドキュメントの URL を取得します。
+    def url
+      api.URL
+    end
+
+    # アクティブなドキュメントの URL を設定します。
+    def url=(url)
+      api.URL=(url) #:nodoc:
+    end
+
+    # お気に入りファイルを取得します。
+    def favorite_file
+      api.FavoriteFile
+    end
+
+    # お気に入りファイルを設定します。
+    def favorite_file=(filename)
+      api.FavoriteFile=(filename) #:nodoc:
+    end
+
+    # UserAgent を取得します。
+    def user_agent
+      api.UserAgent
+    end
+
+    # UserAgent を設定します。
+    def user_agent=(ua)
+      api.UserAgent=(ua) #:nodoc:
+    end
+
+    # Sleipni API の結果を取得します。
+    def result
+      api.Result
+    end
+
+    # Sleipnir.exe の存在するディレクトリを取得します。
+    def app_path
+      api.AppPath
+    end
+
+    # スクリプトの読み込まれるディレクトリを取得します。
+    def script_path
+      api.ScriptPath
+    end
+
+    # リソースの読み込まれるディレクトリを取得します。
+    def resource_path
+      api.ResourcePath
+    end
+
+    # 各種設定の保存するディレクトリを取得します。
+    def user_path
+      api.UserPath
+    end
+
+
+    # 開かれているドキュメントの数を取得します。
+    def count
+      api.GetCount
+    end
+
+    # call-seq:
+    #   tab(index) -> SleipnirAPI::Tab or nil
+    #
+    # 指定されたタブ位置のドキュメントを返します。
+    # 存在しないタブ位置を指定した場合は nil を返します。
+    #
+    # See Also: SleipnirAPI::Tab
+    #
+    def tab(index)
+      if (0...count).include?(index)
+        SleipnirAPI::Tab.new(self, api.GetDocumentId(index))
+      end
+    end
+
+    # call-seq:
+    #   tabs() -> array of SleipnirAPI::Tab
+    #
+    # すべてのタブに対応する SleipnirAPI::Tab オブジェクトを返します。
+    def tabs
+      (0...count).map{|i| tab(i) }
+    end
+
+    # call-seq:
+    #   each {|tab| ... }
+    #
+    # すべてのタブを走査します。
+    #
+    # block の引数には SleipnirAPI::Tab オブジェクトが渡されます。
+    def each(&block)
+      tabs.each(&block)
+    end
+
+
+    # アクティブなドキュメントのタブ位置を取得します。
+    def active_index
+      api.ActiveIndex
+    end
+
+    # 指定されたタブ位置のドキュメントをアクティブにします。
+    def active_index=(index)
+      api.ActiveIndex=(index) #:nodoc:
+    end
+
+    # call-seq:
+    #   active_tab -> SleipnirAPI::Tab or nil
+    #
+    # アクティブなドキュメントの SleipnirAPI::Tab を取得します。
+    # アクティブなドキュメントが存在しない場合は nil を返します。
+    def active_tab
+      tab(active_index)
+    end
+
+    # call-seq:
+    #   active_document -> DispHTMLDocument or nil
+    #
+    # アクティブなドキュメントの DispHTMLDocument (WIN32OLE オブジェクト) を取得します。
+    # アクティブなドキュメントが存在しない場合は nil を返します。
+    def active_document
+      if t = active_tab
+        t.document
+      end
+    end
+
+
+    # call-seq:
+    #   document(index) -> DispHTMLDocument or nil
+    #
+    # 指定されたタブ位置の DispHTMLDocument (WIN32OLE オブジェクト) を取得します。
+    # 存在しないタブ位置を指定した場合は nil を返します。
+    def document(index)
+      if t = tab(index)
+        t.document
+      end
+    end
+
+    # call-seq:
+    #   documents() -> array of DispHTMLDocument
+    #
+    # すべてのタブに対応する DispHTMLDocument (WIN32OLE オブジェクト) オブジェクトを返します。
+    def documents
+      tabs.map{|e| e.document }
+    end
+
+    # call-seq:
+    #   each_document {|doc| ... }
+    #
+    # すべてのタブのドキュメントオブジェクトを走査します。
+    #
+    # block の引数には DispHTMLDocument (WIN32OLE) オブジェクトが渡されます。
+    def each_document(&block)
+      documents.each(&block)
+    end
+
+
+    # call-seq:
+    #   new_tab(url = "about:blank", active = true) -> SleipnirAPI::Tab
+    #
+    # 新しいタブを作成し SleipnirAPI::Tab を返します。
+    #
+    # * <tt>url</tt> に nil を指定した場合は about:blank を開きます。
+    # * <tt>active</tt> に true を指定した場合、作成したタブがアクティブになります。
+    #
+    def new_tab(url = "about:blank", active = true)
+      docid = api.NewWindow(url || "about:blank", active)
+      SleipnirAPI::Tab.new(self, docid)
+    end
+
+    # call-seq:
+    #   open(url, active = true) -> SleipnirAPI::Tab
+    #
+    # 新しいタブで指定された url を開き SleipnirAPI::Tab を返します。
+    #
+    # <tt>url</tt> を省略できない new_tab です。
+    #
+    def open(url, active = true)
+      new_tab(url, active)
+    end
+
+    # call-seq:
+    #   get_url_tab(url) -> SleipnirAPI::Tab
+    #
+    # 指定された url を表示している最初の SleipnirAPI::Tab を返します。
+    #
+    def get_url_tab(url)
+      tabs.find {|tab| tab.document.location.href == url }
+    end
+
+    # call-seq:
+    #   switch_to_tab(tab_or_url) -> SleipnirAPI::Tab
+    #
+    # 指定された url を表示している最初の SleipnirAPI::Tab をアクティブにして返します。
+    #
+    def switch_to_tab(tab_or_url)
+      case tab_or_url
+      when SleipnirAPI::Tab
+        t = tab_or_url
+      else
+        t = get_url_tab(tab_or_url.to_s)
+      end
+      if t
+        t.activate
+        t
+      end
+    end
+
+
+    # 指定されたファイルにお気に入りを保存します。
+    #
+    # 保存できた場合 true を返します。
+    def save_favorite(filename)
+      api.SaveFavorite(filename)
+    end
+
+    # 最近閉じたページをファイルに上書き保存します。
+    def save_closed_url
+      api.SaveClosedURL
+    end
+
+    # ClosedURL.ini を再度読み込みます。
+    def reload_closed_url
+      api.ReloadClosedURL
+    end
+
+    # 検索バーの履歴に項目を追加します。
+    # 文字列がすでに存在する場合は先頭に移動されます。
+    def add_search_bar_history
+      api.AddSearchBarHistory
+    end
+
+    # Sleipnir の任意のメニューを <tt>cmdid</tt> で指定して実行します。
+    # <tt>cmdid</tt> はマウスジェスチャー (Gesture.ini) 等から参照してください。
+    def exec_command(cmdid)
+      api.ExecCommand(cmdid)
+    end
+
+
+    # アウトプットバーを操作するオブジェクトを取得します。
+    #
+    # See Also: SleipnirAPI::Output
+    def output
+      SleipnirAPI::Output.new(self)
+    end
+
+    # ini ファイルを操作するオブジェクトを取得します。
+    #
+    # See Also: SleipnirAPI::Profile
+    def profile
+      SleipnirAPI::Profile.new(self)
+    end
+
+  end
+end
+
+
+__END__
+[string] AddressBarString アドレスバーの文字列を取得/設定する。
+[string] SearchBarString  検索バーの文字列を取得/設定する。
+[string] URL              アクティブなドキュメントの URL を取得/設定する。
+[long]   ActiveIndex      アクティブなドキュメントのタブ位置を取得/設定する。
+[string] FavoriteFile     お気に入りファイルを取得/設定する。
+[string] AppPath(R)       Sleipnir.exe の存在するディレクトリを返す。
+[string] ScriptPath(R)    スクリプトの読み込まれるディレクトリを返す。
+[string] ResourcePath(R)  リソースの読み込まれるディレクトリ返す。
+[string] UserPath(R)      各種設定の保存するディレクトリを返す。
+[string] UserAgent        UserAgent を取得/設定する。
+[long]   Handle(R)        Sleipnir のウィンドウハンドルを返す。
+[long]   Result           Sleipni API の結果を返す。
+[long]   Version(R)       Sleipnir のバージョンを返す。
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+■ メソッド
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+────────
+[long] GetCount
+────────
+
+[説明]
+　開かれているドキュメントの数を返す。
+
+[引数]
+　なし
+
+[戻り値]
+　開かれているドキュメントの数
+
+
+────────────────
+[long] GetDocumentID(long index)
+────────────────
+
+[説明]
+　ドキュメント固有の ID を取得する。
+
+[引数]
+　index: タブ位置( 0 ～ GetCount-1 )
+
+[戻り値]
+　ドキュメント固有の ID
+
+
+───────────────────────
+[long] NewWindow(string strUrl, bool bActive)
+───────────────────────
+
+[説明]
+　新しくドキュメントを開く。
+
+[引数]
+　strUrl:  新しく開くドキュメントの Url
+　bActive: 新しく開くウィンドウをアクティブにするか
+
+[戻り値]
+　開かれたドキュメント固有の ID
+
+
+────────────────────
+[BOOL] SaveFavorite(string strFileName)
+────────────────────
+
+[説明]
+　お気に入りを保存する。
+
+[引数]
+　strFileName: 保存するファイル名（フルパスで指定）
+
+[戻り値]
+　成功なら true
+
+
+───────────
+[void] SaveClosedURL()
+───────────
+
+[説明]
+　最近閉じたページをファイルに上書き保存する。
+
+[引数]
+　なし
+
+[戻り値]
+　なし
+
+
+────────────
+[void] ReloadClosedURL()
+────────────
+
+[説明]
+　ClosedURL.ini を再度読み込む。
+
+[引数]
+　なし
+
+[戻り値]
+　なし
+
+
+───────────────────
+[void] AddSearchBarHistory(string ss)
+───────────────────
+
+[説明]
+　検索バーの履歴に項目を追加する。文字列がすでに存在する場合は先頭に移動されます。
+
+[引数]
+　ss: 追加する文字列
+
+[戻り値]
+　なし
+
+
+───────────────
+[void] ExecCommand(long cmdID)
+───────────────
+
+[説明]
+　Sleipnir の任意のメニューを cmdID で指定して実行します。cmdID はマウスジェス
+　チャー(Gesture.ini)等から参照してください。
+
+[引数]
+　cmdID: コマンドID
+
+[戻り値]
+　なし