clippy_utils/

check_proc_macro.rs

//! This module handles checking if the span given is from a proc-macro or not.
//!
//! Proc-macros are capable of setting the span of every token they output to a few possible spans.
//! This includes spans we can detect easily as coming from a proc-macro (e.g. the call site
//! or the def site), and spans we can't easily detect as such (e.g. the span of any token
//! passed into the proc macro). This capability means proc-macros are capable of generating code
//! with a span that looks like it was written by the user, but which should not be linted by clippy
//! as it was generated by an external macro.
//!
//! That brings us to this module. The current approach is to determine a small bit of text which
//! must exist at both the start and the end of an item (e.g. an expression or a path) assuming the
//! code was written, and check if the span contains that text. Note this will only work correctly
//! if the span is not from a `macro_rules` based macro.

use rustc_abi::ExternAbi;
use rustc_ast as ast;
use rustc_ast::AttrStyle;
use rustc_ast::ast::{
    AttrKind, Attribute, GenericArgs, IntTy, LitIntType, LitKind, StrStyle, TraitObjectSyntax, UintTy,
};
use rustc_ast::token::CommentKind;
use rustc_hir::intravisit::FnKind;
use rustc_hir::{
    Block, BlockCheckMode, Body, BoundConstness, BoundPolarity, Closure, Destination, Expr, ExprKind, FieldDef,
    FnHeader, FnRetTy, HirId, Impl, ImplItem, ImplItemImplKind, ImplItemKind, IsAuto, Item, ItemKind, Lit, LoopSource,
    MatchSource, MutTy, Node, Path, PolyTraitRef, QPath, Safety, TraitBoundModifiers, TraitImplHeader, TraitItem,
    TraitItemKind, TraitRef, Ty, TyKind, UnOp, UnsafeSource, Variant, VariantData, YieldSource,
};
use rustc_lint::{EarlyContext, LateContext, LintContext};
use rustc_middle::ty::TyCtxt;
use rustc_session::Session;
use rustc_span::symbol::{Ident, kw};
use rustc_span::{Span, Symbol, sym};

/// The search pattern to look for. Used by `span_matches_pat`
#[derive(Clone)]
pub enum Pat {
    /// A single string.
    Str(&'static str),
    /// Any of the given strings.
    MultiStr(&'static [&'static str]),
    /// Any of the given strings.
    OwnedMultiStr(Vec<String>),
    /// The string representation of the symbol.
    Sym(Symbol),
    /// Any decimal or hexadecimal digit depending on the location.
    Num,
    /// An attribute.
    Attr(Symbol),
}

/// Checks if the start and the end of the span's text matches the patterns. This will return false
/// if the span crosses multiple files or if source is not available.
fn span_matches_pat(sess: &Session, span: Span, start_pat: Pat, end_pat: Pat) -> bool {
    let pos = sess.source_map().lookup_byte_offset(span.lo());
    let Some(ref src) = pos.sf.src else {
        return false;
    };
    let end = span.hi() - pos.sf.start_pos;
    src.get(pos.pos.0 as usize..end.0 as usize).is_some_and(|s| {
        // Spans can be wrapped in a mixture or parenthesis, whitespace, and trailing commas.
        let start_str = s.trim_start_matches(|c: char| c.is_whitespace() || c == '(');
        let end_str = s.trim_end_matches(|c: char| c.is_whitespace() || c == ')' || c == ',');
        (match start_pat {
            Pat::Str(text) => start_str.starts_with(text),
            Pat::MultiStr(texts) => texts.iter().any(|s| start_str.starts_with(s)),
            Pat::OwnedMultiStr(texts) => texts.iter().any(|s| start_str.starts_with(s)),
            Pat::Sym(sym) => start_str.starts_with(sym.as_str()),
            Pat::Num => start_str.as_bytes().first().is_some_and(u8::is_ascii_digit),
            Pat::Attr(sym) => {
                let start_str = start_str
                    .strip_prefix("#[")
                    .or_else(|| start_str.strip_prefix("#!["))
                    .unwrap_or(start_str);
                start_str.trim_start().starts_with(sym.as_str())
            },
        } && match end_pat {
            Pat::Str(text) => end_str.ends_with(text),
            Pat::MultiStr(texts) => texts.iter().any(|s| end_str.ends_with(s)),
            Pat::OwnedMultiStr(texts) => texts.iter().any(|s| end_str.ends_with(s)),
            Pat::Sym(sym) => end_str.ends_with(sym.as_str()),
            Pat::Num => end_str.as_bytes().last().is_some_and(u8::is_ascii_hexdigit),
            Pat::Attr(_) => false,
        })
    })
}

