ranim_macros/

lib.rs

mod scene;
mod utils;

use proc_macro::TokenStream;
use proc_macro_crate::{FoundCrate, crate_name};
use proc_macro2::Span;
use quote::quote;
use syn::{Data, DeriveInput, Fields, Ident, ItemFn, parse_macro_input};

use crate::scene::parse_scene_attrs;

const RANIM_CRATE_NAME: &str = "ranim";

fn ranim_path() -> proc_macro2::TokenStream {
    match crate_name(RANIM_CRATE_NAME) {
        Ok(FoundCrate::Name(name)) => {
            let ident = Ident::new(&name, Span::call_site());
            quote!(::#ident)
        }
        // The canonical self import in ranim also works in doctests, whose
        // CARGO_CRATE_NAME still names the library rather than the test crate.
        _ => quote!(::ranim),
    }
}

fn ranim_core_path() -> proc_macro2::TokenStream {
    if let Ok(res) = crate_name("ranim-core") {
        match (res, std::env::var("CARGO_CRATE_NAME").as_deref()) {
            (FoundCrate::Itself, Ok("ranim-core") | Ok("ranim_core")) => return quote!(crate),
            (FoundCrate::Name(name), _) => {
                let ident = Ident::new(&name, Span::call_site());
                return quote!(::#ident);
            }
            _ => (),
        }
    } else if let Ok(res) = crate_name("ranim") {
        match (res, std::env::var("CARGO_CRATE_NAME").as_deref()) {
            (FoundCrate::Itself, Ok("ranim")) => return quote!(crate::core),
            (FoundCrate::Name(name), _) => {
                let ident = Ident::new(&name, Span::call_site());
                return quote!(::#ident::core);
            }
            _ => (),
        }
    }
    ranim_path()
}

/// 解析单个属性（#[scene(...)] /  / #[output(...)]）
#[derive(Default)]
struct SceneAttrs {
    name: Option<String>,        // #[scene(name = "...")]
    clear_color: Option<String>, // #[scene(clear_color = "#000000")]
    wasm_demo_doc: bool,         // #[wasm_demo_doc]
    outputs: Vec<OutputDef>,     // #[output(...)]
}

/// 一个 #[output(...)] 里的字段
#[derive(Default)]
struct OutputDef {
    width: u32,
    height: u32,
    fps: u32,
    save_frames: bool,
    name: Option<String>,
    name_template: Option<String>,
    dir: String,
    format: Option<String>,
}

// MARK: scene
#[proc_macro_attribute]
pub fn scene(args: TokenStream, input: TokenStream) -> TokenStream {
    let ranim = ranim_path();
    let input_fn = parse_macro_input!(input as ItemFn);
    let attrs = parse_scene_attrs(args, input_fn.attrs.as_slice()).unwrap();

    let fn_name = &input_fn.sig.ident;
    // `#[wasm_demo_doc]` scenes are embedded into rustdoc pages, so make sure
    // they are public enough for rustdoc to render them.
    let vis = if attrs.wasm_demo_doc {
        quote!(pub)
    } else {
        let vis = &input_fn.vis;
        quote!(#vis)
    };
    let signature = &input_fn.sig;
    let fn_body = &input_fn.block;
    let doc_attrs: Vec<_> = input_fn
        .attrs
        .iter()
        .filter(|attr| attr.path().is_ident("doc"))
        .collect();

    // 场景名称
    let scene_name = attrs.name.unwrap_or_else(|| fn_name.to_string());

    // Scene configuration
    let clear_color = attrs.clear_color.unwrap_or("#333333ff".to_string());
    let scene_config = quote! {
        #ranim::SceneConfig {
            clear_color: #clear_color.to_string(),
        }
    };

    // Owned output descriptors
    let mut outputs = Vec::new();
    for OutputDef {
        width,
        height,
        fps,
        save_frames,
        name,
        name_template,
        dir,
        format,
    } in attrs.outputs
    {
        let name_token = match name.as_deref() {
            Some(n) if !n.is_empty() => quote! { Some(#n.to_string()) },
            _ => quote! { None },
        };
        let name_template_token = match name_template.as_deref() {
            Some(n) if !n.is_empty() => quote! { Some(#n.to_string()) },
            _ => quote! { None },
        };
        let format_token = match format.as_deref() {
            Some("mp4") | None => quote! { #ranim::OutputFormat::Mp4 },
            Some("webm") => quote! { #ranim::OutputFormat::Webm },
            Some("mov") => quote! { #ranim::OutputFormat::Mov },
            Some("gif") => quote! { #ranim::OutputFormat::Gif },
            Some(other) => panic!("unknown output format: {other:?}"),
        };
        outputs.push(quote! {
            #ranim::Output {
                width: #width,
                height: #height,
                fps: #fps,
                save_frames: #save_frames,
                name: #name_token,
                name_template: #name_template_token,
                dir: #dir.to_string(),
                format: #format_token,
            }
        });
    }
    if outputs.is_empty() {
        outputs.push(quote! {
            #ranim::Output::default()
        });
    }

    let doc = if attrs.wasm_demo_doc {
        quote! {
            #[doc = concat!("<div class=\"ranim-preview\" style=\"display:grid;gap:8px\"><ranim-viewport data-module-path=\"", module_path!(), "\" scene=\"", #scene_name, "\"></ranim-viewport><ranim-controls></ranim-controls></div>\n\n")]
        }
    } else {
        quote! {}
    };

    let scene = quote! {
        let mut scene = #ranim::Scene::new(#scene_name, super::#fn_name);
        scene.config = #scene_config;
        scene.outputs = vec![#(#outputs),*];
        scene
    };

    // ANCHOR: SCENE_MACRO
    let expanded = quote! {
        #doc
        #(#doc_attrs)*
        #vis #signature #fn_body

        #[doc(hidden)]
        #vis mod #fn_name {
            /// Construct this scene's descriptor for explicit registration in an App.
            pub fn scene() -> #ranim::Scene {
                #scene
            }
        }
    };
    // ANCHOR_END: SCENE_MACRO

    TokenStream::from(expanded)
}

/// Define a video output.
///
/// Default: 1920x1080 60fps, save_frames = false
///
/// Available attributes:
/// - `width`: output width in pixels
/// - `height`: output height in pixels
/// - `fps`: frames per second
/// - `save_frames`: save frames to disk
/// - `dir`: directory for output
/// - `name_template`: basename template for the output file
#[proc_macro_attribute]
pub fn output(_: TokenStream, _: TokenStream) -> TokenStream {
    TokenStream::new()
}

// #[proc_macro_attribute]
// pub fn preview(_: TokenStream, _: TokenStream) -> TokenStream {
//     TokenStream::new()
// }

#[proc_macro_attribute]
pub fn wasm_demo_doc(_attr: TokenStream, _: TokenStream) -> TokenStream {
    TokenStream::new()
}

// MARK: derive Traits

#[proc_macro_derive(Fill)]
pub fn derive_fill(input: TokenStream) -> TokenStream {
    let core = ranim_core_path();
    impl_derive(input, quote! {#core::traits::Fill}, |field_positions| {
        quote! {
            fn set_fill_opacity(&mut self, opacity: f32) -> &mut Self {
                #(
                    self.#field_positions.set_fill_opacity(opacity);
                )*
                self
            }
            fn fill_color(&self) -> #core::color::AlphaColor<#core::color::Srgb> {
                [#(self.#field_positions.fill_color(), )*].first().cloned().unwrap()
            }
            fn set_fill_color(&mut self, color: #core::color::AlphaColor<#core::color::Srgb>) -> &mut Self {
                #(
                    self.#field_positions.set_fill_color(color);
                )*
                self
            }
        }
    })
}

#[proc_macro_derive(Stroke)]
pub fn derive_stroke(input: TokenStream) -> TokenStream {
    let core = ranim_core_path();
    impl_derive(input, quote! {#core::traits::Stroke}, |field_positions| {
        quote! {
            fn stroke_color(&self) -> #core::color::AlphaColor<#core::color::Srgb> {
                [#(self.#field_positions.stroke_color(), )*].first().cloned().unwrap()
            }
            fn apply_stroke_func(&mut self, f: impl for<'a> Fn(&'a mut [#core::components::width::Width])) -> &mut Self {
                #(
                    self.#field_positions.apply_stroke_func(&f);
                )*
                self
            }
            fn set_stroke_color(&mut self, color: #core::color::AlphaColor<#core::color::Srgb>) -> &mut Self {
                #(
                    self.#field_positions.set_stroke_color(color);
                )*
                self
            }
            fn set_stroke_opacity(&mut self, opacity: f32) -> &mut Self {
                #(
                    self.#field_positions.set_stroke_opacity(opacity);
                )*
                self
            }
        }
    })
}

#[proc_macro_derive(Partial)]
pub fn derive_partial(input: TokenStream) -> TokenStream {
    let core = ranim_core_path();
    impl_derive(input, quote! {#core::traits::Partial}, |field_positions| {
        quote! {
            fn get_partial(&self, range: std::ops::Range<f64>) -> Self {
                Self {
                    #(
                        #field_positions: self.#field_positions.get_partial(range.clone()),
                    )*
                }
            }
            fn get_partial_closed(&self, range: std::ops::Range<f64>) -> Self {
                Self {
                    #(
                        #field_positions: self.#field_positions.get_partial(range.clone()),
                    )*
                }
            }
        }
    })
}

#[proc_macro_derive(Empty)]
pub fn derive_empty(input: TokenStream) -> TokenStream {
    let core = ranim_core_path();
    let input = parse_macro_input!(input as DeriveInput);
    let name = &input.ident;
    let generics = &input.generics;
    let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();

    let fields = match &input.data {
        Data::Struct(data) => &data.fields,
        _ => panic!("Empty can only be derived for structs"),
    };

    let field_impls = match fields {
        Fields::Named(fields) => {
            let (field_names, field_types): (Vec<_>, Vec<_>) =
                fields.named.iter().map(|f| (&f.ident, &f.ty)).unzip();

            quote! {
                Self {
                    #(
                        #field_names: #field_types::empty(),
                    )*
                }
            }
        }
        Fields::Unnamed(fields) => {
            let field_types = fields.unnamed.iter().map(|f| &f.ty);
            quote! {
                Self (
                    #(
                        #field_types::empty(),
                    )*
                )
            }
        }
        Fields::Unit => quote! {},
    };

    let expanded = quote! {
        impl #impl_generics #core::traits::Empty for #name #ty_generics #where_clause {
            fn empty() -> Self {
                #field_impls
            }
        }
    };

    TokenStream::from(expanded)
}

