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