Files

Moe Charm cc2a820af7 feat(plugin): Fix plugin BoxRef return and Box argument support

- Fixed deadlock in FileBox plugin copyFrom implementation (single lock)
- Added TLV Handle (tag=8) parsing in calls.rs for returned BoxRefs
- Improved plugin loader with config path consistency and detailed logging
- Fixed loader routing for proper Handle type_id/fini_method_id resolution
- Added detailed logging for TLV encoding/decoding in plugin_loader_v2

Test docs/examples/plugin_boxref_return.nyash now works correctly:
- cloneSelf() returns FileBox Handle properly
- copyFrom(Box) accepts plugin Box arguments
- Both FileBox instances close and fini correctly

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

2025-08-21 00:41:26 +09:00

3.4 KiB

Raw Blame History

Plugin Documentation Migration Guide

🎯 概要

このガイドは、Nyashプラグインシステムの古いドキュメントから実際の実装に移行するためのものです。

📚 Documentation Status

✅ Current Working Specification

BID-FFI v1 実装仕様書 - RECOMMENDED
- 実際に動作している実装をベースとした正確な仕様
- FileBoxプラグインで実証済み
- plugin_loader_v2.rsの実装に基づく

⚠️ Deprecated Documentation

ffi-abi-specification.md - ❌ DEPRECATED
- 理想的な設計案だが未実装
- MIR ExternCall設計が含まれているが、実際には使われていない
plugin-system.md - ❌ DEPRECATED
- YAML DSLを使った将来構想
- 現在の実装とは大きく異なる
nyash-toml-v2-spec.md - ⚠️ PARTIALLY OUTDATED
- 基本構造は正しいが、実際の形式と部分的に異なる

✅ Still Accurate Documentation

plugin-tester.md - ✅ CURRENT
- プラグイン診断ツールの使用方法
- 実際のツールと一致
filebox-bid-mapping.md - ✅ USEFUL REFERENCE
- FileBox APIとプラグイン実装の対応表
- 開発時の参考資料として有効

🔄 Migration Steps

For Plugin Developers

Start with: BID-FFI v1 実装仕様書
Refer to: 実際のnyash.toml for configuration format
Use: plugin-tester for testing
Study: FileBox plugin as reference implementation

For Nyash Core Developers

Phase 1: ✅ COMPLETED - Documentation cleanup with deprecation notices
Phase 2: ✅ COMPLETED - Accurate specification creation
Phase 3: 🚧 TODO - MIR ExternCall implementation to connect with plugin system

🎯 Key Differences

Old Documentation vs Reality

Aspect	Old Docs	Reality
Configuration	YAML DSL	TOML format
API Design	Complex handle system	Simple TLV + method_id
MIR Integration	Fully designed	Stub only
ABI Version	Multiple versions	BID-FFI v1 only

Working Configuration Format

Old (in deprecated docs):

# filebox.plugin.yaml
schema: 1
apis:
  - sig: "FileBox::open(path: string) -> FileBox"

Current (actual):

[libraries."libnyash_filebox_plugin.so"]
boxes = ["FileBox"]
path = "./plugins/nyash-filebox-plugin/target/release/libnyash_filebox_plugin.so"

[libraries."libnyash_filebox_plugin.so".FileBox.methods]
birth = { method_id = 0 }
open = { method_id = 1 }

📞 FFI Interface

Old (complex):

Multiple entry points
Complex handle management
Dynamic type discovery

Current (simple):

Single entry point: nyash_plugin_invoke
Fixed TLV protocol
Static configuration in nyash.toml

🚀 Next Steps

✅ Documentation Cleanup: Completed
🚧 MIR Integration: Implement ExternCall → plugin system connection
🔮 Future: Consider implementing some ideas from deprecated docs

Last Updated: 2025-08-20
Status: Documentation reorganization Phase 2 completed

3.4 KiB Raw Blame History