WSH用にCOMのIntelliSenseを自動生成する
- C# JavaScript linq.js - 09.08/24
本題、の前にJavaScript用のIntelliSenseの作成方法について。以前、linq.jsにIntelliSense用ファイルを追加した時に利用法を書きましたが、今回はvsdocの作成方法を、ざっと書きます。まずVS2008 SP1とパッチを適用する。hoge.jsに対しhoge-vsdoc.jsを用意するとhoge.jsのかわりにhoge-vsdoc.jsがIntelliSense用に読み込まれる。IntelliSenseでVSが見ているのはメソッド名と引数だけなので、コードの中身はなくてもいい。例えば本来は存在するがprivateメソッドのつもりのものは、vsdoc.js側に書かなければIntelliSenseには表示されない。C#と同様に関数にはXMLドキュメントコメントを記述することが出来る。記述箇所はC#とは異なり開始の波括弧の直下。ドキュメントコメントのタグで現在機能しているものはsummary, params, returnsのみ。特に重要なのはreturns typeで、これにprototypeが存在する関数(ようするにクラスですなー)を指定することで戻り値の型をVSに認識させ、IntelliSenseを働かせることが出来る。ちなみに、ただのオブジェクトだと認識してくれない。
function Hoge(aaa, bbb) { /// <summary>hogehogehogehoge</summary> /// <param name="aaa" type="String">a!a!a!a!a!</param> /// <param name="bbb" type="Optional:Boolean">b?b?b?b?b?</param> /// <returns type="Number"></returns> }
基本はこんな感じ。引数の省略や、型が目で見て分かるので大分書きやすくなります。 で、いつぞやかに作成中とか言っていた通りにlinq.jsをWSH対応させようとしているわけですが、IntelliSense書きの量が思ったよりも膨大なわけです。実は最初は普通に手書きしてました。一応勉強も兼ねて書写みたいなノリで。ですが、あまりにも手間かかりすぎるので自動生成することにしました。こんなの人力でやるもんじゃないですよ。微調整はどちらにせよ必要なのですか、大枠だけでも書きだされていると物凄く楽になる。
static void Main(string[] args) { // add reference and replace dll path var assembly = Assembly.LoadFrom(@"Interop.IWshRuntimeLibrary.dll"); var types = assembly.GetTypes(); var enums = types .Where(t => t.IsEnum) .OrderBy(t => t.Name) .Select(t => string.Format("{0}: \r\n{{\r\n{1}\r\n}}", t.Name, Enum.GetNames(t).Select(s => string.Format("\t{0}: {1}", s, (int)Enum.Parse(t, s))).Join(",\r\n"))); var classes = types .Where(t => t.IsClass) .Select(type => { var bindingFlag = BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly; var properties = type.GetProperties(bindingFlag) .OrderBy(pi => pi.Name) // .Select(pi => string.Format("{0}: {1}", pi.Name, pi.PropertyType.Name .Select(pi => string.Format("{0}: null", pi.Name)); var methods = type.GetMethods(bindingFlag) .Where(mi => !mi.IsSpecialName && mi.Name != "GetEnumerator") .Select(mi => new { mi.Name, Parameters = mi.GetParameters(), ReturnType = mi.ReturnType.Name }) .OrderBy(t => t.Name) .Select(t => string.Format("{0}: function({1})\r\n{{\r\n{2}\t/// <returns type=\"{3}\"></returns>\r\n}}", t.Name, t.Parameters.Select(pi => pi.Name).Join(", "), t.Parameters.Select(pi => string.Format("\t/// <param name=\"{0}\" type=\"{1}{2}\"></param>\r\n", pi.Name, (pi.IsOptional) ? "Optional:" : "", pi.ParameterType.Name.Replace("Void", "void").Replace("Int32", "Number"))) .Join(""), t.ReturnType.Replace("Void", "void").Replace("Int32", "Number"))); var result = properties.Concat(methods).Join(",\r\n"); return string.Format("{0} = function() {{ }}\r\n{0}.prototype =\r\n{{\r\n{1}\r\n}}", Regex.Replace(type.Name, "Class$", ""), result.Split(new string[] { "\r\n" }, StringSplitOptions.None).Select(s => "\t" + s).Join("\r\n")); }); var name = assembly.GetName().Name.Split('.').Last(); File.WriteAllText(name + "_enum.js", string.Format("{0}Enum =\r\n{{\r\n{1}\r\n}}", name, enums.Join(",\r\n").Split(new string[] { "\r\n" }, StringSplitOptions.None).Select(s => "\t" + s).Join("\r\n")), Encoding.UTF8); File.WriteAllText(name + "_class.js", classes.Join("\r\n\r\n"), Encoding.UTF8); } static string Join<T>(this IEnumerable<T> source, string separator) { var index = 0; return source.Aggregate(new StringBuilder(), (sb, o) => (index++ == 0) ? sb.Append(o) : sb.AppendFormat("{0}{1}", separator, o)) .ToString(); }
参照設定で対象のCOMを読み込んで、一旦ビルド。生成されてるInterop.hoge.dllを読み込んで解析、という流れをとってみました。もっとマシなやり方があれば教えてください。コードは、んーと、string.Formatがクドくて見難いですね！ 最初はVSのフォーマッタに後で手動でかければいいや、と思ってたのを、出力状態でちゃんとフォーマットされてるようにと継ぎ接ぎしてたら酷いことに。一回文字列にしたものを改行でバラして再生成とか笑えない。こういうの、HTML/XMLが対象なら何も考えなくてもLinq to Xmlで綺麗に書けるのになあ……。 それ以外はまぁ、こんなものかしらんって感じでしょうか？ リフレクションが絡むとLinq大活躍。Selectがネストしまくるのでクエリ構文の出番はない。リフレクションは掘り進める都合上、ネストが深くなるのでLinqがなかったら、と思うとゾッとします。最近はforの二重ループですらウエエ、とか思ってしまうので。
IWshRuntimeLibraryEnum = { IOMode: { ForReading: 1, ForWriting: 2, ForAppending: 8 } } Folder = function() { } Folder.prototype = { Name: null, ParentFolder: null, Drive: null, CreateTextFile: function(FileName, Overwrite, Unicode) { /// <param name="FileName" type="String"></param> /// <param name="Overwrite" type="Optional:Boolean"></param> /// <param name="Unicode" type="Optional:Boolean"></param> /// <returns type="TextStream"></returns> } }
一部抜粋ですが、こんなようなデータが出力されます。プロパティが全部nullなのは、ここに未指定のものが記述されているとIntelliSenseがエラー起こしてしまうから。例えばDrive: new Drive()で戻り値の型指定が可能といえば可能なのですが、出現位置の上下が問題になってくるので結構面倒くさい。ようはFolderよりも上にDriveがあれば関数が存在するので大丈夫だけど、下にあれば存在しないのでエラー。当たり前といえば当たり前なのですが、ダミーでのIntelliSense作りとしては面倒な問題でして。 この辺は素直に諦めて全部nullで型連鎖を止めてしまうのがお気楽といえばお気楽。あと、Dateはnew Date()にしてもDate.prototypeにしても型指定出来なかったりする問題もある。これは今のところ対処不能。
そんなわけで、linq.js + WSHはわりと順調に作成中なので期待しないでも待っててください。IntelliSenseというだけじゃなく、JScriptではバイト配列が扱いにくいので、扱いやすく出来るような補助メソッドを用意したりとか色々やってたらいつになっても終わらないー。例としてWSHでMD5を作る、とか。.NET Frameworkを通しているのでSHA1でも何でもいけます。これでWSHでwsse認証通してAtomAPIで投稿、とか出来ますね。まあ、もうC#でいいぢゃん、って気がかなりしなくもないですけど、うーん。C#4.0からdynamicが追加されるからCOM連携も楽になるしねえ。ただサイドバーガジェットに使うとか、JavaScriptの用途はまだまだあるもん！(これもSilverlightでやれば？って話がなくもないので、うーん)
