Remove impl Display for FileName and add FileNameDisplay wrapper type

This commit is contained in:
Andy Wang 2021-04-20 01:11:12 +01:00
parent ec34cd94dd
commit f8e55da6de
No known key found for this signature in database
GPG Key ID: 181B49F9F38F3374
2 changed files with 40 additions and 13 deletions

View File

@ -202,6 +202,23 @@ pub fn stable_name(&self) -> &Path {
| RealFileName::Remapped { local_path: _, virtual_name: p } => &p,
}
}
fn to_string_lossy(&self, prefer_local: bool) -> Cow<'_, str> {
use RealFileName::*;
if prefer_local {
match self {
LocalPath(path)
| Remapped { local_path: None, virtual_name: path }
| Remapped { local_path: Some(path), virtual_name: _ } => path.to_string_lossy(),
}
} else {
match self {
LocalPath(path) | Remapped { local_path: _, virtual_name: path } => {
path.to_string_lossy()
}
}
}
}
}
/// Differentiates between real files and common virtual files.
@ -228,16 +245,24 @@ pub enum FileName {
InlineAsm(u64),
}
impl std::fmt::Display for FileName {
impl From<PathBuf> for FileName {
fn from(p: PathBuf) -> Self {
assert!(!p.to_string_lossy().ends_with('>'));
FileName::Real(RealFileName::LocalPath(p))
}
}
pub struct FileNameDisplay<'a> {
inner: &'a FileName,
prefer_local: bool,
}
impl fmt::Display for FileNameDisplay<'_> {
fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
use FileName::*;
match *self {
Real(RealFileName::Named(ref path)) => write!(fmt, "{}", path.display()),
// FIXME: might be nice to display both components of Devirtualized.
// But for now (to backport fix for issue #70924), best to not
// perturb diagnostics so its obvious test suite still works.
Real(RealFileName::Devirtualized { ref local_path, virtual_name: _ }) => {
write!(fmt, "{}", local_path.display())
match *self.inner {
Real(ref name) => {
write!(fmt, "{}", name.to_string_lossy(self.prefer_local))
}
QuoteExpansion(_) => write!(fmt, "<quote expansion>"),
MacroExpansion(_) => write!(fmt, "<macro expansion>"),
@ -252,10 +277,12 @@ fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
}
}
impl From<PathBuf> for FileName {
fn from(p: PathBuf) -> Self {
assert!(!p.to_string_lossy().ends_with('>'));
FileName::Real(RealFileName::LocalPath(p))
impl FileNameDisplay<'_> {
pub fn to_string_lossy(&self) -> Cow<'_, str> {
match self.inner {
FileName::Real(ref inner) => inner.to_string_lossy(self.prefer_local),
_ => Cow::from(format!("{}", self)),
}
}
}

View File

@ -219,7 +219,7 @@ fn fold_item(&mut self, i: clean::Item) -> Option<clean::Item> {
// unless the user had an explicit `allow`
let should_have_docs =
level != lint::Level::Allow || matches!(source, LintLevelSource::Default);
debug!("counting {:?} {:?} in {}", i.type_(), i.name, filename);
debug!("counting {:?} {:?} in {:?}", i.type_(), i.name, filename);
self.items.entry(filename).or_default().count_item(
has_docs,
has_doc_example,