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
// SPDX-FileCopyrightText: 2024 Markus Haug (Korrat)
//
// SPDX-License-Identifier: Apache-2.0
// SPDX-License-Identifier: MIT
//! This serves as a companion crate to [`nullable-utils`] and provides proc-macros to support working with Nullables.
//!
//! [`nullable-utils`]: https://crates.io/crates/nullable-utils
use proc_macro::TokenStream;
use quote::quote;
use quote::quote_spanned;
use quote::ToTokens as _;
use syn::braced;
use syn::parse::Parse;
use syn::parse::ParseStream;
use syn::parse_macro_input;
use syn::parse_quote;
use syn::punctuated::Punctuated;
use syn::spanned::Spanned as _;
use syn::token::Comma;
use syn::token::Enum;
use syn::Attribute;
use syn::Block;
use syn::Field;
use syn::Fields;
use syn::FieldsUnnamed;
use syn::FnArg;
use syn::Ident;
use syn::ItemEnum;
use syn::TraitItemFn;
use syn::Variant;
use syn::Visibility;
/// Create a wrapper enum for switching (internal) implementations efficiently.
///
/// When integrating with third-party infrastructure components (HTTP clients, database clients, …), Nullables make use
/// of embedded stubs. This macro generates a wrapper enum for seamlessly switching between the real implementation and
/// the embedded stub.
///
/// The macro expects input in the form of an enum declaration, optionally followed by a block of function declarations
/// (like in traits). Each enum variant can either be a newtype variant or a unit variant, which will be transformed a
/// into a newtype variants. The macro creates [`From<T>`] and [`TryInto<T>`] implementations for each variant.
///
/// For each method declaration, the wrapper enum will have a definition that automatically forwards the call to the its
/// variants. If the method does have a default body, this will be used instead of generating the body automatically.
#[proc_macro]
pub fn nullable_wrapper(input: TokenStream) -> TokenStream {
let wrapper = parse_macro_input!(input as NullableWrapper);
let expanded = expand(wrapper);
TokenStream::from(expanded)
}
fn expand(wrapper: NullableWrapper) -> proc_macro2::TokenStream {
let NullableWrapper {
attrs,
vis,
enum_token,
ident,
variants,
fns,
} = wrapper;
let enum_ident = ident;
let fns = fns.into_iter().map(
|TraitItemFn {
attrs,
sig,
default,
..
}| {
let method = &sig.ident;
let args: Punctuated<_, Comma> = sig
.inputs
.iter()
.filter_map(|arg| match arg {
FnArg::Receiver(_) => None,
FnArg::Typed(pat) => Some(&pat.pat),
})
.collect();
let body = default.map_or_else(
|| {
let matchers = variants.iter().map(
|Variant { ident, .. }| quote!(Self::#ident(inner) => inner.#method(#args)),
);
quote!({
match self {
#(#matchers),*
}
})
},
Block::into_token_stream,
);
quote! {
#(#attrs)*
#sig #body
}
},
);
let from_impls = variants.iter().map(|var @ Variant { ident, fields, .. }| {
// TODO handle variant attrs
let Fields::Unnamed(FieldsUnnamed { unnamed, .. }) = fields else {
panic!()
};
let Field { ty, .. } = &unnamed[0];
quote_spanned! { var.span() =>
impl From<#ty> for #enum_ident {
fn from(value: #ty) -> Self {
Self::#ident(value)
}
}
}
});
let try_into_impls = variants.iter().map(|var @ Variant { ident, fields, .. }| {
// TODO handle variant attrs
let Fields::Unnamed(FieldsUnnamed { unnamed, .. }) = fields else {
panic!()
};
let Field { ty, .. } = &unnamed[0];
quote_spanned! { var.span() =>
impl TryFrom<#enum_ident> for #ty {
type Error = ();
fn try_from(value: #enum_ident) -> Result<Self, Self::Error> {
match value {
#enum_ident::#ident(inner) => Ok(inner),
_ => Err(())
}
}
}
}
});
let expanded = quote! {
#(#attrs)*
#vis #enum_token #enum_ident {
#variants
}
impl #enum_ident {
#(#fns)*
}
#(#from_impls)*
#(#try_into_impls)*
};
expanded
}
struct NullableWrapper {
attrs: Vec<Attribute>,
vis: Visibility,
enum_token: Enum,
ident: Ident,
variants: Punctuated<Variant, Comma>,
fns: Vec<TraitItemFn>,
}
// TODO parse syntax ourselves instead of reusing syn types?
impl Parse for NullableWrapper {
fn parse(input: ParseStream) -> syn::Result<Self> {
let ItemEnum {
attrs,
vis,
enum_token,
ident,
mut variants,
..
} = input.parse()?;
for variant in &mut variants {
match variant.fields {
Fields::Unit => {
let name = &variant.ident;
variant.fields = Fields::Unnamed(parse_quote!((#name)));
}
Fields::Unnamed(FieldsUnnamed {
ref mut unnamed, ..
}) if unnamed.len() == 1 => {}
_ => {
return Err(syn::Error::new_spanned(
&variant,
"only unit and new-type variants are supported",
))
}
}
}
// TODO handle generics, brace token & method definitions
let mut fns = Vec::new();
if !input.is_empty() {
let content;
braced!(content in input);
while !content.is_empty() {
fns.push(content.parse()?);
}
}
Ok(NullableWrapper {
attrs,
vis,
enum_token,
ident,
variants,
fns,
})
}
}