# 通知設計書 12-errRstGeneralParseError

## 概要

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

### 本通知の処理概要

errRstGeneralParseErrorは、reStructuredText（RST）またはMarkdownドキュメントの解析中に、特定のカテゴリに分類できない一般的なパースエラーが発生した場合に報告されるエラー通知である。

**業務上の目的・背景**：RST/Markdownドキュメントの解析において、ドキュメント全体のパースが完了せずにファイル終端（EOF）に到達しない場合、何らかの構文エラーが存在することを示す。この通知は、より具体的なエラーメッセージでは捕捉できない構文上の問題をユーザーに知らせ、ドキュメントの修正を促すことを目的とする。

**通知の送信タイミング**：parseDoc関数でドキュメント全体の解析が完了した後、現在のトークンがtkEof（ファイル終端）でない場合に発生する。これは、パーサーが何らかの理由でドキュメントの残りを処理できなかったことを示す。

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

**通知内容の概要**：エラーが発生したファイル名、行番号、列番号を含むエラーメッセージ。詳細な理由は含まれないため、ユーザーは該当箇所付近の構文を確認する必要がある。

**期待されるアクション**：開発者はエラーが報告された行番号付近のRST/Markdown構文を確認し、不正な構文を修正する。括弧の不一致、不正なインデント、無効なディレクティブ構文などが一般的な原因である。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

コンパイラのエラー出力設定（`ConfigRef.m.errorOutputs`）に基づいて、標準エラー出力またはフックされたハンドラに送信される。IDEツールモード（nimsuggest等）の場合は構造化エラーフックを通じて送信される。

## 通知テンプレート

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

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

### 本文テンプレート

```
{ファイルパス}({行番号}, {列番号}) Error: general parse error
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| - | このエラーには変数がない | - | - |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ドキュメント生成 | RST/Markdown解析完了 | 現在トークンがtkEofでない | parseDoc関数終了時のチェック |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| errorsAsWarnings | roPreferMarkdownオプション有効かつスタンドアロンドキュメントでない場合、エラーが警告に降格 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[RST/Markdownパース開始] --> B[parseDoc実行]
    B --> C[parseSectionWrapper呼び出し]
    C --> D{パース完了後のトークン確認}
    D -->|tkEof| E[正常終了]
    D -->|tkEof以外| F[meGeneralParseError発行]
    F --> G[docgen.compilerMsgHandler]
    G --> H[errRstGeneralParseErrorに変換]
    H --> I{errorsAsWarnings?}
    I -->|Yes| J[警告として出力しRecoverableError発生]
    I -->|No| K[globalErrorとして出力]
    J --> L[終了]
    K --> L
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 構文エラー | ドキュメントに不正な構文が含まれる | エラー行番号付近の構文を確認し修正 |
| 不完全なブロック | ディレクティブやリテラルブロックが閉じられていない | 対応する閉じ構文を追加 |
| 無効なインデント | インデントレベルが不正 | インデントを正しいレベルに調整 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- ファイルパス情報がエラーメッセージに含まれるが、ローカル環境での開発作業を前提としているため特別な対策は不要

## 備考

- このエラーはRST/Markdownパーサーの最終チェックで発生するため、より具体的なエラーが先に報告されている可能性がある
- エラーメッセージに詳細情報が含まれないため、ユーザーは他のエラーメッセージや該当行付近のコードを確認する必要がある

---

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

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

### 推奨読解順序

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

RSTパーサーで使用されるメッセージ種別を理解する。

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

**読解のコツ**: meGeneralParseErrorは引数を持たないシンプルなエラーメッセージである。

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

エラー発行箇所を特定する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | rst.nim | `lib/packages/docutils/rst.nim` | parseDoc関数（3218-3221行目） |

**主要処理フロー**:
1. **3218行目**: parseDoc関数でparseSectionWrapperを呼び出し
2. **3219行目**: result = parseSectionWrapper(p)でドキュメント全体をパース
3. **3220-3221行目**: currentTok(p).kind != tkEofの場合にmeGeneralParseErrorを発行

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

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

**主要処理フロー**:
- **254行目**: meGeneralParseError -> errRstGeneralParseErrorへの変換

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

```
nim doc (ドキュメント生成コマンド)
    │
    ├─ docgen.nim::generateDoc
    │      │
    │      └─ rst.nim::rstParse
    │             │
    │             └─ parseDoc (3218-3221行目)
    │                    │
    │                    ├─ parseSectionWrapper
    │                    │
    │                    └─ rstMessage(meGeneralParseError) [tkEof以外の場合]
    │
    └─ docgen.nim::compilerMsgHandler (254行目)
           │
           └─ msgs.nim::globalError (errRstGeneralParseError)
```

### データフロー図

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

RST/Markdownファイル ───▶ rst.nim::parseDoc ───▶ MsgKind(meGeneralParseError)
                              │
                              ▼ [tkEof以外の場合]
                         docgen.nim::compilerMsgHandler
                              │
                              ▼
                         TMsgKind(errRstGeneralParseError)
                              │
                              ▼
                         msgs.nim::globalError
                              │
                              ▼
                         stderr / 構造化エラーフック
```

### 関連ファイル一覧

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