AI_Assistant/cad-editor
Watch
1
0
Fork
You've already forked cad-editor
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

feat(plugin): load external cdylib plugins at runtime (phase 2)

Browse source 
Move BuiltinPlugin into ocs_plugin_api (host feature) so out-of-tree
crates can implement it, and add export_plugin! to emit the two C
symbols a cdylib exposes: ocs_plugin_api_version (checked first, so an
ABI-incompatible build never runs) and ocs_plugin_register -> boxed
BuiltinPlugin. The host loads every compatible package from the plugins
folder at startup via libloading (desktop only), keeps the library
resident for the session, and merges its ribbon tab + command dispatch
into the same paths as built-ins (honouring enable/disable). The Plugin
Manager shows external packages with a Loaded / incompatible status.

Approach B: the plugin hands back a boxed trait object, assuming a
matching toolchain + ocs_plugin_api version (the version symbol enforces
the latter). crates/ocs_example_plugin is the reference cdylib.

Part of the #100 extensibility epic (phase 2).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
Hakan Seven 2026-06-17 14:48:56 +03:00
commit 29c71be101
14 changed files with 402 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/plugin-architecture.md
View file

@ -270,16 +270,29 @@ This mirrors QGIS: the application ships core menus; plugins add tabs/tools with
### Phase 2 — Dynamic loading (desktop)
```
%APPDATA%/OpenCADStudio/plugins/
opencad.storm_sewer/
<config>/OpenCADStudio/plugins/
opencad.example/
plugin.toml
opencad_storm_sewer.dll # cdylib
libocs_example_plugin.so # cdylib (.dll / .dylib per platform)
```
- `libloading` + `#[no_mangle] extern "C" fn ocs_plugin_register() -> *const PluginVTable`
- `api_version` compatibility gate at load time
- [x] Enable/disable in settings (like QGIS plugin manager) — landed early in phase 1
- Enable/disable in settings (like QGIS plugin manager)
- [x] Discover packages — scan the plugins folder, read `plugin.toml`, check for
a native library, gate on `api_version`. Surfaced in the Plugin Manager with
a status pill (`src/plugin/external.rs`).
- [x] Load via `libloading` — each cdylib exports two C symbols (via the
`ocs_plugin_api::export_plugin!` macro): `ocs_plugin_api_version` (checked
first, so an incompatible build never runs) and `ocs_plugin_register` →
`*mut Box<dyn BuiltinPlugin>`. Loaded once at startup; the library stays
resident for the session (ribbon tabs / dispatch hold its vtables). External
plugins merge into the same ribbon + `try_dispatch` path as built-ins and
honour the enable/disable set.
- [x] `api_version` compatibility gate at load time.
- [x] Enable/disable in settings (like QGIS plugin manager) — landed in phase 1.
**ABI approach:** the plugin hands back a boxed `BuiltinPlugin` (not a `repr(C)`
vtable). This assumes the package was built against the same toolchain and
`ocs_plugin_api` version; the version symbol enforces the latter. Reference
implementation: [`crates/ocs_example_plugin`](../crates/ocs_example_plugin).
### Phase 3 — Interchange & QA