src/libsyntax/mut_visit.rs

   1 //! A MutVisitor represents an AST modification; it accepts an AST piece and
   2 //! and mutates it in place. So, for instance, macro expansion is a MutVisitor
   3 //! that walks over an AST and modifies it.
   4 //!
   5 //! Note: using a MutVisitor (other than the MacroExpander MutVisitor) on
   6 //! an AST before macro expansion is probably a bad idea. For instance,
   7 //! a MutVisitor renaming item names in a module will miss all of those
   8 //! that are created by the expansion of a macro.
   9
  10 use crate::ast::*;
  11 use crate::source_map::{Spanned, respan};
  12 use crate::parse::token::{self, Token};
  13 use crate::ptr::P;
  14 use crate::ThinVec;
  15 use crate::tokenstream::*;
  16 use crate::util::map_in_place::MapInPlace;
  17
  18 use smallvec::{smallvec, Array, SmallVec};
  19 use syntax_pos::Span;
  20
  21 use rustc_data_structures::sync::Lrc;
  22 use std::ops::DerefMut;
  23 use std::{panic, process, ptr};
  24
  25 pub trait ExpectOne<A: Array> {
  26     fn expect_one(self, err: &'static str) -> A::Item;
  27 }
  28
  29 impl<A: Array> ExpectOne<A> for SmallVec<A> {
  30     fn expect_one(self, err: &'static str) -> A::Item {
  31         assert!(self.len() == 1, err);
  32         self.into_iter().next().unwrap()
  33     }
  34 }
  35
  36 pub trait MutVisitor: Sized {
  37     // Methods in this trait have one of three forms:
  38     //
  39     //   fn visit_t(&mut self, t: &mut T);                      // common
  40     //   fn flat_map_t(&mut self, t: T) -> SmallVec<[T; 1]>;    // rare
  41     //   fn filter_map_t(&mut self, t: T) -> Option<T>;         // rarest
  42     //
  43     // Any additions to this trait should happen in form of a call to a public
  44     // `noop_*` function that only calls out to the visitor again, not other
  45     // `noop_*` functions. This is a necessary API workaround to the problem of
  46     // not being able to call out to the super default method in an overridden
  47     // default method.
  48     //
  49     // When writing these methods, it is better to use destructuring like this:
  50     //
  51     //   fn visit_abc(&mut self, ABC { a, b, c: _ }: &mut ABC) {
  52     //       visit_a(a);
  53     //       visit_b(b);
  54     //   }
  55     //
  56     // than to use field access like this:
  57     //
  58     //   fn visit_abc(&mut self, abc: &mut ABC) {
  59     //       visit_a(&mut abc.a);
  60     //       visit_b(&mut abc.b);
  61     //       // ignore abc.c
  62     //   }
  63     //
  64     // As well as being more concise, the former is explicit about which fields
  65     // are skipped. Furthermore, if a new field is added, the destructuring
  66     // version will cause a compile error, which is good. In comparison, the
  67     // field access version will continue working and it would be easy to
  68     // forget to add handling for it.
  69
  70     fn visit_crate(&mut self, c: &mut Crate) {
  71         noop_visit_crate(c, self)
  72     }
  73
  74     fn visit_meta_list_item(&mut self, list_item: &mut NestedMetaItem) {
  75         noop_visit_meta_list_item(list_item, self);
  76     }
  77
  78     fn visit_meta_item(&mut self, meta_item: &mut MetaItem) {
  79         noop_visit_meta_item(meta_item, self);
  80     }
  81
  82     fn visit_use_tree(&mut self, use_tree: &mut UseTree) {
  83         noop_visit_use_tree(use_tree, self);
  84     }
  85
  86     fn flat_map_foreign_item(&mut self, ni: ForeignItem) -> SmallVec<[ForeignItem; 1]> {
  87         noop_flat_map_foreign_item(ni, self)
  88     }
  89
  90     fn flat_map_item(&mut self, i: P<Item>) -> SmallVec<[P<Item>; 1]> {
  91         noop_flat_map_item(i, self)
  92     }
  93
  94     fn visit_fn_header(&mut self, header: &mut FnHeader) {
  95         noop_visit_fn_header(header, self);
  96     }
  97
  98     fn visit_struct_field(&mut self, sf: &mut StructField) {
  99         noop_visit_struct_field(sf, self);
 100     }
 101
 102     fn visit_item_kind(&mut self, i: &mut ItemKind) {
 103         noop_visit_item_kind(i, self);
 104     }
 105
 106     fn flat_map_trait_item(&mut self, i: TraitItem) -> SmallVec<[TraitItem; 1]> {
 107         noop_flat_map_trait_item(i, self)
 108     }
 109
 110     fn flat_map_impl_item(&mut self, i: ImplItem) -> SmallVec<[ImplItem; 1]> {
 111         noop_flat_map_impl_item(i, self)
 112     }
 113
 114     fn visit_fn_decl(&mut self, d: &mut P<FnDecl>) {
 115         noop_visit_fn_decl(d, self);
 116     }
 117
 118     fn visit_asyncness(&mut self, a: &mut IsAsync) {
 119         noop_visit_asyncness(a, self);
 120     }
 121
 122     fn visit_block(&mut self, b: &mut P<Block>) {
 123         noop_visit_block(b, self);
 124     }
 125
 126     fn flat_map_stmt(&mut self, s: Stmt) -> SmallVec<[Stmt; 1]> {
 127         noop_flat_map_stmt(s, self)
 128     }
 129
 130     fn visit_arm(&mut self, a: &mut Arm) {
 131         noop_visit_arm(a, self);
 132     }
 133
 134     fn visit_guard(&mut self, g: &mut Guard) {
 135         noop_visit_guard(g, self);
 136     }
 137
 138     fn visit_pat(&mut self, p: &mut P<Pat>) {
 139         noop_visit_pat(p, self);
 140     }
 141
 142     fn visit_anon_const(&mut self, c: &mut AnonConst) {
 143         noop_visit_anon_const(c, self);
 144     }
 145
 146     fn visit_expr(&mut self, e: &mut P<Expr>) {
 147         noop_visit_expr(e, self);
 148     }
 149
 150     fn filter_map_expr(&mut self, e: P<Expr>) -> Option<P<Expr>> {
 151         noop_filter_map_expr(e, self)
 152     }
 153
 154     fn visit_generic_arg(&mut self, arg: &mut GenericArg) {
 155         noop_visit_generic_arg(arg, self);
 156     }
 157
 158     fn visit_ty(&mut self, t: &mut P<Ty>) {
 159         noop_visit_ty(t, self);
 160     }
 161
 162     fn visit_lifetime(&mut self, l: &mut Lifetime) {
 163         noop_visit_lifetime(l, self);
 164     }
 165
 166     fn visit_ty_constraint(&mut self, t: &mut AssocTyConstraint) {
 167         noop_visit_ty_constraint(t, self);
 168     }
 169
 170     fn visit_mod(&mut self, m: &mut Mod) {
 171         noop_visit_mod(m, self);
 172     }
 173
 174     fn visit_foreign_mod(&mut self, nm: &mut ForeignMod) {
 175         noop_visit_foreign_mod(nm, self);
 176     }
 177
 178     fn visit_variant(&mut self, v: &mut Variant) {
 179         noop_visit_variant(v, self);
 180     }
 181
 182     fn visit_ident(&mut self, i: &mut Ident) {
 183         noop_visit_ident(i, self);
 184     }
 185
 186     fn visit_path(&mut self, p: &mut Path) {
 187         noop_visit_path(p, self);
 188     }
 189
 190     fn visit_qself(&mut self, qs: &mut Option<QSelf>) {
 191         noop_visit_qself(qs, self);
 192     }
 193
 194     fn visit_generic_args(&mut self, p: &mut GenericArgs) {
 195         noop_visit_generic_args(p, self);
 196     }
 197
 198     fn visit_angle_bracketed_parameter_data(&mut self, p: &mut AngleBracketedArgs) {
 199         noop_visit_angle_bracketed_parameter_data(p, self);
 200     }
 201
 202     fn visit_parenthesized_parameter_data(&mut self, p: &mut ParenthesizedArgs) {
 203         noop_visit_parenthesized_parameter_data(p, self);
 204     }
 205
 206     fn visit_local(&mut self, l: &mut P<Local>) {
 207         noop_visit_local(l, self);
 208     }
 209
 210     fn visit_mac(&mut self, _mac: &mut Mac) {
 211         panic!("visit_mac disabled by default");
 212         // N.B., see note about macros above. If you really want a visitor that
 213         // works on macros, use this definition in your trait impl:
 214         //   mut_visit::noop_visit_mac(_mac, self);
 215     }
 216
 217     fn visit_macro_def(&mut self, def: &mut MacroDef) {
 218         noop_visit_macro_def(def, self);
 219     }
 220
 221     fn visit_label(&mut self, label: &mut Label) {
 222         noop_visit_label(label, self);
 223     }
 224
 225     fn visit_attribute(&mut self, at: &mut Attribute) {
 226         noop_visit_attribute(at, self);
 227     }
 228
 229     fn visit_arg(&mut self, a: &mut Arg) {
 230         noop_visit_arg(a, self);
 231     }
 232
 233     fn visit_generics(&mut self, generics: &mut Generics) {
 234         noop_visit_generics(generics, self);
 235     }
 236
 237     fn visit_trait_ref(&mut self, tr: &mut TraitRef) {
 238         noop_visit_trait_ref(tr, self);
 239     }
 240
 241     fn visit_poly_trait_ref(&mut self, p: &mut PolyTraitRef) {
 242         noop_visit_poly_trait_ref(p, self);
 243     }
 244
 245     fn visit_variant_data(&mut self, vdata: &mut VariantData) {
 246         noop_visit_variant_data(vdata, self);
 247     }
 248
 249     fn visit_generic_param(&mut self, param: &mut GenericParam) {
 250         noop_visit_generic_param(param, self);
 251     }
 252
 253     fn visit_generic_params(&mut self, params: &mut Vec<GenericParam>) {
 254         noop_visit_generic_params(params, self);
 255     }
 256
 257     fn visit_tt(&mut self, tt: &mut TokenTree) {
 258         noop_visit_tt(tt, self);
 259     }
 260
 261     fn visit_tts(&mut self, tts: &mut TokenStream) {
 262         noop_visit_tts(tts, self);
 263     }
 264
 265     fn visit_token(&mut self, t: &mut Token) {
 266         noop_visit_token(t, self);
 267     }
 268
 269     fn visit_interpolated(&mut self, nt: &mut token::Nonterminal) {
 270         noop_visit_interpolated(nt, self);
 271     }
 272
 273     fn visit_param_bound(&mut self, tpb: &mut GenericBound) {
 274         noop_visit_param_bound(tpb, self);
 275     }
 276
 277     fn visit_mt(&mut self, mt: &mut MutTy) {
 278         noop_visit_mt(mt, self);
 279     }
 280
 281     fn visit_field(&mut self, field: &mut Field) {
 282         noop_visit_field(field, self);
 283     }
 284
 285     fn visit_where_clause(&mut self, where_clause: &mut WhereClause) {
 286         noop_visit_where_clause(where_clause, self);
 287     }
 288
 289     fn visit_where_predicate(&mut self, where_predicate: &mut WherePredicate) {
 290         noop_visit_where_predicate(where_predicate, self);
 291     }
 292
 293     fn visit_vis(&mut self, vis: &mut Visibility) {
 294         noop_visit_vis(vis, self);
 295     }
 296
 297     fn visit_id(&mut self, _id: &mut NodeId) {
 298         // Do nothing.
 299     }
 300
 301     fn visit_span(&mut self, _sp: &mut Span) {
 302         // Do nothing.
 303     }
 304 }
 305
 306 /// Use a map-style function (`FnOnce(T) -> T`) to overwrite a `&mut T`. Useful
 307 /// when using a `flat_map_*` or `filter_map_*` method within a `visit_`
 308 /// method. Abort the program if the closure panics.
 309 //
 310 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 311 pub fn visit_clobber<T, F>(t: &mut T, f: F) where F: FnOnce(T) -> T {
 312     unsafe {
 313         // Safe because `t` is used in a read-only fashion by `read()` before
 314         // being overwritten by `write()`.
 315         let old_t = ptr::read(t);
 316         let new_t = panic::catch_unwind(panic::AssertUnwindSafe(|| f(old_t)))
 317             .unwrap_or_else(|_| process::abort());
 318         ptr::write(t, new_t);
 319     }
 320 }
 321
 322 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 323 #[inline]
 324 pub fn visit_vec<T, F>(elems: &mut Vec<T>, mut visit_elem: F) where F: FnMut(&mut T) {
 325     for elem in elems {
 326         visit_elem(elem);
 327     }
 328 }
 329
 330 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 331 #[inline]
 332 pub fn visit_opt<T, F>(opt: &mut Option<T>, mut visit_elem: F) where F: FnMut(&mut T) {
 333     if let Some(elem) = opt {
 334         visit_elem(elem);
 335     }
 336 }
 337
 338 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 339 pub fn visit_attrs<T: MutVisitor>(attrs: &mut Vec<Attribute>, vis: &mut T) {
 340     visit_vec(attrs, |attr| vis.visit_attribute(attr));
 341 }
 342
 343 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 344 pub fn visit_thin_attrs<T: MutVisitor>(attrs: &mut ThinVec<Attribute>, vis: &mut T) {
 345     for attr in attrs.iter_mut() {
 346         vis.visit_attribute(attr);
 347     }
 348 }
 349
 350 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 351 pub fn visit_exprs<T: MutVisitor>(exprs: &mut Vec<P<Expr>>, vis: &mut T) {
 352     exprs.flat_map_in_place(|expr| vis.filter_map_expr(expr))
 353 }
 354
 355 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 356 pub fn visit_bounds<T: MutVisitor>(bounds: &mut GenericBounds, vis: &mut T) {
 357     visit_vec(bounds, |bound| vis.visit_param_bound(bound));
 358 }
 359
 360 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 361 pub fn visit_method_sig<T: MutVisitor>(MethodSig { header, decl }: &mut MethodSig, vis: &mut T) {
 362     vis.visit_fn_header(header);
 363     vis.visit_fn_decl(decl);
 364 }
 365
 366 pub fn noop_visit_use_tree<T: MutVisitor>(use_tree: &mut UseTree, vis: &mut T) {
 367     let UseTree { prefix, kind, span } = use_tree;
 368     vis.visit_path(prefix);
 369     match kind {
 370         UseTreeKind::Simple(rename, id1, id2) => {
 371             visit_opt(rename, |rename| vis.visit_ident(rename));
 372             vis.visit_id(id1);
 373             vis.visit_id(id2);
 374         }
 375         UseTreeKind::Nested(items) => {
 376             for (tree, id) in items {
 377                 vis.visit_use_tree(tree);
 378                 vis.visit_id(id);
 379             }
 380         }
 381         UseTreeKind::Glob => {}
 382     }
 383     vis.visit_span(span);
 384 }
 385
 386 pub fn noop_visit_arm<T: MutVisitor>(
 387     Arm { attrs, pats, guard, body, span }: &mut Arm,
 388     vis: &mut T,
 389 ) {
 390     visit_attrs(attrs, vis);
 391     visit_vec(pats, |pat| vis.visit_pat(pat));
 392     visit_opt(guard, |guard| vis.visit_guard(guard));
 393     vis.visit_expr(body);
 394     vis.visit_span(span);
 395 }
 396
 397 pub fn noop_visit_guard<T: MutVisitor>(g: &mut Guard, vis: &mut T) {
 398     match g {
 399         Guard::If(e) => vis.visit_expr(e),
 400     }
 401 }
 402
 403 pub fn noop_visit_ty_constraint<T: MutVisitor>(
 404     AssocTyConstraint { id, ident, kind, span }: &mut AssocTyConstraint,
 405     vis: &mut T
 406 ) {
 407     vis.visit_id(id);
 408     vis.visit_ident(ident);
 409     match kind {
 410         AssocTyConstraintKind::Equality { ref mut ty } => {
 411             vis.visit_ty(ty);
 412         }
 413         AssocTyConstraintKind::Bound { ref mut bounds } => {
 414             visit_bounds(bounds, vis);
 415         }
 416     }
 417     vis.visit_span(span);
 418 }
 419
 420 pub fn noop_visit_ty<T: MutVisitor>(ty: &mut P<Ty>, vis: &mut T) {
 421     let Ty { id, node, span } = ty.deref_mut();
 422     vis.visit_id(id);
 423     match node {
 424         TyKind::Infer | TyKind::ImplicitSelf | TyKind::Err |
 425             TyKind::Never | TyKind::CVarArgs => {}
 426         TyKind::Slice(ty) => vis.visit_ty(ty),
 427         TyKind::Ptr(mt) => vis.visit_mt(mt),
 428         TyKind::Rptr(lt, mt) => {
 429             visit_opt(lt, |lt| noop_visit_lifetime(lt, vis));
 430             vis.visit_mt(mt);
 431         }
 432         TyKind::BareFn(bft) => {
 433             let BareFnTy { unsafety: _, abi: _, generic_params, decl } = bft.deref_mut();
 434             vis.visit_generic_params(generic_params);
 435             vis.visit_fn_decl(decl);
 436         }
 437         TyKind::Tup(tys) => visit_vec(tys, |ty| vis.visit_ty(ty)),
 438         TyKind::Paren(ty) => vis.visit_ty(ty),
 439         TyKind::Path(qself, path) => {
 440             vis.visit_qself(qself);
 441             vis.visit_path(path);
 442         }
 443         TyKind::Array(ty, length) => {
 444             vis.visit_ty(ty);
 445             vis.visit_anon_const(length);
 446         }
 447         TyKind::Typeof(expr) => vis.visit_anon_const(expr),
 448         TyKind::TraitObject(bounds, _syntax) =>
 449             visit_vec(bounds, |bound| vis.visit_param_bound(bound)),
 450         TyKind::ImplTrait(id, bounds) => {
 451             vis.visit_id(id);
 452             visit_vec(bounds, |bound| vis.visit_param_bound(bound));
 453         }
 454         TyKind::Mac(mac) => vis.visit_mac(mac),
 455     }
 456     vis.visit_span(span);
 457 }
 458
 459 pub fn noop_visit_foreign_mod<T: MutVisitor>(foreign_mod: &mut ForeignMod, vis: &mut T) {
 460     let ForeignMod { abi: _, items} = foreign_mod;
 461     items.flat_map_in_place(|item| vis.flat_map_foreign_item(item));
 462 }
 463
 464 pub fn noop_visit_variant<T: MutVisitor>(variant: &mut Variant, vis: &mut T) {
 465     let Spanned { node: Variant_ { ident, attrs, id, data, disr_expr }, span } = variant;
 466     vis.visit_ident(ident);
 467     visit_attrs(attrs, vis);
 468     vis.visit_id(id);
 469     vis.visit_variant_data(data);
 470     visit_opt(disr_expr, |disr_expr| vis.visit_anon_const(disr_expr));
 471     vis.visit_span(span);
 472 }
 473
 474 pub fn noop_visit_ident<T: MutVisitor>(Ident { name: _, span }: &mut Ident, vis: &mut T) {
 475     vis.visit_span(span);
 476 }
 477
 478 pub fn noop_visit_path<T: MutVisitor>(Path { segments, span }: &mut Path, vis: &mut T) {
 479     vis.visit_span(span);
 480     for PathSegment { ident, id, args } in segments {
 481         vis.visit_ident(ident);
 482         vis.visit_id(id);
 483         visit_opt(args, |args| vis.visit_generic_args(args));
 484     }
 485 }
 486
 487 pub fn noop_visit_qself<T: MutVisitor>(qself: &mut Option<QSelf>, vis: &mut T) {
 488     visit_opt(qself, |QSelf { ty, path_span, position: _ }| {
 489         vis.visit_ty(ty);
 490         vis.visit_span(path_span);
 491     })
 492 }
 493
 494 pub fn noop_visit_generic_args<T: MutVisitor>(generic_args: &mut GenericArgs, vis: &mut T) {
 495     match generic_args {
 496         GenericArgs::AngleBracketed(data) => vis.visit_angle_bracketed_parameter_data(data),
 497         GenericArgs::Parenthesized(data) => vis.visit_parenthesized_parameter_data(data),
 498     }
 499 }
 500
 501 pub fn noop_visit_generic_arg<T: MutVisitor>(arg: &mut GenericArg, vis: &mut T) {
 502     match arg {
 503         GenericArg::Lifetime(lt) => vis.visit_lifetime(lt),
 504         GenericArg::Type(ty) => vis.visit_ty(ty),
 505         GenericArg::Const(ct) => vis.visit_anon_const(ct),
 506     }
 507 }
 508
 509 pub fn noop_visit_angle_bracketed_parameter_data<T: MutVisitor>(data: &mut AngleBracketedArgs,
 510                                                                 vis: &mut T) {
 511     let AngleBracketedArgs { args, constraints, span } = data;
 512     visit_vec(args, |arg| vis.visit_generic_arg(arg));
 513     visit_vec(constraints, |constraint| vis.visit_ty_constraint(constraint));
 514     vis.visit_span(span);
 515 }
 516
 517 pub fn noop_visit_parenthesized_parameter_data<T: MutVisitor>(args: &mut ParenthesizedArgs,
 518                                                               vis: &mut T) {
 519     let ParenthesizedArgs { inputs, output, span } = args;
 520     visit_vec(inputs, |input| vis.visit_ty(input));
 521     visit_opt(output, |output| vis.visit_ty(output));
 522     vis.visit_span(span);
 523 }
 524
 525 pub fn noop_visit_local<T: MutVisitor>(local: &mut P<Local>, vis: &mut T) {
 526     let Local { id, pat, ty, init, span, attrs } = local.deref_mut();
 527     vis.visit_id(id);
 528     vis.visit_pat(pat);
 529     visit_opt(ty, |ty| vis.visit_ty(ty));
 530     visit_opt(init, |init| vis.visit_expr(init));
 531     vis.visit_span(span);
 532     visit_thin_attrs(attrs, vis);
 533 }
 534
 535 pub fn noop_visit_attribute<T: MutVisitor>(attr: &mut Attribute, vis: &mut T) {
 536     let Attribute { id: _, style: _, path, tokens, is_sugared_doc: _, span } = attr;
 537     vis.visit_path(path);
 538     vis.visit_tts(tokens);
 539     vis.visit_span(span);
 540 }
 541
 542 pub fn noop_visit_mac<T: MutVisitor>(Spanned { node, span }: &mut Mac, vis: &mut T) {
 543     let Mac_ { path, delim: _, tts } = node;
 544     vis.visit_path(path);
 545     vis.visit_tts(tts);
 546     vis.visit_span(span);
 547 }
 548
 549 pub fn noop_visit_macro_def<T: MutVisitor>(macro_def: &mut MacroDef, vis: &mut T) {
 550     let MacroDef { tokens, legacy: _ } = macro_def;
 551     vis.visit_tts(tokens);
 552 }
 553
 554 pub fn noop_visit_meta_list_item<T: MutVisitor>(li: &mut NestedMetaItem, vis: &mut T) {
 555     match li {
 556         NestedMetaItem::MetaItem(mi) => vis.visit_meta_item(mi),
 557         NestedMetaItem::Literal(_lit) => {}
 558     }
 559 }
 560
 561 pub fn noop_visit_meta_item<T: MutVisitor>(mi: &mut MetaItem, vis: &mut T) {
 562     let MetaItem { path: _, node, span } = mi;
 563     match node {
 564         MetaItemKind::Word => {}
 565         MetaItemKind::List(mis) => visit_vec(mis, |mi| vis.visit_meta_list_item(mi)),
 566         MetaItemKind::NameValue(_s) => {}
 567     }
 568     vis.visit_span(span);
 569 }
 570
 571 pub fn noop_visit_arg<T: MutVisitor>(Arg { id, pat, ty }: &mut Arg, vis: &mut T) {
 572     vis.visit_id(id);
 573     vis.visit_pat(pat);
 574     vis.visit_ty(ty);
 575 }
 576
 577 pub fn noop_visit_tt<T: MutVisitor>(tt: &mut TokenTree, vis: &mut T) {
 578     match tt {
 579         TokenTree::Token(token) => {
 580             vis.visit_token(token);
 581         }
 582         TokenTree::Delimited(DelimSpan { open, close }, _delim, tts) => {
 583             vis.visit_span(open);
 584             vis.visit_span(close);
 585             vis.visit_tts(tts);
 586         }
 587     }
 588 }
 589
 590 pub fn noop_visit_tts<T: MutVisitor>(TokenStream(tts): &mut TokenStream, vis: &mut T) {
 591     visit_opt(tts, |tts| {
 592         let tts = Lrc::make_mut(tts);
 593         visit_vec(tts, |(tree, _is_joint)| vis.visit_tt(tree));
 594     })
 595 }
 596
 597 // Apply ident visitor if it's an ident, apply other visits to interpolated nodes.
 598 // In practice the ident part is not actually used by specific visitors right now,
 599 // but there's a test below checking that it works.
 600 pub fn noop_visit_token<T: MutVisitor>(t: &mut Token, vis: &mut T) {
 601     let Token { kind, span } = t;
 602     match kind {
 603         token::Ident(name, _) | token::Lifetime(name) => {
 604             let mut ident = Ident::new(*name, *span);
 605             vis.visit_ident(&mut ident);
 606             *name = ident.name;
 607         }
 608         token::Interpolated(nt) => {
 609             let mut nt = Lrc::make_mut(nt);
 610             vis.visit_interpolated(&mut nt);
 611         }
 612         _ => {}
 613     }
 614     vis.visit_span(span);
 615 }
 616
 617 /// Apply visitor to elements of interpolated nodes.
 618 //
 619 // N.B., this can occur only when applying a visitor to partially expanded
 620 // code, where parsed pieces have gotten implanted ito *other* macro
 621 // invocations. This is relevant for macro hygiene, but possibly not elsewhere.
 622 //
 623 // One problem here occurs because the types for flat_map_item, flat_map_stmt,
 624 // etc. allow the visitor to return *multiple* items; this is a problem for the
 625 // nodes here, because they insist on having exactly one piece. One solution
 626 // would be to mangle the MutVisitor trait to include one-to-many and
 627 // one-to-one versions of these entry points, but that would probably confuse a
 628 // lot of people and help very few. Instead, I'm just going to put in dynamic
 629 // checks. I think the performance impact of this will be pretty much
 630 // nonexistent. The danger is that someone will apply a MutVisitor to a
 631 // partially expanded node, and will be confused by the fact that their
 632 // "flat_map_item" or "flat_map_stmt" isn't getting called on NtItem or NtStmt
 633 // nodes. Hopefully they'll wind up reading this comment, and doing something
 634 // appropriate.
 635 //
 636 // BTW, design choice: I considered just changing the type of, e.g., NtItem to
 637 // contain multiple items, but decided against it when I looked at
 638 // parse_item_or_view_item and tried to figure out what I would do with
 639 // multiple items there....
 640 pub fn noop_visit_interpolated<T: MutVisitor>(nt: &mut token::Nonterminal, vis: &mut T) {
 641     match nt {
 642         token::NtItem(item) =>
 643             visit_clobber(item, |item| {
 644                 // This is probably okay, because the only visitors likely to
 645                 // peek inside interpolated nodes will be renamings/markings,
 646                 // which map single items to single items.
 647                 vis.flat_map_item(item).expect_one("expected visitor to produce exactly one item")
 648             }),
 649         token::NtBlock(block) => vis.visit_block(block),
 650         token::NtStmt(stmt) =>
 651             visit_clobber(stmt, |stmt| {
 652                 // See reasoning above.
 653                 vis.flat_map_stmt(stmt).expect_one("expected visitor to produce exactly one item")
 654             }),
 655         token::NtPat(pat) => vis.visit_pat(pat),
 656         token::NtExpr(expr) => vis.visit_expr(expr),
 657         token::NtTy(ty) => vis.visit_ty(ty),
 658         token::NtIdent(ident, _is_raw) => vis.visit_ident(ident),
 659         token::NtLifetime(ident) => vis.visit_ident(ident),
 660         token::NtLiteral(expr) => vis.visit_expr(expr),
 661         token::NtMeta(meta) => vis.visit_meta_item(meta),
 662         token::NtPath(path) => vis.visit_path(path),
 663         token::NtTT(tt) => vis.visit_tt(tt),
 664         token::NtImplItem(item) =>
 665             visit_clobber(item, |item| {
 666                 // See reasoning above.
 667                 vis.flat_map_impl_item(item)
 668                     .expect_one("expected visitor to produce exactly one item")
 669             }),
 670         token::NtTraitItem(item) =>
 671             visit_clobber(item, |item| {
 672                 // See reasoning above.
 673                 vis.flat_map_trait_item(item)
 674                     .expect_one("expected visitor to produce exactly one item")
 675             }),
 676         token::NtVis(visib) => vis.visit_vis(visib),
 677         token::NtForeignItem(item) =>
 678             visit_clobber(item, |item| {
 679                 // See reasoning above.
 680                 vis.flat_map_foreign_item(item)
 681                     .expect_one("expected visitor to produce exactly one item")
 682             }),
 683     }
 684 }
 685
 686 pub fn noop_visit_asyncness<T: MutVisitor>(asyncness: &mut IsAsync, vis: &mut T) {
 687     match asyncness {
 688         IsAsync::Async { closure_id, return_impl_trait_id } => {
 689             vis.visit_id(closure_id);
 690             vis.visit_id(return_impl_trait_id);
 691         }
 692         IsAsync::NotAsync => {}
 693     }
 694 }
 695
 696 pub fn noop_visit_fn_decl<T: MutVisitor>(decl: &mut P<FnDecl>, vis: &mut T) {
 697     let FnDecl { inputs, output, c_variadic: _ } = decl.deref_mut();
 698     visit_vec(inputs, |input| vis.visit_arg(input));
 699     match output {
 700         FunctionRetTy::Default(span) => vis.visit_span(span),
 701         FunctionRetTy::Ty(ty) => vis.visit_ty(ty),
 702     }
 703 }
 704
 705 pub fn noop_visit_param_bound<T: MutVisitor>(pb: &mut GenericBound, vis: &mut T) {
 706     match pb {
 707         GenericBound::Trait(ty, _modifier) => vis.visit_poly_trait_ref(ty),
 708         GenericBound::Outlives(lifetime) => noop_visit_lifetime(lifetime, vis),
 709     }
 710 }
 711
 712 pub fn noop_visit_generic_param<T: MutVisitor>(param: &mut GenericParam, vis: &mut T) {
 713     let GenericParam { id, ident, attrs, bounds, kind } = param;
 714     vis.visit_id(id);
 715     vis.visit_ident(ident);
 716     visit_thin_attrs(attrs, vis);
 717     visit_vec(bounds, |bound| noop_visit_param_bound(bound, vis));
 718     match kind {
 719         GenericParamKind::Lifetime => {}
 720         GenericParamKind::Type { default } => {
 721             visit_opt(default, |default| vis.visit_ty(default));
 722         }
 723         GenericParamKind::Const { ty } => {
 724             vis.visit_ty(ty);
 725         }
 726     }
 727 }
 728
 729 pub fn noop_visit_generic_params<T: MutVisitor>(params: &mut Vec<GenericParam>, vis: &mut T){
 730     visit_vec(params, |param| vis.visit_generic_param(param));
 731 }
 732
 733 pub fn noop_visit_label<T: MutVisitor>(Label { ident }: &mut Label, vis: &mut T) {
 734     vis.visit_ident(ident);
 735 }
 736
 737 fn noop_visit_lifetime<T: MutVisitor>(Lifetime { id, ident }: &mut Lifetime, vis: &mut T) {
 738     vis.visit_id(id);
 739     vis.visit_ident(ident);
 740 }
 741
 742 pub fn noop_visit_generics<T: MutVisitor>(generics: &mut Generics, vis: &mut T) {
 743     let Generics { params, where_clause, span } = generics;
 744     vis.visit_generic_params(params);
 745     vis.visit_where_clause(where_clause);
 746     vis.visit_span(span);
 747 }
 748
 749 pub fn noop_visit_where_clause<T: MutVisitor>(wc: &mut WhereClause, vis: &mut T) {
 750     let WhereClause { id, predicates, span } = wc;
 751     vis.visit_id(id);
 752     visit_vec(predicates, |predicate| vis.visit_where_predicate(predicate));
 753     vis.visit_span(span);
 754 }
 755
 756 pub fn noop_visit_where_predicate<T: MutVisitor>(pred: &mut WherePredicate, vis: &mut T) {
 757     match pred {
 758         WherePredicate::BoundPredicate(bp) => {
 759             let WhereBoundPredicate { span, bound_generic_params, bounded_ty, bounds } = bp;
 760             vis.visit_span(span);
 761             vis.visit_generic_params(bound_generic_params);
 762             vis.visit_ty(bounded_ty);
 763             visit_vec(bounds, |bound| vis.visit_param_bound(bound));
 764         }
 765         WherePredicate::RegionPredicate(rp) => {
 766             let WhereRegionPredicate { span, lifetime, bounds } = rp;
 767             vis.visit_span(span);
 768             noop_visit_lifetime(lifetime, vis);
 769             visit_vec(bounds, |bound| noop_visit_param_bound(bound, vis));
 770         }
 771         WherePredicate::EqPredicate(ep) => {
 772             let WhereEqPredicate { id, span, lhs_ty, rhs_ty } = ep;
 773             vis.visit_id(id);
 774             vis.visit_span(span);
 775             vis.visit_ty(lhs_ty);
 776             vis.visit_ty(rhs_ty);
 777         }
 778     }
 779 }
 780
 781 pub fn noop_visit_variant_data<T: MutVisitor>(vdata: &mut VariantData, vis: &mut T) {
 782     match vdata {
 783         VariantData::Struct(fields, ..) => visit_vec(fields, |field| vis.visit_struct_field(field)),
 784         VariantData::Tuple(fields, id) => {
 785             visit_vec(fields, |field| vis.visit_struct_field(field));
 786             vis.visit_id(id);
 787         },
 788         VariantData::Unit(id) => vis.visit_id(id),
 789     }
 790 }
 791
 792 pub fn noop_visit_trait_ref<T: MutVisitor>(TraitRef { path, ref_id }: &mut TraitRef, vis: &mut T) {
 793     vis.visit_path(path);
 794     vis.visit_id(ref_id);
 795 }
 796
 797 pub fn noop_visit_poly_trait_ref<T: MutVisitor>(p: &mut PolyTraitRef, vis: &mut T) {
 798     let PolyTraitRef { bound_generic_params, trait_ref, span } = p;
 799     vis.visit_generic_params(bound_generic_params);
 800     vis.visit_trait_ref(trait_ref);
 801     vis.visit_span(span);
 802 }
 803
 804 pub fn noop_visit_struct_field<T: MutVisitor>(f: &mut StructField, visitor: &mut T) {
 805     let StructField { span, ident, vis, id, ty, attrs } = f;
 806     visitor.visit_span(span);
 807     visit_opt(ident, |ident| visitor.visit_ident(ident));
 808     visitor.visit_vis(vis);
 809     visitor.visit_id(id);
 810     visitor.visit_ty(ty);
 811     visit_attrs(attrs, visitor);
 812 }
 813
 814 pub fn noop_visit_field<T: MutVisitor>(f: &mut Field, vis: &mut T) {
 815     let Field { ident, expr, span, is_shorthand: _, attrs } = f;
 816     vis.visit_ident(ident);
 817     vis.visit_expr(expr);
 818     vis.visit_span(span);
 819     visit_thin_attrs(attrs, vis);
 820 }
 821
 822 pub fn noop_visit_mt<T: MutVisitor>(MutTy { ty, mutbl: _ }: &mut MutTy, vis: &mut T) {
 823     vis.visit_ty(ty);
 824 }
 825
 826 pub fn noop_visit_block<T: MutVisitor>(block: &mut P<Block>, vis: &mut T) {
 827     let Block { id, stmts, rules: _, span } = block.deref_mut();
 828     vis.visit_id(id);
 829     stmts.flat_map_in_place(|stmt| vis.flat_map_stmt(stmt));
 830     vis.visit_span(span);
 831 }
 832
 833 pub fn noop_visit_item_kind<T: MutVisitor>(kind: &mut ItemKind, vis: &mut T) {
 834     match kind {
 835         ItemKind::ExternCrate(_orig_name) => {}
 836         ItemKind::Use(use_tree) => vis.visit_use_tree(use_tree),
 837         ItemKind::Static(ty, _mut, expr) => {
 838             vis.visit_ty(ty);
 839             vis.visit_expr(expr);
 840         }
 841         ItemKind::Const(ty, expr) => {
 842             vis.visit_ty(ty);
 843             vis.visit_expr(expr);
 844         }
 845         ItemKind::Fn(decl, header, generics, body) => {
 846             vis.visit_fn_decl(decl);
 847             vis.visit_fn_header(header);
 848             vis.visit_generics(generics);
 849             vis.visit_block(body);
 850         }
 851         ItemKind::Mod(m) => vis.visit_mod(m),
 852         ItemKind::ForeignMod(nm) => vis.visit_foreign_mod(nm),
 853         ItemKind::GlobalAsm(_ga) => {}
 854         ItemKind::Ty(ty, generics) => {
 855             vis.visit_ty(ty);
 856             vis.visit_generics(generics);
 857         }
 858         ItemKind::Existential(bounds, generics) => {
 859             visit_bounds(bounds, vis);
 860             vis.visit_generics(generics);
 861         }
 862         ItemKind::Enum(EnumDef { variants }, generics) => {
 863             visit_vec(variants, |variant| vis.visit_variant(variant));
 864             vis.visit_generics(generics);
 865         }
 866         ItemKind::Struct(variant_data, generics) |
 867         ItemKind::Union(variant_data, generics) => {
 868             vis.visit_variant_data(variant_data);
 869             vis.visit_generics(generics);
 870         }
 871         ItemKind::Impl(_unsafety, _polarity, _defaultness, generics, trait_ref, ty, items) => {
 872             vis.visit_generics(generics);
 873             visit_opt(trait_ref, |trait_ref| vis.visit_trait_ref(trait_ref));
 874             vis.visit_ty(ty);
 875             items.flat_map_in_place(|item| vis.flat_map_impl_item(item));
 876         }
 877         ItemKind::Trait(_is_auto, _unsafety, generics, bounds, items) => {
 878             vis.visit_generics(generics);
 879             visit_bounds(bounds, vis);
 880             items.flat_map_in_place(|item| vis.flat_map_trait_item(item));
 881         }
 882         ItemKind::TraitAlias(generics, bounds) => {
 883             vis.visit_generics(generics);
 884             visit_bounds(bounds, vis);
 885         }
 886         ItemKind::Mac(m) => vis.visit_mac(m),
 887         ItemKind::MacroDef(def) => vis.visit_macro_def(def),
 888     }
 889 }
 890
 891 pub fn noop_flat_map_trait_item<T: MutVisitor>(mut item: TraitItem, vis: &mut T)
 892     -> SmallVec<[TraitItem; 1]>
 893 {
 894     let TraitItem { id, ident, attrs, generics, node, span, tokens: _ } = &mut item;
 895     vis.visit_id(id);
 896     vis.visit_ident(ident);
 897     visit_attrs(attrs, vis);
 898     vis.visit_generics(generics);
 899     match node {
 900         TraitItemKind::Const(ty, default) => {
 901             vis.visit_ty(ty);
 902             visit_opt(default, |default| vis.visit_expr(default));
 903         }
 904         TraitItemKind::Method(sig, body) => {
 905             visit_method_sig(sig, vis);
 906             visit_opt(body, |body| vis.visit_block(body));
 907         }
 908         TraitItemKind::Type(bounds, default) => {
 909             visit_bounds(bounds, vis);
 910             visit_opt(default, |default| vis.visit_ty(default));
 911         }
 912         TraitItemKind::Macro(mac) => {
 913             vis.visit_mac(mac);
 914         }
 915     }
 916     vis.visit_span(span);
 917
 918     smallvec![item]
 919 }
 920
 921 pub fn noop_flat_map_impl_item<T: MutVisitor>(mut item: ImplItem, visitor: &mut T)
 922                                               -> SmallVec<[ImplItem; 1]>
 923 {
 924     let ImplItem { id, ident, vis, defaultness: _, attrs, generics, node, span, tokens: _ } =
 925         &mut item;
 926     visitor.visit_id(id);
 927     visitor.visit_ident(ident);
 928     visitor.visit_vis(vis);
 929     visit_attrs(attrs, visitor);
 930     visitor.visit_generics(generics);
 931     match node  {
 932         ImplItemKind::Const(ty, expr) => {
 933             visitor.visit_ty(ty);
 934             visitor.visit_expr(expr);
 935         }
 936         ImplItemKind::Method(sig, body) => {
 937             visit_method_sig(sig, visitor);
 938             visitor.visit_block(body);
 939         }
 940         ImplItemKind::Type(ty) => visitor.visit_ty(ty),
 941         ImplItemKind::Existential(bounds) => visit_bounds(bounds, visitor),
 942         ImplItemKind::Macro(mac) => visitor.visit_mac(mac),
 943     }
 944     visitor.visit_span(span);
 945
 946     smallvec![item]
 947 }
 948
 949 pub fn noop_visit_fn_header<T: MutVisitor>(header: &mut FnHeader, vis: &mut T) {
 950     let FnHeader { unsafety: _, asyncness, constness: _, abi: _ } = header;
 951     vis.visit_asyncness(&mut asyncness.node);
 952 }
 953
 954 pub fn noop_visit_mod<T: MutVisitor>(Mod { inner, items, inline: _ }: &mut Mod, vis: &mut T) {
 955     vis.visit_span(inner);
 956     items.flat_map_in_place(|item| vis.flat_map_item(item));
 957 }
 958
 959 pub fn noop_visit_crate<T: MutVisitor>(krate: &mut Crate, vis: &mut T) {
 960     visit_clobber(krate, |Crate { module, attrs, span }| {
 961         let item = P(Item {
 962             ident: Ident::invalid(),
 963             attrs,
 964             id: DUMMY_NODE_ID,
 965             vis: respan(span.shrink_to_lo(), VisibilityKind::Public),
 966             span,
 967             node: ItemKind::Mod(module),
 968             tokens: None,
 969         });
 970         let items = vis.flat_map_item(item);
 971
 972         let len = items.len();
 973         if len == 0 {
 974             let module = Mod { inner: span, items: vec![], inline: true };
 975             Crate { module, attrs: vec![], span }
 976         } else if len == 1 {
 977             let Item { attrs, span, node, .. } = items.into_iter().next().unwrap().into_inner();
 978             match node {
 979                 ItemKind::Mod(module) => Crate { module, attrs, span },
 980                 _ => panic!("visitor converted a module to not a module"),
 981             }
 982         } else {
 983             panic!("a crate cannot expand to more than one item");
 984         }
 985     });
 986 }
 987
 988 // Mutate one item into possibly many items.
 989 pub fn noop_flat_map_item<T: MutVisitor>(mut item: P<Item>, visitor: &mut T)
 990                                          -> SmallVec<[P<Item>; 1]> {
 991     let Item { ident, attrs, id, node, vis, span, tokens: _ } = item.deref_mut();
 992     visitor.visit_ident(ident);
 993     visit_attrs(attrs, visitor);
 994     visitor.visit_id(id);
 995     visitor.visit_item_kind(node);
 996     visitor.visit_vis(vis);
 997     visitor.visit_span(span);
 998
 999     // FIXME: if `tokens` is modified with a call to `vis.visit_tts` it causes
1000     //        an ICE during resolve... odd!
1001
1002     smallvec![item]
1003 }
1004
1005 pub fn noop_flat_map_foreign_item<T: MutVisitor>(mut item: ForeignItem, visitor: &mut T)
1006     -> SmallVec<[ForeignItem; 1]>
1007 {
1008     let ForeignItem { ident, attrs, node, id, span, vis } = &mut item;
1009     visitor.visit_ident(ident);
1010     visit_attrs(attrs, visitor);
1011     match node {
1012         ForeignItemKind::Fn(fdec, generics) => {
1013             visitor.visit_fn_decl(fdec);
1014             visitor.visit_generics(generics);
1015         }
1016         ForeignItemKind::Static(t, _m) => visitor.visit_ty(t),
1017         ForeignItemKind::Ty => {}
1018         ForeignItemKind::Macro(mac) => visitor.visit_mac(mac),
1019     }
1020     visitor.visit_id(id);
1021     visitor.visit_span(span);
1022     visitor.visit_vis(vis);
1023
1024     smallvec![item]
1025 }
1026
1027 pub fn noop_visit_pat<T: MutVisitor>(pat: &mut P<Pat>, vis: &mut T) {
1028     let Pat { id, node, span } = pat.deref_mut();
1029     vis.visit_id(id);
1030     match node {
1031         PatKind::Wild => {}
1032         PatKind::Ident(_binding_mode, ident, sub) => {
1033             vis.visit_ident(ident);
1034             visit_opt(sub, |sub| vis.visit_pat(sub));
1035         }
1036         PatKind::Lit(e) => vis.visit_expr(e),
1037         PatKind::TupleStruct(path, pats, _ddpos) => {
1038             vis.visit_path(path);
1039             visit_vec(pats, |pat| vis.visit_pat(pat));
1040         }
1041         PatKind::Path(qself, path) => {
1042             vis.visit_qself(qself);
1043             vis.visit_path(path);
1044         }
1045         PatKind::Struct(path, fields, _etc) => {
1046             vis.visit_path(path);
1047             for Spanned { node: FieldPat { ident, pat, is_shorthand: _, attrs }, span } in fields {
1048                 vis.visit_ident(ident);
1049                 vis.visit_pat(pat);
1050                 visit_thin_attrs(attrs, vis);
1051                 vis.visit_span(span);
1052             };
1053         }
1054         PatKind::Tuple(elts, _ddpos) => visit_vec(elts, |elt| vis.visit_pat(elt)),
1055         PatKind::Box(inner) => vis.visit_pat(inner),
1056         PatKind::Ref(inner, _mutbl) => vis.visit_pat(inner),
1057         PatKind::Range(e1, e2, Spanned { span: _, node: _ }) => {
1058             vis.visit_expr(e1);
1059             vis.visit_expr(e2);
1060             vis.visit_span(span);
1061         }
1062         PatKind::Slice(before, slice, after) => {
1063             visit_vec(before, |pat| vis.visit_pat(pat));
1064             visit_opt(slice, |slice| vis.visit_pat(slice));
1065             visit_vec(after, |pat| vis.visit_pat(pat));
1066         }
1067         PatKind::Paren(inner) => vis.visit_pat(inner),
1068         PatKind::Mac(mac) => vis.visit_mac(mac),
1069     }
1070     vis.visit_span(span);
1071 }
1072
1073 pub fn noop_visit_anon_const<T: MutVisitor>(AnonConst { id, value }: &mut AnonConst, vis: &mut T) {
1074     vis.visit_id(id);
1075     vis.visit_expr(value);
1076 }
1077
1078 pub fn noop_visit_expr<T: MutVisitor>(Expr { node, id, span, attrs }: &mut Expr, vis: &mut T) {
1079     match node {
1080         ExprKind::Box(expr) => vis.visit_expr(expr),
1081         ExprKind::Array(exprs) => visit_exprs(exprs, vis),
1082         ExprKind::Repeat(expr, count) => {
1083             vis.visit_expr(expr);
1084             vis.visit_anon_const(count);
1085         }
1086         ExprKind::Tup(exprs) => visit_exprs(exprs, vis),
1087         ExprKind::Call(f, args) => {
1088             vis.visit_expr(f);
1089             visit_exprs(args, vis);
1090         }
1091         ExprKind::MethodCall(PathSegment { ident, id, args }, exprs) => {
1092             vis.visit_ident(ident);
1093             vis.visit_id(id);
1094             visit_opt(args, |args| vis.visit_generic_args(args));
1095             visit_exprs(exprs, vis);
1096         }
1097         ExprKind::Binary(_binop, lhs, rhs) => {
1098             vis.visit_expr(lhs);
1099             vis.visit_expr(rhs);
1100         }
1101         ExprKind::Unary(_unop, ohs) => vis.visit_expr(ohs),
1102         ExprKind::Lit(_lit) => {}
1103         ExprKind::Cast(expr, ty) => {
1104             vis.visit_expr(expr);
1105             vis.visit_ty(ty);
1106         }
1107         ExprKind::Type(expr, ty) => {
1108             vis.visit_expr(expr);
1109             vis.visit_ty(ty);
1110         }
1111         ExprKind::AddrOf(_m, ohs) => vis.visit_expr(ohs),
1112         ExprKind::If(cond, tr, fl) => {
1113             vis.visit_expr(cond);
1114             vis.visit_block(tr);
1115             visit_opt(fl, |fl| vis.visit_expr(fl));
1116         }
1117         ExprKind::IfLet(pats, expr, tr, fl) => {
1118             visit_vec(pats, |pat| vis.visit_pat(pat));
1119             vis.visit_expr(expr);
1120             vis.visit_block(tr);
1121             visit_opt(fl, |fl| vis.visit_expr(fl));
1122         }
1123         ExprKind::While(cond, body, label) => {
1124             vis.visit_expr(cond);
1125             vis.visit_block(body);
1126             visit_opt(label, |label| vis.visit_label(label));
1127         }
1128         ExprKind::WhileLet(pats, expr, body, label) => {
1129             visit_vec(pats, |pat| vis.visit_pat(pat));
1130             vis.visit_expr(expr);
1131             vis.visit_block(body);
1132             visit_opt(label, |label| vis.visit_label(label));
1133         }
1134         ExprKind::ForLoop(pat, iter, body, label) => {
1135             vis.visit_pat(pat);
1136             vis.visit_expr(iter);
1137             vis.visit_block(body);
1138             visit_opt(label, |label| vis.visit_label(label));
1139         }
1140         ExprKind::Loop(body, label) => {
1141             vis.visit_block(body);
1142             visit_opt(label, |label| vis.visit_label(label));
1143         }
1144         ExprKind::Match(expr, arms) => {
1145             vis.visit_expr(expr);
1146             visit_vec(arms, |arm| vis.visit_arm(arm));
1147         }
1148         ExprKind::Closure(_capture_by, asyncness, _movability, decl, body, span) => {
1149             vis.visit_asyncness(asyncness);
1150             vis.visit_fn_decl(decl);
1151             vis.visit_expr(body);
1152             vis.visit_span(span);
1153         }
1154         ExprKind::Block(blk, label) => {
1155             vis.visit_block(blk);
1156             visit_opt(label, |label| vis.visit_label(label));
1157         }
1158         ExprKind::Async(_capture_by, node_id, body) => {
1159             vis.visit_id(node_id);
1160             vis.visit_block(body);
1161         }
1162         ExprKind::Await(_origin, expr) => vis.visit_expr(expr),
1163         ExprKind::Assign(el, er) => {
1164             vis.visit_expr(el);
1165             vis.visit_expr(er);
1166         }
1167         ExprKind::AssignOp(_op, el, er) => {
1168             vis.visit_expr(el);
1169             vis.visit_expr(er);
1170         }
1171         ExprKind::Field(el, ident) => {
1172             vis.visit_expr(el);
1173             vis.visit_ident(ident);
1174         }
1175         ExprKind::Index(el, er) => {
1176             vis.visit_expr(el);
1177             vis.visit_expr(er);
1178         }
1179         ExprKind::Range(e1, e2, _lim) => {
1180             visit_opt(e1, |e1| vis.visit_expr(e1));
1181             visit_opt(e2, |e2| vis.visit_expr(e2));
1182         }
1183         ExprKind::Path(qself, path) => {
1184             vis.visit_qself(qself);
1185             vis.visit_path(path);
1186         }
1187         ExprKind::Break(label, expr) => {
1188             visit_opt(label, |label| vis.visit_label(label));
1189             visit_opt(expr, |expr| vis.visit_expr(expr));
1190         }
1191         ExprKind::Continue(label) => {
1192             visit_opt(label, |label| vis.visit_label(label));
1193         }
1194         ExprKind::Ret(expr) => {
1195             visit_opt(expr, |expr| vis.visit_expr(expr));
1196         }
1197         ExprKind::InlineAsm(asm) => {
1198             let InlineAsm { asm: _, asm_str_style: _, outputs, inputs, clobbers: _, volatile: _,
1199                             alignstack: _, dialect: _, ctxt: _ } = asm.deref_mut();
1200             for out in outputs {
1201                 let InlineAsmOutput { constraint: _, expr, is_rw: _, is_indirect: _ } = out;
1202                 vis.visit_expr(expr);
1203             }
1204             visit_vec(inputs, |(_c, expr)| vis.visit_expr(expr));
1205         }
1206         ExprKind::Mac(mac) => vis.visit_mac(mac),
1207         ExprKind::Struct(path, fields, expr) => {
1208             vis.visit_path(path);
1209             visit_vec(fields, |field| vis.visit_field(field));
1210             visit_opt(expr, |expr| vis.visit_expr(expr));
1211         },
1212         ExprKind::Paren(expr) => {
1213             vis.visit_expr(expr);
1214
1215             // Nodes that are equal modulo `Paren` sugar no-ops should have the same ids.
1216             *id = expr.id;
1217             vis.visit_span(span);
1218             visit_thin_attrs(attrs, vis);
1219             return;
1220         }
1221         ExprKind::Yield(expr) => {
1222             visit_opt(expr, |expr| vis.visit_expr(expr));
1223         }
1224         ExprKind::Try(expr) => vis.visit_expr(expr),
1225         ExprKind::TryBlock(body) => vis.visit_block(body),
1226         ExprKind::Err => {}
1227     }
1228     vis.visit_id(id);
1229     vis.visit_span(span);
1230     visit_thin_attrs(attrs, vis);
1231 }
1232
1233 pub fn noop_filter_map_expr<T: MutVisitor>(mut e: P<Expr>, vis: &mut T) -> Option<P<Expr>> {
1234     Some({ vis.visit_expr(&mut e); e })
1235 }
1236
1237 pub fn noop_flat_map_stmt<T: MutVisitor>(Stmt { node, mut span, mut id }: Stmt, vis: &mut T)
1238     -> SmallVec<[Stmt; 1]>
1239 {
1240     vis.visit_id(&mut id);
1241     vis.visit_span(&mut span);
1242     noop_flat_map_stmt_kind(node, vis).into_iter().map(|node| {
1243         Stmt { id, node, span }
1244     }).collect()
1245 }
1246
1247 pub fn noop_flat_map_stmt_kind<T: MutVisitor>(node: StmtKind, vis: &mut T)
1248                                               -> SmallVec<[StmtKind; 1]> {
1249     match node {
1250         StmtKind::Local(mut local) =>
1251             smallvec![StmtKind::Local({ vis.visit_local(&mut local); local })],
1252         StmtKind::Item(item) => vis.flat_map_item(item).into_iter().map(StmtKind::Item).collect(),
1253         StmtKind::Expr(expr) => {
1254             vis.filter_map_expr(expr).into_iter().map(StmtKind::Expr).collect()
1255         }
1256         StmtKind::Semi(expr) => {
1257             vis.filter_map_expr(expr).into_iter().map(StmtKind::Semi).collect()
1258         }
1259         StmtKind::Mac(mut mac) => {
1260             let (mac_, _semi, attrs) = mac.deref_mut();
1261             vis.visit_mac(mac_);
1262             visit_thin_attrs(attrs, vis);
1263             smallvec![StmtKind::Mac(mac)]
1264         }
1265     }
1266 }
1267
1268 pub fn noop_visit_vis<T: MutVisitor>(Spanned { node, span }: &mut Visibility, vis: &mut T) {
1269     match node {
1270         VisibilityKind::Public | VisibilityKind::Crate(_) | VisibilityKind::Inherited => {}
1271         VisibilityKind::Restricted { path, id } => {
1272             vis.visit_path(path);
1273             vis.visit_id(id);
1274         }
1275     }
1276     vis.visit_span(span);
1277 }
1278
1279 #[cfg(test)]
1280 mod tests {
1281     use std::io;
1282     use crate::ast::{self, Ident};
1283     use crate::util::parser_testing::{string_to_crate, matches_codepattern};
1284     use crate::print::pprust;
1285     use crate::mut_visit;
1286     use crate::with_default_globals;
1287     use super::*;
1288
1289     // this version doesn't care about getting comments or docstrings in.
1290     fn fake_print_crate(s: &mut pprust::State<'_>,
1291                         krate: &ast::Crate) -> io::Result<()> {
1292         s.print_mod(&krate.module, &krate.attrs)
1293     }
1294
1295     // change every identifier to "zz"
1296     struct ToZzIdentMutVisitor;
1297
1298     impl MutVisitor for ToZzIdentMutVisitor {
1299         fn visit_ident(&mut self, ident: &mut ast::Ident) {
1300             *ident = Ident::from_str("zz");
1301         }
1302         fn visit_mac(&mut self, mac: &mut ast::Mac) {
1303             mut_visit::noop_visit_mac(mac, self)
1304         }
1305     }
1306
1307     // maybe add to expand.rs...
1308     macro_rules! assert_pred {
1309         ($pred:expr, $predname:expr, $a:expr , $b:expr) => (
1310             {
1311                 let pred_val = $pred;
1312                 let a_val = $a;
1313                 let b_val = $b;
1314                 if !(pred_val(&a_val, &b_val)) {
1315                     panic!("expected args satisfying {}, got {} and {}",
1316                           $predname, a_val, b_val);
1317                 }
1318             }
1319         )
1320     }
1321
1322     // make sure idents get transformed everywhere
1323     #[test] fn ident_transformation () {
1324         with_default_globals(|| {
1325             let mut zz_visitor = ToZzIdentMutVisitor;
1326             let mut krate = string_to_crate(
1327                 "#[a] mod b {fn c (d : e, f : g) {h!(i,j,k);l;m}}".to_string());
1328             zz_visitor.visit_crate(&mut krate);
1329             assert_pred!(
1330                 matches_codepattern,
1331                 "matches_codepattern",
1332                 pprust::to_string(|s| fake_print_crate(s, &krate)),
1333                 "#[zz]mod zz{fn zz(zz:zz,zz:zz){zz!(zz,zz,zz);zz;zz}}".to_string());
1334         })
1335     }
1336
1337     // even inside macro defs....
1338     #[test] fn ident_transformation_in_defs () {
1339         with_default_globals(|| {
1340             let mut zz_visitor = ToZzIdentMutVisitor;
1341             let mut krate = string_to_crate(
1342                 "macro_rules! a {(b $c:expr $(d $e:token)f+ => \
1343                 (g $(d $d $e)+))} ".to_string());
1344             zz_visitor.visit_crate(&mut krate);
1345             assert_pred!(
1346                 matches_codepattern,
1347                 "matches_codepattern",
1348                 pprust::to_string(|s| fake_print_crate(s, &krate)),
1349                 "macro_rules! zz((zz$zz:zz$(zz $zz:zz)zz+=>(zz$(zz$zz$zz)+)));".to_string());
1350         })
1351     }
1352 }