# 通知設計書 101-hintCodeBegin

## 概要

本ドキュメントは、Nimコンパイラの`hintCodeBegin`ヒント通知に関する設計を定義する。このヒントは、ソースコードフィルタ処理後の生成コードリストの開始を通知するものである。

### 本通知の処理概要

`hintCodeBegin`ヒントは、Nimコンパイラがソースコードフィルタ（`#?`プリプロセッサディレクティブによるフィルタリング）を適用した結果として生成されたコードの一覧表示を開始する際に出力される通知である。

**業務上の目的・背景**：Nimコンパイラは`#?`ディレクティブを使用してソースコードにテンプレート展開、文字列置換、空白除去などのフィルタ処理を適用できる。この通知は、開発者がフィルタ処理後のコードを確認し、デバッグを支援するために存在する。フィルタ処理は複雑な変換を行うことがあり、その結果を可視化することは開発者にとって重要である。

**通知の送信タイミング**：ソースコードパース時に`#?`ディレクティブでフィルタが指定されており、`hintCodeBegin`ヒントが有効（verbosity >= 2）な場合に送信される。フィルタが`filtNone`以外（`stdtmpl`、`replace`、`strip`）の場合に適用される。

**通知の受信者**：コンパイル実行者（開発者）がコンソール出力（stderr）を通じてこの通知を受信する。

**通知内容の概要**：「generated code listing:」という固定メッセージとともに、その後にフィルタ適用後の生成コード全体が出力される。

**期待されるアクション**：開発者はこの通知を確認し、フィルタ処理が期待通りに適用されているか検証する。問題がある場合はフィルタ定義やソースコードを修正する。

## 通知種別

コンソール出力（コンパイラヒント）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイルプロセス内で即時出力） |
| 優先度 | 低（ヒント情報） |
| リトライ | 無し |

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

標準エラー出力（stderr）に送信される。`--stdout`オプションが指定されている場合は標準出力（stdout）に送信される。`writelnHook`が設定されている場合は、そのフック関数に委譲される。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| メッセージ種別 | Hint |
| フォーマット | `Hint: generated code listing: [CodeBegin]` |
| 色 | 緑色（HintColor = fgGreen） |

### 本文テンプレート

```
Hint: generated code listing: [CodeBegin]
{フィルタ適用後の生成コード全体}
Hint: end of listing [CodeEnd]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| なし | 固定メッセージのため変数なし | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | ソースコードフィルタ適用 | `hintCodeBegin in conf.notes`（verbosity >= 2） | フィルタ処理後のコード一覧表示開始 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| verbosity < 2 | デフォルトでは非表示（NotesVerbosity[1]から除外） |
| optHints not in conf.options | ヒント出力自体が無効化されている場合 |
| フィルタ種別がfiltNone | フィルタが適用されない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[パーサー: ソースファイル読み込み] --> B{#?ディレクティブあり?}
    B -->|なし| C[通常パース処理]
    B -->|あり| D[フィルタパイプ解析]
    D --> E[applyFilter関数呼び出し]
    E --> F{フィルタ種別チェック}
    F -->|filtNone| G[フィルタなし終了]
    F -->|filtTemplate/Replace/Strip| H[フィルタ適用]
    H --> I{hasHint hintCodeBegin?}
    I -->|No| J[フィルタ結果返却]
    I -->|Yes| K[rawMessage hintCodeBegin]
    K --> L[msgWriteln: 生成コード出力]
    L --> M[rawMessage hintCodeEnd]
    M --> J
```

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

該当なし（ファイルシステムやデータベースへのアクセスなし）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | このヒントは情報出力のみ | - |

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限なし | フィルタ適用時に1回のみ出力 |

### 配信時間帯

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

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

- 生成コードにはソースコードの内容が含まれるため、機密情報を含むコードがログに出力される可能性がある
- CI/CDパイプラインでverbosityを高く設定している場合、ログに機密情報が記録される可能性に注意

## 備考

- `hintCodeBegin`は常に`hintCodeEnd`とペアで出力される
- verbosity 2以上または`--hint:CodeBegin:on`オプションで有効化可能
- ソースコードフィルタは`#?stdtmpl`、`#?replace`、`#?strip`などで指定

---

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

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

### 推奨読解順序

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

通知種別の定義と、フィルタ種別の列挙型を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でhintCodeBegin/hintCodeEndの定義を確認（108-109行目） |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | MsgKindToStr配列でメッセージ文字列を確認（224-225行目） |

**読解のコツ**: Nimの列挙型定義では、文字列値を`= "文字列"`で指定でき、これがコンパイラ出力時の識別子として使用される。

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

フィルタ処理の起点となるファイル・関数を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | syntaxes.nim | `compiler/syntaxes.nim` | applyFilter関数（84-101行目）がフィルタ適用とヒント出力の核心 |

**主要処理フロー**:
1. **84行目**: `applyFilter`関数の定義開始
2. **86行目**: `getFilter`でフィルタ種別を判定
3. **87-95行目**: フィルタ種別に応じた処理を選択
4. **96行目**: `filtNone`以外の場合にヒント出力処理へ
5. **98行目**: `hasHint(hintCodeBegin)`でヒント有効性チェック
6. **99行目**: `rawMessage`でhintCodeBeginを出力
7. **100行目**: `msgWriteln`で生成コードを出力
8. **101行目**: `rawMessage`でhintCodeEndを出力

#### Step 3: メッセージ出力層を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | msgs.nim | `compiler/msgs.nim` | rawMessage関数（610-615行目）でメッセージ出力処理 |
| 3-2 | msgs.nim | `compiler/msgs.nim` | liMessage関数（536-608行目）で実際の出力フォーマット処理 |

**主要処理フロー**:
- **610-612行目**: `rawMessage`テンプレートがliMessageを呼び出す
- **574-583行目**: ヒントメッセージの処理分岐

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

```
syntaxes.openParser (119行目)
    │
    ├─ parsePipe (43行目)
    │      └─ フィルタパイプ定義の解析
    │
    └─ evalPipe (103行目)
           └─ applyFilter (84行目)
                  ├─ getFilter: フィルタ種別判定
                  ├─ filterTmpl/filterStrip/filterReplace: フィルタ実行
                  └─ hasHint(hintCodeBegin) チェック後
                         ├─ rawMessage(hintCodeBegin)
                         │      └─ liMessage → styledMsgWriteln
                         ├─ msgWriteln(生成コード)
                         └─ rawMessage(hintCodeEnd)
```

### データフロー図

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

ソースファイル   ───▶ parsePipe            ───▶ フィルタ定義AST
(#?stdtmpl等)           │
                        ▼
                   evalPipe              ───▶ フィルタ適用結果
                        │
                        ▼
                   applyFilter           ───▶ PLLStream (変換後コード)
                        │
                        ▼
hasHint check    ───▶ rawMessage         ───▶ stderr/stdout
                        │                      "Hint: generated code listing:"
                        ▼
                   msgWriteln            ───▶ stderr/stdout
                        │                      (生成コード全体)
                        ▼
                   rawMessage            ───▶ stderr/stdout
                                               "Hint: end of listing"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | メッセージ種別定義（TMsgKind列挙型） |
| syntaxes.nim | `compiler/syntaxes.nim` | ソース | パーサーディスパッチャー、フィルタ適用処理 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
| filters.nim | `compiler/filters.nim` | ソース | replace/stripフィルタ実装 |
| filter_tmpl.nim | `compiler/filter_tmpl.nim` | ソース | stdtmplフィルタ実装 |
| options.nim | `compiler/options.nim` | ソース | hasHint関数、verbosity設定 |
