rustc_hir/
intravisit.rs

1//! HIR walker for walking the contents of nodes.
2//!
3//! Here are the three available patterns for the visitor strategy,
4//! in roughly the order of desirability:
5//!
6//! 1. **Shallow visit**: Get a simple callback for every item (or item-like thing) in the HIR.
7//!    - Example: find all items with a `#[foo]` attribute on them.
8//!    - How: Use the `hir_crate_items` or `hir_module_items` query to traverse over item-like ids
9//!       (ItemId, TraitItemId, etc.) and use tcx.def_kind and `tcx.hir_item*(id)` to filter and
10//!       access actual item-like thing, respectively.
11//!    - Pro: Efficient; just walks the lists of item ids and gives users control whether to access
12//!       the hir_owners themselves or not.
13//!    - Con: Don't get information about nesting
14//!    - Con: Don't have methods for specific bits of HIR, like "on
15//!      every expr, do this".
16//! 2. **Deep visit**: Want to scan for specific kinds of HIR nodes within
17//!    an item, but don't care about how item-like things are nested
18//!    within one another.
19//!    - Example: Examine each expression to look for its type and do some check or other.
20//!    - How: Implement `intravisit::Visitor` and override the `NestedFilter` type to
21//!      `nested_filter::OnlyBodies` (and implement `maybe_tcx`), and use
22//!      `tcx.hir_visit_all_item_likes_in_crate(&mut visitor)`. Within your
23//!      `intravisit::Visitor` impl, implement methods like `visit_expr()` (don't forget to invoke
24//!      `intravisit::walk_expr()` to keep walking the subparts).
25//!    - Pro: Visitor methods for any kind of HIR node, not just item-like things.
26//!    - Pro: Integrates well into dependency tracking.
27//!    - Con: Don't get information about nesting between items
28//! 3. **Nested visit**: Want to visit the whole HIR and you care about the nesting between
29//!    item-like things.
30//!    - Example: Lifetime resolution, which wants to bring lifetimes declared on the
31//!      impl into scope while visiting the impl-items, and then back out again.
32//!    - How: Implement `intravisit::Visitor` and override the `NestedFilter` type to
33//!      `nested_filter::All` (and implement `maybe_tcx`). Walk your crate with
34//!      `tcx.hir_walk_toplevel_module(visitor)`.
35//!    - Pro: Visitor methods for any kind of HIR node, not just item-like things.
36//!    - Pro: Preserves nesting information
37//!    - Con: Does not integrate well into dependency tracking.
38//!
39//! If you have decided to use this visitor, here are some general
40//! notes on how to do so:
41//!
42//! Each overridden visit method has full control over what
43//! happens with its node, it can do its own traversal of the node's children,
44//! call `intravisit::walk_*` to apply the default traversal algorithm, or prevent
45//! deeper traversal by doing nothing.
46//!
47//! When visiting the HIR, the contents of nested items are NOT visited
48//! by default. This is different from the AST visitor, which does a deep walk.
49//! Hence this module is called `intravisit`; see the method `visit_nested_item`
50//! for more details.
51//!
52//! Note: it is an important invariant that the default visitor walks
53//! the body of a function in "execution order" - more concretely, if
54//! we consider the reverse post-order (RPO) of the CFG implied by the HIR,
55//! then a pre-order traversal of the HIR is consistent with the CFG RPO
56//! on the *initial CFG point* of each HIR node, while a post-order traversal
57//! of the HIR is consistent with the CFG RPO on each *final CFG point* of
58//! each CFG node.
59//!
60//! One thing that follows is that if HIR node A always starts/ends executing
61//! before HIR node B, then A appears in traversal pre/postorder before B,
62//! respectively. (This follows from RPO respecting CFG domination).
63//!
64//! This order consistency is required in a few places in rustc, for
65//! example coroutine inference, and possibly also HIR borrowck.
66
67use rustc_ast::Label;
68use rustc_ast::visit::{VisitorResult, try_visit, visit_opt, walk_list};
69use rustc_span::def_id::LocalDefId;
70use rustc_span::{Ident, Span, Symbol};
71
72use crate::hir::*;
73
74pub trait IntoVisitor<'hir> {
75    type Visitor: Visitor<'hir>;
76    fn into_visitor(&self) -> Self::Visitor;
77}
78
79#[derive(Copy, Clone, Debug)]
80pub enum FnKind<'a> {
81    /// `#[xxx] pub async/const/extern "Abi" fn foo()`
82    ItemFn(Ident, &'a Generics<'a>, FnHeader),
83
84    /// `fn foo(&self)`
85    Method(Ident, &'a FnSig<'a>),
86
87    /// `|x, y| {}`
88    Closure,
89}
90
91impl<'a> FnKind<'a> {
92    pub fn header(&self) -> Option<&FnHeader> {
93        match *self {
94            FnKind::ItemFn(_, _, ref header) => Some(header),
95            FnKind::Method(_, ref sig) => Some(&sig.header),
96            FnKind::Closure => None,
97        }
98    }
99
100    pub fn constness(self) -> Constness {
101        self.header().map_or(Constness::NotConst, |header| header.constness)
102    }
103
104    pub fn asyncness(self) -> IsAsync {
105        self.header().map_or(IsAsync::NotAsync, |header| header.asyncness)
106    }
107}
108
109/// HIR things retrievable from `TyCtxt`, avoiding an explicit dependence on
110/// `TyCtxt`. The only impls are for `!` (where these functions are never
111/// called) and `TyCtxt` (in `rustc_middle`).
112pub trait HirTyCtxt<'hir> {
113    /// Retrieves the `Node` corresponding to `id`.
114    fn hir_node(&self, hir_id: HirId) -> Node<'hir>;
115    fn hir_body(&self, id: BodyId) -> &'hir Body<'hir>;
116    fn hir_item(&self, id: ItemId) -> &'hir Item<'hir>;
117    fn hir_trait_item(&self, id: TraitItemId) -> &'hir TraitItem<'hir>;
118    fn hir_impl_item(&self, id: ImplItemId) -> &'hir ImplItem<'hir>;
119    fn hir_foreign_item(&self, id: ForeignItemId) -> &'hir ForeignItem<'hir>;
120}
121
122// Used when no tcx is actually available, forcing manual implementation of nested visitors.
123impl<'hir> HirTyCtxt<'hir> for ! {
124    fn hir_node(&self, _: HirId) -> Node<'hir> {
125        unreachable!();
126    }
127    fn hir_body(&self, _: BodyId) -> &'hir Body<'hir> {
128        unreachable!();
129    }
130    fn hir_item(&self, _: ItemId) -> &'hir Item<'hir> {
131        unreachable!();
132    }
133    fn hir_trait_item(&self, _: TraitItemId) -> &'hir TraitItem<'hir> {
134        unreachable!();
135    }
136    fn hir_impl_item(&self, _: ImplItemId) -> &'hir ImplItem<'hir> {
137        unreachable!();
138    }
139    fn hir_foreign_item(&self, _: ForeignItemId) -> &'hir ForeignItem<'hir> {
140        unreachable!();
141    }
142}
143
144pub mod nested_filter {
145    use super::HirTyCtxt;
146
147    /// Specifies what nested things a visitor wants to visit. By "nested
148    /// things", we are referring to bits of HIR that are not directly embedded
149    /// within one another but rather indirectly, through a table in the crate.
150    /// This is done to control dependencies during incremental compilation: the
151    /// non-inline bits of HIR can be tracked and hashed separately.
152    ///
153    /// The most common choice is `OnlyBodies`, which will cause the visitor to
154    /// visit fn bodies for fns that it encounters, and closure bodies, but
155    /// skip over nested item-like things.
156    ///
157    /// See the comments at [`rustc_hir::intravisit`] for more details on the overall
158    /// visit strategy.
159    pub trait NestedFilter<'hir> {
160        type MaybeTyCtxt: HirTyCtxt<'hir>;
161
162        /// Whether the visitor visits nested "item-like" things.
163        /// E.g., item, impl-item.
164        const INTER: bool;
165        /// Whether the visitor visits "intra item-like" things.
166        /// E.g., function body, closure, `AnonConst`
167        const INTRA: bool;
168    }
169
170    /// Do not visit any nested things. When you add a new
171    /// "non-nested" thing, you will want to audit such uses to see if
172    /// they remain valid.
173    ///
174    /// Use this if you are only walking some particular kind of tree
175    /// (i.e., a type, or fn signature) and you don't want to thread a
176    /// `tcx` around.
177    pub struct None(());
178    impl NestedFilter<'_> for None {
179        type MaybeTyCtxt = !;
180        const INTER: bool = false;
181        const INTRA: bool = false;
182    }
183}
184
185use nested_filter::NestedFilter;
186
187/// Each method of the Visitor trait is a hook to be potentially
188/// overridden. Each method's default implementation recursively visits
189/// the substructure of the input via the corresponding `walk` method;
190/// e.g., the `visit_mod` method by default calls `intravisit::walk_mod`.
191///
192/// Note that this visitor does NOT visit nested items by default
193/// (this is why the module is called `intravisit`, to distinguish it
194/// from the AST's `visit` module, which acts differently). If you
195/// simply want to visit all items in the crate in some order, you
196/// should call `tcx.hir_visit_all_item_likes_in_crate`. Otherwise, see the comment
197/// on `visit_nested_item` for details on how to visit nested items.
198///
199/// If you want to ensure that your code handles every variant
200/// explicitly, you need to override each method. (And you also need
201/// to monitor future changes to `Visitor` in case a new method with a
202/// new default implementation gets introduced.)
203///
204/// Every `walk_*` method uses deconstruction to access fields of structs and
205/// enums. This will result in a compile error if a field is added, which makes
206/// it more likely the appropriate visit call will be added for it.
207pub trait Visitor<'v>: Sized {
208    // This type should not be overridden, it exists for convenient usage as `Self::MaybeTyCtxt`.
209    type MaybeTyCtxt: HirTyCtxt<'v> = <Self::NestedFilter as NestedFilter<'v>>::MaybeTyCtxt;
210
211    ///////////////////////////////////////////////////////////////////////////
212    // Nested items.
213
214    /// Override this type to control which nested HIR are visited; see
215    /// [`NestedFilter`] for details. If you override this type, you
216    /// must also override [`maybe_tcx`](Self::maybe_tcx).
217    ///
218    /// **If for some reason you want the nested behavior, but don't
219    /// have a `tcx` at your disposal:** then override the
220    /// `visit_nested_XXX` methods. If a new `visit_nested_XXX` variant is
221    /// added in the future, it will cause a panic which can be detected
222    /// and fixed appropriately.
223    type NestedFilter: NestedFilter<'v> = nested_filter::None;
224
225    /// The result type of the `visit_*` methods. Can be either `()`,
226    /// or `ControlFlow<T>`.
227    type Result: VisitorResult = ();
228
229    /// If `type NestedFilter` is set to visit nested items, this method
230    /// must also be overridden to provide a map to retrieve nested items.
231    fn maybe_tcx(&mut self) -> Self::MaybeTyCtxt {
232        panic!(
233            "maybe_tcx must be implemented or consider using \
234            `type NestedFilter = nested_filter::None` (the default)"
235        );
236    }
237
238    /// Invoked when a nested item is encountered. By default, when
239    /// `Self::NestedFilter` is `nested_filter::None`, this method does
240    /// nothing. **You probably don't want to override this method** --
241    /// instead, override [`Self::NestedFilter`] or use the "shallow" or
242    /// "deep" visit patterns described at
243    /// [`rustc_hir::intravisit`]. The only reason to override
244    /// this method is if you want a nested pattern but cannot supply a
245    /// `TyCtxt`; see `maybe_tcx` for advice.
246    fn visit_nested_item(&mut self, id: ItemId) -> Self::Result {
247        if Self::NestedFilter::INTER {
248            let item = self.maybe_tcx().hir_item(id);
249            try_visit!(self.visit_item(item));
250        }
251        Self::Result::output()
252    }
253
254    /// Like `visit_nested_item()`, but for trait items. See
255    /// `visit_nested_item()` for advice on when to override this
256    /// method.
257    fn visit_nested_trait_item(&mut self, id: TraitItemId) -> Self::Result {
258        if Self::NestedFilter::INTER {
259            let item = self.maybe_tcx().hir_trait_item(id);
260            try_visit!(self.visit_trait_item(item));
261        }
262        Self::Result::output()
263    }
264
265    /// Like `visit_nested_item()`, but for impl items. See
266    /// `visit_nested_item()` for advice on when to override this
267    /// method.
268    fn visit_nested_impl_item(&mut self, id: ImplItemId) -> Self::Result {
269        if Self::NestedFilter::INTER {
270            let item = self.maybe_tcx().hir_impl_item(id);
271            try_visit!(self.visit_impl_item(item));
272        }
273        Self::Result::output()
274    }
275
276    /// Like `visit_nested_item()`, but for foreign items. See
277    /// `visit_nested_item()` for advice on when to override this
278    /// method.
279    fn visit_nested_foreign_item(&mut self, id: ForeignItemId) -> Self::Result {
280        if Self::NestedFilter::INTER {
281            let item = self.maybe_tcx().hir_foreign_item(id);
282            try_visit!(self.visit_foreign_item(item));
283        }
284        Self::Result::output()
285    }
286
287    /// Invoked to visit the body of a function, method or closure. Like
288    /// `visit_nested_item`, does nothing by default unless you override
289    /// `Self::NestedFilter`.
290    fn visit_nested_body(&mut self, id: BodyId) -> Self::Result {
291        if Self::NestedFilter::INTRA {
292            let body = self.maybe_tcx().hir_body(id);
293            try_visit!(self.visit_body(body));
294        }
295        Self::Result::output()
296    }
297
298    fn visit_param(&mut self, param: &'v Param<'v>) -> Self::Result {
299        walk_param(self, param)
300    }
301
302    /// Visits the top-level item and (optionally) nested items / impl items. See
303    /// `visit_nested_item` for details.
304    fn visit_item(&mut self, i: &'v Item<'v>) -> Self::Result {
305        walk_item(self, i)
306    }
307
308    fn visit_body(&mut self, b: &Body<'v>) -> Self::Result {
309        walk_body(self, b)
310    }
311
312    ///////////////////////////////////////////////////////////////////////////
313
314    fn visit_id(&mut self, _hir_id: HirId) -> Self::Result {
315        Self::Result::output()
316    }
317    fn visit_name(&mut self, _name: Symbol) -> Self::Result {
318        Self::Result::output()
319    }
320    fn visit_ident(&mut self, ident: Ident) -> Self::Result {
321        walk_ident(self, ident)
322    }
323    fn visit_mod(&mut self, m: &'v Mod<'v>, _s: Span, _n: HirId) -> Self::Result {
324        walk_mod(self, m)
325    }
326    fn visit_foreign_item(&mut self, i: &'v ForeignItem<'v>) -> Self::Result {
327        walk_foreign_item(self, i)
328    }
329    fn visit_local(&mut self, l: &'v LetStmt<'v>) -> Self::Result {
330        walk_local(self, l)
331    }
332    fn visit_block(&mut self, b: &'v Block<'v>) -> Self::Result {
333        walk_block(self, b)
334    }
335    fn visit_stmt(&mut self, s: &'v Stmt<'v>) -> Self::Result {
336        walk_stmt(self, s)
337    }
338    fn visit_arm(&mut self, a: &'v Arm<'v>) -> Self::Result {
339        walk_arm(self, a)
340    }
341    fn visit_pat(&mut self, p: &'v Pat<'v>) -> Self::Result {
342        walk_pat(self, p)
343    }
344    fn visit_pat_field(&mut self, f: &'v PatField<'v>) -> Self::Result {
345        walk_pat_field(self, f)
346    }
347    fn visit_pat_expr(&mut self, expr: &'v PatExpr<'v>) -> Self::Result {
348        walk_pat_expr(self, expr)
349    }
350    fn visit_lit(&mut self, _hir_id: HirId, _lit: Lit, _negated: bool) -> Self::Result {
351        Self::Result::output()
352    }
353    fn visit_anon_const(&mut self, c: &'v AnonConst) -> Self::Result {
354        walk_anon_const(self, c)
355    }
356    fn visit_inline_const(&mut self, c: &'v ConstBlock) -> Self::Result {
357        walk_inline_const(self, c)
358    }
359
360    fn visit_generic_arg(&mut self, generic_arg: &'v GenericArg<'v>) -> Self::Result {
361        walk_generic_arg(self, generic_arg)
362    }
363
364    /// All types are treated as ambiguous types for the purposes of hir visiting in
365    /// order to ensure that visitors can handle infer vars without it being too error-prone.
366    ///
367    /// The [`Visitor::visit_infer`] method should be overridden in order to handle infer vars.
368    fn visit_ty(&mut self, t: &'v Ty<'v, AmbigArg>) -> Self::Result {
369        walk_ty(self, t)
370    }
371
372    /// All consts are treated as ambiguous consts for the purposes of hir visiting in
373    /// order to ensure that visitors can handle infer vars without it being too error-prone.
374    ///
375    /// The [`Visitor::visit_infer`] method should be overridden in order to handle infer vars.
376    fn visit_const_arg(&mut self, c: &'v ConstArg<'v, AmbigArg>) -> Self::Result {
377        walk_const_arg(self, c)
378    }
379
380    #[allow(unused_variables)]
381    fn visit_infer(&mut self, inf_id: HirId, inf_span: Span, kind: InferKind<'v>) -> Self::Result {
382        self.visit_id(inf_id)
383    }
384
385    fn visit_lifetime(&mut self, lifetime: &'v Lifetime) -> Self::Result {
386        walk_lifetime(self, lifetime)
387    }
388
389    fn visit_expr(&mut self, ex: &'v Expr<'v>) -> Self::Result {
390        walk_expr(self, ex)
391    }
392    fn visit_expr_field(&mut self, field: &'v ExprField<'v>) -> Self::Result {
393        walk_expr_field(self, field)
394    }
395    fn visit_pattern_type_pattern(&mut self, p: &'v TyPat<'v>) -> Self::Result {
396        walk_ty_pat(self, p)
397    }
398    fn visit_generic_param(&mut self, p: &'v GenericParam<'v>) -> Self::Result {
399        walk_generic_param(self, p)
400    }
401    fn visit_const_param_default(&mut self, _param: HirId, ct: &'v ConstArg<'v>) -> Self::Result {
402        walk_const_param_default(self, ct)
403    }
404    fn visit_generics(&mut self, g: &'v Generics<'v>) -> Self::Result {
405        walk_generics(self, g)
406    }
407    fn visit_where_predicate(&mut self, predicate: &'v WherePredicate<'v>) -> Self::Result {
408        walk_where_predicate(self, predicate)
409    }
410    fn visit_fn_ret_ty(&mut self, ret_ty: &'v FnRetTy<'v>) -> Self::Result {
411        walk_fn_ret_ty(self, ret_ty)
412    }
413    fn visit_fn_decl(&mut self, fd: &'v FnDecl<'v>) -> Self::Result {
414        walk_fn_decl(self, fd)
415    }
416    fn visit_fn(
417        &mut self,
418        fk: FnKind<'v>,
419        fd: &'v FnDecl<'v>,
420        b: BodyId,
421        _: Span,
422        id: LocalDefId,
423    ) -> Self::Result {
424        walk_fn(self, fk, fd, b, id)
425    }
426    fn visit_use(&mut self, path: &'v UsePath<'v>, hir_id: HirId) -> Self::Result {
427        walk_use(self, path, hir_id)
428    }
429    fn visit_trait_item(&mut self, ti: &'v TraitItem<'v>) -> Self::Result {
430        walk_trait_item(self, ti)
431    }
432    fn visit_trait_item_ref(&mut self, ii: &'v TraitItemId) -> Self::Result {
433        walk_trait_item_ref(self, *ii)
434    }
435    fn visit_impl_item(&mut self, ii: &'v ImplItem<'v>) -> Self::Result {
436        walk_impl_item(self, ii)
437    }
438    fn visit_foreign_item_ref(&mut self, ii: &'v ForeignItemId) -> Self::Result {
439        walk_foreign_item_ref(self, *ii)
440    }
441    fn visit_impl_item_ref(&mut self, ii: &'v ImplItemId) -> Self::Result {
442        walk_impl_item_ref(self, *ii)
443    }
444    fn visit_trait_ref(&mut self, t: &'v TraitRef<'v>) -> Self::Result {
445        walk_trait_ref(self, t)
446    }
447    fn visit_param_bound(&mut self, bounds: &'v GenericBound<'v>) -> Self::Result {
448        walk_param_bound(self, bounds)
449    }
450    fn visit_precise_capturing_arg(&mut self, arg: &'v PreciseCapturingArg<'v>) -> Self::Result {
451        walk_precise_capturing_arg(self, arg)
452    }
453    fn visit_poly_trait_ref(&mut self, t: &'v PolyTraitRef<'v>) -> Self::Result {
454        walk_poly_trait_ref(self, t)
455    }
456    fn visit_opaque_ty(&mut self, opaque: &'v OpaqueTy<'v>) -> Self::Result {
457        walk_opaque_ty(self, opaque)
458    }
459    fn visit_variant_data(&mut self, s: &'v VariantData<'v>) -> Self::Result {
460        walk_struct_def(self, s)
461    }
462    fn visit_field_def(&mut self, s: &'v FieldDef<'v>) -> Self::Result {
463        walk_field_def(self, s)
464    }
465    fn visit_enum_def(&mut self, enum_definition: &'v EnumDef<'v>) -> Self::Result {
466        walk_enum_def(self, enum_definition)
467    }
468    fn visit_variant(&mut self, v: &'v Variant<'v>) -> Self::Result {
469        walk_variant(self, v)
470    }
471    fn visit_label(&mut self, label: &'v Label) -> Self::Result {
472        walk_label(self, label)
473    }
474    // The span is that of the surrounding type/pattern/expr/whatever.
475    fn visit_qpath(&mut self, qpath: &'v QPath<'v>, id: HirId, _span: Span) -> Self::Result {
476        walk_qpath(self, qpath, id)
477    }
478    fn visit_path(&mut self, path: &Path<'v>, _id: HirId) -> Self::Result {
479        walk_path(self, path)
480    }
481    fn visit_path_segment(&mut self, path_segment: &'v PathSegment<'v>) -> Self::Result {
482        walk_path_segment(self, path_segment)
483    }
484    fn visit_generic_args(&mut self, generic_args: &'v GenericArgs<'v>) -> Self::Result {
485        walk_generic_args(self, generic_args)
486    }
487    fn visit_assoc_item_constraint(
488        &mut self,
489        constraint: &'v AssocItemConstraint<'v>,
490    ) -> Self::Result {
491        walk_assoc_item_constraint(self, constraint)
492    }
493    fn visit_attribute(&mut self, _attr: &'v Attribute) -> Self::Result {
494        Self::Result::output()
495    }
496    fn visit_defaultness(&mut self, defaultness: &'v Defaultness) -> Self::Result {
497        walk_defaultness(self, defaultness)
498    }
499    fn visit_inline_asm(&mut self, asm: &'v InlineAsm<'v>, id: HirId) -> Self::Result {
500        walk_inline_asm(self, asm, id)
501    }
502}
503
504pub trait VisitorExt<'v>: Visitor<'v> {
505    /// Extension trait method to visit types in unambiguous positions, this is not
506    /// directly on the [`Visitor`] trait as this method should never be overridden.
507    ///
508    /// Named `visit_ty_unambig` instead of `visit_unambig_ty` to aid in discovery
509    /// by IDes when `v.visit_ty` is written.
510    fn visit_ty_unambig(&mut self, t: &'v Ty<'v>) -> Self::Result {
511        walk_unambig_ty(self, t)
512    }
513    /// Extension trait method to visit consts in unambiguous positions, this is not
514    /// directly on the [`Visitor`] trait as this method should never be overridden.
515    ///
516    /// Named `visit_const_arg_unambig` instead of `visit_unambig_const_arg` to aid in
517    /// discovery by IDes when `v.visit_const_arg` is written.
518    fn visit_const_arg_unambig(&mut self, c: &'v ConstArg<'v>) -> Self::Result {
519        walk_unambig_const_arg(self, c)
520    }
521}
522impl<'v, V: Visitor<'v>> VisitorExt<'v> for V {}
523
524pub fn walk_param<'v, V: Visitor<'v>>(visitor: &mut V, param: &'v Param<'v>) -> V::Result {
525    let Param { hir_id, pat, ty_span: _, span: _ } = param;
526    try_visit!(visitor.visit_id(*hir_id));
527    visitor.visit_pat(pat)
528}
529
530pub fn walk_item<'v, V: Visitor<'v>>(visitor: &mut V, item: &'v Item<'v>) -> V::Result {
531    let Item { owner_id: _, kind, span: _, vis_span: _, has_delayed_lints: _ } = item;
532    try_visit!(visitor.visit_id(item.hir_id()));
533    match *kind {
534        ItemKind::ExternCrate(orig_name, ident) => {
535            visit_opt!(visitor, visit_name, orig_name);
536            try_visit!(visitor.visit_ident(ident));
537        }
538        ItemKind::Use(ref path, kind) => {
539            try_visit!(visitor.visit_use(path, item.hir_id()));
540            match kind {
541                UseKind::Single(ident) => try_visit!(visitor.visit_ident(ident)),
542                UseKind::Glob | UseKind::ListStem => {}
543            }
544        }
545        ItemKind::Static(_, ident, ref typ, body) => {
546            try_visit!(visitor.visit_ident(ident));
547            try_visit!(visitor.visit_ty_unambig(typ));
548            try_visit!(visitor.visit_nested_body(body));
549        }
550        ItemKind::Const(ident, ref generics, ref typ, body) => {
551            try_visit!(visitor.visit_ident(ident));
552            try_visit!(visitor.visit_generics(generics));
553            try_visit!(visitor.visit_ty_unambig(typ));
554            try_visit!(visitor.visit_nested_body(body));
555        }
556        ItemKind::Fn { ident, sig, generics, body: body_id, .. } => {
557            try_visit!(visitor.visit_ident(ident));
558            try_visit!(visitor.visit_fn(
559                FnKind::ItemFn(ident, generics, sig.header),
560                sig.decl,
561                body_id,
562                item.span,
563                item.owner_id.def_id,
564            ));
565        }
566        ItemKind::Macro(ident, _def, _kind) => {
567            try_visit!(visitor.visit_ident(ident));
568        }
569        ItemKind::Mod(ident, ref module) => {
570            try_visit!(visitor.visit_ident(ident));
571            try_visit!(visitor.visit_mod(module, item.span, item.hir_id()));
572        }
573        ItemKind::ForeignMod { abi: _, items } => {
574            walk_list!(visitor, visit_foreign_item_ref, items);
575        }
576        ItemKind::GlobalAsm { asm: _, fake_body } => {
577            // Visit the fake body, which contains the asm statement.
578            // Therefore we should not visit the asm statement again
579            // outside of the body, or some visitors won't have their
580            // typeck results set correctly.
581            try_visit!(visitor.visit_nested_body(fake_body));
582        }
583        ItemKind::TyAlias(ident, ref generics, ref ty) => {
584            try_visit!(visitor.visit_ident(ident));
585            try_visit!(visitor.visit_generics(generics));
586            try_visit!(visitor.visit_ty_unambig(ty));
587        }
588        ItemKind::Enum(ident, ref generics, ref enum_definition) => {
589            try_visit!(visitor.visit_ident(ident));
590            try_visit!(visitor.visit_generics(generics));
591            try_visit!(visitor.visit_enum_def(enum_definition));
592        }
593        ItemKind::Impl(Impl { generics, of_trait, self_ty, items }) => {
594            try_visit!(visitor.visit_generics(generics));
595            if let Some(TraitImplHeader {
596                constness: _,
597                safety: _,
598                polarity: _,
599                defaultness: _,
600                defaultness_span: _,
601                trait_ref,
602            }) = of_trait
603            {
604                try_visit!(visitor.visit_trait_ref(trait_ref));
605            }
606            try_visit!(visitor.visit_ty_unambig(self_ty));
607            walk_list!(visitor, visit_impl_item_ref, items);
608        }
609        ItemKind::Struct(ident, ref generics, ref struct_definition)
610        | ItemKind::Union(ident, ref generics, ref struct_definition) => {
611            try_visit!(visitor.visit_ident(ident));
612            try_visit!(visitor.visit_generics(generics));
613            try_visit!(visitor.visit_variant_data(struct_definition));
614        }
615        ItemKind::Trait(
616            _constness,
617            _is_auto,
618            _safety,
619            ident,
620            ref generics,
621            bounds,
622            trait_item_refs,
623        ) => {
624            try_visit!(visitor.visit_ident(ident));
625            try_visit!(visitor.visit_generics(generics));
626            walk_list!(visitor, visit_param_bound, bounds);
627            walk_list!(visitor, visit_trait_item_ref, trait_item_refs);
628        }
629        ItemKind::TraitAlias(ident, ref generics, bounds) => {
630            try_visit!(visitor.visit_ident(ident));
631            try_visit!(visitor.visit_generics(generics));
632            walk_list!(visitor, visit_param_bound, bounds);
633        }
634    }
635    V::Result::output()
636}
637
638pub fn walk_body<'v, V: Visitor<'v>>(visitor: &mut V, body: &Body<'v>) -> V::Result {
639    let Body { params, value } = body;
640    walk_list!(visitor, visit_param, *params);
641    visitor.visit_expr(*value)
642}
643
644pub fn walk_ident<'v, V: Visitor<'v>>(visitor: &mut V, ident: Ident) -> V::Result {
645    visitor.visit_name(ident.name)
646}
647
648pub fn walk_mod<'v, V: Visitor<'v>>(visitor: &mut V, module: &'v Mod<'v>) -> V::Result {
649    let Mod { spans: _, item_ids } = module;
650    walk_list!(visitor, visit_nested_item, item_ids.iter().copied());
651    V::Result::output()
652}
653
654pub fn walk_foreign_item<'v, V: Visitor<'v>>(
655    visitor: &mut V,
656    foreign_item: &'v ForeignItem<'v>,
657) -> V::Result {
658    let ForeignItem { ident, kind, owner_id: _, span: _, vis_span: _, has_delayed_lints: _ } =
659        foreign_item;
660    try_visit!(visitor.visit_id(foreign_item.hir_id()));
661    try_visit!(visitor.visit_ident(*ident));
662
663    match *kind {
664        ForeignItemKind::Fn(ref sig, param_idents, ref generics) => {
665            try_visit!(visitor.visit_generics(generics));
666            try_visit!(visitor.visit_fn_decl(sig.decl));
667            for ident in param_idents.iter().copied() {
668                visit_opt!(visitor, visit_ident, ident);
669            }
670        }
671        ForeignItemKind::Static(ref typ, _, _) => {
672            try_visit!(visitor.visit_ty_unambig(typ));
673        }
674        ForeignItemKind::Type => (),
675    }
676    V::Result::output()
677}
678
679pub fn walk_local<'v, V: Visitor<'v>>(visitor: &mut V, local: &'v LetStmt<'v>) -> V::Result {
680    // Intentionally visiting the expr first - the initialization expr
681    // dominates the local's definition.
682    let LetStmt { super_: _, pat, ty, init, els, hir_id, span: _, source: _ } = local;
683    visit_opt!(visitor, visit_expr, *init);
684    try_visit!(visitor.visit_id(*hir_id));
685    try_visit!(visitor.visit_pat(*pat));
686    visit_opt!(visitor, visit_block, *els);
687    visit_opt!(visitor, visit_ty_unambig, *ty);
688    V::Result::output()
689}
690
691pub fn walk_block<'v, V: Visitor<'v>>(visitor: &mut V, block: &'v Block<'v>) -> V::Result {
692    let Block { stmts, expr, hir_id, rules: _, span: _, targeted_by_break: _ } = block;
693    try_visit!(visitor.visit_id(*hir_id));
694    walk_list!(visitor, visit_stmt, *stmts);
695    visit_opt!(visitor, visit_expr, *expr);
696    V::Result::output()
697}
698
699pub fn walk_stmt<'v, V: Visitor<'v>>(visitor: &mut V, statement: &'v Stmt<'v>) -> V::Result {
700    let Stmt { kind, hir_id, span: _ } = statement;
701    try_visit!(visitor.visit_id(*hir_id));
702    match *kind {
703        StmtKind::Let(ref local) => visitor.visit_local(local),
704        StmtKind::Item(item) => visitor.visit_nested_item(item),
705        StmtKind::Expr(ref expression) | StmtKind::Semi(ref expression) => {
706            visitor.visit_expr(expression)
707        }
708    }
709}
710
711pub fn walk_arm<'v, V: Visitor<'v>>(visitor: &mut V, arm: &'v Arm<'v>) -> V::Result {
712    let Arm { hir_id, span: _, pat, guard, body } = arm;
713    try_visit!(visitor.visit_id(*hir_id));
714    try_visit!(visitor.visit_pat(*pat));
715    visit_opt!(visitor, visit_expr, *guard);
716    visitor.visit_expr(*body)
717}
718
719pub fn walk_ty_pat<'v, V: Visitor<'v>>(visitor: &mut V, pattern: &'v TyPat<'v>) -> V::Result {
720    let TyPat { kind, hir_id, span: _ } = pattern;
721    try_visit!(visitor.visit_id(*hir_id));
722    match *kind {
723        TyPatKind::Range(lower_bound, upper_bound) => {
724            try_visit!(visitor.visit_const_arg_unambig(lower_bound));
725            try_visit!(visitor.visit_const_arg_unambig(upper_bound));
726        }
727        TyPatKind::Or(patterns) => walk_list!(visitor, visit_pattern_type_pattern, patterns),
728        TyPatKind::Err(_) => (),
729    }
730    V::Result::output()
731}
732
733pub fn walk_pat<'v, V: Visitor<'v>>(visitor: &mut V, pattern: &'v Pat<'v>) -> V::Result {
734    let Pat { hir_id, kind, span, default_binding_modes: _ } = pattern;
735    try_visit!(visitor.visit_id(*hir_id));
736    match *kind {
737        PatKind::TupleStruct(ref qpath, children, _) => {
738            try_visit!(visitor.visit_qpath(qpath, *hir_id, *span));
739            walk_list!(visitor, visit_pat, children);
740        }
741        PatKind::Struct(ref qpath, fields, _) => {
742            try_visit!(visitor.visit_qpath(qpath, *hir_id, *span));
743            walk_list!(visitor, visit_pat_field, fields);
744        }
745        PatKind::Or(pats) => walk_list!(visitor, visit_pat, pats),
746        PatKind::Tuple(tuple_elements, _) => {
747            walk_list!(visitor, visit_pat, tuple_elements);
748        }
749        PatKind::Box(ref subpattern)
750        | PatKind::Deref(ref subpattern)
751        | PatKind::Ref(ref subpattern, _) => {
752            try_visit!(visitor.visit_pat(subpattern));
753        }
754        PatKind::Binding(_, _hir_id, ident, ref optional_subpattern) => {
755            try_visit!(visitor.visit_ident(ident));
756            visit_opt!(visitor, visit_pat, optional_subpattern);
757        }
758        PatKind::Expr(ref expression) => try_visit!(visitor.visit_pat_expr(expression)),
759        PatKind::Range(ref lower_bound, ref upper_bound, _) => {
760            visit_opt!(visitor, visit_pat_expr, lower_bound);
761            visit_opt!(visitor, visit_pat_expr, upper_bound);
762        }
763        PatKind::Missing | PatKind::Never | PatKind::Wild | PatKind::Err(_) => (),
764        PatKind::Slice(prepatterns, ref slice_pattern, postpatterns) => {
765            walk_list!(visitor, visit_pat, prepatterns);
766            visit_opt!(visitor, visit_pat, slice_pattern);
767            walk_list!(visitor, visit_pat, postpatterns);
768        }
769        PatKind::Guard(subpat, condition) => {
770            try_visit!(visitor.visit_pat(subpat));
771            try_visit!(visitor.visit_expr(condition));
772        }
773    }
774    V::Result::output()
775}
776
777pub fn walk_pat_field<'v, V: Visitor<'v>>(visitor: &mut V, field: &'v PatField<'v>) -> V::Result {
778    let PatField { hir_id, ident, pat, is_shorthand: _, span: _ } = field;
779    try_visit!(visitor.visit_id(*hir_id));
780    try_visit!(visitor.visit_ident(*ident));
781    visitor.visit_pat(*pat)
782}
783
784pub fn walk_pat_expr<'v, V: Visitor<'v>>(visitor: &mut V, expr: &'v PatExpr<'v>) -> V::Result {
785    let PatExpr { hir_id, span, kind } = expr;
786    try_visit!(visitor.visit_id(*hir_id));
787    match kind {
788        PatExprKind::Lit { lit, negated } => visitor.visit_lit(*hir_id, *lit, *negated),
789        PatExprKind::ConstBlock(c) => visitor.visit_inline_const(c),
790        PatExprKind::Path(qpath) => visitor.visit_qpath(qpath, *hir_id, *span),
791    }
792}
793
794pub fn walk_anon_const<'v, V: Visitor<'v>>(visitor: &mut V, constant: &'v AnonConst) -> V::Result {
795    let AnonConst { hir_id, def_id: _, body, span: _ } = constant;
796    try_visit!(visitor.visit_id(*hir_id));
797    visitor.visit_nested_body(*body)
798}
799
800pub fn walk_inline_const<'v, V: Visitor<'v>>(
801    visitor: &mut V,
802    constant: &'v ConstBlock,
803) -> V::Result {
804    let ConstBlock { hir_id, def_id: _, body } = constant;
805    try_visit!(visitor.visit_id(*hir_id));
806    visitor.visit_nested_body(*body)
807}
808
809pub fn walk_expr<'v, V: Visitor<'v>>(visitor: &mut V, expression: &'v Expr<'v>) -> V::Result {
810    let Expr { hir_id, kind, span } = expression;
811    try_visit!(visitor.visit_id(*hir_id));
812    match *kind {
813        ExprKind::Array(subexpressions) => {
814            walk_list!(visitor, visit_expr, subexpressions);
815        }
816        ExprKind::ConstBlock(ref const_block) => {
817            try_visit!(visitor.visit_inline_const(const_block))
818        }
819        ExprKind::Repeat(ref element, ref count) => {
820            try_visit!(visitor.visit_expr(element));
821            try_visit!(visitor.visit_const_arg_unambig(count));
822        }
823        ExprKind::Struct(ref qpath, fields, ref optional_base) => {
824            try_visit!(visitor.visit_qpath(qpath, *hir_id, *span));
825            walk_list!(visitor, visit_expr_field, fields);
826            match optional_base {
827                StructTailExpr::Base(base) => try_visit!(visitor.visit_expr(base)),
828                StructTailExpr::None | StructTailExpr::DefaultFields(_) => {}
829            }
830        }
831        ExprKind::Tup(subexpressions) => {
832            walk_list!(visitor, visit_expr, subexpressions);
833        }
834        ExprKind::Call(ref callee_expression, arguments) => {
835            try_visit!(visitor.visit_expr(callee_expression));
836            walk_list!(visitor, visit_expr, arguments);
837        }
838        ExprKind::MethodCall(ref segment, receiver, arguments, _) => {
839            try_visit!(visitor.visit_path_segment(segment));
840            try_visit!(visitor.visit_expr(receiver));
841            walk_list!(visitor, visit_expr, arguments);
842        }
843        ExprKind::Use(expr, _) => {
844            try_visit!(visitor.visit_expr(expr));
845        }
846        ExprKind::Binary(_, ref left_expression, ref right_expression) => {
847            try_visit!(visitor.visit_expr(left_expression));
848            try_visit!(visitor.visit_expr(right_expression));
849        }
850        ExprKind::AddrOf(_, _, ref subexpression) | ExprKind::Unary(_, ref subexpression) => {
851            try_visit!(visitor.visit_expr(subexpression));
852        }
853        ExprKind::Cast(ref subexpression, ref typ) | ExprKind::Type(ref subexpression, ref typ) => {
854            try_visit!(visitor.visit_expr(subexpression));
855            try_visit!(visitor.visit_ty_unambig(typ));
856        }
857        ExprKind::DropTemps(ref subexpression) => {
858            try_visit!(visitor.visit_expr(subexpression));
859        }
860        ExprKind::Let(LetExpr { span: _, pat, ty, init, recovered: _ }) => {
861            // match the visit order in walk_local
862            try_visit!(visitor.visit_expr(init));
863            try_visit!(visitor.visit_pat(pat));
864            visit_opt!(visitor, visit_ty_unambig, ty);
865        }
866        ExprKind::If(ref cond, ref then, ref else_opt) => {
867            try_visit!(visitor.visit_expr(cond));
868            try_visit!(visitor.visit_expr(then));
869            visit_opt!(visitor, visit_expr, else_opt);
870        }
871        ExprKind::Loop(ref block, ref opt_label, _, _) => {
872            visit_opt!(visitor, visit_label, opt_label);
873            try_visit!(visitor.visit_block(block));
874        }
875        ExprKind::Match(ref subexpression, arms, _) => {
876            try_visit!(visitor.visit_expr(subexpression));
877            walk_list!(visitor, visit_arm, arms);
878        }
879        ExprKind::Closure(&Closure {
880            def_id,
881            binder: _,
882            bound_generic_params,
883            fn_decl,
884            body,
885            capture_clause: _,
886            fn_decl_span: _,
887            fn_arg_span: _,
888            kind: _,
889            constness: _,
890        }) => {
891            walk_list!(visitor, visit_generic_param, bound_generic_params);
892            try_visit!(visitor.visit_fn(FnKind::Closure, fn_decl, body, *span, def_id));
893        }
894        ExprKind::Block(ref block, ref opt_label) => {
895            visit_opt!(visitor, visit_label, opt_label);
896            try_visit!(visitor.visit_block(block));
897        }
898        ExprKind::Assign(ref lhs, ref rhs, _) => {
899            try_visit!(visitor.visit_expr(rhs));
900            try_visit!(visitor.visit_expr(lhs));
901        }
902        ExprKind::AssignOp(_, ref left_expression, ref right_expression) => {
903            try_visit!(visitor.visit_expr(right_expression));
904            try_visit!(visitor.visit_expr(left_expression));
905        }
906        ExprKind::Field(ref subexpression, ident) => {
907            try_visit!(visitor.visit_expr(subexpression));
908            try_visit!(visitor.visit_ident(ident));
909        }
910        ExprKind::Index(ref main_expression, ref index_expression, _) => {
911            try_visit!(visitor.visit_expr(main_expression));
912            try_visit!(visitor.visit_expr(index_expression));
913        }
914        ExprKind::Path(ref qpath) => {
915            try_visit!(visitor.visit_qpath(qpath, *hir_id, *span));
916        }
917        ExprKind::Break(ref destination, ref opt_expr) => {
918            visit_opt!(visitor, visit_label, &destination.label);
919            visit_opt!(visitor, visit_expr, opt_expr);
920        }
921        ExprKind::Continue(ref destination) => {
922            visit_opt!(visitor, visit_label, &destination.label);
923        }
924        ExprKind::Ret(ref optional_expression) => {
925            visit_opt!(visitor, visit_expr, optional_expression);
926        }
927        ExprKind::Become(ref expr) => try_visit!(visitor.visit_expr(expr)),
928        ExprKind::InlineAsm(ref asm) => {
929            try_visit!(visitor.visit_inline_asm(asm, *hir_id));
930        }
931        ExprKind::OffsetOf(ref container, ref fields) => {
932            try_visit!(visitor.visit_ty_unambig(container));
933            walk_list!(visitor, visit_ident, fields.iter().copied());
934        }
935        ExprKind::Yield(ref subexpression, _) => {
936            try_visit!(visitor.visit_expr(subexpression));
937        }
938        ExprKind::UnsafeBinderCast(_kind, expr, ty) => {
939            try_visit!(visitor.visit_expr(expr));
940            visit_opt!(visitor, visit_ty_unambig, ty);
941        }
942        ExprKind::Lit(lit) => try_visit!(visitor.visit_lit(*hir_id, lit, false)),
943        ExprKind::Err(_) => {}
944    }
945    V::Result::output()
946}
947
948pub fn walk_expr_field<'v, V: Visitor<'v>>(visitor: &mut V, field: &'v ExprField<'v>) -> V::Result {
949    let ExprField { hir_id, ident, expr, span: _, is_shorthand: _ } = field;
950    try_visit!(visitor.visit_id(*hir_id));
951    try_visit!(visitor.visit_ident(*ident));
952    visitor.visit_expr(*expr)
953}
954/// We track whether an infer var is from a [`Ty`], [`ConstArg`], or [`GenericArg`] so that
955/// HIR visitors overriding [`Visitor::visit_infer`] can determine what kind of infer is being visited
956pub enum InferKind<'hir> {
957    Ty(&'hir Ty<'hir>),
958    Const(&'hir ConstArg<'hir>),
959    Ambig(&'hir InferArg),
960}
961
962pub fn walk_generic_arg<'v, V: Visitor<'v>>(
963    visitor: &mut V,
964    generic_arg: &'v GenericArg<'v>,
965) -> V::Result {
966    match generic_arg {
967        GenericArg::Lifetime(lt) => visitor.visit_lifetime(lt),
968        GenericArg::Type(ty) => visitor.visit_ty(ty),
969        GenericArg::Const(ct) => visitor.visit_const_arg(ct),
970        GenericArg::Infer(inf) => {
971            let InferArg { hir_id, span } = inf;
972            visitor.visit_infer(*hir_id, *span, InferKind::Ambig(inf))
973        }
974    }
975}
976
977pub fn walk_unambig_ty<'v, V: Visitor<'v>>(visitor: &mut V, typ: &'v Ty<'v>) -> V::Result {
978    match typ.try_as_ambig_ty() {
979        Some(ambig_ty) => visitor.visit_ty(ambig_ty),
980        None => {
981            let Ty { hir_id, span, kind: _ } = typ;
982            visitor.visit_infer(*hir_id, *span, InferKind::Ty(typ))
983        }
984    }
985}
986
987pub fn walk_ty<'v, V: Visitor<'v>>(visitor: &mut V, typ: &'v Ty<'v, AmbigArg>) -> V::Result {
988    let Ty { hir_id, span: _, kind } = typ;
989    try_visit!(visitor.visit_id(*hir_id));
990
991    match *kind {
992        TyKind::Slice(ref ty) => try_visit!(visitor.visit_ty_unambig(ty)),
993        TyKind::Ptr(ref mutable_type) => try_visit!(visitor.visit_ty_unambig(mutable_type.ty)),
994        TyKind::Ref(ref lifetime, ref mutable_type) => {
995            try_visit!(visitor.visit_lifetime(lifetime));
996            try_visit!(visitor.visit_ty_unambig(mutable_type.ty));
997        }
998        TyKind::Never => {}
999        TyKind::Tup(tuple_element_types) => {
1000            walk_list!(visitor, visit_ty_unambig, tuple_element_types);
1001        }
1002        TyKind::FnPtr(ref function_declaration) => {
1003            walk_list!(visitor, visit_generic_param, function_declaration.generic_params);
1004            try_visit!(visitor.visit_fn_decl(function_declaration.decl));
1005        }
1006        TyKind::UnsafeBinder(ref unsafe_binder) => {
1007            walk_list!(visitor, visit_generic_param, unsafe_binder.generic_params);
1008            try_visit!(visitor.visit_ty_unambig(unsafe_binder.inner_ty));
1009        }
1010        TyKind::Path(ref qpath) => {
1011            try_visit!(visitor.visit_qpath(qpath, typ.hir_id, typ.span));
1012        }
1013        TyKind::OpaqueDef(opaque) => {
1014            try_visit!(visitor.visit_opaque_ty(opaque));
1015        }
1016        TyKind::TraitAscription(bounds) => {
1017            walk_list!(visitor, visit_param_bound, bounds);
1018        }
1019        TyKind::Array(ref ty, ref length) => {
1020            try_visit!(visitor.visit_ty_unambig(ty));
1021            try_visit!(visitor.visit_const_arg_unambig(length));
1022        }
1023        TyKind::TraitObject(bounds, ref lifetime) => {
1024            for bound in bounds {
1025                try_visit!(visitor.visit_poly_trait_ref(bound));
1026            }
1027            try_visit!(visitor.visit_lifetime(lifetime));
1028        }
1029        TyKind::Typeof(ref expression) => try_visit!(visitor.visit_anon_const(expression)),
1030        TyKind::InferDelegation(..) | TyKind::Err(_) => {}
1031        TyKind::Pat(ty, pat) => {
1032            try_visit!(visitor.visit_ty_unambig(ty));
1033            try_visit!(visitor.visit_pattern_type_pattern(pat));
1034        }
1035    }
1036    V::Result::output()
1037}
1038
1039pub fn walk_unambig_const_arg<'v, V: Visitor<'v>>(
1040    visitor: &mut V,
1041    const_arg: &'v ConstArg<'v>,
1042) -> V::Result {
1043    match const_arg.try_as_ambig_ct() {
1044        Some(ambig_ct) => visitor.visit_const_arg(ambig_ct),
1045        None => {
1046            let ConstArg { hir_id, kind: _ } = const_arg;
1047            visitor.visit_infer(*hir_id, const_arg.span(), InferKind::Const(const_arg))
1048        }
1049    }
1050}
1051
1052pub fn walk_const_arg<'v, V: Visitor<'v>>(
1053    visitor: &mut V,
1054    const_arg: &'v ConstArg<'v, AmbigArg>,
1055) -> V::Result {
1056    let ConstArg { hir_id, kind } = const_arg;
1057    try_visit!(visitor.visit_id(*hir_id));
1058    match kind {
1059        ConstArgKind::Path(qpath) => visitor.visit_qpath(qpath, *hir_id, qpath.span()),
1060        ConstArgKind::Anon(anon) => visitor.visit_anon_const(*anon),
1061    }
1062}
1063
1064pub fn walk_generic_param<'v, V: Visitor<'v>>(
1065    visitor: &mut V,
1066    param: &'v GenericParam<'v>,
1067) -> V::Result {
1068    let GenericParam {
1069        hir_id,
1070        def_id: _,
1071        name,
1072        span: _,
1073        pure_wrt_drop: _,
1074        kind,
1075        colon_span: _,
1076        source: _,
1077    } = param;
1078    try_visit!(visitor.visit_id(*hir_id));
1079    match *name {
1080        ParamName::Plain(ident) | ParamName::Error(ident) => try_visit!(visitor.visit_ident(ident)),
1081        ParamName::Fresh => {}
1082    }
1083    match *kind {
1084        GenericParamKind::Lifetime { .. } => {}
1085        GenericParamKind::Type { ref default, .. } => {
1086            visit_opt!(visitor, visit_ty_unambig, default)
1087        }
1088        GenericParamKind::Const { ref ty, ref default, synthetic: _ } => {
1089            try_visit!(visitor.visit_ty_unambig(ty));
1090            if let Some(default) = default {
1091                try_visit!(visitor.visit_const_param_default(*hir_id, default));
1092            }
1093        }
1094    }
1095    V::Result::output()
1096}
1097
1098pub fn walk_const_param_default<'v, V: Visitor<'v>>(
1099    visitor: &mut V,
1100    ct: &'v ConstArg<'v>,
1101) -> V::Result {
1102    visitor.visit_const_arg_unambig(ct)
1103}
1104
1105pub fn walk_generics<'v, V: Visitor<'v>>(visitor: &mut V, generics: &'v Generics<'v>) -> V::Result {
1106    let &Generics {
1107        params,
1108        predicates,
1109        has_where_clause_predicates: _,
1110        where_clause_span: _,
1111        span: _,
1112    } = generics;
1113    walk_list!(visitor, visit_generic_param, params);
1114    walk_list!(visitor, visit_where_predicate, predicates);
1115    V::Result::output()
1116}
1117
1118pub fn walk_where_predicate<'v, V: Visitor<'v>>(
1119    visitor: &mut V,
1120    predicate: &'v WherePredicate<'v>,
1121) -> V::Result {
1122    let &WherePredicate { hir_id, kind, span: _ } = predicate;
1123    try_visit!(visitor.visit_id(hir_id));
1124    match *kind {
1125        WherePredicateKind::BoundPredicate(WhereBoundPredicate {
1126            ref bounded_ty,
1127            bounds,
1128            bound_generic_params,
1129            origin: _,
1130        }) => {
1131            try_visit!(visitor.visit_ty_unambig(bounded_ty));
1132            walk_list!(visitor, visit_param_bound, bounds);
1133            walk_list!(visitor, visit_generic_param, bound_generic_params);
1134        }
1135        WherePredicateKind::RegionPredicate(WhereRegionPredicate {
1136            ref lifetime,
1137            bounds,
1138            in_where_clause: _,
1139        }) => {
1140            try_visit!(visitor.visit_lifetime(lifetime));
1141            walk_list!(visitor, visit_param_bound, bounds);
1142        }
1143        WherePredicateKind::EqPredicate(WhereEqPredicate { ref lhs_ty, ref rhs_ty }) => {
1144            try_visit!(visitor.visit_ty_unambig(lhs_ty));
1145            try_visit!(visitor.visit_ty_unambig(rhs_ty));
1146        }
1147    }
1148    V::Result::output()
1149}
1150
1151pub fn walk_fn_decl<'v, V: Visitor<'v>>(
1152    visitor: &mut V,
1153    function_declaration: &'v FnDecl<'v>,
1154) -> V::Result {
1155    let FnDecl { inputs, output, c_variadic: _, implicit_self: _, lifetime_elision_allowed: _ } =
1156        function_declaration;
1157    walk_list!(visitor, visit_ty_unambig, *inputs);
1158    visitor.visit_fn_ret_ty(output)
1159}
1160
1161pub fn walk_fn_ret_ty<'v, V: Visitor<'v>>(visitor: &mut V, ret_ty: &'v FnRetTy<'v>) -> V::Result {
1162    if let FnRetTy::Return(output_ty) = *ret_ty {
1163        try_visit!(visitor.visit_ty_unambig(output_ty));
1164    }
1165    V::Result::output()
1166}
1167
1168pub fn walk_fn<'v, V: Visitor<'v>>(
1169    visitor: &mut V,
1170    function_kind: FnKind<'v>,
1171    function_declaration: &'v FnDecl<'v>,
1172    body_id: BodyId,
1173    _: LocalDefId,
1174) -> V::Result {
1175    try_visit!(visitor.visit_fn_decl(function_declaration));
1176    try_visit!(walk_fn_kind(visitor, function_kind));
1177    visitor.visit_nested_body(body_id)
1178}
1179
1180pub fn walk_fn_kind<'v, V: Visitor<'v>>(visitor: &mut V, function_kind: FnKind<'v>) -> V::Result {
1181    match function_kind {
1182        FnKind::ItemFn(_, generics, ..) => {
1183            try_visit!(visitor.visit_generics(generics));
1184        }
1185        FnKind::Closure | FnKind::Method(..) => {}
1186    }
1187    V::Result::output()
1188}
1189
1190pub fn walk_use<'v, V: Visitor<'v>>(
1191    visitor: &mut V,
1192    path: &'v UsePath<'v>,
1193    hir_id: HirId,
1194) -> V::Result {
1195    let UsePath { segments, ref res, span } = *path;
1196    for res in res.present_items() {
1197        try_visit!(visitor.visit_path(&Path { segments, res, span }, hir_id));
1198    }
1199    V::Result::output()
1200}
1201
1202pub fn walk_trait_item<'v, V: Visitor<'v>>(
1203    visitor: &mut V,
1204    trait_item: &'v TraitItem<'v>,
1205) -> V::Result {
1206    let TraitItem {
1207        ident,
1208        generics,
1209        ref defaultness,
1210        ref kind,
1211        span,
1212        owner_id: _,
1213        has_delayed_lints: _,
1214    } = *trait_item;
1215    let hir_id = trait_item.hir_id();
1216    try_visit!(visitor.visit_ident(ident));
1217    try_visit!(visitor.visit_generics(&generics));
1218    try_visit!(visitor.visit_defaultness(&defaultness));
1219    try_visit!(visitor.visit_id(hir_id));
1220    match *kind {
1221        TraitItemKind::Const(ref ty, default) => {
1222            try_visit!(visitor.visit_ty_unambig(ty));
1223            visit_opt!(visitor, visit_nested_body, default);
1224        }
1225        TraitItemKind::Fn(ref sig, TraitFn::Required(param_idents)) => {
1226            try_visit!(visitor.visit_fn_decl(sig.decl));
1227            for ident in param_idents.iter().copied() {
1228                visit_opt!(visitor, visit_ident, ident);
1229            }
1230        }
1231        TraitItemKind::Fn(ref sig, TraitFn::Provided(body_id)) => {
1232            try_visit!(visitor.visit_fn(
1233                FnKind::Method(ident, sig),
1234                sig.decl,
1235                body_id,
1236                span,
1237                trait_item.owner_id.def_id,
1238            ));
1239        }
1240        TraitItemKind::Type(bounds, ref default) => {
1241            walk_list!(visitor, visit_param_bound, bounds);
1242            visit_opt!(visitor, visit_ty_unambig, default);
1243        }
1244    }
1245    V::Result::output()
1246}
1247
1248pub fn walk_trait_item_ref<'v, V: Visitor<'v>>(visitor: &mut V, id: TraitItemId) -> V::Result {
1249    visitor.visit_nested_trait_item(id)
1250}
1251
1252pub fn walk_impl_item<'v, V: Visitor<'v>>(
1253    visitor: &mut V,
1254    impl_item: &'v ImplItem<'v>,
1255) -> V::Result {
1256    let ImplItem {
1257        owner_id: _,
1258        ident,
1259        ref generics,
1260        ref kind,
1261        ref defaultness,
1262        span: _,
1263        vis_span: _,
1264        has_delayed_lints: _,
1265        trait_item_def_id: _,
1266    } = *impl_item;
1267
1268    try_visit!(visitor.visit_ident(ident));
1269    try_visit!(visitor.visit_generics(generics));
1270    try_visit!(visitor.visit_defaultness(defaultness));
1271    try_visit!(visitor.visit_id(impl_item.hir_id()));
1272    match *kind {
1273        ImplItemKind::Const(ref ty, body) => {
1274            try_visit!(visitor.visit_ty_unambig(ty));
1275            visitor.visit_nested_body(body)
1276        }
1277        ImplItemKind::Fn(ref sig, body_id) => visitor.visit_fn(
1278            FnKind::Method(impl_item.ident, sig),
1279            sig.decl,
1280            body_id,
1281            impl_item.span,
1282            impl_item.owner_id.def_id,
1283        ),
1284        ImplItemKind::Type(ref ty) => visitor.visit_ty_unambig(ty),
1285    }
1286}
1287
1288pub fn walk_foreign_item_ref<'v, V: Visitor<'v>>(visitor: &mut V, id: ForeignItemId) -> V::Result {
1289    visitor.visit_nested_foreign_item(id)
1290}
1291
1292pub fn walk_impl_item_ref<'v, V: Visitor<'v>>(visitor: &mut V, id: ImplItemId) -> V::Result {
1293    visitor.visit_nested_impl_item(id)
1294}
1295
1296pub fn walk_trait_ref<'v, V: Visitor<'v>>(
1297    visitor: &mut V,
1298    trait_ref: &'v TraitRef<'v>,
1299) -> V::Result {
1300    let TraitRef { hir_ref_id, path } = trait_ref;
1301    try_visit!(visitor.visit_id(*hir_ref_id));
1302    visitor.visit_path(*path, *hir_ref_id)
1303}
1304
1305pub fn walk_param_bound<'v, V: Visitor<'v>>(
1306    visitor: &mut V,
1307    bound: &'v GenericBound<'v>,
1308) -> V::Result {
1309    match *bound {
1310        GenericBound::Trait(ref typ) => visitor.visit_poly_trait_ref(typ),
1311        GenericBound::Outlives(ref lifetime) => visitor.visit_lifetime(lifetime),
1312        GenericBound::Use(args, _) => {
1313            walk_list!(visitor, visit_precise_capturing_arg, args);
1314            V::Result::output()
1315        }
1316    }
1317}
1318
1319pub fn walk_precise_capturing_arg<'v, V: Visitor<'v>>(
1320    visitor: &mut V,
1321    arg: &'v PreciseCapturingArg<'v>,
1322) -> V::Result {
1323    match *arg {
1324        PreciseCapturingArg::Lifetime(lt) => visitor.visit_lifetime(lt),
1325        PreciseCapturingArg::Param(param) => {
1326            let PreciseCapturingNonLifetimeArg { hir_id, ident, res: _ } = param;
1327            try_visit!(visitor.visit_id(hir_id));
1328            visitor.visit_ident(ident)
1329        }
1330    }
1331}
1332
1333pub fn walk_poly_trait_ref<'v, V: Visitor<'v>>(
1334    visitor: &mut V,
1335    trait_ref: &'v PolyTraitRef<'v>,
1336) -> V::Result {
1337    let PolyTraitRef { bound_generic_params, modifiers: _, trait_ref, span: _ } = trait_ref;
1338    walk_list!(visitor, visit_generic_param, *bound_generic_params);
1339    visitor.visit_trait_ref(trait_ref)
1340}
1341
1342pub fn walk_opaque_ty<'v, V: Visitor<'v>>(visitor: &mut V, opaque: &'v OpaqueTy<'v>) -> V::Result {
1343    let &OpaqueTy { hir_id, def_id: _, bounds, origin: _, span: _ } = opaque;
1344    try_visit!(visitor.visit_id(hir_id));
1345    walk_list!(visitor, visit_param_bound, bounds);
1346    V::Result::output()
1347}
1348
1349pub fn walk_struct_def<'v, V: Visitor<'v>>(
1350    visitor: &mut V,
1351    struct_definition: &'v VariantData<'v>,
1352) -> V::Result {
1353    visit_opt!(visitor, visit_id, struct_definition.ctor_hir_id());
1354    walk_list!(visitor, visit_field_def, struct_definition.fields());
1355    V::Result::output()
1356}
1357
1358pub fn walk_field_def<'v, V: Visitor<'v>>(
1359    visitor: &mut V,
1360    FieldDef { hir_id, ident, ty, default, span: _, vis_span: _, def_id: _, safety: _ }: &'v FieldDef<'v>,
1361) -> V::Result {
1362    try_visit!(visitor.visit_id(*hir_id));
1363    try_visit!(visitor.visit_ident(*ident));
1364    visit_opt!(visitor, visit_anon_const, default);
1365    visitor.visit_ty_unambig(*ty)
1366}
1367
1368pub fn walk_enum_def<'v, V: Visitor<'v>>(
1369    visitor: &mut V,
1370    enum_definition: &'v EnumDef<'v>,
1371) -> V::Result {
1372    let EnumDef { variants } = enum_definition;
1373    walk_list!(visitor, visit_variant, *variants);
1374    V::Result::output()
1375}
1376
1377pub fn walk_variant<'v, V: Visitor<'v>>(visitor: &mut V, variant: &'v Variant<'v>) -> V::Result {
1378    let Variant { ident, hir_id, def_id: _, data, disr_expr, span: _ } = variant;
1379    try_visit!(visitor.visit_ident(*ident));
1380    try_visit!(visitor.visit_id(*hir_id));
1381    try_visit!(visitor.visit_variant_data(data));
1382    visit_opt!(visitor, visit_anon_const, disr_expr);
1383    V::Result::output()
1384}
1385
1386pub fn walk_label<'v, V: Visitor<'v>>(visitor: &mut V, label: &'v Label) -> V::Result {
1387    let Label { ident } = label;
1388    visitor.visit_ident(*ident)
1389}
1390
1391pub fn walk_inf<'v, V: Visitor<'v>>(visitor: &mut V, inf: &'v InferArg) -> V::Result {
1392    let InferArg { hir_id, span: _ } = inf;
1393    visitor.visit_id(*hir_id)
1394}
1395
1396pub fn walk_lifetime<'v, V: Visitor<'v>>(visitor: &mut V, lifetime: &'v Lifetime) -> V::Result {
1397    let Lifetime { hir_id, ident, kind: _, source: _, syntax: _ } = lifetime;
1398    try_visit!(visitor.visit_id(*hir_id));
1399    visitor.visit_ident(*ident)
1400}
1401
1402pub fn walk_qpath<'v, V: Visitor<'v>>(
1403    visitor: &mut V,
1404    qpath: &'v QPath<'v>,
1405    id: HirId,
1406) -> V::Result {
1407    match *qpath {
1408        QPath::Resolved(ref maybe_qself, ref path) => {
1409            visit_opt!(visitor, visit_ty_unambig, maybe_qself);
1410            visitor.visit_path(path, id)
1411        }
1412        QPath::TypeRelative(ref qself, ref segment) => {
1413            try_visit!(visitor.visit_ty_unambig(qself));
1414            visitor.visit_path_segment(segment)
1415        }
1416        QPath::LangItem(..) => V::Result::output(),
1417    }
1418}
1419
1420pub fn walk_path<'v, V: Visitor<'v>>(visitor: &mut V, path: &Path<'v>) -> V::Result {
1421    let Path { segments, span: _, res: _ } = path;
1422    walk_list!(visitor, visit_path_segment, *segments);
1423    V::Result::output()
1424}
1425
1426pub fn walk_path_segment<'v, V: Visitor<'v>>(
1427    visitor: &mut V,
1428    segment: &'v PathSegment<'v>,
1429) -> V::Result {
1430    let PathSegment { ident, hir_id, res: _, args, infer_args: _ } = segment;
1431    try_visit!(visitor.visit_ident(*ident));
1432    try_visit!(visitor.visit_id(*hir_id));
1433    visit_opt!(visitor, visit_generic_args, *args);
1434    V::Result::output()
1435}
1436
1437pub fn walk_generic_args<'v, V: Visitor<'v>>(
1438    visitor: &mut V,
1439    generic_args: &'v GenericArgs<'v>,
1440) -> V::Result {
1441    let GenericArgs { args, constraints, parenthesized: _, span_ext: _ } = generic_args;
1442    walk_list!(visitor, visit_generic_arg, *args);
1443    walk_list!(visitor, visit_assoc_item_constraint, *constraints);
1444    V::Result::output()
1445}
1446
1447pub fn walk_assoc_item_constraint<'v, V: Visitor<'v>>(
1448    visitor: &mut V,
1449    constraint: &'v AssocItemConstraint<'v>,
1450) -> V::Result {
1451    let AssocItemConstraint { hir_id, ident, gen_args, kind: _, span: _ } = constraint;
1452    try_visit!(visitor.visit_id(*hir_id));
1453    try_visit!(visitor.visit_ident(*ident));
1454    try_visit!(visitor.visit_generic_args(*gen_args));
1455    match constraint.kind {
1456        AssocItemConstraintKind::Equality { ref term } => match term {
1457            Term::Ty(ty) => try_visit!(visitor.visit_ty_unambig(ty)),
1458            Term::Const(c) => try_visit!(visitor.visit_const_arg_unambig(c)),
1459        },
1460        AssocItemConstraintKind::Bound { bounds } => {
1461            walk_list!(visitor, visit_param_bound, bounds)
1462        }
1463    }
1464    V::Result::output()
1465}
1466
1467pub fn walk_defaultness<'v, V: Visitor<'v>>(_: &mut V, _: &'v Defaultness) -> V::Result {
1468    // No visitable content here: this fn exists so you can call it if
1469    // the right thing to do, should content be added in the future,
1470    // would be to walk it.
1471    V::Result::output()
1472}
1473
1474pub fn walk_inline_asm<'v, V: Visitor<'v>>(
1475    visitor: &mut V,
1476    asm: &'v InlineAsm<'v>,
1477    id: HirId,
1478) -> V::Result {
1479    for (op, op_sp) in asm.operands {
1480        match op {
1481            InlineAsmOperand::In { expr, .. } | InlineAsmOperand::InOut { expr, .. } => {
1482                try_visit!(visitor.visit_expr(expr));
1483            }
1484            InlineAsmOperand::Out { expr, .. } => {
1485                visit_opt!(visitor, visit_expr, expr);
1486            }
1487            InlineAsmOperand::SplitInOut { in_expr, out_expr, .. } => {
1488                try_visit!(visitor.visit_expr(in_expr));
1489                visit_opt!(visitor, visit_expr, out_expr);
1490            }
1491            InlineAsmOperand::Const { anon_const, .. } => {
1492                try_visit!(visitor.visit_inline_const(anon_const));
1493            }
1494            InlineAsmOperand::SymFn { expr, .. } => {
1495                try_visit!(visitor.visit_expr(expr));
1496            }
1497            InlineAsmOperand::SymStatic { path, .. } => {
1498                try_visit!(visitor.visit_qpath(path, id, *op_sp));
1499            }
1500            InlineAsmOperand::Label { block } => try_visit!(visitor.visit_block(block)),
1501        }
1502    }
1503    V::Result::output()
1504}