sleipnir-api 0.1.0

data/helper/util.rb

@@ -0,0 +1,19 @@
+def windows?
+  RUBY_PLATFORM =~ /win/
+end
+
+def with_temporary_rename(from, to)
+  mv from, to
+  yield
+ensure
+  mv to, from
+end
+
+def has_dot?
+  if windows?
+    v = `dot -V 2>&1` rescue nil
+    v and v =~ /Graphviz/
+  else
+    `which dot` =~ /\/dot/
+  end
+end

data/lib/sleipnir_api.rb

@@ -0,0 +1,177 @@
+require "win32ole"
+
+require "sleipnir_api/version"
+require "sleipnir_api/registry"
+require "sleipnir_api/process"
+require "sleipnir_api/sleipnir"
+
+#
+# = Overview
+#
+# == Class / Module
+#
+# * SleipnirAPI
+#
+#   このモジュールは Sleipnir の COM サーバ (Sleipnir.API) に接続するための
+#   メソッドを提供します。
+#
+#   まず new または connect を利用して SleipnirAPI::Sleipnir オブジェクトを取得します。
+#
+#   * SleipnirAPI::Sleipnir
+#
+#     Sleipnir 全体を操作する API を定義しています。
+#     各ドキュメントを操作する場合は SleipnirAPI::Sleipnir#tab メソッドで
+#     SleipnirAPI::Tab を取得して行います。
+#
+#     このオブジェクトは SleipnirAPI.new または SleipnirAPI.connect で取得します。
+#
+#     SleipnirAPI::KeyState と SleipnirAPI::Dialog で定義されているメソッドが利用できます。
+#
+#     * SleipnirAPI::Tab
+#
+#       タブ固有の API (Sleipnir.API でドキュメント ID を引数に取る API) を定義しています。
+#
+#       このオブジェクトは Sleipnir.API の ドキュメント ID を抽象化したものです。
+#       実際のドキュメントオブジェクト (DispHTMLDocument) の抽象化は行いません。
+#
+#       SleipnirAPI::KeyState と SleipnirAPI::Dialog で定義されているメソッドが利用できます。
+#       Sleipnir.API の ShiftDown や InputBox はタブ固有の API ではありませんが、
+#       利便性のため SleipnirAPI::Tab でも利用できるようにしてあります。
+#
+#       * SleipnirAPI::Security
+#
+#         各タブのセキュリティ設定を変更する API を定義しています。
+#
+#         SleipnirAPI::Security::Config またはハッシュを利用して設定を変更できます。
+#
+#     * SleipnirAPI::Output
+#
+#       スクリプトのアウトプットバーを操作する API を定義しています。
+#       SleipnirAPI::Sleipnir#output で取得します。
+#
+#     * SleipnirAPI::Profile
+#
+#       ini ファイルを操作する API を定義しています。
+#       SleipnirAPI::Sleipnir#profile で取得します。
+#
+# == Utility
+#
+# * SleipnirAPI::KeyState
+#
+#   Sleipnir.API の ShiftDown, AltDown, CtrlDown の wrapper API を定義します。
+#   SleipnirAPI::Sleipnir および SleipnirAPI::Tab でこのモジュールで定義しているメソッドが利用できます。
+#
+# * SleipnirAPI::Dialog
+#
+#   Sleipnir.API の InputBox や MessegeBox などのダイアログ API を定義します。
+#   SleipnirAPI::Sleipnir および SleipnirAPI::Tab でこのモジュールで定義しているメソッドが利用できます。
+#
+# * SleipnirAPI::VERSION
+#
+#   本ライブラリ (Sleipnir.API の ruby wrapper) のバージョンを定義します。
+#   Sleipnir 自体のバージョンは SleipnirAPI::Sleipnir の version から取得できます。
+#
+#
+# === 非互換性
+#
+# Sleipnir 1.xx と Sleipnir 2.xx で API の動作が違う場合は
+# Sleipnir 1.xx の動作に合わせるようにしてあります。
+# そのため、Sleipnir 2.xx 用に書かれたスクリプトをそのまま
+# 移植すると動かない場合があります。
+#
+# 現時点で判明している動作が違う API は以下のとおりです。
+#
+# * SleipnirAPI::Output#insert
+#
+module SleipnirAPI
+
+  #:stopdoc:
+  class SleipnirError < StandardError; end
+  class ConnectError < SleipnirError; end
+  class ProcessError < SleipnirError; end
+  class NotImplementedError < SleipnirError; end
+  #:startdoc:
+
+  class <<self
+    include SleipnirAPI::Registry
+
+    # call-seq:
+    #    SleipnirAPI.new(quit_on_finish=false) {|pnir| block }
+    #    SleipnirAPI.new() -> SleipniAPI::Sleipnir object
+    #
+    # Sleipnir が起動していない場合は Sleipnir を起動して
+    # Sleipnir.API サーバに接続します。
+    #
+    # 既に起動している場合は、その Sleipnir に接続します。
+    #
+    # ==== params
+    #
+    # * <tt>quit_on_finish</tt>
+    #
+    #   true の場合、block 終了時に Sleipnir を終了します。
+    #   block を指定しない場合、この引数は無視されます。
+    #
+    # ==== return value
+    #
+    # * block を指定しない場合 SleipnirAPI::Sleipnir オブジェクトを返します。
+    # * block を指定した場合は SleipnirAPI::Sleipnir オブジェクトを block の
+    #   引数として block を実行し、block の実行結果を返します。
+    #
+    # ==== example
+    #
+    # Sleipnir を起動して接続、block 終了時に Sleipnir を終了:
+    #
+    #   SleipnirAPI.new(true) do |pnir|
+    #     pnir.each do |tab|
+    #       puts tab.document.location.href
+    #     end
+    #   end
+    #
+    def new(quit_on_finish = false, &block)
+      unless SleipnirAPI::Process.exist?
+        SleipnirAPI::Process.create
+      end
+      connect(quit_on_finish, &block)
+    end
+
+    #
+    # call-seq:
+    #    SleipnirAPI.connect(quit_on_finish=false) {|pnir| block }
+    #    SleipnirAPI.connect() -> SleipniAPI::Sleipnir object
+    #
+    # 既に起動している Sleipnir の Sleipnir.API サーバに接続します。
+    #
+    # Sleipnir が起動していない場合は例外を投げます。
+    #
+    # 引数と戻り値は new と同じです。
+    #
+    # ==== example
+    #
+    # 起動中の Sleipnir に接続 (block を使わない):
+    #
+    #   pnir = SleipnirAPI.connect
+    #   pnir.each do |tab|
+    #     puts tab.document.location.href
+    #   end
+    #
+    def connect(quit_on_finish = false)
+      unless SleipnirAPI::Process.exist?
+        raise SleipnirAPI::ConnectError, "Sleipnir.API does not running"
+      end
+      pnir = SleipnirAPI::Sleipnir.new(create_sleipnir_ole_object)
+      return pnir unless block_given?
+
+      begin
+        yield pnir
+      ensure
+        pnir.quit if quit_on_finish
+      end
+    end
+
+    def create_sleipnir_ole_object
+      WIN32OLE.new(PROG_ID)
+    end
+    private :create_sleipnir_ole_object
+
+  end
+end