#[proc_macro_derive(Opacity)]
pub fn derive_opacity(input: TokenStream) -> TokenStream {
    let core = ranim_core_path();
    impl_derive(input, quote! {#core::traits::Opacity}, |field_positions| {
        quote! {
            fn set_opacity(&mut self, opacity: f32) -> &mut Self {
                #(
                    self.#field_positions.set_opacity(opacity);
                )*
                self
            }
        }
    })
}

#[proc_macro_derive(Alignable)]
pub fn derive_alignable(input: TokenStream) -> TokenStream {
    let core = ranim_core_path();
    impl_derive(
        input,
        quote! {#core::traits::Alignable},
        |field_positions| {
            quote! {
                fn is_aligned(&self, other: &Self) -> bool {
                    #(
                        self.#field_positions.is_aligned(&other.#field_positions) &&
                    )* true
                }
                fn align_with(&mut self, other: &mut Self) {
                    #(
                        self.#field_positions.align_with(&mut other.#field_positions);
                    )*
                }
            }
        },
    )
}

#[proc_macro_derive(Interpolatable)]
pub fn derive_interpolatable(input: TokenStream) -> TokenStream {
    let core = ranim_core_path();
    impl_derive(
        input,
        quote! {#core::traits::Interpolatable},
        |field_positions| {
            quote! {
                fn lerp(&self, other: &Self, t: f64) -> Self {
                    Self {
                        #(
                            #field_positions: #core::traits::Interpolatable::lerp(&self.#field_positions, &other.#field_positions, t),
                        )*
                    }
                }
            }
        },
    )
}

