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