# 通知設計書 99-hintProcessing

## 概要

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

### 本通知の処理概要

hintProcessing（$1）は、Nimコンパイラがモジュールを処理する際に、その進捗状況をユーザーに通知するヒントメッセージである。

**業務上の目的・背景**：コンパイルの進捗可視化とデバッグを目的とする。大規模プロジェクトのコンパイル時、どのモジュールが処理されているかをリアルタイムで把握することで、ビルド時間のボトルネック特定やコンパイルエラー発生時の原因モジュール特定が容易になる。

**通知の送信タイミング**：各モジュールの処理開始時に送信される。モジュールがパース・セマンティック解析される際に、その状態（パース中、解析中など）とともに通知される。

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

**通知内容の概要**：「{モード}{インデント}{インポート元}: {ステータス}: {ファイルパス}」の形式で通知される。`--processing:dots`の場合はドット（.）のみ出力される。

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

## 通知種別

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

## 送信仕様

### 基本情報

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

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

コンパイラを実行しているプロセスの標準エラー出力に直接出力される。`--processing:dots/filenames/off`オプションにより制御される。

## 通知テンプレート

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

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

### 本文テンプレート

標準モード（filenames）：
```
{モード}{インデント}{インポート元}: {ステータス}: {ファイルパス}
```

ドットモード（dots）：
```
.
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 完全なメッセージ | 動的生成 | Yes |
| モード | (nims)など | 設定に基づく | No |
| インデント | >の繰り返し | importStack.len | Yes |
| インポート元 | インポート元モジュール名 | fromModule.name.s | Yes |
| ステータス | モジュールの状態 | moduleStatus | Yes |
| ファイルパス | モジュールのパス | toFilenameOption | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| モジュール処理 | onProcessing呼び出し時 | hintProcessing in conf.notes | モジュール処理開始時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| `--processing:off` | 処理通知を無効化 |
| isNimscript and hintProcessing notin cmdlineNotes | NimScriptでコマンドライン指定なし |
| hintProcessing notin conf.notes | ヒントが無効 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[モジュール処理開始] --> B[onProcessing呼び出し]
    B --> C{NimScript?}
    C -->|Yes| D{cmdlineNotesに含まれる?}
    C -->|No| E[処理続行]
    D -->|No| F[出力スキップ]
    D -->|Yes| E
    E --> G[パス文字列生成]
    G --> H{hintProcessingDots?}
    H -->|Yes| I[ドット出力]
    H -->|No| J[詳細メッセージ出力]
    I --> K[終了]
    J --> K
```

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

### 参照テーブル一覧

コンパイラ内部のモジュールグラフとインポートスタックを参照。データベースは使用しない。

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

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- デフォルトはドットモード（hintProcessingDots = true）
- verbosity=0では出力されない
- foreignPackageNotesDefaultに含まれる
- インデント（>）の深さでインポート階層が可視化される

---

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

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

### 推奨読解順序

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

まず、通知定義と処理オプションを理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | hintProcessingの定義（108行目）とメッセージ（222行目） |
| 1-2 | options.nim | `compiler/options.nim` | hintProcessingDots設定（369行目、562行目） |

**読解のコツ**: hintProcessingDotsがtrue（ドット）かfalse（ファイル名）かで出力が変わることを理解する。

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

モジュール処理通知の発火箇所を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | modulegraphs.nim | `compiler/modulegraphs.nim` | onProcessing関数（705-713行目） |

**主要処理フロー**:
1. **705行目**: onProcessing関数開始
2. **708行目**: NimScriptチェック
3. **709-713行目**: メッセージ生成と出力

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | modulegraphs.nim | `compiler/modulegraphs.nim` | onProcessing内のメッセージ生成（709-713行目） |
| 3-2 | msgs.nim | `compiler/msgs.nim` | rawMessage関数（590-596行目） |

**主要処理フロー**:
- **709行目**: パス文字列生成
- **710行目**: インデント生成（">".repeat）
- **711-712行目**: モードとモジュール情報の組み立て
- **713行目**: rawMessage(hintProcessing)呼び出し
- **593行目**: hintProcessingDots判定でドットまたは詳細出力

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

```
モジュール処理開始
    │
    └─ onProcessing (modulegraphs.nim:705)
           ├─ NimScript判定
           │      └─ cmdlineNotesチェック
           │
           ├─ toFilenameOption (パス生成)
           │
           ├─ メッセージ組み立て
           │      ├─ mode（nims等）
           │      ├─ indent（>の繰り返し）
           │      ├─ fromModule2
           │      ├─ moduleStatus
           │      └─ path
           │
           └─ rawMessage(hintProcessing)
                  └─ hintProcessingDots判定
                         ├─ true: "."出力
                         └─ false: 詳細出力
```

### データフロー図

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

fileIdx ───▶ onProcessing ───▶ stderr
    │              │
    ├─ moduleStatus├─ toFilenameOption
    │              ├─ importStack.len
    └─ fromModule  └─ メッセージ組み立て
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | hintProcessing定義 |
| modulegraphs.nim | `compiler/modulegraphs.nim` | ソース | onProcessing関数 |
| options.nim | `compiler/options.nim` | ソース | hintProcessingDots設定 |
| msgs.nim | `compiler/msgs.nim` | ソース | rawMessage関数 |
| commands.nim | `compiler/commands.nim` | ソース | --processingオプション処理 |
