oxide-generation-macros 0.2.0

use super::error_store::{ErrorSink, ErrorStore};
use heck::ToSnakeCase;
use proc_macro2::{Delimiter, Span, TokenStream, TokenTree};
use quote::{ToTokens, format_ident, quote, quote_spanned};
use serde::Deserialize;
use serde_tokenstream::{
    OrderedMap, ParseWrapper, TokenStreamWrapper, from_tokenstream, from_tokenstream_spanned,
};
use syn::spanned::Spanned;

pub struct ImplKindsOutput {
    pub out: Option<TokenStream>,
    pub errors: Vec<syn::Error>,
}

impl ToTokens for ImplKindsOutput {
    fn to_tokens(&self, tokens: &mut TokenStream) {
        tokens.extend(self.out.clone());
        tokens.extend(self.errors.iter().map(|error| error.to_compile_error()));
    }
}

pub fn impl_typed_generation_kinds(input: TokenStream) -> ImplKindsOutput {
    let params: ImplKindsParams = match from_tokenstream(&input) {
        Ok(input) => input,
        Err(error) => {
            let errors = vec![error];
            return ImplKindsOutput { out: None, errors };
        }
    };

    let oxide_generation_ident = syn::Ident::new("oxide_generation", input.span());
    let oxide_generation_crate = params
        .settings
        .oxide_generation_crate
        .as_ref()
        .map_or_else(|| &oxide_generation_ident, |crate_name| &**crate_name);

    let mut out = quote! {};

    let mut error_store = ErrorStore::new();
    let errors = error_store.sink();

    for (kind_tokens, config_tokens) in params.kinds {
        let errors = errors.new_child();

        let Some((root_ident, config)) = parse_kind(
            kind_tokens.into_inner(),
            config_tokens.into_inner(),
            errors.new_child(),
        ) else {
            // A critical error occurred for this kind -- can't proceed any
            // further.
            continue;
        };
        let Some(config) = config.validate(errors.new_child()) else {
            // The config couldn't be parsed -- can't proceed any further.
            continue;
        };

        let name = if let Some(tag) = &config.tag {
            KindOrExplicitTag::Tag(tag)
        } else {
            KindOrExplicitTag::Kind(&root_ident)
        };

        // Validate the tag name here using the same logic as in oxide-generation.
        // Doing so in the proc macro results in better error messages.
        validate_tag_name(&name, errors.new_child());
        if errors.has_critical_errors() {
            // Don't generate output since it'll panic and lead to worse errors.
            continue;
        }

        let tag_name = name.tag_name();
        let kind_name_ident = config
            .type_name
            .unwrap_or_else(|| format_ident!("{}GenerationKind", root_ident));
        let alias_ident = config
            .alias
            .unwrap_or_else(|| format_ident!("{}Generation", root_ident));

        let attrs = config.attrs.as_ref().unwrap_or(&params.settings.attrs);
        let attrs = attrs.iter().map(|attr| &**attr);

        // Generate JsonSchema implementation if schemars08 settings are provided
        let schemars_impl = if let Some(schemars_settings) = &params.settings.schemars08 {
            generate_schemars_impl(
                &kind_name_ident,
                &kind_name_ident.to_string(),
                schemars_settings,
                oxide_generation_crate,
            )
        } else {
            quote! {}
        };

        let expanded = quote_spanned! {root_ident.span() =>
            #[derive(Clone, Copy, Debug, PartialEq, Eq)]
            #(#attrs)*
            pub enum #kind_name_ident {}

            impl ::#oxide_generation_crate::TypedGenerationKind for #kind_name_ident {
                const TAG: ::#oxide_generation_crate::TypedGenerationTag = ::#oxide_generation_crate::TypedGenerationTag::new(#tag_name);

                const ALIAS: Option<&'static str> = Some(stringify!(#alias_ident));
            }

            // Unused associated constants aren't evaluated, so force an
            // evaluation here to validate the tag at the definition site.
            const _: () = {
                let _ = <#kind_name_ident as ::#oxide_generation_crate::TypedGenerationKind>::TAG;
            };

            #schemars_impl

            #[allow(unused)]
            pub type #alias_ident = ::#oxide_generation_crate::TypedGeneration<#kind_name_ident>;
        };

        out.extend(expanded);
    }

    let errors = error_store.into_inner();
    ImplKindsOutput {
        out: Some(out),
        errors,
    }
}

