Skip to content

dev-env.md

Latest commit

 

History

History
106 lines (72 loc) · 4.81 KB

dev-env.md

File metadata and controls

106 lines (72 loc) · 4.81 KB
Raw

開発環境

ここでは開発環境の前提条件、ビルド手順、ビルド設定の説明などを記述しています

  • knowbug は サーバー (= dll, C++) と クライアント (= exe, HSP) の2つのプログラムから構成されています
  • ビルド手順は IDE (Visual Studio) を使う方法と、ビルドスクリプトを使う方法の2通りがあります

開発環境の前提条件

  • OS: Windows 10/11

以下をインストールしてください

ビルド手順 (簡易)

サーバー側

  • Visual Studio でソリューション (src/knowbug.sln) を開く
    • メニューバーの「ビルド」→「ソリューションをビルド」を行う
    • ビルドに成功すれば、ビルド出力が src/knowbug_dll/bin/Debug/Win32/hsp3debug.dll (など) に生成されます
    • dllをHSPのインストールディレクトリに置くと、デバッグウィンドウの表示時にロードされます

クライアント側

ソースコードが UTF-8 エンコーディングなので、標準のスクリプトエディタではビルドできません

簡単なのは hsed3s を使うことです

  • src/knowbug_client/kc_main.hsp を開いて実行ファイルを作成します
    • 作成に成功すれば、knowbug_client.exe が生成されます
    • exeをHSPのインストールディレクトリに置くと、(knowbugのdllもインストールされていれば) デバッグウィンドウの表示時に自動で実行されます

また、HSPのサンプルにある sample/misc/mkexe.hsp でも可能なはずです

ビルド設定

ソリューション

  • コンフィギュレーション
    • Debug/Release
      • Debug は knowbug 自体のデバッグ用。
      • Release は配布用。
      • shift_jis ランタイム用
    • DebugUtf8/ReleaseUtf8
      • UTF-8 ランタイム用
  • プラットフォーム
    • x86/x64
      • x86: 32 ビット版
      • x64: 64 ビット版 (hsp3debug_64.dll)
  • 出力
    • src/*/bin/*/*/hsp3debug*.dll

テスト

knowbug_tests プロジェクトを起動するとテストが実行され、一定の動作確認を行えます。(ただしテストコードは少ないです。)

動作確認

./sandbox のサンプルコードなどを使って動作確認を行います。

  • スクリプトの実行中に Visual Studio の「プロセスにアタッチ」(Ctrl+Alt+P)で hsp3.exe を選ぶと knowbug 側のコードをトレース実行できて便利です。
  • knowbug の起動時にシフトキーを押しておくと、knowbug の開始時に停止するようになっていて、アタッチしやすくなります。

ビルドスクリプト (省略可)

scripts にあるビルドスクリプトはビルド操作を自動化するためのものです

以下を前提とします

  • ターミナルの基本的な使いかたの習得
  • PowerShell (pwsh) (バージョン7以上) をインストールしてください

以下の追加の構成が必要です

  • 開発用の HSP3 を配置する
    • ./scripts/dev-install-hsp3 で自動的にインストールできるはずです (Windows Defender にブロックされるので自動で処理できません)
    • knowbug リポジトリ直下に bin ディレクトリを作り、その中に HSP (zip アーカイブ版) を2つ配置
      • 片方は client、他方は server という名前にする
  • 想定するディレクトリツリーは以下の通り
    • knowbug/
      • bin/ ← 作成
        • client/ ← HSPのインストールディレクトリ
          • hsp3.exe ほか
        • server/ ← HSPのインストールディレクトリ
          • hsp3.exe ほか

シンボリックリンク

ビルドで生成される DLL を指すシンボリックリンクをインストールしておくと便利です。

シンボリックリンクを手動で作成するのはめんどうなので、スクリプトを用意しています。管理者用の PowerShell (バージョン 7 以上の方) を開き、以下のスクリプトを実行してください。

./scripts/dev-install-link.ps1

インストール先の環境でスクリプトをデバッグ実行するには ./scripts/run.ps1 が使用できます。./scripts/run-default.ps1 は ./sandbox/default.hsp を実行します。

./scripts/run-default.ps1