mirror of
https://github.com/rust-lang/rust-clippy
synced 2024-12-22 19:13:29 +00:00
203 lines
6.8 KiB
Rust
203 lines
6.8 KiB
Rust
use crate::utils::{match_type, paths, span_lint, walk_ptrs_ty};
|
|
use rustc_ast::ast::LitKind;
|
|
use rustc_hir::{Expr, ExprKind};
|
|
use rustc_lint::{LateContext, LateLintPass};
|
|
use rustc_session::{declare_lint_pass, declare_tool_lint};
|
|
use rustc_span::source_map::{Span, Spanned};
|
|
|
|
declare_clippy_lint! {
|
|
/// **What it does:** Checks for duplicate open options as well as combinations
|
|
/// that make no sense.
|
|
///
|
|
/// **Why is this bad?** In the best case, the code will be harder to read than
|
|
/// necessary. I don't know the worst case.
|
|
///
|
|
/// **Known problems:** None.
|
|
///
|
|
/// **Example:**
|
|
/// ```rust
|
|
/// use std::fs::OpenOptions;
|
|
///
|
|
/// OpenOptions::new().read(true).truncate(true);
|
|
/// ```
|
|
pub NONSENSICAL_OPEN_OPTIONS,
|
|
correctness,
|
|
"nonsensical combination of options for opening a file"
|
|
}
|
|
|
|
declare_lint_pass!(OpenOptions => [NONSENSICAL_OPEN_OPTIONS]);
|
|
|
|
impl<'tcx> LateLintPass<'tcx> for OpenOptions {
|
|
fn check_expr(&mut self, cx: &LateContext<'tcx>, e: &'tcx Expr<'_>) {
|
|
if let ExprKind::MethodCall(ref path, _, ref arguments, _) = e.kind {
|
|
let obj_ty = walk_ptrs_ty(cx.typeck_results().expr_ty(&arguments[0]));
|
|
if path.ident.name == sym!(open) && match_type(cx, obj_ty, &paths::OPEN_OPTIONS) {
|
|
let mut options = Vec::new();
|
|
get_open_options(cx, &arguments[0], &mut options);
|
|
check_open_options(cx, &options, e.span);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
|
|
enum Argument {
|
|
True,
|
|
False,
|
|
Unknown,
|
|
}
|
|
|
|
#[derive(Debug)]
|
|
enum OpenOption {
|
|
Write,
|
|
Read,
|
|
Truncate,
|
|
Create,
|
|
Append,
|
|
}
|
|
|
|
fn get_open_options(cx: &LateContext<'_>, argument: &Expr<'_>, options: &mut Vec<(OpenOption, Argument)>) {
|
|
if let ExprKind::MethodCall(ref path, _, ref arguments, _) = argument.kind {
|
|
let obj_ty = walk_ptrs_ty(cx.typeck_results().expr_ty(&arguments[0]));
|
|
|
|
// Only proceed if this is a call on some object of type std::fs::OpenOptions
|
|
if match_type(cx, obj_ty, &paths::OPEN_OPTIONS) && arguments.len() >= 2 {
|
|
let argument_option = match arguments[1].kind {
|
|
ExprKind::Lit(ref span) => {
|
|
if let Spanned {
|
|
node: LitKind::Bool(lit),
|
|
..
|
|
} = *span
|
|
{
|
|
if lit {
|
|
Argument::True
|
|
} else {
|
|
Argument::False
|
|
}
|
|
} else {
|
|
return; // The function is called with a literal
|
|
// which is not a boolean literal. This is theoretically
|
|
// possible, but not very likely.
|
|
}
|
|
},
|
|
_ => Argument::Unknown,
|
|
};
|
|
|
|
match &*path.ident.as_str() {
|
|
"create" => {
|
|
options.push((OpenOption::Create, argument_option));
|
|
},
|
|
"append" => {
|
|
options.push((OpenOption::Append, argument_option));
|
|
},
|
|
"truncate" => {
|
|
options.push((OpenOption::Truncate, argument_option));
|
|
},
|
|
"read" => {
|
|
options.push((OpenOption::Read, argument_option));
|
|
},
|
|
"write" => {
|
|
options.push((OpenOption::Write, argument_option));
|
|
},
|
|
_ => (),
|
|
}
|
|
|
|
get_open_options(cx, &arguments[0], options);
|
|
}
|
|
}
|
|
}
|
|
|
|
fn check_open_options(cx: &LateContext<'_>, options: &[(OpenOption, Argument)], span: Span) {
|
|
let (mut create, mut append, mut truncate, mut read, mut write) = (false, false, false, false, false);
|
|
let (mut create_arg, mut append_arg, mut truncate_arg, mut read_arg, mut write_arg) =
|
|
(false, false, false, false, false);
|
|
// This code is almost duplicated (oh, the irony), but I haven't found a way to
|
|
// unify it.
|
|
|
|
for option in options {
|
|
match *option {
|
|
(OpenOption::Create, arg) => {
|
|
if create {
|
|
span_lint(
|
|
cx,
|
|
NONSENSICAL_OPEN_OPTIONS,
|
|
span,
|
|
"the method `create` is called more than once",
|
|
);
|
|
} else {
|
|
create = true
|
|
}
|
|
create_arg = create_arg || (arg == Argument::True);
|
|
},
|
|
(OpenOption::Append, arg) => {
|
|
if append {
|
|
span_lint(
|
|
cx,
|
|
NONSENSICAL_OPEN_OPTIONS,
|
|
span,
|
|
"the method `append` is called more than once",
|
|
);
|
|
} else {
|
|
append = true
|
|
}
|
|
append_arg = append_arg || (arg == Argument::True);
|
|
},
|
|
(OpenOption::Truncate, arg) => {
|
|
if truncate {
|
|
span_lint(
|
|
cx,
|
|
NONSENSICAL_OPEN_OPTIONS,
|
|
span,
|
|
"the method `truncate` is called more than once",
|
|
);
|
|
} else {
|
|
truncate = true
|
|
}
|
|
truncate_arg = truncate_arg || (arg == Argument::True);
|
|
},
|
|
(OpenOption::Read, arg) => {
|
|
if read {
|
|
span_lint(
|
|
cx,
|
|
NONSENSICAL_OPEN_OPTIONS,
|
|
span,
|
|
"the method `read` is called more than once",
|
|
);
|
|
} else {
|
|
read = true
|
|
}
|
|
read_arg = read_arg || (arg == Argument::True);
|
|
},
|
|
(OpenOption::Write, arg) => {
|
|
if write {
|
|
span_lint(
|
|
cx,
|
|
NONSENSICAL_OPEN_OPTIONS,
|
|
span,
|
|
"the method `write` is called more than once",
|
|
);
|
|
} else {
|
|
write = true
|
|
}
|
|
write_arg = write_arg || (arg == Argument::True);
|
|
},
|
|
}
|
|
}
|
|
|
|
if read && truncate && read_arg && truncate_arg && !(write && write_arg) {
|
|
span_lint(
|
|
cx,
|
|
NONSENSICAL_OPEN_OPTIONS,
|
|
span,
|
|
"file opened with `truncate` and `read`",
|
|
);
|
|
}
|
|
if append && truncate && append_arg && truncate_arg {
|
|
span_lint(
|
|
cx,
|
|
NONSENSICAL_OPEN_OPTIONS,
|
|
span,
|
|
"file opened with `append` and `truncate`",
|
|
);
|
|
}
|
|
}
|