data/lib/sleipnir_api/dialog.rb

@@ -0,0 +1,155 @@
+module SleipnirAPI
+
+  #
+  # このモジュールは Sleipnir のダイアログを操作する API を定義しています。
+  #
+  # SleipnirAPI::Sleipnir、SleipnirAPI::Tab クラスでこのモジュールの API を利用できます。
+  #
+  #   pnir.beep
+  #   pnir.message_box("処理が終わりました")
+  #
+  #   tab = pnir.active_tab
+  #   r, v = tab.input_box("パスワード", :mask => true)
+  #   if r == :ok
+  #     puts "パスワード: #{v}"
+  #   else
+  #     puts "キャンセル"
+  #   end
+  #
+  module Dialog
+
+    # Sleipnir のメッセージボックスを表示します。
+    def message_box(message)
+      self.sleipnir.api.MessageBox(message)
+    end
+
+    #
+    # WinAPI::MessageBox を呼び出します。
+    #
+    # * <tt>prompt</tt>: メッセージボックスに表示する文字列を指定します
+    # * <tt>title</tt>: メッセージボックスのタイトルを指定します
+    # * <tt>flag</tt>: WinAPI::MessageBox の値と同じ値を指定します
+    #
+    # 戻り値は WinAPI::MessageBox のと同じ値です。
+    #
+    def msgbox(prompt, title, flag)
+      self.sleipnir.api.MsgBox(prompt, title, flag)
+    end
+
+    # Beep 音を鳴らします。
+    def beep
+      self.sleipnir.api.Beep
+    end
+
+    #
+    # call-seq:
+    #   input_box(prompt)
+    #   input_box(prompt, :default => "default value")
+    #   input_box(prompt, mask => true)
+    #   input_box(prompt, mask => true, :default => "default value")
+    #
+    # 文字列を入力するダイアログを表示します。
+    #
+    # * <tt>:mask</tt> キーワード引数に true を指定した場合、入力欄はマスクで保護されます。
+    # * <tt>:default</tt> キーワード引数で初期値を指定できます。
+    #
+    # 戻り値は押したボタンと入力欄の値を配列で返します。
+    # キャンセルされた場合は、<tt>:default</tt> で指定した値を返します。
+    #
+    #   pnir.input_box("名前", :default => "sleipnir")
+    #   # firefox を入力し ok を押した場合 => [:ok, "firefox"]
+    #   # 〃           cancel を押した場合 => [:cancel, "sleipnir"]
+    #
+    def input_box(prompt, opts = nil)
+      opts ||= {}
+      if opts[:masked] or opts[:mask]
+        r = self.sleipnir.api.MaskedInputBox(prompt, opts[:default])
+      else
+        r = self.sleipnir.api.InputBox(prompt, opts[:default])
+      end
+
+      if self.sleipnir.api.Result.zero?
+        [:cancel, r]
+      else
+        [:ok, r]
+      end
+    end
+
+  end
+end
+
+
+__END__
+
+──────────────────
+[void] MessageBox(string strMessage)
+──────────────────
+
+[説明]
+　Sleipnir のメッセージボックスを表示する。
+
+[引数]
+　strMessgae: 表示するメッセージ
+
+[戻り値]
+　なし
+
+
+─────────
+[void] Beep(void)
+─────────
+
+[説明]
+　Beep 音を鳴らす。
+
+[戻り値]
+　なし
+
+
+───────────────────────────
+[string] InputBox(string strPrompt, string strDefault)
+───────────────────────────
+
+[説明]
+　文字列を入力するダイアログを表示する。
+
+[引数]
+　strPrompt:  プロンプト
+　strDefault: デフォルトの文字列
+
+[戻り値]
+　OK の場合は編集された文字列、Cancel の場合は strDefault
+　※Result プロパティに 1（OK）、0（Cancel）が設定される。
+
+
+─────────────────────────────
+string MaskedInputBox(string strPrompt, string strDefault)
+─────────────────────────────
+
+[説明]
+　マスクで保護された文字列を入力するダイアログを表示する。
+
+[引数]
+　strPrompt:  プロンプト
+　strDefault: デフォルトの文字列
+
+[戻り値]
+　OK の場合は編集された文字列、Cancel の場合は strDefault
+　※Result プロパティに 1（OK）、0（Cancel）が設定される。
+
+
+──────────────────────────────
+[long] MsgBox(string strPrompt, string strTitle, long lFlag)
+──────────────────────────────
+
+[説明]
+　WinAPI::MessageBox を呼び出す。
+
+[引数]
+　strPrompt: メッセージボックスに表示する文字列
+　strTitle:  メッセージボックスのタイトル
+　lFlag:     WinAPI::MessageBox の値と同じ
+
+[戻り値]
+　WinAPI::MessageBox の戻り値と同じ
+

