Small Basic 標準の Text クラスに自家製メソッドを追加する (Small Basic標準のクラスを"上書き"する方法)

Small Basic とは? 再び

もっぱらプログラミングの学習・教育用として Microsoft からリリースされている無償利用可能なプログラミング言語 & 環境である Small Basic。

http://smallbasic.com/

言語仕様が云々というよりも、

• くるくる回る独特のインテリセンス
• 画面右側に常に表示されているヘルプ画面
• 超基本的な機能しか載っていないシンプルなツールバー

などなど、開発環境のシンプルさ・親切さが秀逸。
学習や教育用だけではもったいない。

バリバリのプログラマになりたいわけじゃない。
けれど、日常の業務を自動化したい。
そんな多少は覚えのある人にお勧めしたい言語・開発環境である。

そういう意味では、個人的には日本語プログラミング言語「なでしこ」と、対象ユーザー層がかぶってる気もするなぁ...などと思ったり。

Small Basic には文字列置換がない!?

本題から逸れた。

さてその Small Basic なのだが、文字列を扱う機能が意外と物足りない。
Small Basic 上では、"Text" というクラスを使って文字列の操作を行うのだが、例えば次のようなメソッドは用意されていない。

• 文字列中を任意のサブテキストで置換
• 文字列を指定の区切り文字で分割して配列にする

.NET Framework でいう、System.String.Replace メソッドや、System.String.Split メソッドに相当する機能が、Small Basic では標準で提供されていないようなのだ。

Small Basic 標準で備わっている File クラスを使うと、テキストファイルを1行単位で読み取れるので、読み取ったあとカンマ区切りで文字列を分割できれば、CSV ファイルの読み取りも容易になるのに、もったいない。

もちろん、Small Basic 標準の Text.GetIndex や Text.GetSubText などを駆使すれば、いずれも同じ動作・機能を実装することは可能である。

しかし、こんなときに、容易に自家製のクラス・メソッドを追加可能なのが Small Basic である。

.NETプログラマなら自分の好きなようにクラスを追加できる

詳細は前の投稿を参照していただきたいが、要するに、
「static クラスを収録した .NET クラスライブラリ(.dll)を作って、C:\Program Files\Microsoft\Small Basic\lib フォルダに置くだけ」
である。

これだけで、以後、Small Basic 上でその独自実装した static クラスとその静的メソッドとが使えるようになるのだ（ちゃんと Small Basic のインテリセンスにも出てくる）。

こうして作成したクラスライブラリを、Small Basic の拡張ライブラリと呼ぶらしい。

拡張ライブラリを作れば、置換を行う Replace メソッドや分割を行う Split メソッドを備えた独自クラスを、Small Basic コード内で使えるようになるのだ。

だけど本当は Text クラスにメソッドを追加したいのだけど?

これで Small Basic コード内でも簡潔に文字列の置換や分割が書けるぞ、万歳!
...と喜ぶのは早計である。

Small Basic では、文字列をいじるときは Text クラスを使うのが常である。

ここで、独自実装した Replace や Split メソッドが、Text2 とか MyText とか SuperText とかいうクラスに備わっていたとしても、果たしてこれらメソッドの存在に気づくだろうか?
使いやすいであろうか?

否。
「GetIndex は標準の Text クラス...」
「Replace は拡張ライブラリの MyText クラス... 」
など使いわけるのは無理がある。

ではどうしたらいいだろうか。
いちばん望ましいのは、既存の Text クラスに、独自実装したメソッドを "追加" できることである。

そんなことできるのだろうか?

Small Basic 標準の Text クラスを乗っ取る!

ということで、ちょっと実験してみた。

Small Basic\lib フォルダに、Small Basic の Text とまったく同じラス名 = Text で、独自実装したアセンブリを配置して、何が起きるか試してみたのだ。

こんな感じ。

namespace MyText {

　public static class Text {

　　public static void Foo(){ /* NOP */ }

　}

}

こんなコードを MyText.dll にビルドしてSmall Basic\lib フォルダに配置。

そいて Small Basic を起動すると...

おおっ!

Small Basic の Text クラスが、自家製 Text クラスに置き換わったではないか。

どうやら、Small Basic で標準搭載されているクラスライブラリを "上書き" できるようになっているのだ。
これはすばらしい。

標準Textクラスの拡張版を作るには、標準Textクラスの実装を複写しなくてはいけない

これで、自家製 Text クラスを拡張ライブラリとして配置するだけで、Small Basic 標準の Text クラスは完全に隠され、自家製 Text クラスだけが使われるようになることがわかった。

さて、今回やりたいのは、Small Basic 標準 Text クラスに備わっている既存のメソッド群に、さらにいくつかのメソッドを追加することである。

ということは、自家製 Text クラスには、Small Basic 標準 Text クラスのすべてのメソッドをコピー実装しなくてはならない。

もちろん、このことは単に、Small Basic 標準 Text クラスのメソッド呼び出しを包んだだけの、プロクシメソッドを書けばいいだけの話である。
難しい話ではない。

こんな感じ。

namespace MyText {

　public static class Text {

　　public static Primitive GetLength(Primitive text){

　　　return Microsoft.SmallBasic.Library.Text.GetLength(text);

　　}

　　...

単純に、Small Basic 標準のオリジナルの Text クラスの同名のメソッドをそのまま呼び出しているだけだ。

ただし、いかんせん、コピー実装すべきメソッドの数が少なくない。

さらに大事なのは、XML ドキュメントコメントもコピーする必要がある。
Small Basic のインテリセンスで説明がなかったら最悪だ。

大体、作業が機械的で、ちっとも創造的じゃない。

うーん。
こんな機械的な作業を手作業で実装していくなんて、正気の沙汰とは思えない。
どうしたらよいだろう?

T4テンプレート

そう、こんな時こそ、T4テンプレートの出番だ。

「T4テンプレート」とは、拡張子.tt のテキストファイル。
.tt ファイル中には、「C# ソースコードを生成する C# プログラム」を記述するようになっている。
Visual Studio にてプロジェクトに .tt ファイルを登録しておくと、.tt ファイルが処理されて、.cs ファイルが生成される、という寸法だ。

つまり。
T4テンプレート(.tt)を実装して、Small Basic 標準 Text クラスをリフレクション機能を使って走査、備わっているメソッドのプロクシを機械生成すればよいのだ。

.tt によって機械生成した、標準 Text クラス呼び出しのプロクシメソッド群と、独自実装するメソッド群とを、partial クラスを使って単一の Text クラスに仕上げれば OK である。

拡張 Text クラスの完成!

ということで、Replace や Split などのメソッドが "追加" された、拡張 Text クラスのライブラリが出来上がった。

せっかくなので、CodePlex で公開する。
http://extext4smallbasic.codeplex.com/

ついでに、LEFT や RIGHT、MID に LEN といった、"BASIC っぽい" 文字列操作メソッドも追加しておいた。

利用するだけなら、上記サイトから Windows インストーラ(.msi)をダウンロードして実行、ウィザード画面に従ってインストールすればよい。

当然、ソースコードも公開しているので、Small Basic 標準のクラスを "乗っ取る" ための .tt ファイルなども入手いただける。

教育や学習、タートルグラフィックだけじゃない、事務・実務にも使えそうな Small Basic として、このライブラリがどなたかの役に立てば幸いである。