FlashDevelop: 2009年1月アーカイブ

[FlashDevelop] FlashDevelop のプラグインを作ってみる：試作

FlashDevelop のプラグインの作り方をメモ。其の二。

■試しに一からこさえてみる。

# 準備

FD3 ディレクトリ内に CustomPlugin という空のディレクトリを作っておく。

# プロジェクトを作成する

Visual Studio を立ち上げて、ファイル > 新しいプロジェクト(Ctrl + Shift + N)を選択。
開いたテンプレートの中から「空のプロジェクト」を選択して「OK」。

ファイル > Project1.sln の保存(Ctrl + S)を選択。

名前：TestPlugin
場所：先ほど作った CustomPlugin ディレクトリ
ソリューション名：「ソリューションのディレクトリを作成」のチェックをはずしておく

で、「上書き保存」。

ソリューションエクスプローラパネル内の「ソリューション `TestPlugin`(1 プロジェクト)」と表示されているアイコンを右クリック。
「追加 > 既存のプロジェクト」を選択して、

\FD3\FlashDevelop\FlashDevelop.csproj

を選択する。続けて、

\FD3\PluginCore\PluginCore.csproj

も追加しておく。

# ソリューションの設定

ソリューションのアイコンを選択した状態で、「右クリック > プロジェクトの依存関係」を選択。
「プロジェクト」に「TestPlugin」を選択。
「依存先」に「PluginCore」のみチェックを入れておく。

ソリューションパネルから、「FlashDevelop」プロジェクトを選択。
「右クリック > スタートアッププロジェクトに設定」を選択しておく。（FlashDevelop プロジェクトが太字になる。）

「メニュー > ビルド > 構成マネージャ」を開く。
パネル下の「プロジェクトのコンテキスト」というテーブルから、「TestPlugin」の行の「プラットフォーム」箇所を選択（デフォルトではAny CPU になってると思う。）、「新規作成」を選択する。
ダイアログが開くと、以下の設定にして「OK」を押す。

「新しいプラットフォーム」：x86
「設定のコピー元」：Any CPU
「新しいソリューションプラットフォームを作成する」のチェックをはずす。

テーブル内の TestPlugin のプラットフォームの項目が「x86」に変わるが、これを元の「Any CPU」に戻してから、閉じる。
（なぜかこれをしないと出力先が設定しても正しく反映されない。）

以降、"FlashDevelop"、"PluginCore" のプロジェクトは触らないので、ツリーは閉じた状態にしといた方が見やすい。

# TestPlugin プロジェクトの設定

ソリューションパネル内の「参照設定」を右クリック。「参照の追加」を選択。
開いたパネル内のタブから「参照」を選択。
ファイルの選択画面になるので、

\FD3\PluginCore\Bin\Debug\PluginCore.dll

を選択。

続いて、再度「参照の追加」を開く。
「.NET」タブを選択。"System.Drawing", "System.Window.Forms" を追加する。（Ctrl + クリックで複数選択可）

ソリューションパネル内の「TestPlugin」プロジェクトアイコンを選択した状態で、「プロパティ」ボタンを押す。（もしくは、右クリックから「プロパティ」を選択。）
「アプリケーション」タブパネルの「対象のフレームワーク」を「ソリューションパネル内の「TestPlugin」プロジェクトアイコンを選択して」に設定する。

変更すると、一度パネルが閉じるので、再度プロパティパネルを開く。

アプリケーションタブパネルの以下の設定を変更しておく。
アセンブリ名：TestPlugin
規定の名前空間：TestPlugin
出力の種類：クラスライブラリ

ビルドタブパネルの出力先のパスを以下に変更する。

..\..\FlashDevelop\Bin\Debug\Plugins\

# メインクラスの作成

ソリューションパネル内の「TestPlugin」プロジェクトアイコンを選択して、右クリック。
「追加 > クラス」を選択。
ファイル名を「PluginMain.cs」として追加。

以下のコードをソースの上部に追加。

using PluginCore;

AS3 でいう、import だと思う。（includeかな？）