#[proc_macro_derive(ShiftTransform)]
pub fn derive_shift_impl(input: TokenStream) -> TokenStream {
    let core = ranim_core_path();
    impl_derive(
        input,
        quote! {#core::traits::transform::ShiftTransform},
        |field_positions| {
            quote! {
                fn shift(&mut self, shift: #core::glam::DVec3) -> &mut Self {
                    #(self.#field_positions.shift(shift);)*
                    self
                }
            }
        },
    )
}

#[proc_macro_derive(RotateTransform)]
pub fn derive_rotate_impl(input: TokenStream) -> TokenStream {
    let core = ranim_core_path();
    impl_derive(
        input,
        quote! {#core::traits::transform::RotateTransform},
        |field_positions| {
            quote! {
                fn rotate_on_axis(&mut self, axis: #core::glam::DVec3, angle: f64) -> &mut Self {
                    #(self.#field_positions.rotate_on_axis(axis, angle);)*
                    self
                }
            }
        },
    )
}

#[proc_macro_derive(ScaleTransform)]
pub fn derive_scale_impl(input: TokenStream) -> TokenStream {
    let core = ranim_core_path();
    impl_derive(
        input,
        quote! {#core::traits::transform::ScaleTransform},
        |field_positions| {
            quote! {
                fn scale(&mut self, scale: #core::glam::DVec3) -> &mut Self {
                    #(self.#field_positions.scale(scale);)*
                    self
                }
            }
        },
    )
}

#[proc_macro_derive(PointsFunc)]
pub fn derive_point_func(input: TokenStream) -> TokenStream {
    let core = ranim_core_path();
    impl_derive(
        input,
        quote! {#core::traits::PointsFunc},
        |field_positions| {
            quote! {
                fn apply_points_func(&mut self, f: impl for<'a> Fn(&'a mut [DVec3])) -> &mut Self {
                    #(self.#field_positions.apply_points_func(f);)*
                    self
                }
            }
        },
    )
}

fn impl_derive(
    input: TokenStream,
    trait_path: proc_macro2::TokenStream,
    impl_token: impl Fn(Vec<proc_macro2::TokenStream>) -> proc_macro2::TokenStream,
) -> TokenStream {
    let input = parse_macro_input!(input as DeriveInput);
    let name = &input.ident;
    let generics = &input.generics;
    let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();

    let fields = match &input.data {
        Data::Struct(data) => &data.fields,
        _ => panic!("Can only be derived for structs"),
    };

    let field_positions = get_field_positions(fields)
        .ok_or("cannot get field from unit struct")
        .unwrap();

    let impl_token = impl_token(field_positions);
    let expanded = quote! {
        impl #impl_generics #trait_path for #name #ty_generics #where_clause {
            #impl_token
        }
    };

    TokenStream::from(expanded)
}

fn get_field_positions(fields: &Fields) -> Option<Vec<proc_macro2::TokenStream>> {
    match fields {
        Fields::Named(fields) => Some(
            fields
                .named
                .iter()
                .map(|f| {
                    let pos = &f.ident;
                    quote! { #pos }
                })
                .collect::<Vec<_>>(),
        ),
        Fields::Unnamed(fields) => Some(
            (0..fields.unnamed.len())
                .map(syn::Index::from)
                .map(|i| {
                    quote! { #i }
                })
                .collect::<Vec<_>>(),
        ),
        Fields::Unit => None,
    }
}