# 通知設計書 35-warnRstFieldXNotSupported

## 概要

本ドキュメントは、Nimコンパイラのドキュメント生成機能（nim doc）において、RST/Markdownドキュメント内のディレクティブでサポートされていないフィールドが指定された場合に出力される警告「warnRstFieldXNotSupported」の設計仕様を記述する。

### 本通知の処理概要

本警告は、RST（reStructuredText）またはMarkdown形式のドキュメント内で、ディレクティブ（code-block、image、figureなど）のオプションフィールドとしてサポートされていないフィールド名が指定された場合に開発者へ通知するものである。

**業務上の目的・背景**：RSTディレクティブは`:フィールド名: 値`形式でオプションを指定できる。例えば、code-blockディレクティブでは`:linenos:`、`:number-lines:`などのフィールドがサポートされている。未知のフィールドが指定された場合、そのオプションは無視される。この警告により、ドキュメント作成者はスペルミスや未サポートフィールドの使用を認識し、適切なフィールド名に修正できる。

**通知の送信タイミング**：`nim doc`コマンドによるドキュメント生成時、RST→HTML/LaTeX変換（rstgen.nim）においてコードブロックパラメータを解析する際、認識できないフィールドが検出された場合にトリガーされる。

**通知の受信者**：Nimソースコードまたはスタンドアロンのドキュメントファイル（.rst/.md）を編集している開発者・ドキュメント作成者。

**通知内容の概要**：「field '$1' not supported」形式で、サポートされていないフィールド名が通知される。$1には指定されたフィールド名が入る。

**期待されるアクション**：開発者は指定したフィールド名のスペルを確認する、サポートされているフィールド名に変更する、または不要なフィールドを削除する必要がある。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

コンパイラの設定に基づき、標準エラー出力へ警告メッセージを出力する。`--warning[FieldXNotSupported]:off`オプションで抑止可能。

## 通知テンプレート

### コンパイラ警告メッセージの場合

| 項目 | 内容 |
|-----|------|
| 出力先 | 標準エラー出力 |
| 重要度 | Warning |
| メッセージID | FieldXNotSupported |
| 形式 | テキスト |

### メッセージテンプレート

