sim-macros 0.2.1

Proc-macro surface for authored SIM libraries.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107

# sim-macros

`sim-macros` turns an inline Rust module into a SIM library declaration. It
reads marker attributes such as `#[sim_class]`, `#[sim_constructor]`,
`#[sim_fn]`, `#[sim_macro]`, `#[sim_codec]`, `#[sim_number_domain]`, and
`#[sim_site]`, validates their contracts, and generates the `Lib` manifest and
registration code that the runtime expects.

Most consumers pull this surface in through the SIM facade:

```toml
[dependencies]
sim = { package = "sim-nest", version = "0.1", default-features = false, features = ["core", "shape", "proc-macros"] }
```

## Example

```rust
use sim::{case, shape, sim_class, sim_constructor, sim_fn, sim_lib};

#[sim_lib(id = "geometry", version = "0.1.0")]
mod geometry {
    use super::{case, shape, sim_class, sim_constructor, sim_fn};

    #[sim_class(name = "Point")]
    #[shape("(fields (:x Number) (:y Number))")]
    pub struct Point {
        x: f64,
        y: f64,
    }

    #[sim_constructor(class = "Point")]
    #[case(args = "((capture x Number) (capture y Number))", result = "Point")]
    pub fn point(x: f64, y: f64) -> Point {
        Point { x, y }
    }

    #[sim_fn(name = "distance")]
    #[case(args = "((capture left Point) (capture right Point))", result = "Number")]
    pub fn distance(left: &Point, right: &Point) -> f64 {
        let dx = left.x - right.x;
        let dy = left.y - right.y;
        (dx * dx + dy * dy).sqrt()
    }
}
```

## What `#[sim_lib]` reads

- `#[sim_class]` for generated class exports.
- `#[sim_constructor]` plus one or more `#[case(...)]` declarations.
- `#[sim_fn]` plus one or more `#[case(...)]` declarations.
- `#[sim_macro]`, `#[sim_codec]`, `#[sim_number_domain]`, and `#[sim_site]`
  marker declarations.
- Optional `#[shape("...")]` literals on classes and functions.
- The `id`, `version`, and optional `native_export` entries on `#[sim_lib(...)]`.

`#[sim_lib]` requires an inline module. The marker attributes are inert on their
own; they are consumed when the enclosing module is expanded.

## What it generates

- A `<ModuleName>Lib` type that implements `::sim::kernel::Lib`.
- Manifest exports for classes, functions, macros, codecs, number domains, and
  sites declared in the module.
- Generated class wrappers, constructor wiring, and function adapters.
- Load-time registration for generated classes, functions, and macros.
- A `__SIM_LIB_EXPANSION` string snapshot for inspection in tests.
- Optional native ABI glue when `native_export = true`.

## What fails at compile time

- Missing or duplicate `id`, `version`, or marker entries.
- Malformed shape literals.
- A `#[sim_class]` without a matching `#[sim_constructor]`.
- Unsupported borrowed builtin arguments.
- `native_export = true` signatures that require generated class values where
  the ABI only supports scalar, `String`, `Symbol`, or `Expr` traffic.
- Non-inline `#[sim_lib]` modules.

These failures are deliberate: the crate rejects invalid library declarations at
build time instead of widening the runtime contract.

## Examples In Tree

- `crates/sim-macros/tests/ui/pass/basic-lib`
- `crates/sim-macros/tests/ui/pass/marker-surface`
- `crates/sim-macros/tests/ui/smoke/consumer`

## Docs And Validation

The crate has no recipe directory because compile-fail and compile-pass fixtures
are the meaningful examples for a proc-macro surface. Rustdoc and UI tests cover
the public contract.

- API docs: <https://docs.rs/sim-macros>
- Repository guide: <https://github.com/sim-nest/sim-foundation>

From the `sim-foundation` checkout:

```bash
cargo test -p sim-macros
RUSTDOCFLAGS="-D warnings" cargo doc -p sim-macros --no-deps
cargo run -p xtask -- check-recipes
cargo run -p xtask -- check-package-floors
cargo run -p xtask -- simdoc --check
```