Eclipseプラグイン開発

前回Eclipseのスニペット(Snippet)を紹介したのですが、もろもろ紛らわしい機能でして、誤解を与えそうってことでもう少し解説します。

貴方の思う”萌え”と、わたしの思う”萌え”は別なのよ、ということですね。わかりにくい！

えっと、まずは Eclipse3.3 のJDT(Java Development Tools)を前提として、機能を説明します。

■ コード・テンプレート
EclipseでJava開発をしていると、以下のようなコードが自動生成されることがありますよね。

他にも新規にクラスファイルを作成したときなどに自動生成されるコードがあります。

ここで自動生成される雛形はユーザが設定できるようになっています。
[設定]→[Java]→[コード・スタイル]→[コード・テンプレート]

これがコード・テンプレート機能です。

■ テンプレート
Javadocの中で文字列を選択し、Ctrl+Spaceを押すとその文字列をタグで囲むことができます。
“if”と入力してCtrl+Spaceと入力したときに”else if”ブロックなどの補完ができるのもテンプレートです。

これは[設定]→[Java]→[エディター]→[テンプレート]から変更・追加が可能です。
これがテンプレート機能です。

■ スニペット
前回こしあんが紹介したのが、これ。
コードの断片を”ビュー”から挿入することができます。

スニペットはビューです。スニペット・ビュー。大事なことなので2回い（ｒｙ

と、いうわけで以上3つの機能を紹介しました。
どれもコードの断片を貼り付ける機能で同じではないかと思われるかもしれません。まったくその通りで、ユーザにとって機能名などどうでも良いことです。それなのに、わざわざこんな紹介をしたのは、Eclipseプラグイン開発の観点からの便宜上です。

プラグイン開発の話に進む前にEclipse3.4について触れておきます。

Eclipse3.4ではスニペット・ビューが標準で付属していません。これはおそらくですが、JDTに”テンプレート・ビュー”が実装されたためと思われます。
テンプレート・ビューとスニペット・ビューはほぼ役割が同じであるため、スニペット・ビューは付属しなくなったのでしょう。

さて、やっとメイン。Eclipse3.4でスニペット・ビューと同じ機能を持つプラグインを作りたい。
方法は2つ考えられます。

1. WST を同梱し、SnippetContributionsを拡張する
2. AbstractTemplatesPage を実装したクラスを作成する

3.4からは2つ目の方法をとりたいところ。

■ 参考
TemplatesView – Eclipse SDK

ITemplatesPage – Eclipse SDK

スニペット（Snippet）は”断片”のことであり、一般的には、コピペで使えるコードサンプルなどのことを言いますが、Eclipseではエディタ上で定型文を挿入する機能のことを言います（というかそう呼ぶことにします、面倒だから）。

かなり便利な機能なのですが、そんなに活用している人を見かけないので紹介(゜-゜=)

スニペットビューを表示するには[ウィンドウ]→[ビューの表示]→[その他]でダイアログを表示し、「一般」フォルダの中の「スニペット」をクリックします。

ビュー上で右クリック→[カスタマイズ]でユーザが独自に”断片”を登録することができ、インポートやエクスポートも行えるのですが、このとき、ユーザが独自に登録したスニペットは以下のディレクトリにxmlファイルとして保存されます。

※ $workspace は各自のworkspace

このディレクトリ名を見るとわかる通り、スニペットビューはWST(Web Standard Tools)によって提供されています。”Web”と言いつつ、ほぼすべてのEclipseパッケージに付属している（気がする）プラグインなので、 Eclipseプラットフォーム標準の機能であるかのように使えるわけですね。

そしてさらに、このスニペットビューにはextension point「SnippetContributions」が定義してあるため、プラグイン開発者はスニペットビューを拡張することもできます。
この辺は以下のドキュメントを参照してください。単純に挿入したいテキストの設定ならplugin.xmlに書くだけでよいです。

Help – Eclipse SDK

contenttypesとextensionsが思ったように動いてくれないよぅ…(´・ω・｀)

■ 参考
WST Common Snippets subcomponent Overview

Eclipseのプラグイン開発本。

竹添さんのプラグイン開発の良書が出版された今でも読む価値のある書籍です。棲み分けがされているので竹添さんの書かれた本を読んだ後に読むと良いかと思います。

この本の優れたところは、プラグイン開発の具体的な実装方法ではなく、「他のプラグインのコードを真似ろ！」のようなプラグイン開発における心構えを学ぶことができる点です。
そして終盤にはEclipseの優れた設計が解説されています。この部分はかなり読み応えありです。

中級者向けで難易度は低くありませんが本気でプラグインを作ろうと思ったら必読の一冊です。

Eclipseプラグイン開発

TreeViewerのメモ。

ツリーの展開状況の取得と設定

ツリーの状態を保存しておくにはTreeViewer#getExpandedElements()を使います。

TreeViewerのときは取得できるObjectはTreeNodeオブジェクトです。
TreeNodeはコンストラクタでObjectを引数に取り、このObjectのequalsによってTreeNodeの同位性も決まります。

ツリーの開閉時に実行されるリスナーの設定

TreeListenerなるものをviewerに設定しておきます。
ここで気をつけるのはイベントの各メソッドが呼ばれた時点ではツリーの状態は開いていない（閉じていない）ということです。
例えば、treeExpanded内でTreeViewer#getExpandedElements()をコールするとトリガとなったノードは取得できません。TreeExpansionEvent#getElement()で取得します。

ユーザの操作だけではなく、内部でツリーを制御するタイミングでもコールされるようなので、データを操作するときは注意しておきましょう。

Viewの更新タイミング。

暫定的に右クリックメニューに「更新」アクションを追加してたのですが、F5で更新できないの？って話になりました。

あー、そうですよねー、ってことで着手したものの結構ハマったのでメモです。
お忙しい方もいると思うので、例によって先に結果から。

ざっくりだとこんな感じ。F5だのコピーだのペーストだと言った標準的な機能に乗せるときはGlobalActionHandlerに登録しとけってことです。
plugin.xmlで指定すべきなのかも…。

ハマった理由っていうのは、最初”キーバインド”でやるのかにゃーと思い込んでいたからです。
F5 をバインドしてアクション呼び出そうとすると”!MESSAGE A conflict occurred for F5:”となり、かなりイケてないことになります。ログの”ActionHandler(RetargetAction(refresh))”などを頼りにretargetへ行き着くまでに大分時間がかかりました。疲れた！
この仕組みは”リターゲットアクション”でプラグイン開発者には通じるのでしょうか(￣~￣)

Eclipseってヘルプが充実してるのですが、プラグイン開発は用語を知らないとそこまで辿りつけないのが難点ですね。こしあんだけですか。

一度横断的におさえておかないと、と思い立ったので注文しちゃいました。Eclipse本。
ちなみに新版は2009-1-2に発売だそうですよ。慌てて買う必要ありませんでしたね。高いし！とても高いし！

Eclipse: Building Commercial-quality Plug-ins2006 (Eclipse)

【参考】
Help – Eclipse SDK
Eclipse/プラグイン開発のTIPS集/再ターゲット可能なアクション – きのさいと