fn parse_kind(
    kind_tokens: TokenStream,
    kind_config_tokens: TokenTree,
    errors: ErrorSink<'_, syn::Error>,
) -> Option<(syn::Ident, KindConfig)> {
    let kind_ident = match syn::parse2::<syn::Ident>(kind_tokens) {
        Ok(ident) => Some(ident),
        Err(err) => {
            // Collect the error.
            errors.push_critical(err);
            None
        }
    };
    // tokens is surrounded by {}
    let kind_config = match kind_config_tokens {
        TokenTree::Group(group) => {
            // group.delimiter() must be {}
            if group.delimiter() == Delimiter::Brace {
                match from_tokenstream_spanned::<KindConfig>(&group.delim_span(), &group.stream()) {
                    Ok(config) => Some(config),
                    Err(err) => {
                        // Collect the error.
                        errors.push_critical(err);
                        None
                    }
                }
            } else {
                // Collect the error.
                errors.push_critical(syn::Error::new(group.span(), "expected `{`"));
                None
            }
        }
        _ => {
            // Collect the error.
            errors.push_critical(syn::Error::new(kind_config_tokens.span(), "expected `{`"));
            None
        }
    };

    if errors.has_critical_errors() {
        None
    } else {
        Some((
            kind_ident.expect("no critical errors => kind is guaranteed to be Some"),
            kind_config.expect("no critical errors => kind config is guaranteed to be Some"),
        ))
    }
}

fn validate_tag_name(name: &KindOrExplicitTag<'_>, errors: ErrorSink<'_, syn::Error>) {
    let tag_name = name.tag_name();
    let span = name.span();

    let mut chars = tag_name.chars();
    let Some(first) = chars.next() else {
        errors.push_critical(syn::Error::new(
            span,
            format!("tag name must not be empty{}", name.hint()),
        ));
        return;
    };
    if !(first.is_ascii_alphabetic() || first == '_') {
        errors.push_critical(syn::Error::new(
            span,
            format!(
                "tag name `{tag_name}` must start with an ASCII letter or underscore{}",
                name.hint(),
            ),
        ));
    }

    for c in chars {
        // Tag names can contain hyphens, but Rust identifiers cannot -- so we
        // don't check for that here. (Once we allow setting custom tag names,
        // we can check for that functionality.)
        if !(c.is_ascii_alphanumeric() || c == '_') {
            errors.push_critical(syn::Error::new(
                span,
                format!(
                    "tag name `{tag_name}` must consist of ASCII \
                     alphanumeric characters or underscores{}",
                    name.hint()
                ),
            ));
        }
    }
}