クラスの宣言を以下に変更。

public class PluginMain : IPlugin

太字のところが追記した箇所。

メインクラスは "PluginCore.IPlugin" インターフェースが定義されてないといけない。

「メニュー > 表示 > クラスビュー」で、クラスビューパネルを開く。
TestPlugin のツリーを開いていくと、「IPlugin」が出てくる。
さらに下層に、「IEventHandler」というインターフェースも出てくる。
これをクリックすると定義されたメソッド、プロパティが表示される。

PluginMain クラスは、これらのインターフェースを定義しているので、AS3 同様、実装してやる必要がある。

実装が必要なものは以下。

void HandleEvent(object, PluginCore.NotifyEvent, PluginCore.HandlingPriority)
void Dispose()
void Initialize()
string Author { get; }
string Description { get; }
string Guid { get; }
string Help { get; }
string Name { get; }
object Settings { get; }

# 実行

PluginMain.cs

「メニュー > デバッグ > デバッグ開始(F5)」を実行する。

FlashDevelop が開くが、実際には何も実装していないので、何も起きない。
FlashDevelop の「Tools > Program Settings...(F10)」からSettings パネルを開く。
Plugins の中に「TestPlugin」が追加されていれば、正しくコンパイルできたことになる。

■コードメモ
追記
参照先が間違っていたので書き換えました。

PathHelper.AppDir        // C:\Program Files\FlashDevelop
PathHelper.DocDir        // C:\Program Files\FlashDevelop\Docs
PathHelper.LibraryDir    // C:\Program Files\FlashDevelop\Library
PathHelper.BaseDir       // C:\Documents and Settings\\Local Settings\Application Data\FlashDevelop
PathHelper.DataDir       // C:\Documents and Settings\\Local Settings\Application Data\FlashDevelop\Data
PathHelper.SettingDir    // C:\Documents and Settings\\Local Settings\Application Data\FlashDevelop\Settings
PathHelper.SnippetDir    // C:\Documents and Settings\\Local Settings\Application Data\FlashDevelop\Snippets
PathHelper.TemplateDir   // C:\Documents and Settings\\Local Settings\Application Data\FlashDevelop\Templates
PathHelper.UserAppDir    // C:\Documents and Settings\\Local Settings\Application Data\FlashDevelop
PathHelper.UserPluginDir // C:\Documents and Settings\\Local Settings\Application Data\FlashDevelop\Plugins

UserPluginDir の参照先は実際にはディレクトリが存在しなくて、プラグインのデータは Data ディレクトリ内に入ってるんだけども、これは仕様変更のなごりなんだろうか。
つづく

[FlashDevelop] FlashDevelop のプラグインを作ってみる：準備～導入

FlashDevelop のプラグインの作り方をメモ。

■参照

導入方法についてこちらに簡単な説明が記されている。
Plugin Development - FlashDevelop
開発用のソースコードは Google Code から。
flashdevelop - Google Code

SVN : http://flashdevelop.googlecode.com/svn/trunk/
Visual C# 2008 Express Edition を以下からダウンロード・インストール
Microsoft Visual C# 2008 Express

■導入

まだ、僕自身知識が曖昧なので、間違ってる部分もあるかと思います。ご注意ください。

FlashDevelop は Visual C# で出来ています。
上のリンク先から Visual C# 2008 Express をインストールしておきます。
また、同じく Google Code から FlashDevelop のソースコードも入手しておきます。

使うのは FlashDevelop 3 なので、"FD3" ディレクトリ以下が、使用するソースコードになります。

プラグインディレクトリ

\FlashDevelop\FD3\External\Plugins\SamplePlugin

.csproj が Visual C# のプロジェクトファイルなので、上記ディレクトリに入っている "SamplePlugin.csproj" を開く。

プロジェクトを開くと「ソリューションエクスプローラ」というパネルが表示されています。
（FlashDevelop に UI が非常に似ているのでエディタの使い方は FlashDevelop を使っていれば分かりやすいと思う。）
この中に 3 つのプロジェクトが表示されています。

