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     Macro(Mac),
1583 }
1584
1585 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, RustcEncodable, RustcDecodable, Debug)]
1586 pub enum FloatTy {
1587     F32,
1588     F64,
1589 }
1590
1591 impl FloatTy {
1592     pub fn name_str(self) -> &'static str {
1593         match self {
1594             FloatTy::F32 => "f32",
1595             FloatTy::F64 => "f64",
1596         }
1597     }
1598
1599     pub fn name(self) -> Symbol {
1600         match self {
1601             FloatTy::F32 => sym::f32,
1602             FloatTy::F64 => sym::f64,
1603         }
1604     }
1605
1606     pub fn bit_width(self) -> usize {
1607         match self {
1608             FloatTy::F32 => 32,
1609             FloatTy::F64 => 64,
1610         }
1611     }
1612 }
1613
1614 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, RustcEncodable, RustcDecodable, Debug)]
1615 pub enum IntTy {
1616     Isize,
1617     I8,
1618     I16,
1619     I32,
1620     I64,
1621     I128,
1622 }
1623
1624 impl IntTy {
1625     pub fn name_str(&self) -> &'static str {
1626         match *self {
1627             IntTy::Isize => "isize",
1628             IntTy::I8 => "i8",
1629             IntTy::I16 => "i16",
1630             IntTy::I32 => "i32",
1631             IntTy::I64 => "i64",
1632             IntTy::I128 => "i128",
1633         }
1634     }
1635
1636     pub fn name(&self) -> Symbol {
1637         match *self {
1638             IntTy::Isize => sym::isize,
1639             IntTy::I8 => sym::i8,
1640             IntTy::I16 => sym::i16,
1641             IntTy::I32 => sym::i32,
1642             IntTy::I64 => sym::i64,
1643             IntTy::I128 => sym::i128,
1644         }
1645     }
1646
1647     pub fn val_to_string(&self, val: i128) -> String {
1648         // Cast to a `u128` so we can correctly print `INT128_MIN`. All integral types
1649         // are parsed as `u128`, so we wouldn't want to print an extra negative
1650         // sign.
1651         format!("{}{}", val as u128, self.name_str())
1652     }
1653
1654     pub fn bit_width(&self) -> Option<usize> {
1655         Some(match *self {
1656             IntTy::Isize => return None,
1657             IntTy::I8 => 8,
1658             IntTy::I16 => 16,
1659             IntTy::I32 => 32,
1660             IntTy::I64 => 64,
1661             IntTy::I128 => 128,
1662         })
1663     }
1664 }
1665
1666 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, RustcEncodable, RustcDecodable, Copy, Debug)]
1667 pub enum UintTy {
1668     Usize,
1669     U8,
1670     U16,
1671     U32,
1672     U64,
1673     U128,
1674 }
1675
1676 impl UintTy {
1677     pub fn name_str(&self) -> &'static str {
1678         match *self {
1679             UintTy::Usize => "usize",
1680             UintTy::U8 => "u8",
1681             UintTy::U16 => "u16",
1682             UintTy::U32 => "u32",
1683             UintTy::U64 => "u64",
1684             UintTy::U128 => "u128",
1685         }
1686     }
1687
1688     pub fn name(&self) -> Symbol {
1689         match *self {
1690             UintTy::Usize => sym::usize,
1691             UintTy::U8 => sym::u8,
1692             UintTy::U16 => sym::u16,
1693             UintTy::U32 => sym::u32,
1694             UintTy::U64 => sym::u64,
1695             UintTy::U128 => sym::u128,
1696         }
1697     }
1698
1699     pub fn val_to_string(&self, val: u128) -> String {
1700         format!("{}{}", val, self.name_str())
1701     }
1702
1703     pub fn bit_width(&self) -> Option<usize> {
1704         Some(match *self {
1705             UintTy::Usize => return None,
1706             UintTy::U8 => 8,
1707             UintTy::U16 => 16,
1708             UintTy::U32 => 32,
1709             UintTy::U64 => 64,
1710             UintTy::U128 => 128,
1711         })
1712     }
1713 }
1714
1715 /// A constraint on an associated type (e.g., `A = Bar` in `Foo<A = Bar>` or
1716 /// `A: TraitA + TraitB` in `Foo<A: TraitA + TraitB>`).
1717 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1718 pub struct AssocTyConstraint {
1719     pub id: NodeId,
1720     pub ident: Ident,
1721     pub kind: AssocTyConstraintKind,
1722     pub span: Span,
1723 }
1724
1725 /// The kinds of an `AssocTyConstraint`.
1726 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1727 pub enum AssocTyConstraintKind {
1728     /// E.g., `A = Bar` in `Foo<A = Bar>`.
1729     Equality {
1730         ty: P<Ty>,
1731     },
1732     /// E.g. `A: TraitA + TraitB` in `Foo<A: TraitA + TraitB>`.
1733     Bound {
1734         bounds: GenericBounds,
1735     },
1736 }
1737
1738 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1739 pub struct Ty {
1740     pub id: NodeId,
1741     pub kind: TyKind,
1742     pub span: Span,
1743 }
1744
1745 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1746 pub struct BareFnTy {
1747     pub unsafety: Unsafety,
1748     pub ext: Extern,
1749     pub generic_params: Vec<GenericParam>,
1750     pub decl: P<FnDecl>,
1751 }
1752
1753 /// The various kinds of type recognized by the compiler.
1754 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1755 pub enum TyKind {
1756     /// A variable-length slice (`[T]`).
1757     Slice(P<Ty>),
1758     /// A fixed length array (`[T; n]`).
1759     Array(P<Ty>, AnonConst),
1760     /// A raw pointer (`*const T` or `*mut T`).
1761     Ptr(MutTy),
1762     /// A reference (`&'a T` or `&'a mut T`).
1763     Rptr(Option<Lifetime>, MutTy),
1764     /// A bare function (e.g., `fn(usize) -> bool`).
1765     BareFn(P<BareFnTy>),
1766     /// The never type (`!`).
1767     Never,
1768     /// A tuple (`(A, B, C, D,...)`).
1769     Tup(Vec<P<Ty>>),
1770     /// A path (`module::module::...::Type`), optionally
1771     /// "qualified", e.g., `<Vec<T> as SomeTrait>::SomeType`.
1772     ///
1773     /// Type parameters are stored in the `Path` itself.
1774     Path(Option<QSelf>, Path),
1775     /// A trait object type `Bound1 + Bound2 + Bound3`
1776     /// where `Bound` is a trait or a lifetime.
1777     TraitObject(GenericBounds, TraitObjectSyntax),
1778     /// An `impl Bound1 + Bound2 + Bound3` type
1779     /// where `Bound` is a trait or a lifetime.
1780     ///
1781     /// The `NodeId` exists to prevent lowering from having to
1782     /// generate `NodeId`s on the fly, which would complicate
1783     /// the generation of opaque `type Foo = impl Trait` items significantly.
1784     ImplTrait(NodeId, GenericBounds),
1785     /// No-op; kept solely so that we can pretty-print faithfully.
1786     Paren(P<Ty>),
1787     /// Unused for now.
1788     Typeof(AnonConst),
1789     /// This means the type should be inferred instead of it having been
1790     /// specified. This can appear anywhere in a type.
1791     Infer,
1792     /// Inferred type of a `self` or `&self` argument in a method.
1793     ImplicitSelf,
1794     /// A macro in the type position.
1795     Mac(Mac),
1796     /// Placeholder for a kind that has failed to be defined.
1797     Err,
1798     /// Placeholder for a `va_list`.
1799     CVarArgs,
1800 }
1801
1802 impl TyKind {
1803     pub fn is_implicit_self(&self) -> bool {
1804         if let TyKind::ImplicitSelf = *self {
1805             true
1806         } else {
1807             false
1808         }
1809     }
1810
1811     pub fn is_unit(&self) -> bool {
1812         if let TyKind::Tup(ref tys) = *self {
1813             tys.is_empty()
1814         } else {
1815             false
1816         }
1817     }
1818
1819     /// HACK(type_alias_impl_trait, Centril): A temporary crutch used
1820     /// in lowering to avoid making larger changes there and beyond.
1821     pub fn opaque_top_hack(&self) -> Option<&GenericBounds> {
1822         match self {
1823             Self::ImplTrait(_, bounds) => Some(bounds),
1824             _ => None,
1825         }
1826     }
1827 }
1828
1829 /// Syntax used to declare a trait object.
1830 #[derive(Clone, Copy, PartialEq, RustcEncodable, RustcDecodable, Debug)]
1831 pub enum TraitObjectSyntax {
1832     Dyn,
1833     None,
1834 }
1835
1836 /// Inline assembly dialect.
1837 ///
1838 /// E.g., `"intel"` as in `asm!("mov eax, 2" : "={eax}"(result) : : : "intel")`.
1839 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
1840 pub enum AsmDialect {
1841     Att,
1842     Intel,
1843 }
1844
1845 /// Inline assembly.
1846 ///
1847 /// E.g., `"={eax}"(result)` as in `asm!("mov eax, 2" : "={eax}"(result) : : : "intel")`.
1848 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1849 pub struct InlineAsmOutput {
1850     pub constraint: Symbol,
1851     pub expr: P<Expr>,
1852     pub is_rw: bool,
1853     pub is_indirect: bool,
1854 }
1855
1856 /// Inline assembly.
1857 ///
1858 /// E.g., `asm!("NOP");`.
1859 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1860 pub struct InlineAsm {
1861     pub asm: Symbol,
1862     pub asm_str_style: StrStyle,
1863     pub outputs: Vec<InlineAsmOutput>,
1864     pub inputs: Vec<(Symbol, P<Expr>)>,
1865     pub clobbers: Vec<Symbol>,
1866     pub volatile: bool,
1867     pub alignstack: bool,
1868     pub dialect: AsmDialect,
1869 }
1870
1871 /// A parameter in a function header.
1872 ///
1873 /// E.g., `bar: usize` as in `fn foo(bar: usize)`.
1874 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1875 pub struct Param {
1876     pub attrs: ThinVec<Attribute>,
1877     pub ty: P<Ty>,
1878     pub pat: P<Pat>,
1879     pub id: NodeId,
1880     pub span: Span,
1881     pub is_placeholder: bool,
1882 }
1883
1884 /// Alternative representation for `Arg`s describing `self` parameter of methods.
1885 ///
1886 /// E.g., `&mut self` as in `fn foo(&mut self)`.
1887 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1888 pub enum SelfKind {
1889     /// `self`, `mut self`
1890     Value(Mutability),
1891     /// `&'lt self`, `&'lt mut self`
1892     Region(Option<Lifetime>, Mutability),
1893     /// `self: TYPE`, `mut self: TYPE`
1894     Explicit(P<Ty>, Mutability),
1895 }
1896
1897 pub type ExplicitSelf = Spanned<SelfKind>;
1898
1899 impl Param {
1900     /// Attempts to cast parameter to `ExplicitSelf`.
1901     pub fn to_self(&self) -> Option<ExplicitSelf> {
1902         if let PatKind::Ident(BindingMode::ByValue(mutbl), ident, _) = self.pat.kind {
1903             if ident.name == kw::SelfLower {
1904                 return match self.ty.kind {
1905                     TyKind::ImplicitSelf => Some(respan(self.pat.span, SelfKind::Value(mutbl))),
1906                     TyKind::Rptr(lt, MutTy { ref ty, mutbl }) if ty.kind.is_implicit_self() => {
1907                         Some(respan(self.pat.span, SelfKind::Region(lt, mutbl)))
1908                     }
1909                     _ => Some(respan(
1910                         self.pat.span.to(self.ty.span),
1911                         SelfKind::Explicit(self.ty.clone(), mutbl),
1912                     )),
1913                 };
1914             }
1915         }
1916         None
1917     }
1918
1919     /// Returns `true` if parameter is `self`.
1920     pub fn is_self(&self) -> bool {
1921         if let PatKind::Ident(_, ident, _) = self.pat.kind {
1922             ident.name == kw::SelfLower
1923         } else {
1924             false
1925         }
1926     }
1927
1928     /// Builds a `Param` object from `ExplicitSelf`.
1929     pub fn from_self(attrs: ThinVec<Attribute>, eself: ExplicitSelf, eself_ident: Ident) -> Param {
1930         let span = eself.span.to(eself_ident.span);
1931         let infer_ty = P(Ty {
1932             id: DUMMY_NODE_ID,
1933             kind: TyKind::ImplicitSelf,
1934             span,
1935         });
1936         let param = |mutbl, ty| Param {
1937             attrs,
1938             pat: P(Pat {
1939                 id: DUMMY_NODE_ID,
1940                 kind: PatKind::Ident(BindingMode::ByValue(mutbl), eself_ident, None),
1941                 span,
1942             }),
1943             span,
1944             ty,
1945             id: DUMMY_NODE_ID,
1946             is_placeholder: false
1947         };
1948         match eself.node {
1949             SelfKind::Explicit(ty, mutbl) => param(mutbl, ty),
1950             SelfKind::Value(mutbl) => param(mutbl, infer_ty),
1951             SelfKind::Region(lt, mutbl) => param(
1952                 Mutability::Immutable,
1953                 P(Ty {
1954                     id: DUMMY_NODE_ID,
1955                     kind: TyKind::Rptr(
1956                         lt,
1957                         MutTy {
1958                             ty: infer_ty,
1959                             mutbl,
1960                         },
1961                     ),
1962                     span,
1963                 }),
1964             ),
1965         }
1966     }
1967 }
1968
1969 /// A signature (not the body) of a function declaration.
1970 ///
1971 /// E.g., `fn foo(bar: baz)`.
1972 ///
1973 /// Please note that it's different from `FnHeader` structure
1974 /// which contains metadata about function safety, asyncness, constness and ABI.
1975 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1976 pub struct FnDecl {
1977     pub inputs: Vec<Param>,
1978     pub output: FunctionRetTy,
1979 }
1980
1981 impl FnDecl {
1982     pub fn get_self(&self) -> Option<ExplicitSelf> {
1983         self.inputs.get(0).and_then(Param::to_self)
1984     }
1985     pub fn has_self(&self) -> bool {
1986         self.inputs.get(0).map_or(false, Param::is_self)
1987     }
1988     pub fn c_variadic(&self) -> bool {
1989         self.inputs.last().map_or(false, |arg| match arg.ty.kind {
1990             TyKind::CVarArgs => true,
1991             _ => false,
1992         })
1993     }
1994 }
1995
1996 /// Is the trait definition an auto trait?
1997 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
1998 pub enum IsAuto {
1999     Yes,
2000     No,
2001 }
2002
2003 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash,
2004          RustcEncodable, RustcDecodable, Debug)]
2005 pub enum Unsafety {
2006     Unsafe,
2007     Normal,
2008 }
2009
2010 impl Unsafety {
2011     pub fn prefix_str(&self) -> &'static str {
2012         match self {
2013             Unsafety::Unsafe => "unsafe ",
2014             Unsafety::Normal => "",
2015         }
2016     }
2017 }
2018
2019 impl fmt::Display for Unsafety {
2020     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2021         fmt::Display::fmt(
2022             match *self {
2023                 Unsafety::Normal => "normal",
2024                 Unsafety::Unsafe => "unsafe",
2025             },
2026             f,
2027         )
2028     }
2029 }
2030
2031 #[derive(Copy, Clone, RustcEncodable, RustcDecodable, Debug)]
2032 pub enum IsAsync {
2033     Async {
2034         closure_id: NodeId,
2035         return_impl_trait_id: NodeId,
2036     },
2037     NotAsync,
2038 }
2039
2040 impl IsAsync {
2041     pub fn is_async(self) -> bool {
2042         if let IsAsync::Async { .. } = self {
2043             true
2044         } else {
2045             false
2046         }
2047     }
2048
2049     /// In ths case this is an `async` return, the `NodeId` for the generated `impl Trait` item.
2050     pub fn opt_return_id(self) -> Option<NodeId> {
2051         match self {
2052             IsAsync::Async {
2053                 return_impl_trait_id,
2054                 ..
2055             } => Some(return_impl_trait_id),
2056             IsAsync::NotAsync => None,
2057         }
2058     }
2059 }
2060
2061 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
2062 pub enum Constness {
2063     Const,
2064     NotConst,
2065 }
2066
2067 /// Item defaultness.
2068 /// For details see the [RFC #2532](https://github.com/rust-lang/rfcs/pull/2532).
2069 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
2070 pub enum Defaultness {
2071     Default,
2072     Final,
2073 }
2074
2075 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable)]
2076 pub enum ImplPolarity {
2077     /// `impl Trait for Type`
2078     Positive,
2079     /// `impl !Trait for Type`
2080     Negative,
2081 }
2082
2083 impl fmt::Debug for ImplPolarity {
2084     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2085         match *self {
2086             ImplPolarity::Positive => "positive".fmt(f),
2087             ImplPolarity::Negative => "negative".fmt(f),
2088         }
2089     }
2090 }
2091
2092 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2093 pub enum FunctionRetTy {
2094     /// Returns type is not specified.
2095     ///
2096     /// Functions default to `()` and closures default to inference.
2097     /// Span points to where return type would be inserted.
2098     Default(Span),
2099     /// Everything else.
2100     Ty(P<Ty>),
2101 }
2102
2103 impl FunctionRetTy {
2104     pub fn span(&self) -> Span {
2105         match *self {
2106             FunctionRetTy::Default(span) => span,
2107             FunctionRetTy::Ty(ref ty) => ty.span,
2108         }
2109     }
2110 }
2111
2112 /// Module declaration.
2113 ///
2114 /// E.g., `mod foo;` or `mod foo { .. }`.
2115 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2116 pub struct Mod {
2117     /// A span from the first token past `{` to the last token until `}`.
2118     /// For `mod foo;`, the inner span ranges from the first token
2119     /// to the last token in the external file.
2120     pub inner: Span,
2121     pub items: Vec<P<Item>>,
2122     /// `true` for `mod foo { .. }`; `false` for `mod foo;`.
2123     pub inline: bool,
2124 }
2125
2126 /// Foreign module declaration.
2127 ///
2128 /// E.g., `extern { .. }` or `extern C { .. }`.
2129 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2130 pub struct ForeignMod {
2131     pub abi: Option<Abi>,
2132     pub items: Vec<ForeignItem>,
2133 }
2134
2135 /// Global inline assembly.
2136 ///
2137 /// Also known as "module-level assembly" or "file-scoped assembly".
2138 #[derive(Clone, RustcEncodable, RustcDecodable, Debug, Copy)]
2139 pub struct GlobalAsm {
2140     pub asm: Symbol,
2141 }
2142
2143 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2144 pub struct EnumDef {
2145     pub variants: Vec<Variant>,
2146 }
2147
2148 /// Enum variant.
2149 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2150 pub struct Variant {
2151     /// Name of the variant.
2152     pub ident: Ident,
2153     /// Attributes of the variant.
2154     pub attrs: Vec<Attribute>,
2155     /// Id of the variant (not the constructor, see `VariantData::ctor_id()`).
2156     pub id: NodeId,
2157     /// Fields and constructor id of the variant.
2158     pub data: VariantData,
2159     /// Explicit discriminant, e.g., `Foo = 1`.
2160     pub disr_expr: Option<AnonConst>,
2161     /// Span
2162     pub span: Span,
2163     /// Is a macro placeholder
2164     pub is_placeholder: bool,
2165 }
2166
2167 /// Part of `use` item to the right of its prefix.
2168 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2169 pub enum UseTreeKind {
2170     /// `use prefix` or `use prefix as rename`
2171     ///
2172     /// The extra `NodeId`s are for HIR lowering, when additional statements are created for each
2173     /// namespace.
2174     Simple(Option<Ident>, NodeId, NodeId),
2175     /// `use prefix::{...}`
2176     Nested(Vec<(UseTree, NodeId)>),
2177     /// `use prefix::*`
2178     Glob,
2179 }
2180
2181 /// A tree of paths sharing common prefixes.
2182 /// Used in `use` items both at top-level and inside of braces in import groups.
2183 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2184 pub struct UseTree {
2185     pub prefix: Path,
2186     pub kind: UseTreeKind,
2187     pub span: Span,
2188 }
2189
2190 impl UseTree {
2191     pub fn ident(&self) -> Ident {
2192         match self.kind {
2193             UseTreeKind::Simple(Some(rename), ..) => rename,
2194             UseTreeKind::Simple(None, ..) => {
2195                 self.prefix
2196                     .segments
2197                     .last()
2198                     .expect("empty prefix in a simple import")
2199                     .ident
2200             }
2201             _ => panic!("`UseTree::ident` can only be used on a simple import"),
2202         }
2203     }
2204 }
2205
2206 /// Distinguishes between `Attribute`s that decorate items and Attributes that
2207 /// are contained as statements within items. These two cases need to be
2208 /// distinguished for pretty-printing.
2209 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
2210 pub enum AttrStyle {
2211     Outer,
2212     Inner,
2213 }
2214
2215 #[derive(Clone, PartialEq, Eq, Hash, Debug, PartialOrd, Ord, Copy)]
2216 pub struct AttrId(pub usize);
2217
2218 impl Idx for AttrId {
2219     fn new(idx: usize) -> Self {
2220         AttrId(idx)
2221     }
2222     fn index(self) -> usize {
2223         self.0
2224     }
2225 }
2226
2227 impl rustc_serialize::Encodable for AttrId {
2228     fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
2229         s.emit_unit()
2230     }
2231 }
2232
2233 impl rustc_serialize::Decodable for AttrId {
2234     fn decode<D: Decoder>(d: &mut D) -> Result<AttrId, D::Error> {
2235         d.read_nil().map(|_| crate::attr::mk_attr_id())
2236     }
2237 }
2238
2239 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2240 pub struct AttrItem {
2241     pub path: Path,
2242     pub tokens: TokenStream,
2243 }
2244
2245 /// Metadata associated with an item.
2246 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2247 pub struct Attribute {
2248     pub kind: AttrKind,
2249     pub id: AttrId,
2250     /// Denotes if the attribute decorates the following construct (outer)
2251     /// or the construct this attribute is contained within (inner).
2252     pub style: AttrStyle,
2253     pub span: Span,
2254 }
2255
2256 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2257 pub enum AttrKind {
2258     /// A normal attribute.
2259     Normal(AttrItem),
2260
2261     /// A doc comment (e.g. `/// ...`, `//! ...`, `/** ... */`, `/*! ... */`).
2262     /// Doc attributes (e.g. `#[doc="..."]`) are represented with the `Normal`
2263     /// variant (which is much less compact and thus more expensive).
2264     ///
2265     /// Note: `self.has_name(sym::doc)` and `self.check_name(sym::doc)` succeed
2266     /// for this variant, but this may change in the future.
2267     /// ```
2268     DocComment(Symbol),
2269 }
2270
2271 /// `TraitRef`s appear in impls.
2272 ///
2273 /// Resolution maps each `TraitRef`'s `ref_id` to its defining trait; that's all
2274 /// that the `ref_id` is for. The `impl_id` maps to the "self type" of this impl.
2275 /// If this impl is an `ItemKind::Impl`, the `impl_id` is redundant (it could be the
2276 /// same as the impl's `NodeId`).
2277 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2278 pub struct TraitRef {
2279     pub path: Path,
2280     pub ref_id: NodeId,
2281 }
2282
2283 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2284 pub struct PolyTraitRef {
2285     /// The `'a` in `<'a> Foo<&'a T>`.
2286     pub bound_generic_params: Vec<GenericParam>,
2287
2288     /// The `Foo<&'a T>` in `<'a> Foo<&'a T>`.
2289     pub trait_ref: TraitRef,
2290
2291     pub span: Span,
2292 }
2293
2294 impl PolyTraitRef {
2295     pub fn new(generic_params: Vec<GenericParam>, path: Path, span: Span) -> Self {
2296         PolyTraitRef {
2297             bound_generic_params: generic_params,
2298             trait_ref: TraitRef {
2299                 path,
2300                 ref_id: DUMMY_NODE_ID,
2301             },
2302             span,
2303         }
2304     }
2305 }
2306
2307 #[derive(Copy, Clone, RustcEncodable, RustcDecodable, Debug)]
2308 pub enum CrateSugar {
2309     /// Source is `pub(crate)`.
2310     PubCrate,
2311
2312     /// Source is (just) `crate`.
2313     JustCrate,
2314 }
2315
2316 pub type Visibility = Spanned<VisibilityKind>;
2317
2318 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2319 pub enum VisibilityKind {
2320     Public,
2321     Crate(CrateSugar),
2322     Restricted { path: P<Path>, id: NodeId },
2323     Inherited,
2324 }
2325
2326 impl VisibilityKind {
2327     pub fn is_pub(&self) -> bool {
2328         if let VisibilityKind::Public = *self {
2329             true
2330         } else {
2331             false
2332         }
2333     }
2334 }
2335
2336 /// Field of a struct.
2337 ///
2338 /// E.g., `bar: usize` as in `struct Foo { bar: usize }`.
2339 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2340 pub struct StructField {
2341     pub span: Span,
2342     pub ident: Option<Ident>,
2343     pub vis: Visibility,
2344     pub id: NodeId,
2345     pub ty: P<Ty>,
2346     pub attrs: Vec<Attribute>,
2347     pub is_placeholder: bool,
2348 }
2349
2350 /// Fields and constructor ids of enum variants and structs.
2351 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2352 pub enum VariantData {
2353     /// Struct variant.
2354     ///
2355     /// E.g., `Bar { .. }` as in `enum Foo { Bar { .. } }`.
2356     Struct(Vec<StructField>, bool),
2357     /// Tuple variant.
2358     ///
2359     /// E.g., `Bar(..)` as in `enum Foo { Bar(..) }`.
2360     Tuple(Vec<StructField>, NodeId),
2361     /// Unit variant.
2362     ///
2363     /// E.g., `Bar = ..` as in `enum Foo { Bar = .. }`.
2364     Unit(NodeId),
2365 }
2366
2367 impl VariantData {
2368     /// Return the fields of this variant.
2369     pub fn fields(&self) -> &[StructField] {
2370         match *self {
2371             VariantData::Struct(ref fields, ..) | VariantData::Tuple(ref fields, _) => fields,
2372             _ => &[],
2373         }
2374     }
2375
2376     /// Return the `NodeId` of this variant's constructor, if it has one.
2377     pub fn ctor_id(&self) -> Option<NodeId> {
2378         match *self {
2379             VariantData::Struct(..) => None,
2380             VariantData::Tuple(_, id) | VariantData::Unit(id) => Some(id),
2381         }
2382     }
2383 }
2384
2385 /// An item.
2386 ///
2387 /// The name might be a dummy name in case of anonymous items.
2388 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2389 pub struct Item {
2390     pub ident: Ident,
2391     pub attrs: Vec<Attribute>,
2392     pub id: NodeId,
2393     pub kind: ItemKind,
2394     pub vis: Visibility,
2395     pub span: Span,
2396
2397     /// Original tokens this item was parsed from. This isn't necessarily
2398     /// available for all items, although over time more and more items should
2399     /// have this be `Some`. Right now this is primarily used for procedural
2400     /// macros, notably custom attributes.
2401     ///
2402     /// Note that the tokens here do not include the outer attributes, but will
2403     /// include inner attributes.
2404     pub tokens: Option<TokenStream>,
2405 }
2406
2407 impl Item {
2408     /// Return the span that encompasses the attributes.
2409     pub fn span_with_attributes(&self) -> Span {
2410         self.attrs.iter().fold(self.span, |acc, attr| acc.to(attr.span))
2411     }
2412 }
2413
2414 /// A reference to an ABI.
2415 ///
2416 /// In AST our notion of an ABI is still syntactic unlike in `rustc_target::spec::abi::Abi`.
2417 #[derive(Clone, Copy, RustcEncodable, RustcDecodable, Debug, PartialEq)]
2418 pub struct Abi {
2419     pub symbol: Symbol,
2420     pub span: Span,
2421 }
2422
2423 /// `extern` qualifier on a function item or function type.
2424 #[derive(Clone, Copy, RustcEncodable, RustcDecodable, Debug)]
2425 pub enum Extern {
2426     None,
2427     Implicit,
2428     Explicit(Abi),
2429 }
2430
2431 impl Extern {
2432     pub fn from_abi(abi: Option<Abi>) -> Extern {
2433         match abi {
2434             Some(abi) => Extern::Explicit(abi),
2435             None => Extern::Implicit,
2436         }
2437     }
2438 }
2439
2440 /// A function header.
2441 ///
2442 /// All the information between the visibility and the name of the function is
2443 /// included in this struct (e.g., `async unsafe fn` or `const extern "C" fn`).
2444 #[derive(Clone, Copy, RustcEncodable, RustcDecodable, Debug)]
2445 pub struct FnHeader {
2446     pub unsafety: Unsafety,
2447     pub asyncness: Spanned<IsAsync>,
2448     pub constness: Spanned<Constness>,
2449     pub ext: Extern,
2450 }
2451
2452 impl Default for FnHeader {
2453     fn default() -> FnHeader {
2454         FnHeader {
2455             unsafety: Unsafety::Normal,
2456             asyncness: dummy_spanned(IsAsync::NotAsync),
2457             constness: dummy_spanned(Constness::NotConst),
2458             ext: Extern::None,
2459         }
2460     }
2461 }
2462
2463 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2464 pub enum ItemKind {
2465     /// An `extern crate` item, with the optional *original* crate name if the crate was renamed.
2466     ///
2467     /// E.g., `extern crate foo` or `extern crate foo_bar as foo`.
2468     ExternCrate(Option<Name>),
2469     /// A use declaration item (`use`).
2470     ///
2471     /// E.g., `use foo;`, `use foo::bar;` or `use foo::bar as FooBar;`.
2472     Use(P<UseTree>),
2473     /// A static item (`static`).
2474     ///
2475     /// E.g., `static FOO: i32 = 42;` or `static FOO: &'static str = "bar";`.
2476     Static(P<Ty>, Mutability, P<Expr>),
2477     /// A constant item (`const`).
2478     ///
2479     /// E.g., `const FOO: i32 = 42;`.
2480     Const(P<Ty>, P<Expr>),
2481     /// A function declaration (`fn`).
2482     ///
2483     /// E.g., `fn foo(bar: usize) -> usize { .. }`.
2484     Fn(FnSig, Generics, P<Block>),
2485     /// A module declaration (`mod`).
2486     ///
2487     /// E.g., `mod foo;` or `mod foo { .. }`.
2488     Mod(Mod),
2489     /// An external module (`extern`).
2490     ///
2491     /// E.g., `extern {}` or `extern "C" {}`.
2492     ForeignMod(ForeignMod),
2493     /// Module-level inline assembly (from `global_asm!()`).
2494     GlobalAsm(P<GlobalAsm>),
2495     /// A type alias (`type`).
2496     ///
2497     /// E.g., `type Foo = Bar<u8>;`.
2498     TyAlias(P<Ty>, Generics),
2499     /// An enum definition (`enum`).
2500     ///
2501     /// E.g., `enum Foo<A, B> { C<A>, D<B> }`.
2502     Enum(EnumDef, Generics),
2503     /// A struct definition (`struct`).
2504     ///
2505     /// E.g., `struct Foo<A> { x: A }`.
2506     Struct(VariantData, Generics),
2507     /// A union definition (`union`).
2508     ///
2509     /// E.g., `union Foo<A, B> { x: A, y: B }`.
2510     Union(VariantData, Generics),
2511     /// A trait declaration (`trait`).
2512     ///
2513     /// E.g., `trait Foo { .. }`, `trait Foo<T> { .. }` or `auto trait Foo {}`.
2514     Trait(IsAuto, Unsafety, Generics, GenericBounds, Vec<TraitItem>),
2515     /// Trait alias
2516     ///
2517     /// E.g., `trait Foo = Bar + Quux;`.
2518     TraitAlias(Generics, GenericBounds),
2519     /// An implementation.
2520     ///
2521     /// E.g., `impl<A> Foo<A> { .. }` or `impl<A> Trait for Foo<A> { .. }`.
2522     Impl(
2523         Unsafety,
2524         ImplPolarity,
2525         Defaultness,
2526         Generics,
2527         Option<TraitRef>, // (optional) trait this impl implements
2528         P<Ty>,            // self
2529         Vec<ImplItem>,
2530     ),
2531     /// A macro invocation.
2532     ///
2533     /// E.g., `foo!(..)`.
2534     Mac(Mac),
2535
2536     /// A macro definition.
2537     MacroDef(MacroDef),
2538 }
2539
2540 impl ItemKind {
2541     pub fn descriptive_variant(&self) -> &str {
2542         match *self {
2543             ItemKind::ExternCrate(..) => "extern crate",
2544             ItemKind::Use(..) => "use",
2545             ItemKind::Static(..) => "static item",
2546             ItemKind::Const(..) => "constant item",
2547             ItemKind::Fn(..) => "function",
2548             ItemKind::Mod(..) => "module",
2549             ItemKind::ForeignMod(..) => "foreign module",
2550             ItemKind::GlobalAsm(..) => "global asm",
2551             ItemKind::TyAlias(..) => "type alias",
2552             ItemKind::Enum(..) => "enum",
2553             ItemKind::Struct(..) => "struct",
2554             ItemKind::Union(..) => "union",
2555             ItemKind::Trait(..) => "trait",
2556             ItemKind::TraitAlias(..) => "trait alias",
2557             ItemKind::Mac(..) | ItemKind::MacroDef(..) | ItemKind::Impl(..) => "item",
2558         }
2559     }
2560 }
2561
2562 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2563 pub struct ForeignItem {
2564     pub ident: Ident,
2565     pub attrs: Vec<Attribute>,
2566     pub kind: ForeignItemKind,
2567     pub id: NodeId,
2568     pub span: Span,
2569     pub vis: Visibility,
2570 }
2571
2572 /// An item within an `extern` block.
2573 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2574 pub enum ForeignItemKind {
2575     /// A foreign function.
2576     Fn(P<FnDecl>, Generics),
2577     /// A foreign static item (`static ext: u8`).
2578     Static(P<Ty>, Mutability),
2579     /// A foreign type.
2580     Ty,
2581     /// A macro invocation.
2582     Macro(Mac),
2583 }
2584
2585 impl ForeignItemKind {
2586     pub fn descriptive_variant(&self) -> &str {
2587         match *self {
2588             ForeignItemKind::Fn(..) => "foreign function",
2589             ForeignItemKind::Static(..) => "foreign static item",
2590             ForeignItemKind::Ty => "foreign type",
2591             ForeignItemKind::Macro(..) => "macro in foreign module",
2592         }
2593     }
2594 }