]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_expand/src/build.rs
Rollup merge of #93870 - tmiasko:const-precise-live-drops-with-coverage, r=ecstatic...
[rust.git] / compiler / rustc_expand / src / build.rs
1 use crate::base::ExtCtxt;
2
3 use rustc_ast::attr;
4 use rustc_ast::ptr::P;
5 use rustc_ast::{self as ast, AttrVec, BlockCheckMode, Expr, LocalKind, PatKind, UnOp};
6 use rustc_span::source_map::Spanned;
7 use rustc_span::symbol::{kw, sym, Ident, Symbol};
8
9 use rustc_span::Span;
10
11 impl<'a> ExtCtxt<'a> {
12     pub fn path(&self, span: Span, strs: Vec<Ident>) -> ast::Path {
13         self.path_all(span, false, strs, vec![])
14     }
15     pub fn path_ident(&self, span: Span, id: Ident) -> ast::Path {
16         self.path(span, vec![id])
17     }
18     pub fn path_global(&self, span: Span, strs: Vec<Ident>) -> ast::Path {
19         self.path_all(span, true, strs, vec![])
20     }
21     pub fn path_all(
22         &self,
23         span: Span,
24         global: bool,
25         mut idents: Vec<Ident>,
26         args: Vec<ast::GenericArg>,
27     ) -> ast::Path {
28         assert!(!idents.is_empty());
29         let add_root = global && !idents[0].is_path_segment_keyword();
30         let mut segments = Vec::with_capacity(idents.len() + add_root as usize);
31         if add_root {
32             segments.push(ast::PathSegment::path_root(span));
33         }
34         let last_ident = idents.pop().unwrap();
35         segments.extend(
36             idents.into_iter().map(|ident| ast::PathSegment::from_ident(ident.with_span_pos(span))),
37         );
38         let args = if !args.is_empty() {
39             let args = args.into_iter().map(ast::AngleBracketedArg::Arg).collect();
40             ast::AngleBracketedArgs { args, span }.into()
41         } else {
42             None
43         };
44         segments.push(ast::PathSegment {
45             ident: last_ident.with_span_pos(span),
46             id: ast::DUMMY_NODE_ID,
47             args,
48         });
49         ast::Path { span, segments, tokens: None }
50     }
51
52     pub fn ty_mt(&self, ty: P<ast::Ty>, mutbl: ast::Mutability) -> ast::MutTy {
53         ast::MutTy { ty, mutbl }
54     }
55
56     pub fn ty(&self, span: Span, kind: ast::TyKind) -> P<ast::Ty> {
57         P(ast::Ty { id: ast::DUMMY_NODE_ID, span, kind, tokens: None })
58     }
59
60     pub fn ty_path(&self, path: ast::Path) -> P<ast::Ty> {
61         self.ty(path.span, ast::TyKind::Path(None, path))
62     }
63
64     // Might need to take bounds as an argument in the future, if you ever want
65     // to generate a bounded existential trait type.
66     pub fn ty_ident(&self, span: Span, ident: Ident) -> P<ast::Ty> {
67         self.ty_path(self.path_ident(span, ident))
68     }
69
70     pub fn anon_const(&self, span: Span, kind: ast::ExprKind) -> ast::AnonConst {
71         ast::AnonConst {
72             id: ast::DUMMY_NODE_ID,
73             value: P(ast::Expr {
74                 id: ast::DUMMY_NODE_ID,
75                 kind,
76                 span,
77                 attrs: AttrVec::new(),
78                 tokens: None,
79             }),
80         }
81     }
82
83     pub fn const_ident(&self, span: Span, ident: Ident) -> ast::AnonConst {
84         self.anon_const(span, ast::ExprKind::Path(None, self.path_ident(span, ident)))
85     }
86
87     pub fn ty_rptr(
88         &self,
89         span: Span,
90         ty: P<ast::Ty>,
91         lifetime: Option<ast::Lifetime>,
92         mutbl: ast::Mutability,
93     ) -> P<ast::Ty> {
94         self.ty(span, ast::TyKind::Rptr(lifetime, self.ty_mt(ty, mutbl)))
95     }
96
97     pub fn ty_ptr(&self, span: Span, ty: P<ast::Ty>, mutbl: ast::Mutability) -> P<ast::Ty> {
98         self.ty(span, ast::TyKind::Ptr(self.ty_mt(ty, mutbl)))
99     }
100
101     pub fn typaram(
102         &self,
103         span: Span,
104         ident: Ident,
105         attrs: Vec<ast::Attribute>,
106         bounds: ast::GenericBounds,
107         default: Option<P<ast::Ty>>,
108     ) -> ast::GenericParam {
109         ast::GenericParam {
110             ident: ident.with_span_pos(span),
111             id: ast::DUMMY_NODE_ID,
112             attrs: attrs.into(),
113             bounds,
114             kind: ast::GenericParamKind::Type { default },
115             is_placeholder: false,
116         }
117     }
118
119     pub fn trait_ref(&self, path: ast::Path) -> ast::TraitRef {
120         ast::TraitRef { path, ref_id: ast::DUMMY_NODE_ID }
121     }
122
123     pub fn poly_trait_ref(&self, span: Span, path: ast::Path) -> ast::PolyTraitRef {
124         ast::PolyTraitRef {
125             bound_generic_params: Vec::new(),
126             trait_ref: self.trait_ref(path),
127             span,
128         }
129     }
130
131     pub fn trait_bound(&self, path: ast::Path) -> ast::GenericBound {
132         ast::GenericBound::Trait(
133             self.poly_trait_ref(path.span, path),
134             ast::TraitBoundModifier::None,
135         )
136     }
137
138     pub fn lifetime(&self, span: Span, ident: Ident) -> ast::Lifetime {
139         ast::Lifetime { id: ast::DUMMY_NODE_ID, ident: ident.with_span_pos(span) }
140     }
141
142     pub fn stmt_expr(&self, expr: P<ast::Expr>) -> ast::Stmt {
143         ast::Stmt { id: ast::DUMMY_NODE_ID, span: expr.span, kind: ast::StmtKind::Expr(expr) }
144     }
145
146     pub fn stmt_let(&self, sp: Span, mutbl: bool, ident: Ident, ex: P<ast::Expr>) -> ast::Stmt {
147         let pat = if mutbl {
148             let binding_mode = ast::BindingMode::ByValue(ast::Mutability::Mut);
149             self.pat_ident_binding_mode(sp, ident, binding_mode)
150         } else {
151             self.pat_ident(sp, ident)
152         };
153         let local = P(ast::Local {
154             pat,
155             ty: None,
156             id: ast::DUMMY_NODE_ID,
157             kind: LocalKind::Init(ex),
158             span: sp,
159             attrs: AttrVec::new(),
160             tokens: None,
161         });
162         ast::Stmt { id: ast::DUMMY_NODE_ID, kind: ast::StmtKind::Local(local), span: sp }
163     }
164
165     // Generates `let _: Type;`, which is usually used for type assertions.
166     pub fn stmt_let_type_only(&self, span: Span, ty: P<ast::Ty>) -> ast::Stmt {
167         let local = P(ast::Local {
168             pat: self.pat_wild(span),
169             ty: Some(ty),
170             id: ast::DUMMY_NODE_ID,
171             kind: LocalKind::Decl,
172             span,
173             attrs: AttrVec::new(),
174             tokens: None,
175         });
176         ast::Stmt { id: ast::DUMMY_NODE_ID, kind: ast::StmtKind::Local(local), span }
177     }
178
179     pub fn stmt_item(&self, sp: Span, item: P<ast::Item>) -> ast::Stmt {
180         ast::Stmt { id: ast::DUMMY_NODE_ID, kind: ast::StmtKind::Item(item), span: sp }
181     }
182
183     pub fn block_expr(&self, expr: P<ast::Expr>) -> P<ast::Block> {
184         self.block(
185             expr.span,
186             vec![ast::Stmt {
187                 id: ast::DUMMY_NODE_ID,
188                 span: expr.span,
189                 kind: ast::StmtKind::Expr(expr),
190             }],
191         )
192     }
193     pub fn block(&self, span: Span, stmts: Vec<ast::Stmt>) -> P<ast::Block> {
194         P(ast::Block {
195             stmts,
196             id: ast::DUMMY_NODE_ID,
197             rules: BlockCheckMode::Default,
198             span,
199             tokens: None,
200             could_be_bare_literal: false,
201         })
202     }
203
204     pub fn expr(&self, span: Span, kind: ast::ExprKind) -> P<ast::Expr> {
205         P(ast::Expr { id: ast::DUMMY_NODE_ID, kind, span, attrs: AttrVec::new(), tokens: None })
206     }
207
208     pub fn expr_path(&self, path: ast::Path) -> P<ast::Expr> {
209         self.expr(path.span, ast::ExprKind::Path(None, path))
210     }
211
212     pub fn expr_ident(&self, span: Span, id: Ident) -> P<ast::Expr> {
213         self.expr_path(self.path_ident(span, id))
214     }
215     pub fn expr_self(&self, span: Span) -> P<ast::Expr> {
216         self.expr_ident(span, Ident::with_dummy_span(kw::SelfLower))
217     }
218
219     pub fn expr_binary(
220         &self,
221         sp: Span,
222         op: ast::BinOpKind,
223         lhs: P<ast::Expr>,
224         rhs: P<ast::Expr>,
225     ) -> P<ast::Expr> {
226         self.expr(sp, ast::ExprKind::Binary(Spanned { node: op, span: sp }, lhs, rhs))
227     }
228
229     pub fn expr_deref(&self, sp: Span, e: P<ast::Expr>) -> P<ast::Expr> {
230         self.expr(sp, ast::ExprKind::Unary(UnOp::Deref, e))
231     }
232
233     pub fn expr_addr_of(&self, sp: Span, e: P<ast::Expr>) -> P<ast::Expr> {
234         self.expr(sp, ast::ExprKind::AddrOf(ast::BorrowKind::Ref, ast::Mutability::Not, e))
235     }
236
237     pub fn expr_call(
238         &self,
239         span: Span,
240         expr: P<ast::Expr>,
241         args: Vec<P<ast::Expr>>,
242     ) -> P<ast::Expr> {
243         self.expr(span, ast::ExprKind::Call(expr, args))
244     }
245     pub fn expr_call_ident(&self, span: Span, id: Ident, args: Vec<P<ast::Expr>>) -> P<ast::Expr> {
246         self.expr(span, ast::ExprKind::Call(self.expr_ident(span, id), args))
247     }
248     pub fn expr_call_global(
249         &self,
250         sp: Span,
251         fn_path: Vec<Ident>,
252         args: Vec<P<ast::Expr>>,
253     ) -> P<ast::Expr> {
254         let pathexpr = self.expr_path(self.path_global(sp, fn_path));
255         self.expr_call(sp, pathexpr, args)
256     }
257     pub fn expr_block(&self, b: P<ast::Block>) -> P<ast::Expr> {
258         self.expr(b.span, ast::ExprKind::Block(b, None))
259     }
260     pub fn field_imm(&self, span: Span, ident: Ident, e: P<ast::Expr>) -> ast::ExprField {
261         ast::ExprField {
262             ident: ident.with_span_pos(span),
263             expr: e,
264             span,
265             is_shorthand: false,
266             attrs: AttrVec::new(),
267             id: ast::DUMMY_NODE_ID,
268             is_placeholder: false,
269         }
270     }
271     pub fn expr_struct(
272         &self,
273         span: Span,
274         path: ast::Path,
275         fields: Vec<ast::ExprField>,
276     ) -> P<ast::Expr> {
277         self.expr(
278             span,
279             ast::ExprKind::Struct(P(ast::StructExpr {
280                 qself: None,
281                 path,
282                 fields,
283                 rest: ast::StructRest::None,
284             })),
285         )
286     }
287     pub fn expr_struct_ident(
288         &self,
289         span: Span,
290         id: Ident,
291         fields: Vec<ast::ExprField>,
292     ) -> P<ast::Expr> {
293         self.expr_struct(span, self.path_ident(span, id), fields)
294     }
295
296     pub fn expr_lit(&self, span: Span, lit_kind: ast::LitKind) -> P<ast::Expr> {
297         let lit = ast::Lit::from_lit_kind(lit_kind, span);
298         self.expr(span, ast::ExprKind::Lit(lit))
299     }
300     pub fn expr_usize(&self, span: Span, i: usize) -> P<ast::Expr> {
301         self.expr_lit(
302             span,
303             ast::LitKind::Int(i as u128, ast::LitIntType::Unsigned(ast::UintTy::Usize)),
304         )
305     }
306     pub fn expr_u32(&self, sp: Span, u: u32) -> P<ast::Expr> {
307         self.expr_lit(sp, ast::LitKind::Int(u as u128, ast::LitIntType::Unsigned(ast::UintTy::U32)))
308     }
309     pub fn expr_bool(&self, sp: Span, value: bool) -> P<ast::Expr> {
310         self.expr_lit(sp, ast::LitKind::Bool(value))
311     }
312
313     pub fn expr_vec(&self, sp: Span, exprs: Vec<P<ast::Expr>>) -> P<ast::Expr> {
314         self.expr(sp, ast::ExprKind::Array(exprs))
315     }
316     pub fn expr_vec_slice(&self, sp: Span, exprs: Vec<P<ast::Expr>>) -> P<ast::Expr> {
317         self.expr_addr_of(sp, self.expr_vec(sp, exprs))
318     }
319     pub fn expr_str(&self, sp: Span, s: Symbol) -> P<ast::Expr> {
320         self.expr_lit(sp, ast::LitKind::Str(s, ast::StrStyle::Cooked))
321     }
322
323     pub fn expr_cast(&self, sp: Span, expr: P<ast::Expr>, ty: P<ast::Ty>) -> P<ast::Expr> {
324         self.expr(sp, ast::ExprKind::Cast(expr, ty))
325     }
326
327     pub fn expr_some(&self, sp: Span, expr: P<ast::Expr>) -> P<ast::Expr> {
328         let some = self.std_path(&[sym::option, sym::Option, sym::Some]);
329         self.expr_call_global(sp, some, vec![expr])
330     }
331
332     pub fn expr_none(&self, sp: Span) -> P<ast::Expr> {
333         let none = self.std_path(&[sym::option, sym::Option, sym::None]);
334         self.expr_path(self.path_global(sp, none))
335     }
336     pub fn expr_tuple(&self, sp: Span, exprs: Vec<P<ast::Expr>>) -> P<ast::Expr> {
337         self.expr(sp, ast::ExprKind::Tup(exprs))
338     }
339
340     pub fn expr_fail(&self, span: Span, msg: Symbol) -> P<ast::Expr> {
341         self.expr_call_global(
342             span,
343             [sym::std, sym::rt, sym::begin_panic].iter().map(|s| Ident::new(*s, span)).collect(),
344             vec![self.expr_str(span, msg)],
345         )
346     }
347
348     pub fn expr_unreachable(&self, span: Span) -> P<ast::Expr> {
349         self.expr_fail(span, Symbol::intern("internal error: entered unreachable code"))
350     }
351
352     pub fn expr_ok(&self, sp: Span, expr: P<ast::Expr>) -> P<ast::Expr> {
353         let ok = self.std_path(&[sym::result, sym::Result, sym::Ok]);
354         self.expr_call_global(sp, ok, vec![expr])
355     }
356
357     pub fn expr_try(&self, sp: Span, head: P<ast::Expr>) -> P<ast::Expr> {
358         let ok = self.std_path(&[sym::result, sym::Result, sym::Ok]);
359         let ok_path = self.path_global(sp, ok);
360         let err = self.std_path(&[sym::result, sym::Result, sym::Err]);
361         let err_path = self.path_global(sp, err);
362
363         let binding_variable = Ident::new(sym::__try_var, sp);
364         let binding_pat = self.pat_ident(sp, binding_variable);
365         let binding_expr = self.expr_ident(sp, binding_variable);
366
367         // `Ok(__try_var)` pattern
368         let ok_pat = self.pat_tuple_struct(sp, ok_path, vec![binding_pat.clone()]);
369
370         // `Err(__try_var)` (pattern and expression respectively)
371         let err_pat = self.pat_tuple_struct(sp, err_path.clone(), vec![binding_pat]);
372         let err_inner_expr =
373             self.expr_call(sp, self.expr_path(err_path), vec![binding_expr.clone()]);
374         // `return Err(__try_var)`
375         let err_expr = self.expr(sp, ast::ExprKind::Ret(Some(err_inner_expr)));
376
377         // `Ok(__try_var) => __try_var`
378         let ok_arm = self.arm(sp, ok_pat, binding_expr);
379         // `Err(__try_var) => return Err(__try_var)`
380         let err_arm = self.arm(sp, err_pat, err_expr);
381
382         // `match head { Ok() => ..., Err() => ... }`
383         self.expr_match(sp, head, vec![ok_arm, err_arm])
384     }
385
386     pub fn pat(&self, span: Span, kind: PatKind) -> P<ast::Pat> {
387         P(ast::Pat { id: ast::DUMMY_NODE_ID, kind, span, tokens: None })
388     }
389     pub fn pat_wild(&self, span: Span) -> P<ast::Pat> {
390         self.pat(span, PatKind::Wild)
391     }
392     pub fn pat_lit(&self, span: Span, expr: P<ast::Expr>) -> P<ast::Pat> {
393         self.pat(span, PatKind::Lit(expr))
394     }
395     pub fn pat_ident(&self, span: Span, ident: Ident) -> P<ast::Pat> {
396         let binding_mode = ast::BindingMode::ByValue(ast::Mutability::Not);
397         self.pat_ident_binding_mode(span, ident, binding_mode)
398     }
399
400     pub fn pat_ident_binding_mode(
401         &self,
402         span: Span,
403         ident: Ident,
404         bm: ast::BindingMode,
405     ) -> P<ast::Pat> {
406         let pat = PatKind::Ident(bm, ident.with_span_pos(span), None);
407         self.pat(span, pat)
408     }
409     pub fn pat_path(&self, span: Span, path: ast::Path) -> P<ast::Pat> {
410         self.pat(span, PatKind::Path(None, path))
411     }
412     pub fn pat_tuple_struct(
413         &self,
414         span: Span,
415         path: ast::Path,
416         subpats: Vec<P<ast::Pat>>,
417     ) -> P<ast::Pat> {
418         self.pat(span, PatKind::TupleStruct(None, path, subpats))
419     }
420     pub fn pat_struct(
421         &self,
422         span: Span,
423         path: ast::Path,
424         field_pats: Vec<ast::PatField>,
425     ) -> P<ast::Pat> {
426         self.pat(span, PatKind::Struct(None, path, field_pats, false))
427     }
428     pub fn pat_tuple(&self, span: Span, pats: Vec<P<ast::Pat>>) -> P<ast::Pat> {
429         self.pat(span, PatKind::Tuple(pats))
430     }
431
432     pub fn pat_some(&self, span: Span, pat: P<ast::Pat>) -> P<ast::Pat> {
433         let some = self.std_path(&[sym::option, sym::Option, sym::Some]);
434         let path = self.path_global(span, some);
435         self.pat_tuple_struct(span, path, vec![pat])
436     }
437
438     pub fn arm(&self, span: Span, pat: P<ast::Pat>, expr: P<ast::Expr>) -> ast::Arm {
439         ast::Arm {
440             attrs: AttrVec::new(),
441             pat,
442             guard: None,
443             body: expr,
444             span,
445             id: ast::DUMMY_NODE_ID,
446             is_placeholder: false,
447         }
448     }
449
450     pub fn arm_unreachable(&self, span: Span) -> ast::Arm {
451         self.arm(span, self.pat_wild(span), self.expr_unreachable(span))
452     }
453
454     pub fn expr_match(&self, span: Span, arg: P<ast::Expr>, arms: Vec<ast::Arm>) -> P<Expr> {
455         self.expr(span, ast::ExprKind::Match(arg, arms))
456     }
457
458     pub fn expr_if(
459         &self,
460         span: Span,
461         cond: P<ast::Expr>,
462         then: P<ast::Expr>,
463         els: Option<P<ast::Expr>>,
464     ) -> P<ast::Expr> {
465         let els = els.map(|x| self.expr_block(self.block_expr(x)));
466         self.expr(span, ast::ExprKind::If(cond, self.block_expr(then), els))
467     }
468
469     pub fn lambda(&self, span: Span, ids: Vec<Ident>, body: P<ast::Expr>) -> P<ast::Expr> {
470         let fn_decl = self.fn_decl(
471             ids.iter().map(|id| self.param(span, *id, self.ty(span, ast::TyKind::Infer))).collect(),
472             ast::FnRetTy::Default(span),
473         );
474
475         // FIXME -- We are using `span` as the span of the `|...|`
476         // part of the lambda, but it probably (maybe?) corresponds to
477         // the entire lambda body. Probably we should extend the API
478         // here, but that's not entirely clear.
479         self.expr(
480             span,
481             ast::ExprKind::Closure(
482                 ast::CaptureBy::Ref,
483                 ast::Async::No,
484                 ast::Movability::Movable,
485                 fn_decl,
486                 body,
487                 span,
488             ),
489         )
490     }
491
492     pub fn lambda0(&self, span: Span, body: P<ast::Expr>) -> P<ast::Expr> {
493         self.lambda(span, Vec::new(), body)
494     }
495
496     pub fn lambda1(&self, span: Span, body: P<ast::Expr>, ident: Ident) -> P<ast::Expr> {
497         self.lambda(span, vec![ident], body)
498     }
499
500     pub fn lambda_stmts_1(&self, span: Span, stmts: Vec<ast::Stmt>, ident: Ident) -> P<ast::Expr> {
501         self.lambda1(span, self.expr_block(self.block(span, stmts)), ident)
502     }
503
504     pub fn param(&self, span: Span, ident: Ident, ty: P<ast::Ty>) -> ast::Param {
505         let arg_pat = self.pat_ident(span, ident);
506         ast::Param {
507             attrs: AttrVec::default(),
508             id: ast::DUMMY_NODE_ID,
509             pat: arg_pat,
510             span,
511             ty,
512             is_placeholder: false,
513         }
514     }
515
516     // FIXME: unused `self`
517     pub fn fn_decl(&self, inputs: Vec<ast::Param>, output: ast::FnRetTy) -> P<ast::FnDecl> {
518         P(ast::FnDecl { inputs, output })
519     }
520
521     pub fn item(
522         &self,
523         span: Span,
524         name: Ident,
525         attrs: Vec<ast::Attribute>,
526         kind: ast::ItemKind,
527     ) -> P<ast::Item> {
528         // FIXME: Would be nice if our generated code didn't violate
529         // Rust coding conventions
530         P(ast::Item {
531             ident: name,
532             attrs,
533             id: ast::DUMMY_NODE_ID,
534             kind,
535             vis: ast::Visibility {
536                 span: span.shrink_to_lo(),
537                 kind: ast::VisibilityKind::Inherited,
538                 tokens: None,
539             },
540             span,
541             tokens: None,
542         })
543     }
544
545     pub fn item_static(
546         &self,
547         span: Span,
548         name: Ident,
549         ty: P<ast::Ty>,
550         mutbl: ast::Mutability,
551         expr: P<ast::Expr>,
552     ) -> P<ast::Item> {
553         self.item(span, name, Vec::new(), ast::ItemKind::Static(ty, mutbl, Some(expr)))
554     }
555
556     pub fn item_const(
557         &self,
558         span: Span,
559         name: Ident,
560         ty: P<ast::Ty>,
561         expr: P<ast::Expr>,
562     ) -> P<ast::Item> {
563         let def = ast::Defaultness::Final;
564         self.item(span, name, Vec::new(), ast::ItemKind::Const(def, ty, Some(expr)))
565     }
566
567     pub fn attribute(&self, mi: ast::MetaItem) -> ast::Attribute {
568         attr::mk_attr_outer(mi)
569     }
570
571     pub fn meta_word(&self, sp: Span, w: Symbol) -> ast::MetaItem {
572         attr::mk_word_item(Ident::new(w, sp))
573     }
574 }