enum KindOrExplicitTag<'a> {
    /// A kind name was specified and will be converted into the corresponding
    /// tag name.
    Kind(&'a syn::Ident),

    /// A tag name was specified and will be used as-is.
    Tag(&'a syn::LitStr),
}

impl<'a> KindOrExplicitTag<'a> {
    fn tag_name(&self) -> String {
        match self {
            KindOrExplicitTag::Kind(kind_name) => kind_name.to_string().to_snake_case(),
            KindOrExplicitTag::Tag(tag_name) => tag_name.value(),
        }
    }

    fn span(&self) -> Span {
        match self {
            KindOrExplicitTag::Kind(kind_name) => kind_name.span(),
            KindOrExplicitTag::Tag(tag_name) => tag_name.span(),
        }
    }

    fn hint(&self) -> String {
        match self {
            KindOrExplicitTag::Kind(kind_name) => {
                format!(
                    "\n(hint: tag name `{}` derived from kind name -- \
                     specify `tag = \"...\" for a custom tag name`)",
                    kind_name.to_string().to_snake_case(),
                )
            }
            KindOrExplicitTag::Tag(_) => String::new(),
        }
    }
}

/// Input structure for the `impl_typed_generation_kinds` macro.
#[derive(Deserialize)]
#[serde(deny_unknown_fields)]
struct ImplKindsParams {
    #[serde(default)]
    settings: GlobalSettings,
    kinds: OrderedMap<TokenStreamWrapper, ParseWrapper<TokenTree>>,
}

/// Global settings for the macro.
#[derive(Deserialize, Default)]
#[serde(deny_unknown_fields)]
struct GlobalSettings {
    /// The name of the oxide-generation crate.
    #[serde(default)]
    oxide_generation_crate: Option<ParseWrapper<syn::Ident>>,

    /// Attributes to apply to generated types.
    #[serde(default)]
    attrs: Vec<TokenStreamWrapper>,

    /// Schemars configuration.
    #[serde(default)]
    schemars08: Option<SchemarsSettings>,
}

/// Settings for schemars08 integration.
#[derive(Deserialize)]
#[serde(deny_unknown_fields)]
struct SchemarsSettings {
    #[serde(default)]
    attrs: Vec<TokenStreamWrapper>,
    rust_type: RustTypeSettings,
}

/// Settings for the x-rust-type extension.
#[derive(Deserialize)]
#[serde(deny_unknown_fields)]
struct RustTypeSettings {
    #[serde(rename = "crate")]
    crate_name: String,
    version: String,
    path: String,
}

/// Configuration for each kind.
#[derive(Deserialize)]
#[serde(deny_unknown_fields)]
struct KindConfig {
    /// The type name for this kind.
    #[serde(default)]
    type_name: Option<TokenStreamWrapper>,

    /// The type alias for the kind.
    alias: Option<TokenStreamWrapper>,

    /// The tag for this kind. Defaults to the snake_case name of the kind.
    #[serde(default)]
    tag: Option<TokenStreamWrapper>,

    /// Attributes to apply to generated types (e.g. derives).
    #[serde(default)]
    attrs: Option<Vec<TokenStreamWrapper>>,
}

impl KindConfig {
    fn validate(self, errors: ErrorSink<'_, syn::Error>) -> Option<ParsedKindConfig> {
        // Parse the type name as an Ident.
        let type_name = match self.type_name {
            Some(type_name) => match syn::parse2::<syn::Ident>(type_name.into_inner()) {
                Ok(ident) => Ok(Some(ident)),
                Err(error) => {
                    errors.push_critical(error);
                    Err(())
                }
            },
            None => Ok(None),
        };
        // Parse the alias as an Ident.
        let alias = match self.alias {
            Some(alias) => match syn::parse2::<syn::Ident>(alias.into_inner()) {
                Ok(ident) => Ok(Some(ident)),
                Err(error) => {
                    errors.push_critical(error);
                    Err(())
                }
            },
            None => Ok(None),
        };
        // Parse the tag as a LitStr.
        let tag = match self.tag {
            Some(tag) => match syn::parse2::<syn::LitStr>(tag.into_inner()) {
                Ok(lit_str) => Ok(Some(lit_str)),
                Err(error) => {
                    errors.push_critical(error);
                    Err(())
                }
            },
            None => Ok(None),
        };

        if errors.has_critical_errors() {
            None
        } else {
            // All parsed values are valid if present.
            Some(ParsedKindConfig {
                type_name: type_name.expect("type name is valid"),
                alias: alias.expect("alias is valid"),
                tag: tag.expect("tag is valid"),
                attrs: self.attrs,
            })
        }
    }
}

struct ParsedKindConfig {
    type_name: Option<syn::Ident>,
    alias: Option<syn::Ident>,
    tag: Option<syn::LitStr>,
    attrs: Option<Vec<TokenStreamWrapper>>,
}

/// Generate a hand-written JsonSchema implementation for a kind.
fn generate_schemars_impl(
    kind_name_ident: &syn::Ident,
    kind_name: &str,
    schemars_settings: &SchemarsSettings,
    oxide_generation_crate: &syn::Ident,
) -> proc_macro2::TokenStream {
    let attrs = schemars_settings.attrs.iter().map(|attrs| &**attrs);
    let crate_name = &schemars_settings.rust_type.crate_name;
    let version = &schemars_settings.rust_type.version;
    let path_prefix = &schemars_settings.rust_type.path;

    // Construct the full path for this specific kind.
    let full_path = format!("{}::{}", path_prefix, kind_name_ident);

    quote! {
        #(#attrs)*
        impl ::#oxide_generation_crate::macro_support::schemars08::JsonSchema for #kind_name_ident {
            fn schema_name() -> ::std::string::String {
                #kind_name.to_string()
            }

            fn schema_id() -> ::std::borrow::Cow<'static, str> {
                ::std::borrow::Cow::Borrowed(#full_path)
            }

            fn json_schema(
                _gen: &mut ::#oxide_generation_crate::macro_support::schemars08::r#gen::SchemaGenerator,
            ) -> ::#oxide_generation_crate::macro_support::schemars08::schema::Schema {
                use ::#oxide_generation_crate::macro_support::schemars08::schema::*;

                let mut schema = SchemaObject {
                    subschemas: ::std::option::Option::Some(Box::new(SubschemaValidation {
                        not: ::std::option::Option::Some(Box::new(Schema::Bool(true))),
                        ..::std::default::Default::default()
                    })),
                    ..::std::default::Default::default()
                };

                // Add the x-rust-type extension.
                let mut extensions = ::#oxide_generation_crate::macro_support::schemars08::Map::new();
                let rust_type = ::#oxide_generation_crate::macro_support::serde_json::json!({
                    "crate": #crate_name,
                    "version": #version,
                    "path": #full_path,
                });
                extensions.insert("x-rust-type".to_string(), rust_type);
                schema.extensions = extensions;

                Schema::Object(schema)
            }
        }
    }
}