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