# バッチ設計書 15-nim-gdb.bat

## 概要

本ドキュメントは、Nimプログラムのデバッグを支援するGDBデバッガ起動用Windowsバッチファイル `nim-gdb.bat` の設計書です。このバッチファイルはNim用のGDB Python拡張モジュールを読み込んでGDBを起動します。

### 本バッチの処理概要

このバッチは、Windows環境でNimプログラムをデバッグする際に、Nim専用のGDB拡張機能を自動的に読み込んだ状態でGDBデバッガを起動します。これにより、Nimの型情報やデータ構造をGDB上で分かりやすく表示できるようになります。

**業務上の目的・背景**：Nimプログラムをデバッグする際、標準のGDBではNimの複雑なデータ構造（シーケンス、文字列、オブジェクト等）が読みにくい形式で表示されます。nim-gdb.pyというPython拡張モジュールを使用することで、これらのデータ構造をNimプログラマに分かりやすい形式で表示できます。このバッチファイルは、その設定を自動化し、開発者がすぐにデバッグを開始できるようにします。

**バッチの実行タイミング**：開発者がNimプログラムのデバッグを行う際に手動で実行します。コマンドラインから `nim-gdb <executable>` の形式で使用します。

**主要な処理内容**：
1. nim.exeのパスからNimルートディレクトリを特定
2. nim-gdb.pyモジュールのパスを構築
3. GDBコマンドファイル（wingdbcommand.txt）を生成
4. GDBをPython拡張を読み込んだ状態で起動
5. 一時ファイル（wingdbcommand.txt）の削除
6. GDBの終了コードを返却

**前後の処理との関連**：このバッチを実行する前に、Nimプログラムがデバッグ情報付きでコンパイルされている必要があります（`--debugger:native`オプション使用）。

**影響範囲**：一時ファイル（wingdbcommand.txt）の作成と削除、GDBプロセスの起動に影響します。

## バッチ種別

開発ツール / デバッグ支援

## 実行スケジュール

| 項目 | 内容 |
|-----|------|
| 実行頻度 | 随時（デバッグ時） |
| 実行時刻 | 任意 |
| 実行曜日 | 任意 |
| 実行日 | 任意 |
| トリガー | 手動実行 |

## 実行条件

### 前提条件

| 条件 | 説明 |
|-----|------|
| Windows環境 | Windowsバッチファイル実行環境が必要 |
| GDBがインストール済み | gdb.exeがPATH上で利用可能であること |
| nim.exeがPATH上にある | Nimルートディレクトリの特定に必要 |
| Pythonサポート付きGDB | GDBがPython拡張をサポートしていること |
| nim-gdb.pyが存在 | tools/debug/nim-gdb.pyが必要 |

### 実行可否判定

nim.exeがPATH上に見つからない場合、NIM_ROOT変数が正しく設定されず、nim-gdb.pyの読み込みに失敗します。

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | デフォルト値 | 説明 |
|-------------|-----|-----|-------------|------|
| %* | 文字列 | No | なし | GDBに渡すすべての引数（デバッグ対象の実行ファイル等） |

### 入力データソース

| データソース | 形式 | 説明 |
|-------------|------|------|
| tools/debug/nim-gdb.py | Pythonスクリプト | GDB用Nim拡張モジュール |

## 出力仕様

### 出力データ

| 出力先 | 形式 | 説明 |
|-------|------|------|
| 標準出力 | テキスト | GDBのデバッグ出力 |
| wingdbcommand.txt | テキストファイル | 一時GDBコマンドファイル（実行後削除） |

### 出力ファイル仕様

| 項目 | 内容 |
|-----|------|
| ファイル名 | wingdbcommand.txt（一時ファイル） |
| 出力先 | カレントディレクトリ |
| 文字コード | ASCII |
| 区切り文字 | N/A |

## 処理フロー

### 処理シーケンス

```
1. エコー抑制
   └─ @echo off でコマンドエコーを無効化
2. nim.exeのパス取得
   └─ for %%i in (nim.exe) でPATH上のnim.exeの場所を特定
3. NIM_ROOT算出
   └─ nim.exeの親ディレクトリの親ディレクトリ（bin/../）を取得
4. nim-gdb.pyパス設定
   └─ %NIM_ROOT%\tools\debug\nim-gdb.py を構築
5. GDB実行ファイル設定
   └─ @NIM_GDB=gdb.exe
6. GDBコマンドファイル生成
   └─ "source <nim-gdb.pyパス>" を wingdbcommand.txt に書き込み
7. GDB起動
   └─ --command="wingdbcommand.txt" オプション付きでGDBを起動、引数を渡す
8. 一時ファイル削除
   └─ wingdbcommand.txt を削除
9. 終了コード返却
   └─ GDBの終了コードで終了
```

### フローチャート

```mermaid
flowchart TD
    A[バッチ開始] --> B[@echo off]
    B --> C[nim.exeのパス検索]
    C --> D[NIM_ROOT算出]
    D --> E[nim-gdb.pyパス設定]
    E --> F[wingdbcommand.txt生成]
    F --> G[GDB起動]
    G --> H[wingdbcommand.txt削除]
    H --> I[終了コード返却]
    I --> J[バッチ終了]
```

## データベース操作仕様

### 操作別データベース影響一覧

このバッチはデータベース操作を行いません。

| 処理 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| N/A | N/A | N/A | N/A |

### テーブル別操作詳細

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| N/A | パス解決失敗 | nim.exeがPATH上にない | Nimをインストールしてnimにパスを通す |
| N/A | ファイル不在 | nim-gdb.pyが存在しない | Nimインストールが完全か確認 |
| N/A | GDB起動失敗 | GDBがインストールされていない | GDBをインストールしてパスを通す |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | N/A |
| リトライ間隔 | N/A |
| リトライ対象エラー | N/A |

### 障害時対応

問題が発生した場合は以下を確認してください：
1. nim.exeがPATH上に存在するか
2. gdb.exeがPATH上に存在するか
3. tools/debug/nim-gdb.pyが存在するか
4. GDBがPythonサポート付きでビルドされているか

## トランザクション仕様

| 項目 | 内容 |
|-----|------|
| トランザクション範囲 | N/A |
| コミットタイミング | N/A |
| ロールバック条件 | N/A |

## パフォーマンス要件

| 項目 | 内容 |
|-----|------|
| 想定処理件数 | 1回の実行 |
| 目標処理時間 | 即座（GDBの起動時間に依存） |
| メモリ使用量上限 | GDBの使用量に依存 |

## 排他制御

wingdbcommand.txtを一時ファイルとして使用するため、同一ディレクトリでの同時実行は競合の可能性があります。異なるディレクトリからの実行を推奨します。

## ログ出力

| ログ種別 | 出力タイミング | 出力内容 |
|---------|--------------|---------|
| GDB出力 | デバッグ中 | GDBのすべての出力 |

## 監視・アラート

| 監視項目 | 閾値 | アラート先 |
|---------|-----|----------|
| N/A | N/A | N/A |

## 備考

- `%~dp$PATH:i` は環境変数PATHから指定ファイルのディレクトリパスを取得するバッチ構文です
- `%~fi` はパスをフルパスに展開します
- `EXIT /B %ERRORLEVEL%` によりGDBの終了コードがそのまま返されます
- nim-gdb.pyは、Nimのseq、string、オブジェクト型などをGDB上で読みやすく表示するpretty-printerを提供します
- UNIX/Linux/macOS環境では、同様の機能を持つ `bin/nim-gdb` シェルスクリプトを使用してください
- デバッグ対象のNimプログラムは、`nim c --debugger:native <file>` でコンパイルする必要があります
