1 //! A `MutVisitor` represents an AST modification; it accepts an AST piece and
2 //! and mutates it in place. So, for instance, macro expansion is a `MutVisitor`
3 //! that walks over an AST and modifies it.
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.
12 use crate::token::{self, Token};
13 use crate::tokenstream::*;
15 use rustc_data_structures::map_in_place::MapInPlace;
16 use rustc_data_structures::sync::Lrc;
17 use rustc_span::source_map::{respan, Spanned};
18 use rustc_span::symbol::Ident;
21 use smallvec::{smallvec, Array, SmallVec};
22 use std::ops::DerefMut;
23 use std::{panic, process, ptr};
25 pub trait ExpectOne<A: Array> {
26 fn expect_one(self, err: &'static str) -> A::Item;
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()
36 pub trait MutVisitor: Sized {
37 // Methods in this trait have one of three forms:
39 // fn visit_t(&mut self, t: &mut T); // common
40 // fn flat_map_t(&mut self, t: T) -> SmallVec<[T; 1]>; // rare
41 // fn filter_map_t(&mut self, t: T) -> Option<T>; // rarest
43 // Any additions to this trait should happen in form of a call to a public
44 // `noop_*` function that only calls out to the visitor again, not other
45 // `noop_*` functions. This is a necessary API workaround to the problem of
46 // not being able to call out to the super default method in an overridden
49 // When writing these methods, it is better to use destructuring like this:
51 // fn visit_abc(&mut self, ABC { a, b, c: _ }: &mut ABC) {
56 // than to use field access like this:
58 // fn visit_abc(&mut self, abc: &mut ABC) {
59 // visit_a(&mut abc.a);
60 // visit_b(&mut abc.b);
64 // As well as being more concise, the former is explicit about which fields
65 // are skipped. Furthermore, if a new field is added, the destructuring
66 // version will cause a compile error, which is good. In comparison, the
67 // field access version will continue working and it would be easy to
68 // forget to add handling for it.
70 fn visit_crate(&mut self, c: &mut Crate) {
71 noop_visit_crate(c, self)
74 fn visit_meta_list_item(&mut self, list_item: &mut NestedMetaItem) {
75 noop_visit_meta_list_item(list_item, self);
78 fn visit_meta_item(&mut self, meta_item: &mut MetaItem) {
79 noop_visit_meta_item(meta_item, self);
82 fn visit_use_tree(&mut self, use_tree: &mut UseTree) {
83 noop_visit_use_tree(use_tree, self);
86 fn flat_map_foreign_item(&mut self, ni: P<ForeignItem>) -> SmallVec<[P<ForeignItem>; 1]> {
87 noop_flat_map_foreign_item(ni, self)
90 fn flat_map_item(&mut self, i: P<Item>) -> SmallVec<[P<Item>; 1]> {
91 noop_flat_map_item(i, self)
94 fn visit_fn_header(&mut self, header: &mut FnHeader) {
95 noop_visit_fn_header(header, self);
98 fn flat_map_struct_field(&mut self, sf: StructField) -> SmallVec<[StructField; 1]> {
99 noop_flat_map_struct_field(sf, self)
102 fn visit_item_kind(&mut self, i: &mut ItemKind) {
103 noop_visit_item_kind(i, self);
106 fn flat_map_trait_item(&mut self, i: P<AssocItem>) -> SmallVec<[P<AssocItem>; 1]> {
107 noop_flat_map_assoc_item(i, self)
110 fn flat_map_impl_item(&mut self, i: P<AssocItem>) -> SmallVec<[P<AssocItem>; 1]> {
111 noop_flat_map_assoc_item(i, self)
114 fn visit_fn_decl(&mut self, d: &mut P<FnDecl>) {
115 noop_visit_fn_decl(d, self);
118 fn visit_asyncness(&mut self, a: &mut Async) {
119 noop_visit_asyncness(a, self);
122 fn visit_block(&mut self, b: &mut P<Block>) {
123 noop_visit_block(b, self);
126 fn flat_map_stmt(&mut self, s: Stmt) -> SmallVec<[Stmt; 1]> {
127 noop_flat_map_stmt(s, self)
130 fn flat_map_arm(&mut self, arm: Arm) -> SmallVec<[Arm; 1]> {
131 noop_flat_map_arm(arm, self)
134 fn visit_pat(&mut self, p: &mut P<Pat>) {
135 noop_visit_pat(p, self);
138 fn visit_anon_const(&mut self, c: &mut AnonConst) {
139 noop_visit_anon_const(c, self);
142 fn visit_expr(&mut self, e: &mut P<Expr>) {
143 noop_visit_expr(e, self);
146 fn filter_map_expr(&mut self, e: P<Expr>) -> Option<P<Expr>> {
147 noop_filter_map_expr(e, self)
150 fn visit_generic_arg(&mut self, arg: &mut GenericArg) {
151 noop_visit_generic_arg(arg, self);
154 fn visit_ty(&mut self, t: &mut P<Ty>) {
155 noop_visit_ty(t, self);
158 fn visit_lifetime(&mut self, l: &mut Lifetime) {
159 noop_visit_lifetime(l, self);
162 fn visit_ty_constraint(&mut self, t: &mut AssocTyConstraint) {
163 noop_visit_ty_constraint(t, self);
166 fn visit_mod(&mut self, m: &mut Mod) {
167 noop_visit_mod(m, self);
170 fn visit_foreign_mod(&mut self, nm: &mut ForeignMod) {
171 noop_visit_foreign_mod(nm, self);
174 fn flat_map_variant(&mut self, v: Variant) -> SmallVec<[Variant; 1]> {
175 noop_flat_map_variant(v, self)
178 fn visit_ident(&mut self, i: &mut Ident) {
179 noop_visit_ident(i, self);
182 fn visit_path(&mut self, p: &mut Path) {
183 noop_visit_path(p, self);
186 fn visit_qself(&mut self, qs: &mut Option<QSelf>) {
187 noop_visit_qself(qs, self);
190 fn visit_generic_args(&mut self, p: &mut GenericArgs) {
191 noop_visit_generic_args(p, self);
194 fn visit_angle_bracketed_parameter_data(&mut self, p: &mut AngleBracketedArgs) {
195 noop_visit_angle_bracketed_parameter_data(p, self);
198 fn visit_parenthesized_parameter_data(&mut self, p: &mut ParenthesizedArgs) {
199 noop_visit_parenthesized_parameter_data(p, self);
202 fn visit_local(&mut self, l: &mut P<Local>) {
203 noop_visit_local(l, self);
206 fn visit_mac(&mut self, _mac: &mut MacCall) {
207 panic!("visit_mac disabled by default");
208 // N.B., see note about macros above. If you really want a visitor that
209 // works on macros, use this definition in your trait impl:
210 // mut_visit::noop_visit_mac(_mac, self);
213 fn visit_macro_def(&mut self, def: &mut MacroDef) {
214 noop_visit_macro_def(def, self);
217 fn visit_label(&mut self, label: &mut Label) {
218 noop_visit_label(label, self);
221 fn visit_attribute(&mut self, at: &mut Attribute) {
222 noop_visit_attribute(at, self);
225 fn flat_map_param(&mut self, param: Param) -> SmallVec<[Param; 1]> {
226 noop_flat_map_param(param, self)
229 fn visit_generics(&mut self, generics: &mut Generics) {
230 noop_visit_generics(generics, self);
233 fn visit_trait_ref(&mut self, tr: &mut TraitRef) {
234 noop_visit_trait_ref(tr, self);
237 fn visit_poly_trait_ref(&mut self, p: &mut PolyTraitRef) {
238 noop_visit_poly_trait_ref(p, self);
241 fn visit_variant_data(&mut self, vdata: &mut VariantData) {
242 noop_visit_variant_data(vdata, self);
245 fn flat_map_generic_param(&mut self, param: GenericParam) -> SmallVec<[GenericParam; 1]> {
246 noop_flat_map_generic_param(param, self)
249 fn visit_tt(&mut self, tt: &mut TokenTree) {
250 noop_visit_tt(tt, self);
253 fn visit_tts(&mut self, tts: &mut TokenStream) {
254 noop_visit_tts(tts, self);
257 fn visit_token(&mut self, t: &mut Token) {
258 noop_visit_token(t, self);
261 fn visit_interpolated(&mut self, nt: &mut token::Nonterminal) {
262 noop_visit_interpolated(nt, self);
265 fn visit_param_bound(&mut self, tpb: &mut GenericBound) {
266 noop_visit_param_bound(tpb, self);
269 fn visit_mt(&mut self, mt: &mut MutTy) {
270 noop_visit_mt(mt, self);
273 fn flat_map_field(&mut self, f: Field) -> SmallVec<[Field; 1]> {
274 noop_flat_map_field(f, self)
277 fn visit_where_clause(&mut self, where_clause: &mut WhereClause) {
278 noop_visit_where_clause(where_clause, self);
281 fn visit_where_predicate(&mut self, where_predicate: &mut WherePredicate) {
282 noop_visit_where_predicate(where_predicate, self);
285 fn visit_vis(&mut self, vis: &mut Visibility) {
286 noop_visit_vis(vis, self);
289 fn visit_id(&mut self, _id: &mut NodeId) {
293 fn visit_span(&mut self, _sp: &mut Span) {
297 fn flat_map_field_pattern(&mut self, fp: FieldPat) -> SmallVec<[FieldPat; 1]> {
298 noop_flat_map_field_pattern(fp, self)
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. Abort the program if the closure panics.
306 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
307 pub fn visit_clobber<T, F>(t: &mut T, f: F)
312 // Safe because `t` is used in a read-only fashion by `read()` before
313 // being overwritten by `write()`.
314 let old_t = ptr::read(t);
315 let new_t = panic::catch_unwind(panic::AssertUnwindSafe(|| f(old_t)))
316 .unwrap_or_else(|_| process::abort());
317 ptr::write(t, new_t);
321 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
323 pub fn visit_vec<T, F>(elems: &mut Vec<T>, mut visit_elem: F)
332 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
334 pub fn visit_opt<T, F>(opt: &mut Option<T>, mut visit_elem: F)
338 if let Some(elem) = opt {
343 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
344 pub fn visit_attrs<T: MutVisitor>(attrs: &mut Vec<Attribute>, vis: &mut T) {
345 visit_vec(attrs, |attr| vis.visit_attribute(attr));
348 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
349 pub fn visit_thin_attrs<T: MutVisitor>(attrs: &mut AttrVec, vis: &mut T) {
350 for attr in attrs.iter_mut() {
351 vis.visit_attribute(attr);
355 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
356 pub fn visit_exprs<T: MutVisitor>(exprs: &mut Vec<P<Expr>>, vis: &mut T) {
357 exprs.flat_map_in_place(|expr| vis.filter_map_expr(expr))
360 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
361 pub fn visit_bounds<T: MutVisitor>(bounds: &mut GenericBounds, vis: &mut T) {
362 visit_vec(bounds, |bound| vis.visit_param_bound(bound));
365 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
366 pub fn visit_fn_sig<T: MutVisitor>(FnSig { header, decl, span }: &mut FnSig, vis: &mut T) {
367 vis.visit_fn_header(header);
368 vis.visit_fn_decl(decl);
369 vis.visit_span(span);
372 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
373 pub fn visit_mac_args<T: MutVisitor>(args: &mut MacArgs, vis: &mut T) {
376 MacArgs::Delimited(dspan, _delim, tokens) => {
377 visit_delim_span(dspan, vis);
378 vis.visit_tts(tokens);
380 MacArgs::Eq(eq_span, tokens) => {
381 vis.visit_span(eq_span);
382 vis.visit_tts(tokens);
387 pub fn visit_delim_span<T: MutVisitor>(dspan: &mut DelimSpan, vis: &mut T) {
388 vis.visit_span(&mut dspan.open);
389 vis.visit_span(&mut dspan.close);
392 pub fn noop_flat_map_field_pattern<T: MutVisitor>(
395 ) -> SmallVec<[FieldPat; 1]> {
396 let FieldPat { attrs, id, ident, is_placeholder: _, is_shorthand: _, pat, span } = &mut fp;
398 vis.visit_ident(ident);
400 vis.visit_span(span);
401 visit_thin_attrs(attrs, vis);
405 pub fn noop_visit_use_tree<T: MutVisitor>(use_tree: &mut UseTree, vis: &mut T) {
406 let UseTree { prefix, kind, span } = use_tree;
407 vis.visit_path(prefix);
409 UseTreeKind::Simple(rename, id1, id2) => {
410 visit_opt(rename, |rename| vis.visit_ident(rename));
414 UseTreeKind::Nested(items) => {
415 for (tree, id) in items {
416 vis.visit_use_tree(tree);
420 UseTreeKind::Glob => {}
422 vis.visit_span(span);
425 pub fn noop_flat_map_arm<T: MutVisitor>(mut arm: Arm, vis: &mut T) -> SmallVec<[Arm; 1]> {
426 let Arm { attrs, pat, guard, body, span, id, is_placeholder: _ } = &mut arm;
427 visit_attrs(attrs, vis);
430 visit_opt(guard, |guard| vis.visit_expr(guard));
431 vis.visit_expr(body);
432 vis.visit_span(span);
436 pub fn noop_visit_ty_constraint<T: MutVisitor>(
437 AssocTyConstraint { id, ident, kind, span }: &mut AssocTyConstraint,
441 vis.visit_ident(ident);
443 AssocTyConstraintKind::Equality { ref mut ty } => {
446 AssocTyConstraintKind::Bound { ref mut bounds } => {
447 visit_bounds(bounds, vis);
450 vis.visit_span(span);
453 pub fn noop_visit_ty<T: MutVisitor>(ty: &mut P<Ty>, vis: &mut T) {
454 let Ty { id, kind, span } = ty.deref_mut();
457 TyKind::Infer | TyKind::ImplicitSelf | TyKind::Err | TyKind::Never | TyKind::CVarArgs => {}
458 TyKind::Slice(ty) => vis.visit_ty(ty),
459 TyKind::Ptr(mt) => vis.visit_mt(mt),
460 TyKind::Rptr(lt, mt) => {
461 visit_opt(lt, |lt| noop_visit_lifetime(lt, vis));
464 TyKind::BareFn(bft) => {
465 let BareFnTy { unsafety: _, ext: _, generic_params, decl } = bft.deref_mut();
466 generic_params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
467 vis.visit_fn_decl(decl);
469 TyKind::Tup(tys) => visit_vec(tys, |ty| vis.visit_ty(ty)),
470 TyKind::Paren(ty) => vis.visit_ty(ty),
471 TyKind::Path(qself, path) => {
472 vis.visit_qself(qself);
473 vis.visit_path(path);
475 TyKind::Array(ty, length) => {
477 vis.visit_anon_const(length);
479 TyKind::Typeof(expr) => vis.visit_anon_const(expr),
480 TyKind::TraitObject(bounds, _syntax) => {
481 visit_vec(bounds, |bound| vis.visit_param_bound(bound))
483 TyKind::ImplTrait(id, bounds) => {
485 visit_vec(bounds, |bound| vis.visit_param_bound(bound));
487 TyKind::MacCall(mac) => vis.visit_mac(mac),
489 vis.visit_span(span);
492 pub fn noop_visit_foreign_mod<T: MutVisitor>(foreign_mod: &mut ForeignMod, vis: &mut T) {
493 let ForeignMod { abi: _, items } = foreign_mod;
494 items.flat_map_in_place(|item| vis.flat_map_foreign_item(item));
497 pub fn noop_flat_map_variant<T: MutVisitor>(
498 mut variant: Variant,
500 ) -> SmallVec<[Variant; 1]> {
501 let Variant { ident, vis, attrs, id, data, disr_expr, span, is_placeholder: _ } = &mut variant;
502 visitor.visit_ident(ident);
503 visitor.visit_vis(vis);
504 visit_attrs(attrs, visitor);
505 visitor.visit_id(id);
506 visitor.visit_variant_data(data);
507 visit_opt(disr_expr, |disr_expr| visitor.visit_anon_const(disr_expr));
508 visitor.visit_span(span);
512 pub fn noop_visit_ident<T: MutVisitor>(Ident { name: _, span }: &mut Ident, vis: &mut T) {
513 vis.visit_span(span);
516 pub fn noop_visit_path<T: MutVisitor>(Path { segments, span }: &mut Path, vis: &mut T) {
517 vis.visit_span(span);
518 for PathSegment { ident, id, args } in segments {
519 vis.visit_ident(ident);
521 visit_opt(args, |args| vis.visit_generic_args(args));
525 pub fn noop_visit_qself<T: MutVisitor>(qself: &mut Option<QSelf>, vis: &mut T) {
526 visit_opt(qself, |QSelf { ty, path_span, position: _ }| {
528 vis.visit_span(path_span);
532 pub fn noop_visit_generic_args<T: MutVisitor>(generic_args: &mut GenericArgs, vis: &mut T) {
534 GenericArgs::AngleBracketed(data) => vis.visit_angle_bracketed_parameter_data(data),
535 GenericArgs::Parenthesized(data) => vis.visit_parenthesized_parameter_data(data),
539 pub fn noop_visit_generic_arg<T: MutVisitor>(arg: &mut GenericArg, vis: &mut T) {
541 GenericArg::Lifetime(lt) => vis.visit_lifetime(lt),
542 GenericArg::Type(ty) => vis.visit_ty(ty),
543 GenericArg::Const(ct) => vis.visit_anon_const(ct),
547 pub fn noop_visit_angle_bracketed_parameter_data<T: MutVisitor>(
548 data: &mut AngleBracketedArgs,
551 let AngleBracketedArgs { args, span } = data;
552 visit_vec(args, |arg| match arg {
553 AngleBracketedArg::Arg(arg) => vis.visit_generic_arg(arg),
554 AngleBracketedArg::Constraint(constraint) => vis.visit_ty_constraint(constraint),
556 vis.visit_span(span);
559 pub fn noop_visit_parenthesized_parameter_data<T: MutVisitor>(
560 args: &mut ParenthesizedArgs,
563 let ParenthesizedArgs { inputs, output, span } = args;
564 visit_vec(inputs, |input| vis.visit_ty(input));
565 noop_visit_fn_ret_ty(output, vis);
566 vis.visit_span(span);
569 pub fn noop_visit_local<T: MutVisitor>(local: &mut P<Local>, vis: &mut T) {
570 let Local { id, pat, ty, init, span, attrs } = local.deref_mut();
573 visit_opt(ty, |ty| vis.visit_ty(ty));
574 visit_opt(init, |init| vis.visit_expr(init));
575 vis.visit_span(span);
576 visit_thin_attrs(attrs, vis);
579 pub fn noop_visit_attribute<T: MutVisitor>(attr: &mut Attribute, vis: &mut T) {
580 let Attribute { kind, id: _, style: _, span } = attr;
582 AttrKind::Normal(AttrItem { path, args }) => {
583 vis.visit_path(path);
584 visit_mac_args(args, vis);
586 AttrKind::DocComment(..) => {}
588 vis.visit_span(span);
591 pub fn noop_visit_mac<T: MutVisitor>(mac: &mut MacCall, vis: &mut T) {
592 let MacCall { path, args, prior_type_ascription: _ } = mac;
593 vis.visit_path(path);
594 visit_mac_args(args, vis);
597 pub fn noop_visit_macro_def<T: MutVisitor>(macro_def: &mut MacroDef, vis: &mut T) {
598 let MacroDef { body, macro_rules: _ } = macro_def;
599 visit_mac_args(body, vis);
602 pub fn noop_visit_meta_list_item<T: MutVisitor>(li: &mut NestedMetaItem, vis: &mut T) {
604 NestedMetaItem::MetaItem(mi) => vis.visit_meta_item(mi),
605 NestedMetaItem::Literal(_lit) => {}
609 pub fn noop_visit_meta_item<T: MutVisitor>(mi: &mut MetaItem, vis: &mut T) {
610 let MetaItem { path: _, kind, span } = mi;
612 MetaItemKind::Word => {}
613 MetaItemKind::List(mis) => visit_vec(mis, |mi| vis.visit_meta_list_item(mi)),
614 MetaItemKind::NameValue(_s) => {}
616 vis.visit_span(span);
619 pub fn noop_flat_map_param<T: MutVisitor>(mut param: Param, vis: &mut T) -> SmallVec<[Param; 1]> {
620 let Param { attrs, id, pat, span, ty, is_placeholder: _ } = &mut param;
622 visit_thin_attrs(attrs, vis);
624 vis.visit_span(span);
629 pub fn noop_visit_tt<T: MutVisitor>(tt: &mut TokenTree, vis: &mut T) {
631 TokenTree::Token(token) => {
632 vis.visit_token(token);
634 TokenTree::Delimited(DelimSpan { open, close }, _delim, tts) => {
635 vis.visit_span(open);
636 vis.visit_span(close);
642 pub fn noop_visit_tts<T: MutVisitor>(TokenStream(tts): &mut TokenStream, vis: &mut T) {
643 let tts = Lrc::make_mut(tts);
644 visit_vec(tts, |(tree, _is_joint)| vis.visit_tt(tree));
647 // Applies ident visitor if it's an ident; applies other visits to interpolated nodes.
648 // In practice the ident part is not actually used by specific visitors right now,
649 // but there's a test below checking that it works.
650 pub fn noop_visit_token<T: MutVisitor>(t: &mut Token, vis: &mut T) {
651 let Token { kind, span } = t;
653 token::Ident(name, _) | token::Lifetime(name) => {
654 let mut ident = Ident::new(*name, *span);
655 vis.visit_ident(&mut ident);
658 return; // Avoid visiting the span for the second time.
660 token::Interpolated(nt) => {
661 let mut nt = Lrc::make_mut(nt);
662 vis.visit_interpolated(&mut nt);
666 vis.visit_span(span);
669 /// Applies the visitor to elements of interpolated nodes.
671 // N.B., this can occur only when applying a visitor to partially expanded
672 // code, where parsed pieces have gotten implanted ito *other* macro
673 // invocations. This is relevant for macro hygiene, but possibly not elsewhere.
675 // One problem here occurs because the types for flat_map_item, flat_map_stmt,
676 // etc., allow the visitor to return *multiple* items; this is a problem for the
677 // nodes here, because they insist on having exactly one piece. One solution
678 // would be to mangle the MutVisitor trait to include one-to-many and
679 // one-to-one versions of these entry points, but that would probably confuse a
680 // lot of people and help very few. Instead, I'm just going to put in dynamic
681 // checks. I think the performance impact of this will be pretty much
682 // nonexistent. The danger is that someone will apply a `MutVisitor` to a
683 // partially expanded node, and will be confused by the fact that their
684 // `flat_map_item` or `flat_map_stmt` isn't getting called on `NtItem` or `NtStmt`
685 // nodes. Hopefully they'll wind up reading this comment, and doing something
688 // BTW, design choice: I considered just changing the type of, e.g., `NtItem` to
689 // contain multiple items, but decided against it when I looked at
690 // `parse_item_or_view_item` and tried to figure out what I would do with
691 // multiple items there....
692 pub fn noop_visit_interpolated<T: MutVisitor>(nt: &mut token::Nonterminal, vis: &mut T) {
694 token::NtItem(item) => visit_clobber(item, |item| {
695 // This is probably okay, because the only visitors likely to
696 // peek inside interpolated nodes will be renamings/markings,
697 // which map single items to single items.
698 vis.flat_map_item(item).expect_one("expected visitor to produce exactly one item")
700 token::NtBlock(block) => vis.visit_block(block),
701 token::NtStmt(stmt) => visit_clobber(stmt, |stmt| {
702 // See reasoning above.
703 vis.flat_map_stmt(stmt).expect_one("expected visitor to produce exactly one item")
705 token::NtPat(pat) => vis.visit_pat(pat),
706 token::NtExpr(expr) => vis.visit_expr(expr),
707 token::NtTy(ty) => vis.visit_ty(ty),
708 token::NtIdent(ident, _is_raw) => vis.visit_ident(ident),
709 token::NtLifetime(ident) => vis.visit_ident(ident),
710 token::NtLiteral(expr) => vis.visit_expr(expr),
711 token::NtMeta(item) => {
712 let AttrItem { path, args } = item.deref_mut();
713 vis.visit_path(path);
714 visit_mac_args(args, vis);
716 token::NtPath(path) => vis.visit_path(path),
717 token::NtTT(tt) => vis.visit_tt(tt),
718 token::NtVis(visib) => vis.visit_vis(visib),
722 pub fn noop_visit_asyncness<T: MutVisitor>(asyncness: &mut Async, vis: &mut T) {
724 Async::Yes { span: _, closure_id, return_impl_trait_id } => {
725 vis.visit_id(closure_id);
726 vis.visit_id(return_impl_trait_id);
732 pub fn noop_visit_fn_decl<T: MutVisitor>(decl: &mut P<FnDecl>, vis: &mut T) {
733 let FnDecl { inputs, output } = decl.deref_mut();
734 inputs.flat_map_in_place(|param| vis.flat_map_param(param));
735 noop_visit_fn_ret_ty(output, vis);
738 pub fn noop_visit_fn_ret_ty<T: MutVisitor>(fn_ret_ty: &mut FnRetTy, vis: &mut T) {
740 FnRetTy::Default(span) => vis.visit_span(span),
741 FnRetTy::Ty(ty) => vis.visit_ty(ty),
745 pub fn noop_visit_param_bound<T: MutVisitor>(pb: &mut GenericBound, vis: &mut T) {
747 GenericBound::Trait(ty, _modifier) => vis.visit_poly_trait_ref(ty),
748 GenericBound::Outlives(lifetime) => noop_visit_lifetime(lifetime, vis),
752 pub fn noop_flat_map_generic_param<T: MutVisitor>(
753 mut param: GenericParam,
755 ) -> SmallVec<[GenericParam; 1]> {
756 let GenericParam { id, ident, attrs, bounds, kind, is_placeholder: _ } = &mut param;
758 vis.visit_ident(ident);
759 visit_thin_attrs(attrs, vis);
760 visit_vec(bounds, |bound| noop_visit_param_bound(bound, vis));
762 GenericParamKind::Lifetime => {}
763 GenericParamKind::Type { default } => {
764 visit_opt(default, |default| vis.visit_ty(default));
766 GenericParamKind::Const { ty, kw_span: _ } => {
773 pub fn noop_visit_label<T: MutVisitor>(Label { ident }: &mut Label, vis: &mut T) {
774 vis.visit_ident(ident);
777 fn noop_visit_lifetime<T: MutVisitor>(Lifetime { id, ident }: &mut Lifetime, vis: &mut T) {
779 vis.visit_ident(ident);
782 pub fn noop_visit_generics<T: MutVisitor>(generics: &mut Generics, vis: &mut T) {
783 let Generics { params, where_clause, span } = generics;
784 params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
785 vis.visit_where_clause(where_clause);
786 vis.visit_span(span);
789 pub fn noop_visit_where_clause<T: MutVisitor>(wc: &mut WhereClause, vis: &mut T) {
790 let WhereClause { has_where_token: _, predicates, span } = wc;
791 visit_vec(predicates, |predicate| vis.visit_where_predicate(predicate));
792 vis.visit_span(span);
795 pub fn noop_visit_where_predicate<T: MutVisitor>(pred: &mut WherePredicate, vis: &mut T) {
797 WherePredicate::BoundPredicate(bp) => {
798 let WhereBoundPredicate { span, bound_generic_params, bounded_ty, bounds } = bp;
799 vis.visit_span(span);
800 bound_generic_params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
801 vis.visit_ty(bounded_ty);
802 visit_vec(bounds, |bound| vis.visit_param_bound(bound));
804 WherePredicate::RegionPredicate(rp) => {
805 let WhereRegionPredicate { span, lifetime, bounds } = rp;
806 vis.visit_span(span);
807 noop_visit_lifetime(lifetime, vis);
808 visit_vec(bounds, |bound| noop_visit_param_bound(bound, vis));
810 WherePredicate::EqPredicate(ep) => {
811 let WhereEqPredicate { id, span, lhs_ty, rhs_ty } = ep;
813 vis.visit_span(span);
814 vis.visit_ty(lhs_ty);
815 vis.visit_ty(rhs_ty);
820 pub fn noop_visit_variant_data<T: MutVisitor>(vdata: &mut VariantData, vis: &mut T) {
822 VariantData::Struct(fields, ..) => {
823 fields.flat_map_in_place(|field| vis.flat_map_struct_field(field));
825 VariantData::Tuple(fields, id) => {
826 fields.flat_map_in_place(|field| vis.flat_map_struct_field(field));
829 VariantData::Unit(id) => vis.visit_id(id),
833 pub fn noop_visit_trait_ref<T: MutVisitor>(TraitRef { path, ref_id }: &mut TraitRef, vis: &mut T) {
834 vis.visit_path(path);
835 vis.visit_id(ref_id);
838 pub fn noop_visit_poly_trait_ref<T: MutVisitor>(p: &mut PolyTraitRef, vis: &mut T) {
839 let PolyTraitRef { bound_generic_params, trait_ref, span } = p;
840 bound_generic_params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
841 vis.visit_trait_ref(trait_ref);
842 vis.visit_span(span);
845 pub fn noop_flat_map_struct_field<T: MutVisitor>(
848 ) -> SmallVec<[StructField; 1]> {
849 let StructField { span, ident, vis, id, ty, attrs, is_placeholder: _ } = &mut sf;
850 visitor.visit_span(span);
851 visit_opt(ident, |ident| visitor.visit_ident(ident));
852 visitor.visit_vis(vis);
853 visitor.visit_id(id);
854 visitor.visit_ty(ty);
855 visit_attrs(attrs, visitor);
859 pub fn noop_flat_map_field<T: MutVisitor>(mut f: Field, vis: &mut T) -> SmallVec<[Field; 1]> {
860 let Field { ident, expr, span, is_shorthand: _, attrs, id, is_placeholder: _ } = &mut f;
861 vis.visit_ident(ident);
862 vis.visit_expr(expr);
864 vis.visit_span(span);
865 visit_thin_attrs(attrs, vis);
869 pub fn noop_visit_mt<T: MutVisitor>(MutTy { ty, mutbl: _ }: &mut MutTy, vis: &mut T) {
873 pub fn noop_visit_block<T: MutVisitor>(block: &mut P<Block>, vis: &mut T) {
874 let Block { id, stmts, rules: _, span } = block.deref_mut();
876 stmts.flat_map_in_place(|stmt| vis.flat_map_stmt(stmt));
877 vis.visit_span(span);
880 pub fn noop_visit_item_kind<T: MutVisitor>(kind: &mut ItemKind, vis: &mut T) {
882 ItemKind::ExternCrate(_orig_name) => {}
883 ItemKind::Use(use_tree) => vis.visit_use_tree(use_tree),
884 ItemKind::Static(ty, _, expr) | ItemKind::Const(_, ty, expr) => {
886 visit_opt(expr, |expr| vis.visit_expr(expr));
888 ItemKind::Fn(_, sig, generics, body) => {
889 visit_fn_sig(sig, vis);
890 vis.visit_generics(generics);
891 visit_opt(body, |body| vis.visit_block(body));
893 ItemKind::Mod(m) => vis.visit_mod(m),
894 ItemKind::ForeignMod(nm) => vis.visit_foreign_mod(nm),
895 ItemKind::GlobalAsm(_ga) => {}
896 ItemKind::TyAlias(_, generics, bounds, ty) => {
897 vis.visit_generics(generics);
898 visit_bounds(bounds, vis);
899 visit_opt(ty, |ty| vis.visit_ty(ty));
901 ItemKind::Enum(EnumDef { variants }, generics) => {
902 variants.flat_map_in_place(|variant| vis.flat_map_variant(variant));
903 vis.visit_generics(generics);
905 ItemKind::Struct(variant_data, generics) | ItemKind::Union(variant_data, generics) => {
906 vis.visit_variant_data(variant_data);
907 vis.visit_generics(generics);
919 vis.visit_generics(generics);
920 visit_opt(of_trait, |trait_ref| vis.visit_trait_ref(trait_ref));
921 vis.visit_ty(self_ty);
922 items.flat_map_in_place(|item| vis.flat_map_impl_item(item));
924 ItemKind::Trait(_is_auto, _unsafety, generics, bounds, items) => {
925 vis.visit_generics(generics);
926 visit_bounds(bounds, vis);
927 items.flat_map_in_place(|item| vis.flat_map_trait_item(item));
929 ItemKind::TraitAlias(generics, bounds) => {
930 vis.visit_generics(generics);
931 visit_bounds(bounds, vis);
933 ItemKind::MacCall(m) => vis.visit_mac(m),
934 ItemKind::MacroDef(def) => vis.visit_macro_def(def),
938 pub fn noop_flat_map_assoc_item<T: MutVisitor>(
939 mut item: P<AssocItem>,
941 ) -> SmallVec<[P<AssocItem>; 1]> {
942 let Item { id, ident, vis, attrs, kind, span, tokens: _ } = item.deref_mut();
943 visitor.visit_id(id);
944 visitor.visit_ident(ident);
945 visitor.visit_vis(vis);
946 visit_attrs(attrs, visitor);
948 AssocItemKind::Const(_, ty, expr) => {
949 visitor.visit_ty(ty);
950 visit_opt(expr, |expr| visitor.visit_expr(expr));
952 AssocItemKind::Fn(_, sig, generics, body) => {
953 visitor.visit_generics(generics);
954 visit_fn_sig(sig, visitor);
955 visit_opt(body, |body| visitor.visit_block(body));
957 AssocItemKind::TyAlias(_, generics, bounds, ty) => {
958 visitor.visit_generics(generics);
959 visit_bounds(bounds, visitor);
960 visit_opt(ty, |ty| visitor.visit_ty(ty));
962 AssocItemKind::MacCall(mac) => visitor.visit_mac(mac),
964 visitor.visit_span(span);
968 pub fn noop_visit_fn_header<T: MutVisitor>(header: &mut FnHeader, vis: &mut T) {
969 let FnHeader { unsafety: _, asyncness, constness: _, ext: _ } = header;
970 vis.visit_asyncness(asyncness);
973 pub fn noop_visit_mod<T: MutVisitor>(Mod { inner, items, inline: _ }: &mut Mod, vis: &mut T) {
974 vis.visit_span(inner);
975 items.flat_map_in_place(|item| vis.flat_map_item(item));
978 pub fn noop_visit_crate<T: MutVisitor>(krate: &mut Crate, vis: &mut T) {
979 visit_clobber(krate, |Crate { module, attrs, span, proc_macros }| {
981 ident: Ident::invalid(),
984 vis: respan(span.shrink_to_lo(), VisibilityKind::Public),
986 kind: ItemKind::Mod(module),
989 let items = vis.flat_map_item(item);
991 let len = items.len();
993 let module = Mod { inner: span, items: vec![], inline: true };
994 Crate { module, attrs: vec![], span, proc_macros }
996 let Item { attrs, span, kind, .. } = items.into_iter().next().unwrap().into_inner();
998 ItemKind::Mod(module) => Crate { module, attrs, span, proc_macros },
999 _ => panic!("visitor converted a module to not a module"),
1002 panic!("a crate cannot expand to more than one item");
1007 // Mutates one item into possibly many items.
1008 pub fn noop_flat_map_item<T: MutVisitor>(
1011 ) -> SmallVec<[P<Item>; 1]> {
1012 let Item { ident, attrs, id, kind, vis, span, tokens: _ } = item.deref_mut();
1013 visitor.visit_ident(ident);
1014 visit_attrs(attrs, visitor);
1015 visitor.visit_id(id);
1016 visitor.visit_item_kind(kind);
1017 visitor.visit_vis(vis);
1018 visitor.visit_span(span);
1020 // FIXME: if `tokens` is modified with a call to `vis.visit_tts` it causes
1021 // an ICE during resolve... odd!
1026 pub fn noop_flat_map_foreign_item<T: MutVisitor>(
1027 mut item: P<ForeignItem>,
1029 ) -> SmallVec<[P<ForeignItem>; 1]> {
1030 let Item { ident, attrs, id, kind, vis, span, tokens: _ } = item.deref_mut();
1031 visitor.visit_id(id);
1032 visitor.visit_ident(ident);
1033 visitor.visit_vis(vis);
1034 visit_attrs(attrs, visitor);
1036 ForeignItemKind::Static(ty, _, expr) => {
1037 visitor.visit_ty(ty);
1038 visit_opt(expr, |expr| visitor.visit_expr(expr));
1040 ForeignItemKind::Fn(_, sig, generics, body) => {
1041 visitor.visit_generics(generics);
1042 visit_fn_sig(sig, visitor);
1043 visit_opt(body, |body| visitor.visit_block(body));
1045 ForeignItemKind::TyAlias(_, generics, bounds, ty) => {
1046 visitor.visit_generics(generics);
1047 visit_bounds(bounds, visitor);
1048 visit_opt(ty, |ty| visitor.visit_ty(ty));
1050 ForeignItemKind::MacCall(mac) => visitor.visit_mac(mac),
1052 visitor.visit_span(span);
1056 pub fn noop_visit_pat<T: MutVisitor>(pat: &mut P<Pat>, vis: &mut T) {
1057 let Pat { id, kind, span, tokens: _ } = pat.deref_mut();
1060 PatKind::Wild | PatKind::Rest => {}
1061 PatKind::Ident(_binding_mode, ident, sub) => {
1062 vis.visit_ident(ident);
1063 visit_opt(sub, |sub| vis.visit_pat(sub));
1065 PatKind::Lit(e) => vis.visit_expr(e),
1066 PatKind::TupleStruct(path, elems) => {
1067 vis.visit_path(path);
1068 visit_vec(elems, |elem| vis.visit_pat(elem));
1070 PatKind::Path(qself, path) => {
1071 vis.visit_qself(qself);
1072 vis.visit_path(path);
1074 PatKind::Struct(path, fields, _etc) => {
1075 vis.visit_path(path);
1076 fields.flat_map_in_place(|field| vis.flat_map_field_pattern(field));
1078 PatKind::Box(inner) => vis.visit_pat(inner),
1079 PatKind::Ref(inner, _mutbl) => vis.visit_pat(inner),
1080 PatKind::Range(e1, e2, Spanned { span: _, node: _ }) => {
1081 visit_opt(e1, |e| vis.visit_expr(e));
1082 visit_opt(e2, |e| vis.visit_expr(e));
1083 vis.visit_span(span);
1085 PatKind::Tuple(elems) | PatKind::Slice(elems) | PatKind::Or(elems) => {
1086 visit_vec(elems, |elem| vis.visit_pat(elem))
1088 PatKind::Paren(inner) => vis.visit_pat(inner),
1089 PatKind::MacCall(mac) => vis.visit_mac(mac),
1091 vis.visit_span(span);
1094 pub fn noop_visit_anon_const<T: MutVisitor>(AnonConst { id, value }: &mut AnonConst, vis: &mut T) {
1096 vis.visit_expr(value);
1099 pub fn noop_visit_expr<T: MutVisitor>(
1100 Expr { kind, id, span, attrs, tokens: _ }: &mut Expr,
1104 ExprKind::Box(expr) => vis.visit_expr(expr),
1105 ExprKind::Array(exprs) => visit_exprs(exprs, vis),
1106 ExprKind::Repeat(expr, count) => {
1107 vis.visit_expr(expr);
1108 vis.visit_anon_const(count);
1110 ExprKind::Tup(exprs) => visit_exprs(exprs, vis),
1111 ExprKind::Call(f, args) => {
1113 visit_exprs(args, vis);
1115 ExprKind::MethodCall(PathSegment { ident, id, args }, exprs, span) => {
1116 vis.visit_ident(ident);
1118 visit_opt(args, |args| vis.visit_generic_args(args));
1119 visit_exprs(exprs, vis);
1120 vis.visit_span(span);
1122 ExprKind::Binary(_binop, lhs, rhs) => {
1123 vis.visit_expr(lhs);
1124 vis.visit_expr(rhs);
1126 ExprKind::Unary(_unop, ohs) => vis.visit_expr(ohs),
1127 ExprKind::Cast(expr, ty) => {
1128 vis.visit_expr(expr);
1131 ExprKind::Type(expr, ty) => {
1132 vis.visit_expr(expr);
1135 ExprKind::AddrOf(_, _, ohs) => vis.visit_expr(ohs),
1136 ExprKind::Let(pat, scrutinee) => {
1138 vis.visit_expr(scrutinee);
1140 ExprKind::If(cond, tr, fl) => {
1141 vis.visit_expr(cond);
1142 vis.visit_block(tr);
1143 visit_opt(fl, |fl| vis.visit_expr(fl));
1145 ExprKind::While(cond, body, label) => {
1146 vis.visit_expr(cond);
1147 vis.visit_block(body);
1148 visit_opt(label, |label| vis.visit_label(label));
1150 ExprKind::ForLoop(pat, iter, body, label) => {
1152 vis.visit_expr(iter);
1153 vis.visit_block(body);
1154 visit_opt(label, |label| vis.visit_label(label));
1156 ExprKind::Loop(body, label) => {
1157 vis.visit_block(body);
1158 visit_opt(label, |label| vis.visit_label(label));
1160 ExprKind::Match(expr, arms) => {
1161 vis.visit_expr(expr);
1162 arms.flat_map_in_place(|arm| vis.flat_map_arm(arm));
1164 ExprKind::Closure(_capture_by, asyncness, _movability, decl, body, span) => {
1165 vis.visit_asyncness(asyncness);
1166 vis.visit_fn_decl(decl);
1167 vis.visit_expr(body);
1168 vis.visit_span(span);
1170 ExprKind::Block(blk, label) => {
1171 vis.visit_block(blk);
1172 visit_opt(label, |label| vis.visit_label(label));
1174 ExprKind::Async(_capture_by, node_id, body) => {
1175 vis.visit_id(node_id);
1176 vis.visit_block(body);
1178 ExprKind::Await(expr) => vis.visit_expr(expr),
1179 ExprKind::Assign(el, er, _) => {
1183 ExprKind::AssignOp(_op, el, er) => {
1187 ExprKind::Field(el, ident) => {
1189 vis.visit_ident(ident);
1191 ExprKind::Index(el, er) => {
1195 ExprKind::Range(e1, e2, _lim) => {
1196 visit_opt(e1, |e1| vis.visit_expr(e1));
1197 visit_opt(e2, |e2| vis.visit_expr(e2));
1199 ExprKind::Path(qself, path) => {
1200 vis.visit_qself(qself);
1201 vis.visit_path(path);
1203 ExprKind::Break(label, expr) => {
1204 visit_opt(label, |label| vis.visit_label(label));
1205 visit_opt(expr, |expr| vis.visit_expr(expr));
1207 ExprKind::Continue(label) => {
1208 visit_opt(label, |label| vis.visit_label(label));
1210 ExprKind::Ret(expr) => {
1211 visit_opt(expr, |expr| vis.visit_expr(expr));
1213 ExprKind::InlineAsm(asm) => {
1214 for (op, _) in &mut asm.operands {
1216 InlineAsmOperand::In { expr, .. }
1217 | InlineAsmOperand::InOut { expr, .. }
1218 | InlineAsmOperand::Const { expr, .. }
1219 | InlineAsmOperand::Sym { expr, .. } => vis.visit_expr(expr),
1220 InlineAsmOperand::Out { expr, .. } => {
1221 if let Some(expr) = expr {
1222 vis.visit_expr(expr);
1225 InlineAsmOperand::SplitInOut { in_expr, out_expr, .. } => {
1226 vis.visit_expr(in_expr);
1227 if let Some(out_expr) = out_expr {
1228 vis.visit_expr(out_expr);
1234 ExprKind::LlvmInlineAsm(asm) => {
1244 } = asm.deref_mut();
1245 for out in outputs {
1246 let LlvmInlineAsmOutput { constraint: _, expr, is_rw: _, is_indirect: _ } = out;
1247 vis.visit_expr(expr);
1249 visit_vec(inputs, |(_c, expr)| vis.visit_expr(expr));
1251 ExprKind::MacCall(mac) => vis.visit_mac(mac),
1252 ExprKind::Struct(path, fields, expr) => {
1253 vis.visit_path(path);
1254 fields.flat_map_in_place(|field| vis.flat_map_field(field));
1255 visit_opt(expr, |expr| vis.visit_expr(expr));
1257 ExprKind::Paren(expr) => {
1258 vis.visit_expr(expr);
1260 // Nodes that are equal modulo `Paren` sugar no-ops should have the same IDs.
1262 vis.visit_span(span);
1263 visit_thin_attrs(attrs, vis);
1266 ExprKind::Yield(expr) => {
1267 visit_opt(expr, |expr| vis.visit_expr(expr));
1269 ExprKind::Try(expr) => vis.visit_expr(expr),
1270 ExprKind::TryBlock(body) => vis.visit_block(body),
1271 ExprKind::Lit(_) | ExprKind::Err => {}
1274 vis.visit_span(span);
1275 visit_thin_attrs(attrs, vis);
1278 pub fn noop_filter_map_expr<T: MutVisitor>(mut e: P<Expr>, vis: &mut T) -> Option<P<Expr>> {
1280 vis.visit_expr(&mut e);
1285 pub fn noop_flat_map_stmt<T: MutVisitor>(
1286 Stmt { kind, mut span, mut id }: Stmt,
1288 ) -> SmallVec<[Stmt; 1]> {
1289 vis.visit_id(&mut id);
1290 vis.visit_span(&mut span);
1291 noop_flat_map_stmt_kind(kind, vis).into_iter().map(|kind| Stmt { id, kind, span }).collect()
1294 pub fn noop_flat_map_stmt_kind<T: MutVisitor>(
1297 ) -> SmallVec<[StmtKind; 1]> {
1299 StmtKind::Local(mut local) => smallvec![StmtKind::Local({
1300 vis.visit_local(&mut local);
1303 StmtKind::Item(item) => vis.flat_map_item(item).into_iter().map(StmtKind::Item).collect(),
1304 StmtKind::Expr(expr) => vis.filter_map_expr(expr).into_iter().map(StmtKind::Expr).collect(),
1305 StmtKind::Semi(expr) => vis.filter_map_expr(expr).into_iter().map(StmtKind::Semi).collect(),
1306 StmtKind::Empty => smallvec![StmtKind::Empty],
1307 StmtKind::MacCall(mut mac) => {
1308 let (mac_, _semi, attrs) = mac.deref_mut();
1309 vis.visit_mac(mac_);
1310 visit_thin_attrs(attrs, vis);
1311 smallvec![StmtKind::MacCall(mac)]
1316 pub fn noop_visit_vis<T: MutVisitor>(Spanned { node, span }: &mut Visibility, vis: &mut T) {
1318 VisibilityKind::Public | VisibilityKind::Crate(_) | VisibilityKind::Inherited => {}
1319 VisibilityKind::Restricted { path, id } => {
1320 vis.visit_path(path);
1324 vis.visit_span(span);