compiler/rustc_ast/src/mut_visit.rs

   1 //! A `MutVisitor` represents an AST modification; it accepts an AST piece and
   2 //! 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::ptr::P;
  12 use crate::token::{self, Token};
  13 use crate::tokenstream::*;
  14
  15 use rustc_data_structures::map_in_place::MapInPlace;
  16 use rustc_data_structures::sync::Lrc;
  17 use rustc_span::source_map::Spanned;
  18 use rustc_span::symbol::Ident;
  19 use rustc_span::Span;
  20
  21 use smallvec::{smallvec, Array, SmallVec};
  22 use std::ops::DerefMut;
  23 use std::{panic, 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     /// Mutable token visiting only exists for the `macro_rules` token marker and should not be
  38     /// used otherwise. Token visitor would be entirely separate from the regular visitor if
  39     /// the marker didn't have to visit AST fragments in nonterminal tokens.
  40     const VISIT_TOKENS: bool = false;
  41
  42     // Methods in this trait have one of three forms:
  43     //
  44     //   fn visit_t(&mut self, t: &mut T);                      // common
  45     //   fn flat_map_t(&mut self, t: T) -> SmallVec<[T; 1]>;    // rare
  46     //   fn filter_map_t(&mut self, t: T) -> Option<T>;         // rarest
  47     //
  48     // Any additions to this trait should happen in form of a call to a public
  49     // `noop_*` function that only calls out to the visitor again, not other
  50     // `noop_*` functions. This is a necessary API workaround to the problem of
  51     // not being able to call out to the super default method in an overridden
  52     // default method.
  53     //
  54     // When writing these methods, it is better to use destructuring like this:
  55     //
  56     //   fn visit_abc(&mut self, ABC { a, b, c: _ }: &mut ABC) {
  57     //       visit_a(a);
  58     //       visit_b(b);
  59     //   }
  60     //
  61     // than to use field access like this:
  62     //
  63     //   fn visit_abc(&mut self, abc: &mut ABC) {
  64     //       visit_a(&mut abc.a);
  65     //       visit_b(&mut abc.b);
  66     //       // ignore abc.c
  67     //   }
  68     //
  69     // As well as being more concise, the former is explicit about which fields
  70     // are skipped. Furthermore, if a new field is added, the destructuring
  71     // version will cause a compile error, which is good. In comparison, the
  72     // field access version will continue working and it would be easy to
  73     // forget to add handling for it.
  74
  75     fn visit_crate(&mut self, c: &mut Crate) {
  76         noop_visit_crate(c, self)
  77     }
  78
  79     fn visit_meta_list_item(&mut self, list_item: &mut NestedMetaItem) {
  80         noop_visit_meta_list_item(list_item, self);
  81     }
  82
  83     fn visit_meta_item(&mut self, meta_item: &mut MetaItem) {
  84         noop_visit_meta_item(meta_item, self);
  85     }
  86
  87     fn visit_use_tree(&mut self, use_tree: &mut UseTree) {
  88         noop_visit_use_tree(use_tree, self);
  89     }
  90
  91     fn flat_map_foreign_item(&mut self, ni: P<ForeignItem>) -> SmallVec<[P<ForeignItem>; 1]> {
  92         noop_flat_map_foreign_item(ni, self)
  93     }
  94
  95     fn flat_map_item(&mut self, i: P<Item>) -> SmallVec<[P<Item>; 1]> {
  96         noop_flat_map_item(i, self)
  97     }
  98
  99     fn visit_fn_header(&mut self, header: &mut FnHeader) {
 100         noop_visit_fn_header(header, self);
 101     }
 102
 103     fn flat_map_field_def(&mut self, fd: FieldDef) -> SmallVec<[FieldDef; 1]> {
 104         noop_flat_map_field_def(fd, self)
 105     }
 106
 107     fn visit_item_kind(&mut self, i: &mut ItemKind) {
 108         noop_visit_item_kind(i, self);
 109     }
 110
 111     fn flat_map_trait_item(&mut self, i: P<AssocItem>) -> SmallVec<[P<AssocItem>; 1]> {
 112         noop_flat_map_assoc_item(i, self)
 113     }
 114
 115     fn flat_map_impl_item(&mut self, i: P<AssocItem>) -> SmallVec<[P<AssocItem>; 1]> {
 116         noop_flat_map_assoc_item(i, self)
 117     }
 118
 119     fn visit_fn_decl(&mut self, d: &mut P<FnDecl>) {
 120         noop_visit_fn_decl(d, self);
 121     }
 122
 123     fn visit_asyncness(&mut self, a: &mut Async) {
 124         noop_visit_asyncness(a, self);
 125     }
 126
 127     fn visit_closure_binder(&mut self, b: &mut ClosureBinder) {
 128         noop_visit_closure_binder(b, self);
 129     }
 130
 131     fn visit_block(&mut self, b: &mut P<Block>) {
 132         noop_visit_block(b, self);
 133     }
 134
 135     fn flat_map_stmt(&mut self, s: Stmt) -> SmallVec<[Stmt; 1]> {
 136         noop_flat_map_stmt(s, self)
 137     }
 138
 139     fn flat_map_arm(&mut self, arm: Arm) -> SmallVec<[Arm; 1]> {
 140         noop_flat_map_arm(arm, self)
 141     }
 142
 143     fn visit_pat(&mut self, p: &mut P<Pat>) {
 144         noop_visit_pat(p, self);
 145     }
 146
 147     fn visit_anon_const(&mut self, c: &mut AnonConst) {
 148         noop_visit_anon_const(c, self);
 149     }
 150
 151     fn visit_expr(&mut self, e: &mut P<Expr>) {
 152         noop_visit_expr(e, self);
 153     }
 154
 155     /// This method is a hack to workaround unstable of `stmt_expr_attributes`.
 156     /// It can be removed once that feature is stabilized.
 157     fn visit_method_receiver_expr(&mut self, ex: &mut P<Expr>) {
 158         self.visit_expr(ex)
 159     }
 160
 161     fn filter_map_expr(&mut self, e: P<Expr>) -> Option<P<Expr>> {
 162         noop_filter_map_expr(e, self)
 163     }
 164
 165     fn visit_generic_arg(&mut self, arg: &mut GenericArg) {
 166         noop_visit_generic_arg(arg, self);
 167     }
 168
 169     fn visit_ty(&mut self, t: &mut P<Ty>) {
 170         noop_visit_ty(t, self);
 171     }
 172
 173     fn visit_lifetime(&mut self, l: &mut Lifetime) {
 174         noop_visit_lifetime(l, self);
 175     }
 176
 177     fn visit_constraint(&mut self, t: &mut AssocConstraint) {
 178         noop_visit_constraint(t, self);
 179     }
 180
 181     fn visit_foreign_mod(&mut self, nm: &mut ForeignMod) {
 182         noop_visit_foreign_mod(nm, self);
 183     }
 184
 185     fn flat_map_variant(&mut self, v: Variant) -> SmallVec<[Variant; 1]> {
 186         noop_flat_map_variant(v, self)
 187     }
 188
 189     fn visit_ident(&mut self, i: &mut Ident) {
 190         noop_visit_ident(i, self);
 191     }
 192
 193     fn visit_path(&mut self, p: &mut Path) {
 194         noop_visit_path(p, self);
 195     }
 196
 197     fn visit_qself(&mut self, qs: &mut Option<P<QSelf>>) {
 198         noop_visit_qself(qs, self);
 199     }
 200
 201     fn visit_generic_args(&mut self, p: &mut GenericArgs) {
 202         noop_visit_generic_args(p, self);
 203     }
 204
 205     fn visit_angle_bracketed_parameter_data(&mut self, p: &mut AngleBracketedArgs) {
 206         noop_visit_angle_bracketed_parameter_data(p, self);
 207     }
 208
 209     fn visit_parenthesized_parameter_data(&mut self, p: &mut ParenthesizedArgs) {
 210         noop_visit_parenthesized_parameter_data(p, self);
 211     }
 212
 213     fn visit_local(&mut self, l: &mut P<Local>) {
 214         noop_visit_local(l, self);
 215     }
 216
 217     fn visit_mac_call(&mut self, mac: &mut MacCall) {
 218         noop_visit_mac(mac, self);
 219     }
 220
 221     fn visit_macro_def(&mut self, def: &mut MacroDef) {
 222         noop_visit_macro_def(def, self);
 223     }
 224
 225     fn visit_label(&mut self, label: &mut Label) {
 226         noop_visit_label(label, self);
 227     }
 228
 229     fn visit_attribute(&mut self, at: &mut Attribute) {
 230         noop_visit_attribute(at, self);
 231     }
 232
 233     fn flat_map_param(&mut self, param: Param) -> SmallVec<[Param; 1]> {
 234         noop_flat_map_param(param, self)
 235     }
 236
 237     fn visit_generics(&mut self, generics: &mut Generics) {
 238         noop_visit_generics(generics, self);
 239     }
 240
 241     fn visit_trait_ref(&mut self, tr: &mut TraitRef) {
 242         noop_visit_trait_ref(tr, self);
 243     }
 244
 245     fn visit_poly_trait_ref(&mut self, p: &mut PolyTraitRef) {
 246         noop_visit_poly_trait_ref(p, self);
 247     }
 248
 249     fn visit_variant_data(&mut self, vdata: &mut VariantData) {
 250         noop_visit_variant_data(vdata, self);
 251     }
 252
 253     fn flat_map_generic_param(&mut self, param: GenericParam) -> SmallVec<[GenericParam; 1]> {
 254         noop_flat_map_generic_param(param, self)
 255     }
 256
 257     fn visit_param_bound(&mut self, tpb: &mut GenericBound) {
 258         noop_visit_param_bound(tpb, self);
 259     }
 260
 261     fn visit_mt(&mut self, mt: &mut MutTy) {
 262         noop_visit_mt(mt, self);
 263     }
 264
 265     fn flat_map_expr_field(&mut self, f: ExprField) -> SmallVec<[ExprField; 1]> {
 266         noop_flat_map_expr_field(f, self)
 267     }
 268
 269     fn visit_where_clause(&mut self, where_clause: &mut WhereClause) {
 270         noop_visit_where_clause(where_clause, self);
 271     }
 272
 273     fn visit_where_predicate(&mut self, where_predicate: &mut WherePredicate) {
 274         noop_visit_where_predicate(where_predicate, self);
 275     }
 276
 277     fn visit_vis(&mut self, vis: &mut Visibility) {
 278         noop_visit_vis(vis, self);
 279     }
 280
 281     fn visit_id(&mut self, _id: &mut NodeId) {
 282         // Do nothing.
 283     }
 284
 285     fn visit_span(&mut self, _sp: &mut Span) {
 286         // Do nothing.
 287     }
 288
 289     fn flat_map_pat_field(&mut self, fp: PatField) -> SmallVec<[PatField; 1]> {
 290         noop_flat_map_pat_field(fp, self)
 291     }
 292
 293     fn visit_inline_asm(&mut self, asm: &mut InlineAsm) {
 294         noop_visit_inline_asm(asm, self)
 295     }
 296
 297     fn visit_inline_asm_sym(&mut self, sym: &mut InlineAsmSym) {
 298         noop_visit_inline_asm_sym(sym, self)
 299     }
 300 }
 301
 302 /// Use a map-style function (`FnOnce(T) -> T`) to overwrite a `&mut T`. Useful
 303 /// when using a `flat_map_*` or `filter_map_*` method within a `visit_`
 304 /// method.
 305 //
 306 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 307 pub fn visit_clobber<T: DummyAstNode>(t: &mut T, f: impl FnOnce(T) -> T) {
 308     unsafe {
 309         // Safe because `t` is used in a read-only fashion by `read()` before
 310         // being overwritten by `write()`.
 311         let old_t = ptr::read(t);
 312         let new_t =
 313             panic::catch_unwind(panic::AssertUnwindSafe(|| f(old_t))).unwrap_or_else(|err| {
 314                 // Set `t` to some valid but possible meaningless value,
 315                 // and pass the fatal error further.
 316                 ptr::write(t, T::dummy());
 317                 panic::resume_unwind(err);
 318             });
 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)
 326 where
 327     F: FnMut(&mut T),
 328 {
 329     for elem in elems {
 330         visit_elem(elem);
 331     }
 332 }
 333
 334 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 335 #[inline]
 336 pub fn visit_opt<T, F>(opt: &mut Option<T>, mut visit_elem: F)
 337 where
 338     F: FnMut(&mut T),
 339 {
 340     if let Some(elem) = opt {
 341         visit_elem(elem);
 342     }
 343 }
 344
 345 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 346 pub fn visit_attrs<T: MutVisitor>(attrs: &mut AttrVec, vis: &mut T) {
 347     for attr in attrs.iter_mut() {
 348         vis.visit_attribute(attr);
 349     }
 350 }
 351
 352 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 353 pub fn visit_exprs<T: MutVisitor>(exprs: &mut Vec<P<Expr>>, vis: &mut T) {
 354     exprs.flat_map_in_place(|expr| vis.filter_map_expr(expr))
 355 }
 356
 357 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 358 pub fn visit_bounds<T: MutVisitor>(bounds: &mut GenericBounds, vis: &mut T) {
 359     visit_vec(bounds, |bound| vis.visit_param_bound(bound));
 360 }
 361
 362 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 363 pub fn visit_fn_sig<T: MutVisitor>(FnSig { header, decl, span }: &mut FnSig, vis: &mut T) {
 364     vis.visit_fn_header(header);
 365     vis.visit_fn_decl(decl);
 366     vis.visit_span(span);
 367 }
 368
 369 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 370 pub fn visit_attr_args<T: MutVisitor>(args: &mut AttrArgs, vis: &mut T) {
 371     match args {
 372         AttrArgs::Empty => {}
 373         AttrArgs::Delimited(args) => visit_delim_args(args, vis),
 374         AttrArgs::Eq(eq_span, AttrArgsEq::Ast(expr)) => {
 375             vis.visit_span(eq_span);
 376             vis.visit_expr(expr);
 377         }
 378         AttrArgs::Eq(_, AttrArgsEq::Hir(lit)) => {
 379             unreachable!("in literal form when visiting mac args eq: {:?}", lit)
 380         }
 381     }
 382 }
 383
 384 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 385 pub fn visit_delim_args<T: MutVisitor>(args: &mut DelimArgs, vis: &mut T) {
 386     let DelimArgs { dspan, delim: _, tokens } = args;
 387     visit_delim_span(dspan, vis);
 388     visit_tts(tokens, vis);
 389 }
 390
 391 pub fn visit_delim_span<T: MutVisitor>(dspan: &mut DelimSpan, vis: &mut T) {
 392     vis.visit_span(&mut dspan.open);
 393     vis.visit_span(&mut dspan.close);
 394 }
 395
 396 pub fn noop_flat_map_pat_field<T: MutVisitor>(
 397     mut fp: PatField,
 398     vis: &mut T,
 399 ) -> SmallVec<[PatField; 1]> {
 400     let PatField { attrs, id, ident, is_placeholder: _, is_shorthand: _, pat, span } = &mut fp;
 401     vis.visit_id(id);
 402     vis.visit_ident(ident);
 403     vis.visit_pat(pat);
 404     vis.visit_span(span);
 405     visit_attrs(attrs, vis);
 406     smallvec![fp]
 407 }
 408
 409 pub fn noop_visit_use_tree<T: MutVisitor>(use_tree: &mut UseTree, vis: &mut T) {
 410     let UseTree { prefix, kind, span } = use_tree;
 411     vis.visit_path(prefix);
 412     match kind {
 413         UseTreeKind::Simple(rename, id1, id2) => {
 414             visit_opt(rename, |rename| vis.visit_ident(rename));
 415             vis.visit_id(id1);
 416             vis.visit_id(id2);
 417         }
 418         UseTreeKind::Nested(items) => {
 419             for (tree, id) in items {
 420                 vis.visit_use_tree(tree);
 421                 vis.visit_id(id);
 422             }
 423         }
 424         UseTreeKind::Glob => {}
 425     }
 426     vis.visit_span(span);
 427 }
 428
 429 pub fn noop_flat_map_arm<T: MutVisitor>(mut arm: Arm, vis: &mut T) -> SmallVec<[Arm; 1]> {
 430     let Arm { attrs, pat, guard, body, span, id, is_placeholder: _ } = &mut arm;
 431     visit_attrs(attrs, vis);
 432     vis.visit_id(id);
 433     vis.visit_pat(pat);
 434     visit_opt(guard, |guard| vis.visit_expr(guard));
 435     vis.visit_expr(body);
 436     vis.visit_span(span);
 437     smallvec![arm]
 438 }
 439
 440 pub fn noop_visit_constraint<T: MutVisitor>(
 441     AssocConstraint { id, ident, gen_args, kind, span }: &mut AssocConstraint,
 442     vis: &mut T,
 443 ) {
 444     vis.visit_id(id);
 445     vis.visit_ident(ident);
 446     if let Some(gen_args) = gen_args {
 447         vis.visit_generic_args(gen_args);
 448     }
 449     match kind {
 450         AssocConstraintKind::Equality { term } => match term {
 451             Term::Ty(ty) => vis.visit_ty(ty),
 452             Term::Const(c) => vis.visit_anon_const(c),
 453         },
 454         AssocConstraintKind::Bound { bounds } => visit_bounds(bounds, vis),
 455     }
 456     vis.visit_span(span);
 457 }
 458
 459 pub fn noop_visit_ty<T: MutVisitor>(ty: &mut P<Ty>, vis: &mut T) {
 460     let Ty { id, kind, span, tokens } = ty.deref_mut();
 461     vis.visit_id(id);
 462     match kind {
 463         TyKind::Infer | TyKind::ImplicitSelf | TyKind::Err | TyKind::Never | TyKind::CVarArgs => {}
 464         TyKind::Slice(ty) => vis.visit_ty(ty),
 465         TyKind::Ptr(mt) => vis.visit_mt(mt),
 466         TyKind::Rptr(lt, mt) => {
 467             visit_opt(lt, |lt| noop_visit_lifetime(lt, vis));
 468             vis.visit_mt(mt);
 469         }
 470         TyKind::BareFn(bft) => {
 471             let BareFnTy { unsafety, ext: _, generic_params, decl, decl_span } = bft.deref_mut();
 472             visit_unsafety(unsafety, vis);
 473             generic_params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
 474             vis.visit_fn_decl(decl);
 475             vis.visit_span(decl_span);
 476         }
 477         TyKind::Tup(tys) => visit_vec(tys, |ty| vis.visit_ty(ty)),
 478         TyKind::Paren(ty) => vis.visit_ty(ty),
 479         TyKind::Path(qself, path) => {
 480             vis.visit_qself(qself);
 481             vis.visit_path(path);
 482         }
 483         TyKind::Array(ty, length) => {
 484             vis.visit_ty(ty);
 485             vis.visit_anon_const(length);
 486         }
 487         TyKind::Typeof(expr) => vis.visit_anon_const(expr),
 488         TyKind::TraitObject(bounds, _syntax) => {
 489             visit_vec(bounds, |bound| vis.visit_param_bound(bound))
 490         }
 491         TyKind::ImplTrait(id, bounds) => {
 492             vis.visit_id(id);
 493             visit_vec(bounds, |bound| vis.visit_param_bound(bound));
 494         }
 495         TyKind::MacCall(mac) => vis.visit_mac_call(mac),
 496     }
 497     vis.visit_span(span);
 498     visit_lazy_tts(tokens, vis);
 499 }
 500
 501 pub fn noop_visit_foreign_mod<T: MutVisitor>(foreign_mod: &mut ForeignMod, vis: &mut T) {
 502     let ForeignMod { unsafety, abi: _, items } = foreign_mod;
 503     visit_unsafety(unsafety, vis);
 504     items.flat_map_in_place(|item| vis.flat_map_foreign_item(item));
 505 }
 506
 507 pub fn noop_flat_map_variant<T: MutVisitor>(
 508     mut variant: Variant,
 509     visitor: &mut T,
 510 ) -> SmallVec<[Variant; 1]> {
 511     let Variant { ident, vis, attrs, id, data, disr_expr, span, is_placeholder: _ } = &mut variant;
 512     visitor.visit_ident(ident);
 513     visitor.visit_vis(vis);
 514     visit_attrs(attrs, visitor);
 515     visitor.visit_id(id);
 516     visitor.visit_variant_data(data);
 517     visit_opt(disr_expr, |disr_expr| visitor.visit_anon_const(disr_expr));
 518     visitor.visit_span(span);
 519     smallvec![variant]
 520 }
 521
 522 pub fn noop_visit_ident<T: MutVisitor>(Ident { name: _, span }: &mut Ident, vis: &mut T) {
 523     vis.visit_span(span);
 524 }
 525
 526 pub fn noop_visit_path<T: MutVisitor>(Path { segments, span, tokens }: &mut Path, vis: &mut T) {
 527     vis.visit_span(span);
 528     for PathSegment { ident, id, args } in segments {
 529         vis.visit_ident(ident);
 530         vis.visit_id(id);
 531         visit_opt(args, |args| vis.visit_generic_args(args));
 532     }
 533     visit_lazy_tts(tokens, vis);
 534 }
 535
 536 pub fn noop_visit_qself<T: MutVisitor>(qself: &mut Option<P<QSelf>>, vis: &mut T) {
 537     visit_opt(qself, |qself| {
 538         let QSelf { ty, path_span, position: _ } = &mut **qself;
 539         vis.visit_ty(ty);
 540         vis.visit_span(path_span);
 541     })
 542 }
 543
 544 pub fn noop_visit_generic_args<T: MutVisitor>(generic_args: &mut GenericArgs, vis: &mut T) {
 545     match generic_args {
 546         GenericArgs::AngleBracketed(data) => vis.visit_angle_bracketed_parameter_data(data),
 547         GenericArgs::Parenthesized(data) => vis.visit_parenthesized_parameter_data(data),
 548     }
 549 }
 550
 551 pub fn noop_visit_generic_arg<T: MutVisitor>(arg: &mut GenericArg, vis: &mut T) {
 552     match arg {
 553         GenericArg::Lifetime(lt) => vis.visit_lifetime(lt),
 554         GenericArg::Type(ty) => vis.visit_ty(ty),
 555         GenericArg::Const(ct) => vis.visit_anon_const(ct),
 556     }
 557 }
 558
 559 pub fn noop_visit_angle_bracketed_parameter_data<T: MutVisitor>(
 560     data: &mut AngleBracketedArgs,
 561     vis: &mut T,
 562 ) {
 563     let AngleBracketedArgs { args, span } = data;
 564     visit_vec(args, |arg| match arg {
 565         AngleBracketedArg::Arg(arg) => vis.visit_generic_arg(arg),
 566         AngleBracketedArg::Constraint(constraint) => vis.visit_constraint(constraint),
 567     });
 568     vis.visit_span(span);
 569 }
 570
 571 pub fn noop_visit_parenthesized_parameter_data<T: MutVisitor>(
 572     args: &mut ParenthesizedArgs,
 573     vis: &mut T,
 574 ) {
 575     let ParenthesizedArgs { inputs, output, span, .. } = args;
 576     visit_vec(inputs, |input| vis.visit_ty(input));
 577     noop_visit_fn_ret_ty(output, vis);
 578     vis.visit_span(span);
 579 }
 580
 581 pub fn noop_visit_local<T: MutVisitor>(local: &mut P<Local>, vis: &mut T) {
 582     let Local { id, pat, ty, kind, span, attrs, tokens } = local.deref_mut();
 583     vis.visit_id(id);
 584     vis.visit_pat(pat);
 585     visit_opt(ty, |ty| vis.visit_ty(ty));
 586     match kind {
 587         LocalKind::Decl => {}
 588         LocalKind::Init(init) => {
 589             vis.visit_expr(init);
 590         }
 591         LocalKind::InitElse(init, els) => {
 592             vis.visit_expr(init);
 593             vis.visit_block(els);
 594         }
 595     }
 596     vis.visit_span(span);
 597     visit_attrs(attrs, vis);
 598     visit_lazy_tts(tokens, vis);
 599 }
 600
 601 pub fn noop_visit_attribute<T: MutVisitor>(attr: &mut Attribute, vis: &mut T) {
 602     let Attribute { kind, id: _, style: _, span } = attr;
 603     match kind {
 604         AttrKind::Normal(normal) => {
 605             let NormalAttr { item: AttrItem { path, args, tokens }, tokens: attr_tokens } =
 606                 &mut **normal;
 607             vis.visit_path(path);
 608             visit_attr_args(args, vis);
 609             visit_lazy_tts(tokens, vis);
 610             visit_lazy_tts(attr_tokens, vis);
 611         }
 612         AttrKind::DocComment(..) => {}
 613     }
 614     vis.visit_span(span);
 615 }
 616
 617 pub fn noop_visit_mac<T: MutVisitor>(mac: &mut MacCall, vis: &mut T) {
 618     let MacCall { path, args, prior_type_ascription: _ } = mac;
 619     vis.visit_path(path);
 620     visit_delim_args(args, vis);
 621 }
 622
 623 pub fn noop_visit_macro_def<T: MutVisitor>(macro_def: &mut MacroDef, vis: &mut T) {
 624     let MacroDef { body, macro_rules: _ } = macro_def;
 625     visit_delim_args(body, vis);
 626 }
 627
 628 pub fn noop_visit_meta_list_item<T: MutVisitor>(li: &mut NestedMetaItem, vis: &mut T) {
 629     match li {
 630         NestedMetaItem::MetaItem(mi) => vis.visit_meta_item(mi),
 631         NestedMetaItem::Lit(_lit) => {}
 632     }
 633 }
 634
 635 pub fn noop_visit_meta_item<T: MutVisitor>(mi: &mut MetaItem, vis: &mut T) {
 636     let MetaItem { path: _, kind, span } = mi;
 637     match kind {
 638         MetaItemKind::Word => {}
 639         MetaItemKind::List(mis) => visit_vec(mis, |mi| vis.visit_meta_list_item(mi)),
 640         MetaItemKind::NameValue(_s) => {}
 641     }
 642     vis.visit_span(span);
 643 }
 644
 645 pub fn noop_flat_map_param<T: MutVisitor>(mut param: Param, vis: &mut T) -> SmallVec<[Param; 1]> {
 646     let Param { attrs, id, pat, span, ty, is_placeholder: _ } = &mut param;
 647     vis.visit_id(id);
 648     visit_attrs(attrs, vis);
 649     vis.visit_pat(pat);
 650     vis.visit_span(span);
 651     vis.visit_ty(ty);
 652     smallvec![param]
 653 }
 654
 655 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 656 pub fn visit_attr_tt<T: MutVisitor>(tt: &mut AttrTokenTree, vis: &mut T) {
 657     match tt {
 658         AttrTokenTree::Token(token, _) => {
 659             visit_token(token, vis);
 660         }
 661         AttrTokenTree::Delimited(DelimSpan { open, close }, _delim, tts) => {
 662             vis.visit_span(open);
 663             vis.visit_span(close);
 664             visit_attr_tts(tts, vis);
 665         }
 666         AttrTokenTree::Attributes(data) => {
 667             for attr in &mut *data.attrs {
 668                 match &mut attr.kind {
 669                     AttrKind::Normal(normal) => {
 670                         visit_lazy_tts(&mut normal.tokens, vis);
 671                     }
 672                     AttrKind::DocComment(..) => {
 673                         vis.visit_span(&mut attr.span);
 674                     }
 675                 }
 676             }
 677             visit_lazy_tts_opt_mut(Some(&mut data.tokens), vis);
 678         }
 679     }
 680 }
 681
 682 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 683 pub fn visit_tt<T: MutVisitor>(tt: &mut TokenTree, vis: &mut T) {
 684     match tt {
 685         TokenTree::Token(token, _) => {
 686             visit_token(token, vis);
 687         }
 688         TokenTree::Delimited(DelimSpan { open, close }, _delim, tts) => {
 689             vis.visit_span(open);
 690             vis.visit_span(close);
 691             visit_tts(tts, vis);
 692         }
 693     }
 694 }
 695
 696 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 697 pub fn visit_tts<T: MutVisitor>(TokenStream(tts): &mut TokenStream, vis: &mut T) {
 698     if T::VISIT_TOKENS && !tts.is_empty() {
 699         let tts = Lrc::make_mut(tts);
 700         visit_vec(tts, |tree| visit_tt(tree, vis));
 701     }
 702 }
 703
 704 pub fn visit_attr_tts<T: MutVisitor>(AttrTokenStream(tts): &mut AttrTokenStream, vis: &mut T) {
 705     if T::VISIT_TOKENS && !tts.is_empty() {
 706         let tts = Lrc::make_mut(tts);
 707         visit_vec(tts, |tree| visit_attr_tt(tree, vis));
 708     }
 709 }
 710
 711 pub fn visit_lazy_tts_opt_mut<T: MutVisitor>(
 712     lazy_tts: Option<&mut LazyAttrTokenStream>,
 713     vis: &mut T,
 714 ) {
 715     if T::VISIT_TOKENS {
 716         if let Some(lazy_tts) = lazy_tts {
 717             let mut tts = lazy_tts.to_attr_token_stream();
 718             visit_attr_tts(&mut tts, vis);
 719             *lazy_tts = LazyAttrTokenStream::new(tts);
 720         }
 721     }
 722 }
 723
 724 pub fn visit_lazy_tts<T: MutVisitor>(lazy_tts: &mut Option<LazyAttrTokenStream>, vis: &mut T) {
 725     visit_lazy_tts_opt_mut(lazy_tts.as_mut(), vis);
 726 }
 727
 728 /// Applies ident visitor if it's an ident; applies other visits to interpolated nodes.
 729 /// In practice the ident part is not actually used by specific visitors right now,
 730 /// but there's a test below checking that it works.
 731 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 732 pub fn visit_token<T: MutVisitor>(t: &mut Token, vis: &mut T) {
 733     let Token { kind, span } = t;
 734     match kind {
 735         token::Ident(name, _) | token::Lifetime(name) => {
 736             let mut ident = Ident::new(*name, *span);
 737             vis.visit_ident(&mut ident);
 738             *name = ident.name;
 739             *span = ident.span;
 740             return; // Avoid visiting the span for the second time.
 741         }
 742         token::Interpolated(nt) => {
 743             let mut nt = Lrc::make_mut(nt);
 744             visit_nonterminal(&mut nt, vis);
 745         }
 746         _ => {}
 747     }
 748     vis.visit_span(span);
 749 }
 750
 751 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 752 /// Applies the visitor to elements of interpolated nodes.
 753 //
 754 // N.B., this can occur only when applying a visitor to partially expanded
 755 // code, where parsed pieces have gotten implanted ito *other* macro
 756 // invocations. This is relevant for macro hygiene, but possibly not elsewhere.
 757 //
 758 // One problem here occurs because the types for flat_map_item, flat_map_stmt,
 759 // etc., allow the visitor to return *multiple* items; this is a problem for the
 760 // nodes here, because they insist on having exactly one piece. One solution
 761 // would be to mangle the MutVisitor trait to include one-to-many and
 762 // one-to-one versions of these entry points, but that would probably confuse a
 763 // lot of people and help very few. Instead, I'm just going to put in dynamic
 764 // checks. I think the performance impact of this will be pretty much
 765 // nonexistent. The danger is that someone will apply a `MutVisitor` to a
 766 // partially expanded node, and will be confused by the fact that their
 767 // `flat_map_item` or `flat_map_stmt` isn't getting called on `NtItem` or `NtStmt`
 768 // nodes. Hopefully they'll wind up reading this comment, and doing something
 769 // appropriate.
 770 //
 771 // BTW, design choice: I considered just changing the type of, e.g., `NtItem` to
 772 // contain multiple items, but decided against it when I looked at
 773 // `parse_item_or_view_item` and tried to figure out what I would do with
 774 // multiple items there....
 775 pub fn visit_nonterminal<T: MutVisitor>(nt: &mut token::Nonterminal, vis: &mut T) {
 776     match nt {
 777         token::NtItem(item) => visit_clobber(item, |item| {
 778             // This is probably okay, because the only visitors likely to
 779             // peek inside interpolated nodes will be renamings/markings,
 780             // which map single items to single items.
 781             vis.flat_map_item(item).expect_one("expected visitor to produce exactly one item")
 782         }),
 783         token::NtBlock(block) => vis.visit_block(block),
 784         token::NtStmt(stmt) => visit_clobber(stmt, |stmt| {
 785             // See reasoning above.
 786             stmt.map(|stmt| {
 787                 vis.flat_map_stmt(stmt).expect_one("expected visitor to produce exactly one item")
 788             })
 789         }),
 790         token::NtPat(pat) => vis.visit_pat(pat),
 791         token::NtExpr(expr) => vis.visit_expr(expr),
 792         token::NtTy(ty) => vis.visit_ty(ty),
 793         token::NtIdent(ident, _is_raw) => vis.visit_ident(ident),
 794         token::NtLifetime(ident) => vis.visit_ident(ident),
 795         token::NtLiteral(expr) => vis.visit_expr(expr),
 796         token::NtMeta(item) => {
 797             let AttrItem { path, args, tokens } = item.deref_mut();
 798             vis.visit_path(path);
 799             visit_attr_args(args, vis);
 800             visit_lazy_tts(tokens, vis);
 801         }
 802         token::NtPath(path) => vis.visit_path(path),
 803         token::NtVis(visib) => vis.visit_vis(visib),
 804     }
 805 }
 806
 807 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 808 pub fn visit_defaultness<T: MutVisitor>(defaultness: &mut Defaultness, vis: &mut T) {
 809     match defaultness {
 810         Defaultness::Default(span) => vis.visit_span(span),
 811         Defaultness::Final => {}
 812     }
 813 }
 814
 815 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 816 pub fn visit_unsafety<T: MutVisitor>(unsafety: &mut Unsafe, vis: &mut T) {
 817     match unsafety {
 818         Unsafe::Yes(span) => vis.visit_span(span),
 819         Unsafe::No => {}
 820     }
 821 }
 822
 823 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 824 pub fn visit_polarity<T: MutVisitor>(polarity: &mut ImplPolarity, vis: &mut T) {
 825     match polarity {
 826         ImplPolarity::Positive => {}
 827         ImplPolarity::Negative(span) => vis.visit_span(span),
 828     }
 829 }
 830
 831 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 832 pub fn visit_constness<T: MutVisitor>(constness: &mut Const, vis: &mut T) {
 833     match constness {
 834         Const::Yes(span) => vis.visit_span(span),
 835         Const::No => {}
 836     }
 837 }
 838
 839 pub fn noop_visit_closure_binder<T: MutVisitor>(binder: &mut ClosureBinder, vis: &mut T) {
 840     match binder {
 841         ClosureBinder::NotPresent => {}
 842         ClosureBinder::For { span: _, generic_params } => {
 843             let mut vec = std::mem::take(generic_params).into_vec();
 844             vec.flat_map_in_place(|param| vis.flat_map_generic_param(param));
 845             *generic_params = P::from_vec(vec);
 846         }
 847     }
 848 }
 849
 850 pub fn noop_visit_asyncness<T: MutVisitor>(asyncness: &mut Async, vis: &mut T) {
 851     match asyncness {
 852         Async::Yes { span: _, closure_id, return_impl_trait_id } => {
 853             vis.visit_id(closure_id);
 854             vis.visit_id(return_impl_trait_id);
 855         }
 856         Async::No => {}
 857     }
 858 }
 859
 860 pub fn noop_visit_fn_decl<T: MutVisitor>(decl: &mut P<FnDecl>, vis: &mut T) {
 861     let FnDecl { inputs, output } = decl.deref_mut();
 862     inputs.flat_map_in_place(|param| vis.flat_map_param(param));
 863     noop_visit_fn_ret_ty(output, vis);
 864 }
 865
 866 pub fn noop_visit_fn_ret_ty<T: MutVisitor>(fn_ret_ty: &mut FnRetTy, vis: &mut T) {
 867     match fn_ret_ty {
 868         FnRetTy::Default(span) => vis.visit_span(span),
 869         FnRetTy::Ty(ty) => vis.visit_ty(ty),
 870     }
 871 }
 872
 873 pub fn noop_visit_param_bound<T: MutVisitor>(pb: &mut GenericBound, vis: &mut T) {
 874     match pb {
 875         GenericBound::Trait(ty, _modifier) => vis.visit_poly_trait_ref(ty),
 876         GenericBound::Outlives(lifetime) => noop_visit_lifetime(lifetime, vis),
 877     }
 878 }
 879
 880 pub fn noop_flat_map_generic_param<T: MutVisitor>(
 881     mut param: GenericParam,
 882     vis: &mut T,
 883 ) -> SmallVec<[GenericParam; 1]> {
 884     let GenericParam { id, ident, attrs, bounds, kind, colon_span, is_placeholder: _ } = &mut param;
 885     vis.visit_id(id);
 886     vis.visit_ident(ident);
 887     if let Some(colon_span) = colon_span {
 888         vis.visit_span(colon_span);
 889     }
 890     visit_attrs(attrs, vis);
 891     visit_vec(bounds, |bound| noop_visit_param_bound(bound, vis));
 892     match kind {
 893         GenericParamKind::Lifetime => {}
 894         GenericParamKind::Type { default } => {
 895             visit_opt(default, |default| vis.visit_ty(default));
 896         }
 897         GenericParamKind::Const { ty, kw_span: _, default } => {
 898             vis.visit_ty(ty);
 899             visit_opt(default, |default| vis.visit_anon_const(default));
 900         }
 901     }
 902     smallvec![param]
 903 }
 904
 905 pub fn noop_visit_label<T: MutVisitor>(Label { ident }: &mut Label, vis: &mut T) {
 906     vis.visit_ident(ident);
 907 }
 908
 909 fn noop_visit_lifetime<T: MutVisitor>(Lifetime { id, ident }: &mut Lifetime, vis: &mut T) {
 910     vis.visit_id(id);
 911     vis.visit_ident(ident);
 912 }
 913
 914 pub fn noop_visit_generics<T: MutVisitor>(generics: &mut Generics, vis: &mut T) {
 915     let Generics { params, where_clause, span } = generics;
 916     params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
 917     vis.visit_where_clause(where_clause);
 918     vis.visit_span(span);
 919 }
 920
 921 pub fn noop_visit_where_clause<T: MutVisitor>(wc: &mut WhereClause, vis: &mut T) {
 922     let WhereClause { has_where_token: _, predicates, span } = wc;
 923     visit_vec(predicates, |predicate| vis.visit_where_predicate(predicate));
 924     vis.visit_span(span);
 925 }
 926
 927 pub fn noop_visit_where_predicate<T: MutVisitor>(pred: &mut WherePredicate, vis: &mut T) {
 928     match pred {
 929         WherePredicate::BoundPredicate(bp) => {
 930             let WhereBoundPredicate { span, bound_generic_params, bounded_ty, bounds } = bp;
 931             vis.visit_span(span);
 932             bound_generic_params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
 933             vis.visit_ty(bounded_ty);
 934             visit_vec(bounds, |bound| vis.visit_param_bound(bound));
 935         }
 936         WherePredicate::RegionPredicate(rp) => {
 937             let WhereRegionPredicate { span, lifetime, bounds } = rp;
 938             vis.visit_span(span);
 939             noop_visit_lifetime(lifetime, vis);
 940             visit_vec(bounds, |bound| noop_visit_param_bound(bound, vis));
 941         }
 942         WherePredicate::EqPredicate(ep) => {
 943             let WhereEqPredicate { span, lhs_ty, rhs_ty } = ep;
 944             vis.visit_span(span);
 945             vis.visit_ty(lhs_ty);
 946             vis.visit_ty(rhs_ty);
 947         }
 948     }
 949 }
 950
 951 pub fn noop_visit_variant_data<T: MutVisitor>(vdata: &mut VariantData, vis: &mut T) {
 952     match vdata {
 953         VariantData::Struct(fields, ..) => {
 954             fields.flat_map_in_place(|field| vis.flat_map_field_def(field));
 955         }
 956         VariantData::Tuple(fields, id) => {
 957             fields.flat_map_in_place(|field| vis.flat_map_field_def(field));
 958             vis.visit_id(id);
 959         }
 960         VariantData::Unit(id) => vis.visit_id(id),
 961     }
 962 }
 963
 964 pub fn noop_visit_trait_ref<T: MutVisitor>(TraitRef { path, ref_id }: &mut TraitRef, vis: &mut T) {
 965     vis.visit_path(path);
 966     vis.visit_id(ref_id);
 967 }
 968
 969 pub fn noop_visit_poly_trait_ref<T: MutVisitor>(p: &mut PolyTraitRef, vis: &mut T) {
 970     let PolyTraitRef { bound_generic_params, trait_ref, span } = p;
 971     bound_generic_params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
 972     vis.visit_trait_ref(trait_ref);
 973     vis.visit_span(span);
 974 }
 975
 976 pub fn noop_flat_map_field_def<T: MutVisitor>(
 977     mut fd: FieldDef,
 978     visitor: &mut T,
 979 ) -> SmallVec<[FieldDef; 1]> {
 980     let FieldDef { span, ident, vis, id, ty, attrs, is_placeholder: _ } = &mut fd;
 981     visitor.visit_span(span);
 982     visit_opt(ident, |ident| visitor.visit_ident(ident));
 983     visitor.visit_vis(vis);
 984     visitor.visit_id(id);
 985     visitor.visit_ty(ty);
 986     visit_attrs(attrs, visitor);
 987     smallvec![fd]
 988 }
 989
 990 pub fn noop_flat_map_expr_field<T: MutVisitor>(
 991     mut f: ExprField,
 992     vis: &mut T,
 993 ) -> SmallVec<[ExprField; 1]> {
 994     let ExprField { ident, expr, span, is_shorthand: _, attrs, id, is_placeholder: _ } = &mut f;
 995     vis.visit_ident(ident);
 996     vis.visit_expr(expr);
 997     vis.visit_id(id);
 998     vis.visit_span(span);
 999     visit_attrs(attrs, vis);
1000     smallvec![f]
1001 }
1002
1003 pub fn noop_visit_mt<T: MutVisitor>(MutTy { ty, mutbl: _ }: &mut MutTy, vis: &mut T) {
1004     vis.visit_ty(ty);
1005 }
1006
1007 pub fn noop_visit_block<T: MutVisitor>(block: &mut P<Block>, vis: &mut T) {
1008     let Block { id, stmts, rules: _, span, tokens, could_be_bare_literal: _ } = block.deref_mut();
1009     vis.visit_id(id);
1010     stmts.flat_map_in_place(|stmt| vis.flat_map_stmt(stmt));
1011     vis.visit_span(span);
1012     visit_lazy_tts(tokens, vis);
1013 }
1014
1015 pub fn noop_visit_item_kind<T: MutVisitor>(kind: &mut ItemKind, vis: &mut T) {
1016     match kind {
1017         ItemKind::ExternCrate(_orig_name) => {}
1018         ItemKind::Use(use_tree) => vis.visit_use_tree(use_tree),
1019         ItemKind::Static(ty, _, expr) => {
1020             vis.visit_ty(ty);
1021             visit_opt(expr, |expr| vis.visit_expr(expr));
1022         }
1023         ItemKind::Const(defaultness, ty, expr) => {
1024             visit_defaultness(defaultness, vis);
1025             vis.visit_ty(ty);
1026             visit_opt(expr, |expr| vis.visit_expr(expr));
1027         }
1028         ItemKind::Fn(box Fn { defaultness, generics, sig, body }) => {
1029             visit_defaultness(defaultness, vis);
1030             visit_fn_sig(sig, vis);
1031             vis.visit_generics(generics);
1032             visit_opt(body, |body| vis.visit_block(body));
1033         }
1034         ItemKind::Mod(unsafety, mod_kind) => {
1035             visit_unsafety(unsafety, vis);
1036             match mod_kind {
1037                 ModKind::Loaded(items, _inline, ModSpans { inner_span, inject_use_span }) => {
1038                     vis.visit_span(inner_span);
1039                     vis.visit_span(inject_use_span);
1040                     items.flat_map_in_place(|item| vis.flat_map_item(item));
1041                 }
1042                 ModKind::Unloaded => {}
1043             }
1044         }
1045         ItemKind::ForeignMod(nm) => vis.visit_foreign_mod(nm),
1046         ItemKind::GlobalAsm(asm) => vis.visit_inline_asm(asm),
1047         ItemKind::TyAlias(box TyAlias {
1048             defaultness, generics, where_clauses, bounds, ty, ..
1049         }) => {
1050             visit_defaultness(defaultness, vis);
1051             vis.visit_generics(generics);
1052             vis.visit_span(&mut where_clauses.0.1);
1053             vis.visit_span(&mut where_clauses.1.1);
1054             visit_bounds(bounds, vis);
1055             visit_opt(ty, |ty| vis.visit_ty(ty));
1056         }
1057         ItemKind::Enum(EnumDef { variants }, generics) => {
1058             variants.flat_map_in_place(|variant| vis.flat_map_variant(variant));
1059             vis.visit_generics(generics);
1060         }
1061         ItemKind::Struct(variant_data, generics) | ItemKind::Union(variant_data, generics) => {
1062             vis.visit_variant_data(variant_data);
1063             vis.visit_generics(generics);
1064         }
1065         ItemKind::Impl(box Impl {
1066             defaultness,
1067             unsafety,
1068             generics,
1069             constness,
1070             polarity,
1071             of_trait,
1072             self_ty,
1073             items,
1074         }) => {
1075             visit_defaultness(defaultness, vis);
1076             visit_unsafety(unsafety, vis);
1077             vis.visit_generics(generics);
1078             visit_constness(constness, vis);
1079             visit_polarity(polarity, vis);
1080             visit_opt(of_trait, |trait_ref| vis.visit_trait_ref(trait_ref));
1081             vis.visit_ty(self_ty);
1082             items.flat_map_in_place(|item| vis.flat_map_impl_item(item));
1083         }
1084         ItemKind::Trait(box Trait { unsafety, is_auto: _, generics, bounds, items }) => {
1085             visit_unsafety(unsafety, vis);
1086             vis.visit_generics(generics);
1087             visit_bounds(bounds, vis);
1088             items.flat_map_in_place(|item| vis.flat_map_trait_item(item));
1089         }
1090         ItemKind::TraitAlias(generics, bounds) => {
1091             vis.visit_generics(generics);
1092             visit_bounds(bounds, vis);
1093         }
1094         ItemKind::MacCall(m) => vis.visit_mac_call(m),
1095         ItemKind::MacroDef(def) => vis.visit_macro_def(def),
1096     }
1097 }
1098
1099 pub fn noop_flat_map_assoc_item<T: MutVisitor>(
1100     mut item: P<AssocItem>,
1101     visitor: &mut T,
1102 ) -> SmallVec<[P<AssocItem>; 1]> {
1103     let Item { id, ident, vis, attrs, kind, span, tokens } = item.deref_mut();
1104     visitor.visit_id(id);
1105     visitor.visit_ident(ident);
1106     visitor.visit_vis(vis);
1107     visit_attrs(attrs, visitor);
1108     match kind {
1109         AssocItemKind::Const(defaultness, ty, expr) => {
1110             visit_defaultness(defaultness, visitor);
1111             visitor.visit_ty(ty);
1112             visit_opt(expr, |expr| visitor.visit_expr(expr));
1113         }
1114         AssocItemKind::Fn(box Fn { defaultness, generics, sig, body }) => {
1115             visit_defaultness(defaultness, visitor);
1116             visitor.visit_generics(generics);
1117             visit_fn_sig(sig, visitor);
1118             visit_opt(body, |body| visitor.visit_block(body));
1119         }
1120         AssocItemKind::Type(box TyAlias {
1121             defaultness,
1122             generics,
1123             where_clauses,
1124             bounds,
1125             ty,
1126             ..
1127         }) => {
1128             visit_defaultness(defaultness, visitor);
1129             visitor.visit_generics(generics);
1130             visitor.visit_span(&mut where_clauses.0.1);
1131             visitor.visit_span(&mut where_clauses.1.1);
1132             visit_bounds(bounds, visitor);
1133             visit_opt(ty, |ty| visitor.visit_ty(ty));
1134         }
1135         AssocItemKind::MacCall(mac) => visitor.visit_mac_call(mac),
1136     }
1137     visitor.visit_span(span);
1138     visit_lazy_tts(tokens, visitor);
1139     smallvec![item]
1140 }
1141
1142 pub fn noop_visit_fn_header<T: MutVisitor>(header: &mut FnHeader, vis: &mut T) {
1143     let FnHeader { unsafety, asyncness, constness, ext: _ } = header;
1144     visit_constness(constness, vis);
1145     vis.visit_asyncness(asyncness);
1146     visit_unsafety(unsafety, vis);
1147 }
1148
1149 pub fn noop_visit_crate<T: MutVisitor>(krate: &mut Crate, vis: &mut T) {
1150     let Crate { attrs, items, spans, id, is_placeholder: _ } = krate;
1151     vis.visit_id(id);
1152     visit_attrs(attrs, vis);
1153     items.flat_map_in_place(|item| vis.flat_map_item(item));
1154     let ModSpans { inner_span, inject_use_span } = spans;
1155     vis.visit_span(inner_span);
1156     vis.visit_span(inject_use_span);
1157 }
1158
1159 // Mutates one item into possibly many items.
1160 pub fn noop_flat_map_item<T: MutVisitor>(
1161     mut item: P<Item>,
1162     visitor: &mut T,
1163 ) -> SmallVec<[P<Item>; 1]> {
1164     let Item { ident, attrs, id, kind, vis, span, tokens } = item.deref_mut();
1165     visitor.visit_ident(ident);
1166     visit_attrs(attrs, visitor);
1167     visitor.visit_id(id);
1168     visitor.visit_item_kind(kind);
1169     visitor.visit_vis(vis);
1170     visitor.visit_span(span);
1171     visit_lazy_tts(tokens, visitor);
1172
1173     smallvec![item]
1174 }
1175
1176 pub fn noop_flat_map_foreign_item<T: MutVisitor>(
1177     mut item: P<ForeignItem>,
1178     visitor: &mut T,
1179 ) -> SmallVec<[P<ForeignItem>; 1]> {
1180     let Item { ident, attrs, id, kind, vis, span, tokens } = item.deref_mut();
1181     visitor.visit_id(id);
1182     visitor.visit_ident(ident);
1183     visitor.visit_vis(vis);
1184     visit_attrs(attrs, visitor);
1185     match kind {
1186         ForeignItemKind::Static(ty, _, expr) => {
1187             visitor.visit_ty(ty);
1188             visit_opt(expr, |expr| visitor.visit_expr(expr));
1189         }
1190         ForeignItemKind::Fn(box Fn { defaultness, generics, sig, body }) => {
1191             visit_defaultness(defaultness, visitor);
1192             visitor.visit_generics(generics);
1193             visit_fn_sig(sig, visitor);
1194             visit_opt(body, |body| visitor.visit_block(body));
1195         }
1196         ForeignItemKind::TyAlias(box TyAlias {
1197             defaultness,
1198             generics,
1199             where_clauses,
1200             bounds,
1201             ty,
1202             ..
1203         }) => {
1204             visit_defaultness(defaultness, visitor);
1205             visitor.visit_generics(generics);
1206             visitor.visit_span(&mut where_clauses.0.1);
1207             visitor.visit_span(&mut where_clauses.1.1);
1208             visit_bounds(bounds, visitor);
1209             visit_opt(ty, |ty| visitor.visit_ty(ty));
1210         }
1211         ForeignItemKind::MacCall(mac) => visitor.visit_mac_call(mac),
1212     }
1213     visitor.visit_span(span);
1214     visit_lazy_tts(tokens, visitor);
1215     smallvec![item]
1216 }
1217
1218 pub fn noop_visit_pat<T: MutVisitor>(pat: &mut P<Pat>, vis: &mut T) {
1219     let Pat { id, kind, span, tokens } = pat.deref_mut();
1220     vis.visit_id(id);
1221     match kind {
1222         PatKind::Wild | PatKind::Rest => {}
1223         PatKind::Ident(_binding_mode, ident, sub) => {
1224             vis.visit_ident(ident);
1225             visit_opt(sub, |sub| vis.visit_pat(sub));
1226         }
1227         PatKind::Lit(e) => vis.visit_expr(e),
1228         PatKind::TupleStruct(qself, path, elems) => {
1229             vis.visit_qself(qself);
1230             vis.visit_path(path);
1231             visit_vec(elems, |elem| vis.visit_pat(elem));
1232         }
1233         PatKind::Path(qself, path) => {
1234             vis.visit_qself(qself);
1235             vis.visit_path(path);
1236         }
1237         PatKind::Struct(qself, path, fields, _etc) => {
1238             vis.visit_qself(qself);
1239             vis.visit_path(path);
1240             fields.flat_map_in_place(|field| vis.flat_map_pat_field(field));
1241         }
1242         PatKind::Box(inner) => vis.visit_pat(inner),
1243         PatKind::Ref(inner, _mutbl) => vis.visit_pat(inner),
1244         PatKind::Range(e1, e2, Spanned { span: _, node: _ }) => {
1245             visit_opt(e1, |e| vis.visit_expr(e));
1246             visit_opt(e2, |e| vis.visit_expr(e));
1247             vis.visit_span(span);
1248         }
1249         PatKind::Tuple(elems) | PatKind::Slice(elems) | PatKind::Or(elems) => {
1250             visit_vec(elems, |elem| vis.visit_pat(elem))
1251         }
1252         PatKind::Paren(inner) => vis.visit_pat(inner),
1253         PatKind::MacCall(mac) => vis.visit_mac_call(mac),
1254     }
1255     vis.visit_span(span);
1256     visit_lazy_tts(tokens, vis);
1257 }
1258
1259 pub fn noop_visit_anon_const<T: MutVisitor>(AnonConst { id, value }: &mut AnonConst, vis: &mut T) {
1260     vis.visit_id(id);
1261     vis.visit_expr(value);
1262 }
1263
1264 pub fn noop_visit_inline_asm<T: MutVisitor>(asm: &mut InlineAsm, vis: &mut T) {
1265     for (op, _) in &mut asm.operands {
1266         match op {
1267             InlineAsmOperand::In { expr, .. }
1268             | InlineAsmOperand::Out { expr: Some(expr), .. }
1269             | InlineAsmOperand::InOut { expr, .. } => vis.visit_expr(expr),
1270             InlineAsmOperand::Out { expr: None, .. } => {}
1271             InlineAsmOperand::SplitInOut { in_expr, out_expr, .. } => {
1272                 vis.visit_expr(in_expr);
1273                 if let Some(out_expr) = out_expr {
1274                     vis.visit_expr(out_expr);
1275                 }
1276             }
1277             InlineAsmOperand::Const { anon_const } => vis.visit_anon_const(anon_const),
1278             InlineAsmOperand::Sym { sym } => vis.visit_inline_asm_sym(sym),
1279         }
1280     }
1281 }
1282
1283 pub fn noop_visit_inline_asm_sym<T: MutVisitor>(
1284     InlineAsmSym { id, qself, path }: &mut InlineAsmSym,
1285     vis: &mut T,
1286 ) {
1287     vis.visit_id(id);
1288     vis.visit_qself(qself);
1289     vis.visit_path(path);
1290 }
1291
1292 pub fn noop_visit_expr<T: MutVisitor>(
1293     Expr { kind, id, span, attrs, tokens }: &mut Expr,
1294     vis: &mut T,
1295 ) {
1296     match kind {
1297         ExprKind::Box(expr) => vis.visit_expr(expr),
1298         ExprKind::Array(exprs) => visit_exprs(exprs, vis),
1299         ExprKind::ConstBlock(anon_const) => {
1300             vis.visit_anon_const(anon_const);
1301         }
1302         ExprKind::Repeat(expr, count) => {
1303             vis.visit_expr(expr);
1304             vis.visit_anon_const(count);
1305         }
1306         ExprKind::Tup(exprs) => visit_exprs(exprs, vis),
1307         ExprKind::Call(f, args) => {
1308             vis.visit_expr(f);
1309             visit_exprs(args, vis);
1310         }
1311         ExprKind::MethodCall(box MethodCall {
1312             seg: PathSegment { ident, id, args: seg_args },
1313             receiver,
1314             args: call_args,
1315             span,
1316         }) => {
1317             vis.visit_ident(ident);
1318             vis.visit_id(id);
1319             visit_opt(seg_args, |args| vis.visit_generic_args(args));
1320             vis.visit_method_receiver_expr(receiver);
1321             visit_exprs(call_args, vis);
1322             vis.visit_span(span);
1323         }
1324         ExprKind::Binary(_binop, lhs, rhs) => {
1325             vis.visit_expr(lhs);
1326             vis.visit_expr(rhs);
1327         }
1328         ExprKind::Unary(_unop, ohs) => vis.visit_expr(ohs),
1329         ExprKind::Cast(expr, ty) => {
1330             vis.visit_expr(expr);
1331             vis.visit_ty(ty);
1332         }
1333         ExprKind::Type(expr, ty) => {
1334             vis.visit_expr(expr);
1335             vis.visit_ty(ty);
1336         }
1337         ExprKind::AddrOf(_, _, ohs) => vis.visit_expr(ohs),
1338         ExprKind::Let(pat, scrutinee, _) => {
1339             vis.visit_pat(pat);
1340             vis.visit_expr(scrutinee);
1341         }
1342         ExprKind::If(cond, tr, fl) => {
1343             vis.visit_expr(cond);
1344             vis.visit_block(tr);
1345             visit_opt(fl, |fl| vis.visit_expr(fl));
1346         }
1347         ExprKind::While(cond, body, label) => {
1348             vis.visit_expr(cond);
1349             vis.visit_block(body);
1350             visit_opt(label, |label| vis.visit_label(label));
1351         }
1352         ExprKind::ForLoop(pat, iter, body, label) => {
1353             vis.visit_pat(pat);
1354             vis.visit_expr(iter);
1355             vis.visit_block(body);
1356             visit_opt(label, |label| vis.visit_label(label));
1357         }
1358         ExprKind::Loop(body, label, span) => {
1359             vis.visit_block(body);
1360             visit_opt(label, |label| vis.visit_label(label));
1361             vis.visit_span(span);
1362         }
1363         ExprKind::Match(expr, arms) => {
1364             vis.visit_expr(expr);
1365             arms.flat_map_in_place(|arm| vis.flat_map_arm(arm));
1366         }
1367         ExprKind::Closure(box Closure {
1368             binder,
1369             capture_clause: _,
1370             asyncness,
1371             movability: _,
1372             fn_decl,
1373             body,
1374             fn_decl_span,
1375         }) => {
1376             vis.visit_closure_binder(binder);
1377             vis.visit_asyncness(asyncness);
1378             vis.visit_fn_decl(fn_decl);
1379             vis.visit_expr(body);
1380             vis.visit_span(fn_decl_span);
1381         }
1382         ExprKind::Block(blk, label) => {
1383             vis.visit_block(blk);
1384             visit_opt(label, |label| vis.visit_label(label));
1385         }
1386         ExprKind::Async(_capture_by, node_id, body) => {
1387             vis.visit_id(node_id);
1388             vis.visit_block(body);
1389         }
1390         ExprKind::Await(expr) => vis.visit_expr(expr),
1391         ExprKind::Assign(el, er, _) => {
1392             vis.visit_expr(el);
1393             vis.visit_expr(er);
1394         }
1395         ExprKind::AssignOp(_op, el, er) => {
1396             vis.visit_expr(el);
1397             vis.visit_expr(er);
1398         }
1399         ExprKind::Field(el, ident) => {
1400             vis.visit_expr(el);
1401             vis.visit_ident(ident);
1402         }
1403         ExprKind::Index(el, er) => {
1404             vis.visit_expr(el);
1405             vis.visit_expr(er);
1406         }
1407         ExprKind::Range(e1, e2, _lim) => {
1408             visit_opt(e1, |e1| vis.visit_expr(e1));
1409             visit_opt(e2, |e2| vis.visit_expr(e2));
1410         }
1411         ExprKind::Underscore => {}
1412         ExprKind::Path(qself, path) => {
1413             vis.visit_qself(qself);
1414             vis.visit_path(path);
1415         }
1416         ExprKind::Break(label, expr) => {
1417             visit_opt(label, |label| vis.visit_label(label));
1418             visit_opt(expr, |expr| vis.visit_expr(expr));
1419         }
1420         ExprKind::Continue(label) => {
1421             visit_opt(label, |label| vis.visit_label(label));
1422         }
1423         ExprKind::Ret(expr) => {
1424             visit_opt(expr, |expr| vis.visit_expr(expr));
1425         }
1426         ExprKind::Yeet(expr) => {
1427             visit_opt(expr, |expr| vis.visit_expr(expr));
1428         }
1429         ExprKind::InlineAsm(asm) => vis.visit_inline_asm(asm),
1430         ExprKind::MacCall(mac) => vis.visit_mac_call(mac),
1431         ExprKind::Struct(se) => {
1432             let StructExpr { qself, path, fields, rest } = se.deref_mut();
1433             vis.visit_qself(qself);
1434             vis.visit_path(path);
1435             fields.flat_map_in_place(|field| vis.flat_map_expr_field(field));
1436             match rest {
1437                 StructRest::Base(expr) => vis.visit_expr(expr),
1438                 StructRest::Rest(_span) => {}
1439                 StructRest::None => {}
1440             }
1441         }
1442         ExprKind::Paren(expr) => {
1443             vis.visit_expr(expr);
1444         }
1445         ExprKind::Yield(expr) => {
1446             visit_opt(expr, |expr| vis.visit_expr(expr));
1447         }
1448         ExprKind::Try(expr) => vis.visit_expr(expr),
1449         ExprKind::TryBlock(body) => vis.visit_block(body),
1450         ExprKind::Lit(_) | ExprKind::IncludedBytes(..) | ExprKind::Err => {}
1451     }
1452     vis.visit_id(id);
1453     vis.visit_span(span);
1454     visit_attrs(attrs, vis);
1455     visit_lazy_tts(tokens, vis);
1456 }
1457
1458 pub fn noop_filter_map_expr<T: MutVisitor>(mut e: P<Expr>, vis: &mut T) -> Option<P<Expr>> {
1459     Some({
1460         vis.visit_expr(&mut e);
1461         e
1462     })
1463 }
1464
1465 pub fn noop_flat_map_stmt<T: MutVisitor>(
1466     Stmt { kind, mut span, mut id }: Stmt,
1467     vis: &mut T,
1468 ) -> SmallVec<[Stmt; 1]> {
1469     vis.visit_id(&mut id);
1470     vis.visit_span(&mut span);
1471     let stmts: SmallVec<_> = noop_flat_map_stmt_kind(kind, vis)
1472         .into_iter()
1473         .map(|kind| Stmt { id, kind, span })
1474         .collect();
1475     if stmts.len() > 1 {
1476         panic!(
1477             "cloning statement `NodeId`s is prohibited by default, \
1478              the visitor should implement custom statement visiting"
1479         );
1480     }
1481     stmts
1482 }
1483
1484 pub fn noop_flat_map_stmt_kind<T: MutVisitor>(
1485     kind: StmtKind,
1486     vis: &mut T,
1487 ) -> SmallVec<[StmtKind; 1]> {
1488     match kind {
1489         StmtKind::Local(mut local) => smallvec![StmtKind::Local({
1490             vis.visit_local(&mut local);
1491             local
1492         })],
1493         StmtKind::Item(item) => vis.flat_map_item(item).into_iter().map(StmtKind::Item).collect(),
1494         StmtKind::Expr(expr) => vis.filter_map_expr(expr).into_iter().map(StmtKind::Expr).collect(),
1495         StmtKind::Semi(expr) => vis.filter_map_expr(expr).into_iter().map(StmtKind::Semi).collect(),
1496         StmtKind::Empty => smallvec![StmtKind::Empty],
1497         StmtKind::MacCall(mut mac) => {
1498             let MacCallStmt { mac: mac_, style: _, attrs, tokens } = mac.deref_mut();
1499             vis.visit_mac_call(mac_);
1500             visit_attrs(attrs, vis);
1501             visit_lazy_tts(tokens, vis);
1502             smallvec![StmtKind::MacCall(mac)]
1503         }
1504     }
1505 }
1506
1507 pub fn noop_visit_vis<T: MutVisitor>(visibility: &mut Visibility, vis: &mut T) {
1508     match &mut visibility.kind {
1509         VisibilityKind::Public | VisibilityKind::Inherited => {}
1510         VisibilityKind::Restricted { path, id, shorthand: _ } => {
1511             vis.visit_path(path);
1512             vis.visit_id(id);
1513         }
1514     }
1515     vis.visit_span(&mut visibility.span);
1516 }
1517
1518 /// Some value for the AST node that is valid but possibly meaningless.
1519 pub trait DummyAstNode {
1520     fn dummy() -> Self;
1521 }
1522
1523 impl<T> DummyAstNode for Option<T> {
1524     fn dummy() -> Self {
1525         Default::default()
1526     }
1527 }
1528
1529 impl<T: DummyAstNode + 'static> DummyAstNode for P<T> {
1530     fn dummy() -> Self {
1531         P(DummyAstNode::dummy())
1532     }
1533 }
1534
1535 impl DummyAstNode for Item {
1536     fn dummy() -> Self {
1537         Item {
1538             attrs: Default::default(),
1539             id: DUMMY_NODE_ID,
1540             span: Default::default(),
1541             vis: Visibility {
1542                 kind: VisibilityKind::Public,
1543                 span: Default::default(),
1544                 tokens: Default::default(),
1545             },
1546             ident: Ident::empty(),
1547             kind: ItemKind::ExternCrate(None),
1548             tokens: Default::default(),
1549         }
1550     }
1551 }
1552
1553 impl DummyAstNode for Expr {
1554     fn dummy() -> Self {
1555         Expr {
1556             id: DUMMY_NODE_ID,
1557             kind: ExprKind::Err,
1558             span: Default::default(),
1559             attrs: Default::default(),
1560             tokens: Default::default(),
1561         }
1562     }
1563 }
1564
1565 impl DummyAstNode for Ty {
1566     fn dummy() -> Self {
1567         Ty {
1568             id: DUMMY_NODE_ID,
1569             kind: TyKind::Err,
1570             span: Default::default(),
1571             tokens: Default::default(),
1572         }
1573     }
1574 }
1575
1576 impl DummyAstNode for Pat {
1577     fn dummy() -> Self {
1578         Pat {
1579             id: DUMMY_NODE_ID,
1580             kind: PatKind::Wild,
1581             span: Default::default(),
1582             tokens: Default::default(),
1583         }
1584     }
1585 }
1586
1587 impl DummyAstNode for Stmt {
1588     fn dummy() -> Self {
1589         Stmt { id: DUMMY_NODE_ID, kind: StmtKind::Empty, span: Default::default() }
1590     }
1591 }
1592
1593 impl DummyAstNode for Block {
1594     fn dummy() -> Self {
1595         Block {
1596             stmts: Default::default(),
1597             id: DUMMY_NODE_ID,
1598             rules: BlockCheckMode::Default,
1599             span: Default::default(),
1600             tokens: Default::default(),
1601             could_be_bare_literal: Default::default(),
1602         }
1603     }
1604 }
1605
1606 impl DummyAstNode for Crate {
1607     fn dummy() -> Self {
1608         Crate {
1609             attrs: Default::default(),
1610             items: Default::default(),
1611             spans: Default::default(),
1612             id: DUMMY_NODE_ID,
1613             is_placeholder: Default::default(),
1614         }
1615     }
1616 }
1617
1618 impl<N: DummyAstNode, T: DummyAstNode> DummyAstNode for crate::ast_traits::AstNodeWrapper<N, T> {
1619     fn dummy() -> Self {
1620         crate::ast_traits::AstNodeWrapper::new(N::dummy(), T::dummy())
1621     }
1622 }