# 通知設計書 102-hintCodeEnd

## 概要

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

### 本通知の処理概要

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

**業務上の目的・背景**：`hintCodeBegin`と対になる通知であり、生成コードリストの終端を明示するために存在する。これにより、開発者は生成コードの範囲を明確に把握でき、コンパイラ出力の可読性が向上する。特に複数のフィルタが適用される場合や、長いコードが生成される場合に有用である。

**通知の送信タイミング**：`hintCodeBegin`が出力された後、フィルタ適用後の生成コード全体が出力された直後に送信される。`hintCodeBegin`と必ずペアで出力される。

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

**通知内容の概要**：「end of listing」という固定メッセージが出力される。

**期待されるアクション**：開発者はこの通知を確認し、生成コードリストの終端を認識する。必要に応じて生成コードの内容をレビューする。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

### 本文テンプレート

```
Hint: end of listing [CodeEnd]
```

### 添付ファイル

なし

## テンプレート変数

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

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | 生成コードリスト出力完了 | `hintCodeBegin`が出力済み | フィルタ処理後のコード一覧表示終了 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[hintCodeBegin出力済み] --> B[msgWriteln: 生成コード出力]
    B --> C[rawMessage hintCodeEnd]
    C --> D[liMessage呼び出し]
    D --> E{writelnHookあり?}
    E -->|Yes| F[フック関数呼び出し]
    E -->|No| G{optStdout有効?}
    G -->|Yes| H[stdout出力]
    G -->|No| I[stderr出力]
    F --> J[終了]
    H --> J
    I --> J
```

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

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

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 制限なし | hintCodeBeginに対応して1回のみ出力 |

### 配信時間帯

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

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

- このヒント自体には機密情報は含まれない
- 直前の生成コード出力に機密情報が含まれる可能性があることに注意

## 備考

- `hintCodeEnd`は常に`hintCodeBegin`とペアで出力される
- 単独で出力されることはなく、applyFilter関数内で連続して呼び出される
- verbosity 2以上または`--hint:CodeEnd:on`オプションで有効化可能

---

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

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

### 推奨読解順序

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

通知種別の定義を理解することが重要。

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

**読解のコツ**: hintCodeBeginとhintCodeEndは連続して定義されており、同じverbosityレベルで制御される。

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | syntaxes.nim | `compiler/syntaxes.nim` | applyFilter関数（84-101行目）でhintCodeEndが出力される箇所 |

**主要処理フロー**:
1. **98行目**: `hasHint(hintCodeBegin)`でヒント有効性チェック
2. **99行目**: `rawMessage`でhintCodeBeginを出力
3. **100行目**: `msgWriteln`で生成コードを出力
4. **101行目**: `rawMessage`でhintCodeEndを出力

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

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

**主要処理フロー**:
- **610-612行目**: `rawMessage`テンプレートがliMessageを呼び出す

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

```
applyFilter (syntaxes.nim 84行目)
    │
    ├─ hasHint(hintCodeBegin) チェック
    │
    ├─ rawMessage(hintCodeBegin)
    │
    ├─ msgWriteln(生成コード)
    │
    └─ rawMessage(hintCodeEnd) ← ここでhintCodeEnd出力
           └─ liMessage
                  └─ styledMsgWriteln → stderr/stdout
```

### データフロー図

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

hintCodeBegin     ───▶ 生成コード出力
出力完了                    │
                           ▼
                    rawMessage          ───▶ stderr/stdout
                    (hintCodeEnd)              "Hint: end of listing"
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | メッセージ種別定義（TMsgKind列挙型） |
| syntaxes.nim | `compiler/syntaxes.nim` | ソース | applyFilter関数でのhintCodeEnd出力 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力処理 |
| options.nim | `compiler/options.nim` | ソース | hasHint関数（hintCodeBeginのチェックに使用） |
