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::Enum(ref enum_definition, ref generics) => {
 267             visitor.visit_generics(generics);
 268             visitor.visit_enum_def(enum_definition, generics, item.id, item.span)
 269         }
 270         ItemKind::Impl(_, _, _,
 271                  ref generics,
 272                  ref opt_trait_reference,
 273                  ref typ,
 274                  ref impl_items) => {
 275             visitor.visit_generics(generics);
 276             walk_list!(visitor, visit_trait_ref, opt_trait_reference);
 277             visitor.visit_ty(typ);
 278             walk_list!(visitor, visit_impl_item, impl_items);
 279         }
 280         ItemKind::Struct(ref struct_definition, ref generics) |
 281         ItemKind::Union(ref struct_definition, ref generics) => {
 282             visitor.visit_generics(generics);
 283             visitor.visit_variant_data(struct_definition);
 284         }
 285         ItemKind::Trait(.., ref generics, ref bounds, ref methods) => {
 286             visitor.visit_generics(generics);
 287             walk_list!(visitor, visit_param_bound, bounds);
 288             walk_list!(visitor, visit_trait_item, methods);
 289         }
 290         ItemKind::TraitAlias(ref generics, ref bounds) => {
 291             visitor.visit_generics(generics);
 292             walk_list!(visitor, visit_param_bound, bounds);
 293         }
 294         ItemKind::Mac(ref mac) => visitor.visit_mac(mac),
 295         ItemKind::MacroDef(ref ts) => visitor.visit_mac_def(ts, item.id),
 296     }
 297     walk_list!(visitor, visit_attribute, &item.attrs);
 298 }
 299
 300 pub fn walk_enum_def<'a, V: Visitor<'a>>(
 301     visitor: &mut V,
 302     enum_definition: &'a EnumDef,
 303     _: &'a Generics,
 304     _: NodeId,
 305 ) {
 306     walk_list!(visitor, visit_variant, &enum_definition.variants);
 307 }
 308
 309 pub fn walk_variant<'a, V: Visitor<'a>>(visitor: &mut V, variant: &'a Variant)
 310     where V: Visitor<'a>,
 311 {
 312     visitor.visit_ident(variant.ident);
 313     visitor.visit_variant_data(&variant.data);
 314     walk_list!(visitor, visit_anon_const, &variant.disr_expr);
 315     walk_list!(visitor, visit_attribute, &variant.attrs);
 316 }
 317
 318 pub fn walk_field<'a, V: Visitor<'a>>(visitor: &mut V, f: &'a Field) {
 319     visitor.visit_expr(&f.expr);
 320     visitor.visit_ident(f.ident);
 321     walk_list!(visitor, visit_attribute, f.attrs.iter());
 322 }
 323
 324 pub fn walk_field_pattern<'a, V: Visitor<'a>>(visitor: &mut V, fp: &'a FieldPat) {
 325     visitor.visit_ident(fp.ident);
 326     visitor.visit_pat(&fp.pat);
 327     walk_list!(visitor, visit_attribute, fp.attrs.iter());
 328 }
 329
 330 pub fn walk_ty<'a, V: Visitor<'a>>(visitor: &mut V, typ: &'a Ty) {
 331     match typ.kind {
 332         TyKind::Slice(ref ty) | TyKind::Paren(ref ty) => {
 333             visitor.visit_ty(ty)
 334         }
 335         TyKind::Ptr(ref mutable_type) => {
 336             visitor.visit_ty(&mutable_type.ty)
 337         }
 338         TyKind::Rptr(ref opt_lifetime, ref mutable_type) => {
 339             walk_list!(visitor, visit_lifetime, opt_lifetime);
 340             visitor.visit_ty(&mutable_type.ty)
 341         }
 342         TyKind::Tup(ref tuple_element_types) => {
 343             walk_list!(visitor, visit_ty, tuple_element_types);
 344         }
 345         TyKind::BareFn(ref function_declaration) => {
 346             walk_list!(visitor, visit_generic_param, &function_declaration.generic_params);
 347             walk_fn_decl(visitor, &function_declaration.decl);
 348         }
 349         TyKind::Path(ref maybe_qself, ref path) => {
 350             if let Some(ref qself) = *maybe_qself {
 351                 visitor.visit_ty(&qself.ty);
 352             }
 353             visitor.visit_path(path, typ.id);
 354         }
 355         TyKind::Array(ref ty, ref length) => {
 356             visitor.visit_ty(ty);
 357             visitor.visit_anon_const(length)
 358         }
 359         TyKind::TraitObject(ref bounds, ..) |
 360         TyKind::ImplTrait(_, ref bounds) => {
 361             walk_list!(visitor, visit_param_bound, bounds);
 362         }
 363         TyKind::Typeof(ref expression) => {
 364             visitor.visit_anon_const(expression)
 365         }
 366         TyKind::Infer | TyKind::ImplicitSelf | TyKind::Err => {}
 367         TyKind::Mac(ref mac) => {
 368             visitor.visit_mac(mac)
 369         }
 370         TyKind::Never |
 371         TyKind::CVarArgs => {}
 372     }
 373 }
 374
 375 pub fn walk_path<'a, V: Visitor<'a>>(visitor: &mut V, path: &'a Path) {
 376     for segment in &path.segments {
 377         visitor.visit_path_segment(path.span, segment);
 378     }
 379 }
 380
 381 pub fn walk_use_tree<'a, V: Visitor<'a>>(
 382     visitor: &mut V, use_tree: &'a UseTree, id: NodeId,
 383 ) {
 384     visitor.visit_path(&use_tree.prefix, id);
 385     match use_tree.kind {
 386         UseTreeKind::Simple(rename, ..) => {
 387             // The extra IDs are handled during HIR lowering.
 388             if let Some(rename) = rename {
 389                 visitor.visit_ident(rename);
 390             }
 391         }
 392         UseTreeKind::Glob => {},
 393         UseTreeKind::Nested(ref use_trees) => {
 394             for &(ref nested_tree, nested_id) in use_trees {
 395                 visitor.visit_use_tree(nested_tree, nested_id, true);
 396             }
 397         }
 398     }
 399 }
 400
 401 pub fn walk_path_segment<'a, V: Visitor<'a>>(visitor: &mut V,
 402                                              path_span: Span,
 403                                              segment: &'a PathSegment) {
 404     visitor.visit_ident(segment.ident);
 405     if let Some(ref args) = segment.args {
 406         visitor.visit_generic_args(path_span, args);
 407     }
 408 }
 409
 410 pub fn walk_generic_args<'a, V>(visitor: &mut V,
 411                                 _path_span: Span,
 412                                 generic_args: &'a GenericArgs)
 413     where V: Visitor<'a>,
 414 {
 415     match *generic_args {
 416         GenericArgs::AngleBracketed(ref data) => {
 417             walk_list!(visitor, visit_generic_arg, &data.args);
 418             walk_list!(visitor, visit_assoc_ty_constraint, &data.constraints);
 419         }
 420         GenericArgs::Parenthesized(ref data) => {
 421             walk_list!(visitor, visit_ty, &data.inputs);
 422             walk_list!(visitor, visit_ty, &data.output);
 423         }
 424     }
 425 }
 426
 427 pub fn walk_assoc_ty_constraint<'a, V: Visitor<'a>>(visitor: &mut V,
 428                                                     constraint: &'a AssocTyConstraint) {
 429     visitor.visit_ident(constraint.ident);
 430     match constraint.kind {
 431         AssocTyConstraintKind::Equality { ref ty } => {
 432             visitor.visit_ty(ty);
 433         }
 434         AssocTyConstraintKind::Bound { ref bounds } => {
 435             walk_list!(visitor, visit_param_bound, bounds);
 436         }
 437     }
 438 }
 439
 440 pub fn walk_pat<'a, V: Visitor<'a>>(visitor: &mut V, pattern: &'a Pat) {
 441     match pattern.kind {
 442         PatKind::TupleStruct(ref path, ref elems) => {
 443             visitor.visit_path(path, pattern.id);
 444             walk_list!(visitor, visit_pat, elems);
 445         }
 446         PatKind::Path(ref opt_qself, ref path) => {
 447             if let Some(ref qself) = *opt_qself {
 448                 visitor.visit_ty(&qself.ty);
 449             }
 450             visitor.visit_path(path, pattern.id)
 451         }
 452         PatKind::Struct(ref path, ref fields, _) => {
 453             visitor.visit_path(path, pattern.id);
 454             walk_list!(visitor, visit_field_pattern, fields);
 455         }
 456         PatKind::Box(ref subpattern) |
 457         PatKind::Ref(ref subpattern, _) |
 458         PatKind::Paren(ref subpattern) => {
 459             visitor.visit_pat(subpattern)
 460         }
 461         PatKind::Ident(_, ident, ref optional_subpattern) => {
 462             visitor.visit_ident(ident);
 463             walk_list!(visitor, visit_pat, optional_subpattern);
 464         }
 465         PatKind::Lit(ref expression) => visitor.visit_expr(expression),
 466         PatKind::Range(ref lower_bound, ref upper_bound, _) => {
 467             visitor.visit_expr(lower_bound);
 468             visitor.visit_expr(upper_bound);
 469         }
 470         PatKind::Wild | PatKind::Rest => {},
 471         PatKind::Tuple(ref elems)
 472         | PatKind::Slice(ref elems)
 473         | PatKind::Or(ref elems) => {
 474             walk_list!(visitor, visit_pat, elems);
 475         }
 476         PatKind::Mac(ref mac) => visitor.visit_mac(mac),
 477     }
 478 }
 479
 480 pub fn walk_foreign_item<'a, V: Visitor<'a>>(visitor: &mut V, foreign_item: &'a ForeignItem) {
 481     visitor.visit_vis(&foreign_item.vis);
 482     visitor.visit_ident(foreign_item.ident);
 483
 484     match foreign_item.kind {
 485         ForeignItemKind::Fn(ref function_declaration, ref generics) => {
 486             walk_fn_decl(visitor, function_declaration);
 487             visitor.visit_generics(generics)
 488         }
 489         ForeignItemKind::Static(ref typ, _) => visitor.visit_ty(typ),
 490         ForeignItemKind::Ty => (),
 491         ForeignItemKind::Macro(ref mac) => visitor.visit_mac(mac),
 492     }
 493
 494     walk_list!(visitor, visit_attribute, &foreign_item.attrs);
 495 }
 496
 497 pub fn walk_global_asm<'a, V: Visitor<'a>>(_: &mut V, _: &'a GlobalAsm) {
 498     // Empty!
 499 }
 500
 501 pub fn walk_param_bound<'a, V: Visitor<'a>>(visitor: &mut V, bound: &'a GenericBound) {
 502     match *bound {
 503         GenericBound::Trait(ref typ, ref modifier) => visitor.visit_poly_trait_ref(typ, modifier),
 504         GenericBound::Outlives(ref lifetime) => visitor.visit_lifetime(lifetime),
 505     }
 506 }
 507
 508 pub fn walk_generic_param<'a, V: Visitor<'a>>(visitor: &mut V, param: &'a GenericParam) {
 509     visitor.visit_ident(param.ident);
 510     walk_list!(visitor, visit_attribute, param.attrs.iter());
 511     walk_list!(visitor, visit_param_bound, &param.bounds);
 512     match param.kind {
 513         GenericParamKind::Lifetime => (),
 514         GenericParamKind::Type { ref default } => walk_list!(visitor, visit_ty, default),
 515         GenericParamKind::Const { ref ty, .. } => visitor.visit_ty(ty),
 516     }
 517 }
 518
 519 pub fn walk_generics<'a, V: Visitor<'a>>(visitor: &mut V, generics: &'a Generics) {
 520     walk_list!(visitor, visit_generic_param, &generics.params);
 521     walk_list!(visitor, visit_where_predicate, &generics.where_clause.predicates);
 522 }
 523
 524 pub fn walk_where_predicate<'a, V: Visitor<'a>>(visitor: &mut V, predicate: &'a WherePredicate) {
 525     match *predicate {
 526         WherePredicate::BoundPredicate(WhereBoundPredicate{ref bounded_ty,
 527                                                            ref bounds,
 528                                                            ref bound_generic_params,
 529                                                            ..}) => {
 530             visitor.visit_ty(bounded_ty);
 531             walk_list!(visitor, visit_param_bound, bounds);
 532             walk_list!(visitor, visit_generic_param, bound_generic_params);
 533         }
 534         WherePredicate::RegionPredicate(WhereRegionPredicate{ref lifetime,
 535                                                              ref bounds,
 536                                                              ..}) => {
 537             visitor.visit_lifetime(lifetime);
 538             walk_list!(visitor, visit_param_bound, bounds);
 539         }
 540         WherePredicate::EqPredicate(WhereEqPredicate{ref lhs_ty,
 541                                                      ref rhs_ty,
 542                                                      ..}) => {
 543             visitor.visit_ty(lhs_ty);
 544             visitor.visit_ty(rhs_ty);
 545         }
 546     }
 547 }
 548
 549 pub fn walk_fn_ret_ty<'a, V: Visitor<'a>>(visitor: &mut V, ret_ty: &'a FunctionRetTy) {
 550     if let FunctionRetTy::Ty(ref output_ty) = *ret_ty {
 551         visitor.visit_ty(output_ty)
 552     }
 553 }
 554
 555 pub fn walk_fn_decl<'a, V: Visitor<'a>>(visitor: &mut V, function_declaration: &'a FnDecl) {
 556     for param in &function_declaration.inputs {
 557         visitor.visit_param(param);
 558     }
 559     visitor.visit_fn_ret_ty(&function_declaration.output);
 560 }
 561
 562 pub fn walk_fn<'a, V>(visitor: &mut V, kind: FnKind<'a>, declaration: &'a FnDecl, _span: Span)
 563     where V: Visitor<'a>,
 564 {
 565     match kind {
 566         FnKind::ItemFn(_, header, _, body) => {
 567             visitor.visit_fn_header(header);
 568             walk_fn_decl(visitor, declaration);
 569             visitor.visit_block(body);
 570         }
 571         FnKind::Method(_, sig, _, body) => {
 572             visitor.visit_fn_header(&sig.header);
 573             walk_fn_decl(visitor, declaration);
 574             visitor.visit_block(body);
 575         }
 576         FnKind::Closure(body) => {
 577             walk_fn_decl(visitor, declaration);
 578             visitor.visit_expr(body);
 579         }
 580     }
 581 }
 582
 583 pub fn walk_trait_item<'a, V: Visitor<'a>>(visitor: &mut V, trait_item: &'a TraitItem) {
 584     visitor.visit_ident(trait_item.ident);
 585     walk_list!(visitor, visit_attribute, &trait_item.attrs);
 586     visitor.visit_generics(&trait_item.generics);
 587     match trait_item.kind {
 588         TraitItemKind::Const(ref ty, ref default) => {
 589             visitor.visit_ty(ty);
 590             walk_list!(visitor, visit_expr, default);
 591         }
 592         TraitItemKind::Method(ref sig, None) => {
 593             visitor.visit_fn_header(&sig.header);
 594             walk_fn_decl(visitor, &sig.decl);
 595         }
 596         TraitItemKind::Method(ref sig, Some(ref body)) => {
 597             visitor.visit_fn(FnKind::Method(trait_item.ident, sig, None, body),
 598                              &sig.decl, trait_item.span, trait_item.id);
 599         }
 600         TraitItemKind::Type(ref bounds, ref default) => {
 601             walk_list!(visitor, visit_param_bound, bounds);
 602             walk_list!(visitor, visit_ty, default);
 603         }
 604         TraitItemKind::Macro(ref mac) => {
 605             visitor.visit_mac(mac);
 606         }
 607     }
 608 }
 609
 610 pub fn walk_impl_item<'a, V: Visitor<'a>>(visitor: &mut V, impl_item: &'a ImplItem) {
 611     visitor.visit_vis(&impl_item.vis);
 612     visitor.visit_ident(impl_item.ident);
 613     walk_list!(visitor, visit_attribute, &impl_item.attrs);
 614     visitor.visit_generics(&impl_item.generics);
 615     match impl_item.kind {
 616         ImplItemKind::Const(ref ty, ref expr) => {
 617             visitor.visit_ty(ty);
 618             visitor.visit_expr(expr);
 619         }
 620         ImplItemKind::Method(ref sig, ref body) => {
 621             visitor.visit_fn(FnKind::Method(impl_item.ident, sig, Some(&impl_item.vis), body),
 622                              &sig.decl, impl_item.span, impl_item.id);
 623         }
 624         ImplItemKind::TyAlias(ref ty) => {
 625             visitor.visit_ty(ty);
 626         }
 627         ImplItemKind::Macro(ref mac) => {
 628             visitor.visit_mac(mac);
 629         }
 630     }
 631 }
 632
 633 pub fn walk_struct_def<'a, V: Visitor<'a>>(visitor: &mut V, struct_definition: &'a VariantData) {
 634     walk_list!(visitor, visit_struct_field, struct_definition.fields());
 635 }
 636
 637 pub fn walk_struct_field<'a, V: Visitor<'a>>(visitor: &mut V, struct_field: &'a StructField) {
 638     visitor.visit_vis(&struct_field.vis);
 639     if let Some(ident) = struct_field.ident {
 640         visitor.visit_ident(ident);
 641     }
 642     visitor.visit_ty(&struct_field.ty);
 643     walk_list!(visitor, visit_attribute, &struct_field.attrs);
 644 }
 645
 646 pub fn walk_block<'a, V: Visitor<'a>>(visitor: &mut V, block: &'a Block) {
 647     walk_list!(visitor, visit_stmt, &block.stmts);
 648 }
 649
 650 pub fn walk_stmt<'a, V: Visitor<'a>>(visitor: &mut V, statement: &'a Stmt) {
 651     match statement.kind {
 652         StmtKind::Local(ref local) => visitor.visit_local(local),
 653         StmtKind::Item(ref item) => visitor.visit_item(item),
 654         StmtKind::Expr(ref expression) | StmtKind::Semi(ref expression) => {
 655             visitor.visit_expr(expression)
 656         }
 657         StmtKind::Mac(ref mac) => {
 658             let (ref mac, _, ref attrs) = **mac;
 659             visitor.visit_mac(mac);
 660             for attr in attrs.iter() {
 661                 visitor.visit_attribute(attr);
 662             }
 663         }
 664     }
 665 }
 666
 667 pub fn walk_mac<'a, V: Visitor<'a>>(visitor: &mut V, mac: &'a Mac) {
 668     visitor.visit_path(&mac.path, DUMMY_NODE_ID);
 669 }
 670
 671 pub fn walk_anon_const<'a, V: Visitor<'a>>(visitor: &mut V, constant: &'a AnonConst) {
 672     visitor.visit_expr(&constant.value);
 673 }
 674
 675 pub fn walk_expr<'a, V: Visitor<'a>>(visitor: &mut V, expression: &'a Expr) {
 676     walk_list!(visitor, visit_attribute, expression.attrs.iter());
 677
 678     match expression.kind {
 679         ExprKind::Box(ref subexpression) => {
 680             visitor.visit_expr(subexpression)
 681         }
 682         ExprKind::Array(ref subexpressions) => {
 683             walk_list!(visitor, visit_expr, subexpressions);
 684         }
 685         ExprKind::Repeat(ref element, ref count) => {
 686             visitor.visit_expr(element);
 687             visitor.visit_anon_const(count)
 688         }
 689         ExprKind::Struct(ref path, ref fields, ref optional_base) => {
 690             visitor.visit_path(path, expression.id);
 691             walk_list!(visitor, visit_field, fields);
 692             walk_list!(visitor, visit_expr, optional_base);
 693         }
 694         ExprKind::Tup(ref subexpressions) => {
 695             walk_list!(visitor, visit_expr, subexpressions);
 696         }
 697         ExprKind::Call(ref callee_expression, ref arguments) => {
 698             visitor.visit_expr(callee_expression);
 699             walk_list!(visitor, visit_expr, arguments);
 700         }
 701         ExprKind::MethodCall(ref segment, ref arguments) => {
 702             visitor.visit_path_segment(expression.span, segment);
 703             walk_list!(visitor, visit_expr, arguments);
 704         }
 705         ExprKind::Binary(_, ref left_expression, ref right_expression) => {
 706             visitor.visit_expr(left_expression);
 707             visitor.visit_expr(right_expression)
 708         }
 709         ExprKind::AddrOf(_, ref subexpression) | ExprKind::Unary(_, ref subexpression) => {
 710             visitor.visit_expr(subexpression)
 711         }
 712         ExprKind::Cast(ref subexpression, ref typ) | ExprKind::Type(ref subexpression, ref typ) => {
 713             visitor.visit_expr(subexpression);
 714             visitor.visit_ty(typ)
 715         }
 716         ExprKind::Let(ref pat, ref scrutinee) => {
 717             visitor.visit_pat(pat);
 718             visitor.visit_expr(scrutinee);
 719         }
 720         ExprKind::If(ref head_expression, ref if_block, ref optional_else) => {
 721             visitor.visit_expr(head_expression);
 722             visitor.visit_block(if_block);
 723             walk_list!(visitor, visit_expr, optional_else);
 724         }
 725         ExprKind::While(ref subexpression, ref block, ref opt_label) => {
 726             walk_list!(visitor, visit_label, opt_label);
 727             visitor.visit_expr(subexpression);
 728             visitor.visit_block(block);
 729         }
 730         ExprKind::ForLoop(ref pattern, ref subexpression, ref block, ref opt_label) => {
 731             walk_list!(visitor, visit_label, opt_label);
 732             visitor.visit_pat(pattern);
 733             visitor.visit_expr(subexpression);
 734             visitor.visit_block(block);
 735         }
 736         ExprKind::Loop(ref block, ref opt_label) => {
 737             walk_list!(visitor, visit_label, opt_label);
 738             visitor.visit_block(block);
 739         }
 740         ExprKind::Match(ref subexpression, ref arms) => {
 741             visitor.visit_expr(subexpression);
 742             walk_list!(visitor, visit_arm, arms);
 743         }
 744         ExprKind::Closure(_, _, _, ref function_declaration, ref body, _decl_span) => {
 745             visitor.visit_fn(FnKind::Closure(body),
 746                              function_declaration,
 747                              expression.span,
 748                              expression.id)
 749         }
 750         ExprKind::Block(ref block, ref opt_label) => {
 751             walk_list!(visitor, visit_label, opt_label);
 752             visitor.visit_block(block);
 753         }
 754         ExprKind::Async(_, _, ref body) => {
 755             visitor.visit_block(body);
 756         }
 757         ExprKind::Await(ref expr) => visitor.visit_expr(expr),
 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::Lit(_) | ExprKind::Err => {}
 816     }
 817
 818     visitor.visit_expr_post(expression)
 819 }
 820
 821 pub fn walk_param<'a, V: Visitor<'a>>(visitor: &mut V, param: &'a Param) {
 822     walk_list!(visitor, visit_attribute, param.attrs.iter());
 823     visitor.visit_pat(&param.pat);
 824     visitor.visit_ty(&param.ty);
 825 }
 826
 827 pub fn walk_arm<'a, V: Visitor<'a>>(visitor: &mut V, arm: &'a Arm) {
 828     visitor.visit_pat(&arm.pat);
 829     walk_list!(visitor, visit_expr, &arm.guard);
 830     visitor.visit_expr(&arm.body);
 831     walk_list!(visitor, visit_attribute, &arm.attrs);
 832 }
 833
 834 pub fn walk_vis<'a, V: Visitor<'a>>(visitor: &mut V, vis: &'a Visibility) {
 835     if let VisibilityKind::Restricted { ref path, id } = vis.node {
 836         visitor.visit_path(path, id);
 837     }
 838 }
 839
 840 pub fn walk_attribute<'a, V: Visitor<'a>>(visitor: &mut V, attr: &'a Attribute) {
 841     match attr.kind {
 842         AttrKind::Normal(ref item) => visitor.visit_tts(item.tokens.clone()),
 843         AttrKind::DocComment(_) => {}
 844     }
 845 }
 846
 847 pub fn walk_tt<'a, V: Visitor<'a>>(visitor: &mut V, tt: TokenTree) {
 848     match tt {
 849         TokenTree::Token(token) => visitor.visit_token(token),
 850         TokenTree::Delimited(_, _, tts) => visitor.visit_tts(tts),
 851     }
 852 }
 853
 854 pub fn walk_tts<'a, V: Visitor<'a>>(visitor: &mut V, tts: TokenStream) {
 855     for tt in tts.trees() {
 856         visitor.visit_tt(tt);
 857     }
 858 }