src/librustc/hir/mod.rs

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