compiler/rustc_ast/src/visit.rs

   1 //! AST walker. Each overridden visit method has full control over what
   2 //! happens with its node, it can do its own traversal of the node's children,
   3 //! call `visit::walk_*` to apply the default traversal algorithm, or prevent
   4 //! deeper traversal by doing nothing.
   5 //!
   6 //! Note: it is an important invariant that the default visitor walks the body
   7 //! of a function in "execution order" (more concretely, reverse post-order
   8 //! with respect to the CFG implied by the AST), meaning that if AST node A may
   9 //! execute before AST node B, then A is visited first. The borrow checker in
  10 //! particular relies on this property.
  11 //!
  12 //! Note: walking an AST before macro expansion is probably a bad idea. For
  13 //! instance, a walker looking for item names in a module will miss all of
  14 //! those that are created by the expansion of a macro.
  15
  16 use crate::ast::*;
  17
  18 use rustc_span::symbol::Ident;
  19 use rustc_span::Span;
  20
  21 #[derive(Copy, Clone, Debug, PartialEq)]
  22 pub enum AssocCtxt {
  23     Trait,
  24     Impl,
  25 }
  26
  27 #[derive(Copy, Clone, Debug, PartialEq)]
  28 pub enum FnCtxt {
  29     Free,
  30     Foreign,
  31     Assoc(AssocCtxt),
  32 }
  33
  34 #[derive(Copy, Clone, Debug)]
  35 pub enum BoundKind {
  36     /// Trait bounds in generics bounds and type/trait alias.
  37     /// E.g., `<T: Bound>`, `type A: Bound`, or `where T: Bound`.
  38     Bound,
  39
  40     /// Trait bounds in `impl` type.
  41     /// E.g., `type Foo = impl Bound1 + Bound2 + Bound3`.
  42     Impl,
  43
  44     /// Trait bounds in trait object type.
  45     /// E.g., `dyn Bound1 + Bound2 + Bound3`.
  46     TraitObject,
  47
  48     /// Super traits of a trait.
  49     /// E.g., `trait A: B`
  50     SuperTraits,
  51 }
  52
  53 #[derive(Copy, Clone, Debug)]
  54 pub enum FnKind<'a> {
  55     /// E.g., `fn foo()`, `fn foo(&self)`, or `extern "Abi" fn foo()`.
  56     Fn(FnCtxt, Ident, &'a FnSig, &'a Visibility, &'a Generics, Option<&'a Block>),
  57
  58     /// E.g., `|x, y| body`.
  59     Closure(&'a ClosureBinder, &'a FnDecl, &'a Expr),
  60 }
  61
  62 impl<'a> FnKind<'a> {
  63     pub fn header(&self) -> Option<&'a FnHeader> {
  64         match *self {
  65             FnKind::Fn(_, _, sig, _, _, _) => Some(&sig.header),
  66             FnKind::Closure(_, _, _) => None,
  67         }
  68     }
  69
  70     pub fn ident(&self) -> Option<&Ident> {
  71         match self {
  72             FnKind::Fn(_, ident, ..) => Some(ident),
  73             _ => None,
  74         }
  75     }
  76
  77     pub fn decl(&self) -> &'a FnDecl {
  78         match self {
  79             FnKind::Fn(_, _, sig, _, _, _) => &sig.decl,
  80             FnKind::Closure(_, decl, _) => decl,
  81         }
  82     }
  83
  84     pub fn ctxt(&self) -> Option<FnCtxt> {
  85         match self {
  86             FnKind::Fn(ctxt, ..) => Some(*ctxt),
  87             FnKind::Closure(..) => None,
  88         }
  89     }
  90 }
  91
  92 #[derive(Copy, Clone, Debug)]
  93 pub enum LifetimeCtxt {
  94     /// Appears in a reference type.
  95     Rptr,
  96     /// Appears as a bound on a type or another lifetime.
  97     Bound,
  98     /// Appears as a generic argument.
  99     GenericArg,
 100 }
 101
 102 /// Each method of the `Visitor` trait is a hook to be potentially
 103 /// overridden. Each method's default implementation recursively visits
 104 /// the substructure of the input via the corresponding `walk` method;
 105 /// e.g., the `visit_item` method by default calls `visit::walk_item`.
 106 ///
 107 /// If you want to ensure that your code handles every variant
 108 /// explicitly, you need to override each method. (And you also need
 109 /// to monitor future changes to `Visitor` in case a new method with a
 110 /// new default implementation gets introduced.)
 111 pub trait Visitor<'ast>: Sized {
 112     fn visit_ident(&mut self, _ident: Ident) {}
 113     fn visit_foreign_item(&mut self, i: &'ast ForeignItem) {
 114         walk_foreign_item(self, i)
 115     }
 116     fn visit_item(&mut self, i: &'ast Item) {
 117         walk_item(self, i)
 118     }
 119     fn visit_local(&mut self, l: &'ast Local) {
 120         walk_local(self, l)
 121     }
 122     fn visit_block(&mut self, b: &'ast Block) {
 123         walk_block(self, b)
 124     }
 125     fn visit_stmt(&mut self, s: &'ast Stmt) {
 126         walk_stmt(self, s)
 127     }
 128     fn visit_param(&mut self, param: &'ast Param) {
 129         walk_param(self, param)
 130     }
 131     fn visit_arm(&mut self, a: &'ast Arm) {
 132         walk_arm(self, a)
 133     }
 134     fn visit_pat(&mut self, p: &'ast Pat) {
 135         walk_pat(self, p)
 136     }
 137     fn visit_anon_const(&mut self, c: &'ast AnonConst) {
 138         walk_anon_const(self, c)
 139     }
 140     fn visit_expr(&mut self, ex: &'ast Expr) {
 141         walk_expr(self, ex)
 142     }
 143     fn visit_expr_post(&mut self, _ex: &'ast Expr) {}
 144     fn visit_ty(&mut self, t: &'ast Ty) {
 145         walk_ty(self, t)
 146     }
 147     fn visit_generic_param(&mut self, param: &'ast GenericParam) {
 148         walk_generic_param(self, param)
 149     }
 150     fn visit_generics(&mut self, g: &'ast Generics) {
 151         walk_generics(self, g)
 152     }
 153     fn visit_closure_binder(&mut self, b: &'ast ClosureBinder) {
 154         walk_closure_binder(self, b)
 155     }
 156     fn visit_where_predicate(&mut self, p: &'ast WherePredicate) {
 157         walk_where_predicate(self, p)
 158     }
 159     fn visit_fn(&mut self, fk: FnKind<'ast>, s: Span, _: NodeId) {
 160         walk_fn(self, fk, s)
 161     }
 162     fn visit_assoc_item(&mut self, i: &'ast AssocItem, ctxt: AssocCtxt) {
 163         walk_assoc_item(self, i, ctxt)
 164     }
 165     fn visit_trait_ref(&mut self, t: &'ast TraitRef) {
 166         walk_trait_ref(self, t)
 167     }
 168     fn visit_param_bound(&mut self, bounds: &'ast GenericBound, _ctxt: BoundKind) {
 169         walk_param_bound(self, bounds)
 170     }
 171     fn visit_poly_trait_ref(&mut self, t: &'ast PolyTraitRef, m: &'ast TraitBoundModifier) {
 172         walk_poly_trait_ref(self, t, m)
 173     }
 174     fn visit_variant_data(&mut self, s: &'ast VariantData) {
 175         walk_struct_def(self, s)
 176     }
 177     fn visit_field_def(&mut self, s: &'ast FieldDef) {
 178         walk_field_def(self, s)
 179     }
 180     fn visit_enum_def(
 181         &mut self,
 182         enum_definition: &'ast EnumDef,
 183         generics: &'ast Generics,
 184         item_id: NodeId,
 185         _: Span,
 186     ) {
 187         walk_enum_def(self, enum_definition, generics, item_id)
 188     }
 189     fn visit_variant(&mut self, v: &'ast Variant) {
 190         walk_variant(self, v)
 191     }
 192     fn visit_label(&mut self, label: &'ast Label) {
 193         walk_label(self, label)
 194     }
 195     fn visit_lifetime(&mut self, lifetime: &'ast Lifetime, _: LifetimeCtxt) {
 196         walk_lifetime(self, lifetime)
 197     }
 198     fn visit_mac_call(&mut self, mac: &'ast MacCall) {
 199         walk_mac(self, mac)
 200     }
 201     fn visit_mac_def(&mut self, _mac: &'ast MacroDef, _id: NodeId) {
 202         // Nothing to do
 203     }
 204     fn visit_path(&mut self, path: &'ast Path, _id: NodeId) {
 205         walk_path(self, path)
 206     }
 207     fn visit_use_tree(&mut self, use_tree: &'ast UseTree, id: NodeId, _nested: bool) {
 208         walk_use_tree(self, use_tree, id)
 209     }
 210     fn visit_path_segment(&mut self, path_span: Span, path_segment: &'ast PathSegment) {
 211         walk_path_segment(self, path_span, path_segment)
 212     }
 213     fn visit_generic_args(&mut self, path_span: Span, generic_args: &'ast GenericArgs) {
 214         walk_generic_args(self, path_span, generic_args)
 215     }
 216     fn visit_generic_arg(&mut self, generic_arg: &'ast GenericArg) {
 217         walk_generic_arg(self, generic_arg)
 218     }
 219     fn visit_assoc_constraint(&mut self, constraint: &'ast AssocConstraint) {
 220         walk_assoc_constraint(self, constraint)
 221     }
 222     fn visit_attribute(&mut self, attr: &'ast Attribute) {
 223         walk_attribute(self, attr)
 224     }
 225     fn visit_vis(&mut self, vis: &'ast Visibility) {
 226         walk_vis(self, vis)
 227     }
 228     fn visit_fn_ret_ty(&mut self, ret_ty: &'ast FnRetTy) {
 229         walk_fn_ret_ty(self, ret_ty)
 230     }
 231     fn visit_fn_header(&mut self, _header: &'ast FnHeader) {
 232         // Nothing to do
 233     }
 234     fn visit_expr_field(&mut self, f: &'ast ExprField) {
 235         walk_expr_field(self, f)
 236     }
 237     fn visit_pat_field(&mut self, fp: &'ast PatField) {
 238         walk_pat_field(self, fp)
 239     }
 240     fn visit_crate(&mut self, krate: &'ast Crate) {
 241         walk_crate(self, krate)
 242     }
 243     fn visit_inline_asm(&mut self, asm: &'ast InlineAsm) {
 244         walk_inline_asm(self, asm)
 245     }
 246     fn visit_inline_asm_sym(&mut self, sym: &'ast InlineAsmSym) {
 247         walk_inline_asm_sym(self, sym)
 248     }
 249 }
 250
 251 #[macro_export]
 252 macro_rules! walk_list {
 253     ($visitor: expr, $method: ident, $list: expr) => {
 254         for elem in $list {
 255             $visitor.$method(elem)
 256         }
 257     };
 258     ($visitor: expr, $method: ident, $list: expr, $($extra_args: expr),*) => {
 259         for elem in $list {
 260             $visitor.$method(elem, $($extra_args,)*)
 261         }
 262     }
 263 }
 264
 265 pub fn walk_crate<'a, V: Visitor<'a>>(visitor: &mut V, krate: &'a Crate) {
 266     walk_list!(visitor, visit_item, &krate.items);
 267     walk_list!(visitor, visit_attribute, &krate.attrs);
 268 }
 269
 270 pub fn walk_local<'a, V: Visitor<'a>>(visitor: &mut V, local: &'a Local) {
 271     for attr in local.attrs.iter() {
 272         visitor.visit_attribute(attr);
 273     }
 274     visitor.visit_pat(&local.pat);
 275     walk_list!(visitor, visit_ty, &local.ty);
 276     if let Some((init, els)) = local.kind.init_else_opt() {
 277         visitor.visit_expr(init);
 278         walk_list!(visitor, visit_block, els);
 279     }
 280 }
 281
 282 pub fn walk_label<'a, V: Visitor<'a>>(visitor: &mut V, label: &'a Label) {
 283     visitor.visit_ident(label.ident);
 284 }
 285
 286 pub fn walk_lifetime<'a, V: Visitor<'a>>(visitor: &mut V, lifetime: &'a Lifetime) {
 287     visitor.visit_ident(lifetime.ident);
 288 }
 289
 290 pub fn walk_poly_trait_ref<'a, V>(
 291     visitor: &mut V,
 292     trait_ref: &'a PolyTraitRef,
 293     _: &TraitBoundModifier,
 294 ) where
 295     V: Visitor<'a>,
 296 {
 297     walk_list!(visitor, visit_generic_param, &trait_ref.bound_generic_params);
 298     visitor.visit_trait_ref(&trait_ref.trait_ref);
 299 }
 300
 301 pub fn walk_trait_ref<'a, V: Visitor<'a>>(visitor: &mut V, trait_ref: &'a TraitRef) {
 302     visitor.visit_path(&trait_ref.path, trait_ref.ref_id)
 303 }
 304
 305 pub fn walk_item<'a, V: Visitor<'a>>(visitor: &mut V, item: &'a Item) {
 306     visitor.visit_vis(&item.vis);
 307     visitor.visit_ident(item.ident);
 308     match item.kind {
 309         ItemKind::ExternCrate(_) => {}
 310         ItemKind::Use(ref use_tree) => visitor.visit_use_tree(use_tree, item.id, false),
 311         ItemKind::Static(ref typ, _, ref expr) | ItemKind::Const(_, ref typ, ref expr) => {
 312             visitor.visit_ty(typ);
 313             walk_list!(visitor, visit_expr, expr);
 314         }
 315         ItemKind::Fn(box Fn { defaultness: _, ref generics, ref sig, ref body }) => {
 316             let kind =
 317                 FnKind::Fn(FnCtxt::Free, item.ident, sig, &item.vis, generics, body.as_deref());
 318             visitor.visit_fn(kind, item.span, item.id)
 319         }
 320         ItemKind::Mod(_unsafety, ref mod_kind) => match mod_kind {
 321             ModKind::Loaded(items, _inline, _inner_span) => {
 322                 walk_list!(visitor, visit_item, items)
 323             }
 324             ModKind::Unloaded => {}
 325         },
 326         ItemKind::ForeignMod(ref foreign_module) => {
 327             walk_list!(visitor, visit_foreign_item, &foreign_module.items);
 328         }
 329         ItemKind::GlobalAsm(ref asm) => visitor.visit_inline_asm(asm),
 330         ItemKind::TyAlias(box TyAlias { ref generics, ref bounds, ref ty, .. }) => {
 331             visitor.visit_generics(generics);
 332             walk_list!(visitor, visit_param_bound, bounds, BoundKind::Bound);
 333             walk_list!(visitor, visit_ty, ty);
 334         }
 335         ItemKind::Enum(ref enum_definition, ref generics) => {
 336             visitor.visit_generics(generics);
 337             visitor.visit_enum_def(enum_definition, generics, item.id, item.span)
 338         }
 339         ItemKind::Impl(box Impl {
 340             defaultness: _,
 341             unsafety: _,
 342             ref generics,
 343             constness: _,
 344             polarity: _,
 345             ref of_trait,
 346             ref self_ty,
 347             ref items,
 348         }) => {
 349             visitor.visit_generics(generics);
 350             walk_list!(visitor, visit_trait_ref, of_trait);
 351             visitor.visit_ty(self_ty);
 352             walk_list!(visitor, visit_assoc_item, items, AssocCtxt::Impl);
 353         }
 354         ItemKind::Struct(ref struct_definition, ref generics)
 355         | ItemKind::Union(ref struct_definition, ref generics) => {
 356             visitor.visit_generics(generics);
 357             visitor.visit_variant_data(struct_definition);
 358         }
 359         ItemKind::Trait(box Trait {
 360             unsafety: _,
 361             is_auto: _,
 362             ref generics,
 363             ref bounds,
 364             ref items,
 365         }) => {
 366             visitor.visit_generics(generics);
 367             walk_list!(visitor, visit_param_bound, bounds, BoundKind::SuperTraits);
 368             walk_list!(visitor, visit_assoc_item, items, AssocCtxt::Trait);
 369         }
 370         ItemKind::TraitAlias(ref generics, ref bounds) => {
 371             visitor.visit_generics(generics);
 372             walk_list!(visitor, visit_param_bound, bounds, BoundKind::Bound);
 373         }
 374         ItemKind::MacCall(ref mac) => visitor.visit_mac_call(mac),
 375         ItemKind::MacroDef(ref ts) => visitor.visit_mac_def(ts, item.id),
 376     }
 377     walk_list!(visitor, visit_attribute, &item.attrs);
 378 }
 379
 380 pub fn walk_enum_def<'a, V: Visitor<'a>>(
 381     visitor: &mut V,
 382     enum_definition: &'a EnumDef,
 383     _: &'a Generics,
 384     _: NodeId,
 385 ) {
 386     walk_list!(visitor, visit_variant, &enum_definition.variants);
 387 }
 388
 389 pub fn walk_variant<'a, V: Visitor<'a>>(visitor: &mut V, variant: &'a Variant)
 390 where
 391     V: Visitor<'a>,
 392 {
 393     visitor.visit_ident(variant.ident);
 394     visitor.visit_vis(&variant.vis);
 395     visitor.visit_variant_data(&variant.data);
 396     walk_list!(visitor, visit_anon_const, &variant.disr_expr);
 397     walk_list!(visitor, visit_attribute, &variant.attrs);
 398 }
 399
 400 pub fn walk_expr_field<'a, V: Visitor<'a>>(visitor: &mut V, f: &'a ExprField) {
 401     visitor.visit_expr(&f.expr);
 402     visitor.visit_ident(f.ident);
 403     walk_list!(visitor, visit_attribute, f.attrs.iter());
 404 }
 405
 406 pub fn walk_pat_field<'a, V: Visitor<'a>>(visitor: &mut V, fp: &'a PatField) {
 407     visitor.visit_ident(fp.ident);
 408     visitor.visit_pat(&fp.pat);
 409     walk_list!(visitor, visit_attribute, fp.attrs.iter());
 410 }
 411
 412 pub fn walk_ty<'a, V: Visitor<'a>>(visitor: &mut V, typ: &'a Ty) {
 413     match typ.kind {
 414         TyKind::Slice(ref ty) | TyKind::Paren(ref ty) => visitor.visit_ty(ty),
 415         TyKind::Ptr(ref mutable_type) => visitor.visit_ty(&mutable_type.ty),
 416         TyKind::Rptr(ref opt_lifetime, ref mutable_type) => {
 417             walk_list!(visitor, visit_lifetime, opt_lifetime, LifetimeCtxt::Rptr);
 418             visitor.visit_ty(&mutable_type.ty)
 419         }
 420         TyKind::Tup(ref tuple_element_types) => {
 421             walk_list!(visitor, visit_ty, tuple_element_types);
 422         }
 423         TyKind::BareFn(ref function_declaration) => {
 424             walk_list!(visitor, visit_generic_param, &function_declaration.generic_params);
 425             walk_fn_decl(visitor, &function_declaration.decl);
 426         }
 427         TyKind::Path(ref maybe_qself, ref path) => {
 428             if let Some(ref qself) = *maybe_qself {
 429                 visitor.visit_ty(&qself.ty);
 430             }
 431             visitor.visit_path(path, typ.id);
 432         }
 433         TyKind::Array(ref ty, ref length) => {
 434             visitor.visit_ty(ty);
 435             visitor.visit_anon_const(length)
 436         }
 437         TyKind::TraitObject(ref bounds, ..) => {
 438             walk_list!(visitor, visit_param_bound, bounds, BoundKind::TraitObject);
 439         }
 440         TyKind::ImplTrait(_, ref bounds) => {
 441             walk_list!(visitor, visit_param_bound, bounds, BoundKind::Impl);
 442         }
 443         TyKind::Typeof(ref expression) => visitor.visit_anon_const(expression),
 444         TyKind::Infer | TyKind::ImplicitSelf | TyKind::Err => {}
 445         TyKind::MacCall(ref mac) => visitor.visit_mac_call(mac),
 446         TyKind::Never | TyKind::CVarArgs => {}
 447     }
 448 }
 449
 450 pub fn walk_path<'a, V: Visitor<'a>>(visitor: &mut V, path: &'a Path) {
 451     for segment in &path.segments {
 452         visitor.visit_path_segment(path.span, segment);
 453     }
 454 }
 455
 456 pub fn walk_use_tree<'a, V: Visitor<'a>>(visitor: &mut V, use_tree: &'a UseTree, id: NodeId) {
 457     visitor.visit_path(&use_tree.prefix, id);
 458     match use_tree.kind {
 459         UseTreeKind::Simple(rename, ..) => {
 460             // The extra IDs are handled during HIR lowering.
 461             if let Some(rename) = rename {
 462                 visitor.visit_ident(rename);
 463             }
 464         }
 465         UseTreeKind::Glob => {}
 466         UseTreeKind::Nested(ref use_trees) => {
 467             for &(ref nested_tree, nested_id) in use_trees {
 468                 visitor.visit_use_tree(nested_tree, nested_id, true);
 469             }
 470         }
 471     }
 472 }
 473
 474 pub fn walk_path_segment<'a, V: Visitor<'a>>(
 475     visitor: &mut V,
 476     path_span: Span,
 477     segment: &'a PathSegment,
 478 ) {
 479     visitor.visit_ident(segment.ident);
 480     if let Some(ref args) = segment.args {
 481         visitor.visit_generic_args(path_span, args);
 482     }
 483 }
 484
 485 pub fn walk_generic_args<'a, V>(visitor: &mut V, _path_span: Span, generic_args: &'a GenericArgs)
 486 where
 487     V: Visitor<'a>,
 488 {
 489     match *generic_args {
 490         GenericArgs::AngleBracketed(ref data) => {
 491             for arg in &data.args {
 492                 match arg {
 493                     AngleBracketedArg::Arg(a) => visitor.visit_generic_arg(a),
 494                     AngleBracketedArg::Constraint(c) => visitor.visit_assoc_constraint(c),
 495                 }
 496             }
 497         }
 498         GenericArgs::Parenthesized(ref data) => {
 499             walk_list!(visitor, visit_ty, &data.inputs);
 500             walk_fn_ret_ty(visitor, &data.output);
 501         }
 502     }
 503 }
 504
 505 pub fn walk_generic_arg<'a, V>(visitor: &mut V, generic_arg: &'a GenericArg)
 506 where
 507     V: Visitor<'a>,
 508 {
 509     match generic_arg {
 510         GenericArg::Lifetime(lt) => visitor.visit_lifetime(lt, LifetimeCtxt::GenericArg),
 511         GenericArg::Type(ty) => visitor.visit_ty(ty),
 512         GenericArg::Const(ct) => visitor.visit_anon_const(ct),
 513     }
 514 }
 515
 516 pub fn walk_assoc_constraint<'a, V: Visitor<'a>>(visitor: &mut V, constraint: &'a AssocConstraint) {
 517     visitor.visit_ident(constraint.ident);
 518     if let Some(ref gen_args) = constraint.gen_args {
 519         visitor.visit_generic_args(gen_args.span(), gen_args);
 520     }
 521     match constraint.kind {
 522         AssocConstraintKind::Equality { ref term } => match term {
 523             Term::Ty(ty) => visitor.visit_ty(ty),
 524             Term::Const(c) => visitor.visit_anon_const(c),
 525         },
 526         AssocConstraintKind::Bound { ref bounds } => {
 527             walk_list!(visitor, visit_param_bound, bounds, BoundKind::Bound);
 528         }
 529     }
 530 }
 531
 532 pub fn walk_pat<'a, V: Visitor<'a>>(visitor: &mut V, pattern: &'a Pat) {
 533     match pattern.kind {
 534         PatKind::TupleStruct(ref opt_qself, ref path, ref elems) => {
 535             if let Some(ref qself) = *opt_qself {
 536                 visitor.visit_ty(&qself.ty);
 537             }
 538             visitor.visit_path(path, pattern.id);
 539             walk_list!(visitor, visit_pat, elems);
 540         }
 541         PatKind::Path(ref opt_qself, ref path) => {
 542             if let Some(ref qself) = *opt_qself {
 543                 visitor.visit_ty(&qself.ty);
 544             }
 545             visitor.visit_path(path, pattern.id)
 546         }
 547         PatKind::Struct(ref opt_qself, ref path, ref fields, _) => {
 548             if let Some(ref qself) = *opt_qself {
 549                 visitor.visit_ty(&qself.ty);
 550             }
 551             visitor.visit_path(path, pattern.id);
 552             walk_list!(visitor, visit_pat_field, fields);
 553         }
 554         PatKind::Box(ref subpattern)
 555         | PatKind::Ref(ref subpattern, _)
 556         | PatKind::Paren(ref subpattern) => visitor.visit_pat(subpattern),
 557         PatKind::Ident(_, ident, ref optional_subpattern) => {
 558             visitor.visit_ident(ident);
 559             walk_list!(visitor, visit_pat, optional_subpattern);
 560         }
 561         PatKind::Lit(ref expression) => visitor.visit_expr(expression),
 562         PatKind::Range(ref lower_bound, ref upper_bound, _) => {
 563             walk_list!(visitor, visit_expr, lower_bound);
 564             walk_list!(visitor, visit_expr, upper_bound);
 565         }
 566         PatKind::Wild | PatKind::Rest => {}
 567         PatKind::Tuple(ref elems) | PatKind::Slice(ref elems) | PatKind::Or(ref elems) => {
 568             walk_list!(visitor, visit_pat, elems);
 569         }
 570         PatKind::MacCall(ref mac) => visitor.visit_mac_call(mac),
 571     }
 572 }
 573
 574 pub fn walk_foreign_item<'a, V: Visitor<'a>>(visitor: &mut V, item: &'a ForeignItem) {
 575     let Item { id, span, ident, ref vis, ref attrs, ref kind, tokens: _ } = *item;
 576     visitor.visit_vis(vis);
 577     visitor.visit_ident(ident);
 578     walk_list!(visitor, visit_attribute, attrs);
 579     match kind {
 580         ForeignItemKind::Static(ty, _, expr) => {
 581             visitor.visit_ty(ty);
 582             walk_list!(visitor, visit_expr, expr);
 583         }
 584         ForeignItemKind::Fn(box Fn { defaultness: _, ref generics, ref sig, ref body }) => {
 585             let kind = FnKind::Fn(FnCtxt::Foreign, ident, sig, vis, generics, body.as_deref());
 586             visitor.visit_fn(kind, span, id);
 587         }
 588         ForeignItemKind::TyAlias(box TyAlias { generics, bounds, ty, .. }) => {
 589             visitor.visit_generics(generics);
 590             walk_list!(visitor, visit_param_bound, bounds, BoundKind::Bound);
 591             walk_list!(visitor, visit_ty, ty);
 592         }
 593         ForeignItemKind::MacCall(mac) => {
 594             visitor.visit_mac_call(mac);
 595         }
 596     }
 597 }
 598
 599 pub fn walk_param_bound<'a, V: Visitor<'a>>(visitor: &mut V, bound: &'a GenericBound) {
 600     match *bound {
 601         GenericBound::Trait(ref typ, ref modifier) => visitor.visit_poly_trait_ref(typ, modifier),
 602         GenericBound::Outlives(ref lifetime) => {
 603             visitor.visit_lifetime(lifetime, LifetimeCtxt::Bound)
 604         }
 605     }
 606 }
 607
 608 pub fn walk_generic_param<'a, V: Visitor<'a>>(visitor: &mut V, param: &'a GenericParam) {
 609     visitor.visit_ident(param.ident);
 610     walk_list!(visitor, visit_attribute, param.attrs.iter());
 611     walk_list!(visitor, visit_param_bound, &param.bounds, BoundKind::Bound);
 612     match param.kind {
 613         GenericParamKind::Lifetime => (),
 614         GenericParamKind::Type { ref default } => walk_list!(visitor, visit_ty, default),
 615         GenericParamKind::Const { ref ty, ref default, .. } => {
 616             visitor.visit_ty(ty);
 617             if let Some(default) = default {
 618                 visitor.visit_anon_const(default);
 619             }
 620         }
 621     }
 622 }
 623
 624 pub fn walk_generics<'a, V: Visitor<'a>>(visitor: &mut V, generics: &'a Generics) {
 625     walk_list!(visitor, visit_generic_param, &generics.params);
 626     walk_list!(visitor, visit_where_predicate, &generics.where_clause.predicates);
 627 }
 628
 629 pub fn walk_closure_binder<'a, V: Visitor<'a>>(visitor: &mut V, binder: &'a ClosureBinder) {
 630     match binder {
 631         ClosureBinder::NotPresent => {}
 632         ClosureBinder::For { generic_params, span: _ } => {
 633             walk_list!(visitor, visit_generic_param, generic_params)
 634         }
 635     }
 636 }
 637
 638 pub fn walk_where_predicate<'a, V: Visitor<'a>>(visitor: &mut V, predicate: &'a WherePredicate) {
 639     match *predicate {
 640         WherePredicate::BoundPredicate(WhereBoundPredicate {
 641             ref bounded_ty,
 642             ref bounds,
 643             ref bound_generic_params,
 644             ..
 645         }) => {
 646             visitor.visit_ty(bounded_ty);
 647             walk_list!(visitor, visit_param_bound, bounds, BoundKind::Bound);
 648             walk_list!(visitor, visit_generic_param, bound_generic_params);
 649         }
 650         WherePredicate::RegionPredicate(WhereRegionPredicate {
 651             ref lifetime, ref bounds, ..
 652         }) => {
 653             visitor.visit_lifetime(lifetime, LifetimeCtxt::Bound);
 654             walk_list!(visitor, visit_param_bound, bounds, BoundKind::Bound);
 655         }
 656         WherePredicate::EqPredicate(WhereEqPredicate { ref lhs_ty, ref rhs_ty, .. }) => {
 657             visitor.visit_ty(lhs_ty);
 658             visitor.visit_ty(rhs_ty);
 659         }
 660     }
 661 }
 662
 663 pub fn walk_fn_ret_ty<'a, V: Visitor<'a>>(visitor: &mut V, ret_ty: &'a FnRetTy) {
 664     if let FnRetTy::Ty(ref output_ty) = *ret_ty {
 665         visitor.visit_ty(output_ty)
 666     }
 667 }
 668
 669 pub fn walk_fn_decl<'a, V: Visitor<'a>>(visitor: &mut V, function_declaration: &'a FnDecl) {
 670     for param in &function_declaration.inputs {
 671         visitor.visit_param(param);
 672     }
 673     visitor.visit_fn_ret_ty(&function_declaration.output);
 674 }
 675
 676 pub fn walk_fn<'a, V: Visitor<'a>>(visitor: &mut V, kind: FnKind<'a>, _span: Span) {
 677     match kind {
 678         FnKind::Fn(_, _, sig, _, generics, body) => {
 679             visitor.visit_generics(generics);
 680             visitor.visit_fn_header(&sig.header);
 681             walk_fn_decl(visitor, &sig.decl);
 682             walk_list!(visitor, visit_block, body);
 683         }
 684         FnKind::Closure(binder, decl, body) => {
 685             visitor.visit_closure_binder(binder);
 686             walk_fn_decl(visitor, decl);
 687             visitor.visit_expr(body);
 688         }
 689     }
 690 }
 691
 692 pub fn walk_assoc_item<'a, V: Visitor<'a>>(visitor: &mut V, item: &'a AssocItem, ctxt: AssocCtxt) {
 693     let Item { id, span, ident, ref vis, ref attrs, ref kind, tokens: _ } = *item;
 694     visitor.visit_vis(vis);
 695     visitor.visit_ident(ident);
 696     walk_list!(visitor, visit_attribute, attrs);
 697     match kind {
 698         AssocItemKind::Const(_, ty, expr) => {
 699             visitor.visit_ty(ty);
 700             walk_list!(visitor, visit_expr, expr);
 701         }
 702         AssocItemKind::Fn(box Fn { defaultness: _, ref generics, ref sig, ref body }) => {
 703             let kind = FnKind::Fn(FnCtxt::Assoc(ctxt), ident, sig, vis, generics, body.as_deref());
 704             visitor.visit_fn(kind, span, id);
 705         }
 706         AssocItemKind::TyAlias(box TyAlias { generics, bounds, ty, .. }) => {
 707             visitor.visit_generics(generics);
 708             walk_list!(visitor, visit_param_bound, bounds, BoundKind::Bound);
 709             walk_list!(visitor, visit_ty, ty);
 710         }
 711         AssocItemKind::MacCall(mac) => {
 712             visitor.visit_mac_call(mac);
 713         }
 714     }
 715 }
 716
 717 pub fn walk_struct_def<'a, V: Visitor<'a>>(visitor: &mut V, struct_definition: &'a VariantData) {
 718     walk_list!(visitor, visit_field_def, struct_definition.fields());
 719 }
 720
 721 pub fn walk_field_def<'a, V: Visitor<'a>>(visitor: &mut V, field: &'a FieldDef) {
 722     visitor.visit_vis(&field.vis);
 723     if let Some(ident) = field.ident {
 724         visitor.visit_ident(ident);
 725     }
 726     visitor.visit_ty(&field.ty);
 727     walk_list!(visitor, visit_attribute, &field.attrs);
 728 }
 729
 730 pub fn walk_block<'a, V: Visitor<'a>>(visitor: &mut V, block: &'a Block) {
 731     walk_list!(visitor, visit_stmt, &block.stmts);
 732 }
 733
 734 pub fn walk_stmt<'a, V: Visitor<'a>>(visitor: &mut V, statement: &'a Stmt) {
 735     match statement.kind {
 736         StmtKind::Local(ref local) => visitor.visit_local(local),
 737         StmtKind::Item(ref item) => visitor.visit_item(item),
 738         StmtKind::Expr(ref expr) | StmtKind::Semi(ref expr) => visitor.visit_expr(expr),
 739         StmtKind::Empty => {}
 740         StmtKind::MacCall(ref mac) => {
 741             let MacCallStmt { ref mac, style: _, ref attrs, tokens: _ } = **mac;
 742             visitor.visit_mac_call(mac);
 743             for attr in attrs.iter() {
 744                 visitor.visit_attribute(attr);
 745             }
 746         }
 747     }
 748 }
 749
 750 pub fn walk_mac<'a, V: Visitor<'a>>(visitor: &mut V, mac: &'a MacCall) {
 751     visitor.visit_path(&mac.path, DUMMY_NODE_ID);
 752 }
 753
 754 pub fn walk_anon_const<'a, V: Visitor<'a>>(visitor: &mut V, constant: &'a AnonConst) {
 755     visitor.visit_expr(&constant.value);
 756 }
 757
 758 pub fn walk_inline_asm<'a, V: Visitor<'a>>(visitor: &mut V, asm: &'a InlineAsm) {
 759     for (op, _) in &asm.operands {
 760         match op {
 761             InlineAsmOperand::In { expr, .. }
 762             | InlineAsmOperand::Out { expr: Some(expr), .. }
 763             | InlineAsmOperand::InOut { expr, .. } => visitor.visit_expr(expr),
 764             InlineAsmOperand::Out { expr: None, .. } => {}
 765             InlineAsmOperand::SplitInOut { in_expr, out_expr, .. } => {
 766                 visitor.visit_expr(in_expr);
 767                 if let Some(out_expr) = out_expr {
 768                     visitor.visit_expr(out_expr);
 769                 }
 770             }
 771             InlineAsmOperand::Const { anon_const, .. } => visitor.visit_anon_const(anon_const),
 772             InlineAsmOperand::Sym { sym } => visitor.visit_inline_asm_sym(sym),
 773         }
 774     }
 775 }
 776
 777 pub fn walk_inline_asm_sym<'a, V: Visitor<'a>>(visitor: &mut V, sym: &'a InlineAsmSym) {
 778     if let Some(ref qself) = sym.qself {
 779         visitor.visit_ty(&qself.ty);
 780     }
 781     visitor.visit_path(&sym.path, sym.id);
 782 }
 783
 784 pub fn walk_expr<'a, V: Visitor<'a>>(visitor: &mut V, expression: &'a Expr) {
 785     walk_list!(visitor, visit_attribute, expression.attrs.iter());
 786
 787     match expression.kind {
 788         ExprKind::Box(ref subexpression) => visitor.visit_expr(subexpression),
 789         ExprKind::Array(ref subexpressions) => {
 790             walk_list!(visitor, visit_expr, subexpressions);
 791         }
 792         ExprKind::ConstBlock(ref anon_const) => visitor.visit_anon_const(anon_const),
 793         ExprKind::Repeat(ref element, ref count) => {
 794             visitor.visit_expr(element);
 795             visitor.visit_anon_const(count)
 796         }
 797         ExprKind::Struct(ref se) => {
 798             if let Some(ref qself) = se.qself {
 799                 visitor.visit_ty(&qself.ty);
 800             }
 801             visitor.visit_path(&se.path, expression.id);
 802             walk_list!(visitor, visit_expr_field, &se.fields);
 803             match &se.rest {
 804                 StructRest::Base(expr) => visitor.visit_expr(expr),
 805                 StructRest::Rest(_span) => {}
 806                 StructRest::None => {}
 807             }
 808         }
 809         ExprKind::Tup(ref subexpressions) => {
 810             walk_list!(visitor, visit_expr, subexpressions);
 811         }
 812         ExprKind::Call(ref callee_expression, ref arguments) => {
 813             visitor.visit_expr(callee_expression);
 814             walk_list!(visitor, visit_expr, arguments);
 815         }
 816         ExprKind::MethodCall(ref segment, ref arguments, _span) => {
 817             visitor.visit_path_segment(expression.span, segment);
 818             walk_list!(visitor, visit_expr, arguments);
 819         }
 820         ExprKind::Binary(_, ref left_expression, ref right_expression) => {
 821             visitor.visit_expr(left_expression);
 822             visitor.visit_expr(right_expression)
 823         }
 824         ExprKind::AddrOf(_, _, ref subexpression) | ExprKind::Unary(_, ref subexpression) => {
 825             visitor.visit_expr(subexpression)
 826         }
 827         ExprKind::Cast(ref subexpression, ref typ) | ExprKind::Type(ref subexpression, ref typ) => {
 828             visitor.visit_expr(subexpression);
 829             visitor.visit_ty(typ)
 830         }
 831         ExprKind::Let(ref pat, ref expr, _) => {
 832             visitor.visit_pat(pat);
 833             visitor.visit_expr(expr);
 834         }
 835         ExprKind::If(ref head_expression, ref if_block, ref optional_else) => {
 836             visitor.visit_expr(head_expression);
 837             visitor.visit_block(if_block);
 838             walk_list!(visitor, visit_expr, optional_else);
 839         }
 840         ExprKind::While(ref subexpression, ref block, ref opt_label) => {
 841             walk_list!(visitor, visit_label, opt_label);
 842             visitor.visit_expr(subexpression);
 843             visitor.visit_block(block);
 844         }
 845         ExprKind::ForLoop(ref pattern, ref subexpression, ref block, ref opt_label) => {
 846             walk_list!(visitor, visit_label, opt_label);
 847             visitor.visit_pat(pattern);
 848             visitor.visit_expr(subexpression);
 849             visitor.visit_block(block);
 850         }
 851         ExprKind::Loop(ref block, ref opt_label) => {
 852             walk_list!(visitor, visit_label, opt_label);
 853             visitor.visit_block(block);
 854         }
 855         ExprKind::Match(ref subexpression, ref arms) => {
 856             visitor.visit_expr(subexpression);
 857             walk_list!(visitor, visit_arm, arms);
 858         }
 859         ExprKind::Closure(ref binder, _, _, _, ref decl, ref body, _decl_span) => {
 860             visitor.visit_fn(FnKind::Closure(binder, decl, body), expression.span, expression.id)
 861         }
 862         ExprKind::Block(ref block, ref opt_label) => {
 863             walk_list!(visitor, visit_label, opt_label);
 864             visitor.visit_block(block);
 865         }
 866         ExprKind::Async(_, _, ref body) => {
 867             visitor.visit_block(body);
 868         }
 869         ExprKind::Await(ref expr) => visitor.visit_expr(expr),
 870         ExprKind::Assign(ref lhs, ref rhs, _) => {
 871             visitor.visit_expr(lhs);
 872             visitor.visit_expr(rhs);
 873         }
 874         ExprKind::AssignOp(_, ref left_expression, ref right_expression) => {
 875             visitor.visit_expr(left_expression);
 876             visitor.visit_expr(right_expression);
 877         }
 878         ExprKind::Field(ref subexpression, ident) => {
 879             visitor.visit_expr(subexpression);
 880             visitor.visit_ident(ident);
 881         }
 882         ExprKind::Index(ref main_expression, ref index_expression) => {
 883             visitor.visit_expr(main_expression);
 884             visitor.visit_expr(index_expression)
 885         }
 886         ExprKind::Range(ref start, ref end, _) => {
 887             walk_list!(visitor, visit_expr, start);
 888             walk_list!(visitor, visit_expr, end);
 889         }
 890         ExprKind::Underscore => {}
 891         ExprKind::Path(ref maybe_qself, ref path) => {
 892             if let Some(ref qself) = *maybe_qself {
 893                 visitor.visit_ty(&qself.ty);
 894             }
 895             visitor.visit_path(path, expression.id)
 896         }
 897         ExprKind::Break(ref opt_label, ref opt_expr) => {
 898             walk_list!(visitor, visit_label, opt_label);
 899             walk_list!(visitor, visit_expr, opt_expr);
 900         }
 901         ExprKind::Continue(ref opt_label) => {
 902             walk_list!(visitor, visit_label, opt_label);
 903         }
 904         ExprKind::Ret(ref optional_expression) => {
 905             walk_list!(visitor, visit_expr, optional_expression);
 906         }
 907         ExprKind::Yeet(ref optional_expression) => {
 908             walk_list!(visitor, visit_expr, optional_expression);
 909         }
 910         ExprKind::MacCall(ref mac) => visitor.visit_mac_call(mac),
 911         ExprKind::Paren(ref subexpression) => visitor.visit_expr(subexpression),
 912         ExprKind::InlineAsm(ref asm) => visitor.visit_inline_asm(asm),
 913         ExprKind::Yield(ref optional_expression) => {
 914             walk_list!(visitor, visit_expr, optional_expression);
 915         }
 916         ExprKind::Try(ref subexpression) => visitor.visit_expr(subexpression),
 917         ExprKind::TryBlock(ref body) => visitor.visit_block(body),
 918         ExprKind::Lit(_) | ExprKind::Err => {}
 919     }
 920
 921     visitor.visit_expr_post(expression)
 922 }
 923
 924 pub fn walk_param<'a, V: Visitor<'a>>(visitor: &mut V, param: &'a Param) {
 925     walk_list!(visitor, visit_attribute, param.attrs.iter());
 926     visitor.visit_pat(&param.pat);
 927     visitor.visit_ty(&param.ty);
 928 }
 929
 930 pub fn walk_arm<'a, V: Visitor<'a>>(visitor: &mut V, arm: &'a Arm) {
 931     visitor.visit_pat(&arm.pat);
 932     walk_list!(visitor, visit_expr, &arm.guard);
 933     visitor.visit_expr(&arm.body);
 934     walk_list!(visitor, visit_attribute, &arm.attrs);
 935 }
 936
 937 pub fn walk_vis<'a, V: Visitor<'a>>(visitor: &mut V, vis: &'a Visibility) {
 938     if let VisibilityKind::Restricted { ref path, id } = vis.kind {
 939         visitor.visit_path(path, id);
 940     }
 941 }
 942
 943 pub fn walk_attribute<'a, V: Visitor<'a>>(visitor: &mut V, attr: &'a Attribute) {
 944     match attr.kind {
 945         AttrKind::Normal(ref item, ref _tokens) => walk_mac_args(visitor, &item.args),
 946         AttrKind::DocComment(..) => {}
 947     }
 948 }
 949
 950 pub fn walk_mac_args<'a, V: Visitor<'a>>(visitor: &mut V, args: &'a MacArgs) {
 951     match args {
 952         MacArgs::Empty => {}
 953         MacArgs::Delimited(_dspan, _delim, _tokens) => {}
 954         MacArgs::Eq(_eq_span, MacArgsEq::Ast(expr)) => visitor.visit_expr(expr),
 955         MacArgs::Eq(_, MacArgsEq::Hir(lit)) => {
 956             unreachable!("in literal form when walking mac args eq: {:?}", lit)
 957         }
 958     }
 959 }