src/libsyntax/ast.rs

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