/// Get the search patterns to use for the given literal
fn lit_search_pat(lit: &LitKind) -> (Pat, Pat) {
    match lit {
        LitKind::Str(_, StrStyle::Cooked) => (Pat::Str("\""), Pat::Str("\"")),
        LitKind::Str(_, StrStyle::Raw(0)) => (Pat::Str("r"), Pat::Str("\"")),
        LitKind::Str(_, StrStyle::Raw(_)) => (Pat::Str("r#"), Pat::Str("#")),
        LitKind::ByteStr(_, StrStyle::Cooked) => (Pat::Str("b\""), Pat::Str("\"")),
        LitKind::ByteStr(_, StrStyle::Raw(0)) => (Pat::Str("br\""), Pat::Str("\"")),
        LitKind::ByteStr(_, StrStyle::Raw(_)) => (Pat::Str("br#\""), Pat::Str("#")),
        LitKind::Byte(_) => (Pat::Str("b'"), Pat::Str("'")),
        LitKind::Char(_) => (Pat::Str("'"), Pat::Str("'")),
        LitKind::Int(_, LitIntType::Signed(IntTy::Isize)) => (Pat::Num, Pat::Str("isize")),
        LitKind::Int(_, LitIntType::Unsigned(UintTy::Usize)) => (Pat::Num, Pat::Str("usize")),
        LitKind::Int(..) => (Pat::Num, Pat::Num),
        LitKind::Float(..) => (Pat::Num, Pat::Str("")),
        LitKind::Bool(true) => (Pat::Str("true"), Pat::Str("true")),
        LitKind::Bool(false) => (Pat::Str("false"), Pat::Str("false")),
        _ => (Pat::Str(""), Pat::Str("")),
    }
}

/// Get the search patterns to use for the given path
fn qpath_search_pat(path: &QPath<'_>) -> (Pat, Pat) {
    match path {
        QPath::Resolved(ty, path) => {
            let start = if ty.is_some() {
                Pat::Str("<")
            } else {
                path.segments.first().map_or(Pat::Str(""), |seg| {
                    if seg.ident.name == kw::PathRoot {
                        Pat::Str("::")
                    } else {
                        Pat::Sym(seg.ident.name)
                    }
                })
            };
            let end = path.segments.last().map_or(Pat::Str(""), |seg| {
                if seg.args.is_some() {
                    Pat::Str(">")
                } else {
                    Pat::Sym(seg.ident.name)
                }
            });
            (start, end)
        },
        QPath::TypeRelative(_, name) => (Pat::Str(""), Pat::Sym(name.ident.name)),
    }
}

fn path_search_pat(path: &Path<'_>) -> (Pat, Pat) {
    let (head, tail) = match path.segments {
        [] => return (Pat::Str(""), Pat::Str("")),
        [p] => (Pat::Sym(p.ident.name), p),
        // QPath::Resolved can have a path that looks like `<Foo as Bar>::baz` where
        // the path (`Bar::baz`) has it's span covering the whole QPath.
        [.., tail] => (Pat::Str(""), tail),
    };
    (
        head,
        if tail.args.is_some() {
            Pat::Str(">")
        } else {
            Pat::Sym(tail.ident.name)
        },
    )
}