```
{ファイルパス}({行},{列}) Warning: field '{フィールド名}' not supported [FieldXNotSupported]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | サポートされていないフィールド名 | ディレクティブのフィールドリスト | Yes |
| filename | ソースファイルパス | TLineInfo.fileIndex | Yes |
| line | 行番号 | TLineInfo.line | Yes |
| col | 列番号 | TLineInfo.col | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ドキュメント生成 | nim doc コマンド実行 | コードブロックの未知フィールド | parseCodeBlockField関数で発生 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning[FieldXNotSupported]:off | コマンドラインオプションで警告を無効化 |
| {.warning[FieldXNotSupported]:off.} | ソースコード内プラグマで警告を無効化 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[nim doc コマンド実行] --> B[RSTパーサー]
    B --> C[PRstNode AST生成]
    C --> D[rstgen HTML/LaTeX変換]
    D --> E{code-blockノード?}
    E -->|Yes| F[parseCodeBlockParams呼び出し]
    F --> G[フィールドリスト走査]
    G --> H{フィールド名}
    H -->|default-language/language| I[言語設定]
    H -->|file| J[ファイル設定]
    H -->|number-lines/linenos/line| K[行番号設定]
    H -->|start-line| L[開始行設定]
    H -->|end-line| M[終了行設定]
    H -->|その他| N[parseCodeBlockField呼び出し]
    N --> O{認識可能?}
    O -->|No| P[mwUnsupportedField警告発行]
    O -->|Yes| Q[フィールド値適用]
    P --> R[compilerMsgHandler呼び出し]
    R --> S[warnRstFieldXNotSupportedに変換]
    S --> T[警告メッセージ出力]
    I --> U[処理継続]
    J --> U
    K --> U
    L --> U
    M --> U
    Q --> U
    T --> U
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| なし | - | フィールド名はハードコードで判定 |

### テーブル別参照項目詳細

なし

### 更新テーブル一覧

なし（読み取り専用処理）

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| フィールド未サポート | 認識できないフィールド名 | 警告出力、フィールドを無視して処理継続 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- フィールド名はユーザー入力由来だが、警告メッセージへの出力のみで特別なセキュリティリスクなし

## 備考

- サポートされているcode-blockフィールド:
  - `default-language` / `language`: シンタックスハイライトの言語指定
  - `file`: 外部ファイルからコードを読み込む
  - `number-lines` / `linenos` / `line`: 行番号を表示
  - `start-line`: 表示開始行
  - `end-line`: 表示終了行
- 他のディレクティブ（image、figureなど）でも同様の警告が発行される可能性がある

---

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

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

### 推奨読解順序

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

まず、警告の種類定義を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnRstFieldXNotSupportedの定義（61行目）とメッセージ文字列（155行目）を確認 |
| 1-2 | rst.nim | `lib/packages/docutils/rst.nim` | MsgKind列挙型でmwUnsupportedFieldの定義（76行目）を確認 |

**読解のコツ**: FieldXNotSupportedは主にrstgen.nimで発行される。RST→HTML変換時に発生することに注意。

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

処理の起点となるドキュメント生成モジュールを特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | docgen.nim | `compiler/docgen.nim` | compilerMsgHandler関数（242-277行目）でRSTメッセージをコンパイラ警告に変換 |

**主要処理フロー**:
1. **264行目**: `of mwUnsupportedField: k = warnRstFieldXNotSupported` - メッセージ種別のマッピング
2. **271-277行目**: `globalError`または`liMessage`で警告出力

#### Step 3: フィールド解析処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | rstgen.nim | `lib/packages/docutils/rstgen.nim` | parseCodeBlockField関数（860-865行目）でフィールドの検証と警告発行を確認 |
| 3-2 | rstgen.nim | `lib/packages/docutils/rstgen.nim` | parseCodeBlockParams関数（867-900行目付近）でフィールドリストの走査を確認 |

**主要処理フロー**:
- **864-865行目**: 認識できないフィールド名の場合にmwUnsupportedField警告発行

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

```
nim doc (main.nim)
    │
    ├─ commandDoc (docgen2.nim)
    │      │
    │      └─ generateDoc (docgen.nim)
    │             │
    │             ├─ newDocumentor
    │             │      └─ declareClosures
    │             │             └─ compilerMsgHandler [264行目]
    │             │
    │             ├─ RSTパース
    │             │      └─ PRstNode AST生成
    │             │
    │             └─ RST→HTML変換 (rstgen.nim)
    │                    └─ renderRstToOut
    │                           └─ renderCodeBlock
    │                                  └─ parseCodeBlockParams
    │                                         └─ parseCodeBlockField [864行目]
    │                                                └─ rstMessage (mwUnsupportedField)
    │
    └─ 警告出力 (msgs.nim)
```

### データフロー図

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

.nim/.rst/.md ───▶ RSTパーサー ───▶ PRstNode (AST)
     ファイル

PRstNode ───▶ rstgen (HTML生成) ───▶ HTML
                   │
                   └─ renderCodeBlock
                          │
                          └─ parseCodeBlockParams
                                 │
                                 ├─ フィールドリスト走査
                                 │      │
                                 │      └─ parseCodeBlockField
                                 │             │
                                 │             ├─ language/file/linenos/etc ───▶ 値適用
                                 │             │
                                 │             └─ 未知フィールド ───▶ mwUnsupportedField ───▶ 警告出力
                                 │
                                 └─ CodeBlockParams構築
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別定義（TMsgKind） |
| docgen.nim | `compiler/docgen.nim` | ソース | ドキュメント生成、メッセージハンドラ |
| rst.nim | `lib/packages/docutils/rst.nim` | ソース | RSTパーサー本体 |
| rstgen.nim | `lib/packages/docutils/rstgen.nim` | ソース | RST→HTML/LaTeX変換、フィールド解析 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力機能 |
