rust/src/methods.rs

use syntax::ast::*;
use rustc::lint::*;
use rustc::middle::ty;

use utils::{span_lint, match_def_path, walk_ptrs_ty};

#[derive(Copy,Clone)]
pub struct MethodsPass;

declare_lint!(pub OPTION_UNWRAP_USED, Allow,
              "using `Option.unwrap()`, which should at least get a better message using `expect()`");
declare_lint!(pub RESULT_UNWRAP_USED, Allow,
              "using `Result.unwrap()`, which might be better handled");
declare_lint!(pub STR_TO_STRING, Warn,
              "using `to_string()` on a str, which should be `to_owned()`");
declare_lint!(pub STRING_TO_STRING, Warn,
              "calling `String.to_string()` which is a no-op");

#[allow(unused_imports)]
impl LintPass for MethodsPass {
    fn get_lints(&self) -> LintArray {
        lint_array!(OPTION_UNWRAP_USED, RESULT_UNWRAP_USED, STR_TO_STRING, STRING_TO_STRING)
    }

    fn check_expr(&mut self, cx: &Context, expr: &Expr) {
        {
            // In case stuff gets moved around
            use core::option::Option;
            use core::result::Result;
            use collections::string::String;
        }
        if let ExprMethodCall(ref ident, _, ref args) = expr.node {
            let ref obj_ty = walk_ptrs_ty(cx.tcx.expr_ty(&*args[0])).sty;
            if ident.node.name == "unwrap" {
                if let ty::TyEnum(did, _) = *obj_ty {
                    if match_def_path(cx, did.did, &["core", "option", "Option"]) {
                        span_lint(cx, OPTION_UNWRAP_USED, expr.span,
                                  "used unwrap() on an Option value. If you don't want \
                                   to handle the None case gracefully, consider using
                                   expect() to provide a better panic message");
                    }
                    else if match_def_path(cx, did.did, &["core", "result", "Result"]) {
                        span_lint(cx, RESULT_UNWRAP_USED, expr.span,
                                  "used unwrap() on a Result value. Graceful handling \
                                   of Err values is preferred");
                    }
                }
            }
            else if ident.node.name == "to_string" {
                if let ty::TyStr = *obj_ty {
                    span_lint(cx, STR_TO_STRING, expr.span, "`str.to_owned()` is faster");
                }
                else if let ty::TyStruct(did, _) = *obj_ty {
                    if match_def_path(cx, did.did, &["collections", "string", "String"]) {
                        span_lint(cx, STRING_TO_STRING, expr.span,
                                  "`String.to_string()` is a no-op")
                    }
                }
            }
        }
    }
}