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