/// Get the search patterns to use for the given expression
fn expr_search_pat(tcx: TyCtxt<'_>, e: &Expr<'_>) -> (Pat, Pat) {
    fn expr_search_pat_inner(tcx: TyCtxt<'_>, e: &Expr<'_>, outer_span: Span) -> (Pat, Pat) {
        // The expression can have subexpressions in different contexts, in which case
        // building up a search pattern from the macro expansion would lead to false positives;
        // e.g. `return format!(..)` would be considered to be from a proc macro
        // if we build up a pattern for the macro expansion and compare it to the invocation `format!()`.
        // So instead we return an empty pattern such that `span_matches_pat` always returns true.
        if !e.span.eq_ctxt(outer_span) {
            return (Pat::Str(""), Pat::Str(""));
        }

        match e.kind {
            ExprKind::ConstBlock(_) => (Pat::Str("const"), Pat::Str("}")),
            // Parenthesis are trimmed from the text before the search patterns are matched.
            // See: `span_matches_pat`
            ExprKind::Tup([]) => (Pat::Str(")"), Pat::Str("(")),
            ExprKind::Unary(UnOp::Deref, e) => (Pat::Str("*"), expr_search_pat_inner(tcx, e, outer_span).1),
            ExprKind::Unary(UnOp::Not, e) => (Pat::Str("!"), expr_search_pat_inner(tcx, e, outer_span).1),
            ExprKind::Unary(UnOp::Neg, e) => (Pat::Str("-"), expr_search_pat_inner(tcx, e, outer_span).1),
            ExprKind::Lit(lit) => lit_search_pat(&lit.node),
            ExprKind::Array(_) | ExprKind::Repeat(..) => (Pat::Str("["), Pat::Str("]")),
            ExprKind::Call(e, []) | ExprKind::MethodCall(_, e, [], _) => {
                (expr_search_pat_inner(tcx, e, outer_span).0, Pat::Str("("))
            },
            ExprKind::Call(first, [.., last])
            | ExprKind::MethodCall(_, first, [.., last], _)
            | ExprKind::Binary(_, first, last)
            | ExprKind::Tup([first, .., last])
            | ExprKind::Assign(first, last, _)
            | ExprKind::AssignOp(_, first, last) => (
                expr_search_pat_inner(tcx, first, outer_span).0,
                expr_search_pat_inner(tcx, last, outer_span).1,
            ),
            ExprKind::Tup([e]) | ExprKind::DropTemps(e) => expr_search_pat_inner(tcx, e, outer_span),
            ExprKind::Cast(e, _) | ExprKind::Type(e, _) => (expr_search_pat_inner(tcx, e, outer_span).0, Pat::Str("")),
            ExprKind::Let(let_expr) => (Pat::Str("let"), expr_search_pat_inner(tcx, let_expr.init, outer_span).1),
            ExprKind::If(..) => (Pat::Str("if"), Pat::Str("}")),
            ExprKind::Loop(_, Some(_), _, _) | ExprKind::Block(_, Some(_)) => (Pat::Str("'"), Pat::Str("}")),
            ExprKind::Loop(_, None, LoopSource::Loop, _) => (Pat::Str("loop"), Pat::Str("}")),
            ExprKind::Loop(_, None, LoopSource::While, _) => (Pat::Str("while"), Pat::Str("}")),
            ExprKind::Loop(_, None, LoopSource::ForLoop, _) | ExprKind::Match(_, _, MatchSource::ForLoopDesugar) => {
                (Pat::Str("for"), Pat::Str("}"))
            },
            ExprKind::Match(_, _, MatchSource::Normal) => (Pat::Str("match"), Pat::Str("}")),
            ExprKind::Match(e, _, MatchSource::TryDesugar(_)) => {
                (expr_search_pat_inner(tcx, e, outer_span).0, Pat::Str("?"))
            },
            ExprKind::Match(e, _, MatchSource::AwaitDesugar) | ExprKind::Yield(e, YieldSource::Await { .. }) => {
                (expr_search_pat_inner(tcx, e, outer_span).0, Pat::Str("await"))
            },
            ExprKind::Closure(&Closure { body, .. }) => (
                Pat::Str(""),
                expr_search_pat_inner(tcx, tcx.hir_body(body).value, outer_span).1,
            ),
            ExprKind::Block(
                Block {
                    rules: BlockCheckMode::UnsafeBlock(UnsafeSource::UserProvided),
                    ..
                },
                None,
            ) => (Pat::Str("unsafe"), Pat::Str("}")),
            ExprKind::Block(_, None) => (Pat::Str("{"), Pat::Str("}")),
            ExprKind::Field(e, name) => (expr_search_pat_inner(tcx, e, outer_span).0, Pat::Sym(name.name)),
            ExprKind::Index(e, _, _) => (expr_search_pat_inner(tcx, e, outer_span).0, Pat::Str("]")),
            ExprKind::Path(ref path) => qpath_search_pat(path),
            ExprKind::AddrOf(_, _, e) => (Pat::Str("&"), expr_search_pat_inner(tcx, e, outer_span).1),
            ExprKind::Break(Destination { label: None, .. }, None) => (Pat::Str("break"), Pat::Str("break")),
            ExprKind::Break(Destination { label: Some(name), .. }, None) => {
                (Pat::Str("break"), Pat::Sym(name.ident.name))
            },
            ExprKind::Break(_, Some(e)) => (Pat::Str("break"), expr_search_pat_inner(tcx, e, outer_span).1),
            ExprKind::Continue(Destination { label: None, .. }) => (Pat::Str("continue"), Pat::Str("continue")),
            ExprKind::Continue(Destination { label: Some(name), .. }) => {
                (Pat::Str("continue"), Pat::Sym(name.ident.name))
            },
            ExprKind::Ret(None) => (Pat::Str("return"), Pat::Str("return")),
            ExprKind::Ret(Some(e)) => (Pat::Str("return"), expr_search_pat_inner(tcx, e, outer_span).1),
            ExprKind::Struct(path, _, _) => (qpath_search_pat(path).0, Pat::Str("}")),
            ExprKind::Yield(e, YieldSource::Yield) => (Pat::Str("yield"), expr_search_pat_inner(tcx, e, outer_span).1),
            _ => (Pat::Str(""), Pat::Str("")),
        }
    }

    expr_search_pat_inner(tcx, e, e.span)
}

