src/libsyntax/ast.rs

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