mirror of
https://github.com/rust-lang/rust-analyzer
synced 2024-12-27 21:43:37 +00:00
Rename declaration_name -> display_name
Declaration names sounds like a name of declaration -- something you can use for analysis. It empathically isn't, and is just a label displayed in various UI. It's important not to confuse the two, least we accidentally mix semantics with UI (I believe, there's already a case of this in the FamousDefs at least).
This commit is contained in:
parent
be762ccccd
commit
af4e75533f
11 changed files with 28 additions and 35 deletions
|
@ -406,7 +406,7 @@ pub use prelude::*;
|
||||||
let std_crate = path.next()?;
|
let std_crate = path.next()?;
|
||||||
let std_crate = if self
|
let std_crate = if self
|
||||||
.1
|
.1
|
||||||
.declaration_name(db)
|
.display_name(db)
|
||||||
.map(|name| name.to_string() == std_crate)
|
.map(|name| name.to_string() == std_crate)
|
||||||
.unwrap_or(false)
|
.unwrap_or(false)
|
||||||
{
|
{
|
||||||
|
|
|
@ -127,11 +127,13 @@ impl PartialEq for ProcMacro {
|
||||||
pub struct CrateData {
|
pub struct CrateData {
|
||||||
pub root_file_id: FileId,
|
pub root_file_id: FileId,
|
||||||
pub edition: Edition,
|
pub edition: Edition,
|
||||||
/// A name used in the package's project declaration: for Cargo projects, it's [package].name,
|
/// A name used in the package's project declaration: for Cargo projects,
|
||||||
/// can be different for other project types or even absent (a dummy crate for the code snippet, for example).
|
/// it's [package].name, can be different for other project types or even
|
||||||
/// NOTE: The crate can be referenced as a dependency under a different name,
|
/// absent (a dummy crate for the code snippet, for example).
|
||||||
/// this one should be used when working with crate hierarchies.
|
///
|
||||||
pub declaration_name: Option<CrateName>,
|
/// For purposes of analysis, crates are anonymous (only names in
|
||||||
|
/// `Dependency` matters), this name should only be used for UI.
|
||||||
|
pub display_name: Option<CrateName>,
|
||||||
pub cfg_options: CfgOptions,
|
pub cfg_options: CfgOptions,
|
||||||
pub env: Env,
|
pub env: Env,
|
||||||
pub dependencies: Vec<Dependency>,
|
pub dependencies: Vec<Dependency>,
|
||||||
|
@ -160,7 +162,7 @@ impl CrateGraph {
|
||||||
&mut self,
|
&mut self,
|
||||||
file_id: FileId,
|
file_id: FileId,
|
||||||
edition: Edition,
|
edition: Edition,
|
||||||
declaration_name: Option<CrateName>,
|
display_name: Option<CrateName>,
|
||||||
cfg_options: CfgOptions,
|
cfg_options: CfgOptions,
|
||||||
env: Env,
|
env: Env,
|
||||||
proc_macro: Vec<(SmolStr, Arc<dyn tt::TokenExpander>)>,
|
proc_macro: Vec<(SmolStr, Arc<dyn tt::TokenExpander>)>,
|
||||||
|
@ -171,7 +173,7 @@ impl CrateGraph {
|
||||||
let data = CrateData {
|
let data = CrateData {
|
||||||
root_file_id: file_id,
|
root_file_id: file_id,
|
||||||
edition,
|
edition,
|
||||||
declaration_name,
|
display_name,
|
||||||
cfg_options,
|
cfg_options,
|
||||||
env,
|
env,
|
||||||
proc_macro,
|
proc_macro,
|
||||||
|
@ -310,8 +312,8 @@ impl CrateGraph {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
fn hacky_find_crate(&self, declaration_name: &str) -> Option<CrateId> {
|
fn hacky_find_crate(&self, display_name: &str) -> Option<CrateId> {
|
||||||
self.iter().find(|it| self[*it].declaration_name.as_deref() == Some(declaration_name))
|
self.iter().find(|it| self[*it].display_name.as_deref() == Some(display_name))
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -103,8 +103,8 @@ impl Crate {
|
||||||
db.crate_graph()[self.id].edition
|
db.crate_graph()[self.id].edition
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn declaration_name(self, db: &dyn HirDatabase) -> Option<CrateName> {
|
pub fn display_name(self, db: &dyn HirDatabase) -> Option<CrateName> {
|
||||||
db.crate_graph()[self.id].declaration_name.clone()
|
db.crate_graph()[self.id].display_name.clone()
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn query_external_importables(
|
pub fn query_external_importables(
|
||||||
|
|
|
@ -356,7 +356,7 @@ mod tests {
|
||||||
let krate = crate_graph
|
let krate = crate_graph
|
||||||
.iter()
|
.iter()
|
||||||
.find(|krate| {
|
.find(|krate| {
|
||||||
crate_graph[*krate].declaration_name.as_ref().map(|n| n.to_string())
|
crate_graph[*krate].display_name.as_ref().map(|n| n.to_string())
|
||||||
== Some(crate_name.to_string())
|
== Some(crate_name.to_string())
|
||||||
})
|
})
|
||||||
.unwrap();
|
.unwrap();
|
||||||
|
@ -375,7 +375,7 @@ mod tests {
|
||||||
let path = map.path_of(item).unwrap();
|
let path = map.path_of(item).unwrap();
|
||||||
format!(
|
format!(
|
||||||
"{}::{} ({})\n",
|
"{}::{} ({})\n",
|
||||||
crate_graph[krate].declaration_name.as_ref().unwrap(),
|
crate_graph[krate].display_name.as_ref().unwrap(),
|
||||||
path,
|
path,
|
||||||
mark
|
mark
|
||||||
)
|
)
|
||||||
|
@ -416,7 +416,7 @@ mod tests {
|
||||||
.iter()
|
.iter()
|
||||||
.filter_map(|krate| {
|
.filter_map(|krate| {
|
||||||
let cdata = &crate_graph[krate];
|
let cdata = &crate_graph[krate];
|
||||||
let name = cdata.declaration_name.as_ref()?;
|
let name = cdata.display_name.as_ref()?;
|
||||||
|
|
||||||
let map = db.import_map(krate);
|
let map = db.import_map(krate);
|
||||||
|
|
||||||
|
|
|
@ -172,11 +172,7 @@ pub struct ModuleData {
|
||||||
impl CrateDefMap {
|
impl CrateDefMap {
|
||||||
pub(crate) fn crate_def_map_query(db: &dyn DefDatabase, krate: CrateId) -> Arc<CrateDefMap> {
|
pub(crate) fn crate_def_map_query(db: &dyn DefDatabase, krate: CrateId) -> Arc<CrateDefMap> {
|
||||||
let _p = profile::span("crate_def_map_query").detail(|| {
|
let _p = profile::span("crate_def_map_query").detail(|| {
|
||||||
db.crate_graph()[krate]
|
db.crate_graph()[krate].display_name.as_deref().unwrap_or_default().to_string()
|
||||||
.declaration_name
|
|
||||||
.as_ref()
|
|
||||||
.map(ToString::to_string)
|
|
||||||
.unwrap_or_default()
|
|
||||||
});
|
});
|
||||||
let def_map = {
|
let def_map = {
|
||||||
let edition = db.crate_graph()[krate].edition;
|
let edition = db.crate_graph()[krate].edition;
|
||||||
|
|
|
@ -130,7 +130,7 @@ fn get_doc_link(db: &RootDatabase, definition: Definition) -> Option<String> {
|
||||||
let module = definition.module(db)?;
|
let module = definition.module(db)?;
|
||||||
let krate = module.krate();
|
let krate = module.krate();
|
||||||
let import_map = db.import_map(krate.into());
|
let import_map = db.import_map(krate.into());
|
||||||
let base = once(krate.declaration_name(db)?.to_string())
|
let base = once(krate.display_name(db)?.to_string())
|
||||||
.chain(import_map.path_of(ns)?.segments.iter().map(|name| name.to_string()))
|
.chain(import_map.path_of(ns)?.segments.iter().map(|name| name.to_string()))
|
||||||
.join("/");
|
.join("/");
|
||||||
|
|
||||||
|
@ -188,7 +188,7 @@ fn rewrite_intra_doc_link(
|
||||||
let krate = resolved.module(db)?.krate();
|
let krate = resolved.module(db)?.krate();
|
||||||
let canonical_path = resolved.canonical_path(db)?;
|
let canonical_path = resolved.canonical_path(db)?;
|
||||||
let new_target = get_doc_url(db, &krate)?
|
let new_target = get_doc_url(db, &krate)?
|
||||||
.join(&format!("{}/", krate.declaration_name(db)?))
|
.join(&format!("{}/", krate.display_name(db)?))
|
||||||
.ok()?
|
.ok()?
|
||||||
.join(&canonical_path.replace("::", "/"))
|
.join(&canonical_path.replace("::", "/"))
|
||||||
.ok()?
|
.ok()?
|
||||||
|
@ -208,7 +208,7 @@ fn rewrite_url_link(db: &RootDatabase, def: ModuleDef, target: &str) -> Option<S
|
||||||
let module = def.module(db)?;
|
let module = def.module(db)?;
|
||||||
let krate = module.krate();
|
let krate = module.krate();
|
||||||
let canonical_path = def.canonical_path(db)?;
|
let canonical_path = def.canonical_path(db)?;
|
||||||
let base = format!("{}/{}", krate.declaration_name(db)?, canonical_path.replace("::", "/"));
|
let base = format!("{}/{}", krate.display_name(db)?, canonical_path.replace("::", "/"));
|
||||||
|
|
||||||
get_doc_url(db, &krate)
|
get_doc_url(db, &krate)
|
||||||
.and_then(|url| url.join(&base).ok())
|
.and_then(|url| url.join(&base).ok())
|
||||||
|
@ -357,7 +357,7 @@ fn get_doc_url(db: &RootDatabase, krate: &Crate) -> Option<Url> {
|
||||||
//
|
//
|
||||||
// FIXME: clicking on the link should just open the file in the editor,
|
// FIXME: clicking on the link should just open the file in the editor,
|
||||||
// instead of falling back to external urls.
|
// instead of falling back to external urls.
|
||||||
Some(format!("https://docs.rs/{}/*/", krate.declaration_name(db)?))
|
Some(format!("https://docs.rs/{}/*/", krate.display_name(db)?))
|
||||||
})
|
})
|
||||||
.and_then(|s| Url::parse(&s).ok())
|
.and_then(|s| Url::parse(&s).ok())
|
||||||
}
|
}
|
||||||
|
|
|
@ -300,7 +300,7 @@ fn definition_owner_name(db: &RootDatabase, def: &Definition) -> Option<String>
|
||||||
|
|
||||||
fn render_path(db: &RootDatabase, module: Module, item_name: Option<String>) -> String {
|
fn render_path(db: &RootDatabase, module: Module, item_name: Option<String>) -> String {
|
||||||
let crate_name =
|
let crate_name =
|
||||||
db.crate_graph()[module.krate().into()].declaration_name.as_ref().map(ToString::to_string);
|
db.crate_graph()[module.krate().into()].display_name.as_ref().map(|it| it.to_string());
|
||||||
let module_path = module
|
let module_path = module
|
||||||
.path_to_root(db)
|
.path_to_root(db)
|
||||||
.into_iter()
|
.into_iter()
|
||||||
|
|
|
@ -215,7 +215,7 @@ fn hint_iterator(
|
||||||
.last()
|
.last()
|
||||||
.and_then(|strukt| strukt.as_adt())?;
|
.and_then(|strukt| strukt.as_adt())?;
|
||||||
let krate = strukt.krate(db)?;
|
let krate = strukt.krate(db)?;
|
||||||
if krate.declaration_name(db).as_deref() != Some("core") {
|
if krate.display_name(db).as_deref() != Some("core") {
|
||||||
return None;
|
return None;
|
||||||
}
|
}
|
||||||
let iter_trait = FamousDefs(sema, krate).core_iter_Iterator()?;
|
let iter_trait = FamousDefs(sema, krate).core_iter_Iterator()?;
|
||||||
|
|
|
@ -32,8 +32,7 @@ pub(crate) fn prime_caches(db: &RootDatabase, cb: &(dyn Fn(PrimeCachesProgress)
|
||||||
// Unfortunately rayon prevents panics from propagation out of a `scope`, which breaks
|
// Unfortunately rayon prevents panics from propagation out of a `scope`, which breaks
|
||||||
// cancellation, so we cannot use rayon.
|
// cancellation, so we cannot use rayon.
|
||||||
for (i, krate) in topo.iter().enumerate() {
|
for (i, krate) in topo.iter().enumerate() {
|
||||||
let crate_name =
|
let crate_name = graph[*krate].display_name.as_deref().unwrap_or_default().to_string();
|
||||||
graph[*krate].declaration_name.as_ref().map(ToString::to_string).unwrap_or_default();
|
|
||||||
|
|
||||||
cb(PrimeCachesProgress::StartedOnCrate {
|
cb(PrimeCachesProgress::StartedOnCrate {
|
||||||
on_crate: crate_name,
|
on_crate: crate_name,
|
||||||
|
|
|
@ -45,7 +45,7 @@ pub(crate) fn status(db: &RootDatabase, file_id: Option<FileId>) -> String {
|
||||||
match krate {
|
match krate {
|
||||||
Some(krate) => {
|
Some(krate) => {
|
||||||
let crate_graph = db.crate_graph();
|
let crate_graph = db.crate_graph();
|
||||||
let display_crate = |krate: CrateId| match &crate_graph[krate].declaration_name {
|
let display_crate = |krate: CrateId| match &crate_graph[krate].display_name {
|
||||||
Some(it) => format!("{}({:?})", it, krate),
|
Some(it) => format!("{}({:?})", it, krate),
|
||||||
None => format!("{:?}", krate),
|
None => format!("{:?}", krate),
|
||||||
};
|
};
|
||||||
|
|
|
@ -36,12 +36,8 @@ pub fn diagnostics(path: &Path, load_output_dirs: bool, with_proc_macro: bool) -
|
||||||
for module in work {
|
for module in work {
|
||||||
let file_id = module.definition_source(db).file_id.original_file(db);
|
let file_id = module.definition_source(db).file_id.original_file(db);
|
||||||
if !visited_files.contains(&file_id) {
|
if !visited_files.contains(&file_id) {
|
||||||
let crate_name = module
|
let crate_name =
|
||||||
.krate()
|
module.krate().display_name(db).as_deref().unwrap_or("unknown").to_string();
|
||||||
.declaration_name(db)
|
|
||||||
.as_ref()
|
|
||||||
.map(ToString::to_string)
|
|
||||||
.unwrap_or_else(|| "unknown".to_string());
|
|
||||||
println!("processing crate: {}, module: {}", crate_name, _vfs.file_path(file_id));
|
println!("processing crate: {}, module: {}", crate_name, _vfs.file_path(file_id));
|
||||||
for diagnostic in analysis.diagnostics(&DiagnosticsConfig::default(), file_id).unwrap()
|
for diagnostic in analysis.diagnostics(&DiagnosticsConfig::default(), file_id).unwrap()
|
||||||
{
|
{
|
||||||
|
|
Loading…
Reference in a new issue