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