1 //! This module is used to store stuff from Rust's AST in a more convenient
2 //! manner (and with prettier names) before cleaning.
3 pub use self::StructType::*;
5 use rustc_span::hygiene::MacroKind;
6 use rustc_span::{self, Span};
11 use rustc_hir::def_id::CrateNum;
13 pub struct Module<'hir> {
14 pub name: Option<Name>,
15 pub attrs: &'hir [ast::Attribute],
16 pub where_outer: Span,
17 pub where_inner: Span,
18 pub extern_crates: Vec<ExternCrate<'hir>>,
19 pub imports: Vec<Import<'hir>>,
20 pub structs: Vec<Struct<'hir>>,
21 pub unions: Vec<Union<'hir>>,
22 pub enums: Vec<Enum<'hir>>,
23 pub fns: Vec<Function<'hir>>,
24 pub mods: Vec<Module<'hir>>,
26 pub typedefs: Vec<Typedef<'hir>>,
27 pub opaque_tys: Vec<OpaqueTy<'hir>>,
28 pub statics: Vec<Static<'hir>>,
29 pub constants: Vec<Constant<'hir>>,
30 pub traits: Vec<Trait<'hir>>,
31 pub vis: &'hir hir::Visibility<'hir>,
32 pub impls: Vec<Impl<'hir>>,
33 pub foreigns: Vec<ForeignItem<'hir>>,
34 pub macros: Vec<Macro<'hir>>,
35 pub proc_macros: Vec<ProcMacro<'hir>>,
36 pub trait_aliases: Vec<TraitAlias<'hir>>,
43 attrs: &'hir [ast::Attribute],
44 vis: &'hir hir::Visibility<'hir>,
48 id: hir::CRATE_HIR_ID,
50 where_outer: rustc_span::DUMMY_SP,
51 where_inner: rustc_span::DUMMY_SP,
53 extern_crates: Vec::new(),
61 opaque_tys: Vec::new(),
63 constants: Vec::new(),
68 proc_macros: Vec::new(),
69 trait_aliases: Vec::new(),
75 #[derive(Debug, Clone, Copy)]
85 pub struct Struct<'hir> {
86 pub vis: &'hir hir::Visibility<'hir>,
88 pub struct_type: StructType,
90 pub generics: &'hir hir::Generics<'hir>,
91 pub attrs: &'hir [ast::Attribute],
92 pub fields: &'hir [hir::StructField<'hir>],
96 pub struct Union<'hir> {
97 pub vis: &'hir hir::Visibility<'hir>,
99 pub struct_type: StructType,
101 pub generics: &'hir hir::Generics<'hir>,
102 pub attrs: &'hir [ast::Attribute],
103 pub fields: &'hir [hir::StructField<'hir>],
107 pub struct Enum<'hir> {
108 pub vis: &'hir hir::Visibility<'hir>,
109 pub variants: Vec<Variant<'hir>>,
110 pub generics: &'hir hir::Generics<'hir>,
111 pub attrs: &'hir [ast::Attribute],
117 pub struct Variant<'hir> {
120 pub attrs: &'hir [ast::Attribute],
121 pub def: &'hir hir::VariantData<'hir>,
125 pub struct Function<'hir> {
126 pub decl: &'hir hir::FnDecl<'hir>,
127 pub attrs: &'hir [ast::Attribute],
130 pub vis: &'hir hir::Visibility<'hir>,
131 pub header: hir::FnHeader,
133 pub generics: &'hir hir::Generics<'hir>,
134 pub body: hir::BodyId,
137 pub struct Typedef<'hir> {
138 pub ty: &'hir hir::Ty<'hir>,
139 pub gen: &'hir hir::Generics<'hir>,
142 pub attrs: &'hir [ast::Attribute],
144 pub vis: &'hir hir::Visibility<'hir>,
147 pub struct OpaqueTy<'hir> {
148 pub opaque_ty: &'hir hir::OpaqueTy<'hir>,
151 pub attrs: &'hir [ast::Attribute],
153 pub vis: &'hir hir::Visibility<'hir>,
157 pub struct Static<'hir> {
158 pub type_: &'hir hir::Ty<'hir>,
159 pub mutability: hir::Mutability,
160 pub expr: hir::BodyId,
162 pub attrs: &'hir [ast::Attribute],
163 pub vis: &'hir hir::Visibility<'hir>,
168 pub struct Constant<'hir> {
169 pub type_: &'hir hir::Ty<'hir>,
170 pub expr: hir::BodyId,
172 pub attrs: &'hir [ast::Attribute],
173 pub vis: &'hir hir::Visibility<'hir>,
178 pub struct Trait<'hir> {
179 pub is_auto: hir::IsAuto,
180 pub unsafety: hir::Unsafety,
182 pub items: Vec<&'hir hir::TraitItem<'hir>>,
183 pub generics: &'hir hir::Generics<'hir>,
184 pub bounds: &'hir [hir::GenericBound<'hir>],
185 pub attrs: &'hir [ast::Attribute],
188 pub vis: &'hir hir::Visibility<'hir>,
191 pub struct TraitAlias<'hir> {
193 pub generics: &'hir hir::Generics<'hir>,
194 pub bounds: &'hir [hir::GenericBound<'hir>],
195 pub attrs: &'hir [ast::Attribute],
198 pub vis: &'hir hir::Visibility<'hir>,
202 pub struct Impl<'hir> {
203 pub unsafety: hir::Unsafety,
204 pub polarity: hir::ImplPolarity,
205 pub defaultness: hir::Defaultness,
206 pub constness: ast::Constness,
207 pub generics: &'hir hir::Generics<'hir>,
208 pub trait_: &'hir Option<hir::TraitRef<'hir>>,
209 pub for_: &'hir hir::Ty<'hir>,
210 pub items: Vec<&'hir hir::ImplItem<'hir>>,
211 pub attrs: &'hir [ast::Attribute],
213 pub vis: &'hir hir::Visibility<'hir>,
217 pub struct ForeignItem<'hir> {
218 pub vis: &'hir hir::Visibility<'hir>,
221 pub kind: &'hir hir::ForeignItemKind<'hir>,
222 pub attrs: &'hir [ast::Attribute],
226 // For Macro we store the DefId instead of the NodeId, since we also create
227 // these imported macro_rules (which only have a DUMMY_NODE_ID).
228 pub struct Macro<'hir> {
231 pub def_id: hir::def_id::DefId,
232 pub attrs: &'hir [ast::Attribute],
234 pub matchers: Vec<Span>,
235 pub imported_from: Option<Name>,
238 pub struct ExternCrate<'hir> {
241 pub path: Option<String>,
242 pub vis: &'hir hir::Visibility<'hir>,
243 pub attrs: &'hir [ast::Attribute],
247 pub struct Import<'hir> {
250 pub vis: &'hir hir::Visibility<'hir>,
251 pub attrs: &'hir [ast::Attribute],
252 pub path: &'hir hir::Path<'hir>,
257 pub struct ProcMacro<'hir> {
261 pub helpers: Vec<Name>,
262 pub attrs: &'hir [ast::Attribute],
266 pub fn struct_type_from_def(vdata: &hir::VariantData) -> StructType {
268 hir::VariantData::Struct(..) => Plain,
269 hir::VariantData::Tuple(..) => Tuple,
270 hir::VariantData::Unit(..) => Unit,