2018-05-30 08:15:50 +00:00
|
|
|
|
use crate::reexport::*;
|
2018-12-29 15:04:45 +00:00
|
|
|
|
use if_chain::if_chain;
|
|
|
|
|
use matches::matches;
|
|
|
|
|
use rustc::hir;
|
|
|
|
|
use rustc::hir::def::Def;
|
2019-01-23 06:32:58 +00:00
|
|
|
|
use rustc::hir::def_id::{DefId, CRATE_DEF_INDEX, LOCAL_CRATE};
|
2018-12-29 15:04:45 +00:00
|
|
|
|
use rustc::hir::intravisit::{NestedVisitorMap, Visitor};
|
|
|
|
|
use rustc::hir::Node;
|
|
|
|
|
use rustc::hir::*;
|
|
|
|
|
use rustc::lint::{LateContext, Level, Lint, LintContext};
|
|
|
|
|
use rustc::session::Session;
|
|
|
|
|
use rustc::traits;
|
|
|
|
|
use rustc::ty::{
|
2018-11-20 09:33:40 +00:00
|
|
|
|
self,
|
|
|
|
|
layout::{self, IntegerExt},
|
|
|
|
|
subst::Kind,
|
|
|
|
|
Binder, Ty, TyCtxt,
|
|
|
|
|
};
|
2019-01-03 17:17:43 +00:00
|
|
|
|
use rustc_data_structures::sync::Lrc;
|
2018-12-29 15:04:45 +00:00
|
|
|
|
use rustc_errors::{Applicability, CodeSuggestion, Substitution, SubstitutionPart};
|
2018-11-20 09:33:40 +00:00
|
|
|
|
use std::borrow::Cow;
|
|
|
|
|
use std::env;
|
|
|
|
|
use std::mem;
|
|
|
|
|
use std::str::FromStr;
|
2018-12-29 15:04:45 +00:00
|
|
|
|
use syntax::ast::{self, LitKind};
|
|
|
|
|
use syntax::attr;
|
|
|
|
|
use syntax::errors::DiagnosticBuilder;
|
|
|
|
|
use syntax::source_map::{Span, DUMMY_SP};
|
|
|
|
|
use syntax::symbol;
|
|
|
|
|
use syntax::symbol::{keywords, Symbol};
|
2015-11-18 11:35:18 +00:00
|
|
|
|
|
2018-10-11 22:36:40 +00:00
|
|
|
|
pub mod camel_case;
|
2018-08-29 02:32:20 +00:00
|
|
|
|
|
2018-11-20 09:33:40 +00:00
|
|
|
|
pub mod author;
|
2016-03-26 05:57:03 +00:00
|
|
|
|
pub mod comparisons;
|
2016-03-06 14:17:51 +00:00
|
|
|
|
pub mod conf;
|
2016-08-27 23:52:01 +00:00
|
|
|
|
pub mod constants;
|
2017-06-11 02:57:25 +00:00
|
|
|
|
mod hir_utils;
|
2016-10-18 14:57:39 +00:00
|
|
|
|
pub mod inspector;
|
2016-07-18 09:19:33 +00:00
|
|
|
|
pub mod internal_lints;
|
2018-11-20 09:33:40 +00:00
|
|
|
|
pub mod paths;
|
2017-10-08 08:51:44 +00:00
|
|
|
|
pub mod ptr;
|
2018-11-20 09:33:40 +00:00
|
|
|
|
pub mod sugg;
|
2018-05-27 22:02:38 +00:00
|
|
|
|
pub mod usage;
|
2017-06-11 02:57:25 +00:00
|
|
|
|
pub use self::hir_utils::{SpanlessEq, SpanlessHash};
|
2015-12-27 22:15:09 +00:00
|
|
|
|
|
2016-06-29 22:08:43 +00:00
|
|
|
|
pub mod higher;
|
|
|
|
|
|
2017-08-09 07:30:56 +00:00
|
|
|
|
/// Returns true if the two spans come from differing expansions (i.e. one is
|
|
|
|
|
/// from a macro and one
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// isn't).
|
2016-03-01 09:13:54 +00:00
|
|
|
|
pub fn differing_macro_contexts(lhs: Span, rhs: Span) -> bool {
|
2017-08-31 12:47:45 +00:00
|
|
|
|
rhs.ctxt() != lhs.ctxt()
|
2016-01-02 16:11:48 +00:00
|
|
|
|
}
|
2017-03-07 11:58:07 +00:00
|
|
|
|
|
2018-12-31 11:12:50 +00:00
|
|
|
|
/// Returns `true` if the given `NodeId` is inside a constant context
|
|
|
|
|
///
|
|
|
|
|
/// # Example
|
|
|
|
|
///
|
|
|
|
|
/// ```rust,ignore
|
|
|
|
|
/// if in_constant(cx, expr.id) {
|
|
|
|
|
/// // Do something
|
|
|
|
|
/// }
|
|
|
|
|
/// ```
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn in_constant(cx: &LateContext<'_, '_>, id: NodeId) -> bool {
|
2018-12-08 00:56:03 +00:00
|
|
|
|
let parent_id = cx.tcx.hir().get_parent(id);
|
2019-01-22 14:28:51 +00:00
|
|
|
|
match cx.tcx.hir().get(parent_id) {
|
2019-01-22 15:27:42 +00:00
|
|
|
|
Node::Item(&Item {
|
|
|
|
|
node: ItemKind::Const(..),
|
|
|
|
|
..
|
|
|
|
|
})
|
|
|
|
|
| Node::TraitItem(&TraitItem {
|
|
|
|
|
node: TraitItemKind::Const(..),
|
|
|
|
|
..
|
|
|
|
|
})
|
|
|
|
|
| Node::ImplItem(&ImplItem {
|
|
|
|
|
node: ImplItemKind::Const(..),
|
|
|
|
|
..
|
|
|
|
|
})
|
2019-01-22 14:28:51 +00:00
|
|
|
|
| Node::AnonConst(_)
|
2019-01-22 15:27:42 +00:00
|
|
|
|
| Node::Item(&Item {
|
|
|
|
|
node: ItemKind::Static(..),
|
|
|
|
|
..
|
|
|
|
|
}) => true,
|
2019-01-26 08:49:55 +00:00
|
|
|
|
Node::Item(&Item {
|
|
|
|
|
node: ItemKind::Fn(_, header, ..),
|
|
|
|
|
..
|
|
|
|
|
}) => header.constness == Constness::Const,
|
2019-01-22 14:28:51 +00:00
|
|
|
|
_ => false,
|
2017-03-07 11:58:07 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// Returns true if this `expn_info` was expanded by any macro.
|
2017-03-31 22:14:04 +00:00
|
|
|
|
pub fn in_macro(span: Span) -> bool {
|
2018-08-02 20:00:14 +00:00
|
|
|
|
span.ctxt().outer().expn_info().is_some()
|
2018-03-05 08:30:07 +00:00
|
|
|
|
}
|
|
|
|
|
|
2018-12-08 10:57:25 +00:00
|
|
|
|
/// Used to store the absolute path to a type.
|
|
|
|
|
///
|
|
|
|
|
/// See `match_def_path` for usage.
|
|
|
|
|
#[derive(Debug)]
|
|
|
|
|
pub struct AbsolutePathBuffer {
|
|
|
|
|
pub names: Vec<symbol::LocalInternedString>,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl ty::item_path::ItemPathBuffer for AbsolutePathBuffer {
|
|
|
|
|
fn root_mode(&self) -> &ty::item_path::RootMode {
|
|
|
|
|
const ABSOLUTE: &ty::item_path::RootMode = &ty::item_path::RootMode::Absolute;
|
|
|
|
|
ABSOLUTE
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
fn push(&mut self, text: &str) {
|
|
|
|
|
self.names.push(symbol::Symbol::intern(text).as_str());
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// Check if a `DefId`'s path matches the given absolute type path usage.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
2016-12-21 09:00:13 +00:00
|
|
|
|
/// ```rust,ignore
|
2017-01-13 16:04:56 +00:00
|
|
|
|
/// match_def_path(cx.tcx, id, &["core", "option", "Option"])
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// ```
|
2016-04-26 11:31:52 +00:00
|
|
|
|
///
|
|
|
|
|
/// See also the `paths` module.
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn match_def_path(tcx: TyCtxt<'_, '_, '_>, def_id: DefId, path: &[&str]) -> bool {
|
2016-06-05 23:42:39 +00:00
|
|
|
|
let mut apb = AbsolutePathBuffer { names: vec![] };
|
2016-04-26 11:31:52 +00:00
|
|
|
|
|
2018-10-03 09:02:50 +00:00
|
|
|
|
tcx.push_item_path(&mut apb, def_id, false);
|
2016-04-26 11:31:52 +00:00
|
|
|
|
|
2018-11-20 09:33:40 +00:00
|
|
|
|
apb.names.len() == path.len() && apb.names.into_iter().zip(path.iter()).all(|(a, &b)| *a == *b)
|
2015-06-07 10:05:14 +00:00
|
|
|
|
}
|
|
|
|
|
|
2019-01-31 04:20:49 +00:00
|
|
|
|
pub fn get_def_path(tcx: TyCtxt<'_, '_, '_>, def_id: DefId) -> Vec<&'static str> {
|
|
|
|
|
let mut apb = AbsolutePathBuffer { names: vec![] };
|
|
|
|
|
tcx.push_item_path(&mut apb, def_id, false);
|
|
|
|
|
apb.names.iter().map(|n| n.get()).collect()
|
|
|
|
|
}
|
|
|
|
|
|
2016-09-09 18:24:20 +00:00
|
|
|
|
/// Check if type is struct, enum or union type with given def path.
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn match_type(cx: &LateContext<'_, '_>, ty: Ty<'_>, path: &[&str]) -> bool {
|
2015-08-21 17:00:33 +00:00
|
|
|
|
match ty.sty {
|
2018-08-22 21:34:52 +00:00
|
|
|
|
ty::Adt(adt, _) => match_def_path(cx.tcx, adt.did, path),
|
2016-01-04 04:26:12 +00:00
|
|
|
|
_ => false,
|
2015-08-21 17:00:33 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// Check if the method call given in `expr` belongs to given trait.
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn match_trait_method(cx: &LateContext<'_, '_>, expr: &Expr, path: &[&str]) -> bool {
|
2017-08-15 09:10:49 +00:00
|
|
|
|
let method_call = cx.tables.type_dependent_defs()[expr.hir_id];
|
2017-06-02 04:13:04 +00:00
|
|
|
|
let trt_id = cx.tcx.trait_of_item(method_call.def_id());
|
2015-08-23 14:32:50 +00:00
|
|
|
|
if let Some(trt_id) = trt_id {
|
2017-01-13 16:04:56 +00:00
|
|
|
|
match_def_path(cx.tcx, trt_id, path)
|
2015-08-23 14:32:50 +00:00
|
|
|
|
} else {
|
|
|
|
|
false
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-09-16 07:10:26 +00:00
|
|
|
|
/// Check if an expression references a variable of the given name.
|
|
|
|
|
pub fn match_var(expr: &Expr, var: Name) -> bool {
|
2018-07-12 07:30:57 +00:00
|
|
|
|
if let ExprKind::Path(QPath::Resolved(None, ref path)) = expr.node {
|
2018-06-28 13:46:58 +00:00
|
|
|
|
if path.segments.len() == 1 && path.segments[0].ident.name == var {
|
2017-09-16 07:10:26 +00:00
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
false
|
|
|
|
|
}
|
|
|
|
|
|
2016-12-02 16:38:31 +00:00
|
|
|
|
pub fn last_path_segment(path: &QPath) -> &PathSegment {
|
|
|
|
|
match *path {
|
2018-11-20 09:33:40 +00:00
|
|
|
|
QPath::Resolved(_, ref path) => path.segments.last().expect("A path must have at least one segment"),
|
2016-12-02 21:33:16 +00:00
|
|
|
|
QPath::TypeRelative(_, ref seg) => seg,
|
2016-12-02 16:38:31 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
pub fn single_segment_path(path: &QPath) -> Option<&PathSegment> {
|
|
|
|
|
match *path {
|
|
|
|
|
QPath::Resolved(_, ref path) if path.segments.len() == 1 => Some(&path.segments[0]),
|
|
|
|
|
QPath::Resolved(..) => None,
|
2016-12-02 21:33:16 +00:00
|
|
|
|
QPath::TypeRelative(_, ref seg) => Some(seg),
|
2016-12-02 16:38:31 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// Match a `Path` against a slice of segment string literals.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
2016-12-21 09:00:13 +00:00
|
|
|
|
/// ```rust,ignore
|
2017-08-24 22:21:46 +00:00
|
|
|
|
/// match_qpath(path, &["std", "rt", "begin_unwind"])
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// ```
|
2017-08-24 22:21:46 +00:00
|
|
|
|
pub fn match_qpath(path: &QPath, segments: &[&str]) -> bool {
|
2016-12-02 16:38:31 +00:00
|
|
|
|
match *path {
|
2017-08-24 22:21:46 +00:00
|
|
|
|
QPath::Resolved(_, ref path) => match_path(path, segments),
|
2017-09-05 09:33:04 +00:00
|
|
|
|
QPath::TypeRelative(ref ty, ref segment) => match ty.node {
|
2018-07-12 08:03:06 +00:00
|
|
|
|
TyKind::Path(ref inner_path) => {
|
2018-11-20 09:33:40 +00:00
|
|
|
|
!segments.is_empty()
|
|
|
|
|
&& match_qpath(inner_path, &segments[..(segments.len() - 1)])
|
2018-06-28 13:46:58 +00:00
|
|
|
|
&& segment.ident.name == segments[segments.len() - 1]
|
2017-09-05 09:33:04 +00:00
|
|
|
|
},
|
|
|
|
|
_ => false,
|
2016-12-02 16:38:31 +00:00
|
|
|
|
},
|
2016-12-01 21:31:56 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-08-24 22:21:46 +00:00
|
|
|
|
pub fn match_path(path: &Path, segments: &[&str]) -> bool {
|
2017-09-05 09:33:04 +00:00
|
|
|
|
path.segments
|
|
|
|
|
.iter()
|
|
|
|
|
.rev()
|
|
|
|
|
.zip(segments.iter().rev())
|
2018-06-28 13:46:58 +00:00
|
|
|
|
.all(|(a, b)| a.ident.name == *b)
|
2015-06-07 10:05:14 +00:00
|
|
|
|
}
|
2015-07-09 15:02:21 +00:00
|
|
|
|
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// Match a `Path` against a slice of segment string literals, e.g.
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
2016-12-21 09:00:13 +00:00
|
|
|
|
/// ```rust,ignore
|
2017-08-24 22:21:46 +00:00
|
|
|
|
/// match_qpath(path, &["std", "rt", "begin_unwind"])
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// ```
|
2015-10-11 21:12:21 +00:00
|
|
|
|
pub fn match_path_ast(path: &ast::Path, segments: &[&str]) -> bool {
|
2017-09-05 09:33:04 +00:00
|
|
|
|
path.segments
|
|
|
|
|
.iter()
|
|
|
|
|
.rev()
|
|
|
|
|
.zip(segments.iter().rev())
|
2018-04-07 05:22:23 +00:00
|
|
|
|
.all(|(a, b)| a.ident.name == *b)
|
2015-10-11 21:12:21 +00:00
|
|
|
|
}
|
|
|
|
|
|
2016-01-18 12:10:13 +00:00
|
|
|
|
/// Get the definition associated to a path.
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn path_to_def(cx: &LateContext<'_, '_>, path: &[&str]) -> Option<def::Def> {
|
2017-09-09 05:23:08 +00:00
|
|
|
|
let crates = cx.tcx.crates();
|
2018-11-20 09:33:40 +00:00
|
|
|
|
let krate = crates.iter().find(|&&krate| cx.tcx.crate_name(krate) == path[0]);
|
2016-01-18 12:10:13 +00:00
|
|
|
|
if let Some(krate) = krate {
|
2016-12-20 17:21:30 +00:00
|
|
|
|
let krate = DefId {
|
|
|
|
|
krate: *krate,
|
|
|
|
|
index: CRATE_DEF_INDEX,
|
|
|
|
|
};
|
2017-09-09 05:23:08 +00:00
|
|
|
|
let mut items = cx.tcx.item_children(krate);
|
2016-01-18 12:10:13 +00:00
|
|
|
|
let mut path_it = path.iter().skip(1).peekable();
|
|
|
|
|
|
|
|
|
|
loop {
|
|
|
|
|
let segment = match path_it.next() {
|
|
|
|
|
Some(segment) => segment,
|
2016-01-30 12:48:39 +00:00
|
|
|
|
None => return None,
|
2016-01-18 12:10:13 +00:00
|
|
|
|
};
|
|
|
|
|
|
2019-01-03 17:17:43 +00:00
|
|
|
|
for item in mem::replace(&mut items, Lrc::new(vec![])).iter() {
|
2017-05-27 05:25:39 +00:00
|
|
|
|
if item.ident.name == *segment {
|
2016-01-18 12:10:13 +00:00
|
|
|
|
if path_it.peek().is_none() {
|
2016-10-06 15:46:50 +00:00
|
|
|
|
return Some(item.def);
|
2016-01-18 12:10:13 +00:00
|
|
|
|
}
|
|
|
|
|
|
2017-09-09 05:23:08 +00:00
|
|
|
|
items = cx.tcx.item_children(item.def.def_id());
|
2016-01-18 12:10:13 +00:00
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
2016-01-30 12:48:39 +00:00
|
|
|
|
} else {
|
2016-01-18 12:10:13 +00:00
|
|
|
|
None
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Convenience function to get the `DefId` of a trait by path.
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn get_trait_def_id(cx: &LateContext<'_, '_>, path: &[&str]) -> Option<DefId> {
|
2016-01-18 12:10:13 +00:00
|
|
|
|
let def = match path_to_def(cx, path) {
|
|
|
|
|
Some(def) => def,
|
|
|
|
|
None => return None,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
match def {
|
2016-09-22 00:51:12 +00:00
|
|
|
|
def::Def::Trait(trait_id) => Some(trait_id),
|
2016-01-18 12:10:13 +00:00
|
|
|
|
_ => None,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// Check whether a type implements a trait.
|
|
|
|
|
/// See also `get_trait_def_id`.
|
2016-12-21 11:14:54 +00:00
|
|
|
|
pub fn implements_trait<'a, 'tcx>(
|
|
|
|
|
cx: &LateContext<'a, 'tcx>,
|
2017-06-11 02:57:25 +00:00
|
|
|
|
ty: Ty<'tcx>,
|
2016-12-21 11:14:54 +00:00
|
|
|
|
trait_id: DefId,
|
2018-05-22 13:45:14 +00:00
|
|
|
|
ty_params: &[Kind<'tcx>],
|
2016-12-21 11:14:54 +00:00
|
|
|
|
) -> bool {
|
2016-03-18 18:12:32 +00:00
|
|
|
|
let ty = cx.tcx.erase_regions(&ty);
|
2018-11-20 09:33:40 +00:00
|
|
|
|
let obligation = cx.tcx.predicate_for_trait_def(
|
|
|
|
|
cx.param_env,
|
|
|
|
|
traits::ObligationCause::dummy(),
|
|
|
|
|
trait_id,
|
|
|
|
|
0,
|
|
|
|
|
ty,
|
|
|
|
|
ty_params,
|
|
|
|
|
);
|
|
|
|
|
cx.tcx
|
|
|
|
|
.infer_ctxt()
|
2019-01-03 20:54:57 +00:00
|
|
|
|
.enter(|infcx| infcx.predicate_must_hold_modulo_regions(&obligation))
|
2016-01-18 12:10:13 +00:00
|
|
|
|
}
|
|
|
|
|
|
2017-09-19 20:38:35 +00:00
|
|
|
|
/// Check whether this type implements Drop.
|
2018-12-09 11:19:21 +00:00
|
|
|
|
pub fn has_drop<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
|
|
|
|
|
match ty.ty_adt_def() {
|
2017-09-19 20:38:35 +00:00
|
|
|
|
Some(def) => def.has_dtor(cx.tcx),
|
|
|
|
|
_ => false,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-08-15 09:10:49 +00:00
|
|
|
|
/// Resolve the definition of a node from its `HirId`.
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn resolve_node(cx: &LateContext<'_, '_>, qpath: &QPath, id: HirId) -> def::Def {
|
2017-01-13 16:04:56 +00:00
|
|
|
|
cx.tables.qpath_def(qpath, id)
|
2016-10-22 13:57:19 +00:00
|
|
|
|
}
|
|
|
|
|
|
2018-10-31 04:26:29 +00:00
|
|
|
|
/// Return the method names and argument list of nested method call expressions that make up
|
|
|
|
|
/// `expr`.
|
|
|
|
|
pub fn method_calls<'a>(expr: &'a Expr, max_depth: usize) -> (Vec<Symbol>, Vec<&'a [Expr]>) {
|
|
|
|
|
let mut method_names = Vec::with_capacity(max_depth);
|
|
|
|
|
let mut arg_lists = Vec::with_capacity(max_depth);
|
|
|
|
|
|
|
|
|
|
let mut current = expr;
|
|
|
|
|
for _ in 0..max_depth {
|
|
|
|
|
if let ExprKind::MethodCall(path, _, args) = ¤t.node {
|
|
|
|
|
if args.iter().any(|e| in_macro(e.span)) {
|
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
method_names.push(path.ident.name);
|
|
|
|
|
arg_lists.push(&**args);
|
|
|
|
|
current = &args[0];
|
|
|
|
|
} else {
|
|
|
|
|
break;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
(method_names, arg_lists)
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// Match an `Expr` against a chain of methods, and return the matched `Expr`s.
|
|
|
|
|
///
|
|
|
|
|
/// For example, if `expr` represents the `.baz()` in `foo.bar().baz()`,
|
2017-08-09 07:30:56 +00:00
|
|
|
|
/// `matched_method_chain(expr, &["bar", "baz"])` will return a `Vec`
|
|
|
|
|
/// containing the `Expr`s for
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// `.bar()` and `.baz()`
|
2016-11-23 21:44:00 +00:00
|
|
|
|
pub fn method_chain_args<'a>(expr: &'a Expr, methods: &[&str]) -> Option<Vec<&'a [Expr]>> {
|
2015-12-27 22:15:09 +00:00
|
|
|
|
let mut current = expr;
|
|
|
|
|
let mut matched = Vec::with_capacity(methods.len());
|
2016-01-04 04:26:12 +00:00
|
|
|
|
for method_name in methods.iter().rev() {
|
|
|
|
|
// method chains are stored last -> first
|
2018-07-12 07:30:57 +00:00
|
|
|
|
if let ExprKind::MethodCall(ref path, _, ref args) = current.node {
|
2018-06-28 13:46:58 +00:00
|
|
|
|
if path.ident.name == *method_name {
|
2017-04-06 14:48:48 +00:00
|
|
|
|
if args.iter().any(|e| in_macro(e.span)) {
|
|
|
|
|
return None;
|
|
|
|
|
}
|
2016-11-23 21:44:00 +00:00
|
|
|
|
matched.push(&**args); // build up `matched` backwards
|
2015-12-27 22:15:09 +00:00
|
|
|
|
current = &args[0] // go to parent expression
|
2016-01-04 04:26:12 +00:00
|
|
|
|
} else {
|
2015-12-27 22:15:09 +00:00
|
|
|
|
return None;
|
2015-12-27 09:22:53 +00:00
|
|
|
|
}
|
2016-01-04 04:26:12 +00:00
|
|
|
|
} else {
|
2015-12-27 22:15:09 +00:00
|
|
|
|
return None;
|
2015-12-27 09:22:53 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
2015-12-27 22:15:09 +00:00
|
|
|
|
matched.reverse(); // reverse `matched`, so that it is in the same order as `methods`
|
|
|
|
|
Some(matched)
|
2015-12-27 09:22:53 +00:00
|
|
|
|
}
|
|
|
|
|
|
2019-01-22 06:36:15 +00:00
|
|
|
|
/// Returns true if the provided `def_id` is an entrypoint to a program
|
|
|
|
|
pub fn is_entrypoint_fn(cx: &LateContext<'_, '_>, def_id: DefId) -> bool {
|
|
|
|
|
if let Some((entry_fn_def_id, _)) = cx.tcx.entry_fn(LOCAL_CRATE) {
|
2019-01-23 06:32:58 +00:00
|
|
|
|
return def_id == entry_fn_def_id;
|
2019-01-22 06:36:15 +00:00
|
|
|
|
}
|
|
|
|
|
false
|
2019-01-09 19:11:37 +00:00
|
|
|
|
}
|
|
|
|
|
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// Get the name of the item the expression is in, if available.
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn get_item_name(cx: &LateContext<'_, '_>, expr: &Expr) -> Option<Name> {
|
2018-12-08 00:56:03 +00:00
|
|
|
|
let parent_id = cx.tcx.hir().get_parent(expr.id);
|
|
|
|
|
match cx.tcx.hir().find(parent_id) {
|
2018-12-30 00:09:24 +00:00
|
|
|
|
Some(Node::Item(&Item { ref ident, .. })) => Some(ident.name),
|
2018-11-20 09:33:40 +00:00
|
|
|
|
Some(Node::TraitItem(&TraitItem { ident, .. })) | Some(Node::ImplItem(&ImplItem { ident, .. })) => {
|
|
|
|
|
Some(ident.name)
|
|
|
|
|
},
|
2015-09-06 18:57:06 +00:00
|
|
|
|
_ => None,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-09-16 07:10:26 +00:00
|
|
|
|
/// Get the name of a `Pat`, if any
|
|
|
|
|
pub fn get_pat_name(pat: &Pat) -> Option<Name> {
|
|
|
|
|
match pat.node {
|
2018-06-28 13:46:58 +00:00
|
|
|
|
PatKind::Binding(_, _, ref spname, _) => Some(spname.name),
|
|
|
|
|
PatKind::Path(ref qpath) => single_segment_path(qpath).map(|ps| ps.ident.name),
|
2017-09-16 07:10:26 +00:00
|
|
|
|
PatKind::Box(ref p) | PatKind::Ref(ref p, _) => get_pat_name(&*p),
|
|
|
|
|
_ => None,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-08-23 15:54:35 +00:00
|
|
|
|
struct ContainsName {
|
|
|
|
|
name: Name,
|
|
|
|
|
result: bool,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl<'tcx> Visitor<'tcx> for ContainsName {
|
|
|
|
|
fn visit_name(&mut self, _: Span, name: Name) {
|
|
|
|
|
if self.name == name {
|
|
|
|
|
self.result = true;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'tcx> {
|
|
|
|
|
NestedVisitorMap::None
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// check if an `Expr` contains a certain name
|
|
|
|
|
pub fn contains_name(name: Name, expr: &Expr) -> bool {
|
2018-11-20 09:33:40 +00:00
|
|
|
|
let mut cn = ContainsName { name, result: false };
|
2017-08-23 15:54:35 +00:00
|
|
|
|
cn.visit_expr(expr);
|
|
|
|
|
cn.result
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// Convert a span to a code snippet if available, otherwise use default.
|
|
|
|
|
///
|
2018-12-31 11:12:50 +00:00
|
|
|
|
/// This is useful if you want to provide suggestions for your lint or more generally, if you want
|
|
|
|
|
/// to convert a given `Span` to a `str`.
|
|
|
|
|
///
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// # Example
|
2016-12-21 09:00:13 +00:00
|
|
|
|
/// ```rust,ignore
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// snippet(cx, expr.span, "..")
|
|
|
|
|
/// ```
|
2016-12-06 10:32:21 +00:00
|
|
|
|
pub fn snippet<'a, 'b, T: LintContext<'b>>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
|
2017-03-03 15:56:35 +00:00
|
|
|
|
snippet_opt(cx, span).map_or_else(|| Cow::Borrowed(default), From::from)
|
2015-08-11 13:07:21 +00:00
|
|
|
|
}
|
|
|
|
|
|
2018-11-27 14:11:13 +00:00
|
|
|
|
/// Same as `snippet`, but it adapts the applicability level by following rules:
|
|
|
|
|
///
|
|
|
|
|
/// - Applicability level `Unspecified` will never be changed.
|
|
|
|
|
/// - If the span is inside a macro, change the applicability level to `MaybeIncorrect`.
|
|
|
|
|
/// - If the default value is used and the applicability level is `MachineApplicable`, change it to
|
|
|
|
|
/// `HasPlaceholders`
|
2018-11-20 09:33:40 +00:00
|
|
|
|
pub fn snippet_with_applicability<'a, 'b, T: LintContext<'b>>(
|
|
|
|
|
cx: &T,
|
|
|
|
|
span: Span,
|
|
|
|
|
default: &'a str,
|
|
|
|
|
applicability: &mut Applicability,
|
|
|
|
|
) -> Cow<'a, str> {
|
2018-11-27 14:11:13 +00:00
|
|
|
|
if *applicability != Applicability::Unspecified && in_macro(span) {
|
|
|
|
|
*applicability = Applicability::MaybeIncorrect;
|
|
|
|
|
}
|
2018-11-20 09:33:40 +00:00
|
|
|
|
snippet_opt(cx, span).map_or_else(
|
|
|
|
|
|| {
|
|
|
|
|
if *applicability == Applicability::MachineApplicable {
|
2018-11-27 14:11:13 +00:00
|
|
|
|
*applicability = Applicability::HasPlaceholders;
|
2018-11-20 09:33:40 +00:00
|
|
|
|
}
|
|
|
|
|
Cow::Borrowed(default)
|
|
|
|
|
},
|
|
|
|
|
From::from,
|
|
|
|
|
)
|
|
|
|
|
}
|
|
|
|
|
|
2018-10-27 09:01:27 +00:00
|
|
|
|
/// Same as `snippet`, but should only be used when it's clear that the input span is
|
|
|
|
|
/// not a macro argument.
|
|
|
|
|
pub fn snippet_with_macro_callsite<'a, 'b, T: LintContext<'b>>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
|
|
|
|
|
snippet(cx, span.source_callsite(), default)
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// Convert a span to a code snippet. Returns `None` if not available.
|
2016-12-06 10:32:21 +00:00
|
|
|
|
pub fn snippet_opt<'a, T: LintContext<'a>>(cx: &T, span: Span) -> Option<String> {
|
2018-08-20 02:06:53 +00:00
|
|
|
|
cx.sess().source_map().span_to_snippet(span).ok()
|
2015-12-08 06:03:01 +00:00
|
|
|
|
}
|
|
|
|
|
|
2017-08-09 07:30:56 +00:00
|
|
|
|
/// Convert a span (from a block) to a code snippet if available, otherwise use
|
|
|
|
|
/// default.
|
|
|
|
|
/// This trims the code of indentation, except for the first line. Use it for
|
|
|
|
|
/// blocks or block-like
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// things which need to be printed as such.
|
|
|
|
|
///
|
|
|
|
|
/// # Example
|
2016-12-21 09:00:13 +00:00
|
|
|
|
/// ```rust,ignore
|
2018-12-31 11:12:50 +00:00
|
|
|
|
/// snippet_block(cx, expr.span, "..")
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// ```
|
2016-12-06 10:32:21 +00:00
|
|
|
|
pub fn snippet_block<'a, 'b, T: LintContext<'b>>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
|
2015-08-12 11:14:14 +00:00
|
|
|
|
let snip = snippet(cx, span, default);
|
|
|
|
|
trim_multiline(snip, true)
|
|
|
|
|
}
|
|
|
|
|
|
2018-11-27 14:11:13 +00:00
|
|
|
|
/// Same as `snippet_block`, but adapts the applicability level by the rules of
|
|
|
|
|
/// `snippet_with_applicabiliy`.
|
|
|
|
|
pub fn snippet_block_with_applicability<'a, 'b, T: LintContext<'b>>(
|
|
|
|
|
cx: &T,
|
|
|
|
|
span: Span,
|
|
|
|
|
default: &'a str,
|
|
|
|
|
applicability: &mut Applicability,
|
|
|
|
|
) -> Cow<'a, str> {
|
|
|
|
|
let snip = snippet_with_applicability(cx, span, default, applicability);
|
|
|
|
|
trim_multiline(snip, true)
|
|
|
|
|
}
|
|
|
|
|
|
2018-02-06 21:14:23 +00:00
|
|
|
|
/// Returns a new Span that covers the full last line of the given Span
|
|
|
|
|
pub fn last_line_of_span<'a, T: LintContext<'a>>(cx: &T, span: Span) -> Span {
|
2018-11-22 06:53:59 +00:00
|
|
|
|
let source_map_and_line = cx.sess().source_map().lookup_line(span.lo()).unwrap();
|
|
|
|
|
let line_no = source_map_and_line.line;
|
|
|
|
|
let line_start = &source_map_and_line.sf.lines[line_no];
|
2018-02-06 21:14:23 +00:00
|
|
|
|
Span::new(*line_start, span.hi(), span.ctxt())
|
|
|
|
|
}
|
|
|
|
|
|
2018-07-12 07:30:57 +00:00
|
|
|
|
/// Like `snippet_block`, but add braces if the expr is not an `ExprKind::Block`.
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// Also takes an `Option<String>` which can be put inside the braces.
|
2016-12-21 11:14:54 +00:00
|
|
|
|
pub fn expr_block<'a, 'b, T: LintContext<'b>>(
|
|
|
|
|
cx: &T,
|
|
|
|
|
expr: &Expr,
|
|
|
|
|
option: Option<String>,
|
2017-08-09 07:30:56 +00:00
|
|
|
|
default: &'a str,
|
2016-12-21 11:14:54 +00:00
|
|
|
|
) -> Cow<'a, str> {
|
2015-08-29 09:41:06 +00:00
|
|
|
|
let code = snippet_block(cx, expr.span, default);
|
2016-01-12 22:17:54 +00:00
|
|
|
|
let string = option.unwrap_or_default();
|
2018-10-27 12:45:02 +00:00
|
|
|
|
if in_macro(expr.span) {
|
|
|
|
|
Cow::Owned(format!("{{ {} }}", snippet_with_macro_callsite(cx, expr.span, default)))
|
2018-11-20 09:33:40 +00:00
|
|
|
|
} else if let ExprKind::Block(_, _) = expr.node {
|
2015-09-27 07:39:42 +00:00
|
|
|
|
Cow::Owned(format!("{}{}", code, string))
|
|
|
|
|
} else if string.is_empty() {
|
2015-08-29 09:41:06 +00:00
|
|
|
|
Cow::Owned(format!("{{ {} }}", code))
|
2015-09-27 07:39:42 +00:00
|
|
|
|
} else {
|
|
|
|
|
Cow::Owned(format!("{{\n{};\n{}\n}}", code, string))
|
2015-08-29 09:41:06 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-08-09 07:30:56 +00:00
|
|
|
|
/// Trim indentation from a multiline string with possibility of ignoring the
|
|
|
|
|
/// first line.
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn trim_multiline(s: Cow<'_, str>, ignore_first: bool) -> Cow<'_, str> {
|
2015-08-21 15:11:34 +00:00
|
|
|
|
let s_space = trim_multiline_inner(s, ignore_first, ' ');
|
|
|
|
|
let s_tab = trim_multiline_inner(s_space, ignore_first, '\t');
|
|
|
|
|
trim_multiline_inner(s_tab, ignore_first, ' ')
|
2015-08-13 07:57:30 +00:00
|
|
|
|
}
|
|
|
|
|
|
2018-07-23 11:01:12 +00:00
|
|
|
|
fn trim_multiline_inner(s: Cow<'_, str>, ignore_first: bool, ch: char) -> Cow<'_, str> {
|
2018-11-20 09:33:40 +00:00
|
|
|
|
let x = s
|
|
|
|
|
.lines()
|
2016-12-20 17:21:30 +00:00
|
|
|
|
.skip(ignore_first as usize)
|
|
|
|
|
.filter_map(|l| {
|
|
|
|
|
if l.is_empty() {
|
|
|
|
|
None
|
|
|
|
|
} else {
|
|
|
|
|
// ignore empty lines
|
2018-11-20 09:33:40 +00:00
|
|
|
|
Some(l.char_indices().find(|&(_, x)| x != ch).unwrap_or((l.len(), ch)).0)
|
2016-12-20 17:21:30 +00:00
|
|
|
|
}
|
|
|
|
|
})
|
|
|
|
|
.min()
|
|
|
|
|
.unwrap_or(0);
|
2015-08-12 11:14:14 +00:00
|
|
|
|
if x > 0 {
|
2017-08-09 07:30:56 +00:00
|
|
|
|
Cow::Owned(
|
|
|
|
|
s.lines()
|
|
|
|
|
.enumerate()
|
2017-11-04 19:55:56 +00:00
|
|
|
|
.map(|(i, l)| {
|
|
|
|
|
if (ignore_first && i == 0) || l.is_empty() {
|
|
|
|
|
l
|
|
|
|
|
} else {
|
|
|
|
|
l.split_at(x).1
|
|
|
|
|
}
|
2017-08-09 07:30:56 +00:00
|
|
|
|
})
|
|
|
|
|
.collect::<Vec<_>>()
|
|
|
|
|
.join("\n"),
|
|
|
|
|
)
|
2015-08-12 11:14:14 +00:00
|
|
|
|
} else {
|
|
|
|
|
s
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// Get a parent expressions if any – this is useful to constrain a lint.
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn get_parent_expr<'c>(cx: &'c LateContext<'_, '_>, e: &Expr) -> Option<&'c Expr> {
|
2018-12-08 00:56:03 +00:00
|
|
|
|
let map = &cx.tcx.hir();
|
2016-01-04 04:26:12 +00:00
|
|
|
|
let node_id: NodeId = e.id;
|
|
|
|
|
let parent_id: NodeId = map.get_parent_node(node_id);
|
|
|
|
|
if node_id == parent_id {
|
|
|
|
|
return None;
|
|
|
|
|
}
|
2017-11-04 19:55:56 +00:00
|
|
|
|
map.find(parent_id).and_then(|node| {
|
2018-08-28 11:13:42 +00:00
|
|
|
|
if let Node::Expr(parent) = node {
|
2017-08-09 07:30:56 +00:00
|
|
|
|
Some(parent)
|
|
|
|
|
} else {
|
|
|
|
|
None
|
2017-11-04 19:55:56 +00:00
|
|
|
|
}
|
|
|
|
|
})
|
2015-07-09 15:02:21 +00:00
|
|
|
|
}
|
2015-07-16 06:53:02 +00:00
|
|
|
|
|
2016-12-06 10:32:21 +00:00
|
|
|
|
pub fn get_enclosing_block<'a, 'tcx: 'a>(cx: &LateContext<'a, 'tcx>, node: NodeId) -> Option<&'tcx Block> {
|
2018-12-08 00:56:03 +00:00
|
|
|
|
let map = &cx.tcx.hir();
|
2018-11-20 09:33:40 +00:00
|
|
|
|
let enclosing_node = map
|
|
|
|
|
.get_enclosing_scope(node)
|
2017-09-05 09:33:04 +00:00
|
|
|
|
.and_then(|enclosing_id| map.find(enclosing_id));
|
2015-10-26 22:49:37 +00:00
|
|
|
|
if let Some(node) = enclosing_node {
|
|
|
|
|
match node {
|
2018-08-28 11:13:42 +00:00
|
|
|
|
Node::Block(block) => Some(block),
|
|
|
|
|
Node::Item(&Item {
|
2018-07-16 13:07:39 +00:00
|
|
|
|
node: ItemKind::Fn(_, _, _, eid),
|
2017-09-05 09:33:04 +00:00
|
|
|
|
..
|
2018-11-20 09:33:40 +00:00
|
|
|
|
})
|
|
|
|
|
| Node::ImplItem(&ImplItem {
|
2018-01-30 19:52:45 +00:00
|
|
|
|
node: ImplItemKind::Method(_, eid),
|
|
|
|
|
..
|
2018-12-08 00:56:03 +00:00
|
|
|
|
}) => match cx.tcx.hir().body(eid).value.node {
|
2018-07-12 07:30:57 +00:00
|
|
|
|
ExprKind::Block(ref block, _) => Some(block),
|
2017-09-05 09:33:04 +00:00
|
|
|
|
_ => None,
|
2016-12-20 17:21:30 +00:00
|
|
|
|
},
|
2016-01-04 04:26:12 +00:00
|
|
|
|
_ => None,
|
2015-10-26 22:49:37 +00:00
|
|
|
|
}
|
2016-01-04 04:26:12 +00:00
|
|
|
|
} else {
|
|
|
|
|
None
|
|
|
|
|
}
|
2015-10-26 22:49:37 +00:00
|
|
|
|
}
|
|
|
|
|
|
2015-12-31 20:39:03 +00:00
|
|
|
|
pub struct DiagnosticWrapper<'a>(pub DiagnosticBuilder<'a>);
|
|
|
|
|
|
|
|
|
|
impl<'a> Drop for DiagnosticWrapper<'a> {
|
|
|
|
|
fn drop(&mut self) {
|
|
|
|
|
self.0.emit();
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-05-04 06:54:59 +00:00
|
|
|
|
impl<'a> DiagnosticWrapper<'a> {
|
2017-09-01 08:29:49 +00:00
|
|
|
|
fn docs_link(&mut self, lint: &'static Lint) {
|
|
|
|
|
if env::var("CLIPPY_DISABLE_DOCS_LINKS").is_err() {
|
2017-08-09 07:30:56 +00:00
|
|
|
|
self.0.help(&format!(
|
2018-11-22 09:22:25 +00:00
|
|
|
|
"for further information visit https://rust-lang.github.io/rust-clippy/{}/index.html#{}",
|
2018-11-21 12:33:42 +00:00
|
|
|
|
&option_env!("RUST_RELEASE_NUM").map_or("master".to_string(), |n| {
|
|
|
|
|
// extract just major + minor version and ignore patch versions
|
|
|
|
|
format!("rust-{}", n.rsplitn(2, '.').nth(1).unwrap())
|
|
|
|
|
}),
|
2018-09-05 22:45:57 +00:00
|
|
|
|
lint.name_lower().replacen("clippy::", "", 1)
|
2017-08-09 07:30:56 +00:00
|
|
|
|
));
|
2016-06-05 19:05:28 +00:00
|
|
|
|
}
|
2016-05-04 06:54:59 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-12-06 10:32:21 +00:00
|
|
|
|
pub fn span_lint<'a, T: LintContext<'a>>(cx: &T, lint: &'static Lint, sp: Span, msg: &str) {
|
2017-09-01 08:29:49 +00:00
|
|
|
|
DiagnosticWrapper(cx.struct_span_lint(lint, sp, msg)).docs_link(lint);
|
2015-08-11 13:07:21 +00:00
|
|
|
|
}
|
|
|
|
|
|
2016-12-21 11:14:54 +00:00
|
|
|
|
pub fn span_help_and_lint<'a, 'tcx: 'a, T: LintContext<'tcx>>(
|
|
|
|
|
cx: &'a T,
|
|
|
|
|
lint: &'static Lint,
|
|
|
|
|
span: Span,
|
|
|
|
|
msg: &str,
|
2017-08-09 07:30:56 +00:00
|
|
|
|
help: &str,
|
2016-12-21 11:14:54 +00:00
|
|
|
|
) {
|
2016-05-04 06:54:59 +00:00
|
|
|
|
let mut db = DiagnosticWrapper(cx.struct_span_lint(lint, span, msg));
|
2017-08-11 12:11:46 +00:00
|
|
|
|
db.0.help(help);
|
2017-09-01 08:29:49 +00:00
|
|
|
|
db.docs_link(lint);
|
2015-07-26 14:53:11 +00:00
|
|
|
|
}
|
2015-08-11 18:57:21 +00:00
|
|
|
|
|
2016-12-21 11:14:54 +00:00
|
|
|
|
pub fn span_note_and_lint<'a, 'tcx: 'a, T: LintContext<'tcx>>(
|
|
|
|
|
cx: &'a T,
|
|
|
|
|
lint: &'static Lint,
|
|
|
|
|
span: Span,
|
|
|
|
|
msg: &str,
|
|
|
|
|
note_span: Span,
|
2017-08-09 07:30:56 +00:00
|
|
|
|
note: &str,
|
2016-12-21 11:14:54 +00:00
|
|
|
|
) {
|
2016-05-04 06:54:59 +00:00
|
|
|
|
let mut db = DiagnosticWrapper(cx.struct_span_lint(lint, span, msg));
|
2017-08-11 12:11:46 +00:00
|
|
|
|
if note_span == span {
|
|
|
|
|
db.0.note(note);
|
|
|
|
|
} else {
|
|
|
|
|
db.0.span_note(note_span, note);
|
2015-09-02 06:19:47 +00:00
|
|
|
|
}
|
2017-09-01 08:29:49 +00:00
|
|
|
|
db.docs_link(lint);
|
2015-09-02 06:19:47 +00:00
|
|
|
|
}
|
|
|
|
|
|
2016-12-21 11:14:54 +00:00
|
|
|
|
pub fn span_lint_and_then<'a, 'tcx: 'a, T: LintContext<'tcx>, F>(
|
|
|
|
|
cx: &'a T,
|
|
|
|
|
lint: &'static Lint,
|
|
|
|
|
sp: Span,
|
|
|
|
|
msg: &str,
|
2017-08-09 07:30:56 +00:00
|
|
|
|
f: F,
|
|
|
|
|
) where
|
|
|
|
|
F: for<'b> FnOnce(&mut DiagnosticBuilder<'b>),
|
2016-01-04 04:26:12 +00:00
|
|
|
|
{
|
2015-12-31 20:39:03 +00:00
|
|
|
|
let mut db = DiagnosticWrapper(cx.struct_span_lint(lint, sp, msg));
|
2017-08-11 12:11:46 +00:00
|
|
|
|
f(&mut db.0);
|
2017-09-01 08:29:49 +00:00
|
|
|
|
db.docs_link(lint);
|
2015-12-08 16:28:35 +00:00
|
|
|
|
}
|
|
|
|
|
|
2018-10-25 12:08:32 +00:00
|
|
|
|
pub fn span_lint_node(cx: &LateContext<'_, '_>, lint: &'static Lint, node: NodeId, sp: Span, msg: &str) {
|
|
|
|
|
DiagnosticWrapper(cx.tcx.struct_span_lint_node(lint, node, sp, msg)).docs_link(lint);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
pub fn span_lint_node_and_then(
|
|
|
|
|
cx: &LateContext<'_, '_>,
|
|
|
|
|
lint: &'static Lint,
|
|
|
|
|
node: NodeId,
|
|
|
|
|
sp: Span,
|
|
|
|
|
msg: &str,
|
|
|
|
|
f: impl FnOnce(&mut DiagnosticBuilder<'_>),
|
|
|
|
|
) {
|
|
|
|
|
let mut db = DiagnosticWrapper(cx.tcx.struct_span_lint_node(lint, node, sp, msg));
|
|
|
|
|
f(&mut db.0);
|
|
|
|
|
db.docs_link(lint);
|
|
|
|
|
}
|
|
|
|
|
|
2018-01-14 18:18:09 +00:00
|
|
|
|
/// Add a span lint with a suggestion on how to fix it.
|
|
|
|
|
///
|
|
|
|
|
/// These suggestions can be parsed by rustfix to allow it to automatically fix your code.
|
2018-11-20 09:33:40 +00:00
|
|
|
|
/// In the example below, `help` is `"try"` and `sugg` is the suggested replacement `".any(|x| x >
|
|
|
|
|
/// 2)"`.
|
2018-01-14 18:18:09 +00:00
|
|
|
|
///
|
2018-06-25 19:22:53 +00:00
|
|
|
|
/// ```ignore
|
2018-01-14 18:18:09 +00:00
|
|
|
|
/// error: This `.fold` can be more succinctly expressed as `.any`
|
|
|
|
|
/// --> $DIR/methods.rs:390:13
|
|
|
|
|
/// |
|
|
|
|
|
/// 390 | let _ = (0..3).fold(false, |acc, x| acc || x > 2);
|
2018-01-16 21:20:55 +00:00
|
|
|
|
/// | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ help: try: `.any(|x| x > 2)`
|
2018-01-14 18:18:09 +00:00
|
|
|
|
/// |
|
|
|
|
|
/// = note: `-D fold-any` implied by `-D warnings`
|
2018-01-17 21:06:16 +00:00
|
|
|
|
/// ```
|
2017-01-30 11:43:27 +00:00
|
|
|
|
pub fn span_lint_and_sugg<'a, 'tcx: 'a, T: LintContext<'tcx>>(
|
|
|
|
|
cx: &'a T,
|
|
|
|
|
lint: &'static Lint,
|
|
|
|
|
sp: Span,
|
|
|
|
|
msg: &str,
|
|
|
|
|
help: &str,
|
2017-08-09 07:30:56 +00:00
|
|
|
|
sugg: String,
|
2018-11-20 13:06:29 +00:00
|
|
|
|
applicability: Applicability,
|
2017-01-30 11:43:27 +00:00
|
|
|
|
) {
|
2017-11-04 19:55:56 +00:00
|
|
|
|
span_lint_and_then(cx, lint, sp, msg, |db| {
|
2019-01-27 12:33:56 +00:00
|
|
|
|
db.span_suggestion(sp, help, sugg, applicability);
|
2017-11-04 19:55:56 +00:00
|
|
|
|
});
|
2017-01-30 11:43:27 +00:00
|
|
|
|
}
|
|
|
|
|
|
2016-07-01 16:38:50 +00:00
|
|
|
|
/// Create a suggestion made from several `span → replacement`.
|
|
|
|
|
///
|
2017-08-09 07:30:56 +00:00
|
|
|
|
/// Note: in the JSON format (used by `compiletest_rs`), the help message will
|
|
|
|
|
/// appear once per
|
|
|
|
|
/// replacement. In human-readable format though, it only appears once before
|
|
|
|
|
/// the whole suggestion.
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn multispan_sugg<I>(db: &mut DiagnosticBuilder<'_>, help_msg: String, sugg: I)
|
2017-10-11 03:10:10 +00:00
|
|
|
|
where
|
2017-11-04 19:55:56 +00:00
|
|
|
|
I: IntoIterator<Item = (Span, String)>,
|
2017-10-11 03:10:10 +00:00
|
|
|
|
{
|
2018-05-01 16:10:25 +00:00
|
|
|
|
let sugg = CodeSuggestion {
|
2018-11-20 09:33:40 +00:00
|
|
|
|
substitutions: vec![Substitution {
|
|
|
|
|
parts: sugg
|
|
|
|
|
.into_iter()
|
|
|
|
|
.map(|(span, snippet)| SubstitutionPart { snippet, span })
|
|
|
|
|
.collect(),
|
|
|
|
|
}],
|
2017-05-02 14:56:36 +00:00
|
|
|
|
msg: help_msg,
|
2017-07-24 13:37:12 +00:00
|
|
|
|
show_code_when_inline: true,
|
2018-05-01 16:10:25 +00:00
|
|
|
|
applicability: Applicability::Unspecified,
|
2016-07-01 16:38:50 +00:00
|
|
|
|
};
|
2017-05-14 07:56:10 +00:00
|
|
|
|
db.suggestions.push(sugg);
|
2016-07-01 16:38:50 +00:00
|
|
|
|
}
|
|
|
|
|
|
2017-09-10 17:32:24 +00:00
|
|
|
|
/// Return the base type for HIR references and pointers.
|
|
|
|
|
pub fn walk_ptrs_hir_ty(ty: &hir::Ty) -> &hir::Ty {
|
|
|
|
|
match ty.node {
|
2018-07-12 08:03:06 +00:00
|
|
|
|
TyKind::Ptr(ref mut_ty) | TyKind::Rptr(_, ref mut_ty) => walk_ptrs_hir_ty(&mut_ty.ty),
|
2017-11-04 19:55:56 +00:00
|
|
|
|
_ => ty,
|
2017-09-10 17:32:24 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-12 22:17:54 +00:00
|
|
|
|
/// Return the base type for references and raw pointers.
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn walk_ptrs_ty(ty: Ty<'_>) -> Ty<'_> {
|
2015-08-11 18:57:21 +00:00
|
|
|
|
match ty.sty {
|
2018-08-22 21:34:52 +00:00
|
|
|
|
ty::Ref(_, ty, _) => walk_ptrs_ty(ty),
|
2016-01-04 04:26:12 +00:00
|
|
|
|
_ => ty,
|
2015-08-11 18:57:21 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
2015-08-12 05:48:00 +00:00
|
|
|
|
|
2017-08-09 07:30:56 +00:00
|
|
|
|
/// Return the base type for references and raw pointers, and count reference
|
|
|
|
|
/// depth.
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn walk_ptrs_ty_depth(ty: Ty<'_>) -> (Ty<'_>, usize) {
|
|
|
|
|
fn inner(ty: Ty<'_>, depth: usize) -> (Ty<'_>, usize) {
|
2015-08-25 16:38:08 +00:00
|
|
|
|
match ty.sty {
|
2018-08-22 21:34:52 +00:00
|
|
|
|
ty::Ref(_, ty, _) => inner(ty, depth + 1),
|
2016-01-04 04:26:12 +00:00
|
|
|
|
_ => (ty, depth),
|
2015-08-25 16:38:08 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
inner(ty, 0)
|
|
|
|
|
}
|
|
|
|
|
|
2016-01-14 19:58:32 +00:00
|
|
|
|
/// Check whether the given expression is a constant literal of the given value.
|
2017-01-04 17:05:33 +00:00
|
|
|
|
pub fn is_integer_literal(expr: &Expr, value: u128) -> bool {
|
2015-09-04 13:26:58 +00:00
|
|
|
|
// FIXME: use constant folding
|
2018-07-12 07:30:57 +00:00
|
|
|
|
if let ExprKind::Lit(ref spanned) = expr.node {
|
2016-02-12 17:35:44 +00:00
|
|
|
|
if let LitKind::Int(v, _) = spanned.node {
|
2015-09-04 13:26:58 +00:00
|
|
|
|
return v == value;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
false
|
|
|
|
|
}
|
|
|
|
|
|
2018-12-31 11:12:50 +00:00
|
|
|
|
/// Returns `true` if the given `Expr` has been coerced before.
|
|
|
|
|
///
|
|
|
|
|
/// Examples of coercions can be found in the Nomicon at
|
|
|
|
|
/// <https://doc.rust-lang.org/nomicon/coercions.html>.
|
|
|
|
|
///
|
|
|
|
|
/// See `rustc::ty::adjustment::Adjustment` and `rustc_typeck::check::coercion` for more
|
|
|
|
|
/// information on adjustments and coercions.
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn is_adjusted(cx: &LateContext<'_, '_>, e: &Expr) -> bool {
|
2017-08-15 09:10:49 +00:00
|
|
|
|
cx.tables.adjustments().get(e.hir_id).is_some()
|
2015-11-04 03:11:40 +00:00
|
|
|
|
}
|
|
|
|
|
|
2015-11-18 11:35:18 +00:00
|
|
|
|
pub struct LimitStack {
|
|
|
|
|
stack: Vec<u64>,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl Drop for LimitStack {
|
|
|
|
|
fn drop(&mut self) {
|
|
|
|
|
assert_eq!(self.stack.len(), 1);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
impl LimitStack {
|
2017-08-21 11:32:12 +00:00
|
|
|
|
pub fn new(limit: u64) -> Self {
|
|
|
|
|
Self { stack: vec![limit] }
|
2015-11-18 11:35:18 +00:00
|
|
|
|
}
|
|
|
|
|
pub fn limit(&self) -> u64 {
|
2018-11-20 09:33:40 +00:00
|
|
|
|
*self.stack.last().expect("there should always be a value in the stack")
|
2015-11-18 11:35:18 +00:00
|
|
|
|
}
|
|
|
|
|
pub fn push_attrs(&mut self, sess: &Session, attrs: &[ast::Attribute], name: &'static str) {
|
|
|
|
|
let stack = &mut self.stack;
|
2016-01-04 04:26:12 +00:00
|
|
|
|
parse_attrs(sess, attrs, name, |val| stack.push(val));
|
2015-11-18 11:35:18 +00:00
|
|
|
|
}
|
|
|
|
|
pub fn pop_attrs(&mut self, sess: &Session, attrs: &[ast::Attribute], name: &'static str) {
|
|
|
|
|
let stack = &mut self.stack;
|
2016-01-04 04:26:12 +00:00
|
|
|
|
parse_attrs(sess, attrs, name, |val| assert_eq!(stack.pop(), Some(val)));
|
2015-11-18 11:35:18 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-05-19 12:04:57 +00:00
|
|
|
|
pub fn get_attr<'a>(attrs: &'a [ast::Attribute], name: &'static str) -> impl Iterator<Item = &'a ast::Attribute> {
|
2018-11-20 09:33:40 +00:00
|
|
|
|
attrs.iter().filter(move |attr| {
|
|
|
|
|
attr.path.segments.len() == 2
|
|
|
|
|
&& attr.path.segments[0].ident.to_string() == "clippy"
|
|
|
|
|
&& attr.path.segments[1].ident.to_string() == name
|
|
|
|
|
})
|
2018-05-19 12:04:57 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
fn parse_attrs<F: FnMut(u64)>(sess: &Session, attrs: &[ast::Attribute], name: &'static str, mut f: F) {
|
|
|
|
|
for attr in get_attr(attrs, name) {
|
2017-03-20 22:51:14 +00:00
|
|
|
|
if let Some(ref value) = attr.value_str() {
|
2018-05-19 12:04:57 +00:00
|
|
|
|
if let Ok(value) = FromStr::from_str(&value.as_str()) {
|
|
|
|
|
f(value)
|
|
|
|
|
} else {
|
|
|
|
|
sess.span_err(attr.span, "not a number");
|
2015-11-18 11:35:18 +00:00
|
|
|
|
}
|
2018-05-19 12:04:57 +00:00
|
|
|
|
} else {
|
|
|
|
|
sess.span_err(attr.span, "bad clippy attribute");
|
2015-11-18 11:35:18 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
2016-01-03 14:49:25 +00:00
|
|
|
|
|
2017-08-09 07:30:56 +00:00
|
|
|
|
/// Return the pre-expansion span if is this comes from an expansion of the
|
|
|
|
|
/// macro `name`.
|
2016-03-15 20:02:08 +00:00
|
|
|
|
/// See also `is_direct_expn_of`.
|
2017-03-31 22:14:04 +00:00
|
|
|
|
pub fn is_expn_of(mut span: Span, name: &str) -> Option<Span> {
|
2016-01-28 18:29:59 +00:00
|
|
|
|
loop {
|
2018-11-20 09:33:40 +00:00
|
|
|
|
let span_name_span = span
|
|
|
|
|
.ctxt()
|
2017-09-05 09:33:04 +00:00
|
|
|
|
.outer()
|
|
|
|
|
.expn_info()
|
2018-06-25 09:53:00 +00:00
|
|
|
|
.map(|ei| (ei.format.name(), ei.call_site));
|
2016-01-30 12:48:39 +00:00
|
|
|
|
|
2016-02-01 10:28:39 +00:00
|
|
|
|
match span_name_span {
|
2016-11-23 20:19:03 +00:00
|
|
|
|
Some((mac_name, new_span)) if mac_name == name => return Some(new_span),
|
2016-02-01 10:28:39 +00:00
|
|
|
|
None => return None,
|
|
|
|
|
Some((_, new_span)) => span = new_span,
|
|
|
|
|
}
|
2016-01-28 18:29:59 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
2016-02-15 15:59:56 +00:00
|
|
|
|
|
2017-08-09 07:30:56 +00:00
|
|
|
|
/// Return the pre-expansion span if is this directly comes from an expansion
|
|
|
|
|
/// of the macro `name`.
|
2016-03-15 20:02:08 +00:00
|
|
|
|
/// The difference with `is_expn_of` is that in
|
|
|
|
|
/// ```rust,ignore
|
|
|
|
|
/// foo!(bar!(42));
|
|
|
|
|
/// ```
|
2017-08-09 07:30:56 +00:00
|
|
|
|
/// `42` is considered expanded from `foo!` and `bar!` by `is_expn_of` but only
|
|
|
|
|
/// `bar!` by
|
2016-03-15 20:02:08 +00:00
|
|
|
|
/// `is_direct_expn_of`.
|
2017-03-31 22:14:04 +00:00
|
|
|
|
pub fn is_direct_expn_of(span: Span, name: &str) -> Option<Span> {
|
2018-11-20 09:33:40 +00:00
|
|
|
|
let span_name_span = span
|
|
|
|
|
.ctxt()
|
2017-09-05 09:33:04 +00:00
|
|
|
|
.outer()
|
|
|
|
|
.expn_info()
|
2018-06-25 09:53:00 +00:00
|
|
|
|
.map(|ei| (ei.format.name(), ei.call_site));
|
2016-03-15 20:02:08 +00:00
|
|
|
|
|
|
|
|
|
match span_name_span {
|
2016-11-23 20:19:03 +00:00
|
|
|
|
Some((mac_name, new_span)) if mac_name == name => Some(new_span),
|
2016-03-15 20:02:08 +00:00
|
|
|
|
_ => None,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2016-08-17 15:58:15 +00:00
|
|
|
|
/// Convenience function to get the return type of a function
|
2017-06-11 02:57:25 +00:00
|
|
|
|
pub fn return_ty<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, fn_item: NodeId) -> Ty<'tcx> {
|
2018-12-08 00:56:03 +00:00
|
|
|
|
let fn_def_id = cx.tcx.hir().local_def_id(fn_item);
|
2017-06-29 13:38:25 +00:00
|
|
|
|
let ret_ty = cx.tcx.fn_sig(fn_def_id).output();
|
2017-05-14 07:56:10 +00:00
|
|
|
|
cx.tcx.erase_late_bound_regions(&ret_ty)
|
2016-03-01 15:25:15 +00:00
|
|
|
|
}
|
2016-03-03 18:46:10 +00:00
|
|
|
|
|
|
|
|
|
/// Check if two types are the same.
|
2018-05-18 20:56:25 +00:00
|
|
|
|
///
|
|
|
|
|
/// This discards any lifetime annotations, too.
|
2017-08-09 07:30:56 +00:00
|
|
|
|
// FIXME: this works correctly for lifetimes bounds (`for <'a> Foo<'a>` == `for
|
|
|
|
|
// <'b> Foo<'b>` but
|
2016-03-03 18:46:10 +00:00
|
|
|
|
// not for type parameters.
|
2017-06-11 04:46:26 +00:00
|
|
|
|
pub fn same_tys<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, a: Ty<'tcx>, b: Ty<'tcx>) -> bool {
|
2018-05-18 20:56:25 +00:00
|
|
|
|
let a = cx.tcx.erase_late_bound_regions(&Binder::bind(a));
|
|
|
|
|
let b = cx.tcx.erase_late_bound_regions(&Binder::bind(b));
|
2017-09-05 09:33:04 +00:00
|
|
|
|
cx.tcx
|
|
|
|
|
.infer_ctxt()
|
|
|
|
|
.enter(|infcx| infcx.can_eq(cx.param_env, a, b).is_ok())
|
2016-03-03 18:46:10 +00:00
|
|
|
|
}
|
2016-03-28 21:32:55 +00:00
|
|
|
|
|
2016-06-07 14:55:55 +00:00
|
|
|
|
/// Return whether the given type is an `unsafe` function.
|
2017-06-29 13:38:25 +00:00
|
|
|
|
pub fn type_is_unsafe_function<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
|
2016-06-07 14:55:55 +00:00
|
|
|
|
match ty.sty {
|
2018-08-22 21:34:52 +00:00
|
|
|
|
ty::FnDef(..) | ty::FnPtr(_) => ty.fn_sig(cx.tcx).unsafety() == Unsafety::Unsafe,
|
2016-06-07 14:55:55 +00:00
|
|
|
|
_ => false,
|
|
|
|
|
}
|
|
|
|
|
}
|
2016-07-14 17:31:17 +00:00
|
|
|
|
|
2017-06-11 02:57:25 +00:00
|
|
|
|
pub fn is_copy<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, ty: Ty<'tcx>) -> bool {
|
2019-01-03 20:54:57 +00:00
|
|
|
|
ty.is_copy_modulo_regions(cx.tcx.global_tcx(), cx.param_env, DUMMY_SP)
|
2016-07-14 17:31:17 +00:00
|
|
|
|
}
|
2016-09-16 13:45:44 +00:00
|
|
|
|
|
|
|
|
|
/// Return whether a pattern is refutable.
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn is_refutable(cx: &LateContext<'_, '_>, pat: &Pat) -> bool {
|
|
|
|
|
fn is_enum_variant(cx: &LateContext<'_, '_>, qpath: &QPath, id: HirId) -> bool {
|
2017-08-09 07:30:56 +00:00
|
|
|
|
matches!(
|
2017-08-15 09:10:49 +00:00
|
|
|
|
cx.tables.qpath_def(qpath, id),
|
2017-08-09 07:30:56 +00:00
|
|
|
|
def::Def::Variant(..) | def::Def::VariantCtor(..)
|
|
|
|
|
)
|
2016-09-16 13:45:44 +00:00
|
|
|
|
}
|
|
|
|
|
|
2018-07-23 11:01:12 +00:00
|
|
|
|
fn are_refutable<'a, I: Iterator<Item = &'a Pat>>(cx: &LateContext<'_, '_>, mut i: I) -> bool {
|
2016-09-16 13:45:44 +00:00
|
|
|
|
i.any(|pat| is_refutable(cx, pat))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
match pat.node {
|
2017-09-05 09:33:04 +00:00
|
|
|
|
PatKind::Binding(..) | PatKind::Wild => false,
|
|
|
|
|
PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => is_refutable(cx, pat),
|
|
|
|
|
PatKind::Lit(..) | PatKind::Range(..) => true,
|
2017-08-15 09:10:49 +00:00
|
|
|
|
PatKind::Path(ref qpath) => is_enum_variant(cx, qpath, pat.hir_id),
|
2016-09-16 13:45:44 +00:00
|
|
|
|
PatKind::Tuple(ref pats, _) => are_refutable(cx, pats.iter().map(|pat| &**pat)),
|
2018-11-20 09:33:40 +00:00
|
|
|
|
PatKind::Struct(ref qpath, ref fields, _) => {
|
|
|
|
|
if is_enum_variant(cx, qpath, pat.hir_id) {
|
|
|
|
|
true
|
|
|
|
|
} else {
|
|
|
|
|
are_refutable(cx, fields.iter().map(|field| &*field.node.pat))
|
|
|
|
|
}
|
2016-12-20 17:21:30 +00:00
|
|
|
|
},
|
2018-11-20 09:33:40 +00:00
|
|
|
|
PatKind::TupleStruct(ref qpath, ref pats, _) => {
|
|
|
|
|
if is_enum_variant(cx, qpath, pat.hir_id) {
|
|
|
|
|
true
|
|
|
|
|
} else {
|
|
|
|
|
are_refutable(cx, pats.iter().map(|pat| &**pat))
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
PatKind::Slice(ref head, ref middle, ref tail) => {
|
|
|
|
|
are_refutable(cx, head.iter().chain(middle).chain(tail.iter()).map(|pat| &**pat))
|
2016-12-20 17:21:30 +00:00
|
|
|
|
},
|
2016-09-16 13:45:44 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
2016-10-30 01:13:41 +00:00
|
|
|
|
|
2017-08-09 07:30:56 +00:00
|
|
|
|
/// Checks for the `#[automatically_derived]` attribute all `#[derive]`d
|
|
|
|
|
/// implementations have.
|
2016-10-30 01:13:41 +00:00
|
|
|
|
pub fn is_automatically_derived(attrs: &[ast::Attribute]) -> bool {
|
|
|
|
|
attr::contains_name(attrs, "automatically_derived")
|
|
|
|
|
}
|
2016-11-17 18:44:18 +00:00
|
|
|
|
|
|
|
|
|
/// Remove blocks around an expression.
|
|
|
|
|
///
|
2017-08-09 07:30:56 +00:00
|
|
|
|
/// Ie. `x`, `{ x }` and `{{{{ x }}}}` all give `x`. `{ x; y }` and `{}` return
|
|
|
|
|
/// themselves.
|
2016-11-17 18:44:18 +00:00
|
|
|
|
pub fn remove_blocks(expr: &Expr) -> &Expr {
|
2018-07-12 07:30:57 +00:00
|
|
|
|
if let ExprKind::Block(ref block, _) = expr.node {
|
2016-11-17 18:44:18 +00:00
|
|
|
|
if block.stmts.is_empty() {
|
|
|
|
|
if let Some(ref expr) = block.expr {
|
|
|
|
|
remove_blocks(expr)
|
|
|
|
|
} else {
|
|
|
|
|
expr
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
expr
|
|
|
|
|
}
|
|
|
|
|
} else {
|
|
|
|
|
expr
|
|
|
|
|
}
|
|
|
|
|
}
|
2016-12-01 21:31:56 +00:00
|
|
|
|
|
|
|
|
|
pub fn opt_def_id(def: Def) -> Option<DefId> {
|
|
|
|
|
match def {
|
2018-11-20 09:33:40 +00:00
|
|
|
|
Def::Fn(id)
|
|
|
|
|
| Def::Mod(id)
|
|
|
|
|
| Def::Static(id, _)
|
|
|
|
|
| Def::Variant(id)
|
|
|
|
|
| Def::VariantCtor(id, ..)
|
|
|
|
|
| Def::Enum(id)
|
|
|
|
|
| Def::TyAlias(id)
|
|
|
|
|
| Def::AssociatedTy(id)
|
|
|
|
|
| Def::TyParam(id)
|
|
|
|
|
| Def::ForeignTy(id)
|
|
|
|
|
| Def::Struct(id)
|
|
|
|
|
| Def::StructCtor(id, ..)
|
|
|
|
|
| Def::Union(id)
|
|
|
|
|
| Def::Trait(id)
|
|
|
|
|
| Def::TraitAlias(id)
|
|
|
|
|
| Def::Method(id)
|
|
|
|
|
| Def::Const(id)
|
|
|
|
|
| Def::AssociatedConst(id)
|
|
|
|
|
| Def::Macro(id, ..)
|
|
|
|
|
| Def::Existential(id)
|
|
|
|
|
| Def::AssociatedExistential(id)
|
|
|
|
|
| Def::SelfCtor(id) => Some(id),
|
|
|
|
|
|
|
|
|
|
Def::Upvar(..)
|
|
|
|
|
| Def::Local(_)
|
|
|
|
|
| Def::Label(..)
|
|
|
|
|
| Def::PrimTy(..)
|
|
|
|
|
| Def::SelfTy(..)
|
|
|
|
|
| Def::ToolMod
|
|
|
|
|
| Def::NonMacroAttr { .. }
|
|
|
|
|
| Def::Err => None,
|
2016-12-01 21:31:56 +00:00
|
|
|
|
}
|
|
|
|
|
}
|
2017-01-04 04:40:42 +00:00
|
|
|
|
|
|
|
|
|
pub fn is_self(slf: &Arg) -> bool {
|
|
|
|
|
if let PatKind::Binding(_, _, name, _) = slf.pat.node {
|
2018-12-06 15:38:32 +00:00
|
|
|
|
name.name == keywords::SelfLower.name()
|
2017-01-04 04:40:42 +00:00
|
|
|
|
} else {
|
|
|
|
|
false
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-06-11 02:57:25 +00:00
|
|
|
|
pub fn is_self_ty(slf: &hir::Ty) -> bool {
|
2017-10-23 19:18:02 +00:00
|
|
|
|
if_chain! {
|
2018-07-12 08:03:06 +00:00
|
|
|
|
if let TyKind::Path(ref qp) = slf.node;
|
2017-10-23 19:18:02 +00:00
|
|
|
|
if let QPath::Resolved(None, ref path) = *qp;
|
|
|
|
|
if let Def::SelfTy(..) = path.def;
|
|
|
|
|
then {
|
|
|
|
|
return true
|
|
|
|
|
}
|
|
|
|
|
}
|
2017-01-04 23:32:57 +00:00
|
|
|
|
false
|
|
|
|
|
}
|
|
|
|
|
|
2017-01-04 23:53:16 +00:00
|
|
|
|
pub fn iter_input_pats<'tcx>(decl: &FnDecl, body: &'tcx Body) -> impl Iterator<Item = &'tcx Arg> {
|
2017-01-04 21:46:41 +00:00
|
|
|
|
(0..decl.inputs.len()).map(move |i| &body.arguments[i])
|
2017-01-04 23:53:16 +00:00
|
|
|
|
}
|
2017-01-07 14:39:50 +00:00
|
|
|
|
|
|
|
|
|
/// Check if a given expression is a match expression
|
|
|
|
|
/// expanded from `?` operator or `try` macro.
|
|
|
|
|
pub fn is_try(expr: &Expr) -> Option<&Expr> {
|
|
|
|
|
fn is_ok(arm: &Arm) -> bool {
|
2017-10-23 19:18:02 +00:00
|
|
|
|
if_chain! {
|
|
|
|
|
if let PatKind::TupleStruct(ref path, ref pat, None) = arm.pats[0].node;
|
|
|
|
|
if match_qpath(path, &paths::RESULT_OK[1..]);
|
|
|
|
|
if let PatKind::Binding(_, defid, _, None) = pat[0].node;
|
2018-07-12 07:30:57 +00:00
|
|
|
|
if let ExprKind::Path(QPath::Resolved(None, ref path)) = arm.body.node;
|
2017-10-23 19:18:02 +00:00
|
|
|
|
if let Def::Local(lid) = path.def;
|
|
|
|
|
if lid == defid;
|
|
|
|
|
then {
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
}
|
2017-01-07 14:39:50 +00:00
|
|
|
|
false
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
fn is_err(arm: &Arm) -> bool {
|
|
|
|
|
if let PatKind::TupleStruct(ref path, _, _) = arm.pats[0].node {
|
2017-08-24 22:21:46 +00:00
|
|
|
|
match_qpath(path, &paths::RESULT_ERR[1..])
|
2017-01-07 14:39:50 +00:00
|
|
|
|
} else {
|
|
|
|
|
false
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2018-07-12 07:30:57 +00:00
|
|
|
|
if let ExprKind::Match(_, ref arms, ref source) = expr.node {
|
2017-01-07 14:39:50 +00:00
|
|
|
|
// desugared from a `?` operator
|
|
|
|
|
if let MatchSource::TryDesugar = *source {
|
|
|
|
|
return Some(expr);
|
|
|
|
|
}
|
|
|
|
|
|
2017-10-23 19:18:02 +00:00
|
|
|
|
if_chain! {
|
|
|
|
|
if arms.len() == 2;
|
|
|
|
|
if arms[0].pats.len() == 1 && arms[0].guard.is_none();
|
|
|
|
|
if arms[1].pats.len() == 1 && arms[1].guard.is_none();
|
|
|
|
|
if (is_ok(&arms[0]) && is_err(&arms[1])) ||
|
|
|
|
|
(is_ok(&arms[1]) && is_err(&arms[0]));
|
|
|
|
|
then {
|
|
|
|
|
return Some(expr);
|
|
|
|
|
}
|
|
|
|
|
}
|
2017-01-07 14:39:50 +00:00
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
None
|
|
|
|
|
}
|
2017-03-02 09:41:20 +00:00
|
|
|
|
|
2017-08-11 12:11:46 +00:00
|
|
|
|
/// Returns true if the lint is allowed in the current context
|
|
|
|
|
///
|
|
|
|
|
/// Useful for skipping long running code when it's unnecessary
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn is_allowed(cx: &LateContext<'_, '_>, lint: &'static Lint, id: NodeId) -> bool {
|
2017-08-11 12:11:46 +00:00
|
|
|
|
cx.tcx.lint_level_at_node(lint, id).0 == Level::Allow
|
|
|
|
|
}
|
2018-01-14 10:05:01 +00:00
|
|
|
|
|
|
|
|
|
pub fn get_arg_name(pat: &Pat) -> Option<ast::Name> {
|
|
|
|
|
match pat.node {
|
2018-06-28 13:46:58 +00:00
|
|
|
|
PatKind::Binding(_, _, ident, None) => Some(ident.name),
|
2018-01-14 10:05:01 +00:00
|
|
|
|
PatKind::Ref(ref subpat, _) => get_arg_name(subpat),
|
|
|
|
|
_ => None,
|
|
|
|
|
}
|
2018-01-16 21:20:55 +00:00
|
|
|
|
}
|
2018-03-13 10:38:11 +00:00
|
|
|
|
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn int_bits(tcx: TyCtxt<'_, '_, '_>, ity: ast::IntTy) -> u64 {
|
2018-11-20 09:33:40 +00:00
|
|
|
|
layout::Integer::from_attr(&tcx, attr::IntType::SignedInt(ity))
|
|
|
|
|
.size()
|
|
|
|
|
.bits()
|
2018-03-13 10:38:11 +00:00
|
|
|
|
}
|
|
|
|
|
|
2018-10-09 05:34:10 +00:00
|
|
|
|
#[allow(clippy::cast_possible_wrap)]
|
2018-03-13 10:38:11 +00:00
|
|
|
|
/// Turn a constant int byte representation into an i128
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn sext(tcx: TyCtxt<'_, '_, '_>, u: u128, ity: ast::IntTy) -> i128 {
|
2018-03-13 10:38:11 +00:00
|
|
|
|
let amt = 128 - int_bits(tcx, ity);
|
|
|
|
|
((u as i128) << amt) >> amt
|
|
|
|
|
}
|
|
|
|
|
|
2018-10-09 05:34:10 +00:00
|
|
|
|
#[allow(clippy::cast_sign_loss)]
|
2018-03-13 10:38:11 +00:00
|
|
|
|
/// clip unused bytes
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn unsext(tcx: TyCtxt<'_, '_, '_>, u: i128, ity: ast::IntTy) -> u128 {
|
2018-03-13 10:38:11 +00:00
|
|
|
|
let amt = 128 - int_bits(tcx, ity);
|
|
|
|
|
((u as u128) << amt) >> amt
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
/// clip unused bytes
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn clip(tcx: TyCtxt<'_, '_, '_>, u: u128, ity: ast::UintTy) -> u128 {
|
2018-11-20 09:33:40 +00:00
|
|
|
|
let bits = layout::Integer::from_attr(&tcx, attr::IntType::UnsignedInt(ity))
|
|
|
|
|
.size()
|
|
|
|
|
.bits();
|
2018-03-13 10:38:11 +00:00
|
|
|
|
let amt = 128 - bits;
|
|
|
|
|
(u << amt) >> amt
|
|
|
|
|
}
|
2018-03-29 19:14:53 +00:00
|
|
|
|
|
|
|
|
|
/// Remove block comments from the given Vec of lines
|
|
|
|
|
///
|
|
|
|
|
/// # Examples
|
|
|
|
|
///
|
|
|
|
|
/// ```rust,ignore
|
|
|
|
|
/// without_block_comments(vec!["/*", "foo", "*/"]);
|
|
|
|
|
/// // => vec![]
|
|
|
|
|
///
|
|
|
|
|
/// without_block_comments(vec!["bar", "/*", "foo", "*/"]);
|
|
|
|
|
/// // => vec!["bar"]
|
|
|
|
|
/// ```
|
|
|
|
|
pub fn without_block_comments(lines: Vec<&str>) -> Vec<&str> {
|
|
|
|
|
let mut without = vec![];
|
|
|
|
|
|
2018-03-30 10:36:30 +00:00
|
|
|
|
let mut nest_level = 0;
|
2018-03-29 19:14:53 +00:00
|
|
|
|
|
2018-04-02 05:35:13 +00:00
|
|
|
|
for line in lines {
|
2018-03-29 19:14:53 +00:00
|
|
|
|
if line.contains("/*") {
|
2018-03-30 10:36:30 +00:00
|
|
|
|
nest_level += 1;
|
2018-03-29 19:14:53 +00:00
|
|
|
|
continue;
|
|
|
|
|
} else if line.contains("*/") {
|
2018-03-30 10:36:30 +00:00
|
|
|
|
nest_level -= 1;
|
2018-03-29 19:14:53 +00:00
|
|
|
|
continue;
|
|
|
|
|
}
|
|
|
|
|
|
2018-03-30 10:36:30 +00:00
|
|
|
|
if nest_level == 0 {
|
2018-03-29 19:14:53 +00:00
|
|
|
|
without.push(line);
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
without
|
|
|
|
|
}
|
2018-06-17 21:58:08 +00:00
|
|
|
|
|
2018-07-23 11:01:12 +00:00
|
|
|
|
pub fn any_parent_is_automatically_derived(tcx: TyCtxt<'_, '_, '_>, node: NodeId) -> bool {
|
2018-12-08 00:56:03 +00:00
|
|
|
|
let map = &tcx.hir();
|
2018-06-17 21:58:08 +00:00
|
|
|
|
let mut prev_enclosing_node = None;
|
|
|
|
|
let mut enclosing_node = node;
|
|
|
|
|
while Some(enclosing_node) != prev_enclosing_node {
|
|
|
|
|
if is_automatically_derived(map.attrs(enclosing_node)) {
|
|
|
|
|
return true;
|
|
|
|
|
}
|
|
|
|
|
prev_enclosing_node = Some(enclosing_node);
|
|
|
|
|
enclosing_node = map.get_parent(enclosing_node);
|
|
|
|
|
}
|
|
|
|
|
false
|
|
|
|
|
}
|
2018-08-29 02:32:20 +00:00
|
|
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
|
mod test {
|
|
|
|
|
use super::{trim_multiline, without_block_comments};
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_trim_multiline_single_line() {
|
|
|
|
|
assert_eq!("", trim_multiline("".into(), false));
|
|
|
|
|
assert_eq!("...", trim_multiline("...".into(), false));
|
|
|
|
|
assert_eq!("...", trim_multiline(" ...".into(), false));
|
|
|
|
|
assert_eq!("...", trim_multiline("\t...".into(), false));
|
|
|
|
|
assert_eq!("...", trim_multiline("\t\t...".into(), false));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
#[rustfmt::skip]
|
|
|
|
|
fn test_trim_multiline_block() {
|
|
|
|
|
assert_eq!("\
|
|
|
|
|
if x {
|
|
|
|
|
y
|
|
|
|
|
} else {
|
|
|
|
|
z
|
|
|
|
|
}", trim_multiline(" if x {
|
|
|
|
|
y
|
|
|
|
|
} else {
|
|
|
|
|
z
|
|
|
|
|
}".into(), false));
|
|
|
|
|
assert_eq!("\
|
|
|
|
|
if x {
|
|
|
|
|
\ty
|
|
|
|
|
} else {
|
|
|
|
|
\tz
|
|
|
|
|
}", trim_multiline(" if x {
|
|
|
|
|
\ty
|
|
|
|
|
} else {
|
|
|
|
|
\tz
|
|
|
|
|
}".into(), false));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
#[rustfmt::skip]
|
|
|
|
|
fn test_trim_multiline_empty_line() {
|
|
|
|
|
assert_eq!("\
|
|
|
|
|
if x {
|
|
|
|
|
y
|
|
|
|
|
|
|
|
|
|
} else {
|
|
|
|
|
z
|
|
|
|
|
}", trim_multiline(" if x {
|
|
|
|
|
y
|
|
|
|
|
|
|
|
|
|
} else {
|
|
|
|
|
z
|
|
|
|
|
}".into(), false));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
|
fn test_without_block_comments_lines_without_block_comments() {
|
|
|
|
|
let result = without_block_comments(vec!["/*", "", "*/"]);
|
|
|
|
|
println!("result: {:?}", result);
|
|
|
|
|
assert!(result.is_empty());
|
|
|
|
|
|
|
|
|
|
let result = without_block_comments(vec!["", "/*", "", "*/", "#[crate_type = \"lib\"]", "/*", "", "*/", ""]);
|
|
|
|
|
assert_eq!(result, vec!["", "#[crate_type = \"lib\"]", ""]);
|
|
|
|
|
|
|
|
|
|
let result = without_block_comments(vec!["/* rust", "", "*/"]);
|
|
|
|
|
assert!(result.is_empty());
|
|
|
|
|
|
|
|
|
|
let result = without_block_comments(vec!["/* one-line comment */"]);
|
|
|
|
|
assert!(result.is_empty());
|
|
|
|
|
|
|
|
|
|
let result = without_block_comments(vec!["/* nested", "/* multi-line", "comment", "*/", "test", "*/"]);
|
|
|
|
|
assert!(result.is_empty());
|
|
|
|
|
|
|
|
|
|
let result = without_block_comments(vec!["/* nested /* inline /* comment */ test */ */"]);
|
|
|
|
|
assert!(result.is_empty());
|
|
|
|
|
|
|
|
|
|
let result = without_block_comments(vec!["foo", "bar", "baz"]);
|
|
|
|
|
assert_eq!(result, vec!["foo", "bar", "baz"]);
|
|
|
|
|
}
|
2018-09-05 22:45:57 +00:00
|
|
|
|
}
|