statum_macros/lib.rs
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 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503
use proc_macro::TokenStream;
use quote::format_ident;
use quote::quote;
use quote::ToTokens;
use syn::{
parse::Parser, parse_macro_input, punctuated::Punctuated, Data, DeriveInput, Fields, Path,
Token,
};
use std::collections::HashMap;
use std::sync::Mutex;
use std::sync::OnceLock;
static STATE_VARIANTS: OnceLock<Mutex<HashMap<String, Vec<String>>>> = OnceLock::new();
// Helper to get or init the storage
fn get_variants_map() -> &'static Mutex<HashMap<String, Vec<String>>> {
STATE_VARIANTS.get_or_init(|| Mutex::new(HashMap::new()))
}
// Helper to register variants from #[state]
pub(crate) fn register_state_variants(enum_name: String, variants: Vec<String>) {
let map = get_variants_map();
map.lock().unwrap().insert(enum_name, variants);
}
// Helper to get variants for #[model]
pub(crate) fn get_state_variants(enum_name: &str) -> Option<Vec<String>> {
let map = get_variants_map();
map.lock().unwrap().get(enum_name).cloned()
}
struct ModelAttr {
machine: syn::Path,
state: syn::Path,
}
impl syn::parse::Parse for ModelAttr {
fn parse(input: syn::parse::ParseStream) -> syn::Result<Self> {
let mut machine = None;
let mut state = None;
// Parse first pair
let name1: syn::Ident = input.parse()?;
input.parse::<Token![=]>()?;
let value1: syn::Path = input.parse()?;
// Store in correct field
match name1.to_string().as_str() {
"machine" => machine = Some(value1),
"state" => state = Some(value1),
_ => {
return Err(syn::Error::new(
name1.span(),
"Expected 'machine' or 'state'",
))
}
}
// Parse comma
input.parse::<Token![,]>()?;
// Parse second pair
let name2: syn::Ident = input.parse()?;
input.parse::<Token![=]>()?;
let value2: syn::Path = input.parse()?;
// Store in correct field
match name2.to_string().as_str() {
"machine" => {
if machine.is_some() {
return Err(syn::Error::new(
name2.span(),
"Duplicate 'machine' parameter",
));
}
machine = Some(value2);
}
"state" => {
if state.is_some() {
return Err(syn::Error::new(name2.span(), "Duplicate 'state' parameter"));
}
state = Some(value2);
}
_ => {
return Err(syn::Error::new(
name2.span(),
"Expected 'machine' or 'state'",
))
}
}
// Ensure we got both parameters
match (machine, state) {
(Some(machine), Some(state)) => Ok(ModelAttr { machine, state }),
_ => Err(syn::Error::new(
name1.span(),
"Must specify both 'machine' and 'state'",
)),
}
}
}
fn get_field_info(input: &DeriveInput) -> (Vec<&syn::Ident>, Vec<&syn::Type>) {
match &input.data {
syn::Data::Struct(s) => match &s.fields {
syn::Fields::Named(fields) => {
let param_names = fields
.named
.iter()
.filter(|f| {
f.ident
.as_ref()
.is_some_and(|i| i != "marker" && i != "state_data")
})
.map(|f| f.ident.as_ref().unwrap())
.collect::<Vec<_>>();
let param_types = fields
.named
.iter()
.filter(|f| {
f.ident
.as_ref()
.is_some_and(|i| i != "marker" && i != "state_data")
})
.map(|f| &f.ty)
.collect::<Vec<_>>();
(param_names, param_types)
}
_ => panic!("Only named fields are supported"),
},
_ => panic!("Only structs are supported"),
}
}
#[proc_macro_attribute]
pub fn state(_attr: TokenStream, item: TokenStream) -> TokenStream {
let input = parse_macro_input!(item as DeriveInput);
let vis = &input.vis;
let name = &input.ident;
// Extract variants
let variants = match &input.data {
Data::Enum(data_enum) => data_enum
.variants
.iter()
.map(|v| v.ident.to_string())
.collect(),
_ => panic!("#[state] can only be used on enums"),
};
// Register variants for later use
register_state_variants(name.to_string(), variants);
// Analyze user-supplied #[derive(...)] to detect which traits they want
#[allow(unused_variables)]
let (
user_derives,
wants_serialize,
wants_deserialize,
wants_debug,
wants_clone,
wants_default,
wants_eq,
wants_partial_eq,
wants_hash,
wants_partial_ord,
wants_ord,
wants_copy,
) = analyze_user_derives(&input.attrs);
// We'll accumulate any trait bounds we need in "trait_bounds".
let mut trait_bounds = vec![];
// If the user derived Debug, we add std::fmt::Debug as a bound.
if wants_debug {
trait_bounds.push(quote!(std::fmt::Debug));
}
// Only add serde bounds if our crate's "serde" feature is enabled.
#[cfg(feature = "serde")]
{
if wants_serialize {
trait_bounds.push(quote!(serde::Serialize));
}
if wants_deserialize {
trait_bounds.push(quote!(serde::de::DeserializeOwned));
}
}
let trait_bounds = if trait_bounds.is_empty() {
quote!()
} else {
quote!(: #(#trait_bounds +)*)
};
// We'll replicate all user-specified derives on each generated variant struct.
let replicate_derives = if user_derives.is_empty() {
quote!()
} else {
quote! {
#[derive(#(#user_derives),*)]
}
};
// Convert each enum variant into a separate struct with an impl that ties back to the "State" trait.
let states = match &input.data {
Data::Enum(data_enum) => data_enum.variants.iter().map(|variant| {
let variant_ident = &variant.ident;
let variant_fields = &variant.fields;
match variant_fields {
// Single-field tuple variant
Fields::Unnamed(fields) if fields.unnamed.len() == 1 => {
let field_type = &fields.unnamed.first().unwrap().ty;
quote! {
#replicate_derives
#vis struct #variant_ident(#field_type);
impl #name for #variant_ident {
type Data = #field_type;
const HAS_DATA: bool = true;
fn get_data(&self) -> Option<&Self::Data> {
Some(&self.0)
}
fn get_data_mut(&mut self) -> Option<&mut Self::Data> {
Some(&mut self.0)
}
}
}
}
// Unit variant
Fields::Unit => {
quote! {
#replicate_derives
#vis struct #variant_ident;
impl #name for #variant_ident {
type Data = ();
const HAS_DATA: bool = false;
fn get_data(&self) -> Option<&Self::Data> {
None
}
fn get_data_mut(&mut self) -> Option<&mut Self::Data> {
None
}
}
}
}
_ => panic!("Variants must be unit or single-field tuple variants"),
}
}),
_ => {
return syn::Error::new_spanned(&input.ident, "#[state] can only be used on an enum")
.to_compile_error()
.into();
}
};
let expanded = quote! {
// The trait for this "state" enum
#vis trait #name {
type Data #trait_bounds;
const HAS_DATA: bool;
fn get_data(&self) -> Option<&Self::Data>;
fn get_data_mut(&mut self) -> Option<&mut Self::Data>;
}
// One struct + impl per variant
#(#states)*
};
TokenStream::from(expanded)
}
#[proc_macro_attribute]
pub fn machine(_attr: TokenStream, item: TokenStream) -> TokenStream {
let mut input = parse_macro_input!(item as DeriveInput);
let struct_name = &input.ident;
let state_trait = extract_state_trait(&input);
// Insert "marker" and "state_data" fields into the user's struct.
if let syn::Data::Struct(ref mut struct_data) = input.data {
if let syn::Fields::Named(ref mut fields) = struct_data.fields {
fields.named.push(
syn::Field::parse_named
.parse2(quote! { marker: core::marker::PhantomData<S> })
.unwrap(),
);
fields.named.push(
syn::Field::parse_named
.parse2(quote! { state_data: Option<S::Data> })
.unwrap(),
);
}
}
let (field_names, field_types) = get_field_info(&input);
let transition_impl = quote! {
impl<CurrentState: #state_trait> #struct_name<CurrentState> {
pub fn transition<NewState: #state_trait>(self) -> #struct_name<NewState>
where
NewState: #state_trait<Data = ()>
{
#struct_name {
#(#field_names: self.#field_names,)*
marker: core::marker::PhantomData,
state_data: None,
}
}
pub fn transition_with<NewState: #state_trait>(self, data: NewState::Data) -> #struct_name<NewState> {
#struct_name {
#(#field_names: self.#field_names,)*
marker: core::marker::PhantomData,
state_data: Some(data),
}
}
pub fn get_state_data(&self) -> Option<&CurrentState::Data> {
self.state_data.as_ref()
}
pub fn get_state_data_mut(&mut self) -> Option<&mut CurrentState::Data> {
self.state_data.as_mut()
}
}
};
let constructor = quote! {
impl<S: #state_trait> #struct_name<S> {
pub fn new(#(#field_names: #field_types),*) -> Self {
Self {
#(#field_names,)*
marker: core::marker::PhantomData,
state_data: None,
}
}
}
};
let expanded = quote! {
#input
#transition_impl
#constructor
};
TokenStream::from(expanded)
}
fn extract_state_trait(input: &DeriveInput) -> syn::Ident {
let generics = &input.generics;
let type_param = generics
.type_params()
.next()
.expect("Struct must have a type parameter");
let bounds = &type_param.bounds;
for bound in bounds {
if let syn::TypeParamBound::Trait(trait_bound) = bound {
if let Some(segment) = trait_bound.path.segments.last() {
return segment.ident.clone();
}
}
}
panic!("Type parameter must have a trait bound");
}
fn analyze_user_derives(
attrs: &[syn::Attribute],
) -> (
Vec<Path>,
bool,
bool,
bool,
bool,
bool,
bool,
bool,
bool,
bool,
bool,
bool,
) {
let mut user_derives = Vec::new();
let mut wants_serialize = false;
let mut wants_deserialize = false;
let mut wants_debug = false;
let mut wants_clone = false;
let mut wants_default = false;
let mut wants_eq = false;
let mut wants_partial_eq = false;
let mut wants_hash = false;
let mut wants_partial_ord = false;
let mut wants_ord = false;
let mut wants_copy = false;
// Parse `#[derive(...)]` with syn 2.0
for attr in attrs {
if attr.path().is_ident("derive") {
if let Ok(paths) = attr.parse_args_with(Punctuated::<Path, Token![,]>::parse_terminated)
{
for path in paths {
if let Some(ident) = path.get_ident() {
match ident.to_string().as_str() {
"Serialize" => wants_serialize = true,
"Deserialize" => wants_deserialize = true,
"Debug" => wants_debug = true,
"Clone" => wants_clone = true,
"Default" => wants_default = true,
"Eq" => wants_eq = true,
"PartialEq" => wants_partial_eq = true,
"Hash" => wants_hash = true,
"PartialOrd" => wants_partial_ord = true,
"Ord" => wants_ord = true,
"Copy" => wants_copy = true,
_ => {}
}
}
user_derives.push(path);
}
}
}
}
(
user_derives,
wants_serialize,
wants_deserialize,
wants_debug,
wants_clone,
wants_default,
wants_eq,
wants_partial_eq,
wants_hash,
wants_partial_ord,
wants_ord,
wants_copy,
)
}
//#[proc_macro_attribute]
//pub fn model(attr: TokenStream, item: TokenStream) -> TokenStream {
// let ModelAttr { machine, state } = parse_macro_input!(attr as ModelAttr);
// let input = parse_macro_input!(item as DeriveInput);
// let struct_name = &input.ident;
//
// // Use reference to machine when converting to token stream
// let machine_input = syn::parse_str::<DeriveInput>(
// &machine.to_token_stream().to_string()
// ).expect("Could not parse machine type");
//
// let (field_names, field_types) = get_field_info(&machine_input);
//
// let state_name = state.get_ident()
// .expect("Expected simple state name")
// .to_string();
//
// let variants = get_state_variants(&state_name)
// .expect("State type not found - did you mark it with #[state]?");
//
// // Generate try_to_* methods using the actual fields
// let try_methods = variants.iter().map(|variant| {
// let variant_ident = format_ident!("{}", variant);
// let try_method_name = format_ident!("try_to_{}", to_snake_case(variant));
// let is_method_name = format_ident!("is_{}", to_snake_case(variant));
//
// quote! {
// pub fn #try_method_name(&self, #(#field_names: #field_types),*) -> Result<#machine<#variant_ident>, StatumError> {
// if self.#is_method_name() {
// Ok(#machine::<#variant_ident>::new(#(#field_names),*))
// } else {
// Err(StatumError::InvalidState)
// }
// }
// }
// });
//
// let expanded = quote! {
// #input
//
// impl #struct_name {
// #(#try_methods)*
// }
// };
//
// TokenStream::from(expanded)
//}
// Helper function to convert PascalCase to snake_case
fn to_snake_case(s: &str) -> String {
let mut result = String::new();
for (i, c) in s.chars().enumerate() {
if i > 0 && c.is_uppercase() {
result.push('_');
}
result.push(c.to_lowercase().next().unwrap());
}
result
}