fn fn_header_search_pat(header: FnHeader) -> Pat {
    if header.is_async() {
        Pat::Str("async")
    } else if matches!(header.constness, rustc_hir::Constness::Const { always: false }) {
        Pat::Str("const")
    } else if header.is_unsafe() {
        Pat::Str("unsafe")
    } else if header.abi != ExternAbi::Rust {
        Pat::Str("extern")
    } else {
        Pat::MultiStr(&["fn", "extern"])
    }
}

fn item_search_pat(item: &Item<'_>) -> (Pat, Pat) {
    let (start_pat, end_pat) = match &item.kind {
        ItemKind::ExternCrate(..) => (Pat::Str("extern"), Pat::Str(";")),
        ItemKind::Static(..) => (Pat::Str("static"), Pat::Str(";")),
        ItemKind::Const(..) => (Pat::Str("const"), Pat::Str(";")),
        ItemKind::Fn { sig, .. } => (fn_header_search_pat(sig.header), Pat::Str("")),
        ItemKind::ForeignMod { .. } => (Pat::Str("extern"), Pat::Str("}")),
        ItemKind::TyAlias(..) => (Pat::Str("type"), Pat::Str(";")),
        ItemKind::Enum(..) => (Pat::Str("enum"), Pat::Str("}")),
        ItemKind::Struct(_, _, VariantData::Struct { .. }) => (Pat::Str("struct"), Pat::Str("}")),
        ItemKind::Struct(..) => (Pat::Str("struct"), Pat::Str(";")),
        ItemKind::Union(..) => (Pat::Str("union"), Pat::Str("}")),
        ItemKind::Trait {
            safety: Safety::Unsafe, ..
        }
        | ItemKind::Impl(Impl {
            of_trait: Some(TraitImplHeader {
                safety: Safety::Unsafe, ..
            }),
            ..
        }) => (Pat::Str("unsafe"), Pat::Str("}")),
        ItemKind::Trait {
            is_auto: IsAuto::Yes, ..
        } => (Pat::Str("auto"), Pat::Str("}")),
        ItemKind::Trait { .. } => (Pat::Str("trait"), Pat::Str("}")),
        ItemKind::Impl(_) => (Pat::Str("impl"), Pat::Str("}")),
        ItemKind::Mod(..) => (Pat::Str("mod"), Pat::Str("")),
        ItemKind::Macro(_, def, _) => (
            Pat::Str(if def.macro_rules { "macro_rules" } else { "macro" }),
            Pat::Str(""),
        ),
        ItemKind::TraitAlias(..) => (Pat::Str("trait"), Pat::Str(";")),
        ItemKind::GlobalAsm { .. } => return (Pat::Str("global_asm"), Pat::Str("")),
        ItemKind::Use(..) => return (Pat::Str(""), Pat::Str("")),
    };
    if item.vis_span.is_empty() {
        (start_pat, end_pat)
    } else {
        (Pat::Str("pub"), end_pat)
    }
}

