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     pub fn is_item(&self) -> bool {
 740         match self.node {
 741             StmtKind::Local(_) => true,
 742             _ => false,
 743         }
 744     }
 745 }
 746
 747 impl fmt::Debug for Stmt {
 748     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 749         write!(f, "stmt({}: {})", self.id.to_string(), pprust::stmt_to_string(self))
 750     }
 751 }
 752
 753
 754 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash)]
 755 pub enum StmtKind {
 756     /// A local (let) binding.
 757     Local(P<Local>),
 758
 759     /// An item definition.
 760     Item(P<Item>),
 761
 762     /// Expr without trailing semi-colon.
 763     Expr(P<Expr>),
 764
 765     Semi(P<Expr>),
 766
 767     Mac(P<(Mac, MacStmtStyle, ThinVec<Attribute>)>),
 768 }
 769
 770 #[derive(Clone, Copy, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
 771 pub enum MacStmtStyle {
 772     /// The macro statement had a trailing semicolon, e.g. `foo! { ... };`
 773     /// `foo!(...);`, `foo![...];`
 774     Semicolon,
 775     /// The macro statement had braces; e.g. foo! { ... }
 776     Braces,
 777     /// The macro statement had parentheses or brackets and no semicolon; e.g.
 778     /// `foo!(...)`. All of these will end up being converted into macro
 779     /// expressions.
 780     NoBraces,
 781 }
 782
 783 // FIXME (pending discussion of #1697, #2178...): local should really be
 784 // a refinement on pat.
 785 /// Local represents a `let` statement, e.g., `let <pat>:<ty> = <expr>;`
 786 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
 787 pub struct Local {
 788     pub pat: P<Pat>,
 789     pub ty: Option<P<Ty>>,
 790     /// Initializer expression to set the value, if any
 791     pub init: Option<P<Expr>>,
 792     pub id: NodeId,
 793     pub span: Span,
 794     pub attrs: ThinVec<Attribute>,
 795 }
 796
 797 /// An arm of a 'match'.
 798 ///
 799 /// E.g. `0...10 => { println!("match!") }` as in
 800 ///
 801 /// ```
 802 /// match 123 {
 803 ///     0...10 => { println!("match!") },
 804 ///     _ => { println!("no match!") },
 805 /// }
 806 /// ```
 807 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
 808 pub struct Arm {
 809     pub attrs: Vec<Attribute>,
 810     pub pats: Vec<P<Pat>>,
 811     pub guard: Option<P<Expr>>,
 812     pub body: P<Expr>,
 813 }
 814
 815 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
 816 pub struct Field {
 817     pub ident: SpannedIdent,
 818     pub expr: P<Expr>,
 819     pub span: Span,
 820     pub is_shorthand: bool,
 821     pub attrs: ThinVec<Attribute>,
 822 }
 823
 824 pub type SpannedIdent = Spanned<Ident>;
 825
 826 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
 827 pub enum BlockCheckMode {
 828     Default,
 829     Unsafe(UnsafeSource),
 830 }
 831
 832 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
 833 pub enum UnsafeSource {
 834     CompilerGenerated,
 835     UserProvided,
 836 }
 837
 838 /// An expression
 839 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash,)]
 840 pub struct Expr {
 841     pub id: NodeId,
 842     pub node: ExprKind,
 843     pub span: Span,
 844     pub attrs: ThinVec<Attribute>
 845 }
 846
 847 impl fmt::Debug for Expr {
 848     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
 849         write!(f, "expr({}: {})", self.id, pprust::expr_to_string(self))
 850     }
 851 }
 852
 853 /// Limit types of a range (inclusive or exclusive)
 854 #[derive(Copy, Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
 855 pub enum RangeLimits {
 856     /// Inclusive at the beginning, exclusive at the end
 857     HalfOpen,
 858     /// Inclusive at the beginning and end
 859     Closed,
 860 }
 861
 862 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
 863 pub enum ExprKind {
 864     /// A `box x` expression.
 865     Box(P<Expr>),
 866     /// First expr is the place; second expr is the value.
 867     InPlace(P<Expr>, P<Expr>),
 868     /// An array (`[a, b, c, d]`)
 869     Array(Vec<P<Expr>>),
 870     /// A function call
 871     ///
 872     /// The first field resolves to the function itself,
 873     /// and the second field is the list of arguments
 874     Call(P<Expr>, Vec<P<Expr>>),
 875     /// A method call (`x.foo::<'static, Bar, Baz>(a, b, c, d)`)
 876     ///
 877     /// The `PathSegment` represents the method name and its generic arguments
 878     /// (within the angle brackets).
 879     /// The first element of the vector of `Expr`s is the expression that evaluates
 880     /// to the object on which the method is being called on (the receiver),
 881     /// and the remaining elements are the rest of the arguments.
 882     /// Thus, `x.foo::<Bar, Baz>(a, b, c, d)` is represented as
 883     /// `ExprKind::MethodCall(PathSegment { foo, [Bar, Baz] }, [x, a, b, c, d])`.
 884     MethodCall(PathSegment, Vec<P<Expr>>),
 885     /// A tuple (`(a, b, c ,d)`)
 886     Tup(Vec<P<Expr>>),
 887     /// A binary operation (For example: `a + b`, `a * b`)
 888     Binary(BinOp, P<Expr>, P<Expr>),
 889     /// A unary operation (For example: `!x`, `*x`)
 890     Unary(UnOp, P<Expr>),
 891     /// A literal (For example: `1`, `"foo"`)
 892     Lit(P<Lit>),
 893     /// A cast (`foo as f64`)
 894     Cast(P<Expr>, P<Ty>),
 895     Type(P<Expr>, P<Ty>),
 896     /// An `if` block, with an optional else block
 897     ///
 898     /// `if expr { block } else { expr }`
 899     If(P<Expr>, P<Block>, Option<P<Expr>>),
 900     /// An `if let` expression with an optional else block
 901     ///
 902     /// `if let pat = expr { block } else { expr }`
 903     ///
 904     /// This is desugared to a `match` expression.
 905     IfLet(P<Pat>, P<Expr>, P<Block>, Option<P<Expr>>),
 906     /// A while loop, with an optional label
 907     ///
 908     /// `'label: while expr { block }`
 909     While(P<Expr>, P<Block>, Option<SpannedIdent>),
 910     /// A while-let loop, with an optional label
 911     ///
 912     /// `'label: while let pat = expr { block }`
 913     ///
 914     /// This is desugared to a combination of `loop` and `match` expressions.
 915     WhileLet(P<Pat>, P<Expr>, P<Block>, Option<SpannedIdent>),
 916     /// A for loop, with an optional label
 917     ///
 918     /// `'label: for pat in expr { block }`
 919     ///
 920     /// This is desugared to a combination of `loop` and `match` expressions.
 921     ForLoop(P<Pat>, P<Expr>, P<Block>, Option<SpannedIdent>),
 922     /// Conditionless loop (can be exited with break, continue, or return)
 923     ///
 924     /// `'label: loop { block }`
 925     Loop(P<Block>, Option<SpannedIdent>),
 926     /// A `match` block.
 927     Match(P<Expr>, Vec<Arm>),
 928     /// A closure (for example, `move |a, b, c| a + b + c`)
 929     ///
 930     /// The final span is the span of the argument block `|...|`
 931     Closure(CaptureBy, P<FnDecl>, P<Expr>, Span),
 932     /// A block (`{ ... }`)
 933     Block(P<Block>),
 934     /// A catch block (`catch { ... }`)
 935     Catch(P<Block>),
 936
 937     /// An assignment (`a = foo()`)
 938     Assign(P<Expr>, P<Expr>),
 939     /// An assignment with an operator
 940     ///
 941     /// For example, `a += 1`.
 942     AssignOp(BinOp, P<Expr>, P<Expr>),
 943     /// Access of a named struct field (`obj.foo`)
 944     Field(P<Expr>, SpannedIdent),
 945     /// Access of an unnamed field of a struct or tuple-struct
 946     ///
 947     /// For example, `foo.0`.
 948     TupField(P<Expr>, Spanned<usize>),
 949     /// An indexing operation (`foo[2]`)
 950     Index(P<Expr>, P<Expr>),
 951     /// A range (`1..2`, `1..`, `..2`, `1...2`, `1...`, `...2`)
 952     Range(Option<P<Expr>>, Option<P<Expr>>, RangeLimits),
 953
 954     /// Variable reference, possibly containing `::` and/or type
 955     /// parameters, e.g. foo::bar::<baz>.
 956     ///
 957     /// Optionally "qualified",
 958     /// E.g. `<Vec<T> as SomeTrait>::SomeType`.
 959     Path(Option<QSelf>, Path),
 960
 961     /// A referencing operation (`&a` or `&mut a`)
 962     AddrOf(Mutability, P<Expr>),
 963     /// A `break`, with an optional label to break, and an optional expression
 964     Break(Option<SpannedIdent>, Option<P<Expr>>),
 965     /// A `continue`, with an optional label
 966     Continue(Option<SpannedIdent>),
 967     /// A `return`, with an optional value to be returned
 968     Ret(Option<P<Expr>>),
 969
 970     /// Output of the `asm!()` macro
 971     InlineAsm(P<InlineAsm>),
 972
 973     /// A macro invocation; pre-expansion
 974     Mac(Mac),
 975
 976     /// A struct literal expression.
 977     ///
 978     /// For example, `Foo {x: 1, y: 2}`, or
 979     /// `Foo {x: 1, .. base}`, where `base` is the `Option<Expr>`.
 980     Struct(Path, Vec<Field>, Option<P<Expr>>),
 981
 982     /// An array literal constructed from one repeated element.
 983     ///
 984     /// For example, `[1; 5]`. The first expression is the element
 985     /// to be repeated; the second is the number of times to repeat it.
 986     Repeat(P<Expr>, P<Expr>),
 987
 988     /// No-op: used solely so we can pretty-print faithfully
 989     Paren(P<Expr>),
 990
 991     /// `expr?`
 992     Try(P<Expr>),
 993 }
 994
 995 /// The explicit Self type in a "qualified path". The actual
 996 /// path, including the trait and the associated item, is stored
 997 /// separately. `position` represents the index of the associated
 998 /// item qualified with this Self type.
 999 ///
