# 機能設計書 63-メタプログラミング機能

## 概要

本ドキュメントは、mrubyにおけるメタプログラミング機能の設計を記述する。mruby-metaprog gemとして実装され、オブジェクトやモジュールのリフレクション・イントロスペクション機能を提供する。

### 本機能の処理概要

メタプログラミング機能は、実行時にオブジェクトやクラス・モジュールの構造を動的に調査・操作するためのメソッド群を提供する。インスタンス変数の取得・設定・定義確認、クラス変数の管理、メソッド一覧の取得、シングルトンクラスへのアクセス、send/public_sendによる動的メソッド呼び出し等を実現する。

**業務上の目的・背景**：Rubyの特徴であるメタプログラミングは、フレームワークやDSL（ドメイン固有言語）の構築に不可欠である。mrubyでもこれらの機能を提供することで、柔軟なプログラミングパラダイムをサポートする。

**機能の利用シーン**：DSL構築、テストフレームワークのモック生成、シリアライゼーション処理でのインスタンス変数走査、プラグインシステムにおける動的メソッド呼び出し、デバッグ時のオブジェクト構造調査等で使用される。

**主要な処理内容**：
1. インスタンス変数操作（instance_variable_get/set/defined?/instance_variables）
2. クラス変数操作（class_variable_get/set/defined?/class_variables/remove_class_variable）
3. メソッド一覧取得（methods/private_methods/protected_methods/public_methods/singleton_methods）
4. モジュール・クラスのメソッド一覧（instance_methods/public_instance_methods/private_instance_methods/protected_instance_methods/undefined_instance_methods）
5. シングルトンクラスアクセス（singleton_class）
6. 動的メソッド呼び出し（send/public_send）
7. 動的メソッド定義（define_singleton_method）
8. メソッド削除（remove_method）
9. ローカル変数一覧（local_variables）
10. グローバル変数一覧（global_variables）
11. 定数一覧（constants/nesting）
12. 含まれるモジュール一覧（included_modules）

**関連システム・外部連携**：Kernelモジュール・Moduleクラスのメソッドとして定義。mruby-method gemと連携してメソッドオブジェクトの取得を可能にする。

**権限による制御**：send/public_sendはvisibility（public/protected/private）に基づくアクセス制御を実施。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| - | - | - | CLIベースのため画面なし |

## 機能種別

リフレクション / メタプログラミング

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| sym/name | Symbol/String | Yes | 変数名・メソッド名 | 種別に応じた名前規約チェック |
| value | Object | No | 設定する値 | 型制約なし |
| all | Boolean | No | 祖先クラスを含めるか（デフォルトtrue） | - |

### 入力データソース

mrubyスクリプトからの直接呼び出し

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| メソッド一覧 | Array[Symbol] | メソッド名のSymbol配列 |
| 変数値 | Object | 変数の値 |
| 定義有無 | Boolean | 変数・メソッドの定義有無 |

### 出力先

mruby値スタック上に結果を返却

## 処理フロー

### 処理シーケンス

```
1. メソッド名・変数名のバリデーション
   └─ 名前規約チェック（@@prefix for class vars, @prefix for instance vars）
2. 対象オブジェクト/クラスの特定
   └─ selfまたは引数からオブジェクトを取得
3. メソッドテーブル/変数テーブルの走査
   └─ kh_hash（ハッシュテーブル）を使用した効率的な走査
4. 結果の構築と返却
   └─ Symbolの配列やBoolean値として返却
```

### フローチャート

