[412] マクロをRubyで書きたい - サクラエディタ マクロBBS

ここで「Ruby でマクロ書けないの？」という話が出てたので対応パッチ作ってみた。

SourceForge.net: Modify: 1929358 - WSH マクロの Ruby、PHP、Phython 対応

Ruby だけじゃなくて PHP や Python にも対応してます。バイナリへのパッチじゃなくてソースへのパッチなので、ひとまずコンパイル環境持ってる人向け。マクロBBS にも書いたけど、本家に取り込まれるかどうかは

[5281] WSH マクロの Ruby、PHP、Phython 対応 - SAKURA Development BBS (ANSI)

ここの反応次第だと思う。

以下今回の対応詳細です。長いので注意。

---

■WSH の開発者向け情報

WSH のクラスその他については、以下のページに説明がある。

Windows Script Interfaces

でもこれだけだとわかりにくいので、旧バージョンのシーケンス図っぽいのを見ておいたほうが理解が深まるかも。

Microsoft Windows Script Interfaces-Introduction

今回のケースだとサクラエディタが scripting host で、PHP やら Ruby やらのエンジンが scripting engine に当たるってことで。

■実装サンプル

はじめは PHP や Ruby の呼び出しをデバッグモードで追ってたんだけど、Scripting host の実装サンプルを見つけた。

Axsh.exe demonstrates how to implement an active scripting host

これの挙動と比べたほうが手っ取り早そうなので、その方法で調査を進めた。PHP や Ruby のデバッグやコンパイルについては、またの機会にネタにしようかと。

■各エンジンのインストールについて

こちらによくまとまっています。

EmEditorのマクロを様々なActiveScriptで書いてみる - テキストエディタ

PHPScript については、.msi のインストーラで PHP→Extensions→Activescript にチェックを入れておけば PHP/ext/php5activescript.dll が勝手にできるはずなので、そのほうが楽かもしれません。もし後述 .reg を使う場合は、念のため PHP→Program→Script Executable→Register *.php も選んでおいたほうがいいと思います。

■調査結果と対応内容について

各言語のインストールについては末尾の参考 URL を見てください。

○Ruby（ActiveScriptRuby）

Ruby マクロを動かすとサクラエディタが落ちてたんだけど、これは AddNamedItem で SCRIPTITEM_GLOBALMEMBERS を指定しなければ解決するみたい。

IActiveScript::AddNamedItem

によると、SCRIPTITEM_GLOBALMEMBERS ってのは追加したオブジェクト（今回でいう Editor）の各要素をグローバルで見れるようにするものらしい。なるほど。それで今まで Editor.InsText("hoge"); と書かずに InsText("hoge"); と書けてたのか。

このフラグを削ると下位互換がなくなる（古いマクロで動かなくなるものもあるかもしれない）わけで、どうするか悩むところ。個人的には Ruby は結構重要ありそうだし対応入れちゃってもいいんじゃないかなと思う。グローバルにメンバがあると、オブジェクトをうまく扱えない言語で便利そうではあるんだけど・・・そもそもオブジェクトを使わずに WSH を使うのが大変そうなので。（後述。Haskell の辺り。）

なお Ruby のマクロは拡張子を .rb で書きます。.rbs ではないので注意。

○PHP（PECL::PHPScript）

まず前提となる動作説明。ブラウザなんかで WSH を使う場合は <script language="PerlScript"> みたいな感じで ScriptEngine を指定するんだけど、サクラエディタや cscript、wscript は拡張子を元にレジストリを調べて ScriptEngine を取得してる。

（例） PerlScript（拡張子 .pls）の場合

HKEY_CLASSES_ROOT\.pls\ →PerlScriptFile

HKEY_CLASSES_ROOT\PerlScriptFile\ScriptEngine\ → PerlScript

と辿ることで ScriptEngine の名前が「PerlScript」であることを知ることができるというわけ。

ところが PHP はレジストリに ScriptEngine を登録してくれないので、自分で登録する必要がある。その拡張子を .php にするか .phps にするか悩んだけど、本家で決めることだと思うので要望を出しておいた。

PECL :: Request #13538 :: .php file can't be executed by cscript.exe

今回はより設定項目が少ない .php でやってみた。その場合のレジストリ追記用 .reg ファイルについては、Patch と一緒にアップロードしてるのでそちらを使ってください。（よく考えたら PHP インストール時に .php の関連付けをやってないと HKEY_CLASSES_ROOT\.php\ → PHPFile の設定が無いかも・・・。）

