1 // Copyright 2013 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 //! A mini version of ast::Ty, which is easier to use, and features an explicit `Self` type to use
12 //! when specifying impls to be derived.
14 pub use self::PtrTy::*;
18 use ast::{Expr,Generics,Ident};
19 use ext::base::ExtCtxt;
20 use ext::build::AstBuilder;
21 use codemap::{Span,respan};
22 use owned_slice::OwnedSlice;
23 use parse::token::special_idents;
26 /// The types of pointers
30 Borrowed(Option<&'a str>, ast::Mutability),
35 /// A path, e.g. `::std::option::Option::<int>` (global). Has support
36 /// for type parameters and a lifetime.
39 pub path: Vec<&'a str> ,
40 pub lifetime: Option<&'a str>,
41 pub params: Vec<Box<Ty<'a>>>,
46 pub fn new<'r>(path: Vec<&'r str> ) -> Path<'r> {
47 Path::new_(path, None, Vec::new(), true)
49 pub fn new_local<'r>(path: &'r str) -> Path<'r> {
50 Path::new_(vec!( path ), None, Vec::new(), false)
52 pub fn new_<'r>(path: Vec<&'r str> ,
53 lifetime: Option<&'r str>,
54 params: Vec<Box<Ty<'r>>>,
69 self_generics: &Generics)
71 cx.ty_path(self.to_path(cx, span, self_ty, self_generics))
77 self_generics: &Generics)
79 let idents = self.path.iter().map(|s| cx.ident_of(*s)).collect();
80 let lt = mk_lifetimes(cx, span, &self.lifetime);
81 let tys = self.params.iter().map(|t| t.to_ty(cx, span, self_ty, self_generics)).collect();
83 cx.path_all(span, self.global, idents, lt, tys, Vec::new())
87 /// A type. Supports pointers, Self, and literals
92 Ptr(Box<Ty<'a>>, PtrTy<'a>),
93 /// mod::mod::Type<[lifetime], [Params...]>, including a plain type
94 /// parameter, and things like `int`
100 pub fn borrowed_ptrty<'r>() -> PtrTy<'r> {
101 Borrowed(None, ast::MutImmutable)
103 pub fn borrowed<'r>(ty: Box<Ty<'r>>) -> Ty<'r> {
104 Ptr(ty, borrowed_ptrty())
107 pub fn borrowed_explicit_self<'r>() -> Option<Option<PtrTy<'r>>> {
108 Some(Some(borrowed_ptrty()))
111 pub fn borrowed_self<'r>() -> Ty<'r> {
115 pub fn nil_ty<'r>() -> Ty<'r> {
119 fn mk_lifetime(cx: &ExtCtxt, span: Span, lt: &Option<&str>) -> Option<ast::Lifetime> {
121 Some(ref s) => Some(cx.lifetime(span, cx.ident_of(*s).name)),
126 fn mk_lifetimes(cx: &ExtCtxt, span: Span, lt: &Option<&str>) -> Vec<ast::Lifetime> {
128 Some(ref s) => vec!(cx.lifetime(span, cx.ident_of(*s).name)),
138 self_generics: &Generics)
141 Ptr(ref ty, ref ptr) => {
142 let raw_ty = ty.to_ty(cx, span, self_ty, self_generics);
144 Borrowed(ref lt, mutbl) => {
145 let lt = mk_lifetime(cx, span, lt);
146 cx.ty_rptr(span, raw_ty, lt, mutbl)
148 Raw(mutbl) => cx.ty_ptr(span, raw_ty, mutbl)
151 Literal(ref p) => { p.to_ty(cx, span, self_ty, self_generics) }
153 cx.ty_path(self.to_path(cx, span, self_ty, self_generics))
155 Tuple(ref fields) => {
156 let ty = ast::TyTup(fields.iter()
157 .map(|f| f.to_ty(cx, span, self_ty, self_generics))
164 pub fn to_path(&self,
168 self_generics: &Generics)
172 let self_params = self_generics.ty_params.map(|ty_param| {
173 cx.ty_ident(span, ty_param.ident)
175 let lifetimes = self_generics.lifetimes.iter()
179 cx.path_all(span, false, vec!(self_ty), lifetimes,
180 self_params.into_vec(), Vec::new())
183 p.to_path(cx, span, self_ty, self_generics)
185 Ptr(..) => { cx.span_bug(span, "pointer in a path in generic `deriving`") }
186 Tuple(..) => { cx.span_bug(span, "tuple in a path in generic `deriving`") }
192 fn mk_ty_param(cx: &ExtCtxt,
197 self_generics: &Generics)
200 bounds.iter().map(|b| {
201 let path = b.to_path(cx, span, self_ident, self_generics);
202 cx.typarambound(path)
204 cx.typaram(span, cx.ident_of(name), bounds, None)
207 fn mk_generics(lifetimes: Vec<ast::LifetimeDef>, ty_params: Vec<ast::TyParam>)
210 lifetimes: lifetimes,
211 ty_params: OwnedSlice::from_vec(ty_params),
212 where_clause: ast::WhereClause {
213 id: ast::DUMMY_NODE_ID,
214 predicates: Vec::new(),
219 /// Lifetimes and bounds on type parameters
221 pub struct LifetimeBounds<'a> {
222 pub lifetimes: Vec<(&'a str, Vec<&'a str>)>,
223 pub bounds: Vec<(&'a str, Vec<Path<'a>>)>,
226 impl<'a> LifetimeBounds<'a> {
227 pub fn empty() -> LifetimeBounds<'a> {
229 lifetimes: Vec::new(), bounds: Vec::new()
232 pub fn to_generics(&self,
236 self_generics: &Generics)
238 let lifetimes = self.lifetimes.iter().map(|&(ref lt, ref bounds)| {
241 |b| cx.lifetime(span, cx.ident_of(*b).name)).collect();
242 cx.lifetime_def(span, cx.ident_of(*lt).name, bounds)
244 let ty_params = self.bounds.iter().map(|t| {
246 &(ref name, ref bounds) => {
256 mk_generics(lifetimes, ty_params)
260 pub fn get_explicit_self(cx: &ExtCtxt, span: Span, self_ptr: &Option<PtrTy>)
261 -> (P<Expr>, ast::ExplicitSelf) {
262 // this constructs a fresh `self` path, which will match the fresh `self` binding
264 let self_path = cx.expr_self(span);
267 (self_path, respan(span, ast::SelfValue(special_idents::self_)))
270 let self_ty = respan(
273 Borrowed(ref lt, mutbl) => {
274 let lt = lt.map(|s| cx.lifetime(span, cx.ident_of(s).name));
275 ast::SelfRegion(lt, mutbl, special_idents::self_)
277 Raw(_) => cx.span_bug(span, "attempted to use *self in deriving definition")
279 let self_expr = cx.expr_deref(span, self_path);