Skip to content

Add lints for disallowing usage of to_xx_bytes and from_xx_bytes #10826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jun 5, 2023
Merged

Add lints for disallowing usage of to_xx_bytes and from_xx_bytes #10826

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
3ab6aee
`to_xx_bytes` implemented, `from_xx_bytes` todo
Centri3 May 25, 2023
97a0ccc
implement `host_endian_bytes` and the other two
Centri3 May 25, 2023
48d36a7
weird grammar
Centri3 May 25, 2023
04b7cae
refine output
Centri3 May 25, 2023
80ae1ec
unidiomatic `if_chain!`
Centri3 May 25, 2023
95e8c0b
don't allocate the names
Centri3 May 31, 2023
a6c3655
use enum for `prefix` instead of `&str`
Centri3 Jun 2, 2023
b1a21ae
Update endian_bytes.rs
Centri3 Jun 2, 2023
7fe200e
derive Copy/PartialEq for `Prefix`
Centri3 Jun 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 27 additions & 34 deletions clippy_lints/src/endian_bytes.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,11 @@ enum LintKind {
Big,
}

enum Prefix {
From,
To,
}

impl LintKind {
fn allowed(&self, cx: &LateContext<'_>, expr: &Expr<'_>) -> bool {
is_lint_allowed(cx, self.as_lint(), expr.hir_id)
Expand All @@ -89,29 +94,13 @@ impl LintKind {
}
}

fn to_name(&self, prefix: &str) -> &str {
fn as_name(&self, prefix: &Prefix) -> &str {
let index = if matches!(prefix, Prefix::From) { 0 } else { 1 };

match self {
LintKind::Host => {
if prefix == "from" {
HOST_NAMES[0]
} else {
HOST_NAMES[1]
}
},
LintKind::Little => {
if prefix == "from" {
LITTLE_NAMES[0]
} else {
LITTLE_NAMES[1]
}
},
LintKind::Big => {
if prefix == "from" {
BIG_NAMES[0]
} else {
BIG_NAMES[1]
}
},
LintKind::Host => HOST_NAMES[index],
LintKind::Little => LITTLE_NAMES[index],
LintKind::Big => BIG_NAMES[index],
}
}
}
Expand All @@ -127,7 +116,7 @@ impl LateLintPass<'_> for EndianBytes {
if args.is_empty();
let ty = cx.typeck_results().expr_ty(receiver);
if ty.is_primitive_ty();
if maybe_lint_endian_bytes(cx, expr, "to", method_name.ident.name, ty);
if maybe_lint_endian_bytes(cx, expr, &Prefix::To, method_name.ident.name, ty);
then {
return;
}
Expand All @@ -141,16 +130,16 @@ impl LateLintPass<'_> for EndianBytes {
let ty = cx.typeck_results().expr_ty(expr);
if ty.is_primitive_ty();
then {
maybe_lint_endian_bytes(cx, expr, "from", *function_name, ty);
maybe_lint_endian_bytes(cx, expr, &Prefix::From, *function_name, ty);
}
}
}
}

fn maybe_lint_endian_bytes(cx: &LateContext<'_>, expr: &Expr<'_>, prefix: &str, name: Symbol, ty: Ty<'_>) -> bool {
let ne = LintKind::Host.to_name(prefix);
let le = LintKind::Little.to_name(prefix);
let be = LintKind::Big.to_name(prefix);
fn maybe_lint_endian_bytes(cx: &LateContext<'_>, expr: &Expr<'_>, prefix: &Prefix, name: Symbol, ty: Ty<'_>) -> bool {
let ne = LintKind::Host.as_name(prefix);
let le = LintKind::Little.as_name(prefix);
let be = LintKind::Big.as_name(prefix);

let (lint, other_lints) = match name.as_str() {
name if name == ne => ((&LintKind::Host), [(&LintKind::Little), (&LintKind::Big)]),
Expand All @@ -172,14 +161,14 @@ fn maybe_lint_endian_bytes(cx: &LateContext<'_>, expr: &Expr<'_>, prefix: &str,
}

// ne_bytes and all other lints allowed
if lint.to_name(prefix) == ne && other_lints.iter().all(|lint| lint.allowed(cx, expr)) {
if lint.as_name(prefix) == ne && other_lints.iter().all(|lint| lint.allowed(cx, expr)) {
help = Some(Cow::Borrowed("specify the desired endianness explicitly"));
break 'build_help;
}

// le_bytes where ne_bytes allowed but be_bytes is not, or le_bytes where ne_bytes allowed but
// le_bytes is not
if (lint.to_name(prefix) == le || lint.to_name(prefix) == be) && LintKind::Host.allowed(cx, expr) {
if (lint.as_name(prefix) == le || lint.as_name(prefix) == be) && LintKind::Host.allowed(cx, expr) {
help = Some(Cow::Borrowed("use the native endianness instead"));
break 'build_help;
}
Expand All @@ -195,7 +184,7 @@ fn maybe_lint_endian_bytes(cx: &LateContext<'_>, expr: &Expr<'_>, prefix: &str,
help_str.push_str("either of ");
}

help_str.push_str(&format!("`{ty}::{}` ", lint.to_name(prefix)));
help_str.push_str(&format!("`{ty}::{}` ", lint.as_name(prefix)));

if i != len && !only_one {
help_str.push_str("or ");
Expand All @@ -211,9 +200,13 @@ fn maybe_lint_endian_bytes(cx: &LateContext<'_>, expr: &Expr<'_>, prefix: &str,
expr.span,
&format!(
"usage of the {}`{ty}::{}`{}",
if prefix == "from" { "function " } else { "" },
lint.to_name(prefix),
if prefix == "to" { " method" } else { "" },
if matches!(prefix, Prefix::From) {
"function "
} else {
""
},
lint.as_name(prefix),
if matches!(prefix, Prefix::To) { " method" } else { "" },
),
move |diag| {
if let Some(help) = help {
Expand Down