で、ここからが本題。挙動を調査したところ、CWSHSite::CWShQueryInterface で IID_IActiveScriptSite や IID_IUnknown にも S_OK 返さないと動かないみたい。この変更は下位互換あるから問題なし。

○Python

CInterfaceObject::Invoke で wFlags == DISPATCH_PROPERTYGET にも反応してたのがまずいっぽい。この部分を修正すれば一応動いた。マクロの拡張子は .pys で。

でもなぜだか VC++ 経由で起動したプロセスではうまく呼び出せない（サクラが落ちる）。詳細不明だけど、別プロセスにアタッチした場合はちゃんと動作してるので VC++ 2005 EE の問題か何かかなと思ってる。

■挫折したもの

○Tcl

TclScript: Tcl Active Script Engine

という scripting engine がある。最終更新が 2001-07-23 なので少々不安。
（scripting engine として ActiveTcl を紹介してる人もいるけど・・・これって scripting engine 含まれてないよね？）

で、TclScript をインストールしようとしたけど、regsvr32 でエラーになってしまう。ドキュメントに「The dll is a debug build linked with Tcl and Tk 8.3.」なんてことが書いてあったから、古い Tcl を探さないといけないのかな？

サンプルとか見てみたけど、もし動かせたとしてもオブジェクト扱うのが難しい気がする。あまり便利じゃなさそうなので深みにはまる前にやめておいた。

○Haskell

HaskellScript: About

こちらも最終更新が 1999 年の 5 月ということで不安だったけど、Haskell98 って現時点でも最新の仕様って聞いてるし、インストール自体はうまくいったので試してみた。
「The HaskellScript libraries are written in Haskell98 and compatible with both Hugs98 and GHC 4.0+.」って書いてるけど、GHC じゃ動かないので Hugs98 も入れる必要あり。オートメーション周りのライブラリは GHC でも動作するって意味かな。

で、HTML やら WSH やらのサンプルはちゃんと動作したんだけど、active scripting host の実装サンプルから呼びだすとなんか変なエラー。構文エラーとかじゃないので、スクリプトは間違ってないと思うんだけどなぁ。

import qualified HScript

import qualified Automation



main :: IO ()

main = do object <- HScript.getHostItem "MyObject"

          Automation.method_0_0 "SayHi" $ object

実装サンプルからも動作しないので半ばあきらめつつ、サクラエディタでも動かしてみた。たぶんこんな感じで拡張子 .hash のファイルを作ればいいはず。

import qualified HScript

import qualified Automation



main :: IO ()

main = do editor <- HScript.getHostItem "Editor"

          Automation.method_1_0 "InsText" "test" $ editor

エラーにはならなかったけど、ちゃんと動作してくれないみたい。
まぁ使えるようになったとしても、上記のように結構記述が冗長になってしまう。OOP がベースとしてある WSH の世界には、関数型言語は向かないのかも。

サンプルでは

import HtmlScript



main :: IO ()

main    = do window <- theWindow

             window # alert "Haskell Script Running !"

これくらいまでシンプルに書けるようにしてあったけど、これはモジュール側で window.alert を宣言してるからだったり。利用側でも各メソッドを宣言しないといけないって、それだと WSH の恩恵があまり受けられないような。そんなわけであまり意味ないようなので調査打ち切り。

■その他情報源

○実装サンプル

How to add support for hosing VBScript to your MFC application

CodeGuru: Implementing Active Script Site with ATL

上のほうで挙げた scripting host サンプルはベタな VC++ での実装だったけど、こっちは MFC や ATL でのサンプル。この辺とちゃんと見比べたら Haskell 動作できるようになるかも。（やる気ないけど。）

SamScrpt.exe sample demonstrates implement Active Debugging in an ActiveX Script Engine built in straight C++

scripting engine のほうを実装する場合のサンプル。いずれこっち方向にも手を出すかもしれないのでメモ。

■その他個人的なメモとか

Windows Script Wiki - リンク

なんだか色々便利そうな情報あるのでメモ。

BSTR 覚え書き

デバッグ中に LPOLESTR の出力方法わからなくて調べたら見かけた。メモメモ。

PerlScript - miau's blog?

ここで紹介した ComTrace も調査に使えるかなと思いつつ忘れてた。次回用メモ。

Active Scripting - Wikipedia, the free encyclopedia

Active Script の説明ページ。ここに Haskell って書いてなければこんなに調査時間食わなかったのになぁ。

それにしても、「ActiveScript」でググると「もしかして：ActionScript」とか言われるのはなんとかならないのかな。もしかしないよ。