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     fn visit_format_args(&mut self, fmt: &mut FormatArgs) {
 302         noop_visit_format_args(fmt, self)
 303     }
 304 }
 305
 306 /// Use a map-style function (`FnOnce(T) -> T`) to overwrite a `&mut T`. Useful
 307 /// when using a `flat_map_*` or `filter_map_*` method within a `visit_`
 308 /// method.
 309 //
 310 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 311 pub fn visit_clobber<T: DummyAstNode>(t: &mut T, f: impl FnOnce(T) -> T) {
 312     unsafe {
 313         // Safe because `t` is used in a read-only fashion by `read()` before
 314         // being overwritten by `write()`.
 315         let old_t = ptr::read(t);
 316         let new_t =
 317             panic::catch_unwind(panic::AssertUnwindSafe(|| f(old_t))).unwrap_or_else(|err| {
 318                 // Set `t` to some valid but possible meaningless value,
 319                 // and pass the fatal error further.
 320                 ptr::write(t, T::dummy());
 321                 panic::resume_unwind(err);
 322             });
 323         ptr::write(t, new_t);
 324     }
 325 }
 326
 327 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 328 #[inline]
 329 pub fn visit_vec<T, F>(elems: &mut Vec<T>, mut visit_elem: F)
 330 where
 331     F: FnMut(&mut T),
 332 {
 333     for elem in elems {
 334         visit_elem(elem);
 335     }
 336 }
 337
 338 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 339 #[inline]
 340 pub fn visit_opt<T, F>(opt: &mut Option<T>, mut visit_elem: F)
 341 where
 342     F: FnMut(&mut T),
 343 {
 344     if let Some(elem) = opt {
 345         visit_elem(elem);
 346     }
 347 }
 348
 349 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 350 pub fn visit_attrs<T: MutVisitor>(attrs: &mut AttrVec, vis: &mut T) {
 351     for attr in attrs.iter_mut() {
 352         vis.visit_attribute(attr);
 353     }
 354 }
 355
 356 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 357 pub fn visit_exprs<T: MutVisitor>(exprs: &mut Vec<P<Expr>>, vis: &mut T) {
 358     exprs.flat_map_in_place(|expr| vis.filter_map_expr(expr))
 359 }
 360
 361 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 362 pub fn visit_bounds<T: MutVisitor>(bounds: &mut GenericBounds, vis: &mut T) {
 363     visit_vec(bounds, |bound| vis.visit_param_bound(bound));
 364 }
 365
 366 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 367 pub fn visit_fn_sig<T: MutVisitor>(FnSig { header, decl, span }: &mut FnSig, vis: &mut T) {
 368     vis.visit_fn_header(header);
 369     vis.visit_fn_decl(decl);
 370     vis.visit_span(span);
 371 }
 372
 373 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 374 pub fn visit_attr_args<T: MutVisitor>(args: &mut AttrArgs, vis: &mut T) {
 375     match args {
 376         AttrArgs::Empty => {}
 377         AttrArgs::Delimited(args) => visit_delim_args(args, vis),
 378         AttrArgs::Eq(eq_span, AttrArgsEq::Ast(expr)) => {
 379             vis.visit_span(eq_span);
 380             vis.visit_expr(expr);
 381         }
 382         AttrArgs::Eq(_, AttrArgsEq::Hir(lit)) => {
 383             unreachable!("in literal form when visiting mac args eq: {:?}", lit)
 384         }
 385     }
 386 }
 387
 388 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 389 pub fn visit_delim_args<T: MutVisitor>(args: &mut DelimArgs, vis: &mut T) {
 390     let DelimArgs { dspan, delim: _, tokens } = args;
 391     visit_delim_span(dspan, vis);
 392     visit_tts(tokens, vis);
 393 }
 394
 395 pub fn visit_delim_span<T: MutVisitor>(dspan: &mut DelimSpan, vis: &mut T) {
 396     vis.visit_span(&mut dspan.open);
 397     vis.visit_span(&mut dspan.close);
 398 }
 399
 400 pub fn noop_flat_map_pat_field<T: MutVisitor>(
 401     mut fp: PatField,
 402     vis: &mut T,
 403 ) -> SmallVec<[PatField; 1]> {
 404     let PatField { attrs, id, ident, is_placeholder: _, is_shorthand: _, pat, span } = &mut fp;
 405     vis.visit_id(id);
 406     vis.visit_ident(ident);
 407     vis.visit_pat(pat);
 408     vis.visit_span(span);
 409     visit_attrs(attrs, vis);
 410     smallvec![fp]
 411 }
 412
 413 pub fn noop_visit_use_tree<T: MutVisitor>(use_tree: &mut UseTree, vis: &mut T) {
 414     let UseTree { prefix, kind, span } = use_tree;
 415     vis.visit_path(prefix);
 416     match kind {
 417         UseTreeKind::Simple(rename) => visit_opt(rename, |rename| vis.visit_ident(rename)),
 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::Ref(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             visit_nonterminal(Lrc::make_mut(nt), vis);
 744         }
 745         _ => {}
 746     }
 747     vis.visit_span(span);
 748 }
 749
 750 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 751 /// Applies the visitor to elements of interpolated nodes.
 752 //
 753 // N.B., this can occur only when applying a visitor to partially expanded
 754 // code, where parsed pieces have gotten implanted ito *other* macro
 755 // invocations. This is relevant for macro hygiene, but possibly not elsewhere.
 756 //
 757 // One problem here occurs because the types for flat_map_item, flat_map_stmt,
 758 // etc., allow the visitor to return *multiple* items; this is a problem for the
 759 // nodes here, because they insist on having exactly one piece. One solution
 760 // would be to mangle the MutVisitor trait to include one-to-many and
 761 // one-to-one versions of these entry points, but that would probably confuse a
 762 // lot of people and help very few. Instead, I'm just going to put in dynamic
 763 // checks. I think the performance impact of this will be pretty much
 764 // nonexistent. The danger is that someone will apply a `MutVisitor` to a
 765 // partially expanded node, and will be confused by the fact that their
 766 // `flat_map_item` or `flat_map_stmt` isn't getting called on `NtItem` or `NtStmt`
 767 // nodes. Hopefully they'll wind up reading this comment, and doing something
 768 // appropriate.
 769 //
 770 // BTW, design choice: I considered just changing the type of, e.g., `NtItem` to
 771 // contain multiple items, but decided against it when I looked at
 772 // `parse_item_or_view_item` and tried to figure out what I would do with
 773 // multiple items there....
 774 pub fn visit_nonterminal<T: MutVisitor>(nt: &mut token::Nonterminal, vis: &mut T) {
 775     match nt {
 776         token::NtItem(item) => visit_clobber(item, |item| {
 777             // This is probably okay, because the only visitors likely to
 778             // peek inside interpolated nodes will be renamings/markings,
 779             // which map single items to single items.
 780             vis.flat_map_item(item).expect_one("expected visitor to produce exactly one item")
 781         }),
 782         token::NtBlock(block) => vis.visit_block(block),
 783         token::NtStmt(stmt) => visit_clobber(stmt, |stmt| {
 784             // See reasoning above.
 785             stmt.map(|stmt| {
 786                 vis.flat_map_stmt(stmt).expect_one("expected visitor to produce exactly one item")
 787             })
 788         }),
 789         token::NtPat(pat) => vis.visit_pat(pat),
 790         token::NtExpr(expr) => vis.visit_expr(expr),
 791         token::NtTy(ty) => vis.visit_ty(ty),
 792         token::NtIdent(ident, _is_raw) => vis.visit_ident(ident),
 793         token::NtLifetime(ident) => vis.visit_ident(ident),
 794         token::NtLiteral(expr) => vis.visit_expr(expr),
 795         token::NtMeta(item) => {
 796             let AttrItem { path, args, tokens } = item.deref_mut();
 797             vis.visit_path(path);
 798             visit_attr_args(args, vis);
 799             visit_lazy_tts(tokens, vis);
 800         }
 801         token::NtPath(path) => vis.visit_path(path),
 802         token::NtVis(visib) => vis.visit_vis(visib),
 803     }
 804 }
 805
 806 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 807 pub fn visit_defaultness<T: MutVisitor>(defaultness: &mut Defaultness, vis: &mut T) {
 808     match defaultness {
 809         Defaultness::Default(span) => vis.visit_span(span),
 810         Defaultness::Final => {}
 811     }
 812 }
 813
 814 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 815 pub fn visit_unsafety<T: MutVisitor>(unsafety: &mut Unsafe, vis: &mut T) {
 816     match unsafety {
 817         Unsafe::Yes(span) => vis.visit_span(span),
 818         Unsafe::No => {}
 819     }
 820 }
 821
 822 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 823 pub fn visit_polarity<T: MutVisitor>(polarity: &mut ImplPolarity, vis: &mut T) {
 824     match polarity {
 825         ImplPolarity::Positive => {}
 826         ImplPolarity::Negative(span) => vis.visit_span(span),
 827     }
 828 }
 829
 830 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
 831 pub fn visit_constness<T: MutVisitor>(constness: &mut Const, vis: &mut T) {
 832     match constness {
 833         Const::Yes(span) => vis.visit_span(span),
 834         Const::No => {}
 835     }
 836 }
 837
 838 pub fn noop_visit_closure_binder<T: MutVisitor>(binder: &mut ClosureBinder, vis: &mut T) {
 839     match binder {
 840         ClosureBinder::NotPresent => {}
 841         ClosureBinder::For { span: _, generic_params } => {
 842             let mut vec = std::mem::take(generic_params).into_vec();
 843             vec.flat_map_in_place(|param| vis.flat_map_generic_param(param));
 844             *generic_params = P::from_vec(vec);
 845         }
 846     }
 847 }
 848
 849 pub fn noop_visit_asyncness<T: MutVisitor>(asyncness: &mut Async, vis: &mut T) {
 850     match asyncness {
 851         Async::Yes { span: _, closure_id, return_impl_trait_id } => {
 852             vis.visit_id(closure_id);
 853             vis.visit_id(return_impl_trait_id);
 854         }
 855         Async::No => {}
 856     }
 857 }
 858
 859 pub fn noop_visit_fn_decl<T: MutVisitor>(decl: &mut P<FnDecl>, vis: &mut T) {
 860     let FnDecl { inputs, output } = decl.deref_mut();
 861     inputs.flat_map_in_place(|param| vis.flat_map_param(param));
 862     noop_visit_fn_ret_ty(output, vis);
 863 }
 864
 865 pub fn noop_visit_fn_ret_ty<T: MutVisitor>(fn_ret_ty: &mut FnRetTy, vis: &mut T) {
 866     match fn_ret_ty {
 867         FnRetTy::Default(span) => vis.visit_span(span),
 868         FnRetTy::Ty(ty) => vis.visit_ty(ty),
 869     }
 870 }
 871
 872 pub fn noop_visit_param_bound<T: MutVisitor>(pb: &mut GenericBound, vis: &mut T) {
 873     match pb {
 874         GenericBound::Trait(ty, _modifier) => vis.visit_poly_trait_ref(ty),
 875         GenericBound::Outlives(lifetime) => noop_visit_lifetime(lifetime, vis),
 876     }
 877 }
 878
 879 pub fn noop_flat_map_generic_param<T: MutVisitor>(
 880     mut param: GenericParam,
 881     vis: &mut T,
 882 ) -> SmallVec<[GenericParam; 1]> {
 883     let GenericParam { id, ident, attrs, bounds, kind, colon_span, is_placeholder: _ } = &mut param;
 884     vis.visit_id(id);
 885     vis.visit_ident(ident);
 886     if let Some(colon_span) = colon_span {
 887         vis.visit_span(colon_span);
 888     }
 889     visit_attrs(attrs, vis);
 890     visit_vec(bounds, |bound| noop_visit_param_bound(bound, vis));
 891     match kind {
 892         GenericParamKind::Lifetime => {}
 893         GenericParamKind::Type { default } => {
 894             visit_opt(default, |default| vis.visit_ty(default));
 895         }
 896         GenericParamKind::Const { ty, kw_span: _, default } => {
 897             vis.visit_ty(ty);
 898             visit_opt(default, |default| vis.visit_anon_const(default));
 899         }
 900     }
 901     smallvec![param]
 902 }
 903
 904 pub fn noop_visit_label<T: MutVisitor>(Label { ident }: &mut Label, vis: &mut T) {
 905     vis.visit_ident(ident);
 906 }
 907
 908 fn noop_visit_lifetime<T: MutVisitor>(Lifetime { id, ident }: &mut Lifetime, vis: &mut T) {
 909     vis.visit_id(id);
 910     vis.visit_ident(ident);
 911 }
 912
 913 pub fn noop_visit_generics<T: MutVisitor>(generics: &mut Generics, vis: &mut T) {
 914     let Generics { params, where_clause, span } = generics;
 915     params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
 916     vis.visit_where_clause(where_clause);
 917     vis.visit_span(span);
 918 }
 919
 920 pub fn noop_visit_where_clause<T: MutVisitor>(wc: &mut WhereClause, vis: &mut T) {
 921     let WhereClause { has_where_token: _, predicates, span } = wc;
 922     visit_vec(predicates, |predicate| vis.visit_where_predicate(predicate));
 923     vis.visit_span(span);
 924 }
 925
 926 pub fn noop_visit_where_predicate<T: MutVisitor>(pred: &mut WherePredicate, vis: &mut T) {
 927     match pred {
 928         WherePredicate::BoundPredicate(bp) => {
 929             let WhereBoundPredicate { span, bound_generic_params, bounded_ty, bounds } = bp;
 930             vis.visit_span(span);
 931             bound_generic_params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
 932             vis.visit_ty(bounded_ty);
 933             visit_vec(bounds, |bound| vis.visit_param_bound(bound));
 934         }
 935         WherePredicate::RegionPredicate(rp) => {
 936             let WhereRegionPredicate { span, lifetime, bounds } = rp;
 937             vis.visit_span(span);
 938             noop_visit_lifetime(lifetime, vis);
 939             visit_vec(bounds, |bound| noop_visit_param_bound(bound, vis));
 940         }
 941         WherePredicate::EqPredicate(ep) => {
 942             let WhereEqPredicate { span, lhs_ty, rhs_ty } = ep;
 943             vis.visit_span(span);
 944             vis.visit_ty(lhs_ty);
 945             vis.visit_ty(rhs_ty);
 946         }
 947     }
 948 }
 949
 950 pub fn noop_visit_variant_data<T: MutVisitor>(vdata: &mut VariantData, vis: &mut T) {
 951     match vdata {
 952         VariantData::Struct(fields, ..) => {
 953             fields.flat_map_in_place(|field| vis.flat_map_field_def(field));
 954         }
 955         VariantData::Tuple(fields, id) => {
 956             fields.flat_map_in_place(|field| vis.flat_map_field_def(field));
 957             vis.visit_id(id);
 958         }
 959         VariantData::Unit(id) => vis.visit_id(id),
 960     }
 961 }
 962
 963 pub fn noop_visit_trait_ref<T: MutVisitor>(TraitRef { path, ref_id }: &mut TraitRef, vis: &mut T) {
 964     vis.visit_path(path);
 965     vis.visit_id(ref_id);
 966 }
 967
 968 pub fn noop_visit_poly_trait_ref<T: MutVisitor>(p: &mut PolyTraitRef, vis: &mut T) {
 969     let PolyTraitRef { bound_generic_params, trait_ref, span } = p;
 970     bound_generic_params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
 971     vis.visit_trait_ref(trait_ref);
 972     vis.visit_span(span);
 973 }
 974
 975 pub fn noop_flat_map_field_def<T: MutVisitor>(
 976     mut fd: FieldDef,
 977     visitor: &mut T,
 978 ) -> SmallVec<[FieldDef; 1]> {
 979     let FieldDef { span, ident, vis, id, ty, attrs, is_placeholder: _ } = &mut fd;
 980     visitor.visit_span(span);
 981     visit_opt(ident, |ident| visitor.visit_ident(ident));
 982     visitor.visit_vis(vis);
 983     visitor.visit_id(id);
 984     visitor.visit_ty(ty);
 985     visit_attrs(attrs, visitor);
 986     smallvec![fd]
 987 }
 988
 989 pub fn noop_flat_map_expr_field<T: MutVisitor>(
 990     mut f: ExprField,
 991     vis: &mut T,
 992 ) -> SmallVec<[ExprField; 1]> {
 993     let ExprField { ident, expr, span, is_shorthand: _, attrs, id, is_placeholder: _ } = &mut f;
 994     vis.visit_ident(ident);
 995     vis.visit_expr(expr);
 996     vis.visit_id(id);
 997     vis.visit_span(span);
 998     visit_attrs(attrs, vis);
 999     smallvec![f]
1000 }
1001
1002 pub fn noop_visit_mt<T: MutVisitor>(MutTy { ty, mutbl: _ }: &mut MutTy, vis: &mut T) {
1003     vis.visit_ty(ty);
1004 }
1005
1006 pub fn noop_visit_block<T: MutVisitor>(block: &mut P<Block>, vis: &mut T) {
1007     let Block { id, stmts, rules: _, span, tokens, could_be_bare_literal: _ } = block.deref_mut();
1008     vis.visit_id(id);
1009     stmts.flat_map_in_place(|stmt| vis.flat_map_stmt(stmt));
1010     vis.visit_span(span);
1011     visit_lazy_tts(tokens, vis);
1012 }
1013
1014 pub fn noop_visit_item_kind<T: MutVisitor>(kind: &mut ItemKind, vis: &mut T) {
1015     match kind {
1016         ItemKind::ExternCrate(_orig_name) => {}
1017         ItemKind::Use(use_tree) => vis.visit_use_tree(use_tree),
1018         ItemKind::Static(ty, _, expr) => {
1019             vis.visit_ty(ty);
1020             visit_opt(expr, |expr| vis.visit_expr(expr));
1021         }
1022         ItemKind::Const(defaultness, ty, expr) => {
1023             visit_defaultness(defaultness, vis);
1024             vis.visit_ty(ty);
1025             visit_opt(expr, |expr| vis.visit_expr(expr));
1026         }
1027         ItemKind::Fn(box Fn { defaultness, generics, sig, body }) => {
1028             visit_defaultness(defaultness, vis);
1029             visit_fn_sig(sig, vis);
1030             vis.visit_generics(generics);
1031             visit_opt(body, |body| vis.visit_block(body));
1032         }
1033         ItemKind::Mod(unsafety, mod_kind) => {
1034             visit_unsafety(unsafety, vis);
1035             match mod_kind {
1036                 ModKind::Loaded(items, _inline, ModSpans { inner_span, inject_use_span }) => {
1037                     vis.visit_span(inner_span);
1038                     vis.visit_span(inject_use_span);
1039                     items.flat_map_in_place(|item| vis.flat_map_item(item));
1040                 }
1041                 ModKind::Unloaded => {}
1042             }
1043         }
1044         ItemKind::ForeignMod(nm) => vis.visit_foreign_mod(nm),
1045         ItemKind::GlobalAsm(asm) => vis.visit_inline_asm(asm),
1046         ItemKind::TyAlias(box TyAlias {
1047             defaultness, generics, where_clauses, bounds, ty, ..
1048         }) => {
1049             visit_defaultness(defaultness, vis);
1050             vis.visit_generics(generics);
1051             vis.visit_span(&mut where_clauses.0.1);
1052             vis.visit_span(&mut where_clauses.1.1);
1053             visit_bounds(bounds, vis);
1054             visit_opt(ty, |ty| vis.visit_ty(ty));
1055         }
1056         ItemKind::Enum(EnumDef { variants }, generics) => {
1057             variants.flat_map_in_place(|variant| vis.flat_map_variant(variant));
1058             vis.visit_generics(generics);
1059         }
1060         ItemKind::Struct(variant_data, generics) | ItemKind::Union(variant_data, generics) => {
1061             vis.visit_variant_data(variant_data);
1062             vis.visit_generics(generics);
1063         }
1064         ItemKind::Impl(box Impl {
1065             defaultness,
1066             unsafety,
1067             generics,
1068             constness,
1069             polarity,
1070             of_trait,
1071             self_ty,
1072             items,
1073         }) => {
1074             visit_defaultness(defaultness, vis);
1075             visit_unsafety(unsafety, vis);
1076             vis.visit_generics(generics);
1077             visit_constness(constness, vis);
1078             visit_polarity(polarity, vis);
1079             visit_opt(of_trait, |trait_ref| vis.visit_trait_ref(trait_ref));
1080             vis.visit_ty(self_ty);
1081             items.flat_map_in_place(|item| vis.flat_map_impl_item(item));
1082         }
1083         ItemKind::Trait(box Trait { unsafety, is_auto: _, generics, bounds, items }) => {
1084             visit_unsafety(unsafety, vis);
1085             vis.visit_generics(generics);
1086             visit_bounds(bounds, vis);
1087             items.flat_map_in_place(|item| vis.flat_map_trait_item(item));
1088         }
1089         ItemKind::TraitAlias(generics, bounds) => {
1090             vis.visit_generics(generics);
1091             visit_bounds(bounds, vis);
1092         }
1093         ItemKind::MacCall(m) => vis.visit_mac_call(m),
1094         ItemKind::MacroDef(def) => vis.visit_macro_def(def),
1095     }
1096 }
1097
1098 pub fn noop_flat_map_assoc_item<T: MutVisitor>(
1099     mut item: P<AssocItem>,
1100     visitor: &mut T,
1101 ) -> SmallVec<[P<AssocItem>; 1]> {
1102     let Item { id, ident, vis, attrs, kind, span, tokens } = item.deref_mut();
1103     visitor.visit_id(id);
1104     visitor.visit_ident(ident);
1105     visitor.visit_vis(vis);
1106     visit_attrs(attrs, visitor);
1107     match kind {
1108         AssocItemKind::Const(defaultness, ty, expr) => {
1109             visit_defaultness(defaultness, visitor);
1110             visitor.visit_ty(ty);
1111             visit_opt(expr, |expr| visitor.visit_expr(expr));
1112         }
1113         AssocItemKind::Fn(box Fn { defaultness, generics, sig, body }) => {
1114             visit_defaultness(defaultness, visitor);
1115             visitor.visit_generics(generics);
1116             visit_fn_sig(sig, visitor);
1117             visit_opt(body, |body| visitor.visit_block(body));
1118         }
1119         AssocItemKind::Type(box TyAlias {
1120             defaultness,
1121             generics,
1122             where_clauses,
1123             bounds,
1124             ty,
1125             ..
1126         }) => {
1127             visit_defaultness(defaultness, visitor);
1128             visitor.visit_generics(generics);
1129             visitor.visit_span(&mut where_clauses.0.1);
1130             visitor.visit_span(&mut where_clauses.1.1);
1131             visit_bounds(bounds, visitor);
1132             visit_opt(ty, |ty| visitor.visit_ty(ty));
1133         }
1134         AssocItemKind::MacCall(mac) => visitor.visit_mac_call(mac),
1135     }
1136     visitor.visit_span(span);
1137     visit_lazy_tts(tokens, visitor);
1138     smallvec![item]
1139 }
1140
1141 pub fn noop_visit_fn_header<T: MutVisitor>(header: &mut FnHeader, vis: &mut T) {
1142     let FnHeader { unsafety, asyncness, constness, ext: _ } = header;
1143     visit_constness(constness, vis);
1144     vis.visit_asyncness(asyncness);
1145     visit_unsafety(unsafety, vis);
1146 }
1147
1148 pub fn noop_visit_crate<T: MutVisitor>(krate: &mut Crate, vis: &mut T) {
1149     let Crate { attrs, items, spans, id, is_placeholder: _ } = krate;
1150     vis.visit_id(id);
1151     visit_attrs(attrs, vis);
1152     items.flat_map_in_place(|item| vis.flat_map_item(item));
1153     let ModSpans { inner_span, inject_use_span } = spans;
1154     vis.visit_span(inner_span);
1155     vis.visit_span(inject_use_span);
1156 }
1157
1158 // Mutates one item into possibly many items.
1159 pub fn noop_flat_map_item<T: MutVisitor>(
1160     mut item: P<Item>,
1161     visitor: &mut T,
1162 ) -> SmallVec<[P<Item>; 1]> {
1163     let Item { ident, attrs, id, kind, vis, span, tokens } = item.deref_mut();
1164     visitor.visit_ident(ident);
1165     visit_attrs(attrs, visitor);
1166     visitor.visit_id(id);
1167     visitor.visit_item_kind(kind);
1168     visitor.visit_vis(vis);
1169     visitor.visit_span(span);
1170     visit_lazy_tts(tokens, visitor);
1171
1172     smallvec![item]
1173 }
1174
1175 pub fn noop_flat_map_foreign_item<T: MutVisitor>(
1176     mut item: P<ForeignItem>,
1177     visitor: &mut T,
1178 ) -> SmallVec<[P<ForeignItem>; 1]> {
1179     let Item { ident, attrs, id, kind, vis, span, tokens } = item.deref_mut();
1180     visitor.visit_id(id);
1181     visitor.visit_ident(ident);
1182     visitor.visit_vis(vis);
1183     visit_attrs(attrs, visitor);
1184     match kind {
1185         ForeignItemKind::Static(ty, _, expr) => {
1186             visitor.visit_ty(ty);
1187             visit_opt(expr, |expr| visitor.visit_expr(expr));
1188         }
1189         ForeignItemKind::Fn(box Fn { defaultness, generics, sig, body }) => {
1190             visit_defaultness(defaultness, visitor);
1191             visitor.visit_generics(generics);
1192             visit_fn_sig(sig, visitor);
1193             visit_opt(body, |body| visitor.visit_block(body));
1194         }
1195         ForeignItemKind::TyAlias(box TyAlias {
1196             defaultness,
1197             generics,
1198             where_clauses,
1199             bounds,
1200             ty,
1201             ..
1202         }) => {
1203             visit_defaultness(defaultness, visitor);
1204             visitor.visit_generics(generics);
1205             visitor.visit_span(&mut where_clauses.0.1);
1206             visitor.visit_span(&mut where_clauses.1.1);
1207             visit_bounds(bounds, visitor);
1208             visit_opt(ty, |ty| visitor.visit_ty(ty));
1209         }
1210         ForeignItemKind::MacCall(mac) => visitor.visit_mac_call(mac),
1211     }
1212     visitor.visit_span(span);
1213     visit_lazy_tts(tokens, visitor);
1214     smallvec![item]
1215 }
1216
1217 pub fn noop_visit_pat<T: MutVisitor>(pat: &mut P<Pat>, vis: &mut T) {
1218     let Pat { id, kind, span, tokens } = pat.deref_mut();
1219     vis.visit_id(id);
1220     match kind {
1221         PatKind::Wild | PatKind::Rest => {}
1222         PatKind::Ident(_binding_mode, ident, sub) => {
1223             vis.visit_ident(ident);
1224             visit_opt(sub, |sub| vis.visit_pat(sub));
1225         }
1226         PatKind::Lit(e) => vis.visit_expr(e),
1227         PatKind::TupleStruct(qself, path, elems) => {
1228             vis.visit_qself(qself);
1229             vis.visit_path(path);
1230             visit_vec(elems, |elem| vis.visit_pat(elem));
1231         }
1232         PatKind::Path(qself, path) => {
1233             vis.visit_qself(qself);
1234             vis.visit_path(path);
1235         }
1236         PatKind::Struct(qself, path, fields, _etc) => {
1237             vis.visit_qself(qself);
1238             vis.visit_path(path);
1239             fields.flat_map_in_place(|field| vis.flat_map_pat_field(field));
1240         }
1241         PatKind::Box(inner) => vis.visit_pat(inner),
1242         PatKind::Ref(inner, _mutbl) => vis.visit_pat(inner),
1243         PatKind::Range(e1, e2, Spanned { span: _, node: _ }) => {
1244             visit_opt(e1, |e| vis.visit_expr(e));
1245             visit_opt(e2, |e| vis.visit_expr(e));
1246             vis.visit_span(span);
1247         }
1248         PatKind::Tuple(elems) | PatKind::Slice(elems) | PatKind::Or(elems) => {
1249             visit_vec(elems, |elem| vis.visit_pat(elem))
1250         }
1251         PatKind::Paren(inner) => vis.visit_pat(inner),
1252         PatKind::MacCall(mac) => vis.visit_mac_call(mac),
1253     }
1254     vis.visit_span(span);
1255     visit_lazy_tts(tokens, vis);
1256 }
1257
1258 pub fn noop_visit_anon_const<T: MutVisitor>(AnonConst { id, value }: &mut AnonConst, vis: &mut T) {
1259     vis.visit_id(id);
1260     vis.visit_expr(value);
1261 }
1262
1263 pub fn noop_visit_inline_asm<T: MutVisitor>(asm: &mut InlineAsm, vis: &mut T) {
1264     for (op, _) in &mut asm.operands {
1265         match op {
1266             InlineAsmOperand::In { expr, .. }
1267             | InlineAsmOperand::Out { expr: Some(expr), .. }
1268             | InlineAsmOperand::InOut { expr, .. } => vis.visit_expr(expr),
1269             InlineAsmOperand::Out { expr: None, .. } => {}
1270             InlineAsmOperand::SplitInOut { in_expr, out_expr, .. } => {
1271                 vis.visit_expr(in_expr);
1272                 if let Some(out_expr) = out_expr {
1273                     vis.visit_expr(out_expr);
1274                 }
1275             }
1276             InlineAsmOperand::Const { anon_const } => vis.visit_anon_const(anon_const),
1277             InlineAsmOperand::Sym { sym } => vis.visit_inline_asm_sym(sym),
1278         }
1279     }
1280 }
1281
1282 pub fn noop_visit_inline_asm_sym<T: MutVisitor>(
1283     InlineAsmSym { id, qself, path }: &mut InlineAsmSym,
1284     vis: &mut T,
1285 ) {
1286     vis.visit_id(id);
1287     vis.visit_qself(qself);
1288     vis.visit_path(path);
1289 }
1290
1291 pub fn noop_visit_format_args<T: MutVisitor>(fmt: &mut FormatArgs, vis: &mut T) {
1292     for arg in fmt.arguments.all_args_mut() {
1293         if let FormatArgumentKind::Named(name) = &mut arg.kind {
1294             vis.visit_ident(name);
1295         }
1296         vis.visit_expr(&mut arg.expr);
1297     }
1298 }
1299
1300 pub fn noop_visit_expr<T: MutVisitor>(
1301     Expr { kind, id, span, attrs, tokens }: &mut Expr,
1302     vis: &mut T,
1303 ) {
1304     match kind {
1305         ExprKind::Box(expr) => vis.visit_expr(expr),
1306         ExprKind::Array(exprs) => visit_exprs(exprs, vis),
1307         ExprKind::ConstBlock(anon_const) => {
1308             vis.visit_anon_const(anon_const);
1309         }
1310         ExprKind::Repeat(expr, count) => {
1311             vis.visit_expr(expr);
1312             vis.visit_anon_const(count);
1313         }
1314         ExprKind::Tup(exprs) => visit_exprs(exprs, vis),
1315         ExprKind::Call(f, args) => {
1316             vis.visit_expr(f);
1317             visit_exprs(args, vis);
1318         }
1319         ExprKind::MethodCall(box MethodCall {
1320             seg: PathSegment { ident, id, args: seg_args },
1321             receiver,
1322             args: call_args,
1323             span,
1324         }) => {
1325             vis.visit_ident(ident);
1326             vis.visit_id(id);
1327             visit_opt(seg_args, |args| vis.visit_generic_args(args));
1328             vis.visit_method_receiver_expr(receiver);
1329             visit_exprs(call_args, vis);
1330             vis.visit_span(span);
1331         }
1332         ExprKind::Binary(_binop, lhs, rhs) => {
1333             vis.visit_expr(lhs);
1334             vis.visit_expr(rhs);
1335         }
1336         ExprKind::Unary(_unop, ohs) => vis.visit_expr(ohs),
1337         ExprKind::Cast(expr, ty) => {
1338             vis.visit_expr(expr);
1339             vis.visit_ty(ty);
1340         }
1341         ExprKind::Type(expr, ty) => {
1342             vis.visit_expr(expr);
1343             vis.visit_ty(ty);
1344         }
1345         ExprKind::AddrOf(_, _, ohs) => vis.visit_expr(ohs),
1346         ExprKind::Let(pat, scrutinee, _) => {
1347             vis.visit_pat(pat);
1348             vis.visit_expr(scrutinee);
1349         }
1350         ExprKind::If(cond, tr, fl) => {
1351             vis.visit_expr(cond);
1352             vis.visit_block(tr);
1353             visit_opt(fl, |fl| vis.visit_expr(fl));
1354         }
1355         ExprKind::While(cond, body, label) => {
1356             vis.visit_expr(cond);
1357             vis.visit_block(body);
1358             visit_opt(label, |label| vis.visit_label(label));
1359         }
1360         ExprKind::ForLoop(pat, iter, body, label) => {
1361             vis.visit_pat(pat);
1362             vis.visit_expr(iter);
1363             vis.visit_block(body);
1364             visit_opt(label, |label| vis.visit_label(label));
1365         }
1366         ExprKind::Loop(body, label, span) => {
1367             vis.visit_block(body);
1368             visit_opt(label, |label| vis.visit_label(label));
1369             vis.visit_span(span);
1370         }
1371         ExprKind::Match(expr, arms) => {
1372             vis.visit_expr(expr);
1373             arms.flat_map_in_place(|arm| vis.flat_map_arm(arm));
1374         }
1375         ExprKind::Closure(box Closure {
1376             binder,
1377             capture_clause: _,
1378             constness,
1379             asyncness,
1380             movability: _,
1381             fn_decl,
1382             body,
1383             fn_decl_span,
1384             fn_arg_span: _,
1385         }) => {
1386             vis.visit_closure_binder(binder);
1387             visit_constness(constness, vis);
1388             vis.visit_asyncness(asyncness);
1389             vis.visit_fn_decl(fn_decl);
1390             vis.visit_expr(body);
1391             vis.visit_span(fn_decl_span);
1392         }
1393         ExprKind::Block(blk, label) => {
1394             vis.visit_block(blk);
1395             visit_opt(label, |label| vis.visit_label(label));
1396         }
1397         ExprKind::Async(_capture_by, node_id, body) => {
1398             vis.visit_id(node_id);
1399             vis.visit_block(body);
1400         }
1401         ExprKind::Await(expr) => vis.visit_expr(expr),
1402         ExprKind::Assign(el, er, _) => {
1403             vis.visit_expr(el);
1404             vis.visit_expr(er);
1405         }
1406         ExprKind::AssignOp(_op, el, er) => {
1407             vis.visit_expr(el);
1408             vis.visit_expr(er);
1409         }
1410         ExprKind::Field(el, ident) => {
1411             vis.visit_expr(el);
1412             vis.visit_ident(ident);
1413         }
1414         ExprKind::Index(el, er) => {
1415             vis.visit_expr(el);
1416             vis.visit_expr(er);
1417         }
1418         ExprKind::Range(e1, e2, _lim) => {
1419             visit_opt(e1, |e1| vis.visit_expr(e1));
1420             visit_opt(e2, |e2| vis.visit_expr(e2));
1421         }
1422         ExprKind::Underscore => {}
1423         ExprKind::Path(qself, path) => {
1424             vis.visit_qself(qself);
1425             vis.visit_path(path);
1426         }
1427         ExprKind::Break(label, expr) => {
1428             visit_opt(label, |label| vis.visit_label(label));
1429             visit_opt(expr, |expr| vis.visit_expr(expr));
1430         }
1431         ExprKind::Continue(label) => {
1432             visit_opt(label, |label| vis.visit_label(label));
1433         }
1434         ExprKind::Ret(expr) => {
1435             visit_opt(expr, |expr| vis.visit_expr(expr));
1436         }
1437         ExprKind::Yeet(expr) => {
1438             visit_opt(expr, |expr| vis.visit_expr(expr));
1439         }
1440         ExprKind::InlineAsm(asm) => vis.visit_inline_asm(asm),
1441         ExprKind::FormatArgs(fmt) => vis.visit_format_args(fmt),
1442         ExprKind::MacCall(mac) => vis.visit_mac_call(mac),
1443         ExprKind::Struct(se) => {
1444             let StructExpr { qself, path, fields, rest } = se.deref_mut();
1445             vis.visit_qself(qself);
1446             vis.visit_path(path);
1447             fields.flat_map_in_place(|field| vis.flat_map_expr_field(field));
1448             match rest {
1449                 StructRest::Base(expr) => vis.visit_expr(expr),
1450                 StructRest::Rest(_span) => {}
1451                 StructRest::None => {}
1452             }
1453         }
1454         ExprKind::Paren(expr) => {
1455             vis.visit_expr(expr);
1456         }
1457         ExprKind::Yield(expr) => {
1458             visit_opt(expr, |expr| vis.visit_expr(expr));
1459         }
1460         ExprKind::Try(expr) => vis.visit_expr(expr),
1461         ExprKind::TryBlock(body) => vis.visit_block(body),
1462         ExprKind::Lit(_) | ExprKind::IncludedBytes(..) | ExprKind::Err => {}
1463     }
1464     vis.visit_id(id);
1465     vis.visit_span(span);
1466     visit_attrs(attrs, vis);
1467     visit_lazy_tts(tokens, vis);
1468 }
1469
1470 pub fn noop_filter_map_expr<T: MutVisitor>(mut e: P<Expr>, vis: &mut T) -> Option<P<Expr>> {
1471     Some({
1472         vis.visit_expr(&mut e);
1473         e
1474     })
1475 }
1476
1477 pub fn noop_flat_map_stmt<T: MutVisitor>(
1478     Stmt { kind, mut span, mut id }: Stmt,
1479     vis: &mut T,
1480 ) -> SmallVec<[Stmt; 1]> {
1481     vis.visit_id(&mut id);
1482     vis.visit_span(&mut span);
1483     let stmts: SmallVec<_> = noop_flat_map_stmt_kind(kind, vis)
1484         .into_iter()
1485         .map(|kind| Stmt { id, kind, span })
1486         .collect();
1487     if stmts.len() > 1 {
1488         panic!(
1489             "cloning statement `NodeId`s is prohibited by default, \
1490              the visitor should implement custom statement visiting"
1491         );
1492     }
1493     stmts
1494 }
1495
1496 pub fn noop_flat_map_stmt_kind<T: MutVisitor>(
1497     kind: StmtKind,
1498     vis: &mut T,
1499 ) -> SmallVec<[StmtKind; 1]> {
1500     match kind {
1501         StmtKind::Local(mut local) => smallvec![StmtKind::Local({
1502             vis.visit_local(&mut local);
1503             local
1504         })],
1505         StmtKind::Item(item) => vis.flat_map_item(item).into_iter().map(StmtKind::Item).collect(),
1506         StmtKind::Expr(expr) => vis.filter_map_expr(expr).into_iter().map(StmtKind::Expr).collect(),
1507         StmtKind::Semi(expr) => vis.filter_map_expr(expr).into_iter().map(StmtKind::Semi).collect(),
1508         StmtKind::Empty => smallvec![StmtKind::Empty],
1509         StmtKind::MacCall(mut mac) => {
1510             let MacCallStmt { mac: mac_, style: _, attrs, tokens } = mac.deref_mut();
1511             vis.visit_mac_call(mac_);
1512             visit_attrs(attrs, vis);
1513             visit_lazy_tts(tokens, vis);
1514             smallvec![StmtKind::MacCall(mac)]
1515         }
1516     }
1517 }
1518
1519 pub fn noop_visit_vis<T: MutVisitor>(visibility: &mut Visibility, vis: &mut T) {
1520     match &mut visibility.kind {
1521         VisibilityKind::Public | VisibilityKind::Inherited => {}
1522         VisibilityKind::Restricted { path, id, shorthand: _ } => {
1523             vis.visit_path(path);
1524             vis.visit_id(id);
1525         }
1526     }
1527     vis.visit_span(&mut visibility.span);
1528 }
1529
1530 /// Some value for the AST node that is valid but possibly meaningless.
1531 pub trait DummyAstNode {
1532     fn dummy() -> Self;
1533 }
1534
1535 impl<T> DummyAstNode for Option<T> {
1536     fn dummy() -> Self {
1537         Default::default()
1538     }
1539 }
1540
1541 impl<T: DummyAstNode + 'static> DummyAstNode for P<T> {
1542     fn dummy() -> Self {
1543         P(DummyAstNode::dummy())
1544     }
1545 }
1546
1547 impl DummyAstNode for Item {
1548     fn dummy() -> Self {
1549         Item {
1550             attrs: Default::default(),
1551             id: DUMMY_NODE_ID,
1552             span: Default::default(),
1553             vis: Visibility {
1554                 kind: VisibilityKind::Public,
1555                 span: Default::default(),
1556                 tokens: Default::default(),
1557             },
1558             ident: Ident::empty(),
1559             kind: ItemKind::ExternCrate(None),
1560             tokens: Default::default(),
1561         }
1562     }
1563 }
1564
1565 impl DummyAstNode for Expr {
1566     fn dummy() -> Self {
1567         Expr {
1568             id: DUMMY_NODE_ID,
1569             kind: ExprKind::Err,
1570             span: Default::default(),
1571             attrs: Default::default(),
1572             tokens: Default::default(),
1573         }
1574     }
1575 }
1576
1577 impl DummyAstNode for Ty {
1578     fn dummy() -> Self {
1579         Ty {
1580             id: DUMMY_NODE_ID,
1581             kind: TyKind::Err,
1582             span: Default::default(),
1583             tokens: Default::default(),
1584         }
1585     }
1586 }
1587
1588 impl DummyAstNode for Pat {
1589     fn dummy() -> Self {
1590         Pat {
1591             id: DUMMY_NODE_ID,
1592             kind: PatKind::Wild,
1593             span: Default::default(),
1594             tokens: Default::default(),
1595         }
1596     }
1597 }
1598
1599 impl DummyAstNode for Stmt {
1600     fn dummy() -> Self {
1601         Stmt { id: DUMMY_NODE_ID, kind: StmtKind::Empty, span: Default::default() }
1602     }
1603 }
1604
1605 impl DummyAstNode for Block {
1606     fn dummy() -> Self {
1607         Block {
1608             stmts: Default::default(),
1609             id: DUMMY_NODE_ID,
1610             rules: BlockCheckMode::Default,
1611             span: Default::default(),
1612             tokens: Default::default(),
1613             could_be_bare_literal: Default::default(),
1614         }
1615     }
1616 }
1617
1618 impl DummyAstNode for Crate {
1619     fn dummy() -> Self {
1620         Crate {
1621             attrs: Default::default(),
1622             items: Default::default(),
1623             spans: Default::default(),
1624             id: DUMMY_NODE_ID,
1625             is_placeholder: Default::default(),
1626         }
1627     }
1628 }
1629
1630 impl<N: DummyAstNode, T: DummyAstNode> DummyAstNode for crate::ast_traits::AstNodeWrapper<N, T> {
1631     fn dummy() -> Self {
1632         crate::ast_traits::AstNodeWrapper::new(N::dummy(), T::dummy())
1633     }
1634 }