rust-clippy/clippy_lints/src/unsafe_removed_from_name.rs

80 lines
2.4 KiB
Rust
Raw Normal View History

use clippy_utils::diagnostics::span_lint;
2020-05-08 11:57:01 +00:00
use rustc_ast::ast::{Item, ItemKind, UseTree, UseTreeKind};
2020-01-12 06:08:41 +00:00
use rustc_lint::{EarlyContext, EarlyLintPass};
2020-01-11 11:37:08 +00:00
use rustc_session::{declare_lint_pass, declare_tool_lint};
use rustc_span::source_map::Span;
use rustc_span::symbol::Ident;
2018-03-28 13:24:26 +00:00
declare_clippy_lint! {
/// ### What it does
/// Checks for imports that remove "unsafe" from an item's
/// name.
///
/// ### Why is this bad?
/// Renaming makes it less clear which traits and
/// structures are unsafe.
///
/// ### Example
/// ```rust,ignore
/// use std::cell::{UnsafeCell as TotallySafeCell};
///
/// extern crate crossbeam;
/// use crossbeam::{spawn_unsafe as spawn};
/// ```
#[clippy::version = "pre 1.29.0"]
pub UNSAFE_REMOVED_FROM_NAME,
2018-03-28 13:24:26 +00:00
style,
"`unsafe` removed from API names on import"
}
2019-04-08 20:43:55 +00:00
declare_lint_pass!(UnsafeNameRemoval => [UNSAFE_REMOVED_FROM_NAME]);
impl EarlyLintPass for UnsafeNameRemoval {
2018-07-23 11:01:12 +00:00
fn check_item(&mut self, cx: &EarlyContext<'_>, item: &Item) {
2019-09-27 15:16:06 +00:00
if let ItemKind::Use(ref use_tree) = item.kind {
check_use_tree(use_tree, cx, item.span);
}
}
}
2018-07-23 11:01:12 +00:00
fn check_use_tree(use_tree: &UseTree, cx: &EarlyContext<'_>, span: Span) {
match use_tree.kind {
2018-06-18 07:55:59 +00:00
UseTreeKind::Simple(Some(new_name), ..) => {
let old_name = use_tree
.prefix
.segments
.last()
.expect("use paths cannot be empty")
.ident;
unsafe_to_safe_check(old_name, new_name, cx, span);
2018-11-27 20:14:15 +00:00
},
UseTreeKind::Simple(None, ..) | UseTreeKind::Glob => {},
UseTreeKind::Nested(ref nested_use_tree) => {
for &(ref use_tree, _) in nested_use_tree {
check_use_tree(use_tree, cx, span);
}
2018-11-27 20:14:15 +00:00
},
}
}
2018-07-23 11:01:12 +00:00
fn unsafe_to_safe_check(old_name: Ident, new_name: Ident, cx: &EarlyContext<'_>, span: Span) {
let old_str = old_name.name.as_str();
let new_str = new_name.name.as_str();
if contains_unsafe(old_str) && !contains_unsafe(new_str) {
2017-08-09 07:30:56 +00:00
span_lint(
cx,
UNSAFE_REMOVED_FROM_NAME,
span,
2018-11-27 20:14:15 +00:00
&format!(
2020-01-06 06:30:43 +00:00
"removed `unsafe` from the name of `{}` in use as `{}`",
2018-11-27 20:14:15 +00:00
old_str, new_str
),
2017-08-09 07:30:56 +00:00
);
}
}
#[must_use]
fn contains_unsafe(name: &str) -> bool {
name.contains("Unsafe") || name.contains("unsafe")
}