# 通知設計書 58-warnDestructor

## 概要

本ドキュメントは、Nimコンパイラの警告通知「warnDestructor」（デストラクタを持つ型の不適切な使用）の設計仕様を記載する。この警告は、デストラクタを持つ型が、デストラクタを実行できないコンテキストで使用された場合に発生する。

### 本通知の処理概要

**業務上の目的・背景**：この警告は、リソース管理の問題を検出することを目的としている。Nimではデストラクタ（`=destroy`フック）を使用してリソースの自動解放を行うが、特定のコンテキスト（例：グローバル変数、特定のコンテナ内など）ではデストラクタが適切に呼び出されない場合がある。この警告は将来的にコンパイルエラーに昇格する予定であり、早期に問題を検出することを目的としている。

**通知の送信タイミング**：コンパイル時の意味解析フェーズにおいて、デストラクタを持つ型がデストラクタを実行できないコンテキストで使用された場合に発生する。現時点では具体的な呼び出し箇所がコード内で確認できなかったため、将来の実装または特定の条件下でのみ発生する可能性がある。

**通知の受信者**：この警告はコンパイルを実行した開発者に対して、標準エラー出力またはコンパイラが設定した出力先に通知される。

**通知内容の概要**：警告メッセージ「usage of a type with a destructor in a non destructible context. This will become a compile time error in the future.」（デストラクタを持つ型をデストラクタを実行できないコンテキストで使用しています。これは将来コンパイル時エラーになります）が表示される。

**期待されるアクション**：開発者はデストラクタを持つ型の使用方法を見直し、デストラクタが適切に呼び出されるコンテキストで使用するか、リソース管理の方法を変更する必要がある。

## 通知種別

コンパイラ警告（Warning）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル時に即座に出力） |
| 優先度 | 中（警告レベル） |
| リトライ | なし |

### 送信先決定ロジック

標準エラー出力（stderr）に出力される。コンパイラの`--verbosity`オプションや`--warning[Destructor]:off`オプションにより出力を制御可能。

## 通知テンプレート

### コンパイラ出力の場合

| 項目 | 内容 |
|-----|------|
| 送信元 | Nimコンパイラ（nim c） |
| 重大度 | Warning |
| メッセージキー | Destructor |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Warning: usage of a type with a destructor in a non destructible context. This will become a compile time error in the future. [Destructor]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| ファイルパス | ソースファイルの絶対または相対パス | TLineInfo.fileIndex | Yes |
| 行番号 | 警告箇所の行番号 | TLineInfo.line | Yes |
| 列番号 | 警告箇所の列番号 | TLineInfo.col | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | デストラクタ持ち型の使用 | デストラクタを実行できないコンテキスト | 詳細な条件は実装に依存 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `{.warning[Destructor]:off.}` | プラグマによる警告抑制 |
| `--warning:Destructor:off` | コマンドラインオプションによる抑制 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[型の使用検出] --> B{デストラクタを持つ型?}
    B -->|No| C[チェックスキップ]
    B -->|Yes| D{デストラクタ実行可能なコンテキスト?}
    D -->|Yes| C
    D -->|No| E[warnDestructor発行]
    E --> F[message関数呼び出し]
    F --> G[出力]
    C --> H[終了]
    G --> H
```

## データベース参照・更新仕様

### 参照テーブル一覧

この警告はコンパイラ内部のデータ構造を参照するため、外部データベースは使用しない。

| データ構造 | 用途 | 備考 |
|-----------|------|------|
| PType | 型情報 | デストラクタの有無をチェック |
| TTypeFlags | 型フラグ | tfHasAsgn等をチェック |

### 更新テーブル一覧

なし（読み取り専用のチェック処理）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 将来のエラー | 将来のバージョンでエラーに昇格予定 | 警告メッセージに従って修正 |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | なし |
| リトライ間隔 | - |
| リトライ対象エラー | - |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | なし（発生箇所ごとに1回出力） |

### 配信時間帯

制限なし（コンパイル実行時に即座に出力）

## セキュリティ考慮事項

- ソースコードのパスが出力に含まれるため、ビルドログを公開する際はパス情報に注意が必要

## 備考

- この警告は「将来コンパイル時エラーになる」と明記されている
- `=destroy`フックを持つ型に関連
- 現在のコードベースでは具体的な呼び出し箇所が限定的である可能性
- リソースリークを防ぐための重要な警告

---

## コードリーディングガイド

本通知を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

警告メッセージの種類とメッセージテンプレートを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnDestructorの定義（73行目）とメッセージテンプレート（180行目）を確認 |

**読解のコツ**: メッセージには「This will become a compile time error in the future.」という将来のエラー化予告が含まれている。

#### Step 2: 関連する概念を理解する

デストラクタとリソース管理の概念を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | injectdestructors.nim | `compiler/injectdestructors.nim` | デストラクタ注入処理 |
| 2-2 | liftdestructors.nim | `compiler/liftdestructors.nim` | デストラクタ生成処理 |

**主要処理フロー**:
- `=destroy`フックの自動生成と注入
- デストラクタを持つ型の判定

#### Step 3: 警告の発行箇所を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | - | - | 現在のコードベースでは具体的な呼び出し箇所が確認できなかった |

**備考**: この警告は定義されているが、現在の実装では限定的な条件下でのみ発生する可能性がある。将来のバージョンで使用箇所が追加される可能性がある。

### プログラム呼び出し階層図

```
[詳細な呼び出し階層は現在確認できず]

lineinfos.nim
    └─ warnDestructor定義
           └─ メッセージテンプレート定義
```

### データフロー図

```
[入力]                    [処理]                         [出力]

デストラクタ持ち型   ───▶ コンテキストチェック        ───▶ 警告メッセージ
の使用                      │                              (stderr)
                            ├─ デストラクタ有無判定
                            ├─ コンテキスト判定
                            └─ message()呼び出し
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別・メッセージ定義 |
| injectdestructors.nim | `compiler/injectdestructors.nim` | ソース | デストラクタ注入処理 |
| liftdestructors.nim | `compiler/liftdestructors.nim` | ソース | デストラクタ生成処理 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
