1 // Copyright 2015 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.
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.
13 pub use self::BlockCheckMode::*;
14 pub use self::CaptureClause::*;
15 pub use self::FunctionRetTy::*;
16 pub use self::Mutability::*;
17 pub use self::PrimTy::*;
18 pub use self::UnOp::*;
19 pub use self::UnsafeSource::*;
22 use hir::def_id::{DefId, DefIndex, LocalDefId, CRATE_DEF_INDEX};
23 use util::nodemap::{NodeMap, FxHashSet};
24 use mir::mono::Linkage;
26 use syntax_pos::{Span, DUMMY_SP, symbol::InternedString};
27 use syntax::source_map::{self, Spanned};
28 use rustc_target::spec::abi::Abi;
29 use syntax::ast::{self, CrateSugar, Ident, Name, NodeId, DUMMY_NODE_ID, AsmDialect};
30 use syntax::ast::{Attribute, Lit, StrStyle, FloatTy, IntTy, UintTy, MetaItem};
31 use syntax::attr::InlineAttr;
32 use syntax::ext::hygiene::SyntaxContext;
34 use syntax::symbol::{Symbol, keywords};
35 use syntax::tokenstream::TokenStream;
36 use syntax::util::parser::ExprPrecedence;
38 use ty::query::Providers;
40 use rustc_data_structures::indexed_vec;
41 use rustc_data_structures::sync::{ParallelIterator, par_iter, Send, Sync, scope};
42 use rustc_data_structures::thin_vec::ThinVec;
44 use serialize::{self, Encoder, Encodable, Decoder, Decodable};
45 use std::collections::BTreeMap;
48 /// HIR doesn't commit to a concrete storage type and has its own alias for a vector.
49 /// It can be `Vec`, `P<[T]>` or potentially `Box<[T]>`, or some other container with similar
50 /// behavior. Unlike AST, HIR is mostly a static structure, so we can use an owned slice instead
51 /// of `Vec` to avoid keeping extra capacity.
52 pub type HirVec<T> = P<[T]>;
54 macro_rules! hir_vec {
55 ($elem:expr; $n:expr) => (
56 $crate::hir::HirVec::from(vec![$elem; $n])
59 $crate::hir::HirVec::from(vec![$($x),*])
61 ($($x:expr,)*) => (hir_vec![$($x),*])
68 pub mod itemlikevisit;
74 /// A HirId uniquely identifies a node in the HIR of the current crate. It is
75 /// composed of the `owner`, which is the DefIndex of the directly enclosing
76 /// hir::Item, hir::TraitItem, or hir::ImplItem (i.e. the closest "item-like"),
77 /// and the `local_id` which is unique within the given owner.
79 /// This two-level structure makes for more stable values: One can move an item
80 /// around within the source code, or add or remove stuff before it, without
81 /// the local_id part of the HirId changing, which is a very useful property in
82 /// incremental compilation where we have to persist things through changes to
84 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
87 pub local_id: ItemLocalId,
91 pub fn owner_def_id(self) -> DefId {
92 DefId::local(self.owner)
95 pub fn owner_local_def_id(self) -> LocalDefId {
96 LocalDefId::from_def_id(DefId::local(self.owner))
100 impl serialize::UseSpecializedEncodable for HirId {
101 fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
112 impl serialize::UseSpecializedDecodable for HirId {
113 fn default_decode<D: Decoder>(d: &mut D) -> Result<HirId, D::Error> {
114 let owner = DefIndex::decode(d)?;
115 let local_id = ItemLocalId::decode(d)?;
125 /// An `ItemLocalId` uniquely identifies something within a given "item-like",
126 /// that is within a hir::Item, hir::TraitItem, or hir::ImplItem. There is no
127 /// guarantee that the numerical value of a given `ItemLocalId` corresponds to
128 /// the node's position within the owning item in any way, but there is a
129 /// guarantee that the `LocalItemId`s within an owner occupy a dense range of
130 /// integers starting at zero, so a mapping that maps all or most nodes within
131 /// an "item-like" to something else can be implement by a `Vec` instead of a
132 /// tree or hash map.
133 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug,
134 RustcEncodable, RustcDecodable)]
135 pub struct ItemLocalId(pub u32);
138 pub fn as_usize(&self) -> usize {
143 impl indexed_vec::Idx for ItemLocalId {
144 fn new(idx: usize) -> Self {
145 debug_assert!((idx as u32) as usize == idx);
146 ItemLocalId(idx as u32)
149 fn index(self) -> usize {
154 /// The `HirId` corresponding to CRATE_NODE_ID and CRATE_DEF_INDEX
155 pub const CRATE_HIR_ID: HirId = HirId {
156 owner: CRATE_DEF_INDEX,
157 local_id: ItemLocalId(0)
160 pub const DUMMY_HIR_ID: HirId = HirId {
161 owner: CRATE_DEF_INDEX,
162 local_id: DUMMY_ITEM_LOCAL_ID,
165 pub const DUMMY_ITEM_LOCAL_ID: ItemLocalId = ItemLocalId(!0);
167 #[derive(Clone, RustcEncodable, RustcDecodable, Copy)]
172 impl fmt::Debug for Label {
173 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
174 write!(f, "label({:?})", self.ident)
178 #[derive(Clone, RustcEncodable, RustcDecodable, Copy)]
179 pub struct Lifetime {
183 /// Either "'a", referring to a named lifetime definition,
184 /// or "" (aka keywords::Invalid), for elision placeholders.
186 /// HIR lowering inserts these placeholders in type paths that
187 /// refer to type definitions needing lifetime parameters,
188 /// `&T` and `&mut T`, and trait objects without `... + 'a`.
189 pub name: LifetimeName,
192 #[derive(Debug, Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Copy)]
194 /// Some user-given name like `T` or `'x`.
197 /// Synthetic name generated when user elided a lifetime in an impl header,
198 /// e.g. the lifetimes in cases like these:
200 /// impl Foo for &u32
201 /// impl Foo<'_> for u32
203 /// in that case, we rewrite to
205 /// impl<'f> Foo for &'f u32
206 /// impl<'f> Foo<'f> for u32
208 /// where `'f` is something like `Fresh(0)`. The indices are
209 /// unique per impl, but not necessarily continuous.
214 pub fn ident(&self) -> Ident {
216 ParamName::Plain(ident) => ident,
217 ParamName::Fresh(_) => keywords::UnderscoreLifetime.ident(),
221 pub fn modern(&self) -> ParamName {
223 ParamName::Plain(ident) => ParamName::Plain(ident.modern()),
224 param_name => param_name,
229 #[derive(Debug, Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Copy)]
230 pub enum LifetimeName {
231 /// User-given names or fresh (synthetic) names.
234 /// User typed nothing. e.g. the lifetime in `&u32`.
240 /// User wrote `'static`
245 pub fn ident(&self) -> Ident {
247 LifetimeName::Implicit => keywords::Invalid.ident(),
248 LifetimeName::Underscore => keywords::UnderscoreLifetime.ident(),
249 LifetimeName::Static => keywords::StaticLifetime.ident(),
250 LifetimeName::Param(param_name) => param_name.ident(),
254 pub fn is_elided(&self) -> bool {
256 LifetimeName::Implicit | LifetimeName::Underscore => true,
258 // It might seem surprising that `Fresh(_)` counts as
259 // *not* elided -- but this is because, as far as the code
260 // in the compiler is concerned -- `Fresh(_)` variants act
261 // equivalently to "some fresh name". They correspond to
262 // early-bound regions on an impl, in other words.
263 LifetimeName::Param(_) | LifetimeName::Static => false,
267 fn is_static(&self) -> bool {
268 self == &LifetimeName::Static
271 pub fn modern(&self) -> LifetimeName {
273 LifetimeName::Param(param_name) => LifetimeName::Param(param_name.modern()),
274 lifetime_name => lifetime_name,
279 impl fmt::Display for Lifetime {
280 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
281 self.name.ident().fmt(f)
285 impl fmt::Debug for Lifetime {
286 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
290 print::to_string(print::NO_ANN, |s| s.print_lifetime(self)))
295 pub fn is_elided(&self) -> bool {
296 self.name.is_elided()
299 pub fn is_static(&self) -> bool {
300 self.name.is_static()
304 /// A "Path" is essentially Rust's notion of a name; for instance:
305 /// `std::cmp::PartialEq`. It's represented as a sequence of identifiers,
306 /// along with a bunch of supporting information.
307 #[derive(Clone, RustcEncodable, RustcDecodable)]
310 /// The definition that the path resolved to.
312 /// The segments in the path: the things separated by `::`.
313 pub segments: HirVec<PathSegment>,
317 pub fn is_global(&self) -> bool {
318 !self.segments.is_empty() && self.segments[0].ident.name == keywords::CrateRoot.name()
322 impl fmt::Debug for Path {
323 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
324 write!(f, "path({})", print::to_string(print::NO_ANN, |s| s.print_path(self, false)))
328 impl fmt::Display for Path {
329 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
330 write!(f, "{}", print::to_string(print::NO_ANN, |s| s.print_path(self, false)))
334 /// A segment of a path: an identifier, an optional lifetime, and a set of
336 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
337 pub struct PathSegment {
338 /// The identifier portion of this path segment.
341 /// Type/lifetime parameters attached to this path. They come in
342 /// two flavors: `Path<A,B,C>` and `Path(A,B) -> C`. Note that
343 /// this is more than just simple syntactic sugar; the use of
344 /// parens affects the region binding rules, so we preserve the
346 pub args: Option<P<GenericArgs>>,
348 /// Whether to infer remaining type parameters, if any.
349 /// This only applies to expression and pattern paths, and
350 /// out of those only the segments with no type parameters
351 /// to begin with, e.g. `Vec::new` is `<Vec<..>>::new::<..>`.
352 pub infer_types: bool,
356 /// Convert an identifier to the corresponding segment.
357 pub fn from_ident(ident: Ident) -> PathSegment {
365 pub fn new(ident: Ident, args: GenericArgs, infer_types: bool) -> Self {
369 args: if args.is_empty() {
377 // FIXME: hack required because you can't create a static
378 // GenericArgs, so you can't just return a &GenericArgs.
379 pub fn with_generic_args<F, R>(&self, f: F) -> R
380 where F: FnOnce(&GenericArgs) -> R
382 let dummy = GenericArgs::none();
383 f(if let Some(ref args) = self.args {
391 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
392 pub enum GenericArg {
398 pub fn span(&self) -> Span {
400 GenericArg::Lifetime(l) => l.span,
401 GenericArg::Type(t) => t.span,
405 pub fn id(&self) -> NodeId {
407 GenericArg::Lifetime(l) => l.id,
408 GenericArg::Type(t) => t.id,
413 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
414 pub struct GenericArgs {
415 /// The generic arguments for this path segment.
416 pub args: HirVec<GenericArg>,
417 /// Bindings (equality constraints) on associated types, if present.
418 /// E.g., `Foo<A=Bar>`.
419 pub bindings: HirVec<TypeBinding>,
420 /// Were arguments written in parenthesized form `Fn(T) -> U`?
421 /// This is required mostly for pretty-printing and diagnostics,
422 /// but also for changing lifetime elision rules to be "function-like".
423 pub parenthesized: bool,
427 pub fn none() -> Self {
430 bindings: HirVec::new(),
431 parenthesized: false,
435 pub fn is_empty(&self) -> bool {
436 self.args.is_empty() && self.bindings.is_empty() && !self.parenthesized
439 pub fn inputs(&self) -> &[Ty] {
440 if self.parenthesized {
441 for arg in &self.args {
443 GenericArg::Lifetime(_) => {}
444 GenericArg::Type(ref ty) => {
445 if let TyKind::Tup(ref tys) = ty.node {
453 bug!("GenericArgs::inputs: not a `Fn(T) -> U`");
456 pub fn own_counts(&self) -> GenericParamCount {
457 // We could cache this as a property of `GenericParamCount`, but
458 // the aim is to refactor this away entirely eventually and the
459 // presence of this method will be a constant reminder.
460 let mut own_counts: GenericParamCount = Default::default();
462 for arg in &self.args {
464 GenericArg::Lifetime(_) => own_counts.lifetimes += 1,
465 GenericArg::Type(_) => own_counts.types += 1,
473 /// A modifier on a bound, currently this is only used for `?Sized`, where the
474 /// modifier is `Maybe`. Negative bounds should also be handled here.
475 #[derive(Copy, Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
476 pub enum TraitBoundModifier {
481 /// The AST represents all type param bounds as types.
482 /// typeck::collect::compute_bounds matches these against
483 /// the "special" built-in traits (see middle::lang_items) and
484 /// detects Copy, Send and Sync.
485 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
486 pub enum GenericBound {
487 Trait(PolyTraitRef, TraitBoundModifier),
492 pub fn span(&self) -> Span {
494 &GenericBound::Trait(ref t, ..) => t.span,
495 &GenericBound::Outlives(ref l) => l.span,
500 pub type GenericBounds = HirVec<GenericBound>;
502 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
503 pub enum GenericParamKind {
504 /// A lifetime definition, eg `'a: 'b + 'c + 'd`.
506 // Indicates that the lifetime definition was synthetically added
507 // as a result of an in-band lifetime usage like:
508 // `fn foo(x: &'a u8) -> &'a u8 { x }`
512 default: Option<P<Ty>>,
513 synthetic: Option<SyntheticTyParamKind>,
517 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
518 pub struct GenericParam {
521 pub attrs: HirVec<Attribute>,
522 pub bounds: GenericBounds,
524 pub pure_wrt_drop: bool,
526 pub kind: GenericParamKind,
530 pub struct GenericParamCount {
531 pub lifetimes: usize,
535 /// Represents lifetimes and type parameters attached to a declaration
536 /// of a function, enum, trait, etc.
537 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
538 pub struct Generics {
539 pub params: HirVec<GenericParam>,
540 pub where_clause: WhereClause,
545 pub fn empty() -> Generics {
547 params: HirVec::new(),
548 where_clause: WhereClause {
550 predicates: HirVec::new(),
556 pub fn own_counts(&self) -> GenericParamCount {
557 // We could cache this as a property of `GenericParamCount`, but
558 // the aim is to refactor this away entirely eventually and the
559 // presence of this method will be a constant reminder.
560 let mut own_counts: GenericParamCount = Default::default();
562 for param in &self.params {
564 GenericParamKind::Lifetime { .. } => own_counts.lifetimes += 1,
565 GenericParamKind::Type { .. } => own_counts.types += 1,
572 pub fn get_named(&self, name: &InternedString) -> Option<&GenericParam> {
573 for param in &self.params {
574 if *name == param.name.ident().as_interned_str() {
582 /// Synthetic Type Parameters are converted to an other form during lowering, this allows
583 /// to track the original form they had. Useful for error messages.
584 #[derive(Copy, Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug)]
585 pub enum SyntheticTyParamKind {
589 /// A `where` clause in a definition
590 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
591 pub struct WhereClause {
593 pub predicates: HirVec<WherePredicate>,
597 pub fn span(&self) -> Option<Span> {
598 self.predicates.iter().map(|predicate| predicate.span())
599 .fold(None, |acc, i| match (acc, i) {
600 (None, i) => Some(i),
608 /// A single predicate in a `where` clause
609 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
610 pub enum WherePredicate {
611 /// A type binding, eg `for<'c> Foo: Send+Clone+'c`
612 BoundPredicate(WhereBoundPredicate),
613 /// A lifetime predicate, e.g. `'a: 'b+'c`
614 RegionPredicate(WhereRegionPredicate),
615 /// An equality predicate (unsupported)
616 EqPredicate(WhereEqPredicate),
619 impl WherePredicate {
620 pub fn span(&self) -> Span {
622 &WherePredicate::BoundPredicate(ref p) => p.span,
623 &WherePredicate::RegionPredicate(ref p) => p.span,
624 &WherePredicate::EqPredicate(ref p) => p.span,
629 /// A type bound, eg `for<'c> Foo: Send+Clone+'c`
630 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
631 pub struct WhereBoundPredicate {
633 /// Any generics from a `for` binding
634 pub bound_generic_params: HirVec<GenericParam>,
635 /// The type being bounded
636 pub bounded_ty: P<Ty>,
637 /// Trait and lifetime bounds (`Clone+Send+'static`)
638 pub bounds: GenericBounds,
641 /// A lifetime predicate, e.g. `'a: 'b+'c`
642 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
643 pub struct WhereRegionPredicate {
645 pub lifetime: Lifetime,
646 pub bounds: GenericBounds,
649 /// An equality predicate (unsupported), e.g. `T=int`
650 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
651 pub struct WhereEqPredicate {
658 pub type CrateConfig = HirVec<P<MetaItem>>;
660 /// The top-level data structure that stores the entire contents of
661 /// the crate currently being compiled.
663 /// For more details, see the [rustc guide].
665 /// [rustc guide]: https://rust-lang-nursery.github.io/rustc-guide/hir.html
666 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
669 pub attrs: HirVec<Attribute>,
671 pub exported_macros: HirVec<MacroDef>,
673 // NB: We use a BTreeMap here so that `visit_all_items` iterates
674 // over the ids in increasing order. In principle it should not
675 // matter what order we visit things in, but in *practice* it
676 // does, because it can affect the order in which errors are
677 // detected, which in turn can make compile-fail tests yield
678 // slightly different results.
679 pub items: BTreeMap<NodeId, Item>,
681 pub trait_items: BTreeMap<TraitItemId, TraitItem>,
682 pub impl_items: BTreeMap<ImplItemId, ImplItem>,
683 pub bodies: BTreeMap<BodyId, Body>,
684 pub trait_impls: BTreeMap<DefId, Vec<NodeId>>,
685 pub trait_auto_impl: BTreeMap<DefId, NodeId>,
687 /// A list of the body ids written out in the order in which they
688 /// appear in the crate. If you're going to process all the bodies
689 /// in the crate, you should iterate over this list rather than the keys
691 pub body_ids: Vec<BodyId>,
695 pub fn item(&self, id: NodeId) -> &Item {
699 pub fn trait_item(&self, id: TraitItemId) -> &TraitItem {
700 &self.trait_items[&id]
703 pub fn impl_item(&self, id: ImplItemId) -> &ImplItem {
704 &self.impl_items[&id]
707 /// Visits all items in the crate in some deterministic (but
708 /// unspecified) order. If you just need to process every item,
709 /// but don't care about nesting, this method is the best choice.
711 /// If you do care about nesting -- usually because your algorithm
712 /// follows lexical scoping rules -- then you want a different
713 /// approach. You should override `visit_nested_item` in your
714 /// visitor and then call `intravisit::walk_crate` instead.
715 pub fn visit_all_item_likes<'hir, V>(&'hir self, visitor: &mut V)
716 where V: itemlikevisit::ItemLikeVisitor<'hir>
718 for (_, item) in &self.items {
719 visitor.visit_item(item);
722 for (_, trait_item) in &self.trait_items {
723 visitor.visit_trait_item(trait_item);
726 for (_, impl_item) in &self.impl_items {
727 visitor.visit_impl_item(impl_item);
731 /// A parallel version of visit_all_item_likes
732 pub fn par_visit_all_item_likes<'hir, V>(&'hir self, visitor: &V)
733 where V: itemlikevisit::ParItemLikeVisitor<'hir> + Sync + Send
737 par_iter(&self.items).for_each(|(_, item)| {
738 visitor.visit_item(item);
743 par_iter(&self.trait_items).for_each(|(_, trait_item)| {
744 visitor.visit_trait_item(trait_item);
749 par_iter(&self.impl_items).for_each(|(_, impl_item)| {
750 visitor.visit_impl_item(impl_item);
756 pub fn body(&self, id: BodyId) -> &Body {
761 /// A macro definition, in this crate or imported from another.
763 /// Not parsed directly, but created on macro import or `macro_rules!` expansion.
764 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
765 pub struct MacroDef {
768 pub attrs: HirVec<Attribute>,
771 pub body: TokenStream,
775 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
777 /// Statements in a block
778 pub stmts: HirVec<Stmt>,
779 /// An expression at the end of the block
780 /// without a semicolon, if any
781 pub expr: Option<P<Expr>>,
784 /// Distinguishes between `unsafe { ... }` and `{ ... }`
785 pub rules: BlockCheckMode,
787 /// If true, then there may exist `break 'a` values that aim to
788 /// break out of this block early.
789 /// Used by `'label: {}` blocks and by `catch` statements.
790 pub targeted_by_break: bool,
791 /// If true, don't emit return value type errors as the parser had
792 /// to recover from a parse error so this block will not have an
793 /// appropriate type. A parse error will have been emitted so the
794 /// compilation will never succeed if this is true.
798 #[derive(Clone, RustcEncodable, RustcDecodable)]
806 impl fmt::Debug for Pat {
807 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
808 write!(f, "pat({}: {})", self.id,
809 print::to_string(print::NO_ANN, |s| s.print_pat(self)))
814 // FIXME(#19596) this is a workaround, but there should be a better way
815 fn walk_<G>(&self, it: &mut G) -> bool
816 where G: FnMut(&Pat) -> bool
823 PatKind::Binding(.., Some(ref p)) => p.walk_(it),
824 PatKind::Struct(_, ref fields, _) => {
825 fields.iter().all(|field| field.node.pat.walk_(it))
827 PatKind::TupleStruct(_, ref s, _) | PatKind::Tuple(ref s, _) => {
828 s.iter().all(|p| p.walk_(it))
830 PatKind::Box(ref s) | PatKind::Ref(ref s, _) => {
833 PatKind::Slice(ref before, ref slice, ref after) => {
837 .all(|p| p.walk_(it))
842 PatKind::Binding(..) |
843 PatKind::Path(_) => {
849 pub fn walk<F>(&self, mut it: F) -> bool
850 where F: FnMut(&Pat) -> bool
856 /// A single field in a struct pattern
858 /// Patterns like the fields of Foo `{ x, ref y, ref mut z }`
859 /// are treated the same as` x: x, y: ref y, z: ref mut z`,
860 /// except is_shorthand is true
861 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
862 pub struct FieldPat {
864 /// The identifier for the field
866 /// The pattern the field is destructured to
868 pub is_shorthand: bool,
871 /// Explicit binding annotations given in the HIR for a binding. Note
872 /// that this is not the final binding *mode* that we infer after type
874 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
875 pub enum BindingAnnotation {
876 /// No binding annotation given: this means that the final binding mode
877 /// will depend on whether we have skipped through a `&` reference
878 /// when matching. For example, the `x` in `Some(x)` will have binding
879 /// mode `None`; if you do `let Some(x) = &Some(22)`, it will
880 /// ultimately be inferred to be by-reference.
882 /// Note that implicit reference skipping is not implemented yet (#42640).
885 /// Annotated with `mut x` -- could be either ref or not, similar to `None`.
888 /// Annotated as `ref`, like `ref x`
891 /// Annotated as `ref mut x`.
895 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
901 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
903 /// Represents a wildcard pattern (`_`)
906 /// A fresh binding `ref mut binding @ OPT_SUBPATTERN`.
907 /// The `NodeId` is the canonical ID for the variable being bound,
908 /// e.g. in `Ok(x) | Err(x)`, both `x` use the same canonical ID,
909 /// which is the pattern ID of the first `x`.
910 Binding(BindingAnnotation, NodeId, Ident, Option<P<Pat>>),
912 /// A struct or struct variant pattern, e.g. `Variant {x, y, ..}`.
913 /// The `bool` is `true` in the presence of a `..`.
914 Struct(QPath, HirVec<Spanned<FieldPat>>, bool),
916 /// A tuple struct/variant pattern `Variant(x, y, .., z)`.
917 /// If the `..` pattern fragment is present, then `Option<usize>` denotes its position.
918 /// 0 <= position <= subpats.len()
919 TupleStruct(QPath, HirVec<P<Pat>>, Option<usize>),
921 /// A path pattern for an unit struct/variant or a (maybe-associated) constant.
924 /// A tuple pattern `(a, b)`.
925 /// If the `..` pattern fragment is present, then `Option<usize>` denotes its position.
926 /// 0 <= position <= subpats.len()
927 Tuple(HirVec<P<Pat>>, Option<usize>),
930 /// A reference pattern, e.g. `&mut (a, b)`
931 Ref(P<Pat>, Mutability),
934 /// A range pattern, e.g. `1...2` or `1..2`
935 Range(P<Expr>, P<Expr>, RangeEnd),
936 /// `[a, b, ..i, y, z]` is represented as:
937 /// `PatKind::Slice(box [a, b], Some(i), box [y, z])`
938 Slice(HirVec<P<Pat>>, Option<P<Pat>>, HirVec<P<Pat>>),
941 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
942 pub enum Mutability {
948 /// Return MutMutable only if both arguments are mutable.
949 pub fn and(self, other: Self) -> Self {
952 MutImmutable => MutImmutable,
957 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy, Hash)]
959 /// The `+` operator (addition)
961 /// The `-` operator (subtraction)
963 /// The `*` operator (multiplication)
965 /// The `/` operator (division)
967 /// The `%` operator (modulus)
969 /// The `&&` operator (logical and)
971 /// The `||` operator (logical or)
973 /// The `^` operator (bitwise xor)
975 /// The `&` operator (bitwise and)
977 /// The `|` operator (bitwise or)
979 /// The `<<` operator (shift left)
981 /// The `>>` operator (shift right)
983 /// The `==` operator (equality)
985 /// The `<` operator (less than)
987 /// The `<=` operator (less than or equal to)
989 /// The `!=` operator (not equal to)
991 /// The `>=` operator (greater than or equal to)
993 /// The `>` operator (greater than)
998 pub fn as_str(self) -> &'static str {
1000 BinOpKind::Add => "+",
1001 BinOpKind::Sub => "-",
1002 BinOpKind::Mul => "*",
1003 BinOpKind::Div => "/",
1004 BinOpKind::Rem => "%",
1005 BinOpKind::And => "&&",
1006 BinOpKind::Or => "||",
1007 BinOpKind::BitXor => "^",
1008 BinOpKind::BitAnd => "&",
1009 BinOpKind::BitOr => "|",
1010 BinOpKind::Shl => "<<",
1011 BinOpKind::Shr => ">>",
1012 BinOpKind::Eq => "==",
1013 BinOpKind::Lt => "<",
1014 BinOpKind::Le => "<=",
1015 BinOpKind::Ne => "!=",
1016 BinOpKind::Ge => ">=",
1017 BinOpKind::Gt => ">",
1021 pub fn is_lazy(self) -> bool {
1023 BinOpKind::And | BinOpKind::Or => true,
1028 pub fn is_shift(self) -> bool {
1030 BinOpKind::Shl | BinOpKind::Shr => true,
1035 pub fn is_comparison(self) -> bool {
1042 BinOpKind::Ge => true,
1054 BinOpKind::Shr => false,
1058 /// Returns `true` if the binary operator takes its arguments by value
1059 pub fn is_by_value(self) -> bool {
1060 !self.is_comparison()
1064 impl Into<ast::BinOpKind> for BinOpKind {
1065 fn into(self) -> ast::BinOpKind {
1067 BinOpKind::Add => ast::BinOpKind::Add,
1068 BinOpKind::Sub => ast::BinOpKind::Sub,
1069 BinOpKind::Mul => ast::BinOpKind::Mul,
1070 BinOpKind::Div => ast::BinOpKind::Div,
1071 BinOpKind::Rem => ast::BinOpKind::Rem,
1072 BinOpKind::And => ast::BinOpKind::And,
1073 BinOpKind::Or => ast::BinOpKind::Or,
1074 BinOpKind::BitXor => ast::BinOpKind::BitXor,
1075 BinOpKind::BitAnd => ast::BinOpKind::BitAnd,
1076 BinOpKind::BitOr => ast::BinOpKind::BitOr,
1077 BinOpKind::Shl => ast::BinOpKind::Shl,
1078 BinOpKind::Shr => ast::BinOpKind::Shr,
1079 BinOpKind::Eq => ast::BinOpKind::Eq,
1080 BinOpKind::Lt => ast::BinOpKind::Lt,
1081 BinOpKind::Le => ast::BinOpKind::Le,
1082 BinOpKind::Ne => ast::BinOpKind::Ne,
1083 BinOpKind::Ge => ast::BinOpKind::Ge,
1084 BinOpKind::Gt => ast::BinOpKind::Gt,
1089 pub type BinOp = Spanned<BinOpKind>;
1091 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy, Hash)]
1093 /// The `*` operator for dereferencing
1095 /// The `!` operator for logical inversion
1097 /// The `-` operator for negation
1102 pub fn as_str(self) -> &'static str {
1110 /// Returns `true` if the unary operator takes its argument by value
1111 pub fn is_by_value(self) -> bool {
1113 UnNeg | UnNot => true,
1120 pub type Stmt = Spanned<StmtKind>;
1122 impl fmt::Debug for StmtKind {
1123 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1125 let spanned = source_map::dummy_spanned(self.clone());
1129 print::to_string(print::NO_ANN, |s| s.print_stmt(&spanned)))
1133 #[derive(Clone, RustcEncodable, RustcDecodable)]
1135 /// Could be an item or a local (let) binding:
1136 Decl(P<Decl>, NodeId),
1138 /// Expr without trailing semi-colon (must have unit type):
1139 Expr(P<Expr>, NodeId),
1141 /// Expr with trailing semi-colon (may have any type):
1142 Semi(P<Expr>, NodeId),
1146 pub fn attrs(&self) -> &[Attribute] {
1148 StmtKind::Decl(ref d, _) => d.node.attrs(),
1149 StmtKind::Expr(ref e, _) |
1150 StmtKind::Semi(ref e, _) => &e.attrs,
1154 pub fn id(&self) -> NodeId {
1156 StmtKind::Decl(_, id) => id,
1157 StmtKind::Expr(_, id) => id,
1158 StmtKind::Semi(_, id) => id,
1163 /// Local represents a `let` statement, e.g., `let <pat>:<ty> = <expr>;`
1164 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1167 pub ty: Option<P<Ty>>,
1168 /// Initializer expression to set the value, if any
1169 pub init: Option<P<Expr>>,
1173 pub attrs: ThinVec<Attribute>,
1174 pub source: LocalSource,
1177 pub type Decl = Spanned<DeclKind>;
1179 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1181 /// A local (let) binding:
1183 /// An item binding:
1188 pub fn attrs(&self) -> &[Attribute] {
1190 DeclKind::Local(ref l) => &l.attrs,
1191 DeclKind::Item(_) => &[]
1195 pub fn is_local(&self) -> bool {
1197 DeclKind::Local(_) => true,
1203 /// represents one arm of a 'match'
1204 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1206 pub attrs: HirVec<Attribute>,
1207 pub pats: HirVec<P<Pat>>,
1208 pub guard: Option<Guard>,
1212 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1217 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1223 pub is_shorthand: bool,
1226 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
1227 pub enum BlockCheckMode {
1229 UnsafeBlock(UnsafeSource),
1230 PushUnsafeBlock(UnsafeSource),
1231 PopUnsafeBlock(UnsafeSource),
1234 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
1235 pub enum UnsafeSource {
1240 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable, Hash, Debug)]
1242 pub node_id: NodeId,
1245 /// The body of a function, closure, or constant value. In the case of
1246 /// a function, the body contains not only the function body itself
1247 /// (which is an expression), but also the argument patterns, since
1248 /// those are something that the caller doesn't really care about.
1253 /// fn foo((x, y): (u32, u32)) -> u32 {
1258 /// Here, the `Body` associated with `foo()` would contain:
1260 /// - an `arguments` array containing the `(x, y)` pattern
1261 /// - a `value` containing the `x + y` expression (maybe wrapped in a block)
1262 /// - `is_generator` would be false
1264 /// All bodies have an **owner**, which can be accessed via the HIR
1265 /// map using `body_owner_def_id()`.
1266 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1268 pub arguments: HirVec<Arg>,
1270 pub is_generator: bool,
1274 pub fn id(&self) -> BodyId {
1276 node_id: self.value.id
1281 #[derive(Copy, Clone, Debug)]
1282 pub enum BodyOwnerKind {
1283 /// Functions and methods.
1286 /// Constants and associated constants.
1289 /// Initializer of a `static` item.
1293 /// A constant (expression) that's not an item or associated item,
1294 /// but needs its own `DefId` for type-checking, const-eval, etc.
1295 /// These are usually found nested inside types (e.g. array lengths)
1296 /// or expressions (e.g. repeat counts), and also used to define
1297 /// explicit discriminant values for enum variants.
1298 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Debug)]
1299 pub struct AnonConst {
1306 #[derive(Clone, RustcEncodable, RustcDecodable)]
1311 pub attrs: ThinVec<Attribute>,
1316 pub fn precedence(&self) -> ExprPrecedence {
1318 ExprKind::Box(_) => ExprPrecedence::Box,
1319 ExprKind::Array(_) => ExprPrecedence::Array,
1320 ExprKind::Call(..) => ExprPrecedence::Call,
1321 ExprKind::MethodCall(..) => ExprPrecedence::MethodCall,
1322 ExprKind::Tup(_) => ExprPrecedence::Tup,
1323 ExprKind::Binary(op, ..) => ExprPrecedence::Binary(op.node.into()),
1324 ExprKind::Unary(..) => ExprPrecedence::Unary,
1325 ExprKind::Lit(_) => ExprPrecedence::Lit,
1326 ExprKind::Type(..) | ExprKind::Cast(..) => ExprPrecedence::Cast,
1327 ExprKind::If(..) => ExprPrecedence::If,
1328 ExprKind::While(..) => ExprPrecedence::While,
1329 ExprKind::Loop(..) => ExprPrecedence::Loop,
1330 ExprKind::Match(..) => ExprPrecedence::Match,
1331 ExprKind::Closure(..) => ExprPrecedence::Closure,
1332 ExprKind::Block(..) => ExprPrecedence::Block,
1333 ExprKind::Assign(..) => ExprPrecedence::Assign,
1334 ExprKind::AssignOp(..) => ExprPrecedence::AssignOp,
1335 ExprKind::Field(..) => ExprPrecedence::Field,
1336 ExprKind::Index(..) => ExprPrecedence::Index,
1337 ExprKind::Path(..) => ExprPrecedence::Path,
1338 ExprKind::AddrOf(..) => ExprPrecedence::AddrOf,
1339 ExprKind::Break(..) => ExprPrecedence::Break,
1340 ExprKind::Continue(..) => ExprPrecedence::Continue,
1341 ExprKind::Ret(..) => ExprPrecedence::Ret,
1342 ExprKind::InlineAsm(..) => ExprPrecedence::InlineAsm,
1343 ExprKind::Struct(..) => ExprPrecedence::Struct,
1344 ExprKind::Repeat(..) => ExprPrecedence::Repeat,
1345 ExprKind::Yield(..) => ExprPrecedence::Yield,
1350 impl fmt::Debug for Expr {
1351 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1352 write!(f, "expr({}: {})", self.id,
1353 print::to_string(print::NO_ANN, |s| s.print_expr(self)))
1357 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1359 /// A `box x` expression.
1361 /// An array (`[a, b, c, d]`)
1362 Array(HirVec<Expr>),
1365 /// The first field resolves to the function itself (usually an `ExprKind::Path`),
1366 /// and the second field is the list of arguments.
1367 /// This also represents calling the constructor of
1368 /// tuple-like ADTs such as tuple structs and enum variants.
1369 Call(P<Expr>, HirVec<Expr>),
1370 /// A method call (`x.foo::<'static, Bar, Baz>(a, b, c, d)`)
1372 /// The `PathSegment`/`Span` represent the method name and its generic arguments
1373 /// (within the angle brackets).
1374 /// The first element of the vector of `Expr`s is the expression that evaluates
1375 /// to the object on which the method is being called on (the receiver),
1376 /// and the remaining elements are the rest of the arguments.
1377 /// Thus, `x.foo::<Bar, Baz>(a, b, c, d)` is represented as
1378 /// `ExprKind::MethodCall(PathSegment { foo, [Bar, Baz] }, [x, a, b, c, d])`.
1379 MethodCall(PathSegment, Span, HirVec<Expr>),
1380 /// A tuple (`(a, b, c ,d)`)
1382 /// A binary operation (For example: `a + b`, `a * b`)
1383 Binary(BinOp, P<Expr>, P<Expr>),
1384 /// A unary operation (For example: `!x`, `*x`)
1385 Unary(UnOp, P<Expr>),
1386 /// A literal (For example: `1`, `"foo"`)
1388 /// A cast (`foo as f64`)
1389 Cast(P<Expr>, P<Ty>),
1390 Type(P<Expr>, P<Ty>),
1391 /// An `if` block, with an optional else block
1393 /// `if expr { expr } else { expr }`
1394 If(P<Expr>, P<Expr>, Option<P<Expr>>),
1395 /// A while loop, with an optional label
1397 /// `'label: while expr { block }`
1398 While(P<Expr>, P<Block>, Option<Label>),
1399 /// Conditionless loop (can be exited with break, continue, or return)
1401 /// `'label: loop { block }`
1402 Loop(P<Block>, Option<Label>, LoopSource),
1403 /// A `match` block, with a source that indicates whether or not it is
1404 /// the result of a desugaring, and if so, which kind.
1405 Match(P<Expr>, HirVec<Arm>, MatchSource),
1406 /// A closure (for example, `move |a, b, c| {a + b + c}`).
1408 /// The final span is the span of the argument block `|...|`
1410 /// This may also be a generator literal, indicated by the final boolean,
1411 /// in that case there is an GeneratorClause.
1412 Closure(CaptureClause, P<FnDecl>, BodyId, Span, Option<GeneratorMovability>),
1413 /// A block (`'label: { ... }`)
1414 Block(P<Block>, Option<Label>),
1416 /// An assignment (`a = foo()`)
1417 Assign(P<Expr>, P<Expr>),
1418 /// An assignment with an operator
1420 /// For example, `a += 1`.
1421 AssignOp(BinOp, P<Expr>, P<Expr>),
1422 /// Access of a named (`obj.foo`) or unnamed (`obj.0`) struct or tuple field
1423 Field(P<Expr>, Ident),
1424 /// An indexing operation (`foo[2]`)
1425 Index(P<Expr>, P<Expr>),
1427 /// Path to a definition, possibly containing lifetime or type parameters.
1430 /// A referencing operation (`&a` or `&mut a`)
1431 AddrOf(Mutability, P<Expr>),
1432 /// A `break`, with an optional label to break
1433 Break(Destination, Option<P<Expr>>),
1434 /// A `continue`, with an optional label
1435 Continue(Destination),
1436 /// A `return`, with an optional value to be returned
1437 Ret(Option<P<Expr>>),
1439 /// Inline assembly (from `asm!`), with its outputs and inputs.
1440 InlineAsm(P<InlineAsm>, HirVec<Expr>, HirVec<Expr>),
1442 /// A struct or struct-like variant literal expression.
1444 /// For example, `Foo {x: 1, y: 2}`, or
1445 /// `Foo {x: 1, .. base}`, where `base` is the `Option<Expr>`.
1446 Struct(QPath, HirVec<Field>, Option<P<Expr>>),
1448 /// An array literal constructed from one repeated element.
1450 /// For example, `[1; 5]`. The first expression is the element
1451 /// to be repeated; the second is the number of times to repeat it.
1452 Repeat(P<Expr>, AnonConst),
1454 /// A suspension point for generators. This is `yield <expr>` in Rust.
1458 /// Optionally `Self`-qualified value/type path or associated extension.
1459 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1461 /// Path to a definition, optionally "fully-qualified" with a `Self`
1462 /// type, if the path points to an associated item in a trait.
1464 /// E.g. an unqualified path like `Clone::clone` has `None` for `Self`,
1465 /// while `<Vec<T> as Clone>::clone` has `Some(Vec<T>)` for `Self`,
1466 /// even though they both have the same two-segment `Clone::clone` `Path`.
1467 Resolved(Option<P<Ty>>, P<Path>),
1469 /// Type-related paths, e.g. `<T>::default` or `<T>::Output`.
1470 /// Will be resolved by type-checking to an associated item.
1472 /// UFCS source paths can desugar into this, with `Vec::new` turning into
1473 /// `<Vec>::new`, and `T::X::Y::method` into `<<<T>::X>::Y>::method`,
1474 /// the `X` and `Y` nodes each being a `TyKind::Path(QPath::TypeRelative(..))`.
1475 TypeRelative(P<Ty>, P<PathSegment>)
1478 /// Hints at the original code for a let statement
1479 #[derive(Clone, RustcEncodable, RustcDecodable, Debug, Copy)]
1480 pub enum LocalSource {
1481 /// A `match _ { .. }`
1483 /// A desugared `for _ in _ { .. }` loop
1487 /// Hints at the original code for a `match _ { .. }`
1488 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
1489 pub enum MatchSource {
1490 /// A `match _ { .. }`
1492 /// An `if let _ = _ { .. }` (optionally with `else { .. }`)
1494 contains_else_clause: bool,
1496 /// A `while let _ = _ { .. }` (which was desugared to a
1497 /// `loop { match _ { .. } }`)
1499 /// A desugared `for _ in _ { .. }` loop
1501 /// A desugared `?` operator
1505 /// The loop type that yielded an ExprKind::Loop
1506 #[derive(Clone, PartialEq, RustcEncodable, RustcDecodable, Debug, Copy)]
1507 pub enum LoopSource {
1508 /// A `loop { .. }` loop
1510 /// A `while let _ = _ { .. }` loop
1512 /// A `for _ in _ { .. }` loop
1516 #[derive(Clone, RustcEncodable, RustcDecodable, Debug, Copy)]
1517 pub enum LoopIdError {
1519 UnlabeledCfInWhileCondition,
1523 impl fmt::Display for LoopIdError {
1524 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1525 fmt::Display::fmt(match *self {
1526 LoopIdError::OutsideLoopScope => "not inside loop scope",
1527 LoopIdError::UnlabeledCfInWhileCondition =>
1528 "unlabeled control flow (break or continue) in while condition",
1529 LoopIdError::UnresolvedLabel => "label not found",
1534 #[derive(Clone, RustcEncodable, RustcDecodable, Debug, Copy)]
1535 pub struct Destination {
1536 // This is `Some(_)` iff there is an explicit user-specified `label
1537 pub label: Option<Label>,
1539 // These errors are caught and then reported during the diagnostics pass in
1540 // librustc_passes/loops.rs
1541 pub target_id: Result<NodeId, LoopIdError>,
1544 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
1545 pub enum GeneratorMovability {
1550 #[derive(Clone, RustcEncodable, RustcDecodable, Debug, Copy)]
1551 pub enum CaptureClause {
1556 // NB: If you change this, you'll probably want to change the corresponding
1557 // type structure in middle/ty.rs as well.
1558 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1561 pub mutbl: Mutability,
1564 /// Represents a method's signature in a trait declaration or implementation.
1565 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1566 pub struct MethodSig {
1567 pub header: FnHeader,
1568 pub decl: P<FnDecl>,
1571 // The bodies for items are stored "out of line", in a separate
1572 // hashmap in the `Crate`. Here we just record the node-id of the item
1573 // so it can fetched later.
1574 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable, Debug)]
1575 pub struct TraitItemId {
1576 pub node_id: NodeId,
1579 /// Represents an item declaration within a trait declaration,
1580 /// possibly including a default implementation. A trait item is
1581 /// either required (meaning it doesn't have an implementation, just a
1582 /// signature) or provided (meaning it has a default implementation).
1583 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1584 pub struct TraitItem {
1588 pub attrs: HirVec<Attribute>,
1589 pub generics: Generics,
1590 pub node: TraitItemKind,
1594 /// A trait method's body (or just argument names).
1595 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1596 pub enum TraitMethod {
1597 /// No default body in the trait, just a signature.
1598 Required(HirVec<Ident>),
1600 /// Both signature and body are provided in the trait.
1604 /// Represents a trait method or associated constant or type
1605 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1606 pub enum TraitItemKind {
1607 /// An associated constant with an optional value (otherwise `impl`s
1608 /// must contain a value)
1609 Const(P<Ty>, Option<BodyId>),
1610 /// A method with an optional body
1611 Method(MethodSig, TraitMethod),
1612 /// An associated type with (possibly empty) bounds and optional concrete
1614 Type(GenericBounds, Option<P<Ty>>),
1617 // The bodies for items are stored "out of line", in a separate
1618 // hashmap in the `Crate`. Here we just record the node-id of the item
1619 // so it can fetched later.
1620 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable, Debug)]
1621 pub struct ImplItemId {
1622 pub node_id: NodeId,
1625 /// Represents anything within an `impl` block
1626 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1627 pub struct ImplItem {
1631 pub vis: Visibility,
1632 pub defaultness: Defaultness,
1633 pub attrs: HirVec<Attribute>,
1634 pub generics: Generics,
1635 pub node: ImplItemKind,
1639 /// Represents different contents within `impl`s
1640 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1641 pub enum ImplItemKind {
1642 /// An associated constant of the given type, set to the constant result
1643 /// of the expression
1644 Const(P<Ty>, BodyId),
1645 /// A method implementation with the given signature and body
1646 Method(MethodSig, BodyId),
1647 /// An associated type
1649 /// An associated existential type
1650 Existential(GenericBounds),
1653 // Bind a type to an associated type: `A=Foo`.
1654 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1655 pub struct TypeBinding {
1662 #[derive(Clone, RustcEncodable, RustcDecodable)]
1670 impl fmt::Debug for Ty {
1671 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1672 write!(f, "type({})",
1673 print::to_string(print::NO_ANN, |s| s.print_type(self)))
1677 /// Not represented directly in the AST, referred to by name through a ty_path.
1678 #[derive(Clone, PartialEq, Eq, RustcEncodable, RustcDecodable, Hash, Debug, Copy)]
1688 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1689 pub struct BareFnTy {
1690 pub unsafety: Unsafety,
1692 pub generic_params: HirVec<GenericParam>,
1693 pub decl: P<FnDecl>,
1694 pub arg_names: HirVec<Ident>,
1697 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1698 pub struct ExistTy {
1699 pub generics: Generics,
1700 pub bounds: GenericBounds,
1701 pub impl_trait_fn: Option<DefId>,
1704 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1705 /// The different kinds of types recognized by the compiler
1707 /// A variable length slice (`[T]`)
1709 /// A fixed length array (`[T; n]`)
1710 Array(P<Ty>, AnonConst),
1711 /// A raw pointer (`*const T` or `*mut T`)
1713 /// A reference (`&'a T` or `&'a mut T`)
1714 Rptr(Lifetime, MutTy),
1715 /// A bare function (e.g. `fn(usize) -> bool`)
1716 BareFn(P<BareFnTy>),
1717 /// The never type (`!`)
1719 /// A tuple (`(A, B, C, D,...)`)
1721 /// A path to a type definition (`module::module::...::Type`), or an
1722 /// associated type, e.g. `<Vec<T> as Trait>::Type` or `<T>::Target`.
1724 /// Type parameters may be stored in each `PathSegment`.
1726 /// A type definition itself. This is currently only used for the `existential type`
1727 /// item that `impl Trait` in return position desugars to.
1729 /// The generic arg list are the lifetimes (and in the future possibly parameters) that are
1730 /// actually bound on the `impl Trait`.
1731 Def(ItemId, HirVec<GenericArg>),
1732 /// A trait object type `Bound1 + Bound2 + Bound3`
1733 /// where `Bound` is a trait or a lifetime.
1734 TraitObject(HirVec<PolyTraitRef>, Lifetime),
1737 /// TyKind::Infer means the type should be inferred instead of it having been
1738 /// specified. This can appear anywhere in a type.
1740 /// Placeholder for a type that has failed to be defined.
1744 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1745 pub struct InlineAsmOutput {
1746 pub constraint: Symbol,
1748 pub is_indirect: bool,
1751 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1752 pub struct InlineAsm {
1754 pub asm_str_style: StrStyle,
1755 pub outputs: HirVec<InlineAsmOutput>,
1756 pub inputs: HirVec<Symbol>,
1757 pub clobbers: HirVec<Symbol>,
1759 pub alignstack: bool,
1760 pub dialect: AsmDialect,
1761 pub ctxt: SyntaxContext,
1764 /// represents an argument in a function header
1765 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1772 /// Represents the header (not the body) of a function declaration
1773 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1775 pub inputs: HirVec<Ty>,
1776 pub output: FunctionRetTy,
1778 /// True if this function has an `self`, `&self` or `&mut self` receiver
1779 /// (but not a `self: Xxx` one).
1780 pub has_implicit_self: bool,
1783 /// Is the trait definition an auto trait?
1784 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
1790 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable, Debug)]
1796 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable, Hash, Debug)]
1802 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
1803 pub enum Constness {
1808 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
1809 pub enum Defaultness {
1810 Default { has_value: bool },
1815 pub fn has_value(&self) -> bool {
1817 Defaultness::Default { has_value, .. } => has_value,
1818 Defaultness::Final => true,
1822 pub fn is_final(&self) -> bool {
1823 *self == Defaultness::Final
1826 pub fn is_default(&self) -> bool {
1828 Defaultness::Default { .. } => true,
1834 impl fmt::Display for Unsafety {
1835 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1836 fmt::Display::fmt(match *self {
1837 Unsafety::Normal => "normal",
1838 Unsafety::Unsafe => "unsafe",
1844 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable)]
1845 pub enum ImplPolarity {
1846 /// `impl Trait for Type`
1848 /// `impl !Trait for Type`
1852 impl fmt::Debug for ImplPolarity {
1853 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1855 ImplPolarity::Positive => "positive".fmt(f),
1856 ImplPolarity::Negative => "negative".fmt(f),
1862 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1863 pub enum FunctionRetTy {
1864 /// Return type is not specified.
1866 /// Functions default to `()` and
1867 /// closures default to inference. Span points to where return
1868 /// type would be inserted.
1869 DefaultReturn(Span),
1874 impl FunctionRetTy {
1875 pub fn span(&self) -> Span {
1877 DefaultReturn(span) => span,
1878 Return(ref ty) => ty.span,
1883 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1885 /// A span from the first token past `{` to the last token until `}`.
1886 /// For `mod foo;`, the inner span ranges from the first token
1887 /// to the last token in the external file.
1889 pub item_ids: HirVec<ItemId>,
1892 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1893 pub struct ForeignMod {
1895 pub items: HirVec<ForeignItem>,
1898 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1899 pub struct GlobalAsm {
1901 pub ctxt: SyntaxContext,
1904 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1905 pub struct EnumDef {
1906 pub variants: HirVec<Variant>,
1909 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1910 pub struct VariantKind {
1912 pub attrs: HirVec<Attribute>,
1913 pub data: VariantData,
1914 /// Explicit discriminant, eg `Foo = 1`
1915 pub disr_expr: Option<AnonConst>,
1918 pub type Variant = Spanned<VariantKind>;
1920 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
1922 /// One import, e.g. `use foo::bar` or `use foo::bar as baz`.
1923 /// Also produced for each element of a list `use`, e.g.
1924 // `use foo::{a, b}` lowers to `use foo::a; use foo::b;`.
1927 /// Glob import, e.g. `use foo::*`.
1930 /// Degenerate list import, e.g. `use foo::{a, b}` produces
1931 /// an additional `use foo::{}` for performing checks such as
1932 /// unstable feature gating. May be removed in the future.
1936 /// TraitRef's appear in impls.
1938 /// resolve maps each TraitRef's ref_id to its defining trait; that's all
1939 /// that the ref_id is for. Note that ref_id's value is not the NodeId of the
1940 /// trait being referred to but just a unique NodeId that serves as a key
1941 /// within the DefMap.
1942 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1943 pub struct TraitRef {
1946 pub hir_ref_id: HirId,
1949 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1950 pub struct PolyTraitRef {
1951 /// The `'a` in `<'a> Foo<&'a T>`
1952 pub bound_generic_params: HirVec<GenericParam>,
1954 /// The `Foo<&'a T>` in `<'a> Foo<&'a T>`
1955 pub trait_ref: TraitRef,
1960 pub type Visibility = Spanned<VisibilityKind>;
1962 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1963 pub enum VisibilityKind {
1966 Restricted { path: P<Path>, id: NodeId, hir_id: HirId },
1970 impl VisibilityKind {
1971 pub fn is_pub(&self) -> bool {
1973 VisibilityKind::Public => true,
1978 pub fn is_pub_restricted(&self) -> bool {
1980 VisibilityKind::Public |
1981 VisibilityKind::Inherited => false,
1982 VisibilityKind::Crate(..) |
1983 VisibilityKind::Restricted { .. } => true,
1988 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
1989 pub struct StructField {
1992 pub vis: Visibility,
1995 pub attrs: HirVec<Attribute>,
1999 // Still necessary in couple of places
2000 pub fn is_positional(&self) -> bool {
2001 let first = self.ident.as_str().as_bytes()[0];
2002 first >= b'0' && first <= b'9'
2006 /// Fields and Ids of enum variants and structs
2008 /// For enum variants: `NodeId` represents both an Id of the variant itself (relevant for all
2009 /// variant kinds) and an Id of the variant's constructor (not relevant for `Struct`-variants).
2010 /// One shared Id can be successfully used for these two purposes.
2011 /// Id of the whole enum lives in `Item`.
2013 /// For structs: `NodeId` represents an Id of the structure's constructor, so it is not actually
2014 /// used for `Struct`-structs (but still presents). Structures don't have an analogue of "Id of
2015 /// the variant itself" from enum variants.
2016 /// Id of the whole struct lives in `Item`.
2017 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2018 pub enum VariantData {
2019 Struct(HirVec<StructField>, NodeId),
2020 Tuple(HirVec<StructField>, NodeId),
2025 pub fn fields(&self) -> &[StructField] {
2027 VariantData::Struct(ref fields, _) | VariantData::Tuple(ref fields, _) => fields,
2031 pub fn id(&self) -> NodeId {
2033 VariantData::Struct(_, id) | VariantData::Tuple(_, id) | VariantData::Unit(id) => id,
2036 pub fn is_struct(&self) -> bool {
2037 if let VariantData::Struct(..) = *self {
2043 pub fn is_tuple(&self) -> bool {
2044 if let VariantData::Tuple(..) = *self {
2050 pub fn is_unit(&self) -> bool {
2051 if let VariantData::Unit(..) = *self {
2059 // The bodies for items are stored "out of line", in a separate
2060 // hashmap in the `Crate`. Here we just record the node-id of the item
2061 // so it can fetched later.
2062 #[derive(Copy, Clone, RustcEncodable, RustcDecodable, Debug)]
2069 /// The name might be a dummy name in case of anonymous items
2070 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2075 pub attrs: HirVec<Attribute>,
2077 pub vis: Visibility,
2081 #[derive(Clone, Copy, RustcEncodable, RustcDecodable, Debug)]
2082 pub struct FnHeader {
2083 pub unsafety: Unsafety,
2084 pub constness: Constness,
2085 pub asyncness: IsAsync,
2089 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2091 /// An `extern crate` item, with optional *original* crate name if the crate was renamed.
2093 /// E.g. `extern crate foo` or `extern crate foo_bar as foo`
2094 ExternCrate(Option<Name>),
2096 /// `use foo::bar::*;` or `use foo::bar::baz as quux;`
2100 /// `use foo::bar::baz;` (with `as baz` implicitly on the right)
2101 Use(P<Path>, UseKind),
2104 Static(P<Ty>, Mutability, BodyId),
2106 Const(P<Ty>, BodyId),
2107 /// A function declaration
2108 Fn(P<FnDecl>, FnHeader, Generics, BodyId),
2111 /// An external module
2112 ForeignMod(ForeignMod),
2113 /// Module-level inline assembly (from global_asm!)
2114 GlobalAsm(P<GlobalAsm>),
2115 /// A type alias, e.g. `type Foo = Bar<u8>`
2116 Ty(P<Ty>, Generics),
2117 /// An existential type definition, e.g. `existential type Foo: Bar;`
2118 Existential(ExistTy),
2119 /// An enum definition, e.g. `enum Foo<A, B> {C<A>, D<B>}`
2120 Enum(EnumDef, Generics),
2121 /// A struct definition, e.g. `struct Foo<A> {x: A}`
2122 Struct(VariantData, Generics),
2123 /// A union definition, e.g. `union Foo<A, B> {x: A, y: B}`
2124 Union(VariantData, Generics),
2125 /// Represents a Trait Declaration
2126 Trait(IsAuto, Unsafety, Generics, GenericBounds, HirVec<TraitItemRef>),
2127 /// Represents a Trait Alias Declaration
2128 TraitAlias(Generics, GenericBounds),
2130 /// An implementation, eg `impl<A> Trait for Foo { .. }`
2135 Option<TraitRef>, // (optional) trait this impl implements
2137 HirVec<ImplItemRef>),
2141 pub fn descriptive_variant(&self) -> &str {
2143 ItemKind::ExternCrate(..) => "extern crate",
2144 ItemKind::Use(..) => "use",
2145 ItemKind::Static(..) => "static item",
2146 ItemKind::Const(..) => "constant item",
2147 ItemKind::Fn(..) => "function",
2148 ItemKind::Mod(..) => "module",
2149 ItemKind::ForeignMod(..) => "foreign module",
2150 ItemKind::GlobalAsm(..) => "global asm",
2151 ItemKind::Ty(..) => "type alias",
2152 ItemKind::Existential(..) => "existential type",
2153 ItemKind::Enum(..) => "enum",
2154 ItemKind::Struct(..) => "struct",
2155 ItemKind::Union(..) => "union",
2156 ItemKind::Trait(..) => "trait",
2157 ItemKind::TraitAlias(..) => "trait alias",
2158 ItemKind::Impl(..) => "item",
2162 pub fn adt_kind(&self) -> Option<AdtKind> {
2164 ItemKind::Struct(..) => Some(AdtKind::Struct),
2165 ItemKind::Union(..) => Some(AdtKind::Union),
2166 ItemKind::Enum(..) => Some(AdtKind::Enum),
2171 pub fn generics(&self) -> Option<&Generics> {
2173 ItemKind::Fn(_, _, ref generics, _) |
2174 ItemKind::Ty(_, ref generics) |
2175 ItemKind::Existential(ExistTy { ref generics, impl_trait_fn: None, .. }) |
2176 ItemKind::Enum(_, ref generics) |
2177 ItemKind::Struct(_, ref generics) |
2178 ItemKind::Union(_, ref generics) |
2179 ItemKind::Trait(_, _, ref generics, _, _) |
2180 ItemKind::Impl(_, _, _, ref generics, _, _, _)=> generics,
2186 /// A reference from an trait to one of its associated items. This
2187 /// contains the item's id, naturally, but also the item's name and
2188 /// some other high-level details (like whether it is an associated
2189 /// type or method, and whether it is public). This allows other
2190 /// passes to find the impl they want without loading the id (which
2191 /// means fewer edges in the incremental compilation graph).
2192 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2193 pub struct TraitItemRef {
2194 pub id: TraitItemId,
2196 pub kind: AssociatedItemKind,
2198 pub defaultness: Defaultness,
2201 /// A reference from an impl to one of its associated items. This
2202 /// contains the item's id, naturally, but also the item's name and
2203 /// some other high-level details (like whether it is an associated
2204 /// type or method, and whether it is public). This allows other
2205 /// passes to find the impl they want without loading the id (which
2206 /// means fewer edges in the incremental compilation graph).
2207 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2208 pub struct ImplItemRef {
2211 pub kind: AssociatedItemKind,
2213 pub vis: Visibility,
2214 pub defaultness: Defaultness,
2217 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, Debug)]
2218 pub enum AssociatedItemKind {
2220 Method { has_self: bool },
2225 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2226 pub struct ForeignItem {
2228 pub attrs: HirVec<Attribute>,
2229 pub node: ForeignItemKind,
2232 pub vis: Visibility,
2235 /// An item within an `extern` block
2236 #[derive(Clone, RustcEncodable, RustcDecodable, Debug)]
2237 pub enum ForeignItemKind {
2238 /// A foreign function
2239 Fn(P<FnDecl>, HirVec<Ident>, Generics),
2240 /// A foreign static item (`static ext: u8`), with optional mutability
2241 /// (the boolean is true when mutable)
2242 Static(P<Ty>, bool),
2247 impl ForeignItemKind {
2248 pub fn descriptive_variant(&self) -> &str {
2250 ForeignItemKind::Fn(..) => "foreign function",
2251 ForeignItemKind::Static(..) => "foreign static item",
2252 ForeignItemKind::Type => "foreign type",
2257 /// A free variable referred to in a function.
2258 #[derive(Debug, Copy, Clone, RustcEncodable, RustcDecodable)]
2259 pub struct Freevar {
2260 /// The variable being accessed free.
2263 // First span where it is accessed (there can be multiple).
2268 pub fn var_id(&self) -> NodeId {
2270 Def::Local(id) | Def::Upvar(id, ..) => id,
2271 _ => bug!("Freevar::var_id: bad def ({:?})", self.def)
2276 pub type FreevarMap = NodeMap<Vec<Freevar>>;
2278 pub type CaptureModeMap = NodeMap<CaptureClause>;
2280 #[derive(Clone, Debug)]
2281 pub struct TraitCandidate {
2283 pub import_id: Option<NodeId>,
2286 // Trait method resolution
2287 pub type TraitMap = NodeMap<Vec<TraitCandidate>>;
2289 // Map from the NodeId of a glob import to a list of items which are actually
2291 pub type GlobMap = NodeMap<FxHashSet<Name>>;
2294 pub fn provide(providers: &mut Providers<'_>) {
2295 providers.describe_def = map::describe_def;
2298 #[derive(Clone, RustcEncodable, RustcDecodable)]
2299 pub struct CodegenFnAttrs {
2300 pub flags: CodegenFnAttrFlags,
2301 /// Parsed representation of the `#[inline]` attribute
2302 pub inline: InlineAttr,
2303 /// The `#[export_name = "..."]` attribute, indicating a custom symbol a
2304 /// function should be exported under
2305 pub export_name: Option<Symbol>,
2306 /// The `#[link_name = "..."]` attribute, indicating a custom symbol an
2307 /// imported function should be imported as. Note that `export_name`
2308 /// probably isn't set when this is set, this is for foreign items while
2309 /// `#[export_name]` is for Rust-defined functions.
2310 pub link_name: Option<Symbol>,
2311 /// The `#[target_feature(enable = "...")]` attribute and the enabled
2312 /// features (only enabled features are supported right now).
2313 pub target_features: Vec<Symbol>,
2314 /// The `#[linkage = "..."]` attribute and the value we found.
2315 pub linkage: Option<Linkage>,
2316 /// The `#[link_section = "..."]` attribute, or what executable section this
2317 /// should be placed in.
2318 pub link_section: Option<Symbol>,
2322 #[derive(RustcEncodable, RustcDecodable)]
2323 pub struct CodegenFnAttrFlags: u32 {
2324 /// #[cold], a hint to LLVM that this function, when called, is never on
2326 const COLD = 1 << 0;
2327 /// #[allocator], a hint to LLVM that the pointer returned from this
2328 /// function is never null
2329 const ALLOCATOR = 1 << 1;
2330 /// #[unwind], an indicator that this function may unwind despite what
2331 /// its ABI signature may otherwise imply
2332 const UNWIND = 1 << 2;
2333 /// #[rust_allocator_nounwind], an indicator that an imported FFI
2334 /// function will never unwind. Probably obsolete by recent changes with
2335 /// #[unwind], but hasn't been removed/migrated yet
2336 const RUSTC_ALLOCATOR_NOUNWIND = 1 << 3;
2337 /// #[naked], indicates to LLVM that no function prologue/epilogue
2338 /// should be generated
2339 const NAKED = 1 << 4;
2340 /// #[no_mangle], the function's name should be the same as its symbol
2341 const NO_MANGLE = 1 << 5;
2342 /// #[rustc_std_internal_symbol], and indicator that this symbol is a
2343 /// "weird symbol" for the standard library in that it has slightly
2344 /// different linkage, visibility, and reachability rules.
2345 const RUSTC_STD_INTERNAL_SYMBOL = 1 << 6;
2346 /// #[no_debug], indicates that no debugging information should be
2347 /// generated for this function by LLVM
2348 const NO_DEBUG = 1 << 7;
2349 /// #[thread_local], indicates a static is actually a thread local
2351 const THREAD_LOCAL = 1 << 8;
2352 /// #[used], indicates that LLVM can't eliminate this function (but the
2354 const USED = 1 << 9;
2358 impl CodegenFnAttrs {
2359 pub fn new() -> CodegenFnAttrs {
2361 flags: CodegenFnAttrFlags::empty(),
2362 inline: InlineAttr::None,
2365 target_features: vec![],
2371 /// True if `#[inline]` or `#[inline(always)]` is present.
2372 pub fn requests_inline(&self) -> bool {
2374 InlineAttr::Hint | InlineAttr::Always => true,
2375 InlineAttr::None | InlineAttr::Never => false,
2379 /// True if `#[no_mangle]` or `#[export_name(...)]` is present.
2380 pub fn contains_extern_indicator(&self) -> bool {
2381 self.flags.contains(CodegenFnAttrFlags::NO_MANGLE) || self.export_name.is_some()
2385 #[derive(Copy, Clone, Debug)]
2386 pub enum Node<'hir> {
2388 ForeignItem(&'hir ForeignItem),
2389 TraitItem(&'hir TraitItem),
2390 ImplItem(&'hir ImplItem),
2391 Variant(&'hir Variant),
2392 Field(&'hir StructField),
2393 AnonConst(&'hir AnonConst),
2397 TraitRef(&'hir TraitRef),
2402 MacroDef(&'hir MacroDef),
2404 /// StructCtor represents a tuple struct.
2405 StructCtor(&'hir VariantData),
2407 Lifetime(&'hir Lifetime),
2408 GenericParam(&'hir GenericParam),
2409 Visibility(&'hir Visibility),