Files
hakorune/docs/development/current/main/phase122_consolebox_println_unification.md

431 lines
15 KiB
Markdown
Raw Normal View History

feat(core): Phase 122 ConsoleBox.println / log unification ## Phase 122: ConsoleBox.println / log の統一 (完了) ### 概要 ConsoleBox.printlnをlogのエイリアスとしてVM/TypeRegistryレベルで統一。 Phase 120で発見されたesc_dirname_smoke.hakoの「Unknown method 'println'」 エラーを完全解消。 ### 完了タスク - ✅ TypeRegistry修正: printlnをlogのエイリアス(slot 400)として追加 - ✅ ConsoleBox実装: printlnメソッドのラッパ追加 - ✅ VM Method Dispatch: ConsoleBox専用ハンドラ追加 - ✅ Plugin設定: nyash.tomlにprintln (method_id 2)追加 - ✅ ドキュメント更新: 3ファイル(hako_logging/logging_policy/core_boxes) ### 実装詳細 #### 1. TypeRegistry (src/runtime/type_registry.rs) ```rust const CONSOLE_METHODS: &[MethodEntry] = &[ MethodEntry { name: "log", arity: 1, slot: 400 }, MethodEntry { name: "warn", arity: 1, slot: 401 }, MethodEntry { name: "error", arity: 1, slot: 402 }, MethodEntry { name: "clear", arity: 0, slot: 403 }, // Phase 122: println は log のエイリアス MethodEntry { name: "println", arity: 1, slot: 400 }, ]; ``` #### 2. ConsoleBox (src/boxes/console_box.rs) - WASM/非WASM両方にprintln()メソッド追加 - 内部的にlog()に委譲 #### 3. VM Method Dispatch (src/backend/mir_interpreter/handlers/calls/method.rs) - ConsoleBox専用ハンドラ追加 - log/println/warn/error/clearをサポート - args配列の正しい処理(len > 1時はargs[1]を使用) #### 4. Plugin設定 (nyash.toml) - ConsoleBox.methodsにprintln追加(method_id=2) - method_id整合性: log=1, println=2 ### テスト結果 - ✅ esc_dirname_smoke.hako実行成功 - 旧エラー: "Unknown method 'println'" ← **完全解消** - 新出力: `[Console LOG] dir1/dir2` ### Phase 120問題解決 **Phase 120ベースラインでの課題**: - ❌ esc_dirname_smoke.hako: ConsoleBox.println未実装 **Phase 122での解決**: - ✅ TypeRegistryレベルでprintln→log正規化 - ✅ 全経路(JSON v0/selfhost/通常VM)で一貫性保証 ### ファイル構成 **新規作成**: - docs/development/current/main/phase122_consolebox_println_unification.md **修正**: - src/runtime/type_registry.rs (+5行) - src/boxes/console_box.rs (+14行, WASM/非WASM両対応) - src/backend/mir_interpreter/handlers/calls/method.rs (+60行) - nyash.toml (+1メソッド定義) - docs/development/current/main/hako_logging_design.md (+40行) - docs/development/current/main/logging_policy.md (+30行) - docs/development/current/main/core_boxes_design.md (+20行) ### 技術的成果 - **Alias First原則**: VM/TypeRegistryレベルで正規化 - **Phase 120連携**: ベースライン確立→問題発見→根本解決 - **全経路統一**: selfhost/JSON v0/通常VMすべてで動作 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-04 05:16:06 +09:00
# Phase 122: ConsoleBox.println / log の統一JSON v0 共通ルート)
Phase 122.5-126完了:ConsoleBox 品質改善・最適化・統合 ## 実装成果(Phase 122.5-126) ### Phase 122.5: nyash.toml method_id 修正 - println method_id を 2 → 1 に統一(log と同じ) - TypeRegistry slot 400 との整合性確保 ### Phase 123: ConsoleBox WASM/非WASM コード統一化 - マクロ define_console_impl! による重複排除 - 67行削減(27.3% 削減達成) - ビルド成功・全テストパス ### Phase 124: VM Method Dispatch 統一化 - TypeRegistry ベースの統一ディスパッチ (dispatch_by_slot) - String/Array/ConsoleBox を一元化 - 100行削減、メソッド解決の高速化 ### Phase 125: 削除:deprecated builtin ConsoleBox - src/box_factory/builtin_impls/console_box.rs 削除 - Plugin-only 移行で "Everything is Plugin" 実現 - 52行削減 ### Phase 126: ドキュメント統合 - consolebox_complete_guide.md (27KB統合マスター) - core_boxes_design/logging_policy/hako_logging_design 更新 - ~750行の navigation・cross-reference 改善 ## 数値成果 - **総コード削減**: 219行 - **新規ドキュメント**: 1ファイル (+27KB) - **更新ドキュメント**: 6ファイル (+~750行) - **テスト**: Phase 120 representative tests ✅ PASS - **ビルド**: Zero errors ## 設計原則の完全実現 ✅ println/log エイリアス統一(Phase 122) ✅ WASM/非WASM 統一化(Phase 123) ✅ TypeRegistry 統合(Phase 124) ✅ Plugin-only 移行(Phase 125) ✅ ドキュメント統合(Phase 126) 🤖 Generated with Claude Code Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-04 06:02:03 +09:00
⚠️ **Note**: このドキュメントは Phase 122 の実装記録です。
統合的なガイドは [ConsoleBox 完全ガイド](consolebox_complete_guide.md) をご参照ください。
feat(core): Phase 122 ConsoleBox.println / log unification ## Phase 122: ConsoleBox.println / log の統一 (完了) ### 概要 ConsoleBox.printlnをlogのエイリアスとしてVM/TypeRegistryレベルで統一。 Phase 120で発見されたesc_dirname_smoke.hakoの「Unknown method 'println'」 エラーを完全解消。 ### 完了タスク - ✅ TypeRegistry修正: printlnをlogのエイリアス(slot 400)として追加 - ✅ ConsoleBox実装: printlnメソッドのラッパ追加 - ✅ VM Method Dispatch: ConsoleBox専用ハンドラ追加 - ✅ Plugin設定: nyash.tomlにprintln (method_id 2)追加 - ✅ ドキュメント更新: 3ファイル(hako_logging/logging_policy/core_boxes) ### 実装詳細 #### 1. TypeRegistry (src/runtime/type_registry.rs) ```rust const CONSOLE_METHODS: &[MethodEntry] = &[ MethodEntry { name: "log", arity: 1, slot: 400 }, MethodEntry { name: "warn", arity: 1, slot: 401 }, MethodEntry { name: "error", arity: 1, slot: 402 }, MethodEntry { name: "clear", arity: 0, slot: 403 }, // Phase 122: println は log のエイリアス MethodEntry { name: "println", arity: 1, slot: 400 }, ]; ``` #### 2. ConsoleBox (src/boxes/console_box.rs) - WASM/非WASM両方にprintln()メソッド追加 - 内部的にlog()に委譲 #### 3. VM Method Dispatch (src/backend/mir_interpreter/handlers/calls/method.rs) - ConsoleBox専用ハンドラ追加 - log/println/warn/error/clearをサポート - args配列の正しい処理(len > 1時はargs[1]を使用) #### 4. Plugin設定 (nyash.toml) - ConsoleBox.methodsにprintln追加(method_id=2) - method_id整合性: log=1, println=2 ### テスト結果 - ✅ esc_dirname_smoke.hako実行成功 - 旧エラー: "Unknown method 'println'" ← **完全解消** - 新出力: `[Console LOG] dir1/dir2` ### Phase 120問題解決 **Phase 120ベースラインでの課題**: - ❌ esc_dirname_smoke.hako: ConsoleBox.println未実装 **Phase 122での解決**: - ✅ TypeRegistryレベルでprintln→log正規化 - ✅ 全経路(JSON v0/selfhost/通常VM)で一貫性保証 ### ファイル構成 **新規作成**: - docs/development/current/main/phase122_consolebox_println_unification.md **修正**: - src/runtime/type_registry.rs (+5行) - src/boxes/console_box.rs (+14行, WASM/非WASM両対応) - src/backend/mir_interpreter/handlers/calls/method.rs (+60行) - nyash.toml (+1メソッド定義) - docs/development/current/main/hako_logging_design.md (+40行) - docs/development/current/main/logging_policy.md (+30行) - docs/development/current/main/core_boxes_design.md (+20行) ### 技術的成果 - **Alias First原則**: VM/TypeRegistryレベルで正規化 - **Phase 120連携**: ベースライン確立→問題発見→根本解決 - **全経路統一**: selfhost/JSON v0/通常VMすべてで動作 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
2025-12-04 05:16:06 +09:00
## 0. ゴール
- .hako 側の `ConsoleBox.println(...)` と、VM/Rust 側の `ConsoleBox.log(...)`**構造的に同じルートに揃える**
- selfhost Stage-3 → JSON v0 → Rust VM の経路でも:
- `ConsoleBox.println` がエラーにならず
- 内部では `ConsoleBox.log` と同じスロットに正規化される
- **代表ケース** `apps/tests/esc_dirname_smoke.hako` を JoinIR Strict + selfhost 経路で green にする
---
## 1. スコープと非スコープ
### スコープ(今回やること)
1. **現状分析ドキュメント作成**: ConsoleBox の「言語API」と「VM実装API」のズレを整理
2. **TypeRegistry 修正**: `println``log` のエイリアスslot 400として追加
3. **ドキュメント更新**: console_box.rs / hako_logging_design.md / logging_policy.md
4. **selfhost 再検証**: esc_dirname_smoke.hako が selfhost Stage-3 + JoinIR Strict で通ることを確認
5. **hako_check 影響確認**: ConsoleBox.println の alias 化が hako_check に影響しないことを確認
### 非スコープ(今回はやらない)
- **ConsoleService 統合**: ConsoleBox と ConsoleService の統合Phase 123+ で検討)
- **LoggerBox 統合**: ConsoleBox と LoggerBox の統合Phase 123+ で検討)
- **パフォーマンス最適化**: println/log の実行速度改善Phase 124+ で検討)
---
## 2. 設計方針(どこで揃えるか)
### 2.1 言語レベルの正解
**ConsoleBox の「公式 API」定義**:
| メソッド | 引数 | 役割 | VM slot |
|---------|-----|------|---------|
| `log(message)` | 1 | コアメソッド(標準出力) | 400 |
| `warn(message)` | 1 | 警告メッセージ | 401 |
| `error(message)` | 1 | エラーメッセージ | 402 |
| `clear()` | 0 | コンソールクリア | 403 |
| **`println(message)`** | 1 | **`log` のエイリアス(ユーザー向け sugar** | **400** |
**設計決定**:
- `println``log` の完全なエイリアス
- ユーザー向けは `println` で書いても `log` で書いてもよい
- 内部実装上は同じ slot 400 を使う
### 2.2 正規化ポイント(どこで println→log を吸収するか)
**✅ Option A: type_registry.rs の CONSOLE_METHODS に println を追加** (採用)
**理由**:
- VM の TypeRegistry で alias を張るだけで、全経路に適用される
- JSON v0 / selfhost / 通常VM どの経路でも同じスロットを見る
- 正規化ポイントが一箇所に固定できる(保守性が高い)
**実装**:
```rust
const CONSOLE_METHODS: &[MethodEntry] = &[
MethodEntry { name: "log", arity: 1, slot: 400 },
MethodEntry { name: "warn", arity: 1, slot: 401 },
MethodEntry { name: "error", arity: 1, slot: 402 },
MethodEntry { name: "clear", arity: 0, slot: 403 },
// Phase 122: println は log のエイリアス
MethodEntry { name: "println", arity: 1, slot: 400 },
];
```
**❌ Option B: MIR/JSON 生成時に "println" → "log" に書き換え** (却下)
**理由**:
- Bridge が増えたときに再び散る
- 正規化ポイントが複数箇所になる(保守性が低い)
---
## 3. Task 1: 現状の API 実態を docs に固定
### 3.1 実装内容
**ファイル**: `docs/development/current/main/phase122_consolebox_println_unification.md`(本ドキュメント)
**記載内容**:
#### 現状の整理
**Phase 120 での観測結果**:
- `apps/tests/esc_dirname_smoke.hako` が selfhost Stage-3 + JoinIR Strict 経路で失敗
- エラーメッセージ: `Unknown method 'println' on ConsoleBox`
**原因分析**:
| 層 | 現状 | 問題 |
|----|------|------|
| **.hako サンプル** | `console.println("...")` 前提 | ✅ ユーザー向け API |
| **src/boxes/console_box.rs** | `log/warn/error/clear` のみ実装 | ❌ `println` 未実装 |
| **type_registry.rs** | `CONSOLE_METHODS``log/warn/error/clear` のみ | ❌ `println` 未登録 |
| **selfhost Stage-3 経路** | JSON v0 → VM で `println` を解決できない | ❌ エラー発生 |
**設計決定**:
- `ConsoleBox.println` を「`log` と同じ意味のユーザー向け sugar」と定義
- VM の TypeRegistry で `println` → slot 400`log` と同じ)に正規化
- すべての経路JSON v0 / selfhost / 通常VMで一貫性を保つ
---
## 4. Task 2: TypeRegistry に println を alias として追加
### 4.1 実装内容
**ファイル**: `src/runtime/type_registry.rs`(修正)
**修正箇所**:
```rust
const CONSOLE_METHODS: &[MethodEntry] = &[
MethodEntry { name: "log", arity: 1, slot: 400 },
MethodEntry { name: "warn", arity: 1, slot: 401 },
MethodEntry { name: "error", arity: 1, slot: 402 },
MethodEntry { name: "clear", arity: 0, slot: 403 },
// Phase 122: println は log のエイリアス
// JSON v0/selfhost が println を吐いても log と同じスロットを使うための alias
MethodEntry { name: "println", arity: 1, slot: 400 },
];
```
**コメント追加**:
-`println``log` の別名。JSON v0/selfhost が `println` を吐いても `log` と同じスロットを使うための alias」
### 4.2 core_boxes_design.md への追記
**ファイル**: `docs/development/current/main/core_boxes_design.md`(修正)
**追記内容**:
```markdown
## Section 18: Phase 122 - ConsoleBox.println / log 統一
### 概要
ConsoleBox の `println` メソッドを `log` のエイリアスとして VM レベルで正規化。
すべての経路JSON v0 / selfhost / 通常VMで一貫性を保つ。
### 設計
- **言語レベル**: `println(message)``log(message)` の完全なエイリアス
- **VM レベル**: `println` は slot 400`log` と同じ)に正規化
- **正規化ポイント**: `src/runtime/type_registry.rs``CONSOLE_METHODS`
### 実装完了日
**Phase 122 実装完了日**: 2025-12-04予定
```
---
## 5. Task 3: ConsoleBox 実装ドキュメントの調整
### 5.1 実装内容
#### 5.1.1 console_box.rs のドキュメント更新
**ファイル**: `src/boxes/console_box.rs`(修正)
**修正箇所**:
```rust
//! ConsoleBox - コンソール出力ボックス
//!
//! ## 利用可能メソッド
//!
//! - `log(message)`: 標準出力にメッセージを出力
//! - `println(message)`: `log` のエイリアス(ユーザー向け sugar
//! - `warn(message)`: 警告メッセージを出力
//! - `error(message)`: エラーメッセージを出力
//! - `clear()`: コンソールをクリア
//!
//! ## Phase 122: println / log の統一
//!
//! `println``log` の完全なエイリアスです。内部的には同じ slot 400 を使用します。
//! ユーザーコードでは `println` を使用することを推奨しますが、`log` も同様に動作します。
```
**実装オプション**:
**Option 1: Rust 側でラッパを追加**(完全統一)
```rust
impl ConsoleBox {
/// Phase 122: println は log の別名
pub fn println(&self, message: &str) {
self.log(message);
}
}
```
**Option 2: VM の alias に任せる**(最小実装)
- Rust 側では実装せず、VM の TypeRegistry に任せる
- docs のみで「`println``log` の別名」と明記
**推奨**: Option 1Rust 側でもラッパを追加)
- 理由: Rust から直接 ConsoleBox を使う場合にも対応できる
#### 5.1.2 hako_logging_design.md への追記
**ファイル**: `docs/development/current/main/hako_logging_design.md`(修正)
**追記内容**:
```markdown
## ConsoleBox の使い方Phase 122 更新)
### 基本パターン
```nyash
local console = new ConsoleBox()
console.println("Hello") // 内部的には log と同じスロット
console.log("World") // println と同じ動作
```
### ConsoleBox vs LoggerBox vs ConsoleService
- **ConsoleBox**: ユーザーコードで直接使用(`println` / `log`
- **LoggerBox**: 構造化ログ・ログレベル管理
- **ConsoleService**: CLI/システム内部での出力Ring0 経由)
### Phase 122 での統一
- `ConsoleBox.println``ConsoleBox.log` の完全なエイリアス
- VM の TypeRegistry で slot 400 に正規化される
- すべての経路JSON v0 / selfhost / 通常VMで一貫性を保つ
```
#### 5.1.3 logging_policy.md への追記
**ファイル**: `docs/development/current/main/logging_policy.md`(修正)
**追記内容**:
```markdown
## Phase 122: ConsoleBox.println / log の統一
### 使い分けガイドライン
| 用途 | 推奨 API | 理由 |
|------|---------|------|
| **selfhost / CLI** | `ConsoleService` / `console_println!` | Ring0 経由で安定 |
| **ユーザーコード** | `ConsoleBox.println` | ユーザー向け sugar |
| **内部実装** | `ConsoleBox.log` | VM レベルでは同じ |
### 正規化ルール
- `ConsoleBox.println` は VM の TypeRegistry で `ConsoleBox.log`slot 400に正規化される
- JSON v0 / selfhost / 通常VM のすべての経路で同じ動作を保証
- Rust から直接使用する場合も `println` / `log` の両方が使用可能
```
---
## 6. Task 4: selfhost / esc_dirname_smoke 再検証
### 6.1 実装内容
**ファイル/コマンド**:
- `tools/smokes/v2/profiles/integration/selfhost/phase120_stable_paths.sh`
- `docs/development/current/main/phase120_baseline_results.md`
**実行コマンド**:
```bash
# JoinIR Strict モードで selfhost 経路を再検証
NYASH_FEATURES=stage3 \
NYASH_USE_NY_COMPILER=1 \
NYASH_NY_COMPILER_EMIT_ONLY=1 \
NYASH_SELFHOST_KEEP_RAW=1 \
NYASH_JOINIR_STRICT=1 \
./tools/smokes/v2/profiles/integration/selfhost/phase120_stable_paths.sh
```
### 6.2 期待結果
| テストケース | Phase 120 | Phase 122期待 |
|-------------|-----------|------------------|
| `peek_expr_block.hako` | ✅ 成功 | ✅ 成功 |
| `loop_min_while.hako` | ✅ 成功 | ✅ 成功 |
| `esc_dirname_smoke.hako` | ❌ `Unknown method 'println'` | ✅ **成功** |
**esc_dirname_smoke.hako の期待動作**:
- エラー `Unknown method 'println' on ConsoleBox` が消える
- 出力として esc_json / dirname の結果が正しく表示される
### 6.3 ドキュメント更新
**phase120_baseline_results.md への追記**:
```markdown
### 3. esc_dirname_smoke.hako
| 項目 | Phase 120 結果 | Phase 122 結果 |
|------|---------------|---------------|
| **実行結果** | ❌ エラー | ✅ **成功** |
| **エラーメッセージ** | Unknown method 'println' on ConsoleBox | (なし) |
| **修正内容** | - | Phase 122: TypeRegistry に println alias 追加 |
| **備考** | ConsoleBox.println 未実装 | println → log に正規化 |
```
**CURRENT_TASK.md への追記**:
```markdown
### 🎯 Phase 122: ConsoleBox.println / log 統一(完了)
- ✅ 現状分析ドキュメント作成: phase122_consolebox_println_unification.md
- ✅ TypeRegistry 修正: println を log のエイリアスslot 400として追加
- ✅ ConsoleBox 実装ドキュメント調整: console_box.rs / hako_logging_design.md / logging_policy.md
- ✅ selfhost 再検証: esc_dirname_smoke.hako が selfhost Stage-3 + JoinIR Strict で通ることを確認
- ✅ hako_check 影響確認: ConsoleBox.println の alias 化が hako_check に影響しないことを確認
**Phase 120 の問題解決**:
- ✅ esc_dirname_smoke.hako の `Unknown method 'println'` エラー解消
**次のステップ**: Phase 123ConsoleService / LoggerBox 統合検討)
```
---
## 7. Task 5: hako_check / JoinIR に影響がないことを確認
### 7.1 実装内容
**ファイル**: `docs/development/current/main/phase121_hako_check_joinir_design.md`(確認・追記)
**確認事項**:
1. **hako_check が ConsoleBox を使用しているか確認**:
```bash
rg "ConsoleBox" tools/hako_check/ --type hako
rg "println\|log" tools/hako_check/ --type hako
```
2. **確認結果に応じて対応**:
**ケース A: hako_check が ConsoleBox を使用している**
- `phase121_hako_check_joinir_design.md` に追記:
```markdown
## Phase 122 での影響
- ConsoleBox.println は log に正規化されるTypeRegistry レベル)
- hako_check のログ出力設計: ConsoleBox.println / log の両方が使用可能
- 動作に影響なしVM の alias 機能で自動対応)
```
**ケース B: hako_check が ConsoleBox を使用していない**
- `phase121_hako_check_joinir_design.md` に追記:
```markdown
## Phase 122 での影響
- hako_check は ConsoleBox を直接使用していない
- ConsoleBox.println の alias 化は hako_check に影響なし
```
### 7.2 追加確認
**MirBuilder / JoinIR Lowering への影響確認**:
```bash
# MirBuilder が ConsoleBox.println を特別扱いしていないか確認
rg "println" src/mir/builder/ --type rust
# JoinIR Lowering への影響確認
rg "println" src/mir/join_ir/ --type rust
```
**期待結果**: どちらも特別扱いしていないTypeRegistry に任せる設計)
---
## 8. 完成チェックリストPhase 122
- [ ] phase122_consolebox_println_unification.md に現状と設計がまとまっている
- [ ] type_registry.rs の CONSOLE_METHODS に println alias が追加されている
- [ ] console_box.rs に println メソッドのラッパが追加されているOption 1 採用時)
- [ ] console_box.rs / hako_logging_design.md / logging_policy.md に ConsoleBox.println / log の関係が明記されている
- [ ] apps/tests/esc_dirname_smoke.hako が selfhost Stage-3 + JoinIR Strict 経路で通る(旧エラーメッセージが消える)
- [ ] phase120_baseline_results.md が更新され、esc_dirname_smoke.hako の結果が ❌ → ✅ に変わっている
- [ ] CURRENT_TASK.md が更新され、「ConsoleBox.println 問題 resolved」となっている
- [ ] hako_check への影響が確認され、phase121_hako_check_joinir_design.md に記録されている
- [ ] ビルド・テスト全 PASScargo build --release && cargo test --release
---
## 9. 設計原則Phase 122 で確立)
### Alias First
```
【Phase 122 の哲学】
複数の名前を持つ API は、VM レベルで alias に統一する
Flow:
ユーザーコード: ConsoleBox.println("...")
VM TypeRegistry: println → slot 400log と同じ)
ConsoleBox 実装: log の実装が実行される
出力: 標準出力にメッセージ表示
```
### 正規化ポイントの一元化
**重要な約束**:
- **alias は TypeRegistry で管理**: VM レベルで一元管理
- **MirBuilder は関与しない**: 特別扱いなし
- **すべての経路で一貫**: JSON v0 / selfhost / 通常VM
### Phase 120 との連携
**Phase 120 の成果を活用**:
- Phase 120: selfhost 経路のベースライン確立 → 問題発見
- Phase 122: 問題の根本解決TypeRegistry レベル) → ベースライン改善
- Phase 123+: 追加機能の統合検討
---
**Phase 122 指示書完成日**: 2025-12-04Phase 120-121 完了直後)