src/libsyntax/ext/deriving/cmp/ord.rs

   1 // Copyright 2013 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 use ast;
  12 use ast::{MetaItem, Item, Expr};
  13 use codemap::Span;
  14 use ext::base::ExtCtxt;
  15 use ext::build::AstBuilder;
  16 use ext::deriving::generic::*;
  17
  18 pub fn expand_deriving_ord(cx: &mut ExtCtxt,
  19                            span: Span,
  20                            mitem: @MetaItem,
  21                            item: @Item,
  22                            push: |@Item|) {
  23     macro_rules! md (
  24         ($name:expr, $op:expr, $equal:expr) => {
  25             MethodDef {
  26                 name: $name,
  27                 generics: LifetimeBounds::empty(),
  28                 explicit_self: borrowed_explicit_self(),
  29                 args: ~[borrowed_self()],
  30                 ret_ty: Literal(Path::new(~["bool"])),
  31                 inline: true,
  32                 const_nonmatching: false,
  33                 combine_substructure: |cx, span, substr| cs_op($op, $equal, cx, span, substr)
  34             }
  35         }
  36     );
  37
  38     let trait_def = TraitDef {
  39         span: span,
  40         attributes: ~[],
  41         path: Path::new(~["std", "cmp", "Ord"]),
  42         additional_bounds: ~[],
  43         generics: LifetimeBounds::empty(),
  44         methods: ~[
  45             md!("lt", true, false),
  46             md!("le", true, true),
  47             md!("gt", false, false),
  48             md!("ge", false, true)
  49         ]
  50     };
  51     trait_def.expand(cx, mitem, item, push)
  52 }
  53
  54 /// Strict inequality.
  55 fn cs_op(less: bool, equal: bool, cx: &mut ExtCtxt, span: Span, substr: &Substructure) -> @Expr {
  56     let op = if less {ast::BiLt} else {ast::BiGt};
  57     cs_fold(
  58         false, // need foldr,
  59         |cx, span, subexpr, self_f, other_fs| {
  60             /*
  61             build up a series of chain ||'s and &&'s from the inside
  62             out (hence foldr) to get lexical ordering, i.e. for op ==
  63             `ast::lt`
  64
  65             ```
  66             self.f1 < other.f1 || (!(other.f1 < self.f1) &&
  67                 (self.f2 < other.f2 || (!(other.f2 < self.f2) &&
  68                     (false)
  69                 ))
  70             )
  71             ```
  72
  73             The optimiser should remove the redundancy. We explicitly
  74             get use the binops to avoid auto-deref derefencing too many
  75             layers of pointers, if the type includes pointers.
  76             */
  77             let other_f = match other_fs {
  78                 [o_f] => o_f,
  79                 _ => cx.span_bug(span, "not exactly 2 arguments in `deriving(Ord)`")
  80             };
  81
  82             let cmp = cx.expr_binary(span, op, self_f, other_f);
  83
  84             let not_cmp = cx.expr_unary(span, ast::UnNot,
  85                                         cx.expr_binary(span, op, other_f, self_f));
  86
  87             let and = cx.expr_binary(span, ast::BiAnd, not_cmp, subexpr);
  88             cx.expr_binary(span, ast::BiOr, cmp, and)
  89         },
  90         cx.expr_bool(span, equal),
  91         |cx, span, args, _| {
  92             // nonmatching enums, order by the order the variants are
  93             // written
  94             match args {
  95                 [(self_var, _, _),
  96                  (other_var, _, _)] =>
  97                     cx.expr_bool(span,
  98                                  if less {
  99                                      self_var < other_var
 100                                  } else {
 101                                      self_var > other_var
 102                                  }),
 103                 _ => cx.span_bug(span, "not exactly 2 arguments in `deriving(Ord)`")
 104             }
 105         },
 106         cx, span, substr)
 107 }