```mermaid
flowchart TD
    A[メタプログラミングメソッド呼び出し] --> B{メソッド種別}
    B -->|変数操作| C[名前規約チェック]
    B -->|メソッド一覧| D[可視性フィルタ設定]
    B -->|send/public_send| E[メソッド探索]
    C --> F[変数テーブルアクセス]
    D --> G[メソッドテーブル走査]
    E --> H[メソッド実行]
    F --> I[結果返却]
    G --> I
    H --> I
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-63-01 | インスタンス変数名規約 | @で始まる識別子のみ受け付ける | instance_variable_*系メソッド |
| BR-63-02 | クラス変数名規約 | @@で始まる識別子のみ受け付ける | class_variable_*系メソッド |
| BR-63-03 | 可視性フィルタ | methods系メソッドはpublic/protected/privateに応じてフィルタ | メソッド一覧取得時 |
| BR-63-04 | 祖先クラス走査 | allパラメータがtrueの場合、祖先クラスのメソッドも含める | メソッド一覧取得時 |

### 計算ロジック

khash（オープンアドレス法ハッシュテーブル）を使用してメソッドテーブルの重複排除を行う。

## データベース操作仕様

該当なし

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| - | NameError | 不正な変数名・メソッド名 | 名前規約を確認 |
| - | NoMethodError | send/public_sendで存在しないメソッド | メソッド名を確認 |

### リトライ仕様

該当なし

## トランザクション仕様

該当なし

## パフォーマンス要件

khashによる効率的なメソッドテーブル走査。ROM（Read-Only Memory）テーブルによるメソッド登録でメモリ効率を最適化。

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

sendメソッドはprivateメソッドも呼び出せるため、信頼できないコードからの利用に注意。public_sendはpublicメソッドのみ呼び出し可能。

## 備考

MRB_MT_INIT_ROMマクロによるROMテーブルベースの高速メソッド登録を採用。

---

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

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

### 推奨読解順序

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

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | metaprog.c | `mrbgems/mruby-metaprog/src/metaprog.c` | khash(st)によるメソッド名重複排除、mt_set構造体 |

**読解のコツ**:
- **130-131行目**: KHASH_DECLARE/DEFINEマクロでシンボルキーのハッシュテーブルを定義
- **133-136行目**: mt_set構造体 - 可視性フィルタとハッシュセットの組み合わせ
- **138行目**: vicheckマクロ - メソッドの可視性チェック

#### Step 2: Kernelモジュールのメソッドを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | metaprog.c | `mrbgems/mruby-metaprog/src/metaprog.c` | インスタンス変数・メソッド一覧の実装 |

**主要処理フロー**:
- **39-47行目**: mrb_obj_ivar_defined() - インスタンス変数定義確認
- **69-77行目**: mrb_obj_ivar_get() - インスタンス変数取得
- **99-109行目**: mrb_obj_ivar_set() - インスタンス変数設定
- **124-128行目**: mrb_local_variables() - ローカル変数一覧
- **160-191行目**: mrb_class_instance_method_list() - メソッド一覧取得（khashによる重複排除）

#### Step 3: gem初期化とROMテーブルを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | metaprog.c | `mrbgems/mruby-metaprog/src/metaprog.c` | MRB_MT_INIT_ROMによるメソッド登録 |

**主要処理フロー**:
- **689-705行目**: metaprog_krn_rom_entries[] - Kernelモジュールへの15メソッド登録
- **707-722行目**: metaprog_mod_rom_entries[] - Moduleクラスへの14メソッド登録
- **724-734行目**: mrb_mruby_metaprog_gem_init() - gem初期化

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

```
obj.methods / obj.instance_variable_get 等
    |
    +-- mrb_obj_methods_m()
    |       +-- mrb_obj_methods()
    |           +-- mrb_class_instance_method_list()
    |               +-- method_entry_loop()
    |                   +-- mrb_mt_foreach() ... メソッドテーブル走査
    |
    +-- mrb_obj_ivar_get/set/defined()
    |       +-- mrb_iv_get/set/defined() ... 変数テーブルアクセス
    |
    +-- mrb_f_send()  ... 動的メソッド呼び出し（VMレベル）
```

### データフロー図

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

Symbol (変数名)    ──▶ 変数テーブル検索     ──▶ 値 or Boolean
Symbol (メソッド名) ──▶ メソッドテーブル走査  ──▶ Symbol配列
obj + Symbol       ──▶ send/public_send     ──▶ メソッド戻り値
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| metaprog.c | `mrbgems/mruby-metaprog/src/metaprog.c` | ソース | メタプログラミング機能全実装（740行） |
| mrbgem.rake | `mrbgems/mruby-metaprog/mrbgem.rake` | 設定 | gem仕様定義 |
| metaprog.rb | `mrbgems/mruby-metaprog/test/metaprog.rb` | テスト | テストケース |
