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