data/lib/sleipnir_api/key_state.rb

@@ -0,0 +1,49 @@
+require "sleipnir_api/util"
+
+module SleipnirAPI
+
+  #
+  # このモジュールは Sleipnir のキーの状態を取得する API を定義しています。
+  #
+  # SleipnirAPI::Sleipnir、SleipnirAPI::Tab クラスでこのモジュールの API を利用できます。
+  #
+  #   pnir.shift_down?
+  #   pnir.alt_down?
+  #   pnir.ctrl_down?
+  #
+  module KeyState
+    include SleipnirAPI::Util
+
+    # Shift キーが押下されている場合 true を返します。
+    #
+    # Sleipnir バージョンが 1.30 より低い場合例外を投げます。
+    def shift_down?
+      ensure_version 130
+      self.sleipnir.api.ShiftDown
+    end
+
+    # Ctrl キーが押下されている場合 true を返します。
+    #
+    # Sleipnir バージョンが 1.30 より低い場合例外を投げます。
+    def ctrl_down?
+      ensure_version 130
+      self.sleipnir.api.CtrlDown
+    end
+
+    # Alt キーが押下されている場合 true を返します。
+    #
+    # Sleipnir バージョンが 1.30 より低い場合例外を投げます。
+    def alt_down?
+      ensure_version 130
+      self.sleipnir.api.AltDown
+    end
+
+  end
+end
+
+__END__
+// 1.30 以降
+
+[bool]   ShiftDown(R)     Shift キーの状態を返す。
+[bool]   CtrlDown(R)      Ctrl キーの状態を返す。
+[bool]   AltDown(R)       Alt キーの状態を返す。