1000 /// ```ignore (only-for-syntax-highlight)
1001 /// <Vec<T> as a::b::Trait>::AssociatedItem
1002 ///  ^~~~~     ~~~~~~~~~~~~~~^
1003 ///  ty        position = 3
1004 ///
1005 /// <Vec<T>>::AssociatedItem
1006 ///  ^~~~~    ^
1007 ///  ty       position = 0
1008 /// ```
1009 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1010 pub struct QSelf {
1011     pub ty: P<Ty>,
1012     pub position: usize
1013 }
1014
1015 /// A capture clause
1016 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
1017 pub enum CaptureBy {
1018     Value,
1019     Ref,
1020 }
1021
1022 pub type Mac = Spanned<Mac_>;
1023
1024 /// Represents a macro invocation. The Path indicates which macro
1025 /// is being invoked, and the vector of token-trees contains the source
1026 /// of the macro invocation.
1027 ///
1028 /// NB: the additional ident for a macro_rules-style macro is actually
1029 /// stored in the enclosing item. Oog.
1030 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1031 pub struct Mac_ {
1032     pub path: Path,
1033     pub tts: ThinTokenStream,
1034 }
1035
1036 impl Mac_ {
1037     pub fn stream(&self) -> TokenStream {
1038         self.tts.clone().into()
1039     }
1040 }
1041
1042 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1043 pub struct MacroDef {
1044     pub tokens: ThinTokenStream,
1045     pub legacy: bool,
1046 }
1047
1048 impl MacroDef {
1049     pub fn stream(&self) -> TokenStream {
1050         self.tokens.clone().into()
1051     }
1052 }
1053
1054 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
1055 pub enum StrStyle {
1056     /// A regular string, like `"foo"`
1057     Cooked,
1058     /// A raw string, like `r##"foo"##`
1059     ///
1060     /// The uint is the number of `#` symbols used
1061     Raw(usize)
1062 }
1063
1064 /// A literal
1065 pub type Lit = Spanned<LitKind>;
1066
1067 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
1068 pub enum LitIntType {
1069     Signed(IntTy),
1070     Unsigned(UintTy),
1071     Unsuffixed,
1072 }
1073
1074 /// Literal kind.
1075 ///
1076 /// E.g. `"foo"`, `42`, `12.34` or `bool`
1077 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1078 pub enum LitKind {
1079     /// A string literal (`"foo"`)
1080     Str(Symbol, StrStyle),
1081     /// A byte string (`b"foo"`)
1082     ByteStr(Rc<Vec<u8>>),
1083     /// A byte char (`b'f'`)
1084     Byte(u8),
1085     /// A character literal (`'a'`)
1086     Char(char),
1087     /// An integer literal (`1`)
1088     Int(u128, LitIntType),
1089     /// A float literal (`1f64` or `1E10f64`)
1090     Float(Symbol, FloatTy),
1091     /// A float literal without a suffix (`1.0 or 1.0E10`)
1092     FloatUnsuffixed(Symbol),
1093     /// A boolean literal
1094     Bool(bool),
1095 }
1096
1097 impl LitKind {
1098     /// Returns true if this literal is a string and false otherwise.
1099     pub fn is_str(&self) -> bool {
1100         match *self {
1101             LitKind::Str(..) => true,
1102             _ => false,
1103         }
1104     }
1105
1106     /// Returns true if this literal has no suffix. Note: this will return true
1107     /// for literals with prefixes such as raw strings and byte strings.
1108     pub fn is_unsuffixed(&self) -> bool {
1109         match *self {
1110             // unsuffixed variants
1111             LitKind::Str(..) |
1112             LitKind::ByteStr(..) |
1113             LitKind::Byte(..) |
1114             LitKind::Char(..) |
1115             LitKind::Int(_, LitIntType::Unsuffixed) |
1116             LitKind::FloatUnsuffixed(..) |
1117             LitKind::Bool(..) => true,
1118             // suffixed variants
1119             LitKind::Int(_, LitIntType::Signed(..)) |
1120             LitKind::Int(_, LitIntType::Unsigned(..)) |
1121             LitKind::Float(..) => false,
1122         }
1123     }
1124
1125     /// Returns true if this literal has a suffix.
1126     pub fn is_suffixed(&self) -> bool {
1127         !self.is_unsuffixed()
1128     }
1129 }
1130
1131 // NB: If you change this, you'll probably want to change the corresponding
1132 // type structure in middle/ty.rs as well.
1133 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1134 pub struct MutTy {
1135     pub ty: P<Ty>,
1136     pub mutbl: Mutability,
1137 }
1138
1139 /// Represents a method's signature in a trait declaration,
1140 /// or in an implementation.
1141 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1142 pub struct MethodSig {
1143     pub unsafety: Unsafety,
1144     pub constness: Spanned<Constness>,
1145     pub abi: Abi,
1146     pub decl: P<FnDecl>,
1147     pub generics: Generics,
1148 }
1149
1150 /// Represents an item declaration within a trait declaration,
1151 /// possibly including a default implementation. A trait item is
1152 /// either required (meaning it doesn't have an implementation, just a
1153 /// signature) or provided (meaning it has a default implementation).
1154 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1155 pub struct TraitItem {
1156     pub id: NodeId,
1157     pub ident: Ident,
1158     pub attrs: Vec<Attribute>,
1159     pub node: TraitItemKind,
1160     pub span: Span,
1161     /// See `Item::tokens` for what this is
1162     pub tokens: Option<TokenStream>,
1163 }
1164
1165 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1166 pub enum TraitItemKind {
1167     Const(P<Ty>, Option<P<Expr>>),
1168     Method(MethodSig, Option<P<Block>>),
1169     Type(TyParamBounds, Option<P<Ty>>),
1170     Macro(Mac),
1171 }
1172
1173 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1174 pub struct ImplItem {
1175     pub id: NodeId,
1176     pub ident: Ident,
1177     pub vis: Visibility,
1178     pub defaultness: Defaultness,
1179     pub attrs: Vec<Attribute>,
1180     pub node: ImplItemKind,
1181     pub span: Span,
1182     /// See `Item::tokens` for what this is
1183     pub tokens: Option<TokenStream>,
1184 }
1185
1186 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1187 pub enum ImplItemKind {
1188     Const(P<Ty>, P<Expr>),
1189     Method(MethodSig, P<Block>),
1190     Type(P<Ty>),
1191     Macro(Mac),
1192 }
1193
1194 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Copy)]
1195 pub enum IntTy {
1196     Is,
1197     I8,
1198     I16,
1199     I32,
1200     I64,
1201     I128,
1202 }
1203
1204 impl fmt::Debug for IntTy {
1205     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1206         fmt::Display::fmt(self, f)
1207     }
1208 }
1209
1210 impl fmt::Display for IntTy {
1211     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1212         write!(f, "{}", self.ty_to_string())
1213     }
1214 }
1215
1216 impl IntTy {
1217     pub fn ty_to_string(&self) -> &'static str {
1218         match *self {
1219             IntTy::Is => "isize",
1220             IntTy::I8 => "i8",
1221             IntTy::I16 => "i16",
1222             IntTy::I32 => "i32",
1223             IntTy::I64 => "i64",
1224             IntTy::I128 => "i128",
1225         }
1226     }
1227
1228     pub fn val_to_string(&self, val: i128) -> String {
1229         // cast to a u128 so we can correctly print INT128_MIN. All integral types
1230         // are parsed as u128, so we wouldn't want to print an extra negative
1231         // sign.
1232         format!("{}{}", val as u128, self.ty_to_string())
1233     }
1234
1235     pub fn bit_width(&self) -> Option<usize> {
1236         Some(match *self {
1237             IntTy::Is => return None,
1238             IntTy::I8 => 8,
1239             IntTy::I16 => 16,
1240             IntTy::I32 => 32,
1241             IntTy::I64 => 64,
1242             IntTy::I128 => 128,
1243         })
1244     }
1245 }
1246
1247 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Copy)]
1248 pub enum UintTy {
1249     Us,
1250     U8,
1251     U16,
1252     U32,
1253     U64,
1254     U128,
1255 }
1256
1257 impl UintTy {
1258     pub fn ty_to_string(&self) -> &'static str {
1259         match *self {
1260             UintTy::Us => "usize",
1261             UintTy::U8 => "u8",
1262             UintTy::U16 => "u16",
1263             UintTy::U32 => "u32",
1264             UintTy::U64 => "u64",
1265             UintTy::U128 => "u128",
1266         }
1267     }
1268
1269     pub fn val_to_string(&self, val: u128) -> String {
1270         format!("{}{}", val, self.ty_to_string())
1271     }
1272
1273     pub fn bit_width(&self) -> Option<usize> {
1274         Some(match *self {
1275             UintTy::Us => return None,
1276             UintTy::U8 => 8,
1277             UintTy::U16 => 16,
1278             UintTy::U32 => 32,
1279             UintTy::U64 => 64,
1280             UintTy::U128 => 128,
1281         })
1282     }
1283 }
1284
1285 impl fmt::Debug for UintTy {
1286     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1287         fmt::Display::fmt(self, f)
1288     }
1289 }
1290
1291 impl fmt::Display for UintTy {
1292     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1293         write!(f, "{}", self.ty_to_string())
1294     }
1295 }
1296
1297 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Copy)]
1298 pub enum FloatTy {
1299     F32,
1300     F64,
1301 }
1302
1303 impl fmt::Debug for FloatTy {
1304     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1305         fmt::Display::fmt(self, f)
1306     }
1307 }
1308
1309 impl fmt::Display for FloatTy {
1310     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1311         write!(f, "{}", self.ty_to_string())
1312     }
1313 }
1314
1315 impl FloatTy {
1316     pub fn ty_to_string(&self) -> &'static str {
1317         match *self {
1318             FloatTy::F32 => "f32",
1319             FloatTy::F64 => "f64",
1320         }
1321     }
1322
1323     pub fn bit_width(&self) -> usize {
1324         match *self {
1325             FloatTy::F32 => 32,
1326             FloatTy::F64 => 64,
1327         }
1328     }
1329 }
1330
1331 // Bind a type to an associated type: `A=Foo`.
1332 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1333 pub struct TypeBinding {
1334     pub id: NodeId,
1335     pub ident: Ident,
1336     pub ty: P<Ty>,
1337     pub span: Span,
1338 }
1339
1340 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash)]
1341 pub struct Ty {
1342     pub id: NodeId,
1343     pub node: TyKind,
1344     pub span: Span,
1345 }
1346
1347 impl fmt::Debug for Ty {
1348     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1349         write!(f, "type({})", pprust::ty_to_string(self))
1350     }
1351 }
1352
1353 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1354 pub struct BareFnTy {
1355     pub unsafety: Unsafety,
1356     pub abi: Abi,
1357     pub lifetimes: Vec<LifetimeDef>,
1358     pub decl: P<FnDecl>
1359 }
1360
1361 /// The different kinds of types recognized by the compiler
1362 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1363 pub enum TyKind {
1364     /// A variable-length slice (`[T]`)
1365     Slice(P<Ty>),
1366     /// A fixed length array (`[T; n]`)
1367     Array(P<Ty>, P<Expr>),
1368     /// A raw pointer (`*const T` or `*mut T`)
1369     Ptr(MutTy),
1370     /// A reference (`&'a T` or `&'a mut T`)
1371     Rptr(Option<Lifetime>, MutTy),
1372     /// A bare function (e.g. `fn(usize) -> bool`)
1373     BareFn(P<BareFnTy>),
1374     /// The never type (`!`)
1375     Never,
1376     /// A tuple (`(A, B, C, D,...)`)
1377     Tup(Vec<P<Ty>> ),
1378     /// A path (`module::module::...::Type`), optionally
1379     /// "qualified", e.g. `<Vec<T> as SomeTrait>::SomeType`.
1380     ///
1381     /// Type parameters are stored in the Path itself
1382     Path(Option<QSelf>, Path),
1383     /// A trait object type `Bound1 + Bound2 + Bound3`
1384     /// where `Bound` is a trait or a lifetime.
1385     TraitObject(TyParamBounds),
1386     /// An `impl Bound1 + Bound2 + Bound3` type
1387     /// where `Bound` is a trait or a lifetime.
1388     ImplTrait(TyParamBounds),
1389     /// No-op; kept solely so that we can pretty-print faithfully
1390     Paren(P<Ty>),
1391     /// Unused for now
1392     Typeof(P<Expr>),
1393     /// TyKind::Infer means the type should be inferred instead of it having been
1394     /// specified. This can appear anywhere in a type.
1395     Infer,
1396     /// Inferred type of a `self` or `&self` argument in a method.
1397     ImplicitSelf,
1398     // A macro in the type position.
1399     Mac(Mac),
1400     /// Placeholder for a kind that has failed to be defined.
1401     Err,
1402 }
1403
1404 /// Inline assembly dialect.
1405 ///
1406 /// E.g. `"intel"` as in `asm!("mov eax, 2" : "={eax}"(result) : : : "intel")``
1407 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
1408 pub enum AsmDialect {
1409     Att,
1410     Intel,
1411 }
1412
1413 /// Inline assembly.
1414 ///
1415 /// E.g. `"={eax}"(result)` as in `asm!("mov eax, 2" : "={eax}"(result) : : : "intel")``
1416 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1417 pub struct InlineAsmOutput {
1418     pub constraint: Symbol,
1419     pub expr: P<Expr>,
1420     pub is_rw: bool,
1421     pub is_indirect: bool,
1422 }
1423
1424 /// Inline assembly.
1425 ///
1426 /// E.g. `asm!("NOP");`
1427 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1428 pub struct InlineAsm {
1429     pub asm: Symbol,
1430     pub asm_str_style: StrStyle,
1431     pub outputs: Vec<InlineAsmOutput>,
1432     pub inputs: Vec<(Symbol, P<Expr>)>,
1433     pub clobbers: Vec<Symbol>,
1434     pub volatile: bool,
1435     pub alignstack: bool,
1436     pub dialect: AsmDialect,
1437     pub ctxt: SyntaxContext,
1438 }
1439
1440 /// An argument in a function header.
1441 ///
1442 /// E.g. `bar: usize` as in `fn foo(bar: usize)`
1443 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1444 pub struct Arg {
1445     pub ty: P<Ty>,
1446     pub pat: P<Pat>,
1447     pub id: NodeId,
1448 }
1449
1450 /// Alternative representation for `Arg`s describing `self` parameter of methods.
1451 ///
1452 /// E.g. `&mut self` as in `fn foo(&mut self)`
1453 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1454 pub enum SelfKind {
1455     /// `self`, `mut self`
1456     Value(Mutability),
1457     /// `&'lt self`, `&'lt mut self`
1458     Region(Option<Lifetime>, Mutability),
1459     /// `self: TYPE`, `mut self: TYPE`
1460     Explicit(P<Ty>, Mutability),
1461 }
1462
1463 pub type ExplicitSelf = Spanned<SelfKind>;
1464
1465 impl Arg {
1466     pub fn to_self(&self) -> Option<ExplicitSelf> {
1467         if let PatKind::Ident(BindingMode::ByValue(mutbl), ident, _) = self.pat.node {
1468             if ident.node.name == keywords::SelfValue.name() {
1469                 return match self.ty.node {
1470                     TyKind::ImplicitSelf => Some(respan(self.pat.span, SelfKind::Value(mutbl))),
1471                     TyKind::Rptr(lt, MutTy{ref ty, mutbl}) if ty.node == TyKind::ImplicitSelf => {
1472                         Some(respan(self.pat.span, SelfKind::Region(lt, mutbl)))
1473                     }
1474                     _ => Some(respan(self.pat.span.to(self.ty.span),
1475                                      SelfKind::Explicit(self.ty.clone(), mutbl))),
1476                 }
1477             }
1478         }
1479         None
1480     }
1481
1482     pub fn is_self(&self) -> bool {
1483         if let PatKind::Ident(_, ident, _) = self.pat.node {
1484             ident.node.name == keywords::SelfValue.name()
1485         } else {
1486             false
1487         }
1488     }
1489
1490     pub fn from_self(eself: ExplicitSelf, eself_ident: SpannedIdent) -> Arg {
1491         let span = eself.span.to(eself_ident.span);
1492         let infer_ty = P(Ty {
1493             id: DUMMY_NODE_ID,
1494             node: TyKind::ImplicitSelf,
1495             span: span,
1496         });
1497         let arg = |mutbl, ty| Arg {
1498             pat: P(Pat {
1499                 id: DUMMY_NODE_ID,
1500                 node: PatKind::Ident(BindingMode::ByValue(mutbl), eself_ident, None),
1501                 span: span,
1502             }),
1503             ty: ty,
1504             id: DUMMY_NODE_ID,
1505         };
1506         match eself.node {
1507             SelfKind::Explicit(ty, mutbl) => arg(mutbl, ty),
1508             SelfKind::Value(mutbl) => arg(mutbl, infer_ty),
1509             SelfKind::Region(lt, mutbl) => arg(Mutability::Immutable, P(Ty {
1510                 id: DUMMY_NODE_ID,
1511                 node: TyKind::Rptr(lt, MutTy { ty: infer_ty, mutbl: mutbl }),
1512                 span: span,
1513             })),
1514         }
1515     }
1516 }
1517
1518 /// Header (not the body) of a function declaration.
1519 ///
1520 /// E.g. `fn foo(bar: baz)`
1521 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1522 pub struct FnDecl {
1523     pub inputs: Vec<Arg>,
1524     pub output: FunctionRetTy,
1525     pub variadic: bool
1526 }
1527
1528 impl FnDecl {
1529     pub fn get_self(&self) -> Option<ExplicitSelf> {
1530         self.inputs.get(0).and_then(Arg::to_self)
1531     }
1532     pub fn has_self(&self) -> bool {
1533         self.inputs.get(0).map(Arg::is_self).unwrap_or(false)
1534     }
1535 }
1536
1537 #[derive(Copy, Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1538 pub enum Unsafety {
1539     Unsafe,
1540     Normal,
1541 }
1542
1543 #[derive(Copy, Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1544 pub enum Constness {
1545     Const,
1546     NotConst,
1547 }
1548
1549 #[derive(Copy, Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1550 pub enum Defaultness {
1551     Default,
1552     Final,
1553 }
1554
1555 impl fmt::Display for Unsafety {
1556     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1557         fmt::Display::fmt(match *self {
1558             Unsafety::Normal => "normal",
1559             Unsafety::Unsafe => "unsafe",
1560         }, f)
1561     }
1562 }
1563
1564 #[derive(Copy, Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash)]
1565 pub enum ImplPolarity {
1566     /// `impl Trait for Type`
1567     Positive,
1568     /// `impl !Trait for Type`
1569     Negative,
1570 }
1571
1572 impl fmt::Debug for ImplPolarity {
1573     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
1574         match *self {
1575             ImplPolarity::Positive => "positive".fmt(f),
1576             ImplPolarity::Negative => "negative".fmt(f),
1577         }
1578     }
1579 }
1580
1581
1582 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1583 pub enum FunctionRetTy {
1584     /// Return type is not specified.
1585     ///
1586     /// Functions default to `()` and
1587     /// closures default to inference. Span points to where return
1588     /// type would be inserted.
1589     Default(Span),
1590     /// Everything else
1591     Ty(P<Ty>),
1592 }
1593
1594 impl FunctionRetTy {
1595     pub fn span(&self) -> Span {
1596         match *self {
1597             FunctionRetTy::Default(span) => span,
1598             FunctionRetTy::Ty(ref ty) => ty.span,
1599         }
1600     }
1601 }
1602
1603 /// Module declaration.
1604 ///
1605 /// E.g. `mod foo;` or `mod foo { .. }`
1606 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1607 pub struct Mod {
1608     /// A span from the first token past `{` to the last token until `}`.
1609     /// For `mod foo;`, the inner span ranges from the first token
1610     /// to the last token in the external file.
1611     pub inner: Span,
1612     pub items: Vec<P<Item>>,
1613 }
1614
1615 /// Foreign module declaration.
1616 ///
1617 /// E.g. `extern { .. }` or `extern C { .. }`
1618 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1619 pub struct ForeignMod {
1620     pub abi: Abi,
1621     pub items: Vec<ForeignItem>,
1622 }
1623
1624 /// Global inline assembly
1625 ///
1626 /// aka module-level assembly or file-scoped assembly
1627 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
1628 pub struct GlobalAsm {
1629     pub asm: Symbol,
1630     pub ctxt: SyntaxContext,
1631 }
1632
1633 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1634 pub struct EnumDef {
1635     pub variants: Vec<Variant>,
1636 }
1637
1638 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1639 pub struct Variant_ {
1640     pub name: Ident,
1641     pub attrs: Vec<Attribute>,
1642     pub data: VariantData,
1643     /// Explicit discriminant, e.g. `Foo = 1`
1644     pub disr_expr: Option<P<Expr>>,
1645 }
1646
1647 pub type Variant = Spanned<Variant_>;
1648
1649 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
1650 pub struct PathListItem_ {
1651     pub name: Ident,
1652     /// renamed in list, e.g. `use foo::{bar as baz};`
1653     pub rename: Option<Ident>,
1654     pub id: NodeId,
1655 }
1656
1657 pub type PathListItem = Spanned<PathListItem_>;
1658
1659 pub type ViewPath = Spanned<ViewPath_>;
1660
1661 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1662 pub enum ViewPath_ {
1663
1664     /// `foo::bar::baz as quux`
1665     ///
1666     /// or just
1667     ///
1668     /// `foo::bar::baz` (with `as baz` implicitly on the right)
1669     ViewPathSimple(Ident, Path),
1670
1671     /// `foo::bar::*`
1672     ViewPathGlob(Path),
1673
1674     /// `foo::bar::{a,b,c}`
1675     ViewPathList(Path, Vec<PathListItem>)
1676 }
1677
1678 impl ViewPath_ {
1679     pub fn path(&self) -> &Path {
1680         match *self {
1681             ViewPathSimple(_, ref path) |
1682             ViewPathGlob (ref path) |
1683             ViewPathList(ref path, _) => path
1684         }
1685     }
1686 }
1687
1688
1689 /// Distinguishes between Attributes that decorate items and Attributes that
1690 /// are contained as statements within items. These two cases need to be
1691 /// distinguished for pretty-printing.
1692 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
1693 pub enum AttrStyle {
1694     Outer,
1695     Inner,
1696 }
1697
1698 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
1699 pub struct AttrId(pub usize);
1700
1701 /// Meta-data associated with an item
1702 /// Doc-comments are promoted to attributes that have is_sugared_doc = true
1703 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1704 pub struct Attribute {
1705     pub id: AttrId,
1706     pub style: AttrStyle,
1707     pub path: Path,
1708     pub tokens: TokenStream,
1709     pub is_sugared_doc: bool,
1710     pub span: Span,
1711 }
1712
1713 /// TraitRef's appear in impls.
1714 ///
1715 /// resolve maps each TraitRef's ref_id to its defining trait; that's all
1716 /// that the ref_id is for. The impl_id maps to the "self type" of this impl.
1717 /// If this impl is an ItemKind::Impl, the impl_id is redundant (it could be the
1718 /// same as the impl's node id).
1719 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1720 pub struct TraitRef {
1721     pub path: Path,
1722     pub ref_id: NodeId,
1723 }
1724
1725 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1726 pub struct PolyTraitRef {
1727     /// The `'a` in `<'a> Foo<&'a T>`
1728     pub bound_lifetimes: Vec<LifetimeDef>,
1729
1730     /// The `Foo<&'a T>` in `<'a> Foo<&'a T>`
1731     pub trait_ref: TraitRef,
1732
1733     pub span: Span,
1734 }
1735
1736 impl PolyTraitRef {
1737     pub fn new(lifetimes: Vec<LifetimeDef>, path: Path, span: Span) -> Self {
1738         PolyTraitRef {
1739             bound_lifetimes: lifetimes,
1740             trait_ref: TraitRef { path: path, ref_id: DUMMY_NODE_ID },
1741             span: span,
1742         }
1743     }
1744 }
1745
1746 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1747 pub enum Visibility {
1748     Public,
1749     Crate(Span),
1750     Restricted { path: P<Path>, id: NodeId },
1751     Inherited,
1752 }
1753
1754 /// Field of a struct.
1755 ///
1756 /// E.g. `bar: usize` as in `struct Foo { bar: usize }`
1757 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1758 pub struct StructField {
1759     pub span: Span,
1760     pub ident: Option<Ident>,
1761     pub vis: Visibility,
1762     pub id: NodeId,
1763     pub ty: P<Ty>,
1764     pub attrs: Vec<Attribute>,
1765 }
1766
1767 /// Fields and Ids of enum variants and structs
1768 ///
1769 /// For enum variants: `NodeId` represents both an Id of the variant itself (relevant for all
1770 /// variant kinds) and an Id of the variant's constructor (not relevant for `Struct`-variants).
1771 /// One shared Id can be successfully used for these two purposes.
1772 /// Id of the whole enum lives in `Item`.
1773 ///
1774 /// For structs: `NodeId` represents an Id of the structure's constructor, so it is not actually
1775 /// used for `Struct`-structs (but still presents). Structures don't have an analogue of "Id of
1776 /// the variant itself" from enum variants.
1777 /// Id of the whole struct lives in `Item`.
1778 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1779 pub enum VariantData {
1780     /// Struct variant.
1781     ///
1782     /// E.g. `Bar { .. }` as in `enum Foo { Bar { .. } }`
1783     Struct(Vec<StructField>, NodeId),
1784     /// Tuple variant.
1785     ///
1786     /// E.g. `Bar(..)` as in `enum Foo { Bar(..) }`
1787     Tuple(Vec<StructField>, NodeId),
1788     /// Unit variant.
1789     ///
1790     /// E.g. `Bar = ..` as in `enum Foo { Bar = .. }`
1791     Unit(NodeId),
1792 }
1793
1794 impl VariantData {
1795     pub fn fields(&self) -> &[StructField] {
1796         match *self {
1797             VariantData::Struct(ref fields, _) | VariantData::Tuple(ref fields, _) => fields,
1798             _ => &[],
1799         }
1800     }
1801     pub fn id(&self) -> NodeId {
1802         match *self {
1803             VariantData::Struct(_, id) | VariantData::Tuple(_, id) | VariantData::Unit(id) => id
1804         }
1805     }
1806     pub fn is_struct(&self) -> bool {
1807         if let VariantData::Struct(..) = *self { true } else { false }
1808     }
1809     pub fn is_tuple(&self) -> bool {
1810         if let VariantData::Tuple(..) = *self { true } else { false }
1811     }
1812     pub fn is_unit(&self) -> bool {
1813         if let VariantData::Unit(..) = *self { true } else { false }
1814     }
1815 }
1816
1817 /// An item
1818 ///
1819 /// The name might be a dummy name in case of anonymous items
1820 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1821 pub struct Item {
1822     pub ident: Ident,
1823     pub attrs: Vec<Attribute>,
1824     pub id: NodeId,
1825     pub node: ItemKind,
1826     pub vis: Visibility,
1827     pub span: Span,
1828
1829     /// Original tokens this item was parsed from. This isn't necessarily
1830     /// available for all items, although over time more and more items should
1831     /// have this be `Some`. Right now this is primarily used for procedural
1832     /// macros, notably custom attributes.
1833     ///
1834     /// Note that the tokens here do not include the outer attributes, but will
1835     /// include inner attributes.
1836     pub tokens: Option<TokenStream>,
1837 }
1838
1839 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1840 pub enum ItemKind {
1841     /// An`extern crate` item, with optional original crate name.
1842     ///
1843     /// E.g. `extern crate foo` or `extern crate foo_bar as foo`
1844     ExternCrate(Option<Name>),
1845     /// A use declaration (`use` or `pub use`) item.
1846     ///
1847     /// E.g. `use foo;`, `use foo::bar;` or `use foo::bar as FooBar;`
1848     Use(P<ViewPath>),
1849     /// A static item (`static` or `pub static`).
1850     ///
1851     /// E.g. `static FOO: i32 = 42;` or `static FOO: &'static str = "bar";`
1852     Static(P<Ty>, Mutability, P<Expr>),
1853     /// A constant item (`const` or `pub const`).
1854     ///
1855     /// E.g. `const FOO: i32 = 42;`
1856     Const(P<Ty>, P<Expr>),
1857     /// A function declaration (`fn` or `pub fn`).
1858     ///
1859     /// E.g. `fn foo(bar: usize) -> usize { .. }`
1860     Fn(P<FnDecl>, Unsafety, Spanned<Constness>, Abi, Generics, P<Block>),
1861     /// A module declaration (`mod` or `pub mod`).
1862     ///
1863     /// E.g. `mod foo;` or `mod foo { .. }`
1864     Mod(Mod),
1865     /// An external module (`extern` or `pub extern`).
1866     ///
1867     /// E.g. `extern {}` or `extern "C" {}`
1868     ForeignMod(ForeignMod),
1869     /// Module-level inline assembly (from `global_asm!()`)
1870     GlobalAsm(P<GlobalAsm>),
1871     /// A type alias (`type` or `pub type`).
1872     ///
1873     /// E.g. `type Foo = Bar<u8>;`
1874     Ty(P<Ty>, Generics),
1875     /// An enum definition (`enum` or `pub enum`).
1876     ///
1877     /// E.g. `enum Foo<A, B> { C<A>, D<B> }`
1878     Enum(EnumDef, Generics),
1879     /// A struct definition (`struct` or `pub struct`).
1880     ///
1881     /// E.g. `struct Foo<A> { x: A }`
1882     Struct(VariantData, Generics),
1883     /// A union definition (`union` or `pub union`).
1884     ///
1885     /// E.g. `union Foo<A, B> { x: A, y: B }`
1886     Union(VariantData, Generics),
1887     /// A Trait declaration (`trait` or `pub trait`).
1888     ///
1889     /// E.g. `trait Foo { .. }` or `trait Foo<T> { .. }`
1890     Trait(Unsafety, Generics, TyParamBounds, Vec<TraitItem>),
1891     // Default trait implementation.
1892     ///
1893     /// E.g. `impl Trait for .. {}` or `impl<T> Trait<T> for .. {}`
1894     DefaultImpl(Unsafety, TraitRef),
1895     /// An implementation.
1896     ///
1897     /// E.g. `impl<A> Foo<A> { .. }` or `impl<A> Trait for Foo<A> { .. }`
1898     Impl(Unsafety,
1899              ImplPolarity,
1900              Defaultness,
1901              Generics,
1902              Option<TraitRef>, // (optional) trait this impl implements
1903              P<Ty>, // self
1904              Vec<ImplItem>),
1905     /// A macro invocation.
1906     ///
1907     /// E.g. `macro_rules! foo { .. }` or `foo!(..)`
1908     Mac(Mac),
1909
1910     /// A macro definition.
1911     MacroDef(MacroDef),
1912 }
1913
1914 impl ItemKind {
1915     pub fn descriptive_variant(&self) -> &str {
1916         match *self {
1917             ItemKind::ExternCrate(..) => "extern crate",
1918             ItemKind::Use(..) => "use",
1919             ItemKind::Static(..) => "static item",
1920             ItemKind::Const(..) => "constant item",
1921             ItemKind::Fn(..) => "function",
1922             ItemKind::Mod(..) => "module",
1923             ItemKind::ForeignMod(..) => "foreign module",
1924             ItemKind::GlobalAsm(..) => "global asm",
1925             ItemKind::Ty(..) => "type alias",
1926             ItemKind::Enum(..) => "enum",
1927             ItemKind::Struct(..) => "struct",
1928             ItemKind::Union(..) => "union",
1929             ItemKind::Trait(..) => "trait",
1930             ItemKind::Mac(..) |
1931             ItemKind::MacroDef(..) |
1932             ItemKind::Impl(..) |
1933             ItemKind::DefaultImpl(..) => "item"
1934         }
1935     }
1936 }
1937
1938 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1939 pub struct ForeignItem {
1940     pub ident: Ident,
1941     pub attrs: Vec<Attribute>,
1942     pub node: ForeignItemKind,
1943     pub id: NodeId,
1944     pub span: Span,
1945     pub vis: Visibility,
1946 }
1947
1948 /// An item within an `extern` block
1949 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
1950 pub enum ForeignItemKind {
1951     /// A foreign function
1952     Fn(P<FnDecl>, Generics),
1953     /// A foreign static item (`static ext: u8`), with optional mutability
1954     /// (the boolean is true when mutable)
1955     Static(P<Ty>, bool),
1956 }
1957
1958 impl ForeignItemKind {
1959     pub fn descriptive_variant(&self) -> &str {
1960         match *self {
1961             ForeignItemKind::Fn(..) => "foreign function",
1962             ForeignItemKind::Static(..) => "foreign static item"
1963         }
1964     }
1965 }
1966
1967 #[cfg(test)]
1968 mod tests {
1969     use serialize;
1970     use super::*;
1971
1972     // are ASTs encodable?
1973     #[test]
1974     fn check_asts_encodable() {
1975         fn assert_encodable<T: serialize::Encodable>() {}
1976         assert_encodable::<Crate>();
1977     }
1978 }