Module macros 

Utilities for analyzing macro invocations and expansions.

Re-exports

use std::cell::Cell; 🔒

use std::sync::Arc; 🔒

use std::sync::OnceLock; 🔒

use crate::visitors::Descend; 🔒

use crate::visitors::for_each_expr_without_closures; 🔒

use crate::get_clippy_attr; 🔒

use crate::sym; 🔒

use arrayvec::ArrayVec; 🔒

use rustc_ast::FormatArgs; 🔒

use rustc_ast::FormatArgument; 🔒

use rustc_ast::FormatPlaceholder; 🔒

use rustc_data_structures::fx::FxHashMap; 🔒

use rustc_hir as hir; 🔒

use rustc_hir::Expr; 🔒

use rustc_hir::ExprKind; 🔒

use rustc_hir::HirId; 🔒

use rustc_hir::Node; 🔒

use rustc_hir::QPath; 🔒

use rustc_lint::LateContext; 🔒

use rustc_span::def_id::DefId; 🔒

use rustc_span::hygiene; 🔒

use rustc_span::hygiene::MacroKind; 🔒

use rustc_span::hygiene::SyntaxContext; 🔒

use rustc_span::BytePos; 🔒

use rustc_span::ExpnData; 🔒

use rustc_span::ExpnId; 🔒

use rustc_span::ExpnKind; 🔒

use rustc_span::Span; 🔒

use rustc_span::SpanData; 🔒

use rustc_span::Symbol; 🔒

use std::ops::ControlFlow; 🔒

Macros

impl_hir_node 🔒

Structs

FormatArgsStorage

Stores AST [FormatArgs] nodes for use in late lint passes, as they are in a desugared form in the HIR

MacroCall

A macro call, like vec![1, 2, 3].

Enums

FormatParamUsage

Where a format parameter is being used in the format string

PanicCall

A call to a function in std::rt or core::panicking that results in a panic, typically part of a panic!() expansion (often wrapped in a block) but may be called directly by other macros such as assert.

Constants

FORMAT_MACRO_DIAG_ITEMS 🔒

LAST_FIRST_NODE_IN_MACRO 🔒

Traits

HirNode

A node with a HirId and a Span

Functions

expn_backtrace

Returns an iterator of expansions that created the given span

expn_is_local

Checks whether the expansion is the root expansion or a locally defined macro

find_assert_args

Finds the arguments of an assert! or debug_assert! macro call within the macro expansion

find_assert_args_inner 🔒

find_assert_eq_args

Finds the arguments of an assert_eq! or debug_assert_eq! macro call within the macro expansion

find_assert_within_debug_assert 🔒

find_format_arg_expr

Attempt to find the [rustc_hir::Expr] that corresponds to the [FormatArgument]’s value

first_node_in_macro

If node is the “first node” in a macro expansion, returns Some with the ExpnId of the macro call site (i.e. the parent of the macro expansion).

first_node_in_macro_uncached 🔒

first_node_macro_backtrace

Like macro_backtrace, but only returns macro calls where node is the “first node” of the macro call, as in first_node_in_macro.

format_arg_removal_span

Returns the [Span] of the value at index extended to the previous comma, e.g. for the value 10

format_args_inputs_span

Span covering the format string and values

format_placeholder_format_span

Span of the : and format specifiers

is_assert_arg 🔒

is_assert_macro

Is def_id of assert! or debug_assert!

is_format_macro

Returns true if a given Macro DefId is a format macro (e.g. println!)

is_panic

Is def_id of std::panic, core::panic or any inner implementation macros

macro_backtrace

Returns an iterator of macro expansions that created the given span. Note that desugaring expansions are skipped.

matching_root_macro_call

A combination of root_macro_call and is_diagnostic_item that returns a MacroCall at the root expansion if only it matches the given name.

root_macro_call

If the macro backtrace of span has a macro call at the root expansion (i.e. not a nested macro call), returns Some with the MacroCall

root_macro_call_first_node

Like root_macro_call, but only returns Some if node is the “first node” produced by the macro call, as in first_node_in_macro.

span_is_local

Checks whether the span is from the root expansion or a locally defined macro