use crate::deriving::generic::ty::*; use crate::deriving::generic::*; use crate::errors; use core::ops::ControlFlow; use rustc_ast as ast; use rustc_ast::visit::visit_opt; use rustc_ast::{attr, EnumDef, VariantData}; use rustc_expand::base::{Annotatable, DummyResult, ExtCtxt}; use rustc_span::symbol::Ident; use rustc_span::symbol::{kw, sym}; use rustc_span::{ErrorGuaranteed, Span}; use smallvec::SmallVec; use thin_vec::{thin_vec, ThinVec}; pub(crate) fn expand_deriving_default( cx: &ExtCtxt<'_>, span: Span, mitem: &ast::MetaItem, item: &Annotatable, push: &mut dyn FnMut(Annotatable), is_const: bool, ) { item.visit_with(&mut DetectNonVariantDefaultAttr { cx }); let trait_def = TraitDef { span, path: Path::new(vec![kw::Default, sym::Default]), skip_path_as_bound: has_a_default_variant(item), needs_copy_as_bound_if_packed: false, additional_bounds: Vec::new(), supports_unions: false, methods: vec![MethodDef { name: kw::Default, generics: Bounds::empty(), explicit_self: false, nonself_args: Vec::new(), ret_ty: Self_, attributes: thin_vec![cx.attr_word(sym::inline, span)], fieldless_variants_strategy: FieldlessVariantsStrategy::Default, combine_substructure: combine_substructure(Box::new(|cx, trait_span, substr| { match substr.fields { StaticStruct(_, fields) => { default_struct_substructure(cx, trait_span, substr, fields) } StaticEnum(enum_def, _) => default_enum_substructure(cx, trait_span, enum_def), _ => cx.dcx().span_bug(trait_span, "method in `derive(Default)`"), } })), }], associated_types: Vec::new(), is_const, }; trait_def.expand(cx, mitem, item, push) } fn default_struct_substructure( cx: &ExtCtxt<'_>, trait_span: Span, substr: &Substructure<'_>, summary: &StaticFields, ) -> BlockOrExpr { // Note that `kw::Default` is "default" and `sym::Default` is "Default"! let default_ident = cx.std_path(&[kw::Default, sym::Default, kw::Default]); let default_call = |span| cx.expr_call_global(span, default_ident.clone(), ThinVec::new()); let expr = match summary { Unnamed(_, IsTuple::No) => cx.expr_ident(trait_span, substr.type_ident), Unnamed(fields, IsTuple::Yes) => { let exprs = fields.iter().map(|sp| default_call(*sp)).collect(); cx.expr_call_ident(trait_span, substr.type_ident, exprs) } Named(fields) => { let default_fields = fields .iter() .map(|&(ident, span)| cx.field_imm(span, ident, default_call(span))) .collect(); cx.expr_struct_ident(trait_span, substr.type_ident, default_fields) } }; BlockOrExpr::new_expr(expr) } fn default_enum_substructure( cx: &ExtCtxt<'_>, trait_span: Span, enum_def: &EnumDef, ) -> BlockOrExpr { let expr = match try { let default_variant = extract_default_variant(cx, enum_def, trait_span)?; validate_default_attribute(cx, default_variant)?; default_variant } { Ok(default_variant) => { // We now know there is exactly one unit variant with exactly one `#[default]` attribute. cx.expr_path(cx.path( default_variant.span, vec![Ident::new(kw::SelfUpper, default_variant.span), default_variant.ident], )) } Err(guar) => DummyResult::raw_expr(trait_span, Some(guar)), }; BlockOrExpr::new_expr(expr) } fn extract_default_variant<'a>( cx: &ExtCtxt<'_>, enum_def: &'a EnumDef, trait_span: Span, ) -> Result<&'a rustc_ast::Variant, ErrorGuaranteed> { let default_variants: SmallVec<[_; 1]> = enum_def .variants .iter() .filter(|variant| attr::contains_name(&variant.attrs, kw::Default)) .collect(); let variant = match default_variants.as_slice() { [variant] => variant, [] => { let possible_defaults = enum_def .variants .iter() .filter(|variant| matches!(variant.data, VariantData::Unit(..))) .filter(|variant| !attr::contains_name(&variant.attrs, sym::non_exhaustive)); let suggs = possible_defaults .map(|v| errors::NoDefaultVariantSugg { span: v.span, ident: v.ident }) .collect(); let guar = cx.dcx().emit_err(errors::NoDefaultVariant { span: trait_span, suggs }); return Err(guar); } [first, rest @ ..] => { let suggs = default_variants .iter() .filter_map(|variant| { let keep = attr::find_by_name(&variant.attrs, kw::Default)?.span; let spans: Vec = default_variants .iter() .flat_map(|v| { attr::filter_by_name(&v.attrs, kw::Default) .filter_map(|attr| (attr.span != keep).then_some(attr.span)) }) .collect(); (!spans.is_empty()) .then_some(errors::MultipleDefaultsSugg { spans, ident: variant.ident }) }) .collect(); let guar = cx.dcx().emit_err(errors::MultipleDefaults { span: trait_span, first: first.span, additional: rest.iter().map(|v| v.span).collect(), suggs, }); return Err(guar); } }; if !matches!(variant.data, VariantData::Unit(..)) { let guar = cx.dcx().emit_err(errors::NonUnitDefault { span: variant.ident.span }); return Err(guar); } if let Some(non_exhaustive_attr) = attr::find_by_name(&variant.attrs, sym::non_exhaustive) { let guar = cx.dcx().emit_err(errors::NonExhaustiveDefault { span: variant.ident.span, non_exhaustive: non_exhaustive_attr.span, }); return Err(guar); } Ok(variant) } fn validate_default_attribute( cx: &ExtCtxt<'_>, default_variant: &rustc_ast::Variant, ) -> Result<(), ErrorGuaranteed> { let attrs: SmallVec<[_; 1]> = attr::filter_by_name(&default_variant.attrs, kw::Default).collect(); let attr = match attrs.as_slice() { [attr] => attr, [] => cx.dcx().bug( "this method must only be called with a variant that has a `#[default]` attribute", ), [first, rest @ ..] => { let sugg = errors::MultipleDefaultAttrsSugg { spans: rest.iter().map(|attr| attr.span).collect(), }; let guar = cx.dcx().emit_err(errors::MultipleDefaultAttrs { span: default_variant.ident.span, first: first.span, first_rest: rest[0].span, rest: rest.iter().map(|attr| attr.span).collect::>().into(), only_one: rest.len() == 1, sugg, }); return Err(guar); } }; if !attr.is_word() { let guar = cx.dcx().emit_err(errors::DefaultHasArg { span: attr.span }); return Err(guar); } Ok(()) } struct DetectNonVariantDefaultAttr<'a, 'b> { cx: &'a ExtCtxt<'b>, } impl<'a, 'b> rustc_ast::visit::Visitor<'a> for DetectNonVariantDefaultAttr<'a, 'b> { fn visit_attribute(&mut self, attr: &'a rustc_ast::Attribute) { if attr.has_name(kw::Default) { self.cx.dcx().emit_err(errors::NonUnitDefault { span: attr.span }); } rustc_ast::visit::walk_attribute(self, attr); } fn visit_variant(&mut self, v: &'a rustc_ast::Variant) { self.visit_ident(v.ident); self.visit_vis(&v.vis); self.visit_variant_data(&v.data); visit_opt!(self, visit_anon_const, &v.disr_expr); for attr in &v.attrs { rustc_ast::visit::walk_attribute(self, attr); } } } fn has_a_default_variant(item: &Annotatable) -> bool { struct HasDefaultAttrOnVariant; impl<'ast> rustc_ast::visit::Visitor<'ast> for HasDefaultAttrOnVariant { type Result = ControlFlow<()>; fn visit_variant(&mut self, v: &'ast rustc_ast::Variant) -> ControlFlow<()> { if v.attrs.iter().any(|attr| attr.has_name(kw::Default)) { ControlFlow::Break(()) } else { // no need to subrecurse. ControlFlow::Continue(()) } } } item.visit_with(&mut HasDefaultAttrOnVariant).is_break() }