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};
/// ```
Added `clippy::version` attribute to all normal lints So, some context for this, well, more a story. I'm not used to scripting, I've never really scripted anything, even if it's a valuable skill. I just never really needed it. Now, `@flip1995` correctly suggested using a script for this in `rust-clippy#7813`... And I decided to write a script using nushell because why not? This was a mistake... I spend way more time on this than I would like to admit. It has definitely been more than 4 hours. It shouldn't take that long, but me being new to scripting and nushell just wasn't a good mixture... Anyway, here is the script that creates another script which adds the versions. Fun... Just execute this on the `gh-pages` branch and the resulting `replacer.sh` in `clippy_lints` and it should all work. ```nu mv v0.0.212 rust-1.00.0; mv beta rust-1.57.0; mv master rust-1.58.0; let paths = (open ./rust-1.58.0/lints.json | select id id_span | flatten | select id path); let versions = ( ls | where name =~ "rust-" | select name | format {name}/lints.json | each { open $it | select id | insert version $it | str substring "5,11" version} | group-by id | rotate counter-clockwise id version | update version {get version | first 1} | flatten | select id version); $paths | each { |row| let version = ($versions | where id == ($row.id) | format {version}) let idu = ($row.id | str upcase) $"sed -i '0,/($idu),/{s/pub ($idu),/#[clippy::version = "($version)"]\n pub ($idu),/}' ($row.path)" } | str collect ";" | str find-replace --all '1.00.0' 'pre 1.29.0' | save "replacer.sh"; ``` And this still has some problems, but at this point I just want to be done -.-
2021-10-21 19:06:26 +00:00
#[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")
}