]> git.lizzy.rs Git - rust.git/blob - src/librustc/hir/intravisit.rs
3c70df7461248968b1400a9d023fe7653c94afc9
[rust.git] / src / librustc / hir / intravisit.rs
1 //! HIR walker for walking the contents of nodes.
2 //!
3 //! **For an overview of the visitor strategy, see the docs on the
4 //! `super::itemlikevisit::ItemLikeVisitor` trait.**
5 //!
6 //! If you have decided to use this visitor, here are some general
7 //! notes on how to do so:
8 //!
9 //! Each overridden visit method has full control over what
10 //! happens with its node, it can do its own traversal of the node's children,
11 //! call `intravisit::walk_*` to apply the default traversal algorithm, or prevent
12 //! deeper traversal by doing nothing.
13 //!
14 //! When visiting the HIR, the contents of nested items are NOT visited
15 //! by default. This is different from the AST visitor, which does a deep walk.
16 //! Hence this module is called `intravisit`; see the method `visit_nested_item`
17 //! for more details.
18 //!
19 //! Note: it is an important invariant that the default visitor walks
20 //! the body of a function in "execution order" - more concretely, if
21 //! we consider the reverse post-order (RPO) of the CFG implied by the HIR,
22 //! then a pre-order traversal of the HIR is consistent with the CFG RPO
23 //! on the *initial CFG point* of each HIR node, while a post-order traversal
24 //! of the HIR is consistent with the CFG RPO on each *final CFG point* of
25 //! each CFG node.
26 //!
27 //! One thing that follows is that if HIR node A always starts/ends executing
28 //! before HIR node B, then A appears in traversal pre/postorder before B,
29 //! respectively. (This follows from RPO respecting CFG domination).
30 //!
31 //! This order consistency is required in a few places in rustc, for
32 //! example generator inference, and possibly also HIR borrowck.
33
34 use syntax::ast::{Ident, Name, Attribute};
35 use syntax_pos::Span;
36 use crate::hir::*;
37 use crate::hir::def::Def;
38 use crate::hir::map::Map;
39 use super::itemlikevisit::DeepVisitor;
40
41 #[derive(Copy, Clone)]
42 pub enum FnKind<'a> {
43     /// `#[xxx] pub async/const/extern "Abi" fn foo()`
44     ItemFn(Ident, &'a Generics, FnHeader, &'a Visibility, &'a [Attribute]),
45
46     /// `fn foo(&self)`
47     Method(Ident, &'a MethodSig, Option<&'a Visibility>, &'a [Attribute]),
48
49     /// `|x, y| {}`
50     Closure(&'a [Attribute]),
51 }
52
53 impl<'a> FnKind<'a> {
54     pub fn attrs(&self) -> &'a [Attribute] {
55         match *self {
56             FnKind::ItemFn(.., attrs) => attrs,
57             FnKind::Method(.., attrs) => attrs,
58             FnKind::Closure(attrs) => attrs,
59         }
60     }
61 }
62
63 /// Specifies what nested things a visitor wants to visit. The most
64 /// common choice is `OnlyBodies`, which will cause the visitor to
65 /// visit fn bodies for fns that it encounters, but skip over nested
66 /// item-like things.
67 ///
68 /// See the comments on `ItemLikeVisitor` for more details on the overall
69 /// visit strategy.
70 pub enum NestedVisitorMap<'this, 'tcx: 'this> {
71     /// Do not visit any nested things. When you add a new
72     /// "non-nested" thing, you will want to audit such uses to see if
73     /// they remain valid.
74     ///
75     /// Use this if you are only walking some particular kind of tree
76     /// (i.e., a type, or fn signature) and you don't want to thread a
77     /// HIR map around.
78     None,
79
80     /// Do not visit nested item-like things, but visit nested things
81     /// that are inside of an item-like.
82     ///
83     /// **This is the most common choice.** A very common pattern is
84     /// to use `visit_all_item_likes()` as an outer loop,
85     /// and to have the visitor that visits the contents of each item
86     /// using this setting.
87     OnlyBodies(&'this Map<'tcx>),
88
89     /// Visits all nested things, including item-likes.
90     ///
91     /// **This is an unusual choice.** It is used when you want to
92     /// process everything within their lexical context. Typically you
93     /// kick off the visit by doing `walk_krate()`.
94     All(&'this Map<'tcx>),
95 }
96
97 impl<'this, 'tcx> NestedVisitorMap<'this, 'tcx> {
98     /// Returns the map to use for an "intra item-like" thing (if any).
99     /// E.g., function body.
100     pub fn intra(self) -> Option<&'this Map<'tcx>> {
101         match self {
102             NestedVisitorMap::None => None,
103             NestedVisitorMap::OnlyBodies(map) => Some(map),
104             NestedVisitorMap::All(map) => Some(map),
105         }
106     }
107
108     /// Returns the map to use for an "item-like" thing (if any).
109     /// E.g., item, impl-item.
110     pub fn inter(self) -> Option<&'this Map<'tcx>> {
111         match self {
112             NestedVisitorMap::None => None,
113             NestedVisitorMap::OnlyBodies(_) => None,
114             NestedVisitorMap::All(map) => Some(map),
115         }
116     }
117 }
118
119 /// Each method of the Visitor trait is a hook to be potentially
120 /// overridden. Each method's default implementation recursively visits
121 /// the substructure of the input via the corresponding `walk` method;
122 /// e.g., the `visit_mod` method by default calls `intravisit::walk_mod`.
123 ///
124 /// Note that this visitor does NOT visit nested items by default
125 /// (this is why the module is called `intravisit`, to distinguish it
126 /// from the AST's `visit` module, which acts differently). If you
127 /// simply want to visit all items in the crate in some order, you
128 /// should call `Crate::visit_all_items`. Otherwise, see the comment
129 /// on `visit_nested_item` for details on how to visit nested items.
130 ///
131 /// If you want to ensure that your code handles every variant
132 /// explicitly, you need to override each method. (And you also need
133 /// to monitor future changes to `Visitor` in case a new method with a
134 /// new default implementation gets introduced.)
135 pub trait Visitor<'v> : Sized {
136     ///////////////////////////////////////////////////////////////////////////
137     // Nested items.
138
139     /// The default versions of the `visit_nested_XXX` routines invoke
140     /// this method to get a map to use. By selecting an enum variant,
141     /// you control which kinds of nested HIR are visited; see
142     /// `NestedVisitorMap` for details. By "nested HIR", we are
143     /// referring to bits of HIR that are not directly embedded within
144     /// one another but rather indirectly, through a table in the
145     /// crate. This is done to control dependencies during incremental
146     /// compilation: the non-inline bits of HIR can be tracked and
147     /// hashed separately.
148     ///
149     /// **If for some reason you want the nested behavior, but don't
150     /// have a `Map` at your disposal:** then you should override the
151     /// `visit_nested_XXX` methods, and override this method to
152     /// `panic!()`. This way, if a new `visit_nested_XXX` variant is
153     /// added in the future, we will see the panic in your code and
154     /// fix it appropriately.
155     fn nested_visit_map<'this>(&'this mut self) -> NestedVisitorMap<'this, 'v>;
156
157     /// Invoked when a nested item is encountered. By default does
158     /// nothing unless you override `nested_visit_map` to return
159     /// `Some(_)`, in which case it will walk the item. **You probably
160     /// don't want to override this method** -- instead, override
161     /// `nested_visit_map` or use the "shallow" or "deep" visit
162     /// patterns described on `itemlikevisit::ItemLikeVisitor`. The only
163     /// reason to override this method is if you want a nested pattern
164     /// but cannot supply a `Map`; see `nested_visit_map` for advice.
165     #[allow(unused_variables)]
166     fn visit_nested_item(&mut self, id: ItemId) {
167         let opt_item = self.nested_visit_map().inter().map(|map| map.expect_item(id.id));
168         if let Some(item) = opt_item {
169             self.visit_item(item);
170         }
171     }
172
173     /// Like `visit_nested_item()`, but for trait items. See
174     /// `visit_nested_item()` for advice on when to override this
175     /// method.
176     #[allow(unused_variables)]
177     fn visit_nested_trait_item(&mut self, id: TraitItemId) {
178         let opt_item = self.nested_visit_map().inter().map(|map| map.trait_item(id));
179         if let Some(item) = opt_item {
180             self.visit_trait_item(item);
181         }
182     }
183
184     /// Like `visit_nested_item()`, but for impl items. See
185     /// `visit_nested_item()` for advice on when to override this
186     /// method.
187     #[allow(unused_variables)]
188     fn visit_nested_impl_item(&mut self, id: ImplItemId) {
189         let opt_item = self.nested_visit_map().inter().map(|map| map.impl_item(id));
190         if let Some(item) = opt_item {
191             self.visit_impl_item(item);
192         }
193     }
194
195     /// Invoked to visit the body of a function, method or closure. Like
196     /// visit_nested_item, does nothing by default unless you override
197     /// `nested_visit_map` to return `Some(_)`, in which case it will walk the
198     /// body.
199     fn visit_nested_body(&mut self, id: BodyId) {
200         let opt_body = self.nested_visit_map().intra().map(|map| map.body(id));
201         if let Some(body) = opt_body {
202             self.visit_body(body);
203         }
204     }
205
206     /// Visits the top-level item and (optionally) nested items / impl items. See
207     /// `visit_nested_item` for details.
208     fn visit_item(&mut self, i: &'v Item) {
209         walk_item(self, i)
210     }
211
212     fn visit_body(&mut self, b: &'v Body) {
213         walk_body(self, b);
214     }
215
216     /// When invoking `visit_all_item_likes()`, you need to supply an
217     /// item-like visitor. This method converts a "intra-visit"
218     /// visitor into an item-like visitor that walks the entire tree.
219     /// If you use this, you probably don't want to process the
220     /// contents of nested item-like things, since the outer loop will
221     /// visit them as well.
222     fn as_deep_visitor<'s>(&'s mut self) -> DeepVisitor<'s, Self> {
223         DeepVisitor::new(self)
224     }
225
226     ///////////////////////////////////////////////////////////////////////////
227
228     fn visit_id(&mut self, _hir_id: HirId) {
229         // Nothing to do.
230     }
231     fn visit_def_mention(&mut self, _def: Def) {
232         // Nothing to do.
233     }
234     fn visit_name(&mut self, _span: Span, _name: Name) {
235         // Nothing to do.
236     }
237     fn visit_ident(&mut self, ident: Ident) {
238         walk_ident(self, ident)
239     }
240     fn visit_mod(&mut self, m: &'v Mod, _s: Span, n: HirId) {
241         walk_mod(self, m, n)
242     }
243     fn visit_foreign_item(&mut self, i: &'v ForeignItem) {
244         walk_foreign_item(self, i)
245     }
246     fn visit_local(&mut self, l: &'v Local) {
247         walk_local(self, l)
248     }
249     fn visit_block(&mut self, b: &'v Block) {
250         walk_block(self, b)
251     }
252     fn visit_stmt(&mut self, s: &'v Stmt) {
253         walk_stmt(self, s)
254     }
255     fn visit_arm(&mut self, a: &'v Arm) {
256         walk_arm(self, a)
257     }
258     fn visit_pat(&mut self, p: &'v Pat) {
259         walk_pat(self, p)
260     }
261     fn visit_anon_const(&mut self, c: &'v AnonConst) {
262         walk_anon_const(self, c)
263     }
264     fn visit_expr(&mut self, ex: &'v Expr) {
265         walk_expr(self, ex)
266     }
267     fn visit_ty(&mut self, t: &'v Ty) {
268         walk_ty(self, t)
269     }
270     fn visit_generic_param(&mut self, p: &'v GenericParam) {
271         walk_generic_param(self, p)
272     }
273     fn visit_generics(&mut self, g: &'v Generics) {
274         walk_generics(self, g)
275     }
276     fn visit_where_predicate(&mut self, predicate: &'v WherePredicate) {
277         walk_where_predicate(self, predicate)
278     }
279     fn visit_fn_decl(&mut self, fd: &'v FnDecl) {
280         walk_fn_decl(self, fd)
281     }
282     fn visit_fn(&mut self, fk: FnKind<'v>, fd: &'v FnDecl, b: BodyId, s: Span, id: HirId) {
283         walk_fn(self, fk, fd, b, s, id)
284     }
285     fn visit_use(&mut self, path: &'v Path, hir_id: HirId) {
286         walk_use(self, path, hir_id)
287     }
288     fn visit_trait_item(&mut self, ti: &'v TraitItem) {
289         walk_trait_item(self, ti)
290     }
291     fn visit_trait_item_ref(&mut self, ii: &'v TraitItemRef) {
292         walk_trait_item_ref(self, ii)
293     }
294     fn visit_impl_item(&mut self, ii: &'v ImplItem) {
295         walk_impl_item(self, ii)
296     }
297     fn visit_impl_item_ref(&mut self, ii: &'v ImplItemRef) {
298         walk_impl_item_ref(self, ii)
299     }
300     fn visit_trait_ref(&mut self, t: &'v TraitRef) {
301         walk_trait_ref(self, t)
302     }
303     fn visit_param_bound(&mut self, bounds: &'v GenericBound) {
304         walk_param_bound(self, bounds)
305     }
306     fn visit_poly_trait_ref(&mut self, t: &'v PolyTraitRef, m: TraitBoundModifier) {
307         walk_poly_trait_ref(self, t, m)
308     }
309     fn visit_variant_data(&mut self,
310                           s: &'v VariantData,
311                           _: Name,
312                           _: &'v Generics,
313                           _parent_id: HirId,
314                           _: Span) {
315         walk_struct_def(self, s)
316     }
317     fn visit_struct_field(&mut self, s: &'v StructField) {
318         walk_struct_field(self, s)
319     }
320     fn visit_enum_def(&mut self,
321                       enum_definition: &'v EnumDef,
322                       generics: &'v Generics,
323                       item_id: HirId,
324                       _: Span) {
325         walk_enum_def(self, enum_definition, generics, item_id)
326     }
327     fn visit_variant(&mut self, v: &'v Variant, g: &'v Generics, item_id: HirId) {
328         walk_variant(self, v, g, item_id)
329     }
330     fn visit_label(&mut self, label: &'v Label) {
331         walk_label(self, label)
332     }
333     fn visit_generic_arg(&mut self, generic_arg: &'v GenericArg) {
334         match generic_arg {
335             GenericArg::Lifetime(lt) => self.visit_lifetime(lt),
336             GenericArg::Type(ty) => self.visit_ty(ty),
337             GenericArg::Const(ct) => self.visit_anon_const(&ct.value),
338         }
339     }
340     fn visit_lifetime(&mut self, lifetime: &'v Lifetime) {
341         walk_lifetime(self, lifetime)
342     }
343     fn visit_qpath(&mut self, qpath: &'v QPath, id: HirId, span: Span) {
344         walk_qpath(self, qpath, id, span)
345     }
346     fn visit_path(&mut self, path: &'v Path, _id: HirId) {
347         walk_path(self, path)
348     }
349     fn visit_path_segment(&mut self, path_span: Span, path_segment: &'v PathSegment) {
350         walk_path_segment(self, path_span, path_segment)
351     }
352     fn visit_generic_args(&mut self, path_span: Span, generic_args: &'v GenericArgs) {
353         walk_generic_args(self, path_span, generic_args)
354     }
355     fn visit_assoc_type_binding(&mut self, type_binding: &'v TypeBinding) {
356         walk_assoc_type_binding(self, type_binding)
357     }
358     fn visit_attribute(&mut self, _attr: &'v Attribute) {
359     }
360     fn visit_macro_def(&mut self, macro_def: &'v MacroDef) {
361         walk_macro_def(self, macro_def)
362     }
363     fn visit_vis(&mut self, vis: &'v Visibility) {
364         walk_vis(self, vis)
365     }
366     fn visit_associated_item_kind(&mut self, kind: &'v AssociatedItemKind) {
367         walk_associated_item_kind(self, kind);
368     }
369     fn visit_defaultness(&mut self, defaultness: &'v Defaultness) {
370         walk_defaultness(self, defaultness);
371     }
372 }
373
374 /// Walks the contents of a crate. See also `Crate::visit_all_items`.
375 pub fn walk_crate<'v, V: Visitor<'v>>(visitor: &mut V, krate: &'v Crate) {
376     visitor.visit_mod(&krate.module, krate.span, CRATE_HIR_ID);
377     walk_list!(visitor, visit_attribute, &krate.attrs);
378     walk_list!(visitor, visit_macro_def, &krate.exported_macros);
379 }
380
381 pub fn walk_macro_def<'v, V: Visitor<'v>>(visitor: &mut V, macro_def: &'v MacroDef) {
382     visitor.visit_id(macro_def.hir_id);
383     visitor.visit_name(macro_def.span, macro_def.name);
384     walk_list!(visitor, visit_attribute, &macro_def.attrs);
385 }
386
387 pub fn walk_mod<'v, V: Visitor<'v>>(visitor: &mut V, module: &'v Mod, mod_hir_id: HirId) {
388     visitor.visit_id(mod_hir_id);
389     for &item_id in &module.item_ids {
390         visitor.visit_nested_item(item_id);
391     }
392 }
393
394 pub fn walk_body<'v, V: Visitor<'v>>(visitor: &mut V, body: &'v Body) {
395     for argument in &body.arguments {
396         visitor.visit_id(argument.hir_id);
397         visitor.visit_pat(&argument.pat);
398     }
399     visitor.visit_expr(&body.value);
400 }
401
402 pub fn walk_local<'v, V: Visitor<'v>>(visitor: &mut V, local: &'v Local) {
403     // Intentionally visiting the expr first - the initialization expr
404     // dominates the local's definition.
405     walk_list!(visitor, visit_expr, &local.init);
406     walk_list!(visitor, visit_attribute, local.attrs.iter());
407     visitor.visit_id(local.hir_id);
408     visitor.visit_pat(&local.pat);
409     walk_list!(visitor, visit_ty, &local.ty);
410 }
411
412 pub fn walk_ident<'v, V: Visitor<'v>>(visitor: &mut V, ident: Ident) {
413     visitor.visit_name(ident.span, ident.name);
414 }
415
416 pub fn walk_label<'v, V: Visitor<'v>>(visitor: &mut V, label: &'v Label) {
417     visitor.visit_ident(label.ident);
418 }
419
420 pub fn walk_lifetime<'v, V: Visitor<'v>>(visitor: &mut V, lifetime: &'v Lifetime) {
421     visitor.visit_id(lifetime.hir_id);
422     match lifetime.name {
423         LifetimeName::Param(ParamName::Plain(ident)) => {
424             visitor.visit_ident(ident);
425         }
426         LifetimeName::Param(ParamName::Fresh(_)) |
427         LifetimeName::Param(ParamName::Error) |
428         LifetimeName::Static |
429         LifetimeName::Error |
430         LifetimeName::Implicit |
431         LifetimeName::Underscore => {}
432     }
433 }
434
435 pub fn walk_poly_trait_ref<'v, V>(visitor: &mut V,
436                                   trait_ref: &'v PolyTraitRef,
437                                   _modifier: TraitBoundModifier)
438     where V: Visitor<'v>
439 {
440     walk_list!(visitor, visit_generic_param, &trait_ref.bound_generic_params);
441     visitor.visit_trait_ref(&trait_ref.trait_ref);
442 }
443
444 pub fn walk_trait_ref<'v, V>(visitor: &mut V, trait_ref: &'v TraitRef)
445     where V: Visitor<'v>
446 {
447     visitor.visit_id(trait_ref.hir_ref_id);
448     visitor.visit_path(&trait_ref.path, trait_ref.hir_ref_id)
449 }
450
451 pub fn walk_item<'v, V: Visitor<'v>>(visitor: &mut V, item: &'v Item) {
452     visitor.visit_vis(&item.vis);
453     visitor.visit_ident(item.ident);
454     match item.node {
455         ItemKind::ExternCrate(orig_name) => {
456             visitor.visit_id(item.hir_id);
457             if let Some(orig_name) = orig_name {
458                 visitor.visit_name(item.span, orig_name);
459             }
460         }
461         ItemKind::Use(ref path, _) => {
462             visitor.visit_use(path, item.hir_id);
463         }
464         ItemKind::Static(ref typ, _, body) |
465         ItemKind::Const(ref typ, body) => {
466             visitor.visit_id(item.hir_id);
467             visitor.visit_ty(typ);
468             visitor.visit_nested_body(body);
469         }
470         ItemKind::Fn(ref declaration, header, ref generics, body_id) => {
471             visitor.visit_fn(FnKind::ItemFn(item.ident,
472                                             generics,
473                                             header,
474                                             &item.vis,
475                                             &item.attrs),
476                              declaration,
477                              body_id,
478                              item.span,
479                              item.hir_id)
480         }
481         ItemKind::Mod(ref module) => {
482             // `visit_mod()` takes care of visiting the `Item`'s `HirId`.
483             visitor.visit_mod(module, item.span, item.hir_id)
484         }
485         ItemKind::ForeignMod(ref foreign_module) => {
486             visitor.visit_id(item.hir_id);
487             walk_list!(visitor, visit_foreign_item, &foreign_module.items);
488         }
489         ItemKind::GlobalAsm(_) => {
490             visitor.visit_id(item.hir_id);
491         }
492         ItemKind::Ty(ref typ, ref type_parameters) => {
493             visitor.visit_id(item.hir_id);
494             visitor.visit_ty(typ);
495             visitor.visit_generics(type_parameters)
496         }
497         ItemKind::Existential(ExistTy {ref generics, ref bounds, impl_trait_fn}) => {
498             visitor.visit_id(item.hir_id);
499             walk_generics(visitor, generics);
500             walk_list!(visitor, visit_param_bound, bounds);
501             if let Some(impl_trait_fn) = impl_trait_fn {
502                 visitor.visit_def_mention(Def::Fn(impl_trait_fn))
503             }
504         }
505         ItemKind::Enum(ref enum_definition, ref type_parameters) => {
506             visitor.visit_generics(type_parameters);
507             // `visit_enum_def()` takes care of visiting the `Item`'s `HirId`.
508             visitor.visit_enum_def(enum_definition, type_parameters, item.hir_id, item.span)
509         }
510         ItemKind::Impl(
511             ..,
512             ref type_parameters,
513             ref opt_trait_reference,
514             ref typ,
515             ref impl_item_refs
516         ) => {
517             visitor.visit_id(item.hir_id);
518             visitor.visit_generics(type_parameters);
519             walk_list!(visitor, visit_trait_ref, opt_trait_reference);
520             visitor.visit_ty(typ);
521             walk_list!(visitor, visit_impl_item_ref, impl_item_refs);
522         }
523         ItemKind::Struct(ref struct_definition, ref generics) |
524         ItemKind::Union(ref struct_definition, ref generics) => {
525             visitor.visit_generics(generics);
526             visitor.visit_id(item.hir_id);
527             visitor.visit_variant_data(struct_definition, item.ident.name, generics, item.hir_id,
528                                        item.span);
529         }
530         ItemKind::Trait(.., ref generics, ref bounds, ref trait_item_refs) => {
531             visitor.visit_id(item.hir_id);
532             visitor.visit_generics(generics);
533             walk_list!(visitor, visit_param_bound, bounds);
534             walk_list!(visitor, visit_trait_item_ref, trait_item_refs);
535         }
536         ItemKind::TraitAlias(ref generics, ref bounds) => {
537             visitor.visit_id(item.hir_id);
538             visitor.visit_generics(generics);
539             walk_list!(visitor, visit_param_bound, bounds);
540         }
541     }
542     walk_list!(visitor, visit_attribute, &item.attrs);
543 }
544
545 pub fn walk_use<'v, V: Visitor<'v>>(visitor: &mut V,
546                                     path: &'v Path,
547                                     hir_id: HirId) {
548     visitor.visit_id(hir_id);
549     visitor.visit_path(path, hir_id);
550 }
551
552 pub fn walk_enum_def<'v, V: Visitor<'v>>(visitor: &mut V,
553                                          enum_definition: &'v EnumDef,
554                                          generics: &'v Generics,
555                                          item_id: HirId) {
556     visitor.visit_id(item_id);
557     walk_list!(visitor,
558                visit_variant,
559                &enum_definition.variants,
560                generics,
561                item_id);
562 }
563
564 pub fn walk_variant<'v, V: Visitor<'v>>(visitor: &mut V,
565                                         variant: &'v Variant,
566                                         generics: &'v Generics,
567                                         parent_item_id: HirId) {
568     visitor.visit_ident(variant.node.ident);
569     visitor.visit_variant_data(&variant.node.data,
570                                variant.node.ident.name,
571                                generics,
572                                parent_item_id,
573                                variant.span);
574     walk_list!(visitor, visit_anon_const, &variant.node.disr_expr);
575     walk_list!(visitor, visit_attribute, &variant.node.attrs);
576 }
577
578 pub fn walk_ty<'v, V: Visitor<'v>>(visitor: &mut V, typ: &'v Ty) {
579     visitor.visit_id(typ.hir_id);
580
581     match typ.node {
582         TyKind::Slice(ref ty) => {
583             visitor.visit_ty(ty)
584         }
585         TyKind::Ptr(ref mutable_type) => {
586             visitor.visit_ty(&mutable_type.ty)
587         }
588         TyKind::Rptr(ref lifetime, ref mutable_type) => {
589             visitor.visit_lifetime(lifetime);
590             visitor.visit_ty(&mutable_type.ty)
591         }
592         TyKind::Never => {},
593         TyKind::Tup(ref tuple_element_types) => {
594             walk_list!(visitor, visit_ty, tuple_element_types);
595         }
596         TyKind::BareFn(ref function_declaration) => {
597             walk_list!(visitor, visit_generic_param, &function_declaration.generic_params);
598             visitor.visit_fn_decl(&function_declaration.decl);
599         }
600         TyKind::Path(ref qpath) => {
601             visitor.visit_qpath(qpath, typ.hir_id, typ.span);
602         }
603         TyKind::Def(item_id, ref lifetimes) => {
604             visitor.visit_nested_item(item_id);
605             walk_list!(visitor, visit_generic_arg, lifetimes);
606         }
607         TyKind::Array(ref ty, ref length) => {
608             visitor.visit_ty(ty);
609             visitor.visit_anon_const(length)
610         }
611         TyKind::TraitObject(ref bounds, ref lifetime) => {
612             for bound in bounds {
613                 visitor.visit_poly_trait_ref(bound, TraitBoundModifier::None);
614             }
615             visitor.visit_lifetime(lifetime);
616         }
617         TyKind::Typeof(ref expression) => {
618             visitor.visit_anon_const(expression)
619         }
620         TyKind::CVarArgs(ref lt) => {
621             visitor.visit_lifetime(lt)
622         }
623         TyKind::Infer | TyKind::Err => {}
624     }
625 }
626
627 pub fn walk_qpath<'v, V: Visitor<'v>>(visitor: &mut V, qpath: &'v QPath, id: HirId, span: Span) {
628     match *qpath {
629         QPath::Resolved(ref maybe_qself, ref path) => {
630             if let Some(ref qself) = *maybe_qself {
631                 visitor.visit_ty(qself);
632             }
633             visitor.visit_path(path, id)
634         }
635         QPath::TypeRelative(ref qself, ref segment) => {
636             visitor.visit_ty(qself);
637             visitor.visit_path_segment(span, segment);
638         }
639     }
640 }
641
642 pub fn walk_path<'v, V: Visitor<'v>>(visitor: &mut V, path: &'v Path) {
643     visitor.visit_def_mention(path.def);
644     for segment in &path.segments {
645         visitor.visit_path_segment(path.span, segment);
646     }
647 }
648
649 pub fn walk_path_segment<'v, V: Visitor<'v>>(visitor: &mut V,
650                                              path_span: Span,
651                                              segment: &'v PathSegment) {
652     visitor.visit_ident(segment.ident);
653     if let Some(id) = segment.hir_id {
654         visitor.visit_id(id);
655     }
656     if let Some(ref args) = segment.args {
657         visitor.visit_generic_args(path_span, args);
658     }
659 }
660
661 pub fn walk_generic_args<'v, V: Visitor<'v>>(visitor: &mut V,
662                                              _path_span: Span,
663                                              generic_args: &'v GenericArgs) {
664     walk_list!(visitor, visit_generic_arg, &generic_args.args);
665     walk_list!(visitor, visit_assoc_type_binding, &generic_args.bindings);
666 }
667
668 pub fn walk_assoc_type_binding<'v, V: Visitor<'v>>(visitor: &mut V,
669                                                    type_binding: &'v TypeBinding) {
670     visitor.visit_id(type_binding.hir_id);
671     visitor.visit_ident(type_binding.ident);
672     visitor.visit_ty(&type_binding.ty);
673 }
674
675 pub fn walk_pat<'v, V: Visitor<'v>>(visitor: &mut V, pattern: &'v Pat) {
676     visitor.visit_id(pattern.hir_id);
677     match pattern.node {
678         PatKind::TupleStruct(ref qpath, ref children, _) => {
679             visitor.visit_qpath(qpath, pattern.hir_id, pattern.span);
680             walk_list!(visitor, visit_pat, children);
681         }
682         PatKind::Path(ref qpath) => {
683             visitor.visit_qpath(qpath, pattern.hir_id, pattern.span);
684         }
685         PatKind::Struct(ref qpath, ref fields, _) => {
686             visitor.visit_qpath(qpath, pattern.hir_id, pattern.span);
687             for field in fields {
688                 visitor.visit_id(field.node.hir_id);
689                 visitor.visit_ident(field.node.ident);
690                 visitor.visit_pat(&field.node.pat)
691             }
692         }
693         PatKind::Tuple(ref tuple_elements, _) => {
694             walk_list!(visitor, visit_pat, tuple_elements);
695         }
696         PatKind::Box(ref subpattern) |
697         PatKind::Ref(ref subpattern, _) => {
698             visitor.visit_pat(subpattern)
699         }
700         PatKind::Binding(_, _hir_id, ident, ref optional_subpattern) => {
701             // visitor.visit_def_mention(Def::Local(hir_id));
702             visitor.visit_ident(ident);
703             walk_list!(visitor, visit_pat, optional_subpattern);
704         }
705         PatKind::Lit(ref expression) => visitor.visit_expr(expression),
706         PatKind::Range(ref lower_bound, ref upper_bound, _) => {
707             visitor.visit_expr(lower_bound);
708             visitor.visit_expr(upper_bound)
709         }
710         PatKind::Wild => (),
711         PatKind::Slice(ref prepatterns, ref slice_pattern, ref postpatterns) => {
712             walk_list!(visitor, visit_pat, prepatterns);
713             walk_list!(visitor, visit_pat, slice_pattern);
714             walk_list!(visitor, visit_pat, postpatterns);
715         }
716     }
717 }
718
719 pub fn walk_foreign_item<'v, V: Visitor<'v>>(visitor: &mut V, foreign_item: &'v ForeignItem) {
720     visitor.visit_id(foreign_item.hir_id);
721     visitor.visit_vis(&foreign_item.vis);
722     visitor.visit_ident(foreign_item.ident);
723
724     match foreign_item.node {
725         ForeignItemKind::Fn(ref function_declaration, ref param_names, ref generics) => {
726             visitor.visit_generics(generics);
727             visitor.visit_fn_decl(function_declaration);
728             for &param_name in param_names {
729                 visitor.visit_ident(param_name);
730             }
731         }
732         ForeignItemKind::Static(ref typ, _) => visitor.visit_ty(typ),
733         ForeignItemKind::Type => (),
734     }
735
736     walk_list!(visitor, visit_attribute, &foreign_item.attrs);
737 }
738
739 pub fn walk_param_bound<'v, V: Visitor<'v>>(visitor: &mut V, bound: &'v GenericBound) {
740     match *bound {
741         GenericBound::Trait(ref typ, modifier) => {
742             visitor.visit_poly_trait_ref(typ, modifier);
743         }
744         GenericBound::Outlives(ref lifetime) => visitor.visit_lifetime(lifetime),
745     }
746 }
747
748 pub fn walk_generic_param<'v, V: Visitor<'v>>(visitor: &mut V, param: &'v GenericParam) {
749     visitor.visit_id(param.hir_id);
750     walk_list!(visitor, visit_attribute, &param.attrs);
751     match param.name {
752         ParamName::Plain(ident) => visitor.visit_ident(ident),
753         ParamName::Error | ParamName::Fresh(_) => {}
754     }
755     match param.kind {
756         GenericParamKind::Lifetime { .. } => {}
757         GenericParamKind::Type { ref default, .. } => walk_list!(visitor, visit_ty, default),
758         GenericParamKind::Const { ref ty } => visitor.visit_ty(ty),
759     }
760     walk_list!(visitor, visit_param_bound, &param.bounds);
761 }
762
763 pub fn walk_generics<'v, V: Visitor<'v>>(visitor: &mut V, generics: &'v Generics) {
764     walk_list!(visitor, visit_generic_param, &generics.params);
765     visitor.visit_id(generics.where_clause.hir_id);
766     walk_list!(visitor, visit_where_predicate, &generics.where_clause.predicates);
767 }
768
769 pub fn walk_where_predicate<'v, V: Visitor<'v>>(
770     visitor: &mut V,
771     predicate: &'v WherePredicate)
772 {
773     match predicate {
774         &WherePredicate::BoundPredicate(WhereBoundPredicate{ref bounded_ty,
775                                                             ref bounds,
776                                                             ref bound_generic_params,
777                                                             ..}) => {
778             visitor.visit_ty(bounded_ty);
779             walk_list!(visitor, visit_param_bound, bounds);
780             walk_list!(visitor, visit_generic_param, bound_generic_params);
781         }
782         &WherePredicate::RegionPredicate(WhereRegionPredicate{ref lifetime,
783                                                               ref bounds,
784                                                               ..}) => {
785             visitor.visit_lifetime(lifetime);
786             walk_list!(visitor, visit_param_bound, bounds);
787         }
788         &WherePredicate::EqPredicate(WhereEqPredicate{hir_id,
789                                                       ref lhs_ty,
790                                                       ref rhs_ty,
791                                                       ..}) => {
792             visitor.visit_id(hir_id);
793             visitor.visit_ty(lhs_ty);
794             visitor.visit_ty(rhs_ty);
795         }
796     }
797 }
798
799 pub fn walk_fn_ret_ty<'v, V: Visitor<'v>>(visitor: &mut V, ret_ty: &'v FunctionRetTy) {
800     if let Return(ref output_ty) = *ret_ty {
801         visitor.visit_ty(output_ty)
802     }
803 }
804
805 pub fn walk_fn_decl<'v, V: Visitor<'v>>(visitor: &mut V, function_declaration: &'v FnDecl) {
806     for ty in &function_declaration.inputs {
807         visitor.visit_ty(ty)
808     }
809     walk_fn_ret_ty(visitor, &function_declaration.output)
810 }
811
812 pub fn walk_fn_kind<'v, V: Visitor<'v>>(visitor: &mut V, function_kind: FnKind<'v>) {
813     match function_kind {
814         FnKind::ItemFn(_, generics, ..) => {
815             visitor.visit_generics(generics);
816         }
817         FnKind::Method(..) |
818         FnKind::Closure(_) => {}
819     }
820 }
821
822 pub fn walk_fn<'v, V: Visitor<'v>>(visitor: &mut V,
823                                    function_kind: FnKind<'v>,
824                                    function_declaration: &'v FnDecl,
825                                    body_id: BodyId,
826                                    _span: Span,
827                                    id: HirId) {
828     visitor.visit_id(id);
829     visitor.visit_fn_decl(function_declaration);
830     walk_fn_kind(visitor, function_kind);
831     visitor.visit_nested_body(body_id)
832 }
833
834 pub fn walk_trait_item<'v, V: Visitor<'v>>(visitor: &mut V, trait_item: &'v TraitItem) {
835     visitor.visit_ident(trait_item.ident);
836     walk_list!(visitor, visit_attribute, &trait_item.attrs);
837     visitor.visit_generics(&trait_item.generics);
838     match trait_item.node {
839         TraitItemKind::Const(ref ty, default) => {
840             visitor.visit_id(trait_item.hir_id);
841             visitor.visit_ty(ty);
842             walk_list!(visitor, visit_nested_body, default);
843         }
844         TraitItemKind::Method(ref sig, TraitMethod::Required(ref param_names)) => {
845             visitor.visit_id(trait_item.hir_id);
846             visitor.visit_fn_decl(&sig.decl);
847             for &param_name in param_names {
848                 visitor.visit_ident(param_name);
849             }
850         }
851         TraitItemKind::Method(ref sig, TraitMethod::Provided(body_id)) => {
852             visitor.visit_fn(FnKind::Method(trait_item.ident,
853                                             sig,
854                                             None,
855                                             &trait_item.attrs),
856                              &sig.decl,
857                              body_id,
858                              trait_item.span,
859                              trait_item.hir_id);
860         }
861         TraitItemKind::Type(ref bounds, ref default) => {
862             visitor.visit_id(trait_item.hir_id);
863             walk_list!(visitor, visit_param_bound, bounds);
864             walk_list!(visitor, visit_ty, default);
865         }
866     }
867 }
868
869 pub fn walk_trait_item_ref<'v, V: Visitor<'v>>(visitor: &mut V, trait_item_ref: &'v TraitItemRef) {
870     // N.B., deliberately force a compilation error if/when new fields are added.
871     let TraitItemRef { id, ident, ref kind, span: _, ref defaultness } = *trait_item_ref;
872     visitor.visit_nested_trait_item(id);
873     visitor.visit_ident(ident);
874     visitor.visit_associated_item_kind(kind);
875     visitor.visit_defaultness(defaultness);
876 }
877
878 pub fn walk_impl_item<'v, V: Visitor<'v>>(visitor: &mut V, impl_item: &'v ImplItem) {
879     // N.B., deliberately force a compilation error if/when new fields are added.
880     let ImplItem {
881         hir_id: _,
882         ident,
883         ref vis,
884         ref defaultness,
885         ref attrs,
886         ref generics,
887         ref node,
888         span: _,
889     } = *impl_item;
890
891     visitor.visit_ident(ident);
892     visitor.visit_vis(vis);
893     visitor.visit_defaultness(defaultness);
894     walk_list!(visitor, visit_attribute, attrs);
895     visitor.visit_generics(generics);
896     match *node {
897         ImplItemKind::Const(ref ty, body) => {
898             visitor.visit_id(impl_item.hir_id);
899             visitor.visit_ty(ty);
900             visitor.visit_nested_body(body);
901         }
902         ImplItemKind::Method(ref sig, body_id) => {
903             visitor.visit_fn(FnKind::Method(impl_item.ident,
904                                             sig,
905                                             Some(&impl_item.vis),
906                                             &impl_item.attrs),
907                              &sig.decl,
908                              body_id,
909                              impl_item.span,
910                              impl_item.hir_id);
911         }
912         ImplItemKind::Type(ref ty) => {
913             visitor.visit_id(impl_item.hir_id);
914             visitor.visit_ty(ty);
915         }
916         ImplItemKind::Existential(ref bounds) => {
917             visitor.visit_id(impl_item.hir_id);
918             walk_list!(visitor, visit_param_bound, bounds);
919         }
920     }
921 }
922
923 pub fn walk_impl_item_ref<'v, V: Visitor<'v>>(visitor: &mut V, impl_item_ref: &'v ImplItemRef) {
924     // N.B., deliberately force a compilation error if/when new fields are added.
925     let ImplItemRef { id, ident, ref kind, span: _, ref vis, ref defaultness } = *impl_item_ref;
926     visitor.visit_nested_impl_item(id);
927     visitor.visit_ident(ident);
928     visitor.visit_associated_item_kind(kind);
929     visitor.visit_vis(vis);
930     visitor.visit_defaultness(defaultness);
931 }
932
933
934 pub fn walk_struct_def<'v, V: Visitor<'v>>(visitor: &mut V, struct_definition: &'v VariantData) {
935     visitor.visit_id(struct_definition.hir_id());
936     walk_list!(visitor, visit_struct_field, struct_definition.fields());
937 }
938
939 pub fn walk_struct_field<'v, V: Visitor<'v>>(visitor: &mut V, struct_field: &'v StructField) {
940     visitor.visit_id(struct_field.hir_id);
941     visitor.visit_vis(&struct_field.vis);
942     visitor.visit_ident(struct_field.ident);
943     visitor.visit_ty(&struct_field.ty);
944     walk_list!(visitor, visit_attribute, &struct_field.attrs);
945 }
946
947 pub fn walk_block<'v, V: Visitor<'v>>(visitor: &mut V, block: &'v Block) {
948     visitor.visit_id(block.hir_id);
949     walk_list!(visitor, visit_stmt, &block.stmts);
950     walk_list!(visitor, visit_expr, &block.expr);
951 }
952
953 pub fn walk_stmt<'v, V: Visitor<'v>>(visitor: &mut V, statement: &'v Stmt) {
954     visitor.visit_id(statement.hir_id);
955     match statement.node {
956         StmtKind::Local(ref local) => visitor.visit_local(local),
957         StmtKind::Item(item) => visitor.visit_nested_item(item),
958         StmtKind::Expr(ref expression) |
959         StmtKind::Semi(ref expression) => {
960             visitor.visit_expr(expression)
961         }
962     }
963 }
964
965 pub fn walk_anon_const<'v, V: Visitor<'v>>(visitor: &mut V, constant: &'v AnonConst) {
966     visitor.visit_id(constant.hir_id);
967     visitor.visit_nested_body(constant.body);
968 }
969
970 pub fn walk_expr<'v, V: Visitor<'v>>(visitor: &mut V, expression: &'v Expr) {
971     visitor.visit_id(expression.hir_id);
972     walk_list!(visitor, visit_attribute, expression.attrs.iter());
973     match expression.node {
974         ExprKind::Box(ref subexpression) => {
975             visitor.visit_expr(subexpression)
976         }
977         ExprKind::Array(ref subexpressions) => {
978             walk_list!(visitor, visit_expr, subexpressions);
979         }
980         ExprKind::Repeat(ref element, ref count) => {
981             visitor.visit_expr(element);
982             visitor.visit_anon_const(count)
983         }
984         ExprKind::Struct(ref qpath, ref fields, ref optional_base) => {
985             visitor.visit_qpath(qpath, expression.hir_id, expression.span);
986             for field in fields {
987                 visitor.visit_id(field.hir_id);
988                 visitor.visit_ident(field.ident);
989                 visitor.visit_expr(&field.expr)
990             }
991             walk_list!(visitor, visit_expr, optional_base);
992         }
993         ExprKind::Tup(ref subexpressions) => {
994             walk_list!(visitor, visit_expr, subexpressions);
995         }
996         ExprKind::Call(ref callee_expression, ref arguments) => {
997             visitor.visit_expr(callee_expression);
998             walk_list!(visitor, visit_expr, arguments);
999         }
1000         ExprKind::MethodCall(ref segment, _, ref arguments) => {
1001             visitor.visit_path_segment(expression.span, segment);
1002             walk_list!(visitor, visit_expr, arguments);
1003         }
1004         ExprKind::Binary(_, ref left_expression, ref right_expression) => {
1005             visitor.visit_expr(left_expression);
1006             visitor.visit_expr(right_expression)
1007         }
1008         ExprKind::AddrOf(_, ref subexpression) | ExprKind::Unary(_, ref subexpression) => {
1009             visitor.visit_expr(subexpression)
1010         }
1011         ExprKind::Lit(_) => {}
1012         ExprKind::Cast(ref subexpression, ref typ) | ExprKind::Type(ref subexpression, ref typ) => {
1013             visitor.visit_expr(subexpression);
1014             visitor.visit_ty(typ)
1015         }
1016         ExprKind::If(ref head_expression, ref if_block, ref optional_else) => {
1017             visitor.visit_expr(head_expression);
1018             visitor.visit_expr(if_block);
1019             walk_list!(visitor, visit_expr, optional_else);
1020         }
1021         ExprKind::While(ref subexpression, ref block, ref opt_label) => {
1022             walk_list!(visitor, visit_label, opt_label);
1023             visitor.visit_expr(subexpression);
1024             visitor.visit_block(block);
1025         }
1026         ExprKind::Loop(ref block, ref opt_label, _) => {
1027             walk_list!(visitor, visit_label, opt_label);
1028             visitor.visit_block(block);
1029         }
1030         ExprKind::Match(ref subexpression, ref arms, _) => {
1031             visitor.visit_expr(subexpression);
1032             walk_list!(visitor, visit_arm, arms);
1033         }
1034         ExprKind::Closure(_, ref function_declaration, body, _fn_decl_span, _gen) => {
1035             visitor.visit_fn(FnKind::Closure(&expression.attrs),
1036                              function_declaration,
1037                              body,
1038                              expression.span,
1039                              expression.hir_id)
1040         }
1041         ExprKind::Block(ref block, ref opt_label) => {
1042             walk_list!(visitor, visit_label, opt_label);
1043             visitor.visit_block(block);
1044         }
1045         ExprKind::Assign(ref left_hand_expression, ref right_hand_expression) => {
1046             visitor.visit_expr(right_hand_expression);
1047             visitor.visit_expr(left_hand_expression)
1048         }
1049         ExprKind::AssignOp(_, ref left_expression, ref right_expression) => {
1050             visitor.visit_expr(right_expression);
1051             visitor.visit_expr(left_expression)
1052         }
1053         ExprKind::Field(ref subexpression, ident) => {
1054             visitor.visit_expr(subexpression);
1055             visitor.visit_ident(ident);
1056         }
1057         ExprKind::Index(ref main_expression, ref index_expression) => {
1058             visitor.visit_expr(main_expression);
1059             visitor.visit_expr(index_expression)
1060         }
1061         ExprKind::Path(ref qpath) => {
1062             visitor.visit_qpath(qpath, expression.hir_id, expression.span);
1063         }
1064         ExprKind::Break(ref destination, ref opt_expr) => {
1065             if let Some(ref label) = destination.label {
1066                 visitor.visit_label(label);
1067                 if let Ok(node_id) = destination.target_id {
1068                     visitor.visit_def_mention(Def::Label(node_id))
1069                 }
1070             }
1071             walk_list!(visitor, visit_expr, opt_expr);
1072         }
1073         ExprKind::Continue(ref destination) => {
1074             if let Some(ref label) = destination.label {
1075                 visitor.visit_label(label);
1076                 if let Ok(node_id) = destination.target_id {
1077                     visitor.visit_def_mention(Def::Label(node_id))
1078                 }
1079             }
1080         }
1081         ExprKind::Ret(ref optional_expression) => {
1082             walk_list!(visitor, visit_expr, optional_expression);
1083         }
1084         ExprKind::InlineAsm(_, ref outputs, ref inputs) => {
1085             for expr in outputs.iter().chain(inputs.iter()) {
1086                 visitor.visit_expr(expr)
1087             }
1088         }
1089         ExprKind::Yield(ref subexpression) => {
1090             visitor.visit_expr(subexpression);
1091         }
1092         ExprKind::Err => {}
1093     }
1094 }
1095
1096 pub fn walk_arm<'v, V: Visitor<'v>>(visitor: &mut V, arm: &'v Arm) {
1097     walk_list!(visitor, visit_pat, &arm.pats);
1098     if let Some(ref g) = arm.guard {
1099         match g {
1100             Guard::If(ref e) => visitor.visit_expr(e),
1101         }
1102     }
1103     visitor.visit_expr(&arm.body);
1104     walk_list!(visitor, visit_attribute, &arm.attrs);
1105 }
1106
1107 pub fn walk_vis<'v, V: Visitor<'v>>(visitor: &mut V, vis: &'v Visibility) {
1108     if let VisibilityKind::Restricted { ref path, hir_id } = vis.node {
1109         visitor.visit_id(hir_id);
1110         visitor.visit_path(path, hir_id)
1111     }
1112 }
1113
1114 pub fn walk_associated_item_kind<'v, V: Visitor<'v>>(_: &mut V, _: &'v AssociatedItemKind) {
1115     // No visitable content here: this fn exists so you can call it if
1116     // the right thing to do, should content be added in the future,
1117     // would be to walk it.
1118 }
1119
1120 pub fn walk_defaultness<'v, V: Visitor<'v>>(_: &mut V, _: &'v Defaultness) {
1121     // No visitable content here: this fn exists so you can call it if
1122     // the right thing to do, should content be added in the future,
1123     // would be to walk it.
1124 }