# 通知設計書 29-warnUnknownMagic

## 概要

本ドキュメントは、Nimコンパイラにおける警告通知「warnUnknownMagic」の設計仕様を定義する。この警告は、コンパイラが認識できない`{.magic.}`プラグマの値が使用された場合に発生する警告である。

### 本通知の処理概要

この通知は、`{.magic: "SomeName".}`形式のプラグマで指定されたマジック名がコンパイラ内部のTMagic列挙型に存在しない場合に発生する。マジックプラグマは、コンパイラが特別に認識し最適化や特殊処理を行うシンボルを指定するためのものである。

**業務上の目的・背景**：`{.magic.}`プラグマはシステムライブラリ（system.nim等）で使用される高度な機能であり、コンパイラの内部実装と密接に関連している。未知のマジック名を指定するとコンパイラがクラッシュする可能性があるため、この警告で開発者に潜在的な問題を通知する。通常のアプリケーション開発者がこのプラグマを使用することは稀であり、主にコンパイラ開発者や標準ライブラリ開発者向けの警告である。

**通知の送信タイミング**：コンパイル時のプラグマ処理フェーズで、`{.magic.}`プラグマの値がTMagic列挙型に存在しない場合に送信される。

**通知の受信者**：Nimソースコードをコンパイルしている開発者（特にシステムライブラリ開発者）（標準エラー出力またはIDEツール経由）。

**通知内容の概要**：「unknown magic '$1' might crash the compiler」というメッセージが出力され、$1には認識できないマジック名が代入される。

**期待されるアクション**：開発者はマジック名のスペルを確認し、正しいマジック名を使用する。TMagic列挙型（compiler/ast.nim）を参照して有効なマジック名を確認する。

## 通知種別

コンパイラ警告メッセージ（標準エラー出力 / IDE連携）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中（Warning） |
| リトライ | 無し |

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

標準エラー出力（stderr）に出力される。外部パッケージからのコードの場合、`foreignPackageNotesDefault`設定により出力が制御される（warnUnknownMagicはデフォルトで外部パッケージでも出力される）。

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイル名}({行},{列}) Warning: unknown magic '{マジック名}' might crash the compiler [UnknownMagic]
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 認識できないマジック名 | {.magic.}プラグマの引数 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル | プラグマ処理 | マジック名がTMagic列挙型に存在しない | pragmas.nim:262行目 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:UnknownMagic:off | この特定の警告が無効化されている場合 |
| --warnings:off | 全ての警告が無効化されている場合 |
| マジック名が有効 | s.magic != mNone の場合（正常に認識された場合） |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[{.magic.}プラグマ検出] --> B[マジック名取得]
    B --> C[TMagic列挙型との照合]
    C --> D{マッチするマジック存在?}
    D -->|Yes| E[s.magic設定]
    D -->|No| F[s.magic = mNone]
    E --> G[正常終了]
    F --> H{s.magic == mNone?}
    H -->|Yes| I[warnUnknownMagic発行]
    H -->|No| G
    I --> J[message呼び出し]
    J --> K[liMessage呼び出し]
    K --> L[styledMsgWriteln出力]
    L --> G
```

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

### 参照テーブル一覧

該当なし（コンパイラ内部のTMagic列挙型を参照）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| コンパイラクラッシュ | 未知のマジックでの内部処理 | 警告を出力しユーザーに通知（予防的警告） |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- マジック名がメッセージに含まれるが、機密情報ではないためセキュリティリスクは低い
- システムライブラリに関する内部情報が漏洩する可能性はあるが、影響は限定的

## 備考

- この警告は`foreignPackageNotesDefault`に含まれており、外部パッケージからのコードでもデフォルトで出力される
- システムライブラリ（system.nim等）を修正する際に特に注意が必要
- TMagic列挙型はcompiler/ast.nimで定義されている
- マジックシンボルは言語の基本操作（算術演算、文字列操作など）を最適化するために使用される

---

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

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

### 推奨読解順序

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

まず、メッセージ種別の定義と警告メッセージの文字列を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnUnknownMagicの定義（55行目）、MsgKindToStr配列でメッセージ文字列の定義（149行目） |

**読解のコツ**: warnUnknownMagicは「UnknownMagic」という文字列キーを持つ。メッセージテンプレートには`$1`変数が含まれ、未知のマジック名が代入される。

#### Step 2: 発行箇所を理解する

警告が発行される具体的なコード箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | pragmas.nim | `compiler/pragmas.nim` | pragmaMagic関数（249-262行目）でマジック名の照合と警告発行 |

**主要処理フロー**:
1. **252-254行目**: プラグマの形式チェック
2. **255-257行目**: マジック名の取得（識別子または文字列リテラル）
3. **258-260行目**: TMagic列挙型との照合ループ
4. **262行目**: `if s.magic == mNone: message(c.config, n.info, warnUnknownMagic, v)` で警告発行

#### Step 3: TMagic列挙型を理解する

有効なマジック名の定義を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | ast.nim | `compiler/ast.nim` | TMagic列挙型の定義（多数のマジック値が定義されている） |

**読解のコツ**: TMagic列挙型の各値は先頭に「m」プレフィックスが付いている。プラグマでは「m」を除いた部分を指定する（例：`mEcho` → `{.magic: "Echo".}`）。

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

```
pragmas.pragmaMagic (compiler/pragmas.nim:249)
    │
    ├─ プラグマ引数解析
    │      └─ マジック名取得（文字列または識別子）
    │
    ├─ TMagic列挙型照合
    │      └─ for m in TMagic ループ
    │
    └─ 警告発行（未知の場合）
           │
           └─ message (compiler/msgs.nim:641)
                  │
                  └─ liMessage (compiler/msgs.nim:536)
                         │
                         └─ styledMsgWriteln (compiler/msgs.nim:401)
```

### データフロー図

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

{.magic: "X".} ───▶ pragmaMagic ───▶ TMagic照合 ───▶ warnUnknownMagic
    │                    │               │                    │
    └─ マジック名 ──────┘               │                    └─ stderr
                                         │
              TMagic.mNone（未発見） ────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind列挙型とメッセージ文字列の定義 |
| pragmas.nim | `compiler/pragmas.nim` | ソース | pragmaMagic関数、warnUnknownMagic発行箇所 |
| ast.nim | `compiler/ast.nim` | ソース | TMagic列挙型の定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力関数群の実装 |
| options.nim | `compiler/options.nim` | ソース | foreignPackageNotesDefault定義（549行目） |
