rustc_builtin_macros/deriving/cmp/
eq.rs

1use rustc_ast::{self as ast, MetaItem};
2use rustc_data_structures::fx::FxHashSet;
3use rustc_expand::base::{Annotatable, ExtCtxt};
4use rustc_span::{Span, sym};
5use thin_vec::{ThinVec, thin_vec};
6
7use crate::deriving::generic::ty::*;
8use crate::deriving::generic::*;
9use crate::deriving::path_std;
10
11pub(crate) fn expand_deriving_eq(
12    cx: &ExtCtxt<'_>,
13    span: Span,
14    mitem: &MetaItem,
15    item: &Annotatable,
16    push: &mut dyn FnMut(Annotatable),
17    is_const: bool,
18) {
19    let span = cx.with_def_site_ctxt(span);
20
21    let trait_def = TraitDef {
22        span,
23        path: path_std!(cmp::Eq),
24        skip_path_as_bound: false,
25        needs_copy_as_bound_if_packed: true,
26        additional_bounds: Vec::new(),
27        supports_unions: true,
28        methods: vec![MethodDef {
29            name: sym::assert_receiver_is_total_eq,
30            generics: Bounds::empty(),
31            explicit_self: true,
32            nonself_args: vec![],
33            ret_ty: Unit,
34            attributes: thin_vec![
35                cx.attr_word(sym::inline, span),
36                cx.attr_nested_word(sym::doc, sym::hidden, span),
37                cx.attr_nested_word(sym::coverage, sym::off, span)
38            ],
39            fieldless_variants_strategy: FieldlessVariantsStrategy::Unify,
40            combine_substructure: combine_substructure(Box::new(|a, b, c| {
41                cs_total_eq_assert(a, b, c)
42            })),
43        }],
44        associated_types: Vec::new(),
45        is_const,
46        is_staged_api_crate: cx.ecfg.features.staged_api(),
47    };
48    trait_def.expand_ext(cx, mitem, item, push, true)
49}
50
51fn cs_total_eq_assert(
52    cx: &ExtCtxt<'_>,
53    trait_span: Span,
54    substr: &Substructure<'_>,
55) -> BlockOrExpr {
56    let mut stmts = ThinVec::new();
57    let mut seen_type_names = FxHashSet::default();
58    let mut process_variant = |variant: &ast::VariantData| {
59        for field in variant.fields() {
60            // This basic redundancy checking only prevents duplication of
61            // assertions like `AssertParamIsEq<Foo>` where the type is a
62            // simple name. That's enough to get a lot of cases, though.
63            if let Some(name) = field.ty.kind.is_simple_path()
64                && !seen_type_names.insert(name)
65            {
66                // Already produced an assertion for this type.
67            } else {
68                // let _: AssertParamIsEq<FieldTy>;
69                super::assert_ty_bounds(
70                    cx,
71                    &mut stmts,
72                    field.ty.clone(),
73                    field.span,
74                    &[sym::cmp, sym::AssertParamIsEq],
75                );
76            }
77        }
78    };
79
80    match *substr.fields {
81        StaticStruct(vdata, ..) => {
82            process_variant(vdata);
83        }
84        StaticEnum(enum_def, ..) => {
85            for variant in &enum_def.variants {
86                process_variant(&variant.data);
87            }
88        }
89        _ => cx.dcx().span_bug(trait_span, "unexpected substructure in `derive(Eq)`"),
90    }
91    BlockOrExpr::new_stmts(stmts)
92}