# 通知設計書 40-warnUseBase

## 概要

本ドキュメントは、Nimコンパイラにおいて、メソッド定義時に`{.base.}`プラグマが指定されていない場合に出力される警告「warnUseBase」の設計仕様を記述する。

### 本通知の処理概要

本警告は、オブジェクト指向プログラミングにおけるメソッド定義で、基底メソッド（継承階層の最上位にあるメソッド）に`{.base.}`プラグマが付与されていない場合に開発者へ通知するものである。

**業務上の目的・背景**：Nimのメソッドシステムでは、継承階層における動的ディスパッチを実現するために、基底メソッドを`{.base.}`プラグマで明示的にマークすることが推奨されている。このプラグマがない場合、コンパイラはメソッドが基底メソッドかどうかを自動推論するが、これは将来的に非推奨となる予定である。この警告により、開発者は明示的に基底メソッドを指定し、コードの意図を明確にすることができる。

**通知の送信タイミング**：コンパイル時、メソッド定義の解析（cgmeth.nim内のmethodDef関数）において、新しいメソッドディスパッチャーが作成される際に、`sfBase`フラグが設定されていない場合にトリガーされる。

**通知の受信者**：Nimソースコードを編集している開発者。

**通知内容の概要**：「use {.base.} for base methods; baseless methods are deprecated」形式で、基底メソッドには{.base.}プラグマの使用が推奨されることが通知される。

**期待されるアクション**：開発者は、基底メソッド（継承階層で最初に定義されるメソッド）に`{.base.}`プラグマを追加する必要がある。

## 通知種別

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

## 送信仕様

### 基本情報

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

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

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

## 通知テンプレート

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

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

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

```
{ファイルパス}({行},{列}) Warning: use {.base.} for base methods; baseless methods are deprecated [UseBase]
```

### 添付ファイル

なし

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| filename | ソースファイルパス | メソッドシンボルのinfo | Yes |
| line | 行番号 | メソッドシンボルのinfo.line | Yes |
| col | 列番号 | メソッドシンボルのinfo.col | Yes |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| コンパイル | メソッド定義の解析 | 新しいディスパッチャー作成時にsfBaseフラグなし | cgmeth.nim:199行目 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| --warning[UseBase]:off | コマンドラインオプションで警告を無効化 |
| {.warning[UseBase]:off.} | ソースコード内プラグマで警告を無効化 |
| {.base.}プラグマが付与されている | sfBaseフラグが設定されている場合は警告なし |
| 派生メソッド | 既存のディスパッチャーにアタッチされる場合は警告なし |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[コンパイル開始] --> B[メソッド定義検出]
    B --> C[methodDef関数呼び出し]
    C --> D{既存のディスパッチャーに一致?}
    D -->|Yes| E[既存ディスパッチャーにアタッチ]
    D -->|No| F[新しいディスパッチャー作成]
    F --> G{sfBaseフラグ設定済み?}
    G -->|Yes| H[警告なし]
    G -->|No| I[warnUseBase警告発行]
    I --> J[message関数呼び出し]
    J --> K[警告メッセージ出力]
    E --> L[コンパイル継続]
    H --> L
    K --> L
```

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

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| ModuleGraph.methods | メソッドバケットの管理 | 既存のディスパッチャーとの比較 |
| PSym.flags | シンボルフラグの参照 | sfBaseの有無を確認 |

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

#### ModuleGraph.methods

| 参照項目 | 用途 | 取得条件 |
|---------|------|---------|
| methods[i].dispatcher | 既存ディスパッチャーの取得 | メソッド定義解析時 |
| methods[i].methods | 同一バケット内のメソッド一覧 | sameMethodBucket比較時 |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| ModuleGraph.methods | INSERT | 新しいメソッドバケットの追加 |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 基底プラグマなし | 新規メソッドにsfBaseフラグなし | 警告出力、コンパイル継続 |

### リトライ仕様

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

## 配信設定

### レート制限

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

### 配信時間帯

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

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

- メソッド名やファイルパスが警告メッセージに含まれるが、開発環境での使用を想定しており問題なし

## 備考

- `{.base.}`プラグマは、継承階層の基底メソッドを明示的にマークするために使用される
- 将来的に、{.base.}なしのメソッドはコンパイルエラーになる可能性がある
- マルチメソッド（multi-methods）機能を使用する場合も同様の警告が適用される
- vtables機能が有効な場合、メソッドは同じモジュール内で定義する必要がある（別のエラーが発生する）

---

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

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

### 推奨読解順序

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

まず、警告の種類定義とメソッドシステムの基本構造を理解することが重要。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | lineinfos.nim | `compiler/lineinfos.nim` | TMsgKind列挙型でwarnUseBaseの定義（66行目）とメッセージ文字列（160行目）を確認 |
| 1-2 | ast.nim | `compiler/ast.nim` | sfBaseフラグの定義を確認（TSymFlag列挙型） |

**読解のコツ**: sfBaseはシンボルフラグで、{.base.}プラグマが付与されたメソッドに設定される。

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

メソッド解析の起点を特定。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | cgmeth.nim | `compiler/cgmeth.nim` | methodDef関数（160-199行目）でメソッド定義の解析と警告発行を確認 |

**主要処理フロー**:
1. **160-169行目**: メソッド定義のバリデーション
2. **170-186行目**: 既存ディスパッチャーとの比較
3. **187-193行目**: 新規ディスパッチャーの作成
4. **198-199行目**: sfBaseフラグがない場合にwarnUseBase警告発行

#### Step 3: メソッドバケットの仕組みを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | cgmeth.nim | `compiler/cgmeth.nim` | sameMethodBucket関数（69-112行目）でメソッドの比較ロジックを確認 |
| 3-2 | cgmeth.nim | `compiler/cgmeth.nim` | createDispatcher関数（124-148行目）でディスパッチャー作成処理を確認 |

**主要処理フロー**:
- **69-112行目**: メソッドシグネチャの比較、継承関係の確認
- **124-148行目**: ディスパッチャーシンボルの作成、sfDispatcherフラグの設定

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

```
コンパイル (sem.nim)
    │
    ├─ semProcAux (メソッド定義の意味解析)
    │      │
    │      └─ methodDef (cgmeth.nim:160)
    │             │
    │             ├─ sameMethodBucket (既存ディスパッチャー検索)
    │             │      │
    │             │      └─ Yes: attachDispatcher
    │             │
    │             └─ No: createDispatcher
    │                    │
    │                    └─ sfBase未設定時
    │                           │
    │                           └─ message (warnUseBase) [199行目]
    │
    └─ 警告出力 (msgs.nim)
```

### データフロー図

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

method定義 ───▶ methodDef関数 ───▶ ディスパッチャー管理
   .nim           │
   ファイル       │
                  ├─ 既存ディスパッチャー検索
                  │      │
                  │      └─ 見つかった ───▶ アタッチ
                  │
                  └─ 見つからない
                         │
                         ├─ createDispatcher
                         │
                         └─ sfBaseチェック
                                │
                                └─ 未設定 ───▶ warnUseBase ───▶ 警告出力
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| lineinfos.nim | `compiler/lineinfos.nim` | ソース | 警告種別定義（TMsgKind） |
| cgmeth.nim | `compiler/cgmeth.nim` | ソース | メソッド処理、警告発行 |
| ast.nim | `compiler/ast.nim` | ソース | sfBaseフラグ定義 |
| msgs.nim | `compiler/msgs.nim` | ソース | メッセージ出力機能 |
| modulegraphs.nim | `compiler/modulegraphs.nim` | ソース | methods配列の管理 |
