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 use parse::token::InternedString;
  18
  19 pub fn expand_deriving_ord(cx: &mut ExtCtxt,
  20                            span: Span,
  21                            mitem: @MetaItem,
  22                            item: @Item,
  23                            push: |@Item|) {
  24     macro_rules! md (
  25         ($name:expr, $op:expr, $equal:expr) => { {
  26             let inline = cx.meta_word(span, InternedString::new("inline"));
  27             let attrs = vec!(cx.attribute(span, inline));
  28             MethodDef {
  29                 name: $name,
  30                 generics: LifetimeBounds::empty(),
  31                 explicit_self: borrowed_explicit_self(),
  32                 args: vec!(borrowed_self()),
  33                 ret_ty: Literal(Path::new(vec!("bool"))),
  34                 attributes: attrs,
  35                 const_nonmatching: false,
  36                 combine_substructure: |cx, span, substr| cs_op($op, $equal, cx, span, substr)
  37             }
  38         } }
  39     );
  40
  41     let trait_def = TraitDef {
  42         span: span,
  43         attributes: Vec::new(),
  44         path: Path::new(vec!("std", "cmp", "Ord")),
  45         additional_bounds: Vec::new(),
  46         generics: LifetimeBounds::empty(),
  47         methods: vec!(
  48             md!("lt", true, false),
  49             md!("le", true, true),
  50             md!("gt", false, false),
  51             md!("ge", false, true)
  52         )
  53     };
  54     trait_def.expand(cx, mitem, item, push)
  55 }
  56
  57 /// Strict inequality.
  58 fn cs_op(less: bool, equal: bool, cx: &mut ExtCtxt, span: Span, substr: &Substructure) -> @Expr {
  59     let op = if less {ast::BiLt} else {ast::BiGt};
  60     cs_fold(
  61         false, // need foldr,
  62         |cx, span, subexpr, self_f, other_fs| {
  63             /*
  64             build up a series of chain ||'s and &&'s from the inside
  65             out (hence foldr) to get lexical ordering, i.e. for op ==
  66             `ast::lt`
  67
  68             ```
  69             self.f1 < other.f1 || (!(other.f1 < self.f1) &&
  70                 (self.f2 < other.f2 || (!(other.f2 < self.f2) &&
  71                     (false)
  72                 ))
  73             )
  74             ```
  75
  76             The optimiser should remove the redundancy. We explicitly
  77             get use the binops to avoid auto-deref derefencing too many
  78             layers of pointers, if the type includes pointers.
  79             */
  80             let other_f = match other_fs {
  81                 [o_f] => o_f,
  82                 _ => cx.span_bug(span, "not exactly 2 arguments in `deriving(Ord)`")
  83             };
  84
  85             let cmp = cx.expr_binary(span, op, self_f, other_f);
  86
  87             let not_cmp = cx.expr_unary(span, ast::UnNot,
  88                                         cx.expr_binary(span, op, other_f, self_f));
  89
  90             let and = cx.expr_binary(span, ast::BiAnd, not_cmp, subexpr);
  91             cx.expr_binary(span, ast::BiOr, cmp, and)
  92         },
  93         cx.expr_bool(span, equal),
  94         |cx, span, args, _| {
  95             // nonmatching enums, order by the order the variants are
  96             // written
  97             match args {
  98                 [(self_var, _, _),
  99                  (other_var, _, _)] =>
 100                     cx.expr_bool(span,
 101                                  if less {
 102                                      self_var < other_var
 103                                  } else {
 104                                      self_var > other_var
 105                                  }),
 106                 _ => cx.span_bug(span, "not exactly 2 arguments in `deriving(Ord)`")
 107             }
 108         },
 109         cx, span, substr)
 110 }