data/lib/sleipnir_api/output.rb

@@ -0,0 +1,319 @@
+require "sleipnir_api/util"
+
+module SleipnirAPI
+
+  #
+  # このクラスは Sleipnir の COM オブジェクト (Sleipnir.API) の wrapper クラスです。
+  # Sleipnir のアウトプットバーを操作する API を定義しています。
+  #
+  # * このオブジェクトは SleipnirAPI::Sleipnir#output で取得します。
+  # * このクラスは Enumerable を include しています。
+  #
+  # 例:
+  #
+  #   pnir = SleipnirAPI.new
+  #   output = pnir.output
+  #   output.clear
+  #   output.show
+  #   output << "foo"
+  #   output << "fooo"
+  #   output << "bar"
+  #   output.count       #=> 3
+  #   output.getlines    #=> ["foo", "fooo", "bar"]
+  #
+  #   # Enumerable method
+  #   output.grep(/foo/) #=> ["foo", "fooo"]
+  #
+  class Output
+    include Enumerable
+    include SleipnirAPI::Util
+
+    # SleipnirAPI::Sleipnir object
+    attr_reader :sleipnir
+
+    def initialize(sleipnir)
+      @sleipnir = sleipnir
+    end
+
+
+    # アウトプットバーの可視状態を取得します。
+    #
+    # Sleipnir バージョンが 1.30 より低い場合例外を投げます。
+    def visible?
+      ensure_version 130
+      api.OutputVisible
+    end
+
+    # アウトプットバーの可視状態を設定します。
+    #
+    # Sleipnir バージョンが 1.30 より低い場合例外を投げます。
+    def visible=(show)
+      ensure_version 130
+      api.OutputVisible=(show) #:nodoc:
+    end
+
+    # アウトプットバーの表示します。
+    #
+    # Sleipnir バージョンが 1.30 より低い場合例外を投げます。
+    def show
+      self.visible = true
+    end
+
+    # アウトプットバーの隠します。
+    #
+    # Sleipnir バージョンが 1.30 より低い場合例外を投げます。
+    def hide
+      self.visible = false
+    end
+
+    # アウトプットバーの選択行の行番号を取得します。
+    #
+    # Sleipnir バージョンが 1.30 より低い場合例外を投げます。
+    def cursor
+      ensure_version 130
+      api.OutputCurSel
+    end
+
+    # アウトプットバーの選択行を設定します。
+    #
+    # Sleipnir バージョンが 1.30 より低い場合例外を投げます。
+    #
+    # * +lineno+ が範囲外の場合、カーソルは -1 に設定されます。
+    def cursor=(lineno)
+      ensure_version 130
+      if (0...count).include?(lineno)
+        api.OutputCurSel=(lineno) #:nodoc:
+      else
+        api.OutputCurSel=(-1) #:nodoc:
+      end
+    end
+
+    # アウトプットでダブルクリックされた時に呼ばれるスクリプトファイルを取得します。
+    #
+    # Sleipnir バージョンが 1.30 より低い場合例外を投げます。
+    def script
+      ensure_version 130
+      api.OutputScript
+    end
+
+    # アウトプットでダブルクリックされた時に呼ばれるスクリプトファイルを設定します。
+    #
+    # Sleipnir バージョンが 1.30 より低い場合例外を投げます。
+    def script=(filename)
+      ensure_version 130
+      api.OutputScript=(filename) #:nodoc:
+    end
+
+
+    # アウトプットに出力されている文字列の行数を取得します。
+    def count
+      api.OutputGetCount
+    end
+
+    # アウトプットの最後に文字列を追加します。
+    #
+    # カーソルは最後に移動します。
+    def add(string)
+      api.OutputAddString(string)
+    end
+    alias << add
+
+    # アウトプットに複数の文字列を追加します。
+    def concat(*strings)
+      strings.flatten.compact.each do |str|
+        add(str)
+      end
+    end
+
+    # アウトプットに文字列を挿入します。
+    #
+    # * 文字列は指定された行に挿入されます。
+    # * カーソルは +n+ に移動します。
+    #
+    # ==== 非互換
+    #
+    # * Sleipnir 2.x では OutputInsertString 後にカーソルは移動しませんが、
+    #   このメソッドはカーソルが移動します。
+    #   Sleipnir 1.x の動作にあわせています。
+    #
+    def insert(n, string)
+      if (0..count).include?(n)
+        api.OutputInsertString(n, string)
+        self.cursor = n if sleipnir.v2?
+      else
+        self.cursor = -1
+      end
+    end
+
+    # アウトプットに文字列を挿入します。
+    #
+    # * 文字列は現在のカーソル行の前行に挿入されます。
+    # * カーソルがさしている行は変わりません (== insert された分カーソル行が +1 されます)
+    def insert_before(string)
+      insert(cursor, string)
+      self.cursor += 1
+    end
+
+    # アウトプットに文字列を挿入します。
+    #
+    # * 文字列は現在のカーソル行の次行に挿入されます。
+    # * カーソルの移動しません。
+    def insert_after(string)
+      c = cursor
+      insert(c + 1, string)
+      self.cursor = c
+    end
+
+    # アウトプットをクリアします。
+    def clear
+      api.OutputClear
+    end
+
+    # アウトプットから指定された行を削除します。
+    #
+    # * 引数を省略すると現在のカーソル行を削除します。
+    # * 削除する行番号は配列や Range を指定可能です。
+    #
+    # 例:
+    #
+    #   o = pnir.output
+    #   o.delete                     # 現在のカーソル行を削除
+    #   o.delete(0)                  # 0 行を削除
+    #   o.delete(1, 3, 5)            # 1, 3, 5 行を削除
+    #   o.delete([1, 3, 5])          # 同上
+    #   o.delete(0...5)              # 0, 1, 2, 3, 4 行を削除
+    #   o.dekete(1, 2..3, 10...15)   # 1, 2, 3, 10, 11, 12, 13, 14 行を削除
+    #
+    def delete(*lines)
+      if lines.empty?
+        delete(self.cursor)
+      else
+        lines.map{|e| Array(e) }.flatten.compact.sort.uniq.reverse.each do |e|
+          api.OutputDeleteString(e)
+        end
+      end
+    end
+
+    # アウトプットから指定された行を取得します。
+    #
+    # * +n+ を省略すると現在のカーソル行の文字列を取得します。
+    # * +n+ が範囲外の場合 +nil+ を返します。
+    def get(n = cursor)
+      if (0...count).include?(n)
+        api.OutputGetString(n)
+      end
+    end
+
+    # アウトプットに出力されている全行を配列で取得します。
+    def getlines
+      (0...count).map{|i| get(i) }
+    end
+
+    # call-seq:
+    #    each {|line| ... }
+    #
+    # アウトプットに出力されている全行を走査します。
+    def each
+      i = 0
+      while i < count
+        self.cursor = i
+        yield get(i)
+        i = i + 1
+      end
+    end
+
+  end
+end
+
+
+__END__
+[bool]   OutputVisible    アウトプットバーの可視状態を取得/設定する。
+[long]   OutputCurSel     アウトプットバーの選択行を取得/設定する。
+[string] OutputScript     アウトプットでダブルクリックされた時に呼ばれるスクリ
+                          プトファイルを取得/設定する。このスクリプトは引数とし
+                          て /output:選択行 が渡される。
+
+────────────
+[long] OutputGetCount()
+────────────
+
+[説明]
+　アウトプットに出力されている文字列の行数を取得する。
+
+[引数]
+　なし
+
+[戻り値]
+　行数
+
+
+─────────────────
+[void] OutputAddString(string str)
+─────────────────
+
+[説明]
+　アウトプットに文字列を追加する。
+
+[引数]
+　str: 出力する文字列
+
+[戻り値]
+　なし
+
+
+───────────────────────
+[void] OutputInsertString(long n, string str)
+───────────────────────
+
+[説明]
+　アウトプットに文字列を挿入する。
+
+[引数]
+　n:   挿入する位置
+　str: 出力する文字列
+
+[戻り値]
+　なし
+
+
+──────────
+[void] OutputClear()
+──────────
+
+[説明]
+　アウトプットをクリアする。
+
+[引数]
+　なし
+
+[戻り値]
+　なし
+
+
+────────────────
+[string] OutputGetString(long n)
+────────────────
+
+[説明]
+　アウトプットから文字列を取得する。
+
+[引数]
+　n: 取得する行
+
+[戻り値]
+　文字列
+
+
+─────────────────
+[void] OutputDeleteString(long n)
+─────────────────
+
+[説明]
+　アウトプットから文字列を削除する。
+
+[引数]
+　n: 削除する行
+
+[戻り値]
+　なし
+