1 use crate::deriving::generic::ty::*;
2 use crate::deriving::generic::*;
3 use crate::deriving::{path_std, pathvec_std};
4 use rustc_ast::{ExprKind, ItemKind, MetaItem, PatKind};
5 use rustc_expand::base::{Annotatable, ExtCtxt};
6 use rustc_span::symbol::{sym, Ident};
8 use thin_vec::thin_vec;
10 pub fn expand_deriving_partial_ord(
15 push: &mut dyn FnMut(Annotatable),
18 let ordering_ty = Path(path_std!(cmp::Ordering));
20 Path(Path::new_(pathvec_std!(option::Option), vec![Box::new(ordering_ty)], PathKind::Std));
22 let attrs = thin_vec![cx.attr_word(sym::inline, span)];
24 // Order in which to perform matching
25 let tag_then_data = if let Annotatable::Item(item) = item
26 && let ItemKind::Enum(def, _) = &item.kind {
27 let dataful: Vec<bool> = def.variants.iter().map(|v| !v.data.fields().is_empty()).collect();
28 match dataful.iter().filter(|&&b| b).count() {
29 // No data, placing the tag check first makes codegen simpler
33 (0..dataful.len()-1).any(|i| {
34 if dataful[i] && let Some(idx) = dataful[i+1..].iter().position(|v| *v) {
45 let partial_cmp_def = MethodDef {
46 name: sym::partial_cmp,
47 generics: Bounds::empty(),
49 nonself_args: vec![(self_ref(), sym::other)],
52 fieldless_variants_strategy: FieldlessVariantsStrategy::Unify,
53 combine_substructure: combine_substructure(Box::new(|cx, span, substr| {
54 cs_partial_cmp(cx, span, substr, tag_then_data)
58 let trait_def = TraitDef {
60 path: path_std!(cmp::PartialOrd),
61 skip_path_as_bound: false,
62 needs_copy_as_bound_if_packed: true,
63 additional_bounds: vec![],
64 supports_unions: false,
65 methods: vec![partial_cmp_def],
66 associated_types: Vec::new(),
69 trait_def.expand(cx, mitem, item, push)
75 substr: &Substructure<'_>,
78 let test_id = Ident::new(sym::cmp, span);
79 let equal_path = cx.path_global(span, cx.std_path(&[sym::cmp, sym::Ordering, sym::Equal]));
80 let partial_cmp_path = cx.std_path(&[sym::cmp, sym::PartialOrd, sym::partial_cmp]);
84 // match ::core::cmp::PartialOrd::partial_cmp(&self.x, &other.x) {
85 // ::core::option::Option::Some(::core::cmp::Ordering::Equal) =>
86 // ::core::cmp::PartialOrd::partial_cmp(&self.y, &other.y),
90 // foldr nests the if-elses correctly, leaving the first field
91 // as the outermost one, and the last as the innermost.
96 |cx, fold| match fold {
97 CsFold::Single(field) => {
98 let [other_expr] = &field.other_selflike_exprs[..] else {
99 cx.span_bug(field.span, "not exactly 2 arguments in `derive(Ord)`");
101 let args = vec![field.self_expr.clone(), other_expr.clone()];
102 cx.expr_call_global(field.span, partial_cmp_path.clone(), args)
104 CsFold::Combine(span, mut expr1, expr2) => {
105 // When the item is an enum, this expands to
108 // Some(Ordering::Equal) => expr1,
112 // where `expr2` is `partial_cmp(self_tag, other_tag)`, and `expr1` is a `match`
113 // against the enum variants. This means that we begin by comparing the enum tags,
114 // before either inspecting their contents (if they match), or returning
115 // the `cmp::Ordering` of comparing the enum tags.
117 // match partial_cmp(self_tag, other_tag) {
118 // Some(Ordering::Equal) => match (self, other) {
119 // (Self::A(self_0), Self::A(other_0)) => partial_cmp(self_0, other_0),
120 // (Self::B(self_0), Self::B(other_0)) => partial_cmp(self_0, other_0),
121 // _ => Some(Ordering::Equal)
126 // If we have any certain enum layouts, flipping this results in better codegen
128 // match (self, other) {
129 // (Self::A(self_0), Self::A(other_0)) => partial_cmp(self_0, other_0),
130 // _ => partial_cmp(self_tag, other_tag)
133 // Reference: https://github.com/rust-lang/rust/pull/103659#issuecomment-1328126354
136 && let ExprKind::Match(_, arms) = &mut expr1.kind
137 && let Some(last) = arms.last_mut()
138 && let PatKind::Wild = last.pat.kind {
143 cx.arm(span, cx.pat_some(span, cx.pat_path(span, equal_path.clone())), expr1);
145 cx.arm(span, cx.pat_ident(span, test_id), cx.expr_ident(span, test_id));
146 cx.expr_match(span, expr2, vec![eq_arm, neq_arm])
149 CsFold::Fieldless => cx.expr_some(span, cx.expr_path(equal_path.clone())),
152 BlockOrExpr::new_expr(expr)