1 use crate::base::ExtCtxt;
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};
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 = Vec::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_path(&self, path: ast::Path) -> P<ast::Ty> {
61 self.ty(path.span, ast::TyKind::Path(None, path))
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))
70 pub fn anon_const(&self, span: Span, kind: ast::ExprKind) -> ast::AnonConst {
72 id: ast::DUMMY_NODE_ID,
74 id: ast::DUMMY_NODE_ID,
77 attrs: AttrVec::new(),
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)))
91 lifetime: Option<ast::Lifetime>,
92 mutbl: ast::Mutability,
94 self.ty(span, ast::TyKind::Rptr(lifetime, self.ty_mt(ty, mutbl)))
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)))
105 attrs: Vec<ast::Attribute>,
106 bounds: ast::GenericBounds,
107 default: Option<P<ast::Ty>>,
108 ) -> ast::GenericParam {
110 ident: ident.with_span_pos(span),
111 id: ast::DUMMY_NODE_ID,
114 kind: ast::GenericParamKind::Type { default },
115 is_placeholder: false,
120 pub fn trait_ref(&self, path: ast::Path) -> ast::TraitRef {
121 ast::TraitRef { path, ref_id: ast::DUMMY_NODE_ID }
124 pub fn poly_trait_ref(&self, span: Span, path: ast::Path) -> ast::PolyTraitRef {
126 bound_generic_params: Vec::new(),
127 trait_ref: self.trait_ref(path),
132 pub fn trait_bound(&self, path: ast::Path) -> ast::GenericBound {
133 ast::GenericBound::Trait(
134 self.poly_trait_ref(path.span, path),
135 ast::TraitBoundModifier::None,
139 pub fn lifetime(&self, span: Span, ident: Ident) -> ast::Lifetime {
140 ast::Lifetime { id: ast::DUMMY_NODE_ID, ident: ident.with_span_pos(span) }
143 pub fn stmt_expr(&self, expr: P<ast::Expr>) -> ast::Stmt {
144 ast::Stmt { id: ast::DUMMY_NODE_ID, span: expr.span, kind: ast::StmtKind::Expr(expr) }
147 pub fn stmt_let(&self, sp: Span, mutbl: bool, ident: Ident, ex: P<ast::Expr>) -> ast::Stmt {
149 let binding_mode = ast::BindingMode::ByValue(ast::Mutability::Mut);
150 self.pat_ident_binding_mode(sp, ident, binding_mode)
152 self.pat_ident(sp, ident)
154 let local = P(ast::Local {
157 id: ast::DUMMY_NODE_ID,
158 kind: LocalKind::Init(ex),
160 attrs: AttrVec::new(),
163 ast::Stmt { id: ast::DUMMY_NODE_ID, kind: ast::StmtKind::Local(local), span: sp }
166 // Generates `let _: Type;`, which is usually used for type assertions.
167 pub fn stmt_let_type_only(&self, span: Span, ty: P<ast::Ty>) -> ast::Stmt {
168 let local = P(ast::Local {
169 pat: self.pat_wild(span),
171 id: ast::DUMMY_NODE_ID,
172 kind: LocalKind::Decl,
174 attrs: AttrVec::new(),
177 ast::Stmt { id: ast::DUMMY_NODE_ID, kind: ast::StmtKind::Local(local), span }
180 pub fn stmt_item(&self, sp: Span, item: P<ast::Item>) -> ast::Stmt {
181 ast::Stmt { id: ast::DUMMY_NODE_ID, kind: ast::StmtKind::Item(item), span: sp }
184 pub fn block_expr(&self, expr: P<ast::Expr>) -> P<ast::Block> {
188 id: ast::DUMMY_NODE_ID,
190 kind: ast::StmtKind::Expr(expr),
194 pub fn block(&self, span: Span, stmts: Vec<ast::Stmt>) -> P<ast::Block> {
197 id: ast::DUMMY_NODE_ID,
198 rules: BlockCheckMode::Default,
201 could_be_bare_literal: false,
205 pub fn expr(&self, span: Span, kind: ast::ExprKind) -> P<ast::Expr> {
206 P(ast::Expr { id: ast::DUMMY_NODE_ID, kind, span, attrs: AttrVec::new(), tokens: None })
209 pub fn expr_path(&self, path: ast::Path) -> P<ast::Expr> {
210 self.expr(path.span, ast::ExprKind::Path(None, path))
213 pub fn expr_ident(&self, span: Span, id: Ident) -> P<ast::Expr> {
214 self.expr_path(self.path_ident(span, id))
216 pub fn expr_self(&self, span: Span) -> P<ast::Expr> {
217 self.expr_ident(span, Ident::with_dummy_span(kw::SelfLower))
227 self.expr(sp, ast::ExprKind::Binary(Spanned { node: op, span: sp }, lhs, rhs))
230 pub fn expr_deref(&self, sp: Span, e: P<ast::Expr>) -> P<ast::Expr> {
231 self.expr(sp, ast::ExprKind::Unary(UnOp::Deref, e))
234 pub fn expr_addr_of(&self, sp: Span, e: P<ast::Expr>) -> P<ast::Expr> {
235 self.expr(sp, ast::ExprKind::AddrOf(ast::BorrowKind::Ref, ast::Mutability::Not, e))
242 args: Vec<P<ast::Expr>>,
244 self.expr(span, ast::ExprKind::Call(expr, args))
246 pub fn expr_call_ident(&self, span: Span, id: Ident, args: Vec<P<ast::Expr>>) -> P<ast::Expr> {
247 self.expr(span, ast::ExprKind::Call(self.expr_ident(span, id), args))
249 pub fn expr_call_global(
253 args: Vec<P<ast::Expr>>,
255 let pathexpr = self.expr_path(self.path_global(sp, fn_path));
256 self.expr_call(sp, pathexpr, args)
258 pub fn expr_block(&self, b: P<ast::Block>) -> P<ast::Expr> {
259 self.expr(b.span, ast::ExprKind::Block(b, None))
261 pub fn field_imm(&self, span: Span, ident: Ident, e: P<ast::Expr>) -> ast::ExprField {
263 ident: ident.with_span_pos(span),
267 attrs: AttrVec::new(),
268 id: ast::DUMMY_NODE_ID,
269 is_placeholder: false,
276 fields: Vec<ast::ExprField>,
280 ast::ExprKind::Struct(P(ast::StructExpr {
284 rest: ast::StructRest::None,
288 pub fn expr_struct_ident(
292 fields: Vec<ast::ExprField>,
294 self.expr_struct(span, self.path_ident(span, id), fields)
297 pub fn expr_lit(&self, span: Span, lit_kind: ast::LitKind) -> P<ast::Expr> {
298 let lit = ast::Lit::from_lit_kind(lit_kind, span);
299 self.expr(span, ast::ExprKind::Lit(lit))
301 pub fn expr_usize(&self, span: Span, i: usize) -> P<ast::Expr> {
304 ast::LitKind::Int(i as u128, ast::LitIntType::Unsigned(ast::UintTy::Usize)),
307 pub fn expr_u32(&self, sp: Span, u: u32) -> P<ast::Expr> {
308 self.expr_lit(sp, ast::LitKind::Int(u as u128, ast::LitIntType::Unsigned(ast::UintTy::U32)))
310 pub fn expr_bool(&self, sp: Span, value: bool) -> P<ast::Expr> {
311 self.expr_lit(sp, ast::LitKind::Bool(value))
314 pub fn expr_vec(&self, sp: Span, exprs: Vec<P<ast::Expr>>) -> P<ast::Expr> {
315 self.expr(sp, ast::ExprKind::Array(exprs))
317 pub fn expr_vec_slice(&self, sp: Span, exprs: Vec<P<ast::Expr>>) -> P<ast::Expr> {
318 self.expr_addr_of(sp, self.expr_vec(sp, exprs))
320 pub fn expr_str(&self, sp: Span, s: Symbol) -> P<ast::Expr> {
321 self.expr_lit(sp, ast::LitKind::Str(s, ast::StrStyle::Cooked))
324 pub fn expr_cast(&self, sp: Span, expr: P<ast::Expr>, ty: P<ast::Ty>) -> P<ast::Expr> {
325 self.expr(sp, ast::ExprKind::Cast(expr, ty))
328 pub fn expr_some(&self, sp: Span, expr: P<ast::Expr>) -> P<ast::Expr> {
329 let some = self.std_path(&[sym::option, sym::Option, sym::Some]);
330 self.expr_call_global(sp, some, vec![expr])
333 pub fn expr_none(&self, sp: Span) -> P<ast::Expr> {
334 let none = self.std_path(&[sym::option, sym::Option, sym::None]);
335 self.expr_path(self.path_global(sp, none))
337 pub fn expr_tuple(&self, sp: Span, exprs: Vec<P<ast::Expr>>) -> P<ast::Expr> {
338 self.expr(sp, ast::ExprKind::Tup(exprs))
341 pub fn expr_fail(&self, span: Span, msg: Symbol) -> P<ast::Expr> {
342 self.expr_call_global(
344 [sym::std, sym::rt, sym::begin_panic].iter().map(|s| Ident::new(*s, span)).collect(),
345 vec![self.expr_str(span, msg)],
349 pub fn expr_unreachable(&self, span: Span) -> P<ast::Expr> {
350 self.expr_fail(span, Symbol::intern("internal error: entered unreachable code"))
353 pub fn expr_ok(&self, sp: Span, expr: P<ast::Expr>) -> P<ast::Expr> {
354 let ok = self.std_path(&[sym::result, sym::Result, sym::Ok]);
355 self.expr_call_global(sp, ok, vec![expr])
358 pub fn expr_try(&self, sp: Span, head: P<ast::Expr>) -> P<ast::Expr> {
359 let ok = self.std_path(&[sym::result, sym::Result, sym::Ok]);
360 let ok_path = self.path_global(sp, ok);
361 let err = self.std_path(&[sym::result, sym::Result, sym::Err]);
362 let err_path = self.path_global(sp, err);
364 let binding_variable = Ident::new(sym::__try_var, sp);
365 let binding_pat = self.pat_ident(sp, binding_variable);
366 let binding_expr = self.expr_ident(sp, binding_variable);
368 // `Ok(__try_var)` pattern
369 let ok_pat = self.pat_tuple_struct(sp, ok_path, vec![binding_pat.clone()]);
371 // `Err(__try_var)` (pattern and expression respectively)
372 let err_pat = self.pat_tuple_struct(sp, err_path.clone(), vec![binding_pat]);
374 self.expr_call(sp, self.expr_path(err_path), vec![binding_expr.clone()]);
375 // `return Err(__try_var)`
376 let err_expr = self.expr(sp, ast::ExprKind::Ret(Some(err_inner_expr)));
378 // `Ok(__try_var) => __try_var`
379 let ok_arm = self.arm(sp, ok_pat, binding_expr);
380 // `Err(__try_var) => return Err(__try_var)`
381 let err_arm = self.arm(sp, err_pat, err_expr);
383 // `match head { Ok() => ..., Err() => ... }`
384 self.expr_match(sp, head, vec![ok_arm, err_arm])
387 pub fn pat(&self, span: Span, kind: PatKind) -> P<ast::Pat> {
388 P(ast::Pat { id: ast::DUMMY_NODE_ID, kind, span, tokens: None })
390 pub fn pat_wild(&self, span: Span) -> P<ast::Pat> {
391 self.pat(span, PatKind::Wild)
393 pub fn pat_lit(&self, span: Span, expr: P<ast::Expr>) -> P<ast::Pat> {
394 self.pat(span, PatKind::Lit(expr))
396 pub fn pat_ident(&self, span: Span, ident: Ident) -> P<ast::Pat> {
397 let binding_mode = ast::BindingMode::ByValue(ast::Mutability::Not);
398 self.pat_ident_binding_mode(span, ident, binding_mode)
401 pub fn pat_ident_binding_mode(
405 bm: ast::BindingMode,
407 let pat = PatKind::Ident(bm, ident.with_span_pos(span), None);
410 pub fn pat_path(&self, span: Span, path: ast::Path) -> P<ast::Pat> {
411 self.pat(span, PatKind::Path(None, path))
413 pub fn pat_tuple_struct(
417 subpats: Vec<P<ast::Pat>>,
419 self.pat(span, PatKind::TupleStruct(None, path, subpats))
425 field_pats: Vec<ast::PatField>,
427 self.pat(span, PatKind::Struct(None, path, field_pats, false))
429 pub fn pat_tuple(&self, span: Span, pats: Vec<P<ast::Pat>>) -> P<ast::Pat> {
430 self.pat(span, PatKind::Tuple(pats))
433 pub fn pat_some(&self, span: Span, pat: P<ast::Pat>) -> P<ast::Pat> {
434 let some = self.std_path(&[sym::option, sym::Option, sym::Some]);
435 let path = self.path_global(span, some);
436 self.pat_tuple_struct(span, path, vec![pat])
439 pub fn arm(&self, span: Span, pat: P<ast::Pat>, expr: P<ast::Expr>) -> ast::Arm {
441 attrs: AttrVec::new(),
446 id: ast::DUMMY_NODE_ID,
447 is_placeholder: false,
451 pub fn arm_unreachable(&self, span: Span) -> ast::Arm {
452 self.arm(span, self.pat_wild(span), self.expr_unreachable(span))
455 pub fn expr_match(&self, span: Span, arg: P<ast::Expr>, arms: Vec<ast::Arm>) -> P<Expr> {
456 self.expr(span, ast::ExprKind::Match(arg, arms))
464 els: Option<P<ast::Expr>>,
466 let els = els.map(|x| self.expr_block(self.block_expr(x)));
467 self.expr(span, ast::ExprKind::If(cond, self.block_expr(then), els))
470 pub fn lambda(&self, span: Span, ids: Vec<Ident>, body: P<ast::Expr>) -> P<ast::Expr> {
471 let fn_decl = self.fn_decl(
472 ids.iter().map(|id| self.param(span, *id, self.ty(span, ast::TyKind::Infer))).collect(),
473 ast::FnRetTy::Default(span),
476 // FIXME -- We are using `span` as the span of the `|...|`
477 // part of the lambda, but it probably (maybe?) corresponds to
478 // the entire lambda body. Probably we should extend the API
479 // here, but that's not entirely clear.
482 ast::ExprKind::Closure(
485 ast::Movability::Movable,
493 pub fn lambda0(&self, span: Span, body: P<ast::Expr>) -> P<ast::Expr> {
494 self.lambda(span, Vec::new(), body)
497 pub fn lambda1(&self, span: Span, body: P<ast::Expr>, ident: Ident) -> P<ast::Expr> {
498 self.lambda(span, vec![ident], body)
501 pub fn lambda_stmts_1(&self, span: Span, stmts: Vec<ast::Stmt>, ident: Ident) -> P<ast::Expr> {
502 self.lambda1(span, self.expr_block(self.block(span, stmts)), ident)
505 pub fn param(&self, span: Span, ident: Ident, ty: P<ast::Ty>) -> ast::Param {
506 let arg_pat = self.pat_ident(span, ident);
508 attrs: AttrVec::default(),
509 id: ast::DUMMY_NODE_ID,
513 is_placeholder: false,
517 // `self` is unused but keep it as method for the convenience use.
518 pub fn fn_decl(&self, inputs: Vec<ast::Param>, output: ast::FnRetTy) -> P<ast::FnDecl> {
519 P(ast::FnDecl { inputs, output })
526 attrs: Vec<ast::Attribute>,
529 // FIXME: Would be nice if our generated code didn't violate
530 // Rust coding conventions
534 id: ast::DUMMY_NODE_ID,
536 vis: ast::Visibility {
537 span: span.shrink_to_lo(),
538 kind: ast::VisibilityKind::Inherited,
551 mutbl: ast::Mutability,
554 self.item(span, name, Vec::new(), ast::ItemKind::Static(ty, mutbl, Some(expr)))
564 let def = ast::Defaultness::Final;
565 self.item(span, name, Vec::new(), ast::ItemKind::Const(def, ty, Some(expr)))
568 pub fn attribute(&self, mi: ast::MetaItem) -> ast::Attribute {
569 attr::mk_attr_outer(mi)
572 pub fn meta_word(&self, sp: Span, w: Symbol) -> ast::MetaItem {
573 attr::mk_word_item(Ident::new(w, sp))