src/libsyntax/ast.rs

   1 // The Rust abstract syntax tree.
   2
   3 pub use GenericArgs::*;
   4 pub use UnsafeSource::*;
   5 pub use crate::symbol::{Ident, Symbol as Name};
   6 pub use crate::util::parser::ExprPrecedence;
   7
   8 use crate::ext::hygiene::{Mark, SyntaxContext};
   9 use crate::parse::token;
  10 use crate::print::pprust;
  11 use crate::ptr::P;
  12 use crate::source_map::{dummy_spanned, respan, Spanned};
  13 use crate::symbol::{kw, Symbol};
  14 use crate::tokenstream::TokenStream;
  15 use crate::ThinVec;
  16
  17 use rustc_data_structures::indexed_vec::Idx;
  18 #[cfg(target_arch = "x86_64")]
  19 use rustc_data_structures::static_assert_size;
  20 use rustc_target::spec::abi::Abi;
  21 use syntax_pos::{Span, DUMMY_SP};
  22
  23 use rustc_data_structures::fx::FxHashSet;
  24 use rustc_data_structures::sync::Lrc;
  25 use serialize::{self, Decoder, Encoder};
  26 use std::fmt;
  27
  28 pub use rustc_target::abi::FloatTy;
  29
  30 #[derive(Clone, RustcEncodable, RustcDecodable, Copy)]
  31 pub struct Label {
  32     pub ident: Ident,
  33 }
  34
  35 impl fmt::Debug for Label {
  36     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  37         write!(f, "label({:?})", self.ident)
  38     }
  39 }
  40
  41 #[derive(Clone, RustcEncodable, RustcDecodable, Copy)]
  42 pub struct Lifetime {
  43     pub id: NodeId,
  44     pub ident: Ident,
  45 }
  46
  47 impl fmt::Debug for Lifetime {
  48     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  49         write!(
  50             f,
  51             "lifetime({}: {})",
  52             self.id,
  53             pprust::lifetime_to_string(self)
  54         )
  55     }
  56 }
  57
  58 /// A "Path" is essentially Rust's notion of a name.
  59 ///
  60 /// It's represented as a sequence of identifiers,
  61 /// along with a bunch of supporting information.
  62 ///
  63 /// E.g., `std::cmp::PartialEq`.
  64 #[derive(Clone, RustcEncodable, RustcDecodable)]
  65 pub struct Path {
  66     pub span: Span,
  67     /// The segments in the path: the things separated by `::`.
  68     /// Global paths begin with `kw::PathRoot`.
  69     pub segments: Vec<PathSegment>,
  70 }
  71
  72 impl PartialEq<Symbol> for Path {
  73     fn eq(&self, symbol: &Symbol) -> bool {
  74         self.segments.len() == 1 && {
  75             self.segments[0].ident.name == *symbol
  76         }
  77     }
  78 }
  79
  80 impl fmt::Debug for Path {
  81     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  82         write!(f, "path({})", pprust::path_to_string(self))
  83     }
  84 }
  85
  86 impl fmt::Display for Path {
  87     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  88         write!(f, "{}", pprust::path_to_string(self))
  89     }
  90 }
  91
  92 impl Path {
  93     // Convert a span and an identifier to the corresponding
  94     // one-segment path.
  95     pub fn from_ident(ident: Ident) -> Path {
  96         Path {
  97             segments: vec![PathSegment::from_ident(ident)],
  98             span: ident.span,
  99         }
 100     }
 101
 102     pub fn is_global(&self) -> bool {
 103         !self.segments.is_empty() && self.segments[0].ident.name == kw::PathRoot
 104     }
 105 }
 106
 107 /// A segment of a path: an identifier, an optional lifetime, and a set of types.
 108 ///
 109 /// E.g., `std`, `String` or `Box<T>`.
 110 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 111 pub struct PathSegment {
 112     /// The identifier portion of this path segment.
 113     pub ident: Ident,
 114
 115     pub id: NodeId,
 116
 117     /// Type/lifetime parameters attached to this path. They come in
 118     /// two flavors: `Path<A,B,C>` and `Path(A,B) -> C`.
 119     /// `None` means that no parameter list is supplied (`Path`),
 120     /// `Some` means that parameter list is supplied (`Path<X, Y>`)
 121     /// but it can be empty (`Path<>`).
 122     /// `P` is used as a size optimization for the common case with no parameters.
 123     pub args: Option<P<GenericArgs>>,
 124 }
 125
 126 impl PathSegment {
 127     pub fn from_ident(ident: Ident) -> Self {
 128         PathSegment { ident, id: DUMMY_NODE_ID, args: None }
 129     }
 130     pub fn path_root(span: Span) -> Self {
 131         PathSegment::from_ident(Ident::new(kw::PathRoot, span))
 132     }
 133 }
 134
 135 /// The arguments of a path segment.
 136 ///
 137 /// E.g., `<A, B>` as in `Foo<A, B>` or `(A, B)` as in `Foo(A, B)`.
 138 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 139 pub enum GenericArgs {
 140     /// The `<'a, A, B, C>` in `foo::bar::baz::<'a, A, B, C>`.
 141     AngleBracketed(AngleBracketedArgs),
 142     /// The `(A, B)` and `C` in `Foo(A, B) -> C`.
 143     Parenthesized(ParenthesizedArgs),
 144 }
 145
 146 impl GenericArgs {
 147     pub fn is_parenthesized(&self) -> bool {
 148         match *self {
 149             Parenthesized(..) => true,
 150             _ => false,
 151         }
 152     }
 153
 154     pub fn is_angle_bracketed(&self) -> bool {
 155         match *self {
 156             AngleBracketed(..) => true,
 157             _ => false,
 158         }
 159     }
 160
 161     pub fn span(&self) -> Span {
 162         match *self {
 163             AngleBracketed(ref data) => data.span,
 164             Parenthesized(ref data) => data.span,
 165         }
 166     }
 167 }
 168
 169 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 170 pub enum GenericArg {
 171     Lifetime(Lifetime),
 172     Type(P<Ty>),
 173     Const(AnonConst),
 174 }
 175
 176 impl GenericArg {
 177     pub fn span(&self) -> Span {
 178         match self {
 179             GenericArg::Lifetime(lt) => lt.ident.span,
 180             GenericArg::Type(ty) => ty.span,
 181             GenericArg::Const(ct) => ct.value.span,
 182         }
 183     }
 184 }
 185
 186 /// A path like `Foo<'a, T>`.
 187 #[derive(Clone, RustcEncodable, RustcDecodable, Debug, Default)]
 188 pub struct AngleBracketedArgs {
 189     /// The overall span.
 190     pub span: Span,
 191     /// The arguments for this path segment.
 192     pub args: Vec<GenericArg>,
 193     /// Bindings (equality constraints) on associated types, if present.
 194     /// E.g., `Foo<A = Bar>`.
 195     pub bindings: Vec<TypeBinding>,
 196 }
 197
 198 impl Into<Option<P<GenericArgs>>> for AngleBracketedArgs {
 199     fn into(self) -> Option<P<GenericArgs>> {
 200         Some(P(GenericArgs::AngleBracketed(self)))
 201     }
 202 }
 203
 204 impl Into<Option<P<GenericArgs>>> for ParenthesizedArgs {
 205     fn into(self) -> Option<P<GenericArgs>> {
 206         Some(P(GenericArgs::Parenthesized(self)))
 207     }
 208 }
 209
 210 /// A path like `Foo(A, B) -> C`.
 211 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 212 pub struct ParenthesizedArgs {
 213     /// Overall span
 214     pub span: Span,
 215
 216     /// `(A,B)`
 217     pub inputs: Vec<P<Ty>>,
 218
 219     /// `C`
 220     pub output: Option<P<Ty>>,
 221 }
 222
 223 impl ParenthesizedArgs {
 224     pub fn as_angle_bracketed_args(&self) -> AngleBracketedArgs {
 225         AngleBracketedArgs {
 226             span: self.span,
 227             args: self.inputs.iter().cloned().map(|input| GenericArg::Type(input)).collect(),
 228             bindings: vec![],
 229         }
 230     }
 231 }
 232
 233 // hack to ensure that we don't try to access the private parts of `NodeId` in this module
 234 mod node_id_inner {
 235     use rustc_data_structures::indexed_vec::Idx;
 236     use rustc_data_structures::newtype_index;
 237     newtype_index! {
 238         pub struct NodeId {
 239             ENCODABLE = custom
 240             DEBUG_FORMAT = "NodeId({})"
 241         }
 242     }
 243 }
 244
 245 pub use node_id_inner::NodeId;
 246
 247 impl NodeId {
 248     pub fn placeholder_from_mark(mark: Mark) -> Self {
 249         NodeId::from_u32(mark.as_u32())
 250     }
 251
 252     pub fn placeholder_to_mark(self) -> Mark {
 253         Mark::from_u32(self.as_u32())
 254     }
 255 }
 256
 257 impl fmt::Display for NodeId {
 258     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 259         fmt::Display::fmt(&self.as_u32(), f)
 260     }
 261 }
 262
 263 impl serialize::UseSpecializedEncodable for NodeId {
 264     fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
 265         s.emit_u32(self.as_u32())
 266     }
 267 }
 268
 269 impl serialize::UseSpecializedDecodable for NodeId {
 270     fn default_decode<D: Decoder>(d: &mut D) -> Result<NodeId, D::Error> {
 271         d.read_u32().map(NodeId::from_u32)
 272     }
 273 }
 274
 275 /// `NodeId` used to represent the root of the crate.
 276 pub const CRATE_NODE_ID: NodeId = NodeId::from_u32_const(0);
 277
 278 /// When parsing and doing expansions, we initially give all AST nodes this AST
 279 /// node value. Then later, in the renumber pass, we renumber them to have
 280 /// small, positive ids.
 281 pub const DUMMY_NODE_ID: NodeId = NodeId::MAX;
 282
 283 /// A modifier on a bound, currently this is only used for `?Sized`, where the
 284 /// modifier is `Maybe`. Negative bounds should also be handled here.
 285 #[derive(Copy, Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Debug)]
 286 pub enum TraitBoundModifier {
 287     None,
 288     Maybe,
 289 }
 290
 291 /// The AST represents all type param bounds as types.
 292 /// `typeck::collect::compute_bounds` matches these against
 293 /// the "special" built-in traits (see `middle::lang_items`) and
 294 /// detects `Copy`, `Send` and `Sync`.
 295 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 296 pub enum GenericBound {
 297     Trait(PolyTraitRef, TraitBoundModifier),
 298     Outlives(Lifetime),
 299 }
 300
 301 impl GenericBound {
 302     pub fn span(&self) -> Span {
 303         match self {
 304             &GenericBound::Trait(ref t, ..) => t.span,
 305             &GenericBound::Outlives(ref l) => l.ident.span,
 306         }
 307     }
 308 }
 309
 310 pub type GenericBounds = Vec<GenericBound>;
 311
 312 /// Specifies the enforced ordering for generic parameters. In the future,
 313 /// if we wanted to relax this order, we could override `PartialEq` and
 314 /// `PartialOrd`, to allow the kinds to be unordered.
 315 #[derive(PartialEq, Eq, PartialOrd, Ord, Hash, Clone, Copy)]
 316 pub enum ParamKindOrd {
 317     Lifetime,
 318     Type,
 319     Const,
 320 }
 321
 322 impl fmt::Display for ParamKindOrd {
 323     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 324         match self {
 325             ParamKindOrd::Lifetime => "lifetime".fmt(f),
 326             ParamKindOrd::Type => "type".fmt(f),
 327             ParamKindOrd::Const => "const".fmt(f),
 328         }
 329     }
 330 }
 331
 332 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 333 pub enum GenericParamKind {
 334     /// A lifetime definition (e.g., `'a: 'b + 'c + 'd`).
 335     Lifetime,
 336     Type { default: Option<P<Ty>> },
 337     Const { ty: P<Ty> },
 338 }
 339
 340 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 341 pub struct GenericParam {
 342     pub id: NodeId,
 343     pub ident: Ident,
 344     pub attrs: ThinVec<Attribute>,
 345     pub bounds: GenericBounds,
 346
 347     pub kind: GenericParamKind,
 348 }
 349
 350 /// Represents lifetime, type and const parameters attached to a declaration of
 351 /// a function, enum, trait, etc.
 352 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 353 pub struct Generics {
 354     pub params: Vec<GenericParam>,
 355     pub where_clause: WhereClause,
 356     pub span: Span,
 357 }
 358
 359 impl Default for Generics {
 360     /// Creates an instance of `Generics`.
 361     fn default() -> Generics {
 362         Generics {
 363             params: Vec::new(),
 364             where_clause: WhereClause {
 365                 id: DUMMY_NODE_ID,
 366                 predicates: Vec::new(),
 367                 span: DUMMY_SP,
 368             },
 369             span: DUMMY_SP,
 370         }
 371     }
 372 }
 373
 374 /// A where-clause in a definition.
 375 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 376 pub struct WhereClause {
 377     pub id: NodeId,
 378     pub predicates: Vec<WherePredicate>,
 379     pub span: Span,
 380 }
 381
 382 /// A single predicate in a where-clause.
 383 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 384 pub enum WherePredicate {
 385     /// A type binding (e.g., `for<'c> Foo: Send + Clone + 'c`).
 386     BoundPredicate(WhereBoundPredicate),
 387     /// A lifetime predicate (e.g., `'a: 'b + 'c`).
 388     RegionPredicate(WhereRegionPredicate),
 389     /// An equality predicate (unsupported).
 390     EqPredicate(WhereEqPredicate),
 391 }
 392
 393 impl WherePredicate {
 394     pub fn span(&self) -> Span {
 395         match self {
 396             &WherePredicate::BoundPredicate(ref p) => p.span,
 397             &WherePredicate::RegionPredicate(ref p) => p.span,
 398             &WherePredicate::EqPredicate(ref p) => p.span,
 399         }
 400     }
 401 }
 402
 403 /// A type bound.
 404 ///
 405 /// E.g., `for<'c> Foo: Send + Clone + 'c`.
 406 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 407 pub struct WhereBoundPredicate {
 408     pub span: Span,
 409     /// Any generics from a `for` binding
 410     pub bound_generic_params: Vec<GenericParam>,
 411     /// The type being bounded
 412     pub bounded_ty: P<Ty>,
 413     /// Trait and lifetime bounds (`Clone+Send+'static`)
 414     pub bounds: GenericBounds,
 415 }
 416
 417 /// A lifetime predicate.
 418 ///
 419 /// E.g., `'a: 'b + 'c`.
 420 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 421 pub struct WhereRegionPredicate {
 422     pub span: Span,
 423     pub lifetime: Lifetime,
 424     pub bounds: GenericBounds,
 425 }
 426
 427 /// An equality predicate (unsupported).
 428 ///
 429 /// E.g., `T = int`.
 430 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 431 pub struct WhereEqPredicate {
 432     pub id: NodeId,
 433     pub span: Span,
 434     pub lhs_ty: P<Ty>,
 435     pub rhs_ty: P<Ty>,
 436 }
 437
 438 /// The set of `MetaItem`s that define the compilation environment of the crate,
 439 /// used to drive conditional compilation.
 440 pub type CrateConfig = FxHashSet<(Name, Option<Symbol>)>;
 441
 442 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 443 pub struct Crate {
 444     pub module: Mod,
 445     pub attrs: Vec<Attribute>,
 446     pub span: Span,
 447 }
 448
 449 /// Possible values inside of compile-time attribute lists.
 450 ///
 451 /// E.g., the '..' in `#[name(..)]`.
 452 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 453 pub enum NestedMetaItem {
 454     /// A full MetaItem, for recursive meta items.
 455     MetaItem(MetaItem),
 456     /// A literal.
 457     ///
 458     /// E.g., `"foo"`, `64`, `true`.
 459     Literal(Lit),
 460 }
 461
 462 /// A spanned compile-time attribute item.
 463 ///
 464 /// E.g., `#[test]`, `#[derive(..)]`, `#[rustfmt::skip]` or `#[feature = "foo"]`.
 465 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 466 pub struct MetaItem {
 467     pub path: Path,
 468     pub node: MetaItemKind,
 469     pub span: Span,
 470 }
 471
 472 /// A compile-time attribute item.
 473 ///
 474 /// E.g., `#[test]`, `#[derive(..)]` or `#[feature = "foo"]`.
 475 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 476 pub enum MetaItemKind {
 477     /// Word meta item.
 478     ///
 479     /// E.g., `test` as in `#[test]`.
 480     Word,
 481     /// List meta item.
 482     ///
 483     /// E.g., `derive(..)` as in `#[derive(..)]`.
 484     List(Vec<NestedMetaItem>),
 485     /// Name value meta item.
 486     ///
 487     /// E.g., `feature = "foo"` as in `#[feature = "foo"]`.
 488     NameValue(Lit),
 489 }
 490
 491 /// A Block (`{ .. }`).
 492 ///
 493 /// E.g., `{ .. }` as in `fn foo() { .. }`.
 494 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 495 pub struct Block {
 496     /// Statements in a block
 497     pub stmts: Vec<Stmt>,
 498     pub id: NodeId,
 499     /// Distinguishes between `unsafe { ... }` and `{ ... }`
 500     pub rules: BlockCheckMode,
 501     pub span: Span,
 502 }
 503
 504 #[derive(Clone, RustcEncodable, RustcDecodable)]
 505 pub struct Pat {
 506     pub id: NodeId,
 507     pub node: PatKind,
 508     pub span: Span,
 509 }
 510
 511 impl fmt::Debug for Pat {
 512     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 513         write!(f, "pat({}: {})", self.id, pprust::pat_to_string(self))
 514     }
 515 }
 516
 517 impl Pat {
 518     pub(super) fn to_ty(&self) -> Option<P<Ty>> {
 519         let node = match &self.node {
 520             PatKind::Wild => TyKind::Infer,
 521             PatKind::Ident(BindingMode::ByValue(Mutability::Immutable), ident, None) => {
 522                 TyKind::Path(None, Path::from_ident(*ident))
 523             }
 524             PatKind::Path(qself, path) => TyKind::Path(qself.clone(), path.clone()),
 525             PatKind::Mac(mac) => TyKind::Mac(mac.clone()),
 526             PatKind::Ref(pat, mutbl) => pat
 527                 .to_ty()
 528                 .map(|ty| TyKind::Rptr(None, MutTy { ty, mutbl: *mutbl }))?,
 529             PatKind::Slice(pats, None, _) if pats.len() == 1 => {
 530                 pats[0].to_ty().map(TyKind::Slice)?
 531             }
 532             PatKind::Tuple(pats, None) => {
 533                 let mut tys = Vec::with_capacity(pats.len());
 534                 // FIXME(#48994) - could just be collected into an Option<Vec>
 535                 for pat in pats {
 536                     tys.push(pat.to_ty()?);
 537                 }
 538                 TyKind::Tup(tys)
 539             }
 540             _ => return None,
 541         };
 542
 543         Some(P(Ty {
 544             node,
 545             id: self.id,
 546             span: self.span,
 547         }))
 548     }
 549
 550     pub fn walk<F>(&self, it: &mut F) -> bool
 551     where
 552         F: FnMut(&Pat) -> bool,
 553     {
 554         if !it(self) {
 555             return false;
 556         }
 557
 558         match self.node {
 559             PatKind::Ident(_, _, Some(ref p)) => p.walk(it),
 560             PatKind::Struct(_, ref fields, _) => fields.iter().all(|field| field.node.pat.walk(it)),
 561             PatKind::TupleStruct(_, ref s, _) | PatKind::Tuple(ref s, _) => {
 562                 s.iter().all(|p| p.walk(it))
 563             }
 564             PatKind::Box(ref s) | PatKind::Ref(ref s, _) | PatKind::Paren(ref s) => s.walk(it),
 565             PatKind::Slice(ref before, ref slice, ref after) => {
 566                 before.iter().all(|p| p.walk(it))
 567                     && slice.iter().all(|p| p.walk(it))
 568                     && after.iter().all(|p| p.walk(it))
 569             }
 570             PatKind::Wild
 571             | PatKind::Lit(_)
 572             | PatKind::Range(..)
 573             | PatKind::Ident(..)
 574             | PatKind::Path(..)
 575             | PatKind::Mac(_) => true,
 576         }
 577     }
 578 }
 579
 580 /// A single field in a struct pattern
 581 ///
 582 /// Patterns like the fields of Foo `{ x, ref y, ref mut z }`
 583 /// are treated the same as` x: x, y: ref y, z: ref mut z`,
 584 /// except is_shorthand is true
 585 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 586 pub struct FieldPat {
 587     /// The identifier for the field
 588     pub ident: Ident,
 589     /// The pattern the field is destructured to
 590     pub pat: P<Pat>,
 591     pub is_shorthand: bool,
 592     pub attrs: ThinVec<Attribute>,
 593 }
 594
 595 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
 596 pub enum BindingMode {
 597     ByRef(Mutability),
 598     ByValue(Mutability),
 599 }
 600
 601 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 602 pub enum RangeEnd {
 603     Included(RangeSyntax),
 604     Excluded,
 605 }
 606
 607 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 608 pub enum RangeSyntax {
 609     DotDotDot,
 610     DotDotEq,
 611 }
 612
 613 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 614 pub enum PatKind {
 615     /// Represents a wildcard pattern (`_`).
 616     Wild,
 617
 618     /// A `PatKind::Ident` may either be a new bound variable (`ref mut binding @ OPT_SUBPATTERN`),
 619     /// or a unit struct/variant pattern, or a const pattern (in the last two cases the third
 620     /// field must be `None`). Disambiguation cannot be done with parser alone, so it happens
 621     /// during name resolution.
 622     Ident(BindingMode, Ident, Option<P<Pat>>),
 623
 624     /// A struct or struct variant pattern (e.g., `Variant {x, y, ..}`).
 625     /// The `bool` is `true` in the presence of a `..`.
 626     Struct(Path, Vec<Spanned<FieldPat>>, /* recovered */ bool),
 627
 628     /// A tuple struct/variant pattern (`Variant(x, y, .., z)`).
 629     /// If the `..` pattern fragment is present, then `Option<usize>` denotes its position.
 630     /// `0 <= position <= subpats.len()`.
 631     TupleStruct(Path, Vec<P<Pat>>, Option<usize>),
 632
 633     /// A possibly qualified path pattern.
 634     /// Unqualified path patterns `A::B::C` can legally refer to variants, structs, constants
 635     /// or associated constants. Qualified path patterns `<A>::B::C`/`<A as Trait>::B::C` can
 636     /// only legally refer to associated constants.
 637     Path(Option<QSelf>, Path),
 638
 639     /// A tuple pattern (`(a, b)`).
 640     /// If the `..` pattern fragment is present, then `Option<usize>` denotes its position.
 641     /// `0 <= position <= subpats.len()`.
 642     Tuple(Vec<P<Pat>>, Option<usize>),
 643
 644     /// A `box` pattern.
 645     Box(P<Pat>),
 646
 647     /// A reference pattern (e.g., `&mut (a, b)`).
 648     Ref(P<Pat>, Mutability),
 649
 650     /// A literal.
 651     Lit(P<Expr>),
 652
 653     /// A range pattern (e.g., `1...2`, `1..=2` or `1..2`).
 654     Range(P<Expr>, P<Expr>, Spanned<RangeEnd>),
 655
 656     /// `[a, b, ..i, y, z]` is represented as:
 657     ///     `PatKind::Slice(box [a, b], Some(i), box [y, z])`
 658     Slice(Vec<P<Pat>>, Option<P<Pat>>, Vec<P<Pat>>),
 659
 660     /// Parentheses in patterns used for grouping (i.e., `(PAT)`).
 661     Paren(P<Pat>),
 662
 663     /// A macro pattern; pre-expansion.
 664     Mac(Mac),
 665 }
 666
 667 #[derive(
 668     Clone, PartialEq, Eq, PartialOrd, Ord, Hash, RustcEncodable, RustcDecodable, Debug, Copy,
 669 )]
 670 pub enum Mutability {
 671     Mutable,
 672     Immutable,
 673 }
 674
 675 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
 676 pub enum BinOpKind {
 677     /// The `+` operator (addition)
 678     Add,
 679     /// The `-` operator (subtraction)
 680     Sub,
 681     /// The `*` operator (multiplication)
 682     Mul,
 683     /// The `/` operator (division)
 684     Div,
 685     /// The `%` operator (modulus)
 686     Rem,
 687     /// The `&&` operator (logical and)
 688     And,
 689     /// The `||` operator (logical or)
 690     Or,
 691     /// The `^` operator (bitwise xor)
 692     BitXor,
 693     /// The `&` operator (bitwise and)
 694     BitAnd,
 695     /// The `|` operator (bitwise or)
 696     BitOr,
 697     /// The `<<` operator (shift left)
 698     Shl,
 699     /// The `>>` operator (shift right)
 700     Shr,
 701     /// The `==` operator (equality)
 702     Eq,
 703     /// The `<` operator (less than)
 704     Lt,
 705     /// The `<=` operator (less than or equal to)
 706     Le,
 707     /// The `!=` operator (not equal to)
 708     Ne,
 709     /// The `>=` operator (greater than or equal to)
 710     Ge,
 711     /// The `>` operator (greater than)
 712     Gt,
 713 }
 714
 715 impl BinOpKind {
 716     pub fn to_string(&self) -> &'static str {
 717         use BinOpKind::*;
 718         match *self {
 719             Add => "+",
 720             Sub => "-",
 721             Mul => "*",
 722             Div => "/",
 723             Rem => "%",
 724             And => "&&",
 725             Or => "||",
 726             BitXor => "^",
 727             BitAnd => "&",
 728             BitOr => "|",
 729             Shl => "<<",
 730             Shr => ">>",
 731             Eq => "==",
 732             Lt => "<",
 733             Le => "<=",
 734             Ne => "!=",
 735             Ge => ">=",
 736             Gt => ">",
 737         }
 738     }
 739     pub fn lazy(&self) -> bool {
 740         match *self {
 741             BinOpKind::And | BinOpKind::Or => true,
 742             _ => false,
 743         }
 744     }
 745
 746     pub fn is_shift(&self) -> bool {
 747         match *self {
 748             BinOpKind::Shl | BinOpKind::Shr => true,
 749             _ => false,
 750         }
 751     }
 752
 753     pub fn is_comparison(&self) -> bool {
 754         use BinOpKind::*;
 755         match *self {
 756             Eq | Lt | Le | Ne | Gt | Ge => true,
 757             And | Or | Add | Sub | Mul | Div | Rem | BitXor | BitAnd | BitOr | Shl | Shr => false,
 758         }
 759     }
 760
 761     /// Returns `true` if the binary operator takes its arguments by value
 762     pub fn is_by_value(&self) -> bool {
 763         !self.is_comparison()
 764     }
 765 }
 766
 767 pub type BinOp = Spanned<BinOpKind>;
 768
 769 #[derive(Clone, RustcEncodable, RustcDecodable, Debug, Copy)]
 770 pub enum UnOp {
 771     /// The `*` operator for dereferencing
 772     Deref,
 773     /// The `!` operator for logical inversion
 774     Not,
 775     /// The `-` operator for negation
 776     Neg,
 777 }
 778
 779 impl UnOp {
 780     /// Returns `true` if the unary operator takes its argument by value
 781     pub fn is_by_value(u: UnOp) -> bool {
 782         match u {
 783             UnOp::Neg | UnOp::Not => true,
 784             _ => false,
 785         }
 786     }
 787
 788     pub fn to_string(op: UnOp) -> &'static str {
 789         match op {
 790             UnOp::Deref => "*",
 791             UnOp::Not => "!",
 792             UnOp::Neg => "-",
 793         }
 794     }
 795 }
 796
 797 /// A statement
 798 #[derive(Clone, RustcEncodable, RustcDecodable)]
 799 pub struct Stmt {
 800     pub id: NodeId,
 801     pub node: StmtKind,
 802     pub span: Span,
 803 }
 804
 805 impl Stmt {
 806     pub fn add_trailing_semicolon(mut self) -> Self {
 807         self.node = match self.node {
 808             StmtKind::Expr(expr) => StmtKind::Semi(expr),
 809             StmtKind::Mac(mac) => {
 810                 StmtKind::Mac(mac.map(|(mac, _style, attrs)| (mac, MacStmtStyle::Semicolon, attrs)))
 811             }
 812             node => node,
 813         };
 814         self
 815     }
 816
 817     pub fn is_item(&self) -> bool {
 818         match self.node {
 819             StmtKind::Item(_) => true,
 820             _ => false,
 821         }
 822     }
 823
 824     pub fn is_expr(&self) -> bool {
 825         match self.node {
 826             StmtKind::Expr(_) => true,
 827             _ => false,
 828         }
 829     }
 830 }
 831
 832 impl fmt::Debug for Stmt {
 833     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 834         write!(
 835             f,
 836             "stmt({}: {})",
 837             self.id.to_string(),
 838             pprust::stmt_to_string(self)
 839         )
 840     }
 841 }
 842
 843 #[derive(Clone, RustcEncodable, RustcDecodable)]
 844 pub enum StmtKind {
 845     /// A local (let) binding.
 846     Local(P<Local>),
 847
 848     /// An item definition.
 849     Item(P<Item>),
 850
 851     /// Expr without trailing semi-colon.
 852     Expr(P<Expr>),
 853     /// Expr with a trailing semi-colon.
 854     Semi(P<Expr>),
 855     /// Macro.
 856     Mac(P<(Mac, MacStmtStyle, ThinVec<Attribute>)>),
 857 }
 858
 859 #[derive(Clone, Copy, PartialEq, RustcEncodable, RustcDecodable, Debug)]
 860 pub enum MacStmtStyle {
 861     /// The macro statement had a trailing semicolon (e.g., `foo! { ... };`
 862     /// `foo!(...);`, `foo![...];`).
 863     Semicolon,
 864     /// The macro statement had braces (e.g., `foo! { ... }`).
 865     Braces,
 866     /// The macro statement had parentheses or brackets and no semicolon (e.g.,
 867     /// `foo!(...)`). All of these will end up being converted into macro
 868     /// expressions.
 869     NoBraces,
 870 }
 871
 872 /// Local represents a `let` statement, e.g., `let <pat>:<ty> = <expr>;`.
 873 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 874 pub struct Local {
 875     pub pat: P<Pat>,
 876     pub ty: Option<P<Ty>>,
 877     /// Initializer expression to set the value, if any.
 878     pub init: Option<P<Expr>>,
 879     pub id: NodeId,
 880     pub span: Span,
 881     pub attrs: ThinVec<Attribute>,
 882     /// Origin of this local variable.
 883     pub source: LocalSource,
 884 }
 885
 886 #[derive(Clone, Copy, RustcEncodable, RustcDecodable, Debug)]
 887 pub enum LocalSource {
 888     /// Local was parsed from source.
 889     Normal,
 890     /// Within `ast::IsAsync::Async`, a local is generated that will contain the moved arguments
 891     /// of an `async fn`.
 892     AsyncFn,
 893 }
 894
 895 /// An arm of a 'match'.
 896 ///
 897 /// E.g., `0..=10 => { println!("match!") }` as in
 898 ///
 899 /// ```
 900 /// match 123 {
 901 ///     0..=10 => { println!("match!") },
 902 ///     _ => { println!("no match!") },
 903 /// }
 904 /// ```
 905 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 906 pub struct Arm {
 907     pub attrs: Vec<Attribute>,
 908     pub pats: Vec<P<Pat>>,
 909     pub guard: Option<Guard>,
 910     pub body: P<Expr>,
 911     pub span: Span,
 912 }
 913
 914 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 915 pub enum Guard {
 916     If(P<Expr>),
 917 }
 918
 919 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 920 pub struct Field {
 921     pub ident: Ident,
 922     pub expr: P<Expr>,
 923     pub span: Span,
 924     pub is_shorthand: bool,
 925     pub attrs: ThinVec<Attribute>,
 926 }
 927
 928 pub type SpannedIdent = Spanned<Ident>;
 929
 930 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
 931 pub enum BlockCheckMode {
 932     Default,
 933     Unsafe(UnsafeSource),
 934 }
 935
 936 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
 937 pub enum UnsafeSource {
 938     CompilerGenerated,
 939     UserProvided,
 940 }
 941
 942 /// A constant (expression) that's not an item or associated item,
 943 /// but needs its own `DefId` for type-checking, const-eval, etc.
 944 /// These are usually found nested inside types (e.g., array lengths)
 945 /// or expressions (e.g., repeat counts), and also used to define
 946 /// explicit discriminant values for enum variants.
 947 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
 948 pub struct AnonConst {
 949     pub id: NodeId,
 950     pub value: P<Expr>,
 951 }
 952
 953 /// An expression
 954 #[derive(Clone, RustcEncodable, RustcDecodable)]
 955 pub struct Expr {
 956     pub id: NodeId,
 957     pub node: ExprKind,
 958     pub span: Span,
 959     pub attrs: ThinVec<Attribute>,
 960 }
 961
 962 // `Expr` is used a lot. Make sure it doesn't unintentionally get bigger.
 963 #[cfg(target_arch = "x86_64")]
 964 static_assert_size!(Expr, 96);
 965
 966 impl Expr {
 967     /// Whether this expression would be valid somewhere that expects a value; for example, an `if`
 968     /// condition.
 969     pub fn returns(&self) -> bool {
 970         if let ExprKind::Block(ref block, _) = self.node {
 971             match block.stmts.last().map(|last_stmt| &last_stmt.node) {
 972                 // implicit return
 973                 Some(&StmtKind::Expr(_)) => true,
 974                 Some(&StmtKind::Semi(ref expr)) => {
 975                     if let ExprKind::Ret(_) = expr.node {
 976                         // last statement is explicit return
 977                         true
 978                     } else {
 979                         false
 980                     }
 981                 }
 982                 // This is a block that doesn't end in either an implicit or explicit return
 983                 _ => false,
 984             }
 985         } else {
 986             // This is not a block, it is a value
 987             true
 988         }
 989     }
 990
 991     fn to_bound(&self) -> Option<GenericBound> {
 992         match &self.node {
 993             ExprKind::Path(None, path) => Some(GenericBound::Trait(
 994                 PolyTraitRef::new(Vec::new(), path.clone(), self.span),
 995                 TraitBoundModifier::None,
 996             )),
 997             _ => None,
 998         }
 999     }
1000
1001     pub(super) fn to_ty(&self) -> Option<P<Ty>> {
1002         let node = match &self.node {
1003             ExprKind::Path(qself, path) => TyKind::Path(qself.clone(), path.clone()),
1004             ExprKind::Mac(mac) => TyKind::Mac(mac.clone()),
1005             ExprKind::Paren(expr) => expr.to_ty().map(TyKind::Paren)?,
1006             ExprKind::AddrOf(mutbl, expr) => expr
1007                 .to_ty()
1008                 .map(|ty| TyKind::Rptr(None, MutTy { ty, mutbl: *mutbl }))?,
1009             ExprKind::Repeat(expr, expr_len) => {
1010                 expr.to_ty().map(|ty| TyKind::Array(ty, expr_len.clone()))?
1011             }
1012             ExprKind::Array(exprs) if exprs.len() == 1 => exprs[0].to_ty().map(TyKind::Slice)?,
1013             ExprKind::Tup(exprs) => {
1014                 let tys = exprs
1015                     .iter()
1016                     .map(|expr| expr.to_ty())
1017                     .collect::<Option<Vec<_>>>()?;
1018                 TyKind::Tup(tys)
1019             }
1020             ExprKind::Binary(binop, lhs, rhs) if binop.node == BinOpKind::Add => {
1021                 if let (Some(lhs), Some(rhs)) = (lhs.to_bound(), rhs.to_bound()) {
1022                     TyKind::TraitObject(vec![lhs, rhs], TraitObjectSyntax::None)
1023                 } else {
1024                     return None;
1025                 }
1026             }
1027             _ => return None,
1028         };
1029
1030         Some(P(Ty {
1031             node,
1032             id: self.id,
1033             span: self.span,
1034         }))
1035     }
1036
1037     pub fn precedence(&self) -> ExprPrecedence {
1038         match self.node {
1039             ExprKind::Box(_) => ExprPrecedence::Box,
1040             ExprKind::Array(_) => ExprPrecedence::Array,
1041             ExprKind::Call(..) => ExprPrecedence::Call,
1042             ExprKind::MethodCall(..) => ExprPrecedence::MethodCall,
1043             ExprKind::Tup(_) => ExprPrecedence::Tup,
1044             ExprKind::Binary(op, ..) => ExprPrecedence::Binary(op.node),
1045             ExprKind::Unary(..) => ExprPrecedence::Unary,
1046             ExprKind::Lit(_) => ExprPrecedence::Lit,
1047             ExprKind::Type(..) | ExprKind::Cast(..) => ExprPrecedence::Cast,
1048             ExprKind::If(..) => ExprPrecedence::If,
1049             ExprKind::IfLet(..) => ExprPrecedence::IfLet,
1050             ExprKind::While(..) => ExprPrecedence::While,
1051             ExprKind::WhileLet(..) => ExprPrecedence::WhileLet,
1052             ExprKind::ForLoop(..) => ExprPrecedence::ForLoop,
1053             ExprKind::Loop(..) => ExprPrecedence::Loop,
1054             ExprKind::Match(..) => ExprPrecedence::Match,
1055             ExprKind::Closure(..) => ExprPrecedence::Closure,
1056             ExprKind::Block(..) => ExprPrecedence::Block,
1057             ExprKind::TryBlock(..) => ExprPrecedence::TryBlock,
1058             ExprKind::Async(..) => ExprPrecedence::Async,
1059             ExprKind::Await(..) => ExprPrecedence::Await,
1060             ExprKind::Assign(..) => ExprPrecedence::Assign,
1061             ExprKind::AssignOp(..) => ExprPrecedence::AssignOp,
1062             ExprKind::Field(..) => ExprPrecedence::Field,
1063             ExprKind::Index(..) => ExprPrecedence::Index,
1064             ExprKind::Range(..) => ExprPrecedence::Range,
1065             ExprKind::Path(..) => ExprPrecedence::Path,
1066             ExprKind::AddrOf(..) => ExprPrecedence::AddrOf,
1067             ExprKind::Break(..) => ExprPrecedence::Break,
1068             ExprKind::Continue(..) => ExprPrecedence::Continue,
1069             ExprKind::Ret(..) => ExprPrecedence::Ret,
1070             ExprKind::InlineAsm(..) => ExprPrecedence::InlineAsm,
1071             ExprKind::Mac(..) => ExprPrecedence::Mac,
1072             ExprKind::Struct(..) => ExprPrecedence::Struct,
1073             ExprKind::Repeat(..) => ExprPrecedence::Repeat,
1074             ExprKind::Paren(..) => ExprPrecedence::Paren,
1075             ExprKind::Try(..) => ExprPrecedence::Try,
1076             ExprKind::Yield(..) => ExprPrecedence::Yield,
1077             ExprKind::Err => ExprPrecedence::Err,
1078         }
1079     }
1080 }
1081
1082 impl fmt::Debug for Expr {
1083     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1084         write!(f, "expr({}: {})", self.id, pprust::expr_to_string(self))
1085     }
1086 }
1087
1088 /// Limit types of a range (inclusive or exclusive)
1089 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
1090 pub enum RangeLimits {
1091     /// Inclusive at the beginning, exclusive at the end
1092     HalfOpen,
1093     /// Inclusive at the beginning and end
1094     Closed,
1095 }
1096
1097 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1098 pub enum ExprKind {
1099     /// A `box x` expression.
1100     Box(P<Expr>),
1101     /// An array (`[a, b, c, d]`)
1102     Array(Vec<P<Expr>>),
1103     /// A function call
1104     ///
1105     /// The first field resolves to the function itself,
1106     /// and the second field is the list of arguments.
1107     /// This also represents calling the constructor of
1108     /// tuple-like ADTs such as tuple structs and enum variants.
1109     Call(P<Expr>, Vec<P<Expr>>),
1110     /// A method call (`x.foo::<'static, Bar, Baz>(a, b, c, d)`)
1111     ///
1112     /// The `PathSegment` represents the method name and its generic arguments
1113     /// (within the angle brackets).
1114     /// The first element of the vector of an `Expr` is the expression that evaluates
1115     /// to the object on which the method is being called on (the receiver),
1116     /// and the remaining elements are the rest of the arguments.
1117     /// Thus, `x.foo::<Bar, Baz>(a, b, c, d)` is represented as
1118     /// `ExprKind::MethodCall(PathSegment { foo, [Bar, Baz] }, [x, a, b, c, d])`.
1119     MethodCall(PathSegment, Vec<P<Expr>>),
1120     /// A tuple (e.g., `(a, b, c, d)`).
1121     Tup(Vec<P<Expr>>),
1122     /// A binary operation (e.g., `a + b`, `a * b`).
1123     Binary(BinOp, P<Expr>, P<Expr>),
1124     /// A unary operation (e.g., `!x`, `*x`).
1125     Unary(UnOp, P<Expr>),
1126     /// A literal (e.g., `1`, `"foo"`).
1127     Lit(Lit),
1128     /// A cast (e.g., `foo as f64`).
1129     Cast(P<Expr>, P<Ty>),
1130     /// A type ascription (e.g., `42: usize`).
1131     Type(P<Expr>, P<Ty>),
1132     /// An `if` block, with an optional `else` block.
1133     ///
1134     /// `if expr { block } else { expr }`
1135     If(P<Expr>, P<Block>, Option<P<Expr>>),
1136     /// An `if let` expression with an optional else block
1137     ///
1138     /// `if let pat = expr { block } else { expr }`
1139     ///
1140     /// This is desugared to a `match` expression.
1141     IfLet(Vec<P<Pat>>, P<Expr>, P<Block>, Option<P<Expr>>),
1142     /// A while loop, with an optional label
1143     ///
1144     /// `'label: while expr { block }`
1145     While(P<Expr>, P<Block>, Option<Label>),
1146     /// A `while let` loop, with an optional label.
1147     ///
1148     /// `'label: while let pat = expr { block }`
1149     ///
1150     /// This is desugared to a combination of `loop` and `match` expressions.
1151     WhileLet(Vec<P<Pat>>, P<Expr>, P<Block>, Option<Label>),
1152     /// A `for` loop, with an optional label.
1153     ///
1154     /// `'label: for pat in expr { block }`
1155     ///
1156     /// This is desugared to a combination of `loop` and `match` expressions.
1157     ForLoop(P<Pat>, P<Expr>, P<Block>, Option<Label>),
1158     /// Conditionless loop (can be exited with `break`, `continue`, or `return`).
1159     ///
1160     /// `'label: loop { block }`
1161     Loop(P<Block>, Option<Label>),
1162     /// A `match` block.
1163     Match(P<Expr>, Vec<Arm>),
1164     /// A closure (e.g., `move |a, b, c| a + b + c`).
1165     ///
1166     /// The final span is the span of the argument block `|...|`.
1167     Closure(CaptureBy, IsAsync, Movability, P<FnDecl>, P<Expr>, Span),
1168     /// A block (`'label: { ... }`).
1169     Block(P<Block>, Option<Label>),
1170     /// An async block (`async move { ... }`).
1171     ///
1172     /// The `NodeId` is the `NodeId` for the closure that results from
1173     /// desugaring an async block, just like the NodeId field in the
1174     /// `IsAsync` enum. This is necessary in order to create a def for the
1175     /// closure which can be used as a parent of any child defs. Defs
1176     /// created during lowering cannot be made the parent of any other
1177     /// preexisting defs.
1178     Async(CaptureBy, NodeId, P<Block>),
1179     /// An await expression (`my_future.await`).
1180     Await(AwaitOrigin, P<Expr>),
1181
1182     /// A try block (`try { ... }`).
1183     TryBlock(P<Block>),
1184
1185     /// An assignment (`a = foo()`).
1186     Assign(P<Expr>, P<Expr>),
1187     /// An assignment with an operator.
1188     ///
1189     /// E.g., `a += 1`.
1190     AssignOp(BinOp, P<Expr>, P<Expr>),
1191     /// Access of a named (e.g., `obj.foo`) or unnamed (e.g., `obj.0`) struct field.
1192     Field(P<Expr>, Ident),
1193     /// An indexing operation (e.g., `foo[2]`).
1194     Index(P<Expr>, P<Expr>),
1195     /// A range (e.g., `1..2`, `1..`, `..2`, `1...2`, `1...`, `...2`).
1196     Range(Option<P<Expr>>, Option<P<Expr>>, RangeLimits),
1197
1198     /// Variable reference, possibly containing `::` and/or type
1199     /// parameters (e.g., `foo::bar::<baz>`).
1200     ///
1201     /// Optionally "qualified" (e.g., `<Vec<T> as SomeTrait>::SomeType`).
1202     Path(Option<QSelf>, Path),
1203
1204     /// A referencing operation (`&a` or `&mut a`).
1205     AddrOf(Mutability, P<Expr>),
1206     /// A `break`, with an optional label to break, and an optional expression.
1207     Break(Option<Label>, Option<P<Expr>>),
1208     /// A `continue`, with an optional label.
1209     Continue(Option<Label>),
1210     /// A `return`, with an optional value to be returned.
1211     Ret(Option<P<Expr>>),
1212
1213     /// Output of the `asm!()` macro.
1214     InlineAsm(P<InlineAsm>),
1215
1216     /// A macro invocation; pre-expansion.
1217     Mac(Mac),
1218
1219     /// A struct literal expression.
1220     ///
1221     /// E.g., `Foo {x: 1, y: 2}`, or `Foo {x: 1, .. base}`,
1222     /// where `base` is the `Option<Expr>`.
1223     Struct(Path, Vec<Field>, Option<P<Expr>>),
1224
1225     /// An array literal constructed from one repeated element.
1226     ///
1227     /// E.g., `[1; 5]`. The expression is the element to be
1228     /// repeated; the constant is the number of times to repeat it.
1229     Repeat(P<Expr>, AnonConst),
1230
1231     /// No-op: used solely so we can pretty-print faithfully.
1232     Paren(P<Expr>),
1233
1234     /// A try expression (`expr?`).
1235     Try(P<Expr>),
1236
1237     /// A `yield`, with an optional value to be yielded.
1238     Yield(Option<P<Expr>>),
1239
1240     /// Placeholder for an expression that wasn't syntactically well formed in some way.
1241     Err,
1242 }
1243
1244 /// The explicit `Self` type in a "qualified path". The actual
1245 /// path, including the trait and the associated item, is stored
1246 /// separately. `position` represents the index of the associated
1247 /// item qualified with this `Self` type.
1248 ///
1249 /// ```ignore (only-for-syntax-highlight)
1250 /// <Vec<T> as a::b::Trait>::AssociatedItem
1251 ///  ^~~~~     ~~~~~~~~~~~~~~^
1252 ///  ty        position = 3
1253 ///
1254 /// <Vec<T>>::AssociatedItem
1255 ///  ^~~~~    ^
1256 ///  ty       position = 0
1257 /// ```
1258 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1259 pub struct QSelf {
1260     pub ty: P<Ty>,
1261
1262     /// The span of `a::b::Trait` in a path like `<Vec<T> as
1263     /// a::b::Trait>::AssociatedItem`; in the case where `position ==
1264     /// 0`, this is an empty span.
1265     pub path_span: Span,
1266     pub position: usize,
1267 }
1268
1269 /// A capture clause.
1270 #[derive(Clone, Copy, PartialEq, RustcEncodable, RustcDecodable, Debug)]
1271 pub enum CaptureBy {
1272     Value,
1273     Ref,
1274 }
1275
1276 /// The movability of a generator / closure literal.
1277 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
1278 pub enum Movability {
1279     Static,
1280     Movable,
1281 }
1282
1283 /// Whether an `await` comes from `await!` or `.await` syntax.
1284 /// FIXME: this should be removed when support for legacy `await!` is removed.
1285 /// https://github.com/rust-lang/rust/issues/60610
1286 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
1287 pub enum AwaitOrigin {
1288     FieldLike,
1289     MacroLike,
1290 }
1291
1292 pub type Mac = Spanned<Mac_>;
1293
1294 /// Represents a macro invocation. The `Path` indicates which macro
1295 /// is being invoked, and the vector of token-trees contains the source
1296 /// of the macro invocation.
1297 ///
1298 /// N.B., the additional ident for a `macro_rules`-style macro is actually
1299 /// stored in the enclosing item.
1300 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1301 pub struct Mac_ {
1302     pub path: Path,
1303     pub delim: MacDelimiter,
1304     pub tts: TokenStream,
1305 }
1306
1307 #[derive(Copy, Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Debug)]
1308 pub enum MacDelimiter {
1309     Parenthesis,
1310     Bracket,
1311     Brace,
1312 }
1313
1314 impl Mac_ {
1315     pub fn stream(&self) -> TokenStream {
1316         self.tts.clone()
1317     }
1318 }
1319
1320 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1321 pub struct MacroDef {
1322     pub tokens: TokenStream,
1323     pub legacy: bool,
1324 }
1325
1326 impl MacroDef {
1327     pub fn stream(&self) -> TokenStream {
1328         self.tokens.clone().into()
1329     }
1330 }
1331
1332 #[derive(Clone, RustcEncodable, RustcDecodable, Debug, Copy, Hash, PartialEq)]
1333 pub enum StrStyle {
1334     /// A regular string, like `"foo"`.
1335     Cooked,
1336     /// A raw string, like `r##"foo"##`.
1337     ///
1338     /// The value is the number of `#` symbols used.
1339     Raw(u16),
1340 }
1341
1342 /// An AST literal.
1343 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1344 pub struct Lit {
1345     /// The original literal token as written in source code.
1346     pub token: token::Lit,
1347     /// The "semantic" representation of the literal lowered from the original tokens.
1348     /// Strings are unescaped, hexadecimal forms are eliminated, etc.
1349     /// FIXME: Remove this and only create the semantic representation during lowering to HIR.
1350     pub node: LitKind,
1351     pub span: Span,
1352 }
1353
1354 #[derive(Clone, RustcEncodable, RustcDecodable, Debug, Copy, Hash, PartialEq)]
1355 pub enum LitIntType {
1356     Signed(IntTy),
1357     Unsigned(UintTy),
1358     Unsuffixed,
1359 }
1360
1361 /// Literal kind.
1362 ///
1363 /// E.g., `"foo"`, `42`, `12.34`, or `bool`.
1364 #[derive(Clone, RustcEncodable, RustcDecodable, Debug, Hash, PartialEq)]
1365 pub enum LitKind {
1366     /// A string literal (`"foo"`).
1367     Str(Symbol, StrStyle),
1368     /// A byte string (`b"foo"`).
1369     ByteStr(Lrc<Vec<u8>>),
1370     /// A byte char (`b'f'`).
1371     Byte(u8),
1372     /// A character literal (`'a'`).
1373     Char(char),
1374     /// An integer literal (`1`).
1375     Int(u128, LitIntType),
1376     /// A float literal (`1f64` or `1E10f64`).
1377     Float(Symbol, FloatTy),
1378     /// A float literal without a suffix (`1.0 or 1.0E10`).
1379     FloatUnsuffixed(Symbol),
1380     /// A boolean literal.
1381     Bool(bool),
1382     /// A recovered character literal that contains mutliple `char`s, most likely a typo.
1383     Err(Symbol),
1384 }
1385
1386 impl LitKind {
1387     /// Returns `true` if this literal is a string.
1388     pub fn is_str(&self) -> bool {
1389         match *self {
1390             LitKind::Str(..) => true,
1391             _ => false,
1392         }
1393     }
1394
1395     /// Returns `true` if this literal is byte literal string.
1396     pub fn is_bytestr(&self) -> bool {
1397         match self {
1398             LitKind::ByteStr(_) => true,
1399             _ => false,
1400         }
1401     }
1402
1403     /// Returns `true` if this is a numeric literal.
1404     pub fn is_numeric(&self) -> bool {
1405         match *self {
1406             LitKind::Int(..) | LitKind::Float(..) | LitKind::FloatUnsuffixed(..) => true,
1407             _ => false,
1408         }
1409     }
1410
1411     /// Returns `true` if this literal has no suffix.
1412     /// Note: this will return true for literals with prefixes such as raw strings and byte strings.
1413     pub fn is_unsuffixed(&self) -> bool {
1414         match *self {
1415             // unsuffixed variants
1416             LitKind::Str(..)
1417             | LitKind::ByteStr(..)
1418             | LitKind::Byte(..)
1419             | LitKind::Char(..)
1420             | LitKind::Err(..)
1421             | LitKind::Int(_, LitIntType::Unsuffixed)
1422             | LitKind::FloatUnsuffixed(..)
1423             | LitKind::Bool(..) => true,
1424             // suffixed variants
1425             LitKind::Int(_, LitIntType::Signed(..))
1426             | LitKind::Int(_, LitIntType::Unsigned(..))
1427             | LitKind::Float(..) => false,
1428         }
1429     }
1430
1431     /// Returns `true` if this literal has a suffix.
1432     pub fn is_suffixed(&self) -> bool {
1433         !self.is_unsuffixed()
1434     }
1435 }
1436
1437 // N.B., If you change this, you'll probably want to change the corresponding
1438 // type structure in `middle/ty.rs` as well.
1439 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1440 pub struct MutTy {
1441     pub ty: P<Ty>,
1442     pub mutbl: Mutability,
1443 }
1444
1445 /// Represents a method's signature in a trait declaration,
1446 /// or in an implementation.
1447 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1448 pub struct MethodSig {
1449     pub header: FnHeader,
1450     pub decl: P<FnDecl>,
1451 }
1452
1453 /// Represents an item declaration within a trait declaration,
1454 /// possibly including a default implementation. A trait item is
1455 /// either required (meaning it doesn't have an implementation, just a
1456 /// signature) or provided (meaning it has a default implementation).
1457 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1458 pub struct TraitItem {
1459     pub id: NodeId,
1460     pub ident: Ident,
1461     pub attrs: Vec<Attribute>,
1462     pub generics: Generics,
1463     pub node: TraitItemKind,
1464     pub span: Span,
1465     /// See `Item::tokens` for what this is.
1466     pub tokens: Option<TokenStream>,
1467 }
1468
1469 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1470 pub enum TraitItemKind {
1471     Const(P<Ty>, Option<P<Expr>>),
1472     Method(MethodSig, Option<P<Block>>),
1473     Type(GenericBounds, Option<P<Ty>>),
1474     Macro(Mac),
1475 }
1476
1477 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1478 pub struct ImplItem {
1479     pub id: NodeId,
1480     pub ident: Ident,
1481     pub vis: Visibility,
1482     pub defaultness: Defaultness,
1483     pub attrs: Vec<Attribute>,
1484     pub generics: Generics,
1485     pub node: ImplItemKind,
1486     pub span: Span,
1487     /// See `Item::tokens` for what this is.
1488     pub tokens: Option<TokenStream>,
1489 }
1490
1491 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1492 pub enum ImplItemKind {
1493     Const(P<Ty>, P<Expr>),
1494     Method(MethodSig, P<Block>),
1495     Type(P<Ty>),
1496     Existential(GenericBounds),
1497     Macro(Mac),
1498 }
1499
1500 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, RustcEncodable, RustcDecodable, Copy)]
1501 pub enum IntTy {
1502     Isize,
1503     I8,
1504     I16,
1505     I32,
1506     I64,
1507     I128,
1508 }
1509
1510 impl fmt::Debug for IntTy {
1511     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1512         fmt::Display::fmt(self, f)
1513     }
1514 }
1515
1516 impl fmt::Display for IntTy {
1517     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1518         write!(f, "{}", self.ty_to_string())
1519     }
1520 }
1521
1522 impl IntTy {
1523     pub fn ty_to_string(&self) -> &'static str {
1524         match *self {
1525             IntTy::Isize => "isize",
1526             IntTy::I8 => "i8",
1527             IntTy::I16 => "i16",
1528             IntTy::I32 => "i32",
1529             IntTy::I64 => "i64",
1530             IntTy::I128 => "i128",
1531         }
1532     }
1533
1534     pub fn val_to_string(&self, val: i128) -> String {
1535         // Cast to a `u128` so we can correctly print `INT128_MIN`. All integral types
1536         // are parsed as `u128`, so we wouldn't want to print an extra negative
1537         // sign.
1538         format!("{}{}", val as u128, self.ty_to_string())
1539     }
1540
1541     pub fn bit_width(&self) -> Option<usize> {
1542         Some(match *self {
1543             IntTy::Isize => return None,
1544             IntTy::I8 => 8,
1545             IntTy::I16 => 16,
1546             IntTy::I32 => 32,
1547             IntTy::I64 => 64,
1548             IntTy::I128 => 128,
1549         })
1550     }
1551 }
1552
1553 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, RustcEncodable, RustcDecodable, Copy)]
1554 pub enum UintTy {
1555     Usize,
1556     U8,
1557     U16,
1558     U32,
1559     U64,
1560     U128,
1561 }
1562
1563 impl UintTy {
1564     pub fn ty_to_string(&self) -> &'static str {
1565         match *self {
1566             UintTy::Usize => "usize",
1567             UintTy::U8 => "u8",
1568             UintTy::U16 => "u16",
1569             UintTy::U32 => "u32",
1570             UintTy::U64 => "u64",
1571             UintTy::U128 => "u128",
1572         }
1573     }
1574
1575     pub fn val_to_string(&self, val: u128) -> String {
1576         format!("{}{}", val, self.ty_to_string())
1577     }
1578
1579     pub fn bit_width(&self) -> Option<usize> {
1580         Some(match *self {
1581             UintTy::Usize => return None,
1582             UintTy::U8 => 8,
1583             UintTy::U16 => 16,
1584             UintTy::U32 => 32,
1585             UintTy::U64 => 64,
1586             UintTy::U128 => 128,
1587         })
1588     }
1589 }
1590
1591 impl fmt::Debug for UintTy {
1592     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1593         fmt::Display::fmt(self, f)
1594     }
1595 }
1596
1597 impl fmt::Display for UintTy {
1598     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1599         write!(f, "{}", self.ty_to_string())
1600     }
1601 }
1602
1603 // Bind a type to an associated type: `A = Foo`.
1604 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1605 pub struct TypeBinding {
1606     pub id: NodeId,
1607     pub ident: Ident,
1608     pub ty: P<Ty>,
1609     pub span: Span,
1610 }
1611
1612 #[derive(Clone, RustcEncodable, RustcDecodable)]
1613 pub struct Ty {
1614     pub id: NodeId,
1615     pub node: TyKind,
1616     pub span: Span,
1617 }
1618
1619 impl fmt::Debug for Ty {
1620     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1621         write!(f, "type({})", pprust::ty_to_string(self))
1622     }
1623 }
1624
1625 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1626 pub struct BareFnTy {
1627     pub unsafety: Unsafety,
1628     pub abi: Abi,
1629     pub generic_params: Vec<GenericParam>,
1630     pub decl: P<FnDecl>,
1631 }
1632
1633 /// The various kinds of type recognized by the compiler.
1634 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1635 pub enum TyKind {
1636     /// A variable-length slice (`[T]`).
1637     Slice(P<Ty>),
1638     /// A fixed length array (`[T; n]`).
1639     Array(P<Ty>, AnonConst),
1640     /// A raw pointer (`*const T` or `*mut T`).
1641     Ptr(MutTy),
1642     /// A reference (`&'a T` or `&'a mut T`).
1643     Rptr(Option<Lifetime>, MutTy),
1644     /// A bare function (e.g., `fn(usize) -> bool`).
1645     BareFn(P<BareFnTy>),
1646     /// The never type (`!`).
1647     Never,
1648     /// A tuple (`(A, B, C, D,...)`).
1649     Tup(Vec<P<Ty>>),
1650     /// A path (`module::module::...::Type`), optionally
1651     /// "qualified", e.g., `<Vec<T> as SomeTrait>::SomeType`.
1652     ///
1653     /// Type parameters are stored in the `Path` itself.
1654     Path(Option<QSelf>, Path),
1655     /// A trait object type `Bound1 + Bound2 + Bound3`
1656     /// where `Bound` is a trait or a lifetime.
1657     TraitObject(GenericBounds, TraitObjectSyntax),
1658     /// An `impl Bound1 + Bound2 + Bound3` type
1659     /// where `Bound` is a trait or a lifetime.
1660     ///
1661     /// The `NodeId` exists to prevent lowering from having to
1662     /// generate `NodeId`s on the fly, which would complicate
1663     /// the generation of `existential type` items significantly.
1664     ImplTrait(NodeId, GenericBounds),
1665     /// No-op; kept solely so that we can pretty-print faithfully.
1666     Paren(P<Ty>),
1667     /// Unused for now.
1668     Typeof(AnonConst),
1669     /// This means the type should be inferred instead of it having been
1670     /// specified. This can appear anywhere in a type.
1671     Infer,
1672     /// Inferred type of a `self` or `&self` argument in a method.
1673     ImplicitSelf,
1674     /// A macro in the type position.
1675     Mac(Mac),
1676     /// Placeholder for a kind that has failed to be defined.
1677     Err,
1678     /// Placeholder for a `va_list`.
1679     CVarArgs,
1680 }
1681
1682 impl TyKind {
1683     pub fn is_implicit_self(&self) -> bool {
1684         if let TyKind::ImplicitSelf = *self {
1685             true
1686         } else {
1687             false
1688         }
1689     }
1690
1691     pub fn is_unit(&self) -> bool {
1692         if let TyKind::Tup(ref tys) = *self {
1693             tys.is_empty()
1694         } else {
1695             false
1696         }
1697     }
1698 }
1699
1700 /// Syntax used to declare a trait object.
1701 #[derive(Clone, Copy, PartialEq, RustcEncodable, RustcDecodable, Debug)]
1702 pub enum TraitObjectSyntax {
1703     Dyn,
1704     None,
1705 }
1706
1707 /// Inline assembly dialect.
1708 ///
1709 /// E.g., `"intel"` as in `asm!("mov eax, 2" : "={eax}"(result) : : : "intel")`.
1710 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
1711 pub enum AsmDialect {
1712     Att,
1713     Intel,
1714 }
1715
1716 /// Inline assembly.
1717 ///
1718 /// E.g., `"={eax}"(result)` as in `asm!("mov eax, 2" : "={eax}"(result) : : : "intel")`.
1719 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1720 pub struct InlineAsmOutput {
1721     pub constraint: Symbol,
1722     pub expr: P<Expr>,
1723     pub is_rw: bool,
1724     pub is_indirect: bool,
1725 }
1726
1727 /// Inline assembly.
1728 ///
1729 /// E.g., `asm!("NOP");`.
1730 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1731 pub struct InlineAsm {
1732     pub asm: Symbol,
1733     pub asm_str_style: StrStyle,
1734     pub outputs: Vec<InlineAsmOutput>,
1735     pub inputs: Vec<(Symbol, P<Expr>)>,
1736     pub clobbers: Vec<Symbol>,
1737     pub volatile: bool,
1738     pub alignstack: bool,
1739     pub dialect: AsmDialect,
1740     pub ctxt: SyntaxContext,
1741 }
1742
1743 /// An argument in a function header.
1744 ///
1745 /// E.g., `bar: usize` as in `fn foo(bar: usize)`.
1746 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1747 pub struct Arg {
1748     pub ty: P<Ty>,
1749     pub pat: P<Pat>,
1750     pub id: NodeId,
1751     pub source: ArgSource,
1752 }
1753
1754 /// The source of an argument in a function header.
1755 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1756 pub enum ArgSource {
1757     /// Argument as written by the user.
1758     Normal,
1759     /// Argument from `async fn` lowering, contains the original binding pattern.
1760     AsyncFn(P<Pat>),
1761 }
1762
1763 /// Alternative representation for `Arg`s describing `self` parameter of methods.
1764 ///
1765 /// E.g., `&mut self` as in `fn foo(&mut self)`.
1766 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1767 pub enum SelfKind {
1768     /// `self`, `mut self`
1769     Value(Mutability),
1770     /// `&'lt self`, `&'lt mut self`
1771     Region(Option<Lifetime>, Mutability),
1772     /// `self: TYPE`, `mut self: TYPE`
1773     Explicit(P<Ty>, Mutability),
1774 }
1775
1776 pub type ExplicitSelf = Spanned<SelfKind>;
1777
1778 impl Arg {
1779     pub fn to_self(&self) -> Option<ExplicitSelf> {
1780         if let PatKind::Ident(BindingMode::ByValue(mutbl), ident, _) = self.pat.node {
1781             if ident.name == kw::SelfLower {
1782                 return match self.ty.node {
1783                     TyKind::ImplicitSelf => Some(respan(self.pat.span, SelfKind::Value(mutbl))),
1784                     TyKind::Rptr(lt, MutTy { ref ty, mutbl }) if ty.node.is_implicit_self() => {
1785                         Some(respan(self.pat.span, SelfKind::Region(lt, mutbl)))
1786                     }
1787                     _ => Some(respan(
1788                         self.pat.span.to(self.ty.span),
1789                         SelfKind::Explicit(self.ty.clone(), mutbl),
1790                     )),
1791                 };
1792             }
1793         }
1794         None
1795     }
1796
1797     pub fn is_self(&self) -> bool {
1798         if let PatKind::Ident(_, ident, _) = self.pat.node {
1799             ident.name == kw::SelfLower
1800         } else {
1801             false
1802         }
1803     }
1804
1805     pub fn from_self(eself: ExplicitSelf, eself_ident: Ident) -> Arg {
1806         let span = eself.span.to(eself_ident.span);
1807         let infer_ty = P(Ty {
1808             id: DUMMY_NODE_ID,
1809             node: TyKind::ImplicitSelf,
1810             span,
1811         });
1812         let arg = |mutbl, ty| Arg {
1813             pat: P(Pat {
1814                 id: DUMMY_NODE_ID,
1815                 node: PatKind::Ident(BindingMode::ByValue(mutbl), eself_ident, None),
1816                 span,
1817             }),
1818             ty,
1819             id: DUMMY_NODE_ID,
1820             source: ArgSource::Normal,
1821         };
1822         match eself.node {
1823             SelfKind::Explicit(ty, mutbl) => arg(mutbl, ty),
1824             SelfKind::Value(mutbl) => arg(mutbl, infer_ty),
1825             SelfKind::Region(lt, mutbl) => arg(
1826                 Mutability::Immutable,
1827                 P(Ty {
1828                     id: DUMMY_NODE_ID,
1829                     node: TyKind::Rptr(
1830                         lt,
1831                         MutTy {
1832                             ty: infer_ty,
1833                             mutbl: mutbl,
1834                         },
1835                     ),
1836                     span,
1837                 }),
1838             ),
1839         }
1840     }
1841 }
1842
1843 /// Header (not the body) of a function declaration.
1844 ///
1845 /// E.g., `fn foo(bar: baz)`.
1846 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1847 pub struct FnDecl {
1848     pub inputs: Vec<Arg>,
1849     pub output: FunctionRetTy,
1850     pub c_variadic: bool,
1851 }
1852
1853 impl FnDecl {
1854     pub fn get_self(&self) -> Option<ExplicitSelf> {
1855         self.inputs.get(0).and_then(Arg::to_self)
1856     }
1857     pub fn has_self(&self) -> bool {
1858         self.inputs.get(0).map(Arg::is_self).unwrap_or(false)
1859     }
1860 }
1861
1862 /// Is the trait definition an auto trait?
1863 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
1864 pub enum IsAuto {
1865     Yes,
1866     No,
1867 }
1868
1869 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
1870 pub enum Unsafety {
1871     Unsafe,
1872     Normal,
1873 }
1874
1875 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1876 pub struct AsyncArgument {
1877     /// `__arg0`
1878     pub ident: Ident,
1879     /// `__arg0: <ty>` argument to replace existing function argument `<pat>: <ty>`. Only if
1880     /// argument is not a simple binding.
1881     pub arg: Option<Arg>,
1882     /// `let __arg0 = __arg0;` statement to be inserted at the start of the block.
1883     pub move_stmt: Stmt,
1884     /// `let <pat> = __arg0;` statement to be inserted at the start of the block, after matching
1885     /// move statement. Only if argument is not a simple binding.
1886     pub pat_stmt: Option<Stmt>,
1887 }
1888
1889 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1890 pub enum IsAsync {
1891     Async {
1892         closure_id: NodeId,
1893         return_impl_trait_id: NodeId,
1894         /// This field stores the arguments and statements that are used in HIR lowering to
1895         /// ensure that `async fn` arguments are dropped at the correct time.
1896         ///
1897         /// The argument and statements here are generated at parse time as they are required in
1898         /// both the hir lowering, def collection and name resolution and this stops them needing
1899         /// to be created in each place.
1900         arguments: Vec<AsyncArgument>,
1901     },
1902     NotAsync,
1903 }
1904
1905 impl IsAsync {
1906     pub fn is_async(&self) -> bool {
1907         if let IsAsync::Async { .. } = *self {
1908             true
1909         } else {
1910             false
1911         }
1912     }
1913
1914     /// In ths case this is an `async` return, the `NodeId` for the generated `impl Trait` item.
1915     pub fn opt_return_id(&self) -> Option<NodeId> {
1916         match self {
1917             IsAsync::Async {
1918                 return_impl_trait_id,
1919                 ..
1920             } => Some(*return_impl_trait_id),
1921             IsAsync::NotAsync => None,
1922         }
1923     }
1924 }
1925
1926 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
1927 pub enum Constness {
1928     Const,
1929     NotConst,
1930 }
1931
1932 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
1933 pub enum Defaultness {
1934     Default,
1935     Final,
1936 }
1937
1938 impl fmt::Display for Unsafety {
1939     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1940         fmt::Display::fmt(
1941             match *self {
1942                 Unsafety::Normal => "normal",
1943                 Unsafety::Unsafe => "unsafe",
1944             },
1945             f,
1946         )
1947     }
1948 }
1949
1950 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable)]
1951 pub enum ImplPolarity {
1952     /// `impl Trait for Type`
1953     Positive,
1954     /// `impl !Trait for Type`
1955     Negative,
1956 }
1957
1958 impl fmt::Debug for ImplPolarity {
1959     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1960         match *self {
1961             ImplPolarity::Positive => "positive".fmt(f),
1962             ImplPolarity::Negative => "negative".fmt(f),
1963         }
1964     }
1965 }
1966
1967 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1968 pub enum FunctionRetTy {
1969     /// Returns type is not specified.
1970     ///
1971     /// Functions default to `()` and closures default to inference.
1972     /// Span points to where return type would be inserted.
1973     Default(Span),
1974     /// Everything else.
1975     Ty(P<Ty>),
1976 }
1977
1978 impl FunctionRetTy {
1979     pub fn span(&self) -> Span {
1980         match *self {
1981             FunctionRetTy::Default(span) => span,
1982             FunctionRetTy::Ty(ref ty) => ty.span,
1983         }
1984     }
1985 }
1986
1987 /// Module declaration.
1988 ///
1989 /// E.g., `mod foo;` or `mod foo { .. }`.
1990 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1991 pub struct Mod {
1992     /// A span from the first token past `{` to the last token until `}`.
1993     /// For `mod foo;`, the inner span ranges from the first token
1994     /// to the last token in the external file.
1995     pub inner: Span,
1996     pub items: Vec<P<Item>>,
1997     /// `true` for `mod foo { .. }`; `false` for `mod foo;`.
1998     pub inline: bool,
1999 }
2000
2001 /// Foreign module declaration.
2002 ///
2003 /// E.g., `extern { .. }` or `extern C { .. }`.
2004 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2005 pub struct ForeignMod {
2006     pub abi: Abi,
2007     pub items: Vec<ForeignItem>,
2008 }
2009
2010 /// Global inline assembly.
2011 ///
2012 /// Also known as "module-level assembly" or "file-scoped assembly".
2013 #[derive(Clone, RustcEncodable, RustcDecodable, Debug, Copy)]
2014 pub struct GlobalAsm {
2015     pub asm: Symbol,
2016     pub ctxt: SyntaxContext,
2017 }
2018
2019 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2020 pub struct EnumDef {
2021     pub variants: Vec<Variant>,
2022 }
2023
2024 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2025 pub struct Variant_ {
2026     /// Name of the variant.
2027     pub ident: Ident,
2028     /// Attributes of the variant.
2029     pub attrs: Vec<Attribute>,
2030     /// Id of the variant (not the constructor, see `VariantData::ctor_id()`).
2031     pub id: NodeId,
2032     /// Fields and constructor id of the variant.
2033     pub data: VariantData,
2034     /// Explicit discriminant, e.g., `Foo = 1`.
2035     pub disr_expr: Option<AnonConst>,
2036 }
2037
2038 pub type Variant = Spanned<Variant_>;
2039
2040 /// Part of `use` item to the right of its prefix.
2041 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2042 pub enum UseTreeKind {
2043     /// `use prefix` or `use prefix as rename`
2044     ///
2045     /// The extra `NodeId`s are for HIR lowering, when additional statements are created for each
2046     /// namespace.
2047     Simple(Option<Ident>, NodeId, NodeId),
2048     /// `use prefix::{...}`
2049     Nested(Vec<(UseTree, NodeId)>),
2050     /// `use prefix::*`
2051     Glob,
2052 }
2053
2054 /// A tree of paths sharing common prefixes.
2055 /// Used in `use` items both at top-level and inside of braces in import groups.
2056 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2057 pub struct UseTree {
2058     pub prefix: Path,
2059     pub kind: UseTreeKind,
2060     pub span: Span,
2061 }
2062
2063 impl UseTree {
2064     pub fn ident(&self) -> Ident {
2065         match self.kind {
2066             UseTreeKind::Simple(Some(rename), ..) => rename,
2067             UseTreeKind::Simple(None, ..) => {
2068                 self.prefix
2069                     .segments
2070                     .last()
2071                     .expect("empty prefix in a simple import")
2072                     .ident
2073             }
2074             _ => panic!("`UseTree::ident` can only be used on a simple import"),
2075         }
2076     }
2077 }
2078
2079 /// Distinguishes between `Attribute`s that decorate items and Attributes that
2080 /// are contained as statements within items. These two cases need to be
2081 /// distinguished for pretty-printing.
2082 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
2083 pub enum AttrStyle {
2084     Outer,
2085     Inner,
2086 }
2087
2088 #[derive(
2089     Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug, PartialOrd, Ord, Copy,
2090 )]
2091 pub struct AttrId(pub usize);
2092
2093 impl Idx for AttrId {
2094     fn new(idx: usize) -> Self {
2095         AttrId(idx)
2096     }
2097     fn index(self) -> usize {
2098         self.0
2099     }
2100 }
2101
2102 /// Metadata associated with an item.
2103 /// Doc-comments are promoted to attributes that have `is_sugared_doc = true`.
2104 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2105 pub struct Attribute {
2106     pub id: AttrId,
2107     pub style: AttrStyle,
2108     pub path: Path,
2109     pub tokens: TokenStream,
2110     pub is_sugared_doc: bool,
2111     pub span: Span,
2112 }
2113
2114 /// `TraitRef`s appear in impls.
2115 ///
2116 /// Resolution maps each `TraitRef`'s `ref_id` to its defining trait; that's all
2117 /// that the `ref_id` is for. The `impl_id` maps to the "self type" of this impl.
2118 /// If this impl is an `ItemKind::Impl`, the `impl_id` is redundant (it could be the
2119 /// same as the impl's `NodeId`).
2120 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2121 pub struct TraitRef {
2122     pub path: Path,
2123     pub ref_id: NodeId,
2124 }
2125
2126 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2127 pub struct PolyTraitRef {
2128     /// The `'a` in `<'a> Foo<&'a T>`.
2129     pub bound_generic_params: Vec<GenericParam>,
2130
2131     /// The `Foo<&'a T>` in `<'a> Foo<&'a T>`.
2132     pub trait_ref: TraitRef,
2133
2134     pub span: Span,
2135 }
2136
2137 impl PolyTraitRef {
2138     pub fn new(generic_params: Vec<GenericParam>, path: Path, span: Span) -> Self {
2139         PolyTraitRef {
2140             bound_generic_params: generic_params,
2141             trait_ref: TraitRef {
2142                 path: path,
2143                 ref_id: DUMMY_NODE_ID,
2144             },
2145             span,
2146         }
2147     }
2148 }
2149
2150 #[derive(Copy, Clone, RustcEncodable, RustcDecodable, Debug)]
2151 pub enum CrateSugar {
2152     /// Source is `pub(crate)`.
2153     PubCrate,
2154
2155     /// Source is (just) `crate`.
2156     JustCrate,
2157 }
2158
2159 pub type Visibility = Spanned<VisibilityKind>;
2160
2161 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2162 pub enum VisibilityKind {
2163     Public,
2164     Crate(CrateSugar),
2165     Restricted { path: P<Path>, id: NodeId },
2166     Inherited,
2167 }
2168
2169 impl VisibilityKind {
2170     pub fn is_pub(&self) -> bool {
2171         if let VisibilityKind::Public = *self {
2172             true
2173         } else {
2174             false
2175         }
2176     }
2177 }
2178
2179 /// Field of a struct.
2180 ///
2181 /// E.g., `bar: usize` as in `struct Foo { bar: usize }`.
2182 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2183 pub struct StructField {
2184     pub span: Span,
2185     pub ident: Option<Ident>,
2186     pub vis: Visibility,
2187     pub id: NodeId,
2188     pub ty: P<Ty>,
2189     pub attrs: Vec<Attribute>,
2190 }
2191
2192 /// Fields and constructor ids of enum variants and structs.
2193 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2194 pub enum VariantData {
2195     /// Struct variant.
2196     ///
2197     /// E.g., `Bar { .. }` as in `enum Foo { Bar { .. } }`.
2198     Struct(Vec<StructField>, bool),
2199     /// Tuple variant.
2200     ///
2201     /// E.g., `Bar(..)` as in `enum Foo { Bar(..) }`.
2202     Tuple(Vec<StructField>, NodeId),
2203     /// Unit variant.
2204     ///
2205     /// E.g., `Bar = ..` as in `enum Foo { Bar = .. }`.
2206     Unit(NodeId),
2207 }
2208
2209 impl VariantData {
2210     /// Return the fields of this variant.
2211     pub fn fields(&self) -> &[StructField] {
2212         match *self {
2213             VariantData::Struct(ref fields, ..) | VariantData::Tuple(ref fields, _) => fields,
2214             _ => &[],
2215         }
2216     }
2217
2218     /// Return the `NodeId` of this variant's constructor, if it has one.
2219     pub fn ctor_id(&self) -> Option<NodeId> {
2220         match *self {
2221             VariantData::Struct(..) => None,
2222             VariantData::Tuple(_, id) | VariantData::Unit(id) => Some(id),
2223         }
2224     }
2225 }
2226
2227 /// An item.
2228 ///
2229 /// The name might be a dummy name in case of anonymous items.
2230 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2231 pub struct Item {
2232     pub ident: Ident,
2233     pub attrs: Vec<Attribute>,
2234     pub id: NodeId,
2235     pub node: ItemKind,
2236     pub vis: Visibility,
2237     pub span: Span,
2238
2239     /// Original tokens this item was parsed from. This isn't necessarily
2240     /// available for all items, although over time more and more items should
2241     /// have this be `Some`. Right now this is primarily used for procedural
2242     /// macros, notably custom attributes.
2243     ///
2244     /// Note that the tokens here do not include the outer attributes, but will
2245     /// include inner attributes.
2246     pub tokens: Option<TokenStream>,
2247 }
2248
2249 impl Item {
2250     /// Return the span that encompasses the attributes.
2251     pub fn span_with_attributes(&self) -> Span {
2252         self.attrs.iter().fold(self.span, |acc, attr| acc.to(attr.span))
2253     }
2254 }
2255
2256 /// A function header.
2257 ///
2258 /// All the information between the visibility and the name of the function is
2259 /// included in this struct (e.g., `async unsafe fn` or `const extern "C" fn`).
2260 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2261 pub struct FnHeader {
2262     pub unsafety: Unsafety,
2263     pub asyncness: Spanned<IsAsync>,
2264     pub constness: Spanned<Constness>,
2265     pub abi: Abi,
2266 }
2267
2268 impl Default for FnHeader {
2269     fn default() -> FnHeader {
2270         FnHeader {
2271             unsafety: Unsafety::Normal,
2272             asyncness: dummy_spanned(IsAsync::NotAsync),
2273             constness: dummy_spanned(Constness::NotConst),
2274             abi: Abi::Rust,
2275         }
2276     }
2277 }
2278
2279 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2280 pub enum ItemKind {
2281     /// An `extern crate` item, with optional *original* crate name if the crate was renamed.
2282     ///
2283     /// E.g., `extern crate foo` or `extern crate foo_bar as foo`.
2284     ExternCrate(Option<Name>),
2285     /// A use declaration (`use` or `pub use`) item.
2286     ///
2287     /// E.g., `use foo;`, `use foo::bar;` or `use foo::bar as FooBar;`.
2288     Use(P<UseTree>),
2289     /// A static item (`static` or `pub static`).
2290     ///
2291     /// E.g., `static FOO: i32 = 42;` or `static FOO: &'static str = "bar";`.
2292     Static(P<Ty>, Mutability, P<Expr>),
2293     /// A constant item (`const` or `pub const`).
2294     ///
2295     /// E.g., `const FOO: i32 = 42;`.
2296     Const(P<Ty>, P<Expr>),
2297     /// A function declaration (`fn` or `pub fn`).
2298     ///
2299     /// E.g., `fn foo(bar: usize) -> usize { .. }`.
2300     Fn(P<FnDecl>, FnHeader, Generics, P<Block>),
2301     /// A module declaration (`mod` or `pub mod`).
2302     ///
2303     /// E.g., `mod foo;` or `mod foo { .. }`.
2304     Mod(Mod),
2305     /// An external module (`extern` or `pub extern`).
2306     ///
2307     /// E.g., `extern {}` or `extern "C" {}`.
2308     ForeignMod(ForeignMod),
2309     /// Module-level inline assembly (from `global_asm!()`).
2310     GlobalAsm(P<GlobalAsm>),
2311     /// A type alias (`type` or `pub type`).
2312     ///
2313     /// E.g., `type Foo = Bar<u8>;`.
2314     Ty(P<Ty>, Generics),
2315     /// An existential type declaration (`existential type`).
2316     ///
2317     /// E.g., `existential type Foo: Bar + Boo;`.
2318     Existential(GenericBounds, Generics),
2319     /// An enum definition (`enum` or `pub enum`).
2320     ///
2321     /// E.g., `enum Foo<A, B> { C<A>, D<B> }`.
2322     Enum(EnumDef, Generics),
2323     /// A struct definition (`struct` or `pub struct`).
2324     ///
2325     /// E.g., `struct Foo<A> { x: A }`.
2326     Struct(VariantData, Generics),
2327     /// A union definition (`union` or `pub union`).
2328     ///
2329     /// E.g., `union Foo<A, B> { x: A, y: B }`.
2330     Union(VariantData, Generics),
2331     /// A Trait declaration (`trait` or `pub trait`).
2332     ///
2333     /// E.g., `trait Foo { .. }`, `trait Foo<T> { .. }` or `auto trait Foo {}`.
2334     Trait(IsAuto, Unsafety, Generics, GenericBounds, Vec<TraitItem>),
2335     /// Trait alias
2336     ///
2337     /// E.g., `trait Foo = Bar + Quux;`.
2338     TraitAlias(Generics, GenericBounds),
2339     /// An implementation.
2340     ///
2341     /// E.g., `impl<A> Foo<A> { .. }` or `impl<A> Trait for Foo<A> { .. }`.
2342     Impl(
2343         Unsafety,
2344         ImplPolarity,
2345         Defaultness,
2346         Generics,
2347         Option<TraitRef>, // (optional) trait this impl implements
2348         P<Ty>,            // self
2349         Vec<ImplItem>,
2350     ),
2351     /// A macro invocation.
2352     ///
2353     /// E.g., `macro_rules! foo { .. }` or `foo!(..)`.
2354     Mac(Mac),
2355
2356     /// A macro definition.
2357     MacroDef(MacroDef),
2358 }
2359
2360 impl ItemKind {
2361     pub fn descriptive_variant(&self) -> &str {
2362         match *self {
2363             ItemKind::ExternCrate(..) => "extern crate",
2364             ItemKind::Use(..) => "use",
2365             ItemKind::Static(..) => "static item",
2366             ItemKind::Const(..) => "constant item",
2367             ItemKind::Fn(..) => "function",
2368             ItemKind::Mod(..) => "module",
2369             ItemKind::ForeignMod(..) => "foreign module",
2370             ItemKind::GlobalAsm(..) => "global asm",
2371             ItemKind::Ty(..) => "type alias",
2372             ItemKind::Existential(..) => "existential type",
2373             ItemKind::Enum(..) => "enum",
2374             ItemKind::Struct(..) => "struct",
2375             ItemKind::Union(..) => "union",
2376             ItemKind::Trait(..) => "trait",
2377             ItemKind::TraitAlias(..) => "trait alias",
2378             ItemKind::Mac(..) | ItemKind::MacroDef(..) | ItemKind::Impl(..) => "item",
2379         }
2380     }
2381 }
2382
2383 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2384 pub struct ForeignItem {
2385     pub ident: Ident,
2386     pub attrs: Vec<Attribute>,
2387     pub node: ForeignItemKind,
2388     pub id: NodeId,
2389     pub span: Span,
2390     pub vis: Visibility,
2391 }
2392
2393 /// An item within an `extern` block.
2394 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2395 pub enum ForeignItemKind {
2396     /// A foreign function.
2397     Fn(P<FnDecl>, Generics),
2398     /// A foreign static item (`static ext: u8`).
2399     Static(P<Ty>, Mutability),
2400     /// A foreign type.
2401     Ty,
2402     /// A macro invocation.
2403     Macro(Mac),
2404 }
2405
2406 impl ForeignItemKind {
2407     pub fn descriptive_variant(&self) -> &str {
2408         match *self {
2409             ForeignItemKind::Fn(..) => "foreign function",
2410             ForeignItemKind::Static(..) => "foreign static item",
2411             ForeignItemKind::Ty => "foreign type",
2412             ForeignItemKind::Macro(..) => "macro in foreign module",
2413         }
2414     }
2415 }
2416
2417 #[cfg(test)]
2418 mod tests {
2419     use super::*;
2420     use serialize;
2421
2422     // Are ASTs encodable?
2423     #[test]
2424     fn check_asts_encodable() {
2425         fn assert_encodable<T: serialize::Encodable>() {}
2426         assert_encodable::<Crate>();
2427     }
2428 }