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