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