# 通知設計書 84-warnUnknownNotes

## 概要

本ドキュメントは、Nimコンパイラの警告通知「warnUnknownNotes」（未知のノート警告）に関する設計仕様を記載する。

### 本通知の処理概要

本通知は、コマンドラインオプションやプラグマで指定された警告・ヒント名が認識できない場合に警告を発行するものである。これにより、タイプミスや非推奨となったノート名の使用を開発者に通知する。

**業務上の目的・背景**：Nimコンパイラは `--warning:{ノート名}:on/off` や `--hint:{ノート名}:on/off` といったオプションで警告やヒントの有効/無効を制御できる。しかし、ノート名にタイプミスがあったり、古いバージョンで存在していたノート名が現在のバージョンでは存在しない場合、設定が意図通りに適用されない。この警告は、未知のノート名の使用を検出し、開発者に正しいノート名を使用するよう促す。

**通知の送信タイミング**：コマンドラインオプション解析フェーズ（commands.nim内）において、指定されたノート名がwarnMin〜warnMaxまたはhintMin〜hintMaxの範囲で見つからない場合に発行される。

**通知の受信者**：コンパイルを実行している開発者。ターミナルまたはIDEの出力ウィンドウに表示される。

**通知内容の概要**：「unknown {hint/warning}: {指定されたノート名}」という形式で、認識できなかったノート名とその種類を示す。

**期待されるアクション**：開発者は警告を確認し、正しいノート名を使用するようオプションを修正することが期待される。利用可能なノート名は `nim --warnings` や `nim --hints` で確認できる。

## 通知種別

コンパイラ警告（Warning） - ターミナル/IDE出力

## 送信仕様

### 基本情報

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

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

コンパイラの標準エラー出力（stderr）または設定されたwritelnHookに出力される。`--stdout`オプション指定時は標準出力に出力される。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr（デフォルト）/ stdout（--stdout指定時） |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイル名}({行番号}, {列番号}) Warning: unknown {hint/warning}: {ノート名} [UnknownNotes]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | エラーメッセージ本文 | commands.nim内で動的生成 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コマンドライン解析 | --warning/--hintオプション処理 | 指定されたノート名が未知 | commands.nim内でのオプション解析時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:UnknownNotes:off | コマンドラインオプションで抑制可能 |
| {.warning[UnknownNotes]:off.} | プラグマで抑制可能 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[コマンドラインオプション解析] --> B{--warning/--hintオプション?}
    B -->|No| C[他のオプション処理]
    B -->|Yes| D[ノート名を抽出]
    D --> E{ノート名が "all"?}
    E -->|Yes| F[全ノート処理]
    E -->|No| G{有効なノート名?}
    G -->|Yes| H[ノート設定適用]
    G -->|No| I{ヒント/警告のどちらか?}
    I -->|ヒント/警告| J[warnUnknownNotes発行]
    I -->|その他| K[localError発行]
    J --> L[処理継続]
    K --> L
    H --> L
    F --> L
```

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

### 参照テーブル一覧

本通知はデータベースを使用しない。

### 更新テーブル一覧

本通知はデータベースを使用しない。

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| localError | 警告/ヒント以外のコンテキストで未知のノート名 | エラーとして処理される |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

なし。コンパイラ警告メッセージであり、機密情報を含まない。

## 備考

- 警告IDは "UnknownNotes"
- ヒント/警告コンテキストでは警告として発行、それ以外ではエラーとして発行
- `nim --warnings` で利用可能な警告一覧を確認可能
- `nim --hints` で利用可能なヒント一覧を確認可能

---

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

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

### 推奨読解順序

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

警告メッセージの種類と定義を理解する。

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

**読解のコツ**: メッセージテンプレートは "$1" であり、実際のメッセージはcommands.nimで動的に構築される。

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

警告が発行される箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | commands.nim | `compiler/commands.nim` | 205-220行目でノート名の検索と警告発行処理を確認 |

**主要処理フロー**:
1. **207行目**: findNoteテンプレートでノート名を検索
2. **209-210行目**: ノートが見つかればnotesセットに追加
3. **211-215行目**: 見つからなければコンテキストに応じて警告またはエラーを発行
4. **213行目**: message関数呼び出しでwarnUnknownNotesを出力

#### Step 3: ノート検索処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | commands.nim | `compiler/commands.nim` | findStr関数の使用方法と、hintMin〜hintMax、warnMin〜warnMaxの範囲検索を確認 |

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

```
commands.nim: processSwitch (オプション処理)
    │
    ├─ findNote (ノート名検索)
    │      │
    │      └─ findStr (文字列検索)
    │
    └─ msgs.nim: message (警告発行)
           │
           └─ msgs.nim: liMessage (メッセージ処理)
```

### データフロー図

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

コマンドライン ───▶ commands.nim ───▶ ノート名検索
オプション           processSwitch        │
                                          ▼
                                   未知ノート検出
                                          │
                                          ▼
                                   msgs.nim ───▶ stderr/stdout
                                (message関数)     (警告メッセージ)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別定義とメッセージテンプレート |
| commands.nim | `compiler/commands.nim` | ソース | コマンドラインオプション解析、警告発行トリガー |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
