src/librustc_mir/hair/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 //! The MIR is translated from some high-level abstract IR
  12 //! (HAIR). This section defines the HAIR along with a trait for
  13 //! accessing it. The intention is to allow MIR construction to be
  14 //! unit-tested and separated from the Rust source and compiler data
  15 //! structures.
  16
  17 use rustc_const_math::ConstUsize;
  18 use rustc::mir::{BinOp, BorrowKind, Field, Literal, UnOp};
  19 use rustc::hir::def_id::DefId;
  20 use rustc::middle::region::CodeExtent;
  21 use rustc::ty::subst::Substs;
  22 use rustc::ty::{self, AdtDef, ClosureSubsts, Region, Ty};
  23 use rustc::hir;
  24 use syntax::ast;
  25 use syntax_pos::Span;
  26 use self::cx::Cx;
  27
  28 pub mod cx;
  29
  30 pub use rustc_const_eval::pattern::{BindingMode, Pattern, PatternKind, FieldPattern};
  31
  32 #[derive(Clone, Debug)]
  33 pub struct Block<'tcx> {
  34     pub targeted_by_break: bool,
  35     pub extent: CodeExtent,
  36     pub span: Span,
  37     pub stmts: Vec<StmtRef<'tcx>>,
  38     pub expr: Option<ExprRef<'tcx>>,
  39 }
  40
  41 #[derive(Clone, Debug)]
  42 pub enum StmtRef<'tcx> {
  43     Mirror(Box<Stmt<'tcx>>),
  44 }
  45
  46 #[derive(Clone, Debug)]
  47 pub struct Stmt<'tcx> {
  48     pub span: Span,
  49     pub kind: StmtKind<'tcx>,
  50 }
  51
  52 #[derive(Clone, Debug)]
  53 pub enum StmtKind<'tcx> {
  54     Expr {
  55         /// scope for this statement; may be used as lifetime of temporaries
  56         scope: CodeExtent,
  57
  58         /// expression being evaluated in this statement
  59         expr: ExprRef<'tcx>,
  60     },
  61
  62     Let {
  63         /// scope for variables bound in this let; covers this and
  64         /// remaining statements in block
  65         remainder_scope: CodeExtent,
  66
  67         /// scope for the initialization itself; might be used as
  68         /// lifetime of temporaries
  69         init_scope: CodeExtent,
  70
  71         /// let <PAT> = ...
  72         pattern: Pattern<'tcx>,
  73
  74         /// let pat = <INIT> ...
  75         initializer: Option<ExprRef<'tcx>>
  76     },
  77 }
  78
  79 /// The Hair trait implementor translates their expressions (`&'tcx H::Expr`)
  80 /// into instances of this `Expr` enum. This translation can be done
  81 /// basically as lazilly or as eagerly as desired: every recursive
  82 /// reference to an expression in this enum is an `ExprRef<'tcx>`, which
  83 /// may in turn be another instance of this enum (boxed), or else an
  84 /// untranslated `&'tcx H::Expr`. Note that instances of `Expr` are very
  85 /// shortlived. They are created by `Hair::to_expr`, analyzed and
  86 /// converted into MIR, and then discarded.
  87 ///
  88 /// If you compare `Expr` to the full compiler AST, you will see it is
  89 /// a good bit simpler. In fact, a number of the more straight-forward
  90 /// MIR simplifications are already done in the impl of `Hair`. For
  91 /// example, method calls and overloaded operators are absent: they are
  92 /// expected to be converted into `Expr::Call` instances.
  93 #[derive(Clone, Debug)]
  94 pub struct Expr<'tcx> {
  95     /// type of this expression
  96     pub ty: Ty<'tcx>,
  97
  98     /// lifetime of this expression if it should be spilled into a
  99     /// temporary; should be None only if in a constant context
 100     pub temp_lifetime: Option<CodeExtent>,
 101
 102     /// span of the expression in the source
 103     pub span: Span,
 104
 105     /// kind of expression
 106     pub kind: ExprKind<'tcx>,
 107 }
 108
 109 #[derive(Clone, Debug)]
 110 pub enum ExprKind<'tcx> {
 111     Scope {
 112         extent: CodeExtent,
 113         value: ExprRef<'tcx>,
 114     },
 115     Box {
 116         value: ExprRef<'tcx>,
 117         value_extents: CodeExtent,
 118     },
 119     Call {
 120         ty: ty::Ty<'tcx>,
 121         fun: ExprRef<'tcx>,
 122         args: Vec<ExprRef<'tcx>>,
 123     },
 124     Deref {
 125         arg: ExprRef<'tcx>,
 126     }, // NOT overloaded!
 127     Binary {
 128         op: BinOp,
 129         lhs: ExprRef<'tcx>,
 130         rhs: ExprRef<'tcx>,
 131     }, // NOT overloaded!
 132     LogicalOp {
 133         op: LogicalOp,
 134         lhs: ExprRef<'tcx>,
 135         rhs: ExprRef<'tcx>,
 136     }, // NOT overloaded!
 137        // LogicalOp is distinct from BinaryOp because of lazy evaluation of the operands.
 138     Unary {
 139         op: UnOp,
 140         arg: ExprRef<'tcx>,
 141     }, // NOT overloaded!
 142     Cast {
 143         source: ExprRef<'tcx>,
 144     },
 145     Use {
 146         source: ExprRef<'tcx>,
 147     }, // Use a lexpr to get a vexpr.
 148     NeverToAny {
 149         source: ExprRef<'tcx>,
 150     },
 151     ReifyFnPointer {
 152         source: ExprRef<'tcx>,
 153     },
 154     ClosureFnPointer {
 155         source: ExprRef<'tcx>,
 156     },
 157     UnsafeFnPointer {
 158         source: ExprRef<'tcx>,
 159     },
 160     Unsize {
 161         source: ExprRef<'tcx>,
 162     },
 163     If {
 164         condition: ExprRef<'tcx>,
 165         then: ExprRef<'tcx>,
 166         otherwise: Option<ExprRef<'tcx>>,
 167     },
 168     Loop {
 169         condition: Option<ExprRef<'tcx>>,
 170         body: ExprRef<'tcx>,
 171     },
 172     Match {
 173         discriminant: ExprRef<'tcx>,
 174         arms: Vec<Arm<'tcx>>,
 175     },
 176     Block {
 177         body: &'tcx hir::Block,
 178     },
 179     Assign {
 180         lhs: ExprRef<'tcx>,
 181         rhs: ExprRef<'tcx>,
 182     },
 183     AssignOp {
 184         op: BinOp,
 185         lhs: ExprRef<'tcx>,
 186         rhs: ExprRef<'tcx>,
 187     },
 188     Field {
 189         lhs: ExprRef<'tcx>,
 190         name: Field,
 191     },
 192     Index {
 193         lhs: ExprRef<'tcx>,
 194         index: ExprRef<'tcx>,
 195     },
 196     VarRef {
 197         id: ast::NodeId,
 198     },
 199     /// first argument, used for self in a closure
 200     SelfRef,
 201     StaticRef {
 202         id: DefId,
 203     },
 204     Borrow {
 205         region: Region<'tcx>,
 206         borrow_kind: BorrowKind,
 207         arg: ExprRef<'tcx>,
 208     },
 209     Break {
 210         label: CodeExtent,
 211         value: Option<ExprRef<'tcx>>,
 212     },
 213     Continue {
 214         label: CodeExtent,
 215     },
 216     Return {
 217         value: Option<ExprRef<'tcx>>,
 218     },
 219     Repeat {
 220         value: ExprRef<'tcx>,
 221         count: ConstUsize,
 222     },
 223     Array {
 224         fields: Vec<ExprRef<'tcx>>,
 225     },
 226     Tuple {
 227         fields: Vec<ExprRef<'tcx>>,
 228     },
 229     Adt {
 230         adt_def: &'tcx AdtDef,
 231         variant_index: usize,
 232         substs: &'tcx Substs<'tcx>,
 233         fields: Vec<FieldExprRef<'tcx>>,
 234         base: Option<FruInfo<'tcx>>
 235     },
 236     Closure {
 237         closure_id: DefId,
 238         substs: ClosureSubsts<'tcx>,
 239         upvars: Vec<ExprRef<'tcx>>,
 240     },
 241     Literal {
 242         literal: Literal<'tcx>,
 243     },
 244     InlineAsm {
 245         asm: &'tcx hir::InlineAsm,
 246         outputs: Vec<ExprRef<'tcx>>,
 247         inputs: Vec<ExprRef<'tcx>>
 248     },
 249 }
 250
 251 #[derive(Clone, Debug)]
 252 pub enum ExprRef<'tcx> {
 253     Hair(&'tcx hir::Expr),
 254     Mirror(Box<Expr<'tcx>>),
 255 }
 256
 257 #[derive(Clone, Debug)]
 258 pub struct FieldExprRef<'tcx> {
 259     pub name: Field,
 260     pub expr: ExprRef<'tcx>,
 261 }
 262
 263 #[derive(Clone, Debug)]
 264 pub struct FruInfo<'tcx> {
 265     pub base: ExprRef<'tcx>,
 266     pub field_types: Vec<Ty<'tcx>>
 267 }
 268
 269 #[derive(Clone, Debug)]
 270 pub struct Arm<'tcx> {
 271     pub patterns: Vec<Pattern<'tcx>>,
 272     pub guard: Option<ExprRef<'tcx>>,
 273     pub body: ExprRef<'tcx>,
 274 }
 275
 276 #[derive(Copy, Clone, Debug)]
 277 pub enum LogicalOp {
 278     And,
 279     Or,
 280 }
 281
 282 ///////////////////////////////////////////////////////////////////////////
 283 // The Mirror trait
 284
 285 /// "Mirroring" is the process of converting from a HIR type into one
 286 /// of the HAIR types defined in this file. This is basically a "on
 287 /// the fly" desugaring step that hides a lot of the messiness in the
 288 /// tcx. For example, the mirror of a `&'tcx hir::Expr` is an
 289 /// `Expr<'tcx>`.
 290 ///
 291 /// Mirroring is gradual: when you mirror an outer expression like `e1
 292 /// + e2`, the references to the inner expressions `e1` and `e2` are
 293 /// `ExprRef<'tcx>` instances, and they may or may not be eagerly
 294 /// mirrored.  This allows a single AST node from the compiler to
 295 /// expand into one or more Hair nodes, which lets the Hair nodes be
 296 /// simpler.
 297 pub trait Mirror<'tcx> {
 298     type Output;
 299
 300     fn make_mirror<'a, 'gcx>(self, cx: &mut Cx<'a, 'gcx, 'tcx>) -> Self::Output;
 301 }
 302
 303 impl<'tcx> Mirror<'tcx> for Expr<'tcx> {
 304     type Output = Expr<'tcx>;
 305
 306     fn make_mirror<'a, 'gcx>(self, _: &mut Cx<'a, 'gcx, 'tcx>) -> Expr<'tcx> {
 307         self
 308     }
 309 }
 310
 311 impl<'tcx> Mirror<'tcx> for ExprRef<'tcx> {
 312     type Output = Expr<'tcx>;
 313
 314     fn make_mirror<'a, 'gcx>(self, hir: &mut Cx<'a, 'gcx, 'tcx>) -> Expr<'tcx> {
 315         match self {
 316             ExprRef::Hair(h) => h.make_mirror(hir),
 317             ExprRef::Mirror(m) => *m,
 318         }
 319     }
 320 }
 321
 322 impl<'tcx> Mirror<'tcx> for Stmt<'tcx> {
 323     type Output = Stmt<'tcx>;
 324
 325     fn make_mirror<'a, 'gcx>(self, _: &mut Cx<'a, 'gcx, 'tcx>) -> Stmt<'tcx> {
 326         self
 327     }
 328 }
 329
 330 impl<'tcx> Mirror<'tcx> for StmtRef<'tcx> {
 331     type Output = Stmt<'tcx>;
 332
 333     fn make_mirror<'a, 'gcx>(self, _: &mut Cx<'a, 'gcx, 'tcx>) -> Stmt<'tcx> {
 334         match self {
 335             StmtRef::Mirror(m) => *m,
 336         }
 337     }
 338 }
 339
 340 impl<'tcx> Mirror<'tcx> for Block<'tcx> {
 341     type Output = Block<'tcx>;
 342
 343     fn make_mirror<'a, 'gcx>(self, _: &mut Cx<'a, 'gcx, 'tcx>) -> Block<'tcx> {
 344         self
 345     }
 346 }