1 use clippy_utils::diagnostics::{span_lint, span_lint_and_sugg};
2 use clippy_utils::source::snippet_opt;
3 use rustc_errors::Applicability;
4 use rustc_hir::{Expr, ExprKind};
5 use rustc_lint::{LateContext, LateLintPass};
6 use rustc_session::{declare_lint_pass, declare_tool_lint};
10 declare_clippy_lint! {
12 /// Checks for usage of the `offset` pointer method with a `usize` casted to an
15 /// ### Why is this bad?
16 /// If we’re always increasing the pointer address, we can avoid the numeric
17 /// cast by using the `add` method instead.
21 /// let vec = vec![b'a', b'b', b'c'];
22 /// let ptr = vec.as_ptr();
23 /// let offset = 1_usize;
26 /// ptr.offset(offset as isize);
33 /// let vec = vec![b'a', b'b', b'c'];
34 /// let ptr = vec.as_ptr();
35 /// let offset = 1_usize;
41 #[clippy::version = "1.30.0"]
42 pub PTR_OFFSET_WITH_CAST,
44 "unneeded pointer offset cast"
47 declare_lint_pass!(PtrOffsetWithCast => [PTR_OFFSET_WITH_CAST]);
49 impl<'tcx> LateLintPass<'tcx> for PtrOffsetWithCast {
50 fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
51 // Check if the expressions is a ptr.offset or ptr.wrapping_offset method call
52 let Some((receiver_expr, arg_expr, method)) = expr_as_ptr_offset_call(cx, expr) else {
56 // Check if the argument to the method call is a cast from usize
57 let Some(cast_lhs_expr) = expr_as_cast_from_usize(cx, arg_expr) else {
61 let msg = format!("use of `{method}` with a `usize` casted to an `isize`");
62 if let Some(sugg) = build_suggestion(cx, method, receiver_expr, cast_lhs_expr) {
70 Applicability::MachineApplicable,
73 span_lint(cx, PTR_OFFSET_WITH_CAST, expr.span, &msg);
78 // If the given expression is a cast from a usize, return the lhs of the cast
79 fn expr_as_cast_from_usize<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'tcx>) -> Option<&'tcx Expr<'tcx>> {
80 if let ExprKind::Cast(cast_lhs_expr, _) = expr.kind {
81 if is_expr_ty_usize(cx, cast_lhs_expr) {
82 return Some(cast_lhs_expr);
88 // If the given expression is a ptr::offset or ptr::wrapping_offset method call, return the
89 // receiver, the arg of the method call, and the method.
90 fn expr_as_ptr_offset_call<'tcx>(
91 cx: &LateContext<'tcx>,
93 ) -> Option<(&'tcx Expr<'tcx>, &'tcx Expr<'tcx>, Method)> {
94 if let ExprKind::MethodCall(path_segment, arg_0, [arg_1, ..], _) = &expr.kind {
95 if is_expr_ty_raw_ptr(cx, arg_0) {
96 if path_segment.ident.name == sym::offset {
97 return Some((arg_0, arg_1, Method::Offset));
99 if path_segment.ident.name == sym!(wrapping_offset) {
100 return Some((arg_0, arg_1, Method::WrappingOffset));
107 // Is the type of the expression a usize?
108 fn is_expr_ty_usize<'tcx>(cx: &LateContext<'tcx>, expr: &Expr<'_>) -> bool {
109 cx.typeck_results().expr_ty(expr) == cx.tcx.types.usize
112 // Is the type of the expression a raw pointer?
113 fn is_expr_ty_raw_ptr<'tcx>(cx: &LateContext<'tcx>, expr: &Expr<'_>) -> bool {
114 cx.typeck_results().expr_ty(expr).is_unsafe_ptr()
117 fn build_suggestion<'tcx>(
118 cx: &LateContext<'tcx>,
120 receiver_expr: &Expr<'_>,
121 cast_lhs_expr: &Expr<'_>,
122 ) -> Option<String> {
123 let receiver = snippet_opt(cx, receiver_expr.span)?;
124 let cast_lhs = snippet_opt(cx, cast_lhs_expr.span)?;
125 Some(format!("{receiver}.{}({cast_lhs})", method.suggestion()))
128 #[derive(Copy, Clone)]
136 fn suggestion(self) -> &'static str {
138 Self::Offset => "add",
139 Self::WrappingOffset => "wrapping_add",
144 impl fmt::Display for Method {
145 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
147 Self::Offset => write!(f, "offset"),
148 Self::WrappingOffset => write!(f, "wrapping_offset"),