FlashDevelop - デバッグの実行時に使用される FlashDevelop そのもの
PluginCore - プラグインを作る上で必須となるコアライブラリ
SamplePlugin - 作成中のプラグイン

基本的に "FlashDevelop" と "PluginCore" を変更することはないと思う。

まずは試しにデバッグを実行してみる。
メニューから「デバッグ > デバッグ開始（F5）」で実行。
実行すると、FlashDevelop が起動して、SamplePlugin パネルが表示される。
表示されていない場合は、「View > SamplePlugin（Ctrl + F1）」で表示される。

このサンプルはアクティブな状態のドキュメントが切り替えられたときに、パネルにファイル名を表示するだけのものです。
試しに Ctrl + N で新規ファイルを開いて、タブを切り替えると動作が分かるかと思います。

デバッグの終了は、開いた FlashDevelop を閉じるか、 Shift + F5。

SamplePlugin 構成

SamplePlugin
    +- Properties/
    |    +- AssemblyInfo.cs
    +- 参照設定/
    +- Resources/
    |    +- en_US.resX
    |    +- LocaleHelper.cs
    |
    +- PluginMain.cs
    +- PluginUI.cs
    +- Settings.cs

AssemblyInfo.cs
作成するプラグインに関する情報の定義
書き出したファイル（.dll）のプロパティ開いたときに表示される内容。

en_US.resX
メニューでの表示名、パネルのタイトル、設定での説明文が設定されたファイル。
あんまり意味が理解できてない。
多言語に対応できるようにするためにこうなってんのかな？
画像を埋め込んだりするのも、このリソースファイルってのを使うらしい。

LocaleHelper.cs
リソースファイル内の値を抜き出すためのクラスファイル
en_US.resX で設定した "名前" を GetString() に渡すと値が取得できる。

PluginMain.cs
SamplePlugin のメインクラス

PluginUI.cs
SamplePlugin パネルの UI を定義。
ツールボックスからコンポーネントをドラッグで追加とかできる。
Flex Builder と近い？（Flex Builderを使ったことがない・・・）
「表示 > コード(F7)」でソース表示。

Settings.cs
FlashDevelop の「Tools > Program Settings...(F10)」で設定できる項目を定義する。
開くと "Plugins" のところに "SamplePlugin" が表示されている。その中の設定。

■ちょろっとソースのメモ
PluginMain.cs

//現在開いてるドキュメントのエディタへの参照
ScintillaNet.ScintillaControl sciControl = PluginBase.MainForm.CurrentDocument.SciControl;

//現在開いてるドキュメントのテキストを参照
String text = sciControl.Text;

//現在のキャレットの位置にある単語を取得
String word = sciControl.GetWordFromPosition(sciControl.SelectionStart);

FlashDevelop に適用する
メニュー下の「ソリューション構成」（FlashDevelop で Debug と Release の切り替えを行うコンボボックスみたいなとこ）を "Debug" から "Release" に変更して、ビルド > ソリューションのビルド(F6)を実行する。

SamplePlugin ディレクトリ内に obj ディレクトリが作られて、その中の Release ディレクトリに SamplePlugin.dll が作成される。

\Program Files\FlashDevelop\Plugins

FlashDevelop の "Plugins" ディレクトリ内に生成された.dll ファイルをコピーして、FlashDevelop を起動すると使えるようになります。

FlashDevelop を使って AS3 をごりごり書いてる人は、C# のソース見れば大体何をやってるのかはわかると思う。
ルールの違いが掴めれば、プラグインを作るぐらいのレベルであれば、 AS3 と大して変わらないと思う。

僕自身 C# に触れたのはこれがはじめて。

続く。

« FlashDevelop: 2008年10月 | メインページ | アーカイブ | FlashDevelop: 2009年2月 »

FlashDevelop: 2009年1月アーカイブ

[FlashDevelop] FlashDevelop のプラグインを作ってみる：試作

[FlashDevelop] FlashDevelop のプラグインを作ってみる：準備～導入

検索

カテゴリ

FlashDevelop: 2009年1月: 月別アーカイブ