1 use crate::base::ExtCtxt;
3 use rustc_ast::{self as ast, AttrVec, BlockCheckMode, Expr, LocalKind, PatKind, UnOp};
4 use rustc_ast::{attr, token, util::literal};
5 use rustc_span::source_map::Spanned;
6 use rustc_span::symbol::{kw, sym, Ident, Symbol};
10 impl<'a> ExtCtxt<'a> {
11 pub fn path(&self, span: Span, strs: Vec<Ident>) -> ast::Path {
12 self.path_all(span, false, strs, vec![])
14 pub fn path_ident(&self, span: Span, id: Ident) -> ast::Path {
15 self.path(span, vec![id])
17 pub fn path_global(&self, span: Span, strs: Vec<Ident>) -> ast::Path {
18 self.path_all(span, true, strs, vec![])
24 mut idents: Vec<Ident>,
25 args: Vec<ast::GenericArg>,
27 assert!(!idents.is_empty());
28 let add_root = global && !idents[0].is_path_segment_keyword();
29 let mut segments = ThinVec::with_capacity(idents.len() + add_root as usize);
31 segments.push(ast::PathSegment::path_root(span));
33 let last_ident = idents.pop().unwrap();
35 idents.into_iter().map(|ident| ast::PathSegment::from_ident(ident.with_span_pos(span))),
37 let args = if !args.is_empty() {
38 let args = args.into_iter().map(ast::AngleBracketedArg::Arg).collect();
39 ast::AngleBracketedArgs { args, span }.into()
43 segments.push(ast::PathSegment {
44 ident: last_ident.with_span_pos(span),
45 id: ast::DUMMY_NODE_ID,
48 ast::Path { span, segments, tokens: None }
51 pub fn ty_mt(&self, ty: P<ast::Ty>, mutbl: ast::Mutability) -> ast::MutTy {
52 ast::MutTy { ty, mutbl }
55 pub fn ty(&self, span: Span, kind: ast::TyKind) -> P<ast::Ty> {
56 P(ast::Ty { id: ast::DUMMY_NODE_ID, span, kind, tokens: None })
59 pub fn ty_infer(&self, span: Span) -> P<ast::Ty> {
60 self.ty(span, ast::TyKind::Infer)
63 pub fn ty_path(&self, path: ast::Path) -> P<ast::Ty> {
64 self.ty(path.span, ast::TyKind::Path(None, path))
67 // Might need to take bounds as an argument in the future, if you ever want
68 // to generate a bounded existential trait type.
69 pub fn ty_ident(&self, span: Span, ident: Ident) -> P<ast::Ty> {
70 self.ty_path(self.path_ident(span, ident))
73 pub fn anon_const(&self, span: Span, kind: ast::ExprKind) -> ast::AnonConst {
75 id: ast::DUMMY_NODE_ID,
77 id: ast::DUMMY_NODE_ID,
80 attrs: AttrVec::new(),
86 pub fn const_ident(&self, span: Span, ident: Ident) -> ast::AnonConst {
87 self.anon_const(span, ast::ExprKind::Path(None, self.path_ident(span, ident)))
94 lifetime: Option<ast::Lifetime>,
95 mutbl: ast::Mutability,
97 self.ty(span, ast::TyKind::Rptr(lifetime, self.ty_mt(ty, mutbl)))
100 pub fn ty_ptr(&self, span: Span, ty: P<ast::Ty>, mutbl: ast::Mutability) -> P<ast::Ty> {
101 self.ty(span, ast::TyKind::Ptr(self.ty_mt(ty, mutbl)))
108 bounds: ast::GenericBounds,
109 default: Option<P<ast::Ty>>,
110 ) -> ast::GenericParam {
112 ident: ident.with_span_pos(span),
113 id: ast::DUMMY_NODE_ID,
114 attrs: AttrVec::new(),
116 kind: ast::GenericParamKind::Type { default },
117 is_placeholder: false,
122 pub fn trait_ref(&self, path: ast::Path) -> ast::TraitRef {
123 ast::TraitRef { path, ref_id: ast::DUMMY_NODE_ID }
126 pub fn poly_trait_ref(&self, span: Span, path: ast::Path) -> ast::PolyTraitRef {
128 bound_generic_params: Vec::new(),
129 trait_ref: self.trait_ref(path),
134 pub fn trait_bound(&self, path: ast::Path) -> ast::GenericBound {
135 ast::GenericBound::Trait(
136 self.poly_trait_ref(path.span, path),
137 ast::TraitBoundModifier::None,
141 pub fn lifetime(&self, span: Span, ident: Ident) -> ast::Lifetime {
142 ast::Lifetime { id: ast::DUMMY_NODE_ID, ident: ident.with_span_pos(span) }
145 pub fn lifetime_static(&self, span: Span) -> ast::Lifetime {
146 self.lifetime(span, Ident::new(kw::StaticLifetime, span))
149 pub fn stmt_expr(&self, expr: P<ast::Expr>) -> ast::Stmt {
150 ast::Stmt { id: ast::DUMMY_NODE_ID, span: expr.span, kind: ast::StmtKind::Expr(expr) }
153 pub fn stmt_let_pat(&self, sp: Span, pat: P<ast::Pat>, ex: P<ast::Expr>) -> ast::Stmt {
154 let local = P(ast::Local {
157 id: ast::DUMMY_NODE_ID,
158 kind: LocalKind::Init(ex),
160 attrs: AttrVec::new(),
163 self.stmt_local(local, sp)
166 pub fn stmt_let(&self, sp: Span, mutbl: bool, ident: Ident, ex: P<ast::Expr>) -> ast::Stmt {
167 self.stmt_let_ty(sp, mutbl, ident, None, ex)
175 ty: Option<P<ast::Ty>>,
179 self.pat_ident_binding_mode(sp, ident, ast::BindingAnnotation::MUT)
181 self.pat_ident(sp, ident)
183 let local = P(ast::Local {
186 id: ast::DUMMY_NODE_ID,
187 kind: LocalKind::Init(ex),
189 attrs: AttrVec::new(),
192 self.stmt_local(local, sp)
195 /// Generates `let _: Type;`, which is usually used for type assertions.
196 pub fn stmt_let_type_only(&self, span: Span, ty: P<ast::Ty>) -> ast::Stmt {
197 let local = P(ast::Local {
198 pat: self.pat_wild(span),
200 id: ast::DUMMY_NODE_ID,
201 kind: LocalKind::Decl,
203 attrs: AttrVec::new(),
206 self.stmt_local(local, span)
209 pub fn stmt_local(&self, local: P<ast::Local>, span: Span) -> ast::Stmt {
210 ast::Stmt { id: ast::DUMMY_NODE_ID, kind: ast::StmtKind::Local(local), span }
213 pub fn stmt_item(&self, sp: Span, item: P<ast::Item>) -> ast::Stmt {
214 ast::Stmt { id: ast::DUMMY_NODE_ID, kind: ast::StmtKind::Item(item), span: sp }
217 pub fn block_expr(&self, expr: P<ast::Expr>) -> P<ast::Block> {
221 id: ast::DUMMY_NODE_ID,
223 kind: ast::StmtKind::Expr(expr),
227 pub fn block(&self, span: Span, stmts: Vec<ast::Stmt>) -> P<ast::Block> {
230 id: ast::DUMMY_NODE_ID,
231 rules: BlockCheckMode::Default,
234 could_be_bare_literal: false,
238 pub fn expr(&self, span: Span, kind: ast::ExprKind) -> P<ast::Expr> {
239 P(ast::Expr { id: ast::DUMMY_NODE_ID, kind, span, attrs: AttrVec::new(), tokens: None })
242 pub fn expr_path(&self, path: ast::Path) -> P<ast::Expr> {
243 self.expr(path.span, ast::ExprKind::Path(None, path))
246 pub fn expr_ident(&self, span: Span, id: Ident) -> P<ast::Expr> {
247 self.expr_path(self.path_ident(span, id))
249 pub fn expr_self(&self, span: Span) -> P<ast::Expr> {
250 self.expr_ident(span, Ident::with_dummy_span(kw::SelfLower))
253 pub fn expr_field(&self, span: Span, expr: P<Expr>, field: Ident) -> P<ast::Expr> {
254 self.expr(span, ast::ExprKind::Field(expr, field))
264 self.expr(sp, ast::ExprKind::Binary(Spanned { node: op, span: sp }, lhs, rhs))
267 pub fn expr_deref(&self, sp: Span, e: P<ast::Expr>) -> P<ast::Expr> {
268 self.expr(sp, ast::ExprKind::Unary(UnOp::Deref, e))
271 pub fn expr_addr_of(&self, sp: Span, e: P<ast::Expr>) -> P<ast::Expr> {
272 self.expr(sp, ast::ExprKind::AddrOf(ast::BorrowKind::Ref, ast::Mutability::Not, e))
279 args: Vec<P<ast::Expr>>,
281 self.expr(span, ast::ExprKind::Call(expr, args))
283 pub fn expr_call_ident(&self, span: Span, id: Ident, args: Vec<P<ast::Expr>>) -> P<ast::Expr> {
284 self.expr(span, ast::ExprKind::Call(self.expr_ident(span, id), args))
286 pub fn expr_call_global(
290 args: Vec<P<ast::Expr>>,
292 let pathexpr = self.expr_path(self.path_global(sp, fn_path));
293 self.expr_call(sp, pathexpr, args)
295 pub fn expr_block(&self, b: P<ast::Block>) -> P<ast::Expr> {
296 self.expr(b.span, ast::ExprKind::Block(b, None))
298 pub fn field_imm(&self, span: Span, ident: Ident, e: P<ast::Expr>) -> ast::ExprField {
300 ident: ident.with_span_pos(span),
304 attrs: AttrVec::new(),
305 id: ast::DUMMY_NODE_ID,
306 is_placeholder: false,
313 fields: Vec<ast::ExprField>,
317 ast::ExprKind::Struct(P(ast::StructExpr {
321 rest: ast::StructRest::None,
325 pub fn expr_struct_ident(
329 fields: Vec<ast::ExprField>,
331 self.expr_struct(span, self.path_ident(span, id), fields)
334 pub fn expr_usize(&self, span: Span, n: usize) -> P<ast::Expr> {
335 let suffix = Some(ast::UintTy::Usize.name());
336 let lit = token::Lit::new(token::Integer, sym::integer(n), suffix);
337 self.expr(span, ast::ExprKind::Lit(lit))
340 pub fn expr_u32(&self, span: Span, n: u32) -> P<ast::Expr> {
341 let suffix = Some(ast::UintTy::U32.name());
342 let lit = token::Lit::new(token::Integer, sym::integer(n), suffix);
343 self.expr(span, ast::ExprKind::Lit(lit))
346 pub fn expr_bool(&self, span: Span, value: bool) -> P<ast::Expr> {
347 let lit = token::Lit::new(token::Bool, if value { kw::True } else { kw::False }, None);
348 self.expr(span, ast::ExprKind::Lit(lit))
351 pub fn expr_str(&self, span: Span, s: Symbol) -> P<ast::Expr> {
352 let lit = token::Lit::new(token::Str, literal::escape_string_symbol(s), None);
353 self.expr(span, ast::ExprKind::Lit(lit))
356 pub fn expr_char(&self, span: Span, ch: char) -> P<ast::Expr> {
357 let lit = token::Lit::new(token::Char, literal::escape_char_symbol(ch), None);
358 self.expr(span, ast::ExprKind::Lit(lit))
361 pub fn expr_byte_str(&self, span: Span, bytes: Vec<u8>) -> P<ast::Expr> {
362 let lit = token::Lit::new(token::ByteStr, literal::escape_byte_str_symbol(&bytes), None);
363 self.expr(span, ast::ExprKind::Lit(lit))
366 /// `[expr1, expr2, ...]`
367 pub fn expr_array(&self, sp: Span, exprs: Vec<P<ast::Expr>>) -> P<ast::Expr> {
368 self.expr(sp, ast::ExprKind::Array(exprs))
371 /// `&[expr1, expr2, ...]`
372 pub fn expr_array_ref(&self, sp: Span, exprs: Vec<P<ast::Expr>>) -> P<ast::Expr> {
373 self.expr_addr_of(sp, self.expr_array(sp, exprs))
376 pub fn expr_cast(&self, sp: Span, expr: P<ast::Expr>, ty: P<ast::Ty>) -> P<ast::Expr> {
377 self.expr(sp, ast::ExprKind::Cast(expr, ty))
380 pub fn expr_some(&self, sp: Span, expr: P<ast::Expr>) -> P<ast::Expr> {
381 let some = self.std_path(&[sym::option, sym::Option, sym::Some]);
382 self.expr_call_global(sp, some, vec![expr])
385 pub fn expr_none(&self, sp: Span) -> P<ast::Expr> {
386 let none = self.std_path(&[sym::option, sym::Option, sym::None]);
387 self.expr_path(self.path_global(sp, none))
389 pub fn expr_tuple(&self, sp: Span, exprs: Vec<P<ast::Expr>>) -> P<ast::Expr> {
390 self.expr(sp, ast::ExprKind::Tup(exprs))
393 pub fn expr_fail(&self, span: Span, msg: Symbol) -> P<ast::Expr> {
394 self.expr_call_global(
396 [sym::std, sym::rt, sym::begin_panic].iter().map(|s| Ident::new(*s, span)).collect(),
397 vec![self.expr_str(span, msg)],
401 pub fn expr_unreachable(&self, span: Span) -> P<ast::Expr> {
402 self.expr_fail(span, Symbol::intern("internal error: entered unreachable code"))
405 pub fn expr_ok(&self, sp: Span, expr: P<ast::Expr>) -> P<ast::Expr> {
406 let ok = self.std_path(&[sym::result, sym::Result, sym::Ok]);
407 self.expr_call_global(sp, ok, vec![expr])
410 pub fn expr_try(&self, sp: Span, head: P<ast::Expr>) -> P<ast::Expr> {
411 let ok = self.std_path(&[sym::result, sym::Result, sym::Ok]);
412 let ok_path = self.path_global(sp, ok);
413 let err = self.std_path(&[sym::result, sym::Result, sym::Err]);
414 let err_path = self.path_global(sp, err);
416 let binding_variable = Ident::new(sym::__try_var, sp);
417 let binding_pat = self.pat_ident(sp, binding_variable);
418 let binding_expr = self.expr_ident(sp, binding_variable);
420 // `Ok(__try_var)` pattern
421 let ok_pat = self.pat_tuple_struct(sp, ok_path, vec![binding_pat.clone()]);
423 // `Err(__try_var)` (pattern and expression respectively)
424 let err_pat = self.pat_tuple_struct(sp, err_path.clone(), vec![binding_pat]);
426 self.expr_call(sp, self.expr_path(err_path), vec![binding_expr.clone()]);
427 // `return Err(__try_var)`
428 let err_expr = self.expr(sp, ast::ExprKind::Ret(Some(err_inner_expr)));
430 // `Ok(__try_var) => __try_var`
431 let ok_arm = self.arm(sp, ok_pat, binding_expr);
432 // `Err(__try_var) => return Err(__try_var)`
433 let err_arm = self.arm(sp, err_pat, err_expr);
435 // `match head { Ok() => ..., Err() => ... }`
436 self.expr_match(sp, head, vec![ok_arm, err_arm])
439 pub fn pat(&self, span: Span, kind: PatKind) -> P<ast::Pat> {
440 P(ast::Pat { id: ast::DUMMY_NODE_ID, kind, span, tokens: None })
442 pub fn pat_wild(&self, span: Span) -> P<ast::Pat> {
443 self.pat(span, PatKind::Wild)
445 pub fn pat_lit(&self, span: Span, expr: P<ast::Expr>) -> P<ast::Pat> {
446 self.pat(span, PatKind::Lit(expr))
448 pub fn pat_ident(&self, span: Span, ident: Ident) -> P<ast::Pat> {
449 self.pat_ident_binding_mode(span, ident, ast::BindingAnnotation::NONE)
452 pub fn pat_ident_binding_mode(
456 ann: ast::BindingAnnotation,
458 let pat = PatKind::Ident(ann, ident.with_span_pos(span), None);
461 pub fn pat_path(&self, span: Span, path: ast::Path) -> P<ast::Pat> {
462 self.pat(span, PatKind::Path(None, path))
464 pub fn pat_tuple_struct(
468 subpats: Vec<P<ast::Pat>>,
470 self.pat(span, PatKind::TupleStruct(None, path, subpats))
476 field_pats: Vec<ast::PatField>,
478 self.pat(span, PatKind::Struct(None, path, field_pats, false))
480 pub fn pat_tuple(&self, span: Span, pats: Vec<P<ast::Pat>>) -> P<ast::Pat> {
481 self.pat(span, PatKind::Tuple(pats))
484 pub fn pat_some(&self, span: Span, pat: P<ast::Pat>) -> P<ast::Pat> {
485 let some = self.std_path(&[sym::option, sym::Option, sym::Some]);
486 let path = self.path_global(span, some);
487 self.pat_tuple_struct(span, path, vec![pat])
490 pub fn arm(&self, span: Span, pat: P<ast::Pat>, expr: P<ast::Expr>) -> ast::Arm {
492 attrs: AttrVec::new(),
497 id: ast::DUMMY_NODE_ID,
498 is_placeholder: false,
502 pub fn arm_unreachable(&self, span: Span) -> ast::Arm {
503 self.arm(span, self.pat_wild(span), self.expr_unreachable(span))
506 pub fn expr_match(&self, span: Span, arg: P<ast::Expr>, arms: Vec<ast::Arm>) -> P<Expr> {
507 self.expr(span, ast::ExprKind::Match(arg, arms))
515 els: Option<P<ast::Expr>>,
517 let els = els.map(|x| self.expr_block(self.block_expr(x)));
518 self.expr(span, ast::ExprKind::If(cond, self.block_expr(then), els))
521 pub fn lambda(&self, span: Span, ids: Vec<Ident>, body: P<ast::Expr>) -> P<ast::Expr> {
522 let fn_decl = self.fn_decl(
523 ids.iter().map(|id| self.param(span, *id, self.ty(span, ast::TyKind::Infer))).collect(),
524 ast::FnRetTy::Default(span),
527 // FIXME -- We are using `span` as the span of the `|...|`
528 // part of the lambda, but it probably (maybe?) corresponds to
529 // the entire lambda body. Probably we should extend the API
530 // here, but that's not entirely clear.
533 ast::ExprKind::Closure(Box::new(ast::Closure {
534 binder: ast::ClosureBinder::NotPresent,
535 capture_clause: ast::CaptureBy::Ref,
536 asyncness: ast::Async::No,
537 movability: ast::Movability::Movable,
541 // FIXME(SarthakSingh31): This points to the start of the declaration block and
542 // not the span of the argument block.
548 pub fn lambda0(&self, span: Span, body: P<ast::Expr>) -> P<ast::Expr> {
549 self.lambda(span, Vec::new(), body)
552 pub fn lambda1(&self, span: Span, body: P<ast::Expr>, ident: Ident) -> P<ast::Expr> {
553 self.lambda(span, vec![ident], body)
556 pub fn lambda_stmts_1(&self, span: Span, stmts: Vec<ast::Stmt>, ident: Ident) -> P<ast::Expr> {
557 self.lambda1(span, self.expr_block(self.block(span, stmts)), ident)
560 pub fn param(&self, span: Span, ident: Ident, ty: P<ast::Ty>) -> ast::Param {
561 let arg_pat = self.pat_ident(span, ident);
563 attrs: AttrVec::default(),
564 id: ast::DUMMY_NODE_ID,
568 is_placeholder: false,
572 // `self` is unused but keep it as method for the convenience use.
573 pub fn fn_decl(&self, inputs: Vec<ast::Param>, output: ast::FnRetTy) -> P<ast::FnDecl> {
574 P(ast::FnDecl { inputs, output })
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)))
622 pub fn attr_word(&self, name: Symbol, span: Span) -> ast::Attribute {
623 let g = &self.sess.parse_sess.attr_id_generator;
624 attr::mk_attr_word(g, ast::AttrStyle::Outer, name, span)
627 // Builds `#[name = val]`.
629 // Note: `span` is used for both the identifier and the value.
630 pub fn attr_name_value_str(&self, name: Symbol, val: Symbol, span: Span) -> ast::Attribute {
631 let g = &self.sess.parse_sess.attr_id_generator;
632 attr::mk_attr_name_value_str(g, ast::AttrStyle::Outer, name, val, span)
635 // Builds `#[outer(inner)]`.
636 pub fn attr_nested_word(&self, outer: Symbol, inner: Symbol, span: Span) -> ast::Attribute {
637 let g = &self.sess.parse_sess.attr_id_generator;
638 attr::mk_attr_nested_word(g, ast::AttrStyle::Outer, outer, inner, span)