fn trait_item_search_pat(item: &TraitItem<'_>) -> (Pat, Pat) {
    match &item.kind {
        TraitItemKind::Const(..) => (Pat::Str("const"), Pat::Str(";")),
        TraitItemKind::Type(..) => (Pat::Str("type"), Pat::Str(";")),
        TraitItemKind::Fn(sig, ..) => (fn_header_search_pat(sig.header), Pat::Str("")),
    }
}

fn impl_item_search_pat(item: &ImplItem<'_>) -> (Pat, Pat) {
    let (mut start_pat, end_pat) = match &item.kind {
        ImplItemKind::Const(..) => (Pat::Str("const"), Pat::Str(";")),
        ImplItemKind::Type(..) => (Pat::Str("type"), Pat::Str(";")),
        ImplItemKind::Fn(sig, ..) => (fn_header_search_pat(sig.header), Pat::Str("")),
    };
    if let ImplItemImplKind::Inherent { vis_span, .. } = item.impl_kind
        && !vis_span.is_empty()
    {
        start_pat = Pat::Str("pub");
    }
    (start_pat, end_pat)
}

fn field_def_search_pat(def: &FieldDef<'_>) -> (Pat, Pat) {
    if def.vis_span.is_empty() {
        if def.is_positional() {
            (Pat::Str(""), Pat::Str(""))
        } else {
            (Pat::Sym(def.ident.name), Pat::Str(""))
        }
    } else {
        (Pat::Str("pub"), Pat::Str(""))
    }
}

fn variant_search_pat(v: &Variant<'_>) -> (Pat, Pat) {
    match v.data {
        VariantData::Struct { .. } => (Pat::Sym(v.ident.name), Pat::Str("}")),
        VariantData::Tuple(..) => (Pat::Sym(v.ident.name), Pat::Str("")),
        VariantData::Unit(..) => (Pat::Sym(v.ident.name), Pat::Sym(v.ident.name)),
    }
}

fn fn_kind_pat(tcx: TyCtxt<'_>, kind: &FnKind<'_>, body: &Body<'_>, hir_id: HirId) -> (Pat, Pat) {
    let (mut start_pat, end_pat) = match kind {
        FnKind::ItemFn(.., header) => (fn_header_search_pat(*header), Pat::Str("")),
        FnKind::Method(.., sig) => (fn_header_search_pat(sig.header), Pat::Str("")),
        FnKind::Closure => return (Pat::Str(""), expr_search_pat(tcx, body.value).1),
    };
    match tcx.hir_node(hir_id) {
        Node::Item(Item { vis_span, .. })
        | Node::ImplItem(ImplItem {
            impl_kind: ImplItemImplKind::Inherent { vis_span, .. },
            ..
        }) => {
            if !vis_span.is_empty() {
                start_pat = Pat::Str("pub");
            }
        },
        Node::ImplItem(_) | Node::TraitItem(_) => {},
        _ => start_pat = Pat::Str(""),
    }
    (start_pat, end_pat)
}

fn attr_search_pat(attr: &Attribute) -> (Pat, Pat) {
    match attr.kind {
        AttrKind::Normal(..) => {
            if let Some(name) = attr.name() {
                // NOTE: This will likely have false positives, like `allow = 1`
                (Pat::Attr(name), Pat::Str(""))
            } else {
                (Pat::Str("#"), Pat::Str("]"))
            }
        },
        AttrKind::Synthetic(..) => unreachable!(),
        AttrKind::DocComment(_kind @ CommentKind::Line, ..) => {
            if attr.style == AttrStyle::Outer {
                (Pat::Str("///"), Pat::Str(""))
            } else {
                (Pat::Str("//!"), Pat::Str(""))
            }
        },
        AttrKind::DocComment(_kind @ CommentKind::Block, ..) => {
            if attr.style == AttrStyle::Outer {
                (Pat::Str("/**"), Pat::Str("*/"))
            } else {
                (Pat::Str("/*!"), Pat::Str("*/"))
            }
        },
    }
}

