# 通知設計書 117-hintExpandMacro

## 概要

本ドキュメントは、Nimコンパイラにおける`hintExpandMacro`（マクロ展開ヒント）通知の設計について記述する。

### 本通知の処理概要

`hintExpandMacro`は、マクロが展開された結果のコードを表示するためのヒント通知である。マクロのデバッグや、生成されたコードの確認に使用される。

**業務上の目的・背景**：Nimのマクロは強力なメタプログラミング機能を提供するが、展開結果を確認することはデバッグにおいて重要である。このヒントにより、特定のマクロが展開された結果のASTをソースコード形式で表示し、マクロの動作を検証できる。

**通知の送信タイミング**：セマンティック解析フェーズ（sem.nim）において、`--expandMacro:マクロ名`オプションで指定されたマクロが呼び出された際に、展開結果を出力する。

**通知の受信者**：コンパイルを実行している開発者。コンソール出力またはIDE経由で展開結果を受け取る。

**通知内容の概要**：「expanded macro: {展開結果のコード}」というメッセージが通知される。

**期待されるアクション**：開発者は展開されたコードを確認し、マクロが意図した通りにコードを生成しているかを検証する。

## 通知種別

コンパイラ出力（コンソール / IDE統合）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 低（Hint） |
| リトライ | なし |

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

コンパイラの標準出力または標準エラー出力へ送信。`--expandMacro:マクロ名`オプションで指定されたマクロに対してのみ有効。

## 通知テンプレート

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

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

### 本文テンプレート

```
Hint: expanded macro: {展開結果のコード} [ExpandMacro]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 展開されたマクロのコード | renderTree(result, {...}) | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| マクロ呼び出し | semMacroExpr関数 | c.config.macrosToExpand.hasKey(sym.name.s) | 展開対象マクロとして登録されている場合 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --expandMacro未指定 | オプションでマクロ名が指定されていない場合 |
| マクロ名が一致しない | 指定されたマクロ名と異なるマクロの場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[マクロ呼び出し検出] --> B[evalMacroCall実行]
    B --> C[semAfterMacroCall実行]
    C --> D{macrosToExpandに登録?}
    D -->|Yes| E[renderTreeで結果をレンダリング]
    D -->|No| G[ヒントなし]
    E --> F[hintExpandMacro発行]
    F --> H[終了]
    G --> H
```

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

### 参照テーブル一覧

該当なし（コンパイラ内部処理のみ）

### 参照項目詳細

| 参照項目 | 用途 | 取得条件 |
|---------|------|---------|
| c.config.macrosToExpand | 展開対象マクロの登録確認 | sym.name.sで検索 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| なし | このヒント自体はエラーを発生させない | - |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限 | なし |

### 配信時間帯

制限なし

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

展開されたコードが出力されるため、機密性の高いマクロを扱う場合はログ出力の取り扱いに注意が必要。

## 備考

- `--expandMacro:マクロ名`オプションで有効化
- 複数のマクロを指定する場合は複数回オプションを指定
- renderTreeで展開結果をソースコード形式に変換

---

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

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

### 推奨読解順序

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

まず、通知の定義と設定について理解する。

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

**読解のコツ**: hintExpandMacroのテンプレートは「expanded macro: $1」で、$1に展開結果のコードが入る。

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

処理の起点となるマクロ展開処理を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | sem.nim | `compiler/sem.nim` | semMacroExpr関数内でのhintExpandMacro発行（564-567行目） |

**主要処理フロー**:
1. **561行目**: evalMacroCall()でマクロを実行
2. **562-563行目**: semAfterMacroCall()で結果のセマンティック解析
3. **564行目**: `c.config.macrosToExpand.hasKey(sym.name.s)`の条件確認
4. **565-567行目**: `message(c.config, nOrig.info, hintExpandMacro, renderTree(result, {...}))`でヒント発行

#### Step 3: オプション処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | commands.nim | `compiler/commands.nim` | --expandMacroオプションの処理 |

**主要処理フロー**:
- macrosToExpandテーブルへのマクロ名登録

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

```
セマンティック解析
    │
    └─ semMacroExpr (sem.nim)
           │
           ├─ evalMacroCall (マクロ実行)
           │
           ├─ semAfterMacroCall (結果解析)
           │
           └─ macrosToExpand.hasKey確認
                  │
                  └─ message(hintExpandMacro, renderTree(result))
```

### データフロー図

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

--expandMacro ─────────▶ macrosToExpand登録
       │
マクロ呼び出し ────────▶ semMacroExpr ────────▶ ヒント出力
       │                      │                "expanded macro: ..."
       │                      │
evalMacroCall ───────────────┘
       │
renderTree(result) ──────────────────────────────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind定義、メッセージテンプレート |
| sem.nim | `compiler/sem.nim` | ソース | セマンティック解析、hintExpandMacro発行 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ送信処理 |
| commands.nim | `compiler/commands.nim` | ソース | --expandMacroオプション処理 |
| renderer.nim | `compiler/renderer.nim` | ソース | renderTree関数（AST→ソースコード変換） |
