-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
14 changed files
with
350 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,113 @@ | ||
use clippy_utils::diagnostics::span_lint_and_sugg; | ||
use clippy_utils::is_from_proc_macro; | ||
use clippy_utils::source::snippet; | ||
use rustc_errors::Applicability; | ||
use rustc_hir::def_id::LocalDefId; | ||
use rustc_hir::intravisit::FnKind; | ||
use rustc_hir::{Body, FnDecl, FnHeader, Item, ItemKind}; | ||
use rustc_lint::{LateContext, LateLintPass, LintContext}; | ||
use rustc_middle::lint::in_external_macro; | ||
use rustc_session::declare_lint_pass; | ||
use rustc_span::Span; | ||
use rustc_target::spec::abi::Abi; | ||
|
||
const LINT_MSG: &str = "`extern` missing explicit ABI"; | ||
const LINT_HELP_MSG: &str = "consider using"; | ||
|
||
const EXTERN: &str = "extern"; | ||
const FN: &str = "fn"; | ||
const OPEN_BRACE: &str = "{"; | ||
const ABI: &str = "\"C\""; | ||
|
||
declare_clippy_lint! { | ||
/// ### What it does | ||
/// Checks for usage of `extern` without an explicit ABI. | ||
/// | ||
/// ### Why is this bad? | ||
/// Explicitly declaring the ABI is the recommended convention. See: | ||
/// [Rust Style Guide - `extern` items](https://doc.rust-lang.org/nightly/style-guide/items.html#extern-items) | ||
/// | ||
/// It's also enforced by `rustfmt` when the `force_explicit_abi` option is enabled. See: | ||
/// [Configuring Rustfmt](https://rust-lang.github.io/rustfmt/?version=master&search=#force_explicit_abi) | ||
/// | ||
/// ### Example | ||
/// ```no_run | ||
/// extern fn foo() {} | ||
/// | ||
/// extern { | ||
/// fn bar(); | ||
/// } | ||
/// ``` | ||
/// Use instead: | ||
/// ```no_run | ||
/// extern "C" fn foo() {} | ||
/// | ||
/// extern "C" { | ||
/// fn bar(); | ||
/// } | ||
/// ``` | ||
#[clippy::version = "1.83.0"] | ||
pub EXTERN_WITHOUT_ABI, | ||
style, | ||
"`extern` missing explicit ABI" | ||
} | ||
|
||
declare_lint_pass!(ExternWithoutAbi => [EXTERN_WITHOUT_ABI]); | ||
|
||
impl<'tcx> LateLintPass<'tcx> for ExternWithoutAbi { | ||
fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx Item<'tcx>) { | ||
if let ItemKind::ForeignMod { abi: Abi::C { .. }, .. } = item.kind | ||
&& !in_external_macro(cx.sess(), item.span) | ||
&& !is_from_proc_macro(cx, item) | ||
&& let snippet = snippet(cx.sess(), item.span, "").as_ref() | ||
&& is_extern_followed_by(OPEN_BRACE, snippet) | ||
{ | ||
emit_lint(cx, item.span, snippet); | ||
} | ||
} | ||
|
||
fn check_fn( | ||
&mut self, | ||
cx: &LateContext<'tcx>, | ||
kind: FnKind<'tcx>, | ||
_: &'tcx FnDecl<'tcx>, | ||
body: &'tcx Body<'tcx>, | ||
span: Span, | ||
_: LocalDefId, | ||
) { | ||
if let FnKind::ItemFn(_, _, header) = kind | ||
&& let FnHeader { abi: Abi::C { .. }, .. } = header | ||
&& !in_external_macro(cx.sess(), span) | ||
&& let hir_id = cx.tcx.hir().body_owner(body.id()) | ||
&& !is_from_proc_macro(cx, &(&kind, body, hir_id, span)) | ||
&& let snippet = snippet(cx.sess(), span, "").as_ref() | ||
&& is_extern_followed_by(FN, snippet) | ||
{ | ||
emit_lint(cx, span, snippet); | ||
} | ||
} | ||
} | ||
|
||
fn is_extern_followed_by(item: &str, snippet: &str) -> bool { | ||
let mut tokens = snippet.split_whitespace(); | ||
|
||
if let (_, Some(i)) = (tokens.next(), tokens.next()) | ||
&& i.starts_with(item) | ||
{ | ||
return true; | ||
} | ||
false | ||
} | ||
|
||
fn emit_lint(cx: &LateContext<'_>, span: Span, snippet: &str) { | ||
let sugg = snippet.replacen(EXTERN, format!("{EXTERN} {ABI}").as_str(), 1); | ||
span_lint_and_sugg( | ||
cx, | ||
EXTERN_WITHOUT_ABI, | ||
span, | ||
LINT_MSG, | ||
LINT_HELP_MSG, | ||
sugg, | ||
Applicability::MachineApplicable, | ||
); | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
//@aux-build:proc_macros.rs | ||
|
||
#![warn(clippy::extern_without_abi)] | ||
|
||
extern crate proc_macros; | ||
use proc_macros::{external, with_span}; | ||
|
||
#[rustfmt::skip] | ||
extern "C" fn foo() {} | ||
//~^ ERROR: `extern` missing explicit ABI | ||
|
||
#[rustfmt::skip] | ||
extern "C" | ||
fn foo_two() {} | ||
//~^^ ERROR: `extern` missing explicit ABI | ||
|
||
extern "C" fn bar() {} | ||
|
||
#[rustfmt::skip] | ||
extern | ||
"C" | ||
fn bar_two() {} | ||
|
||
extern "system" fn baz() {} | ||
|
||
#[rustfmt::skip] | ||
extern "C" { | ||
//~^ ERROR: `extern` missing explicit ABI | ||
fn qux(); | ||
} | ||
|
||
#[rustfmt::skip] | ||
extern "C" | ||
{ | ||
//~^^ ERROR: `extern` missing explicit ABI | ||
fn qux_two(); | ||
} | ||
|
||
#[rustfmt::skip] | ||
extern "C" {fn qux_three();} | ||
//~^ ERROR: `extern` missing explicit ABI | ||
|
||
extern "C" { | ||
fn grault(); | ||
} | ||
|
||
extern "system" { | ||
fn grault_two(); | ||
} | ||
|
||
external! { | ||
extern fn waldo() {} | ||
} | ||
|
||
with_span! { | ||
span | ||
extern fn waldo_two() {} | ||
} | ||
|
||
fn main() {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,60 @@ | ||
//@aux-build:proc_macros.rs | ||
|
||
#![warn(clippy::extern_without_abi)] | ||
|
||
extern crate proc_macros; | ||
use proc_macros::{external, with_span}; | ||
|
||
#[rustfmt::skip] | ||
extern fn foo() {} | ||
//~^ ERROR: `extern` missing explicit ABI | ||
|
||
#[rustfmt::skip] | ||
extern | ||
fn foo_two() {} | ||
//~^^ ERROR: `extern` missing explicit ABI | ||
|
||
extern "C" fn bar() {} | ||
|
||
#[rustfmt::skip] | ||
extern | ||
"C" | ||
fn bar_two() {} | ||
|
||
extern "system" fn baz() {} | ||
|
||
#[rustfmt::skip] | ||
extern { | ||
//~^ ERROR: `extern` missing explicit ABI | ||
fn qux(); | ||
} | ||
|
||
#[rustfmt::skip] | ||
extern | ||
{ | ||
//~^^ ERROR: `extern` missing explicit ABI | ||
fn qux_two(); | ||
} | ||
|
||
#[rustfmt::skip] | ||
extern {fn qux_three();} | ||
//~^ ERROR: `extern` missing explicit ABI | ||
|
||
extern "C" { | ||
fn grault(); | ||
} | ||
|
||
extern "system" { | ||
fn grault_two(); | ||
} | ||
|
||
external! { | ||
extern fn waldo() {} | ||
} | ||
|
||
with_span! { | ||
span | ||
extern fn waldo_two() {} | ||
} | ||
|
||
fn main() {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
error: `extern` missing explicit ABI | ||
--> tests/ui/extern_without_abi.rs:9:1 | ||
| | ||
LL | extern fn foo() {} | ||
| ^^^^^^^^^^^^^^^^^^ help: consider using: `extern "C" fn foo() {}` | ||
| | ||
= note: `-D clippy::extern-without-abi` implied by `-D warnings` | ||
= help: to override `-D warnings` add `#[allow(clippy::extern_without_abi)]` | ||
|
||
error: `extern` missing explicit ABI | ||
--> tests/ui/extern_without_abi.rs:13:1 | ||
| | ||
LL | / extern | ||
LL | | fn foo_two() {} | ||
| |_______________^ | ||
| | ||
help: consider using | ||
| | ||
LL ~ extern "C" | ||
LL + fn foo_two() {} | ||
| | ||
|
||
error: `extern` missing explicit ABI | ||
--> tests/ui/extern_without_abi.rs:27:1 | ||
| | ||
LL | / extern { | ||
LL | | | ||
LL | | fn qux(); | ||
LL | | } | ||
| |_^ | ||
| | ||
help: consider using | ||
| | ||
LL + extern "C" { | ||
LL + | ||
LL + fn qux(); | ||
LL + } | ||
| | ||
|
||
error: `extern` missing explicit ABI | ||
--> tests/ui/extern_without_abi.rs:33:1 | ||
| | ||
LL | / extern | ||
LL | | { | ||
LL | | | ||
LL | | fn qux_two(); | ||
LL | | } | ||
| |_^ | ||
| | ||
help: consider using | ||
| | ||
LL ~ extern "C" | ||
LL + { | ||
LL + | ||
LL + fn qux_two(); | ||
LL + } | ||
| | ||
|
||
error: `extern` missing explicit ABI | ||
--> tests/ui/extern_without_abi.rs:40:1 | ||
| | ||
LL | extern {fn qux_three();} | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^ help: consider using: `extern "C" {fn qux_three();}` | ||
|
||
error: aborting due to 5 previous errors | ||
|
Oops, something went wrong.