fn ty_search_pat(ty: &Ty<'_>) -> (Pat, Pat) {
    match ty.kind {
        TyKind::Slice(..) | TyKind::Array(..) => (Pat::Str("["), Pat::Str("]")),
        TyKind::Ptr(MutTy { ty, .. }) => (Pat::Str("*"), ty_search_pat(ty).1),
        TyKind::Ref(_, MutTy { ty, .. }) => (Pat::Str("&"), ty_search_pat(ty).1),
        TyKind::FnPtr(fn_ptr) => (
            if fn_ptr.safety.is_unsafe() {
                Pat::Str("unsafe")
            } else if fn_ptr.abi != ExternAbi::Rust {
                Pat::Str("extern")
            } else {
                Pat::MultiStr(&["fn", "extern"])
            },
            match fn_ptr.decl.output {
                FnRetTy::DefaultReturn(_) => {
                    if let [.., ty] = fn_ptr.decl.inputs {
                        ty_search_pat(ty).1
                    } else {
                        Pat::Str("(")
                    }
                },
                FnRetTy::Return(ty) => ty_search_pat(ty).1,
            },
        ),
        TyKind::Never => (Pat::Str("!"), Pat::Str("!")),
        // Parenthesis are trimmed from the text before the search patterns are matched.
        // See: `span_matches_pat`
        TyKind::Tup([]) => (Pat::Str(")"), Pat::Str("(")),
        TyKind::Tup([ty]) => ty_search_pat(ty),
        TyKind::Tup([head, .., tail]) => (ty_search_pat(head).0, ty_search_pat(tail).1),
        TyKind::OpaqueDef(..) => (Pat::Str("impl"), Pat::Str("")),
        TyKind::Path(qpath) => qpath_search_pat(&qpath),
        TyKind::Infer(()) => (Pat::Str("_"), Pat::Str("_")),
        TyKind::UnsafeBinder(binder_ty) => (Pat::Str("unsafe"), ty_search_pat(binder_ty.inner_ty).1),
        TyKind::TraitObject(_, tagged_ptr) if let TraitObjectSyntax::Dyn = tagged_ptr.tag() => {
            (Pat::Str("dyn"), Pat::Str(""))
        },
        // NOTE: `TraitObject` is incomplete. It will always return true then.
        _ => (Pat::Str(""), Pat::Str("")),
    }
}

