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
use darling::{FromDeriveInput, FromField, FromVariant};
use proc_macro2::TokenStream;
use quote::{format_ident, quote, quote_spanned};
use syn::{parse_macro_input, spanned::Spanned, Data, DeriveInput};
#[derive(Default, FromMeta)]
struct DisplayFieldOpts {
/// Skip formatting this field or variant
#[darling(default)]
skip: bool,
/// Use this field when formatting extra data
#[darling(default)]
extra: bool,
}
#[derive(Default, FromMeta)]
struct DisplayVariantOpts {
/// Value to use as extra format instead of the variant name
#[darling(default)]
extra: Option<String>,
}
#[derive(FromField)]
#[darling(attributes(lang_util))]
struct NodeDisplayField {
ident: Option<syn::Ident>,
#[darling(default)]
display: DisplayFieldOpts,
}
#[derive(FromVariant)]
#[darling(attributes(lang_util))]
struct NodeDisplayVariant {
ident: syn::Ident,
fields: darling::ast::Fields<NodeDisplayField>,
#[darling(default)]
display: DisplayVariantOpts,
}
fn is_unit_enum(en: &syn::DataEnum) -> bool {
en.variants.iter().all(|variant| {
NodeDisplayVariant::from_variant(variant)
.map(|dv| dv.fields.style == darling::ast::Style::Unit)
.unwrap_or(false)
})
}
#[derive(Default, FromMeta)]
#[darling(default)]
struct NodeDisplay {
leaf: bool,
}
#[derive(FromDeriveInput)]
#[darling(attributes(lang_util))]
pub(crate) struct NodeDisplayOpts {
ident: syn::Ident,
generics: syn::Generics,
#[darling(default)]
display: NodeDisplay,
}
pub(crate) fn node_display(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
// Parse the input tokens into a syntax tree
let input = parse_macro_input!(input as DeriveInput);
// Find out struct-level options
let opts = NodeDisplayOpts::from_derive_input(&input).expect("failed to parse options");
// Add anonymous lifetimes as needed
let lifetimes: Vec<_> = opts.generics.lifetimes().map(|_| quote! { '_ }).collect();
// Generate the name of the target for usage in impl targets
let base_ident = &opts.ident;
let struct_name = if lifetimes.is_empty() {
quote! { #base_ident }
} else {
quote! { #base_ident<#(#lifetimes),*> }
};
// Is this a "Data" node?
let raw_name = base_ident
.to_string()
.strip_suffix("Data")
.map(|id| format_ident!("{}", id));
// The node name for the NodeDisplay impl
let node_name = raw_name.unwrap_or_else(|| base_ident.clone()).to_string();
let display_quoted = {
let display_extra_impl = {
let mut ts = TokenStream::new();
// TODO: Support `extra` on variant struct fields
match &input.data {
Data::Struct(st) => {
for (i, field) in st.fields.iter().enumerate() {
let df = NodeDisplayField::from_field(field)
.expect("failed to parse field attributes");
let ident = if let Some(id) = &df.ident {
quote! { #id }
} else {
let i = syn::Index::from(i);
quote! { #i }
};
if df.display.extra {
ts.extend(quote_spanned! {
field.span() =>
write!(f, " `{}`", self.#ident)?;
});
}
}
}
Data::Enum(en) => {
let mut match_body = TokenStream::new();
// Are the variants all units?
for variant in &en.variants {
let dv = NodeDisplayVariant::from_variant(variant)
.expect("failed to parse variant attributes");
let name = &dv.ident;
// Find out how to display the enum variant
let vs = dv
.display
.extra
.clone()
.unwrap_or_else(|| dv.ident.to_string());
// Fields pattern
let fields = match dv.fields.style {
darling::ast::Style::Unit => None,
darling::ast::Style::Tuple => {
let mut v = Vec::with_capacity(dv.fields.fields.len());
let ident = format_ident!("_");
for _ in 0..dv.fields.fields.len() {
v.push(ident.clone());
}
Some(quote! { (#(#v),*) })
}
darling::ast::Style::Struct => Some(quote! { { .. } }),
};
let quoted = quote_spanned! {
variant.span() =>
Self::#name #fields=> {
write!(f, " `{}`", #vs)?;
}
};
match_body.extend(quoted);
}
ts.extend(quote_spanned! {
input.span() => match self {
#match_body
};
});
}
Data::Union(_) => ts.extend(quote_spanned! {
input.span() =>
compile_error!("Unions are not supported");
}),
};
ts.extend(quote! { Ok(()) });
ts
};
let display_children_impl = if opts.display.leaf {
quote! { Ok(()) }
} else {
let mut ts = TokenStream::new();
ts.extend(quote! { use ::lang_util::node::NodeDisplay; });
match &input.data {
Data::Struct(st) => {
for (i, field) in st.fields.iter().enumerate() {
let df = NodeDisplayField::from_field(field)
.expect("failed to parse field attributes");
let ident = if let Some(id) = &df.ident {
quote! { #id }
} else {
let i = syn::Index::from(i);
quote! { #i }
};
ts.extend(quote_spanned! {
field.span() =>
write!(f, "{}", self.#ident.display().set_level(level))?;
});
}
}
Data::Enum(en) => {
let mut match_body = TokenStream::new();
if !is_unit_enum(en) {
for variant in &en.variants {
let dv = NodeDisplayVariant::from_variant(variant)
.expect("failed to parse variant attributes");
let name = &dv.ident;
if let darling::ast::Style::Unit = dv.fields.style {
let vs = dv.ident.to_string();
let quoted = quote_spanned! {
variant.span() =>
Self::#name => {
write!(f, "{}", ::lang_util::node::NodeDisplayWrapper::new(#vs, level))?;
}
};
match_body.extend(quoted);
} else if let darling::ast::Style::Tuple = dv.fields.style {
let mut variant_body = TokenStream::new();
let mut field_names = Vec::new();
for (i, field) in dv.fields.fields.iter().enumerate() {
// Add tuple identifier
let ff = if field.display.skip {
format_ident!("_")
} else {
format_ident!("tuple{}", i)
};
field_names.push(ff.clone());
// Add code
if !field.display.skip {
variant_body.extend(quote! {
write!(f, "{}", #ff.display().set_level(level))?;
});
}
}
match_body.extend(quote_spanned! {
variant.span() =>
Self::#name(#(#field_names),*) => {
#variant_body
}
});
} else {
let mut variant_body = TokenStream::new();
let mut field_names = Vec::new();
for field in &dv.fields.fields {
// Add tuple identifier
let ff = field.ident.as_ref().unwrap();
field_names.push(ff.clone());
// Add code
if !field.display.skip {
variant_body.extend(quote! {
write!(f, "{}", #ff.display().set_level(level))?;
});
}
}
match_body.extend(quote_spanned! {
variant.span() =>
Self::#name { #(#field_names),* } => {
#variant_body
}
});
}
}
ts.extend(quote_spanned! {
input.span() => match self {
#match_body
};
});
}
}
Data::Union(_) => ts.extend(quote_spanned! {
input.span() =>
compile_error!("Unions are not supported");
}),
};
ts.extend(quote! { Ok(()) });
ts
};
quote! {
#[automatically_derived]
impl ::lang_util::node::NodeContentDisplay for #struct_name {
fn name() -> Option<&'static str> {
Some(#node_name)
}
fn display_extra(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
#display_extra_impl
}
fn display_children(&self, level: usize, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
#display_children_impl
}
}
}
};
proc_macro::TokenStream::from(display_quoted)
}