# 通知設計書 34-warnRstLanguageXNotSupported

## 概要

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

### 本通知の処理概要

本警告は、RST（reStructuredText）またはMarkdown形式のドキュメント内で、コードブロックの言語指定（`.. code-block:: 言語名`やMarkdownの```言語名）やインラインコードのロール指定で、シンタックスハイライターがサポートしていない言語が指定された場合に開発者へ通知するものである。

**業務上の目的・背景**：Nimのドキュメントシステムは、コードブロックに対してシンタックスハイライトを適用する機能を持つ。サポートされていない言語が指定された場合、コードはハイライトされずにプレーンテキストとして表示される。この警告により、ドキュメント作成者はスペルミスや未サポート言語の使用を認識し、適切な言語名に修正できる。

**通知の送信タイミング**：`nim doc`コマンドによるドキュメント生成時、以下の場面でトリガーされる：
1. コードブロックディレクティブ（code-block、code）の言語パラメータ解析時
2. ロールディレクティブの言語フィールド解析時
3. シンタックスハイライト適用時（rstgen.nim）

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

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

**期待されるアクション**：開発者は指定した言語名のスペルを確認する、サポートされている言語名に変更する、または言語指定を削除してデフォルト（Nim）を使用する必要がある。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

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

```
{ファイルパス}({行},{列}) Warning: language '{言語名}' not supported [LanguageXNotSupported]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| $1 | サポートされていない言語名 | コードブロック/ロールのパラメータ | Yes |
| filename | ソースファイルパス | TLineInfo.fileIndex | Yes |
| line | 行番号 | TLineInfo.line | Yes |
| col | 列番号 | TLineInfo.col | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ドキュメント生成 | nim doc コマンド実行 | コードブロックの言語がlangNone | dirCodeBlock関数で発生 |
| ドキュメント生成 | nim doc コマンド実行 | ロールの言語がlangNone | whichRole関数で発生 |
| ドキュメント生成 | nim doc コマンド実行 | シンタックスハイライト適用時に言語不明 | renderCodeBlock関数で発生 |

### 送信抑止条件

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

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[nim doc コマンド実行] --> B[RSTパーサー]
    B --> C{ノード種別}
    C -->|code-blockディレクティブ| D[dirCodeBlock関数]
    C -->|roleディレクティブ| E[dirRole関数]
    C -->|インラインロール| F[whichRole関数]
    D --> G[言語パラメータ取得]
    E --> H[languageフィールド取得]
    F --> I[ロール名を言語として解釈]
    G --> J[getSourceLanguage呼び出し]
    H --> J
    I --> J
    J --> K{結果 == langNone?}
    K -->|Yes かつ 言語名あり| L[mwUnsupportedLanguage警告発行]
    K -->|No| M[シンタックスハイライト適用]
    L --> N[compilerMsgHandler呼び出し]
    N --> O[warnRstLanguageXNotSupportedに変換]
    O --> P[警告メッセージ出力]
    M --> Q[処理継続]
    P --> Q
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| SourceLanguage列挙型 | サポート言語の判定 | highlite.nim内で定義 |

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

#### SourceLanguage

| 参照項目 | 用途 | 取得条件 |
|---------|------|---------|
| 言語名文字列 | getSourceLanguage関数で判定 | 大文字小文字を無視して比較 |

### 更新テーブル一覧

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

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 言語未サポート | getSourceLanguageがlangNoneを返す | 警告出力、プレーンテキストとして処理継続 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

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

## 備考

- サポートされている言語はhighlite.nimのSourceLanguage列挙型で定義されている
- 主要なサポート言語：Nim、C、C++、Python、JavaScript、Java、Go、Rust、など多数
- 言語名の比較は大文字小文字を区別しない
- 言語が"none"と明示的に指定された場合は警告を出さない

---

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

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

### 推奨読解順序

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

まず、警告の種類定義とサポート言語の判定ロジックを理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnRstLanguageXNotSupportedの定義（60行目）とメッセージ文字列（154行目）を確認 |
| 1-2 | rst.nim | `lib/packages/docutils/rst.nim` | MsgKind列挙型でmwUnsupportedLanguageの定義（75行目）を確認 |
| 1-3 | highlite.nim | `lib/packages/docutils/highlite.nim` | SourceLanguage列挙型とgetSourceLanguage関数を確認 |

**読解のコツ**: getSourceLanguage関数は言語名文字列を受け取り、対応するSourceLanguage列挙値を返す。未知の言語名の場合はlangNoneを返す。

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

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

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

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

#### Step 3: 言語検証処理を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | rst.nim | `lib/packages/docutils/rst.nim` | whichRole関数（1285-1288行目）でロール名を言語として解釈し、未サポート時に警告 |
| 3-2 | rst.nim | `lib/packages/docutils/rst.nim` | dirRole関数（3420-3423行目）でlanguageフィールドの検証 |
| 3-3 | rstgen.nim | `lib/packages/docutils/rstgen.nim` | renderCodeBlock関数（973-977行目）でシンタックスハイライト適用時の検証 |

**主要処理フロー**:
- **1287-1288行目**: whichRoleAuxがrnUnknownRoleを返した場合にmwUnsupportedLanguage警告
- **3422-3423行目**: getSourceLanguageがlangNoneを返した場合にmwUnsupportedLanguage警告
- **974-977行目**: 言語名がありかつlangNoneの場合にmwUnsupportedLanguage警告

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

```
nim doc (main.nim)
    │
    ├─ commandDoc (docgen2.nim)
    │      │
    │      └─ generateDoc (docgen.nim)
    │             │
    │             ├─ newDocumentor
    │             │      └─ declareClosures
    │             │             └─ compilerMsgHandler [263行目]
    │             │
    │             ├─ RSTパース
    │             │      ├─ whichRole [1287行目]
    │             │      │      └─ rstMessage (mwUnsupportedLanguage)
    │             │      │
    │             │      └─ dirRole [3422行目]
    │             │             └─ rstMessage (mwUnsupportedLanguage)
    │             │
    │             └─ RST→HTML変換 (rstgen.nim)
    │                    └─ renderCodeBlock [976行目]
    │                           └─ rstMessage (mwUnsupportedLanguage)
    │
    └─ 警告出力 (msgs.nim)
```

### データフロー図

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

.nim/.rst/.md ───▶ RSTパーサー ───▶ PRstNode (AST)
     ファイル         │
                      │
                      ├─ code-blockディレクティブ
                      │      │
                      │      └─ 言語パラメータ抽出
                      │             │
                      │             └─ getSourceLanguage
                      │                    │
                      │                    └─ langNone ───▶ mwUnsupportedLanguage ───▶ 警告出力
                      │
                      └─ ロール指定
                             │
                             └─ whichRole
                                    │
                                    └─ rnUnknownRole ───▶ mwUnsupportedLanguage ───▶ 警告出力

PRstNode ───▶ rstgen (HTML生成) ───▶ HTML
                   │
                   └─ renderCodeBlock
                          │
                          └─ langNone かつ 言語名あり ───▶ mwUnsupportedLanguage ───▶ 警告出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| 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変換 |
| highlite.nim | `lib/packages/docutils/highlite.nim` | ソース | シンタックスハイライト、SourceLanguage定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力機能 |
