# 通知設計書 4-errIllFormedAstX

## 概要

本ドキュメントは、Nimコンパイラにおけるエラー通知「errIllFormedAstX」の設計仕様を定義する。

### 本通知の処理概要

errIllFormedAstXは、コンパイラが不正な形式の抽象構文木（AST）を検出した場合に出力されるエラー通知である。ASTはソースコードの構造化された表現であり、その整合性が崩れている場合にこのエラーが発生する。

**業務上の目的・背景**：コンパイラはソースコードをAST（抽象構文木）に変換し、そのASTを解析・変換して最終的なコードを生成する。AST構造が期待される形式と異なる場合、コンパイル処理を続行できないため、開発者に問題を通知する必要がある。このエラーは、マクロやテンプレートによって生成された不正なコード、または内部処理の問題を検出する。

**通知の送信タイミング**：意味解析（セマンティック解析）フェーズで、ASTノードの子要素の数や構造が期待と異なることを検出した時点で発行される。主にsemdata.nim内のillFormedAst/illFormedAstLocal関数から呼び出される。

**通知の受信者**：Nimソースコードをコンパイルしている開発者。特にマクロやテンプレートを使用している場合にこのエラーに遭遇する可能性がある。

**通知内容の概要**：「illformed AST: {AST内容}」という形式で出力される。$1プレースホルダーにはrenderTree関数で整形されたAST表現が挿入される。

**期待されるアクション**：開発者は、出力されたAST情報を確認し、マクロやテンプレートの実装を見直すか、構文エラーを修正することが期待される。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

コンパイラオプション`--stdout`が指定されている場合はstdoutに、それ以外はstderrに出力される。

## 通知テンプレート

### コンソール通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元 | Nimコンパイラ |
| メッセージ種別 | Error |
| 形式 | テキスト |

### 本文テンプレート

```
{ファイル名}({行},{列}) Error: illformed AST: {AST内容}
```

### 添付ファイル

該当なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | 不正なAST内容 | renderTree(n, {renderNoComments}) | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| 意味解析処理 | AST構造チェック失敗 | illFormedAst呼び出し | 致命的なAST不整合 |
| 意味解析処理 | AST構造チェック失敗 | illFormedAstLocal呼び出し | 非致命的なAST不整合 |
| 意味解析処理 | 子ノード数チェック失敗 | checkSonsLen呼び出し | ノード数の不一致 |
| 意味解析処理 | 最小子ノード数チェック失敗 | checkMinSonsLen呼び出し | ノード数不足 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| なし | エラーのため常に出力される |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[AST処理] --> B{AST構造チェック}
    B -->|不正| C[illFormedAst呼び出し]
    B -->|正常| D[処理継続]
    C --> E[renderTree実行]
    E --> F[globalError/localError呼び出し]
    F --> G[liMessage処理]
    G --> H[メッセージ出力]
    H --> I{globalError?}
    I -->|Yes| J[例外発生 doRaise]
    I -->|No| K[エラーカウント増加]
```

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

### 参照テーブル一覧

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

### 更新テーブル一覧

該当なし

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| AST子ノード数不一致 | checkSonsLen失敗 | マクロ/テンプレートの修正 |
| AST最小ノード数不足 | checkMinSonsLen失敗 | コード構造の見直し |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

制限なし

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

- エラーメッセージにはソースコードの一部（AST表現）が含まれる
- ファイルパス情報が含まれる可能性がある
- ローカル開発環境での使用を想定

## 備考

- errIllFormedAstXはエラー（Error）カテゴリに属する（Fatal Errorではない）
- globalError使用時はdoRaiseで例外を発生させる
- localError使用時はdoNothingでエラーカウントを増加させるのみ
- renderNoCommentsオプションでコメントを除外したAST表示を行う

---

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

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

### 推奨読解順序

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

errIllFormedAstX通知の基盤となるデータ構造を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でerrIllFormedAstXの定義を確認（34行目） |
| 1-2 | lineinfos.nim | `compiler/lineinfos.nim` | MsgKindToStr配列でメッセージ文字列を確認（124行目） |

**読解のコツ**: errIllFormedAstXは非致命的エラー（non-fatal errors）セクションの最初に定義されている。$1プレースホルダーにAST内容が挿入される。

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

通知発行の起点となるファイル・関数を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | semdata.nim | `compiler/semdata.nim` | illFormedAst関数（559-560行目） |
| 2-2 | semdata.nim | `compiler/semdata.nim` | illFormedAstLocal関数（562-563行目） |
| 2-3 | semdata.nim | `compiler/semdata.nim` | checkSonsLen関数（565-566行目） |

**主要処理フロー**:
1. **559-560行目**: illFormedAst - globalErrorでdoRaise（処理中断）
2. **562-563行目**: illFormedAstLocal - localErrorでdoNothing（処理継続）
3. **565-566行目**: checkSonsLen - ノード数チェック後、illFormedAst呼び出し

#### Step 3: AST描画処理を理解する

ASTを文字列に変換する処理を確認。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | renderer.nim | `compiler/renderer.nim` | renderTree関数 - AST描画処理 |

**主要処理フロー**:
- renderTree(n, {renderNoComments}) - コメントを除外したAST文字列を生成

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

```
意味解析モジュール (sem*.nim)
    │
    ├─ checkSonsLen(n, length, conf)
    │      │
    │      └─ illFormedAst(n, conf) (if n.len != length)
    │             │
    │             └─ renderTree(n, {renderNoComments})
    │                    │
    │                    └─ globalError(conf, n.info, errIllFormedAstX, ast)
    │
    └─ illFormedAstLocal(n, conf)
           │
           └─ renderTree(n, {renderNoComments})
                  │
                  └─ localError(conf, n.info, errIllFormedAstX, ast)
```

### データフロー図

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

不正なAST ───────▶ checkSonsLen ────────▶ 標準エラー出力
ノード (n)          │                       "illformed AST: {AST}"
                    ▼
              illFormedAst
                    │
                    ▼
              renderTree
                    │
                    ▼
              globalError
                    │
                    ▼
              liMessage
                    │
                    ▼
              handleError
                    │
                    ▼
              raiseRecoverableError
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | TMsgKind定義、メッセージ文字列定義 |
| semdata.nim | `compiler/semdata.nim` | ソース | illFormedAst関数、checkSonsLen関数 |
| msgs.nim | `compiler/msgs.nim` | ソース | globalError/localErrorテンプレート |
| renderer.nim | `compiler/renderer.nim` | ソース | renderTree関数（AST描画） |
| ast.nim | `compiler/ast.nim` | ソース | PNode定義（ASTノード） |
