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     /// This method is a hack to workaround unstable of `stmt_expr_attributes`.
 144     /// It can be removed once that feature is stabilized.
 145     fn visit_method_receiver_expr(&mut self, ex: &'ast Expr) {
 146         self.visit_expr(ex)
 147     }
 148     fn visit_expr_post(&mut self, _ex: &'ast Expr) {}
 149     fn visit_ty(&mut self, t: &'ast Ty) {
 150         walk_ty(self, t)
 151     }
 152     fn visit_generic_param(&mut self, param: &'ast GenericParam) {
 153         walk_generic_param(self, param)
 154     }
 155     fn visit_generics(&mut self, g: &'ast Generics) {
 156         walk_generics(self, g)
 157     }
 158     fn visit_closure_binder(&mut self, b: &'ast ClosureBinder) {
 159         walk_closure_binder(self, b)
 160     }
 161     fn visit_where_predicate(&mut self, p: &'ast WherePredicate) {
 162         walk_where_predicate(self, p)
 163     }
 164     fn visit_fn(&mut self, fk: FnKind<'ast>, _: Span, _: NodeId) {
 165         walk_fn(self, fk)
 166     }
 167     fn visit_assoc_item(&mut self, i: &'ast AssocItem, ctxt: AssocCtxt) {
 168         walk_assoc_item(self, i, ctxt)
 169     }
 170     fn visit_trait_ref(&mut self, t: &'ast TraitRef) {
 171         walk_trait_ref(self, t)
 172     }
 173     fn visit_param_bound(&mut self, bounds: &'ast GenericBound, _ctxt: BoundKind) {
 174         walk_param_bound(self, bounds)
 175     }
 176     fn visit_poly_trait_ref(&mut self, t: &'ast PolyTraitRef) {
 177         walk_poly_trait_ref(self, t)
 178     }
 179     fn visit_variant_data(&mut self, s: &'ast VariantData) {
 180         walk_struct_def(self, s)
 181     }
 182     fn visit_field_def(&mut self, s: &'ast FieldDef) {
 183         walk_field_def(self, s)
 184     }
 185     fn visit_enum_def(&mut self, enum_definition: &'ast EnumDef) {
 186         walk_enum_def(self, enum_definition)
 187     }
 188     fn visit_variant(&mut self, v: &'ast Variant) {
 189         walk_variant(self, v)
 190     }
 191     fn visit_label(&mut self, label: &'ast Label) {
 192         walk_label(self, label)
 193     }
 194     fn visit_lifetime(&mut self, lifetime: &'ast Lifetime, _: LifetimeCtxt) {
 195         walk_lifetime(self, lifetime)
 196     }
 197     fn visit_mac_call(&mut self, mac: &'ast MacCall) {
 198         walk_mac(self, mac)
 199     }
 200     fn visit_mac_def(&mut self, _mac: &'ast MacroDef, _id: NodeId) {
 201         // Nothing to do
 202     }
 203     fn visit_path(&mut self, path: &'ast Path, _id: NodeId) {
 204         walk_path(self, path)
 205     }
 206     fn visit_use_tree(&mut self, use_tree: &'ast UseTree, id: NodeId, _nested: bool) {
 207         walk_use_tree(self, use_tree, id)
 208     }
 209     fn visit_path_segment(&mut self, path_segment: &'ast PathSegment) {
 210         walk_path_segment(self, path_segment)
 211     }
 212     fn visit_generic_args(&mut self, generic_args: &'ast GenericArgs) {
 213         walk_generic_args(self, generic_args)
 214     }
 215     fn visit_generic_arg(&mut self, generic_arg: &'ast GenericArg) {
 216         walk_generic_arg(self, generic_arg)
 217     }
 218     fn visit_assoc_constraint(&mut self, constraint: &'ast AssocConstraint) {
 219         walk_assoc_constraint(self, constraint)
 220     }
 221     fn visit_attribute(&mut self, attr: &'ast Attribute) {
 222         walk_attribute(self, attr)
 223     }
 224     fn visit_vis(&mut self, vis: &'ast Visibility) {
 225         walk_vis(self, vis)
 226     }
 227     fn visit_fn_ret_ty(&mut self, ret_ty: &'ast FnRetTy) {
 228         walk_fn_ret_ty(self, ret_ty)
 229     }
 230     fn visit_fn_header(&mut self, _header: &'ast FnHeader) {
 231         // Nothing to do
 232     }
 233     fn visit_expr_field(&mut self, f: &'ast ExprField) {
 234         walk_expr_field(self, f)
 235     }
 236     fn visit_pat_field(&mut self, fp: &'ast PatField) {
 237         walk_pat_field(self, fp)
 238     }
 239     fn visit_crate(&mut self, krate: &'ast Crate) {
 240         walk_crate(self, krate)
 241     }
 242     fn visit_inline_asm(&mut self, asm: &'ast InlineAsm) {
 243         walk_inline_asm(self, asm)
 244     }
 245     fn visit_inline_asm_sym(&mut self, sym: &'ast InlineAsmSym) {
 246         walk_inline_asm_sym(self, sym)
 247     }
 248 }
 249
 250 #[macro_export]
 251 macro_rules! walk_list {
 252     ($visitor: expr, $method: ident, $list: expr $(, $($extra_args: expr),* )?) => {
 253         {
 254             #[cfg_attr(not(bootstrap), allow(for_loops_over_fallibles))]
 255             for elem in $list {
 256                 $visitor.$method(elem $(, $($extra_args,)* )?)
 257             }
 258         }
 259     }
 260 }
 261
 262 pub fn walk_crate<'a, V: Visitor<'a>>(visitor: &mut V, krate: &'a Crate) {
 263     walk_list!(visitor, visit_item, &krate.items);
 264     walk_list!(visitor, visit_attribute, &krate.attrs);
 265 }
 266
 267 pub fn walk_local<'a, V: Visitor<'a>>(visitor: &mut V, local: &'a Local) {
 268     for attr in local.attrs.iter() {
 269         visitor.visit_attribute(attr);
 270     }
 271     visitor.visit_pat(&local.pat);
 272     walk_list!(visitor, visit_ty, &local.ty);
 273     if let Some((init, els)) = local.kind.init_else_opt() {
 274         visitor.visit_expr(init);
 275         walk_list!(visitor, visit_block, els);
 276     }
 277 }
 278
 279 pub fn walk_label<'a, V: Visitor<'a>>(visitor: &mut V, label: &'a Label) {
 280     visitor.visit_ident(label.ident);
 281 }
 282
 283 pub fn walk_lifetime<'a, V: Visitor<'a>>(visitor: &mut V, lifetime: &'a Lifetime) {
 284     visitor.visit_ident(lifetime.ident);
 285 }
 286
 287 pub fn walk_poly_trait_ref<'a, V>(visitor: &mut V, trait_ref: &'a PolyTraitRef)
 288 where
 289     V: Visitor<'a>,
 290 {
 291     walk_list!(visitor, visit_generic_param, &trait_ref.bound_generic_params);
 292     visitor.visit_trait_ref(&trait_ref.trait_ref);
 293 }
 294
 295 pub fn walk_trait_ref<'a, V: Visitor<'a>>(visitor: &mut V, trait_ref: &'a TraitRef) {
 296     visitor.visit_path(&trait_ref.path, trait_ref.ref_id)
 297 }
 298
 299 pub fn walk_item<'a, V: Visitor<'a>>(visitor: &mut V, item: &'a Item) {
 300     visitor.visit_vis(&item.vis);
 301     visitor.visit_ident(item.ident);
 302     match item.kind {
 303         ItemKind::ExternCrate(_) => {}
 304         ItemKind::Use(ref use_tree) => visitor.visit_use_tree(use_tree, item.id, false),
 305         ItemKind::Static(ref typ, _, ref expr) | ItemKind::Const(_, ref typ, ref expr) => {
 306             visitor.visit_ty(typ);
 307             walk_list!(visitor, visit_expr, expr);
 308         }
 309         ItemKind::Fn(box Fn { defaultness: _, ref generics, ref sig, ref body }) => {
 310             let kind =
 311                 FnKind::Fn(FnCtxt::Free, item.ident, sig, &item.vis, generics, body.as_deref());
 312             visitor.visit_fn(kind, item.span, item.id)
 313         }
 314         ItemKind::Mod(_unsafety, ref mod_kind) => match mod_kind {
 315             ModKind::Loaded(items, _inline, _inner_span) => {
 316                 walk_list!(visitor, visit_item, items)
 317             }
 318             ModKind::Unloaded => {}
 319         },
 320         ItemKind::ForeignMod(ref foreign_module) => {
 321             walk_list!(visitor, visit_foreign_item, &foreign_module.items);
 322         }
 323         ItemKind::GlobalAsm(ref asm) => visitor.visit_inline_asm(asm),
 324         ItemKind::TyAlias(box TyAlias { ref generics, ref bounds, ref ty, .. }) => {
 325             visitor.visit_generics(generics);
 326             walk_list!(visitor, visit_param_bound, bounds, BoundKind::Bound);
 327             walk_list!(visitor, visit_ty, ty);
 328         }
 329         ItemKind::Enum(ref enum_definition, ref generics) => {
 330             visitor.visit_generics(generics);
 331             visitor.visit_enum_def(enum_definition)
 332         }
 333         ItemKind::Impl(box Impl {
 334             defaultness: _,
 335             unsafety: _,
 336             ref generics,
 337             constness: _,
 338             polarity: _,
 339             ref of_trait,
 340             ref self_ty,
 341             ref items,
 342         }) => {
 343             visitor.visit_generics(generics);
 344             walk_list!(visitor, visit_trait_ref, of_trait);
 345             visitor.visit_ty(self_ty);
 346             walk_list!(visitor, visit_assoc_item, items, AssocCtxt::Impl);
 347         }
 348         ItemKind::Struct(ref struct_definition, ref generics)
 349         | ItemKind::Union(ref struct_definition, ref generics) => {
 350             visitor.visit_generics(generics);
 351             visitor.visit_variant_data(struct_definition);
 352         }
 353         ItemKind::Trait(box Trait {
 354             unsafety: _,
 355             is_auto: _,
 356             ref generics,
 357             ref bounds,
 358             ref items,
 359         }) => {
 360             visitor.visit_generics(generics);
 361             walk_list!(visitor, visit_param_bound, bounds, BoundKind::SuperTraits);
 362             walk_list!(visitor, visit_assoc_item, items, AssocCtxt::Trait);
 363         }
 364         ItemKind::TraitAlias(ref generics, ref bounds) => {
 365             visitor.visit_generics(generics);
 366             walk_list!(visitor, visit_param_bound, bounds, BoundKind::Bound);
 367         }
 368         ItemKind::MacCall(ref mac) => visitor.visit_mac_call(mac),
 369         ItemKind::MacroDef(ref ts) => visitor.visit_mac_def(ts, item.id),
 370     }
 371     walk_list!(visitor, visit_attribute, &item.attrs);
 372 }
 373
 374 pub fn walk_enum_def<'a, V: Visitor<'a>>(visitor: &mut V, enum_definition: &'a EnumDef) {
 375     walk_list!(visitor, visit_variant, &enum_definition.variants);
 376 }
 377
 378 pub fn walk_variant<'a, V: Visitor<'a>>(visitor: &mut V, variant: &'a Variant)
 379 where
 380     V: Visitor<'a>,
 381 {
 382     visitor.visit_ident(variant.ident);
 383     visitor.visit_vis(&variant.vis);
 384     visitor.visit_variant_data(&variant.data);
 385     walk_list!(visitor, visit_anon_const, &variant.disr_expr);
 386     walk_list!(visitor, visit_attribute, &variant.attrs);
 387 }
 388
 389 pub fn walk_expr_field<'a, V: Visitor<'a>>(visitor: &mut V, f: &'a ExprField) {
 390     visitor.visit_expr(&f.expr);
 391     visitor.visit_ident(f.ident);
 392     walk_list!(visitor, visit_attribute, f.attrs.iter());
 393 }
 394
 395 pub fn walk_pat_field<'a, V: Visitor<'a>>(visitor: &mut V, fp: &'a PatField) {
 396     visitor.visit_ident(fp.ident);
 397     visitor.visit_pat(&fp.pat);
 398     walk_list!(visitor, visit_attribute, fp.attrs.iter());
 399 }
 400
 401 pub fn walk_ty<'a, V: Visitor<'a>>(visitor: &mut V, typ: &'a Ty) {
 402     match typ.kind {
 403         TyKind::Slice(ref ty) | TyKind::Paren(ref ty) => visitor.visit_ty(ty),
 404         TyKind::Ptr(ref mutable_type) => visitor.visit_ty(&mutable_type.ty),
 405         TyKind::Rptr(ref opt_lifetime, ref mutable_type) => {
 406             walk_list!(visitor, visit_lifetime, opt_lifetime, LifetimeCtxt::Rptr);
 407             visitor.visit_ty(&mutable_type.ty)
 408         }
 409         TyKind::Tup(ref tuple_element_types) => {
 410             walk_list!(visitor, visit_ty, tuple_element_types);
 411         }
 412         TyKind::BareFn(ref function_declaration) => {
 413             walk_list!(visitor, visit_generic_param, &function_declaration.generic_params);
 414             walk_fn_decl(visitor, &function_declaration.decl);
 415         }
 416         TyKind::Path(ref maybe_qself, ref path) => {
 417             if let Some(ref qself) = *maybe_qself {
 418                 visitor.visit_ty(&qself.ty);
 419             }
 420             visitor.visit_path(path, typ.id);
 421         }
 422         TyKind::Array(ref ty, ref length) => {
 423             visitor.visit_ty(ty);
 424             visitor.visit_anon_const(length)
 425         }
 426         TyKind::TraitObject(ref bounds, ..) => {
 427             walk_list!(visitor, visit_param_bound, bounds, BoundKind::TraitObject);
 428         }
 429         TyKind::ImplTrait(_, ref bounds) => {
 430             walk_list!(visitor, visit_param_bound, bounds, BoundKind::Impl);
 431         }
 432         TyKind::Typeof(ref expression) => visitor.visit_anon_const(expression),
 433         TyKind::Infer | TyKind::ImplicitSelf | TyKind::Err => {}
 434         TyKind::MacCall(ref mac) => visitor.visit_mac_call(mac),
 435         TyKind::Never | TyKind::CVarArgs => {}
 436     }
 437 }
 438
 439 pub fn walk_path<'a, V: Visitor<'a>>(visitor: &mut V, path: &'a Path) {
 440     for segment in &path.segments {
 441         visitor.visit_path_segment(segment);
 442     }
 443 }
 444
 445 pub fn walk_use_tree<'a, V: Visitor<'a>>(visitor: &mut V, use_tree: &'a UseTree, id: NodeId) {
 446     visitor.visit_path(&use_tree.prefix, id);
 447     match use_tree.kind {
 448         UseTreeKind::Simple(rename, ..) => {
 449             // The extra IDs are handled during HIR lowering.
 450             if let Some(rename) = rename {
 451                 visitor.visit_ident(rename);
 452             }
 453         }
 454         UseTreeKind::Glob => {}
 455         UseTreeKind::Nested(ref use_trees) => {
 456             for &(ref nested_tree, nested_id) in use_trees {
 457                 visitor.visit_use_tree(nested_tree, nested_id, true);
 458             }
 459         }
 460     }
 461 }
 462
 463 pub fn walk_path_segment<'a, V: Visitor<'a>>(visitor: &mut V, segment: &'a PathSegment) {
 464     visitor.visit_ident(segment.ident);
 465     if let Some(ref args) = segment.args {
 466         visitor.visit_generic_args(args);
 467     }
 468 }
 469
 470 pub fn walk_generic_args<'a, V>(visitor: &mut V, generic_args: &'a GenericArgs)
 471 where
 472     V: Visitor<'a>,
 473 {
 474     match *generic_args {
 475         GenericArgs::AngleBracketed(ref data) => {
 476             for arg in &data.args {
 477                 match arg {
 478                     AngleBracketedArg::Arg(a) => visitor.visit_generic_arg(a),
 479                     AngleBracketedArg::Constraint(c) => visitor.visit_assoc_constraint(c),
 480                 }
 481             }
 482         }
 483         GenericArgs::Parenthesized(ref data) => {
 484             walk_list!(visitor, visit_ty, &data.inputs);
 485             walk_fn_ret_ty(visitor, &data.output);
 486         }
 487     }
 488 }
 489
 490 pub fn walk_generic_arg<'a, V>(visitor: &mut V, generic_arg: &'a GenericArg)
 491 where
 492     V: Visitor<'a>,
 493 {
 494     match generic_arg {
 495         GenericArg::Lifetime(lt) => visitor.visit_lifetime(lt, LifetimeCtxt::GenericArg),
 496         GenericArg::Type(ty) => visitor.visit_ty(ty),
 497         GenericArg::Const(ct) => visitor.visit_anon_const(ct),
 498     }
 499 }
 500
 501 pub fn walk_assoc_constraint<'a, V: Visitor<'a>>(visitor: &mut V, constraint: &'a AssocConstraint) {
 502     visitor.visit_ident(constraint.ident);
 503     if let Some(ref gen_args) = constraint.gen_args {
 504         visitor.visit_generic_args(gen_args);
 505     }
 506     match constraint.kind {
 507         AssocConstraintKind::Equality { ref term } => match term {
 508             Term::Ty(ty) => visitor.visit_ty(ty),
 509             Term::Const(c) => visitor.visit_anon_const(c),
 510         },
 511         AssocConstraintKind::Bound { ref bounds } => {
 512             walk_list!(visitor, visit_param_bound, bounds, BoundKind::Bound);
 513         }
 514     }
 515 }
 516
 517 pub fn walk_pat<'a, V: Visitor<'a>>(visitor: &mut V, pattern: &'a Pat) {
 518     match pattern.kind {
 519         PatKind::TupleStruct(ref opt_qself, ref path, ref elems) => {
 520             if let Some(ref qself) = *opt_qself {
 521                 visitor.visit_ty(&qself.ty);
 522             }
 523             visitor.visit_path(path, pattern.id);
 524             walk_list!(visitor, visit_pat, elems);
 525         }
 526         PatKind::Path(ref opt_qself, ref path) => {
 527             if let Some(ref qself) = *opt_qself {
 528                 visitor.visit_ty(&qself.ty);
 529             }
 530             visitor.visit_path(path, pattern.id)
 531         }
 532         PatKind::Struct(ref opt_qself, ref path, ref fields, _) => {
 533             if let Some(ref qself) = *opt_qself {
 534                 visitor.visit_ty(&qself.ty);
 535             }
 536             visitor.visit_path(path, pattern.id);
 537             walk_list!(visitor, visit_pat_field, fields);
 538         }
 539         PatKind::Box(ref subpattern)
 540         | PatKind::Ref(ref subpattern, _)
 541         | PatKind::Paren(ref subpattern) => visitor.visit_pat(subpattern),
 542         PatKind::Ident(_, ident, ref optional_subpattern) => {
 543             visitor.visit_ident(ident);
 544             walk_list!(visitor, visit_pat, optional_subpattern);
 545         }
 546         PatKind::Lit(ref expression) => visitor.visit_expr(expression),
 547         PatKind::Range(ref lower_bound, ref upper_bound, _) => {
 548             walk_list!(visitor, visit_expr, lower_bound);
 549             walk_list!(visitor, visit_expr, upper_bound);
 550         }
 551         PatKind::Wild | PatKind::Rest => {}
 552         PatKind::Tuple(ref elems) | PatKind::Slice(ref elems) | PatKind::Or(ref elems) => {
 553             walk_list!(visitor, visit_pat, elems);
 554         }
 555         PatKind::MacCall(ref mac) => visitor.visit_mac_call(mac),
 556     }
 557 }
 558
 559 pub fn walk_foreign_item<'a, V: Visitor<'a>>(visitor: &mut V, item: &'a ForeignItem) {
 560     let Item { id, span, ident, ref vis, ref attrs, ref kind, tokens: _ } = *item;
 561     visitor.visit_vis(vis);
 562     visitor.visit_ident(ident);
 563     walk_list!(visitor, visit_attribute, attrs);
 564     match kind {
 565         ForeignItemKind::Static(ty, _, expr) => {
 566             visitor.visit_ty(ty);
 567             walk_list!(visitor, visit_expr, expr);
 568         }
 569         ForeignItemKind::Fn(box Fn { defaultness: _, ref generics, ref sig, ref body }) => {
 570             let kind = FnKind::Fn(FnCtxt::Foreign, ident, sig, vis, generics, body.as_deref());
 571             visitor.visit_fn(kind, span, id);
 572         }
 573         ForeignItemKind::TyAlias(box TyAlias { generics, bounds, ty, .. }) => {
 574             visitor.visit_generics(generics);
 575             walk_list!(visitor, visit_param_bound, bounds, BoundKind::Bound);
 576             walk_list!(visitor, visit_ty, ty);
 577         }
 578         ForeignItemKind::MacCall(mac) => {
 579             visitor.visit_mac_call(mac);
 580         }
 581     }
 582 }
 583
 584 pub fn walk_param_bound<'a, V: Visitor<'a>>(visitor: &mut V, bound: &'a GenericBound) {
 585     match *bound {
 586         GenericBound::Trait(ref typ, ref _modifier) => visitor.visit_poly_trait_ref(typ),
 587         GenericBound::Outlives(ref lifetime) => {
 588             visitor.visit_lifetime(lifetime, LifetimeCtxt::Bound)
 589         }
 590     }
 591 }
 592
 593 pub fn walk_generic_param<'a, V: Visitor<'a>>(visitor: &mut V, param: &'a GenericParam) {
 594     visitor.visit_ident(param.ident);
 595     walk_list!(visitor, visit_attribute, param.attrs.iter());
 596     walk_list!(visitor, visit_param_bound, &param.bounds, BoundKind::Bound);
 597     match param.kind {
 598         GenericParamKind::Lifetime => (),
 599         GenericParamKind::Type { ref default } => walk_list!(visitor, visit_ty, default),
 600         GenericParamKind::Const { ref ty, ref default, .. } => {
 601             visitor.visit_ty(ty);
 602             if let Some(default) = default {
 603                 visitor.visit_anon_const(default);
 604             }
 605         }
 606     }
 607 }
 608
 609 pub fn walk_generics<'a, V: Visitor<'a>>(visitor: &mut V, generics: &'a Generics) {
 610     walk_list!(visitor, visit_generic_param, &generics.params);
 611     walk_list!(visitor, visit_where_predicate, &generics.where_clause.predicates);
 612 }
 613
 614 pub fn walk_closure_binder<'a, V: Visitor<'a>>(visitor: &mut V, binder: &'a ClosureBinder) {
 615     match binder {
 616         ClosureBinder::NotPresent => {}
 617         ClosureBinder::For { generic_params, span: _ } => {
 618             walk_list!(visitor, visit_generic_param, generic_params)
 619         }
 620     }
 621 }
 622
 623 pub fn walk_where_predicate<'a, V: Visitor<'a>>(visitor: &mut V, predicate: &'a WherePredicate) {
 624     match *predicate {
 625         WherePredicate::BoundPredicate(WhereBoundPredicate {
 626             ref bounded_ty,
 627             ref bounds,
 628             ref bound_generic_params,
 629             ..
 630         }) => {
 631             visitor.visit_ty(bounded_ty);
 632             walk_list!(visitor, visit_param_bound, bounds, BoundKind::Bound);
 633             walk_list!(visitor, visit_generic_param, bound_generic_params);
 634         }
 635         WherePredicate::RegionPredicate(WhereRegionPredicate {
 636             ref lifetime, ref bounds, ..
 637         }) => {
 638             visitor.visit_lifetime(lifetime, LifetimeCtxt::Bound);
 639             walk_list!(visitor, visit_param_bound, bounds, BoundKind::Bound);
 640         }
 641         WherePredicate::EqPredicate(WhereEqPredicate { ref lhs_ty, ref rhs_ty, .. }) => {
 642             visitor.visit_ty(lhs_ty);
 643             visitor.visit_ty(rhs_ty);
 644         }
 645     }
 646 }
 647
 648 pub fn walk_fn_ret_ty<'a, V: Visitor<'a>>(visitor: &mut V, ret_ty: &'a FnRetTy) {
 649     if let FnRetTy::Ty(ref output_ty) = *ret_ty {
 650         visitor.visit_ty(output_ty)
 651     }
 652 }
 653
 654 pub fn walk_fn_decl<'a, V: Visitor<'a>>(visitor: &mut V, function_declaration: &'a FnDecl) {
 655     for param in &function_declaration.inputs {
 656         visitor.visit_param(param);
 657     }
 658     visitor.visit_fn_ret_ty(&function_declaration.output);
 659 }
 660
 661 pub fn walk_fn<'a, V: Visitor<'a>>(visitor: &mut V, kind: FnKind<'a>) {
 662     match kind {
 663         FnKind::Fn(_, _, sig, _, generics, body) => {
 664             visitor.visit_generics(generics);
 665             visitor.visit_fn_header(&sig.header);
 666             walk_fn_decl(visitor, &sig.decl);
 667             walk_list!(visitor, visit_block, body);
 668         }
 669         FnKind::Closure(binder, decl, body) => {
 670             visitor.visit_closure_binder(binder);
 671             walk_fn_decl(visitor, decl);
 672             visitor.visit_expr(body);
 673         }
 674     }
 675 }
 676
 677 pub fn walk_assoc_item<'a, V: Visitor<'a>>(visitor: &mut V, item: &'a AssocItem, ctxt: AssocCtxt) {
 678     let Item { id, span, ident, ref vis, ref attrs, ref kind, tokens: _ } = *item;
 679     visitor.visit_vis(vis);
 680     visitor.visit_ident(ident);
 681     walk_list!(visitor, visit_attribute, attrs);
 682     match kind {
 683         AssocItemKind::Const(_, ty, expr) => {
 684             visitor.visit_ty(ty);
 685             walk_list!(visitor, visit_expr, expr);
 686         }
 687         AssocItemKind::Fn(box Fn { defaultness: _, ref generics, ref sig, ref body }) => {
 688             let kind = FnKind::Fn(FnCtxt::Assoc(ctxt), ident, sig, vis, generics, body.as_deref());
 689             visitor.visit_fn(kind, span, id);
 690         }
 691         AssocItemKind::Type(box TyAlias { generics, bounds, ty, .. }) => {
 692             visitor.visit_generics(generics);
 693             walk_list!(visitor, visit_param_bound, bounds, BoundKind::Bound);
 694             walk_list!(visitor, visit_ty, ty);
 695         }
 696         AssocItemKind::MacCall(mac) => {
 697             visitor.visit_mac_call(mac);
 698         }
 699     }
 700 }
 701
 702 pub fn walk_struct_def<'a, V: Visitor<'a>>(visitor: &mut V, struct_definition: &'a VariantData) {
 703     walk_list!(visitor, visit_field_def, struct_definition.fields());
 704 }
 705
 706 pub fn walk_field_def<'a, V: Visitor<'a>>(visitor: &mut V, field: &'a FieldDef) {
 707     visitor.visit_vis(&field.vis);
 708     if let Some(ident) = field.ident {
 709         visitor.visit_ident(ident);
 710     }
 711     visitor.visit_ty(&field.ty);
 712     walk_list!(visitor, visit_attribute, &field.attrs);
 713 }
 714
 715 pub fn walk_block<'a, V: Visitor<'a>>(visitor: &mut V, block: &'a Block) {
 716     walk_list!(visitor, visit_stmt, &block.stmts);
 717 }
 718
 719 pub fn walk_stmt<'a, V: Visitor<'a>>(visitor: &mut V, statement: &'a Stmt) {
 720     match statement.kind {
 721         StmtKind::Local(ref local) => visitor.visit_local(local),
 722         StmtKind::Item(ref item) => visitor.visit_item(item),
 723         StmtKind::Expr(ref expr) | StmtKind::Semi(ref expr) => visitor.visit_expr(expr),
 724         StmtKind::Empty => {}
 725         StmtKind::MacCall(ref mac) => {
 726             let MacCallStmt { ref mac, style: _, ref attrs, tokens: _ } = **mac;
 727             visitor.visit_mac_call(mac);
 728             for attr in attrs.iter() {
 729                 visitor.visit_attribute(attr);
 730             }
 731         }
 732     }
 733 }
 734
 735 pub fn walk_mac<'a, V: Visitor<'a>>(visitor: &mut V, mac: &'a MacCall) {
 736     visitor.visit_path(&mac.path, DUMMY_NODE_ID);
 737 }
 738
 739 pub fn walk_anon_const<'a, V: Visitor<'a>>(visitor: &mut V, constant: &'a AnonConst) {
 740     visitor.visit_expr(&constant.value);
 741 }
 742
 743 pub fn walk_inline_asm<'a, V: Visitor<'a>>(visitor: &mut V, asm: &'a InlineAsm) {
 744     for (op, _) in &asm.operands {
 745         match op {
 746             InlineAsmOperand::In { expr, .. }
 747             | InlineAsmOperand::Out { expr: Some(expr), .. }
 748             | InlineAsmOperand::InOut { expr, .. } => visitor.visit_expr(expr),
 749             InlineAsmOperand::Out { expr: None, .. } => {}
 750             InlineAsmOperand::SplitInOut { in_expr, out_expr, .. } => {
 751                 visitor.visit_expr(in_expr);
 752                 if let Some(out_expr) = out_expr {
 753                     visitor.visit_expr(out_expr);
 754                 }
 755             }
 756             InlineAsmOperand::Const { anon_const, .. } => visitor.visit_anon_const(anon_const),
 757             InlineAsmOperand::Sym { sym } => visitor.visit_inline_asm_sym(sym),
 758         }
 759     }
 760 }
 761
 762 pub fn walk_inline_asm_sym<'a, V: Visitor<'a>>(visitor: &mut V, sym: &'a InlineAsmSym) {
 763     if let Some(ref qself) = sym.qself {
 764         visitor.visit_ty(&qself.ty);
 765     }
 766     visitor.visit_path(&sym.path, sym.id);
 767 }
 768
 769 pub fn walk_expr<'a, V: Visitor<'a>>(visitor: &mut V, expression: &'a Expr) {
 770     walk_list!(visitor, visit_attribute, expression.attrs.iter());
 771
 772     match expression.kind {
 773         ExprKind::Box(ref subexpression) => visitor.visit_expr(subexpression),
 774         ExprKind::Array(ref subexpressions) => {
 775             walk_list!(visitor, visit_expr, subexpressions);
 776         }
 777         ExprKind::ConstBlock(ref anon_const) => visitor.visit_anon_const(anon_const),
 778         ExprKind::Repeat(ref element, ref count) => {
 779             visitor.visit_expr(element);
 780             visitor.visit_anon_const(count)
 781         }
 782         ExprKind::Struct(ref se) => {
 783             if let Some(ref qself) = se.qself {
 784                 visitor.visit_ty(&qself.ty);
 785             }
 786             visitor.visit_path(&se.path, expression.id);
 787             walk_list!(visitor, visit_expr_field, &se.fields);
 788             match &se.rest {
 789                 StructRest::Base(expr) => visitor.visit_expr(expr),
 790                 StructRest::Rest(_span) => {}
 791                 StructRest::None => {}
 792             }
 793         }
 794         ExprKind::Tup(ref subexpressions) => {
 795             walk_list!(visitor, visit_expr, subexpressions);
 796         }
 797         ExprKind::Call(ref callee_expression, ref arguments) => {
 798             visitor.visit_expr(callee_expression);
 799             walk_list!(visitor, visit_expr, arguments);
 800         }
 801         ExprKind::MethodCall(ref segment, ref receiver, ref arguments, _span) => {
 802             visitor.visit_path_segment(segment);
 803             visitor.visit_expr(receiver);
 804             walk_list!(visitor, visit_expr, arguments);
 805         }
 806         ExprKind::Binary(_, ref left_expression, ref right_expression) => {
 807             visitor.visit_expr(left_expression);
 808             visitor.visit_expr(right_expression)
 809         }
 810         ExprKind::AddrOf(_, _, ref subexpression) | ExprKind::Unary(_, ref subexpression) => {
 811             visitor.visit_expr(subexpression)
 812         }
 813         ExprKind::Cast(ref subexpression, ref typ) | ExprKind::Type(ref subexpression, ref typ) => {
 814             visitor.visit_expr(subexpression);
 815             visitor.visit_ty(typ)
 816         }
 817         ExprKind::Let(ref pat, ref expr, _) => {
 818             visitor.visit_pat(pat);
 819             visitor.visit_expr(expr);
 820         }
 821         ExprKind::If(ref head_expression, ref if_block, ref optional_else) => {
 822             visitor.visit_expr(head_expression);
 823             visitor.visit_block(if_block);
 824             walk_list!(visitor, visit_expr, optional_else);
 825         }
 826         ExprKind::While(ref subexpression, ref block, ref opt_label) => {
 827             walk_list!(visitor, visit_label, opt_label);
 828             visitor.visit_expr(subexpression);
 829             visitor.visit_block(block);
 830         }
 831         ExprKind::ForLoop(ref pattern, ref subexpression, ref block, ref opt_label) => {
 832             walk_list!(visitor, visit_label, opt_label);
 833             visitor.visit_pat(pattern);
 834             visitor.visit_expr(subexpression);
 835             visitor.visit_block(block);
 836         }
 837         ExprKind::Loop(ref block, ref opt_label) => {
 838             walk_list!(visitor, visit_label, opt_label);
 839             visitor.visit_block(block);
 840         }
 841         ExprKind::Match(ref subexpression, ref arms) => {
 842             visitor.visit_expr(subexpression);
 843             walk_list!(visitor, visit_arm, arms);
 844         }
 845         ExprKind::Closure(ref binder, _, _, _, ref decl, ref body, _decl_span) => {
 846             visitor.visit_fn(FnKind::Closure(binder, decl, body), expression.span, expression.id)
 847         }
 848         ExprKind::Block(ref block, ref opt_label) => {
 849             walk_list!(visitor, visit_label, opt_label);
 850             visitor.visit_block(block);
 851         }
 852         ExprKind::Async(_, _, ref body) => {
 853             visitor.visit_block(body);
 854         }
 855         ExprKind::Await(ref expr) => visitor.visit_expr(expr),
 856         ExprKind::Assign(ref lhs, ref rhs, _) => {
 857             visitor.visit_expr(lhs);
 858             visitor.visit_expr(rhs);
 859         }
 860         ExprKind::AssignOp(_, ref left_expression, ref right_expression) => {
 861             visitor.visit_expr(left_expression);
 862             visitor.visit_expr(right_expression);
 863         }
 864         ExprKind::Field(ref subexpression, ident) => {
 865             visitor.visit_expr(subexpression);
 866             visitor.visit_ident(ident);
 867         }
 868         ExprKind::Index(ref main_expression, ref index_expression) => {
 869             visitor.visit_expr(main_expression);
 870             visitor.visit_expr(index_expression)
 871         }
 872         ExprKind::Range(ref start, ref end, _) => {
 873             walk_list!(visitor, visit_expr, start);
 874             walk_list!(visitor, visit_expr, end);
 875         }
 876         ExprKind::Underscore => {}
 877         ExprKind::Path(ref maybe_qself, ref path) => {
 878             if let Some(ref qself) = *maybe_qself {
 879                 visitor.visit_ty(&qself.ty);
 880             }
 881             visitor.visit_path(path, expression.id)
 882         }
 883         ExprKind::Break(ref opt_label, ref opt_expr) => {
 884             walk_list!(visitor, visit_label, opt_label);
 885             walk_list!(visitor, visit_expr, opt_expr);
 886         }
 887         ExprKind::Continue(ref opt_label) => {
 888             walk_list!(visitor, visit_label, opt_label);
 889         }
 890         ExprKind::Ret(ref optional_expression) => {
 891             walk_list!(visitor, visit_expr, optional_expression);
 892         }
 893         ExprKind::Yeet(ref optional_expression) => {
 894             walk_list!(visitor, visit_expr, optional_expression);
 895         }
 896         ExprKind::MacCall(ref mac) => visitor.visit_mac_call(mac),
 897         ExprKind::Paren(ref subexpression) => visitor.visit_expr(subexpression),
 898         ExprKind::InlineAsm(ref asm) => visitor.visit_inline_asm(asm),
 899         ExprKind::Yield(ref optional_expression) => {
 900             walk_list!(visitor, visit_expr, optional_expression);
 901         }
 902         ExprKind::Try(ref subexpression) => visitor.visit_expr(subexpression),
 903         ExprKind::TryBlock(ref body) => visitor.visit_block(body),
 904         ExprKind::Lit(_) | ExprKind::Err => {}
 905     }
 906
 907     visitor.visit_expr_post(expression)
 908 }
 909
 910 pub fn walk_param<'a, V: Visitor<'a>>(visitor: &mut V, param: &'a Param) {
 911     walk_list!(visitor, visit_attribute, param.attrs.iter());
 912     visitor.visit_pat(&param.pat);
 913     visitor.visit_ty(&param.ty);
 914 }
 915
 916 pub fn walk_arm<'a, V: Visitor<'a>>(visitor: &mut V, arm: &'a Arm) {
 917     visitor.visit_pat(&arm.pat);
 918     walk_list!(visitor, visit_expr, &arm.guard);
 919     visitor.visit_expr(&arm.body);
 920     walk_list!(visitor, visit_attribute, &arm.attrs);
 921 }
 922
 923 pub fn walk_vis<'a, V: Visitor<'a>>(visitor: &mut V, vis: &'a Visibility) {
 924     if let VisibilityKind::Restricted { ref path, id, shorthand: _ } = vis.kind {
 925         visitor.visit_path(path, id);
 926     }
 927 }
 928
 929 pub fn walk_attribute<'a, V: Visitor<'a>>(visitor: &mut V, attr: &'a Attribute) {
 930     match attr.kind {
 931         AttrKind::Normal(ref normal) => walk_mac_args(visitor, &normal.item.args),
 932         AttrKind::DocComment(..) => {}
 933     }
 934 }
 935
 936 pub fn walk_mac_args<'a, V: Visitor<'a>>(visitor: &mut V, args: &'a MacArgs) {
 937     match args {
 938         MacArgs::Empty => {}
 939         MacArgs::Delimited(_dspan, _delim, _tokens) => {}
 940         MacArgs::Eq(_eq_span, MacArgsEq::Ast(expr)) => visitor.visit_expr(expr),
 941         MacArgs::Eq(_, MacArgsEq::Hir(lit)) => {
 942             unreachable!("in literal form when walking mac args eq: {:?}", lit)
 943         }
 944     }
 945 }