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::parse::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};
28 pub trait ExpectOne<A: Array> {
29 fn expect_one(self, err: &'static str) -> A::Item;
32 impl<A: Array> ExpectOne<A> for SmallVec<A> {
33 fn expect_one(self, err: &'static str) -> A::Item {
34 assert!(self.len() == 1, err);
35 self.into_iter().next().unwrap()
39 pub trait MutVisitor: Sized {
40 // Methods in this trait have one of three forms:
42 // fn visit_t(&mut self, t: &mut T); // common
43 // fn flat_map_t(&mut self, t: T) -> SmallVec<[T; 1]>; // rare
44 // fn filter_map_t(&mut self, t: T) -> Option<T>; // rarest
46 // Any additions to this trait should happen in form of a call to a public
47 // `noop_*` function that only calls out to the visitor again, not other
48 // `noop_*` functions. This is a necessary API workaround to the problem of
49 // not being able to call out to the super default method in an overridden
52 // When writing these methods, it is better to use destructuring like this:
54 // fn visit_abc(&mut self, ABC { a, b, c: _ }: &mut ABC) {
59 // than to use field access like this:
61 // fn visit_abc(&mut self, abc: &mut ABC) {
62 // visit_a(&mut abc.a);
63 // visit_b(&mut abc.b);
67 // As well as being more concise, the former is explicit about which fields
68 // are skipped. Furthermore, if a new field is added, the destructuring
69 // version will cause a compile error, which is good. In comparison, the
70 // field access version will continue working and it would be easy to
71 // forget to add handling for it.
73 fn visit_crate(&mut self, c: &mut Crate) {
74 noop_visit_crate(c, self)
77 fn visit_meta_list_item(&mut self, list_item: &mut NestedMetaItem) {
78 noop_visit_meta_list_item(list_item, self);
81 fn visit_meta_item(&mut self, meta_item: &mut MetaItem) {
82 noop_visit_meta_item(meta_item, self);
85 fn visit_use_tree(&mut self, use_tree: &mut UseTree) {
86 noop_visit_use_tree(use_tree, self);
89 fn flat_map_foreign_item(&mut self, ni: ForeignItem) -> SmallVec<[ForeignItem; 1]> {
90 noop_flat_map_foreign_item(ni, self)
93 fn flat_map_item(&mut self, i: P<Item>) -> SmallVec<[P<Item>; 1]> {
94 noop_flat_map_item(i, self)
97 fn visit_fn_header(&mut self, header: &mut FnHeader) {
98 noop_visit_fn_header(header, self);
101 fn flat_map_struct_field(&mut self, sf: StructField) -> SmallVec<[StructField; 1]> {
102 noop_flat_map_struct_field(sf, self)
105 fn visit_item_kind(&mut self, i: &mut ItemKind) {
106 noop_visit_item_kind(i, self);
109 fn flat_map_trait_item(&mut self, i: TraitItem) -> SmallVec<[TraitItem; 1]> {
110 noop_flat_map_trait_item(i, self)
113 fn flat_map_impl_item(&mut self, i: ImplItem) -> SmallVec<[ImplItem; 1]> {
114 noop_flat_map_impl_item(i, self)
117 fn visit_fn_decl(&mut self, d: &mut P<FnDecl>) {
118 noop_visit_fn_decl(d, self);
121 fn visit_asyncness(&mut self, a: &mut IsAsync) {
122 noop_visit_asyncness(a, self);
125 fn visit_block(&mut self, b: &mut P<Block>) {
126 noop_visit_block(b, self);
129 fn flat_map_stmt(&mut self, s: Stmt) -> SmallVec<[Stmt; 1]> {
130 noop_flat_map_stmt(s, self)
133 fn flat_map_arm(&mut self, arm: Arm) -> SmallVec<[Arm; 1]> {
134 noop_flat_map_arm(arm, self)
137 fn visit_pat(&mut self, p: &mut P<Pat>) {
138 noop_visit_pat(p, self);
141 fn visit_anon_const(&mut self, c: &mut AnonConst) {
142 noop_visit_anon_const(c, self);
145 fn visit_expr(&mut self, e: &mut P<Expr>) {
146 noop_visit_expr(e, self);
149 fn filter_map_expr(&mut self, e: P<Expr>) -> Option<P<Expr>> {
150 noop_filter_map_expr(e, self)
153 fn visit_generic_arg(&mut self, arg: &mut GenericArg) {
154 noop_visit_generic_arg(arg, self);
157 fn visit_ty(&mut self, t: &mut P<Ty>) {
158 noop_visit_ty(t, self);
161 fn visit_lifetime(&mut self, l: &mut Lifetime) {
162 noop_visit_lifetime(l, self);
165 fn visit_ty_constraint(&mut self, t: &mut AssocTyConstraint) {
166 noop_visit_ty_constraint(t, self);
169 fn visit_mod(&mut self, m: &mut Mod) {
170 noop_visit_mod(m, self);
173 fn visit_foreign_mod(&mut self, nm: &mut ForeignMod) {
174 noop_visit_foreign_mod(nm, self);
177 fn flat_map_variant(&mut self, v: Variant) -> SmallVec<[Variant; 1]> {
178 noop_flat_map_variant(v, self)
181 fn visit_ident(&mut self, i: &mut Ident) {
182 noop_visit_ident(i, self);
185 fn visit_path(&mut self, p: &mut Path) {
186 noop_visit_path(p, self);
189 fn visit_qself(&mut self, qs: &mut Option<QSelf>) {
190 noop_visit_qself(qs, self);
193 fn visit_generic_args(&mut self, p: &mut GenericArgs) {
194 noop_visit_generic_args(p, self);
197 fn visit_angle_bracketed_parameter_data(&mut self, p: &mut AngleBracketedArgs) {
198 noop_visit_angle_bracketed_parameter_data(p, self);
201 fn visit_parenthesized_parameter_data(&mut self, p: &mut ParenthesizedArgs) {
202 noop_visit_parenthesized_parameter_data(p, self);
205 fn visit_local(&mut self, l: &mut P<Local>) {
206 noop_visit_local(l, self);
209 fn visit_mac(&mut self, _mac: &mut Mac) {
210 panic!("visit_mac disabled by default");
211 // N.B., see note about macros above. If you really want a visitor that
212 // works on macros, use this definition in your trait impl:
213 // mut_visit::noop_visit_mac(_mac, self);
216 fn visit_macro_def(&mut self, def: &mut MacroDef) {
217 noop_visit_macro_def(def, self);
220 fn visit_label(&mut self, label: &mut Label) {
221 noop_visit_label(label, self);
224 fn visit_attribute(&mut self, at: &mut Attribute) {
225 noop_visit_attribute(at, self);
228 fn flat_map_param(&mut self, param: Param) -> SmallVec<[Param; 1]> {
229 noop_flat_map_param(param, self)
232 fn visit_generics(&mut self, generics: &mut Generics) {
233 noop_visit_generics(generics, self);
236 fn visit_trait_ref(&mut self, tr: &mut TraitRef) {
237 noop_visit_trait_ref(tr, self);
240 fn visit_poly_trait_ref(&mut self, p: &mut PolyTraitRef) {
241 noop_visit_poly_trait_ref(p, self);
244 fn visit_variant_data(&mut self, vdata: &mut VariantData) {
245 noop_visit_variant_data(vdata, self);
248 fn flat_map_generic_param(&mut self, param: GenericParam) -> SmallVec<[GenericParam; 1]> {
249 noop_flat_map_generic_param(param, self)
252 fn visit_tt(&mut self, tt: &mut TokenTree) {
253 noop_visit_tt(tt, self);
256 fn visit_tts(&mut self, tts: &mut TokenStream) {
257 noop_visit_tts(tts, self);
260 fn visit_token(&mut self, t: &mut Token) {
261 noop_visit_token(t, self);
264 fn visit_interpolated(&mut self, nt: &mut token::Nonterminal) {
265 noop_visit_interpolated(nt, self);
268 fn visit_param_bound(&mut self, tpb: &mut GenericBound) {
269 noop_visit_param_bound(tpb, self);
272 fn visit_mt(&mut self, mt: &mut MutTy) {
273 noop_visit_mt(mt, self);
276 fn flat_map_field(&mut self, f: Field) -> SmallVec<[Field; 1]> {
277 noop_flat_map_field(f, self)
280 fn visit_where_clause(&mut self, where_clause: &mut WhereClause) {
281 noop_visit_where_clause(where_clause, self);
284 fn visit_where_predicate(&mut self, where_predicate: &mut WherePredicate) {
285 noop_visit_where_predicate(where_predicate, self);
288 fn visit_vis(&mut self, vis: &mut Visibility) {
289 noop_visit_vis(vis, self);
292 fn visit_id(&mut self, _id: &mut NodeId) {
296 fn visit_span(&mut self, _sp: &mut Span) {
300 fn flat_map_field_pattern(&mut self, fp: FieldPat) -> SmallVec<[FieldPat; 1]> {
301 noop_flat_map_field_pattern(fp, self)
305 /// Use a map-style function (`FnOnce(T) -> T`) to overwrite a `&mut T`. Useful
306 /// when using a `flat_map_*` or `filter_map_*` method within a `visit_`
307 /// method. Abort the program if the closure panics.
309 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
310 pub fn visit_clobber<T, F>(t: &mut T, f: F) where F: FnOnce(T) -> T {
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) where F: FnMut(&mut T) {
329 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
331 pub fn visit_opt<T, F>(opt: &mut Option<T>, mut visit_elem: F) where F: FnMut(&mut T) {
332 if let Some(elem) = opt {
337 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
338 pub fn visit_attrs<T: MutVisitor>(attrs: &mut Vec<Attribute>, vis: &mut T) {
339 visit_vec(attrs, |attr| vis.visit_attribute(attr));
342 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
343 pub fn visit_thin_attrs<T: MutVisitor>(attrs: &mut ThinVec<Attribute>, vis: &mut T) {
344 for attr in attrs.iter_mut() {
345 vis.visit_attribute(attr);
349 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
350 pub fn visit_exprs<T: MutVisitor>(exprs: &mut Vec<P<Expr>>, vis: &mut T) {
351 exprs.flat_map_in_place(|expr| vis.filter_map_expr(expr))
354 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
355 pub fn visit_bounds<T: MutVisitor>(bounds: &mut GenericBounds, vis: &mut T) {
356 visit_vec(bounds, |bound| vis.visit_param_bound(bound));
359 // No `noop_` prefix because there isn't a corresponding method in `MutVisitor`.
360 pub fn visit_method_sig<T: MutVisitor>(MethodSig { header, decl }: &mut MethodSig, vis: &mut T) {
361 vis.visit_fn_header(header);
362 vis.visit_fn_decl(decl);
365 pub fn noop_flat_map_field_pattern<T: MutVisitor>(
368 ) -> SmallVec<[FieldPat; 1]> {
379 vis.visit_ident(ident);
381 vis.visit_span(span);
382 visit_thin_attrs(attrs, vis);
386 pub fn noop_visit_use_tree<T: MutVisitor>(use_tree: &mut UseTree, vis: &mut T) {
387 let UseTree { prefix, kind, span } = use_tree;
388 vis.visit_path(prefix);
390 UseTreeKind::Simple(rename, id1, id2) => {
391 visit_opt(rename, |rename| vis.visit_ident(rename));
395 UseTreeKind::Nested(items) => {
396 for (tree, id) in items {
397 vis.visit_use_tree(tree);
401 UseTreeKind::Glob => {}
403 vis.visit_span(span);
406 pub fn noop_flat_map_arm<T: MutVisitor>(mut arm: Arm, vis: &mut T) -> SmallVec<[Arm; 1]> {
407 let Arm { attrs, pat, guard, body, span, id, is_placeholder: _ } = &mut arm;
408 visit_attrs(attrs, vis);
411 visit_opt(guard, |guard| vis.visit_expr(guard));
412 vis.visit_expr(body);
413 vis.visit_span(span);
417 pub fn noop_visit_ty_constraint<T: MutVisitor>(
418 AssocTyConstraint { id, ident, kind, span }: &mut AssocTyConstraint,
422 vis.visit_ident(ident);
424 AssocTyConstraintKind::Equality { ref mut ty } => {
427 AssocTyConstraintKind::Bound { ref mut bounds } => {
428 visit_bounds(bounds, vis);
431 vis.visit_span(span);
434 pub fn noop_visit_ty<T: MutVisitor>(ty: &mut P<Ty>, vis: &mut T) {
435 let Ty { id, node, span } = ty.deref_mut();
438 TyKind::Infer | TyKind::ImplicitSelf | TyKind::Err |
439 TyKind::Never | TyKind::CVarArgs => {}
440 TyKind::Slice(ty) => vis.visit_ty(ty),
441 TyKind::Ptr(mt) => vis.visit_mt(mt),
442 TyKind::Rptr(lt, mt) => {
443 visit_opt(lt, |lt| noop_visit_lifetime(lt, vis));
446 TyKind::BareFn(bft) => {
447 let BareFnTy { unsafety: _, abi: _, generic_params, decl } = bft.deref_mut();
448 generic_params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
449 vis.visit_fn_decl(decl);
451 TyKind::Tup(tys) => visit_vec(tys, |ty| vis.visit_ty(ty)),
452 TyKind::Paren(ty) => vis.visit_ty(ty),
453 TyKind::Path(qself, path) => {
454 vis.visit_qself(qself);
455 vis.visit_path(path);
457 TyKind::Array(ty, length) => {
459 vis.visit_anon_const(length);
461 TyKind::Typeof(expr) => vis.visit_anon_const(expr),
462 TyKind::TraitObject(bounds, _syntax) =>
463 visit_vec(bounds, |bound| vis.visit_param_bound(bound)),
464 TyKind::ImplTrait(id, bounds) => {
466 visit_vec(bounds, |bound| vis.visit_param_bound(bound));
468 TyKind::Mac(mac) => vis.visit_mac(mac),
470 vis.visit_span(span);
473 pub fn noop_visit_foreign_mod<T: MutVisitor>(foreign_mod: &mut ForeignMod, vis: &mut T) {
474 let ForeignMod { abi: _, items} = foreign_mod;
475 items.flat_map_in_place(|item| vis.flat_map_foreign_item(item));
478 pub fn noop_flat_map_variant<T: MutVisitor>(mut variant: Variant, vis: &mut T)
479 -> SmallVec<[Variant; 1]>
481 let Variant { ident, attrs, id, data, disr_expr, span, is_placeholder: _ } = &mut variant;
482 vis.visit_ident(ident);
483 visit_attrs(attrs, vis);
485 vis.visit_variant_data(data);
486 visit_opt(disr_expr, |disr_expr| vis.visit_anon_const(disr_expr));
487 vis.visit_span(span);
491 pub fn noop_visit_ident<T: MutVisitor>(Ident { name: _, span }: &mut Ident, vis: &mut T) {
492 vis.visit_span(span);
495 pub fn noop_visit_path<T: MutVisitor>(Path { segments, span }: &mut Path, vis: &mut T) {
496 vis.visit_span(span);
497 for PathSegment { ident, id, args } in segments {
498 vis.visit_ident(ident);
500 visit_opt(args, |args| vis.visit_generic_args(args));
504 pub fn noop_visit_qself<T: MutVisitor>(qself: &mut Option<QSelf>, vis: &mut T) {
505 visit_opt(qself, |QSelf { ty, path_span, position: _ }| {
507 vis.visit_span(path_span);
511 pub fn noop_visit_generic_args<T: MutVisitor>(generic_args: &mut GenericArgs, vis: &mut T) {
513 GenericArgs::AngleBracketed(data) => vis.visit_angle_bracketed_parameter_data(data),
514 GenericArgs::Parenthesized(data) => vis.visit_parenthesized_parameter_data(data),
518 pub fn noop_visit_generic_arg<T: MutVisitor>(arg: &mut GenericArg, vis: &mut T) {
520 GenericArg::Lifetime(lt) => vis.visit_lifetime(lt),
521 GenericArg::Type(ty) => vis.visit_ty(ty),
522 GenericArg::Const(ct) => vis.visit_anon_const(ct),
526 pub fn noop_visit_angle_bracketed_parameter_data<T: MutVisitor>(data: &mut AngleBracketedArgs,
528 let AngleBracketedArgs { args, constraints, span } = data;
529 visit_vec(args, |arg| vis.visit_generic_arg(arg));
530 visit_vec(constraints, |constraint| vis.visit_ty_constraint(constraint));
531 vis.visit_span(span);
534 pub fn noop_visit_parenthesized_parameter_data<T: MutVisitor>(args: &mut ParenthesizedArgs,
536 let ParenthesizedArgs { inputs, output, span } = args;
537 visit_vec(inputs, |input| vis.visit_ty(input));
538 visit_opt(output, |output| vis.visit_ty(output));
539 vis.visit_span(span);
542 pub fn noop_visit_local<T: MutVisitor>(local: &mut P<Local>, vis: &mut T) {
543 let Local { id, pat, ty, init, span, attrs } = local.deref_mut();
546 visit_opt(ty, |ty| vis.visit_ty(ty));
547 visit_opt(init, |init| vis.visit_expr(init));
548 vis.visit_span(span);
549 visit_thin_attrs(attrs, vis);
552 pub fn noop_visit_attribute<T: MutVisitor>(attr: &mut Attribute, vis: &mut T) {
553 let Attribute { id: _, style: _, path, tokens, is_sugared_doc: _, span } = attr;
554 vis.visit_path(path);
555 vis.visit_tts(tokens);
556 vis.visit_span(span);
559 pub fn noop_visit_mac<T: MutVisitor>(mac: &mut Mac, vis: &mut T) {
560 let Mac { path, delim: _, tts, span, prior_type_ascription: _ } = mac;
561 vis.visit_path(path);
563 vis.visit_span(span);
566 pub fn noop_visit_macro_def<T: MutVisitor>(macro_def: &mut MacroDef, vis: &mut T) {
567 let MacroDef { tokens, legacy: _ } = macro_def;
568 vis.visit_tts(tokens);
571 pub fn noop_visit_meta_list_item<T: MutVisitor>(li: &mut NestedMetaItem, vis: &mut T) {
573 NestedMetaItem::MetaItem(mi) => vis.visit_meta_item(mi),
574 NestedMetaItem::Literal(_lit) => {}
578 pub fn noop_visit_meta_item<T: MutVisitor>(mi: &mut MetaItem, vis: &mut T) {
579 let MetaItem { path: _, node, span } = mi;
581 MetaItemKind::Word => {}
582 MetaItemKind::List(mis) => visit_vec(mis, |mi| vis.visit_meta_list_item(mi)),
583 MetaItemKind::NameValue(_s) => {}
585 vis.visit_span(span);
588 pub fn noop_flat_map_param<T: MutVisitor>(mut param: Param, vis: &mut T) -> SmallVec<[Param; 1]> {
589 let Param { attrs, id, pat, span, ty, is_placeholder: _ } = &mut param;
591 visit_thin_attrs(attrs, vis);
593 vis.visit_span(span);
598 pub fn noop_visit_tt<T: MutVisitor>(tt: &mut TokenTree, vis: &mut T) {
600 TokenTree::Token(token) => {
601 vis.visit_token(token);
603 TokenTree::Delimited(DelimSpan { open, close }, _delim, tts) => {
604 vis.visit_span(open);
605 vis.visit_span(close);
611 pub fn noop_visit_tts<T: MutVisitor>(TokenStream(tts): &mut TokenStream, vis: &mut T) {
612 visit_opt(tts, |tts| {
613 let tts = Lrc::make_mut(tts);
614 visit_vec(tts, |(tree, _is_joint)| vis.visit_tt(tree));
618 // Applies ident visitor if it's an ident; applies other visits to interpolated nodes.
619 // In practice the ident part is not actually used by specific visitors right now,
620 // but there's a test below checking that it works.
621 pub fn noop_visit_token<T: MutVisitor>(t: &mut Token, vis: &mut T) {
622 let Token { kind, span } = t;
624 token::Ident(name, _) | token::Lifetime(name) => {
625 let mut ident = Ident::new(*name, *span);
626 vis.visit_ident(&mut ident);
629 return; // Avoid visiting the span for the second time.
631 token::Interpolated(nt) => {
632 let mut nt = Lrc::make_mut(nt);
633 vis.visit_interpolated(&mut nt);
637 vis.visit_span(span);
640 /// Applies the visitor to elements of interpolated nodes.
642 // N.B., this can occur only when applying a visitor to partially expanded
643 // code, where parsed pieces have gotten implanted ito *other* macro
644 // invocations. This is relevant for macro hygiene, but possibly not elsewhere.
646 // One problem here occurs because the types for flat_map_item, flat_map_stmt,
647 // etc., allow the visitor to return *multiple* items; this is a problem for the
648 // nodes here, because they insist on having exactly one piece. One solution
649 // would be to mangle the MutVisitor trait to include one-to-many and
650 // one-to-one versions of these entry points, but that would probably confuse a
651 // lot of people and help very few. Instead, I'm just going to put in dynamic
652 // checks. I think the performance impact of this will be pretty much
653 // nonexistent. The danger is that someone will apply a `MutVisitor` to a
654 // partially expanded node, and will be confused by the fact that their
655 // `flat_map_item` or `flat_map_stmt` isn't getting called on `NtItem` or `NtStmt`
656 // nodes. Hopefully they'll wind up reading this comment, and doing something
659 // BTW, design choice: I considered just changing the type of, e.g., `NtItem` to
660 // contain multiple items, but decided against it when I looked at
661 // `parse_item_or_view_item` and tried to figure out what I would do with
662 // multiple items there....
663 pub fn noop_visit_interpolated<T: MutVisitor>(nt: &mut token::Nonterminal, vis: &mut T) {
665 token::NtItem(item) =>
666 visit_clobber(item, |item| {
667 // This is probably okay, because the only visitors likely to
668 // peek inside interpolated nodes will be renamings/markings,
669 // which map single items to single items.
670 vis.flat_map_item(item).expect_one("expected visitor to produce exactly one item")
672 token::NtBlock(block) => vis.visit_block(block),
673 token::NtStmt(stmt) =>
674 visit_clobber(stmt, |stmt| {
675 // See reasoning above.
676 vis.flat_map_stmt(stmt).expect_one("expected visitor to produce exactly one item")
678 token::NtPat(pat) => vis.visit_pat(pat),
679 token::NtExpr(expr) => vis.visit_expr(expr),
680 token::NtTy(ty) => vis.visit_ty(ty),
681 token::NtIdent(ident, _is_raw) => vis.visit_ident(ident),
682 token::NtLifetime(ident) => vis.visit_ident(ident),
683 token::NtLiteral(expr) => vis.visit_expr(expr),
684 token::NtMeta(meta) => vis.visit_meta_item(meta),
685 token::NtPath(path) => vis.visit_path(path),
686 token::NtTT(tt) => vis.visit_tt(tt),
687 token::NtImplItem(item) =>
688 visit_clobber(item, |item| {
689 // See reasoning above.
690 vis.flat_map_impl_item(item)
691 .expect_one("expected visitor to produce exactly one item")
693 token::NtTraitItem(item) =>
694 visit_clobber(item, |item| {
695 // See reasoning above.
696 vis.flat_map_trait_item(item)
697 .expect_one("expected visitor to produce exactly one item")
699 token::NtVis(visib) => vis.visit_vis(visib),
700 token::NtForeignItem(item) =>
701 visit_clobber(item, |item| {
702 // See reasoning above.
703 vis.flat_map_foreign_item(item)
704 .expect_one("expected visitor to produce exactly one item")
709 pub fn noop_visit_asyncness<T: MutVisitor>(asyncness: &mut IsAsync, vis: &mut T) {
711 IsAsync::Async { closure_id, return_impl_trait_id } => {
712 vis.visit_id(closure_id);
713 vis.visit_id(return_impl_trait_id);
715 IsAsync::NotAsync => {}
719 pub fn noop_visit_fn_decl<T: MutVisitor>(decl: &mut P<FnDecl>, vis: &mut T) {
720 let FnDecl { inputs, output, c_variadic: _ } = decl.deref_mut();
721 inputs.flat_map_in_place(|param| vis.flat_map_param(param));
723 FunctionRetTy::Default(span) => vis.visit_span(span),
724 FunctionRetTy::Ty(ty) => vis.visit_ty(ty),
728 pub fn noop_visit_param_bound<T: MutVisitor>(pb: &mut GenericBound, vis: &mut T) {
730 GenericBound::Trait(ty, _modifier) => vis.visit_poly_trait_ref(ty),
731 GenericBound::Outlives(lifetime) => noop_visit_lifetime(lifetime, vis),
735 pub fn noop_flat_map_generic_param<T: MutVisitor>(
736 mut param: GenericParam,
738 ) -> SmallVec<[GenericParam; 1]>
740 let GenericParam { id, ident, attrs, bounds, kind, is_placeholder: _ } = &mut param;
742 vis.visit_ident(ident);
743 visit_thin_attrs(attrs, vis);
744 visit_vec(bounds, |bound| noop_visit_param_bound(bound, vis));
746 GenericParamKind::Lifetime => {}
747 GenericParamKind::Type { default } => {
748 visit_opt(default, |default| vis.visit_ty(default));
750 GenericParamKind::Const { ty } => {
757 pub fn noop_visit_label<T: MutVisitor>(Label { ident }: &mut Label, vis: &mut T) {
758 vis.visit_ident(ident);
761 fn noop_visit_lifetime<T: MutVisitor>(Lifetime { id, ident }: &mut Lifetime, vis: &mut T) {
763 vis.visit_ident(ident);
766 pub fn noop_visit_generics<T: MutVisitor>(generics: &mut Generics, vis: &mut T) {
767 let Generics { params, where_clause, span } = generics;
768 params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
769 vis.visit_where_clause(where_clause);
770 vis.visit_span(span);
773 pub fn noop_visit_where_clause<T: MutVisitor>(wc: &mut WhereClause, vis: &mut T) {
774 let WhereClause { predicates, span } = wc;
775 visit_vec(predicates, |predicate| vis.visit_where_predicate(predicate));
776 vis.visit_span(span);
779 pub fn noop_visit_where_predicate<T: MutVisitor>(pred: &mut WherePredicate, vis: &mut T) {
781 WherePredicate::BoundPredicate(bp) => {
782 let WhereBoundPredicate { span, bound_generic_params, bounded_ty, bounds } = bp;
783 vis.visit_span(span);
784 bound_generic_params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
785 vis.visit_ty(bounded_ty);
786 visit_vec(bounds, |bound| vis.visit_param_bound(bound));
788 WherePredicate::RegionPredicate(rp) => {
789 let WhereRegionPredicate { span, lifetime, bounds } = rp;
790 vis.visit_span(span);
791 noop_visit_lifetime(lifetime, vis);
792 visit_vec(bounds, |bound| noop_visit_param_bound(bound, vis));
794 WherePredicate::EqPredicate(ep) => {
795 let WhereEqPredicate { id, span, lhs_ty, rhs_ty } = ep;
797 vis.visit_span(span);
798 vis.visit_ty(lhs_ty);
799 vis.visit_ty(rhs_ty);
804 pub fn noop_visit_variant_data<T: MutVisitor>(vdata: &mut VariantData, vis: &mut T) {
806 VariantData::Struct(fields, ..) => {
807 fields.flat_map_in_place(|field| vis.flat_map_struct_field(field));
809 VariantData::Tuple(fields, id) => {
810 fields.flat_map_in_place(|field| vis.flat_map_struct_field(field));
813 VariantData::Unit(id) => vis.visit_id(id),
817 pub fn noop_visit_trait_ref<T: MutVisitor>(TraitRef { path, ref_id }: &mut TraitRef, vis: &mut T) {
818 vis.visit_path(path);
819 vis.visit_id(ref_id);
822 pub fn noop_visit_poly_trait_ref<T: MutVisitor>(p: &mut PolyTraitRef, vis: &mut T) {
823 let PolyTraitRef { bound_generic_params, trait_ref, span } = p;
824 bound_generic_params.flat_map_in_place(|param| vis.flat_map_generic_param(param));
825 vis.visit_trait_ref(trait_ref);
826 vis.visit_span(span);
829 pub fn noop_flat_map_struct_field<T: MutVisitor>(mut sf: StructField, visitor: &mut T)
830 -> SmallVec<[StructField; 1]>
832 let StructField { span, ident, vis, id, ty, attrs, is_placeholder: _ } = &mut sf;
833 visitor.visit_span(span);
834 visit_opt(ident, |ident| visitor.visit_ident(ident));
835 visitor.visit_vis(vis);
836 visitor.visit_id(id);
837 visitor.visit_ty(ty);
838 visit_attrs(attrs, visitor);
842 pub fn noop_flat_map_field<T: MutVisitor>(mut f: Field, vis: &mut T) -> SmallVec<[Field; 1]> {
843 let Field { ident, expr, span, is_shorthand: _, attrs, id, is_placeholder: _ } = &mut f;
844 vis.visit_ident(ident);
845 vis.visit_expr(expr);
847 vis.visit_span(span);
848 visit_thin_attrs(attrs, vis);
852 pub fn noop_visit_mt<T: MutVisitor>(MutTy { ty, mutbl: _ }: &mut MutTy, vis: &mut T) {
856 pub fn noop_visit_block<T: MutVisitor>(block: &mut P<Block>, vis: &mut T) {
857 let Block { id, stmts, rules: _, span } = block.deref_mut();
859 stmts.flat_map_in_place(|stmt| vis.flat_map_stmt(stmt));
860 vis.visit_span(span);
863 pub fn noop_visit_item_kind<T: MutVisitor>(kind: &mut ItemKind, vis: &mut T) {
865 ItemKind::ExternCrate(_orig_name) => {}
866 ItemKind::Use(use_tree) => vis.visit_use_tree(use_tree),
867 ItemKind::Static(ty, _mut, expr) => {
869 vis.visit_expr(expr);
871 ItemKind::Const(ty, expr) => {
873 vis.visit_expr(expr);
875 ItemKind::Fn(decl, header, generics, body) => {
876 vis.visit_fn_decl(decl);
877 vis.visit_fn_header(header);
878 vis.visit_generics(generics);
879 vis.visit_block(body);
881 ItemKind::Mod(m) => vis.visit_mod(m),
882 ItemKind::ForeignMod(nm) => vis.visit_foreign_mod(nm),
883 ItemKind::GlobalAsm(_ga) => {}
884 ItemKind::TyAlias(ty, generics) => {
886 vis.visit_generics(generics);
888 ItemKind::OpaqueTy(bounds, generics) => {
889 visit_bounds(bounds, vis);
890 vis.visit_generics(generics);
892 ItemKind::Enum(EnumDef { variants }, generics) => {
893 variants.flat_map_in_place(|variant| vis.flat_map_variant(variant));
894 vis.visit_generics(generics);
896 ItemKind::Struct(variant_data, generics) |
897 ItemKind::Union(variant_data, generics) => {
898 vis.visit_variant_data(variant_data);
899 vis.visit_generics(generics);
901 ItemKind::Impl(_unsafety, _polarity, _defaultness, generics, trait_ref, ty, items) => {
902 vis.visit_generics(generics);
903 visit_opt(trait_ref, |trait_ref| vis.visit_trait_ref(trait_ref));
905 items.flat_map_in_place(|item| vis.flat_map_impl_item(item));
907 ItemKind::Trait(_is_auto, _unsafety, generics, bounds, items) => {
908 vis.visit_generics(generics);
909 visit_bounds(bounds, vis);
910 items.flat_map_in_place(|item| vis.flat_map_trait_item(item));
912 ItemKind::TraitAlias(generics, bounds) => {
913 vis.visit_generics(generics);
914 visit_bounds(bounds, vis);
916 ItemKind::Mac(m) => vis.visit_mac(m),
917 ItemKind::MacroDef(def) => vis.visit_macro_def(def),
921 pub fn noop_flat_map_trait_item<T: MutVisitor>(mut item: TraitItem, vis: &mut T)
922 -> SmallVec<[TraitItem; 1]>
924 let TraitItem { id, ident, attrs, generics, node, span, tokens: _ } = &mut item;
926 vis.visit_ident(ident);
927 visit_attrs(attrs, vis);
928 vis.visit_generics(generics);
930 TraitItemKind::Const(ty, default) => {
932 visit_opt(default, |default| vis.visit_expr(default));
934 TraitItemKind::Method(sig, body) => {
935 visit_method_sig(sig, vis);
936 visit_opt(body, |body| vis.visit_block(body));
938 TraitItemKind::Type(bounds, default) => {
939 visit_bounds(bounds, vis);
940 visit_opt(default, |default| vis.visit_ty(default));
942 TraitItemKind::Macro(mac) => {
946 vis.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, node, 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_method_sig(sig, visitor);
968 visitor.visit_block(body);
970 ImplItemKind::TyAlias(ty) => visitor.visit_ty(ty),
971 ImplItemKind::OpaqueTy(bounds) => visit_bounds(bounds, visitor),
972 ImplItemKind::Macro(mac) => visitor.visit_mac(mac),
974 visitor.visit_span(span);
979 pub fn noop_visit_fn_header<T: MutVisitor>(header: &mut FnHeader, vis: &mut T) {
980 let FnHeader { unsafety: _, asyncness, constness: _, abi: _ } = header;
981 vis.visit_asyncness(&mut asyncness.node);
984 pub fn noop_visit_mod<T: MutVisitor>(Mod { inner, items, inline: _ }: &mut Mod, vis: &mut T) {
985 vis.visit_span(inner);
986 items.flat_map_in_place(|item| vis.flat_map_item(item));
989 pub fn noop_visit_crate<T: MutVisitor>(krate: &mut Crate, vis: &mut T) {
990 visit_clobber(krate, |Crate { module, attrs, span }| {
992 ident: Ident::invalid(),
995 vis: respan(span.shrink_to_lo(), VisibilityKind::Public),
997 node: ItemKind::Mod(module),
1000 let items = vis.flat_map_item(item);
1002 let len = items.len();
1004 let module = Mod { inner: span, items: vec![], inline: true };
1005 Crate { module, attrs: vec![], span }
1006 } else if len == 1 {
1007 let Item { attrs, span, node, .. } = items.into_iter().next().unwrap().into_inner();
1009 ItemKind::Mod(module) => Crate { module, attrs, span },
1010 _ => panic!("visitor converted a module to not a module"),
1013 panic!("a crate cannot expand to more than one item");
1018 // Mutates one item into possibly many items.
1019 pub fn noop_flat_map_item<T: MutVisitor>(mut item: P<Item>, visitor: &mut T)
1020 -> SmallVec<[P<Item>; 1]> {
1021 let Item { ident, attrs, id, node, vis, span, tokens: _ } = item.deref_mut();
1022 visitor.visit_ident(ident);
1023 visit_attrs(attrs, visitor);
1024 visitor.visit_id(id);
1025 visitor.visit_item_kind(node);
1026 visitor.visit_vis(vis);
1027 visitor.visit_span(span);
1029 // FIXME: if `tokens` is modified with a call to `vis.visit_tts` it causes
1030 // an ICE during resolve... odd!
1035 pub fn noop_flat_map_foreign_item<T: MutVisitor>(mut item: ForeignItem, visitor: &mut T)
1036 -> SmallVec<[ForeignItem; 1]>
1038 let ForeignItem { ident, attrs, node, id, span, vis } = &mut item;
1039 visitor.visit_ident(ident);
1040 visit_attrs(attrs, visitor);
1042 ForeignItemKind::Fn(fdec, generics) => {
1043 visitor.visit_fn_decl(fdec);
1044 visitor.visit_generics(generics);
1046 ForeignItemKind::Static(t, _m) => visitor.visit_ty(t),
1047 ForeignItemKind::Ty => {}
1048 ForeignItemKind::Macro(mac) => visitor.visit_mac(mac),
1050 visitor.visit_id(id);
1051 visitor.visit_span(span);
1052 visitor.visit_vis(vis);
1057 pub fn noop_visit_pat<T: MutVisitor>(pat: &mut P<Pat>, vis: &mut T) {
1058 let Pat { id, kind, span } = pat.deref_mut();
1061 PatKind::Wild | PatKind::Rest => {}
1062 PatKind::Ident(_binding_mode, ident, sub) => {
1063 vis.visit_ident(ident);
1064 visit_opt(sub, |sub| vis.visit_pat(sub));
1066 PatKind::Lit(e) => vis.visit_expr(e),
1067 PatKind::TupleStruct(path, elems) => {
1068 vis.visit_path(path);
1069 visit_vec(elems, |elem| vis.visit_pat(elem));
1071 PatKind::Path(qself, path) => {
1072 vis.visit_qself(qself);
1073 vis.visit_path(path);
1075 PatKind::Struct(path, fields, _etc) => {
1076 vis.visit_path(path);
1077 fields.flat_map_in_place(|field| vis.flat_map_field_pattern(field));
1079 PatKind::Box(inner) => vis.visit_pat(inner),
1080 PatKind::Ref(inner, _mutbl) => vis.visit_pat(inner),
1081 PatKind::Range(e1, e2, Spanned { span: _, node: _ }) => {
1084 vis.visit_span(span);
1086 PatKind::Tuple(elems)
1087 | PatKind::Slice(elems)
1088 | PatKind::Or(elems) => visit_vec(elems, |elem| vis.visit_pat(elem)),
1089 PatKind::Paren(inner) => vis.visit_pat(inner),
1090 PatKind::Mac(mac) => vis.visit_mac(mac),
1092 vis.visit_span(span);
1095 pub fn noop_visit_anon_const<T: MutVisitor>(AnonConst { id, value }: &mut AnonConst, vis: &mut T) {
1097 vis.visit_expr(value);
1100 pub fn noop_visit_expr<T: MutVisitor>(Expr { kind, id, span, attrs }: &mut Expr, vis: &mut T) {
1102 ExprKind::Box(expr) => vis.visit_expr(expr),
1103 ExprKind::Array(exprs) => visit_exprs(exprs, vis),
1104 ExprKind::Repeat(expr, count) => {
1105 vis.visit_expr(expr);
1106 vis.visit_anon_const(count);
1108 ExprKind::Tup(exprs) => visit_exprs(exprs, vis),
1109 ExprKind::Call(f, args) => {
1111 visit_exprs(args, vis);
1113 ExprKind::MethodCall(PathSegment { ident, id, args }, exprs) => {
1114 vis.visit_ident(ident);
1116 visit_opt(args, |args| vis.visit_generic_args(args));
1117 visit_exprs(exprs, vis);
1119 ExprKind::Binary(_binop, lhs, rhs) => {
1120 vis.visit_expr(lhs);
1121 vis.visit_expr(rhs);
1123 ExprKind::Unary(_unop, ohs) => vis.visit_expr(ohs),
1124 ExprKind::Cast(expr, ty) => {
1125 vis.visit_expr(expr);
1128 ExprKind::Type(expr, ty) => {
1129 vis.visit_expr(expr);
1132 ExprKind::AddrOf(_m, ohs) => vis.visit_expr(ohs),
1133 ExprKind::Let(pat, scrutinee) => {
1135 vis.visit_expr(scrutinee);
1137 ExprKind::If(cond, tr, fl) => {
1138 vis.visit_expr(cond);
1139 vis.visit_block(tr);
1140 visit_opt(fl, |fl| vis.visit_expr(fl));
1142 ExprKind::While(cond, body, label) => {
1143 vis.visit_expr(cond);
1144 vis.visit_block(body);
1145 visit_opt(label, |label| vis.visit_label(label));
1147 ExprKind::ForLoop(pat, iter, body, label) => {
1149 vis.visit_expr(iter);
1150 vis.visit_block(body);
1151 visit_opt(label, |label| vis.visit_label(label));
1153 ExprKind::Loop(body, label) => {
1154 vis.visit_block(body);
1155 visit_opt(label, |label| vis.visit_label(label));
1157 ExprKind::Match(expr, arms) => {
1158 vis.visit_expr(expr);
1159 arms.flat_map_in_place(|arm| vis.flat_map_arm(arm));
1161 ExprKind::Closure(_capture_by, asyncness, _movability, decl, body, span) => {
1162 vis.visit_asyncness(asyncness);
1163 vis.visit_fn_decl(decl);
1164 vis.visit_expr(body);
1165 vis.visit_span(span);
1167 ExprKind::Block(blk, label) => {
1168 vis.visit_block(blk);
1169 visit_opt(label, |label| vis.visit_label(label));
1171 ExprKind::Async(_capture_by, node_id, body) => {
1172 vis.visit_id(node_id);
1173 vis.visit_block(body);
1175 ExprKind::Await(expr) => vis.visit_expr(expr),
1176 ExprKind::Assign(el, er) => {
1180 ExprKind::AssignOp(_op, el, er) => {
1184 ExprKind::Field(el, ident) => {
1186 vis.visit_ident(ident);
1188 ExprKind::Index(el, er) => {
1192 ExprKind::Range(e1, e2, _lim) => {
1193 visit_opt(e1, |e1| vis.visit_expr(e1));
1194 visit_opt(e2, |e2| vis.visit_expr(e2));
1196 ExprKind::Path(qself, path) => {
1197 vis.visit_qself(qself);
1198 vis.visit_path(path);
1200 ExprKind::Break(label, expr) => {
1201 visit_opt(label, |label| vis.visit_label(label));
1202 visit_opt(expr, |expr| vis.visit_expr(expr));
1204 ExprKind::Continue(label) => {
1205 visit_opt(label, |label| vis.visit_label(label));
1207 ExprKind::Ret(expr) => {
1208 visit_opt(expr, |expr| vis.visit_expr(expr));
1210 ExprKind::InlineAsm(asm) => {
1211 let InlineAsm { asm: _, asm_str_style: _, outputs, inputs, clobbers: _, volatile: _,
1212 alignstack: _, dialect: _ } = asm.deref_mut();
1213 for out in outputs {
1214 let InlineAsmOutput { constraint: _, expr, is_rw: _, is_indirect: _ } = out;
1215 vis.visit_expr(expr);
1217 visit_vec(inputs, |(_c, expr)| vis.visit_expr(expr));
1219 ExprKind::Mac(mac) => vis.visit_mac(mac),
1220 ExprKind::Struct(path, fields, expr) => {
1221 vis.visit_path(path);
1222 fields.flat_map_in_place(|field| vis.flat_map_field(field));
1223 visit_opt(expr, |expr| vis.visit_expr(expr));
1225 ExprKind::Paren(expr) => {
1226 vis.visit_expr(expr);
1228 // Nodes that are equal modulo `Paren` sugar no-ops should have the same IDs.
1230 vis.visit_span(span);
1231 visit_thin_attrs(attrs, vis);
1234 ExprKind::Yield(expr) => {
1235 visit_opt(expr, |expr| vis.visit_expr(expr));
1237 ExprKind::Try(expr) => vis.visit_expr(expr),
1238 ExprKind::TryBlock(body) => vis.visit_block(body),
1239 ExprKind::Lit(_) | ExprKind::Err => {}
1242 vis.visit_span(span);
1243 visit_thin_attrs(attrs, vis);
1246 pub fn noop_filter_map_expr<T: MutVisitor>(mut e: P<Expr>, vis: &mut T) -> Option<P<Expr>> {
1247 Some({ vis.visit_expr(&mut e); e })
1250 pub fn noop_flat_map_stmt<T: MutVisitor>(Stmt { node, mut span, mut id }: Stmt, vis: &mut T)
1251 -> SmallVec<[Stmt; 1]>
1253 vis.visit_id(&mut id);
1254 vis.visit_span(&mut span);
1255 noop_flat_map_stmt_kind(node, vis).into_iter().map(|node| {
1256 Stmt { id, node, span }
1260 pub fn noop_flat_map_stmt_kind<T: MutVisitor>(node: StmtKind, vis: &mut T)
1261 -> SmallVec<[StmtKind; 1]> {
1263 StmtKind::Local(mut local) =>
1264 smallvec![StmtKind::Local({ vis.visit_local(&mut local); local })],
1265 StmtKind::Item(item) => vis.flat_map_item(item).into_iter().map(StmtKind::Item).collect(),
1266 StmtKind::Expr(expr) => {
1267 vis.filter_map_expr(expr).into_iter().map(StmtKind::Expr).collect()
1269 StmtKind::Semi(expr) => {
1270 vis.filter_map_expr(expr).into_iter().map(StmtKind::Semi).collect()
1272 StmtKind::Mac(mut mac) => {
1273 let (mac_, _semi, attrs) = mac.deref_mut();
1274 vis.visit_mac(mac_);
1275 visit_thin_attrs(attrs, vis);
1276 smallvec![StmtKind::Mac(mac)]
1281 pub fn noop_visit_vis<T: MutVisitor>(Spanned { node, span }: &mut Visibility, vis: &mut T) {
1283 VisibilityKind::Public | VisibilityKind::Crate(_) | VisibilityKind::Inherited => {}
1284 VisibilityKind::Restricted { path, id } => {
1285 vis.visit_path(path);
1289 vis.visit_span(span);