crates/hir_def/src/item_tree.rs

   1 //! A simplified AST that only contains items.
   2 //!
   3 //! This is the primary IR used throughout `hir_def`. It is the input to the name resolution
   4 //! algorithm, as well as to the queries defined in `adt.rs`, `data.rs`, and most things in
   5 //! `attr.rs`.
   6 //!
   7 //! `ItemTree`s are built per `HirFileId`, from the syntax tree of the parsed file. This means that
   8 //! they are crate-independent: they don't know which `#[cfg]`s are active or which module they
   9 //! belong to, since those concepts don't exist at this level (a single `ItemTree` might be part of
  10 //! multiple crates, or might be included into the same crate twice via `#[path]`).
  11 //!
  12 //! One important purpose of this layer is to provide an "invalidation barrier" for incremental
  13 //! computations: when typing inside an item body, the `ItemTree` of the modified file is typically
  14 //! unaffected, so we don't have to recompute name resolution results or item data (see `data.rs`).
  15 //!
  16 //! The `ItemTree` for the currently open file can be displayed by using the VS Code command
  17 //! "Rust Analyzer: Debug ItemTree".
  18 //!
  19 //! Compared to rustc's architecture, `ItemTree` has properties from both rustc's AST and HIR: many
  20 //! syntax-level Rust features are already desugared to simpler forms in the `ItemTree`, but name
  21 //! resolution has not yet been performed. `ItemTree`s are per-file, while rustc's AST and HIR are
  22 //! per-crate, because we are interested in incrementally computing it.
  23 //!
  24 //! The representation of items in the `ItemTree` should generally mirror the surface syntax: it is
  25 //! usually a bad idea to desugar a syntax-level construct to something that is structurally
  26 //! different here. Name resolution needs to be able to process attributes and expand macros
  27 //! (including attribute macros), and having a 1-to-1 mapping between syntax and the `ItemTree`
  28 //! avoids introducing subtle bugs.
  29 //!
  30 //! In general, any item in the `ItemTree` stores its `AstId`, which allows mapping it back to its
  31 //! surface syntax.
  32
  33 mod lower;
  34 mod pretty;
  35 #[cfg(test)]
  36 mod tests;
  37
  38 use std::{
  39     any::type_name,
  40     fmt::{self, Debug},
  41     hash::{Hash, Hasher},
  42     marker::PhantomData,
  43     ops::{Index, Range},
  44     sync::Arc,
  45 };
  46
  47 use ast::{AstNode, NameOwner, StructKind};
  48 use base_db::CrateId;
  49 use either::Either;
  50 use hir_expand::{
  51     ast_id_map::FileAstId,
  52     hygiene::Hygiene,
  53     name::{name, AsName, Name},
  54     FragmentKind, HirFileId, InFile,
  55 };
  56 use la_arena::{Arena, Idx, RawIdx};
  57 use profile::Count;
  58 use rustc_hash::FxHashMap;
  59 use smallvec::SmallVec;
  60 use syntax::{ast, match_ast, SyntaxKind};
  61
  62 use crate::{
  63     attr::{Attrs, RawAttrs},
  64     db::DefDatabase,
  65     generics::GenericParams,
  66     intern::Interned,
  67     path::{path, AssociatedTypeBinding, GenericArgs, ImportAlias, ModPath, Path, PathKind},
  68     type_ref::{Mutability, TraitRef, TypeBound, TypeRef},
  69     visibility::RawVisibility,
  70 };
  71
  72 #[derive(Copy, Clone, Eq, PartialEq)]
  73 pub struct RawVisibilityId(u32);
  74
  75 impl RawVisibilityId {
  76     pub const PUB: Self = RawVisibilityId(u32::max_value());
  77     pub const PRIV: Self = RawVisibilityId(u32::max_value() - 1);
  78     pub const PUB_CRATE: Self = RawVisibilityId(u32::max_value() - 2);
  79 }
  80
  81 impl fmt::Debug for RawVisibilityId {
  82     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  83         let mut f = f.debug_tuple("RawVisibilityId");
  84         match *self {
  85             Self::PUB => f.field(&"pub"),
  86             Self::PRIV => f.field(&"pub(self)"),
  87             Self::PUB_CRATE => f.field(&"pub(crate)"),
  88             _ => f.field(&self.0),
  89         };
  90         f.finish()
  91     }
  92 }
  93
  94 /// The item tree of a source file.
  95 #[derive(Debug, Default, Eq, PartialEq)]
  96 pub struct ItemTree {
  97     _c: Count<Self>,
  98
  99     top_level: SmallVec<[ModItem; 1]>,
 100     attrs: FxHashMap<AttrOwner, RawAttrs>,
 101
 102     data: Option<Box<ItemTreeData>>,
 103 }
 104
 105 impl ItemTree {
 106     pub(crate) fn file_item_tree_query(db: &dyn DefDatabase, file_id: HirFileId) -> Arc<ItemTree> {
 107         let _p = profile::span("item_tree_query").detail(|| format!("{:?}", file_id));
 108         let syntax = if let Some(node) = db.parse_or_expand(file_id) {
 109             if node.kind() == SyntaxKind::ERROR {
 110                 // FIXME: not 100% sure why these crop up, but return an empty tree to avoid a panic
 111                 return Default::default();
 112             }
 113             node
 114         } else {
 115             return Default::default();
 116         };
 117
 118         let hygiene = Hygiene::new(db.upcast(), file_id);
 119         let ctx = lower::Ctx::new(db, hygiene.clone(), file_id);
 120         let mut top_attrs = None;
 121         let mut item_tree = match_ast! {
 122             match syntax {
 123                 ast::SourceFile(file) => {
 124                     top_attrs = Some(RawAttrs::new(db, &file, &hygiene));
 125                     ctx.lower_module_items(&file)
 126                 },
 127                 ast::MacroItems(items) => {
 128                     ctx.lower_module_items(&items)
 129                 },
 130                 ast::MacroStmts(stmts) => {
 131                     // The produced statements can include items, which should be added as top-level
 132                     // items.
 133                     ctx.lower_macro_stmts(stmts)
 134                 },
 135                 ast::Pat(_pat) => {
 136                     // FIXME: This occurs because macros in pattern position are treated as inner
 137                     // items and expanded during block DefMap computation
 138                     return Default::default();
 139                 },
 140                 ast::Type(ty) => {
 141                     // Types can contain inner items. We return an empty item tree in this case, but
 142                     // still need to collect inner items.
 143                     ctx.lower_inner_items(ty.syntax())
 144                 },
 145                 ast::Expr(e) => {
 146                     // Macros can expand to expressions. We return an empty item tree in this case, but
 147                     // still need to collect inner items.
 148                     ctx.lower_inner_items(e.syntax())
 149                 },
 150                 _ => {
 151                     panic!("cannot create item tree from {:?} {}", syntax, syntax);
 152                 },
 153             }
 154         };
 155
 156         if let Some(attrs) = top_attrs {
 157             item_tree.attrs.insert(AttrOwner::TopLevel, attrs);
 158         }
 159         item_tree.shrink_to_fit();
 160         Arc::new(item_tree)
 161     }
 162
 163     fn shrink_to_fit(&mut self) {
 164         if let Some(data) = &mut self.data {
 165             let ItemTreeData {
 166                 imports,
 167                 extern_crates,
 168                 extern_blocks,
 169                 functions,
 170                 params,
 171                 structs,
 172                 fields,
 173                 unions,
 174                 enums,
 175                 variants,
 176                 consts,
 177                 statics,
 178                 traits,
 179                 impls,
 180                 type_aliases,
 181                 mods,
 182                 macro_calls,
 183                 macro_rules,
 184                 macro_defs,
 185                 vis,
 186                 inner_items,
 187             } = &mut **data;
 188
 189             imports.shrink_to_fit();
 190             extern_crates.shrink_to_fit();
 191             extern_blocks.shrink_to_fit();
 192             functions.shrink_to_fit();
 193             params.shrink_to_fit();
 194             structs.shrink_to_fit();
 195             fields.shrink_to_fit();
 196             unions.shrink_to_fit();
 197             enums.shrink_to_fit();
 198             variants.shrink_to_fit();
 199             consts.shrink_to_fit();
 200             statics.shrink_to_fit();
 201             traits.shrink_to_fit();
 202             impls.shrink_to_fit();
 203             type_aliases.shrink_to_fit();
 204             mods.shrink_to_fit();
 205             macro_calls.shrink_to_fit();
 206             macro_rules.shrink_to_fit();
 207             macro_defs.shrink_to_fit();
 208
 209             vis.arena.shrink_to_fit();
 210
 211             inner_items.shrink_to_fit();
 212         }
 213     }
 214
 215     /// Returns an iterator over all items located at the top level of the `HirFileId` this
 216     /// `ItemTree` was created from.
 217     pub fn top_level_items(&self) -> &[ModItem] {
 218         &self.top_level
 219     }
 220
 221     /// Returns the inner attributes of the source file.
 222     pub fn top_level_attrs(&self, db: &dyn DefDatabase, krate: CrateId) -> Attrs {
 223         self.attrs.get(&AttrOwner::TopLevel).unwrap_or(&RawAttrs::EMPTY).clone().filter(db, krate)
 224     }
 225
 226     pub(crate) fn raw_attrs(&self, of: AttrOwner) -> &RawAttrs {
 227         self.attrs.get(&of).unwrap_or(&RawAttrs::EMPTY)
 228     }
 229
 230     pub fn attrs(&self, db: &dyn DefDatabase, krate: CrateId, of: AttrOwner) -> Attrs {
 231         self.raw_attrs(of).clone().filter(db, krate)
 232     }
 233
 234     pub fn inner_items_of_block(&self, block: FileAstId<ast::BlockExpr>) -> &[ModItem] {
 235         match &self.data {
 236             Some(data) => data.inner_items.get(&block).map(|it| &**it).unwrap_or(&[]),
 237             None => &[],
 238         }
 239     }
 240
 241     pub fn pretty_print(&self) -> String {
 242         pretty::print_item_tree(self)
 243     }
 244
 245     fn data(&self) -> &ItemTreeData {
 246         self.data.as_ref().expect("attempted to access data of empty ItemTree")
 247     }
 248
 249     fn data_mut(&mut self) -> &mut ItemTreeData {
 250         self.data.get_or_insert_with(Box::default)
 251     }
 252 }
 253
 254 #[derive(Default, Debug, Eq, PartialEq)]
 255 struct ItemVisibilities {
 256     arena: Arena<RawVisibility>,
 257 }
 258
 259 impl ItemVisibilities {
 260     fn alloc(&mut self, vis: RawVisibility) -> RawVisibilityId {
 261         match &vis {
 262             RawVisibility::Public => RawVisibilityId::PUB,
 263             RawVisibility::Module(path) if path.segments().is_empty() => match &path.kind {
 264                 PathKind::Super(0) => RawVisibilityId::PRIV,
 265                 PathKind::Crate => RawVisibilityId::PUB_CRATE,
 266                 _ => RawVisibilityId(self.arena.alloc(vis).into_raw().into()),
 267             },
 268             _ => RawVisibilityId(self.arena.alloc(vis).into_raw().into()),
 269         }
 270     }
 271 }
 272
 273 static VIS_PUB: RawVisibility = RawVisibility::Public;
 274 static VIS_PRIV: RawVisibility = RawVisibility::Module(ModPath::from_kind(PathKind::Super(0)));
 275 static VIS_PUB_CRATE: RawVisibility = RawVisibility::Module(ModPath::from_kind(PathKind::Crate));
 276
 277 #[derive(Default, Debug, Eq, PartialEq)]
 278 struct ItemTreeData {
 279     imports: Arena<Import>,
 280     extern_crates: Arena<ExternCrate>,
 281     extern_blocks: Arena<ExternBlock>,
 282     functions: Arena<Function>,
 283     params: Arena<Param>,
 284     structs: Arena<Struct>,
 285     fields: Arena<Field>,
 286     unions: Arena<Union>,
 287     enums: Arena<Enum>,
 288     variants: Arena<Variant>,
 289     consts: Arena<Const>,
 290     statics: Arena<Static>,
 291     traits: Arena<Trait>,
 292     impls: Arena<Impl>,
 293     type_aliases: Arena<TypeAlias>,
 294     mods: Arena<Mod>,
 295     macro_calls: Arena<MacroCall>,
 296     macro_rules: Arena<MacroRules>,
 297     macro_defs: Arena<MacroDef>,
 298
 299     vis: ItemVisibilities,
 300
 301     inner_items: FxHashMap<FileAstId<ast::BlockExpr>, SmallVec<[ModItem; 1]>>,
 302 }
 303
 304 #[derive(Debug, Eq, PartialEq, Hash)]
 305 pub enum AttrOwner {
 306     /// Attributes on an item.
 307     ModItem(ModItem),
 308     /// Inner attributes of the source file.
 309     TopLevel,
 310
 311     Variant(Idx<Variant>),
 312     Field(Idx<Field>),
 313     Param(Idx<Param>),
 314 }
 315
 316 macro_rules! from_attrs {
 317     ( $( $var:ident($t:ty) ),+ ) => {
 318         $(
 319             impl From<$t> for AttrOwner {
 320                 fn from(t: $t) -> AttrOwner {
 321                     AttrOwner::$var(t)
 322                 }
 323             }
 324         )+
 325     };
 326 }
 327
 328 from_attrs!(ModItem(ModItem), Variant(Idx<Variant>), Field(Idx<Field>), Param(Idx<Param>));
 329
 330 /// Trait implemented by all item nodes in the item tree.
 331 pub trait ItemTreeNode: Clone {
 332     type Source: AstNode + Into<ast::Item>;
 333
 334     fn ast_id(&self) -> FileAstId<Self::Source>;
 335
 336     /// Looks up an instance of `Self` in an item tree.
 337     fn lookup(tree: &ItemTree, index: Idx<Self>) -> &Self;
 338
 339     /// Downcasts a `ModItem` to a `FileItemTreeId` specific to this type.
 340     fn id_from_mod_item(mod_item: ModItem) -> Option<FileItemTreeId<Self>>;
 341
 342     /// Upcasts a `FileItemTreeId` to a generic `ModItem`.
 343     fn id_to_mod_item(id: FileItemTreeId<Self>) -> ModItem;
 344 }
 345
 346 pub struct FileItemTreeId<N: ItemTreeNode> {
 347     index: Idx<N>,
 348     _p: PhantomData<N>,
 349 }
 350
 351 impl<N: ItemTreeNode> Clone for FileItemTreeId<N> {
 352     fn clone(&self) -> Self {
 353         Self { index: self.index, _p: PhantomData }
 354     }
 355 }
 356 impl<N: ItemTreeNode> Copy for FileItemTreeId<N> {}
 357
 358 impl<N: ItemTreeNode> PartialEq for FileItemTreeId<N> {
 359     fn eq(&self, other: &FileItemTreeId<N>) -> bool {
 360         self.index == other.index
 361     }
 362 }
 363 impl<N: ItemTreeNode> Eq for FileItemTreeId<N> {}
 364
 365 impl<N: ItemTreeNode> Hash for FileItemTreeId<N> {
 366     fn hash<H: Hasher>(&self, state: &mut H) {
 367         self.index.hash(state)
 368     }
 369 }
 370
 371 impl<N: ItemTreeNode> fmt::Debug for FileItemTreeId<N> {
 372     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 373         self.index.fmt(f)
 374     }
 375 }
 376
 377 #[derive(Debug)]
 378 pub struct ItemTreeId<N: ItemTreeNode> {
 379     file: HirFileId,
 380     pub value: FileItemTreeId<N>,
 381 }
 382
 383 impl<N: ItemTreeNode> ItemTreeId<N> {
 384     pub fn new(file: HirFileId, idx: FileItemTreeId<N>) -> Self {
 385         Self { file, value: idx }
 386     }
 387
 388     pub fn file_id(self) -> HirFileId {
 389         self.file
 390     }
 391
 392     pub fn item_tree(self, db: &dyn DefDatabase) -> Arc<ItemTree> {
 393         db.file_item_tree(self.file)
 394     }
 395 }
 396
 397 impl<N: ItemTreeNode> Copy for ItemTreeId<N> {}
 398 impl<N: ItemTreeNode> Clone for ItemTreeId<N> {
 399     fn clone(&self) -> Self {
 400         *self
 401     }
 402 }
 403
 404 impl<N: ItemTreeNode> PartialEq for ItemTreeId<N> {
 405     fn eq(&self, other: &Self) -> bool {
 406         self.file == other.file && self.value == other.value
 407     }
 408 }
 409
 410 impl<N: ItemTreeNode> Eq for ItemTreeId<N> {}
 411
 412 impl<N: ItemTreeNode> Hash for ItemTreeId<N> {
 413     fn hash<H: Hasher>(&self, state: &mut H) {
 414         self.file.hash(state);
 415         self.value.hash(state);
 416     }
 417 }
 418
 419 macro_rules! mod_items {
 420     ( $( $typ:ident in $fld:ident -> $ast:ty ),+ $(,)? ) => {
 421         #[derive(Debug, Copy, Clone, Eq, PartialEq, Hash)]
 422         pub enum ModItem {
 423             $(
 424                 $typ(FileItemTreeId<$typ>),
 425             )+
 426         }
 427
 428         $(
 429             impl From<FileItemTreeId<$typ>> for ModItem {
 430                 fn from(id: FileItemTreeId<$typ>) -> ModItem {
 431                     ModItem::$typ(id)
 432                 }
 433             }
 434         )+
 435
 436         $(
 437             impl ItemTreeNode for $typ {
 438                 type Source = $ast;
 439
 440                 fn ast_id(&self) -> FileAstId<Self::Source> {
 441                     self.ast_id
 442                 }
 443
 444                 fn lookup(tree: &ItemTree, index: Idx<Self>) -> &Self {
 445                     &tree.data().$fld[index]
 446                 }
 447
 448                 fn id_from_mod_item(mod_item: ModItem) -> Option<FileItemTreeId<Self>> {
 449                     if let ModItem::$typ(id) = mod_item {
 450                         Some(id)
 451                     } else {
 452                         None
 453                     }
 454                 }
 455
 456                 fn id_to_mod_item(id: FileItemTreeId<Self>) -> ModItem {
 457                     ModItem::$typ(id)
 458                 }
 459             }
 460
 461             impl Index<Idx<$typ>> for ItemTree {
 462                 type Output = $typ;
 463
 464                 fn index(&self, index: Idx<$typ>) -> &Self::Output {
 465                     &self.data().$fld[index]
 466                 }
 467             }
 468         )+
 469     };
 470 }
 471
 472 mod_items! {
 473     Import in imports -> ast::Use,
 474     ExternCrate in extern_crates -> ast::ExternCrate,
 475     ExternBlock in extern_blocks -> ast::ExternBlock,
 476     Function in functions -> ast::Fn,
 477     Struct in structs -> ast::Struct,
 478     Union in unions -> ast::Union,
 479     Enum in enums -> ast::Enum,
 480     Const in consts -> ast::Const,
 481     Static in statics -> ast::Static,
 482     Trait in traits -> ast::Trait,
 483     Impl in impls -> ast::Impl,
 484     TypeAlias in type_aliases -> ast::TypeAlias,
 485     Mod in mods -> ast::Module,
 486     MacroCall in macro_calls -> ast::MacroCall,
 487     MacroRules in macro_rules -> ast::MacroRules,
 488     MacroDef in macro_defs -> ast::MacroDef,
 489 }
 490
 491 macro_rules! impl_index {
 492     ( $($fld:ident: $t:ty),+ $(,)? ) => {
 493         $(
 494             impl Index<Idx<$t>> for ItemTree {
 495                 type Output = $t;
 496
 497                 fn index(&self, index: Idx<$t>) -> &Self::Output {
 498                     &self.data().$fld[index]
 499                 }
 500             }
 501         )+
 502     };
 503 }
 504
 505 impl_index!(fields: Field, variants: Variant, params: Param);
 506
 507 impl Index<RawVisibilityId> for ItemTree {
 508     type Output = RawVisibility;
 509     fn index(&self, index: RawVisibilityId) -> &Self::Output {
 510         match index {
 511             RawVisibilityId::PRIV => &VIS_PRIV,
 512             RawVisibilityId::PUB => &VIS_PUB,
 513             RawVisibilityId::PUB_CRATE => &VIS_PUB_CRATE,
 514             _ => &self.data().vis.arena[Idx::from_raw(index.0.into())],
 515         }
 516     }
 517 }
 518
 519 impl<N: ItemTreeNode> Index<FileItemTreeId<N>> for ItemTree {
 520     type Output = N;
 521     fn index(&self, id: FileItemTreeId<N>) -> &N {
 522         N::lookup(self, id.index)
 523     }
 524 }
 525
 526 #[derive(Debug, Clone, Eq, PartialEq)]
 527 pub struct Import {
 528     pub visibility: RawVisibilityId,
 529     pub ast_id: FileAstId<ast::Use>,
 530     pub use_tree: UseTree,
 531 }
 532
 533 #[derive(Debug, Clone, Eq, PartialEq)]
 534 pub struct UseTree {
 535     pub index: Idx<ast::UseTree>,
 536     kind: UseTreeKind,
 537 }
 538
 539 #[derive(Debug, Clone, Eq, PartialEq)]
 540 pub enum UseTreeKind {
 541     /// ```
 542     /// use path::to::Item;
 543     /// use path::to::Item as Renamed;
 544     /// use path::to::Trait as _;
 545     /// ```
 546     Single { path: Interned<ModPath>, alias: Option<ImportAlias> },
 547
 548     /// ```
 549     /// use *;  // (invalid, but can occur in nested tree)
 550     /// use path::*;
 551     /// ```
 552     Glob { path: Option<Interned<ModPath>> },
 553
 554     /// ```
 555     /// use prefix::{self, Item, ...};
 556     /// ```
 557     Prefixed { prefix: Option<Interned<ModPath>>, list: Box<[UseTree]> },
 558 }
 559
 560 #[derive(Debug, Clone, Eq, PartialEq)]
 561 pub struct ExternCrate {
 562     pub name: Name,
 563     pub alias: Option<ImportAlias>,
 564     pub visibility: RawVisibilityId,
 565     pub ast_id: FileAstId<ast::ExternCrate>,
 566 }
 567
 568 #[derive(Debug, Clone, Eq, PartialEq)]
 569 pub struct ExternBlock {
 570     pub abi: Option<Interned<str>>,
 571     pub ast_id: FileAstId<ast::ExternBlock>,
 572     pub children: Box<[ModItem]>,
 573 }
 574
 575 #[derive(Debug, Clone, Eq, PartialEq)]
 576 pub struct Function {
 577     pub name: Name,
 578     pub visibility: RawVisibilityId,
 579     pub generic_params: Interned<GenericParams>,
 580     pub abi: Option<Interned<str>>,
 581     pub params: IdRange<Param>,
 582     pub ret_type: Interned<TypeRef>,
 583     pub ast_id: FileAstId<ast::Fn>,
 584     pub(crate) flags: FnFlags,
 585 }
 586
 587 #[derive(Debug, Clone, Eq, PartialEq)]
 588 pub enum Param {
 589     Normal(Interned<TypeRef>),
 590     Varargs,
 591 }
 592
 593 #[derive(Debug, Clone, Copy, Eq, PartialEq, Default)]
 594 pub(crate) struct FnFlags {
 595     pub(crate) bits: u8,
 596 }
 597 impl FnFlags {
 598     pub(crate) const HAS_SELF_PARAM: u8 = 1 << 0;
 599     pub(crate) const HAS_BODY: u8 = 1 << 1;
 600     pub(crate) const IS_DEFAULT: u8 = 1 << 2;
 601     pub(crate) const IS_CONST: u8 = 1 << 3;
 602     pub(crate) const IS_ASYNC: u8 = 1 << 4;
 603     pub(crate) const IS_UNSAFE: u8 = 1 << 5;
 604     /// Whether the function is located in an `extern` block (*not* whether it is an
 605     /// `extern "abi" fn`).
 606     pub(crate) const IS_IN_EXTERN_BLOCK: u8 = 1 << 6;
 607     pub(crate) const IS_VARARGS: u8 = 1 << 7;
 608 }
 609
 610 #[derive(Debug, Clone, Eq, PartialEq)]
 611 pub struct Struct {
 612     pub name: Name,
 613     pub visibility: RawVisibilityId,
 614     pub generic_params: Interned<GenericParams>,
 615     pub fields: Fields,
 616     pub ast_id: FileAstId<ast::Struct>,
 617 }
 618
 619 #[derive(Debug, Clone, Eq, PartialEq)]
 620 pub struct Union {
 621     pub name: Name,
 622     pub visibility: RawVisibilityId,
 623     pub generic_params: Interned<GenericParams>,
 624     pub fields: Fields,
 625     pub ast_id: FileAstId<ast::Union>,
 626 }
 627
 628 #[derive(Debug, Clone, Eq, PartialEq)]
 629 pub struct Enum {
 630     pub name: Name,
 631     pub visibility: RawVisibilityId,
 632     pub generic_params: Interned<GenericParams>,
 633     pub variants: IdRange<Variant>,
 634     pub ast_id: FileAstId<ast::Enum>,
 635 }
 636
 637 #[derive(Debug, Clone, Eq, PartialEq)]
 638 pub struct Const {
 639     /// const _: () = ();
 640     pub name: Option<Name>,
 641     pub visibility: RawVisibilityId,
 642     pub type_ref: Interned<TypeRef>,
 643     pub ast_id: FileAstId<ast::Const>,
 644 }
 645
 646 #[derive(Debug, Clone, Eq, PartialEq)]
 647 pub struct Static {
 648     pub name: Name,
 649     pub visibility: RawVisibilityId,
 650     pub mutable: bool,
 651     /// Whether the static is in an `extern` block.
 652     pub is_extern: bool,
 653     pub type_ref: Interned<TypeRef>,
 654     pub ast_id: FileAstId<ast::Static>,
 655 }
 656
 657 #[derive(Debug, Clone, Eq, PartialEq)]
 658 pub struct Trait {
 659     pub name: Name,
 660     pub visibility: RawVisibilityId,
 661     pub generic_params: Interned<GenericParams>,
 662     pub is_auto: bool,
 663     pub is_unsafe: bool,
 664     pub items: Box<[AssocItem]>,
 665     pub ast_id: FileAstId<ast::Trait>,
 666 }
 667
 668 #[derive(Debug, Clone, Eq, PartialEq)]
 669 pub struct Impl {
 670     pub generic_params: Interned<GenericParams>,
 671     pub target_trait: Option<Interned<TraitRef>>,
 672     pub self_ty: Interned<TypeRef>,
 673     pub is_negative: bool,
 674     pub items: Box<[AssocItem]>,
 675     pub ast_id: FileAstId<ast::Impl>,
 676 }
 677
 678 #[derive(Debug, Clone, PartialEq, Eq)]
 679 pub struct TypeAlias {
 680     pub name: Name,
 681     pub visibility: RawVisibilityId,
 682     /// Bounds on the type alias itself. Only valid in trait declarations, eg. `type Assoc: Copy;`.
 683     pub bounds: Box<[Interned<TypeBound>]>,
 684     pub generic_params: Interned<GenericParams>,
 685     pub type_ref: Option<Interned<TypeRef>>,
 686     pub is_extern: bool,
 687     pub ast_id: FileAstId<ast::TypeAlias>,
 688 }
 689
 690 #[derive(Debug, Clone, Eq, PartialEq)]
 691 pub struct Mod {
 692     pub name: Name,
 693     pub visibility: RawVisibilityId,
 694     pub kind: ModKind,
 695     pub ast_id: FileAstId<ast::Module>,
 696 }
 697
 698 #[derive(Debug, Clone, Eq, PartialEq)]
 699 pub enum ModKind {
 700     /// `mod m { ... }`
 701     Inline { items: Box<[ModItem]> },
 702
 703     /// `mod m;`
 704     Outline {},
 705 }
 706
 707 #[derive(Debug, Clone, Eq, PartialEq)]
 708 pub struct MacroCall {
 709     /// Path to the called macro.
 710     pub path: Interned<ModPath>,
 711     pub ast_id: FileAstId<ast::MacroCall>,
 712     pub fragment: FragmentKind,
 713 }
 714
 715 #[derive(Debug, Clone, Eq, PartialEq)]
 716 pub struct MacroRules {
 717     /// The name of the declared macro.
 718     pub name: Name,
 719     pub ast_id: FileAstId<ast::MacroRules>,
 720 }
 721
 722 /// "Macros 2.0" macro definition.
 723 #[derive(Debug, Clone, Eq, PartialEq)]
 724 pub struct MacroDef {
 725     pub name: Name,
 726     pub visibility: RawVisibilityId,
 727     pub ast_id: FileAstId<ast::MacroDef>,
 728 }
 729
 730 impl Import {
 731     /// Maps a `UseTree` contained in this import back to its AST node.
 732     pub fn use_tree_to_ast(
 733         &self,
 734         db: &dyn DefDatabase,
 735         file_id: HirFileId,
 736         index: Idx<ast::UseTree>,
 737     ) -> ast::UseTree {
 738         // Re-lower the AST item and get the source map.
 739         // Note: The AST unwraps are fine, since if they fail we should have never obtained `index`.
 740         let ast = InFile::new(file_id, self.ast_id).to_node(db.upcast());
 741         let ast_use_tree = ast.use_tree().expect("missing `use_tree`");
 742         let hygiene = Hygiene::new(db.upcast(), file_id);
 743         let (_, source_map) =
 744             lower::lower_use_tree(db, &hygiene, ast_use_tree).expect("failed to lower use tree");
 745         source_map[index].clone()
 746     }
 747 }
 748
 749 impl UseTree {
 750     /// Expands the `UseTree` into individually imported `ModPath`s.
 751     pub fn expand(
 752         &self,
 753         mut cb: impl FnMut(Idx<ast::UseTree>, ModPath, /* is_glob */ bool, Option<ImportAlias>),
 754     ) {
 755         self.expand_impl(None, &mut cb)
 756     }
 757
 758     fn expand_impl(
 759         &self,
 760         prefix: Option<ModPath>,
 761         cb: &mut dyn FnMut(
 762             Idx<ast::UseTree>,
 763             ModPath,
 764             /* is_glob */ bool,
 765             Option<ImportAlias>,
 766         ),
 767     ) {
 768         fn concat_mod_paths(prefix: Option<ModPath>, path: &ModPath) -> Option<ModPath> {
 769             match (prefix, &path.kind) {
 770                 (None, _) => Some(path.clone()),
 771                 (Some(mut prefix), PathKind::Plain) => {
 772                     for segment in path.segments() {
 773                         prefix.push_segment(segment.clone());
 774                     }
 775                     Some(prefix)
 776                 }
 777                 (Some(prefix), PathKind::Super(0)) => {
 778                     // `some::path::self` == `some::path`
 779                     if path.segments().is_empty() {
 780                         Some(prefix)
 781                     } else {
 782                         None
 783                     }
 784                 }
 785                 (Some(_), _) => None,
 786             }
 787         }
 788
 789         match &self.kind {
 790             UseTreeKind::Single { path, alias } => {
 791                 if let Some(path) = concat_mod_paths(prefix, path) {
 792                     cb(self.index, path, false, alias.clone());
 793                 }
 794             }
 795             UseTreeKind::Glob { path: Some(path) } => {
 796                 if let Some(path) = concat_mod_paths(prefix, path) {
 797                     cb(self.index, path, true, None);
 798                 }
 799             }
 800             UseTreeKind::Glob { path: None } => {
 801                 if let Some(prefix) = prefix {
 802                     cb(self.index, prefix, true, None);
 803                 }
 804             }
 805             UseTreeKind::Prefixed { prefix: additional_prefix, list } => {
 806                 let prefix = match additional_prefix {
 807                     Some(path) => match concat_mod_paths(prefix, path) {
 808                         Some(path) => Some(path),
 809                         None => return,
 810                     },
 811                     None => prefix,
 812                 };
 813                 for tree in &**list {
 814                     tree.expand_impl(prefix.clone(), cb);
 815                 }
 816             }
 817         }
 818     }
 819 }
 820
 821 macro_rules! impl_froms {
 822     ($e:ident { $($v:ident ($t:ty)),* $(,)? }) => {
 823         $(
 824             impl From<$t> for $e {
 825                 fn from(it: $t) -> $e {
 826                     $e::$v(it)
 827                 }
 828             }
 829         )*
 830     }
 831 }
 832
 833 impl ModItem {
 834     pub fn as_assoc_item(&self) -> Option<AssocItem> {
 835         match self {
 836             ModItem::Import(_)
 837             | ModItem::ExternCrate(_)
 838             | ModItem::ExternBlock(_)
 839             | ModItem::Struct(_)
 840             | ModItem::Union(_)
 841             | ModItem::Enum(_)
 842             | ModItem::Static(_)
 843             | ModItem::Trait(_)
 844             | ModItem::Impl(_)
 845             | ModItem::Mod(_)
 846             | ModItem::MacroRules(_)
 847             | ModItem::MacroDef(_) => None,
 848             ModItem::MacroCall(call) => Some(AssocItem::MacroCall(*call)),
 849             ModItem::Const(konst) => Some(AssocItem::Const(*konst)),
 850             ModItem::TypeAlias(alias) => Some(AssocItem::TypeAlias(*alias)),
 851             ModItem::Function(func) => Some(AssocItem::Function(*func)),
 852         }
 853     }
 854
 855     pub fn downcast<N: ItemTreeNode>(self) -> Option<FileItemTreeId<N>> {
 856         N::id_from_mod_item(self)
 857     }
 858
 859     pub fn ast_id(&self, tree: &ItemTree) -> FileAstId<ast::Item> {
 860         match self {
 861             ModItem::Import(it) => tree[it.index].ast_id().upcast(),
 862             ModItem::ExternCrate(it) => tree[it.index].ast_id().upcast(),
 863             ModItem::ExternBlock(it) => tree[it.index].ast_id().upcast(),
 864             ModItem::Function(it) => tree[it.index].ast_id().upcast(),
 865             ModItem::Struct(it) => tree[it.index].ast_id().upcast(),
 866             ModItem::Union(it) => tree[it.index].ast_id().upcast(),
 867             ModItem::Enum(it) => tree[it.index].ast_id().upcast(),
 868             ModItem::Const(it) => tree[it.index].ast_id().upcast(),
 869             ModItem::Static(it) => tree[it.index].ast_id().upcast(),
 870             ModItem::Trait(it) => tree[it.index].ast_id().upcast(),
 871             ModItem::Impl(it) => tree[it.index].ast_id().upcast(),
 872             ModItem::TypeAlias(it) => tree[it.index].ast_id().upcast(),
 873             ModItem::Mod(it) => tree[it.index].ast_id().upcast(),
 874             ModItem::MacroCall(it) => tree[it.index].ast_id().upcast(),
 875             ModItem::MacroRules(it) => tree[it.index].ast_id().upcast(),
 876             ModItem::MacroDef(it) => tree[it.index].ast_id().upcast(),
 877         }
 878     }
 879 }
 880
 881 #[derive(Debug, Copy, Clone, Eq, PartialEq)]
 882 pub enum AssocItem {
 883     Function(FileItemTreeId<Function>),
 884     TypeAlias(FileItemTreeId<TypeAlias>),
 885     Const(FileItemTreeId<Const>),
 886     MacroCall(FileItemTreeId<MacroCall>),
 887 }
 888
 889 impl_froms!(AssocItem {
 890     Function(FileItemTreeId<Function>),
 891     TypeAlias(FileItemTreeId<TypeAlias>),
 892     Const(FileItemTreeId<Const>),
 893     MacroCall(FileItemTreeId<MacroCall>),
 894 });
 895
 896 impl From<AssocItem> for ModItem {
 897     fn from(item: AssocItem) -> Self {
 898         match item {
 899             AssocItem::Function(it) => it.into(),
 900             AssocItem::TypeAlias(it) => it.into(),
 901             AssocItem::Const(it) => it.into(),
 902             AssocItem::MacroCall(it) => it.into(),
 903         }
 904     }
 905 }
 906
 907 #[derive(Debug, Eq, PartialEq)]
 908 pub struct Variant {
 909     pub name: Name,
 910     pub fields: Fields,
 911 }
 912
 913 /// A range of densely allocated ItemTree IDs.
 914 pub struct IdRange<T> {
 915     range: Range<u32>,
 916     _p: PhantomData<T>,
 917 }
 918
 919 impl<T> IdRange<T> {
 920     fn new(range: Range<Idx<T>>) -> Self {
 921         Self { range: range.start.into_raw().into()..range.end.into_raw().into(), _p: PhantomData }
 922     }
 923
 924     fn is_empty(&self) -> bool {
 925         self.range.is_empty()
 926     }
 927 }
 928
 929 impl<T> Iterator for IdRange<T> {
 930     type Item = Idx<T>;
 931     fn next(&mut self) -> Option<Self::Item> {
 932         self.range.next().map(|raw| Idx::from_raw(raw.into()))
 933     }
 934 }
 935
 936 impl<T> DoubleEndedIterator for IdRange<T> {
 937     fn next_back(&mut self) -> Option<Self::Item> {
 938         self.range.next_back().map(|raw| Idx::from_raw(raw.into()))
 939     }
 940 }
 941
 942 impl<T> fmt::Debug for IdRange<T> {
 943     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 944         f.debug_tuple(&format!("IdRange::<{}>", type_name::<T>())).field(&self.range).finish()
 945     }
 946 }
 947
 948 impl<T> Clone for IdRange<T> {
 949     fn clone(&self) -> Self {
 950         Self { range: self.range.clone(), _p: PhantomData }
 951     }
 952 }
 953
 954 impl<T> PartialEq for IdRange<T> {
 955     fn eq(&self, other: &Self) -> bool {
 956         self.range == other.range
 957     }
 958 }
 959
 960 impl<T> Eq for IdRange<T> {}
 961
 962 #[derive(Debug, Clone, PartialEq, Eq)]
 963 pub enum Fields {
 964     Record(IdRange<Field>),
 965     Tuple(IdRange<Field>),
 966     Unit,
 967 }
 968
 969 /// A single field of an enum variant or struct
 970 #[derive(Debug, Clone, PartialEq, Eq)]
 971 pub struct Field {
 972     pub name: Name,
 973     pub type_ref: Interned<TypeRef>,
 974     pub visibility: RawVisibilityId,
 975 }