mirror of
https://github.com/rust-lang/rust-analyzer
synced 2025-01-07 18:58:51 +00:00
63 lines
2.2 KiB
Rust
63 lines
2.2 KiB
Rust
//! HIR (previously known as descriptors) provides a high-level object oriented
|
|
//! access to Rust code.
|
|
//!
|
|
//! The principal difference between HIR and syntax trees is that HIR is bound
|
|
//! to a particular crate instance. That is, it has cfg flags and features
|
|
//! applied. So, the relation between syntax and HIR is many-to-one.
|
|
//!
|
|
//! HIR is the public API of the all of the compiler logic above syntax trees.
|
|
//! It is written in "OO" style. Each type is self contained (as in, it knows it's
|
|
//! parents and full context). It should be "clean code".
|
|
//!
|
|
//! `ra_hir_*` crates are the implementation of the compiler logic.
|
|
//! They are written in "ECS" style, with relatively little abstractions.
|
|
//! Many types are not self-contained, and explicitly use local indexes, arenas, etc.
|
|
//!
|
|
//! `ra_hir` is what insulates the "we don't know how to actually write an incremental compiler"
|
|
//! from the ide with completions, hovers, etc. It is a (soft, internal) boundary:
|
|
//! https://www.tedinski.com/2018/02/06/system-boundaries.html.
|
|
|
|
#![recursion_limit = "512"]
|
|
|
|
mod semantics;
|
|
pub mod db;
|
|
mod source_analyzer;
|
|
|
|
pub mod diagnostics;
|
|
|
|
mod from_id;
|
|
mod code_model;
|
|
mod link_rewrite;
|
|
|
|
mod has_source;
|
|
|
|
pub use crate::{
|
|
code_model::{
|
|
Adt, AsAssocItem, AssocItem, AssocItemContainer, AttrDef, Callable, CallableKind, Const,
|
|
Crate, CrateDependency, DefWithBody, Docs, Enum, EnumVariant, Field, FieldSource, Function,
|
|
GenericDef, HasAttrs, HasVisibility, ImplDef, Local, MacroDef, Module, ModuleDef, ScopeDef,
|
|
Static, Struct, Trait, Type, TypeAlias, TypeParam, Union, VariantDef, Visibility,
|
|
},
|
|
has_source::HasSource,
|
|
link_rewrite::resolve_doc_link,
|
|
semantics::{original_range, PathResolution, Semantics, SemanticsScope},
|
|
};
|
|
|
|
pub use hir_def::{
|
|
adt::StructKind,
|
|
attr::Attrs,
|
|
body::scope::ExprScopes,
|
|
builtin_type::BuiltinType,
|
|
docs::Documentation,
|
|
item_scope::ItemInNs,
|
|
nameres::ModuleSource,
|
|
path::{ModPath, Path, PathKind},
|
|
type_ref::Mutability,
|
|
};
|
|
pub use hir_expand::{
|
|
hygiene::Hygiene,
|
|
name::{AsName, Name},
|
|
HirFileId, InFile, MacroCallId, MacroCallLoc, MacroDefId, /* FIXME */
|
|
MacroFile, Origin,
|
|
};
|
|
pub use hir_ty::display::HirDisplay;
|