# 通知設計書 68-warnFileChanged

## 概要

本ドキュメントは、Nimコンパイラの警告メッセージ `warnFileChanged` の設計仕様を定義する。この警告は、コンパイル中にソースファイルが変更されたことを検出した場合に出力される。

### 本通知の処理概要

この警告は、インクリメンタルコンパイルやIDEサポート機能において、ファイルの内容が処理中に変更されたことを検出し、開発者に通知する機能を提供する。

**業務上の目的・背景**：インクリメンタルコンパイルやLanguage Server Protocol (LSP)などのIDEサポート機能では、ソースファイルのキャッシュを使用してパフォーマンスを向上させている。しかし、コンパイル処理中にソースファイルが外部から変更された場合、キャッシュと実際のファイル内容に不整合が生じる可能性がある。この警告により、開発者やツールはファイル変更を認識し、必要に応じて再コンパイルを行うことができる。

**通知の送信タイミング**：コンパイラがファイルを読み込む際、またはキャッシュされたファイル内容を使用する際に、ファイルの変更が検出された場合に警告が発生する可能性がある。ただし、現在のソースコードでは、この警告の具体的な使用箇所は確認されていない。

**通知の受信者**：Nimコンパイラを使用してソースコードをコンパイルしている開発者、またはIDEやビルドツール。コンパイル時の警告メッセージとして標準エラー出力またはビルドログに表示される。

**通知内容の概要**：「file changed: {ファイル情報}」（ファイルが変更されました：{ファイル情報}）というメッセージが出力される。

**期待されるアクション**：開発者またはビルドシステムは、影響を受けるファイルを再コンパイルするか、キャッシュを無効化して最新のファイル内容を使用する。

## 通知種別

コンパイラ警告メッセージ（stderr/ビルドログ出力）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期（コンパイル処理中に即座に出力） |
| 優先度 | 中（Warning） |
| リトライ | 無（コンパイル時の一度きりの出力） |

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

警告は、コンパイラオプションで `warnFileChanged`（短縮形: `FileChanged`）が有効になっている場合に出力される。

## 通知テンプレート

### コンパイラ警告出力の場合

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr |
| メッセージ種別 | Warning |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイルパス}({行番号}, {カラム番号}) Warning: file changed: {ファイル情報} [FileChanged]
```

### 添付ファイル

なし（コンパイラ出力のため）

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 変更されたファイルの情報 | 呼び出し元から渡される | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル処理 | ファイル変更検出 | ファイルのタイムスタンプまたはハッシュ値が変更された | キャッシュと実ファイルの不整合を検出 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning:FileChanged:off | コマンドラインオプションで明示的に無効化 |
| {.warning[FileChanged]:off.} | プラグマで無効化 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ファイル読み込み/キャッシュ参照] --> B{ファイル変更検出?}
    B -->|No| C[処理継続]
    B -->|Yes| D[message - warnFileChanged]
    D --> E{再コンパイル必要?}
    E -->|Yes| F[キャッシュ無効化]
    E -->|No| C
    F --> C
```

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

本警告はコンパイラ内部処理であり、データベースは使用しない。

### 参照テーブル一覧

なし

### 更新テーブル一覧

なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 該当なし | 警告メッセージのため、エラーは発生しない | - |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

ファイル変更の検出は、特にセキュリティ上重要なビルドパイプラインにおいて、ビルドの整合性を確保するために重要である。不正なファイル変更が行われた場合にこの警告が発生する可能性がある。

## 備考

- この警告は`lineinfos.nim`に定義されているが、現在のソースコードでは直接的な使用箇所は確認されていない
- インクリメンタルコンパイルやnimsuggest（IDE支援ツール）での使用が想定される
- ファイル変更検出は、タイムスタンプやファイルハッシュを使用して行われることが一般的

---

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

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

### 推奨読解順序

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

まず、警告メッセージの種別定義を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnFileChangedの定義（81行目）とメッセージテンプレート（190行目）を確認 |

**読解のコツ**: warnFileChangedは将来のインクリメンタルコンパイル機能での使用を想定している可能性がある。

#### Step 2: ファイル情報管理を理解する

ファイル情報の管理構造を確認する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | lineinfos.nim | `compiler/lineinfos.nim` | TFileInfo構造体（284-302行目付近）でファイル情報の管理方法を確認 |

**主要処理フロー**:
- TFileInfo.hash: ファイルのチェックサム
- TFileInfo.dirty: ファイルが変更されたかどうかのフラグ
- TFileInfo.dirtyFile: 実際に読み込まれるファイル（nimsuggest用）

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

```
（現在のソースコードでは使用箇所なし）

将来の想定:
ファイルキャッシュモジュール
    │
    ├─ ファイル変更検出
    │      │
    │      └─ msgs.nim::message（警告出力 - warnFileChanged）
    │
    └─ キャッシュ更新処理
```

### データフロー図

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

ファイルパス ───▶ ファイル読み込み/キャッシュ参照
                          │
                          ▼
                 ┌─────────────────────┐
                 │ タイムスタンプ/ハッシュ │
                 │ 比較                   │
                 └──────────┬────────────┘
                            │変更検出
                            ▼
                      message ───▶ stderr（警告出力）
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind定義、メッセージテンプレート、TFileInfo構造体 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力関数 |
