LANCARD.LAB｜ランカードコムのスタッフブログ

EclipseプラグインのJavaEditorへの機能追加について書いていきます。

今回は次のようになっているソースを
「
String aaaa = null;
String b = null;
String ccc = null;
」
イコールの位置で整形する機能を追加してみます。

1.プロジェクト作成する。
　1)Eclipseプラグインの作り方基本編を見てこの手順でプロジェクトを作成してください。
　　今回からActivatorにはちゃんとしたパッケージを指定します。

　　今回はテンプレートは選択しません。

2.plugin.xmlの編集
　1)拡張タブを選択します。

　2)追加ボタンを押します。

　3)ポップアップメニューとして出す予定なので「org.eclipse.ui.popupMenus」を選択します。

　4)「org.eclipse.ui.popupMenus」の上で右クリックし以下のように選択します。

　5)以下のように値を入力します。
　　JavaEditorのIDは「#CompilationUnitEditorContext」になります。

　6)追加したメニューの上で右クリックしactionを登録します。
　　これはこのメニューを選択したときどのclassが実行されるかなどを登録します。

　7)追加したアクションには以下のように記述します。
　　idとclassには「com.lancard.editor.action.FormatAction」
　　menubarpathには「additions」と書きます。

2.クラスの作成
　1)「com.lancard.editor.action.FormatAction」を作成します。

　2)コードは以下のように書きます。

package com.lancard.editor.action;

import org.eclipse.jface.action.IAction;
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.ITextSelection;
import org.eclipse.jface.viewers.ISelection;
import org.eclipse.jface.viewers.ISelectionProvider;
import org.eclipse.ui.IEditorActionDelegate;
import org.eclipse.ui.IEditorPart;
import org.eclipse.ui.texteditor.IDocumentProvider;
import org.eclipse.ui.texteditor.ITextEditor;

public class FormatAction implements IEditorActionDelegate {
private IEditorPart targetEditor = null;
public void run(IAction action) {
ITextEditor textEditor = (ITextEditor)targetEditor;
ISelectionProvider selectionProvider = textEditor.getSelectionProvider();
ISelection selection = selectionProvider.getSelection();
ITextSelection textSelection = (ITextSelection)selection;
textSelection.getStartLine();
try{
execute(textSelection.getStartLine(),textSelection.getEndLine());
}catch(BadLocationException e){
//ログとか出したほうがいい。
}
}
private void execute(int startLine,int endLine) throws BadLocationException {
ITextEditor textEditor = (ITextEditor)targetEditor;
IDocumentProvider provider = textEditor.getDocumentProvider();
IDocument document = provider.getDocument(textEditor.getEditorInput());
int maxIndex = 0;
for(int line=startLine;line<=endLine;line++){
int length = document.getLineLength(line);
int offset = document.getLineOffset(line);
String value = document.get(offset, length);
int equalsIndex = value.indexOf("=");
if(equalsIndex<0){
continue;
}
if(equalsIndex>maxIndex){
maxIndex = equalsIndex;
}
}

for(int line=startLine;line<=endLine;line++){
int length = document.getLineLength(line);
int offset = document.getLineOffset(line);
String value = document.get(offset, length);
int equalsIndex = value.indexOf("=");
if(equalsIndex<0){
continue;
}
if(equalsIndex
　3)一部見つからないクラスが出ると思います。



　4)plugin.xmlに依存関係を登録します。

　　依存関係のタブを開きます。



　　以下のように２つ登録します。


3.実行してみる

　1)適当にjavaファイルを作ります。

　2)エディター上で右クリックします。

　3)以下のようにメニューに機能が追加されていれば成功です。


4.使ってみる

　1)整形する範囲を選択します。



　2)ランカードコム整形を押します。



　　整形されていたら成功です。
5.プラグインファイルの作成

　1)エクスポートウィザードを実行します。

　　plugin.xmlの概要タブの右下のボタンを押します。



　2)以下のように入力し、完了を押したら完成です。



　3)あとは解凍してpluginフォルダの中にあるjarファイルを自分のEclipseのpluginフォルダに入れたら

　　あなただけの独自機能の追加されたEclipseを使うことが出来ます。
6.ソースの説明

　すごく簡単なソースなので、読めばわかると思うので今回はここまでです。

　あとすぐ作りたかったので適当に書いたのですが、もうちょっと奇麗にかけるところがあるかもしれないです・・。
						

Eclipseのプラグインの作り方基本編

1.注意

Eclipseはプラグイン開発用に新しくダウンロードしたEclipseにしたほうがいいです。

仕事で使っている色々入っているEclipseだとめんどくさいことになりがちです。

とりあえず、ここに書いてある内容がならない場合は新しく入れた方がいいです。

今回はEclipseをダウンロードして日本語化しただけのものを使います。

2.プラグインプロジェクトを作る
1)パッケージエクスプローラ上で右クリック→新規→その他を選択

2)プラグイン開発からプラグイン・プロジェクトを選択

3)プロジェクト名に「HelloWorld」と入力します。Eclipseバージョンは書いてある通りターゲットとするEclipseのバージョンになります。
今回はそのままにしておきます。

4)ここは今回は変更しませんが、重要ポイントになります。
①実行環境はターゲットとなるJavaのバージョンになります。これを高くしすぎているといろんな人に使ってもらえなくなります。
　(Eclipseのバージョンもそうです。)
②リッチクライアントプリケーションを作成を「はい」にすると、Eclipse内で動くPluginと違い独立したソフトウェアになります。

5)ここは普通は何も選択する必要はないのですが、どうやって作るのかわからないときのサンプルとしてや
さっさと作りたい場合に使うといいと思います。
今回はHello,Worldを選択します。

6)ここはHello,Worldのアクションクラスの設定です。ここはこのままで問題ありません。完了ボタンを押します。

7)パースペクティブを変更しますか?と出てくると思いますが、「はい」でいいです。
プラグイン開発のパースペクティブのほうが便利です。
以上でプラグインは完成です。

3.実行してみる
1)赤わく部分を押します。

2)もう一つEclipseが立ち上がって、メニューに「サンプルメニュー」というのがついていたら成功です。

4.最後に説明
重要なファイルはActivator.javaとplugin.xmlとbuild.propertiesになります。
①Activator.javaはプラグインそのものを表すクラスになります。
②plugin.xmlはある意味最も重要でここに書く設定で既存プラグインに機能を追加したりしていきます。
③build.propertiesはプラグインにはライブラリーを伴うことが多いのでその設定を書いたりします。