# 通知設計書 92-hintXDeclaredButNotUsed

## 概要

本ドキュメントは、Nimコンパイラにおけるヒント通知「hintXDeclaredButNotUsed」の設計を記載する。この通知は宣言されたが使用されていない変数・定数・関数などをユーザーに通知するためのものである。

### 本通知の処理概要

hintXDeclaredButNotUsed（'$1' is declared but not used）は、Nimコンパイラがスコープ解析時に検出する未使用シンボルに関するヒントメッセージである。

**業務上の目的・背景**：コードの品質向上とメンテナンス性の確保を目的とする。未使用の変数や関数は、コードの可読性を低下させ、将来のバグの温床となる可能性がある。この通知により、開発者は不要なコードを特定し、クリーンアップする機会を得られる。また、意図せず未使用となっている場合（例：タイポによる別名宣言）のバグ発見にも役立つ。

**通知の送信タイミング**：スコープのクローズ時（関数・プロシージャの終了、モジュールの終了など）に、そのスコープ内で宣言されたが一度も使用されなかったシンボルに対して送信される。

**通知の受信者**：コンパイルを実行している開発者。標準エラー出力を通じて通知される。

**通知内容の概要**：「'{シンボル名}' is declared but not used」の形式で、未使用のシンボル名が通知される。

**期待されるアクション**：開発者は通知を受け、該当するシンボルが本当に不要か確認し、不要であれば削除、必要であれば使用するようコードを修正する。

## 通知種別

コンパイラコンソール出力（標準エラー出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 低（ヒント） |
| リトライ | 無 |

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

コンパイラを実行しているプロセスの標準エラー出力に直接出力される。`--hint:XDeclaredButNotUsed:on/off`オプションにより制御される。

## 通知テンプレート

### コンソール出力の場合

| 項目 | 内容 |
|-----|------|
| 送信元 | Nimコンパイラ |
| 出力先 | stderr |
| 形式 | テキスト |

### 本文テンプレート

```
'{シンボル名}' is declared but not used
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | シンボル名 | PSym.name.s | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| スコープ終了 | closeScope実行時 | シンボルが未使用 | スコープ内シンボルの使用状況チェック |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| sfUsed in s.flags | シンボルが使用済みとマークされている |
| sfExported in s.flags | シンボルがエクスポートされている |
| s.kind in {skForVar, skParam, skMethod, skUnknown, skGenericParam, skEnumField} | 特定のシンボル種別は対象外 |
| tfImplicitTypeParam in s.typ.flags | 暗黙の型パラメータは対象外 |
| `--hint:XDeclaredButNotUsed:off` | ヒントが明示的に無効化されている |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[closeScope呼び出し] --> B[ensureNoMissingOrUnusedSymbols]
    B --> C[スコープ内シンボルを反復]
    C --> D{sfUsed or sfExported?}
    D -->|Yes| C
    D -->|No| E{対象外のシンボル種別?}
    E -->|Yes| C
    E -->|No| F{暗黙型パラメータ?}
    F -->|Yes| C
    F -->|No| G[unusedSymsリストに追加]
    G --> C
    C --> H[ソート済みリストを反復]
    H --> I[message hintXDeclaredButNotUsed]
    I --> J[終了]
```

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

### 参照テーブル一覧

コンパイラ内部のシンボルテーブルを参照。データベースは使用しない。

### テーブル別参照項目詳細

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 出力失敗 | stderr書き込みエラー | 処理継続（無視） |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | 制限なし |
| 1日あたり上限 | 制限なし |

### 配信時間帯

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

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

機密情報を含まない。シンボル名が表示されるが、ローカル開発環境での使用が前提であり、特別なセキュリティ対策は不要。

## 備考

- 未使用シンボルはファイルの行番号でソートされて出力される
- エクスポートされたシンボルは使用済みとみなされる（外部モジュールから使用される可能性）
- `{.used.}`プラグマでシンボルを使用済みとマーク可能

---

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

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

### 推奨読解順序

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

まず、シンボルのフラグとスコープの構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | hintXDeclaredButNotUsedの定義（105行目）とメッセージ（215行目） |
| 1-2 | ast.nim | `compiler/ast.nim` | PSymとTSymFlagsの定義、sfUsed・sfExportedフラグ |

**読解のコツ**: sfUsedフラグがシンボル使用時にどのように設定されるかを追跡する。

#### Step 2: エントリーポイントを理解する

スコープクローズ時の未使用チェック処理を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | lookups.nim | `compiler/lookups.nim` | closeScope関数（87-89行目）がエントリーポイント |

**主要処理フロー**:
1. **87行目**: closeScope開始
2. **88行目**: ensureNoMissingOrUnusedSymbols呼び出し
3. **89行目**: rawCloseScope呼び出し

#### Step 3: 未使用チェックロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | lookups.nim | `compiler/lookups.nim` | ensureNoMissingOrUnusedSymbols関数（352-375行目） |

**主要処理フロー**:
- **354-355行目**: シンボルテーブルの反復開始
- **366-372行目**: 未使用シンボルの判定ロジック
- **374-375行目**: ソートしてメッセージ出力

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

```
closeScope (lookups.nim:87)
    │
    ├─ ensureNoMissingOrUnusedSymbols (lookups.nim:352)
    │      ├─ initTabIter (シンボルテーブル反復)
    │      ├─ 未使用判定ロジック
    │      │      ├─ sfUsed チェック
    │      │      ├─ sfExported チェック
    │      │      └─ シンボル種別チェック
    │      ├─ sortedByIt (ファイル位置でソート)
    │      └─ message(hintXDeclaredButNotUsed)
    │
    └─ rawCloseScope (lookups.nim:82)
```

### データフロー図

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

PScope.symbols ───▶ ensureNoMissingOrUnused ───▶ stderr
     │                     │
     ├─ PSym              ├─ flags チェック
     │    ├─ name         ├─ kind チェック
     │    ├─ flags        └─ typ.flags チェック
     │    ├─ kind
     │    └─ typ
     │
     └─ TLineInfo        ───▶ ソートキー
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | hintXDeclaredButNotUsed定義 |
| lookups.nim | `compiler/lookups.nim` | ソース | スコープ管理と未使用チェック |
| ast.nim | `compiler/ast.nim` | ソース | PSym、TSymFlagsの定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
| semdata.nim | `compiler/semdata.nim` | ソース | PContextとスコープ管理 |
