src/librustc_mir/hair/mod.rs

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