src/librustc_expand/placeholders.rs

   1 use crate::base::ExtCtxt;
   2 use crate::expand::{AstFragment, AstFragmentKind};
   3
   4 use rustc_ast::ast;
   5 use rustc_ast::mut_visit::*;
   6 use rustc_ast::ptr::P;
   7 use rustc_span::source_map::{dummy_spanned, DUMMY_SP};
   8
   9 use smallvec::{smallvec, SmallVec};
  10
  11 use rustc_data_structures::fx::FxHashMap;
  12
  13 pub fn placeholder(
  14     kind: AstFragmentKind,
  15     id: ast::NodeId,
  16     vis: Option<ast::Visibility>,
  17 ) -> AstFragment {
  18     fn mac_placeholder() -> ast::Mac {
  19         ast::Mac {
  20             path: ast::Path { span: DUMMY_SP, segments: Vec::new() },
  21             args: P(ast::MacArgs::Empty),
  22             prior_type_ascription: None,
  23         }
  24     }
  25
  26     let ident = ast::Ident::invalid();
  27     let attrs = Vec::new();
  28     let vis = vis.unwrap_or_else(|| dummy_spanned(ast::VisibilityKind::Inherited));
  29     let span = DUMMY_SP;
  30     let expr_placeholder = || {
  31         P(ast::Expr {
  32             id,
  33             span,
  34             attrs: ast::AttrVec::new(),
  35             kind: ast::ExprKind::Mac(mac_placeholder()),
  36         })
  37     };
  38     let ty = || P(ast::Ty { id, kind: ast::TyKind::Mac(mac_placeholder()), span });
  39     let pat = || P(ast::Pat { id, kind: ast::PatKind::Mac(mac_placeholder()), span });
  40
  41     match kind {
  42         AstFragmentKind::Expr => AstFragment::Expr(expr_placeholder()),
  43         AstFragmentKind::OptExpr => AstFragment::OptExpr(Some(expr_placeholder())),
  44         AstFragmentKind::Items => AstFragment::Items(smallvec![P(ast::Item {
  45             id,
  46             span,
  47             ident,
  48             vis,
  49             attrs,
  50             kind: ast::ItemKind::Mac(mac_placeholder()),
  51             tokens: None,
  52         })]),
  53         AstFragmentKind::TraitItems => AstFragment::TraitItems(smallvec![P(ast::AssocItem {
  54             id,
  55             span,
  56             ident,
  57             vis,
  58             attrs,
  59             kind: ast::AssocItemKind::Macro(mac_placeholder()),
  60             tokens: None,
  61         })]),
  62         AstFragmentKind::ImplItems => AstFragment::ImplItems(smallvec![P(ast::AssocItem {
  63             id,
  64             span,
  65             ident,
  66             vis,
  67             attrs,
  68             kind: ast::AssocItemKind::Macro(mac_placeholder()),
  69             tokens: None,
  70         })]),
  71         AstFragmentKind::ForeignItems => {
  72             AstFragment::ForeignItems(smallvec![P(ast::ForeignItem {
  73                 id,
  74                 span,
  75                 ident,
  76                 vis,
  77                 attrs,
  78                 kind: ast::ForeignItemKind::Macro(mac_placeholder()),
  79                 tokens: None,
  80             })])
  81         }
  82         AstFragmentKind::Pat => {
  83             AstFragment::Pat(P(ast::Pat { id, span, kind: ast::PatKind::Mac(mac_placeholder()) }))
  84         }
  85         AstFragmentKind::Ty => {
  86             AstFragment::Ty(P(ast::Ty { id, span, kind: ast::TyKind::Mac(mac_placeholder()) }))
  87         }
  88         AstFragmentKind::Stmts => AstFragment::Stmts(smallvec![{
  89             let mac = P((mac_placeholder(), ast::MacStmtStyle::Braces, ast::AttrVec::new()));
  90             ast::Stmt { id, span, kind: ast::StmtKind::Mac(mac) }
  91         }]),
  92         AstFragmentKind::Arms => AstFragment::Arms(smallvec![ast::Arm {
  93             attrs: Default::default(),
  94             body: expr_placeholder(),
  95             guard: None,
  96             id,
  97             pat: pat(),
  98             span,
  99             is_placeholder: true,
 100         }]),
 101         AstFragmentKind::Fields => AstFragment::Fields(smallvec![ast::Field {
 102             attrs: Default::default(),
 103             expr: expr_placeholder(),
 104             id,
 105             ident,
 106             is_shorthand: false,
 107             span,
 108             is_placeholder: true,
 109         }]),
 110         AstFragmentKind::FieldPats => AstFragment::FieldPats(smallvec![ast::FieldPat {
 111             attrs: Default::default(),
 112             id,
 113             ident,
 114             is_shorthand: false,
 115             pat: pat(),
 116             span,
 117             is_placeholder: true,
 118         }]),
 119         AstFragmentKind::GenericParams => AstFragment::GenericParams(smallvec![{
 120             ast::GenericParam {
 121                 attrs: Default::default(),
 122                 bounds: Default::default(),
 123                 id,
 124                 ident,
 125                 is_placeholder: true,
 126                 kind: ast::GenericParamKind::Lifetime,
 127             }
 128         }]),
 129         AstFragmentKind::Params => AstFragment::Params(smallvec![ast::Param {
 130             attrs: Default::default(),
 131             id,
 132             pat: pat(),
 133             span,
 134             ty: ty(),
 135             is_placeholder: true,
 136         }]),
 137         AstFragmentKind::StructFields => AstFragment::StructFields(smallvec![ast::StructField {
 138             attrs: Default::default(),
 139             id,
 140             ident: None,
 141             span,
 142             ty: ty(),
 143             vis,
 144             is_placeholder: true,
 145         }]),
 146         AstFragmentKind::Variants => AstFragment::Variants(smallvec![ast::Variant {
 147             attrs: Default::default(),
 148             data: ast::VariantData::Struct(Default::default(), false),
 149             disr_expr: None,
 150             id,
 151             ident,
 152             span,
 153             vis,
 154             is_placeholder: true,
 155         }]),
 156     }
 157 }
 158
 159 pub struct PlaceholderExpander<'a, 'b> {
 160     expanded_fragments: FxHashMap<ast::NodeId, AstFragment>,
 161     cx: &'a mut ExtCtxt<'b>,
 162     monotonic: bool,
 163 }
 164
 165 impl<'a, 'b> PlaceholderExpander<'a, 'b> {
 166     pub fn new(cx: &'a mut ExtCtxt<'b>, monotonic: bool) -> Self {
 167         PlaceholderExpander { cx, expanded_fragments: FxHashMap::default(), monotonic }
 168     }
 169
 170     pub fn add(&mut self, id: ast::NodeId, mut fragment: AstFragment) {
 171         fragment.mut_visit_with(self);
 172         self.expanded_fragments.insert(id, fragment);
 173     }
 174
 175     fn remove(&mut self, id: ast::NodeId) -> AstFragment {
 176         self.expanded_fragments.remove(&id).unwrap()
 177     }
 178 }
 179
 180 impl<'a, 'b> MutVisitor for PlaceholderExpander<'a, 'b> {
 181     fn flat_map_arm(&mut self, arm: ast::Arm) -> SmallVec<[ast::Arm; 1]> {
 182         if arm.is_placeholder {
 183             self.remove(arm.id).make_arms()
 184         } else {
 185             noop_flat_map_arm(arm, self)
 186         }
 187     }
 188
 189     fn flat_map_field(&mut self, field: ast::Field) -> SmallVec<[ast::Field; 1]> {
 190         if field.is_placeholder {
 191             self.remove(field.id).make_fields()
 192         } else {
 193             noop_flat_map_field(field, self)
 194         }
 195     }
 196
 197     fn flat_map_field_pattern(&mut self, fp: ast::FieldPat) -> SmallVec<[ast::FieldPat; 1]> {
 198         if fp.is_placeholder {
 199             self.remove(fp.id).make_field_patterns()
 200         } else {
 201             noop_flat_map_field_pattern(fp, self)
 202         }
 203     }
 204
 205     fn flat_map_generic_param(
 206         &mut self,
 207         param: ast::GenericParam,
 208     ) -> SmallVec<[ast::GenericParam; 1]> {
 209         if param.is_placeholder {
 210             self.remove(param.id).make_generic_params()
 211         } else {
 212             noop_flat_map_generic_param(param, self)
 213         }
 214     }
 215
 216     fn flat_map_param(&mut self, p: ast::Param) -> SmallVec<[ast::Param; 1]> {
 217         if p.is_placeholder {
 218             self.remove(p.id).make_params()
 219         } else {
 220             noop_flat_map_param(p, self)
 221         }
 222     }
 223
 224     fn flat_map_struct_field(&mut self, sf: ast::StructField) -> SmallVec<[ast::StructField; 1]> {
 225         if sf.is_placeholder {
 226             self.remove(sf.id).make_struct_fields()
 227         } else {
 228             noop_flat_map_struct_field(sf, self)
 229         }
 230     }
 231
 232     fn flat_map_variant(&mut self, variant: ast::Variant) -> SmallVec<[ast::Variant; 1]> {
 233         if variant.is_placeholder {
 234             self.remove(variant.id).make_variants()
 235         } else {
 236             noop_flat_map_variant(variant, self)
 237         }
 238     }
 239
 240     fn flat_map_item(&mut self, item: P<ast::Item>) -> SmallVec<[P<ast::Item>; 1]> {
 241         match item.kind {
 242             ast::ItemKind::Mac(_) => return self.remove(item.id).make_items(),
 243             ast::ItemKind::MacroDef(_) => return smallvec![item],
 244             _ => {}
 245         }
 246
 247         noop_flat_map_item(item, self)
 248     }
 249
 250     fn flat_map_trait_item(&mut self, item: P<ast::AssocItem>) -> SmallVec<[P<ast::AssocItem>; 1]> {
 251         match item.kind {
 252             ast::AssocItemKind::Macro(_) => self.remove(item.id).make_trait_items(),
 253             _ => noop_flat_map_assoc_item(item, self),
 254         }
 255     }
 256
 257     fn flat_map_impl_item(&mut self, item: P<ast::AssocItem>) -> SmallVec<[P<ast::AssocItem>; 1]> {
 258         match item.kind {
 259             ast::AssocItemKind::Macro(_) => self.remove(item.id).make_impl_items(),
 260             _ => noop_flat_map_assoc_item(item, self),
 261         }
 262     }
 263
 264     fn flat_map_foreign_item(
 265         &mut self,
 266         item: P<ast::ForeignItem>,
 267     ) -> SmallVec<[P<ast::ForeignItem>; 1]> {
 268         match item.kind {
 269             ast::ForeignItemKind::Macro(_) => self.remove(item.id).make_foreign_items(),
 270             _ => noop_flat_map_foreign_item(item, self),
 271         }
 272     }
 273
 274     fn visit_expr(&mut self, expr: &mut P<ast::Expr>) {
 275         match expr.kind {
 276             ast::ExprKind::Mac(_) => *expr = self.remove(expr.id).make_expr(),
 277             _ => noop_visit_expr(expr, self),
 278         }
 279     }
 280
 281     fn filter_map_expr(&mut self, expr: P<ast::Expr>) -> Option<P<ast::Expr>> {
 282         match expr.kind {
 283             ast::ExprKind::Mac(_) => self.remove(expr.id).make_opt_expr(),
 284             _ => noop_filter_map_expr(expr, self),
 285         }
 286     }
 287
 288     fn flat_map_stmt(&mut self, stmt: ast::Stmt) -> SmallVec<[ast::Stmt; 1]> {
 289         let (style, mut stmts) = match stmt.kind {
 290             ast::StmtKind::Mac(mac) => (mac.1, self.remove(stmt.id).make_stmts()),
 291             _ => return noop_flat_map_stmt(stmt, self),
 292         };
 293
 294         if style == ast::MacStmtStyle::Semicolon {
 295             if let Some(stmt) = stmts.pop() {
 296                 stmts.push(stmt.add_trailing_semicolon());
 297             }
 298         }
 299
 300         stmts
 301     }
 302
 303     fn visit_pat(&mut self, pat: &mut P<ast::Pat>) {
 304         match pat.kind {
 305             ast::PatKind::Mac(_) => *pat = self.remove(pat.id).make_pat(),
 306             _ => noop_visit_pat(pat, self),
 307         }
 308     }
 309
 310     fn visit_ty(&mut self, ty: &mut P<ast::Ty>) {
 311         match ty.kind {
 312             ast::TyKind::Mac(_) => *ty = self.remove(ty.id).make_ty(),
 313             _ => noop_visit_ty(ty, self),
 314         }
 315     }
 316
 317     fn visit_block(&mut self, block: &mut P<ast::Block>) {
 318         noop_visit_block(block, self);
 319
 320         for stmt in block.stmts.iter_mut() {
 321             if self.monotonic {
 322                 assert_eq!(stmt.id, ast::DUMMY_NODE_ID);
 323                 stmt.id = self.cx.resolver.next_node_id();
 324             }
 325         }
 326     }
 327
 328     fn visit_mod(&mut self, module: &mut ast::Mod) {
 329         noop_visit_mod(module, self);
 330         module.items.retain(|item| match item.kind {
 331             ast::ItemKind::Mac(_) if !self.cx.ecfg.keep_macs => false, // remove macro definitions
 332             _ => true,
 333         });
 334     }
 335
 336     fn visit_mac(&mut self, _mac: &mut ast::Mac) {
 337         // Do nothing.
 338     }
 339 }