src/librustc_expand/placeholders.rs

   1 use crate::base::ExtCtxt;
   2 use crate::expand::{AstFragment, AstFragmentKind};
   3
   4 use rustc_span::source_map::{dummy_spanned, DUMMY_SP};
   5 use syntax::ast;
   6 use syntax::mut_visit::*;
   7 use syntax::ptr::P;
   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 generics = ast::Generics::default();
  29     let vis = vis.unwrap_or_else(|| dummy_spanned(ast::VisibilityKind::Inherited));
  30     let span = DUMMY_SP;
  31     let expr_placeholder = || {
  32         P(ast::Expr {
  33             id,
  34             span,
  35             attrs: ast::AttrVec::new(),
  36             kind: ast::ExprKind::Mac(mac_placeholder()),
  37         })
  38     };
  39     let ty = || P(ast::Ty { id, kind: ast::TyKind::Mac(mac_placeholder()), span });
  40     let pat = || P(ast::Pat { id, kind: ast::PatKind::Mac(mac_placeholder()), span });
  41
  42     match kind {
  43         AstFragmentKind::Expr => AstFragment::Expr(expr_placeholder()),
  44         AstFragmentKind::OptExpr => AstFragment::OptExpr(Some(expr_placeholder())),
  45         AstFragmentKind::Items => AstFragment::Items(smallvec![P(ast::Item {
  46             id,
  47             span,
  48             ident,
  49             vis,
  50             attrs,
  51             kind: ast::ItemKind::Mac(mac_placeholder()),
  52             tokens: None,
  53         })]),
  54         AstFragmentKind::TraitItems => AstFragment::TraitItems(smallvec![ast::AssocItem {
  55             id,
  56             span,
  57             ident,
  58             vis,
  59             attrs,
  60             generics,
  61             kind: ast::AssocItemKind::Macro(mac_placeholder()),
  62             defaultness: ast::Defaultness::Final,
  63             tokens: None,
  64         }]),
  65         AstFragmentKind::ImplItems => AstFragment::ImplItems(smallvec![ast::AssocItem {
  66             id,
  67             span,
  68             ident,
  69             vis,
  70             attrs,
  71             generics,
  72             kind: ast::AssocItemKind::Macro(mac_placeholder()),
  73             defaultness: ast::Defaultness::Final,
  74             tokens: None,
  75         }]),
  76         AstFragmentKind::ForeignItems => AstFragment::ForeignItems(smallvec![ast::ForeignItem {
  77             id,
  78             span,
  79             ident,
  80             vis,
  81             attrs,
  82             kind: ast::ForeignItemKind::Macro(mac_placeholder()),
  83             tokens: None,
  84         }]),
  85         AstFragmentKind::Pat => {
  86             AstFragment::Pat(P(ast::Pat { id, span, kind: ast::PatKind::Mac(mac_placeholder()) }))
  87         }
  88         AstFragmentKind::Ty => {
  89             AstFragment::Ty(P(ast::Ty { id, span, kind: ast::TyKind::Mac(mac_placeholder()) }))
  90         }
  91         AstFragmentKind::Stmts => AstFragment::Stmts(smallvec![{
  92             let mac = P((mac_placeholder(), ast::MacStmtStyle::Braces, ast::AttrVec::new()));
  93             ast::Stmt { id, span, kind: ast::StmtKind::Mac(mac) }
  94         }]),
  95         AstFragmentKind::Arms => AstFragment::Arms(smallvec![ast::Arm {
  96             attrs: Default::default(),
  97             body: expr_placeholder(),
  98             guard: None,
  99             id,
 100             pat: pat(),
 101             span,
 102             is_placeholder: true,
 103         }]),
 104         AstFragmentKind::Fields => AstFragment::Fields(smallvec![ast::Field {
 105             attrs: Default::default(),
 106             expr: expr_placeholder(),
 107             id,
 108             ident,
 109             is_shorthand: false,
 110             span,
 111             is_placeholder: true,
 112         }]),
 113         AstFragmentKind::FieldPats => AstFragment::FieldPats(smallvec![ast::FieldPat {
 114             attrs: Default::default(),
 115             id,
 116             ident,
 117             is_shorthand: false,
 118             pat: pat(),
 119             span,
 120             is_placeholder: true,
 121         }]),
 122         AstFragmentKind::GenericParams => AstFragment::GenericParams(smallvec![{
 123             ast::GenericParam {
 124                 attrs: Default::default(),
 125                 bounds: Default::default(),
 126                 id,
 127                 ident,
 128                 is_placeholder: true,
 129                 kind: ast::GenericParamKind::Lifetime,
 130             }
 131         }]),
 132         AstFragmentKind::Params => AstFragment::Params(smallvec![ast::Param {
 133             attrs: Default::default(),
 134             id,
 135             pat: pat(),
 136             span,
 137             ty: ty(),
 138             is_placeholder: true,
 139         }]),
 140         AstFragmentKind::StructFields => AstFragment::StructFields(smallvec![ast::StructField {
 141             attrs: Default::default(),
 142             id,
 143             ident: None,
 144             span,
 145             ty: ty(),
 146             vis,
 147             is_placeholder: true,
 148         }]),
 149         AstFragmentKind::Variants => AstFragment::Variants(smallvec![ast::Variant {
 150             attrs: Default::default(),
 151             data: ast::VariantData::Struct(Default::default(), false),
 152             disr_expr: None,
 153             id,
 154             ident,
 155             span,
 156             vis,
 157             is_placeholder: true,
 158         }]),
 159     }
 160 }
 161
 162 pub struct PlaceholderExpander<'a, 'b> {
 163     expanded_fragments: FxHashMap<ast::NodeId, AstFragment>,
 164     cx: &'a mut ExtCtxt<'b>,
 165     monotonic: bool,
 166 }
 167
 168 impl<'a, 'b> PlaceholderExpander<'a, 'b> {
 169     pub fn new(cx: &'a mut ExtCtxt<'b>, monotonic: bool) -> Self {
 170         PlaceholderExpander { cx, expanded_fragments: FxHashMap::default(), monotonic }
 171     }
 172
 173     pub fn add(&mut self, id: ast::NodeId, mut fragment: AstFragment) {
 174         fragment.mut_visit_with(self);
 175         self.expanded_fragments.insert(id, fragment);
 176     }
 177
 178     fn remove(&mut self, id: ast::NodeId) -> AstFragment {
 179         self.expanded_fragments.remove(&id).unwrap()
 180     }
 181 }
 182
 183 impl<'a, 'b> MutVisitor for PlaceholderExpander<'a, 'b> {
 184     fn flat_map_arm(&mut self, arm: ast::Arm) -> SmallVec<[ast::Arm; 1]> {
 185         if arm.is_placeholder {
 186             self.remove(arm.id).make_arms()
 187         } else {
 188             noop_flat_map_arm(arm, self)
 189         }
 190     }
 191
 192     fn flat_map_field(&mut self, field: ast::Field) -> SmallVec<[ast::Field; 1]> {
 193         if field.is_placeholder {
 194             self.remove(field.id).make_fields()
 195         } else {
 196             noop_flat_map_field(field, self)
 197         }
 198     }
 199
 200     fn flat_map_field_pattern(&mut self, fp: ast::FieldPat) -> SmallVec<[ast::FieldPat; 1]> {
 201         if fp.is_placeholder {
 202             self.remove(fp.id).make_field_patterns()
 203         } else {
 204             noop_flat_map_field_pattern(fp, self)
 205         }
 206     }
 207
 208     fn flat_map_generic_param(
 209         &mut self,
 210         param: ast::GenericParam,
 211     ) -> SmallVec<[ast::GenericParam; 1]> {
 212         if param.is_placeholder {
 213             self.remove(param.id).make_generic_params()
 214         } else {
 215             noop_flat_map_generic_param(param, self)
 216         }
 217     }
 218
 219     fn flat_map_param(&mut self, p: ast::Param) -> SmallVec<[ast::Param; 1]> {
 220         if p.is_placeholder {
 221             self.remove(p.id).make_params()
 222         } else {
 223             noop_flat_map_param(p, self)
 224         }
 225     }
 226
 227     fn flat_map_struct_field(&mut self, sf: ast::StructField) -> SmallVec<[ast::StructField; 1]> {
 228         if sf.is_placeholder {
 229             self.remove(sf.id).make_struct_fields()
 230         } else {
 231             noop_flat_map_struct_field(sf, self)
 232         }
 233     }
 234
 235     fn flat_map_variant(&mut self, variant: ast::Variant) -> SmallVec<[ast::Variant; 1]> {
 236         if variant.is_placeholder {
 237             self.remove(variant.id).make_variants()
 238         } else {
 239             noop_flat_map_variant(variant, self)
 240         }
 241     }
 242
 243     fn flat_map_item(&mut self, item: P<ast::Item>) -> SmallVec<[P<ast::Item>; 1]> {
 244         match item.kind {
 245             ast::ItemKind::Mac(_) => return self.remove(item.id).make_items(),
 246             ast::ItemKind::MacroDef(_) => return smallvec![item],
 247             _ => {}
 248         }
 249
 250         noop_flat_map_item(item, self)
 251     }
 252
 253     fn flat_map_trait_item(&mut self, item: ast::AssocItem) -> SmallVec<[ast::AssocItem; 1]> {
 254         match item.kind {
 255             ast::AssocItemKind::Macro(_) => self.remove(item.id).make_trait_items(),
 256             _ => noop_flat_map_assoc_item(item, self),
 257         }
 258     }
 259
 260     fn flat_map_impl_item(&mut self, item: ast::AssocItem) -> SmallVec<[ast::AssocItem; 1]> {
 261         match item.kind {
 262             ast::AssocItemKind::Macro(_) => self.remove(item.id).make_impl_items(),
 263             _ => noop_flat_map_assoc_item(item, self),
 264         }
 265     }
 266
 267     fn flat_map_foreign_item(&mut self, item: ast::ForeignItem) -> SmallVec<[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 }