# 通知設計書 14-errRstInvalidField

## 概要

本ドキュメントは、Nimコンパイラのドキュメント生成機能（docgen）およびRST/Markdownパーサーにおける無効フィールドエラー通知「errRstInvalidField」の設計について記述する。

### 本通知の処理概要

errRstInvalidFieldは、reStructuredText（RST）またはMarkdownドキュメント内で無効なフィールド値が指定された場合、またはインデックスファイル（.idx）の解析中に不正なフィールドが検出された場合に発生するエラー通知である。

**業務上の目的・背景**：RST/Markdownドキュメントやインデックスファイルでは、特定の形式やデータ型でフィールド値を指定する必要がある。例えば、数値が期待されるフィールドに文字列が指定された場合や、インデックスファイル内のエントリ種別が不正な場合に、ユーザーに修正を促すためにこのエラーを報告する。

**通知の送信タイミング**：以下の状況で発生する：
1. rstgen.nimでフィールド値の解析に失敗した場合（getField1Int関数など）
2. インデックスファイル（.idx）のパース中に不正なフィールドが検出された場合
3. importdoc処理でインデックスエントリの種別が不整合な場合

**通知の受信者**：Nimコンパイラを使用してドキュメント生成（nim doc）を実行している開発者。

**通知内容の概要**：エラーが発生したファイル名、行番号、列番号、および無効なフィールドの詳細情報を含むエラーメッセージ。

**期待されるアクション**：開発者はエラーメッセージに基づいて、フィールド値を正しい形式に修正するか、インデックスファイルの整合性を確認する。

## 通知種別

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

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 同期 |
| 優先度 | 高（エラー） |
| リトライ | なし |

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

コンパイラのエラー出力設定（`ConfigRef.m.errorOutputs`）に基づいて、標準エラー出力またはフックされたハンドラに送信される。

## 通知テンプレート

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

| 項目 | 内容 |
|-----|------|
| 送信元 | Nimコンパイラ（docgen/rst/rstgen） |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Error: invalid field: {詳細情報}
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 無効フィールドの詳細情報 | パーサーが検出したエラー内容 | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ドキュメント生成 | フィールド値解析 | 数値フィールドのパース失敗 | getField1Int関数での変換エラー |
| ドキュメント生成 | インデックスファイル解析 | 不正なフィールド値 | parseIdxFile関数でのValueError |
| ドキュメント生成 | importdoc処理 | エントリ種別の不整合 | .nimファイル由来のIDXに対するマークアップエントリなど |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | このエラーは常に報告される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[ドキュメント/インデックス解析] --> B{フィールド値取得}
    B -->|数値フィールド| C[getField1Int呼び出し]
    B -->|IDXファイル| D[parseIdxFile呼び出し]
    C --> E{パース成功?}
    E -->|Yes| F[正常処理続行]
    E -->|No| G[meInvalidField発行]
    D --> H{パース成功?}
    H -->|Yes| I[エントリ種別チェック]
    H -->|No| J[rstMessage/meInvalidField発行]
    I --> K{種別整合?}
    K -->|Yes| F
    K -->|No| J
    G --> L[docgen.compilerMsgHandler]
    J --> L
    L --> M[errRstInvalidFieldに変換]
    M --> N[globalErrorとして出力]
    F --> O[終了]
    N --> O
```

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

### 参照テーブル一覧

該当なし（ファイルベース処理）

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 数値変換エラー | 数値フィールドに非数値が指定 | 正しい数値形式で指定 |
| IDXファイルエラー | インデックスファイルのフォーマット不正 | IDXファイルを再生成 |
| エントリ種別不整合 | .nimファイルのIDXにマークアップエントリなど | importdoc設定を確認 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- 外部から提供されるインデックスファイルの内容が不正な場合にエラーを報告し、不正なデータの処理を防止

## 備考

- このエラーは主にrstgen.nim（RST生成器）およびrst.nim（RSTパーサー）のインデックス処理で発生する
- インデックスファイル（.idx）はドキュメント間のクロスリファレンス解決に使用される

---

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

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

### 推奨読解順序

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

RSTパーサーおよびジェネレータで使用されるメッセージ種別を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | rst.nim | `lib/packages/docutils/rst.nim` | MsgKind列挙型のmeInvalidField定義（69行目） |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型のerrRstInvalidField定義（43行目） |

#### Step 2: エラー発行箇所を理解する

フィールド検証とエラー発行の箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | rstgen.nim | `lib/packages/docutils/rstgen.nim` | getField1Int関数（813-820行目） |
| 2-2 | rst.nim | `lib/packages/docutils/rst.nim` | parseIdxFile例外ハンドリング（3604行目） |
| 2-3 | rst.nim | `lib/packages/docutils/rst.nim` | importdocエントリ種別チェック（3617行目、3626行目） |

**主要処理フロー**:
1. **rstgen.nim 815行目**: getField1Int関数でmeInvalidFieldを発行するテンプレート定義
2. **rst.nim 3604行目**: parseIdxFileでValueError発生時にmeInvalidField発行
3. **rst.nim 3617行目**: .nimファイル由来のIDXにieMarkupTitleがある場合にエラー
4. **rst.nim 3626行目**: マークアップ由来のIDXにieNim等がある場合にエラー

#### Step 3: メッセージ変換レイヤーを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | docgen.nim | `compiler/docgen.nim` | compilerMsgHandler関数（256行目）でメッセージ変換 |

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

```
nim doc (ドキュメント生成コマンド)
    │
    ├─ rstgen.nim
    │      │
    │      └─ getField1Int (813-820行目)
    │             │
    │             └─ rstMessage(meInvalidField) [パース失敗時]
    │
    ├─ rst.nim
    │      │
    │      ├─ loadIdxFile
    │      │      │
    │      │      └─ parseIdxFile
    │      │             │
    │      │             └─ ValueError catch -> rstMessage(meInvalidField) (3604行目)
    │      │
    │      └─ importdocエントリ検証 (3617行目, 3626行目)
    │             │
    │             └─ rstMessage(meInvalidField)
    │
    └─ docgen.nim::compilerMsgHandler (256行目)
           │
           └─ msgs.nim::globalError (errRstInvalidField)
```

### データフロー図

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

RST/IDXファイル ───▶ rstgen.nim::getField1Int ───▶ 数値パース試行
                              │
                              ▼ [パース失敗]
                         rstMessage(meInvalidField)
                              │
                              ▼
インデックスファイル ───▶ rst.nim::parseIdxFile ───▶ フィールド解析
                              │
                              ▼ [ValueError発生]
                         rstMessage(meInvalidField)
                              │
                              ▼
                         docgen.nim::compilerMsgHandler
                              │
                              ▼
                         TMsgKind(errRstInvalidField)
                              │
                              ▼
                         stderr / 構造化エラーフック
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| rst.nim | `lib/packages/docutils/rst.nim` | ソース | RST/Markdownパーサー、インデックス処理 |
| rstgen.nim | `lib/packages/docutils/rstgen.nim` | ソース | RST生成器、フィールド値処理 |
| rstidx.nim | `lib/packages/docutils/rstidx.nim` | ソース | インデックスファイル処理 |
| docgen.nim | `compiler/docgen.nim` | ソース | ドキュメント生成器、メッセージハンドラ |
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind列挙型定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | コンパイラメッセージシステム |
