src/librustc/hir/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 Rust HIR.
  12
  13 pub use self::BlockCheckMode::*;
  14 pub use self::CaptureClause::*;
  15 pub use self::FunctionRetTy::*;
  16 pub use self::Mutability::*;
  17 pub use self::PrimTy::*;
  18 pub use self::UnOp::*;
  19 pub use self::UnsafeSource::*;
  20
  21 use hir::def::Def;
  22 use hir::def_id::{DefId, DefIndex, LocalDefId, CRATE_DEF_INDEX};
  23 use util::nodemap::{NodeMap, FxHashSet};
  24 use mir::mono::Linkage;
  25
  26 use syntax_pos::{Span, DUMMY_SP, symbol::InternedString};
  27 use syntax::source_map::{self, Spanned};
  28 use rustc_target::spec::abi::Abi;
  29 use syntax::ast::{self, CrateSugar, Ident, Name, NodeId, DUMMY_NODE_ID, AsmDialect};
  30 use syntax::ast::{Attribute, Lit, StrStyle, FloatTy, IntTy, UintTy, MetaItem};
  31 use syntax::attr::InlineAttr;
  32 use syntax::ext::hygiene::SyntaxContext;
  33 use syntax::ptr::P;
  34 use syntax::symbol::{Symbol, keywords};
  35 use syntax::tokenstream::TokenStream;
  36 use syntax::util::parser::ExprPrecedence;
  37 use ty::AdtKind;
  38 use ty::query::Providers;
  39
  40 use rustc_data_structures::indexed_vec;
  41 use rustc_data_structures::sync::{ParallelIterator, par_iter, Send, Sync, scope};
  42 use rustc_data_structures::thin_vec::ThinVec;
  43
  44 use serialize::{self, Encoder, Encodable, Decoder, Decodable};
  45 use std::collections::BTreeMap;
  46 use std::fmt;
  47
  48 /// HIR doesn't commit to a concrete storage type and has its own alias for a vector.
  49 /// It can be `Vec`, `P<[T]>` or potentially `Box<[T]>`, or some other container with similar
  50 /// behavior. Unlike AST, HIR is mostly a static structure, so we can use an owned slice instead
  51 /// of `Vec` to avoid keeping extra capacity.
  52 pub type HirVec<T> = P<[T]>;
  53
  54 macro_rules! hir_vec {
  55     ($elem:expr; $n:expr) => (
  56         $crate::hir::HirVec::from(vec![$elem; $n])
  57     );
  58     ($($x:expr),*) => (
  59         $crate::hir::HirVec::from(vec![$($x),*])
  60     );
  61     ($($x:expr,)*) => (hir_vec![$($x),*])
  62 }
  63
  64 pub mod check_attr;
  65 pub mod def;
  66 pub mod def_id;
  67 pub mod intravisit;
  68 pub mod itemlikevisit;
  69 pub mod lowering;
  70 pub mod map;
  71 pub mod pat_util;
  72 pub mod print;
  73
  74 /// A HirId uniquely identifies a node in the HIR of the current crate. It is
  75 /// composed of the `owner`, which is the DefIndex of the directly enclosing
  76 /// hir::Item, hir::TraitItem, or hir::ImplItem (i.e. the closest "item-like"),
  77 /// and the `local_id` which is unique within the given owner.
  78 ///
  79 /// This two-level structure makes for more stable values: One can move an item
  80 /// around within the source code, or add or remove stuff before it, without
  81 /// the local_id part of the HirId changing, which is a very useful property in
  82 /// incremental compilation where we have to persist things through changes to
  83 /// the code base.
  84 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
  85 pub struct HirId {
  86     pub owner: DefIndex,
  87     pub local_id: ItemLocalId,
  88 }
  89
  90 impl HirId {
  91     pub fn owner_def_id(self) -> DefId {
  92         DefId::local(self.owner)
  93     }
  94
  95     pub fn owner_local_def_id(self) -> LocalDefId {
  96         LocalDefId::from_def_id(DefId::local(self.owner))
  97     }
  98 }
  99
 100 impl serialize::UseSpecializedEncodable for HirId {
 101     fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
 102         let HirId {
 103             owner,
 104             local_id,
 105         } = *self;
 106
 107         owner.encode(s)?;
 108         local_id.encode(s)
 109     }
 110 }
 111
 112 impl serialize::UseSpecializedDecodable for HirId {
 113     fn default_decode<D: Decoder>(d: &mut D) -> Result<HirId, D::Error> {
 114         let owner = DefIndex::decode(d)?;
 115         let local_id = ItemLocalId::decode(d)?;
 116
 117         Ok(HirId {
 118             owner,
 119             local_id
 120         })
 121     }
 122 }
 123
 124
 125 /// An `ItemLocalId` uniquely identifies something within a given "item-like",
 126 /// that is within a hir::Item, hir::TraitItem, or hir::ImplItem. There is no
 127 /// guarantee that the numerical value of a given `ItemLocalId` corresponds to
 128 /// the node's position within the owning item in any way, but there is a
 129 /// guarantee that the `LocalItemId`s within an owner occupy a dense range of
 130 /// integers starting at zero, so a mapping that maps all or most nodes within
 131 /// an "item-like" to something else can be implement by a `Vec` instead of a
 132 /// tree or hash map.
 133 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug,
 134          RustcEncodable, RustcDecodable)]
 135 pub struct ItemLocalId(pub u32);
 136
 137 impl ItemLocalId {
 138     pub fn as_usize(&self) -> usize {
 139         self.0 as usize
 140     }
 141 }
 142
 143 impl indexed_vec::Idx for ItemLocalId {
 144     fn new(idx: usize) -> Self {
 145         debug_assert!((idx as u32) as usize == idx);
 146         ItemLocalId(idx as u32)
 147     }
 148
 149     fn index(self) -> usize {
 150         self.0 as usize
 151     }
 152 }
 153
 154 /// The `HirId` corresponding to CRATE_NODE_ID and CRATE_DEF_INDEX
 155 pub const CRATE_HIR_ID: HirId = HirId {
 156     owner: CRATE_DEF_INDEX,
 157     local_id: ItemLocalId(0)
 158 };
 159
 160 pub const DUMMY_HIR_ID: HirId = HirId {
 161     owner: CRATE_DEF_INDEX,
 162     local_id: DUMMY_ITEM_LOCAL_ID,
 163 };
 164
 165 pub const DUMMY_ITEM_LOCAL_ID: ItemLocalId = ItemLocalId(!0);
 166
 167 #[derive(Clone, RustcEncodable, RustcDecodable, Copy)]
 168 pub struct Label {
 169     pub ident: Ident,
 170 }
 171
 172 impl fmt::Debug for Label {
 173     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 174         write!(f, "label({:?})", self.ident)
 175     }
 176 }
 177
 178 #[derive(Clone, RustcEncodable, RustcDecodable, Copy)]
 179 pub struct Lifetime {
 180     pub id: NodeId,
 181     pub span: Span,
 182
 183     /// Either "'a", referring to a named lifetime definition,
 184     /// or "" (aka keywords::Invalid), for elision placeholders.
 185     ///
 186     /// HIR lowering inserts these placeholders in type paths that
 187     /// refer to type definitions needing lifetime parameters,
 188     /// `&T` and `&mut T`, and trait objects without `... + 'a`.
 189     pub name: LifetimeName,
 190 }
 191
 192 #[derive(Debug, Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Copy)]
 193 pub enum ParamName {
 194     /// Some user-given name like `T` or `'x`.
 195     Plain(Ident),
 196
 197     /// Synthetic name generated when user elided a lifetime in an impl header,
 198     /// e.g. the lifetimes in cases like these:
 199     ///
 200     ///     impl Foo for &u32
 201     ///     impl Foo<'_> for u32
 202     ///
 203     /// in that case, we rewrite to
 204     ///
 205     ///     impl<'f> Foo for &'f u32
 206     ///     impl<'f> Foo<'f> for u32
 207     ///
 208     /// where `'f` is something like `Fresh(0)`. The indices are
 209     /// unique per impl, but not necessarily continuous.
 210     Fresh(usize),
 211 }
 212
 213 impl ParamName {
 214     pub fn ident(&self) -> Ident {
 215         match *self {
 216             ParamName::Plain(ident) => ident,
 217             ParamName::Fresh(_) => keywords::UnderscoreLifetime.ident(),
 218         }
 219     }
 220
 221     pub fn modern(&self) -> ParamName {
 222         match *self {
 223             ParamName::Plain(ident) => ParamName::Plain(ident.modern()),
 224             param_name => param_name,
 225         }
 226     }
 227 }
 228
 229 #[derive(Debug, Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Copy)]
 230 pub enum LifetimeName {
 231     /// User-given names or fresh (synthetic) names.
 232     Param(ParamName),
 233
 234     /// User typed nothing. e.g. the lifetime in `&u32`.
 235     Implicit,
 236
 237     /// User typed `'_`.
 238     Underscore,
 239
 240     /// User wrote `'static`
 241     Static,
 242 }
 243
 244 impl LifetimeName {
 245     pub fn ident(&self) -> Ident {
 246         match *self {
 247             LifetimeName::Implicit => keywords::Invalid.ident(),
 248             LifetimeName::Underscore => keywords::UnderscoreLifetime.ident(),
 249             LifetimeName::Static => keywords::StaticLifetime.ident(),
 250             LifetimeName::Param(param_name) => param_name.ident(),
 251         }
 252     }
 253
 254     pub fn is_elided(&self) -> bool {
 255         match self {
 256             LifetimeName::Implicit | LifetimeName::Underscore => true,
 257
 258             // It might seem surprising that `Fresh(_)` counts as
 259             // *not* elided -- but this is because, as far as the code
 260             // in the compiler is concerned -- `Fresh(_)` variants act
 261             // equivalently to "some fresh name". They correspond to
 262             // early-bound regions on an impl, in other words.
 263             LifetimeName::Param(_) | LifetimeName::Static => false,
 264         }
 265     }
 266
 267     fn is_static(&self) -> bool {
 268         self == &LifetimeName::Static
 269     }
 270
 271     pub fn modern(&self) -> LifetimeName {
 272         match *self {
 273             LifetimeName::Param(param_name) => LifetimeName::Param(param_name.modern()),
 274             lifetime_name => lifetime_name,
 275         }
 276     }
 277 }
 278
 279 impl fmt::Display for Lifetime {
 280     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 281         self.name.ident().fmt(f)
 282     }
 283 }
 284
 285 impl fmt::Debug for Lifetime {
 286     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 287         write!(f,
 288                "lifetime({}: {})",
 289                self.id,
 290                print::to_string(print::NO_ANN, |s| s.print_lifetime(self)))
 291     }
 292 }
 293
 294 impl Lifetime {
 295     pub fn is_elided(&self) -> bool {
 296         self.name.is_elided()
 297     }
 298
 299     pub fn is_static(&self) -> bool {
 300         self.name.is_static()
 301     }
 302 }
 303
 304 /// A "Path" is essentially Rust's notion of a name; for instance:
 305 /// `std::cmp::PartialEq`. It's represented as a sequence of identifiers,
 306 /// along with a bunch of supporting information.
 307 #[derive(Clone, RustcEncodable, RustcDecodable)]
 308 pub struct Path {
 309     pub span: Span,
 310     /// The definition that the path resolved to.
 311     pub def: Def,
 312     /// The segments in the path: the things separated by `::`.
 313     pub segments: HirVec<PathSegment>,
 314 }
 315
 316 impl Path {
 317     pub fn is_global(&self) -> bool {
 318         !self.segments.is_empty() && self.segments[0].ident.name == keywords::CrateRoot.name()
 319     }
 320 }
 321
 322 impl fmt::Debug for Path {
 323     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 324         write!(f, "path({})", print::to_string(print::NO_ANN, |s| s.print_path(self, false)))
 325     }
 326 }
 327
 328 impl fmt::Display for Path {
 329     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 330         write!(f, "{}", print::to_string(print::NO_ANN, |s| s.print_path(self, false)))
 331     }
 332 }
 333
 334 /// A segment of a path: an identifier, an optional lifetime, and a set of
 335 /// types.
 336 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 337 pub struct PathSegment {
 338     /// The identifier portion of this path segment.
 339     pub ident: Ident,
 340
 341     /// Type/lifetime parameters attached to this path. They come in
 342     /// two flavors: `Path<A,B,C>` and `Path(A,B) -> C`. Note that
 343     /// this is more than just simple syntactic sugar; the use of
 344     /// parens affects the region binding rules, so we preserve the
 345     /// distinction.
 346     pub args: Option<P<GenericArgs>>,
 347
 348     /// Whether to infer remaining type parameters, if any.
 349     /// This only applies to expression and pattern paths, and
 350     /// out of those only the segments with no type parameters
 351     /// to begin with, e.g. `Vec::new` is `<Vec<..>>::new::<..>`.
 352     pub infer_types: bool,
 353 }
 354
 355 impl PathSegment {
 356     /// Convert an identifier to the corresponding segment.
 357     pub fn from_ident(ident: Ident) -> PathSegment {
 358         PathSegment {
 359             ident,
 360             infer_types: true,
 361             args: None,
 362         }
 363     }
 364
 365     pub fn new(ident: Ident, args: GenericArgs, infer_types: bool) -> Self {
 366         PathSegment {
 367             ident,
 368             infer_types,
 369             args: if args.is_empty() {
 370                 None
 371             } else {
 372                 Some(P(args))
 373             }
 374         }
 375     }
 376
 377     // FIXME: hack required because you can't create a static
 378     // GenericArgs, so you can't just return a &GenericArgs.
 379     pub fn with_generic_args<F, R>(&self, f: F) -> R
 380         where F: FnOnce(&GenericArgs) -> R
 381     {
 382         let dummy = GenericArgs::none();
 383         f(if let Some(ref args) = self.args {
 384             &args
 385         } else {
 386             &dummy
 387         })
 388     }
 389 }
 390
 391 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 392 pub enum GenericArg {
 393     Lifetime(Lifetime),
 394     Type(Ty),
 395 }
 396
 397 impl GenericArg {
 398     pub fn span(&self) -> Span {
 399         match self {
 400             GenericArg::Lifetime(l) => l.span,
 401             GenericArg::Type(t) => t.span,
 402         }
 403     }
 404
 405     pub fn id(&self) -> NodeId {
 406         match self {
 407             GenericArg::Lifetime(l) => l.id,
 408             GenericArg::Type(t) => t.id,
 409         }
 410     }
 411 }
 412
 413 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 414 pub struct GenericArgs {
 415     /// The generic arguments for this path segment.
 416     pub args: HirVec<GenericArg>,
 417     /// Bindings (equality constraints) on associated types, if present.
 418     /// E.g., `Foo<A=Bar>`.
 419     pub bindings: HirVec<TypeBinding>,
 420     /// Were arguments written in parenthesized form `Fn(T) -> U`?
 421     /// This is required mostly for pretty-printing and diagnostics,
 422     /// but also for changing lifetime elision rules to be "function-like".
 423     pub parenthesized: bool,
 424 }
 425
 426 impl GenericArgs {
 427     pub fn none() -> Self {
 428         Self {
 429             args: HirVec::new(),
 430             bindings: HirVec::new(),
 431             parenthesized: false,
 432         }
 433     }
 434
 435     pub fn is_empty(&self) -> bool {
 436         self.args.is_empty() && self.bindings.is_empty() && !self.parenthesized
 437     }
 438
 439     pub fn inputs(&self) -> &[Ty] {
 440         if self.parenthesized {
 441             for arg in &self.args {
 442                 match arg {
 443                     GenericArg::Lifetime(_) => {}
 444                     GenericArg::Type(ref ty) => {
 445                         if let TyKind::Tup(ref tys) = ty.node {
 446                             return tys;
 447                         }
 448                         break;
 449                     }
 450                 }
 451             }
 452         }
 453         bug!("GenericArgs::inputs: not a `Fn(T) -> U`");
 454     }
 455
 456     pub fn own_counts(&self) -> GenericParamCount {
 457         // We could cache this as a property of `GenericParamCount`, but
 458         // the aim is to refactor this away entirely eventually and the
 459         // presence of this method will be a constant reminder.
 460         let mut own_counts: GenericParamCount = Default::default();
 461
 462         for arg in &self.args {
 463             match arg {
 464                 GenericArg::Lifetime(_) => own_counts.lifetimes += 1,
 465                 GenericArg::Type(_) => own_counts.types += 1,
 466             };
 467         }
 468
 469         own_counts
 470     }
 471 }
 472
 473 /// A modifier on a bound, currently this is only used for `?Sized`, where the
 474 /// modifier is `Maybe`. Negative bounds should also be handled here.
 475 #[derive(Copy, Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
 476 pub enum TraitBoundModifier {
 477     None,
 478     Maybe,
 479 }
 480
 481 /// The AST represents all type param bounds as types.
 482 /// typeck::collect::compute_bounds matches these against
 483 /// the "special" built-in traits (see middle::lang_items) and
 484 /// detects Copy, Send and Sync.
 485 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 486 pub enum GenericBound {
 487     Trait(PolyTraitRef, TraitBoundModifier),
 488     Outlives(Lifetime),
 489 }
 490
 491 impl GenericBound {
 492     pub fn span(&self) -> Span {
 493         match self {
 494             &GenericBound::Trait(ref t, ..) => t.span,
 495             &GenericBound::Outlives(ref l) => l.span,
 496         }
 497     }
 498 }
 499
 500 pub type GenericBounds = HirVec<GenericBound>;
 501
 502 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 503 pub enum GenericParamKind {
 504     /// A lifetime definition, eg `'a: 'b + 'c + 'd`.
 505     Lifetime {
 506         // Indicates that the lifetime definition was synthetically added
 507         // as a result of an in-band lifetime usage like:
 508         // `fn foo(x: &'a u8) -> &'a u8 { x }`
 509         in_band: bool,
 510     },
 511     Type {
 512         default: Option<P<Ty>>,
 513         synthetic: Option<SyntheticTyParamKind>,
 514     }
 515 }
 516
 517 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 518 pub struct GenericParam {
 519     pub id: NodeId,
 520     pub name: ParamName,
 521     pub attrs: HirVec<Attribute>,
 522     pub bounds: GenericBounds,
 523     pub span: Span,
 524     pub pure_wrt_drop: bool,
 525
 526     pub kind: GenericParamKind,
 527 }
 528
 529 #[derive(Default)]
 530 pub struct GenericParamCount {
 531     pub lifetimes: usize,
 532     pub types: usize,
 533 }
 534
 535 /// Represents lifetimes and type parameters attached to a declaration
 536 /// of a function, enum, trait, etc.
 537 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 538 pub struct Generics {
 539     pub params: HirVec<GenericParam>,
 540     pub where_clause: WhereClause,
 541     pub span: Span,
 542 }
 543
 544 impl Generics {
 545     pub fn empty() -> Generics {
 546         Generics {
 547             params: HirVec::new(),
 548             where_clause: WhereClause {
 549                 id: DUMMY_NODE_ID,
 550                 predicates: HirVec::new(),
 551             },
 552             span: DUMMY_SP,
 553         }
 554     }
 555
 556     pub fn own_counts(&self) -> GenericParamCount {
 557         // We could cache this as a property of `GenericParamCount`, but
 558         // the aim is to refactor this away entirely eventually and the
 559         // presence of this method will be a constant reminder.
 560         let mut own_counts: GenericParamCount = Default::default();
 561
 562         for param in &self.params {
 563             match param.kind {
 564                 GenericParamKind::Lifetime { .. } => own_counts.lifetimes += 1,
 565                 GenericParamKind::Type { .. } => own_counts.types += 1,
 566             };
 567         }
 568
 569         own_counts
 570     }
 571
 572     pub fn get_named(&self, name: &InternedString) -> Option<&GenericParam> {
 573         for param in &self.params {
 574             if *name == param.name.ident().as_interned_str() {
 575                 return Some(param);
 576             }
 577         }
 578         None
 579     }
 580 }
 581
 582 /// Synthetic Type Parameters are converted to an other form during lowering, this allows
 583 /// to track the original form they had. Useful for error messages.
 584 #[derive(Copy, Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
 585 pub enum SyntheticTyParamKind {
 586     ImplTrait
 587 }
 588
 589 /// A `where` clause in a definition
 590 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 591 pub struct WhereClause {
 592     pub id: NodeId,
 593     pub predicates: HirVec<WherePredicate>,
 594 }
 595
 596 impl WhereClause {
 597     pub fn span(&self) -> Option<Span> {
 598         self.predicates.iter().map(|predicate| predicate.span())
 599             .fold(None, |acc, i| match (acc, i) {
 600                 (None, i) => Some(i),
 601                 (Some(acc), i) => {
 602                     Some(acc.to(i))
 603                 }
 604             })
 605     }
 606 }
 607
 608 /// A single predicate in a `where` clause
 609 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 610 pub enum WherePredicate {
 611     /// A type binding, eg `for<'c> Foo: Send+Clone+'c`
 612     BoundPredicate(WhereBoundPredicate),
 613     /// A lifetime predicate, e.g. `'a: 'b+'c`
 614     RegionPredicate(WhereRegionPredicate),
 615     /// An equality predicate (unsupported)
 616     EqPredicate(WhereEqPredicate),
 617 }
 618
 619 impl WherePredicate {
 620     pub fn span(&self) -> Span {
 621         match self {
 622             &WherePredicate::BoundPredicate(ref p) => p.span,
 623             &WherePredicate::RegionPredicate(ref p) => p.span,
 624             &WherePredicate::EqPredicate(ref p) => p.span,
 625         }
 626     }
 627 }
 628
 629 /// A type bound, eg `for<'c> Foo: Send+Clone+'c`
 630 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 631 pub struct WhereBoundPredicate {
 632     pub span: Span,
 633     /// Any generics from a `for` binding
 634     pub bound_generic_params: HirVec<GenericParam>,
 635     /// The type being bounded
 636     pub bounded_ty: P<Ty>,
 637     /// Trait and lifetime bounds (`Clone+Send+'static`)
 638     pub bounds: GenericBounds,
 639 }
 640
 641 /// A lifetime predicate, e.g. `'a: 'b+'c`
 642 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 643 pub struct WhereRegionPredicate {
 644     pub span: Span,
 645     pub lifetime: Lifetime,
 646     pub bounds: GenericBounds,
 647 }
 648
 649 /// An equality predicate (unsupported), e.g. `T=int`
 650 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 651 pub struct WhereEqPredicate {
 652     pub id: NodeId,
 653     pub span: Span,
 654     pub lhs_ty: P<Ty>,
 655     pub rhs_ty: P<Ty>,
 656 }
 657
 658 pub type CrateConfig = HirVec<P<MetaItem>>;
 659
 660 /// The top-level data structure that stores the entire contents of
 661 /// the crate currently being compiled.
 662 ///
 663 /// For more details, see the [rustc guide].
 664 ///
 665 /// [rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/hir.html
 666 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 667 pub struct Crate {
 668     pub module: Mod,
 669     pub attrs: HirVec<Attribute>,
 670     pub span: Span,
 671     pub exported_macros: HirVec<MacroDef>,
 672
 673     // NB: We use a BTreeMap here so that `visit_all_items` iterates
 674     // over the ids in increasing order. In principle it should not
 675     // matter what order we visit things in, but in *practice* it
 676     // does, because it can affect the order in which errors are
 677     // detected, which in turn can make compile-fail tests yield
 678     // slightly different results.
 679     pub items: BTreeMap<NodeId, Item>,
 680
 681     pub trait_items: BTreeMap<TraitItemId, TraitItem>,
 682     pub impl_items: BTreeMap<ImplItemId, ImplItem>,
 683     pub bodies: BTreeMap<BodyId, Body>,
 684     pub trait_impls: BTreeMap<DefId, Vec<NodeId>>,
 685     pub trait_auto_impl: BTreeMap<DefId, NodeId>,
 686
 687     /// A list of the body ids written out in the order in which they
 688     /// appear in the crate. If you're going to process all the bodies
 689     /// in the crate, you should iterate over this list rather than the keys
 690     /// of bodies.
 691     pub body_ids: Vec<BodyId>,
 692 }
 693
 694 impl Crate {
 695     pub fn item(&self, id: NodeId) -> &Item {
 696         &self.items[&id]
 697     }
 698
 699     pub fn trait_item(&self, id: TraitItemId) -> &TraitItem {
 700         &self.trait_items[&id]
 701     }
 702
 703     pub fn impl_item(&self, id: ImplItemId) -> &ImplItem {
 704         &self.impl_items[&id]
 705     }
 706
 707     /// Visits all items in the crate in some deterministic (but
 708     /// unspecified) order. If you just need to process every item,
 709     /// but don't care about nesting, this method is the best choice.
 710     ///
 711     /// If you do care about nesting -- usually because your algorithm
 712     /// follows lexical scoping rules -- then you want a different
 713     /// approach. You should override `visit_nested_item` in your
 714     /// visitor and then call `intravisit::walk_crate` instead.
 715     pub fn visit_all_item_likes<'hir, V>(&'hir self, visitor: &mut V)
 716         where V: itemlikevisit::ItemLikeVisitor<'hir>
 717     {
 718         for (_, item) in &self.items {
 719             visitor.visit_item(item);
 720         }
 721
 722         for (_, trait_item) in &self.trait_items {
 723             visitor.visit_trait_item(trait_item);
 724         }
 725
 726         for (_, impl_item) in &self.impl_items {
 727             visitor.visit_impl_item(impl_item);
 728         }
 729     }
 730
 731     /// A parallel version of visit_all_item_likes
 732     pub fn par_visit_all_item_likes<'hir, V>(&'hir self, visitor: &V)
 733         where V: itemlikevisit::ParItemLikeVisitor<'hir> + Sync + Send
 734     {
 735         scope(|s| {
 736             s.spawn(|_| {
 737                 par_iter(&self.items).for_each(|(_, item)| {
 738                     visitor.visit_item(item);
 739                 });
 740             });
 741
 742             s.spawn(|_| {
 743                 par_iter(&self.trait_items).for_each(|(_, trait_item)| {
 744                     visitor.visit_trait_item(trait_item);
 745                 });
 746             });
 747
 748             s.spawn(|_| {
 749                 par_iter(&self.impl_items).for_each(|(_, impl_item)| {
 750                     visitor.visit_impl_item(impl_item);
 751                 });
 752             });
 753         });
 754     }
 755
 756     pub fn body(&self, id: BodyId) -> &Body {
 757         &self.bodies[&id]
 758     }
 759 }
 760
 761 /// A macro definition, in this crate or imported from another.
 762 ///
 763 /// Not parsed directly, but created on macro import or `macro_rules!` expansion.
 764 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 765 pub struct MacroDef {
 766     pub name: Name,
 767     pub vis: Visibility,
 768     pub attrs: HirVec<Attribute>,
 769     pub id: NodeId,
 770     pub span: Span,
 771     pub body: TokenStream,
 772     pub legacy: bool,
 773 }
 774
 775 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 776 pub struct Block {
 777     /// Statements in a block
 778     pub stmts: HirVec<Stmt>,
 779     /// An expression at the end of the block
 780     /// without a semicolon, if any
 781     pub expr: Option<P<Expr>>,
 782     pub id: NodeId,
 783     pub hir_id: HirId,
 784     /// Distinguishes between `unsafe { ... }` and `{ ... }`
 785     pub rules: BlockCheckMode,
 786     pub span: Span,
 787     /// If true, then there may exist `break 'a` values that aim to
 788     /// break out of this block early.
 789     /// Used by `'label: {}` blocks and by `catch` statements.
 790     pub targeted_by_break: bool,
 791     /// If true, don't emit return value type errors as the parser had
 792     /// to recover from a parse error so this block will not have an
 793     /// appropriate type. A parse error will have been emitted so the
 794     /// compilation will never succeed if this is true.
 795     pub recovered: bool,
 796 }
 797
 798 #[derive(Clone, RustcEncodable, RustcDecodable)]
 799 pub struct Pat {
 800     pub id: NodeId,
 801     pub hir_id: HirId,
 802     pub node: PatKind,
 803     pub span: Span,
 804 }
 805
 806 impl fmt::Debug for Pat {
 807     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 808         write!(f, "pat({}: {})", self.id,
 809                print::to_string(print::NO_ANN, |s| s.print_pat(self)))
 810     }
 811 }
 812
 813 impl Pat {
 814     // FIXME(#19596) this is a workaround, but there should be a better way
 815     fn walk_<G>(&self, it: &mut G) -> bool
 816         where G: FnMut(&Pat) -> bool
 817     {
 818         if !it(self) {
 819             return false;
 820         }
 821
 822         match self.node {
 823             PatKind::Binding(.., Some(ref p)) => p.walk_(it),
 824             PatKind::Struct(_, ref fields, _) => {
 825                 fields.iter().all(|field| field.node.pat.walk_(it))
 826             }
 827             PatKind::TupleStruct(_, ref s, _) | PatKind::Tuple(ref s, _) => {
 828                 s.iter().all(|p| p.walk_(it))
 829             }
 830             PatKind::Box(ref s) | PatKind::Ref(ref s, _) => {
 831                 s.walk_(it)
 832             }
 833             PatKind::Slice(ref before, ref slice, ref after) => {
 834                 before.iter().all(|p| p.walk_(it)) &&
 835                 slice.iter().all(|p| p.walk_(it)) &&
 836                 after.iter().all(|p| p.walk_(it))
 837             }
 838             PatKind::Wild |
 839             PatKind::Lit(_) |
 840             PatKind::Range(..) |
 841             PatKind::Binding(..) |
 842             PatKind::Path(_) => {
 843                 true
 844             }
 845         }
 846     }
 847
 848     pub fn walk<F>(&self, mut it: F) -> bool
 849         where F: FnMut(&Pat) -> bool
 850     {
 851         self.walk_(&mut it)
 852     }
 853 }
 854
 855 /// A single field in a struct pattern
 856 ///
 857 /// Patterns like the fields of Foo `{ x, ref y, ref mut z }`
 858 /// are treated the same as` x: x, y: ref y, z: ref mut z`,
 859 /// except is_shorthand is true
 860 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 861 pub struct FieldPat {
 862     pub id: NodeId,
 863     /// The identifier for the field
 864     pub ident: Ident,
 865     /// The pattern the field is destructured to
 866     pub pat: P<Pat>,
 867     pub is_shorthand: bool,
 868 }
 869
 870 /// Explicit binding annotations given in the HIR for a binding. Note
 871 /// that this is not the final binding *mode* that we infer after type
 872 /// inference.
 873 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
 874 pub enum BindingAnnotation {
 875   /// No binding annotation given: this means that the final binding mode
 876   /// will depend on whether we have skipped through a `&` reference
 877   /// when matching. For example, the `x` in `Some(x)` will have binding
 878   /// mode `None`; if you do `let Some(x) = &Some(22)`, it will
 879   /// ultimately be inferred to be by-reference.
 880   ///
 881   /// Note that implicit reference skipping is not implemented yet (#42640).
 882   Unannotated,
 883
 884   /// Annotated with `mut x` -- could be either ref or not, similar to `None`.
 885   Mutable,
 886
 887   /// Annotated as `ref`, like `ref x`
 888   Ref,
 889
 890   /// Annotated as `ref mut x`.
 891   RefMut,
 892 }
 893
 894 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
 895 pub enum RangeEnd {
 896     Included,
 897     Excluded,
 898 }
 899
 900 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 901 pub enum PatKind {
 902     /// Represents a wildcard pattern (`_`)
 903     Wild,
 904
 905     /// A fresh binding `ref mut binding @ OPT_SUBPATTERN`.
 906     /// The `NodeId` is the canonical ID for the variable being bound,
 907     /// e.g. in `Ok(x) | Err(x)`, both `x` use the same canonical ID,
 908     /// which is the pattern ID of the first `x`.
 909     Binding(BindingAnnotation, NodeId, Ident, Option<P<Pat>>),
 910
 911     /// A struct or struct variant pattern, e.g. `Variant {x, y, ..}`.
 912     /// The `bool` is `true` in the presence of a `..`.
 913     Struct(QPath, HirVec<Spanned<FieldPat>>, bool),
 914
 915     /// A tuple struct/variant pattern `Variant(x, y, .., z)`.
 916     /// If the `..` pattern fragment is present, then `Option<usize>` denotes its position.
 917     /// 0 <= position <= subpats.len()
 918     TupleStruct(QPath, HirVec<P<Pat>>, Option<usize>),
 919
 920     /// A path pattern for an unit struct/variant or a (maybe-associated) constant.
 921     Path(QPath),
 922
 923     /// A tuple pattern `(a, b)`.
 924     /// If the `..` pattern fragment is present, then `Option<usize>` denotes its position.
 925     /// 0 <= position <= subpats.len()
 926     Tuple(HirVec<P<Pat>>, Option<usize>),
 927     /// A `box` pattern
 928     Box(P<Pat>),
 929     /// A reference pattern, e.g. `&mut (a, b)`
 930     Ref(P<Pat>, Mutability),
 931     /// A literal
 932     Lit(P<Expr>),
 933     /// A range pattern, e.g. `1...2` or `1..2`
 934     Range(P<Expr>, P<Expr>, RangeEnd),
 935     /// `[a, b, ..i, y, z]` is represented as:
 936     ///     `PatKind::Slice(box [a, b], Some(i), box [y, z])`
 937     Slice(HirVec<P<Pat>>, Option<P<Pat>>, HirVec<P<Pat>>),
 938 }
 939
 940 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
 941 pub enum Mutability {
 942     MutMutable,
 943     MutImmutable,
 944 }
 945
 946 impl Mutability {
 947     /// Return MutMutable only if both arguments are mutable.
 948     pub fn and(self, other: Self) -> Self {
 949         match self {
 950             MutMutable => other,
 951             MutImmutable => MutImmutable,
 952         }
 953     }
 954 }
 955
 956 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy, Hash)]
 957 pub enum BinOpKind {
 958     /// The `+` operator (addition)
 959     Add,
 960     /// The `-` operator (subtraction)
 961     Sub,
 962     /// The `*` operator (multiplication)
 963     Mul,
 964     /// The `/` operator (division)
 965     Div,
 966     /// The `%` operator (modulus)
 967     Rem,
 968     /// The `&&` operator (logical and)
 969     And,
 970     /// The `||` operator (logical or)
 971     Or,
 972     /// The `^` operator (bitwise xor)
 973     BitXor,
 974     /// The `&` operator (bitwise and)
 975     BitAnd,
 976     /// The `|` operator (bitwise or)
 977     BitOr,
 978     /// The `<<` operator (shift left)
 979     Shl,
 980     /// The `>>` operator (shift right)
 981     Shr,
 982     /// The `==` operator (equality)
 983     Eq,
 984     /// The `<` operator (less than)
 985     Lt,
 986     /// The `<=` operator (less than or equal to)
 987     Le,
 988     /// The `!=` operator (not equal to)
 989     Ne,
 990     /// The `>=` operator (greater than or equal to)
 991     Ge,
 992     /// The `>` operator (greater than)
 993     Gt,
 994 }
 995
 996 impl BinOpKind {
 997     pub fn as_str(self) -> &'static str {
 998         match self {
 999             BinOpKind::Add => "+",
1000             BinOpKind::Sub => "-",
1001             BinOpKind::Mul => "*",
1002             BinOpKind::Div => "/",
1003             BinOpKind::Rem => "%",
1004             BinOpKind::And => "&&",
1005             BinOpKind::Or => "||",
1006             BinOpKind::BitXor => "^",
1007             BinOpKind::BitAnd => "&",
1008             BinOpKind::BitOr => "|",
1009             BinOpKind::Shl => "<<",
1010             BinOpKind::Shr => ">>",
1011             BinOpKind::Eq => "==",
1012             BinOpKind::Lt => "<",
1013             BinOpKind::Le => "<=",
1014             BinOpKind::Ne => "!=",
1015             BinOpKind::Ge => ">=",
1016             BinOpKind::Gt => ">",
1017         }
1018     }
1019
1020     pub fn is_lazy(self) -> bool {
1021         match self {
1022             BinOpKind::And | BinOpKind::Or => true,
1023             _ => false,
1024         }
1025     }
1026
1027     pub fn is_shift(self) -> bool {
1028         match self {
1029             BinOpKind::Shl | BinOpKind::Shr => true,
1030             _ => false,
1031         }
1032     }
1033
1034     pub fn is_comparison(self) -> bool {
1035         match self {
1036             BinOpKind::Eq |
1037             BinOpKind::Lt |
1038             BinOpKind::Le |
1039             BinOpKind::Ne |
1040             BinOpKind::Gt |
1041             BinOpKind::Ge => true,
1042             BinOpKind::And |
1043             BinOpKind::Or |
1044             BinOpKind::Add |
1045             BinOpKind::Sub |
1046             BinOpKind::Mul |
1047             BinOpKind::Div |
1048             BinOpKind::Rem |
1049             BinOpKind::BitXor |
1050             BinOpKind::BitAnd |
1051             BinOpKind::BitOr |
1052             BinOpKind::Shl |
1053             BinOpKind::Shr => false,
1054         }
1055     }
1056
1057     /// Returns `true` if the binary operator takes its arguments by value
1058     pub fn is_by_value(self) -> bool {
1059         !self.is_comparison()
1060     }
1061 }
1062
1063 impl Into<ast::BinOpKind> for BinOpKind {
1064     fn into(self) -> ast::BinOpKind {
1065         match self {
1066             BinOpKind::Add => ast::BinOpKind::Add,
1067             BinOpKind::Sub => ast::BinOpKind::Sub,
1068             BinOpKind::Mul => ast::BinOpKind::Mul,
1069             BinOpKind::Div => ast::BinOpKind::Div,
1070             BinOpKind::Rem => ast::BinOpKind::Rem,
1071             BinOpKind::And => ast::BinOpKind::And,
1072             BinOpKind::Or => ast::BinOpKind::Or,
1073             BinOpKind::BitXor => ast::BinOpKind::BitXor,
1074             BinOpKind::BitAnd => ast::BinOpKind::BitAnd,
1075             BinOpKind::BitOr => ast::BinOpKind::BitOr,
1076             BinOpKind::Shl => ast::BinOpKind::Shl,
1077             BinOpKind::Shr => ast::BinOpKind::Shr,
1078             BinOpKind::Eq => ast::BinOpKind::Eq,
1079             BinOpKind::Lt => ast::BinOpKind::Lt,
1080             BinOpKind::Le => ast::BinOpKind::Le,
1081             BinOpKind::Ne => ast::BinOpKind::Ne,
1082             BinOpKind::Ge => ast::BinOpKind::Ge,
1083             BinOpKind::Gt => ast::BinOpKind::Gt,
1084         }
1085     }
1086 }
1087
1088 pub type BinOp = Spanned<BinOpKind>;
1089
1090 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy, Hash)]
1091 pub enum UnOp {
1092     /// The `*` operator for dereferencing
1093     UnDeref,
1094     /// The `!` operator for logical inversion
1095     UnNot,
1096     /// The `-` operator for negation
1097     UnNeg,
1098 }
1099
1100 impl UnOp {
1101     pub fn as_str(self) -> &'static str {
1102         match self {
1103             UnDeref => "*",
1104             UnNot => "!",
1105             UnNeg => "-",
1106         }
1107     }
1108
1109     /// Returns `true` if the unary operator takes its argument by value
1110     pub fn is_by_value(self) -> bool {
1111         match self {
1112             UnNeg | UnNot => true,
1113             _ => false,
1114         }
1115     }
1116 }
1117
1118 /// A statement
1119 pub type Stmt = Spanned<StmtKind>;
1120
1121 impl fmt::Debug for StmtKind {
1122     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1123         // Sadness.
1124         let spanned = source_map::dummy_spanned(self.clone());
1125         write!(f,
1126                "stmt({}: {})",
1127                spanned.node.id(),
1128                print::to_string(print::NO_ANN, |s| s.print_stmt(&spanned)))
1129     }
1130 }
1131
1132 #[derive(Clone, RustcEncodable, RustcDecodable)]
1133 pub enum StmtKind {
1134     /// Could be an item or a local (let) binding:
1135     Decl(P<Decl>, NodeId),
1136
1137     /// Expr without trailing semi-colon (must have unit type):
1138     Expr(P<Expr>, NodeId),
1139
1140     /// Expr with trailing semi-colon (may have any type):
1141     Semi(P<Expr>, NodeId),
1142 }
1143
1144 impl StmtKind {
1145     pub fn attrs(&self) -> &[Attribute] {
1146         match *self {
1147             StmtKind::Decl(ref d, _) => d.node.attrs(),
1148             StmtKind::Expr(ref e, _) |
1149             StmtKind::Semi(ref e, _) => &e.attrs,
1150         }
1151     }
1152
1153     pub fn id(&self) -> NodeId {
1154         match *self {
1155             StmtKind::Decl(_, id) => id,
1156             StmtKind::Expr(_, id) => id,
1157             StmtKind::Semi(_, id) => id,
1158         }
1159     }
1160 }
1161
1162 /// Local represents a `let` statement, e.g., `let <pat>:<ty> = <expr>;`
1163 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1164 pub struct Local {
1165     pub pat: P<Pat>,
1166     pub ty: Option<P<Ty>>,
1167     /// Initializer expression to set the value, if any
1168     pub init: Option<P<Expr>>,
1169     pub id: NodeId,
1170     pub hir_id: HirId,
1171     pub span: Span,
1172     pub attrs: ThinVec<Attribute>,
1173     pub source: LocalSource,
1174 }
1175
1176 pub type Decl = Spanned<DeclKind>;
1177
1178 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1179 pub enum DeclKind {
1180     /// A local (let) binding:
1181     Local(P<Local>),
1182     /// An item binding:
1183     Item(ItemId),
1184 }
1185
1186 impl DeclKind {
1187     pub fn attrs(&self) -> &[Attribute] {
1188         match *self {
1189             DeclKind::Local(ref l) => &l.attrs,
1190             DeclKind::Item(_) => &[]
1191         }
1192     }
1193
1194     pub fn is_local(&self) -> bool {
1195         match *self {
1196             DeclKind::Local(_) => true,
1197             _ => false,
1198         }
1199     }
1200 }
1201
1202 /// represents one arm of a 'match'
1203 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1204 pub struct Arm {
1205     pub attrs: HirVec<Attribute>,
1206     pub pats: HirVec<P<Pat>>,
1207     pub guard: Option<Guard>,
1208     pub body: P<Expr>,
1209 }
1210
1211 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1212 pub enum Guard {
1213     If(P<Expr>),
1214 }
1215
1216 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1217 pub struct Field {
1218     pub id: NodeId,
1219     pub ident: Ident,
1220     pub expr: P<Expr>,
1221     pub span: Span,
1222     pub is_shorthand: bool,
1223 }
1224
1225 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
1226 pub enum BlockCheckMode {
1227     DefaultBlock,
1228     UnsafeBlock(UnsafeSource),
1229     PushUnsafeBlock(UnsafeSource),
1230     PopUnsafeBlock(UnsafeSource),
1231 }
1232
1233 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
1234 pub enum UnsafeSource {
1235     CompilerGenerated,
1236     UserProvided,
1237 }
1238
1239 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable, Hash, Debug)]
1240 pub struct BodyId {
1241     pub node_id: NodeId,
1242 }
1243
1244 /// The body of a function, closure, or constant value. In the case of
1245 /// a function, the body contains not only the function body itself
1246 /// (which is an expression), but also the argument patterns, since
1247 /// those are something that the caller doesn't really care about.
1248 ///
1249 /// # Examples
1250 ///
1251 /// ```
1252 /// fn foo((x, y): (u32, u32)) -> u32 {
1253 ///     x + y
1254 /// }
1255 /// ```
1256 ///
1257 /// Here, the `Body` associated with `foo()` would contain:
1258 ///
1259 /// - an `arguments` array containing the `(x, y)` pattern
1260 /// - a `value` containing the `x + y` expression (maybe wrapped in a block)
1261 /// - `is_generator` would be false
1262 ///
1263 /// All bodies have an **owner**, which can be accessed via the HIR
1264 /// map using `body_owner_def_id()`.
1265 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1266 pub struct Body {
1267     pub arguments: HirVec<Arg>,
1268     pub value: Expr,
1269     pub is_generator: bool,
1270 }
1271
1272 impl Body {
1273     pub fn id(&self) -> BodyId {
1274         BodyId {
1275             node_id: self.value.id
1276         }
1277     }
1278 }
1279
1280 #[derive(Copy, Clone, Debug)]
1281 pub enum BodyOwnerKind {
1282     /// Functions and methods.
1283     Fn,
1284
1285     /// Constants and associated constants.
1286     Const,
1287
1288     /// Initializer of a `static` item.
1289     Static(Mutability),
1290 }
1291
1292 /// A constant (expression) that's not an item or associated item,
1293 /// but needs its own `DefId` for type-checking, const-eval, etc.
1294 /// These are usually found nested inside types (e.g. array lengths)
1295 /// or expressions (e.g. repeat counts), and also used to define
1296 /// explicit discriminant values for enum variants.
1297 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Debug)]
1298 pub struct AnonConst {
1299     pub id: NodeId,
1300     pub hir_id: HirId,
1301     pub body: BodyId,
1302 }
1303
1304 /// An expression
1305 #[derive(Clone, RustcEncodable, RustcDecodable)]
1306 pub struct Expr {
1307     pub id: NodeId,
1308     pub span: Span,
1309     pub node: ExprKind,
1310     pub attrs: ThinVec<Attribute>,
1311     pub hir_id: HirId,
1312 }
1313
1314 impl Expr {
1315     pub fn precedence(&self) -> ExprPrecedence {
1316         match self.node {
1317             ExprKind::Box(_) => ExprPrecedence::Box,
1318             ExprKind::Array(_) => ExprPrecedence::Array,
1319             ExprKind::Call(..) => ExprPrecedence::Call,
1320             ExprKind::MethodCall(..) => ExprPrecedence::MethodCall,
1321             ExprKind::Tup(_) => ExprPrecedence::Tup,
1322             ExprKind::Binary(op, ..) => ExprPrecedence::Binary(op.node.into()),
1323             ExprKind::Unary(..) => ExprPrecedence::Unary,
1324             ExprKind::Lit(_) => ExprPrecedence::Lit,
1325             ExprKind::Type(..) | ExprKind::Cast(..) => ExprPrecedence::Cast,
1326             ExprKind::If(..) => ExprPrecedence::If,
1327             ExprKind::While(..) => ExprPrecedence::While,
1328             ExprKind::Loop(..) => ExprPrecedence::Loop,
1329             ExprKind::Match(..) => ExprPrecedence::Match,
1330             ExprKind::Closure(..) => ExprPrecedence::Closure,
1331             ExprKind::Block(..) => ExprPrecedence::Block,
1332             ExprKind::Assign(..) => ExprPrecedence::Assign,
1333             ExprKind::AssignOp(..) => ExprPrecedence::AssignOp,
1334             ExprKind::Field(..) => ExprPrecedence::Field,
1335             ExprKind::Index(..) => ExprPrecedence::Index,
1336             ExprKind::Path(..) => ExprPrecedence::Path,
1337             ExprKind::AddrOf(..) => ExprPrecedence::AddrOf,
1338             ExprKind::Break(..) => ExprPrecedence::Break,
1339             ExprKind::Continue(..) => ExprPrecedence::Continue,
1340             ExprKind::Ret(..) => ExprPrecedence::Ret,
1341             ExprKind::InlineAsm(..) => ExprPrecedence::InlineAsm,
1342             ExprKind::Struct(..) => ExprPrecedence::Struct,
1343             ExprKind::Repeat(..) => ExprPrecedence::Repeat,
1344             ExprKind::Yield(..) => ExprPrecedence::Yield,
1345         }
1346     }
1347 }
1348
1349 impl fmt::Debug for Expr {
1350     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1351         write!(f, "expr({}: {})", self.id,
1352                print::to_string(print::NO_ANN, |s| s.print_expr(self)))
1353     }
1354 }
1355
1356 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1357 pub enum ExprKind {
1358     /// A `box x` expression.
1359     Box(P<Expr>),
1360     /// An array (`[a, b, c, d]`)
1361     Array(HirVec<Expr>),
1362     /// A function call
1363     ///
1364     /// The first field resolves to the function itself (usually an `ExprKind::Path`),
1365     /// and the second field is the list of arguments.
1366     /// This also represents calling the constructor of
1367     /// tuple-like ADTs such as tuple structs and enum variants.
1368     Call(P<Expr>, HirVec<Expr>),
1369     /// A method call (`x.foo::<'static, Bar, Baz>(a, b, c, d)`)
1370     ///
1371     /// The `PathSegment`/`Span` represent the method name and its generic arguments
1372     /// (within the angle brackets).
1373     /// The first element of the vector of `Expr`s is the expression that evaluates
1374     /// to the object on which the method is being called on (the receiver),
1375     /// and the remaining elements are the rest of the arguments.
1376     /// Thus, `x.foo::<Bar, Baz>(a, b, c, d)` is represented as
1377     /// `ExprKind::MethodCall(PathSegment { foo, [Bar, Baz] }, [x, a, b, c, d])`.
1378     MethodCall(PathSegment, Span, HirVec<Expr>),
1379     /// A tuple (`(a, b, c ,d)`)
1380     Tup(HirVec<Expr>),
1381     /// A binary operation (For example: `a + b`, `a * b`)
1382     Binary(BinOp, P<Expr>, P<Expr>),
1383     /// A unary operation (For example: `!x`, `*x`)
1384     Unary(UnOp, P<Expr>),
1385     /// A literal (For example: `1`, `"foo"`)
1386     Lit(P<Lit>),
1387     /// A cast (`foo as f64`)
1388     Cast(P<Expr>, P<Ty>),
1389     Type(P<Expr>, P<Ty>),
1390     /// An `if` block, with an optional else block
1391     ///
1392     /// `if expr { expr } else { expr }`
1393     If(P<Expr>, P<Expr>, Option<P<Expr>>),
1394     /// A while loop, with an optional label
1395     ///
1396     /// `'label: while expr { block }`
1397     While(P<Expr>, P<Block>, Option<Label>),
1398     /// Conditionless loop (can be exited with break, continue, or return)
1399     ///
1400     /// `'label: loop { block }`
1401     Loop(P<Block>, Option<Label>, LoopSource),
1402     /// A `match` block, with a source that indicates whether or not it is
1403     /// the result of a desugaring, and if so, which kind.
1404     Match(P<Expr>, HirVec<Arm>, MatchSource),
1405     /// A closure (for example, `move |a, b, c| {a + b + c}`).
1406     ///
1407     /// The final span is the span of the argument block `|...|`
1408     ///
1409     /// This may also be a generator literal, indicated by the final boolean,
1410     /// in that case there is an GeneratorClause.
1411     Closure(CaptureClause, P<FnDecl>, BodyId, Span, Option<GeneratorMovability>),
1412     /// A block (`'label: { ... }`)
1413     Block(P<Block>, Option<Label>),
1414
1415     /// An assignment (`a = foo()`)
1416     Assign(P<Expr>, P<Expr>),
1417     /// An assignment with an operator
1418     ///
1419     /// For example, `a += 1`.
1420     AssignOp(BinOp, P<Expr>, P<Expr>),
1421     /// Access of a named (`obj.foo`) or unnamed (`obj.0`) struct or tuple field
1422     Field(P<Expr>, Ident),
1423     /// An indexing operation (`foo[2]`)
1424     Index(P<Expr>, P<Expr>),
1425
1426     /// Path to a definition, possibly containing lifetime or type parameters.
1427     Path(QPath),
1428
1429     /// A referencing operation (`&a` or `&mut a`)
1430     AddrOf(Mutability, P<Expr>),
1431     /// A `break`, with an optional label to break
1432     Break(Destination, Option<P<Expr>>),
1433     /// A `continue`, with an optional label
1434     Continue(Destination),
1435     /// A `return`, with an optional value to be returned
1436     Ret(Option<P<Expr>>),
1437
1438     /// Inline assembly (from `asm!`), with its outputs and inputs.
1439     InlineAsm(P<InlineAsm>, HirVec<Expr>, HirVec<Expr>),
1440
1441     /// A struct or struct-like variant literal expression.
1442     ///
1443     /// For example, `Foo {x: 1, y: 2}`, or
1444     /// `Foo {x: 1, .. base}`, where `base` is the `Option<Expr>`.
1445     Struct(QPath, HirVec<Field>, Option<P<Expr>>),
1446
1447     /// An array literal constructed from one repeated element.
1448     ///
1449     /// For example, `[1; 5]`. The first expression is the element
1450     /// to be repeated; the second is the number of times to repeat it.
1451     Repeat(P<Expr>, AnonConst),
1452
1453     /// A suspension point for generators. This is `yield <expr>` in Rust.
1454     Yield(P<Expr>),
1455 }
1456
1457 /// Optionally `Self`-qualified value/type path or associated extension.
1458 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1459 pub enum QPath {
1460     /// Path to a definition, optionally "fully-qualified" with a `Self`
1461     /// type, if the path points to an associated item in a trait.
1462     ///
1463     /// E.g. an unqualified path like `Clone::clone` has `None` for `Self`,
1464     /// while `<Vec<T> as Clone>::clone` has `Some(Vec<T>)` for `Self`,
1465     /// even though they both have the same two-segment `Clone::clone` `Path`.
1466     Resolved(Option<P<Ty>>, P<Path>),
1467
1468     /// Type-related paths, e.g. `<T>::default` or `<T>::Output`.
1469     /// Will be resolved by type-checking to an associated item.
1470     ///
1471     /// UFCS source paths can desugar into this, with `Vec::new` turning into
1472     /// `<Vec>::new`, and `T::X::Y::method` into `<<<T>::X>::Y>::method`,
1473     /// the `X` and `Y` nodes each being a `TyKind::Path(QPath::TypeRelative(..))`.
1474     TypeRelative(P<Ty>, P<PathSegment>)
1475 }
1476
1477 /// Hints at the original code for a let statement
1478 #[derive(Clone, RustcEncodable, RustcDecodable, Debug, Copy)]
1479 pub enum LocalSource {
1480     /// A `match _ { .. }`
1481     Normal,
1482     /// A desugared `for _ in _ { .. }` loop
1483     ForLoopDesugar,
1484 }
1485
1486 /// Hints at the original code for a `match _ { .. }`
1487 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
1488 pub enum MatchSource {
1489     /// A `match _ { .. }`
1490     Normal,
1491     /// An `if let _ = _ { .. }` (optionally with `else { .. }`)
1492     IfLetDesugar {
1493         contains_else_clause: bool,
1494     },
1495     /// A `while let _ = _ { .. }` (which was desugared to a
1496     /// `loop { match _ { .. } }`)
1497     WhileLetDesugar,
1498     /// A desugared `for _ in _ { .. }` loop
1499     ForLoopDesugar,
1500     /// A desugared `?` operator
1501     TryDesugar,
1502 }
1503
1504 /// The loop type that yielded an ExprKind::Loop
1505 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
1506 pub enum LoopSource {
1507     /// A `loop { .. }` loop
1508     Loop,
1509     /// A `while let _ = _ { .. }` loop
1510     WhileLet,
1511     /// A `for _ in _ { .. }` loop
1512     ForLoop,
1513 }
1514
1515 #[derive(Clone, RustcEncodable, RustcDecodable, Debug, Copy)]
1516 pub enum LoopIdError {
1517     OutsideLoopScope,
1518     UnlabeledCfInWhileCondition,
1519     UnresolvedLabel,
1520 }
1521
1522 impl fmt::Display for LoopIdError {
1523     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1524         fmt::Display::fmt(match *self {
1525             LoopIdError::OutsideLoopScope => "not inside loop scope",
1526             LoopIdError::UnlabeledCfInWhileCondition =>
1527                 "unlabeled control flow (break or continue) in while condition",
1528             LoopIdError::UnresolvedLabel => "label not found",
1529         }, f)
1530     }
1531 }
1532
1533 #[derive(Clone, RustcEncodable, RustcDecodable, Debug, Copy)]
1534 pub struct Destination {
1535     // This is `Some(_)` iff there is an explicit user-specified `label
1536     pub label: Option<Label>,
1537
1538     // These errors are caught and then reported during the diagnostics pass in
1539     // librustc_passes/loops.rs
1540     pub target_id: Result<NodeId, LoopIdError>,
1541 }
1542
1543 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
1544 pub enum GeneratorMovability {
1545     Static,
1546     Movable,
1547 }
1548
1549 #[derive(Clone, RustcEncodable, RustcDecodable, Debug, Copy)]
1550 pub enum CaptureClause {
1551     CaptureByValue,
1552     CaptureByRef,
1553 }
1554
1555 // NB: If you change this, you'll probably want to change the corresponding
1556 // type structure in middle/ty.rs as well.
1557 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1558 pub struct MutTy {
1559     pub ty: P<Ty>,
1560     pub mutbl: Mutability,
1561 }
1562
1563 /// Represents a method's signature in a trait declaration or implementation.
1564 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1565 pub struct MethodSig {
1566     pub header: FnHeader,
1567     pub decl: P<FnDecl>,
1568 }
1569
1570 // The bodies for items are stored "out of line", in a separate
1571 // hashmap in the `Crate`. Here we just record the node-id of the item
1572 // so it can fetched later.
1573 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable, Debug)]
1574 pub struct TraitItemId {
1575     pub node_id: NodeId,
1576 }
1577
1578 /// Represents an item declaration within a trait declaration,
1579 /// possibly including a default implementation. A trait item is
1580 /// either required (meaning it doesn't have an implementation, just a
1581 /// signature) or provided (meaning it has a default implementation).
1582 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1583 pub struct TraitItem {
1584     pub id: NodeId,
1585     pub ident: Ident,
1586     pub hir_id: HirId,
1587     pub attrs: HirVec<Attribute>,
1588     pub generics: Generics,
1589     pub node: TraitItemKind,
1590     pub span: Span,
1591 }
1592
1593 /// A trait method's body (or just argument names).
1594 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1595 pub enum TraitMethod {
1596     /// No default body in the trait, just a signature.
1597     Required(HirVec<Ident>),
1598
1599     /// Both signature and body are provided in the trait.
1600     Provided(BodyId),
1601 }
1602
1603 /// Represents a trait method or associated constant or type
1604 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1605 pub enum TraitItemKind {
1606     /// An associated constant with an optional value (otherwise `impl`s
1607     /// must contain a value)
1608     Const(P<Ty>, Option<BodyId>),
1609     /// A method with an optional body
1610     Method(MethodSig, TraitMethod),
1611     /// An associated type with (possibly empty) bounds and optional concrete
1612     /// type
1613     Type(GenericBounds, Option<P<Ty>>),
1614 }
1615
1616 // The bodies for items are stored "out of line", in a separate
1617 // hashmap in the `Crate`. Here we just record the node-id of the item
1618 // so it can fetched later.
1619 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable, Debug)]
1620 pub struct ImplItemId {
1621     pub node_id: NodeId,
1622 }
1623
1624 /// Represents anything within an `impl` block
1625 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1626 pub struct ImplItem {
1627     pub id: NodeId,
1628     pub ident: Ident,
1629     pub hir_id: HirId,
1630     pub vis: Visibility,
1631     pub defaultness: Defaultness,
1632     pub attrs: HirVec<Attribute>,
1633     pub generics: Generics,
1634     pub node: ImplItemKind,
1635     pub span: Span,
1636 }
1637
1638 /// Represents different contents within `impl`s
1639 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1640 pub enum ImplItemKind {
1641     /// An associated constant of the given type, set to the constant result
1642     /// of the expression
1643     Const(P<Ty>, BodyId),
1644     /// A method implementation with the given signature and body
1645     Method(MethodSig, BodyId),
1646     /// An associated type
1647     Type(P<Ty>),
1648     /// An associated existential type
1649     Existential(GenericBounds),
1650 }
1651
1652 // Bind a type to an associated type: `A=Foo`.
1653 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1654 pub struct TypeBinding {
1655     pub id: NodeId,
1656     pub ident: Ident,
1657     pub ty: P<Ty>,
1658     pub span: Span,
1659 }
1660
1661
1662 #[derive(Clone, RustcEncodable, RustcDecodable)]
1663 pub struct Ty {
1664     pub id: NodeId,
1665     pub node: TyKind,
1666     pub span: Span,
1667     pub hir_id: HirId,
1668 }
1669
1670 impl fmt::Debug for Ty {
1671     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1672         write!(f, "type({})",
1673                print::to_string(print::NO_ANN, |s| s.print_type(self)))
1674     }
1675 }
1676
1677 /// Not represented directly in the AST, referred to by name through a ty_path.
1678 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
1679 pub enum PrimTy {
1680     Int(IntTy),
1681     Uint(UintTy),
1682     Float(FloatTy),
1683     Str,
1684     Bool,
1685     Char,
1686 }
1687
1688 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1689 pub struct BareFnTy {
1690     pub unsafety: Unsafety,
1691     pub abi: Abi,
1692     pub generic_params: HirVec<GenericParam>,
1693     pub decl: P<FnDecl>,
1694     pub arg_names: HirVec<Ident>,
1695 }
1696
1697 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1698 pub struct ExistTy {
1699     pub generics: Generics,
1700     pub bounds: GenericBounds,
1701     pub impl_trait_fn: Option<DefId>,
1702 }
1703
1704 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1705 /// The different kinds of types recognized by the compiler
1706 pub enum TyKind {
1707     /// A variable length slice (`[T]`)
1708     Slice(P<Ty>),
1709     /// A fixed length array (`[T; n]`)
1710     Array(P<Ty>, AnonConst),
1711     /// A raw pointer (`*const T` or `*mut T`)
1712     Ptr(MutTy),
1713     /// A reference (`&'a T` or `&'a mut T`)
1714     Rptr(Lifetime, MutTy),
1715     /// A bare function (e.g. `fn(usize) -> bool`)
1716     BareFn(P<BareFnTy>),
1717     /// The never type (`!`)
1718     Never,
1719     /// A tuple (`(A, B, C, D,...)`)
1720     Tup(HirVec<Ty>),
1721     /// A path to a type definition (`module::module::...::Type`), or an
1722     /// associated type, e.g. `<Vec<T> as Trait>::Type` or `<T>::Target`.
1723     ///
1724     /// Type parameters may be stored in each `PathSegment`.
1725     Path(QPath),
1726     /// A trait object type `Bound1 + Bound2 + Bound3`
1727     /// where `Bound` is a trait or a lifetime.
1728     TraitObject(HirVec<PolyTraitRef>, Lifetime),
1729     /// Unused for now
1730     Typeof(AnonConst),
1731     /// TyKind::Infer means the type should be inferred instead of it having been
1732     /// specified. This can appear anywhere in a type.
1733     Infer,
1734     /// Placeholder for a type that has failed to be defined.
1735     Err,
1736 }
1737
1738 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1739 pub struct InlineAsmOutput {
1740     pub constraint: Symbol,
1741     pub is_rw: bool,
1742     pub is_indirect: bool,
1743 }
1744
1745 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1746 pub struct InlineAsm {
1747     pub asm: Symbol,
1748     pub asm_str_style: StrStyle,
1749     pub outputs: HirVec<InlineAsmOutput>,
1750     pub inputs: HirVec<Symbol>,
1751     pub clobbers: HirVec<Symbol>,
1752     pub volatile: bool,
1753     pub alignstack: bool,
1754     pub dialect: AsmDialect,
1755     pub ctxt: SyntaxContext,
1756 }
1757
1758 /// represents an argument in a function header
1759 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1760 pub struct Arg {
1761     pub pat: P<Pat>,
1762     pub id: NodeId,
1763     pub hir_id: HirId,
1764 }
1765
1766 /// Represents the header (not the body) of a function declaration
1767 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1768 pub struct FnDecl {
1769     pub inputs: HirVec<Ty>,
1770     pub output: FunctionRetTy,
1771     pub variadic: bool,
1772     /// True if this function has an `self`, `&self` or `&mut self` receiver
1773     /// (but not a `self: Xxx` one).
1774     pub has_implicit_self: bool,
1775 }
1776
1777 /// Is the trait definition an auto trait?
1778 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
1779 pub enum IsAuto {
1780     Yes,
1781     No
1782 }
1783
1784 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable, Debug)]
1785 pub enum IsAsync {
1786     Async,
1787     NotAsync,
1788 }
1789
1790 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable, Hash, Debug)]
1791 pub enum Unsafety {
1792     Unsafe,
1793     Normal,
1794 }
1795
1796 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
1797 pub enum Constness {
1798     Const,
1799     NotConst,
1800 }
1801
1802 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
1803 pub enum Defaultness {
1804     Default { has_value: bool },
1805     Final,
1806 }
1807
1808 impl Defaultness {
1809     pub fn has_value(&self) -> bool {
1810         match *self {
1811             Defaultness::Default { has_value, .. } => has_value,
1812             Defaultness::Final => true,
1813         }
1814     }
1815
1816     pub fn is_final(&self) -> bool {
1817         *self == Defaultness::Final
1818     }
1819
1820     pub fn is_default(&self) -> bool {
1821         match *self {
1822             Defaultness::Default { .. } => true,
1823             _ => false,
1824         }
1825     }
1826 }
1827
1828 impl fmt::Display for Unsafety {
1829     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1830         fmt::Display::fmt(match *self {
1831                               Unsafety::Normal => "normal",
1832                               Unsafety::Unsafe => "unsafe",
1833                           },
1834                           f)
1835     }
1836 }
1837
1838 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable)]
1839 pub enum ImplPolarity {
1840     /// `impl Trait for Type`
1841     Positive,
1842     /// `impl !Trait for Type`
1843     Negative,
1844 }
1845
1846 impl fmt::Debug for ImplPolarity {
1847     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1848         match *self {
1849             ImplPolarity::Positive => "positive".fmt(f),
1850             ImplPolarity::Negative => "negative".fmt(f),
1851         }
1852     }
1853 }
1854
1855
1856 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1857 pub enum FunctionRetTy {
1858     /// Return type is not specified.
1859     ///
1860     /// Functions default to `()` and
1861     /// closures default to inference. Span points to where return
1862     /// type would be inserted.
1863     DefaultReturn(Span),
1864     /// Everything else
1865     Return(P<Ty>),
1866 }
1867
1868 impl FunctionRetTy {
1869     pub fn span(&self) -> Span {
1870         match *self {
1871             DefaultReturn(span) => span,
1872             Return(ref ty) => ty.span,
1873         }
1874     }
1875 }
1876
1877 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1878 pub struct Mod {
1879     /// A span from the first token past `{` to the last token until `}`.
1880     /// For `mod foo;`, the inner span ranges from the first token
1881     /// to the last token in the external file.
1882     pub inner: Span,
1883     pub item_ids: HirVec<ItemId>,
1884 }
1885
1886 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1887 pub struct ForeignMod {
1888     pub abi: Abi,
1889     pub items: HirVec<ForeignItem>,
1890 }
1891
1892 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1893 pub struct GlobalAsm {
1894     pub asm: Symbol,
1895     pub ctxt: SyntaxContext,
1896 }
1897
1898 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1899 pub struct EnumDef {
1900     pub variants: HirVec<Variant>,
1901 }
1902
1903 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1904 pub struct VariantKind {
1905     pub name: Name,
1906     pub attrs: HirVec<Attribute>,
1907     pub data: VariantData,
1908     /// Explicit discriminant, eg `Foo = 1`
1909     pub disr_expr: Option<AnonConst>,
1910 }
1911
1912 pub type Variant = Spanned<VariantKind>;
1913
1914 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
1915 pub enum UseKind {
1916     /// One import, e.g. `use foo::bar` or `use foo::bar as baz`.
1917     /// Also produced for each element of a list `use`, e.g.
1918     // `use foo::{a, b}` lowers to `use foo::a; use foo::b;`.
1919     Single,
1920
1921     /// Glob import, e.g. `use foo::*`.
1922     Glob,
1923
1924     /// Degenerate list import, e.g. `use foo::{a, b}` produces
1925     /// an additional `use foo::{}` for performing checks such as
1926     /// unstable feature gating. May be removed in the future.
1927     ListStem,
1928 }
1929
1930 /// TraitRef's appear in impls.
1931 ///
1932 /// resolve maps each TraitRef's ref_id to its defining trait; that's all
1933 /// that the ref_id is for. Note that ref_id's value is not the NodeId of the
1934 /// trait being referred to but just a unique NodeId that serves as a key
1935 /// within the DefMap.
1936 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1937 pub struct TraitRef {
1938     pub path: Path,
1939     pub ref_id: NodeId,
1940     pub hir_ref_id: HirId,
1941 }
1942
1943 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1944 pub struct PolyTraitRef {
1945     /// The `'a` in `<'a> Foo<&'a T>`
1946     pub bound_generic_params: HirVec<GenericParam>,
1947
1948     /// The `Foo<&'a T>` in `<'a> Foo<&'a T>`
1949     pub trait_ref: TraitRef,
1950
1951     pub span: Span,
1952 }
1953
1954 pub type Visibility = Spanned<VisibilityKind>;
1955
1956 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1957 pub enum VisibilityKind {
1958     Public,
1959     Crate(CrateSugar),
1960     Restricted { path: P<Path>, id: NodeId, hir_id: HirId },
1961     Inherited,
1962 }
1963
1964 impl VisibilityKind {
1965     pub fn is_pub(&self) -> bool {
1966         match *self {
1967             VisibilityKind::Public => true,
1968             _ => false
1969         }
1970     }
1971
1972     pub fn is_pub_restricted(&self) -> bool {
1973         match *self {
1974             VisibilityKind::Public |
1975             VisibilityKind::Inherited => false,
1976             VisibilityKind::Crate(..) |
1977             VisibilityKind::Restricted { .. } => true,
1978         }
1979     }
1980 }
1981
1982 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1983 pub struct StructField {
1984     pub span: Span,
1985     pub ident: Ident,
1986     pub vis: Visibility,
1987     pub id: NodeId,
1988     pub ty: P<Ty>,
1989     pub attrs: HirVec<Attribute>,
1990 }
1991
1992 impl StructField {
1993     // Still necessary in couple of places
1994     pub fn is_positional(&self) -> bool {
1995         let first = self.ident.as_str().as_bytes()[0];
1996         first >= b'0' && first <= b'9'
1997     }
1998 }
1999
2000 /// Fields and Ids of enum variants and structs
2001 ///
2002 /// For enum variants: `NodeId` represents both an Id of the variant itself (relevant for all
2003 /// variant kinds) and an Id of the variant's constructor (not relevant for `Struct`-variants).
2004 /// One shared Id can be successfully used for these two purposes.
2005 /// Id of the whole enum lives in `Item`.
2006 ///
2007 /// For structs: `NodeId` represents an Id of the structure's constructor, so it is not actually
2008 /// used for `Struct`-structs (but still presents). Structures don't have an analogue of "Id of
2009 /// the variant itself" from enum variants.
2010 /// Id of the whole struct lives in `Item`.
2011 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2012 pub enum VariantData {
2013     Struct(HirVec<StructField>, NodeId),
2014     Tuple(HirVec<StructField>, NodeId),
2015     Unit(NodeId),
2016 }
2017
2018 impl VariantData {
2019     pub fn fields(&self) -> &[StructField] {
2020         match *self {
2021             VariantData::Struct(ref fields, _) | VariantData::Tuple(ref fields, _) => fields,
2022             _ => &[],
2023         }
2024     }
2025     pub fn id(&self) -> NodeId {
2026         match *self {
2027             VariantData::Struct(_, id) | VariantData::Tuple(_, id) | VariantData::Unit(id) => id,
2028         }
2029     }
2030     pub fn is_struct(&self) -> bool {
2031         if let VariantData::Struct(..) = *self {
2032             true
2033         } else {
2034             false
2035         }
2036     }
2037     pub fn is_tuple(&self) -> bool {
2038         if let VariantData::Tuple(..) = *self {
2039             true
2040         } else {
2041             false
2042         }
2043     }
2044     pub fn is_unit(&self) -> bool {
2045         if let VariantData::Unit(..) = *self {
2046             true
2047         } else {
2048             false
2049         }
2050     }
2051 }
2052
2053 // The bodies for items are stored "out of line", in a separate
2054 // hashmap in the `Crate`. Here we just record the node-id of the item
2055 // so it can fetched later.
2056 #[derive(Copy, Clone, RustcEncodable, RustcDecodable, Debug)]
2057 pub struct ItemId {
2058     pub id: NodeId,
2059 }
2060
2061 /// An item
2062 ///
2063 /// The name might be a dummy name in case of anonymous items
2064 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2065 pub struct Item {
2066     pub name: Name,
2067     pub id: NodeId,
2068     pub hir_id: HirId,
2069     pub attrs: HirVec<Attribute>,
2070     pub node: ItemKind,
2071     pub vis: Visibility,
2072     pub span: Span,
2073 }
2074
2075 #[derive(Clone, Copy, RustcEncodable, RustcDecodable, Debug)]
2076 pub struct FnHeader {
2077     pub unsafety: Unsafety,
2078     pub constness: Constness,
2079     pub asyncness: IsAsync,
2080     pub abi: Abi,
2081 }
2082
2083 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2084 pub enum ItemKind {
2085     /// An `extern crate` item, with optional *original* crate name if the crate was renamed.
2086     ///
2087     /// E.g. `extern crate foo` or `extern crate foo_bar as foo`
2088     ExternCrate(Option<Name>),
2089
2090     /// `use foo::bar::*;` or `use foo::bar::baz as quux;`
2091     ///
2092     /// or just
2093     ///
2094     /// `use foo::bar::baz;` (with `as baz` implicitly on the right)
2095     Use(P<Path>, UseKind),
2096
2097     /// A `static` item
2098     Static(P<Ty>, Mutability, BodyId),
2099     /// A `const` item
2100     Const(P<Ty>, BodyId),
2101     /// A function declaration
2102     Fn(P<FnDecl>, FnHeader, Generics, BodyId),
2103     /// A module
2104     Mod(Mod),
2105     /// An external module
2106     ForeignMod(ForeignMod),
2107     /// Module-level inline assembly (from global_asm!)
2108     GlobalAsm(P<GlobalAsm>),
2109     /// A type alias, e.g. `type Foo = Bar<u8>`
2110     Ty(P<Ty>, Generics),
2111     /// An existential type definition, e.g. `existential type Foo: Bar;`
2112     Existential(ExistTy),
2113     /// An enum definition, e.g. `enum Foo<A, B> {C<A>, D<B>}`
2114     Enum(EnumDef, Generics),
2115     /// A struct definition, e.g. `struct Foo<A> {x: A}`
2116     Struct(VariantData, Generics),
2117     /// A union definition, e.g. `union Foo<A, B> {x: A, y: B}`
2118     Union(VariantData, Generics),
2119     /// Represents a Trait Declaration
2120     Trait(IsAuto, Unsafety, Generics, GenericBounds, HirVec<TraitItemRef>),
2121     /// Represents a Trait Alias Declaration
2122     TraitAlias(Generics, GenericBounds),
2123
2124     /// An implementation, eg `impl<A> Trait for Foo { .. }`
2125     Impl(Unsafety,
2126          ImplPolarity,
2127          Defaultness,
2128          Generics,
2129          Option<TraitRef>, // (optional) trait this impl implements
2130          P<Ty>, // self
2131          HirVec<ImplItemRef>),
2132 }
2133
2134 impl ItemKind {
2135     pub fn descriptive_variant(&self) -> &str {
2136         match *self {
2137             ItemKind::ExternCrate(..) => "extern crate",
2138             ItemKind::Use(..) => "use",
2139             ItemKind::Static(..) => "static item",
2140             ItemKind::Const(..) => "constant item",
2141             ItemKind::Fn(..) => "function",
2142             ItemKind::Mod(..) => "module",
2143             ItemKind::ForeignMod(..) => "foreign module",
2144             ItemKind::GlobalAsm(..) => "global asm",
2145             ItemKind::Ty(..) => "type alias",
2146             ItemKind::Existential(..) => "existential type",
2147             ItemKind::Enum(..) => "enum",
2148             ItemKind::Struct(..) => "struct",
2149             ItemKind::Union(..) => "union",
2150             ItemKind::Trait(..) => "trait",
2151             ItemKind::TraitAlias(..) => "trait alias",
2152             ItemKind::Impl(..) => "item",
2153         }
2154     }
2155
2156     pub fn adt_kind(&self) -> Option<AdtKind> {
2157         match *self {
2158             ItemKind::Struct(..) => Some(AdtKind::Struct),
2159             ItemKind::Union(..) => Some(AdtKind::Union),
2160             ItemKind::Enum(..) => Some(AdtKind::Enum),
2161             _ => None,
2162         }
2163     }
2164
2165     pub fn generics(&self) -> Option<&Generics> {
2166         Some(match *self {
2167             ItemKind::Fn(_, _, ref generics, _) |
2168             ItemKind::Ty(_, ref generics) |
2169             ItemKind::Existential(ExistTy { ref generics, impl_trait_fn: None, .. }) |
2170             ItemKind::Enum(_, ref generics) |
2171             ItemKind::Struct(_, ref generics) |
2172             ItemKind::Union(_, ref generics) |
2173             ItemKind::Trait(_, _, ref generics, _, _) |
2174             ItemKind::Impl(_, _, _, ref generics, _, _, _)=> generics,
2175             _ => return None
2176         })
2177     }
2178 }
2179
2180 /// A reference from an trait to one of its associated items. This
2181 /// contains the item's id, naturally, but also the item's name and
2182 /// some other high-level details (like whether it is an associated
2183 /// type or method, and whether it is public). This allows other
2184 /// passes to find the impl they want without loading the id (which
2185 /// means fewer edges in the incremental compilation graph).
2186 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2187 pub struct TraitItemRef {
2188     pub id: TraitItemId,
2189     pub ident: Ident,
2190     pub kind: AssociatedItemKind,
2191     pub span: Span,
2192     pub defaultness: Defaultness,
2193 }
2194
2195 /// A reference from an impl to one of its associated items. This
2196 /// contains the item's id, naturally, but also the item's name and
2197 /// some other high-level details (like whether it is an associated
2198 /// type or method, and whether it is public). This allows other
2199 /// passes to find the impl they want without loading the id (which
2200 /// means fewer edges in the incremental compilation graph).
2201 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2202 pub struct ImplItemRef {
2203     pub id: ImplItemId,
2204     pub ident: Ident,
2205     pub kind: AssociatedItemKind,
2206     pub span: Span,
2207     pub vis: Visibility,
2208     pub defaultness: Defaultness,
2209 }
2210
2211 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
2212 pub enum AssociatedItemKind {
2213     Const,
2214     Method { has_self: bool },
2215     Type,
2216     Existential,
2217 }
2218
2219 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2220 pub struct ForeignItem {
2221     pub name: Name,
2222     pub attrs: HirVec<Attribute>,
2223     pub node: ForeignItemKind,
2224     pub id: NodeId,
2225     pub span: Span,
2226     pub vis: Visibility,
2227 }
2228
2229 /// An item within an `extern` block
2230 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2231 pub enum ForeignItemKind {
2232     /// A foreign function
2233     Fn(P<FnDecl>, HirVec<Ident>, Generics),
2234     /// A foreign static item (`static ext: u8`), with optional mutability
2235     /// (the boolean is true when mutable)
2236     Static(P<Ty>, bool),
2237     /// A foreign type
2238     Type,
2239 }
2240
2241 impl ForeignItemKind {
2242     pub fn descriptive_variant(&self) -> &str {
2243         match *self {
2244             ForeignItemKind::Fn(..) => "foreign function",
2245             ForeignItemKind::Static(..) => "foreign static item",
2246             ForeignItemKind::Type => "foreign type",
2247         }
2248     }
2249 }
2250
2251 /// A free variable referred to in a function.
2252 #[derive(Debug, Copy, Clone, RustcEncodable, RustcDecodable)]
2253 pub struct Freevar {
2254     /// The variable being accessed free.
2255     pub def: Def,
2256
2257     // First span where it is accessed (there can be multiple).
2258     pub span: Span
2259 }
2260
2261 impl Freevar {
2262     pub fn var_id(&self) -> NodeId {
2263         match self.def {
2264             Def::Local(id) | Def::Upvar(id, ..) => id,
2265             _ => bug!("Freevar::var_id: bad def ({:?})", self.def)
2266         }
2267     }
2268 }
2269
2270 pub type FreevarMap = NodeMap<Vec<Freevar>>;
2271
2272 pub type CaptureModeMap = NodeMap<CaptureClause>;
2273
2274 #[derive(Clone, Debug)]
2275 pub struct TraitCandidate {
2276     pub def_id: DefId,
2277     pub import_id: Option<NodeId>,
2278 }
2279
2280 // Trait method resolution
2281 pub type TraitMap = NodeMap<Vec<TraitCandidate>>;
2282
2283 // Map from the NodeId of a glob import to a list of items which are actually
2284 // imported.
2285 pub type GlobMap = NodeMap<FxHashSet<Name>>;
2286
2287
2288 pub fn provide(providers: &mut Providers) {
2289     providers.describe_def = map::describe_def;
2290 }
2291
2292 #[derive(Clone, RustcEncodable, RustcDecodable)]
2293 pub struct CodegenFnAttrs {
2294     pub flags: CodegenFnAttrFlags,
2295     /// Parsed representation of the `#[inline]` attribute
2296     pub inline: InlineAttr,
2297     /// The `#[export_name = "..."]` attribute, indicating a custom symbol a
2298     /// function should be exported under
2299     pub export_name: Option<Symbol>,
2300     /// The `#[link_name = "..."]` attribute, indicating a custom symbol an
2301     /// imported function should be imported as. Note that `export_name`
2302     /// probably isn't set when this is set, this is for foreign items while
2303     /// `#[export_name]` is for Rust-defined functions.
2304     pub link_name: Option<Symbol>,
2305     /// The `#[target_feature(enable = "...")]` attribute and the enabled
2306     /// features (only enabled features are supported right now).
2307     pub target_features: Vec<Symbol>,
2308     /// The `#[linkage = "..."]` attribute and the value we found.
2309     pub linkage: Option<Linkage>,
2310     /// The `#[link_section = "..."]` attribute, or what executable section this
2311     /// should be placed in.
2312     pub link_section: Option<Symbol>,
2313 }
2314
2315 bitflags! {
2316     #[derive(RustcEncodable, RustcDecodable)]
2317     pub struct CodegenFnAttrFlags: u32 {
2318         /// #[cold], a hint to LLVM that this function, when called, is never on
2319         /// the hot path
2320         const COLD                      = 1 << 0;
2321         /// #[allocator], a hint to LLVM that the pointer returned from this
2322         /// function is never null
2323         const ALLOCATOR                 = 1 << 1;
2324         /// #[unwind], an indicator that this function may unwind despite what
2325         /// its ABI signature may otherwise imply
2326         const UNWIND                    = 1 << 2;
2327         /// #[rust_allocator_nounwind], an indicator that an imported FFI
2328         /// function will never unwind. Probably obsolete by recent changes with
2329         /// #[unwind], but hasn't been removed/migrated yet
2330         const RUSTC_ALLOCATOR_NOUNWIND  = 1 << 3;
2331         /// #[naked], indicates to LLVM that no function prologue/epilogue
2332         /// should be generated
2333         const NAKED                     = 1 << 4;
2334         /// #[no_mangle], the function's name should be the same as its symbol
2335         const NO_MANGLE                 = 1 << 5;
2336         /// #[rustc_std_internal_symbol], and indicator that this symbol is a
2337         /// "weird symbol" for the standard library in that it has slightly
2338         /// different linkage, visibility, and reachability rules.
2339         const RUSTC_STD_INTERNAL_SYMBOL = 1 << 6;
2340         /// #[no_debug], indicates that no debugging information should be
2341         /// generated for this function by LLVM
2342         const NO_DEBUG                  = 1 << 7;
2343         /// #[thread_local], indicates a static is actually a thread local
2344         /// piece of memory
2345         const THREAD_LOCAL              = 1 << 8;
2346         /// #[used], indicates that LLVM can't eliminate this function (but the
2347         /// linker can!)
2348         const USED                      = 1 << 9;
2349     }
2350 }
2351
2352 impl CodegenFnAttrs {
2353     pub fn new() -> CodegenFnAttrs {
2354         CodegenFnAttrs {
2355             flags: CodegenFnAttrFlags::empty(),
2356             inline: InlineAttr::None,
2357             export_name: None,
2358             link_name: None,
2359             target_features: vec![],
2360             linkage: None,
2361             link_section: None,
2362         }
2363     }
2364
2365     /// True if `#[inline]` or `#[inline(always)]` is present.
2366     pub fn requests_inline(&self) -> bool {
2367         match self.inline {
2368             InlineAttr::Hint | InlineAttr::Always => true,
2369             InlineAttr::None | InlineAttr::Never => false,
2370         }
2371     }
2372
2373     /// True if `#[no_mangle]` or `#[export_name(...)]` is present.
2374     pub fn contains_extern_indicator(&self) -> bool {
2375         self.flags.contains(CodegenFnAttrFlags::NO_MANGLE) || self.export_name.is_some()
2376     }
2377 }
2378
2379 #[derive(Copy, Clone, Debug)]
2380 pub enum Node<'hir> {
2381     Item(&'hir Item),
2382     ForeignItem(&'hir ForeignItem),
2383     TraitItem(&'hir TraitItem),
2384     ImplItem(&'hir ImplItem),
2385     Variant(&'hir Variant),
2386     Field(&'hir StructField),
2387     AnonConst(&'hir AnonConst),
2388     Expr(&'hir Expr),
2389     Stmt(&'hir Stmt),
2390     Ty(&'hir Ty),
2391     TraitRef(&'hir TraitRef),
2392     Binding(&'hir Pat),
2393     Pat(&'hir Pat),
2394     Block(&'hir Block),
2395     Local(&'hir Local),
2396     MacroDef(&'hir MacroDef),
2397
2398     /// StructCtor represents a tuple struct.
2399     StructCtor(&'hir VariantData),
2400
2401     Lifetime(&'hir Lifetime),
2402     GenericParam(&'hir GenericParam),
2403     Visibility(&'hir Visibility),
2404
2405     Crate,
2406 }