1 use crate::base::ExtCtxt;
4 use rustc_ast::{self as ast, AttrVec, BlockCheckMode, Expr, LocalKind, PatKind, UnOp};
5 use rustc_data_structures::sync::Lrc;
6 use rustc_span::source_map::Spanned;
7 use rustc_span::symbol::{kw, sym, Ident, Symbol};
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![])
15 pub fn path_ident(&self, span: Span, id: Ident) -> ast::Path {
16 self.path(span, vec![id])
18 pub fn path_global(&self, span: Span, strs: Vec<Ident>) -> ast::Path {
19 self.path_all(span, true, strs, vec![])
25 mut idents: Vec<Ident>,
26 args: Vec<ast::GenericArg>,
28 assert!(!idents.is_empty());
29 let add_root = global && !idents[0].is_path_segment_keyword();
30 let mut segments = ThinVec::with_capacity(idents.len() + add_root as usize);
32 segments.push(ast::PathSegment::path_root(span));
34 let last_ident = idents.pop().unwrap();
36 idents.into_iter().map(|ident| ast::PathSegment::from_ident(ident.with_span_pos(span))),
38 let args = if !args.is_empty() {
39 let args = args.into_iter().map(ast::AngleBracketedArg::Arg).collect();
40 ast::AngleBracketedArgs { args, span }.into()
44 segments.push(ast::PathSegment {
45 ident: last_ident.with_span_pos(span),
46 id: ast::DUMMY_NODE_ID,
49 ast::Path { span, segments, tokens: None }
52 pub fn ty_mt(&self, ty: P<ast::Ty>, mutbl: ast::Mutability) -> ast::MutTy {
53 ast::MutTy { ty, mutbl }
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 })
60 pub fn ty_infer(&self, span: Span) -> P<ast::Ty> {
61 self.ty(span, ast::TyKind::Infer)
64 pub fn ty_path(&self, path: ast::Path) -> P<ast::Ty> {
65 self.ty(path.span, ast::TyKind::Path(None, path))
68 // Might need to take bounds as an argument in the future, if you ever want
69 // to generate a bounded existential trait type.
70 pub fn ty_ident(&self, span: Span, ident: Ident) -> P<ast::Ty> {
71 self.ty_path(self.path_ident(span, ident))
74 pub fn anon_const(&self, span: Span, kind: ast::ExprKind) -> ast::AnonConst {
76 id: ast::DUMMY_NODE_ID,
78 id: ast::DUMMY_NODE_ID,
81 attrs: AttrVec::new(),
87 pub fn const_ident(&self, span: Span, ident: Ident) -> ast::AnonConst {
88 self.anon_const(span, ast::ExprKind::Path(None, self.path_ident(span, ident)))
95 lifetime: Option<ast::Lifetime>,
96 mutbl: ast::Mutability,
98 self.ty(span, ast::TyKind::Rptr(lifetime, self.ty_mt(ty, mutbl)))
101 pub fn ty_ptr(&self, span: Span, ty: P<ast::Ty>, mutbl: ast::Mutability) -> P<ast::Ty> {
102 self.ty(span, ast::TyKind::Ptr(self.ty_mt(ty, mutbl)))
109 bounds: ast::GenericBounds,
110 default: Option<P<ast::Ty>>,
111 ) -> ast::GenericParam {
113 ident: ident.with_span_pos(span),
114 id: ast::DUMMY_NODE_ID,
115 attrs: AttrVec::new(),
117 kind: ast::GenericParamKind::Type { default },
118 is_placeholder: false,
123 pub fn trait_ref(&self, path: ast::Path) -> ast::TraitRef {
124 ast::TraitRef { path, ref_id: ast::DUMMY_NODE_ID }
127 pub fn poly_trait_ref(&self, span: Span, path: ast::Path) -> ast::PolyTraitRef {
129 bound_generic_params: Vec::new(),
130 trait_ref: self.trait_ref(path),
135 pub fn trait_bound(&self, path: ast::Path) -> ast::GenericBound {
136 ast::GenericBound::Trait(
137 self.poly_trait_ref(path.span, path),
138 ast::TraitBoundModifier::None,
142 pub fn lifetime(&self, span: Span, ident: Ident) -> ast::Lifetime {
143 ast::Lifetime { id: ast::DUMMY_NODE_ID, ident: ident.with_span_pos(span) }
146 pub fn lifetime_static(&self, span: Span) -> ast::Lifetime {
147 self.lifetime(span, Ident::new(kw::StaticLifetime, span))
150 pub fn stmt_expr(&self, expr: P<ast::Expr>) -> ast::Stmt {
151 ast::Stmt { id: ast::DUMMY_NODE_ID, span: expr.span, kind: ast::StmtKind::Expr(expr) }
154 pub fn stmt_let_pat(&self, sp: Span, pat: P<ast::Pat>, ex: P<ast::Expr>) -> ast::Stmt {
155 let local = P(ast::Local {
158 id: ast::DUMMY_NODE_ID,
159 kind: LocalKind::Init(ex),
161 attrs: AttrVec::new(),
164 self.stmt_local(local, sp)
167 pub fn stmt_let(&self, sp: Span, mutbl: bool, ident: Ident, ex: P<ast::Expr>) -> ast::Stmt {
168 self.stmt_let_ty(sp, mutbl, ident, None, ex)
176 ty: Option<P<ast::Ty>>,
180 self.pat_ident_binding_mode(sp, ident, ast::BindingAnnotation::MUT)
182 self.pat_ident(sp, ident)
184 let local = P(ast::Local {
187 id: ast::DUMMY_NODE_ID,
188 kind: LocalKind::Init(ex),
190 attrs: AttrVec::new(),
193 self.stmt_local(local, sp)
196 // Generates `let _: Type;`, which is usually used for type assertions.
197 pub fn stmt_let_type_only(&self, span: Span, ty: P<ast::Ty>) -> ast::Stmt {
198 let local = P(ast::Local {
199 pat: self.pat_wild(span),
201 id: ast::DUMMY_NODE_ID,
202 kind: LocalKind::Decl,
204 attrs: AttrVec::new(),
207 self.stmt_local(local, span)
210 pub fn stmt_local(&self, local: P<ast::Local>, span: Span) -> ast::Stmt {
211 ast::Stmt { id: ast::DUMMY_NODE_ID, kind: ast::StmtKind::Local(local), span }
214 pub fn stmt_item(&self, sp: Span, item: P<ast::Item>) -> ast::Stmt {
215 ast::Stmt { id: ast::DUMMY_NODE_ID, kind: ast::StmtKind::Item(item), span: sp }
218 pub fn block_expr(&self, expr: P<ast::Expr>) -> P<ast::Block> {
222 id: ast::DUMMY_NODE_ID,
224 kind: ast::StmtKind::Expr(expr),
228 pub fn block(&self, span: Span, stmts: Vec<ast::Stmt>) -> P<ast::Block> {
231 id: ast::DUMMY_NODE_ID,
232 rules: BlockCheckMode::Default,
235 could_be_bare_literal: false,
239 pub fn expr(&self, span: Span, kind: ast::ExprKind) -> P<ast::Expr> {
240 P(ast::Expr { id: ast::DUMMY_NODE_ID, kind, span, attrs: AttrVec::new(), tokens: None })
243 pub fn expr_path(&self, path: ast::Path) -> P<ast::Expr> {
244 self.expr(path.span, ast::ExprKind::Path(None, path))
247 pub fn expr_ident(&self, span: Span, id: Ident) -> P<ast::Expr> {
248 self.expr_path(self.path_ident(span, id))
250 pub fn expr_self(&self, span: Span) -> P<ast::Expr> {
251 self.expr_ident(span, Ident::with_dummy_span(kw::SelfLower))
254 pub fn expr_field(&self, span: Span, expr: P<Expr>, field: Ident) -> P<ast::Expr> {
255 self.expr(span, ast::ExprKind::Field(expr, field))
265 self.expr(sp, ast::ExprKind::Binary(Spanned { node: op, span: sp }, lhs, rhs))
268 pub fn expr_deref(&self, sp: Span, e: P<ast::Expr>) -> P<ast::Expr> {
269 self.expr(sp, ast::ExprKind::Unary(UnOp::Deref, e))
272 pub fn expr_addr_of(&self, sp: Span, e: P<ast::Expr>) -> P<ast::Expr> {
273 self.expr(sp, ast::ExprKind::AddrOf(ast::BorrowKind::Ref, ast::Mutability::Not, e))
280 args: Vec<P<ast::Expr>>,
282 self.expr(span, ast::ExprKind::Call(expr, args))
284 pub fn expr_call_ident(&self, span: Span, id: Ident, args: Vec<P<ast::Expr>>) -> P<ast::Expr> {
285 self.expr(span, ast::ExprKind::Call(self.expr_ident(span, id), args))
287 pub fn expr_call_global(
291 args: Vec<P<ast::Expr>>,
293 let pathexpr = self.expr_path(self.path_global(sp, fn_path));
294 self.expr_call(sp, pathexpr, args)
296 pub fn expr_block(&self, b: P<ast::Block>) -> P<ast::Expr> {
297 self.expr(b.span, ast::ExprKind::Block(b, None))
299 pub fn field_imm(&self, span: Span, ident: Ident, e: P<ast::Expr>) -> ast::ExprField {
301 ident: ident.with_span_pos(span),
305 attrs: AttrVec::new(),
306 id: ast::DUMMY_NODE_ID,
307 is_placeholder: false,
314 fields: Vec<ast::ExprField>,
318 ast::ExprKind::Struct(P(ast::StructExpr {
322 rest: ast::StructRest::None,
326 pub fn expr_struct_ident(
330 fields: Vec<ast::ExprField>,
332 self.expr_struct(span, self.path_ident(span, id), fields)
335 fn expr_lit(&self, span: Span, lit_kind: ast::LitKind) -> P<ast::Expr> {
336 let token_lit = lit_kind.to_token_lit();
337 self.expr(span, ast::ExprKind::Lit(token_lit))
340 pub fn expr_usize(&self, span: Span, i: usize) -> P<ast::Expr> {
343 ast::LitKind::Int(i as u128, ast::LitIntType::Unsigned(ast::UintTy::Usize)),
347 pub fn expr_u32(&self, sp: Span, u: u32) -> P<ast::Expr> {
348 self.expr_lit(sp, ast::LitKind::Int(u as u128, ast::LitIntType::Unsigned(ast::UintTy::U32)))
351 pub fn expr_bool(&self, sp: Span, value: bool) -> P<ast::Expr> {
352 self.expr_lit(sp, ast::LitKind::Bool(value))
355 pub fn expr_str(&self, sp: Span, s: Symbol) -> P<ast::Expr> {
356 self.expr_lit(sp, ast::LitKind::Str(s, ast::StrStyle::Cooked))
359 pub fn expr_char(&self, sp: Span, ch: char) -> P<ast::Expr> {
360 self.expr_lit(sp, ast::LitKind::Char(ch))
363 pub fn expr_byte_str(&self, sp: Span, bytes: Vec<u8>) -> P<ast::Expr> {
364 self.expr_lit(sp, ast::LitKind::ByteStr(Lrc::from(bytes)))
367 /// `[expr1, expr2, ...]`
368 pub fn expr_array(&self, sp: Span, exprs: Vec<P<ast::Expr>>) -> P<ast::Expr> {
369 self.expr(sp, ast::ExprKind::Array(exprs))
372 /// `&[expr1, expr2, ...]`
373 pub fn expr_array_ref(&self, sp: Span, exprs: Vec<P<ast::Expr>>) -> P<ast::Expr> {
374 self.expr_addr_of(sp, self.expr_array(sp, exprs))
377 pub fn expr_cast(&self, sp: Span, expr: P<ast::Expr>, ty: P<ast::Ty>) -> P<ast::Expr> {
378 self.expr(sp, ast::ExprKind::Cast(expr, ty))
381 pub fn expr_some(&self, sp: Span, expr: P<ast::Expr>) -> P<ast::Expr> {
382 let some = self.std_path(&[sym::option, sym::Option, sym::Some]);
383 self.expr_call_global(sp, some, vec![expr])
386 pub fn expr_none(&self, sp: Span) -> P<ast::Expr> {
387 let none = self.std_path(&[sym::option, sym::Option, sym::None]);
388 self.expr_path(self.path_global(sp, none))
390 pub fn expr_tuple(&self, sp: Span, exprs: Vec<P<ast::Expr>>) -> P<ast::Expr> {
391 self.expr(sp, ast::ExprKind::Tup(exprs))
394 pub fn expr_fail(&self, span: Span, msg: Symbol) -> P<ast::Expr> {
395 self.expr_call_global(
397 [sym::std, sym::rt, sym::begin_panic].iter().map(|s| Ident::new(*s, span)).collect(),
398 vec![self.expr_str(span, msg)],
402 pub fn expr_unreachable(&self, span: Span) -> P<ast::Expr> {
403 self.expr_fail(span, Symbol::intern("internal error: entered unreachable code"))
406 pub fn expr_ok(&self, sp: Span, expr: P<ast::Expr>) -> P<ast::Expr> {
407 let ok = self.std_path(&[sym::result, sym::Result, sym::Ok]);
408 self.expr_call_global(sp, ok, vec![expr])
411 pub fn expr_try(&self, sp: Span, head: P<ast::Expr>) -> P<ast::Expr> {
412 let ok = self.std_path(&[sym::result, sym::Result, sym::Ok]);
413 let ok_path = self.path_global(sp, ok);
414 let err = self.std_path(&[sym::result, sym::Result, sym::Err]);
415 let err_path = self.path_global(sp, err);
417 let binding_variable = Ident::new(sym::__try_var, sp);
418 let binding_pat = self.pat_ident(sp, binding_variable);
419 let binding_expr = self.expr_ident(sp, binding_variable);
421 // `Ok(__try_var)` pattern
422 let ok_pat = self.pat_tuple_struct(sp, ok_path, vec![binding_pat.clone()]);
424 // `Err(__try_var)` (pattern and expression respectively)
425 let err_pat = self.pat_tuple_struct(sp, err_path.clone(), vec![binding_pat]);
427 self.expr_call(sp, self.expr_path(err_path), vec![binding_expr.clone()]);
428 // `return Err(__try_var)`
429 let err_expr = self.expr(sp, ast::ExprKind::Ret(Some(err_inner_expr)));
431 // `Ok(__try_var) => __try_var`
432 let ok_arm = self.arm(sp, ok_pat, binding_expr);
433 // `Err(__try_var) => return Err(__try_var)`
434 let err_arm = self.arm(sp, err_pat, err_expr);
436 // `match head { Ok() => ..., Err() => ... }`
437 self.expr_match(sp, head, vec![ok_arm, err_arm])
440 pub fn pat(&self, span: Span, kind: PatKind) -> P<ast::Pat> {
441 P(ast::Pat { id: ast::DUMMY_NODE_ID, kind, span, tokens: None })
443 pub fn pat_wild(&self, span: Span) -> P<ast::Pat> {
444 self.pat(span, PatKind::Wild)
446 pub fn pat_lit(&self, span: Span, expr: P<ast::Expr>) -> P<ast::Pat> {
447 self.pat(span, PatKind::Lit(expr))
449 pub fn pat_ident(&self, span: Span, ident: Ident) -> P<ast::Pat> {
450 self.pat_ident_binding_mode(span, ident, ast::BindingAnnotation::NONE)
453 pub fn pat_ident_binding_mode(
457 ann: ast::BindingAnnotation,
459 let pat = PatKind::Ident(ann, ident.with_span_pos(span), None);
462 pub fn pat_path(&self, span: Span, path: ast::Path) -> P<ast::Pat> {
463 self.pat(span, PatKind::Path(None, path))
465 pub fn pat_tuple_struct(
469 subpats: Vec<P<ast::Pat>>,
471 self.pat(span, PatKind::TupleStruct(None, path, subpats))
477 field_pats: Vec<ast::PatField>,
479 self.pat(span, PatKind::Struct(None, path, field_pats, false))
481 pub fn pat_tuple(&self, span: Span, pats: Vec<P<ast::Pat>>) -> P<ast::Pat> {
482 self.pat(span, PatKind::Tuple(pats))
485 pub fn pat_some(&self, span: Span, pat: P<ast::Pat>) -> P<ast::Pat> {
486 let some = self.std_path(&[sym::option, sym::Option, sym::Some]);
487 let path = self.path_global(span, some);
488 self.pat_tuple_struct(span, path, vec![pat])
491 pub fn arm(&self, span: Span, pat: P<ast::Pat>, expr: P<ast::Expr>) -> ast::Arm {
493 attrs: AttrVec::new(),
498 id: ast::DUMMY_NODE_ID,
499 is_placeholder: false,
503 pub fn arm_unreachable(&self, span: Span) -> ast::Arm {
504 self.arm(span, self.pat_wild(span), self.expr_unreachable(span))
507 pub fn expr_match(&self, span: Span, arg: P<ast::Expr>, arms: Vec<ast::Arm>) -> P<Expr> {
508 self.expr(span, ast::ExprKind::Match(arg, arms))
516 els: Option<P<ast::Expr>>,
518 let els = els.map(|x| self.expr_block(self.block_expr(x)));
519 self.expr(span, ast::ExprKind::If(cond, self.block_expr(then), els))
522 pub fn lambda(&self, span: Span, ids: Vec<Ident>, body: P<ast::Expr>) -> P<ast::Expr> {
523 let fn_decl = self.fn_decl(
524 ids.iter().map(|id| self.param(span, *id, self.ty(span, ast::TyKind::Infer))).collect(),
525 ast::FnRetTy::Default(span),
528 // FIXME -- We are using `span` as the span of the `|...|`
529 // part of the lambda, but it probably (maybe?) corresponds to
530 // the entire lambda body. Probably we should extend the API
531 // here, but that's not entirely clear.
534 ast::ExprKind::Closure(Box::new(ast::Closure {
535 binder: ast::ClosureBinder::NotPresent,
536 capture_clause: ast::CaptureBy::Ref,
537 asyncness: ast::Async::No,
538 movability: ast::Movability::Movable,
546 pub fn lambda0(&self, span: Span, body: P<ast::Expr>) -> P<ast::Expr> {
547 self.lambda(span, Vec::new(), body)
550 pub fn lambda1(&self, span: Span, body: P<ast::Expr>, ident: Ident) -> P<ast::Expr> {
551 self.lambda(span, vec![ident], body)
554 pub fn lambda_stmts_1(&self, span: Span, stmts: Vec<ast::Stmt>, ident: Ident) -> P<ast::Expr> {
555 self.lambda1(span, self.expr_block(self.block(span, stmts)), ident)
558 pub fn param(&self, span: Span, ident: Ident, ty: P<ast::Ty>) -> ast::Param {
559 let arg_pat = self.pat_ident(span, ident);
561 attrs: AttrVec::default(),
562 id: ast::DUMMY_NODE_ID,
566 is_placeholder: false,
570 // `self` is unused but keep it as method for the convenience use.
571 pub fn fn_decl(&self, inputs: Vec<ast::Param>, output: ast::FnRetTy) -> P<ast::FnDecl> {
572 P(ast::FnDecl { inputs, output })
582 // FIXME: Would be nice if our generated code didn't violate
583 // Rust coding conventions
587 id: ast::DUMMY_NODE_ID,
589 vis: ast::Visibility {
590 span: span.shrink_to_lo(),
591 kind: ast::VisibilityKind::Inherited,
604 mutbl: ast::Mutability,
607 self.item(span, name, AttrVec::new(), ast::ItemKind::Static(ty, mutbl, Some(expr)))
617 let def = ast::Defaultness::Final;
618 self.item(span, name, AttrVec::new(), ast::ItemKind::Const(def, ty, Some(expr)))
621 pub fn attribute(&self, mi: ast::MetaItem) -> ast::Attribute {
622 attr::mk_attr_outer(&self.sess.parse_sess.attr_id_generator, mi)
625 pub fn meta_word(&self, sp: Span, w: Symbol) -> ast::MetaItem {
626 attr::mk_word_item(Ident::new(w, sp))