use clippy_utils::diagnostics::span_lint_and_then; use clippy_utils::fn_def_id; use rustc_hir::{def::Res, def_id::DefIdMap, Crate, Expr}; use rustc_lint::{LateContext, LateLintPass}; use rustc_session::{declare_tool_lint, impl_lint_pass}; use crate::utils::conf; declare_clippy_lint! { /// ### What it does /// Denies the configured methods and functions in clippy.toml /// /// ### Why is this bad? /// Some methods are undesirable in certain contexts, and it's beneficial to /// lint for them as needed. /// /// ### Example /// An example clippy.toml configuration: /// ```toml /// # clippy.toml /// disallowed-methods = [ /// # Can use a string as the path of the disallowed method. /// "std::boxed::Box::new", /// # Can also use an inline table with a `path` key. /// { path = "std::time::Instant::now" }, /// # When using an inline table, can add a `reason` for why the method /// # is disallowed. /// { path = "std::vec::Vec::leak", reason = "no leaking memory" }, /// ] /// ``` /// /// ```rust,ignore /// // Example code where clippy issues a warning /// let xs = vec![1, 2, 3, 4]; /// xs.leak(); // Vec::leak is disallowed in the config. /// // The diagnostic contains the message "no leaking memory". /// /// let _now = Instant::now(); // Instant::now is disallowed in the config. /// /// let _box = Box::new(3); // Box::new is disallowed in the config. /// ``` /// /// Use instead: /// ```rust,ignore /// // Example code which does not raise clippy warning /// let mut xs = Vec::new(); // Vec::new is _not_ disallowed in the config. /// xs.push(123); // Vec::push is _not_ disallowed in the config. /// ``` pub DISALLOWED_METHOD, nursery, "use of a disallowed method call" } #[derive(Clone, Debug)] pub struct DisallowedMethod { conf_disallowed: Vec, disallowed: DefIdMap>, } impl DisallowedMethod { pub fn new(conf_disallowed: Vec) -> Self { Self { conf_disallowed, disallowed: DefIdMap::default(), } } } impl_lint_pass!(DisallowedMethod => [DISALLOWED_METHOD]); impl<'tcx> LateLintPass<'tcx> for DisallowedMethod { fn check_crate(&mut self, cx: &LateContext<'_>, _: &Crate<'_>) { for conf in &self.conf_disallowed { let (path, reason) = match conf { conf::DisallowedMethod::Simple(path) => (path, None), conf::DisallowedMethod::WithReason { path, reason } => ( path, reason.as_ref().map(|reason| format!("{} (from clippy.toml)", reason)), ), }; let segs: Vec<_> = path.split("::").collect(); if let Res::Def(_, id) = clippy_utils::path_to_res(cx, &segs) { self.disallowed.insert(id, reason); } } } fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) { let def_id = match fn_def_id(cx, expr) { Some(def_id) => def_id, None => return, }; let reason = match self.disallowed.get(&def_id) { Some(reason) => reason, None => return, }; let func_path = cx.tcx.def_path_str(def_id); let msg = format!("use of a disallowed method `{}`", func_path); span_lint_and_then(cx, DISALLOWED_METHOD, expr.span, &msg, |diag| { if let Some(reason) = reason { diag.note(reason); } }); } }