fn ast_ty_search_pat(ty: &ast::Ty) -> (Pat, Pat) {
    use ast::{Extern, FnRetTy, MutTy, Safety, TraitObjectSyntax, TyKind};

    match &ty.kind {
        TyKind::Slice(..) | TyKind::Array(..) => (Pat::Str("["), Pat::Str("]")),
        TyKind::Ptr(MutTy { ty, .. }) => (Pat::Str("*"), ast_ty_search_pat(ty).1),
        TyKind::Ref(_, MutTy { ty, .. }) | TyKind::PinnedRef(_, MutTy { ty, .. }) => {
            (Pat::Str("&"), ast_ty_search_pat(ty).1)
        },
        TyKind::FnPtr(fn_ptr) => (
            if let Safety::Unsafe(_) = fn_ptr.safety {
                Pat::Str("unsafe")
            } else if let Extern::Explicit(strlit, _) = fn_ptr.ext
                && strlit.symbol == sym::rust
            {
                Pat::MultiStr(&["fn", "extern"])
            } else {
                Pat::Str("extern")
            },
            match &fn_ptr.decl.output {
                FnRetTy::Default(_) => {
                    if let [.., param] = &*fn_ptr.decl.inputs {
                        ast_ty_search_pat(&param.ty).1
                    } else {
                        Pat::Str("(")
                    }
                },
                FnRetTy::Ty(ty) => ast_ty_search_pat(ty).1,
            },
        ),
        TyKind::Never => (Pat::Str("!"), Pat::Str("!")),
        // Parenthesis are trimmed from the text before the search patterns are matched.
        // See: `span_matches_pat`
        TyKind::Tup(tup) => match &**tup {
            [] => (Pat::Str(")"), Pat::Str("(")),
            [ty] => ast_ty_search_pat(ty),
            [head, .., tail] => (ast_ty_search_pat(head).0, ast_ty_search_pat(tail).1),
        },
        TyKind::ImplTrait(..) => (Pat::Str("impl"), Pat::Str("")),
        TyKind::Path(qself_path, path) => {
            let start = if qself_path.is_some() {
                Pat::Str("<")
            } else if let Some(first) = path.segments.first() {
                ident_search_pat(first.ident).0
            } else {
                // this shouldn't be possible, but sure
                Pat::Str("")
            };
            let end = if let Some(last) = path.segments.last() {
                match last.args.as_deref() {
                    // last `>` in `std::foo::Bar<T>`
                    Some(GenericArgs::AngleBracketed(_)) => Pat::Str(">"),
                    Some(GenericArgs::Parenthesized(par_args)) => match &par_args.output {
                        FnRetTy::Default(_) => {
                            if let Some(last) = par_args.inputs.last() {
                                // `B` in `(A, B)` -- `)` gets stripped
                                ast_ty_search_pat(last).1
                            } else {
                                // `(` in `()` -- `)` gets stripped
                                Pat::Str("(")
                            }
                        },
                        // `C` in `(A, B) -> C`
                        FnRetTy::Ty(ty) => ast_ty_search_pat(ty).1,
                    },
                    // last `..` in `(..)` -- `)` gets stripped
                    Some(GenericArgs::ParenthesizedElided(_)) => Pat::Str(".."),
                    // `bar` in `std::foo::bar`
                    None => ident_search_pat(last.ident).1,
                }
            } else {
                // this shouldn't be possible
                Pat::Str(
                    if qself_path.is_some() {
                        ">"  // last `>` in `<Vec as IntoIterator>`
                    } else {
                        ""
                    }
                )
            };
            (start, end)
        },
        TyKind::Infer => (Pat::Str("_"), Pat::Str("_")),
        TyKind::Paren(ty) => ast_ty_search_pat(ty),
        TyKind::UnsafeBinder(binder_ty) => (Pat::Str("unsafe"), ast_ty_search_pat(&binder_ty.inner_ty).1),
        TyKind::TraitObject(_, trait_obj_syntax) => {
            if let TraitObjectSyntax::Dyn = trait_obj_syntax {
                (Pat::Str("dyn"), Pat::Str(""))
            } else {
                // NOTE: `TraitObject` is incomplete. It will always return true then.
                (Pat::Str(""), Pat::Str(""))
            }
        },
        TyKind::MacCall(mac_call) => {
            let start = if let Some(first) = mac_call.path.segments.first() {
                ident_search_pat(first.ident).0
            } else {
                Pat::Str("")
            };
            (start, Pat::Str(""))
        },

        // implicit, so has no contents to match against
        TyKind::ImplicitSelf

        // experimental
        | TyKind::Pat(..)
        | TyKind::FieldOf(..)
        | TyKind::View(..)
        | TyKind::DirectConstArg(..)

        // unused
        | TyKind::CVarArgs

        // placeholder
        | TyKind::Dummy
        | TyKind::Err(_) => (Pat::Str(""), Pat::Str("")),
    }
}

// NOTE: can't `impl WithSearchPat for TraitRef`, because `TraitRef` doesn't have a `span` field
// (nor a method)
fn trait_ref_search_pat(trait_ref: &TraitRef<'_>) -> (Pat, Pat) {
    path_search_pat(trait_ref.path)
}

fn poly_trait_ref_search_pat(poly_trait_ref: &PolyTraitRef<'_>) -> (Pat, Pat) {
    // NOTE: unfortunately we can't use `bound_generic_params` to see whether the pattern starts with
    // `for<..>`, because if it's empty, we could have either `for<>` (nothing bound), or
    // no `for` at all
    let PolyTraitRef {
        modifiers: TraitBoundModifiers { constness, polarity },
        trait_ref,
        ..
    } = poly_trait_ref;

    let trait_ref_search_pat = trait_ref_search_pat(trait_ref);

    #[expect(
        clippy::unnecessary_lazy_evaluations,
        reason = "the closure in `or_else` has `match polarity`, which isn't free"
    )]
    let start = match constness {
        BoundConstness::Never => None,
        BoundConstness::Maybe(_) => Some(Pat::Str("[const]")),
        BoundConstness::Always(_) => Some(Pat::Str("const")),
    }
    .or_else(|| match polarity {
        BoundPolarity::Negative(_) => Some(Pat::Str("!")),
        BoundPolarity::Maybe(_) => Some(Pat::Str("?")),
        BoundPolarity::Positive => None,
    })
    .unwrap_or(trait_ref_search_pat.0);
    let end = trait_ref_search_pat.1;

    (start, end)
}

