# 通知設計書 97-hintExprAlwaysX

## 概要

本ドキュメントは、Nimコンパイラにおけるヒント通知「hintExprAlwaysX」の設計を記載する。この通知は式が常に特定の値に評価されることをユーザーに通知するためのものである。

### 本通知の処理概要

hintExprAlwaysX（expression evaluates always to '$1'）は、コンパイル時に式が常に同じ値に評価されることが判明した場合に発行されるヒントメッセージである。

**業務上の目的・背景**：コードの最適化と潜在的なバグの発見を目的とする。常に同じ値に評価される式は、コードの意図しない動作やロジックエラーを示している可能性がある。この通知により、開発者は冗長な計算や到達不能コードを特定し、コードを改善する機会を得られる。

**通知の送信タイミング**：セマンティック解析時、定数畳み込み（constant folding）や式の評価において、式が常に特定の値になると判断された場合に送信される。

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

**通知内容の概要**：「expression evaluates always to '{値}'」というメッセージで、式が常に評価される値が通知される。

**期待されるアクション**：開発者は通知を受け、式を定数に置き換えるか、ロジックエラーがないか確認する。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

コンパイラを実行しているプロセスの標準エラー出力に直接出力される。

## 通知テンプレート

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

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

### 本文テンプレート

```
expression evaluates always to '{値}'
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 評価値 | 式の評価結果 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 式評価 | 定数畳み込み時 | 式が常に同一値 | コンパイル時に評価可能な式 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| 実行時評価が必要 | 実行時の状態に依存する場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[式の解析] --> B[定数畳み込み試行]
    B --> C{コンパイル時評価可能?}
    C -->|No| D[通常の式として処理]
    C -->|Yes| E{常に同一値?}
    E -->|No| D
    E -->|Yes| F[message hintExprAlwaysX]
    F --> G[処理継続]
```

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

### 参照テーブル一覧

コンパイラ内部の式評価データを参照。データベースは使用しない。

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

該当なし

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

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

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

機密情報を含まない。式の評価値が表示されるが、ソースコードに含まれる情報であり、特別なセキュリティ対策は不要。

## 備考

- 条件式（if、when、while）で特に有用
- hintConditionAlwaysTrue/Falseと関連するが、より一般的な式を対象
- マクロやテンプレート展開後の式も対象

---

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

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

### 推奨読解順序

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

まず、通知定義と式評価の仕組みを理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | hintExprAlwaysXの定義（107行目）とメッセージ（220行目） |
| 1-2 | semfold.nim | `compiler/semfold.nim` | 定数畳み込み処理 |

**読解のコツ**: 定数畳み込みがどのような条件で適用されるかを理解する。

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

式評価時のヒント出力箇所を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | semexprs.nim | `compiler/semexprs.nim` | 式のセマンティック解析 |
| 2-2 | semfold.nim | `compiler/semfold.nim` | 定数畳み込み処理 |

**主要処理フロー**:
1. 式の解析開始
2. 定数畳み込み試行
3. 常に同一値と判定された場合にヒント出力

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | msgs.nim | `compiler/msgs.nim` | message関数の呼び出し |

**主要処理フロー**:
- 定数畳み込み結果の判定
- message(hintExprAlwaysX)呼び出し

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

```
sem式処理
    │
    ├─ 式の型解析
    │
    ├─ 定数畳み込み試行
    │      ├─ evalConstExpr
    │      └─ 常値判定
    │
    └─ message(hintExprAlwaysX)
           └─ 評価値の文字列化
```

### データフロー図

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

式（PNode） ───▶ 定数畳み込み ───▶ stderr
    │                │
    ├─ 演算子       ├─ evalConstExpr
    └─ オペランド   └─ 常値判定
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | hintExprAlwaysX定義 |
| semfold.nim | `compiler/semfold.nim` | ソース | 定数畳み込み処理 |
| semexprs.nim | `compiler/semexprs.nim` | ソース | 式のセマンティック解析 |
| msgs.nim | `compiler/msgs.nim` | ソース | message関数 |
