1 use crate::expand::{AstFragment, AstFragmentKind};
4 use rustc_ast::mut_visit::*;
6 use rustc_span::source_map::DUMMY_SP;
7 use rustc_span::symbol::Ident;
9 use smallvec::{smallvec, SmallVec};
11 use rustc_data_structures::fx::FxHashMap;
14 kind: AstFragmentKind,
16 vis: Option<ast::Visibility>,
18 fn mac_placeholder() -> P<ast::MacCall> {
20 path: ast::Path { span: DUMMY_SP, segments: Vec::new(), tokens: None },
21 args: P(ast::MacArgs::Empty),
22 prior_type_ascription: None,
26 let ident = Ident::empty();
27 let attrs = ast::AttrVec::new();
28 let vis = vis.unwrap_or(ast::Visibility {
30 kind: ast::VisibilityKind::Inherited,
34 let expr_placeholder = || {
38 attrs: ast::AttrVec::new(),
39 kind: ast::ExprKind::MacCall(mac_placeholder()),
44 || P(ast::Ty { id, kind: ast::TyKind::MacCall(mac_placeholder()), span, tokens: None });
46 || P(ast::Pat { id, kind: ast::PatKind::MacCall(mac_placeholder()), span, tokens: None });
49 AstFragmentKind::Crate => AstFragment::Crate(ast::Crate {
50 attrs: Default::default(),
51 items: Default::default(),
52 spans: ast::ModSpans { inner_span: span, ..Default::default() },
56 AstFragmentKind::Expr => AstFragment::Expr(expr_placeholder()),
57 AstFragmentKind::OptExpr => AstFragment::OptExpr(Some(expr_placeholder())),
58 AstFragmentKind::MethodReceiverExpr => AstFragment::MethodReceiverExpr(expr_placeholder()),
59 AstFragmentKind::Items => AstFragment::Items(smallvec![P(ast::Item {
65 kind: ast::ItemKind::MacCall(mac_placeholder()),
68 AstFragmentKind::TraitItems => AstFragment::TraitItems(smallvec![P(ast::AssocItem {
74 kind: ast::AssocItemKind::MacCall(mac_placeholder()),
77 AstFragmentKind::ImplItems => AstFragment::ImplItems(smallvec![P(ast::AssocItem {
83 kind: ast::AssocItemKind::MacCall(mac_placeholder()),
86 AstFragmentKind::ForeignItems => {
87 AstFragment::ForeignItems(smallvec![P(ast::ForeignItem {
93 kind: ast::ForeignItemKind::MacCall(mac_placeholder()),
97 AstFragmentKind::Pat => AstFragment::Pat(P(ast::Pat {
100 kind: ast::PatKind::MacCall(mac_placeholder()),
103 AstFragmentKind::Ty => AstFragment::Ty(P(ast::Ty {
106 kind: ast::TyKind::MacCall(mac_placeholder()),
109 AstFragmentKind::Stmts => AstFragment::Stmts(smallvec![{
110 let mac = P(ast::MacCallStmt {
111 mac: mac_placeholder(),
112 style: ast::MacStmtStyle::Braces,
113 attrs: ast::AttrVec::new(),
116 ast::Stmt { id, span, kind: ast::StmtKind::MacCall(mac) }
118 AstFragmentKind::Arms => AstFragment::Arms(smallvec![ast::Arm {
119 attrs: Default::default(),
120 body: expr_placeholder(),
125 is_placeholder: true,
127 AstFragmentKind::ExprFields => AstFragment::ExprFields(smallvec![ast::ExprField {
128 attrs: Default::default(),
129 expr: expr_placeholder(),
134 is_placeholder: true,
136 AstFragmentKind::PatFields => AstFragment::PatFields(smallvec![ast::PatField {
137 attrs: Default::default(),
143 is_placeholder: true,
145 AstFragmentKind::GenericParams => AstFragment::GenericParams(smallvec![{
147 attrs: Default::default(),
148 bounds: Default::default(),
151 is_placeholder: true,
152 kind: ast::GenericParamKind::Lifetime,
156 AstFragmentKind::Params => AstFragment::Params(smallvec![ast::Param {
157 attrs: Default::default(),
162 is_placeholder: true,
164 AstFragmentKind::FieldDefs => AstFragment::FieldDefs(smallvec![ast::FieldDef {
165 attrs: Default::default(),
171 is_placeholder: true,
173 AstFragmentKind::Variants => AstFragment::Variants(smallvec![ast::Variant {
174 attrs: Default::default(),
175 data: ast::VariantData::Struct(Default::default(), false),
181 is_placeholder: true,
187 pub struct PlaceholderExpander {
188 expanded_fragments: FxHashMap<ast::NodeId, AstFragment>,
191 impl PlaceholderExpander {
192 pub fn add(&mut self, id: ast::NodeId, mut fragment: AstFragment) {
193 fragment.mut_visit_with(self);
194 self.expanded_fragments.insert(id, fragment);
197 fn remove(&mut self, id: ast::NodeId) -> AstFragment {
198 self.expanded_fragments.remove(&id).unwrap()
202 impl MutVisitor for PlaceholderExpander {
203 fn flat_map_arm(&mut self, arm: ast::Arm) -> SmallVec<[ast::Arm; 1]> {
204 if arm.is_placeholder {
205 self.remove(arm.id).make_arms()
207 noop_flat_map_arm(arm, self)
211 fn flat_map_expr_field(&mut self, field: ast::ExprField) -> SmallVec<[ast::ExprField; 1]> {
212 if field.is_placeholder {
213 self.remove(field.id).make_expr_fields()
215 noop_flat_map_expr_field(field, self)
219 fn flat_map_pat_field(&mut self, fp: ast::PatField) -> SmallVec<[ast::PatField; 1]> {
220 if fp.is_placeholder {
221 self.remove(fp.id).make_pat_fields()
223 noop_flat_map_pat_field(fp, self)
227 fn flat_map_generic_param(
229 param: ast::GenericParam,
230 ) -> SmallVec<[ast::GenericParam; 1]> {
231 if param.is_placeholder {
232 self.remove(param.id).make_generic_params()
234 noop_flat_map_generic_param(param, self)
238 fn flat_map_param(&mut self, p: ast::Param) -> SmallVec<[ast::Param; 1]> {
239 if p.is_placeholder {
240 self.remove(p.id).make_params()
242 noop_flat_map_param(p, self)
246 fn flat_map_field_def(&mut self, sf: ast::FieldDef) -> SmallVec<[ast::FieldDef; 1]> {
247 if sf.is_placeholder {
248 self.remove(sf.id).make_field_defs()
250 noop_flat_map_field_def(sf, self)
254 fn flat_map_variant(&mut self, variant: ast::Variant) -> SmallVec<[ast::Variant; 1]> {
255 if variant.is_placeholder {
256 self.remove(variant.id).make_variants()
258 noop_flat_map_variant(variant, self)
262 fn flat_map_item(&mut self, item: P<ast::Item>) -> SmallVec<[P<ast::Item>; 1]> {
264 ast::ItemKind::MacCall(_) => self.remove(item.id).make_items(),
265 _ => noop_flat_map_item(item, self),
269 fn flat_map_trait_item(&mut self, item: P<ast::AssocItem>) -> SmallVec<[P<ast::AssocItem>; 1]> {
271 ast::AssocItemKind::MacCall(_) => self.remove(item.id).make_trait_items(),
272 _ => noop_flat_map_assoc_item(item, self),
276 fn flat_map_impl_item(&mut self, item: P<ast::AssocItem>) -> SmallVec<[P<ast::AssocItem>; 1]> {
278 ast::AssocItemKind::MacCall(_) => self.remove(item.id).make_impl_items(),
279 _ => noop_flat_map_assoc_item(item, self),
283 fn flat_map_foreign_item(
285 item: P<ast::ForeignItem>,
286 ) -> SmallVec<[P<ast::ForeignItem>; 1]> {
288 ast::ForeignItemKind::MacCall(_) => self.remove(item.id).make_foreign_items(),
289 _ => noop_flat_map_foreign_item(item, self),
293 fn visit_expr(&mut self, expr: &mut P<ast::Expr>) {
295 ast::ExprKind::MacCall(_) => *expr = self.remove(expr.id).make_expr(),
296 _ => noop_visit_expr(expr, self),
300 fn visit_method_receiver_expr(&mut self, expr: &mut P<ast::Expr>) {
302 ast::ExprKind::MacCall(_) => *expr = self.remove(expr.id).make_method_receiver_expr(),
303 _ => noop_visit_expr(expr, self),
307 fn filter_map_expr(&mut self, expr: P<ast::Expr>) -> Option<P<ast::Expr>> {
309 ast::ExprKind::MacCall(_) => self.remove(expr.id).make_opt_expr(),
310 _ => noop_filter_map_expr(expr, self),
314 fn flat_map_stmt(&mut self, stmt: ast::Stmt) -> SmallVec<[ast::Stmt; 1]> {
315 let (style, mut stmts) = match stmt.kind {
316 ast::StmtKind::MacCall(mac) => (mac.style, self.remove(stmt.id).make_stmts()),
317 _ => return noop_flat_map_stmt(stmt, self),
320 if style == ast::MacStmtStyle::Semicolon {
321 // Implement the proposal described in
322 // https://github.com/rust-lang/rust/issues/61733#issuecomment-509626449
324 // The macro invocation expands to the list of statements. If the
325 // list of statements is empty, then 'parse' the trailing semicolon
326 // on the original invocation as an empty statement. That is:
328 // `empty();` is parsed as a single `StmtKind::Empty`
330 // If the list of statements is non-empty, see if the final
331 // statement already has a trailing semicolon.
333 // If it doesn't have a semicolon, then 'parse' the trailing
334 // semicolon from the invocation as part of the final statement,
335 // using `stmt.add_trailing_semicolon()`
337 // If it does have a semicolon, then 'parse' the trailing semicolon
338 // from the invocation as a new StmtKind::Empty
340 // FIXME: We will need to preserve the original semicolon token and
341 // span as part of #15701
343 ast::Stmt { id: ast::DUMMY_NODE_ID, kind: ast::StmtKind::Empty, span: DUMMY_SP };
345 if let Some(stmt) = stmts.pop() {
346 if stmt.has_trailing_semicolon() {
348 stmts.push(empty_stmt);
350 stmts.push(stmt.add_trailing_semicolon());
353 stmts.push(empty_stmt);
360 fn visit_pat(&mut self, pat: &mut P<ast::Pat>) {
362 ast::PatKind::MacCall(_) => *pat = self.remove(pat.id).make_pat(),
363 _ => noop_visit_pat(pat, self),
367 fn visit_ty(&mut self, ty: &mut P<ast::Ty>) {
369 ast::TyKind::MacCall(_) => *ty = self.remove(ty.id).make_ty(),
370 _ => noop_visit_ty(ty, self),
374 fn visit_crate(&mut self, krate: &mut ast::Crate) {
375 if krate.is_placeholder {
376 *krate = self.remove(krate.id).make_crate();
378 noop_visit_crate(krate, self)