# 通知設計書 21-warnCannotOpenFile

## 概要

本ドキュメントは、Nimコンパイラにおける警告通知「warnCannotOpenFile」の設計仕様を定義する。この警告は、コンパイラがファイルを開くことができない場合に発生する警告レベルの通知である。

### 本通知の処理概要

この通知は、コンパイラがドキュメント生成時にファイルを開けない場合に警告として出力される。エラーレベルの`errCannotOpenFile`とは異なり、処理を継続しながらユーザーに問題を通知する。

**業務上の目的・背景**：ドキュメント生成（nim doc）時に出力ファイルへの書き込みができない場合、ユーザーに警告を発することで、ファイルシステムの問題（権限不足、ディスク容量不足など）を早期に発見させる。エラーとして処理を停止するのではなく、警告として処理を継続することで、他のファイルの生成を完了させることができる。

**通知の送信タイミング**：ドキュメント生成コマンド（nim doc）実行時に、出力ファイルへの書き込みでIOError例外が発生した際に送信される。具体的には`writeOutputJson`や`writeOutput`関数内でファイル書き込みが失敗した場合に発生する。

**通知の受信者**：Nimコンパイラを使用している開発者（標準エラー出力またはIDEツール経由）。

**通知内容の概要**：開けなかったファイルのパスを含む警告メッセージ「cannot open '$1'」が出力される。`$1`には実際のファイルパスが代入される。

**期待されるアクション**：ユーザーはファイルシステムの権限を確認し、出力先ディレクトリが存在するか、書き込み権限があるかを確認する。必要に応じてディレクトリを作成するか、権限を修正してから再度コンパイルを実行する。

## 通知種別

コンパイラ警告メッセージ（標準エラー出力 / IDE連携）

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 中（Warning） |
| リトライ | 無し |

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

標準エラー出力（stderr）に出力される。IDEツール（nimsuggest等）使用時は、構造化されたエラーフック経由でIDEに通知される。`--stdout`オプション指定時は標準出力に出力される。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 出力先 | stderr（デフォルト）/ stdout（--stdout指定時） |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイル名}({行},{列}) Warning: cannot open '{ファイルパス}' [CannotOpenFile]
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 開けなかったファイルのパス | IOError発生時のファイルパス | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コマンド実行 | nim doc実行 | ファイル書き込み時にIOError発生 | ドキュメント出力ファイルへの書き込み失敗時 |
| コマンド実行 | nim docコマンド | useWarning=true設定時 | writeOutput/writeOutputJson関数で警告モード有効時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| useWarning=false | エラーモードの場合はerrCannotOpenFileが使用される |
| --hints:off | ヒントおよび警告が無効化されている場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[nim doc実行] --> B[writeOutput/writeOutputJson呼び出し]
    B --> C[writeFile実行]
    C --> D{IOError発生?}
    D -->|Yes| E{useWarning?}
    D -->|No| F[正常終了]
    E -->|true| G[warnCannotOpenFile発行]
    E -->|false| H[errCannotOpenFile発行]
    G --> I[rawMessage呼び出し]
    I --> J[liMessage呼び出し]
    J --> K[styledMsgWriteln出力]
    K --> L[処理継続]
    H --> M[処理中断]
```

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

### 参照テーブル一覧

該当なし（ファイルシステム操作のみ）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| IOError | ファイルへの書き込み権限がない | 警告を出力し処理継続 |
| IOError | ディスク容量不足 | 警告を出力し処理継続 |
| IOError | ファイルパスが無効 | 警告を出力し処理継続 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- ファイルパスがそのまま出力されるため、機密性の高いパスが含まれる可能性がある
- ユーザーのローカル環境でのみ出力されるため、外部への漏洩リスクは低い

## 備考

- この警告はエラー`errCannotOpenFile`と対をなす設計となっている
- ドキュメント生成時のエラーハンドリングを柔軟にするため、警告/エラーの切り替えが可能
- `lineinfos.nim`で定義される最初のWarningカテゴリの通知（warnMin）

---

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

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

### 推奨読解順序

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

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnCannotOpenFileの定義（51行目）、MsgKindToStr配列でメッセージ文字列の定義（141行目） |

**読解のコツ**: TMsgKind列挙型は警告の識別子を定義し、MsgKindToStr配列は対応するメッセージテンプレートを保持する。warnMin定数（253行目）がwarnCannotOpenFileを指していることに注目。

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

警告が発生する具体的なコード箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | docgen.nim | `compiler/docgen.nim` | writeOutput関数内のtry-except（1799-1803行目）でIOErrorをキャッチしrawMessageを呼び出す |

**主要処理フロー**:
1. **1799行目**: try内でwriteFileを実行
2. **1801行目**: except IOErrorでエラーをキャッチ
3. **1802行目**: rawMessage呼び出しでwarnCannotOpenFileまたはerrCannotOpenFileを発行

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

rawMessageからstyledMsgWritelnまでの処理フローを追う。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | msgs.nim | `compiler/msgs.nim` | rawMessageテンプレート（610-612行目）からliMessage（536行目）を経てstyledMsgWriteln（401行目）へ |

**主要処理フロー**:
- **610-612行目**: rawMessageテンプレートがliMessageを呼び出す
- **536-608行目**: liMessage関数で警告のフォーマットと出力を制御
- **401-417行目**: styledMsgWritelnテンプレートで実際の出力を行う

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

```
docgen.writeOutput (compiler/docgen.nim:1786)
    │
    ├─ writeFile (システム関数)
    │      └─ IOError例外発生
    │
    └─ rawMessage (compiler/msgs.nim:610)
           │
           └─ liMessage (compiler/msgs.nim:536)
                  │
                  ├─ msgKindToString (compiler/msgs.nim:419)
                  │
                  └─ styledMsgWriteln (compiler/msgs.nim:401)
                         │
                         └─ writeLine (stdout/stderr)
```

### データフロー図

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

ファイルパス ───▶ writeFile ───▶ IOError例外 ───▶ rawMessage ───▶ stderr
                     │                               │
                     └─ useWarning ─────────────────┘
                        フラグ判定
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind列挙型とメッセージ文字列の定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力関数群の実装 |
| docgen.nim | `compiler/docgen.nim` | ソース | ドキュメント生成でのwarnCannotOpenFile発行箇所 |
| options.nim | `compiler/options.nim` | ソース | ConfigRef型と警告設定の管理 |
