KuinStudio

Creator: Baku

公開日: 2017/4/16

1. About

プログラミング言語KuinをサポートするVisual Studio拡張です。以下の機能をサポートしています。

Kuinプロジェクトの作成
Kuinプロジェクトのビルドおよび実行
.knファイルのシンタックスハイライト

以下の機能はサポートしていませんが、作りたいような気はしています。

インテリセンス
デバッグ実行

動作確認はVisual Studio Community 2017で行っています。

2. Kuin環境について

KuinStudio自体はKuin環境、とくにKuinコンパイラ(kuincl.exe)を同梱していません。使用にあたってはオリジナルの配布元などから取得したものが必要になります。ただし、2017/4/16時点でKuin環境はオリジナル配布元からダウンロードできません。

KuinStudioの作者はKuin環境を持っており、 くいなちゃんライセンスに基づいて再配布する権利がありますが、配布元で非公開にしている事を踏まえて、KuinStudio越しでの再配布も意図的に避けています。

3. 使い方

3.1. インストール

「拡張機能と更新プログラム」でオンラインのタブを開き、KuinStudioで検索してインストールします。

3.2. Kuinコンパイラのパス設定

「ツール」の「オプション」からKuinStudioタブを選択し、CompilerPathへ、PC上にすでにあるkuincl.exeの絶対パスを設定します。

3.3. Kuin用プロジェクト作成

新規プロジェクト作成時にKuin > Kuin Projectを選択します。プロジェクト作成後、main.knのみからなるプロジェクトが新規作成されます。

注意ですが、KuinStudioは現在「単一のKuinプロジェクトのみからなるソリューション」に限って動作確認しています。複数のKuinプロジェクトがあるような構成ではうまく動作しない可能性があります。

3.4. プロジェクトのプロパティ

Kuinプロジェクトのプロパティでは以下の設定ができます(動作チェックはあまり徹底していません)。

Startup File: エントリポイント(main関数)を含む.knファイル名を、.knprojファイルが存在するディレクトリからの相対パスで指定します。プロジェクト作成時にはmain.knが指定されています。
Output File (.exe): 出力ファイル名を、.knprojファイルが存在するディレクトリからの相対パスで指定します。指定しない場合はStartup Fileのディレクトリにout.exeが出力されます。
Icon File (.ico): アイコンファイル名を、.knprojファイルが存在するディレクトリからの相対パスで指定します。指定しなければデフォルトアイコンが適用されます。
- アイコン設定に関してはknown issueがあります。トラブルシューティングの節を参照してください。
Working Directory: デバッグ実行/リリース実行時の作業ディレクトリを指定します。既定値は.であり、.knprojファイルが存在するディレクトリが作業ディレクトリになります。特に理由がない限り変更しないでください。
Application Type: WndまたはCuiを選択します。Wndを選択するとGUIアプリケーションとしてビルドし、Cuiを選択するとCUIアプリケーションとしてビルドされます。Webは現時点では選択できません。
Custom System Directory: 存在するディレクトリを指定した場合、kuinclコンパイラの-sオプションに引数として渡します。既定値は空欄であり、基本的に変更しないでください。

3.5. コマンド

ビルド、Run関連のコマンドを追加しています。以下の点に注意してください。

デバッグビルドとリリースビルドの出力先は区別していません。
ビルド、Runのいずれを行った場合でも、つねにリビルド処理が走ります。
- Kuinはビルドが速いので、わざわざ再ビルドの必要/不要を判定していません。
ビルド結果の出力は、単にkuincl.exeの出力を「出力」ウィンドウに表示するだけです。ビルドの成否は出力ウィンドウの内容で確認してください。

利用可能なコマンドは以下の通りです。いずれも、Kuinプロジェクトを開いた状態で使用可能です。

ビルド > Debug Build (Alt+K, B): リリースフラグなしでビルドします。
ビルド > Release Build (Alt+K, Ctrl+B): リリースフラグありでビルドします。
デバッグ > Debug Build and Run (Alt+K, F5): Debug Buildを行い、成功した場合はプログラムを実行します。
デバッグ > Release Build and Run (Alt+K, Ctrl+F5): Release Buildを行い、成功した場合はプログラムを実行します。

4. トラブルシューティング

4.1. ビルドが通らない

ソースコードがShift JISで保存され、日本語コメントがある場合、ビルドが通らないことがあります。保存時の設定でエンコーディングとして「BOMなしUTF-8(65001)」を選んで保存しなおすか、あるいは根本解決のためにFix File Encoding拡張など、他ツールの使用を検討してください。

4.2. アイコンを指定したのに反映されない

プロジェクトのプロパティでアイコンファイルを指定したにもかかわらず、出力した実行ファイルのアイコンがデフォルトのままになっている場合があります。

この場合、実行ファイルの名前を変えたり、エクスプローラの表示状態を切り替えると反映される場合があります。

KuinStudioの作者にも根本原因は分かっていませんが、icoファイルの構成を変更したり、ファイル名の切り替えで対応してください。あるいは、最終的なリリースビルドはコマンドプロンプトから実施するようにしてください。

5. License

KuinStudioはプロジェクト機能サポートのためにPython tools for Visual Studio(PTVS)のソースコードを用いており、PTVSはApache 2.0 Licenseに従います。
KuinStudio本体として実装した部分はMITライセンスです。
プログラミング言語「Kuin」はくいなちゃんの著作物であり、くいなちゃんライセンスに従います。

6. Contact

(Kuin自体とは関係のなさそうな)KuinStudioへの不具合報告や要望につきましては下記へお願いします。

Twitter: @baku_dreameater
Blog: Bakulog

malaybaku / KuinStudio