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