+#[macro_use]
+pub mod sym;
+
pub mod attrs;
pub mod author;
pub mod camel_case;
use if_chain::if_chain;
use matches::matches;
use rustc::hir;
-use rustc::hir::def::Def;
-use rustc::hir::def_id::CrateNum;
+use rustc::hir::def::{DefKind, Res};
use rustc::hir::def_id::{DefId, CRATE_DEF_INDEX, LOCAL_CRATE};
use rustc::hir::intravisit::{NestedVisitorMap, Visitor};
-use rustc::hir::map::{DefPathData, DisambiguatedDefPathData};
use rustc::hir::Node;
use rustc::hir::*;
use rustc::lint::{LateContext, Level, Lint, LintContext};
subst::Kind,
Binder, Ty, TyCtxt,
};
-use rustc_data_structures::sync::Lrc;
use rustc_errors::Applicability;
+use smallvec::SmallVec;
use syntax::ast::{self, LitKind};
use syntax::attr;
+use syntax::ext::hygiene::ExpnFormat;
use syntax::source_map::{Span, DUMMY_SP};
-use syntax::symbol::{keywords, LocalInternedString, Symbol};
+use syntax::symbol::{kw, Symbol};
use crate::reexport::*;
}
}
-/// Returns `true` if this `expn_info` was expanded by any macro.
-pub fn in_macro(span: Span) -> bool {
- span.ctxt().outer().expn_info().is_some()
-}
-
-/// Used to store the absolute path to a type.
-///
-/// See `match_def_path` for usage.
-pub struct AbsolutePathPrinter<'a, 'tcx> {
- pub tcx: TyCtxt<'a, 'tcx, 'tcx>,
+/// Returns `true` if this `expn_info` was expanded by any macro or desugaring
+pub fn in_macro_or_desugar(span: Span) -> bool {
+ span.ctxt().outer_expn_info().is_some()
}
-use rustc::ty::print::Printer;
-
-#[allow(clippy::diverging_sub_expression)]
-impl<'tcx> Printer<'tcx, 'tcx> for AbsolutePathPrinter<'_, 'tcx> {
- type Error = !;
-
- type Path = Vec<LocalInternedString>;
- type Region = ();
- type Type = ();
- type DynExistential = ();
-
- fn tcx<'a>(&'a self) -> TyCtxt<'a, 'tcx, 'tcx> {
- self.tcx
- }
-
- fn print_region(self, _region: ty::Region<'_>) -> Result<Self::Region, Self::Error> {
- Ok(())
- }
-
- fn print_type(self, _ty: Ty<'tcx>) -> Result<Self::Type, Self::Error> {
- Ok(())
- }
-
- fn print_dyn_existential(
- self,
- _predicates: &'tcx ty::List<ty::ExistentialPredicate<'tcx>>,
- ) -> Result<Self::DynExistential, Self::Error> {
- Ok(())
- }
-
- fn path_crate(self, cnum: CrateNum) -> Result<Self::Path, Self::Error> {
- Ok(vec![self.tcx.original_crate_name(cnum).as_str()])
- }
-
- fn path_qualified(
- self,
- self_ty: Ty<'tcx>,
- trait_ref: Option<ty::TraitRef<'tcx>>,
- ) -> Result<Self::Path, Self::Error> {
- if trait_ref.is_none() {
- if let ty::Adt(def, substs) = self_ty.sty {
- return self.print_def_path(def.did, substs);
- }
+/// Returns `true` if this `expn_info` was expanded by any macro.
+pub fn in_macro(span: Span) -> bool {
+ if let Some(info) = span.ctxt().outer_expn_info() {
+ if let ExpnFormat::CompilerDesugaring(..) = info.format {
+ false
+ } else {
+ true
}
-
- // This shouldn't ever be needed, but just in case:
- Ok(vec![match trait_ref {
- Some(trait_ref) => Symbol::intern(&format!("{:?}", trait_ref)).as_str(),
- None => Symbol::intern(&format!("<{}>", self_ty)).as_str(),
- }])
- }
-
- fn path_append_impl(
- self,
- print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
- _disambiguated_data: &DisambiguatedDefPathData,
- self_ty: Ty<'tcx>,
- trait_ref: Option<ty::TraitRef<'tcx>>,
- ) -> Result<Self::Path, Self::Error> {
- let mut path = print_prefix(self)?;
-
- // This shouldn't ever be needed, but just in case:
- path.push(match trait_ref {
- Some(trait_ref) => Symbol::intern(&format!("<impl {} for {}>", trait_ref, self_ty)).as_str(),
- None => Symbol::intern(&format!("<impl {}>", self_ty)).as_str(),
- });
-
- Ok(path)
+ } else {
+ false
}
-
- fn path_append(
- self,
- print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
- disambiguated_data: &DisambiguatedDefPathData,
- ) -> Result<Self::Path, Self::Error> {
- let mut path = print_prefix(self)?;
-
- // Skip `::{{constructor}}` on tuple/unit structs.
- if let DefPathData::Ctor = disambiguated_data.data {
- return Ok(path);
+}
+// If the snippet is empty, it's an attribute that was inserted during macro
+// expansion and we want to ignore those, because they could come from external
+// sources that the user has no control over.
+// For some reason these attributes don't have any expansion info on them, so
+// we have to check it this way until there is a better way.
+pub fn is_present_in_source<T: LintContext>(cx: &T, span: Span) -> bool {
+ if let Some(snippet) = snippet_opt(cx, span) {
+ if snippet.is_empty() {
+ return false;
}
-
- path.push(disambiguated_data.data.as_interned_str().as_str());
- Ok(path)
- }
-
- fn path_generic_args(
- self,
- print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
- _args: &[Kind<'tcx>],
- ) -> Result<Self::Path, Self::Error> {
- print_prefix(self)
}
-}
-
-/// Checks if a `DefId`'s path matches the given absolute type path usage.
-///
-/// # Examples
-/// ```rust,ignore
-/// match_def_path(cx.tcx, id, &["core", "option", "Option"])
-/// ```
-///
-/// See also the `paths` module.
-pub fn match_def_path<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId, path: &[&str]) -> bool {
- let names = get_def_path(tcx, def_id);
-
- names.len() == path.len() && names.into_iter().zip(path.iter()).all(|(a, &b)| *a == *b)
-}
-
-/// Gets the absolute path of `def_id` as a vector of `&str`.
-///
-/// # Examples
-/// ```rust,ignore
-/// let def_path = get_def_path(tcx, def_id);
-/// if let &["core", "option", "Option"] = &def_path[..] {
-/// // The given `def_id` is that of an `Option` type
-/// };
-/// ```
-pub fn get_def_path<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> Vec<LocalInternedString> {
- AbsolutePathPrinter { tcx }.print_def_path(def_id, &[]).unwrap()
+ true
}
/// Checks if type is struct, enum or union type with the given def path.
pub fn match_type(cx: &LateContext<'_, '_>, ty: Ty<'_>, path: &[&str]) -> bool {
match ty.sty {
- ty::Adt(adt, _) => match_def_path(cx.tcx, adt.did, path),
+ ty::Adt(adt, _) => match_def_path(cx, adt.did, path),
_ => false,
}
}
let def_id = cx.tables.type_dependent_def_id(expr.hir_id).unwrap();
let trt_id = cx.tcx.trait_of_item(def_id);
if let Some(trt_id) = trt_id {
- match_def_path(cx.tcx, trt_id, path)
+ match_def_path(cx, trt_id, path)
} else {
false
}
TyKind::Path(ref inner_path) => {
!segments.is_empty()
&& match_qpath(inner_path, &segments[..(segments.len() - 1)])
- && segment.ident.name == segments[segments.len() - 1]
+ && segment.ident.name.as_str() == segments[segments.len() - 1]
},
_ => false,
},
.iter()
.rev()
.zip(segments.iter().rev())
- .all(|(a, b)| a.ident.name == *b)
+ .all(|(a, b)| a.ident.name.as_str() == *b)
}
/// Matches a `Path` against a slice of segment string literals, e.g.
.iter()
.rev()
.zip(segments.iter().rev())
- .all(|(a, b)| a.ident.name == *b)
+ .all(|(a, b)| a.ident.name.as_str() == *b)
}
/// Gets the definition associated to a path.
-pub fn path_to_def(cx: &LateContext<'_, '_>, path: &[&str]) -> Option<def::Def> {
+pub fn path_to_res(cx: &LateContext<'_, '_>, path: &[&str]) -> Option<(def::Res)> {
let crates = cx.tcx.crates();
- let krate = crates.iter().find(|&&krate| cx.tcx.crate_name(krate) == path[0]);
+ let krate = crates
+ .iter()
+ .find(|&&krate| cx.tcx.crate_name(krate).as_str() == path[0]);
if let Some(krate) = krate {
let krate = DefId {
krate: *krate,
None => return None,
};
- for item in mem::replace(&mut items, Lrc::new(vec![])).iter() {
- if item.ident.name == *segment {
+ let result = SmallVec::<[_; 8]>::new();
+ for item in mem::replace(&mut items, cx.tcx.arena.alloc_slice(&result)).iter() {
+ if item.ident.name.as_str() == *segment {
if path_it.peek().is_none() {
- return Some(item.def);
+ return Some(item.res);
}
- items = cx.tcx.item_children(item.def.def_id());
+ items = cx.tcx.item_children(item.res.def_id());
break;
}
}
/// Convenience function to get the `DefId` of a trait by path.
pub fn get_trait_def_id(cx: &LateContext<'_, '_>, path: &[&str]) -> Option<DefId> {
- let def = match path_to_def(cx, path) {
- Some(def) => def,
+ let res = match path_to_res(cx, path) {
+ Some(res) => res,
None => return None,
};
- match def {
- def::Def::Trait(trait_id) => Some(trait_id),
+ match res {
+ def::Res::Def(DefKind::Trait, trait_id) => Some(trait_id),
_ => None,
}
}
}
/// Resolves the definition of a node from its `HirId`.
-pub fn resolve_node(cx: &LateContext<'_, '_>, qpath: &QPath, id: HirId) -> def::Def {
- cx.tables.qpath_def(qpath, id)
+pub fn resolve_node(cx: &LateContext<'_, '_>, qpath: &QPath, id: HirId) -> Res {
+ cx.tables.qpath_res(qpath, id)
}
/// Returns the method names and argument list of nested method call expressions that make up
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)) {
+ if args.iter().any(|e| in_macro_or_desugar(e.span)) {
break;
}
method_names.push(path.ident.name);
for method_name in methods.iter().rev() {
// method chains are stored last -> first
if let ExprKind::MethodCall(ref path, _, ref args) = current.node {
- if path.ident.name == *method_name {
- if args.iter().any(|e| in_macro(e.span)) {
+ if path.ident.name.as_str() == *method_name {
+ if args.iter().any(|e| in_macro_or_desugar(e.span)) {
return None;
}
matched.push(&**args); // build up `matched` backwards
/// ```rust,ignore
/// snippet(cx, expr.span, "..")
/// ```
-pub fn snippet<'a, 'b, T: LintContext<'b>>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
+pub fn snippet<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
snippet_opt(cx, span).map_or_else(|| Cow::Borrowed(default), From::from)
}
/// - 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`
-pub fn snippet_with_applicability<'a, 'b, T: LintContext<'b>>(
+pub fn snippet_with_applicability<'a, T: LintContext>(
cx: &T,
span: Span,
default: &'a str,
applicability: &mut Applicability,
) -> Cow<'a, str> {
- if *applicability != Applicability::Unspecified && in_macro(span) {
+ if *applicability != Applicability::Unspecified && in_macro_or_desugar(span) {
*applicability = Applicability::MaybeIncorrect;
}
snippet_opt(cx, span).map_or_else(
/// 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> {
+pub fn snippet_with_macro_callsite<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
snippet(cx, span.source_callsite(), default)
}
/// Converts a span to a code snippet. Returns `None` if not available.
-pub fn snippet_opt<'a, T: LintContext<'a>>(cx: &T, span: Span) -> Option<String> {
+pub fn snippet_opt<T: LintContext>(cx: &T, span: Span) -> Option<String> {
cx.sess().source_map().span_to_snippet(span).ok()
}
/// ```rust,ignore
/// snippet_block(cx, expr.span, "..")
/// ```
-pub fn snippet_block<'a, 'b, T: LintContext<'b>>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
+pub fn snippet_block<'a, T: LintContext>(cx: &T, span: Span, default: &'a str) -> Cow<'a, str> {
let snip = snippet(cx, span, default);
trim_multiline(snip, true)
}
/// 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>>(
+pub fn snippet_block_with_applicability<'a, T: LintContext>(
cx: &T,
span: Span,
default: &'a str,
}
/// 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 {
+pub fn last_line_of_span<T: LintContext>(cx: &T, span: Span) -> Span {
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];
/// Like `snippet_block`, but add braces if the expr is not an `ExprKind::Block`.
/// Also takes an `Option<String>` which can be put inside the braces.
-pub fn expr_block<'a, 'b, T: LintContext<'b>>(
- cx: &T,
- expr: &Expr,
- option: Option<String>,
- default: &'a str,
-) -> Cow<'a, str> {
+pub fn expr_block<'a, T: LintContext>(cx: &T, expr: &Expr, option: Option<String>, default: &'a str) -> Cow<'a, str> {
let code = snippet_block(cx, expr.span, default);
let string = option.unwrap_or_default();
- if in_macro(expr.span) {
+ if in_macro_or_desugar(expr.span) {
Cow::Owned(format!("{{ {} }}", snippet_with_macro_callsite(cx, expr.span, default)))
} else if let ExprKind::Block(_, _) = expr.node {
Cow::Owned(format!("{}{}", code, string))
})
}
-pub fn get_enclosing_block<'a, 'tcx: 'a>(cx: &LateContext<'a, 'tcx>, node: HirId) -> Option<&'tcx Block> {
+pub fn get_enclosing_block<'a, 'tcx: 'a>(cx: &LateContext<'a, 'tcx>, hir_id: HirId) -> Option<&'tcx Block> {
let map = &cx.tcx.hir();
- let node_id = map.hir_to_node_id(node);
let enclosing_node = map
- .get_enclosing_scope(node_id)
- .and_then(|enclosing_id| map.find(enclosing_id));
+ .get_enclosing_scope(hir_id)
+ .and_then(|enclosing_id| map.find_by_hir_id(enclosing_id));
if let Some(node) = enclosing_node {
match node {
Node::Block(block) => Some(block),
/// See also `is_direct_expn_of`.
pub fn is_expn_of(mut span: Span, name: &str) -> Option<Span> {
loop {
- let span_name_span = span
- .ctxt()
- .outer()
- .expn_info()
- .map(|ei| (ei.format.name(), ei.call_site));
+ let span_name_span = span.ctxt().outer_expn_info().map(|ei| (ei.format.name(), ei.call_site));
match span_name_span {
- Some((mac_name, new_span)) if mac_name == name => return Some(new_span),
+ Some((mac_name, new_span)) if mac_name.as_str() == name => return Some(new_span),
None => return None,
Some((_, new_span)) => span = new_span,
}
/// `bar!` by
/// `is_direct_expn_of`.
pub fn is_direct_expn_of(span: Span, name: &str) -> Option<Span> {
- let span_name_span = span
- .ctxt()
- .outer()
- .expn_info()
- .map(|ei| (ei.format.name(), ei.call_site));
+ let span_name_span = span.ctxt().outer_expn_info().map(|ei| (ei.format.name(), ei.call_site));
match span_name_span {
- Some((mac_name, new_span)) if mac_name == name => Some(new_span),
+ Some((mac_name, new_span)) if mac_name.as_str() == name => Some(new_span),
_ => None,
}
}
ty.is_copy_modulo_regions(cx.tcx.global_tcx(), cx.param_env, DUMMY_SP)
}
+/// Checks if an expression is constructing a tuple-like enum variant or struct
+pub fn is_ctor_function(cx: &LateContext<'_, '_>, expr: &Expr) -> bool {
+ if let ExprKind::Call(ref fun, _) = expr.node {
+ if let ExprKind::Path(ref qp) = fun.node {
+ return matches!(
+ cx.tables.qpath_res(qp, fun.hir_id),
+ def::Res::Def(DefKind::Variant, ..) | Res::Def(DefKind::Ctor(..), _)
+ );
+ }
+ }
+ false
+}
+
/// Returns `true` if a pattern is refutable.
pub fn is_refutable(cx: &LateContext<'_, '_>, pat: &Pat) -> bool {
fn is_enum_variant(cx: &LateContext<'_, '_>, qpath: &QPath, id: HirId) -> bool {
matches!(
- cx.tables.qpath_def(qpath, id),
- def::Def::Variant(..) | def::Def::Ctor(_, def::CtorOf::Variant, _)
+ cx.tables.qpath_res(qpath, id),
+ def::Res::Def(DefKind::Variant, ..) | Res::Def(DefKind::Ctor(def::CtorOf::Variant, _), _)
)
}
/// Checks for the `#[automatically_derived]` attribute all `#[derive]`d
/// implementations have.
pub fn is_automatically_derived(attrs: &[ast::Attribute]) -> bool {
- attr::contains_name(attrs, "automatically_derived")
+ attr::contains_name(attrs, sym!(automatically_derived))
}
/// Remove blocks around an expression.
pub fn is_self(slf: &Arg) -> bool {
if let PatKind::Binding(.., name, _) = slf.pat.node {
- name.name == keywords::SelfLower.name()
+ name.name == kw::SelfLower
} else {
false
}
if_chain! {
if let TyKind::Path(ref qp) = slf.node;
if let QPath::Resolved(None, ref path) = *qp;
- if let Def::SelfTy(..) = path.def;
+ if let Res::SelfTy(..) = path.res;
then {
return true
}
/// Checks if a given expression is a match expression expanded from the `?`
/// operator or the `try` macro.
-pub fn is_try<'a>(cx: &'_ LateContext<'_, '_>, expr: &'a Expr) -> Option<&'a Expr> {
- fn is_ok(cx: &'_ LateContext<'_, '_>, arm: &Arm) -> bool {
+pub fn is_try(expr: &Expr) -> Option<&Expr> {
+ fn is_ok(arm: &Arm) -> bool {
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(_, hir_id, _, None) = pat[0].node;
if let ExprKind::Path(QPath::Resolved(None, ref path)) = arm.body.node;
- if let Def::Local(lid) = path.def;
+ if let Res::Local(lid) = path.res;
if lid == hir_id;
then {
return true;
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(cx, &arms[0]) && is_err(&arms[1])) ||
- (is_ok(cx, &arms[1]) && is_err(&arms[0]));
+ if (is_ok(&arms[0]) && is_err(&arms[1])) ||
+ (is_ok(&arms[1]) && is_err(&arms[0]));
then {
return Some(expr);
}
// FIXME: instead of this hard-coded list, we should check if `<adt>::iter`
// exists and has the desired signature. Unfortunately FnCtxt is not exported
// so we can't use its `lookup_method` method.
- static INTO_ITER_COLLECTIONS: [&[&str]; 13] = [
+ let into_iter_collections: [&[&str]; 13] = [
&paths::VEC,
&paths::OPTION,
&paths::RESULT,
_ => return None,
};
- for path in &INTO_ITER_COLLECTIONS {
- if match_def_path(cx.tcx, def_id, path) {
- return Some(path.last().unwrap());
+ for path in &into_iter_collections {
+ if match_def_path(cx, def_id, path) {
+ return Some(*path.last().unwrap());
}
}
None
assert_eq!(result, vec!["foo", "bar", "baz"]);
}
}
+
+pub fn match_def_path<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, did: DefId, syms: &[&str]) -> bool {
+ // HACK: find a way to use symbols from clippy or just go fully to diagnostic items
+ let syms: Vec<_> = syms.iter().map(|sym| Symbol::intern(sym)).collect();
+ cx.match_def_path(did, &syms)
+}
projects / rust.git / blobdiff