]> git.lizzy.rs Git - rust.git/blob - src/librustc_mir/hair/cx/mod.rs
rustdoc: Hide `self: Box<Self>` in list of deref methods
[rust.git] / src / librustc_mir / hair / cx / mod.rs
1 // Copyright 2015 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.
4 //
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.
10
11 //! This module contains the code to convert from the wacky tcx data
12 //! structures into the hair. The `builder` is generally ignorant of
13 //! the tcx etc, and instead goes through the `Cx` for most of its
14 //! work.
15 //!
16
17 use hair::*;
18 use rustc::mir::transform::MirSource;
19
20 use rustc::middle::const_val::{ConstEvalErr, ConstVal};
21 use rustc_const_eval::ConstContext;
22 use rustc_data_structures::indexed_vec::Idx;
23 use rustc::hir::def_id::DefId;
24 use rustc::hir::map::blocks::FnLikeNode;
25 use rustc::middle::region::RegionMaps;
26 use rustc::infer::InferCtxt;
27 use rustc::ty::subst::Subst;
28 use rustc::ty::{self, Ty, TyCtxt};
29 use syntax::symbol::Symbol;
30 use rustc::hir;
31 use rustc_const_math::{ConstInt, ConstUsize};
32 use std::rc::Rc;
33
34 #[derive(Clone)]
35 pub struct Cx<'a, 'gcx: 'a + 'tcx, 'tcx: 'a> {
36     tcx: TyCtxt<'a, 'gcx, 'tcx>,
37     infcx: &'a InferCtxt<'a, 'gcx, 'tcx>,
38     pub region_maps: Rc<RegionMaps>,
39
40     /// This is `Constness::Const` if we are compiling a `static`,
41     /// `const`, or the body of a `const fn`.
42     constness: hir::Constness,
43
44     /// What are we compiling?
45     pub src: MirSource,
46
47     /// True if this constant/function needs overflow checks.
48     check_overflow: bool,
49 }
50
51 impl<'a, 'gcx, 'tcx> Cx<'a, 'gcx, 'tcx> {
52     pub fn new(infcx: &'a InferCtxt<'a, 'gcx, 'tcx>, src: MirSource) -> Cx<'a, 'gcx, 'tcx> {
53         let constness = match src {
54             MirSource::Const(_) |
55             MirSource::Static(..) => hir::Constness::Const,
56             MirSource::Fn(id) => {
57                 let fn_like = FnLikeNode::from_node(infcx.tcx.hir.get(id));
58                 fn_like.map_or(hir::Constness::NotConst, |f| f.constness())
59             }
60             MirSource::Promoted(..) => bug!(),
61         };
62
63         let tcx = infcx.tcx;
64         let src_id = src.item_id();
65         let src_def_id = tcx.hir.local_def_id(src_id);
66
67         let region_maps = tcx.region_maps(src_def_id);
68
69         let attrs = tcx.hir.attrs(src_id);
70
71         // Some functions always have overflow checks enabled,
72         // however, they may not get codegen'd, depending on
73         // the settings for the crate they are translated in.
74         let mut check_overflow = attrs.iter()
75             .any(|item| item.check_name("rustc_inherit_overflow_checks"));
76
77         // Respect -C overflow-checks.
78         check_overflow |= tcx.sess.overflow_checks();
79
80         // Constants and const fn's always need overflow checks.
81         check_overflow |= constness == hir::Constness::Const;
82
83         Cx { tcx, infcx, region_maps, constness, src, check_overflow }
84     }
85 }
86
87 impl<'a, 'gcx, 'tcx> Cx<'a, 'gcx, 'tcx> {
88     /// Normalizes `ast` into the appropriate `mirror` type.
89     pub fn mirror<M: Mirror<'tcx>>(&mut self, ast: M) -> M::Output {
90         ast.make_mirror(self)
91     }
92
93     pub fn usize_ty(&mut self) -> Ty<'tcx> {
94         self.tcx.types.usize
95     }
96
97     pub fn usize_literal(&mut self, value: u64) -> Literal<'tcx> {
98         match ConstUsize::new(value, self.tcx.sess.target.uint_type) {
99             Ok(val) => Literal::Value { value: ConstVal::Integral(ConstInt::Usize(val)) },
100             Err(_) => bug!("usize literal out of range for target"),
101         }
102     }
103
104     pub fn bool_ty(&mut self) -> Ty<'tcx> {
105         self.tcx.types.bool
106     }
107
108     pub fn unit_ty(&mut self) -> Ty<'tcx> {
109         self.tcx.mk_nil()
110     }
111
112     pub fn true_literal(&mut self) -> Literal<'tcx> {
113         Literal::Value { value: ConstVal::Bool(true) }
114     }
115
116     pub fn false_literal(&mut self) -> Literal<'tcx> {
117         Literal::Value { value: ConstVal::Bool(false) }
118     }
119
120     pub fn const_eval_literal(&mut self, e: &hir::Expr) -> Literal<'tcx> {
121         let tcx = self.tcx.global_tcx();
122         match ConstContext::with_tables(tcx, self.tables()).eval(e) {
123             Ok(value) => Literal::Value { value: value },
124             Err(s) => self.fatal_const_eval_err(&s, e.span, "expression")
125         }
126     }
127
128     pub fn fatal_const_eval_err(&self,
129         err: &ConstEvalErr<'tcx>,
130         primary_span: Span,
131         primary_kind: &str)
132         -> !
133     {
134         err.report(self.tcx, primary_span, primary_kind);
135         self.tcx.sess.abort_if_errors();
136         unreachable!()
137     }
138
139     pub fn trait_method(&mut self,
140                         trait_def_id: DefId,
141                         method_name: &str,
142                         self_ty: Ty<'tcx>,
143                         params: &[Ty<'tcx>])
144                         -> (Ty<'tcx>, Literal<'tcx>) {
145         let method_name = Symbol::intern(method_name);
146         let substs = self.tcx.mk_substs_trait(self_ty, params);
147         for item in self.tcx.associated_items(trait_def_id) {
148             if item.kind == ty::AssociatedKind::Method && item.name == method_name {
149                 let method_ty = self.tcx.type_of(item.def_id);
150                 let method_ty = method_ty.subst(self.tcx, substs);
151                 return (method_ty,
152                         Literal::Value {
153                             value: ConstVal::Function(item.def_id, substs),
154                         });
155             }
156         }
157
158         bug!("found no method `{}` in `{:?}`", method_name, trait_def_id);
159     }
160
161     pub fn num_variants(&mut self, adt_def: &ty::AdtDef) -> usize {
162         adt_def.variants.len()
163     }
164
165     pub fn all_fields(&mut self, adt_def: &ty::AdtDef, variant_index: usize) -> Vec<Field> {
166         (0..adt_def.variants[variant_index].fields.len())
167             .map(Field::new)
168             .collect()
169     }
170
171     pub fn needs_drop(&mut self, ty: Ty<'tcx>) -> bool {
172         let ty = self.tcx.lift_to_global(&ty).unwrap_or_else(|| {
173             bug!("MIR: Cx::needs_drop({}) got \
174                   type with inference types/regions",
175                  ty);
176         });
177         ty.needs_drop(self.tcx.global_tcx(), self.infcx.param_env)
178     }
179
180     pub fn tcx(&self) -> TyCtxt<'a, 'gcx, 'tcx> {
181         self.tcx
182     }
183
184     pub fn tables(&self) -> &'a ty::TypeckTables<'gcx> {
185         self.infcx.tables.expect_interned()
186     }
187
188     pub fn check_overflow(&self) -> bool {
189         self.check_overflow
190     }
191 }
192
193 mod block;
194 mod expr;
195 mod to_ref;