# 通知設計書 100-hintProcessingStmt

## 概要

本ドキュメントは、Nimコンパイラにおけるヒント通知「hintProcessingStmt」の設計を記載する。この通知は文（ステートメント）レベルの処理状況をユーザーに通知するためのものである。

### 本通知の処理概要

hintProcessingStmt（$1）は、Nimコンパイラがトップレベルの文を処理する際に、その進捗状況をユーザーに通知するヒントメッセージである。hintProcessingがモジュールレベルの通知であるのに対し、hintProcessingStmtはより細かい文レベルでの通知を提供する。

**業務上の目的・背景**：詳細なコンパイル進捗の可視化とデバッグを目的とする。verbosityレベル3の詳細モードで有効となり、各トップレベル文が処理される様子を追跡できる。これにより、コンパイルエラーや処理遅延の原因を特定しやすくなる。

**通知の送信タイミング**：パイプライン処理またはverboseパス処理において、各トップレベル文の処理直前に送信される。

**通知の受信者**：コンパイルを実行している開発者。標準エラー出力を通じて通知される。

**通知内容の概要**：IdGen識別子などの処理情報が通知される。

**期待されるアクション**：通常は情報提供のみで、アクション不要。デバッグ時の参照情報として利用される。

## 通知種別

コンパイラコンソール出力（標準エラー出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 最低（詳細ヒント） |
| リトライ | 無 |

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

コンパイラを実行しているプロセスの標準エラー出力に直接出力される。verbosity >= 3で有効となる。

## 通知テンプレート

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

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

### 本文テンプレート

```
{IdGen情報}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | IdGen識別子情報 | $idgen[] | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 文処理 | トップレベル文の処理前 | hintProcessingStmt in conf.notes | パイプラインまたはverboseパス |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| verbosity < 3 | 詳細出力モードでない場合 |
| hintProcessingStmt notin conf.notes | ヒントが無効な場合 |
| graph.pipelinePass == EvalPass | 評価パスでは出力しない |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[トップレベル文の取得] --> B{pipelinePass?}
    B -->|EvalPass| C[出力スキップ]
    B -->|その他| D[message hintProcessingStmt]
    D --> E[semWithPContext実行]
    E --> F[処理継続]
```

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

### 参照テーブル一覧

コンパイラ内部のIdGenと処理コンテキストを参照。データベースは使用しない。

### テーブル別参照項目詳細

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 出力失敗 | stderr書き込みエラー | 処理継続（無視） |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

機密情報を含まない。内部識別子が表示されるが、ローカル開発環境での使用が前提であり、特別なセキュリティ対策は不要。

## 備考

- verbosity >= 3（NotesVerbosity[3]）で有効
- hintProcessingより詳細な粒度での通知
- passauxモジュールのverbosePassでも使用される
- 大量の出力が発生するため、通常のコンパイルでは無効

---

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

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

### 推奨読解順序

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

まず、通知定義とverbosityレベルの関係を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | hintProcessingStmtの定義（108行目）とメッセージ（223行目） |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | NotesVerbosityの定義（263-271行目） |

**読解のコツ**: verbosity=2ではhintProcessingStmtが除外されることを確認（266行目）。

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

文処理時の通知発火箇所を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | pipelines.nim | `compiler/pipelines.nim` | message(hintProcessingStmt)呼び出し箇所（76行目、203行目） |
| 2-2 | passaux.nim | `compiler/passaux.nim` | verboseProcess関数（28-31行目） |

**主要処理フロー**:
1. **pipelines.nim 76行目**: importStmt処理前に出力
2. **pipelines.nim 203行目**: トップレベル文処理前に出力
3. **passaux.nim 31行目**: verbosePass処理で出力

#### Step 3: 出力ロジックを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | pipelines.nim | `compiler/pipelines.nim` | パイプライン処理での出力（200-203行目） |
| 3-2 | passaux.nim | `compiler/passaux.nim` | verbosePassでの出力（31行目） |

**主要処理フロー**:
- **pipelines.nim 202行目**: pipelinePass != EvalPassの判定
- **pipelines.nim 203行目**: message(hintProcessingStmt, $idgen[])
- **passaux.nim 31行目**: message(hintProcessingStmt, $v.idgen[])

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

```
パイプライン処理
    │
    ├─ processPipelineModule (pipelines.nim)
    │      └─ トップレベル文の反復処理
    │             ├─ pipelinePass != EvalPass判定
    │             │
    │             └─ message(hintProcessingStmt, $idgen[])
    │
    └─ verbosePass (passaux.nim)
           └─ verboseProcess
                  └─ message(hintProcessingStmt, $v.idgen[])
```

### データフロー図

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

トップレベル文 ───▶ パイプライン処理 ───▶ stderr
    │                    │
    └─ idgen[]           ├─ pipelinePass判定
                         └─ message(hintProcessingStmt)
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | hintProcessingStmt定義、NotesVerbosity |
| pipelines.nim | `compiler/pipelines.nim` | ソース | パイプライン処理での通知 |
| passaux.nim | `compiler/passaux.nim` | ソース | verbosePassでの通知 |
| msgs.nim | `compiler/msgs.nim` | ソース | message関数 |
