1 use crate::expand::{AstFragment, AstFragmentKind};
3 use rustc_ast::mut_visit::*;
5 use rustc_data_structures::fx::FxHashMap;
6 use rustc_span::source_map::DUMMY_SP;
7 use rustc_span::symbol::Ident;
8 use smallvec::{smallvec, SmallVec};
12 kind: AstFragmentKind,
14 vis: Option<ast::Visibility>,
16 fn mac_placeholder() -> P<ast::MacCall> {
18 path: ast::Path { span: DUMMY_SP, segments: ThinVec::new(), tokens: None },
19 args: P(ast::MacArgs::Empty),
20 prior_type_ascription: None,
24 let ident = Ident::empty();
25 let attrs = ast::AttrVec::new();
26 let vis = vis.unwrap_or(ast::Visibility {
28 kind: ast::VisibilityKind::Inherited,
32 let expr_placeholder = || {
36 attrs: ast::AttrVec::new(),
37 kind: ast::ExprKind::MacCall(mac_placeholder()),
42 || P(ast::Ty { id, kind: ast::TyKind::MacCall(mac_placeholder()), span, tokens: None });
44 || P(ast::Pat { id, kind: ast::PatKind::MacCall(mac_placeholder()), span, tokens: None });
47 AstFragmentKind::Crate => AstFragment::Crate(ast::Crate {
48 attrs: Default::default(),
49 items: Default::default(),
50 spans: ast::ModSpans { inner_span: span, ..Default::default() },
54 AstFragmentKind::Expr => AstFragment::Expr(expr_placeholder()),
55 AstFragmentKind::OptExpr => AstFragment::OptExpr(Some(expr_placeholder())),
56 AstFragmentKind::MethodReceiverExpr => AstFragment::MethodReceiverExpr(expr_placeholder()),
57 AstFragmentKind::Items => AstFragment::Items(smallvec![P(ast::Item {
63 kind: ast::ItemKind::MacCall(mac_placeholder()),
66 AstFragmentKind::TraitItems => AstFragment::TraitItems(smallvec![P(ast::AssocItem {
72 kind: ast::AssocItemKind::MacCall(mac_placeholder()),
75 AstFragmentKind::ImplItems => AstFragment::ImplItems(smallvec![P(ast::AssocItem {
81 kind: ast::AssocItemKind::MacCall(mac_placeholder()),
84 AstFragmentKind::ForeignItems => {
85 AstFragment::ForeignItems(smallvec![P(ast::ForeignItem {
91 kind: ast::ForeignItemKind::MacCall(mac_placeholder()),
95 AstFragmentKind::Pat => AstFragment::Pat(P(ast::Pat {
98 kind: ast::PatKind::MacCall(mac_placeholder()),
101 AstFragmentKind::Ty => AstFragment::Ty(P(ast::Ty {
104 kind: ast::TyKind::MacCall(mac_placeholder()),
107 AstFragmentKind::Stmts => AstFragment::Stmts(smallvec![{
108 let mac = P(ast::MacCallStmt {
109 mac: mac_placeholder(),
110 style: ast::MacStmtStyle::Braces,
111 attrs: ast::AttrVec::new(),
114 ast::Stmt { id, span, kind: ast::StmtKind::MacCall(mac) }
116 AstFragmentKind::Arms => AstFragment::Arms(smallvec![ast::Arm {
117 attrs: Default::default(),
118 body: expr_placeholder(),
123 is_placeholder: true,
125 AstFragmentKind::ExprFields => AstFragment::ExprFields(smallvec![ast::ExprField {
126 attrs: Default::default(),
127 expr: expr_placeholder(),
132 is_placeholder: true,
134 AstFragmentKind::PatFields => AstFragment::PatFields(smallvec![ast::PatField {
135 attrs: Default::default(),
141 is_placeholder: true,
143 AstFragmentKind::GenericParams => AstFragment::GenericParams(smallvec![{
145 attrs: Default::default(),
146 bounds: Default::default(),
149 is_placeholder: true,
150 kind: ast::GenericParamKind::Lifetime,
154 AstFragmentKind::Params => AstFragment::Params(smallvec![ast::Param {
155 attrs: Default::default(),
160 is_placeholder: true,
162 AstFragmentKind::FieldDefs => AstFragment::FieldDefs(smallvec![ast::FieldDef {
163 attrs: Default::default(),
169 is_placeholder: true,
171 AstFragmentKind::Variants => AstFragment::Variants(smallvec![ast::Variant {
172 attrs: Default::default(),
173 data: ast::VariantData::Struct(Default::default(), false),
179 is_placeholder: true,
185 pub struct PlaceholderExpander {
186 expanded_fragments: FxHashMap<ast::NodeId, AstFragment>,
189 impl PlaceholderExpander {
190 pub fn add(&mut self, id: ast::NodeId, mut fragment: AstFragment) {
191 fragment.mut_visit_with(self);
192 self.expanded_fragments.insert(id, fragment);
195 fn remove(&mut self, id: ast::NodeId) -> AstFragment {
196 self.expanded_fragments.remove(&id).unwrap()
200 impl MutVisitor for PlaceholderExpander {
201 fn flat_map_arm(&mut self, arm: ast::Arm) -> SmallVec<[ast::Arm; 1]> {
202 if arm.is_placeholder {
203 self.remove(arm.id).make_arms()
205 noop_flat_map_arm(arm, self)
209 fn flat_map_expr_field(&mut self, field: ast::ExprField) -> SmallVec<[ast::ExprField; 1]> {
210 if field.is_placeholder {
211 self.remove(field.id).make_expr_fields()
213 noop_flat_map_expr_field(field, self)
217 fn flat_map_pat_field(&mut self, fp: ast::PatField) -> SmallVec<[ast::PatField; 1]> {
218 if fp.is_placeholder {
219 self.remove(fp.id).make_pat_fields()
221 noop_flat_map_pat_field(fp, self)
225 fn flat_map_generic_param(
227 param: ast::GenericParam,
228 ) -> SmallVec<[ast::GenericParam; 1]> {
229 if param.is_placeholder {
230 self.remove(param.id).make_generic_params()
232 noop_flat_map_generic_param(param, self)
236 fn flat_map_param(&mut self, p: ast::Param) -> SmallVec<[ast::Param; 1]> {
237 if p.is_placeholder {
238 self.remove(p.id).make_params()
240 noop_flat_map_param(p, self)
244 fn flat_map_field_def(&mut self, sf: ast::FieldDef) -> SmallVec<[ast::FieldDef; 1]> {
245 if sf.is_placeholder {
246 self.remove(sf.id).make_field_defs()
248 noop_flat_map_field_def(sf, self)
252 fn flat_map_variant(&mut self, variant: ast::Variant) -> SmallVec<[ast::Variant; 1]> {
253 if variant.is_placeholder {
254 self.remove(variant.id).make_variants()
256 noop_flat_map_variant(variant, self)
260 fn flat_map_item(&mut self, item: P<ast::Item>) -> SmallVec<[P<ast::Item>; 1]> {
262 ast::ItemKind::MacCall(_) => self.remove(item.id).make_items(),
263 _ => noop_flat_map_item(item, self),
267 fn flat_map_trait_item(&mut self, item: P<ast::AssocItem>) -> SmallVec<[P<ast::AssocItem>; 1]> {
269 ast::AssocItemKind::MacCall(_) => self.remove(item.id).make_trait_items(),
270 _ => noop_flat_map_assoc_item(item, self),
274 fn flat_map_impl_item(&mut self, item: P<ast::AssocItem>) -> SmallVec<[P<ast::AssocItem>; 1]> {
276 ast::AssocItemKind::MacCall(_) => self.remove(item.id).make_impl_items(),
277 _ => noop_flat_map_assoc_item(item, self),
281 fn flat_map_foreign_item(
283 item: P<ast::ForeignItem>,
284 ) -> SmallVec<[P<ast::ForeignItem>; 1]> {
286 ast::ForeignItemKind::MacCall(_) => self.remove(item.id).make_foreign_items(),
287 _ => noop_flat_map_foreign_item(item, self),
291 fn visit_expr(&mut self, expr: &mut P<ast::Expr>) {
293 ast::ExprKind::MacCall(_) => *expr = self.remove(expr.id).make_expr(),
294 _ => noop_visit_expr(expr, self),
298 fn visit_method_receiver_expr(&mut self, expr: &mut P<ast::Expr>) {
300 ast::ExprKind::MacCall(_) => *expr = self.remove(expr.id).make_method_receiver_expr(),
301 _ => noop_visit_expr(expr, self),
305 fn filter_map_expr(&mut self, expr: P<ast::Expr>) -> Option<P<ast::Expr>> {
307 ast::ExprKind::MacCall(_) => self.remove(expr.id).make_opt_expr(),
308 _ => noop_filter_map_expr(expr, self),
312 fn flat_map_stmt(&mut self, stmt: ast::Stmt) -> SmallVec<[ast::Stmt; 1]> {
313 let (style, mut stmts) = match stmt.kind {
314 ast::StmtKind::MacCall(mac) => (mac.style, self.remove(stmt.id).make_stmts()),
315 _ => return noop_flat_map_stmt(stmt, self),
318 if style == ast::MacStmtStyle::Semicolon {
319 // Implement the proposal described in
320 // https://github.com/rust-lang/rust/issues/61733#issuecomment-509626449
322 // The macro invocation expands to the list of statements. If the
323 // list of statements is empty, then 'parse' the trailing semicolon
324 // on the original invocation as an empty statement. That is:
326 // `empty();` is parsed as a single `StmtKind::Empty`
328 // If the list of statements is non-empty, see if the final
329 // statement already has a trailing semicolon.
331 // If it doesn't have a semicolon, then 'parse' the trailing
332 // semicolon from the invocation as part of the final statement,
333 // using `stmt.add_trailing_semicolon()`
335 // If it does have a semicolon, then 'parse' the trailing semicolon
336 // from the invocation as a new StmtKind::Empty
338 // FIXME: We will need to preserve the original semicolon token and
339 // span as part of #15701
341 ast::Stmt { id: ast::DUMMY_NODE_ID, kind: ast::StmtKind::Empty, span: DUMMY_SP };
343 if let Some(stmt) = stmts.pop() {
344 if stmt.has_trailing_semicolon() {
346 stmts.push(empty_stmt);
348 stmts.push(stmt.add_trailing_semicolon());
351 stmts.push(empty_stmt);
358 fn visit_pat(&mut self, pat: &mut P<ast::Pat>) {
360 ast::PatKind::MacCall(_) => *pat = self.remove(pat.id).make_pat(),
361 _ => noop_visit_pat(pat, self),
365 fn visit_ty(&mut self, ty: &mut P<ast::Ty>) {
367 ast::TyKind::MacCall(_) => *ty = self.remove(ty.id).make_ty(),
368 _ => noop_visit_ty(ty, self),
372 fn visit_crate(&mut self, krate: &mut ast::Crate) {
373 if krate.is_placeholder {
374 *krate = self.remove(krate.id).make_crate();
376 noop_visit_crate(krate, self)