clippy_lints/src/consts.rs

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