// Copyright 2012-2014 The Rust Project Developers. See the COPYRIGHT // file at the top-level directory of this distribution and at // http://rust-lang.org/COPYRIGHT. // // Licensed under the Apache License, Version 2.0 or the MIT license // , at your // option. This file may not be copied, modified, or distributed // except according to those terms. //! A Folder represents an AST->AST fold; it accepts an AST piece, //! and returns a piece of the same type. So, for instance, macro //! expansion is a Folder that walks over an AST and produces another //! AST. //! //! Note: using a Folder (other than the MacroExpander Folder) on //! an AST before macro expansion is probably a bad idea. For instance, //! a folder renaming item names in a module will miss all of those //! that are created by the expansion of a macro. use ast::*; use ast; use syntax_pos::Span; use codemap::{Spanned, respan}; use parse::token; use ptr::P; use symbol::keywords; use tokenstream::*; use util::small_vector::SmallVector; use util::move_map::MoveMap; use std::rc::Rc; pub trait Folder : Sized { // Any additions to this trait should happen in form // of a call to a public `noop_*` function that only calls // out to the folder again, not other `noop_*` functions. // // This is a necessary API workaround to the problem of not // being able to call out to the super default method // in an overridden default method. fn fold_crate(&mut self, c: Crate) -> Crate { noop_fold_crate(c, self) } fn fold_meta_items(&mut self, meta_items: Vec) -> Vec { noop_fold_meta_items(meta_items, self) } fn fold_meta_list_item(&mut self, list_item: NestedMetaItem) -> NestedMetaItem { noop_fold_meta_list_item(list_item, self) } fn fold_meta_item(&mut self, meta_item: MetaItem) -> MetaItem { noop_fold_meta_item(meta_item, self) } fn fold_view_path(&mut self, view_path: P) -> P { noop_fold_view_path(view_path, self) } fn fold_foreign_item(&mut self, ni: ForeignItem) -> ForeignItem { noop_fold_foreign_item(ni, self) } fn fold_item(&mut self, i: P) -> SmallVector> { noop_fold_item(i, self) } fn fold_item_simple(&mut self, i: Item) -> Item { noop_fold_item_simple(i, self) } fn fold_struct_field(&mut self, sf: StructField) -> StructField { noop_fold_struct_field(sf, self) } fn fold_item_kind(&mut self, i: ItemKind) -> ItemKind { noop_fold_item_kind(i, self) } fn fold_trait_item(&mut self, i: TraitItem) -> SmallVector { noop_fold_trait_item(i, self) } fn fold_impl_item(&mut self, i: ImplItem) -> SmallVector { noop_fold_impl_item(i, self) } fn fold_fn_decl(&mut self, d: P) -> P { noop_fold_fn_decl(d, self) } fn fold_block(&mut self, b: P) -> P { noop_fold_block(b, self) } fn fold_stmt(&mut self, s: Stmt) -> SmallVector { noop_fold_stmt(s, self) } fn fold_arm(&mut self, a: Arm) -> Arm { noop_fold_arm(a, self) } fn fold_pat(&mut self, p: P) -> P { noop_fold_pat(p, self) } fn fold_expr(&mut self, e: P) -> P { e.map(|e| noop_fold_expr(e, self)) } fn fold_opt_expr(&mut self, e: P) -> Option> { noop_fold_opt_expr(e, self) } fn fold_exprs(&mut self, es: Vec>) -> Vec> { noop_fold_exprs(es, self) } fn fold_ty(&mut self, t: P) -> P { noop_fold_ty(t, self) } fn fold_ty_binding(&mut self, t: TypeBinding) -> TypeBinding { noop_fold_ty_binding(t, self) } fn fold_mod(&mut self, m: Mod) -> Mod { noop_fold_mod(m, self) } fn fold_foreign_mod(&mut self, nm: ForeignMod) -> ForeignMod { noop_fold_foreign_mod(nm, self) } fn fold_variant(&mut self, v: Variant) -> Variant { noop_fold_variant(v, self) } fn fold_ident(&mut self, i: Ident) -> Ident { noop_fold_ident(i, self) } fn fold_usize(&mut self, i: usize) -> usize { noop_fold_usize(i, self) } fn fold_path(&mut self, p: Path) -> Path { noop_fold_path(p, self) } fn fold_path_parameters(&mut self, p: PathParameters) -> PathParameters { noop_fold_path_parameters(p, self) } fn fold_angle_bracketed_parameter_data(&mut self, p: AngleBracketedParameterData) -> AngleBracketedParameterData { noop_fold_angle_bracketed_parameter_data(p, self) } fn fold_parenthesized_parameter_data(&mut self, p: ParenthesizedParameterData) -> ParenthesizedParameterData { noop_fold_parenthesized_parameter_data(p, self) } fn fold_local(&mut self, l: P) -> P { noop_fold_local(l, self) } fn fold_mac(&mut self, _mac: Mac) -> Mac { panic!("fold_mac disabled by default"); // NB: see note about macros above. // if you really want a folder that // works on macros, use this // definition in your trait impl: // fold::noop_fold_mac(_mac, self) } fn fold_lifetime(&mut self, l: Lifetime) -> Lifetime { noop_fold_lifetime(l, self) } fn fold_lifetime_def(&mut self, l: LifetimeDef) -> LifetimeDef { noop_fold_lifetime_def(l, self) } fn fold_attribute(&mut self, at: Attribute) -> Option { noop_fold_attribute(at, self) } fn fold_arg(&mut self, a: Arg) -> Arg { noop_fold_arg(a, self) } fn fold_generics(&mut self, generics: Generics) -> Generics { noop_fold_generics(generics, self) } fn fold_trait_ref(&mut self, p: TraitRef) -> TraitRef { noop_fold_trait_ref(p, self) } fn fold_poly_trait_ref(&mut self, p: PolyTraitRef) -> PolyTraitRef { noop_fold_poly_trait_ref(p, self) } fn fold_variant_data(&mut self, vdata: VariantData) -> VariantData { noop_fold_variant_data(vdata, self) } fn fold_lifetimes(&mut self, lts: Vec) -> Vec { noop_fold_lifetimes(lts, self) } fn fold_lifetime_defs(&mut self, lts: Vec) -> Vec { noop_fold_lifetime_defs(lts, self) } fn fold_ty_param(&mut self, tp: TyParam) -> TyParam { noop_fold_ty_param(tp, self) } fn fold_ty_params(&mut self, tps: P<[TyParam]>) -> P<[TyParam]> { noop_fold_ty_params(tps, self) } fn fold_tt(&mut self, tt: &TokenTree) -> TokenTree { noop_fold_tt(tt, self) } fn fold_tts(&mut self, tts: &[TokenTree]) -> Vec { noop_fold_tts(tts, self) } fn fold_token(&mut self, t: token::Token) -> token::Token { noop_fold_token(t, self) } fn fold_interpolated(&mut self, nt: token::Nonterminal) -> token::Nonterminal { noop_fold_interpolated(nt, self) } fn fold_opt_lifetime(&mut self, o_lt: Option) -> Option { noop_fold_opt_lifetime(o_lt, self) } fn fold_opt_bounds(&mut self, b: Option) -> Option { noop_fold_opt_bounds(b, self) } fn fold_bounds(&mut self, b: TyParamBounds) -> TyParamBounds { noop_fold_bounds(b, self) } fn fold_ty_param_bound(&mut self, tpb: TyParamBound) -> TyParamBound { noop_fold_ty_param_bound(tpb, self) } fn fold_mt(&mut self, mt: MutTy) -> MutTy { noop_fold_mt(mt, self) } fn fold_field(&mut self, field: Field) -> Field { noop_fold_field(field, self) } fn fold_where_clause(&mut self, where_clause: WhereClause) -> WhereClause { noop_fold_where_clause(where_clause, self) } fn fold_where_predicate(&mut self, where_predicate: WherePredicate) -> WherePredicate { noop_fold_where_predicate(where_predicate, self) } fn fold_vis(&mut self, vis: Visibility) -> Visibility { noop_fold_vis(vis, self) } fn new_id(&mut self, i: NodeId) -> NodeId { i } fn new_span(&mut self, sp: Span) -> Span { sp } } pub fn noop_fold_meta_items(meta_items: Vec, fld: &mut T) -> Vec { meta_items.move_map(|x| fld.fold_meta_item(x)) } pub fn noop_fold_view_path(view_path: P, fld: &mut T) -> P { view_path.map(|Spanned {node, span}| Spanned { node: match node { ViewPathSimple(ident, path) => { ViewPathSimple(ident, fld.fold_path(path)) } ViewPathGlob(path) => { ViewPathGlob(fld.fold_path(path)) } ViewPathList(path, path_list_idents) => { ViewPathList(fld.fold_path(path), path_list_idents.move_map(|path_list_ident| { Spanned { node: PathListItem_ { id: fld.new_id(path_list_ident.node.id), rename: path_list_ident.node.rename, name: path_list_ident.node.name, }, span: fld.new_span(path_list_ident.span) } })) } }, span: fld.new_span(span) }) } pub fn fold_attrs(attrs: Vec, fld: &mut T) -> Vec { attrs.move_flat_map(|x| fld.fold_attribute(x)) } pub fn fold_thin_attrs(attrs: ThinVec, fld: &mut T) -> ThinVec { fold_attrs(attrs.into(), fld).into() } pub fn noop_fold_arm(Arm {attrs, pats, guard, body}: Arm, fld: &mut T) -> Arm { Arm { attrs: fold_attrs(attrs, fld), pats: pats.move_map(|x| fld.fold_pat(x)), guard: guard.map(|x| fld.fold_expr(x)), body: fld.fold_expr(body), } } pub fn noop_fold_ty_binding(b: TypeBinding, fld: &mut T) -> TypeBinding { TypeBinding { id: fld.new_id(b.id), ident: b.ident, ty: fld.fold_ty(b.ty), span: fld.new_span(b.span), } } pub fn noop_fold_ty(t: P, fld: &mut T) -> P { t.map(|Ty {id, node, span}| Ty { id: fld.new_id(id), node: match node { TyKind::Infer | TyKind::ImplicitSelf => node, TyKind::Slice(ty) => TyKind::Slice(fld.fold_ty(ty)), TyKind::Ptr(mt) => TyKind::Ptr(fld.fold_mt(mt)), TyKind::Rptr(region, mt) => { TyKind::Rptr(fld.fold_opt_lifetime(region), fld.fold_mt(mt)) } TyKind::BareFn(f) => { TyKind::BareFn(f.map(|BareFnTy {lifetimes, unsafety, abi, decl}| BareFnTy { lifetimes: fld.fold_lifetime_defs(lifetimes), unsafety: unsafety, abi: abi, decl: fld.fold_fn_decl(decl) })) } TyKind::Never => node, TyKind::Tup(tys) => TyKind::Tup(tys.move_map(|ty| fld.fold_ty(ty))), TyKind::Paren(ty) => TyKind::Paren(fld.fold_ty(ty)), TyKind::Path(qself, path) => { let qself = qself.map(|QSelf { ty, position }| { QSelf { ty: fld.fold_ty(ty), position: position } }); TyKind::Path(qself, fld.fold_path(path)) } TyKind::ObjectSum(ty, bounds) => { TyKind::ObjectSum(fld.fold_ty(ty), fld.fold_bounds(bounds)) } TyKind::Array(ty, e) => { TyKind::Array(fld.fold_ty(ty), fld.fold_expr(e)) } TyKind::Typeof(expr) => { TyKind::Typeof(fld.fold_expr(expr)) } TyKind::PolyTraitRef(bounds) => { TyKind::PolyTraitRef(bounds.move_map(|b| fld.fold_ty_param_bound(b))) } TyKind::ImplTrait(bounds) => { TyKind::ImplTrait(bounds.move_map(|b| fld.fold_ty_param_bound(b))) } TyKind::Mac(mac) => { TyKind::Mac(fld.fold_mac(mac)) } }, span: fld.new_span(span) }) } pub fn noop_fold_foreign_mod(ForeignMod {abi, items}: ForeignMod, fld: &mut T) -> ForeignMod { ForeignMod { abi: abi, items: items.move_map(|x| fld.fold_foreign_item(x)), } } pub fn noop_fold_variant(v: Variant, fld: &mut T) -> Variant { Spanned { node: Variant_ { name: v.node.name, attrs: fold_attrs(v.node.attrs, fld), data: fld.fold_variant_data(v.node.data), disr_expr: v.node.disr_expr.map(|e| fld.fold_expr(e)), }, span: fld.new_span(v.span), } } pub fn noop_fold_ident(i: Ident, _: &mut T) -> Ident { i } pub fn noop_fold_usize(i: usize, _: &mut T) -> usize { i } pub fn noop_fold_path(Path {global, segments, span}: Path, fld: &mut T) -> Path { Path { global: global, segments: segments.move_map(|PathSegment {identifier, parameters}| PathSegment { identifier: fld.fold_ident(identifier), parameters: fld.fold_path_parameters(parameters), }), span: fld.new_span(span) } } pub fn noop_fold_path_parameters(path_parameters: PathParameters, fld: &mut T) -> PathParameters { match path_parameters { PathParameters::AngleBracketed(data) => PathParameters::AngleBracketed(fld.fold_angle_bracketed_parameter_data(data)), PathParameters::Parenthesized(data) => PathParameters::Parenthesized(fld.fold_parenthesized_parameter_data(data)), } } pub fn noop_fold_angle_bracketed_parameter_data(data: AngleBracketedParameterData, fld: &mut T) -> AngleBracketedParameterData { let AngleBracketedParameterData { lifetimes, types, bindings } = data; AngleBracketedParameterData { lifetimes: fld.fold_lifetimes(lifetimes), types: types.move_map(|ty| fld.fold_ty(ty)), bindings: bindings.move_map(|b| fld.fold_ty_binding(b)) } } pub fn noop_fold_parenthesized_parameter_data(data: ParenthesizedParameterData, fld: &mut T) -> ParenthesizedParameterData { let ParenthesizedParameterData { inputs, output, span } = data; ParenthesizedParameterData { inputs: inputs.move_map(|ty| fld.fold_ty(ty)), output: output.map(|ty| fld.fold_ty(ty)), span: fld.new_span(span) } } pub fn noop_fold_local(l: P, fld: &mut T) -> P { l.map(|Local {id, pat, ty, init, span, attrs}| Local { id: fld.new_id(id), pat: fld.fold_pat(pat), ty: ty.map(|t| fld.fold_ty(t)), init: init.map(|e| fld.fold_expr(e)), span: fld.new_span(span), attrs: fold_attrs(attrs.into(), fld).into(), }) } pub fn noop_fold_attribute(attr: Attribute, fld: &mut T) -> Option { Some(Attribute { id: attr.id, style: attr.style, value: fld.fold_meta_item(attr.value), is_sugared_doc: attr.is_sugared_doc, span: fld.new_span(attr.span), }) } pub fn noop_fold_mac(Spanned {node, span}: Mac, fld: &mut T) -> Mac { Spanned { node: Mac_ { path: fld.fold_path(node.path), tts: fld.fold_tts(&node.tts), }, span: fld.new_span(span) } } pub fn noop_fold_meta_list_item(li: NestedMetaItem, fld: &mut T) -> NestedMetaItem { Spanned { node: match li.node { NestedMetaItemKind::MetaItem(mi) => { NestedMetaItemKind::MetaItem(fld.fold_meta_item(mi)) }, NestedMetaItemKind::Literal(lit) => NestedMetaItemKind::Literal(lit) }, span: fld.new_span(li.span) } } pub fn noop_fold_meta_item(mi: MetaItem, fld: &mut T) -> MetaItem { MetaItem { name: mi.name, node: match mi.node { MetaItemKind::Word => MetaItemKind::Word, MetaItemKind::List(mis) => { MetaItemKind::List(mis.move_map(|e| fld.fold_meta_list_item(e))) }, MetaItemKind::NameValue(s) => MetaItemKind::NameValue(s), }, span: fld.new_span(mi.span) } } pub fn noop_fold_arg(Arg {id, pat, ty}: Arg, fld: &mut T) -> Arg { Arg { id: fld.new_id(id), pat: fld.fold_pat(pat), ty: fld.fold_ty(ty) } } pub fn noop_fold_tt(tt: &TokenTree, fld: &mut T) -> TokenTree { match *tt { TokenTree::Token(span, ref tok) => TokenTree::Token(span, fld.fold_token(tok.clone())), TokenTree::Delimited(span, ref delimed) => { TokenTree::Delimited(span, Rc::new( Delimited { delim: delimed.delim, open_span: delimed.open_span, tts: fld.fold_tts(&delimed.tts), close_span: delimed.close_span, } )) }, TokenTree::Sequence(span, ref seq) => TokenTree::Sequence(span, Rc::new(SequenceRepetition { tts: fld.fold_tts(&seq.tts), separator: seq.separator.clone().map(|tok| fld.fold_token(tok)), ..**seq })), } } pub fn noop_fold_tts(tts: &[TokenTree], fld: &mut T) -> Vec { tts.iter().map(|tt| fld.fold_tt(tt)).collect() } // apply ident folder if it's an ident, apply other folds to interpolated nodes pub fn noop_fold_token(t: token::Token, fld: &mut T) -> token::Token { match t { token::Ident(id) => token::Ident(fld.fold_ident(id)), token::Lifetime(id) => token::Lifetime(fld.fold_ident(id)), token::Interpolated(nt) => { let nt = match Rc::try_unwrap(nt) { Ok(nt) => nt, Err(nt) => (*nt).clone(), }; token::Interpolated(Rc::new(fld.fold_interpolated(nt))) } token::SubstNt(ident) => token::SubstNt(fld.fold_ident(ident)), token::MatchNt(name, kind) => token::MatchNt(fld.fold_ident(name), fld.fold_ident(kind)), _ => t } } /// apply folder to elements of interpolated nodes // // NB: this can occur only when applying a fold to partially expanded code, where // parsed pieces have gotten implanted ito *other* macro invocations. This is relevant // for macro hygiene, but possibly not elsewhere. // // One problem here occurs because the types for fold_item, fold_stmt, etc. allow the // folder to return *multiple* items; this is a problem for the nodes here, because // they insist on having exactly one piece. One solution would be to mangle the fold // trait to include one-to-many and one-to-one versions of these entry points, but that // would probably confuse a lot of people and help very few. Instead, I'm just going // to put in dynamic checks. I think the performance impact of this will be pretty much // nonexistent. The danger is that someone will apply a fold to a partially expanded // node, and will be confused by the fact that their "fold_item" or "fold_stmt" isn't // getting called on NtItem or NtStmt nodes. Hopefully they'll wind up reading this // comment, and doing something appropriate. // // BTW, design choice: I considered just changing the type of, e.g., NtItem to contain // multiple items, but decided against it when I looked at parse_item_or_view_item and // tried to figure out what I would do with multiple items there.... pub fn noop_fold_interpolated(nt: token::Nonterminal, fld: &mut T) -> token::Nonterminal { match nt { token::NtItem(item) => token::NtItem(fld.fold_item(item) // this is probably okay, because the only folds likely // to peek inside interpolated nodes will be renamings/markings, // which map single items to single items .expect_one("expected fold to produce exactly one item")), token::NtBlock(block) => token::NtBlock(fld.fold_block(block)), token::NtStmt(stmt) => token::NtStmt(fld.fold_stmt(stmt) // this is probably okay, because the only folds likely // to peek inside interpolated nodes will be renamings/markings, // which map single items to single items .expect_one("expected fold to produce exactly one statement")), token::NtPat(pat) => token::NtPat(fld.fold_pat(pat)), token::NtExpr(expr) => token::NtExpr(fld.fold_expr(expr)), token::NtTy(ty) => token::NtTy(fld.fold_ty(ty)), token::NtIdent(id) => token::NtIdent(Spanned::{node: fld.fold_ident(id.node), ..id}), token::NtMeta(meta_item) => token::NtMeta(fld.fold_meta_item(meta_item)), token::NtPath(path) => token::NtPath(fld.fold_path(path)), token::NtTT(tt) => token::NtTT(fld.fold_tt(&tt)), token::NtArm(arm) => token::NtArm(fld.fold_arm(arm)), token::NtImplItem(item) => token::NtImplItem(fld.fold_impl_item(item) .expect_one("expected fold to produce exactly one item")), token::NtTraitItem(item) => token::NtTraitItem(fld.fold_trait_item(item) .expect_one("expected fold to produce exactly one item")), token::NtGenerics(generics) => token::NtGenerics(fld.fold_generics(generics)), token::NtWhereClause(where_clause) => token::NtWhereClause(fld.fold_where_clause(where_clause)), token::NtArg(arg) => token::NtArg(fld.fold_arg(arg)), } } pub fn noop_fold_fn_decl(decl: P, fld: &mut T) -> P { decl.map(|FnDecl {inputs, output, variadic}| FnDecl { inputs: inputs.move_map(|x| fld.fold_arg(x)), output: match output { FunctionRetTy::Ty(ty) => FunctionRetTy::Ty(fld.fold_ty(ty)), FunctionRetTy::Default(span) => FunctionRetTy::Default(span), }, variadic: variadic }) } pub fn noop_fold_ty_param_bound(tpb: TyParamBound, fld: &mut T) -> TyParamBound where T: Folder { match tpb { TraitTyParamBound(ty, modifier) => TraitTyParamBound(fld.fold_poly_trait_ref(ty), modifier), RegionTyParamBound(lifetime) => RegionTyParamBound(fld.fold_lifetime(lifetime)), } } pub fn noop_fold_ty_param(tp: TyParam, fld: &mut T) -> TyParam { let TyParam {attrs, id, ident, bounds, default, span} = tp; let attrs: Vec<_> = attrs.into(); TyParam { attrs: attrs.into_iter() .flat_map(|x| fld.fold_attribute(x).into_iter()) .collect::>() .into(), id: fld.new_id(id), ident: ident, bounds: fld.fold_bounds(bounds), default: default.map(|x| fld.fold_ty(x)), span: span } } pub fn noop_fold_ty_params(tps: P<[TyParam]>, fld: &mut T) -> P<[TyParam]> { tps.move_map(|tp| fld.fold_ty_param(tp)) } pub fn noop_fold_lifetime(l: Lifetime, fld: &mut T) -> Lifetime { Lifetime { id: fld.new_id(l.id), name: l.name, span: fld.new_span(l.span) } } pub fn noop_fold_lifetime_def(l: LifetimeDef, fld: &mut T) -> LifetimeDef { let attrs: Vec<_> = l.attrs.into(); LifetimeDef { attrs: attrs.into_iter() .flat_map(|x| fld.fold_attribute(x).into_iter()) .collect::>() .into(), lifetime: fld.fold_lifetime(l.lifetime), bounds: fld.fold_lifetimes(l.bounds), } } pub fn noop_fold_lifetimes(lts: Vec, fld: &mut T) -> Vec { lts.move_map(|l| fld.fold_lifetime(l)) } pub fn noop_fold_lifetime_defs(lts: Vec, fld: &mut T) -> Vec { lts.move_map(|l| fld.fold_lifetime_def(l)) } pub fn noop_fold_opt_lifetime(o_lt: Option, fld: &mut T) -> Option { o_lt.map(|lt| fld.fold_lifetime(lt)) } pub fn noop_fold_generics(Generics {ty_params, lifetimes, where_clause, span}: Generics, fld: &mut T) -> Generics { Generics { ty_params: fld.fold_ty_params(ty_params), lifetimes: fld.fold_lifetime_defs(lifetimes), where_clause: fld.fold_where_clause(where_clause), span: fld.new_span(span), } } pub fn noop_fold_where_clause( WhereClause {id, predicates}: WhereClause, fld: &mut T) -> WhereClause { WhereClause { id: fld.new_id(id), predicates: predicates.move_map(|predicate| { fld.fold_where_predicate(predicate) }) } } pub fn noop_fold_where_predicate( pred: WherePredicate, fld: &mut T) -> WherePredicate { match pred { ast::WherePredicate::BoundPredicate(ast::WhereBoundPredicate{bound_lifetimes, bounded_ty, bounds, span}) => { ast::WherePredicate::BoundPredicate(ast::WhereBoundPredicate { bound_lifetimes: fld.fold_lifetime_defs(bound_lifetimes), bounded_ty: fld.fold_ty(bounded_ty), bounds: bounds.move_map(|x| fld.fold_ty_param_bound(x)), span: fld.new_span(span) }) } ast::WherePredicate::RegionPredicate(ast::WhereRegionPredicate{lifetime, bounds, span}) => { ast::WherePredicate::RegionPredicate(ast::WhereRegionPredicate { span: fld.new_span(span), lifetime: fld.fold_lifetime(lifetime), bounds: bounds.move_map(|bound| fld.fold_lifetime(bound)) }) } ast::WherePredicate::EqPredicate(ast::WhereEqPredicate{id, path, ty, span}) => { ast::WherePredicate::EqPredicate(ast::WhereEqPredicate{ id: fld.new_id(id), path: fld.fold_path(path), ty:fld.fold_ty(ty), span: fld.new_span(span) }) } } } pub fn noop_fold_variant_data(vdata: VariantData, fld: &mut T) -> VariantData { match vdata { ast::VariantData::Struct(fields, id) => { ast::VariantData::Struct(fields.move_map(|f| fld.fold_struct_field(f)), fld.new_id(id)) } ast::VariantData::Tuple(fields, id) => { ast::VariantData::Tuple(fields.move_map(|f| fld.fold_struct_field(f)), fld.new_id(id)) } ast::VariantData::Unit(id) => ast::VariantData::Unit(fld.new_id(id)) } } pub fn noop_fold_trait_ref(p: TraitRef, fld: &mut T) -> TraitRef { let id = fld.new_id(p.ref_id); let TraitRef { path, ref_id: _, } = p; ast::TraitRef { path: fld.fold_path(path), ref_id: id, } } pub fn noop_fold_poly_trait_ref(p: PolyTraitRef, fld: &mut T) -> PolyTraitRef { ast::PolyTraitRef { bound_lifetimes: fld.fold_lifetime_defs(p.bound_lifetimes), trait_ref: fld.fold_trait_ref(p.trait_ref), span: fld.new_span(p.span), } } pub fn noop_fold_struct_field(f: StructField, fld: &mut T) -> StructField { StructField { span: fld.new_span(f.span), id: fld.new_id(f.id), ident: f.ident.map(|ident| fld.fold_ident(ident)), vis: fld.fold_vis(f.vis), ty: fld.fold_ty(f.ty), attrs: fold_attrs(f.attrs, fld), } } pub fn noop_fold_field(f: Field, folder: &mut T) -> Field { Field { ident: respan(f.ident.span, folder.fold_ident(f.ident.node)), expr: folder.fold_expr(f.expr), span: folder.new_span(f.span), is_shorthand: f.is_shorthand, } } pub fn noop_fold_mt(MutTy {ty, mutbl}: MutTy, folder: &mut T) -> MutTy { MutTy { ty: folder.fold_ty(ty), mutbl: mutbl, } } pub fn noop_fold_opt_bounds(b: Option, folder: &mut T) -> Option { b.map(|bounds| folder.fold_bounds(bounds)) } fn noop_fold_bounds(bounds: TyParamBounds, folder: &mut T) -> TyParamBounds { bounds.move_map(|bound| folder.fold_ty_param_bound(bound)) } pub fn noop_fold_block(b: P, folder: &mut T) -> P { b.map(|Block {id, stmts, rules, span}| Block { id: folder.new_id(id), stmts: stmts.move_flat_map(|s| folder.fold_stmt(s).into_iter()), rules: rules, span: folder.new_span(span), }) } pub fn noop_fold_item_kind(i: ItemKind, folder: &mut T) -> ItemKind { match i { ItemKind::ExternCrate(string) => ItemKind::ExternCrate(string), ItemKind::Use(view_path) => { ItemKind::Use(folder.fold_view_path(view_path)) } ItemKind::Static(t, m, e) => { ItemKind::Static(folder.fold_ty(t), m, folder.fold_expr(e)) } ItemKind::Const(t, e) => { ItemKind::Const(folder.fold_ty(t), folder.fold_expr(e)) } ItemKind::Fn(decl, unsafety, constness, abi, generics, body) => { let generics = folder.fold_generics(generics); let decl = folder.fold_fn_decl(decl); let body = folder.fold_block(body); ItemKind::Fn(decl, unsafety, constness, abi, generics, body) } ItemKind::Mod(m) => ItemKind::Mod(folder.fold_mod(m)), ItemKind::ForeignMod(nm) => ItemKind::ForeignMod(folder.fold_foreign_mod(nm)), ItemKind::Ty(t, generics) => { ItemKind::Ty(folder.fold_ty(t), folder.fold_generics(generics)) } ItemKind::Enum(enum_definition, generics) => { let generics = folder.fold_generics(generics); let variants = enum_definition.variants.move_map(|x| folder.fold_variant(x)); ItemKind::Enum(ast::EnumDef { variants: variants }, generics) } ItemKind::Struct(struct_def, generics) => { let generics = folder.fold_generics(generics); ItemKind::Struct(folder.fold_variant_data(struct_def), generics) } ItemKind::Union(struct_def, generics) => { let generics = folder.fold_generics(generics); ItemKind::Union(folder.fold_variant_data(struct_def), generics) } ItemKind::DefaultImpl(unsafety, ref trait_ref) => { ItemKind::DefaultImpl(unsafety, folder.fold_trait_ref((*trait_ref).clone())) } ItemKind::Impl(unsafety, polarity, generics, ifce, ty, impl_items) => ItemKind::Impl( unsafety, polarity, folder.fold_generics(generics), ifce.map(|trait_ref| folder.fold_trait_ref(trait_ref.clone())), folder.fold_ty(ty), impl_items.move_flat_map(|item| folder.fold_impl_item(item)), ), ItemKind::Trait(unsafety, generics, bounds, items) => ItemKind::Trait( unsafety, folder.fold_generics(generics), folder.fold_bounds(bounds), items.move_flat_map(|item| folder.fold_trait_item(item)), ), ItemKind::Mac(m) => ItemKind::Mac(folder.fold_mac(m)), } } pub fn noop_fold_trait_item(i: TraitItem, folder: &mut T) -> SmallVector { SmallVector::one(TraitItem { id: folder.new_id(i.id), ident: folder.fold_ident(i.ident), attrs: fold_attrs(i.attrs, folder), node: match i.node { TraitItemKind::Const(ty, default) => { TraitItemKind::Const(folder.fold_ty(ty), default.map(|x| folder.fold_expr(x))) } TraitItemKind::Method(sig, body) => { TraitItemKind::Method(noop_fold_method_sig(sig, folder), body.map(|x| folder.fold_block(x))) } TraitItemKind::Type(bounds, default) => { TraitItemKind::Type(folder.fold_bounds(bounds), default.map(|x| folder.fold_ty(x))) } ast::TraitItemKind::Macro(mac) => { TraitItemKind::Macro(folder.fold_mac(mac)) } }, span: folder.new_span(i.span) }) } pub fn noop_fold_impl_item(i: ImplItem, folder: &mut T) -> SmallVector { SmallVector::one(ImplItem { id: folder.new_id(i.id), vis: folder.fold_vis(i.vis), ident: folder.fold_ident(i.ident), attrs: fold_attrs(i.attrs, folder), defaultness: i.defaultness, node: match i.node { ast::ImplItemKind::Const(ty, expr) => { ast::ImplItemKind::Const(folder.fold_ty(ty), folder.fold_expr(expr)) } ast::ImplItemKind::Method(sig, body) => { ast::ImplItemKind::Method(noop_fold_method_sig(sig, folder), folder.fold_block(body)) } ast::ImplItemKind::Type(ty) => ast::ImplItemKind::Type(folder.fold_ty(ty)), ast::ImplItemKind::Macro(mac) => ast::ImplItemKind::Macro(folder.fold_mac(mac)) }, span: folder.new_span(i.span) }) } pub fn noop_fold_mod(Mod {inner, items}: Mod, folder: &mut T) -> Mod { Mod { inner: folder.new_span(inner), items: items.move_flat_map(|x| folder.fold_item(x)), } } pub fn noop_fold_crate(Crate {module, attrs, mut exported_macros, span}: Crate, folder: &mut T) -> Crate { let mut items = folder.fold_item(P(ast::Item { ident: keywords::Invalid.ident(), attrs: attrs, id: ast::DUMMY_NODE_ID, vis: ast::Visibility::Public, span: span, node: ast::ItemKind::Mod(module), })).into_iter(); let (module, attrs, span) = match items.next() { Some(item) => { assert!(items.next().is_none(), "a crate cannot expand to more than one item"); item.and_then(|ast::Item { attrs, span, node, .. }| { match node { ast::ItemKind::Mod(m) => (m, attrs, span), _ => panic!("fold converted a module to not a module"), } }) } None => (ast::Mod { inner: span, items: vec![], }, vec![], span) }; for def in &mut exported_macros { def.id = folder.new_id(def.id); } Crate { module: module, attrs: attrs, exported_macros: exported_macros, span: span, } } // fold one item into possibly many items pub fn noop_fold_item(i: P, folder: &mut T) -> SmallVector> { SmallVector::one(i.map(|i| folder.fold_item_simple(i))) } // fold one item into exactly one item pub fn noop_fold_item_simple(Item {id, ident, attrs, node, vis, span}: Item, folder: &mut T) -> Item { Item { id: folder.new_id(id), vis: folder.fold_vis(vis), ident: folder.fold_ident(ident), attrs: fold_attrs(attrs, folder), node: folder.fold_item_kind(node), span: folder.new_span(span) } } pub fn noop_fold_foreign_item(ni: ForeignItem, folder: &mut T) -> ForeignItem { ForeignItem { id: folder.new_id(ni.id), vis: folder.fold_vis(ni.vis), ident: folder.fold_ident(ni.ident), attrs: fold_attrs(ni.attrs, folder), node: match ni.node { ForeignItemKind::Fn(fdec, generics) => { ForeignItemKind::Fn(folder.fold_fn_decl(fdec), folder.fold_generics(generics)) } ForeignItemKind::Static(t, m) => { ForeignItemKind::Static(folder.fold_ty(t), m) } }, span: folder.new_span(ni.span) } } pub fn noop_fold_method_sig(sig: MethodSig, folder: &mut T) -> MethodSig { MethodSig { generics: folder.fold_generics(sig.generics), abi: sig.abi, unsafety: sig.unsafety, constness: sig.constness, decl: folder.fold_fn_decl(sig.decl) } } pub fn noop_fold_pat(p: P, folder: &mut T) -> P { p.map(|Pat {id, node, span}| Pat { id: folder.new_id(id), node: match node { PatKind::Wild => PatKind::Wild, PatKind::Ident(binding_mode, pth1, sub) => { PatKind::Ident(binding_mode, Spanned{span: folder.new_span(pth1.span), node: folder.fold_ident(pth1.node)}, sub.map(|x| folder.fold_pat(x))) } PatKind::Lit(e) => PatKind::Lit(folder.fold_expr(e)), PatKind::TupleStruct(pth, pats, ddpos) => { PatKind::TupleStruct(folder.fold_path(pth), pats.move_map(|x| folder.fold_pat(x)), ddpos) } PatKind::Path(opt_qself, pth) => { let opt_qself = opt_qself.map(|qself| { QSelf { ty: folder.fold_ty(qself.ty), position: qself.position } }); PatKind::Path(opt_qself, folder.fold_path(pth)) } PatKind::Struct(pth, fields, etc) => { let pth = folder.fold_path(pth); let fs = fields.move_map(|f| { Spanned { span: folder.new_span(f.span), node: ast::FieldPat { ident: f.node.ident, pat: folder.fold_pat(f.node.pat), is_shorthand: f.node.is_shorthand, }} }); PatKind::Struct(pth, fs, etc) } PatKind::Tuple(elts, ddpos) => { PatKind::Tuple(elts.move_map(|x| folder.fold_pat(x)), ddpos) } PatKind::Box(inner) => PatKind::Box(folder.fold_pat(inner)), PatKind::Ref(inner, mutbl) => PatKind::Ref(folder.fold_pat(inner), mutbl), PatKind::Range(e1, e2) => { PatKind::Range(folder.fold_expr(e1), folder.fold_expr(e2)) }, PatKind::Slice(before, slice, after) => { PatKind::Slice(before.move_map(|x| folder.fold_pat(x)), slice.map(|x| folder.fold_pat(x)), after.move_map(|x| folder.fold_pat(x))) } PatKind::Mac(mac) => PatKind::Mac(folder.fold_mac(mac)) }, span: folder.new_span(span) }) } pub fn noop_fold_expr(Expr {id, node, span, attrs}: Expr, folder: &mut T) -> Expr { Expr { node: match node { ExprKind::Box(e) => { ExprKind::Box(folder.fold_expr(e)) } ExprKind::InPlace(p, e) => { ExprKind::InPlace(folder.fold_expr(p), folder.fold_expr(e)) } ExprKind::Vec(exprs) => { ExprKind::Vec(folder.fold_exprs(exprs)) } ExprKind::Repeat(expr, count) => { ExprKind::Repeat(folder.fold_expr(expr), folder.fold_expr(count)) } ExprKind::Tup(exprs) => ExprKind::Tup(folder.fold_exprs(exprs)), ExprKind::Call(f, args) => { ExprKind::Call(folder.fold_expr(f), folder.fold_exprs(args)) } ExprKind::MethodCall(i, tps, args) => { ExprKind::MethodCall( respan(folder.new_span(i.span), folder.fold_ident(i.node)), tps.move_map(|x| folder.fold_ty(x)), folder.fold_exprs(args)) } ExprKind::Binary(binop, lhs, rhs) => { ExprKind::Binary(binop, folder.fold_expr(lhs), folder.fold_expr(rhs)) } ExprKind::Unary(binop, ohs) => { ExprKind::Unary(binop, folder.fold_expr(ohs)) } ExprKind::Lit(l) => ExprKind::Lit(l), ExprKind::Cast(expr, ty) => { ExprKind::Cast(folder.fold_expr(expr), folder.fold_ty(ty)) } ExprKind::Type(expr, ty) => { ExprKind::Type(folder.fold_expr(expr), folder.fold_ty(ty)) } ExprKind::AddrOf(m, ohs) => ExprKind::AddrOf(m, folder.fold_expr(ohs)), ExprKind::If(cond, tr, fl) => { ExprKind::If(folder.fold_expr(cond), folder.fold_block(tr), fl.map(|x| folder.fold_expr(x))) } ExprKind::IfLet(pat, expr, tr, fl) => { ExprKind::IfLet(folder.fold_pat(pat), folder.fold_expr(expr), folder.fold_block(tr), fl.map(|x| folder.fold_expr(x))) } ExprKind::While(cond, body, opt_ident) => { ExprKind::While(folder.fold_expr(cond), folder.fold_block(body), opt_ident.map(|label| respan(folder.new_span(label.span), folder.fold_ident(label.node)))) } ExprKind::WhileLet(pat, expr, body, opt_ident) => { ExprKind::WhileLet(folder.fold_pat(pat), folder.fold_expr(expr), folder.fold_block(body), opt_ident.map(|label| respan(folder.new_span(label.span), folder.fold_ident(label.node)))) } ExprKind::ForLoop(pat, iter, body, opt_ident) => { ExprKind::ForLoop(folder.fold_pat(pat), folder.fold_expr(iter), folder.fold_block(body), opt_ident.map(|label| respan(folder.new_span(label.span), folder.fold_ident(label.node)))) } ExprKind::Loop(body, opt_ident) => { ExprKind::Loop(folder.fold_block(body), opt_ident.map(|label| respan(folder.new_span(label.span), folder.fold_ident(label.node)))) } ExprKind::Match(expr, arms) => { ExprKind::Match(folder.fold_expr(expr), arms.move_map(|x| folder.fold_arm(x))) } ExprKind::Closure(capture_clause, decl, body, span) => { ExprKind::Closure(capture_clause, folder.fold_fn_decl(decl), folder.fold_expr(body), folder.new_span(span)) } ExprKind::Block(blk) => ExprKind::Block(folder.fold_block(blk)), ExprKind::Assign(el, er) => { ExprKind::Assign(folder.fold_expr(el), folder.fold_expr(er)) } ExprKind::AssignOp(op, el, er) => { ExprKind::AssignOp(op, folder.fold_expr(el), folder.fold_expr(er)) } ExprKind::Field(el, ident) => { ExprKind::Field(folder.fold_expr(el), respan(folder.new_span(ident.span), folder.fold_ident(ident.node))) } ExprKind::TupField(el, ident) => { ExprKind::TupField(folder.fold_expr(el), respan(folder.new_span(ident.span), folder.fold_usize(ident.node))) } ExprKind::Index(el, er) => { ExprKind::Index(folder.fold_expr(el), folder.fold_expr(er)) } ExprKind::Range(e1, e2, lim) => { ExprKind::Range(e1.map(|x| folder.fold_expr(x)), e2.map(|x| folder.fold_expr(x)), lim) } ExprKind::Path(qself, path) => { let qself = qself.map(|QSelf { ty, position }| { QSelf { ty: folder.fold_ty(ty), position: position } }); ExprKind::Path(qself, folder.fold_path(path)) } ExprKind::Break(opt_ident, opt_expr) => { ExprKind::Break(opt_ident.map(|label| respan(folder.new_span(label.span), folder.fold_ident(label.node))), opt_expr.map(|e| folder.fold_expr(e))) } ExprKind::Continue(opt_ident) => ExprKind::Continue(opt_ident.map(|label| respan(folder.new_span(label.span), folder.fold_ident(label.node))) ), ExprKind::Ret(e) => ExprKind::Ret(e.map(|x| folder.fold_expr(x))), ExprKind::InlineAsm(asm) => ExprKind::InlineAsm(asm.map(|asm| { InlineAsm { inputs: asm.inputs.move_map(|(c, input)| { (c, folder.fold_expr(input)) }), outputs: asm.outputs.move_map(|out| { InlineAsmOutput { constraint: out.constraint, expr: folder.fold_expr(out.expr), is_rw: out.is_rw, is_indirect: out.is_indirect, } }), ..asm } })), ExprKind::Mac(mac) => ExprKind::Mac(folder.fold_mac(mac)), ExprKind::Struct(path, fields, maybe_expr) => { ExprKind::Struct(folder.fold_path(path), fields.move_map(|x| folder.fold_field(x)), maybe_expr.map(|x| folder.fold_expr(x))) }, ExprKind::Paren(ex) => { let sub_expr = folder.fold_expr(ex); return Expr { // Nodes that are equal modulo `Paren` sugar no-ops should have the same ids. id: sub_expr.id, node: ExprKind::Paren(sub_expr), span: folder.new_span(span), attrs: fold_attrs(attrs.into(), folder).into(), }; } ExprKind::Try(ex) => ExprKind::Try(folder.fold_expr(ex)), }, id: folder.new_id(id), span: folder.new_span(span), attrs: fold_attrs(attrs.into(), folder).into(), } } pub fn noop_fold_opt_expr(e: P, folder: &mut T) -> Option> { Some(folder.fold_expr(e)) } pub fn noop_fold_exprs(es: Vec>, folder: &mut T) -> Vec> { es.move_flat_map(|e| folder.fold_opt_expr(e)) } pub fn noop_fold_stmt(Stmt {node, span, id}: Stmt, folder: &mut T) -> SmallVector { let id = folder.new_id(id); let span = folder.new_span(span); noop_fold_stmt_kind(node, folder).into_iter().map(|node| { Stmt { id: id, node: node, span: span } }).collect() } pub fn noop_fold_stmt_kind(node: StmtKind, folder: &mut T) -> SmallVector { match node { StmtKind::Local(local) => SmallVector::one(StmtKind::Local(folder.fold_local(local))), StmtKind::Item(item) => folder.fold_item(item).into_iter().map(StmtKind::Item).collect(), StmtKind::Expr(expr) => { folder.fold_opt_expr(expr).into_iter().map(StmtKind::Expr).collect() } StmtKind::Semi(expr) => { folder.fold_opt_expr(expr).into_iter().map(StmtKind::Semi).collect() } StmtKind::Mac(mac) => SmallVector::one(StmtKind::Mac(mac.map(|(mac, semi, attrs)| { (folder.fold_mac(mac), semi, fold_attrs(attrs.into(), folder).into()) }))), } } pub fn noop_fold_vis(vis: Visibility, folder: &mut T) -> Visibility { match vis { Visibility::Restricted { path, id } => Visibility::Restricted { path: path.map(|path| folder.fold_path(path)), id: folder.new_id(id) }, _ => vis, } } #[cfg(test)] mod tests { use std::io; use ast::{self, Ident}; use util::parser_testing::{string_to_crate, matches_codepattern}; use print::pprust; use fold; use super::*; // this version doesn't care about getting comments or docstrings in. fn fake_print_crate(s: &mut pprust::State, krate: &ast::Crate) -> io::Result<()> { s.print_mod(&krate.module, &krate.attrs) } // change every identifier to "zz" struct ToZzIdentFolder; impl Folder for ToZzIdentFolder { fn fold_ident(&mut self, _: ast::Ident) -> ast::Ident { Ident::from_str("zz") } fn fold_mac(&mut self, mac: ast::Mac) -> ast::Mac { fold::noop_fold_mac(mac, self) } } // maybe add to expand.rs... macro_rules! assert_pred { ($pred:expr, $predname:expr, $a:expr , $b:expr) => ( { let pred_val = $pred; let a_val = $a; let b_val = $b; if !(pred_val(&a_val, &b_val)) { panic!("expected args satisfying {}, got {} and {}", $predname, a_val, b_val); } } ) } // make sure idents get transformed everywhere #[test] fn ident_transformation () { let mut zz_fold = ToZzIdentFolder; let ast = string_to_crate( "#[a] mod b {fn c (d : e, f : g) {h!(i,j,k);l;m}}".to_string()); let folded_crate = zz_fold.fold_crate(ast); assert_pred!( matches_codepattern, "matches_codepattern", pprust::to_string(|s| fake_print_crate(s, &folded_crate)), "#[a]mod zz{fn zz(zz:zz,zz:zz){zz!(zz,zz,zz);zz;zz}}".to_string()); } // even inside macro defs.... #[test] fn ident_transformation_in_defs () { let mut zz_fold = ToZzIdentFolder; let ast = string_to_crate( "macro_rules! a {(b $c:expr $(d $e:token)f+ => \ (g $(d $d $e)+))} ".to_string()); let folded_crate = zz_fold.fold_crate(ast); assert_pred!( matches_codepattern, "matches_codepattern", pprust::to_string(|s| fake_print_crate(s, &folded_crate)), "zz!zz((zz$zz:zz$(zz $zz:zz)zz+=>(zz$(zz$zz$zz)+)));".to_string()); } }