fn ident_search_pat(ident: Ident) -> (Pat, Pat) {
    (Pat::Sym(ident.name), Pat::Sym(ident.name))
}

pub trait WithSearchPat<'cx> {
    type Context: LintContext;
    fn search_pat(&self, cx: &Self::Context) -> (Pat, Pat);
    fn span(&self) -> Span;
}
macro_rules! impl_with_search_pat {
    (($cx_ident:ident: $cx_ty:ident<$cx_lt:lifetime>, $self:tt: $ty:ty) => $fn:ident($($args:tt)*)) => {
        impl<$cx_lt> WithSearchPat<$cx_lt> for $ty {
            type Context = $cx_ty<$cx_lt>;
            fn search_pat(&$self, $cx_ident: &Self::Context) -> (Pat, Pat) {
                $fn($($args)*)
            }
            fn span(&self) -> Span {
                self.span
            }
        }
    };
}
impl_with_search_pat!((cx: LateContext<'tcx>, self: Expr<'tcx>) => expr_search_pat(cx.tcx, self));
impl_with_search_pat!((_cx: LateContext<'tcx>, self: Item<'_>) => item_search_pat(self));
impl_with_search_pat!((_cx: LateContext<'tcx>, self: TraitItem<'_>) => trait_item_search_pat(self));
impl_with_search_pat!((_cx: LateContext<'tcx>, self: ImplItem<'_>) => impl_item_search_pat(self));
impl_with_search_pat!((_cx: LateContext<'tcx>, self: FieldDef<'_>) => field_def_search_pat(self));
impl_with_search_pat!((_cx: LateContext<'tcx>, self: Variant<'_>) => variant_search_pat(self));
impl_with_search_pat!((_cx: LateContext<'tcx>, self: Ty<'_>) => ty_search_pat(self));
impl_with_search_pat!((_cx: LateContext<'tcx>, self: Ident) => ident_search_pat(*self));
impl_with_search_pat!((_cx: LateContext<'tcx>, self: Lit) => lit_search_pat(&self.node));
impl_with_search_pat!((_cx: LateContext<'tcx>, self: Path<'_>) => path_search_pat(self));
impl_with_search_pat!((_cx: LateContext<'tcx>, self: PolyTraitRef<'_>) => poly_trait_ref_search_pat(self));

impl_with_search_pat!((_cx: EarlyContext<'tcx>, self: Attribute) => attr_search_pat(self));
impl_with_search_pat!((_cx: EarlyContext<'tcx>, self: ast::Ty) => ast_ty_search_pat(self));

impl<'cx> WithSearchPat<'cx> for (&FnKind<'cx>, &Body<'cx>, HirId, Span) {
    type Context = LateContext<'cx>;

    fn search_pat(&self, cx: &Self::Context) -> (Pat, Pat) {
        fn_kind_pat(cx.tcx, self.0, self.1, self.2)
    }

    fn span(&self) -> Span {
        self.3
    }
}

/// Checks if the item likely came from a proc-macro.
///
/// This should be called after `in_external_macro` and the initial pattern matching of the ast as
/// it is significantly slower than both of those.
pub fn is_from_proc_macro<'cx, T: WithSearchPat<'cx>>(cx: &T::Context, item: &T) -> bool {
    let (start_pat, end_pat) = item.search_pat(cx);
    !span_matches_pat(cx.sess(), item.span(), start_pat, end_pat)
}

/// Checks if the span actually refers to a match expression
pub fn is_span_match(cx: &impl LintContext, span: Span) -> bool {
    span_matches_pat(cx.sess(), span, Pat::Str("match"), Pat::Str("}"))
}

/// Checks if the span actually refers to an if expression
pub fn is_span_if(cx: &impl LintContext, span: Span) -> bool {
    span_matches_pat(cx.sess(), span, Pat::Str("if"), Pat::Str("}"))
}