clippy_lints/src/consts.rs

   1 #![allow(cast_possible_truncation)]
   2
   3 use rustc::lint::LateContext;
   4 use rustc::hir::def::Def;
   5 use rustc_const_eval::lookup_const_by_id;
   6 use rustc_const_math::ConstInt;
   7 use rustc::hir::*;
   8 use rustc::ty::{self, Ty, TyCtxt};
   9 use rustc::ty::subst::{Subst, Substs};
  10 use std::cmp::Ordering::{self, Equal};
  11 use std::cmp::PartialOrd;
  12 use std::hash::{Hash, Hasher};
  13 use std::mem;
  14 use std::rc::Rc;
  15 use syntax::ast::{FloatTy, LitKind, StrStyle};
  16 use syntax::ptr::P;
  17 use utils::const_to_u64;
  18
  19 #[derive(Debug, Copy, Clone)]
  20 pub enum FloatWidth {
  21     F32,
  22     F64,
  23     Any,
  24 }
  25
  26 impl From<FloatTy> for FloatWidth {
  27     fn from(ty: FloatTy) -> Self {
  28         match ty {
  29             FloatTy::F32 => FloatWidth::F32,
  30             FloatTy::F64 => FloatWidth::F64,
  31         }
  32     }
  33 }
  34
  35 /// A `LitKind`-like enum to fold constant `Expr`s into.
  36 #[derive(Debug, Clone)]
  37 pub enum Constant {
  38     /// a String "abc"
  39     Str(String, StrStyle),
  40     /// a Binary String b"abc"
  41     Binary(Rc<Vec<u8>>),
  42     /// a single char 'a'
  43     Char(char),
  44     /// an integer, third argument is whether the value is negated
  45     Int(ConstInt),
  46     /// a float with given type
  47     Float(String, FloatWidth),
  48     /// true or false
  49     Bool(bool),
  50     /// an array of constants
  51     Vec(Vec<Constant>),
  52     /// also an array, but with only one constant, repeated N times
  53     Repeat(Box<Constant>, u64),
  54     /// a tuple of constants
  55     Tuple(Vec<Constant>),
  56 }
  57
  58 impl PartialEq for Constant {
  59     fn eq(&self, other: &Self) -> bool {
  60         match (self, other) {
  61             (&Constant::Str(ref ls, ref l_sty), &Constant::Str(ref rs, ref r_sty)) => ls == rs && l_sty == r_sty,
  62             (&Constant::Binary(ref l), &Constant::Binary(ref r)) => l == r,
  63             (&Constant::Char(l), &Constant::Char(r)) => l == r,
  64             (&Constant::Int(l), &Constant::Int(r)) => {
  65                 l.is_negative() == r.is_negative() && l.to_u128_unchecked() == r.to_u128_unchecked()
  66             },
  67             (&Constant::Float(ref ls, _), &Constant::Float(ref rs, _)) => {
  68                 // we want `Fw32 == FwAny` and `FwAny == Fw64`, by transitivity we must have
  69                 // `Fw32 == Fw64` so don’t compare them
  70                 match (ls.parse::<f64>(), rs.parse::<f64>()) {
  71                     // mem::transmute is required to catch non-matching 0.0, -0.0, and NaNs
  72                     (Ok(l), Ok(r)) => unsafe { mem::transmute::<f64, u64>(l) == mem::transmute::<f64, u64>(r) },
  73                     _ => false,
  74                 }
  75             },
  76             (&Constant::Bool(l), &Constant::Bool(r)) => l == r,
  77             (&Constant::Vec(ref l), &Constant::Vec(ref r)) | (&Constant::Tuple(ref l), &Constant::Tuple(ref r)) => l == r,
  78             (&Constant::Repeat(ref lv, ref ls), &Constant::Repeat(ref rv, ref rs)) => ls == rs && lv == rv,
  79             _ => false, // TODO: Are there inter-type equalities?
  80         }
  81     }
  82 }
  83
  84 impl Hash for Constant {
  85     fn hash<H>(&self, state: &mut H)
  86     where
  87         H: Hasher,
  88     {
  89         match *self {
  90             Constant::Str(ref s, ref k) => {
  91                 s.hash(state);
  92                 k.hash(state);
  93             },
  94             Constant::Binary(ref b) => {
  95                 b.hash(state);
  96             },
  97             Constant::Char(c) => {
  98                 c.hash(state);
  99             },
 100             Constant::Int(i) => {
 101                 i.to_u128_unchecked().hash(state);
 102                 i.is_negative().hash(state);
 103             },
 104             Constant::Float(ref f, _) => {
 105                 // don’t use the width here because of PartialEq implementation
 106                 if let Ok(f) = f.parse::<f64>() {
 107                     unsafe { mem::transmute::<f64, u64>(f) }.hash(state);
 108                 }
 109             },
 110             Constant::Bool(b) => {
 111                 b.hash(state);
 112             },
 113             Constant::Vec(ref v) | Constant::Tuple(ref v) => {
 114                 v.hash(state);
 115             },
 116             Constant::Repeat(ref c, l) => {
 117                 c.hash(state);
 118                 l.hash(state);
 119             },
 120         }
 121     }
 122 }
 123
 124 impl PartialOrd for Constant {
 125     fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
 126         match (self, other) {
 127             (&Constant::Str(ref ls, ref l_sty), &Constant::Str(ref rs, ref r_sty)) => if l_sty == r_sty {
 128                 Some(ls.cmp(rs))
 129             } else {
 130                 None
 131             },
 132             (&Constant::Char(ref l), &Constant::Char(ref r)) => Some(l.cmp(r)),
 133             (&Constant::Int(l), &Constant::Int(r)) => Some(l.cmp(&r)),
 134             (&Constant::Float(ref ls, _), &Constant::Float(ref rs, _)) => {
 135                 match (ls.parse::<f64>(), rs.parse::<f64>()) {
 136                     (Ok(ref l), Ok(ref r)) => {
 137                         match (l.partial_cmp(r), l.is_sign_positive() == r.is_sign_positive()) {
 138                             // Check for comparison of -0.0 and 0.0
 139                             (Some(Ordering::Equal), false) => None,
 140                             (x, _) => x,
 141                         }
 142                     },
 143                     _ => None,
 144                 }
 145             },
 146             (&Constant::Bool(ref l), &Constant::Bool(ref r)) => Some(l.cmp(r)),
 147             (&Constant::Tuple(ref l), &Constant::Tuple(ref r)) | (&Constant::Vec(ref l), &Constant::Vec(ref r)) => {
 148                 l.partial_cmp(r)
 149             },
 150             (&Constant::Repeat(ref lv, ref ls), &Constant::Repeat(ref rv, ref rs)) => match lv.partial_cmp(rv) {
 151                 Some(Equal) => Some(ls.cmp(rs)),
 152                 x => x,
 153             },
 154             _ => None, // TODO: Are there any useful inter-type orderings?
 155         }
 156     }
 157 }
 158
 159 /// parse a `LitKind` to a `Constant`
 160 #[allow(cast_possible_wrap)]
 161 pub fn lit_to_constant<'a, 'tcx>(lit: &LitKind, tcx: TyCtxt<'a, 'tcx, 'tcx>, mut ty: Ty<'tcx>) -> Constant {
 162     use syntax::ast::*;
 163     use syntax::ast::LitIntType::*;
 164     use rustc::ty::util::IntTypeExt;
 165
 166     if let ty::TyAdt(adt, _) = ty.sty {
 167         if adt.is_enum() {
 168             ty = adt.repr.discr_type().to_ty(tcx)
 169         }
 170     }
 171     match *lit {
 172         LitKind::Str(ref is, style) => Constant::Str(is.to_string(), style),
 173         LitKind::Byte(b) => Constant::Int(ConstInt::U8(b)),
 174         LitKind::ByteStr(ref s) => Constant::Binary(Rc::clone(s)),
 175         LitKind::Char(c) => Constant::Char(c),
 176         LitKind::Int(n, hint) => match (&ty.sty, hint) {
 177             (&ty::TyInt(ity), _) | (_, Signed(ity)) => {
 178                 Constant::Int(ConstInt::new_signed_truncating(n as i128, ity, tcx.sess.target.isize_ty))
 179             },
 180             (&ty::TyUint(uty), _) | (_, Unsigned(uty)) => {
 181                 Constant::Int(ConstInt::new_unsigned_truncating(n as u128, uty, tcx.sess.target.usize_ty))
 182             },
 183             _ => bug!(),
 184         },
 185         LitKind::Float(ref is, ty) => Constant::Float(is.to_string(), ty.into()),
 186         LitKind::FloatUnsuffixed(ref is) => Constant::Float(is.to_string(), FloatWidth::Any),
 187         LitKind::Bool(b) => Constant::Bool(b),
 188     }
 189 }
 190
 191 fn constant_not(o: &Constant) -> Option<Constant> {
 192     use self::Constant::*;
 193     match *o {
 194         Bool(b) => Some(Bool(!b)),
 195         Int(value) => (!value).ok().map(Int),
 196         _ => None,
 197     }
 198 }
 199
 200 fn constant_negate(o: Constant) -> Option<Constant> {
 201     use self::Constant::*;
 202     match o {
 203         Int(value) => (-value).ok().map(Int),
 204         Float(is, ty) => Some(Float(neg_float_str(&is), ty)),
 205         _ => None,
 206     }
 207 }
 208
 209 fn neg_float_str(s: &str) -> String {
 210     if s.starts_with('-') {
 211         s[1..].to_owned()
 212     } else {
 213         format!("-{}", s)
 214     }
 215 }
 216
 217 pub fn constant(lcx: &LateContext, e: &Expr) -> Option<(Constant, bool)> {
 218     let mut cx = ConstEvalLateContext {
 219         tcx: lcx.tcx,
 220         tables: lcx.tables,
 221         param_env: lcx.param_env,
 222         needed_resolution: false,
 223         substs: lcx.tcx.intern_substs(&[]),
 224     };
 225     cx.expr(e).map(|cst| (cst, cx.needed_resolution))
 226 }
 227
 228 pub fn constant_simple(lcx: &LateContext, e: &Expr) -> Option<Constant> {
 229     constant(lcx, e).and_then(|(cst, res)| if res { None } else { Some(cst) })
 230 }
 231
 232 struct ConstEvalLateContext<'a, 'tcx: 'a> {
 233     tcx: TyCtxt<'a, 'tcx, 'tcx>,
 234     tables: &'a ty::TypeckTables<'tcx>,
 235     param_env: ty::ParamEnv<'tcx>,
 236     needed_resolution: bool,
 237     substs: &'tcx Substs<'tcx>,
 238 }
 239
 240 impl<'c, 'cc> ConstEvalLateContext<'c, 'cc> {
 241     /// simple constant folding: Insert an expression, get a constant or none.
 242     fn expr(&mut self, e: &Expr) -> Option<Constant> {
 243         match e.node {
 244             ExprPath(ref qpath) => self.fetch_path(qpath, e.hir_id),
 245             ExprBlock(ref block) => self.block(block),
 246             ExprIf(ref cond, ref then, ref otherwise) => self.ifthenelse(cond, then, otherwise),
 247             ExprLit(ref lit) => Some(lit_to_constant(&lit.node, self.tcx, self.tables.expr_ty(e))),
 248             ExprArray(ref vec) => self.multi(vec).map(Constant::Vec),
 249             ExprTup(ref tup) => self.multi(tup).map(Constant::Tuple),
 250             ExprRepeat(ref value, _) => {
 251                 let n = match self.tables.expr_ty(e).sty {
 252                     ty::TyArray(_, n) => const_to_u64(n),
 253                     _ => span_bug!(e.span, "typeck error"),
 254                 };
 255                 self.expr(value).map(|v| Constant::Repeat(Box::new(v), n))
 256             },
 257             ExprUnary(op, ref operand) => self.expr(operand).and_then(|o| match op {
 258                 UnNot => constant_not(&o),
 259                 UnNeg => constant_negate(o),
 260                 UnDeref => Some(o),
 261             }),
 262             ExprBinary(op, ref left, ref right) => self.binop(op, left, right),
 263             // TODO: add other expressions
 264             _ => None,
 265         }
 266     }
 267
 268     /// create `Some(Vec![..])` of all constants, unless there is any
 269     /// non-constant part
 270     fn multi(&mut self, vec: &[Expr]) -> Option<Vec<Constant>> {
 271         vec.iter()
 272             .map(|elem| self.expr(elem))
 273             .collect::<Option<_>>()
 274     }
 275
 276     /// lookup a possibly constant expression from a ExprPath
 277     fn fetch_path(&mut self, qpath: &QPath, id: HirId) -> Option<Constant> {
 278         let def = self.tables.qpath_def(qpath, id);
 279         match def {
 280             Def::Const(def_id) | Def::AssociatedConst(def_id) => {
 281                 let substs = self.tables.node_substs(id);
 282                 let substs = if self.substs.is_empty() {
 283                     substs
 284                 } else {
 285                     substs.subst(self.tcx, self.substs)
 286                 };
 287                 let param_env = self.param_env.and((def_id, substs));
 288                 if let Some((def_id, substs)) = lookup_const_by_id(self.tcx, param_env) {
 289                     let mut cx = Self {
 290                         tcx: self.tcx,
 291                         tables: self.tcx.typeck_tables_of(def_id),
 292                         needed_resolution: false,
 293                         substs: substs,
 294                         param_env: param_env.param_env,
 295                     };
 296                     let body = if let Some(id) = self.tcx.hir.as_local_node_id(def_id) {
 297                         self.tcx.mir_const_qualif(def_id);
 298                         self.tcx.hir.body(self.tcx.hir.body_owned_by(id))
 299                     } else {
 300                         self.tcx.extern_const_body(def_id).body
 301                     };
 302                     let ret = cx.expr(&body.value);
 303                     if ret.is_some() {
 304                         self.needed_resolution = true;
 305                     }
 306                     return ret;
 307                 }
 308             },
 309             _ => {},
 310         }
 311         None
 312     }
 313
 314     /// A block can only yield a constant if it only has one constant expression
 315     fn block(&mut self, block: &Block) -> Option<Constant> {
 316         if block.stmts.is_empty() {
 317             block.expr.as_ref().and_then(|b| self.expr(b))
 318         } else {
 319             None
 320         }
 321     }
 322
 323     fn ifthenelse(&mut self, cond: &Expr, then: &P<Expr>, otherwise: &Option<P<Expr>>) -> Option<Constant> {
 324         if let Some(Constant::Bool(b)) = self.expr(cond) {
 325             if b {
 326                 self.expr(&**then)
 327             } else {
 328                 otherwise.as_ref().and_then(|expr| self.expr(expr))
 329             }
 330         } else {
 331             None
 332         }
 333     }
 334
 335     fn binop(&mut self, op: BinOp, left: &Expr, right: &Expr) -> Option<Constant> {
 336         let l = if let Some(l) = self.expr(left) {
 337             l
 338         } else {
 339             return None;
 340         };
 341         let r = self.expr(right);
 342         match (op.node, l, r) {
 343             (BiAdd, Constant::Int(l), Some(Constant::Int(r))) => (l + r).ok().map(Constant::Int),
 344             (BiSub, Constant::Int(l), Some(Constant::Int(r))) => (l - r).ok().map(Constant::Int),
 345             (BiMul, Constant::Int(l), Some(Constant::Int(r))) => (l * r).ok().map(Constant::Int),
 346             (BiDiv, Constant::Int(l), Some(Constant::Int(r))) => (l / r).ok().map(Constant::Int),
 347             (BiRem, Constant::Int(l), Some(Constant::Int(r))) => (l % r).ok().map(Constant::Int),
 348             (BiAnd, Constant::Bool(false), _) => Some(Constant::Bool(false)),
 349             (BiOr, Constant::Bool(true), _) => Some(Constant::Bool(true)),
 350             (BiAnd, Constant::Bool(true), Some(r)) | (BiOr, Constant::Bool(false), Some(r)) => Some(r),
 351             (BiBitXor, Constant::Bool(l), Some(Constant::Bool(r))) => Some(Constant::Bool(l ^ r)),
 352             (BiBitXor, Constant::Int(l), Some(Constant::Int(r))) => (l ^ r).ok().map(Constant::Int),
 353             (BiBitAnd, Constant::Bool(l), Some(Constant::Bool(r))) => Some(Constant::Bool(l & r)),
 354             (BiBitAnd, Constant::Int(l), Some(Constant::Int(r))) => (l & r).ok().map(Constant::Int),
 355             (BiBitOr, Constant::Bool(l), Some(Constant::Bool(r))) => Some(Constant::Bool(l | r)),
 356             (BiBitOr, Constant::Int(l), Some(Constant::Int(r))) => (l | r).ok().map(Constant::Int),
 357             (BiShl, Constant::Int(l), Some(Constant::Int(r))) => (l << r).ok().map(Constant::Int),
 358             (BiShr, Constant::Int(l), Some(Constant::Int(r))) => (l >> r).ok().map(Constant::Int),
 359             (BiEq, Constant::Int(l), Some(Constant::Int(r))) => Some(Constant::Bool(l == r)),
 360             (BiNe, Constant::Int(l), Some(Constant::Int(r))) => Some(Constant::Bool(l != r)),
 361             (BiLt, Constant::Int(l), Some(Constant::Int(r))) => Some(Constant::Bool(l < r)),
 362             (BiLe, Constant::Int(l), Some(Constant::Int(r))) => Some(Constant::Bool(l <= r)),
 363             (BiGe, Constant::Int(l), Some(Constant::Int(r))) => Some(Constant::Bool(l >= r)),
 364             (BiGt, Constant::Int(l), Some(Constant::Int(r))) => Some(Constant::Bool(l > r)),
 365             _ => None,
 366         }
 367     }
 368 }