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.
11 use crate::source_map::{Spanned, respan};
12 use crate::token::{self, Token};
15 use crate::tokenstream::*;
16 use crate::util::map_in_place::MapInPlace;
18 use smallvec::{smallvec, Array, SmallVec};
21 use rustc_data_structures::sync::Lrc;
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: ForeignItem) -> SmallVec<[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: TraitItem) -> SmallVec<[TraitItem; 1]> {
107 noop_flat_map_trait_item(i, self)
110 fn flat_map_impl_item(&mut self, i: ImplItem) -> SmallVec<[ImplItem; 1]> {
111 noop_flat_map_impl_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 IsAsync) {
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 Mac) {
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) where F: FnOnce(T) -> T {
309 // Safe because `t` is used in a read-only fashion by `read()` before
310 // being overwritten by `write()`.
311 let old_t = ptr::read(t);
312 let new_t = panic::catch_unwind(panic::AssertUnwindSafe(|| f(old_t)))
313 .unwrap_or_else(|_| process::abort());
314 ptr::write(t, new_t);
318 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
320 pub fn visit_vec<T, F>(elems: &mut Vec<T>, mut visit_elem: F) where F: FnMut(&mut T) {
326 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
328 pub fn visit_opt<T, F>(opt: &mut Option<T>, mut visit_elem: F) where F: FnMut(&mut T) {
329 if let Some(elem) = opt {
334 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
335 pub fn visit_attrs<T: MutVisitor>(attrs: &mut Vec<Attribute>, vis: &mut T) {
336 visit_vec(attrs, |attr| vis.visit_attribute(attr));
339 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
340 pub fn visit_thin_attrs<T: MutVisitor>(attrs: &mut ThinVec<Attribute>, vis: &mut T) {
341 for attr in attrs.iter_mut() {
342 vis.visit_attribute(attr);
346 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
347 pub fn visit_exprs<T: MutVisitor>(exprs: &mut Vec<P<Expr>>, vis: &mut T) {
348 exprs.flat_map_in_place(|expr| vis.filter_map_expr(expr))
351 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
352 pub fn visit_bounds<T: MutVisitor>(bounds: &mut GenericBounds, vis: &mut T) {
353 visit_vec(bounds, |bound| vis.visit_param_bound(bound));
356 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
357 pub fn visit_fn_sig<T: MutVisitor>(FnSig { header, decl }: &mut FnSig, vis: &mut T) {
358 vis.visit_fn_header(header);
359 vis.visit_fn_decl(decl);
362 pub fn noop_flat_map_field_pattern<T: MutVisitor>(
365 ) -> SmallVec<[FieldPat; 1]> {
376 vis.visit_ident(ident);
378 vis.visit_span(span);
379 visit_thin_attrs(attrs, vis);
383 pub fn noop_visit_use_tree<T: MutVisitor>(use_tree: &mut UseTree, vis: &mut T) {
384 let UseTree { prefix, kind, span } = use_tree;
385 vis.visit_path(prefix);
387 UseTreeKind::Simple(rename, id1, id2) => {
388 visit_opt(rename, |rename| vis.visit_ident(rename));
392 UseTreeKind::Nested(items) => {
393 for (tree, id) in items {
394 vis.visit_use_tree(tree);
398 UseTreeKind::Glob => {}
400 vis.visit_span(span);
403 pub fn noop_flat_map_arm<T: MutVisitor>(mut arm: Arm, vis: &mut T) -> SmallVec<[Arm; 1]> {
404 let Arm { attrs, pat, guard, body, span, id, is_placeholder: _ } = &mut arm;
405 visit_attrs(attrs, vis);
408 visit_opt(guard, |guard| vis.visit_expr(guard));
409 vis.visit_expr(body);
410 vis.visit_span(span);
414 pub fn noop_visit_ty_constraint<T: MutVisitor>(
415 AssocTyConstraint { id, ident, kind, span }: &mut AssocTyConstraint,
419 vis.visit_ident(ident);
421 AssocTyConstraintKind::Equality { ref mut ty } => {
424 AssocTyConstraintKind::Bound { ref mut bounds } => {
425 visit_bounds(bounds, vis);
428 vis.visit_span(span);
431 pub fn noop_visit_ty<T: MutVisitor>(ty: &mut P<Ty>, vis: &mut T) {
432 let Ty { id, kind, span } = ty.deref_mut();
435 TyKind::Infer | TyKind::ImplicitSelf | TyKind::Err |
436 TyKind::Never | TyKind::CVarArgs => {}
437 TyKind::Slice(ty) => vis.visit_ty(ty),
438 TyKind::Ptr(mt) => vis.visit_mt(mt),
439 TyKind::Rptr(lt, mt) => {
440 visit_opt(lt, |lt| noop_visit_lifetime(lt, vis));
443 TyKind::BareFn(bft) => {
444 let BareFnTy { unsafety: _, ext: _, generic_params, decl } = bft.deref_mut();
445 generic_params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
446 vis.visit_fn_decl(decl);
448 TyKind::Tup(tys) => visit_vec(tys, |ty| vis.visit_ty(ty)),
449 TyKind::Paren(ty) => vis.visit_ty(ty),
450 TyKind::Path(qself, path) => {
451 vis.visit_qself(qself);
452 vis.visit_path(path);
454 TyKind::Array(ty, length) => {
456 vis.visit_anon_const(length);
458 TyKind::Typeof(expr) => vis.visit_anon_const(expr),
459 TyKind::TraitObject(bounds, _syntax) =>
460 visit_vec(bounds, |bound| vis.visit_param_bound(bound)),
461 TyKind::ImplTrait(id, bounds) => {
463 visit_vec(bounds, |bound| vis.visit_param_bound(bound));
465 TyKind::Mac(mac) => vis.visit_mac(mac),
467 vis.visit_span(span);
470 pub fn noop_visit_foreign_mod<T: MutVisitor>(foreign_mod: &mut ForeignMod, vis: &mut T) {
471 let ForeignMod { abi: _, items} = foreign_mod;
472 items.flat_map_in_place(|item| vis.flat_map_foreign_item(item));
475 pub fn noop_flat_map_variant<T: MutVisitor>(mut variant: Variant, visitor: &mut T)
476 -> SmallVec<[Variant; 1]>
478 let Variant { ident, vis, attrs, id, data, disr_expr, span, is_placeholder: _ } = &mut variant;
479 visitor.visit_ident(ident);
480 visitor.visit_vis(vis);
481 visit_attrs(attrs, visitor);
482 visitor.visit_id(id);
483 visitor.visit_variant_data(data);
484 visit_opt(disr_expr, |disr_expr| visitor.visit_anon_const(disr_expr));
485 visitor.visit_span(span);
489 pub fn noop_visit_ident<T: MutVisitor>(Ident { name: _, span }: &mut Ident, vis: &mut T) {
490 vis.visit_span(span);
493 pub fn noop_visit_path<T: MutVisitor>(Path { segments, span }: &mut Path, vis: &mut T) {
494 vis.visit_span(span);
495 for PathSegment { ident, id, args } in segments {
496 vis.visit_ident(ident);
498 visit_opt(args, |args| vis.visit_generic_args(args));
502 pub fn noop_visit_qself<T: MutVisitor>(qself: &mut Option<QSelf>, vis: &mut T) {
503 visit_opt(qself, |QSelf { ty, path_span, position: _ }| {
505 vis.visit_span(path_span);
509 pub fn noop_visit_generic_args<T: MutVisitor>(generic_args: &mut GenericArgs, vis: &mut T) {
511 GenericArgs::AngleBracketed(data) => vis.visit_angle_bracketed_parameter_data(data),
512 GenericArgs::Parenthesized(data) => vis.visit_parenthesized_parameter_data(data),
516 pub fn noop_visit_generic_arg<T: MutVisitor>(arg: &mut GenericArg, vis: &mut T) {
518 GenericArg::Lifetime(lt) => vis.visit_lifetime(lt),
519 GenericArg::Type(ty) => vis.visit_ty(ty),
520 GenericArg::Const(ct) => vis.visit_anon_const(ct),
524 pub fn noop_visit_angle_bracketed_parameter_data<T: MutVisitor>(data: &mut AngleBracketedArgs,
526 let AngleBracketedArgs { args, constraints, span } = data;
527 visit_vec(args, |arg| vis.visit_generic_arg(arg));
528 visit_vec(constraints, |constraint| vis.visit_ty_constraint(constraint));
529 vis.visit_span(span);
532 pub fn noop_visit_parenthesized_parameter_data<T: MutVisitor>(args: &mut ParenthesizedArgs,
534 let ParenthesizedArgs { inputs, output, span } = args;
535 visit_vec(inputs, |input| vis.visit_ty(input));
536 visit_opt(output, |output| vis.visit_ty(output));
537 vis.visit_span(span);
540 pub fn noop_visit_local<T: MutVisitor>(local: &mut P<Local>, vis: &mut T) {
541 let Local { id, pat, ty, init, span, attrs } = local.deref_mut();
544 visit_opt(ty, |ty| vis.visit_ty(ty));
545 visit_opt(init, |init| vis.visit_expr(init));
546 vis.visit_span(span);
547 visit_thin_attrs(attrs, vis);
550 pub fn noop_visit_attribute<T: MutVisitor>(attr: &mut Attribute, vis: &mut T) {
551 let Attribute { kind, id: _, style: _, span } = attr;
553 AttrKind::Normal(AttrItem { path, tokens }) => {
554 vis.visit_path(path);
555 vis.visit_tts(tokens);
557 AttrKind::DocComment(_) => {}
559 vis.visit_span(span);
562 pub fn noop_visit_mac<T: MutVisitor>(mac: &mut Mac, vis: &mut T) {
563 let Mac { path, delim: _, tts, span, prior_type_ascription: _ } = mac;
564 vis.visit_path(path);
566 vis.visit_span(span);
569 pub fn noop_visit_macro_def<T: MutVisitor>(macro_def: &mut MacroDef, vis: &mut T) {
570 let MacroDef { tokens, legacy: _ } = macro_def;
571 vis.visit_tts(tokens);
574 pub fn noop_visit_meta_list_item<T: MutVisitor>(li: &mut NestedMetaItem, vis: &mut T) {
576 NestedMetaItem::MetaItem(mi) => vis.visit_meta_item(mi),
577 NestedMetaItem::Literal(_lit) => {}
581 pub fn noop_visit_meta_item<T: MutVisitor>(mi: &mut MetaItem, vis: &mut T) {
582 let MetaItem { path: _, kind, span } = mi;
584 MetaItemKind::Word => {}
585 MetaItemKind::List(mis) => visit_vec(mis, |mi| vis.visit_meta_list_item(mi)),
586 MetaItemKind::NameValue(_s) => {}
588 vis.visit_span(span);
591 pub fn noop_flat_map_param<T: MutVisitor>(mut param: Param, vis: &mut T) -> SmallVec<[Param; 1]> {
592 let Param { attrs, id, pat, span, ty, is_placeholder: _ } = &mut param;
594 visit_thin_attrs(attrs, vis);
596 vis.visit_span(span);
601 pub fn noop_visit_tt<T: MutVisitor>(tt: &mut TokenTree, vis: &mut T) {
603 TokenTree::Token(token) => {
604 vis.visit_token(token);
606 TokenTree::Delimited(DelimSpan { open, close }, _delim, tts) => {
607 vis.visit_span(open);
608 vis.visit_span(close);
614 pub fn noop_visit_tts<T: MutVisitor>(TokenStream(tts): &mut TokenStream, vis: &mut T) {
615 let tts = Lrc::make_mut(tts);
616 visit_vec(tts, |(tree, _is_joint)| vis.visit_tt(tree));
619 // Applies ident visitor if it's an ident; applies other visits to interpolated nodes.
620 // In practice the ident part is not actually used by specific visitors right now,
621 // but there's a test below checking that it works.
622 pub fn noop_visit_token<T: MutVisitor>(t: &mut Token, vis: &mut T) {
623 let Token { kind, span } = t;
625 token::Ident(name, _) | token::Lifetime(name) => {
626 let mut ident = Ident::new(*name, *span);
627 vis.visit_ident(&mut ident);
630 return; // Avoid visiting the span for the second time.
632 token::Interpolated(nt) => {
633 let mut nt = Lrc::make_mut(nt);
634 vis.visit_interpolated(&mut nt);
638 vis.visit_span(span);
641 /// Applies the visitor to elements of interpolated nodes.
643 // N.B., this can occur only when applying a visitor to partially expanded
644 // code, where parsed pieces have gotten implanted ito *other* macro
645 // invocations. This is relevant for macro hygiene, but possibly not elsewhere.
647 // One problem here occurs because the types for flat_map_item, flat_map_stmt,
648 // etc., allow the visitor to return *multiple* items; this is a problem for the
649 // nodes here, because they insist on having exactly one piece. One solution
650 // would be to mangle the MutVisitor trait to include one-to-many and
651 // one-to-one versions of these entry points, but that would probably confuse a
652 // lot of people and help very few. Instead, I'm just going to put in dynamic
653 // checks. I think the performance impact of this will be pretty much
654 // nonexistent. The danger is that someone will apply a `MutVisitor` to a
655 // partially expanded node, and will be confused by the fact that their
656 // `flat_map_item` or `flat_map_stmt` isn't getting called on `NtItem` or `NtStmt`
657 // nodes. Hopefully they'll wind up reading this comment, and doing something
660 // BTW, design choice: I considered just changing the type of, e.g., `NtItem` to
661 // contain multiple items, but decided against it when I looked at
662 // `parse_item_or_view_item` and tried to figure out what I would do with
663 // multiple items there....
664 pub fn noop_visit_interpolated<T: MutVisitor>(nt: &mut token::Nonterminal, vis: &mut T) {
666 token::NtItem(item) =>
667 visit_clobber(item, |item| {
668 // This is probably okay, because the only visitors likely to
669 // peek inside interpolated nodes will be renamings/markings,
670 // which map single items to single items.
671 vis.flat_map_item(item).expect_one("expected visitor to produce exactly one item")
673 token::NtBlock(block) => vis.visit_block(block),
674 token::NtStmt(stmt) =>
675 visit_clobber(stmt, |stmt| {
676 // See reasoning above.
677 vis.flat_map_stmt(stmt).expect_one("expected visitor to produce exactly one item")
679 token::NtPat(pat) => vis.visit_pat(pat),
680 token::NtExpr(expr) => vis.visit_expr(expr),
681 token::NtTy(ty) => vis.visit_ty(ty),
682 token::NtIdent(ident, _is_raw) => vis.visit_ident(ident),
683 token::NtLifetime(ident) => vis.visit_ident(ident),
684 token::NtLiteral(expr) => vis.visit_expr(expr),
685 token::NtMeta(AttrItem { path, tokens }) => {
686 vis.visit_path(path);
687 vis.visit_tts(tokens);
689 token::NtPath(path) => vis.visit_path(path),
690 token::NtTT(tt) => vis.visit_tt(tt),
691 token::NtImplItem(item) =>
692 visit_clobber(item, |item| {
693 // See reasoning above.
694 vis.flat_map_impl_item(item)
695 .expect_one("expected visitor to produce exactly one item")
697 token::NtTraitItem(item) =>
698 visit_clobber(item, |item| {
699 // See reasoning above.
700 vis.flat_map_trait_item(item)
701 .expect_one("expected visitor to produce exactly one item")
703 token::NtVis(visib) => vis.visit_vis(visib),
704 token::NtForeignItem(item) =>
705 visit_clobber(item, |item| {
706 // See reasoning above.
707 vis.flat_map_foreign_item(item)
708 .expect_one("expected visitor to produce exactly one item")
713 pub fn noop_visit_asyncness<T: MutVisitor>(asyncness: &mut IsAsync, vis: &mut T) {
715 IsAsync::Async { closure_id, return_impl_trait_id } => {
716 vis.visit_id(closure_id);
717 vis.visit_id(return_impl_trait_id);
719 IsAsync::NotAsync => {}
723 pub fn noop_visit_fn_decl<T: MutVisitor>(decl: &mut P<FnDecl>, vis: &mut T) {
724 let FnDecl { inputs, output } = decl.deref_mut();
725 inputs.flat_map_in_place(|param| vis.flat_map_param(param));
727 FunctionRetTy::Default(span) => vis.visit_span(span),
728 FunctionRetTy::Ty(ty) => vis.visit_ty(ty),
732 pub fn noop_visit_param_bound<T: MutVisitor>(pb: &mut GenericBound, vis: &mut T) {
734 GenericBound::Trait(ty, _modifier) => vis.visit_poly_trait_ref(ty),
735 GenericBound::Outlives(lifetime) => noop_visit_lifetime(lifetime, vis),
739 pub fn noop_flat_map_generic_param<T: MutVisitor>(
740 mut param: GenericParam,
742 ) -> SmallVec<[GenericParam; 1]>
744 let GenericParam { id, ident, attrs, bounds, kind, is_placeholder: _ } = &mut param;
746 vis.visit_ident(ident);
747 visit_thin_attrs(attrs, vis);
748 visit_vec(bounds, |bound| noop_visit_param_bound(bound, vis));
750 GenericParamKind::Lifetime => {}
751 GenericParamKind::Type { default } => {
752 visit_opt(default, |default| vis.visit_ty(default));
754 GenericParamKind::Const { ty } => {
761 pub fn noop_visit_label<T: MutVisitor>(Label { ident }: &mut Label, vis: &mut T) {
762 vis.visit_ident(ident);
765 fn noop_visit_lifetime<T: MutVisitor>(Lifetime { id, ident }: &mut Lifetime, vis: &mut T) {
767 vis.visit_ident(ident);
770 pub fn noop_visit_generics<T: MutVisitor>(generics: &mut Generics, vis: &mut T) {
771 let Generics { params, where_clause, span } = generics;
772 params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
773 vis.visit_where_clause(where_clause);
774 vis.visit_span(span);
777 pub fn noop_visit_where_clause<T: MutVisitor>(wc: &mut WhereClause, vis: &mut T) {
778 let WhereClause { predicates, span } = wc;
779 visit_vec(predicates, |predicate| vis.visit_where_predicate(predicate));
780 vis.visit_span(span);
783 pub fn noop_visit_where_predicate<T: MutVisitor>(pred: &mut WherePredicate, vis: &mut T) {
785 WherePredicate::BoundPredicate(bp) => {
786 let WhereBoundPredicate { span, bound_generic_params, bounded_ty, bounds } = bp;
787 vis.visit_span(span);
788 bound_generic_params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
789 vis.visit_ty(bounded_ty);
790 visit_vec(bounds, |bound| vis.visit_param_bound(bound));
792 WherePredicate::RegionPredicate(rp) => {
793 let WhereRegionPredicate { span, lifetime, bounds } = rp;
794 vis.visit_span(span);
795 noop_visit_lifetime(lifetime, vis);
796 visit_vec(bounds, |bound| noop_visit_param_bound(bound, vis));
798 WherePredicate::EqPredicate(ep) => {
799 let WhereEqPredicate { id, span, lhs_ty, rhs_ty } = ep;
801 vis.visit_span(span);
802 vis.visit_ty(lhs_ty);
803 vis.visit_ty(rhs_ty);
808 pub fn noop_visit_variant_data<T: MutVisitor>(vdata: &mut VariantData, vis: &mut T) {
810 VariantData::Struct(fields, ..) => {
811 fields.flat_map_in_place(|field| vis.flat_map_struct_field(field));
813 VariantData::Tuple(fields, id) => {
814 fields.flat_map_in_place(|field| vis.flat_map_struct_field(field));
817 VariantData::Unit(id) => vis.visit_id(id),
821 pub fn noop_visit_trait_ref<T: MutVisitor>(TraitRef { path, ref_id }: &mut TraitRef, vis: &mut T) {
822 vis.visit_path(path);
823 vis.visit_id(ref_id);
826 pub fn noop_visit_poly_trait_ref<T: MutVisitor>(p: &mut PolyTraitRef, vis: &mut T) {
827 let PolyTraitRef { bound_generic_params, trait_ref, span } = p;
828 bound_generic_params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
829 vis.visit_trait_ref(trait_ref);
830 vis.visit_span(span);
833 pub fn noop_flat_map_struct_field<T: MutVisitor>(mut sf: StructField, visitor: &mut T)
834 -> SmallVec<[StructField; 1]>
836 let StructField { span, ident, vis, id, ty, attrs, is_placeholder: _ } = &mut sf;
837 visitor.visit_span(span);
838 visit_opt(ident, |ident| visitor.visit_ident(ident));
839 visitor.visit_vis(vis);
840 visitor.visit_id(id);
841 visitor.visit_ty(ty);
842 visit_attrs(attrs, visitor);
846 pub fn noop_flat_map_field<T: MutVisitor>(mut f: Field, vis: &mut T) -> SmallVec<[Field; 1]> {
847 let Field { ident, expr, span, is_shorthand: _, attrs, id, is_placeholder: _ } = &mut f;
848 vis.visit_ident(ident);
849 vis.visit_expr(expr);
851 vis.visit_span(span);
852 visit_thin_attrs(attrs, vis);
856 pub fn noop_visit_mt<T: MutVisitor>(MutTy { ty, mutbl: _ }: &mut MutTy, vis: &mut T) {
860 pub fn noop_visit_block<T: MutVisitor>(block: &mut P<Block>, vis: &mut T) {
861 let Block { id, stmts, rules: _, span } = block.deref_mut();
863 stmts.flat_map_in_place(|stmt| vis.flat_map_stmt(stmt));
864 vis.visit_span(span);
867 pub fn noop_visit_item_kind<T: MutVisitor>(kind: &mut ItemKind, vis: &mut T) {
869 ItemKind::ExternCrate(_orig_name) => {}
870 ItemKind::Use(use_tree) => vis.visit_use_tree(use_tree),
871 ItemKind::Static(ty, _mut, expr) => {
873 vis.visit_expr(expr);
875 ItemKind::Const(ty, expr) => {
877 vis.visit_expr(expr);
879 ItemKind::Fn(sig, generics, body) => {
880 visit_fn_sig(sig, vis);
881 vis.visit_generics(generics);
882 vis.visit_block(body);
884 ItemKind::Mod(m) => vis.visit_mod(m),
885 ItemKind::ForeignMod(nm) => vis.visit_foreign_mod(nm),
886 ItemKind::GlobalAsm(_ga) => {}
887 ItemKind::TyAlias(ty, generics) => {
889 vis.visit_generics(generics);
891 ItemKind::Enum(EnumDef { variants }, generics) => {
892 variants.flat_map_in_place(|variant| vis.flat_map_variant(variant));
893 vis.visit_generics(generics);
895 ItemKind::Struct(variant_data, generics) |
896 ItemKind::Union(variant_data, generics) => {
897 vis.visit_variant_data(variant_data);
898 vis.visit_generics(generics);
900 ItemKind::Impl(_unsafety, _polarity, _defaultness, generics, trait_ref, ty, items) => {
901 vis.visit_generics(generics);
902 visit_opt(trait_ref, |trait_ref| vis.visit_trait_ref(trait_ref));
904 items.flat_map_in_place(|item| vis.flat_map_impl_item(item));
906 ItemKind::Trait(_is_auto, _unsafety, generics, bounds, items) => {
907 vis.visit_generics(generics);
908 visit_bounds(bounds, vis);
909 items.flat_map_in_place(|item| vis.flat_map_trait_item(item));
911 ItemKind::TraitAlias(generics, bounds) => {
912 vis.visit_generics(generics);
913 visit_bounds(bounds, vis);
915 ItemKind::Mac(m) => vis.visit_mac(m),
916 ItemKind::MacroDef(def) => vis.visit_macro_def(def),
920 pub fn noop_flat_map_trait_item<T: MutVisitor>(mut item: TraitItem, visitor: &mut T)
921 -> SmallVec<[TraitItem; 1]>
923 let TraitItem { id, ident, vis, attrs, generics, kind, span, tokens: _ } = &mut item;
924 visitor.visit_id(id);
925 visitor.visit_ident(ident);
926 visitor.visit_vis(vis);
927 visit_attrs(attrs, visitor);
928 visitor.visit_generics(generics);
930 TraitItemKind::Const(ty, default) => {
931 visitor.visit_ty(ty);
932 visit_opt(default, |default| visitor.visit_expr(default));
934 TraitItemKind::Method(sig, body) => {
935 visit_fn_sig(sig, visitor);
936 visit_opt(body, |body| visitor.visit_block(body));
938 TraitItemKind::Type(bounds, default) => {
939 visit_bounds(bounds, visitor);
940 visit_opt(default, |default| visitor.visit_ty(default));
942 TraitItemKind::Macro(mac) => {
943 visitor.visit_mac(mac);
946 visitor.visit_span(span);
951 pub fn noop_flat_map_impl_item<T: MutVisitor>(mut item: ImplItem, visitor: &mut T)
952 -> SmallVec<[ImplItem; 1]>
954 let ImplItem { id, ident, vis, defaultness: _, attrs, generics, kind, span, tokens: _ } =
956 visitor.visit_id(id);
957 visitor.visit_ident(ident);
958 visitor.visit_vis(vis);
959 visit_attrs(attrs, visitor);
960 visitor.visit_generics(generics);
962 ImplItemKind::Const(ty, expr) => {
963 visitor.visit_ty(ty);
964 visitor.visit_expr(expr);
966 ImplItemKind::Method(sig, body) => {
967 visit_fn_sig(sig, visitor);
968 visitor.visit_block(body);
970 ImplItemKind::TyAlias(ty) => visitor.visit_ty(ty),
971 ImplItemKind::Macro(mac) => visitor.visit_mac(mac),
973 visitor.visit_span(span);
978 pub fn noop_visit_fn_header<T: MutVisitor>(header: &mut FnHeader, vis: &mut T) {
979 let FnHeader { unsafety: _, asyncness, constness: _, ext: _ } = header;
980 vis.visit_asyncness(&mut asyncness.node);
983 pub fn noop_visit_mod<T: MutVisitor>(Mod { inner, items, inline: _ }: &mut Mod, vis: &mut T) {
984 vis.visit_span(inner);
985 items.flat_map_in_place(|item| vis.flat_map_item(item));
988 pub fn noop_visit_crate<T: MutVisitor>(krate: &mut Crate, vis: &mut T) {
989 visit_clobber(krate, |Crate { module, attrs, span }| {
991 ident: Ident::invalid(),
994 vis: respan(span.shrink_to_lo(), VisibilityKind::Public),
996 kind: ItemKind::Mod(module),
999 let items = vis.flat_map_item(item);
1001 let len = items.len();
1003 let module = Mod { inner: span, items: vec![], inline: true };
1004 Crate { module, attrs: vec![], span }
1005 } else if len == 1 {
1006 let Item { attrs, span, kind, .. } = items.into_iter().next().unwrap().into_inner();
1008 ItemKind::Mod(module) => Crate { module, attrs, span },
1009 _ => panic!("visitor converted a module to not a module"),
1012 panic!("a crate cannot expand to more than one item");
1017 // Mutates one item into possibly many items.
1018 pub fn noop_flat_map_item<T: MutVisitor>(mut item: P<Item>, visitor: &mut T)
1019 -> SmallVec<[P<Item>; 1]> {
1020 let Item { ident, attrs, id, kind, vis, span, tokens: _ } = item.deref_mut();
1021 visitor.visit_ident(ident);
1022 visit_attrs(attrs, visitor);
1023 visitor.visit_id(id);
1024 visitor.visit_item_kind(kind);
1025 visitor.visit_vis(vis);
1026 visitor.visit_span(span);
1028 // FIXME: if `tokens` is modified with a call to `vis.visit_tts` it causes
1029 // an ICE during resolve... odd!
1034 pub fn noop_flat_map_foreign_item<T: MutVisitor>(mut item: ForeignItem, visitor: &mut T)
1035 -> SmallVec<[ForeignItem; 1]>
1037 let ForeignItem { ident, attrs, kind, id, span, vis } = &mut item;
1038 visitor.visit_ident(ident);
1039 visit_attrs(attrs, visitor);
1041 ForeignItemKind::Fn(fdec, generics) => {
1042 visitor.visit_fn_decl(fdec);
1043 visitor.visit_generics(generics);
1045 ForeignItemKind::Static(t, _m) => visitor.visit_ty(t),
1046 ForeignItemKind::Ty => {}
1047 ForeignItemKind::Macro(mac) => visitor.visit_mac(mac),
1049 visitor.visit_id(id);
1050 visitor.visit_span(span);
1051 visitor.visit_vis(vis);
1056 pub fn noop_visit_pat<T: MutVisitor>(pat: &mut P<Pat>, vis: &mut T) {
1057 let Pat { id, kind, span } = 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: _ }) => {
1083 vis.visit_span(span);
1085 PatKind::Tuple(elems)
1086 | PatKind::Slice(elems)
1087 | PatKind::Or(elems) => visit_vec(elems, |elem| vis.visit_pat(elem)),
1088 PatKind::Paren(inner) => vis.visit_pat(inner),
1089 PatKind::Mac(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>(Expr { kind, id, span, attrs }: &mut Expr, vis: &mut T) {
1101 ExprKind::Box(expr) => vis.visit_expr(expr),
1102 ExprKind::Array(exprs) => visit_exprs(exprs, vis),
1103 ExprKind::Repeat(expr, count) => {
1104 vis.visit_expr(expr);
1105 vis.visit_anon_const(count);
1107 ExprKind::Tup(exprs) => visit_exprs(exprs, vis),
1108 ExprKind::Call(f, args) => {
1110 visit_exprs(args, vis);
1112 ExprKind::MethodCall(PathSegment { ident, id, args }, exprs) => {
1113 vis.visit_ident(ident);
1115 visit_opt(args, |args| vis.visit_generic_args(args));
1116 visit_exprs(exprs, vis);
1118 ExprKind::Binary(_binop, lhs, rhs) => {
1119 vis.visit_expr(lhs);
1120 vis.visit_expr(rhs);
1122 ExprKind::Unary(_unop, ohs) => vis.visit_expr(ohs),
1123 ExprKind::Cast(expr, ty) => {
1124 vis.visit_expr(expr);
1127 ExprKind::Type(expr, ty) => {
1128 vis.visit_expr(expr);
1131 ExprKind::AddrOf(_, _, ohs) => vis.visit_expr(ohs),
1132 ExprKind::Let(pat, scrutinee) => {
1134 vis.visit_expr(scrutinee);
1136 ExprKind::If(cond, tr, fl) => {
1137 vis.visit_expr(cond);
1138 vis.visit_block(tr);
1139 visit_opt(fl, |fl| vis.visit_expr(fl));
1141 ExprKind::While(cond, body, label) => {
1142 vis.visit_expr(cond);
1143 vis.visit_block(body);
1144 visit_opt(label, |label| vis.visit_label(label));
1146 ExprKind::ForLoop(pat, iter, body, label) => {
1148 vis.visit_expr(iter);
1149 vis.visit_block(body);
1150 visit_opt(label, |label| vis.visit_label(label));
1152 ExprKind::Loop(body, label) => {
1153 vis.visit_block(body);
1154 visit_opt(label, |label| vis.visit_label(label));
1156 ExprKind::Match(expr, arms) => {
1157 vis.visit_expr(expr);
1158 arms.flat_map_in_place(|arm| vis.flat_map_arm(arm));
1160 ExprKind::Closure(_capture_by, asyncness, _movability, decl, body, span) => {
1161 vis.visit_asyncness(asyncness);
1162 vis.visit_fn_decl(decl);
1163 vis.visit_expr(body);
1164 vis.visit_span(span);
1166 ExprKind::Block(blk, label) => {
1167 vis.visit_block(blk);
1168 visit_opt(label, |label| vis.visit_label(label));
1170 ExprKind::Async(_capture_by, node_id, body) => {
1171 vis.visit_id(node_id);
1172 vis.visit_block(body);
1174 ExprKind::Await(expr) => vis.visit_expr(expr),
1175 ExprKind::Assign(el, er) => {
1179 ExprKind::AssignOp(_op, el, er) => {
1183 ExprKind::Field(el, ident) => {
1185 vis.visit_ident(ident);
1187 ExprKind::Index(el, er) => {
1191 ExprKind::Range(e1, e2, _lim) => {
1192 visit_opt(e1, |e1| vis.visit_expr(e1));
1193 visit_opt(e2, |e2| vis.visit_expr(e2));
1195 ExprKind::Path(qself, path) => {
1196 vis.visit_qself(qself);
1197 vis.visit_path(path);
1199 ExprKind::Break(label, expr) => {
1200 visit_opt(label, |label| vis.visit_label(label));
1201 visit_opt(expr, |expr| vis.visit_expr(expr));
1203 ExprKind::Continue(label) => {
1204 visit_opt(label, |label| vis.visit_label(label));
1206 ExprKind::Ret(expr) => {
1207 visit_opt(expr, |expr| vis.visit_expr(expr));
1209 ExprKind::InlineAsm(asm) => {
1210 let InlineAsm { asm: _, asm_str_style: _, outputs, inputs, clobbers: _, volatile: _,
1211 alignstack: _, dialect: _ } = asm.deref_mut();
1212 for out in outputs {
1213 let InlineAsmOutput { constraint: _, expr, is_rw: _, is_indirect: _ } = out;
1214 vis.visit_expr(expr);
1216 visit_vec(inputs, |(_c, expr)| vis.visit_expr(expr));
1218 ExprKind::Mac(mac) => vis.visit_mac(mac),
1219 ExprKind::Struct(path, fields, expr) => {
1220 vis.visit_path(path);
1221 fields.flat_map_in_place(|field| vis.flat_map_field(field));
1222 visit_opt(expr, |expr| vis.visit_expr(expr));
1224 ExprKind::Paren(expr) => {
1225 vis.visit_expr(expr);
1227 // Nodes that are equal modulo `Paren` sugar no-ops should have the same IDs.
1229 vis.visit_span(span);
1230 visit_thin_attrs(attrs, vis);
1233 ExprKind::Yield(expr) => {
1234 visit_opt(expr, |expr| vis.visit_expr(expr));
1236 ExprKind::Try(expr) => vis.visit_expr(expr),
1237 ExprKind::TryBlock(body) => vis.visit_block(body),
1238 ExprKind::Lit(_) | ExprKind::Err => {}
1241 vis.visit_span(span);
1242 visit_thin_attrs(attrs, vis);
1245 pub fn noop_filter_map_expr<T: MutVisitor>(mut e: P<Expr>, vis: &mut T) -> Option<P<Expr>> {
1246 Some({ vis.visit_expr(&mut e); e })
1249 pub fn noop_flat_map_stmt<T: MutVisitor>(Stmt { kind, mut span, mut id }: Stmt, vis: &mut T)
1250 -> SmallVec<[Stmt; 1]>
1252 vis.visit_id(&mut id);
1253 vis.visit_span(&mut span);
1254 noop_flat_map_stmt_kind(kind, vis).into_iter().map(|kind| {
1255 Stmt { id, kind, span }
1259 pub fn noop_flat_map_stmt_kind<T: MutVisitor>(kind: StmtKind, vis: &mut T)
1260 -> SmallVec<[StmtKind; 1]> {
1262 StmtKind::Local(mut local) =>
1263 smallvec![StmtKind::Local({ vis.visit_local(&mut local); local })],
1264 StmtKind::Item(item) => vis.flat_map_item(item).into_iter().map(StmtKind::Item).collect(),
1265 StmtKind::Expr(expr) => {
1266 vis.filter_map_expr(expr).into_iter().map(StmtKind::Expr).collect()
1268 StmtKind::Semi(expr) => {
1269 vis.filter_map_expr(expr).into_iter().map(StmtKind::Semi).collect()
1271 StmtKind::Mac(mut mac) => {
1272 let (mac_, _semi, attrs) = mac.deref_mut();
1273 vis.visit_mac(mac_);
1274 visit_thin_attrs(attrs, vis);
1275 smallvec![StmtKind::Mac(mac)]
1280 pub fn noop_visit_vis<T: MutVisitor>(Spanned { node, span }: &mut Visibility, vis: &mut T) {
1282 VisibilityKind::Public | VisibilityKind::Crate(_) | VisibilityKind::Inherited => {}
1283 VisibilityKind::Restricted { path, id } => {
1284 vis.visit_path(path);
1288 vis.visit_span(span);