src/libsyntax/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 use crate::token::Token;
  18 use crate::tokenstream::{TokenStream, TokenTree};
  19
  20 use rustc_span::Span;
  21
  22 #[derive(Copy, Clone)]
  23 pub enum FnKind<'a> {
  24     /// E.g., `fn foo()` or `extern "Abi" fn foo()`.
  25     ItemFn(Ident, &'a FnHeader, &'a Visibility, &'a Block),
  26
  27     /// E.g., `fn foo(&self)`.
  28     Method(Ident, &'a FnSig, &'a Visibility, &'a Block),
  29
  30     /// E.g., `|x, y| body`.
  31     Closure(&'a Expr),
  32 }
  33
  34 impl<'a> FnKind<'a> {
  35     pub fn header(&self) -> Option<&'a FnHeader> {
  36         match *self {
  37             FnKind::ItemFn(_, header, _, _) => Some(header),
  38             FnKind::Method(_, sig, _, _) => Some(&sig.header),
  39             FnKind::Closure(_) => None,
  40         }
  41     }
  42 }
  43
  44 /// Each method of the `Visitor` trait is a hook to be potentially
  45 /// overridden. Each method's default implementation recursively visits
  46 /// the substructure of the input via the corresponding `walk` method;
  47 /// e.g., the `visit_mod` method by default calls `visit::walk_mod`.
  48 ///
  49 /// If you want to ensure that your code handles every variant
  50 /// explicitly, you need to override each method. (And you also need
  51 /// to monitor future changes to `Visitor` in case a new method with a
  52 /// new default implementation gets introduced.)
  53 pub trait Visitor<'ast>: Sized {
  54     fn visit_name(&mut self, _span: Span, _name: Name) {
  55         // Nothing to do.
  56     }
  57     fn visit_ident(&mut self, ident: Ident) {
  58         walk_ident(self, ident);
  59     }
  60     fn visit_mod(&mut self, m: &'ast Mod, _s: Span, _attrs: &[Attribute], _n: NodeId) {
  61         walk_mod(self, m);
  62     }
  63     fn visit_foreign_item(&mut self, i: &'ast ForeignItem) {
  64         walk_foreign_item(self, i)
  65     }
  66     fn visit_global_asm(&mut self, ga: &'ast GlobalAsm) {
  67         walk_global_asm(self, ga)
  68     }
  69     fn visit_item(&mut self, i: &'ast Item) {
  70         walk_item(self, i)
  71     }
  72     fn visit_local(&mut self, l: &'ast Local) {
  73         walk_local(self, l)
  74     }
  75     fn visit_block(&mut self, b: &'ast Block) {
  76         walk_block(self, b)
  77     }
  78     fn visit_stmt(&mut self, s: &'ast Stmt) {
  79         walk_stmt(self, s)
  80     }
  81     fn visit_param(&mut self, param: &'ast Param) {
  82         walk_param(self, param)
  83     }
  84     fn visit_arm(&mut self, a: &'ast Arm) {
  85         walk_arm(self, a)
  86     }
  87     fn visit_pat(&mut self, p: &'ast Pat) {
  88         walk_pat(self, p)
  89     }
  90     fn visit_anon_const(&mut self, c: &'ast AnonConst) {
  91         walk_anon_const(self, c)
  92     }
  93     fn visit_expr(&mut self, ex: &'ast Expr) {
  94         walk_expr(self, ex)
  95     }
  96     fn visit_expr_post(&mut self, _ex: &'ast Expr) {}
  97     fn visit_ty(&mut self, t: &'ast Ty) {
  98         walk_ty(self, t)
  99     }
 100     fn visit_generic_param(&mut self, param: &'ast GenericParam) {
 101         walk_generic_param(self, param)
 102     }
 103     fn visit_generics(&mut self, g: &'ast Generics) {
 104         walk_generics(self, g)
 105     }
 106     fn visit_where_predicate(&mut self, p: &'ast WherePredicate) {
 107         walk_where_predicate(self, p)
 108     }
 109     fn visit_fn(&mut self, fk: FnKind<'ast>, fd: &'ast FnDecl, s: Span, _: NodeId) {
 110         walk_fn(self, fk, fd, s)
 111     }
 112     fn visit_trait_item(&mut self, i: &'ast AssocItem) {
 113         walk_trait_item(self, i)
 114     }
 115     fn visit_impl_item(&mut self, i: &'ast AssocItem) {
 116         walk_impl_item(self, i)
 117     }
 118     fn visit_assoc_item(&mut self, i: &'ast AssocItem) {
 119         walk_assoc_item(self, i)
 120     }
 121     fn visit_trait_ref(&mut self, t: &'ast TraitRef) {
 122         walk_trait_ref(self, t)
 123     }
 124     fn visit_param_bound(&mut self, bounds: &'ast GenericBound) {
 125         walk_param_bound(self, bounds)
 126     }
 127     fn visit_poly_trait_ref(&mut self, t: &'ast PolyTraitRef, m: &'ast TraitBoundModifier) {
 128         walk_poly_trait_ref(self, t, m)
 129     }
 130     fn visit_variant_data(&mut self, s: &'ast VariantData) {
 131         walk_struct_def(self, s)
 132     }
 133     fn visit_struct_field(&mut self, s: &'ast StructField) {
 134         walk_struct_field(self, s)
 135     }
 136     fn visit_enum_def(
 137         &mut self,
 138         enum_definition: &'ast EnumDef,
 139         generics: &'ast Generics,
 140         item_id: NodeId,
 141         _: Span,
 142     ) {
 143         walk_enum_def(self, enum_definition, generics, item_id)
 144     }
 145     fn visit_variant(&mut self, v: &'ast Variant) {
 146         walk_variant(self, v)
 147     }
 148     fn visit_label(&mut self, label: &'ast Label) {
 149         walk_label(self, label)
 150     }
 151     fn visit_lifetime(&mut self, lifetime: &'ast Lifetime) {
 152         walk_lifetime(self, lifetime)
 153     }
 154     fn visit_mac(&mut self, _mac: &'ast Mac) {
 155         panic!("visit_mac disabled by default");
 156         // N.B., see note about macros above.
 157         // if you really want a visitor that
 158         // works on macros, use this
 159         // definition in your trait impl:
 160         // visit::walk_mac(self, _mac)
 161     }
 162     fn visit_mac_def(&mut self, _mac: &'ast MacroDef, _id: NodeId) {
 163         // Nothing to do
 164     }
 165     fn visit_path(&mut self, path: &'ast Path, _id: NodeId) {
 166         walk_path(self, path)
 167     }
 168     fn visit_use_tree(&mut self, use_tree: &'ast UseTree, id: NodeId, _nested: bool) {
 169         walk_use_tree(self, use_tree, id)
 170     }
 171     fn visit_path_segment(&mut self, path_span: Span, path_segment: &'ast PathSegment) {
 172         walk_path_segment(self, path_span, path_segment)
 173     }
 174     fn visit_generic_args(&mut self, path_span: Span, generic_args: &'ast GenericArgs) {
 175         walk_generic_args(self, path_span, generic_args)
 176     }
 177     fn visit_generic_arg(&mut self, generic_arg: &'ast GenericArg) {
 178         match generic_arg {
 179             GenericArg::Lifetime(lt) => self.visit_lifetime(lt),
 180             GenericArg::Type(ty) => self.visit_ty(ty),
 181             GenericArg::Const(ct) => self.visit_anon_const(ct),
 182         }
 183     }
 184     fn visit_assoc_ty_constraint(&mut self, constraint: &'ast AssocTyConstraint) {
 185         walk_assoc_ty_constraint(self, constraint)
 186     }
 187     fn visit_attribute(&mut self, attr: &'ast Attribute) {
 188         walk_attribute(self, attr)
 189     }
 190     fn visit_tt(&mut self, tt: TokenTree) {
 191         walk_tt(self, tt)
 192     }
 193     fn visit_tts(&mut self, tts: TokenStream) {
 194         walk_tts(self, tts)
 195     }
 196     fn visit_token(&mut self, _t: Token) {}
 197     // FIXME: add `visit_interpolated` and `walk_interpolated`
 198     fn visit_vis(&mut self, vis: &'ast Visibility) {
 199         walk_vis(self, vis)
 200     }
 201     fn visit_fn_ret_ty(&mut self, ret_ty: &'ast FunctionRetTy) {
 202         walk_fn_ret_ty(self, ret_ty)
 203     }
 204     fn visit_fn_header(&mut self, _header: &'ast FnHeader) {
 205         // Nothing to do
 206     }
 207     fn visit_field(&mut self, f: &'ast Field) {
 208         walk_field(self, f)
 209     }
 210     fn visit_field_pattern(&mut self, fp: &'ast FieldPat) {
 211         walk_field_pattern(self, fp)
 212     }
 213 }
 214
 215 #[macro_export]
 216 macro_rules! walk_list {
 217     ($visitor: expr, $method: ident, $list: expr) => {
 218         for elem in $list {
 219             $visitor.$method(elem)
 220         }
 221     };
 222     ($visitor: expr, $method: ident, $list: expr, $($extra_args: expr),*) => {
 223         for elem in $list {
 224             $visitor.$method(elem, $($extra_args,)*)
 225         }
 226     }
 227 }
 228
 229 pub fn walk_ident<'a, V: Visitor<'a>>(visitor: &mut V, ident: Ident) {
 230     visitor.visit_name(ident.span, ident.name);
 231 }
 232
 233 pub fn walk_crate<'a, V: Visitor<'a>>(visitor: &mut V, krate: &'a Crate) {
 234     visitor.visit_mod(&krate.module, krate.span, &krate.attrs, CRATE_NODE_ID);
 235     walk_list!(visitor, visit_attribute, &krate.attrs);
 236 }
 237
 238 pub fn walk_mod<'a, V: Visitor<'a>>(visitor: &mut V, module: &'a Mod) {
 239     walk_list!(visitor, visit_item, &module.items);
 240 }
 241
 242 pub fn walk_local<'a, V: Visitor<'a>>(visitor: &mut V, local: &'a Local) {
 243     for attr in local.attrs.iter() {
 244         visitor.visit_attribute(attr);
 245     }
 246     visitor.visit_pat(&local.pat);
 247     walk_list!(visitor, visit_ty, &local.ty);
 248     walk_list!(visitor, visit_expr, &local.init);
 249 }
 250
 251 pub fn walk_label<'a, V: Visitor<'a>>(visitor: &mut V, label: &'a Label) {
 252     visitor.visit_ident(label.ident);
 253 }
 254
 255 pub fn walk_lifetime<'a, V: Visitor<'a>>(visitor: &mut V, lifetime: &'a Lifetime) {
 256     visitor.visit_ident(lifetime.ident);
 257 }
 258
 259 pub fn walk_poly_trait_ref<'a, V>(
 260     visitor: &mut V,
 261     trait_ref: &'a PolyTraitRef,
 262     _: &TraitBoundModifier,
 263 ) where
 264     V: Visitor<'a>,
 265 {
 266     walk_list!(visitor, visit_generic_param, &trait_ref.bound_generic_params);
 267     visitor.visit_trait_ref(&trait_ref.trait_ref);
 268 }
 269
 270 pub fn walk_trait_ref<'a, V: Visitor<'a>>(visitor: &mut V, trait_ref: &'a TraitRef) {
 271     visitor.visit_path(&trait_ref.path, trait_ref.ref_id)
 272 }
 273
 274 pub fn walk_item<'a, V: Visitor<'a>>(visitor: &mut V, item: &'a Item) {
 275     visitor.visit_vis(&item.vis);
 276     visitor.visit_ident(item.ident);
 277     match item.kind {
 278         ItemKind::ExternCrate(orig_name) => {
 279             if let Some(orig_name) = orig_name {
 280                 visitor.visit_name(item.span, orig_name);
 281             }
 282         }
 283         ItemKind::Use(ref use_tree) => visitor.visit_use_tree(use_tree, item.id, false),
 284         ItemKind::Static(ref typ, _, ref expr) | ItemKind::Const(ref typ, ref expr) => {
 285             visitor.visit_ty(typ);
 286             visitor.visit_expr(expr);
 287         }
 288         ItemKind::Fn(ref sig, ref generics, ref body) => {
 289             visitor.visit_generics(generics);
 290             visitor.visit_fn_header(&sig.header);
 291             visitor.visit_fn(
 292                 FnKind::ItemFn(item.ident, &sig.header, &item.vis, body),
 293                 &sig.decl,
 294                 item.span,
 295                 item.id,
 296             )
 297         }
 298         ItemKind::Mod(ref module) => visitor.visit_mod(module, item.span, &item.attrs, item.id),
 299         ItemKind::ForeignMod(ref foreign_module) => {
 300             walk_list!(visitor, visit_foreign_item, &foreign_module.items);
 301         }
 302         ItemKind::GlobalAsm(ref ga) => visitor.visit_global_asm(ga),
 303         ItemKind::TyAlias(ref typ, ref generics) => {
 304             visitor.visit_ty(typ);
 305             visitor.visit_generics(generics)
 306         }
 307         ItemKind::Enum(ref enum_definition, ref generics) => {
 308             visitor.visit_generics(generics);
 309             visitor.visit_enum_def(enum_definition, generics, item.id, item.span)
 310         }
 311         ItemKind::Impl(_, _, _, ref generics, ref opt_trait_reference, ref typ, ref impl_items) => {
 312             visitor.visit_generics(generics);
 313             walk_list!(visitor, visit_trait_ref, opt_trait_reference);
 314             visitor.visit_ty(typ);
 315             walk_list!(visitor, visit_impl_item, impl_items);
 316         }
 317         ItemKind::Struct(ref struct_definition, ref generics)
 318         | ItemKind::Union(ref struct_definition, ref generics) => {
 319             visitor.visit_generics(generics);
 320             visitor.visit_variant_data(struct_definition);
 321         }
 322         ItemKind::Trait(.., ref generics, ref bounds, ref methods) => {
 323             visitor.visit_generics(generics);
 324             walk_list!(visitor, visit_param_bound, bounds);
 325             walk_list!(visitor, visit_trait_item, methods);
 326         }
 327         ItemKind::TraitAlias(ref generics, ref bounds) => {
 328             visitor.visit_generics(generics);
 329             walk_list!(visitor, visit_param_bound, bounds);
 330         }
 331         ItemKind::Mac(ref mac) => visitor.visit_mac(mac),
 332         ItemKind::MacroDef(ref ts) => visitor.visit_mac_def(ts, item.id),
 333     }
 334     walk_list!(visitor, visit_attribute, &item.attrs);
 335 }
 336
 337 pub fn walk_enum_def<'a, V: Visitor<'a>>(
 338     visitor: &mut V,
 339     enum_definition: &'a EnumDef,
 340     _: &'a Generics,
 341     _: NodeId,
 342 ) {
 343     walk_list!(visitor, visit_variant, &enum_definition.variants);
 344 }
 345
 346 pub fn walk_variant<'a, V: Visitor<'a>>(visitor: &mut V, variant: &'a Variant)
 347 where
 348     V: Visitor<'a>,
 349 {
 350     visitor.visit_ident(variant.ident);
 351     visitor.visit_vis(&variant.vis);
 352     visitor.visit_variant_data(&variant.data);
 353     walk_list!(visitor, visit_anon_const, &variant.disr_expr);
 354     walk_list!(visitor, visit_attribute, &variant.attrs);
 355 }
 356
 357 pub fn walk_field<'a, V: Visitor<'a>>(visitor: &mut V, f: &'a Field) {
 358     visitor.visit_expr(&f.expr);
 359     visitor.visit_ident(f.ident);
 360     walk_list!(visitor, visit_attribute, f.attrs.iter());
 361 }
 362
 363 pub fn walk_field_pattern<'a, V: Visitor<'a>>(visitor: &mut V, fp: &'a FieldPat) {
 364     visitor.visit_ident(fp.ident);
 365     visitor.visit_pat(&fp.pat);
 366     walk_list!(visitor, visit_attribute, fp.attrs.iter());
 367 }
 368
 369 pub fn walk_ty<'a, V: Visitor<'a>>(visitor: &mut V, typ: &'a Ty) {
 370     match typ.kind {
 371         TyKind::Slice(ref ty) | TyKind::Paren(ref ty) => visitor.visit_ty(ty),
 372         TyKind::Ptr(ref mutable_type) => visitor.visit_ty(&mutable_type.ty),
 373         TyKind::Rptr(ref opt_lifetime, ref mutable_type) => {
 374             walk_list!(visitor, visit_lifetime, opt_lifetime);
 375             visitor.visit_ty(&mutable_type.ty)
 376         }
 377         TyKind::Tup(ref tuple_element_types) => {
 378             walk_list!(visitor, visit_ty, tuple_element_types);
 379         }
 380         TyKind::BareFn(ref function_declaration) => {
 381             walk_list!(visitor, visit_generic_param, &function_declaration.generic_params);
 382             walk_fn_decl(visitor, &function_declaration.decl);
 383         }
 384         TyKind::Path(ref maybe_qself, ref path) => {
 385             if let Some(ref qself) = *maybe_qself {
 386                 visitor.visit_ty(&qself.ty);
 387             }
 388             visitor.visit_path(path, typ.id);
 389         }
 390         TyKind::Array(ref ty, ref length) => {
 391             visitor.visit_ty(ty);
 392             visitor.visit_anon_const(length)
 393         }
 394         TyKind::TraitObject(ref bounds, ..) | TyKind::ImplTrait(_, ref bounds) => {
 395             walk_list!(visitor, visit_param_bound, bounds);
 396         }
 397         TyKind::Typeof(ref expression) => visitor.visit_anon_const(expression),
 398         TyKind::Infer | TyKind::ImplicitSelf | TyKind::Err => {}
 399         TyKind::Mac(ref mac) => visitor.visit_mac(mac),
 400         TyKind::Never | TyKind::CVarArgs => {}
 401     }
 402 }
 403
 404 pub fn walk_path<'a, V: Visitor<'a>>(visitor: &mut V, path: &'a Path) {
 405     for segment in &path.segments {
 406         visitor.visit_path_segment(path.span, segment);
 407     }
 408 }
 409
 410 pub fn walk_use_tree<'a, V: Visitor<'a>>(visitor: &mut V, use_tree: &'a UseTree, id: NodeId) {
 411     visitor.visit_path(&use_tree.prefix, id);
 412     match use_tree.kind {
 413         UseTreeKind::Simple(rename, ..) => {
 414             // The extra IDs are handled during HIR lowering.
 415             if let Some(rename) = rename {
 416                 visitor.visit_ident(rename);
 417             }
 418         }
 419         UseTreeKind::Glob => {}
 420         UseTreeKind::Nested(ref use_trees) => {
 421             for &(ref nested_tree, nested_id) in use_trees {
 422                 visitor.visit_use_tree(nested_tree, nested_id, true);
 423             }
 424         }
 425     }
 426 }
 427
 428 pub fn walk_path_segment<'a, V: Visitor<'a>>(
 429     visitor: &mut V,
 430     path_span: Span,
 431     segment: &'a PathSegment,
 432 ) {
 433     visitor.visit_ident(segment.ident);
 434     if let Some(ref args) = segment.args {
 435         visitor.visit_generic_args(path_span, args);
 436     }
 437 }
 438
 439 pub fn walk_generic_args<'a, V>(visitor: &mut V, _path_span: Span, generic_args: &'a GenericArgs)
 440 where
 441     V: Visitor<'a>,
 442 {
 443     match *generic_args {
 444         GenericArgs::AngleBracketed(ref data) => {
 445             walk_list!(visitor, visit_generic_arg, &data.args);
 446             walk_list!(visitor, visit_assoc_ty_constraint, &data.constraints);
 447         }
 448         GenericArgs::Parenthesized(ref data) => {
 449             walk_list!(visitor, visit_ty, &data.inputs);
 450             walk_fn_ret_ty(visitor, &data.output);
 451         }
 452     }
 453 }
 454
 455 pub fn walk_assoc_ty_constraint<'a, V: Visitor<'a>>(
 456     visitor: &mut V,
 457     constraint: &'a AssocTyConstraint,
 458 ) {
 459     visitor.visit_ident(constraint.ident);
 460     match constraint.kind {
 461         AssocTyConstraintKind::Equality { ref ty } => {
 462             visitor.visit_ty(ty);
 463         }
 464         AssocTyConstraintKind::Bound { ref bounds } => {
 465             walk_list!(visitor, visit_param_bound, bounds);
 466         }
 467     }
 468 }
 469
 470 pub fn walk_pat<'a, V: Visitor<'a>>(visitor: &mut V, pattern: &'a Pat) {
 471     match pattern.kind {
 472         PatKind::TupleStruct(ref path, ref elems) => {
 473             visitor.visit_path(path, pattern.id);
 474             walk_list!(visitor, visit_pat, elems);
 475         }
 476         PatKind::Path(ref opt_qself, ref path) => {
 477             if let Some(ref qself) = *opt_qself {
 478                 visitor.visit_ty(&qself.ty);
 479             }
 480             visitor.visit_path(path, pattern.id)
 481         }
 482         PatKind::Struct(ref path, ref fields, _) => {
 483             visitor.visit_path(path, pattern.id);
 484             walk_list!(visitor, visit_field_pattern, fields);
 485         }
 486         PatKind::Box(ref subpattern)
 487         | PatKind::Ref(ref subpattern, _)
 488         | PatKind::Paren(ref subpattern) => visitor.visit_pat(subpattern),
 489         PatKind::Ident(_, ident, ref optional_subpattern) => {
 490             visitor.visit_ident(ident);
 491             walk_list!(visitor, visit_pat, optional_subpattern);
 492         }
 493         PatKind::Lit(ref expression) => visitor.visit_expr(expression),
 494         PatKind::Range(ref lower_bound, ref upper_bound, _) => {
 495             walk_list!(visitor, visit_expr, lower_bound);
 496             walk_list!(visitor, visit_expr, upper_bound);
 497         }
 498         PatKind::Wild | PatKind::Rest => {}
 499         PatKind::Tuple(ref elems) | PatKind::Slice(ref elems) | PatKind::Or(ref elems) => {
 500             walk_list!(visitor, visit_pat, elems);
 501         }
 502         PatKind::Mac(ref mac) => visitor.visit_mac(mac),
 503     }
 504 }
 505
 506 pub fn walk_foreign_item<'a, V: Visitor<'a>>(visitor: &mut V, foreign_item: &'a ForeignItem) {
 507     visitor.visit_vis(&foreign_item.vis);
 508     visitor.visit_ident(foreign_item.ident);
 509
 510     match foreign_item.kind {
 511         ForeignItemKind::Fn(ref function_declaration, ref generics) => {
 512             walk_fn_decl(visitor, function_declaration);
 513             visitor.visit_generics(generics)
 514         }
 515         ForeignItemKind::Static(ref typ, _) => visitor.visit_ty(typ),
 516         ForeignItemKind::Ty => (),
 517         ForeignItemKind::Macro(ref mac) => visitor.visit_mac(mac),
 518     }
 519
 520     walk_list!(visitor, visit_attribute, &foreign_item.attrs);
 521 }
 522
 523 pub fn walk_global_asm<'a, V: Visitor<'a>>(_: &mut V, _: &'a GlobalAsm) {
 524     // Empty!
 525 }
 526
 527 pub fn walk_param_bound<'a, V: Visitor<'a>>(visitor: &mut V, bound: &'a GenericBound) {
 528     match *bound {
 529         GenericBound::Trait(ref typ, ref modifier) => visitor.visit_poly_trait_ref(typ, modifier),
 530         GenericBound::Outlives(ref lifetime) => visitor.visit_lifetime(lifetime),
 531     }
 532 }
 533
 534 pub fn walk_generic_param<'a, V: Visitor<'a>>(visitor: &mut V, param: &'a GenericParam) {
 535     visitor.visit_ident(param.ident);
 536     walk_list!(visitor, visit_attribute, param.attrs.iter());
 537     walk_list!(visitor, visit_param_bound, &param.bounds);
 538     match param.kind {
 539         GenericParamKind::Lifetime => (),
 540         GenericParamKind::Type { ref default } => walk_list!(visitor, visit_ty, default),
 541         GenericParamKind::Const { ref ty, .. } => visitor.visit_ty(ty),
 542     }
 543 }
 544
 545 pub fn walk_generics<'a, V: Visitor<'a>>(visitor: &mut V, generics: &'a Generics) {
 546     walk_list!(visitor, visit_generic_param, &generics.params);
 547     walk_list!(visitor, visit_where_predicate, &generics.where_clause.predicates);
 548 }
 549
 550 pub fn walk_where_predicate<'a, V: Visitor<'a>>(visitor: &mut V, predicate: &'a WherePredicate) {
 551     match *predicate {
 552         WherePredicate::BoundPredicate(WhereBoundPredicate {
 553             ref bounded_ty,
 554             ref bounds,
 555             ref bound_generic_params,
 556             ..
 557         }) => {
 558             visitor.visit_ty(bounded_ty);
 559             walk_list!(visitor, visit_param_bound, bounds);
 560             walk_list!(visitor, visit_generic_param, bound_generic_params);
 561         }
 562         WherePredicate::RegionPredicate(WhereRegionPredicate {
 563             ref lifetime, ref bounds, ..
 564         }) => {
 565             visitor.visit_lifetime(lifetime);
 566             walk_list!(visitor, visit_param_bound, bounds);
 567         }
 568         WherePredicate::EqPredicate(WhereEqPredicate { ref lhs_ty, ref rhs_ty, .. }) => {
 569             visitor.visit_ty(lhs_ty);
 570             visitor.visit_ty(rhs_ty);
 571         }
 572     }
 573 }
 574
 575 pub fn walk_fn_ret_ty<'a, V: Visitor<'a>>(visitor: &mut V, ret_ty: &'a FunctionRetTy) {
 576     if let FunctionRetTy::Ty(ref output_ty) = *ret_ty {
 577         visitor.visit_ty(output_ty)
 578     }
 579 }
 580
 581 pub fn walk_fn_decl<'a, V: Visitor<'a>>(visitor: &mut V, function_declaration: &'a FnDecl) {
 582     for param in &function_declaration.inputs {
 583         visitor.visit_param(param);
 584     }
 585     visitor.visit_fn_ret_ty(&function_declaration.output);
 586 }
 587
 588 pub fn walk_fn<'a, V>(visitor: &mut V, kind: FnKind<'a>, declaration: &'a FnDecl, _span: Span)
 589 where
 590     V: Visitor<'a>,
 591 {
 592     match kind {
 593         FnKind::ItemFn(_, header, _, body) => {
 594             visitor.visit_fn_header(header);
 595             walk_fn_decl(visitor, declaration);
 596             visitor.visit_block(body);
 597         }
 598         FnKind::Method(_, sig, _, body) => {
 599             visitor.visit_fn_header(&sig.header);
 600             walk_fn_decl(visitor, declaration);
 601             visitor.visit_block(body);
 602         }
 603         FnKind::Closure(body) => {
 604             walk_fn_decl(visitor, declaration);
 605             visitor.visit_expr(body);
 606         }
 607     }
 608 }
 609
 610 pub fn walk_impl_item<'a, V: Visitor<'a>>(visitor: &mut V, item: &'a AssocItem) {
 611     visitor.visit_assoc_item(item);
 612 }
 613
 614 pub fn walk_trait_item<'a, V: Visitor<'a>>(visitor: &mut V, item: &'a AssocItem) {
 615     visitor.visit_assoc_item(item);
 616 }
 617
 618 pub fn walk_assoc_item<'a, V: Visitor<'a>>(visitor: &mut V, item: &'a AssocItem) {
 619     visitor.visit_vis(&item.vis);
 620     visitor.visit_ident(item.ident);
 621     walk_list!(visitor, visit_attribute, &item.attrs);
 622     visitor.visit_generics(&item.generics);
 623     match item.kind {
 624         AssocItemKind::Const(ref ty, ref expr) => {
 625             visitor.visit_ty(ty);
 626             walk_list!(visitor, visit_expr, expr);
 627         }
 628         AssocItemKind::Fn(ref sig, None) => {
 629             visitor.visit_fn_header(&sig.header);
 630             walk_fn_decl(visitor, &sig.decl);
 631         }
 632         AssocItemKind::Fn(ref sig, Some(ref body)) => {
 633             visitor.visit_fn(
 634                 FnKind::Method(item.ident, sig, &item.vis, body),
 635                 &sig.decl,
 636                 item.span,
 637                 item.id,
 638             );
 639         }
 640         AssocItemKind::TyAlias(ref bounds, ref ty) => {
 641             walk_list!(visitor, visit_param_bound, bounds);
 642             walk_list!(visitor, visit_ty, ty);
 643         }
 644         AssocItemKind::Macro(ref mac) => {
 645             visitor.visit_mac(mac);
 646         }
 647     }
 648 }
 649
 650 pub fn walk_struct_def<'a, V: Visitor<'a>>(visitor: &mut V, struct_definition: &'a VariantData) {
 651     walk_list!(visitor, visit_struct_field, struct_definition.fields());
 652 }
 653
 654 pub fn walk_struct_field<'a, V: Visitor<'a>>(visitor: &mut V, struct_field: &'a StructField) {
 655     visitor.visit_vis(&struct_field.vis);
 656     if let Some(ident) = struct_field.ident {
 657         visitor.visit_ident(ident);
 658     }
 659     visitor.visit_ty(&struct_field.ty);
 660     walk_list!(visitor, visit_attribute, &struct_field.attrs);
 661 }
 662
 663 pub fn walk_block<'a, V: Visitor<'a>>(visitor: &mut V, block: &'a Block) {
 664     walk_list!(visitor, visit_stmt, &block.stmts);
 665 }
 666
 667 pub fn walk_stmt<'a, V: Visitor<'a>>(visitor: &mut V, statement: &'a Stmt) {
 668     match statement.kind {
 669         StmtKind::Local(ref local) => visitor.visit_local(local),
 670         StmtKind::Item(ref item) => visitor.visit_item(item),
 671         StmtKind::Expr(ref expression) | StmtKind::Semi(ref expression) => {
 672             visitor.visit_expr(expression)
 673         }
 674         StmtKind::Mac(ref mac) => {
 675             let (ref mac, _, ref attrs) = **mac;
 676             visitor.visit_mac(mac);
 677             for attr in attrs.iter() {
 678                 visitor.visit_attribute(attr);
 679             }
 680         }
 681     }
 682 }
 683
 684 pub fn walk_mac<'a, V: Visitor<'a>>(visitor: &mut V, mac: &'a Mac) {
 685     visitor.visit_path(&mac.path, DUMMY_NODE_ID);
 686 }
 687
 688 pub fn walk_anon_const<'a, V: Visitor<'a>>(visitor: &mut V, constant: &'a AnonConst) {
 689     visitor.visit_expr(&constant.value);
 690 }
 691
 692 pub fn walk_expr<'a, V: Visitor<'a>>(visitor: &mut V, expression: &'a Expr) {
 693     walk_list!(visitor, visit_attribute, expression.attrs.iter());
 694
 695     match expression.kind {
 696         ExprKind::Box(ref subexpression) => visitor.visit_expr(subexpression),
 697         ExprKind::Array(ref subexpressions) => {
 698             walk_list!(visitor, visit_expr, subexpressions);
 699         }
 700         ExprKind::Repeat(ref element, ref count) => {
 701             visitor.visit_expr(element);
 702             visitor.visit_anon_const(count)
 703         }
 704         ExprKind::Struct(ref path, ref fields, ref optional_base) => {
 705             visitor.visit_path(path, expression.id);
 706             walk_list!(visitor, visit_field, fields);
 707             walk_list!(visitor, visit_expr, optional_base);
 708         }
 709         ExprKind::Tup(ref subexpressions) => {
 710             walk_list!(visitor, visit_expr, subexpressions);
 711         }
 712         ExprKind::Call(ref callee_expression, ref arguments) => {
 713             visitor.visit_expr(callee_expression);
 714             walk_list!(visitor, visit_expr, arguments);
 715         }
 716         ExprKind::MethodCall(ref segment, ref arguments) => {
 717             visitor.visit_path_segment(expression.span, segment);
 718             walk_list!(visitor, visit_expr, arguments);
 719         }
 720         ExprKind::Binary(_, ref left_expression, ref right_expression) => {
 721             visitor.visit_expr(left_expression);
 722             visitor.visit_expr(right_expression)
 723         }
 724         ExprKind::AddrOf(_, _, ref subexpression) | ExprKind::Unary(_, ref subexpression) => {
 725             visitor.visit_expr(subexpression)
 726         }
 727         ExprKind::Cast(ref subexpression, ref typ) | ExprKind::Type(ref subexpression, ref typ) => {
 728             visitor.visit_expr(subexpression);
 729             visitor.visit_ty(typ)
 730         }
 731         ExprKind::Let(ref pat, ref scrutinee) => {
 732             visitor.visit_pat(pat);
 733             visitor.visit_expr(scrutinee);
 734         }
 735         ExprKind::If(ref head_expression, ref if_block, ref optional_else) => {
 736             visitor.visit_expr(head_expression);
 737             visitor.visit_block(if_block);
 738             walk_list!(visitor, visit_expr, optional_else);
 739         }
 740         ExprKind::While(ref subexpression, ref block, ref opt_label) => {
 741             walk_list!(visitor, visit_label, opt_label);
 742             visitor.visit_expr(subexpression);
 743             visitor.visit_block(block);
 744         }
 745         ExprKind::ForLoop(ref pattern, ref subexpression, ref block, ref opt_label) => {
 746             walk_list!(visitor, visit_label, opt_label);
 747             visitor.visit_pat(pattern);
 748             visitor.visit_expr(subexpression);
 749             visitor.visit_block(block);
 750         }
 751         ExprKind::Loop(ref block, ref opt_label) => {
 752             walk_list!(visitor, visit_label, opt_label);
 753             visitor.visit_block(block);
 754         }
 755         ExprKind::Match(ref subexpression, ref arms) => {
 756             visitor.visit_expr(subexpression);
 757             walk_list!(visitor, visit_arm, arms);
 758         }
 759         ExprKind::Closure(_, _, _, ref function_declaration, ref body, _decl_span) => visitor
 760             .visit_fn(FnKind::Closure(body), function_declaration, expression.span, expression.id),
 761         ExprKind::Block(ref block, ref opt_label) => {
 762             walk_list!(visitor, visit_label, opt_label);
 763             visitor.visit_block(block);
 764         }
 765         ExprKind::Async(_, _, ref body) => {
 766             visitor.visit_block(body);
 767         }
 768         ExprKind::Await(ref expr) => visitor.visit_expr(expr),
 769         ExprKind::Assign(ref lhs, ref rhs, _) => {
 770             visitor.visit_expr(lhs);
 771             visitor.visit_expr(rhs);
 772         }
 773         ExprKind::AssignOp(_, ref left_expression, ref right_expression) => {
 774             visitor.visit_expr(left_expression);
 775             visitor.visit_expr(right_expression);
 776         }
 777         ExprKind::Field(ref subexpression, ident) => {
 778             visitor.visit_expr(subexpression);
 779             visitor.visit_ident(ident);
 780         }
 781         ExprKind::Index(ref main_expression, ref index_expression) => {
 782             visitor.visit_expr(main_expression);
 783             visitor.visit_expr(index_expression)
 784         }
 785         ExprKind::Range(ref start, ref end, _) => {
 786             walk_list!(visitor, visit_expr, start);
 787             walk_list!(visitor, visit_expr, end);
 788         }
 789         ExprKind::Path(ref maybe_qself, ref path) => {
 790             if let Some(ref qself) = *maybe_qself {
 791                 visitor.visit_ty(&qself.ty);
 792             }
 793             visitor.visit_path(path, expression.id)
 794         }
 795         ExprKind::Break(ref opt_label, ref opt_expr) => {
 796             walk_list!(visitor, visit_label, opt_label);
 797             walk_list!(visitor, visit_expr, opt_expr);
 798         }
 799         ExprKind::Continue(ref opt_label) => {
 800             walk_list!(visitor, visit_label, opt_label);
 801         }
 802         ExprKind::Ret(ref optional_expression) => {
 803             walk_list!(visitor, visit_expr, optional_expression);
 804         }
 805         ExprKind::Mac(ref mac) => visitor.visit_mac(mac),
 806         ExprKind::Paren(ref subexpression) => visitor.visit_expr(subexpression),
 807         ExprKind::InlineAsm(ref ia) => {
 808             for &(_, ref input) in &ia.inputs {
 809                 visitor.visit_expr(input)
 810             }
 811             for output in &ia.outputs {
 812                 visitor.visit_expr(&output.expr)
 813             }
 814         }
 815         ExprKind::Yield(ref optional_expression) => {
 816             walk_list!(visitor, visit_expr, optional_expression);
 817         }
 818         ExprKind::Try(ref subexpression) => visitor.visit_expr(subexpression),
 819         ExprKind::TryBlock(ref body) => visitor.visit_block(body),
 820         ExprKind::Lit(_) | ExprKind::Err => {}
 821     }
 822
 823     visitor.visit_expr_post(expression)
 824 }
 825
 826 pub fn walk_param<'a, V: Visitor<'a>>(visitor: &mut V, param: &'a Param) {
 827     walk_list!(visitor, visit_attribute, param.attrs.iter());
 828     visitor.visit_pat(&param.pat);
 829     visitor.visit_ty(&param.ty);
 830 }
 831
 832 pub fn walk_arm<'a, V: Visitor<'a>>(visitor: &mut V, arm: &'a Arm) {
 833     visitor.visit_pat(&arm.pat);
 834     walk_list!(visitor, visit_expr, &arm.guard);
 835     visitor.visit_expr(&arm.body);
 836     walk_list!(visitor, visit_attribute, &arm.attrs);
 837 }
 838
 839 pub fn walk_vis<'a, V: Visitor<'a>>(visitor: &mut V, vis: &'a Visibility) {
 840     if let VisibilityKind::Restricted { ref path, id } = vis.node {
 841         visitor.visit_path(path, id);
 842     }
 843 }
 844
 845 pub fn walk_attribute<'a, V: Visitor<'a>>(visitor: &mut V, attr: &'a Attribute) {
 846     match attr.kind {
 847         AttrKind::Normal(ref item) => walk_mac_args(visitor, &item.args),
 848         AttrKind::DocComment(_) => {}
 849     }
 850 }
 851
 852 pub fn walk_mac_args<'a, V: Visitor<'a>>(visitor: &mut V, args: &'a MacArgs) {
 853     match args {
 854         MacArgs::Empty => {}
 855         MacArgs::Delimited(_dspan, _delim, tokens) => visitor.visit_tts(tokens.clone()),
 856         MacArgs::Eq(_eq_span, tokens) => visitor.visit_tts(tokens.clone()),
 857     }
 858 }
 859
 860 pub fn walk_tt<'a, V: Visitor<'a>>(visitor: &mut V, tt: TokenTree) {
 861     match tt {
 862         TokenTree::Token(token) => visitor.visit_token(token),
 863         TokenTree::Delimited(_, _, tts) => visitor.visit_tts(tts),
 864     }
 865 }
 866
 867 pub fn walk_tts<'a, V: Visitor<'a>>(visitor: &mut V, tts: TokenStream) {
 868     for tt in tts.trees() {
 869         visitor.visit_tt(tt);
 870     }
 871 }