forked from 1b-agent/opencadstudio-upstream
Move the dependency-free, semver-versioned half of the plugin contract into a standalone workspace crate `crates/ocs_plugin_api`: - manifest types: PluginManifest, ApiVersion, API_VERSION - ribbon vocabulary: CadModule trait + ToolDef/RibbonGroup/RibbonItem/IconKind/ ModuleEvent/StyleKey The host re-exports them from `crate::plugin::manifest` and `crate::modules`, so every existing call site is unchanged. The acadrust-typed runtime surface (HostSession) stays in the host binary; lifting it behind a HostApi trait in the same crate is the remaining phase-1b step. Part of #100. Docs updated in docs/plugin-architecture.md. Co-Authored-By: Claude Opus 4.8 <[email protected]>
26 lines
1.0 KiB
Rust
26 lines
1.0 KiB
Rust
//! # Open CAD Studio plugin API
|
|
//!
|
|
//! The stable, semver-versioned contract an add-on package targets instead of
|
|
//! the `OpenCADStudio` binary internals. It is intentionally **dependency
|
|
//! free** (no `iced`, no `acadrust`) so engine crates and external tooling can
|
|
//! depend on it cheaply.
|
|
//!
|
|
//! Two pieces live here:
|
|
//!
|
|
//! - [`manifest`] — plugin identity ([`PluginManifest`]) and the host ABI
|
|
//! version handshake ([`ApiVersion`]).
|
|
//! - [`ribbon`] — the [`CadModule`] trait and the plain-data ribbon types
|
|
//! ([`RibbonGroup`], [`ToolDef`], …) a plugin uses to describe its tab.
|
|
//!
|
|
//! The runtime host surface a plugin uses at *dispatch* time (document access,
|
|
//! command line, undo) is `acadrust`-typed and therefore lives in the host
|
|
//! binary for now; see `docs/plugin-architecture.md` (phase 1b).
|
|
|
|
pub mod manifest;
|
|
pub mod ribbon;
|
|
|
|
pub use manifest::{ApiVersion, PluginManifest, API_VERSION};
|
|
pub use ribbon::{
|
|
CadModule, IconKind, ModuleEvent, RibbonGroup, RibbonItem, StyleKey, ToolDef,
|
|
};
|